qemu-ga.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901
  1. /*
  2. * QEMU Guest Agent
  3. *
  4. * Copyright IBM Corp. 2011
  5. *
  6. * Authors:
  7. * Adam Litke <aglitke@linux.vnet.ibm.com>
  8. * Michael Roth <mdroth@linux.vnet.ibm.com>
  9. *
  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.
  12. */
  13. #include <stdlib.h>
  14. #include <stdio.h>
  15. #include <stdbool.h>
  16. #include <glib.h>
  17. #include <getopt.h>
  18. #ifndef _WIN32
  19. #include <syslog.h>
  20. #include <sys/wait.h>
  21. #include <sys/stat.h>
  22. #endif
  23. #include "json-streamer.h"
  24. #include "json-parser.h"
  25. #include "qint.h"
  26. #include "qjson.h"
  27. #include "qga/guest-agent-core.h"
  28. #include "module.h"
  29. #include "signal.h"
  30. #include "qerror.h"
  31. #include "qapi/qmp-core.h"
  32. #include "qga/channel.h"
  33. #ifdef _WIN32
  34. #include "qga/service-win32.h"
  35. #include <windows.h>
  36. #endif
  37. #ifndef _WIN32
  38. #define QGA_VIRTIO_PATH_DEFAULT "/dev/virtio-ports/org.qemu.guest_agent.0"
  39. #else
  40. #define QGA_VIRTIO_PATH_DEFAULT "\\\\.\\Global\\org.qemu.guest_agent.0"
  41. #endif
  42. #define QGA_PIDFILE_DEFAULT "/var/run/qemu-ga.pid"
  43. #define QGA_STATEDIR_DEFAULT "/tmp"
  44. #define QGA_SENTINEL_BYTE 0xFF
  45. struct GAState {
  46. JSONMessageParser parser;
  47. GMainLoop *main_loop;
  48. GAChannel *channel;
  49. bool virtio; /* fastpath to check for virtio to deal with poll() quirks */
  50. GACommandState *command_state;
  51. GLogLevelFlags log_level;
  52. FILE *log_file;
  53. bool logging_enabled;
  54. #ifdef _WIN32
  55. GAService service;
  56. #endif
  57. bool delimit_response;
  58. bool frozen;
  59. GList *blacklist;
  60. const char *state_filepath_isfrozen;
  61. struct {
  62. const char *log_filepath;
  63. const char *pid_filepath;
  64. } deferred_options;
  65. };
  66. struct GAState *ga_state;
  67. /* commands that are safe to issue while filesystems are frozen */
  68. static const char *ga_freeze_whitelist[] = {
  69. "guest-ping",
  70. "guest-info",
  71. "guest-sync",
  72. "guest-fsfreeze-status",
  73. "guest-fsfreeze-thaw",
  74. NULL
  75. };
  76. #ifdef _WIN32
  77. DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
  78. LPVOID ctx);
  79. VOID WINAPI service_main(DWORD argc, TCHAR *argv[]);
  80. #endif
  81. static void quit_handler(int sig)
  82. {
  83. /* if we're frozen, don't exit unless we're absolutely forced to,
  84. * because it's basically impossible for graceful exit to complete
  85. * unless all log/pid files are on unfreezable filesystems. there's
  86. * also a very likely chance killing the agent before unfreezing
  87. * the filesystems is a mistake (or will be viewed as one later).
  88. */
  89. if (ga_is_frozen(ga_state)) {
  90. return;
  91. }
  92. g_debug("received signal num %d, quitting", sig);
  93. if (g_main_loop_is_running(ga_state->main_loop)) {
  94. g_main_loop_quit(ga_state->main_loop);
  95. }
  96. }
  97. #ifndef _WIN32
  98. static gboolean register_signal_handlers(void)
  99. {
  100. struct sigaction sigact;
  101. int ret;
  102. memset(&sigact, 0, sizeof(struct sigaction));
  103. sigact.sa_handler = quit_handler;
  104. ret = sigaction(SIGINT, &sigact, NULL);
  105. if (ret == -1) {
  106. g_error("error configuring signal handler: %s", strerror(errno));
  107. }
  108. ret = sigaction(SIGTERM, &sigact, NULL);
  109. if (ret == -1) {
  110. g_error("error configuring signal handler: %s", strerror(errno));
  111. }
  112. return true;
  113. }
  114. /* TODO: use this in place of all post-fork() fclose(std*) callers */
  115. void reopen_fd_to_null(int fd)
  116. {
  117. int nullfd;
  118. nullfd = open("/dev/null", O_RDWR);
  119. if (nullfd < 0) {
  120. return;
  121. }
  122. dup2(nullfd, fd);
  123. if (nullfd != fd) {
  124. close(nullfd);
  125. }
  126. }
  127. #endif
  128. static void usage(const char *cmd)
  129. {
  130. printf(
  131. "Usage: %s [-m <method> -p <path>] [<options>]\n"
  132. "QEMU Guest Agent %s\n"
  133. "\n"
  134. " -m, --method transport method: one of unix-listen, virtio-serial, or\n"
  135. " isa-serial (virtio-serial is the default)\n"
  136. " -p, --path device/socket path (the default for virtio-serial is:\n"
  137. " %s)\n"
  138. " -l, --logfile set logfile path, logs to stderr by default\n"
  139. " -f, --pidfile specify pidfile (default is %s)\n"
  140. " -t, --statedir specify dir to store state information (absolute paths\n"
  141. " only, default is %s)\n"
  142. " -v, --verbose log extra debugging information\n"
  143. " -V, --version print version information and exit\n"
  144. " -d, --daemonize become a daemon\n"
  145. #ifdef _WIN32
  146. " -s, --service service commands: install, uninstall\n"
  147. #endif
  148. " -b, --blacklist comma-separated list of RPCs to disable (no spaces, \"?\"\n"
  149. " to list available RPCs)\n"
  150. " -h, --help display this help and exit\n"
  151. "\n"
  152. "Report bugs to <mdroth@linux.vnet.ibm.com>\n"
  153. , cmd, QEMU_VERSION, QGA_VIRTIO_PATH_DEFAULT, QGA_PIDFILE_DEFAULT,
  154. QGA_STATEDIR_DEFAULT);
  155. }
  156. static const char *ga_log_level_str(GLogLevelFlags level)
  157. {
  158. switch (level & G_LOG_LEVEL_MASK) {
  159. case G_LOG_LEVEL_ERROR:
  160. return "error";
  161. case G_LOG_LEVEL_CRITICAL:
  162. return "critical";
  163. case G_LOG_LEVEL_WARNING:
  164. return "warning";
  165. case G_LOG_LEVEL_MESSAGE:
  166. return "message";
  167. case G_LOG_LEVEL_INFO:
  168. return "info";
  169. case G_LOG_LEVEL_DEBUG:
  170. return "debug";
  171. default:
  172. return "user";
  173. }
  174. }
  175. bool ga_logging_enabled(GAState *s)
  176. {
  177. return s->logging_enabled;
  178. }
  179. void ga_disable_logging(GAState *s)
  180. {
  181. s->logging_enabled = false;
  182. }
  183. void ga_enable_logging(GAState *s)
  184. {
  185. s->logging_enabled = true;
  186. }
  187. static void ga_log(const gchar *domain, GLogLevelFlags level,
  188. const gchar *msg, gpointer opaque)
  189. {
  190. GAState *s = opaque;
  191. GTimeVal time;
  192. const char *level_str = ga_log_level_str(level);
  193. if (!ga_logging_enabled(s)) {
  194. return;
  195. }
  196. level &= G_LOG_LEVEL_MASK;
  197. #ifndef _WIN32
  198. if (domain && strcmp(domain, "syslog") == 0) {
  199. syslog(LOG_INFO, "%s: %s", level_str, msg);
  200. } else if (level & s->log_level) {
  201. #else
  202. if (level & s->log_level) {
  203. #endif
  204. g_get_current_time(&time);
  205. fprintf(s->log_file,
  206. "%lu.%lu: %s: %s\n", time.tv_sec, time.tv_usec, level_str, msg);
  207. fflush(s->log_file);
  208. }
  209. }
  210. void ga_set_response_delimited(GAState *s)
  211. {
  212. s->delimit_response = true;
  213. }
  214. #ifndef _WIN32
  215. static bool ga_open_pidfile(const char *pidfile)
  216. {
  217. int pidfd;
  218. char pidstr[32];
  219. pidfd = open(pidfile, O_CREAT|O_WRONLY, S_IRUSR|S_IWUSR);
  220. if (pidfd == -1 || lockf(pidfd, F_TLOCK, 0)) {
  221. g_critical("Cannot lock pid file, %s", strerror(errno));
  222. if (pidfd != -1) {
  223. close(pidfd);
  224. }
  225. return false;
  226. }
  227. if (ftruncate(pidfd, 0) || lseek(pidfd, 0, SEEK_SET)) {
  228. g_critical("Failed to truncate pid file");
  229. goto fail;
  230. }
  231. sprintf(pidstr, "%d", getpid());
  232. if (write(pidfd, pidstr, strlen(pidstr)) != strlen(pidstr)) {
  233. g_critical("Failed to write pid file");
  234. goto fail;
  235. }
  236. return true;
  237. fail:
  238. unlink(pidfile);
  239. return false;
  240. }
  241. #else /* _WIN32 */
  242. static bool ga_open_pidfile(const char *pidfile)
  243. {
  244. return true;
  245. }
  246. #endif
  247. static gint ga_strcmp(gconstpointer str1, gconstpointer str2)
  248. {
  249. return strcmp(str1, str2);
  250. }
  251. /* disable commands that aren't safe for fsfreeze */
  252. static void ga_disable_non_whitelisted(void)
  253. {
  254. char **list_head, **list;
  255. bool whitelisted;
  256. int i;
  257. list_head = list = qmp_get_command_list();
  258. while (*list != NULL) {
  259. whitelisted = false;
  260. i = 0;
  261. while (ga_freeze_whitelist[i] != NULL) {
  262. if (strcmp(*list, ga_freeze_whitelist[i]) == 0) {
  263. whitelisted = true;
  264. }
  265. i++;
  266. }
  267. if (!whitelisted) {
  268. g_debug("disabling command: %s", *list);
  269. qmp_disable_command(*list);
  270. }
  271. g_free(*list);
  272. list++;
  273. }
  274. g_free(list_head);
  275. }
  276. /* [re-]enable all commands, except those explicitly blacklisted by user */
  277. static void ga_enable_non_blacklisted(GList *blacklist)
  278. {
  279. char **list_head, **list;
  280. list_head = list = qmp_get_command_list();
  281. while (*list != NULL) {
  282. if (g_list_find_custom(blacklist, *list, ga_strcmp) == NULL &&
  283. !qmp_command_is_enabled(*list)) {
  284. g_debug("enabling command: %s", *list);
  285. qmp_enable_command(*list);
  286. }
  287. g_free(*list);
  288. list++;
  289. }
  290. g_free(list_head);
  291. }
  292. static bool ga_create_file(const char *path)
  293. {
  294. int fd = open(path, O_CREAT | O_WRONLY, S_IWUSR | S_IRUSR);
  295. if (fd == -1) {
  296. g_warning("unable to open/create file %s: %s", path, strerror(errno));
  297. return false;
  298. }
  299. close(fd);
  300. return true;
  301. }
  302. static bool ga_delete_file(const char *path)
  303. {
  304. int ret = unlink(path);
  305. if (ret == -1) {
  306. g_warning("unable to delete file: %s: %s", path, strerror(errno));
  307. return false;
  308. }
  309. return true;
  310. }
  311. bool ga_is_frozen(GAState *s)
  312. {
  313. return s->frozen;
  314. }
  315. void ga_set_frozen(GAState *s)
  316. {
  317. if (ga_is_frozen(s)) {
  318. return;
  319. }
  320. /* disable all non-whitelisted (for frozen state) commands */
  321. ga_disable_non_whitelisted();
  322. g_warning("disabling logging due to filesystem freeze");
  323. ga_disable_logging(s);
  324. s->frozen = true;
  325. if (!ga_create_file(s->state_filepath_isfrozen)) {
  326. g_warning("unable to create %s, fsfreeze may not function properly",
  327. s->state_filepath_isfrozen);
  328. }
  329. }
  330. void ga_unset_frozen(GAState *s)
  331. {
  332. if (!ga_is_frozen(s)) {
  333. return;
  334. }
  335. /* if we delayed creation/opening of pid/log files due to being
  336. * in a frozen state at start up, do it now
  337. */
  338. if (s->deferred_options.log_filepath) {
  339. s->log_file = fopen(s->deferred_options.log_filepath, "a");
  340. if (!s->log_file) {
  341. s->log_file = stderr;
  342. }
  343. s->deferred_options.log_filepath = NULL;
  344. }
  345. ga_enable_logging(s);
  346. g_warning("logging re-enabled due to filesystem unfreeze");
  347. if (s->deferred_options.pid_filepath) {
  348. if (!ga_open_pidfile(s->deferred_options.pid_filepath)) {
  349. g_warning("failed to create/open pid file");
  350. }
  351. s->deferred_options.pid_filepath = NULL;
  352. }
  353. /* enable all disabled, non-blacklisted commands */
  354. ga_enable_non_blacklisted(s->blacklist);
  355. s->frozen = false;
  356. if (!ga_delete_file(s->state_filepath_isfrozen)) {
  357. g_warning("unable to delete %s, fsfreeze may not function properly",
  358. s->state_filepath_isfrozen);
  359. }
  360. }
  361. static void become_daemon(const char *pidfile)
  362. {
  363. #ifndef _WIN32
  364. pid_t pid, sid;
  365. pid = fork();
  366. if (pid < 0) {
  367. exit(EXIT_FAILURE);
  368. }
  369. if (pid > 0) {
  370. exit(EXIT_SUCCESS);
  371. }
  372. if (pidfile) {
  373. if (!ga_open_pidfile(pidfile)) {
  374. g_critical("failed to create pidfile");
  375. exit(EXIT_FAILURE);
  376. }
  377. }
  378. umask(0);
  379. sid = setsid();
  380. if (sid < 0) {
  381. goto fail;
  382. }
  383. if ((chdir("/")) < 0) {
  384. goto fail;
  385. }
  386. reopen_fd_to_null(STDIN_FILENO);
  387. reopen_fd_to_null(STDOUT_FILENO);
  388. reopen_fd_to_null(STDERR_FILENO);
  389. return;
  390. fail:
  391. if (pidfile) {
  392. unlink(pidfile);
  393. }
  394. g_critical("failed to daemonize");
  395. exit(EXIT_FAILURE);
  396. #endif
  397. }
  398. static int send_response(GAState *s, QObject *payload)
  399. {
  400. const char *buf;
  401. QString *payload_qstr, *response_qstr;
  402. GIOStatus status;
  403. g_assert(payload && s->channel);
  404. payload_qstr = qobject_to_json(payload);
  405. if (!payload_qstr) {
  406. return -EINVAL;
  407. }
  408. if (s->delimit_response) {
  409. s->delimit_response = false;
  410. response_qstr = qstring_new();
  411. qstring_append_chr(response_qstr, QGA_SENTINEL_BYTE);
  412. qstring_append(response_qstr, qstring_get_str(payload_qstr));
  413. QDECREF(payload_qstr);
  414. } else {
  415. response_qstr = payload_qstr;
  416. }
  417. qstring_append_chr(response_qstr, '\n');
  418. buf = qstring_get_str(response_qstr);
  419. status = ga_channel_write_all(s->channel, buf, strlen(buf));
  420. QDECREF(response_qstr);
  421. if (status != G_IO_STATUS_NORMAL) {
  422. return -EIO;
  423. }
  424. return 0;
  425. }
  426. static void process_command(GAState *s, QDict *req)
  427. {
  428. QObject *rsp = NULL;
  429. int ret;
  430. g_assert(req);
  431. g_debug("processing command");
  432. rsp = qmp_dispatch(QOBJECT(req));
  433. if (rsp) {
  434. ret = send_response(s, rsp);
  435. if (ret) {
  436. g_warning("error sending response: %s", strerror(ret));
  437. }
  438. qobject_decref(rsp);
  439. }
  440. }
  441. /* handle requests/control events coming in over the channel */
  442. static void process_event(JSONMessageParser *parser, QList *tokens)
  443. {
  444. GAState *s = container_of(parser, GAState, parser);
  445. QObject *obj;
  446. QDict *qdict;
  447. Error *err = NULL;
  448. int ret;
  449. g_assert(s && parser);
  450. g_debug("process_event: called");
  451. obj = json_parser_parse_err(tokens, NULL, &err);
  452. if (err || !obj || qobject_type(obj) != QTYPE_QDICT) {
  453. qobject_decref(obj);
  454. qdict = qdict_new();
  455. if (!err) {
  456. g_warning("failed to parse event: unknown error");
  457. error_set(&err, QERR_JSON_PARSING);
  458. } else {
  459. g_warning("failed to parse event: %s", error_get_pretty(err));
  460. }
  461. qdict_put_obj(qdict, "error", qmp_build_error_object(err));
  462. error_free(err);
  463. } else {
  464. qdict = qobject_to_qdict(obj);
  465. }
  466. g_assert(qdict);
  467. /* handle host->guest commands */
  468. if (qdict_haskey(qdict, "execute")) {
  469. process_command(s, qdict);
  470. } else {
  471. if (!qdict_haskey(qdict, "error")) {
  472. QDECREF(qdict);
  473. qdict = qdict_new();
  474. g_warning("unrecognized payload format");
  475. error_set(&err, QERR_UNSUPPORTED);
  476. qdict_put_obj(qdict, "error", qmp_build_error_object(err));
  477. error_free(err);
  478. }
  479. ret = send_response(s, QOBJECT(qdict));
  480. if (ret) {
  481. g_warning("error sending error response: %s", strerror(ret));
  482. }
  483. }
  484. QDECREF(qdict);
  485. }
  486. /* false return signals GAChannel to close the current client connection */
  487. static gboolean channel_event_cb(GIOCondition condition, gpointer data)
  488. {
  489. GAState *s = data;
  490. gchar buf[QGA_READ_COUNT_DEFAULT+1];
  491. gsize count;
  492. GError *err = NULL;
  493. GIOStatus status = ga_channel_read(s->channel, buf, QGA_READ_COUNT_DEFAULT, &count);
  494. if (err != NULL) {
  495. g_warning("error reading channel: %s", err->message);
  496. g_error_free(err);
  497. return false;
  498. }
  499. switch (status) {
  500. case G_IO_STATUS_ERROR:
  501. g_warning("error reading channel");
  502. return false;
  503. case G_IO_STATUS_NORMAL:
  504. buf[count] = 0;
  505. g_debug("read data, count: %d, data: %s", (int)count, buf);
  506. json_message_parser_feed(&s->parser, (char *)buf, (int)count);
  507. break;
  508. case G_IO_STATUS_EOF:
  509. g_debug("received EOF");
  510. if (!s->virtio) {
  511. return false;
  512. }
  513. case G_IO_STATUS_AGAIN:
  514. /* virtio causes us to spin here when no process is attached to
  515. * host-side chardev. sleep a bit to mitigate this
  516. */
  517. if (s->virtio) {
  518. usleep(100*1000);
  519. }
  520. return true;
  521. default:
  522. g_warning("unknown channel read status, closing");
  523. return false;
  524. }
  525. return true;
  526. }
  527. static gboolean channel_init(GAState *s, const gchar *method, const gchar *path)
  528. {
  529. GAChannelMethod channel_method;
  530. if (method == NULL) {
  531. method = "virtio-serial";
  532. }
  533. if (path == NULL) {
  534. if (strcmp(method, "virtio-serial") != 0) {
  535. g_critical("must specify a path for this channel");
  536. return false;
  537. }
  538. /* try the default path for the virtio-serial port */
  539. path = QGA_VIRTIO_PATH_DEFAULT;
  540. }
  541. if (strcmp(method, "virtio-serial") == 0) {
  542. s->virtio = true; /* virtio requires special handling in some cases */
  543. channel_method = GA_CHANNEL_VIRTIO_SERIAL;
  544. } else if (strcmp(method, "isa-serial") == 0) {
  545. channel_method = GA_CHANNEL_ISA_SERIAL;
  546. } else if (strcmp(method, "unix-listen") == 0) {
  547. channel_method = GA_CHANNEL_UNIX_LISTEN;
  548. } else {
  549. g_critical("unsupported channel method/type: %s", method);
  550. return false;
  551. }
  552. s->channel = ga_channel_new(channel_method, path, channel_event_cb, s);
  553. if (!s->channel) {
  554. g_critical("failed to create guest agent channel");
  555. return false;
  556. }
  557. return true;
  558. }
  559. #ifdef _WIN32
  560. DWORD WINAPI service_ctrl_handler(DWORD ctrl, DWORD type, LPVOID data,
  561. LPVOID ctx)
  562. {
  563. DWORD ret = NO_ERROR;
  564. GAService *service = &ga_state->service;
  565. switch (ctrl)
  566. {
  567. case SERVICE_CONTROL_STOP:
  568. case SERVICE_CONTROL_SHUTDOWN:
  569. quit_handler(SIGTERM);
  570. service->status.dwCurrentState = SERVICE_STOP_PENDING;
  571. SetServiceStatus(service->status_handle, &service->status);
  572. break;
  573. default:
  574. ret = ERROR_CALL_NOT_IMPLEMENTED;
  575. }
  576. return ret;
  577. }
  578. VOID WINAPI service_main(DWORD argc, TCHAR *argv[])
  579. {
  580. GAService *service = &ga_state->service;
  581. service->status_handle = RegisterServiceCtrlHandlerEx(QGA_SERVICE_NAME,
  582. service_ctrl_handler, NULL);
  583. if (service->status_handle == 0) {
  584. g_critical("Failed to register extended requests function!\n");
  585. return;
  586. }
  587. service->status.dwServiceType = SERVICE_WIN32;
  588. service->status.dwCurrentState = SERVICE_RUNNING;
  589. service->status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN;
  590. service->status.dwWin32ExitCode = NO_ERROR;
  591. service->status.dwServiceSpecificExitCode = NO_ERROR;
  592. service->status.dwCheckPoint = 0;
  593. service->status.dwWaitHint = 0;
  594. SetServiceStatus(service->status_handle, &service->status);
  595. g_main_loop_run(ga_state->main_loop);
  596. service->status.dwCurrentState = SERVICE_STOPPED;
  597. SetServiceStatus(service->status_handle, &service->status);
  598. }
  599. #endif
  600. int main(int argc, char **argv)
  601. {
  602. const char *sopt = "hVvdm:p:l:f:b:s:t:";
  603. const char *method = NULL, *path = NULL;
  604. const char *log_filepath = NULL;
  605. const char *pid_filepath = QGA_PIDFILE_DEFAULT;
  606. const char *state_dir = QGA_STATEDIR_DEFAULT;
  607. #ifdef _WIN32
  608. const char *service = NULL;
  609. #endif
  610. const struct option lopt[] = {
  611. { "help", 0, NULL, 'h' },
  612. { "version", 0, NULL, 'V' },
  613. { "logfile", 1, NULL, 'l' },
  614. { "pidfile", 1, NULL, 'f' },
  615. { "verbose", 0, NULL, 'v' },
  616. { "method", 1, NULL, 'm' },
  617. { "path", 1, NULL, 'p' },
  618. { "daemonize", 0, NULL, 'd' },
  619. { "blacklist", 1, NULL, 'b' },
  620. #ifdef _WIN32
  621. { "service", 1, NULL, 's' },
  622. #endif
  623. { "statedir", 1, NULL, 't' },
  624. { NULL, 0, NULL, 0 }
  625. };
  626. int opt_ind = 0, ch, daemonize = 0, i, j, len;
  627. GLogLevelFlags log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL;
  628. GList *blacklist = NULL;
  629. GAState *s;
  630. module_call_init(MODULE_INIT_QAPI);
  631. while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
  632. switch (ch) {
  633. case 'm':
  634. method = optarg;
  635. break;
  636. case 'p':
  637. path = optarg;
  638. break;
  639. case 'l':
  640. log_filepath = optarg;
  641. break;
  642. case 'f':
  643. pid_filepath = optarg;
  644. break;
  645. case 't':
  646. state_dir = optarg;
  647. break;
  648. case 'v':
  649. /* enable all log levels */
  650. log_level = G_LOG_LEVEL_MASK;
  651. break;
  652. case 'V':
  653. printf("QEMU Guest Agent %s\n", QEMU_VERSION);
  654. return 0;
  655. case 'd':
  656. daemonize = 1;
  657. break;
  658. case 'b': {
  659. char **list_head, **list;
  660. if (is_help_option(optarg)) {
  661. list_head = list = qmp_get_command_list();
  662. while (*list != NULL) {
  663. printf("%s\n", *list);
  664. g_free(*list);
  665. list++;
  666. }
  667. g_free(list_head);
  668. return 0;
  669. }
  670. for (j = 0, i = 0, len = strlen(optarg); i < len; i++) {
  671. if (optarg[i] == ',') {
  672. optarg[i] = 0;
  673. blacklist = g_list_append(blacklist, &optarg[j]);
  674. j = i + 1;
  675. }
  676. }
  677. if (j < i) {
  678. blacklist = g_list_append(blacklist, &optarg[j]);
  679. }
  680. break;
  681. }
  682. #ifdef _WIN32
  683. case 's':
  684. service = optarg;
  685. if (strcmp(service, "install") == 0) {
  686. return ga_install_service(path, log_filepath);
  687. } else if (strcmp(service, "uninstall") == 0) {
  688. return ga_uninstall_service();
  689. } else {
  690. printf("Unknown service command.\n");
  691. return EXIT_FAILURE;
  692. }
  693. break;
  694. #endif
  695. case 'h':
  696. usage(argv[0]);
  697. return 0;
  698. case '?':
  699. g_print("Unknown option, try '%s --help' for more information.\n",
  700. argv[0]);
  701. return EXIT_FAILURE;
  702. }
  703. }
  704. s = g_malloc0(sizeof(GAState));
  705. s->log_level = log_level;
  706. s->log_file = stderr;
  707. g_log_set_default_handler(ga_log, s);
  708. g_log_set_fatal_mask(NULL, G_LOG_LEVEL_ERROR);
  709. ga_enable_logging(s);
  710. s->state_filepath_isfrozen = g_strdup_printf("%s/qga.state.isfrozen",
  711. state_dir);
  712. s->frozen = false;
  713. #ifndef _WIN32
  714. /* check if a previous instance of qemu-ga exited with filesystems' state
  715. * marked as frozen. this could be a stale value (a non-qemu-ga process
  716. * or reboot may have since unfrozen them), but better to require an
  717. * uneeded unfreeze than to risk hanging on start-up
  718. */
  719. struct stat st;
  720. if (stat(s->state_filepath_isfrozen, &st) == -1) {
  721. /* it's okay if the file doesn't exist, but if we can't access for
  722. * some other reason, such as permissions, there's a configuration
  723. * that needs to be addressed. so just bail now before we get into
  724. * more trouble later
  725. */
  726. if (errno != ENOENT) {
  727. g_critical("unable to access state file at path %s: %s",
  728. s->state_filepath_isfrozen, strerror(errno));
  729. return EXIT_FAILURE;
  730. }
  731. } else {
  732. g_warning("previous instance appears to have exited with frozen"
  733. " filesystems. deferring logging/pidfile creation and"
  734. " disabling non-fsfreeze-safe commands until"
  735. " guest-fsfreeze-thaw is issued, or filesystems are"
  736. " manually unfrozen and the file %s is removed",
  737. s->state_filepath_isfrozen);
  738. s->frozen = true;
  739. }
  740. #endif
  741. if (ga_is_frozen(s)) {
  742. if (daemonize) {
  743. /* delay opening/locking of pidfile till filesystem are unfrozen */
  744. s->deferred_options.pid_filepath = pid_filepath;
  745. become_daemon(NULL);
  746. }
  747. if (log_filepath) {
  748. /* delay opening the log file till filesystems are unfrozen */
  749. s->deferred_options.log_filepath = log_filepath;
  750. }
  751. ga_disable_logging(s);
  752. ga_disable_non_whitelisted();
  753. } else {
  754. if (daemonize) {
  755. become_daemon(pid_filepath);
  756. }
  757. if (log_filepath) {
  758. FILE *log_file = fopen(log_filepath, "a");
  759. if (!log_file) {
  760. g_critical("unable to open specified log file: %s",
  761. strerror(errno));
  762. goto out_bad;
  763. }
  764. s->log_file = log_file;
  765. }
  766. }
  767. if (blacklist) {
  768. s->blacklist = blacklist;
  769. do {
  770. g_debug("disabling command: %s", (char *)blacklist->data);
  771. qmp_disable_command(blacklist->data);
  772. blacklist = g_list_next(blacklist);
  773. } while (blacklist);
  774. }
  775. s->command_state = ga_command_state_new();
  776. ga_command_state_init(s, s->command_state);
  777. ga_command_state_init_all(s->command_state);
  778. json_message_parser_init(&s->parser, process_event);
  779. ga_state = s;
  780. #ifndef _WIN32
  781. if (!register_signal_handlers()) {
  782. g_critical("failed to register signal handlers");
  783. goto out_bad;
  784. }
  785. #endif
  786. s->main_loop = g_main_loop_new(NULL, false);
  787. if (!channel_init(ga_state, method, path)) {
  788. g_critical("failed to initialize guest agent channel");
  789. goto out_bad;
  790. }
  791. #ifndef _WIN32
  792. g_main_loop_run(ga_state->main_loop);
  793. #else
  794. if (daemonize) {
  795. SERVICE_TABLE_ENTRY service_table[] = {
  796. { (char *)QGA_SERVICE_NAME, service_main }, { NULL, NULL } };
  797. StartServiceCtrlDispatcher(service_table);
  798. } else {
  799. g_main_loop_run(ga_state->main_loop);
  800. }
  801. #endif
  802. ga_command_state_cleanup_all(ga_state->command_state);
  803. ga_channel_free(ga_state->channel);
  804. if (daemonize) {
  805. unlink(pid_filepath);
  806. }
  807. return 0;
  808. out_bad:
  809. if (daemonize) {
  810. unlink(pid_filepath);
  811. }
  812. return EXIT_FAILURE;
  813. }