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$
  27  */
  28
  29 #ifndef _SPAWN_H_
  30 #define _SPAWN_H_
  31
  32 #include <sys/cdefs.h>
  33 #include <sys/_types.h>
  34 #include <sys/_sigset.h>
  35
  36 #ifndef _MODE_T_DECLARED
  37 typedef __mode_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 #ifndef _SIGSET_T_DECLARED
  47 #define _SIGSET_T_DECLARED
  48 typedef __sigset_t      sigset_t;
  49 #endif
  50
  51 struct sched_param;
  52
  53 typedef struct __posix_spawnattr                *posix_spawnattr_t;
  54 typedef struct __posix_spawn_file_actions       *posix_spawn_file_actions_t;
  55
  56 #define POSIX_SPAWN_RESETIDS            0x01
  57 #define POSIX_SPAWN_SETPGROUP           0x02
  58 #define POSIX_SPAWN_SETSCHEDPARAM       0x04
  59 #define POSIX_SPAWN_SETSCHEDULER        0x08
  60 #define POSIX_SPAWN_SETSIGDEF           0x10
  61 #define POSIX_SPAWN_SETSIGMASK          0x20
  62
  63 __BEGIN_DECLS
  64 /*
  65  * Spawn routines
  66  *
  67  * XXX both arrays should be __restrict, but this does not work when GCC
  68  * is invoked with -std=c99.
  69  */
  70 int posix_spawn(pid_t * __restrict, const char * __restrict,
  71     const posix_spawn_file_actions_t *, const posix_spawnattr_t * __restrict,
  72     char * const [], char * const []);
  73 int posix_spawnp(pid_t * __restrict, const char * __restrict,
  74     const posix_spawn_file_actions_t *, const posix_spawnattr_t * __restrict,
  75     char * const [], char * const []);
  76
  77 /*
  78  * File descriptor actions
  79  */
  80 int posix_spawn_file_actions_init(posix_spawn_file_actions_t *);
  81 int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t *);
  82
  83 int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t * __restrict,
  84     int, const char * __restrict, int, mode_t);
  85 int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t *, int, int);
  86 int posix_spawn_file_actions_addclose(posix_spawn_file_actions_t *, int);
  87
  88 /*
  89  * Spawn attributes
  90  */
  91 int posix_spawnattr_init(posix_spawnattr_t *);
  92 int posix_spawnattr_destroy(posix_spawnattr_t *);
  93
  94 int posix_spawnattr_getflags(const posix_spawnattr_t * __restrict,
  95     short * __restrict);
  96 int posix_spawnattr_getpgroup(const posix_spawnattr_t * __restrict,
  97     pid_t * __restrict);
  98 int posix_spawnattr_getschedparam(const posix_spawnattr_t * __restrict,
  99     struct sched_param * __restrict);
 100 int posix_spawnattr_getschedpolicy(const posix_spawnattr_t * __restrict,
 101     int * __restrict);
 102 int posix_spawnattr_getsigdefault(const posix_spawnattr_t * __restrict,
 103     sigset_t * __restrict);
 104 int posix_spawnattr_getsigmask(const posix_spawnattr_t * __restrict,
 105     sigset_t * __restrict sigmask);
 106
 107 int posix_spawnattr_setflags(posix_spawnattr_t *, short);
 108 int posix_spawnattr_setpgroup(posix_spawnattr_t *, pid_t);
 109 int posix_spawnattr_setschedparam(posix_spawnattr_t * __restrict,
 110     const struct sched_param * __restrict);
 111 int posix_spawnattr_setschedpolicy(posix_spawnattr_t *, int);
 112 int posix_spawnattr_setsigdefault(posix_spawnattr_t * __restrict,
 113     const sigset_t * __restrict);
 114 int posix_spawnattr_setsigmask(posix_spawnattr_t * __restrict,
 115     const sigset_t * __restrict);
 116 __END_DECLS
 117
 118 #endif /* !_SPAWN_H_ */