osfmk/mach/processor_set.defs

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_FREE_COPYRIGHT@
  25  */
  26 /*
  27  * Mach Operating System
  28  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  29  * All Rights Reserved.
  30  *
  31  * Permission to use, copy, modify and distribute this software and its
  32  * documentation is hereby granted, provided that both the copyright
  33  * notice and this permission notice appear in all copies of the
  34  * software, derivative works or modified versions, and any portions
  35  * thereof, and that both notices appear in supporting documentation.
  36  *
  37  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  38  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  39  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  40  *
  41  * Carnegie Mellon requests users of this software to return to
  42  *
  43  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  44  *  School of Computer Science
  45  *  Carnegie Mellon University
  46  *  Pittsburgh PA 15213-3890
  47  *
  48  * any improvements or extensions that they make and grant Carnegie Mellon
  49  * the rights to redistribute these changes.
  50  */
  51 /*
  52  */
  53 /*
  54  *      File:   mach/mach_port.defs
  55  *      Author: Rich Draves
  56  *
  57  *      Exported kernel calls.
  58  */
  59
  60 subsystem
  61 #if     KERNEL_SERVER
  62           KernelServer
  63 #endif  /* KERNEL_SERVER */
  64           processor_set 4000;
  65
  66 #include <mach/std_types.defs>
  67 #include <mach/mach_types.defs>
  68
  69 /*
  70  *      Return scheduling statistics for a processor set.
  71  */
  72 routine processor_set_statistics(
  73                 pset                    : processor_set_name_t;
  74                 flavor                  : processor_set_flavor_t;
  75         out     info_out                : processor_set_info_t, CountInOut);
  76
  77
  78 /*
  79  *      Destroy processor set.
  80  */
  81 routine processor_set_destroy(
  82                 set             : processor_set_t);
  83
  84
  85 /*
  86  *      Set max priority for processor_set.
  87  */
  88 routine processor_set_max_priority(
  89                 processor_set   : processor_set_t;
  90                 max_priority    : int;
  91                 change_threads  : boolean_t);
  92
  93 /*
  94  *      Enable policy for processor set
  95  */
  96 routine processor_set_policy_enable(
  97                 processor_set   : processor_set_t;
  98                 policy          : int);
  99
 100 /*
 101  *      Disable policy for processor set
 102  */
 103 routine processor_set_policy_disable(
 104                 processor_set   : processor_set_t;
 105                 policy          : int;
 106                 change_threads  : boolean_t);
 107
 108 /*
 109  *      List all tasks in processor set.
 110  */
 111 routine processor_set_tasks(
 112                 processor_set   : processor_set_t;
 113         out     task_list       : task_array_t);
 114
 115 /*
 116  *      List all threads in processor set.
 117  */
 118 routine processor_set_threads(
 119                 processor_set   : processor_set_t;
 120         out     thread_list     : thread_act_array_t);
 121
 122 /*
 123  *      Controls the scheduling attributes governing the processor set.
 124  *      Allows control of enabled policies, and per-policy base and limit
 125  *      priorities.
 126  */
 127 routine processor_set_policy_control(
 128         pset                    : processor_set_t;
 129         flavor                  : processor_set_flavor_t;
 130         policy_info             : processor_set_info_t;
 131         change                  : boolean_t);
 132
 133
 134 /*
 135  *      Debug Info
 136  *      This call is only valid on MACH_DEBUG kernels.
 137  *      Otherwise, KERN_FAILURE is returned.
 138  */
 139 routine processor_set_stack_usage(
 140                 pset            : processor_set_t;
 141         out     total           : unsigned;
 142         out     space           : vm_size_t;
 143         out     resident        : vm_size_t;
 144         out     maxusage        : vm_size_t;
 145         out     maxstack        : vm_offset_t);
 146
 147 /*
 148  *      Get information about processor set.
 149  */
 150 routine processor_set_info(
 151                 set_name        : processor_set_name_t;
 152                 flavor          : int;
 153         out     host            : host_t;
 154         out     info_out        : processor_set_info_t, CountInOut);
 155