xnu-1699.22.73.tar.gz

[apple/xnu.git] / osfmk / mach / mach_port.defs

diff --git a/osfmk/mach/mach_port.defs b/osfmk/mach/mach_port.defs
index 88156a84732048ede881965feddd9c3d5e15f1f5..6c612758d1667305bb1238f364919f1af3e6db6e 100644 (file)
--- a/osfmk/mach/mach_port.defs
+++ b/osfmk/mach/mach_port.defs
@@ -239,9 +239,10 @@ routine mach_port_move_member(
  *     Requests a notification from the kernel.  The request
  *     must supply the send-once right which is used for
  *     the notification.  If a send-once right was previously
- *     registered, it is returned.  The msg_id must be one of
+ *     registered, it is returned.  The msgid must be one of:
  *             MACH_NOTIFY_PORT_DESTROYED (receive rights)
  *             MACH_NOTIFY_DEAD_NAME (send/receive/send-once rights)
+ *             MACH_NOTIFY_SEND_POSSIBLE (send/receive/send-once rights)
  *             MACH_NOTIFY_NO_SENDERS (receive rights)
  *
  *     The sync value specifies whether a notification should
@@ -251,10 +252,20 @@ routine mach_port_move_member(
  *             MACH_NOTIFY_DEAD_NAME: if non-zero, then name can be dead,
  *                     and the notification gets sent immediately.
  *                     If zero, then name can't be dead.
+ *             MACH_NOTIFY_SEND_POSSIBLE: if non-zero, will generate a send-
+ *                     possible notification as soon as it is possible to send
+ *                     to the port. If zero, will generate a send-possible
+ *                     notification only after a subsequent failed send
+ *                     (with MACH_SEND_NOTIFY option to mach_msg call).  Can
+ *                     generate a dead-name notification if name is already dead
+ *                     or becomes dead before a send-possible notification fires.
  *             MACH_NOTIFY_NO_SENDERS: the notification gets sent
  *                     immediately if the current mscount is greater
  *                     than or equal to the sync value and there are no
  *                     extant send rights.
+ *
+ * If the name is deleted before a successfully registered notification
+ * is delivered, it is replaced with a port-deleted notification.
  */
 
 routine mach_port_request_notification(
@@ -406,12 +417,15 @@ routine mach_port_dnrequest_info(
  *     that the given send/receive right represents.
  *      This call is only valid on MACH_IPC_DEBUG kernels.
  *      Otherwise, KERN_FAILURE is returned.
+ *
+ *     This interface is DEPRECATED in favor of the new
+ *     mach_port_kernel_object64() call (see below).
  */
 routine        mach_port_kernel_object(
                task            : ipc_space_t;
                name            : mach_port_name_t;
        out     object_type     : unsigned;
-       out     object_addr     : vm_offset_t);
+       out     object_addr     : unsigned);
 
 
 /*
@@ -453,4 +467,37 @@ routine mach_port_extract_member(
                name            : mach_port_name_t;
                pset            : mach_port_name_t);
 
+/*
+ * Only valid for receive rights.
+ * Gets the context pointer for the port.
+ */
+
+routine mach_port_get_context(
+               task            : ipc_space_t;
+               name            : mach_port_name_t;
+       out context             : mach_vm_address_t);
+
+/*
+ * Only valid for receive rights.
+ * Sets the context pointer for the port.
+ */
+
+routine mach_port_set_context(
+               task            : ipc_space_t;
+               name            : mach_port_name_t;
+               context         : mach_vm_address_t);
+
+/*
+ *     Return the type and address of the kernel object
+ *     that the given send/receive right represents.
+ *      This call is only valid on MACH_IPC_DEBUG kernels.
+ *      Otherwise, KERN_FAILURE is returned.
+ */
+routine        mach_port_kobject(
+               task            : ipc_space_t;
+               name            : mach_port_name_t;
+       out     object_type     : natural_t;
+       out     object_addr     : mach_vm_address_t);
+
+
 /* vim: set ft=c : */