docs: Routine refresh of the documentation for guestfs(3) and guestfish(1).
[libguestfs.git] / 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 <stdio.h>
23 #include <stdarg.h>
24 #include <errno.h>
25 #include <unistd.h>
26
27 #include <rpc/types.h>
28 #include <rpc/xdr.h>
29
30 #include "../src/guestfs_protocol.h"
31
32 /*-- in guestfsd.c --*/
33 extern int verbose;
34
35 extern const char *sysroot;
36 extern int sysroot_len;
37
38 extern char *sysroot_path (const char *path);
39
40 extern int xwrite (int sock, const void *buf, size_t len)
41   __attribute__((__warn_unused_result__));
42 extern int xread (int sock, void *buf, size_t len)
43   __attribute__((__warn_unused_result__));
44
45 extern int add_string (char ***argv, int *size, int *alloc, const char *str);
46 extern int count_strings (char *const *argv);
47 extern void sort_strings (char **argv, int len);
48 extern void free_strings (char **argv);
49 extern void free_stringslen (char **argv, int len);
50
51 #define command(out,err,name,...) commandf((out),(err),0,(name),__VA_ARGS__)
52 #define commandr(out,err,name,...) commandrf((out),(err),0,(name),__VA_ARGS__)
53 #define commandv(out,err,argv) commandvf((out),(err),0,(argv))
54 #define commandrv(out,err,argv) commandrvf((out),(err),0,(argv))
55
56 #define COMMAND_FLAG_FOLD_STDOUT_ON_STDERR 1
57
58 extern int commandf (char **stdoutput, char **stderror, int flags,
59                      const char *name, ...);
60 extern int commandrf (char **stdoutput, char **stderror, int flags,
61                       const char *name, ...);
62 extern int commandvf (char **stdoutput, char **stderror, int flags,
63                       char const *const *argv);
64 extern int commandrvf (char **stdoutput, char **stderror, int flags,
65                        char const* const *argv);
66
67 extern char **split_lines (char *str);
68
69 extern void trim (char *str);
70
71 extern int device_name_translation (char *device);
72
73 extern int prog_exists (const char *prog);
74
75 extern void udev_settle (void);
76
77 /* This just stops gcc from giving a warning about our custom
78  * printf formatters %Q and %R.  See HACKING file for more
79  * info about these.
80  */
81 static inline int
82 asprintf_nowarn (char **strp, const char *fmt, ...)
83 {
84   int r;
85   va_list args;
86
87   va_start (args, fmt);
88   r = vasprintf (strp, fmt, args);
89   va_end (args);
90   return r;
91 }
92
93 /*-- in names.c (auto-generated) --*/
94 extern const char *function_names[];
95
96 /*-- in proto.c --*/
97 extern int proc_nr;
98 extern int serial;
99
100 /*-- in mount.c --*/
101 extern int root_mounted;
102
103 /*-- in stubs.c (auto-generated) --*/
104 extern void dispatch_incoming_message (XDR *);
105 extern guestfs_int_lvm_pv_list *parse_command_line_pvs (void);
106 extern guestfs_int_lvm_vg_list *parse_command_line_vgs (void);
107 extern guestfs_int_lvm_lv_list *parse_command_line_lvs (void);
108
109 /*-- in optgroups.c (auto-generated) --*/
110 struct optgroup {
111   const char *group;            /* Name of the optional group. */
112   int (*available) (void);      /* Function to test availability. */
113 };
114 extern struct optgroup optgroups[];
115
116 /*-- in sync.c --*/
117 /* Use this as a replacement for sync(2). */
118 extern int sync_disks (void);
119
120 /*-- in proto.c --*/
121 extern void main_loop (int sock) __attribute__((noreturn));
122
123 /* ordinary daemon functions use these to indicate errors
124  * NB: you don't need to prefix the string with the current command,
125  * it is added automatically by the client-side RPC stubs.
126  */
127 extern void reply_with_error (const char *fs, ...)
128   __attribute__((format (printf,1,2)));
129 extern void reply_with_perror_errno (int err, const char *fs, ...)
130   __attribute__((format (printf,2,3)));
131 #define reply_with_perror(...) reply_with_perror_errno(errno, __VA_ARGS__)
132
133 /* daemon functions that receive files (FileIn) should call
134  * receive_file for each FileIn parameter.
135  */
136 typedef int (*receive_cb) (void *opaque, const void *buf, size_t len);
137 extern int receive_file (receive_cb cb, void *opaque);
138
139 /* daemon functions that receive files (FileIn) can call this
140  * to cancel incoming transfers (eg. if there is a local error),
141  * but they MUST then call reply_with_*.
142  */
143 extern void cancel_receive (void);
144
145 /* daemon functions that return files (FileOut) should call
146  * reply, then send_file_* for each FileOut parameter.
147  * Note max write size if GUESTFS_MAX_CHUNK_SIZE.
148  */
149 extern int send_file_write (const void *buf, int len);
150 extern int send_file_end (int cancel);
151
152 /* only call this if there is a FileOut parameter */
153 extern void reply (xdrproc_t xdrp, char *ret);
154
155 /* Helper for functions that need a root filesystem mounted.
156  * NB. Cannot be used for FileIn functions.
157  */
158 #define NEED_ROOT(cancel_stmt,fail_stmt)                                \
159   do {                                                                  \
160     if (!root_mounted) {                                                \
161       cancel_stmt;                                                      \
162       reply_with_error ("%s: you must call 'mount' first to mount the root filesystem", __func__); \
163       fail_stmt;                                                        \
164     }                                                                   \
165   }                                                                     \
166   while (0)
167
168 /* Helper for functions that need an argument ("path") that is absolute.
169  * NB. Cannot be used for FileIn functions.
170  */
171 #define ABS_PATH(path,cancel_stmt,fail_stmt)                            \
172   do {                                                                  \
173     if ((path)[0] != '/') {                                             \
174       cancel_stmt;                                                      \
175       reply_with_error ("%s: path must start with a / character", __func__); \
176       fail_stmt;                                                        \
177     }                                                                   \
178   } while (0)
179
180 /* All functions that need an argument that is a device or partition name
181  * must call this macro.  It checks that the device exists and does
182  * device name translation (described in the guestfs(3) manpage).
183  * Note that the "path" argument may be modified.
184  *
185  * NB. Cannot be used for FileIn functions.
186  */
187 #define RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)                      \
188   do {                                                                  \
189     if (STRNEQLEN ((path), "/dev/", 5)) {                               \
190       cancel_stmt;                                                      \
191       reply_with_error ("%s: %s: expecting a device name", __func__, (path)); \
192       fail_stmt;                                                        \
193     }                                                                   \
194     if (device_name_translation ((path)) == -1) {                       \
195       int err = errno;                                                  \
196       cancel_stmt;                                                      \
197       errno = err;                                                      \
198       reply_with_perror ("%s: %s", __func__, path);                     \
199       fail_stmt;                                                        \
200     }                                                                   \
201   } while (0)
202
203 /* Helper for functions which need either an absolute path in the
204  * mounted filesystem, OR a /dev/ device which exists.
205  *
206  * NB. Cannot be used for FileIn functions.
207  *
208  * NB #2: Functions which mix filenames and device paths should be
209  * avoided, and existing functions should be deprecated.  This is
210  * because we intend in future to make device parameters a distinct
211  * type from filenames.
212  */
213 #define REQUIRE_ROOT_OR_RESOLVE_DEVICE(path,cancel_stmt,fail_stmt)      \
214   do {                                                                  \
215     if (STREQLEN ((path), "/dev/", 5))                                  \
216       RESOLVE_DEVICE ((path), cancel_stmt, fail_stmt);                  \
217     else {                                                              \
218       NEED_ROOT (cancel_stmt, fail_stmt);                               \
219       ABS_PATH ((path), cancel_stmt, fail_stmt);                        \
220     }                                                                   \
221   } while (0)
222
223 /* NB:
224  * (1) You must match CHROOT_IN and CHROOT_OUT even along error paths.
225  * (2) You must not change directory!  cwd must always be "/", otherwise
226  *     we can't escape our own chroot.
227  * (3) All paths specified must be absolute.
228  * (4) Neither macro affects errno.
229  */
230 #define CHROOT_IN                               \
231   do {                                          \
232     int __old_errno = errno;                    \
233     if (chroot (sysroot) == -1)                 \
234       perror ("CHROOT_IN: sysroot");            \
235     errno = __old_errno;                        \
236   } while (0)
237 #define CHROOT_OUT                              \
238   do {                                          \
239     int __old_errno = errno;                    \
240     if (chroot (".") == -1)                     \
241       perror ("CHROOT_OUT: .");                 \
242     errno = __old_errno;                        \
243   } while (0)
244
245 /* Marks functions which are not implemented.
246  * NB. Cannot be used for FileIn functions.
247  */
248 #define XXX_NOT_IMPL(errcode)                                           \
249   do {                                                                  \
250     reply_with_error ("%s: function not implemented", __func__);        \
251     return (errcode);                                                   \
252   }                                                                     \
253   while (0)
254
255 /* Marks functions which are not available.
256  * NB. Cannot be used for FileIn functions.
257  */
258 #define NOT_AVAILABLE(errcode)                                          \
259   do {                                                                  \
260     reply_with_error ("%s: function not available", __func__);          \
261     return (errcode);                                                   \
262   }                                                                     \
263   while (0)
264
265 #ifndef __attribute__
266 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
267 #  define __attribute__(x) /* empty */
268 # endif
269 #endif
270
271 #ifndef ATTRIBUTE_UNUSED
272 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
273 #endif
274
275 #define STREQ(a,b) (strcmp((a),(b)) == 0)
276 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
277 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
278 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
279 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
280 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
281 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
282 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
283 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
284
285 #endif /* GUESTFSD_DAEMON_H */