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