xnu-1504.9.17.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 bac4fefaa56e2ecabec45fa239d045ee85f1b702..5801ee42c712f607bbcc78ed299cca8f9d38c911 100644 (file)
--- a/osfmk/mach/mach_port.defs
+++ b/osfmk/mach/mach_port.defs
@@ -1,16 +1,19 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ * 
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
@@ -20,7 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_FREE_COPYRIGHT@
@@ -62,7 +65,7 @@
 subsystem
 #if    KERNEL_SERVER
          KernelServer
-#endif KERNEL_SERVER
+#endif /* KERNEL_SERVER */
          mach_port 3200;
 
 #include <mach/std_types.defs>
@@ -221,9 +224,10 @@ routine mach_port_get_set_status(
 
 /*
  *     Puts the member port (the task must have receive rights)
- *     into the after port set.  (Or removes it from any port set
- *     if after is MACH_PORT_NULL.)  If the port is already in
- *     a set, does an atomic move.
+ *     into the after port set.  If the port is already a member
+ *     of any set(s), it is atomically removed from those sets as
+ *     part of this operation.  (If after is MACH_PORT_NULL, the
+ *     port is still removed from all current sets).
  */
 
 routine mach_port_move_member(
@@ -381,11 +385,9 @@ routine    mach_port_get_srights(
  */
 routine mach_port_space_info(
                task            : ipc_space_t;
-       out     info            : ipc_info_space_t;
-       out     table_info      : ipc_info_name_array_t,
-                                       Dealloc;
-       out     tree_info       : ipc_info_tree_name_array_t,
-                                       Dealloc);
+       out     space_info      : ipc_info_space_t;
+       out     table_info      : ipc_info_name_array_t;
+       out     tree_info       : ipc_info_tree_name_array_t);
 
 /*
  *     Returns information about the dead-name requests
@@ -396,20 +398,23 @@ routine mach_port_space_info(
 routine mach_port_dnrequest_info(
                task            : ipc_space_t;
                name            : mach_port_name_t;
-       out     total           : unsigned;     /* total size of table */
-       out     used            : unsigned);    /* amount used */
+       out     dnr_total       : unsigned;     /* total size of table */
+       out     dnr_used        : unsigned);    /* amount used */
 
 /*
  *     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.
+ *
+ *     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);
 
 
 /*
@@ -451,3 +456,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 : */