/*
* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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. 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.
*
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * 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@
#endif /* KERNEL_SERVER */
mach_port 3200;
+#if !KERNEL && !LIBSYSCALL_INTERFACE
+ UserPrefix _kernelrpc_;
+#endif
+
#include <mach/std_types.defs>
#include <mach/mach_types.defs>
#include <mach_debug/mach_debug_types.defs>
* Changes the name by which a port (or port set) is known to
* the target task. The new name can't be in use. The
* old name becomes available for recycling.
+ *
+ * This interface is OBSOLETE and will always
+ * return KERN_NOT_SUPPORTED.
*/
routine mach_port_rename(
right : mach_port_right_t;
delta : mach_port_delta_t);
-skip;
+/*
+ * Peek at the message queue for the specified receive
+ * right and return info about the message with the
+ * sequence number matching the input. If zero is
+ * specified as the seqno, the first message in the
+ * queue will be peeked.
+ *
+ * Only the following trailer types are currently supported:
+ * MACH_RCV_TRAILER_TYPE(MACH_MSG_TRAILER_FORMAT_0)
+ *
+ * or'ed with one of these element types:
+ * MACH_RCV_TRAILER_ELEMENTS(MACH_RCV_TRAILER_NULL)
+ * MACH_RCV_TRAILER_ELEMENTS(MACH_RCV_TRAILER_SEQNO)
+ * MACH_RCV_TRAILER_ELEMENTS(MACH_RCV_TRAILER_SENDER)
+ * MACH_RCV_TRAILER_ELEMENTS(MACH_RCV_TRAILER_AUDIT)
+ */
+routine mach_port_peek(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+ trailer_type : mach_msg_trailer_type_t;
+ inout request_seqnop : mach_port_seqno_t;
+ out msg_sizep : mach_msg_size_t;
+ out msg_idp : mach_msg_id_t;
+ out trailer_infop : mach_msg_trailer_info_t, CountInOut);
/*
* Only valid for receive rights.
*/
routine mach_port_get_set_status(
- task : ipc_space_t;
+ task : ipc_space_inspect_t;
name : mach_port_name_t;
out members : mach_port_name_array_t);
/*
* 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(
* 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
* 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(
*/
routine mach_port_get_attributes(
- task : ipc_space_t;
+ task : ipc_space_inspect_t;
name : mach_port_name_t;
flavor : mach_port_flavor_t;
out port_info_out : mach_port_info_t, CountInOut);
* Otherwise, KERN_FAILURE is returned.
*/
routine mach_port_space_info(
- task : ipc_space_t;
+ task : ipc_space_inspect_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
* 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;
+ task : ipc_space_inspect_t;
name : mach_port_name_t;
out object_type : unsigned;
- out object_addr : vm_offset_t);
+ out object_addr : unsigned);
/*
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_inspect_t;
+ name : mach_port_name_t;
+#ifdef LIBSYSCALL_INTERFACE
+ out context : mach_port_context_t
+#else
+ out context : mach_vm_address_t
+#endif
+ );
+
+/*
+ * 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;
+#ifdef LIBSYSCALL_INTERFACE
+ context : mach_port_context_t
+#else
+ context : mach_vm_address_t
+#endif
+ );
+
+/*
+ * 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_inspect_t;
+ name : mach_port_name_t;
+ out object_type : natural_t;
+ out object_addr : mach_vm_address_t);
+
+
+/*
+ * Constructs a right based on the options passed
+ * in. Also allows guarding the port as one of the
+ * options if the requested right is a receive
+ * right.
+ */
+routine mach_port_construct(
+ task : ipc_space_t;
+ options : mach_port_options_ptr_t;
+#ifdef LIBSYSCALL_INTERFACE
+ context : mach_port_context_t;
+#else
+ context : uint64_t;
+#endif
+ out name : mach_port_name_t);
+
+/*
+ * Destroys a mach port using the guard provided
+ * for guarded ports. Also reduces the user ref
+ * count for send rights as specified by srdelta.
+ */
+routine mach_port_destruct(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+ srdelta : mach_port_delta_t;
+#ifdef LIBSYSCALL_INTERFACE
+ guard : mach_port_context_t
+#else
+ guard : uint64_t
+#endif
+ );
+
+/*
+ * Guard an already existing port. Allows guarding
+ * receive rights only. Uses the context field in the
+ * port structure to store the guard.
+ */
+routine mach_port_guard(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+#ifdef LIBSYSCALL_INTERFACE
+ guard : mach_port_context_t;
+#else
+ guard : uint64_t;
+#endif
+ strict : boolean_t);
+
+/*
+ * Unguard a port guarded previously. For unguarded ports
+ * or incorrect guards passed in it raises an exception
+ * indicating guarding misbehavior.
+ */
+routine mach_port_unguard(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+#ifdef LIBSYSCALL_INTERFACE
+ guard : mach_port_context_t
+#else
+ guard : uint64_t
+#endif
+ );
+
+/*
+ * Returns basic information about an IPC space.
+ * This call is only valid on MACH_IPC_DEBUG kernels.
+ * Otherwise, KERN_FAILURE is returned.
+ */
+routine mach_port_space_basic_info(
+ task : ipc_space_inspect_t;
+ out basic_info : ipc_info_space_basic_t);
+
+#if KERNEL || !LIBSYSCALL_INTERFACE
+/*
+ * Returns sync ipc turnstile link status
+ * for special reply ports.
+ */
+routine mach_port_special_reply_port_reset_link(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+ out srp_lost_link : boolean_t);
+#else
+skip;
+#endif
+
+/*
+ * Guard an already existing port. Allows guarding
+ * receive rights only. Uses the context field in the
+ * port structure to store the guard.
+ */
+routine mach_port_guard_with_flags(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+#ifdef LIBSYSCALL_INTERFACE
+ guard : mach_port_context_t;
+#else
+ guard : uint64_t;
+#endif
+ flags : uint64_t);
+
+/*
+ * Swap guard value of an existing guarded port. Works
+ * only if it is not a strict guard.
+ */
+routine mach_port_swap_guard(
+ task : ipc_space_t;
+ name : mach_port_name_t;
+#ifdef LIBSYSCALL_INTERFACE
+ old_guard : mach_port_context_t;
+#else
+ old_guard : uint64_t;
+#endif
+
+#ifdef LIBSYSCALL_INTERFACE
+ new_guard : mach_port_context_t);
+#else
+ new_guard : uint64_t);
+#endif
+
+/* vim: set ft=c : */
projects / apple / xnu.git / blobdiff