blob: b1057541e0246833d220223bc9347cfb71be8038 [file] [log] [blame]
Elliott Hughes14e3ff92017-10-06 16:58:36 -07001/*
2 * Copyright (C) 2017 The Android Open Source Project
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 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _SPAWN_H_
30#define _SPAWN_H_
31
32#include <sys/cdefs.h>
33#include <sys/types.h>
34#include <sched.h>
35#include <signal.h>
36
37__BEGIN_DECLS
38
39#define POSIX_SPAWN_RESETIDS 1
40#define POSIX_SPAWN_SETPGROUP 2
41#define POSIX_SPAWN_SETSIGDEF 4
42#define POSIX_SPAWN_SETSIGMASK 8
43#define POSIX_SPAWN_SETSCHEDPARAM 16
44#define POSIX_SPAWN_SETSCHEDULER 32
45#if defined(__USE_GNU)
46#define POSIX_SPAWN_USEVFORK 64
47#define POSIX_SPAWN_SETSID 128
48#endif
Elliott Hughes2229e552024-08-22 17:12:23 +000049/**
50 * Used with posix_spawnattr_setflags() to mark all fds except
51 * stdin/stdout/stderr as O_CLOEXEC prior to executing registered file actions.
52 */
Maciej Żenczykowski262b8732022-01-20 14:56:20 -080053#define POSIX_SPAWN_CLOEXEC_DEFAULT 256
Elliott Hughes14e3ff92017-10-06 16:58:36 -070054
55typedef struct __posix_spawnattr* posix_spawnattr_t;
56typedef struct __posix_spawn_file_actions* posix_spawn_file_actions_t;
57
Dan Albert02ce4012024-10-25 19:13:49 +000058
59#if __BIONIC_AVAILABILITY_GUARD(28)
Elliott Hughes2229e552024-08-22 17:12:23 +000060int posix_spawn(pid_t* _Nullable __pid, const char* _Nonnull __path, const posix_spawn_file_actions_t _Nullable * _Nullable __actions, const posix_spawnattr_t _Nullable * _Nullable __attr, char* const _Nullable __argv[_Nullable], char* const _Nullable __env[_Nullable]) __INTRODUCED_IN(28);
61int posix_spawnp(pid_t* _Nullable __pid, const char* _Nonnull __file, const posix_spawn_file_actions_t _Nullable * _Nullable __actions, const posix_spawnattr_t _Nullable * _Nullable __attr, char* const _Nullable __argv[_Nullable], char* const _Nullable __env[_Nullable]) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070062
zijunzhao148476d2024-02-29 22:55:00 +000063int posix_spawnattr_init(posix_spawnattr_t _Nullable * _Nonnull __attr) __INTRODUCED_IN(28);
zijunzhao8f23da62023-03-31 06:08:20 +000064int posix_spawnattr_destroy(posix_spawnattr_t _Nonnull * _Nonnull __attr) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070065
zijunzhao8f23da62023-03-31 06:08:20 +000066int posix_spawnattr_setflags(posix_spawnattr_t _Nonnull * _Nonnull __attr, short __flags) __INTRODUCED_IN(28);
67int posix_spawnattr_getflags(const posix_spawnattr_t _Nonnull * _Nonnull __attr, short* _Nonnull __flags) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070068
zijunzhao8f23da62023-03-31 06:08:20 +000069int posix_spawnattr_setpgroup(posix_spawnattr_t _Nonnull * _Nonnull __attr, pid_t __pgroup) __INTRODUCED_IN(28);
70int posix_spawnattr_getpgroup(const posix_spawnattr_t _Nonnull * _Nonnull __attr, pid_t* _Nonnull __pgroup) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070071
zijunzhao8f23da62023-03-31 06:08:20 +000072int posix_spawnattr_setsigmask(posix_spawnattr_t _Nonnull * _Nonnull __attr, const sigset_t* _Nonnull __mask) __INTRODUCED_IN(28);
73int posix_spawnattr_setsigmask64(posix_spawnattr_t _Nonnull * _Nonnull __attr, const sigset64_t* _Nonnull __mask) __INTRODUCED_IN(28);
74int posix_spawnattr_getsigmask(const posix_spawnattr_t _Nonnull * _Nonnull __attr, sigset_t* _Nonnull __mask) __INTRODUCED_IN(28);
75int posix_spawnattr_getsigmask64(const posix_spawnattr_t _Nonnull * _Nonnull __attr, sigset64_t* _Nonnull __mask) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070076
zijunzhao8f23da62023-03-31 06:08:20 +000077int posix_spawnattr_setsigdefault(posix_spawnattr_t _Nonnull * _Nonnull __attr, const sigset_t* _Nonnull __mask) __INTRODUCED_IN(28);
78int posix_spawnattr_setsigdefault64(posix_spawnattr_t _Nonnull * _Nonnull __attr, const sigset64_t* _Nonnull __mask) __INTRODUCED_IN(28);
79int posix_spawnattr_getsigdefault(const posix_spawnattr_t _Nonnull * _Nonnull __attr, sigset_t* _Nonnull __mask) __INTRODUCED_IN(28);
80int posix_spawnattr_getsigdefault64(const posix_spawnattr_t _Nonnull * _Nonnull __attr, sigset64_t* _Nonnull __mask) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070081
zijunzhao8f23da62023-03-31 06:08:20 +000082int posix_spawnattr_setschedparam(posix_spawnattr_t _Nonnull * _Nonnull __attr, const struct sched_param* _Nonnull __param) __INTRODUCED_IN(28);
83int posix_spawnattr_getschedparam(const posix_spawnattr_t _Nonnull * _Nonnull __attr, struct sched_param* _Nonnull __param) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070084
zijunzhao8f23da62023-03-31 06:08:20 +000085int posix_spawnattr_setschedpolicy(posix_spawnattr_t _Nonnull * _Nonnull __attr, int __policy) __INTRODUCED_IN(28);
86int posix_spawnattr_getschedpolicy(const posix_spawnattr_t _Nonnull * _Nonnull __attr, int* _Nonnull __policy) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070087
zijunzhao8f23da62023-03-31 06:08:20 +000088int posix_spawn_file_actions_init(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions) __INTRODUCED_IN(28);
89int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions) __INTRODUCED_IN(28);
Elliott Hughes14e3ff92017-10-06 16:58:36 -070090
zijunzhao8f23da62023-03-31 06:08:20 +000091int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions, int __fd, const char* _Nonnull __path, int __flags, mode_t __mode) __INTRODUCED_IN(28);
92int posix_spawn_file_actions_addclose(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions, int __fd) __INTRODUCED_IN(28);
93int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions, int __fd, int __new_fd) __INTRODUCED_IN(28);
Dan Albert02ce4012024-10-25 19:13:49 +000094#endif /* __BIONIC_AVAILABILITY_GUARD(28) */
Elliott Hughes14e3ff92017-10-06 16:58:36 -070095
Dan Albert02ce4012024-10-25 19:13:49 +000096
97
98#if __BIONIC_AVAILABILITY_GUARD(34)
Elliott Hughes462ca8b2023-04-04 13:33:28 -070099int posix_spawn_file_actions_addchdir_np(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions, const char* _Nonnull __path) __INTRODUCED_IN(34);
100int posix_spawn_file_actions_addfchdir_np(posix_spawn_file_actions_t _Nonnull * _Nonnull __actions, int __fd) __INTRODUCED_IN(34);
Dan Albert02ce4012024-10-25 19:13:49 +0000101#endif /* __BIONIC_AVAILABILITY_GUARD(34) */
102
Elliott Hughes462ca8b2023-04-04 13:33:28 -0700103
Elliott Hughes14e3ff92017-10-06 16:58:36 -0700104__END_DECLS
105
106#endif