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"
32 #include "qemu/systemd.h"
34 #include "qga/service-win32.h"
35 #include "qga/vss-win32.h"
40 #define CONFIG_FSFREEZE
45 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
46 #define QGA_STATE_RELATIVE_DIR "run"
47 #define QGA_SERIAL_PATH_DEFAULT "/dev/ttyS0"
49 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
50 #define QGA_STATE_RELATIVE_DIR "qemu-ga"
51 #define QGA_SERIAL_PATH_DEFAULT "COM1"
53 #ifdef CONFIG_FSFREEZE
54 #define QGA_FSFREEZE_HOOK_DEFAULT CONFIG_QEMU_CONFDIR "/fsfreeze-hook"
56 #define QGA_SENTINEL_BYTE 0xFF
57 #define QGA_CONF_DEFAULT CONFIG_QEMU_CONFDIR G_DIR_SEPARATOR_S "qemu-ga.conf"
60 const char *state_dir
;
64 typedef struct GAPersistentState
{
65 #define QGA_PSTATE_DEFAULT_FD_COUNTER 1000
70 JSONMessageParser parser
;
73 bool virtio
; /* fastpath to check for virtio to deal with poll() quirks */
74 GACommandState
*command_state
;
75 GLogLevelFlags log_level
;
81 bool delimit_response
;
84 char *state_filepath_isfrozen
;
86 const char *log_filepath
;
87 const char *pid_filepath
;
89 #ifdef CONFIG_FSFREEZE
90 const char *fsfreeze_hook
;
92 gchar
*pstate_filepath
;
93 GAPersistentState pstate
;
96 struct GAState
*ga_state
;
97 QmpCommandList ga_commands
;
99 /* commands that are safe to issue while filesystems are frozen */
100 static const char *ga_freeze_whitelist
[] = {
104 "guest-sync-delimited",
105 "guest-fsfreeze-status",
106 "guest-fsfreeze-thaw",
111 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
113 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[]);
117 init_dfl_pathnames(void)
119 g_assert(dfl_pathnames
.state_dir
== NULL
);
120 g_assert(dfl_pathnames
.pidfile
== NULL
);
121 dfl_pathnames
.state_dir
= qemu_get_local_state_pathname(
122 QGA_STATE_RELATIVE_DIR
);
123 dfl_pathnames
.pidfile
= qemu_get_local_state_pathname(
124 QGA_STATE_RELATIVE_DIR G_DIR_SEPARATOR_S
"qemu-ga.pid");
127 static void quit_handler(int sig
)
129 /* if we're frozen, don't exit unless we're absolutely forced to,
130 * because it's basically impossible for graceful exit to complete
131 * unless all log/pid files are on unfreezable filesystems. there's
132 * also a very likely chance killing the agent before unfreezing
133 * the filesystems is a mistake (or will be viewed as one later).
134 * On Windows the freeze interval is limited to 10 seconds, so
135 * we should quit, but first we should wait for the timeout, thaw
136 * the filesystem and quit.
138 if (ga_is_frozen(ga_state
)) {
142 HANDLE hEventTimeout
;
144 g_debug("Thawing filesystems before exiting");
146 hEventTimeout
= OpenEvent(EVENT_ALL_ACCESS
, FALSE
, EVENT_NAME_TIMEOUT
);
148 WaitForSingleObject(hEventTimeout
, 0);
149 CloseHandle(hEventTimeout
);
151 qga_vss_fsfreeze(&i
, false, &err
);
153 g_debug("Error unfreezing filesystems prior to exiting: %s",
154 error_get_pretty(err
));
161 g_debug("received signal num %d, quitting", sig
);
163 if (g_main_loop_is_running(ga_state
->main_loop
)) {
164 g_main_loop_quit(ga_state
->main_loop
);
169 static gboolean
register_signal_handlers(void)
171 struct sigaction sigact
;
174 memset(&sigact
, 0, sizeof(struct sigaction
));
175 sigact
.sa_handler
= quit_handler
;
177 ret
= sigaction(SIGINT
, &sigact
, NULL
);
179 g_error("error configuring signal handler: %s", strerror(errno
));
181 ret
= sigaction(SIGTERM
, &sigact
, NULL
);
183 g_error("error configuring signal handler: %s", strerror(errno
));
186 sigact
.sa_handler
= SIG_IGN
;
187 if (sigaction(SIGPIPE
, &sigact
, NULL
) != 0) {
188 g_error("error configuring SIGPIPE signal handler: %s",
195 /* TODO: use this in place of all post-fork() fclose(std*) callers */
196 void reopen_fd_to_null(int fd
)
200 nullfd
= open("/dev/null", O_RDWR
);
213 static void usage(const char *cmd
)
216 "Usage: %s [-m <method> -p <path>] [<options>]\n"
217 "QEMU Guest Agent %s\n"
219 " -m, --method transport method: one of unix-listen, virtio-serial,\n"
220 " isa-serial, or vsock-listen (virtio-serial is the default)\n"
221 " -p, --path device/socket path (the default for virtio-serial is:\n"
223 " the default for isa-serial is:\n"
225 " -l, --logfile set logfile path, logs to stderr by default\n"
226 " -f, --pidfile specify pidfile (default is %s)\n"
227 #ifdef CONFIG_FSFREEZE
228 " -F, --fsfreeze-hook\n"
229 " enable fsfreeze hook. Accepts an optional argument that\n"
230 " specifies script to run on freeze/thaw. Script will be\n"
231 " called with 'freeze'/'thaw' arguments accordingly.\n"
233 " If using -F with an argument, do not follow -F with a\n"
235 " (for example: -F/var/run/fsfreezehook.sh)\n"
237 " -t, --statedir specify dir to store state information (absolute paths\n"
238 " only, default is %s)\n"
239 " -v, --verbose log extra debugging information\n"
240 " -V, --version print version information and exit\n"
241 " -d, --daemonize become a daemon\n"
243 " -s, --service service commands: install, uninstall, vss-install, vss-uninstall\n"
245 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
246 " to list available RPCs)\n"
247 " -D, --dump-conf dump a qemu-ga config file based on current config\n"
248 " options / command-line parameters to stdout\n"
249 " -h, --help display this help and exit\n"
251 "Report bugs to <mdroth@linux.vnet.ibm.com>\n"
252 , cmd
, QEMU_VERSION
, QGA_VIRTIO_PATH_DEFAULT
, QGA_SERIAL_PATH_DEFAULT
,
253 dfl_pathnames
.pidfile
,
254 #ifdef CONFIG_FSFREEZE
255 QGA_FSFREEZE_HOOK_DEFAULT
,
257 dfl_pathnames
.state_dir
);
260 static const char *ga_log_level_str(GLogLevelFlags level
)
262 switch (level
& G_LOG_LEVEL_MASK
) {
263 case G_LOG_LEVEL_ERROR
:
265 case G_LOG_LEVEL_CRITICAL
:
267 case G_LOG_LEVEL_WARNING
:
269 case G_LOG_LEVEL_MESSAGE
:
271 case G_LOG_LEVEL_INFO
:
273 case G_LOG_LEVEL_DEBUG
:
280 bool ga_logging_enabled(GAState
*s
)
282 return s
->logging_enabled
;
285 void ga_disable_logging(GAState
*s
)
287 s
->logging_enabled
= false;
290 void ga_enable_logging(GAState
*s
)
292 s
->logging_enabled
= true;
295 static void ga_log(const gchar
*domain
, GLogLevelFlags level
,
296 const gchar
*msg
, gpointer opaque
)
300 const char *level_str
= ga_log_level_str(level
);
302 if (!ga_logging_enabled(s
)) {
306 level
&= G_LOG_LEVEL_MASK
;
308 if (g_strcmp0(domain
, "syslog") == 0) {
309 syslog(LOG_INFO
, "%s: %s", level_str
, msg
);
310 } else if (level
& s
->log_level
) {
312 if (level
& s
->log_level
) {
314 g_get_current_time(&time
);
316 "%lu.%lu: %s: %s\n", time
.tv_sec
, time
.tv_usec
, level_str
, msg
);
321 void ga_set_response_delimited(GAState
*s
)
323 s
->delimit_response
= true;
326 static FILE *ga_open_logfile(const char *logfile
)
330 f
= fopen(logfile
, "a");
335 qemu_set_cloexec(fileno(f
));
340 static bool ga_open_pidfile(const char *pidfile
)
345 pidfd
= qemu_open(pidfile
, O_CREAT
|O_WRONLY
, S_IRUSR
|S_IWUSR
);
346 if (pidfd
== -1 || lockf(pidfd
, F_TLOCK
, 0)) {
347 g_critical("Cannot lock pid file, %s", strerror(errno
));
354 if (ftruncate(pidfd
, 0)) {
355 g_critical("Failed to truncate pid file");
358 snprintf(pidstr
, sizeof(pidstr
), "%d\n", getpid());
359 if (write(pidfd
, pidstr
, strlen(pidstr
)) != strlen(pidstr
)) {
360 g_critical("Failed to write pid file");
364 /* keep pidfile open & locked forever */
373 static bool ga_open_pidfile(const char *pidfile
)
379 static gint
ga_strcmp(gconstpointer str1
, gconstpointer str2
)
381 return strcmp(str1
, str2
);
384 /* disable commands that aren't safe for fsfreeze */
385 static void ga_disable_non_whitelisted(QmpCommand
*cmd
, void *opaque
)
387 bool whitelisted
= false;
389 const char *name
= qmp_command_name(cmd
);
391 while (ga_freeze_whitelist
[i
] != NULL
) {
392 if (strcmp(name
, ga_freeze_whitelist
[i
]) == 0) {
398 g_debug("disabling command: %s", name
);
399 qmp_disable_command(&ga_commands
, name
);
403 /* [re-]enable all commands, except those explicitly blacklisted by user */
404 static void ga_enable_non_blacklisted(QmpCommand
*cmd
, void *opaque
)
406 GList
*blacklist
= opaque
;
407 const char *name
= qmp_command_name(cmd
);
409 if (g_list_find_custom(blacklist
, name
, ga_strcmp
) == NULL
&&
410 !qmp_command_is_enabled(cmd
)) {
411 g_debug("enabling command: %s", name
);
412 qmp_enable_command(&ga_commands
, name
);
416 static bool ga_create_file(const char *path
)
418 int fd
= open(path
, O_CREAT
| O_WRONLY
, S_IWUSR
| S_IRUSR
);
420 g_warning("unable to open/create file %s: %s", path
, strerror(errno
));
427 static bool ga_delete_file(const char *path
)
429 int ret
= unlink(path
);
431 g_warning("unable to delete file: %s: %s", path
, strerror(errno
));
438 bool ga_is_frozen(GAState
*s
)
443 void ga_set_frozen(GAState
*s
)
445 if (ga_is_frozen(s
)) {
448 /* disable all non-whitelisted (for frozen state) commands */
449 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
450 g_warning("disabling logging due to filesystem freeze");
451 ga_disable_logging(s
);
453 if (!ga_create_file(s
->state_filepath_isfrozen
)) {
454 g_warning("unable to create %s, fsfreeze may not function properly",
455 s
->state_filepath_isfrozen
);
459 void ga_unset_frozen(GAState
*s
)
461 if (!ga_is_frozen(s
)) {
465 /* if we delayed creation/opening of pid/log files due to being
466 * in a frozen state at start up, do it now
468 if (s
->deferred_options
.log_filepath
) {
469 s
->log_file
= ga_open_logfile(s
->deferred_options
.log_filepath
);
471 s
->log_file
= stderr
;
473 s
->deferred_options
.log_filepath
= NULL
;
475 ga_enable_logging(s
);
476 g_warning("logging re-enabled due to filesystem unfreeze");
477 if (s
->deferred_options
.pid_filepath
) {
478 if (!ga_open_pidfile(s
->deferred_options
.pid_filepath
)) {
479 g_warning("failed to create/open pid file");
481 s
->deferred_options
.pid_filepath
= NULL
;
484 /* enable all disabled, non-blacklisted commands */
485 qmp_for_each_command(&ga_commands
, ga_enable_non_blacklisted
, s
->blacklist
);
487 if (!ga_delete_file(s
->state_filepath_isfrozen
)) {
488 g_warning("unable to delete %s, fsfreeze may not function properly",
489 s
->state_filepath_isfrozen
);
493 #ifdef CONFIG_FSFREEZE
494 const char *ga_fsfreeze_hook(GAState
*s
)
496 return s
->fsfreeze_hook
;
500 static void become_daemon(const char *pidfile
)
514 if (!ga_open_pidfile(pidfile
)) {
515 g_critical("failed to create pidfile");
520 umask(S_IRWXG
| S_IRWXO
);
525 if ((chdir("/")) < 0) {
529 reopen_fd_to_null(STDIN_FILENO
);
530 reopen_fd_to_null(STDOUT_FILENO
);
531 reopen_fd_to_null(STDERR_FILENO
);
538 g_critical("failed to daemonize");
543 static int send_response(GAState
*s
, QObject
*payload
)
546 QString
*payload_qstr
, *response_qstr
;
549 g_assert(payload
&& s
->channel
);
551 payload_qstr
= qobject_to_json(payload
);
556 if (s
->delimit_response
) {
557 s
->delimit_response
= false;
558 response_qstr
= qstring_new();
559 qstring_append_chr(response_qstr
, QGA_SENTINEL_BYTE
);
560 qstring_append(response_qstr
, qstring_get_str(payload_qstr
));
561 QDECREF(payload_qstr
);
563 response_qstr
= payload_qstr
;
566 qstring_append_chr(response_qstr
, '\n');
567 buf
= qstring_get_str(response_qstr
);
568 status
= ga_channel_write_all(s
->channel
, buf
, strlen(buf
));
569 QDECREF(response_qstr
);
570 if (status
!= G_IO_STATUS_NORMAL
) {
577 static void process_command(GAState
*s
, QDict
*req
)
583 g_debug("processing command");
584 rsp
= qmp_dispatch(&ga_commands
, QOBJECT(req
));
586 ret
= send_response(s
, rsp
);
588 g_warning("error sending response: %s", strerror(-ret
));
594 /* handle requests/control events coming in over the channel */
595 static void process_event(JSONMessageParser
*parser
, GQueue
*tokens
)
597 GAState
*s
= container_of(parser
, GAState
, parser
);
602 g_assert(s
&& parser
);
604 g_debug("process_event: called");
605 qdict
= qobject_to_qdict(json_parser_parse_err(tokens
, NULL
, &err
));
610 g_warning("failed to parse event: unknown error");
611 error_setg(&err
, QERR_JSON_PARSING
);
613 g_warning("failed to parse event: %s", error_get_pretty(err
));
615 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
619 /* handle host->guest commands */
620 if (qdict_haskey(qdict
, "execute")) {
621 process_command(s
, qdict
);
623 if (!qdict_haskey(qdict
, "error")) {
626 g_warning("unrecognized payload format");
627 error_setg(&err
, QERR_UNSUPPORTED
);
628 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
631 ret
= send_response(s
, QOBJECT(qdict
));
633 g_warning("error sending error response: %s", strerror(-ret
));
640 /* false return signals GAChannel to close the current client connection */
641 static gboolean
channel_event_cb(GIOCondition condition
, gpointer data
)
644 gchar buf
[QGA_READ_COUNT_DEFAULT
+1];
646 GIOStatus status
= ga_channel_read(s
->channel
, buf
, QGA_READ_COUNT_DEFAULT
, &count
);
648 case G_IO_STATUS_ERROR
:
649 g_warning("error reading channel");
651 case G_IO_STATUS_NORMAL
:
653 g_debug("read data, count: %d, data: %s", (int)count
, buf
);
654 json_message_parser_feed(&s
->parser
, (char *)buf
, (int)count
);
656 case G_IO_STATUS_EOF
:
657 g_debug("received EOF");
662 case G_IO_STATUS_AGAIN
:
663 /* virtio causes us to spin here when no process is attached to
664 * host-side chardev. sleep a bit to mitigate this
671 g_warning("unknown channel read status, closing");
677 static gboolean
channel_init(GAState
*s
, const gchar
*method
, const gchar
*path
,
680 GAChannelMethod channel_method
;
682 if (strcmp(method
, "virtio-serial") == 0) {
683 s
->virtio
= true; /* virtio requires special handling in some cases */
684 channel_method
= GA_CHANNEL_VIRTIO_SERIAL
;
685 } else if (strcmp(method
, "isa-serial") == 0) {
686 channel_method
= GA_CHANNEL_ISA_SERIAL
;
687 } else if (strcmp(method
, "unix-listen") == 0) {
688 channel_method
= GA_CHANNEL_UNIX_LISTEN
;
689 } else if (strcmp(method
, "vsock-listen") == 0) {
690 channel_method
= GA_CHANNEL_VSOCK_LISTEN
;
692 g_critical("unsupported channel method/type: %s", method
);
696 s
->channel
= ga_channel_new(channel_method
, path
, listen_fd
,
697 channel_event_cb
, s
);
699 g_critical("failed to create guest agent channel");
707 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
710 DWORD ret
= NO_ERROR
;
711 GAService
*service
= &ga_state
->service
;
715 case SERVICE_CONTROL_STOP
:
716 case SERVICE_CONTROL_SHUTDOWN
:
717 quit_handler(SIGTERM
);
718 service
->status
.dwCurrentState
= SERVICE_STOP_PENDING
;
719 SetServiceStatus(service
->status_handle
, &service
->status
);
723 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
728 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[])
730 GAService
*service
= &ga_state
->service
;
732 service
->status_handle
= RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME
,
733 service_ctrl_handler
, NULL
);
735 if (service
->status_handle
== 0) {
736 g_critical("Failed to register extended requests function!\n");
740 service
->status
.dwServiceType
= SERVICE_WIN32
;
741 service
->status
.dwCurrentState
= SERVICE_RUNNING
;
742 service
->status
.dwControlsAccepted
= SERVICE_ACCEPT_STOP
| SERVICE_ACCEPT_SHUTDOWN
;
743 service
->status
.dwWin32ExitCode
= NO_ERROR
;
744 service
->status
.dwServiceSpecificExitCode
= NO_ERROR
;
745 service
->status
.dwCheckPoint
= 0;
746 service
->status
.dwWaitHint
= 0;
747 SetServiceStatus(service
->status_handle
, &service
->status
);
749 g_main_loop_run(ga_state
->main_loop
);
751 service
->status
.dwCurrentState
= SERVICE_STOPPED
;
752 SetServiceStatus(service
->status_handle
, &service
->status
);
756 static void set_persistent_state_defaults(GAPersistentState
*pstate
)
759 pstate
->fd_counter
= QGA_PSTATE_DEFAULT_FD_COUNTER
;
762 static void persistent_state_from_keyfile(GAPersistentState
*pstate
,
767 /* if any fields are missing, either because the file was tampered with
768 * by agents of chaos, or because the field wasn't present at the time the
769 * file was created, the best we can ever do is start over with the default
770 * values. so load them now, and ignore any errors in accessing key-value
773 set_persistent_state_defaults(pstate
);
775 if (g_key_file_has_key(keyfile
, "global", "fd_counter", NULL
)) {
777 g_key_file_get_integer(keyfile
, "global", "fd_counter", NULL
);
781 static void persistent_state_to_keyfile(const GAPersistentState
*pstate
,
787 g_key_file_set_integer(keyfile
, "global", "fd_counter", pstate
->fd_counter
);
790 static gboolean
write_persistent_state(const GAPersistentState
*pstate
,
793 GKeyFile
*keyfile
= g_key_file_new();
801 persistent_state_to_keyfile(pstate
, keyfile
);
802 data
= g_key_file_to_data(keyfile
, &data_len
, &gerr
);
804 g_critical("failed to convert persistent state to string: %s",
810 g_file_set_contents(path
, data
, data_len
, &gerr
);
812 g_critical("failed to write persistent state to %s: %s",
813 path
, gerr
->message
);
823 g_key_file_free(keyfile
);
829 static gboolean
read_persistent_state(GAPersistentState
*pstate
,
830 const gchar
*path
, gboolean frozen
)
832 GKeyFile
*keyfile
= NULL
;
839 if (stat(path
, &st
) == -1) {
840 /* it's okay if state file doesn't exist, but any other error
841 * indicates a permissions issue or some other misconfiguration
842 * that we likely won't be able to recover from.
844 if (errno
!= ENOENT
) {
845 g_critical("unable to access state file at path %s: %s",
846 path
, strerror(errno
));
851 /* file doesn't exist. initialize state to default values and
852 * attempt to save now. (we could wait till later when we have
853 * modified state we need to commit, but if there's a problem,
854 * such as a missing parent directory, we want to catch it now)
856 * there is a potential scenario where someone either managed to
857 * update the agent from a version that didn't use a key store
858 * while qemu-ga thought the filesystem was frozen, or
859 * deleted the key store prior to issuing a fsfreeze, prior
860 * to restarting the agent. in this case we go ahead and defer
861 * initial creation till we actually have modified state to
862 * write, otherwise fail to recover from freeze.
864 set_persistent_state_defaults(pstate
);
866 ret
= write_persistent_state(pstate
, path
);
868 g_critical("unable to create state file at path %s", path
);
877 keyfile
= g_key_file_new();
878 g_key_file_load_from_file(keyfile
, path
, 0, &gerr
);
880 g_critical("error loading persistent state from path: %s, %s",
881 path
, gerr
->message
);
886 persistent_state_from_keyfile(pstate
, keyfile
);
890 g_key_file_free(keyfile
);
899 int64_t ga_get_fd_handle(GAState
*s
, Error
**errp
)
903 g_assert(s
->pstate_filepath
);
904 /* we blacklist commands and avoid operations that potentially require
905 * writing to disk when we're in a frozen state. this includes opening
906 * new files, so we should never get here in that situation
908 g_assert(!ga_is_frozen(s
));
910 handle
= s
->pstate
.fd_counter
++;
912 /* This should never happen on a reasonable timeframe, as guest-file-open
913 * would have to be issued 2^63 times */
914 if (s
->pstate
.fd_counter
== INT64_MAX
) {
918 if (!write_persistent_state(&s
->pstate
, s
->pstate_filepath
)) {
919 error_setg(errp
, "failed to commit persistent state to disk");
926 static void ga_print_cmd(QmpCommand
*cmd
, void *opaque
)
928 printf("%s\n", qmp_command_name(cmd
));
931 static GList
*split_list(const gchar
*str
, const gchar
*delim
)
937 strv
= g_strsplit(str
, delim
, -1);
938 for (i
= 0; strv
[i
]; i
++) {
939 list
= g_list_prepend(list
, strv
[i
]);
946 typedef struct GAConfig
{
951 #ifdef CONFIG_FSFREEZE
958 gchar
*bliststr
; /* blacklist may point to this string */
961 GLogLevelFlags log_level
;
965 static void config_load(GAConfig
*config
)
969 const char *conf
= g_getenv("QGA_CONF") ?: QGA_CONF_DEFAULT
;
971 /* read system config */
972 keyfile
= g_key_file_new();
973 if (!g_key_file_load_from_file(keyfile
, conf
, 0, &gerr
)) {
976 if (g_key_file_has_key(keyfile
, "general", "daemon", NULL
)) {
978 g_key_file_get_boolean(keyfile
, "general", "daemon", &gerr
);
980 if (g_key_file_has_key(keyfile
, "general", "method", NULL
)) {
982 g_key_file_get_string(keyfile
, "general", "method", &gerr
);
984 if (g_key_file_has_key(keyfile
, "general", "path", NULL
)) {
985 config
->channel_path
=
986 g_key_file_get_string(keyfile
, "general", "path", &gerr
);
988 if (g_key_file_has_key(keyfile
, "general", "logfile", NULL
)) {
989 config
->log_filepath
=
990 g_key_file_get_string(keyfile
, "general", "logfile", &gerr
);
992 if (g_key_file_has_key(keyfile
, "general", "pidfile", NULL
)) {
993 config
->pid_filepath
=
994 g_key_file_get_string(keyfile
, "general", "pidfile", &gerr
);
996 #ifdef CONFIG_FSFREEZE
997 if (g_key_file_has_key(keyfile
, "general", "fsfreeze-hook", NULL
)) {
998 config
->fsfreeze_hook
=
999 g_key_file_get_string(keyfile
,
1000 "general", "fsfreeze-hook", &gerr
);
1003 if (g_key_file_has_key(keyfile
, "general", "statedir", NULL
)) {
1005 g_key_file_get_string(keyfile
, "general", "statedir", &gerr
);
1007 if (g_key_file_has_key(keyfile
, "general", "verbose", NULL
) &&
1008 g_key_file_get_boolean(keyfile
, "general", "verbose", &gerr
)) {
1009 /* enable all log levels */
1010 config
->log_level
= G_LOG_LEVEL_MASK
;
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 QGA_CONF_DEFAULT
, 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 tmp
= list_join(config
->blacklist
, ',');
1074 g_key_file_set_string(keyfile
, "general", "blacklist", tmp
);
1077 tmp
= g_key_file_to_data(keyfile
, NULL
, &error
);
1081 g_key_file_free(keyfile
);
1084 static void config_parse(GAConfig
*config
, int argc
, char **argv
)
1086 const char *sopt
= "hVvdm:p:l:f:F::b:s:t:D";
1087 int opt_ind
= 0, ch
;
1088 const struct option lopt
[] = {
1089 { "help", 0, NULL
, 'h' },
1090 { "version", 0, NULL
, 'V' },
1091 { "dump-conf", 0, NULL
, 'D' },
1092 { "logfile", 1, NULL
, 'l' },
1093 { "pidfile", 1, NULL
, 'f' },
1094 #ifdef CONFIG_FSFREEZE
1095 { "fsfreeze-hook", 2, NULL
, 'F' },
1097 { "verbose", 0, NULL
, 'v' },
1098 { "method", 1, NULL
, 'm' },
1099 { "path", 1, NULL
, 'p' },
1100 { "daemonize", 0, NULL
, 'd' },
1101 { "blacklist", 1, NULL
, 'b' },
1103 { "service", 1, NULL
, 's' },
1105 { "statedir", 1, NULL
, 't' },
1106 { NULL
, 0, NULL
, 0 }
1109 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
1112 g_free(config
->method
);
1113 config
->method
= g_strdup(optarg
);
1116 g_free(config
->channel_path
);
1117 config
->channel_path
= g_strdup(optarg
);
1120 g_free(config
->log_filepath
);
1121 config
->log_filepath
= g_strdup(optarg
);
1124 g_free(config
->pid_filepath
);
1125 config
->pid_filepath
= g_strdup(optarg
);
1127 #ifdef CONFIG_FSFREEZE
1129 g_free(config
->fsfreeze_hook
);
1130 config
->fsfreeze_hook
= g_strdup(optarg
?: QGA_FSFREEZE_HOOK_DEFAULT
);
1134 g_free(config
->state_dir
);
1135 config
->state_dir
= g_strdup(optarg
);
1138 /* enable all log levels */
1139 config
->log_level
= G_LOG_LEVEL_MASK
;
1142 printf("QEMU Guest Agent %s\n", QEMU_VERSION
);
1145 config
->daemonize
= 1;
1148 config
->dumpconf
= 1;
1151 if (is_help_option(optarg
)) {
1152 qmp_for_each_command(&ga_commands
, ga_print_cmd
, NULL
);
1155 config
->blacklist
= g_list_concat(config
->blacklist
,
1156 split_list(optarg
, ","));
1161 config
->service
= optarg
;
1162 if (strcmp(config
->service
, "install") == 0) {
1163 if (ga_install_vss_provider()) {
1166 if (ga_install_service(config
->channel_path
,
1167 config
->log_filepath
, config
->state_dir
)) {
1171 } else if (strcmp(config
->service
, "uninstall") == 0) {
1172 ga_uninstall_vss_provider();
1173 exit(ga_uninstall_service());
1174 } else if (strcmp(config
->service
, "vss-install") == 0) {
1175 if (ga_install_vss_provider()) {
1179 } else if (strcmp(config
->service
, "vss-uninstall") == 0) {
1180 ga_uninstall_vss_provider();
1183 printf("Unknown service command.\n");
1192 g_print("Unknown option, try '%s --help' for more information.\n",
1199 static void config_free(GAConfig
*config
)
1201 g_free(config
->method
);
1202 g_free(config
->log_filepath
);
1203 g_free(config
->pid_filepath
);
1204 g_free(config
->state_dir
);
1205 g_free(config
->channel_path
);
1206 g_free(config
->bliststr
);
1207 #ifdef CONFIG_FSFREEZE
1208 g_free(config
->fsfreeze_hook
);
1210 g_list_free_full(config
->blacklist
, g_free
);
1214 static bool check_is_frozen(GAState
*s
)
1217 /* check if a previous instance of qemu-ga exited with filesystems' state
1218 * marked as frozen. this could be a stale value (a non-qemu-ga process
1219 * or reboot may have since unfrozen them), but better to require an
1220 * uneeded unfreeze than to risk hanging on start-up
1223 if (stat(s
->state_filepath_isfrozen
, &st
) == -1) {
1224 /* it's okay if the file doesn't exist, but if we can't access for
1225 * some other reason, such as permissions, there's a configuration
1226 * that needs to be addressed. so just bail now before we get into
1227 * more trouble later
1229 if (errno
!= ENOENT
) {
1230 g_critical("unable to access state file at path %s: %s",
1231 s
->state_filepath_isfrozen
, strerror(errno
));
1232 return EXIT_FAILURE
;
1235 g_warning("previous instance appears to have exited with frozen"
1236 " filesystems. deferring logging/pidfile creation and"
1237 " disabling non-fsfreeze-safe commands until"
1238 " guest-fsfreeze-thaw is issued, or filesystems are"
1239 " manually unfrozen and the file %s is removed",
1240 s
->state_filepath_isfrozen
);
1247 static int run_agent(GAState
*s
, GAConfig
*config
, int socket_activation
)
1251 g_log_set_default_handler(ga_log
, s
);
1252 g_log_set_fatal_mask(NULL
, G_LOG_LEVEL_ERROR
);
1253 ga_enable_logging(s
);
1256 /* On win32 the state directory is application specific (be it the default
1257 * or a user override). We got past the command line parsing; let's create
1258 * the directory (with any intermediate directories). If we run into an
1259 * error later on, we won't try to clean up the directory, it is considered
1262 if (g_mkdir_with_parents(config
->state_dir
, S_IRWXU
) == -1) {
1263 g_critical("unable to create (an ancestor of) the state directory"
1264 " '%s': %s", config
->state_dir
, strerror(errno
));
1265 return EXIT_FAILURE
;
1269 if (ga_is_frozen(s
)) {
1270 if (config
->daemonize
) {
1271 /* delay opening/locking of pidfile till filesystems are unfrozen */
1272 s
->deferred_options
.pid_filepath
= config
->pid_filepath
;
1273 become_daemon(NULL
);
1275 if (config
->log_filepath
) {
1276 /* delay opening the log file till filesystems are unfrozen */
1277 s
->deferred_options
.log_filepath
= config
->log_filepath
;
1279 ga_disable_logging(s
);
1280 qmp_for_each_command(&ga_commands
, ga_disable_non_whitelisted
, NULL
);
1282 if (config
->daemonize
) {
1283 become_daemon(config
->pid_filepath
);
1285 if (config
->log_filepath
) {
1286 FILE *log_file
= ga_open_logfile(config
->log_filepath
);
1288 g_critical("unable to open specified log file: %s",
1290 return EXIT_FAILURE
;
1292 s
->log_file
= log_file
;
1296 /* load persistent state from disk */
1297 if (!read_persistent_state(&s
->pstate
,
1300 g_critical("failed to load persistent state");
1301 return EXIT_FAILURE
;
1304 config
->blacklist
= ga_command_blacklist_init(config
->blacklist
);
1305 if (config
->blacklist
) {
1306 GList
*l
= config
->blacklist
;
1307 s
->blacklist
= config
->blacklist
;
1309 g_debug("disabling command: %s", (char *)l
->data
);
1310 qmp_disable_command(&ga_commands
, l
->data
);
1314 s
->command_state
= ga_command_state_new();
1315 ga_command_state_init(s
, s
->command_state
);
1316 ga_command_state_init_all(s
->command_state
);
1317 json_message_parser_init(&s
->parser
, process_event
);
1320 if (!register_signal_handlers()) {
1321 g_critical("failed to register signal handlers");
1322 return EXIT_FAILURE
;
1326 s
->main_loop
= g_main_loop_new(NULL
, false);
1328 if (!channel_init(ga_state
, config
->method
, config
->channel_path
,
1329 socket_activation
? FIRST_SOCKET_ACTIVATION_FD
: -1)) {
1330 g_critical("failed to initialize guest agent channel");
1331 return EXIT_FAILURE
;
1334 g_main_loop_run(ga_state
->main_loop
);
1336 if (config
->daemonize
) {
1337 SERVICE_TABLE_ENTRY service_table
[] = {
1338 { (char *)QGA_SERVICE_NAME
, service_main
}, { NULL
, NULL
} };
1339 StartServiceCtrlDispatcher(service_table
);
1341 g_main_loop_run(ga_state
->main_loop
);
1345 return EXIT_SUCCESS
;
1348 int main(int argc
, char **argv
)
1350 int ret
= EXIT_SUCCESS
;
1351 GAState
*s
= g_new0(GAState
, 1);
1352 GAConfig
*config
= g_new0(GAConfig
, 1);
1353 int socket_activation
;
1355 config
->log_level
= G_LOG_LEVEL_ERROR
| G_LOG_LEVEL_CRITICAL
;
1357 qga_qmp_init_marshal(&ga_commands
);
1359 init_dfl_pathnames();
1360 config_load(config
);
1361 config_parse(config
, argc
, argv
);
1363 if (config
->pid_filepath
== NULL
) {
1364 config
->pid_filepath
= g_strdup(dfl_pathnames
.pidfile
);
1367 if (config
->state_dir
== NULL
) {
1368 config
->state_dir
= g_strdup(dfl_pathnames
.state_dir
);
1371 if (config
->method
== NULL
) {
1372 config
->method
= g_strdup("virtio-serial");
1375 socket_activation
= check_socket_activation();
1376 if (socket_activation
> 1) {
1377 g_critical("qemu-ga only supports listening on one socket");
1381 if (socket_activation
) {
1382 SocketAddress
*addr
;
1384 g_free(config
->method
);
1385 g_free(config
->channel_path
);
1386 config
->method
= NULL
;
1387 config
->channel_path
= NULL
;
1389 addr
= socket_local_address(FIRST_SOCKET_ACTIVATION_FD
, NULL
);
1391 if (addr
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
1392 config
->method
= g_strdup("unix-listen");
1393 } else if (addr
->type
== SOCKET_ADDRESS_TYPE_VSOCK
) {
1394 config
->method
= g_strdup("vsock-listen");
1397 qapi_free_SocketAddress(addr
);
1400 if (!config
->method
) {
1401 g_critical("unsupported listen fd type");
1405 } else if (config
->channel_path
== NULL
) {
1406 if (strcmp(config
->method
, "virtio-serial") == 0) {
1407 /* try the default path for the virtio-serial port */
1408 config
->channel_path
= g_strdup(QGA_VIRTIO_PATH_DEFAULT
);
1409 } else if (strcmp(config
->method
, "isa-serial") == 0) {
1410 /* try the default path for the serial port - COM1 */
1411 config
->channel_path
= g_strdup(QGA_SERIAL_PATH_DEFAULT
);
1413 g_critical("must specify a path for this channel");
1419 s
->log_level
= config
->log_level
;
1420 s
->log_file
= stderr
;
1421 #ifdef CONFIG_FSFREEZE
1422 s
->fsfreeze_hook
= config
->fsfreeze_hook
;
1424 s
->pstate_filepath
= g_strdup_printf("%s/qga.state", config
->state_dir
);
1425 s
->state_filepath_isfrozen
= g_strdup_printf("%s/qga.state.isfrozen",
1427 s
->frozen
= check_is_frozen(s
);
1429 if (config
->dumpconf
) {
1430 config_dump(config
);
1434 ret
= run_agent(s
, config
, socket_activation
);
1437 if (s
->command_state
) {
1438 ga_command_state_cleanup_all(s
->command_state
);
1439 ga_command_state_free(s
->command_state
);
1440 json_message_parser_destroy(&s
->parser
);
1443 ga_channel_free(s
->channel
);
1445 g_free(s
->pstate_filepath
);
1446 g_free(s
->state_filepath_isfrozen
);
1448 if (config
->daemonize
) {
1449 unlink(config
->pid_filepath
);
1452 config_free(config
);
1454 g_main_loop_unref(s
->main_loop
);