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