osfmk/kern/ipc_host.h

   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_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988 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 #ifndef _KERN_IPC_HOST_H_
  62 #define _KERN_IPC_HOST_H_
  63
  64 #include <mach/port.h>
  65 #include <kern/kern_types.h>
  66
  67 /* Initialize IPC host services */
  68 extern void ipc_host_init(void);
  69
  70 /* Initialize ipc access to processor by allocating a port */
  71 extern void ipc_processor_init(
  72         processor_t     processor);
  73
  74 /* Enable ipc control of processor by setting port object */
  75 extern void ipc_processor_enable(
  76         processor_t     processor);
  77
  78 /* Initialize ipc control of a processor set */
  79 extern void ipc_pset_init(
  80         processor_set_t         pset);
  81
  82 /* Enable ipc access to a processor set */
  83 extern void ipc_pset_enable(
  84         processor_set_t         pset);
  85
  86 /* Disable ipc access to a processor set */
  87 extern void ipc_pset_disable(
  88         processor_set_t         pset);
  89
  90 /* Deallocate the ipc control structures for a processor set */
  91 extern void ipc_pset_terminate(
  92         processor_set_t         pset);
  93
  94 /* Initialize ipc control of a clock */
  95 extern void ipc_clock_init(
  96         clock_t         clock);
  97
  98 /* Enable ipc access to a clock */
  99 extern void ipc_clock_enable(
 100         clock_t         clock);
 101
 102 /* Convert from a port to a clock */
 103 extern clock_t convert_port_to_clock(
 104         ipc_port_t      port);
 105
 106 /* Convert from a port to a clock control */
 107 extern clock_t convert_port_to_clock_ctrl(
 108         ipc_port_t      port);
 109
 110 /* Convert from a clock to a port */
 111 extern ipc_port_t convert_clock_to_port(
 112         clock_t         clock);
 113
 114 /* Convert from a clock control to a port */
 115 extern ipc_port_t convert_clock_ctrl_to_port(
 116         clock_t         clock);
 117
 118 /* Convert from a clock name to a clock pointer */
 119 extern clock_t port_name_to_clock(
 120         mach_port_name_t clock_name);
 121
 122 /* Convert from a port to a host */
 123 extern host_t convert_port_to_host(
 124         ipc_port_t      port);
 125
 126 /* Convert from a port to a host privilege port */
 127 extern host_t convert_port_to_host_priv(
 128         ipc_port_t      port);
 129
 130 /*  Convert from a port to a host paging port */
 131 extern host_t convert_port_to_host_paging(
 132         ipc_port_t      port);
 133
 134 /* Convert from a host to a port */
 135 extern ipc_port_t convert_host_to_port(
 136         host_t          host);
 137
 138 /* Convert from a port to a processor */
 139 extern processor_t convert_port_to_processor(
 140         ipc_port_t      port);
 141
 142 /* Convert from a processor to a port */
 143 extern ipc_port_t convert_processor_to_port(
 144         processor_t     processor);
 145
 146 /* Convert from a port to a processor set */
 147 extern processor_set_t convert_port_to_pset(
 148         ipc_port_t      port);
 149
 150 /* Convert from a port to a processor set name */
 151 extern processor_set_t convert_port_to_pset_name(
 152         ipc_port_t      port);
 153
 154 /* Convert from a processor set to a port */
 155 extern ipc_port_t convert_pset_to_port(
 156         processor_set_t         processor);
 157
 158 /* Convert from a processor set name to a port */
 159 extern ipc_port_t convert_pset_name_to_port(
 160         processor_set_t         processor);
 161
 162 /* Convert from a port to a host security port */
 163 extern host_t convert_port_to_host_security(
 164         ipc_port_t      port);
 165
 166
 167 #endif  /* _KERN_IPC_HOST_H_ */