2 * QEMU Guest Agent win32-specific command implementations
4 * Copyright IBM Corp. 2012
7 * Michael Roth <mdroth@linux.vnet.ibm.com>
8 * Gal Hammer <ghammer@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.
15 # define _WIN32_WINNT 0x0600
18 #include "qemu/osdep.h"
25 #ifdef CONFIG_QGA_NTDDSCSI
35 #include "guest-agent-core.h"
36 #include "vss-win32.h"
37 #include "qga-qapi-commands.h"
38 #include "qapi/error.h"
39 #include "qapi/qmp/qerror.h"
40 #include "qemu/queue.h"
41 #include "qemu/host-utils.h"
42 #include "qemu/base64.h"
44 #ifndef SHTDN_REASON_FLAG_PLANNED
45 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
48 /* multiple of 100 nanoseconds elapsed between windows baseline
49 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
50 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
51 (365 * (1970 - 1601) + \
52 (1970 - 1601) / 4 - 3))
54 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
56 typedef struct GuestFileHandle
{
59 QTAILQ_ENTRY(GuestFileHandle
) next
;
63 QTAILQ_HEAD(, GuestFileHandle
) filehandles
;
64 } guest_file_state
= {
65 .filehandles
= QTAILQ_HEAD_INITIALIZER(guest_file_state
.filehandles
),
68 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
70 typedef struct OpenFlags
{
73 DWORD creation_disposition
;
75 static OpenFlags guest_file_open_modes
[] = {
76 {"r", GENERIC_READ
, OPEN_EXISTING
},
77 {"rb", GENERIC_READ
, OPEN_EXISTING
},
78 {"w", GENERIC_WRITE
, CREATE_ALWAYS
},
79 {"wb", GENERIC_WRITE
, CREATE_ALWAYS
},
80 {"a", FILE_GENERIC_APPEND
, OPEN_ALWAYS
},
81 {"r+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
82 {"rb+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
83 {"r+b", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
84 {"w+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
85 {"wb+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
86 {"w+b", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
87 {"a+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
88 {"ab+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
89 {"a+b", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
}
92 #define debug_error(msg) do { \
93 char *suffix = g_win32_error_message(GetLastError()); \
94 g_debug("%s: %s", (msg), suffix); \
98 static OpenFlags
*find_open_flag(const char *mode_str
)
103 for (mode
= 0; mode
< ARRAY_SIZE(guest_file_open_modes
); ++mode
) {
104 OpenFlags
*flags
= guest_file_open_modes
+ mode
;
106 if (strcmp(flags
->forms
, mode_str
) == 0) {
111 error_setg(errp
, "invalid file open mode '%s'", mode_str
);
115 static int64_t guest_file_handle_add(HANDLE fh
, Error
**errp
)
117 GuestFileHandle
*gfh
;
120 handle
= ga_get_fd_handle(ga_state
, errp
);
124 gfh
= g_new0(GuestFileHandle
, 1);
127 QTAILQ_INSERT_TAIL(&guest_file_state
.filehandles
, gfh
, next
);
132 static GuestFileHandle
*guest_file_handle_find(int64_t id
, Error
**errp
)
134 GuestFileHandle
*gfh
;
135 QTAILQ_FOREACH(gfh
, &guest_file_state
.filehandles
, next
) {
140 error_setg(errp
, "handle '%" PRId64
"' has not been found", id
);
144 static void handle_set_nonblocking(HANDLE fh
)
146 DWORD file_type
, pipe_state
;
147 file_type
= GetFileType(fh
);
148 if (file_type
!= FILE_TYPE_PIPE
) {
151 /* If file_type == FILE_TYPE_PIPE, according to MSDN
152 * the specified file is socket or named pipe */
153 if (!GetNamedPipeHandleState(fh
, &pipe_state
, NULL
,
154 NULL
, NULL
, NULL
, 0)) {
157 /* The fd is named pipe fd */
158 if (pipe_state
& PIPE_NOWAIT
) {
162 pipe_state
|= PIPE_NOWAIT
;
163 SetNamedPipeHandleState(fh
, &pipe_state
, NULL
, NULL
);
166 int64_t qmp_guest_file_open(const char *path
, bool has_mode
,
167 const char *mode
, Error
**errp
)
171 HANDLE templ_file
= NULL
;
172 DWORD share_mode
= FILE_SHARE_READ
;
173 DWORD flags_and_attr
= FILE_ATTRIBUTE_NORMAL
;
174 LPSECURITY_ATTRIBUTES sa_attr
= NULL
;
175 OpenFlags
*guest_flags
;
177 wchar_t *w_path
= NULL
;
182 slog("guest-file-open called, filepath: %s, mode: %s", path
, mode
);
183 guest_flags
= find_open_flag(mode
);
184 if (guest_flags
== NULL
) {
185 error_setg(errp
, "invalid file open mode");
189 w_path
= g_utf8_to_utf16(path
, -1, NULL
, NULL
, &gerr
);
194 fh
= CreateFileW(w_path
, guest_flags
->desired_access
, share_mode
, sa_attr
,
195 guest_flags
->creation_disposition
, flags_and_attr
,
197 if (fh
== INVALID_HANDLE_VALUE
) {
198 error_setg_win32(errp
, GetLastError(), "failed to open file '%s'",
203 /* set fd non-blocking to avoid common use cases (like reading from a
204 * named pipe) from hanging the agent
206 handle_set_nonblocking(fh
);
208 fd
= guest_file_handle_add(fh
, errp
);
211 error_setg(errp
, "failed to add handle to qmp handle table");
215 slog("guest-file-open, handle: % " PRId64
, fd
);
219 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
226 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
229 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
230 slog("guest-file-close called, handle: %" PRId64
, handle
);
234 ret
= CloseHandle(gfh
->fh
);
236 error_setg_win32(errp
, GetLastError(), "failed close handle");
240 QTAILQ_REMOVE(&guest_file_state
.filehandles
, gfh
, next
);
244 static void acquire_privilege(const char *name
, Error
**errp
)
247 TOKEN_PRIVILEGES priv
;
248 Error
*local_err
= NULL
;
250 if (OpenProcessToken(GetCurrentProcess(),
251 TOKEN_ADJUST_PRIVILEGES
|TOKEN_QUERY
, &token
))
253 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
254 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
255 "no luid for requested privilege");
259 priv
.PrivilegeCount
= 1;
260 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
262 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
263 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
264 "unable to acquire requested privilege");
269 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
270 "failed to open privilege token");
277 error_propagate(errp
, local_err
);
280 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
283 Error
*local_err
= NULL
;
285 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
287 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
288 "failed to dispatch asynchronous command");
289 error_propagate(errp
, local_err
);
293 void qmp_guest_shutdown(bool has_mode
, const char *mode
, Error
**errp
)
295 Error
*local_err
= NULL
;
296 UINT shutdown_flag
= EWX_FORCE
;
298 slog("guest-shutdown called, mode: %s", mode
);
300 if (!has_mode
|| strcmp(mode
, "powerdown") == 0) {
301 shutdown_flag
|= EWX_POWEROFF
;
302 } else if (strcmp(mode
, "halt") == 0) {
303 shutdown_flag
|= EWX_SHUTDOWN
;
304 } else if (strcmp(mode
, "reboot") == 0) {
305 shutdown_flag
|= EWX_REBOOT
;
307 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
308 "halt|powerdown|reboot");
312 /* Request a shutdown privilege, but try to shut down the system
314 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
316 error_propagate(errp
, local_err
);
320 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
321 slog("guest-shutdown failed: %lu", GetLastError());
322 error_setg(errp
, QERR_UNDEFINED_ERROR
);
326 GuestFileRead
*qmp_guest_file_read(int64_t handle
, bool has_count
,
327 int64_t count
, Error
**errp
)
329 GuestFileRead
*read_data
= NULL
;
334 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
340 count
= QGA_READ_COUNT_DEFAULT
;
341 } else if (count
< 0 || count
>= UINT32_MAX
) {
342 error_setg(errp
, "value '%" PRId64
343 "' is invalid for argument count", count
);
348 buf
= g_malloc0(count
+1);
349 is_ok
= ReadFile(fh
, buf
, count
, &read_count
, NULL
);
351 error_setg_win32(errp
, GetLastError(), "failed to read file");
352 slog("guest-file-read failed, handle %" PRId64
, handle
);
355 read_data
= g_new0(GuestFileRead
, 1);
356 read_data
->count
= (size_t)read_count
;
357 read_data
->eof
= read_count
== 0;
359 if (read_count
!= 0) {
360 read_data
->buf_b64
= g_base64_encode(buf
, read_count
);
368 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
369 bool has_count
, int64_t count
,
372 GuestFileWrite
*write_data
= NULL
;
377 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
384 buf
= qbase64_decode(buf_b64
, -1, &buf_len
, errp
);
391 } else if (count
< 0 || count
> buf_len
) {
392 error_setg(errp
, "value '%" PRId64
393 "' is invalid for argument count", count
);
397 is_ok
= WriteFile(fh
, buf
, count
, &write_count
, NULL
);
399 error_setg_win32(errp
, GetLastError(), "failed to write to file");
400 slog("guest-file-write-failed, handle: %" PRId64
, handle
);
402 write_data
= g_new0(GuestFileWrite
, 1);
403 write_data
->count
= (size_t) write_count
;
411 GuestFileSeek
*qmp_guest_file_seek(int64_t handle
, int64_t offset
,
412 GuestFileWhence
*whence_code
,
415 GuestFileHandle
*gfh
;
416 GuestFileSeek
*seek_data
;
418 LARGE_INTEGER new_pos
, off_pos
;
419 off_pos
.QuadPart
= offset
;
424 gfh
= guest_file_handle_find(handle
, errp
);
429 /* We stupidly exposed 'whence':'int' in our qapi */
430 whence
= ga_parse_whence(whence_code
, &err
);
432 error_propagate(errp
, err
);
437 res
= SetFilePointerEx(fh
, off_pos
, &new_pos
, whence
);
439 error_setg_win32(errp
, GetLastError(), "failed to seek file");
442 seek_data
= g_new0(GuestFileSeek
, 1);
443 seek_data
->position
= new_pos
.QuadPart
;
447 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
450 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
456 if (!FlushFileBuffers(fh
)) {
457 error_setg_win32(errp
, GetLastError(), "failed to flush file");
461 #ifdef CONFIG_QGA_NTDDSCSI
463 static STORAGE_BUS_TYPE win2qemu
[] = {
464 [BusTypeUnknown
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
465 [BusTypeScsi
] = GUEST_DISK_BUS_TYPE_SCSI
,
466 [BusTypeAtapi
] = GUEST_DISK_BUS_TYPE_IDE
,
467 [BusTypeAta
] = GUEST_DISK_BUS_TYPE_IDE
,
468 [BusType1394
] = GUEST_DISK_BUS_TYPE_IEEE1394
,
469 [BusTypeSsa
] = GUEST_DISK_BUS_TYPE_SSA
,
470 [BusTypeFibre
] = GUEST_DISK_BUS_TYPE_SSA
,
471 [BusTypeUsb
] = GUEST_DISK_BUS_TYPE_USB
,
472 [BusTypeRAID
] = GUEST_DISK_BUS_TYPE_RAID
,
473 #if (_WIN32_WINNT >= 0x0600)
474 [BusTypeiScsi
] = GUEST_DISK_BUS_TYPE_ISCSI
,
475 [BusTypeSas
] = GUEST_DISK_BUS_TYPE_SAS
,
476 [BusTypeSata
] = GUEST_DISK_BUS_TYPE_SATA
,
477 [BusTypeSd
] = GUEST_DISK_BUS_TYPE_SD
,
478 [BusTypeMmc
] = GUEST_DISK_BUS_TYPE_MMC
,
480 #if (_WIN32_WINNT >= 0x0601)
481 [BusTypeVirtual
] = GUEST_DISK_BUS_TYPE_VIRTUAL
,
482 [BusTypeFileBackedVirtual
] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL
,
486 static GuestDiskBusType
find_bus_type(STORAGE_BUS_TYPE bus
)
488 if (bus
>= ARRAY_SIZE(win2qemu
) || (int)bus
< 0) {
489 return GUEST_DISK_BUS_TYPE_UNKNOWN
;
491 return win2qemu
[(int)bus
];
494 /* XXX: The following function is BROKEN!
496 * It does not work and probably has never worked. When we query for list of
497 * disks we get cryptic names like "\Device\0000001d" instead of
498 * "\PhysicalDriveX" or "\HarddiskX". Whether the names can be translated one
499 * way or the other for comparison is an open question.
501 * When we query volume names (the original version) we are able to match those
502 * but then the property queries report error "Invalid function". (duh!)
506 DEFINE_GUID(GUID_DEVINTERFACE_VOLUME,
507 0x53f5630dL, 0xb6bf, 0x11d0, 0x94, 0xf2,
508 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
510 DEFINE_GUID(GUID_DEVINTERFACE_DISK
,
511 0x53f56307L
, 0xb6bf, 0x11d0, 0x94, 0xf2,
512 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
515 static GuestPCIAddress
*get_pci_info(char *guid
, Error
**errp
)
518 SP_DEVINFO_DATA dev_info_data
;
521 char dev_name
[MAX_PATH
];
523 GuestPCIAddress
*pci
= NULL
;
525 bool partial_pci
= false;
526 pci
= g_malloc0(sizeof(*pci
));
532 if (g_str_has_prefix(guid
, "\\\\.\\") ||
533 g_str_has_prefix(guid
, "\\\\?\\")) {
534 name
= g_strdup(guid
+ 4);
536 name
= g_strdup(guid
);
539 if (!QueryDosDevice(name
, dev_name
, ARRAY_SIZE(dev_name
))) {
540 error_setg_win32(errp
, GetLastError(), "failed to get dos device name");
544 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
545 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
546 if (dev_info
== INVALID_HANDLE_VALUE
) {
547 error_setg_win32(errp
, GetLastError(), "failed to get devices tree");
551 g_debug("enumerating devices");
552 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
553 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
554 DWORD addr
, bus
, slot
, data
, size2
;
556 while (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
557 SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
,
558 &data
, (PBYTE
)buffer
, size
,
560 size
= MAX(size
, size2
);
561 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
563 /* Double the size to avoid problems on
564 * W2k MBCS systems per KB 888609.
565 * https://support.microsoft.com/en-us/kb/259695 */
566 buffer
= g_malloc(size
* 2);
568 error_setg_win32(errp
, GetLastError(),
569 "failed to get device name");
574 if (g_strcmp0(buffer
, dev_name
)) {
577 g_debug("found device %s", dev_name
);
579 /* There is no need to allocate buffer in the next functions. The size
580 * is known and ULONG according to
581 * https://support.microsoft.com/en-us/kb/253232
582 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
584 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
585 SPDRP_BUSNUMBER
, &data
, (PBYTE
)&bus
, size
, NULL
)) {
586 debug_error("failed to get bus");
591 /* The function retrieves the device's address. This value will be
592 * transformed into device function and number */
593 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
594 SPDRP_ADDRESS
, &data
, (PBYTE
)&addr
, size
, NULL
)) {
595 debug_error("failed to get address");
600 /* This call returns UINumber of DEVICE_CAPABILITIES structure.
601 * This number is typically a user-perceived slot number. */
602 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
603 SPDRP_UI_NUMBER
, &data
, (PBYTE
)&slot
, size
, NULL
)) {
604 debug_error("failed to get slot");
609 /* SetupApi gives us the same information as driver with
610 * IoGetDeviceProperty. According to Microsoft
611 * https://support.microsoft.com/en-us/kb/253232
612 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF);
613 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF);
614 * SPDRP_ADDRESS is propertyAddress, so we do the same.*/
622 func
= ((int) addr
== -1) ? -1 : addr
& 0x0000FFFF;
623 dev
= ((int) addr
== -1) ? -1 : (addr
>> 16) & 0x0000FFFF;
625 pci
->slot
= (int) slot
;
626 pci
->function
= func
;
627 pci
->bus
= (int) bus
;
633 SetupDiDestroyDeviceInfoList(dev_info
);
640 static void get_disk_properties(HANDLE vol_h
, GuestDiskAddress
*disk
,
643 STORAGE_PROPERTY_QUERY query
;
644 STORAGE_DEVICE_DESCRIPTOR
*dev_desc
, buf
;
646 ULONG size
= sizeof(buf
);
649 query
.PropertyId
= StorageDeviceProperty
;
650 query
.QueryType
= PropertyStandardQuery
;
652 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
653 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
654 size
, &received
, NULL
)) {
655 error_setg_win32(errp
, GetLastError(), "failed to get bus type");
658 disk
->bus_type
= find_bus_type(dev_desc
->BusType
);
659 g_debug("bus type %d", disk
->bus_type
);
661 /* Query once more. Now with long enough buffer. */
662 size
= dev_desc
->Size
;
663 dev_desc
= g_malloc0(size
);
664 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
665 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
666 size
, &received
, NULL
)) {
667 error_setg_win32(errp
, GetLastError(), "failed to get serial number");
668 g_debug("failed to get serial number");
671 if (dev_desc
->SerialNumberOffset
> 0) {
675 if (dev_desc
->SerialNumberOffset
>= received
) {
676 error_setg(errp
, "failed to get serial number: offset outside the buffer");
677 g_debug("serial number offset outside the buffer");
680 serial
= (char *)dev_desc
+ dev_desc
->SerialNumberOffset
;
681 len
= received
- dev_desc
->SerialNumberOffset
;
682 g_debug("serial number \"%s\"", serial
);
684 disk
->serial
= g_strndup(serial
, len
);
685 disk
->has_serial
= true;
694 static void get_single_disk_info(GuestDiskAddress
*disk
, Error
**errp
)
696 SCSI_ADDRESS addr
, *scsi_ad
;
699 Error
*local_err
= NULL
;
703 g_debug("getting disk info for: %s", disk
->dev
);
704 disk_h
= CreateFile(disk
->dev
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
706 if (disk_h
== INVALID_HANDLE_VALUE
) {
707 error_setg_win32(errp
, GetLastError(), "failed to open disk");
711 get_disk_properties(disk_h
, disk
, &local_err
);
713 error_propagate(errp
, local_err
);
717 g_debug("bus type %d", disk
->bus_type
);
718 /* always set pci_controller as required by schema. get_pci_info() should
719 * report -1 values for non-PCI buses rather than fail. fail the command
720 * if that doesn't hold since that suggests some other unexpected
723 disk
->pci_controller
= get_pci_info(disk
->dev
, &local_err
);
725 error_propagate(errp
, local_err
);
728 if (disk
->bus_type
== GUEST_DISK_BUS_TYPE_SCSI
729 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_IDE
730 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_RAID
731 #if (_WIN32_WINNT >= 0x0600)
732 /* This bus type is not supported before Windows Server 2003 SP1 */
733 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_SAS
736 /* We are able to use the same ioctls for different bus types
737 * according to Microsoft docs
738 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
739 g_debug("getting pci-controller info");
740 if (DeviceIoControl(disk_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
741 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
742 disk
->unit
= addr
.Lun
;
743 disk
->target
= addr
.TargetId
;
744 disk
->bus
= addr
.PathId
;
746 /* We do not set error in this case, because we still have enough
747 * information about volume. */
755 /* VSS provider works with volumes, thus there is no difference if
756 * the volume consist of spanned disks. Info about the first disk in the
757 * volume is returned for the spanned disk group (LVM) */
758 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
760 Error
*local_err
= NULL
;
761 GuestDiskAddressList
*list
= NULL
, *cur_item
= NULL
;
762 GuestDiskAddress
*disk
= NULL
;
766 PVOLUME_DISK_EXTENTS extents
= NULL
;
768 /* strip final backslash */
769 char *name
= g_strdup(guid
);
770 if (g_str_has_suffix(name
, "\\")) {
771 name
[strlen(name
) - 1] = 0;
774 g_debug("opening %s", name
);
775 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
777 if (vol_h
== INVALID_HANDLE_VALUE
) {
778 error_setg_win32(errp
, GetLastError(), "failed to open volume");
782 /* Get list of extents */
783 g_debug("getting disk extents");
784 size
= sizeof(VOLUME_DISK_EXTENTS
);
785 extents
= g_malloc0(size
);
786 if (!DeviceIoControl(vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
787 0, extents
, size
, NULL
, NULL
)) {
788 DWORD last_err
= GetLastError();
789 if (last_err
== ERROR_MORE_DATA
) {
790 /* Try once more with big enough buffer */
791 size
= sizeof(VOLUME_DISK_EXTENTS
)
792 + extents
->NumberOfDiskExtents
*sizeof(DISK_EXTENT
);
794 extents
= g_malloc0(size
);
795 if (!DeviceIoControl(
796 vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
797 0, extents
, size
, NULL
, NULL
)) {
798 error_setg_win32(errp
, GetLastError(),
799 "failed to get disk extents");
802 } else if (last_err
== ERROR_INVALID_FUNCTION
) {
803 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
804 g_debug("volume not on disk");
805 disk
= g_malloc0(sizeof(GuestDiskAddress
));
806 disk
->has_dev
= true;
807 disk
->dev
= g_strdup(name
);
808 get_single_disk_info(disk
, &local_err
);
810 g_debug("failed to get disk info, ignoring error: %s",
811 error_get_pretty(local_err
));
812 error_free(local_err
);
815 list
= g_malloc0(sizeof(*list
));
821 error_setg_win32(errp
, GetLastError(),
822 "failed to get disk extents");
826 g_debug("Number of extents: %lu", extents
->NumberOfDiskExtents
);
828 /* Go through each extent */
829 for (i
= 0; i
< extents
->NumberOfDiskExtents
; i
++) {
830 disk
= g_malloc0(sizeof(GuestDiskAddress
));
832 /* Disk numbers directly correspond to numbers used in UNCs
834 * See documentation for DISK_EXTENT:
835 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
837 * See also Naming Files, Paths and Namespaces:
838 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
840 disk
->has_dev
= true;
841 disk
->dev
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
842 extents
->Extents
[i
].DiskNumber
);
844 get_single_disk_info(disk
, &local_err
);
846 error_propagate(errp
, local_err
);
849 cur_item
= g_malloc0(sizeof(*list
));
850 cur_item
->value
= disk
;
852 cur_item
->next
= list
;
858 if (vol_h
!= INVALID_HANDLE_VALUE
) {
861 qapi_free_GuestDiskAddress(disk
);
870 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
875 #endif /* CONFIG_QGA_NTDDSCSI */
877 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
880 char mnt
, *mnt_point
;
882 char vol_info
[MAX_PATH
+1];
884 uint64_t i64FreeBytesToCaller
, i64TotalBytes
, i64FreeBytes
;
885 GuestFilesystemInfo
*fs
= NULL
;
887 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
888 if (GetLastError() != ERROR_MORE_DATA
) {
889 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
893 mnt_point
= g_malloc(info_size
+ 1);
894 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
896 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
900 len
= strlen(mnt_point
);
901 mnt_point
[len
] = '\\';
902 mnt_point
[len
+1] = 0;
903 if (!GetVolumeInformation(mnt_point
, vol_info
, sizeof(vol_info
), NULL
, NULL
,
904 NULL
, (LPSTR
)&fs_name
, sizeof(fs_name
))) {
905 if (GetLastError() != ERROR_NOT_READY
) {
906 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
911 fs_name
[sizeof(fs_name
) - 1] = 0;
912 fs
= g_malloc(sizeof(*fs
));
913 fs
->name
= g_strdup(guid
);
914 fs
->has_total_bytes
= false;
915 fs
->has_used_bytes
= false;
917 fs
->mountpoint
= g_strdup("System Reserved");
919 fs
->mountpoint
= g_strndup(mnt_point
, len
);
920 if (GetDiskFreeSpaceEx(fs
->mountpoint
,
921 (PULARGE_INTEGER
) & i64FreeBytesToCaller
,
922 (PULARGE_INTEGER
) & i64TotalBytes
,
923 (PULARGE_INTEGER
) & i64FreeBytes
)) {
924 fs
->used_bytes
= i64TotalBytes
- i64FreeBytes
;
925 fs
->total_bytes
= i64TotalBytes
;
926 fs
->has_total_bytes
= true;
927 fs
->has_used_bytes
= true;
930 fs
->type
= g_strdup(fs_name
);
931 fs
->disk
= build_guest_disk_info(guid
, errp
);
937 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
940 GuestFilesystemInfoList
*new, *ret
= NULL
;
943 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
944 if (vol_h
== INVALID_HANDLE_VALUE
) {
945 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
950 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, errp
);
954 new = g_malloc(sizeof(*ret
));
958 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
960 if (GetLastError() != ERROR_NO_MORE_FILES
) {
961 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
964 FindVolumeClose(vol_h
);
969 * Return status of freeze/thaw
971 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
973 if (!vss_initialized()) {
974 error_setg(errp
, QERR_UNSUPPORTED
);
978 if (ga_is_frozen(ga_state
)) {
979 return GUEST_FSFREEZE_STATUS_FROZEN
;
982 return GUEST_FSFREEZE_STATUS_THAWED
;
986 * Freeze local file systems using Volume Shadow-copy Service.
987 * The frozen state is limited for up to 10 seconds by VSS.
989 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
991 return qmp_guest_fsfreeze_freeze_list(false, NULL
, errp
);
994 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
995 strList
*mountpoints
,
999 Error
*local_err
= NULL
;
1001 if (!vss_initialized()) {
1002 error_setg(errp
, QERR_UNSUPPORTED
);
1006 slog("guest-fsfreeze called");
1008 /* cannot risk guest agent blocking itself on a write in this state */
1009 ga_set_frozen(ga_state
);
1011 qga_vss_fsfreeze(&i
, true, mountpoints
, &local_err
);
1013 error_propagate(errp
, local_err
);
1021 qmp_guest_fsfreeze_thaw(&local_err
);
1023 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
1024 error_free(local_err
);
1030 * Thaw local file systems using Volume Shadow-copy Service.
1032 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
1036 if (!vss_initialized()) {
1037 error_setg(errp
, QERR_UNSUPPORTED
);
1041 qga_vss_fsfreeze(&i
, false, NULL
, errp
);
1043 ga_unset_frozen(ga_state
);
1047 static void guest_fsfreeze_cleanup(void)
1051 if (!vss_initialized()) {
1055 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
1056 qmp_guest_fsfreeze_thaw(&err
);
1058 slog("failed to clean up frozen filesystems: %s",
1059 error_get_pretty(err
));
1068 * Walk list of mounted file systems in the guest, and discard unused
1071 GuestFilesystemTrimResponse
*
1072 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
1074 GuestFilesystemTrimResponse
*resp
;
1076 WCHAR guid
[MAX_PATH
] = L
"";
1080 ZeroMemory(&osvi
, sizeof(OSVERSIONINFO
));
1081 osvi
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1082 GetVersionEx(&osvi
);
1083 win8_or_later
= (osvi
.dwMajorVersion
> 6 ||
1084 ((osvi
.dwMajorVersion
== 6) &&
1085 (osvi
.dwMinorVersion
>= 2)));
1086 if (!win8_or_later
) {
1087 error_setg(errp
, "fstrim is only supported for Win8+");
1091 handle
= FindFirstVolumeW(guid
, ARRAYSIZE(guid
));
1092 if (handle
== INVALID_HANDLE_VALUE
) {
1093 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1097 resp
= g_new0(GuestFilesystemTrimResponse
, 1);
1100 GuestFilesystemTrimResult
*res
;
1101 GuestFilesystemTrimResultList
*list
;
1103 DWORD char_count
= 0;
1105 GError
*gerr
= NULL
;
1108 GetVolumePathNamesForVolumeNameW(guid
, NULL
, 0, &char_count
);
1110 if (GetLastError() != ERROR_MORE_DATA
) {
1113 if (GetDriveTypeW(guid
) != DRIVE_FIXED
) {
1117 uc_path
= g_malloc(sizeof(WCHAR
) * char_count
);
1118 if (!GetVolumePathNamesForVolumeNameW(guid
, uc_path
, char_count
,
1119 &char_count
) || !*uc_path
) {
1120 /* strange, but this condition could be faced even with size == 2 */
1125 res
= g_new0(GuestFilesystemTrimResult
, 1);
1127 path
= g_utf16_to_utf8(uc_path
, char_count
, NULL
, NULL
, &gerr
);
1132 res
->has_error
= true;
1133 res
->error
= g_strdup(gerr
->message
);
1140 list
= g_new0(GuestFilesystemTrimResultList
, 1);
1142 list
->next
= resp
->paths
;
1146 memset(argv
, 0, sizeof(argv
));
1147 argv
[0] = (gchar
*)"defrag.exe";
1148 argv
[1] = (gchar
*)"/L";
1151 if (!g_spawn_sync(NULL
, argv
, NULL
, G_SPAWN_SEARCH_PATH
, NULL
, NULL
,
1152 &out
/* stdout */, NULL
/* stdin */,
1154 res
->has_error
= true;
1155 res
->error
= g_strdup(gerr
->message
);
1158 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1159 Error is reported in the output with something like
1160 (x89000020) etc code in the stdout */
1163 gchar
**lines
= g_strsplit(out
, "\r\n", 0);
1166 for (i
= 0; lines
[i
] != NULL
; i
++) {
1167 if (g_strstr_len(lines
[i
], -1, "(0x") == NULL
) {
1170 res
->has_error
= true;
1171 res
->error
= g_strdup(lines
[i
]);
1176 } while (FindNextVolumeW(handle
, guid
, ARRAYSIZE(guid
)));
1178 FindVolumeClose(handle
);
1183 GUEST_SUSPEND_MODE_DISK
,
1184 GUEST_SUSPEND_MODE_RAM
1187 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
1189 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
1190 Error
*local_err
= NULL
;
1192 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
1193 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
1194 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
1195 "failed to determine guest suspend capabilities");
1200 case GUEST_SUSPEND_MODE_DISK
:
1201 if (!sys_pwr_caps
.SystemS4
) {
1202 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
1203 "suspend-to-disk not supported by OS");
1206 case GUEST_SUSPEND_MODE_RAM
:
1207 if (!sys_pwr_caps
.SystemS3
) {
1208 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
1209 "suspend-to-ram not supported by OS");
1213 error_setg(&local_err
, QERR_INVALID_PARAMETER_VALUE
, "mode",
1214 "GuestSuspendMode");
1218 error_propagate(errp
, local_err
);
1221 static DWORD WINAPI
do_suspend(LPVOID opaque
)
1223 GuestSuspendMode
*mode
= opaque
;
1226 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
1227 slog("failed to suspend guest, %lu", GetLastError());
1234 void qmp_guest_suspend_disk(Error
**errp
)
1236 Error
*local_err
= NULL
;
1237 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1239 *mode
= GUEST_SUSPEND_MODE_DISK
;
1240 check_suspend_mode(*mode
, &local_err
);
1241 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1242 execute_async(do_suspend
, mode
, &local_err
);
1245 error_propagate(errp
, local_err
);
1250 void qmp_guest_suspend_ram(Error
**errp
)
1252 Error
*local_err
= NULL
;
1253 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1255 *mode
= GUEST_SUSPEND_MODE_RAM
;
1256 check_suspend_mode(*mode
, &local_err
);
1257 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1258 execute_async(do_suspend
, mode
, &local_err
);
1261 error_propagate(errp
, local_err
);
1266 void qmp_guest_suspend_hybrid(Error
**errp
)
1268 error_setg(errp
, QERR_UNSUPPORTED
);
1271 static IP_ADAPTER_ADDRESSES
*guest_get_adapters_addresses(Error
**errp
)
1273 IP_ADAPTER_ADDRESSES
*adptr_addrs
= NULL
;
1274 ULONG adptr_addrs_len
= 0;
1277 /* Call the first time to get the adptr_addrs_len. */
1278 GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1279 NULL
, adptr_addrs
, &adptr_addrs_len
);
1281 adptr_addrs
= g_malloc(adptr_addrs_len
);
1282 ret
= GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1283 NULL
, adptr_addrs
, &adptr_addrs_len
);
1284 if (ret
!= ERROR_SUCCESS
) {
1285 error_setg_win32(errp
, ret
, "failed to get adapters addresses");
1286 g_free(adptr_addrs
);
1292 static char *guest_wctomb_dup(WCHAR
*wstr
)
1297 i
= wcslen(wstr
) + 1;
1299 WideCharToMultiByte(CP_ACP
, WC_COMPOSITECHECK
,
1300 wstr
, -1, str
, i
, NULL
, NULL
);
1304 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
,
1307 char addr_str
[INET6_ADDRSTRLEN
+ INET_ADDRSTRLEN
];
1311 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
||
1312 ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1313 len
= sizeof(addr_str
);
1314 ret
= WSAAddressToString(ip_addr
->Address
.lpSockaddr
,
1315 ip_addr
->Address
.iSockaddrLength
,
1320 error_setg_win32(errp
, WSAGetLastError(),
1321 "failed address presentation form conversion");
1324 return g_strdup(addr_str
);
1329 #if (_WIN32_WINNT >= 0x0600)
1330 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1332 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1333 * field to obtain the prefix.
1335 return ip_addr
->OnLinkPrefixLength
;
1338 /* When using the Windows XP and 2003 build environment, do the best we can to
1339 * figure out the prefix.
1341 static IP_ADAPTER_INFO
*guest_get_adapters_info(void)
1343 IP_ADAPTER_INFO
*adptr_info
= NULL
;
1344 ULONG adptr_info_len
= 0;
1347 /* Call the first time to get the adptr_info_len. */
1348 GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1350 adptr_info
= g_malloc(adptr_info_len
);
1351 ret
= GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1352 if (ret
!= ERROR_SUCCESS
) {
1359 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1361 int64_t prefix
= -1; /* Use for AF_INET6 and unknown/undetermined values. */
1362 IP_ADAPTER_INFO
*adptr_info
, *info
;
1366 if (ip_addr
->Address
.lpSockaddr
->sa_family
!= AF_INET
) {
1369 adptr_info
= guest_get_adapters_info();
1370 if (adptr_info
== NULL
) {
1374 /* Match up the passed in ip_addr with one found in adaptr_info.
1375 * The matching one in adptr_info will have the netmask.
1377 p
= &((struct sockaddr_in
*)ip_addr
->Address
.lpSockaddr
)->sin_addr
;
1378 for (info
= adptr_info
; info
; info
= info
->Next
) {
1379 for (ip
= &info
->IpAddressList
; ip
; ip
= ip
->Next
) {
1380 if (p
->S_un
.S_addr
== inet_addr(ip
->IpAddress
.String
)) {
1381 prefix
= ctpop32(inet_addr(ip
->IpMask
.String
));
1392 #define INTERFACE_PATH_BUF_SZ 512
1394 static DWORD
get_interface_index(const char *guid
)
1398 wchar_t wbuf
[INTERFACE_PATH_BUF_SZ
];
1399 snwprintf(wbuf
, INTERFACE_PATH_BUF_SZ
, L
"\\device\\tcpip_%s", guid
);
1400 wbuf
[INTERFACE_PATH_BUF_SZ
- 1] = 0;
1401 status
= GetAdapterIndex (wbuf
, &index
);
1402 if (status
!= NO_ERROR
) {
1409 typedef NETIOAPI_API (WINAPI
*GetIfEntry2Func
)(PMIB_IF_ROW2 Row
);
1411 static int guest_get_network_stats(const char *name
,
1412 GuestNetworkInterfaceStat
*stats
)
1414 OSVERSIONINFO os_ver
;
1416 os_ver
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1417 GetVersionEx(&os_ver
);
1418 if (os_ver
.dwMajorVersion
>= 6) {
1419 MIB_IF_ROW2 a_mid_ifrow
;
1420 GetIfEntry2Func getifentry2_ex
;
1422 HMODULE module
= GetModuleHandle("iphlpapi");
1423 PVOID func
= GetProcAddress(module
, "GetIfEntry2");
1429 getifentry2_ex
= (GetIfEntry2Func
)func
;
1430 if_index
= get_interface_index(name
);
1431 if (if_index
== (DWORD
)~0) {
1435 memset(&a_mid_ifrow
, 0, sizeof(a_mid_ifrow
));
1436 a_mid_ifrow
.InterfaceIndex
= if_index
;
1437 if (NO_ERROR
== getifentry2_ex(&a_mid_ifrow
)) {
1438 stats
->rx_bytes
= a_mid_ifrow
.InOctets
;
1439 stats
->rx_packets
= a_mid_ifrow
.InUcastPkts
;
1440 stats
->rx_errs
= a_mid_ifrow
.InErrors
;
1441 stats
->rx_dropped
= a_mid_ifrow
.InDiscards
;
1442 stats
->tx_bytes
= a_mid_ifrow
.OutOctets
;
1443 stats
->tx_packets
= a_mid_ifrow
.OutUcastPkts
;
1444 stats
->tx_errs
= a_mid_ifrow
.OutErrors
;
1445 stats
->tx_dropped
= a_mid_ifrow
.OutDiscards
;
1452 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
1454 IP_ADAPTER_ADDRESSES
*adptr_addrs
, *addr
;
1455 IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
= NULL
;
1456 GuestNetworkInterfaceList
*head
= NULL
, *cur_item
= NULL
;
1457 GuestIpAddressList
*head_addr
, *cur_addr
;
1458 GuestNetworkInterfaceList
*info
;
1459 GuestNetworkInterfaceStat
*interface_stat
= NULL
;
1460 GuestIpAddressList
*address_item
= NULL
;
1461 unsigned char *mac_addr
;
1467 adptr_addrs
= guest_get_adapters_addresses(errp
);
1468 if (adptr_addrs
== NULL
) {
1472 /* Make WSA APIs available. */
1473 wsa_version
= MAKEWORD(2, 2);
1474 ret
= WSAStartup(wsa_version
, &wsa_data
);
1476 error_setg_win32(errp
, ret
, "failed socket startup");
1480 for (addr
= adptr_addrs
; addr
; addr
= addr
->Next
) {
1481 info
= g_malloc0(sizeof(*info
));
1483 if (cur_item
== NULL
) {
1484 head
= cur_item
= info
;
1486 cur_item
->next
= info
;
1490 info
->value
= g_malloc0(sizeof(*info
->value
));
1491 info
->value
->name
= guest_wctomb_dup(addr
->FriendlyName
);
1493 if (addr
->PhysicalAddressLength
!= 0) {
1494 mac_addr
= addr
->PhysicalAddress
;
1496 info
->value
->hardware_address
=
1497 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1498 (int) mac_addr
[0], (int) mac_addr
[1],
1499 (int) mac_addr
[2], (int) mac_addr
[3],
1500 (int) mac_addr
[4], (int) mac_addr
[5]);
1502 info
->value
->has_hardware_address
= true;
1507 for (ip_addr
= addr
->FirstUnicastAddress
;
1509 ip_addr
= ip_addr
->Next
) {
1510 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1511 if (addr_str
== NULL
) {
1515 address_item
= g_malloc0(sizeof(*address_item
));
1518 head_addr
= cur_addr
= address_item
;
1520 cur_addr
->next
= address_item
;
1521 cur_addr
= address_item
;
1524 address_item
->value
= g_malloc0(sizeof(*address_item
->value
));
1525 address_item
->value
->ip_address
= addr_str
;
1526 address_item
->value
->prefix
= guest_ip_prefix(ip_addr
);
1527 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1528 address_item
->value
->ip_address_type
=
1529 GUEST_IP_ADDRESS_TYPE_IPV4
;
1530 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1531 address_item
->value
->ip_address_type
=
1532 GUEST_IP_ADDRESS_TYPE_IPV6
;
1536 info
->value
->has_ip_addresses
= true;
1537 info
->value
->ip_addresses
= head_addr
;
1539 if (!info
->value
->has_statistics
) {
1540 interface_stat
= g_malloc0(sizeof(*interface_stat
));
1541 if (guest_get_network_stats(addr
->AdapterName
,
1542 interface_stat
) == -1) {
1543 info
->value
->has_statistics
= false;
1544 g_free(interface_stat
);
1546 info
->value
->statistics
= interface_stat
;
1547 info
->value
->has_statistics
= true;
1553 g_free(adptr_addrs
);
1557 int64_t qmp_guest_get_time(Error
**errp
)
1559 SYSTEMTIME ts
= {0};
1563 if (ts
.wYear
< 1601 || ts
.wYear
> 30827) {
1564 error_setg(errp
, "Failed to get time");
1568 if (!SystemTimeToFileTime(&ts
, &tf
)) {
1569 error_setg(errp
, "Failed to convert system time: %d", (int)GetLastError());
1573 return ((((int64_t)tf
.dwHighDateTime
<< 32) | tf
.dwLowDateTime
)
1574 - W32_FT_OFFSET
) * 100;
1577 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
1579 Error
*local_err
= NULL
;
1585 /* Unfortunately, Windows libraries don't provide an easy way to access
1588 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1590 * Instead, a workaround is to use the Windows win32tm command to
1591 * resync the time using the Windows Time service.
1596 HRESULT hr
= system("w32tm /resync /nowait");
1598 if (GetLastError() != 0) {
1599 strerror_s((LPTSTR
) & msg_buffer
, 0, errno
);
1600 error_setg(errp
, "system(...) failed: %s", (LPCTSTR
)msg_buffer
);
1601 } else if (hr
!= 0) {
1602 if (hr
== HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE
)) {
1603 error_setg(errp
, "Windows Time service not running on the "
1606 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1607 FORMAT_MESSAGE_FROM_SYSTEM
|
1608 FORMAT_MESSAGE_IGNORE_INSERTS
, NULL
,
1609 (DWORD
)hr
, MAKELANGID(LANG_NEUTRAL
,
1610 SUBLANG_DEFAULT
), (LPTSTR
) & msg_buffer
, 0,
1612 error_setg(errp
, "w32tm failed with error (0x%lx), couldn'"
1613 "t retrieve error message", hr
);
1615 error_setg(errp
, "w32tm failed with error (0x%lx): %s", hr
,
1616 (LPCTSTR
)msg_buffer
);
1617 LocalFree(msg_buffer
);
1620 } else if (!InternetGetConnectedState(&ret_flags
, 0)) {
1621 error_setg(errp
, "No internet connection on guest, sync not "
1627 /* Validate time passed by user. */
1628 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
1629 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
1633 time
= time_ns
/ 100 + W32_FT_OFFSET
;
1635 tf
.dwLowDateTime
= (DWORD
) time
;
1636 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
1638 if (!FileTimeToSystemTime(&tf
, &ts
)) {
1639 error_setg(errp
, "Failed to convert system time %d",
1640 (int)GetLastError());
1644 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
1646 error_propagate(errp
, local_err
);
1650 if (!SetSystemTime(&ts
)) {
1651 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
1656 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
1658 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi
, ptr
;
1660 GuestLogicalProcessorList
*head
, **link
;
1661 Error
*local_err
= NULL
;
1670 if ((GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) &&
1671 (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) &&
1672 (length
> sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
))) {
1673 ptr
= pslpi
= g_malloc0(length
);
1674 if (GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) {
1675 error_setg(&local_err
, "Failed to get processor information: %d",
1676 (int)GetLastError());
1679 error_setg(&local_err
,
1680 "Failed to get processor information buffer length: %d",
1681 (int)GetLastError());
1684 while ((local_err
== NULL
) && (length
> 0)) {
1685 if (pslpi
->Relationship
== RelationProcessorCore
) {
1686 ULONG_PTR cpu_bits
= pslpi
->ProcessorMask
;
1688 while (cpu_bits
> 0) {
1689 if (!!(cpu_bits
& 1)) {
1690 GuestLogicalProcessor
*vcpu
;
1691 GuestLogicalProcessorList
*entry
;
1693 vcpu
= g_malloc0(sizeof *vcpu
);
1694 vcpu
->logical_id
= current
++;
1695 vcpu
->online
= true;
1696 vcpu
->has_can_offline
= true;
1698 entry
= g_malloc0(sizeof *entry
);
1699 entry
->value
= vcpu
;
1702 link
= &entry
->next
;
1707 length
-= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
);
1708 pslpi
++; /* next entry */
1713 if (local_err
== NULL
) {
1717 /* there's no guest with zero VCPUs */
1718 error_setg(&local_err
, "Guest reported zero VCPUs");
1721 qapi_free_GuestLogicalProcessorList(head
);
1722 error_propagate(errp
, local_err
);
1726 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
1728 error_setg(errp
, QERR_UNSUPPORTED
);
1733 get_net_error_message(gint error
)
1735 HMODULE module
= NULL
;
1736 gchar
*retval
= NULL
;
1737 wchar_t *msg
= NULL
;
1741 flags
= FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1742 FORMAT_MESSAGE_IGNORE_INSERTS
|
1743 FORMAT_MESSAGE_FROM_SYSTEM
;
1745 if (error
>= NERR_BASE
&& error
<= MAX_NERR
) {
1746 module
= LoadLibraryExW(L
"netmsg.dll", NULL
, LOAD_LIBRARY_AS_DATAFILE
);
1748 if (module
!= NULL
) {
1749 flags
|= FORMAT_MESSAGE_FROM_HMODULE
;
1753 FormatMessageW(flags
, module
, error
, 0, (LPWSTR
)&msg
, 0, NULL
);
1756 nchars
= wcslen(msg
);
1759 msg
[nchars
- 1] == L
'\n' &&
1760 msg
[nchars
- 2] == L
'\r') {
1761 msg
[nchars
- 2] = L
'\0';
1764 retval
= g_utf16_to_utf8(msg
, -1, NULL
, NULL
, NULL
);
1769 if (module
!= NULL
) {
1770 FreeLibrary(module
);
1776 void qmp_guest_set_user_password(const char *username
,
1777 const char *password
,
1782 char *rawpasswddata
= NULL
;
1783 size_t rawpasswdlen
;
1784 wchar_t *user
= NULL
, *wpass
= NULL
;
1785 USER_INFO_1003 pi1003
= { 0, };
1786 GError
*gerr
= NULL
;
1789 error_setg(errp
, QERR_UNSUPPORTED
);
1793 rawpasswddata
= (char *)qbase64_decode(password
, -1, &rawpasswdlen
, errp
);
1794 if (!rawpasswddata
) {
1797 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
1798 rawpasswddata
[rawpasswdlen
] = '\0';
1800 user
= g_utf8_to_utf16(username
, -1, NULL
, NULL
, &gerr
);
1805 wpass
= g_utf8_to_utf16(rawpasswddata
, -1, NULL
, NULL
, &gerr
);
1810 pi1003
.usri1003_password
= wpass
;
1811 nas
= NetUserSetInfo(NULL
, user
,
1812 1003, (LPBYTE
)&pi1003
,
1815 if (nas
!= NERR_Success
) {
1816 gchar
*msg
= get_net_error_message(nas
);
1817 error_setg(errp
, "failed to set password: %s", msg
);
1823 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
1828 g_free(rawpasswddata
);
1831 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
1833 error_setg(errp
, QERR_UNSUPPORTED
);
1837 GuestMemoryBlockResponseList
*
1838 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
1840 error_setg(errp
, QERR_UNSUPPORTED
);
1844 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
1846 error_setg(errp
, QERR_UNSUPPORTED
);
1850 /* add unsupported commands to the blacklist */
1851 GList
*ga_command_blacklist_init(GList
*blacklist
)
1853 const char *list_unsupported
[] = {
1854 "guest-suspend-hybrid",
1856 "guest-get-memory-blocks", "guest-set-memory-blocks",
1857 "guest-get-memory-block-size",
1859 char **p
= (char **)list_unsupported
;
1862 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1865 if (!vss_init(true)) {
1866 g_debug("vss_init failed, vss commands are going to be disabled");
1867 const char *list
[] = {
1868 "guest-get-fsinfo", "guest-fsfreeze-status",
1869 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL
};
1873 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1880 /* register init/cleanup routines for stateful command groups */
1881 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
1883 if (!vss_initialized()) {
1884 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);
1888 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
1889 typedef struct _GA_WTSINFOA
{
1890 WTS_CONNECTSTATE_CLASS State
;
1892 DWORD IncomingBytes
;
1893 DWORD OutgoingBytes
;
1894 DWORD IncomingFrames
;
1895 DWORD OutgoingFrames
;
1896 DWORD IncomingCompressedBytes
;
1897 DWORD OutgoingCompressedBy
;
1898 CHAR WinStationName
[WINSTATIONNAME_LENGTH
];
1899 CHAR Domain
[DOMAIN_LENGTH
];
1900 CHAR UserName
[USERNAME_LENGTH
+ 1];
1901 LARGE_INTEGER ConnectTime
;
1902 LARGE_INTEGER DisconnectTime
;
1903 LARGE_INTEGER LastInputTime
;
1904 LARGE_INTEGER LogonTime
;
1905 LARGE_INTEGER CurrentTime
;
1909 GuestUserList
*qmp_guest_get_users(Error
**err
)
1911 #if (_WIN32_WINNT >= 0x0600)
1912 #define QGA_NANOSECONDS 10000000
1914 GHashTable
*cache
= NULL
;
1915 GuestUserList
*head
= NULL
, *cur_item
= NULL
;
1917 DWORD buffer_size
= 0, count
= 0, i
= 0;
1918 GA_WTSINFOA
*info
= NULL
;
1919 WTS_SESSION_INFOA
*entries
= NULL
;
1920 GuestUserList
*item
= NULL
;
1921 GuestUser
*user
= NULL
;
1922 gpointer value
= NULL
;
1924 double login_time
= 0;
1926 cache
= g_hash_table_new(g_str_hash
, g_str_equal
);
1928 if (WTSEnumerateSessionsA(NULL
, 0, 1, &entries
, &count
)) {
1929 for (i
= 0; i
< count
; ++i
) {
1932 if (WTSQuerySessionInformationA(
1934 entries
[i
].SessionId
,
1940 if (strlen(info
->UserName
) == 0) {
1941 WTSFreeMemory(info
);
1945 login
= info
->LogonTime
.QuadPart
;
1946 login
-= W32_FT_OFFSET
;
1947 login_time
= ((double)login
) / QGA_NANOSECONDS
;
1949 if (g_hash_table_contains(cache
, info
->UserName
)) {
1950 value
= g_hash_table_lookup(cache
, info
->UserName
);
1951 user
= (GuestUser
*)value
;
1952 if (user
->login_time
> login_time
) {
1953 user
->login_time
= login_time
;
1956 item
= g_new0(GuestUserList
, 1);
1957 item
->value
= g_new0(GuestUser
, 1);
1959 item
->value
->user
= g_strdup(info
->UserName
);
1960 item
->value
->domain
= g_strdup(info
->Domain
);
1961 item
->value
->has_domain
= true;
1963 item
->value
->login_time
= login_time
;
1965 g_hash_table_add(cache
, item
->value
->user
);
1968 head
= cur_item
= item
;
1970 cur_item
->next
= item
;
1975 WTSFreeMemory(info
);
1977 WTSFreeMemory(entries
);
1979 g_hash_table_destroy(cache
);
1982 error_setg(err
, QERR_UNSUPPORTED
);
1987 typedef struct _ga_matrix_lookup_t
{
1990 char const *version
;
1991 char const *version_id
;
1992 } ga_matrix_lookup_t
;
1994 static ga_matrix_lookup_t
const WIN_VERSION_MATRIX
[2][8] = {
1996 /* Desktop editions */
1997 { 5, 0, "Microsoft Windows 2000", "2000"},
1998 { 5, 1, "Microsoft Windows XP", "xp"},
1999 { 6, 0, "Microsoft Windows Vista", "vista"},
2000 { 6, 1, "Microsoft Windows 7" "7"},
2001 { 6, 2, "Microsoft Windows 8", "8"},
2002 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2003 {10, 0, "Microsoft Windows 10", "10"},
2006 /* Server editions */
2007 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2008 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2009 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2010 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2011 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2012 {10, 0, "Microsoft Windows Server 2016", "2016"},
2018 static void ga_get_win_version(RTL_OSVERSIONINFOEXW
*info
, Error
**errp
)
2020 typedef NTSTATUS(WINAPI
* rtl_get_version_t
)(
2021 RTL_OSVERSIONINFOEXW
*os_version_info_ex
);
2023 info
->dwOSVersionInfoSize
= sizeof(RTL_OSVERSIONINFOEXW
);
2025 HMODULE module
= GetModuleHandle("ntdll");
2026 PVOID fun
= GetProcAddress(module
, "RtlGetVersion");
2028 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
2029 "Failed to get address of RtlGetVersion");
2033 rtl_get_version_t rtl_get_version
= (rtl_get_version_t
)fun
;
2034 rtl_get_version(info
);
2038 static char *ga_get_win_name(OSVERSIONINFOEXW
const *os_version
, bool id
)
2040 DWORD major
= os_version
->dwMajorVersion
;
2041 DWORD minor
= os_version
->dwMinorVersion
;
2042 int tbl_idx
= (os_version
->wProductType
!= VER_NT_WORKSTATION
);
2043 ga_matrix_lookup_t
const *table
= WIN_VERSION_MATRIX
[tbl_idx
];
2044 while (table
->version
!= NULL
) {
2045 if (major
== table
->major
&& minor
== table
->minor
) {
2047 return g_strdup(table
->version_id
);
2049 return g_strdup(table
->version
);
2054 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2056 return g_strdup("N/A");
2059 static char *ga_get_win_product_name(Error
**errp
)
2063 char *result
= g_malloc0(size
);
2064 LONG err
= ERROR_SUCCESS
;
2066 err
= RegOpenKeyA(HKEY_LOCAL_MACHINE
,
2067 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2069 if (err
!= ERROR_SUCCESS
) {
2070 error_setg_win32(errp
, err
, "failed to open registry key");
2074 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2075 (LPBYTE
)result
, &size
);
2076 if (err
== ERROR_MORE_DATA
) {
2077 slog("ProductName longer than expected (%lu bytes), retrying",
2082 result
= g_malloc0(size
);
2083 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2084 (LPBYTE
)result
, &size
);
2087 if (err
!= ERROR_SUCCESS
) {
2088 error_setg_win32(errp
, err
, "failed to retrive ProductName");
2099 static char *ga_get_current_arch(void)
2102 GetNativeSystemInfo(&info
);
2103 char *result
= NULL
;
2104 switch (info
.wProcessorArchitecture
) {
2105 case PROCESSOR_ARCHITECTURE_AMD64
:
2106 result
= g_strdup("x86_64");
2108 case PROCESSOR_ARCHITECTURE_ARM
:
2109 result
= g_strdup("arm");
2111 case PROCESSOR_ARCHITECTURE_IA64
:
2112 result
= g_strdup("ia64");
2114 case PROCESSOR_ARCHITECTURE_INTEL
:
2115 result
= g_strdup("x86");
2117 case PROCESSOR_ARCHITECTURE_UNKNOWN
:
2119 slog("unknown processor architecture 0x%0x",
2120 info
.wProcessorArchitecture
);
2121 result
= g_strdup("unknown");
2127 GuestOSInfo
*qmp_guest_get_osinfo(Error
**errp
)
2129 Error
*local_err
= NULL
;
2130 OSVERSIONINFOEXW os_version
= {0};
2135 ga_get_win_version(&os_version
, &local_err
);
2137 error_propagate(errp
, local_err
);
2141 server
= os_version
.wProductType
!= VER_NT_WORKSTATION
;
2142 product_name
= ga_get_win_product_name(&local_err
);
2143 if (product_name
== NULL
) {
2144 error_propagate(errp
, local_err
);
2148 info
= g_new0(GuestOSInfo
, 1);
2150 info
->has_kernel_version
= true;
2151 info
->kernel_version
= g_strdup_printf("%lu.%lu",
2152 os_version
.dwMajorVersion
,
2153 os_version
.dwMinorVersion
);
2154 info
->has_kernel_release
= true;
2155 info
->kernel_release
= g_strdup_printf("%lu",
2156 os_version
.dwBuildNumber
);
2157 info
->has_machine
= true;
2158 info
->machine
= ga_get_current_arch();
2160 info
->has_id
= true;
2161 info
->id
= g_strdup("mswindows");
2162 info
->has_name
= true;
2163 info
->name
= g_strdup("Microsoft Windows");
2164 info
->has_pretty_name
= true;
2165 info
->pretty_name
= product_name
;
2166 info
->has_version
= true;
2167 info
->version
= ga_get_win_name(&os_version
, false);
2168 info
->has_version_id
= true;
2169 info
->version_id
= ga_get_win_name(&os_version
, true);
2170 info
->has_variant
= true;
2171 info
->variant
= g_strdup(server
? "server" : "client");
2172 info
->has_variant_id
= true;
2173 info
->variant_id
= g_strdup(server
? "server" : "client");