xnu-4570.1.46.tar.gz

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

diff --git a/osfmk/mach/task.defs b/osfmk/mach/task.defs
index 45e9519e2d84abc0a31bd6a3360f3eac9e8f7730..5ac64e7d5281097ec0ebad2e29a101a7780e306a 100644 (file)
--- a/osfmk/mach/task.defs
+++ b/osfmk/mach/task.defs
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple 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,
  * 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@
  */
 /*
  * @OSF_FREE_COPYRIGHT@


@@ -59,11 +65,13 @@
 subsystem
 #if    KERNEL_SERVER
          KernelServer
 subsystem
 #if    KERNEL_SERVER
          KernelServer

-#endif KERNEL_SERVER
+#endif /* KERNEL_SERVER */

          task 3400;
 
 #include <mach/std_types.defs>
 #include <mach/mach_types.defs>
          task 3400;
 
 #include <mach/std_types.defs>
 #include <mach/mach_types.defs>

+#include <mach_debug/mach_debug_types.defs>
+

 /*
  *     Create a new task with an empty set of IPC rights,
  *     and having an address space constructed from the
 /*
  *     Create a new task with an empty set of IPC rights,
  *     and having an address space constructed from the


@@ -87,7 +95,7 @@ routine task_terminate(
  *     Returns the set of threads belonging to the target task.
  */
 routine task_threads(
  *     Returns the set of threads belonging to the target task.
  */
 routine task_threads(

-               target_task     : task_t;
+               target_task     : task_inspect_t;

        out     act_list        : thread_act_array_t);
 
 /*
        out     act_list        : thread_act_array_t);
 
 /*


@@ -110,11 +118,18 @@ routine   mach_ports_lookup(
 /*
  *      Returns information about the target task.
  */
 /*
  *      Returns information about the target task.
  */

+#ifdef KERNEL_SERVER
+routine task_info_from_user(
+                target_task     : mach_port_t;
+                flavor          : task_flavor_t;
+        out     task_info_out   : task_info_t, CountInOut);
+#else

 routine task_info(
 routine task_info(

-                target_task     : task_t;
+                target_task     : task_name_t;

                 flavor          : task_flavor_t;
         out     task_info_out   : task_info_t, CountInOut);
 
                 flavor          : task_flavor_t;
         out     task_info_out   : task_info_t, CountInOut);
 

+#endif

 /*
  * Set task information.
  */
 /*
  * Set task information.
  */


@@ -146,7 +161,7 @@ routine     task_resume(
  *     associated with the target task.
  */
 routine task_get_special_port(
  *     associated with the target task.
  */
 routine task_get_special_port(

-               task            : task_t;
+               task            : task_inspect_t;

                which_port      : int;
        out     special_port    : mach_port_t);
 
                which_port      : int;
        out     special_port    : mach_port_t);
 


@@ -164,7 +179,12 @@ routine task_set_special_port(
  *     the port representing the first thr_act in that new thread.  The
  *     initial execution state of the thread is undefined.
  */
  *     the port representing the first thr_act in that new thread.  The
  *     initial execution state of the thread is undefined.
  */

-routine thread_create(
+routine
+#ifdef KERNEL_SERVER
+thread_create_from_user(
+#else
+thread_create(
+#endif

                parent_task     : task_t;
        out     child_act       : thread_act_t);
 
                parent_task     : task_t;
        out     child_act       : thread_act_t);
 


@@ -175,7 +195,12 @@ routine thread_create(
  *     by flavor and new_state. Returns the port representing 
  *     the new thread.
  */
  *     by flavor and new_state. Returns the port representing 
  *     the new thread.
  */

-routine thread_create_running(
+routine
+#ifdef KERNEL_SERVER
+thread_create_running_from_user(
+#else
+thread_create_running(
+#endif

                 parent_task     : task_t;
                 flavor          : thread_state_flavor_t;
                 new_state       : thread_state_t;
                 parent_task     : task_t;
                 flavor          : thread_state_flavor_t;
                 new_state       : thread_state_t;


@@ -199,7 +224,7 @@ routine     task_set_exception_ports(
  * Lookup some of the old exception handlers for a task
  */
 routine        task_get_exception_ports(
  * Lookup some of the old exception handlers for a task
  */
 routine        task_get_exception_ports(

-               task            : task_t;
+               task            : task_inspect_t;

                exception_mask  : exception_mask_t;
          out   masks           : exception_mask_array_t;
          out   old_handlers    : exception_handler_array_t, SameCount;
                exception_mask  : exception_mask_t;
          out   masks           : exception_mask_array_t;
          out   old_handlers    : exception_handler_array_t, SameCount;


@@ -224,8 +249,7 @@ routine     task_swap_exception_ports(
          out   old_flavors     : exception_flavor_array_t, SameCount);
 
 /*
          out   old_flavors     : exception_flavor_array_t, SameCount);
 
 /*

- * Create and destroy lock_set and semaphore synchronizers on a
- * per-task basis (i.e. the task owns them).
+ * OBSOLETE interface.

  */
 routine lock_set_create(
                task            : task_t;
  */
 routine lock_set_create(
                task            : task_t;


@@ -233,10 +257,18 @@ routine lock_set_create(
                n_ulocks        : int;
                policy          : int);
 
                n_ulocks        : int;
                policy          : int);
 

+/*
+ * OBSOLETE interface.
+ */

 routine lock_set_destroy(
                task            : task_t;
                lock_set        : lock_set_t);
 
 routine lock_set_destroy(
                task            : task_t;
                lock_set        : lock_set_t);
 

+/*
+ * Create and destroy semaphore synchronizers on a
+ * per-task basis (i.e. the task owns them).
+ */
+

 routine semaphore_create(
                task            : task_t;
        out     semaphore       : semaphore_t;
 routine semaphore_create(
                task            : task_t;
        out     semaphore       : semaphore_t;


@@ -264,11 +296,15 @@ out       policy_info             : task_policy_t, CountInOut;
 inout  get_default             : boolean_t);
 
 /*
 inout  get_default             : boolean_t);
 
 /*

- * Task profiling.
+ *     Removed from the kernel.

  */
  */

+#if KERNEL_SERVER
+skip;
+#else

 routine task_sample(
                task            : task_t;
                reply           : mach_port_make_send_t);
 routine task_sample(
                task            : task_t;
                reply           : mach_port_make_send_t);

+#endif

 
 /*
  * JMM - Everything from here down is likely to go away soon
 
 /*
  * JMM - Everything from here down is likely to go away soon


@@ -322,20 +358,20 @@ routine task_set_ras_pc(
                boundspc        : vm_address_t);
 
 
                boundspc        : vm_address_t);
 
 

-/* 
- * JMM - Want to eliminate kernel tasks and processor_set so
- * keep them at the end.
- */

 /*
 /*

- *     Create a new task in the kernel's address space with
- *     an empty set of IPC rights, with a map allocated from
- *     the kernel's map starting at map_base of length map_size.
+ * Return zone info as seen/used by this task.

  */
  */

-routine kernel_task_create(
+routine task_zone_info(

                target_task     : task_t;
                target_task     : task_t;

-               map_base        : vm_offset_t;
-               map_size        : vm_size_t;
-       out     child_task      : task_t);
+       out     names           : mach_zone_name_array_t,
+                                       Dealloc;
+       out     info            : task_zone_info_array_t,
+                                       Dealloc);
+
+
+/* 
+ * JMM - Want to eliminate processor_set so keep them at the end.
+ */

 
 /*
  *     Assign task to processor set.
 
 /*
  *     Assign task to processor set.


@@ -370,3 +406,103 @@ routine task_set_policy(
        limit                   : policy_limit_t;
        change                  : boolean_t);
 
        limit                   : policy_limit_t;
        change                  : boolean_t);
 

+/*
+ * Read the selected state which is to be installed on new 
+ * threads in the task as they are created.
+ */
+routine task_get_state(
+               task            : task_t;
+               flavor          : thread_state_flavor_t;
+       out     old_state       : thread_state_t, CountInOut);
+ 
+/*
+ * Set the selected state information to be installed on
+ * all subsequently created threads in the task.
+ */
+routine        task_set_state(
+               task            : task_t;
+               flavor          : thread_state_flavor_t;
+               new_state       : thread_state_t);
+
+/*
+ * Change the task's physical footprint limit (in MB).
+ */
+routine task_set_phys_footprint_limit(
+               task            : task_t;
+               new_limit       : int;
+       out old_limit   : int);
+
+routine task_suspend2(
+               target_task : task_t;
+       out suspend_token : task_suspension_token_t);
+
+routine task_resume2(
+               suspend_token : task_suspension_token_t);
+
+routine task_purgable_info(
+               task            : task_t;
+       out     stats           : task_purgable_info_t);
+
+routine task_get_mach_voucher(
+               task            : task_t;
+               which           : mach_voucher_selector_t;
+       out     voucher         : ipc_voucher_t);
+
+routine task_set_mach_voucher(
+               task            : task_t;
+               voucher         : ipc_voucher_t);
+
+routine task_swap_mach_voucher(
+               task            : task_t;
+               new_voucher     : ipc_voucher_t;
+       inout   old_voucher     : ipc_voucher_t);
+
+routine task_generate_corpse(
+               task            :task_t;
+       out     corpse_task_port:mach_port_t);
+
+routine task_map_corpse_info(
+               task            :task_t;
+               corspe_task     :task_t;
+       out     kcd_addr_begin  :vm_address_t;
+       out     kcd_size        :uint32_t);
+
+routine task_register_dyld_image_infos(
+        task            :task_t;
+        dyld_images     :dyld_kernel_image_info_array_t);
+
+routine task_unregister_dyld_image_infos(
+        task            :task_t;
+        dyld_images     :dyld_kernel_image_info_array_t);
+
+routine task_get_dyld_image_infos(
+        task            :task_inspect_t;
+    out dyld_images     :dyld_kernel_image_info_array_t);
+
+routine task_register_dyld_shared_cache_image_info(
+        task                :task_t;
+        dyld_cache_image    :dyld_kernel_image_info_t;
+        no_cache            :boolean_t;
+        private_cache       :boolean_t);
+
+routine task_register_dyld_set_dyld_state(
+        task           :task_t;
+        dyld_state     :uint8_t);
+
+routine task_register_dyld_get_process_state(
+        task                :task_t;
+    out dyld_process_state  :dyld_kernel_process_info_t);
+
+routine task_map_corpse_info_64(
+               task            :task_t;
+               corspe_task     :task_t;
+       out     kcd_addr_begin  :mach_vm_address_t;
+       out     kcd_size        :mach_vm_size_t);
+
+routine task_inspect(
+           task     : task_inspect_t;
+           flavor   : task_inspect_flavor_t;
+       out info_out : task_inspect_info_t, CountInOut);
+
+/* vim: set ft=c : */
+