tests: Split regressions -> various subdirectories of tests/
[libguestfs.git] / daemon / debug.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 #include <config.h>
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <unistd.h>
27 #include <fcntl.h>
28 #include <dirent.h>
29 #include <sys/resource.h>
30
31 #include "guestfs_protocol.h"
32 #include "daemon.h"
33 #include "actions.h"
34
35 /* This command exposes debugging information, internals and
36  * status.  There is no comprehensive documentation for this
37  * command.  You have to look at the source code in this file
38  * to find out what you can do.
39  *
40  * Commands always output a freeform string.
41  *
42  * Since libguestfs 1.5.7, the debug command has been enabled
43  * by default for all builds (previously you had to enable it
44  * in configure).  This command is not part of the stable ABI
45  * and may change at any time.
46  */
47
48 struct cmd {
49   const char *cmd;
50   char * (*f) (const char *subcmd, int argc, char *const *const argv);
51 };
52
53 static char *debug_help (const char *subcmd, int argc, char *const *const argv);
54 static char *debug_binaries (const char *subcmd, int argc, char *const *const argv);
55 static char *debug_core_pattern (const char *subcmd, int argc, char *const *const argv);
56 static char *debug_env (const char *subcmd, int argc, char *const *const argv);
57 static char *debug_fds (const char *subcmd, int argc, char *const *const argv);
58 static char *debug_ldd (const char *subcmd, int argc, char *const *const argv);
59 static char *debug_ls (const char *subcmd, int argc, char *const *const argv);
60 static char *debug_ll (const char *subcmd, int argc, char *const *const argv);
61 static char *debug_progress (const char *subcmd, int argc, char *const *const argv);
62 static char *debug_qtrace (const char *subcmd, int argc, char *const *const argv);
63 static char *debug_segv (const char *subcmd, int argc, char *const *const argv);
64 static char *debug_sh (const char *subcmd, int argc, char *const *const argv);
65
66 static struct cmd cmds[] = {
67   { "help", debug_help },
68   { "binaries", debug_binaries },
69   { "core_pattern", debug_core_pattern },
70   { "env", debug_env },
71   { "fds", debug_fds },
72   { "ldd", debug_ldd },
73   { "ls", debug_ls },
74   { "ll", debug_ll },
75   { "progress", debug_progress },
76   { "qtrace", debug_qtrace },
77   { "segv", debug_segv },
78   { "sh", debug_sh },
79   { NULL, NULL }
80 };
81
82 char *
83 do_debug (const char *subcmd, char *const *argv)
84 {
85   int argc, i;
86
87   for (i = argc = 0; argv[i] != NULL; ++i)
88     argc++;
89
90   for (i = 0; cmds[i].cmd != NULL; ++i) {
91     if (STRCASEEQ (subcmd, cmds[i].cmd))
92       return cmds[i].f (subcmd, argc, argv);
93   }
94
95   reply_with_error ("use 'debug help 0' to list the supported commands");
96   return NULL;
97 }
98
99 static char *
100 debug_help (const char *subcmd, int argc, char *const *const argv)
101 {
102   int len, i;
103   char *r, *p;
104
105   r = strdup ("Commands supported:");
106   if (!r) {
107     reply_with_perror ("strdup");
108     return NULL;
109   }
110
111   len = strlen (r);
112   for (i = 0; cmds[i].cmd != NULL; ++i) {
113     len += strlen (cmds[i].cmd) + 1; /* space + new command */
114     p = realloc (r, len + 1);        /* +1 for the final NUL */
115     if (p == NULL) {
116       reply_with_perror ("realloc");
117       free (r);
118       return NULL;
119     }
120     r = p;
121
122     strcat (r, " ");
123     strcat (r, cmds[i].cmd);
124   }
125
126   return r;
127 }
128
129 /* Show open FDs. */
130 static char *
131 debug_fds (const char *subcmd, int argc, char *const *const argv)
132 {
133   int r;
134   char *out;
135   size_t size;
136   FILE *fp;
137   DIR *dir;
138   struct dirent *d;
139   char fname[256], link[256];
140   struct stat statbuf;
141
142   fp = open_memstream (&out, &size);
143   if (!fp) {
144     reply_with_perror ("open_memstream");
145     return NULL;
146   }
147
148   dir = opendir ("/proc/self/fd");
149   if (!dir) {
150     reply_with_perror ("opendir: /proc/self/fd");
151     fclose (fp);
152     return NULL;
153   }
154
155   while ((d = readdir (dir)) != NULL) {
156     if (STREQ (d->d_name, ".") || STREQ (d->d_name, ".."))
157       continue;
158
159     snprintf (fname, sizeof fname, "/proc/self/fd/%s", d->d_name);
160
161     r = lstat (fname, &statbuf);
162     if (r == -1) {
163       reply_with_perror ("stat: %s", fname);
164       fclose (fp);
165       free (out);
166       closedir (dir);
167       return NULL;
168     }
169
170     if (S_ISLNK (statbuf.st_mode)) {
171       r = readlink (fname, link, sizeof link - 1);
172       if (r == -1) {
173         reply_with_perror ("readline: %s", fname);
174         fclose (fp);
175         free (out);
176         closedir (dir);
177         return NULL;
178       }
179       link[r] = '\0';
180
181       fprintf (fp, "%2s %s\n", d->d_name, link);
182     } else
183       fprintf (fp, "%2s 0%o\n", d->d_name, statbuf.st_mode);
184   }
185
186   fclose (fp);
187
188   if (closedir (dir) == -1) {
189     reply_with_perror ("closedir");
190     free (out);
191     return NULL;
192   }
193
194   return out;
195 }
196
197 /* Force a segfault in the daemon. */
198 static char *
199 debug_segv (const char *subcmd, int argc, char *const *const argv)
200 {
201   *(int*)0 = 0;
202   return NULL;
203 }
204
205 /* Run an arbitrary shell command using /bin/sh from the appliance.
206  *
207  * Note this is somewhat different from the ordinary guestfs_sh command
208  * because it's not using the guest shell, and is not chrooted.
209  */
210 static char *
211 debug_sh (const char *subcmd, int argc, char *const *const argv)
212 {
213   if (argc < 1) {
214     reply_with_error ("sh: expecting a command to run");
215     return NULL;
216   }
217
218   char *cmd;
219   int len, i, j;
220
221   /* guestfish splits the parameter(s) into a list of strings,
222    * and we have to reassemble them here.  Not ideal. XXX
223    */
224   for (i = len = 0; i < argc; ++i)
225     len += strlen (argv[i]) + 1;
226   cmd = malloc (len);
227   if (!cmd) {
228     reply_with_perror ("malloc");
229     return NULL;
230   }
231   for (i = j = 0; i < argc; ++i) {
232     len = strlen (argv[i]);
233     memcpy (&cmd[j], argv[i], len);
234     j += len;
235     cmd[j] = ' ';
236     j++;
237   }
238   cmd[j-1] = '\0';
239
240   /* Set up some environment variables. */
241   setenv ("root", sysroot, 1);
242   if (access ("/sys/block/sda", F_OK) == 0)
243     setenv ("sd", "sd", 1);
244   else if (access ("/sys/block/hda", F_OK) == 0)
245     setenv ("sd", "hd", 1);
246   else if (access ("/sys/block/vda", F_OK) == 0)
247     setenv ("sd", "vd", 1);
248
249   char *err;
250   int r = commandf (NULL, &err, COMMAND_FLAG_FOLD_STDOUT_ON_STDERR,
251                     "/bin/sh", "-c", cmd, NULL);
252   free (cmd);
253
254   if (r == -1) {
255     reply_with_error ("%s", err);
256     free (err);
257     return NULL;
258   }
259
260   return err;
261 }
262
263 /* Print the environment that commands get (by running external printenv). */
264 static char *
265 debug_env (const char *subcmd, int argc, char *const *const argv)
266 {
267   int r;
268   char *out, *err;
269
270   r = command (&out, &err, "printenv", NULL);
271   if (r == -1) {
272     reply_with_error ("printenv: %s", err);
273     free (out);
274     free (err);
275     return NULL;
276   }
277
278   free (err);
279
280   return out;
281 }
282
283 /* Return binaries in the appliance.
284  * See tests/regressions/rhbz727178.sh
285  */
286 static char *
287 debug_binaries (const char *subcmd, int argc, char *const *const argv)
288 {
289   int r;
290   char *out, *err;
291
292   const char cmd[] =
293     "find / -xdev -type f -executable "
294     "| xargs file -i "
295     "| grep application/x-executable "
296     "| gawk -F: '{print $1}'";
297
298   r = command (&out, &err, "sh", "-c", cmd, NULL);
299   if (r == -1) {
300     reply_with_error ("find: %s", err);
301     free (out);
302     free (err);
303     return NULL;
304   }
305
306   free (err);
307
308   return out;
309 }
310
311 /* Run 'ldd' on a file from the appliance.
312  * See tests/regressions/rhbz727178.sh
313  */
314 static char *
315 debug_ldd (const char *subcmd, int argc, char *const *const argv)
316 {
317   int r;
318   char *out, *err, *ret;
319
320   if (argc != 1) {
321     reply_with_error ("ldd: no file argument");
322     return NULL;
323   }
324
325   /* Note that 'ldd' doesn't fail if it finds errors.  We have to grep
326    * for errors in the regression test instead.  'ldd' only fails here
327    * if the binary is not a binary at all (eg. for shell scripts).
328    * Also 'ldd' randomly sends messages to stderr and errors to stdout
329    * depending on the phase of the moon.
330    */
331   r = command (&out, &err, "ldd", "-r", argv[0], NULL);
332   if (r == -1) {
333     reply_with_error ("ldd: %s: %s", argv[0], err);
334     free (out);
335     free (err);
336     return NULL;
337   }
338
339   /* Concatenate stdout and stderr in the result. */
340   ret = realloc (out, strlen (out) + strlen (err) + 1);
341   if (ret == NULL) {
342     reply_with_perror ("realloc");
343     free (out);
344     free (err);
345     return NULL;
346   }
347
348   strcat (ret, err);
349   free (err);
350
351   return ret;
352 }
353
354 /* List files in the appliance. */
355 static char *
356 debug_ls (const char *subcmd, int argc, char *const *const argv)
357 {
358   int len = count_strings (argv);
359   const char *cargv[len+3];
360   int i;
361
362   cargv[0] = "ls";
363   cargv[1] = "-a";
364   for (i = 0; i < len; ++i)
365     cargv[2+i] = argv[i];
366   cargv[2+len] = NULL;
367
368   int r;
369   char *out, *err;
370
371   r = commandv (&out, &err, (void *) cargv);
372   if (r == -1) {
373     reply_with_error ("ls: %s", err);
374     free (out);
375     free (err);
376     return NULL;
377   }
378
379   free (err);
380
381   return out;
382 }
383
384 /* List files in the appliance. */
385 static char *
386 debug_ll (const char *subcmd, int argc, char *const *const argv)
387 {
388   int len = count_strings (argv);
389   const char *cargv[len+3];
390   int i;
391
392   cargv[0] = "ls";
393   cargv[1] = "-la";
394   for (i = 0; i < len; ++i)
395     cargv[2+i] = argv[i];
396   cargv[2+len] = NULL;
397
398   int r;
399   char *out, *err;
400
401   r = commandv (&out, &err, (void *) cargv);
402   if (r == -1) {
403     reply_with_error ("ll: %s", err);
404     free (out);
405     free (err);
406     return NULL;
407   }
408
409   free (err);
410
411   return out;
412 }
413
414 /* Generate progress notification messages in order to test progress bars. */
415 static char *
416 debug_progress (const char *subcmd, int argc, char *const *const argv)
417 {
418   if (argc < 1) {
419   error:
420     reply_with_error ("progress: expecting arg (time in seconds as string)");
421     return NULL;
422   }
423
424   char *secs_str = argv[0];
425   unsigned secs;
426   if (sscanf (secs_str, "%u", &secs) != 1 || secs == 0)
427     goto error;
428
429   unsigned i;
430   unsigned tsecs = secs * 10;   /* 1/10ths of seconds */
431   for (i = 1; i <= tsecs; ++i) {
432     usleep (100000);
433     notify_progress ((uint64_t) i, (uint64_t) tsecs);
434   }
435
436   char *ret = strdup ("ok");
437   if (ret == NULL) {
438     reply_with_perror ("strdup");
439     return NULL;
440   }
441
442   return ret;
443 }
444
445 /* Enable core dumping to the given core pattern.
446  * Note that this pattern is relative to any chroot of the process which
447  * crashes. This means that if you want to write the core file to the guest's
448  * storage the pattern must start with /sysroot only if the command which
449  * crashes doesn't chroot.
450  */
451 static char *
452 debug_core_pattern (const char *subcmd, int argc, char *const *const argv)
453 {
454   if (argc < 1) {
455     reply_with_error ("core_pattern: expecting a core pattern");
456     return NULL;
457   }
458
459   const char *pattern = argv[0];
460   const size_t pattern_len = strlen(pattern);
461
462 #define CORE_PATTERN "/proc/sys/kernel/core_pattern"
463   int fd = open (CORE_PATTERN, O_WRONLY);
464   if (fd == -1) {
465     reply_with_perror ("open: " CORE_PATTERN);
466     return NULL;
467   }
468   if (write (fd, pattern, pattern_len) < (ssize_t) pattern_len) {
469     reply_with_perror ("write: " CORE_PATTERN);
470     return NULL;
471   }
472   if (close (fd) == -1) {
473     reply_with_perror ("close: " CORE_PATTERN);
474     return NULL;
475   }
476
477   struct rlimit limit = {
478     .rlim_cur = RLIM_INFINITY,
479     .rlim_max = RLIM_INFINITY
480   };
481   if (setrlimit (RLIMIT_CORE, &limit) == -1) {
482     reply_with_perror ("setrlimit (RLIMIT_CORE)");
483     return NULL;
484   }
485
486   char *ret = strdup ("ok");
487   if (NULL == ret) {
488     reply_with_perror ("strdup");
489     return NULL;
490   }
491
492   return ret;
493 }
494
495 static int
496 write_cb (void *fd_ptr, const void *buf, size_t len)
497 {
498   int fd = *(int *)fd_ptr;
499   return xwrite (fd, buf, len);
500 }
501
502 /* This requires a non-upstream qemu patch.  See contrib/visualize-alignment/
503  * directory in the libguestfs source tree.
504  */
505 static char *
506 debug_qtrace (const char *subcmd, int argc, char *const *const argv)
507 {
508   int enable;
509
510   if (argc != 2) {
511   bad_args:
512     reply_with_error ("qtrace <device> <on|off>");
513     return NULL;
514   }
515
516   if (STREQ (argv[1], "on"))
517     enable = 1;
518   else if (STREQ (argv[1], "off"))
519     enable = 0;
520   else
521     goto bad_args;
522
523   /* This does a sync and flushes all caches. */
524   if (do_drop_caches (3) == -1)
525     return NULL;
526
527   /* Note this doesn't do device name translation or check this is a device. */
528   int fd = open (argv[0], O_RDONLY | O_DIRECT);
529   if (fd == -1) {
530     reply_with_perror ("qtrace: %s: open", argv[0]);
531     return NULL;
532   }
533
534   /* The pattern of reads is what signals to the analysis program that
535    * tracing should be started or stopped.  Note this assumes both 512
536    * byte sectors, and that O_DIRECT will let us do 512 byte aligned
537    * reads.  We ought to read the sector size of the device and use
538    * that instead (XXX).  The analysis program currently assumes 512
539    * byte sectors anyway.
540    */
541 #define QTRACE_SIZE 512
542   const int patterns[2][5] = {
543     { 2, 15, 21, 2, -1 }, /* disable trace */
544     { 2, 21, 15, 2, -1 }  /* enable trace */
545   };
546   void *buf;
547   size_t i;
548
549   /* For O_DIRECT, buffer must be aligned too (thanks Matt).
550    * Note posix_memalign has this strange errno behaviour.
551    */
552   errno = posix_memalign (&buf, QTRACE_SIZE, QTRACE_SIZE);
553   if (errno != 0) {
554     reply_with_perror ("posix_memalign");
555     close (fd);
556     return NULL;
557   }
558
559   for (i = 0; patterns[enable][i] >= 0; ++i) {
560     if (lseek (fd, patterns[enable][i]*QTRACE_SIZE, SEEK_SET) == -1) {
561       reply_with_perror ("qtrace: %s: lseek", argv[0]);
562       close (fd);
563       free (buf);
564       return NULL;
565     }
566
567     if (read (fd, buf, QTRACE_SIZE) == -1) {
568       reply_with_perror ("qtrace: %s: read", argv[0]);
569       close (fd);
570       free (buf);
571       return NULL;
572     }
573   }
574
575   close (fd);
576   free (buf);
577
578   /* This does a sync and flushes all caches. */
579   if (do_drop_caches (3) == -1)
580     return NULL;
581
582   char *ret = strdup ("ok");
583   if (NULL == ret) {
584     reply_with_perror ("strdup");
585     return NULL;
586   }
587
588   return ret;
589 }
590
591 /* Has one FileIn parameter. */
592 int
593 do_debug_upload (const char *filename, int mode)
594 {
595   /* Not chrooted - this command lets you upload a file to anywhere
596    * in the appliance.
597    */
598   int fd = open (filename, O_WRONLY|O_CREAT|O_TRUNC|O_NOCTTY, mode);
599
600   if (fd == -1) {
601     int err = errno;
602     cancel_receive ();
603     errno = err;
604     reply_with_perror ("%s", filename);
605     return -1;
606   }
607
608   int r = receive_file (write_cb, &fd);
609   if (r == -1) {                /* write error */
610     int err = errno;
611     cancel_receive ();
612     errno = err;
613     reply_with_error ("write error: %s", filename);
614     close (fd);
615     return -1;
616   }
617   if (r == -2) {                /* cancellation from library */
618     /* This error is ignored by the library since it initiated the
619      * cancel.  Nevertheless we must send an error reply here.
620      */
621     reply_with_error ("file upload cancelled");
622     close (fd);
623     return -1;
624   }
625
626   if (close (fd) == -1) {
627     reply_with_perror ("close: %s", filename);
628     return -1;
629   }
630
631   return 0;
632 }