annotate lib/popen.c @ 11848:9e3299dad578

popen: fix cygwin 1.5 bug when stdin closed * doc/posix-functions/popen.texi (popen): Document cygwin bugs. * modules/popen: New file. * modules/popen-tests: Likewise. * tests/test-popen.c: Likewise. * m4/popen.m4: Likewise. * lib/popen.c: Likewise. * lib/stdio.in.h (popen): New declaration. * m4/stdio_h.m4 (gl_STDIO_H_DEFAULTS): Add popen. * modules/stdio (Makefile.am): Likewise. * MODULES.html.sh (systems lacking POSIX:2008): Mention it. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Wed, 19 Aug 2009 07:15:54 -0600
parents
children f17a5ed578bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11848
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* Open a stream to a sub-process.
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2 Copyright (C) 2009 Free Software Foundation, Inc.
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
3
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 the Free Software Foundation; either version 3 of the License, or
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 (at your option) any later version.
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 GNU General Public License for more details.
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17 /* Written by Eric Blake <ebb9@byu.net>, 2009. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19 #include <config.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21 /* Get the original definition of popen. It might be defined as a macro. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22 #define __need_FILE
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23 # include <stdio.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24 #undef __need_FILE
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
26 static inline FILE *
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27 orig_popen (const char *filename, const char *mode)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
28 {
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
29 return popen (filename, mode);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30 }
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 /* Specification. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 #include <stdio.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 #include <errno.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36 #include <fcntl.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37 #include <stdlib.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38 #include <unistd.h>
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 FILE *
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 rpl_popen (const char *filename, const char *mode)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
42 {
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 /* The mingw popen works fine, and all other platforms have fcntl.
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 The bug of the child clobbering its own file descriptors if stdin
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
45 or stdout was closed in the parent can be worked around by
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
46 opening those two fds as close-on-exec to begin with. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
47 /* Cygwin 1.5.x also has a bug where the popen fd is improperly
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
48 marked close-on-exec, and if the application undoes this, then
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
49 the fd leaks into subsequent popen calls. We could work around
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
50 this by maintaining a list of all fd's opened by popen, and
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
51 temporarily marking them cloexec around the real popen call, but
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
52 we would also have to override pclose, and the bookkeepping seems
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
53 extreme given that cygwin 1.7 no longer has the bug. */
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
54 FILE *result;
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
55 int cloexec0 = fcntl (STDIN_FILENO, F_GETFD);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
56 int cloexec1 = fcntl (STDOUT_FILENO, F_GETFD);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
57 int saved_errno;
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
58
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
59 if (cloexec0 < 0)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
60 {
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
61 if (open ("/dev/null", O_RDONLY) != STDIN_FILENO
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
62 || fcntl (STDIN_FILENO, F_SETFD,
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
63 fcntl (STDIN_FILENO, F_GETFD) | FD_CLOEXEC) == -1)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
64 abort ();
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
65 }
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
66 if (cloexec1 < 0)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
67 {
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
68 if (open ("/dev/null", O_RDONLY) != STDOUT_FILENO
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
69 || fcntl (STDOUT_FILENO, F_SETFD,
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
70 fcntl (STDOUT_FILENO, F_GETFD) | FD_CLOEXEC) == -1)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
71 abort ();
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
72 }
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
73 result = orig_popen (filename, mode);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
74 saved_errno = errno;
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
75 if (cloexec0 < 0)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
76 close (STDIN_FILENO);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
77 if (cloexec1 < 0)
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
78 close (STDOUT_FILENO);
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
79 errno = saved_errno;
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
80 return result;
9e3299dad578 popen: fix cygwin 1.5 bug when stdin closed
Eric Blake <ebb9@byu.net>
parents:
diff changeset
81 }