libsyscall/mach/mach/mach.h

   1 /*
   2  * Copyright (c) 1999-2014 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  * Mach Operating System
  30  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53
  54 /*
  55  *  Includes all the types that a normal user
  56  *  of Mach programs should need
  57  */
  58
  59 #ifndef _MACH_H_
  60 #define _MACH_H_
  61
  62 #define __MACH30__
  63 #define MACH_IPC_FLAVOR UNTYPED
  64
  65 #include <mach/std_types.h>
  66 #include <mach/mach_types.h>
  67 #include <mach/mach_interface.h>
  68 #include <mach/mach_port.h>
  69 #include <mach/mach_init.h>
  70 #include <mach/mach_host.h>
  71 #include <mach/thread_switch.h>
  72
  73 #include <mach/rpc.h>           /* for compatibility only */
  74 #include <mach/mig.h>
  75
  76 #include <mach/mig_errors.h>
  77 #include <mach/mach_error.h>
  78
  79 #include <sys/cdefs.h>
  80
  81 __BEGIN_DECLS
  82 /*
  83  * Standard prototypes
  84  */
  85 extern void                     panic_init(mach_port_t);
  86 extern void                     panic(const char *, ...);
  87
  88 extern void                     safe_gets(char *,
  89                                           char *,
  90                                           int);
  91
  92 extern void                     slot_name(cpu_type_t,
  93                                           cpu_subtype_t,
  94                                           char **,
  95                                           char **);
  96
  97 extern void                     mig_reply_setup(mach_msg_header_t *,
  98                                                 mach_msg_header_t *);
  99
 100 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 101 extern void                     mach_msg_destroy(mach_msg_header_t *);
 102
 103 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 104 extern mach_msg_return_t        mach_msg_receive(mach_msg_header_t *);
 105
 106 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 107 extern mach_msg_return_t        mach_msg_send(mach_msg_header_t *);
 108
 109 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 110 extern mach_msg_return_t        mach_msg_server_once(boolean_t (*)
 111                                                      (mach_msg_header_t *,
 112                                                       mach_msg_header_t *),
 113                                                      mach_msg_size_t,
 114                                                      mach_port_t,
 115                                                      mach_msg_options_t);
 116
 117 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 118 extern mach_msg_return_t        mach_msg_server(boolean_t (*)
 119                                                 (mach_msg_header_t *,
 120                                                  mach_msg_header_t *),
 121                                                 mach_msg_size_t,
 122                                                 mach_port_t,
 123                                                 mach_msg_options_t);
 124
 125 __WATCHOS_PROHIBITED __TVOS_PROHIBITED
 126 extern mach_msg_return_t        mach_msg_server_importance(boolean_t (*)
 127                                                 (mach_msg_header_t *,
 128                                                  mach_msg_header_t *),
 129                                                 mach_msg_size_t,
 130                                                 mach_port_t,
 131                                                 mach_msg_options_t);
 132 /*
 133  * Prototypes for compatibility
 134  */
 135 extern kern_return_t    clock_get_res(mach_port_t,
 136                                       clock_res_t *);
 137 extern kern_return_t    clock_set_res(mach_port_t,
 138                                       clock_res_t);
 139
 140 extern kern_return_t    clock_sleep(mach_port_t,
 141                                     int,
 142                                     mach_timespec_t,
 143                                     mach_timespec_t *);
 144
 145 /*!
 146  * @group voucher_mach_msg Prototypes
 147  */
 148
 149 #define VOUCHER_MACH_MSG_API_VERSION 20140205
 150
 151 /*!
 152  * @typedef voucher_mach_msg_state_t
 153  *
 154  * @abstract
 155  * Opaque object encapsulating state changed by voucher_mach_msg_adopt().
 156  */
 157 typedef struct voucher_mach_msg_state_s *voucher_mach_msg_state_t;
 158
 159 /*!
 160  * @const VOUCHER_MACH_MSG_STATE_UNCHANGED
 161  *
 162  * @discussion
 163  * Constant indicating no state change occurred.
 164  */
 165 #define VOUCHER_MACH_MSG_STATE_UNCHANGED ((voucher_mach_msg_state_t)~0ul)
 166
 167 /*!
 168  * @function voucher_mach_msg_set
 169  *
 170  * @abstract
 171  * Change specified message header to contain current mach voucher with a
 172  * COPY_SEND disposition.
 173  * Does not change message if it already has non-zero MACH_MSGH_BITS_VOUCHER.
 174  *
 175  * @discussion
 176  * Borrows reference to current thread voucher so message should be sent
 177  * immediately (without intervening calls that might change that voucher).
 178  *
 179  * @param msg
 180  * The message to modify.
 181  *
 182  * @result
 183  * True if header was changed.
 184  */
 185 extern boolean_t voucher_mach_msg_set(mach_msg_header_t *msg);
 186
 187 /*!
 188  * @function voucher_mach_msg_clear
 189  *
 190  * @abstract
 191  * Removes changes made to specified message header by voucher_mach_msg_set()
 192  * and any mach_msg() send operations (successful or not).
 193  * If the message is not needed further, mach_msg_destroy() should be called
 194  * instead.
 195  *
 196  * @discussion
 197  * Not intended to be called if voucher_mach_msg_set() returned false.
 198  * Releases reference to message mach voucher if an extra reference was
 199  * acquired due to an unsuccessful send operation (pseudo-receive).
 200  *
 201  * @param msg
 202  * The message to modify.
 203  */
 204 extern void voucher_mach_msg_clear(mach_msg_header_t *msg);
 205
 206 /*!
 207  * @function voucher_mach_msg_adopt
 208  *
 209  * @abstract
 210  * Adopt the voucher contained in the specified message on the current thread
 211  * and return the previous thread voucher state.
 212  *
 213  * @discussion
 214  * Ownership of the mach voucher in the message is transferred to the current
 215  * thread and the message header voucher fields are cleared.
 216  *
 217  * @param msg
 218  * The message to query and modify.
 219  *
 220  * @result
 221  * The previous thread voucher state or VOUCHER_MACH_MSG_STATE_UNCHANGED if no
 222  * state change occurred.
 223  */
 224 extern voucher_mach_msg_state_t voucher_mach_msg_adopt(mach_msg_header_t *msg);
 225
 226 /*!
 227  * @function voucher_mach_msg_revert
 228  *
 229  * @abstract
 230  * Restore thread voucher state previously modified by voucher_mach_msg_adopt().
 231  *
 232  * @discussion
 233  * Current thread voucher reference is released.
 234  * No change to thread voucher state if passed VOUCHER_MACH_MSG_STATE_UNCHANGED.
 235  *
 236  * @param state
 237  * The thread voucher state to restore.
 238  */
 239
 240 extern void voucher_mach_msg_revert(voucher_mach_msg_state_t state);
 241
 242 __END_DECLS
 243
 244 #endif  /* _MACH_H_ */