New API: Bind the tune2fs command.
[libguestfs.git] / daemon / ext2.c
index 85ddce5..79fd354 100644 (file)
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #include <config.h>
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <inttypes.h>
 #include <string.h>
 #include <unistd.h>
 
-#include "../src/guestfs_protocol.h"
+#include "guestfs_protocol.h"
 #include "daemon.h"
 #include "c-ctype.h"
 #include "actions.h"
 
+/* Confirmed this is true up to ext4 from the Linux sources. */
+#define EXT2_LABEL_MAX 16
+
+#define MAX_ARGS 64
+
+/* Choose which tools like mke2fs to use.  For RHEL 5 (only) there
+ * is a special set of tools which support ext2/3/4.  eg. On RHEL 5,
+ * mke2fs only supports ext2/3, but mke4fs supports ext2/3/4.
+ *
+ * We specify e4fsprogs in the package list to ensure it is loaded
+ * if it exists.
+ */
+int
+e2prog (char *name)
+{
+  char *p = strstr (name, "e2");
+  if (!p) return 0;
+  p++;
+
+  *p = '4';
+  if (prog_exists (name))
+    return 0;
+
+  *p = '2';
+  if (prog_exists (name))
+    return 0;
+
+  reply_with_error ("cannot find required program %s", name);
+  return -1;
+}
+
 char **
 do_tune2fs_l (const char *device)
 {
@@ -37,7 +69,11 @@ do_tune2fs_l (const char *device)
   char **ret = NULL;
   int size = 0, alloc = 0;
 
-  r = command (&out, &err, "/sbin/tune2fs", "-l", device, NULL);
+  char prog[] = "tune2fs";
+  if (e2prog (prog) == -1)
+    return NULL;
+
+  r = command (&out, &err, prog, "-l", device, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
     free (err);
@@ -49,7 +85,7 @@ do_tune2fs_l (const char *device)
   p = out;
 
   /* Discard the first line if it contains "tune2fs ...". */
-  if (STREQLEN (p, "tune2fs ", 8)) {
+  if (STRPREFIX (p, "tune2fs ") || STRPREFIX (p, "tune4fs ")) {
     p = strchr (p, '\n');
     if (p) p++;
     else {
@@ -121,7 +157,17 @@ do_set_e2label (const char *device, const char *label)
   int r;
   char *err;
 
-  r = command (NULL, &err, "/sbin/e2label", device, label, NULL);
+  char prog[] = "e2label";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  if (strlen (label) > EXT2_LABEL_MAX) {
+    reply_with_error ("%s: ext2 labels are limited to %d bytes",
+                      label, EXT2_LABEL_MAX);
+    return -1;
+  }
+
+  r = command (NULL, &err, prog, device, label, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
     free (err);
@@ -135,25 +181,7 @@ do_set_e2label (const char *device, const char *label)
 char *
 do_get_e2label (const char *device)
 {
-  int r, len;
-  char *out, *err;
-
-  r = command (&out, &err, "/sbin/e2label", device, NULL);
-  if (r == -1) {
-    reply_with_error ("%s", err);
-    free (out);
-    free (err);
-    return NULL;
-  }
-
-  free (err);
-
-  /* Remove any trailing \n from the label. */
-  len = strlen (out);
-  if (len > 0 && out[len-1] == '\n')
-    out[len-1] = '\0';
-
-  return out;                  /* caller frees */
+  return do_vfs_label (device);
 }
 
 int
@@ -162,7 +190,11 @@ do_set_e2uuid (const char *device, const char *uuid)
   int r;
   char *err;
 
-  r = command (NULL, &err, "/sbin/tune2fs", "-U", uuid, device, NULL);
+  char prog[] = "tune2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  r = command (NULL, &err, prog, "-U", uuid, device, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
     free (err);
@@ -176,71 +208,76 @@ do_set_e2uuid (const char *device, const char *uuid)
 char *
 do_get_e2uuid (const char *device)
 {
+  return do_vfs_uuid (device);
+}
+
+int
+do_resize2fs (const char *device)
+{
+  char *err;
   int r;
-  char *out, *err, *p, *q;
 
-  /* It's not so straightforward to get the volume UUID.  We have
-   * to use tune2fs -l and then look for a particular string in
-   * the output.
-   */
+  char prog[] = "resize2fs";
+  if (e2prog (prog) == -1)
+    return -1;
 
-  r = command (&out, &err, "/sbin/tune2fs", "-l", device, NULL);
+  r = command (NULL, &err, prog, device, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
-    free (out);
     free (err);
-    return NULL;
+    return -1;
   }
 
   free (err);
+  return 0;
+}
 
-  /* Look for /\nFilesystem UUID:\s+/ in the output. */
-  p = strstr (out, "\nFilesystem UUID:");
-  if (p == NULL) {
-    reply_with_error ("no Filesystem UUID in the output of tune2fs -l");
-    free (out);
-    return NULL;
-  }
+int
+do_resize2fs_size (const char *device, int64_t size)
+{
+  char *err;
+  int r;
 
-  p += 17;
-  while (*p && c_isspace (*p))
-    p++;
-  if (!*p) {
-    reply_with_error ("malformed Filesystem UUID in the output of tune2fs -l");
-    free (out);
-    return NULL;
-  }
+  char prog[] = "resize2fs";
+  if (e2prog (prog) == -1)
+    return -1;
 
-  /* Now 'p' hopefully points to the start of the UUID. */
-  q = p;
-  while (*q && (c_isxdigit (*q) || *q == '-'))
-    q++;
-  if (!*q) {
-    reply_with_error ("malformed Filesystem UUID in the output of tune2fs -l");
-    free (out);
-    return NULL;
+  /* resize2fs itself may impose additional limits.  Since we are
+   * going to use the 'K' suffix however we can only work with whole
+   * kilobytes.
+   */
+  if (size & 1023) {
+    reply_with_error ("%" PRIi64 ": size must be a round number of kilobytes",
+                      size);
+    return -1;
   }
+  size /= 1024;
 
-  *q = '\0';
+  char buf[32];
+  snprintf (buf, sizeof buf, "%" PRIi64 "K", size);
 
-  p = strdup (p);
-  if (!p) {
-    reply_with_perror ("strdup");
-    free (out);
-    return NULL;
+  r = command (NULL, &err, prog, device, buf, NULL);
+  if (r == -1) {
+    reply_with_error ("%s", err);
+    free (err);
+    return -1;
   }
 
-  free (out);
-  return p;                    /* caller frees */
+  free (err);
+  return 0;
 }
 
 int
-do_resize2fs (const char *device)
+do_resize2fs_M (const char *device)
 {
   char *err;
   int r;
 
-  r = command (NULL, &err, "/sbin/resize2fs", device, NULL);
+  char prog[] = "resize2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  r = command (NULL, &err, prog, "-M" , device, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
     free (err);
@@ -257,8 +294,19 @@ do_e2fsck_f (const char *device)
   char *err;
   int r;
 
-  r = command (NULL, &err, "/sbin/e2fsck", "-p", "-f", device, NULL);
-  if (r == -1) {
+  char prog[] = "e2fsck";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  /* 0 = no errors, 1 = errors corrected.
+   *
+   * >= 4 means uncorrected or other errors.
+   *
+   * 2, 3 means errors were corrected and we require a reboot.  This is
+   * a difficult corner case.
+   */
+  r = commandr (NULL, &err, prog, "-p", "-f", device, NULL);
+  if (r == -1 || r >= 2) {
     reply_with_error ("%s", err);
     free (err);
     return -1;
@@ -274,11 +322,15 @@ do_mke2journal (int blocksize, const char *device)
   char *err;
   int r;
 
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
 
   r = command (NULL, &err,
-               "/sbin/mke2fs", "-O", "journal_dev", "-b", blocksize_s,
+               prog, "-O", "journal_dev", "-b", blocksize_s,
                device, NULL);
   if (r == -1) {
     reply_with_error ("%s", err);
@@ -296,11 +348,21 @@ do_mke2journal_L (int blocksize, const char *label, const char *device)
   char *err;
   int r;
 
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  if (strlen (label) > EXT2_LABEL_MAX) {
+    reply_with_error ("%s: ext2 labels are limited to %d bytes",
+                      label, EXT2_LABEL_MAX);
+    return -1;
+  }
+
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
 
   r = command (NULL, &err,
-               "/sbin/mke2fs", "-O", "journal_dev", "-b", blocksize_s,
+               prog, "-O", "journal_dev", "-b", blocksize_s,
                "-L", label,
                device, NULL);
   if (r == -1) {
@@ -319,11 +381,15 @@ do_mke2journal_U (int blocksize, const char *uuid, const char *device)
   char *err;
   int r;
 
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
 
   r = command (NULL, &err,
-               "/sbin/mke2fs", "-O", "journal_dev", "-b", blocksize_s,
+               prog, "-O", "journal_dev", "-b", blocksize_s,
                "-U", uuid,
                device, NULL);
   if (r == -1) {
@@ -336,40 +402,6 @@ do_mke2journal_U (int blocksize, const char *uuid, const char *device)
   return 0;
 }
 
-/* Run mke2fs to create a filesystem of type fstype, where fstype
- * is the string "ext2", "ext3" or "ext4".
- *
- * This is more complex than it seems.
- *
- * On RHEL 5, the -t option was deprecated.  Moreover RHEL <= 5.4
- * systems have a bug where the -t option doesn't work (it doesn't
- * correctly ignore the following argument).
- *
- * On RHEL 5, to create an ext4dev filesystem you have to use
- * the special command /sbin/mke4fs.  This can also create ext2/3
- * using the '-t fstype' option.
- *
- * On Fedora 11+, mke4fs was renamed mke2fs, and it can use the
- * '-t fstype' option to specify the filesystem type.
- *
- * So it seems best to run /sbin/mke4fs if it exists, or /sbin/mke2fs
- * otherwise.  We specify e4fsprogs in the package list to ensure it
- * is loaded if it exists.
- */
-static const char *
-get_mke2fs (void)
-{
-  static const char *const progs[] = { "/sbin/mke4fs", "/sbin/mke2fs", NULL };
-  int i;
-
-  for (i = 0; progs[i]; ++i)
-    if (access (progs[i], F_OK) == 0)
-      return progs[i];
-
-  reply_with_error ("no mke2fs binary found in appliance");
-  return NULL;
-}
-
 int
 do_mke2fs_J (const char *fstype, int blocksize, const char *device,
              const char *journal)
@@ -377,8 +409,9 @@ do_mke2fs_J (const char *fstype, int blocksize, const char *device,
   char *err;
   int r;
 
-  const char *prog = get_mke2fs ();
-  if (!prog) return -1;
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
 
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
@@ -407,8 +440,15 @@ do_mke2fs_JL (const char *fstype, int blocksize, const char *device,
   char *err;
   int r;
 
-  const char *prog = get_mke2fs ();
-  if (!prog) return -1;
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
+
+  if (strlen (label) > EXT2_LABEL_MAX) {
+    reply_with_error ("%s: ext2 labels are limited to %d bytes",
+                      label, EXT2_LABEL_MAX);
+    return -1;
+  }
 
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
@@ -437,8 +477,9 @@ do_mke2fs_JU (const char *fstype, int blocksize, const char *device,
   char *err;
   int r;
 
-  const char *prog = get_mke2fs ();
-  if (!prog) return -1;
+  char prog[] = "mke2fs";
+  if (e2prog (prog) == -1)
+    return -1;
 
   char blocksize_s[32];
   snprintf (blocksize_s, sizeof blocksize_s, "%d", blocksize);
@@ -459,3 +500,150 @@ do_mke2fs_JU (const char *fstype, int blocksize, const char *device,
   free (err);
   return 0;
 }
+
+/* Takes optional arguments, consult optargs_bitmask. */
+int
+do_tune2fs (const char *device, /* only required parameter */
+            int force,
+            int maxmountcount,
+            int mountcount,
+            const char *errorbehavior,
+            int64_t group,
+            int intervalbetweenchecks,
+            int reservedblockspercentage,
+            const char *lastmounteddirectory,
+            int64_t reservedblockscount,
+            int64_t user)
+{
+  const char *argv[MAX_ARGS];
+  size_t i = 0;
+  int r;
+  char *err;
+  char prog[] = "tune2fs";
+  char maxmountcount_s[64];
+  char mountcount_s[64];
+  char group_s[64];
+  char intervalbetweenchecks_s[64];
+  char reservedblockspercentage_s[64];
+  char reservedblockscount_s[64];
+  char user_s[64];
+
+  if (e2prog (prog) == -1)
+    return -1;
+
+  ADD_ARG (argv, i, prog);
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_FORCE_BITMASK) {
+    if (force)
+      ADD_ARG (argv, i, "-f");
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_MAXMOUNTCOUNT_BITMASK) {
+    if (maxmountcount < 0) {
+      reply_with_error ("maxmountcount cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-c");
+    snprintf (maxmountcount_s, sizeof maxmountcount_s, "%d", maxmountcount);
+    ADD_ARG (argv, i, maxmountcount_s);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_MOUNTCOUNT_BITMASK) {
+    if (mountcount < 0) {
+      reply_with_error ("mountcount cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-C");
+    snprintf (mountcount_s, sizeof mountcount_s, "%d", mountcount);
+    ADD_ARG (argv, i, mountcount_s);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_ERRORBEHAVIOR_BITMASK) {
+    if (STRNEQ (errorbehavior, "continue") &&
+        STRNEQ (errorbehavior, "remount-ro") &&
+        STRNEQ (errorbehavior, "panic")) {
+      reply_with_error ("invalid errorbehavior parameter: %s", errorbehavior);
+      return -1;
+    }
+    ADD_ARG (argv, i, "-e");
+    ADD_ARG (argv, i, errorbehavior);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_GROUP_BITMASK) {
+    if (group < 0) {
+      reply_with_error ("group cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-g");
+    snprintf (group_s, sizeof group_s, "%" PRIi64, group);
+    ADD_ARG (argv, i, group_s);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_INTERVALBETWEENCHECKS_BITMASK) {
+    if (intervalbetweenchecks < 0) {
+      reply_with_error ("intervalbetweenchecks cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-i");
+    if (intervalbetweenchecks > 0) {
+      /* -i <NN>s is not documented in the man page, but has been
+       * supported in tune2fs for several years.
+       */
+      snprintf (intervalbetweenchecks_s, sizeof intervalbetweenchecks_s,
+                "%ds", intervalbetweenchecks);
+      ADD_ARG (argv, i, intervalbetweenchecks_s);
+    }
+    else
+      ADD_ARG (argv, i, "0");
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_RESERVEDBLOCKSPERCENTAGE_BITMASK) {
+    if (reservedblockspercentage < 0) {
+      reply_with_error ("reservedblockspercentage cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-m");
+    snprintf (reservedblockspercentage_s, sizeof reservedblockspercentage_s,
+              "%d", reservedblockspercentage);
+    ADD_ARG (argv, i, reservedblockspercentage_s);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_LASTMOUNTEDDIRECTORY_BITMASK) {
+    ADD_ARG (argv, i, "-M");
+    ADD_ARG (argv, i, lastmounteddirectory);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_RESERVEDBLOCKSCOUNT_BITMASK) {
+    if (reservedblockscount < 0) {
+      reply_with_error ("reservedblockscount cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-r");
+    snprintf (reservedblockscount_s, sizeof reservedblockscount_s,
+              "%" PRIi64, reservedblockscount);
+    ADD_ARG (argv, i, reservedblockscount_s);
+  }
+
+  if (optargs_bitmask & GUESTFS_TUNE2FS_USER_BITMASK) {
+    if (user < 0) {
+      reply_with_error ("user cannot be negative");
+      return -1;
+    }
+    ADD_ARG (argv, i, "-u");
+    snprintf (user_s, sizeof user_s, "%" PRIi64, user);
+    ADD_ARG (argv, i, user_s);
+  }
+
+  ADD_ARG (argv, i, device);
+  ADD_ARG (argv, i, NULL);
+
+  r = commandv (NULL, &err, argv);
+  if (r == -1) {
+    reply_with_error ("%s: %s: %s", prog, device, err);
+    free (err);
+    return -1;
+  }
+
+  free (err);
+  return 0;
+}