X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/ff6e181ae92fc6f1e89841290f461d1f2f9badd9..6d2010ae8f7a6078e10b361c6962983bab233e0f:/osfmk/mach/mach_port.defs diff --git a/osfmk/mach/mach_port.defs b/osfmk/mach/mach_port.defs index a3ea118e5..6c612758d 100644 --- a/osfmk/mach/mach_port.defs +++ b/osfmk/mach/mach_port.defs @@ -1,14 +1,19 @@ /* * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved. * - * @APPLE_LICENSE_HEADER_START@ + * @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 @@ -18,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@ @@ -219,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( @@ -233,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 @@ -245,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( @@ -380,10 +397,8 @@ routine mach_port_get_srights( routine mach_port_space_info( task : ipc_space_t; out space_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 table_info : ipc_info_name_array_t; + out tree_info : ipc_info_tree_name_array_t); /* * Returns information about the dead-name requests @@ -402,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); /* @@ -449,3 +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 : */