X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=daemon%2Fdaemon.h;h=c3b9120932eaee6b23bffc8c988afe68f77f90cd;hp=42d772768c0cb9d3a6439809e3d9d10676a8647e;hb=875dc84cc01dacb1e254e294a66e179b96fbdbc6;hpb=843514eef9dc6d04d71e031ba9ddb16e2beb9a04 diff --git a/daemon/daemon.h b/daemon/daemon.h index 42d7727..c3b9120 100644 --- a/daemon/daemon.h +++ b/daemon/daemon.h @@ -20,48 +20,156 @@ #define GUESTFSD_DAEMON_H #include +#include +#include + #include #include -/* in guestfsd.c */ -extern void xwrite (int sock, const void *buf, size_t len); -extern void xread (int sock, void *buf, size_t len); -extern int count_strings (char **argv); +#include "../src/guestfs_protocol.h" + +/*-- in guestfsd.c --*/ +extern int xwrite (int sock, const void *buf, size_t len); +extern int xread (int sock, void *buf, size_t len); + +extern int add_string (char ***argv, int *size, int *alloc, const char *str); +extern int count_strings (char * const* const argv); +extern void sort_strings (char **argv, int len); extern void free_strings (char **argv); +extern void free_stringslen (char **argv, int len); + extern int command (char **stdoutput, char **stderror, const char *name, ...); +extern int commandr (char **stdoutput, char **stderror, const char *name, ...); +extern int commandv (char **stdoutput, char **stderror, + char * const* const argv); +extern int commandrv (char **stdoutput, char **stderror, + char * const* const argv); + +extern char **split_lines (char *str); -/* in proto.c */ +extern int shell_quote (char *out, int len, const char *in); + +extern int device_name_translation (char *device, const char *func); + +extern int verbose; + +/*-- in proto.c --*/ extern int proc_nr; extern int serial; -/* in mount.c */ +/*-- in mount.c --*/ extern int root_mounted; -/* in stubs.c (auto-generated) */ +/*-- in stubs.c (auto-generated) --*/ extern void dispatch_incoming_message (XDR *); +extern guestfs_lvm_int_pv_list *parse_command_line_pvs (void); +extern guestfs_lvm_int_vg_list *parse_command_line_vgs (void); +extern guestfs_lvm_int_lv_list *parse_command_line_lvs (void); -/* in proto.c */ +/*-- in proto.c --*/ extern void main_loop (int sock); -extern void reply_with_error (const char *fs, ...); -extern void reply_with_perror (const char *fs, ...); + +/* ordinary daemon functions use these to indicate errors */ +extern void reply_with_error (const char *fs, ...) + __attribute__((format (printf,1,2))); +extern void reply_with_perror (const char *fs, ...) + __attribute__((format (printf,1,2))); + +/* daemon functions that receive files (FileIn) should call + * receive_file for each FileIn parameter. + */ +typedef int (*receive_cb) (void *opaque, const void *buf, int len); +extern int receive_file (receive_cb cb, void *opaque); + +/* daemon functions that receive files (FileIn) can call this + * to cancel incoming transfers (eg. if there is a local error), + * but they MUST then call reply_with_error or reply_with_perror. + */ +extern void cancel_receive (void); + +/* daemon functions that return files (FileOut) should call + * reply, then send_file_* for each FileOut parameter. + * Note max write size if GUESTFS_MAX_CHUNK_SIZE. + */ +extern int send_file_write (const void *buf, int len); +extern void send_file_end (int cancel); + +/* only call this if there is a FileOut parameter */ extern void reply (xdrproc_t xdrp, char *ret); -#define NEED_ROOT \ +/* Helper for functions that need a root filesystem mounted. + * NB. Cannot be used for FileIn functions. + */ +#define NEED_ROOT(errcode) \ do { \ if (!root_mounted) { \ reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \ - return -1; \ + return (errcode); \ } \ } \ while (0) +/* Helper for functions that need an argument ("path") that is absolute. + * NB. Cannot be used for FileIn functions. + */ +#define ABS_PATH(path,errcode) \ + do { \ + if ((path)[0] != '/') { \ + reply_with_error ("%s: path must start with a / character", __func__); \ + return (errcode); \ + } \ + } while (0) + +/* All functions that need an argument that is a device or partition name + * must call this macro. It checks that the device exists and does + * device name translation (described in the guestfs(3) manpage). + * Note that the "path" argument may be modified. + * + * NB. Cannot be used for FileIn functions. + */ +#define IS_DEVICE(path,errcode) \ + do { \ + if (strncmp ((path), "/dev/", 5) != 0) { \ + reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \ + return (errcode); \ + } \ + if (device_name_translation ((path), __func__) == -1) \ + return (errcode); \ + } while (0) + +/* Helper for functions which need either an absolute path in the + * mounted filesystem, OR a /dev/ device which exists. + * NB. Cannot be used for FileIn functions. + */ +#define NEED_ROOT_OR_IS_DEVICE(path,errcode) \ + do { \ + if (strncmp ((path), "/dev/", 5) == 0) \ + IS_DEVICE ((path),(errcode)); \ + else { \ + NEED_ROOT ((errcode)); \ + ABS_PATH ((path),(errcode)); \ + } \ + } while (0) + /* NB: * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths. * (2) You must not change directory! cwd must always be "/", otherwise * we can't escape our own chroot. * (3) All paths specified must be absolute. + * (4) CHROOT_OUT does not affect errno. */ #define CHROOT_IN chroot ("/sysroot"); -#define CHROOT_OUT chroot ("."); +#define CHROOT_OUT \ + do { int old_errno = errno; chroot ("."); errno = old_errno; } while (0) + +/* Marks functions which are not implemented. + * NB. Cannot be used for FileIn functions. + */ +#define XXX_NOT_IMPL(errcode) \ + do { \ + reply_with_error ("%s: function not implemented", __func__); \ + return (errcode); \ + } \ + while (0) #endif /* GUESTFSD_DAEMON_H */