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
28 #include <rpc/types.h>
31 #include "guestfs_protocol.h"
33 /*-- in guestfsd.c --*/
36 extern const char *sysroot;
37 extern int sysroot_len;
39 extern char *sysroot_path (const char *path);
41 extern int is_root_device (const char *device);
43 extern int xwrite (int sock, const void *buf, size_t len)
44 __attribute__((__warn_unused_result__));
45 extern int xread (int sock, void *buf, size_t len)
46 __attribute__((__warn_unused_result__));
48 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
49 extern size_t count_strings (char *const *argv);
50 extern void sort_strings (char **argv, int len);
51 extern void free_strings (char **argv);
52 extern void free_stringslen (char **argv, int len);
54 extern int is_power_of_2 (unsigned long v);
56 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
57 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
58 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
59 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
61 #define COMMAND_FLAG_FD_MASK (1024-1)
62 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR 1024
63 #define COMMAND_FLAG_CHROOT_COPY_FILE_TO_STDIN 2048
65 extern int commandf (char **stdoutput, char **stderror, int flags,
66 const char *name, ...);
67 extern int commandrf (char **stdoutput, char **stderror, int flags,
68 const char *name, ...);
69 extern int commandvf (char **stdoutput, char **stderror, int flags,
70 char const *const *argv);
71 extern int commandrvf (char **stdoutput, char **stderror, int flags,
72 char const* const *argv);
74 extern char **split_lines (char *str);
76 extern void trim (char *str);
78 extern int device_name_translation (char *device);
80 extern int prog_exists (const char *prog);
82 extern void udev_settle (void);
84 /* This just stops gcc from giving a warning about our custom printf
85 * formatters %Q and %R. See guestfs(3)/EXTENDING LIBGUESTFS for more
89 asprintf_nowarn (char **strp, const char *fmt, ...)
95 r = vasprintf (strp, fmt, args);
100 /*-- in names.c (auto-generated) --*/
101 extern const char *function_names[];
106 extern uint64_t progress_hint;
107 extern uint64_t optargs_bitmask;
110 extern int root_mounted;
112 /*-- in stubs.c (auto-generated) --*/
113 extern void dispatch_incoming_message (XDR *);
114 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
115 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
116 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
118 /*-- in optgroups.c (auto-generated) --*/
120 const char *group; /* Name of the optional group. */
121 int (*available) (void); /* Function to test availability. */
123 extern struct optgroup optgroups[];
126 /* Use this as a replacement for sync(2). */
127 extern int sync_disks (void);
130 extern int lv_canonical (const char *device, char **ret);
133 extern void main_loop (int sock) __attribute__((noreturn));
135 /* ordinary daemon functions use these to indicate errors
136 * NB: you don't need to prefix the string with the current command,
137 * it is added automatically by the client-side RPC stubs.
139 extern void reply_with_error (const char *fs, ...)
140 __attribute__((format (printf,1,2)));
141 extern void reply_with_perror_errno (int err, const char *fs, ...)
142 __attribute__((format (printf,2,3)));
143 #define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
145 /* daemon functions that receive files (FileIn) should call
146 * receive_file for each FileIn parameter.
148 typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
149 extern int receive_file (receive_cb cb, void *opaque);
151 /* daemon functions that receive files (FileIn) can call this
152 * to cancel incoming transfers (eg. if there is a local error).
154 extern int cancel_receive (void);
156 /* daemon functions that return files (FileOut) should call
157 * reply, then send_file_* for each FileOut parameter.
158 * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
160 extern int send_file_write (const void *buf, int len);
161 extern int send_file_end (int cancel);
163 /* only call this if there is a FileOut parameter */
164 extern void reply (xdrproc_t xdrp, char *ret);
166 /* Notify progress to caller. This function is self-rate-limiting so
167 * you can call it as often as necessary. Actions which call this
168 * should add 'Progress' note in generator.
170 extern void notify_progress (uint64_t position, uint64_t total);
172 /* Helper for functions that need a root filesystem mounted.
173 * NB. Cannot be used for FileIn functions.
175 #define NEED_ROOT(cancel_stmt,fail_stmt) \
177 if (!root_mounted) { \
179 reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
185 /* Helper for functions that need an argument ("path") that is absolute.
186 * NB. Cannot be used for FileIn functions.
188 #define ABS_PATH(path,cancel_stmt,fail_stmt) \
190 if ((path)[0] != '/') { \
192 reply_with_error ("%s: path must start with a / character", __func__); \
197 /* All functions that need an argument that is a device or partition name
198 * must call this macro. It checks that the device exists and does
199 * device name translation (described in the guestfs(3) manpage).
200 * Note that the "path" argument may be modified.
202 * NB. Cannot be used for FileIn functions.
204 #define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt) \
206 if (STRNEQLEN ((path), "/dev/", 5)) { \
208 reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
211 if (is_root_device (path)) \
212 reply_with_error ("%s: %s: device not found", __func__, path); \
213 if (device_name_translation ((path)) == -1) { \
217 reply_with_perror ("%s: %s", __func__, path); \
222 /* Helper for functions which need either an absolute path in the
223 * mounted filesystem, OR a /dev/ device which exists.
225 * NB. Cannot be used for FileIn functions.
227 * NB #2: Functions which mix filenames and device paths should be
228 * avoided, and existing functions should be deprecated. This is
229 * because we intend in future to make device parameters a distinct
230 * type from filenames.
232 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt) \
234 if (STREQLEN ((path), "/dev/", 5)) \
235 RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt); \
237 NEED_ROOT (cancel_stmt, fail_stmt); \
238 ABS_PATH ((path), cancel_stmt, fail_stmt); \
243 * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
244 * (2) You must not change directory! cwd must always be "/", otherwise
245 * we can't escape our own chroot.
246 * (3) All paths specified must be absolute.
247 * (4) Neither macro affects errno.
251 int __old_errno = errno; \
252 if (chroot (sysroot) == -1) \
253 perror ("CHROOT_IN: sysroot"); \
254 errno = __old_errno; \
258 int __old_errno = errno; \
259 if (chroot (".") == -1) \
260 perror ("CHROOT_OUT: ."); \
261 errno = __old_errno; \
264 /* Marks functions which are not implemented.
265 * NB. Cannot be used for FileIn functions.
267 #define XXX_NOT_IMPL(errcode) \
269 reply_with_error ("%s: function not implemented", __func__); \
274 /* Marks functions which are not available.
275 * NB. Cannot be used for FileIn functions.
277 #define NOT_AVAILABLE(errcode) \
279 reply_with_error ("%s: function not available", __func__); \
284 #ifndef __attribute__
285 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
286 # define __attribute__(x) /* empty */
290 #ifndef ATTRIBUTE_UNUSED
291 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
294 #define STREQ(a,b) (strcmp((a),(b)) == 0)
295 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
296 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
297 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
298 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
299 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
300 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
301 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
302 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
304 #endif /* GUESTFSD_DAEMON_H */