]>
Commit | Line | Data |
---|---|---|
48ff7a62 MR |
1 | /* |
2 | * QEMU Guest Agent | |
3 | * | |
4 | * Copyright IBM Corp. 2011 | |
5 | * | |
6 | * Authors: | |
7 | * Adam Litke <[email protected]> | |
8 | * Michael Roth <[email protected]> | |
9 | * | |
10 | * This work is licensed under the terms of the GNU GPL, version 2 or later. | |
11 | * See the COPYING file in the top-level directory. | |
12 | */ | |
4459bf38 | 13 | #include "qemu/osdep.h" |
48ff7a62 | 14 | #include <getopt.h> |
39097daf | 15 | #include <glib/gstdio.h> |
d8ca685a | 16 | #ifndef _WIN32 |
48ff7a62 | 17 | #include <syslog.h> |
11d0f125 | 18 | #include <sys/wait.h> |
d8ca685a | 19 | #endif |
7b1b5d19 PB |
20 | #include "qapi/qmp/json-streamer.h" |
21 | #include "qapi/qmp/json-parser.h" | |
7b1b5d19 | 22 | #include "qapi/qmp/qjson.h" |
48ff7a62 | 23 | #include "qga/guest-agent-core.h" |
1de7afc9 | 24 | #include "qemu/module.h" |
7b1b5d19 PB |
25 | #include "qapi/qmp/qerror.h" |
26 | #include "qapi/qmp/dispatch.h" | |
125b310e | 27 | #include "qga/channel.h" |
39097daf | 28 | #include "qemu/bswap.h" |
f348b6d1 | 29 | #include "qemu/help_option.h" |
26de2296 | 30 | #include "qemu/sockets.h" |
53fabd4b | 31 | #include "qemu/systemd.h" |
8f1c29af | 32 | #include "qemu-version.h" |
bc62fa03 MR |
33 | #ifdef _WIN32 |
34 | #include "qga/service-win32.h" | |
f311f2c2 | 35 | #include "qga/vss-win32.h" |
bc62fa03 | 36 | #endif |
ec0f694c TS |
37 | #ifdef __linux__ |
38 | #include <linux/fs.h> | |
39 | #ifdef FIFREEZE | |
40 | #define CONFIG_FSFREEZE | |
41 | #endif | |
42 | #endif | |
48ff7a62 | 43 | |
7868e26e | 44 | #ifndef _WIN32 |
48ff7a62 | 45 | #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0" |
c394ecb7 | 46 | #define QGA_STATE_RELATIVE_DIR "run" |
a749f42d | 47 | #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0" |
7868e26e MR |
48 | #else |
49 | #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0" | |
c394ecb7 | 50 | #define QGA_STATE_RELATIVE_DIR "qemu-ga" |
a749f42d | 51 | #define QGA_SERIAL_PATH_DEFAULT "COM1" |
7868e26e | 52 | #endif |
ec0f694c TS |
53 | #ifdef CONFIG_FSFREEZE |
54 | #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook" | |
55 | #endif | |
3cf0bed8 | 56 | #define QGA_SENTINEL_BYTE 0xFF |
e236d060 | 57 | #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf" |
48ff7a62 | 58 | |
c394ecb7 LE |
59 | static struct { |
60 | const char *state_dir; | |
61 | const char *pidfile; | |
62 | } dfl_pathnames; | |
63 | ||
39097daf MR |
64 | typedef struct GAPersistentState { |
65 | #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000 | |
66 | int64_t fd_counter; | |
67 | } GAPersistentState; | |
68 | ||
48ff7a62 MR |
69 | struct GAState { |
70 | JSONMessageParser parser; | |
71 | GMainLoop *main_loop; | |
125b310e | 72 | GAChannel *channel; |
48ff7a62 MR |
73 | bool virtio; /* fastpath to check for virtio to deal with poll() quirks */ |
74 | GACommandState *command_state; | |
75 | GLogLevelFlags log_level; | |
76 | FILE *log_file; | |
77 | bool logging_enabled; | |
bc62fa03 MR |
78 | #ifdef _WIN32 |
79 | GAService service; | |
80 | #endif | |
3cf0bed8 | 81 | bool delimit_response; |
f22d85e9 MR |
82 | bool frozen; |
83 | GList *blacklist; | |
d4c8a5d4 | 84 | char *state_filepath_isfrozen; |
f789aa7b MR |
85 | struct { |
86 | const char *log_filepath; | |
87 | const char *pid_filepath; | |
88 | } deferred_options; | |
ec0f694c TS |
89 | #ifdef CONFIG_FSFREEZE |
90 | const char *fsfreeze_hook; | |
91 | #endif | |
d4c8a5d4 | 92 | gchar *pstate_filepath; |
39097daf | 93 | GAPersistentState pstate; |
48ff7a62 MR |
94 | }; |
95 | ||
3cf0bed8 | 96 | struct GAState *ga_state; |
1527badb | 97 | QmpCommandList ga_commands; |
48ff7a62 | 98 | |
f22d85e9 MR |
99 | /* commands that are safe to issue while filesystems are frozen */ |
100 | static const char *ga_freeze_whitelist[] = { | |
101 | "guest-ping", | |
102 | "guest-info", | |
103 | "guest-sync", | |
c5dcb6ae | 104 | "guest-sync-delimited", |
f22d85e9 MR |
105 | "guest-fsfreeze-status", |
106 | "guest-fsfreeze-thaw", | |
107 | NULL | |
108 | }; | |
109 | ||
bc62fa03 MR |
110 | #ifdef _WIN32 |
111 | DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data, | |
112 | LPVOID ctx); | |
113 | VOID WINAPI service_main(DWORD argc, TCHAR *argv[]); | |
114 | #endif | |
115 | ||
c394ecb7 LE |
116 | static void |
117 | init_dfl_pathnames(void) | |
118 | { | |
119 | g_assert(dfl_pathnames.state_dir == NULL); | |
120 | g_assert(dfl_pathnames.pidfile == NULL); | |
121 | dfl_pathnames.state_dir = qemu_get_local_state_pathname( | |
122 | QGA_STATE_RELATIVE_DIR); | |
123 | dfl_pathnames.pidfile = qemu_get_local_state_pathname( | |
124 | QGA_STATE_RELATIVE_DIR G_DIR_SEPARATOR_S "qemu-ga.pid"); | |
125 | } | |
126 | ||
48ff7a62 MR |
127 | static void quit_handler(int sig) |
128 | { | |
f22d85e9 MR |
129 | /* if we're frozen, don't exit unless we're absolutely forced to, |
130 | * because it's basically impossible for graceful exit to complete | |
131 | * unless all log/pid files are on unfreezable filesystems. there's | |
132 | * also a very likely chance killing the agent before unfreezing | |
133 | * the filesystems is a mistake (or will be viewed as one later). | |
94d81ae8 SJ |
134 | * On Windows the freeze interval is limited to 10 seconds, so |
135 | * we should quit, but first we should wait for the timeout, thaw | |
136 | * the filesystem and quit. | |
f22d85e9 MR |
137 | */ |
138 | if (ga_is_frozen(ga_state)) { | |
94d81ae8 SJ |
139 | #ifdef _WIN32 |
140 | int i = 0; | |
141 | Error *err = NULL; | |
142 | HANDLE hEventTimeout; | |
143 | ||
144 | g_debug("Thawing filesystems before exiting"); | |
145 | ||
146 | hEventTimeout = OpenEvent(EVENT_ALL_ACCESS, FALSE, EVENT_NAME_TIMEOUT); | |
147 | if (hEventTimeout) { | |
148 | WaitForSingleObject(hEventTimeout, 0); | |
149 | CloseHandle(hEventTimeout); | |
150 | } | |
151 | qga_vss_fsfreeze(&i, false, &err); | |
152 | if (err) { | |
153 | g_debug("Error unfreezing filesystems prior to exiting: %s", | |
154 | error_get_pretty(err)); | |
155 | error_free(err); | |
156 | } | |
157 | #else | |
f22d85e9 | 158 | return; |
94d81ae8 | 159 | #endif |
f22d85e9 | 160 | } |
2542bfd5 | 161 | g_debug("received signal num %d, quitting", sig); |
48ff7a62 MR |
162 | |
163 | if (g_main_loop_is_running(ga_state->main_loop)) { | |
164 | g_main_loop_quit(ga_state->main_loop); | |
165 | } | |
166 | } | |
167 | ||
bc62fa03 | 168 | #ifndef _WIN32 |
125b310e | 169 | static gboolean register_signal_handlers(void) |
48ff7a62 | 170 | { |
dc8764f0 | 171 | struct sigaction sigact; |
48ff7a62 MR |
172 | int ret; |
173 | ||
174 | memset(&sigact, 0, sizeof(struct sigaction)); | |
175 | sigact.sa_handler = quit_handler; | |
176 | ||
177 | ret = sigaction(SIGINT, &sigact, NULL); | |
178 | if (ret == -1) { | |
179 | g_error("error configuring signal handler: %s", strerror(errno)); | |
48ff7a62 MR |
180 | } |
181 | ret = sigaction(SIGTERM, &sigact, NULL); | |
182 | if (ret == -1) { | |
183 | g_error("error configuring signal handler: %s", strerror(errno)); | |
184 | } | |
11d0f125 | 185 | |
4005b473 DL |
186 | sigact.sa_handler = SIG_IGN; |
187 | if (sigaction(SIGPIPE, &sigact, NULL) != 0) { | |
188 | g_error("error configuring SIGPIPE signal handler: %s", | |
189 | strerror(errno)); | |
190 | } | |
191 | ||
125b310e | 192 | return true; |
48ff7a62 | 193 | } |
04b4e75f LC |
194 | |
195 | /* TODO: use this in place of all post-fork() fclose(std*) callers */ | |
196 | void reopen_fd_to_null(int fd) | |
197 | { | |
198 | int nullfd; | |
199 | ||
200 | nullfd = open("/dev/null", O_RDWR); | |
201 | if (nullfd < 0) { | |
202 | return; | |
203 | } | |
204 | ||
205 | dup2(nullfd, fd); | |
206 | ||
207 | if (nullfd != fd) { | |
208 | close(nullfd); | |
209 | } | |
210 | } | |
d8ca685a | 211 | #endif |
48ff7a62 MR |
212 | |
213 | static void usage(const char *cmd) | |
214 | { | |
215 | printf( | |
4bdd0416 | 216 | "Usage: %s [-m <method> -p <path>] [<options>]\n" |
8f1c29af EB |
217 | "QEMU Guest Agent " QEMU_VERSION QEMU_PKGVERSION "\n" |
218 | QEMU_COPYRIGHT "\n" | |
48ff7a62 | 219 | "\n" |
586ef5de SH |
220 | " -m, --method transport method: one of unix-listen, virtio-serial,\n" |
221 | " isa-serial, or vsock-listen (virtio-serial is the default)\n" | |
4bdd0416 | 222 | " -p, --path device/socket path (the default for virtio-serial is:\n" |
a749f42d MM |
223 | " %s,\n" |
224 | " the default for isa-serial is:\n" | |
4bdd0416 | 225 | " %s)\n" |
48ff7a62 MR |
226 | " -l, --logfile set logfile path, logs to stderr by default\n" |
227 | " -f, --pidfile specify pidfile (default is %s)\n" | |
ec0f694c TS |
228 | #ifdef CONFIG_FSFREEZE |
229 | " -F, --fsfreeze-hook\n" | |
230 | " enable fsfreeze hook. Accepts an optional argument that\n" | |
231 | " specifies script to run on freeze/thaw. Script will be\n" | |
232 | " called with 'freeze'/'thaw' arguments accordingly.\n" | |
233 | " (default is %s)\n" | |
234 | " If using -F with an argument, do not follow -F with a\n" | |
235 | " space.\n" | |
236 | " (for example: -F/var/run/fsfreezehook.sh)\n" | |
237 | #endif | |
f789aa7b MR |
238 | " -t, --statedir specify dir to store state information (absolute paths\n" |
239 | " only, default is %s)\n" | |
48ff7a62 MR |
240 | " -v, --verbose log extra debugging information\n" |
241 | " -V, --version print version information and exit\n" | |
242 | " -d, --daemonize become a daemon\n" | |
bc62fa03 | 243 | #ifdef _WIN32 |
5e031072 | 244 | " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n" |
d8ca685a | 245 | #endif |
4bdd0416 | 246 | " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n" |
abd6cf6d | 247 | " to list available RPCs)\n" |
aeadcbb6 MAL |
248 | " -D, --dump-conf dump a qemu-ga config file based on current config\n" |
249 | " options / command-line parameters to stdout\n" | |
48ff7a62 MR |
250 | " -h, --help display this help and exit\n" |
251 | "\n" | |
f5048cb7 | 252 | QEMU_HELP_BOTTOM "\n" |
8f1c29af | 253 | , cmd, QGA_VIRTIO_PATH_DEFAULT, QGA_SERIAL_PATH_DEFAULT, |
a749f42d | 254 | dfl_pathnames.pidfile, |
ec0f694c TS |
255 | #ifdef CONFIG_FSFREEZE |
256 | QGA_FSFREEZE_HOOK_DEFAULT, | |
257 | #endif | |
c394ecb7 | 258 | dfl_pathnames.state_dir); |
48ff7a62 MR |
259 | } |
260 | ||
48ff7a62 MR |
261 | static const char *ga_log_level_str(GLogLevelFlags level) |
262 | { | |
263 | switch (level & G_LOG_LEVEL_MASK) { | |
264 | case G_LOG_LEVEL_ERROR: | |
265 | return "error"; | |
266 | case G_LOG_LEVEL_CRITICAL: | |
267 | return "critical"; | |
268 | case G_LOG_LEVEL_WARNING: | |
269 | return "warning"; | |
270 | case G_LOG_LEVEL_MESSAGE: | |
271 | return "message"; | |
272 | case G_LOG_LEVEL_INFO: | |
273 | return "info"; | |
274 | case G_LOG_LEVEL_DEBUG: | |
275 | return "debug"; | |
276 | default: | |
277 | return "user"; | |
278 | } | |
279 | } | |
280 | ||
281 | bool ga_logging_enabled(GAState *s) | |
282 | { | |
283 | return s->logging_enabled; | |
284 | } | |
285 | ||
286 | void ga_disable_logging(GAState *s) | |
287 | { | |
288 | s->logging_enabled = false; | |
289 | } | |
290 | ||
291 | void ga_enable_logging(GAState *s) | |
292 | { | |
293 | s->logging_enabled = true; | |
294 | } | |
295 | ||
296 | static void ga_log(const gchar *domain, GLogLevelFlags level, | |
297 | const gchar *msg, gpointer opaque) | |
298 | { | |
299 | GAState *s = opaque; | |
300 | GTimeVal time; | |
301 | const char *level_str = ga_log_level_str(level); | |
302 | ||
303 | if (!ga_logging_enabled(s)) { | |
304 | return; | |
305 | } | |
306 | ||
307 | level &= G_LOG_LEVEL_MASK; | |
d8ca685a | 308 | #ifndef _WIN32 |
f300414c | 309 | if (g_strcmp0(domain, "syslog") == 0) { |
48ff7a62 MR |
310 | syslog(LOG_INFO, "%s: %s", level_str, msg); |
311 | } else if (level & s->log_level) { | |
d8ca685a MR |
312 | #else |
313 | if (level & s->log_level) { | |
314 | #endif | |
48ff7a62 MR |
315 | g_get_current_time(&time); |
316 | fprintf(s->log_file, | |
317 | "%lu.%lu: %s: %s\n", time.tv_sec, time.tv_usec, level_str, msg); | |
318 | fflush(s->log_file); | |
319 | } | |
320 | } | |
321 | ||
3cf0bed8 MR |
322 | void ga_set_response_delimited(GAState *s) |
323 | { | |
324 | s->delimit_response = true; | |
325 | } | |
326 | ||
9e92f6d4 LC |
327 | static FILE *ga_open_logfile(const char *logfile) |
328 | { | |
329 | FILE *f; | |
330 | ||
331 | f = fopen(logfile, "a"); | |
332 | if (!f) { | |
333 | return NULL; | |
334 | } | |
335 | ||
336 | qemu_set_cloexec(fileno(f)); | |
337 | return f; | |
338 | } | |
339 | ||
f789aa7b MR |
340 | #ifndef _WIN32 |
341 | static bool ga_open_pidfile(const char *pidfile) | |
342 | { | |
343 | int pidfd; | |
344 | char pidstr[32]; | |
345 | ||
6ffacc5d | 346 | pidfd = qemu_open(pidfile, O_CREAT|O_WRONLY, S_IRUSR|S_IWUSR); |
f789aa7b MR |
347 | if (pidfd == -1 || lockf(pidfd, F_TLOCK, 0)) { |
348 | g_critical("Cannot lock pid file, %s", strerror(errno)); | |
4144f122 JM |
349 | if (pidfd != -1) { |
350 | close(pidfd); | |
351 | } | |
f789aa7b MR |
352 | return false; |
353 | } | |
354 | ||
5d27f9ce | 355 | if (ftruncate(pidfd, 0)) { |
f789aa7b MR |
356 | g_critical("Failed to truncate pid file"); |
357 | goto fail; | |
358 | } | |
9d6f1b73 | 359 | snprintf(pidstr, sizeof(pidstr), "%d\n", getpid()); |
f789aa7b MR |
360 | if (write(pidfd, pidstr, strlen(pidstr)) != strlen(pidstr)) { |
361 | g_critical("Failed to write pid file"); | |
362 | goto fail; | |
363 | } | |
364 | ||
03ac10f1 | 365 | /* keep pidfile open & locked forever */ |
f789aa7b MR |
366 | return true; |
367 | ||
368 | fail: | |
369 | unlink(pidfile); | |
03ac10f1 | 370 | close(pidfd); |
f789aa7b MR |
371 | return false; |
372 | } | |
373 | #else /* _WIN32 */ | |
374 | static bool ga_open_pidfile(const char *pidfile) | |
375 | { | |
376 | return true; | |
377 | } | |
378 | #endif | |
379 | ||
f22d85e9 MR |
380 | static gint ga_strcmp(gconstpointer str1, gconstpointer str2) |
381 | { | |
382 | return strcmp(str1, str2); | |
383 | } | |
384 | ||
385 | /* disable commands that aren't safe for fsfreeze */ | |
8dc4d915 | 386 | static void ga_disable_non_whitelisted(QmpCommand *cmd, void *opaque) |
f22d85e9 | 387 | { |
8dc4d915 MW |
388 | bool whitelisted = false; |
389 | int i = 0; | |
390 | const char *name = qmp_command_name(cmd); | |
391 | ||
392 | while (ga_freeze_whitelist[i] != NULL) { | |
393 | if (strcmp(name, ga_freeze_whitelist[i]) == 0) { | |
394 | whitelisted = true; | |
f22d85e9 | 395 | } |
8dc4d915 MW |
396 | i++; |
397 | } | |
398 | if (!whitelisted) { | |
399 | g_debug("disabling command: %s", name); | |
1527badb | 400 | qmp_disable_command(&ga_commands, name); |
f22d85e9 | 401 | } |
f22d85e9 MR |
402 | } |
403 | ||
a31f0531 | 404 | /* [re-]enable all commands, except those explicitly blacklisted by user */ |
8dc4d915 | 405 | static void ga_enable_non_blacklisted(QmpCommand *cmd, void *opaque) |
f22d85e9 | 406 | { |
8dc4d915 MW |
407 | GList *blacklist = opaque; |
408 | const char *name = qmp_command_name(cmd); | |
409 | ||
410 | if (g_list_find_custom(blacklist, name, ga_strcmp) == NULL && | |
411 | !qmp_command_is_enabled(cmd)) { | |
412 | g_debug("enabling command: %s", name); | |
1527badb | 413 | qmp_enable_command(&ga_commands, name); |
f22d85e9 | 414 | } |
f22d85e9 MR |
415 | } |
416 | ||
f789aa7b MR |
417 | static bool ga_create_file(const char *path) |
418 | { | |
419 | int fd = open(path, O_CREAT | O_WRONLY, S_IWUSR | S_IRUSR); | |
420 | if (fd == -1) { | |
421 | g_warning("unable to open/create file %s: %s", path, strerror(errno)); | |
422 | return false; | |
423 | } | |
424 | close(fd); | |
425 | return true; | |
426 | } | |
427 | ||
428 | static bool ga_delete_file(const char *path) | |
429 | { | |
430 | int ret = unlink(path); | |
431 | if (ret == -1) { | |
432 | g_warning("unable to delete file: %s: %s", path, strerror(errno)); | |
433 | return false; | |
434 | } | |
435 | ||
436 | return true; | |
437 | } | |
438 | ||
f22d85e9 MR |
439 | bool ga_is_frozen(GAState *s) |
440 | { | |
441 | return s->frozen; | |
442 | } | |
443 | ||
444 | void ga_set_frozen(GAState *s) | |
445 | { | |
446 | if (ga_is_frozen(s)) { | |
447 | return; | |
448 | } | |
449 | /* disable all non-whitelisted (for frozen state) commands */ | |
1527badb | 450 | qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL); |
f22d85e9 MR |
451 | g_warning("disabling logging due to filesystem freeze"); |
452 | ga_disable_logging(s); | |
453 | s->frozen = true; | |
f789aa7b MR |
454 | if (!ga_create_file(s->state_filepath_isfrozen)) { |
455 | g_warning("unable to create %s, fsfreeze may not function properly", | |
456 | s->state_filepath_isfrozen); | |
457 | } | |
f22d85e9 MR |
458 | } |
459 | ||
460 | void ga_unset_frozen(GAState *s) | |
461 | { | |
462 | if (!ga_is_frozen(s)) { | |
463 | return; | |
464 | } | |
465 | ||
f789aa7b MR |
466 | /* if we delayed creation/opening of pid/log files due to being |
467 | * in a frozen state at start up, do it now | |
468 | */ | |
469 | if (s->deferred_options.log_filepath) { | |
9e92f6d4 | 470 | s->log_file = ga_open_logfile(s->deferred_options.log_filepath); |
f789aa7b MR |
471 | if (!s->log_file) { |
472 | s->log_file = stderr; | |
473 | } | |
474 | s->deferred_options.log_filepath = NULL; | |
475 | } | |
f22d85e9 | 476 | ga_enable_logging(s); |
f789aa7b MR |
477 | g_warning("logging re-enabled due to filesystem unfreeze"); |
478 | if (s->deferred_options.pid_filepath) { | |
479 | if (!ga_open_pidfile(s->deferred_options.pid_filepath)) { | |
480 | g_warning("failed to create/open pid file"); | |
481 | } | |
482 | s->deferred_options.pid_filepath = NULL; | |
483 | } | |
f22d85e9 MR |
484 | |
485 | /* enable all disabled, non-blacklisted commands */ | |
1527badb | 486 | qmp_for_each_command(&ga_commands, ga_enable_non_blacklisted, s->blacklist); |
f22d85e9 | 487 | s->frozen = false; |
f789aa7b MR |
488 | if (!ga_delete_file(s->state_filepath_isfrozen)) { |
489 | g_warning("unable to delete %s, fsfreeze may not function properly", | |
490 | s->state_filepath_isfrozen); | |
491 | } | |
f22d85e9 MR |
492 | } |
493 | ||
ec0f694c TS |
494 | #ifdef CONFIG_FSFREEZE |
495 | const char *ga_fsfreeze_hook(GAState *s) | |
496 | { | |
497 | return s->fsfreeze_hook; | |
498 | } | |
499 | #endif | |
500 | ||
48ff7a62 MR |
501 | static void become_daemon(const char *pidfile) |
502 | { | |
f789aa7b | 503 | #ifndef _WIN32 |
48ff7a62 | 504 | pid_t pid, sid; |
48ff7a62 MR |
505 | |
506 | pid = fork(); | |
507 | if (pid < 0) { | |
508 | exit(EXIT_FAILURE); | |
509 | } | |
510 | if (pid > 0) { | |
511 | exit(EXIT_SUCCESS); | |
512 | } | |
513 | ||
f789aa7b MR |
514 | if (pidfile) { |
515 | if (!ga_open_pidfile(pidfile)) { | |
516 | g_critical("failed to create pidfile"); | |
517 | exit(EXIT_FAILURE); | |
518 | } | |
48ff7a62 MR |
519 | } |
520 | ||
c689b4f1 | 521 | umask(S_IRWXG | S_IRWXO); |
48ff7a62 MR |
522 | sid = setsid(); |
523 | if (sid < 0) { | |
524 | goto fail; | |
525 | } | |
526 | if ((chdir("/")) < 0) { | |
527 | goto fail; | |
528 | } | |
529 | ||
226a4894 LC |
530 | reopen_fd_to_null(STDIN_FILENO); |
531 | reopen_fd_to_null(STDOUT_FILENO); | |
532 | reopen_fd_to_null(STDERR_FILENO); | |
48ff7a62 MR |
533 | return; |
534 | ||
535 | fail: | |
4bdb1a30 SW |
536 | if (pidfile) { |
537 | unlink(pidfile); | |
538 | } | |
48ff7a62 MR |
539 | g_critical("failed to daemonize"); |
540 | exit(EXIT_FAILURE); | |
d8ca685a | 541 | #endif |
f789aa7b | 542 | } |
48ff7a62 | 543 | |
125b310e | 544 | static int send_response(GAState *s, QObject *payload) |
48ff7a62 | 545 | { |
48ff7a62 | 546 | const char *buf; |
3cf0bed8 | 547 | QString *payload_qstr, *response_qstr; |
125b310e | 548 | GIOStatus status; |
48ff7a62 | 549 | |
125b310e | 550 | g_assert(payload && s->channel); |
48ff7a62 MR |
551 | |
552 | payload_qstr = qobject_to_json(payload); | |
553 | if (!payload_qstr) { | |
554 | return -EINVAL; | |
555 | } | |
556 | ||
3cf0bed8 MR |
557 | if (s->delimit_response) { |
558 | s->delimit_response = false; | |
559 | response_qstr = qstring_new(); | |
560 | qstring_append_chr(response_qstr, QGA_SENTINEL_BYTE); | |
561 | qstring_append(response_qstr, qstring_get_str(payload_qstr)); | |
562 | QDECREF(payload_qstr); | |
563 | } else { | |
564 | response_qstr = payload_qstr; | |
565 | } | |
566 | ||
567 | qstring_append_chr(response_qstr, '\n'); | |
568 | buf = qstring_get_str(response_qstr); | |
125b310e | 569 | status = ga_channel_write_all(s->channel, buf, strlen(buf)); |
3cf0bed8 | 570 | QDECREF(response_qstr); |
125b310e MR |
571 | if (status != G_IO_STATUS_NORMAL) { |
572 | return -EIO; | |
48ff7a62 | 573 | } |
125b310e MR |
574 | |
575 | return 0; | |
48ff7a62 MR |
576 | } |
577 | ||
578 | static void process_command(GAState *s, QDict *req) | |
579 | { | |
580 | QObject *rsp = NULL; | |
581 | int ret; | |
582 | ||
583 | g_assert(req); | |
584 | g_debug("processing command"); | |
1527badb | 585 | rsp = qmp_dispatch(&ga_commands, QOBJECT(req)); |
48ff7a62 | 586 | if (rsp) { |
125b310e | 587 | ret = send_response(s, rsp); |
47b0c3f2 PB |
588 | if (ret < 0) { |
589 | g_warning("error sending response: %s", strerror(-ret)); | |
48ff7a62 MR |
590 | } |
591 | qobject_decref(rsp); | |
48ff7a62 MR |
592 | } |
593 | } | |
594 | ||
595 | /* handle requests/control events coming in over the channel */ | |
95385fe9 | 596 | static void process_event(JSONMessageParser *parser, GQueue *tokens) |
48ff7a62 MR |
597 | { |
598 | GAState *s = container_of(parser, GAState, parser); | |
48ff7a62 MR |
599 | QDict *qdict; |
600 | Error *err = NULL; | |
601 | int ret; | |
602 | ||
603 | g_assert(s && parser); | |
604 | ||
605 | g_debug("process_event: called"); | |
89cad9f3 MA |
606 | qdict = qobject_to_qdict(json_parser_parse_err(tokens, NULL, &err)); |
607 | if (err || !qdict) { | |
608 | QDECREF(qdict); | |
48ff7a62 MR |
609 | qdict = qdict_new(); |
610 | if (!err) { | |
611 | g_warning("failed to parse event: unknown error"); | |
c6bd8c70 | 612 | error_setg(&err, QERR_JSON_PARSING); |
48ff7a62 MR |
613 | } else { |
614 | g_warning("failed to parse event: %s", error_get_pretty(err)); | |
615 | } | |
93b91c59 | 616 | qdict_put_obj(qdict, "error", qmp_build_error_object(err)); |
48ff7a62 | 617 | error_free(err); |
48ff7a62 MR |
618 | } |
619 | ||
48ff7a62 MR |
620 | /* handle host->guest commands */ |
621 | if (qdict_haskey(qdict, "execute")) { | |
622 | process_command(s, qdict); | |
623 | } else { | |
624 | if (!qdict_haskey(qdict, "error")) { | |
625 | QDECREF(qdict); | |
626 | qdict = qdict_new(); | |
627 | g_warning("unrecognized payload format"); | |
c6bd8c70 | 628 | error_setg(&err, QERR_UNSUPPORTED); |
93b91c59 | 629 | qdict_put_obj(qdict, "error", qmp_build_error_object(err)); |
48ff7a62 MR |
630 | error_free(err); |
631 | } | |
125b310e | 632 | ret = send_response(s, QOBJECT(qdict)); |
1def7454 GA |
633 | if (ret < 0) { |
634 | g_warning("error sending error response: %s", strerror(-ret)); | |
48ff7a62 MR |
635 | } |
636 | } | |
637 | ||
638 | QDECREF(qdict); | |
639 | } | |
640 | ||
125b310e MR |
641 | /* false return signals GAChannel to close the current client connection */ |
642 | static gboolean channel_event_cb(GIOCondition condition, gpointer data) | |
48ff7a62 MR |
643 | { |
644 | GAState *s = data; | |
125b310e | 645 | gchar buf[QGA_READ_COUNT_DEFAULT+1]; |
48ff7a62 | 646 | gsize count; |
125b310e | 647 | GIOStatus status = ga_channel_read(s->channel, buf, QGA_READ_COUNT_DEFAULT, &count); |
48ff7a62 MR |
648 | switch (status) { |
649 | case G_IO_STATUS_ERROR: | |
125b310e | 650 | g_warning("error reading channel"); |
48ff7a62 MR |
651 | return false; |
652 | case G_IO_STATUS_NORMAL: | |
125b310e | 653 | buf[count] = 0; |
48ff7a62 MR |
654 | g_debug("read data, count: %d, data: %s", (int)count, buf); |
655 | json_message_parser_feed(&s->parser, (char *)buf, (int)count); | |
125b310e MR |
656 | break; |
657 | case G_IO_STATUS_EOF: | |
658 | g_debug("received EOF"); | |
659 | if (!s->virtio) { | |
660 | return false; | |
661 | } | |
f5b79578 | 662 | /* fall through */ |
48ff7a62 MR |
663 | case G_IO_STATUS_AGAIN: |
664 | /* virtio causes us to spin here when no process is attached to | |
665 | * host-side chardev. sleep a bit to mitigate this | |
666 | */ | |
667 | if (s->virtio) { | |
668 | usleep(100*1000); | |
669 | } | |
670 | return true; | |
48ff7a62 MR |
671 | default: |
672 | g_warning("unknown channel read status, closing"); | |
48ff7a62 MR |
673 | return false; |
674 | } | |
675 | return true; | |
676 | } | |
677 | ||
26de2296 SH |
678 | static gboolean channel_init(GAState *s, const gchar *method, const gchar *path, |
679 | int listen_fd) | |
48ff7a62 | 680 | { |
125b310e | 681 | GAChannelMethod channel_method; |
48ff7a62 | 682 | |
125b310e MR |
683 | if (strcmp(method, "virtio-serial") == 0) { |
684 | s->virtio = true; /* virtio requires special handling in some cases */ | |
685 | channel_method = GA_CHANNEL_VIRTIO_SERIAL; | |
686 | } else if (strcmp(method, "isa-serial") == 0) { | |
687 | channel_method = GA_CHANNEL_ISA_SERIAL; | |
688 | } else if (strcmp(method, "unix-listen") == 0) { | |
689 | channel_method = GA_CHANNEL_UNIX_LISTEN; | |
586ef5de SH |
690 | } else if (strcmp(method, "vsock-listen") == 0) { |
691 | channel_method = GA_CHANNEL_VSOCK_LISTEN; | |
48ff7a62 | 692 | } else { |
125b310e MR |
693 | g_critical("unsupported channel method/type: %s", method); |
694 | return false; | |
48ff7a62 MR |
695 | } |
696 | ||
26de2296 SH |
697 | s->channel = ga_channel_new(channel_method, path, listen_fd, |
698 | channel_event_cb, s); | |
125b310e MR |
699 | if (!s->channel) { |
700 | g_critical("failed to create guest agent channel"); | |
701 | return false; | |
702 | } | |
703 | ||
704 | return true; | |
48ff7a62 MR |
705 | } |
706 | ||
bc62fa03 MR |
707 | #ifdef _WIN32 |
708 | DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data, | |
709 | LPVOID ctx) | |
710 | { | |
711 | DWORD ret = NO_ERROR; | |
712 | GAService *service = &ga_state->service; | |
713 | ||
714 | switch (ctrl) | |
715 | { | |
716 | case SERVICE_CONTROL_STOP: | |
717 | case SERVICE_CONTROL_SHUTDOWN: | |
718 | quit_handler(SIGTERM); | |
719 | service->status.dwCurrentState = SERVICE_STOP_PENDING; | |
720 | SetServiceStatus(service->status_handle, &service->status); | |
721 | break; | |
722 | ||
723 | default: | |
724 | ret = ERROR_CALL_NOT_IMPLEMENTED; | |
725 | } | |
726 | return ret; | |
727 | } | |
728 | ||
729 | VOID WINAPI service_main(DWORD argc, TCHAR *argv[]) | |
730 | { | |
731 | GAService *service = &ga_state->service; | |
732 | ||
733 | service->status_handle = RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME, | |
734 | service_ctrl_handler, NULL); | |
735 | ||
736 | if (service->status_handle == 0) { | |
737 | g_critical("Failed to register extended requests function!\n"); | |
738 | return; | |
739 | } | |
740 | ||
741 | service->status.dwServiceType = SERVICE_WIN32; | |
742 | service->status.dwCurrentState = SERVICE_RUNNING; | |
743 | service->status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN; | |
744 | service->status.dwWin32ExitCode = NO_ERROR; | |
745 | service->status.dwServiceSpecificExitCode = NO_ERROR; | |
746 | service->status.dwCheckPoint = 0; | |
747 | service->status.dwWaitHint = 0; | |
748 | SetServiceStatus(service->status_handle, &service->status); | |
749 | ||
750 | g_main_loop_run(ga_state->main_loop); | |
751 | ||
752 | service->status.dwCurrentState = SERVICE_STOPPED; | |
753 | SetServiceStatus(service->status_handle, &service->status); | |
754 | } | |
755 | #endif | |
756 | ||
39097daf MR |
757 | static void set_persistent_state_defaults(GAPersistentState *pstate) |
758 | { | |
759 | g_assert(pstate); | |
760 | pstate->fd_counter = QGA_PSTATE_DEFAULT_FD_COUNTER; | |
761 | } | |
762 | ||
763 | static void persistent_state_from_keyfile(GAPersistentState *pstate, | |
764 | GKeyFile *keyfile) | |
765 | { | |
766 | g_assert(pstate); | |
767 | g_assert(keyfile); | |
768 | /* if any fields are missing, either because the file was tampered with | |
769 | * by agents of chaos, or because the field wasn't present at the time the | |
770 | * file was created, the best we can ever do is start over with the default | |
771 | * values. so load them now, and ignore any errors in accessing key-value | |
772 | * pairs | |
773 | */ | |
774 | set_persistent_state_defaults(pstate); | |
775 | ||
776 | if (g_key_file_has_key(keyfile, "global", "fd_counter", NULL)) { | |
777 | pstate->fd_counter = | |
4f306496 | 778 | g_key_file_get_integer(keyfile, "global", "fd_counter", NULL); |
39097daf MR |
779 | } |
780 | } | |
781 | ||
782 | static void persistent_state_to_keyfile(const GAPersistentState *pstate, | |
783 | GKeyFile *keyfile) | |
784 | { | |
785 | g_assert(pstate); | |
786 | g_assert(keyfile); | |
787 | ||
4f306496 | 788 | g_key_file_set_integer(keyfile, "global", "fd_counter", pstate->fd_counter); |
39097daf MR |
789 | } |
790 | ||
791 | static gboolean write_persistent_state(const GAPersistentState *pstate, | |
792 | const gchar *path) | |
793 | { | |
794 | GKeyFile *keyfile = g_key_file_new(); | |
795 | GError *gerr = NULL; | |
796 | gboolean ret = true; | |
797 | gchar *data = NULL; | |
798 | gsize data_len; | |
799 | ||
800 | g_assert(pstate); | |
801 | ||
802 | persistent_state_to_keyfile(pstate, keyfile); | |
803 | data = g_key_file_to_data(keyfile, &data_len, &gerr); | |
804 | if (gerr) { | |
805 | g_critical("failed to convert persistent state to string: %s", | |
806 | gerr->message); | |
807 | ret = false; | |
808 | goto out; | |
809 | } | |
810 | ||
811 | g_file_set_contents(path, data, data_len, &gerr); | |
812 | if (gerr) { | |
813 | g_critical("failed to write persistent state to %s: %s", | |
814 | path, gerr->message); | |
815 | ret = false; | |
816 | goto out; | |
817 | } | |
818 | ||
819 | out: | |
820 | if (gerr) { | |
821 | g_error_free(gerr); | |
822 | } | |
823 | if (keyfile) { | |
824 | g_key_file_free(keyfile); | |
825 | } | |
826 | g_free(data); | |
827 | return ret; | |
828 | } | |
829 | ||
830 | static gboolean read_persistent_state(GAPersistentState *pstate, | |
831 | const gchar *path, gboolean frozen) | |
832 | { | |
833 | GKeyFile *keyfile = NULL; | |
834 | GError *gerr = NULL; | |
835 | struct stat st; | |
836 | gboolean ret = true; | |
837 | ||
838 | g_assert(pstate); | |
839 | ||
840 | if (stat(path, &st) == -1) { | |
841 | /* it's okay if state file doesn't exist, but any other error | |
842 | * indicates a permissions issue or some other misconfiguration | |
843 | * that we likely won't be able to recover from. | |
844 | */ | |
845 | if (errno != ENOENT) { | |
846 | g_critical("unable to access state file at path %s: %s", | |
847 | path, strerror(errno)); | |
848 | ret = false; | |
849 | goto out; | |
850 | } | |
851 | ||
852 | /* file doesn't exist. initialize state to default values and | |
853 | * attempt to save now. (we could wait till later when we have | |
854 | * modified state we need to commit, but if there's a problem, | |
855 | * such as a missing parent directory, we want to catch it now) | |
856 | * | |
857 | * there is a potential scenario where someone either managed to | |
858 | * update the agent from a version that didn't use a key store | |
859 | * while qemu-ga thought the filesystem was frozen, or | |
860 | * deleted the key store prior to issuing a fsfreeze, prior | |
861 | * to restarting the agent. in this case we go ahead and defer | |
862 | * initial creation till we actually have modified state to | |
863 | * write, otherwise fail to recover from freeze. | |
864 | */ | |
865 | set_persistent_state_defaults(pstate); | |
866 | if (!frozen) { | |
867 | ret = write_persistent_state(pstate, path); | |
868 | if (!ret) { | |
869 | g_critical("unable to create state file at path %s", path); | |
870 | ret = false; | |
871 | goto out; | |
872 | } | |
873 | } | |
874 | ret = true; | |
875 | goto out; | |
876 | } | |
877 | ||
878 | keyfile = g_key_file_new(); | |
879 | g_key_file_load_from_file(keyfile, path, 0, &gerr); | |
880 | if (gerr) { | |
881 | g_critical("error loading persistent state from path: %s, %s", | |
882 | path, gerr->message); | |
883 | ret = false; | |
884 | goto out; | |
885 | } | |
886 | ||
887 | persistent_state_from_keyfile(pstate, keyfile); | |
888 | ||
889 | out: | |
890 | if (keyfile) { | |
891 | g_key_file_free(keyfile); | |
892 | } | |
893 | if (gerr) { | |
894 | g_error_free(gerr); | |
895 | } | |
896 | ||
897 | return ret; | |
898 | } | |
899 | ||
900 | int64_t ga_get_fd_handle(GAState *s, Error **errp) | |
901 | { | |
902 | int64_t handle; | |
903 | ||
904 | g_assert(s->pstate_filepath); | |
905 | /* we blacklist commands and avoid operations that potentially require | |
906 | * writing to disk when we're in a frozen state. this includes opening | |
907 | * new files, so we should never get here in that situation | |
908 | */ | |
909 | g_assert(!ga_is_frozen(s)); | |
910 | ||
911 | handle = s->pstate.fd_counter++; | |
ce7f7cc2 LC |
912 | |
913 | /* This should never happen on a reasonable timeframe, as guest-file-open | |
914 | * would have to be issued 2^63 times */ | |
915 | if (s->pstate.fd_counter == INT64_MAX) { | |
916 | abort(); | |
39097daf | 917 | } |
ce7f7cc2 | 918 | |
39097daf MR |
919 | if (!write_persistent_state(&s->pstate, s->pstate_filepath)) { |
920 | error_setg(errp, "failed to commit persistent state to disk"); | |
a903f40c | 921 | return -1; |
39097daf MR |
922 | } |
923 | ||
924 | return handle; | |
925 | } | |
926 | ||
8dc4d915 MW |
927 | static void ga_print_cmd(QmpCommand *cmd, void *opaque) |
928 | { | |
929 | printf("%s\n", qmp_command_name(cmd)); | |
930 | } | |
931 | ||
4bca81ce | 932 | static GList *split_list(const gchar *str, const gchar *delim) |
23b42894 MAL |
933 | { |
934 | GList *list = NULL; | |
4bca81ce MAL |
935 | int i; |
936 | gchar **strv; | |
23b42894 | 937 | |
4bca81ce MAL |
938 | strv = g_strsplit(str, delim, -1); |
939 | for (i = 0; strv[i]; i++) { | |
940 | list = g_list_prepend(list, strv[i]); | |
23b42894 | 941 | } |
4bca81ce | 942 | g_free(strv); |
23b42894 MAL |
943 | |
944 | return list; | |
945 | } | |
946 | ||
7a406694 MAL |
947 | typedef struct GAConfig { |
948 | char *channel_path; | |
949 | char *method; | |
950 | char *log_filepath; | |
951 | char *pid_filepath; | |
ec0f694c | 952 | #ifdef CONFIG_FSFREEZE |
7a406694 | 953 | char *fsfreeze_hook; |
ec0f694c | 954 | #endif |
7a406694 | 955 | char *state_dir; |
bc62fa03 | 956 | #ifdef _WIN32 |
7a406694 | 957 | const char *service; |
bc62fa03 | 958 | #endif |
e236d060 | 959 | gchar *bliststr; /* blacklist may point to this string */ |
7a406694 MAL |
960 | GList *blacklist; |
961 | int daemonize; | |
962 | GLogLevelFlags log_level; | |
aeadcbb6 | 963 | int dumpconf; |
7a406694 MAL |
964 | } GAConfig; |
965 | ||
e236d060 MAL |
966 | static void config_load(GAConfig *config) |
967 | { | |
968 | GError *gerr = NULL; | |
969 | GKeyFile *keyfile; | |
8e34bf36 | 970 | const char *conf = g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT; |
e236d060 MAL |
971 | |
972 | /* read system config */ | |
973 | keyfile = g_key_file_new(); | |
8e34bf36 | 974 | if (!g_key_file_load_from_file(keyfile, conf, 0, &gerr)) { |
e236d060 MAL |
975 | goto end; |
976 | } | |
977 | if (g_key_file_has_key(keyfile, "general", "daemon", NULL)) { | |
978 | config->daemonize = | |
979 | g_key_file_get_boolean(keyfile, "general", "daemon", &gerr); | |
980 | } | |
981 | if (g_key_file_has_key(keyfile, "general", "method", NULL)) { | |
982 | config->method = | |
983 | g_key_file_get_string(keyfile, "general", "method", &gerr); | |
984 | } | |
985 | if (g_key_file_has_key(keyfile, "general", "path", NULL)) { | |
986 | config->channel_path = | |
987 | g_key_file_get_string(keyfile, "general", "path", &gerr); | |
988 | } | |
989 | if (g_key_file_has_key(keyfile, "general", "logfile", NULL)) { | |
990 | config->log_filepath = | |
991 | g_key_file_get_string(keyfile, "general", "logfile", &gerr); | |
992 | } | |
993 | if (g_key_file_has_key(keyfile, "general", "pidfile", NULL)) { | |
994 | config->pid_filepath = | |
995 | g_key_file_get_string(keyfile, "general", "pidfile", &gerr); | |
996 | } | |
997 | #ifdef CONFIG_FSFREEZE | |
998 | if (g_key_file_has_key(keyfile, "general", "fsfreeze-hook", NULL)) { | |
999 | config->fsfreeze_hook = | |
1000 | g_key_file_get_string(keyfile, | |
1001 | "general", "fsfreeze-hook", &gerr); | |
1002 | } | |
1003 | #endif | |
1004 | if (g_key_file_has_key(keyfile, "general", "statedir", NULL)) { | |
1005 | config->state_dir = | |
1006 | g_key_file_get_string(keyfile, "general", "statedir", &gerr); | |
1007 | } | |
1008 | if (g_key_file_has_key(keyfile, "general", "verbose", NULL) && | |
1009 | g_key_file_get_boolean(keyfile, "general", "verbose", &gerr)) { | |
1010 | /* enable all log levels */ | |
1011 | config->log_level = G_LOG_LEVEL_MASK; | |
1012 | } | |
1013 | if (g_key_file_has_key(keyfile, "general", "blacklist", NULL)) { | |
1014 | config->bliststr = | |
1015 | g_key_file_get_string(keyfile, "general", "blacklist", &gerr); | |
1016 | config->blacklist = g_list_concat(config->blacklist, | |
1017 | split_list(config->bliststr, ",")); | |
1018 | } | |
1019 | ||
1020 | end: | |
1021 | g_key_file_free(keyfile); | |
1022 | if (gerr && | |
1023 | !(gerr->domain == G_FILE_ERROR && gerr->code == G_FILE_ERROR_NOENT)) { | |
1024 | g_critical("error loading configuration from path: %s, %s", | |
1025 | QGA_CONF_DEFAULT, gerr->message); | |
1026 | exit(EXIT_FAILURE); | |
1027 | } | |
1028 | g_clear_error(&gerr); | |
1029 | } | |
1030 | ||
aeadcbb6 MAL |
1031 | static gchar *list_join(GList *list, const gchar separator) |
1032 | { | |
1033 | GString *str = g_string_new(""); | |
1034 | ||
1035 | while (list) { | |
1036 | str = g_string_append(str, (gchar *)list->data); | |
1037 | list = g_list_next(list); | |
1038 | if (list) { | |
1039 | str = g_string_append_c(str, separator); | |
1040 | } | |
1041 | } | |
1042 | ||
1043 | return g_string_free(str, FALSE); | |
1044 | } | |
1045 | ||
1046 | static void config_dump(GAConfig *config) | |
1047 | { | |
1048 | GError *error = NULL; | |
1049 | GKeyFile *keyfile; | |
1050 | gchar *tmp; | |
1051 | ||
1052 | keyfile = g_key_file_new(); | |
1053 | g_assert(keyfile); | |
1054 | ||
1055 | g_key_file_set_boolean(keyfile, "general", "daemon", config->daemonize); | |
1056 | g_key_file_set_string(keyfile, "general", "method", config->method); | |
26de2296 SH |
1057 | if (config->channel_path) { |
1058 | g_key_file_set_string(keyfile, "general", "path", config->channel_path); | |
1059 | } | |
aeadcbb6 MAL |
1060 | if (config->log_filepath) { |
1061 | g_key_file_set_string(keyfile, "general", "logfile", | |
1062 | config->log_filepath); | |
1063 | } | |
1064 | g_key_file_set_string(keyfile, "general", "pidfile", config->pid_filepath); | |
1065 | #ifdef CONFIG_FSFREEZE | |
1066 | if (config->fsfreeze_hook) { | |
1067 | g_key_file_set_string(keyfile, "general", "fsfreeze-hook", | |
1068 | config->fsfreeze_hook); | |
1069 | } | |
1070 | #endif | |
1071 | g_key_file_set_string(keyfile, "general", "statedir", config->state_dir); | |
1072 | g_key_file_set_boolean(keyfile, "general", "verbose", | |
1073 | config->log_level == G_LOG_LEVEL_MASK); | |
1074 | tmp = list_join(config->blacklist, ','); | |
1075 | g_key_file_set_string(keyfile, "general", "blacklist", tmp); | |
1076 | g_free(tmp); | |
1077 | ||
1078 | tmp = g_key_file_to_data(keyfile, NULL, &error); | |
cbcd9ba1 MAL |
1079 | if (error) { |
1080 | g_critical("Failed to dump keyfile: %s", error->message); | |
1081 | g_clear_error(&error); | |
1082 | } else { | |
1083 | printf("%s", tmp); | |
1084 | } | |
aeadcbb6 MAL |
1085 | |
1086 | g_free(tmp); | |
1087 | g_key_file_free(keyfile); | |
1088 | } | |
1089 | ||
e236d060 | 1090 | static void config_parse(GAConfig *config, int argc, char **argv) |
7a406694 | 1091 | { |
7a406694 MAL |
1092 | const char *sopt = "hVvdm:p:l:f:F::b:s:t:D"; |
1093 | int opt_ind = 0, ch; | |
48ff7a62 MR |
1094 | const struct option lopt[] = { |
1095 | { "help", 0, NULL, 'h' }, | |
1096 | { "version", 0, NULL, 'V' }, | |
aeadcbb6 | 1097 | { "dump-conf", 0, NULL, 'D' }, |
bc62fa03 MR |
1098 | { "logfile", 1, NULL, 'l' }, |
1099 | { "pidfile", 1, NULL, 'f' }, | |
ec0f694c TS |
1100 | #ifdef CONFIG_FSFREEZE |
1101 | { "fsfreeze-hook", 2, NULL, 'F' }, | |
1102 | #endif | |
48ff7a62 | 1103 | { "verbose", 0, NULL, 'v' }, |
bc62fa03 MR |
1104 | { "method", 1, NULL, 'm' }, |
1105 | { "path", 1, NULL, 'p' }, | |
48ff7a62 | 1106 | { "daemonize", 0, NULL, 'd' }, |
bc62fa03 MR |
1107 | { "blacklist", 1, NULL, 'b' }, |
1108 | #ifdef _WIN32 | |
1109 | { "service", 1, NULL, 's' }, | |
f22d85e9 | 1110 | #endif |
f789aa7b | 1111 | { "statedir", 1, NULL, 't' }, |
48ff7a62 MR |
1112 | { NULL, 0, NULL, 0 } |
1113 | }; | |
48ff7a62 MR |
1114 | |
1115 | while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) { | |
1116 | switch (ch) { | |
1117 | case 'm': | |
e236d060 | 1118 | g_free(config->method); |
7a406694 | 1119 | config->method = g_strdup(optarg); |
48ff7a62 MR |
1120 | break; |
1121 | case 'p': | |
e236d060 | 1122 | g_free(config->channel_path); |
7a406694 | 1123 | config->channel_path = g_strdup(optarg); |
48ff7a62 MR |
1124 | break; |
1125 | case 'l': | |
e236d060 | 1126 | g_free(config->log_filepath); |
7a406694 | 1127 | config->log_filepath = g_strdup(optarg); |
48ff7a62 MR |
1128 | break; |
1129 | case 'f': | |
e236d060 | 1130 | g_free(config->pid_filepath); |
7a406694 | 1131 | config->pid_filepath = g_strdup(optarg); |
48ff7a62 | 1132 | break; |
ec0f694c TS |
1133 | #ifdef CONFIG_FSFREEZE |
1134 | case 'F': | |
e236d060 | 1135 | g_free(config->fsfreeze_hook); |
7a406694 | 1136 | config->fsfreeze_hook = g_strdup(optarg ?: QGA_FSFREEZE_HOOK_DEFAULT); |
ec0f694c TS |
1137 | break; |
1138 | #endif | |
f789aa7b | 1139 | case 't': |
e236d060 | 1140 | g_free(config->state_dir); |
7a406694 | 1141 | config->state_dir = g_strdup(optarg); |
2e38d990 | 1142 | break; |
48ff7a62 MR |
1143 | case 'v': |
1144 | /* enable all log levels */ | |
7a406694 | 1145 | config->log_level = G_LOG_LEVEL_MASK; |
48ff7a62 MR |
1146 | break; |
1147 | case 'V': | |
8efacc43 | 1148 | printf("QEMU Guest Agent %s\n", QEMU_VERSION); |
c6c84523 | 1149 | exit(EXIT_SUCCESS); |
48ff7a62 | 1150 | case 'd': |
7a406694 | 1151 | config->daemonize = 1; |
48ff7a62 | 1152 | break; |
aeadcbb6 MAL |
1153 | case 'D': |
1154 | config->dumpconf = 1; | |
1155 | break; | |
abd6cf6d | 1156 | case 'b': { |
c8057f95 | 1157 | if (is_help_option(optarg)) { |
1527badb | 1158 | qmp_for_each_command(&ga_commands, ga_print_cmd, NULL); |
c6c84523 | 1159 | exit(EXIT_SUCCESS); |
abd6cf6d | 1160 | } |
7a406694 MAL |
1161 | config->blacklist = g_list_concat(config->blacklist, |
1162 | split_list(optarg, ",")); | |
abd6cf6d MR |
1163 | break; |
1164 | } | |
bc62fa03 MR |
1165 | #ifdef _WIN32 |
1166 | case 's': | |
7a406694 MAL |
1167 | config->service = optarg; |
1168 | if (strcmp(config->service, "install") == 0) { | |
f311f2c2 | 1169 | if (ga_install_vss_provider()) { |
c6c84523 | 1170 | exit(EXIT_FAILURE); |
f311f2c2 | 1171 | } |
7a406694 MAL |
1172 | if (ga_install_service(config->channel_path, |
1173 | config->log_filepath, config->state_dir)) { | |
c6c84523 | 1174 | exit(EXIT_FAILURE); |
f311f2c2 | 1175 | } |
c6c84523 | 1176 | exit(EXIT_SUCCESS); |
7a406694 | 1177 | } else if (strcmp(config->service, "uninstall") == 0) { |
f311f2c2 | 1178 | ga_uninstall_vss_provider(); |
c6c84523 | 1179 | exit(ga_uninstall_service()); |
7a406694 | 1180 | } else if (strcmp(config->service, "vss-install") == 0) { |
5e031072 | 1181 | if (ga_install_vss_provider()) { |
c6c84523 | 1182 | exit(EXIT_FAILURE); |
5e031072 | 1183 | } |
c6c84523 | 1184 | exit(EXIT_SUCCESS); |
7a406694 | 1185 | } else if (strcmp(config->service, "vss-uninstall") == 0) { |
5e031072 | 1186 | ga_uninstall_vss_provider(); |
c6c84523 | 1187 | exit(EXIT_SUCCESS); |
bc62fa03 MR |
1188 | } else { |
1189 | printf("Unknown service command.\n"); | |
c6c84523 | 1190 | exit(EXIT_FAILURE); |
bc62fa03 MR |
1191 | } |
1192 | break; | |
1193 | #endif | |
48ff7a62 MR |
1194 | case 'h': |
1195 | usage(argv[0]); | |
c6c84523 | 1196 | exit(EXIT_SUCCESS); |
48ff7a62 MR |
1197 | case '?': |
1198 | g_print("Unknown option, try '%s --help' for more information.\n", | |
1199 | argv[0]); | |
c6c84523 | 1200 | exit(EXIT_FAILURE); |
48ff7a62 MR |
1201 | } |
1202 | } | |
7a406694 MAL |
1203 | } |
1204 | ||
1205 | static void config_free(GAConfig *config) | |
1206 | { | |
1207 | g_free(config->method); | |
1208 | g_free(config->log_filepath); | |
1209 | g_free(config->pid_filepath); | |
1210 | g_free(config->state_dir); | |
1211 | g_free(config->channel_path); | |
e236d060 | 1212 | g_free(config->bliststr); |
7a406694 MAL |
1213 | #ifdef CONFIG_FSFREEZE |
1214 | g_free(config->fsfreeze_hook); | |
1215 | #endif | |
2aa67a91 | 1216 | g_list_free_full(config->blacklist, g_free); |
7a406694 MAL |
1217 | g_free(config); |
1218 | } | |
1219 | ||
e3d31039 | 1220 | static bool check_is_frozen(GAState *s) |
7a406694 | 1221 | { |
f789aa7b MR |
1222 | #ifndef _WIN32 |
1223 | /* check if a previous instance of qemu-ga exited with filesystems' state | |
1224 | * marked as frozen. this could be a stale value (a non-qemu-ga process | |
1225 | * or reboot may have since unfrozen them), but better to require an | |
1226 | * uneeded unfreeze than to risk hanging on start-up | |
1227 | */ | |
1228 | struct stat st; | |
1229 | if (stat(s->state_filepath_isfrozen, &st) == -1) { | |
1230 | /* it's okay if the file doesn't exist, but if we can't access for | |
1231 | * some other reason, such as permissions, there's a configuration | |
1232 | * that needs to be addressed. so just bail now before we get into | |
1233 | * more trouble later | |
1234 | */ | |
1235 | if (errno != ENOENT) { | |
1236 | g_critical("unable to access state file at path %s: %s", | |
1237 | s->state_filepath_isfrozen, strerror(errno)); | |
1238 | return EXIT_FAILURE; | |
1239 | } | |
1240 | } else { | |
1241 | g_warning("previous instance appears to have exited with frozen" | |
1242 | " filesystems. deferring logging/pidfile creation and" | |
1243 | " disabling non-fsfreeze-safe commands until" | |
1244 | " guest-fsfreeze-thaw is issued, or filesystems are" | |
1245 | " manually unfrozen and the file %s is removed", | |
1246 | s->state_filepath_isfrozen); | |
e3d31039 MAL |
1247 | return true; |
1248 | } | |
1249 | #endif | |
1250 | return false; | |
1251 | } | |
1252 | ||
53fabd4b | 1253 | static int run_agent(GAState *s, GAConfig *config, int socket_activation) |
e3d31039 MAL |
1254 | { |
1255 | ga_state = s; | |
1256 | ||
1257 | g_log_set_default_handler(ga_log, s); | |
1258 | g_log_set_fatal_mask(NULL, G_LOG_LEVEL_ERROR); | |
1259 | ga_enable_logging(s); | |
1260 | ||
1261 | #ifdef _WIN32 | |
1262 | /* On win32 the state directory is application specific (be it the default | |
1263 | * or a user override). We got past the command line parsing; let's create | |
1264 | * the directory (with any intermediate directories). If we run into an | |
1265 | * error later on, we won't try to clean up the directory, it is considered | |
1266 | * persistent. | |
1267 | */ | |
1268 | if (g_mkdir_with_parents(config->state_dir, S_IRWXU) == -1) { | |
1269 | g_critical("unable to create (an ancestor of) the state directory" | |
1270 | " '%s': %s", config->state_dir, strerror(errno)); | |
1271 | return EXIT_FAILURE; | |
f789aa7b MR |
1272 | } |
1273 | #endif | |
1274 | ||
1275 | if (ga_is_frozen(s)) { | |
7a406694 | 1276 | if (config->daemonize) { |
8e8be266 | 1277 | /* delay opening/locking of pidfile till filesystems are unfrozen */ |
7a406694 | 1278 | s->deferred_options.pid_filepath = config->pid_filepath; |
f789aa7b MR |
1279 | become_daemon(NULL); |
1280 | } | |
7a406694 | 1281 | if (config->log_filepath) { |
f789aa7b | 1282 | /* delay opening the log file till filesystems are unfrozen */ |
7a406694 | 1283 | s->deferred_options.log_filepath = config->log_filepath; |
f789aa7b MR |
1284 | } |
1285 | ga_disable_logging(s); | |
1527badb | 1286 | qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL); |
f789aa7b | 1287 | } else { |
7a406694 MAL |
1288 | if (config->daemonize) { |
1289 | become_daemon(config->pid_filepath); | |
f789aa7b | 1290 | } |
7a406694 MAL |
1291 | if (config->log_filepath) { |
1292 | FILE *log_file = ga_open_logfile(config->log_filepath); | |
6c615ec5 | 1293 | if (!log_file) { |
f789aa7b MR |
1294 | g_critical("unable to open specified log file: %s", |
1295 | strerror(errno)); | |
e3d31039 | 1296 | return EXIT_FAILURE; |
f789aa7b | 1297 | } |
6c615ec5 | 1298 | s->log_file = log_file; |
f789aa7b MR |
1299 | } |
1300 | } | |
1301 | ||
39097daf MR |
1302 | /* load persistent state from disk */ |
1303 | if (!read_persistent_state(&s->pstate, | |
1304 | s->pstate_filepath, | |
1305 | ga_is_frozen(s))) { | |
1306 | g_critical("failed to load persistent state"); | |
e3d31039 | 1307 | return EXIT_FAILURE; |
39097daf MR |
1308 | } |
1309 | ||
7a406694 MAL |
1310 | config->blacklist = ga_command_blacklist_init(config->blacklist); |
1311 | if (config->blacklist) { | |
1312 | GList *l = config->blacklist; | |
1313 | s->blacklist = config->blacklist; | |
f22d85e9 | 1314 | do { |
7a406694 | 1315 | g_debug("disabling command: %s", (char *)l->data); |
1527badb | 1316 | qmp_disable_command(&ga_commands, l->data); |
7a406694 MAL |
1317 | l = g_list_next(l); |
1318 | } while (l); | |
f22d85e9 | 1319 | } |
e3d4d252 MR |
1320 | s->command_state = ga_command_state_new(); |
1321 | ga_command_state_init(s, s->command_state); | |
1322 | ga_command_state_init_all(s->command_state); | |
125b310e | 1323 | json_message_parser_init(&s->parser, process_event); |
f8837b37 | 1324 | |
d8ca685a | 1325 | #ifndef _WIN32 |
125b310e MR |
1326 | if (!register_signal_handlers()) { |
1327 | g_critical("failed to register signal handlers"); | |
e3d31039 | 1328 | return EXIT_FAILURE; |
125b310e | 1329 | } |
d8ca685a | 1330 | #endif |
48ff7a62 | 1331 | |
125b310e | 1332 | s->main_loop = g_main_loop_new(NULL, false); |
26de2296 SH |
1333 | |
1334 | if (!channel_init(ga_state, config->method, config->channel_path, | |
53fabd4b | 1335 | socket_activation ? FIRST_SOCKET_ACTIVATION_FD : -1)) { |
125b310e | 1336 | g_critical("failed to initialize guest agent channel"); |
e3d31039 | 1337 | return EXIT_FAILURE; |
125b310e | 1338 | } |
bc62fa03 | 1339 | #ifndef _WIN32 |
48ff7a62 | 1340 | g_main_loop_run(ga_state->main_loop); |
bc62fa03 | 1341 | #else |
7a406694 | 1342 | if (config->daemonize) { |
bc62fa03 MR |
1343 | SERVICE_TABLE_ENTRY service_table[] = { |
1344 | { (char *)QGA_SERVICE_NAME, service_main }, { NULL, NULL } }; | |
1345 | StartServiceCtrlDispatcher(service_table); | |
1346 | } else { | |
1347 | g_main_loop_run(ga_state->main_loop); | |
1348 | } | |
1349 | #endif | |
48ff7a62 | 1350 | |
e3d31039 MAL |
1351 | return EXIT_SUCCESS; |
1352 | } | |
48ff7a62 | 1353 | |
e3d31039 MAL |
1354 | int main(int argc, char **argv) |
1355 | { | |
1356 | int ret = EXIT_SUCCESS; | |
1357 | GAState *s = g_new0(GAState, 1); | |
e236d060 | 1358 | GAConfig *config = g_new0(GAConfig, 1); |
53fabd4b | 1359 | int socket_activation; |
e3d31039 | 1360 | |
6eaeae37 MAL |
1361 | config->log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL; |
1362 | ||
1527badb | 1363 | qga_qmp_init_marshal(&ga_commands); |
e3d31039 MAL |
1364 | |
1365 | init_dfl_pathnames(); | |
e236d060 MAL |
1366 | config_load(config); |
1367 | config_parse(config, argc, argv); | |
e3d31039 MAL |
1368 | |
1369 | if (config->pid_filepath == NULL) { | |
1370 | config->pid_filepath = g_strdup(dfl_pathnames.pidfile); | |
1371 | } | |
1372 | ||
1373 | if (config->state_dir == NULL) { | |
1374 | config->state_dir = g_strdup(dfl_pathnames.state_dir); | |
1375 | } | |
1376 | ||
1377 | if (config->method == NULL) { | |
1378 | config->method = g_strdup("virtio-serial"); | |
125b310e | 1379 | } |
125b310e | 1380 | |
53fabd4b PB |
1381 | socket_activation = check_socket_activation(); |
1382 | if (socket_activation > 1) { | |
1383 | g_critical("qemu-ga only supports listening on one socket"); | |
1384 | ret = EXIT_FAILURE; | |
1385 | goto end; | |
1386 | } | |
1387 | if (socket_activation) { | |
bd269ebc | 1388 | SocketAddress *addr; |
26de2296 SH |
1389 | |
1390 | g_free(config->method); | |
1391 | g_free(config->channel_path); | |
1392 | config->method = NULL; | |
1393 | config->channel_path = NULL; | |
1394 | ||
53fabd4b | 1395 | addr = socket_local_address(FIRST_SOCKET_ACTIVATION_FD, NULL); |
26de2296 | 1396 | if (addr) { |
bd269ebc | 1397 | if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) { |
26de2296 | 1398 | config->method = g_strdup("unix-listen"); |
bd269ebc | 1399 | } else if (addr->type == SOCKET_ADDRESS_TYPE_VSOCK) { |
26de2296 SH |
1400 | config->method = g_strdup("vsock-listen"); |
1401 | } | |
1402 | ||
bd269ebc | 1403 | qapi_free_SocketAddress(addr); |
26de2296 SH |
1404 | } |
1405 | ||
1406 | if (!config->method) { | |
1407 | g_critical("unsupported listen fd type"); | |
1408 | ret = EXIT_FAILURE; | |
1409 | goto end; | |
1410 | } | |
1411 | } else if (config->channel_path == NULL) { | |
e3d31039 MAL |
1412 | if (strcmp(config->method, "virtio-serial") == 0) { |
1413 | /* try the default path for the virtio-serial port */ | |
1414 | config->channel_path = g_strdup(QGA_VIRTIO_PATH_DEFAULT); | |
1415 | } else if (strcmp(config->method, "isa-serial") == 0) { | |
1416 | /* try the default path for the serial port - COM1 */ | |
1417 | config->channel_path = g_strdup(QGA_SERIAL_PATH_DEFAULT); | |
1418 | } else { | |
1419 | g_critical("must specify a path for this channel"); | |
1420 | ret = EXIT_FAILURE; | |
1421 | goto end; | |
1422 | } | |
1423 | } | |
1424 | ||
1425 | s->log_level = config->log_level; | |
1426 | s->log_file = stderr; | |
1427 | #ifdef CONFIG_FSFREEZE | |
1428 | s->fsfreeze_hook = config->fsfreeze_hook; | |
1429 | #endif | |
1430 | s->pstate_filepath = g_strdup_printf("%s/qga.state", config->state_dir); | |
1431 | s->state_filepath_isfrozen = g_strdup_printf("%s/qga.state.isfrozen", | |
1432 | config->state_dir); | |
1433 | s->frozen = check_is_frozen(s); | |
1434 | ||
aeadcbb6 MAL |
1435 | if (config->dumpconf) { |
1436 | config_dump(config); | |
1437 | goto end; | |
1438 | } | |
1439 | ||
53fabd4b | 1440 | ret = run_agent(s, config, socket_activation); |
e3d31039 MAL |
1441 | |
1442 | end: | |
1443 | if (s->command_state) { | |
1444 | ga_command_state_cleanup_all(s->command_state); | |
3e3e302f MAL |
1445 | ga_command_state_free(s->command_state); |
1446 | json_message_parser_destroy(&s->parser); | |
e3d31039 MAL |
1447 | } |
1448 | if (s->channel) { | |
1449 | ga_channel_free(s->channel); | |
1450 | } | |
d4c8a5d4 MAL |
1451 | g_free(s->pstate_filepath); |
1452 | g_free(s->state_filepath_isfrozen); | |
e3d31039 | 1453 | |
7a406694 MAL |
1454 | if (config->daemonize) { |
1455 | unlink(config->pid_filepath); | |
125b310e | 1456 | } |
2e38d990 | 1457 | |
7a406694 | 1458 | config_free(config); |
3e3e302f MAL |
1459 | if (s->main_loop) { |
1460 | g_main_loop_unref(s->main_loop); | |
1461 | } | |
1462 | g_free(s); | |
2e38d990 | 1463 | |
e3d31039 | 1464 | return ret; |
48ff7a62 | 1465 | } |