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