1 /* libguestfs - the guestfsd daemon
2 * Copyright (C) 2009 Red Hat Inc.
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.
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.
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.
19 #ifndef GUESTFSD_DAEMON_H
20 #define GUESTFSD_DAEMON_H
26 #include <rpc/types.h>
29 #include "../src/guestfs_protocol.h"
31 /*-- in guestfsd.c --*/
34 extern const char *sysroot;
35 extern int sysroot_len;
37 extern char *sysroot_path (const char *path);
39 extern int xwrite (int sock, const void *buf, size_t len)
40 __attribute__((__warn_unused_result__));
41 extern int xread (int sock, void *buf, size_t len)
42 __attribute__((__warn_unused_result__));
44 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
45 extern int count_strings (char *const *argv);
46 extern void sort_strings (char **argv, int len);
47 extern void free_strings (char **argv);
48 extern void free_stringslen (char **argv, int len);
50 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
51 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
52 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
53 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
55 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR 1
57 extern int commandf (char **stdoutput, char **stderror, int flags,
58 const char *name, ...);
59 extern int commandrf (char **stdoutput, char **stderror, int flags,
60 const char *name, ...);
61 extern int commandvf (char **stdoutput, char **stderror, int flags,
62 char const *const *argv);
63 extern int commandrvf (char **stdoutput, char **stderror, int flags,
64 char const* const *argv);
66 extern char **split_lines (char *str);
68 extern int device_name_translation (char *device, const char *func);
70 extern void udev_settle (void);
72 /* This just stops gcc from giving a warning about our custom
73 * printf formatters %Q and %R. See HACKING file for more
77 asprintf_nowarn (char **strp, const char *fmt, ...)
83 r = vasprintf (strp, fmt, args);
88 /*-- in names.c (auto-generated) --*/
89 extern const char *function_names[];
96 extern int root_mounted;
98 /*-- in stubs.c (auto-generated) --*/
99 extern void dispatch_incoming_message (XDR *);
100 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
101 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
102 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
105 extern void main_loop (int sock) __attribute__((noreturn));
107 /* ordinary daemon functions use these to indicate errors */
108 extern void reply_with_error (const char *fs, ...)
109 __attribute__((format (printf,1,2)));
110 extern void reply_with_perror (const char *fs, ...)
111 __attribute__((format (printf,1,2)));
113 /* daemon functions that receive files (FileIn) should call
114 * receive_file for each FileIn parameter.
116 typedef int (*receive_cb) (void *opaque, const void *buf, int len);
117 extern int receive_file (receive_cb cb, void *opaque);
119 /* daemon functions that receive files (FileIn) can call this
120 * to cancel incoming transfers (eg. if there is a local error),
121 * but they MUST then call reply_with_error or reply_with_perror.
123 extern void cancel_receive (void);
125 /* daemon functions that return files (FileOut) should call
126 * reply, then send_file_* for each FileOut parameter.
127 * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
129 extern int send_file_write (const void *buf, int len);
130 extern int send_file_end (int cancel);
132 /* only call this if there is a FileOut parameter */
133 extern void reply (xdrproc_t xdrp, char *ret);
135 /* Helper for functions that need a root filesystem mounted.
136 * NB. Cannot be used for FileIn functions.
138 #define NEED_ROOT(fail_stmt) \
140 if (!root_mounted) { \
141 reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
147 /* Helper for functions that need an argument ("path") that is absolute.
148 * NB. Cannot be used for FileIn functions.
150 #define ABS_PATH(path,fail_stmt) \
152 if ((path)[0] != '/') { \
153 reply_with_error ("%s: path must start with a / character", __func__); \
158 /* All functions that need an argument that is a device or partition name
159 * must call this macro. It checks that the device exists and does
160 * device name translation (described in the guestfs(3) manpage).
161 * Note that the "path" argument may be modified.
163 * NB. Cannot be used for FileIn functions.
165 #define RESOLVE_DEVICE(path,fail_stmt) \
167 if (STRNEQLEN ((path), "/dev/", 5)) { \
168 reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
171 if (device_name_translation ((path), __func__) == -1) \
175 /* Helper for functions which need either an absolute path in the
176 * mounted filesystem, OR a /dev/ device which exists.
178 * NB. Cannot be used for FileIn functions.
180 * NB #2: Functions which mix filenames and device paths should be
181 * avoided, and existing functions should be deprecated. This is
182 * because we intend in future to make device parameters a distinct
183 * type from filenames.
185 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,fail_stmt) \
187 if (STREQLEN ((path), "/dev/", 5)) \
188 RESOLVE_DEVICE ((path), fail_stmt); \
190 NEED_ROOT (fail_stmt); \
191 ABS_PATH ((path),fail_stmt); \
196 * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
197 * (2) You must not change directory! cwd must always be "/", otherwise
198 * we can't escape our own chroot.
199 * (3) All paths specified must be absolute.
200 * (4) Neither macro affects errno.
204 int __old_errno = errno; \
205 if (chroot (sysroot) == -1) \
206 perror ("CHROOT_IN: sysroot"); \
207 errno = __old_errno; \
211 int __old_errno = errno; \
212 if (chroot (".") == -1) \
213 perror ("CHROOT_OUT: ."); \
214 errno = __old_errno; \
217 /* Marks functions which are not implemented.
218 * NB. Cannot be used for FileIn functions.
220 #define XXX_NOT_IMPL(errcode) \
222 reply_with_error ("%s: function not implemented", __func__); \
227 #ifndef __attribute__
228 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
229 # define __attribute__(x) /* empty */
233 #ifndef ATTRIBUTE_UNUSED
234 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
237 #define STREQ(a,b) (strcmp((a),(b)) == 0)
238 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
239 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
240 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
241 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
242 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
243 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
244 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
245 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
247 #endif /* GUESTFSD_DAEMON_H */