osfmk/ipc/ipc_port.h

   1 /*
   2  * Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  * NOTICE: This file was modified by McAfee Research in 2004 to introduce
  58  * support for mandatory and extensible security protections.  This notice
  59  * is included in support of clause 2.2 (b) of the Apple Public License,
  60  * Version 2.0.
  61  */
  62 /*
  63  */
  64 /*
  65  *      File:   ipc/ipc_port.h
  66  *      Author: Rich Draves
  67  *      Date:   1989
  68  *
  69  *      Definitions for ports.
  70  */
  71
  72 #ifndef _IPC_IPC_PORT_H_
  73 #define _IPC_IPC_PORT_H_
  74
  75 #ifdef MACH_KERNEL_PRIVATE
  76
  77 #include <mach_assert.h>
  78 #include <mach_debug.h>
  79
  80 #include <mach/mach_types.h>
  81 #include <mach/boolean.h>
  82 #include <mach/kern_return.h>
  83 #include <mach/port.h>
  84
  85 #include <kern/assert.h>
  86 #include <kern/kern_types.h>
  87 #include <kern/turnstile.h>
  88
  89 #include <ipc/ipc_types.h>
  90 #include <ipc/ipc_object.h>
  91 #include <ipc/ipc_mqueue.h>
  92 #include <ipc/ipc_space.h>
  93
  94 #include <security/_label.h>
  95
  96 /*
  97  *  A receive right (port) can be in four states:
  98  *      1) dead (not active, ip_timestamp has death time)
  99  *      2) in a space (ip_receiver_name != 0, ip_receiver points
 100  *      to the space but doesn't hold a ref for it)
 101  *      3) in transit (ip_receiver_name == 0, ip_destination points
 102  *      to the destination port and holds a ref for it)
 103  *      4) in limbo (ip_receiver_name == 0, ip_destination == IP_NULL)
 104  *
 105  *  If the port is active, and ip_receiver points to some space,
 106  *  then ip_receiver_name != 0, and that space holds receive rights.
 107  *  If the port is not active, then ip_timestamp contains a timestamp
 108  *  taken when the port was destroyed.
 109  */
 110
 111 struct task_watchport_elem;
 112
 113 typedef unsigned int ipc_port_timestamp_t;
 114
 115 struct ipc_port {
 116         /*
 117          * Initial sub-structure in common with ipc_pset
 118          * First element is an ipc_object second is a
 119          * message queue
 120          */
 121         struct ipc_object ip_object;
 122         struct ipc_mqueue ip_messages;
 123
 124         union {
 125                 struct ipc_space *receiver;
 126                 struct ipc_port *destination;
 127                 ipc_port_timestamp_t timestamp;
 128         } data;
 129
 130         union {
 131                 ipc_kobject_t kobject;
 132                 ipc_importance_task_t imp_task;
 133                 ipc_port_t sync_inheritor_port;
 134                 struct knote *sync_inheritor_knote;
 135                 struct turnstile *sync_inheritor_ts;
 136         } kdata;
 137
 138         struct ipc_port *ip_nsrequest;
 139         struct ipc_port *ip_pdrequest;
 140         struct ipc_port_request *ip_requests;
 141         union {
 142                 struct ipc_kmsg *premsg;
 143                 struct turnstile *send_turnstile;
 144         } kdata2;
 145
 146         mach_vm_address_t ip_context;
 147
 148         natural_t ip_sprequests:1,      /* send-possible requests outstanding */
 149             ip_spimportant:1,           /* ... at least one is importance donating */
 150             ip_impdonation:1,           /* port supports importance donation */
 151             ip_tempowner:1,             /* dont give donations to current receiver */
 152             ip_guarded:1,               /* port guarded (use context value as guard) */
 153             ip_strict_guard:1,          /* Strict guarding; Prevents user manipulation of context values directly */
 154             ip_specialreply:1,          /* port is a special reply port */
 155             ip_sync_link_state:3,       /* link the port to destination port/ Workloop */
 156             ip_sync_bootstrap_checkin:1,/* port part of sync bootstrap checkin, push on thread doing the checkin */
 157             ip_immovable_receive:1,     /* the receive right cannot be moved out of a space, until it is destroyed */
 158             ip_no_grant:1,              /* Port wont accept complex messages containing (ool) port descriptors */
 159             ip_immovable_send:1,        /* No send(once) rights to this port can be moved out of a space */
 160             ip_impcount:18;             /* number of importance donations in nested queue */
 161
 162         mach_port_mscount_t ip_mscount;
 163         mach_port_rights_t ip_srights;
 164         mach_port_rights_t ip_sorights;
 165
 166 #if     MACH_ASSERT
 167 #define IP_NSPARES              4
 168 #define IP_CALLSTACK_MAX        16
 169 /*      queue_chain_t   ip_port_links;*//* all allocated ports */
 170         thread_t        ip_thread;      /* who made me?  thread context */
 171         unsigned long   ip_timetrack;   /* give an idea of "when" created */
 172         uintptr_t       ip_callstack[IP_CALLSTACK_MAX]; /* stack trace */
 173         unsigned long   ip_spares[IP_NSPARES]; /* for debugging */
 174 #endif  /* MACH_ASSERT */
 175 #if DEVELOPMENT || DEBUG
 176         uint8_t         ip_srp_lost_link:1,     /* special reply port turnstile link chain broken */
 177             ip_srp_msg_sent:1;                  /* special reply port msg sent */
 178 #endif
 179 };
 180
 181
 182 #define ip_references           ip_object.io_references
 183
 184 #define ip_receiver_name        ip_messages.imq_receiver_name
 185 #define ip_in_pset              ip_messages.imq_in_pset
 186 #define ip_reply_context        ip_messages.imq_context
 187
 188 #define ip_receiver             data.receiver
 189 #define ip_destination          data.destination
 190 #define ip_timestamp            data.timestamp
 191
 192 #define ip_kobject              kdata.kobject
 193 #define ip_imp_task             kdata.imp_task
 194 #define ip_sync_inheritor_port  kdata.sync_inheritor_port
 195 #define ip_sync_inheritor_knote kdata.sync_inheritor_knote
 196 #define ip_sync_inheritor_ts    kdata.sync_inheritor_ts
 197
 198 #define ip_premsg               kdata2.premsg
 199 #define ip_send_turnstile       kdata2.send_turnstile
 200
 201 #define port_send_turnstile(port)       (IP_PREALLOC(port) ? (port)->ip_premsg->ikm_turnstile : (port)->ip_send_turnstile)
 202
 203 #define set_port_send_turnstile(port, value)                 \
 204 MACRO_BEGIN                                                  \
 205 if (IP_PREALLOC(port)) {                                     \
 206         (port)->ip_premsg->ikm_turnstile = (value);          \
 207 } else {                                                     \
 208         (port)->ip_send_turnstile = (value);                 \
 209 }                                                            \
 210 MACRO_END
 211
 212 #define port_send_turnstile_address(port)                    \
 213 (IP_PREALLOC(port) ? &((port)->ip_premsg->ikm_turnstile) : &((port)->ip_send_turnstile))
 214
 215 #define port_rcv_turnstile_address(port) \
 216         &(port)->ip_messages.imq_wait_queue.waitq_ts
 217
 218
 219 /*
 220  * SYNC IPC state flags for special reply port/ rcv right.
 221  *
 222  * PORT_SYNC_LINK_ANY
 223  *    Special reply port is not linked to any other port
 224  *    or WL and linkage should be allowed.
 225  *
 226  * PORT_SYNC_LINK_PORT
 227  *    Special reply port is linked to the port and
 228  *    ip_sync_inheritor_port contains the inheritor
 229  *    port.
 230  *
 231  * PORT_SYNC_LINK_WORKLOOP_KNOTE
 232  *    Special reply port is linked to a WL (via a knote).
 233  *    ip_sync_inheritor_knote contains a pointer to the knote
 234  *    the port is stashed on.
 235  *
 236  * PORT_SYNC_LINK_WORKLOOP_STASH
 237  *    Special reply port is linked to a WL (via a knote stash).
 238  *    ip_sync_inheritor_ts contains a pointer to the turnstile with a +1
 239  *    the port is stashed on.
 240  *
 241  * PORT_SYNC_LINK_NO_LINKAGE
 242  *    Message sent to special reply port, do
 243  *    not allow any linkages till receive is
 244  *    complete.
 245  *
 246  * PORT_SYNC_LINK_RCV_THREAD
 247  *    Receive right copied out as a part of bootstrap check in,
 248  *    push on the thread which copied out the port.
 249  */
 250 #define PORT_SYNC_LINK_ANY              (0)
 251 #define PORT_SYNC_LINK_PORT             (0x1)
 252 #define PORT_SYNC_LINK_WORKLOOP_KNOTE   (0x2)
 253 #define PORT_SYNC_LINK_WORKLOOP_STASH   (0x3)
 254 #define PORT_SYNC_LINK_NO_LINKAGE       (0x4)
 255 #define PORT_SYNC_LINK_RCV_THREAD       (0x5)
 256
 257 #define IP_NULL                 IPC_PORT_NULL
 258 #define IP_DEAD                 IPC_PORT_DEAD
 259 #define IP_VALID(port)          IPC_PORT_VALID(port)
 260
 261 #define ip_object_to_port(io)   __container_of(io, struct ipc_port, ip_object)
 262 #define ip_to_object(port)      (&(port)->ip_object)
 263 #define ip_active(port)         io_active(ip_to_object(port))
 264 #define ip_lock_init(port)      io_lock_init(ip_to_object(port))
 265 #define ip_lock_held(port)      io_lock_held(ip_to_object(port))
 266 #define ip_lock(port)           io_lock(ip_to_object(port))
 267 #define ip_lock_try(port)       io_lock_try(ip_to_object(port))
 268 #define ip_lock_held_kdp(port)  io_lock_held_kdp(ip_to_object(port))
 269 #define ip_unlock(port)         io_unlock(ip_to_object(port))
 270
 271 #define ip_reference(port)      io_reference(ip_to_object(port))
 272 #define ip_release(port)        io_release(ip_to_object(port))
 273
 274 /* get an ipc_port pointer from an ipc_mqueue pointer */
 275 #define ip_from_mq(mq) \
 276                 __container_of(mq, struct ipc_port, ip_messages)
 277
 278 #define ip_reference_mq(mq)     ip_reference(ip_from_mq(mq))
 279 #define ip_release_mq(mq)       ip_release(ip_from_mq(mq))
 280
 281 #define ip_kotype(port)         io_kotype(ip_to_object(port))
 282 #define ip_is_kobject(port)     io_is_kobject(ip_to_object(port))
 283
 284 #define ip_full_kernel(port)    imq_full_kernel(&(port)->ip_messages)
 285 #define ip_full(port)           imq_full(&(port)->ip_messages)
 286
 287 /*
 288  * JMM - Preallocation flag
 289  * This flag indicates that there is a message buffer preallocated for this
 290  * port and we should use that when sending (from the kernel) rather than
 291  * allocate a new one.  This avoids deadlocks during notification message
 292  * sends by critical system threads (which may be needed to free memory and
 293  * therefore cannot be blocked waiting for memory themselves).
 294  */
 295 #define IP_BIT_PREALLOC         0x00008000      /* preallocated mesg */
 296 #define IP_PREALLOC(port)       ((port)->ip_object.io_bits & IP_BIT_PREALLOC)
 297
 298 #define IP_SET_PREALLOC(port, kmsg)                                     \
 299 MACRO_BEGIN                                                             \
 300         (port)->ip_object.io_bits |= IP_BIT_PREALLOC;                   \
 301         (port)->ip_premsg = (kmsg);                                     \
 302 MACRO_END
 303
 304 #define IP_CLEAR_PREALLOC(port, kmsg)                                   \
 305 MACRO_BEGIN                                                             \
 306         assert((port)->ip_premsg == kmsg);                              \
 307         (port)->ip_object.io_bits &= ~IP_BIT_PREALLOC;                  \
 308         (port)->ip_premsg = IKM_NULL;                                   \
 309 MACRO_END
 310
 311 /* JMM - address alignment/packing for LP64 */
 312 struct ipc_port_request {
 313         union {
 314                 struct ipc_port *port;
 315                 ipc_port_request_index_t index;
 316         } notify;
 317
 318         union {
 319                 mach_port_name_t name;
 320                 struct ipc_table_size *size;
 321         } name;
 322 };
 323
 324 #define ipr_next                notify.index
 325 #define ipr_size                name.size
 326
 327 #define ipr_soright             notify.port
 328 #define ipr_name                name.name
 329
 330 /*
 331  * Use the low bits in the ipr_soright to specify the request type
 332  */
 333 #define IPR_SOR_SPARM_MASK      1               /* send-possible armed */
 334 #define IPR_SOR_SPREQ_MASK      2               /* send-possible requested */
 335 #define IPR_SOR_SPBIT_MASK      3               /* combo */
 336 #define IPR_SOR_SPARMED(sor)    (((uintptr_t)(sor) & IPR_SOR_SPARM_MASK) != 0)
 337 #define IPR_SOR_SPREQ(sor)      (((uintptr_t)(sor) & IPR_SOR_SPREQ_MASK) != 0)
 338 #define IPR_SOR_PORT(sor)       ((ipc_port_t)((uintptr_t)(sor) & ~IPR_SOR_SPBIT_MASK))
 339 #define IPR_SOR_MAKE(p, m)       ((ipc_port_t)((uintptr_t)(p) | (m)))
 340
 341 extern lck_grp_t        ipc_lck_grp;
 342 extern lck_attr_t       ipc_lck_attr;
 343
 344 /*
 345  *      Taking the ipc_port_multiple lock grants the privilege
 346  *      to lock multiple ports at once.  No ports must locked
 347  *      when it is taken.
 348  */
 349
 350 extern lck_spin_t ipc_port_multiple_lock_data;
 351
 352 #define ipc_port_multiple_lock_init()                                   \
 353                 lck_spin_init(&ipc_port_multiple_lock_data, &ipc_lck_grp, &ipc_lck_attr)
 354
 355 #define ipc_port_multiple_lock()                                        \
 356                 lck_spin_lock_grp(&ipc_port_multiple_lock_data, &ipc_lck_grp)
 357
 358 #define ipc_port_multiple_unlock()                                      \
 359                 lck_spin_unlock(&ipc_port_multiple_lock_data)
 360
 361 /*
 362  *      The port timestamp facility provides timestamps
 363  *      for port destruction.  It is used to serialize
 364  *      mach_port_names with port death.
 365  */
 366
 367 extern ipc_port_timestamp_t ipc_port_timestamp_data;
 368
 369 /* Retrieve a port timestamp value */
 370 extern ipc_port_timestamp_t ipc_port_timestamp(void);
 371
 372 /*
 373  *      Compares two timestamps, and returns TRUE if one
 374  *      happened before two.  Note that this formulation
 375  *      works when the timestamp wraps around at 2^32,
 376  *      as long as one and two aren't too far apart.
 377  */
 378
 379 #define IP_TIMESTAMP_ORDER(one, two)    ((int) ((one) - (two)) < 0)
 380
 381 static inline void
 382 require_ip_active(ipc_port_t port)
 383 {
 384         if (!ip_active(port)) {
 385                 panic("Using inactive port %p", port);
 386         }
 387 }
 388
 389 static inline kern_return_t
 390 ipc_port_translate(
 391         ipc_space_t                     space,
 392         mach_port_name_t                name,
 393         mach_port_right_t               right,
 394         ipc_port_t                     *portp)
 395 {
 396         ipc_object_t object;
 397         kern_return_t kr;
 398
 399         kr = ipc_object_translate(space, name, right, &object);
 400         *portp = (kr == KERN_SUCCESS) ? ip_object_to_port(object) : IP_NULL;
 401         return kr;
 402 }
 403
 404 #define ipc_port_translate_receive(space, name, portp)                  \
 405         ipc_port_translate((space), (name), MACH_PORT_RIGHT_RECEIVE, portp)
 406
 407 #define ipc_port_translate_send(space, name, portp)                     \
 408         ipc_port_translate((space), (name), MACH_PORT_RIGHT_SEND, portp)
 409
 410 /* Allocate a notification request slot */
 411 #if IMPORTANCE_INHERITANCE
 412 extern kern_return_t
 413 ipc_port_request_alloc(
 414         ipc_port_t                      port,
 415         mach_port_name_t                name,
 416         ipc_port_t                      soright,
 417         boolean_t                       send_possible,
 418         boolean_t                       immediate,
 419         ipc_port_request_index_t        *indexp,
 420         boolean_t                       *importantp);
 421 #else
 422 extern kern_return_t
 423 ipc_port_request_alloc(
 424         ipc_port_t                      port,
 425         mach_port_name_t                name,
 426         ipc_port_t                      soright,
 427         boolean_t                       send_possible,
 428         boolean_t                       immediate,
 429         ipc_port_request_index_t        *indexp);
 430 #endif /* IMPORTANCE_INHERITANCE */
 431
 432 /* Grow one of a port's tables of notifcation requests */
 433 extern kern_return_t ipc_port_request_grow(
 434         ipc_port_t                      port,
 435         ipc_table_elems_t               target_size);
 436
 437 /* Return the type(s) of notification requests outstanding */
 438 extern mach_port_type_t ipc_port_request_type(
 439         ipc_port_t                      port,
 440         mach_port_name_t                name,
 441         ipc_port_request_index_t        index);
 442
 443 /* Cancel a notification request and return the send-once right */
 444 extern ipc_port_t ipc_port_request_cancel(
 445         ipc_port_t                      port,
 446         mach_port_name_t                name,
 447         ipc_port_request_index_t        index);
 448
 449 /* Arm any delayed send-possible notification */
 450 extern boolean_t ipc_port_request_sparm(
 451         ipc_port_t                port,
 452         mach_port_name_t          name,
 453         ipc_port_request_index_t  index,
 454         mach_msg_option_t         option,
 455         mach_msg_priority_t       override);
 456
 457 /* Make a port-deleted request */
 458 extern void ipc_port_pdrequest(
 459         ipc_port_t      port,
 460         ipc_port_t      notify,
 461         ipc_port_t      *previousp);
 462
 463 /* Make a no-senders request */
 464 extern void ipc_port_nsrequest(
 465         ipc_port_t              port,
 466         mach_port_mscount_t     sync,
 467         ipc_port_t              notify,
 468         ipc_port_t              *previousp);
 469
 470 /* Prepare a receive right for transmission/destruction */
 471 extern boolean_t ipc_port_clear_receiver(
 472         ipc_port_t              port,
 473         boolean_t               should_destroy);
 474
 475 __options_decl(ipc_port_init_flags_t, uint32_t, {
 476         IPC_PORT_INIT_NONE            = 0x00000000,
 477         IPC_PORT_INIT_MAKE_SEND_RIGHT = 0x00000001,
 478         IPC_PORT_INIT_MESSAGE_QUEUE   = 0x00000002,
 479         IPC_PORT_INIT_SPECIAL_REPLY   = 0x00000004,
 480 });
 481
 482 /* Initialize a newly-allocated port */
 483 extern void ipc_port_init(
 484         ipc_port_t              port,
 485         ipc_space_t             space,
 486         ipc_port_init_flags_t   flags,
 487         mach_port_name_t        name);
 488
 489 /* Allocate a port */
 490 extern kern_return_t ipc_port_alloc(
 491         ipc_space_t             space,
 492         ipc_port_init_flags_t   flags,
 493         mach_port_name_t        *namep,
 494         ipc_port_t              *portp);
 495
 496 /* Allocate a port, with a specific name */
 497 extern kern_return_t ipc_port_alloc_name(
 498         ipc_space_t             space,
 499         ipc_port_init_flags_t   flags,
 500         mach_port_name_t        name,
 501         ipc_port_t              *portp);
 502
 503 /* Generate dead name notifications */
 504 extern void ipc_port_dnnotify(
 505         ipc_port_t              port);
 506
 507 /* Generate send-possible notifications */
 508 extern void ipc_port_spnotify(
 509         ipc_port_t              port);
 510
 511 /* Destroy a port */
 512 extern void ipc_port_destroy(
 513         ipc_port_t      port);
 514
 515 /* Check if queueing "port" in a message for "dest" would create a circular
 516  *  group of ports and messages */
 517 extern boolean_t
 518 ipc_port_check_circularity(
 519         ipc_port_t      port,
 520         ipc_port_t      dest);
 521
 522 #if IMPORTANCE_INHERITANCE
 523
 524 enum {
 525         IPID_OPTION_NORMAL       = 0, /* normal boost */
 526         IPID_OPTION_SENDPOSSIBLE = 1, /* send-possible induced boost */
 527 };
 528
 529 /* link the destination port with special reply port */
 530 void
 531 ipc_port_link_special_reply_port(
 532         ipc_port_t special_reply_port,
 533         ipc_port_t dest_port,
 534         boolean_t sync_bootstrap_checkin);
 535
 536 #define IPC_PORT_ADJUST_SR_NONE                      0
 537 #define IPC_PORT_ADJUST_SR_ALLOW_SYNC_LINKAGE        0x1
 538 #define IPC_PORT_ADJUST_SR_LINK_WORKLOOP             0x2
 539 #define IPC_PORT_ADJUST_UNLINK_THREAD                0x4
 540 #define IPC_PORT_ADJUST_SR_RECEIVED_MSG              0x8
 541 #define IPC_PORT_ADJUST_SR_ENABLE_EVENT              0x10
 542 #define IPC_PORT_ADJUST_RESET_BOOSTRAP_CHECKIN       0x20
 543
 544 void
 545 ipc_special_reply_port_bits_reset(ipc_port_t special_reply_port);
 546
 547 void
 548 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
 549
 550 void
 551 ipc_special_reply_port_msg_sent(ipc_port_t special_reply_port);
 552
 553 /* Adjust special reply port linkage */
 554 void
 555 ipc_port_adjust_special_reply_port_locked(
 556         ipc_port_t special_reply_port,
 557         struct knote *kn,
 558         uint8_t flags,
 559         boolean_t get_turnstile);
 560
 561 void
 562 ipc_port_adjust_sync_link_state_locked(
 563         ipc_port_t port,
 564         int sync_link_state,
 565         turnstile_inheritor_t inheritor);
 566
 567 /* Adjust special reply port linkage */
 568 void
 569 ipc_port_adjust_special_reply_port(
 570         ipc_port_t special_reply_port,
 571         uint8_t flags);
 572
 573 void
 574 ipc_port_adjust_port_locked(
 575         ipc_port_t port,
 576         struct knote *kn,
 577         boolean_t sync_bootstrap_checkin);
 578
 579 void
 580 ipc_port_clear_sync_rcv_thread_boost_locked(
 581         ipc_port_t port);
 582
 583 kern_return_t
 584 ipc_port_add_watchport_elem_locked(
 585         ipc_port_t                 port,
 586         struct task_watchport_elem *watchport_elem,
 587         struct task_watchport_elem **old_elem);
 588
 589 kern_return_t
 590 ipc_port_clear_watchport_elem_internal_conditional_locked(
 591         ipc_port_t                 port,
 592         struct task_watchport_elem *watchport_elem);
 593
 594 kern_return_t
 595 ipc_port_replace_watchport_elem_conditional_locked(
 596         ipc_port_t                 port,
 597         struct task_watchport_elem *old_watchport_elem,
 598         struct task_watchport_elem *new_watchport_elem);
 599
 600 struct task_watchport_elem *
 601 ipc_port_clear_watchport_elem_internal(
 602         ipc_port_t                 port);
 603
 604 void
 605 ipc_port_send_turnstile_prepare(ipc_port_t port);
 606
 607 void
 608 ipc_port_send_turnstile_complete(ipc_port_t port);
 609
 610 struct waitq *
 611 ipc_port_rcv_turnstile_waitq(struct waitq *waitq);
 612
 613 /* apply importance delta to port only */
 614 extern mach_port_delta_t
 615 ipc_port_impcount_delta(
 616         ipc_port_t              port,
 617         mach_port_delta_t       delta,
 618         ipc_port_t              base);
 619
 620 /* apply importance delta to port, and return task importance for update */
 621 extern boolean_t
 622 ipc_port_importance_delta_internal(
 623         ipc_port_t              port,
 624         natural_t               options,
 625         mach_port_delta_t       *deltap,
 626         ipc_importance_task_t   *imp_task);
 627
 628 /* Apply an importance delta to a port and reflect change in receiver task */
 629 extern boolean_t
 630 ipc_port_importance_delta(
 631         ipc_port_t              port,
 632         natural_t               options,
 633         mach_port_delta_t       delta);
 634 #endif /* IMPORTANCE_INHERITANCE */
 635
 636 /* Make a naked send right from a receive right - port locked and active */
 637 extern ipc_port_t ipc_port_make_send_locked(
 638         ipc_port_t      port);
 639
 640 /* Make a naked send right from a receive right */
 641 extern ipc_port_t ipc_port_make_send(
 642         ipc_port_t      port);
 643
 644 /* Make a naked send right from another naked send right - port locked and active */
 645 extern void ipc_port_copy_send_locked(
 646         ipc_port_t      port);
 647
 648 /* Make a naked send right from another naked send right */
 649 extern ipc_port_t ipc_port_copy_send(
 650         ipc_port_t      port);
 651
 652 /* Copyout a naked send right */
 653 extern mach_port_name_t ipc_port_copyout_send(
 654         ipc_port_t      sright,
 655         ipc_space_t     space);
 656
 657 #endif /* MACH_KERNEL_PRIVATE */
 658
 659 #if KERNEL_PRIVATE
 660
 661 /* Release a (valid) naked send right */
 662 extern void ipc_port_release_send(
 663         ipc_port_t      port);
 664
 665 extern void ipc_port_reference(
 666         ipc_port_t port);
 667
 668 extern void ipc_port_release(
 669         ipc_port_t port);
 670
 671 #endif /* KERNEL_PRIVATE */
 672
 673 #ifdef MACH_KERNEL_PRIVATE
 674
 675 /* Make a naked send-once right from a locked and active receive right */
 676 extern ipc_port_t ipc_port_make_sonce_locked(
 677         ipc_port_t      port);
 678
 679 /* Make a naked send-once right from a receive right */
 680 extern ipc_port_t ipc_port_make_sonce(
 681         ipc_port_t      port);
 682
 683 /* Release a naked send-once right */
 684 extern void ipc_port_release_sonce(
 685         ipc_port_t      port);
 686
 687 /* Release a naked (in limbo or in transit) receive right */
 688 extern void ipc_port_release_receive(
 689         ipc_port_t      port);
 690
 691 /* finalize the destruction of a port before it gets freed */
 692 extern void ipc_port_finalize(
 693         ipc_port_t      port);
 694
 695 /* Allocate a port in a special space */
 696 extern ipc_port_t ipc_port_alloc_special(
 697         ipc_space_t             space,
 698         ipc_port_init_flags_t   flags);
 699
 700 /* Deallocate a port in a special space */
 701 extern void ipc_port_dealloc_special(
 702         ipc_port_t      port,
 703         ipc_space_t     space);
 704
 705 #if     MACH_ASSERT
 706 /* Track low-level port deallocation */
 707 extern void ipc_port_track_dealloc(
 708         ipc_port_t      port);
 709
 710 /* Initialize general port debugging state */
 711 extern void ipc_port_debug_init(void);
 712 #endif  /* MACH_ASSERT */
 713
 714 extern void ipc_port_recv_update_inheritor(ipc_port_t port,
 715     struct turnstile *turnstile,
 716     turnstile_update_flags_t flags);
 717
 718 extern void ipc_port_send_update_inheritor(ipc_port_t port,
 719     struct turnstile *turnstile,
 720     turnstile_update_flags_t flags);
 721
 722 #define ipc_port_alloc_kernel()         \
 723                 ipc_port_alloc_special(ipc_space_kernel, IPC_PORT_INIT_NONE)
 724 #define ipc_port_dealloc_kernel(port)   \
 725                 ipc_port_dealloc_special((port), ipc_space_kernel)
 726
 727 #define ipc_port_alloc_reply()          \
 728                 ipc_port_alloc_special(ipc_space_reply, IPC_PORT_INIT_MESSAGE_QUEUE)
 729 #define ipc_port_dealloc_reply(port)    \
 730                 ipc_port_dealloc_special((port), ipc_space_reply)
 731
 732 #endif /* MACH_KERNEL_PRIVATE */
 733
 734 #endif  /* _IPC_IPC_PORT_H_ */