2 * QEMU Guest Agent POSIX-specific command implementations
4 * Copyright IBM Corp. 2011
7 * Michael Roth <mdroth@linux.vnet.ibm.com>
8 * Michal Privoznik <mprivozn@redhat.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.
14 #include "qemu/osdep.h"
15 #include <sys/ioctl.h>
16 #include <sys/utsname.h>
19 #include "qemu-common.h"
20 #include "guest-agent-core.h"
21 #include "qga-qapi-commands.h"
22 #include "qapi/error.h"
23 #include "qapi/qmp/qerror.h"
24 #include "qemu/queue.h"
25 #include "qemu/host-utils.h"
26 #include "qemu/sockets.h"
27 #include "qemu/base64.h"
28 #include "qemu/cutils.h"
29 #include "commands-common.h"
35 #ifndef CONFIG_HAS_ENVIRON
37 #include <crt_externs.h>
38 #define environ (*_NSGetEnviron())
40 extern char **environ;
44 #if defined(__linux__)
48 #include <arpa/inet.h>
49 #include <sys/socket.h>
51 #include <sys/statvfs.h>
58 #define CONFIG_FSFREEZE
65 static void ga_wait_child(pid_t pid, int *status, Error **errp)
72 rpid = waitpid(pid, status, 0);
73 } while (rpid == -1 && errno == EINTR);
76 error_setg_errno(errp, errno, "failed to wait for child (pid: %d)",
81 g_assert(rpid == pid);
84 void qmp_guest_shutdown(bool has_mode, const char *mode, Error **errp)
86 const char *shutdown_flag;
87 Error *local_err = NULL;
91 slog("guest-shutdown called, mode: %s", mode);
92 if (!has_mode || strcmp(mode, "powerdown") == 0) {
94 } else if (strcmp(mode, "halt") == 0) {
96 } else if (strcmp(mode, "reboot") == 0) {
100 "mode is invalid (valid values are: halt|powerdown|reboot");
106 /* child, start the shutdown */
108 reopen_fd_to_null(0);
109 reopen_fd_to_null(1);
110 reopen_fd_to_null(2);
112 execle("/sbin/shutdown", "shutdown", "-h", shutdown_flag, "+0",
113 "hypervisor initiated shutdown", (char*)NULL, environ);
115 } else if (pid < 0) {
116 error_setg_errno(errp, errno, "failed to create child process");
120 ga_wait_child(pid, &status, &local_err);
122 error_propagate(errp, local_err);
126 if (!WIFEXITED(status)) {
127 error_setg(errp, "child process has terminated abnormally");
131 if (WEXITSTATUS(status)) {
132 error_setg(errp, "child process has failed to shutdown");
139 int64_t qmp_guest_get_time(Error **errp)
144 ret = qemu_gettimeofday(&tq);
146 error_setg_errno(errp, errno, "Failed to get time");
150 return tq.tv_sec * 1000000000LL + tq.tv_usec * 1000;
153 void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
158 Error *local_err = NULL;
160 static const char hwclock_path[] = "/sbin/hwclock";
161 static int hwclock_available = -1;
163 if (hwclock_available < 0) {
164 hwclock_available = (access(hwclock_path, X_OK) == 0);
167 if (!hwclock_available) {
168 error_setg(errp, QERR_UNSUPPORTED);
172 /* If user has passed a time, validate and set it. */
176 /* year-2038 will overflow in case time_t is 32bit */
177 if (time_ns / 1000000000 != (time_t)(time_ns / 1000000000)) {
178 error_setg(errp, "Time %" PRId64 " is too large", time_ns);
182 tv.tv_sec = time_ns / 1000000000;
183 tv.tv_usec = (time_ns % 1000000000) / 1000;
184 g_date_set_time_t(&date, tv.tv_sec);
185 if (date.year < 1970 || date.year >= 2070) {
186 error_setg_errno(errp, errno, "Invalid time");
190 ret = settimeofday(&tv, NULL);
192 error_setg_errno(errp, errno, "Failed to set time to guest");
197 /* Now, if user has passed a time to set and the system time is set, we
198 * just need to synchronize the hardware clock. However, if no time was
199 * passed, user is requesting the opposite: set the system time from the
200 * hardware clock (RTC). */
204 reopen_fd_to_null(0);
205 reopen_fd_to_null(1);
206 reopen_fd_to_null(2);
208 /* Use '/sbin/hwclock -w' to set RTC from the system time,
209 * or '/sbin/hwclock -s' to set the system time from RTC. */
210 execle(hwclock_path, "hwclock", has_time ? "-w" : "-s",
213 } else if (pid < 0) {
214 error_setg_errno(errp, errno, "failed to create child process");
218 ga_wait_child(pid, &status, &local_err);
220 error_propagate(errp, local_err);
224 if (!WIFEXITED(status)) {
225 error_setg(errp, "child process has terminated abnormally");
229 if (WEXITSTATUS(status)) {
230 error_setg(errp, "hwclock failed to set hardware clock to system time");
241 struct GuestFileHandle {
245 QTAILQ_ENTRY(GuestFileHandle) next;
249 QTAILQ_HEAD(, GuestFileHandle) filehandles;
250 } guest_file_state = {
251 .filehandles = QTAILQ_HEAD_INITIALIZER(guest_file_state.filehandles),
254 static int64_t guest_file_handle_add(FILE *fh, Error **errp)
256 GuestFileHandle *gfh;
259 handle = ga_get_fd_handle(ga_state, errp);
264 gfh = g_new0(GuestFileHandle, 1);
267 QTAILQ_INSERT_TAIL(&guest_file_state.filehandles, gfh, next);
272 GuestFileHandle *guest_file_handle_find(int64_t id, Error **errp)
274 GuestFileHandle *gfh;
276 QTAILQ_FOREACH(gfh, &guest_file_state.filehandles, next)
283 error_setg(errp, "handle '%" PRId64 "' has not been found", id);
287 typedef const char * const ccpc;
293 /* http://pubs.opengroup.org/onlinepubs/9699919799/functions/fopen.html */
294 static const struct {
297 } guest_file_open_modes[] = {
298 { (ccpc[]){ "r", NULL }, O_RDONLY },
299 { (ccpc[]){ "rb", NULL }, O_RDONLY | O_BINARY },
300 { (ccpc[]){ "w", NULL }, O_WRONLY | O_CREAT | O_TRUNC },
301 { (ccpc[]){ "wb", NULL }, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY },
302 { (ccpc[]){ "a", NULL }, O_WRONLY | O_CREAT | O_APPEND },
303 { (ccpc[]){ "ab", NULL }, O_WRONLY | O_CREAT | O_APPEND | O_BINARY },
304 { (ccpc[]){ "r+", NULL }, O_RDWR },
305 { (ccpc[]){ "rb+", "r+b", NULL }, O_RDWR | O_BINARY },
306 { (ccpc[]){ "w+", NULL }, O_RDWR | O_CREAT | O_TRUNC },
307 { (ccpc[]){ "wb+", "w+b", NULL }, O_RDWR | O_CREAT | O_TRUNC | O_BINARY },
308 { (ccpc[]){ "a+", NULL }, O_RDWR | O_CREAT | O_APPEND },
309 { (ccpc[]){ "ab+", "a+b", NULL }, O_RDWR | O_CREAT | O_APPEND | O_BINARY }
313 find_open_flag(const char *mode_str, Error **errp)
317 for (mode = 0; mode < ARRAY_SIZE(guest_file_open_modes); ++mode) {
320 form = guest_file_open_modes[mode].forms;
321 while (*form != NULL && strcmp(*form, mode_str) != 0) {
329 if (mode == ARRAY_SIZE(guest_file_open_modes)) {
330 error_setg(errp, "invalid file open mode '%s'", mode_str);
333 return guest_file_open_modes[mode].oflag_base | O_NOCTTY | O_NONBLOCK;
336 #define DEFAULT_NEW_FILE_MODE (S_IRUSR | S_IWUSR | \
337 S_IRGRP | S_IWGRP | \
341 safe_open_or_create(const char *path, const char *mode, Error **errp)
343 Error *local_err = NULL;
346 oflag = find_open_flag(mode, &local_err);
347 if (local_err == NULL) {
350 /* If the caller wants / allows creation of a new file, we implement it
351 * with a two step process: open() + (open() / fchmod()).
353 * First we insist on creating the file exclusively as a new file. If
354 * that succeeds, we're free to set any file-mode bits on it. (The
355 * motivation is that we want to set those file-mode bits independently
356 * of the current umask.)
358 * If the exclusive creation fails because the file already exists
359 * (EEXIST is not possible for any other reason), we just attempt to
360 * open the file, but in this case we won't be allowed to change the
361 * file-mode bits on the preexistent file.
363 * The pathname should never disappear between the two open()s in
364 * practice. If it happens, then someone very likely tried to race us.
365 * In this case just go ahead and report the ENOENT from the second
366 * open() to the caller.
368 * If the caller wants to open a preexistent file, then the first
369 * open() is decisive and its third argument is ignored, and the second
370 * open() and the fchmod() are never called.
372 fd = open(path, oflag | ((oflag & O_CREAT) ? O_EXCL : 0), 0);
373 if (fd == -1 && errno == EEXIST) {
374 oflag &= ~(unsigned)O_CREAT;
375 fd = open(path, oflag);
379 error_setg_errno(&local_err, errno, "failed to open file '%s' "
380 "(mode: '%s')", path, mode);
382 qemu_set_cloexec(fd);
384 if ((oflag & O_CREAT) && fchmod(fd, DEFAULT_NEW_FILE_MODE) == -1) {
385 error_setg_errno(&local_err, errno, "failed to set permission "
386 "0%03o on new file '%s' (mode: '%s')",
387 (unsigned)DEFAULT_NEW_FILE_MODE, path, mode);
391 f = fdopen(fd, mode);
393 error_setg_errno(&local_err, errno, "failed to associate "
394 "stdio stream with file descriptor %d, "
395 "file '%s' (mode: '%s')", fd, path, mode);
402 if (oflag & O_CREAT) {
408 error_propagate(errp, local_err);
412 int64_t qmp_guest_file_open(const char *path, bool has_mode, const char *mode,
416 Error *local_err = NULL;
422 slog("guest-file-open called, filepath: %s, mode: %s", path, mode);
423 fh = safe_open_or_create(path, mode, &local_err);
424 if (local_err != NULL) {
425 error_propagate(errp, local_err);
429 /* set fd non-blocking to avoid common use cases (like reading from a
430 * named pipe) from hanging the agent
432 qemu_set_nonblock(fileno(fh));
434 handle = guest_file_handle_add(fh, errp);
440 slog("guest-file-open, handle: %" PRId64, handle);
444 void qmp_guest_file_close(int64_t handle, Error **errp)
446 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
449 slog("guest-file-close called, handle: %" PRId64, handle);
454 ret = fclose(gfh->fh);
456 error_setg_errno(errp, errno, "failed to close handle");
460 QTAILQ_REMOVE(&guest_file_state.filehandles, gfh, next);
464 GuestFileRead *guest_file_read_unsafe(GuestFileHandle *gfh,
465 int64_t count, Error **errp)
467 GuestFileRead *read_data = NULL;
472 /* explicitly flush when switching from writing to reading */
473 if (gfh->state == RW_STATE_WRITING) {
474 int ret = fflush(fh);
476 error_setg_errno(errp, errno, "failed to flush file");
479 gfh->state = RW_STATE_NEW;
482 buf = g_malloc0(count+1);
483 read_count = fread(buf, 1, count, fh);
485 error_setg_errno(errp, errno, "failed to read file");
488 read_data = g_new0(GuestFileRead, 1);
489 read_data->count = read_count;
490 read_data->eof = feof(fh);
492 read_data->buf_b64 = g_base64_encode(buf, read_count);
494 gfh->state = RW_STATE_READING;
502 GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64,
503 bool has_count, int64_t count,
506 GuestFileWrite *write_data = NULL;
510 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
519 if (gfh->state == RW_STATE_READING) {
520 int ret = fseek(fh, 0, SEEK_CUR);
522 error_setg_errno(errp, errno, "failed to seek file");
525 gfh->state = RW_STATE_NEW;
528 buf = qbase64_decode(buf_b64, -1, &buf_len, errp);
535 } else if (count < 0 || count > buf_len) {
536 error_setg(errp, "value '%" PRId64 "' is invalid for argument count",
542 write_count = fwrite(buf, 1, count, fh);
544 error_setg_errno(errp, errno, "failed to write to file");
545 slog("guest-file-write failed, handle: %" PRId64, handle);
547 write_data = g_new0(GuestFileWrite, 1);
548 write_data->count = write_count;
549 write_data->eof = feof(fh);
550 gfh->state = RW_STATE_WRITING;
558 struct GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset,
559 GuestFileWhence *whence_code,
562 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
563 GuestFileSeek *seek_data = NULL;
573 /* We stupidly exposed 'whence':'int' in our qapi */
574 whence = ga_parse_whence(whence_code, &err);
576 error_propagate(errp, err);
581 ret = fseek(fh, offset, whence);
583 error_setg_errno(errp, errno, "failed to seek file");
584 if (errno == ESPIPE) {
585 /* file is non-seekable, stdio shouldn't be buffering anyways */
586 gfh->state = RW_STATE_NEW;
589 seek_data = g_new0(GuestFileSeek, 1);
590 seek_data->position = ftell(fh);
591 seek_data->eof = feof(fh);
592 gfh->state = RW_STATE_NEW;
599 void qmp_guest_file_flush(int64_t handle, Error **errp)
601 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
612 error_setg_errno(errp, errno, "failed to flush file");
614 gfh->state = RW_STATE_NEW;
618 /* linux-specific implementations. avoid this if at all possible. */
619 #if defined(__linux__)
621 #if defined(CONFIG_FSFREEZE) || defined(CONFIG_FSTRIM)
622 typedef struct FsMount {
625 unsigned int devmajor, devminor;
626 QTAILQ_ENTRY(FsMount) next;
629 typedef QTAILQ_HEAD(FsMountList, FsMount) FsMountList;
631 static void free_fs_mount_list(FsMountList *mounts)
633 FsMount *mount, *temp;
639 QTAILQ_FOREACH_SAFE(mount, mounts, next, temp) {
640 QTAILQ_REMOVE(mounts, mount, next);
641 g_free(mount->dirname);
642 g_free(mount->devtype);
647 static int dev_major_minor(const char *devpath,
648 unsigned int *devmajor, unsigned int *devminor)
655 if (stat(devpath, &st) < 0) {
656 slog("failed to stat device file '%s': %s", devpath, strerror(errno));
659 if (S_ISDIR(st.st_mode)) {
660 /* It is bind mount */
663 if (S_ISBLK(st.st_mode)) {
664 *devmajor = major(st.st_rdev);
665 *devminor = minor(st.st_rdev);
672 * Walk the mount table and build a list of local file systems
674 static void build_fs_mount_list_from_mtab(FsMountList *mounts, Error **errp)
678 char const *mtab = "/proc/self/mounts";
680 unsigned int devmajor, devminor;
682 fp = setmntent(mtab, "r");
684 error_setg(errp, "failed to open mtab file: '%s'", mtab);
688 while ((ment = getmntent(fp))) {
690 * An entry which device name doesn't start with a '/' is
691 * either a dummy file system or a network file system.
692 * Add special handling for smbfs and cifs as is done by
695 if ((ment->mnt_fsname[0] != '/') ||
696 (strcmp(ment->mnt_type, "smbfs") == 0) ||
697 (strcmp(ment->mnt_type, "cifs") == 0)) {
700 if (dev_major_minor(ment->mnt_fsname, &devmajor, &devminor) == -2) {
701 /* Skip bind mounts */
705 mount = g_new0(FsMount, 1);
706 mount->dirname = g_strdup(ment->mnt_dir);
707 mount->devtype = g_strdup(ment->mnt_type);
708 mount->devmajor = devmajor;
709 mount->devminor = devminor;
711 QTAILQ_INSERT_TAIL(mounts, mount, next);
717 static void decode_mntname(char *name, int len)
720 for (i = 0; i <= len; i++) {
721 if (name[i] != '\\') {
723 } else if (name[i + 1] == '\\') {
726 } else if (name[i + 1] >= '0' && name[i + 1] <= '3' &&
727 name[i + 2] >= '0' && name[i + 2] <= '7' &&
728 name[i + 3] >= '0' && name[i + 3] <= '7') {
729 name[j++] = (name[i + 1] - '0') * 64 +
730 (name[i + 2] - '0') * 8 +
739 static void build_fs_mount_list(FsMountList *mounts, Error **errp)
742 char const *mountinfo = "/proc/self/mountinfo";
744 char *line = NULL, *dash;
747 unsigned int devmajor, devminor;
748 int ret, dir_s, dir_e, type_s, type_e, dev_s, dev_e;
750 fp = fopen(mountinfo, "r");
752 build_fs_mount_list_from_mtab(mounts, errp);
756 while (getline(&line, &n, fp) != -1) {
757 ret = sscanf(line, "%*u %*u %u:%u %*s %n%*s%n%c",
758 &devmajor, &devminor, &dir_s, &dir_e, &check);
762 dash = strstr(line + dir_e, " - ");
766 ret = sscanf(dash, " - %n%*s%n %n%*s%n%c",
767 &type_s, &type_e, &dev_s, &dev_e, &check);
774 decode_mntname(line + dir_s, dir_e - dir_s);
775 decode_mntname(dash + dev_s, dev_e - dev_s);
777 /* btrfs reports major number = 0 */
778 if (strcmp("btrfs", dash + type_s) != 0 ||
779 dev_major_minor(dash + dev_s, &devmajor, &devminor) < 0) {
784 mount = g_new0(FsMount, 1);
785 mount->dirname = g_strdup(line + dir_s);
786 mount->devtype = g_strdup(dash + type_s);
787 mount->devmajor = devmajor;
788 mount->devminor = devminor;
790 QTAILQ_INSERT_TAIL(mounts, mount, next);
798 #if defined(CONFIG_FSFREEZE)
800 static char *get_pci_driver(char const *syspath, int pathlen, Error **errp)
808 path = g_strndup(syspath, pathlen);
809 dpath = g_strdup_printf("%s/driver", path);
810 len = readlink(dpath, buf, sizeof(buf) - 1);
813 driver = g_path_get_basename(buf);
820 static int compare_uint(const void *_a, const void *_b)
822 unsigned int a = *(unsigned int *)_a;
823 unsigned int b = *(unsigned int *)_b;
825 return a < b ? -1 : a > b ? 1 : 0;
828 /* Walk the specified sysfs and build a sorted list of host or ata numbers */
829 static int build_hosts(char const *syspath, char const *host, bool ata,
830 unsigned int *hosts, int hosts_max, Error **errp)
834 struct dirent *entry;
837 path = g_strndup(syspath, host - syspath);
840 error_setg_errno(errp, errno, "opendir(\"%s\")", path);
845 while (i < hosts_max) {
846 entry = readdir(dir);
850 if (ata && sscanf(entry->d_name, "ata%d", hosts + i) == 1) {
852 } else if (!ata && sscanf(entry->d_name, "host%d", hosts + i) == 1) {
857 qsort(hosts, i, sizeof(hosts[0]), compare_uint);
865 * Store disk device info for devices on the PCI bus.
866 * Returns true if information has been stored, or false for failure.
868 static bool build_guest_fsinfo_for_pci_dev(char const *syspath,
869 GuestDiskAddress *disk,
872 unsigned int pci[4], host, hosts[8], tgt[3];
873 int i, nhosts = 0, pcilen;
874 GuestPCIAddress *pciaddr = disk->pci_controller;
875 bool has_ata = false, has_host = false, has_tgt = false;
876 char *p, *q, *driver = NULL;
879 p = strstr(syspath, "/devices/pci");
880 if (!p || sscanf(p + 12, "%*x:%*x/%x:%x:%x.%x%n",
881 pci, pci + 1, pci + 2, pci + 3, &pcilen) < 4) {
882 g_debug("only pci device is supported: sysfs path '%s'", syspath);
888 driver = get_pci_driver(syspath, p - syspath, errp);
889 if (driver && (g_str_equal(driver, "ata_piix") ||
890 g_str_equal(driver, "sym53c8xx") ||
891 g_str_equal(driver, "virtio-pci") ||
892 g_str_equal(driver, "ahci"))) {
897 if (sscanf(p, "/%x:%x:%x.%x%n",
898 pci, pci + 1, pci + 2, pci + 3, &pcilen) == 4) {
903 g_debug("unsupported driver or sysfs path '%s'", syspath);
907 p = strstr(syspath, "/target");
908 if (p && sscanf(p + 7, "%*u:%*u:%*u/%*u:%u:%u:%u",
909 tgt, tgt + 1, tgt + 2) == 3) {
913 p = strstr(syspath, "/ata");
918 p = strstr(syspath, "/host");
921 if (p && sscanf(q, "%u", &host) == 1) {
923 nhosts = build_hosts(syspath, p, has_ata, hosts,
924 ARRAY_SIZE(hosts), errp);
930 pciaddr->domain = pci[0];
931 pciaddr->bus = pci[1];
932 pciaddr->slot = pci[2];
933 pciaddr->function = pci[3];
935 if (strcmp(driver, "ata_piix") == 0) {
936 /* a host per ide bus, target*:0:<unit>:0 */
937 if (!has_host || !has_tgt) {
938 g_debug("invalid sysfs path '%s' (driver '%s')", syspath, driver);
941 for (i = 0; i < nhosts; i++) {
942 if (host == hosts[i]) {
943 disk->bus_type = GUEST_DISK_BUS_TYPE_IDE;
950 g_debug("no host for '%s' (driver '%s')", syspath, driver);
953 } else if (strcmp(driver, "sym53c8xx") == 0) {
954 /* scsi(LSI Logic): target*:0:<unit>:0 */
956 g_debug("invalid sysfs path '%s' (driver '%s')", syspath, driver);
959 disk->bus_type = GUEST_DISK_BUS_TYPE_SCSI;
961 } else if (strcmp(driver, "virtio-pci") == 0) {
963 /* virtio-scsi: target*:0:0:<unit> */
964 disk->bus_type = GUEST_DISK_BUS_TYPE_SCSI;
967 /* virtio-blk: 1 disk per 1 device */
968 disk->bus_type = GUEST_DISK_BUS_TYPE_VIRTIO;
970 } else if (strcmp(driver, "ahci") == 0) {
971 /* ahci: 1 host per 1 unit */
972 if (!has_host || !has_tgt) {
973 g_debug("invalid sysfs path '%s' (driver '%s')", syspath, driver);
976 for (i = 0; i < nhosts; i++) {
977 if (host == hosts[i]) {
979 disk->bus_type = GUEST_DISK_BUS_TYPE_SATA;
984 g_debug("no host for '%s' (driver '%s')", syspath, driver);
988 g_debug("unknown driver '%s' (sysfs path '%s')", driver, syspath);
1000 * Store disk device info for non-PCI virtio devices (for example s390x
1001 * channel I/O devices). Returns true if information has been stored, or
1002 * false for failure.
1004 static bool build_guest_fsinfo_for_nonpci_virtio(char const *syspath,
1005 GuestDiskAddress *disk,
1008 unsigned int tgt[3];
1011 if (!strstr(syspath, "/virtio") || !strstr(syspath, "/block")) {
1012 g_debug("Unsupported virtio device '%s'", syspath);
1016 p = strstr(syspath, "/target");
1017 if (p && sscanf(p + 7, "%*u:%*u:%*u/%*u:%u:%u:%u",
1018 &tgt[0], &tgt[1], &tgt[2]) == 3) {
1019 /* virtio-scsi: target*:0:<target>:<unit> */
1020 disk->bus_type = GUEST_DISK_BUS_TYPE_SCSI;
1022 disk->target = tgt[1];
1023 disk->unit = tgt[2];
1025 /* virtio-blk: 1 disk per 1 device */
1026 disk->bus_type = GUEST_DISK_BUS_TYPE_VIRTIO;
1032 /* Store disk device info specified by @sysfs into @fs */
1033 static void build_guest_fsinfo_for_real_device(char const *syspath,
1034 GuestFilesystemInfo *fs,
1037 GuestDiskAddress *disk;
1038 GuestPCIAddress *pciaddr;
1039 GuestDiskAddressList *list = NULL;
1041 #ifdef CONFIG_LIBUDEV
1042 struct udev *udev = NULL;
1043 struct udev_device *udevice = NULL;
1046 pciaddr = g_new0(GuestPCIAddress, 1);
1047 pciaddr->domain = -1; /* -1 means field is invalid */
1050 pciaddr->function = -1;
1052 disk = g_new0(GuestDiskAddress, 1);
1053 disk->pci_controller = pciaddr;
1054 disk->bus_type = GUEST_DISK_BUS_TYPE_UNKNOWN;
1056 list = g_new0(GuestDiskAddressList, 1);
1059 #ifdef CONFIG_LIBUDEV
1061 udevice = udev_device_new_from_syspath(udev, syspath);
1062 if (udev == NULL || udevice == NULL) {
1063 g_debug("failed to query udev");
1065 const char *devnode, *serial;
1066 devnode = udev_device_get_devnode(udevice);
1067 if (devnode != NULL) {
1068 disk->dev = g_strdup(devnode);
1069 disk->has_dev = true;
1071 serial = udev_device_get_property_value(udevice, "ID_SERIAL");
1072 if (serial != NULL && *serial != 0) {
1073 disk->serial = g_strdup(serial);
1074 disk->has_serial = true;
1079 udev_device_unref(udevice);
1082 if (strstr(syspath, "/devices/pci")) {
1083 has_hwinf = build_guest_fsinfo_for_pci_dev(syspath, disk, errp);
1084 } else if (strstr(syspath, "/virtio")) {
1085 has_hwinf = build_guest_fsinfo_for_nonpci_virtio(syspath, disk, errp);
1087 g_debug("Unsupported device type for '%s'", syspath);
1091 if (has_hwinf || disk->has_dev || disk->has_serial) {
1092 list->next = fs->disk;
1095 qapi_free_GuestDiskAddressList(list);
1099 static void build_guest_fsinfo_for_device(char const *devpath,
1100 GuestFilesystemInfo *fs,
1103 /* Store a list of slave devices of virtual volume specified by @syspath into
1105 static void build_guest_fsinfo_for_virtual_device(char const *syspath,
1106 GuestFilesystemInfo *fs,
1112 struct dirent *entry;
1114 dirpath = g_strdup_printf("%s/slaves", syspath);
1115 dir = opendir(dirpath);
1117 if (errno != ENOENT) {
1118 error_setg_errno(errp, errno, "opendir(\"%s\")", dirpath);
1126 entry = readdir(dir);
1127 if (entry == NULL) {
1129 error_setg_errno(errp, errno, "readdir(\"%s\")", dirpath);
1134 if (entry->d_type == DT_LNK) {
1137 g_debug(" slave device '%s'", entry->d_name);
1138 path = g_strdup_printf("%s/slaves/%s", syspath, entry->d_name);
1139 build_guest_fsinfo_for_device(path, fs, &err);
1143 error_propagate(errp, err);
1153 static bool is_disk_virtual(const char *devpath, Error **errp)
1155 g_autofree char *syspath = realpath(devpath, NULL);
1158 error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
1161 return strstr(syspath, "/devices/virtual/block/") != NULL;
1164 /* Dispatch to functions for virtual/real device */
1165 static void build_guest_fsinfo_for_device(char const *devpath,
1166 GuestFilesystemInfo *fs,
1170 g_autofree char *syspath = NULL;
1171 bool is_virtual = false;
1173 syspath = realpath(devpath, NULL);
1175 error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
1180 fs->name = g_path_get_basename(syspath);
1183 g_debug(" parse sysfs path '%s'", syspath);
1184 is_virtual = is_disk_virtual(syspath, errp);
1185 if (*errp != NULL) {
1189 build_guest_fsinfo_for_virtual_device(syspath, fs, errp);
1191 build_guest_fsinfo_for_real_device(syspath, fs, errp);
1195 #ifdef CONFIG_LIBUDEV
1198 * Wrapper around build_guest_fsinfo_for_device() for getting just
1201 static GuestDiskAddress *get_disk_address(const char *syspath, Error **errp)
1203 g_autoptr(GuestFilesystemInfo) fs = NULL;
1205 fs = g_new0(GuestFilesystemInfo, 1);
1206 build_guest_fsinfo_for_device(syspath, fs, errp);
1207 if (fs->disk != NULL) {
1208 return g_steal_pointer(&fs->disk->value);
1213 static char *get_alias_for_syspath(const char *syspath)
1215 struct udev *udev = NULL;
1216 struct udev_device *udevice = NULL;
1221 g_debug("failed to query udev");
1224 udevice = udev_device_new_from_syspath(udev, syspath);
1225 if (udevice == NULL) {
1226 g_debug("failed to query udev for path: %s", syspath);
1229 const char *alias = udev_device_get_property_value(
1230 udevice, "DM_NAME");
1232 * NULL means there was an error and empty string means there is no
1233 * alias. In case of no alias we return NULL instead of empty string.
1235 if (alias == NULL) {
1236 g_debug("failed to query udev for device alias for: %s",
1238 } else if (*alias != 0) {
1239 ret = g_strdup(alias);
1245 udev_device_unref(udevice);
1249 static char *get_device_for_syspath(const char *syspath)
1251 struct udev *udev = NULL;
1252 struct udev_device *udevice = NULL;
1257 g_debug("failed to query udev");
1260 udevice = udev_device_new_from_syspath(udev, syspath);
1261 if (udevice == NULL) {
1262 g_debug("failed to query udev for path: %s", syspath);
1265 ret = g_strdup(udev_device_get_devnode(udevice));
1270 udev_device_unref(udevice);
1274 static void get_disk_deps(const char *disk_dir, GuestDiskInfo *disk)
1276 g_autofree char *deps_dir = NULL;
1278 GDir *dp_deps = NULL;
1280 /* List dependent disks */
1281 deps_dir = g_strdup_printf("%s/slaves", disk_dir);
1282 g_debug(" listing entries in: %s", deps_dir);
1283 dp_deps = g_dir_open(deps_dir, 0, NULL);
1284 if (dp_deps == NULL) {
1285 g_debug("failed to list entries in %s", deps_dir);
1288 disk->has_dependencies = true;
1289 while ((dep = g_dir_read_name(dp_deps)) != NULL) {
1290 g_autofree char *dep_dir = NULL;
1291 strList *dep_item = NULL;
1294 /* Add dependent disks */
1295 dep_dir = g_strdup_printf("%s/%s", deps_dir, dep);
1296 dev_name = get_device_for_syspath(dep_dir);
1297 if (dev_name != NULL) {
1298 g_debug(" adding dependent device: %s", dev_name);
1299 dep_item = g_new0(strList, 1);
1300 dep_item->value = dev_name;
1301 dep_item->next = disk->dependencies;
1302 disk->dependencies = dep_item;
1305 g_dir_close(dp_deps);
1309 * Detect partitions subdirectory, name is "<disk_name><number>" or
1310 * "<disk_name>p<number>"
1312 * @disk_name -- last component of /sys path (e.g. sda)
1313 * @disk_dir -- sys path of the disk (e.g. /sys/block/sda)
1314 * @disk_dev -- device node of the disk (e.g. /dev/sda)
1316 static GuestDiskInfoList *get_disk_partitions(
1317 GuestDiskInfoList *list,
1318 const char *disk_name, const char *disk_dir,
1319 const char *disk_dev)
1321 GuestDiskInfoList *item, *ret = list;
1322 struct dirent *de_disk;
1323 DIR *dp_disk = NULL;
1324 size_t len = strlen(disk_name);
1326 dp_disk = opendir(disk_dir);
1327 while ((de_disk = readdir(dp_disk)) != NULL) {
1328 g_autofree char *partition_dir = NULL;
1330 GuestDiskInfo *partition;
1332 if (!(de_disk->d_type & DT_DIR)) {
1336 if (!(strncmp(disk_name, de_disk->d_name, len) == 0 &&
1337 ((*(de_disk->d_name + len) == 'p' &&
1338 isdigit(*(de_disk->d_name + len + 1))) ||
1339 isdigit(*(de_disk->d_name + len))))) {
1343 partition_dir = g_strdup_printf("%s/%s",
1344 disk_dir, de_disk->d_name);
1345 dev_name = get_device_for_syspath(partition_dir);
1346 if (dev_name == NULL) {
1347 g_debug("Failed to get device name for syspath: %s",
1351 partition = g_new0(GuestDiskInfo, 1);
1352 partition->name = dev_name;
1353 partition->partition = true;
1354 /* Add parent disk as dependent for easier tracking of hierarchy */
1355 partition->dependencies = g_new0(strList, 1);
1356 partition->dependencies->value = g_strdup(disk_dev);
1357 partition->has_dependencies = true;
1359 item = g_new0(GuestDiskInfoList, 1);
1360 item->value = partition;
1370 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1372 GuestDiskInfoList *item, *ret = NULL;
1373 GuestDiskInfo *disk;
1375 struct dirent *de = NULL;
1377 g_debug("listing /sys/block directory");
1378 dp = opendir("/sys/block");
1380 error_setg_errno(errp, errno, "Can't open directory \"/sys/block\"");
1383 while ((de = readdir(dp)) != NULL) {
1384 g_autofree char *disk_dir = NULL, *line = NULL,
1387 Error *local_err = NULL;
1388 if (de->d_type != DT_LNK) {
1389 g_debug(" skipping entry: %s", de->d_name);
1393 /* Check size and skip zero-sized disks */
1394 g_debug(" checking disk size");
1395 size_path = g_strdup_printf("/sys/block/%s/size", de->d_name);
1396 if (!g_file_get_contents(size_path, &line, NULL, NULL)) {
1397 g_debug(" failed to read disk size");
1400 if (g_strcmp0(line, "0\n") == 0) {
1401 g_debug(" skipping zero-sized disk");
1405 g_debug(" adding %s", de->d_name);
1406 disk_dir = g_strdup_printf("/sys/block/%s", de->d_name);
1407 dev_name = get_device_for_syspath(disk_dir);
1408 if (dev_name == NULL) {
1409 g_debug("Failed to get device name for syspath: %s",
1413 disk = g_new0(GuestDiskInfo, 1);
1414 disk->name = dev_name;
1415 disk->partition = false;
1416 disk->alias = get_alias_for_syspath(disk_dir);
1417 disk->has_alias = (disk->alias != NULL);
1418 item = g_new0(GuestDiskInfoList, 1);
1423 /* Get address for non-virtual devices */
1424 bool is_virtual = is_disk_virtual(disk_dir, &local_err);
1425 if (local_err != NULL) {
1426 g_debug(" failed to check disk path, ignoring error: %s",
1427 error_get_pretty(local_err));
1428 error_free(local_err);
1430 /* Don't try to get the address */
1434 disk->address = get_disk_address(disk_dir, &local_err);
1435 if (local_err != NULL) {
1436 g_debug(" failed to get device info, ignoring error: %s",
1437 error_get_pretty(local_err));
1438 error_free(local_err);
1440 } else if (disk->address != NULL) {
1441 disk->has_address = true;
1445 get_disk_deps(disk_dir, disk);
1446 ret = get_disk_partitions(ret, de->d_name, disk_dir, dev_name);
1456 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1458 error_setg(errp, QERR_UNSUPPORTED);
1464 /* Return a list of the disk device(s)' info which @mount lies on */
1465 static GuestFilesystemInfo *build_guest_fsinfo(struct FsMount *mount,
1468 GuestFilesystemInfo *fs = g_malloc0(sizeof(*fs));
1470 unsigned long used, nonroot_total, fr_size;
1471 char *devpath = g_strdup_printf("/sys/dev/block/%u:%u",
1472 mount->devmajor, mount->devminor);
1474 fs->mountpoint = g_strdup(mount->dirname);
1475 fs->type = g_strdup(mount->devtype);
1476 build_guest_fsinfo_for_device(devpath, fs, errp);
1478 if (statvfs(fs->mountpoint, &buf) == 0) {
1479 fr_size = buf.f_frsize;
1480 used = buf.f_blocks - buf.f_bfree;
1481 nonroot_total = used + buf.f_bavail;
1482 fs->used_bytes = used * fr_size;
1483 fs->total_bytes = nonroot_total * fr_size;
1485 fs->has_total_bytes = true;
1486 fs->has_used_bytes = true;
1494 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
1497 struct FsMount *mount;
1498 GuestFilesystemInfoList *new, *ret = NULL;
1499 Error *local_err = NULL;
1501 QTAILQ_INIT(&mounts);
1502 build_fs_mount_list(&mounts, &local_err);
1504 error_propagate(errp, local_err);
1508 QTAILQ_FOREACH(mount, &mounts, next) {
1509 g_debug("Building guest fsinfo for '%s'", mount->dirname);
1511 new = g_malloc0(sizeof(*ret));
1512 new->value = build_guest_fsinfo(mount, &local_err);
1516 error_propagate(errp, local_err);
1517 qapi_free_GuestFilesystemInfoList(ret);
1523 free_fs_mount_list(&mounts);
1529 FSFREEZE_HOOK_THAW = 0,
1530 FSFREEZE_HOOK_FREEZE,
1533 static const char *fsfreeze_hook_arg_string[] = {
1538 static void execute_fsfreeze_hook(FsfreezeHookArg arg, Error **errp)
1543 const char *arg_str = fsfreeze_hook_arg_string[arg];
1544 Error *local_err = NULL;
1546 hook = ga_fsfreeze_hook(ga_state);
1550 if (access(hook, X_OK) != 0) {
1551 error_setg_errno(errp, errno, "can't access fsfreeze hook '%s'", hook);
1555 slog("executing fsfreeze hook with arg '%s'", arg_str);
1559 reopen_fd_to_null(0);
1560 reopen_fd_to_null(1);
1561 reopen_fd_to_null(2);
1563 execle(hook, hook, arg_str, NULL, environ);
1564 _exit(EXIT_FAILURE);
1565 } else if (pid < 0) {
1566 error_setg_errno(errp, errno, "failed to create child process");
1570 ga_wait_child(pid, &status, &local_err);
1572 error_propagate(errp, local_err);
1576 if (!WIFEXITED(status)) {
1577 error_setg(errp, "fsfreeze hook has terminated abnormally");
1581 status = WEXITSTATUS(status);
1583 error_setg(errp, "fsfreeze hook has failed with status %d", status);
1589 * Return status of freeze/thaw
1591 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
1593 if (ga_is_frozen(ga_state)) {
1594 return GUEST_FSFREEZE_STATUS_FROZEN;
1597 return GUEST_FSFREEZE_STATUS_THAWED;
1600 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
1602 return qmp_guest_fsfreeze_freeze_list(false, NULL, errp);
1606 * Walk list of mounted file systems in the guest, and freeze the ones which
1607 * are real local file systems.
1609 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
1610 strList *mountpoints,
1616 struct FsMount *mount;
1617 Error *local_err = NULL;
1620 slog("guest-fsfreeze called");
1622 execute_fsfreeze_hook(FSFREEZE_HOOK_FREEZE, &local_err);
1624 error_propagate(errp, local_err);
1628 QTAILQ_INIT(&mounts);
1629 build_fs_mount_list(&mounts, &local_err);
1631 error_propagate(errp, local_err);
1635 /* cannot risk guest agent blocking itself on a write in this state */
1636 ga_set_frozen(ga_state);
1638 QTAILQ_FOREACH_REVERSE(mount, &mounts, next) {
1639 /* To issue fsfreeze in the reverse order of mounts, check if the
1640 * mount is listed in the list here */
1641 if (has_mountpoints) {
1642 for (list = mountpoints; list; list = list->next) {
1643 if (strcmp(list->value, mount->dirname) == 0) {
1652 fd = qemu_open_old(mount->dirname, O_RDONLY);
1654 error_setg_errno(errp, errno, "failed to open %s", mount->dirname);
1658 /* we try to cull filesystems we know won't work in advance, but other
1659 * filesystems may not implement fsfreeze for less obvious reasons.
1660 * these will report EOPNOTSUPP. we simply ignore these when tallying
1661 * the number of frozen filesystems.
1662 * if a filesystem is mounted more than once (aka bind mount) a
1663 * consecutive attempt to freeze an already frozen filesystem will
1666 * any other error means a failure to freeze a filesystem we
1667 * expect to be freezable, so return an error in those cases
1668 * and return system to thawed state.
1670 ret = ioctl(fd, FIFREEZE);
1672 if (errno != EOPNOTSUPP && errno != EBUSY) {
1673 error_setg_errno(errp, errno, "failed to freeze %s",
1684 free_fs_mount_list(&mounts);
1685 /* We may not issue any FIFREEZE here.
1686 * Just unset ga_state here and ready for the next call.
1689 ga_unset_frozen(ga_state);
1694 free_fs_mount_list(&mounts);
1695 qmp_guest_fsfreeze_thaw(NULL);
1700 * Walk list of frozen file systems in the guest, and thaw them.
1702 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1707 int fd, i = 0, logged;
1708 Error *local_err = NULL;
1710 QTAILQ_INIT(&mounts);
1711 build_fs_mount_list(&mounts, &local_err);
1713 error_propagate(errp, local_err);
1717 QTAILQ_FOREACH(mount, &mounts, next) {
1719 fd = qemu_open_old(mount->dirname, O_RDONLY);
1723 /* we have no way of knowing whether a filesystem was actually unfrozen
1724 * as a result of a successful call to FITHAW, only that if an error
1725 * was returned the filesystem was *not* unfrozen by that particular
1728 * since multiple preceding FIFREEZEs require multiple calls to FITHAW
1729 * to unfreeze, continuing issuing FITHAW until an error is returned,
1730 * in which case either the filesystem is in an unfreezable state, or,
1731 * more likely, it was thawed previously (and remains so afterward).
1733 * also, since the most recent successful call is the one that did
1734 * the actual unfreeze, we can use this to provide an accurate count
1735 * of the number of filesystems unfrozen by guest-fsfreeze-thaw, which
1736 * may * be useful for determining whether a filesystem was unfrozen
1737 * during the freeze/thaw phase by a process other than qemu-ga.
1740 ret = ioctl(fd, FITHAW);
1741 if (ret == 0 && !logged) {
1749 ga_unset_frozen(ga_state);
1750 free_fs_mount_list(&mounts);
1752 execute_fsfreeze_hook(FSFREEZE_HOOK_THAW, errp);
1757 static void guest_fsfreeze_cleanup(void)
1761 if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1762 qmp_guest_fsfreeze_thaw(&err);
1764 slog("failed to clean up frozen filesystems: %s",
1765 error_get_pretty(err));
1770 #endif /* CONFIG_FSFREEZE */
1772 #if defined(CONFIG_FSTRIM)
1774 * Walk list of mounted file systems in the guest, and trim them.
1776 GuestFilesystemTrimResponse *
1777 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1779 GuestFilesystemTrimResponse *response;
1780 GuestFilesystemTrimResultList *list;
1781 GuestFilesystemTrimResult *result;
1784 struct FsMount *mount;
1786 Error *local_err = NULL;
1787 struct fstrim_range r;
1789 slog("guest-fstrim called");
1791 QTAILQ_INIT(&mounts);
1792 build_fs_mount_list(&mounts, &local_err);
1794 error_propagate(errp, local_err);
1798 response = g_malloc0(sizeof(*response));
1800 QTAILQ_FOREACH(mount, &mounts, next) {
1801 result = g_malloc0(sizeof(*result));
1802 result->path = g_strdup(mount->dirname);
1804 list = g_malloc0(sizeof(*list));
1805 list->value = result;
1806 list->next = response->paths;
1807 response->paths = list;
1809 fd = qemu_open_old(mount->dirname, O_RDONLY);
1811 result->error = g_strdup_printf("failed to open: %s",
1813 result->has_error = true;
1817 /* We try to cull filesystems we know won't work in advance, but other
1818 * filesystems may not implement fstrim for less obvious reasons.
1819 * These will report EOPNOTSUPP; while in some other cases ENOTTY
1820 * will be reported (e.g. CD-ROMs).
1821 * Any other error means an unexpected error.
1825 r.minlen = has_minimum ? minimum : 0;
1826 ret = ioctl(fd, FITRIM, &r);
1828 result->has_error = true;
1829 if (errno == ENOTTY || errno == EOPNOTSUPP) {
1830 result->error = g_strdup("trim not supported");
1832 result->error = g_strdup_printf("failed to trim: %s",
1839 result->has_minimum = true;
1840 result->minimum = r.minlen;
1841 result->has_trimmed = true;
1842 result->trimmed = r.len;
1846 free_fs_mount_list(&mounts);
1849 #endif /* CONFIG_FSTRIM */
1852 #define LINUX_SYS_STATE_FILE "/sys/power/state"
1853 #define SUSPEND_SUPPORTED 0
1854 #define SUSPEND_NOT_SUPPORTED 1
1857 SUSPEND_MODE_DISK = 0,
1858 SUSPEND_MODE_RAM = 1,
1859 SUSPEND_MODE_HYBRID = 2,
1863 * Executes a command in a child process using g_spawn_sync,
1864 * returning an int >= 0 representing the exit status of the
1867 * If the program wasn't found in path, returns -1.
1869 * If a problem happened when creating the child process,
1870 * returns -1 and errp is set.
1872 static int run_process_child(const char *command[], Error **errp)
1874 int exit_status, spawn_flag;
1875 GError *g_err = NULL;
1878 spawn_flag = G_SPAWN_SEARCH_PATH | G_SPAWN_STDOUT_TO_DEV_NULL |
1879 G_SPAWN_STDERR_TO_DEV_NULL;
1881 success = g_spawn_sync(NULL, (char **)command, environ, spawn_flag,
1882 NULL, NULL, NULL, NULL,
1883 &exit_status, &g_err);
1886 return WEXITSTATUS(exit_status);
1889 if (g_err && (g_err->code != G_SPAWN_ERROR_NOENT)) {
1890 error_setg(errp, "failed to create child process, error '%s'",
1894 g_error_free(g_err);
1898 static bool systemd_supports_mode(SuspendMode mode, Error **errp)
1900 const char *systemctl_args[3] = {"systemd-hibernate", "systemd-suspend",
1901 "systemd-hybrid-sleep"};
1902 const char *cmd[4] = {"systemctl", "status", systemctl_args[mode], NULL};
1905 status = run_process_child(cmd, errp);
1908 * systemctl status uses LSB return codes so we can expect
1909 * status > 0 and be ok. To assert if the guest has support
1910 * for the selected suspend mode, status should be < 4. 4 is
1911 * the code for unknown service status, the return value when
1912 * the service does not exist. A common value is status = 3
1913 * (program is not running).
1915 if (status > 0 && status < 4) {
1922 static void systemd_suspend(SuspendMode mode, Error **errp)
1924 Error *local_err = NULL;
1925 const char *systemctl_args[3] = {"hibernate", "suspend", "hybrid-sleep"};
1926 const char *cmd[3] = {"systemctl", systemctl_args[mode], NULL};
1929 status = run_process_child(cmd, &local_err);
1935 if ((status == -1) && !local_err) {
1936 error_setg(errp, "the helper program 'systemctl %s' was not found",
1937 systemctl_args[mode]);
1942 error_propagate(errp, local_err);
1944 error_setg(errp, "the helper program 'systemctl %s' returned an "
1945 "unexpected exit status code (%d)",
1946 systemctl_args[mode], status);
1950 static bool pmutils_supports_mode(SuspendMode mode, Error **errp)
1952 Error *local_err = NULL;
1953 const char *pmutils_args[3] = {"--hibernate", "--suspend",
1954 "--suspend-hybrid"};
1955 const char *cmd[3] = {"pm-is-supported", pmutils_args[mode], NULL};
1958 status = run_process_child(cmd, &local_err);
1960 if (status == SUSPEND_SUPPORTED) {
1964 if ((status == -1) && !local_err) {
1969 error_propagate(errp, local_err);
1972 "the helper program '%s' returned an unexpected exit"
1973 " status code (%d)", "pm-is-supported", status);
1979 static void pmutils_suspend(SuspendMode mode, Error **errp)
1981 Error *local_err = NULL;
1982 const char *pmutils_binaries[3] = {"pm-hibernate", "pm-suspend",
1983 "pm-suspend-hybrid"};
1984 const char *cmd[2] = {pmutils_binaries[mode], NULL};
1987 status = run_process_child(cmd, &local_err);
1993 if ((status == -1) && !local_err) {
1994 error_setg(errp, "the helper program '%s' was not found",
1995 pmutils_binaries[mode]);
2000 error_propagate(errp, local_err);
2003 "the helper program '%s' returned an unexpected exit"
2004 " status code (%d)", pmutils_binaries[mode], status);
2008 static bool linux_sys_state_supports_mode(SuspendMode mode, Error **errp)
2010 const char *sysfile_strs[3] = {"disk", "mem", NULL};
2011 const char *sysfile_str = sysfile_strs[mode];
2012 char buf[32]; /* hopefully big enough */
2017 error_setg(errp, "unknown guest suspend mode");
2021 fd = open(LINUX_SYS_STATE_FILE, O_RDONLY);
2026 ret = read(fd, buf, sizeof(buf) - 1);
2033 if (strstr(buf, sysfile_str)) {
2039 static void linux_sys_state_suspend(SuspendMode mode, Error **errp)
2041 Error *local_err = NULL;
2042 const char *sysfile_strs[3] = {"disk", "mem", NULL};
2043 const char *sysfile_str = sysfile_strs[mode];
2048 error_setg(errp, "unknown guest suspend mode");
2058 reopen_fd_to_null(0);
2059 reopen_fd_to_null(1);
2060 reopen_fd_to_null(2);
2062 fd = open(LINUX_SYS_STATE_FILE, O_WRONLY);
2064 _exit(EXIT_FAILURE);
2067 if (write(fd, sysfile_str, strlen(sysfile_str)) < 0) {
2068 _exit(EXIT_FAILURE);
2071 _exit(EXIT_SUCCESS);
2072 } else if (pid < 0) {
2073 error_setg_errno(errp, errno, "failed to create child process");
2077 ga_wait_child(pid, &status, &local_err);
2079 error_propagate(errp, local_err);
2083 if (WEXITSTATUS(status)) {
2084 error_setg(errp, "child process has failed to suspend");
2089 static void guest_suspend(SuspendMode mode, Error **errp)
2091 Error *local_err = NULL;
2092 bool mode_supported = false;
2094 if (systemd_supports_mode(mode, &local_err)) {
2095 mode_supported = true;
2096 systemd_suspend(mode, &local_err);
2103 error_free(local_err);
2106 if (pmutils_supports_mode(mode, &local_err)) {
2107 mode_supported = true;
2108 pmutils_suspend(mode, &local_err);
2115 error_free(local_err);
2118 if (linux_sys_state_supports_mode(mode, &local_err)) {
2119 mode_supported = true;
2120 linux_sys_state_suspend(mode, &local_err);
2123 if (!mode_supported) {
2124 error_free(local_err);
2126 "the requested suspend mode is not supported by the guest");
2128 error_propagate(errp, local_err);
2132 void qmp_guest_suspend_disk(Error **errp)
2134 guest_suspend(SUSPEND_MODE_DISK, errp);
2137 void qmp_guest_suspend_ram(Error **errp)
2139 guest_suspend(SUSPEND_MODE_RAM, errp);
2142 void qmp_guest_suspend_hybrid(Error **errp)
2144 guest_suspend(SUSPEND_MODE_HYBRID, errp);
2147 static GuestNetworkInterfaceList *
2148 guest_find_interface(GuestNetworkInterfaceList *head,
2151 for (; head; head = head->next) {
2152 if (strcmp(head->value->name, name) == 0) {
2160 static int guest_get_network_stats(const char *name,
2161 GuestNetworkInterfaceStat *stats)
2164 char const *devinfo = "/proc/net/dev";
2166 char *line = NULL, *colon;
2168 fp = fopen(devinfo, "r");
2172 name_len = strlen(name);
2173 while (getline(&line, &n, fp) != -1) {
2176 long long rx_packets;
2178 long long rx_dropped;
2180 long long tx_packets;
2182 long long tx_dropped;
2184 trim_line = g_strchug(line);
2185 if (trim_line[0] == '\0') {
2188 colon = strchr(trim_line, ':');
2192 if (colon - name_len == trim_line &&
2193 strncmp(trim_line, name, name_len) == 0) {
2194 if (sscanf(colon + 1,
2195 "%lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld",
2196 &rx_bytes, &rx_packets, &rx_errs, &rx_dropped,
2197 &dummy, &dummy, &dummy, &dummy,
2198 &tx_bytes, &tx_packets, &tx_errs, &tx_dropped,
2199 &dummy, &dummy, &dummy, &dummy) != 16) {
2202 stats->rx_bytes = rx_bytes;
2203 stats->rx_packets = rx_packets;
2204 stats->rx_errs = rx_errs;
2205 stats->rx_dropped = rx_dropped;
2206 stats->tx_bytes = tx_bytes;
2207 stats->tx_packets = tx_packets;
2208 stats->tx_errs = tx_errs;
2209 stats->tx_dropped = tx_dropped;
2217 g_debug("/proc/net/dev: Interface '%s' not found", name);
2222 * Build information about guest interfaces
2224 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
2226 GuestNetworkInterfaceList *head = NULL, *cur_item = NULL;
2227 struct ifaddrs *ifap, *ifa;
2229 if (getifaddrs(&ifap) < 0) {
2230 error_setg_errno(errp, errno, "getifaddrs failed");
2234 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
2235 GuestNetworkInterfaceList *info;
2236 GuestIpAddressList **address_list = NULL, *address_item = NULL;
2237 GuestNetworkInterfaceStat *interface_stat = NULL;
2238 char addr4[INET_ADDRSTRLEN];
2239 char addr6[INET6_ADDRSTRLEN];
2242 unsigned char *mac_addr;
2245 g_debug("Processing %s interface", ifa->ifa_name);
2247 info = guest_find_interface(head, ifa->ifa_name);
2250 info = g_malloc0(sizeof(*info));
2251 info->value = g_malloc0(sizeof(*info->value));
2252 info->value->name = g_strdup(ifa->ifa_name);
2255 head = cur_item = info;
2257 cur_item->next = info;
2262 if (!info->value->has_hardware_address &&
2263 ifa->ifa_flags & SIOCGIFHWADDR) {
2264 /* we haven't obtained HW address yet */
2265 sock = socket(PF_INET, SOCK_STREAM, 0);
2267 error_setg_errno(errp, errno, "failed to create socket");
2271 memset(&ifr, 0, sizeof(ifr));
2272 pstrcpy(ifr.ifr_name, IF_NAMESIZE, info->value->name);
2273 if (ioctl(sock, SIOCGIFHWADDR, &ifr) == -1) {
2274 error_setg_errno(errp, errno,
2275 "failed to get MAC address of %s",
2282 mac_addr = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
2284 info->value->hardware_address =
2285 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
2286 (int) mac_addr[0], (int) mac_addr[1],
2287 (int) mac_addr[2], (int) mac_addr[3],
2288 (int) mac_addr[4], (int) mac_addr[5]);
2290 info->value->has_hardware_address = true;
2293 if (ifa->ifa_addr &&
2294 ifa->ifa_addr->sa_family == AF_INET) {
2295 /* interface with IPv4 address */
2296 p = &((struct sockaddr_in *)ifa->ifa_addr)->sin_addr;
2297 if (!inet_ntop(AF_INET, p, addr4, sizeof(addr4))) {
2298 error_setg_errno(errp, errno, "inet_ntop failed");
2302 address_item = g_malloc0(sizeof(*address_item));
2303 address_item->value = g_malloc0(sizeof(*address_item->value));
2304 address_item->value->ip_address = g_strdup(addr4);
2305 address_item->value->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV4;
2307 if (ifa->ifa_netmask) {
2308 /* Count the number of set bits in netmask.
2309 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2310 p = &((struct sockaddr_in *)ifa->ifa_netmask)->sin_addr;
2311 address_item->value->prefix = ctpop32(((uint32_t *) p)[0]);
2313 } else if (ifa->ifa_addr &&
2314 ifa->ifa_addr->sa_family == AF_INET6) {
2315 /* interface with IPv6 address */
2316 p = &((struct sockaddr_in6 *)ifa->ifa_addr)->sin6_addr;
2317 if (!inet_ntop(AF_INET6, p, addr6, sizeof(addr6))) {
2318 error_setg_errno(errp, errno, "inet_ntop failed");
2322 address_item = g_malloc0(sizeof(*address_item));
2323 address_item->value = g_malloc0(sizeof(*address_item->value));
2324 address_item->value->ip_address = g_strdup(addr6);
2325 address_item->value->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV6;
2327 if (ifa->ifa_netmask) {
2328 /* Count the number of set bits in netmask.
2329 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2330 p = &((struct sockaddr_in6 *)ifa->ifa_netmask)->sin6_addr;
2331 address_item->value->prefix =
2332 ctpop32(((uint32_t *) p)[0]) +
2333 ctpop32(((uint32_t *) p)[1]) +
2334 ctpop32(((uint32_t *) p)[2]) +
2335 ctpop32(((uint32_t *) p)[3]);
2339 if (!address_item) {
2343 address_list = &info->value->ip_addresses;
2345 while (*address_list && (*address_list)->next) {
2346 address_list = &(*address_list)->next;
2349 if (!*address_list) {
2350 *address_list = address_item;
2352 (*address_list)->next = address_item;
2355 info->value->has_ip_addresses = true;
2357 if (!info->value->has_statistics) {
2358 interface_stat = g_malloc0(sizeof(*interface_stat));
2359 if (guest_get_network_stats(info->value->name,
2360 interface_stat) == -1) {
2361 info->value->has_statistics = false;
2362 g_free(interface_stat);
2364 info->value->statistics = interface_stat;
2365 info->value->has_statistics = true;
2375 qapi_free_GuestNetworkInterfaceList(head);
2379 #define SYSCONF_EXACT(name, errp) sysconf_exact((name), #name, (errp))
2381 static long sysconf_exact(int name, const char *name_str, Error **errp)
2386 ret = sysconf(name);
2389 error_setg(errp, "sysconf(%s): value indefinite", name_str);
2391 error_setg_errno(errp, errno, "sysconf(%s)", name_str);
2397 /* Transfer online/offline status between @vcpu and the guest system.
2399 * On input either @errp or *@errp must be NULL.
2401 * In system-to-@vcpu direction, the following @vcpu fields are accessed:
2402 * - R: vcpu->logical_id
2404 * - W: vcpu->can_offline
2406 * In @vcpu-to-system direction, the following @vcpu fields are accessed:
2407 * - R: vcpu->logical_id
2410 * Written members remain unmodified on error.
2412 static void transfer_vcpu(GuestLogicalProcessor *vcpu, bool sys2vcpu,
2413 char *dirpath, Error **errp)
2418 static const char fn[] = "online";
2420 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2422 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2426 fd = openat(dirfd, fn, sys2vcpu ? O_RDONLY : O_RDWR);
2428 if (errno != ENOENT) {
2429 error_setg_errno(errp, errno, "open(\"%s/%s\")", dirpath, fn);
2430 } else if (sys2vcpu) {
2431 vcpu->online = true;
2432 vcpu->can_offline = false;
2433 } else if (!vcpu->online) {
2434 error_setg(errp, "logical processor #%" PRId64 " can't be "
2435 "offlined", vcpu->logical_id);
2436 } /* otherwise pretend successful re-onlining */
2438 unsigned char status;
2440 res = pread(fd, &status, 1, 0);
2442 error_setg_errno(errp, errno, "pread(\"%s/%s\")", dirpath, fn);
2443 } else if (res == 0) {
2444 error_setg(errp, "pread(\"%s/%s\"): unexpected EOF", dirpath,
2446 } else if (sys2vcpu) {
2447 vcpu->online = (status != '0');
2448 vcpu->can_offline = true;
2449 } else if (vcpu->online != (status != '0')) {
2450 status = '0' + vcpu->online;
2451 if (pwrite(fd, &status, 1, 0) == -1) {
2452 error_setg_errno(errp, errno, "pwrite(\"%s/%s\")", dirpath,
2455 } /* otherwise pretend successful re-(on|off)-lining */
2465 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
2468 GuestLogicalProcessorList *head, **link;
2470 Error *local_err = NULL;
2475 sc_max = SYSCONF_EXACT(_SC_NPROCESSORS_CONF, &local_err);
2477 while (local_err == NULL && current < sc_max) {
2478 GuestLogicalProcessor *vcpu;
2479 GuestLogicalProcessorList *entry;
2480 int64_t id = current++;
2481 char *path = g_strdup_printf("/sys/devices/system/cpu/cpu%" PRId64 "/",
2484 if (g_file_test(path, G_FILE_TEST_EXISTS)) {
2485 vcpu = g_malloc0(sizeof *vcpu);
2486 vcpu->logical_id = id;
2487 vcpu->has_can_offline = true; /* lolspeak ftw */
2488 transfer_vcpu(vcpu, true, path, &local_err);
2489 entry = g_malloc0(sizeof *entry);
2490 entry->value = vcpu;
2492 link = &entry->next;
2497 if (local_err == NULL) {
2498 /* there's no guest with zero VCPUs */
2499 g_assert(head != NULL);
2503 qapi_free_GuestLogicalProcessorList(head);
2504 error_propagate(errp, local_err);
2508 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
2511 Error *local_err = NULL;
2514 while (vcpus != NULL) {
2515 char *path = g_strdup_printf("/sys/devices/system/cpu/cpu%" PRId64 "/",
2516 vcpus->value->logical_id);
2518 transfer_vcpu(vcpus->value, false, path, &local_err);
2520 if (local_err != NULL) {
2524 vcpus = vcpus->next;
2527 if (local_err != NULL) {
2528 if (processed == 0) {
2529 error_propagate(errp, local_err);
2531 error_free(local_err);
2538 void qmp_guest_set_user_password(const char *username,
2539 const char *password,
2543 Error *local_err = NULL;
2544 char *passwd_path = NULL;
2547 int datafd[2] = { -1, -1 };
2548 char *rawpasswddata = NULL;
2549 size_t rawpasswdlen;
2550 char *chpasswddata = NULL;
2553 rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
2554 if (!rawpasswddata) {
2557 rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
2558 rawpasswddata[rawpasswdlen] = '\0';
2560 if (strchr(rawpasswddata, '\n')) {
2561 error_setg(errp, "forbidden characters in raw password");
2565 if (strchr(username, '\n') ||
2566 strchr(username, ':')) {
2567 error_setg(errp, "forbidden characters in username");
2571 chpasswddata = g_strdup_printf("%s:%s\n", username, rawpasswddata);
2572 chpasswdlen = strlen(chpasswddata);
2574 passwd_path = g_find_program_in_path("chpasswd");
2577 error_setg(errp, "cannot find 'passwd' program in PATH");
2581 if (pipe(datafd) < 0) {
2582 error_setg(errp, "cannot create pipe FDs");
2592 reopen_fd_to_null(1);
2593 reopen_fd_to_null(2);
2596 execle(passwd_path, "chpasswd", "-e", NULL, environ);
2598 execle(passwd_path, "chpasswd", NULL, environ);
2600 _exit(EXIT_FAILURE);
2601 } else if (pid < 0) {
2602 error_setg_errno(errp, errno, "failed to create child process");
2608 if (qemu_write_full(datafd[1], chpasswddata, chpasswdlen) != chpasswdlen) {
2609 error_setg_errno(errp, errno, "cannot write new account password");
2615 ga_wait_child(pid, &status, &local_err);
2617 error_propagate(errp, local_err);
2621 if (!WIFEXITED(status)) {
2622 error_setg(errp, "child process has terminated abnormally");
2626 if (WEXITSTATUS(status)) {
2627 error_setg(errp, "child process has failed to set user password");
2632 g_free(chpasswddata);
2633 g_free(rawpasswddata);
2634 g_free(passwd_path);
2635 if (datafd[0] != -1) {
2638 if (datafd[1] != -1) {
2643 static void ga_read_sysfs_file(int dirfd, const char *pathname, char *buf,
2644 int size, Error **errp)
2650 fd = openat(dirfd, pathname, O_RDONLY);
2652 error_setg_errno(errp, errno, "open sysfs file \"%s\"", pathname);
2656 res = pread(fd, buf, size, 0);
2658 error_setg_errno(errp, errno, "pread sysfs file \"%s\"", pathname);
2659 } else if (res == 0) {
2660 error_setg(errp, "pread sysfs file \"%s\": unexpected EOF", pathname);
2665 static void ga_write_sysfs_file(int dirfd, const char *pathname,
2666 const char *buf, int size, Error **errp)
2671 fd = openat(dirfd, pathname, O_WRONLY);
2673 error_setg_errno(errp, errno, "open sysfs file \"%s\"", pathname);
2677 if (pwrite(fd, buf, size, 0) == -1) {
2678 error_setg_errno(errp, errno, "pwrite sysfs file \"%s\"", pathname);
2684 /* Transfer online/offline status between @mem_blk and the guest system.
2686 * On input either @errp or *@errp must be NULL.
2688 * In system-to-@mem_blk direction, the following @mem_blk fields are accessed:
2689 * - R: mem_blk->phys_index
2690 * - W: mem_blk->online
2691 * - W: mem_blk->can_offline
2693 * In @mem_blk-to-system direction, the following @mem_blk fields are accessed:
2694 * - R: mem_blk->phys_index
2695 * - R: mem_blk->online
2696 *- R: mem_blk->can_offline
2697 * Written members remain unmodified on error.
2699 static void transfer_memory_block(GuestMemoryBlock *mem_blk, bool sys2memblk,
2700 GuestMemoryBlockResponse *result,
2706 Error *local_err = NULL;
2712 error_setg(errp, "Internal error, 'result' should not be NULL");
2716 dp = opendir("/sys/devices/system/memory/");
2717 /* if there is no 'memory' directory in sysfs,
2718 * we think this VM does not support online/offline memory block,
2719 * any other solution?
2722 if (errno == ENOENT) {
2724 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED;
2731 dirpath = g_strdup_printf("/sys/devices/system/memory/memory%" PRId64 "/",
2732 mem_blk->phys_index);
2733 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2736 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2738 if (errno == ENOENT) {
2739 result->response = GUEST_MEMORY_BLOCK_RESPONSE_TYPE_NOT_FOUND;
2742 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2750 status = g_malloc0(10);
2751 ga_read_sysfs_file(dirfd, "state", status, 10, &local_err);
2753 /* treat with sysfs file that not exist in old kernel */
2754 if (errno == ENOENT) {
2755 error_free(local_err);
2757 mem_blk->online = true;
2758 mem_blk->can_offline = false;
2759 } else if (!mem_blk->online) {
2761 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED;
2765 error_propagate(errp, local_err);
2767 error_free(local_err);
2769 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2776 char removable = '0';
2778 mem_blk->online = (strncmp(status, "online", 6) == 0);
2780 ga_read_sysfs_file(dirfd, "removable", &removable, 1, &local_err);
2782 /* if no 'removable' file, it doesn't support offline mem blk */
2783 if (errno == ENOENT) {
2784 error_free(local_err);
2785 mem_blk->can_offline = false;
2787 error_propagate(errp, local_err);
2790 mem_blk->can_offline = (removable != '0');
2793 if (mem_blk->online != (strncmp(status, "online", 6) == 0)) {
2794 const char *new_state = mem_blk->online ? "online" : "offline";
2796 ga_write_sysfs_file(dirfd, "state", new_state, strlen(new_state),
2799 error_free(local_err);
2801 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2805 result->response = GUEST_MEMORY_BLOCK_RESPONSE_TYPE_SUCCESS;
2806 result->has_error_code = false;
2807 } /* otherwise pretend successful re-(on|off)-lining */
2818 result->has_error_code = true;
2819 result->error_code = errno;
2823 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
2825 GuestMemoryBlockList *head, **link;
2826 Error *local_err = NULL;
2833 dp = opendir("/sys/devices/system/memory/");
2835 /* it's ok if this happens to be a system that doesn't expose
2836 * memory blocks via sysfs, but otherwise we should report
2839 if (errno != ENOENT) {
2840 error_setg_errno(errp, errno, "Can't open directory"
2841 "\"/sys/devices/system/memory/\"");
2846 /* Note: the phys_index of memory block may be discontinuous,
2847 * this is because a memblk is the unit of the Sparse Memory design, which
2848 * allows discontinuous memory ranges (ex. NUMA), so here we should
2849 * traverse the memory block directory.
2851 while ((de = readdir(dp)) != NULL) {
2852 GuestMemoryBlock *mem_blk;
2853 GuestMemoryBlockList *entry;
2855 if ((strncmp(de->d_name, "memory", 6) != 0) ||
2856 !(de->d_type & DT_DIR)) {
2860 mem_blk = g_malloc0(sizeof *mem_blk);
2861 /* The d_name is "memoryXXX", phys_index is block id, same as XXX */
2862 mem_blk->phys_index = strtoul(&de->d_name[6], NULL, 10);
2863 mem_blk->has_can_offline = true; /* lolspeak ftw */
2864 transfer_memory_block(mem_blk, true, NULL, &local_err);
2869 entry = g_malloc0(sizeof *entry);
2870 entry->value = mem_blk;
2873 link = &entry->next;
2877 if (local_err == NULL) {
2878 /* there's no guest with zero memory blocks */
2880 error_setg(errp, "guest reported zero memory blocks!");
2885 qapi_free_GuestMemoryBlockList(head);
2886 error_propagate(errp, local_err);
2890 GuestMemoryBlockResponseList *
2891 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
2893 GuestMemoryBlockResponseList *head, **link;
2894 Error *local_err = NULL;
2899 while (mem_blks != NULL) {
2900 GuestMemoryBlockResponse *result;
2901 GuestMemoryBlockResponseList *entry;
2902 GuestMemoryBlock *current_mem_blk = mem_blks->value;
2904 result = g_malloc0(sizeof(*result));
2905 result->phys_index = current_mem_blk->phys_index;
2906 transfer_memory_block(current_mem_blk, false, result, &local_err);
2907 if (local_err) { /* should never happen */
2910 entry = g_malloc0(sizeof *entry);
2911 entry->value = result;
2914 link = &entry->next;
2915 mem_blks = mem_blks->next;
2920 qapi_free_GuestMemoryBlockResponseList(head);
2921 error_propagate(errp, local_err);
2925 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
2927 Error *local_err = NULL;
2931 GuestMemoryBlockInfo *info;
2933 dirpath = g_strdup_printf("/sys/devices/system/memory/");
2934 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2936 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2942 buf = g_malloc0(20);
2943 ga_read_sysfs_file(dirfd, "block_size_bytes", buf, 20, &local_err);
2947 error_propagate(errp, local_err);
2951 info = g_new0(GuestMemoryBlockInfo, 1);
2952 info->size = strtol(buf, NULL, 16); /* the unit is bytes */
2959 #else /* defined(__linux__) */
2961 void qmp_guest_suspend_disk(Error **errp)
2963 error_setg(errp, QERR_UNSUPPORTED);
2966 void qmp_guest_suspend_ram(Error **errp)
2968 error_setg(errp, QERR_UNSUPPORTED);
2971 void qmp_guest_suspend_hybrid(Error **errp)
2973 error_setg(errp, QERR_UNSUPPORTED);
2976 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
2978 error_setg(errp, QERR_UNSUPPORTED);
2982 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
2984 error_setg(errp, QERR_UNSUPPORTED);
2988 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
2990 error_setg(errp, QERR_UNSUPPORTED);
2994 void qmp_guest_set_user_password(const char *username,
2995 const char *password,
2999 error_setg(errp, QERR_UNSUPPORTED);
3002 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
3004 error_setg(errp, QERR_UNSUPPORTED);
3008 GuestMemoryBlockResponseList *
3009 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
3011 error_setg(errp, QERR_UNSUPPORTED);
3015 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
3017 error_setg(errp, QERR_UNSUPPORTED);
3023 #if !defined(CONFIG_FSFREEZE)
3025 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
3027 error_setg(errp, QERR_UNSUPPORTED);
3031 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
3033 error_setg(errp, QERR_UNSUPPORTED);
3038 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
3040 error_setg(errp, QERR_UNSUPPORTED);
3045 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
3046 strList *mountpoints,
3049 error_setg(errp, QERR_UNSUPPORTED);
3054 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
3056 error_setg(errp, QERR_UNSUPPORTED);
3061 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
3063 error_setg(errp, QERR_UNSUPPORTED);
3067 #endif /* CONFIG_FSFREEZE */
3069 #if !defined(CONFIG_FSTRIM)
3070 GuestFilesystemTrimResponse *
3071 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
3073 error_setg(errp, QERR_UNSUPPORTED);
3078 /* add unsupported commands to the blacklist */
3079 GList *ga_command_blacklist_init(GList *blacklist)
3081 #if !defined(__linux__)
3083 const char *list[] = {
3084 "guest-suspend-disk", "guest-suspend-ram",
3085 "guest-suspend-hybrid", "guest-network-get-interfaces",
3086 "guest-get-vcpus", "guest-set-vcpus",
3087 "guest-get-memory-blocks", "guest-set-memory-blocks",
3088 "guest-get-memory-block-size", "guest-get-memory-block-info",
3090 char **p = (char **)list;
3093 blacklist = g_list_append(blacklist, g_strdup(*p++));
3098 #if !defined(CONFIG_FSFREEZE)
3100 const char *list[] = {
3101 "guest-get-fsinfo", "guest-fsfreeze-status",
3102 "guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list",
3103 "guest-fsfreeze-thaw", "guest-get-fsinfo",
3104 "guest-get-disks", NULL};
3105 char **p = (char **)list;
3108 blacklist = g_list_append(blacklist, g_strdup(*p++));
3113 #if !defined(CONFIG_FSTRIM)
3114 blacklist = g_list_append(blacklist, g_strdup("guest-fstrim"));
3117 blacklist = g_list_append(blacklist, g_strdup("guest-get-devices"));
3122 /* register init/cleanup routines for stateful command groups */
3123 void ga_command_state_init(GAState *s, GACommandState *cs)
3125 #if defined(CONFIG_FSFREEZE)
3126 ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
3132 #define QGA_MICRO_SECOND_TO_SECOND 1000000
3134 static double ga_get_login_time(struct utmpx *user_info)
3136 double seconds = (double)user_info->ut_tv.tv_sec;
3137 double useconds = (double)user_info->ut_tv.tv_usec;
3138 useconds /= QGA_MICRO_SECOND_TO_SECOND;
3139 return seconds + useconds;
3142 GuestUserList *qmp_guest_get_users(Error **errp)
3144 GHashTable *cache = NULL;
3145 GuestUserList *head = NULL, *cur_item = NULL;
3146 struct utmpx *user_info = NULL;
3147 gpointer value = NULL;
3148 GuestUser *user = NULL;
3149 GuestUserList *item = NULL;
3150 double login_time = 0;
3152 cache = g_hash_table_new(g_str_hash, g_str_equal);
3156 user_info = getutxent();
3157 if (user_info == NULL) {
3159 } else if (user_info->ut_type != USER_PROCESS) {
3161 } else if (g_hash_table_contains(cache, user_info->ut_user)) {
3162 value = g_hash_table_lookup(cache, user_info->ut_user);
3163 user = (GuestUser *)value;
3164 login_time = ga_get_login_time(user_info);
3165 /* We're ensuring the earliest login time to be sent */
3166 if (login_time < user->login_time) {
3167 user->login_time = login_time;
3172 item = g_new0(GuestUserList, 1);
3173 item->value = g_new0(GuestUser, 1);
3174 item->value->user = g_strdup(user_info->ut_user);
3175 item->value->login_time = ga_get_login_time(user_info);
3177 g_hash_table_insert(cache, item->value->user, item->value);
3180 head = cur_item = item;
3182 cur_item->next = item;
3187 g_hash_table_destroy(cache);
3193 GuestUserList *qmp_guest_get_users(Error **errp)
3195 error_setg(errp, QERR_UNSUPPORTED);
3201 /* Replace escaped special characters with theire real values. The replacement
3202 * is done in place -- returned value is in the original string.
3204 static void ga_osrelease_replace_special(gchar *value)
3206 gchar *p, *p2, quote;
3208 /* Trim the string at first space or semicolon if it is not enclosed in
3209 * single or double quotes. */
3210 if ((value[0] != '"') || (value[0] == '\'')) {
3211 p = strchr(value, ' ');
3215 p = strchr(value, ';');
3236 /* Keep literal backslash followed by whatever is there */
3240 } else if (*p == quote) {
3248 static GKeyFile *ga_parse_osrelease(const char *fname)
3250 gchar *content = NULL;
3251 gchar *content2 = NULL;
3253 GKeyFile *keys = g_key_file_new();
3254 const char *group = "[os-release]\n";
3256 if (!g_file_get_contents(fname, &content, NULL, &err)) {
3257 slog("failed to read '%s', error: %s", fname, err->message);
3261 if (!g_utf8_validate(content, -1, NULL)) {
3262 slog("file is not utf-8 encoded: %s", fname);
3265 content2 = g_strdup_printf("%s%s", group, content);
3267 if (!g_key_file_load_from_data(keys, content2, -1, G_KEY_FILE_NONE,
3269 slog("failed to parse file '%s', error: %s", fname, err->message);
3281 g_key_file_free(keys);
3285 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
3287 GuestOSInfo *info = NULL;
3288 struct utsname kinfo;
3289 GKeyFile *osrelease = NULL;
3290 const char *qga_os_release = g_getenv("QGA_OS_RELEASE");
3292 info = g_new0(GuestOSInfo, 1);
3294 if (uname(&kinfo) != 0) {
3295 error_setg_errno(errp, errno, "uname failed");
3297 info->has_kernel_version = true;
3298 info->kernel_version = g_strdup(kinfo.version);
3299 info->has_kernel_release = true;
3300 info->kernel_release = g_strdup(kinfo.release);
3301 info->has_machine = true;
3302 info->machine = g_strdup(kinfo.machine);
3305 if (qga_os_release != NULL) {
3306 osrelease = ga_parse_osrelease(qga_os_release);
3308 osrelease = ga_parse_osrelease("/etc/os-release");
3309 if (osrelease == NULL) {
3310 osrelease = ga_parse_osrelease("/usr/lib/os-release");
3314 if (osrelease != NULL) {
3317 #define GET_FIELD(field, osfield) do { \
3318 value = g_key_file_get_value(osrelease, "os-release", osfield, NULL); \
3319 if (value != NULL) { \
3320 ga_osrelease_replace_special(value); \
3321 info->has_ ## field = true; \
3322 info->field = value; \
3325 GET_FIELD(id, "ID");
3326 GET_FIELD(name, "NAME");
3327 GET_FIELD(pretty_name, "PRETTY_NAME");
3328 GET_FIELD(version, "VERSION");
3329 GET_FIELD(version_id, "VERSION_ID");
3330 GET_FIELD(variant, "VARIANT");
3331 GET_FIELD(variant_id, "VARIANT_ID");
3334 g_key_file_free(osrelease);
3340 GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
3342 error_setg(errp, QERR_UNSUPPORTED);