annotate lib/cloexec.h @ 40196:e63f5d3edab5

relocatable-prog: Update documentation. * doc/relocatable-maint.texi (Supporting Relocation): Update to match the recent changes.
author Bruno Haible <bruno@clisp.org>
date Sun, 24 Feb 2019 01:49:15 +0100
parents b06060465f09
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19066
f4931d86d489 cloexec: spelling fixes in comments
Paul Eggert <eggert@cs.ucla.edu>
parents: 18626
diff changeset
1 /* cloexec.c - set or clear the close-on-exec descriptor flag
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
2
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 19484
diff changeset
3 Copyright (C) 2004, 2009-2019 Free Software Foundation, Inc.
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
4
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
5 This program is free software: you can redistribute it and/or modify
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
6 it under the terms of the GNU General Public License as published by
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
8 (at your option) any later version.
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
9
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
10 This program is distributed in the hope that it will be useful,
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
13 GNU General Public License for more details.
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
14
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
15 You should have received a copy of the GNU General Public License
19190
9759915b2aca all: prefer https: URLs
Paul Eggert <eggert@cs.ucla.edu>
parents: 19066
diff changeset
16 along with this program. If not, see <https://www.gnu.org/licenses/>.
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
17
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
18 */
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
19
4979
6b9af4133e6f Merge changes to getloadavg.c from coreutils and Emacs; this
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20 #include <stdbool.h>
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
21
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
22 /* Set the 'FD_CLOEXEC' flag of DESC if VALUE is true,
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
23 or clear the flag if VALUE is false.
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
24 Return 0 on success, or -1 on error with 'errno' set.
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
25
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
26 Note that on MingW, this function does NOT protect DESC from being
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
27 inherited into spawned children. Instead, either use dup_cloexec
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
28 followed by closing the original DESC, or use interfaces such as
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
29 open or pipe2 that accept flags like O_CLOEXEC to create DESC
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
30 non-inheritable in the first place. */
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
31
4982
87f0b7b6d498 cloexec returns int not bool, to be more consistent with Unix conventions.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4979
diff changeset
32 int set_cloexec_flag (int desc, bool value);
12390
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
33
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
34 /* Duplicates a file handle FD, while marking the copy to be closed
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
35 prior to exec or spawn. Returns -1 and sets errno if FD could not
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
36 be duplicated. */
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
37
f203ad5f7ea8 cloexec: add dup_cloexec
Eric Blake <ebb9@byu.net>
parents: 4982
diff changeset
38 int dup_cloexec (int fd);