Subversion Repositories scarts

/* Utilities to execute a program in a subprocess (possibly linked by pipes

   with other subprocesses), and wait for it.  Generic Win32 specialization.

   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006

   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.  */

#include "pex-common.h"

#include <windows.h>

#ifdef HAVE_STDLIB_H

#include <stdlib.h>

#endif

#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 <assert.h>

#include <process.h>

#include <io.h>

#include <fcntl.h>

#include <signal.h>

#include <sys/stat.h>

#include <errno.h>

#include <ctype.h>

/* 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

#define MINGW_NAME "Minimalist GNU for Windows"

#define MINGW_NAME_LEN (sizeof(MINGW_NAME) - 1)

extern char *stpcpy (char *dst, const char *src);

/* 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 pid_t pex_win32_exec_child (struct pex_obj *, int, const char *,

                                  char * const *, char * const *,

                                  int, int, int, int,

                                  const char **, int *);

static int pex_win32_close (struct pex_obj *, int);

static int pex_win32_wait (struct pex_obj *, pid_t, 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);

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 =

{

  pex_win32_open_read,

  pex_win32_open_write,

  pex_win32_exec_child,

  pex_win32_close,

  pex_win32_wait,

  pex_win32_pipe,

  pex_win32_fdopenr,

  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);

}

#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

/* Return the number of arguments in an argv array, not including the null

   terminating argument. */

static int

argv_to_argc (char *const *argv)

{

  char *const *i = argv;

  while (*i)

    i++;

  return i - argv;

}

/* 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 = XNEWVEC (char, 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;

}

/* We'll try the passed filename with all the known standard

   extensions, and then without extension.  We try no extension

   last so that we don't try to run some random extension-less

   file that might be hanging around.  We try both extension

   and no extension so that we don't need any fancy logic

   to determine if a file has extension.  */

static const char *const

std_suffixes[] = {

  ".com",

  ".exe",

  ".bat",

  ".cmd",

  "",

};

/* 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_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 + 5 /* space for extension */;

  full_executable = XNEWVEC (char, 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 = 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 and helper.  */

static int

env_compare (const void *a_ptr, const void *b_ptr)

{

  const char *a;

  const char *b;

  unsigned char c1;

  unsigned char c2;

  a = *(const char **) a_ptr;

  b = *(const char **) b_ptr;

  /* a and b will be of the form: VAR=VALUE

     We compare only the variable name part here using a case-insensitive

     comparison algorithm.  It might appear that in fact strcasecmp () can

     take the place of this whole function, and indeed it could, save for

     the fact that it would fail in cases such as comparing A1=foo and

     A=bar (because 1 is less than = in the ASCII character set).

     (Environment variables containing no numbers would work in such a

     scenario.)  */

  do

    {

      c1 = (unsigned char) tolower (*a++);

      c2 = (unsigned char) tolower (*b++);

      if (c1 == '=')

        c1 = '\0';

      if (c2 == '=')

        c2 = '\0';

    }

  while (c1 == c2 && c1 != '\0');

  return c1 - c2;

}

/* Execute a Windows executable as a child process.  This will fail if the

 * target is not actually an executable, such as if it is a shell script. */

static pid_t

win32_spawn (const char *executable,

             BOOL search,

             char *const *argv,

             char *const *env, /* array of strings of the form: VAR=VALUE */

             DWORD dwCreationFlags,

             LPSTARTUPINFO si,

             LPPROCESS_INFORMATION pi)

{

  char *full_executable;

  char *cmdline;

  char **env_copy;

  char *env_block = NULL;

  full_executable = NULL;

  cmdline = NULL;

  if (env)

    {

      int env_size;

      /* Count the number of environment bindings supplied.  */

      for (env_size = 0; env[env_size]; env_size++)

        continue;

      /* Assemble an environment block, if required.  This consists of

         VAR=VALUE strings juxtaposed (with one null character between each

         pair) and an additional null at the end.  */

      if (env_size > 0)

        {

          int var;

          int total_size = 1; /* 1 is for the final null.  */

          char *bufptr;

          /* Windows needs the members of the block to be sorted by variable

             name.  */

          env_copy = (char **) alloca (sizeof (char *) * env_size);

          memcpy (env_copy, env, sizeof (char *) * env_size);

          qsort (env_copy, env_size, sizeof (char *), env_compare);

          for (var = 0; var < env_size; var++)

            total_size += strlen (env[var]) + 1;

          env_block = XNEWVEC (char, total_size);

          bufptr = env_block;

          for (var = 0; var < env_size; var++)

            bufptr = stpcpy (bufptr, env_copy[var]) + 1;

          *bufptr = '\0';

        }

    }

  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,

                      (LPVOID) env_block,

                      /*lpCurrentDirectory=*/NULL,

                      si,

                      pi))

    {

      if (env_block)

        free (env_block);

      free (full_executable);

      return (pid_t) -1;

    }

  /* Clean up.  */

  CloseHandle (pi->hThread);

  free (full_executable);

  if (env_block)

    free (env_block);

  return (pid_t) pi->hProcess;

 error:

  if (env_block)

    free (env_block);

  if (cmdline)

    free (cmdline);

  if (full_executable)

    free (full_executable);

  return (pid_t) -1;

}

/* Spawn a script.  This simulates the Unix script execution mechanism.

   This function is called as a fallback if win32_spawn fails. */

static pid_t

spawn_script (const char *executable, char *const *argv,

              char* const *env,

              DWORD dwCreationFlags,

              LPSTARTUPINFO si,

              LPPROCESS_INFORMATION pi)

{

  pid_t pid = (pid_t) -1;

  int save_errno = errno;

  int fd = _open (executable, _O_RDONLY);

  /* Try to open script, check header format, extract interpreter path,

     and spawn script using that interpretter. */

  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)

            {

              /* Header format is OK. */

              char *executable1;

              int new_argc;