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 long 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 int pex_win32_wait (struct pex_obj
*, long, 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 a Windows command-line from ARGV. It is the caller's
325 responsibility to free the string returned. */
328 argv_to_cmdline (char *const *argv
)
336 for (i
= 0; argv
[i
]; i
++)
338 /* We quote every last argument. This simplifies the problem;
339 we need only escape embedded double-quotes and immediately
340 preceeding backslash characters. A sequence of backslach characters
341 that is not follwed by a double quote character will not be
343 for (j
= 0; argv
[i
][j
]; j
++)
345 if (argv
[i
][j
] == '"')
347 /* Escape preceeding backslashes. */
348 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
350 /* Escape the qote character. */
354 /* Trailing backslashes also need to be escaped because they will be
355 followed by the terminating quote. */
356 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
359 cmdline_len
+= 3; /* for leading and trailing quotes and space */
361 cmdline
= XNEWVEC (char, cmdline_len
);
363 for (i
= 0; argv
[i
]; i
++)
366 for (j
= 0; argv
[i
][j
]; j
++)
368 if (argv
[i
][j
] == '"')
370 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
376 for (k
= j
- 1; k
>= 0 && argv
[i
][k
] == '\\'; k
--)
385 /* We'll try the passed filename with all the known standard
386 extensions, and then without extension. We try no extension
387 last so that we don't try to run some random extension-less
388 file that might be hanging around. We try both extension
389 and no extension so that we don't need any fancy logic
390 to determine if a file has extension. */
391 static const char *const
401 /* Returns the full path to PROGRAM. If SEARCH is true, look for
402 PROGRAM in each directory in PATH. */
405 find_executable (const char *program
, BOOL search
)
407 char *full_executable
;
410 const char *path
= 0;
411 const char *const *ext
;
413 size_t proglen
= strlen (program
);
414 int has_slash
= (strchr (program
, '/') || strchr (program
, '\\'));
421 path
= getenv ("PATH");
426 for (p
= path
; *p
; p
= q
)
429 while (*q
!= ';' && *q
!= '\0')
431 if ((size_t)(q
- p
) > fe_len
)
436 fe_len
= fe_len
+ 1 + proglen
+ 5 /* space for extension */;
437 full_executable
= XNEWVEC (char, fe_len
);
443 while (*q
!= ';' && *q
!= '\0')
447 memcpy (e
, p
, q
- p
);
456 for (e
= full_executable
; *e
; e
++)
460 /* At this point, e points to the terminating NUL character for
462 for (ext
= std_suffixes
; *ext
; ext
++)
464 /* Remove any current extension. */
466 /* Add the new one. */
467 strcat (full_executable
, *ext
);
469 /* Attempt to open this file. */
470 h
= CreateFile (full_executable
, GENERIC_READ
,
471 FILE_SHARE_READ
| FILE_SHARE_WRITE
,
472 0, OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
473 if (h
!= INVALID_HANDLE_VALUE
)
479 free (full_executable
);
484 return full_executable
;
487 /* Low-level process creation function and helper. */
490 env_compare (const void *a_ptr
, const void *b_ptr
)
497 a
= *(const char **) a_ptr
;
498 b
= *(const char **) b_ptr
;
500 /* a and b will be of the form: VAR=VALUE
501 We compare only the variable name part here using a case-insensitive
502 comparison algorithm. It might appear that in fact strcasecmp () can
503 take the place of this whole function, and indeed it could, save for
504 the fact that it would fail in cases such as comparing A1=foo and
505 A=bar (because 1 is less than = in the ASCII character set).
506 (Environment variables containing no numbers would work in such a
511 c1
= (unsigned char) tolower (*a
++);
512 c2
= (unsigned char) tolower (*b
++);
520 while (c1
== c2
&& c1
!= '\0');
526 win32_spawn (const char *executable
,
529 char *const *env
, /* array of strings of the form: VAR=VALUE */
530 DWORD dwCreationFlags
,
532 LPPROCESS_INFORMATION pi
)
534 char *full_executable
;
537 char *env_block
= NULL
;
539 full_executable
= NULL
;
546 /* Count the number of environment bindings supplied. */
547 for (env_size
= 0; env
[env_size
]; env_size
++)
550 /* Assemble an environment block, if required. This consists of
551 VAR=VALUE strings juxtaposed (with one null character between each
552 pair) and an additional null at the end. */
556 int total_size
= 1; /* 1 is for the final null. */
559 /* Windows needs the members of the block to be sorted by variable
561 env_copy
= (char **) alloca (sizeof (char *) * env_size
);
562 memcpy (env_copy
, env
, sizeof (char *) * env_size
);
563 qsort (env_copy
, env_size
, sizeof (char *), env_compare
);
565 for (var
= 0; var
< env_size
; var
++)
566 total_size
+= strlen (env
[var
]) + 1;
568 env_block
= XNEWVEC (char, total_size
);
570 for (var
= 0; var
< env_size
; var
++)
571 bufptr
= stpcpy (bufptr
, env_copy
[var
]) + 1;
577 full_executable
= find_executable (executable
, search
);
578 if (!full_executable
)
580 cmdline
= argv_to_cmdline (argv
);
584 /* Create the child process. */
585 if (!CreateProcess (full_executable
, cmdline
,
586 /*lpProcessAttributes=*/NULL
,
587 /*lpThreadAttributes=*/NULL
,
588 /*bInheritHandles=*/TRUE
,
591 /*lpCurrentDirectory=*/NULL
,
598 free (full_executable
);
604 CloseHandle (pi
->hThread
);
605 free (full_executable
);
609 return (long) pi
->hProcess
;
617 free (full_executable
);
623 spawn_script (const char *executable
, char *const *argv
,
625 DWORD dwCreationFlags
,
627 LPPROCESS_INFORMATION pi
)
630 int save_errno
= errno
;
631 int fd
= _open (executable
, _O_RDONLY
);
635 char buf
[MAX_PATH
+ 5];
636 int len
= _read (fd
, buf
, sizeof (buf
) - 1);
642 eol
= strchr (buf
, '\n');
643 if (eol
&& strncmp (buf
, "#!", 2) == 0)
646 const char ** avhere
= (const char **) --argv
;
649 while (*--eol
== '\r' || *eol
== ' ' || *eol
== '\t');
650 for (executable1
= buf
+ 2; *executable1
== ' ' || *executable1
== '\t'; executable1
++)
653 backslashify (executable1
);
654 *avhere
= executable1
;
655 #ifndef USE_MINGW_MSYS
656 executable
= strrchr (executable1
, '\\') + 1;
658 executable
= executable1
;
659 pid
= win32_spawn (executable
, TRUE
, argv
, env
,
660 dwCreationFlags
, si
, pi
);
662 if (strchr (executable1
, '\\') == NULL
)
663 pid
= win32_spawn (executable1
, TRUE
, argv
, env
,
664 dwCreationFlags
, si
, pi
);
665 else if (executable1
[0] != '\\')
666 pid
= win32_spawn (executable1
, FALSE
, argv
, env
,
667 dwCreationFlags
, si
, pi
);
670 const char *newex
= mingw_rootify (executable1
);
672 pid
= win32_spawn (newex
, FALSE
, argv
, env
,
673 dwCreationFlags
, si
, pi
);
674 if (executable1
!= newex
)
675 free ((char *) newex
);
678 newex
= msys_rootify (executable1
);
679 if (newex
!= executable1
)
682 pid
= win32_spawn (newex
, FALSE
, argv
, env
,
683 dwCreationFlags
, si
, pi
);
684 free ((char *) newex
);
697 /* Execute a child. */
700 pex_win32_exec_child (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int flags
,
701 const char *executable
, char * const * argv
,
703 int in
, int out
, int errdes
,
704 int toclose ATTRIBUTE_UNUSED
,
710 HANDLE stdout_handle
;
711 HANDLE stderr_handle
;
712 DWORD dwCreationFlags
;
713 OSVERSIONINFO version_info
;
715 PROCESS_INFORMATION pi
;
717 stdin_handle
= INVALID_HANDLE_VALUE
;
718 stdout_handle
= INVALID_HANDLE_VALUE
;
719 stderr_handle
= INVALID_HANDLE_VALUE
;
721 stdin_handle
= (HANDLE
) _get_osfhandle (in
);
722 stdout_handle
= (HANDLE
) _get_osfhandle (out
);
723 if (!(flags
& PEX_STDERR_TO_STDOUT
))
724 stderr_handle
= (HANDLE
) _get_osfhandle (errdes
);
726 stderr_handle
= stdout_handle
;
728 /* Determine the version of Windows we are running on. */
729 version_info
.dwOSVersionInfoSize
= sizeof (version_info
);
730 GetVersionEx (&version_info
);
731 if (version_info
.dwPlatformId
== VER_PLATFORM_WIN32_WINDOWS
)
732 /* On Windows 95/98/ME the CREATE_NO_WINDOW flag is not
733 supported, so we cannot avoid creating a console window. */
737 HANDLE conout_handle
;
739 /* Determine whether or not we have an associated console. */
740 conout_handle
= CreateFile("CONOUT$",
743 /*lpSecurityAttributes=*/NULL
,
745 FILE_ATTRIBUTE_NORMAL
,
746 /*hTemplateFile=*/NULL
);
747 if (conout_handle
== INVALID_HANDLE_VALUE
)
748 /* There is no console associated with this process. Since
749 the child is a console process, the OS would normally
750 create a new console Window for the child. Since we'll be
751 redirecting the child's standard streams, we do not need
752 the console window. */
753 dwCreationFlags
= CREATE_NO_WINDOW
;
756 /* There is a console associated with the process, so the OS
757 will not create a new console. And, if we use
758 CREATE_NO_WINDOW in this situation, the child will have
759 no associated console. Therefore, if the child's
760 standard streams are connected to the console, the output
761 will be discarded. */
762 CloseHandle(conout_handle
);
767 /* Since the child will be a console process, it will, by default,
768 connect standard input/output to its console. However, we want
769 the child to use the handles specifically designated above. In
770 addition, if there is no console (such as when we are running in
771 a Cygwin X window), then we must redirect the child's
772 input/output, as there is no console for the child to use. */
773 memset (&si
, 0, sizeof (si
));
775 si
.dwFlags
= STARTF_USESTDHANDLES
;
776 si
.hStdInput
= stdin_handle
;
777 si
.hStdOutput
= stdout_handle
;
778 si
.hStdError
= stderr_handle
;
780 /* Create the child process. */
781 pid
= win32_spawn (executable
, (flags
& PEX_SEARCH
) != 0,
782 argv
, env
, dwCreationFlags
, &si
, &pi
);
784 pid
= spawn_script (executable
, argv
, env
, dwCreationFlags
,
789 *errmsg
= "CreateProcess";
792 /* Close the standard output and standard error handles in the
794 if (out
!= STDOUT_FILENO
)
795 obj
->funcs
->close (obj
, out
);
796 if (errdes
!= STDERR_FILENO
)
797 obj
->funcs
->close (obj
, errdes
);
802 /* Wait for a child process to complete. MS CRTDLL doesn't return
803 enough information in status to decide if the child exited due to a
804 signal or not, rather it simply returns an integer with the exit
805 code of the child; eg., if the child exited with an abort() call
806 and didn't have a handler for SIGABRT, it simply returns with
807 status == 3. We fix the status code to conform to the usual WIF*
808 macros. Note that WIFSIGNALED will never be true under CRTDLL. */
811 pex_win32_wait (struct pex_obj
*obj ATTRIBUTE_UNUSED
, long pid
,
812 int *status
, struct pex_time
*time
, int done ATTRIBUTE_UNUSED
,
813 const char **errmsg
, int *err
)
819 memset (time
, 0, sizeof *time
);
823 /* FIXME: If done is non-zero, we should probably try to kill the
825 if (WaitForSingleObject (h
, INFINITE
) != WAIT_OBJECT_0
)
829 *errmsg
= "WaitForSingleObject";
833 GetExitCodeProcess (h
, &termstat
);
836 /* A value of 3 indicates that the child caught a signal, but not
837 which one. Since only SIGABRT, SIGFPE and SIGINT do anything, we
842 *status
= (termstat
& 0xff) << 8;
850 pex_win32_pipe (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int *p
,
853 return _pipe (p
, 256, binary
? _O_BINARY
: _O_TEXT
);
856 /* Get a FILE pointer to read from a file descriptor. */
859 pex_win32_fdopenr (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
862 return fdopen (fd
, binary
? "rb" : "r");
866 pex_win32_fdopenw (struct pex_obj
*obj ATTRIBUTE_UNUSED
, int fd
,
869 HANDLE h
= (HANDLE
) _get_osfhandle (fd
);
870 if (h
== INVALID_HANDLE_VALUE
)
872 if (! SetHandleInformation (h
, HANDLE_FLAG_INHERIT
, 0))
874 return fdopen (fd
, binary
? "wb" : "w");
881 main (int argc ATTRIBUTE_UNUSED
, char **argv
)
886 printf ("%ld\n", pex_win32_exec_child (NULL
, PEX_SEARCH
, argv
[0], argv
, NULL
, 0, 0, 1, 2, &errmsg
, &err
));