posix/spawn.h

   1 /* Definitions for POSIX spawn interface.
   2    Copyright (C) 2000-2017 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _SPAWN_H
  20 #define _SPAWN_H        1
  21
  22 #include <features.h>
  23 #include <sched.h>
  24 #define __need_sigset_t
  25 #include <signal.h>
  26 #include <sys/types.h>
  27
  28
  29 /* Data structure to contain attributes for thread creation.  */
  30 typedef struct
  31 {
  32   short int __flags;
  33   pid_t __pgrp;
  34   sigset_t __sd;
  35   sigset_t __ss;
  36   struct sched_param __sp;
  37   int __policy;
  38   int __pad[16];
  39 } posix_spawnattr_t;
  40
  41
  42 /* Data structure to contain information about the actions to be
  43    performed in the new process with respect to file descriptors.  */
  44 typedef struct
  45 {
  46   int __allocated;
  47   int __used;
  48   struct __spawn_action *__actions;
  49   int __pad[16];
  50 } posix_spawn_file_actions_t;
  51
  52
  53 /* Flags to be set in the `posix_spawnattr_t'.  */
  54 #define POSIX_SPAWN_RESETIDS            0x01
  55 #define POSIX_SPAWN_SETPGROUP           0x02
  56 #define POSIX_SPAWN_SETSIGDEF           0x04
  57 #define POSIX_SPAWN_SETSIGMASK          0x08
  58 #define POSIX_SPAWN_SETSCHEDPARAM       0x10
  59 #define POSIX_SPAWN_SETSCHEDULER        0x20
  60 #ifdef __USE_GNU
  61 # define POSIX_SPAWN_USEVFORK           0x40
  62 # define POSIX_SPAWN_SETSID             0x80
  63 #endif
  64
  65
  66 __BEGIN_DECLS
  67
  68 /* Spawn a new process executing PATH with the attributes describes in *ATTRP.
  69    Before running the process perform the actions described in FILE-ACTIONS.
  70
  71    This function is a possible cancellation point and therefore not
  72    marked with __THROW. */
  73 extern int posix_spawn (pid_t *__restrict __pid,
  74                         const char *__restrict __path,
  75                         const posix_spawn_file_actions_t *__restrict
  76                         __file_actions,
  77                         const posix_spawnattr_t *__restrict __attrp,
  78                         char *const __argv[__restrict_arr],
  79                         char *const __envp[__restrict_arr]);
  80
  81 /* Similar to `posix_spawn' but search for FILE in the PATH.
  82
  83    This function is a possible cancellation point and therefore not
  84    marked with __THROW.  */
  85 extern int posix_spawnp (pid_t *__pid, const char *__file,
  86                          const posix_spawn_file_actions_t *__file_actions,
  87                          const posix_spawnattr_t *__attrp,
  88                          char *const __argv[], char *const __envp[]);
  89
  90
  91 /* Initialize data structure with attributes for `spawn' to default values.  */
  92 extern int posix_spawnattr_init (posix_spawnattr_t *__attr) __THROW;
  93
  94 /* Free resources associated with ATTR.  */
  95 extern int posix_spawnattr_destroy (posix_spawnattr_t *__attr) __THROW;
  96
  97 /* Store signal mask for signals with default handling from ATTR in
  98    SIGDEFAULT.  */
  99 extern int posix_spawnattr_getsigdefault (const posix_spawnattr_t *
 100                                           __restrict __attr,
 101                                           sigset_t *__restrict __sigdefault)
 102      __THROW;
 103
 104 /* Set signal mask for signals with default handling in ATTR to SIGDEFAULT.  */
 105 extern int posix_spawnattr_setsigdefault (posix_spawnattr_t *__restrict __attr,
 106                                           const sigset_t *__restrict
 107                                           __sigdefault)
 108      __THROW;
 109
 110 /* Store signal mask for the new process from ATTR in SIGMASK.  */
 111 extern int posix_spawnattr_getsigmask (const posix_spawnattr_t *__restrict
 112                                        __attr,
 113                                        sigset_t *__restrict __sigmask) __THROW;
 114
 115 /* Set signal mask for the new process in ATTR to SIGMASK.  */
 116 extern int posix_spawnattr_setsigmask (posix_spawnattr_t *__restrict __attr,
 117                                        const sigset_t *__restrict __sigmask)
 118      __THROW;
 119
 120 /* Get flag word from the attribute structure.  */
 121 extern int posix_spawnattr_getflags (const posix_spawnattr_t *__restrict
 122                                      __attr,
 123                                      short int *__restrict __flags) __THROW;
 124
 125 /* Store flags in the attribute structure.  */
 126 extern int posix_spawnattr_setflags (posix_spawnattr_t *_attr,
 127                                      short int __flags) __THROW;
 128
 129 /* Get process group ID from the attribute structure.  */
 130 extern int posix_spawnattr_getpgroup (const posix_spawnattr_t *__restrict
 131                                       __attr, pid_t *__restrict __pgroup)
 132      __THROW;
 133
 134 /* Store process group ID in the attribute structure.  */
 135 extern int posix_spawnattr_setpgroup (posix_spawnattr_t *__attr,
 136                                       pid_t __pgroup) __THROW;
 137
 138 /* Get scheduling policy from the attribute structure.  */
 139 extern int posix_spawnattr_getschedpolicy (const posix_spawnattr_t *
 140                                            __restrict __attr,
 141                                            int *__restrict __schedpolicy)
 142      __THROW;
 143
 144 /* Store scheduling policy in the attribute structure.  */
 145 extern int posix_spawnattr_setschedpolicy (posix_spawnattr_t *__attr,
 146                                            int __schedpolicy) __THROW;
 147
 148 /* Get scheduling parameters from the attribute structure.  */
 149 extern int posix_spawnattr_getschedparam (const posix_spawnattr_t *
 150                                           __restrict __attr,
 151                                           struct sched_param *__restrict
 152                                           __schedparam) __THROW;
 153
 154 /* Store scheduling parameters in the attribute structure.  */
 155 extern int posix_spawnattr_setschedparam (posix_spawnattr_t *__restrict __attr,
 156                                           const struct sched_param *
 157                                           __restrict __schedparam) __THROW;
 158
 159
 160 /* Initialize data structure for file attribute for `spawn' call.  */
 161 extern int posix_spawn_file_actions_init (posix_spawn_file_actions_t *
 162                                           __file_actions) __THROW;
 163
 164 /* Free resources associated with FILE-ACTIONS.  */
 165 extern int posix_spawn_file_actions_destroy (posix_spawn_file_actions_t *
 166                                              __file_actions) __THROW;
 167
 168 /* Add an action to FILE-ACTIONS which tells the implementation to call
 169    `open' for the given file during the `spawn' call.  */
 170 extern int posix_spawn_file_actions_addopen (posix_spawn_file_actions_t *
 171                                              __restrict __file_actions,
 172                                              int __fd,
 173                                              const char *__restrict __path,
 174                                              int __oflag, mode_t __mode)
 175      __THROW;
 176
 177 /* Add an action to FILE-ACTIONS which tells the implementation to call
 178    `close' for the given file descriptor during the `spawn' call.  */
 179 extern int posix_spawn_file_actions_addclose (posix_spawn_file_actions_t *
 180                                               __file_actions, int __fd)
 181      __THROW;
 182
 183 /* Add an action to FILE-ACTIONS which tells the implementation to call
 184    `dup2' for the given file descriptors during the `spawn' call.  */
 185 extern int posix_spawn_file_actions_adddup2 (posix_spawn_file_actions_t *
 186                                              __file_actions,
 187                                              int __fd, int __newfd) __THROW;
 188
 189 __END_DECLS
 190
 191 #endif /* spawn.h */