daemon: Fix /dev/mapper paths from mounts and mountpoints (RHBZ#646432).
[libguestfs.git] / daemon / daemon.h
index 6872bd7..e4e7159 100644 (file)
@@ -21,6 +21,7 @@
 
 #include <stdio.h>
 #include <stdarg.h>
+#include <stdint.h>
 #include <errno.h>
 #include <unistd.h>
 
@@ -37,23 +38,29 @@ extern int sysroot_len;
 
 extern char *sysroot_path (const char *path);
 
+extern int is_root_device (const char *device);
+
 extern int xwrite (int sock, const void *buf, size_t len)
   __attribute__((__warn_unused_result__));
 extern int xread (int sock, void *buf, size_t len)
   __attribute__((__warn_unused_result__));
 
 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
-extern int count_strings (char *const *argv);
+extern size_t count_strings (char *const *argv);
 extern void sort_strings (char **argv, int len);
 extern void free_strings (char **argv);
 extern void free_stringslen (char **argv, int len);
 
+extern int is_power_of_2 (unsigned long v);
+
 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
 
-#define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR 1
+#define COMMAND_FLAG_FD_MASK                   (1024-1)
+#define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR     1024
+#define COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN 2048
 
 extern int commandf (char **stdoutput, char **stderror, int flags,
                      const char *name, ...);
@@ -66,7 +73,11 @@ extern int commandrvf (char **stdoutput, char **stderror, int flags,
 
 extern char **split_lines (char *str);
 
-extern int device_name_translation (char *device, const char *func);
+extern void trim (char *str);
+
+extern int device_name_translation (char *device);
+
+extern int prog_exists (const char *prog);
 
 extern void udev_settle (void);
 
@@ -102,9 +113,6 @@ extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
 
-/*-- in proto.c --*/
-extern void main_loop (int sock) __attribute__((noreturn));
-
 /*-- in optgroups.c (auto-generated) --*/
 struct optgroup {
   const char *group;            /* Name of the optional group. */
@@ -116,23 +124,36 @@ extern struct optgroup optgroups[];
 /* Use this as a replacement for sync(2). */
 extern int sync_disks (void);
 
-/* ordinary daemon functions use these to indicate errors */
+/*-- in lvm.c --*/
+extern int lv_canonical (const char *device, char **ret);
+
+/*-- in proto.c --*/
+extern void main_loop (int sock) __attribute__((noreturn));
+
+/* ordinary daemon functions use these to indicate errors
+ * NB: you don't need to prefix the string with the current command,
+ * it is added automatically by the client-side RPC stubs.
+ */
 extern void reply_with_error (const char *fs, ...)
   __attribute__((format (printf,1,2)));
-extern void reply_with_perror (const char *fs, ...)
-  __attribute__((format (printf,1,2)));
+extern void reply_with_perror_errno (int err, const char *fs, ...)
+  __attribute__((format (printf,2,3)));
+#define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
 
 /* daemon functions that receive files (FileIn) should call
  * receive_file for each FileIn parameter.
  */
-typedef int (*receive_cb) (void *opaque, const void *buf, int len);
+typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
 extern int receive_file (receive_cb cb, void *opaque);
 
 /* daemon functions that receive files (FileIn) can call this
- * to cancel incoming transfers (eg. if there is a local error),
- * but they MUST then call reply_with_error or reply_with_perror.
+ * to cancel incoming transfers (eg. if there is a local error).
+ *
+ * If and only if this function does NOT return -2, they MUST then
+ * call reply_with_*
+ * (see https://bugzilla.redhat.com/show_bug.cgi?id=576879#c5).
  */
-extern void cancel_receive (void);
+extern int cancel_receive (void);
 
 /* daemon functions that return files (FileOut) should call
  * reply, then send_file_* for each FileOut parameter.
@@ -144,13 +165,20 @@ extern int send_file_end (int cancel);
 /* only call this if there is a FileOut parameter */
 extern void reply (xdrproc_t xdrp, char *ret);
 
+/* Notify progress to caller.  This function is self-rate-limiting so
+ * you can call it as often as necessary.  Actions which call this
+ * should add 'Progress' note in generator.
+ */
+extern void notify_progress (uint64_t position, uint64_t total);
+
 /* Helper for functions that need a root filesystem mounted.
  * NB. Cannot be used for FileIn functions.
  */
-#define NEED_ROOT(fail_stmt)                                           \
+#define NEED_ROOT(cancel_stmt,fail_stmt)                                \
   do {                                                                 \
     if (!root_mounted) {                                               \
-      reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
+      if ((cancel_stmt) != -2)                                          \
+        reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
       fail_stmt;                                                       \
     }                                                                  \
   }                                                                    \
@@ -159,10 +187,11 @@ extern void reply (xdrproc_t xdrp, char *ret);
 /* Helper for functions that need an argument ("path") that is absolute.
  * NB. Cannot be used for FileIn functions.
  */
-#define ABS_PATH(path,fail_stmt)                                       \
+#define ABS_PATH(path,cancel_stmt,fail_stmt)                            \
   do {                                                                 \
     if ((path)[0] != '/') {                                            \
-      reply_with_error ("%s: path must start with a / character", __func__); \
+      if ((cancel_stmt) != -2)                                          \
+        reply_with_error ("%s: path must start with a / character", __func__); \
       fail_stmt;                                                       \
     }                                                                  \
   } while (0)
@@ -174,14 +203,23 @@ extern void reply (xdrproc_t xdrp, char *ret);
  *
  * NB. Cannot be used for FileIn functions.
  */
-#define RESOLVE_DEVICE(path,fail_stmt)                                 \
+#define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)                      \
   do {                                                                 \
     if (STRNEQLEN ((path), "/dev/", 5)) {                              \
-      reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
+      if ((cancel_stmt) != -2)                                          \
+        reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
       fail_stmt;                                                       \
     }                                                                  \
-    if (device_name_translation ((path), __func__) == -1)              \
+    if (is_root_device (path))                                          \
+      reply_with_error ("%s: %s: device not found", __func__, path);    \
+    if (device_name_translation ((path)) == -1) {                       \
+      int err = errno;                                                  \
+      int r = cancel_stmt;                                              \
+      errno = err;                                                      \
+      if (r != -2)                                                      \
+        reply_with_perror ("%s: %s", __func__, path);                   \
       fail_stmt;                                                       \
+    }                                                                   \
   } while (0)
 
 /* Helper for functions which need either an absolute path in the
@@ -194,13 +232,13 @@ extern void reply (xdrproc_t xdrp, char *ret);
  * because we intend in future to make device parameters a distinct
  * type from filenames.
  */
-#define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,fail_stmt)                 \
+#define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)      \
   do {                                                                 \
-    if (STREQLEN ((path), "/dev/", 5))                         \
-      RESOLVE_DEVICE ((path), fail_stmt);                              \
+    if (STREQLEN ((path), "/dev/", 5))                                  \
+      RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt);                  \
     else {                                                             \
-      NEED_ROOT (fail_stmt);                                           \
-      ABS_PATH ((path),fail_stmt);                                     \
+      NEED_ROOT (cancel_stmt, fail_stmt);                               \
+      ABS_PATH ((path), cancel_stmt, fail_stmt);                        \
     }                                                                  \
   } while (0)