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;
1033 * Store disk device info for CCW devices (s390x channel I/O devices).
1034 * Returns true if information has been stored, or false for failure.
1036 static bool build_guest_fsinfo_for_ccw_dev(char const *syspath,
1037 GuestDiskAddress *disk,
1040 unsigned int cssid, ssid, subchno, devno;
1043 p = strstr(syspath, "/devices/css");
1044 if (!p || sscanf(p + 12, "%*x/%x.%x.%x/%*x.%*x.%x/",
1045 &cssid, &ssid, &subchno, &devno) < 4) {
1046 g_debug("could not parse ccw device sysfs path: %s", syspath);
1050 disk->has_ccw_address = true;
1051 disk->ccw_address = g_new0(GuestCCWAddress, 1);
1052 disk->ccw_address->cssid = cssid;
1053 disk->ccw_address->ssid = ssid;
1054 disk->ccw_address->subchno = subchno;
1055 disk->ccw_address->devno = devno;
1057 if (strstr(p, "/virtio")) {
1058 build_guest_fsinfo_for_nonpci_virtio(syspath, disk, errp);
1064 /* Store disk device info specified by @sysfs into @fs */
1065 static void build_guest_fsinfo_for_real_device(char const *syspath,
1066 GuestFilesystemInfo *fs,
1069 GuestDiskAddress *disk;
1070 GuestPCIAddress *pciaddr;
1072 #ifdef CONFIG_LIBUDEV
1073 struct udev *udev = NULL;
1074 struct udev_device *udevice = NULL;
1077 pciaddr = g_new0(GuestPCIAddress, 1);
1078 pciaddr->domain = -1; /* -1 means field is invalid */
1081 pciaddr->function = -1;
1083 disk = g_new0(GuestDiskAddress, 1);
1084 disk->pci_controller = pciaddr;
1085 disk->bus_type = GUEST_DISK_BUS_TYPE_UNKNOWN;
1087 #ifdef CONFIG_LIBUDEV
1089 udevice = udev_device_new_from_syspath(udev, syspath);
1090 if (udev == NULL || udevice == NULL) {
1091 g_debug("failed to query udev");
1093 const char *devnode, *serial;
1094 devnode = udev_device_get_devnode(udevice);
1095 if (devnode != NULL) {
1096 disk->dev = g_strdup(devnode);
1097 disk->has_dev = true;
1099 serial = udev_device_get_property_value(udevice, "ID_SERIAL");
1100 if (serial != NULL && *serial != 0) {
1101 disk->serial = g_strdup(serial);
1102 disk->has_serial = true;
1107 udev_device_unref(udevice);
1110 if (strstr(syspath, "/devices/pci")) {
1111 has_hwinf = build_guest_fsinfo_for_pci_dev(syspath, disk, errp);
1112 } else if (strstr(syspath, "/devices/css")) {
1113 has_hwinf = build_guest_fsinfo_for_ccw_dev(syspath, disk, errp);
1114 } else if (strstr(syspath, "/virtio")) {
1115 has_hwinf = build_guest_fsinfo_for_nonpci_virtio(syspath, disk, errp);
1117 g_debug("Unsupported device type for '%s'", syspath);
1121 if (has_hwinf || disk->has_dev || disk->has_serial) {
1122 QAPI_LIST_PREPEND(fs->disk, disk);
1124 qapi_free_GuestDiskAddress(disk);
1128 static void build_guest_fsinfo_for_device(char const *devpath,
1129 GuestFilesystemInfo *fs,
1132 /* Store a list of slave devices of virtual volume specified by @syspath into
1134 static void build_guest_fsinfo_for_virtual_device(char const *syspath,
1135 GuestFilesystemInfo *fs,
1141 struct dirent *entry;
1143 dirpath = g_strdup_printf("%s/slaves", syspath);
1144 dir = opendir(dirpath);
1146 if (errno != ENOENT) {
1147 error_setg_errno(errp, errno, "opendir(\"%s\")", dirpath);
1155 entry = readdir(dir);
1156 if (entry == NULL) {
1158 error_setg_errno(errp, errno, "readdir(\"%s\")", dirpath);
1163 if (entry->d_type == DT_LNK) {
1166 g_debug(" slave device '%s'", entry->d_name);
1167 path = g_strdup_printf("%s/slaves/%s", syspath, entry->d_name);
1168 build_guest_fsinfo_for_device(path, fs, &err);
1172 error_propagate(errp, err);
1182 static bool is_disk_virtual(const char *devpath, Error **errp)
1184 g_autofree char *syspath = realpath(devpath, NULL);
1187 error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
1190 return strstr(syspath, "/devices/virtual/block/") != NULL;
1193 /* Dispatch to functions for virtual/real device */
1194 static void build_guest_fsinfo_for_device(char const *devpath,
1195 GuestFilesystemInfo *fs,
1199 g_autofree char *syspath = NULL;
1200 bool is_virtual = false;
1202 syspath = realpath(devpath, NULL);
1204 error_setg_errno(errp, errno, "realpath(\"%s\")", devpath);
1209 fs->name = g_path_get_basename(syspath);
1212 g_debug(" parse sysfs path '%s'", syspath);
1213 is_virtual = is_disk_virtual(syspath, errp);
1214 if (*errp != NULL) {
1218 build_guest_fsinfo_for_virtual_device(syspath, fs, errp);
1220 build_guest_fsinfo_for_real_device(syspath, fs, errp);
1224 #ifdef CONFIG_LIBUDEV
1227 * Wrapper around build_guest_fsinfo_for_device() for getting just
1230 static GuestDiskAddress *get_disk_address(const char *syspath, Error **errp)
1232 g_autoptr(GuestFilesystemInfo) fs = NULL;
1234 fs = g_new0(GuestFilesystemInfo, 1);
1235 build_guest_fsinfo_for_device(syspath, fs, errp);
1236 if (fs->disk != NULL) {
1237 return g_steal_pointer(&fs->disk->value);
1242 static char *get_alias_for_syspath(const char *syspath)
1244 struct udev *udev = NULL;
1245 struct udev_device *udevice = NULL;
1250 g_debug("failed to query udev");
1253 udevice = udev_device_new_from_syspath(udev, syspath);
1254 if (udevice == NULL) {
1255 g_debug("failed to query udev for path: %s", syspath);
1258 const char *alias = udev_device_get_property_value(
1259 udevice, "DM_NAME");
1261 * NULL means there was an error and empty string means there is no
1262 * alias. In case of no alias we return NULL instead of empty string.
1264 if (alias == NULL) {
1265 g_debug("failed to query udev for device alias for: %s",
1267 } else if (*alias != 0) {
1268 ret = g_strdup(alias);
1274 udev_device_unref(udevice);
1278 static char *get_device_for_syspath(const char *syspath)
1280 struct udev *udev = NULL;
1281 struct udev_device *udevice = NULL;
1286 g_debug("failed to query udev");
1289 udevice = udev_device_new_from_syspath(udev, syspath);
1290 if (udevice == NULL) {
1291 g_debug("failed to query udev for path: %s", syspath);
1294 ret = g_strdup(udev_device_get_devnode(udevice));
1299 udev_device_unref(udevice);
1303 static void get_disk_deps(const char *disk_dir, GuestDiskInfo *disk)
1305 g_autofree char *deps_dir = NULL;
1307 GDir *dp_deps = NULL;
1309 /* List dependent disks */
1310 deps_dir = g_strdup_printf("%s/slaves", disk_dir);
1311 g_debug(" listing entries in: %s", deps_dir);
1312 dp_deps = g_dir_open(deps_dir, 0, NULL);
1313 if (dp_deps == NULL) {
1314 g_debug("failed to list entries in %s", deps_dir);
1317 disk->has_dependencies = true;
1318 while ((dep = g_dir_read_name(dp_deps)) != NULL) {
1319 g_autofree char *dep_dir = NULL;
1322 /* Add dependent disks */
1323 dep_dir = g_strdup_printf("%s/%s", deps_dir, dep);
1324 dev_name = get_device_for_syspath(dep_dir);
1325 if (dev_name != NULL) {
1326 g_debug(" adding dependent device: %s", dev_name);
1327 QAPI_LIST_PREPEND(disk->dependencies, dev_name);
1330 g_dir_close(dp_deps);
1334 * Detect partitions subdirectory, name is "<disk_name><number>" or
1335 * "<disk_name>p<number>"
1337 * @disk_name -- last component of /sys path (e.g. sda)
1338 * @disk_dir -- sys path of the disk (e.g. /sys/block/sda)
1339 * @disk_dev -- device node of the disk (e.g. /dev/sda)
1341 static GuestDiskInfoList *get_disk_partitions(
1342 GuestDiskInfoList *list,
1343 const char *disk_name, const char *disk_dir,
1344 const char *disk_dev)
1346 GuestDiskInfoList *ret = list;
1347 struct dirent *de_disk;
1348 DIR *dp_disk = NULL;
1349 size_t len = strlen(disk_name);
1351 dp_disk = opendir(disk_dir);
1352 while ((de_disk = readdir(dp_disk)) != NULL) {
1353 g_autofree char *partition_dir = NULL;
1355 GuestDiskInfo *partition;
1357 if (!(de_disk->d_type & DT_DIR)) {
1361 if (!(strncmp(disk_name, de_disk->d_name, len) == 0 &&
1362 ((*(de_disk->d_name + len) == 'p' &&
1363 isdigit(*(de_disk->d_name + len + 1))) ||
1364 isdigit(*(de_disk->d_name + len))))) {
1368 partition_dir = g_strdup_printf("%s/%s",
1369 disk_dir, de_disk->d_name);
1370 dev_name = get_device_for_syspath(partition_dir);
1371 if (dev_name == NULL) {
1372 g_debug("Failed to get device name for syspath: %s",
1376 partition = g_new0(GuestDiskInfo, 1);
1377 partition->name = dev_name;
1378 partition->partition = true;
1379 /* Add parent disk as dependent for easier tracking of hierarchy */
1380 QAPI_LIST_PREPEND(partition->dependencies, g_strdup(disk_dev));
1382 QAPI_LIST_PREPEND(ret, partition);
1389 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1391 GuestDiskInfoList *ret = NULL;
1392 GuestDiskInfo *disk;
1394 struct dirent *de = NULL;
1396 g_debug("listing /sys/block directory");
1397 dp = opendir("/sys/block");
1399 error_setg_errno(errp, errno, "Can't open directory \"/sys/block\"");
1402 while ((de = readdir(dp)) != NULL) {
1403 g_autofree char *disk_dir = NULL, *line = NULL,
1406 Error *local_err = NULL;
1407 if (de->d_type != DT_LNK) {
1408 g_debug(" skipping entry: %s", de->d_name);
1412 /* Check size and skip zero-sized disks */
1413 g_debug(" checking disk size");
1414 size_path = g_strdup_printf("/sys/block/%s/size", de->d_name);
1415 if (!g_file_get_contents(size_path, &line, NULL, NULL)) {
1416 g_debug(" failed to read disk size");
1419 if (g_strcmp0(line, "0\n") == 0) {
1420 g_debug(" skipping zero-sized disk");
1424 g_debug(" adding %s", de->d_name);
1425 disk_dir = g_strdup_printf("/sys/block/%s", de->d_name);
1426 dev_name = get_device_for_syspath(disk_dir);
1427 if (dev_name == NULL) {
1428 g_debug("Failed to get device name for syspath: %s",
1432 disk = g_new0(GuestDiskInfo, 1);
1433 disk->name = dev_name;
1434 disk->partition = false;
1435 disk->alias = get_alias_for_syspath(disk_dir);
1436 disk->has_alias = (disk->alias != NULL);
1437 QAPI_LIST_PREPEND(ret, disk);
1439 /* Get address for non-virtual devices */
1440 bool is_virtual = is_disk_virtual(disk_dir, &local_err);
1441 if (local_err != NULL) {
1442 g_debug(" failed to check disk path, ignoring error: %s",
1443 error_get_pretty(local_err));
1444 error_free(local_err);
1446 /* Don't try to get the address */
1450 disk->address = get_disk_address(disk_dir, &local_err);
1451 if (local_err != NULL) {
1452 g_debug(" failed to get device info, ignoring error: %s",
1453 error_get_pretty(local_err));
1454 error_free(local_err);
1456 } else if (disk->address != NULL) {
1457 disk->has_address = true;
1461 get_disk_deps(disk_dir, disk);
1462 ret = get_disk_partitions(ret, de->d_name, disk_dir, dev_name);
1472 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1474 error_setg(errp, QERR_UNSUPPORTED);
1480 /* Return a list of the disk device(s)' info which @mount lies on */
1481 static GuestFilesystemInfo *build_guest_fsinfo(struct FsMount *mount,
1484 GuestFilesystemInfo *fs = g_malloc0(sizeof(*fs));
1486 unsigned long used, nonroot_total, fr_size;
1487 char *devpath = g_strdup_printf("/sys/dev/block/%u:%u",
1488 mount->devmajor, mount->devminor);
1490 fs->mountpoint = g_strdup(mount->dirname);
1491 fs->type = g_strdup(mount->devtype);
1492 build_guest_fsinfo_for_device(devpath, fs, errp);
1494 if (statvfs(fs->mountpoint, &buf) == 0) {
1495 fr_size = buf.f_frsize;
1496 used = buf.f_blocks - buf.f_bfree;
1497 nonroot_total = used + buf.f_bavail;
1498 fs->used_bytes = used * fr_size;
1499 fs->total_bytes = nonroot_total * fr_size;
1501 fs->has_total_bytes = true;
1502 fs->has_used_bytes = true;
1510 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
1513 struct FsMount *mount;
1514 GuestFilesystemInfoList *ret = NULL;
1515 Error *local_err = NULL;
1517 QTAILQ_INIT(&mounts);
1518 build_fs_mount_list(&mounts, &local_err);
1520 error_propagate(errp, local_err);
1524 QTAILQ_FOREACH(mount, &mounts, next) {
1525 g_debug("Building guest fsinfo for '%s'", mount->dirname);
1527 QAPI_LIST_PREPEND(ret, build_guest_fsinfo(mount, &local_err));
1529 error_propagate(errp, local_err);
1530 qapi_free_GuestFilesystemInfoList(ret);
1536 free_fs_mount_list(&mounts);
1542 FSFREEZE_HOOK_THAW = 0,
1543 FSFREEZE_HOOK_FREEZE,
1546 static const char *fsfreeze_hook_arg_string[] = {
1551 static void execute_fsfreeze_hook(FsfreezeHookArg arg, Error **errp)
1556 const char *arg_str = fsfreeze_hook_arg_string[arg];
1557 Error *local_err = NULL;
1559 hook = ga_fsfreeze_hook(ga_state);
1563 if (access(hook, X_OK) != 0) {
1564 error_setg_errno(errp, errno, "can't access fsfreeze hook '%s'", hook);
1568 slog("executing fsfreeze hook with arg '%s'", arg_str);
1572 reopen_fd_to_null(0);
1573 reopen_fd_to_null(1);
1574 reopen_fd_to_null(2);
1576 execle(hook, hook, arg_str, NULL, environ);
1577 _exit(EXIT_FAILURE);
1578 } else if (pid < 0) {
1579 error_setg_errno(errp, errno, "failed to create child process");
1583 ga_wait_child(pid, &status, &local_err);
1585 error_propagate(errp, local_err);
1589 if (!WIFEXITED(status)) {
1590 error_setg(errp, "fsfreeze hook has terminated abnormally");
1594 status = WEXITSTATUS(status);
1596 error_setg(errp, "fsfreeze hook has failed with status %d", status);
1602 * Return status of freeze/thaw
1604 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
1606 if (ga_is_frozen(ga_state)) {
1607 return GUEST_FSFREEZE_STATUS_FROZEN;
1610 return GUEST_FSFREEZE_STATUS_THAWED;
1613 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
1615 return qmp_guest_fsfreeze_freeze_list(false, NULL, errp);
1619 * Walk list of mounted file systems in the guest, and freeze the ones which
1620 * are real local file systems.
1622 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
1623 strList *mountpoints,
1629 struct FsMount *mount;
1630 Error *local_err = NULL;
1633 slog("guest-fsfreeze called");
1635 execute_fsfreeze_hook(FSFREEZE_HOOK_FREEZE, &local_err);
1637 error_propagate(errp, local_err);
1641 QTAILQ_INIT(&mounts);
1642 build_fs_mount_list(&mounts, &local_err);
1644 error_propagate(errp, local_err);
1648 /* cannot risk guest agent blocking itself on a write in this state */
1649 ga_set_frozen(ga_state);
1651 QTAILQ_FOREACH_REVERSE(mount, &mounts, next) {
1652 /* To issue fsfreeze in the reverse order of mounts, check if the
1653 * mount is listed in the list here */
1654 if (has_mountpoints) {
1655 for (list = mountpoints; list; list = list->next) {
1656 if (strcmp(list->value, mount->dirname) == 0) {
1665 fd = qemu_open_old(mount->dirname, O_RDONLY);
1667 error_setg_errno(errp, errno, "failed to open %s", mount->dirname);
1671 /* we try to cull filesystems we know won't work in advance, but other
1672 * filesystems may not implement fsfreeze for less obvious reasons.
1673 * these will report EOPNOTSUPP. we simply ignore these when tallying
1674 * the number of frozen filesystems.
1675 * if a filesystem is mounted more than once (aka bind mount) a
1676 * consecutive attempt to freeze an already frozen filesystem will
1679 * any other error means a failure to freeze a filesystem we
1680 * expect to be freezable, so return an error in those cases
1681 * and return system to thawed state.
1683 ret = ioctl(fd, FIFREEZE);
1685 if (errno != EOPNOTSUPP && errno != EBUSY) {
1686 error_setg_errno(errp, errno, "failed to freeze %s",
1697 free_fs_mount_list(&mounts);
1698 /* We may not issue any FIFREEZE here.
1699 * Just unset ga_state here and ready for the next call.
1702 ga_unset_frozen(ga_state);
1707 free_fs_mount_list(&mounts);
1708 qmp_guest_fsfreeze_thaw(NULL);
1713 * Walk list of frozen file systems in the guest, and thaw them.
1715 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1720 int fd, i = 0, logged;
1721 Error *local_err = NULL;
1723 QTAILQ_INIT(&mounts);
1724 build_fs_mount_list(&mounts, &local_err);
1726 error_propagate(errp, local_err);
1730 QTAILQ_FOREACH(mount, &mounts, next) {
1732 fd = qemu_open_old(mount->dirname, O_RDONLY);
1736 /* we have no way of knowing whether a filesystem was actually unfrozen
1737 * as a result of a successful call to FITHAW, only that if an error
1738 * was returned the filesystem was *not* unfrozen by that particular
1741 * since multiple preceding FIFREEZEs require multiple calls to FITHAW
1742 * to unfreeze, continuing issuing FITHAW until an error is returned,
1743 * in which case either the filesystem is in an unfreezable state, or,
1744 * more likely, it was thawed previously (and remains so afterward).
1746 * also, since the most recent successful call is the one that did
1747 * the actual unfreeze, we can use this to provide an accurate count
1748 * of the number of filesystems unfrozen by guest-fsfreeze-thaw, which
1749 * may * be useful for determining whether a filesystem was unfrozen
1750 * during the freeze/thaw phase by a process other than qemu-ga.
1753 ret = ioctl(fd, FITHAW);
1754 if (ret == 0 && !logged) {
1762 ga_unset_frozen(ga_state);
1763 free_fs_mount_list(&mounts);
1765 execute_fsfreeze_hook(FSFREEZE_HOOK_THAW, errp);
1770 static void guest_fsfreeze_cleanup(void)
1774 if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1775 qmp_guest_fsfreeze_thaw(&err);
1777 slog("failed to clean up frozen filesystems: %s",
1778 error_get_pretty(err));
1783 #endif /* CONFIG_FSFREEZE */
1785 #if defined(CONFIG_FSTRIM)
1787 * Walk list of mounted file systems in the guest, and trim them.
1789 GuestFilesystemTrimResponse *
1790 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1792 GuestFilesystemTrimResponse *response;
1793 GuestFilesystemTrimResult *result;
1796 struct FsMount *mount;
1798 Error *local_err = NULL;
1799 struct fstrim_range r;
1801 slog("guest-fstrim called");
1803 QTAILQ_INIT(&mounts);
1804 build_fs_mount_list(&mounts, &local_err);
1806 error_propagate(errp, local_err);
1810 response = g_malloc0(sizeof(*response));
1812 QTAILQ_FOREACH(mount, &mounts, next) {
1813 result = g_malloc0(sizeof(*result));
1814 result->path = g_strdup(mount->dirname);
1816 QAPI_LIST_PREPEND(response->paths, result);
1818 fd = qemu_open_old(mount->dirname, O_RDONLY);
1820 result->error = g_strdup_printf("failed to open: %s",
1822 result->has_error = true;
1826 /* We try to cull filesystems we know won't work in advance, but other
1827 * filesystems may not implement fstrim for less obvious reasons.
1828 * These will report EOPNOTSUPP; while in some other cases ENOTTY
1829 * will be reported (e.g. CD-ROMs).
1830 * Any other error means an unexpected error.
1834 r.minlen = has_minimum ? minimum : 0;
1835 ret = ioctl(fd, FITRIM, &r);
1837 result->has_error = true;
1838 if (errno == ENOTTY || errno == EOPNOTSUPP) {
1839 result->error = g_strdup("trim not supported");
1841 result->error = g_strdup_printf("failed to trim: %s",
1848 result->has_minimum = true;
1849 result->minimum = r.minlen;
1850 result->has_trimmed = true;
1851 result->trimmed = r.len;
1855 free_fs_mount_list(&mounts);
1858 #endif /* CONFIG_FSTRIM */
1861 #define LINUX_SYS_STATE_FILE "/sys/power/state"
1862 #define SUSPEND_SUPPORTED 0
1863 #define SUSPEND_NOT_SUPPORTED 1
1866 SUSPEND_MODE_DISK = 0,
1867 SUSPEND_MODE_RAM = 1,
1868 SUSPEND_MODE_HYBRID = 2,
1872 * Executes a command in a child process using g_spawn_sync,
1873 * returning an int >= 0 representing the exit status of the
1876 * If the program wasn't found in path, returns -1.
1878 * If a problem happened when creating the child process,
1879 * returns -1 and errp is set.
1881 static int run_process_child(const char *command[], Error **errp)
1883 int exit_status, spawn_flag;
1884 GError *g_err = NULL;
1887 spawn_flag = G_SPAWN_SEARCH_PATH | G_SPAWN_STDOUT_TO_DEV_NULL |
1888 G_SPAWN_STDERR_TO_DEV_NULL;
1890 success = g_spawn_sync(NULL, (char **)command, environ, spawn_flag,
1891 NULL, NULL, NULL, NULL,
1892 &exit_status, &g_err);
1895 return WEXITSTATUS(exit_status);
1898 if (g_err && (g_err->code != G_SPAWN_ERROR_NOENT)) {
1899 error_setg(errp, "failed to create child process, error '%s'",
1903 g_error_free(g_err);
1907 static bool systemd_supports_mode(SuspendMode mode, Error **errp)
1909 const char *systemctl_args[3] = {"systemd-hibernate", "systemd-suspend",
1910 "systemd-hybrid-sleep"};
1911 const char *cmd[4] = {"systemctl", "status", systemctl_args[mode], NULL};
1914 status = run_process_child(cmd, errp);
1917 * systemctl status uses LSB return codes so we can expect
1918 * status > 0 and be ok. To assert if the guest has support
1919 * for the selected suspend mode, status should be < 4. 4 is
1920 * the code for unknown service status, the return value when
1921 * the service does not exist. A common value is status = 3
1922 * (program is not running).
1924 if (status > 0 && status < 4) {
1931 static void systemd_suspend(SuspendMode mode, Error **errp)
1933 Error *local_err = NULL;
1934 const char *systemctl_args[3] = {"hibernate", "suspend", "hybrid-sleep"};
1935 const char *cmd[3] = {"systemctl", systemctl_args[mode], NULL};
1938 status = run_process_child(cmd, &local_err);
1944 if ((status == -1) && !local_err) {
1945 error_setg(errp, "the helper program 'systemctl %s' was not found",
1946 systemctl_args[mode]);
1951 error_propagate(errp, local_err);
1953 error_setg(errp, "the helper program 'systemctl %s' returned an "
1954 "unexpected exit status code (%d)",
1955 systemctl_args[mode], status);
1959 static bool pmutils_supports_mode(SuspendMode mode, Error **errp)
1961 Error *local_err = NULL;
1962 const char *pmutils_args[3] = {"--hibernate", "--suspend",
1963 "--suspend-hybrid"};
1964 const char *cmd[3] = {"pm-is-supported", pmutils_args[mode], NULL};
1967 status = run_process_child(cmd, &local_err);
1969 if (status == SUSPEND_SUPPORTED) {
1973 if ((status == -1) && !local_err) {
1978 error_propagate(errp, local_err);
1981 "the helper program '%s' returned an unexpected exit"
1982 " status code (%d)", "pm-is-supported", status);
1988 static void pmutils_suspend(SuspendMode mode, Error **errp)
1990 Error *local_err = NULL;
1991 const char *pmutils_binaries[3] = {"pm-hibernate", "pm-suspend",
1992 "pm-suspend-hybrid"};
1993 const char *cmd[2] = {pmutils_binaries[mode], NULL};
1996 status = run_process_child(cmd, &local_err);
2002 if ((status == -1) && !local_err) {
2003 error_setg(errp, "the helper program '%s' was not found",
2004 pmutils_binaries[mode]);
2009 error_propagate(errp, local_err);
2012 "the helper program '%s' returned an unexpected exit"
2013 " status code (%d)", pmutils_binaries[mode], status);
2017 static bool linux_sys_state_supports_mode(SuspendMode mode, Error **errp)
2019 const char *sysfile_strs[3] = {"disk", "mem", NULL};
2020 const char *sysfile_str = sysfile_strs[mode];
2021 char buf[32]; /* hopefully big enough */
2026 error_setg(errp, "unknown guest suspend mode");
2030 fd = open(LINUX_SYS_STATE_FILE, O_RDONLY);
2035 ret = read(fd, buf, sizeof(buf) - 1);
2042 if (strstr(buf, sysfile_str)) {
2048 static void linux_sys_state_suspend(SuspendMode mode, Error **errp)
2050 Error *local_err = NULL;
2051 const char *sysfile_strs[3] = {"disk", "mem", NULL};
2052 const char *sysfile_str = sysfile_strs[mode];
2057 error_setg(errp, "unknown guest suspend mode");
2067 reopen_fd_to_null(0);
2068 reopen_fd_to_null(1);
2069 reopen_fd_to_null(2);
2071 fd = open(LINUX_SYS_STATE_FILE, O_WRONLY);
2073 _exit(EXIT_FAILURE);
2076 if (write(fd, sysfile_str, strlen(sysfile_str)) < 0) {
2077 _exit(EXIT_FAILURE);
2080 _exit(EXIT_SUCCESS);
2081 } else if (pid < 0) {
2082 error_setg_errno(errp, errno, "failed to create child process");
2086 ga_wait_child(pid, &status, &local_err);
2088 error_propagate(errp, local_err);
2092 if (WEXITSTATUS(status)) {
2093 error_setg(errp, "child process has failed to suspend");
2098 static void guest_suspend(SuspendMode mode, Error **errp)
2100 Error *local_err = NULL;
2101 bool mode_supported = false;
2103 if (systemd_supports_mode(mode, &local_err)) {
2104 mode_supported = true;
2105 systemd_suspend(mode, &local_err);
2112 error_free(local_err);
2115 if (pmutils_supports_mode(mode, &local_err)) {
2116 mode_supported = true;
2117 pmutils_suspend(mode, &local_err);
2124 error_free(local_err);
2127 if (linux_sys_state_supports_mode(mode, &local_err)) {
2128 mode_supported = true;
2129 linux_sys_state_suspend(mode, &local_err);
2132 if (!mode_supported) {
2133 error_free(local_err);
2135 "the requested suspend mode is not supported by the guest");
2137 error_propagate(errp, local_err);
2141 void qmp_guest_suspend_disk(Error **errp)
2143 guest_suspend(SUSPEND_MODE_DISK, errp);
2146 void qmp_guest_suspend_ram(Error **errp)
2148 guest_suspend(SUSPEND_MODE_RAM, errp);
2151 void qmp_guest_suspend_hybrid(Error **errp)
2153 guest_suspend(SUSPEND_MODE_HYBRID, errp);
2156 static GuestNetworkInterface *
2157 guest_find_interface(GuestNetworkInterfaceList *head,
2160 for (; head; head = head->next) {
2161 if (strcmp(head->value->name, name) == 0) {
2169 static int guest_get_network_stats(const char *name,
2170 GuestNetworkInterfaceStat *stats)
2173 char const *devinfo = "/proc/net/dev";
2175 char *line = NULL, *colon;
2177 fp = fopen(devinfo, "r");
2181 name_len = strlen(name);
2182 while (getline(&line, &n, fp) != -1) {
2185 long long rx_packets;
2187 long long rx_dropped;
2189 long long tx_packets;
2191 long long tx_dropped;
2193 trim_line = g_strchug(line);
2194 if (trim_line[0] == '\0') {
2197 colon = strchr(trim_line, ':');
2201 if (colon - name_len == trim_line &&
2202 strncmp(trim_line, name, name_len) == 0) {
2203 if (sscanf(colon + 1,
2204 "%lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld",
2205 &rx_bytes, &rx_packets, &rx_errs, &rx_dropped,
2206 &dummy, &dummy, &dummy, &dummy,
2207 &tx_bytes, &tx_packets, &tx_errs, &tx_dropped,
2208 &dummy, &dummy, &dummy, &dummy) != 16) {
2211 stats->rx_bytes = rx_bytes;
2212 stats->rx_packets = rx_packets;
2213 stats->rx_errs = rx_errs;
2214 stats->rx_dropped = rx_dropped;
2215 stats->tx_bytes = tx_bytes;
2216 stats->tx_packets = tx_packets;
2217 stats->tx_errs = tx_errs;
2218 stats->tx_dropped = tx_dropped;
2226 g_debug("/proc/net/dev: Interface '%s' not found", name);
2231 * Build information about guest interfaces
2233 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
2235 GuestNetworkInterfaceList *head = NULL, **tail = &head;
2236 struct ifaddrs *ifap, *ifa;
2238 if (getifaddrs(&ifap) < 0) {
2239 error_setg_errno(errp, errno, "getifaddrs failed");
2243 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
2244 GuestNetworkInterface *info;
2245 GuestIpAddressList **address_tail;
2246 GuestIpAddress *address_item = NULL;
2247 GuestNetworkInterfaceStat *interface_stat = NULL;
2248 char addr4[INET_ADDRSTRLEN];
2249 char addr6[INET6_ADDRSTRLEN];
2252 unsigned char *mac_addr;
2255 g_debug("Processing %s interface", ifa->ifa_name);
2257 info = guest_find_interface(head, ifa->ifa_name);
2260 info = g_malloc0(sizeof(*info));
2261 info->name = g_strdup(ifa->ifa_name);
2263 QAPI_LIST_APPEND(tail, info);
2266 if (!info->has_hardware_address && ifa->ifa_flags & SIOCGIFHWADDR) {
2267 /* we haven't obtained HW address yet */
2268 sock = socket(PF_INET, SOCK_STREAM, 0);
2270 error_setg_errno(errp, errno, "failed to create socket");
2274 memset(&ifr, 0, sizeof(ifr));
2275 pstrcpy(ifr.ifr_name, IF_NAMESIZE, info->name);
2276 if (ioctl(sock, SIOCGIFHWADDR, &ifr) == -1) {
2277 error_setg_errno(errp, errno,
2278 "failed to get MAC address of %s",
2285 mac_addr = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
2287 info->hardware_address =
2288 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
2289 (int) mac_addr[0], (int) mac_addr[1],
2290 (int) mac_addr[2], (int) mac_addr[3],
2291 (int) mac_addr[4], (int) mac_addr[5]);
2293 info->has_hardware_address = true;
2296 if (ifa->ifa_addr &&
2297 ifa->ifa_addr->sa_family == AF_INET) {
2298 /* interface with IPv4 address */
2299 p = &((struct sockaddr_in *)ifa->ifa_addr)->sin_addr;
2300 if (!inet_ntop(AF_INET, p, addr4, sizeof(addr4))) {
2301 error_setg_errno(errp, errno, "inet_ntop failed");
2305 address_item = g_malloc0(sizeof(*address_item));
2306 address_item->ip_address = g_strdup(addr4);
2307 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV4;
2309 if (ifa->ifa_netmask) {
2310 /* Count the number of set bits in netmask.
2311 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2312 p = &((struct sockaddr_in *)ifa->ifa_netmask)->sin_addr;
2313 address_item->prefix = ctpop32(((uint32_t *) p)[0]);
2315 } else if (ifa->ifa_addr &&
2316 ifa->ifa_addr->sa_family == AF_INET6) {
2317 /* interface with IPv6 address */
2318 p = &((struct sockaddr_in6 *)ifa->ifa_addr)->sin6_addr;
2319 if (!inet_ntop(AF_INET6, p, addr6, sizeof(addr6))) {
2320 error_setg_errno(errp, errno, "inet_ntop failed");
2324 address_item = g_malloc0(sizeof(*address_item));
2325 address_item->ip_address = g_strdup(addr6);
2326 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV6;
2328 if (ifa->ifa_netmask) {
2329 /* Count the number of set bits in netmask.
2330 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2331 p = &((struct sockaddr_in6 *)ifa->ifa_netmask)->sin6_addr;
2332 address_item->prefix =
2333 ctpop32(((uint32_t *) p)[0]) +
2334 ctpop32(((uint32_t *) p)[1]) +
2335 ctpop32(((uint32_t *) p)[2]) +
2336 ctpop32(((uint32_t *) p)[3]);
2340 if (!address_item) {
2344 address_tail = &info->ip_addresses;
2345 while (*address_tail) {
2346 address_tail = &(*address_tail)->next;
2348 QAPI_LIST_APPEND(address_tail, address_item);
2350 info->has_ip_addresses = true;
2352 if (!info->has_statistics) {
2353 interface_stat = g_malloc0(sizeof(*interface_stat));
2354 if (guest_get_network_stats(info->name, interface_stat) == -1) {
2355 info->has_statistics = false;
2356 g_free(interface_stat);
2358 info->statistics = interface_stat;
2359 info->has_statistics = true;
2369 qapi_free_GuestNetworkInterfaceList(head);
2373 /* Transfer online/offline status between @vcpu and the guest system.
2375 * On input either @errp or *@errp must be NULL.
2377 * In system-to-@vcpu direction, the following @vcpu fields are accessed:
2378 * - R: vcpu->logical_id
2380 * - W: vcpu->can_offline
2382 * In @vcpu-to-system direction, the following @vcpu fields are accessed:
2383 * - R: vcpu->logical_id
2386 * Written members remain unmodified on error.
2388 static void transfer_vcpu(GuestLogicalProcessor *vcpu, bool sys2vcpu,
2389 char *dirpath, Error **errp)
2394 static const char fn[] = "online";
2396 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2398 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2402 fd = openat(dirfd, fn, sys2vcpu ? O_RDONLY : O_RDWR);
2404 if (errno != ENOENT) {
2405 error_setg_errno(errp, errno, "open(\"%s/%s\")", dirpath, fn);
2406 } else if (sys2vcpu) {
2407 vcpu->online = true;
2408 vcpu->can_offline = false;
2409 } else if (!vcpu->online) {
2410 error_setg(errp, "logical processor #%" PRId64 " can't be "
2411 "offlined", vcpu->logical_id);
2412 } /* otherwise pretend successful re-onlining */
2414 unsigned char status;
2416 res = pread(fd, &status, 1, 0);
2418 error_setg_errno(errp, errno, "pread(\"%s/%s\")", dirpath, fn);
2419 } else if (res == 0) {
2420 error_setg(errp, "pread(\"%s/%s\"): unexpected EOF", dirpath,
2422 } else if (sys2vcpu) {
2423 vcpu->online = (status != '0');
2424 vcpu->can_offline = true;
2425 } else if (vcpu->online != (status != '0')) {
2426 status = '0' + vcpu->online;
2427 if (pwrite(fd, &status, 1, 0) == -1) {
2428 error_setg_errno(errp, errno, "pwrite(\"%s/%s\")", dirpath,
2431 } /* otherwise pretend successful re-(on|off)-lining */
2441 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
2443 GuestLogicalProcessorList *head, **tail;
2444 const char *cpu_dir = "/sys/devices/system/cpu";
2446 g_autoptr(GDir) cpu_gdir = NULL;
2447 Error *local_err = NULL;
2451 cpu_gdir = g_dir_open(cpu_dir, 0, NULL);
2453 if (cpu_gdir == NULL) {
2454 error_setg_errno(errp, errno, "failed to list entries: %s", cpu_dir);
2458 while (local_err == NULL && (line = g_dir_read_name(cpu_gdir)) != NULL) {
2459 GuestLogicalProcessor *vcpu;
2461 if (sscanf(line, "cpu%" PRId64, &id)) {
2462 g_autofree char *path = g_strdup_printf("/sys/devices/system/cpu/"
2463 "cpu%" PRId64 "/", id);
2464 vcpu = g_malloc0(sizeof *vcpu);
2465 vcpu->logical_id = id;
2466 vcpu->has_can_offline = true; /* lolspeak ftw */
2467 transfer_vcpu(vcpu, true, path, &local_err);
2468 QAPI_LIST_APPEND(tail, vcpu);
2472 if (local_err == NULL) {
2473 /* there's no guest with zero VCPUs */
2474 g_assert(head != NULL);
2478 qapi_free_GuestLogicalProcessorList(head);
2479 error_propagate(errp, local_err);
2483 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
2486 Error *local_err = NULL;
2489 while (vcpus != NULL) {
2490 char *path = g_strdup_printf("/sys/devices/system/cpu/cpu%" PRId64 "/",
2491 vcpus->value->logical_id);
2493 transfer_vcpu(vcpus->value, false, path, &local_err);
2495 if (local_err != NULL) {
2499 vcpus = vcpus->next;
2502 if (local_err != NULL) {
2503 if (processed == 0) {
2504 error_propagate(errp, local_err);
2506 error_free(local_err);
2513 void qmp_guest_set_user_password(const char *username,
2514 const char *password,
2518 Error *local_err = NULL;
2519 char *passwd_path = NULL;
2522 int datafd[2] = { -1, -1 };
2523 char *rawpasswddata = NULL;
2524 size_t rawpasswdlen;
2525 char *chpasswddata = NULL;
2528 rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
2529 if (!rawpasswddata) {
2532 rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
2533 rawpasswddata[rawpasswdlen] = '\0';
2535 if (strchr(rawpasswddata, '\n')) {
2536 error_setg(errp, "forbidden characters in raw password");
2540 if (strchr(username, '\n') ||
2541 strchr(username, ':')) {
2542 error_setg(errp, "forbidden characters in username");
2546 chpasswddata = g_strdup_printf("%s:%s\n", username, rawpasswddata);
2547 chpasswdlen = strlen(chpasswddata);
2549 passwd_path = g_find_program_in_path("chpasswd");
2552 error_setg(errp, "cannot find 'passwd' program in PATH");
2556 if (pipe(datafd) < 0) {
2557 error_setg(errp, "cannot create pipe FDs");
2567 reopen_fd_to_null(1);
2568 reopen_fd_to_null(2);
2571 execle(passwd_path, "chpasswd", "-e", NULL, environ);
2573 execle(passwd_path, "chpasswd", NULL, environ);
2575 _exit(EXIT_FAILURE);
2576 } else if (pid < 0) {
2577 error_setg_errno(errp, errno, "failed to create child process");
2583 if (qemu_write_full(datafd[1], chpasswddata, chpasswdlen) != chpasswdlen) {
2584 error_setg_errno(errp, errno, "cannot write new account password");
2590 ga_wait_child(pid, &status, &local_err);
2592 error_propagate(errp, local_err);
2596 if (!WIFEXITED(status)) {
2597 error_setg(errp, "child process has terminated abnormally");
2601 if (WEXITSTATUS(status)) {
2602 error_setg(errp, "child process has failed to set user password");
2607 g_free(chpasswddata);
2608 g_free(rawpasswddata);
2609 g_free(passwd_path);
2610 if (datafd[0] != -1) {
2613 if (datafd[1] != -1) {
2618 static void ga_read_sysfs_file(int dirfd, const char *pathname, char *buf,
2619 int size, Error **errp)
2625 fd = openat(dirfd, pathname, O_RDONLY);
2627 error_setg_errno(errp, errno, "open sysfs file \"%s\"", pathname);
2631 res = pread(fd, buf, size, 0);
2633 error_setg_errno(errp, errno, "pread sysfs file \"%s\"", pathname);
2634 } else if (res == 0) {
2635 error_setg(errp, "pread sysfs file \"%s\": unexpected EOF", pathname);
2640 static void ga_write_sysfs_file(int dirfd, const char *pathname,
2641 const char *buf, int size, Error **errp)
2646 fd = openat(dirfd, pathname, O_WRONLY);
2648 error_setg_errno(errp, errno, "open sysfs file \"%s\"", pathname);
2652 if (pwrite(fd, buf, size, 0) == -1) {
2653 error_setg_errno(errp, errno, "pwrite sysfs file \"%s\"", pathname);
2659 /* Transfer online/offline status between @mem_blk and the guest system.
2661 * On input either @errp or *@errp must be NULL.
2663 * In system-to-@mem_blk direction, the following @mem_blk fields are accessed:
2664 * - R: mem_blk->phys_index
2665 * - W: mem_blk->online
2666 * - W: mem_blk->can_offline
2668 * In @mem_blk-to-system direction, the following @mem_blk fields are accessed:
2669 * - R: mem_blk->phys_index
2670 * - R: mem_blk->online
2671 *- R: mem_blk->can_offline
2672 * Written members remain unmodified on error.
2674 static void transfer_memory_block(GuestMemoryBlock *mem_blk, bool sys2memblk,
2675 GuestMemoryBlockResponse *result,
2681 Error *local_err = NULL;
2687 error_setg(errp, "Internal error, 'result' should not be NULL");
2691 dp = opendir("/sys/devices/system/memory/");
2692 /* if there is no 'memory' directory in sysfs,
2693 * we think this VM does not support online/offline memory block,
2694 * any other solution?
2697 if (errno == ENOENT) {
2699 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED;
2706 dirpath = g_strdup_printf("/sys/devices/system/memory/memory%" PRId64 "/",
2707 mem_blk->phys_index);
2708 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2711 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2713 if (errno == ENOENT) {
2714 result->response = GUEST_MEMORY_BLOCK_RESPONSE_TYPE_NOT_FOUND;
2717 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2725 status = g_malloc0(10);
2726 ga_read_sysfs_file(dirfd, "state", status, 10, &local_err);
2728 /* treat with sysfs file that not exist in old kernel */
2729 if (errno == ENOENT) {
2730 error_free(local_err);
2732 mem_blk->online = true;
2733 mem_blk->can_offline = false;
2734 } else if (!mem_blk->online) {
2736 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED;
2740 error_propagate(errp, local_err);
2742 error_free(local_err);
2744 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2751 char removable = '0';
2753 mem_blk->online = (strncmp(status, "online", 6) == 0);
2755 ga_read_sysfs_file(dirfd, "removable", &removable, 1, &local_err);
2757 /* if no 'removable' file, it doesn't support offline mem blk */
2758 if (errno == ENOENT) {
2759 error_free(local_err);
2760 mem_blk->can_offline = false;
2762 error_propagate(errp, local_err);
2765 mem_blk->can_offline = (removable != '0');
2768 if (mem_blk->online != (strncmp(status, "online", 6) == 0)) {
2769 const char *new_state = mem_blk->online ? "online" : "offline";
2771 ga_write_sysfs_file(dirfd, "state", new_state, strlen(new_state),
2774 error_free(local_err);
2776 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED;
2780 result->response = GUEST_MEMORY_BLOCK_RESPONSE_TYPE_SUCCESS;
2781 result->has_error_code = false;
2782 } /* otherwise pretend successful re-(on|off)-lining */
2793 result->has_error_code = true;
2794 result->error_code = errno;
2798 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
2800 GuestMemoryBlockList *head, **tail;
2801 Error *local_err = NULL;
2808 dp = opendir("/sys/devices/system/memory/");
2810 /* it's ok if this happens to be a system that doesn't expose
2811 * memory blocks via sysfs, but otherwise we should report
2814 if (errno != ENOENT) {
2815 error_setg_errno(errp, errno, "Can't open directory"
2816 "\"/sys/devices/system/memory/\"");
2821 /* Note: the phys_index of memory block may be discontinuous,
2822 * this is because a memblk is the unit of the Sparse Memory design, which
2823 * allows discontinuous memory ranges (ex. NUMA), so here we should
2824 * traverse the memory block directory.
2826 while ((de = readdir(dp)) != NULL) {
2827 GuestMemoryBlock *mem_blk;
2829 if ((strncmp(de->d_name, "memory", 6) != 0) ||
2830 !(de->d_type & DT_DIR)) {
2834 mem_blk = g_malloc0(sizeof *mem_blk);
2835 /* The d_name is "memoryXXX", phys_index is block id, same as XXX */
2836 mem_blk->phys_index = strtoul(&de->d_name[6], NULL, 10);
2837 mem_blk->has_can_offline = true; /* lolspeak ftw */
2838 transfer_memory_block(mem_blk, true, NULL, &local_err);
2843 QAPI_LIST_APPEND(tail, mem_blk);
2847 if (local_err == NULL) {
2848 /* there's no guest with zero memory blocks */
2850 error_setg(errp, "guest reported zero memory blocks!");
2855 qapi_free_GuestMemoryBlockList(head);
2856 error_propagate(errp, local_err);
2860 GuestMemoryBlockResponseList *
2861 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
2863 GuestMemoryBlockResponseList *head, **tail;
2864 Error *local_err = NULL;
2869 while (mem_blks != NULL) {
2870 GuestMemoryBlockResponse *result;
2871 GuestMemoryBlock *current_mem_blk = mem_blks->value;
2873 result = g_malloc0(sizeof(*result));
2874 result->phys_index = current_mem_blk->phys_index;
2875 transfer_memory_block(current_mem_blk, false, result, &local_err);
2876 if (local_err) { /* should never happen */
2880 QAPI_LIST_APPEND(tail, result);
2881 mem_blks = mem_blks->next;
2886 qapi_free_GuestMemoryBlockResponseList(head);
2887 error_propagate(errp, local_err);
2891 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
2893 Error *local_err = NULL;
2897 GuestMemoryBlockInfo *info;
2899 dirpath = g_strdup_printf("/sys/devices/system/memory/");
2900 dirfd = open(dirpath, O_RDONLY | O_DIRECTORY);
2902 error_setg_errno(errp, errno, "open(\"%s\")", dirpath);
2908 buf = g_malloc0(20);
2909 ga_read_sysfs_file(dirfd, "block_size_bytes", buf, 20, &local_err);
2913 error_propagate(errp, local_err);
2917 info = g_new0(GuestMemoryBlockInfo, 1);
2918 info->size = strtol(buf, NULL, 16); /* the unit is bytes */
2925 #else /* defined(__linux__) */
2927 void qmp_guest_suspend_disk(Error **errp)
2929 error_setg(errp, QERR_UNSUPPORTED);
2932 void qmp_guest_suspend_ram(Error **errp)
2934 error_setg(errp, QERR_UNSUPPORTED);
2937 void qmp_guest_suspend_hybrid(Error **errp)
2939 error_setg(errp, QERR_UNSUPPORTED);
2942 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
2944 error_setg(errp, QERR_UNSUPPORTED);
2948 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
2950 error_setg(errp, QERR_UNSUPPORTED);
2954 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
2956 error_setg(errp, QERR_UNSUPPORTED);
2960 void qmp_guest_set_user_password(const char *username,
2961 const char *password,
2965 error_setg(errp, QERR_UNSUPPORTED);
2968 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
2970 error_setg(errp, QERR_UNSUPPORTED);
2974 GuestMemoryBlockResponseList *
2975 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
2977 error_setg(errp, QERR_UNSUPPORTED);
2981 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
2983 error_setg(errp, QERR_UNSUPPORTED);
2989 #if !defined(CONFIG_FSFREEZE)
2991 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
2993 error_setg(errp, QERR_UNSUPPORTED);
2997 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
2999 error_setg(errp, QERR_UNSUPPORTED);
3004 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
3006 error_setg(errp, QERR_UNSUPPORTED);
3011 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
3012 strList *mountpoints,
3015 error_setg(errp, QERR_UNSUPPORTED);
3020 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
3022 error_setg(errp, QERR_UNSUPPORTED);
3027 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
3029 error_setg(errp, QERR_UNSUPPORTED);
3033 #endif /* CONFIG_FSFREEZE */
3035 #if !defined(CONFIG_FSTRIM)
3036 GuestFilesystemTrimResponse *
3037 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
3039 error_setg(errp, QERR_UNSUPPORTED);
3044 /* add unsupported commands to the blacklist */
3045 GList *ga_command_blacklist_init(GList *blacklist)
3047 #if !defined(__linux__)
3049 const char *list[] = {
3050 "guest-suspend-disk", "guest-suspend-ram",
3051 "guest-suspend-hybrid", "guest-network-get-interfaces",
3052 "guest-get-vcpus", "guest-set-vcpus",
3053 "guest-get-memory-blocks", "guest-set-memory-blocks",
3054 "guest-get-memory-block-size", "guest-get-memory-block-info",
3056 char **p = (char **)list;
3059 blacklist = g_list_append(blacklist, g_strdup(*p++));
3064 #if !defined(CONFIG_FSFREEZE)
3066 const char *list[] = {
3067 "guest-get-fsinfo", "guest-fsfreeze-status",
3068 "guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list",
3069 "guest-fsfreeze-thaw", "guest-get-fsinfo",
3070 "guest-get-disks", NULL};
3071 char **p = (char **)list;
3074 blacklist = g_list_append(blacklist, g_strdup(*p++));
3079 #if !defined(CONFIG_FSTRIM)
3080 blacklist = g_list_append(blacklist, g_strdup("guest-fstrim"));
3083 blacklist = g_list_append(blacklist, g_strdup("guest-get-devices"));
3088 /* register init/cleanup routines for stateful command groups */
3089 void ga_command_state_init(GAState *s, GACommandState *cs)
3091 #if defined(CONFIG_FSFREEZE)
3092 ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
3098 #define QGA_MICRO_SECOND_TO_SECOND 1000000
3100 static double ga_get_login_time(struct utmpx *user_info)
3102 double seconds = (double)user_info->ut_tv.tv_sec;
3103 double useconds = (double)user_info->ut_tv.tv_usec;
3104 useconds /= QGA_MICRO_SECOND_TO_SECOND;
3105 return seconds + useconds;
3108 GuestUserList *qmp_guest_get_users(Error **errp)
3110 GHashTable *cache = NULL;
3111 GuestUserList *head = NULL, **tail = &head;
3112 struct utmpx *user_info = NULL;
3113 gpointer value = NULL;
3114 GuestUser *user = NULL;
3115 double login_time = 0;
3117 cache = g_hash_table_new(g_str_hash, g_str_equal);
3121 user_info = getutxent();
3122 if (user_info == NULL) {
3124 } else if (user_info->ut_type != USER_PROCESS) {
3126 } else if (g_hash_table_contains(cache, user_info->ut_user)) {
3127 value = g_hash_table_lookup(cache, user_info->ut_user);
3128 user = (GuestUser *)value;
3129 login_time = ga_get_login_time(user_info);
3130 /* We're ensuring the earliest login time to be sent */
3131 if (login_time < user->login_time) {
3132 user->login_time = login_time;
3137 user = g_new0(GuestUser, 1);
3138 user->user = g_strdup(user_info->ut_user);
3139 user->login_time = ga_get_login_time(user_info);
3141 g_hash_table_insert(cache, user->user, user);
3143 QAPI_LIST_APPEND(tail, user);
3146 g_hash_table_destroy(cache);
3152 GuestUserList *qmp_guest_get_users(Error **errp)
3154 error_setg(errp, QERR_UNSUPPORTED);
3160 /* Replace escaped special characters with theire real values. The replacement
3161 * is done in place -- returned value is in the original string.
3163 static void ga_osrelease_replace_special(gchar *value)
3165 gchar *p, *p2, quote;
3167 /* Trim the string at first space or semicolon if it is not enclosed in
3168 * single or double quotes. */
3169 if ((value[0] != '"') || (value[0] == '\'')) {
3170 p = strchr(value, ' ');
3174 p = strchr(value, ';');
3195 /* Keep literal backslash followed by whatever is there */
3199 } else if (*p == quote) {
3207 static GKeyFile *ga_parse_osrelease(const char *fname)
3209 gchar *content = NULL;
3210 gchar *content2 = NULL;
3212 GKeyFile *keys = g_key_file_new();
3213 const char *group = "[os-release]\n";
3215 if (!g_file_get_contents(fname, &content, NULL, &err)) {
3216 slog("failed to read '%s', error: %s", fname, err->message);
3220 if (!g_utf8_validate(content, -1, NULL)) {
3221 slog("file is not utf-8 encoded: %s", fname);
3224 content2 = g_strdup_printf("%s%s", group, content);
3226 if (!g_key_file_load_from_data(keys, content2, -1, G_KEY_FILE_NONE,
3228 slog("failed to parse file '%s', error: %s", fname, err->message);
3240 g_key_file_free(keys);
3244 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
3246 GuestOSInfo *info = NULL;
3247 struct utsname kinfo;
3248 GKeyFile *osrelease = NULL;
3249 const char *qga_os_release = g_getenv("QGA_OS_RELEASE");
3251 info = g_new0(GuestOSInfo, 1);
3253 if (uname(&kinfo) != 0) {
3254 error_setg_errno(errp, errno, "uname failed");
3256 info->has_kernel_version = true;
3257 info->kernel_version = g_strdup(kinfo.version);
3258 info->has_kernel_release = true;
3259 info->kernel_release = g_strdup(kinfo.release);
3260 info->has_machine = true;
3261 info->machine = g_strdup(kinfo.machine);
3264 if (qga_os_release != NULL) {
3265 osrelease = ga_parse_osrelease(qga_os_release);
3267 osrelease = ga_parse_osrelease("/etc/os-release");
3268 if (osrelease == NULL) {
3269 osrelease = ga_parse_osrelease("/usr/lib/os-release");
3273 if (osrelease != NULL) {
3276 #define GET_FIELD(field, osfield) do { \
3277 value = g_key_file_get_value(osrelease, "os-release", osfield, NULL); \
3278 if (value != NULL) { \
3279 ga_osrelease_replace_special(value); \
3280 info->has_ ## field = true; \
3281 info->field = value; \
3284 GET_FIELD(id, "ID");
3285 GET_FIELD(name, "NAME");
3286 GET_FIELD(pretty_name, "PRETTY_NAME");
3287 GET_FIELD(version, "VERSION");
3288 GET_FIELD(version_id, "VERSION_ID");
3289 GET_FIELD(variant, "VARIANT");
3290 GET_FIELD(variant_id, "VARIANT_ID");
3293 g_key_file_free(osrelease);
3299 GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
3301 error_setg(errp, QERR_UNSUPPORTED);