daemon/daemon.h

   1 /* libguestfs - the guestfsd daemon
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef GUESTFSD_DAEMON_H
  20 #define GUESTFSD_DAEMON_H
  21
  22 #include <stdarg.h>
  23 #include <errno.h>
  24 #include <unistd.h>
  25
  26 #include <rpc/types.h>
  27 #include <rpc/xdr.h>
  28
  29 #include "../src/guestfs_protocol.h"
  30
  31 /*-- in guestfsd.c --*/
  32 extern int xwrite (int sock, const void *buf, size_t len);
  33 extern int xread (int sock, void *buf, size_t len);
  34
  35 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  36 extern int count_strings (char * const* const argv);
  37 extern void sort_strings (char **argv, int len);
  38 extern void free_strings (char **argv);
  39 extern void free_stringslen (char **argv, int len);
  40
  41 extern int command (char **stdoutput, char **stderror, const char *name, ...);
  42 extern int commandr (char **stdoutput, char **stderror, const char *name, ...);
  43 extern int commandv (char **stdoutput, char **stderror,
  44                      char * const* const argv);
  45 extern int commandrv (char **stdoutput, char **stderror,
  46                       char * const* const argv);
  47
  48 extern char **split_lines (char *str);
  49
  50 extern int shell_quote (char *out, int len, const char *in);
  51
  52 extern int device_name_translation (char *device, const char *func);
  53
  54 extern int verbose;
  55
  56 /*-- in proto.c --*/
  57 extern int proc_nr;
  58 extern int serial;
  59
  60 /*-- in mount.c --*/
  61 extern int root_mounted;
  62
  63 /*-- in stubs.c (auto-generated) --*/
  64 extern void dispatch_incoming_message (XDR *);
  65 extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void);
  66 extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void);
  67 extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
  68
  69 /*-- in proto.c --*/
  70 extern void main_loop (int sock);
  71
  72 /* ordinary daemon functions use these to indicate errors */
  73 extern void reply_with_error (const char *fs, ...)
  74   __attribute__((format (printf,1,2)));
  75 extern void reply_with_perror (const char *fs, ...)
  76   __attribute__((format (printf,1,2)));
  77
  78 /* daemon functions that receive files (FileIn) should call
  79  * receive_file for each FileIn parameter.
  80  */
  81 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
  82 extern int receive_file (receive_cb cb, void *opaque);
  83
  84 /* daemon functions that receive files (FileIn) can call this
  85  * to cancel incoming transfers (eg. if there is a local error),
  86  * but they MUST then call reply_with_error or reply_with_perror.
  87  */
  88 extern void cancel_receive (void);
  89
  90 /* daemon functions that return files (FileOut) should call
  91  * reply, then send_file_* for each FileOut parameter.
  92  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
  93  */
  94 extern int send_file_write (const void *buf, int len);
  95 extern void send_file_end (int cancel);
  96
  97 /* only call this if there is a FileOut parameter */
  98 extern void reply (xdrproc_t xdrp, char *ret);
  99
 100 /* Helper for functions that need a root filesystem mounted.
 101  * NB. Cannot be used for FileIn functions.
 102  */
 103 #define NEED_ROOT(errcode)                                              \
 104   do {                                                                  \
 105     if (!root_mounted) {                                                \
 106       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 107       return (errcode);                                                 \
 108     }                                                                   \
 109   }                                                                     \
 110   while (0)
 111
 112 /* Helper for functions that need an argument ("path") that is absolute.
 113  * NB. Cannot be used for FileIn functions.
 114  */
 115 #define ABS_PATH(path,errcode)                                          \
 116   do {                                                                  \
 117     if ((path)[0] != '/') {                                             \
 118       reply_with_error ("%s: path must start with a / character", __func__); \
 119       return (errcode);                                                 \
 120     }                                                                   \
 121   } while (0)
 122
 123 /* All functions that need an argument that is a device or partition name
 124  * must call this macro.  It checks that the device exists and does
 125  * device name translation (described in the guestfs(3) manpage).
 126  * Note that the "path" argument may be modified.
 127  *
 128  * NB. Cannot be used for FileIn functions.
 129  */
 130 #define IS_DEVICE(path,errcode)                                         \
 131   do {                                                                  \
 132     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 133       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 134       return (errcode);                                                 \
 135     }                                                                   \
 136     if (device_name_translation ((path), __func__) == -1)               \
 137       return (errcode);                                                 \
 138   } while (0)
 139
 140 /* Helper for functions which need either an absolute path in the
 141  * mounted filesystem, OR a /dev/ device which exists.
 142  * NB. Cannot be used for FileIn functions.
 143  */
 144 #define NEED_ROOT_OR_IS_DEVICE(path,errcode) \
 145   do {                                                                  \
 146     if (strncmp ((path), "/dev/", 5) == 0)                              \
 147       IS_DEVICE ((path),(errcode));                                     \
 148     else {                                                              \
 149       NEED_ROOT ((errcode));                                            \
 150       ABS_PATH ((path),(errcode));                                      \
 151     }                                                                   \
 152   } while (0)
 153
 154 /* NB:
 155  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 156  * (2) You must not change directory!  cwd must always be "/", otherwise
 157  *     we can't escape our own chroot.
 158  * (3) All paths specified must be absolute.
 159  * (4) CHROOT_OUT does not affect errno.
 160  */
 161 #define CHROOT_IN chroot ("/sysroot");
 162 #define CHROOT_OUT \
 163   do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
 164
 165 /* Marks functions which are not implemented.
 166  * NB. Cannot be used for FileIn functions.
 167  */
 168 #define XXX_NOT_IMPL(errcode)                                           \
 169   do {                                                                  \
 170     reply_with_error ("%s: function not implemented", __func__);        \
 171     return (errcode);                                                   \
 172   }                                                                     \
 173   while (0)
 174
 175 #endif /* GUESTFSD_DAEMON_H */