1 /* guestfish - the filesystem interactive shell
2 * Copyright (C) 2009 Red Hat Inc.
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.
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.
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.
21 #define _GNU_SOURCE // for strchrnul
32 #include <sys/types.h>
35 #ifdef HAVE_LIBREADLINE
36 #include <readline/readline.h>
37 #include <readline/history.h>
55 static void add_drives (struct drv *drv);
56 static void mount_mps (struct mp *mp);
57 static void interactive (void);
58 static void shell_script (void);
59 static void script (int prompt);
60 static void cmdline (char *argv[], int optind, int argc);
61 static void initialize_readline (void);
62 static void cleanup_readline (void);
63 static void add_history_line (const char *);
65 /* Currently open libguestfs handle. */
71 int echo_commands = 0;
72 int remote_control_listen = 0;
73 int remote_control = 0;
74 int exit_on_error = 1;
77 launch (guestfs_h *_g)
81 if (guestfs_is_config (g)) {
82 if (guestfs_launch (g) == -1)
84 if (guestfs_wait_ready (g) == -1)
94 _("guestfish: guest filesystem shell\n"
95 "guestfish lets you edit virtual machine filesystems\n"
96 "Copyright (C) 2009 Red Hat Inc.\n"
98 " guestfish [--options] cmd [: cmd : cmd ...]\n"
99 " guestfish -i libvirt-domain\n"
100 " guestfish -i disk-image(s)\n"
101 "or for interactive use:\n"
103 "or from a shell script:\n"
109 " -h|--cmd-help List available commands\n"
110 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
111 " -a|--add image Add image\n"
112 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
113 " -f|--file file Read commands from file\n"
114 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
115 " --listen Listen for remote commands\n"
116 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
117 " -n|--no-sync Don't autosync\n"
118 " --remote[=pid] Send commands to remote guestfish\n"
119 " -r|--ro Mount read-only\n"
120 " -v|--verbose Verbose messages\n"
121 " -x Echo each command before executing it\n"
122 " -V|--version Display version and exit\n"
123 "For more information, see the manpage guestfish(1).\n"));
127 main (int argc, char *argv[])
129 static const char *options = "a:Df:h::im:nrv?Vx";
130 static struct option long_options[] = {
131 { "add", 1, 0, 'a' },
132 { "cmd-help", 2, 0, 'h' },
133 { "file", 1, 0, 'f' },
134 { "help", 0, 0, '?' },
135 { "inspector", 0, 0, 'i' },
136 { "listen", 0, 0, 0 },
137 { "mount", 1, 0, 'm' },
138 { "no-dest-paths", 0, 0, 'D' },
139 { "no-sync", 0, 0, 'n' },
140 { "remote", 2, 0, 0 },
142 { "verbose", 0, 0, 'v' },
143 { "version", 0, 0, 'V' },
146 struct drv *drvs = NULL;
148 struct mp *mps = NULL;
150 char *p, *file = NULL;
156 initialize_readline ();
158 memset (&sa, 0, sizeof sa);
159 sa.sa_handler = SIG_IGN;
160 sa.sa_flags = SA_RESTART;
161 sigaction (SIGPIPE, &sa, NULL);
163 /* guestfs_create is meant to be a lightweight operation, so
164 * it's OK to do it early here.
166 g = guestfs_create ();
168 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
172 guestfs_set_autosync (g, 1);
174 /* If developing, add ./appliance to the path. Note that libtools
175 * interferes with this because uninstalled guestfish is a shell
176 * script that runs the real program with an absolute path. Detect
179 * BUT if LIBGUESTFS_PATH environment variable is already set by
180 * the user, then don't override it.
182 if (getenv ("LIBGUESTFS_PATH") == NULL &&
184 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
185 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
188 c = getopt_long (argc, argv, options, long_options, &option_index);
192 case 0: /* options which are long only */
193 if (strcmp (long_options[option_index].name, "listen") == 0)
194 remote_control_listen = 1;
195 else if (strcmp (long_options[option_index].name, "remote") == 0) {
197 if (sscanf (optarg, "%d", &remote_control) != 1) {
198 fprintf (stderr, _("guestfish: --listen=PID: PID was not a number: %s\n"), optarg);
202 p = getenv ("GUESTFISH_PID");
203 if (!p || sscanf (p, "%d", &remote_control) != 1) {
204 fprintf (stderr, _("guestfish: remote: $GUESTFISH_PID must be set to the PID of the remote process\n"));
209 fprintf (stderr, _("guestfish: unknown long option: %s (%d)\n"),
210 long_options[option_index].name, option_index);
216 if (access (optarg, R_OK) != 0) {
220 drv = malloc (sizeof (struct drv));
225 drv->filename = optarg;
231 complete_dest_paths = 0;
236 fprintf (stderr, _("guestfish: only one -f parameter can be given\n"));
244 display_command (optarg);
245 else if (argv[optind] && argv[optind][0] != '-')
246 display_command (argv[optind++]);
256 mp = malloc (sizeof (struct mp));
261 p = strchr (optarg, ':');
264 mp->mountpoint = p+1;
266 mp->mountpoint = "/";
273 guestfs_set_autosync (g, 0);
282 guestfs_set_verbose (g, verbose);
286 printf ("guestfish %s\n", PACKAGE_VERSION);
298 fprintf (stderr, _("guestfish: unexpected command line option 0x%x\n"),
304 /* Inspector mode invalidates most of the other arguments. */
309 if (drvs || mps || remote_control_listen || remote_control) {
310 fprintf (stderr, _("guestfish: cannot use -i option with -a, -m, --listen or --remote\n"));
313 if (optind >= argc) {
314 fprintf (stderr, _("guestfish -i requires a libvirt domain or path(s) to disk image(s)\n"));
318 strcpy (cmd, "a=`virt-inspector");
319 while (optind < argc) {
320 if (strlen (cmd) + strlen (argv[optind]) + strlen (argv[0]) + 60
322 fprintf (stderr, _("guestfish: virt-inspector command too long for fixed-size buffer\n"));
326 strcat (cmd, argv[optind]);
332 strcat (cmd, " --ro-fish");
334 strcat (cmd, " --fish");
336 sprintf (&cmd[strlen(cmd)], "` && %s $a", argv[0]);
338 if (guestfs_get_verbose (g))
340 if (!guestfs_get_autosync (g))
345 "guestfish -i: running virt-inspector command:\n%s\n", cmd);
352 exit (WEXITSTATUS (r));
355 /* If we've got drives to add, add them now. */
358 /* If we've got mountpoints, we must launch the guest and mount them. */
360 if (launch (g) == -1) exit (1);
364 /* Remote control? */
365 if (remote_control_listen && remote_control) {
366 fprintf (stderr, _("guestfish: cannot use --listen and --remote options at the same time\n"));
370 if (remote_control_listen) {
372 fprintf (stderr, _("guestfish: extra parameters on the command line with --listen flag\n"));
376 fprintf (stderr, _("guestfish: cannot use --listen and --file options at the same time\n"));
382 /* -f (file) parameter? */
385 if (open (file, O_RDONLY) == -1) {
391 /* Interactive, shell script, or command(s) on the command line? */
392 if (optind >= argc) {
399 cmdline (argv, optind, argc);
407 pod2text (const char *heading, const char *str)
411 fp = popen ("pod2text", "w");
413 /* pod2text failed, maybe not found, so let's just print the
414 * source instead, since that's better than doing nothing.
416 printf ("%s\n\n%s\n", heading, str);
419 fputs ("=head1 ", fp);
426 /* List is built in reverse order, so mount them in reverse order. */
428 mount_mps (struct mp *mp)
433 mount_mps (mp->next);
435 r = guestfs_mount (g, mp->device, mp->mountpoint);
437 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
444 add_drives (struct drv *drv)
449 add_drives (drv->next);
451 r = guestfs_add_drive (g, drv->filename);
453 r = guestfs_add_drive_ro (g, drv->filename);
471 #define FISH "><fs> "
473 static char *line_read = NULL;
478 #ifdef HAVE_LIBREADLINE
486 line_read = readline (prompt ? FISH : "");
488 if (line_read && *line_read)
489 add_history_line (line_read);
494 #endif /* HAVE_LIBREADLINE */
496 static char buf[8192];
499 if (prompt) printf (FISH);
500 line_read = fgets (buf, sizeof buf, stdin);
503 len = strlen (line_read);
504 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
518 int global_exit_on_error = !prompt;
523 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
524 "editing virtual machine filesystems.\n"
526 "Type: 'help' for help with commands\n"
527 " 'quit' to quit the shell\n"
533 exit_on_error = global_exit_on_error;
535 buf = rl_gets (prompt);
541 /* Skip any initial whitespace before the command. */
543 while (*buf && isspace (*buf))
548 /* If the next character is '#' then this is a comment. */
549 if (*buf == '#') continue;
551 /* If the next character is '!' then pass the whole lot to system(3). */
559 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
560 WEXITSTATUS (r) != 0)
566 /* If the next character is '-' allow the command to fail without
567 * exiting on error (just for this one command though).
575 /* Get the command (cannot be quoted). */
576 len = strcspn (buf, " \t");
578 if (len == 0) continue;
582 if (buf[len] == '\0') {
589 p += strspn (p, " \t");
591 /* Get the parameters. */
592 while (*p && i < sizeof argv / sizeof argv[0]) {
595 /* Parameters which start with quotes or pipes are treated
596 * specially. Bare parameters are delimited by whitespace.
600 len = strcspn (p, "\"");
601 if (p[len] == '\0') {
602 fprintf (stderr, _("guestfish: unterminated double quote\n"));
603 if (exit_on_error) exit (1);
606 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
607 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
608 if (exit_on_error) exit (1);
612 pend = p[len+1] ? &p[len+2] : &p[len+1];
613 } else if (*p == '\'') {
615 len = strcspn (p, "'");
616 if (p[len] == '\0') {
617 fprintf (stderr, _("guestfish: unterminated single quote\n"));
618 if (exit_on_error) exit (1);
621 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
622 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
623 if (exit_on_error) exit (1);
627 pend = p[len+1] ? &p[len+2] : &p[len+1];
628 } else if (*p == '|') {
633 } else if (*p == '[') {
637 while (*pend && c != 0) {
638 if (*pend == '[') c++;
639 else if (*pend == ']') c--;
643 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
644 if (exit_on_error) exit (1);
647 if (*pend && (*pend != ' ' && *pend != '\t')) {
648 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
649 if (exit_on_error) exit (1);
654 } else if (*p != ' ' && *p != '\t') {
655 /* If the first character is a ~ then note that this parameter
656 * is a candidate for ~username expansion. NB this does not
657 * apply to quoted parameters.
659 tilde_candidate = *p == '~';
660 len = strcspn (p, " \t");
667 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
672 if (!tilde_candidate)
675 argv[i] = try_tilde_expansion (p);
680 p += strspn (p, " \t");
683 if (i == sizeof argv / sizeof argv[0]) {
684 fprintf (stderr, _("guestfish: too many arguments\n"));
685 if (exit_on_error) exit (1);
692 if (issue_command (cmd, argv, pipe) == -1) {
693 if (exit_on_error) exit (1);
698 if (prompt) printf ("\n");
702 cmdline (char *argv[], int optind, int argc)
709 if (optind >= argc) return;
711 cmd = argv[optind++];
712 if (strcmp (cmd, ":") == 0) {
713 fprintf (stderr, _("guestfish: empty command on command line\n"));
716 params = &argv[optind];
718 /* Search for end of command list or ":" ... */
719 while (optind < argc && strcmp (argv[optind], ":") != 0)
722 if (optind == argc) {
723 if (issue_command (cmd, params, NULL) == -1) exit (1);
726 if (issue_command (cmd, params, NULL) == -1) exit (1);
727 cmdline (argv, optind+1, argc);
732 issue_command (const char *cmd, char *argv[], const char *pipecmd)
735 int stdout_saved_fd = -1;
741 for (i = 0; argv[i] != NULL; ++i)
742 printf (" %s", argv[i]);
746 /* For | ... commands. Annoyingly we can't use popen(3) here. */
758 if (pid == 0) { /* Child process. */
762 r = system (pipecmd);
767 _exit (WEXITSTATUS (r));
770 stdout_saved_fd = dup (1);
776 for (argc = 0; argv[argc] != NULL; ++argc)
779 /* If --remote was set, then send this command to a remote process. */
781 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
783 /* Otherwise execute it locally. */
784 else if (strcasecmp (cmd, "help") == 0) {
788 display_command (argv[0]);
791 else if (strcasecmp (cmd, "quit") == 0 ||
792 strcasecmp (cmd, "exit") == 0 ||
793 strcasecmp (cmd, "q") == 0) {
797 else if (strcasecmp (cmd, "alloc") == 0 ||
798 strcasecmp (cmd, "allocate") == 0)
799 r = do_alloc (cmd, argc, argv);
800 else if (strcasecmp (cmd, "echo") == 0)
801 r = do_echo (cmd, argc, argv);
802 else if (strcasecmp (cmd, "edit") == 0 ||
803 strcasecmp (cmd, "vi") == 0 ||
804 strcasecmp (cmd, "emacs") == 0)
805 r = do_edit (cmd, argc, argv);
806 else if (strcasecmp (cmd, "lcd") == 0)
807 r = do_lcd (cmd, argc, argv);
808 else if (strcasecmp (cmd, "glob") == 0)
809 r = do_glob (cmd, argc, argv);
810 else if (strcasecmp (cmd, "more") == 0 ||
811 strcasecmp (cmd, "less") == 0)
812 r = do_more (cmd, argc, argv);
813 else if (strcasecmp (cmd, "reopen") == 0)
814 r = do_reopen (cmd, argc, argv);
815 else if (strcasecmp (cmd, "time") == 0)
816 r = do_time (cmd, argc, argv);
818 r = run_action (cmd, argc, argv);
820 /* Always flush stdout after every command, so that messages, results
821 * etc appear immediately.
827 dup2 (stdout_saved_fd, 1);
828 close (stdout_saved_fd);
829 waitpid (pid, NULL, 0);
836 list_builtin_commands (void)
838 /* help and quit should appear at the top */
839 printf ("%-20s %s\n",
840 "help", _("display a list of commands or help on a command"));
841 printf ("%-20s %s\n",
842 "quit", _("quit guestfish"));
844 printf ("%-20s %s\n",
845 "alloc", _("allocate an image"));
846 printf ("%-20s %s\n",
847 "echo", _("display a line of text"));
848 printf ("%-20s %s\n",
849 "edit", _("edit a file in the image"));
850 printf ("%-20s %s\n",
851 "lcd", _("local change directory"));
852 printf ("%-20s %s\n",
853 "glob", _("expand wildcards in command"));
854 printf ("%-20s %s\n",
855 "more", _("view a file in the pager"));
856 printf ("%-20s %s\n",
857 "reopen", _("close and reopen libguestfs handle"));
858 printf ("%-20s %s\n",
859 "time", _("measure time taken to run command"));
861 /* actions are printed after this (see list_commands) */
865 display_builtin_command (const char *cmd)
867 /* help for actions is auto-generated, see display_command */
869 if (strcasecmp (cmd, "alloc") == 0 ||
870 strcasecmp (cmd, "allocate") == 0)
871 printf (_("alloc - allocate an image\n"
872 " alloc <filename> <size>\n"
874 " This creates an empty (zeroed) file of the given size,\n"
875 " and then adds so it can be further examined.\n"
877 " For more advanced image creation, see qemu-img utility.\n"
879 " Size can be specified (where <nn> means a number):\n"
880 " <nn> number of kilobytes\n"
881 " eg: 1440 standard 3.5\" floppy\n"
882 " <nn>K or <nn>KB number of kilobytes\n"
883 " <nn>M or <nn>MB number of megabytes\n"
884 " <nn>G or <nn>GB number of gigabytes\n"
885 " <nn>sects number of 512 byte sectors\n"));
886 else if (strcasecmp (cmd, "echo") == 0)
887 printf (_("echo - display a line of text\n"
888 " echo [<params> ...]\n"
890 " This echos the parameters to the terminal.\n"));
891 else if (strcasecmp (cmd, "edit") == 0 ||
892 strcasecmp (cmd, "vi") == 0 ||
893 strcasecmp (cmd, "emacs") == 0)
894 printf (_("edit - edit a file in the image\n"
897 " This is used to edit a file.\n"
899 " It is the equivalent of (and is implemented by)\n"
900 " running \"cat\", editing locally, and then \"write-file\".\n"
902 " Normally it uses $EDITOR, but if you use the aliases\n"
903 " \"vi\" or \"emacs\" you will get those editors.\n"
905 " NOTE: This will not work reliably for large files\n"
906 " (> 2 MB) or binary files containing \\0 bytes.\n"));
907 else if (strcasecmp (cmd, "lcd") == 0)
908 printf (_("lcd - local change directory\n"
911 " Change guestfish's current directory. This command is\n"
912 " useful if you want to download files to a particular\n"
914 else if (strcasecmp (cmd, "glob") == 0)
915 printf (_("glob - expand wildcards in command\n"
916 " glob <command> [<args> ...]\n"
918 " Glob runs <command> with wildcards expanded in any\n"
919 " command args. Note that the command is run repeatedly\n"
920 " once for each expanded argument.\n"));
921 else if (strcasecmp (cmd, "help") == 0)
922 printf (_("help - display a list of commands or help on a command\n"
925 else if (strcasecmp (cmd, "more") == 0 ||
926 strcasecmp (cmd, "less") == 0)
927 printf (_("more - view a file in the pager\n"
930 " This is used to view a file in the pager.\n"
932 " It is the equivalent of (and is implemented by)\n"
933 " running \"cat\" and using the pager.\n"
935 " Normally it uses $PAGER, but if you use the alias\n"
936 " \"less\" then it always uses \"less\".\n"
938 " NOTE: This will not work reliably for large files\n"
939 " (> 2 MB) or binary files containing \\0 bytes.\n"));
940 else if (strcasecmp (cmd, "quit") == 0 ||
941 strcasecmp (cmd, "exit") == 0 ||
942 strcasecmp (cmd, "q") == 0)
943 printf (_("quit - quit guestfish\n"
945 else if (strcasecmp (cmd, "reopen") == 0)
946 printf (_("reopen - close and reopen the libguestfs handle\n"
949 "Close and reopen the libguestfs handle. It is not necessary to use\n"
950 "this normally, because the handle is closed properly when guestfish\n"
951 "exits. However this is occasionally useful for testing.\n"));
952 else if (strcasecmp (cmd, "time") == 0)
953 printf (_("time - measure time taken to run command\n"
954 " time <command> [<args> ...]\n"
956 " This runs <command> as usual, and prints the elapsed\n"
957 " time afterwards.\n"));
959 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
964 free_strings (char **argv)
968 for (argc = 0; argv[argc] != NULL; ++argc)
974 count_strings (char * const * const argv)
978 for (c = 0; argv[c]; ++c)
984 print_strings (char * const * const argv)
988 for (argc = 0; argv[argc] != NULL; ++argc)
989 printf ("%s\n", argv[argc]);
993 print_table (char * const * const argv)
997 for (i = 0; argv[i] != NULL; i += 2)
998 printf ("%s: %s\n", argv[i], argv[i+1]);
1002 is_true (const char *str)
1005 strcasecmp (str, "0") != 0 &&
1006 strcasecmp (str, "f") != 0 &&
1007 strcasecmp (str, "false") != 0 &&
1008 strcasecmp (str, "n") != 0 &&
1009 strcasecmp (str, "no") != 0;
1012 /* XXX We could improve list parsing. */
1014 parse_string_list (const char *str)
1017 const char *p, *pend;
1021 for (i = 0; str[i]; ++i)
1022 if (str[i] == ' ') argc++;
1024 argv = malloc (sizeof (char *) * (argc+1));
1025 if (argv == NULL) { perror ("malloc"); exit (1); }
1030 pend = strchrnul (p, ' ');
1031 argv[i] = strndup (p, pend-p);
1033 p = *pend == ' ' ? pend+1 : pend;
1040 #ifdef HAVE_LIBREADLINE
1041 static char histfile[1024];
1042 static int nr_history_lines = 0;
1046 initialize_readline (void)
1048 #ifdef HAVE_LIBREADLINE
1051 home = getenv ("HOME");
1053 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1055 (void) read_history (histfile);
1058 rl_readline_name = "guestfish";
1059 rl_attempted_completion_function = do_completion;
1064 cleanup_readline (void)
1066 #ifdef HAVE_LIBREADLINE
1069 if (histfile[0] != '\0') {
1070 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1077 (void) append_history (nr_history_lines, histfile);
1083 add_history_line (const char *line)
1085 #ifdef HAVE_LIBREADLINE
1092 xwrite (int fd, const void *buf, size_t len)
1097 r = write (fd, buf, len);