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