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 <stdarg.h>
  23 #include <errno.h>
  24 #include <unistd.h>
  25
  26 #include <rpc/types.h>
  27 #include <rpc/xdr.h>
  28
  29 #include "../src/guestfs_protocol.h"
  30
  31 /*-- in guestfsd.c --*/
  32 extern int verbose;
  33
  34 extern const char *sysroot;
  35 extern int sysroot_len;
  36
  37 extern char *sysroot_path (const char *path);
  38
  39 extern int xwrite (int sock, const void *buf, size_t len)
  40   __attribute__((__warn_unused_result__));
  41 extern int xread (int sock, void *buf, size_t len)
  42   __attribute__((__warn_unused_result__));
  43
  44 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  45 extern int count_strings (char *const *argv);
  46 extern void sort_strings (char **argv, int len);
  47 extern void free_strings (char **argv);
  48 extern void free_stringslen (char **argv, int len);
  49
  50 extern int command (char **stdoutput, char **stderror, const char *name, ...);
  51 extern int commandr (char **stdoutput, char **stderror, const char *name, ...);
  52 extern int commandv (char **stdoutput, char **stderror,
  53                      char *const *argv);
  54 extern int commandrv (char **stdoutput, char **stderror,
  55                       char const* const *argv);
  56
  57 extern char **split_lines (char *str);
  58
  59 extern int device_name_translation (char *device, const char *func);
  60
  61 extern void udev_settle (void);
  62
  63 /* This just stops gcc from giving a warning about our custom
  64  * printf formatters %Q and %R.  See HACKING file for more
  65  * info about these.
  66  */
  67 static inline int
  68 asprintf_nowarn (char **strp, const char *fmt, ...)
  69 {
  70   int r;
  71   va_list args;
  72
  73   va_start (args, fmt);
  74   r = vasprintf (strp, fmt, args);
  75   va_end (args);
  76   return r;
  77 }
  78
  79 /*-- in names.c (auto-generated) --*/
  80 extern const char *function_names[];
  81
  82 /*-- in proto.c --*/
  83 extern int proc_nr;
  84 extern int serial;
  85
  86 /*-- in mount.c --*/
  87 extern int root_mounted;
  88
  89 /*-- in stubs.c (auto-generated) --*/
  90 extern void dispatch_incoming_message (XDR *);
  91 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
  92 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
  93 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
  94
  95 /*-- in proto.c --*/
  96 extern void main_loop (int sock) __attribute__((noreturn));
  97
  98 /* ordinary daemon functions use these to indicate errors */
  99 extern void reply_with_error (const char *fs, ...)
 100   __attribute__((format (printf,1,2)));
 101 extern void reply_with_perror (const char *fs, ...)
 102   __attribute__((format (printf,1,2)));
 103
 104 /* daemon functions that receive files (FileIn) should call
 105  * receive_file for each FileIn parameter.
 106  */
 107 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
 108 extern int receive_file (receive_cb cb, void *opaque);
 109
 110 /* daemon functions that receive files (FileIn) can call this
 111  * to cancel incoming transfers (eg. if there is a local error),
 112  * but they MUST then call reply_with_error or reply_with_perror.
 113  */
 114 extern void cancel_receive (void);
 115
 116 /* daemon functions that return files (FileOut) should call
 117  * reply, then send_file_* for each FileOut parameter.
 118  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
 119  */
 120 extern int send_file_write (const void *buf, int len);
 121 extern int send_file_end (int cancel);
 122
 123 /* only call this if there is a FileOut parameter */
 124 extern void reply (xdrproc_t xdrp, char *ret);
 125
 126 /* Helper for functions that need a root filesystem mounted.
 127  * NB. Cannot be used for FileIn functions.
 128  */
 129 #define NEED_ROOT(fail_stmt)                                            \
 130   do {                                                                  \
 131     if (!root_mounted) {                                                \
 132       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
 133       fail_stmt;                                                        \
 134     }                                                                   \
 135   }                                                                     \
 136   while (0)
 137
 138 /* Helper for functions that need an argument ("path") that is absolute.
 139  * NB. Cannot be used for FileIn functions.
 140  */
 141 #define ABS_PATH(path,fail_stmt)                                        \
 142   do {                                                                  \
 143     if ((path)[0] != '/') {                                             \
 144       reply_with_error ("%s: path must start with a / character", __func__); \
 145       fail_stmt;                                                        \
 146     }                                                                   \
 147   } while (0)
 148
 149 /* All functions that need an argument that is a device or partition name
 150  * must call this macro.  It checks that the device exists and does
 151  * device name translation (described in the guestfs(3) manpage).
 152  * Note that the "path" argument may be modified.
 153  *
 154  * NB. Cannot be used for FileIn functions.
 155  */
 156 #define RESOLVE_DEVICE(path,fail_stmt)                                  \
 157   do {                                                                  \
 158     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 159       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 160       fail_stmt;                                                        \
 161     }                                                                   \
 162     if (device_name_translation ((path), __func__) == -1)               \
 163       fail_stmt;                                                        \
 164   } while (0)
 165
 166 /* Helper for functions which need either an absolute path in the
 167  * mounted filesystem, OR a /dev/ device which exists.
 168  *
 169  * NB. Cannot be used for FileIn functions.
 170  *
 171  * NB #2: Functions which mix filenames and device paths should be
 172  * avoided, and existing functions should be deprecated.  This is
 173  * because we intend in future to make device parameters a distinct
 174  * type from filenames.
 175  */
 176 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,fail_stmt)                  \
 177   do {                                                                  \
 178     if (strncmp ((path), "/dev/", 5) == 0)                              \
 179       RESOLVE_DEVICE ((path), fail_stmt);                               \
 180     else {                                                              \
 181       NEED_ROOT (fail_stmt);                                            \
 182       ABS_PATH ((path),fail_stmt);                                      \
 183     }                                                                   \
 184   } while (0)
 185
 186 /* NB:
 187  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 188  * (2) You must not change directory!  cwd must always be "/", otherwise
 189  *     we can't escape our own chroot.
 190  * (3) All paths specified must be absolute.
 191  * (4) Neither macro affects errno.
 192  */
 193 #define CHROOT_IN                               \
 194   do {                                          \
 195     int __old_errno = errno;                    \
 196     if (chroot (sysroot) == -1)                 \
 197       perror ("CHROOT_IN: sysroot");            \
 198     errno = __old_errno;                        \
 199   } while (0)
 200 #define CHROOT_OUT                              \
 201   do {                                          \
 202     int __old_errno = errno;                    \
 203     if (chroot (".") == -1)                     \
 204       perror ("CHROOT_OUT: .");                 \
 205     errno = __old_errno;                        \
 206   } while (0)
 207
 208 /* Marks functions which are not implemented.
 209  * NB. Cannot be used for FileIn functions.
 210  */
 211 #define XXX_NOT_IMPL(errcode)                                           \
 212   do {                                                                  \
 213     reply_with_error ("%s: function not implemented", __func__);        \
 214     return (errcode);                                                   \
 215   }                                                                     \
 216   while (0)
 217
 218 #ifndef __attribute__
 219 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
 220 #  define __attribute__(x) /* empty */
 221 # endif
 222 #endif
 223
 224 #ifndef ATTRIBUTE_UNUSED
 225 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 226 #endif
 227
 228 #endif /* GUESTFSD_DAEMON_H */