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.
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"
170 "Report bugs to <mdroth@linux.vnet.ibm.com>\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
));
253 if (ftruncate(pidfd
, 0) || lseek(pidfd
, 0, SEEK_SET
)) {
254 g_critical("Failed to truncate pid file");
257 sprintf(pidstr
, "%d", getpid());
258 if (write(pidfd
, pidstr
, strlen(pidstr
)) != strlen(pidstr
)) {
259 g_critical("Failed to write pid file");
270 static bool ga_open_pidfile(const char *pidfile
)
276 static gint
ga_strcmp(gconstpointer str1
, gconstpointer str2
)
278 return strcmp(str1
, str2
);
281 /* disable commands that aren't safe for fsfreeze */
282 static void ga_disable_non_whitelisted(void)
284 char **list_head
, **list
;
288 list_head
= list
= qmp_get_command_list();
289 while (*list
!= NULL
) {
292 while (ga_freeze_whitelist
[i
] != NULL
) {
293 if (strcmp(*list
, ga_freeze_whitelist
[i
]) == 0) {
299 g_debug("disabling command: %s", *list
);
300 qmp_disable_command(*list
);
308 /* [re-]enable all commands, except those explicitly blacklisted by user */
309 static void ga_enable_non_blacklisted(GList
*blacklist
)
311 char **list_head
, **list
;
313 list_head
= list
= qmp_get_command_list();
314 while (*list
!= NULL
) {
315 if (g_list_find_custom(blacklist
, *list
, ga_strcmp
) == NULL
&&
316 !qmp_command_is_enabled(*list
)) {
317 g_debug("enabling command: %s", *list
);
318 qmp_enable_command(*list
);
326 static bool ga_create_file(const char *path
)
328 int fd
= open(path
, O_CREAT
| O_WRONLY
, S_IWUSR
| S_IRUSR
);
330 g_warning("unable to open/create file %s: %s", path
, strerror(errno
));
337 static bool ga_delete_file(const char *path
)
339 int ret
= unlink(path
);
341 g_warning("unable to delete file: %s: %s", path
, strerror(errno
));
348 bool ga_is_frozen(GAState
*s
)
353 void ga_set_frozen(GAState
*s
)
355 if (ga_is_frozen(s
)) {
358 /* disable all non-whitelisted (for frozen state) commands */
359 ga_disable_non_whitelisted();
360 g_warning("disabling logging due to filesystem freeze");
361 ga_disable_logging(s
);
363 if (!ga_create_file(s
->state_filepath_isfrozen
)) {
364 g_warning("unable to create %s, fsfreeze may not function properly",
365 s
->state_filepath_isfrozen
);
369 void ga_unset_frozen(GAState
*s
)
371 if (!ga_is_frozen(s
)) {
375 /* if we delayed creation/opening of pid/log files due to being
376 * in a frozen state at start up, do it now
378 if (s
->deferred_options
.log_filepath
) {
379 s
->log_file
= fopen(s
->deferred_options
.log_filepath
, "a");
381 s
->log_file
= stderr
;
383 s
->deferred_options
.log_filepath
= NULL
;
385 ga_enable_logging(s
);
386 g_warning("logging re-enabled due to filesystem unfreeze");
387 if (s
->deferred_options
.pid_filepath
) {
388 if (!ga_open_pidfile(s
->deferred_options
.pid_filepath
)) {
389 g_warning("failed to create/open pid file");
391 s
->deferred_options
.pid_filepath
= NULL
;
394 /* enable all disabled, non-blacklisted commands */
395 ga_enable_non_blacklisted(s
->blacklist
);
397 if (!ga_delete_file(s
->state_filepath_isfrozen
)) {
398 g_warning("unable to delete %s, fsfreeze may not function properly",
399 s
->state_filepath_isfrozen
);
403 static void become_daemon(const char *pidfile
)
417 if (!ga_open_pidfile(pidfile
)) {
418 g_critical("failed to create pidfile");
428 if ((chdir("/")) < 0) {
432 reopen_fd_to_null(STDIN_FILENO
);
433 reopen_fd_to_null(STDOUT_FILENO
);
434 reopen_fd_to_null(STDERR_FILENO
);
439 g_critical("failed to daemonize");
444 static int send_response(GAState
*s
, QObject
*payload
)
447 QString
*payload_qstr
, *response_qstr
;
450 g_assert(payload
&& s
->channel
);
452 payload_qstr
= qobject_to_json(payload
);
457 if (s
->delimit_response
) {
458 s
->delimit_response
= false;
459 response_qstr
= qstring_new();
460 qstring_append_chr(response_qstr
, QGA_SENTINEL_BYTE
);
461 qstring_append(response_qstr
, qstring_get_str(payload_qstr
));
462 QDECREF(payload_qstr
);
464 response_qstr
= payload_qstr
;
467 qstring_append_chr(response_qstr
, '\n');
468 buf
= qstring_get_str(response_qstr
);
469 status
= ga_channel_write_all(s
->channel
, buf
, strlen(buf
));
470 QDECREF(response_qstr
);
471 if (status
!= G_IO_STATUS_NORMAL
) {
478 static void process_command(GAState
*s
, QDict
*req
)
484 g_debug("processing command");
485 rsp
= qmp_dispatch(QOBJECT(req
));
487 ret
= send_response(s
, rsp
);
489 g_warning("error sending response: %s", strerror(ret
));
495 /* handle requests/control events coming in over the channel */
496 static void process_event(JSONMessageParser
*parser
, QList
*tokens
)
498 GAState
*s
= container_of(parser
, GAState
, parser
);
504 g_assert(s
&& parser
);
506 g_debug("process_event: called");
507 obj
= json_parser_parse_err(tokens
, NULL
, &err
);
508 if (err
|| !obj
|| qobject_type(obj
) != QTYPE_QDICT
) {
512 g_warning("failed to parse event: unknown error");
513 error_set(&err
, QERR_JSON_PARSING
);
515 g_warning("failed to parse event: %s", error_get_pretty(err
));
517 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
520 qdict
= qobject_to_qdict(obj
);
525 /* handle host->guest commands */
526 if (qdict_haskey(qdict
, "execute")) {
527 process_command(s
, qdict
);
529 if (!qdict_haskey(qdict
, "error")) {
532 g_warning("unrecognized payload format");
533 error_set(&err
, QERR_UNSUPPORTED
);
534 qdict_put_obj(qdict
, "error", qmp_build_error_object(err
));
537 ret
= send_response(s
, QOBJECT(qdict
));
539 g_warning("error sending error response: %s", strerror(ret
));
546 /* false return signals GAChannel to close the current client connection */
547 static gboolean
channel_event_cb(GIOCondition condition
, gpointer data
)
550 gchar buf
[QGA_READ_COUNT_DEFAULT
+1];
553 GIOStatus status
= ga_channel_read(s
->channel
, buf
, QGA_READ_COUNT_DEFAULT
, &count
);
555 g_warning("error reading channel: %s", err
->message
);
560 case G_IO_STATUS_ERROR
:
561 g_warning("error reading channel");
563 case G_IO_STATUS_NORMAL
:
565 g_debug("read data, count: %d, data: %s", (int)count
, buf
);
566 json_message_parser_feed(&s
->parser
, (char *)buf
, (int)count
);
568 case G_IO_STATUS_EOF
:
569 g_debug("received EOF");
573 case G_IO_STATUS_AGAIN
:
574 /* virtio causes us to spin here when no process is attached to
575 * host-side chardev. sleep a bit to mitigate this
582 g_warning("unknown channel read status, closing");
588 static gboolean
channel_init(GAState
*s
, const gchar
*method
, const gchar
*path
)
590 GAChannelMethod channel_method
;
592 if (method
== NULL
) {
593 method
= "virtio-serial";
597 if (strcmp(method
, "virtio-serial") != 0) {
598 g_critical("must specify a path for this channel");
601 /* try the default path for the virtio-serial port */
602 path
= QGA_VIRTIO_PATH_DEFAULT
;
605 if (strcmp(method
, "virtio-serial") == 0) {
606 s
->virtio
= true; /* virtio requires special handling in some cases */
607 channel_method
= GA_CHANNEL_VIRTIO_SERIAL
;
608 } else if (strcmp(method
, "isa-serial") == 0) {
609 channel_method
= GA_CHANNEL_ISA_SERIAL
;
610 } else if (strcmp(method
, "unix-listen") == 0) {
611 channel_method
= GA_CHANNEL_UNIX_LISTEN
;
613 g_critical("unsupported channel method/type: %s", method
);
617 s
->channel
= ga_channel_new(channel_method
, path
, channel_event_cb
, s
);
619 g_critical("failed to create guest agent channel");
627 DWORD WINAPI
service_ctrl_handler(DWORD ctrl
, DWORD type
, LPVOID data
,
630 DWORD ret
= NO_ERROR
;
631 GAService
*service
= &ga_state
->service
;
635 case SERVICE_CONTROL_STOP
:
636 case SERVICE_CONTROL_SHUTDOWN
:
637 quit_handler(SIGTERM
);
638 service
->status
.dwCurrentState
= SERVICE_STOP_PENDING
;
639 SetServiceStatus(service
->status_handle
, &service
->status
);
643 ret
= ERROR_CALL_NOT_IMPLEMENTED
;
648 VOID WINAPI
service_main(DWORD argc
, TCHAR
*argv
[])
650 GAService
*service
= &ga_state
->service
;
652 service
->status_handle
= RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME
,
653 service_ctrl_handler
, NULL
);
655 if (service
->status_handle
== 0) {
656 g_critical("Failed to register extended requests function!\n");
660 service
->status
.dwServiceType
= SERVICE_WIN32
;
661 service
->status
.dwCurrentState
= SERVICE_RUNNING
;
662 service
->status
.dwControlsAccepted
= SERVICE_ACCEPT_STOP
| SERVICE_ACCEPT_SHUTDOWN
;
663 service
->status
.dwWin32ExitCode
= NO_ERROR
;
664 service
->status
.dwServiceSpecificExitCode
= NO_ERROR
;
665 service
->status
.dwCheckPoint
= 0;
666 service
->status
.dwWaitHint
= 0;
667 SetServiceStatus(service
->status_handle
, &service
->status
);
669 g_main_loop_run(ga_state
->main_loop
);
671 service
->status
.dwCurrentState
= SERVICE_STOPPED
;
672 SetServiceStatus(service
->status_handle
, &service
->status
);
676 int main(int argc
, char **argv
)
678 const char *sopt
= "hVvdm:p:l:f:b:s:t:";
679 const char *method
= NULL
, *path
= NULL
;
680 const char *log_filepath
= NULL
;
681 const char *pid_filepath
= QGA_PIDFILE_DEFAULT
;
682 const char *state_dir
= QGA_STATEDIR_DEFAULT
;
684 const char *service
= NULL
;
686 const struct option lopt
[] = {
687 { "help", 0, NULL
, 'h' },
688 { "version", 0, NULL
, 'V' },
689 { "logfile", 1, NULL
, 'l' },
690 { "pidfile", 1, NULL
, 'f' },
691 { "verbose", 0, NULL
, 'v' },
692 { "method", 1, NULL
, 'm' },
693 { "path", 1, NULL
, 'p' },
694 { "daemonize", 0, NULL
, 'd' },
695 { "blacklist", 1, NULL
, 'b' },
697 { "service", 1, NULL
, 's' },
699 { "statedir", 1, NULL
, 't' },
702 int opt_ind
= 0, ch
, daemonize
= 0, i
, j
, len
;
703 GLogLevelFlags log_level
= G_LOG_LEVEL_ERROR
| G_LOG_LEVEL_CRITICAL
;
704 GList
*blacklist
= NULL
;
707 module_call_init(MODULE_INIT_QAPI
);
709 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
718 log_filepath
= optarg
;
721 pid_filepath
= optarg
;
727 /* enable all log levels */
728 log_level
= G_LOG_LEVEL_MASK
;
731 printf("QEMU Guest Agent %s\n", QEMU_VERSION
);
737 char **list_head
, **list
;
738 if (is_help_option(optarg
)) {
739 list_head
= list
= qmp_get_command_list();
740 while (*list
!= NULL
) {
741 printf("%s\n", *list
);
748 for (j
= 0, i
= 0, len
= strlen(optarg
); i
< len
; i
++) {
749 if (optarg
[i
] == ',') {
751 blacklist
= g_list_append(blacklist
, &optarg
[j
]);
756 blacklist
= g_list_append(blacklist
, &optarg
[j
]);
763 if (strcmp(service
, "install") == 0) {
764 return ga_install_service(path
, log_filepath
);
765 } else if (strcmp(service
, "uninstall") == 0) {
766 return ga_uninstall_service();
768 printf("Unknown service command.\n");
777 g_print("Unknown option, try '%s --help' for more information.\n",
783 s
= g_malloc0(sizeof(GAState
));
784 s
->log_level
= log_level
;
785 s
->log_file
= stderr
;
786 g_log_set_default_handler(ga_log
, s
);
787 g_log_set_fatal_mask(NULL
, G_LOG_LEVEL_ERROR
);
788 ga_enable_logging(s
);
789 s
->state_filepath_isfrozen
= g_strdup_printf("%s/qga.state.isfrozen",
793 /* check if a previous instance of qemu-ga exited with filesystems' state
794 * marked as frozen. this could be a stale value (a non-qemu-ga process
795 * or reboot may have since unfrozen them), but better to require an
796 * uneeded unfreeze than to risk hanging on start-up
799 if (stat(s
->state_filepath_isfrozen
, &st
) == -1) {
800 /* it's okay if the file doesn't exist, but if we can't access for
801 * some other reason, such as permissions, there's a configuration
802 * that needs to be addressed. so just bail now before we get into
805 if (errno
!= ENOENT
) {
806 g_critical("unable to access state file at path %s: %s",
807 s
->state_filepath_isfrozen
, strerror(errno
));
811 g_warning("previous instance appears to have exited with frozen"
812 " filesystems. deferring logging/pidfile creation and"
813 " disabling non-fsfreeze-safe commands until"
814 " guest-fsfreeze-thaw is issued, or filesystems are"
815 " manually unfrozen and the file %s is removed",
816 s
->state_filepath_isfrozen
);
821 if (ga_is_frozen(s
)) {
823 /* delay opening/locking of pidfile till filesystem are unfrozen */
824 s
->deferred_options
.pid_filepath
= pid_filepath
;
828 /* delay opening the log file till filesystems are unfrozen */
829 s
->deferred_options
.log_filepath
= log_filepath
;
831 ga_disable_logging(s
);
832 ga_disable_non_whitelisted();
835 become_daemon(pid_filepath
);
838 FILE *log_file
= fopen(log_filepath
, "a");
840 g_critical("unable to open specified log file: %s",
844 s
->log_file
= log_file
;
849 s
->blacklist
= blacklist
;
851 g_debug("disabling command: %s", (char *)blacklist
->data
);
852 qmp_disable_command(blacklist
->data
);
853 blacklist
= g_list_next(blacklist
);
856 s
->command_state
= ga_command_state_new();
857 ga_command_state_init(s
, s
->command_state
);
858 ga_command_state_init_all(s
->command_state
);
859 json_message_parser_init(&s
->parser
, process_event
);
862 if (!register_signal_handlers()) {
863 g_critical("failed to register signal handlers");
868 s
->main_loop
= g_main_loop_new(NULL
, false);
869 if (!channel_init(ga_state
, method
, path
)) {
870 g_critical("failed to initialize guest agent channel");
874 g_main_loop_run(ga_state
->main_loop
);
877 SERVICE_TABLE_ENTRY service_table
[] = {
878 { (char *)QGA_SERVICE_NAME
, service_main
}, { NULL
, NULL
} };
879 StartServiceCtrlDispatcher(service_table
);
881 g_main_loop_run(ga_state
->main_loop
);
885 ga_command_state_cleanup_all(ga_state
->command_state
);
886 ga_channel_free(ga_state
->channel
);
889 unlink(pid_filepath
);
895 unlink(pid_filepath
);