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.
14 #include "qemu/osdep.h"
16 #include <glib/gstdio.h>
21 #include "qemu-common.h"
22 #include "qapi/qmp/json-parser.h"
23 #include "qapi/qmp/qdict.h"
24 #include "qapi/qmp/qjson.h"
25 #include "qapi/qmp/qstring.h"
26 #include "guest-agent-core.h"
27 #include "qga-qapi-init-commands.h"
28 #include "qapi/qmp/qerror.h"
29 #include "qapi/error.h"
31 #include "qemu/bswap.h"
32 #include "qemu/help_option.h"
33 #include "qemu/sockets.h"
34 #include "qemu/systemd.h"
35 #include "qemu-version.h"
38 #include "qga/service-win32.h"
39 #include "qga/vss-win32.h"
44 #define CONFIG_FSFREEZE
49 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
50 #define QGA_STATE_RELATIVE_DIR "run"
51 #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0"
53 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
54 #define QGA_STATE_RELATIVE_DIR "qemu-ga"
55 #define QGA_SERIAL_PATH_DEFAULT "COM1"
57 #ifdef CONFIG_FSFREEZE
58 #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook"
60 #define QGA_SENTINEL_BYTE 0xFF
61 #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf"
62 #define QGA_RETRY_INTERVAL 5
65 const char *state_dir;
69 typedef struct GAPersistentState {
70 #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000
74 typedef struct GAConfig GAConfig;
77 JSONMessageParser parser;
80 bool virtio; /* fastpath to check for virtio to deal with poll() quirks */
81 GACommandState *command_state;
82 GLogLevelFlags log_level;
89 bool delimit_response;
92 char *state_filepath_isfrozen;
94 const char *log_filepath;
95 const char *pid_filepath;
97 #ifdef CONFIG_FSFREEZE
98 const char *fsfreeze_hook;
100 gchar *pstate_filepath;
101 GAPersistentState pstate;
103 int socket_activation;
107 struct GAState *ga_state;
108 QmpCommandList ga_commands;
110 /* commands that are safe to issue while filesystems are frozen */
111 static const char *ga_freeze_whitelist[] = {
115 "guest-sync-delimited",
116 "guest-fsfreeze-status",
117 "guest-fsfreeze-thaw",
122 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
124 DWORD WINAPI handle_serial_device_events(DWORD type, LPVOID data);
125 VOID WINAPI service_main(DWORD argc, TCHAR *argv[]);
127 static int run_agent(GAState *s);
128 static void stop_agent(GAState *s, bool requested);
131 init_dfl_pathnames(void)
133 g_assert(dfl_pathnames.state_dir == NULL);
134 g_assert(dfl_pathnames.pidfile == NULL);
135 dfl_pathnames.state_dir = qemu_get_local_state_pathname(
136 QGA_STATE_RELATIVE_DIR);
137 dfl_pathnames.pidfile = qemu_get_local_state_pathname(
138 QGA_STATE_RELATIVE_DIR G_DIR_SEPARATOR_S "qemu-ga.pid");
141 static void quit_handler(int sig)
143 /* if we're frozen, don't exit unless we're absolutely forced to,
144 * because it's basically impossible for graceful exit to complete
145 * unless all log/pid files are on unfreezable filesystems. there's
146 * also a very likely chance killing the agent before unfreezing
147 * the filesystems is a mistake (or will be viewed as one later).
148 * On Windows the freeze interval is limited to 10 seconds, so
149 * we should quit, but first we should wait for the timeout, thaw
150 * the filesystem and quit.
152 if (ga_is_frozen(ga_state)) {
156 HANDLE hEventTimeout;
158 g_debug("Thawing filesystems before exiting");
160 hEventTimeout = OpenEvent(EVENT_ALL_ACCESS, FALSE, EVENT_NAME_TIMEOUT);
162 WaitForSingleObject(hEventTimeout, 0);
163 CloseHandle(hEventTimeout);
165 qga_vss_fsfreeze(&i, false, NULL, &err);
167 g_debug("Error unfreezing filesystems prior to exiting: %s",
168 error_get_pretty(err));
175 g_debug("received signal num %d, quitting", sig);
177 stop_agent(ga_state, true);
181 static gboolean register_signal_handlers(void)
183 struct sigaction sigact;
186 memset(&sigact, 0, sizeof(struct sigaction));
187 sigact.sa_handler = quit_handler;
189 ret = sigaction(SIGINT, &sigact, NULL);
191 g_error("error configuring signal handler: %s", strerror(errno));
193 ret = sigaction(SIGTERM, &sigact, NULL);
195 g_error("error configuring signal handler: %s", strerror(errno));
198 sigact.sa_handler = SIG_IGN;
199 if (sigaction(SIGPIPE, &sigact, NULL) != 0) {
200 g_error("error configuring SIGPIPE signal handler: %s",
207 /* TODO: use this in place of all post-fork() fclose(std*) callers */
208 void reopen_fd_to_null(int fd)
212 nullfd = open("/dev/null", O_RDWR);
225 static void usage(const char *cmd)
228 "Usage: %s [-m <method> -p <path>] [<options>]\n"
229 "QEMU Guest Agent " QEMU_FULL_VERSION "\n"
232 " -m, --method transport method: one of unix-listen, virtio-serial,\n"
233 " isa-serial, or vsock-listen (virtio-serial is the default)\n"
234 " -p, --path device/socket path (the default for virtio-serial is:\n"
236 " the default for isa-serial is:\n"
238 " Socket addresses for vsock-listen are written as\n"
240 " -l, --logfile set logfile path, logs to stderr by default\n"
241 " -f, --pidfile specify pidfile (default is %s)\n"
242 #ifdef CONFIG_FSFREEZE
243 " -F, --fsfreeze-hook\n"
244 " enable fsfreeze hook. Accepts an optional argument that\n"
245 " specifies script to run on freeze/thaw. Script will be\n"
246 " called with 'freeze'/'thaw' arguments accordingly.\n"
248 " If using -F with an argument, do not follow -F with a\n"
250 " (for example: -F/var/run/fsfreezehook.sh)\n"
252 " -t, --statedir specify dir to store state information (absolute paths\n"
253 " only, default is %s)\n"
254 " -v, --verbose log extra debugging information\n"
255 " -V, --version print version information and exit\n"
256 " -d, --daemonize become a daemon\n"
258 " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n"
260 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
261 " to list available RPCs)\n"
262 " -D, --dump-conf dump a qemu-ga config file based on current config\n"
263 " options / command-line parameters to stdout\n"
264 " -r, --retry-path attempt re-opening path if it's unavailable or closed\n"
265 " due to an error which may be recoverable in the future\n"
266 " (virtio-serial driver re-install, serial device hot\n"
267 " plug/unplug, etc.)\n"
268 " -h, --help display this help and exit\n"
270 QEMU_HELP_BOTTOM "\n"
271 , cmd, QGA_VIRTIO_PATH_DEFAULT, QGA_SERIAL_PATH_DEFAULT,
272 dfl_pathnames.pidfile,
273 #ifdef CONFIG_FSFREEZE
274 QGA_FSFREEZE_HOOK_DEFAULT,
276 dfl_pathnames.state_dir);
279 static const char *ga_log_level_str(GLogLevelFlags level)
281 switch (level & G_LOG_LEVEL_MASK) {
282 case G_LOG_LEVEL_ERROR:
284 case G_LOG_LEVEL_CRITICAL:
286 case G_LOG_LEVEL_WARNING:
288 case G_LOG_LEVEL_MESSAGE:
290 case G_LOG_LEVEL_INFO:
292 case G_LOG_LEVEL_DEBUG:
299 bool ga_logging_enabled(GAState *s)
301 return s->logging_enabled;
304 void ga_disable_logging(GAState *s)
306 s->logging_enabled = false;
309 void ga_enable_logging(GAState *s)
311 s->logging_enabled = true;
314 static void ga_log(const gchar *domain, GLogLevelFlags level,
315 const gchar *msg, gpointer opaque)
319 const char *level_str = ga_log_level_str(level);
321 if (!ga_logging_enabled(s)) {
325 level &= G_LOG_LEVEL_MASK;
327 if (g_strcmp0(domain, "syslog") == 0) {
328 syslog(LOG_INFO, "%s: %s", level_str, msg);
329 } else if (level & s->log_level) {
331 if (level & s->log_level) {
333 g_get_current_time(&time);
335 "%lu.%lu: %s: %s\n", time.tv_sec, time.tv_usec, level_str, msg);
340 void ga_set_response_delimited(GAState *s)
342 s->delimit_response = true;
345 static FILE *ga_open_logfile(const char *logfile)
349 f = fopen(logfile, "a");
354 qemu_set_cloexec(fileno(f));
358 static gint ga_strcmp(gconstpointer str1, gconstpointer str2)
360 return strcmp(str1, str2);
363 /* disable commands that aren't safe for fsfreeze */
364 static void ga_disable_non_whitelisted(const QmpCommand *cmd, void *opaque)
366 bool whitelisted = false;
368 const char *name = qmp_command_name(cmd);
370 while (ga_freeze_whitelist[i] != NULL) {
371 if (strcmp(name, ga_freeze_whitelist[i]) == 0) {
377 g_debug("disabling command: %s", name);
378 qmp_disable_command(&ga_commands, name);
382 /* [re-]enable all commands, except those explicitly blacklisted by user */
383 static void ga_enable_non_blacklisted(const QmpCommand *cmd, void *opaque)
385 GList *blacklist = opaque;
386 const char *name = qmp_command_name(cmd);
388 if (g_list_find_custom(blacklist, name, ga_strcmp) == NULL &&
389 !qmp_command_is_enabled(cmd)) {
390 g_debug("enabling command: %s", name);
391 qmp_enable_command(&ga_commands, name);
395 static bool ga_create_file(const char *path)
397 int fd = open(path, O_CREAT | O_WRONLY, S_IWUSR | S_IRUSR);
399 g_warning("unable to open/create file %s: %s", path, strerror(errno));
406 static bool ga_delete_file(const char *path)
408 int ret = unlink(path);
410 g_warning("unable to delete file: %s: %s", path, strerror(errno));
417 bool ga_is_frozen(GAState *s)
422 void ga_set_frozen(GAState *s)
424 if (ga_is_frozen(s)) {
427 /* disable all non-whitelisted (for frozen state) commands */
428 qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL);
429 g_warning("disabling logging due to filesystem freeze");
430 ga_disable_logging(s);
432 if (!ga_create_file(s->state_filepath_isfrozen)) {
433 g_warning("unable to create %s, fsfreeze may not function properly",
434 s->state_filepath_isfrozen);
438 void ga_unset_frozen(GAState *s)
440 if (!ga_is_frozen(s)) {
444 /* if we delayed creation/opening of pid/log files due to being
445 * in a frozen state at start up, do it now
447 if (s->deferred_options.log_filepath) {
448 s->log_file = ga_open_logfile(s->deferred_options.log_filepath);
450 s->log_file = stderr;
452 s->deferred_options.log_filepath = NULL;
454 ga_enable_logging(s);
455 g_warning("logging re-enabled due to filesystem unfreeze");
456 if (s->deferred_options.pid_filepath) {
459 if (!qemu_write_pidfile(s->deferred_options.pid_filepath, &err)) {
460 g_warning("%s", error_get_pretty(err));
463 s->deferred_options.pid_filepath = NULL;
466 /* enable all disabled, non-blacklisted commands */
467 qmp_for_each_command(&ga_commands, ga_enable_non_blacklisted, s->blacklist);
469 if (!ga_delete_file(s->state_filepath_isfrozen)) {
470 g_warning("unable to delete %s, fsfreeze may not function properly",
471 s->state_filepath_isfrozen);
475 #ifdef CONFIG_FSFREEZE
476 const char *ga_fsfreeze_hook(GAState *s)
478 return s->fsfreeze_hook;
482 static void become_daemon(const char *pidfile)
498 if (!qemu_write_pidfile(pidfile, &err)) {
499 g_critical("%s", error_get_pretty(err));
505 umask(S_IRWXG | S_IRWXO);
510 if ((chdir("/")) < 0) {
514 reopen_fd_to_null(STDIN_FILENO);
515 reopen_fd_to_null(STDOUT_FILENO);
516 reopen_fd_to_null(STDERR_FILENO);
523 g_critical("failed to daemonize");
528 static int send_response(GAState *s, const QDict *rsp)
531 QString *payload_qstr, *response_qstr;
534 g_assert(s->channel);
540 payload_qstr = qobject_to_json(QOBJECT(rsp));
545 if (s->delimit_response) {
546 s->delimit_response = false;
547 response_qstr = qstring_new();
548 qstring_append_chr(response_qstr, QGA_SENTINEL_BYTE);
549 qstring_append(response_qstr, qstring_get_str(payload_qstr));
550 qobject_unref(payload_qstr);
552 response_qstr = payload_qstr;
555 qstring_append_chr(response_qstr, '\n');
556 buf = qstring_get_str(response_qstr);
557 status = ga_channel_write_all(s->channel, buf, strlen(buf));
558 qobject_unref(response_qstr);
559 if (status != G_IO_STATUS_NORMAL) {
566 /* handle requests/control events coming in over the channel */
567 static void process_event(void *opaque, QObject *obj, Error *err)
573 g_debug("process_event: called");
574 assert(!obj != !err);
576 rsp = qmp_error_response(err);
580 g_debug("processing command");
581 rsp = qmp_dispatch(&ga_commands, obj, false);
584 ret = send_response(s, rsp);
586 g_warning("error sending error response: %s", strerror(-ret));
592 /* false return signals GAChannel to close the current client connection */
593 static gboolean channel_event_cb(GIOCondition condition, gpointer data)
596 gchar buf[QGA_READ_COUNT_DEFAULT+1];
598 GIOStatus status = ga_channel_read(s->channel, buf, QGA_READ_COUNT_DEFAULT, &count);
600 case G_IO_STATUS_ERROR:
601 g_warning("error reading channel");
602 stop_agent(s, false);
604 case G_IO_STATUS_NORMAL:
606 g_debug("read data, count: %d, data: %s", (int)count, buf);
607 json_message_parser_feed(&s->parser, (char *)buf, (int)count);
609 case G_IO_STATUS_EOF:
610 g_debug("received EOF");
615 case G_IO_STATUS_AGAIN:
616 /* virtio causes us to spin here when no process is attached to
617 * host-side chardev. sleep a bit to mitigate this
624 g_warning("unknown channel read status, closing");
630 static gboolean channel_init(GAState *s, const gchar *method, const gchar *path,
633 GAChannelMethod channel_method;
635 if (strcmp(method, "virtio-serial") == 0) {
636 s->virtio = true; /* virtio requires special handling in some cases */
637 channel_method = GA_CHANNEL_VIRTIO_SERIAL;
638 } else if (strcmp(method, "isa-serial") == 0) {
639 channel_method = GA_CHANNEL_ISA_SERIAL;
640 } else if (strcmp(method, "unix-listen") == 0) {
641 channel_method = GA_CHANNEL_UNIX_LISTEN;
642 } else if (strcmp(method, "vsock-listen") == 0) {
643 channel_method = GA_CHANNEL_VSOCK_LISTEN;
645 g_critical("unsupported channel method/type: %s", method);
649 s->channel = ga_channel_new(channel_method, path, listen_fd,
650 channel_event_cb, s);
652 g_critical("failed to create guest agent channel");
660 DWORD WINAPI handle_serial_device_events(DWORD type, LPVOID data)
662 DWORD ret = NO_ERROR;
663 PDEV_BROADCAST_HDR broadcast_header = (PDEV_BROADCAST_HDR)data;
665 if (broadcast_header->dbch_devicetype == DBT_DEVTYP_DEVICEINTERFACE) {
667 /* Device inserted */
668 case DBT_DEVICEARRIVAL:
669 /* Start QEMU-ga's service */
670 if (!SetEvent(ga_state->wakeup_event)) {
671 ret = GetLastError();
675 case DBT_DEVICEQUERYREMOVE:
676 case DBT_DEVICEREMOVEPENDING:
677 case DBT_DEVICEREMOVECOMPLETE:
678 /* Stop QEMU-ga's service */
679 if (!ResetEvent(ga_state->wakeup_event)) {
680 ret = GetLastError();
684 ret = ERROR_CALL_NOT_IMPLEMENTED;
690 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
693 DWORD ret = NO_ERROR;
694 GAService *service = &ga_state->service;
698 case SERVICE_CONTROL_STOP:
699 case SERVICE_CONTROL_SHUTDOWN:
700 quit_handler(SIGTERM);
701 SetEvent(ga_state->wakeup_event);
702 service->status.dwCurrentState = SERVICE_STOP_PENDING;
703 SetServiceStatus(service->status_handle, &service->status);
705 case SERVICE_CONTROL_DEVICEEVENT:
706 handle_serial_device_events(type, data);
710 ret = ERROR_CALL_NOT_IMPLEMENTED;
715 VOID WINAPI service_main(DWORD argc, TCHAR *argv[])
717 GAService *service = &ga_state->service;
719 service->status_handle = RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME,
720 service_ctrl_handler, NULL);
722 if (service->status_handle == 0) {
723 g_critical("Failed to register extended requests function!\n");
727 service->status.dwServiceType = SERVICE_WIN32;
728 service->status.dwCurrentState = SERVICE_RUNNING;
729 service->status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN;
730 service->status.dwWin32ExitCode = NO_ERROR;
731 service->status.dwServiceSpecificExitCode = NO_ERROR;
732 service->status.dwCheckPoint = 0;
733 service->status.dwWaitHint = 0;
734 DEV_BROADCAST_DEVICEINTERFACE notification_filter;
735 ZeroMemory(¬ification_filter, sizeof(notification_filter));
736 notification_filter.dbcc_devicetype = DBT_DEVTYP_DEVICEINTERFACE;
737 notification_filter.dbcc_size = sizeof(DEV_BROADCAST_DEVICEINTERFACE);
738 notification_filter.dbcc_classguid = GUID_VIOSERIAL_PORT;
740 service->device_notification_handle =
741 RegisterDeviceNotification(service->status_handle,
742 ¬ification_filter, DEVICE_NOTIFY_SERVICE_HANDLE);
743 if (!service->device_notification_handle) {
744 g_critical("Failed to register device notification handle!\n");
747 SetServiceStatus(service->status_handle, &service->status);
751 UnregisterDeviceNotification(service->device_notification_handle);
752 service->status.dwCurrentState = SERVICE_STOPPED;
753 SetServiceStatus(service->status_handle, &service->status);
757 static void set_persistent_state_defaults(GAPersistentState *pstate)
760 pstate->fd_counter = QGA_PSTATE_DEFAULT_FD_COUNTER;
763 static void persistent_state_from_keyfile(GAPersistentState *pstate,
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
774 set_persistent_state_defaults(pstate);
776 if (g_key_file_has_key(keyfile, "global", "fd_counter", NULL)) {
778 g_key_file_get_integer(keyfile, "global", "fd_counter", NULL);
782 static void persistent_state_to_keyfile(const GAPersistentState *pstate,
788 g_key_file_set_integer(keyfile, "global", "fd_counter", pstate->fd_counter);
791 static gboolean write_persistent_state(const GAPersistentState *pstate,
794 GKeyFile *keyfile = g_key_file_new();
802 persistent_state_to_keyfile(pstate, keyfile);
803 data = g_key_file_to_data(keyfile, &data_len, &gerr);
805 g_critical("failed to convert persistent state to string: %s",
811 g_file_set_contents(path, data, data_len, &gerr);
813 g_critical("failed to write persistent state to %s: %s",
814 path, gerr->message);
824 g_key_file_free(keyfile);
830 static gboolean read_persistent_state(GAPersistentState *pstate,
831 const gchar *path, gboolean frozen)
833 GKeyFile *keyfile = NULL;
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.
845 if (errno != ENOENT) {
846 g_critical("unable to access state file at path %s: %s",
847 path, strerror(errno));
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)
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.
865 set_persistent_state_defaults(pstate);
867 ret = write_persistent_state(pstate, path);
869 g_critical("unable to create state file at path %s", path);
878 keyfile = g_key_file_new();
879 g_key_file_load_from_file(keyfile, path, 0, &gerr);
881 g_critical("error loading persistent state from path: %s, %s",
882 path, gerr->message);
887 persistent_state_from_keyfile(pstate, keyfile);
891 g_key_file_free(keyfile);
900 int64_t ga_get_fd_handle(GAState *s, Error **errp)
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
909 g_assert(!ga_is_frozen(s));
911 handle = s->pstate.fd_counter++;
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) {
919 if (!write_persistent_state(&s->pstate, s->pstate_filepath)) {
920 error_setg(errp, "failed to commit persistent state to disk");
927 static void ga_print_cmd(const QmpCommand *cmd, void *opaque)
929 printf("%s\n", qmp_command_name(cmd));
932 static GList *split_list(const gchar *str, const gchar *delim)
938 strv = g_strsplit(str, delim, -1);
939 for (i = 0; strv[i]; i++) {
940 list = g_list_prepend(list, strv[i]);
952 #ifdef CONFIG_FSFREEZE
959 gchar *bliststr; /* blacklist may point to this string */
962 GLogLevelFlags log_level;
967 static void config_load(GAConfig *config)
971 const char *conf = g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT;
973 /* read system config */
974 keyfile = g_key_file_new();
975 if (!g_key_file_load_from_file(keyfile, conf, 0, &gerr)) {
978 if (g_key_file_has_key(keyfile, "general", "daemon", NULL)) {
980 g_key_file_get_boolean(keyfile, "general", "daemon", &gerr);
982 if (g_key_file_has_key(keyfile, "general", "method", NULL)) {
984 g_key_file_get_string(keyfile, "general", "method", &gerr);
986 if (g_key_file_has_key(keyfile, "general", "path", NULL)) {
987 config->channel_path =
988 g_key_file_get_string(keyfile, "general", "path", &gerr);
990 if (g_key_file_has_key(keyfile, "general", "logfile", NULL)) {
991 config->log_filepath =
992 g_key_file_get_string(keyfile, "general", "logfile", &gerr);
994 if (g_key_file_has_key(keyfile, "general", "pidfile", NULL)) {
995 config->pid_filepath =
996 g_key_file_get_string(keyfile, "general", "pidfile", &gerr);
998 #ifdef CONFIG_FSFREEZE
999 if (g_key_file_has_key(keyfile, "general", "fsfreeze-hook", NULL)) {
1000 config->fsfreeze_hook =
1001 g_key_file_get_string(keyfile,
1002 "general", "fsfreeze-hook", &gerr);
1005 if (g_key_file_has_key(keyfile, "general", "statedir", NULL)) {
1007 g_key_file_get_string(keyfile, "general", "statedir", &gerr);
1009 if (g_key_file_has_key(keyfile, "general", "verbose", NULL) &&
1010 g_key_file_get_boolean(keyfile, "general", "verbose", &gerr)) {
1011 /* enable all log levels */
1012 config->log_level = G_LOG_LEVEL_MASK;
1014 if (g_key_file_has_key(keyfile, "general", "retry-path", NULL)) {
1015 config->retry_path =
1016 g_key_file_get_boolean(keyfile, "general", "retry-path", &gerr);
1018 if (g_key_file_has_key(keyfile, "general", "blacklist", NULL)) {
1020 g_key_file_get_string(keyfile, "general", "blacklist", &gerr);
1021 config->blacklist = g_list_concat(config->blacklist,
1022 split_list(config->bliststr, ","));
1026 g_key_file_free(keyfile);
1028 !(gerr->domain == G_FILE_ERROR && gerr->code == G_FILE_ERROR_NOENT)) {
1029 g_critical("error loading configuration from path: %s, %s",
1030 QGA_CONF_DEFAULT, gerr->message);
1033 g_clear_error(&gerr);
1036 static gchar *list_join(GList *list, const gchar separator)
1038 GString *str = g_string_new("");
1041 str = g_string_append(str, (gchar *)list->data);
1042 list = g_list_next(list);
1044 str = g_string_append_c(str, separator);
1048 return g_string_free(str, FALSE);
1051 static void config_dump(GAConfig *config)
1053 GError *error = NULL;
1057 keyfile = g_key_file_new();
1060 g_key_file_set_boolean(keyfile, "general", "daemon", config->daemonize);
1061 g_key_file_set_string(keyfile, "general", "method", config->method);
1062 if (config->channel_path) {
1063 g_key_file_set_string(keyfile, "general", "path", config->channel_path);
1065 if (config->log_filepath) {
1066 g_key_file_set_string(keyfile, "general", "logfile",
1067 config->log_filepath);
1069 g_key_file_set_string(keyfile, "general", "pidfile", config->pid_filepath);
1070 #ifdef CONFIG_FSFREEZE
1071 if (config->fsfreeze_hook) {
1072 g_key_file_set_string(keyfile, "general", "fsfreeze-hook",
1073 config->fsfreeze_hook);
1076 g_key_file_set_string(keyfile, "general", "statedir", config->state_dir);
1077 g_key_file_set_boolean(keyfile, "general", "verbose",
1078 config->log_level == G_LOG_LEVEL_MASK);
1079 g_key_file_set_boolean(keyfile, "general", "retry-path",
1080 config->retry_path);
1081 tmp = list_join(config->blacklist, ',');
1082 g_key_file_set_string(keyfile, "general", "blacklist", tmp);
1085 tmp = g_key_file_to_data(keyfile, NULL, &error);
1087 g_critical("Failed to dump keyfile: %s", error->message);
1088 g_clear_error(&error);
1094 g_key_file_free(keyfile);
1097 static void config_parse(GAConfig *config, int argc, char **argv)
1099 const char *sopt = "hVvdm:p:l:f:F::b:s:t:Dr";
1100 int opt_ind = 0, ch;
1101 const struct option lopt[] = {
1102 { "help", 0, NULL, 'h' },
1103 { "version", 0, NULL, 'V' },
1104 { "dump-conf", 0, NULL, 'D' },
1105 { "logfile", 1, NULL, 'l' },
1106 { "pidfile", 1, NULL, 'f' },
1107 #ifdef CONFIG_FSFREEZE
1108 { "fsfreeze-hook", 2, NULL, 'F' },
1110 { "verbose", 0, NULL, 'v' },
1111 { "method", 1, NULL, 'm' },
1112 { "path", 1, NULL, 'p' },
1113 { "daemonize", 0, NULL, 'd' },
1114 { "blacklist", 1, NULL, 'b' },
1116 { "service", 1, NULL, 's' },
1118 { "statedir", 1, NULL, 't' },
1119 { "retry-path", 0, NULL, 'r' },
1120 { NULL, 0, NULL, 0 }
1123 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
1126 g_free(config->method);
1127 config->method = g_strdup(optarg);
1130 g_free(config->channel_path);
1131 config->channel_path = g_strdup(optarg);
1134 g_free(config->log_filepath);
1135 config->log_filepath = g_strdup(optarg);
1138 g_free(config->pid_filepath);
1139 config->pid_filepath = g_strdup(optarg);
1141 #ifdef CONFIG_FSFREEZE
1143 g_free(config->fsfreeze_hook);
1144 config->fsfreeze_hook = g_strdup(optarg ?: QGA_FSFREEZE_HOOK_DEFAULT);
1148 g_free(config->state_dir);
1149 config->state_dir = g_strdup(optarg);
1152 /* enable all log levels */
1153 config->log_level = G_LOG_LEVEL_MASK;
1156 printf("QEMU Guest Agent %s\n", QEMU_VERSION);
1159 config->daemonize = 1;
1162 config->dumpconf = 1;
1165 config->retry_path = true;
1168 if (is_help_option(optarg)) {
1169 qmp_for_each_command(&ga_commands, ga_print_cmd, NULL);
1172 config->blacklist = g_list_concat(config->blacklist,
1173 split_list(optarg, ","));
1178 config->service = optarg;
1179 if (strcmp(config->service, "install") == 0) {
1180 if (ga_install_vss_provider()) {
1183 if (ga_install_service(config->channel_path,
1184 config->log_filepath, config->state_dir)) {
1188 } else if (strcmp(config->service, "uninstall") == 0) {
1189 ga_uninstall_vss_provider();
1190 exit(ga_uninstall_service());
1191 } else if (strcmp(config->service, "vss-install") == 0) {
1192 if (ga_install_vss_provider()) {
1196 } else if (strcmp(config->service, "vss-uninstall") == 0) {
1197 ga_uninstall_vss_provider();
1200 printf("Unknown service command.\n");
1209 g_print("Unknown option, try '%s --help' for more information.\n",
1216 static void config_free(GAConfig *config)
1218 g_free(config->method);
1219 g_free(config->log_filepath);
1220 g_free(config->pid_filepath);
1221 g_free(config->state_dir);
1222 g_free(config->channel_path);
1223 g_free(config->bliststr);
1224 #ifdef CONFIG_FSFREEZE
1225 g_free(config->fsfreeze_hook);
1227 g_list_free_full(config->blacklist, g_free);
1231 static bool check_is_frozen(GAState *s)
1234 /* check if a previous instance of qemu-ga exited with filesystems' state
1235 * marked as frozen. this could be a stale value (a non-qemu-ga process
1236 * or reboot may have since unfrozen them), but better to require an
1237 * uneeded unfreeze than to risk hanging on start-up
1240 if (stat(s->state_filepath_isfrozen, &st) == -1) {
1241 /* it's okay if the file doesn't exist, but if we can't access for
1242 * some other reason, such as permissions, there's a configuration
1243 * that needs to be addressed. so just bail now before we get into
1244 * more trouble later
1246 if (errno != ENOENT) {
1247 g_critical("unable to access state file at path %s: %s",
1248 s->state_filepath_isfrozen, strerror(errno));
1249 return EXIT_FAILURE;
1252 g_warning("previous instance appears to have exited with frozen"
1253 " filesystems. deferring logging/pidfile creation and"
1254 " disabling non-fsfreeze-safe commands until"
1255 " guest-fsfreeze-thaw is issued, or filesystems are"
1256 " manually unfrozen and the file %s is removed",
1257 s->state_filepath_isfrozen);
1264 static GAState *initialize_agent(GAConfig *config, int socket_activation)
1266 GAState *s = g_new0(GAState, 1);
1268 g_assert(ga_state == NULL);
1270 s->log_level = config->log_level;
1271 s->log_file = stderr;
1272 #ifdef CONFIG_FSFREEZE
1273 s->fsfreeze_hook = config->fsfreeze_hook;
1275 s->pstate_filepath = g_strdup_printf("%s/qga.state", config->state_dir);
1276 s->state_filepath_isfrozen = g_strdup_printf("%s/qga.state.isfrozen",
1278 s->frozen = check_is_frozen(s);
1280 g_log_set_default_handler(ga_log, s);
1281 g_log_set_fatal_mask(NULL, G_LOG_LEVEL_ERROR);
1282 ga_enable_logging(s);
1285 /* On win32 the state directory is application specific (be it the default
1286 * or a user override). We got past the command line parsing; let's create
1287 * the directory (with any intermediate directories). If we run into an
1288 * error later on, we won't try to clean up the directory, it is considered
1291 if (g_mkdir_with_parents(config->state_dir, S_IRWXU) == -1) {
1292 g_critical("unable to create (an ancestor of) the state directory"
1293 " '%s': %s", config->state_dir, strerror(errno));
1298 if (ga_is_frozen(s)) {
1299 if (config->daemonize) {
1300 /* delay opening/locking of pidfile till filesystems are unfrozen */
1301 s->deferred_options.pid_filepath = config->pid_filepath;
1302 become_daemon(NULL);
1304 if (config->log_filepath) {
1305 /* delay opening the log file till filesystems are unfrozen */
1306 s->deferred_options.log_filepath = config->log_filepath;
1308 ga_disable_logging(s);
1309 qmp_for_each_command(&ga_commands, ga_disable_non_whitelisted, NULL);
1311 if (config->daemonize) {
1312 become_daemon(config->pid_filepath);
1314 if (config->log_filepath) {
1315 FILE *log_file = ga_open_logfile(config->log_filepath);
1317 g_critical("unable to open specified log file: %s",
1321 s->log_file = log_file;
1325 /* load persistent state from disk */
1326 if (!read_persistent_state(&s->pstate,
1329 g_critical("failed to load persistent state");
1333 config->blacklist = ga_command_blacklist_init(config->blacklist);
1334 if (config->blacklist) {
1335 GList *l = config->blacklist;
1336 s->blacklist = config->blacklist;
1338 g_debug("disabling command: %s", (char *)l->data);
1339 qmp_disable_command(&ga_commands, l->data);
1343 s->command_state = ga_command_state_new();
1344 ga_command_state_init(s, s->command_state);
1345 ga_command_state_init_all(s->command_state);
1346 json_message_parser_init(&s->parser, process_event, s, NULL);
1349 if (!register_signal_handlers()) {
1350 g_critical("failed to register signal handlers");
1355 s->main_loop = g_main_loop_new(NULL, false);
1358 s->socket_activation = socket_activation;
1361 s->wakeup_event = CreateEvent(NULL, TRUE, FALSE, TEXT("WakeUp"));
1362 if (s->wakeup_event == NULL) {
1363 g_critical("CreateEvent failed");
1372 static void cleanup_agent(GAState *s)
1375 CloseHandle(s->wakeup_event);
1377 if (s->command_state) {
1378 ga_command_state_cleanup_all(s->command_state);
1379 ga_command_state_free(s->command_state);
1380 json_message_parser_destroy(&s->parser);
1382 g_free(s->pstate_filepath);
1383 g_free(s->state_filepath_isfrozen);
1385 g_main_loop_unref(s->main_loop);
1391 static int run_agent_once(GAState *s)
1393 if (!channel_init(s, s->config->method, s->config->channel_path,
1394 s->socket_activation ? FIRST_SOCKET_ACTIVATION_FD : -1)) {
1395 g_critical("failed to initialize guest agent channel");
1396 return EXIT_FAILURE;
1399 g_main_loop_run(ga_state->main_loop);
1402 ga_channel_free(s->channel);
1405 return EXIT_SUCCESS;
1408 static void wait_for_channel_availability(GAState *s)
1410 g_warning("waiting for channel path...");
1412 sleep(QGA_RETRY_INTERVAL);
1416 dwWaitResult = WaitForSingleObject(s->wakeup_event, INFINITE);
1418 switch (dwWaitResult) {
1424 g_critical("WaitForSingleObject failed");
1429 static int run_agent(GAState *s)
1431 int ret = EXIT_SUCCESS;
1433 s->force_exit = false;
1436 ret = run_agent_once(s);
1437 if (s->config->retry_path && !s->force_exit) {
1438 g_warning("agent stopped unexpectedly, restarting...");
1439 wait_for_channel_availability(s);
1441 } while (s->config->retry_path && !s->force_exit);
1446 static void stop_agent(GAState *s, bool requested)
1448 if (!s->force_exit) {
1449 s->force_exit = requested;
1452 if (g_main_loop_is_running(s->main_loop)) {
1453 g_main_loop_quit(s->main_loop);
1457 int main(int argc, char **argv)
1459 int ret = EXIT_SUCCESS;
1461 GAConfig *config = g_new0(GAConfig, 1);
1462 int socket_activation;
1464 config->log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL;
1466 qga_qmp_init_marshal(&ga_commands);
1468 init_dfl_pathnames();
1469 config_load(config);
1470 config_parse(config, argc, argv);
1472 if (config->pid_filepath == NULL) {
1473 config->pid_filepath = g_strdup(dfl_pathnames.pidfile);
1476 if (config->state_dir == NULL) {
1477 config->state_dir = g_strdup(dfl_pathnames.state_dir);
1480 if (config->method == NULL) {
1481 config->method = g_strdup("virtio-serial");
1484 socket_activation = check_socket_activation();
1485 if (socket_activation > 1) {
1486 g_critical("qemu-ga only supports listening on one socket");
1490 if (socket_activation) {
1491 SocketAddress *addr;
1493 g_free(config->method);
1494 g_free(config->channel_path);
1495 config->method = NULL;
1496 config->channel_path = NULL;
1498 addr = socket_local_address(FIRST_SOCKET_ACTIVATION_FD, NULL);
1500 if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
1501 config->method = g_strdup("unix-listen");
1502 } else if (addr->type == SOCKET_ADDRESS_TYPE_VSOCK) {
1503 config->method = g_strdup("vsock-listen");
1506 qapi_free_SocketAddress(addr);
1509 if (!config->method) {
1510 g_critical("unsupported listen fd type");
1514 } else if (config->channel_path == NULL) {
1515 if (strcmp(config->method, "virtio-serial") == 0) {
1516 /* try the default path for the virtio-serial port */
1517 config->channel_path = g_strdup(QGA_VIRTIO_PATH_DEFAULT);
1518 } else if (strcmp(config->method, "isa-serial") == 0) {
1519 /* try the default path for the serial port - COM1 */
1520 config->channel_path = g_strdup(QGA_SERIAL_PATH_DEFAULT);
1522 g_critical("must specify a path for this channel");
1528 if (config->dumpconf) {
1529 config_dump(config);
1533 s = initialize_agent(config, socket_activation);
1535 g_critical("error initializing guest agent");
1540 if (config->daemonize) {
1541 SERVICE_TABLE_ENTRY service_table[] = {
1542 { (char *)QGA_SERVICE_NAME, service_main }, { NULL, NULL } };
1543 StartServiceCtrlDispatcher(service_table);
1554 if (config->daemonize) {
1555 unlink(config->pid_filepath);
1558 config_free(config);