daemon/daemon.h

   1 /* libguestfs - the guestfsd daemon
   2  * Copyright (C) 2009-2011 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 size_t 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_nodup (char ***argv, int *size, int *alloc, char *str);
  51 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  52 extern size_t count_strings (char *const *argv);
  53 extern void sort_strings (char **argv, int len);
  54 extern void free_strings (char **argv);
  55 extern void free_stringslen (char **argv, int len);
  56
  57 extern int is_power_of_2 (unsigned long v);
  58
  59 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
  60 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
  61 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
  62 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
  63
  64 #define COMMAND_FLAG_FD_MASK                   (1024-1)
  65 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR     1024
  66 #define COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN 2048
  67
  68 extern int commandf (char **stdoutput, char **stderror, int flags,
  69                      const char *name, ...);
  70 extern int commandrf (char **stdoutput, char **stderror, int flags,
  71                       const char *name, ...);
  72 extern int commandvf (char **stdoutput, char **stderror, int flags,
  73                       char const *const *argv);
  74 extern int commandrvf (char **stdoutput, char **stderror, int flags,
  75                        char const* const *argv);
  76
  77 extern char **split_lines (char *str);
  78
  79 extern void trim (char *str);
  80
  81 extern int device_name_translation (char *device);
  82
  83 extern int prog_exists (const char *prog);
  84
  85 extern void udev_settle (void);
  86
  87 /* This just stops gcc from giving a warning about our custom printf
  88  * formatters %Q and %R.  See guestfs(3)/EXTENDING LIBGUESTFS for more
  89  * info about these.
  90  */
  91 static inline int
  92 asprintf_nowarn (char **strp, const char *fmt, ...)
  93 {
  94   int r;
  95   va_list args;
  96
  97   va_start (args, fmt);
  98   r = vasprintf (strp, fmt, args);
  99   va_end (args);
 100   return r;
 101 }
 102
 103 /*-- in names.c (auto-generated) --*/
 104 extern const char *function_names[];
 105
 106 /*-- in proto.c --*/
 107 extern int proc_nr;
 108 extern int serial;
 109 extern uint64_t progress_hint;
 110 extern uint64_t optargs_bitmask;
 111
 112 /*-- in mount.c --*/
 113 extern int is_root_mounted (void);
 114
 115 /*-- in stubs.c (auto-generated) --*/
 116 extern void dispatch_incoming_message (XDR *);
 117 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
 118 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
 119 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
 120
 121 /*-- in optgroups.c (auto-generated) --*/
 122 struct optgroup {
 123   const char *group;            /* Name of the optional group. */
 124   int (*available) (void);      /* Function to test availability. */
 125 };
 126 extern struct optgroup optgroups[];
 127
 128 /*-- in sync.c --*/
 129 /* Use this as a replacement for sync(2). */
 130 extern int sync_disks (void);
 131
 132 /*-- in ext2.c --*/
 133 extern int e2prog (char *name); /* Massive hack for RHEL 5. */
 134
 135 /*-- in lvm.c --*/
 136 extern int lv_canonical (const char *device, char **ret);
 137
 138 /*-- in lvm-filter.c --*/
 139 extern void copy_lvm (void);
 140
 141 /*-- in proto.c --*/
 142 extern void main_loop (int sock) __attribute__((noreturn));
 143
 144 /* ordinary daemon functions use these to indicate errors
 145  * NB: you don't need to prefix the string with the current command,
 146  * it is added automatically by the client-side RPC stubs.
 147  */
 148 extern void reply_with_error (const char *fs, ...)
 149   __attribute__((format (printf,1,2)));
 150 extern void reply_with_perror_errno (int err, const char *fs, ...)
 151   __attribute__((format (printf,2,3)));
 152 #define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
 153
 154 /* daemon functions that receive files (FileIn) should call
 155  * receive_file for each FileIn parameter.
 156  */
 157 typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
 158 extern int receive_file (receive_cb cb, void *opaque);
 159
 160 /* daemon functions that receive files (FileIn) can call this
 161  * to cancel incoming transfers (eg. if there is a local error).
 162  */
 163 extern int cancel_receive (void);
 164
 165 /* daemon functions that return files (FileOut) should call
 166  * reply, then send_file_* for each FileOut parameter.
 167  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
 168  */
 169 extern int send_file_write (const void *buf, int len);
 170 extern int send_file_end (int cancel);
 171
 172 /* only call this if there is a FileOut parameter */
 173 extern void reply (xdrproc_t xdrp, char *ret);
 174
 175 /* Notify progress to caller.  This function is self-rate-limiting so
 176  * you can call it as often as necessary.  Actions which call this
 177  * should add 'Progress' note in generator.
 178  */
 179 extern void notify_progress (uint64_t position, uint64_t total);
 180
 181 /* Pulse mode progress messages.
 182  *
 183  * Call pulse_mode_start to start sending progress messages.
 184  *
 185  * Call pulse_mode_end along the ordinary exit path (ie. before a
 186  * reply message is sent).
 187  *
 188  * Call pulse_mode_cancel along all error paths *before* any reply is
 189  * sent.  pulse_mode_cancel does not modify errno, so it is safe to
 190  * call it before reply_with_perror.
 191  *
 192  * Pulse mode and ordinary notify_progress must not be mixed.
 193  */
 194 extern void pulse_mode_start (void);
 195 extern void pulse_mode_end (void);
 196 extern void pulse_mode_cancel (void);
 197
 198 /* Return true iff the buffer is all zero bytes.
 199  *
 200  * Note that gcc is smart enough to optimize this properly:
 201  * http://stackoverflow.com/questions/1493936/faster-means-of-checking-for-an-empty-buffer-in-c/1493989#1493989
 202  */
 203 static inline int
 204 is_zero (const char *buffer, size_t size)
 205 {
 206   size_t i;
 207
 208   for (i = 0; i < size; ++i) {
 209     if (buffer[i] != 0)
 210       return 0;
 211   }
 212
 213   return 1;
 214 }
 215
 216 /* Helper for building up short lists of arguments.  Your code has to
 217  * define MAX_ARGS to a suitable value.
 218  */
 219 #define ADD_ARG(argv,i,v)                                               \
 220   do {                                                                  \
 221     if ((i) >= MAX_ARGS) {                                              \
 222       fprintf (stderr, "%s: %d: internal error: exceeded MAX_ARGS (%zu) when constructing the command line\n", __FILE__, __LINE__, (size_t) MAX_ARGS); \
 223       abort ();                                                         \
 224     }                                                                   \
 225     (argv)[(i)++] = (v);                                                \
 226   } while (0)
 227
 228 /* Helper for functions that need a root filesystem mounted.
 229  * NB. Cannot be used for FileIn functions.
 230  */
 231 #define NEED_ROOT(cancel_stmt,fail_stmt)                                \
 232   do {                                                                  \
 233     if (!is_root_mounted ()) {                                          \
 234       cancel_stmt;                                                      \
 235       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 236       fail_stmt;                                                        \
 237     }                                                                   \
 238   }                                                                     \
 239   while (0)
 240
 241 /* Helper for functions that need an argument ("path") that is absolute.
 242  * NB. Cannot be used for FileIn functions.
 243  */
 244 #define ABS_PATH(path,cancel_stmt,fail_stmt)                            \
 245   do {                                                                  \
 246     if ((path)[0] != '/') {                                             \
 247       cancel_stmt;                                                      \
 248       reply_with_error ("%s: path must start with a / character", __func__); \
 249       fail_stmt;                                                        \
 250     }                                                                   \
 251   } while (0)
 252
 253 /* All functions that need an argument that is a device or partition name
 254  * must call this macro.  It checks that the device exists and does
 255  * device name translation (described in the guestfs(3) manpage).
 256  * Note that the "path" argument may be modified.
 257  *
 258  * NB. Cannot be used for FileIn functions.
 259  */
 260 #define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)                      \
 261   do {                                                                  \
 262     if (STRNEQLEN ((path), "/dev/", 5)) {                               \
 263       cancel_stmt;                                                      \
 264       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 265       fail_stmt;                                                        \
 266     }                                                                   \
 267     if (is_root_device (path))                                          \
 268       reply_with_error ("%s: %s: device not found", __func__, path);    \
 269     if (device_name_translation ((path)) == -1) {                       \
 270       int err = errno;                                                  \
 271       cancel_stmt;                                                      \
 272       errno = err;                                                      \
 273       reply_with_perror ("%s: %s", __func__, path);                     \
 274       fail_stmt;                                                        \
 275     }                                                                   \
 276   } while (0)
 277
 278 /* Helper for functions which need either an absolute path in the
 279  * mounted filesystem, OR a /dev/ device which exists.
 280  *
 281  * NB. Cannot be used for FileIn functions.
 282  *
 283  * NB #2: Functions which mix filenames and device paths should be
 284  * avoided, and existing functions should be deprecated.  This is
 285  * because we intend in future to make device parameters a distinct
 286  * type from filenames.
 287  */
 288 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)      \
 289   do {                                                                  \
 290     if (STREQLEN ((path), "/dev/", 5))                                  \
 291       RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt);                  \
 292     else {                                                              \
 293       NEED_ROOT (cancel_stmt, fail_stmt);                               \
 294       ABS_PATH ((path), cancel_stmt, fail_stmt);                        \
 295     }                                                                   \
 296   } while (0)
 297
 298 /* NB:
 299  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 300  * (2) You must not change directory!  cwd must always be "/", otherwise
 301  *     we can't escape our own chroot.
 302  * (3) All paths specified must be absolute.
 303  * (4) Neither macro affects errno.
 304  */
 305 #define CHROOT_IN                               \
 306   do {                                          \
 307     if (sysroot_len > 0) {                      \
 308       int __old_errno = errno;                  \
 309       if (chroot (sysroot) == -1)               \
 310         perror ("CHROOT_IN: sysroot");          \
 311       errno = __old_errno;                      \
 312     }                                           \
 313   } while (0)
 314 #define CHROOT_OUT                              \
 315   do {                                          \
 316     if (sysroot_len > 0) {                      \
 317       int __old_errno = errno;                  \
 318       if (chroot (".") == -1)                   \
 319         perror ("CHROOT_OUT: .");               \
 320       errno = __old_errno;                      \
 321     }                                           \
 322   } while (0)
 323
 324 /* Marks functions which are not implemented.
 325  * NB. Cannot be used for FileIn functions.
 326  */
 327 #define XXX_NOT_IMPL(errcode)                                           \
 328   do {                                                                  \
 329     reply_with_error ("%s: function not implemented", __func__);        \
 330     return (errcode);                                                   \
 331   }                                                                     \
 332   while (0)
 333
 334 /* Marks functions which are not available.
 335  * NB. Cannot be used for FileIn functions.
 336  */
 337 #define NOT_AVAILABLE(errcode)                                          \
 338   do {                                                                  \
 339     reply_with_error ("%s: function not available", __func__);          \
 340     return (errcode);                                                   \
 341   }                                                                     \
 342   while (0)
 343
 344 #ifndef __attribute__
 345 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
 346 #  define __attribute__(x) /* empty */
 347 # endif
 348 #endif
 349
 350 #ifndef ATTRIBUTE_UNUSED
 351 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 352 #endif
 353
 354 #define STREQ(a,b) (strcmp((a),(b)) == 0)
 355 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
 356 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
 357 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
 358 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
 359 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
 360 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
 361 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
 362 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
 363
 364 #endif /* GUESTFSD_DAEMON_H */