lib/w32spawn.h

   1 /* Auxiliary functions for the creation of subprocesses.  Native Windows API.
   2    Copyright (C) 2001, 2003-2012 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2003.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Get declarations of the native Windows API functions.  */
  19 #define WIN32_LEAN_AND_MEAN
  20 #include <windows.h>
  21
  22 /* Get _open_osfhandle().  */
  23 #include <io.h>
  24
  25 #include <stdbool.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #include <errno.h>
  29
  30 /* Get _get_osfhandle().  */
  31 #include "msvc-nothrow.h"
  32
  33 #include "cloexec.h"
  34 #include "xalloc.h"
  35
  36 /* Duplicates a file handle, making the copy uninheritable.
  37    Returns -1 for a file handle that is equivalent to closed.  */
  38 static int
  39 dup_noinherit (int fd)
  40 {
  41   fd = dup_cloexec (fd);
  42   if (fd < 0 && errno == EMFILE)
  43     error (EXIT_FAILURE, errno, _("_open_osfhandle failed"));
  44
  45   return fd;
  46 }
  47
  48 /* Returns a file descriptor equivalent to FD, except that the resulting file
  49    descriptor is none of STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
  50    FD must be open and non-inheritable.  The result will be non-inheritable as
  51    well.
  52    If FD < 0, FD itself is returned.  */
  53 static int
  54 fd_safer_noinherit (int fd)
  55 {
  56   if (STDIN_FILENO <= fd && fd <= STDERR_FILENO)
  57     {
  58       /* The recursion depth is at most 3.  */
  59       int nfd = fd_safer_noinherit (dup_noinherit (fd));
  60       int saved_errno = errno;
  61       close (fd);
  62       errno = saved_errno;
  63       return nfd;
  64     }
  65   return fd;
  66 }
  67
  68 /* Duplicates a file handle, making the copy uninheritable and ensuring the
  69    result is none of STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO.
  70    Returns -1 for a file handle that is equivalent to closed.  */
  71 static int
  72 dup_safer_noinherit (int fd)
  73 {
  74   return fd_safer_noinherit (dup_noinherit (fd));
  75 }
  76
  77 /* Undoes the effect of TEMPFD = dup_safer_noinherit (ORIGFD);  */
  78 static void
  79 undup_safer_noinherit (int tempfd, int origfd)
  80 {
  81   if (tempfd >= 0)
  82     {
  83       if (dup2 (tempfd, origfd) < 0)
  84         error (EXIT_FAILURE, errno, _("cannot restore fd %d: dup2 failed"),
  85                origfd);
  86       close (tempfd);
  87     }
  88   else
  89     {
  90       /* origfd was closed or open to no handle at all.  Set it to a closed
  91          state.  This is (nearly) equivalent to the original state.  */
  92       close (origfd);
  93     }
  94 }
  95
  96 /* Prepares an argument vector before calling spawn().
  97    Note that spawn() does not by itself call the command interpreter
  98      (getenv ("COMSPEC") != NULL ? getenv ("COMSPEC") :
  99       ({ OSVERSIONINFO v; v.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
 100          GetVersionEx(&v);
 101          v.dwPlatformId == VER_PLATFORM_WIN32_NT;
 102       }) ? "cmd.exe" : "command.com").
 103    Instead it simply concatenates the arguments, separated by ' ', and calls
 104    CreateProcess().  We must quote the arguments since Windows CreateProcess()
 105    interprets characters like ' ', '\t', '\\', '"' (but not '<' and '>') in a
 106    special way:
 107    - Space and tab are interpreted as delimiters. They are not treated as
 108      delimiters if they are surrounded by double quotes: "...".
 109    - Unescaped double quotes are removed from the input. Their only effect is
 110      that within double quotes, space and tab are treated like normal
 111      characters.
 112    - Backslashes not followed by double quotes are not special.
 113    - But 2*n+1 backslashes followed by a double quote become
 114      n backslashes followed by a double quote (n >= 0):
 115        \" -> "
 116        \\\" -> \"
 117        \\\\\" -> \\"
 118    - '*' characters may get expanded or lead to a failure with error code
 119      ERROR_PATH_NOT_FOUND.
 120  */
 121 #define SHELL_SPECIAL_CHARS "\"\\ \001\002\003\004\005\006\007\010\011\012\013\014\015\016\017\020\021\022\023\024\025\026\027\030\031\032\033\034\035\036\037*"
 122 #define SHELL_SPACE_CHARS " \001\002\003\004\005\006\007\010\011\012\013\014\015\016\017\020\021\022\023\024\025\026\027\030\031\032\033\034\035\036\037"
 123 static char **
 124 prepare_spawn (char **argv)
 125 {
 126   size_t argc;
 127   char **new_argv;
 128   size_t i;
 129
 130   /* Count number of arguments.  */
 131   for (argc = 0; argv[argc] != NULL; argc++)
 132     ;
 133
 134   /* Allocate new argument vector.  */
 135   new_argv = XNMALLOC (1 + argc + 1, char *);
 136
 137   /* Add an element upfront that can be used when argv[0] turns out to be a
 138      script, not a program.
 139      On Unix, this would be "/bin/sh". On native Windows, "sh" is actually
 140      "sh.exe".  We have to omit the directory part and rely on the search in
 141      PATH, because the mingw "mount points" are not visible inside Windows
 142      CreateProcess().  */
 143   *new_argv++ = "sh.exe";
 144
 145   /* Put quoted arguments into the new argument vector.  */
 146   for (i = 0; i < argc; i++)
 147     {
 148       const char *string = argv[i];
 149
 150       if (string[0] == '\0')
 151         new_argv[i] = xstrdup ("\"\"");
 152       else if (strpbrk (string, SHELL_SPECIAL_CHARS) != NULL)
 153         {
 154           bool quote_around = (strpbrk (string, SHELL_SPACE_CHARS) != NULL);
 155           size_t length;
 156           unsigned int backslashes;
 157           const char *s;
 158           char *quoted_string;
 159           char *p;
 160
 161           length = 0;
 162           backslashes = 0;
 163           if (quote_around)
 164             length++;
 165           for (s = string; *s != '\0'; s++)
 166             {
 167               char c = *s;
 168               if (c == '"')
 169                 length += backslashes + 1;
 170               length++;
 171               if (c == '\\')
 172                 backslashes++;
 173               else
 174                 backslashes = 0;
 175             }
 176           if (quote_around)
 177             length += backslashes + 1;
 178
 179           quoted_string = (char *) xmalloc (length + 1);
 180
 181           p = quoted_string;
 182           backslashes = 0;
 183           if (quote_around)
 184             *p++ = '"';
 185           for (s = string; *s != '\0'; s++)
 186             {
 187               char c = *s;
 188               if (c == '"')
 189                 {
 190                   unsigned int j;
 191                   for (j = backslashes + 1; j > 0; j--)
 192                     *p++ = '\\';
 193                 }
 194               *p++ = c;
 195               if (c == '\\')
 196                 backslashes++;
 197               else
 198                 backslashes = 0;
 199             }
 200           if (quote_around)
 201             {
 202               unsigned int j;
 203               for (j = backslashes; j > 0; j--)
 204                 *p++ = '\\';
 205               *p++ = '"';
 206             }
 207           *p = '\0';
 208
 209           new_argv[i] = quoted_string;
 210         }
 211       else
 212         new_argv[i] = (char *) string;
 213     }
 214   new_argv[argc] = NULL;
 215
 216   return new_argv;
 217 }