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 #include <sys/types.h>
  26 #include <sys/stat.h>
  27
  28 #include <rpc/types.h>
  29 #include <rpc/xdr.h>
  30
  31 #include "../src/guestfs_protocol.h"
  32
  33 /*-- in guestfsd.c --*/
  34 extern int xwrite (int sock, const void *buf, size_t len);
  35 extern int xread (int sock, void *buf, size_t len);
  36
  37 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
  38 extern int count_strings (char * const* const argv);
  39 extern void sort_strings (char **argv, int len);
  40 extern void free_strings (char **argv);
  41 extern void free_stringslen (char **argv, int len);
  42
  43 extern int command (char **stdoutput, char **stderror, const char *name, ...);
  44 extern int commandv (char **stdoutput, char **stderror,
  45                      char * const* const argv);
  46
  47 extern int verbose;
  48
  49 /*-- in proto.c --*/
  50 extern int proc_nr;
  51 extern int serial;
  52
  53 /*-- in mount.c --*/
  54 extern int root_mounted;
  55
  56 /*-- in stubs.c (auto-generated) --*/
  57 extern void dispatch_incoming_message (XDR *);
  58 extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void);
  59 extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void);
  60 extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
  61
  62 /*-- in proto.c --*/
  63 extern void main_loop (int sock);
  64
  65 /* ordinary daemon functions use these to indicate errors */
  66 extern void reply_with_error (const char *fs, ...)
  67   __attribute__((format (printf,1,2)));
  68 extern void reply_with_perror (const char *fs, ...)
  69   __attribute__((format (printf,1,2)));
  70
  71 /* daemon functions that receive files (FileIn) should call
  72  * receive_file for each FileIn parameter.
  73  */
  74 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
  75 extern int receive_file (receive_cb cb, void *opaque);
  76
  77 /* daemon functions that receive files (FileIn) can call this
  78  * to cancel incoming transfers (eg. if there is a local error),
  79  * but they MUST then call reply_with_error or reply_with_perror.
  80  */
  81 extern void cancel_receive (void);
  82
  83 /* daemon functions that return files (FileOut) should call
  84  * reply, then send_file_* for each FileOut parameter.
  85  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
  86  */
  87 extern int send_file_write (const void *buf, int len);
  88 extern void send_file_end (int cancel);
  89
  90 /* only call this if there is a FileOut parameter */
  91 extern void reply (xdrproc_t xdrp, char *ret);
  92
  93 /* Helper for functions that need a root filesystem mounted. */
  94 #define NEED_ROOT(errcode)                                              \
  95   do {                                                                  \
  96     if (!root_mounted) {                                                \
  97       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
  98       return (errcode);                                                 \
  99     }                                                                   \
 100   }                                                                     \
 101   while (0)
 102
 103 /* Helper for functions that need an argument ("path") that is absolute. */
 104 #define ABS_PATH(path,errcode)                                          \
 105   do {                                                                  \
 106     if ((path)[0] != '/') {                                             \
 107       reply_with_error ("%s: path must start with a / character", __func__); \
 108       return (errcode);                                                 \
 109     }                                                                   \
 110   } while (0)
 111
 112 /* Helper for functions that need an argument ("path") that is a device. */
 113 #define IS_DEVICE(path,errcode)                                         \
 114   do {                                                                  \
 115     struct stat statbuf;                                                \
 116     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 117       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 118       return (errcode);                                                 \
 119     }                                                                   \
 120     if (stat ((path), &statbuf) == -1) {                                \
 121       reply_with_perror ("%s: %s", __func__, (path));                   \
 122       return (errcode);                                                 \
 123     }                                                                   \
 124   } while (0)
 125
 126 /* Helper for functions which need either an absolute path in the
 127  * mounted filesystem, OR a /dev/ device which exists.
 128  */
 129 #define NEED_ROOT_OR_IS_DEVICE(path,errcode) \
 130   do {                                                                  \
 131     if (strncmp ((path), "/dev/", 5) == 0)                              \
 132       IS_DEVICE ((path),(errcode));                                     \
 133     else {                                                              \
 134       NEED_ROOT ((errcode));                                            \
 135       ABS_PATH ((path),(errcode));                                      \
 136     }                                                                   \
 137   } while (0)
 138
 139 /* NB:
 140  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 141  * (2) You must not change directory!  cwd must always be "/", otherwise
 142  *     we can't escape our own chroot.
 143  * (3) All paths specified must be absolute.
 144  * (4) CHROOT_OUT does not affect errno.
 145  */
 146 #define CHROOT_IN chroot ("/sysroot");
 147 #define CHROOT_OUT \
 148   do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
 149
 150 /* Marks functions which are not implemented. */
 151 #define XXX_NOT_IMPL(errcode)                                           \
 152   do {                                                                  \
 153     reply_with_error ("%s: function not implemented", __func__);        \
 154     return (errcode);                                                   \
 155   }                                                                     \
 156   while (0)
 157
 158 #endif /* GUESTFSD_DAEMON_H */