osfmk/mach/mach_host.defs

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58
  59 /*
  60  * File:        mach/mach_host.defs
  61  *
  62  * Abstract:
  63  *      Mach host operations support.  Includes processor allocation and
  64  *      control.
  65  */
  66
  67 #ifdef  MACH_KERNEL
  68 #include <mach_prof.h>
  69 #include <advisory_pageout.h>
  70 #endif  /* MACH_KERNEL */
  71
  72 subsystem
  73 #if     KERNEL_SERVER
  74           KernelServer
  75 #endif  /* KERNEL_SERVER */
  76                        mach_host 200;
  77
  78 /*
  79  *      Basic types
  80  */
  81
  82 #include <mach/std_types.defs>
  83 #include <mach/mach_types.defs>
  84 #include <mach/clock_types.defs>
  85 #include <mach_debug/mach_debug_types.defs>
  86
  87 /*
  88  * References to host objects are returned by:
  89  *      mach_host_self() - trap
  90  */
  91
  92 /*
  93  *      Return information about this host.
  94  */
  95 routine host_info(
  96                 host            : host_t;
  97                 flavor          : host_flavor_t;
  98         out     host_info_out   : host_info_t, CountInOut);
  99
 100 /*
 101  *      Get string describing current kernel version.
 102  */
 103 routine host_kernel_version(
 104                 host            : host_t;
 105         out     kernel_version  : kernel_version_t);
 106
 107 /*
 108  *      Get host page size
 109  */
 110 routine host_page_size(
 111                 host            : host_t;
 112         out     out_page_size   : vm_size_t);
 113
 114 /*
 115  *      Allow pagers to create named entries that point to un-mapped
 116  *      abstract memory object.  The named entries are generally mappable
 117  *      and can be subsetted through the mach_make_memory_entry call
 118  */
 119 routine mach_memory_object_memory_entry(
 120                 host            :host_t;
 121                 internal        :boolean_t;
 122                 size            :vm_size_t;
 123                 permission      :vm_prot_t;
 124                 pager           :memory_object_t;
 125         out     entry_handle    :mach_port_move_send_t);
 126
 127
 128 /*
 129  *      Get processor info for all the processors on this host.
 130  *      The returned data is an OOL array of processor info.
 131  */
 132 routine host_processor_info(
 133                 host                    : host_t;
 134                 flavor                  : processor_flavor_t;
 135         out     out_processor_count     : natural_t;
 136         out     out_processor_info      : processor_info_array_t);
 137
 138 /*
 139  *      Return host IO master access port
 140  */
 141 routine host_get_io_master(
 142                 host            : host_t;
 143         out     io_master       : io_master_t);
 144
 145 /*
 146  *      Get service port for a processor set.
 147  *      Available to all.
 148  */
 149 routine host_get_clock_service(
 150                 host            : host_t;
 151                 clock_id        : clock_id_t;
 152         out     clock_serv      : clock_serv_t);
 153
 154
 155 routine kmod_get_info(
 156                 host            : host_t;
 157         out     modules         : kmod_args_t);
 158
 159 /*
 160  *      Returns information about the memory allocation zones.
 161  *      Supported in all kernels..
 162  */
 163 routine host_zone_info(
 164                 host            : host_t;
 165         out     names           : zone_name_array_t,
 166                                         Dealloc;
 167         out     info            : zone_info_array_t,
 168                                         Dealloc);
 169
 170 /*
 171  *      Returns information about the global VP table.
 172  *      Only supported in MACH_VM_DEBUG kernels,
 173  *      otherwise returns KERN_FAILURE.
 174  */
 175 routine host_virtual_physical_table_info(
 176                 host            : host_t;
 177         out     info            : hash_info_bucket_array_t,
 178                                         Dealloc);
 179
 180 /*
 181  *      Returns information about the global reverse hash table.
 182  *      This call is only valid on MACH_IPC_DEBUG kernels.
 183  *      Otherwise, KERN_FAILURE is returned.
 184  */
 185 routine host_ipc_hash_info(
 186                 host            : host_t;
 187         out     info            : hash_info_bucket_array_t,
 188                                         Dealloc);
 189
 190 /*
 191  * JMM - These routines should be on the host_priv port.  We need
 192  * to verify the move before putting them there.
 193  */
 194 routine enable_bluebox(
 195                 host                    : host_t;
 196         in      taskID                  : unsigned;
 197         in      TWI_TableStart  : unsigned;
 198         in      Desc_TableStart : unsigned);
 199
 200 routine disable_bluebox(
 201                 host            : host_t);
 202
 203 /*
 204  * JMM - Keep processor_set related items at the end for easy
 205  * removal.
 206  */
 207 /*
 208  *      Get default processor set for host.
 209  */
 210 routine processor_set_default(
 211                 host            : host_t;
 212         out     default_set     : processor_set_name_t);
 213
 214 /*
 215  *      Create new processor set.  Returns real port for manipulations,
 216  *      and name port for obtaining information.
 217  */
 218 routine processor_set_create(
 219                 host            : host_t;
 220         out     new_set         : processor_set_t;
 221         out     new_name        : processor_set_name_t);
 222
 223 /*
 224  *      Temporary interfaces for conversion to 64 bit data path
 225  */
 226
 227 routine mach_memory_object_memory_entry_64(
 228                 host            :host_t;
 229                 internal        :boolean_t;
 230                 size            :memory_object_size_t;
 231                 permission      :vm_prot_t;
 232                 pager           :memory_object_t;
 233         out     entry_handle    :mach_port_move_send_t);
 234
 235 /*
 236  *      Return statistics from this host.
 237  */
 238 routine host_statistics(
 239                 host_priv       : host_t;
 240                 flavor          : host_flavor_t;
 241         out     host_info_out   : host_info_t, CountInOut);
 242
 243 routine host_request_notification(
 244                 host            : host_t;
 245                 notify_type     : host_flavor_t;
 246                 notify_port     : mach_port_make_send_once_t);
 247
 248 routine host_lockgroup_info(
 249                 host            : host_t;
 250         out     lockgroup_info  : lockgroup_info_array_t,
 251                                         Dealloc);
 252