Merge tag 'v9.0.0-rc3'
[qemu/ar7.git] / qga / commands-win32.c
blob6242737b005da55187cd050214d8798903f38b46
1 /*
2 * QEMU Guest Agent win32-specific command implementations
4 * Copyright IBM Corp. 2012
6 * Authors:
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"
15 #include <wtypes.h>
16 #include <powrprof.h>
17 #include <winsock2.h>
18 #include <ws2tcpip.h>
19 #include <iptypes.h>
20 #include <iphlpapi.h>
21 #include <winioctl.h>
22 #include <ntddscsi.h>
23 #include <setupapi.h>
24 #include <cfgmgr32.h>
25 #include <initguid.h>
26 #include <devpropdef.h>
27 #include <lm.h>
28 #include <wtsapi32.h>
29 #include <wininet.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(
63 DEVINST dnDevInst,
64 CONST DEVPROPKEY * PropertyKey,
65 DEVPROPTYPE * PropertyType,
66 PBYTE PropertyBuffer,
67 PULONG PropertyBufferSize,
68 ULONG ulFlags
70 #define CM_Get_DevNode_Property CM_Get_DevNode_PropertyW
71 #pragma GCC diagnostic pop
72 #endif
74 #ifndef SHTDN_REASON_FLAG_PLANNED
75 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
76 #endif
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 {
87 int64_t id;
88 HANDLE fh;
89 QTAILQ_ENTRY(GuestFileHandle) next;
92 static struct {
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 {
101 const char *forms;
102 DWORD desired_access;
103 DWORD creation_disposition;
104 } OpenFlags;
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); \
125 g_free(suffix); \
126 } while (0)
128 static OpenFlags *find_open_flag(const char *mode_str)
130 int mode;
131 Error **errp = NULL;
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) {
137 return flags;
141 error_setg(errp, "invalid file open mode '%s'", mode_str);
142 return NULL;
145 static int64_t guest_file_handle_add(HANDLE fh, Error **errp)
147 GuestFileHandle *gfh;
148 int64_t handle;
150 handle = ga_get_fd_handle(ga_state, errp);
151 if (handle < 0) {
152 return -1;
154 gfh = g_new0(GuestFileHandle, 1);
155 gfh->id = handle;
156 gfh->fh = fh;
157 QTAILQ_INSERT_TAIL(&guest_file_state.filehandles, gfh, next);
159 return handle;
162 GuestFileHandle *guest_file_handle_find(int64_t id, Error **errp)
164 GuestFileHandle *gfh;
165 QTAILQ_FOREACH(gfh, &guest_file_state.filehandles, next) {
166 if (gfh->id == id) {
167 return gfh;
170 error_setg(errp, "handle '%" PRId64 "' has not been found", id);
171 return NULL;
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) {
179 return;
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)) {
185 return;
187 /* The fd is named pipe fd */
188 if (pipe_state & PIPE_NOWAIT) {
189 return;
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)
198 int64_t fd = -1;
199 HANDLE fh;
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;
205 GError *gerr = NULL;
206 wchar_t *w_path = NULL;
208 if (!mode) {
209 mode = "r";
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");
215 goto done;
218 w_path = g_utf8_to_utf16(path, -1, NULL, NULL, &gerr);
219 if (!w_path) {
220 goto done;
223 fh = CreateFileW(w_path, guest_flags->desired_access, share_mode, sa_attr,
224 guest_flags->creation_disposition, flags_and_attr,
225 templ_file);
226 if (fh == INVALID_HANDLE_VALUE) {
227 error_setg_win32(errp, GetLastError(), "failed to open file '%s'",
228 path);
229 goto done;
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);
238 if (fd < 0) {
239 CloseHandle(fh);
240 error_setg(errp, "failed to add handle to qmp handle table");
241 goto done;
244 slog("guest-file-open, handle: % " PRId64, fd);
246 done:
247 if (gerr) {
248 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
249 g_error_free(gerr);
251 g_free(w_path);
252 return fd;
255 void qmp_guest_file_close(int64_t handle, Error **errp)
257 bool ret;
258 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
259 slog("guest-file-close called, handle: %" PRId64, handle);
260 if (gfh == NULL) {
261 return;
263 ret = CloseHandle(gfh->fh);
264 if (!ret) {
265 error_setg_win32(errp, GetLastError(), "failed close handle");
266 return;
269 QTAILQ_REMOVE(&guest_file_state.filehandles, gfh, next);
270 g_free(gfh);
273 static void acquire_privilege(const char *name, Error **errp)
275 HANDLE token = NULL;
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");
284 goto out;
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");
293 goto out;
296 } else {
297 error_setg(errp, QERR_QGA_COMMAND_FAILED,
298 "failed to open privilege token");
301 out:
302 if (token) {
303 CloseHandle(token);
307 static void execute_async(DWORD WINAPI (*func)(LPVOID), LPVOID opaque,
308 Error **errp)
310 HANDLE thread = CreateThread(NULL, 0, func, opaque, 0, NULL);
311 if (!thread) {
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;
330 } else {
331 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "mode",
332 "'halt', 'powerdown', or 'reboot'");
333 return;
336 /* Request a shutdown privilege, but try to shut down the system
337 anyway. */
338 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
339 if (local_err) {
340 error_propagate(errp, local_err);
341 return;
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;
355 guchar *buf;
356 HANDLE fh = gfh->fh;
357 bool is_ok;
358 DWORD read_count;
360 buf = g_malloc0(count + 1);
361 is_ok = ReadFile(fh, buf, count, &read_count, NULL);
362 if (!is_ok) {
363 error_setg_win32(errp, GetLastError(), "failed to read file");
364 } else {
365 buf[read_count] = 0;
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);
374 g_free(buf);
376 return read_data;
379 GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64,
380 bool has_count, int64_t count,
381 Error **errp)
383 GuestFileWrite *write_data = NULL;
384 guchar *buf;
385 gsize buf_len;
386 bool is_ok;
387 DWORD write_count;
388 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
389 HANDLE fh;
391 if (!gfh) {
392 return NULL;
394 fh = gfh->fh;
395 buf = qbase64_decode(buf_b64, -1, &buf_len, errp);
396 if (!buf) {
397 return NULL;
400 if (!has_count) {
401 count = buf_len;
402 } else if (count < 0 || count > buf_len) {
403 error_setg(errp, "value '%" PRId64
404 "' is invalid for argument count", count);
405 goto done;
408 is_ok = WriteFile(fh, buf, count, &write_count, NULL);
409 if (!is_ok) {
410 error_setg_win32(errp, GetLastError(), "failed to write to file");
411 slog("guest-file-write-failed, handle: %" PRId64, handle);
412 } else {
413 write_data = g_new0(GuestFileWrite, 1);
414 write_data->count = (size_t) write_count;
417 done:
418 g_free(buf);
419 return write_data;
422 GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset,
423 GuestFileWhence *whence_code,
424 Error **errp)
426 GuestFileHandle *gfh;
427 GuestFileSeek *seek_data;
428 HANDLE fh;
429 LARGE_INTEGER new_pos, off_pos;
430 off_pos.QuadPart = offset;
431 BOOL res;
432 int whence;
433 Error *err = NULL;
435 gfh = guest_file_handle_find(handle, errp);
436 if (!gfh) {
437 return NULL;
440 /* We stupidly exposed 'whence':'int' in our qapi */
441 whence = ga_parse_whence(whence_code, &err);
442 if (err) {
443 error_propagate(errp, err);
444 return NULL;
447 fh = gfh->fh;
448 res = SetFilePointerEx(fh, off_pos, &new_pos, whence);
449 if (!res) {
450 error_setg_win32(errp, GetLastError(), "failed to seek file");
451 return NULL;
453 seek_data = g_new0(GuestFileSeek, 1);
454 seek_data->position = new_pos.QuadPart;
455 return seek_data;
458 void qmp_guest_file_flush(int64_t handle, Error **errp)
460 HANDLE fh;
461 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
462 if (!gfh) {
463 return;
466 fh = gfh->fh;
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 [BusTypeVirtual] = GUEST_DISK_BUS_TYPE_VIRTUAL,
488 [BusTypeFileBackedVirtual] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL,
490 * BusTypeSpaces currently is not supported
492 [BusTypeSpaces] = GUEST_DISK_BUS_TYPE_UNKNOWN,
493 [BusTypeNvme] = GUEST_DISK_BUS_TYPE_NVME,
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 static void get_pci_address_for_device(GuestPCIAddress *pci,
505 HDEVINFO dev_info)
507 SP_DEVINFO_DATA dev_info_data;
508 DWORD j;
509 DWORD size;
510 bool partial_pci = false;
512 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
514 for (j = 0;
515 SetupDiEnumDeviceInfo(dev_info, j, &dev_info_data);
516 j++) {
517 DWORD addr, bus, ui_slot, type;
518 int func, slot;
519 size = sizeof(DWORD);
522 * There is no need to allocate buffer in the next functions. The
523 * size is known and ULONG according to
524 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
526 if (!SetupDiGetDeviceRegistryProperty(
527 dev_info, &dev_info_data, SPDRP_BUSNUMBER,
528 &type, (PBYTE)&bus, size, NULL)) {
529 debug_error("failed to get PCI bus");
530 bus = -1;
531 partial_pci = true;
535 * The function retrieves the device's address. This value will be
536 * transformed into device function and number
538 if (!SetupDiGetDeviceRegistryProperty(
539 dev_info, &dev_info_data, SPDRP_ADDRESS,
540 &type, (PBYTE)&addr, size, NULL)) {
541 debug_error("failed to get PCI address");
542 addr = -1;
543 partial_pci = true;
547 * This call returns UINumber of DEVICE_CAPABILITIES structure.
548 * This number is typically a user-perceived slot number.
550 if (!SetupDiGetDeviceRegistryProperty(
551 dev_info, &dev_info_data, SPDRP_UI_NUMBER,
552 &type, (PBYTE)&ui_slot, size, NULL)) {
553 debug_error("failed to get PCI slot");
554 ui_slot = -1;
555 partial_pci = true;
559 * SetupApi gives us the same information as driver with
560 * IoGetDeviceProperty. According to Microsoft:
562 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF)
563 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF)
564 * SPDRP_ADDRESS is propertyAddress, so we do the same.
566 * https://docs.microsoft.com/en-us/windows/desktop/api/setupapi/nf-setupapi-setupdigetdeviceregistrypropertya
568 if (partial_pci) {
569 pci->domain = -1;
570 pci->slot = -1;
571 pci->function = -1;
572 pci->bus = -1;
573 continue;
574 } else {
575 func = ((int)addr == -1) ? -1 : addr & 0x0000FFFF;
576 slot = ((int)addr == -1) ? -1 : (addr >> 16) & 0x0000FFFF;
577 if ((int)ui_slot != slot) {
578 g_debug("mismatch with reported slot values: %d vs %d",
579 (int)ui_slot, slot);
581 pci->domain = 0;
582 pci->slot = (int)ui_slot;
583 pci->function = func;
584 pci->bus = (int)bus;
585 return;
590 static GuestPCIAddress *get_empty_pci_address(void)
592 GuestPCIAddress *pci = NULL;
594 pci = g_malloc0(sizeof(*pci));
595 pci->domain = -1;
596 pci->slot = -1;
597 pci->function = -1;
598 pci->bus = -1;
599 return pci;
602 static GuestPCIAddress *get_pci_info(int number, Error **errp)
604 HDEVINFO dev_info = INVALID_HANDLE_VALUE;
605 HDEVINFO parent_dev_info = INVALID_HANDLE_VALUE;
607 SP_DEVINFO_DATA dev_info_data;
608 SP_DEVICE_INTERFACE_DATA dev_iface_data;
609 HANDLE dev_file;
610 int i;
611 GuestPCIAddress *pci = get_empty_pci_address();
613 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
614 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
615 if (dev_info == INVALID_HANDLE_VALUE) {
616 error_setg_win32(errp, GetLastError(), "failed to get devices tree");
617 goto end;
620 g_debug("enumerating devices");
621 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
622 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
623 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
624 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA pdev_iface_detail_data = NULL;
625 STORAGE_DEVICE_NUMBER sdn;
626 g_autofree char *parent_dev_id = NULL;
627 SP_DEVINFO_DATA parent_dev_info_data;
628 DWORD size = 0;
630 g_debug("getting device path");
631 if (SetupDiEnumDeviceInterfaces(dev_info, &dev_info_data,
632 &GUID_DEVINTERFACE_DISK, 0,
633 &dev_iface_data)) {
634 if (!SetupDiGetDeviceInterfaceDetail(dev_info, &dev_iface_data,
635 pdev_iface_detail_data,
636 size, &size,
637 &dev_info_data)) {
638 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
639 pdev_iface_detail_data = g_malloc(size);
640 pdev_iface_detail_data->cbSize =
641 sizeof(*pdev_iface_detail_data);
642 } else {
643 error_setg_win32(errp, GetLastError(),
644 "failed to get device interfaces");
645 goto end;
649 if (!SetupDiGetDeviceInterfaceDetail(dev_info, &dev_iface_data,
650 pdev_iface_detail_data,
651 size, &size,
652 &dev_info_data)) {
653 // pdev_iface_detail_data already is allocated
654 error_setg_win32(errp, GetLastError(),
655 "failed to get device interfaces");
656 goto end;
659 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
660 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0,
661 NULL);
663 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
664 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
665 CloseHandle(dev_file);
666 error_setg_win32(errp, GetLastError(),
667 "failed to get device slot number");
668 goto end;
671 CloseHandle(dev_file);
672 if (sdn.DeviceNumber != number) {
673 continue;
675 } else {
676 error_setg_win32(errp, GetLastError(),
677 "failed to get device interfaces");
678 goto end;
681 g_debug("found device slot %d. Getting storage controller", number);
683 CONFIGRET cr;
684 DEVINST dev_inst, parent_dev_inst;
685 ULONG dev_id_size = 0;
687 size = 0;
688 if (!SetupDiGetDeviceInstanceId(dev_info, &dev_info_data,
689 parent_dev_id, size, &size)) {
690 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
691 parent_dev_id = g_malloc(size);
692 } else {
693 error_setg_win32(errp, GetLastError(),
694 "failed to get device instance ID");
695 goto end;
699 if (!SetupDiGetDeviceInstanceId(dev_info, &dev_info_data,
700 parent_dev_id, size, &size)) {
701 // parent_dev_id already is allocated
702 error_setg_win32(errp, GetLastError(),
703 "failed to get device instance ID");
704 goto end;
708 * CM API used here as opposed to
709 * SetupDiGetDeviceProperty(..., DEVPKEY_Device_Parent, ...)
710 * which exports are only available in mingw-w64 6+
712 cr = CM_Locate_DevInst(&dev_inst, parent_dev_id, 0);
713 if (cr != CR_SUCCESS) {
714 g_error("CM_Locate_DevInst failed with code %lx", cr);
715 error_setg_win32(errp, GetLastError(),
716 "failed to get device instance");
717 goto end;
719 cr = CM_Get_Parent(&parent_dev_inst, dev_inst, 0);
720 if (cr != CR_SUCCESS) {
721 g_error("CM_Get_Parent failed with code %lx", cr);
722 error_setg_win32(errp, GetLastError(),
723 "failed to get parent device instance");
724 goto end;
727 cr = CM_Get_Device_ID_Size(&dev_id_size, parent_dev_inst, 0);
728 if (cr != CR_SUCCESS) {
729 g_error("CM_Get_Device_ID_Size failed with code %lx", cr);
730 error_setg_win32(errp, GetLastError(),
731 "failed to get parent device ID length");
732 goto end;
735 ++dev_id_size;
736 if (dev_id_size > size) {
737 g_free(parent_dev_id);
738 parent_dev_id = g_malloc(dev_id_size);
741 cr = CM_Get_Device_ID(parent_dev_inst, parent_dev_id, dev_id_size,
743 if (cr != CR_SUCCESS) {
744 g_error("CM_Get_Device_ID failed with code %lx", cr);
745 error_setg_win32(errp, GetLastError(),
746 "failed to get parent device ID");
747 goto end;
751 g_debug("querying storage controller %s for PCI information",
752 parent_dev_id);
753 parent_dev_info =
754 SetupDiGetClassDevs(&GUID_DEVINTERFACE_STORAGEPORT, parent_dev_id,
755 NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
757 if (parent_dev_info == INVALID_HANDLE_VALUE) {
758 error_setg_win32(errp, GetLastError(),
759 "failed to get parent device");
760 goto end;
763 parent_dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
764 if (!SetupDiEnumDeviceInfo(parent_dev_info, 0, &parent_dev_info_data)) {
765 error_setg_win32(errp, GetLastError(),
766 "failed to get parent device data");
767 goto end;
770 get_pci_address_for_device(pci, parent_dev_info);
772 break;
775 end:
776 if (parent_dev_info != INVALID_HANDLE_VALUE) {
777 SetupDiDestroyDeviceInfoList(parent_dev_info);
779 if (dev_info != INVALID_HANDLE_VALUE) {
780 SetupDiDestroyDeviceInfoList(dev_info);
782 return pci;
785 static void get_disk_properties(HANDLE vol_h, GuestDiskAddress *disk,
786 Error **errp)
788 STORAGE_PROPERTY_QUERY query;
789 STORAGE_DEVICE_DESCRIPTOR *dev_desc, buf;
790 DWORD received;
791 ULONG size = sizeof(buf);
793 dev_desc = &buf;
794 query.PropertyId = StorageDeviceProperty;
795 query.QueryType = PropertyStandardQuery;
797 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
798 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
799 size, &received, NULL)) {
800 error_setg_win32(errp, GetLastError(), "failed to get bus type");
801 return;
803 disk->bus_type = find_bus_type(dev_desc->BusType);
804 g_debug("bus type %d", disk->bus_type);
806 /* Query once more. Now with long enough buffer. */
807 size = dev_desc->Size;
808 dev_desc = g_malloc0(size);
809 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
810 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
811 size, &received, NULL)) {
812 error_setg_win32(errp, GetLastError(), "failed to get serial number");
813 g_debug("failed to get serial number");
814 goto out_free;
816 if (dev_desc->SerialNumberOffset > 0) {
817 const char *serial;
818 size_t len;
820 if (dev_desc->SerialNumberOffset >= received) {
821 error_setg(errp, "failed to get serial number: offset outside the buffer");
822 g_debug("serial number offset outside the buffer");
823 goto out_free;
825 serial = (char *)dev_desc + dev_desc->SerialNumberOffset;
826 len = received - dev_desc->SerialNumberOffset;
827 g_debug("serial number \"%s\"", serial);
828 if (*serial != 0) {
829 disk->serial = g_strndup(serial, len);
832 out_free:
833 g_free(dev_desc);
835 return;
838 static void get_single_disk_info(int disk_number,
839 GuestDiskAddress *disk, Error **errp)
841 SCSI_ADDRESS addr, *scsi_ad;
842 DWORD len;
843 HANDLE disk_h;
844 Error *local_err = NULL;
846 scsi_ad = &addr;
848 g_debug("getting disk info for: %s", disk->dev);
849 disk_h = CreateFile(disk->dev, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
850 0, NULL);
851 if (disk_h == INVALID_HANDLE_VALUE) {
852 error_setg_win32(errp, GetLastError(), "failed to open disk");
853 return;
856 get_disk_properties(disk_h, disk, &local_err);
857 if (local_err) {
858 error_propagate(errp, local_err);
859 goto err_close;
862 g_debug("bus type %d", disk->bus_type);
863 /* always set pci_controller as required by schema. get_pci_info() should
864 * report -1 values for non-PCI buses rather than fail. fail the command
865 * if that doesn't hold since that suggests some other unexpected
866 * breakage
868 if (disk->bus_type == GUEST_DISK_BUS_TYPE_USB) {
869 disk->pci_controller = get_empty_pci_address();
870 } else {
871 disk->pci_controller = get_pci_info(disk_number, &local_err);
872 if (local_err) {
873 error_propagate(errp, local_err);
874 goto err_close;
877 if (disk->bus_type == GUEST_DISK_BUS_TYPE_SCSI
878 || disk->bus_type == GUEST_DISK_BUS_TYPE_IDE
879 || disk->bus_type == GUEST_DISK_BUS_TYPE_RAID
880 /* This bus type is not supported before Windows Server 2003 SP1 */
881 || disk->bus_type == GUEST_DISK_BUS_TYPE_SAS
883 /* We are able to use the same ioctls for different bus types
884 * according to Microsoft docs
885 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
886 g_debug("getting SCSI info");
887 if (DeviceIoControl(disk_h, IOCTL_SCSI_GET_ADDRESS, NULL, 0, scsi_ad,
888 sizeof(SCSI_ADDRESS), &len, NULL)) {
889 disk->unit = addr.Lun;
890 disk->target = addr.TargetId;
891 disk->bus = addr.PathId;
893 /* We do not set error in this case, because we still have enough
894 * information about volume. */
897 err_close:
898 CloseHandle(disk_h);
899 return;
902 /* VSS provider works with volumes, thus there is no difference if
903 * the volume consist of spanned disks. Info about the first disk in the
904 * volume is returned for the spanned disk group (LVM) */
905 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
907 Error *local_err = NULL;
908 GuestDiskAddressList *list = NULL;
909 GuestDiskAddress *disk = NULL;
910 int i;
911 HANDLE vol_h;
912 DWORD size;
913 PVOLUME_DISK_EXTENTS extents = NULL;
915 /* strip final backslash */
916 char *name = g_strdup(guid);
917 if (g_str_has_suffix(name, "\\")) {
918 name[strlen(name) - 1] = 0;
921 g_debug("opening %s", name);
922 vol_h = CreateFile(name, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
923 0, NULL);
924 if (vol_h == INVALID_HANDLE_VALUE) {
925 error_setg_win32(errp, GetLastError(), "failed to open volume");
926 goto out;
929 /* Get list of extents */
930 g_debug("getting disk extents");
931 size = sizeof(VOLUME_DISK_EXTENTS);
932 extents = g_malloc0(size);
933 if (!DeviceIoControl(vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
934 0, extents, size, &size, NULL)) {
935 DWORD last_err = GetLastError();
936 if (last_err == ERROR_MORE_DATA) {
937 /* Try once more with big enough buffer */
938 size = sizeof(VOLUME_DISK_EXTENTS) +
939 (sizeof(DISK_EXTENT) * (extents->NumberOfDiskExtents - 1));
940 g_free(extents);
941 extents = g_malloc0(size);
942 if (!DeviceIoControl(
943 vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
944 0, extents, size, NULL, NULL)) {
945 error_setg_win32(errp, GetLastError(),
946 "failed to get disk extents");
947 goto out;
949 } else if (last_err == ERROR_INVALID_FUNCTION) {
950 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
951 g_debug("volume not on disk");
952 disk = g_new0(GuestDiskAddress, 1);
953 disk->dev = g_strdup(name);
954 get_single_disk_info(0xffffffff, disk, &local_err);
955 if (local_err) {
956 g_debug("failed to get disk info, ignoring error: %s",
957 error_get_pretty(local_err));
958 error_free(local_err);
959 goto out;
961 QAPI_LIST_PREPEND(list, disk);
962 disk = NULL;
963 goto out;
964 } else {
965 error_setg_win32(errp, GetLastError(),
966 "failed to get disk extents");
967 goto out;
970 g_debug("Number of extents: %lu", extents->NumberOfDiskExtents);
972 /* Go through each extent */
973 for (i = 0; i < extents->NumberOfDiskExtents; i++) {
974 disk = g_new0(GuestDiskAddress, 1);
976 /* Disk numbers directly correspond to numbers used in UNCs
978 * See documentation for DISK_EXTENT:
979 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
981 * See also Naming Files, Paths and Namespaces:
982 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
984 disk->dev = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
985 extents->Extents[i].DiskNumber);
987 get_single_disk_info(extents->Extents[i].DiskNumber, disk, &local_err);
988 if (local_err) {
989 error_propagate(errp, local_err);
990 goto out;
992 QAPI_LIST_PREPEND(list, disk);
993 disk = NULL;
997 out:
998 if (vol_h != INVALID_HANDLE_VALUE) {
999 CloseHandle(vol_h);
1001 qapi_free_GuestDiskAddress(disk);
1002 g_free(extents);
1003 g_free(name);
1005 return list;
1008 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1010 GuestDiskInfoList *ret = NULL;
1011 HDEVINFO dev_info;
1012 SP_DEVICE_INTERFACE_DATA dev_iface_data;
1013 int i;
1015 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
1016 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
1017 if (dev_info == INVALID_HANDLE_VALUE) {
1018 error_setg_win32(errp, GetLastError(), "failed to get device tree");
1019 return NULL;
1022 g_debug("enumerating devices");
1023 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
1024 for (i = 0;
1025 SetupDiEnumDeviceInterfaces(dev_info, NULL, &GUID_DEVINTERFACE_DISK,
1026 i, &dev_iface_data);
1027 i++) {
1028 GuestDiskAddress *address = NULL;
1029 GuestDiskInfo *disk = NULL;
1030 Error *local_err = NULL;
1031 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1032 pdev_iface_detail_data = NULL;
1033 STORAGE_DEVICE_NUMBER sdn;
1034 HANDLE dev_file;
1035 DWORD size = 0;
1036 BOOL result;
1037 int attempt;
1039 g_debug(" getting device path");
1040 for (attempt = 0, result = FALSE; attempt < 2 && !result; attempt++) {
1041 result = SetupDiGetDeviceInterfaceDetail(dev_info,
1042 &dev_iface_data, pdev_iface_detail_data, size, &size, NULL);
1043 if (result) {
1044 break;
1046 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
1047 pdev_iface_detail_data = g_realloc(pdev_iface_detail_data,
1048 size);
1049 pdev_iface_detail_data->cbSize =
1050 sizeof(*pdev_iface_detail_data);
1051 } else {
1052 g_debug("failed to get device interface details");
1053 break;
1056 if (!result) {
1057 g_debug("skipping device");
1058 continue;
1061 g_debug(" device: %s", pdev_iface_detail_data->DevicePath);
1062 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
1063 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
1064 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
1065 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
1066 CloseHandle(dev_file);
1067 debug_error("failed to get storage device number");
1068 continue;
1070 CloseHandle(dev_file);
1072 disk = g_new0(GuestDiskInfo, 1);
1073 disk->name = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1074 sdn.DeviceNumber);
1076 g_debug(" number: %lu", sdn.DeviceNumber);
1077 address = g_new0(GuestDiskAddress, 1);
1078 address->dev = g_strdup(disk->name);
1079 get_single_disk_info(sdn.DeviceNumber, address, &local_err);
1080 if (local_err) {
1081 g_debug("failed to get disk info: %s",
1082 error_get_pretty(local_err));
1083 error_free(local_err);
1084 qapi_free_GuestDiskAddress(address);
1085 address = NULL;
1086 } else {
1087 disk->address = address;
1090 QAPI_LIST_PREPEND(ret, disk);
1093 SetupDiDestroyDeviceInfoList(dev_info);
1094 return ret;
1097 static GuestFilesystemInfo *build_guest_fsinfo(char *guid, Error **errp)
1099 DWORD info_size;
1100 char mnt, *mnt_point;
1101 wchar_t wfs_name[32];
1102 char fs_name[32];
1103 wchar_t vol_info[MAX_PATH + 1];
1104 size_t len;
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");
1112 return NULL;
1115 mnt_point = g_malloc(info_size + 1);
1116 if (!GetVolumePathNamesForVolumeName(guid, mnt_point, info_size,
1117 &info_size)) {
1118 error_setg_win32(errp, GetLastError(), "failed to get volume name");
1119 goto free;
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");
1127 goto free;
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");
1140 goto free;
1143 fs = g_malloc(sizeof(*fs));
1144 fs->name = g_strdup(guid);
1145 fs->has_total_bytes = false;
1146 fs->has_used_bytes = false;
1147 if (len == 0) {
1148 fs->mountpoint = g_strdup("System Reserved");
1149 } else {
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);
1164 free:
1165 if (hLocalDiskHandle != INVALID_HANDLE_VALUE) {
1166 CloseHandle(hLocalDiskHandle);
1168 g_free(mnt_point);
1169 return fs;
1172 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
1174 HANDLE vol_h;
1175 GuestFilesystemInfoList *ret = NULL;
1176 char guid[256];
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");
1181 return NULL;
1184 do {
1185 Error *local_err = NULL;
1186 GuestFilesystemInfo *info = build_guest_fsinfo(guid, &local_err);
1187 if (local_err) {
1188 g_debug("failed to get filesystem info, ignoring error: %s",
1189 error_get_pretty(local_err));
1190 error_free(local_err);
1191 continue;
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);
1201 return ret;
1205 * Return status of freeze/thaw
1207 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
1209 if (!vss_initialized()) {
1210 error_setg(errp, QERR_UNSUPPORTED);
1211 return 0;
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,
1232 Error **errp)
1234 int i;
1235 Error *local_err = NULL;
1237 if (!vss_initialized()) {
1238 error_setg(errp, QERR_UNSUPPORTED);
1239 return 0;
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);
1248 if (local_err) {
1249 error_propagate(errp, local_err);
1250 goto error;
1253 return i;
1255 error:
1256 local_err = NULL;
1257 qmp_guest_fsfreeze_thaw(&local_err);
1258 if (local_err) {
1259 g_debug("cleanup thaw: %s", error_get_pretty(local_err));
1260 error_free(local_err);
1262 return 0;
1266 * Thaw local file systems using Volume Shadow-copy Service.
1268 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1270 int i;
1272 if (!vss_initialized()) {
1273 error_setg(errp, QERR_UNSUPPORTED);
1274 return 0;
1277 qga_vss_fsfreeze(&i, false, NULL, errp);
1279 ga_unset_frozen(ga_state);
1280 return i;
1283 static void guest_fsfreeze_cleanup(void)
1285 Error *err = NULL;
1287 if (!vss_initialized()) {
1288 return;
1291 if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1292 qmp_guest_fsfreeze_thaw(&err);
1293 if (err) {
1294 slog("failed to clean up frozen filesystems: %s",
1295 error_get_pretty(err));
1296 error_free(err);
1300 vss_deinit(true);
1304 * Walk list of mounted file systems in the guest, and discard unused
1305 * areas.
1307 GuestFilesystemTrimResponse *
1308 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1310 GuestFilesystemTrimResponse *resp;
1311 HANDLE handle;
1312 WCHAR guid[MAX_PATH] = L"";
1313 OSVERSIONINFO osvi;
1314 BOOL win8_or_later;
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+");
1324 return NULL;
1327 handle = FindFirstVolumeW(guid, ARRAYSIZE(guid));
1328 if (handle == INVALID_HANDLE_VALUE) {
1329 error_setg_win32(errp, GetLastError(), "failed to find any volume");
1330 return NULL;
1333 resp = g_new0(GuestFilesystemTrimResponse, 1);
1335 do {
1336 GuestFilesystemTrimResult *res;
1337 PWCHAR uc_path;
1338 DWORD char_count = 0;
1339 char *path, *out;
1340 GError *gerr = NULL;
1341 gchar *argv[4];
1343 GetVolumePathNamesForVolumeNameW(guid, NULL, 0, &char_count);
1345 if (GetLastError() != ERROR_MORE_DATA) {
1346 continue;
1348 if (GetDriveTypeW(guid) != DRIVE_FIXED) {
1349 continue;
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 */
1356 g_free(uc_path);
1357 continue;
1360 res = g_new0(GuestFilesystemTrimResult, 1);
1362 path = g_utf16_to_utf8(uc_path, char_count, NULL, NULL, &gerr);
1364 g_free(uc_path);
1366 if (!path) {
1367 res->error = g_strdup(gerr->message);
1368 g_error_free(gerr);
1369 break;
1372 res->path = path;
1374 QAPI_LIST_PREPEND(resp->paths, res);
1376 memset(argv, 0, sizeof(argv));
1377 argv[0] = (gchar *)"defrag.exe";
1378 argv[1] = (gchar *)"/L";
1379 argv[2] = path;
1381 if (!g_spawn_sync(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL,
1382 &out /* stdout */, NULL /* stdin */,
1383 NULL, &gerr)) {
1384 res->error = g_strdup(gerr->message);
1385 g_error_free(gerr);
1386 } else {
1387 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1388 Error is reported in the output with something like
1389 (x89000020) etc code in the stdout */
1391 int i;
1392 gchar **lines = g_strsplit(out, "\r\n", 0);
1393 g_free(out);
1395 for (i = 0; lines[i] != NULL; i++) {
1396 if (g_strstr_len(lines[i], -1, "(0x") == NULL) {
1397 continue;
1399 res->error = g_strdup(lines[i]);
1400 break;
1402 g_strfreev(lines);
1404 } while (FindNextVolumeW(handle, guid, ARRAYSIZE(guid)));
1406 FindVolumeClose(handle);
1407 return resp;
1410 typedef enum {
1411 GUEST_SUSPEND_MODE_DISK,
1412 GUEST_SUSPEND_MODE_RAM
1413 } GuestSuspendMode;
1415 static void check_suspend_mode(GuestSuspendMode mode, Error **errp)
1417 SYSTEM_POWER_CAPABILITIES sys_pwr_caps;
1419 ZeroMemory(&sys_pwr_caps, sizeof(sys_pwr_caps));
1420 if (!GetPwrCapabilities(&sys_pwr_caps)) {
1421 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1422 "failed to determine guest suspend capabilities");
1423 return;
1426 switch (mode) {
1427 case GUEST_SUSPEND_MODE_DISK:
1428 if (!sys_pwr_caps.SystemS4) {
1429 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1430 "suspend-to-disk not supported by OS");
1432 break;
1433 case GUEST_SUSPEND_MODE_RAM:
1434 if (!sys_pwr_caps.SystemS3) {
1435 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1436 "suspend-to-ram not supported by OS");
1438 break;
1439 default:
1440 abort();
1444 static DWORD WINAPI do_suspend(LPVOID opaque)
1446 GuestSuspendMode *mode = opaque;
1447 DWORD ret = 0;
1449 if (!SetSuspendState(*mode == GUEST_SUSPEND_MODE_DISK, TRUE, TRUE)) {
1450 g_autofree gchar *emsg = g_win32_error_message(GetLastError());
1451 slog("failed to suspend guest: %s", emsg);
1452 ret = -1;
1454 g_free(mode);
1455 return ret;
1458 void qmp_guest_suspend_disk(Error **errp)
1460 Error *local_err = NULL;
1461 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1463 *mode = GUEST_SUSPEND_MODE_DISK;
1464 check_suspend_mode(*mode, &local_err);
1465 if (local_err) {
1466 goto out;
1468 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1469 if (local_err) {
1470 goto out;
1472 execute_async(do_suspend, mode, &local_err);
1474 out:
1475 if (local_err) {
1476 error_propagate(errp, local_err);
1477 g_free(mode);
1481 void qmp_guest_suspend_ram(Error **errp)
1483 Error *local_err = NULL;
1484 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1486 *mode = GUEST_SUSPEND_MODE_RAM;
1487 check_suspend_mode(*mode, &local_err);
1488 if (local_err) {
1489 goto out;
1491 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1492 if (local_err) {
1493 goto out;
1495 execute_async(do_suspend, mode, &local_err);
1497 out:
1498 if (local_err) {
1499 error_propagate(errp, local_err);
1500 g_free(mode);
1504 void qmp_guest_suspend_hybrid(Error **errp)
1506 error_setg(errp, QERR_UNSUPPORTED);
1509 static IP_ADAPTER_ADDRESSES *guest_get_adapters_addresses(Error **errp)
1511 IP_ADAPTER_ADDRESSES *adptr_addrs = NULL;
1512 ULONG adptr_addrs_len = 0;
1513 DWORD ret;
1515 /* Call the first time to get the adptr_addrs_len. */
1516 GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1517 NULL, adptr_addrs, &adptr_addrs_len);
1519 adptr_addrs = g_malloc(adptr_addrs_len);
1520 ret = GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1521 NULL, adptr_addrs, &adptr_addrs_len);
1522 if (ret != ERROR_SUCCESS) {
1523 error_setg_win32(errp, ret, "failed to get adapters addresses");
1524 g_free(adptr_addrs);
1525 adptr_addrs = NULL;
1527 return adptr_addrs;
1530 static char *guest_wctomb_dup(WCHAR *wstr)
1532 char *str;
1533 size_t str_size;
1535 str_size = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, NULL, 0, NULL, NULL);
1536 /* add 1 to str_size for NULL terminator */
1537 str = g_malloc(str_size + 1);
1538 WideCharToMultiByte(CP_UTF8, 0, wstr, -1, str, str_size, NULL, NULL);
1539 return str;
1542 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS *ip_addr,
1543 Error **errp)
1545 char addr_str[INET6_ADDRSTRLEN + INET_ADDRSTRLEN];
1546 DWORD len;
1547 int ret;
1549 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET ||
1550 ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1551 len = sizeof(addr_str);
1552 ret = WSAAddressToString(ip_addr->Address.lpSockaddr,
1553 ip_addr->Address.iSockaddrLength,
1554 NULL,
1555 addr_str,
1556 &len);
1557 if (ret != 0) {
1558 error_setg_win32(errp, WSAGetLastError(),
1559 "failed address presentation form conversion");
1560 return NULL;
1562 return g_strdup(addr_str);
1564 return NULL;
1567 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS *ip_addr)
1569 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1570 * field to obtain the prefix.
1572 return ip_addr->OnLinkPrefixLength;
1575 #define INTERFACE_PATH_BUF_SZ 512
1577 static DWORD get_interface_index(const char *guid)
1579 ULONG index;
1580 DWORD status;
1581 wchar_t wbuf[INTERFACE_PATH_BUF_SZ];
1582 snwprintf(wbuf, INTERFACE_PATH_BUF_SZ, L"\\device\\tcpip_%s", guid);
1583 wbuf[INTERFACE_PATH_BUF_SZ - 1] = 0;
1584 status = GetAdapterIndex (wbuf, &index);
1585 if (status != NO_ERROR) {
1586 return (DWORD)~0;
1587 } else {
1588 return index;
1592 typedef NETIOAPI_API (WINAPI *GetIfEntry2Func)(PMIB_IF_ROW2 Row);
1594 static int guest_get_network_stats(const char *name,
1595 GuestNetworkInterfaceStat *stats)
1597 OSVERSIONINFO os_ver;
1599 os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1600 GetVersionEx(&os_ver);
1601 if (os_ver.dwMajorVersion >= 6) {
1602 MIB_IF_ROW2 a_mid_ifrow;
1603 GetIfEntry2Func getifentry2_ex;
1604 DWORD if_index = 0;
1605 HMODULE module = GetModuleHandle("iphlpapi");
1606 PVOID func = GetProcAddress(module, "GetIfEntry2");
1608 if (func == NULL) {
1609 return -1;
1612 getifentry2_ex = (GetIfEntry2Func)func;
1613 if_index = get_interface_index(name);
1614 if (if_index == (DWORD)~0) {
1615 return -1;
1618 memset(&a_mid_ifrow, 0, sizeof(a_mid_ifrow));
1619 a_mid_ifrow.InterfaceIndex = if_index;
1620 if (NO_ERROR == getifentry2_ex(&a_mid_ifrow)) {
1621 stats->rx_bytes = a_mid_ifrow.InOctets;
1622 stats->rx_packets = a_mid_ifrow.InUcastPkts;
1623 stats->rx_errs = a_mid_ifrow.InErrors;
1624 stats->rx_dropped = a_mid_ifrow.InDiscards;
1625 stats->tx_bytes = a_mid_ifrow.OutOctets;
1626 stats->tx_packets = a_mid_ifrow.OutUcastPkts;
1627 stats->tx_errs = a_mid_ifrow.OutErrors;
1628 stats->tx_dropped = a_mid_ifrow.OutDiscards;
1629 return 0;
1632 return -1;
1635 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
1637 IP_ADAPTER_ADDRESSES *adptr_addrs, *addr;
1638 IP_ADAPTER_UNICAST_ADDRESS *ip_addr = NULL;
1639 GuestNetworkInterfaceList *head = NULL, **tail = &head;
1640 GuestIpAddressList *head_addr, **tail_addr;
1641 GuestNetworkInterface *info;
1642 GuestNetworkInterfaceStat *interface_stat = NULL;
1643 GuestIpAddress *address_item = NULL;
1644 unsigned char *mac_addr;
1645 char *addr_str;
1646 WORD wsa_version;
1647 WSADATA wsa_data;
1648 int ret;
1650 adptr_addrs = guest_get_adapters_addresses(errp);
1651 if (adptr_addrs == NULL) {
1652 return NULL;
1655 /* Make WSA APIs available. */
1656 wsa_version = MAKEWORD(2, 2);
1657 ret = WSAStartup(wsa_version, &wsa_data);
1658 if (ret != 0) {
1659 error_setg_win32(errp, ret, "failed socket startup");
1660 goto out;
1663 for (addr = adptr_addrs; addr; addr = addr->Next) {
1664 info = g_malloc0(sizeof(*info));
1666 QAPI_LIST_APPEND(tail, info);
1668 info->name = guest_wctomb_dup(addr->FriendlyName);
1670 if (addr->PhysicalAddressLength != 0) {
1671 mac_addr = addr->PhysicalAddress;
1673 info->hardware_address =
1674 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1675 (int) mac_addr[0], (int) mac_addr[1],
1676 (int) mac_addr[2], (int) mac_addr[3],
1677 (int) mac_addr[4], (int) mac_addr[5]);
1680 head_addr = NULL;
1681 tail_addr = &head_addr;
1682 for (ip_addr = addr->FirstUnicastAddress;
1683 ip_addr;
1684 ip_addr = ip_addr->Next) {
1685 addr_str = guest_addr_to_str(ip_addr, errp);
1686 if (addr_str == NULL) {
1687 continue;
1690 address_item = g_malloc0(sizeof(*address_item));
1692 QAPI_LIST_APPEND(tail_addr, address_item);
1694 address_item->ip_address = addr_str;
1695 address_item->prefix = guest_ip_prefix(ip_addr);
1696 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET) {
1697 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV4;
1698 } else if (ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1699 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV6;
1702 if (head_addr) {
1703 info->has_ip_addresses = true;
1704 info->ip_addresses = head_addr;
1706 if (!info->statistics) {
1707 interface_stat = g_malloc0(sizeof(*interface_stat));
1708 if (guest_get_network_stats(addr->AdapterName, interface_stat)
1709 == -1) {
1710 g_free(interface_stat);
1711 } else {
1712 info->statistics = interface_stat;
1716 WSACleanup();
1717 out:
1718 g_free(adptr_addrs);
1719 return head;
1722 static int64_t filetime_to_ns(const FILETIME *tf)
1724 return ((((int64_t)tf->dwHighDateTime << 32) | tf->dwLowDateTime)
1725 - W32_FT_OFFSET) * 100;
1728 void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
1730 Error *local_err = NULL;
1731 SYSTEMTIME ts;
1732 FILETIME tf;
1733 LONGLONG time;
1735 if (!has_time) {
1736 /* Unfortunately, Windows libraries don't provide an easy way to access
1737 * RTC yet:
1739 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1741 * Instead, a workaround is to use the Windows win32tm command to
1742 * resync the time using the Windows Time service.
1744 LPVOID msg_buffer;
1745 DWORD ret_flags;
1747 HRESULT hr = system("w32tm /resync /nowait");
1749 if (GetLastError() != 0) {
1750 strerror_s((LPTSTR) & msg_buffer, 0, errno);
1751 error_setg(errp, "system(...) failed: %s", (LPCTSTR)msg_buffer);
1752 } else if (hr != 0) {
1753 if (hr == HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)) {
1754 error_setg(errp, "Windows Time service not running on the "
1755 "guest");
1756 } else {
1757 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
1758 FORMAT_MESSAGE_FROM_SYSTEM |
1759 FORMAT_MESSAGE_IGNORE_INSERTS, NULL,
1760 (DWORD)hr, MAKELANGID(LANG_NEUTRAL,
1761 SUBLANG_DEFAULT), (LPTSTR) & msg_buffer, 0,
1762 NULL)) {
1763 error_setg(errp, "w32tm failed with error (0x%lx), couldn'"
1764 "t retrieve error message", hr);
1765 } else {
1766 error_setg(errp, "w32tm failed with error (0x%lx): %s", hr,
1767 (LPCTSTR)msg_buffer);
1768 LocalFree(msg_buffer);
1771 } else if (!InternetGetConnectedState(&ret_flags, 0)) {
1772 error_setg(errp, "No internet connection on guest, sync not "
1773 "accurate");
1775 return;
1778 /* Validate time passed by user. */
1779 if (time_ns < 0 || time_ns / 100 > INT64_MAX - W32_FT_OFFSET) {
1780 error_setg(errp, "Time %" PRId64 "is invalid", time_ns);
1781 return;
1784 time = time_ns / 100 + W32_FT_OFFSET;
1786 tf.dwLowDateTime = (DWORD) time;
1787 tf.dwHighDateTime = (DWORD) (time >> 32);
1789 if (!FileTimeToSystemTime(&tf, &ts)) {
1790 error_setg(errp, "Failed to convert system time %d",
1791 (int)GetLastError());
1792 return;
1795 acquire_privilege(SE_SYSTEMTIME_NAME, &local_err);
1796 if (local_err) {
1797 error_propagate(errp, local_err);
1798 return;
1801 if (!SetSystemTime(&ts)) {
1802 error_setg(errp, "Failed to set time to guest: %d", (int)GetLastError());
1803 return;
1807 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
1809 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi, ptr;
1810 DWORD length;
1811 GuestLogicalProcessorList *head, **tail;
1812 Error *local_err = NULL;
1813 int64_t current;
1815 ptr = pslpi = NULL;
1816 length = 0;
1817 current = 0;
1818 head = NULL;
1819 tail = &head;
1821 if ((GetLogicalProcessorInformation(pslpi, &length) == FALSE) &&
1822 (GetLastError() == ERROR_INSUFFICIENT_BUFFER) &&
1823 (length > sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION))) {
1824 ptr = pslpi = g_malloc0(length);
1825 if (GetLogicalProcessorInformation(pslpi, &length) == FALSE) {
1826 error_setg(&local_err, "Failed to get processor information: %d",
1827 (int)GetLastError());
1829 } else {
1830 error_setg(&local_err,
1831 "Failed to get processor information buffer length: %d",
1832 (int)GetLastError());
1835 while ((local_err == NULL) && (length > 0)) {
1836 if (pslpi->Relationship == RelationProcessorCore) {
1837 ULONG_PTR cpu_bits = pslpi->ProcessorMask;
1839 while (cpu_bits > 0) {
1840 if (!!(cpu_bits & 1)) {
1841 GuestLogicalProcessor *vcpu;
1843 vcpu = g_malloc0(sizeof *vcpu);
1844 vcpu->logical_id = current++;
1845 vcpu->online = true;
1846 vcpu->has_can_offline = true;
1848 QAPI_LIST_APPEND(tail, vcpu);
1850 cpu_bits >>= 1;
1853 length -= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION);
1854 pslpi++; /* next entry */
1857 g_free(ptr);
1859 if (local_err == NULL) {
1860 if (head != NULL) {
1861 return head;
1863 /* there's no guest with zero VCPUs */
1864 error_setg(&local_err, "Guest reported zero VCPUs");
1867 qapi_free_GuestLogicalProcessorList(head);
1868 error_propagate(errp, local_err);
1869 return NULL;
1872 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
1874 error_setg(errp, QERR_UNSUPPORTED);
1875 return -1;
1878 static gchar *
1879 get_net_error_message(gint error)
1881 HMODULE module = NULL;
1882 gchar *retval = NULL;
1883 wchar_t *msg = NULL;
1884 int flags;
1885 size_t nchars;
1887 flags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
1888 FORMAT_MESSAGE_IGNORE_INSERTS |
1889 FORMAT_MESSAGE_FROM_SYSTEM;
1891 if (error >= NERR_BASE && error <= MAX_NERR) {
1892 module = LoadLibraryExW(L"netmsg.dll", NULL, LOAD_LIBRARY_AS_DATAFILE);
1894 if (module != NULL) {
1895 flags |= FORMAT_MESSAGE_FROM_HMODULE;
1899 FormatMessageW(flags, module, error, 0, (LPWSTR)&msg, 0, NULL);
1901 if (msg != NULL) {
1902 nchars = wcslen(msg);
1904 if (nchars >= 2 &&
1905 msg[nchars - 1] == L'\n' &&
1906 msg[nchars - 2] == L'\r') {
1907 msg[nchars - 2] = L'\0';
1910 retval = g_utf16_to_utf8(msg, -1, NULL, NULL, NULL);
1912 LocalFree(msg);
1915 if (module != NULL) {
1916 FreeLibrary(module);
1919 return retval;
1922 void qmp_guest_set_user_password(const char *username,
1923 const char *password,
1924 bool crypted,
1925 Error **errp)
1927 NET_API_STATUS nas;
1928 char *rawpasswddata = NULL;
1929 size_t rawpasswdlen;
1930 wchar_t *user = NULL, *wpass = NULL;
1931 USER_INFO_1003 pi1003 = { 0, };
1932 GError *gerr = NULL;
1934 if (crypted) {
1935 error_setg(errp, QERR_UNSUPPORTED);
1936 return;
1939 rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
1940 if (!rawpasswddata) {
1941 return;
1943 rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
1944 rawpasswddata[rawpasswdlen] = '\0';
1946 user = g_utf8_to_utf16(username, -1, NULL, NULL, &gerr);
1947 if (!user) {
1948 goto done;
1951 wpass = g_utf8_to_utf16(rawpasswddata, -1, NULL, NULL, &gerr);
1952 if (!wpass) {
1953 goto done;
1956 pi1003.usri1003_password = wpass;
1957 nas = NetUserSetInfo(NULL, user,
1958 1003, (LPBYTE)&pi1003,
1959 NULL);
1961 if (nas != NERR_Success) {
1962 gchar *msg = get_net_error_message(nas);
1963 error_setg(errp, "failed to set password: %s", msg);
1964 g_free(msg);
1967 done:
1968 if (gerr) {
1969 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
1970 g_error_free(gerr);
1972 g_free(user);
1973 g_free(wpass);
1974 g_free(rawpasswddata);
1977 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
1979 error_setg(errp, QERR_UNSUPPORTED);
1980 return NULL;
1983 GuestMemoryBlockResponseList *
1984 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
1986 error_setg(errp, QERR_UNSUPPORTED);
1987 return NULL;
1990 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
1992 error_setg(errp, QERR_UNSUPPORTED);
1993 return NULL;
1996 /* add unsupported commands to the list of blocked RPCs */
1997 GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
1999 const char *list_unsupported[] = {
2000 "guest-suspend-hybrid",
2001 "guest-set-vcpus",
2002 "guest-get-memory-blocks", "guest-set-memory-blocks",
2003 "guest-get-memory-block-size", "guest-get-memory-block-info",
2004 NULL};
2005 char **p = (char **)list_unsupported;
2007 while (*p) {
2008 blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
2011 if (!vss_init(true)) {
2012 g_debug("vss_init failed, vss commands are going to be disabled");
2013 const char *list[] = {
2014 "guest-get-fsinfo", "guest-fsfreeze-status",
2015 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL};
2016 p = (char **)list;
2018 while (*p) {
2019 blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
2023 return blockedrpcs;
2026 /* register init/cleanup routines for stateful command groups */
2027 void ga_command_state_init(GAState *s, GACommandState *cs)
2029 if (!vss_initialized()) {
2030 ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
2034 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
2035 typedef struct _GA_WTSINFOA {
2036 WTS_CONNECTSTATE_CLASS State;
2037 DWORD SessionId;
2038 DWORD IncomingBytes;
2039 DWORD OutgoingBytes;
2040 DWORD IncomingFrames;
2041 DWORD OutgoingFrames;
2042 DWORD IncomingCompressedBytes;
2043 DWORD OutgoingCompressedBy;
2044 CHAR WinStationName[WINSTATIONNAME_LENGTH];
2045 CHAR Domain[DOMAIN_LENGTH];
2046 CHAR UserName[USERNAME_LENGTH + 1];
2047 LARGE_INTEGER ConnectTime;
2048 LARGE_INTEGER DisconnectTime;
2049 LARGE_INTEGER LastInputTime;
2050 LARGE_INTEGER LogonTime;
2051 LARGE_INTEGER CurrentTime;
2053 } GA_WTSINFOA;
2055 GuestUserList *qmp_guest_get_users(Error **errp)
2057 #define QGA_NANOSECONDS 10000000
2059 GHashTable *cache = NULL;
2060 GuestUserList *head = NULL, **tail = &head;
2062 DWORD buffer_size = 0, count = 0, i = 0;
2063 GA_WTSINFOA *info = NULL;
2064 WTS_SESSION_INFOA *entries = NULL;
2065 GuestUser *user = NULL;
2066 gpointer value = NULL;
2067 INT64 login = 0;
2068 double login_time = 0;
2070 cache = g_hash_table_new(g_str_hash, g_str_equal);
2072 if (WTSEnumerateSessionsA(NULL, 0, 1, &entries, &count)) {
2073 for (i = 0; i < count; ++i) {
2074 buffer_size = 0;
2075 info = NULL;
2076 if (WTSQuerySessionInformationA(
2077 NULL,
2078 entries[i].SessionId,
2079 WTSSessionInfo,
2080 (LPSTR *)&info,
2081 &buffer_size
2082 )) {
2084 if (strlen(info->UserName) == 0) {
2085 WTSFreeMemory(info);
2086 continue;
2089 login = info->LogonTime.QuadPart;
2090 login -= W32_FT_OFFSET;
2091 login_time = ((double)login) / QGA_NANOSECONDS;
2093 if (g_hash_table_contains(cache, info->UserName)) {
2094 value = g_hash_table_lookup(cache, info->UserName);
2095 user = (GuestUser *)value;
2096 if (user->login_time > login_time) {
2097 user->login_time = login_time;
2099 } else {
2100 user = g_new0(GuestUser, 1);
2102 user->user = g_strdup(info->UserName);
2103 user->domain = g_strdup(info->Domain);
2105 user->login_time = login_time;
2107 g_hash_table_add(cache, user->user);
2109 QAPI_LIST_APPEND(tail, user);
2112 WTSFreeMemory(info);
2114 WTSFreeMemory(entries);
2116 g_hash_table_destroy(cache);
2117 return head;
2120 typedef struct _ga_matrix_lookup_t {
2121 int major;
2122 int minor;
2123 const char *version;
2124 const char *version_id;
2125 } ga_matrix_lookup_t;
2127 static const ga_matrix_lookup_t WIN_CLIENT_VERSION_MATRIX[] = {
2128 { 5, 0, "Microsoft Windows 2000", "2000"},
2129 { 5, 1, "Microsoft Windows XP", "xp"},
2130 { 6, 0, "Microsoft Windows Vista", "vista"},
2131 { 6, 1, "Microsoft Windows 7" "7"},
2132 { 6, 2, "Microsoft Windows 8", "8"},
2133 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2137 static const ga_matrix_lookup_t WIN_SERVER_VERSION_MATRIX[] = {
2138 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2139 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2140 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2141 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2142 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2143 { },
2146 typedef struct _ga_win_10_0_t {
2147 int first_build;
2148 const char *version;
2149 const char *version_id;
2150 } ga_win_10_0_t;
2152 static const ga_win_10_0_t WIN_10_0_SERVER_VERSION_MATRIX[] = {
2153 {14393, "Microsoft Windows Server 2016", "2016"},
2154 {17763, "Microsoft Windows Server 2019", "2019"},
2155 {20344, "Microsoft Windows Server 2022", "2022"},
2156 {26040, "MIcrosoft Windows Server 2025", "2025"},
2160 static const ga_win_10_0_t WIN_10_0_CLIENT_VERSION_MATRIX[] = {
2161 {10240, "Microsoft Windows 10", "10"},
2162 {22000, "Microsoft Windows 11", "11"},
2166 static void ga_get_win_version(RTL_OSVERSIONINFOEXW *info, Error **errp)
2168 typedef NTSTATUS(WINAPI *rtl_get_version_t)(
2169 RTL_OSVERSIONINFOEXW *os_version_info_ex);
2171 info->dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
2173 HMODULE module = GetModuleHandle("ntdll");
2174 PVOID fun = GetProcAddress(module, "RtlGetVersion");
2175 if (fun == NULL) {
2176 error_setg(errp, QERR_QGA_COMMAND_FAILED,
2177 "Failed to get address of RtlGetVersion");
2178 return;
2181 rtl_get_version_t rtl_get_version = (rtl_get_version_t)fun;
2182 rtl_get_version(info);
2183 return;
2186 static char *ga_get_win_name(const OSVERSIONINFOEXW *os_version, bool id)
2188 DWORD major = os_version->dwMajorVersion;
2189 DWORD minor = os_version->dwMinorVersion;
2190 DWORD build = os_version->dwBuildNumber;
2191 int tbl_idx = (os_version->wProductType != VER_NT_WORKSTATION);
2192 const ga_matrix_lookup_t *table = tbl_idx ?
2193 WIN_SERVER_VERSION_MATRIX : WIN_CLIENT_VERSION_MATRIX;
2194 const ga_win_10_0_t *win_10_0_table = tbl_idx ?
2195 WIN_10_0_SERVER_VERSION_MATRIX : WIN_10_0_CLIENT_VERSION_MATRIX;
2196 const ga_win_10_0_t *win_10_0_version = NULL;
2197 while (table->version != NULL) {
2198 if (major == 10 && minor == 0) {
2199 while (win_10_0_table->version != NULL) {
2200 if (build >= win_10_0_table->first_build) {
2201 win_10_0_version = win_10_0_table;
2203 win_10_0_table++;
2205 if (win_10_0_table) {
2206 if (id) {
2207 return g_strdup(win_10_0_version->version_id);
2208 } else {
2209 return g_strdup(win_10_0_version->version);
2212 } else if (major == table->major && minor == table->minor) {
2213 if (id) {
2214 return g_strdup(table->version_id);
2215 } else {
2216 return g_strdup(table->version);
2219 ++table;
2221 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2222 major, minor);
2223 return g_strdup("N/A");
2226 static char *ga_get_win_product_name(Error **errp)
2228 HKEY key = INVALID_HANDLE_VALUE;
2229 DWORD size = 128;
2230 char *result = g_malloc0(size);
2231 LONG err = ERROR_SUCCESS;
2233 err = RegOpenKeyA(HKEY_LOCAL_MACHINE,
2234 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2235 &key);
2236 if (err != ERROR_SUCCESS) {
2237 error_setg_win32(errp, err, "failed to open registry key");
2238 g_free(result);
2239 return NULL;
2242 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2243 (LPBYTE)result, &size);
2244 if (err == ERROR_MORE_DATA) {
2245 slog("ProductName longer than expected (%lu bytes), retrying",
2246 size);
2247 g_free(result);
2248 result = NULL;
2249 if (size > 0) {
2250 result = g_malloc0(size);
2251 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2252 (LPBYTE)result, &size);
2255 if (err != ERROR_SUCCESS) {
2256 error_setg_win32(errp, err, "failed to retrieve ProductName");
2257 goto fail;
2260 RegCloseKey(key);
2261 return result;
2263 fail:
2264 if (key != INVALID_HANDLE_VALUE) {
2265 RegCloseKey(key);
2267 g_free(result);
2268 return NULL;
2271 static char *ga_get_current_arch(void)
2273 SYSTEM_INFO info;
2274 GetNativeSystemInfo(&info);
2275 char *result = NULL;
2276 switch (info.wProcessorArchitecture) {
2277 case PROCESSOR_ARCHITECTURE_AMD64:
2278 result = g_strdup("x86_64");
2279 break;
2280 case PROCESSOR_ARCHITECTURE_ARM:
2281 result = g_strdup("arm");
2282 break;
2283 case PROCESSOR_ARCHITECTURE_IA64:
2284 result = g_strdup("ia64");
2285 break;
2286 case PROCESSOR_ARCHITECTURE_INTEL:
2287 result = g_strdup("x86");
2288 break;
2289 case PROCESSOR_ARCHITECTURE_UNKNOWN:
2290 default:
2291 slog("unknown processor architecture 0x%0x",
2292 info.wProcessorArchitecture);
2293 result = g_strdup("unknown");
2294 break;
2296 return result;
2299 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
2301 Error *local_err = NULL;
2302 OSVERSIONINFOEXW os_version = {0};
2303 bool server;
2304 char *product_name;
2305 GuestOSInfo *info;
2307 ga_get_win_version(&os_version, &local_err);
2308 if (local_err) {
2309 error_propagate(errp, local_err);
2310 return NULL;
2313 server = os_version.wProductType != VER_NT_WORKSTATION;
2314 product_name = ga_get_win_product_name(errp);
2315 if (product_name == NULL) {
2316 return NULL;
2319 info = g_new0(GuestOSInfo, 1);
2321 info->kernel_version = g_strdup_printf("%lu.%lu",
2322 os_version.dwMajorVersion,
2323 os_version.dwMinorVersion);
2324 info->kernel_release = g_strdup_printf("%lu",
2325 os_version.dwBuildNumber);
2326 info->machine = ga_get_current_arch();
2328 info->id = g_strdup("mswindows");
2329 info->name = g_strdup("Microsoft Windows");
2330 info->pretty_name = product_name;
2331 info->version = ga_get_win_name(&os_version, false);
2332 info->version_id = ga_get_win_name(&os_version, true);
2333 info->variant = g_strdup(server ? "server" : "client");
2334 info->variant_id = g_strdup(server ? "server" : "client");
2336 return info;
2340 * Safely get device property. Returned strings are using wide characters.
2341 * Caller is responsible for freeing the buffer.
2343 static LPBYTE cm_get_property(DEVINST devInst, const DEVPROPKEY *propName,
2344 PDEVPROPTYPE propType)
2346 CONFIGRET cr;
2347 g_autofree LPBYTE buffer = NULL;
2348 ULONG buffer_len = 0;
2350 /* First query for needed space */
2351 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2352 buffer, &buffer_len, 0);
2353 if (cr != CR_SUCCESS && cr != CR_BUFFER_SMALL) {
2355 slog("failed to get property size, error=0x%lx", cr);
2356 return NULL;
2358 buffer = g_new0(BYTE, buffer_len + 1);
2359 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2360 buffer, &buffer_len, 0);
2361 if (cr != CR_SUCCESS) {
2362 slog("failed to get device property, error=0x%lx", cr);
2363 return NULL;
2365 return g_steal_pointer(&buffer);
2368 static GStrv ga_get_hardware_ids(DEVINST devInstance)
2370 GArray *values = NULL;
2371 DEVPROPTYPE cm_type;
2372 LPWSTR id;
2373 g_autofree LPWSTR property = (LPWSTR)cm_get_property(devInstance,
2374 &qga_DEVPKEY_Device_HardwareIds, &cm_type);
2375 if (property == NULL) {
2376 slog("failed to get hardware IDs");
2377 return NULL;
2379 if (*property == '\0') {
2380 /* empty list */
2381 return NULL;
2383 values = g_array_new(TRUE, TRUE, sizeof(gchar *));
2384 for (id = property; '\0' != *id; id += lstrlenW(id) + 1) {
2385 gchar *id8 = g_utf16_to_utf8(id, -1, NULL, NULL, NULL);
2386 g_array_append_val(values, id8);
2388 return (GStrv)g_array_free(values, FALSE);
2392 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2394 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2396 GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
2398 GuestDeviceInfoList *head = NULL, **tail = &head;
2399 HDEVINFO dev_info = INVALID_HANDLE_VALUE;
2400 SP_DEVINFO_DATA dev_info_data;
2401 int i, j;
2402 GError *gerr = NULL;
2403 g_autoptr(GRegex) device_pci_re = NULL;
2404 DEVPROPTYPE cm_type;
2406 device_pci_re = g_regex_new(DEVICE_PCI_RE,
2407 G_REGEX_ANCHORED | G_REGEX_OPTIMIZE, 0,
2408 &gerr);
2409 g_assert(device_pci_re != NULL);
2411 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
2412 dev_info = SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT | DIGCF_ALLCLASSES);
2413 if (dev_info == INVALID_HANDLE_VALUE) {
2414 error_setg(errp, "failed to get device tree");
2415 return NULL;
2418 slog("enumerating devices");
2419 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
2420 bool skip = true;
2421 g_autofree LPWSTR name = NULL;
2422 g_autofree LPFILETIME date = NULL;
2423 g_autofree LPWSTR version = NULL;
2424 g_auto(GStrv) hw_ids = NULL;
2425 g_autoptr(GuestDeviceInfo) device = g_new0(GuestDeviceInfo, 1);
2426 g_autofree char *vendor_id = NULL;
2427 g_autofree char *device_id = NULL;
2429 name = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2430 &qga_DEVPKEY_NAME, &cm_type);
2431 if (name == NULL) {
2432 slog("failed to get device description");
2433 continue;
2435 device->driver_name = g_utf16_to_utf8(name, -1, NULL, NULL, NULL);
2436 if (device->driver_name == NULL) {
2437 error_setg(errp, "conversion to utf8 failed (driver name)");
2438 return NULL;
2440 slog("querying device: %s", device->driver_name);
2441 hw_ids = ga_get_hardware_ids(dev_info_data.DevInst);
2442 if (hw_ids == NULL) {
2443 continue;
2445 for (j = 0; hw_ids[j] != NULL; j++) {
2446 g_autoptr(GMatchInfo) match_info;
2447 GuestDeviceIdPCI *id;
2448 if (!g_regex_match(device_pci_re, hw_ids[j], 0, &match_info)) {
2449 continue;
2451 skip = false;
2453 vendor_id = g_match_info_fetch(match_info, 1);
2454 device_id = g_match_info_fetch(match_info, 2);
2456 device->id = g_new0(GuestDeviceId, 1);
2457 device->id->type = GUEST_DEVICE_TYPE_PCI;
2458 id = &device->id->u.pci;
2459 id->vendor_id = g_ascii_strtoull(vendor_id, NULL, 16);
2460 id->device_id = g_ascii_strtoull(device_id, NULL, 16);
2462 break;
2464 if (skip) {
2465 continue;
2468 version = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2469 &qga_DEVPKEY_Device_DriverVersion, &cm_type);
2470 if (version == NULL) {
2471 slog("failed to get driver version");
2472 continue;
2474 device->driver_version = g_utf16_to_utf8(version, -1, NULL,
2475 NULL, NULL);
2476 if (device->driver_version == NULL) {
2477 error_setg(errp, "conversion to utf8 failed (driver version)");
2478 return NULL;
2481 date = (LPFILETIME)cm_get_property(dev_info_data.DevInst,
2482 &qga_DEVPKEY_Device_DriverDate, &cm_type);
2483 if (date == NULL) {
2484 slog("failed to get driver date");
2485 continue;
2487 device->driver_date = filetime_to_ns(date);
2488 device->has_driver_date = true;
2490 slog("driver: %s\ndriver version: %" PRId64 ",%s\n",
2491 device->driver_name, device->driver_date,
2492 device->driver_version);
2493 QAPI_LIST_APPEND(tail, g_steal_pointer(&device));
2496 if (dev_info != INVALID_HANDLE_VALUE) {
2497 SetupDiDestroyDeviceInfoList(dev_info);
2499 return head;
2502 char *qga_get_host_name(Error **errp)
2504 wchar_t tmp[MAX_COMPUTERNAME_LENGTH + 1];
2505 DWORD size = G_N_ELEMENTS(tmp);
2507 if (GetComputerNameW(tmp, &size) == 0) {
2508 error_setg_win32(errp, GetLastError(), "failed close handle");
2509 return NULL;
2512 return g_utf16_to_utf8(tmp, size, NULL, NULL, NULL);
2515 GuestDiskStatsInfoList *qmp_guest_get_diskstats(Error **errp)
2517 error_setg(errp, QERR_UNSUPPORTED);
2518 return NULL;
2521 GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
2523 error_setg(errp, QERR_UNSUPPORTED);
2524 return NULL;