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 <stdio.h>
  23 #include <stdarg.h>
  24 #include <errno.h>
  25 #include <unistd.h>
  26
  27 #include <rpc/types.h>
  28 #include <rpc/xdr.h>
  29
  30 #include "../src/guestfs_protocol.h"
  31
  32 /*-- in guestfsd.c --*/
  33 extern int verbose;
  34
  35 extern const char *sysroot;
  36 extern int sysroot_len;
  37
  38 extern char *sysroot_path (const char *path);
  39
  40 extern int xwrite (int sock, const void *buf, size_t len)
  41   __attribute__((__warn_unused_result__));
  42 extern int xread (int sock, void *buf, size_t len)
  43   __attribute__((__warn_unused_result__));
  44
  45 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  46 extern size_t count_strings (char *const *argv);
  47 extern void sort_strings (char **argv, int len);
  48 extern void free_strings (char **argv);
  49 extern void free_stringslen (char **argv, int len);
  50
  51 extern int is_power_of_2 (unsigned long v);
  52
  53 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
  54 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
  55 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
  56 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
  57
  58 #define COMMAND_FLAG_FD_MASK                   (1024-1)
  59 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR     1024
  60 #define COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN 2048
  61
  62 extern int commandf (char **stdoutput, char **stderror, int flags,
  63                      const char *name, ...);
  64 extern int commandrf (char **stdoutput, char **stderror, int flags,
  65                       const char *name, ...);
  66 extern int commandvf (char **stdoutput, char **stderror, int flags,
  67                       char const *const *argv);
  68 extern int commandrvf (char **stdoutput, char **stderror, int flags,
  69                        char const* const *argv);
  70
  71 extern char **split_lines (char *str);
  72
  73 extern void trim (char *str);
  74
  75 extern int device_name_translation (char *device);
  76
  77 extern int prog_exists (const char *prog);
  78
  79 extern void udev_settle (void);
  80
  81 /* This just stops gcc from giving a warning about our custom
  82  * printf formatters %Q and %R.  See HACKING file for more
  83  * info about these.
  84  */
  85 static inline int
  86 asprintf_nowarn (char **strp, const char *fmt, ...)
  87 {
  88   int r;
  89   va_list args;
  90
  91   va_start (args, fmt);
  92   r = vasprintf (strp, fmt, args);
  93   va_end (args);
  94   return r;
  95 }
  96
  97 /*-- in names.c (auto-generated) --*/
  98 extern const char *function_names[];
  99
 100 /*-- in proto.c --*/
 101 extern int proc_nr;
 102 extern int serial;
 103
 104 /*-- in mount.c --*/
 105 extern int root_mounted;
 106
 107 /*-- in stubs.c (auto-generated) --*/
 108 extern void dispatch_incoming_message (XDR *);
 109 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
 110 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
 111 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
 112
 113 /*-- in optgroups.c (auto-generated) --*/
 114 struct optgroup {
 115   const char *group;            /* Name of the optional group. */
 116   int (*available) (void);      /* Function to test availability. */
 117 };
 118 extern struct optgroup optgroups[];
 119
 120 /*-- in sync.c --*/
 121 /* Use this as a replacement for sync(2). */
 122 extern int sync_disks (void);
 123
 124 /*-- in proto.c --*/
 125 extern void main_loop (int sock) __attribute__((noreturn));
 126
 127 /* ordinary daemon functions use these to indicate errors
 128  * NB: you don't need to prefix the string with the current command,
 129  * it is added automatically by the client-side RPC stubs.
 130  */
 131 extern void reply_with_error (const char *fs, ...)
 132   __attribute__((format (printf,1,2)));
 133 extern void reply_with_perror_errno (int err, const char *fs, ...)
 134   __attribute__((format (printf,2,3)));
 135 #define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
 136
 137 /* daemon functions that receive files (FileIn) should call
 138  * receive_file for each FileIn parameter.
 139  */
 140 typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
 141 extern int receive_file (receive_cb cb, void *opaque);
 142
 143 /* daemon functions that receive files (FileIn) can call this
 144  * to cancel incoming transfers (eg. if there is a local error).
 145  *
 146  * If and only if this function does NOT return -2, they MUST then
 147  * call reply_with_*
 148  * (see https://bugzilla.redhat.com/show_bug.cgi?id=576879#c5).
 149  */
 150 extern int cancel_receive (void);
 151
 152 /* daemon functions that return files (FileOut) should call
 153  * reply, then send_file_* for each FileOut parameter.
 154  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
 155  */
 156 extern int send_file_write (const void *buf, int len);
 157 extern int send_file_end (int cancel);
 158
 159 /* only call this if there is a FileOut parameter */
 160 extern void reply (xdrproc_t xdrp, char *ret);
 161
 162 /* Helper for functions that need a root filesystem mounted.
 163  * NB. Cannot be used for FileIn functions.
 164  */
 165 #define NEED_ROOT(cancel_stmt,fail_stmt)                                \
 166   do {                                                                  \
 167     if (!root_mounted) {                                                \
 168       if ((cancel_stmt) != -2)                                          \
 169         reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 170       fail_stmt;                                                        \
 171     }                                                                   \
 172   }                                                                     \
 173   while (0)
 174
 175 /* Helper for functions that need an argument ("path") that is absolute.
 176  * NB. Cannot be used for FileIn functions.
 177  */
 178 #define ABS_PATH(path,cancel_stmt,fail_stmt)                            \
 179   do {                                                                  \
 180     if ((path)[0] != '/') {                                             \
 181       if ((cancel_stmt) != -2)                                          \
 182         reply_with_error ("%s: path must start with a / character", __func__); \
 183       fail_stmt;                                                        \
 184     }                                                                   \
 185   } while (0)
 186
 187 /* All functions that need an argument that is a device or partition name
 188  * must call this macro.  It checks that the device exists and does
 189  * device name translation (described in the guestfs(3) manpage).
 190  * Note that the "path" argument may be modified.
 191  *
 192  * NB. Cannot be used for FileIn functions.
 193  */
 194 #define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)                      \
 195   do {                                                                  \
 196     if (STRNEQLEN ((path), "/dev/", 5)) {                               \
 197       if ((cancel_stmt) != -2)                                          \
 198         reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 199       fail_stmt;                                                        \
 200     }                                                                   \
 201     if (device_name_translation ((path)) == -1) {                       \
 202       int err = errno;                                                  \
 203       int r = cancel_stmt;                                              \
 204       errno = err;                                                      \
 205       if (r != -2)                                                      \
 206         reply_with_perror ("%s: %s", __func__, path);                   \
 207       fail_stmt;                                                        \
 208     }                                                                   \
 209   } while (0)
 210
 211 /* Helper for functions which need either an absolute path in the
 212  * mounted filesystem, OR a /dev/ device which exists.
 213  *
 214  * NB. Cannot be used for FileIn functions.
 215  *
 216  * NB #2: Functions which mix filenames and device paths should be
 217  * avoided, and existing functions should be deprecated.  This is
 218  * because we intend in future to make device parameters a distinct
 219  * type from filenames.
 220  */
 221 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)      \
 222   do {                                                                  \
 223     if (STREQLEN ((path), "/dev/", 5))                                  \
 224       RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt);                  \
 225     else {                                                              \
 226       NEED_ROOT (cancel_stmt, fail_stmt);                               \
 227       ABS_PATH ((path), cancel_stmt, fail_stmt);                        \
 228     }                                                                   \
 229   } while (0)
 230
 231 /* NB:
 232  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 233  * (2) You must not change directory!  cwd must always be "/", otherwise
 234  *     we can't escape our own chroot.
 235  * (3) All paths specified must be absolute.
 236  * (4) Neither macro affects errno.
 237  */
 238 #define CHROOT_IN                               \
 239   do {                                          \
 240     int __old_errno = errno;                    \
 241     if (chroot (sysroot) == -1)                 \
 242       perror ("CHROOT_IN: sysroot");            \
 243     errno = __old_errno;                        \
 244   } while (0)
 245 #define CHROOT_OUT                              \
 246   do {                                          \
 247     int __old_errno = errno;                    \
 248     if (chroot (".") == -1)                     \
 249       perror ("CHROOT_OUT: .");                 \
 250     errno = __old_errno;                        \
 251   } while (0)
 252
 253 /* Marks functions which are not implemented.
 254  * NB. Cannot be used for FileIn functions.
 255  */
 256 #define XXX_NOT_IMPL(errcode)                                           \
 257   do {                                                                  \
 258     reply_with_error ("%s: function not implemented", __func__);        \
 259     return (errcode);                                                   \
 260   }                                                                     \
 261   while (0)
 262
 263 /* Marks functions which are not available.
 264  * NB. Cannot be used for FileIn functions.
 265  */
 266 #define NOT_AVAILABLE(errcode)                                          \
 267   do {                                                                  \
 268     reply_with_error ("%s: function not available", __func__);          \
 269     return (errcode);                                                   \
 270   }                                                                     \
 271   while (0)
 272
 273 #ifndef __attribute__
 274 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
 275 #  define __attribute__(x) /* empty */
 276 # endif
 277 #endif
 278
 279 #ifndef ATTRIBUTE_UNUSED
 280 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 281 #endif
 282
 283 #define STREQ(a,b) (strcmp((a),(b)) == 0)
 284 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
 285 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
 286 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
 287 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
 288 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
 289 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
 290 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
 291 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
 292
 293 #endif /* GUESTFSD_DAEMON_H */