xref: /openbsd-src/include/spawn.h (revision 4c1e55dc91edd6e69ccc60ce855900fbc12cf34f)
1 /*	$OpenBSD: spawn.h,v 1.1 2012/03/21 23:20:35 matthew 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/cdefs.h>
34 #include <sys/types.h>
35 #include <sys/signal.h>
36 
37 struct sched_param;
38 
39 typedef struct __posix_spawnattr		*posix_spawnattr_t;
40 typedef struct __posix_spawn_file_actions	*posix_spawn_file_actions_t;
41 
42 #define POSIX_SPAWN_RESETIDS		0x01
43 #define POSIX_SPAWN_SETPGROUP		0x02
44 #define POSIX_SPAWN_SETSCHEDPARAM	0x04
45 #define POSIX_SPAWN_SETSCHEDULER	0x08
46 #define POSIX_SPAWN_SETSIGDEF		0x10
47 #define POSIX_SPAWN_SETSIGMASK		0x20
48 
49 __BEGIN_DECLS
50 /*
51  * Spawn routines
52  *
53  * XXX both arrays should be __restrict, but this does not work when GCC
54  * is invoked with -std=c99.
55  */
56 int posix_spawn(pid_t *__restrict, const char *__restrict,
57     const posix_spawn_file_actions_t *, const posix_spawnattr_t *__restrict,
58     char *const [], char *const []);
59 int posix_spawnp(pid_t *__restrict, const char *__restrict,
60     const posix_spawn_file_actions_t *, const posix_spawnattr_t *__restrict,
61     char *const [], char *const []);
62 
63 /*
64  * File descriptor actions
65  */
66 int posix_spawn_file_actions_init(posix_spawn_file_actions_t *);
67 int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t *);
68 
69 int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t *__restrict,
70     int, const char *__restrict, int, mode_t);
71 int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t *, int, int);
72 int posix_spawn_file_actions_addclose(posix_spawn_file_actions_t *, int);
73 
74 /*
75  * Spawn attributes
76  */
77 int posix_spawnattr_init(posix_spawnattr_t *);
78 int posix_spawnattr_destroy(posix_spawnattr_t *);
79 
80 int posix_spawnattr_getflags(const posix_spawnattr_t *__restrict,
81     short *__restrict);
82 int posix_spawnattr_getpgroup(const posix_spawnattr_t *__restrict,
83     pid_t *__restrict);
84 int posix_spawnattr_getschedparam(const posix_spawnattr_t *__restrict,
85     struct sched_param *__restrict);
86 int posix_spawnattr_getschedpolicy(const posix_spawnattr_t *__restrict,
87     int *__restrict);
88 int posix_spawnattr_getsigdefault(const posix_spawnattr_t *__restrict,
89     sigset_t *__restrict);
90 int posix_spawnattr_getsigmask(const posix_spawnattr_t *__restrict,
91     sigset_t *__restrict sigmask);
92 
93 int posix_spawnattr_setflags(posix_spawnattr_t *, short);
94 int posix_spawnattr_setpgroup(posix_spawnattr_t *, pid_t);
95 int posix_spawnattr_setschedparam(posix_spawnattr_t *__restrict,
96     const struct sched_param *__restrict);
97 int posix_spawnattr_setschedpolicy(posix_spawnattr_t *, int);
98 int posix_spawnattr_setsigdefault(posix_spawnattr_t *__restrict,
99     const sigset_t *__restrict);
100 int posix_spawnattr_setsigmask(posix_spawnattr_t *__restrict,
101     const sigset_t *__restrict);
102 __END_DECLS
103 
104 #endif /* !_SPAWN_H_ */
105