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 disk
->pci_controller
= get_pci_info(disk_number
, &local_err
);
879 error_propagate(errp
, local_err
);
882 if (disk
->bus_type
== GUEST_DISK_BUS_TYPE_SCSI
883 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_IDE
884 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_RAID
885 /* This bus type is not supported before Windows Server 2003 SP1 */
886 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_SAS
888 /* We are able to use the same ioctls for different bus types
889 * according to Microsoft docs
890 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
891 g_debug("getting SCSI info");
892 if (DeviceIoControl(disk_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
893 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
894 disk
->unit
= addr
.Lun
;
895 disk
->target
= addr
.TargetId
;
896 disk
->bus
= addr
.PathId
;
898 /* We do not set error in this case, because we still have enough
899 * information about volume. */
907 /* VSS provider works with volumes, thus there is no difference if
908 * the volume consist of spanned disks. Info about the first disk in the
909 * volume is returned for the spanned disk group (LVM) */
910 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
912 Error
*local_err
= NULL
;
913 GuestDiskAddressList
*list
= NULL
;
914 GuestDiskAddress
*disk
= NULL
;
918 PVOLUME_DISK_EXTENTS extents
= NULL
;
920 /* strip final backslash */
921 char *name
= g_strdup(guid
);
922 if (g_str_has_suffix(name
, "\\")) {
923 name
[strlen(name
) - 1] = 0;
926 g_debug("opening %s", name
);
927 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
929 if (vol_h
== INVALID_HANDLE_VALUE
) {
930 error_setg_win32(errp
, GetLastError(), "failed to open volume");
934 /* Get list of extents */
935 g_debug("getting disk extents");
936 size
= sizeof(VOLUME_DISK_EXTENTS
);
937 extents
= g_malloc0(size
);
938 if (!DeviceIoControl(vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
939 0, extents
, size
, &size
, NULL
)) {
940 DWORD last_err
= GetLastError();
941 if (last_err
== ERROR_MORE_DATA
) {
942 /* Try once more with big enough buffer */
944 extents
= g_malloc0(size
);
945 if (!DeviceIoControl(
946 vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
947 0, extents
, size
, NULL
, NULL
)) {
948 error_setg_win32(errp
, GetLastError(),
949 "failed to get disk extents");
952 } else if (last_err
== ERROR_INVALID_FUNCTION
) {
953 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
954 g_debug("volume not on disk");
955 disk
= g_new0(GuestDiskAddress
, 1);
956 disk
->dev
= g_strdup(name
);
957 get_single_disk_info(0xffffffff, disk
, &local_err
);
959 g_debug("failed to get disk info, ignoring error: %s",
960 error_get_pretty(local_err
));
961 error_free(local_err
);
964 QAPI_LIST_PREPEND(list
, disk
);
968 error_setg_win32(errp
, GetLastError(),
969 "failed to get disk extents");
973 g_debug("Number of extents: %lu", extents
->NumberOfDiskExtents
);
975 /* Go through each extent */
976 for (i
= 0; i
< extents
->NumberOfDiskExtents
; i
++) {
977 disk
= g_new0(GuestDiskAddress
, 1);
979 /* Disk numbers directly correspond to numbers used in UNCs
981 * See documentation for DISK_EXTENT:
982 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
984 * See also Naming Files, Paths and Namespaces:
985 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
987 disk
->dev
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
988 extents
->Extents
[i
].DiskNumber
);
990 get_single_disk_info(extents
->Extents
[i
].DiskNumber
, disk
, &local_err
);
992 error_propagate(errp
, local_err
);
995 QAPI_LIST_PREPEND(list
, disk
);
1001 if (vol_h
!= INVALID_HANDLE_VALUE
) {
1004 qapi_free_GuestDiskAddress(disk
);
1011 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
1013 GuestDiskInfoList
*ret
= NULL
;
1015 SP_DEVICE_INTERFACE_DATA dev_iface_data
;
1018 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
1019 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
1020 if (dev_info
== INVALID_HANDLE_VALUE
) {
1021 error_setg_win32(errp
, GetLastError(), "failed to get device tree");
1025 g_debug("enumerating devices");
1026 dev_iface_data
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
1028 SetupDiEnumDeviceInterfaces(dev_info
, NULL
, &GUID_DEVINTERFACE_DISK
,
1029 i
, &dev_iface_data
);
1031 GuestDiskAddress
*address
= NULL
;
1032 GuestDiskInfo
*disk
= NULL
;
1033 Error
*local_err
= NULL
;
1034 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1035 pdev_iface_detail_data
= NULL
;
1036 STORAGE_DEVICE_NUMBER sdn
;
1042 g_debug(" getting device path");
1043 for (attempt
= 0, result
= FALSE
; attempt
< 2 && !result
; attempt
++) {
1044 result
= SetupDiGetDeviceInterfaceDetail(dev_info
,
1045 &dev_iface_data
, pdev_iface_detail_data
, size
, &size
, NULL
);
1049 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
1050 pdev_iface_detail_data
= g_realloc(pdev_iface_detail_data
,
1052 pdev_iface_detail_data
->cbSize
=
1053 sizeof(*pdev_iface_detail_data
);
1055 g_debug("failed to get device interface details");
1060 g_debug("skipping device");
1064 g_debug(" device: %s", pdev_iface_detail_data
->DevicePath
);
1065 dev_file
= CreateFile(pdev_iface_detail_data
->DevicePath
, 0,
1066 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, 0, NULL
);
1067 if (!DeviceIoControl(dev_file
, IOCTL_STORAGE_GET_DEVICE_NUMBER
,
1068 NULL
, 0, &sdn
, sizeof(sdn
), &size
, NULL
)) {
1069 CloseHandle(dev_file
);
1070 debug_error("failed to get storage device number");
1073 CloseHandle(dev_file
);
1075 disk
= g_new0(GuestDiskInfo
, 1);
1076 disk
->name
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1079 g_debug(" number: %lu", sdn
.DeviceNumber
);
1080 address
= g_new0(GuestDiskAddress
, 1);
1081 address
->dev
= g_strdup(disk
->name
);
1082 get_single_disk_info(sdn
.DeviceNumber
, address
, &local_err
);
1084 g_debug("failed to get disk info: %s",
1085 error_get_pretty(local_err
));
1086 error_free(local_err
);
1087 qapi_free_GuestDiskAddress(address
);
1090 disk
->address
= address
;
1093 QAPI_LIST_PREPEND(ret
, disk
);
1096 SetupDiDestroyDeviceInfoList(dev_info
);
1100 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
1103 char mnt
, *mnt_point
;
1104 wchar_t wfs_name
[32];
1106 wchar_t vol_info
[MAX_PATH
+ 1];
1108 uint64_t i64FreeBytesToCaller
, i64TotalBytes
, i64FreeBytes
;
1109 GuestFilesystemInfo
*fs
= NULL
;
1110 HANDLE hLocalDiskHandle
= INVALID_HANDLE_VALUE
;
1112 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
1113 if (GetLastError() != ERROR_MORE_DATA
) {
1114 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1118 mnt_point
= g_malloc(info_size
+ 1);
1119 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
1121 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1125 hLocalDiskHandle
= CreateFile(guid
, 0 , 0, NULL
, OPEN_EXISTING
,
1126 FILE_ATTRIBUTE_NORMAL
|
1127 FILE_FLAG_BACKUP_SEMANTICS
, NULL
);
1128 if (INVALID_HANDLE_VALUE
== hLocalDiskHandle
) {
1129 error_setg_win32(errp
, GetLastError(), "failed to get handle for volume");
1133 len
= strlen(mnt_point
);
1134 mnt_point
[len
] = '\\';
1135 mnt_point
[len
+ 1] = 0;
1137 if (!GetVolumeInformationByHandleW(hLocalDiskHandle
, vol_info
,
1138 sizeof(vol_info
), NULL
, NULL
, NULL
,
1139 (LPWSTR
) & wfs_name
, sizeof(wfs_name
))) {
1140 if (GetLastError() != ERROR_NOT_READY
) {
1141 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
1146 fs
= g_malloc(sizeof(*fs
));
1147 fs
->name
= g_strdup(guid
);
1148 fs
->has_total_bytes
= false;
1149 fs
->has_used_bytes
= false;
1151 fs
->mountpoint
= g_strdup("System Reserved");
1153 fs
->mountpoint
= g_strndup(mnt_point
, len
);
1154 if (GetDiskFreeSpaceEx(fs
->mountpoint
,
1155 (PULARGE_INTEGER
) & i64FreeBytesToCaller
,
1156 (PULARGE_INTEGER
) & i64TotalBytes
,
1157 (PULARGE_INTEGER
) & i64FreeBytes
)) {
1158 fs
->used_bytes
= i64TotalBytes
- i64FreeBytes
;
1159 fs
->total_bytes
= i64TotalBytes
;
1160 fs
->has_total_bytes
= true;
1161 fs
->has_used_bytes
= true;
1164 wcstombs(fs_name
, wfs_name
, sizeof(wfs_name
));
1165 fs
->type
= g_strdup(fs_name
);
1166 fs
->disk
= build_guest_disk_info(guid
, errp
);
1168 if (hLocalDiskHandle
!= INVALID_HANDLE_VALUE
) {
1169 CloseHandle(hLocalDiskHandle
);
1175 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
1178 GuestFilesystemInfoList
*ret
= NULL
;
1181 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
1182 if (vol_h
== INVALID_HANDLE_VALUE
) {
1183 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1188 Error
*local_err
= NULL
;
1189 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, &local_err
);
1191 g_debug("failed to get filesystem info, ignoring error: %s",
1192 error_get_pretty(local_err
));
1193 error_free(local_err
);
1196 QAPI_LIST_PREPEND(ret
, info
);
1197 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
1199 if (GetLastError() != ERROR_NO_MORE_FILES
) {
1200 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
1203 FindVolumeClose(vol_h
);
1208 * Return status of freeze/thaw
1210 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
1212 if (!vss_initialized()) {
1213 error_setg(errp
, QERR_UNSUPPORTED
);
1217 if (ga_is_frozen(ga_state
)) {
1218 return GUEST_FSFREEZE_STATUS_FROZEN
;
1221 return GUEST_FSFREEZE_STATUS_THAWED
;
1225 * Freeze local file systems using Volume Shadow-copy Service.
1226 * The frozen state is limited for up to 10 seconds by VSS.
1228 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
1230 return qmp_guest_fsfreeze_freeze_list(false, NULL
, errp
);
1233 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
1234 strList
*mountpoints
,
1238 Error
*local_err
= NULL
;
1240 if (!vss_initialized()) {
1241 error_setg(errp
, QERR_UNSUPPORTED
);
1245 slog("guest-fsfreeze called");
1247 /* cannot risk guest agent blocking itself on a write in this state */
1248 ga_set_frozen(ga_state
);
1250 qga_vss_fsfreeze(&i
, true, mountpoints
, &local_err
);
1252 error_propagate(errp
, local_err
);
1260 qmp_guest_fsfreeze_thaw(&local_err
);
1262 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
1263 error_free(local_err
);
1269 * Thaw local file systems using Volume Shadow-copy Service.
1271 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
1275 if (!vss_initialized()) {
1276 error_setg(errp
, QERR_UNSUPPORTED
);
1280 qga_vss_fsfreeze(&i
, false, NULL
, errp
);
1282 ga_unset_frozen(ga_state
);
1286 static void guest_fsfreeze_cleanup(void)
1290 if (!vss_initialized()) {
1294 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
1295 qmp_guest_fsfreeze_thaw(&err
);
1297 slog("failed to clean up frozen filesystems: %s",
1298 error_get_pretty(err
));
1307 * Walk list of mounted file systems in the guest, and discard unused
1310 GuestFilesystemTrimResponse
*
1311 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
1313 GuestFilesystemTrimResponse
*resp
;
1315 WCHAR guid
[MAX_PATH
] = L
"";
1319 ZeroMemory(&osvi
, sizeof(OSVERSIONINFO
));
1320 osvi
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1321 GetVersionEx(&osvi
);
1322 win8_or_later
= (osvi
.dwMajorVersion
> 6 ||
1323 ((osvi
.dwMajorVersion
== 6) &&
1324 (osvi
.dwMinorVersion
>= 2)));
1325 if (!win8_or_later
) {
1326 error_setg(errp
, "fstrim is only supported for Win8+");
1330 handle
= FindFirstVolumeW(guid
, ARRAYSIZE(guid
));
1331 if (handle
== INVALID_HANDLE_VALUE
) {
1332 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1336 resp
= g_new0(GuestFilesystemTrimResponse
, 1);
1339 GuestFilesystemTrimResult
*res
;
1341 DWORD char_count
= 0;
1343 GError
*gerr
= NULL
;
1346 GetVolumePathNamesForVolumeNameW(guid
, NULL
, 0, &char_count
);
1348 if (GetLastError() != ERROR_MORE_DATA
) {
1351 if (GetDriveTypeW(guid
) != DRIVE_FIXED
) {
1355 uc_path
= g_new(WCHAR
, char_count
);
1356 if (!GetVolumePathNamesForVolumeNameW(guid
, uc_path
, char_count
,
1357 &char_count
) || !*uc_path
) {
1358 /* strange, but this condition could be faced even with size == 2 */
1363 res
= g_new0(GuestFilesystemTrimResult
, 1);
1365 path
= g_utf16_to_utf8(uc_path
, char_count
, NULL
, NULL
, &gerr
);
1370 res
->error
= g_strdup(gerr
->message
);
1377 QAPI_LIST_PREPEND(resp
->paths
, res
);
1379 memset(argv
, 0, sizeof(argv
));
1380 argv
[0] = (gchar
*)"defrag.exe";
1381 argv
[1] = (gchar
*)"/L";
1384 if (!g_spawn_sync(NULL
, argv
, NULL
, G_SPAWN_SEARCH_PATH
, NULL
, NULL
,
1385 &out
/* stdout */, NULL
/* stdin */,
1387 res
->error
= g_strdup(gerr
->message
);
1390 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1391 Error is reported in the output with something like
1392 (x89000020) etc code in the stdout */
1395 gchar
**lines
= g_strsplit(out
, "\r\n", 0);
1398 for (i
= 0; lines
[i
] != NULL
; i
++) {
1399 if (g_strstr_len(lines
[i
], -1, "(0x") == NULL
) {
1402 res
->error
= g_strdup(lines
[i
]);
1407 } while (FindNextVolumeW(handle
, guid
, ARRAYSIZE(guid
)));
1409 FindVolumeClose(handle
);
1414 GUEST_SUSPEND_MODE_DISK
,
1415 GUEST_SUSPEND_MODE_RAM
1418 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
1420 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
1422 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
1423 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
1424 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1425 "failed to determine guest suspend capabilities");
1430 case GUEST_SUSPEND_MODE_DISK
:
1431 if (!sys_pwr_caps
.SystemS4
) {
1432 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1433 "suspend-to-disk not supported by OS");
1436 case GUEST_SUSPEND_MODE_RAM
:
1437 if (!sys_pwr_caps
.SystemS3
) {
1438 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
1439 "suspend-to-ram not supported by OS");
1447 static DWORD WINAPI
do_suspend(LPVOID opaque
)
1449 GuestSuspendMode
*mode
= opaque
;
1452 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
1453 g_autofree gchar
*emsg
= g_win32_error_message(GetLastError());
1454 slog("failed to suspend guest: %s", emsg
);
1461 void qmp_guest_suspend_disk(Error
**errp
)
1463 Error
*local_err
= NULL
;
1464 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1466 *mode
= GUEST_SUSPEND_MODE_DISK
;
1467 check_suspend_mode(*mode
, &local_err
);
1471 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1475 execute_async(do_suspend
, mode
, &local_err
);
1479 error_propagate(errp
, local_err
);
1484 void qmp_guest_suspend_ram(Error
**errp
)
1486 Error
*local_err
= NULL
;
1487 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1489 *mode
= GUEST_SUSPEND_MODE_RAM
;
1490 check_suspend_mode(*mode
, &local_err
);
1494 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1498 execute_async(do_suspend
, mode
, &local_err
);
1502 error_propagate(errp
, local_err
);
1507 void qmp_guest_suspend_hybrid(Error
**errp
)
1509 error_setg(errp
, QERR_UNSUPPORTED
);
1512 static IP_ADAPTER_ADDRESSES
*guest_get_adapters_addresses(Error
**errp
)
1514 IP_ADAPTER_ADDRESSES
*adptr_addrs
= NULL
;
1515 ULONG adptr_addrs_len
= 0;
1518 /* Call the first time to get the adptr_addrs_len. */
1519 GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1520 NULL
, adptr_addrs
, &adptr_addrs_len
);
1522 adptr_addrs
= g_malloc(adptr_addrs_len
);
1523 ret
= GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1524 NULL
, adptr_addrs
, &adptr_addrs_len
);
1525 if (ret
!= ERROR_SUCCESS
) {
1526 error_setg_win32(errp
, ret
, "failed to get adapters addresses");
1527 g_free(adptr_addrs
);
1533 static char *guest_wctomb_dup(WCHAR
*wstr
)
1538 str_size
= WideCharToMultiByte(CP_UTF8
, 0, wstr
, -1, NULL
, 0, NULL
, NULL
);
1539 /* add 1 to str_size for NULL terminator */
1540 str
= g_malloc(str_size
+ 1);
1541 WideCharToMultiByte(CP_UTF8
, 0, wstr
, -1, str
, str_size
, NULL
, NULL
);
1545 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
,
1548 char addr_str
[INET6_ADDRSTRLEN
+ INET_ADDRSTRLEN
];
1552 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
||
1553 ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1554 len
= sizeof(addr_str
);
1555 ret
= WSAAddressToString(ip_addr
->Address
.lpSockaddr
,
1556 ip_addr
->Address
.iSockaddrLength
,
1561 error_setg_win32(errp
, WSAGetLastError(),
1562 "failed address presentation form conversion");
1565 return g_strdup(addr_str
);
1570 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1572 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1573 * field to obtain the prefix.
1575 return ip_addr
->OnLinkPrefixLength
;
1578 #define INTERFACE_PATH_BUF_SZ 512
1580 static DWORD
get_interface_index(const char *guid
)
1584 wchar_t wbuf
[INTERFACE_PATH_BUF_SZ
];
1585 snwprintf(wbuf
, INTERFACE_PATH_BUF_SZ
, L
"\\device\\tcpip_%s", guid
);
1586 wbuf
[INTERFACE_PATH_BUF_SZ
- 1] = 0;
1587 status
= GetAdapterIndex (wbuf
, &index
);
1588 if (status
!= NO_ERROR
) {
1595 typedef NETIOAPI_API (WINAPI
*GetIfEntry2Func
)(PMIB_IF_ROW2 Row
);
1597 static int guest_get_network_stats(const char *name
,
1598 GuestNetworkInterfaceStat
*stats
)
1600 OSVERSIONINFO os_ver
;
1602 os_ver
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1603 GetVersionEx(&os_ver
);
1604 if (os_ver
.dwMajorVersion
>= 6) {
1605 MIB_IF_ROW2 a_mid_ifrow
;
1606 GetIfEntry2Func getifentry2_ex
;
1608 HMODULE module
= GetModuleHandle("iphlpapi");
1609 PVOID func
= GetProcAddress(module
, "GetIfEntry2");
1615 getifentry2_ex
= (GetIfEntry2Func
)func
;
1616 if_index
= get_interface_index(name
);
1617 if (if_index
== (DWORD
)~0) {
1621 memset(&a_mid_ifrow
, 0, sizeof(a_mid_ifrow
));
1622 a_mid_ifrow
.InterfaceIndex
= if_index
;
1623 if (NO_ERROR
== getifentry2_ex(&a_mid_ifrow
)) {
1624 stats
->rx_bytes
= a_mid_ifrow
.InOctets
;
1625 stats
->rx_packets
= a_mid_ifrow
.InUcastPkts
;
1626 stats
->rx_errs
= a_mid_ifrow
.InErrors
;
1627 stats
->rx_dropped
= a_mid_ifrow
.InDiscards
;
1628 stats
->tx_bytes
= a_mid_ifrow
.OutOctets
;
1629 stats
->tx_packets
= a_mid_ifrow
.OutUcastPkts
;
1630 stats
->tx_errs
= a_mid_ifrow
.OutErrors
;
1631 stats
->tx_dropped
= a_mid_ifrow
.OutDiscards
;
1638 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
1640 IP_ADAPTER_ADDRESSES
*adptr_addrs
, *addr
;
1641 IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
= NULL
;
1642 GuestNetworkInterfaceList
*head
= NULL
, **tail
= &head
;
1643 GuestIpAddressList
*head_addr
, **tail_addr
;
1644 GuestNetworkInterface
*info
;
1645 GuestNetworkInterfaceStat
*interface_stat
= NULL
;
1646 GuestIpAddress
*address_item
= NULL
;
1647 unsigned char *mac_addr
;
1653 adptr_addrs
= guest_get_adapters_addresses(errp
);
1654 if (adptr_addrs
== NULL
) {
1658 /* Make WSA APIs available. */
1659 wsa_version
= MAKEWORD(2, 2);
1660 ret
= WSAStartup(wsa_version
, &wsa_data
);
1662 error_setg_win32(errp
, ret
, "failed socket startup");
1666 for (addr
= adptr_addrs
; addr
; addr
= addr
->Next
) {
1667 info
= g_malloc0(sizeof(*info
));
1669 QAPI_LIST_APPEND(tail
, info
);
1671 info
->name
= guest_wctomb_dup(addr
->FriendlyName
);
1673 if (addr
->PhysicalAddressLength
!= 0) {
1674 mac_addr
= addr
->PhysicalAddress
;
1676 info
->hardware_address
=
1677 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1678 (int) mac_addr
[0], (int) mac_addr
[1],
1679 (int) mac_addr
[2], (int) mac_addr
[3],
1680 (int) mac_addr
[4], (int) mac_addr
[5]);
1684 tail_addr
= &head_addr
;
1685 for (ip_addr
= addr
->FirstUnicastAddress
;
1687 ip_addr
= ip_addr
->Next
) {
1688 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1689 if (addr_str
== NULL
) {
1693 address_item
= g_malloc0(sizeof(*address_item
));
1695 QAPI_LIST_APPEND(tail_addr
, address_item
);
1697 address_item
->ip_address
= addr_str
;
1698 address_item
->prefix
= guest_ip_prefix(ip_addr
);
1699 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1700 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV4
;
1701 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1702 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV6
;
1706 info
->has_ip_addresses
= true;
1707 info
->ip_addresses
= head_addr
;
1709 if (!info
->statistics
) {
1710 interface_stat
= g_malloc0(sizeof(*interface_stat
));
1711 if (guest_get_network_stats(addr
->AdapterName
, interface_stat
)
1713 g_free(interface_stat
);
1715 info
->statistics
= interface_stat
;
1721 g_free(adptr_addrs
);
1725 static int64_t filetime_to_ns(const FILETIME
*tf
)
1727 return ((((int64_t)tf
->dwHighDateTime
<< 32) | tf
->dwLowDateTime
)
1728 - W32_FT_OFFSET
) * 100;
1731 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
1733 Error
*local_err
= NULL
;
1739 /* Unfortunately, Windows libraries don't provide an easy way to access
1742 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1744 * Instead, a workaround is to use the Windows win32tm command to
1745 * resync the time using the Windows Time service.
1750 HRESULT hr
= system("w32tm /resync /nowait");
1752 if (GetLastError() != 0) {
1753 strerror_s((LPTSTR
) & msg_buffer
, 0, errno
);
1754 error_setg(errp
, "system(...) failed: %s", (LPCTSTR
)msg_buffer
);
1755 } else if (hr
!= 0) {
1756 if (hr
== HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE
)) {
1757 error_setg(errp
, "Windows Time service not running on the "
1760 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1761 FORMAT_MESSAGE_FROM_SYSTEM
|
1762 FORMAT_MESSAGE_IGNORE_INSERTS
, NULL
,
1763 (DWORD
)hr
, MAKELANGID(LANG_NEUTRAL
,
1764 SUBLANG_DEFAULT
), (LPTSTR
) & msg_buffer
, 0,
1766 error_setg(errp
, "w32tm failed with error (0x%lx), couldn'"
1767 "t retrieve error message", hr
);
1769 error_setg(errp
, "w32tm failed with error (0x%lx): %s", hr
,
1770 (LPCTSTR
)msg_buffer
);
1771 LocalFree(msg_buffer
);
1774 } else if (!InternetGetConnectedState(&ret_flags
, 0)) {
1775 error_setg(errp
, "No internet connection on guest, sync not "
1781 /* Validate time passed by user. */
1782 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
1783 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
1787 time
= time_ns
/ 100 + W32_FT_OFFSET
;
1789 tf
.dwLowDateTime
= (DWORD
) time
;
1790 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
1792 if (!FileTimeToSystemTime(&tf
, &ts
)) {
1793 error_setg(errp
, "Failed to convert system time %d",
1794 (int)GetLastError());
1798 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
1800 error_propagate(errp
, local_err
);
1804 if (!SetSystemTime(&ts
)) {
1805 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
1810 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
1812 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi
, ptr
;
1814 GuestLogicalProcessorList
*head
, **tail
;
1815 Error
*local_err
= NULL
;
1824 if ((GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) &&
1825 (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) &&
1826 (length
> sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
))) {
1827 ptr
= pslpi
= g_malloc0(length
);
1828 if (GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) {
1829 error_setg(&local_err
, "Failed to get processor information: %d",
1830 (int)GetLastError());
1833 error_setg(&local_err
,
1834 "Failed to get processor information buffer length: %d",
1835 (int)GetLastError());
1838 while ((local_err
== NULL
) && (length
> 0)) {
1839 if (pslpi
->Relationship
== RelationProcessorCore
) {
1840 ULONG_PTR cpu_bits
= pslpi
->ProcessorMask
;
1842 while (cpu_bits
> 0) {
1843 if (!!(cpu_bits
& 1)) {
1844 GuestLogicalProcessor
*vcpu
;
1846 vcpu
= g_malloc0(sizeof *vcpu
);
1847 vcpu
->logical_id
= current
++;
1848 vcpu
->online
= true;
1849 vcpu
->has_can_offline
= true;
1851 QAPI_LIST_APPEND(tail
, vcpu
);
1856 length
-= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
);
1857 pslpi
++; /* next entry */
1862 if (local_err
== NULL
) {
1866 /* there's no guest with zero VCPUs */
1867 error_setg(&local_err
, "Guest reported zero VCPUs");
1870 qapi_free_GuestLogicalProcessorList(head
);
1871 error_propagate(errp
, local_err
);
1875 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
1877 error_setg(errp
, QERR_UNSUPPORTED
);
1882 get_net_error_message(gint error
)
1884 HMODULE module
= NULL
;
1885 gchar
*retval
= NULL
;
1886 wchar_t *msg
= NULL
;
1890 flags
= FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1891 FORMAT_MESSAGE_IGNORE_INSERTS
|
1892 FORMAT_MESSAGE_FROM_SYSTEM
;
1894 if (error
>= NERR_BASE
&& error
<= MAX_NERR
) {
1895 module
= LoadLibraryExW(L
"netmsg.dll", NULL
, LOAD_LIBRARY_AS_DATAFILE
);
1897 if (module
!= NULL
) {
1898 flags
|= FORMAT_MESSAGE_FROM_HMODULE
;
1902 FormatMessageW(flags
, module
, error
, 0, (LPWSTR
)&msg
, 0, NULL
);
1905 nchars
= wcslen(msg
);
1908 msg
[nchars
- 1] == L
'\n' &&
1909 msg
[nchars
- 2] == L
'\r') {
1910 msg
[nchars
- 2] = L
'\0';
1913 retval
= g_utf16_to_utf8(msg
, -1, NULL
, NULL
, NULL
);
1918 if (module
!= NULL
) {
1919 FreeLibrary(module
);
1925 void qmp_guest_set_user_password(const char *username
,
1926 const char *password
,
1931 char *rawpasswddata
= NULL
;
1932 size_t rawpasswdlen
;
1933 wchar_t *user
= NULL
, *wpass
= NULL
;
1934 USER_INFO_1003 pi1003
= { 0, };
1935 GError
*gerr
= NULL
;
1938 error_setg(errp
, QERR_UNSUPPORTED
);
1942 rawpasswddata
= (char *)qbase64_decode(password
, -1, &rawpasswdlen
, errp
);
1943 if (!rawpasswddata
) {
1946 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
1947 rawpasswddata
[rawpasswdlen
] = '\0';
1949 user
= g_utf8_to_utf16(username
, -1, NULL
, NULL
, &gerr
);
1954 wpass
= g_utf8_to_utf16(rawpasswddata
, -1, NULL
, NULL
, &gerr
);
1959 pi1003
.usri1003_password
= wpass
;
1960 nas
= NetUserSetInfo(NULL
, user
,
1961 1003, (LPBYTE
)&pi1003
,
1964 if (nas
!= NERR_Success
) {
1965 gchar
*msg
= get_net_error_message(nas
);
1966 error_setg(errp
, "failed to set password: %s", msg
);
1972 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
1977 g_free(rawpasswddata
);
1980 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
1982 error_setg(errp
, QERR_UNSUPPORTED
);
1986 GuestMemoryBlockResponseList
*
1987 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
1989 error_setg(errp
, QERR_UNSUPPORTED
);
1993 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
1995 error_setg(errp
, QERR_UNSUPPORTED
);
1999 /* add unsupported commands to the list of blocked RPCs */
2000 GList
*ga_command_init_blockedrpcs(GList
*blockedrpcs
)
2002 const char *list_unsupported
[] = {
2003 "guest-suspend-hybrid",
2005 "guest-get-memory-blocks", "guest-set-memory-blocks",
2006 "guest-get-memory-block-size", "guest-get-memory-block-info",
2008 char **p
= (char **)list_unsupported
;
2011 blockedrpcs
= g_list_append(blockedrpcs
, g_strdup(*p
++));
2014 if (!vss_init(true)) {
2015 g_debug("vss_init failed, vss commands are going to be disabled");
2016 const char *list
[] = {
2017 "guest-get-fsinfo", "guest-fsfreeze-status",
2018 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL
};
2022 blockedrpcs
= g_list_append(blockedrpcs
, g_strdup(*p
++));
2029 /* register init/cleanup routines for stateful command groups */
2030 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
2032 if (!vss_initialized()) {
2033 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);
2037 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
2038 typedef struct _GA_WTSINFOA
{
2039 WTS_CONNECTSTATE_CLASS State
;
2041 DWORD IncomingBytes
;
2042 DWORD OutgoingBytes
;
2043 DWORD IncomingFrames
;
2044 DWORD OutgoingFrames
;
2045 DWORD IncomingCompressedBytes
;
2046 DWORD OutgoingCompressedBy
;
2047 CHAR WinStationName
[WINSTATIONNAME_LENGTH
];
2048 CHAR Domain
[DOMAIN_LENGTH
];
2049 CHAR UserName
[USERNAME_LENGTH
+ 1];
2050 LARGE_INTEGER ConnectTime
;
2051 LARGE_INTEGER DisconnectTime
;
2052 LARGE_INTEGER LastInputTime
;
2053 LARGE_INTEGER LogonTime
;
2054 LARGE_INTEGER CurrentTime
;
2058 GuestUserList
*qmp_guest_get_users(Error
**errp
)
2060 #define QGA_NANOSECONDS 10000000
2062 GHashTable
*cache
= NULL
;
2063 GuestUserList
*head
= NULL
, **tail
= &head
;
2065 DWORD buffer_size
= 0, count
= 0, i
= 0;
2066 GA_WTSINFOA
*info
= NULL
;
2067 WTS_SESSION_INFOA
*entries
= NULL
;
2068 GuestUser
*user
= NULL
;
2069 gpointer value
= NULL
;
2071 double login_time
= 0;
2073 cache
= g_hash_table_new(g_str_hash
, g_str_equal
);
2075 if (WTSEnumerateSessionsA(NULL
, 0, 1, &entries
, &count
)) {
2076 for (i
= 0; i
< count
; ++i
) {
2079 if (WTSQuerySessionInformationA(
2081 entries
[i
].SessionId
,
2087 if (strlen(info
->UserName
) == 0) {
2088 WTSFreeMemory(info
);
2092 login
= info
->LogonTime
.QuadPart
;
2093 login
-= W32_FT_OFFSET
;
2094 login_time
= ((double)login
) / QGA_NANOSECONDS
;
2096 if (g_hash_table_contains(cache
, info
->UserName
)) {
2097 value
= g_hash_table_lookup(cache
, info
->UserName
);
2098 user
= (GuestUser
*)value
;
2099 if (user
->login_time
> login_time
) {
2100 user
->login_time
= login_time
;
2103 user
= g_new0(GuestUser
, 1);
2105 user
->user
= g_strdup(info
->UserName
);
2106 user
->domain
= g_strdup(info
->Domain
);
2108 user
->login_time
= login_time
;
2110 g_hash_table_add(cache
, user
->user
);
2112 QAPI_LIST_APPEND(tail
, user
);
2115 WTSFreeMemory(info
);
2117 WTSFreeMemory(entries
);
2119 g_hash_table_destroy(cache
);
2123 typedef struct _ga_matrix_lookup_t
{
2126 char const *version
;
2127 char const *version_id
;
2128 } ga_matrix_lookup_t
;
2130 static ga_matrix_lookup_t
const WIN_VERSION_MATRIX
[2][7] = {
2132 /* Desktop editions */
2133 { 5, 0, "Microsoft Windows 2000", "2000"},
2134 { 5, 1, "Microsoft Windows XP", "xp"},
2135 { 6, 0, "Microsoft Windows Vista", "vista"},
2136 { 6, 1, "Microsoft Windows 7" "7"},
2137 { 6, 2, "Microsoft Windows 8", "8"},
2138 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2141 /* Server editions */
2142 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2143 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2144 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2145 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2146 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2152 typedef struct _ga_win_10_0_t
{
2154 char const *version
;
2155 char const *version_id
;
2158 static ga_win_10_0_t
const WIN_10_0_SERVER_VERSION_MATRIX
[4] = {
2159 {14393, "Microsoft Windows Server 2016", "2016"},
2160 {17763, "Microsoft Windows Server 2019", "2019"},
2161 {20344, "Microsoft Windows Server 2022", "2022"},
2165 static ga_win_10_0_t
const WIN_10_0_CLIENT_VERSION_MATRIX
[3] = {
2166 {10240, "Microsoft Windows 10", "10"},
2167 {22000, "Microsoft Windows 11", "11"},
2171 static void ga_get_win_version(RTL_OSVERSIONINFOEXW
*info
, Error
**errp
)
2173 typedef NTSTATUS(WINAPI
*rtl_get_version_t
)(
2174 RTL_OSVERSIONINFOEXW
*os_version_info_ex
);
2176 info
->dwOSVersionInfoSize
= sizeof(RTL_OSVERSIONINFOEXW
);
2178 HMODULE module
= GetModuleHandle("ntdll");
2179 PVOID fun
= GetProcAddress(module
, "RtlGetVersion");
2181 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
2182 "Failed to get address of RtlGetVersion");
2186 rtl_get_version_t rtl_get_version
= (rtl_get_version_t
)fun
;
2187 rtl_get_version(info
);
2191 static char *ga_get_win_name(OSVERSIONINFOEXW
const *os_version
, bool id
)
2193 DWORD major
= os_version
->dwMajorVersion
;
2194 DWORD minor
= os_version
->dwMinorVersion
;
2195 DWORD build
= os_version
->dwBuildNumber
;
2196 int tbl_idx
= (os_version
->wProductType
!= VER_NT_WORKSTATION
);
2197 ga_matrix_lookup_t
const *table
= WIN_VERSION_MATRIX
[tbl_idx
];
2198 ga_win_10_0_t
const *win_10_0_table
= tbl_idx
?
2199 WIN_10_0_SERVER_VERSION_MATRIX
: WIN_10_0_CLIENT_VERSION_MATRIX
;
2200 ga_win_10_0_t
const *win_10_0_version
= NULL
;
2201 while (table
->version
!= NULL
) {
2202 if (major
== 10 && minor
== 0) {
2203 while (win_10_0_table
->version
!= NULL
) {
2204 if (build
>= win_10_0_table
->first_build
) {
2205 win_10_0_version
= win_10_0_table
;
2209 if (win_10_0_table
) {
2211 return g_strdup(win_10_0_version
->version_id
);
2213 return g_strdup(win_10_0_version
->version
);
2216 } else if (major
== table
->major
&& minor
== table
->minor
) {
2218 return g_strdup(table
->version_id
);
2220 return g_strdup(table
->version
);
2225 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2227 return g_strdup("N/A");
2230 static char *ga_get_win_product_name(Error
**errp
)
2232 HKEY key
= INVALID_HANDLE_VALUE
;
2234 char *result
= g_malloc0(size
);
2235 LONG err
= ERROR_SUCCESS
;
2237 err
= RegOpenKeyA(HKEY_LOCAL_MACHINE
,
2238 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2240 if (err
!= ERROR_SUCCESS
) {
2241 error_setg_win32(errp
, err
, "failed to open registry key");
2246 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2247 (LPBYTE
)result
, &size
);
2248 if (err
== ERROR_MORE_DATA
) {
2249 slog("ProductName longer than expected (%lu bytes), retrying",
2254 result
= g_malloc0(size
);
2255 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2256 (LPBYTE
)result
, &size
);
2259 if (err
!= ERROR_SUCCESS
) {
2260 error_setg_win32(errp
, err
, "failed to retrive ProductName");
2268 if (key
!= INVALID_HANDLE_VALUE
) {
2275 static char *ga_get_current_arch(void)
2278 GetNativeSystemInfo(&info
);
2279 char *result
= NULL
;
2280 switch (info
.wProcessorArchitecture
) {
2281 case PROCESSOR_ARCHITECTURE_AMD64
:
2282 result
= g_strdup("x86_64");
2284 case PROCESSOR_ARCHITECTURE_ARM
:
2285 result
= g_strdup("arm");
2287 case PROCESSOR_ARCHITECTURE_IA64
:
2288 result
= g_strdup("ia64");
2290 case PROCESSOR_ARCHITECTURE_INTEL
:
2291 result
= g_strdup("x86");
2293 case PROCESSOR_ARCHITECTURE_UNKNOWN
:
2295 slog("unknown processor architecture 0x%0x",
2296 info
.wProcessorArchitecture
);
2297 result
= g_strdup("unknown");
2303 GuestOSInfo
*qmp_guest_get_osinfo(Error
**errp
)
2305 Error
*local_err
= NULL
;
2306 OSVERSIONINFOEXW os_version
= {0};
2311 ga_get_win_version(&os_version
, &local_err
);
2313 error_propagate(errp
, local_err
);
2317 server
= os_version
.wProductType
!= VER_NT_WORKSTATION
;
2318 product_name
= ga_get_win_product_name(errp
);
2319 if (product_name
== NULL
) {
2323 info
= g_new0(GuestOSInfo
, 1);
2325 info
->kernel_version
= g_strdup_printf("%lu.%lu",
2326 os_version
.dwMajorVersion
,
2327 os_version
.dwMinorVersion
);
2328 info
->kernel_release
= g_strdup_printf("%lu",
2329 os_version
.dwBuildNumber
);
2330 info
->machine
= ga_get_current_arch();
2332 info
->id
= g_strdup("mswindows");
2333 info
->name
= g_strdup("Microsoft Windows");
2334 info
->pretty_name
= product_name
;
2335 info
->version
= ga_get_win_name(&os_version
, false);
2336 info
->version_id
= ga_get_win_name(&os_version
, true);
2337 info
->variant
= g_strdup(server
? "server" : "client");
2338 info
->variant_id
= g_strdup(server
? "server" : "client");
2344 * Safely get device property. Returned strings are using wide characters.
2345 * Caller is responsible for freeing the buffer.
2347 static LPBYTE
cm_get_property(DEVINST devInst
, const DEVPROPKEY
*propName
,
2348 PDEVPROPTYPE propType
)
2351 g_autofree LPBYTE buffer
= NULL
;
2352 ULONG buffer_len
= 0;
2354 /* First query for needed space */
2355 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2356 buffer
, &buffer_len
, 0);
2357 if (cr
!= CR_SUCCESS
&& cr
!= CR_BUFFER_SMALL
) {
2359 slog("failed to get property size, error=0x%lx", cr
);
2362 buffer
= g_new0(BYTE
, buffer_len
+ 1);
2363 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2364 buffer
, &buffer_len
, 0);
2365 if (cr
!= CR_SUCCESS
) {
2366 slog("failed to get device property, error=0x%lx", cr
);
2369 return g_steal_pointer(&buffer
);
2372 static GStrv
ga_get_hardware_ids(DEVINST devInstance
)
2374 GArray
*values
= NULL
;
2375 DEVPROPTYPE cm_type
;
2377 g_autofree LPWSTR property
= (LPWSTR
)cm_get_property(devInstance
,
2378 &qga_DEVPKEY_Device_HardwareIds
, &cm_type
);
2379 if (property
== NULL
) {
2380 slog("failed to get hardware IDs");
2383 if (*property
== '\0') {
2387 values
= g_array_new(TRUE
, TRUE
, sizeof(gchar
*));
2388 for (id
= property
; '\0' != *id
; id
+= lstrlenW(id
) + 1) {
2389 gchar
*id8
= g_utf16_to_utf8(id
, -1, NULL
, NULL
, NULL
);
2390 g_array_append_val(values
, id8
);
2392 return (GStrv
)g_array_free(values
, FALSE
);
2396 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2398 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2400 GuestDeviceInfoList
*qmp_guest_get_devices(Error
**errp
)
2402 GuestDeviceInfoList
*head
= NULL
, **tail
= &head
;
2403 HDEVINFO dev_info
= INVALID_HANDLE_VALUE
;
2404 SP_DEVINFO_DATA dev_info_data
;
2406 GError
*gerr
= NULL
;
2407 g_autoptr(GRegex
) device_pci_re
= NULL
;
2408 DEVPROPTYPE cm_type
;
2410 device_pci_re
= g_regex_new(DEVICE_PCI_RE
,
2411 G_REGEX_ANCHORED
| G_REGEX_OPTIMIZE
, 0,
2413 g_assert(device_pci_re
!= NULL
);
2415 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
2416 dev_info
= SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT
| DIGCF_ALLCLASSES
);
2417 if (dev_info
== INVALID_HANDLE_VALUE
) {
2418 error_setg(errp
, "failed to get device tree");
2422 slog("enumerating devices");
2423 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
2425 g_autofree LPWSTR name
= NULL
;
2426 g_autofree LPFILETIME date
= NULL
;
2427 g_autofree LPWSTR version
= NULL
;
2428 g_auto(GStrv
) hw_ids
= NULL
;
2429 g_autoptr(GuestDeviceInfo
) device
= g_new0(GuestDeviceInfo
, 1);
2430 g_autofree
char *vendor_id
= NULL
;
2431 g_autofree
char *device_id
= NULL
;
2433 name
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2434 &qga_DEVPKEY_NAME
, &cm_type
);
2436 slog("failed to get device description");
2439 device
->driver_name
= g_utf16_to_utf8(name
, -1, NULL
, NULL
, NULL
);
2440 if (device
->driver_name
== NULL
) {
2441 error_setg(errp
, "conversion to utf8 failed (driver name)");
2444 slog("querying device: %s", device
->driver_name
);
2445 hw_ids
= ga_get_hardware_ids(dev_info_data
.DevInst
);
2446 if (hw_ids
== NULL
) {
2449 for (j
= 0; hw_ids
[j
] != NULL
; j
++) {
2450 g_autoptr(GMatchInfo
) match_info
;
2451 GuestDeviceIdPCI
*id
;
2452 if (!g_regex_match(device_pci_re
, hw_ids
[j
], 0, &match_info
)) {
2457 vendor_id
= g_match_info_fetch(match_info
, 1);
2458 device_id
= g_match_info_fetch(match_info
, 2);
2460 device
->id
= g_new0(GuestDeviceId
, 1);
2461 device
->id
->type
= GUEST_DEVICE_TYPE_PCI
;
2462 id
= &device
->id
->u
.pci
;
2463 id
->vendor_id
= g_ascii_strtoull(vendor_id
, NULL
, 16);
2464 id
->device_id
= g_ascii_strtoull(device_id
, NULL
, 16);
2472 version
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2473 &qga_DEVPKEY_Device_DriverVersion
, &cm_type
);
2474 if (version
== NULL
) {
2475 slog("failed to get driver version");
2478 device
->driver_version
= g_utf16_to_utf8(version
, -1, NULL
,
2480 if (device
->driver_version
== NULL
) {
2481 error_setg(errp
, "conversion to utf8 failed (driver version)");
2485 date
= (LPFILETIME
)cm_get_property(dev_info_data
.DevInst
,
2486 &qga_DEVPKEY_Device_DriverDate
, &cm_type
);
2488 slog("failed to get driver date");
2491 device
->driver_date
= filetime_to_ns(date
);
2492 device
->has_driver_date
= true;
2494 slog("driver: %s\ndriver version: %" PRId64
",%s\n",
2495 device
->driver_name
, device
->driver_date
,
2496 device
->driver_version
);
2497 QAPI_LIST_APPEND(tail
, g_steal_pointer(&device
));
2500 if (dev_info
!= INVALID_HANDLE_VALUE
) {
2501 SetupDiDestroyDeviceInfoList(dev_info
);
2506 char *qga_get_host_name(Error
**errp
)
2508 wchar_t tmp
[MAX_COMPUTERNAME_LENGTH
+ 1];
2509 DWORD size
= G_N_ELEMENTS(tmp
);
2511 if (GetComputerNameW(tmp
, &size
) == 0) {
2512 error_setg_win32(errp
, GetLastError(), "failed close handle");
2516 return g_utf16_to_utf8(tmp
, size
, NULL
, NULL
, NULL
);
2519 GuestDiskStatsInfoList
*qmp_guest_get_diskstats(Error
**errp
)
2521 error_setg(errp
, QERR_UNSUPPORTED
);
2525 GuestCpuStatsList
*qmp_guest_get_cpustats(Error
**errp
)
2527 error_setg(errp
, QERR_UNSUPPORTED
);