Implement device name translation. Remove device name hacks in tests.

[libguestfs.git] / daemon / daemon.h

diff --git a/daemon/daemon.h b/daemon/daemon.h
index b2b8152..c3b9120 100644 (file)
--- a/daemon/daemon.h
+++ b/daemon/daemon.h
@@ -22,8 +22,6 @@
 #include <stdarg.h>
 #include <errno.h>
 #include <unistd.h>
-#include <sys/types.h>
-#include <sys/stat.h>
 
 #include <rpc/types.h>
 #include <rpc/xdr.h>
@@ -41,8 +39,19 @@ extern void free_strings (char **argv);
 extern void free_stringslen (char **argv, int len);
 
 extern int command (char **stdoutput, char **stderror, const char *name, ...);
+extern int commandr (char **stdoutput, char **stderror, const char *name, ...);
 extern int commandv (char **stdoutput, char **stderror,
                     char * const* const argv);
+extern int commandrv (char **stdoutput, char **stderror,
+                     char * const* const argv);
+
+extern char **split_lines (char *str);
+
+extern int shell_quote (char *out, int len, const char *in);
+
+extern int device_name_translation (char *device, const char *func);
+
+extern int verbose;
 
 /*-- in proto.c --*/
 extern int proc_nr;
@@ -61,27 +70,36 @@ extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
 extern void main_loop (int sock);
 
 /* ordinary daemon functions use these to indicate errors */
-extern void reply_with_error (const char *fs, ...);
-extern void reply_with_perror (const char *fs, ...);
+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)));
 
 /* daemon functions that receive files (FileIn) should call
  * receive_file for each FileIn parameter.
  */
-#if 0
-extern void receive_file ();
-#endif
+typedef int (*receive_cb) (void *opaque, const void *buf, int 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.
+ */
+extern void cancel_receive (void);
 
 /* daemon functions that return files (FileOut) should call
- * reply, then send_file for each FileOut parameter.
+ * reply, then send_file_* for each FileOut parameter.
+ * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
  */
-#if 0
-extern void send_file ();
-#endif
+extern int send_file_write (const void *buf, int len);
+extern void send_file_end (int cancel);
 
 /* only call this if there is a FileOut parameter */
 extern void reply (xdrproc_t xdrp, char *ret);
 
-/* Helper for functions that need a root filesystem mounted. */
+/* Helper for functions that need a root filesystem mounted.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define NEED_ROOT(errcode)                                             \
   do {                                                                 \
     if (!root_mounted) {                                               \
@@ -91,7 +109,9 @@ extern void reply (xdrproc_t xdrp, char *ret);
   }                                                                    \
   while (0)
 
-/* Helper for functions that need an argument ("path") that is absolute. */
+/* Helper for functions that need an argument ("path") that is absolute.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define ABS_PATH(path,errcode)                                         \
   do {                                                                 \
     if ((path)[0] != '/') {                                            \
@@ -100,29 +120,33 @@ extern void reply (xdrproc_t xdrp, char *ret);
     }                                                                  \
   } while (0)
 
-/* Helper for functions that need an argument ("path") that is a device. */
+/* All functions that need an argument that is a device or partition name
+ * must call this macro.  It checks that the device exists and does
+ * device name translation (described in the guestfs(3) manpage).
+ * Note that the "path" argument may be modified.
+ *
+ * NB. Cannot be used for FileIn functions.
+ */
 #define IS_DEVICE(path,errcode)                                                \
   do {                                                                 \
-    struct stat statbuf;                                               \
     if (strncmp ((path), "/dev/", 5) != 0) {                           \
       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
       return (errcode);                                                        \
     }                                                                  \
-    if (stat ((path), &statbuf) == -1) {                               \
-      reply_with_perror ("%s: %s", __func__, (path));                  \
+    if (device_name_translation ((path), __func__) == -1)              \
       return (errcode);                                                        \
-    }                                                                  \
   } while (0)
 
 /* Helper for functions which need either an absolute path in the
  * mounted filesystem, OR a /dev/ device which exists.
+ * NB. Cannot be used for FileIn functions.
  */
 #define NEED_ROOT_OR_IS_DEVICE(path,errcode) \
   do {                                                                 \
     if (strncmp ((path), "/dev/", 5) == 0)                             \
       IS_DEVICE ((path),(errcode));                                    \
     else {                                                             \
-      NEED_ROOT ((path),(errcode));                                    \
+      NEED_ROOT ((errcode));                                           \
       ABS_PATH ((path),(errcode));                                     \
     }                                                                  \
   } while (0)
@@ -138,7 +162,9 @@ extern void reply (xdrproc_t xdrp, char *ret);
 #define CHROOT_OUT \
   do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
 
-/* Marks functions which are not implemented. */
+/* Marks functions which are not implemented.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define XXX_NOT_IMPL(errcode)                                          \
   do {                                                                 \
     reply_with_error ("%s: function not implemented", __func__);       \