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.
29 #include <sys/types.h>
33 #ifdef HAVE_LIBREADLINE
34 #include <readline/readline.h>
35 #include <readline/history.h>
47 char *filename; /* disk filename (for -a or -N options) */
48 prep_data *data; /* prepared type (for -N option only) */
49 char *device; /* device inside the appliance */
58 static void add_drives (struct drv *drv);
59 static void prepare_drives (struct drv *drv);
60 static void mount_mps (struct mp *mp);
61 static void interactive (void);
62 static void shell_script (void);
63 static void script (int prompt);
64 static void cmdline (char *argv[], int optind, int argc);
65 static void initialize_readline (void);
66 static void cleanup_readline (void);
67 static void add_history_line (const char *);
69 /* Currently open libguestfs handle. */
75 int echo_commands = 0;
76 int remote_control_listen = 0;
77 int remote_control = 0;
78 int exit_on_error = 1;
82 launch (guestfs_h *_g)
86 if (guestfs_is_config (g)) {
87 if (guestfs_launch (g) == -1)
93 static void __attribute__((noreturn))
96 if (status != EXIT_SUCCESS)
97 fprintf (stderr, _("Try `%s --help' for more information.\n"),
101 _("%s: guest filesystem shell\n"
102 "%s lets you edit virtual machine filesystems\n"
103 "Copyright (C) 2009 Red Hat Inc.\n"
105 " %s [--options] cmd [: cmd : cmd ...]\n"
106 " %s -i libvirt-domain\n"
107 " %s -i disk-image(s)\n"
108 "or for interactive use:\n"
110 "or from a shell script:\n"
116 " -h|--cmd-help List available commands\n"
117 " -h|--cmd-help cmd Display detailed help on 'cmd'\n"
118 " -a|--add image Add image\n"
119 " -D|--no-dest-paths Don't tab-complete paths from guest fs\n"
120 " -f|--file file Read commands from file\n"
121 " -i|--inspector Run virt-inspector to get disk mountpoints\n"
122 " --listen Listen for remote commands\n"
123 " -m|--mount dev[:mnt] Mount dev on mnt (if omitted, /)\n"
124 " -n|--no-sync Don't autosync\n"
125 " -N|--new type Create prepared disk (test1.img, ...)\n"
126 " --remote[=pid] Send commands to remote %s\n"
127 " -r|--ro Mount read-only\n"
128 " --selinux Enable SELinux support\n"
129 " -v|--verbose Verbose messages\n"
130 " -x Echo each command before executing it\n"
131 " -V|--version Display version and exit\n"
132 "For more information, see the manpage %s(1).\n"),
133 program_name, program_name, program_name,
134 program_name, program_name, program_name,
135 program_name, program_name, program_name);
141 main (int argc, char *argv[])
143 /* Set global program name that is not polluted with libtool artifacts. */
144 set_program_name (argv[0]);
146 atexit (close_stdout);
148 setlocale (LC_ALL, "");
149 bindtextdomain (PACKAGE, LOCALEBASEDIR);
150 textdomain (PACKAGE);
152 enum { HELP_OPTION = CHAR_MAX + 1 };
154 static const char *options = "a:Df:h::im:nN:rv?Vx";
155 static const struct option long_options[] = {
156 { "add", 1, 0, 'a' },
157 { "cmd-help", 2, 0, 'h' },
158 { "file", 1, 0, 'f' },
159 { "help", 0, 0, HELP_OPTION },
160 { "inspector", 0, 0, 'i' },
161 { "listen", 0, 0, 0 },
162 { "mount", 1, 0, 'm' },
163 { "new", 1, 0, 'N' },
164 { "no-dest-paths", 0, 0, 'D' },
165 { "no-sync", 0, 0, 'n' },
166 { "remote", 2, 0, 0 },
168 { "selinux", 0, 0, 0 },
169 { "verbose", 0, 0, 'v' },
170 { "version", 0, 0, 'V' },
173 struct drv *drvs = NULL;
175 struct mp *mps = NULL;
177 char *p, *file = NULL;
182 char next_drive = 'a';
183 int next_prepared_drive = 1;
185 initialize_readline ();
187 memset (&sa, 0, sizeof sa);
188 sa.sa_handler = SIG_IGN;
189 sa.sa_flags = SA_RESTART;
190 sigaction (SIGPIPE, &sa, NULL);
192 /* guestfs_create is meant to be a lightweight operation, so
193 * it's OK to do it early here.
195 g = guestfs_create ();
197 fprintf (stderr, _("guestfs_create: failed to create handle\n"));
201 guestfs_set_autosync (g, 1);
203 /* If developing, add ./appliance to the path. Note that libtools
204 * interferes with this because uninstalled guestfish is a shell
205 * script that runs the real program with an absolute path. Detect
208 * BUT if LIBGUESTFS_PATH environment variable is already set by
209 * the user, then don't override it.
211 if (getenv ("LIBGUESTFS_PATH") == NULL &&
213 (argv[0][0] != '/' || strstr (argv[0], "/.libs/lt-") != NULL))
214 guestfs_set_path (g, "appliance:" GUESTFS_DEFAULT_PATH);
216 /* CAUTION: we are careful to modify argv[0] here, only after
217 * using it just above.
219 * getopt_long uses argv[0], so give it the sanitized name. Save a copy
220 * of the original, in case it's needed in virt-inspector mode, below.
222 char *real_argv0 = argv[0];
223 argv[0] = bad_cast (program_name);
226 c = getopt_long (argc, argv, options, long_options, &option_index);
230 case 0: /* options which are long only */
231 if (STREQ (long_options[option_index].name, "listen"))
232 remote_control_listen = 1;
233 else if (STREQ (long_options[option_index].name, "remote")) {
235 if (sscanf (optarg, "%d", &remote_control) != 1) {
236 fprintf (stderr, _("%s: --listen=PID: PID was not a number: %s\n"),
237 program_name, optarg);
241 p = getenv ("GUESTFISH_PID");
242 if (!p || sscanf (p, "%d", &remote_control) != 1) {
243 fprintf (stderr, _("%s: remote: $GUESTFISH_PID must be set"
244 " to the PID of the remote process\n"),
249 } else if (STREQ (long_options[option_index].name, "selinux")) {
250 guestfs_set_selinux (g, 1);
252 fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
253 program_name, long_options[option_index].name, option_index);
259 if (access (optarg, R_OK) != 0) {
263 drv = malloc (sizeof (struct drv));
268 drv->filename = optarg;
270 /* We could fill the device field in, but in fact we
271 * only use it for the -N option at present.
280 if (STRCASEEQ (optarg, "list")) {
281 list_prepared_drives ();
284 drv = malloc (sizeof (struct drv));
289 if (asprintf (&drv->filename, "test%d.img",
290 next_prepared_drive++) == -1) {
294 drv->data = create_prepared_file (optarg, drv->filename);
295 if (asprintf (&drv->device, "/dev/sd%c", next_drive++) == -1) {
304 complete_dest_paths = 0;
309 fprintf (stderr, _("%s: only one -f parameter can be given\n"),
318 display_command (optarg);
319 else if (argv[optind] && argv[optind][0] != '-')
320 display_command (argv[optind++]);
330 mp = malloc (sizeof (struct mp));
335 p = strchr (optarg, ':');
338 mp->mountpoint = p+1;
340 mp->mountpoint = bad_cast ("/");
347 guestfs_set_autosync (g, 0);
356 guestfs_set_verbose (g, verbose);
360 printf ("%s %s\n", program_name, PACKAGE_VERSION);
368 usage (EXIT_SUCCESS);
371 usage (EXIT_FAILURE);
375 /* Inspector mode invalidates most of the other arguments. */
380 if (drvs || mps || remote_control_listen || remote_control ||
381 guestfs_get_selinux (g)) {
382 fprintf (stderr, _("%s: cannot use -i option with -a, -m, -N, "
383 "--listen, --remote or --selinux\n"),
387 if (optind >= argc) {
389 _("%s: -i requires a libvirt domain or path(s) to disk image(s)\n"),
394 strcpy (cmd, "a=`virt-inspector");
395 while (optind < argc) {
396 if (strlen (cmd) + strlen (argv[optind]) + strlen (real_argv0) + 60
399 _("%s: virt-inspector command too long for fixed-size buffer\n"),
404 strcat (cmd, argv[optind]);
410 strcat (cmd, " --ro-fish");
412 strcat (cmd, " --fish");
414 sprintf (&cmd[strlen(cmd)], "` && %s $a", real_argv0);
416 if (guestfs_get_verbose (g))
418 if (!guestfs_get_autosync (g))
423 "%s -i: running virt-inspector command:\n%s\n", program_name, cmd);
430 exit (WEXITSTATUS (r));
433 /* If we've got drives to add, add them now. */
436 /* If we've got mountpoints or prepared drives, we must launch the
437 * guest and mount them.
439 if (next_prepared_drive > 1 || mps != NULL) {
440 if (launch (g) == -1) exit (EXIT_FAILURE);
441 prepare_drives (drvs);
445 /* Remote control? */
446 if (remote_control_listen && remote_control) {
448 _("%s: cannot use --listen and --remote options at the same time\n"),
453 if (remote_control_listen) {
456 _("%s: extra parameters on the command line with --listen flag\n"),
462 _("%s: cannot use --listen and --file options at the same time\n"),
469 /* -f (file) parameter? */
472 if (open (file, O_RDONLY) == -1) {
478 /* Interactive, shell script, or command(s) on the command line? */
479 if (optind >= argc) {
486 cmdline (argv, optind, argc);
494 pod2text (const char *name, const char *shortdesc, const char *str)
498 fp = popen ("pod2text", "w");
500 /* pod2text failed, maybe not found, so let's just print the
501 * source instead, since that's better than doing nothing.
503 printf ("%s - %s\n\n%s\n", name, shortdesc, str);
506 fprintf (fp, "=head1 NAME\n\n%s - %s\n\n", name, shortdesc);
511 /* List is built in reverse order, so mount them in reverse order. */
513 mount_mps (struct mp *mp)
518 mount_mps (mp->next);
520 /* Don't use guestfs_mount here because that will default to mount
521 * options -o sync,noatime. For more information, see guestfs(3)
522 * section "LIBGUESTFS GOTCHAS".
524 const char *options = read_only ? "ro" : "";
525 r = guestfs_mount_options (g, options, mp->device, mp->mountpoint);
532 add_drives (struct drv *drv)
537 add_drives (drv->next);
539 if (drv->data /* -N option is not affected by --ro */ || !read_only)
540 r = guestfs_add_drive (g, drv->filename);
542 r = guestfs_add_drive_ro (g, drv->filename);
549 prepare_drives (struct drv *drv)
552 prepare_drives (drv->next);
554 prepare_drive (drv->filename, drv->data, drv->device);
570 #define FISH "><fs> "
572 static char *line_read = NULL;
577 #ifdef HAVE_LIBREADLINE
585 line_read = readline (prompt ? FISH : "");
587 if (line_read && *line_read)
588 add_history_line (line_read);
593 #endif /* HAVE_LIBREADLINE */
595 static char buf[8192];
598 if (prompt) printf (FISH);
599 line_read = fgets (buf, sizeof buf, stdin);
602 len = strlen (line_read);
603 if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0';
617 int global_exit_on_error = !prompt;
622 "Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
623 "editing virtual machine filesystems.\n"
625 "Type: 'help' for a list of commands\n"
626 " 'man' to read the manual\n"
627 " 'quit' to quit the shell\n"
633 exit_on_error = global_exit_on_error;
635 buf = rl_gets (prompt);
641 /* Skip any initial whitespace before the command. */
643 while (*buf && c_isspace (*buf))
648 /* If the next character is '#' then this is a comment. */
649 if (*buf == '#') continue;
651 /* If the next character is '!' then pass the whole lot to system(3). */
659 (WTERMSIG (r) == SIGINT || WTERMSIG (r) == SIGQUIT)) ||
660 WEXITSTATUS (r) != 0)
666 /* If the next character is '-' allow the command to fail without
667 * exiting on error (just for this one command though).
675 /* Get the command (cannot be quoted). */
676 len = strcspn (buf, " \t");
678 if (len == 0) continue;
682 if (buf[len] == '\0') {
689 p += strspn (p, " \t");
691 /* Get the parameters. */
692 while (*p && i < sizeof argv / sizeof argv[0]) {
695 /* Parameters which start with quotes or pipes are treated
696 * specially. Bare parameters are delimited by whitespace.
700 len = strcspn (p, "\"");
701 if (p[len] == '\0') {
702 fprintf (stderr, _("%s: unterminated double quote\n"), program_name);
703 if (exit_on_error) exit (EXIT_FAILURE);
706 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
708 _("%s: command arguments not separated by whitespace\n"),
710 if (exit_on_error) exit (EXIT_FAILURE);
714 pend = p[len+1] ? &p[len+2] : &p[len+1];
715 } else if (*p == '\'') {
717 len = strcspn (p, "'");
718 if (p[len] == '\0') {
719 fprintf (stderr, _("%s: unterminated single quote\n"), program_name);
720 if (exit_on_error) exit (EXIT_FAILURE);
723 if (p[len+1] && (p[len+1] != ' ' && p[len+1] != '\t')) {
725 _("%s: command arguments not separated by whitespace\n"),
727 if (exit_on_error) exit (EXIT_FAILURE);
731 pend = p[len+1] ? &p[len+2] : &p[len+1];
732 } else if (*p == '|') {
737 } else if (*p == '[') {
741 while (*pend && c != 0) {
742 if (*pend == '[') c++;
743 else if (*pend == ']') c--;
748 _("%s: unterminated \"[...]\" sequence\n"), program_name);
749 if (exit_on_error) exit (EXIT_FAILURE);
752 if (*pend && (*pend != ' ' && *pend != '\t')) {
754 _("%s: command arguments not separated by whitespace\n"),
756 if (exit_on_error) exit (EXIT_FAILURE);
761 } else if (*p != ' ' && *p != '\t') {
762 /* If the first character is a ~ then note that this parameter
763 * is a candidate for ~username expansion. NB this does not
764 * apply to quoted parameters.
766 tilde_candidate = *p == '~';
767 len = strcspn (p, " \t");
774 fprintf (stderr, _("%s: internal error parsing string at '%s'\n"),
779 if (!tilde_candidate)
782 argv[i] = try_tilde_expansion (p);
787 p += strspn (p, " \t");
790 if (i == sizeof argv / sizeof argv[0]) {
791 fprintf (stderr, _("%s: too many arguments\n"), program_name);
792 if (exit_on_error) exit (EXIT_FAILURE);
799 if (issue_command (cmd, argv, pipe) == -1) {
800 if (exit_on_error) exit (EXIT_FAILURE);
805 if (prompt) printf ("\n");
809 cmdline (char *argv[], int optind, int argc)
816 if (optind >= argc) return;
818 cmd = argv[optind++];
819 if (STREQ (cmd, ":")) {
820 fprintf (stderr, _("%s: empty command on command line\n"), program_name);
824 /* Allow -cmd on the command line to mean (temporarily) override
825 * the normal exit on error (RHBZ#578407).
832 params = &argv[optind];
834 /* Search for end of command list or ":" ... */
835 while (optind < argc && STRNEQ (argv[optind], ":"))
838 if (optind == argc) {
839 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
843 if (issue_command (cmd, params, NULL) == -1 && exit_on_error)
845 cmdline (argv, optind+1, argc);
850 issue_command (const char *cmd, char *argv[], const char *pipecmd)
853 int stdout_saved_fd = -1;
857 /* This counts the commands issued, starting at 1. */
862 for (i = 0; argv[i] != NULL; ++i)
863 printf (" %s", argv[i]);
867 /* For | ... commands. Annoyingly we can't use popen(3) here. */
871 if (fflush (stdout) == EOF) {
872 perror ("failed to flush standard output");
876 perror ("pipe failed");
885 if (pid == 0) { /* Child process. */
887 if (dup2 (fd[0], 0) < 0) {
888 perror ("dup2 of stdin failed");
892 r = system (pipecmd);
897 _exit (WEXITSTATUS (r));
900 if ((stdout_saved_fd = dup (1)) < 0) {
901 perror ("failed to dup stdout");
905 if (dup2 (fd[1], 1) < 0) {
906 perror ("failed to dup stdout");
907 close (stdout_saved_fd);
913 for (argc = 0; argv[argc] != NULL; ++argc)
916 /* If --remote was set, then send this command to a remote process. */
918 r = rc_remote (remote_control, cmd, argc, argv, exit_on_error);
920 /* Otherwise execute it locally. */
921 else if (STRCASEEQ (cmd, "help")) {
925 display_command (argv[0]);
928 else if (STRCASEEQ (cmd, "quit") ||
929 STRCASEEQ (cmd, "exit") ||
930 STRCASEEQ (cmd, "q")) {
934 else if (STRCASEEQ (cmd, "alloc") ||
935 STRCASEEQ (cmd, "allocate"))
936 r = do_alloc (cmd, argc, argv);
937 else if (STRCASEEQ (cmd, "echo"))
938 r = do_echo (cmd, argc, argv);
939 else if (STRCASEEQ (cmd, "edit") ||
940 STRCASEEQ (cmd, "vi") ||
941 STRCASEEQ (cmd, "emacs"))
942 r = do_edit (cmd, argc, argv);
943 else if (STRCASEEQ (cmd, "lcd"))
944 r = do_lcd (cmd, argc, argv);
945 else if (STRCASEEQ (cmd, "glob"))
946 r = do_glob (cmd, argc, argv);
947 else if (STRCASEEQ (cmd, "man") ||
948 STRCASEEQ (cmd, "manual"))
949 r = do_man (cmd, argc, argv);
950 else if (STRCASEEQ (cmd, "more") ||
951 STRCASEEQ (cmd, "less"))
952 r = do_more (cmd, argc, argv);
953 else if (STRCASEEQ (cmd, "reopen"))
954 r = do_reopen (cmd, argc, argv);
955 else if (STRCASEEQ (cmd, "sparse"))
956 r = do_sparse (cmd, argc, argv);
957 else if (STRCASEEQ (cmd, "time"))
958 r = do_time (cmd, argc, argv);
960 r = run_action (cmd, argc, argv);
962 /* Always flush stdout after every command, so that messages, results
963 * etc appear immediately.
965 if (fflush (stdout) == EOF) {
966 perror ("failed to flush standard output");
972 if (dup2 (stdout_saved_fd, 1) < 0) {
973 perror ("failed to dup2 standard output");
976 close (stdout_saved_fd);
977 if (waitpid (pid, NULL, 0) < 0) {
978 perror ("waiting for command to complete");
987 list_builtin_commands (void)
989 /* help, man and quit should appear at the top */
990 printf ("%-20s %s\n",
991 "help", _("display a list of commands or help on a command"));
992 printf ("%-20s %s\n",
993 "man", _("read the manual"));
994 printf ("%-20s %s\n",
995 "quit", _("quit guestfish"));
997 printf ("%-20s %s\n",
998 "alloc", _("allocate an image"));
999 printf ("%-20s %s\n",
1000 "echo", _("display a line of text"));
1001 printf ("%-20s %s\n",
1002 "edit", _("edit a file in the image"));
1003 printf ("%-20s %s\n",
1004 "lcd", _("local change directory"));
1005 printf ("%-20s %s\n",
1006 "glob", _("expand wildcards in command"));
1007 printf ("%-20s %s\n",
1008 "more", _("view a file in the pager"));
1009 printf ("%-20s %s\n",
1010 "reopen", _("close and reopen libguestfs handle"));
1011 printf ("%-20s %s\n",
1012 "sparse", _("allocate a sparse image file"));
1013 printf ("%-20s %s\n",
1014 "time", _("measure time taken to run command"));
1016 /* actions are printed after this (see list_commands) */
1020 display_builtin_command (const char *cmd)
1022 /* help for actions is auto-generated, see display_command */
1024 if (STRCASEEQ (cmd, "alloc") ||
1025 STRCASEEQ (cmd, "allocate"))
1026 printf (_("alloc - allocate an image\n"
1027 " alloc <filename> <size>\n"
1029 " This creates an empty (zeroed) file of the given size,\n"
1030 " and then adds so it can be further examined.\n"
1032 " For more advanced image creation, see qemu-img utility.\n"
1034 " Size can be specified (where <nn> means a number):\n"
1035 " <nn> number of kilobytes\n"
1036 " eg: 1440 standard 3.5\" floppy\n"
1037 " <nn>K or <nn>KB number of kilobytes\n"
1038 " <nn>M or <nn>MB number of megabytes\n"
1039 " <nn>G or <nn>GB number of gigabytes\n"
1040 " <nn>T or <nn>TB number of terabytes\n"
1041 " <nn>P or <nn>PB number of petabytes\n"
1042 " <nn>E or <nn>EB number of exabytes\n"
1043 " <nn>sects number of 512 byte sectors\n"));
1044 else if (STRCASEEQ (cmd, "echo"))
1045 printf (_("echo - display a line of text\n"
1046 " echo [<params> ...]\n"
1048 " This echos the parameters to the terminal.\n"));
1049 else if (STRCASEEQ (cmd, "edit") ||
1050 STRCASEEQ (cmd, "vi") ||
1051 STRCASEEQ (cmd, "emacs"))
1052 printf (_("edit - edit a file in the image\n"
1053 " edit <filename>\n"
1055 " This is used to edit a file.\n"
1057 " It is the equivalent of (and is implemented by)\n"
1058 " running \"cat\", editing locally, and then \"write-file\".\n"
1060 " Normally it uses $EDITOR, but if you use the aliases\n"
1061 " \"vi\" or \"emacs\" you will get those editors.\n"
1063 " NOTE: This will not work reliably for large files\n"
1064 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1065 else if (STRCASEEQ (cmd, "lcd"))
1066 printf (_("lcd - local change directory\n"
1067 " lcd <directory>\n"
1069 " Change guestfish's current directory. This command is\n"
1070 " useful if you want to download files to a particular\n"
1072 else if (STRCASEEQ (cmd, "glob"))
1073 printf (_("glob - expand wildcards in command\n"
1074 " glob <command> [<args> ...]\n"
1076 " Glob runs <command> with wildcards expanded in any\n"
1077 " command args. Note that the command is run repeatedly\n"
1078 " once for each expanded argument.\n"));
1079 else if (STRCASEEQ (cmd, "man") ||
1080 STRCASEEQ (cmd, "manual"))
1081 printf (_("man - read the manual\n"
1084 " Opens the manual page for guestfish.\n"));
1085 else if (STRCASEEQ (cmd, "help"))
1086 printf (_("help - display a list of commands or help on a command\n"
1089 else if (STRCASEEQ (cmd, "more") ||
1090 STRCASEEQ (cmd, "less"))
1091 printf (_("more - view a file in the pager\n"
1092 " more <filename>\n"
1094 " This is used to view a file in the pager.\n"
1096 " It is the equivalent of (and is implemented by)\n"
1097 " running \"cat\" and using the pager.\n"
1099 " Normally it uses $PAGER, but if you use the alias\n"
1100 " \"less\" then it always uses \"less\".\n"
1102 " NOTE: This will not work reliably for large files\n"
1103 " (> 2 MB) or binary files containing \\0 bytes.\n"));
1104 else if (STRCASEEQ (cmd, "quit") ||
1105 STRCASEEQ (cmd, "exit") ||
1106 STRCASEEQ (cmd, "q"))
1107 printf (_("quit - quit guestfish\n"
1109 else if (STRCASEEQ (cmd, "reopen"))
1110 printf (_("reopen - close and reopen the libguestfs handle\n"
1113 "Close and reopen the libguestfs handle. It is not necessary to use\n"
1114 "this normally, because the handle is closed properly when guestfish\n"
1115 "exits. However this is occasionally useful for testing.\n"));
1116 else if (STRCASEEQ (cmd, "sparse"))
1117 printf (_("sparse - allocate a sparse image file\n"
1118 " sparse <filename> <size>\n"
1120 " This creates an empty sparse file of the given size,\n"
1121 " and then adds so it can be further examined.\n"
1123 " In all respects it works the same as the 'alloc'\n"
1124 " command, except that the image file is allocated\n"
1125 " sparsely, which means that disk blocks are not assigned\n"
1126 " to the file until they are needed. Sparse disk files\n"
1127 " only use space when written to, but they are slower\n"
1128 " and there is a danger you could run out of real disk\n"
1129 " space during a write operation.\n"
1131 " For more advanced image creation, see qemu-img utility.\n"
1133 " Size can be specified (where <nn> means a number):\n"
1134 " <nn> number of kilobytes\n"
1135 " eg: 1440 standard 3.5\" floppy\n"
1136 " <nn>K or <nn>KB number of kilobytes\n"
1137 " <nn>M or <nn>MB number of megabytes\n"
1138 " <nn>G or <nn>GB number of gigabytes\n"
1139 " <nn>T or <nn>TB number of terabytes\n"
1140 " <nn>P or <nn>PB number of petabytes\n"
1141 " <nn>E or <nn>EB number of exabytes\n"
1142 " <nn>sects number of 512 byte sectors\n"));
1143 else if (STRCASEEQ (cmd, "time"))
1144 printf (_("time - measure time taken to run command\n"
1145 " time <command> [<args> ...]\n"
1147 " This runs <command> as usual, and prints the elapsed\n"
1148 " time afterwards.\n"));
1150 fprintf (stderr, _("%s: command not known, use -h to list all commands\n"),
1154 /* This is printed when the user types in an unknown command for the
1155 * first command issued. A common case is the user doing:
1156 * guestfish disk.img
1157 * expecting guestfish to open 'disk.img' (in fact, this tried to
1158 * run a command 'disk.img').
1161 extended_help_message (void)
1164 _("Did you mean to open a disk image? guestfish -a disk.img\n"
1165 "For a list of commands: guestfish -h\n"
1166 "For complete documentation: man guestfish\n"));
1170 free_strings (char **argv)
1174 for (argc = 0; argv[argc] != NULL; ++argc)
1180 count_strings (char *const *argv)
1184 for (c = 0; argv[c]; ++c)
1190 print_strings (char *const *argv)
1194 for (argc = 0; argv[argc] != NULL; ++argc)
1195 printf ("%s\n", argv[argc]);
1199 print_table (char *const *argv)
1203 for (i = 0; argv[i] != NULL; i += 2)
1204 printf ("%s: %s\n", argv[i], argv[i+1]);
1208 is_true (const char *str)
1211 STRCASENEQ (str, "0") &&
1212 STRCASENEQ (str, "f") &&
1213 STRCASENEQ (str, "false") &&
1214 STRCASENEQ (str, "n") &&
1215 STRCASENEQ (str, "no");
1218 /* Free strings from a non-NULL terminated char** */
1220 free_n_strings (char **str, size_t len)
1224 for (i = 0; i < len; i++) {
1231 parse_string_list (const char *str)
1234 size_t argv_len = 0;
1236 /* Current position pointer */
1237 const char *p = str;
1239 /* Token might be simple:
1242 * 'This is a single token'
1243 * or contain embedded single-quoted sections:
1244 * This' is a sing'l'e to'ken
1246 * The latter may seem over-complicated, but it's what a normal shell does.
1247 * Not doing it risks surprising somebody.
1249 * This outer loop is over complete tokens.
1255 /* Skip leading whitespace */
1256 p += strspn (p, " \t");
1260 /* This loop is over token 'fragments'. A token can be in multiple bits if
1261 * it contains single quotes. We also treat both sides of an escaped quote
1262 * as separate fragments because we can't just copy it: we have to remove
1265 while (*p && (!c_isblank (*p) || in_quote)) {
1266 const char *end = p;
1268 /* Check if the fragment starts with a quote */
1270 /* Toggle in_quote */
1271 in_quote = !in_quote;
1273 /* Skip the quote */
1277 /* If we're in a quote, look for an end quote */
1279 end += strcspn (end, "'");
1282 /* Otherwise, look for whitespace or a quote */
1284 end += strcspn (end, " \t'");
1287 /* Grow the token to accommodate the fragment */
1288 size_t tok_end = tok_len;
1290 char *tok_new = realloc (tok, tok_len + 1);
1291 if (NULL == tok_new) {
1293 free_n_strings (argv, argv_len);
1295 exit (EXIT_FAILURE);
1299 /* Check if we stopped on an escaped quote */
1300 if ('\'' == *end && end != p && *(end-1) == '\\') {
1301 /* Add everything before \' to the token */
1302 memcpy (&tok[tok_end], p, end - p - 1);
1305 tok[tok_len-1] = '\'';
1307 /* Already processed the quote */
1312 /* Add the whole fragment */
1313 memcpy (&tok[tok_end], p, end - p);
1319 /* We've reached the end of a token. We shouldn't still be in quotes. */
1321 fprintf (stderr, _("Runaway quote in string \"%s\"\n"), str);
1323 free_n_strings (argv, argv_len);
1328 /* Add this token if there is one. There might not be if there was
1329 * whitespace at the end of the input string */
1331 /* Add the NULL terminator */
1332 tok[tok_len] = '\0';
1334 /* Add the argument to the argument list */
1336 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1337 if (NULL == argv_new) {
1339 free_n_strings (argv, argv_len-1);
1341 exit (EXIT_FAILURE);
1345 argv[argv_len-1] = tok;
1349 /* NULL terminate the argument list */
1351 char **argv_new = realloc (argv, sizeof (*argv) * argv_len);
1352 if (NULL == argv_new) {
1354 free_n_strings (argv, argv_len-1);
1355 exit (EXIT_FAILURE);
1359 argv[argv_len-1] = NULL;
1364 #ifdef HAVE_LIBREADLINE
1365 static char histfile[1024];
1366 static int nr_history_lines = 0;
1370 initialize_readline (void)
1372 #ifdef HAVE_LIBREADLINE
1375 home = getenv ("HOME");
1377 snprintf (histfile, sizeof histfile, "%s/.guestfish", home);
1379 (void) read_history (histfile);
1382 rl_readline_name = "guestfish";
1383 rl_attempted_completion_function = do_completion;
1388 cleanup_readline (void)
1390 #ifdef HAVE_LIBREADLINE
1393 if (histfile[0] != '\0') {
1394 fd = open (histfile, O_WRONLY|O_CREAT, 0644);
1401 #ifdef HAVE_APPEND_HISTORY
1402 (void) append_history (nr_history_lines, histfile);
1404 (void) write_history (histfile);
1411 add_history_line (const char *line)
1413 #ifdef HAVE_LIBREADLINE
1420 xwrite (int fd, const void *v_buf, size_t len)
1423 const char *buf = v_buf;
1426 r = write (fd, buf, len);
1438 /* Resolve the special "win:..." form for Windows-specific paths.
1439 * This always returns a newly allocated string which is freed by the
1440 * caller function in "cmds.c".
1443 resolve_win_path (const char *path)
1448 if (STRCASENEQLEN (path, "win:", 4)) {
1449 ret = strdup (path);
1457 /* Drop drive letter, if it's "C:". */
1458 if (STRCASEEQLEN (path, "c:", 2))
1468 ret = strdup (path);
1474 /* Blindly convert any backslashes into forward slashes. Is this good? */
1475 for (i = 0; i < strlen (ret); ++i)
1479 char *t = guestfs_case_sensitive_path (g, ret);
1486 /* Resolve the special FileIn paths ("-" or "-<<END" or filename).
1487 * The caller (cmds.c) will call free_file_in after the command has
1488 * run which should clean up resources.
1490 static char *file_in_heredoc (const char *endmarker);
1491 static char *file_in_tmpfile = NULL;
1494 file_in (const char *arg)
1498 if (STREQ (arg, "-")) {
1499 ret = strdup ("/dev/stdin");
1505 else if (STRPREFIX (arg, "-<<")) {
1506 const char *endmarker = &arg[3];
1507 if (*endmarker == '\0') {
1508 fprintf (stderr, "%s: missing end marker in -<< expression\n",
1512 ret = file_in_heredoc (endmarker);
1528 file_in_heredoc (const char *endmarker)
1530 static const char template[] = "/tmp/heredocXXXXXX";
1531 file_in_tmpfile = strdup (template);
1532 if (file_in_tmpfile == NULL) {
1537 int fd = mkstemp (file_in_tmpfile);
1543 size_t markerlen = strlen (endmarker);
1545 char buffer[BUFSIZ];
1546 int write_error = 0;
1547 while (fgets (buffer, sizeof buffer, stdin) != NULL) {
1548 /* Look for "END"<EOF> or "END\n" in input. */
1549 size_t blen = strlen (buffer);
1550 if (STREQLEN (buffer, endmarker, markerlen) &&
1551 (blen == markerlen ||
1552 (blen == markerlen+1 && buffer[markerlen] == '\n')))
1555 if (xwrite (fd, buffer, blen) == -1) {
1556 if (!write_error) perror ("write");
1558 /* continue reading up to the end marker */
1562 /* Reached EOF of stdin without finding the end marker, which
1563 * is likely to be an error.
1565 fprintf (stderr, "%s: end of input reached without finding '%s'\n",
1566 program_name, endmarker);
1575 if (close (fd) == -1) {
1580 return file_in_tmpfile;
1583 unlink (file_in_tmpfile);
1586 free (file_in_tmpfile);
1587 file_in_tmpfile = NULL;
1592 free_file_in (char *s)
1594 if (file_in_tmpfile) {
1595 if (unlink (file_in_tmpfile) == -1)
1596 perror (file_in_tmpfile);
1597 file_in_tmpfile = NULL;
1600 /* Free the device or file name which was strdup'd in file_in().
1601 * Note it's not immediately clear, but for -<< heredocs,
1602 * s == file_in_tmpfile, so this frees up that buffer.
1607 /* Resolve the special FileOut paths ("-" or filename).
1608 * The caller (cmds.c) will call free (str) after the command has run.
1611 file_out (const char *arg)
1615 if (STREQ (arg, "-"))
1616 ret = strdup ("/dev/stdout");