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 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 ext2.c --*/
 132 extern int e2prog (char *name); /* Massive hack for RHEL 5. */
 133
 134 /*-- in lvm.c --*/
 135 extern int lv_canonical (const char *device, char **ret);
 136
 137 /*-- in proto.c --*/
 138 extern void main_loop (int sock) __attribute__((noreturn));
 139
 140 /* ordinary daemon functions use these to indicate errors
 141  * NB: you don't need to prefix the string with the current command,
 142  * it is added automatically by the client-side RPC stubs.
 143  */
 144 extern void reply_with_error (const char *fs, ...)
 145   __attribute__((format (printf,1,2)));
 146 extern void reply_with_perror_errno (int err, const char *fs, ...)
 147   __attribute__((format (printf,2,3)));
 148 #define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
 149
 150 /* daemon functions that receive files (FileIn) should call
 151  * receive_file for each FileIn parameter.
 152  */
 153 typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
 154 extern int receive_file (receive_cb cb, void *opaque);
 155
 156 /* daemon functions that receive files (FileIn) can call this
 157  * to cancel incoming transfers (eg. if there is a local error).
 158  */
 159 extern int cancel_receive (void);
 160
 161 /* daemon functions that return files (FileOut) should call
 162  * reply, then send_file_* for each FileOut parameter.
 163  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
 164  */
 165 extern int send_file_write (const void *buf, int len);
 166 extern int send_file_end (int cancel);
 167
 168 /* only call this if there is a FileOut parameter */
 169 extern void reply (xdrproc_t xdrp, char *ret);
 170
 171 /* Notify progress to caller.  This function is self-rate-limiting so
 172  * you can call it as often as necessary.  Actions which call this
 173  * should add 'Progress' note in generator.
 174  */
 175 extern void notify_progress (uint64_t position, uint64_t total);
 176
 177 /* Pulse mode progress messages.
 178  *
 179  * Call pulse_mode_start to start sending progress messages.
 180  *
 181  * Call pulse_mode_end along the ordinary exit path (ie. before a
 182  * reply message is sent).
 183  *
 184  * Call pulse_mode_cancel along all error paths *before* any reply is
 185  * sent.  pulse_mode_cancel does not modify errno, so it is safe to
 186  * call it before reply_with_perror.
 187  *
 188  * Pulse mode and ordinary notify_progress must not be mixed.
 189  */
 190 extern void pulse_mode_start (void);
 191 extern void pulse_mode_end (void);
 192 extern void pulse_mode_cancel (void);
 193
 194 /* Helper for functions that need a root filesystem mounted.
 195  * NB. Cannot be used for FileIn functions.
 196  */
 197 #define NEED_ROOT(cancel_stmt,fail_stmt)                                \
 198   do {                                                                  \
 199     if (!is_root_mounted ()) {                                          \
 200       cancel_stmt;                                                      \
 201       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 202       fail_stmt;                                                        \
 203     }                                                                   \
 204   }                                                                     \
 205   while (0)
 206
 207 /* Helper for functions that need an argument ("path") that is absolute.
 208  * NB. Cannot be used for FileIn functions.
 209  */
 210 #define ABS_PATH(path,cancel_stmt,fail_stmt)                            \
 211   do {                                                                  \
 212     if ((path)[0] != '/') {                                             \
 213       cancel_stmt;                                                      \
 214       reply_with_error ("%s: path must start with a / character", __func__); \
 215       fail_stmt;                                                        \
 216     }                                                                   \
 217   } while (0)
 218
 219 /* All functions that need an argument that is a device or partition name
 220  * must call this macro.  It checks that the device exists and does
 221  * device name translation (described in the guestfs(3) manpage).
 222  * Note that the "path" argument may be modified.
 223  *
 224  * NB. Cannot be used for FileIn functions.
 225  */
 226 #define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)                      \
 227   do {                                                                  \
 228     if (STRNEQLEN ((path), "/dev/", 5)) {                               \
 229       cancel_stmt;                                                      \
 230       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 231       fail_stmt;                                                        \
 232     }                                                                   \
 233     if (is_root_device (path))                                          \
 234       reply_with_error ("%s: %s: device not found", __func__, path);    \
 235     if (device_name_translation ((path)) == -1) {                       \
 236       int err = errno;                                                  \
 237       cancel_stmt;                                                      \
 238       errno = err;                                                      \
 239       reply_with_perror ("%s: %s", __func__, path);                     \
 240       fail_stmt;                                                        \
 241     }                                                                   \
 242   } while (0)
 243
 244 /* Helper for functions which need either an absolute path in the
 245  * mounted filesystem, OR a /dev/ device which exists.
 246  *
 247  * NB. Cannot be used for FileIn functions.
 248  *
 249  * NB #2: Functions which mix filenames and device paths should be
 250  * avoided, and existing functions should be deprecated.  This is
 251  * because we intend in future to make device parameters a distinct
 252  * type from filenames.
 253  */
 254 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)      \
 255   do {                                                                  \
 256     if (STREQLEN ((path), "/dev/", 5))                                  \
 257       RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt);                  \
 258     else {                                                              \
 259       NEED_ROOT (cancel_stmt, fail_stmt);                               \
 260       ABS_PATH ((path), cancel_stmt, fail_stmt);                        \
 261     }                                                                   \
 262   } while (0)
 263
 264 /* NB:
 265  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 266  * (2) You must not change directory!  cwd must always be "/", otherwise
 267  *     we can't escape our own chroot.
 268  * (3) All paths specified must be absolute.
 269  * (4) Neither macro affects errno.
 270  */
 271 #define CHROOT_IN                               \
 272   do {                                          \
 273     if (sysroot_len > 0) {                      \
 274       int __old_errno = errno;                  \
 275       if (chroot (sysroot) == -1)               \
 276         perror ("CHROOT_IN: sysroot");          \
 277       errno = __old_errno;                      \
 278     }                                           \
 279   } while (0)
 280 #define CHROOT_OUT                              \
 281   do {                                          \
 282     if (sysroot_len > 0) {                      \
 283       int __old_errno = errno;                  \
 284       if (chroot (".") == -1)                   \
 285         perror ("CHROOT_OUT: .");               \
 286       errno = __old_errno;                      \
 287     }                                           \
 288   } while (0)
 289
 290 /* Marks functions which are not implemented.
 291  * NB. Cannot be used for FileIn functions.
 292  */
 293 #define XXX_NOT_IMPL(errcode)                                           \
 294   do {                                                                  \
 295     reply_with_error ("%s: function not implemented", __func__);        \
 296     return (errcode);                                                   \
 297   }                                                                     \
 298   while (0)
 299
 300 /* Marks functions which are not available.
 301  * NB. Cannot be used for FileIn functions.
 302  */
 303 #define NOT_AVAILABLE(errcode)                                          \
 304   do {                                                                  \
 305     reply_with_error ("%s: function not available", __func__);          \
 306     return (errcode);                                                   \
 307   }                                                                     \
 308   while (0)
 309
 310 #ifndef __attribute__
 311 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
 312 #  define __attribute__(x) /* empty */
 313 # endif
 314 #endif
 315
 316 #ifndef ATTRIBUTE_UNUSED
 317 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 318 #endif
 319
 320 #define STREQ(a,b) (strcmp((a),(b)) == 0)
 321 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
 322 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
 323 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
 324 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
 325 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
 326 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
 327 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
 328 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
 329
 330 #endif /* GUESTFSD_DAEMON_H */