Prepare for 1.0.46.
[libguestfs.git] / daemon / guestfsd.c
1 /* libguestfs - the guestfsd daemon
2  * Copyright (C) 2009 Red Hat Inc. 
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <config.h>
20
21 #define _BSD_SOURCE             /* for daemon(3) */
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include <rpc/types.h>
28 #include <rpc/xdr.h>
29 #include <getopt.h>
30 #include <netdb.h>
31 #include <sys/param.h>
32 #include <sys/select.h>
33 #include <sys/types.h>
34 #include <sys/wait.h>
35 #include <sys/stat.h>
36 #include <fcntl.h>
37 #include <ctype.h>
38 #include <signal.h>
39
40 #include "daemon.h"
41
42 static void usage (void);
43
44 /* Also in guestfs.c */
45 #define VMCHANNEL_PORT "6666"
46 #define VMCHANNEL_ADDR "10.0.2.4"
47
48 int verbose = 0;
49
50 int
51 main (int argc, char *argv[])
52 {
53   static const char *options = "fh:p:?";
54   static struct option long_options[] = {
55     { "foreground", 0, 0, 'f' },
56     { "help", 0, 0, '?' },
57     { "host", 1, 0, 'h' },
58     { "port", 1, 0, 'p' },
59     { 0, 0, 0, 0 }
60   };
61   int c, n, r;
62   int dont_fork = 0;
63   const char *host = NULL;
64   const char *port = NULL;
65   FILE *fp;
66   char buf[4096];
67   char *p, *p2;
68   int sock;
69   struct addrinfo *res, *rr;
70   struct addrinfo hints;
71   XDR xdr;
72   uint32_t len;
73   struct sigaction sa;
74
75   for (;;) {
76     c = getopt_long (argc, argv, options, long_options, NULL);
77     if (c == -1) break;
78
79     switch (c) {
80     case 'f':
81       dont_fork = 1;
82       break;
83
84     case 'h':
85       host = optarg;
86       break;
87
88     case 'p':
89       port = optarg;
90       break;
91
92     case '?':
93       usage ();
94       exit (0);
95
96     default:
97       fprintf (stderr, "guestfsd: unexpected command line option 0x%x\n", c);
98       exit (1);
99     }
100   }
101
102   if (optind < argc) {
103     usage ();
104     exit (1);
105   }
106
107   /* If host and port aren't set yet, try /proc/cmdline. */
108   if (!host || !port) {
109     fp = fopen ("/proc/cmdline", "r");
110     if (fp == NULL) {
111       perror ("/proc/cmdline");
112       goto next;
113     }
114     n = fread (buf, 1, sizeof buf - 1, fp);
115     fclose (fp);
116     buf[n] = '\0';
117
118     /* Set the verbose flag.  Not quite right because this will only
119      * set the flag if host and port aren't set on the command line.
120      * Don't worry about this for now. (XXX)
121      */
122     verbose = strstr (buf, "guestfs_verbose=1") != NULL;
123     if (verbose)
124       printf ("verbose daemon enabled\n");
125
126     p = strstr (buf, "guestfs=");
127
128     if (p) {
129       p += 8;
130       p2 = strchr (p, ':');
131       if (p2) {
132         *p2++ = '\0';
133         host = p;
134         r = strcspn (p2, " \n");
135         p2[r] = '\0';
136         port = p2;
137       }
138     }
139   }
140
141  next:
142   /* Can't parse /proc/cmdline, so use built-in defaults. */
143   if (!host || !port) {
144     host = VMCHANNEL_ADDR;
145     port = VMCHANNEL_PORT;
146   }
147
148   /* Make sure SIGPIPE doesn't kill us. */
149   memset (&sa, 0, sizeof sa);
150   sa.sa_handler = SIG_IGN;
151   sa.sa_flags = 0;
152   if (sigaction (SIGPIPE, &sa, NULL) == -1)
153     perror ("sigaction SIGPIPE"); /* but try to continue anyway ... */
154
155   /* Set up a basic environment.  After we are called by /init the
156    * environment is essentially empty.
157    * https://bugzilla.redhat.com/show_bug.cgi?id=502074#c5
158    */
159   setenv ("PATH", "/usr/bin:/bin", 1);
160   setenv ("SHELL", "/bin/sh", 1);
161   setenv ("LANG", "C", 1);
162
163   /* Resolve the hostname. */
164   memset (&hints, 0, sizeof hints);
165   hints.ai_socktype = SOCK_STREAM;
166   hints.ai_flags = AI_ADDRCONFIG;
167   r = getaddrinfo (host, port, &hints, &res);
168   if (r != 0) {
169     fprintf (stderr, "%s:%s: %s\n", host, port, gai_strerror (r));
170     exit (1);
171   }
172
173   /* Connect to the given TCP socket. */
174   sock = -1;
175   for (rr = res; rr != NULL; rr = rr->ai_next) {
176     sock = socket (rr->ai_family, rr->ai_socktype, rr->ai_protocol);
177     if (sock != -1) {
178       if (connect (sock, rr->ai_addr, rr->ai_addrlen) == 0)
179         break;
180       perror ("connect");
181
182       close (sock);
183       sock = -1;
184     }
185   }
186   freeaddrinfo (res);
187
188   if (sock == -1) {
189     fprintf (stderr, "connection to %s:%s failed\n", host, port);
190     exit (1);
191   }
192
193   /* Send the magic length message which indicates that
194    * userspace is up inside the guest.
195    */
196   len = GUESTFS_LAUNCH_FLAG;
197   xdrmem_create (&xdr, buf, sizeof buf, XDR_ENCODE);
198   if (!xdr_uint32_t (&xdr, &len)) {
199     fprintf (stderr, "xdr_uint32_t failed\n");
200     exit (1);
201   }
202
203   (void) xwrite (sock, buf, xdr_getpos (&xdr));
204
205   xdr_destroy (&xdr);
206
207   /* Fork into the background. */
208   if (!dont_fork) {
209     if (daemon (0, 1) == -1) {
210       perror ("daemon");
211       exit (1);
212     }
213   }
214
215   /* Enter the main loop, reading and performing actions. */
216   main_loop (sock);
217
218   exit (0);
219 }
220
221 int
222 xwrite (int sock, const void *buf, size_t len)
223 {
224   int r;
225
226   while (len > 0) {
227     r = write (sock, buf, len);
228     if (r == -1) {
229       perror ("write");
230       return -1;
231     }
232     buf += r;
233     len -= r;
234   }
235
236   return 0;
237 }
238
239 int
240 xread (int sock, void *buf, size_t len)
241 {
242   int r;
243
244   while (len > 0) {
245     r = read (sock, buf, len);
246     if (r == -1) {
247       perror ("read");
248       return -1;
249     }
250     if (r == 0) {
251       fprintf (stderr, "read: unexpected end of file on fd %d\n", sock);
252       return -1;
253     }
254     buf += r;
255     len -= r;
256   }
257
258   return 0;
259 }
260
261 static void
262 usage (void)
263 {
264   fprintf (stderr, "guestfsd [-f] [-h host -p port]\n");
265 }
266
267 int
268 add_string (char ***argv, int *size, int *alloc, const char *str)
269 {
270   char **new_argv;
271   char *new_str;
272
273   if (*size >= *alloc) {
274     *alloc += 64;
275     new_argv = realloc (*argv, *alloc * sizeof (char *));
276     if (new_argv == NULL) {
277       reply_with_perror ("realloc");
278       free_strings (*argv);
279       return -1;
280     }
281     *argv = new_argv;
282   }
283
284   if (str) {
285     new_str = strdup (str);
286     if (new_str == NULL) {
287       reply_with_perror ("strdup");
288       free_strings (*argv);
289     }
290   } else
291     new_str = NULL;
292
293   (*argv)[*size] = new_str;
294
295   (*size)++;
296   return 0;
297 }
298
299 int
300 count_strings (char * const* const argv)
301 {
302   int argc;
303
304   for (argc = 0; argv[argc] != NULL; ++argc)
305     ;
306   return argc;
307 }
308
309 static int
310 compare (const void *vp1, const void *vp2)
311 {
312   char * const *p1 = (char * const *) vp1;
313   char * const *p2 = (char * const *) vp2;
314   return strcmp (*p1, *p2);
315 }
316
317 void
318 sort_strings (char **argv, int len)
319 {
320   qsort (argv, len, sizeof (char *), compare);
321 }
322
323 void
324 free_strings (char **argv)
325 {
326   int argc;
327
328   for (argc = 0; argv[argc] != NULL; ++argc)
329     free (argv[argc]);
330   free (argv);
331 }
332
333 void
334 free_stringslen (char **argv, int len)
335 {
336   int i;
337
338   for (i = 0; i < len; ++i)
339     free (argv[i]);
340   free (argv);
341 }
342
343 /* This is a more sane version of 'system(3)' for running external
344  * commands.  It uses fork/execvp, so we don't need to worry about
345  * quoting of parameters, and it allows us to capture any error
346  * messages in a buffer.
347  */
348 int
349 command (char **stdoutput, char **stderror, const char *name, ...)
350 {
351   va_list args;
352   char **argv, **p;
353   char *s;
354   int i, r;
355
356   /* Collect the command line arguments into an array. */
357   i = 2;
358   argv = malloc (sizeof (char *) * i);
359   if (argv == NULL) {
360     perror ("malloc");
361     return -1;
362   }
363   argv[0] = (char *) name;
364   argv[1] = NULL;
365
366   va_start (args, name);
367
368   while ((s = va_arg (args, char *)) != NULL) {
369     p = realloc (argv, sizeof (char *) * (++i));
370     if (p == NULL) {
371       perror ("realloc");
372       free (argv);
373       va_end (args);
374       return -1;
375     }
376     argv = p;
377     argv[i-2] = s;
378     argv[i-1] = NULL;
379   }
380
381   va_end (args);
382
383   r = commandv (stdoutput, stderror, argv);
384
385   /* NB: Mustn't free the strings which are on the stack. */
386   free (argv);
387
388   return r;
389 }
390
391 /* Same as 'command', but we allow the status code from the
392  * subcommand to be non-zero, and return that status code.
393  * We still return -1 if there was some other error.
394  */
395 int
396 commandr (char **stdoutput, char **stderror, const char *name, ...)
397 {
398   va_list args;
399   char **argv, **p;
400   char *s;
401   int i, r;
402
403   /* Collect the command line arguments into an array. */
404   i = 2;
405   argv = malloc (sizeof (char *) * i);
406   if (argv == NULL) {
407     perror ("malloc");
408     return -1;
409   }
410   argv[0] = (char *) name;
411   argv[1] = NULL;
412
413   va_start (args, name);
414
415   while ((s = va_arg (args, char *)) != NULL) {
416     p = realloc (argv, sizeof (char *) * (++i));
417     if (p == NULL) {
418       perror ("realloc");
419       free (argv);
420       va_end (args);
421       return -1;
422     }
423     argv = p;
424     argv[i-2] = s;
425     argv[i-1] = NULL;
426   }
427
428   va_end (args);
429
430   r = commandrv (stdoutput, stderror, argv);
431
432   /* NB: Mustn't free the strings which are on the stack. */
433   free (argv);
434
435   return r;
436 }
437
438 /* Same as 'command', but passing an argv. */
439 int
440 commandv (char **stdoutput, char **stderror, char * const* const argv)
441 {
442   int r;
443
444   r = commandrv (stdoutput, stderror, argv);
445   if (r == 0)
446     return 0;
447   else
448     return -1;
449 }
450
451 int
452 commandrv (char **stdoutput, char **stderror, char * const* const argv)
453 {
454   int so_size = 0, se_size = 0;
455   int so_fd[2], se_fd[2];
456   int pid, r, quit, i;
457   fd_set rset, rset2;
458   char buf[256];
459   char *p;
460
461   if (stdoutput) *stdoutput = NULL;
462   if (stderror) *stderror = NULL;
463
464   if (verbose) {
465     printf ("%s", argv[0]);
466     for (i = 1; argv[i] != NULL; ++i)
467       printf (" %s", argv[i]);
468     printf ("\n");
469   }
470
471   if (pipe (so_fd) == -1 || pipe (se_fd) == -1) {
472     perror ("pipe");
473     return -1;
474   }
475
476   pid = fork ();
477   if (pid == -1) {
478     perror ("fork");
479     close (so_fd[0]);
480     close (so_fd[1]);
481     close (se_fd[0]);
482     close (se_fd[1]);
483     return -1;
484   }
485
486   if (pid == 0) {               /* Child process. */
487     close (0);
488     close (so_fd[0]);
489     close (se_fd[0]);
490     dup2 (so_fd[1], 1);
491     dup2 (se_fd[1], 2);
492     close (so_fd[1]);
493     close (se_fd[1]);
494
495     execvp (argv[0], argv);
496     perror (argv[0]);
497     _exit (1);
498   }
499
500   /* Parent process. */
501   close (so_fd[1]);
502   close (se_fd[1]);
503
504   FD_ZERO (&rset);
505   FD_SET (so_fd[0], &rset);
506   FD_SET (se_fd[0], &rset);
507
508   quit = 0;
509   while (quit < 2) {
510     rset2 = rset;
511     r = select (MAX (so_fd[0], se_fd[0]) + 1, &rset2, NULL, NULL, NULL);
512     if (r == -1) {
513       perror ("select");
514     quit:
515       if (stdoutput) free (*stdoutput);
516       if (stderror) free (*stderror);
517       close (so_fd[0]);
518       close (se_fd[0]);
519       waitpid (pid, NULL, 0);
520       return -1;
521     }
522
523     if (FD_ISSET (so_fd[0], &rset2)) { /* something on stdout */
524       r = read (so_fd[0], buf, sizeof buf);
525       if (r == -1) {
526         perror ("read");
527         goto quit;
528       }
529       if (r == 0) { FD_CLR (so_fd[0], &rset); quit++; }
530
531       if (r > 0 && stdoutput) {
532         so_size += r;
533         p = realloc (*stdoutput, so_size);
534         if (p == NULL) {
535           perror ("realloc");
536           goto quit;
537         }
538         *stdoutput = p;
539         memcpy (*stdoutput + so_size - r, buf, r);
540       }
541     }
542
543     if (FD_ISSET (se_fd[0], &rset2)) { /* something on stderr */
544       r = read (se_fd[0], buf, sizeof buf);
545       if (r == -1) {
546         perror ("read");
547         goto quit;
548       }
549       if (r == 0) { FD_CLR (se_fd[0], &rset); quit++; }
550
551       if (r > 0 && stderror) {
552         se_size += r;
553         p = realloc (*stderror, se_size);
554         if (p == NULL) {
555           perror ("realloc");
556           goto quit;
557         }
558         *stderror = p;
559         memcpy (*stderror + se_size - r, buf, r);
560       }
561     }
562   }
563
564   close (so_fd[0]);
565   close (se_fd[0]);
566
567   /* Make sure the output buffers are \0-terminated.  Also remove any
568    * trailing \n characters from the error buffer (not from stdout).
569    */
570   if (stdoutput) {
571     *stdoutput = realloc (*stdoutput, so_size+1);
572     if (*stdoutput == NULL) {
573       perror ("realloc");
574       *stdoutput = NULL;
575     } else
576       (*stdoutput)[so_size] = '\0';
577   }
578   if (stderror) {
579     *stderror = realloc (*stderror, se_size+1);
580     if (*stderror == NULL) {
581       perror ("realloc");
582       *stderror = NULL;
583     } else {
584       (*stderror)[se_size] = '\0';
585       se_size--;
586       while (se_size >= 0 && (*stderror)[se_size] == '\n')
587         (*stderror)[se_size--] = '\0';
588     }
589   }
590
591   /* Get the exit status of the command. */
592   waitpid (pid, &r, 0);
593
594   if (WIFEXITED (r)) {
595     return WEXITSTATUS (r);
596   } else
597     return -1;
598 }
599
600 /* Split an output string into a NULL-terminated list of lines.
601  * Typically this is used where we have run an external command
602  * which has printed out a list of things, and we want to return
603  * an actual list.
604  *
605  * The corner cases here are quite tricky.  Note in particular:
606  *
607  *   "" -> []
608  *   "\n" -> [""]
609  *   "a\nb" -> ["a"; "b"]
610  *   "a\nb\n" -> ["a"; "b"]
611  *   "a\nb\n\n" -> ["a"; "b"; ""]
612  *
613  * The original string is written over and destroyed by this
614  * function (which is usually OK because it's the 'out' string
615  * from command()).  You can free the original string, because
616  * add_string() strdups the strings.
617  */
618 char **
619 split_lines (char *str)
620 {
621   char **lines = NULL;
622   int size = 0, alloc = 0;
623   char *p, *pend;
624
625   if (strcmp (str, "") == 0)
626     goto empty_list;
627
628   p = str;
629   while (p) {
630     /* Empty last line? */
631     if (p[0] == '\0')
632       break;
633
634     pend = strchr (p, '\n');
635     if (pend) {
636       *pend = '\0';
637       pend++;
638     }
639
640     if (add_string (&lines, &size, &alloc, p) == -1) {
641       return NULL;
642     }
643
644     p = pend;
645   }
646
647  empty_list:
648   if (add_string (&lines, &size, &alloc, NULL) == -1)
649     return NULL;
650
651   return lines;
652 }
653
654 /* Quote 'in' for the shell, and write max len-1 bytes to out.  The
655  * result will be NUL-terminated, even if it is truncated.
656  *
657  * Returns number of bytes needed, so if result >= len then the buffer
658  * should have been longer.
659  *
660  * XXX This doesn't quote \n correctly (but is still safe).
661  */
662 int
663 shell_quote (char *out, int len, const char *in)
664 {
665 #define SAFE(c) (isalnum((c)) ||                                        \
666                  (c) == '/' || (c) == '-' || (c) == '_' || (c) == '.')
667   int i, j;
668   int outlen = strlen (in);
669
670   /* Calculate how much output space this really needs. */
671   for (i = 0; in[i]; ++i)
672     if (!SAFE (in[i])) outlen++;
673
674   /* Now copy the string, but only up to len-1 bytes. */
675   for (i = 0, j = 0; in[i]; ++i) {
676     int is_safe = SAFE (in[i]);
677
678     /* Enough space left to write this character? */
679     if (j >= len-1 || (!is_safe && j >= len-2))
680       break;
681
682     if (!is_safe) out[j++] = '\\';
683     out[j++] = in[i];
684   }
685
686   out[j] = '\0';
687
688   return outlen;
689 }
690
691 /* Perform device name translation.  Don't call this directly -
692  * use the IS_DEVICE macro.
693  *
694  * See guestfs(3) for the algorithm.
695  *
696  * We have to open the device and test for ENXIO, because
697  * the device nodes themselves will exist in the appliance.
698  */
699 int
700 device_name_translation (char *device, const char *func)
701 {
702   int fd;
703
704   fd = open (device, O_RDONLY);
705   if (fd >= 0) {
706     close (fd);
707     return 0;
708   }
709
710   if (errno != ENXIO) {
711   error:
712     reply_with_perror ("%s: %s", func, device);
713     return -1;
714   }
715
716   /* If the name begins with "/dev/sd" then try the alternatives. */
717   if (strncmp (device, "/dev/sd", 7) != 0)
718     goto error;
719
720   device[5] = 'h';              /* /dev/hd (old IDE driver) */
721   fd = open (device, O_RDONLY);
722   if (fd >= 0) {
723     close (fd);
724     return 0;
725   }
726
727   device[5] = 'v';              /* /dev/vd (for virtio devices) */
728   fd = open (device, O_RDONLY);
729   if (fd >= 0) {
730     close (fd);
731     return 0;
732   }
733
734   device[5] = 's';              /* Restore original device name. */
735   goto error;
736 }