1 /* Utilities to execute a program in a subprocess (possibly linked by pipes
2 with other subprocesses), and wait for it. Generic Win32 specialization.
3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006
4 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. */
22 #include "pex-common.h"
35 #ifdef HAVE_SYS_WAIT_H
48 /* mingw32 headers may not define the following. */
58 # define WAIT_GRANDCHILD 1
61 #define MINGW_NAME "Minimalist GNU for Windows"
62 #define MINGW_NAME_LEN (sizeof(MINGW_NAME) - 1)
64 extern char *stpcpy (char *dst
, const char *src
);
66 /* Ensure that the executable pathname uses Win32 backslashes. This
67 is not necessary on NT, but on W9x, forward slashes causes
68 failure of spawn* and exec* functions (and probably any function
69 that calls CreateProcess) *iff* the executable pathname (argv[0])
70 is a quoted string. And quoting is necessary in case a pathname
71 contains embedded white space. You can't win. */
73 backslashify (char *s
)
75 while ((s
= strchr (s
, '/')) != NULL
)
80 static int pex_win32_open_read (struct pex_obj
*, const char *, int);
81 static int pex_win32_open_write (struct pex_obj
*, const char *, int);
82 static pid_t
pex_win32_exec_child (struct pex_obj
*, int, const char *,
83 char * const *, char * const *,
85 const char **, int *);
86 static int pex_win32_close (struct pex_obj
*, int);
87 static pid_t
pex_win32_wait (struct pex_obj
*, pid_t
, int *,
88 struct pex_time
*, int, const char **, int *);
89 static int pex_win32_pipe (struct pex_obj
*, int *, int);
90 static FILE *pex_win32_fdopenr (struct pex_obj
*, int, int);
91 static FILE *pex_win32_fdopenw (struct pex_obj
*, int, int);
93 /* The list of functions we pass to the common routines. */
95 const struct pex_funcs funcs
=
108 /* Return a newly initialized pex_obj structure. */
111 pex_init (int flags
, const char *pname
, const char *tempbase
)
113 return pex_init_common (flags
, pname
, tempbase
, &funcs
);
116 /* Open a file for reading. */
119 pex_win32_open_read (struct pex_obj
*obj ATTRIBUTE_UNUSED
, const char *name
,
122 return _open (name
, _O_RDONLY
| (binary
? _O_BINARY
: _O_TEXT
));
125 /* Open a file for writing. */
128 pex_win32_open_write (struct pex_obj
*obj ATTRIBUTE_UNUSED
, const char *name
,
131 /* Note that we can't use O_EXCL here because gcc may have already
132 created the temporary file via make_temp_file. */
134 (_O_WRONLY
| _O_CREAT
| _O_TRUNC
135 | (binary
? _O_BINARY
: _O_TEXT
)),
136 _S_IREAD
| _S_IWRITE
);
142 pex_win32_close (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
)
147 #ifdef USE_MINGW_MSYS
148 static const char *mingw_keys
[] = {"SOFTWARE", "Microsoft", "Windows", "CurrentVersion", "Uninstall", NULL
};
150 /* Tack the executable on the end of a (possibly slash terminated) buffer
151 and convert everything to \. */
153 tack_on_executable (char *buf
, const char *executable
)
155 char *p
= strchr (buf
, '\0');
156 if (p
> buf
&& (p
[-1] == '\\' || p
[-1] == '/'))
158 backslashify (strcat (buf
, executable
));
162 /* Walk down a registry hierarchy until the end. Return the key. */
164 openkey (HKEY hStart
, const char *keys
[])
167 for (hKey
= hStart
; *keys
; keys
++)
171 res
= RegOpenKey (hTmp
, *keys
, &hKey
);
173 if (hTmp
!= HKEY_LOCAL_MACHINE
)
176 if (res
!= ERROR_SUCCESS
)
182 /* Return the "mingw root" as derived from the mingw uninstall information. */
184 mingw_rootify (const char *executable
)
188 char *namebuf
, *foundbuf
;
192 /* Open the uninstall "directory". */
193 hKey
= openkey (HKEY_LOCAL_MACHINE
, mingw_keys
);
199 /* Need to enumerate all of the keys here looking for one the most recent
201 if (RegQueryInfoKey (hKey
, NULL
, NULL
, NULL
, NULL
, &maxlen
, NULL
, NULL
,
202 NULL
, NULL
, NULL
, NULL
) != ERROR_SUCCESS
)
207 namebuf
= XNEWVEC (char, ++maxlen
);
208 foundbuf
= XNEWVEC (char, maxlen
);
210 if (!namebuf
|| !foundbuf
)
220 /* Look through all of the keys for one that begins with Minimal GNU...
221 Try to get the latest version by doing a string compare although that
222 string never really works with version number sorting. */
223 for (i
= 0; RegEnumKey (hKey
, i
, namebuf
, maxlen
) == ERROR_SUCCESS
; i
++)
225 int match
= strcasecmp (namebuf
, MINGW_NAME
);
228 if (match
> 0 && strncasecmp (namebuf
, MINGW_NAME
, MINGW_NAME_LEN
) > 0)
230 if (strcasecmp (namebuf
, foundbuf
) > 0)
231 strcpy (foundbuf
, namebuf
);
235 /* If foundbuf is empty, we didn't find anything. Punt. */
243 /* Open the key that we wanted */
244 res
= RegOpenKey (hKey
, foundbuf
, &hTmp
);
248 /* Don't know why this would fail, but you gotta check */
249 if (res
!= ERROR_SUCCESS
)
253 /* Get the length of the value pointed to by InstallLocation */
254 if (RegQueryValueEx (hTmp
, "InstallLocation", 0, NULL
, NULL
,
255 &maxlen
) != ERROR_SUCCESS
|| maxlen
== 0)
261 /* Allocate space for the install location */
262 foundbuf
= XNEWVEC (char, maxlen
+ strlen (executable
));
269 /* Read the install location into the buffer */
270 res
= RegQueryValueEx (hTmp
, "InstallLocation", 0, NULL
, (LPBYTE
) foundbuf
,
273 if (res
!= ERROR_SUCCESS
)
279 /* Concatenate the install location and the executable, turn all slashes
280 to backslashes, and return that. */
281 return tack_on_executable (foundbuf
, executable
);
284 /* Read the install location of msys from it's installation file and
285 rootify the executable based on that. */
287 msys_rootify (const char *executable
)
290 size_t execlen
= strlen (executable
) + 1;
295 buf
= XNEWVEC (char, bufsize
+ execlen
);
298 res
= GetPrivateProfileString ("InstallSettings", "InstallPath", NULL
,
299 buf
, bufsize
, "msys.ini");
302 if (strlen (buf
) < bufsize
)
315 return tack_on_executable (buf
, executable
);
324 /* Return the number of arguments in an argv array, not including the null
325 terminating argument. */
328 argv_to_argc (char *const *argv
)
330 char *const *i
= argv
;
336 /* Return a Windows command-line from ARGV. It is the caller's
337 responsibility to free the string returned. */
340 argv_to_cmdline (char *const *argv
)
348 for (i
= 0; argv
[i
]; i
++)
350 /* We quote every last argument. This simplifies the problem;
351 we need only escape embedded double-quotes and immediately
352 preceeding backslash characters. A sequence of backslach characters
353 that is not follwed by a double quote character will not be
355 for (j
= 0; argv
[i
][j
]; j
++)
357 if (argv
[i
][j
] == '"')
359 /* Escape preceeding backslashes. */
360 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
362 /* Escape the qote character. */
366 /* Trailing backslashes also need to be escaped because they will be
367 followed by the terminating quote. */
368 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
371 cmdline_len
+= 3; /* for leading and trailing quotes and space */
373 cmdline
= XNEWVEC (char, cmdline_len
);
375 for (i
= 0; argv
[i
]; i
++)
378 for (j
= 0; argv
[i
][j
]; j
++)
380 if (argv
[i
][j
] == '"')
382 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
388 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
397 /* We'll try the passed filename with all the known standard
398 extensions, and then without extension. We try no extension
399 last so that we don't try to run some random extension-less
400 file that might be hanging around. We try both extension
401 and no extension so that we don't need any fancy logic
402 to determine if a file has extension. */
403 static const char *const
413 /* Returns the full path to PROGRAM. If SEARCH is true, look for
414 PROGRAM in each directory in PATH. */
417 find_executable (const char *program
, BOOL search
)
419 char *full_executable
;
422 const char *path
= 0;
423 const char *const *ext
;
425 size_t proglen
= strlen (program
);
426 int has_slash
= (strchr (program
, '/') || strchr (program
, '\\'));
433 path
= getenv ("PATH");
438 for (p
= path
; *p
; p
= q
)
441 while (*q
!= ';' && *q
!= '\0')
443 if ((size_t)(q
- p
) > fe_len
)
448 fe_len
= fe_len
+ 1 + proglen
+ 5 /* space for extension */;
449 full_executable
= XNEWVEC (char, fe_len
);
455 while (*q
!= ';' && *q
!= '\0')
459 memcpy (e
, p
, q
- p
);
468 for (e
= full_executable
; *e
; e
++)
472 /* At this point, e points to the terminating NUL character for
474 for (ext
= std_suffixes
; *ext
; ext
++)
476 /* Remove any current extension. */
478 /* Add the new one. */
479 strcat (full_executable
, *ext
);
481 /* Attempt to open this file. */
482 h
= CreateFile (full_executable
, GENERIC_READ
,
483 FILE_SHARE_READ
| FILE_SHARE_WRITE
,
484 0, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
485 if (h
!= INVALID_HANDLE_VALUE
)
491 free (full_executable
);
496 return full_executable
;
499 /* Low-level process creation function and helper. */
502 env_compare (const void *a_ptr
, const void *b_ptr
)
509 a
= *(const char **) a_ptr
;
510 b
= *(const char **) b_ptr
;
512 /* a and b will be of the form: VAR=VALUE
513 We compare only the variable name part here using a case-insensitive
514 comparison algorithm. It might appear that in fact strcasecmp () can
515 take the place of this whole function, and indeed it could, save for
516 the fact that it would fail in cases such as comparing A1=foo and
517 A=bar (because 1 is less than = in the ASCII character set).
518 (Environment variables containing no numbers would work in such a
523 c1
= (unsigned char) tolower (*a
++);
524 c2
= (unsigned char) tolower (*b
++);
532 while (c1
== c2
&& c1
!= '\0');
537 /* Execute a Windows executable as a child process. This will fail if the
538 * target is not actually an executable, such as if it is a shell script. */
541 win32_spawn (const char *executable
,
544 char *const *env
, /* array of strings of the form: VAR=VALUE */
545 DWORD dwCreationFlags
,
547 LPPROCESS_INFORMATION pi
)
549 char *full_executable
;
552 char *env_block
= NULL
;
554 full_executable
= NULL
;
561 /* Count the number of environment bindings supplied. */
562 for (env_size
= 0; env
[env_size
]; env_size
++)
565 /* Assemble an environment block, if required. This consists of
566 VAR=VALUE strings juxtaposed (with one null character between each
567 pair) and an additional null at the end. */
571 int total_size
= 1; /* 1 is for the final null. */
574 /* Windows needs the members of the block to be sorted by variable
576 env_copy
= (char **) alloca (sizeof (char *) * env_size
);
577 memcpy (env_copy
, env
, sizeof (char *) * env_size
);
578 qsort (env_copy
, env_size
, sizeof (char *), env_compare
);
580 for (var
= 0; var
< env_size
; var
++)
581 total_size
+= strlen (env
[var
]) + 1;
583 env_block
= XNEWVEC (char, total_size
);
585 for (var
= 0; var
< env_size
; var
++)
586 bufptr
= stpcpy (bufptr
, env_copy
[var
]) + 1;
592 full_executable
= find_executable (executable
, search
);
593 if (!full_executable
)
595 cmdline
= argv_to_cmdline (argv
);
599 /* Create the child process. */
600 if (!CreateProcess (full_executable
, cmdline
,
601 /*lpProcessAttributes=*/NULL
,
602 /*lpThreadAttributes=*/NULL
,
603 /*bInheritHandles=*/TRUE
,
606 /*lpCurrentDirectory=*/NULL
,
613 free (full_executable
);
619 CloseHandle (pi
->hThread
);
620 free (full_executable
);
624 return (pid_t
) pi
->hProcess
;
632 free (full_executable
);
637 /* Spawn a script. This simulates the Unix script execution mechanism.
638 This function is called as a fallback if win32_spawn fails. */
641 spawn_script (const char *executable
, char *const *argv
,
643 DWORD dwCreationFlags
,
645 LPPROCESS_INFORMATION pi
)
647 pid_t pid
= (pid_t
) -1;
648 int save_errno
= errno
;
649 int fd
= _open (executable
, _O_RDONLY
);
651 /* Try to open script, check header format, extract interpreter path,
652 and spawn script using that interpretter. */
655 char buf
[MAX_PATH
+ 5];
656 int len
= _read (fd
, buf
, sizeof (buf
) - 1);
662 eol
= strchr (buf
, '\n');
663 if (eol
&& strncmp (buf
, "#!", 2) == 0)
666 /* Header format is OK. */
671 /* Extract interpreter path. */
674 while (*--eol
== '\r' || *eol
== ' ' || *eol
== '\t');
675 for (executable1
= buf
+ 2; *executable1
== ' ' || *executable1
== '\t'; executable1
++)
677 backslashify (executable1
);
679 /* Duplicate argv, prepending the interpreter path. */
680 new_argc
= argv_to_argc (argv
) + 1;
681 avhere
= XNEWVEC (const char *, new_argc
+ 1);
682 *avhere
= executable1
;
683 memcpy (avhere
+ 1, argv
, new_argc
* sizeof(*argv
));
684 argv
= (char *const *)avhere
;
686 /* Spawn the child. */
687 #ifndef USE_MINGW_MSYS
688 executable
= strrchr (executable1
, '\\') + 1;
690 executable
= executable1
;
691 pid
= win32_spawn (executable
, TRUE
, argv
, env
,
692 dwCreationFlags
, si
, pi
);
694 if (strchr (executable1
, '\\') == NULL
)
695 pid
= win32_spawn (executable1
, TRUE
, argv
, env
,
696 dwCreationFlags
, si
, pi
);
697 else if (executable1
[0] != '\\')
698 pid
= win32_spawn (executable1
, FALSE
, argv
, env
,
699 dwCreationFlags
, si
, pi
);
702 const char *newex
= mingw_rootify (executable1
);
704 pid
= win32_spawn (newex
, FALSE
, argv
, env
,
705 dwCreationFlags
, si
, pi
);
706 if (executable1
!= newex
)
707 free ((char *) newex
);
708 if (pid
== (pid_t
) -1)
710 newex
= msys_rootify (executable1
);
711 if (newex
!= executable1
)
714 pid
= win32_spawn (newex
, FALSE
, argv
, env
,
715 dwCreationFlags
, si
, pi
);
716 free ((char *) newex
);
725 if (pid
== (pid_t
) -1)
730 /* Execute a child. */
733 pex_win32_exec_child (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int flags
,
734 const char *executable
, char * const * argv
,
736 int in
, int out
, int errdes
,
737 int toclose ATTRIBUTE_UNUSED
,
743 HANDLE stdout_handle
;
744 HANDLE stderr_handle
;
745 DWORD dwCreationFlags
;
746 OSVERSIONINFO version_info
;
748 PROCESS_INFORMATION pi
;
749 int orig_out
, orig_in
, orig_err
;
750 BOOL separate_stderr
= !(flags
& PEX_STDERR_TO_STDOUT
);
752 /* Ensure we have inheritable descriptors to pass to the child, and close the
753 original descriptors. */
756 if (orig_in
!= STDIN_FILENO
)
760 out
= _dup (orig_out
);
761 if (orig_out
!= STDOUT_FILENO
)
767 errdes
= _dup (orig_err
);
768 if (orig_err
!= STDERR_FILENO
)
772 stdin_handle
= INVALID_HANDLE_VALUE
;
773 stdout_handle
= INVALID_HANDLE_VALUE
;
774 stderr_handle
= INVALID_HANDLE_VALUE
;
776 stdin_handle
= (HANDLE
) _get_osfhandle (in
);
777 stdout_handle
= (HANDLE
) _get_osfhandle (out
);
779 stderr_handle
= (HANDLE
) _get_osfhandle (errdes
);
781 stderr_handle
= stdout_handle
;
783 /* Determine the version of Windows we are running on. */
784 version_info
.dwOSVersionInfoSize
= sizeof (version_info
);
785 GetVersionEx (&version_info
);
786 if (version_info
.dwPlatformId
== VER_PLATFORM_WIN32_WINDOWS
)
787 /* On Windows 95/98/ME the CREATE_NO_WINDOW flag is not
788 supported, so we cannot avoid creating a console window. */
792 HANDLE conout_handle
;
794 /* Determine whether or not we have an associated console. */
795 conout_handle
= CreateFile("CONOUT$",
798 /*lpSecurityAttributes=*/NULL
,
800 FILE_ATTRIBUTE_NORMAL
,
801 /*hTemplateFile=*/NULL
);
802 if (conout_handle
== INVALID_HANDLE_VALUE
)
803 /* There is no console associated with this process. Since
804 the child is a console process, the OS would normally
805 create a new console Window for the child. Since we'll be
806 redirecting the child's standard streams, we do not need
807 the console window. */
808 dwCreationFlags
= CREATE_NO_WINDOW
;
811 /* There is a console associated with the process, so the OS
812 will not create a new console. And, if we use
813 CREATE_NO_WINDOW in this situation, the child will have
814 no associated console. Therefore, if the child's
815 standard streams are connected to the console, the output
816 will be discarded. */
817 CloseHandle(conout_handle
);
822 /* Since the child will be a console process, it will, by default,
823 connect standard input/output to its console. However, we want
824 the child to use the handles specifically designated above. In
825 addition, if there is no console (such as when we are running in
826 a Cygwin X window), then we must redirect the child's
827 input/output, as there is no console for the child to use. */
828 memset (&si
, 0, sizeof (si
));
830 si
.dwFlags
= STARTF_USESTDHANDLES
;
831 si
.hStdInput
= stdin_handle
;
832 si
.hStdOutput
= stdout_handle
;
833 si
.hStdError
= stderr_handle
;
835 /* Create the child process. */
836 pid
= win32_spawn (executable
, (flags
& PEX_SEARCH
) != 0,
837 argv
, env
, dwCreationFlags
, &si
, &pi
);
838 if (pid
== (pid_t
) -1)
839 pid
= spawn_script (executable
, argv
, env
, dwCreationFlags
,
841 if (pid
== (pid_t
) -1)
844 *errmsg
= "CreateProcess";
847 /* Close the standard input, standard output and standard error handles
858 /* Wait for a child process to complete. MS CRTDLL doesn't return
859 enough information in status to decide if the child exited due to a
860 signal or not, rather it simply returns an integer with the exit
861 code of the child; eg., if the child exited with an abort() call
862 and didn't have a handler for SIGABRT, it simply returns with
863 status == 3. We fix the status code to conform to the usual WIF*
864 macros. Note that WIFSIGNALED will never be true under CRTDLL. */
867 pex_win32_wait (struct pex_obj
*obj ATTRIBUTE_UNUSED
, pid_t pid
,
868 int *status
, struct pex_time
*time
, int done ATTRIBUTE_UNUSED
,
869 const char **errmsg
, int *err
)
875 memset (time
, 0, sizeof *time
);
879 /* FIXME: If done is non-zero, we should probably try to kill the
881 if (WaitForSingleObject (h
, INFINITE
) != WAIT_OBJECT_0
)
885 *errmsg
= "WaitForSingleObject";
889 GetExitCodeProcess (h
, &termstat
);
892 /* A value of 3 indicates that the child caught a signal, but not
893 which one. Since only SIGABRT, SIGFPE and SIGINT do anything, we
898 *status
= (termstat
& 0xff) << 8;
906 pex_win32_pipe (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int *p
,
909 return _pipe (p
, 256, (binary
? _O_BINARY
: _O_TEXT
) | _O_NOINHERIT
);
912 /* Get a FILE pointer to read from a file descriptor. */
915 pex_win32_fdopenr (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
918 HANDLE h
= (HANDLE
) _get_osfhandle (fd
);
919 if (h
== INVALID_HANDLE_VALUE
)
921 if (! SetHandleInformation (h
, HANDLE_FLAG_INHERIT
, 0))
923 return fdopen (fd
, binary
? "rb" : "r");
927 pex_win32_fdopenw (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
930 HANDLE h
= (HANDLE
) _get_osfhandle (fd
);
931 if (h
== INVALID_HANDLE_VALUE
)
933 if (! SetHandleInformation (h
, HANDLE_FLAG_INHERIT
, 0))
935 return fdopen (fd
, binary
? "wb" : "w");
942 main (int argc ATTRIBUTE_UNUSED
, char **argv
)
947 printf ("%ld\n", (long) pex_win32_exec_child (NULL
, PEX_SEARCH
, argv
[0], argv
, NULL
, 0, 0, 1, 2, &errmsg
, &err
));