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.
13 #include "qemu/osdep.h"
26 #include <devpropdef.h>
31 #include "guest-agent-core.h"
32 #include "vss-win32.h"
33 #include "qga-qapi-commands.h"
34 #include "qapi/error.h"
35 #include "qapi/qmp/qerror.h"
36 #include "qemu/queue.h"
37 #include "qemu/host-utils.h"
38 #include "qemu/base64.h"
39 #include "commands-common.h"
42 * The following should be in devpkey.h, but it isn't. The key names were
43 * prefixed to avoid (future) name clashes. Once the definitions get into
44 * mingw the following lines can be removed.
46 DEFINE_DEVPROPKEY(qga_DEVPKEY_NAME
, 0xb725f130, 0x47ef, 0x101a, 0xa5,
47 0xf1, 0x02, 0x60, 0x8c, 0x9e, 0xeb, 0xac, 10);
48 /* DEVPROP_TYPE_STRING */
49 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_HardwareIds
, 0xa45c254e, 0xdf1c,
50 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 3);
51 /* DEVPROP_TYPE_STRING_LIST */
52 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverDate
, 0xa8b865dd, 0x2e3d,
53 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 2);
54 /* DEVPROP_TYPE_FILETIME */
55 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverVersion
, 0xa8b865dd, 0x2e3d,
56 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 3);
57 /* DEVPROP_TYPE_STRING */
58 /* The CM_Get_DevNode_PropertyW prototype is only sometimes in cfgmgr32.h */
59 #ifndef CM_Get_DevNode_Property
60 #pragma GCC diagnostic push
61 #pragma GCC diagnostic ignored "-Wredundant-decls"
62 CMAPI CONFIGRET WINAPI
CM_Get_DevNode_PropertyW(
64 CONST DEVPROPKEY
* PropertyKey
,
65 DEVPROPTYPE
* PropertyType
,
67 PULONG PropertyBufferSize
,
70 #define CM_Get_DevNode_Property CM_Get_DevNode_PropertyW
71 #pragma GCC diagnostic pop
74 #ifndef SHTDN_REASON_FLAG_PLANNED
75 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
78 /* multiple of 100 nanoseconds elapsed between windows baseline
79 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
80 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
81 (365 * (1970 - 1601) + \
82 (1970 - 1601) / 4 - 3))
84 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
86 struct GuestFileHandle
{
89 QTAILQ_ENTRY(GuestFileHandle
) next
;
93 QTAILQ_HEAD(, GuestFileHandle
) filehandles
;
94 } guest_file_state
= {
95 .filehandles
= QTAILQ_HEAD_INITIALIZER(guest_file_state
.filehandles
),
98 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
100 typedef struct OpenFlags
{
102 DWORD desired_access
;
103 DWORD creation_disposition
;
105 static OpenFlags guest_file_open_modes
[] = {
106 {"r", GENERIC_READ
, OPEN_EXISTING
},
107 {"rb", GENERIC_READ
, OPEN_EXISTING
},
108 {"w", GENERIC_WRITE
, CREATE_ALWAYS
},
109 {"wb", GENERIC_WRITE
, CREATE_ALWAYS
},
110 {"a", FILE_GENERIC_APPEND
, OPEN_ALWAYS
},
111 {"r+", GENERIC_WRITE
| GENERIC_READ
, OPEN_EXISTING
},
112 {"rb+", GENERIC_WRITE
| GENERIC_READ
, OPEN_EXISTING
},
113 {"r+b", GENERIC_WRITE
| GENERIC_READ
, OPEN_EXISTING
},
114 {"w+", GENERIC_WRITE
| GENERIC_READ
, CREATE_ALWAYS
},
115 {"wb+", GENERIC_WRITE
| GENERIC_READ
, CREATE_ALWAYS
},
116 {"w+b", GENERIC_WRITE
| GENERIC_READ
, CREATE_ALWAYS
},
117 {"a+", FILE_GENERIC_APPEND
| GENERIC_READ
, OPEN_ALWAYS
},
118 {"ab+", FILE_GENERIC_APPEND
| GENERIC_READ
, OPEN_ALWAYS
},
119 {"a+b", FILE_GENERIC_APPEND
| GENERIC_READ
, OPEN_ALWAYS
}
122 #define debug_error(msg) do { \
123 char *suffix = g_win32_error_message(GetLastError()); \
124 g_debug("%s: %s", (msg), suffix); \
128 static OpenFlags
*find_open_flag(const char *mode_str
)
133 for (mode
= 0; mode
< ARRAY_SIZE(guest_file_open_modes
); ++mode
) {
134 OpenFlags
*flags
= guest_file_open_modes
+ mode
;
136 if (strcmp(flags
->forms
, mode_str
) == 0) {
141 error_setg(errp
, "invalid file open mode '%s'", mode_str
);
145 static int64_t guest_file_handle_add(HANDLE fh
, Error
**errp
)
147 GuestFileHandle
*gfh
;
150 handle
= ga_get_fd_handle(ga_state
, errp
);
154 gfh
= g_new0(GuestFileHandle
, 1);
157 QTAILQ_INSERT_TAIL(&guest_file_state
.filehandles
, gfh
, next
);
162 GuestFileHandle
*guest_file_handle_find(int64_t id
, Error
**errp
)
164 GuestFileHandle
*gfh
;
165 QTAILQ_FOREACH(gfh
, &guest_file_state
.filehandles
, next
) {
170 error_setg(errp
, "handle '%" PRId64
"' has not been found", id
);
174 static void handle_set_nonblocking(HANDLE fh
)
176 DWORD file_type
, pipe_state
;
177 file_type
= GetFileType(fh
);
178 if (file_type
!= FILE_TYPE_PIPE
) {
181 /* If file_type == FILE_TYPE_PIPE, according to MSDN
182 * the specified file is socket or named pipe */
183 if (!GetNamedPipeHandleState(fh
, &pipe_state
, NULL
,
184 NULL
, NULL
, NULL
, 0)) {
187 /* The fd is named pipe fd */
188 if (pipe_state
& PIPE_NOWAIT
) {
192 pipe_state
|= PIPE_NOWAIT
;
193 SetNamedPipeHandleState(fh
, &pipe_state
, NULL
, NULL
);
196 int64_t qmp_guest_file_open(const char *path
, const char *mode
, Error
**errp
)
200 HANDLE templ_file
= NULL
;
201 DWORD share_mode
= FILE_SHARE_READ
;
202 DWORD flags_and_attr
= FILE_ATTRIBUTE_NORMAL
;
203 LPSECURITY_ATTRIBUTES sa_attr
= NULL
;
204 OpenFlags
*guest_flags
;
206 wchar_t *w_path
= NULL
;
211 slog("guest-file-open called, filepath: %s, mode: %s", path
, mode
);
212 guest_flags
= find_open_flag(mode
);
213 if (guest_flags
== NULL
) {
214 error_setg(errp
, "invalid file open mode");
218 w_path
= g_utf8_to_utf16(path
, -1, NULL
, NULL
, &gerr
);
223 fh
= CreateFileW(w_path
, guest_flags
->desired_access
, share_mode
, sa_attr
,
224 guest_flags
->creation_disposition
, flags_and_attr
,
226 if (fh
== INVALID_HANDLE_VALUE
) {
227 error_setg_win32(errp
, GetLastError(), "failed to open file '%s'",
232 /* set fd non-blocking to avoid common use cases (like reading from a
233 * named pipe) from hanging the agent
235 handle_set_nonblocking(fh
);
237 fd
= guest_file_handle_add(fh
, errp
);
240 error_setg(errp
, "failed to add handle to qmp handle table");
244 slog("guest-file-open, handle: % " PRId64
, fd
);
248 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
255 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
258 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
259 slog("guest-file-close called, handle: %" PRId64
, handle
);
263 ret
= CloseHandle(gfh
->fh
);
265 error_setg_win32(errp
, GetLastError(), "failed close handle");
269 QTAILQ_REMOVE(&guest_file_state
.filehandles
, gfh
, next
);
273 static void acquire_privilege(const char *name
, Error
**errp
)
276 TOKEN_PRIVILEGES priv
;
278 if (OpenProcessToken(GetCurrentProcess(),
279 TOKEN_ADJUST_PRIVILEGES
| TOKEN_QUERY
, &token
))
281 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
282 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
283 "no luid for requested privilege");
287 priv
.PrivilegeCount
= 1;
288 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
290 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
291 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
292 "unable to acquire requested privilege");
297 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
298 "failed to open privilege token");
307 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
310 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
312 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
313 "failed to dispatch asynchronous command");
317 void qmp_guest_shutdown(const char *mode
, Error
**errp
)
319 Error
*local_err
= NULL
;
320 UINT shutdown_flag
= EWX_FORCE
;
322 slog("guest-shutdown called, mode: %s", mode
);
324 if (!mode
|| strcmp(mode
, "powerdown") == 0) {
325 shutdown_flag
|= EWX_POWEROFF
;
326 } else if (strcmp(mode
, "halt") == 0) {
327 shutdown_flag
|= EWX_SHUTDOWN
;
328 } else if (strcmp(mode
, "reboot") == 0) {
329 shutdown_flag
|= EWX_REBOOT
;
331 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
332 "'halt', 'powerdown', or 'reboot'");
336 /* Request a shutdown privilege, but try to shut down the system
338 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
340 error_propagate(errp
, local_err
);
344 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
345 g_autofree gchar
*emsg
= g_win32_error_message(GetLastError());
346 slog("guest-shutdown failed: %s", emsg
);
347 error_setg_win32(errp
, GetLastError(), "guest-shutdown failed");
351 GuestFileRead
*guest_file_read_unsafe(GuestFileHandle
*gfh
,
352 int64_t count
, Error
**errp
)
354 GuestFileRead
*read_data
= NULL
;
360 buf
= g_malloc0(count
+ 1);
361 is_ok
= ReadFile(fh
, buf
, count
, &read_count
, NULL
);
363 error_setg_win32(errp
, GetLastError(), "failed to read file");
366 read_data
= g_new0(GuestFileRead
, 1);
367 read_data
->count
= (size_t)read_count
;
368 read_data
->eof
= read_count
== 0;
370 if (read_count
!= 0) {
371 read_data
->buf_b64
= g_base64_encode(buf
, read_count
);
379 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
380 bool has_count
, int64_t count
,
383 GuestFileWrite
*write_data
= NULL
;
388 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
395 buf
= qbase64_decode(buf_b64
, -1, &buf_len
, errp
);
402 } else if (count
< 0 || count
> buf_len
) {
403 error_setg(errp
, "value '%" PRId64
404 "' is invalid for argument count", count
);
408 is_ok
= WriteFile(fh
, buf
, count
, &write_count
, NULL
);
410 error_setg_win32(errp
, GetLastError(), "failed to write to file");
411 slog("guest-file-write-failed, handle: %" PRId64
, handle
);
413 write_data
= g_new0(GuestFileWrite
, 1);
414 write_data
->count
= (size_t) write_count
;
422 GuestFileSeek
*qmp_guest_file_seek(int64_t handle
, int64_t offset
,
423 GuestFileWhence
*whence_code
,
426 GuestFileHandle
*gfh
;
427 GuestFileSeek
*seek_data
;
429 LARGE_INTEGER new_pos
, off_pos
;
430 off_pos
.QuadPart
= offset
;
435 gfh
= guest_file_handle_find(handle
, errp
);
440 /* We stupidly exposed 'whence':'int' in our qapi */
441 whence
= ga_parse_whence(whence_code
, &err
);
443 error_propagate(errp
, err
);
448 res
= SetFilePointerEx(fh
, off_pos
, &new_pos
, whence
);
450 error_setg_win32(errp
, GetLastError(), "failed to seek file");
453 seek_data
= g_new0(GuestFileSeek
, 1);
454 seek_data
->position
= new_pos
.QuadPart
;
458 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
461 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
467 if (!FlushFileBuffers(fh
)) {
468 error_setg_win32(errp
, GetLastError(), "failed to flush file");
472 static GuestDiskBusType win2qemu
[] = {
473 [BusTypeUnknown
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
474 [BusTypeScsi
] = GUEST_DISK_BUS_TYPE_SCSI
,
475 [BusTypeAtapi
] = GUEST_DISK_BUS_TYPE_IDE
,
476 [BusTypeAta
] = GUEST_DISK_BUS_TYPE_IDE
,
477 [BusType1394
] = GUEST_DISK_BUS_TYPE_IEEE1394
,
478 [BusTypeSsa
] = GUEST_DISK_BUS_TYPE_SSA
,
479 [BusTypeFibre
] = GUEST_DISK_BUS_TYPE_SSA
,
480 [BusTypeUsb
] = GUEST_DISK_BUS_TYPE_USB
,
481 [BusTypeRAID
] = GUEST_DISK_BUS_TYPE_RAID
,
482 [BusTypeiScsi
] = GUEST_DISK_BUS_TYPE_ISCSI
,
483 [BusTypeSas
] = GUEST_DISK_BUS_TYPE_SAS
,
484 [BusTypeSata
] = GUEST_DISK_BUS_TYPE_SATA
,
485 [BusTypeSd
] = GUEST_DISK_BUS_TYPE_SD
,
486 [BusTypeMmc
] = GUEST_DISK_BUS_TYPE_MMC
,
487 #if (_WIN32_WINNT >= 0x0601)
488 [BusTypeVirtual
] = GUEST_DISK_BUS_TYPE_VIRTUAL
,
489 [BusTypeFileBackedVirtual
] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL
,
491 * BusTypeSpaces currently is not suported
493 [BusTypeSpaces
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
494 [BusTypeNvme
] = GUEST_DISK_BUS_TYPE_NVME
,
498 static GuestDiskBusType
find_bus_type(STORAGE_BUS_TYPE bus
)
500 if (bus
>= ARRAY_SIZE(win2qemu
) || (int)bus
< 0) {
501 return GUEST_DISK_BUS_TYPE_UNKNOWN
;
503 return win2qemu
[(int)bus
];
506 DEFINE_GUID(GUID_DEVINTERFACE_DISK
,
507 0x53f56307L
, 0xb6bf, 0x11d0, 0x94, 0xf2,
508 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
509 DEFINE_GUID(GUID_DEVINTERFACE_STORAGEPORT
,
510 0x2accfe60L
, 0xc130, 0x11d2, 0xb0, 0x82,
511 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
513 static void get_pci_address_for_device(GuestPCIAddress
*pci
,
516 SP_DEVINFO_DATA dev_info_data
;
519 bool partial_pci
= false;
521 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
524 SetupDiEnumDeviceInfo(dev_info
, j
, &dev_info_data
);
526 DWORD addr
, bus
, ui_slot
, type
;
528 size
= sizeof(DWORD
);
531 * There is no need to allocate buffer in the next functions. The
532 * size is known and ULONG according to
533 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
535 if (!SetupDiGetDeviceRegistryProperty(
536 dev_info
, &dev_info_data
, SPDRP_BUSNUMBER
,
537 &type
, (PBYTE
)&bus
, size
, NULL
)) {
538 debug_error("failed to get PCI bus");
544 * The function retrieves the device's address. This value will be
545 * transformed into device function and number
547 if (!SetupDiGetDeviceRegistryProperty(
548 dev_info
, &dev_info_data
, SPDRP_ADDRESS
,
549 &type
, (PBYTE
)&addr
, size
, NULL
)) {
550 debug_error("failed to get PCI address");
556 * This call returns UINumber of DEVICE_CAPABILITIES structure.
557 * This number is typically a user-perceived slot number.
559 if (!SetupDiGetDeviceRegistryProperty(
560 dev_info
, &dev_info_data
, SPDRP_UI_NUMBER
,
561 &type
, (PBYTE
)&ui_slot
, size
, NULL
)) {
562 debug_error("failed to get PCI slot");
568 * SetupApi gives us the same information as driver with
569 * IoGetDeviceProperty. According to Microsoft:
571 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF)
572 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF)
573 * SPDRP_ADDRESS is propertyAddress, so we do the same.
575 * https://docs.microsoft.com/en-us/windows/desktop/api/setupapi/nf-setupapi-setupdigetdeviceregistrypropertya
584 func
= ((int)addr
== -1) ? -1 : addr
& 0x0000FFFF;
585 slot
= ((int)addr
== -1) ? -1 : (addr
>> 16) & 0x0000FFFF;
586 if ((int)ui_slot
!= slot
) {
587 g_debug("mismatch with reported slot values: %d vs %d",
591 pci
->slot
= (int)ui_slot
;
592 pci
->function
= func
;
599 static GuestPCIAddress
*get_empty_pci_address(void)
601 GuestPCIAddress
*pci
= NULL
;
603 pci
= g_malloc0(sizeof(*pci
));
611 static GuestPCIAddress
*get_pci_info(int number
, Error
**errp
)
613 HDEVINFO dev_info
= INVALID_HANDLE_VALUE
;
614 HDEVINFO parent_dev_info
= INVALID_HANDLE_VALUE
;
616 SP_DEVINFO_DATA dev_info_data
;
617 SP_DEVICE_INTERFACE_DATA dev_iface_data
;
620 GuestPCIAddress
*pci
= get_empty_pci_address();
622 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
623 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
624 if (dev_info
== INVALID_HANDLE_VALUE
) {
625 error_setg_win32(errp
, GetLastError(), "failed to get devices tree");
629 g_debug("enumerating devices");
630 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
631 dev_iface_data
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
632 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
633 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA pdev_iface_detail_data
= NULL
;
634 STORAGE_DEVICE_NUMBER sdn
;
635 g_autofree
char *parent_dev_id
= NULL
;
636 SP_DEVINFO_DATA parent_dev_info_data
;
639 g_debug("getting device path");
640 if (SetupDiEnumDeviceInterfaces(dev_info
, &dev_info_data
,
641 &GUID_DEVINTERFACE_DISK
, 0,
643 if (!SetupDiGetDeviceInterfaceDetail(dev_info
, &dev_iface_data
,
644 pdev_iface_detail_data
,
647 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
648 pdev_iface_detail_data
= g_malloc(size
);
649 pdev_iface_detail_data
->cbSize
=
650 sizeof(*pdev_iface_detail_data
);
652 error_setg_win32(errp
, GetLastError(),
653 "failed to get device interfaces");
658 if (!SetupDiGetDeviceInterfaceDetail(dev_info
, &dev_iface_data
,
659 pdev_iface_detail_data
,
662 // pdev_iface_detail_data already is allocated
663 error_setg_win32(errp
, GetLastError(),
664 "failed to get device interfaces");
668 dev_file
= CreateFile(pdev_iface_detail_data
->DevicePath
, 0,
669 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, 0,
672 if (!DeviceIoControl(dev_file
, IOCTL_STORAGE_GET_DEVICE_NUMBER
,
673 NULL
, 0, &sdn
, sizeof(sdn
), &size
, NULL
)) {
674 CloseHandle(dev_file
);
675 error_setg_win32(errp
, GetLastError(),
676 "failed to get device slot number");
680 CloseHandle(dev_file
);
681 if (sdn
.DeviceNumber
!= number
) {
685 error_setg_win32(errp
, GetLastError(),
686 "failed to get device interfaces");
690 g_debug("found device slot %d. Getting storage controller", number
);
693 DEVINST dev_inst
, parent_dev_inst
;
694 ULONG dev_id_size
= 0;
697 if (!SetupDiGetDeviceInstanceId(dev_info
, &dev_info_data
,
698 parent_dev_id
, size
, &size
)) {
699 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
700 parent_dev_id
= g_malloc(size
);
702 error_setg_win32(errp
, GetLastError(),
703 "failed to get device instance ID");
708 if (!SetupDiGetDeviceInstanceId(dev_info
, &dev_info_data
,
709 parent_dev_id
, size
, &size
)) {
710 // parent_dev_id already is allocated
711 error_setg_win32(errp
, GetLastError(),
712 "failed to get device instance ID");
717 * CM API used here as opposed to
718 * SetupDiGetDeviceProperty(..., DEVPKEY_Device_Parent, ...)
719 * which exports are only available in mingw-w64 6+
721 cr
= CM_Locate_DevInst(&dev_inst
, parent_dev_id
, 0);
722 if (cr
!= CR_SUCCESS
) {
723 g_error("CM_Locate_DevInst failed with code %lx", cr
);
724 error_setg_win32(errp
, GetLastError(),
725 "failed to get device instance");
728 cr
= CM_Get_Parent(&parent_dev_inst
, dev_inst
, 0);
729 if (cr
!= CR_SUCCESS
) {
730 g_error("CM_Get_Parent failed with code %lx", cr
);
731 error_setg_win32(errp
, GetLastError(),
732 "failed to get parent device instance");
736 cr
= CM_Get_Device_ID_Size(&dev_id_size
, parent_dev_inst
, 0);
737 if (cr
!= CR_SUCCESS
) {
738 g_error("CM_Get_Device_ID_Size failed with code %lx", cr
);
739 error_setg_win32(errp
, GetLastError(),
740 "failed to get parent device ID length");
745 if (dev_id_size
> size
) {
746 g_free(parent_dev_id
);
747 parent_dev_id
= g_malloc(dev_id_size
);
750 cr
= CM_Get_Device_ID(parent_dev_inst
, parent_dev_id
, dev_id_size
,
752 if (cr
!= CR_SUCCESS
) {
753 g_error("CM_Get_Device_ID failed with code %lx", cr
);
754 error_setg_win32(errp
, GetLastError(),
755 "failed to get parent device ID");
760 g_debug("querying storage controller %s for PCI information",
763 SetupDiGetClassDevs(&GUID_DEVINTERFACE_STORAGEPORT
, parent_dev_id
,
764 NULL
, DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
766 if (parent_dev_info
== INVALID_HANDLE_VALUE
) {
767 error_setg_win32(errp
, GetLastError(),
768 "failed to get parent device");
772 parent_dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
773 if (!SetupDiEnumDeviceInfo(parent_dev_info
, 0, &parent_dev_info_data
)) {
774 error_setg_win32(errp
, GetLastError(),
775 "failed to get parent device data");
779 get_pci_address_for_device(pci
, parent_dev_info
);
785 if (parent_dev_info
!= INVALID_HANDLE_VALUE
) {
786 SetupDiDestroyDeviceInfoList(parent_dev_info
);
788 if (dev_info
!= INVALID_HANDLE_VALUE
) {
789 SetupDiDestroyDeviceInfoList(dev_info
);
794 static void get_disk_properties(HANDLE vol_h
, GuestDiskAddress
*disk
,
797 STORAGE_PROPERTY_QUERY query
;
798 STORAGE_DEVICE_DESCRIPTOR
*dev_desc
, buf
;
800 ULONG size
= sizeof(buf
);
803 query
.PropertyId
= StorageDeviceProperty
;
804 query
.QueryType
= PropertyStandardQuery
;
806 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
807 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
808 size
, &received
, NULL
)) {
809 error_setg_win32(errp
, GetLastError(), "failed to get bus type");
812 disk
->bus_type
= find_bus_type(dev_desc
->BusType
);
813 g_debug("bus type %d", disk
->bus_type
);
815 /* Query once more. Now with long enough buffer. */
816 size
= dev_desc
->Size
;
817 dev_desc
= g_malloc0(size
);
818 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
819 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
820 size
, &received
, NULL
)) {
821 error_setg_win32(errp
, GetLastError(), "failed to get serial number");
822 g_debug("failed to get serial number");
825 if (dev_desc
->SerialNumberOffset
> 0) {
829 if (dev_desc
->SerialNumberOffset
>= received
) {
830 error_setg(errp
, "failed to get serial number: offset outside the buffer");
831 g_debug("serial number offset outside the buffer");
834 serial
= (char *)dev_desc
+ dev_desc
->SerialNumberOffset
;
835 len
= received
- dev_desc
->SerialNumberOffset
;
836 g_debug("serial number \"%s\"", serial
);
838 disk
->serial
= g_strndup(serial
, len
);
847 static void get_single_disk_info(int disk_number
,
848 GuestDiskAddress
*disk
, Error
**errp
)
850 SCSI_ADDRESS addr
, *scsi_ad
;
853 Error
*local_err
= NULL
;
857 g_debug("getting disk info for: %s", disk
->dev
);
858 disk_h
= CreateFile(disk
->dev
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
860 if (disk_h
== INVALID_HANDLE_VALUE
) {
861 error_setg_win32(errp
, GetLastError(), "failed to open disk");
865 get_disk_properties(disk_h
, disk
, &local_err
);
867 error_propagate(errp
, local_err
);
871 g_debug("bus type %d", disk
->bus_type
);
872 /* always set pci_controller as required by schema. get_pci_info() should
873 * report -1 values for non-PCI buses rather than fail. fail the command
874 * if that doesn't hold since that suggests some other unexpected
877 if (disk
->bus_type
== GUEST_DISK_BUS_TYPE_USB
) {
878 disk
->pci_controller
= get_empty_pci_address();
880 disk
->pci_controller
= get_pci_info(disk_number
, &local_err
);
882 error_propagate(errp
, local_err
);
886 if (disk
->bus_type
== GUEST_DISK_BUS_TYPE_SCSI
887 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_IDE
888 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_RAID
889 /* This bus type is not supported before Windows Server 2003 SP1 */
890 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_SAS
892 /* We are able to use the same ioctls for different bus types
893 * according to Microsoft docs
894 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
895 g_debug("getting SCSI info");
896 if (DeviceIoControl(disk_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
897 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
898 disk
->unit
= addr
.Lun
;
899 disk
->target
= addr
.TargetId
;
900 disk
->bus
= addr
.PathId
;
902 /* We do not set error in this case, because we still have enough
903 * information about volume. */
911 /* VSS provider works with volumes, thus there is no difference if
912 * the volume consist of spanned disks. Info about the first disk in the
913 * volume is returned for the spanned disk group (LVM) */
914 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
916 Error
*local_err
= NULL
;
917 GuestDiskAddressList
*list
= NULL
;
918 GuestDiskAddress
*disk
= NULL
;
922 PVOLUME_DISK_EXTENTS extents
= NULL
;
924 /* strip final backslash */
925 char *name
= g_strdup(guid
);
926 if (g_str_has_suffix(name
, "\\")) {
927 name
[strlen(name
) - 1] = 0;
930 g_debug("opening %s", name
);
931 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
933 if (vol_h
== INVALID_HANDLE_VALUE
) {
934 error_setg_win32(errp
, GetLastError(), "failed to open volume");
938 /* Get list of extents */
939 g_debug("getting disk extents");
940 size
= sizeof(VOLUME_DISK_EXTENTS
);
941 extents
= g_malloc0(size
);
942 if (!DeviceIoControl(vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
943 0, extents
, size
, &size
, NULL
)) {
944 DWORD last_err
= GetLastError();
945 if (last_err
== ERROR_MORE_DATA
) {
946 /* Try once more with big enough buffer */
948 extents
= g_malloc0(size
);
949 if (!DeviceIoControl(
950 vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
951 0, extents
, size
, NULL
, NULL
)) {
952 error_setg_win32(errp
, GetLastError(),
953 "failed to get disk extents");
956 } else if (last_err
== ERROR_INVALID_FUNCTION
) {
957 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
958 g_debug("volume not on disk");
959 disk
= g_new0(GuestDiskAddress
, 1);
960 disk
->dev
= g_strdup(name
);
961 get_single_disk_info(0xffffffff, disk
, &local_err
);
963 g_debug("failed to get disk info, ignoring error: %s",
964 error_get_pretty(local_err
));
965 error_free(local_err
);
968 QAPI_LIST_PREPEND(list
, disk
);
972 error_setg_win32(errp
, GetLastError(),
973 "failed to get disk extents");
977 g_debug("Number of extents: %lu", extents
->NumberOfDiskExtents
);
979 /* Go through each extent */
980 for (i
= 0; i
< extents
->NumberOfDiskExtents
; i
++) {
981 disk
= g_new0(GuestDiskAddress
, 1);
983 /* Disk numbers directly correspond to numbers used in UNCs
985 * See documentation for DISK_EXTENT:
986 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
988 * See also Naming Files, Paths and Namespaces:
989 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
991 disk
->dev
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
992 extents
->Extents
[i
].DiskNumber
);
994 get_single_disk_info(extents
->Extents
[i
].DiskNumber
, disk
, &local_err
);
996 error_propagate(errp
, local_err
);
999 QAPI_LIST_PREPEND(list
, disk
);
1005 if (vol_h
!= INVALID_HANDLE_VALUE
) {
1008 qapi_free_GuestDiskAddress(disk
);
1015 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
1017 GuestDiskInfoList
*ret
= NULL
;
1019 SP_DEVICE_INTERFACE_DATA dev_iface_data
;
1022 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
1023 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
1024 if (dev_info
== INVALID_HANDLE_VALUE
) {
1025 error_setg_win32(errp
, GetLastError(), "failed to get device tree");
1029 g_debug("enumerating devices");
1030 dev_iface_data
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
1032 SetupDiEnumDeviceInterfaces(dev_info
, NULL
, &GUID_DEVINTERFACE_DISK
,
1033 i
, &dev_iface_data
);
1035 GuestDiskAddress
*address
= NULL
;
1036 GuestDiskInfo
*disk
= NULL
;
1037 Error
*local_err
= NULL
;
1038 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1039 pdev_iface_detail_data
= NULL
;
1040 STORAGE_DEVICE_NUMBER sdn
;
1046 g_debug(" getting device path");
1047 for (attempt
= 0, result
= FALSE
; attempt
< 2 && !result
; attempt
++) {
1048 result
= SetupDiGetDeviceInterfaceDetail(dev_info
,
1049 &dev_iface_data
, pdev_iface_detail_data
, size
, &size
, NULL
);
1053 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
1054 pdev_iface_detail_data
= g_realloc(pdev_iface_detail_data
,
1056 pdev_iface_detail_data
->cbSize
=
1057 sizeof(*pdev_iface_detail_data
);
1059 g_debug("failed to get device interface details");
1064 g_debug("skipping device");
1068 g_debug(" device: %s", pdev_iface_detail_data
->DevicePath
);
1069 dev_file
= CreateFile(pdev_iface_detail_data
->DevicePath
, 0,
1070 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, 0, NULL
);
1071 if (!DeviceIoControl(dev_file
, IOCTL_STORAGE_GET_DEVICE_NUMBER
,
1072 NULL
, 0, &sdn
, sizeof(sdn
), &size
, NULL
)) {
1073 CloseHandle(dev_file
);
1074 debug_error("failed to get storage device number");
1077 CloseHandle(dev_file
);
1079 disk
= g_new0(GuestDiskInfo
, 1);
1080 disk
->name
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1083 g_debug(" number: %lu", sdn
.DeviceNumber
);
1084 address
= g_new0(GuestDiskAddress
, 1);
1085 address
->dev
= g_strdup(disk
->name
);
1086 get_single_disk_info(sdn
.DeviceNumber
, address
, &local_err
);
1088 g_debug("failed to get disk info: %s",
1089 error_get_pretty(local_err
));
1090 error_free(local_err
);
1091 qapi_free_GuestDiskAddress(address
);
1094 disk
->address
= address
;
1097 QAPI_LIST_PREPEND(ret
, disk
);
1100 SetupDiDestroyDeviceInfoList(dev_info
);
1104 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
1107 char mnt
, *mnt_point
;
1108 wchar_t wfs_name
[32];
1110 wchar_t vol_info
[MAX_PATH
+ 1];
1112 uint64_t i64FreeBytesToCaller
, i64TotalBytes
, i64FreeBytes
;
1113 GuestFilesystemInfo
*fs
= NULL
;
1114 HANDLE hLocalDiskHandle
= INVALID_HANDLE_VALUE
;
1116 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
1117 if (GetLastError() != ERROR_MORE_DATA
) {
1118 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1122 mnt_point
= g_malloc(info_size
+ 1);
1123 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
1125 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1129 hLocalDiskHandle
= CreateFile(guid
, 0 , 0, NULL
, OPEN_EXISTING
,
1130 FILE_ATTRIBUTE_NORMAL
|
1131 FILE_FLAG_BACKUP_SEMANTICS
, NULL
);
1132 if (INVALID_HANDLE_VALUE
== hLocalDiskHandle
) {
1133 error_setg_win32(errp
, GetLastError(), "failed to get handle for volume");
1137 len
= strlen(mnt_point
);
1138 mnt_point
[len
] = '\\';
1139 mnt_point
[len
+ 1] = 0;
1141 if (!GetVolumeInformationByHandleW(hLocalDiskHandle
, vol_info
,
1142 sizeof(vol_info
), NULL
, NULL
, NULL
,
1143 (LPWSTR
) & wfs_name
, sizeof(wfs_name
))) {
1144 if (GetLastError() != ERROR_NOT_READY
) {
1145 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
1150 fs
= g_malloc(sizeof(*fs
));
1151 fs
->name
= g_strdup(guid
);
1152 fs
->has_total_bytes
= false;
1153 fs
->has_used_bytes
= false;
1155 fs
->mountpoint
= g_strdup("System Reserved");
1157 fs
->mountpoint
= g_strndup(mnt_point
, len
);
1158 if (GetDiskFreeSpaceEx(fs
->mountpoint
,
1159 (PULARGE_INTEGER
) & i64FreeBytesToCaller
,
1160 (PULARGE_INTEGER
) & i64TotalBytes
,
1161 (PULARGE_INTEGER
) & i64FreeBytes
)) {
1162 fs
->used_bytes
= i64TotalBytes
- i64FreeBytes
;
1163 fs
->total_bytes
= i64TotalBytes
;
1164 fs
->has_total_bytes
= true;
1165 fs
->has_used_bytes
= true;
1168 wcstombs(fs_name
, wfs_name
, sizeof(wfs_name
));
1169 fs
->type
= g_strdup(fs_name
);
1170 fs
->disk
= build_guest_disk_info(guid
, errp
);
1172 if (hLocalDiskHandle
!= INVALID_HANDLE_VALUE
) {
1173 CloseHandle(hLocalDiskHandle
);
1179 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
1182 GuestFilesystemInfoList
*ret
= NULL
;
1185 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
1186 if (vol_h
== INVALID_HANDLE_VALUE
) {
1187 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1192 Error
*local_err
= NULL
;
1193 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, &local_err
);
1195 g_debug("failed to get filesystem info, ignoring error: %s",
1196 error_get_pretty(local_err
));
1197 error_free(local_err
);
1200 QAPI_LIST_PREPEND(ret
, info
);
1201 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
1203 if (GetLastError() != ERROR_NO_MORE_FILES
) {
1204 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
1207 FindVolumeClose(vol_h
);
1212 * Return status of freeze/thaw
1214 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
1216 if (!vss_initialized()) {
1217 error_setg(errp
, QERR_UNSUPPORTED
);
1221 if (ga_is_frozen(ga_state
)) {
1222 return GUEST_FSFREEZE_STATUS_FROZEN
;
1225 return GUEST_FSFREEZE_STATUS_THAWED
;
1229 * Freeze local file systems using Volume Shadow-copy Service.
1230 * The frozen state is limited for up to 10 seconds by VSS.
1232 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
1234 return qmp_guest_fsfreeze_freeze_list(false, NULL
, errp
);
1237 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
1238 strList
*mountpoints
,
1242 Error
*local_err
= NULL
;
1244 if (!vss_initialized()) {
1245 error_setg(errp
, QERR_UNSUPPORTED
);
1249 slog("guest-fsfreeze called");
1251 /* cannot risk guest agent blocking itself on a write in this state */
1252 ga_set_frozen(ga_state
);
1254 qga_vss_fsfreeze(&i
, true, mountpoints
, &local_err
);
1256 error_propagate(errp
, local_err
);
1264 qmp_guest_fsfreeze_thaw(&local_err
);
1266 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
1267 error_free(local_err
);
1273 * Thaw local file systems using Volume Shadow-copy Service.
1275 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
1279 if (!vss_initialized()) {
1280 error_setg(errp
, QERR_UNSUPPORTED
);
1284 qga_vss_fsfreeze(&i
, false, NULL
, errp
);
1286 ga_unset_frozen(ga_state
);
1290 static void guest_fsfreeze_cleanup(void)
1294 if (!vss_initialized()) {
1298 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
1299 qmp_guest_fsfreeze_thaw(&err
);
1301 slog("failed to clean up frozen filesystems: %s",
1302 error_get_pretty(err
));
1311 * Walk list of mounted file systems in the guest, and discard unused
1314 GuestFilesystemTrimResponse
*
1315 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
1317 GuestFilesystemTrimResponse
*resp
;
1319 WCHAR guid
[MAX_PATH
] = L
"";
1323 ZeroMemory(&osvi
, sizeof(OSVERSIONINFO
));
1324 osvi
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1325 GetVersionEx(&osvi
);
1326 win8_or_later
= (osvi
.dwMajorVersion
> 6 ||
1327 ((osvi
.dwMajorVersion
== 6) &&
1328 (osvi
.dwMinorVersion
>= 2)));
1329 if (!win8_or_later
) {
1330 error_setg(errp
, "fstrim is only supported for Win8+");
1334 handle
= FindFirstVolumeW(guid
, ARRAYSIZE(guid
));
1335 if (handle
== INVALID_HANDLE_VALUE
) {
1336 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1340 resp
= g_new0(GuestFilesystemTrimResponse
, 1);
1343 GuestFilesystemTrimResult
*res
;
1345 DWORD char_count
= 0;
1347 GError
*gerr
= NULL
;
1350 GetVolumePathNamesForVolumeNameW(guid
, NULL
, 0, &char_count
);
1352 if (GetLastError() != ERROR_MORE_DATA
) {
1355 if (GetDriveTypeW(guid
) != DRIVE_FIXED
) {
1359 uc_path
= g_new(WCHAR
, char_count
);
1360 if (!GetVolumePathNamesForVolumeNameW(guid
, uc_path
, char_count
,
1361 &char_count
) || !*uc_path
) {
1362 /* strange, but this condition could be faced even with size == 2 */
1367 res
= g_new0(GuestFilesystemTrimResult
, 1);
1369 path
= g_utf16_to_utf8(uc_path
, char_count
, NULL
, NULL
, &gerr
);
1374 res
->error
= g_strdup(gerr
->message
);
1381 QAPI_LIST_PREPEND(resp
->paths
, res
);
1383 memset(argv
, 0, sizeof(argv
));
1384 argv
[0] = (gchar
*)"defrag.exe";
1385 argv
[1] = (gchar
*)"/L";
1388 if (!g_spawn_sync(NULL
, argv
, NULL
, G_SPAWN_SEARCH_PATH
, NULL
, NULL
,
1389 &out
/* stdout */, NULL
/* stdin */,
1391 res
->error
= g_strdup(gerr
->message
);
1394 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1395 Error is reported in the output with something like
1396 (x89000020) etc code in the stdout */
1399 gchar
**lines
= g_strsplit(out
, "\r\n", 0);
1402 for (i
= 0; lines
[i
] != NULL
; i
++) {
1403 if (g_strstr_len(lines
[i
], -1, "(0x") == NULL
) {
1406 res
->error
= g_strdup(lines
[i
]);
1411 } while (FindNextVolumeW(handle
, guid
, ARRAYSIZE(guid
)));
1413 FindVolumeClose(handle
);
1418 GUEST_SUSPEND_MODE_DISK
,
1419 GUEST_SUSPEND_MODE_RAM
1422 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
1424 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
1426 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
1427 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
1428 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1429 "failed to determine guest suspend capabilities");
1434 case GUEST_SUSPEND_MODE_DISK
:
1435 if (!sys_pwr_caps
.SystemS4
) {
1436 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1437 "suspend-to-disk not supported by OS");
1440 case GUEST_SUSPEND_MODE_RAM
:
1441 if (!sys_pwr_caps
.SystemS3
) {
1442 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1443 "suspend-to-ram not supported by OS");
1451 static DWORD WINAPI
do_suspend(LPVOID opaque
)
1453 GuestSuspendMode
*mode
= opaque
;
1456 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
1457 g_autofree gchar
*emsg
= g_win32_error_message(GetLastError());
1458 slog("failed to suspend guest: %s", emsg
);
1465 void qmp_guest_suspend_disk(Error
**errp
)
1467 Error
*local_err
= NULL
;
1468 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1470 *mode
= GUEST_SUSPEND_MODE_DISK
;
1471 check_suspend_mode(*mode
, &local_err
);
1475 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1479 execute_async(do_suspend
, mode
, &local_err
);
1483 error_propagate(errp
, local_err
);
1488 void qmp_guest_suspend_ram(Error
**errp
)
1490 Error
*local_err
= NULL
;
1491 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1493 *mode
= GUEST_SUSPEND_MODE_RAM
;
1494 check_suspend_mode(*mode
, &local_err
);
1498 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1502 execute_async(do_suspend
, mode
, &local_err
);
1506 error_propagate(errp
, local_err
);
1511 void qmp_guest_suspend_hybrid(Error
**errp
)
1513 error_setg(errp
, QERR_UNSUPPORTED
);
1516 static IP_ADAPTER_ADDRESSES
*guest_get_adapters_addresses(Error
**errp
)
1518 IP_ADAPTER_ADDRESSES
*adptr_addrs
= NULL
;
1519 ULONG adptr_addrs_len
= 0;
1522 /* Call the first time to get the adptr_addrs_len. */
1523 GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1524 NULL
, adptr_addrs
, &adptr_addrs_len
);
1526 adptr_addrs
= g_malloc(adptr_addrs_len
);
1527 ret
= GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1528 NULL
, adptr_addrs
, &adptr_addrs_len
);
1529 if (ret
!= ERROR_SUCCESS
) {
1530 error_setg_win32(errp
, ret
, "failed to get adapters addresses");
1531 g_free(adptr_addrs
);
1537 static char *guest_wctomb_dup(WCHAR
*wstr
)
1542 str_size
= WideCharToMultiByte(CP_UTF8
, 0, wstr
, -1, NULL
, 0, NULL
, NULL
);
1543 /* add 1 to str_size for NULL terminator */
1544 str
= g_malloc(str_size
+ 1);
1545 WideCharToMultiByte(CP_UTF8
, 0, wstr
, -1, str
, str_size
, NULL
, NULL
);
1549 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
,
1552 char addr_str
[INET6_ADDRSTRLEN
+ INET_ADDRSTRLEN
];
1556 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
||
1557 ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1558 len
= sizeof(addr_str
);
1559 ret
= WSAAddressToString(ip_addr
->Address
.lpSockaddr
,
1560 ip_addr
->Address
.iSockaddrLength
,
1565 error_setg_win32(errp
, WSAGetLastError(),
1566 "failed address presentation form conversion");
1569 return g_strdup(addr_str
);
1574 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1576 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1577 * field to obtain the prefix.
1579 return ip_addr
->OnLinkPrefixLength
;
1582 #define INTERFACE_PATH_BUF_SZ 512
1584 static DWORD
get_interface_index(const char *guid
)
1588 wchar_t wbuf
[INTERFACE_PATH_BUF_SZ
];
1589 snwprintf(wbuf
, INTERFACE_PATH_BUF_SZ
, L
"\\device\\tcpip_%s", guid
);
1590 wbuf
[INTERFACE_PATH_BUF_SZ
- 1] = 0;
1591 status
= GetAdapterIndex (wbuf
, &index
);
1592 if (status
!= NO_ERROR
) {
1599 typedef NETIOAPI_API (WINAPI
*GetIfEntry2Func
)(PMIB_IF_ROW2 Row
);
1601 static int guest_get_network_stats(const char *name
,
1602 GuestNetworkInterfaceStat
*stats
)
1604 OSVERSIONINFO os_ver
;
1606 os_ver
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1607 GetVersionEx(&os_ver
);
1608 if (os_ver
.dwMajorVersion
>= 6) {
1609 MIB_IF_ROW2 a_mid_ifrow
;
1610 GetIfEntry2Func getifentry2_ex
;
1612 HMODULE module
= GetModuleHandle("iphlpapi");
1613 PVOID func
= GetProcAddress(module
, "GetIfEntry2");
1619 getifentry2_ex
= (GetIfEntry2Func
)func
;
1620 if_index
= get_interface_index(name
);
1621 if (if_index
== (DWORD
)~0) {
1625 memset(&a_mid_ifrow
, 0, sizeof(a_mid_ifrow
));
1626 a_mid_ifrow
.InterfaceIndex
= if_index
;
1627 if (NO_ERROR
== getifentry2_ex(&a_mid_ifrow
)) {
1628 stats
->rx_bytes
= a_mid_ifrow
.InOctets
;
1629 stats
->rx_packets
= a_mid_ifrow
.InUcastPkts
;
1630 stats
->rx_errs
= a_mid_ifrow
.InErrors
;
1631 stats
->rx_dropped
= a_mid_ifrow
.InDiscards
;
1632 stats
->tx_bytes
= a_mid_ifrow
.OutOctets
;
1633 stats
->tx_packets
= a_mid_ifrow
.OutUcastPkts
;
1634 stats
->tx_errs
= a_mid_ifrow
.OutErrors
;
1635 stats
->tx_dropped
= a_mid_ifrow
.OutDiscards
;
1642 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
1644 IP_ADAPTER_ADDRESSES
*adptr_addrs
, *addr
;
1645 IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
= NULL
;
1646 GuestNetworkInterfaceList
*head
= NULL
, **tail
= &head
;
1647 GuestIpAddressList
*head_addr
, **tail_addr
;
1648 GuestNetworkInterface
*info
;
1649 GuestNetworkInterfaceStat
*interface_stat
= NULL
;
1650 GuestIpAddress
*address_item
= NULL
;
1651 unsigned char *mac_addr
;
1657 adptr_addrs
= guest_get_adapters_addresses(errp
);
1658 if (adptr_addrs
== NULL
) {
1662 /* Make WSA APIs available. */
1663 wsa_version
= MAKEWORD(2, 2);
1664 ret
= WSAStartup(wsa_version
, &wsa_data
);
1666 error_setg_win32(errp
, ret
, "failed socket startup");
1670 for (addr
= adptr_addrs
; addr
; addr
= addr
->Next
) {
1671 info
= g_malloc0(sizeof(*info
));
1673 QAPI_LIST_APPEND(tail
, info
);
1675 info
->name
= guest_wctomb_dup(addr
->FriendlyName
);
1677 if (addr
->PhysicalAddressLength
!= 0) {
1678 mac_addr
= addr
->PhysicalAddress
;
1680 info
->hardware_address
=
1681 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1682 (int) mac_addr
[0], (int) mac_addr
[1],
1683 (int) mac_addr
[2], (int) mac_addr
[3],
1684 (int) mac_addr
[4], (int) mac_addr
[5]);
1688 tail_addr
= &head_addr
;
1689 for (ip_addr
= addr
->FirstUnicastAddress
;
1691 ip_addr
= ip_addr
->Next
) {
1692 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1693 if (addr_str
== NULL
) {
1697 address_item
= g_malloc0(sizeof(*address_item
));
1699 QAPI_LIST_APPEND(tail_addr
, address_item
);
1701 address_item
->ip_address
= addr_str
;
1702 address_item
->prefix
= guest_ip_prefix(ip_addr
);
1703 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1704 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV4
;
1705 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1706 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV6
;
1710 info
->has_ip_addresses
= true;
1711 info
->ip_addresses
= head_addr
;
1713 if (!info
->statistics
) {
1714 interface_stat
= g_malloc0(sizeof(*interface_stat
));
1715 if (guest_get_network_stats(addr
->AdapterName
, interface_stat
)
1717 g_free(interface_stat
);
1719 info
->statistics
= interface_stat
;
1725 g_free(adptr_addrs
);
1729 static int64_t filetime_to_ns(const FILETIME
*tf
)
1731 return ((((int64_t)tf
->dwHighDateTime
<< 32) | tf
->dwLowDateTime
)
1732 - W32_FT_OFFSET
) * 100;
1735 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
1737 Error
*local_err
= NULL
;
1743 /* Unfortunately, Windows libraries don't provide an easy way to access
1746 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1748 * Instead, a workaround is to use the Windows win32tm command to
1749 * resync the time using the Windows Time service.
1754 HRESULT hr
= system("w32tm /resync /nowait");
1756 if (GetLastError() != 0) {
1757 strerror_s((LPTSTR
) & msg_buffer
, 0, errno
);
1758 error_setg(errp
, "system(...) failed: %s", (LPCTSTR
)msg_buffer
);
1759 } else if (hr
!= 0) {
1760 if (hr
== HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE
)) {
1761 error_setg(errp
, "Windows Time service not running on the "
1764 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1765 FORMAT_MESSAGE_FROM_SYSTEM
|
1766 FORMAT_MESSAGE_IGNORE_INSERTS
, NULL
,
1767 (DWORD
)hr
, MAKELANGID(LANG_NEUTRAL
,
1768 SUBLANG_DEFAULT
), (LPTSTR
) & msg_buffer
, 0,
1770 error_setg(errp
, "w32tm failed with error (0x%lx), couldn'"
1771 "t retrieve error message", hr
);
1773 error_setg(errp
, "w32tm failed with error (0x%lx): %s", hr
,
1774 (LPCTSTR
)msg_buffer
);
1775 LocalFree(msg_buffer
);
1778 } else if (!InternetGetConnectedState(&ret_flags
, 0)) {
1779 error_setg(errp
, "No internet connection on guest, sync not "
1785 /* Validate time passed by user. */
1786 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
1787 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
1791 time
= time_ns
/ 100 + W32_FT_OFFSET
;
1793 tf
.dwLowDateTime
= (DWORD
) time
;
1794 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
1796 if (!FileTimeToSystemTime(&tf
, &ts
)) {
1797 error_setg(errp
, "Failed to convert system time %d",
1798 (int)GetLastError());
1802 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
1804 error_propagate(errp
, local_err
);
1808 if (!SetSystemTime(&ts
)) {
1809 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
1814 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
1816 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi
, ptr
;
1818 GuestLogicalProcessorList
*head
, **tail
;
1819 Error
*local_err
= NULL
;
1828 if ((GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) &&
1829 (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) &&
1830 (length
> sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
))) {
1831 ptr
= pslpi
= g_malloc0(length
);
1832 if (GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) {
1833 error_setg(&local_err
, "Failed to get processor information: %d",
1834 (int)GetLastError());
1837 error_setg(&local_err
,
1838 "Failed to get processor information buffer length: %d",
1839 (int)GetLastError());
1842 while ((local_err
== NULL
) && (length
> 0)) {
1843 if (pslpi
->Relationship
== RelationProcessorCore
) {
1844 ULONG_PTR cpu_bits
= pslpi
->ProcessorMask
;
1846 while (cpu_bits
> 0) {
1847 if (!!(cpu_bits
& 1)) {
1848 GuestLogicalProcessor
*vcpu
;
1850 vcpu
= g_malloc0(sizeof *vcpu
);
1851 vcpu
->logical_id
= current
++;
1852 vcpu
->online
= true;
1853 vcpu
->has_can_offline
= true;
1855 QAPI_LIST_APPEND(tail
, vcpu
);
1860 length
-= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
);
1861 pslpi
++; /* next entry */
1866 if (local_err
== NULL
) {
1870 /* there's no guest with zero VCPUs */
1871 error_setg(&local_err
, "Guest reported zero VCPUs");
1874 qapi_free_GuestLogicalProcessorList(head
);
1875 error_propagate(errp
, local_err
);
1879 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
1881 error_setg(errp
, QERR_UNSUPPORTED
);
1886 get_net_error_message(gint error
)
1888 HMODULE module
= NULL
;
1889 gchar
*retval
= NULL
;
1890 wchar_t *msg
= NULL
;
1894 flags
= FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1895 FORMAT_MESSAGE_IGNORE_INSERTS
|
1896 FORMAT_MESSAGE_FROM_SYSTEM
;
1898 if (error
>= NERR_BASE
&& error
<= MAX_NERR
) {
1899 module
= LoadLibraryExW(L
"netmsg.dll", NULL
, LOAD_LIBRARY_AS_DATAFILE
);
1901 if (module
!= NULL
) {
1902 flags
|= FORMAT_MESSAGE_FROM_HMODULE
;
1906 FormatMessageW(flags
, module
, error
, 0, (LPWSTR
)&msg
, 0, NULL
);
1909 nchars
= wcslen(msg
);
1912 msg
[nchars
- 1] == L
'\n' &&
1913 msg
[nchars
- 2] == L
'\r') {
1914 msg
[nchars
- 2] = L
'\0';
1917 retval
= g_utf16_to_utf8(msg
, -1, NULL
, NULL
, NULL
);
1922 if (module
!= NULL
) {
1923 FreeLibrary(module
);
1929 void qmp_guest_set_user_password(const char *username
,
1930 const char *password
,
1935 char *rawpasswddata
= NULL
;
1936 size_t rawpasswdlen
;
1937 wchar_t *user
= NULL
, *wpass
= NULL
;
1938 USER_INFO_1003 pi1003
= { 0, };
1939 GError
*gerr
= NULL
;
1942 error_setg(errp
, QERR_UNSUPPORTED
);
1946 rawpasswddata
= (char *)qbase64_decode(password
, -1, &rawpasswdlen
, errp
);
1947 if (!rawpasswddata
) {
1950 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
1951 rawpasswddata
[rawpasswdlen
] = '\0';
1953 user
= g_utf8_to_utf16(username
, -1, NULL
, NULL
, &gerr
);
1958 wpass
= g_utf8_to_utf16(rawpasswddata
, -1, NULL
, NULL
, &gerr
);
1963 pi1003
.usri1003_password
= wpass
;
1964 nas
= NetUserSetInfo(NULL
, user
,
1965 1003, (LPBYTE
)&pi1003
,
1968 if (nas
!= NERR_Success
) {
1969 gchar
*msg
= get_net_error_message(nas
);
1970 error_setg(errp
, "failed to set password: %s", msg
);
1976 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
1981 g_free(rawpasswddata
);
1984 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
1986 error_setg(errp
, QERR_UNSUPPORTED
);
1990 GuestMemoryBlockResponseList
*
1991 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
1993 error_setg(errp
, QERR_UNSUPPORTED
);
1997 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
1999 error_setg(errp
, QERR_UNSUPPORTED
);
2003 /* add unsupported commands to the list of blocked RPCs */
2004 GList
*ga_command_init_blockedrpcs(GList
*blockedrpcs
)
2006 const char *list_unsupported
[] = {
2007 "guest-suspend-hybrid",
2009 "guest-get-memory-blocks", "guest-set-memory-blocks",
2010 "guest-get-memory-block-size", "guest-get-memory-block-info",
2012 char **p
= (char **)list_unsupported
;
2015 blockedrpcs
= g_list_append(blockedrpcs
, g_strdup(*p
++));
2018 if (!vss_init(true)) {
2019 g_debug("vss_init failed, vss commands are going to be disabled");
2020 const char *list
[] = {
2021 "guest-get-fsinfo", "guest-fsfreeze-status",
2022 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL
};
2026 blockedrpcs
= g_list_append(blockedrpcs
, g_strdup(*p
++));
2033 /* register init/cleanup routines for stateful command groups */
2034 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
2036 if (!vss_initialized()) {
2037 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);
2041 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
2042 typedef struct _GA_WTSINFOA
{
2043 WTS_CONNECTSTATE_CLASS State
;
2045 DWORD IncomingBytes
;
2046 DWORD OutgoingBytes
;
2047 DWORD IncomingFrames
;
2048 DWORD OutgoingFrames
;
2049 DWORD IncomingCompressedBytes
;
2050 DWORD OutgoingCompressedBy
;
2051 CHAR WinStationName
[WINSTATIONNAME_LENGTH
];
2052 CHAR Domain
[DOMAIN_LENGTH
];
2053 CHAR UserName
[USERNAME_LENGTH
+ 1];
2054 LARGE_INTEGER ConnectTime
;
2055 LARGE_INTEGER DisconnectTime
;
2056 LARGE_INTEGER LastInputTime
;
2057 LARGE_INTEGER LogonTime
;
2058 LARGE_INTEGER CurrentTime
;
2062 GuestUserList
*qmp_guest_get_users(Error
**errp
)
2064 #define QGA_NANOSECONDS 10000000
2066 GHashTable
*cache
= NULL
;
2067 GuestUserList
*head
= NULL
, **tail
= &head
;
2069 DWORD buffer_size
= 0, count
= 0, i
= 0;
2070 GA_WTSINFOA
*info
= NULL
;
2071 WTS_SESSION_INFOA
*entries
= NULL
;
2072 GuestUser
*user
= NULL
;
2073 gpointer value
= NULL
;
2075 double login_time
= 0;
2077 cache
= g_hash_table_new(g_str_hash
, g_str_equal
);
2079 if (WTSEnumerateSessionsA(NULL
, 0, 1, &entries
, &count
)) {
2080 for (i
= 0; i
< count
; ++i
) {
2083 if (WTSQuerySessionInformationA(
2085 entries
[i
].SessionId
,
2091 if (strlen(info
->UserName
) == 0) {
2092 WTSFreeMemory(info
);
2096 login
= info
->LogonTime
.QuadPart
;
2097 login
-= W32_FT_OFFSET
;
2098 login_time
= ((double)login
) / QGA_NANOSECONDS
;
2100 if (g_hash_table_contains(cache
, info
->UserName
)) {
2101 value
= g_hash_table_lookup(cache
, info
->UserName
);
2102 user
= (GuestUser
*)value
;
2103 if (user
->login_time
> login_time
) {
2104 user
->login_time
= login_time
;
2107 user
= g_new0(GuestUser
, 1);
2109 user
->user
= g_strdup(info
->UserName
);
2110 user
->domain
= g_strdup(info
->Domain
);
2112 user
->login_time
= login_time
;
2114 g_hash_table_add(cache
, user
->user
);
2116 QAPI_LIST_APPEND(tail
, user
);
2119 WTSFreeMemory(info
);
2121 WTSFreeMemory(entries
);
2123 g_hash_table_destroy(cache
);
2127 typedef struct _ga_matrix_lookup_t
{
2130 char const *version
;
2131 char const *version_id
;
2132 } ga_matrix_lookup_t
;
2134 static ga_matrix_lookup_t
const WIN_VERSION_MATRIX
[2][7] = {
2136 /* Desktop editions */
2137 { 5, 0, "Microsoft Windows 2000", "2000"},
2138 { 5, 1, "Microsoft Windows XP", "xp"},
2139 { 6, 0, "Microsoft Windows Vista", "vista"},
2140 { 6, 1, "Microsoft Windows 7" "7"},
2141 { 6, 2, "Microsoft Windows 8", "8"},
2142 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2145 /* Server editions */
2146 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2147 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2148 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2149 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2150 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2156 typedef struct _ga_win_10_0_t
{
2158 char const *version
;
2159 char const *version_id
;
2162 static ga_win_10_0_t
const WIN_10_0_SERVER_VERSION_MATRIX
[4] = {
2163 {14393, "Microsoft Windows Server 2016", "2016"},
2164 {17763, "Microsoft Windows Server 2019", "2019"},
2165 {20344, "Microsoft Windows Server 2022", "2022"},
2169 static ga_win_10_0_t
const WIN_10_0_CLIENT_VERSION_MATRIX
[3] = {
2170 {10240, "Microsoft Windows 10", "10"},
2171 {22000, "Microsoft Windows 11", "11"},
2175 static void ga_get_win_version(RTL_OSVERSIONINFOEXW
*info
, Error
**errp
)
2177 typedef NTSTATUS(WINAPI
*rtl_get_version_t
)(
2178 RTL_OSVERSIONINFOEXW
*os_version_info_ex
);
2180 info
->dwOSVersionInfoSize
= sizeof(RTL_OSVERSIONINFOEXW
);
2182 HMODULE module
= GetModuleHandle("ntdll");
2183 PVOID fun
= GetProcAddress(module
, "RtlGetVersion");
2185 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
2186 "Failed to get address of RtlGetVersion");
2190 rtl_get_version_t rtl_get_version
= (rtl_get_version_t
)fun
;
2191 rtl_get_version(info
);
2195 static char *ga_get_win_name(OSVERSIONINFOEXW
const *os_version
, bool id
)
2197 DWORD major
= os_version
->dwMajorVersion
;
2198 DWORD minor
= os_version
->dwMinorVersion
;
2199 DWORD build
= os_version
->dwBuildNumber
;
2200 int tbl_idx
= (os_version
->wProductType
!= VER_NT_WORKSTATION
);
2201 ga_matrix_lookup_t
const *table
= WIN_VERSION_MATRIX
[tbl_idx
];
2202 ga_win_10_0_t
const *win_10_0_table
= tbl_idx
?
2203 WIN_10_0_SERVER_VERSION_MATRIX
: WIN_10_0_CLIENT_VERSION_MATRIX
;
2204 ga_win_10_0_t
const *win_10_0_version
= NULL
;
2205 while (table
->version
!= NULL
) {
2206 if (major
== 10 && minor
== 0) {
2207 while (win_10_0_table
->version
!= NULL
) {
2208 if (build
>= win_10_0_table
->first_build
) {
2209 win_10_0_version
= win_10_0_table
;
2213 if (win_10_0_table
) {
2215 return g_strdup(win_10_0_version
->version_id
);
2217 return g_strdup(win_10_0_version
->version
);
2220 } else if (major
== table
->major
&& minor
== table
->minor
) {
2222 return g_strdup(table
->version_id
);
2224 return g_strdup(table
->version
);
2229 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2231 return g_strdup("N/A");
2234 static char *ga_get_win_product_name(Error
**errp
)
2236 HKEY key
= INVALID_HANDLE_VALUE
;
2238 char *result
= g_malloc0(size
);
2239 LONG err
= ERROR_SUCCESS
;
2241 err
= RegOpenKeyA(HKEY_LOCAL_MACHINE
,
2242 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2244 if (err
!= ERROR_SUCCESS
) {
2245 error_setg_win32(errp
, err
, "failed to open registry key");
2250 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2251 (LPBYTE
)result
, &size
);
2252 if (err
== ERROR_MORE_DATA
) {
2253 slog("ProductName longer than expected (%lu bytes), retrying",
2258 result
= g_malloc0(size
);
2259 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2260 (LPBYTE
)result
, &size
);
2263 if (err
!= ERROR_SUCCESS
) {
2264 error_setg_win32(errp
, err
, "failed to retrive ProductName");
2272 if (key
!= INVALID_HANDLE_VALUE
) {
2279 static char *ga_get_current_arch(void)
2282 GetNativeSystemInfo(&info
);
2283 char *result
= NULL
;
2284 switch (info
.wProcessorArchitecture
) {
2285 case PROCESSOR_ARCHITECTURE_AMD64
:
2286 result
= g_strdup("x86_64");
2288 case PROCESSOR_ARCHITECTURE_ARM
:
2289 result
= g_strdup("arm");
2291 case PROCESSOR_ARCHITECTURE_IA64
:
2292 result
= g_strdup("ia64");
2294 case PROCESSOR_ARCHITECTURE_INTEL
:
2295 result
= g_strdup("x86");
2297 case PROCESSOR_ARCHITECTURE_UNKNOWN
:
2299 slog("unknown processor architecture 0x%0x",
2300 info
.wProcessorArchitecture
);
2301 result
= g_strdup("unknown");
2307 GuestOSInfo
*qmp_guest_get_osinfo(Error
**errp
)
2309 Error
*local_err
= NULL
;
2310 OSVERSIONINFOEXW os_version
= {0};
2315 ga_get_win_version(&os_version
, &local_err
);
2317 error_propagate(errp
, local_err
);
2321 server
= os_version
.wProductType
!= VER_NT_WORKSTATION
;
2322 product_name
= ga_get_win_product_name(errp
);
2323 if (product_name
== NULL
) {
2327 info
= g_new0(GuestOSInfo
, 1);
2329 info
->kernel_version
= g_strdup_printf("%lu.%lu",
2330 os_version
.dwMajorVersion
,
2331 os_version
.dwMinorVersion
);
2332 info
->kernel_release
= g_strdup_printf("%lu",
2333 os_version
.dwBuildNumber
);
2334 info
->machine
= ga_get_current_arch();
2336 info
->id
= g_strdup("mswindows");
2337 info
->name
= g_strdup("Microsoft Windows");
2338 info
->pretty_name
= product_name
;
2339 info
->version
= ga_get_win_name(&os_version
, false);
2340 info
->version_id
= ga_get_win_name(&os_version
, true);
2341 info
->variant
= g_strdup(server
? "server" : "client");
2342 info
->variant_id
= g_strdup(server
? "server" : "client");
2348 * Safely get device property. Returned strings are using wide characters.
2349 * Caller is responsible for freeing the buffer.
2351 static LPBYTE
cm_get_property(DEVINST devInst
, const DEVPROPKEY
*propName
,
2352 PDEVPROPTYPE propType
)
2355 g_autofree LPBYTE buffer
= NULL
;
2356 ULONG buffer_len
= 0;
2358 /* First query for needed space */
2359 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2360 buffer
, &buffer_len
, 0);
2361 if (cr
!= CR_SUCCESS
&& cr
!= CR_BUFFER_SMALL
) {
2363 slog("failed to get property size, error=0x%lx", cr
);
2366 buffer
= g_new0(BYTE
, buffer_len
+ 1);
2367 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2368 buffer
, &buffer_len
, 0);
2369 if (cr
!= CR_SUCCESS
) {
2370 slog("failed to get device property, error=0x%lx", cr
);
2373 return g_steal_pointer(&buffer
);
2376 static GStrv
ga_get_hardware_ids(DEVINST devInstance
)
2378 GArray
*values
= NULL
;
2379 DEVPROPTYPE cm_type
;
2381 g_autofree LPWSTR property
= (LPWSTR
)cm_get_property(devInstance
,
2382 &qga_DEVPKEY_Device_HardwareIds
, &cm_type
);
2383 if (property
== NULL
) {
2384 slog("failed to get hardware IDs");
2387 if (*property
== '\0') {
2391 values
= g_array_new(TRUE
, TRUE
, sizeof(gchar
*));
2392 for (id
= property
; '\0' != *id
; id
+= lstrlenW(id
) + 1) {
2393 gchar
*id8
= g_utf16_to_utf8(id
, -1, NULL
, NULL
, NULL
);
2394 g_array_append_val(values
, id8
);
2396 return (GStrv
)g_array_free(values
, FALSE
);
2400 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2402 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2404 GuestDeviceInfoList
*qmp_guest_get_devices(Error
**errp
)
2406 GuestDeviceInfoList
*head
= NULL
, **tail
= &head
;
2407 HDEVINFO dev_info
= INVALID_HANDLE_VALUE
;
2408 SP_DEVINFO_DATA dev_info_data
;
2410 GError
*gerr
= NULL
;
2411 g_autoptr(GRegex
) device_pci_re
= NULL
;
2412 DEVPROPTYPE cm_type
;
2414 device_pci_re
= g_regex_new(DEVICE_PCI_RE
,
2415 G_REGEX_ANCHORED
| G_REGEX_OPTIMIZE
, 0,
2417 g_assert(device_pci_re
!= NULL
);
2419 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
2420 dev_info
= SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT
| DIGCF_ALLCLASSES
);
2421 if (dev_info
== INVALID_HANDLE_VALUE
) {
2422 error_setg(errp
, "failed to get device tree");
2426 slog("enumerating devices");
2427 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
2429 g_autofree LPWSTR name
= NULL
;
2430 g_autofree LPFILETIME date
= NULL
;
2431 g_autofree LPWSTR version
= NULL
;
2432 g_auto(GStrv
) hw_ids
= NULL
;
2433 g_autoptr(GuestDeviceInfo
) device
= g_new0(GuestDeviceInfo
, 1);
2434 g_autofree
char *vendor_id
= NULL
;
2435 g_autofree
char *device_id
= NULL
;
2437 name
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2438 &qga_DEVPKEY_NAME
, &cm_type
);
2440 slog("failed to get device description");
2443 device
->driver_name
= g_utf16_to_utf8(name
, -1, NULL
, NULL
, NULL
);
2444 if (device
->driver_name
== NULL
) {
2445 error_setg(errp
, "conversion to utf8 failed (driver name)");
2448 slog("querying device: %s", device
->driver_name
);
2449 hw_ids
= ga_get_hardware_ids(dev_info_data
.DevInst
);
2450 if (hw_ids
== NULL
) {
2453 for (j
= 0; hw_ids
[j
] != NULL
; j
++) {
2454 g_autoptr(GMatchInfo
) match_info
;
2455 GuestDeviceIdPCI
*id
;
2456 if (!g_regex_match(device_pci_re
, hw_ids
[j
], 0, &match_info
)) {
2461 vendor_id
= g_match_info_fetch(match_info
, 1);
2462 device_id
= g_match_info_fetch(match_info
, 2);
2464 device
->id
= g_new0(GuestDeviceId
, 1);
2465 device
->id
->type
= GUEST_DEVICE_TYPE_PCI
;
2466 id
= &device
->id
->u
.pci
;
2467 id
->vendor_id
= g_ascii_strtoull(vendor_id
, NULL
, 16);
2468 id
->device_id
= g_ascii_strtoull(device_id
, NULL
, 16);
2476 version
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2477 &qga_DEVPKEY_Device_DriverVersion
, &cm_type
);
2478 if (version
== NULL
) {
2479 slog("failed to get driver version");
2482 device
->driver_version
= g_utf16_to_utf8(version
, -1, NULL
,
2484 if (device
->driver_version
== NULL
) {
2485 error_setg(errp
, "conversion to utf8 failed (driver version)");
2489 date
= (LPFILETIME
)cm_get_property(dev_info_data
.DevInst
,
2490 &qga_DEVPKEY_Device_DriverDate
, &cm_type
);
2492 slog("failed to get driver date");
2495 device
->driver_date
= filetime_to_ns(date
);
2496 device
->has_driver_date
= true;
2498 slog("driver: %s\ndriver version: %" PRId64
",%s\n",
2499 device
->driver_name
, device
->driver_date
,
2500 device
->driver_version
);
2501 QAPI_LIST_APPEND(tail
, g_steal_pointer(&device
));
2504 if (dev_info
!= INVALID_HANDLE_VALUE
) {
2505 SetupDiDestroyDeviceInfoList(dev_info
);
2510 char *qga_get_host_name(Error
**errp
)
2512 wchar_t tmp
[MAX_COMPUTERNAME_LENGTH
+ 1];
2513 DWORD size
= G_N_ELEMENTS(tmp
);
2515 if (GetComputerNameW(tmp
, &size
) == 0) {
2516 error_setg_win32(errp
, GetLastError(), "failed close handle");
2520 return g_utf16_to_utf8(tmp
, size
, NULL
, NULL
, NULL
);
2523 GuestDiskStatsInfoList
*qmp_guest_get_diskstats(Error
**errp
)
2525 error_setg(errp
, QERR_UNSUPPORTED
);
2529 GuestCpuStatsList
*qmp_guest_get_cpustats(Error
**errp
)
2531 error_setg(errp
, QERR_UNSUPPORTED
);