annotate lib/popen-safer.c @ 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
11850
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* Invoke popen, but avoid some glitches.
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 19484
diff changeset
3 Copyright (C) 2009-2019 Free Software Foundation, Inc.
11850
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8 (at your option) any later version.
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13 GNU General Public License for more details.
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
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: 19052
diff changeset
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
11850
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18 /* Written by Eric Blake. */
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20 #include <config.h>
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22 #include "stdio-safer.h"
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24 #include <errno.h>
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25 #include <fcntl.h>
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
26 #include <unistd.h>
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
28 /* Like popen, but do not return stdin, stdout, or stderr. */
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
29
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30 FILE *
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31 popen_safer (char const *cmd, char const *mode)
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 {
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 /* Unfortunately, we cannot use the fopen_safer approach of using
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34 fdopen (dup_safer (fileno (popen (cmd, mode)))), because stdio
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 libraries maintain hidden state tying the original fd to the pid
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36 to wait on when using pclose (this hidden state is also used to
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37 avoid fd leaks in subsequent popen calls). So, we instead
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38 guarantee that all standard streams are open prior to the popen
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 call (even though this puts more pressure on open fds), so that
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 the original fd created by popen is safe. */
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 FILE *fp;
19052
637f3a63efbd open: support O_CLOEXEC
Paul Eggert <eggert@cs.ucla.edu>
parents: 18626
diff changeset
42 int fd = open ("/dev/null", O_RDONLY | O_CLOEXEC);
11850
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 if (0 <= fd && fd <= STDERR_FILENO)
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 {
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
45 /* Maximum recursion depth is 3. */
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
46 int saved_errno;
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
47 fp = popen_safer (cmd, mode);
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
48 saved_errno = errno;
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
49 close (fd);
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
50 errno = saved_errno;
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
51 }
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
52 else
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
53 {
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
54 /* Either all fd's are tied up, or fd is safe and the real popen
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11860
diff changeset
55 will reuse it. */
11850
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
56 close (fd);
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
57 fp = popen (cmd, mode);
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
58 }
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
59 return fp;
9ebc8e9eca64 popen-safer: prevent popen from clobbering std descriptors
Eric Blake <ebb9@byu.net>
parents:
diff changeset
60 }