Replace shell_quote function with %Q and %R printf specifiers.
[libguestfs.git] / daemon / daemon.h
index 27d86c9..5bf6f35 100644 (file)
 #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>
 
 #include "../src/guestfs_protocol.h"
 
-/* in guestfsd.c */
+/*-- in guestfsd.c --*/
+extern int verbose;
+
+extern const char *sysroot;
+extern int sysroot_len;
+
+extern char *sysroot_path (const char *path);
+
 extern int xwrite (int sock, const void *buf, size_t len);
 extern int xread (int sock, void *buf, size_t len);
 
@@ -41,28 +46,84 @@ 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);
 
-/* in proto.c */
+extern int device_name_translation (char *device, const char *func);
+
+extern void udev_settle (void);
+
+/* This just stops gcc from giving a warning about our custom
+ * printf formatters %Q and %R.  See HACKING file for more
+ * info about these.
+ */
+static int
+asprintf_nowarn (char **strp, const char *fmt, ...)
+{
+  int r;
+  va_list args;
+
+  va_start (args, fmt);
+  r = vasprintf (strp, fmt, args);
+  va_end (args);
+  return r;
+}
+
+/*-- in names.c (auto-generated) --*/
+extern const char *function_names[];
+
+/*-- 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);
+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 */
+/*-- 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 +133,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,16 +144,40 @@ extern void reply (xdrproc_t xdrp, char *ret);
     }                                                                  \
   } while (0)
 
+/* 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.
+ *
+ * NB #2: Functions which mix filenames and device paths should be
+ * avoided, and existing functions should be deprecated.  This is
+ * because we intend in future to make device parameters a distinct
+ * type from filenames.
+ */
+#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)
 
@@ -98,12 +186,26 @@ extern void reply (xdrproc_t xdrp, char *ret);
  * (2) You must not change directory!  cwd must always be "/", otherwise
  *     we can't escape our own chroot.
  * (3) All paths specified must be absolute.
- * (4) CHROOT_OUT does not affect errno.
+ * (4) Neither macro affects errno.
  */
-#define CHROOT_IN chroot ("/sysroot");
-#define CHROOT_OUT \
-  do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
+#define CHROOT_IN                              \
+  do {                                         \
+    int __old_errno = errno;                   \
+    if (chroot (sysroot) == -1)                        \
+      perror ("CHROOT_IN: sysroot");           \
+    errno = __old_errno;                       \
+  } while (0)
+#define CHROOT_OUT                             \
+  do {                                         \
+    int __old_errno = errno;                   \
+    if (chroot (".") == -1)                    \
+      perror ("CHROOT_OUT: .");                        \
+    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__);       \