include/spawn.h

   1 /*
   2  * Copyright (c) 2006, 2010 Apple 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
  25 #ifndef _SPAWN_H_
  26 #define _SPAWN_H_
  27
  28 /*
  29  * [SPN] Support for _POSIX_SPAWN
  30  */
  31
  32 #include <sys/cdefs.h>
  33 #include <_types.h>
  34 #include <sys/spawn.h>  /* shared types */
  35
  36 #include <Availability.h>
  37
  38 /*
  39  * [SPN] Inclusion of the <spawn.h> header may make visible symbols defined
  40  * in the <sched.h>, <signal.h>, and <sys/types.h> headers.
  41  */
  42 #ifndef _PID_T
  43 typedef __darwin_pid_t          pid_t;
  44 #define _PID_T
  45 #endif
  46
  47 #ifndef _SIGSET_T
  48 #define _SIGSET_T
  49 typedef __darwin_sigset_t       sigset_t;
  50 #endif
  51
  52 #ifndef _MODE_T
  53 typedef __darwin_mode_t         mode_t;
  54 #define _MODE_T
  55 #endif
  56
  57 /*
  58  * Opaque types for use with posix_spawn() family functions.  Internals are
  59  * not defined, and should not be accessed directly.  Types are defined as
  60  * mandated by POSIX.
  61  */
  62 typedef  void *posix_spawnattr_t;
  63 typedef  void *posix_spawn_file_actions_t;
  64
  65 __BEGIN_DECLS
  66 /*
  67  * gcc under c99 mode won't compile "[ __restrict]" by itself.  As a workaround,
  68  * a dummy argument name is added.
  69  */
  70 int     posix_spawn(pid_t * __restrict, const char * __restrict,
  71                 const posix_spawn_file_actions_t *,
  72                 const posix_spawnattr_t * __restrict,
  73                 char *const __argv[ __restrict],
  74                 char *const __envp[ __restrict]) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  75 int     posix_spawnp(pid_t * __restrict, const char * __restrict,
  76                 const posix_spawn_file_actions_t *,
  77                 const posix_spawnattr_t * __restrict,
  78                 char *const __argv[ __restrict],
  79                 char *const __envp[ __restrict]) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  80 int     posix_spawn_file_actions_addclose(posix_spawn_file_actions_t *, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  81 int     posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t *, int,
  82                 int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  83 int     posix_spawn_file_actions_addopen(
  84                 posix_spawn_file_actions_t * __restrict, int,
  85                 const char * __restrict, int, mode_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  86 int     posix_spawn_file_actions_destroy(posix_spawn_file_actions_t *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  87 int     posix_spawn_file_actions_init(posix_spawn_file_actions_t *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  88 int     posix_spawnattr_destroy(posix_spawnattr_t *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  89 int     posix_spawnattr_getsigdefault(const posix_spawnattr_t * __restrict,
  90                 sigset_t * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  91 int     posix_spawnattr_getflags(const posix_spawnattr_t * __restrict,
  92                 short * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  93 int     posix_spawnattr_getpgroup(const posix_spawnattr_t * __restrict,
  94                 pid_t * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  95 int     posix_spawnattr_getsigmask(const posix_spawnattr_t * __restrict,
  96                 sigset_t * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  97 int     posix_spawnattr_init(posix_spawnattr_t *) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
  98 int     posix_spawnattr_setsigdefault(posix_spawnattr_t * __restrict,
  99                 const sigset_t * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 100 int     posix_spawnattr_setflags(posix_spawnattr_t *, short) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 101 int     posix_spawnattr_setpgroup(posix_spawnattr_t *, pid_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 102 int     posix_spawnattr_setsigmask(posix_spawnattr_t * __restrict,
 103                 const sigset_t * __restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 104
 105 #if 0   /* _POSIX_PRIORITY_SCHEDULING [PS] : not supported */
 106 int     posix_spawnattr_setschedparam(posix_spawnattr_t * __restrict,
 107                 const struct sched_param * __restrict);
 108 int     posix_spawnattr_setschedpolicy(posix_spawnattr_t *, int);
 109 int     posix_spawnattr_getschedparam(const posix_spawnattr_t * __restrict,
 110                 struct sched_param * __restrict);
 111 int     posix_spawnattr_getschedpolicy(const posix_spawnattr_t * __restrict,
 112                 int * __restrict);
 113 #endif  /* 0 */
 114
 115 __END_DECLS
 116
 117 #if     !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 118 /*
 119  * Darwin-specific extensions below
 120  */
 121 #include <mach/exception_types.h>
 122 #include <mach/machine.h>
 123 #include <mach/port.h>
 124
 125 #ifndef _SIZE_T
 126 typedef __darwin_size_t         size_t;
 127 #define _SIZE_T
 128 #endif
 129
 130 __BEGIN_DECLS
 131
 132 int     posix_spawnattr_getbinpref_np(const posix_spawnattr_t * __restrict,
 133                 size_t, cpu_type_t *__restrict, size_t *__restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 134 int     posix_spawnattr_setauditsessionport_np(posix_spawnattr_t *__restrict,
 135                 mach_port_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 136 int     posix_spawnattr_setbinpref_np(posix_spawnattr_t * __restrict,
 137                 size_t, cpu_type_t *__restrict, size_t *__restrict) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 138 int     posix_spawnattr_setexceptionports_np(posix_spawnattr_t *__restrict,
 139                 exception_mask_t, mach_port_t,
 140                 exception_behavior_t, thread_state_flavor_t) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 141 int     posix_spawnattr_setspecialport_np(posix_spawnattr_t *__restrict,
 142                 mach_port_t, int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
 143 int     posix_spawn_file_actions_addinherit_np(posix_spawn_file_actions_t *,
 144                 int) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
 145
 146 __END_DECLS
 147
 148 #endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 149 #endif  /* _SPAWN_H_ */