examples/to-xml.c

   1 /* This inspects a block device and produces an XML representation of
   2  * the partitions, LVM, filesystems that we find there.  This could be
   3  * useful as example code of how to do this sort of probing, or to
   4  * feed the XML to other programs.
   5  *
   6  * Usage:
   7  *   to-xml guest.img [guest.img ...]
   8  */
   9
  10 #if HAVE_CONFIG_H
  11 # include <config.h>
  12 #endif
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <stdint.h>
  17 #include <inttypes.h>
  18 #include <unistd.h>
  19 #include <ctype.h>
  20
  21 #include <guestfs.h>
  22
  23 /* Note that if any API call fails, we can just exit.  The
  24  * standard error handler will have printed the error message
  25  * to stderr already.
  26  */
  27 #define CALL(call,errcode)                      \
  28   if ((call) == (errcode)) exit (EXIT_FAILURE);
  29
  30 static void display_partition (guestfs_h *g, const char *dev);
  31 static void display_partitions (guestfs_h *g, const char *dev);
  32 static void display_ext234 (guestfs_h *g, const char *dev, const char *fstype);
  33
  34 int
  35 main (int argc, char *argv[])
  36 {
  37   guestfs_h *g;
  38   int i;
  39
  40   if (argc < 2 || access (argv[1], F_OK) != 0) {
  41     fprintf (stderr, "Usage: to-xml guest.img [guest.img ...]\n");
  42     exit (EXIT_FAILURE);
  43   }
  44
  45   if (!(g = guestfs_create ())) {
  46     fprintf (stderr, "Cannot create libguestfs handle.\n");
  47     exit (EXIT_FAILURE);
  48   }
  49
  50   for (i = 1; i < argc; ++i)
  51     CALL (guestfs_add_drive (g, argv[i]), -1);
  52
  53   CALL (guestfs_launch (g), -1);
  54
  55   printf ("<guestfs-system>\n");
  56
  57   /* list-devices should return the devices that we just attached?
  58    * Better to find out what the kernel thinks are devices anyway ...
  59    */
  60   char **devices;
  61   CALL (devices = guestfs_list_devices (g), NULL);
  62   printf ("<devices>\n");
  63   for (i = 0; devices[i] != NULL; ++i) {
  64     int64_t size;
  65     CALL (size = guestfs_blockdev_getsize64 (g, devices[i]), -1);
  66     printf ("<device dev=\"%s\" size=\"%" PRIi64 "\">\n", devices[i], size);
  67     display_partitions (g, devices[i]);
  68     free (devices[i]);
  69     printf ("</device>\n");
  70   }
  71   free (devices);
  72   printf ("</devices>\n");
  73
  74   /* Now do the same for VGs and LVs.  Note that a VG may span
  75    * multiple PVs / block devices, in arbitrary ways, which is
  76    * why VGs are in a separate top-level XML class.
  77    */
  78   char **vgs;
  79   char **lvs;
  80   printf ("<volgroups>\n");
  81   CALL (vgs = guestfs_vgs (g), NULL);
  82   CALL (lvs = guestfs_lvs (g), NULL);
  83   for (i = 0; vgs[i] != NULL; ++i) {
  84     printf ("<volgroup name=\"%s\">\n", vgs[i]);
  85
  86     /* Just the LVs in this VG. */
  87     int len = strlen (vgs[i]);
  88     int j;
  89     for (j = 0; lvs[j] != NULL; ++j) {
  90       if (strncmp (lvs[j], "/dev/", 5) == 0 &&
  91           strncmp (&lvs[j][5], vgs[i], len) == 0 &&
  92           lvs[j][len+5] == '/') {
  93         int64_t size;
  94         CALL (size = guestfs_blockdev_getsize64 (g, lvs[j]), -1);
  95         printf ("<logvol name=\"%s\" size=\"%" PRIi64 "\">\n", lvs[j], size);
  96         display_partition (g, lvs[j]);
  97         printf ("</logvol>\n");
  98         free (lvs[j]);
  99       }
 100     }
 101
 102     free (vgs[i]);
 103     printf ("</volgroup>\n");
 104   }
 105   free (vgs);
 106   free (lvs);
 107   printf ("</volgroups>\n");
 108
 109   guestfs_close (g);
 110   printf ("</guestfs-system>\n");
 111
 112   return 0;
 113 }
 114
 115 /* Display a partition or LV. */
 116 static void
 117 display_partition (guestfs_h *g, const char *dev)
 118 {
 119   char *what;
 120
 121   CALL (what = guestfs_file (g, dev), NULL);
 122
 123   if (strcmp (what, "x86 boot sector") == 0)
 124     /* This is what 'file' program shows for Windows/NTFS partitions. */
 125     printf ("<windows/>\n");
 126   else if (strstr (what, "boot sector") != NULL)
 127     display_partitions (g, dev);
 128   else if (strncmp (what, "LVM2", 4) == 0)
 129     printf ("<physvol/>\n");
 130   else if (strstr (what, "ext2 filesystem data") != NULL)
 131     display_ext234 (g, dev, "ext2");
 132   else if (strstr (what, "ext3 filesystem data") != NULL)
 133     display_ext234 (g, dev, "ext3");
 134   else if (strstr (what, "ext4 filesystem data") != NULL)
 135     display_ext234 (g, dev, "ext4");
 136   else if (strstr (what, "Linux/i386 swap file") != NULL)
 137     printf ("<linux-swap/>\n");
 138   else
 139     printf ("<unknown/>\n");
 140
 141   free (what);
 142 }
 143
 144 /* Display an MBR-formatted boot sector. */
 145 static void
 146 display_partitions (guestfs_h *g, const char *dev)
 147 {
 148   /* We can't look into a boot sector which is an LV or partition.
 149    * That's a limitation of sorts of the Linux kernel.  (Actually,
 150    * we could do this if we add the kpartx program to libguestfs).
 151    */
 152   if (strncmp (dev, "/dev/sd", 7) != 0 || isdigit (dev[strlen(dev)-1])) {
 153     printf ("<vm-image dev=\"%s\"/>\n", dev);
 154     return;
 155   }
 156
 157   char **parts;
 158   int i, len;
 159   CALL (parts = guestfs_list_partitions (g), NULL);
 160   printf ("<partitions>\n");
 161
 162   len = strlen (dev);
 163   for (i = 0; parts[i] != NULL; ++i) {
 164     /* Only display partition if it's in the device. */
 165     if (strncmp (parts[i], dev, len) == 0) {
 166       int64_t size;
 167       CALL (size = guestfs_blockdev_getsize64 (g, parts[i]), -1);
 168       printf ("<partition dev=\"%s\" size=\"%" PRIi64 "\">\n", parts[i], size);
 169       display_partition (g, parts[i]);
 170       printf ("</partition>\n");
 171     }
 172
 173     free (parts[i]);
 174   }
 175   free (parts);
 176   printf ("</partitions>\n");
 177 }
 178
 179 /* Display some details on the ext2/3/4 filesystem on dev. */
 180 static void
 181 display_ext234 (guestfs_h *g, const char *dev, const char *fstype)
 182 {
 183   char **sbfields;
 184   int i;
 185
 186   printf ("<fs type=\"%s\">\n", fstype);
 187   CALL (sbfields = guestfs_tune2fs_l (g, dev), NULL);
 188
 189   for (i = 0; sbfields[i] != NULL; i += 2) {
 190     /* Just pick out a few important fields to display.  There
 191      * is much more that could be displayed here.
 192      */
 193     if (strcmp (sbfields[i], "Filesystem UUID") == 0)
 194       printf ("<uuid>%s</uuid>\n", sbfields[i+1]);
 195     else if (strcmp (sbfields[i], "Block size") == 0)
 196       printf ("<blocksize>%s</blocksize>\n", sbfields[i+1]);
 197
 198     free (sbfields[i]);
 199     free (sbfields[i+1]);
 200   }
 201   free (sbfields);
 202
 203   printf ("</fs>\n");
 204 }