4 * Copyright IBM Corp. 2011
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.
18 #include <glib/gstdio.h>
24 #include "qapi/qmp/json-streamer.h"
25 #include "qapi/qmp/json-parser.h"
26 #include "qapi/qmp/qint.h"
27 #include "qapi/qmp/qjson.h"
28 #include "qga/guest-agent-core.h"
29 #include "qemu/module.h"
31 #include "qapi/qmp/qerror.h"
32 #include "qapi/qmp/dispatch.h"
33 #include "qga/channel.h"
34 #include "qemu/bswap.h"
36 #include "qga/service-win32.h"
37 #include "qga/vss-win32.h"
42 #define CONFIG_FSFREEZE
47 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
48 #define QGA_STATE_RELATIVE_DIR "run"
49 #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0"
51 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
52 #define QGA_STATE_RELATIVE_DIR "qemu-ga"
53 #define QGA_SERIAL_PATH_DEFAULT "COM1"
55 #ifdef CONFIG_FSFREEZE
56 #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook"
58 #define QGA_SENTINEL_BYTE 0xFF
59 #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf"
62 const char *state_dir;
66 typedef struct GAPersistentState {
67 #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000
72 JSONMessageParser parser;
75 bool virtio; /* fastpath to check for virtio to deal with poll() quirks */
76 GACommandState *command_state;
77 GLogLevelFlags log_level;
83 bool delimit_response;
86 char *state_filepath_isfrozen;
88 const char *log_filepath;
89 const char *pid_filepath;
91 #ifdef CONFIG_FSFREEZE
92 const char *fsfreeze_hook;
94 gchar *pstate_filepath;
95 GAPersistentState pstate;
98 struct GAState *ga_state;
100 /* commands that are safe to issue while filesystems are frozen */
101 static const char *ga_freeze_whitelist[] = {
105 "guest-sync-delimited",
106 "guest-fsfreeze-status",
107 "guest-fsfreeze-thaw",
112 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
114 VOID WINAPI service_main(DWORD argc, TCHAR *argv[]);
118 init_dfl_pathnames(void)
120 g_assert(dfl_pathnames.state_dir == NULL);
121 g_assert(dfl_pathnames.pidfile == NULL);
122 dfl_pathnames.state_dir = qemu_get_local_state_pathname(
123 QGA_STATE_RELATIVE_DIR);
124 dfl_pathnames.pidfile = qemu_get_local_state_pathname(
125 QGA_STATE_RELATIVE_DIR G_DIR_SEPARATOR_S "qemu-ga.pid");
128 static void quit_handler(int sig)
130 /* if we're frozen, don't exit unless we're absolutely forced to,
131 * because it's basically impossible for graceful exit to complete
132 * unless all log/pid files are on unfreezable filesystems. there's
133 * also a very likely chance killing the agent before unfreezing
134 * the filesystems is a mistake (or will be viewed as one later).
136 if (ga_is_frozen(ga_state)) {
139 g_debug("received signal num %d, quitting", sig);
141 if (g_main_loop_is_running(ga_state->main_loop)) {
142 g_main_loop_quit(ga_state->main_loop);
147 static gboolean register_signal_handlers(void)
149 struct sigaction sigact;
152 memset(&sigact, 0, sizeof(struct sigaction));
153 sigact.sa_handler = quit_handler;
155 ret = sigaction(SIGINT, &sigact, NULL);
157 g_error("error configuring signal handler: %s", strerror(errno));
159 ret = sigaction(SIGTERM, &sigact, NULL);
161 g_error("error configuring signal handler: %s", strerror(errno));
167 /* TODO: use this in place of all post-fork() fclose(std*) callers */
168 void reopen_fd_to_null(int fd)
172 nullfd = open("/dev/null", O_RDWR);
185 static void usage(const char *cmd)
188 "Usage: %s [-m <method> -p <path>] [<options>]\n"
189 "QEMU Guest Agent %s\n"
191 " -m, --method transport method: one of unix-listen, virtio-serial, or\n"
192 " isa-serial (virtio-serial is the default)\n"
193 " -p, --path device/socket path (the default for virtio-serial is:\n"
195 " the default for isa-serial is:\n"
197 " -l, --logfile set logfile path, logs to stderr by default\n"
198 " -f, --pidfile specify pidfile (default is %s)\n"
199 #ifdef CONFIG_FSFREEZE
200 " -F, --fsfreeze-hook\n"
201 " enable fsfreeze hook. Accepts an optional argument that\n"
202 " specifies script to run on freeze/thaw. Script will be\n"
203 " called with 'freeze'/'thaw' arguments accordingly.\n"
205 " If using -F with an argument, do not follow -F with a\n"
207 " (for example: -F/var/run/fsfreezehook.sh)\n"
209 " -t, --statedir specify dir to store state information (absolute paths\n"
210 " only, default is %s)\n"
211 " -v, --verbose log extra debugging information\n"
212 " -V, --version print version information and exit\n"
213 " -d, --daemonize become a daemon\n"
215 " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n"
217 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
218 " to list available RPCs)\n"
219 " -D, --dump-conf dump a qemu-ga config file based on current config\n"
220 " options / command-line parameters to stdout\n"
221 " -h, --help display this help and exit\n"
224 , cmd, QEMU_VERSION, QGA_VIRTIO_PATH_DEFAULT, QGA_SERIAL_PATH_DEFAULT,
225 dfl_pathnames.pidfile,
226 #ifdef CONFIG_FSFREEZE
227 QGA_FSFREEZE_HOOK_DEFAULT,
229 dfl_pathnames.state_dir);
232 static const char *ga_log_level_str(GLogLevelFlags level)
234 switch (level & G_LOG_LEVEL_MASK) {
235 case G_LOG_LEVEL_ERROR:
237 case G_LOG_LEVEL_CRITICAL:
239 case G_LOG_LEVEL_WARNING:
241 case G_LOG_LEVEL_MESSAGE:
243 case G_LOG_LEVEL_INFO:
245 case G_LOG_LEVEL_DEBUG:
252 bool ga_logging_enabled(GAState *s)
254 return s->logging_enabled;
257 void ga_disable_logging(GAState *s)
259 s->logging_enabled = false;
262 void ga_enable_logging(GAState *s)
264 s->logging_enabled = true;
267 static void ga_log(const gchar *domain, GLogLevelFlags level,
268 const gchar *msg, gpointer opaque)
272 const char *level_str = ga_log_level_str(level);
274 if (!ga_logging_enabled(s)) {
278 level &= G_LOG_LEVEL_MASK;
280 if (g_strcmp0(domain, "syslog") == 0) {
281 syslog(LOG_INFO, "%s: %s", level_str, msg);
282 } else if (level & s->log_level) {
284 if (level & s->log_level) {
286 g_get_current_time(&time);
288 "%lu.%lu: %s: %s\n", time.tv_sec, time.tv_usec, level_str, msg);
293 void ga_set_response_delimited(GAState *s)
295 s->delimit_response = true;
298 static FILE *ga_open_logfile(const char *logfile)
302 f = fopen(logfile, "a");
307 qemu_set_cloexec(fileno(f));
312 static bool ga_open_pidfile(const char *pidfile)
317 pidfd = qemu_open(pidfile, O_CREAT|O_WRONLY, S_IRUSR|S_IWUSR);
318 if (pidfd == -1 || lockf(pidfd, F_TLOCK, 0)) {
319 g_critical("Cannot lock pid file, %s", strerror(errno));
326 if (ftruncate(pidfd, 0)) {
327 g_critical("Failed to truncate pid file");
330 snprintf(pidstr, sizeof(pidstr), "%d\n", getpid());
331 if (write(pidfd, pidstr, strlen(pidstr)) != strlen(pidstr)) {
332 g_critical("Failed to write pid file");
336 /* keep pidfile open & locked forever */
345 static bool ga_open_pidfile(const char *pidfile)
351 static gint ga_strcmp(gconstpointer str1, gconstpointer str2)
353 return strcmp(str1, str2);
356 /* disable commands that aren't safe for fsfreeze */
357 static void ga_disable_non_whitelisted(QmpCommand *cmd, void *opaque)
359 bool whitelisted = false;
361 const char *name = qmp_command_name(cmd);
363 while (ga_freeze_whitelist[i] != NULL) {
364 if (strcmp(name, ga_freeze_whitelist[i]) == 0) {
370 g_debug("disabling command: %s", name);
371 qmp_disable_command(name);
375 /* [re-]enable all commands, except those explicitly blacklisted by user */
376 static void ga_enable_non_blacklisted(QmpCommand *cmd, void *opaque)
378 GList *blacklist = opaque;
379 const char *name = qmp_command_name(cmd);
381 if (g_list_find_custom(blacklist, name, ga_strcmp) == NULL &&
382 !qmp_command_is_enabled(cmd)) {
383 g_debug("enabling command: %s", name);
384 qmp_enable_command(name);
388 static bool ga_create_file(const char *path)
390 int fd = open(path, O_CREAT | O_WRONLY, S_IWUSR | S_IRUSR);
392 g_warning("unable to open/create file %s: %s", path, strerror(errno));
399 static bool ga_delete_file(const char *path)
401 int ret = unlink(path);
403 g_warning("unable to delete file: %s: %s", path, strerror(errno));
410 bool ga_is_frozen(GAState *s)
415 void ga_set_frozen(GAState *s)
417 if (ga_is_frozen(s)) {
420 /* disable all non-whitelisted (for frozen state) commands */
421 qmp_for_each_command(ga_disable_non_whitelisted, NULL);
422 g_warning("disabling logging due to filesystem freeze");
423 ga_disable_logging(s);
425 if (!ga_create_file(s->state_filepath_isfrozen)) {
426 g_warning("unable to create %s, fsfreeze may not function properly",
427 s->state_filepath_isfrozen);
431 void ga_unset_frozen(GAState *s)
433 if (!ga_is_frozen(s)) {
437 /* if we delayed creation/opening of pid/log files due to being
438 * in a frozen state at start up, do it now
440 if (s->deferred_options.log_filepath) {
441 s->log_file = ga_open_logfile(s->deferred_options.log_filepath);
443 s->log_file = stderr;
445 s->deferred_options.log_filepath = NULL;
447 ga_enable_logging(s);
448 g_warning("logging re-enabled due to filesystem unfreeze");
449 if (s->deferred_options.pid_filepath) {
450 if (!ga_open_pidfile(s->deferred_options.pid_filepath)) {
451 g_warning("failed to create/open pid file");
453 s->deferred_options.pid_filepath = NULL;
456 /* enable all disabled, non-blacklisted commands */
457 qmp_for_each_command(ga_enable_non_blacklisted, s->blacklist);
459 if (!ga_delete_file(s->state_filepath_isfrozen)) {
460 g_warning("unable to delete %s, fsfreeze may not function properly",
461 s->state_filepath_isfrozen);
465 #ifdef CONFIG_FSFREEZE
466 const char *ga_fsfreeze_hook(GAState *s)
468 return s->fsfreeze_hook;
472 static void become_daemon(const char *pidfile)
486 if (!ga_open_pidfile(pidfile)) {
487 g_critical("failed to create pidfile");
492 umask(S_IRWXG | S_IRWXO);
497 if ((chdir("/")) < 0) {
501 reopen_fd_to_null(STDIN_FILENO);
502 reopen_fd_to_null(STDOUT_FILENO);
503 reopen_fd_to_null(STDERR_FILENO);
510 g_critical("failed to daemonize");
515 static int send_response(GAState *s, QObject *payload)
518 QString *payload_qstr, *response_qstr;
521 g_assert(payload && s->channel);
523 payload_qstr = qobject_to_json(payload);
528 if (s->delimit_response) {
529 s->delimit_response = false;
530 response_qstr = qstring_new();
531 qstring_append_chr(response_qstr, QGA_SENTINEL_BYTE);
532 qstring_append(response_qstr, qstring_get_str(payload_qstr));
533 QDECREF(payload_qstr);
535 response_qstr = payload_qstr;
538 qstring_append_chr(response_qstr, '\n');
539 buf = qstring_get_str(response_qstr);
540 status = ga_channel_write_all(s->channel, buf, strlen(buf));
541 QDECREF(response_qstr);
542 if (status != G_IO_STATUS_NORMAL) {
549 static void process_command(GAState *s, QDict *req)
555 g_debug("processing command");
556 rsp = qmp_dispatch(QOBJECT(req));
558 ret = send_response(s, rsp);
560 g_warning("error sending response: %s", strerror(ret));
566 /* handle requests/control events coming in over the channel */
567 static void process_event(JSONMessageParser *parser, QList *tokens)
569 GAState *s = container_of(parser, GAState, parser);
575 g_assert(s && parser);
577 g_debug("process_event: called");
578 obj = json_parser_parse_err(tokens, NULL, &err);
579 if (err || !obj || qobject_type(obj) != QTYPE_QDICT) {
583 g_warning("failed to parse event: unknown error");
584 error_setg(&err, QERR_JSON_PARSING);
586 g_warning("failed to parse event: %s", error_get_pretty(err));
588 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
591 qdict = qobject_to_qdict(obj);
596 /* handle host->guest commands */
597 if (qdict_haskey(qdict, "execute")) {
598 process_command(s, qdict);
600 if (!qdict_haskey(qdict, "error")) {
603 g_warning("unrecognized payload format");
604 error_setg(&err, QERR_UNSUPPORTED);
605 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
608 ret = send_response(s, QOBJECT(qdict));
610 g_warning("error sending error response: %s", strerror(-ret));
617 /* false return signals GAChannel to close the current client connection */
618 static gboolean channel_event_cb(GIOCondition condition, gpointer data)
621 gchar buf[QGA_READ_COUNT_DEFAULT+1];
624 GIOStatus status = ga_channel_read(s->channel, buf, QGA_READ_COUNT_DEFAULT, &count);
626 g_warning("error reading channel: %s", err->message);
631 case G_IO_STATUS_ERROR:
632 g_warning("error reading channel");
634 case G_IO_STATUS_NORMAL:
636 g_debug("read data, count: %d, data: %s", (int)count, buf);
637 json_message_parser_feed(&s->parser, (char *)buf, (int)count);
639 case G_IO_STATUS_EOF:
640 g_debug("received EOF");
645 case G_IO_STATUS_AGAIN:
646 /* virtio causes us to spin here when no process is attached to
647 * host-side chardev. sleep a bit to mitigate this
654 g_warning("unknown channel read status, closing");
660 static gboolean channel_init(GAState *s, const gchar *method, const gchar *path)
662 GAChannelMethod channel_method;
664 if (strcmp(method, "virtio-serial") == 0) {
665 s->virtio = true; /* virtio requires special handling in some cases */
666 channel_method = GA_CHANNEL_VIRTIO_SERIAL;
667 } else if (strcmp(method, "isa-serial") == 0) {
668 channel_method = GA_CHANNEL_ISA_SERIAL;
669 } else if (strcmp(method, "unix-listen") == 0) {
670 channel_method = GA_CHANNEL_UNIX_LISTEN;
672 g_critical("unsupported channel method/type: %s", method);
676 s->channel = ga_channel_new(channel_method, path, channel_event_cb, s);
678 g_critical("failed to create guest agent channel");
686 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
689 DWORD ret = NO_ERROR;
690 GAService *service = &ga_state->service;
694 case SERVICE_CONTROL_STOP:
695 case SERVICE_CONTROL_SHUTDOWN:
696 quit_handler(SIGTERM);
697 service->status.dwCurrentState = SERVICE_STOP_PENDING;
698 SetServiceStatus(service->status_handle, &service->status);
702 ret = ERROR_CALL_NOT_IMPLEMENTED;
707 VOID WINAPI service_main(DWORD argc, TCHAR *argv[])
709 GAService *service = &ga_state->service;
711 service->status_handle = RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME,
712 service_ctrl_handler, NULL);
714 if (service->status_handle == 0) {
715 g_critical("Failed to register extended requests function!\n");
719 service->status.dwServiceType = SERVICE_WIN32;
720 service->status.dwCurrentState = SERVICE_RUNNING;
721 service->status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN;
722 service->status.dwWin32ExitCode = NO_ERROR;
723 service->status.dwServiceSpecificExitCode = NO_ERROR;
724 service->status.dwCheckPoint = 0;
725 service->status.dwWaitHint = 0;
726 SetServiceStatus(service->status_handle, &service->status);
728 g_main_loop_run(ga_state->main_loop);
730 service->status.dwCurrentState = SERVICE_STOPPED;
731 SetServiceStatus(service->status_handle, &service->status);
735 static void set_persistent_state_defaults(GAPersistentState *pstate)
738 pstate->fd_counter = QGA_PSTATE_DEFAULT_FD_COUNTER;
741 static void persistent_state_from_keyfile(GAPersistentState *pstate,
746 /* if any fields are missing, either because the file was tampered with
747 * by agents of chaos, or because the field wasn't present at the time the
748 * file was created, the best we can ever do is start over with the default
749 * values. so load them now, and ignore any errors in accessing key-value
752 set_persistent_state_defaults(pstate);
754 if (g_key_file_has_key(keyfile, "global", "fd_counter", NULL)) {
756 g_key_file_get_integer(keyfile, "global", "fd_counter", NULL);
760 static void persistent_state_to_keyfile(const GAPersistentState *pstate,
766 g_key_file_set_integer(keyfile, "global", "fd_counter", pstate->fd_counter);
769 static gboolean write_persistent_state(const GAPersistentState *pstate,
772 GKeyFile *keyfile = g_key_file_new();
780 persistent_state_to_keyfile(pstate, keyfile);
781 data = g_key_file_to_data(keyfile, &data_len, &gerr);
783 g_critical("failed to convert persistent state to string: %s",
789 g_file_set_contents(path, data, data_len, &gerr);
791 g_critical("failed to write persistent state to %s: %s",
792 path, gerr->message);
802 g_key_file_free(keyfile);
808 static gboolean read_persistent_state(GAPersistentState *pstate,
809 const gchar *path, gboolean frozen)
811 GKeyFile *keyfile = NULL;
818 if (stat(path, &st) == -1) {
819 /* it's okay if state file doesn't exist, but any other error
820 * indicates a permissions issue or some other misconfiguration
821 * that we likely won't be able to recover from.
823 if (errno != ENOENT) {
824 g_critical("unable to access state file at path %s: %s",
825 path, strerror(errno));
830 /* file doesn't exist. initialize state to default values and
831 * attempt to save now. (we could wait till later when we have
832 * modified state we need to commit, but if there's a problem,
833 * such as a missing parent directory, we want to catch it now)
835 * there is a potential scenario where someone either managed to
836 * update the agent from a version that didn't use a key store
837 * while qemu-ga thought the filesystem was frozen, or
838 * deleted the key store prior to issuing a fsfreeze, prior
839 * to restarting the agent. in this case we go ahead and defer
840 * initial creation till we actually have modified state to
841 * write, otherwise fail to recover from freeze.
843 set_persistent_state_defaults(pstate);
845 ret = write_persistent_state(pstate, path);
847 g_critical("unable to create state file at path %s", path);
856 keyfile = g_key_file_new();
857 g_key_file_load_from_file(keyfile, path, 0, &gerr);
859 g_critical("error loading persistent state from path: %s, %s",
860 path, gerr->message);
865 persistent_state_from_keyfile(pstate, keyfile);
869 g_key_file_free(keyfile);
878 int64_t ga_get_fd_handle(GAState *s, Error **errp)
882 g_assert(s->pstate_filepath);
883 /* we blacklist commands and avoid operations that potentially require
884 * writing to disk when we're in a frozen state. this includes opening
885 * new files, so we should never get here in that situation
887 g_assert(!ga_is_frozen(s));
889 handle = s->pstate.fd_counter++;
891 /* This should never happen on a reasonable timeframe, as guest-file-open
892 * would have to be issued 2^63 times */
893 if (s->pstate.fd_counter == INT64_MAX) {
897 if (!write_persistent_state(&s->pstate, s->pstate_filepath)) {
898 error_setg(errp, "failed to commit persistent state to disk");
905 static void ga_print_cmd(QmpCommand *cmd, void *opaque)
907 printf("%s\n", qmp_command_name(cmd));
910 static GList *split_list(const gchar *str, const gchar *delim)
916 strv = g_strsplit(str, delim, -1);
917 for (i = 0; strv[i]; i++) {
918 list = g_list_prepend(list, strv[i]);
925 typedef struct GAConfig {
930 #ifdef CONFIG_FSFREEZE
937 gchar *bliststr; /* blacklist may point to this string */
940 GLogLevelFlags log_level;
944 static void config_load(GAConfig *config)
948 const char *conf = g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT;
950 /* read system config */
951 keyfile = g_key_file_new();
952 if (!g_key_file_load_from_file(keyfile, conf, 0, &gerr)) {
955 if (g_key_file_has_key(keyfile, "general", "daemon", NULL)) {
957 g_key_file_get_boolean(keyfile, "general", "daemon", &gerr);
959 if (g_key_file_has_key(keyfile, "general", "method", NULL)) {
961 g_key_file_get_string(keyfile, "general", "method", &gerr);
963 if (g_key_file_has_key(keyfile, "general", "path", NULL)) {
964 config->channel_path =
965 g_key_file_get_string(keyfile, "general", "path", &gerr);
967 if (g_key_file_has_key(keyfile, "general", "logfile", NULL)) {
968 config->log_filepath =
969 g_key_file_get_string(keyfile, "general", "logfile", &gerr);
971 if (g_key_file_has_key(keyfile, "general", "pidfile", NULL)) {
972 config->pid_filepath =
973 g_key_file_get_string(keyfile, "general", "pidfile", &gerr);
975 #ifdef CONFIG_FSFREEZE
976 if (g_key_file_has_key(keyfile, "general", "fsfreeze-hook", NULL)) {
977 config->fsfreeze_hook =
978 g_key_file_get_string(keyfile,
979 "general", "fsfreeze-hook", &gerr);
982 if (g_key_file_has_key(keyfile, "general", "statedir", NULL)) {
984 g_key_file_get_string(keyfile, "general", "statedir", &gerr);
986 if (g_key_file_has_key(keyfile, "general", "verbose", NULL) &&
987 g_key_file_get_boolean(keyfile, "general", "verbose", &gerr)) {
988 /* enable all log levels */
989 config->log_level = G_LOG_LEVEL_MASK;
991 if (g_key_file_has_key(keyfile, "general", "blacklist", NULL)) {
993 g_key_file_get_string(keyfile, "general", "blacklist", &gerr);
994 config->blacklist = g_list_concat(config->blacklist,
995 split_list(config->bliststr, ","));
999 g_key_file_free(keyfile);
1001 !(gerr->domain == G_FILE_ERROR && gerr->code == G_FILE_ERROR_NOENT)) {
1002 g_critical("error loading configuration from path: %s, %s",
1003 QGA_CONF_DEFAULT, gerr->message);
1006 g_clear_error(&gerr);
1009 static gchar *list_join(GList *list, const gchar separator)
1011 GString *str = g_string_new("");
1014 str = g_string_append(str, (gchar *)list->data);
1015 list = g_list_next(list);
1017 str = g_string_append_c(str, separator);
1021 return g_string_free(str, FALSE);
1024 static void config_dump(GAConfig *config)
1026 GError *error = NULL;
1030 keyfile = g_key_file_new();
1033 g_key_file_set_boolean(keyfile, "general", "daemon", config->daemonize);
1034 g_key_file_set_string(keyfile, "general", "method", config->method);
1035 g_key_file_set_string(keyfile, "general", "path", config->channel_path);
1036 if (config->log_filepath) {
1037 g_key_file_set_string(keyfile, "general", "logfile",
1038 config->log_filepath);
1040 g_key_file_set_string(keyfile, "general", "pidfile", config->pid_filepath);
1041 #ifdef CONFIG_FSFREEZE
1042 if (config->fsfreeze_hook) {
1043 g_key_file_set_string(keyfile, "general", "fsfreeze-hook",
1044 config->fsfreeze_hook);
1047 g_key_file_set_string(keyfile, "general", "statedir", config->state_dir);
1048 g_key_file_set_boolean(keyfile, "general", "verbose",
1049 config->log_level == G_LOG_LEVEL_MASK);
1050 tmp = list_join(config->blacklist, ',');
1051 g_key_file_set_string(keyfile, "general", "blacklist", tmp);
1054 tmp = g_key_file_to_data(keyfile, NULL, &error);
1058 g_key_file_free(keyfile);
1061 static void config_parse(GAConfig *config, int argc, char **argv)
1063 const char *sopt = "hVvdm:p:l:f:F::b:s:t:D";
1064 int opt_ind = 0, ch;
1065 const struct option lopt[] = {
1066 { "help", 0, NULL, 'h' },
1067 { "version", 0, NULL, 'V' },
1068 { "dump-conf", 0, NULL, 'D' },
1069 { "logfile", 1, NULL, 'l' },
1070 { "pidfile", 1, NULL, 'f' },
1071 #ifdef CONFIG_FSFREEZE
1072 { "fsfreeze-hook", 2, NULL, 'F' },
1074 { "verbose", 0, NULL, 'v' },
1075 { "method", 1, NULL, 'm' },
1076 { "path", 1, NULL, 'p' },
1077 { "daemonize", 0, NULL, 'd' },
1078 { "blacklist", 1, NULL, 'b' },
1080 { "service", 1, NULL, 's' },
1082 { "statedir", 1, NULL, 't' },
1083 { NULL, 0, NULL, 0 }
1086 config->log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL;
1088 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
1091 g_free(config->method);
1092 config->method = g_strdup(optarg);
1095 g_free(config->channel_path);
1096 config->channel_path = g_strdup(optarg);
1099 g_free(config->log_filepath);
1100 config->log_filepath = g_strdup(optarg);
1103 g_free(config->pid_filepath);
1104 config->pid_filepath = g_strdup(optarg);
1106 #ifdef CONFIG_FSFREEZE
1108 g_free(config->fsfreeze_hook);
1109 config->fsfreeze_hook = g_strdup(optarg ?: QGA_FSFREEZE_HOOK_DEFAULT);
1113 g_free(config->state_dir);
1114 config->state_dir = g_strdup(optarg);
1117 /* enable all log levels */
1118 config->log_level = G_LOG_LEVEL_MASK;
1121 printf("QEMU Guest Agent %s\n", QEMU_VERSION);
1124 config->daemonize = 1;
1127 config->dumpconf = 1;
1130 if (is_help_option(optarg)) {
1131 qmp_for_each_command(ga_print_cmd, NULL);
1134 config->blacklist = g_list_concat(config->blacklist,
1135 split_list(optarg, ","));
1140 config->service = optarg;
1141 if (strcmp(config->service, "install") == 0) {
1142 if (ga_install_vss_provider()) {
1145 if (ga_install_service(config->channel_path,
1146 config->log_filepath, config->state_dir)) {
1150 } else if (strcmp(config->service, "uninstall") == 0) {
1151 ga_uninstall_vss_provider();
1152 exit(ga_uninstall_service());
1153 } else if (strcmp(config->service, "vss-install") == 0) {
1154 if (ga_install_vss_provider()) {
1158 } else if (strcmp(config->service, "vss-uninstall") == 0) {
1159 ga_uninstall_vss_provider();
1162 printf("Unknown service command.\n");
1171 g_print("Unknown option, try '%s --help' for more information.\n",
1178 static void config_free(GAConfig *config)
1180 g_free(config->method);
1181 g_free(config->log_filepath);
1182 g_free(config->pid_filepath);
1183 g_free(config->state_dir);
1184 g_free(config->channel_path);
1185 g_free(config->bliststr);
1186 #ifdef CONFIG_FSFREEZE
1187 g_free(config->fsfreeze_hook);
1192 static bool check_is_frozen(GAState *s)
1195 /* check if a previous instance of qemu-ga exited with filesystems' state
1196 * marked as frozen. this could be a stale value (a non-qemu-ga process
1197 * or reboot may have since unfrozen them), but better to require an
1198 * uneeded unfreeze than to risk hanging on start-up
1201 if (stat(s->state_filepath_isfrozen, &st) == -1) {
1202 /* it's okay if the file doesn't exist, but if we can't access for
1203 * some other reason, such as permissions, there's a configuration
1204 * that needs to be addressed. so just bail now before we get into
1205 * more trouble later
1207 if (errno != ENOENT) {
1208 g_critical("unable to access state file at path %s: %s",
1209 s->state_filepath_isfrozen, strerror(errno));
1210 return EXIT_FAILURE;
1213 g_warning("previous instance appears to have exited with frozen"
1214 " filesystems. deferring logging/pidfile creation and"
1215 " disabling non-fsfreeze-safe commands until"
1216 " guest-fsfreeze-thaw is issued, or filesystems are"
1217 " manually unfrozen and the file %s is removed",
1218 s->state_filepath_isfrozen);
1225 static int run_agent(GAState *s, GAConfig *config)
1229 g_log_set_default_handler(ga_log, s);
1230 g_log_set_fatal_mask(NULL, G_LOG_LEVEL_ERROR);
1231 ga_enable_logging(s);
1234 /* On win32 the state directory is application specific (be it the default
1235 * or a user override). We got past the command line parsing; let's create
1236 * the directory (with any intermediate directories). If we run into an
1237 * error later on, we won't try to clean up the directory, it is considered
1240 if (g_mkdir_with_parents(config->state_dir, S_IRWXU) == -1) {
1241 g_critical("unable to create (an ancestor of) the state directory"
1242 " '%s': %s", config->state_dir, strerror(errno));
1243 return EXIT_FAILURE;
1247 if (ga_is_frozen(s)) {
1248 if (config->daemonize) {
1249 /* delay opening/locking of pidfile till filesystems are unfrozen */
1250 s->deferred_options.pid_filepath = config->pid_filepath;
1251 become_daemon(NULL);
1253 if (config->log_filepath) {
1254 /* delay opening the log file till filesystems are unfrozen */
1255 s->deferred_options.log_filepath = config->log_filepath;
1257 ga_disable_logging(s);
1258 qmp_for_each_command(ga_disable_non_whitelisted, NULL);
1260 if (config->daemonize) {
1261 become_daemon(config->pid_filepath);
1263 if (config->log_filepath) {
1264 FILE *log_file = ga_open_logfile(config->log_filepath);
1266 g_critical("unable to open specified log file: %s",
1268 return EXIT_FAILURE;
1270 s->log_file = log_file;
1274 /* load persistent state from disk */
1275 if (!read_persistent_state(&s->pstate,
1278 g_critical("failed to load persistent state");
1279 return EXIT_FAILURE;
1282 config->blacklist = ga_command_blacklist_init(config->blacklist);
1283 if (config->blacklist) {
1284 GList *l = config->blacklist;
1285 s->blacklist = config->blacklist;
1287 g_debug("disabling command: %s", (char *)l->data);
1288 qmp_disable_command(l->data);
1292 s->command_state = ga_command_state_new();
1293 ga_command_state_init(s, s->command_state);
1294 ga_command_state_init_all(s->command_state);
1295 json_message_parser_init(&s->parser, process_event);
1298 if (!register_signal_handlers()) {
1299 g_critical("failed to register signal handlers");
1300 return EXIT_FAILURE;
1304 s->main_loop = g_main_loop_new(NULL, false);
1305 if (!channel_init(ga_state, config->method, config->channel_path)) {
1306 g_critical("failed to initialize guest agent channel");
1307 return EXIT_FAILURE;
1310 g_main_loop_run(ga_state->main_loop);
1312 if (config->daemonize) {
1313 SERVICE_TABLE_ENTRY service_table[] = {
1314 { (char *)QGA_SERVICE_NAME, service_main }, { NULL, NULL } };
1315 StartServiceCtrlDispatcher(service_table);
1317 g_main_loop_run(ga_state->main_loop);
1321 return EXIT_SUCCESS;
1324 static void free_blacklist_entry(gpointer entry, gpointer unused)
1329 int main(int argc, char **argv)
1331 int ret = EXIT_SUCCESS;
1332 GAState *s = g_new0(GAState, 1);
1333 GAConfig *config = g_new0(GAConfig, 1);
1335 module_call_init(MODULE_INIT_QAPI);
1337 init_dfl_pathnames();
1338 config_load(config);
1339 config_parse(config, argc, argv);
1341 if (config->pid_filepath == NULL) {
1342 config->pid_filepath = g_strdup(dfl_pathnames.pidfile);
1345 if (config->state_dir == NULL) {
1346 config->state_dir = g_strdup(dfl_pathnames.state_dir);
1349 if (config->method == NULL) {
1350 config->method = g_strdup("virtio-serial");
1353 if (config->channel_path == NULL) {
1354 if (strcmp(config->method, "virtio-serial") == 0) {
1355 /* try the default path for the virtio-serial port */
1356 config->channel_path = g_strdup(QGA_VIRTIO_PATH_DEFAULT);
1357 } else if (strcmp(config->method, "isa-serial") == 0) {
1358 /* try the default path for the serial port - COM1 */
1359 config->channel_path = g_strdup(QGA_SERIAL_PATH_DEFAULT);
1361 g_critical("must specify a path for this channel");
1367 s->log_level = config->log_level;
1368 s->log_file = stderr;
1369 #ifdef CONFIG_FSFREEZE
1370 s->fsfreeze_hook = config->fsfreeze_hook;
1372 s->pstate_filepath = g_strdup_printf("%s/qga.state", config->state_dir);
1373 s->state_filepath_isfrozen = g_strdup_printf("%s/qga.state.isfrozen",
1375 s->frozen = check_is_frozen(s);
1377 if (config->dumpconf) {
1378 config_dump(config);
1382 ret = run_agent(s, config);
1385 if (s->command_state) {
1386 ga_command_state_cleanup_all(s->command_state);
1389 ga_channel_free(s->channel);
1391 g_list_foreach(config->blacklist, free_blacklist_entry, NULL);
1392 g_free(s->pstate_filepath);
1393 g_free(s->state_filepath_isfrozen);
1395 if (config->daemonize) {
1396 unlink(config->pid_filepath);
1399 config_free(config);