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