binutils-gdb/libiberty/pex-win32.c

796 lines
20 KiB
C
Raw Normal View History

2003-01-24 22:31:35 +01:00
/* Utilities to execute a program in a subprocess (possibly linked by pipes
with other subprocesses), and wait for it. Generic Win32 specialization.
2005-03-28 07:07:08 +02:00
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004, 2005
2003-01-24 22:31:35 +01:00
Free Software Foundation, Inc.
This file is part of the libiberty library.
Libiberty is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
Libiberty is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with libiberty; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
Boston, MA 02110-1301, USA. */
2003-01-24 22:31:35 +01:00
#include "pex-common.h"
2005-09-15 03:04:05 +02:00
#include <windows.h>
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
2003-01-24 22:31:35 +01:00
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
#include <process.h>
#include <io.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/stat.h>
2006-04-01 01:01:16 +02:00
#include <errno.h>
2003-01-24 22:31:35 +01:00
/* mingw32 headers may not define the following. */
#ifndef _P_WAIT
# define _P_WAIT 0
# define _P_NOWAIT 1
# define _P_OVERLAY 2
# define _P_NOWAITO 3
# define _P_DETACH 4
# define WAIT_CHILD 0
# define WAIT_GRANDCHILD 1
#endif
2005-09-15 03:04:05 +02:00
#define MINGW_NAME "Minimalist GNU for Windows"
#define MINGW_NAME_LEN (sizeof(MINGW_NAME) - 1)
/* Ensure that the executable pathname uses Win32 backslashes. This
is not necessary on NT, but on W9x, forward slashes causes
failure of spawn* and exec* functions (and probably any function
that calls CreateProcess) *iff* the executable pathname (argv[0])
is a quoted string. And quoting is necessary in case a pathname
contains embedded white space. You can't win. */
static void
backslashify (char *s)
{
while ((s = strchr (s, '/')) != NULL)
*s = '\\';
return;
}
static int pex_win32_open_read (struct pex_obj *, const char *, int);
static int pex_win32_open_write (struct pex_obj *, const char *, int);
static long pex_win32_exec_child (struct pex_obj *, int, const char *,
char * const *, int, int, int,
const char **, int *);
static int pex_win32_close (struct pex_obj *, int);
static int pex_win32_wait (struct pex_obj *, long, int *,
struct pex_time *, int, const char **, int *);
static int pex_win32_pipe (struct pex_obj *, int *, int);
static FILE *pex_win32_fdopenr (struct pex_obj *, int, int);
2006-04-12 20:42:01 +02:00
static FILE *pex_win32_fdopenw (struct pex_obj *, int, int);
/* The list of functions we pass to the common routines. */
const struct pex_funcs funcs =
2003-01-24 22:31:35 +01:00
{
pex_win32_open_read,
pex_win32_open_write,
pex_win32_exec_child,
pex_win32_close,
pex_win32_wait,
pex_win32_pipe,
pex_win32_fdopenr,
2006-04-12 20:42:01 +02:00
pex_win32_fdopenw,
NULL /* cleanup */
};
/* Return a newly initialized pex_obj structure. */
struct pex_obj *
pex_init (int flags, const char *pname, const char *tempbase)
{
return pex_init_common (flags, pname, tempbase, &funcs);
}
/* Open a file for reading. */
static int
pex_win32_open_read (struct pex_obj *obj ATTRIBUTE_UNUSED, const char *name,
int binary)
{
return _open (name, _O_RDONLY | (binary ? _O_BINARY : _O_TEXT));
}
/* Open a file for writing. */
static int
pex_win32_open_write (struct pex_obj *obj ATTRIBUTE_UNUSED, const char *name,
int binary)
{
/* Note that we can't use O_EXCL here because gcc may have already
created the temporary file via make_temp_file. */
return _open (name,
(_O_WRONLY | _O_CREAT | _O_TRUNC
| (binary ? _O_BINARY : _O_TEXT)),
_S_IREAD | _S_IWRITE);
}
/* Close a file. */
static int
pex_win32_close (struct pex_obj *obj ATTRIBUTE_UNUSED, int fd)
{
return _close (fd);
}
2005-09-15 03:04:05 +02:00
#ifdef USE_MINGW_MSYS
static const char *mingw_keys[] = {"SOFTWARE", "Microsoft", "Windows", "CurrentVersion", "Uninstall", NULL};
/* Tack the executable on the end of a (possibly slash terminated) buffer
and convert everything to \. */
static const char *
tack_on_executable (char *buf, const char *executable)
{
char *p = strchr (buf, '\0');
if (p > buf && (p[-1] == '\\' || p[-1] == '/'))
p[-1] = '\0';
backslashify (strcat (buf, executable));
return buf;
}
/* Walk down a registry hierarchy until the end. Return the key. */
static HKEY
openkey (HKEY hStart, const char *keys[])
{
HKEY hKey, hTmp;
for (hKey = hStart; *keys; keys++)
{
LONG res;
hTmp = hKey;
res = RegOpenKey (hTmp, *keys, &hKey);
if (hTmp != HKEY_LOCAL_MACHINE)
RegCloseKey (hTmp);
if (res != ERROR_SUCCESS)
return NULL;
}
return hKey;
}
/* Return the "mingw root" as derived from the mingw uninstall information. */
static const char *
mingw_rootify (const char *executable)
{
HKEY hKey, hTmp;
DWORD maxlen;
char *namebuf, *foundbuf;
DWORD i;
LONG res;
/* Open the uninstall "directory". */
hKey = openkey (HKEY_LOCAL_MACHINE, mingw_keys);
/* Not found. */
if (!hKey)
return executable;
/* Need to enumerate all of the keys here looking for one the most recent
one for MinGW. */
if (RegQueryInfoKey (hKey, NULL, NULL, NULL, NULL, &maxlen, NULL, NULL,
NULL, NULL, NULL, NULL) != ERROR_SUCCESS)
{
RegCloseKey (hKey);
return executable;
}
namebuf = XNEWVEC (char, ++maxlen);
foundbuf = XNEWVEC (char, maxlen);
foundbuf[0] = '\0';
if (!namebuf || !foundbuf)
{
RegCloseKey (hKey);
if (namebuf)
free (namebuf);
if (foundbuf)
free (foundbuf);
return executable;
}
/* Look through all of the keys for one that begins with Minimal GNU...
Try to get the latest version by doing a string compare although that
string never really works with version number sorting. */
for (i = 0; RegEnumKey (hKey, i, namebuf, maxlen) == ERROR_SUCCESS; i++)
{
int match = strcasecmp (namebuf, MINGW_NAME);
if (match < 0)
continue;
if (match > 0 && strncasecmp (namebuf, MINGW_NAME, MINGW_NAME_LEN) > 0)
continue;
if (strcasecmp (namebuf, foundbuf) > 0)
strcpy (foundbuf, namebuf);
}
free (namebuf);
/* If foundbuf is empty, we didn't find anything. Punt. */
if (!foundbuf[0])
{
free (foundbuf);
RegCloseKey (hKey);
return executable;
}
/* Open the key that we wanted */
res = RegOpenKey (hKey, foundbuf, &hTmp);
RegCloseKey (hKey);
free (foundbuf);
/* Don't know why this would fail, but you gotta check */
if (res != ERROR_SUCCESS)
return executable;
maxlen = 0;
/* Get the length of the value pointed to by InstallLocation */
if (RegQueryValueEx (hTmp, "InstallLocation", 0, NULL, NULL,
&maxlen) != ERROR_SUCCESS || maxlen == 0)
{
RegCloseKey (hTmp);
return executable;
}
/* Allocate space for the install location */
foundbuf = XNEWVEC (char, maxlen + strlen (executable));
if (!foundbuf)
{
free (foundbuf);
RegCloseKey (hTmp);
}
/* Read the install location into the buffer */
res = RegQueryValueEx (hTmp, "InstallLocation", 0, NULL, (LPBYTE) foundbuf,
&maxlen);
RegCloseKey (hTmp);
if (res != ERROR_SUCCESS)
{
free (foundbuf);
return executable;
}
/* Concatenate the install location and the executable, turn all slashes
to backslashes, and return that. */
return tack_on_executable (foundbuf, executable);
}
/* Read the install location of msys from it's installation file and
rootify the executable based on that. */
static const char *
msys_rootify (const char *executable)
{
size_t bufsize = 64;
size_t execlen = strlen (executable) + 1;
char *buf;
DWORD res = 0;
for (;;)
{
buf = XNEWVEC (char, bufsize + execlen);
if (!buf)
break;
res = GetPrivateProfileString ("InstallSettings", "InstallPath", NULL,
buf, bufsize, "msys.ini");
if (!res)
break;
if (strlen (buf) < bufsize)
break;
res = 0;
free (buf);
bufsize *= 2;
if (bufsize > 65536)
{
buf = NULL;
break;
}
}
if (res)
return tack_on_executable (buf, executable);
/* failed */
if (buf)
free (buf);
return executable;
}
#endif
2006-04-01 01:01:16 +02:00
/* Return a Windows command-line from ARGV. It is the caller's
responsibility to free the string returned. */
static char *
argv_to_cmdline (char *const *argv)
{
char *cmdline;
char *p;
size_t cmdline_len;
int i, j, k;
cmdline_len = 0;
for (i = 0; argv[i]; i++)
{
/* We quote every last argument. This simplifies the problem;
we need only escape embedded double-quotes and immediately
preceeding backslash characters. A sequence of backslach characters
that is not follwed by a double quote character will not be
escaped. */
for (j = 0; argv[i][j]; j++)
{
if (argv[i][j] == '"')
{
/* Escape preceeding backslashes. */
for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
cmdline_len++;
/* Escape the qote character. */
cmdline_len++;
}
}
/* Trailing backslashes also need to be escaped because they will be
followed by the terminating quote. */
for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
cmdline_len++;
cmdline_len += j;
cmdline_len += 3; /* for leading and trailing quotes and space */
}
cmdline = xmalloc (cmdline_len);
p = cmdline;
for (i = 0; argv[i]; i++)
{
*p++ = '"';
for (j = 0; argv[i][j]; j++)
{
if (argv[i][j] == '"')
{
for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
*p++ = '\\';
*p++ = '\\';
}
*p++ = argv[i][j];
}
for (k = j - 1; k >= 0 && argv[i][k] == '\\'; k--)
*p++ = '\\';
*p++ = '"';
*p++ = ' ';
}
p[-1] = '\0';
return cmdline;
}
static const char *const
std_suffixes[] = {
".com",
".exe",
".bat",
".cmd",
0
};
static const char *const
no_suffixes[] = {
"",
0
};
/* Returns the full path to PROGRAM. If SEARCH is true, look for
PROGRAM in each directory in PATH. */
static char *
find_executable (const char *program, BOOL search)
{
char *full_executable;
char *e;
size_t fe_len;
const char *path = 0;
const char *const *ext;
const char *p, *q;
size_t proglen = strlen (program);
int has_extension = !!strchr (program, '.');
int has_slash = (strchr (program, '/') || strchr (program, '\\'));
HANDLE h;
if (has_slash)
search = FALSE;
if (search)
path = getenv ("PATH");
if (!path)
path = "";
fe_len = 0;
for (p = path; *p; p = q)
{
q = p;
while (*q != ';' && *q != '\0')
q++;
if ((size_t)(q - p) > fe_len)
fe_len = q - p;
if (*q == ';')
q++;
}
fe_len = fe_len + 1 + proglen + (has_extension ? 1 : 5);
full_executable = xmalloc (fe_len);
p = path;
do
{
q = p;
while (*q != ';' && *q != '\0')
q++;
e = full_executable;
memcpy (e, p, q - p);
e += (q - p);
if (q - p)
*e++ = '\\';
strcpy (e, program);
if (*q == ';')
q++;
for (e = full_executable; *e; e++)
if (*e == '/')
*e = '\\';
/* At this point, e points to the terminating NUL character for
full_executable. */
for (ext = has_extension ? no_suffixes : std_suffixes; *ext; ext++)
{
/* Remove any current extension. */
*e = '\0';
/* Add the new one. */
strcat (full_executable, *ext);
/* Attempt to open this file. */
h = CreateFile (full_executable, GENERIC_READ,
FILE_SHARE_READ | FILE_SHARE_WRITE,
0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
if (h != INVALID_HANDLE_VALUE)
goto found;
}
p = q;
}
while (*p);
free (full_executable);
return 0;
found:
CloseHandle (h);
return full_executable;
}
/* Low-level process creation function. */
static long
win32_spawn (const char *executable,
BOOL search,
char *const *argv,
DWORD dwCreationFlags,
LPSTARTUPINFO si,
LPPROCESS_INFORMATION pi)
{
char *full_executable;
char *cmdline;
full_executable = NULL;
cmdline = NULL;
full_executable = find_executable (executable, search);
if (!full_executable)
goto error;
cmdline = argv_to_cmdline (argv);
if (!cmdline)
goto error;
/* Create the child process. */
if (!CreateProcess (full_executable, cmdline,
/*lpProcessAttributes=*/NULL,
/*lpThreadAttributes=*/NULL,
/*bInheritHandles=*/TRUE,
dwCreationFlags,
/*lpEnvironment=*/NULL,
/*lpCurrentDirectory=*/NULL,
si,
pi))
{
free (full_executable);
return -1;
}
/* Clean up. */
CloseHandle (pi->hThread);
free (full_executable);
return (long) pi->hProcess;
error:
if (cmdline)
free (cmdline);
if (full_executable)
free (full_executable);
return -1;
}
2005-09-15 03:04:05 +02:00
static long
2006-04-01 01:01:16 +02:00
spawn_script (const char *executable, char *const *argv,
DWORD dwCreationFlags,
LPSTARTUPINFO si,
LPPROCESS_INFORMATION pi)
2005-09-15 03:04:05 +02:00
{
int pid = -1;
int save_errno = errno;
int fd = _open (executable, _O_RDONLY);
if (fd >= 0)
{
char buf[MAX_PATH + 5];
int len = _read (fd, buf, sizeof (buf) - 1);
_close (fd);
if (len > 3)
{
char *eol;
buf[len] = '\0';
eol = strchr (buf, '\n');
if (eol && strncmp (buf, "#!", 2) == 0)
{
char *executable1;
const char ** avhere = (const char **) --argv;
do
*eol = '\0';
while (*--eol == '\r' || *eol == ' ' || *eol == '\t');
for (executable1 = buf + 2; *executable1 == ' ' || *executable1 == '\t'; executable1++)
continue;
backslashify (executable1);
*avhere = executable1;
#ifndef USE_MINGW_MSYS
executable = strrchr (executable1, '\\') + 1;
if (!executable)
executable = executable1;
2006-04-01 01:01:16 +02:00
pid = win32_spawn (executable, TRUE, argv,
dwCreationFlags, si, pi);
2005-09-15 03:04:05 +02:00
#else
if (strchr (executable1, '\\') == NULL)
2006-04-01 01:01:16 +02:00
pid = win32_spawn (executable1, TRUE, argv,
dwCreationFlags, si, pi);
2005-09-15 03:04:05 +02:00
else if (executable1[0] != '\\')
2006-04-01 01:01:16 +02:00
pid = win32_spawn (executable1, FALSE, argv,
dwCreationFlags, si, pi);
2005-09-15 03:04:05 +02:00
else
{
const char *newex = mingw_rootify (executable1);
*avhere = newex;
2006-04-01 01:01:16 +02:00
pid = win32_spawn (newex, FALSE, argv,
dwCreationFlags, si, pi);
2005-09-15 03:04:05 +02:00
if (executable1 != newex)
free ((char *) newex);
if (pid < 0)
{
newex = msys_rootify (executable1);
if (newex != executable1)
{
*avhere = newex;
2006-04-01 01:01:16 +02:00
pid = win32_spawn (newex, FALSE, argv,
dwCreationFlags, si, pi);
2005-09-15 03:04:05 +02:00
free ((char *) newex);
}
}
}
#endif
}
}
}
if (pid < 0)
errno = save_errno;
return pid;
}
/* Execute a child. */
static long
pex_win32_exec_child (struct pex_obj *obj ATTRIBUTE_UNUSED, int flags,
const char *executable, char * const * argv,
int in, int out, int errdes, const char **errmsg,
int *err)
{
long pid;
2006-04-01 01:01:16 +02:00
HANDLE stdin_handle;
HANDLE stdout_handle;
HANDLE stderr_handle;
DWORD dwCreationFlags;
OSVERSIONINFO version_info;
STARTUPINFO si;
PROCESS_INFORMATION pi;
stdin_handle = INVALID_HANDLE_VALUE;
stdout_handle = INVALID_HANDLE_VALUE;
stderr_handle = INVALID_HANDLE_VALUE;
stdin_handle = (HANDLE) _get_osfhandle (in);
stdout_handle = (HANDLE) _get_osfhandle (out);
if (!(flags & PEX_STDERR_TO_STDOUT))
stderr_handle = (HANDLE) _get_osfhandle (errdes);
else
stderr_handle = stdout_handle;
/* Determine the version of Windows we are running on. */
version_info.dwOSVersionInfoSize = sizeof (version_info);
GetVersionEx (&version_info);
if (version_info.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)
/* On Windows 95/98/ME the CREATE_NO_WINDOW flag is not
supported, so we cannot avoid creating a console window. */
dwCreationFlags = 0;
else
2003-01-24 22:31:35 +01:00
{
2006-04-01 01:01:16 +02:00
HANDLE conout_handle;
/* Determine whether or not we have an associated console. */
conout_handle = CreateFile("CONOUT$",
GENERIC_WRITE,
FILE_SHARE_WRITE,
/*lpSecurityAttributes=*/NULL,
OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL,
/*hTemplateFile=*/NULL);
if (conout_handle == INVALID_HANDLE_VALUE)
/* There is no console associated with this process. Since
the child is a console process, the OS would normally
create a new console Window for the child. Since we'll be
redirecting the child's standard streams, we do not need
the console window. */
dwCreationFlags = CREATE_NO_WINDOW;
else
{
2006-04-01 01:01:16 +02:00
/* There is a console associated with the process, so the OS
will not create a new console. And, if we use
CREATE_NO_WINDOW in this situation, the child will have
no associated console. Therefore, if the child's
standard streams are connected to the console, the output
will be discarded. */
CloseHandle(conout_handle);
dwCreationFlags = 0;
}
2003-01-24 22:31:35 +01:00
}
2006-04-01 01:01:16 +02:00
/* Since the child will be a console process, it will, by default,
connect standard input/output to its console. However, we want
the child to use the handles specifically designated above. In
addition, if there is no console (such as when we are running in
a Cygwin X window), then we must redirect the child's
input/output, as there is no console for the child to use. */
memset (&si, 0, sizeof (si));
si.cb = sizeof (si);
si.dwFlags = STARTF_USESTDHANDLES;
si.hStdInput = stdin_handle;
si.hStdOutput = stdout_handle;
si.hStdError = stderr_handle;
/* Create the child process. */
pid = win32_spawn (executable, (flags & PEX_SEARCH) != 0,
argv, dwCreationFlags, &si, &pi);
2005-09-15 03:04:05 +02:00
if (pid == -1)
2006-04-01 01:01:16 +02:00
pid = spawn_script (executable, argv, dwCreationFlags, &si, &pi);
if (pid == -1)
2003-01-24 22:31:35 +01:00
{
2006-04-01 01:01:16 +02:00
*err = ENOENT;
*errmsg = "CreateProcess";
2003-01-24 22:31:35 +01:00
}
2006-04-01 01:01:16 +02:00
/* Close the standard output and standard error handles in the
parent. */
if (out != STDOUT_FILENO)
obj->funcs->close (obj, out);
if (errdes != STDERR_FILENO)
obj->funcs->close (obj, errdes);
2003-01-24 22:31:35 +01:00
return pid;
}
/* Wait for a child process to complete. MS CRTDLL doesn't return
enough information in status to decide if the child exited due to a
signal or not, rather it simply returns an integer with the exit
code of the child; eg., if the child exited with an abort() call
and didn't have a handler for SIGABRT, it simply returns with
status == 3. We fix the status code to conform to the usual WIF*
macros. Note that WIFSIGNALED will never be true under CRTDLL. */
static int
pex_win32_wait (struct pex_obj *obj ATTRIBUTE_UNUSED, long pid,
int *status, struct pex_time *time, int done ATTRIBUTE_UNUSED,
const char **errmsg, int *err)
2003-01-24 22:31:35 +01:00
{
2006-04-01 01:01:16 +02:00
DWORD termstat;
HANDLE h;
2003-01-24 22:31:35 +01:00
if (time != NULL)
memset (time, 0, sizeof *time);
2006-04-01 01:01:16 +02:00
h = (HANDLE) pid;
/* FIXME: If done is non-zero, we should probably try to kill the
process. */
2006-04-01 01:01:16 +02:00
if (WaitForSingleObject (h, INFINITE) != WAIT_OBJECT_0)
{
2006-04-01 01:01:16 +02:00
CloseHandle (h);
*err = ECHILD;
*errmsg = "WaitForSingleObject";
return -1;
}
2003-01-24 22:31:35 +01:00
2006-04-01 01:01:16 +02:00
GetExitCodeProcess (h, &termstat);
CloseHandle (h);
/* A value of 3 indicates that the child caught a signal, but not
which one. Since only SIGABRT, SIGFPE and SIGINT do anything, we
report SIGABRT. */
2003-01-24 22:31:35 +01:00
if (termstat == 3)
*status = SIGABRT;
else
2006-04-01 01:01:16 +02:00
*status = (termstat & 0xff) << 8;
2003-01-24 22:31:35 +01:00
return 0;
}
/* Create a pipe. */
static int
pex_win32_pipe (struct pex_obj *obj ATTRIBUTE_UNUSED, int *p,
int binary)
{
return _pipe (p, 256, binary ? _O_BINARY : _O_TEXT);
}
/* Get a FILE pointer to read from a file descriptor. */
static FILE *
pex_win32_fdopenr (struct pex_obj *obj ATTRIBUTE_UNUSED, int fd,
int binary)
{
return fdopen (fd, binary ? "rb" : "r");
2003-01-24 22:31:35 +01:00
}
2005-09-15 03:04:05 +02:00
2006-04-12 20:42:01 +02:00
static FILE *
pex_win32_fdopenw (struct pex_obj *obj ATTRIBUTE_UNUSED, int fd,
int binary)
{
HANDLE h = (HANDLE) _get_osfhandle (fd);
if (h == INVALID_HANDLE_VALUE)
return NULL;
if (! SetHandleInformation (h, HANDLE_FLAG_INHERIT, 0))
return NULL;
return fdopen (fd, binary ? "wb" : "w");
}
2005-09-15 03:04:05 +02:00
#ifdef MAIN
#include <stdio.h>
int
main (int argc ATTRIBUTE_UNUSED, char **argv)
{
char const *errmsg;
int err;
argv++;
printf ("%ld\n", pex_win32_exec_child (NULL, PEX_SEARCH, argv[0], argv, 0, 1, 2, &errmsg, &err));
exit (0);
}
#endif