daemon: count_strings function returns size_t
[libguestfs.git] / daemon / guestfsd.c
index 9375ede..f9e5a68 100644 (file)
@@ -1,5 +1,5 @@
 /* libguestfs - the guestfsd daemon
- * Copyright (C) 2009 Red Hat Inc.
+ * Copyright (C) 2009-2010 Red Hat Inc.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 #define _BSD_SOURCE            /* for daemon(3) */
 
+#ifdef HAVE_WINDOWS_H
+# include <windows.h>
+#endif
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <rpc/types.h>
 #include <rpc/xdr.h>
 #include <getopt.h>
-#include <netdb.h>
 #include <sys/param.h>
-#include <sys/select.h>
 #include <sys/types.h>
-#include <sys/wait.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <signal.h>
-#include <printf.h>
+#include <netdb.h>
+#include <sys/select.h>
+#include <sys/wait.h>
+#include <arpa/inet.h>
+#include <netinet/in.h>
+#include <errno.h>
 
+#ifdef HAVE_PRINTF_H
+# include <printf.h>
+#endif
+
+#include "sockets.h"
 #include "c-ctype.h"
 #include "ignore-value.h"
+#include "error.h"
 
 #include "daemon.h"
 
 static char *read_cmdline (void);
 
-/* Also in guestfs.c */
-#define GUESTFWD_ADDR "10.0.2.4"
-#define GUESTFWD_PORT "6666"
+/* This is the default address we connect to for very old libraries
+ * which didn't specify the address and port number explicitly on the
+ * kernel command line.  It's now recommended to always specify the
+ * address and port number on the command line, so this will not be
+ * used any more.
+ */
+#define OLD_GUESTFWD_ADDR "10.0.2.4"
+#define OLD_GUESTFWD_PORT "6666"
+
+/* This is only a hint.  If not defined, ignore it. */
+#ifndef AI_ADDRCONFIG
+# define AI_ADDRCONFIG 0
+#endif
+
+#ifndef MAX
+# define MAX(a,b) ((a)>(b)?(a):(b))
+#endif
 
 int verbose = 0;
 
@@ -62,10 +88,42 @@ static int print_arginfo (const struct printf_info *info, size_t n, int *argtype
 #endif
 #endif
 
+#ifdef WIN32
+static int
+daemon (int nochdir, int noclose)
+{
+  fprintf (stderr,
+           "On Windows the daemon does not support forking into the "
+           "background.\nYou *must* run the daemon with the -f option.\n");
+  exit (EXIT_FAILURE);
+}
+#endif /* WIN32 */
+
+#ifdef WIN32
+static int
+winsock_init (void)
+{
+  int r;
+
+  /* http://msdn2.microsoft.com/en-us/library/ms742213.aspx */
+  r = gl_sockets_startup (SOCKETS_2_2);
+  return r == 0 ? 0 : -1;
+}
+#else /* !WIN32 */
+static int
+winsock_init (void)
+{
+  return 0;
+}
+#endif /* !WIN32 */
+
 /* Location to mount root device. */
 const char *sysroot = "/sysroot"; /* No trailing slash. */
 int sysroot_len = 8;
 
+/* Not used explicitly, but required by the gnulib 'error' module. */
+const char *program_name = "guestfsd";
+
 static void
 usage (void)
 {
@@ -89,6 +147,9 @@ main (int argc, char *argv[])
   char *cmdline;
   char *vmchannel = NULL;
 
+  if (winsock_init () == -1)
+    error (EXIT_FAILURE, 0, "winsock initialization failed");
+
 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
   /* http://udrepper.livejournal.com/20948.html */
   register_printf_specifier ('Q', print_shell_quote, print_arginfo);
@@ -121,17 +182,17 @@ main (int argc, char *argv[])
 
     case '?':
       usage ();
-      exit (0);
+      exit (EXIT_SUCCESS);
 
     default:
       fprintf (stderr, "guestfsd: unexpected command line option 0x%x\n", c);
-      exit (1);
+      exit (EXIT_FAILURE);
     }
   }
 
   if (optind < argc) {
     usage ();
-    exit (1);
+    exit (EXIT_FAILURE);
   }
 
   cmdline = read_cmdline ();
@@ -149,6 +210,7 @@ main (int argc, char *argv[])
       printf ("could not read linux command line\n");
   }
 
+#ifndef WIN32
   /* Make sure SIGPIPE doesn't kill us. */
   struct sigaction sa;
   memset (&sa, 0, sizeof sa);
@@ -156,17 +218,33 @@ main (int argc, char *argv[])
   sa.sa_flags = 0;
   if (sigaction (SIGPIPE, &sa, NULL) == -1)
     perror ("sigaction SIGPIPE"); /* but try to continue anyway ... */
+#endif
 
+#ifdef WIN32
+# define setenv(n,v,f) _putenv(n "=" v)
+#endif
   /* Set up a basic environment.  After we are called by /init the
    * environment is essentially empty.
    * https://bugzilla.redhat.com/show_bug.cgi?id=502074#c5
+   *
+   * NOTE: if you change $PATH, you must also change 'prog_exists'
+   * function below.
    */
-  setenv ("PATH", "/usr/bin:/bin", 1);
+  setenv ("PATH", "/sbin:/usr/sbin:/bin:/usr/bin", 1);
   setenv ("SHELL", "/bin/sh", 1);
   setenv ("LC_ALL", "C", 1);
+  setenv ("TERM", "dumb", 1);
 
+#ifndef WIN32
   /* We document that umask defaults to 022 (it should be this anyway). */
   umask (022);
+#else
+  /* This is the default for Windows anyway.  It's not even clear if
+   * Windows ever uses this -- the MSDN documentation for the function
+   * contains obvious errors.
+   */
+  _umask (0);
+#endif
 
   /* Get the vmchannel string.
    *
@@ -190,7 +268,7 @@ main (int argc, char *argv[])
       vmchannel = strndup (p + 18, len);
       if (!vmchannel) {
         perror ("strndup");
-        exit (1);
+        exit (EXIT_FAILURE);
       }
     }
 
@@ -204,7 +282,7 @@ main (int argc, char *argv[])
         vmchannel = strndup (p + 4, len);
         if (!vmchannel) {
           perror ("strndup");
-          exit (1);
+          exit (EXIT_FAILURE);
         }
         memcpy (vmchannel, "tcp:", 4);
       }
@@ -213,10 +291,10 @@ main (int argc, char *argv[])
 
   /* Default vmchannel. */
   if (vmchannel == NULL) {
-    vmchannel = strdup ("tcp:" GUESTFWD_ADDR ":" GUESTFWD_PORT);
+    vmchannel = strdup ("tcp:" OLD_GUESTFWD_ADDR ":" OLD_GUESTFWD_PORT);
     if (!vmchannel) {
       perror ("strdup");
-      exit (1);
+      exit (EXIT_FAILURE);
     }
   }
 
@@ -241,7 +319,7 @@ main (int argc, char *argv[])
     } else {
       fprintf (stderr, "vmchannel: expecting \"tcp:<ip>:<port>\": %s\n",
                vmchannel);
-      exit (1);
+      exit (EXIT_FAILURE);
     }
 
     memset (&hints, 0, sizeof hints);
@@ -251,7 +329,7 @@ main (int argc, char *argv[])
     if (r != 0) {
       fprintf (stderr, "%s:%s: %s\n",
                host, port, gai_strerror (r));
-      exit (1);
+      exit (EXIT_FAILURE);
     }
 
     /* Connect to the given TCP socket. */
@@ -272,7 +350,7 @@ main (int argc, char *argv[])
              "unknown vmchannel connection type: %s\n"
              "expecting \"tcp:<ip>:<port>\"\n",
              vmchannel);
-    exit (1);
+    exit (EXIT_FAILURE);
   }
 
   if (sock == -1) {
@@ -291,7 +369,7 @@ main (int argc, char *argv[])
              "or on the libguestfs redhat com mailing list.\n"
              "\n",
              vmchannel);
-    exit (1);
+    exit (EXIT_FAILURE);
   }
 
   /* Send the magic length message which indicates that
@@ -301,10 +379,10 @@ main (int argc, char *argv[])
   XDR xdr;
   uint32_t len = GUESTFS_LAUNCH_FLAG;
   xdrmem_create (&xdr, lenbuf, sizeof lenbuf, XDR_ENCODE);
-  xdr_uint32_t (&xdr, &len);
+  xdr_u_int (&xdr, &len);
 
   if (xwrite (sock, lenbuf, sizeof lenbuf) == -1)
-    exit (1);
+    exit (EXIT_FAILURE);
 
   xdr_destroy (&xdr);
 
@@ -312,14 +390,14 @@ main (int argc, char *argv[])
   if (!dont_fork) {
     if (daemon (0, 1) == -1) {
       perror ("daemon");
-      exit (1);
+      exit (EXIT_FAILURE);
     }
   }
 
   /* Enter the main loop, reading and performing actions. */
   main_loop (sock);
 
-  exit (0);
+  exit (EXIT_SUCCESS);
 }
 
 /* Read /proc/cmdline. */
@@ -466,10 +544,10 @@ add_string (char ***argv, int *size, int *alloc, const char *str)
   return 0;
 }
 
-int
+size_t
 count_strings (char *const *argv)
 {
-  int argc;
+  size_t argc;
 
   for (argc = 0; argv[argc] != NULL; ++argc)
     ;
@@ -638,6 +716,14 @@ commandvf (char **stdoutput, char **stderror, int flags,
  * error messages in the *stderror buffer.  If using this flag,
  * you should pass stdoutput as NULL because nothing could ever be
  * captured in that buffer.
+ *
+ * COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN: For running external
+ * commands on chrooted files correctly (see RHBZ#579608) specifying
+ * this flag causes another process to be forked which chroots into
+ * sysroot and just copies the input file to stdin of the specified
+ * command.  The file descriptor is ORed with the flags, and that file
+ * descriptor is always closed by this function.  See hexdump.c for an
+ * example of usage.
  */
 int
 commandrvf (char **stdoutput, char **stderror, int flags,
@@ -645,7 +731,9 @@ commandrvf (char **stdoutput, char **stderror, int flags,
 {
   int so_size = 0, se_size = 0;
   int so_fd[2], se_fd[2];
-  pid_t pid;
+  int flag_copy_stdin = flags & COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN;
+  int stdin_fd[2] = { -1, -1 };
+  pid_t pid, stdin_pid = -1;
   int r, quit, i;
   fd_set rset, rset2;
   char buf[256];
@@ -661,24 +749,43 @@ commandrvf (char **stdoutput, char **stderror, int flags,
     printf ("\n");
   }
 
+  /* Note: abort is used in a few places along the error paths early
+   * in this function.  This is because (a) cleaning up correctly is
+   * very complex at these places and (b) abort is used when a
+   * resource problems is indicated which would be due to much more
+   * serious issues - eg. memory or file descriptor leaks.  We
+   * wouldn't expect fork(2) or pipe(2) to fail in normal
+   * circumstances.
+   */
+
   if (pipe (so_fd) == -1 || pipe (se_fd) == -1) {
-    perror ("pipe");
-    return -1;
+    error (0, errno, "pipe");
+    abort ();
+  }
+
+  if (flag_copy_stdin) {
+    if (pipe (stdin_fd) == -1) {
+      error (0, errno, "pipe");
+      abort ();
+    }
   }
 
   pid = fork ();
   if (pid == -1) {
-    perror ("fork");
-    close (so_fd[0]);
-    close (so_fd[1]);
-    close (se_fd[0]);
-    close (se_fd[1]);
-    return -1;
+    error (0, errno, "fork");
+    abort ();
   }
 
-  if (pid == 0) {              /* Child process. */
+  if (pid == 0) {              /* Child process running the command. */
     close (0);
-    open ("/dev/null", O_RDONLY); /* Set stdin to /dev/null (ignore failure) */
+    if (flag_copy_stdin) {
+      dup2 (stdin_fd[0], 0);
+      close (stdin_fd[0]);
+      close (stdin_fd[1]);
+    } else {
+      /* Set stdin to /dev/null (ignore failure) */
+      open ("/dev/null", O_RDONLY);
+    }
     close (so_fd[0]);
     close (se_fd[0]);
     if (!(flags & COMMAND_FLAG_FOLD_STDOUT_ON_STDERR))
@@ -691,7 +798,61 @@ commandrvf (char **stdoutput, char **stderror, int flags,
 
     execvp (argv[0], (void *) argv);
     perror (argv[0]);
-    _exit (1);
+    _exit (EXIT_FAILURE);
+  }
+
+  if (flag_copy_stdin) {
+    int fd = flags & COMMAND_FLAG_FD_MASK;
+
+    stdin_pid = fork ();
+    if (stdin_pid == -1) {
+      error (0, errno, "fork");
+      abort ();
+    }
+
+    if (stdin_pid == 0) {       /* Child process copying stdin. */
+      close (so_fd[0]);
+      close (so_fd[1]);
+      close (se_fd[0]);
+      close (se_fd[1]);
+
+      close (1);
+      dup2 (stdin_fd[1], 1);
+      close (stdin_fd[0]);
+      close (stdin_fd[1]);
+
+      if (chroot (sysroot) == -1) {
+        perror ("chroot");
+        _exit (EXIT_FAILURE);
+      }
+
+      ssize_t n;
+      char buffer[BUFSIZ];
+      while ((n = read (fd, buffer, sizeof buffer)) > 0) {
+        if (xwrite (1, buffer, n) == -1)
+          /* EPIPE error indicates the command process has exited
+           * early.  If the command process fails that will be caught
+           * by the daemon, and if not, then it's not an error.
+           */
+          _exit (errno == EPIPE ? EXIT_SUCCESS : EXIT_FAILURE);
+      }
+
+      if (n == -1) {
+        perror ("read");
+        _exit (EXIT_FAILURE);
+      }
+
+      if (close (fd) == -1) {
+        perror ("close");
+        _exit (EXIT_FAILURE);
+      }
+
+      _exit (EXIT_SUCCESS);
+    }
+
+    close (fd);
+    close (stdin_fd[0]);
+    close (stdin_fd[1]);
   }
 
   /* Parent process. */
@@ -714,6 +875,7 @@ commandrvf (char **stdoutput, char **stderror, int flags,
       close (so_fd[0]);
       close (se_fd[0]);
       waitpid (pid, NULL, 0);
+      if (stdin_pid >= 0) waitpid (stdin_pid, NULL, 0);
       return -1;
     }
 
@@ -794,6 +956,23 @@ commandrvf (char **stdoutput, char **stderror, int flags,
     }
   }
 
+  if (flag_copy_stdin) {
+    /* Check copy process didn't fail. */
+    if (waitpid (stdin_pid, &r, 0) != stdin_pid) {
+      perror ("waitpid");
+      kill (pid, 9);
+      waitpid (pid, NULL, 0);
+      return -1;
+    }
+
+    if (!WIFEXITED (r) || WEXITSTATUS (r) != 0) {
+      fprintf (stderr, "failed copying from input file, see earlier messages\n");
+      kill (pid, 9);
+      waitpid (pid, NULL, 0);
+      return -1;
+    }
+  }
+
   /* Get the exit status of the command. */
   if (waitpid (pid, &r, 0) != pid) {
     perror ("waitpid");
@@ -860,6 +1039,28 @@ split_lines (char *str)
   return lines;
 }
 
+/* Skip leading and trailing whitespace, updating the original string
+ * in-place.
+ */
+void
+trim (char *str)
+{
+  size_t len = strlen (str);
+
+  while (len > 0 && c_isspace (str[len-1])) {
+    str[len-1] = '\0';
+    len--;
+  }
+
+  const char *p = str;
+  while (*p && c_isspace (*p)) {
+    p++;
+    len--;
+  }
+
+  memmove (str, p, len+1);
+}
+
 /* printf helper function so we can use %Q ("quoted") and %R to print
  * shell-quoted strings.  See HACKING file for more details.
  */
@@ -928,73 +1129,74 @@ print_arginfo (const struct printf_info *info, size_t n, int *argtypes)
  * the device nodes themselves will exist in the appliance.
  */
 int
-device_name_translation (char *device, const char *func)
+device_name_translation (char *device)
 {
   int fd;
 
   fd = open (device, O_RDONLY);
   if (fd >= 0) {
+  close_ok:
     close (fd);
     return 0;
   }
 
-  if (errno != ENXIO && errno != ENOENT) {
-  error:
-    reply_with_perror ("%s: %s", func, device);
+  if (errno != ENXIO && errno != ENOENT)
     return -1;
-  }
 
   /* If the name begins with "/dev/sd" then try the alternatives. */
   if (STRNEQLEN (device, "/dev/sd", 7))
-    goto error;
+    return -1;
 
   device[5] = 'h';             /* /dev/hd (old IDE driver) */
   fd = open (device, O_RDONLY);
-  if (fd >= 0) {
-    close (fd);
-    return 0;
-  }
+  if (fd >= 0)
+    goto close_ok;
 
   device[5] = 'v';             /* /dev/vd (for virtio devices) */
   fd = open (device, O_RDONLY);
-  if (fd >= 0) {
-    close (fd);
-    return 0;
-  }
+  if (fd >= 0)
+    goto close_ok;
 
   device[5] = 's';             /* Restore original device name. */
-  goto error;
+  return -1;
+}
+
+/* Check program exists and is executable on $PATH.  Actually, we
+ * just assume PATH contains the default entries (see main() above).
+ */
+int
+prog_exists (const char *prog)
+{
+  static const char * const dirs[] =
+    { "/sbin", "/usr/sbin", "/bin", "/usr/bin" };
+  size_t i;
+  char buf[1024];
+
+  for (i = 0; i < sizeof dirs / sizeof dirs[0]; ++i) {
+    snprintf (buf, sizeof buf, "%s/%s", dirs[i], prog);
+    if (access (buf, X_OK) == 0)
+      return 1;
+  }
+  return 0;
 }
 
 /* LVM and other commands aren't synchronous, especially when udev is
  * involved.  eg. You can create or remove some device, but the /dev
  * device node won't appear until some time later.  This means that
  * you get an error if you run one command followed by another.
+ *
  * Use 'udevadm settle' after certain commands, but don't be too
  * fussed if it fails.
+ *
+ * 'udevsettle' was the old name for this command (RHEL 5).  This was
+ * deprecated in favour of 'udevadm settle'.  The old 'udevsettle'
+ * command was left as a symlink.  Then in Fedora 13 the old symlink
+ * remained but it stopped working (RHBZ#548121), so we have to be
+ * careful not to assume that we can use 'udevsettle' if it exists.
  */
 void
 udev_settle (void)
 {
-  static int which_prog = 0;
-
-  if (which_prog == 0) {
-    if (access ("/sbin/udevsettle", X_OK) == 0)
-      which_prog = 2;
-    else if (access ("/sbin/udevadm", X_OK) == 0)
-      which_prog = 1;
-    else
-      which_prog = 3;
-  }
-
-  switch (which_prog) {
-  case 1:
-    command (NULL, NULL, "/sbin/udevadm", "settle", NULL);
-    break;
-  case 2:
-    command (NULL, NULL, "/sbin/udevsettle", NULL);
-    break;
-  default:
-    ;
-  }
+  (void) command (NULL, NULL, "udevadm", "settle", NULL);
+  (void) command (NULL, NULL, "udevsettle", NULL);
 }