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 verbose;
  33
  34 extern const char *sysroot;
  35 extern int sysroot_len;
  36
  37 extern char *sysroot_path (const char *path);
  38
  39 extern int xwrite (int sock, const void *buf, size_t len)
  40   __attribute__((__warn_unused_result__));
  41 extern int xread (int sock, void *buf, size_t len)
  42   __attribute__((__warn_unused_result__));
  43
  44 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  45 extern int count_strings (char *const *argv);
  46 extern void sort_strings (char **argv, int len);
  47 extern void free_strings (char **argv);
  48 extern void free_stringslen (char **argv, int len);
  49
  50 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
  51 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
  52 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
  53 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
  54
  55 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR 1
  56
  57 extern int commandf (char **stdoutput, char **stderror, int flags,
  58                      const char *name, ...);
  59 extern int commandrf (char **stdoutput, char **stderror, int flags,
  60                       const char *name, ...);
  61 extern int commandvf (char **stdoutput, char **stderror, int flags,
  62                       char const *const *argv);
  63 extern int commandrvf (char **stdoutput, char **stderror, int flags,
  64                        char const* const *argv);
  65
  66 extern char **split_lines (char *str);
  67
  68 extern int device_name_translation (char *device, const char *func);
  69
  70 extern void udev_settle (void);
  71
  72 /* This just stops gcc from giving a warning about our custom
  73  * printf formatters %Q and %R.  See HACKING file for more
  74  * info about these.
  75  */
  76 static inline int
  77 asprintf_nowarn (char **strp, const char *fmt, ...)
  78 {
  79   int r;
  80   va_list args;
  81
  82   va_start (args, fmt);
  83   r = vasprintf (strp, fmt, args);
  84   va_end (args);
  85   return r;
  86 }
  87
  88 /*-- in names.c (auto-generated) --*/
  89 extern const char *function_names[];
  90
  91 /*-- in proto.c --*/
  92 extern int proc_nr;
  93 extern int serial;
  94
  95 /*-- in mount.c --*/
  96 extern int root_mounted;
  97
  98 /*-- in stubs.c (auto-generated) --*/
  99 extern void dispatch_incoming_message (XDR *);
 100 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
 101 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
 102 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
 103
 104 /*-- in proto.c --*/
 105 extern void main_loop (int sock) __attribute__((noreturn));
 106
 107 /* ordinary daemon functions use these to indicate errors */
 108 extern void reply_with_error (const char *fs, ...)
 109   __attribute__((format (printf,1,2)));
 110 extern void reply_with_perror (const char *fs, ...)
 111   __attribute__((format (printf,1,2)));
 112
 113 /* daemon functions that receive files (FileIn) should call
 114  * receive_file for each FileIn parameter.
 115  */
 116 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
 117 extern int receive_file (receive_cb cb, void *opaque);
 118
 119 /* daemon functions that receive files (FileIn) can call this
 120  * to cancel incoming transfers (eg. if there is a local error),
 121  * but they MUST then call reply_with_error or reply_with_perror.
 122  */
 123 extern void cancel_receive (void);
 124
 125 /* daemon functions that return files (FileOut) should call
 126  * reply, then send_file_* for each FileOut parameter.
 127  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
 128  */
 129 extern int send_file_write (const void *buf, int len);
 130 extern int send_file_end (int cancel);
 131
 132 /* only call this if there is a FileOut parameter */
 133 extern void reply (xdrproc_t xdrp, char *ret);
 134
 135 /* Helper for functions that need a root filesystem mounted.
 136  * NB. Cannot be used for FileIn functions.
 137  */
 138 #define NEED_ROOT(fail_stmt)                                            \
 139   do {                                                                  \
 140     if (!root_mounted) {                                                \
 141       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 142       fail_stmt;                                                        \
 143     }                                                                   \
 144   }                                                                     \
 145   while (0)
 146
 147 /* Helper for functions that need an argument ("path") that is absolute.
 148  * NB. Cannot be used for FileIn functions.
 149  */
 150 #define ABS_PATH(path,fail_stmt)                                        \
 151   do {                                                                  \
 152     if ((path)[0] != '/') {                                             \
 153       reply_with_error ("%s: path must start with a / character", __func__); \
 154       fail_stmt;                                                        \
 155     }                                                                   \
 156   } while (0)
 157
 158 /* All functions that need an argument that is a device or partition name
 159  * must call this macro.  It checks that the device exists and does
 160  * device name translation (described in the guestfs(3) manpage).
 161  * Note that the "path" argument may be modified.
 162  *
 163  * NB. Cannot be used for FileIn functions.
 164  */
 165 #define RESOLVE_DEVICE(path,fail_stmt)                                  \
 166   do {                                                                  \
 167     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 168       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 169       fail_stmt;                                                        \
 170     }                                                                   \
 171     if (device_name_translation ((path), __func__) == -1)               \
 172       fail_stmt;                                                        \
 173   } while (0)
 174
 175 /* Helper for functions which need either an absolute path in the
 176  * mounted filesystem, OR a /dev/ device which exists.
 177  *
 178  * NB. Cannot be used for FileIn functions.
 179  *
 180  * NB #2: Functions which mix filenames and device paths should be
 181  * avoided, and existing functions should be deprecated.  This is
 182  * because we intend in future to make device parameters a distinct
 183  * type from filenames.
 184  */
 185 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,fail_stmt)                  \
 186   do {                                                                  \
 187     if (strncmp ((path), "/dev/", 5) == 0)                              \
 188       RESOLVE_DEVICE ((path), fail_stmt);                               \
 189     else {                                                              \
 190       NEED_ROOT (fail_stmt);                                            \
 191       ABS_PATH ((path),fail_stmt);                                      \
 192     }                                                                   \
 193   } while (0)
 194
 195 /* NB:
 196  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 197  * (2) You must not change directory!  cwd must always be "/", otherwise
 198  *     we can't escape our own chroot.
 199  * (3) All paths specified must be absolute.
 200  * (4) Neither macro affects errno.
 201  */
 202 #define CHROOT_IN                               \
 203   do {                                          \
 204     int __old_errno = errno;                    \
 205     if (chroot (sysroot) == -1)                 \
 206       perror ("CHROOT_IN: sysroot");            \
 207     errno = __old_errno;                        \
 208   } while (0)
 209 #define CHROOT_OUT                              \
 210   do {                                          \
 211     int __old_errno = errno;                    \
 212     if (chroot (".") == -1)                     \
 213       perror ("CHROOT_OUT: .");                 \
 214     errno = __old_errno;                        \
 215   } while (0)
 216
 217 /* Marks functions which are not implemented.
 218  * NB. Cannot be used for FileIn functions.
 219  */
 220 #define XXX_NOT_IMPL(errcode)                                           \
 221   do {                                                                  \
 222     reply_with_error ("%s: function not implemented", __func__);        \
 223     return (errcode);                                                   \
 224   }                                                                     \
 225   while (0)
 226
 227 #ifndef __attribute__
 228 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
 229 #  define __attribute__(x) /* empty */
 230 # endif
 231 #endif
 232
 233 #ifndef ATTRIBUTE_UNUSED
 234 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 235 #endif
 236
 237 #endif /* GUESTFSD_DAEMON_H */