1 /* Utilities to execute a program in a subprocess (possibly linked by pipes
2 with other subprocesses), and wait for it. Generic Unix version
3 (also used for UWIN and VMS).
4 Copyright (C) 1996-2022 Free Software Foundation, Inc.
6 This file is part of the libiberty library.
7 Libiberty is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.
12 Libiberty is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.
17 You should have received a copy of the GNU Library General Public
18 License along with libiberty; see the file COPYING.LIB. If not,
19 write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #include "libiberty.h"
24 #include "pex-common.h"
30 #ifdef NEED_DECLARATION_ERRNO
43 #include <sys/types.h>
48 #ifdef HAVE_SYS_WAIT_H
53 #include <sys/resource.h>
55 #ifdef HAVE_SYS_STAT_H
62 #ifdef vfork /* Autoconf may define this to fork for us. */
63 # define VFORK_STRING "fork"
65 # define VFORK_STRING "vfork"
70 #if defined(VMS) && defined (__LONG_POINTERS)
72 typedef char * __char_ptr32
73 __attribute__ ((mode (SI
)));
76 typedef __char_ptr32
*__char_ptr_char_ptr32
77 __attribute__ ((mode (SI
)));
79 /* Return a 32 bit pointer to an array of 32 bit pointers
80 given a 64 bit pointer to an array of 64 bit pointers. */
82 static __char_ptr_char_ptr32
83 to_ptr32 (char **ptr64
)
86 __char_ptr_char_ptr32 short_argv
;
88 /* Count number of arguments. */
89 for (argc
= 0; ptr64
[argc
] != NULL
; argc
++)
92 /* Reallocate argv with 32 bit pointers. */
93 short_argv
= (__char_ptr_char_ptr32
) decc$malloc
94 (sizeof (__char_ptr32
) * (argc
+ 1));
96 for (argc
= 0; ptr64
[argc
] != NULL
; argc
++)
97 short_argv
[argc
] = (__char_ptr32
) decc$
strdup (ptr64
[argc
]);
99 short_argv
[argc
] = (__char_ptr32
) 0;
104 #define to_ptr32(argv) argv
107 /* File mode to use for private and world-readable files. */
109 #if defined (S_IRUSR) && defined (S_IWUSR) && defined (S_IRGRP) && defined (S_IWGRP) && defined (S_IROTH) && defined (S_IWOTH)
110 #define PUBLIC_MODE \
111 (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)
113 #define PUBLIC_MODE 0666
116 /* Get the exit status of a particular process, and optionally get the
117 time that it took. This is simple if we have wait4, slightly
118 harder if we have waitpid, and is a pain if we only have wait. */
120 static pid_t
pex_wait (struct pex_obj
*, pid_t
, int *, struct pex_time
*);
125 pex_wait (struct pex_obj
*obj ATTRIBUTE_UNUSED
, pid_t pid
, int *status
,
126 struct pex_time
*time
)
133 return waitpid (pid
, status
, 0);
136 ret
= wait4 (pid
, status
, 0, &r
);
140 time
->user_seconds
= r
.ru_utime
.tv_sec
;
141 time
->user_microseconds
= r
.ru_utime
.tv_usec
;
142 time
->system_seconds
= r
.ru_stime
.tv_sec
;
143 time
->system_microseconds
= r
.ru_stime
.tv_usec
;
149 #else /* ! defined (HAVE_WAIT4) */
153 #ifndef HAVE_GETRUSAGE
156 pex_wait (struct pex_obj
*obj ATTRIBUTE_UNUSED
, pid_t pid
, int *status
,
157 struct pex_time
*time
)
160 memset (time
, 0, sizeof (struct pex_time
));
161 return waitpid (pid
, status
, 0);
164 #else /* defined (HAVE_GETRUSAGE) */
167 pex_wait (struct pex_obj
*obj ATTRIBUTE_UNUSED
, pid_t pid
, int *status
,
168 struct pex_time
*time
)
170 struct rusage r1
, r2
;
174 return waitpid (pid
, status
, 0);
176 getrusage (RUSAGE_CHILDREN
, &r1
);
178 ret
= waitpid (pid
, status
, 0);
182 getrusage (RUSAGE_CHILDREN
, &r2
);
184 time
->user_seconds
= r2
.ru_utime
.tv_sec
- r1
.ru_utime
.tv_sec
;
185 time
->user_microseconds
= r2
.ru_utime
.tv_usec
- r1
.ru_utime
.tv_usec
;
186 if (r2
.ru_utime
.tv_usec
< r1
.ru_utime
.tv_usec
)
188 --time
->user_seconds
;
189 time
->user_microseconds
+= 1000000;
192 time
->system_seconds
= r2
.ru_stime
.tv_sec
- r1
.ru_stime
.tv_sec
;
193 time
->system_microseconds
= r2
.ru_stime
.tv_usec
- r1
.ru_stime
.tv_usec
;
194 if (r2
.ru_stime
.tv_usec
< r1
.ru_stime
.tv_usec
)
196 --time
->system_seconds
;
197 time
->system_microseconds
+= 1000000;
203 #endif /* defined (HAVE_GETRUSAGE) */
205 #else /* ! defined (HAVE_WAITPID) */
209 struct status_list
*next
;
212 struct pex_time time
;
216 pex_wait (struct pex_obj
*obj
, pid_t pid
, int *status
, struct pex_time
*time
)
218 struct status_list
**pp
;
220 for (pp
= (struct status_list
**) &obj
->sysdep
;
224 if ((*pp
)->pid
== pid
)
226 struct status_list
*p
;
241 struct status_list
*psl
;
243 #ifdef HAVE_GETRUSAGE
244 struct rusage r1
, r2
;
249 #ifdef HAVE_GETRUSAGE
250 getrusage (RUSAGE_CHILDREN
, &r1
);
252 memset (&pt
, 0, sizeof (struct pex_time
));
256 cpid
= wait (status
);
258 #ifdef HAVE_GETRUSAGE
259 if (time
!= NULL
&& cpid
>= 0)
261 getrusage (RUSAGE_CHILDREN
, &r2
);
263 pt
.user_seconds
= r2
.ru_utime
.tv_sec
- r1
.ru_utime
.tv_sec
;
264 pt
.user_microseconds
= r2
.ru_utime
.tv_usec
- r1
.ru_utime
.tv_usec
;
265 if (pt
.user_microseconds
< 0)
268 pt
.user_microseconds
+= 1000000;
271 pt
.system_seconds
= r2
.ru_stime
.tv_sec
- r1
.ru_stime
.tv_sec
;
272 pt
.system_microseconds
= r2
.ru_stime
.tv_usec
- r1
.ru_stime
.tv_usec
;
273 if (pt
.system_microseconds
< 0)
276 pt
.system_microseconds
+= 1000000;
281 if (cpid
< 0 || cpid
== pid
)
288 psl
= XNEW (struct status_list
);
290 psl
->status
= *status
;
293 psl
->next
= (struct status_list
*) obj
->sysdep
;
294 obj
->sysdep
= (void *) psl
;
298 #endif /* ! defined (HAVE_WAITPID) */
299 #endif /* ! defined (HAVE_WAIT4) */
301 static int pex_unix_open_read (struct pex_obj
*, const char *, int);
302 static int pex_unix_open_write (struct pex_obj
*, const char *, int, int);
303 static pid_t
pex_unix_exec_child (struct pex_obj
*, int, const char *,
304 char * const *, char * const *,
306 const char **, int *);
307 static int pex_unix_close (struct pex_obj
*, int);
308 static int pex_unix_wait (struct pex_obj
*, pid_t
, int *, struct pex_time
*,
309 int, const char **, int *);
310 static int pex_unix_pipe (struct pex_obj
*, int *, int);
311 static FILE *pex_unix_fdopenr (struct pex_obj
*, int, int);
312 static FILE *pex_unix_fdopenw (struct pex_obj
*, int, int);
313 static void pex_unix_cleanup (struct pex_obj
*);
315 /* The list of functions we pass to the common routines. */
317 const struct pex_funcs funcs
=
330 /* Return a newly initialized pex_obj structure. */
333 pex_init (int flags
, const char *pname
, const char *tempbase
)
335 return pex_init_common (flags
, pname
, tempbase
, &funcs
);
338 /* Open a file for reading. */
341 pex_unix_open_read (struct pex_obj
*obj ATTRIBUTE_UNUSED
, const char *name
,
342 int binary ATTRIBUTE_UNUSED
)
344 return open (name
, O_RDONLY
);
347 /* Open a file for writing. */
350 pex_unix_open_write (struct pex_obj
*obj ATTRIBUTE_UNUSED
, const char *name
,
351 int binary ATTRIBUTE_UNUSED
, int append
)
353 /* Note that we can't use O_EXCL here because gcc may have already
354 created the temporary file via make_temp_file. */
355 return open (name
, O_WRONLY
| O_CREAT
356 | (append
? O_APPEND
: O_TRUNC
), PUBLIC_MODE
);
362 pex_unix_close (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
)
367 /* Execute a child. */
369 #if defined(HAVE_SPAWNVE) && defined(HAVE_SPAWNVPE)
370 /* Implementation of pex->exec_child using the Cygwin spawn operation. */
372 /* Subroutine of pex_unix_exec_child. Move OLD_FD to a new file descriptor
373 to be stored in *PNEW_FD, save the flags in *PFLAGS, and arrange for the
374 saved copy to be close-on-exec. Move CHILD_FD into OLD_FD. If CHILD_FD
375 is -1, OLD_FD is to be closed. Return -1 on error. */
378 save_and_install_fd(int *pnew_fd
, int *pflags
, int old_fd
, int child_fd
)
382 flags
= fcntl (old_fd
, F_GETFD
);
384 /* If we could not retrieve the flags, then OLD_FD was not open. */
387 new_fd
= -1, flags
= 0;
388 if (child_fd
>= 0 && dup2 (child_fd
, old_fd
) < 0)
391 /* If we wish to close OLD_FD, just mark it CLOEXEC. */
392 else if (child_fd
== -1)
395 if ((flags
& FD_CLOEXEC
) == 0 && fcntl (old_fd
, F_SETFD
, FD_CLOEXEC
) < 0)
398 /* Otherwise we need to save a copy of OLD_FD before installing CHILD_FD. */
401 #ifdef F_DUPFD_CLOEXEC
402 new_fd
= fcntl (old_fd
, F_DUPFD_CLOEXEC
, 3);
406 /* Prefer F_DUPFD over dup in order to avoid getting a new fd
407 in the range 0-2, right where a new stderr fd might get put. */
408 new_fd
= fcntl (old_fd
, F_DUPFD
, 3);
411 if (fcntl (new_fd
, F_SETFD
, FD_CLOEXEC
) < 0)
414 if (dup2 (child_fd
, old_fd
) < 0)
421 else if (new_fd
!= old_fd
)
427 /* Subroutine of pex_unix_exec_child. Move SAVE_FD back to OLD_FD
428 restoring FLAGS. If SAVE_FD < 0, OLD_FD is to be closed. */
431 restore_fd(int old_fd
, int save_fd
, int flags
)
433 /* For SAVE_FD < 0, all we have to do is restore the
434 "closed-ness" of the original. */
436 return close (old_fd
);
438 /* For SAVE_FD == OLD_FD, all we have to do is restore the
439 original setting of the CLOEXEC flag. */
440 if (save_fd
== old_fd
)
442 if (flags
& FD_CLOEXEC
)
444 return fcntl (old_fd
, F_SETFD
, flags
);
447 /* Otherwise we have to move the descriptor back, restore the flags,
448 and close the saved copy. */
450 if (flags
== FD_CLOEXEC
)
452 if (dup3 (save_fd
, old_fd
, O_CLOEXEC
) < 0)
458 if (dup2 (save_fd
, old_fd
) < 0)
460 if (flags
!= 0 && fcntl (old_fd
, F_SETFD
, flags
) < 0)
463 return close (save_fd
);
467 pex_unix_exec_child (struct pex_obj
*obj ATTRIBUTE_UNUSED
,
468 int flags
, const char *executable
,
469 char * const * argv
, char * const * env
,
470 int in
, int out
, int errdes
, int toclose
,
471 const char **errmsg
, int *err
)
473 int fl_in
= 0, fl_out
= 0, fl_err
= 0, fl_tc
= 0;
474 int save_in
= -1, save_out
= -1, save_err
= -1;
478 if (flags
& PEX_STDERR_TO_STDOUT
)
481 /* We need the three standard file descriptors to be set up as for
482 the child before we perform the spawn. The file descriptors for
483 the parent need to be moved and marked for close-on-exec. */
484 if (in
!= STDIN_FILE_NO
485 && save_and_install_fd (&save_in
, &fl_in
, STDIN_FILE_NO
, in
) < 0)
487 if (out
!= STDOUT_FILE_NO
488 && save_and_install_fd (&save_out
, &fl_out
, STDOUT_FILE_NO
, out
) < 0)
490 if (errdes
!= STDERR_FILE_NO
491 && save_and_install_fd (&save_err
, &fl_err
, STDERR_FILE_NO
, errdes
) < 0)
494 && save_and_install_fd (NULL
, &fl_tc
, toclose
, -1) < 0)
497 /* Now that we've moved the file descriptors for the child into place,
498 close the originals. Be careful not to close any of the standard
499 file descriptors that we just set up. */
502 max
= STDERR_FILE_NO
;
504 max
= STDOUT_FILE_NO
;
511 if (errdes
> max
&& errdes
!= out
)
514 /* If we were not given an environment, use the global environment. */
518 /* Launch the program. If we get EAGAIN (normally out of pid's), try
519 again a few times with increasing backoff times. */
523 typedef const char * const *cc_cp
;
525 if (flags
& PEX_SEARCH
)
526 pid
= spawnvpe (_P_NOWAITO
, executable
, (cc_cp
)argv
, (cc_cp
)env
);
528 pid
= spawnve (_P_NOWAITO
, executable
, (cc_cp
)argv
, (cc_cp
)env
);
535 if (errno
!= EAGAIN
|| ++retries
== 4)
537 sleep (1 << retries
);
540 /* Success. Restore the parent's file descriptors that we saved above. */
542 && restore_fd (toclose
, toclose
, fl_tc
) < 0)
544 if (in
!= STDIN_FILE_NO
545 && restore_fd (STDIN_FILE_NO
, save_in
, fl_in
) < 0)
547 if (out
!= STDOUT_FILE_NO
548 && restore_fd (STDOUT_FILE_NO
, save_out
, fl_out
) < 0)
550 if (errdes
!= STDERR_FILE_NO
551 && restore_fd (STDERR_FILE_NO
, save_err
, fl_err
) < 0)
563 /* Implementation of pex->exec_child using standard vfork + exec. */
566 pex_unix_exec_child (struct pex_obj
*obj
, int flags
, const char *executable
,
567 char * const * argv
, char * const * env
,
568 int in
, int out
, int errdes
,
569 int toclose
, const char **errmsg
, int *err
)
572 /* Tuple to communicate error from child to parent. We can safely
573 transfer string literal pointers as both run with identical
580 volatile int do_pipe
= 0;
581 volatile int pipes
[2]; /* [0]:reader,[1]:writer. */
588 if (pipe2 ((int *)pipes
, O_CLOEXEC
))
591 if (pipe ((int *)pipes
))
595 if (fcntl (pipes
[1], F_SETFD
, FD_CLOEXEC
) == -1)
605 /* We declare these to be volatile to avoid warnings from gcc about
606 them being clobbered by vfork. */
607 volatile int sleep_interval
= 1;
608 volatile int retries
;
610 /* We vfork and then set environ in the child before calling execvp.
611 This clobbers the parent's environ so we need to restore it.
612 It would be nice to use one of the exec* functions that takes an
613 environment as a parameter, but that may have portability
614 issues. It is marked volatile so the child doesn't consider it a
615 dead variable and therefore clobber where ever it is stored. */
616 char **volatile save_environ
= environ
;
618 for (retries
= 0; retries
< 4; ++retries
)
623 sleep (sleep_interval
);
636 *errmsg
= VFORK_STRING
;
642 struct fn_err failed
;
647 if (!failed
.fn
&& in
!= STDIN_FILE_NO
)
649 if (dup2 (in
, STDIN_FILE_NO
) < 0)
650 failed
.fn
= "dup2", failed
.err
= errno
;
651 else if (close (in
) < 0)
652 failed
.fn
= "close", failed
.err
= errno
;
654 if (!failed
.fn
&& out
!= STDOUT_FILE_NO
)
656 if (dup2 (out
, STDOUT_FILE_NO
) < 0)
657 failed
.fn
= "dup2", failed
.err
= errno
;
658 else if (close (out
) < 0)
659 failed
.fn
= "close", failed
.err
= errno
;
661 if (!failed
.fn
&& errdes
!= STDERR_FILE_NO
)
663 if (dup2 (errdes
, STDERR_FILE_NO
) < 0)
664 failed
.fn
= "dup2", failed
.err
= errno
;
665 else if (close (errdes
) < 0)
666 failed
.fn
= "close", failed
.err
= errno
;
668 if (!failed
.fn
&& toclose
>= 0)
670 if (close (toclose
) < 0)
671 failed
.fn
= "close", failed
.err
= errno
;
673 if (!failed
.fn
&& (flags
& PEX_STDERR_TO_STDOUT
) != 0)
675 if (dup2 (STDOUT_FILE_NO
, STDERR_FILE_NO
) < 0)
676 failed
.fn
= "dup2", failed
.err
= errno
;
681 /* NOTE: In a standard vfork implementation this clobbers
682 the parent's copy of environ "too" (in reality there's
683 only one copy). This is ok as we restore it below. */
684 environ
= (char**) env
;
685 if ((flags
& PEX_SEARCH
) != 0)
687 execvp (executable
, to_ptr32 (argv
));
688 failed
.fn
= "execvp", failed
.err
= errno
;
692 execv (executable
, to_ptr32 (argv
));
693 failed
.fn
= "execv", failed
.err
= errno
;
697 /* Something failed, report an error. We don't use stdio
698 routines, because we might be here due to a vfork call. */
702 || write (pipes
[1], &failed
, sizeof (failed
)) != sizeof (failed
))
704 /* The parent will not see our scream above, so write to
706 #define writeerr(s) (retval |= write (STDERR_FILE_NO, s, strlen (s)))
707 writeerr (obj
->pname
);
708 writeerr (": error trying to exec '");
709 writeerr (executable
);
711 writeerr (failed
.fn
);
713 writeerr (xstrerror (failed
.err
));
718 /* Exit with -2 if the error output failed, too. */
719 _exit (retval
< 0 ? -2 : -1);
725 /* Parent process. */
727 /* Restore environ. Note that the parent either doesn't run
728 until the child execs/exits (standard vfork behaviour), or
729 if it does run then vfork is behaving more like fork. In
730 either case we needn't worry about clobbering the child's
732 environ
= save_environ
;
734 struct fn_err failed
;
739 ssize_t len
= read (pipes
[0], &failed
, sizeof (failed
));
745 if (!failed
.fn
&& in
!= STDIN_FILE_NO
)
747 failed
.fn
= "close", failed
.err
= errno
;
748 if (!failed
.fn
&& out
!= STDOUT_FILE_NO
)
750 failed
.fn
= "close", failed
.err
= errno
;
751 if (!failed
.fn
&& errdes
!= STDERR_FILE_NO
)
752 if (close (errdes
) < 0)
753 failed
.fn
= "close", failed
.err
= errno
;
767 /* Wait for a child process to complete. */
770 pex_unix_wait (struct pex_obj
*obj
, pid_t pid
, int *status
,
771 struct pex_time
*time
, int done
, const char **errmsg
,
774 /* If we are cleaning up when the caller didn't retrieve process
775 status for some reason, encourage the process to go away. */
779 if (pex_wait (obj
, pid
, status
, time
) < 0)
792 pex_unix_pipe (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int *p
,
793 int binary ATTRIBUTE_UNUSED
)
798 /* Get a FILE pointer to read from a file descriptor. */
801 pex_unix_fdopenr (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
802 int binary ATTRIBUTE_UNUSED
)
804 return fdopen (fd
, "r");
808 pex_unix_fdopenw (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
809 int binary ATTRIBUTE_UNUSED
)
811 if (fcntl (fd
, F_SETFD
, FD_CLOEXEC
) < 0)
813 return fdopen (fd
, "w");
817 pex_unix_cleanup (struct pex_obj
*obj ATTRIBUTE_UNUSED
)
819 #if !defined (HAVE_WAIT4) && !defined (HAVE_WAITPID)
820 while (obj
->sysdep
!= NULL
)
822 struct status_list
*this;
823 struct status_list
*next
;
825 this = (struct status_list
*) obj
->sysdep
;
828 obj
->sysdep
= (void *) next
;