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