Generated code for lvremove, vgremove, pvremove.

[libguestfs.git] / daemon / daemon.h

diff --git a/daemon/daemon.h b/daemon/daemon.h
index 27d86c9..3f51056 100644 (file)
--- a/daemon/daemon.h
+++ b/daemon/daemon.h
@@ -30,7 +30,7 @@
 
 #include "../src/guestfs_protocol.h"
 
-/* in guestfsd.c */
+/*-- in guestfsd.c --*/
 extern int xwrite (int sock, const void *buf, size_t len);
 extern int xread (int sock, void *buf, size_t len);
 
@@ -44,25 +44,57 @@ extern int command (char **stdoutput, char **stderror, const char *name, ...);
 extern int commandv (char **stdoutput, char **stderror,
                     char * const* const argv);
 
-/* in proto.c */
+extern int shell_quote (char *out, int len, const char *in);
+
+extern int verbose;
+
+/*-- in proto.c --*/
 extern int proc_nr;
 extern int serial;
 
-/* in mount.c */
+/*-- in mount.c --*/
 extern int root_mounted;
 
-/* in stubs.c (auto-generated) */
+/*-- in stubs.c (auto-generated) --*/
 extern void dispatch_incoming_message (XDR *);
 extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void);
 extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void);
 extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
 
-/* in proto.c */
+/*-- in proto.c --*/
 extern void main_loop (int sock);
-extern void reply_with_error (const char *fs, ...);
-extern void reply_with_perror (const char *fs, ...);
+
+/* ordinary daemon functions use these to indicate errors */
+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.
+ */
+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.
+ * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
+ */
+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.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define NEED_ROOT(errcode)                                             \
   do {                                                                 \
     if (!root_mounted) {                                               \
@@ -72,6 +104,9 @@ extern void reply (xdrproc_t xdrp, char *ret);
   }                                                                    \
   while (0)
 
+/* 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] != '/') {                                            \
@@ -80,6 +115,9 @@ extern void reply (xdrproc_t xdrp, char *ret);
     }                                                                  \
   } while (0)
 
+/* Helper for functions that need an argument ("path") that is a device.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define IS_DEVICE(path,errcode)                                                \
   do {                                                                 \
     struct stat statbuf;                                               \
@@ -93,6 +131,20 @@ extern void reply (xdrproc_t xdrp, char *ret);
     }                                                                  \
   } 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 ((errcode));                                           \
+      ABS_PATH ((path),(errcode));                                     \
+    }                                                                  \
+  } while (0)
+
 /* NB:
  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
  * (2) You must not change directory!  cwd must always be "/", otherwise
@@ -104,6 +156,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.
+ * NB. Cannot be used for FileIn functions.
+ */
 #define XXX_NOT_IMPL(errcode)                                          \
   do {                                                                 \
     reply_with_error ("%s: function not implemented", __func__);       \