ppc/ppc405: Rework ppc_40x_timers_init() to use a PowerPCCPU
[qemu.git] / qga / commands-win32.c
blob4e84afd83beeb48d9cfb2204dbe5a650d45e66ed
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 #ifdef CONFIG_QGA_NTDDSCSI
22 #include <winioctl.h>
23 #include <ntddscsi.h>
24 #endif
25 #include <setupapi.h>
26 #include <cfgmgr32.h>
27 #include <initguid.h>
28 #include <devpropdef.h>
29 #include <lm.h>
30 #include <wtsapi32.h>
31 #include <wininet.h>
33 #include "guest-agent-core.h"
34 #include "vss-win32.h"
35 #include "qga-qapi-commands.h"
36 #include "qapi/error.h"
37 #include "qapi/qmp/qerror.h"
38 #include "qemu/queue.h"
39 #include "qemu/host-utils.h"
40 #include "qemu/base64.h"
41 #include "commands-common.h"
44 * The following should be in devpkey.h, but it isn't. The key names were
45 * prefixed to avoid (future) name clashes. Once the definitions get into
46 * mingw the following lines can be removed.
48 DEFINE_DEVPROPKEY(qga_DEVPKEY_NAME, 0xb725f130, 0x47ef, 0x101a, 0xa5,
49 0xf1, 0x02, 0x60, 0x8c, 0x9e, 0xeb, 0xac, 10);
50 /* DEVPROP_TYPE_STRING */
51 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_HardwareIds, 0xa45c254e, 0xdf1c,
52 0x4efd, 0x80, 0x20, 0x67, 0xd1, 0x46, 0xa8, 0x50, 0xe0, 3);
53 /* DEVPROP_TYPE_STRING_LIST */
54 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverDate, 0xa8b865dd, 0x2e3d,
55 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 2);
56 /* DEVPROP_TYPE_FILETIME */
57 DEFINE_DEVPROPKEY(qga_DEVPKEY_Device_DriverVersion, 0xa8b865dd, 0x2e3d,
58 0x4094, 0xad, 0x97, 0xe5, 0x93, 0xa7, 0xc, 0x75, 0xd6, 3);
59 /* DEVPROP_TYPE_STRING */
60 /* The CM_Get_DevNode_PropertyW prototype is only sometimes in cfgmgr32.h */
61 #ifndef CM_Get_DevNode_Property
62 #pragma GCC diagnostic push
63 #pragma GCC diagnostic ignored "-Wredundant-decls"
64 CMAPI CONFIGRET WINAPI CM_Get_DevNode_PropertyW(
65 DEVINST dnDevInst,
66 CONST DEVPROPKEY * PropertyKey,
67 DEVPROPTYPE * PropertyType,
68 PBYTE PropertyBuffer,
69 PULONG PropertyBufferSize,
70 ULONG ulFlags
72 #define CM_Get_DevNode_Property CM_Get_DevNode_PropertyW
73 #pragma GCC diagnostic pop
74 #endif
76 #ifndef SHTDN_REASON_FLAG_PLANNED
77 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
78 #endif
80 /* multiple of 100 nanoseconds elapsed between windows baseline
81 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
82 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
83 (365 * (1970 - 1601) + \
84 (1970 - 1601) / 4 - 3))
86 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
88 struct GuestFileHandle {
89 int64_t id;
90 HANDLE fh;
91 QTAILQ_ENTRY(GuestFileHandle) next;
94 static struct {
95 QTAILQ_HEAD(, GuestFileHandle) filehandles;
96 } guest_file_state = {
97 .filehandles = QTAILQ_HEAD_INITIALIZER(guest_file_state.filehandles),
100 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
102 typedef struct OpenFlags {
103 const char *forms;
104 DWORD desired_access;
105 DWORD creation_disposition;
106 } OpenFlags;
107 static OpenFlags guest_file_open_modes[] = {
108 {"r", GENERIC_READ, OPEN_EXISTING},
109 {"rb", GENERIC_READ, OPEN_EXISTING},
110 {"w", GENERIC_WRITE, CREATE_ALWAYS},
111 {"wb", GENERIC_WRITE, CREATE_ALWAYS},
112 {"a", FILE_GENERIC_APPEND, OPEN_ALWAYS },
113 {"r+", GENERIC_WRITE | GENERIC_READ, OPEN_EXISTING},
114 {"rb+", GENERIC_WRITE | GENERIC_READ, OPEN_EXISTING},
115 {"r+b", GENERIC_WRITE | GENERIC_READ, OPEN_EXISTING},
116 {"w+", GENERIC_WRITE | GENERIC_READ, CREATE_ALWAYS},
117 {"wb+", GENERIC_WRITE | GENERIC_READ, CREATE_ALWAYS},
118 {"w+b", GENERIC_WRITE | GENERIC_READ, CREATE_ALWAYS},
119 {"a+", FILE_GENERIC_APPEND | GENERIC_READ, OPEN_ALWAYS },
120 {"ab+", FILE_GENERIC_APPEND | GENERIC_READ, OPEN_ALWAYS },
121 {"a+b", FILE_GENERIC_APPEND | GENERIC_READ, OPEN_ALWAYS }
124 #define debug_error(msg) do { \
125 char *suffix = g_win32_error_message(GetLastError()); \
126 g_debug("%s: %s", (msg), suffix); \
127 g_free(suffix); \
128 } while (0)
130 static OpenFlags *find_open_flag(const char *mode_str)
132 int mode;
133 Error **errp = NULL;
135 for (mode = 0; mode < ARRAY_SIZE(guest_file_open_modes); ++mode) {
136 OpenFlags *flags = guest_file_open_modes + mode;
138 if (strcmp(flags->forms, mode_str) == 0) {
139 return flags;
143 error_setg(errp, "invalid file open mode '%s'", mode_str);
144 return NULL;
147 static int64_t guest_file_handle_add(HANDLE fh, Error **errp)
149 GuestFileHandle *gfh;
150 int64_t handle;
152 handle = ga_get_fd_handle(ga_state, errp);
153 if (handle < 0) {
154 return -1;
156 gfh = g_new0(GuestFileHandle, 1);
157 gfh->id = handle;
158 gfh->fh = fh;
159 QTAILQ_INSERT_TAIL(&guest_file_state.filehandles, gfh, next);
161 return handle;
164 GuestFileHandle *guest_file_handle_find(int64_t id, Error **errp)
166 GuestFileHandle *gfh;
167 QTAILQ_FOREACH(gfh, &guest_file_state.filehandles, next) {
168 if (gfh->id == id) {
169 return gfh;
172 error_setg(errp, "handle '%" PRId64 "' has not been found", id);
173 return NULL;
176 static void handle_set_nonblocking(HANDLE fh)
178 DWORD file_type, pipe_state;
179 file_type = GetFileType(fh);
180 if (file_type != FILE_TYPE_PIPE) {
181 return;
183 /* If file_type == FILE_TYPE_PIPE, according to MSDN
184 * the specified file is socket or named pipe */
185 if (!GetNamedPipeHandleState(fh, &pipe_state, NULL,
186 NULL, NULL, NULL, 0)) {
187 return;
189 /* The fd is named pipe fd */
190 if (pipe_state & PIPE_NOWAIT) {
191 return;
194 pipe_state |= PIPE_NOWAIT;
195 SetNamedPipeHandleState(fh, &pipe_state, NULL, NULL);
198 int64_t qmp_guest_file_open(const char *path, bool has_mode,
199 const char *mode, Error **errp)
201 int64_t fd = -1;
202 HANDLE fh;
203 HANDLE templ_file = NULL;
204 DWORD share_mode = FILE_SHARE_READ;
205 DWORD flags_and_attr = FILE_ATTRIBUTE_NORMAL;
206 LPSECURITY_ATTRIBUTES sa_attr = NULL;
207 OpenFlags *guest_flags;
208 GError *gerr = NULL;
209 wchar_t *w_path = NULL;
211 if (!has_mode) {
212 mode = "r";
214 slog("guest-file-open called, filepath: %s, mode: %s", path, mode);
215 guest_flags = find_open_flag(mode);
216 if (guest_flags == NULL) {
217 error_setg(errp, "invalid file open mode");
218 goto done;
221 w_path = g_utf8_to_utf16(path, -1, NULL, NULL, &gerr);
222 if (!w_path) {
223 goto done;
226 fh = CreateFileW(w_path, guest_flags->desired_access, share_mode, sa_attr,
227 guest_flags->creation_disposition, flags_and_attr,
228 templ_file);
229 if (fh == INVALID_HANDLE_VALUE) {
230 error_setg_win32(errp, GetLastError(), "failed to open file '%s'",
231 path);
232 goto done;
235 /* set fd non-blocking to avoid common use cases (like reading from a
236 * named pipe) from hanging the agent
238 handle_set_nonblocking(fh);
240 fd = guest_file_handle_add(fh, errp);
241 if (fd < 0) {
242 CloseHandle(fh);
243 error_setg(errp, "failed to add handle to qmp handle table");
244 goto done;
247 slog("guest-file-open, handle: % " PRId64, fd);
249 done:
250 if (gerr) {
251 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
252 g_error_free(gerr);
254 g_free(w_path);
255 return fd;
258 void qmp_guest_file_close(int64_t handle, Error **errp)
260 bool ret;
261 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
262 slog("guest-file-close called, handle: %" PRId64, handle);
263 if (gfh == NULL) {
264 return;
266 ret = CloseHandle(gfh->fh);
267 if (!ret) {
268 error_setg_win32(errp, GetLastError(), "failed close handle");
269 return;
272 QTAILQ_REMOVE(&guest_file_state.filehandles, gfh, next);
273 g_free(gfh);
276 static void acquire_privilege(const char *name, Error **errp)
278 HANDLE token = NULL;
279 TOKEN_PRIVILEGES priv;
280 Error *local_err = NULL;
282 if (OpenProcessToken(GetCurrentProcess(),
283 TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &token))
285 if (!LookupPrivilegeValue(NULL, name, &priv.Privileges[0].Luid)) {
286 error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
287 "no luid for requested privilege");
288 goto out;
291 priv.PrivilegeCount = 1;
292 priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
294 if (!AdjustTokenPrivileges(token, FALSE, &priv, 0, NULL, 0)) {
295 error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
296 "unable to acquire requested privilege");
297 goto out;
300 } else {
301 error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
302 "failed to open privilege token");
305 out:
306 if (token) {
307 CloseHandle(token);
309 error_propagate(errp, local_err);
312 static void execute_async(DWORD WINAPI (*func)(LPVOID), LPVOID opaque,
313 Error **errp)
315 HANDLE thread = CreateThread(NULL, 0, func, opaque, 0, NULL);
316 if (!thread) {
317 error_setg(errp, QERR_QGA_COMMAND_FAILED,
318 "failed to dispatch asynchronous command");
322 void qmp_guest_shutdown(bool has_mode, const char *mode, Error **errp)
324 Error *local_err = NULL;
325 UINT shutdown_flag = EWX_FORCE;
327 slog("guest-shutdown called, mode: %s", mode);
329 if (!has_mode || strcmp(mode, "powerdown") == 0) {
330 shutdown_flag |= EWX_POWEROFF;
331 } else if (strcmp(mode, "halt") == 0) {
332 shutdown_flag |= EWX_SHUTDOWN;
333 } else if (strcmp(mode, "reboot") == 0) {
334 shutdown_flag |= EWX_REBOOT;
335 } else {
336 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "mode",
337 "'halt', 'powerdown', or 'reboot'");
338 return;
341 /* Request a shutdown privilege, but try to shut down the system
342 anyway. */
343 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
344 if (local_err) {
345 error_propagate(errp, local_err);
346 return;
349 if (!ExitWindowsEx(shutdown_flag, SHTDN_REASON_FLAG_PLANNED)) {
350 g_autofree gchar *emsg = g_win32_error_message(GetLastError());
351 slog("guest-shutdown failed: %s", emsg);
352 error_setg_win32(errp, GetLastError(), "guest-shutdown failed");
356 GuestFileRead *guest_file_read_unsafe(GuestFileHandle *gfh,
357 int64_t count, Error **errp)
359 GuestFileRead *read_data = NULL;
360 guchar *buf;
361 HANDLE fh = gfh->fh;
362 bool is_ok;
363 DWORD read_count;
365 buf = g_malloc0(count + 1);
366 is_ok = ReadFile(fh, buf, count, &read_count, NULL);
367 if (!is_ok) {
368 error_setg_win32(errp, GetLastError(), "failed to read file");
369 } else {
370 buf[read_count] = 0;
371 read_data = g_new0(GuestFileRead, 1);
372 read_data->count = (size_t)read_count;
373 read_data->eof = read_count == 0;
375 if (read_count != 0) {
376 read_data->buf_b64 = g_base64_encode(buf, read_count);
379 g_free(buf);
381 return read_data;
384 GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64,
385 bool has_count, int64_t count,
386 Error **errp)
388 GuestFileWrite *write_data = NULL;
389 guchar *buf;
390 gsize buf_len;
391 bool is_ok;
392 DWORD write_count;
393 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
394 HANDLE fh;
396 if (!gfh) {
397 return NULL;
399 fh = gfh->fh;
400 buf = qbase64_decode(buf_b64, -1, &buf_len, errp);
401 if (!buf) {
402 return NULL;
405 if (!has_count) {
406 count = buf_len;
407 } else if (count < 0 || count > buf_len) {
408 error_setg(errp, "value '%" PRId64
409 "' is invalid for argument count", count);
410 goto done;
413 is_ok = WriteFile(fh, buf, count, &write_count, NULL);
414 if (!is_ok) {
415 error_setg_win32(errp, GetLastError(), "failed to write to file");
416 slog("guest-file-write-failed, handle: %" PRId64, handle);
417 } else {
418 write_data = g_new0(GuestFileWrite, 1);
419 write_data->count = (size_t) write_count;
422 done:
423 g_free(buf);
424 return write_data;
427 GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset,
428 GuestFileWhence *whence_code,
429 Error **errp)
431 GuestFileHandle *gfh;
432 GuestFileSeek *seek_data;
433 HANDLE fh;
434 LARGE_INTEGER new_pos, off_pos;
435 off_pos.QuadPart = offset;
436 BOOL res;
437 int whence;
438 Error *err = NULL;
440 gfh = guest_file_handle_find(handle, errp);
441 if (!gfh) {
442 return NULL;
445 /* We stupidly exposed 'whence':'int' in our qapi */
446 whence = ga_parse_whence(whence_code, &err);
447 if (err) {
448 error_propagate(errp, err);
449 return NULL;
452 fh = gfh->fh;
453 res = SetFilePointerEx(fh, off_pos, &new_pos, whence);
454 if (!res) {
455 error_setg_win32(errp, GetLastError(), "failed to seek file");
456 return NULL;
458 seek_data = g_new0(GuestFileSeek, 1);
459 seek_data->position = new_pos.QuadPart;
460 return seek_data;
463 void qmp_guest_file_flush(int64_t handle, Error **errp)
465 HANDLE fh;
466 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
467 if (!gfh) {
468 return;
471 fh = gfh->fh;
472 if (!FlushFileBuffers(fh)) {
473 error_setg_win32(errp, GetLastError(), "failed to flush file");
477 #ifdef CONFIG_QGA_NTDDSCSI
479 static GuestDiskBusType win2qemu[] = {
480 [BusTypeUnknown] = GUEST_DISK_BUS_TYPE_UNKNOWN,
481 [BusTypeScsi] = GUEST_DISK_BUS_TYPE_SCSI,
482 [BusTypeAtapi] = GUEST_DISK_BUS_TYPE_IDE,
483 [BusTypeAta] = GUEST_DISK_BUS_TYPE_IDE,
484 [BusType1394] = GUEST_DISK_BUS_TYPE_IEEE1394,
485 [BusTypeSsa] = GUEST_DISK_BUS_TYPE_SSA,
486 [BusTypeFibre] = GUEST_DISK_BUS_TYPE_SSA,
487 [BusTypeUsb] = GUEST_DISK_BUS_TYPE_USB,
488 [BusTypeRAID] = GUEST_DISK_BUS_TYPE_RAID,
489 [BusTypeiScsi] = GUEST_DISK_BUS_TYPE_ISCSI,
490 [BusTypeSas] = GUEST_DISK_BUS_TYPE_SAS,
491 [BusTypeSata] = GUEST_DISK_BUS_TYPE_SATA,
492 [BusTypeSd] = GUEST_DISK_BUS_TYPE_SD,
493 [BusTypeMmc] = GUEST_DISK_BUS_TYPE_MMC,
494 #if (_WIN32_WINNT >= 0x0601)
495 [BusTypeVirtual] = GUEST_DISK_BUS_TYPE_VIRTUAL,
496 [BusTypeFileBackedVirtual] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL,
497 #endif
500 static GuestDiskBusType find_bus_type(STORAGE_BUS_TYPE bus)
502 if (bus >= ARRAY_SIZE(win2qemu) || (int)bus < 0) {
503 return GUEST_DISK_BUS_TYPE_UNKNOWN;
505 return win2qemu[(int)bus];
508 DEFINE_GUID(GUID_DEVINTERFACE_DISK,
509 0x53f56307L, 0xb6bf, 0x11d0, 0x94, 0xf2,
510 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
511 DEFINE_GUID(GUID_DEVINTERFACE_STORAGEPORT,
512 0x2accfe60L, 0xc130, 0x11d2, 0xb0, 0x82,
513 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
515 static GuestPCIAddress *get_pci_info(int number, Error **errp)
517 HDEVINFO dev_info;
518 SP_DEVINFO_DATA dev_info_data;
519 SP_DEVICE_INTERFACE_DATA dev_iface_data;
520 HANDLE dev_file;
521 int i;
522 GuestPCIAddress *pci = NULL;
523 bool partial_pci = false;
525 pci = g_malloc0(sizeof(*pci));
526 pci->domain = -1;
527 pci->slot = -1;
528 pci->function = -1;
529 pci->bus = -1;
531 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
532 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
533 if (dev_info == INVALID_HANDLE_VALUE) {
534 error_setg_win32(errp, GetLastError(), "failed to get devices tree");
535 goto out;
538 g_debug("enumerating devices");
539 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
540 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
541 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
542 PSP_DEVICE_INTERFACE_DETAIL_DATA pdev_iface_detail_data = NULL;
543 STORAGE_DEVICE_NUMBER sdn;
544 char *parent_dev_id = NULL;
545 HDEVINFO parent_dev_info;
546 SP_DEVINFO_DATA parent_dev_info_data;
547 DWORD j;
548 DWORD size = 0;
550 g_debug("getting device path");
551 if (SetupDiEnumDeviceInterfaces(dev_info, &dev_info_data,
552 &GUID_DEVINTERFACE_DISK, 0,
553 &dev_iface_data)) {
554 while (!SetupDiGetDeviceInterfaceDetail(dev_info, &dev_iface_data,
555 pdev_iface_detail_data,
556 size, &size,
557 &dev_info_data)) {
558 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
559 pdev_iface_detail_data = g_malloc(size);
560 pdev_iface_detail_data->cbSize =
561 sizeof(*pdev_iface_detail_data);
562 } else {
563 error_setg_win32(errp, GetLastError(),
564 "failed to get device interfaces");
565 goto free_dev_info;
569 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
570 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0,
571 NULL);
572 g_free(pdev_iface_detail_data);
574 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
575 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
576 CloseHandle(dev_file);
577 error_setg_win32(errp, GetLastError(),
578 "failed to get device slot number");
579 goto free_dev_info;
582 CloseHandle(dev_file);
583 if (sdn.DeviceNumber != number) {
584 continue;
586 } else {
587 error_setg_win32(errp, GetLastError(),
588 "failed to get device interfaces");
589 goto free_dev_info;
592 g_debug("found device slot %d. Getting storage controller", number);
594 CONFIGRET cr;
595 DEVINST dev_inst, parent_dev_inst;
596 ULONG dev_id_size = 0;
598 size = 0;
599 while (!SetupDiGetDeviceInstanceId(dev_info, &dev_info_data,
600 parent_dev_id, size, &size)) {
601 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
602 parent_dev_id = g_malloc(size);
603 } else {
604 error_setg_win32(errp, GetLastError(),
605 "failed to get device instance ID");
606 goto out;
611 * CM API used here as opposed to
612 * SetupDiGetDeviceProperty(..., DEVPKEY_Device_Parent, ...)
613 * which exports are only available in mingw-w64 6+
615 cr = CM_Locate_DevInst(&dev_inst, parent_dev_id, 0);
616 if (cr != CR_SUCCESS) {
617 g_error("CM_Locate_DevInst failed with code %lx", cr);
618 error_setg_win32(errp, GetLastError(),
619 "failed to get device instance");
620 goto out;
622 cr = CM_Get_Parent(&parent_dev_inst, dev_inst, 0);
623 if (cr != CR_SUCCESS) {
624 g_error("CM_Get_Parent failed with code %lx", cr);
625 error_setg_win32(errp, GetLastError(),
626 "failed to get parent device instance");
627 goto out;
630 cr = CM_Get_Device_ID_Size(&dev_id_size, parent_dev_inst, 0);
631 if (cr != CR_SUCCESS) {
632 g_error("CM_Get_Device_ID_Size failed with code %lx", cr);
633 error_setg_win32(errp, GetLastError(),
634 "failed to get parent device ID length");
635 goto out;
638 ++dev_id_size;
639 if (dev_id_size > size) {
640 g_free(parent_dev_id);
641 parent_dev_id = g_malloc(dev_id_size);
644 cr = CM_Get_Device_ID(parent_dev_inst, parent_dev_id, dev_id_size,
646 if (cr != CR_SUCCESS) {
647 g_error("CM_Get_Device_ID failed with code %lx", cr);
648 error_setg_win32(errp, GetLastError(),
649 "failed to get parent device ID");
650 goto out;
654 g_debug("querying storage controller %s for PCI information",
655 parent_dev_id);
656 parent_dev_info =
657 SetupDiGetClassDevs(&GUID_DEVINTERFACE_STORAGEPORT, parent_dev_id,
658 NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
659 g_free(parent_dev_id);
661 if (parent_dev_info == INVALID_HANDLE_VALUE) {
662 error_setg_win32(errp, GetLastError(),
663 "failed to get parent device");
664 goto out;
667 parent_dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
668 if (!SetupDiEnumDeviceInfo(parent_dev_info, 0, &parent_dev_info_data)) {
669 error_setg_win32(errp, GetLastError(),
670 "failed to get parent device data");
671 goto out;
674 for (j = 0;
675 SetupDiEnumDeviceInfo(parent_dev_info, j, &parent_dev_info_data);
676 j++) {
677 DWORD addr, bus, ui_slot, type;
678 int func, slot;
681 * There is no need to allocate buffer in the next functions. The
682 * size is known and ULONG according to
683 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
685 if (!SetupDiGetDeviceRegistryProperty(
686 parent_dev_info, &parent_dev_info_data, SPDRP_BUSNUMBER,
687 &type, (PBYTE)&bus, size, NULL)) {
688 debug_error("failed to get PCI bus");
689 bus = -1;
690 partial_pci = true;
694 * The function retrieves the device's address. This value will be
695 * transformed into device function and number
697 if (!SetupDiGetDeviceRegistryProperty(
698 parent_dev_info, &parent_dev_info_data, SPDRP_ADDRESS,
699 &type, (PBYTE)&addr, size, NULL)) {
700 debug_error("failed to get PCI address");
701 addr = -1;
702 partial_pci = true;
706 * This call returns UINumber of DEVICE_CAPABILITIES structure.
707 * This number is typically a user-perceived slot number.
709 if (!SetupDiGetDeviceRegistryProperty(
710 parent_dev_info, &parent_dev_info_data, SPDRP_UI_NUMBER,
711 &type, (PBYTE)&ui_slot, size, NULL)) {
712 debug_error("failed to get PCI slot");
713 ui_slot = -1;
714 partial_pci = true;
718 * SetupApi gives us the same information as driver with
719 * IoGetDeviceProperty. According to Microsoft:
721 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF)
722 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF)
723 * SPDRP_ADDRESS is propertyAddress, so we do the same.
725 * https://docs.microsoft.com/en-us/windows/desktop/api/setupapi/nf-setupapi-setupdigetdeviceregistrypropertya
727 if (partial_pci) {
728 pci->domain = -1;
729 pci->slot = -1;
730 pci->function = -1;
731 pci->bus = -1;
732 continue;
733 } else {
734 func = ((int)addr == -1) ? -1 : addr & 0x0000FFFF;
735 slot = ((int)addr == -1) ? -1 : (addr >> 16) & 0x0000FFFF;
736 if ((int)ui_slot != slot) {
737 g_debug("mismatch with reported slot values: %d vs %d",
738 (int)ui_slot, slot);
740 pci->domain = 0;
741 pci->slot = (int)ui_slot;
742 pci->function = func;
743 pci->bus = (int)bus;
744 break;
747 SetupDiDestroyDeviceInfoList(parent_dev_info);
748 break;
751 free_dev_info:
752 SetupDiDestroyDeviceInfoList(dev_info);
753 out:
754 return pci;
757 static void get_disk_properties(HANDLE vol_h, GuestDiskAddress *disk,
758 Error **errp)
760 STORAGE_PROPERTY_QUERY query;
761 STORAGE_DEVICE_DESCRIPTOR *dev_desc, buf;
762 DWORD received;
763 ULONG size = sizeof(buf);
765 dev_desc = &buf;
766 query.PropertyId = StorageDeviceProperty;
767 query.QueryType = PropertyStandardQuery;
769 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
770 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
771 size, &received, NULL)) {
772 error_setg_win32(errp, GetLastError(), "failed to get bus type");
773 return;
775 disk->bus_type = find_bus_type(dev_desc->BusType);
776 g_debug("bus type %d", disk->bus_type);
778 /* Query once more. Now with long enough buffer. */
779 size = dev_desc->Size;
780 dev_desc = g_malloc0(size);
781 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
782 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
783 size, &received, NULL)) {
784 error_setg_win32(errp, GetLastError(), "failed to get serial number");
785 g_debug("failed to get serial number");
786 goto out_free;
788 if (dev_desc->SerialNumberOffset > 0) {
789 const char *serial;
790 size_t len;
792 if (dev_desc->SerialNumberOffset >= received) {
793 error_setg(errp, "failed to get serial number: offset outside the buffer");
794 g_debug("serial number offset outside the buffer");
795 goto out_free;
797 serial = (char *)dev_desc + dev_desc->SerialNumberOffset;
798 len = received - dev_desc->SerialNumberOffset;
799 g_debug("serial number \"%s\"", serial);
800 if (*serial != 0) {
801 disk->serial = g_strndup(serial, len);
802 disk->has_serial = true;
805 out_free:
806 g_free(dev_desc);
808 return;
811 static void get_single_disk_info(int disk_number,
812 GuestDiskAddress *disk, Error **errp)
814 SCSI_ADDRESS addr, *scsi_ad;
815 DWORD len;
816 HANDLE disk_h;
817 Error *local_err = NULL;
819 scsi_ad = &addr;
821 g_debug("getting disk info for: %s", disk->dev);
822 disk_h = CreateFile(disk->dev, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
823 0, NULL);
824 if (disk_h == INVALID_HANDLE_VALUE) {
825 error_setg_win32(errp, GetLastError(), "failed to open disk");
826 return;
829 get_disk_properties(disk_h, disk, &local_err);
830 if (local_err) {
831 error_propagate(errp, local_err);
832 goto err_close;
835 g_debug("bus type %d", disk->bus_type);
836 /* always set pci_controller as required by schema. get_pci_info() should
837 * report -1 values for non-PCI buses rather than fail. fail the command
838 * if that doesn't hold since that suggests some other unexpected
839 * breakage
841 disk->pci_controller = get_pci_info(disk_number, &local_err);
842 if (local_err) {
843 error_propagate(errp, local_err);
844 goto err_close;
846 if (disk->bus_type == GUEST_DISK_BUS_TYPE_SCSI
847 || disk->bus_type == GUEST_DISK_BUS_TYPE_IDE
848 || disk->bus_type == GUEST_DISK_BUS_TYPE_RAID
849 /* This bus type is not supported before Windows Server 2003 SP1 */
850 || disk->bus_type == GUEST_DISK_BUS_TYPE_SAS
852 /* We are able to use the same ioctls for different bus types
853 * according to Microsoft docs
854 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
855 g_debug("getting SCSI info");
856 if (DeviceIoControl(disk_h, IOCTL_SCSI_GET_ADDRESS, NULL, 0, scsi_ad,
857 sizeof(SCSI_ADDRESS), &len, NULL)) {
858 disk->unit = addr.Lun;
859 disk->target = addr.TargetId;
860 disk->bus = addr.PathId;
862 /* We do not set error in this case, because we still have enough
863 * information about volume. */
866 err_close:
867 CloseHandle(disk_h);
868 return;
871 /* VSS provider works with volumes, thus there is no difference if
872 * the volume consist of spanned disks. Info about the first disk in the
873 * volume is returned for the spanned disk group (LVM) */
874 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
876 Error *local_err = NULL;
877 GuestDiskAddressList *list = NULL;
878 GuestDiskAddress *disk = NULL;
879 int i;
880 HANDLE vol_h;
881 DWORD size;
882 PVOLUME_DISK_EXTENTS extents = NULL;
884 /* strip final backslash */
885 char *name = g_strdup(guid);
886 if (g_str_has_suffix(name, "\\")) {
887 name[strlen(name) - 1] = 0;
890 g_debug("opening %s", name);
891 vol_h = CreateFile(name, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
892 0, NULL);
893 if (vol_h == INVALID_HANDLE_VALUE) {
894 error_setg_win32(errp, GetLastError(), "failed to open volume");
895 goto out;
898 /* Get list of extents */
899 g_debug("getting disk extents");
900 size = sizeof(VOLUME_DISK_EXTENTS);
901 extents = g_malloc0(size);
902 if (!DeviceIoControl(vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
903 0, extents, size, &size, NULL)) {
904 DWORD last_err = GetLastError();
905 if (last_err == ERROR_MORE_DATA) {
906 /* Try once more with big enough buffer */
907 g_free(extents);
908 extents = g_malloc0(size);
909 if (!DeviceIoControl(
910 vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
911 0, extents, size, NULL, NULL)) {
912 error_setg_win32(errp, GetLastError(),
913 "failed to get disk extents");
914 goto out;
916 } else if (last_err == ERROR_INVALID_FUNCTION) {
917 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
918 g_debug("volume not on disk");
919 disk = g_malloc0(sizeof(GuestDiskAddress));
920 disk->has_dev = true;
921 disk->dev = g_strdup(name);
922 get_single_disk_info(0xffffffff, disk, &local_err);
923 if (local_err) {
924 g_debug("failed to get disk info, ignoring error: %s",
925 error_get_pretty(local_err));
926 error_free(local_err);
927 goto out;
929 QAPI_LIST_PREPEND(list, disk);
930 disk = NULL;
931 goto out;
932 } else {
933 error_setg_win32(errp, GetLastError(),
934 "failed to get disk extents");
935 goto out;
938 g_debug("Number of extents: %lu", extents->NumberOfDiskExtents);
940 /* Go through each extent */
941 for (i = 0; i < extents->NumberOfDiskExtents; i++) {
942 disk = g_malloc0(sizeof(GuestDiskAddress));
944 /* Disk numbers directly correspond to numbers used in UNCs
946 * See documentation for DISK_EXTENT:
947 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
949 * See also Naming Files, Paths and Namespaces:
950 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
952 disk->has_dev = true;
953 disk->dev = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
954 extents->Extents[i].DiskNumber);
956 get_single_disk_info(extents->Extents[i].DiskNumber, disk, &local_err);
957 if (local_err) {
958 error_propagate(errp, local_err);
959 goto out;
961 QAPI_LIST_PREPEND(list, disk);
962 disk = NULL;
966 out:
967 if (vol_h != INVALID_HANDLE_VALUE) {
968 CloseHandle(vol_h);
970 qapi_free_GuestDiskAddress(disk);
971 g_free(extents);
972 g_free(name);
974 return list;
977 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
979 GuestDiskInfoList *ret = NULL;
980 HDEVINFO dev_info;
981 SP_DEVICE_INTERFACE_DATA dev_iface_data;
982 int i;
984 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
985 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
986 if (dev_info == INVALID_HANDLE_VALUE) {
987 error_setg_win32(errp, GetLastError(), "failed to get device tree");
988 return NULL;
991 g_debug("enumerating devices");
992 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
993 for (i = 0;
994 SetupDiEnumDeviceInterfaces(dev_info, NULL, &GUID_DEVINTERFACE_DISK,
995 i, &dev_iface_data);
996 i++) {
997 GuestDiskAddress *address = NULL;
998 GuestDiskInfo *disk = NULL;
999 Error *local_err = NULL;
1000 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1001 pdev_iface_detail_data = NULL;
1002 STORAGE_DEVICE_NUMBER sdn;
1003 HANDLE dev_file;
1004 DWORD size = 0;
1005 BOOL result;
1006 int attempt;
1008 g_debug(" getting device path");
1009 for (attempt = 0, result = FALSE; attempt < 2 && !result; attempt++) {
1010 result = SetupDiGetDeviceInterfaceDetail(dev_info,
1011 &dev_iface_data, pdev_iface_detail_data, size, &size, NULL);
1012 if (result) {
1013 break;
1015 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
1016 pdev_iface_detail_data = g_realloc(pdev_iface_detail_data,
1017 size);
1018 pdev_iface_detail_data->cbSize =
1019 sizeof(*pdev_iface_detail_data);
1020 } else {
1021 g_debug("failed to get device interface details");
1022 break;
1025 if (!result) {
1026 g_debug("skipping device");
1027 continue;
1030 g_debug(" device: %s", pdev_iface_detail_data->DevicePath);
1031 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
1032 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
1033 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
1034 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
1035 CloseHandle(dev_file);
1036 debug_error("failed to get storage device number");
1037 continue;
1039 CloseHandle(dev_file);
1041 disk = g_new0(GuestDiskInfo, 1);
1042 disk->name = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1043 sdn.DeviceNumber);
1045 g_debug(" number: %lu", sdn.DeviceNumber);
1046 address = g_malloc0(sizeof(GuestDiskAddress));
1047 address->has_dev = true;
1048 address->dev = g_strdup(disk->name);
1049 get_single_disk_info(sdn.DeviceNumber, address, &local_err);
1050 if (local_err) {
1051 g_debug("failed to get disk info: %s",
1052 error_get_pretty(local_err));
1053 error_free(local_err);
1054 qapi_free_GuestDiskAddress(address);
1055 address = NULL;
1056 } else {
1057 disk->address = address;
1058 disk->has_address = true;
1061 QAPI_LIST_PREPEND(ret, disk);
1064 SetupDiDestroyDeviceInfoList(dev_info);
1065 return ret;
1068 #else
1070 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
1072 return NULL;
1075 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1077 error_setg(errp, QERR_UNSUPPORTED);
1078 return NULL;
1081 #endif /* CONFIG_QGA_NTDDSCSI */
1083 static GuestFilesystemInfo *build_guest_fsinfo(char *guid, Error **errp)
1085 DWORD info_size;
1086 char mnt, *mnt_point;
1087 wchar_t wfs_name[32];
1088 char fs_name[32];
1089 wchar_t vol_info[MAX_PATH + 1];
1090 size_t len;
1091 uint64_t i64FreeBytesToCaller, i64TotalBytes, i64FreeBytes;
1092 GuestFilesystemInfo *fs = NULL;
1093 HANDLE hLocalDiskHandle = INVALID_HANDLE_VALUE;
1095 GetVolumePathNamesForVolumeName(guid, (LPCH)&mnt, 0, &info_size);
1096 if (GetLastError() != ERROR_MORE_DATA) {
1097 error_setg_win32(errp, GetLastError(), "failed to get volume name");
1098 return NULL;
1101 mnt_point = g_malloc(info_size + 1);
1102 if (!GetVolumePathNamesForVolumeName(guid, mnt_point, info_size,
1103 &info_size)) {
1104 error_setg_win32(errp, GetLastError(), "failed to get volume name");
1105 goto free;
1108 hLocalDiskHandle = CreateFile(guid, 0 , 0, NULL, OPEN_EXISTING,
1109 FILE_ATTRIBUTE_NORMAL |
1110 FILE_FLAG_BACKUP_SEMANTICS, NULL);
1111 if (INVALID_HANDLE_VALUE == hLocalDiskHandle) {
1112 error_setg_win32(errp, GetLastError(), "failed to get handle for volume");
1113 goto free;
1116 len = strlen(mnt_point);
1117 mnt_point[len] = '\\';
1118 mnt_point[len + 1] = 0;
1120 if (!GetVolumeInformationByHandleW(hLocalDiskHandle, vol_info,
1121 sizeof(vol_info), NULL, NULL, NULL,
1122 (LPWSTR) & wfs_name, sizeof(wfs_name))) {
1123 if (GetLastError() != ERROR_NOT_READY) {
1124 error_setg_win32(errp, GetLastError(), "failed to get volume info");
1126 goto free;
1129 fs = g_malloc(sizeof(*fs));
1130 fs->name = g_strdup(guid);
1131 fs->has_total_bytes = false;
1132 fs->has_used_bytes = false;
1133 if (len == 0) {
1134 fs->mountpoint = g_strdup("System Reserved");
1135 } else {
1136 fs->mountpoint = g_strndup(mnt_point, len);
1137 if (GetDiskFreeSpaceEx(fs->mountpoint,
1138 (PULARGE_INTEGER) & i64FreeBytesToCaller,
1139 (PULARGE_INTEGER) & i64TotalBytes,
1140 (PULARGE_INTEGER) & i64FreeBytes)) {
1141 fs->used_bytes = i64TotalBytes - i64FreeBytes;
1142 fs->total_bytes = i64TotalBytes;
1143 fs->has_total_bytes = true;
1144 fs->has_used_bytes = true;
1147 wcstombs(fs_name, wfs_name, sizeof(wfs_name));
1148 fs->type = g_strdup(fs_name);
1149 fs->disk = build_guest_disk_info(guid, errp);
1150 free:
1151 if (hLocalDiskHandle != INVALID_HANDLE_VALUE) {
1152 CloseHandle(hLocalDiskHandle);
1154 g_free(mnt_point);
1155 return fs;
1158 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
1160 HANDLE vol_h;
1161 GuestFilesystemInfoList *ret = NULL;
1162 char guid[256];
1164 vol_h = FindFirstVolume(guid, sizeof(guid));
1165 if (vol_h == INVALID_HANDLE_VALUE) {
1166 error_setg_win32(errp, GetLastError(), "failed to find any volume");
1167 return NULL;
1170 do {
1171 Error *local_err = NULL;
1172 GuestFilesystemInfo *info = build_guest_fsinfo(guid, &local_err);
1173 if (local_err) {
1174 g_debug("failed to get filesystem info, ignoring error: %s",
1175 error_get_pretty(local_err));
1176 error_free(local_err);
1177 continue;
1179 QAPI_LIST_PREPEND(ret, info);
1180 } while (FindNextVolume(vol_h, guid, sizeof(guid)));
1182 if (GetLastError() != ERROR_NO_MORE_FILES) {
1183 error_setg_win32(errp, GetLastError(), "failed to find next volume");
1186 FindVolumeClose(vol_h);
1187 return ret;
1191 * Return status of freeze/thaw
1193 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
1195 if (!vss_initialized()) {
1196 error_setg(errp, QERR_UNSUPPORTED);
1197 return 0;
1200 if (ga_is_frozen(ga_state)) {
1201 return GUEST_FSFREEZE_STATUS_FROZEN;
1204 return GUEST_FSFREEZE_STATUS_THAWED;
1208 * Freeze local file systems using Volume Shadow-copy Service.
1209 * The frozen state is limited for up to 10 seconds by VSS.
1211 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
1213 return qmp_guest_fsfreeze_freeze_list(false, NULL, errp);
1216 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
1217 strList *mountpoints,
1218 Error **errp)
1220 int i;
1221 Error *local_err = NULL;
1223 if (!vss_initialized()) {
1224 error_setg(errp, QERR_UNSUPPORTED);
1225 return 0;
1228 slog("guest-fsfreeze called");
1230 /* cannot risk guest agent blocking itself on a write in this state */
1231 ga_set_frozen(ga_state);
1233 qga_vss_fsfreeze(&i, true, mountpoints, &local_err);
1234 if (local_err) {
1235 error_propagate(errp, local_err);
1236 goto error;
1239 return i;
1241 error:
1242 local_err = NULL;
1243 qmp_guest_fsfreeze_thaw(&local_err);
1244 if (local_err) {
1245 g_debug("cleanup thaw: %s", error_get_pretty(local_err));
1246 error_free(local_err);
1248 return 0;
1252 * Thaw local file systems using Volume Shadow-copy Service.
1254 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1256 int i;
1258 if (!vss_initialized()) {
1259 error_setg(errp, QERR_UNSUPPORTED);
1260 return 0;
1263 qga_vss_fsfreeze(&i, false, NULL, errp);
1265 ga_unset_frozen(ga_state);
1266 return i;
1269 static void guest_fsfreeze_cleanup(void)
1271 Error *err = NULL;
1273 if (!vss_initialized()) {
1274 return;
1277 if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1278 qmp_guest_fsfreeze_thaw(&err);
1279 if (err) {
1280 slog("failed to clean up frozen filesystems: %s",
1281 error_get_pretty(err));
1282 error_free(err);
1286 vss_deinit(true);
1290 * Walk list of mounted file systems in the guest, and discard unused
1291 * areas.
1293 GuestFilesystemTrimResponse *
1294 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1296 GuestFilesystemTrimResponse *resp;
1297 HANDLE handle;
1298 WCHAR guid[MAX_PATH] = L"";
1299 OSVERSIONINFO osvi;
1300 BOOL win8_or_later;
1302 ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
1303 osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1304 GetVersionEx(&osvi);
1305 win8_or_later = (osvi.dwMajorVersion > 6 ||
1306 ((osvi.dwMajorVersion == 6) &&
1307 (osvi.dwMinorVersion >= 2)));
1308 if (!win8_or_later) {
1309 error_setg(errp, "fstrim is only supported for Win8+");
1310 return NULL;
1313 handle = FindFirstVolumeW(guid, ARRAYSIZE(guid));
1314 if (handle == INVALID_HANDLE_VALUE) {
1315 error_setg_win32(errp, GetLastError(), "failed to find any volume");
1316 return NULL;
1319 resp = g_new0(GuestFilesystemTrimResponse, 1);
1321 do {
1322 GuestFilesystemTrimResult *res;
1323 PWCHAR uc_path;
1324 DWORD char_count = 0;
1325 char *path, *out;
1326 GError *gerr = NULL;
1327 gchar *argv[4];
1329 GetVolumePathNamesForVolumeNameW(guid, NULL, 0, &char_count);
1331 if (GetLastError() != ERROR_MORE_DATA) {
1332 continue;
1334 if (GetDriveTypeW(guid) != DRIVE_FIXED) {
1335 continue;
1338 uc_path = g_malloc(sizeof(WCHAR) * char_count);
1339 if (!GetVolumePathNamesForVolumeNameW(guid, uc_path, char_count,
1340 &char_count) || !*uc_path) {
1341 /* strange, but this condition could be faced even with size == 2 */
1342 g_free(uc_path);
1343 continue;
1346 res = g_new0(GuestFilesystemTrimResult, 1);
1348 path = g_utf16_to_utf8(uc_path, char_count, NULL, NULL, &gerr);
1350 g_free(uc_path);
1352 if (!path) {
1353 res->has_error = true;
1354 res->error = g_strdup(gerr->message);
1355 g_error_free(gerr);
1356 break;
1359 res->path = path;
1361 QAPI_LIST_PREPEND(resp->paths, res);
1363 memset(argv, 0, sizeof(argv));
1364 argv[0] = (gchar *)"defrag.exe";
1365 argv[1] = (gchar *)"/L";
1366 argv[2] = path;
1368 if (!g_spawn_sync(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL,
1369 &out /* stdout */, NULL /* stdin */,
1370 NULL, &gerr)) {
1371 res->has_error = true;
1372 res->error = g_strdup(gerr->message);
1373 g_error_free(gerr);
1374 } else {
1375 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1376 Error is reported in the output with something like
1377 (x89000020) etc code in the stdout */
1379 int i;
1380 gchar **lines = g_strsplit(out, "\r\n", 0);
1381 g_free(out);
1383 for (i = 0; lines[i] != NULL; i++) {
1384 if (g_strstr_len(lines[i], -1, "(0x") == NULL) {
1385 continue;
1387 res->has_error = true;
1388 res->error = g_strdup(lines[i]);
1389 break;
1391 g_strfreev(lines);
1393 } while (FindNextVolumeW(handle, guid, ARRAYSIZE(guid)));
1395 FindVolumeClose(handle);
1396 return resp;
1399 typedef enum {
1400 GUEST_SUSPEND_MODE_DISK,
1401 GUEST_SUSPEND_MODE_RAM
1402 } GuestSuspendMode;
1404 static void check_suspend_mode(GuestSuspendMode mode, Error **errp)
1406 SYSTEM_POWER_CAPABILITIES sys_pwr_caps;
1408 ZeroMemory(&sys_pwr_caps, sizeof(sys_pwr_caps));
1409 if (!GetPwrCapabilities(&sys_pwr_caps)) {
1410 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1411 "failed to determine guest suspend capabilities");
1412 return;
1415 switch (mode) {
1416 case GUEST_SUSPEND_MODE_DISK:
1417 if (!sys_pwr_caps.SystemS4) {
1418 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1419 "suspend-to-disk not supported by OS");
1421 break;
1422 case GUEST_SUSPEND_MODE_RAM:
1423 if (!sys_pwr_caps.SystemS3) {
1424 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1425 "suspend-to-ram not supported by OS");
1427 break;
1428 default:
1429 abort();
1433 static DWORD WINAPI do_suspend(LPVOID opaque)
1435 GuestSuspendMode *mode = opaque;
1436 DWORD ret = 0;
1438 if (!SetSuspendState(*mode == GUEST_SUSPEND_MODE_DISK, TRUE, TRUE)) {
1439 g_autofree gchar *emsg = g_win32_error_message(GetLastError());
1440 slog("failed to suspend guest: %s", emsg);
1441 ret = -1;
1443 g_free(mode);
1444 return ret;
1447 void qmp_guest_suspend_disk(Error **errp)
1449 Error *local_err = NULL;
1450 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1452 *mode = GUEST_SUSPEND_MODE_DISK;
1453 check_suspend_mode(*mode, &local_err);
1454 if (local_err) {
1455 goto out;
1457 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1458 if (local_err) {
1459 goto out;
1461 execute_async(do_suspend, mode, &local_err);
1463 out:
1464 if (local_err) {
1465 error_propagate(errp, local_err);
1466 g_free(mode);
1470 void qmp_guest_suspend_ram(Error **errp)
1472 Error *local_err = NULL;
1473 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1475 *mode = GUEST_SUSPEND_MODE_RAM;
1476 check_suspend_mode(*mode, &local_err);
1477 if (local_err) {
1478 goto out;
1480 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1481 if (local_err) {
1482 goto out;
1484 execute_async(do_suspend, mode, &local_err);
1486 out:
1487 if (local_err) {
1488 error_propagate(errp, local_err);
1489 g_free(mode);
1493 void qmp_guest_suspend_hybrid(Error **errp)
1495 error_setg(errp, QERR_UNSUPPORTED);
1498 static IP_ADAPTER_ADDRESSES *guest_get_adapters_addresses(Error **errp)
1500 IP_ADAPTER_ADDRESSES *adptr_addrs = NULL;
1501 ULONG adptr_addrs_len = 0;
1502 DWORD ret;
1504 /* Call the first time to get the adptr_addrs_len. */
1505 GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1506 NULL, adptr_addrs, &adptr_addrs_len);
1508 adptr_addrs = g_malloc(adptr_addrs_len);
1509 ret = GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1510 NULL, adptr_addrs, &adptr_addrs_len);
1511 if (ret != ERROR_SUCCESS) {
1512 error_setg_win32(errp, ret, "failed to get adapters addresses");
1513 g_free(adptr_addrs);
1514 adptr_addrs = NULL;
1516 return adptr_addrs;
1519 static char *guest_wctomb_dup(WCHAR *wstr)
1521 char *str;
1522 size_t str_size;
1524 str_size = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, NULL, 0, NULL, NULL);
1525 /* add 1 to str_size for NULL terminator */
1526 str = g_malloc(str_size + 1);
1527 WideCharToMultiByte(CP_UTF8, 0, wstr, -1, str, str_size, NULL, NULL);
1528 return str;
1531 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS *ip_addr,
1532 Error **errp)
1534 char addr_str[INET6_ADDRSTRLEN + INET_ADDRSTRLEN];
1535 DWORD len;
1536 int ret;
1538 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET ||
1539 ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1540 len = sizeof(addr_str);
1541 ret = WSAAddressToString(ip_addr->Address.lpSockaddr,
1542 ip_addr->Address.iSockaddrLength,
1543 NULL,
1544 addr_str,
1545 &len);
1546 if (ret != 0) {
1547 error_setg_win32(errp, WSAGetLastError(),
1548 "failed address presentation form conversion");
1549 return NULL;
1551 return g_strdup(addr_str);
1553 return NULL;
1556 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS *ip_addr)
1558 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1559 * field to obtain the prefix.
1561 return ip_addr->OnLinkPrefixLength;
1564 #define INTERFACE_PATH_BUF_SZ 512
1566 static DWORD get_interface_index(const char *guid)
1568 ULONG index;
1569 DWORD status;
1570 wchar_t wbuf[INTERFACE_PATH_BUF_SZ];
1571 snwprintf(wbuf, INTERFACE_PATH_BUF_SZ, L"\\device\\tcpip_%s", guid);
1572 wbuf[INTERFACE_PATH_BUF_SZ - 1] = 0;
1573 status = GetAdapterIndex (wbuf, &index);
1574 if (status != NO_ERROR) {
1575 return (DWORD)~0;
1576 } else {
1577 return index;
1581 typedef NETIOAPI_API (WINAPI *GetIfEntry2Func)(PMIB_IF_ROW2 Row);
1583 static int guest_get_network_stats(const char *name,
1584 GuestNetworkInterfaceStat *stats)
1586 OSVERSIONINFO os_ver;
1588 os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1589 GetVersionEx(&os_ver);
1590 if (os_ver.dwMajorVersion >= 6) {
1591 MIB_IF_ROW2 a_mid_ifrow;
1592 GetIfEntry2Func getifentry2_ex;
1593 DWORD if_index = 0;
1594 HMODULE module = GetModuleHandle("iphlpapi");
1595 PVOID func = GetProcAddress(module, "GetIfEntry2");
1597 if (func == NULL) {
1598 return -1;
1601 getifentry2_ex = (GetIfEntry2Func)func;
1602 if_index = get_interface_index(name);
1603 if (if_index == (DWORD)~0) {
1604 return -1;
1607 memset(&a_mid_ifrow, 0, sizeof(a_mid_ifrow));
1608 a_mid_ifrow.InterfaceIndex = if_index;
1609 if (NO_ERROR == getifentry2_ex(&a_mid_ifrow)) {
1610 stats->rx_bytes = a_mid_ifrow.InOctets;
1611 stats->rx_packets = a_mid_ifrow.InUcastPkts;
1612 stats->rx_errs = a_mid_ifrow.InErrors;
1613 stats->rx_dropped = a_mid_ifrow.InDiscards;
1614 stats->tx_bytes = a_mid_ifrow.OutOctets;
1615 stats->tx_packets = a_mid_ifrow.OutUcastPkts;
1616 stats->tx_errs = a_mid_ifrow.OutErrors;
1617 stats->tx_dropped = a_mid_ifrow.OutDiscards;
1618 return 0;
1621 return -1;
1624 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
1626 IP_ADAPTER_ADDRESSES *adptr_addrs, *addr;
1627 IP_ADAPTER_UNICAST_ADDRESS *ip_addr = NULL;
1628 GuestNetworkInterfaceList *head = NULL, **tail = &head;
1629 GuestIpAddressList *head_addr, **tail_addr;
1630 GuestNetworkInterface *info;
1631 GuestNetworkInterfaceStat *interface_stat = NULL;
1632 GuestIpAddress *address_item = NULL;
1633 unsigned char *mac_addr;
1634 char *addr_str;
1635 WORD wsa_version;
1636 WSADATA wsa_data;
1637 int ret;
1639 adptr_addrs = guest_get_adapters_addresses(errp);
1640 if (adptr_addrs == NULL) {
1641 return NULL;
1644 /* Make WSA APIs available. */
1645 wsa_version = MAKEWORD(2, 2);
1646 ret = WSAStartup(wsa_version, &wsa_data);
1647 if (ret != 0) {
1648 error_setg_win32(errp, ret, "failed socket startup");
1649 goto out;
1652 for (addr = adptr_addrs; addr; addr = addr->Next) {
1653 info = g_malloc0(sizeof(*info));
1655 QAPI_LIST_APPEND(tail, info);
1657 info->name = guest_wctomb_dup(addr->FriendlyName);
1659 if (addr->PhysicalAddressLength != 0) {
1660 mac_addr = addr->PhysicalAddress;
1662 info->hardware_address =
1663 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1664 (int) mac_addr[0], (int) mac_addr[1],
1665 (int) mac_addr[2], (int) mac_addr[3],
1666 (int) mac_addr[4], (int) mac_addr[5]);
1668 info->has_hardware_address = true;
1671 head_addr = NULL;
1672 tail_addr = &head_addr;
1673 for (ip_addr = addr->FirstUnicastAddress;
1674 ip_addr;
1675 ip_addr = ip_addr->Next) {
1676 addr_str = guest_addr_to_str(ip_addr, errp);
1677 if (addr_str == NULL) {
1678 continue;
1681 address_item = g_malloc0(sizeof(*address_item));
1683 QAPI_LIST_APPEND(tail_addr, address_item);
1685 address_item->ip_address = addr_str;
1686 address_item->prefix = guest_ip_prefix(ip_addr);
1687 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET) {
1688 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV4;
1689 } else if (ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1690 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV6;
1693 if (head_addr) {
1694 info->has_ip_addresses = true;
1695 info->ip_addresses = head_addr;
1697 if (!info->has_statistics) {
1698 interface_stat = g_malloc0(sizeof(*interface_stat));
1699 if (guest_get_network_stats(addr->AdapterName,
1700 interface_stat) == -1) {
1701 info->has_statistics = false;
1702 g_free(interface_stat);
1703 } else {
1704 info->statistics = interface_stat;
1705 info->has_statistics = true;
1709 WSACleanup();
1710 out:
1711 g_free(adptr_addrs);
1712 return head;
1715 static int64_t filetime_to_ns(const FILETIME *tf)
1717 return ((((int64_t)tf->dwHighDateTime << 32) | tf->dwLowDateTime)
1718 - W32_FT_OFFSET) * 100;
1721 int64_t qmp_guest_get_time(Error **errp)
1723 SYSTEMTIME ts = {0};
1724 FILETIME tf;
1726 GetSystemTime(&ts);
1727 if (ts.wYear < 1601 || ts.wYear > 30827) {
1728 error_setg(errp, "Failed to get time");
1729 return -1;
1732 if (!SystemTimeToFileTime(&ts, &tf)) {
1733 error_setg(errp, "Failed to convert system time: %d", (int)GetLastError());
1734 return -1;
1737 return filetime_to_ns(&tf);
1740 void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
1742 Error *local_err = NULL;
1743 SYSTEMTIME ts;
1744 FILETIME tf;
1745 LONGLONG time;
1747 if (!has_time) {
1748 /* Unfortunately, Windows libraries don't provide an easy way to access
1749 * RTC yet:
1751 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1753 * Instead, a workaround is to use the Windows win32tm command to
1754 * resync the time using the Windows Time service.
1756 LPVOID msg_buffer;
1757 DWORD ret_flags;
1759 HRESULT hr = system("w32tm /resync /nowait");
1761 if (GetLastError() != 0) {
1762 strerror_s((LPTSTR) & msg_buffer, 0, errno);
1763 error_setg(errp, "system(...) failed: %s", (LPCTSTR)msg_buffer);
1764 } else if (hr != 0) {
1765 if (hr == HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)) {
1766 error_setg(errp, "Windows Time service not running on the "
1767 "guest");
1768 } else {
1769 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
1770 FORMAT_MESSAGE_FROM_SYSTEM |
1771 FORMAT_MESSAGE_IGNORE_INSERTS, NULL,
1772 (DWORD)hr, MAKELANGID(LANG_NEUTRAL,
1773 SUBLANG_DEFAULT), (LPTSTR) & msg_buffer, 0,
1774 NULL)) {
1775 error_setg(errp, "w32tm failed with error (0x%lx), couldn'"
1776 "t retrieve error message", hr);
1777 } else {
1778 error_setg(errp, "w32tm failed with error (0x%lx): %s", hr,
1779 (LPCTSTR)msg_buffer);
1780 LocalFree(msg_buffer);
1783 } else if (!InternetGetConnectedState(&ret_flags, 0)) {
1784 error_setg(errp, "No internet connection on guest, sync not "
1785 "accurate");
1787 return;
1790 /* Validate time passed by user. */
1791 if (time_ns < 0 || time_ns / 100 > INT64_MAX - W32_FT_OFFSET) {
1792 error_setg(errp, "Time %" PRId64 "is invalid", time_ns);
1793 return;
1796 time = time_ns / 100 + W32_FT_OFFSET;
1798 tf.dwLowDateTime = (DWORD) time;
1799 tf.dwHighDateTime = (DWORD) (time >> 32);
1801 if (!FileTimeToSystemTime(&tf, &ts)) {
1802 error_setg(errp, "Failed to convert system time %d",
1803 (int)GetLastError());
1804 return;
1807 acquire_privilege(SE_SYSTEMTIME_NAME, &local_err);
1808 if (local_err) {
1809 error_propagate(errp, local_err);
1810 return;
1813 if (!SetSystemTime(&ts)) {
1814 error_setg(errp, "Failed to set time to guest: %d", (int)GetLastError());
1815 return;
1819 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
1821 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi, ptr;
1822 DWORD length;
1823 GuestLogicalProcessorList *head, **tail;
1824 Error *local_err = NULL;
1825 int64_t current;
1827 ptr = pslpi = NULL;
1828 length = 0;
1829 current = 0;
1830 head = NULL;
1831 tail = &head;
1833 if ((GetLogicalProcessorInformation(pslpi, &length) == FALSE) &&
1834 (GetLastError() == ERROR_INSUFFICIENT_BUFFER) &&
1835 (length > sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION))) {
1836 ptr = pslpi = g_malloc0(length);
1837 if (GetLogicalProcessorInformation(pslpi, &length) == FALSE) {
1838 error_setg(&local_err, "Failed to get processor information: %d",
1839 (int)GetLastError());
1841 } else {
1842 error_setg(&local_err,
1843 "Failed to get processor information buffer length: %d",
1844 (int)GetLastError());
1847 while ((local_err == NULL) && (length > 0)) {
1848 if (pslpi->Relationship == RelationProcessorCore) {
1849 ULONG_PTR cpu_bits = pslpi->ProcessorMask;
1851 while (cpu_bits > 0) {
1852 if (!!(cpu_bits & 1)) {
1853 GuestLogicalProcessor *vcpu;
1855 vcpu = g_malloc0(sizeof *vcpu);
1856 vcpu->logical_id = current++;
1857 vcpu->online = true;
1858 vcpu->has_can_offline = true;
1860 QAPI_LIST_APPEND(tail, vcpu);
1862 cpu_bits >>= 1;
1865 length -= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION);
1866 pslpi++; /* next entry */
1869 g_free(ptr);
1871 if (local_err == NULL) {
1872 if (head != NULL) {
1873 return head;
1875 /* there's no guest with zero VCPUs */
1876 error_setg(&local_err, "Guest reported zero VCPUs");
1879 qapi_free_GuestLogicalProcessorList(head);
1880 error_propagate(errp, local_err);
1881 return NULL;
1884 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
1886 error_setg(errp, QERR_UNSUPPORTED);
1887 return -1;
1890 static gchar *
1891 get_net_error_message(gint error)
1893 HMODULE module = NULL;
1894 gchar *retval = NULL;
1895 wchar_t *msg = NULL;
1896 int flags;
1897 size_t nchars;
1899 flags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
1900 FORMAT_MESSAGE_IGNORE_INSERTS |
1901 FORMAT_MESSAGE_FROM_SYSTEM;
1903 if (error >= NERR_BASE && error <= MAX_NERR) {
1904 module = LoadLibraryExW(L"netmsg.dll", NULL, LOAD_LIBRARY_AS_DATAFILE);
1906 if (module != NULL) {
1907 flags |= FORMAT_MESSAGE_FROM_HMODULE;
1911 FormatMessageW(flags, module, error, 0, (LPWSTR)&msg, 0, NULL);
1913 if (msg != NULL) {
1914 nchars = wcslen(msg);
1916 if (nchars >= 2 &&
1917 msg[nchars - 1] == L'\n' &&
1918 msg[nchars - 2] == L'\r') {
1919 msg[nchars - 2] = L'\0';
1922 retval = g_utf16_to_utf8(msg, -1, NULL, NULL, NULL);
1924 LocalFree(msg);
1927 if (module != NULL) {
1928 FreeLibrary(module);
1931 return retval;
1934 void qmp_guest_set_user_password(const char *username,
1935 const char *password,
1936 bool crypted,
1937 Error **errp)
1939 NET_API_STATUS nas;
1940 char *rawpasswddata = NULL;
1941 size_t rawpasswdlen;
1942 wchar_t *user = NULL, *wpass = NULL;
1943 USER_INFO_1003 pi1003 = { 0, };
1944 GError *gerr = NULL;
1946 if (crypted) {
1947 error_setg(errp, QERR_UNSUPPORTED);
1948 return;
1951 rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
1952 if (!rawpasswddata) {
1953 return;
1955 rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
1956 rawpasswddata[rawpasswdlen] = '\0';
1958 user = g_utf8_to_utf16(username, -1, NULL, NULL, &gerr);
1959 if (!user) {
1960 goto done;
1963 wpass = g_utf8_to_utf16(rawpasswddata, -1, NULL, NULL, &gerr);
1964 if (!wpass) {
1965 goto done;
1968 pi1003.usri1003_password = wpass;
1969 nas = NetUserSetInfo(NULL, user,
1970 1003, (LPBYTE)&pi1003,
1971 NULL);
1973 if (nas != NERR_Success) {
1974 gchar *msg = get_net_error_message(nas);
1975 error_setg(errp, "failed to set password: %s", msg);
1976 g_free(msg);
1979 done:
1980 if (gerr) {
1981 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
1982 g_error_free(gerr);
1984 g_free(user);
1985 g_free(wpass);
1986 g_free(rawpasswddata);
1989 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
1991 error_setg(errp, QERR_UNSUPPORTED);
1992 return NULL;
1995 GuestMemoryBlockResponseList *
1996 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
1998 error_setg(errp, QERR_UNSUPPORTED);
1999 return NULL;
2002 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
2004 error_setg(errp, QERR_UNSUPPORTED);
2005 return NULL;
2008 /* add unsupported commands to the blacklist */
2009 GList *ga_command_blacklist_init(GList *blacklist)
2011 const char *list_unsupported[] = {
2012 "guest-suspend-hybrid",
2013 "guest-set-vcpus",
2014 "guest-get-memory-blocks", "guest-set-memory-blocks",
2015 "guest-get-memory-block-size", "guest-get-memory-block-info",
2016 NULL};
2017 char **p = (char **)list_unsupported;
2019 while (*p) {
2020 blacklist = g_list_append(blacklist, g_strdup(*p++));
2023 if (!vss_init(true)) {
2024 g_debug("vss_init failed, vss commands are going to be disabled");
2025 const char *list[] = {
2026 "guest-get-fsinfo", "guest-fsfreeze-status",
2027 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL};
2028 p = (char **)list;
2030 while (*p) {
2031 blacklist = g_list_append(blacklist, g_strdup(*p++));
2035 return blacklist;
2038 /* register init/cleanup routines for stateful command groups */
2039 void ga_command_state_init(GAState *s, GACommandState *cs)
2041 if (!vss_initialized()) {
2042 ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
2046 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
2047 typedef struct _GA_WTSINFOA {
2048 WTS_CONNECTSTATE_CLASS State;
2049 DWORD SessionId;
2050 DWORD IncomingBytes;
2051 DWORD OutgoingBytes;
2052 DWORD IncomingFrames;
2053 DWORD OutgoingFrames;
2054 DWORD IncomingCompressedBytes;
2055 DWORD OutgoingCompressedBy;
2056 CHAR WinStationName[WINSTATIONNAME_LENGTH];
2057 CHAR Domain[DOMAIN_LENGTH];
2058 CHAR UserName[USERNAME_LENGTH + 1];
2059 LARGE_INTEGER ConnectTime;
2060 LARGE_INTEGER DisconnectTime;
2061 LARGE_INTEGER LastInputTime;
2062 LARGE_INTEGER LogonTime;
2063 LARGE_INTEGER CurrentTime;
2065 } GA_WTSINFOA;
2067 GuestUserList *qmp_guest_get_users(Error **errp)
2069 #define QGA_NANOSECONDS 10000000
2071 GHashTable *cache = NULL;
2072 GuestUserList *head = NULL, **tail = &head;
2074 DWORD buffer_size = 0, count = 0, i = 0;
2075 GA_WTSINFOA *info = NULL;
2076 WTS_SESSION_INFOA *entries = NULL;
2077 GuestUser *user = NULL;
2078 gpointer value = NULL;
2079 INT64 login = 0;
2080 double login_time = 0;
2082 cache = g_hash_table_new(g_str_hash, g_str_equal);
2084 if (WTSEnumerateSessionsA(NULL, 0, 1, &entries, &count)) {
2085 for (i = 0; i < count; ++i) {
2086 buffer_size = 0;
2087 info = NULL;
2088 if (WTSQuerySessionInformationA(
2089 NULL,
2090 entries[i].SessionId,
2091 WTSSessionInfo,
2092 (LPSTR *)&info,
2093 &buffer_size
2094 )) {
2096 if (strlen(info->UserName) == 0) {
2097 WTSFreeMemory(info);
2098 continue;
2101 login = info->LogonTime.QuadPart;
2102 login -= W32_FT_OFFSET;
2103 login_time = ((double)login) / QGA_NANOSECONDS;
2105 if (g_hash_table_contains(cache, info->UserName)) {
2106 value = g_hash_table_lookup(cache, info->UserName);
2107 user = (GuestUser *)value;
2108 if (user->login_time > login_time) {
2109 user->login_time = login_time;
2111 } else {
2112 user = g_new0(GuestUser, 1);
2114 user->user = g_strdup(info->UserName);
2115 user->domain = g_strdup(info->Domain);
2116 user->has_domain = true;
2118 user->login_time = login_time;
2120 g_hash_table_add(cache, user->user);
2122 QAPI_LIST_APPEND(tail, user);
2125 WTSFreeMemory(info);
2127 WTSFreeMemory(entries);
2129 g_hash_table_destroy(cache);
2130 return head;
2133 typedef struct _ga_matrix_lookup_t {
2134 int major;
2135 int minor;
2136 char const *version;
2137 char const *version_id;
2138 } ga_matrix_lookup_t;
2140 static ga_matrix_lookup_t const WIN_VERSION_MATRIX[2][8] = {
2142 /* Desktop editions */
2143 { 5, 0, "Microsoft Windows 2000", "2000"},
2144 { 5, 1, "Microsoft Windows XP", "xp"},
2145 { 6, 0, "Microsoft Windows Vista", "vista"},
2146 { 6, 1, "Microsoft Windows 7" "7"},
2147 { 6, 2, "Microsoft Windows 8", "8"},
2148 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2149 {10, 0, "Microsoft Windows 10", "10"},
2150 { 0, 0, 0}
2152 /* Server editions */
2153 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2154 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2155 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2156 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2157 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2158 { 0, 0, 0},
2159 { 0, 0, 0},
2160 { 0, 0, 0}
2164 typedef struct _ga_win_10_0_server_t {
2165 int final_build;
2166 char const *version;
2167 char const *version_id;
2168 } ga_win_10_0_server_t;
2170 static ga_win_10_0_server_t const WIN_10_0_SERVER_VERSION_MATRIX[4] = {
2171 {14393, "Microsoft Windows Server 2016", "2016"},
2172 {17763, "Microsoft Windows Server 2019", "2019"},
2173 {20344, "Microsoft Windows Server 2022", "2022"},
2174 {0, 0}
2177 static void ga_get_win_version(RTL_OSVERSIONINFOEXW *info, Error **errp)
2179 typedef NTSTATUS(WINAPI *rtl_get_version_t)(
2180 RTL_OSVERSIONINFOEXW *os_version_info_ex);
2182 info->dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
2184 HMODULE module = GetModuleHandle("ntdll");
2185 PVOID fun = GetProcAddress(module, "RtlGetVersion");
2186 if (fun == NULL) {
2187 error_setg(errp, QERR_QGA_COMMAND_FAILED,
2188 "Failed to get address of RtlGetVersion");
2189 return;
2192 rtl_get_version_t rtl_get_version = (rtl_get_version_t)fun;
2193 rtl_get_version(info);
2194 return;
2197 static char *ga_get_win_name(OSVERSIONINFOEXW const *os_version, bool id)
2199 DWORD major = os_version->dwMajorVersion;
2200 DWORD minor = os_version->dwMinorVersion;
2201 DWORD build = os_version->dwBuildNumber;
2202 int tbl_idx = (os_version->wProductType != VER_NT_WORKSTATION);
2203 ga_matrix_lookup_t const *table = WIN_VERSION_MATRIX[tbl_idx];
2204 ga_win_10_0_server_t const *win_10_0_table = WIN_10_0_SERVER_VERSION_MATRIX;
2205 while (table->version != NULL) {
2206 if (major == 10 && minor == 0 && tbl_idx) {
2207 while (win_10_0_table->version != NULL) {
2208 if (build <= win_10_0_table->final_build) {
2209 if (id) {
2210 return g_strdup(win_10_0_table->version_id);
2211 } else {
2212 return g_strdup(win_10_0_table->version);
2215 win_10_0_table++;
2217 } else if (major == table->major && minor == table->minor) {
2218 if (id) {
2219 return g_strdup(table->version_id);
2220 } else {
2221 return g_strdup(table->version);
2224 ++table;
2226 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2227 major, minor);
2228 return g_strdup("N/A");
2231 static char *ga_get_win_product_name(Error **errp)
2233 HKEY key = INVALID_HANDLE_VALUE;
2234 DWORD size = 128;
2235 char *result = g_malloc0(size);
2236 LONG err = ERROR_SUCCESS;
2238 err = RegOpenKeyA(HKEY_LOCAL_MACHINE,
2239 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2240 &key);
2241 if (err != ERROR_SUCCESS) {
2242 error_setg_win32(errp, err, "failed to open registry key");
2243 g_free(result);
2244 return NULL;
2247 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2248 (LPBYTE)result, &size);
2249 if (err == ERROR_MORE_DATA) {
2250 slog("ProductName longer than expected (%lu bytes), retrying",
2251 size);
2252 g_free(result);
2253 result = NULL;
2254 if (size > 0) {
2255 result = g_malloc0(size);
2256 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2257 (LPBYTE)result, &size);
2260 if (err != ERROR_SUCCESS) {
2261 error_setg_win32(errp, err, "failed to retrive ProductName");
2262 goto fail;
2265 RegCloseKey(key);
2266 return result;
2268 fail:
2269 if (key != INVALID_HANDLE_VALUE) {
2270 RegCloseKey(key);
2272 g_free(result);
2273 return NULL;
2276 static char *ga_get_current_arch(void)
2278 SYSTEM_INFO info;
2279 GetNativeSystemInfo(&info);
2280 char *result = NULL;
2281 switch (info.wProcessorArchitecture) {
2282 case PROCESSOR_ARCHITECTURE_AMD64:
2283 result = g_strdup("x86_64");
2284 break;
2285 case PROCESSOR_ARCHITECTURE_ARM:
2286 result = g_strdup("arm");
2287 break;
2288 case PROCESSOR_ARCHITECTURE_IA64:
2289 result = g_strdup("ia64");
2290 break;
2291 case PROCESSOR_ARCHITECTURE_INTEL:
2292 result = g_strdup("x86");
2293 break;
2294 case PROCESSOR_ARCHITECTURE_UNKNOWN:
2295 default:
2296 slog("unknown processor architecture 0x%0x",
2297 info.wProcessorArchitecture);
2298 result = g_strdup("unknown");
2299 break;
2301 return result;
2304 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
2306 Error *local_err = NULL;
2307 OSVERSIONINFOEXW os_version = {0};
2308 bool server;
2309 char *product_name;
2310 GuestOSInfo *info;
2312 ga_get_win_version(&os_version, &local_err);
2313 if (local_err) {
2314 error_propagate(errp, local_err);
2315 return NULL;
2318 server = os_version.wProductType != VER_NT_WORKSTATION;
2319 product_name = ga_get_win_product_name(errp);
2320 if (product_name == NULL) {
2321 return NULL;
2324 info = g_new0(GuestOSInfo, 1);
2326 info->has_kernel_version = true;
2327 info->kernel_version = g_strdup_printf("%lu.%lu",
2328 os_version.dwMajorVersion,
2329 os_version.dwMinorVersion);
2330 info->has_kernel_release = true;
2331 info->kernel_release = g_strdup_printf("%lu",
2332 os_version.dwBuildNumber);
2333 info->has_machine = true;
2334 info->machine = ga_get_current_arch();
2336 info->has_id = true;
2337 info->id = g_strdup("mswindows");
2338 info->has_name = true;
2339 info->name = g_strdup("Microsoft Windows");
2340 info->has_pretty_name = true;
2341 info->pretty_name = product_name;
2342 info->has_version = true;
2343 info->version = ga_get_win_name(&os_version, false);
2344 info->has_version_id = true;
2345 info->version_id = ga_get_win_name(&os_version, true);
2346 info->has_variant = true;
2347 info->variant = g_strdup(server ? "server" : "client");
2348 info->has_variant_id = true;
2349 info->variant_id = g_strdup(server ? "server" : "client");
2351 return info;
2355 * Safely get device property. Returned strings are using wide characters.
2356 * Caller is responsible for freeing the buffer.
2358 static LPBYTE cm_get_property(DEVINST devInst, const DEVPROPKEY *propName,
2359 PDEVPROPTYPE propType)
2361 CONFIGRET cr;
2362 g_autofree LPBYTE buffer = NULL;
2363 ULONG buffer_len = 0;
2365 /* First query for needed space */
2366 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2367 buffer, &buffer_len, 0);
2368 if (cr != CR_SUCCESS && cr != CR_BUFFER_SMALL) {
2370 slog("failed to get property size, error=0x%lx", cr);
2371 return NULL;
2373 buffer = g_new0(BYTE, buffer_len + 1);
2374 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2375 buffer, &buffer_len, 0);
2376 if (cr != CR_SUCCESS) {
2377 slog("failed to get device property, error=0x%lx", cr);
2378 return NULL;
2380 return g_steal_pointer(&buffer);
2383 static GStrv ga_get_hardware_ids(DEVINST devInstance)
2385 GArray *values = NULL;
2386 DEVPROPTYPE cm_type;
2387 LPWSTR id;
2388 g_autofree LPWSTR property = (LPWSTR)cm_get_property(devInstance,
2389 &qga_DEVPKEY_Device_HardwareIds, &cm_type);
2390 if (property == NULL) {
2391 slog("failed to get hardware IDs");
2392 return NULL;
2394 if (*property == '\0') {
2395 /* empty list */
2396 return NULL;
2398 values = g_array_new(TRUE, TRUE, sizeof(gchar *));
2399 for (id = property; '\0' != *id; id += lstrlenW(id) + 1) {
2400 gchar *id8 = g_utf16_to_utf8(id, -1, NULL, NULL, NULL);
2401 g_array_append_val(values, id8);
2403 return (GStrv)g_array_free(values, FALSE);
2407 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2409 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2411 GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
2413 GuestDeviceInfoList *head = NULL, **tail = &head;
2414 HDEVINFO dev_info = INVALID_HANDLE_VALUE;
2415 SP_DEVINFO_DATA dev_info_data;
2416 int i, j;
2417 GError *gerr = NULL;
2418 g_autoptr(GRegex) device_pci_re = NULL;
2419 DEVPROPTYPE cm_type;
2421 device_pci_re = g_regex_new(DEVICE_PCI_RE,
2422 G_REGEX_ANCHORED | G_REGEX_OPTIMIZE, 0,
2423 &gerr);
2424 g_assert(device_pci_re != NULL);
2426 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
2427 dev_info = SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT | DIGCF_ALLCLASSES);
2428 if (dev_info == INVALID_HANDLE_VALUE) {
2429 error_setg(errp, "failed to get device tree");
2430 return NULL;
2433 slog("enumerating devices");
2434 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
2435 bool skip = true;
2436 g_autofree LPWSTR name = NULL;
2437 g_autofree LPFILETIME date = NULL;
2438 g_autofree LPWSTR version = NULL;
2439 g_auto(GStrv) hw_ids = NULL;
2440 g_autoptr(GuestDeviceInfo) device = g_new0(GuestDeviceInfo, 1);
2441 g_autofree char *vendor_id = NULL;
2442 g_autofree char *device_id = NULL;
2444 name = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2445 &qga_DEVPKEY_NAME, &cm_type);
2446 if (name == NULL) {
2447 slog("failed to get device description");
2448 continue;
2450 device->driver_name = g_utf16_to_utf8(name, -1, NULL, NULL, NULL);
2451 if (device->driver_name == NULL) {
2452 error_setg(errp, "conversion to utf8 failed (driver name)");
2453 return NULL;
2455 slog("querying device: %s", device->driver_name);
2456 hw_ids = ga_get_hardware_ids(dev_info_data.DevInst);
2457 if (hw_ids == NULL) {
2458 continue;
2460 for (j = 0; hw_ids[j] != NULL; j++) {
2461 g_autoptr(GMatchInfo) match_info;
2462 GuestDeviceIdPCI *id;
2463 if (!g_regex_match(device_pci_re, hw_ids[j], 0, &match_info)) {
2464 continue;
2466 skip = false;
2468 vendor_id = g_match_info_fetch(match_info, 1);
2469 device_id = g_match_info_fetch(match_info, 2);
2471 device->id = g_new0(GuestDeviceId, 1);
2472 device->has_id = true;
2473 device->id->type = GUEST_DEVICE_TYPE_PCI;
2474 id = &device->id->u.pci;
2475 id->vendor_id = g_ascii_strtoull(vendor_id, NULL, 16);
2476 id->device_id = g_ascii_strtoull(device_id, NULL, 16);
2478 break;
2480 if (skip) {
2481 continue;
2484 version = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2485 &qga_DEVPKEY_Device_DriverVersion, &cm_type);
2486 if (version == NULL) {
2487 slog("failed to get driver version");
2488 continue;
2490 device->driver_version = g_utf16_to_utf8(version, -1, NULL,
2491 NULL, NULL);
2492 if (device->driver_version == NULL) {
2493 error_setg(errp, "conversion to utf8 failed (driver version)");
2494 return NULL;
2496 device->has_driver_version = true;
2498 date = (LPFILETIME)cm_get_property(dev_info_data.DevInst,
2499 &qga_DEVPKEY_Device_DriverDate, &cm_type);
2500 if (date == NULL) {
2501 slog("failed to get driver date");
2502 continue;
2504 device->driver_date = filetime_to_ns(date);
2505 device->has_driver_date = true;
2507 slog("driver: %s\ndriver version: %" PRId64 ",%s\n",
2508 device->driver_name, device->driver_date,
2509 device->driver_version);
2510 QAPI_LIST_APPEND(tail, g_steal_pointer(&device));
2513 if (dev_info != INVALID_HANDLE_VALUE) {
2514 SetupDiDestroyDeviceInfoList(dev_info);
2516 return head;