xref: /freebsd/lib/libc/gen/posix_spawnattr_getflags.3 (revision e63d20b70ee1dbee9b075f29de6f30cdcfe1abe1)
1.\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" Portions of this text are reprinted and reproduced in electronic form
26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27.\" Portable Operating System Interface (POSIX), The Open Group Base
28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30.\" event of any discrepancy between this version and the original IEEE and
31.\" The Open Group Standard, the original IEEE and The Open Group Standard is
32.\" the referee document.  The original Standard can be obtained online at
33.\"	http://www.opengroup.org/unix/online.html.
34.\"
35.Dd March 4, 2024
36.Dt POSIX_SPAWNATTR_GETFLAGS 3
37.Os
38.Sh NAME
39.Nm posix_spawnattr_getflags ,
40.Nm posix_spawnattr_setflags
41.Nd "get and set the spawn-flags attribute of a spawn attributes object"
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In spawn.h
46.Ft int
47.Fn posix_spawnattr_getflags "const posix_spawnattr_t *restrict attr" "short *restrict flags"
48.Ft int
49.Fn posix_spawnattr_setflags "posix_spawnattr_t *attr" "short flags"
50.Sh DESCRIPTION
51The
52.Fn posix_spawnattr_getflags
53function obtains the value of the spawn-flags attribute from the
54attributes object referenced by
55.Fa attr .
56.Pp
57The
58.Fn posix_spawnattr_setflags
59function sets the spawn-flags attribute in an initialized
60attributes object referenced by
61.Fa attr .
62.Pp
63The spawn-flags attribute is used to indicate which process attributes
64are to be changed in the new process image when invoking
65.Fn posix_spawn
66or
67.Fn posix_spawnp .
68It is the bitwise-inclusive OR of zero or more of the following flags
69(see
70.Fn posix_spawn ) :
71.Bl -tag -width "POSIX_SPAWN_SETSCHEDPARAM" -offset indent
72.It Dv POSIX_SPAWN_RESETIDS
73.It Dv POSIX_SPAWN_SETPGROUP
74.It Dv POSIX_SPAWN_SETSIGDEF
75.It Dv POSIX_SPAWN_SETSIGMASK
76.It Dv POSIX_SPAWN_SETSCHEDPARAM
77.It Dv POSIX_SPAWN_SETSCHEDULER
78.It Dv POSIX_SPAWN_DISABLE_ASLR_NP
79.El
80.Pp
81These flags are defined in
82.In spawn.h .
83The default value of this attribute is as if no flags were set.
84.Sh RETURN VALUES
85The
86.Fn posix_spawnattr_getflags
87function returns zero.
88The
89.Fn posix_spawnattr_setflags
90function returns zero on success, and
91.Er EINVAL
92on failure due to invalid flag specified.
93.Sh SEE ALSO
94.Xr posix_spawn 3 ,
95.Xr posix_spawnattr_destroy 3 ,
96.Xr posix_spawnattr_init 3 ,
97.Xr posix_spawnp 3
98.Sh STANDARDS
99The
100.Fn posix_spawnattr_getflags
101and
102.Fn posix_spawnattr_setflags
103functions conform to
104.St -p1003.1-2001 .
105.Sh HISTORY
106The
107.Fn posix_spawnattr_getflags
108and
109.Fn posix_spawnattr_setflags
110functions first appeared in
111.Fx 8.0 .
112.Sh AUTHORS
113.An \&Ed Schouten Aq Mt ed@FreeBSD.org
114