4 * Copyright IBM Corp. 2011
7 * Adam Litke <aglitke@linux.vnet.ibm.com>
8 * Michael Roth <mdroth@linux.vnet.ibm.com>
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(rsp
&& s
->channel
);
536 payload_qstr
= qobject_to_json(QOBJECT(rsp
));
541 if (s
->delimit_response
) {
542 s
->delimit_response
= false;
543 response_qstr
= qstring_new();
544 qstring_append_chr(response_qstr
, QGA_SENTINEL_BYTE
);
545 qstring_append(response_qstr
, qstring_get_str(payload_qstr
));
546 qobject_unref(payload_qstr
);
548 response_qstr
= payload_qstr
;
551 qstring_append_chr(response_qstr
, '\n');
552 buf
= qstring_get_str(response_qstr
);
553 status
= ga_channel_write_all(s
->channel
, buf
, strlen(buf
));
554 qobject_unref(response_qstr
);
555 if (status
!= G_IO_STATUS_NORMAL
) {
562 /* handle requests/control events coming in over the channel */
563 static void process_event(void *opaque
, QObject
*obj
, Error
*err
)
569 g_debug("process_event: called");
570 assert(!obj
!= !err
);
572 rsp
= qmp_error_response(err
);
576 g_debug("processing command");
577 rsp
= qmp_dispatch(&ga_commands
, obj
, false);
580 ret
= send_response(s
, rsp
);
582 g_warning("error sending error response: %s", strerror(-ret
));
588 /* false return signals GAChannel to close the current client connection */
589 static gboolean
channel_event_cb(GIOCondition condition
, gpointer data
)
592 gchar buf
[QGA_READ_COUNT_DEFAULT
+1];
594 GIOStatus status
= ga_channel_read(s
->channel
, buf
, QGA_READ_COUNT_DEFAULT
, &count
);
596 case G_IO_STATUS_ERROR
:
597 g_warning("error reading channel");
598 stop_agent(s
, false);
600 case G_IO_STATUS_NORMAL
:
602 g_debug("read data, count: %d, data: %s", (int)count
, buf
);
603 json_message_parser_feed(&s
->parser
, (char *)buf
, (int)count
);
605 case G_IO_STATUS_EOF
:
606 g_debug("received EOF");
611 case G_IO_STATUS_AGAIN
:
612 /* virtio causes us to spin here when no process is attached to
613 * host-side chardev. sleep a bit to mitigate this
620 g_warning("unknown channel read status, closing");
626 static gboolean
channel_init(GAState
*s
, const gchar
*method
, const gchar
*path
,
629 GAChannelMethod channel_method
;
631 if (strcmp(method
, "virtio-serial") == 0) {
632 s
->virtio
= true; /* virtio requires special handling in some cases */
633 channel_method
= GA_CHANNEL_VIRTIO_SERIAL
;
634 } else if (strcmp(method
, "isa-serial") == 0) {
635 channel_method
= GA_CHANNEL_ISA_SERIAL
;
636 } else if (strcmp(method
, "unix-listen") == 0) {
637 channel_method
= GA_CHANNEL_UNIX_LISTEN
;
638 } else if (strcmp(method
, "vsock-listen") == 0) {
639 channel_method
= GA_CHANNEL_VSOCK_LISTEN
;
641 g_critical("unsupported channel method/type: %s", method
);
645 s
->channel
= ga_channel_new(channel_method
, path
, listen_fd
,
646 channel_event_cb
, s
);
648 g_critical("failed to create guest agent channel");
656 DWORD WINAPI
handle_serial_device_events(DWORD type
, LPVOID data
)
658 DWORD ret
= NO_ERROR
;
659 PDEV_BROADCAST_HDR broadcast_header
= (PDEV_BROADCAST_HDR
)data
;
661 if (broadcast_header
->dbch_devicetype
== DBT_DEVTYP_DEVICEINTERFACE
) {
663 /* Device inserted */
664 case DBT_DEVICEARRIVAL
:
665 /* Start QEMU-ga's service */
666 if (!SetEvent(ga_state
->wakeup_event
)) {
667 ret
= GetLastError();
671 case DBT_DEVICEQUERYREMOVE
:
672 case DBT_DEVICEREMOVEPENDING
:
673 case DBT_DEVICEREMOVECOMPLETE
:
674 /* Stop QEMU-ga's service */
675 if (!ResetEvent(ga_state
->wakeup_event
)) {
676 ret
= GetLastError();
680 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
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 SetEvent(ga_state
->wakeup_event
);
698 service
->status
.dwCurrentState
= SERVICE_STOP_PENDING
;
699 SetServiceStatus(service
->status_handle
, &service
->status
);
701 case SERVICE_CONTROL_DEVICEEVENT
:
702 handle_serial_device_events(type
, data
);
706 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
711 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[])
713 GAService
*service
= &ga_state
->service
;
715 service
->status_handle
= RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME
,
716 service_ctrl_handler
, NULL
);
718 if (service
->status_handle
== 0) {
719 g_critical("Failed to register extended requests function!\n");
723 service
->status
.dwServiceType
= SERVICE_WIN32
;
724 service
->status
.dwCurrentState
= SERVICE_RUNNING
;
725 service
->status
.dwControlsAccepted
= SERVICE_ACCEPT_STOP
| SERVICE_ACCEPT_SHUTDOWN
;
726 service
->status
.dwWin32ExitCode
= NO_ERROR
;
727 service
->status
.dwServiceSpecificExitCode
= NO_ERROR
;
728 service
->status
.dwCheckPoint
= 0;
729 service
->status
.dwWaitHint
= 0;
730 DEV_BROADCAST_DEVICEINTERFACE notification_filter
;
731 ZeroMemory(¬ification_filter
, sizeof(notification_filter
));
732 notification_filter
.dbcc_devicetype
= DBT_DEVTYP_DEVICEINTERFACE
;
733 notification_filter
.dbcc_size
= sizeof(DEV_BROADCAST_DEVICEINTERFACE
);
734 notification_filter
.dbcc_classguid
= GUID_VIOSERIAL_PORT
;
736 service
->device_notification_handle
=
737 RegisterDeviceNotification(service
->status_handle
,
738 ¬ification_filter
, DEVICE_NOTIFY_SERVICE_HANDLE
);
739 if (!service
->device_notification_handle
) {
740 g_critical("Failed to register device notification handle!\n");
743 SetServiceStatus(service
->status_handle
, &service
->status
);
747 UnregisterDeviceNotification(service
->device_notification_handle
);
748 service
->status
.dwCurrentState
= SERVICE_STOPPED
;
749 SetServiceStatus(service
->status_handle
, &service
->status
);
753 static void set_persistent_state_defaults(GAPersistentState
*pstate
)
756 pstate
->fd_counter
= QGA_PSTATE_DEFAULT_FD_COUNTER
;
759 static void persistent_state_from_keyfile(GAPersistentState
*pstate
,
764 /* if any fields are missing, either because the file was tampered with
765 * by agents of chaos, or because the field wasn't present at the time the
766 * file was created, the best we can ever do is start over with the default
767 * values. so load them now, and ignore any errors in accessing key-value
770 set_persistent_state_defaults(pstate
);
772 if (g_key_file_has_key(keyfile
, "global", "fd_counter", NULL
)) {
774 g_key_file_get_integer(keyfile
, "global", "fd_counter", NULL
);
778 static void persistent_state_to_keyfile(const GAPersistentState
*pstate
,
784 g_key_file_set_integer(keyfile
, "global", "fd_counter", pstate
->fd_counter
);
787 static gboolean
write_persistent_state(const GAPersistentState
*pstate
,
790 GKeyFile
*keyfile
= g_key_file_new();
798 persistent_state_to_keyfile(pstate
, keyfile
);
799 data
= g_key_file_to_data(keyfile
, &data_len
, &gerr
);
801 g_critical("failed to convert persistent state to string: %s",
807 g_file_set_contents(path
, data
, data_len
, &gerr
);
809 g_critical("failed to write persistent state to %s: %s",
810 path
, gerr
->message
);
820 g_key_file_free(keyfile
);
826 static gboolean
read_persistent_state(GAPersistentState
*pstate
,
827 const gchar
*path
, gboolean frozen
)
829 GKeyFile
*keyfile
= NULL
;
836 if (stat(path
, &st
) == -1) {
837 /* it's okay if state file doesn't exist, but any other error
838 * indicates a permissions issue or some other misconfiguration
839 * that we likely won't be able to recover from.
841 if (errno
!= ENOENT
) {
842 g_critical("unable to access state file at path %s: %s",
843 path
, strerror(errno
));
848 /* file doesn't exist. initialize state to default values and
849 * attempt to save now. (we could wait till later when we have
850 * modified state we need to commit, but if there's a problem,
851 * such as a missing parent directory, we want to catch it now)
853 * there is a potential scenario where someone either managed to
854 * update the agent from a version that didn't use a key store
855 * while qemu-ga thought the filesystem was frozen, or
856 * deleted the key store prior to issuing a fsfreeze, prior
857 * to restarting the agent. in this case we go ahead and defer
858 * initial creation till we actually have modified state to
859 * write, otherwise fail to recover from freeze.
861 set_persistent_state_defaults(pstate
);
863 ret
= write_persistent_state(pstate
, path
);
865 g_critical("unable to create state file at path %s", path
);
874 keyfile
= g_key_file_new();
875 g_key_file_load_from_file(keyfile
, path
, 0, &gerr
);
877 g_critical("error loading persistent state from path: %s, %s",
878 path
, gerr
->message
);
883 persistent_state_from_keyfile(pstate
, keyfile
);
887 g_key_file_free(keyfile
);
896 int64_t ga_get_fd_handle(GAState
*s
, Error
**errp
)
900 g_assert(s
->pstate_filepath
);
901 /* we blacklist commands and avoid operations that potentially require
902 * writing to disk when we're in a frozen state. this includes opening
903 * new files, so we should never get here in that situation
905 g_assert(!ga_is_frozen(s
));
907 handle
= s
->pstate
.fd_counter
++;
909 /* This should never happen on a reasonable timeframe, as guest-file-open
910 * would have to be issued 2^63 times */
911 if (s
->pstate
.fd_counter
== INT64_MAX
) {
915 if (!write_persistent_state(&s
->pstate
, s
->pstate_filepath
)) {
916 error_setg(errp
, "failed to commit persistent state to disk");
923 static void ga_print_cmd(const QmpCommand
*cmd
, void *opaque
)
925 printf("%s\n", qmp_command_name(cmd
));
928 static GList
*split_list(const gchar
*str
, const gchar
*delim
)
934 strv
= g_strsplit(str
, delim
, -1);
935 for (i
= 0; strv
[i
]; i
++) {
936 list
= g_list_prepend(list
, strv
[i
]);
948 #ifdef CONFIG_FSFREEZE
955 gchar
*bliststr
; /* blacklist may point to this string */
958 GLogLevelFlags log_level
;
963 static void config_load(GAConfig
*config
)
967 const char *conf
= g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT
;
969 /* read system config */
970 keyfile
= g_key_file_new();
971 if (!g_key_file_load_from_file(keyfile
, conf
, 0, &gerr
)) {
974 if (g_key_file_has_key(keyfile
, "general", "daemon", NULL
)) {
976 g_key_file_get_boolean(keyfile
, "general", "daemon", &gerr
);
978 if (g_key_file_has_key(keyfile
, "general", "method", NULL
)) {
980 g_key_file_get_string(keyfile
, "general", "method", &gerr
);
982 if (g_key_file_has_key(keyfile
, "general", "path", NULL
)) {
983 config
->channel_path
=
984 g_key_file_get_string(keyfile
, "general", "path", &gerr
);
986 if (g_key_file_has_key(keyfile
, "general", "logfile", NULL
)) {
987 config
->log_filepath
=
988 g_key_file_get_string(keyfile
, "general", "logfile", &gerr
);
990 if (g_key_file_has_key(keyfile
, "general", "pidfile", NULL
)) {
991 config
->pid_filepath
=
992 g_key_file_get_string(keyfile
, "general", "pidfile", &gerr
);
994 #ifdef CONFIG_FSFREEZE
995 if (g_key_file_has_key(keyfile
, "general", "fsfreeze-hook", NULL
)) {
996 config
->fsfreeze_hook
=
997 g_key_file_get_string(keyfile
,
998 "general", "fsfreeze-hook", &gerr
);
1001 if (g_key_file_has_key(keyfile
, "general", "statedir", NULL
)) {
1003 g_key_file_get_string(keyfile
, "general", "statedir", &gerr
);
1005 if (g_key_file_has_key(keyfile
, "general", "verbose", NULL
) &&
1006 g_key_file_get_boolean(keyfile
, "general", "verbose", &gerr
)) {
1007 /* enable all log levels */
1008 config
->log_level
= G_LOG_LEVEL_MASK
;
1010 if (g_key_file_has_key(keyfile
, "general", "retry-path", NULL
)) {
1011 config
->retry_path
=
1012 g_key_file_get_boolean(keyfile
, "general", "retry-path", &gerr
);
1014 if (g_key_file_has_key(keyfile
, "general", "blacklist", NULL
)) {
1016 g_key_file_get_string(keyfile
, "general", "blacklist", &gerr
);
1017 config
->blacklist
= g_list_concat(config
->blacklist
,
1018 split_list(config
->bliststr
, ","));
1022 g_key_file_free(keyfile
);
1024 !(gerr
->domain
== G_FILE_ERROR
&& gerr
->code
== G_FILE_ERROR_NOENT
)) {
1025 g_critical("error loading configuration from path: %s, %s",
1026 QGA_CONF_DEFAULT
, gerr
->message
);
1029 g_clear_error(&gerr
);
1032 static gchar
*list_join(GList
*list
, const gchar separator
)
1034 GString
*str
= g_string_new("");
1037 str
= g_string_append(str
, (gchar
*)list
->data
);
1038 list
= g_list_next(list
);
1040 str
= g_string_append_c(str
, separator
);
1044 return g_string_free(str
, FALSE
);
1047 static void config_dump(GAConfig
*config
)
1049 GError
*error
= NULL
;
1053 keyfile
= g_key_file_new();
1056 g_key_file_set_boolean(keyfile
, "general", "daemon", config
->daemonize
);
1057 g_key_file_set_string(keyfile
, "general", "method", config
->method
);
1058 if (config
->channel_path
) {
1059 g_key_file_set_string(keyfile
, "general", "path", config
->channel_path
);
1061 if (config
->log_filepath
) {
1062 g_key_file_set_string(keyfile
, "general", "logfile",
1063 config
->log_filepath
);
1065 g_key_file_set_string(keyfile
, "general", "pidfile", config
->pid_filepath
);
1066 #ifdef CONFIG_FSFREEZE
1067 if (config
->fsfreeze_hook
) {
1068 g_key_file_set_string(keyfile
, "general", "fsfreeze-hook",
1069 config
->fsfreeze_hook
);
1072 g_key_file_set_string(keyfile
, "general", "statedir", config
->state_dir
);
1073 g_key_file_set_boolean(keyfile
, "general", "verbose",
1074 config
->log_level
== G_LOG_LEVEL_MASK
);
1075 g_key_file_set_boolean(keyfile
, "general", "retry-path",
1076 config
->retry_path
);
1077 tmp
= list_join(config
->blacklist
, ',');
1078 g_key_file_set_string(keyfile
, "general", "blacklist", tmp
);
1081 tmp
= g_key_file_to_data(keyfile
, NULL
, &error
);
1083 g_critical("Failed to dump keyfile: %s", error
->message
);
1084 g_clear_error(&error
);
1090 g_key_file_free(keyfile
);
1093 static void config_parse(GAConfig
*config
, int argc
, char **argv
)
1095 const char *sopt
= "hVvdm:p:l:f:F::b:s:t:Dr";
1096 int opt_ind
= 0, ch
;
1097 const struct option lopt
[] = {
1098 { "help", 0, NULL
, 'h' },
1099 { "version", 0, NULL
, 'V' },
1100 { "dump-conf", 0, NULL
, 'D' },
1101 { "logfile", 1, NULL
, 'l' },
1102 { "pidfile", 1, NULL
, 'f' },
1103 #ifdef CONFIG_FSFREEZE
1104 { "fsfreeze-hook", 2, NULL
, 'F' },
1106 { "verbose", 0, NULL
, 'v' },
1107 { "method", 1, NULL
, 'm' },
1108 { "path", 1, NULL
, 'p' },
1109 { "daemonize", 0, NULL
, 'd' },
1110 { "blacklist", 1, NULL
, 'b' },
1112 { "service", 1, NULL
, 's' },
1114 { "statedir", 1, NULL
, 't' },
1115 { "retry-path", 0, NULL
, 'r' },
1116 { NULL
, 0, NULL
, 0 }
1119 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
1122 g_free(config
->method
);
1123 config
->method
= g_strdup(optarg
);
1126 g_free(config
->channel_path
);
1127 config
->channel_path
= g_strdup(optarg
);
1130 g_free(config
->log_filepath
);
1131 config
->log_filepath
= g_strdup(optarg
);
1134 g_free(config
->pid_filepath
);
1135 config
->pid_filepath
= g_strdup(optarg
);
1137 #ifdef CONFIG_FSFREEZE
1139 g_free(config
->fsfreeze_hook
);
1140 config
->fsfreeze_hook
= g_strdup(optarg
?: QGA_FSFREEZE_HOOK_DEFAULT
);
1144 g_free(config
->state_dir
);
1145 config
->state_dir
= g_strdup(optarg
);
1148 /* enable all log levels */
1149 config
->log_level
= G_LOG_LEVEL_MASK
;
1152 printf("QEMU Guest Agent %s\n", QEMU_VERSION
);
1155 config
->daemonize
= 1;
1158 config
->dumpconf
= 1;
1161 config
->retry_path
= true;
1164 if (is_help_option(optarg
)) {
1165 qmp_for_each_command(&ga_commands
, ga_print_cmd
, NULL
);
1168 config
->blacklist
= g_list_concat(config
->blacklist
,
1169 split_list(optarg
, ","));
1174 config
->service
= optarg
;
1175 if (strcmp(config
->service
, "install") == 0) {
1176 if (ga_install_vss_provider()) {
1179 if (ga_install_service(config
->channel_path
,
1180 config
->log_filepath
, config
->state_dir
)) {
1184 } else if (strcmp(config
->service
, "uninstall") == 0) {
1185 ga_uninstall_vss_provider();
1186 exit(ga_uninstall_service());
1187 } else if (strcmp(config
->service
, "vss-install") == 0) {
1188 if (ga_install_vss_provider()) {
1192 } else if (strcmp(config
->service
, "vss-uninstall") == 0) {
1193 ga_uninstall_vss_provider();
1196 printf("Unknown service command.\n");
1205 g_print("Unknown option, try '%s --help' for more information.\n",
1212 static void config_free(GAConfig
*config
)
1214 g_free(config
->method
);
1215 g_free(config
->log_filepath
);
1216 g_free(config
->pid_filepath
);
1217 g_free(config
->state_dir
);
1218 g_free(config
->channel_path
);
1219 g_free(config
->bliststr
);
1220 #ifdef CONFIG_FSFREEZE
1221 g_free(config
->fsfreeze_hook
);
1223 g_list_free_full(config
->blacklist
, g_free
);
1227 static bool check_is_frozen(GAState
*s
)
1230 /* check if a previous instance of qemu-ga exited with filesystems' state
1231 * marked as frozen. this could be a stale value (a non-qemu-ga process
1232 * or reboot may have since unfrozen them), but better to require an
1233 * uneeded unfreeze than to risk hanging on start-up
1236 if (stat(s
->state_filepath_isfrozen
, &st
) == -1) {
1237 /* it's okay if the file doesn't exist, but if we can't access for
1238 * some other reason, such as permissions, there's a configuration
1239 * that needs to be addressed. so just bail now before we get into
1240 * more trouble later
1242 if (errno
!= ENOENT
) {
1243 g_critical("unable to access state file at path %s: %s",
1244 s
->state_filepath_isfrozen
, strerror(errno
));
1245 return EXIT_FAILURE
;
1248 g_warning("previous instance appears to have exited with frozen"
1249 " filesystems. deferring logging/pidfile creation and"
1250 " disabling non-fsfreeze-safe commands until"
1251 " guest-fsfreeze-thaw is issued, or filesystems are"
1252 " manually unfrozen and the file %s is removed",
1253 s
->state_filepath_isfrozen
);
1260 static GAState
*initialize_agent(GAConfig
*config
, int socket_activation
)
1262 GAState
*s
= g_new0(GAState
, 1);
1264 g_assert(ga_state
== NULL
);
1266 s
->log_level
= config
->log_level
;
1267 s
->log_file
= stderr
;
1268 #ifdef CONFIG_FSFREEZE
1269 s
->fsfreeze_hook
= config
->fsfreeze_hook
;
1271 s
->pstate_filepath
= g_strdup_printf("%s/qga.state", config
->state_dir
);
1272 s
->state_filepath_isfrozen
= g_strdup_printf("%s/qga.state.isfrozen",
1274 s
->frozen
= check_is_frozen(s
);
1276 g_log_set_default_handler(ga_log
, s
);
1277 g_log_set_fatal_mask(NULL
, G_LOG_LEVEL_ERROR
);
1278 ga_enable_logging(s
);
1281 /* On win32 the state directory is application specific (be it the default
1282 * or a user override). We got past the command line parsing; let's create
1283 * the directory (with any intermediate directories). If we run into an
1284 * error later on, we won't try to clean up the directory, it is considered
1287 if (g_mkdir_with_parents(config
->state_dir
, S_IRWXU
) == -1) {
1288 g_critical("unable to create (an ancestor of) the state directory"
1289 " '%s': %s", config
->state_dir
, strerror(errno
));
1294 if (ga_is_frozen(s
)) {
1295 if (config
->daemonize
) {
1296 /* delay opening/locking of pidfile till filesystems are unfrozen */
1297 s
->deferred_options
.pid_filepath
= config
->pid_filepath
;
1298 become_daemon(NULL
);
1300 if (config
->log_filepath
) {
1301 /* delay opening the log file till filesystems are unfrozen */
1302 s
->deferred_options
.log_filepath
= config
->log_filepath
;
1304 ga_disable_logging(s
);
1305 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
1307 if (config
->daemonize
) {
1308 become_daemon(config
->pid_filepath
);
1310 if (config
->log_filepath
) {
1311 FILE *log_file
= ga_open_logfile(config
->log_filepath
);
1313 g_critical("unable to open specified log file: %s",
1317 s
->log_file
= log_file
;
1321 /* load persistent state from disk */
1322 if (!read_persistent_state(&s
->pstate
,
1325 g_critical("failed to load persistent state");
1329 config
->blacklist
= ga_command_blacklist_init(config
->blacklist
);
1330 if (config
->blacklist
) {
1331 GList
*l
= config
->blacklist
;
1332 s
->blacklist
= config
->blacklist
;
1334 g_debug("disabling command: %s", (char *)l
->data
);
1335 qmp_disable_command(&ga_commands
, l
->data
);
1339 s
->command_state
= ga_command_state_new();
1340 ga_command_state_init(s
, s
->command_state
);
1341 ga_command_state_init_all(s
->command_state
);
1342 json_message_parser_init(&s
->parser
, process_event
, s
, NULL
);
1345 if (!register_signal_handlers()) {
1346 g_critical("failed to register signal handlers");
1351 s
->main_loop
= g_main_loop_new(NULL
, false);
1354 s
->socket_activation
= socket_activation
;
1357 s
->wakeup_event
= CreateEvent(NULL
, TRUE
, FALSE
, TEXT("WakeUp"));
1358 if (s
->wakeup_event
== NULL
) {
1359 g_critical("CreateEvent failed");
1368 static void cleanup_agent(GAState
*s
)
1371 CloseHandle(s
->wakeup_event
);
1373 if (s
->command_state
) {
1374 ga_command_state_cleanup_all(s
->command_state
);
1375 ga_command_state_free(s
->command_state
);
1376 json_message_parser_destroy(&s
->parser
);
1378 g_free(s
->pstate_filepath
);
1379 g_free(s
->state_filepath_isfrozen
);
1381 g_main_loop_unref(s
->main_loop
);
1387 static int run_agent_once(GAState
*s
)
1389 if (!channel_init(s
, s
->config
->method
, s
->config
->channel_path
,
1390 s
->socket_activation
? FIRST_SOCKET_ACTIVATION_FD
: -1)) {
1391 g_critical("failed to initialize guest agent channel");
1392 return EXIT_FAILURE
;
1395 g_main_loop_run(ga_state
->main_loop
);
1398 ga_channel_free(s
->channel
);
1401 return EXIT_SUCCESS
;
1404 static void wait_for_channel_availability(GAState
*s
)
1406 g_warning("waiting for channel path...");
1408 sleep(QGA_RETRY_INTERVAL
);
1412 dwWaitResult
= WaitForSingleObject(s
->wakeup_event
, INFINITE
);
1414 switch (dwWaitResult
) {
1420 g_critical("WaitForSingleObject failed");
1425 static int run_agent(GAState
*s
)
1427 int ret
= EXIT_SUCCESS
;
1429 s
->force_exit
= false;
1432 ret
= run_agent_once(s
);
1433 if (s
->config
->retry_path
&& !s
->force_exit
) {
1434 g_warning("agent stopped unexpectedly, restarting...");
1435 wait_for_channel_availability(s
);
1437 } while (s
->config
->retry_path
&& !s
->force_exit
);
1442 static void stop_agent(GAState
*s
, bool requested
)
1444 if (!s
->force_exit
) {
1445 s
->force_exit
= requested
;
1448 if (g_main_loop_is_running(s
->main_loop
)) {
1449 g_main_loop_quit(s
->main_loop
);
1453 int main(int argc
, char **argv
)
1455 int ret
= EXIT_SUCCESS
;
1457 GAConfig
*config
= g_new0(GAConfig
, 1);
1458 int socket_activation
;
1460 config
->log_level
= G_LOG_LEVEL_ERROR
| G_LOG_LEVEL_CRITICAL
;
1462 qga_qmp_init_marshal(&ga_commands
);
1464 init_dfl_pathnames();
1465 config_load(config
);
1466 config_parse(config
, argc
, argv
);
1468 if (config
->pid_filepath
== NULL
) {
1469 config
->pid_filepath
= g_strdup(dfl_pathnames
.pidfile
);
1472 if (config
->state_dir
== NULL
) {
1473 config
->state_dir
= g_strdup(dfl_pathnames
.state_dir
);
1476 if (config
->method
== NULL
) {
1477 config
->method
= g_strdup("virtio-serial");
1480 socket_activation
= check_socket_activation();
1481 if (socket_activation
> 1) {
1482 g_critical("qemu-ga only supports listening on one socket");
1486 if (socket_activation
) {
1487 SocketAddress
*addr
;
1489 g_free(config
->method
);
1490 g_free(config
->channel_path
);
1491 config
->method
= NULL
;
1492 config
->channel_path
= NULL
;
1494 addr
= socket_local_address(FIRST_SOCKET_ACTIVATION_FD
, NULL
);
1496 if (addr
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
1497 config
->method
= g_strdup("unix-listen");
1498 } else if (addr
->type
== SOCKET_ADDRESS_TYPE_VSOCK
) {
1499 config
->method
= g_strdup("vsock-listen");
1502 qapi_free_SocketAddress(addr
);
1505 if (!config
->method
) {
1506 g_critical("unsupported listen fd type");
1510 } else if (config
->channel_path
== NULL
) {
1511 if (strcmp(config
->method
, "virtio-serial") == 0) {
1512 /* try the default path for the virtio-serial port */
1513 config
->channel_path
= g_strdup(QGA_VIRTIO_PATH_DEFAULT
);
1514 } else if (strcmp(config
->method
, "isa-serial") == 0) {
1515 /* try the default path for the serial port - COM1 */
1516 config
->channel_path
= g_strdup(QGA_SERIAL_PATH_DEFAULT
);
1518 g_critical("must specify a path for this channel");
1524 if (config
->dumpconf
) {
1525 config_dump(config
);
1529 s
= initialize_agent(config
, socket_activation
);
1531 g_critical("error initializing guest agent");
1536 if (config
->daemonize
) {
1537 SERVICE_TABLE_ENTRY service_table
[] = {
1538 { (char *)QGA_SERVICE_NAME
, service_main
}, { NULL
, NULL
} };
1539 StartServiceCtrlDispatcher(service_table
);
1550 if (config
->daemonize
) {
1551 unlink(config
->pid_filepath
);
1554 config_free(config
);