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/help-texts.h"
22 #include "qapi/qmp/json-parser.h"
23 #include "qapi/qmp/qdict.h"
24 #include "qapi/qmp/qjson.h"
25 #include "guest-agent-core.h"
26 #include "qga-qapi-init-commands.h"
27 #include "qapi/qmp/qerror.h"
28 #include "qapi/error.h"
30 #include "qemu/cutils.h"
31 #include "qemu/help_option.h"
32 #include "qemu/sockets.h"
33 #include "qemu/systemd.h"
34 #include "qemu-version.h"
37 #include "qga/service-win32.h"
38 #include "qga/vss-win32.h"
43 #define CONFIG_FSFREEZE
48 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
49 #define QGA_STATE_RELATIVE_DIR "run"
50 #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0"
52 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
53 #define QGA_STATE_RELATIVE_DIR "qemu-ga"
54 #define QGA_SERIAL_PATH_DEFAULT "COM1"
56 #ifdef CONFIG_FSFREEZE
57 #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook"
59 #define QGA_SENTINEL_BYTE 0xFF
60 #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf"
61 #define QGA_RETRY_INTERVAL 5
64 const char *state_dir
;
68 typedef struct GAPersistentState
{
69 #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000
73 typedef struct GAConfig GAConfig
;
76 JSONMessageParser parser
;
79 bool virtio
; /* fastpath to check for virtio to deal with poll() quirks */
80 GACommandState
*command_state
;
81 GLogLevelFlags log_level
;
88 bool delimit_response
;
91 char *state_filepath_isfrozen
;
93 const char *log_filepath
;
94 const char *pid_filepath
;
96 #ifdef CONFIG_FSFREEZE
97 const char *fsfreeze_hook
;
99 gchar
*pstate_filepath
;
100 GAPersistentState pstate
;
102 int socket_activation
;
106 struct GAState
*ga_state
;
107 QmpCommandList ga_commands
;
109 /* commands that are safe to issue while filesystems are frozen */
110 static const char *ga_freeze_whitelist
[] = {
114 "guest-sync-delimited",
115 "guest-fsfreeze-status",
116 "guest-fsfreeze-thaw",
121 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
123 DWORD WINAPI
handle_serial_device_events(DWORD type
, LPVOID data
);
124 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[]);
126 static int run_agent(GAState
*s
);
127 static void stop_agent(GAState
*s
, bool requested
);
130 init_dfl_pathnames(void)
132 g_autofree
char *state
= qemu_get_local_state_dir();
134 g_assert(dfl_pathnames
.state_dir
== NULL
);
135 g_assert(dfl_pathnames
.pidfile
== NULL
);
136 dfl_pathnames
.state_dir
= g_build_filename(state
, QGA_STATE_RELATIVE_DIR
, NULL
);
137 dfl_pathnames
.pidfile
= g_build_filename(state
, QGA_STATE_RELATIVE_DIR
, "qemu-ga.pid", NULL
);
140 static void quit_handler(int sig
)
142 /* if we're frozen, don't exit unless we're absolutely forced to,
143 * because it's basically impossible for graceful exit to complete
144 * unless all log/pid files are on unfreezable filesystems. there's
145 * also a very likely chance killing the agent before unfreezing
146 * the filesystems is a mistake (or will be viewed as one later).
147 * On Windows the freeze interval is limited to 10 seconds, so
148 * we should quit, but first we should wait for the timeout, thaw
149 * the filesystem and quit.
151 if (ga_is_frozen(ga_state
)) {
155 HANDLE hEventTimeout
;
157 g_debug("Thawing filesystems before exiting");
159 hEventTimeout
= OpenEvent(EVENT_ALL_ACCESS
, FALSE
, EVENT_NAME_TIMEOUT
);
161 WaitForSingleObject(hEventTimeout
, 0);
162 CloseHandle(hEventTimeout
);
164 qga_vss_fsfreeze(&i
, false, NULL
, &err
);
166 g_debug("Error unfreezing filesystems prior to exiting: %s",
167 error_get_pretty(err
));
174 g_debug("received signal num %d, quitting", sig
);
176 stop_agent(ga_state
, true);
180 static gboolean
register_signal_handlers(void)
182 struct sigaction sigact
;
185 memset(&sigact
, 0, sizeof(struct sigaction
));
186 sigact
.sa_handler
= quit_handler
;
188 ret
= sigaction(SIGINT
, &sigact
, NULL
);
190 g_error("error configuring signal handler: %s", strerror(errno
));
192 ret
= sigaction(SIGTERM
, &sigact
, NULL
);
194 g_error("error configuring signal handler: %s", strerror(errno
));
197 sigact
.sa_handler
= SIG_IGN
;
198 if (sigaction(SIGPIPE
, &sigact
, NULL
) != 0) {
199 g_error("error configuring SIGPIPE signal handler: %s",
206 /* TODO: use this in place of all post-fork() fclose(std*) callers */
207 void reopen_fd_to_null(int fd
)
211 nullfd
= open("/dev/null", O_RDWR
);
224 static void usage(const char *cmd
)
226 #ifdef CONFIG_FSFREEZE
227 g_autofree
char *fsfreeze_hook
= get_relocated_path(QGA_FSFREEZE_HOOK_DEFAULT
);
231 "Usage: %s [-m <method> -p <path>] [<options>]\n"
232 "QEMU Guest Agent " QEMU_FULL_VERSION
"\n"
235 " -m, --method transport method: one of unix-listen, virtio-serial,\n"
236 " isa-serial, or vsock-listen (virtio-serial is the default)\n"
237 " -p, --path device/socket path (the default for virtio-serial is:\n"
239 " the default for isa-serial is:\n"
241 " Socket addresses for vsock-listen are written as\n"
243 " -l, --logfile set logfile path, logs to stderr by default\n"
244 " -f, --pidfile specify pidfile (default is %s)\n"
245 #ifdef CONFIG_FSFREEZE
246 " -F, --fsfreeze-hook\n"
247 " enable fsfreeze hook. Accepts an optional argument that\n"
248 " specifies script to run on freeze/thaw. Script will be\n"
249 " called with 'freeze'/'thaw' arguments accordingly.\n"
251 " If using -F with an argument, do not follow -F with a\n"
253 " (for example: -F/var/run/fsfreezehook.sh)\n"
255 " -t, --statedir specify dir to store state information (absolute paths\n"
256 " only, default is %s)\n"
257 " -v, --verbose log extra debugging information\n"
258 " -V, --version print version information and exit\n"
259 " -d, --daemonize become a daemon\n"
261 " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n"
263 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
264 " to list available RPCs)\n"
265 " -D, --dump-conf dump a qemu-ga config file based on current config\n"
266 " options / command-line parameters to stdout\n"
267 " -r, --retry-path attempt re-opening path if it's unavailable or closed\n"
268 " due to an error which may be recoverable in the future\n"
269 " (virtio-serial driver re-install, serial device hot\n"
270 " plug/unplug, etc.)\n"
271 " -h, --help display this help and exit\n"
273 QEMU_HELP_BOTTOM
"\n"
274 , cmd
, QGA_VIRTIO_PATH_DEFAULT
, QGA_SERIAL_PATH_DEFAULT
,
275 dfl_pathnames
.pidfile
,
276 #ifdef CONFIG_FSFREEZE
279 dfl_pathnames
.state_dir
);
282 static const char *ga_log_level_str(GLogLevelFlags level
)
284 switch (level
& G_LOG_LEVEL_MASK
) {
285 case G_LOG_LEVEL_ERROR
:
287 case G_LOG_LEVEL_CRITICAL
:
289 case G_LOG_LEVEL_WARNING
:
291 case G_LOG_LEVEL_MESSAGE
:
293 case G_LOG_LEVEL_INFO
:
295 case G_LOG_LEVEL_DEBUG
:
302 bool ga_logging_enabled(GAState
*s
)
304 return s
->logging_enabled
;
307 void ga_disable_logging(GAState
*s
)
309 s
->logging_enabled
= false;
312 void ga_enable_logging(GAState
*s
)
314 s
->logging_enabled
= true;
317 static void ga_log(const gchar
*domain
, GLogLevelFlags level
,
318 const gchar
*msg
, gpointer opaque
)
321 const char *level_str
= ga_log_level_str(level
);
323 if (!ga_logging_enabled(s
)) {
327 level
&= G_LOG_LEVEL_MASK
;
329 if (g_strcmp0(domain
, "syslog") == 0) {
330 syslog(LOG_INFO
, "%s: %s", level_str
, msg
);
331 } else if (level
& s
->log_level
) {
333 if (level
& s
->log_level
) {
335 g_autoptr(GDateTime
) now
= g_date_time_new_now_utc();
336 g_autofree
char *nowstr
= g_date_time_format(now
, "%s.%f");
337 fprintf(s
->log_file
, "%s: %s: %s\n", nowstr
, level_str
, msg
);
342 void ga_set_response_delimited(GAState
*s
)
344 s
->delimit_response
= true;
347 static FILE *ga_open_logfile(const char *logfile
)
351 f
= fopen(logfile
, "a");
356 qemu_set_cloexec(fileno(f
));
360 static gint
ga_strcmp(gconstpointer str1
, gconstpointer str2
)
362 return strcmp(str1
, str2
);
365 /* disable commands that aren't safe for fsfreeze */
366 static void ga_disable_non_whitelisted(const QmpCommand
*cmd
, void *opaque
)
368 bool whitelisted
= false;
370 const char *name
= qmp_command_name(cmd
);
372 while (ga_freeze_whitelist
[i
] != NULL
) {
373 if (strcmp(name
, ga_freeze_whitelist
[i
]) == 0) {
379 g_debug("disabling command: %s", name
);
380 qmp_disable_command(&ga_commands
, name
, "the agent is in frozen state");
384 /* [re-]enable all commands, except those explicitly blacklisted by user */
385 static void ga_enable_non_blacklisted(const QmpCommand
*cmd
, void *opaque
)
387 GList
*blacklist
= opaque
;
388 const char *name
= qmp_command_name(cmd
);
390 if (g_list_find_custom(blacklist
, name
, ga_strcmp
) == NULL
&&
391 !qmp_command_is_enabled(cmd
)) {
392 g_debug("enabling command: %s", name
);
393 qmp_enable_command(&ga_commands
, name
);
397 static bool ga_create_file(const char *path
)
399 int fd
= open(path
, O_CREAT
| O_WRONLY
, S_IWUSR
| S_IRUSR
);
401 g_warning("unable to open/create file %s: %s", path
, strerror(errno
));
408 static bool ga_delete_file(const char *path
)
410 int ret
= unlink(path
);
412 g_warning("unable to delete file: %s: %s", path
, strerror(errno
));
419 bool ga_is_frozen(GAState
*s
)
424 void ga_set_frozen(GAState
*s
)
426 if (ga_is_frozen(s
)) {
429 /* disable all non-whitelisted (for frozen state) commands */
430 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
431 g_warning("disabling logging due to filesystem freeze");
432 ga_disable_logging(s
);
434 if (!ga_create_file(s
->state_filepath_isfrozen
)) {
435 g_warning("unable to create %s, fsfreeze may not function properly",
436 s
->state_filepath_isfrozen
);
440 void ga_unset_frozen(GAState
*s
)
442 if (!ga_is_frozen(s
)) {
446 /* if we delayed creation/opening of pid/log files due to being
447 * in a frozen state at start up, do it now
449 if (s
->deferred_options
.log_filepath
) {
450 s
->log_file
= ga_open_logfile(s
->deferred_options
.log_filepath
);
452 s
->log_file
= stderr
;
454 s
->deferred_options
.log_filepath
= NULL
;
456 ga_enable_logging(s
);
457 g_warning("logging re-enabled due to filesystem unfreeze");
458 if (s
->deferred_options
.pid_filepath
) {
461 if (!qemu_write_pidfile(s
->deferred_options
.pid_filepath
, &err
)) {
462 g_warning("%s", error_get_pretty(err
));
465 s
->deferred_options
.pid_filepath
= NULL
;
468 /* enable all disabled, non-blacklisted commands */
469 qmp_for_each_command(&ga_commands
, ga_enable_non_blacklisted
, s
->blacklist
);
471 if (!ga_delete_file(s
->state_filepath_isfrozen
)) {
472 g_warning("unable to delete %s, fsfreeze may not function properly",
473 s
->state_filepath_isfrozen
);
477 #ifdef CONFIG_FSFREEZE
478 const char *ga_fsfreeze_hook(GAState
*s
)
480 return s
->fsfreeze_hook
;
484 static void become_daemon(const char *pidfile
)
500 if (!qemu_write_pidfile(pidfile
, &err
)) {
501 g_critical("%s", error_get_pretty(err
));
507 umask(S_IRWXG
| S_IRWXO
);
512 if ((chdir("/")) < 0) {
516 reopen_fd_to_null(STDIN_FILENO
);
517 reopen_fd_to_null(STDOUT_FILENO
);
518 reopen_fd_to_null(STDERR_FILENO
);
525 g_critical("failed to daemonize");
530 static int send_response(GAState
*s
, const QDict
*rsp
)
535 g_assert(s
->channel
);
541 response
= qobject_to_json(QOBJECT(rsp
));
546 if (s
->delimit_response
) {
547 s
->delimit_response
= false;
548 g_string_prepend_c(response
, QGA_SENTINEL_BYTE
);
551 g_string_append_c(response
, '\n');
552 status
= ga_channel_write_all(s
->channel
, response
->str
, response
->len
);
553 g_string_free(response
, true);
554 if (status
!= G_IO_STATUS_NORMAL
) {
561 /* handle requests/control events coming in over the channel */
562 static void process_event(void *opaque
, QObject
*obj
, Error
*err
)
568 g_debug("process_event: called");
569 assert(!obj
!= !err
);
571 rsp
= qmp_error_response(err
);
575 g_debug("processing command");
576 rsp
= qmp_dispatch(&ga_commands
, obj
, false, NULL
);
579 ret
= send_response(s
, rsp
);
581 g_warning("error sending error response: %s", strerror(-ret
));
587 /* false return signals GAChannel to close the current client connection */
588 static gboolean
channel_event_cb(GIOCondition condition
, gpointer data
)
591 gchar buf
[QGA_READ_COUNT_DEFAULT
+ 1];
593 GIOStatus status
= ga_channel_read(s
->channel
, buf
, QGA_READ_COUNT_DEFAULT
, &count
);
595 case G_IO_STATUS_ERROR
:
596 g_warning("error reading channel");
597 stop_agent(s
, false);
599 case G_IO_STATUS_NORMAL
:
601 g_debug("read data, count: %d, data: %s", (int)count
, buf
);
602 json_message_parser_feed(&s
->parser
, (char *)buf
, (int)count
);
604 case G_IO_STATUS_EOF
:
605 g_debug("received EOF");
610 case G_IO_STATUS_AGAIN
:
611 /* virtio causes us to spin here when no process is attached to
612 * host-side chardev. sleep a bit to mitigate this
615 g_usleep(G_USEC_PER_SEC
/ 10);
619 g_warning("unknown channel read status, closing");
625 static gboolean
channel_init(GAState
*s
, const gchar
*method
, const gchar
*path
,
628 GAChannelMethod channel_method
;
630 if (strcmp(method
, "virtio-serial") == 0) {
631 s
->virtio
= true; /* virtio requires special handling in some cases */
632 channel_method
= GA_CHANNEL_VIRTIO_SERIAL
;
633 } else if (strcmp(method
, "isa-serial") == 0) {
634 channel_method
= GA_CHANNEL_ISA_SERIAL
;
635 } else if (strcmp(method
, "unix-listen") == 0) {
636 channel_method
= GA_CHANNEL_UNIX_LISTEN
;
637 } else if (strcmp(method
, "vsock-listen") == 0) {
638 channel_method
= GA_CHANNEL_VSOCK_LISTEN
;
640 g_critical("unsupported channel method/type: %s", method
);
644 s
->channel
= ga_channel_new(channel_method
, path
, listen_fd
,
645 channel_event_cb
, s
);
647 g_critical("failed to create guest agent channel");
655 DWORD WINAPI
handle_serial_device_events(DWORD type
, LPVOID data
)
657 DWORD ret
= NO_ERROR
;
658 PDEV_BROADCAST_HDR broadcast_header
= (PDEV_BROADCAST_HDR
)data
;
660 if (broadcast_header
->dbch_devicetype
== DBT_DEVTYP_DEVICEINTERFACE
) {
662 /* Device inserted */
663 case DBT_DEVICEARRIVAL
:
664 /* Start QEMU-ga's service */
665 if (!SetEvent(ga_state
->wakeup_event
)) {
666 ret
= GetLastError();
670 case DBT_DEVICEQUERYREMOVE
:
671 case DBT_DEVICEREMOVEPENDING
:
672 case DBT_DEVICEREMOVECOMPLETE
:
673 /* Stop QEMU-ga's service */
674 if (!ResetEvent(ga_state
->wakeup_event
)) {
675 ret
= GetLastError();
679 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
685 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
688 DWORD ret
= NO_ERROR
;
689 GAService
*service
= &ga_state
->service
;
692 case SERVICE_CONTROL_STOP
:
693 case SERVICE_CONTROL_SHUTDOWN
:
694 quit_handler(SIGTERM
);
695 SetEvent(ga_state
->wakeup_event
);
696 service
->status
.dwCurrentState
= SERVICE_STOP_PENDING
;
697 SetServiceStatus(service
->status_handle
, &service
->status
);
699 case SERVICE_CONTROL_DEVICEEVENT
:
700 handle_serial_device_events(type
, data
);
704 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
709 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[])
711 GAService
*service
= &ga_state
->service
;
713 service
->status_handle
= RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME
,
714 service_ctrl_handler
, NULL
);
716 if (service
->status_handle
== 0) {
717 g_critical("Failed to register extended requests function!\n");
721 service
->status
.dwServiceType
= SERVICE_WIN32
;
722 service
->status
.dwCurrentState
= SERVICE_RUNNING
;
723 service
->status
.dwControlsAccepted
= SERVICE_ACCEPT_STOP
| SERVICE_ACCEPT_SHUTDOWN
;
724 service
->status
.dwWin32ExitCode
= NO_ERROR
;
725 service
->status
.dwServiceSpecificExitCode
= NO_ERROR
;
726 service
->status
.dwCheckPoint
= 0;
727 service
->status
.dwWaitHint
= 0;
728 DEV_BROADCAST_DEVICEINTERFACE notification_filter
;
729 ZeroMemory(¬ification_filter
, sizeof(notification_filter
));
730 notification_filter
.dbcc_devicetype
= DBT_DEVTYP_DEVICEINTERFACE
;
731 notification_filter
.dbcc_size
= sizeof(DEV_BROADCAST_DEVICEINTERFACE
);
732 notification_filter
.dbcc_classguid
= GUID_VIOSERIAL_PORT
;
734 service
->device_notification_handle
=
735 RegisterDeviceNotification(service
->status_handle
,
736 ¬ification_filter
, DEVICE_NOTIFY_SERVICE_HANDLE
);
737 if (!service
->device_notification_handle
) {
738 g_critical("Failed to register device notification handle!\n");
741 SetServiceStatus(service
->status_handle
, &service
->status
);
745 UnregisterDeviceNotification(service
->device_notification_handle
);
746 service
->status
.dwCurrentState
= SERVICE_STOPPED
;
747 SetServiceStatus(service
->status_handle
, &service
->status
);
751 static void set_persistent_state_defaults(GAPersistentState
*pstate
)
754 pstate
->fd_counter
= QGA_PSTATE_DEFAULT_FD_COUNTER
;
757 static void persistent_state_from_keyfile(GAPersistentState
*pstate
,
762 /* if any fields are missing, either because the file was tampered with
763 * by agents of chaos, or because the field wasn't present at the time the
764 * file was created, the best we can ever do is start over with the default
765 * values. so load them now, and ignore any errors in accessing key-value
768 set_persistent_state_defaults(pstate
);
770 if (g_key_file_has_key(keyfile
, "global", "fd_counter", NULL
)) {
772 g_key_file_get_integer(keyfile
, "global", "fd_counter", NULL
);
776 static void persistent_state_to_keyfile(const GAPersistentState
*pstate
,
782 g_key_file_set_integer(keyfile
, "global", "fd_counter", pstate
->fd_counter
);
785 static gboolean
write_persistent_state(const GAPersistentState
*pstate
,
788 GKeyFile
*keyfile
= g_key_file_new();
796 persistent_state_to_keyfile(pstate
, keyfile
);
797 data
= g_key_file_to_data(keyfile
, &data_len
, &gerr
);
799 g_critical("failed to convert persistent state to string: %s",
805 g_file_set_contents(path
, data
, data_len
, &gerr
);
807 g_critical("failed to write persistent state to %s: %s",
808 path
, gerr
->message
);
818 g_key_file_free(keyfile
);
824 static gboolean
read_persistent_state(GAPersistentState
*pstate
,
825 const gchar
*path
, gboolean frozen
)
827 GKeyFile
*keyfile
= NULL
;
834 if (stat(path
, &st
) == -1) {
835 /* it's okay if state file doesn't exist, but any other error
836 * indicates a permissions issue or some other misconfiguration
837 * that we likely won't be able to recover from.
839 if (errno
!= ENOENT
) {
840 g_critical("unable to access state file at path %s: %s",
841 path
, strerror(errno
));
846 /* file doesn't exist. initialize state to default values and
847 * attempt to save now. (we could wait till later when we have
848 * modified state we need to commit, but if there's a problem,
849 * such as a missing parent directory, we want to catch it now)
851 * there is a potential scenario where someone either managed to
852 * update the agent from a version that didn't use a key store
853 * while qemu-ga thought the filesystem was frozen, or
854 * deleted the key store prior to issuing a fsfreeze, prior
855 * to restarting the agent. in this case we go ahead and defer
856 * initial creation till we actually have modified state to
857 * write, otherwise fail to recover from freeze.
859 set_persistent_state_defaults(pstate
);
861 ret
= write_persistent_state(pstate
, path
);
863 g_critical("unable to create state file at path %s", path
);
872 keyfile
= g_key_file_new();
873 g_key_file_load_from_file(keyfile
, path
, 0, &gerr
);
875 g_critical("error loading persistent state from path: %s, %s",
876 path
, gerr
->message
);
881 persistent_state_from_keyfile(pstate
, keyfile
);
885 g_key_file_free(keyfile
);
894 int64_t ga_get_fd_handle(GAState
*s
, Error
**errp
)
898 g_assert(s
->pstate_filepath
);
899 /* we blacklist commands and avoid operations that potentially require
900 * writing to disk when we're in a frozen state. this includes opening
901 * new files, so we should never get here in that situation
903 g_assert(!ga_is_frozen(s
));
905 handle
= s
->pstate
.fd_counter
++;
907 /* This should never happen on a reasonable timeframe, as guest-file-open
908 * would have to be issued 2^63 times */
909 if (s
->pstate
.fd_counter
== INT64_MAX
) {
913 if (!write_persistent_state(&s
->pstate
, s
->pstate_filepath
)) {
914 error_setg(errp
, "failed to commit persistent state to disk");
921 static void ga_print_cmd(const QmpCommand
*cmd
, void *opaque
)
923 printf("%s\n", qmp_command_name(cmd
));
926 static GList
*split_list(const gchar
*str
, const gchar
*delim
)
932 strv
= g_strsplit(str
, delim
, -1);
933 for (i
= 0; strv
[i
]; i
++) {
934 list
= g_list_prepend(list
, strv
[i
]);
946 #ifdef CONFIG_FSFREEZE
953 gchar
*bliststr
; /* blacklist may point to this string */
956 GLogLevelFlags log_level
;
961 static void config_load(GAConfig
*config
)
965 g_autofree
char *conf
= g_strdup(g_getenv("QGA_CONF")) ?: get_relocated_path(QGA_CONF_DEFAULT
);
967 /* read system config */
968 keyfile
= g_key_file_new();
969 if (!g_key_file_load_from_file(keyfile
, conf
, 0, &gerr
)) {
972 if (g_key_file_has_key(keyfile
, "general", "daemon", NULL
)) {
974 g_key_file_get_boolean(keyfile
, "general", "daemon", &gerr
);
976 if (g_key_file_has_key(keyfile
, "general", "method", NULL
)) {
978 g_key_file_get_string(keyfile
, "general", "method", &gerr
);
980 if (g_key_file_has_key(keyfile
, "general", "path", NULL
)) {
981 config
->channel_path
=
982 g_key_file_get_string(keyfile
, "general", "path", &gerr
);
984 if (g_key_file_has_key(keyfile
, "general", "logfile", NULL
)) {
985 config
->log_filepath
=
986 g_key_file_get_string(keyfile
, "general", "logfile", &gerr
);
988 if (g_key_file_has_key(keyfile
, "general", "pidfile", NULL
)) {
989 config
->pid_filepath
=
990 g_key_file_get_string(keyfile
, "general", "pidfile", &gerr
);
992 #ifdef CONFIG_FSFREEZE
993 if (g_key_file_has_key(keyfile
, "general", "fsfreeze-hook", NULL
)) {
994 config
->fsfreeze_hook
=
995 g_key_file_get_string(keyfile
,
996 "general", "fsfreeze-hook", &gerr
);
999 if (g_key_file_has_key(keyfile
, "general", "statedir", NULL
)) {
1001 g_key_file_get_string(keyfile
, "general", "statedir", &gerr
);
1003 if (g_key_file_has_key(keyfile
, "general", "verbose", NULL
) &&
1004 g_key_file_get_boolean(keyfile
, "general", "verbose", &gerr
)) {
1005 /* enable all log levels */
1006 config
->log_level
= G_LOG_LEVEL_MASK
;
1008 if (g_key_file_has_key(keyfile
, "general", "retry-path", NULL
)) {
1009 config
->retry_path
=
1010 g_key_file_get_boolean(keyfile
, "general", "retry-path", &gerr
);
1012 if (g_key_file_has_key(keyfile
, "general", "blacklist", NULL
)) {
1014 g_key_file_get_string(keyfile
, "general", "blacklist", &gerr
);
1015 config
->blacklist
= g_list_concat(config
->blacklist
,
1016 split_list(config
->bliststr
, ","));
1020 g_key_file_free(keyfile
);
1022 !(gerr
->domain
== G_FILE_ERROR
&& gerr
->code
== G_FILE_ERROR_NOENT
)) {
1023 g_critical("error loading configuration from path: %s, %s",
1024 conf
, gerr
->message
);
1027 g_clear_error(&gerr
);
1030 static gchar
*list_join(GList
*list
, const gchar separator
)
1032 GString
*str
= g_string_new("");
1035 str
= g_string_append(str
, (gchar
*)list
->data
);
1036 list
= g_list_next(list
);
1038 str
= g_string_append_c(str
, separator
);
1042 return g_string_free(str
, FALSE
);
1045 static void config_dump(GAConfig
*config
)
1047 GError
*error
= NULL
;
1051 keyfile
= g_key_file_new();
1054 g_key_file_set_boolean(keyfile
, "general", "daemon", config
->daemonize
);
1055 g_key_file_set_string(keyfile
, "general", "method", config
->method
);
1056 if (config
->channel_path
) {
1057 g_key_file_set_string(keyfile
, "general", "path", config
->channel_path
);
1059 if (config
->log_filepath
) {
1060 g_key_file_set_string(keyfile
, "general", "logfile",
1061 config
->log_filepath
);
1063 g_key_file_set_string(keyfile
, "general", "pidfile", config
->pid_filepath
);
1064 #ifdef CONFIG_FSFREEZE
1065 if (config
->fsfreeze_hook
) {
1066 g_key_file_set_string(keyfile
, "general", "fsfreeze-hook",
1067 config
->fsfreeze_hook
);
1070 g_key_file_set_string(keyfile
, "general", "statedir", config
->state_dir
);
1071 g_key_file_set_boolean(keyfile
, "general", "verbose",
1072 config
->log_level
== G_LOG_LEVEL_MASK
);
1073 g_key_file_set_boolean(keyfile
, "general", "retry-path",
1074 config
->retry_path
);
1075 tmp
= list_join(config
->blacklist
, ',');
1076 g_key_file_set_string(keyfile
, "general", "blacklist", tmp
);
1079 tmp
= g_key_file_to_data(keyfile
, NULL
, &error
);
1081 g_critical("Failed to dump keyfile: %s", error
->message
);
1082 g_clear_error(&error
);
1088 g_key_file_free(keyfile
);
1091 static void config_parse(GAConfig
*config
, int argc
, char **argv
)
1093 const char *sopt
= "hVvdm:p:l:f:F::b:s:t:Dr";
1094 int opt_ind
= 0, ch
;
1095 const struct option lopt
[] = {
1096 { "help", 0, NULL
, 'h' },
1097 { "version", 0, NULL
, 'V' },
1098 { "dump-conf", 0, NULL
, 'D' },
1099 { "logfile", 1, NULL
, 'l' },
1100 { "pidfile", 1, NULL
, 'f' },
1101 #ifdef CONFIG_FSFREEZE
1102 { "fsfreeze-hook", 2, NULL
, 'F' },
1104 { "verbose", 0, NULL
, 'v' },
1105 { "method", 1, NULL
, 'm' },
1106 { "path", 1, NULL
, 'p' },
1107 { "daemonize", 0, NULL
, 'd' },
1108 { "blacklist", 1, NULL
, 'b' },
1110 { "service", 1, NULL
, 's' },
1112 { "statedir", 1, NULL
, 't' },
1113 { "retry-path", 0, NULL
, 'r' },
1114 { NULL
, 0, NULL
, 0 }
1117 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
1120 g_free(config
->method
);
1121 config
->method
= g_strdup(optarg
);
1124 g_free(config
->channel_path
);
1125 config
->channel_path
= g_strdup(optarg
);
1128 g_free(config
->log_filepath
);
1129 config
->log_filepath
= g_strdup(optarg
);
1132 g_free(config
->pid_filepath
);
1133 config
->pid_filepath
= g_strdup(optarg
);
1135 #ifdef CONFIG_FSFREEZE
1137 g_free(config
->fsfreeze_hook
);
1138 config
->fsfreeze_hook
= optarg
? g_strdup(optarg
) : get_relocated_path(QGA_FSFREEZE_HOOK_DEFAULT
);
1142 g_free(config
->state_dir
);
1143 config
->state_dir
= g_strdup(optarg
);
1146 /* enable all log levels */
1147 config
->log_level
= G_LOG_LEVEL_MASK
;
1150 printf("QEMU Guest Agent %s\n", QEMU_VERSION
);
1153 config
->daemonize
= 1;
1156 config
->dumpconf
= 1;
1159 config
->retry_path
= true;
1162 if (is_help_option(optarg
)) {
1163 qmp_for_each_command(&ga_commands
, ga_print_cmd
, NULL
);
1166 config
->blacklist
= g_list_concat(config
->blacklist
,
1167 split_list(optarg
, ","));
1172 config
->service
= optarg
;
1173 if (strcmp(config
->service
, "install") == 0) {
1174 if (ga_install_vss_provider()) {
1177 if (ga_install_service(config
->channel_path
,
1178 config
->log_filepath
, config
->state_dir
)) {
1182 } else if (strcmp(config
->service
, "uninstall") == 0) {
1183 ga_uninstall_vss_provider();
1184 exit(ga_uninstall_service());
1185 } else if (strcmp(config
->service
, "vss-install") == 0) {
1186 if (ga_install_vss_provider()) {
1190 } else if (strcmp(config
->service
, "vss-uninstall") == 0) {
1191 ga_uninstall_vss_provider();
1194 printf("Unknown service command.\n");
1203 g_print("Unknown option, try '%s --help' for more information.\n",
1210 static void config_free(GAConfig
*config
)
1212 g_free(config
->method
);
1213 g_free(config
->log_filepath
);
1214 g_free(config
->pid_filepath
);
1215 g_free(config
->state_dir
);
1216 g_free(config
->channel_path
);
1217 g_free(config
->bliststr
);
1218 #ifdef CONFIG_FSFREEZE
1219 g_free(config
->fsfreeze_hook
);
1221 g_list_free_full(config
->blacklist
, g_free
);
1225 static bool check_is_frozen(GAState
*s
)
1228 /* check if a previous instance of qemu-ga exited with filesystems' state
1229 * marked as frozen. this could be a stale value (a non-qemu-ga process
1230 * or reboot may have since unfrozen them), but better to require an
1231 * uneeded unfreeze than to risk hanging on start-up
1234 if (stat(s
->state_filepath_isfrozen
, &st
) == -1) {
1235 /* it's okay if the file doesn't exist, but if we can't access for
1236 * some other reason, such as permissions, there's a configuration
1237 * that needs to be addressed. so just bail now before we get into
1238 * more trouble later
1240 if (errno
!= ENOENT
) {
1241 g_critical("unable to access state file at path %s: %s",
1242 s
->state_filepath_isfrozen
, strerror(errno
));
1243 return EXIT_FAILURE
;
1246 g_warning("previous instance appears to have exited with frozen"
1247 " filesystems. deferring logging/pidfile creation and"
1248 " disabling non-fsfreeze-safe commands until"
1249 " guest-fsfreeze-thaw is issued, or filesystems are"
1250 " manually unfrozen and the file %s is removed",
1251 s
->state_filepath_isfrozen
);
1258 static GAState
*initialize_agent(GAConfig
*config
, int socket_activation
)
1260 GAState
*s
= g_new0(GAState
, 1);
1262 g_assert(ga_state
== NULL
);
1264 s
->log_level
= config
->log_level
;
1265 s
->log_file
= stderr
;
1266 #ifdef CONFIG_FSFREEZE
1267 s
->fsfreeze_hook
= config
->fsfreeze_hook
;
1269 s
->pstate_filepath
= g_strdup_printf("%s/qga.state", config
->state_dir
);
1270 s
->state_filepath_isfrozen
= g_strdup_printf("%s/qga.state.isfrozen",
1272 s
->frozen
= check_is_frozen(s
);
1274 g_log_set_default_handler(ga_log
, s
);
1275 g_log_set_fatal_mask(NULL
, G_LOG_LEVEL_ERROR
);
1276 ga_enable_logging(s
);
1278 g_debug("Guest agent version %s started", QEMU_FULL_VERSION
);
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
, NULL
);
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 qemu_init_exec_dir(argv
[0]);
1463 qga_qmp_init_marshal(&ga_commands
);
1465 init_dfl_pathnames();
1466 config_load(config
);
1467 config_parse(config
, argc
, argv
);
1469 if (config
->pid_filepath
== NULL
) {
1470 config
->pid_filepath
= g_strdup(dfl_pathnames
.pidfile
);
1473 if (config
->state_dir
== NULL
) {
1474 config
->state_dir
= g_strdup(dfl_pathnames
.state_dir
);
1477 if (config
->method
== NULL
) {
1478 config
->method
= g_strdup("virtio-serial");
1481 socket_activation
= check_socket_activation();
1482 if (socket_activation
> 1) {
1483 g_critical("qemu-ga only supports listening on one socket");
1487 if (socket_activation
) {
1488 SocketAddress
*addr
;
1490 g_free(config
->method
);
1491 g_free(config
->channel_path
);
1492 config
->method
= NULL
;
1493 config
->channel_path
= NULL
;
1495 addr
= socket_local_address(FIRST_SOCKET_ACTIVATION_FD
, NULL
);
1497 if (addr
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
1498 config
->method
= g_strdup("unix-listen");
1499 } else if (addr
->type
== SOCKET_ADDRESS_TYPE_VSOCK
) {
1500 config
->method
= g_strdup("vsock-listen");
1503 qapi_free_SocketAddress(addr
);
1506 if (!config
->method
) {
1507 g_critical("unsupported listen fd type");
1511 } else if (config
->channel_path
== NULL
) {
1512 if (strcmp(config
->method
, "virtio-serial") == 0) {
1513 /* try the default path for the virtio-serial port */
1514 config
->channel_path
= g_strdup(QGA_VIRTIO_PATH_DEFAULT
);
1515 } else if (strcmp(config
->method
, "isa-serial") == 0) {
1516 /* try the default path for the serial port - COM1 */
1517 config
->channel_path
= g_strdup(QGA_SERIAL_PATH_DEFAULT
);
1519 g_critical("must specify a path for this channel");
1525 if (config
->dumpconf
) {
1526 config_dump(config
);
1530 s
= initialize_agent(config
, socket_activation
);
1532 g_critical("error initializing guest agent");
1537 if (config
->daemonize
) {
1538 SERVICE_TABLE_ENTRY service_table
[] = {
1539 { (char *)QGA_SERVICE_NAME
, service_main
}, { NULL
, NULL
} };
1540 StartServiceCtrlDispatcher(service_table
);
1551 if (config
->daemonize
) {
1552 unlink(config
->pid_filepath
);
1555 config_free(config
);