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 *name, const char *shortdesc, 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 - %s\n\n%s\n", name, shortdesc, str);
419 fprintf (fp, "=head1 %s - %s\n\n", name, shortdesc);
424 /* List is built in reverse order, so mount them in reverse order. */
426 mount_mps (struct mp *mp)
431 mount_mps (mp->next);
433 r = guestfs_mount (g, mp->device, mp->mountpoint);
435 r = guestfs_mount_ro (g, mp->device, mp->mountpoint);
442 add_drives (struct drv *drv)
447 add_drives (drv->next);
449 r = guestfs_add_drive (g, drv->filename);
451 r = guestfs_add_drive_ro (g, drv->filename);
469 #define FISH "><fs> "
471 static char *line_read = NULL;
476 #ifdef HAVE_LIBREADLINE
484 line_read = readline (prompt ? FISH : "");
486 if (line_read && *line_read)
487 add_history_line (line_read);
492 #endif /* HAVE_LIBREADLINE */
494 static char buf[8192];
497 if (prompt) printf (FISH);
498 line_read = fgets (buf, sizeof buf, stdin);
501 len = strlen (line_read);
502 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
516 int global_exit_on_error = !prompt;
521 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
522 "editing virtual machine filesystems.\n"
524 "Type: 'help' for help with commands\n"
525 " 'quit' to quit the shell\n"
531 exit_on_error = global_exit_on_error;
533 buf = rl_gets (prompt);
539 /* Skip any initial whitespace before the command. */
541 while (*buf && isspace (*buf))
546 /* If the next character is '#' then this is a comment. */
547 if (*buf == '#') continue;
549 /* If the next character is '!' then pass the whole lot to system(3). */
557 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
558 WEXITSTATUS (r) != 0)
564 /* If the next character is '-' allow the command to fail without
565 * exiting on error (just for this one command though).
573 /* Get the command (cannot be quoted). */
574 len = strcspn (buf, " \t");
576 if (len == 0) continue;
580 if (buf[len] == '\0') {
587 p += strspn (p, " \t");
589 /* Get the parameters. */
590 while (*p && i < sizeof argv / sizeof argv[0]) {
593 /* Parameters which start with quotes or pipes are treated
594 * specially. Bare parameters are delimited by whitespace.
598 len = strcspn (p, "\"");
599 if (p[len] == '\0') {
600 fprintf (stderr, _("guestfish: unterminated double quote\n"));
601 if (exit_on_error) exit (1);
604 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
605 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
606 if (exit_on_error) exit (1);
610 pend = p[len+1] ? &p[len+2] : &p[len+1];
611 } else if (*p == '\'') {
613 len = strcspn (p, "'");
614 if (p[len] == '\0') {
615 fprintf (stderr, _("guestfish: unterminated single quote\n"));
616 if (exit_on_error) exit (1);
619 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
620 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
621 if (exit_on_error) exit (1);
625 pend = p[len+1] ? &p[len+2] : &p[len+1];
626 } else if (*p == '|') {
631 } else if (*p == '[') {
635 while (*pend && c != 0) {
636 if (*pend == '[') c++;
637 else if (*pend == ']') c--;
641 fprintf (stderr, _("guestfish: unterminated \"[...]\" sequence\n"));
642 if (exit_on_error) exit (1);
645 if (*pend && (*pend != ' ' && *pend != '\t')) {
646 fprintf (stderr, _("guestfish: command arguments not separated by whitespace\n"));
647 if (exit_on_error) exit (1);
652 } else if (*p != ' ' && *p != '\t') {
653 /* If the first character is a ~ then note that this parameter
654 * is a candidate for ~username expansion. NB this does not
655 * apply to quoted parameters.
657 tilde_candidate = *p == '~';
658 len = strcspn (p, " \t");
665 fprintf (stderr, _("guestfish: internal error parsing string at '%s'\n"),
670 if (!tilde_candidate)
673 argv[i] = try_tilde_expansion (p);
678 p += strspn (p, " \t");
681 if (i == sizeof argv / sizeof argv[0]) {
682 fprintf (stderr, _("guestfish: too many arguments\n"));
683 if (exit_on_error) exit (1);
690 if (issue_command (cmd, argv, pipe) == -1) {
691 if (exit_on_error) exit (1);
696 if (prompt) printf ("\n");
700 cmdline (char *argv[], int optind, int argc)
707 if (optind >= argc) return;
709 cmd = argv[optind++];
710 if (strcmp (cmd, ":") == 0) {
711 fprintf (stderr, _("guestfish: empty command on command line\n"));
714 params = &argv[optind];
716 /* Search for end of command list or ":" ... */
717 while (optind < argc && strcmp (argv[optind], ":") != 0)
720 if (optind == argc) {
721 if (issue_command (cmd, params, NULL) == -1) exit (1);
724 if (issue_command (cmd, params, NULL) == -1) exit (1);
725 cmdline (argv, optind+1, argc);
730 issue_command (const char *cmd, char *argv[], const char *pipecmd)
733 int stdout_saved_fd = -1;
739 for (i = 0; argv[i] != NULL; ++i)
740 printf (" %s", argv[i]);
744 /* For | ... commands. Annoyingly we can't use popen(3) here. */
756 if (pid == 0) { /* Child process. */
760 r = system (pipecmd);
765 _exit (WEXITSTATUS (r));
768 stdout_saved_fd = dup (1);
774 for (argc = 0; argv[argc] != NULL; ++argc)
777 /* If --remote was set, then send this command to a remote process. */
779 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
781 /* Otherwise execute it locally. */
782 else if (strcasecmp (cmd, "help") == 0) {
786 display_command (argv[0]);
789 else if (strcasecmp (cmd, "quit") == 0 ||
790 strcasecmp (cmd, "exit") == 0 ||
791 strcasecmp (cmd, "q") == 0) {
795 else if (strcasecmp (cmd, "alloc") == 0 ||
796 strcasecmp (cmd, "allocate") == 0)
797 r = do_alloc (cmd, argc, argv);
798 else if (strcasecmp (cmd, "echo") == 0)
799 r = do_echo (cmd, argc, argv);
800 else if (strcasecmp (cmd, "edit") == 0 ||
801 strcasecmp (cmd, "vi") == 0 ||
802 strcasecmp (cmd, "emacs") == 0)
803 r = do_edit (cmd, argc, argv);
804 else if (strcasecmp (cmd, "lcd") == 0)
805 r = do_lcd (cmd, argc, argv);
806 else if (strcasecmp (cmd, "glob") == 0)
807 r = do_glob (cmd, argc, argv);
808 else if (strcasecmp (cmd, "more") == 0 ||
809 strcasecmp (cmd, "less") == 0)
810 r = do_more (cmd, argc, argv);
811 else if (strcasecmp (cmd, "reopen") == 0)
812 r = do_reopen (cmd, argc, argv);
813 else if (strcasecmp (cmd, "time") == 0)
814 r = do_time (cmd, argc, argv);
816 r = run_action (cmd, argc, argv);
818 /* Always flush stdout after every command, so that messages, results
819 * etc appear immediately.
825 dup2 (stdout_saved_fd, 1);
826 close (stdout_saved_fd);
827 waitpid (pid, NULL, 0);
834 list_builtin_commands (void)
836 /* help and quit should appear at the top */
837 printf ("%-20s %s\n",
838 "help", _("display a list of commands or help on a command"));
839 printf ("%-20s %s\n",
840 "quit", _("quit guestfish"));
842 printf ("%-20s %s\n",
843 "alloc", _("allocate an image"));
844 printf ("%-20s %s\n",
845 "echo", _("display a line of text"));
846 printf ("%-20s %s\n",
847 "edit", _("edit a file in the image"));
848 printf ("%-20s %s\n",
849 "lcd", _("local change directory"));
850 printf ("%-20s %s\n",
851 "glob", _("expand wildcards in command"));
852 printf ("%-20s %s\n",
853 "more", _("view a file in the pager"));
854 printf ("%-20s %s\n",
855 "reopen", _("close and reopen libguestfs handle"));
856 printf ("%-20s %s\n",
857 "time", _("measure time taken to run command"));
859 /* actions are printed after this (see list_commands) */
863 display_builtin_command (const char *cmd)
865 /* help for actions is auto-generated, see display_command */
867 if (strcasecmp (cmd, "alloc") == 0 ||
868 strcasecmp (cmd, "allocate") == 0)
869 printf (_("alloc - allocate an image\n"
870 " alloc <filename> <size>\n"
872 " This creates an empty (zeroed) file of the given size,\n"
873 " and then adds so it can be further examined.\n"
875 " For more advanced image creation, see qemu-img utility.\n"
877 " Size can be specified (where <nn> means a number):\n"
878 " <nn> number of kilobytes\n"
879 " eg: 1440 standard 3.5\" floppy\n"
880 " <nn>K or <nn>KB number of kilobytes\n"
881 " <nn>M or <nn>MB number of megabytes\n"
882 " <nn>G or <nn>GB number of gigabytes\n"
883 " <nn>sects number of 512 byte sectors\n"));
884 else if (strcasecmp (cmd, "echo") == 0)
885 printf (_("echo - display a line of text\n"
886 " echo [<params> ...]\n"
888 " This echos the parameters to the terminal.\n"));
889 else if (strcasecmp (cmd, "edit") == 0 ||
890 strcasecmp (cmd, "vi") == 0 ||
891 strcasecmp (cmd, "emacs") == 0)
892 printf (_("edit - edit a file in the image\n"
895 " This is used to edit a file.\n"
897 " It is the equivalent of (and is implemented by)\n"
898 " running \"cat\", editing locally, and then \"write-file\".\n"
900 " Normally it uses $EDITOR, but if you use the aliases\n"
901 " \"vi\" or \"emacs\" you will get those editors.\n"
903 " NOTE: This will not work reliably for large files\n"
904 " (> 2 MB) or binary files containing \\0 bytes.\n"));
905 else if (strcasecmp (cmd, "lcd") == 0)
906 printf (_("lcd - local change directory\n"
909 " Change guestfish's current directory. This command is\n"
910 " useful if you want to download files to a particular\n"
912 else if (strcasecmp (cmd, "glob") == 0)
913 printf (_("glob - expand wildcards in command\n"
914 " glob <command> [<args> ...]\n"
916 " Glob runs <command> with wildcards expanded in any\n"
917 " command args. Note that the command is run repeatedly\n"
918 " once for each expanded argument.\n"));
919 else if (strcasecmp (cmd, "help") == 0)
920 printf (_("help - display a list of commands or help on a command\n"
923 else if (strcasecmp (cmd, "more") == 0 ||
924 strcasecmp (cmd, "less") == 0)
925 printf (_("more - view a file in the pager\n"
928 " This is used to view a file in the pager.\n"
930 " It is the equivalent of (and is implemented by)\n"
931 " running \"cat\" and using the pager.\n"
933 " Normally it uses $PAGER, but if you use the alias\n"
934 " \"less\" then it always uses \"less\".\n"
936 " NOTE: This will not work reliably for large files\n"
937 " (> 2 MB) or binary files containing \\0 bytes.\n"));
938 else if (strcasecmp (cmd, "quit") == 0 ||
939 strcasecmp (cmd, "exit") == 0 ||
940 strcasecmp (cmd, "q") == 0)
941 printf (_("quit - quit guestfish\n"
943 else if (strcasecmp (cmd, "reopen") == 0)
944 printf (_("reopen - close and reopen the libguestfs handle\n"
947 "Close and reopen the libguestfs handle. It is not necessary to use\n"
948 "this normally, because the handle is closed properly when guestfish\n"
949 "exits. However this is occasionally useful for testing.\n"));
950 else if (strcasecmp (cmd, "time") == 0)
951 printf (_("time - measure time taken to run command\n"
952 " time <command> [<args> ...]\n"
954 " This runs <command> as usual, and prints the elapsed\n"
955 " time afterwards.\n"));
957 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
962 free_strings (char **argv)
966 for (argc = 0; argv[argc] != NULL; ++argc)
972 count_strings (char * const * const argv)
976 for (c = 0; argv[c]; ++c)
982 print_strings (char * const * const argv)
986 for (argc = 0; argv[argc] != NULL; ++argc)
987 printf ("%s\n", argv[argc]);
991 print_table (char * const * const argv)
995 for (i = 0; argv[i] != NULL; i += 2)
996 printf ("%s: %s\n", argv[i], argv[i+1]);
1000 is_true (const char *str)
1003 strcasecmp (str, "0") != 0 &&
1004 strcasecmp (str, "f") != 0 &&
1005 strcasecmp (str, "false") != 0 &&
1006 strcasecmp (str, "n") != 0 &&
1007 strcasecmp (str, "no") != 0;
1010 /* XXX We could improve list parsing. */
1012 parse_string_list (const char *str)
1015 const char *p, *pend;
1019 for (i = 0; str[i]; ++i)
1020 if (str[i] == ' ') argc++;
1022 argv = malloc (sizeof (char *) * (argc+1));
1023 if (argv == NULL) { perror ("malloc"); exit (1); }
1028 pend = strchrnul (p, ' ');
1029 argv[i] = strndup (p, pend-p);
1031 p = *pend == ' ' ? pend+1 : pend;
1038 #ifdef HAVE_LIBREADLINE
1039 static char histfile[1024];
1040 static int nr_history_lines = 0;
1044 initialize_readline (void)
1046 #ifdef HAVE_LIBREADLINE
1049 home = getenv ("HOME");
1051 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1053 (void) read_history (histfile);
1056 rl_readline_name = "guestfish";
1057 rl_attempted_completion_function = do_completion;
1062 cleanup_readline (void)
1064 #ifdef HAVE_LIBREADLINE
1067 if (histfile[0] != '\0') {
1068 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1075 (void) append_history (nr_history_lines, histfile);
1081 add_history_line (const char *line)
1083 #ifdef HAVE_LIBREADLINE
1090 xwrite (int fd, const void *buf, size_t len)
1095 r = write (fd, buf, len);