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