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 #include <sys/types.h>
  26 #include <sys/stat.h>
  27
  28 #include <rpc/types.h>
  29 #include <rpc/xdr.h>
  30
  31 #include "../src/guestfs_protocol.h"
  32
  33 /*-- in guestfsd.c --*/
  34 extern int xwrite (int sock, const void *buf, size_t len);
  35 extern int xread (int sock, void *buf, size_t len);
  36
  37 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  38 extern int count_strings (char * const* const argv);
  39 extern void sort_strings (char **argv, int len);
  40 extern void free_strings (char **argv);
  41 extern void free_stringslen (char **argv, int len);
  42
  43 extern int command (char **stdoutput, char **stderror, const char *name, ...);
  44 extern int commandr (char **stdoutput, char **stderror, const char *name, ...);
  45 extern int commandv (char **stdoutput, char **stderror,
  46                      char * const* const argv);
  47 extern int commandrv (char **stdoutput, char **stderror,
  48                       char * const* const argv);
  49
  50 extern int shell_quote (char *out, int len, const char *in);
  51
  52 extern int verbose;
  53
  54 /*-- in proto.c --*/
  55 extern int proc_nr;
  56 extern int serial;
  57
  58 /*-- in mount.c --*/
  59 extern int root_mounted;
  60
  61 /*-- in stubs.c (auto-generated) --*/
  62 extern void dispatch_incoming_message (XDR *);
  63 extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void);
  64 extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void);
  65 extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
  66
  67 /*-- in proto.c --*/
  68 extern void main_loop (int sock);
  69
  70 /* ordinary daemon functions use these to indicate errors */
  71 extern void reply_with_error (const char *fs, ...)
  72   __attribute__((format (printf,1,2)));
  73 extern void reply_with_perror (const char *fs, ...)
  74   __attribute__((format (printf,1,2)));
  75
  76 /* daemon functions that receive files (FileIn) should call
  77  * receive_file for each FileIn parameter.
  78  */
  79 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
  80 extern int receive_file (receive_cb cb, void *opaque);
  81
  82 /* daemon functions that receive files (FileIn) can call this
  83  * to cancel incoming transfers (eg. if there is a local error),
  84  * but they MUST then call reply_with_error or reply_with_perror.
  85  */
  86 extern void cancel_receive (void);
  87
  88 /* daemon functions that return files (FileOut) should call
  89  * reply, then send_file_* for each FileOut parameter.
  90  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
  91  */
  92 extern int send_file_write (const void *buf, int len);
  93 extern void send_file_end (int cancel);
  94
  95 /* only call this if there is a FileOut parameter */
  96 extern void reply (xdrproc_t xdrp, char *ret);
  97
  98 /* Helper for functions that need a root filesystem mounted.
  99  * NB. Cannot be used for FileIn functions.
 100  */
 101 #define NEED_ROOT(errcode)                                              \
 102   do {                                                                  \
 103     if (!root_mounted) {                                                \
 104       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 105       return (errcode);                                                 \
 106     }                                                                   \
 107   }                                                                     \
 108   while (0)
 109
 110 /* Helper for functions that need an argument ("path") that is absolute.
 111  * NB. Cannot be used for FileIn functions.
 112  */
 113 #define ABS_PATH(path,errcode)                                          \
 114   do {                                                                  \
 115     if ((path)[0] != '/') {                                             \
 116       reply_with_error ("%s: path must start with a / character", __func__); \
 117       return (errcode);                                                 \
 118     }                                                                   \
 119   } while (0)
 120
 121 /* Helper for functions that need an argument ("path") that is a device.
 122  * NB. Cannot be used for FileIn functions.
 123  */
 124 #define IS_DEVICE(path,errcode)                                         \
 125   do {                                                                  \
 126     struct stat statbuf;                                                \
 127     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 128       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 129       return (errcode);                                                 \
 130     }                                                                   \
 131     if (stat ((path), &statbuf) == -1) {                                \
 132       reply_with_perror ("%s: %s", __func__, (path));                   \
 133       return (errcode);                                                 \
 134     }                                                                   \
 135   } while (0)
 136
 137 /* Helper for functions which need either an absolute path in the
 138  * mounted filesystem, OR a /dev/ device which exists.
 139  * NB. Cannot be used for FileIn functions.
 140  */
 141 #define NEED_ROOT_OR_IS_DEVICE(path,errcode) \
 142   do {                                                                  \
 143     if (strncmp ((path), "/dev/", 5) == 0)                              \
 144       IS_DEVICE ((path),(errcode));                                     \
 145     else {                                                              \
 146       NEED_ROOT ((errcode));                                            \
 147       ABS_PATH ((path),(errcode));                                      \
 148     }                                                                   \
 149   } while (0)
 150
 151 /* NB:
 152  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 153  * (2) You must not change directory!  cwd must always be "/", otherwise
 154  *     we can't escape our own chroot.
 155  * (3) All paths specified must be absolute.
 156  * (4) CHROOT_OUT does not affect errno.
 157  */
 158 #define CHROOT_IN chroot ("/sysroot");
 159 #define CHROOT_OUT \
 160   do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
 161
 162 /* Marks functions which are not implemented.
 163  * NB. Cannot be used for FileIn functions.
 164  */
 165 #define XXX_NOT_IMPL(errcode)                                           \
 166   do {                                                                  \
 167     reply_with_error ("%s: function not implemented", __func__);        \
 168     return (errcode);                                                   \
 169   }                                                                     \
 170   while (0)
 171
 172 #endif /* GUESTFSD_DAEMON_H */