4 * Copyright IBM Corp. 2011
10 * This work is licensed under the terms of the GNU GPL, version 2 or later.
11 * See the COPYING file in the top-level directory.
23 #include "json-streamer.h"
24 #include "json-parser.h"
27 #include "qga/guest-agent-core.h"
31 #include "qapi/qmp-core.h"
32 #include "qga/channel.h"
34 #include "qga/service-win32.h"
39 #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
41 #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
43 #define QGA_PIDFILE_DEFAULT "/var/run/qemu-ga.pid"
44 #define QGA_STATEDIR_DEFAULT "/tmp"
45 #define QGA_SENTINEL_BYTE 0xFF
48 JSONMessageParser parser;
51 bool virtio; /* fastpath to check for virtio to deal with poll() quirks */
52 GACommandState *command_state;
53 GLogLevelFlags log_level;
59 bool delimit_response;
62 const char *state_filepath_isfrozen;
64 const char *log_filepath;
65 const char *pid_filepath;
69 struct GAState *ga_state;
71 /* commands that are safe to issue while filesystems are frozen */
72 static const char *ga_freeze_whitelist[] = {
76 "guest-fsfreeze-status",
77 "guest-fsfreeze-thaw",
82 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
84 VOID WINAPI service_main(DWORD argc, TCHAR *argv[]);
87 static void quit_handler(int sig)
89 /* if we're frozen, don't exit unless we're absolutely forced to,
90 * because it's basically impossible for graceful exit to complete
91 * unless all log/pid files are on unfreezable filesystems. there's
92 * also a very likely chance killing the agent before unfreezing
93 * the filesystems is a mistake (or will be viewed as one later).
95 if (ga_is_frozen(ga_state)) {
98 g_debug("received signal num %d, quitting", sig);
100 if (g_main_loop_is_running(ga_state->main_loop)) {
101 g_main_loop_quit(ga_state->main_loop);
106 static gboolean register_signal_handlers(void)
108 struct sigaction sigact;
111 memset(&sigact, 0, sizeof(struct sigaction));
112 sigact.sa_handler = quit_handler;
114 ret = sigaction(SIGINT, &sigact, NULL);
116 g_error("error configuring signal handler: %s", strerror(errno));
119 ret = sigaction(SIGTERM, &sigact, NULL);
121 g_error("error configuring signal handler: %s", strerror(errno));
128 /* TODO: use this in place of all post-fork() fclose(std*) callers */
129 void reopen_fd_to_null(int fd)
133 nullfd = open("/dev/null", O_RDWR);
146 static void usage(const char *cmd)
149 "Usage: %s [-m <method> -p <path>] [<options>]\n"
150 "QEMU Guest Agent %s\n"
152 " -m, --method transport method: one of unix-listen, virtio-serial, or\n"
153 " isa-serial (virtio-serial is the default)\n"
154 " -p, --path device/socket path (the default for virtio-serial is:\n"
156 " -l, --logfile set logfile path, logs to stderr by default\n"
157 " -f, --pidfile specify pidfile (default is %s)\n"
158 " -t, --statedir specify dir to store state information (absolute paths\n"
159 " only, default is %s)\n"
160 " -v, --verbose log extra debugging information\n"
161 " -V, --version print version information and exit\n"
162 " -d, --daemonize become a daemon\n"
164 " -s, --service service commands: install, uninstall\n"
166 " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
167 " to list available RPCs)\n"
168 " -h, --help display this help and exit\n"
171 , cmd, QEMU_VERSION, QGA_VIRTIO_PATH_DEFAULT, QGA_PIDFILE_DEFAULT,
172 QGA_STATEDIR_DEFAULT);
175 static const char *ga_log_level_str(GLogLevelFlags level)
177 switch (level & G_LOG_LEVEL_MASK) {
178 case G_LOG_LEVEL_ERROR:
180 case G_LOG_LEVEL_CRITICAL:
182 case G_LOG_LEVEL_WARNING:
184 case G_LOG_LEVEL_MESSAGE:
186 case G_LOG_LEVEL_INFO:
188 case G_LOG_LEVEL_DEBUG:
195 bool ga_logging_enabled(GAState *s)
197 return s->logging_enabled;
200 void ga_disable_logging(GAState *s)
202 s->logging_enabled = false;
205 void ga_enable_logging(GAState *s)
207 s->logging_enabled = true;
210 static void ga_log(const gchar *domain, GLogLevelFlags level,
211 const gchar *msg, gpointer opaque)
215 const char *level_str = ga_log_level_str(level);
217 if (!ga_logging_enabled(s)) {
221 level &= G_LOG_LEVEL_MASK;
223 if (domain && strcmp(domain, "syslog") == 0) {
224 syslog(LOG_INFO, "%s: %s", level_str, msg);
225 } else if (level & s->log_level) {
227 if (level & s->log_level) {
229 g_get_current_time(&time);
231 "%lu.%lu: %s: %s\n", time.tv_sec, time.tv_usec, level_str, msg);
236 void ga_set_response_delimited(GAState *s)
238 s->delimit_response = true;
242 static bool ga_open_pidfile(const char *pidfile)
247 pidfd = open(pidfile, O_CREAT|O_WRONLY, S_IRUSR|S_IWUSR);
248 if (pidfd == -1 || lockf(pidfd, F_TLOCK, 0)) {
249 g_critical("Cannot lock pid file, %s", strerror(errno));
256 if (ftruncate(pidfd, 0) || lseek(pidfd, 0, SEEK_SET)) {
257 g_critical("Failed to truncate pid file");
260 sprintf(pidstr, "%d", getpid());
261 if (write(pidfd, pidstr, strlen(pidstr)) != strlen(pidstr)) {
262 g_critical("Failed to write pid file");
273 static bool ga_open_pidfile(const char *pidfile)
279 static gint ga_strcmp(gconstpointer str1, gconstpointer str2)
281 return strcmp(str1, str2);
284 /* disable commands that aren't safe for fsfreeze */
285 static void ga_disable_non_whitelisted(void)
287 char **list_head, **list;
291 list_head = list = qmp_get_command_list();
292 while (*list != NULL) {
295 while (ga_freeze_whitelist[i] != NULL) {
296 if (strcmp(*list, ga_freeze_whitelist[i]) == 0) {
302 g_debug("disabling command: %s", *list);
303 qmp_disable_command(*list);
311 /* [re-]enable all commands, except those explicitly blacklisted by user */
312 static void ga_enable_non_blacklisted(GList *blacklist)
314 char **list_head, **list;
316 list_head = list = qmp_get_command_list();
317 while (*list != NULL) {
318 if (g_list_find_custom(blacklist, *list, ga_strcmp) == NULL &&
319 !qmp_command_is_enabled(*list)) {
320 g_debug("enabling command: %s", *list);
321 qmp_enable_command(*list);
329 static bool ga_create_file(const char *path)
331 int fd = open(path, O_CREAT | O_WRONLY, S_IWUSR | S_IRUSR);
333 g_warning("unable to open/create file %s: %s", path, strerror(errno));
340 static bool ga_delete_file(const char *path)
342 int ret = unlink(path);
344 g_warning("unable to delete file: %s: %s", path, strerror(errno));
351 bool ga_is_frozen(GAState *s)
356 void ga_set_frozen(GAState *s)
358 if (ga_is_frozen(s)) {
361 /* disable all non-whitelisted (for frozen state) commands */
362 ga_disable_non_whitelisted();
363 g_warning("disabling logging due to filesystem freeze");
364 ga_disable_logging(s);
366 if (!ga_create_file(s->state_filepath_isfrozen)) {
367 g_warning("unable to create %s, fsfreeze may not function properly",
368 s->state_filepath_isfrozen);
372 void ga_unset_frozen(GAState *s)
374 if (!ga_is_frozen(s)) {
378 /* if we delayed creation/opening of pid/log files due to being
379 * in a frozen state at start up, do it now
381 if (s->deferred_options.log_filepath) {
382 s->log_file = fopen(s->deferred_options.log_filepath, "a");
384 s->log_file = stderr;
386 s->deferred_options.log_filepath = NULL;
388 ga_enable_logging(s);
389 g_warning("logging re-enabled due to filesystem unfreeze");
390 if (s->deferred_options.pid_filepath) {
391 if (!ga_open_pidfile(s->deferred_options.pid_filepath)) {
392 g_warning("failed to create/open pid file");
394 s->deferred_options.pid_filepath = NULL;
397 /* enable all disabled, non-blacklisted commands */
398 ga_enable_non_blacklisted(s->blacklist);
400 if (!ga_delete_file(s->state_filepath_isfrozen)) {
401 g_warning("unable to delete %s, fsfreeze may not function properly",
402 s->state_filepath_isfrozen);
406 static void become_daemon(const char *pidfile)
420 if (!ga_open_pidfile(pidfile)) {
421 g_critical("failed to create pidfile");
431 if ((chdir("/")) < 0) {
435 reopen_fd_to_null(STDIN_FILENO);
436 reopen_fd_to_null(STDOUT_FILENO);
437 reopen_fd_to_null(STDERR_FILENO);
444 g_critical("failed to daemonize");
449 static int send_response(GAState *s, QObject *payload)
452 QString *payload_qstr, *response_qstr;
455 g_assert(payload && s->channel);
457 payload_qstr = qobject_to_json(payload);
462 if (s->delimit_response) {
463 s->delimit_response = false;
464 response_qstr = qstring_new();
465 qstring_append_chr(response_qstr, QGA_SENTINEL_BYTE);
466 qstring_append(response_qstr, qstring_get_str(payload_qstr));
467 QDECREF(payload_qstr);
469 response_qstr = payload_qstr;
472 qstring_append_chr(response_qstr, '\n');
473 buf = qstring_get_str(response_qstr);
474 status = ga_channel_write_all(s->channel, buf, strlen(buf));
475 QDECREF(response_qstr);
476 if (status != G_IO_STATUS_NORMAL) {
483 static void process_command(GAState *s, QDict *req)
489 g_debug("processing command");
490 rsp = qmp_dispatch(QOBJECT(req));
492 ret = send_response(s, rsp);
494 g_warning("error sending response: %s", strerror(ret));
500 /* handle requests/control events coming in over the channel */
501 static void process_event(JSONMessageParser *parser, QList *tokens)
503 GAState *s = container_of(parser, GAState, parser);
509 g_assert(s && parser);
511 g_debug("process_event: called");
512 obj = json_parser_parse_err(tokens, NULL, &err);
513 if (err || !obj || qobject_type(obj) != QTYPE_QDICT) {
517 g_warning("failed to parse event: unknown error");
518 error_set(&err, QERR_JSON_PARSING);
520 g_warning("failed to parse event: %s", error_get_pretty(err));
522 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
525 qdict = qobject_to_qdict(obj);
530 /* handle host->guest commands */
531 if (qdict_haskey(qdict, "execute")) {
532 process_command(s, qdict);
534 if (!qdict_haskey(qdict, "error")) {
537 g_warning("unrecognized payload format");
538 error_set(&err, QERR_UNSUPPORTED);
539 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
542 ret = send_response(s, QOBJECT(qdict));
544 g_warning("error sending error response: %s", strerror(ret));
551 /* false return signals GAChannel to close the current client connection */
552 static gboolean channel_event_cb(GIOCondition condition, gpointer data)
555 gchar buf[QGA_READ_COUNT_DEFAULT+1];
558 GIOStatus status = ga_channel_read(s->channel, buf, QGA_READ_COUNT_DEFAULT, &count);
560 g_warning("error reading channel: %s", err->message);
565 case G_IO_STATUS_ERROR:
566 g_warning("error reading channel");
568 case G_IO_STATUS_NORMAL:
570 g_debug("read data, count: %d, data: %s", (int)count, buf);
571 json_message_parser_feed(&s->parser, (char *)buf, (int)count);
573 case G_IO_STATUS_EOF:
574 g_debug("received EOF");
578 case G_IO_STATUS_AGAIN:
579 /* virtio causes us to spin here when no process is attached to
580 * host-side chardev. sleep a bit to mitigate this
587 g_warning("unknown channel read status, closing");
593 static gboolean channel_init(GAState *s, const gchar *method, const gchar *path)
595 GAChannelMethod channel_method;
597 if (method == NULL) {
598 method = "virtio-serial";
602 if (strcmp(method, "virtio-serial") != 0) {
603 g_critical("must specify a path for this channel");
606 /* try the default path for the virtio-serial port */
607 path = QGA_VIRTIO_PATH_DEFAULT;
610 if (strcmp(method, "virtio-serial") == 0) {
611 s->virtio = true; /* virtio requires special handling in some cases */
612 channel_method = GA_CHANNEL_VIRTIO_SERIAL;
613 } else if (strcmp(method, "isa-serial") == 0) {
614 channel_method = GA_CHANNEL_ISA_SERIAL;
615 } else if (strcmp(method, "unix-listen") == 0) {
616 channel_method = GA_CHANNEL_UNIX_LISTEN;
618 g_critical("unsupported channel method/type: %s", method);
622 s->channel = ga_channel_new(channel_method, path, channel_event_cb, s);
624 g_critical("failed to create guest agent channel");
632 DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
635 DWORD ret = NO_ERROR;
636 GAService *service = &ga_state->service;
640 case SERVICE_CONTROL_STOP:
641 case SERVICE_CONTROL_SHUTDOWN:
642 quit_handler(SIGTERM);
643 service->status.dwCurrentState = SERVICE_STOP_PENDING;
644 SetServiceStatus(service->status_handle, &service->status);
648 ret = ERROR_CALL_NOT_IMPLEMENTED;
653 VOID WINAPI service_main(DWORD argc, TCHAR *argv[])
655 GAService *service = &ga_state->service;
657 service->status_handle = RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME,
658 service_ctrl_handler, NULL);
660 if (service->status_handle == 0) {
661 g_critical("Failed to register extended requests function!\n");
665 service->status.dwServiceType = SERVICE_WIN32;
666 service->status.dwCurrentState = SERVICE_RUNNING;
667 service->status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN;
668 service->status.dwWin32ExitCode = NO_ERROR;
669 service->status.dwServiceSpecificExitCode = NO_ERROR;
670 service->status.dwCheckPoint = 0;
671 service->status.dwWaitHint = 0;
672 SetServiceStatus(service->status_handle, &service->status);
674 g_main_loop_run(ga_state->main_loop);
676 service->status.dwCurrentState = SERVICE_STOPPED;
677 SetServiceStatus(service->status_handle, &service->status);
681 int main(int argc, char **argv)
683 const char *sopt = "hVvdm:p:l:f:b:s:t:";
684 const char *method = NULL, *path = NULL;
685 const char *log_filepath = NULL;
686 const char *pid_filepath = QGA_PIDFILE_DEFAULT;
687 const char *state_dir = QGA_STATEDIR_DEFAULT;
689 const char *service = NULL;
691 const struct option lopt[] = {
692 { "help", 0, NULL, 'h' },
693 { "version", 0, NULL, 'V' },
694 { "logfile", 1, NULL, 'l' },
695 { "pidfile", 1, NULL, 'f' },
696 { "verbose", 0, NULL, 'v' },
697 { "method", 1, NULL, 'm' },
698 { "path", 1, NULL, 'p' },
699 { "daemonize", 0, NULL, 'd' },
700 { "blacklist", 1, NULL, 'b' },
702 { "service", 1, NULL, 's' },
704 { "statedir", 1, NULL, 't' },
707 int opt_ind = 0, ch, daemonize = 0, i, j, len;
708 GLogLevelFlags log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL;
709 GList *blacklist = NULL;
712 module_call_init(MODULE_INIT_QAPI);
714 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
723 log_filepath = optarg;
726 pid_filepath = optarg;
732 /* enable all log levels */
733 log_level = G_LOG_LEVEL_MASK;
736 printf("QEMU Guest Agent %s\n", QEMU_VERSION);
742 char **list_head, **list;
743 if (is_help_option(optarg)) {
744 list_head = list = qmp_get_command_list();
745 while (*list != NULL) {
746 printf("%s\n", *list);
753 for (j = 0, i = 0, len = strlen(optarg); i < len; i++) {
754 if (optarg[i] == ',') {
756 blacklist = g_list_append(blacklist, &optarg[j]);
761 blacklist = g_list_append(blacklist, &optarg[j]);
768 if (strcmp(service, "install") == 0) {
769 return ga_install_service(path, log_filepath);
770 } else if (strcmp(service, "uninstall") == 0) {
771 return ga_uninstall_service();
773 printf("Unknown service command.\n");
782 g_print("Unknown option, try '%s --help' for more information.\n",
788 s = g_malloc0(sizeof(GAState));
789 s->log_level = log_level;
790 s->log_file = stderr;
791 g_log_set_default_handler(ga_log, s);
792 g_log_set_fatal_mask(NULL, G_LOG_LEVEL_ERROR);
793 ga_enable_logging(s);
794 s->state_filepath_isfrozen = g_strdup_printf("%s/qga.state.isfrozen",
798 /* check if a previous instance of qemu-ga exited with filesystems' state
799 * marked as frozen. this could be a stale value (a non-qemu-ga process
800 * or reboot may have since unfrozen them), but better to require an
801 * uneeded unfreeze than to risk hanging on start-up
804 if (stat(s->state_filepath_isfrozen, &st) == -1) {
805 /* it's okay if the file doesn't exist, but if we can't access for
806 * some other reason, such as permissions, there's a configuration
807 * that needs to be addressed. so just bail now before we get into
810 if (errno != ENOENT) {
811 g_critical("unable to access state file at path %s: %s",
812 s->state_filepath_isfrozen, strerror(errno));
816 g_warning("previous instance appears to have exited with frozen"
817 " filesystems. deferring logging/pidfile creation and"
818 " disabling non-fsfreeze-safe commands until"
819 " guest-fsfreeze-thaw is issued, or filesystems are"
820 " manually unfrozen and the file %s is removed",
821 s->state_filepath_isfrozen);
826 if (ga_is_frozen(s)) {
828 /* delay opening/locking of pidfile till filesystem are unfrozen */
829 s->deferred_options.pid_filepath = pid_filepath;
833 /* delay opening the log file till filesystems are unfrozen */
834 s->deferred_options.log_filepath = log_filepath;
836 ga_disable_logging(s);
837 ga_disable_non_whitelisted();
840 become_daemon(pid_filepath);
843 FILE *log_file = fopen(log_filepath, "a");
845 g_critical("unable to open specified log file: %s",
849 s->log_file = log_file;
854 s->blacklist = blacklist;
856 g_debug("disabling command: %s", (char *)blacklist->data);
857 qmp_disable_command(blacklist->data);
858 blacklist = g_list_next(blacklist);
861 s->command_state = ga_command_state_new();
862 ga_command_state_init(s, s->command_state);
863 ga_command_state_init_all(s->command_state);
864 json_message_parser_init(&s->parser, process_event);
867 if (!register_signal_handlers()) {
868 g_critical("failed to register signal handlers");
873 s->main_loop = g_main_loop_new(NULL, false);
874 if (!channel_init(ga_state, method, path)) {
875 g_critical("failed to initialize guest agent channel");
879 g_main_loop_run(ga_state->main_loop);
882 SERVICE_TABLE_ENTRY service_table[] = {
883 { (char *)QGA_SERVICE_NAME, service_main }, { NULL, NULL } };
884 StartServiceCtrlDispatcher(service_table);
886 g_main_loop_run(ga_state->main_loop);
890 ga_command_state_cleanup_all(ga_state->command_state);
891 ga_channel_free(ga_state->channel);
894 unlink(pid_filepath);
900 unlink(pid_filepath);