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