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.
13 #include "qemu/osdep.h"
15 #include <glib/gstdio.h>
20 #include "qapi/qmp/json-streamer.h"
21 #include "qapi/qmp/json-parser.h"
22 #include "qapi/qmp/qint.h"
23 #include "qapi/qmp/qjson.h"
24 #include "qga/guest-agent-core.h"
25 #include "qemu/module.h"
26 #include "qapi/qmp/qerror.h"
27 #include "qapi/qmp/dispatch.h"
28 #include "qga/channel.h"
29 #include "qemu/bswap.h"
30 #include "qemu/help_option.h"
31 #include "qemu/sockets.h"
33 #include "qga/service-win32.h"
34 #include "qga/vss-win32.h"
39 #define CONFIG_FSFREEZE
44 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
45 #define QGA_STATE_RELATIVE_DIR "run"
46 #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0"
48 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
49 #define QGA_STATE_RELATIVE_DIR "qemu-ga"
50 #define QGA_SERIAL_PATH_DEFAULT "COM1"
52 #ifdef CONFIG_FSFREEZE
53 #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook"
55 #define QGA_SENTINEL_BYTE 0xFF
56 #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf"
59 const char *state_dir
;
63 typedef struct GAPersistentState
{
64 #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000
69 JSONMessageParser parser
;
72 bool virtio
; /* fastpath to check for virtio to deal with poll() quirks */
73 GACommandState
*command_state
;
74 GLogLevelFlags log_level
;
80 bool delimit_response
;
83 char *state_filepath_isfrozen
;
85 const char *log_filepath
;
86 const char *pid_filepath
;
88 #ifdef CONFIG_FSFREEZE
89 const char *fsfreeze_hook
;
91 gchar
*pstate_filepath
;
92 GAPersistentState pstate
;
95 struct GAState
*ga_state
;
96 QmpCommandList ga_commands
;
98 /* commands that are safe to issue while filesystems are frozen */
99 static const char *ga_freeze_whitelist
[] = {
103 "guest-sync-delimited",
104 "guest-fsfreeze-status",
105 "guest-fsfreeze-thaw",
110 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
112 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[]);
116 init_dfl_pathnames(void)
118 g_assert(dfl_pathnames
.state_dir
== NULL
);
119 g_assert(dfl_pathnames
.pidfile
== NULL
);
120 dfl_pathnames
.state_dir
= qemu_get_local_state_pathname(
121 QGA_STATE_RELATIVE_DIR
);
122 dfl_pathnames
.pidfile
= qemu_get_local_state_pathname(
123 QGA_STATE_RELATIVE_DIR G_DIR_SEPARATOR_S
"qemu-ga.pid");
126 static void quit_handler(int sig
)
128 /* if we're frozen, don't exit unless we're absolutely forced to,
129 * because it's basically impossible for graceful exit to complete
130 * unless all log/pid files are on unfreezable filesystems. there's
131 * also a very likely chance killing the agent before unfreezing
132 * the filesystems is a mistake (or will be viewed as one later).
134 if (ga_is_frozen(ga_state
)) {
137 g_debug("received signal num %d, quitting", sig
);
139 if (g_main_loop_is_running(ga_state
->main_loop
)) {
140 g_main_loop_quit(ga_state
->main_loop
);
145 static gboolean
register_signal_handlers(void)
147 struct sigaction sigact
;
150 memset(&sigact
, 0, sizeof(struct sigaction
));
151 sigact
.sa_handler
= quit_handler
;
153 ret
= sigaction(SIGINT
, &sigact
, NULL
);
155 g_error("error configuring signal handler: %s", strerror(errno
));
157 ret
= sigaction(SIGTERM
, &sigact
, NULL
);
159 g_error("error configuring signal handler: %s", strerror(errno
));
162 sigact
.sa_handler
= SIG_IGN
;
163 if (sigaction(SIGPIPE
, &sigact
, NULL
) != 0) {
164 g_error("error configuring SIGPIPE signal handler: %s",
171 /* TODO: use this in place of all post-fork() fclose(std*) callers */
172 void reopen_fd_to_null(int fd
)
176 nullfd
= open("/dev/null", O_RDWR
);
191 * @consume: true to prevent future calls from succeeding
193 * Fetch a listen file descriptor that was passed via systemd socket
194 * activation. Use @consume to prevent child processes from thinking a file
195 * descriptor was passed.
197 * Returns: file descriptor or -1 if no fd was passed
199 static int get_listen_fd(bool consume
)
202 return -1; /* no fd passing expected, unsetenv(3) not available */
204 const char *listen_fds
= getenv("LISTEN_FDS");
205 int fd
= STDERR_FILENO
+ 1;
207 if (!listen_fds
|| strcmp(listen_fds
, "1") != 0) {
212 unsetenv("LISTEN_FDS");
215 qemu_set_cloexec(fd
);
220 static void usage(const char *cmd
)
223 "Usage: %s [-m <method> -p <path>] [<options>]\n"
224 "QEMU Guest Agent %s\n"
226 " -m, --method transport method: one of unix-listen, virtio-serial,\n"
227 " isa-serial, or vsock-listen (virtio-serial is the default)\n"
228 " -p, --path device/socket path (the default for virtio-serial is:\n"
230 " the default for isa-serial is:\n"
232 " -l, --logfile set logfile path, logs to stderr by default\n"
233 " -f, --pidfile specify pidfile (default is %s)\n"
234 #ifdef CONFIG_FSFREEZE
235 " -F, --fsfreeze-hook\n"
236 " enable fsfreeze hook. Accepts an optional argument that\n"
237 " specifies script to run on freeze/thaw. Script will be\n"
238 " called with 'freeze'/'thaw' arguments accordingly.\n"
240 " If using -F with an argument, do not follow -F with a\n"
242 " (for example: -F/var/run/fsfreezehook.sh)\n"
244 " -t, --statedir specify dir to store state information (absolute paths\n"
245 " only, default is %s)\n"
246 " -v, --verbose log extra debugging information\n"
247 " -V, --version print version information and exit\n"
248 " -d, --daemonize become a daemon\n"
250 " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n"
252 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
253 " to list available RPCs)\n"
254 " -D, --dump-conf dump a qemu-ga config file based on current config\n"
255 " options / command-line parameters to stdout\n"
256 " -h, --help display this help and exit\n"
258 "Report bugs to <mdroth@linux.vnet.ibm.com>\n"
259 , cmd
, QEMU_VERSION
, QGA_VIRTIO_PATH_DEFAULT
, QGA_SERIAL_PATH_DEFAULT
,
260 dfl_pathnames
.pidfile
,
261 #ifdef CONFIG_FSFREEZE
262 QGA_FSFREEZE_HOOK_DEFAULT
,
264 dfl_pathnames
.state_dir
);
267 static const char *ga_log_level_str(GLogLevelFlags level
)
269 switch (level
& G_LOG_LEVEL_MASK
) {
270 case G_LOG_LEVEL_ERROR
:
272 case G_LOG_LEVEL_CRITICAL
:
274 case G_LOG_LEVEL_WARNING
:
276 case G_LOG_LEVEL_MESSAGE
:
278 case G_LOG_LEVEL_INFO
:
280 case G_LOG_LEVEL_DEBUG
:
287 bool ga_logging_enabled(GAState
*s
)
289 return s
->logging_enabled
;
292 void ga_disable_logging(GAState
*s
)
294 s
->logging_enabled
= false;
297 void ga_enable_logging(GAState
*s
)
299 s
->logging_enabled
= true;
302 static void ga_log(const gchar
*domain
, GLogLevelFlags level
,
303 const gchar
*msg
, gpointer opaque
)
307 const char *level_str
= ga_log_level_str(level
);
309 if (!ga_logging_enabled(s
)) {
313 level
&= G_LOG_LEVEL_MASK
;
315 if (g_strcmp0(domain
, "syslog") == 0) {
316 syslog(LOG_INFO
, "%s: %s", level_str
, msg
);
317 } else if (level
& s
->log_level
) {
319 if (level
& s
->log_level
) {
321 g_get_current_time(&time
);
323 "%lu.%lu: %s: %s\n", time
.tv_sec
, time
.tv_usec
, level_str
, msg
);
328 void ga_set_response_delimited(GAState
*s
)
330 s
->delimit_response
= true;
333 static FILE *ga_open_logfile(const char *logfile
)
337 f
= fopen(logfile
, "a");
342 qemu_set_cloexec(fileno(f
));
347 static bool ga_open_pidfile(const char *pidfile
)
352 pidfd
= qemu_open(pidfile
, O_CREAT
|O_WRONLY
, S_IRUSR
|S_IWUSR
);
353 if (pidfd
== -1 || lockf(pidfd
, F_TLOCK
, 0)) {
354 g_critical("Cannot lock pid file, %s", strerror(errno
));
361 if (ftruncate(pidfd
, 0)) {
362 g_critical("Failed to truncate pid file");
365 snprintf(pidstr
, sizeof(pidstr
), "%d\n", getpid());
366 if (write(pidfd
, pidstr
, strlen(pidstr
)) != strlen(pidstr
)) {
367 g_critical("Failed to write pid file");
371 /* keep pidfile open & locked forever */
380 static bool ga_open_pidfile(const char *pidfile
)
386 static gint
ga_strcmp(gconstpointer str1
, gconstpointer str2
)
388 return strcmp(str1
, str2
);
391 /* disable commands that aren't safe for fsfreeze */
392 static void ga_disable_non_whitelisted(QmpCommand
*cmd
, void *opaque
)
394 bool whitelisted
= false;
396 const char *name
= qmp_command_name(cmd
);
398 while (ga_freeze_whitelist
[i
] != NULL
) {
399 if (strcmp(name
, ga_freeze_whitelist
[i
]) == 0) {
405 g_debug("disabling command: %s", name
);
406 qmp_disable_command(&ga_commands
, name
);
410 /* [re-]enable all commands, except those explicitly blacklisted by user */
411 static void ga_enable_non_blacklisted(QmpCommand
*cmd
, void *opaque
)
413 GList
*blacklist
= opaque
;
414 const char *name
= qmp_command_name(cmd
);
416 if (g_list_find_custom(blacklist
, name
, ga_strcmp
) == NULL
&&
417 !qmp_command_is_enabled(cmd
)) {
418 g_debug("enabling command: %s", name
);
419 qmp_enable_command(&ga_commands
, name
);
423 static bool ga_create_file(const char *path
)
425 int fd
= open(path
, O_CREAT
| O_WRONLY
, S_IWUSR
| S_IRUSR
);
427 g_warning("unable to open/create file %s: %s", path
, strerror(errno
));
434 static bool ga_delete_file(const char *path
)
436 int ret
= unlink(path
);
438 g_warning("unable to delete file: %s: %s", path
, strerror(errno
));
445 bool ga_is_frozen(GAState
*s
)
450 void ga_set_frozen(GAState
*s
)
452 if (ga_is_frozen(s
)) {
455 /* disable all non-whitelisted (for frozen state) commands */
456 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
457 g_warning("disabling logging due to filesystem freeze");
458 ga_disable_logging(s
);
460 if (!ga_create_file(s
->state_filepath_isfrozen
)) {
461 g_warning("unable to create %s, fsfreeze may not function properly",
462 s
->state_filepath_isfrozen
);
466 void ga_unset_frozen(GAState
*s
)
468 if (!ga_is_frozen(s
)) {
472 /* if we delayed creation/opening of pid/log files due to being
473 * in a frozen state at start up, do it now
475 if (s
->deferred_options
.log_filepath
) {
476 s
->log_file
= ga_open_logfile(s
->deferred_options
.log_filepath
);
478 s
->log_file
= stderr
;
480 s
->deferred_options
.log_filepath
= NULL
;
482 ga_enable_logging(s
);
483 g_warning("logging re-enabled due to filesystem unfreeze");
484 if (s
->deferred_options
.pid_filepath
) {
485 if (!ga_open_pidfile(s
->deferred_options
.pid_filepath
)) {
486 g_warning("failed to create/open pid file");
488 s
->deferred_options
.pid_filepath
= NULL
;
491 /* enable all disabled, non-blacklisted commands */
492 qmp_for_each_command(&ga_commands
, ga_enable_non_blacklisted
, s
->blacklist
);
494 if (!ga_delete_file(s
->state_filepath_isfrozen
)) {
495 g_warning("unable to delete %s, fsfreeze may not function properly",
496 s
->state_filepath_isfrozen
);
500 #ifdef CONFIG_FSFREEZE
501 const char *ga_fsfreeze_hook(GAState
*s
)
503 return s
->fsfreeze_hook
;
507 static void become_daemon(const char *pidfile
)
521 if (!ga_open_pidfile(pidfile
)) {
522 g_critical("failed to create pidfile");
527 umask(S_IRWXG
| S_IRWXO
);
532 if ((chdir("/")) < 0) {
536 reopen_fd_to_null(STDIN_FILENO
);
537 reopen_fd_to_null(STDOUT_FILENO
);
538 reopen_fd_to_null(STDERR_FILENO
);
545 g_critical("failed to daemonize");
550 static int send_response(GAState
*s
, QObject
*payload
)
553 QString
*payload_qstr
, *response_qstr
;
556 g_assert(payload
&& s
->channel
);
558 payload_qstr
= qobject_to_json(payload
);
563 if (s
->delimit_response
) {
564 s
->delimit_response
= false;
565 response_qstr
= qstring_new();
566 qstring_append_chr(response_qstr
, QGA_SENTINEL_BYTE
);
567 qstring_append(response_qstr
, qstring_get_str(payload_qstr
));
568 QDECREF(payload_qstr
);
570 response_qstr
= payload_qstr
;
573 qstring_append_chr(response_qstr
, '\n');
574 buf
= qstring_get_str(response_qstr
);
575 status
= ga_channel_write_all(s
->channel
, buf
, strlen(buf
));
576 QDECREF(response_qstr
);
577 if (status
!= G_IO_STATUS_NORMAL
) {
584 static void process_command(GAState
*s
, QDict
*req
)
590 g_debug("processing command");
591 rsp
= qmp_dispatch(&ga_commands
, QOBJECT(req
));
593 ret
= send_response(s
, rsp
);
595 g_warning("error sending response: %s", strerror(-ret
));
601 /* handle requests/control events coming in over the channel */
602 static void process_event(JSONMessageParser
*parser
, GQueue
*tokens
)
604 GAState
*s
= container_of(parser
, GAState
, parser
);
609 g_assert(s
&& parser
);
611 g_debug("process_event: called");
612 qdict
= qobject_to_qdict(json_parser_parse_err(tokens
, NULL
, &err
));
617 g_warning("failed to parse event: unknown error");
618 error_setg(&err
, QERR_JSON_PARSING
);
620 g_warning("failed to parse event: %s", error_get_pretty(err
));
622 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
626 /* handle host->guest commands */
627 if (qdict_haskey(qdict
, "execute")) {
628 process_command(s
, qdict
);
630 if (!qdict_haskey(qdict
, "error")) {
633 g_warning("unrecognized payload format");
634 error_setg(&err
, QERR_UNSUPPORTED
);
635 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
638 ret
= send_response(s
, QOBJECT(qdict
));
640 g_warning("error sending error response: %s", strerror(-ret
));
647 /* false return signals GAChannel to close the current client connection */
648 static gboolean
channel_event_cb(GIOCondition condition
, gpointer data
)
651 gchar buf
[QGA_READ_COUNT_DEFAULT
+1];
653 GIOStatus status
= ga_channel_read(s
->channel
, buf
, QGA_READ_COUNT_DEFAULT
, &count
);
655 case G_IO_STATUS_ERROR
:
656 g_warning("error reading channel");
658 case G_IO_STATUS_NORMAL
:
660 g_debug("read data, count: %d, data: %s", (int)count
, buf
);
661 json_message_parser_feed(&s
->parser
, (char *)buf
, (int)count
);
663 case G_IO_STATUS_EOF
:
664 g_debug("received EOF");
669 case G_IO_STATUS_AGAIN
:
670 /* virtio causes us to spin here when no process is attached to
671 * host-side chardev. sleep a bit to mitigate this
678 g_warning("unknown channel read status, closing");
684 static gboolean
channel_init(GAState
*s
, const gchar
*method
, const gchar
*path
,
687 GAChannelMethod channel_method
;
689 if (strcmp(method
, "virtio-serial") == 0) {
690 s
->virtio
= true; /* virtio requires special handling in some cases */
691 channel_method
= GA_CHANNEL_VIRTIO_SERIAL
;
692 } else if (strcmp(method
, "isa-serial") == 0) {
693 channel_method
= GA_CHANNEL_ISA_SERIAL
;
694 } else if (strcmp(method
, "unix-listen") == 0) {
695 channel_method
= GA_CHANNEL_UNIX_LISTEN
;
696 } else if (strcmp(method
, "vsock-listen") == 0) {
697 channel_method
= GA_CHANNEL_VSOCK_LISTEN
;
699 g_critical("unsupported channel method/type: %s", method
);
703 s
->channel
= ga_channel_new(channel_method
, path
, listen_fd
,
704 channel_event_cb
, s
);
706 g_critical("failed to create guest agent channel");
714 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
717 DWORD ret
= NO_ERROR
;
718 GAService
*service
= &ga_state
->service
;
722 case SERVICE_CONTROL_STOP
:
723 case SERVICE_CONTROL_SHUTDOWN
:
724 quit_handler(SIGTERM
);
725 service
->status
.dwCurrentState
= SERVICE_STOP_PENDING
;
726 SetServiceStatus(service
->status_handle
, &service
->status
);
730 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
735 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[])
737 GAService
*service
= &ga_state
->service
;
739 service
->status_handle
= RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME
,
740 service_ctrl_handler
, NULL
);
742 if (service
->status_handle
== 0) {
743 g_critical("Failed to register extended requests function!\n");
747 service
->status
.dwServiceType
= SERVICE_WIN32
;
748 service
->status
.dwCurrentState
= SERVICE_RUNNING
;
749 service
->status
.dwControlsAccepted
= SERVICE_ACCEPT_STOP
| SERVICE_ACCEPT_SHUTDOWN
;
750 service
->status
.dwWin32ExitCode
= NO_ERROR
;
751 service
->status
.dwServiceSpecificExitCode
= NO_ERROR
;
752 service
->status
.dwCheckPoint
= 0;
753 service
->status
.dwWaitHint
= 0;
754 SetServiceStatus(service
->status_handle
, &service
->status
);
756 g_main_loop_run(ga_state
->main_loop
);
758 service
->status
.dwCurrentState
= SERVICE_STOPPED
;
759 SetServiceStatus(service
->status_handle
, &service
->status
);
763 static void set_persistent_state_defaults(GAPersistentState
*pstate
)
766 pstate
->fd_counter
= QGA_PSTATE_DEFAULT_FD_COUNTER
;
769 static void persistent_state_from_keyfile(GAPersistentState
*pstate
,
774 /* if any fields are missing, either because the file was tampered with
775 * by agents of chaos, or because the field wasn't present at the time the
776 * file was created, the best we can ever do is start over with the default
777 * values. so load them now, and ignore any errors in accessing key-value
780 set_persistent_state_defaults(pstate
);
782 if (g_key_file_has_key(keyfile
, "global", "fd_counter", NULL
)) {
784 g_key_file_get_integer(keyfile
, "global", "fd_counter", NULL
);
788 static void persistent_state_to_keyfile(const GAPersistentState
*pstate
,
794 g_key_file_set_integer(keyfile
, "global", "fd_counter", pstate
->fd_counter
);
797 static gboolean
write_persistent_state(const GAPersistentState
*pstate
,
800 GKeyFile
*keyfile
= g_key_file_new();
808 persistent_state_to_keyfile(pstate
, keyfile
);
809 data
= g_key_file_to_data(keyfile
, &data_len
, &gerr
);
811 g_critical("failed to convert persistent state to string: %s",
817 g_file_set_contents(path
, data
, data_len
, &gerr
);
819 g_critical("failed to write persistent state to %s: %s",
820 path
, gerr
->message
);
830 g_key_file_free(keyfile
);
836 static gboolean
read_persistent_state(GAPersistentState
*pstate
,
837 const gchar
*path
, gboolean frozen
)
839 GKeyFile
*keyfile
= NULL
;
846 if (stat(path
, &st
) == -1) {
847 /* it's okay if state file doesn't exist, but any other error
848 * indicates a permissions issue or some other misconfiguration
849 * that we likely won't be able to recover from.
851 if (errno
!= ENOENT
) {
852 g_critical("unable to access state file at path %s: %s",
853 path
, strerror(errno
));
858 /* file doesn't exist. initialize state to default values and
859 * attempt to save now. (we could wait till later when we have
860 * modified state we need to commit, but if there's a problem,
861 * such as a missing parent directory, we want to catch it now)
863 * there is a potential scenario where someone either managed to
864 * update the agent from a version that didn't use a key store
865 * while qemu-ga thought the filesystem was frozen, or
866 * deleted the key store prior to issuing a fsfreeze, prior
867 * to restarting the agent. in this case we go ahead and defer
868 * initial creation till we actually have modified state to
869 * write, otherwise fail to recover from freeze.
871 set_persistent_state_defaults(pstate
);
873 ret
= write_persistent_state(pstate
, path
);
875 g_critical("unable to create state file at path %s", path
);
884 keyfile
= g_key_file_new();
885 g_key_file_load_from_file(keyfile
, path
, 0, &gerr
);
887 g_critical("error loading persistent state from path: %s, %s",
888 path
, gerr
->message
);
893 persistent_state_from_keyfile(pstate
, keyfile
);
897 g_key_file_free(keyfile
);
906 int64_t ga_get_fd_handle(GAState
*s
, Error
**errp
)
910 g_assert(s
->pstate_filepath
);
911 /* we blacklist commands and avoid operations that potentially require
912 * writing to disk when we're in a frozen state. this includes opening
913 * new files, so we should never get here in that situation
915 g_assert(!ga_is_frozen(s
));
917 handle
= s
->pstate
.fd_counter
++;
919 /* This should never happen on a reasonable timeframe, as guest-file-open
920 * would have to be issued 2^63 times */
921 if (s
->pstate
.fd_counter
== INT64_MAX
) {
925 if (!write_persistent_state(&s
->pstate
, s
->pstate_filepath
)) {
926 error_setg(errp
, "failed to commit persistent state to disk");
933 static void ga_print_cmd(QmpCommand
*cmd
, void *opaque
)
935 printf("%s\n", qmp_command_name(cmd
));
938 static GList
*split_list(const gchar
*str
, const gchar
*delim
)
944 strv
= g_strsplit(str
, delim
, -1);
945 for (i
= 0; strv
[i
]; i
++) {
946 list
= g_list_prepend(list
, strv
[i
]);
953 typedef struct GAConfig
{
958 #ifdef CONFIG_FSFREEZE
965 gchar
*bliststr
; /* blacklist may point to this string */
968 GLogLevelFlags log_level
;
972 static void config_load(GAConfig
*config
)
976 const char *conf
= g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT
;
978 /* read system config */
979 keyfile
= g_key_file_new();
980 if (!g_key_file_load_from_file(keyfile
, conf
, 0, &gerr
)) {
983 if (g_key_file_has_key(keyfile
, "general", "daemon", NULL
)) {
985 g_key_file_get_boolean(keyfile
, "general", "daemon", &gerr
);
987 if (g_key_file_has_key(keyfile
, "general", "method", NULL
)) {
989 g_key_file_get_string(keyfile
, "general", "method", &gerr
);
991 if (g_key_file_has_key(keyfile
, "general", "path", NULL
)) {
992 config
->channel_path
=
993 g_key_file_get_string(keyfile
, "general", "path", &gerr
);
995 if (g_key_file_has_key(keyfile
, "general", "logfile", NULL
)) {
996 config
->log_filepath
=
997 g_key_file_get_string(keyfile
, "general", "logfile", &gerr
);
999 if (g_key_file_has_key(keyfile
, "general", "pidfile", NULL
)) {
1000 config
->pid_filepath
=
1001 g_key_file_get_string(keyfile
, "general", "pidfile", &gerr
);
1003 #ifdef CONFIG_FSFREEZE
1004 if (g_key_file_has_key(keyfile
, "general", "fsfreeze-hook", NULL
)) {
1005 config
->fsfreeze_hook
=
1006 g_key_file_get_string(keyfile
,
1007 "general", "fsfreeze-hook", &gerr
);
1010 if (g_key_file_has_key(keyfile
, "general", "statedir", NULL
)) {
1012 g_key_file_get_string(keyfile
, "general", "statedir", &gerr
);
1014 if (g_key_file_has_key(keyfile
, "general", "verbose", NULL
) &&
1015 g_key_file_get_boolean(keyfile
, "general", "verbose", &gerr
)) {
1016 /* enable all log levels */
1017 config
->log_level
= G_LOG_LEVEL_MASK
;
1019 if (g_key_file_has_key(keyfile
, "general", "blacklist", NULL
)) {
1021 g_key_file_get_string(keyfile
, "general", "blacklist", &gerr
);
1022 config
->blacklist
= g_list_concat(config
->blacklist
,
1023 split_list(config
->bliststr
, ","));
1027 g_key_file_free(keyfile
);
1029 !(gerr
->domain
== G_FILE_ERROR
&& gerr
->code
== G_FILE_ERROR_NOENT
)) {
1030 g_critical("error loading configuration from path: %s, %s",
1031 QGA_CONF_DEFAULT
, gerr
->message
);
1034 g_clear_error(&gerr
);
1037 static gchar
*list_join(GList
*list
, const gchar separator
)
1039 GString
*str
= g_string_new("");
1042 str
= g_string_append(str
, (gchar
*)list
->data
);
1043 list
= g_list_next(list
);
1045 str
= g_string_append_c(str
, separator
);
1049 return g_string_free(str
, FALSE
);
1052 static void config_dump(GAConfig
*config
)
1054 GError
*error
= NULL
;
1058 keyfile
= g_key_file_new();
1061 g_key_file_set_boolean(keyfile
, "general", "daemon", config
->daemonize
);
1062 g_key_file_set_string(keyfile
, "general", "method", config
->method
);
1063 if (config
->channel_path
) {
1064 g_key_file_set_string(keyfile
, "general", "path", config
->channel_path
);
1066 if (config
->log_filepath
) {
1067 g_key_file_set_string(keyfile
, "general", "logfile",
1068 config
->log_filepath
);
1070 g_key_file_set_string(keyfile
, "general", "pidfile", config
->pid_filepath
);
1071 #ifdef CONFIG_FSFREEZE
1072 if (config
->fsfreeze_hook
) {
1073 g_key_file_set_string(keyfile
, "general", "fsfreeze-hook",
1074 config
->fsfreeze_hook
);
1077 g_key_file_set_string(keyfile
, "general", "statedir", config
->state_dir
);
1078 g_key_file_set_boolean(keyfile
, "general", "verbose",
1079 config
->log_level
== G_LOG_LEVEL_MASK
);
1080 tmp
= list_join(config
->blacklist
, ',');
1081 g_key_file_set_string(keyfile
, "general", "blacklist", tmp
);
1084 tmp
= g_key_file_to_data(keyfile
, NULL
, &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:D";
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 { NULL
, 0, NULL
, 0 }
1116 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
1119 g_free(config
->method
);
1120 config
->method
= g_strdup(optarg
);
1123 g_free(config
->channel_path
);
1124 config
->channel_path
= g_strdup(optarg
);
1127 g_free(config
->log_filepath
);
1128 config
->log_filepath
= g_strdup(optarg
);
1131 g_free(config
->pid_filepath
);
1132 config
->pid_filepath
= g_strdup(optarg
);
1134 #ifdef CONFIG_FSFREEZE
1136 g_free(config
->fsfreeze_hook
);
1137 config
->fsfreeze_hook
= g_strdup(optarg
?: QGA_FSFREEZE_HOOK_DEFAULT
);
1141 g_free(config
->state_dir
);
1142 config
->state_dir
= g_strdup(optarg
);
1145 /* enable all log levels */
1146 config
->log_level
= G_LOG_LEVEL_MASK
;
1149 printf("QEMU Guest Agent %s\n", QEMU_VERSION
);
1152 config
->daemonize
= 1;
1155 config
->dumpconf
= 1;
1158 if (is_help_option(optarg
)) {
1159 qmp_for_each_command(&ga_commands
, ga_print_cmd
, NULL
);
1162 config
->blacklist
= g_list_concat(config
->blacklist
,
1163 split_list(optarg
, ","));
1168 config
->service
= optarg
;
1169 if (strcmp(config
->service
, "install") == 0) {
1170 if (ga_install_vss_provider()) {
1173 if (ga_install_service(config
->channel_path
,
1174 config
->log_filepath
, config
->state_dir
)) {
1178 } else if (strcmp(config
->service
, "uninstall") == 0) {
1179 ga_uninstall_vss_provider();
1180 exit(ga_uninstall_service());
1181 } else if (strcmp(config
->service
, "vss-install") == 0) {
1182 if (ga_install_vss_provider()) {
1186 } else if (strcmp(config
->service
, "vss-uninstall") == 0) {
1187 ga_uninstall_vss_provider();
1190 printf("Unknown service command.\n");
1199 g_print("Unknown option, try '%s --help' for more information.\n",
1206 static void config_free(GAConfig
*config
)
1208 g_free(config
->method
);
1209 g_free(config
->log_filepath
);
1210 g_free(config
->pid_filepath
);
1211 g_free(config
->state_dir
);
1212 g_free(config
->channel_path
);
1213 g_free(config
->bliststr
);
1214 #ifdef CONFIG_FSFREEZE
1215 g_free(config
->fsfreeze_hook
);
1217 g_list_free_full(config
->blacklist
, g_free
);
1221 static bool check_is_frozen(GAState
*s
)
1224 /* check if a previous instance of qemu-ga exited with filesystems' state
1225 * marked as frozen. this could be a stale value (a non-qemu-ga process
1226 * or reboot may have since unfrozen them), but better to require an
1227 * uneeded unfreeze than to risk hanging on start-up
1230 if (stat(s
->state_filepath_isfrozen
, &st
) == -1) {
1231 /* it's okay if the file doesn't exist, but if we can't access for
1232 * some other reason, such as permissions, there's a configuration
1233 * that needs to be addressed. so just bail now before we get into
1234 * more trouble later
1236 if (errno
!= ENOENT
) {
1237 g_critical("unable to access state file at path %s: %s",
1238 s
->state_filepath_isfrozen
, strerror(errno
));
1239 return EXIT_FAILURE
;
1242 g_warning("previous instance appears to have exited with frozen"
1243 " filesystems. deferring logging/pidfile creation and"
1244 " disabling non-fsfreeze-safe commands until"
1245 " guest-fsfreeze-thaw is issued, or filesystems are"
1246 " manually unfrozen and the file %s is removed",
1247 s
->state_filepath_isfrozen
);
1254 static int run_agent(GAState
*s
, GAConfig
*config
)
1258 g_log_set_default_handler(ga_log
, s
);
1259 g_log_set_fatal_mask(NULL
, G_LOG_LEVEL_ERROR
);
1260 ga_enable_logging(s
);
1263 /* On win32 the state directory is application specific (be it the default
1264 * or a user override). We got past the command line parsing; let's create
1265 * the directory (with any intermediate directories). If we run into an
1266 * error later on, we won't try to clean up the directory, it is considered
1269 if (g_mkdir_with_parents(config
->state_dir
, S_IRWXU
) == -1) {
1270 g_critical("unable to create (an ancestor of) the state directory"
1271 " '%s': %s", config
->state_dir
, strerror(errno
));
1272 return EXIT_FAILURE
;
1276 if (ga_is_frozen(s
)) {
1277 if (config
->daemonize
) {
1278 /* delay opening/locking of pidfile till filesystems are unfrozen */
1279 s
->deferred_options
.pid_filepath
= config
->pid_filepath
;
1280 become_daemon(NULL
);
1282 if (config
->log_filepath
) {
1283 /* delay opening the log file till filesystems are unfrozen */
1284 s
->deferred_options
.log_filepath
= config
->log_filepath
;
1286 ga_disable_logging(s
);
1287 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
1289 if (config
->daemonize
) {
1290 become_daemon(config
->pid_filepath
);
1292 if (config
->log_filepath
) {
1293 FILE *log_file
= ga_open_logfile(config
->log_filepath
);
1295 g_critical("unable to open specified log file: %s",
1297 return EXIT_FAILURE
;
1299 s
->log_file
= log_file
;
1303 /* load persistent state from disk */
1304 if (!read_persistent_state(&s
->pstate
,
1307 g_critical("failed to load persistent state");
1308 return EXIT_FAILURE
;
1311 config
->blacklist
= ga_command_blacklist_init(config
->blacklist
);
1312 if (config
->blacklist
) {
1313 GList
*l
= config
->blacklist
;
1314 s
->blacklist
= config
->blacklist
;
1316 g_debug("disabling command: %s", (char *)l
->data
);
1317 qmp_disable_command(&ga_commands
, l
->data
);
1321 s
->command_state
= ga_command_state_new();
1322 ga_command_state_init(s
, s
->command_state
);
1323 ga_command_state_init_all(s
->command_state
);
1324 json_message_parser_init(&s
->parser
, process_event
);
1327 if (!register_signal_handlers()) {
1328 g_critical("failed to register signal handlers");
1329 return EXIT_FAILURE
;
1333 s
->main_loop
= g_main_loop_new(NULL
, false);
1335 if (!channel_init(ga_state
, config
->method
, config
->channel_path
,
1336 get_listen_fd(true))) {
1337 g_critical("failed to initialize guest agent channel");
1338 return EXIT_FAILURE
;
1341 g_main_loop_run(ga_state
->main_loop
);
1343 if (config
->daemonize
) {
1344 SERVICE_TABLE_ENTRY service_table
[] = {
1345 { (char *)QGA_SERVICE_NAME
, service_main
}, { NULL
, NULL
} };
1346 StartServiceCtrlDispatcher(service_table
);
1348 g_main_loop_run(ga_state
->main_loop
);
1352 return EXIT_SUCCESS
;
1355 int main(int argc
, char **argv
)
1357 int ret
= EXIT_SUCCESS
;
1358 GAState
*s
= g_new0(GAState
, 1);
1359 GAConfig
*config
= g_new0(GAConfig
, 1);
1362 config
->log_level
= G_LOG_LEVEL_ERROR
| G_LOG_LEVEL_CRITICAL
;
1364 qga_qmp_init_marshal(&ga_commands
);
1366 init_dfl_pathnames();
1367 config_load(config
);
1368 config_parse(config
, argc
, argv
);
1370 if (config
->pid_filepath
== NULL
) {
1371 config
->pid_filepath
= g_strdup(dfl_pathnames
.pidfile
);
1374 if (config
->state_dir
== NULL
) {
1375 config
->state_dir
= g_strdup(dfl_pathnames
.state_dir
);
1378 if (config
->method
== NULL
) {
1379 config
->method
= g_strdup("virtio-serial");
1382 listen_fd
= get_listen_fd(false);
1383 if (listen_fd
>= 0) {
1384 SocketAddress
*addr
;
1386 g_free(config
->method
);
1387 g_free(config
->channel_path
);
1388 config
->method
= NULL
;
1389 config
->channel_path
= NULL
;
1391 addr
= socket_local_address(listen_fd
, NULL
);
1393 if (addr
->type
== SOCKET_ADDRESS_KIND_UNIX
) {
1394 config
->method
= g_strdup("unix-listen");
1395 } else if (addr
->type
== SOCKET_ADDRESS_KIND_VSOCK
) {
1396 config
->method
= g_strdup("vsock-listen");
1399 qapi_free_SocketAddress(addr
);
1402 if (!config
->method
) {
1403 g_critical("unsupported listen fd type");
1407 } else if (config
->channel_path
== NULL
) {
1408 if (strcmp(config
->method
, "virtio-serial") == 0) {
1409 /* try the default path for the virtio-serial port */
1410 config
->channel_path
= g_strdup(QGA_VIRTIO_PATH_DEFAULT
);
1411 } else if (strcmp(config
->method
, "isa-serial") == 0) {
1412 /* try the default path for the serial port - COM1 */
1413 config
->channel_path
= g_strdup(QGA_SERIAL_PATH_DEFAULT
);
1415 g_critical("must specify a path for this channel");
1421 s
->log_level
= config
->log_level
;
1422 s
->log_file
= stderr
;
1423 #ifdef CONFIG_FSFREEZE
1424 s
->fsfreeze_hook
= config
->fsfreeze_hook
;
1426 s
->pstate_filepath
= g_strdup_printf("%s/qga.state", config
->state_dir
);
1427 s
->state_filepath_isfrozen
= g_strdup_printf("%s/qga.state.isfrozen",
1429 s
->frozen
= check_is_frozen(s
);
1431 if (config
->dumpconf
) {
1432 config_dump(config
);
1436 ret
= run_agent(s
, config
);
1439 if (s
->command_state
) {
1440 ga_command_state_cleanup_all(s
->command_state
);
1441 ga_command_state_free(s
->command_state
);
1442 json_message_parser_destroy(&s
->parser
);
1445 ga_channel_free(s
->channel
);
1447 g_free(s
->pstate_filepath
);
1448 g_free(s
->state_filepath_isfrozen
);
1450 if (config
->daemonize
) {
1451 unlink(config
->pid_filepath
);
1454 config_free(config
);
1456 g_main_loop_unref(s
->main_loop
);