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_rt.h>
  78 #include <mach_assert.h>
  79 #include <mach_debug.h>
  80
  81 #include <mach/mach_types.h>
  82 #include <mach/boolean.h>
  83 #include <mach/kern_return.h>
  84 #include <mach/port.h>
  85
  86 #include <kern/assert.h>
  87 #include <kern/kern_types.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 typedef unsigned int ipc_port_timestamp_t;
 112
 113 struct ipc_port {
 114
 115         /*
 116          * Initial sub-structure in common with ipc_pset
 117          * First element is an ipc_object second is a
 118          * message queue
 119          */
 120         struct ipc_object ip_object;
 121         struct ipc_mqueue ip_messages;
 122
 123         union {
 124                 struct ipc_space *receiver;
 125                 struct ipc_port *destination;
 126                 ipc_port_timestamp_t timestamp;
 127         } data;
 128
 129         union {
 130                 ipc_kobject_t kobject;
 131                 ipc_importance_task_t imp_task;
 132         } kdata;
 133
 134         struct ipc_port *ip_nsrequest;
 135         struct ipc_port *ip_pdrequest;
 136         struct ipc_port_request *ip_requests;
 137         struct ipc_kmsg *ip_premsg;
 138
 139         mach_vm_address_t ip_context;
 140
 141         natural_t ip_sprequests:1,      /* send-possible requests outstanding */
 142                   ip_spimportant:1,     /* ... at least one is importance donating */
 143                   ip_impdonation:1,     /* port supports importance donation */
 144                   ip_tempowner:1,       /* dont give donations to current receiver */
 145                   ip_guarded:1,         /* port guarded (use context value as guard) */
 146                   ip_strict_guard:1,    /* Strict guarding; Prevents user manipulation of context values directly */
 147                   ip_reserved:2,
 148                   ip_impcount:24;       /* number of importance donations in nested queue */
 149
 150         mach_port_mscount_t ip_mscount;
 151         mach_port_rights_t ip_srights;
 152         mach_port_rights_t ip_sorights;
 153
 154 #if     MACH_ASSERT
 155 #define IP_NSPARES              4
 156 #define IP_CALLSTACK_MAX        16
 157 /*      queue_chain_t   ip_port_links;*//* all allocated ports */
 158         thread_t        ip_thread;      /* who made me?  thread context */
 159         unsigned long   ip_timetrack;   /* give an idea of "when" created */
 160         uintptr_t       ip_callstack[IP_CALLSTACK_MAX]; /* stack trace */
 161         unsigned long   ip_spares[IP_NSPARES]; /* for debugging */
 162 #endif  /* MACH_ASSERT */
 163 };
 164
 165
 166 #define ip_references           ip_object.io_references
 167 #define ip_bits                 ip_object.io_bits
 168
 169 #define ip_receiver_name        ip_messages.imq_receiver_name
 170 #define ip_in_pset              ip_messages.imq_in_pset
 171
 172 #define ip_receiver             data.receiver
 173 #define ip_destination          data.destination
 174 #define ip_timestamp            data.timestamp
 175
 176 #define ip_kobject              kdata.kobject
 177 #define ip_imp_task             kdata.imp_task
 178
 179 #define IP_NULL                 IPC_PORT_NULL
 180 #define IP_DEAD                 IPC_PORT_DEAD
 181 #define IP_VALID(port)          IPC_PORT_VALID(port)
 182
 183 #define ip_active(port)         io_active(&(port)->ip_object)
 184 #define ip_lock_init(port)      io_lock_init(&(port)->ip_object)
 185 #define ip_lock(port)           io_lock(&(port)->ip_object)
 186 #define ip_lock_try(port)       io_lock_try(&(port)->ip_object)
 187 #define ip_lock_held_kdp(port)  io_lock_held_kdp(&(port)->ip_object)
 188 #define ip_unlock(port)         io_unlock(&(port)->ip_object)
 189
 190 #define ip_reference(port)      io_reference(&(port)->ip_object)
 191 #define ip_release(port)        io_release(&(port)->ip_object)
 192
 193 /* get an ipc_port pointer from an ipc_mqueue pointer */
 194 #define ip_from_mq(mq)          ((struct ipc_port *)((void *)( \
 195                                         (char *)(mq) - \
 196                                         __offsetof(struct ipc_port, ip_messages)) \
 197                                 ))
 198
 199 #define ip_reference_mq(mq)     ip_reference(ip_from_mq(mq))
 200 #define ip_release_mq(mq)       ip_release(ip_from_mq(mq))
 201
 202 #define ip_kotype(port)         io_kotype(&(port)->ip_object)
 203
 204 #define ip_full_kernel(port)    imq_full_kernel(&(port)->ip_messages)
 205 #define ip_full(port)           imq_full(&(port)->ip_messages)
 206
 207 /*
 208  * JMM - Preallocation flag
 209  * This flag indicates that there is a message buffer preallocated for this
 210  * port and we should use that when sending (from the kernel) rather than
 211  * allocate a new one.  This avoids deadlocks during notification message
 212  * sends by critical system threads (which may be needed to free memory and
 213  * therefore cannot be blocked waiting for memory themselves).
 214  */
 215 #define IP_BIT_PREALLOC         0x00008000      /* preallocated mesg */
 216 #define IP_PREALLOC(port)       ((port)->ip_bits & IP_BIT_PREALLOC)
 217
 218 #define IP_SET_PREALLOC(port, kmsg)                                     \
 219 MACRO_BEGIN                                                             \
 220         (port)->ip_bits |= IP_BIT_PREALLOC;                             \
 221         (port)->ip_premsg = (kmsg);                                     \
 222 MACRO_END
 223
 224 #define IP_CLEAR_PREALLOC(port, kmsg)                                   \
 225 MACRO_BEGIN                                                             \
 226         assert((port)->ip_premsg == kmsg);                              \
 227         (port)->ip_bits &= ~IP_BIT_PREALLOC;                            \
 228         (port)->ip_premsg = IKM_NULL;                                   \
 229 MACRO_END
 230
 231 /* JMM - address alignment/packing for LP64 */
 232 struct ipc_port_request {
 233         union {
 234                 struct ipc_port *port;
 235                 ipc_port_request_index_t index;
 236         } notify;
 237
 238         union {
 239                 mach_port_name_t name;
 240                 struct ipc_table_size *size;
 241         } name;
 242 };
 243
 244 #define ipr_next                notify.index
 245 #define ipr_size                name.size
 246
 247 #define ipr_soright             notify.port
 248 #define ipr_name                name.name
 249
 250 /*
 251  * Use the low bits in the ipr_soright to specify the request type
 252  */
 253 #define IPR_SOR_SPARM_MASK      1               /* send-possible armed */
 254 #define IPR_SOR_SPREQ_MASK      2               /* send-possible requested */
 255 #define IPR_SOR_SPBIT_MASK      3               /* combo */
 256 #define IPR_SOR_SPARMED(sor)    (((uintptr_t)(sor) & IPR_SOR_SPARM_MASK) != 0)
 257 #define IPR_SOR_SPREQ(sor)      (((uintptr_t)(sor) & IPR_SOR_SPREQ_MASK) != 0)
 258 #define IPR_SOR_PORT(sor)       ((ipc_port_t)((uintptr_t)(sor) & ~IPR_SOR_SPBIT_MASK))
 259 #define IPR_SOR_MAKE(p,m)       ((ipc_port_t)((uintptr_t)(p) | (m)))
 260
 261 extern lck_grp_t        ipc_lck_grp;
 262 extern lck_attr_t       ipc_lck_attr;
 263
 264 /*
 265  *      Taking the ipc_port_multiple lock grants the privilege
 266  *      to lock multiple ports at once.  No ports must locked
 267  *      when it is taken.
 268  */
 269
 270 extern lck_spin_t ipc_port_multiple_lock_data;
 271
 272 #define ipc_port_multiple_lock_init()                                   \
 273                 lck_spin_init(&ipc_port_multiple_lock_data, &ipc_lck_grp, &ipc_lck_attr)
 274
 275 #define ipc_port_multiple_lock()                                        \
 276                 lck_spin_lock(&ipc_port_multiple_lock_data)
 277
 278 #define ipc_port_multiple_unlock()                                      \
 279                 lck_spin_unlock(&ipc_port_multiple_lock_data)
 280
 281 /*
 282  *      The port timestamp facility provides timestamps
 283  *      for port destruction.  It is used to serialize
 284  *      mach_port_names with port death.
 285  */
 286
 287 extern ipc_port_timestamp_t ipc_port_timestamp_data;
 288
 289 /* Retrieve a port timestamp value */
 290 extern ipc_port_timestamp_t ipc_port_timestamp(void);
 291
 292 /*
 293  *      Compares two timestamps, and returns TRUE if one
 294  *      happened before two.  Note that this formulation
 295  *      works when the timestamp wraps around at 2^32,
 296  *      as long as one and two aren't too far apart.
 297  */
 298
 299 #define IP_TIMESTAMP_ORDER(one, two)    ((int) ((one) - (two)) < 0)
 300
 301 #define ipc_port_translate_receive(space, name, portp)                  \
 302                 ipc_object_translate((space), (name),                   \
 303                                      MACH_PORT_RIGHT_RECEIVE,           \
 304                                      (ipc_object_t *) (portp))
 305
 306 #define ipc_port_translate_send(space, name, portp)                     \
 307                 ipc_object_translate((space), (name),                   \
 308                                      MACH_PORT_RIGHT_SEND,              \
 309                                      (ipc_object_t *) (portp))
 310
 311 /* Allocate a notification request slot */
 312 #if IMPORTANCE_INHERITANCE
 313 extern kern_return_t
 314 ipc_port_request_alloc(
 315         ipc_port_t                      port,
 316         mach_port_name_t                name,
 317         ipc_port_t                      soright,
 318         boolean_t                       send_possible,
 319         boolean_t                       immediate,
 320         ipc_port_request_index_t        *indexp,
 321         boolean_t                       *importantp);
 322 #else
 323 extern kern_return_t
 324 ipc_port_request_alloc(
 325         ipc_port_t                      port,
 326         mach_port_name_t                name,
 327         ipc_port_t                      soright,
 328         boolean_t                       send_possible,
 329         boolean_t                       immediate,
 330         ipc_port_request_index_t        *indexp);
 331 #endif /* IMPORTANCE_INHERITANCE */
 332
 333 /* Grow one of a port's tables of notifcation requests */
 334 extern kern_return_t ipc_port_request_grow(
 335         ipc_port_t                      port,
 336         ipc_table_elems_t               target_size);
 337
 338 /* Return the type(s) of notification requests outstanding */
 339 extern mach_port_type_t ipc_port_request_type(
 340         ipc_port_t                      port,
 341         mach_port_name_t                name,
 342         ipc_port_request_index_t        index);
 343
 344 /* Cancel a notification request and return the send-once right */
 345 extern ipc_port_t ipc_port_request_cancel(
 346         ipc_port_t                      port,
 347         mach_port_name_t                name,
 348         ipc_port_request_index_t        index);
 349
 350 /* Arm any delayed send-possible notification */
 351 extern boolean_t ipc_port_request_sparm(
 352         ipc_port_t                port,
 353         mach_port_name_t          name,
 354         ipc_port_request_index_t  index,
 355         mach_msg_option_t         option,
 356         mach_msg_priority_t       override);
 357
 358 /* Macros for manipulating a port's dead name notificaiton requests */
 359 #define ipc_port_request_rename(port, index, oname, nname)              \
 360 MACRO_BEGIN                                                             \
 361         ipc_port_request_t ipr, table;                                  \
 362                                                                         \
 363         assert(ip_active(port));                                        \
 364                                                                         \
 365         table = port->ip_requests;                                      \
 366         assert(table != IPR_NULL);                                      \
 367                                                                         \
 368         ipr = &table[index];                                            \
 369         assert(ipr->ipr_name == oname);                                 \
 370                                                                         \
 371         ipr->ipr_name = nname;                                          \
 372 MACRO_END
 373
 374
 375 /* Make a port-deleted request */
 376 extern void ipc_port_pdrequest(
 377         ipc_port_t      port,
 378         ipc_port_t      notify,
 379         ipc_port_t      *previousp);
 380
 381 /* Make a no-senders request */
 382 extern void ipc_port_nsrequest(
 383         ipc_port_t              port,
 384         mach_port_mscount_t     sync,
 385         ipc_port_t              notify,
 386         ipc_port_t              *previousp);
 387
 388 #define ipc_port_set_mscount(port, mscount)                             \
 389 MACRO_BEGIN                                                             \
 390         assert(ip_active(port));                                        \
 391                                                                         \
 392         (port)->ip_mscount = (mscount);                                 \
 393 MACRO_END
 394
 395 /* Prepare a receive right for transmission/destruction */
 396 extern boolean_t ipc_port_clear_receiver(
 397         ipc_port_t              port,
 398         boolean_t               should_destroy);
 399
 400 /* Initialize a newly-allocated port */
 401 extern void ipc_port_init(
 402         ipc_port_t              port,
 403         ipc_space_t             space,
 404         mach_port_name_t        name);
 405
 406 /* Allocate a port */
 407 extern kern_return_t ipc_port_alloc(
 408         ipc_space_t             space,
 409         mach_port_name_t        *namep,
 410         ipc_port_t              *portp);
 411
 412 /* Allocate a port, with a specific name */
 413 extern kern_return_t ipc_port_alloc_name(
 414         ipc_space_t             space,
 415         mach_port_name_t        name,
 416         ipc_port_t              *portp);
 417
 418 /* Generate dead name notifications */
 419 extern void ipc_port_dnnotify(
 420         ipc_port_t              port);
 421
 422 /* Generate send-possible notifications */
 423 extern void ipc_port_spnotify(
 424         ipc_port_t              port);
 425
 426 /* Destroy a port */
 427 extern void ipc_port_destroy(
 428         ipc_port_t      port);
 429
 430 /* Check if queueing "port" in a message for "dest" would create a circular
 431    group of ports and messages */
 432 extern boolean_t
 433 ipc_port_check_circularity(
 434         ipc_port_t      port,
 435         ipc_port_t      dest);
 436
 437 #if IMPORTANCE_INHERITANCE
 438
 439 enum {
 440         IPID_OPTION_NORMAL       = 0, /* normal boost */
 441         IPID_OPTION_SENDPOSSIBLE = 1, /* send-possible induced boost */
 442 };
 443
 444 /* apply importance delta to port only */
 445 extern mach_port_delta_t
 446 ipc_port_impcount_delta(
 447         ipc_port_t              port,
 448         mach_port_delta_t       delta,
 449         ipc_port_t              base);
 450
 451 /* apply importance delta to port, and return task importance for update */
 452 extern boolean_t
 453 ipc_port_importance_delta_internal(
 454         ipc_port_t              port,
 455         natural_t               options,
 456         mach_port_delta_t       *deltap,
 457         ipc_importance_task_t   *imp_task);
 458
 459 /* Apply an importance delta to a port and reflect change in receiver task */
 460 extern boolean_t
 461 ipc_port_importance_delta(
 462         ipc_port_t              port,
 463         natural_t               options,
 464         mach_port_delta_t       delta);
 465 #endif /* IMPORTANCE_INHERITANCE */
 466
 467 /* Make a send-once notify port from a receive right */
 468 extern ipc_port_t ipc_port_lookup_notify(
 469         ipc_space_t             space,
 470         mach_port_name_t        name);
 471
 472 /* Make a naked send right from a receive right - port locked and active */
 473 extern ipc_port_t ipc_port_make_send_locked(
 474         ipc_port_t      port);
 475
 476 /* Make a naked send right from a receive right */
 477 extern ipc_port_t ipc_port_make_send(
 478         ipc_port_t      port);
 479
 480 /* Make a naked send right from another naked send right */
 481 extern ipc_port_t ipc_port_copy_send(
 482         ipc_port_t      port);
 483
 484 /* Copyout a naked send right */
 485 extern mach_port_name_t ipc_port_copyout_send(
 486         ipc_port_t      sright,
 487         ipc_space_t     space);
 488
 489 #endif /* MACH_KERNEL_PRIVATE */
 490
 491 #if KERNEL_PRIVATE
 492
 493 /* Release a (valid) naked send right */
 494 extern void ipc_port_release_send(
 495         ipc_port_t      port);
 496
 497 extern void ipc_port_reference(
 498         ipc_port_t port);
 499
 500 extern void ipc_port_release(
 501         ipc_port_t port);
 502
 503 #endif /* KERNEL_PRIVATE */
 504
 505 #ifdef MACH_KERNEL_PRIVATE
 506
 507 /* Make a naked send-once right from a locked and active receive right */
 508 extern ipc_port_t ipc_port_make_sonce_locked(
 509         ipc_port_t      port);
 510
 511 /* Make a naked send-once right from a receive right */
 512 extern ipc_port_t ipc_port_make_sonce(
 513         ipc_port_t      port);
 514
 515 /* Release a naked send-once right */
 516 extern void ipc_port_release_sonce(
 517         ipc_port_t      port);
 518
 519 /* Release a naked (in limbo or in transit) receive right */
 520 extern void ipc_port_release_receive(
 521         ipc_port_t      port);
 522
 523 /* finalize the destruction of a port before it gets freed */
 524 extern void ipc_port_finalize(
 525         ipc_port_t      port);
 526
 527 /* Allocate a port in a special space */
 528 extern ipc_port_t ipc_port_alloc_special(
 529         ipc_space_t     space);
 530
 531 /* Deallocate a port in a special space */
 532 extern void ipc_port_dealloc_special(
 533         ipc_port_t      port,
 534         ipc_space_t     space);
 535
 536 #if     MACH_ASSERT
 537 /* Track low-level port deallocation */
 538 extern void ipc_port_track_dealloc(
 539         ipc_port_t      port);
 540
 541 /* Initialize general port debugging state */
 542 extern void ipc_port_debug_init(void);
 543 #endif  /* MACH_ASSERT */
 544
 545 #define ipc_port_alloc_kernel()         \
 546                 ipc_port_alloc_special(ipc_space_kernel)
 547 #define ipc_port_dealloc_kernel(port)   \
 548                 ipc_port_dealloc_special((port), ipc_space_kernel)
 549
 550 #define ipc_port_alloc_reply()          \
 551                 ipc_port_alloc_special(ipc_space_reply)
 552 #define ipc_port_dealloc_reply(port)    \
 553                 ipc_port_dealloc_special((port), ipc_space_reply)
 554
 555 #endif /* MACH_KERNEL_PRIVATE */
 556
 557 #endif  /* _IPC_IPC_PORT_H_ */