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