osfmk/mach/processor_set.defs

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