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)
218 /* Look through all of the keys for one that begins with Minimal GNU...
219 Try to get the latest version by doing a string compare although that
220 string never really works with version number sorting. */
221 for (i = 0; RegEnumKey (hKey, i, namebuf, maxlen) == ERROR_SUCCESS; i++)
223 int match = strcasecmp (namebuf, MINGW_NAME);
226 if (match > 0 && strncasecmp (namebuf, MINGW_NAME, MINGW_NAME_LEN) > 0)
228 if (strcasecmp (namebuf, foundbuf) > 0)
229 strcpy (foundbuf, namebuf);
233 /* If foundbuf is empty, we didn't find anything. Punt. */
241 /* Open the key that we wanted */
242 res = RegOpenKey (hKey, foundbuf, &hTmp);
246 /* Don't know why this would fail, but you gotta check */
247 if (res != ERROR_SUCCESS)
251 /* Get the length of the value pointed to by InstallLocation */
252 if (RegQueryValueEx (hTmp, "InstallLocation", 0, NULL, NULL,
253 &maxlen) != ERROR_SUCCESS || maxlen == 0)
259 /* Allocate space for the install location */
260 foundbuf = XNEWVEC (char, maxlen + strlen (executable));
267 /* Read the install location into the buffer */
268 res = RegQueryValueEx (hTmp, "InstallLocation", 0, NULL, (LPBYTE) foundbuf,
271 if (res != ERROR_SUCCESS)
277 /* Concatenate the install location and the executable, turn all slashes
278 to backslashes, and return that. */
279 return tack_on_executable (foundbuf, executable);
282 /* Read the install location of msys from it's installation file and
283 rootify the executable based on that. */
285 msys_rootify (const char *executable)
288 size_t execlen = strlen (executable) + 1;
293 buf = XNEWVEC (char, bufsize + execlen);
296 res = GetPrivateProfileString ("InstallSettings", "InstallPath", NULL,
297 buf, bufsize, "msys.ini");
300 if (strlen (buf) < bufsize)
313 return tack_on_executable (buf, executable);
321 /* Return the number of arguments in an argv array, not including the null
322 terminating argument. */
325 argv_to_argc (char *const *argv)
327 char *const *i = argv;
333 /* Return a Windows command-line from ARGV. It is the caller's
334 responsibility to free the string returned. */
337 argv_to_cmdline (char *const *argv)
346 for (i = 0; argv[i]; i++)
348 /* We only quote arguments that contain spaces, \t or " characters to
349 prevent wasting 2 chars per argument of the CreateProcess 32k char
350 limit. We need only escape embedded double-quotes and immediately
351 preceeding backslash characters. A sequence of backslach characters
352 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] == ' ' || argv[i][j] == '\t' || argv[i][j] == '"')
362 if (argv[i][j] == '"')
364 /* Escape preceeding backslashes. */
365 for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
367 /* Escape the qote character. */
371 /* Trailing backslashes also need to be escaped because they will be
372 followed by the terminating quote. */
375 for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
379 /* for leading and trailing quotes and space */
380 cmdline_len += needs_quotes * 2 + 1;
382 cmdline = XNEWVEC (char, cmdline_len);
384 for (i = 0; argv[i]; i++)
387 for (j = 0; argv[i][j]; j++)
389 if (argv[i][j] == ' ' || argv[i][j] == '\t' || argv[i][j] == '"')
400 for (j = 0; argv[i][j]; j++)
402 if (argv[i][j] == '"')
404 for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
412 for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
422 /* We'll try the passed filename with all the known standard
423 extensions, and then without extension. We try no extension
424 last so that we don't try to run some random extension-less
425 file that might be hanging around. We try both extension
426 and no extension so that we don't need any fancy logic
427 to determine if a file has extension. */
428 static const char *const
438 /* Returns the full path to PROGRAM. If SEARCH is true, look for
439 PROGRAM in each directory in PATH. */
442 find_executable (const char *program, BOOL search)
444 char *full_executable;
447 const char *path = 0;
448 const char *const *ext;
450 size_t proglen = strlen (program);
451 int has_slash = (strchr (program, '/') || strchr (program, '\\'));
458 path = getenv ("PATH");
463 for (p = path; *p; p = q)
466 while (*q != ';' && *q != '\0')
468 if ((size_t)(q - p) > fe_len)
473 fe_len = fe_len + 1 + proglen + 5 /* space for extension */;
474 full_executable = XNEWVEC (char, fe_len);
480 while (*q != ';' && *q != '\0')
484 memcpy (e, p, q - p);
493 for (e = full_executable; *e; e++)
497 /* At this point, e points to the terminating NUL character for
499 for (ext = std_suffixes; *ext; ext++)
501 /* Remove any current extension. */
503 /* Add the new one. */
504 strcat (full_executable, *ext);
506 /* Attempt to open this file. */
507 h = CreateFile (full_executable, GENERIC_READ,
508 FILE_SHARE_READ | FILE_SHARE_WRITE,
509 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
510 if (h != INVALID_HANDLE_VALUE)
516 free (full_executable);
521 return full_executable;
524 /* Low-level process creation function and helper. */
527 env_compare (const void *a_ptr, const void *b_ptr)
534 a = *(const char **) a_ptr;
535 b = *(const char **) b_ptr;
537 /* a and b will be of the form: VAR=VALUE
538 We compare only the variable name part here using a case-insensitive
539 comparison algorithm. It might appear that in fact strcasecmp () can
540 take the place of this whole function, and indeed it could, save for
541 the fact that it would fail in cases such as comparing A1=foo and
542 A=bar (because 1 is less than = in the ASCII character set).
543 (Environment variables containing no numbers would work in such a
548 c1 = (unsigned char) tolower (*a++);
549 c2 = (unsigned char) tolower (*b++);
557 while (c1 == c2 && c1 != '\0');
562 /* Execute a Windows executable as a child process. This will fail if the
563 * target is not actually an executable, such as if it is a shell script. */
566 win32_spawn (const char *executable,
569 char *const *env, /* array of strings of the form: VAR=VALUE */
570 DWORD dwCreationFlags,
572 LPPROCESS_INFORMATION pi)
574 char *full_executable;
577 char *env_block = NULL;
579 full_executable = NULL;
586 /* Count the number of environment bindings supplied. */
587 for (env_size = 0; env[env_size]; env_size++)
590 /* Assemble an environment block, if required. This consists of
591 VAR=VALUE strings juxtaposed (with one null character between each
592 pair) and an additional null at the end. */
596 int total_size = 1; /* 1 is for the final null. */
599 /* Windows needs the members of the block to be sorted by variable
601 env_copy = (char **) alloca (sizeof (char *) * env_size);
602 memcpy (env_copy, env, sizeof (char *) * env_size);
603 qsort (env_copy, env_size, sizeof (char *), env_compare);
605 for (var = 0; var < env_size; var++)
606 total_size += strlen (env[var]) + 1;
608 env_block = XNEWVEC (char, total_size);
610 for (var = 0; var < env_size; var++)
611 bufptr = stpcpy (bufptr, env_copy[var]) + 1;
617 full_executable = find_executable (executable, search);
618 if (!full_executable)
620 cmdline = argv_to_cmdline (argv);
624 /* Create the child process. */
625 if (!CreateProcess (full_executable, cmdline,
626 /*lpProcessAttributes=*/NULL,
627 /*lpThreadAttributes=*/NULL,
628 /*bInheritHandles=*/TRUE,
631 /*lpCurrentDirectory=*/NULL,
637 free (full_executable);
643 CloseHandle (pi->hThread);
644 free (full_executable);
647 return (pid_t) pi->hProcess;
652 free (full_executable);
657 /* Spawn a script. This simulates the Unix script execution mechanism.
658 This function is called as a fallback if win32_spawn fails. */
661 spawn_script (const char *executable, char *const *argv,
663 DWORD dwCreationFlags,
665 LPPROCESS_INFORMATION pi)
667 pid_t pid = (pid_t) -1;
668 int save_errno = errno;
669 int fd = _open (executable, _O_RDONLY);
671 /* Try to open script, check header format, extract interpreter path,
672 and spawn script using that interpretter. */
675 char buf[MAX_PATH + 5];
676 int len = _read (fd, buf, sizeof (buf) - 1);
682 eol = strchr (buf, '\n');
683 if (eol && strncmp (buf, "#!", 2) == 0)
686 /* Header format is OK. */
691 /* Extract interpreter path. */
694 while (*--eol == '\r' || *eol == ' ' || *eol == '\t');
695 for (executable1 = buf + 2; *executable1 == ' ' || *executable1 == '\t'; executable1++)
697 backslashify (executable1);
699 /* Duplicate argv, prepending the interpreter path. */
700 new_argc = argv_to_argc (argv) + 1;
701 avhere = XNEWVEC (const char *, new_argc + 1);
702 *avhere = executable1;
703 memcpy (avhere + 1, argv, new_argc * sizeof(*argv));
704 argv = (char *const *)avhere;
706 /* Spawn the child. */
707 #ifndef USE_MINGW_MSYS
708 executable = strrchr (executable1, '\\') + 1;
710 executable = executable1;
711 pid = win32_spawn (executable, TRUE, argv, env,
712 dwCreationFlags, si, pi);
714 if (strchr (executable1, '\\') == NULL)
715 pid = win32_spawn (executable1, TRUE, argv, env,
716 dwCreationFlags, si, pi);
717 else if (executable1[0] != '\\')
718 pid = win32_spawn (executable1, FALSE, argv, env,
719 dwCreationFlags, si, pi);
722 const char *newex = mingw_rootify (executable1);
724 pid = win32_spawn (newex, FALSE, argv, env,
725 dwCreationFlags, si, pi);
726 if (executable1 != newex)
727 free ((char *) newex);
728 if (pid == (pid_t) -1)
730 newex = msys_rootify (executable1);
731 if (newex != executable1)
734 pid = win32_spawn (newex, FALSE, argv, env,
735 dwCreationFlags, si, pi);
736 free ((char *) newex);
745 if (pid == (pid_t) -1)
750 /* Execute a child. */
753 pex_win32_exec_child (struct pex_obj *obj ATTRIBUTE_UNUSED, int flags,
754 const char *executable, char * const * argv,
756 int in, int out, int errdes,
757 int toclose ATTRIBUTE_UNUSED,
763 HANDLE stdout_handle;
764 HANDLE stderr_handle;
765 DWORD dwCreationFlags;
766 OSVERSIONINFO version_info;
768 PROCESS_INFORMATION pi;
769 int orig_out, orig_in, orig_err;
770 BOOL separate_stderr = !(flags & PEX_STDERR_TO_STDOUT);
772 /* Ensure we have inheritable descriptors to pass to the child. */
777 out = _dup (orig_out);
782 errdes = _dup (orig_err);
785 stdin_handle = INVALID_HANDLE_VALUE;
786 stdout_handle = INVALID_HANDLE_VALUE;
787 stderr_handle = INVALID_HANDLE_VALUE;
789 stdin_handle = (HANDLE) _get_osfhandle (in);
790 stdout_handle = (HANDLE) _get_osfhandle (out);
792 stderr_handle = (HANDLE) _get_osfhandle (errdes);
794 stderr_handle = stdout_handle;
796 /* Determine the version of Windows we are running on. */
797 version_info.dwOSVersionInfoSize = sizeof (version_info);
798 GetVersionEx (&version_info);
799 if (version_info.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)
800 /* On Windows 95/98/ME the CREATE_NO_WINDOW flag is not
801 supported, so we cannot avoid creating a console window. */
805 HANDLE conout_handle;
807 /* Determine whether or not we have an associated console. */
808 conout_handle = CreateFile("CONOUT$",
811 /*lpSecurityAttributes=*/NULL,
813 FILE_ATTRIBUTE_NORMAL,
814 /*hTemplateFile=*/NULL);
815 if (conout_handle == INVALID_HANDLE_VALUE)
816 /* There is no console associated with this process. Since
817 the child is a console process, the OS would normally
818 create a new console Window for the child. Since we'll be
819 redirecting the child's standard streams, we do not need
820 the console window. */
821 dwCreationFlags = CREATE_NO_WINDOW;
824 /* There is a console associated with the process, so the OS
825 will not create a new console. And, if we use
826 CREATE_NO_WINDOW in this situation, the child will have
827 no associated console. Therefore, if the child's
828 standard streams are connected to the console, the output
829 will be discarded. */
830 CloseHandle(conout_handle);
835 /* Since the child will be a console process, it will, by default,
836 connect standard input/output to its console. However, we want
837 the child to use the handles specifically designated above. In
838 addition, if there is no console (such as when we are running in
839 a Cygwin X window), then we must redirect the child's
840 input/output, as there is no console for the child to use. */
841 memset (&si, 0, sizeof (si));
843 si.dwFlags = STARTF_USESTDHANDLES;
844 si.hStdInput = stdin_handle;
845 si.hStdOutput = stdout_handle;
846 si.hStdError = stderr_handle;
848 /* Create the child process. */
849 pid = win32_spawn (executable, (flags & PEX_SEARCH) != 0,
850 argv, env, dwCreationFlags, &si, &pi);
851 if (pid == (pid_t) -1)
852 pid = spawn_script (executable, argv, env, dwCreationFlags,
854 if (pid == (pid_t) -1)
857 *errmsg = "CreateProcess";
860 /* If the child was created successfully, close the original file
861 descriptors. If the process creation fails, these are closed by
862 pex_run_in_environment instead. We must not close them twice as
863 that seems to cause a Windows exception. */
865 if (pid != (pid_t) -1)
867 if (orig_in != STDIN_FILENO)
869 if (orig_out != STDOUT_FILENO)
872 && orig_err != STDERR_FILENO)
876 /* Close the standard input, standard output and standard error handles
887 /* Wait for a child process to complete. MS CRTDLL doesn't return
888 enough information in status to decide if the child exited due to a
889 signal or not, rather it simply returns an integer with the exit
890 code of the child; eg., if the child exited with an abort() call
891 and didn't have a handler for SIGABRT, it simply returns with
892 status == 3. We fix the status code to conform to the usual WIF*
893 macros. Note that WIFSIGNALED will never be true under CRTDLL. */
896 pex_win32_wait (struct pex_obj *obj ATTRIBUTE_UNUSED, pid_t pid,
897 int *status, struct pex_time *time, int done ATTRIBUTE_UNUSED,
898 const char **errmsg, int *err)
904 memset (time, 0, sizeof *time);
908 /* FIXME: If done is non-zero, we should probably try to kill the
910 if (WaitForSingleObject (h, INFINITE) != WAIT_OBJECT_0)
914 *errmsg = "WaitForSingleObject";
918 GetExitCodeProcess (h, &termstat);
921 /* A value of 3 indicates that the child caught a signal, but not
922 which one. Since only SIGABRT, SIGFPE and SIGINT do anything, we
927 *status = (termstat & 0xff) << 8;
935 pex_win32_pipe (struct pex_obj *obj ATTRIBUTE_UNUSED, int *p,
938 return _pipe (p, 256, (binary ? _O_BINARY : _O_TEXT) | _O_NOINHERIT);
941 /* Get a FILE pointer to read from a file descriptor. */
944 pex_win32_fdopenr (struct pex_obj *obj ATTRIBUTE_UNUSED, int fd,
947 HANDLE h = (HANDLE) _get_osfhandle (fd);
948 if (h == INVALID_HANDLE_VALUE)
950 if (! SetHandleInformation (h, HANDLE_FLAG_INHERIT, 0))
952 return fdopen (fd, binary ? "rb" : "r");
956 pex_win32_fdopenw (struct pex_obj *obj ATTRIBUTE_UNUSED, int fd,
959 HANDLE h = (HANDLE) _get_osfhandle (fd);
960 if (h == INVALID_HANDLE_VALUE)
962 if (! SetHandleInformation (h, HANDLE_FLAG_INHERIT, 0))
964 return fdopen (fd, binary ? "wb" : "w");
971 main (int argc ATTRIBUTE_UNUSED, char **argv)
976 printf ("%ld\n", (long) pex_win32_exec_child (NULL, PEX_SEARCH, argv[0], argv, NULL, 0, 0, 1, 2, &errmsg, &err));