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 /*-- in proto.c --*/
  48 extern int proc_nr;
  49 extern int serial;
  50
  51 /*-- in mount.c --*/
  52 extern int root_mounted;
  53
  54 /*-- in stubs.c (auto-generated) --*/
  55 extern void dispatch_incoming_message (XDR *);
  56 extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void);
  57 extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void);
  58 extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void);
  59
  60 /*-- in proto.c --*/
  61 extern void main_loop (int sock);
  62
  63 /* ordinary daemon functions use these to indicate errors */
  64 extern void reply_with_error (const char *fs, ...);
  65 extern void reply_with_perror (const char *fs, ...);
  66
  67 /* daemon functions that receive files (FileIn) should call
  68  * receive_file for each FileIn parameter.
  69  */
  70 #if 0
  71 extern void receive_file ();
  72 #endif
  73
  74 /* daemon functions that return files (FileOut) should call
  75  * reply, then send_file for each FileOut parameter.
  76  */
  77 #if 0
  78 extern void send_file ();
  79 #endif
  80
  81 /* only call this if there is a FileOut parameter */
  82 extern void reply (xdrproc_t xdrp, char *ret);
  83
  84 /* Helper for functions that need a root filesystem mounted. */
  85 #define NEED_ROOT(errcode)                                              \
  86   do {                                                                  \
  87     if (!root_mounted) {                                                \
  88       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
  89       return (errcode);                                                 \
  90     }                                                                   \
  91   }                                                                     \
  92   while (0)
  93
  94 /* Helper for functions that need an argument ("path") that is absolute. */
  95 #define ABS_PATH(path,errcode)                                          \
  96   do {                                                                  \
  97     if ((path)[0] != '/') {                                             \
  98       reply_with_error ("%s: path must start with a / character", __func__); \
  99       return (errcode);                                                 \
 100     }                                                                   \
 101   } while (0)
 102
 103 /* Helper for functions that need an argument ("path") that is a device. */
 104 #define IS_DEVICE(path,errcode)                                         \
 105   do {                                                                  \
 106     struct stat statbuf;                                                \
 107     if (strncmp ((path), "/dev/", 5) != 0) {                            \
 108       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
 109       return (errcode);                                                 \
 110     }                                                                   \
 111     if (stat ((path), &statbuf) == -1) {                                \
 112       reply_with_perror ("%s: %s", __func__, (path));                   \
 113       return (errcode);                                                 \
 114     }                                                                   \
 115   } while (0)
 116
 117 /* Helper for functions which need either an absolute path in the
 118  * mounted filesystem, OR a /dev/ device which exists.
 119  */
 120 #define NEED_ROOT_OR_IS_DEVICE(path,errcode) \
 121   do {                                                                  \
 122     if (strncmp ((path), "/dev/", 5) == 0)                              \
 123       IS_DEVICE ((path),(errcode));                                     \
 124     else {                                                              \
 125       NEED_ROOT ((path),(errcode));                                     \
 126       ABS_PATH ((path),(errcode));                                      \
 127     }                                                                   \
 128   } while (0)
 129
 130 /* NB:
 131  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
 132  * (2) You must not change directory!  cwd must always be "/", otherwise
 133  *     we can't escape our own chroot.
 134  * (3) All paths specified must be absolute.
 135  * (4) CHROOT_OUT does not affect errno.
 136  */
 137 #define CHROOT_IN chroot ("/sysroot");
 138 #define CHROOT_OUT \
 139   do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0)
 140
 141 /* Marks functions which are not implemented. */
 142 #define XXX_NOT_IMPL(errcode)                                           \
 143   do {                                                                  \
 144     reply_with_error ("%s: function not implemented", __func__);        \
 145     return (errcode);                                                   \
 146   }                                                                     \
 147   while (0)
 148
 149 #endif /* GUESTFSD_DAEMON_H */