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
, bool has_mode
,
197 const char *mode
, Error
**errp
)
201 HANDLE templ_file
= NULL
;
202 DWORD share_mode
= FILE_SHARE_READ
;
203 DWORD flags_and_attr
= FILE_ATTRIBUTE_NORMAL
;
204 LPSECURITY_ATTRIBUTES sa_attr
= NULL
;
205 OpenFlags
*guest_flags
;
207 wchar_t *w_path
= NULL
;
212 slog("guest-file-open called, filepath: %s, mode: %s", path
, mode
);
213 guest_flags
= find_open_flag(mode
);
214 if (guest_flags
== NULL
) {
215 error_setg(errp
, "invalid file open mode");
219 w_path
= g_utf8_to_utf16(path
, -1, NULL
, NULL
, &gerr
);
224 fh
= CreateFileW(w_path
, guest_flags
->desired_access
, share_mode
, sa_attr
,
225 guest_flags
->creation_disposition
, flags_and_attr
,
227 if (fh
== INVALID_HANDLE_VALUE
) {
228 error_setg_win32(errp
, GetLastError(), "failed to open file '%s'",
233 /* set fd non-blocking to avoid common use cases (like reading from a
234 * named pipe) from hanging the agent
236 handle_set_nonblocking(fh
);
238 fd
= guest_file_handle_add(fh
, errp
);
241 error_setg(errp
, "failed to add handle to qmp handle table");
245 slog("guest-file-open, handle: % " PRId64
, fd
);
249 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
256 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
259 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
260 slog("guest-file-close called, handle: %" PRId64
, handle
);
264 ret
= CloseHandle(gfh
->fh
);
266 error_setg_win32(errp
, GetLastError(), "failed close handle");
270 QTAILQ_REMOVE(&guest_file_state
.filehandles
, gfh
, next
);
274 static void acquire_privilege(const char *name
, Error
**errp
)
277 TOKEN_PRIVILEGES priv
;
278 Error
*local_err
= NULL
;
280 if (OpenProcessToken(GetCurrentProcess(),
281 TOKEN_ADJUST_PRIVILEGES
| TOKEN_QUERY
, &token
))
283 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
284 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
285 "no luid for requested privilege");
289 priv
.PrivilegeCount
= 1;
290 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
292 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
293 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
294 "unable to acquire requested privilege");
299 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
300 "failed to open privilege token");
307 error_propagate(errp
, local_err
);
310 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
313 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
315 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
316 "failed to dispatch asynchronous command");
320 void qmp_guest_shutdown(bool has_mode
, const char *mode
, Error
**errp
)
322 Error
*local_err
= NULL
;
323 UINT shutdown_flag
= EWX_FORCE
;
325 slog("guest-shutdown called, mode: %s", mode
);
327 if (!has_mode
|| strcmp(mode
, "powerdown") == 0) {
328 shutdown_flag
|= EWX_POWEROFF
;
329 } else if (strcmp(mode
, "halt") == 0) {
330 shutdown_flag
|= EWX_SHUTDOWN
;
331 } else if (strcmp(mode
, "reboot") == 0) {
332 shutdown_flag
|= EWX_REBOOT
;
334 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
335 "'halt', 'powerdown', or 'reboot'");
339 /* Request a shutdown privilege, but try to shut down the system
341 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
343 error_propagate(errp
, local_err
);
347 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
348 g_autofree gchar
*emsg
= g_win32_error_message(GetLastError());
349 slog("guest-shutdown failed: %s", emsg
);
350 error_setg_win32(errp
, GetLastError(), "guest-shutdown failed");
354 GuestFileRead
*guest_file_read_unsafe(GuestFileHandle
*gfh
,
355 int64_t count
, Error
**errp
)
357 GuestFileRead
*read_data
= NULL
;
363 buf
= g_malloc0(count
+ 1);
364 is_ok
= ReadFile(fh
, buf
, count
, &read_count
, NULL
);
366 error_setg_win32(errp
, GetLastError(), "failed to read file");
369 read_data
= g_new0(GuestFileRead
, 1);
370 read_data
->count
= (size_t)read_count
;
371 read_data
->eof
= read_count
== 0;
373 if (read_count
!= 0) {
374 read_data
->buf_b64
= g_base64_encode(buf
, read_count
);
382 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
383 bool has_count
, int64_t count
,
386 GuestFileWrite
*write_data
= NULL
;
391 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
398 buf
= qbase64_decode(buf_b64
, -1, &buf_len
, errp
);
405 } else if (count
< 0 || count
> buf_len
) {
406 error_setg(errp
, "value '%" PRId64
407 "' is invalid for argument count", count
);
411 is_ok
= WriteFile(fh
, buf
, count
, &write_count
, NULL
);
413 error_setg_win32(errp
, GetLastError(), "failed to write to file");
414 slog("guest-file-write-failed, handle: %" PRId64
, handle
);
416 write_data
= g_new0(GuestFileWrite
, 1);
417 write_data
->count
= (size_t) write_count
;
425 GuestFileSeek
*qmp_guest_file_seek(int64_t handle
, int64_t offset
,
426 GuestFileWhence
*whence_code
,
429 GuestFileHandle
*gfh
;
430 GuestFileSeek
*seek_data
;
432 LARGE_INTEGER new_pos
, off_pos
;
433 off_pos
.QuadPart
= offset
;
438 gfh
= guest_file_handle_find(handle
, errp
);
443 /* We stupidly exposed 'whence':'int' in our qapi */
444 whence
= ga_parse_whence(whence_code
, &err
);
446 error_propagate(errp
, err
);
451 res
= SetFilePointerEx(fh
, off_pos
, &new_pos
, whence
);
453 error_setg_win32(errp
, GetLastError(), "failed to seek file");
456 seek_data
= g_new0(GuestFileSeek
, 1);
457 seek_data
->position
= new_pos
.QuadPart
;
461 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
464 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
470 if (!FlushFileBuffers(fh
)) {
471 error_setg_win32(errp
, GetLastError(), "failed to flush file");
475 static GuestDiskBusType win2qemu
[] = {
476 [BusTypeUnknown
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
477 [BusTypeScsi
] = GUEST_DISK_BUS_TYPE_SCSI
,
478 [BusTypeAtapi
] = GUEST_DISK_BUS_TYPE_IDE
,
479 [BusTypeAta
] = GUEST_DISK_BUS_TYPE_IDE
,
480 [BusType1394
] = GUEST_DISK_BUS_TYPE_IEEE1394
,
481 [BusTypeSsa
] = GUEST_DISK_BUS_TYPE_SSA
,
482 [BusTypeFibre
] = GUEST_DISK_BUS_TYPE_SSA
,
483 [BusTypeUsb
] = GUEST_DISK_BUS_TYPE_USB
,
484 [BusTypeRAID
] = GUEST_DISK_BUS_TYPE_RAID
,
485 [BusTypeiScsi
] = GUEST_DISK_BUS_TYPE_ISCSI
,
486 [BusTypeSas
] = GUEST_DISK_BUS_TYPE_SAS
,
487 [BusTypeSata
] = GUEST_DISK_BUS_TYPE_SATA
,
488 [BusTypeSd
] = GUEST_DISK_BUS_TYPE_SD
,
489 [BusTypeMmc
] = GUEST_DISK_BUS_TYPE_MMC
,
490 #if (_WIN32_WINNT >= 0x0601)
491 [BusTypeVirtual
] = GUEST_DISK_BUS_TYPE_VIRTUAL
,
492 [BusTypeFileBackedVirtual
] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL
,
496 static GuestDiskBusType
find_bus_type(STORAGE_BUS_TYPE bus
)
498 if (bus
>= ARRAY_SIZE(win2qemu
) || (int)bus
< 0) {
499 return GUEST_DISK_BUS_TYPE_UNKNOWN
;
501 return win2qemu
[(int)bus
];
504 DEFINE_GUID(GUID_DEVINTERFACE_DISK
,
505 0x53f56307L
, 0xb6bf, 0x11d0, 0x94, 0xf2,
506 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
507 DEFINE_GUID(GUID_DEVINTERFACE_STORAGEPORT
,
508 0x2accfe60L
, 0xc130, 0x11d2, 0xb0, 0x82,
509 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
511 static void get_pci_address_for_device(GuestPCIAddress
*pci
,
514 SP_DEVINFO_DATA dev_info_data
;
517 bool partial_pci
= false;
519 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
522 SetupDiEnumDeviceInfo(dev_info
, j
, &dev_info_data
);
524 DWORD addr
, bus
, ui_slot
, type
;
526 size
= sizeof(DWORD
);
529 * There is no need to allocate buffer in the next functions. The
530 * size is known and ULONG according to
531 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
533 if (!SetupDiGetDeviceRegistryProperty(
534 dev_info
, &dev_info_data
, SPDRP_BUSNUMBER
,
535 &type
, (PBYTE
)&bus
, size
, NULL
)) {
536 debug_error("failed to get PCI bus");
542 * The function retrieves the device's address. This value will be
543 * transformed into device function and number
545 if (!SetupDiGetDeviceRegistryProperty(
546 dev_info
, &dev_info_data
, SPDRP_ADDRESS
,
547 &type
, (PBYTE
)&addr
, size
, NULL
)) {
548 debug_error("failed to get PCI address");
554 * This call returns UINumber of DEVICE_CAPABILITIES structure.
555 * This number is typically a user-perceived slot number.
557 if (!SetupDiGetDeviceRegistryProperty(
558 dev_info
, &dev_info_data
, SPDRP_UI_NUMBER
,
559 &type
, (PBYTE
)&ui_slot
, size
, NULL
)) {
560 debug_error("failed to get PCI slot");
566 * SetupApi gives us the same information as driver with
567 * IoGetDeviceProperty. According to Microsoft:
569 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF)
570 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF)
571 * SPDRP_ADDRESS is propertyAddress, so we do the same.
573 * https://docs.microsoft.com/en-us/windows/desktop/api/setupapi/nf-setupapi-setupdigetdeviceregistrypropertya
582 func
= ((int)addr
== -1) ? -1 : addr
& 0x0000FFFF;
583 slot
= ((int)addr
== -1) ? -1 : (addr
>> 16) & 0x0000FFFF;
584 if ((int)ui_slot
!= slot
) {
585 g_debug("mismatch with reported slot values: %d vs %d",
589 pci
->slot
= (int)ui_slot
;
590 pci
->function
= func
;
597 static GuestPCIAddress
*get_pci_info(int number
, Error
**errp
)
599 HDEVINFO dev_info
= INVALID_HANDLE_VALUE
;
600 HDEVINFO parent_dev_info
= INVALID_HANDLE_VALUE
;
602 SP_DEVINFO_DATA dev_info_data
;
603 SP_DEVICE_INTERFACE_DATA dev_iface_data
;
606 GuestPCIAddress
*pci
= NULL
;
608 pci
= g_malloc0(sizeof(*pci
));
614 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
615 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
616 if (dev_info
== INVALID_HANDLE_VALUE
) {
617 error_setg_win32(errp
, GetLastError(), "failed to get devices tree");
621 g_debug("enumerating devices");
622 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
623 dev_iface_data
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
624 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
625 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA pdev_iface_detail_data
= NULL
;
626 STORAGE_DEVICE_NUMBER sdn
;
627 g_autofree
char *parent_dev_id
= NULL
;
628 SP_DEVINFO_DATA parent_dev_info_data
;
631 g_debug("getting device path");
632 if (SetupDiEnumDeviceInterfaces(dev_info
, &dev_info_data
,
633 &GUID_DEVINTERFACE_DISK
, 0,
635 if (!SetupDiGetDeviceInterfaceDetail(dev_info
, &dev_iface_data
,
636 pdev_iface_detail_data
,
639 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
640 pdev_iface_detail_data
= g_malloc(size
);
641 pdev_iface_detail_data
->cbSize
=
642 sizeof(*pdev_iface_detail_data
);
644 error_setg_win32(errp
, GetLastError(),
645 "failed to get device interfaces");
650 if (!SetupDiGetDeviceInterfaceDetail(dev_info
, &dev_iface_data
,
651 pdev_iface_detail_data
,
654 // pdev_iface_detail_data already is allocated
655 error_setg_win32(errp
, GetLastError(),
656 "failed to get device interfaces");
660 dev_file
= CreateFile(pdev_iface_detail_data
->DevicePath
, 0,
661 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, 0,
664 if (!DeviceIoControl(dev_file
, IOCTL_STORAGE_GET_DEVICE_NUMBER
,
665 NULL
, 0, &sdn
, sizeof(sdn
), &size
, NULL
)) {
666 CloseHandle(dev_file
);
667 error_setg_win32(errp
, GetLastError(),
668 "failed to get device slot number");
672 CloseHandle(dev_file
);
673 if (sdn
.DeviceNumber
!= number
) {
677 error_setg_win32(errp
, GetLastError(),
678 "failed to get device interfaces");
682 g_debug("found device slot %d. Getting storage controller", number
);
685 DEVINST dev_inst
, parent_dev_inst
;
686 ULONG dev_id_size
= 0;
689 if (!SetupDiGetDeviceInstanceId(dev_info
, &dev_info_data
,
690 parent_dev_id
, size
, &size
)) {
691 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
692 parent_dev_id
= g_malloc(size
);
694 error_setg_win32(errp
, GetLastError(),
695 "failed to get device instance ID");
700 if (!SetupDiGetDeviceInstanceId(dev_info
, &dev_info_data
,
701 parent_dev_id
, size
, &size
)) {
702 // parent_dev_id already is allocated
703 error_setg_win32(errp
, GetLastError(),
704 "failed to get device instance ID");
709 * CM API used here as opposed to
710 * SetupDiGetDeviceProperty(..., DEVPKEY_Device_Parent, ...)
711 * which exports are only available in mingw-w64 6+
713 cr
= CM_Locate_DevInst(&dev_inst
, parent_dev_id
, 0);
714 if (cr
!= CR_SUCCESS
) {
715 g_error("CM_Locate_DevInst failed with code %lx", cr
);
716 error_setg_win32(errp
, GetLastError(),
717 "failed to get device instance");
720 cr
= CM_Get_Parent(&parent_dev_inst
, dev_inst
, 0);
721 if (cr
!= CR_SUCCESS
) {
722 g_error("CM_Get_Parent failed with code %lx", cr
);
723 error_setg_win32(errp
, GetLastError(),
724 "failed to get parent device instance");
728 cr
= CM_Get_Device_ID_Size(&dev_id_size
, parent_dev_inst
, 0);
729 if (cr
!= CR_SUCCESS
) {
730 g_error("CM_Get_Device_ID_Size failed with code %lx", cr
);
731 error_setg_win32(errp
, GetLastError(),
732 "failed to get parent device ID length");
737 if (dev_id_size
> size
) {
738 g_free(parent_dev_id
);
739 parent_dev_id
= g_malloc(dev_id_size
);
742 cr
= CM_Get_Device_ID(parent_dev_inst
, parent_dev_id
, dev_id_size
,
744 if (cr
!= CR_SUCCESS
) {
745 g_error("CM_Get_Device_ID failed with code %lx", cr
);
746 error_setg_win32(errp
, GetLastError(),
747 "failed to get parent device ID");
752 g_debug("querying storage controller %s for PCI information",
755 SetupDiGetClassDevs(&GUID_DEVINTERFACE_STORAGEPORT
, parent_dev_id
,
756 NULL
, DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
758 if (parent_dev_info
== INVALID_HANDLE_VALUE
) {
759 error_setg_win32(errp
, GetLastError(),
760 "failed to get parent device");
764 parent_dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
765 if (!SetupDiEnumDeviceInfo(parent_dev_info
, 0, &parent_dev_info_data
)) {
766 error_setg_win32(errp
, GetLastError(),
767 "failed to get parent device data");
771 get_pci_address_for_device(pci
, parent_dev_info
);
777 if (parent_dev_info
!= INVALID_HANDLE_VALUE
) {
778 SetupDiDestroyDeviceInfoList(parent_dev_info
);
780 if (dev_info
!= INVALID_HANDLE_VALUE
) {
781 SetupDiDestroyDeviceInfoList(dev_info
);
786 static void get_disk_properties(HANDLE vol_h
, GuestDiskAddress
*disk
,
789 STORAGE_PROPERTY_QUERY query
;
790 STORAGE_DEVICE_DESCRIPTOR
*dev_desc
, buf
;
792 ULONG size
= sizeof(buf
);
795 query
.PropertyId
= StorageDeviceProperty
;
796 query
.QueryType
= PropertyStandardQuery
;
798 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
799 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
800 size
, &received
, NULL
)) {
801 error_setg_win32(errp
, GetLastError(), "failed to get bus type");
804 disk
->bus_type
= find_bus_type(dev_desc
->BusType
);
805 g_debug("bus type %d", disk
->bus_type
);
807 /* Query once more. Now with long enough buffer. */
808 size
= dev_desc
->Size
;
809 dev_desc
= g_malloc0(size
);
810 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
811 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
812 size
, &received
, NULL
)) {
813 error_setg_win32(errp
, GetLastError(), "failed to get serial number");
814 g_debug("failed to get serial number");
817 if (dev_desc
->SerialNumberOffset
> 0) {
821 if (dev_desc
->SerialNumberOffset
>= received
) {
822 error_setg(errp
, "failed to get serial number: offset outside the buffer");
823 g_debug("serial number offset outside the buffer");
826 serial
= (char *)dev_desc
+ dev_desc
->SerialNumberOffset
;
827 len
= received
- dev_desc
->SerialNumberOffset
;
828 g_debug("serial number \"%s\"", serial
);
830 disk
->serial
= g_strndup(serial
, len
);
831 disk
->has_serial
= true;
840 static void get_single_disk_info(int disk_number
,
841 GuestDiskAddress
*disk
, Error
**errp
)
843 SCSI_ADDRESS addr
, *scsi_ad
;
846 Error
*local_err
= NULL
;
850 g_debug("getting disk info for: %s", disk
->dev
);
851 disk_h
= CreateFile(disk
->dev
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
853 if (disk_h
== INVALID_HANDLE_VALUE
) {
854 error_setg_win32(errp
, GetLastError(), "failed to open disk");
858 get_disk_properties(disk_h
, disk
, &local_err
);
860 error_propagate(errp
, local_err
);
864 g_debug("bus type %d", disk
->bus_type
);
865 /* always set pci_controller as required by schema. get_pci_info() should
866 * report -1 values for non-PCI buses rather than fail. fail the command
867 * if that doesn't hold since that suggests some other unexpected
870 disk
->pci_controller
= get_pci_info(disk_number
, &local_err
);
872 error_propagate(errp
, local_err
);
875 if (disk
->bus_type
== GUEST_DISK_BUS_TYPE_SCSI
876 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_IDE
877 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_RAID
878 /* This bus type is not supported before Windows Server 2003 SP1 */
879 || disk
->bus_type
== GUEST_DISK_BUS_TYPE_SAS
881 /* We are able to use the same ioctls for different bus types
882 * according to Microsoft docs
883 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
884 g_debug("getting SCSI info");
885 if (DeviceIoControl(disk_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
886 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
887 disk
->unit
= addr
.Lun
;
888 disk
->target
= addr
.TargetId
;
889 disk
->bus
= addr
.PathId
;
891 /* We do not set error in this case, because we still have enough
892 * information about volume. */
900 /* VSS provider works with volumes, thus there is no difference if
901 * the volume consist of spanned disks. Info about the first disk in the
902 * volume is returned for the spanned disk group (LVM) */
903 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
905 Error
*local_err
= NULL
;
906 GuestDiskAddressList
*list
= NULL
;
907 GuestDiskAddress
*disk
= NULL
;
911 PVOLUME_DISK_EXTENTS extents
= NULL
;
913 /* strip final backslash */
914 char *name
= g_strdup(guid
);
915 if (g_str_has_suffix(name
, "\\")) {
916 name
[strlen(name
) - 1] = 0;
919 g_debug("opening %s", name
);
920 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
922 if (vol_h
== INVALID_HANDLE_VALUE
) {
923 error_setg_win32(errp
, GetLastError(), "failed to open volume");
927 /* Get list of extents */
928 g_debug("getting disk extents");
929 size
= sizeof(VOLUME_DISK_EXTENTS
);
930 extents
= g_malloc0(size
);
931 if (!DeviceIoControl(vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
932 0, extents
, size
, &size
, NULL
)) {
933 DWORD last_err
= GetLastError();
934 if (last_err
== ERROR_MORE_DATA
) {
935 /* Try once more with big enough buffer */
937 extents
= g_malloc0(size
);
938 if (!DeviceIoControl(
939 vol_h
, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS
, NULL
,
940 0, extents
, size
, NULL
, NULL
)) {
941 error_setg_win32(errp
, GetLastError(),
942 "failed to get disk extents");
945 } else if (last_err
== ERROR_INVALID_FUNCTION
) {
946 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
947 g_debug("volume not on disk");
948 disk
= g_new0(GuestDiskAddress
, 1);
949 disk
->has_dev
= true;
950 disk
->dev
= g_strdup(name
);
951 get_single_disk_info(0xffffffff, disk
, &local_err
);
953 g_debug("failed to get disk info, ignoring error: %s",
954 error_get_pretty(local_err
));
955 error_free(local_err
);
958 QAPI_LIST_PREPEND(list
, disk
);
962 error_setg_win32(errp
, GetLastError(),
963 "failed to get disk extents");
967 g_debug("Number of extents: %lu", extents
->NumberOfDiskExtents
);
969 /* Go through each extent */
970 for (i
= 0; i
< extents
->NumberOfDiskExtents
; i
++) {
971 disk
= g_new0(GuestDiskAddress
, 1);
973 /* Disk numbers directly correspond to numbers used in UNCs
975 * See documentation for DISK_EXTENT:
976 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
978 * See also Naming Files, Paths and Namespaces:
979 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
981 disk
->has_dev
= true;
982 disk
->dev
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
983 extents
->Extents
[i
].DiskNumber
);
985 get_single_disk_info(extents
->Extents
[i
].DiskNumber
, disk
, &local_err
);
987 error_propagate(errp
, local_err
);
990 QAPI_LIST_PREPEND(list
, disk
);
996 if (vol_h
!= INVALID_HANDLE_VALUE
) {
999 qapi_free_GuestDiskAddress(disk
);
1006 GuestDiskInfoList
*qmp_guest_get_disks(Error
**errp
)
1008 GuestDiskInfoList
*ret
= NULL
;
1010 SP_DEVICE_INTERFACE_DATA dev_iface_data
;
1013 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK
, 0, 0,
1014 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
1015 if (dev_info
== INVALID_HANDLE_VALUE
) {
1016 error_setg_win32(errp
, GetLastError(), "failed to get device tree");
1020 g_debug("enumerating devices");
1021 dev_iface_data
.cbSize
= sizeof(SP_DEVICE_INTERFACE_DATA
);
1023 SetupDiEnumDeviceInterfaces(dev_info
, NULL
, &GUID_DEVINTERFACE_DISK
,
1024 i
, &dev_iface_data
);
1026 GuestDiskAddress
*address
= NULL
;
1027 GuestDiskInfo
*disk
= NULL
;
1028 Error
*local_err
= NULL
;
1029 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1030 pdev_iface_detail_data
= NULL
;
1031 STORAGE_DEVICE_NUMBER sdn
;
1037 g_debug(" getting device path");
1038 for (attempt
= 0, result
= FALSE
; attempt
< 2 && !result
; attempt
++) {
1039 result
= SetupDiGetDeviceInterfaceDetail(dev_info
,
1040 &dev_iface_data
, pdev_iface_detail_data
, size
, &size
, NULL
);
1044 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
1045 pdev_iface_detail_data
= g_realloc(pdev_iface_detail_data
,
1047 pdev_iface_detail_data
->cbSize
=
1048 sizeof(*pdev_iface_detail_data
);
1050 g_debug("failed to get device interface details");
1055 g_debug("skipping device");
1059 g_debug(" device: %s", pdev_iface_detail_data
->DevicePath
);
1060 dev_file
= CreateFile(pdev_iface_detail_data
->DevicePath
, 0,
1061 FILE_SHARE_READ
, NULL
, OPEN_EXISTING
, 0, NULL
);
1062 if (!DeviceIoControl(dev_file
, IOCTL_STORAGE_GET_DEVICE_NUMBER
,
1063 NULL
, 0, &sdn
, sizeof(sdn
), &size
, NULL
)) {
1064 CloseHandle(dev_file
);
1065 debug_error("failed to get storage device number");
1068 CloseHandle(dev_file
);
1070 disk
= g_new0(GuestDiskInfo
, 1);
1071 disk
->name
= g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1074 g_debug(" number: %lu", sdn
.DeviceNumber
);
1075 address
= g_new0(GuestDiskAddress
, 1);
1076 address
->has_dev
= true;
1077 address
->dev
= g_strdup(disk
->name
);
1078 get_single_disk_info(sdn
.DeviceNumber
, address
, &local_err
);
1080 g_debug("failed to get disk info: %s",
1081 error_get_pretty(local_err
));
1082 error_free(local_err
);
1083 qapi_free_GuestDiskAddress(address
);
1086 disk
->address
= address
;
1087 disk
->has_address
= true;
1090 QAPI_LIST_PREPEND(ret
, disk
);
1093 SetupDiDestroyDeviceInfoList(dev_info
);
1097 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
1100 char mnt
, *mnt_point
;
1101 wchar_t wfs_name
[32];
1103 wchar_t vol_info
[MAX_PATH
+ 1];
1105 uint64_t i64FreeBytesToCaller
, i64TotalBytes
, i64FreeBytes
;
1106 GuestFilesystemInfo
*fs
= NULL
;
1107 HANDLE hLocalDiskHandle
= INVALID_HANDLE_VALUE
;
1109 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
1110 if (GetLastError() != ERROR_MORE_DATA
) {
1111 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1115 mnt_point
= g_malloc(info_size
+ 1);
1116 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
1118 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
1122 hLocalDiskHandle
= CreateFile(guid
, 0 , 0, NULL
, OPEN_EXISTING
,
1123 FILE_ATTRIBUTE_NORMAL
|
1124 FILE_FLAG_BACKUP_SEMANTICS
, NULL
);
1125 if (INVALID_HANDLE_VALUE
== hLocalDiskHandle
) {
1126 error_setg_win32(errp
, GetLastError(), "failed to get handle for volume");
1130 len
= strlen(mnt_point
);
1131 mnt_point
[len
] = '\\';
1132 mnt_point
[len
+ 1] = 0;
1134 if (!GetVolumeInformationByHandleW(hLocalDiskHandle
, vol_info
,
1135 sizeof(vol_info
), NULL
, NULL
, NULL
,
1136 (LPWSTR
) & wfs_name
, sizeof(wfs_name
))) {
1137 if (GetLastError() != ERROR_NOT_READY
) {
1138 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
1143 fs
= g_malloc(sizeof(*fs
));
1144 fs
->name
= g_strdup(guid
);
1145 fs
->has_total_bytes
= false;
1146 fs
->has_used_bytes
= false;
1148 fs
->mountpoint
= g_strdup("System Reserved");
1150 fs
->mountpoint
= g_strndup(mnt_point
, len
);
1151 if (GetDiskFreeSpaceEx(fs
->mountpoint
,
1152 (PULARGE_INTEGER
) & i64FreeBytesToCaller
,
1153 (PULARGE_INTEGER
) & i64TotalBytes
,
1154 (PULARGE_INTEGER
) & i64FreeBytes
)) {
1155 fs
->used_bytes
= i64TotalBytes
- i64FreeBytes
;
1156 fs
->total_bytes
= i64TotalBytes
;
1157 fs
->has_total_bytes
= true;
1158 fs
->has_used_bytes
= true;
1161 wcstombs(fs_name
, wfs_name
, sizeof(wfs_name
));
1162 fs
->type
= g_strdup(fs_name
);
1163 fs
->disk
= build_guest_disk_info(guid
, errp
);
1165 if (hLocalDiskHandle
!= INVALID_HANDLE_VALUE
) {
1166 CloseHandle(hLocalDiskHandle
);
1172 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
1175 GuestFilesystemInfoList
*ret
= NULL
;
1178 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
1179 if (vol_h
== INVALID_HANDLE_VALUE
) {
1180 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1185 Error
*local_err
= NULL
;
1186 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, &local_err
);
1188 g_debug("failed to get filesystem info, ignoring error: %s",
1189 error_get_pretty(local_err
));
1190 error_free(local_err
);
1193 QAPI_LIST_PREPEND(ret
, info
);
1194 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
1196 if (GetLastError() != ERROR_NO_MORE_FILES
) {
1197 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
1200 FindVolumeClose(vol_h
);
1205 * Return status of freeze/thaw
1207 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
1209 if (!vss_initialized()) {
1210 error_setg(errp
, QERR_UNSUPPORTED
);
1214 if (ga_is_frozen(ga_state
)) {
1215 return GUEST_FSFREEZE_STATUS_FROZEN
;
1218 return GUEST_FSFREEZE_STATUS_THAWED
;
1222 * Freeze local file systems using Volume Shadow-copy Service.
1223 * The frozen state is limited for up to 10 seconds by VSS.
1225 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
1227 return qmp_guest_fsfreeze_freeze_list(false, NULL
, errp
);
1230 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
1231 strList
*mountpoints
,
1235 Error
*local_err
= NULL
;
1237 if (!vss_initialized()) {
1238 error_setg(errp
, QERR_UNSUPPORTED
);
1242 slog("guest-fsfreeze called");
1244 /* cannot risk guest agent blocking itself on a write in this state */
1245 ga_set_frozen(ga_state
);
1247 qga_vss_fsfreeze(&i
, true, mountpoints
, &local_err
);
1249 error_propagate(errp
, local_err
);
1257 qmp_guest_fsfreeze_thaw(&local_err
);
1259 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
1260 error_free(local_err
);
1266 * Thaw local file systems using Volume Shadow-copy Service.
1268 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
1272 if (!vss_initialized()) {
1273 error_setg(errp
, QERR_UNSUPPORTED
);
1277 qga_vss_fsfreeze(&i
, false, NULL
, errp
);
1279 ga_unset_frozen(ga_state
);
1283 static void guest_fsfreeze_cleanup(void)
1287 if (!vss_initialized()) {
1291 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
1292 qmp_guest_fsfreeze_thaw(&err
);
1294 slog("failed to clean up frozen filesystems: %s",
1295 error_get_pretty(err
));
1304 * Walk list of mounted file systems in the guest, and discard unused
1307 GuestFilesystemTrimResponse
*
1308 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
1310 GuestFilesystemTrimResponse
*resp
;
1312 WCHAR guid
[MAX_PATH
] = L
"";
1316 ZeroMemory(&osvi
, sizeof(OSVERSIONINFO
));
1317 osvi
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
1318 GetVersionEx(&osvi
);
1319 win8_or_later
= (osvi
.dwMajorVersion
> 6 ||
1320 ((osvi
.dwMajorVersion
== 6) &&
1321 (osvi
.dwMinorVersion
>= 2)));
1322 if (!win8_or_later
) {
1323 error_setg(errp
, "fstrim is only supported for Win8+");
1327 handle
= FindFirstVolumeW(guid
, ARRAYSIZE(guid
));
1328 if (handle
== INVALID_HANDLE_VALUE
) {
1329 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
1333 resp
= g_new0(GuestFilesystemTrimResponse
, 1);
1336 GuestFilesystemTrimResult
*res
;
1338 DWORD char_count
= 0;
1340 GError
*gerr
= NULL
;
1343 GetVolumePathNamesForVolumeNameW(guid
, NULL
, 0, &char_count
);
1345 if (GetLastError() != ERROR_MORE_DATA
) {
1348 if (GetDriveTypeW(guid
) != DRIVE_FIXED
) {
1352 uc_path
= g_new(WCHAR
, char_count
);
1353 if (!GetVolumePathNamesForVolumeNameW(guid
, uc_path
, char_count
,
1354 &char_count
) || !*uc_path
) {
1355 /* strange, but this condition could be faced even with size == 2 */
1360 res
= g_new0(GuestFilesystemTrimResult
, 1);
1362 path
= g_utf16_to_utf8(uc_path
, char_count
, NULL
, NULL
, &gerr
);
1367 res
->has_error
= true;
1368 res
->error
= g_strdup(gerr
->message
);
1375 QAPI_LIST_PREPEND(resp
->paths
, res
);
1377 memset(argv
, 0, sizeof(argv
));
1378 argv
[0] = (gchar
*)"defrag.exe";
1379 argv
[1] = (gchar
*)"/L";
1382 if (!g_spawn_sync(NULL
, argv
, NULL
, G_SPAWN_SEARCH_PATH
, NULL
, NULL
,
1383 &out
/* stdout */, NULL
/* stdin */,
1385 res
->has_error
= true;
1386 res
->error
= g_strdup(gerr
->message
);
1389 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1390 Error is reported in the output with something like
1391 (x89000020) etc code in the stdout */
1394 gchar
**lines
= g_strsplit(out
, "\r\n", 0);
1397 for (i
= 0; lines
[i
] != NULL
; i
++) {
1398 if (g_strstr_len(lines
[i
], -1, "(0x") == NULL
) {
1401 res
->has_error
= true;
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]);
1682 info
->has_hardware_address
= true;
1686 tail_addr
= &head_addr
;
1687 for (ip_addr
= addr
->FirstUnicastAddress
;
1689 ip_addr
= ip_addr
->Next
) {
1690 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1691 if (addr_str
== NULL
) {
1695 address_item
= g_malloc0(sizeof(*address_item
));
1697 QAPI_LIST_APPEND(tail_addr
, address_item
);
1699 address_item
->ip_address
= addr_str
;
1700 address_item
->prefix
= guest_ip_prefix(ip_addr
);
1701 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1702 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV4
;
1703 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1704 address_item
->ip_address_type
= GUEST_IP_ADDRESS_TYPE_IPV6
;
1708 info
->has_ip_addresses
= true;
1709 info
->ip_addresses
= head_addr
;
1711 if (!info
->has_statistics
) {
1712 interface_stat
= g_malloc0(sizeof(*interface_stat
));
1713 if (guest_get_network_stats(addr
->AdapterName
,
1714 interface_stat
) == -1) {
1715 info
->has_statistics
= false;
1716 g_free(interface_stat
);
1718 info
->statistics
= interface_stat
;
1719 info
->has_statistics
= true;
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 blacklist */
2004 GList
*ga_command_blacklist_init(GList
*blacklist
)
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 blacklist
= g_list_append(blacklist
, 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 blacklist
= g_list_append(blacklist
, 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
);
2111 user
->has_domain
= true;
2113 user
->login_time
= login_time
;
2115 g_hash_table_add(cache
, user
->user
);
2117 QAPI_LIST_APPEND(tail
, user
);
2120 WTSFreeMemory(info
);
2122 WTSFreeMemory(entries
);
2124 g_hash_table_destroy(cache
);
2128 typedef struct _ga_matrix_lookup_t
{
2131 char const *version
;
2132 char const *version_id
;
2133 } ga_matrix_lookup_t
;
2135 static ga_matrix_lookup_t
const WIN_VERSION_MATRIX
[2][7] = {
2137 /* Desktop editions */
2138 { 5, 0, "Microsoft Windows 2000", "2000"},
2139 { 5, 1, "Microsoft Windows XP", "xp"},
2140 { 6, 0, "Microsoft Windows Vista", "vista"},
2141 { 6, 1, "Microsoft Windows 7" "7"},
2142 { 6, 2, "Microsoft Windows 8", "8"},
2143 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2146 /* Server editions */
2147 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2148 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2149 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2150 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2151 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2157 typedef struct _ga_win_10_0_t
{
2159 char const *version
;
2160 char const *version_id
;
2163 static ga_win_10_0_t
const WIN_10_0_SERVER_VERSION_MATRIX
[4] = {
2164 {14393, "Microsoft Windows Server 2016", "2016"},
2165 {17763, "Microsoft Windows Server 2019", "2019"},
2166 {20344, "Microsoft Windows Server 2022", "2022"},
2170 static ga_win_10_0_t
const WIN_10_0_CLIENT_VERSION_MATRIX
[3] = {
2171 {10240, "Microsoft Windows 10", "10"},
2172 {22000, "Microsoft Windows 11", "11"},
2176 static void ga_get_win_version(RTL_OSVERSIONINFOEXW
*info
, Error
**errp
)
2178 typedef NTSTATUS(WINAPI
*rtl_get_version_t
)(
2179 RTL_OSVERSIONINFOEXW
*os_version_info_ex
);
2181 info
->dwOSVersionInfoSize
= sizeof(RTL_OSVERSIONINFOEXW
);
2183 HMODULE module
= GetModuleHandle("ntdll");
2184 PVOID fun
= GetProcAddress(module
, "RtlGetVersion");
2186 error_setg(errp
, QERR_QGA_COMMAND_FAILED
,
2187 "Failed to get address of RtlGetVersion");
2191 rtl_get_version_t rtl_get_version
= (rtl_get_version_t
)fun
;
2192 rtl_get_version(info
);
2196 static char *ga_get_win_name(OSVERSIONINFOEXW
const *os_version
, bool id
)
2198 DWORD major
= os_version
->dwMajorVersion
;
2199 DWORD minor
= os_version
->dwMinorVersion
;
2200 DWORD build
= os_version
->dwBuildNumber
;
2201 int tbl_idx
= (os_version
->wProductType
!= VER_NT_WORKSTATION
);
2202 ga_matrix_lookup_t
const *table
= WIN_VERSION_MATRIX
[tbl_idx
];
2203 ga_win_10_0_t
const *win_10_0_table
= tbl_idx
?
2204 WIN_10_0_SERVER_VERSION_MATRIX
: WIN_10_0_CLIENT_VERSION_MATRIX
;
2205 ga_win_10_0_t
const *win_10_0_version
= NULL
;
2206 while (table
->version
!= NULL
) {
2207 if (major
== 10 && minor
== 0) {
2208 while (win_10_0_table
->version
!= NULL
) {
2209 if (build
>= win_10_0_table
->first_build
) {
2210 win_10_0_version
= win_10_0_table
;
2214 if (win_10_0_table
) {
2216 return g_strdup(win_10_0_version
->version_id
);
2218 return g_strdup(win_10_0_version
->version
);
2221 } else if (major
== table
->major
&& minor
== table
->minor
) {
2223 return g_strdup(table
->version_id
);
2225 return g_strdup(table
->version
);
2230 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2232 return g_strdup("N/A");
2235 static char *ga_get_win_product_name(Error
**errp
)
2237 HKEY key
= INVALID_HANDLE_VALUE
;
2239 char *result
= g_malloc0(size
);
2240 LONG err
= ERROR_SUCCESS
;
2242 err
= RegOpenKeyA(HKEY_LOCAL_MACHINE
,
2243 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2245 if (err
!= ERROR_SUCCESS
) {
2246 error_setg_win32(errp
, err
, "failed to open registry key");
2251 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2252 (LPBYTE
)result
, &size
);
2253 if (err
== ERROR_MORE_DATA
) {
2254 slog("ProductName longer than expected (%lu bytes), retrying",
2259 result
= g_malloc0(size
);
2260 err
= RegQueryValueExA(key
, "ProductName", NULL
, NULL
,
2261 (LPBYTE
)result
, &size
);
2264 if (err
!= ERROR_SUCCESS
) {
2265 error_setg_win32(errp
, err
, "failed to retrive ProductName");
2273 if (key
!= INVALID_HANDLE_VALUE
) {
2280 static char *ga_get_current_arch(void)
2283 GetNativeSystemInfo(&info
);
2284 char *result
= NULL
;
2285 switch (info
.wProcessorArchitecture
) {
2286 case PROCESSOR_ARCHITECTURE_AMD64
:
2287 result
= g_strdup("x86_64");
2289 case PROCESSOR_ARCHITECTURE_ARM
:
2290 result
= g_strdup("arm");
2292 case PROCESSOR_ARCHITECTURE_IA64
:
2293 result
= g_strdup("ia64");
2295 case PROCESSOR_ARCHITECTURE_INTEL
:
2296 result
= g_strdup("x86");
2298 case PROCESSOR_ARCHITECTURE_UNKNOWN
:
2300 slog("unknown processor architecture 0x%0x",
2301 info
.wProcessorArchitecture
);
2302 result
= g_strdup("unknown");
2308 GuestOSInfo
*qmp_guest_get_osinfo(Error
**errp
)
2310 Error
*local_err
= NULL
;
2311 OSVERSIONINFOEXW os_version
= {0};
2316 ga_get_win_version(&os_version
, &local_err
);
2318 error_propagate(errp
, local_err
);
2322 server
= os_version
.wProductType
!= VER_NT_WORKSTATION
;
2323 product_name
= ga_get_win_product_name(errp
);
2324 if (product_name
== NULL
) {
2328 info
= g_new0(GuestOSInfo
, 1);
2330 info
->has_kernel_version
= true;
2331 info
->kernel_version
= g_strdup_printf("%lu.%lu",
2332 os_version
.dwMajorVersion
,
2333 os_version
.dwMinorVersion
);
2334 info
->has_kernel_release
= true;
2335 info
->kernel_release
= g_strdup_printf("%lu",
2336 os_version
.dwBuildNumber
);
2337 info
->has_machine
= true;
2338 info
->machine
= ga_get_current_arch();
2340 info
->has_id
= true;
2341 info
->id
= g_strdup("mswindows");
2342 info
->has_name
= true;
2343 info
->name
= g_strdup("Microsoft Windows");
2344 info
->has_pretty_name
= true;
2345 info
->pretty_name
= product_name
;
2346 info
->has_version
= true;
2347 info
->version
= ga_get_win_name(&os_version
, false);
2348 info
->has_version_id
= true;
2349 info
->version_id
= ga_get_win_name(&os_version
, true);
2350 info
->has_variant
= true;
2351 info
->variant
= g_strdup(server
? "server" : "client");
2352 info
->has_variant_id
= true;
2353 info
->variant_id
= g_strdup(server
? "server" : "client");
2359 * Safely get device property. Returned strings are using wide characters.
2360 * Caller is responsible for freeing the buffer.
2362 static LPBYTE
cm_get_property(DEVINST devInst
, const DEVPROPKEY
*propName
,
2363 PDEVPROPTYPE propType
)
2366 g_autofree LPBYTE buffer
= NULL
;
2367 ULONG buffer_len
= 0;
2369 /* First query for needed space */
2370 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2371 buffer
, &buffer_len
, 0);
2372 if (cr
!= CR_SUCCESS
&& cr
!= CR_BUFFER_SMALL
) {
2374 slog("failed to get property size, error=0x%lx", cr
);
2377 buffer
= g_new0(BYTE
, buffer_len
+ 1);
2378 cr
= CM_Get_DevNode_PropertyW(devInst
, propName
, propType
,
2379 buffer
, &buffer_len
, 0);
2380 if (cr
!= CR_SUCCESS
) {
2381 slog("failed to get device property, error=0x%lx", cr
);
2384 return g_steal_pointer(&buffer
);
2387 static GStrv
ga_get_hardware_ids(DEVINST devInstance
)
2389 GArray
*values
= NULL
;
2390 DEVPROPTYPE cm_type
;
2392 g_autofree LPWSTR property
= (LPWSTR
)cm_get_property(devInstance
,
2393 &qga_DEVPKEY_Device_HardwareIds
, &cm_type
);
2394 if (property
== NULL
) {
2395 slog("failed to get hardware IDs");
2398 if (*property
== '\0') {
2402 values
= g_array_new(TRUE
, TRUE
, sizeof(gchar
*));
2403 for (id
= property
; '\0' != *id
; id
+= lstrlenW(id
) + 1) {
2404 gchar
*id8
= g_utf16_to_utf8(id
, -1, NULL
, NULL
, NULL
);
2405 g_array_append_val(values
, id8
);
2407 return (GStrv
)g_array_free(values
, FALSE
);
2411 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2413 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2415 GuestDeviceInfoList
*qmp_guest_get_devices(Error
**errp
)
2417 GuestDeviceInfoList
*head
= NULL
, **tail
= &head
;
2418 HDEVINFO dev_info
= INVALID_HANDLE_VALUE
;
2419 SP_DEVINFO_DATA dev_info_data
;
2421 GError
*gerr
= NULL
;
2422 g_autoptr(GRegex
) device_pci_re
= NULL
;
2423 DEVPROPTYPE cm_type
;
2425 device_pci_re
= g_regex_new(DEVICE_PCI_RE
,
2426 G_REGEX_ANCHORED
| G_REGEX_OPTIMIZE
, 0,
2428 g_assert(device_pci_re
!= NULL
);
2430 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
2431 dev_info
= SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT
| DIGCF_ALLCLASSES
);
2432 if (dev_info
== INVALID_HANDLE_VALUE
) {
2433 error_setg(errp
, "failed to get device tree");
2437 slog("enumerating devices");
2438 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
2440 g_autofree LPWSTR name
= NULL
;
2441 g_autofree LPFILETIME date
= NULL
;
2442 g_autofree LPWSTR version
= NULL
;
2443 g_auto(GStrv
) hw_ids
= NULL
;
2444 g_autoptr(GuestDeviceInfo
) device
= g_new0(GuestDeviceInfo
, 1);
2445 g_autofree
char *vendor_id
= NULL
;
2446 g_autofree
char *device_id
= NULL
;
2448 name
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2449 &qga_DEVPKEY_NAME
, &cm_type
);
2451 slog("failed to get device description");
2454 device
->driver_name
= g_utf16_to_utf8(name
, -1, NULL
, NULL
, NULL
);
2455 if (device
->driver_name
== NULL
) {
2456 error_setg(errp
, "conversion to utf8 failed (driver name)");
2459 slog("querying device: %s", device
->driver_name
);
2460 hw_ids
= ga_get_hardware_ids(dev_info_data
.DevInst
);
2461 if (hw_ids
== NULL
) {
2464 for (j
= 0; hw_ids
[j
] != NULL
; j
++) {
2465 g_autoptr(GMatchInfo
) match_info
;
2466 GuestDeviceIdPCI
*id
;
2467 if (!g_regex_match(device_pci_re
, hw_ids
[j
], 0, &match_info
)) {
2472 vendor_id
= g_match_info_fetch(match_info
, 1);
2473 device_id
= g_match_info_fetch(match_info
, 2);
2475 device
->id
= g_new0(GuestDeviceId
, 1);
2476 device
->has_id
= true;
2477 device
->id
->type
= GUEST_DEVICE_TYPE_PCI
;
2478 id
= &device
->id
->u
.pci
;
2479 id
->vendor_id
= g_ascii_strtoull(vendor_id
, NULL
, 16);
2480 id
->device_id
= g_ascii_strtoull(device_id
, NULL
, 16);
2488 version
= (LPWSTR
)cm_get_property(dev_info_data
.DevInst
,
2489 &qga_DEVPKEY_Device_DriverVersion
, &cm_type
);
2490 if (version
== NULL
) {
2491 slog("failed to get driver version");
2494 device
->driver_version
= g_utf16_to_utf8(version
, -1, NULL
,
2496 if (device
->driver_version
== NULL
) {
2497 error_setg(errp
, "conversion to utf8 failed (driver version)");
2500 device
->has_driver_version
= true;
2502 date
= (LPFILETIME
)cm_get_property(dev_info_data
.DevInst
,
2503 &qga_DEVPKEY_Device_DriverDate
, &cm_type
);
2505 slog("failed to get driver date");
2508 device
->driver_date
= filetime_to_ns(date
);
2509 device
->has_driver_date
= true;
2511 slog("driver: %s\ndriver version: %" PRId64
",%s\n",
2512 device
->driver_name
, device
->driver_date
,
2513 device
->driver_version
);
2514 QAPI_LIST_APPEND(tail
, g_steal_pointer(&device
));
2517 if (dev_info
!= INVALID_HANDLE_VALUE
) {
2518 SetupDiDestroyDeviceInfoList(dev_info
);
2523 char *qga_get_host_name(Error
**errp
)
2525 wchar_t tmp
[MAX_COMPUTERNAME_LENGTH
+ 1];
2526 DWORD size
= G_N_ELEMENTS(tmp
);
2528 if (GetComputerNameW(tmp
, &size
) == 0) {
2529 error_setg_win32(errp
, GetLastError(), "failed close handle");
2533 return g_utf16_to_utf8(tmp
, size
, NULL
, NULL
, NULL
);