include/spawn.h

   1 /*-
   2  * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/include/spawn.h,v 1.3 2008/06/19 07:30:32 ed Exp $
  27  */
  28
  29 #ifndef _SPAWN_H_
  30 #define _SPAWN_H_
  31
  32 #include <sys/cdefs.h>
  33 #include <sys/signal.h>
  34 #include <sys/stdint.h>
  35
  36 #ifndef _MODE_T_DECLARED
  37 typedef __uint16_t      mode_t;
  38 #define _MODE_T_DECLARED
  39 #endif
  40
  41 #ifndef _PID_T_DECLARED
  42 typedef __pid_t         pid_t;
  43 #define _PID_T_DECLARED
  44 #endif
  45
  46 struct sched_param;
  47
  48 typedef struct __posix_spawnattr                *posix_spawnattr_t;
  49 typedef struct __posix_spawn_file_actions       *posix_spawn_file_actions_t;
  50
  51 #define POSIX_SPAWN_RESETIDS            0x01
  52 #define POSIX_SPAWN_SETPGROUP           0x02
  53 #define POSIX_SPAWN_SETSCHEDPARAM       0x04
  54 #define POSIX_SPAWN_SETSCHEDULER        0x08
  55 #define POSIX_SPAWN_SETSIGDEF           0x10
  56 #define POSIX_SPAWN_SETSIGMASK          0x20
  57
  58 __BEGIN_DECLS
  59 /*
  60  * Spawn routines
  61  *
  62  * XXX both arrays should be __restrict, but this does not work when GCC
  63  * is invoked with -std=c99.
  64  */
  65 int posix_spawn(pid_t * __restrict, const char * __restrict,
  66                 const posix_spawn_file_actions_t *,
  67                 const posix_spawnattr_t * __restrict, char * const [],
  68                 char * const []);
  69 int posix_spawnp(pid_t * __restrict, const char * __restrict,
  70                  const posix_spawn_file_actions_t *,
  71                  const posix_spawnattr_t * __restrict, char * const [],
  72                  char * const []);
  73
  74 /*
  75  * File descriptor actions
  76  */
  77 int posix_spawn_file_actions_init(posix_spawn_file_actions_t *);
  78 int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t *);
  79
  80 int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t * __restrict,
  81                                      int, const char * __restrict, int, mode_t);
  82 int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t *, int, int);
  83 int posix_spawn_file_actions_addclose(posix_spawn_file_actions_t *, int);
  84
  85 /*
  86  * Spawn attributes
  87  */
  88 int posix_spawnattr_init(posix_spawnattr_t *);
  89 int posix_spawnattr_destroy(posix_spawnattr_t *);
  90
  91 int posix_spawnattr_getflags(const posix_spawnattr_t * __restrict,
  92                              short * __restrict);
  93 int posix_spawnattr_getpgroup(const posix_spawnattr_t * __restrict,
  94                               pid_t * __restrict);
  95 int posix_spawnattr_getschedparam(const posix_spawnattr_t * __restrict,
  96                                   struct sched_param * __restrict);
  97 int posix_spawnattr_getschedpolicy(const posix_spawnattr_t * __restrict,
  98                                    int * __restrict);
  99 int posix_spawnattr_getsigdefault(const posix_spawnattr_t * __restrict,
 100                                   sigset_t * __restrict);
 101 int posix_spawnattr_getsigmask(const posix_spawnattr_t * __restrict,
 102                                sigset_t * __restrict sigmask);
 103
 104 int posix_spawnattr_setflags(posix_spawnattr_t *, short);
 105 int posix_spawnattr_setpgroup(posix_spawnattr_t *, pid_t);
 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_setsigdefault(posix_spawnattr_t * __restrict,
 110                                   const sigset_t * __restrict);
 111 int posix_spawnattr_setsigmask(posix_spawnattr_t * __restrict,
 112                                const sigset_t * __restrict);
 113 __END_DECLS
 114
 115 #endif /* !_SPAWN_H_ */