/* guestfish - the filesystem interactive shell * Copyright (C) 2009 Red Hat Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #include #include #include #include #include #include #include #include #include #include #include "fish.h" struct mp { struct mp *next; char *device; char *mountpoint; }; static void mount_mps (struct mp *mp); static void interactive (void); static void shell_script (void); static void script (int prompt); static void cmdline (char *argv[], int optind, int argc); static int issue_command (const char *cmd, char *argv[]); static int parse_size (const char *str, off_t *size_rtn); /* Currently open libguestfs handle. */ guestfs_h *g; int g_launched = 0; int quit = 0; int verbose = 0; int launch (guestfs_h *_g) { assert (_g == g); if (!g_launched) { if (guestfs_launch (g) == -1) return -1; if (guestfs_wait_ready (g) == -1) return -1; g_launched = 1; } return 0; } static void usage (void) { fprintf (stderr, "guestfish: guest filesystem shell\n" "guestfish lets you edit virtual machine filesystems\n" "Copyright (C) 2009 Red Hat Inc.\n" "Usage:\n" " guestfish [--options] cmd [: cmd : cmd ...]\n" "or for interactive use:\n" " guestfish\n" "or from a shell script:\n" " guestfish <mountpoint = p+1; } else mp->mountpoint = "/"; mp->device = optarg; mp->next = mps; mps = mp; break; case 'n': guestfs_set_autosync (g, 0); break; case 'v': verbose++; guestfs_set_verbose (g, verbose); break; case '?': usage (); exit (0); default: fprintf (stderr, "guestfish: unexpected command line option 0x%x\n", c); exit (1); } } /* If we've got mountpoints, we must launch the guest and mount them. */ if (mps != NULL) { if (launch (g) == -1) exit (1); mount_mps (mps); } /* Interactive, shell script, or command(s) on the command line? */ if (optind >= argc) { if (isatty (0)) interactive (); else shell_script (); } else cmdline (argv, optind, argc); exit (0); } void pod2text (const char *heading, const char *str) { FILE *fp; fp = popen ("pod2text", "w"); if (fp == NULL) { /* pod2text failed, maybe not found, so let's just print the * source instead, since that's better than doing nothing. */ printf ("%s\n\n%s\n", heading, str); return; } fputs ("=head1 ", fp); fputs (heading, fp); fputs ("\n\n", fp); fputs (str, fp); pclose (fp); } /* List is built in reverse order, so mount them in reverse order. */ static void mount_mps (struct mp *mp) { if (mp) { mount_mps (mp->next); if (guestfs_mount (g, mp->device, mp->mountpoint) == -1) exit (1); } } static void interactive (void) { script (1); } static void shell_script (void) { script (0); } static void script (int prompt) { char buf[8192]; char *cmd; char *argv[64]; int len, i; if (prompt) printf ("\n" "Welcome to guestfish, the libguestfs filesystem interactive shell for\n" "editing virtual machine filesystems.\n" "\n" "Type: 'help' for help with commands\n" " 'quit' to quit the shell\n" "\n"); while (!quit) { if (prompt) printf ("> "); if (fgets (buf, sizeof buf, stdin) == NULL) { quit = 1; break; } len = strlen (buf); if (len > 0 && buf[len-1] == '\n') buf[len-1] = '\0'; /* Split the buffer up at whitespace. */ cmd = strtok (buf, " \t"); if (cmd == NULL) continue; i = 0; while (i < sizeof argv / sizeof argv[0] && (argv[i] = strtok (NULL, " \t")) != NULL) i++; if (i == sizeof argv / sizeof argv[0]) { fprintf (stderr, "guestfish: too many arguments in command\n"); exit (1); } if (issue_command (cmd, argv) == -1) { if (!prompt) exit (1); } } if (prompt) printf ("\n"); } static void cmdline (char *argv[], int optind, int argc) { const char *cmd; char **params; if (optind >= argc) return; cmd = argv[optind++]; if (strcmp (cmd, ":") == 0) { fprintf (stderr, "guestfish: empty command on command line\n"); exit (1); } params = &argv[optind]; /* Search for end of command list or ":" ... */ while (optind < argc && strcmp (argv[optind], ":") != 0) optind++; if (optind == argc) { if (issue_command (cmd, params) == -1) exit (1); } else { argv[optind] = NULL; if (issue_command (cmd, params) == -1) exit (1); cmdline (argv, optind+1, argc); } } static int issue_command (const char *cmd, char *argv[]) { int argc; for (argc = 0; argv[argc] != NULL; ++argc) ; if (strcasecmp (cmd, "help") == 0) { if (argc == 0) list_commands (); else display_command (argv[0]); return 0; } else if (strcasecmp (cmd, "quit") == 0 || strcasecmp (cmd, "exit") == 0 || strcasecmp (cmd, "q") == 0) { quit = 1; return 0; } else if (strcasecmp (cmd, "alloc") == 0 || strcasecmp (cmd, "allocate") == 0) { if (argc != 2) { fprintf (stderr, "use 'alloc file size' to create an image\n"); return -1; } else { off_t size; int fd; if (parse_size (argv[1], &size) == -1) return -1; if (g_launched) { fprintf (stderr, "can't allocate or add disks after launching\n"); return -1; } fd = open (argv[0], O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666); if (fd == -1) { perror (argv[0]); return -1; } if (posix_fallocate (fd, 0, size) == -1) { perror ("fallocate"); close (fd); unlink (argv[0]); return -1; } if (close (fd) == -1) { perror (argv[0]); unlink (argv[0]); return -1; } if (guestfs_add_drive (g, argv[0]) == -1) { unlink (argv[0]); return -1; } return 0; } } else return run_action (cmd, argc, argv); } void list_builtin_commands (void) { /* help and quit should appear at the top */ printf ("%-20s %s\n", "help", "display a list of commands or help on a command"); printf ("%-20s %s\n", "quit", "quit guestfish"); printf ("%-20s %s\n", "alloc", "allocate an image"); /* actions are printed after this (see list_commands) */ } void display_builtin_command (const char *cmd) { /* help for actions is auto-generated, see display_command */ if (strcasecmp (cmd, "alloc") == 0) printf ("alloc - allocate an image\n" " alloc \n" "\n" " This creates an empty (zeroed) file of the given size,\n" " and then adds so it can be further examined.\n" "\n" " For more advanced image creation, see qemu-img utility.\n" "\n" " Size can be specified (where means a number):\n" " number of kilobytes\n" " eg: 1440 standard 3.5\" floppy\n" " K or KB number of kilobytes\n" " M or MB number of megabytes\n" " G or GB number of gigabytes\n" " sects number of 512 byte sectors\n"); else if (strcasecmp (cmd, "help") == 0) printf ("help - display a list of commands or help on a command\n" " help cmd\n" " help\n"); else if (strcasecmp (cmd, "quit") == 0) printf ("quit - quit guestfish\n" " quit\n"); else fprintf (stderr, "%s: command not known, use -h to list all commands\n", cmd); } /* Parse size parameter of alloc command. */ static int parse_size (const char *str, off_t *size_rtn) { uint64_t size; char type; /* Note that the parsing here is looser than what is specified in the * help, but we may tighten it up in future so beware. */ if (sscanf (str, "%"SCNu64"%c", &size, &type) == 2) { switch (type) { case 'k': case 'K': size *= 1024; break; case 'm': case 'M': size *= 1024 * 1024; break; case 'g': case 'G': size *= 1024 * 1024 * 1024; break; case 's': size *= 512; break; default: fprintf (stderr, "could not parse size specification '%s'\n", str); return -1; } } else if (sscanf (str, "%"SCNu64, &size) == 1) size *= 1024; else { fprintf (stderr, "could not parse size specification '%s'\n", str); return -1; } printf ("size = %lu\n", size); /* XXX 32 bit file offsets, if anyone uses them? GCC should give * a warning here anyhow. */ *size_rtn = size; return 0; } void free_strings (char **argv) { int argc; for (argc = 0; argv[argc] != NULL; ++argc) free (argv[argc]); free (argv); } void print_strings (char **argv) { int argc; for (argc = 0; argv[argc] != NULL; ++argc) printf ("%s\n", argv[argc]); } int is_true (const char *str) { return strcasecmp (str, "0") != 0 && strcasecmp (str, "f") != 0 && strcasecmp (str, "false") != 0 && strcasecmp (str, "n") != 0 && strcasecmp (str, "no") != 0; }