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
;
1071 GuestDiskAddressList
*list
= NULL
;
1073 #ifdef CONFIG_LIBUDEV
1074 struct udev
*udev
= NULL
;
1075 struct udev_device
*udevice
= NULL
;
1078 pciaddr
= g_new0(GuestPCIAddress
, 1);
1079 pciaddr
->domain
= -1; /* -1 means field is invalid */
1082 pciaddr
->function
= -1;
1084 disk
= g_new0(GuestDiskAddress
, 1);
1085 disk
->pci_controller
= pciaddr
;
1086 disk
->bus_type
= GUEST_DISK_BUS_TYPE_UNKNOWN
;
1088 list
= g_new0(GuestDiskAddressList
, 1);
1091 #ifdef CONFIG_LIBUDEV
1093 udevice
= udev_device_new_from_syspath(udev
, syspath
);
1094 if (udev
== NULL
|| udevice
== NULL
) {
1095 g_debug("failed to query udev");
1097 const char *devnode
, *serial
;
1098 devnode
= udev_device_get_devnode(udevice
);
1099 if (devnode
!= NULL
) {
1100 disk
->dev
= g_strdup(devnode
);
1101 disk
->has_dev
= true;
1103 serial
= udev_device_get_property_value(udevice
, "ID_SERIAL");
1104 if (serial
!= NULL
&& *serial
!= 0) {
1105 disk
->serial
= g_strdup(serial
);
1106 disk
->has_serial
= true;
1111 udev_device_unref(udevice
);
1114 if (strstr(syspath
, "/devices/pci")) {
1115 has_hwinf
= build_guest_fsinfo_for_pci_dev(syspath
, disk
, errp
);
1116 } else if (strstr(syspath
, "/devices/css")) {
1117 has_hwinf
= build_guest_fsinfo_for_ccw_dev(syspath
, disk
, errp
);
1118 } else if (strstr(syspath
, "/virtio")) {
1119 has_hwinf
= build_guest_fsinfo_for_nonpci_virtio(syspath
, disk
, errp
);
1121 g_debug("Unsupported device type for '%s'", syspath
);
1125 if (has_hwinf
|| disk
->has_dev
|| disk
->has_serial
) {
1126 list
->next
= fs
->disk
;
1129 qapi_free_GuestDiskAddressList(list
);
1133 static void build_guest_fsinfo_for_device(char const *devpath
,
1134 GuestFilesystemInfo
*fs
,
1137 /* Store a list of slave devices of virtual volume specified by @syspath into
1139 static void build_guest_fsinfo_for_virtual_device(char const *syspath
,
1140 GuestFilesystemInfo
*fs
,
1146 struct dirent
*entry
;
1148 dirpath
= g_strdup_printf("%s/slaves", syspath
);
1149 dir
= opendir(dirpath
);
1151 if (errno
!= ENOENT
) {
1152 error_setg_errno(errp
, errno
, "opendir(\"%s\")", dirpath
);
1160 entry
= readdir(dir
);
1161 if (entry
== NULL
) {
1163 error_setg_errno(errp
, errno
, "readdir(\"%s\")", dirpath
);
1168 if (entry
->d_type
== DT_LNK
) {
1171 g_debug(" slave device '%s'", entry
->d_name
);
1172 path
= g_strdup_printf("%s/slaves/%s", syspath
, entry
->d_name
);
1173 build_guest_fsinfo_for_device(path
, fs
, &err
);
1177 error_propagate(errp
, err
);
1187 static bool is_disk_virtual(const char *devpath
, Error
**errp
)
1189 g_autofree
char *syspath
= realpath(devpath
, NULL
);
1192 error_setg_errno(errp
, errno
, "realpath(\"%s\")", devpath
);
1195 return strstr(syspath
, "/devices/virtual/block/") != NULL
;
1198 /* Dispatch to functions for virtual/real device */
1199 static void build_guest_fsinfo_for_device(char const *devpath
,
1200 GuestFilesystemInfo
*fs
,
1204 g_autofree
char *syspath
= NULL
;
1205 bool is_virtual
= false;
1207 syspath
= realpath(devpath
, NULL
);
1209 error_setg_errno(errp
, errno
, "realpath(\"%s\")", devpath
);
1214 fs
->name
= g_path_get_basename(syspath
);
1217 g_debug(" parse sysfs path '%s'", syspath
);
1218 is_virtual
= is_disk_virtual(syspath
, errp
);
1219 if (*errp
!= NULL
) {
1223 build_guest_fsinfo_for_virtual_device(syspath
, fs
, errp
);
1225 build_guest_fsinfo_for_real_device(syspath
, fs
, errp
);
1229 #ifdef CONFIG_LIBUDEV
1232 * Wrapper around build_guest_fsinfo_for_device() for getting just
1235 static GuestDiskAddress
*get_disk_address(const char *syspath
, Error
**errp
)
1237 g_autoptr(GuestFilesystemInfo
) fs
= NULL
;
1239 fs
= g_new0(GuestFilesystemInfo
, 1);
1240 build_guest_fsinfo_for_device(syspath
, fs
, errp
);
1241 if (fs
->disk
!= NULL
) {
1242 return g_steal_pointer(&fs
->disk
->value
);
1247 static char *get_alias_for_syspath(const char *syspath
)
1249 struct udev
*udev
= NULL
;
1250 struct udev_device
*udevice
= NULL
;
1255 g_debug("failed to query udev");
1258 udevice
= udev_device_new_from_syspath(udev
, syspath
);
1259 if (udevice
== NULL
) {
1260 g_debug("failed to query udev for path: %s", syspath
);
1263 const char *alias
= udev_device_get_property_value(
1264 udevice
, "DM_NAME");
1266 * NULL means there was an error and empty string means there is no
1267 * alias. In case of no alias we return NULL instead of empty string.
1269 if (alias
== NULL
) {
1270 g_debug("failed to query udev for device alias for: %s",
1272 } else if (*alias
!= 0) {
1273 ret
= g_strdup(alias
);
1279 udev_device_unref(udevice
);
1283 static char *get_device_for_syspath(const char *syspath
)
1285 struct udev
*udev
= NULL
;
1286 struct udev_device
*udevice
= NULL
;
1291 g_debug("failed to query udev");
1294 udevice
= udev_device_new_from_syspath(udev
, syspath
);
1295 if (udevice
== NULL
) {
1296 g_debug("failed to query udev for path: %s", syspath
);
1299 ret
= g_strdup(udev_device_get_devnode(udevice
));
1304 udev_device_unref(udevice
);
1308 static void get_disk_deps(const char *disk_dir
, GuestDiskInfo
*disk
)
1310 g_autofree
char *deps_dir
= NULL
;
1312 GDir
*dp_deps
= NULL
;
1314 /* List dependent disks */
1315 deps_dir
= g_strdup_printf("%s/slaves", disk_dir
);
1316 g_debug(" listing entries in: %s", deps_dir
);
1317 dp_deps
= g_dir_open(deps_dir
, 0, NULL
);
1318 if (dp_deps
== NULL
) {
1319 g_debug("failed to list entries in %s", deps_dir
);
1322 disk
->has_dependencies
= true;
1323 while ((dep
= g_dir_read_name(dp_deps
)) != NULL
) {
1324 g_autofree
char *dep_dir
= NULL
;
1325 strList
*dep_item
= NULL
;
1328 /* Add dependent disks */
1329 dep_dir
= g_strdup_printf("%s/%s", deps_dir
, dep
);
1330 dev_name
= get_device_for_syspath(dep_dir
);
1331 if (dev_name
!= NULL
) {
1332 g_debug(" adding dependent device: %s", dev_name
);
1333 dep_item
= g_new0(strList
, 1);
1334 dep_item
->value
= dev_name
;
1335 dep_item
->next
= disk
->dependencies
;
1336 disk
->dependencies
= dep_item
;
1339 g_dir_close(dp_deps
);
1343 * Detect partitions subdirectory, name is "<disk_name><number>" or
1344 * "<disk_name>p<number>"
1346 * @disk_name -- last component of /sys path (e.g. sda)
1347 * @disk_dir -- sys path of the disk (e.g. /sys/block/sda)
1348 * @disk_dev -- device node of the disk (e.g. /dev/sda)
1350 static GuestDiskInfoList
*get_disk_partitions(
1351 GuestDiskInfoList
*list
,
1352 const char *disk_name
, const char *disk_dir
,
1353 const char *disk_dev
)
1355 GuestDiskInfoList
*item
, *ret
= list
;
1356 struct dirent
*de_disk
;
1357 DIR *dp_disk
= NULL
;
1358 size_t len
= strlen(disk_name
);
1360 dp_disk
= opendir(disk_dir
);
1361 while ((de_disk
= readdir(dp_disk
)) != NULL
) {
1362 g_autofree
char *partition_dir
= NULL
;
1364 GuestDiskInfo
*partition
;
1366 if (!(de_disk
->d_type
& DT_DIR
)) {
1370 if (!(strncmp(disk_name
, de_disk
->d_name
, len
) == 0 &&
1371 ((*(de_disk
->d_name
+ len
) == 'p' &&
1372 isdigit(*(de_disk
->d_name
+ len
+ 1))) ||
1373 isdigit(*(de_disk
->d_name
+ len
))))) {
1377 partition_dir
= g_strdup_printf("%s/%s",
1378 disk_dir
, de_disk
->d_name
);
1379 dev_name
= get_device_for_syspath(partition_dir
);
1380 if (dev_name
== NULL
) {
1381 g_debug("Failed to get device name for syspath: %s",
1385 partition
= g_new0(GuestDiskInfo
, 1);
1386 partition
->name
= dev_name
;
1387 partition
->partition
= true;
1388 /* Add parent disk as dependent for easier tracking of hierarchy */
1389 partition
->dependencies
= g_new0(strList
, 1);
1390 partition
->dependencies
->value
= g_strdup(disk_dev
);
1391 partition
->has_dependencies
= true;
1393 item
= g_new0(GuestDiskInfoList
, 1);
1394 item
->value
= partition
;
1404 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
1406 GuestDiskInfoList
*item
, *ret
= NULL
;
1407 GuestDiskInfo
*disk
;
1409 struct dirent
*de
= NULL
;
1411 g_debug("listing /sys/block directory");
1412 dp
= opendir("/sys/block");
1414 error_setg_errno(errp
, errno
, "Can't open directory \"/sys/block\"");
1417 while ((de
= readdir(dp
)) != NULL
) {
1418 g_autofree
char *disk_dir
= NULL
, *line
= NULL
,
1421 Error
*local_err
= NULL
;
1422 if (de
->d_type
!= DT_LNK
) {
1423 g_debug(" skipping entry: %s", de
->d_name
);
1427 /* Check size and skip zero-sized disks */
1428 g_debug(" checking disk size");
1429 size_path
= g_strdup_printf("/sys/block/%s/size", de
->d_name
);
1430 if (!g_file_get_contents(size_path
, &line
, NULL
, NULL
)) {
1431 g_debug(" failed to read disk size");
1434 if (g_strcmp0(line
, "0\n") == 0) {
1435 g_debug(" skipping zero-sized disk");
1439 g_debug(" adding %s", de
->d_name
);
1440 disk_dir
= g_strdup_printf("/sys/block/%s", de
->d_name
);
1441 dev_name
= get_device_for_syspath(disk_dir
);
1442 if (dev_name
== NULL
) {
1443 g_debug("Failed to get device name for syspath: %s",
1447 disk
= g_new0(GuestDiskInfo
, 1);
1448 disk
->name
= dev_name
;
1449 disk
->partition
= false;
1450 disk
->alias
= get_alias_for_syspath(disk_dir
);
1451 disk
->has_alias
= (disk
->alias
!= NULL
);
1452 item
= g_new0(GuestDiskInfoList
, 1);
1457 /* Get address for non-virtual devices */
1458 bool is_virtual
= is_disk_virtual(disk_dir
, &local_err
);
1459 if (local_err
!= NULL
) {
1460 g_debug(" failed to check disk path, ignoring error: %s",
1461 error_get_pretty(local_err
));
1462 error_free(local_err
);
1464 /* Don't try to get the address */
1468 disk
->address
= get_disk_address(disk_dir
, &local_err
);
1469 if (local_err
!= NULL
) {
1470 g_debug(" failed to get device info, ignoring error: %s",
1471 error_get_pretty(local_err
));
1472 error_free(local_err
);
1474 } else if (disk
->address
!= NULL
) {
1475 disk
->has_address
= true;
1479 get_disk_deps(disk_dir
, disk
);
1480 ret
= get_disk_partitions(ret
, de
->d_name
, disk_dir
, dev_name
);
1490 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
1492 error_setg(errp
, QERR_UNSUPPORTED
);
1498 /* Return a list of the disk device(s)' info which @mount lies on */
1499 static GuestFilesystemInfo
*build_guest_fsinfo(struct FsMount
*mount
,
1502 GuestFilesystemInfo
*fs
= g_malloc0(sizeof(*fs
));
1504 unsigned long used
, nonroot_total
, fr_size
;
1505 char *devpath
= g_strdup_printf("/sys/dev/block/%u:%u",
1506 mount
->devmajor
, mount
->devminor
);
1508 fs
->mountpoint
= g_strdup(mount
->dirname
);
1509 fs
->type
= g_strdup(mount
->devtype
);
1510 build_guest_fsinfo_for_device(devpath
, fs
, errp
);
1512 if (statvfs(fs
->mountpoint
, &buf
) == 0) {
1513 fr_size
= buf
.f_frsize
;
1514 used
= buf
.f_blocks
- buf
.f_bfree
;
1515 nonroot_total
= used
+ buf
.f_bavail
;
1516 fs
->used_bytes
= used
* fr_size
;
1517 fs
->total_bytes
= nonroot_total
* fr_size
;
1519 fs
->has_total_bytes
= true;
1520 fs
->has_used_bytes
= true;
1528 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
1531 struct FsMount
*mount
;
1532 GuestFilesystemInfoList
*new, *ret
= NULL
;
1533 Error
*local_err
= NULL
;
1535 QTAILQ_INIT(&mounts
);
1536 build_fs_mount_list(&mounts
, &local_err
);
1538 error_propagate(errp
, local_err
);
1542 QTAILQ_FOREACH(mount
, &mounts
, next
) {
1543 g_debug("Building guest fsinfo for '%s'", mount
->dirname
);
1545 new = g_malloc0(sizeof(*ret
));
1546 new->value
= build_guest_fsinfo(mount
, &local_err
);
1550 error_propagate(errp
, local_err
);
1551 qapi_free_GuestFilesystemInfoList(ret
);
1557 free_fs_mount_list(&mounts
);
1563 FSFREEZE_HOOK_THAW
= 0,
1564 FSFREEZE_HOOK_FREEZE
,
1567 static const char *fsfreeze_hook_arg_string
[] = {
1572 static void execute_fsfreeze_hook(FsfreezeHookArg arg
, Error
**errp
)
1577 const char *arg_str
= fsfreeze_hook_arg_string
[arg
];
1578 Error
*local_err
= NULL
;
1580 hook
= ga_fsfreeze_hook(ga_state
);
1584 if (access(hook
, X_OK
) != 0) {
1585 error_setg_errno(errp
, errno
, "can't access fsfreeze hook '%s'", hook
);
1589 slog("executing fsfreeze hook with arg '%s'", arg_str
);
1593 reopen_fd_to_null(0);
1594 reopen_fd_to_null(1);
1595 reopen_fd_to_null(2);
1597 execle(hook
, hook
, arg_str
, NULL
, environ
);
1598 _exit(EXIT_FAILURE
);
1599 } else if (pid
< 0) {
1600 error_setg_errno(errp
, errno
, "failed to create child process");
1604 ga_wait_child(pid
, &status
, &local_err
);
1606 error_propagate(errp
, local_err
);
1610 if (!WIFEXITED(status
)) {
1611 error_setg(errp
, "fsfreeze hook has terminated abnormally");
1615 status
= WEXITSTATUS(status
);
1617 error_setg(errp
, "fsfreeze hook has failed with status %d", status
);
1623 * Return status of freeze/thaw
1625 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
1627 if (ga_is_frozen(ga_state
)) {
1628 return GUEST_FSFREEZE_STATUS_FROZEN
;
1631 return GUEST_FSFREEZE_STATUS_THAWED
;
1634 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
1636 return qmp_guest_fsfreeze_freeze_list(false, NULL
, errp
);
1640 * Walk list of mounted file systems in the guest, and freeze the ones which
1641 * are real local file systems.
1643 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
1644 strList
*mountpoints
,
1650 struct FsMount
*mount
;
1651 Error
*local_err
= NULL
;
1654 slog("guest-fsfreeze called");
1656 execute_fsfreeze_hook(FSFREEZE_HOOK_FREEZE
, &local_err
);
1658 error_propagate(errp
, local_err
);
1662 QTAILQ_INIT(&mounts
);
1663 build_fs_mount_list(&mounts
, &local_err
);
1665 error_propagate(errp
, local_err
);
1669 /* cannot risk guest agent blocking itself on a write in this state */
1670 ga_set_frozen(ga_state
);
1672 QTAILQ_FOREACH_REVERSE(mount
, &mounts
, next
) {
1673 /* To issue fsfreeze in the reverse order of mounts, check if the
1674 * mount is listed in the list here */
1675 if (has_mountpoints
) {
1676 for (list
= mountpoints
; list
; list
= list
->next
) {
1677 if (strcmp(list
->value
, mount
->dirname
) == 0) {
1686 fd
= qemu_open_old(mount
->dirname
, O_RDONLY
);
1688 error_setg_errno(errp
, errno
, "failed to open %s", mount
->dirname
);
1692 /* we try to cull filesystems we know won't work in advance, but other
1693 * filesystems may not implement fsfreeze for less obvious reasons.
1694 * these will report EOPNOTSUPP. we simply ignore these when tallying
1695 * the number of frozen filesystems.
1696 * if a filesystem is mounted more than once (aka bind mount) a
1697 * consecutive attempt to freeze an already frozen filesystem will
1700 * any other error means a failure to freeze a filesystem we
1701 * expect to be freezable, so return an error in those cases
1702 * and return system to thawed state.
1704 ret
= ioctl(fd
, FIFREEZE
);
1706 if (errno
!= EOPNOTSUPP
&& errno
!= EBUSY
) {
1707 error_setg_errno(errp
, errno
, "failed to freeze %s",
1718 free_fs_mount_list(&mounts
);
1719 /* We may not issue any FIFREEZE here.
1720 * Just unset ga_state here and ready for the next call.
1723 ga_unset_frozen(ga_state
);
1728 free_fs_mount_list(&mounts
);
1729 qmp_guest_fsfreeze_thaw(NULL
);
1734 * Walk list of frozen file systems in the guest, and thaw them.
1736 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
1741 int fd
, i
= 0, logged
;
1742 Error
*local_err
= NULL
;
1744 QTAILQ_INIT(&mounts
);
1745 build_fs_mount_list(&mounts
, &local_err
);
1747 error_propagate(errp
, local_err
);
1751 QTAILQ_FOREACH(mount
, &mounts
, next
) {
1753 fd
= qemu_open_old(mount
->dirname
, O_RDONLY
);
1757 /* we have no way of knowing whether a filesystem was actually unfrozen
1758 * as a result of a successful call to FITHAW, only that if an error
1759 * was returned the filesystem was *not* unfrozen by that particular
1762 * since multiple preceding FIFREEZEs require multiple calls to FITHAW
1763 * to unfreeze, continuing issuing FITHAW until an error is returned,
1764 * in which case either the filesystem is in an unfreezable state, or,
1765 * more likely, it was thawed previously (and remains so afterward).
1767 * also, since the most recent successful call is the one that did
1768 * the actual unfreeze, we can use this to provide an accurate count
1769 * of the number of filesystems unfrozen by guest-fsfreeze-thaw, which
1770 * may * be useful for determining whether a filesystem was unfrozen
1771 * during the freeze/thaw phase by a process other than qemu-ga.
1774 ret
= ioctl(fd
, FITHAW
);
1775 if (ret
== 0 && !logged
) {
1783 ga_unset_frozen(ga_state
);
1784 free_fs_mount_list(&mounts
);
1786 execute_fsfreeze_hook(FSFREEZE_HOOK_THAW
, errp
);
1791 static void guest_fsfreeze_cleanup(void)
1795 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
1796 qmp_guest_fsfreeze_thaw(&err
);
1798 slog("failed to clean up frozen filesystems: %s",
1799 error_get_pretty(err
));
1804 #endif /* CONFIG_FSFREEZE */
1806 #if defined(CONFIG_FSTRIM)
1808 * Walk list of mounted file systems in the guest, and trim them.
1810 GuestFilesystemTrimResponse
*
1811 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
1813 GuestFilesystemTrimResponse
*response
;
1814 GuestFilesystemTrimResultList
*list
;
1815 GuestFilesystemTrimResult
*result
;
1818 struct FsMount
*mount
;
1820 Error
*local_err
= NULL
;
1821 struct fstrim_range r
;
1823 slog("guest-fstrim called");
1825 QTAILQ_INIT(&mounts
);
1826 build_fs_mount_list(&mounts
, &local_err
);
1828 error_propagate(errp
, local_err
);
1832 response
= g_malloc0(sizeof(*response
));
1834 QTAILQ_FOREACH(mount
, &mounts
, next
) {
1835 result
= g_malloc0(sizeof(*result
));
1836 result
->path
= g_strdup(mount
->dirname
);
1838 list
= g_malloc0(sizeof(*list
));
1839 list
->value
= result
;
1840 list
->next
= response
->paths
;
1841 response
->paths
= list
;
1843 fd
= qemu_open_old(mount
->dirname
, O_RDONLY
);
1845 result
->error
= g_strdup_printf("failed to open: %s",
1847 result
->has_error
= true;
1851 /* We try to cull filesystems we know won't work in advance, but other
1852 * filesystems may not implement fstrim for less obvious reasons.
1853 * These will report EOPNOTSUPP; while in some other cases ENOTTY
1854 * will be reported (e.g. CD-ROMs).
1855 * Any other error means an unexpected error.
1859 r
.minlen
= has_minimum
? minimum
: 0;
1860 ret
= ioctl(fd
, FITRIM
, &r
);
1862 result
->has_error
= true;
1863 if (errno
== ENOTTY
|| errno
== EOPNOTSUPP
) {
1864 result
->error
= g_strdup("trim not supported");
1866 result
->error
= g_strdup_printf("failed to trim: %s",
1873 result
->has_minimum
= true;
1874 result
->minimum
= r
.minlen
;
1875 result
->has_trimmed
= true;
1876 result
->trimmed
= r
.len
;
1880 free_fs_mount_list(&mounts
);
1883 #endif /* CONFIG_FSTRIM */
1886 #define LINUX_SYS_STATE_FILE "/sys/power/state"
1887 #define SUSPEND_SUPPORTED 0
1888 #define SUSPEND_NOT_SUPPORTED 1
1891 SUSPEND_MODE_DISK
= 0,
1892 SUSPEND_MODE_RAM
= 1,
1893 SUSPEND_MODE_HYBRID
= 2,
1897 * Executes a command in a child process using g_spawn_sync,
1898 * returning an int >= 0 representing the exit status of the
1901 * If the program wasn't found in path, returns -1.
1903 * If a problem happened when creating the child process,
1904 * returns -1 and errp is set.
1906 static int run_process_child(const char *command
[], Error
**errp
)
1908 int exit_status
, spawn_flag
;
1909 GError
*g_err
= NULL
;
1912 spawn_flag
= G_SPAWN_SEARCH_PATH
| G_SPAWN_STDOUT_TO_DEV_NULL
|
1913 G_SPAWN_STDERR_TO_DEV_NULL
;
1915 success
= g_spawn_sync(NULL
, (char **)command
, environ
, spawn_flag
,
1916 NULL
, NULL
, NULL
, NULL
,
1917 &exit_status
, &g_err
);
1920 return WEXITSTATUS(exit_status
);
1923 if (g_err
&& (g_err
->code
!= G_SPAWN_ERROR_NOENT
)) {
1924 error_setg(errp
, "failed to create child process, error '%s'",
1928 g_error_free(g_err
);
1932 static bool systemd_supports_mode(SuspendMode mode
, Error
**errp
)
1934 const char *systemctl_args
[3] = {"systemd-hibernate", "systemd-suspend",
1935 "systemd-hybrid-sleep"};
1936 const char *cmd
[4] = {"systemctl", "status", systemctl_args
[mode
], NULL
};
1939 status
= run_process_child(cmd
, errp
);
1942 * systemctl status uses LSB return codes so we can expect
1943 * status > 0 and be ok. To assert if the guest has support
1944 * for the selected suspend mode, status should be < 4. 4 is
1945 * the code for unknown service status, the return value when
1946 * the service does not exist. A common value is status = 3
1947 * (program is not running).
1949 if (status
> 0 && status
< 4) {
1956 static void systemd_suspend(SuspendMode mode
, Error
**errp
)
1958 Error
*local_err
= NULL
;
1959 const char *systemctl_args
[3] = {"hibernate", "suspend", "hybrid-sleep"};
1960 const char *cmd
[3] = {"systemctl", systemctl_args
[mode
], NULL
};
1963 status
= run_process_child(cmd
, &local_err
);
1969 if ((status
== -1) && !local_err
) {
1970 error_setg(errp
, "the helper program 'systemctl %s' was not found",
1971 systemctl_args
[mode
]);
1976 error_propagate(errp
, local_err
);
1978 error_setg(errp
, "the helper program 'systemctl %s' returned an "
1979 "unexpected exit status code (%d)",
1980 systemctl_args
[mode
], status
);
1984 static bool pmutils_supports_mode(SuspendMode mode
, Error
**errp
)
1986 Error
*local_err
= NULL
;
1987 const char *pmutils_args
[3] = {"--hibernate", "--suspend",
1988 "--suspend-hybrid"};
1989 const char *cmd
[3] = {"pm-is-supported", pmutils_args
[mode
], NULL
};
1992 status
= run_process_child(cmd
, &local_err
);
1994 if (status
== SUSPEND_SUPPORTED
) {
1998 if ((status
== -1) && !local_err
) {
2003 error_propagate(errp
, local_err
);
2006 "the helper program '%s' returned an unexpected exit"
2007 " status code (%d)", "pm-is-supported", status
);
2013 static void pmutils_suspend(SuspendMode mode
, Error
**errp
)
2015 Error
*local_err
= NULL
;
2016 const char *pmutils_binaries
[3] = {"pm-hibernate", "pm-suspend",
2017 "pm-suspend-hybrid"};
2018 const char *cmd
[2] = {pmutils_binaries
[mode
], NULL
};
2021 status
= run_process_child(cmd
, &local_err
);
2027 if ((status
== -1) && !local_err
) {
2028 error_setg(errp
, "the helper program '%s' was not found",
2029 pmutils_binaries
[mode
]);
2034 error_propagate(errp
, local_err
);
2037 "the helper program '%s' returned an unexpected exit"
2038 " status code (%d)", pmutils_binaries
[mode
], status
);
2042 static bool linux_sys_state_supports_mode(SuspendMode mode
, Error
**errp
)
2044 const char *sysfile_strs
[3] = {"disk", "mem", NULL
};
2045 const char *sysfile_str
= sysfile_strs
[mode
];
2046 char buf
[32]; /* hopefully big enough */
2051 error_setg(errp
, "unknown guest suspend mode");
2055 fd
= open(LINUX_SYS_STATE_FILE
, O_RDONLY
);
2060 ret
= read(fd
, buf
, sizeof(buf
) - 1);
2067 if (strstr(buf
, sysfile_str
)) {
2073 static void linux_sys_state_suspend(SuspendMode mode
, Error
**errp
)
2075 Error
*local_err
= NULL
;
2076 const char *sysfile_strs
[3] = {"disk", "mem", NULL
};
2077 const char *sysfile_str
= sysfile_strs
[mode
];
2082 error_setg(errp
, "unknown guest suspend mode");
2092 reopen_fd_to_null(0);
2093 reopen_fd_to_null(1);
2094 reopen_fd_to_null(2);
2096 fd
= open(LINUX_SYS_STATE_FILE
, O_WRONLY
);
2098 _exit(EXIT_FAILURE
);
2101 if (write(fd
, sysfile_str
, strlen(sysfile_str
)) < 0) {
2102 _exit(EXIT_FAILURE
);
2105 _exit(EXIT_SUCCESS
);
2106 } else if (pid
< 0) {
2107 error_setg_errno(errp
, errno
, "failed to create child process");
2111 ga_wait_child(pid
, &status
, &local_err
);
2113 error_propagate(errp
, local_err
);
2117 if (WEXITSTATUS(status
)) {
2118 error_setg(errp
, "child process has failed to suspend");
2123 static void guest_suspend(SuspendMode mode
, Error
**errp
)
2125 Error
*local_err
= NULL
;
2126 bool mode_supported
= false;
2128 if (systemd_supports_mode(mode
, &local_err
)) {
2129 mode_supported
= true;
2130 systemd_suspend(mode
, &local_err
);
2137 error_free(local_err
);
2140 if (pmutils_supports_mode(mode
, &local_err
)) {
2141 mode_supported
= true;
2142 pmutils_suspend(mode
, &local_err
);
2149 error_free(local_err
);
2152 if (linux_sys_state_supports_mode(mode
, &local_err
)) {
2153 mode_supported
= true;
2154 linux_sys_state_suspend(mode
, &local_err
);
2157 if (!mode_supported
) {
2158 error_free(local_err
);
2160 "the requested suspend mode is not supported by the guest");
2162 error_propagate(errp
, local_err
);
2166 void qmp_guest_suspend_disk(Error
**errp
)
2168 guest_suspend(SUSPEND_MODE_DISK
, errp
);
2171 void qmp_guest_suspend_ram(Error
**errp
)
2173 guest_suspend(SUSPEND_MODE_RAM
, errp
);
2176 void qmp_guest_suspend_hybrid(Error
**errp
)
2178 guest_suspend(SUSPEND_MODE_HYBRID
, errp
);
2181 static GuestNetworkInterfaceList
*
2182 guest_find_interface(GuestNetworkInterfaceList
*head
,
2185 for (; head
; head
= head
->next
) {
2186 if (strcmp(head
->value
->name
, name
) == 0) {
2194 static int guest_get_network_stats(const char *name
,
2195 GuestNetworkInterfaceStat
*stats
)
2198 char const *devinfo
= "/proc/net/dev";
2200 char *line
= NULL
, *colon
;
2202 fp
= fopen(devinfo
, "r");
2206 name_len
= strlen(name
);
2207 while (getline(&line
, &n
, fp
) != -1) {
2210 long long rx_packets
;
2212 long long rx_dropped
;
2214 long long tx_packets
;
2216 long long tx_dropped
;
2218 trim_line
= g_strchug(line
);
2219 if (trim_line
[0] == '\0') {
2222 colon
= strchr(trim_line
, ':');
2226 if (colon
- name_len
== trim_line
&&
2227 strncmp(trim_line
, name
, name_len
) == 0) {
2228 if (sscanf(colon
+ 1,
2229 "%lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld %lld",
2230 &rx_bytes
, &rx_packets
, &rx_errs
, &rx_dropped
,
2231 &dummy
, &dummy
, &dummy
, &dummy
,
2232 &tx_bytes
, &tx_packets
, &tx_errs
, &tx_dropped
,
2233 &dummy
, &dummy
, &dummy
, &dummy
) != 16) {
2236 stats
->rx_bytes
= rx_bytes
;
2237 stats
->rx_packets
= rx_packets
;
2238 stats
->rx_errs
= rx_errs
;
2239 stats
->rx_dropped
= rx_dropped
;
2240 stats
->tx_bytes
= tx_bytes
;
2241 stats
->tx_packets
= tx_packets
;
2242 stats
->tx_errs
= tx_errs
;
2243 stats
->tx_dropped
= tx_dropped
;
2251 g_debug("/proc/net/dev: Interface '%s' not found", name
);
2256 * Build information about guest interfaces
2258 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
2260 GuestNetworkInterfaceList
*head
= NULL
, *cur_item
= NULL
;
2261 struct ifaddrs
*ifap
, *ifa
;
2263 if (getifaddrs(&ifap
) < 0) {
2264 error_setg_errno(errp
, errno
, "getifaddrs failed");
2268 for (ifa
= ifap
; ifa
; ifa
= ifa
->ifa_next
) {
2269 GuestNetworkInterfaceList
*info
;
2270 GuestIpAddressList
**address_list
= NULL
, *address_item
= NULL
;
2271 GuestNetworkInterfaceStat
*interface_stat
= NULL
;
2272 char addr4
[INET_ADDRSTRLEN
];
2273 char addr6
[INET6_ADDRSTRLEN
];
2276 unsigned char *mac_addr
;
2279 g_debug("Processing %s interface", ifa
->ifa_name
);
2281 info
= guest_find_interface(head
, ifa
->ifa_name
);
2284 info
= g_malloc0(sizeof(*info
));
2285 info
->value
= g_malloc0(sizeof(*info
->value
));
2286 info
->value
->name
= g_strdup(ifa
->ifa_name
);
2289 head
= cur_item
= info
;
2291 cur_item
->next
= info
;
2296 if (!info
->value
->has_hardware_address
&&
2297 ifa
->ifa_flags
& SIOCGIFHWADDR
) {
2298 /* we haven't obtained HW address yet */
2299 sock
= socket(PF_INET
, SOCK_STREAM
, 0);
2301 error_setg_errno(errp
, errno
, "failed to create socket");
2305 memset(&ifr
, 0, sizeof(ifr
));
2306 pstrcpy(ifr
.ifr_name
, IF_NAMESIZE
, info
->value
->name
);
2307 if (ioctl(sock
, SIOCGIFHWADDR
, &ifr
) == -1) {
2308 error_setg_errno(errp
, errno
,
2309 "failed to get MAC address of %s",
2316 mac_addr
= (unsigned char *) &ifr
.ifr_hwaddr
.sa_data
;
2318 info
->value
->hardware_address
=
2319 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
2320 (int) mac_addr
[0], (int) mac_addr
[1],
2321 (int) mac_addr
[2], (int) mac_addr
[3],
2322 (int) mac_addr
[4], (int) mac_addr
[5]);
2324 info
->value
->has_hardware_address
= true;
2327 if (ifa
->ifa_addr
&&
2328 ifa
->ifa_addr
->sa_family
== AF_INET
) {
2329 /* interface with IPv4 address */
2330 p
= &((struct sockaddr_in
*)ifa
->ifa_addr
)->sin_addr
;
2331 if (!inet_ntop(AF_INET
, p
, addr4
, sizeof(addr4
))) {
2332 error_setg_errno(errp
, errno
, "inet_ntop failed");
2336 address_item
= g_malloc0(sizeof(*address_item
));
2337 address_item
->value
= g_malloc0(sizeof(*address_item
->value
));
2338 address_item
->value
->ip_address
= g_strdup(addr4
);
2339 address_item
->value
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV4
;
2341 if (ifa
->ifa_netmask
) {
2342 /* Count the number of set bits in netmask.
2343 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2344 p
= &((struct sockaddr_in
*)ifa
->ifa_netmask
)->sin_addr
;
2345 address_item
->value
->prefix
= ctpop32(((uint32_t *) p
)[0]);
2347 } else if (ifa
->ifa_addr
&&
2348 ifa
->ifa_addr
->sa_family
== AF_INET6
) {
2349 /* interface with IPv6 address */
2350 p
= &((struct sockaddr_in6
*)ifa
->ifa_addr
)->sin6_addr
;
2351 if (!inet_ntop(AF_INET6
, p
, addr6
, sizeof(addr6
))) {
2352 error_setg_errno(errp
, errno
, "inet_ntop failed");
2356 address_item
= g_malloc0(sizeof(*address_item
));
2357 address_item
->value
= g_malloc0(sizeof(*address_item
->value
));
2358 address_item
->value
->ip_address
= g_strdup(addr6
);
2359 address_item
->value
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV6
;
2361 if (ifa
->ifa_netmask
) {
2362 /* Count the number of set bits in netmask.
2363 * This is safe as '1' and '0' cannot be shuffled in netmask. */
2364 p
= &((struct sockaddr_in6
*)ifa
->ifa_netmask
)->sin6_addr
;
2365 address_item
->value
->prefix
=
2366 ctpop32(((uint32_t *) p
)[0]) +
2367 ctpop32(((uint32_t *) p
)[1]) +
2368 ctpop32(((uint32_t *) p
)[2]) +
2369 ctpop32(((uint32_t *) p
)[3]);
2373 if (!address_item
) {
2377 address_list
= &info
->value
->ip_addresses
;
2379 while (*address_list
&& (*address_list
)->next
) {
2380 address_list
= &(*address_list
)->next
;
2383 if (!*address_list
) {
2384 *address_list
= address_item
;
2386 (*address_list
)->next
= address_item
;
2389 info
->value
->has_ip_addresses
= true;
2391 if (!info
->value
->has_statistics
) {
2392 interface_stat
= g_malloc0(sizeof(*interface_stat
));
2393 if (guest_get_network_stats(info
->value
->name
,
2394 interface_stat
) == -1) {
2395 info
->value
->has_statistics
= false;
2396 g_free(interface_stat
);
2398 info
->value
->statistics
= interface_stat
;
2399 info
->value
->has_statistics
= true;
2409 qapi_free_GuestNetworkInterfaceList(head
);
2413 #define SYSCONF_EXACT(name, errp) sysconf_exact((name), #name, (errp))
2415 static long sysconf_exact(int name
, const char *name_str
, Error
**errp
)
2420 ret
= sysconf(name
);
2423 error_setg(errp
, "sysconf(%s): value indefinite", name_str
);
2425 error_setg_errno(errp
, errno
, "sysconf(%s)", name_str
);
2431 /* Transfer online/offline status between @vcpu and the guest system.
2433 * On input either @errp or *@errp must be NULL.
2435 * In system-to-@vcpu direction, the following @vcpu fields are accessed:
2436 * - R: vcpu->logical_id
2438 * - W: vcpu->can_offline
2440 * In @vcpu-to-system direction, the following @vcpu fields are accessed:
2441 * - R: vcpu->logical_id
2444 * Written members remain unmodified on error.
2446 static void transfer_vcpu(GuestLogicalProcessor
*vcpu
, bool sys2vcpu
,
2447 char *dirpath
, Error
**errp
)
2452 static const char fn
[] = "online";
2454 dirfd
= open(dirpath
, O_RDONLY
| O_DIRECTORY
);
2456 error_setg_errno(errp
, errno
, "open(\"%s\")", dirpath
);
2460 fd
= openat(dirfd
, fn
, sys2vcpu
? O_RDONLY
: O_RDWR
);
2462 if (errno
!= ENOENT
) {
2463 error_setg_errno(errp
, errno
, "open(\"%s/%s\")", dirpath
, fn
);
2464 } else if (sys2vcpu
) {
2465 vcpu
->online
= true;
2466 vcpu
->can_offline
= false;
2467 } else if (!vcpu
->online
) {
2468 error_setg(errp
, "logical processor #%" PRId64
" can't be "
2469 "offlined", vcpu
->logical_id
);
2470 } /* otherwise pretend successful re-onlining */
2472 unsigned char status
;
2474 res
= pread(fd
, &status
, 1, 0);
2476 error_setg_errno(errp
, errno
, "pread(\"%s/%s\")", dirpath
, fn
);
2477 } else if (res
== 0) {
2478 error_setg(errp
, "pread(\"%s/%s\"): unexpected EOF", dirpath
,
2480 } else if (sys2vcpu
) {
2481 vcpu
->online
= (status
!= '0');
2482 vcpu
->can_offline
= true;
2483 } else if (vcpu
->online
!= (status
!= '0')) {
2484 status
= '0' + vcpu
->online
;
2485 if (pwrite(fd
, &status
, 1, 0) == -1) {
2486 error_setg_errno(errp
, errno
, "pwrite(\"%s/%s\")", dirpath
,
2489 } /* otherwise pretend successful re-(on|off)-lining */
2499 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
2502 GuestLogicalProcessorList
*head
, **link
;
2504 Error
*local_err
= NULL
;
2509 sc_max
= SYSCONF_EXACT(_SC_NPROCESSORS_CONF
, &local_err
);
2511 while (local_err
== NULL
&& current
< sc_max
) {
2512 GuestLogicalProcessor
*vcpu
;
2513 GuestLogicalProcessorList
*entry
;
2514 int64_t id
= current
++;
2515 char *path
= g_strdup_printf("/sys/devices/system/cpu/cpu%" PRId64
"/",
2518 if (g_file_test(path
, G_FILE_TEST_EXISTS
)) {
2519 vcpu
= g_malloc0(sizeof *vcpu
);
2520 vcpu
->logical_id
= id
;
2521 vcpu
->has_can_offline
= true; /* lolspeak ftw */
2522 transfer_vcpu(vcpu
, true, path
, &local_err
);
2523 entry
= g_malloc0(sizeof *entry
);
2524 entry
->value
= vcpu
;
2526 link
= &entry
->next
;
2531 if (local_err
== NULL
) {
2532 /* there's no guest with zero VCPUs */
2533 g_assert(head
!= NULL
);
2537 qapi_free_GuestLogicalProcessorList(head
);
2538 error_propagate(errp
, local_err
);
2542 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
2545 Error
*local_err
= NULL
;
2548 while (vcpus
!= NULL
) {
2549 char *path
= g_strdup_printf("/sys/devices/system/cpu/cpu%" PRId64
"/",
2550 vcpus
->value
->logical_id
);
2552 transfer_vcpu(vcpus
->value
, false, path
, &local_err
);
2554 if (local_err
!= NULL
) {
2558 vcpus
= vcpus
->next
;
2561 if (local_err
!= NULL
) {
2562 if (processed
== 0) {
2563 error_propagate(errp
, local_err
);
2565 error_free(local_err
);
2572 void qmp_guest_set_user_password(const char *username
,
2573 const char *password
,
2577 Error
*local_err
= NULL
;
2578 char *passwd_path
= NULL
;
2581 int datafd
[2] = { -1, -1 };
2582 char *rawpasswddata
= NULL
;
2583 size_t rawpasswdlen
;
2584 char *chpasswddata
= NULL
;
2587 rawpasswddata
= (char *)qbase64_decode(password
, -1, &rawpasswdlen
, errp
);
2588 if (!rawpasswddata
) {
2591 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
2592 rawpasswddata
[rawpasswdlen
] = '\0';
2594 if (strchr(rawpasswddata
, '\n')) {
2595 error_setg(errp
, "forbidden characters in raw password");
2599 if (strchr(username
, '\n') ||
2600 strchr(username
, ':')) {
2601 error_setg(errp
, "forbidden characters in username");
2605 chpasswddata
= g_strdup_printf("%s:%s\n", username
, rawpasswddata
);
2606 chpasswdlen
= strlen(chpasswddata
);
2608 passwd_path
= g_find_program_in_path("chpasswd");
2611 error_setg(errp
, "cannot find 'passwd' program in PATH");
2615 if (pipe(datafd
) < 0) {
2616 error_setg(errp
, "cannot create pipe FDs");
2626 reopen_fd_to_null(1);
2627 reopen_fd_to_null(2);
2630 execle(passwd_path
, "chpasswd", "-e", NULL
, environ
);
2632 execle(passwd_path
, "chpasswd", NULL
, environ
);
2634 _exit(EXIT_FAILURE
);
2635 } else if (pid
< 0) {
2636 error_setg_errno(errp
, errno
, "failed to create child process");
2642 if (qemu_write_full(datafd
[1], chpasswddata
, chpasswdlen
) != chpasswdlen
) {
2643 error_setg_errno(errp
, errno
, "cannot write new account password");
2649 ga_wait_child(pid
, &status
, &local_err
);
2651 error_propagate(errp
, local_err
);
2655 if (!WIFEXITED(status
)) {
2656 error_setg(errp
, "child process has terminated abnormally");
2660 if (WEXITSTATUS(status
)) {
2661 error_setg(errp
, "child process has failed to set user password");
2666 g_free(chpasswddata
);
2667 g_free(rawpasswddata
);
2668 g_free(passwd_path
);
2669 if (datafd
[0] != -1) {
2672 if (datafd
[1] != -1) {
2677 static void ga_read_sysfs_file(int dirfd
, const char *pathname
, char *buf
,
2678 int size
, Error
**errp
)
2684 fd
= openat(dirfd
, pathname
, O_RDONLY
);
2686 error_setg_errno(errp
, errno
, "open sysfs file \"%s\"", pathname
);
2690 res
= pread(fd
, buf
, size
, 0);
2692 error_setg_errno(errp
, errno
, "pread sysfs file \"%s\"", pathname
);
2693 } else if (res
== 0) {
2694 error_setg(errp
, "pread sysfs file \"%s\": unexpected EOF", pathname
);
2699 static void ga_write_sysfs_file(int dirfd
, const char *pathname
,
2700 const char *buf
, int size
, Error
**errp
)
2705 fd
= openat(dirfd
, pathname
, O_WRONLY
);
2707 error_setg_errno(errp
, errno
, "open sysfs file \"%s\"", pathname
);
2711 if (pwrite(fd
, buf
, size
, 0) == -1) {
2712 error_setg_errno(errp
, errno
, "pwrite sysfs file \"%s\"", pathname
);
2718 /* Transfer online/offline status between @mem_blk and the guest system.
2720 * On input either @errp or *@errp must be NULL.
2722 * In system-to-@mem_blk direction, the following @mem_blk fields are accessed:
2723 * - R: mem_blk->phys_index
2724 * - W: mem_blk->online
2725 * - W: mem_blk->can_offline
2727 * In @mem_blk-to-system direction, the following @mem_blk fields are accessed:
2728 * - R: mem_blk->phys_index
2729 * - R: mem_blk->online
2730 *- R: mem_blk->can_offline
2731 * Written members remain unmodified on error.
2733 static void transfer_memory_block(GuestMemoryBlock
*mem_blk
, bool sys2memblk
,
2734 GuestMemoryBlockResponse
*result
,
2740 Error
*local_err
= NULL
;
2746 error_setg(errp
, "Internal error, 'result' should not be NULL");
2750 dp
= opendir("/sys/devices/system/memory/");
2751 /* if there is no 'memory' directory in sysfs,
2752 * we think this VM does not support online/offline memory block,
2753 * any other solution?
2756 if (errno
== ENOENT
) {
2758 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED
;
2765 dirpath
= g_strdup_printf("/sys/devices/system/memory/memory%" PRId64
"/",
2766 mem_blk
->phys_index
);
2767 dirfd
= open(dirpath
, O_RDONLY
| O_DIRECTORY
);
2770 error_setg_errno(errp
, errno
, "open(\"%s\")", dirpath
);
2772 if (errno
== ENOENT
) {
2773 result
->response
= GUEST_MEMORY_BLOCK_RESPONSE_TYPE_NOT_FOUND
;
2776 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED
;
2784 status
= g_malloc0(10);
2785 ga_read_sysfs_file(dirfd
, "state", status
, 10, &local_err
);
2787 /* treat with sysfs file that not exist in old kernel */
2788 if (errno
== ENOENT
) {
2789 error_free(local_err
);
2791 mem_blk
->online
= true;
2792 mem_blk
->can_offline
= false;
2793 } else if (!mem_blk
->online
) {
2795 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_NOT_SUPPORTED
;
2799 error_propagate(errp
, local_err
);
2801 error_free(local_err
);
2803 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED
;
2810 char removable
= '0';
2812 mem_blk
->online
= (strncmp(status
, "online", 6) == 0);
2814 ga_read_sysfs_file(dirfd
, "removable", &removable
, 1, &local_err
);
2816 /* if no 'removable' file, it doesn't support offline mem blk */
2817 if (errno
== ENOENT
) {
2818 error_free(local_err
);
2819 mem_blk
->can_offline
= false;
2821 error_propagate(errp
, local_err
);
2824 mem_blk
->can_offline
= (removable
!= '0');
2827 if (mem_blk
->online
!= (strncmp(status
, "online", 6) == 0)) {
2828 const char *new_state
= mem_blk
->online
? "online" : "offline";
2830 ga_write_sysfs_file(dirfd
, "state", new_state
, strlen(new_state
),
2833 error_free(local_err
);
2835 GUEST_MEMORY_BLOCK_RESPONSE_TYPE_OPERATION_FAILED
;
2839 result
->response
= GUEST_MEMORY_BLOCK_RESPONSE_TYPE_SUCCESS
;
2840 result
->has_error_code
= false;
2841 } /* otherwise pretend successful re-(on|off)-lining */
2852 result
->has_error_code
= true;
2853 result
->error_code
= errno
;
2857 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
2859 GuestMemoryBlockList
*head
, **link
;
2860 Error
*local_err
= NULL
;
2867 dp
= opendir("/sys/devices/system/memory/");
2869 /* it's ok if this happens to be a system that doesn't expose
2870 * memory blocks via sysfs, but otherwise we should report
2873 if (errno
!= ENOENT
) {
2874 error_setg_errno(errp
, errno
, "Can't open directory"
2875 "\"/sys/devices/system/memory/\"");
2880 /* Note: the phys_index of memory block may be discontinuous,
2881 * this is because a memblk is the unit of the Sparse Memory design, which
2882 * allows discontinuous memory ranges (ex. NUMA), so here we should
2883 * traverse the memory block directory.
2885 while ((de
= readdir(dp
)) != NULL
) {
2886 GuestMemoryBlock
*mem_blk
;
2887 GuestMemoryBlockList
*entry
;
2889 if ((strncmp(de
->d_name
, "memory", 6) != 0) ||
2890 !(de
->d_type
& DT_DIR
)) {
2894 mem_blk
= g_malloc0(sizeof *mem_blk
);
2895 /* The d_name is "memoryXXX", phys_index is block id, same as XXX */
2896 mem_blk
->phys_index
= strtoul(&de
->d_name
[6], NULL
, 10);
2897 mem_blk
->has_can_offline
= true; /* lolspeak ftw */
2898 transfer_memory_block(mem_blk
, true, NULL
, &local_err
);
2903 entry
= g_malloc0(sizeof *entry
);
2904 entry
->value
= mem_blk
;
2907 link
= &entry
->next
;
2911 if (local_err
== NULL
) {
2912 /* there's no guest with zero memory blocks */
2914 error_setg(errp
, "guest reported zero memory blocks!");
2919 qapi_free_GuestMemoryBlockList(head
);
2920 error_propagate(errp
, local_err
);
2924 GuestMemoryBlockResponseList
*
2925 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
2927 GuestMemoryBlockResponseList
*head
, **link
;
2928 Error
*local_err
= NULL
;
2933 while (mem_blks
!= NULL
) {
2934 GuestMemoryBlockResponse
*result
;
2935 GuestMemoryBlockResponseList
*entry
;
2936 GuestMemoryBlock
*current_mem_blk
= mem_blks
->value
;
2938 result
= g_malloc0(sizeof(*result
));
2939 result
->phys_index
= current_mem_blk
->phys_index
;
2940 transfer_memory_block(current_mem_blk
, false, result
, &local_err
);
2941 if (local_err
) { /* should never happen */
2944 entry
= g_malloc0(sizeof *entry
);
2945 entry
->value
= result
;
2948 link
= &entry
->next
;
2949 mem_blks
= mem_blks
->next
;
2954 qapi_free_GuestMemoryBlockResponseList(head
);
2955 error_propagate(errp
, local_err
);
2959 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
2961 Error
*local_err
= NULL
;
2965 GuestMemoryBlockInfo
*info
;
2967 dirpath
= g_strdup_printf("/sys/devices/system/memory/");
2968 dirfd
= open(dirpath
, O_RDONLY
| O_DIRECTORY
);
2970 error_setg_errno(errp
, errno
, "open(\"%s\")", dirpath
);
2976 buf
= g_malloc0(20);
2977 ga_read_sysfs_file(dirfd
, "block_size_bytes", buf
, 20, &local_err
);
2981 error_propagate(errp
, local_err
);
2985 info
= g_new0(GuestMemoryBlockInfo
, 1);
2986 info
->size
= strtol(buf
, NULL
, 16); /* the unit is bytes */
2993 #else /* defined(__linux__) */
2995 void qmp_guest_suspend_disk(Error
**errp
)
2997 error_setg(errp
, QERR_UNSUPPORTED
);
3000 void qmp_guest_suspend_ram(Error
**errp
)
3002 error_setg(errp
, QERR_UNSUPPORTED
);
3005 void qmp_guest_suspend_hybrid(Error
**errp
)
3007 error_setg(errp
, QERR_UNSUPPORTED
);
3010 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
3012 error_setg(errp
, QERR_UNSUPPORTED
);
3016 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
3018 error_setg(errp
, QERR_UNSUPPORTED
);
3022 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
3024 error_setg(errp
, QERR_UNSUPPORTED
);
3028 void qmp_guest_set_user_password(const char *username
,
3029 const char *password
,
3033 error_setg(errp
, QERR_UNSUPPORTED
);
3036 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
3038 error_setg(errp
, QERR_UNSUPPORTED
);
3042 GuestMemoryBlockResponseList
*
3043 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
3045 error_setg(errp
, QERR_UNSUPPORTED
);
3049 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
3051 error_setg(errp
, QERR_UNSUPPORTED
);
3057 #if !defined(CONFIG_FSFREEZE)
3059 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
3061 error_setg(errp
, QERR_UNSUPPORTED
);
3065 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
3067 error_setg(errp
, QERR_UNSUPPORTED
);
3072 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
3074 error_setg(errp
, QERR_UNSUPPORTED
);
3079 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
3080 strList
*mountpoints
,
3083 error_setg(errp
, QERR_UNSUPPORTED
);
3088 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
3090 error_setg(errp
, QERR_UNSUPPORTED
);
3095 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
3097 error_setg(errp
, QERR_UNSUPPORTED
);
3101 #endif /* CONFIG_FSFREEZE */
3103 #if !defined(CONFIG_FSTRIM)
3104 GuestFilesystemTrimResponse
*
3105 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
3107 error_setg(errp
, QERR_UNSUPPORTED
);
3112 /* add unsupported commands to the blacklist */
3113 GList
*ga_command_blacklist_init(GList
*blacklist
)
3115 #if !defined(__linux__)
3117 const char *list
[] = {
3118 "guest-suspend-disk", "guest-suspend-ram",
3119 "guest-suspend-hybrid", "guest-network-get-interfaces",
3120 "guest-get-vcpus", "guest-set-vcpus",
3121 "guest-get-memory-blocks", "guest-set-memory-blocks",
3122 "guest-get-memory-block-size", "guest-get-memory-block-info",
3124 char **p
= (char **)list
;
3127 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
3132 #if !defined(CONFIG_FSFREEZE)
3134 const char *list
[] = {
3135 "guest-get-fsinfo", "guest-fsfreeze-status",
3136 "guest-fsfreeze-freeze", "guest-fsfreeze-freeze-list",
3137 "guest-fsfreeze-thaw", "guest-get-fsinfo",
3138 "guest-get-disks", NULL
};
3139 char **p
= (char **)list
;
3142 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
3147 #if !defined(CONFIG_FSTRIM)
3148 blacklist
= g_list_append(blacklist
, g_strdup("guest-fstrim"));
3151 blacklist
= g_list_append(blacklist
, g_strdup("guest-get-devices"));
3156 /* register init/cleanup routines for stateful command groups */
3157 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
3159 #if defined(CONFIG_FSFREEZE)
3160 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);
3166 #define QGA_MICRO_SECOND_TO_SECOND 1000000
3168 static double ga_get_login_time(struct utmpx
*user_info
)
3170 double seconds
= (double)user_info
->ut_tv
.tv_sec
;
3171 double useconds
= (double)user_info
->ut_tv
.tv_usec
;
3172 useconds
/= QGA_MICRO_SECOND_TO_SECOND
;
3173 return seconds
+ useconds
;
3176 GuestUserList
*qmp_guest_get_users(Error
**errp
)
3178 GHashTable
*cache
= NULL
;
3179 GuestUserList
*head
= NULL
, *cur_item
= NULL
;
3180 struct utmpx
*user_info
= NULL
;
3181 gpointer value
= NULL
;
3182 GuestUser
*user
= NULL
;
3183 GuestUserList
*item
= NULL
;
3184 double login_time
= 0;
3186 cache
= g_hash_table_new(g_str_hash
, g_str_equal
);
3190 user_info
= getutxent();
3191 if (user_info
== NULL
) {
3193 } else if (user_info
->ut_type
!= USER_PROCESS
) {
3195 } else if (g_hash_table_contains(cache
, user_info
->ut_user
)) {
3196 value
= g_hash_table_lookup(cache
, user_info
->ut_user
);
3197 user
= (GuestUser
*)value
;
3198 login_time
= ga_get_login_time(user_info
);
3199 /* We're ensuring the earliest login time to be sent */
3200 if (login_time
< user
->login_time
) {
3201 user
->login_time
= login_time
;
3206 item
= g_new0(GuestUserList
, 1);
3207 item
->value
= g_new0(GuestUser
, 1);
3208 item
->value
->user
= g_strdup(user_info
->ut_user
);
3209 item
->value
->login_time
= ga_get_login_time(user_info
);
3211 g_hash_table_insert(cache
, item
->value
->user
, item
->value
);
3214 head
= cur_item
= item
;
3216 cur_item
->next
= item
;
3221 g_hash_table_destroy(cache
);
3227 GuestUserList
*qmp_guest_get_users(Error
**errp
)
3229 error_setg(errp
, QERR_UNSUPPORTED
);
3235 /* Replace escaped special characters with theire real values. The replacement
3236 * is done in place -- returned value is in the original string.
3238 static void ga_osrelease_replace_special(gchar
*value
)
3240 gchar
*p
, *p2
, quote
;
3242 /* Trim the string at first space or semicolon if it is not enclosed in
3243 * single or double quotes. */
3244 if ((value
[0] != '"') || (value
[0] == '\'')) {
3245 p
= strchr(value
, ' ');
3249 p
= strchr(value
, ';');
3270 /* Keep literal backslash followed by whatever is there */
3274 } else if (*p
== quote
) {
3282 static GKeyFile
*ga_parse_osrelease(const char *fname
)
3284 gchar
*content
= NULL
;
3285 gchar
*content2
= NULL
;
3287 GKeyFile
*keys
= g_key_file_new();
3288 const char *group
= "[os-release]\n";
3290 if (!g_file_get_contents(fname
, &content
, NULL
, &err
)) {
3291 slog("failed to read '%s', error: %s", fname
, err
->message
);
3295 if (!g_utf8_validate(content
, -1, NULL
)) {
3296 slog("file is not utf-8 encoded: %s", fname
);
3299 content2
= g_strdup_printf("%s%s", group
, content
);
3301 if (!g_key_file_load_from_data(keys
, content2
, -1, G_KEY_FILE_NONE
,
3303 slog("failed to parse file '%s', error: %s", fname
, err
->message
);
3315 g_key_file_free(keys
);
3319 GuestOSInfo
*qmp_guest_get_osinfo(Error
**errp
)
3321 GuestOSInfo
*info
= NULL
;
3322 struct utsname kinfo
;
3323 GKeyFile
*osrelease
= NULL
;
3324 const char *qga_os_release
= g_getenv("QGA_OS_RELEASE");
3326 info
= g_new0(GuestOSInfo
, 1);
3328 if (uname(&kinfo
) != 0) {
3329 error_setg_errno(errp
, errno
, "uname failed");
3331 info
->has_kernel_version
= true;
3332 info
->kernel_version
= g_strdup(kinfo
.version
);
3333 info
->has_kernel_release
= true;
3334 info
->kernel_release
= g_strdup(kinfo
.release
);
3335 info
->has_machine
= true;
3336 info
->machine
= g_strdup(kinfo
.machine
);
3339 if (qga_os_release
!= NULL
) {
3340 osrelease
= ga_parse_osrelease(qga_os_release
);
3342 osrelease
= ga_parse_osrelease("/etc/os-release");
3343 if (osrelease
== NULL
) {
3344 osrelease
= ga_parse_osrelease("/usr/lib/os-release");
3348 if (osrelease
!= NULL
) {
3351 #define GET_FIELD(field, osfield) do { \
3352 value = g_key_file_get_value(osrelease, "os-release", osfield, NULL); \
3353 if (value != NULL) { \
3354 ga_osrelease_replace_special(value); \
3355 info->has_ ## field = true; \
3356 info->field = value; \
3359 GET_FIELD(id
, "ID");
3360 GET_FIELD(name
, "NAME");
3361 GET_FIELD(pretty_name
, "PRETTY_NAME");
3362 GET_FIELD(version
, "VERSION");
3363 GET_FIELD(version_id
, "VERSION_ID");
3364 GET_FIELD(variant
, "VARIANT");
3365 GET_FIELD(variant_id
, "VARIANT_ID");
3368 g_key_file_free(osrelease
);
3374 GuestDeviceInfoList
*qmp_guest_get_devices(Error
**errp
)
3376 error_setg(errp
, QERR_UNSUPPORTED
);