xref: /xnu-8796.141.3/osfmk/man/index.html (revision 1b191cb58250d0705d8a51287127505aa4bc0789)
1*1b191cb5SApple OSS Distributions<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2*1b191cb5SApple OSS Distributions<html>
3*1b191cb5SApple OSS Distributions<head>
4*1b191cb5SApple OSS Distributions  <title>Mach Kernel Interface Reference Manual</title>
5*1b191cb5SApple OSS Distributions</head>
6*1b191cb5SApple OSS Distributions<body>
7*1b191cb5SApple OSS Distributions<h3>Mach IPC Interface</h3>
8*1b191cb5SApple OSS Distributions<blockquote>
9*1b191cb5SApple OSS Distributions<p>
10*1b191cb5SApple OSS DistributionsMach IPC presents itself in a few forms: message queues, lock-sets,
11*1b191cb5SApple OSS Distributionsand semaphores (more may be added in the future). &nbsp;All share one common
12*1b191cb5SApple OSS Distributionscharateristic: the capabilities presented by each are represented through
13*1b191cb5SApple OSS Distributionsa handle known as a Mach port. &nbsp;Specific rights represented in these
14*1b191cb5SApple OSS DistributionsMach port capability handles allow the underlying IPC object to be used and
15*1b191cb5SApple OSS Distributionsmanipulated in consistent ways.</p>
16*1b191cb5SApple OSS Distributions
17*1b191cb5SApple OSS Distributions<h4>Mach Message Queue Interface</h4>
18*1b191cb5SApple OSS Distributions<blockquote>
19*1b191cb5SApple OSS Distributions<p>
20*1b191cb5SApple OSS Distributions<a href="mach_msg.html">mach_msg</a> - Send and/or receive a message from the target port.<br>
21*1b191cb5SApple OSS Distributions<a href="mach_msg.html">mach_msg_overwrite</a> - Send and/or receive messages with possible overwrite.<br>
22*1b191cb5SApple OSS Distributions</p>
23*1b191cb5SApple OSS DistributionsMach Message Queue Data Structures
24*1b191cb5SApple OSS Distributions<p>
25*1b191cb5SApple OSS Distributions<a href="mach_msg_descriptor.html">mach_msg_descriptor</a> - Specifies an element of a complex IPC message.<br>
26*1b191cb5SApple OSS Distributions<a href="mach_msg_header.html">mach_msg_header</a> - Specifies the content of an IPC message header.<br>
27*1b191cb5SApple OSS Distributions</p>
28*1b191cb5SApple OSS Distributions</blockquote>
29*1b191cb5SApple OSS Distributions
30*1b191cb5SApple OSS Distributions<h4>Mach Lock-Set Interface</h4>
31*1b191cb5SApple OSS Distributions<blockquote>
32*1b191cb5SApple OSS Distributions<p>
33*1b191cb5SApple OSS Distributions<a href="lock_acquire.html">lock_acquire</a> - Acquire ownership a lock<br>
34*1b191cb5SApple OSS Distributions<a href="lock_handoff.html">lock_handoff</a> - Hand-off ownership of a lock.<br>
35*1b191cb5SApple OSS Distributions<a href="lock_handoff_accept.html">lock_handoff_accept</a> - Accept lock ownership from a handoff.<br>
36*1b191cb5SApple OSS Distributions<a href="lock_make_stable.html">lock_make_stable</a> - Stabilize the state of the specified lock.<br>
37*1b191cb5SApple OSS Distributions<a href="lock_release.html">lock_release</a> - Release ownership of a lock.<br>
38*1b191cb5SApple OSS Distributions<a href="lock_set_create.html">lock_set_create</a> - Create a new lock set.<br>
39*1b191cb5SApple OSS Distributions<a href="lock_set_destroy.html">lock_set_destroy</a> - Destroy a lock set and its associated locks.<br>
40*1b191cb5SApple OSS Distributions<a href="lock_try.html">lock_try</a> - Attempt to acquire access rights to a lock.<br>
41*1b191cb5SApple OSS Distributions</p>
42*1b191cb5SApple OSS Distributions</blockquote>
43*1b191cb5SApple OSS Distributions
44*1b191cb5SApple OSS Distributions<h4>Mach Semaphore Interface</h4>
45*1b191cb5SApple OSS Distributions<blockquote>
46*1b191cb5SApple OSS Distributions<p>
47*1b191cb5SApple OSS Distributions<a href="semaphore_create.html">semaphore_create</a> - Create a new semaphore.<br>
48*1b191cb5SApple OSS Distributions<a href="semaphore_destroy.html">semaphore_destroy</a> - Destroy a semaphore.<br>
49*1b191cb5SApple OSS Distributions<a href="semaphore_signal.html">semaphore_signal</a> - Increments the semaphore count.<br>
50*1b191cb5SApple OSS Distributions<a href="semaphore_signal_all.html">semaphore_signal_all</a> - Wake up all threads blocked on a semaphore.<br>
51*1b191cb5SApple OSS Distributions<a href="semaphore_wait.html">semaphore_wait</a> - Wait on the specified semaphore.<br>
52*1b191cb5SApple OSS Distributions</p>
53*1b191cb5SApple OSS Distributions</blockquote>
54*1b191cb5SApple OSS Distributions
55*1b191cb5SApple OSS Distributions<h4>Mach Port Management Interface</h4>
56*1b191cb5SApple OSS Distributions<blockquote>
57*1b191cb5SApple OSS Distributions<p>
58*1b191cb5SApple OSS Distributions<a href="mach_port_allocate.html">mach_port_allocate</a> - Create caller-specified type of port right.<br>
59*1b191cb5SApple OSS Distributions<a href="mach_port_allocate_full.html">mach_port_allocate_full</a> - Create a port right with full Mach port semantics.<br>
60*1b191cb5SApple OSS Distributions<a href="mach_port_allocate_name.html">mach_port_allocate_name</a> - Create a port right with the caller-specified name.<br>
61*1b191cb5SApple OSS Distributions<a href="mach_port_allocate_qos.html">mach_port_allocate_qos</a> - Allocate a port with specified "quality of service".<br>
62*1b191cb5SApple OSS Distributions<a href="MP_allocate_subsystem.html">mach_port_allocate_subsystem</a> - Create a port right associated with the caller-specified subsystem.<br>
63*1b191cb5SApple OSS Distributions<a href="mach_port_deallocate.html">mach_port_deallocate</a> - Decrement the target port right's user reference count.<br>
64*1b191cb5SApple OSS Distributions<a href="mach_port_destroy.html">mach_port_destroy</a> - Deallocate all port rights associated with specified name.<br>
65*1b191cb5SApple OSS Distributions<a href="mach_port_extract_right.html">mach_port_extract_right</a> - Remove the specified right from the target task and return it to the caller.<br>
66*1b191cb5SApple OSS Distributions<a href="mach_port_get_attributes.html">mach_port_get_attributes</a> - Return information about target port as specified by the caller.<br>
67*1b191cb5SApple OSS Distributions<a href="mach_port_get_refs.html">mach_port_get_refs</a> - Return the current count of user references on the target port right.<br>
68*1b191cb5SApple OSS Distributions<a href="mach_port_get_set_status.html">mach_port_get_set_status</a> - Return the port right names contained in the target port set.<br>
69*1b191cb5SApple OSS Distributions<a href="mach_port_insert_right.html">mach_port_insert_right</a> - Insert the specified port right into the target task.<br>
70*1b191cb5SApple OSS Distributions<a href="mach_port_mod_refs.html">mach_port_mod_refs</a> - Modify the specified port right's count of user references.<br>
71*1b191cb5SApple OSS Distributions<a href="mach_port_move_member.html">mach_port_move_member</a> - Move the specified receive right into or out of the specified port set.<br>
72*1b191cb5SApple OSS Distributions<a href="mach_port_names.html">mach_port_names</a> - Return information about a task's port name space.<br>
73*1b191cb5SApple OSS Distributions<a href="MP_request_notification.html">mach_port_request_notification</a> - Request notification of the specified port event type.<br>
74*1b191cb5SApple OSS Distributions<a href="mach_port_set_attributes.html">mach_port_set_attributes</a> - Set the target port's attributes.<br>
75*1b191cb5SApple OSS Distributions<a href="mach_port_set_mscount.html">mach_port_set_mscount</a> - Change the target port's make-send count.<br>
76*1b191cb5SApple OSS Distributions<a href="mach_port_set_seqno.html">mach_port_set_seqno</a> - Change the current value of the target port's sequence number.<br>
77*1b191cb5SApple OSS Distributions<a href="mach_port_type.html">mach_port_type</a> - Return the characteristics of the target port name.<br>
78*1b191cb5SApple OSS Distributions<a href="mach_reply_port.html">mach_reply_port</a> - Allocate a new port and insert corresponding receive right in the calling task.<br>
79*1b191cb5SApple OSS Distributions<a href="mach_subsystem_create.html"> mach_subsystem_create</a> - Used by a server to register information about an RPC subsystem with the kernel.<br>
80*1b191cb5SApple OSS Distributions</p>
81*1b191cb5SApple OSS DistributionsMach Port Data Structures
82*1b191cb5SApple OSS Distributions<p>
83*1b191cb5SApple OSS Distributions<a href="mach_port_limits.html">mach_port_limits</a> - Specifies a port's resource and message queue limits.<br>
84*1b191cb5SApple OSS Distributions<a href="mach_port_qos.html">mach_port_qos</a> - Specifies a port's attributes with respect to "Quality Of Service."<br>
85*1b191cb5SApple OSS Distributions<a href="mach_port_status.html">mach_port_status</a> - Used to present a port's current status with respect to various important attributes.<br>
86*1b191cb5SApple OSS Distributions</p>
87*1b191cb5SApple OSS DistributionsMach Port Notification Callbacks
88*1b191cb5SApple OSS Distributions<p>
89*1b191cb5SApple OSS Distributions<a href="do_mach_notify_dead_name.html">do_mach_notify_dead_name</a> - Handle the current instance of a dead-name notification.<br>
90*1b191cb5SApple OSS Distributions<a href="do_mach_notify_no_senders.html">do_mach_notify_no_senders</a> - Handle the current instance of a no-more-senders notification.<br>
91*1b191cb5SApple OSS Distributions<a href="DMN_port_deleted.html">do_mach_notify_port_deleted</a> - Handle the current instance of a port-deleted notification.<br>
92*1b191cb5SApple OSS Distributions<a href="DMN_port_destroyed.html">do_mach_notify_port_destroyed</a> - Handle the current instance of a port-destroyed notification.<br>
93*1b191cb5SApple OSS Distributions<a href="do_mach_notify_send_once.html">do_mach_notify_send_once</a> - Handle the current instance of a send-once notification.<br>
94*1b191cb5SApple OSS Distributions</p>
95*1b191cb5SApple OSS DistributionsMach Port Notification Callback Server Helpers
96*1b191cb5SApple OSS Distributions<p>
97*1b191cb5SApple OSS Distributions<a href="notify_server.html">notify_server</a> - Detect and handle a kernel-generated IPC notification.<br>
98*1b191cb5SApple OSS Distributions</p>
99*1b191cb5SApple OSS Distributions</blockquote>
100*1b191cb5SApple OSS Distributions
101*1b191cb5SApple OSS Distributions</blockquote>
102*1b191cb5SApple OSS Distributions
103*1b191cb5SApple OSS Distributions<h3>Mach Virtual Memory Interface</h3>
104*1b191cb5SApple OSS Distributions<blockquote>
105*1b191cb5SApple OSS Distributions<h4>Mach Virtual Memory Address Space Manipulation Interface</h4>
106*1b191cb5SApple OSS Distributions<blockquote>
107*1b191cb5SApple OSS Distributions<p>
108*1b191cb5SApple OSS Distributions<a href="host_page_size.html">host_page_size</a> - Provide the system's virtual page size.<br>
109*1b191cb5SApple OSS Distributions<a href="vm_allocate.html">vm_allocate</a> - Allocate a region of virtual memory.<br>
110*1b191cb5SApple OSS Distributions<a href="vm_behavior_set.html">vm_behavior_set</a> - Specify expected access patterns for the target VM region.<br>
111*1b191cb5SApple OSS Distributions<a href="vm_copy.html">vm_copy</a> - Copy a region of virtual memory.<br>
112*1b191cb5SApple OSS Distributions<a href="vm_deallocate.html">vm_deallocate</a> - Deallocate a region of virtual memory.<br>
113*1b191cb5SApple OSS Distributions<a href="vm_inherit.html">vm_inherit</a> - Set a VM region's inheritance attribute.<br>
114*1b191cb5SApple OSS Distributions<a href="vm_machine_attribute.html">vm_machine_attribute</a> - Get/set the target memory region's special attributes.<br>
115*1b191cb5SApple OSS Distributions<a href="vm_map.html">vm_map</a> - Map the specified memory object to a region of virtual memory.<br>
116*1b191cb5SApple OSS Distributions<a href="vm_msync.html">vm_msync</a> - Synchronize the specified region of virtual memory.<br>
117*1b191cb5SApple OSS Distributions<a href="vm_protect.html">vm_protect</a> - Set access privilege attribute for a region of virtual memory.<br>
118*1b191cb5SApple OSS Distributions<a href="vm_read.html">vm_read</a> - Read the specified range of target task's address space.<br>
119*1b191cb5SApple OSS Distributions<a href="vm_region.html">vm_region</a> - Return description of a virtual memory region.<br>
120*1b191cb5SApple OSS Distributions<a href="vm_remap.html">vm_remap</a> - Map memory objects in one address space to that of another's.<br>
121*1b191cb5SApple OSS Distributions<a href="vm_wire.html"> vm_wire</a> - Modify the target region's paging characteristics.<br>
122*1b191cb5SApple OSS Distributions<a href="vm_write.html">vm_write</a> - Write data to the specified address in the target address space.<br>
123*1b191cb5SApple OSS Distributions</p>
124*1b191cb5SApple OSS DistributionsData Structures
125*1b191cb5SApple OSS Distributions<p>
126*1b191cb5SApple OSS Distributions<a href="vm_region_basic_info.html">vm_region_basic_info</a> - Defines the attributes of a task's memory region.<br>
127*1b191cb5SApple OSS Distributions<a href="vm_statistics.html">vm_statistics</a> - Defines statistics for the kernel's use of virtual memory.<br>
128*1b191cb5SApple OSS Distributions</p>
129*1b191cb5SApple OSS Distributions</blockquote>
130*1b191cb5SApple OSS Distributions
131*1b191cb5SApple OSS Distributions<h4>External Memory Management Interface</h4>
132*1b191cb5SApple OSS Distributions<blockquote>
133*1b191cb5SApple OSS DistributionsThe External Memory Management Interface (EMMI) is undergoing significant change in the Darwin system.
134*1b191cb5SApple OSS DistributionsFor this reason, the interface is not currently available to user-level programs.  Even for kernel
135*1b191cb5SApple OSS Distributionsextensions, use of these interfaces in not supported.  Instead, the BSD filesystem's Universal Buffer Cache (UBC)
136*1b191cb5SApple OSS Distributionsmechanism should be used.<br>
137*1b191cb5SApple OSS Distributions<p>
138*1b191cb5SApple OSS Distributions<a href="MO_change_attributes.html">memory_object_change_attributes</a> - Modify subset of memory object attributes.<br>
139*1b191cb5SApple OSS Distributions<a href="memory_object_destroy.html">memory_object_destroy</a> - Shut down a memory object.<br>
140*1b191cb5SApple OSS Distributions<a href="MO_get_attributes.html">memory_object_get_attributes</a> - Return current attributes for a memory object.<br>
141*1b191cb5SApple OSS Distributions<a href="memory_object_lock_request.html">memory_object_lock_request</a> - Restrict access to memory object data.<br>
142*1b191cb5SApple OSS Distributions<a href="MO_SY_completed.html">memory_object_synchronize_completed</a> - Synchronized data has been processed.<br>
143*1b191cb5SApple OSS Distributions</p>
144*1b191cb5SApple OSS DistributionsData Structures
145*1b191cb5SApple OSS Distributions<p>
146*1b191cb5SApple OSS Distributions<a href="memory_object_attr_info.html">memory_object_attr_info</a> - Defines memory object attributes.<br>
147*1b191cb5SApple OSS Distributions<a href="memory_object_perf_info.html">memory_object_perf_info</a>- Specifies performance-related memory object attributes.<br>
148*1b191cb5SApple OSS Distributions</p>
149*1b191cb5SApple OSS DistributionsExternal Memory Manager Interface Callbacks
150*1b191cb5SApple OSS Distributions<p>
151*1b191cb5SApple OSS Distributions<a href="memory_object_create.html">memory_object_create</a> - Assign a new memory object to the default memory manager.<br>
152*1b191cb5SApple OSS Distributions<a href="MO_data_initialize.html">memory_object_data_initialize</a> - Provide initial data for a new memory object.<br>
153*1b191cb5SApple OSS Distributions<a href="memory_object_data_request.html">memory_object_data_request</a> - Request that memory manager page-in specified data.<br>
154*1b191cb5SApple OSS Distributions<a href="memory_object_data_return.html">memory_object_data_return</a> - Return memory object data to the appropriate memory manager.<br>
155*1b191cb5SApple OSS Distributions<a href="memory_object_data_unlock.html">memory_object_data_unlock</a> - Request a memory manager release the lock on specific data.<br>
156*1b191cb5SApple OSS Distributions<a href="memory_object_init.html">memory_object_init</a> - Inform a memory manager on first use of a memory object.<br>
157*1b191cb5SApple OSS Distributions<a href="memory_object_synchronize.html">memory_object_synchronize</a> - Request synchronization of data with backing store.<br>
158*1b191cb5SApple OSS Distributions<a href="memory_object_terminate.html">memory_object_terminate</a> - Relinquish access to a memory object.<br>
159*1b191cb5SApple OSS Distributions</p>
160*1b191cb5SApple OSS DistributionsEMMI Callback Server Helpers
161*1b191cb5SApple OSS Distributions<p>
162*1b191cb5SApple OSS Distributions<a href="MO_default_server.html">memory_object_default_server</a> - Handle kernel operation request targeted for the default pager.<br>
163*1b191cb5SApple OSS Distributions<a href="memory_object_server.html">memory_object_server</a> - Handle kernel operation request aimed at a given memory manager.<br>
164*1b191cb5SApple OSS Distributions</p>
165*1b191cb5SApple OSS Distributions</blockquote>
166*1b191cb5SApple OSS Distributions
167*1b191cb5SApple OSS Distributions<h4>Default Memory Management Interface</h4>
168*1b191cb5SApple OSS Distributions<blockquote>
169*1b191cb5SApple OSS Distributions<p>
170*1b191cb5SApple OSS Distributions<a href="default_pager_add_segment.html">default_pager_add_segment</a> - Add additional backing storage for a default pager.<br>
171*1b191cb5SApple OSS Distributions<a href="DP_backing_store_create.html">default_pager_backing_store_create</a> - Create a backing storage object.<br>
172*1b191cb5SApple OSS Distributions<a href="DP_backing_store_delete.html"> default_pager_backing_store_delete</a> - Delete a backing storage object.<br>
173*1b191cb5SApple OSS Distributions<a href="DP_backing_store_info.html">default_pager_backing_store_info</a> - Return information about a backing storage object.<br>
174*1b191cb5SApple OSS Distributions<a href="default_pager_info.html">default_pager_info</a> - Furnish caller with information about the default pager.<br>
175*1b191cb5SApple OSS Distributions<a href="DP_object_create.html">default_pager_object_create</a> - Initialize a non-persistent memory object.<br>
176*1b191cb5SApple OSS Distributions<a href="HD_memory_manager.html">host_default_memory_manager</a> - Register/Lookup the host's default pager.<br>
177*1b191cb5SApple OSS Distributions</p>
178*1b191cb5SApple OSS Distributions</blockquote>
179*1b191cb5SApple OSS Distributions
180*1b191cb5SApple OSS Distributions</blockquote>
181*1b191cb5SApple OSS Distributions
182*1b191cb5SApple OSS Distributions<h3>Process Management Interface</h3>
183*1b191cb5SApple OSS Distributions<blockquote>
184*1b191cb5SApple OSS Distributions
185*1b191cb5SApple OSS Distributions<h4>Task Interface</h4>
186*1b191cb5SApple OSS Distributions<blockquote>
187*1b191cb5SApple OSS Distributions<p>
188*1b191cb5SApple OSS Distributions<a href="mach_ports_lookup.html">mach_ports_lookup</a> - Provide caller with an array of the target task's well-known ports.<br>
189*1b191cb5SApple OSS Distributions<a href="mach_ports_register.html">mach_ports_register</a> - Register an array of well-known ports on behalf of the target task.<br>
190*1b191cb5SApple OSS Distributions<a href="mach_task_self.html">mach_task_self</a> - Return a send right to the caller's task_self port.<br>
191*1b191cb5SApple OSS Distributions<a href="task_create.html">task_create</a> - Create a new task.<br>
192*1b191cb5SApple OSS Distributions<a href="task_get_emulation_vector.html">task_get_emulation_vector</a> - Return an array identifying the target task's user-level system call handlers.<br>
193*1b191cb5SApple OSS Distributions<a href="task_get_exception_ports.html">task_get_exception_ports</a> - Return send rights to the target task's exception ports.<br>
194*1b191cb5SApple OSS Distributions<a href="task_get_special_port.html">task_get_special_port</a> - Return a send write to the indicated special port.<br>
195*1b191cb5SApple OSS Distributions<a href="task_info.html">task_info</a> - Return per-task information according to specified flavor.<br>
196*1b191cb5SApple OSS Distributions<a href="task_resume.html">task_resume</a> - Decrement the target task's suspend count.<br>
197*1b191cb5SApple OSS Distributions<a href="task_sample.html">task_sample</a> - Sample the target task's thread program counters periodically.<br>
198*1b191cb5SApple OSS Distributions<a href="task_set_emulation.html">task_set_emulation</a> - Establish a user-level handler for a system call.<br>
199*1b191cb5SApple OSS Distributions<a href="task_set_emulation_vector.html">task_set_emulation_vector</a> - Establish the target task's user-level system call handlers.<br>
200*1b191cb5SApple OSS Distributions<a href="task_set_exception_ports.html">task_set_exception_ports</a> - Set target task's exception ports.<br>
201*1b191cb5SApple OSS Distributions<a href="task_set_info.html">task_set_info</a> - Set task-specific information state.<br>
202*1b191cb5SApple OSS Distributions<a href="task_set_port_space.html">task_set_port_space</a> - Set the size of the target task's port name space table.<br>
203*1b191cb5SApple OSS Distributions<a href="task_set_special_port.html">task_set_special_port</a> - Set the indicated special port.<br>
204*1b191cb5SApple OSS Distributions<a href="task_suspend.html">task_suspend</a> - Suspend the target task.<br>
205*1b191cb5SApple OSS Distributions<a href="task_swap_exception_ports.html">task_swap_exception_ports</a> - Set target task's exception ports, returning the previous exception ports.<br>
206*1b191cb5SApple OSS Distributions<a href="task_terminate.html">task_terminate</a> - Terminate the target task and deallocate its resources.<br>
207*1b191cb5SApple OSS Distributions<a href="task_threads.html">task_threads</a> - Return the target task's list of threads.<br>
208*1b191cb5SApple OSS Distributions</p>
209*1b191cb5SApple OSS DistributionsTask Data Structures
210*1b191cb5SApple OSS Distributions<p>
211*1b191cb5SApple OSS Distributions<a href="task_basic_info.html">task_basic_info</a> - Defines basic information for a task.<br>
212*1b191cb5SApple OSS Distributions<a href="task_thread_times_info.html">task_thread_times_info</a> - Defines thread execution times information for tasks.<br>
213*1b191cb5SApple OSS Distributions</p>
214*1b191cb5SApple OSS Distributions</blockquote>
215*1b191cb5SApple OSS Distributions
216*1b191cb5SApple OSS Distributions<h4>Thread Interface</h4>
217*1b191cb5SApple OSS Distributions<blockquote>
218*1b191cb5SApple OSS Distributions<p>
219*1b191cb5SApple OSS Distributions<a href="mach_thread_self.html">mach_thread_self</a> - Returns the thread self port.<br>
220*1b191cb5SApple OSS Distributions<a href="thread_abort.html">thread_abort</a> - Abort a thread.<br>
221*1b191cb5SApple OSS Distributions<a href="thread_abort_safely.html">thread_abort_safely</a> - Abort a thread, restartably.<br>
222*1b191cb5SApple OSS Distributions<a href="thread_create.html">thread_create</a> - Create a thread within a task.<br>
223*1b191cb5SApple OSS Distributions<a href="thread_create_running.html">thread_create_running</a> - Optimized creation of a running thread.<br>
224*1b191cb5SApple OSS Distributions<a href="thread_depress_abort.html">thread_depress_abort</a> - Cancel thread scheduling depression.<br>
225*1b191cb5SApple OSS Distributions<a href="thread_get_exception_ports.html">thread_get_exception_ports</a> - Return a send right to an exception port.<br>
226*1b191cb5SApple OSS Distributions<a href="thread_get_special_port.html">thread_get_special_port</a> - Return a send right to the caller-specified special port.<br>
227*1b191cb5SApple OSS Distributions<a href="thread_get_state.html">thread_get_state</a> - Return the execution state for a thread.<br>
228*1b191cb5SApple OSS Distributions<a href="thread_info.html">thread_info</a> - Return information about a thread.<br>
229*1b191cb5SApple OSS Distributions<a href="thread_resume.html">thread_resume</a> - Resume a thread.<br>
230*1b191cb5SApple OSS Distributions<a href="thread_sample.html">thread_sample</a> - Perform periodic PC sampling for a thread.<br>
231*1b191cb5SApple OSS Distributions<a href="thread_set_exception_ports.html">thread_set_exception_ports</a> - Set exception ports for a thread.<br>
232*1b191cb5SApple OSS Distributions<a href="thread_set_special_port.html">thread_set_special_port</a> - Set caller-specified special port belonging to the target thread.<br>
233*1b191cb5SApple OSS Distributions<a href="thread_set_state.html">thread_set_state</a> - Set the target thread's user-mode execution state.<br>
234*1b191cb5SApple OSS Distributions<a href="thread_suspend.html">thread_suspend</a> - Suspend a thread.<br>
235*1b191cb5SApple OSS Distributions<a href="TS_exception_ports.html">thread_swap_exception_ports</a> - Swap exception ports for a thread.<br>
236*1b191cb5SApple OSS Distributions<a href="thread_terminate.html">thread_terminate</a> - Destroy a thread.<br>
237*1b191cb5SApple OSS Distributions<a href="thread_wire.html">thread_wire</a> - Mark the thread as privileged with respect to kernel resources.<br>
238*1b191cb5SApple OSS Distributions</p>
239*1b191cb5SApple OSS DistributionsThread Data Structures
240*1b191cb5SApple OSS Distributions<p>
241*1b191cb5SApple OSS Distributions<a href="thread_basic_info.html">thread_basic_info</a> - Defines basic information for a thread.<br>
242*1b191cb5SApple OSS Distributions</p>
243*1b191cb5SApple OSS DistributionsThread Exception Callbacks
244*1b191cb5SApple OSS Distributions<p>
245*1b191cb5SApple OSS Distributions<a href="catch_exception_raise.html">catch_exception_raise</a> - Handles the occurrence of an exception within a thread.<br>
246*1b191cb5SApple OSS Distributions</p>
247*1b191cb5SApple OSS DistributionsThread Exception Callback Server Helpers
248*1b191cb5SApple OSS Distributions<p>
249*1b191cb5SApple OSS Distributions<a href="exc_server.html">exc_server</a> - Handle kernel-reported thread exception.<br>
250*1b191cb5SApple OSS Distributions</p>
251*1b191cb5SApple OSS Distributions</blockquote>
252*1b191cb5SApple OSS Distributions
253*1b191cb5SApple OSS Distributions<h4>Scheduling Interface</h4>
254*1b191cb5SApple OSS Distributions<blockquote>
255*1b191cb5SApple OSS Distributions<p>
256*1b191cb5SApple OSS Distributions<a href="task_policy.html">task_policy</a> - Set target task's default scheduling policy state.<br>
257*1b191cb5SApple OSS Distributions<a href="task_set_policy.html">task_set_policy</a> - Set target task's default scheduling policy state.<br>
258*1b191cb5SApple OSS Distributions<a href="thread_policy.html">thread_policy</a> - Set target thread's scheduling policy state.<br>
259*1b191cb5SApple OSS Distributions<a href="thread_set_policy.html">thread_set_policy</a> - Set target thread's scheduling policy state.<br>
260*1b191cb5SApple OSS Distributions<a href="thread_switch.html">thread_switch</a> - Cause context switch with options.<br>
261*1b191cb5SApple OSS Distributions</p>
262*1b191cb5SApple OSS DistributionsScheduling Data Structures
263*1b191cb5SApple OSS Distributions<p>
264*1b191cb5SApple OSS Distributions<a href="policy_fifo_info.html">policy_fifo_info</a> - Specifies information associated with the system's First-In-First-Out scheduling policy.<br>
265*1b191cb5SApple OSS Distributions<a href="policy_rr_info.html">policy_rr_info</a> - Specifies information associated with the system's Round Robin scheduling policy.<br>
266*1b191cb5SApple OSS Distributions<a href="policy_timeshare_info.html">policy_timeshare_info</a> - Specifies information associated with the system's Timeshare scheduling policy.<br>
267*1b191cb5SApple OSS Distributions</p>
268*1b191cb5SApple OSS Distributions</blockquote>
269*1b191cb5SApple OSS Distributions</blockquote>
270*1b191cb5SApple OSS Distributions
271*1b191cb5SApple OSS Distributions<h3>System Management Interface</h3>
272*1b191cb5SApple OSS Distributions<blockquote>
273*1b191cb5SApple OSS Distributions
274*1b191cb5SApple OSS Distributions<h4>Host Interface</h4>
275*1b191cb5SApple OSS Distributions<blockquote>
276*1b191cb5SApple OSS Distributions<p>
277*1b191cb5SApple OSS Distributions<a href="host_get_clock_service.html">host_get_clock_service</a> - Return a send right to a kernel clock's service port.<br>
278*1b191cb5SApple OSS Distributions<a href="host_get_time.html">host_get_time</a> - Returns the current time as seen by that host.<br>
279*1b191cb5SApple OSS Distributions<a href="host_info.html">host_info</a> - Return information about a host.<br>
280*1b191cb5SApple OSS Distributions<a href="host_kernel_version.html">host_kernel_version</a> - Return kernel version information for a host.<br>
281*1b191cb5SApple OSS Distributions<a href="host_statistics.html">host_statistics</a> - Return statistics for a host.<br>
282*1b191cb5SApple OSS Distributions<a href="mach_host_self.html">mach_host_self</a> - Returns send rights to the task's host self port.<br>
283*1b191cb5SApple OSS Distributions</p>
284*1b191cb5SApple OSS DistributionsData Structures
285*1b191cb5SApple OSS Distributions<p>
286*1b191cb5SApple OSS Distributions<a href="host_basic_info.html">host_basic_info</a> - Used to present basic information about a host.<br>
287*1b191cb5SApple OSS Distributions<a href="host_load_info.html">host_load_info</a> - Used to present a host's processor load information.<br>
288*1b191cb5SApple OSS Distributions<a href="host_sched_info.html">host_sched_info</a> -  - Used to present the set of scheduler limits associated with the host.<br>
289*1b191cb5SApple OSS Distributions<a href="kernel_resource_sizes.html">kernel_resource_sizes</a> - Used to present the sizes of kernel's major structures.<br>
290*1b191cb5SApple OSS Distributions</p>
291*1b191cb5SApple OSS Distributions</blockquote>
292*1b191cb5SApple OSS Distributions
293*1b191cb5SApple OSS Distributions<h4>Host Control Interface</h4>
294*1b191cb5SApple OSS Distributions<blockquote>
295*1b191cb5SApple OSS Distributions<p>
296*1b191cb5SApple OSS Distributions<a href="host_adjust_time.html">host_adjust_time</a> - Arranges for the time on a specified host to be gradually changed by an adjustment value.<br>
297*1b191cb5SApple OSS Distributions<a href="HD_memory_manager.html">host_default_memory_manager</a> - Set the default memory manager.<br>
298*1b191cb5SApple OSS Distributions<a href="host_get_boot_info.html">host_get_boot_info</a> - Return operator boot information.<br>
299*1b191cb5SApple OSS Distributions<a href="host_get_clock_control.html">host_get_clock_control</a> - Return a send right to a kernel clock's control port.<br>
300*1b191cb5SApple OSS Distributions<a href="host_processor_slots.html">host_processor_slots</a> - Return a list of numbers that map processor slots to active processors.<br>
301*1b191cb5SApple OSS Distributions<a href="host_processors.html">host_processors</a> - Return a list of send rights representing all processor ports.<br>
302*1b191cb5SApple OSS Distributions<a href="host_reboot.html">host_reboot</a> - Reboot this host.<br>
303*1b191cb5SApple OSS Distributions<a href="host_set_time.html">host_set_time</a> - Establishes the time on the specified host.<br>
304*1b191cb5SApple OSS Distributions</p>
305*1b191cb5SApple OSS Distributions</blockquote>
306*1b191cb5SApple OSS Distributions
307*1b191cb5SApple OSS Distributions<h4>Host Security Interface</h4>
308*1b191cb5SApple OSS Distributions<blockquote>
309*1b191cb5SApple OSS Distributions<p>
310*1b191cb5SApple OSS Distributions<a href="host_security_create_task_token.html">host_security_create_task_token</a> - Create a new task with an explicit security token.<br>
311*1b191cb5SApple OSS Distributions<a href="host_security_set_task_token.html">host_security_set_task_token</a> - Change the target task's security token.<br>
312*1b191cb5SApple OSS Distributions</p>
313*1b191cb5SApple OSS Distributions</blockquote>
314*1b191cb5SApple OSS Distributions
315*1b191cb5SApple OSS Distributions<h4>Resource Accounting Interface</h4>
316*1b191cb5SApple OSS Distributions<blockquote>
317*1b191cb5SApple OSS Distributions<i>
318*1b191cb5SApple OSS DistributionsThe Mach resource accounting mechanism is not functional in the current Mac OS X/Darwin system.  It will become functional in a future release.
319*1b191cb5SApple OSS Distributions</i>
320*1b191cb5SApple OSS Distributions<p>
321*1b191cb5SApple OSS Distributions<a href="ledger_create.html">ledger_create</a> - Create a subordinate ledger.<br>
322*1b191cb5SApple OSS Distributions<a href="ledger_read.html">ledger_read</a> - Return the ledger limit and balance.<br>
323*1b191cb5SApple OSS Distributions<a href="ledger_terminate.html">ledger_terminate</a> - Destroy a ledger.<br>
324*1b191cb5SApple OSS Distributions<a href="ledger_transfer.html">ledger_transfer</a> - Transfer resources from a parent ledger to a child.<br>
325*1b191cb5SApple OSS Distributions</p>
326*1b191cb5SApple OSS Distributions</blockquote>
327*1b191cb5SApple OSS Distributions
328*1b191cb5SApple OSS Distributions<h4>Processor Management Interface</h4>
329*1b191cb5SApple OSS Distributions<blockquote>
330*1b191cb5SApple OSS Distributions<p>
331*1b191cb5SApple OSS Distributions<a href="processor_control.html">processor_control</a> - Perform caller-specified operation on target processor.<br>
332*1b191cb5SApple OSS Distributions<a href="processor_exit.html">processor_exit</a> - Exit a processor.<br>
333*1b191cb5SApple OSS Distributions<a href="processor_info.html">processor_info</a> - Return information about a processor.<br>
334*1b191cb5SApple OSS Distributions<a href="processor_start.html">processor_start</a> - Start a processor.<br>
335*1b191cb5SApple OSS Distributions</p>
336*1b191cb5SApple OSS DistributionsProcessor Data Structures
337*1b191cb5SApple OSS Distributions<p>
338*1b191cb5SApple OSS Distributions<a href="processor_basic_info.html">processor_basic_info</a> - Defines the basic information about a processor.<br>
339*1b191cb5SApple OSS Distributions</p>
340*1b191cb5SApple OSS Distributions</blockquote>
341*1b191cb5SApple OSS Distributions
342*1b191cb5SApple OSS Distributions<h4>Processor Set Interface</h4>
343*1b191cb5SApple OSS Distributions<blockquote>
344*1b191cb5SApple OSS Distributions<i>
345*1b191cb5SApple OSS DistributionsThe processor set interface allows for the grouping of tasks and
346*1b191cb5SApple OSS Distributionsprocessors for the purpose of exclusive scheduling.  These interface
347*1b191cb5SApple OSS Distributionsare <b>deprecated</b> and should not be used in code that isn't tied
348*1b191cb5SApple OSS Distributionsto a particular release of Mac OS X/Darwin.  These will likely change
349*1b191cb5SApple OSS Distributionsor disappear in a future release.
350*1b191cb5SApple OSS Distributions</i>
351*1b191cb5SApple OSS Distributions<p>
352*1b191cb5SApple OSS Distributions<a href="host_processor_sets.html">host_processor_sets</a> - Return a list of send rights representing all processor set name ports.<br>
353*1b191cb5SApple OSS Distributions<a href="host_processor_set_priv.html">host_processor_set_priv</a> - Translate a processor set name port into a processor set control port.<br>
354*1b191cb5SApple OSS Distributions<a href="processor_assign.html">processor_assign</a> - Assign a processor to a processor set.<br>
355*1b191cb5SApple OSS Distributions<a href="processor_get_assignment.html">processor_get_assignment</a> - Get current assignment for a processor.<br>
356*1b191cb5SApple OSS Distributions<a href="processor_set_create.html">processor_set_create</a> - Create a new processor set.<br>
357*1b191cb5SApple OSS Distributions<a href="processor_set_default.html">processor_set_default</a> - Return the default processor set.<br>
358*1b191cb5SApple OSS Distributions<a href="processor_set_destroy.html">processor_set_destroy</a> - Destroy the target processor set.<br>
359*1b191cb5SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a> - Return processor set state according to caller-specified flavor.<br>
360*1b191cb5SApple OSS Distributions<a href="processor_set_max_priority.html">processor_set_max_priority</a> - Sets the maximum scheduling priority for a processor set.<br>
361*1b191cb5SApple OSS Distributions<a href="P_set_policy_control.html">processor_set_policy_control</a> - Set target processor set's scheduling policy state.<br>
362*1b191cb5SApple OSS Distributions<a href="P_set_policy_disable.html">processor_set_policy_disable</a> - Enables a scheduling policy for a processor set.<br>
363*1b191cb5SApple OSS Distributions<a href="P_set_policy_enable.html">processor_set_policy_enable</a> - Enables a scheduling policy for a processor set.<br>
364*1b191cb5SApple OSS Distributions<a href="processor_set_statistics.html">processor_set_statistics</a> - Return scheduling statistics for a processor set.<br>
365*1b191cb5SApple OSS Distributions<a href="processor_set_tasks.html">processor_set_tasks</a> - Return all tasks currently assigned to the target processor set.<br>
366*1b191cb5SApple OSS Distributions<a href="processor_set_threads.html">processor_set_threads</a> - Return all threads currently assigned to the target processor set.<br>
367*1b191cb5SApple OSS Distributions<a href="task_assign.html">task_assign</a> - Assign a task to a processor set.<br>
368*1b191cb5SApple OSS Distributions<a href="task_assign_default.html">task_assign_default</a> -  Assign a task to the default processor set.<br>
369*1b191cb5SApple OSS Distributions<a href="task_get_assignment.html">task_get_assignment</a> - Create a new task with an explicit security token.<br>
370*1b191cb5SApple OSS Distributions<a href="thread_assign.html">thread_assign</a> - Assign a thread to a processor set.<br>
371*1b191cb5SApple OSS Distributions<a href="thread_assign_default.html">thread_assign_default</a> - Assign a thread to the default processor set.<br>
372*1b191cb5SApple OSS Distributions<a href="thread_get_assignment.html">thread_get_assignment</a> - Return the processor set to which a thread is assigned.<br>
373*1b191cb5SApple OSS Distributions</p>
374*1b191cb5SApple OSS DistributionsProcessor Set Data Structures
375*1b191cb5SApple OSS Distributions<p>
376*1b191cb5SApple OSS Distributions<a href="processor_set_basic_info.html">processor_set_basic_info</a> - Defines the basic information about a processor set.<br>
377*1b191cb5SApple OSS Distributions<a href="processor_set_load_info.html">processor_set_load_info</a> - Defines the scheduling statistics for a processor set.<br>
378*1b191cb5SApple OSS Distributions</p>
379*1b191cb5SApple OSS Distributions</blockquote>
380*1b191cb5SApple OSS Distributions
381*1b191cb5SApple OSS Distributions<h4>Clock Interface</h4>
382*1b191cb5SApple OSS Distributions<blockquote>
383*1b191cb5SApple OSS Distributions<p>
384*1b191cb5SApple OSS Distributions<a href="clock_alarm.html">clock_alarm</a> - Set up an alarm.<br>
385*1b191cb5SApple OSS Distributions<a href="clock_get_attributes.html">clock_get_attributes</a> - Return attributes of a clock.<br>
386*1b191cb5SApple OSS Distributions<a href="clock_get_time.html">clock_get_time</a> - Return the current time.<br>
387*1b191cb5SApple OSS Distributions<a href="clock_map_time.html">clock_map_time</a> - Return a memory object that maps a clock.<br>
388*1b191cb5SApple OSS Distributions<a href="clock_set_attributes.html">clock_set_attributes</a> - Set a particular clock's attributes.<br>
389*1b191cb5SApple OSS Distributions<a href="clock_set_time.html">clock_set_time</a> - Set the current time.<br>
390*1b191cb5SApple OSS Distributions<a href="clock_sleep.html">clock_sleep</a> - Delay the invoking thread until a specified time.<br>
391*1b191cb5SApple OSS Distributions</p>
392*1b191cb5SApple OSS DistributionsClock Data Structures
393*1b191cb5SApple OSS Distributions<p>
394*1b191cb5SApple OSS Distributions<a href="mapped_tvalspec.html">mapped_tvalspec</a> - Specifies the format the kernel uses to maintain a mapped clock's time.<br>
395*1b191cb5SApple OSS Distributions<a href="tvalspec.html">tvalspec</a> - Defines format of system time values.<br>
396*1b191cb5SApple OSS Distributions</p>
397*1b191cb5SApple OSS DistributionsClock Interface Callbacks
398*1b191cb5SApple OSS Distributions<p>
399*1b191cb5SApple OSS Distributions<a href="clock_alarm_reply.html">clock_alarm_reply</a> - Ring a preset alarm.<br>
400*1b191cb5SApple OSS Distributions</p>
401*1b191cb5SApple OSS DistributionsClock Callback Server Helpers
402*1b191cb5SApple OSS Distributions<p>
403*1b191cb5SApple OSS Distributions<a href="clock_reply_server.html"> clock_reply_server</a> - Handle kernel-generated alarm.<br>
404*1b191cb5SApple OSS Distributions</p>
405*1b191cb5SApple OSS Distributions</blockquote>
406*1b191cb5SApple OSS Distributions
407*1b191cb5SApple OSS Distributions<h4>Multi-Computer Support Interface</h4>
408*1b191cb5SApple OSS Distributions<blockquote>
409*1b191cb5SApple OSS Distributions<i>
410*1b191cb5SApple OSS DistributionsThese multi-computer support interfaces are no longer supported by
411*1b191cb5SApple OSS Distributionsthe Mac OS X/Darwin kernel.  If and when multi-computer support is
412*1b191cb5SApple OSS Distributionsadded back in, something like these will likely be added.
413*1b191cb5SApple OSS Distributions</i>
414*1b191cb5SApple OSS Distributions<p>
415*1b191cb5SApple OSS Distributions<a href="host_page_size.html">host_page_size</a> - Returns the page size for the given host.<br>
416*1b191cb5SApple OSS Distributions<a href="ledger_get_remote.html">ledger_get_remote</a> - Return send right to specified host's remote ledger port.<br>
417*1b191cb5SApple OSS Distributions<a href="ledger_set_remote.html">ledger_set_remote</a> - Set this host's remote ledger port.<br>
418*1b191cb5SApple OSS Distributions</p>
419*1b191cb5SApple OSS Distributions</blockquote>
420*1b191cb5SApple OSS Distributions
421*1b191cb5SApple OSS Distributions</blockquote>
422*1b191cb5SApple OSS Distributions
423*1b191cb5SApple OSS Distributions<h3>Machine Specific Interface</h3>
424*1b191cb5SApple OSS Distributions<blockquote>
425*1b191cb5SApple OSS Distributions
426*1b191cb5SApple OSS Distributions<h4>Intel 386 Support</h4>
427*1b191cb5SApple OSS Distributions<blockquote>
428*1b191cb5SApple OSS Distributions<p>
429*1b191cb5SApple OSS Distributions<a href="i386_get_ldt.html">i386_get_ldt</a> - Returns per-thread segment descriptors from the local descriptor table (LDT).<br>
430*1b191cb5SApple OSS Distributions<a href="i386_io_port_add.html">i386_io_port_add</a> - Adds a device to the I/O permission bitmap for a thread. <br>
431*1b191cb5SApple OSS Distributions<a href="i386_io_port_list.html">i386_io_port_list</a> - Returns a list of the devices named in the thread's I/O permission bitmap.<br>
432*1b191cb5SApple OSS Distributions<a href="i386_io_port_remove.html">i386_io_port_remove</a> - Removes the specified device from the thread's I/O permission bitmap.<br>
433*1b191cb5SApple OSS Distributions<a href="i386_set_ldt.html">i386_set_ldt</a> - Allows a thread to have a private local descriptor table (LDT).<br>
434*1b191cb5SApple OSS Distributions</p>
435*1b191cb5SApple OSS Distributions</blockquote>
436*1b191cb5SApple OSS Distributions
437*1b191cb5SApple OSS Distributions<h4>PowerPC Support</h4>
438*1b191cb5SApple OSS Distributions<blockquote>
439*1b191cb5SApple OSS Distributions<p>
440*1b191cb5SApple OSS Distributions</p>
441*1b191cb5SApple OSS Distributions</blockquote>
442*1b191cb5SApple OSS Distributions
443*1b191cb5SApple OSS Distributions</blockquote>
444*1b191cb5SApple OSS Distributions
445*1b191cb5SApple OSS Distributions</BODY>
446*1b191cb5SApple OSS Distributions
447*1b191cb5SApple OSS Distributions</HTML>
448*1b191cb5SApple OSS Distributions
449