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