]> git.proxmox.com Git - mirror_qemu.git/blob - qga/commands-win32.c
qga:/qga-win: adding a empty PCI address creation function
[mirror_qemu.git] / qga / commands-win32.c
1 /*
2 * QEMU Guest Agent win32-specific command implementations
3 *
4 * Copyright IBM Corp. 2012
5 *
6 * Authors:
7 * Michael Roth <mdroth@linux.vnet.ibm.com>
8 * Gal Hammer <ghammer@redhat.com>
9 *
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.
12 */
13 #include "qemu/osdep.h"
14
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>
30
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"
40
41 /*
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.
45 */
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
69 );
70 #define CM_Get_DevNode_Property CM_Get_DevNode_PropertyW
71 #pragma GCC diagnostic pop
72 #endif
73
74 #ifndef SHTDN_REASON_FLAG_PLANNED
75 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
76 #endif
77
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))
83
84 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
85
86 struct GuestFileHandle {
87 int64_t id;
88 HANDLE fh;
89 QTAILQ_ENTRY(GuestFileHandle) next;
90 };
91
92 static struct {
93 QTAILQ_HEAD(, GuestFileHandle) filehandles;
94 } guest_file_state = {
95 .filehandles = QTAILQ_HEAD_INITIALIZER(guest_file_state.filehandles),
96 };
97
98 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
99
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 }
120 };
121
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)
127
128 static OpenFlags *find_open_flag(const char *mode_str)
129 {
130 int mode;
131 Error **errp = NULL;
132
133 for (mode = 0; mode < ARRAY_SIZE(guest_file_open_modes); ++mode) {
134 OpenFlags *flags = guest_file_open_modes + mode;
135
136 if (strcmp(flags->forms, mode_str) == 0) {
137 return flags;
138 }
139 }
140
141 error_setg(errp, "invalid file open mode '%s'", mode_str);
142 return NULL;
143 }
144
145 static int64_t guest_file_handle_add(HANDLE fh, Error **errp)
146 {
147 GuestFileHandle *gfh;
148 int64_t handle;
149
150 handle = ga_get_fd_handle(ga_state, errp);
151 if (handle < 0) {
152 return -1;
153 }
154 gfh = g_new0(GuestFileHandle, 1);
155 gfh->id = handle;
156 gfh->fh = fh;
157 QTAILQ_INSERT_TAIL(&guest_file_state.filehandles, gfh, next);
158
159 return handle;
160 }
161
162 GuestFileHandle *guest_file_handle_find(int64_t id, Error **errp)
163 {
164 GuestFileHandle *gfh;
165 QTAILQ_FOREACH(gfh, &guest_file_state.filehandles, next) {
166 if (gfh->id == id) {
167 return gfh;
168 }
169 }
170 error_setg(errp, "handle '%" PRId64 "' has not been found", id);
171 return NULL;
172 }
173
174 static void handle_set_nonblocking(HANDLE fh)
175 {
176 DWORD file_type, pipe_state;
177 file_type = GetFileType(fh);
178 if (file_type != FILE_TYPE_PIPE) {
179 return;
180 }
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;
186 }
187 /* The fd is named pipe fd */
188 if (pipe_state & PIPE_NOWAIT) {
189 return;
190 }
191
192 pipe_state |= PIPE_NOWAIT;
193 SetNamedPipeHandleState(fh, &pipe_state, NULL, NULL);
194 }
195
196 int64_t qmp_guest_file_open(const char *path, const char *mode, Error **errp)
197 {
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;
207
208 if (!mode) {
209 mode = "r";
210 }
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;
216 }
217
218 w_path = g_utf8_to_utf16(path, -1, NULL, NULL, &gerr);
219 if (!w_path) {
220 goto done;
221 }
222
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;
230 }
231
232 /* set fd non-blocking to avoid common use cases (like reading from a
233 * named pipe) from hanging the agent
234 */
235 handle_set_nonblocking(fh);
236
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;
242 }
243
244 slog("guest-file-open, handle: % " PRId64, fd);
245
246 done:
247 if (gerr) {
248 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
249 g_error_free(gerr);
250 }
251 g_free(w_path);
252 return fd;
253 }
254
255 void qmp_guest_file_close(int64_t handle, Error **errp)
256 {
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;
262 }
263 ret = CloseHandle(gfh->fh);
264 if (!ret) {
265 error_setg_win32(errp, GetLastError(), "failed close handle");
266 return;
267 }
268
269 QTAILQ_REMOVE(&guest_file_state.filehandles, gfh, next);
270 g_free(gfh);
271 }
272
273 static void acquire_privilege(const char *name, Error **errp)
274 {
275 HANDLE token = NULL;
276 TOKEN_PRIVILEGES priv;
277
278 if (OpenProcessToken(GetCurrentProcess(),
279 TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &token))
280 {
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;
285 }
286
287 priv.PrivilegeCount = 1;
288 priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
289
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;
294 }
295
296 } else {
297 error_setg(errp, QERR_QGA_COMMAND_FAILED,
298 "failed to open privilege token");
299 }
300
301 out:
302 if (token) {
303 CloseHandle(token);
304 }
305 }
306
307 static void execute_async(DWORD WINAPI (*func)(LPVOID), LPVOID opaque,
308 Error **errp)
309 {
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");
314 }
315 }
316
317 void qmp_guest_shutdown(const char *mode, Error **errp)
318 {
319 Error *local_err = NULL;
320 UINT shutdown_flag = EWX_FORCE;
321
322 slog("guest-shutdown called, mode: %s", mode);
323
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;
334 }
335
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;
342 }
343
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");
348 }
349 }
350
351 GuestFileRead *guest_file_read_unsafe(GuestFileHandle *gfh,
352 int64_t count, Error **errp)
353 {
354 GuestFileRead *read_data = NULL;
355 guchar *buf;
356 HANDLE fh = gfh->fh;
357 bool is_ok;
358 DWORD read_count;
359
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;
369
370 if (read_count != 0) {
371 read_data->buf_b64 = g_base64_encode(buf, read_count);
372 }
373 }
374 g_free(buf);
375
376 return read_data;
377 }
378
379 GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64,
380 bool has_count, int64_t count,
381 Error **errp)
382 {
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;
390
391 if (!gfh) {
392 return NULL;
393 }
394 fh = gfh->fh;
395 buf = qbase64_decode(buf_b64, -1, &buf_len, errp);
396 if (!buf) {
397 return NULL;
398 }
399
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;
406 }
407
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;
415 }
416
417 done:
418 g_free(buf);
419 return write_data;
420 }
421
422 GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset,
423 GuestFileWhence *whence_code,
424 Error **errp)
425 {
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;
434
435 gfh = guest_file_handle_find(handle, errp);
436 if (!gfh) {
437 return NULL;
438 }
439
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;
445 }
446
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;
452 }
453 seek_data = g_new0(GuestFileSeek, 1);
454 seek_data->position = new_pos.QuadPart;
455 return seek_data;
456 }
457
458 void qmp_guest_file_flush(int64_t handle, Error **errp)
459 {
460 HANDLE fh;
461 GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
462 if (!gfh) {
463 return;
464 }
465
466 fh = gfh->fh;
467 if (!FlushFileBuffers(fh)) {
468 error_setg_win32(errp, GetLastError(), "failed to flush file");
469 }
470 }
471
472 static GuestDiskBusType win2qemu[] = {
473 [BusTypeUnknown] = GUEST_DISK_BUS_TYPE_UNKNOWN,
474 [BusTypeScsi] = GUEST_DISK_BUS_TYPE_SCSI,
475 [BusTypeAtapi] = GUEST_DISK_BUS_TYPE_IDE,
476 [BusTypeAta] = GUEST_DISK_BUS_TYPE_IDE,
477 [BusType1394] = GUEST_DISK_BUS_TYPE_IEEE1394,
478 [BusTypeSsa] = GUEST_DISK_BUS_TYPE_SSA,
479 [BusTypeFibre] = GUEST_DISK_BUS_TYPE_SSA,
480 [BusTypeUsb] = GUEST_DISK_BUS_TYPE_USB,
481 [BusTypeRAID] = GUEST_DISK_BUS_TYPE_RAID,
482 [BusTypeiScsi] = GUEST_DISK_BUS_TYPE_ISCSI,
483 [BusTypeSas] = GUEST_DISK_BUS_TYPE_SAS,
484 [BusTypeSata] = GUEST_DISK_BUS_TYPE_SATA,
485 [BusTypeSd] = GUEST_DISK_BUS_TYPE_SD,
486 [BusTypeMmc] = GUEST_DISK_BUS_TYPE_MMC,
487 #if (_WIN32_WINNT >= 0x0601)
488 [BusTypeVirtual] = GUEST_DISK_BUS_TYPE_VIRTUAL,
489 [BusTypeFileBackedVirtual] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL,
490 /*
491 * BusTypeSpaces currently is not suported
492 */
493 [BusTypeSpaces] = GUEST_DISK_BUS_TYPE_UNKNOWN,
494 [BusTypeNvme] = GUEST_DISK_BUS_TYPE_NVME,
495 #endif
496 };
497
498 static GuestDiskBusType find_bus_type(STORAGE_BUS_TYPE bus)
499 {
500 if (bus >= ARRAY_SIZE(win2qemu) || (int)bus < 0) {
501 return GUEST_DISK_BUS_TYPE_UNKNOWN;
502 }
503 return win2qemu[(int)bus];
504 }
505
506 DEFINE_GUID(GUID_DEVINTERFACE_DISK,
507 0x53f56307L, 0xb6bf, 0x11d0, 0x94, 0xf2,
508 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
509 DEFINE_GUID(GUID_DEVINTERFACE_STORAGEPORT,
510 0x2accfe60L, 0xc130, 0x11d2, 0xb0, 0x82,
511 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
512
513 static void get_pci_address_for_device(GuestPCIAddress *pci,
514 HDEVINFO dev_info)
515 {
516 SP_DEVINFO_DATA dev_info_data;
517 DWORD j;
518 DWORD size;
519 bool partial_pci = false;
520
521 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
522
523 for (j = 0;
524 SetupDiEnumDeviceInfo(dev_info, j, &dev_info_data);
525 j++) {
526 DWORD addr, bus, ui_slot, type;
527 int func, slot;
528 size = sizeof(DWORD);
529
530 /*
531 * There is no need to allocate buffer in the next functions. The
532 * size is known and ULONG according to
533 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
534 */
535 if (!SetupDiGetDeviceRegistryProperty(
536 dev_info, &dev_info_data, SPDRP_BUSNUMBER,
537 &type, (PBYTE)&bus, size, NULL)) {
538 debug_error("failed to get PCI bus");
539 bus = -1;
540 partial_pci = true;
541 }
542
543 /*
544 * The function retrieves the device's address. This value will be
545 * transformed into device function and number
546 */
547 if (!SetupDiGetDeviceRegistryProperty(
548 dev_info, &dev_info_data, SPDRP_ADDRESS,
549 &type, (PBYTE)&addr, size, NULL)) {
550 debug_error("failed to get PCI address");
551 addr = -1;
552 partial_pci = true;
553 }
554
555 /*
556 * This call returns UINumber of DEVICE_CAPABILITIES structure.
557 * This number is typically a user-perceived slot number.
558 */
559 if (!SetupDiGetDeviceRegistryProperty(
560 dev_info, &dev_info_data, SPDRP_UI_NUMBER,
561 &type, (PBYTE)&ui_slot, size, NULL)) {
562 debug_error("failed to get PCI slot");
563 ui_slot = -1;
564 partial_pci = true;
565 }
566
567 /*
568 * SetupApi gives us the same information as driver with
569 * IoGetDeviceProperty. According to Microsoft:
570 *
571 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF)
572 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF)
573 * SPDRP_ADDRESS is propertyAddress, so we do the same.
574 *
575 * https://docs.microsoft.com/en-us/windows/desktop/api/setupapi/nf-setupapi-setupdigetdeviceregistrypropertya
576 */
577 if (partial_pci) {
578 pci->domain = -1;
579 pci->slot = -1;
580 pci->function = -1;
581 pci->bus = -1;
582 continue;
583 } else {
584 func = ((int)addr == -1) ? -1 : addr & 0x0000FFFF;
585 slot = ((int)addr == -1) ? -1 : (addr >> 16) & 0x0000FFFF;
586 if ((int)ui_slot != slot) {
587 g_debug("mismatch with reported slot values: %d vs %d",
588 (int)ui_slot, slot);
589 }
590 pci->domain = 0;
591 pci->slot = (int)ui_slot;
592 pci->function = func;
593 pci->bus = (int)bus;
594 return;
595 }
596 }
597 }
598
599 static GuestPCIAddress *get_empty_pci_address(void)
600 {
601 GuestPCIAddress *pci = NULL;
602
603 pci = g_malloc0(sizeof(*pci));
604 pci->domain = -1;
605 pci->slot = -1;
606 pci->function = -1;
607 pci->bus = -1;
608 return pci;
609 }
610
611 static GuestPCIAddress *get_pci_info(int number, Error **errp)
612 {
613 HDEVINFO dev_info = INVALID_HANDLE_VALUE;
614 HDEVINFO parent_dev_info = INVALID_HANDLE_VALUE;
615
616 SP_DEVINFO_DATA dev_info_data;
617 SP_DEVICE_INTERFACE_DATA dev_iface_data;
618 HANDLE dev_file;
619 int i;
620 GuestPCIAddress *pci = get_empty_pci_address();
621
622 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
623 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
624 if (dev_info == INVALID_HANDLE_VALUE) {
625 error_setg_win32(errp, GetLastError(), "failed to get devices tree");
626 goto end;
627 }
628
629 g_debug("enumerating devices");
630 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
631 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
632 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
633 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA pdev_iface_detail_data = NULL;
634 STORAGE_DEVICE_NUMBER sdn;
635 g_autofree char *parent_dev_id = NULL;
636 SP_DEVINFO_DATA parent_dev_info_data;
637 DWORD size = 0;
638
639 g_debug("getting device path");
640 if (SetupDiEnumDeviceInterfaces(dev_info, &dev_info_data,
641 &GUID_DEVINTERFACE_DISK, 0,
642 &dev_iface_data)) {
643 if (!SetupDiGetDeviceInterfaceDetail(dev_info, &dev_iface_data,
644 pdev_iface_detail_data,
645 size, &size,
646 &dev_info_data)) {
647 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
648 pdev_iface_detail_data = g_malloc(size);
649 pdev_iface_detail_data->cbSize =
650 sizeof(*pdev_iface_detail_data);
651 } else {
652 error_setg_win32(errp, GetLastError(),
653 "failed to get device interfaces");
654 goto end;
655 }
656 }
657
658 if (!SetupDiGetDeviceInterfaceDetail(dev_info, &dev_iface_data,
659 pdev_iface_detail_data,
660 size, &size,
661 &dev_info_data)) {
662 // pdev_iface_detail_data already is allocated
663 error_setg_win32(errp, GetLastError(),
664 "failed to get device interfaces");
665 goto end;
666 }
667
668 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
669 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0,
670 NULL);
671
672 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
673 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
674 CloseHandle(dev_file);
675 error_setg_win32(errp, GetLastError(),
676 "failed to get device slot number");
677 goto end;
678 }
679
680 CloseHandle(dev_file);
681 if (sdn.DeviceNumber != number) {
682 continue;
683 }
684 } else {
685 error_setg_win32(errp, GetLastError(),
686 "failed to get device interfaces");
687 goto end;
688 }
689
690 g_debug("found device slot %d. Getting storage controller", number);
691 {
692 CONFIGRET cr;
693 DEVINST dev_inst, parent_dev_inst;
694 ULONG dev_id_size = 0;
695
696 size = 0;
697 if (!SetupDiGetDeviceInstanceId(dev_info, &dev_info_data,
698 parent_dev_id, size, &size)) {
699 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
700 parent_dev_id = g_malloc(size);
701 } else {
702 error_setg_win32(errp, GetLastError(),
703 "failed to get device instance ID");
704 goto end;
705 }
706 }
707
708 if (!SetupDiGetDeviceInstanceId(dev_info, &dev_info_data,
709 parent_dev_id, size, &size)) {
710 // parent_dev_id already is allocated
711 error_setg_win32(errp, GetLastError(),
712 "failed to get device instance ID");
713 goto end;
714 }
715
716 /*
717 * CM API used here as opposed to
718 * SetupDiGetDeviceProperty(..., DEVPKEY_Device_Parent, ...)
719 * which exports are only available in mingw-w64 6+
720 */
721 cr = CM_Locate_DevInst(&dev_inst, parent_dev_id, 0);
722 if (cr != CR_SUCCESS) {
723 g_error("CM_Locate_DevInst failed with code %lx", cr);
724 error_setg_win32(errp, GetLastError(),
725 "failed to get device instance");
726 goto end;
727 }
728 cr = CM_Get_Parent(&parent_dev_inst, dev_inst, 0);
729 if (cr != CR_SUCCESS) {
730 g_error("CM_Get_Parent failed with code %lx", cr);
731 error_setg_win32(errp, GetLastError(),
732 "failed to get parent device instance");
733 goto end;
734 }
735
736 cr = CM_Get_Device_ID_Size(&dev_id_size, parent_dev_inst, 0);
737 if (cr != CR_SUCCESS) {
738 g_error("CM_Get_Device_ID_Size failed with code %lx", cr);
739 error_setg_win32(errp, GetLastError(),
740 "failed to get parent device ID length");
741 goto end;
742 }
743
744 ++dev_id_size;
745 if (dev_id_size > size) {
746 g_free(parent_dev_id);
747 parent_dev_id = g_malloc(dev_id_size);
748 }
749
750 cr = CM_Get_Device_ID(parent_dev_inst, parent_dev_id, dev_id_size,
751 0);
752 if (cr != CR_SUCCESS) {
753 g_error("CM_Get_Device_ID failed with code %lx", cr);
754 error_setg_win32(errp, GetLastError(),
755 "failed to get parent device ID");
756 goto end;
757 }
758 }
759
760 g_debug("querying storage controller %s for PCI information",
761 parent_dev_id);
762 parent_dev_info =
763 SetupDiGetClassDevs(&GUID_DEVINTERFACE_STORAGEPORT, parent_dev_id,
764 NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
765
766 if (parent_dev_info == INVALID_HANDLE_VALUE) {
767 error_setg_win32(errp, GetLastError(),
768 "failed to get parent device");
769 goto end;
770 }
771
772 parent_dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
773 if (!SetupDiEnumDeviceInfo(parent_dev_info, 0, &parent_dev_info_data)) {
774 error_setg_win32(errp, GetLastError(),
775 "failed to get parent device data");
776 goto end;
777 }
778
779 get_pci_address_for_device(pci, parent_dev_info);
780
781 break;
782 }
783
784 end:
785 if (parent_dev_info != INVALID_HANDLE_VALUE) {
786 SetupDiDestroyDeviceInfoList(parent_dev_info);
787 }
788 if (dev_info != INVALID_HANDLE_VALUE) {
789 SetupDiDestroyDeviceInfoList(dev_info);
790 }
791 return pci;
792 }
793
794 static void get_disk_properties(HANDLE vol_h, GuestDiskAddress *disk,
795 Error **errp)
796 {
797 STORAGE_PROPERTY_QUERY query;
798 STORAGE_DEVICE_DESCRIPTOR *dev_desc, buf;
799 DWORD received;
800 ULONG size = sizeof(buf);
801
802 dev_desc = &buf;
803 query.PropertyId = StorageDeviceProperty;
804 query.QueryType = PropertyStandardQuery;
805
806 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
807 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
808 size, &received, NULL)) {
809 error_setg_win32(errp, GetLastError(), "failed to get bus type");
810 return;
811 }
812 disk->bus_type = find_bus_type(dev_desc->BusType);
813 g_debug("bus type %d", disk->bus_type);
814
815 /* Query once more. Now with long enough buffer. */
816 size = dev_desc->Size;
817 dev_desc = g_malloc0(size);
818 if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
819 sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
820 size, &received, NULL)) {
821 error_setg_win32(errp, GetLastError(), "failed to get serial number");
822 g_debug("failed to get serial number");
823 goto out_free;
824 }
825 if (dev_desc->SerialNumberOffset > 0) {
826 const char *serial;
827 size_t len;
828
829 if (dev_desc->SerialNumberOffset >= received) {
830 error_setg(errp, "failed to get serial number: offset outside the buffer");
831 g_debug("serial number offset outside the buffer");
832 goto out_free;
833 }
834 serial = (char *)dev_desc + dev_desc->SerialNumberOffset;
835 len = received - dev_desc->SerialNumberOffset;
836 g_debug("serial number \"%s\"", serial);
837 if (*serial != 0) {
838 disk->serial = g_strndup(serial, len);
839 }
840 }
841 out_free:
842 g_free(dev_desc);
843
844 return;
845 }
846
847 static void get_single_disk_info(int disk_number,
848 GuestDiskAddress *disk, Error **errp)
849 {
850 SCSI_ADDRESS addr, *scsi_ad;
851 DWORD len;
852 HANDLE disk_h;
853 Error *local_err = NULL;
854
855 scsi_ad = &addr;
856
857 g_debug("getting disk info for: %s", disk->dev);
858 disk_h = CreateFile(disk->dev, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
859 0, NULL);
860 if (disk_h == INVALID_HANDLE_VALUE) {
861 error_setg_win32(errp, GetLastError(), "failed to open disk");
862 return;
863 }
864
865 get_disk_properties(disk_h, disk, &local_err);
866 if (local_err) {
867 error_propagate(errp, local_err);
868 goto err_close;
869 }
870
871 g_debug("bus type %d", disk->bus_type);
872 /* always set pci_controller as required by schema. get_pci_info() should
873 * report -1 values for non-PCI buses rather than fail. fail the command
874 * if that doesn't hold since that suggests some other unexpected
875 * breakage
876 */
877 disk->pci_controller = get_pci_info(disk_number, &local_err);
878 if (local_err) {
879 error_propagate(errp, local_err);
880 goto err_close;
881 }
882 if (disk->bus_type == GUEST_DISK_BUS_TYPE_SCSI
883 || disk->bus_type == GUEST_DISK_BUS_TYPE_IDE
884 || disk->bus_type == GUEST_DISK_BUS_TYPE_RAID
885 /* This bus type is not supported before Windows Server 2003 SP1 */
886 || disk->bus_type == GUEST_DISK_BUS_TYPE_SAS
887 ) {
888 /* We are able to use the same ioctls for different bus types
889 * according to Microsoft docs
890 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
891 g_debug("getting SCSI info");
892 if (DeviceIoControl(disk_h, IOCTL_SCSI_GET_ADDRESS, NULL, 0, scsi_ad,
893 sizeof(SCSI_ADDRESS), &len, NULL)) {
894 disk->unit = addr.Lun;
895 disk->target = addr.TargetId;
896 disk->bus = addr.PathId;
897 }
898 /* We do not set error in this case, because we still have enough
899 * information about volume. */
900 }
901
902 err_close:
903 CloseHandle(disk_h);
904 return;
905 }
906
907 /* VSS provider works with volumes, thus there is no difference if
908 * the volume consist of spanned disks. Info about the first disk in the
909 * volume is returned for the spanned disk group (LVM) */
910 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
911 {
912 Error *local_err = NULL;
913 GuestDiskAddressList *list = NULL;
914 GuestDiskAddress *disk = NULL;
915 int i;
916 HANDLE vol_h;
917 DWORD size;
918 PVOLUME_DISK_EXTENTS extents = NULL;
919
920 /* strip final backslash */
921 char *name = g_strdup(guid);
922 if (g_str_has_suffix(name, "\\")) {
923 name[strlen(name) - 1] = 0;
924 }
925
926 g_debug("opening %s", name);
927 vol_h = CreateFile(name, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
928 0, NULL);
929 if (vol_h == INVALID_HANDLE_VALUE) {
930 error_setg_win32(errp, GetLastError(), "failed to open volume");
931 goto out;
932 }
933
934 /* Get list of extents */
935 g_debug("getting disk extents");
936 size = sizeof(VOLUME_DISK_EXTENTS);
937 extents = g_malloc0(size);
938 if (!DeviceIoControl(vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
939 0, extents, size, &size, NULL)) {
940 DWORD last_err = GetLastError();
941 if (last_err == ERROR_MORE_DATA) {
942 /* Try once more with big enough buffer */
943 g_free(extents);
944 extents = g_malloc0(size);
945 if (!DeviceIoControl(
946 vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
947 0, extents, size, NULL, NULL)) {
948 error_setg_win32(errp, GetLastError(),
949 "failed to get disk extents");
950 goto out;
951 }
952 } else if (last_err == ERROR_INVALID_FUNCTION) {
953 /* Possibly CD-ROM or a shared drive. Try to pass the volume */
954 g_debug("volume not on disk");
955 disk = g_new0(GuestDiskAddress, 1);
956 disk->dev = g_strdup(name);
957 get_single_disk_info(0xffffffff, disk, &local_err);
958 if (local_err) {
959 g_debug("failed to get disk info, ignoring error: %s",
960 error_get_pretty(local_err));
961 error_free(local_err);
962 goto out;
963 }
964 QAPI_LIST_PREPEND(list, disk);
965 disk = NULL;
966 goto out;
967 } else {
968 error_setg_win32(errp, GetLastError(),
969 "failed to get disk extents");
970 goto out;
971 }
972 }
973 g_debug("Number of extents: %lu", extents->NumberOfDiskExtents);
974
975 /* Go through each extent */
976 for (i = 0; i < extents->NumberOfDiskExtents; i++) {
977 disk = g_new0(GuestDiskAddress, 1);
978
979 /* Disk numbers directly correspond to numbers used in UNCs
980 *
981 * See documentation for DISK_EXTENT:
982 * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
983 *
984 * See also Naming Files, Paths and Namespaces:
985 * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
986 */
987 disk->dev = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
988 extents->Extents[i].DiskNumber);
989
990 get_single_disk_info(extents->Extents[i].DiskNumber, disk, &local_err);
991 if (local_err) {
992 error_propagate(errp, local_err);
993 goto out;
994 }
995 QAPI_LIST_PREPEND(list, disk);
996 disk = NULL;
997 }
998
999
1000 out:
1001 if (vol_h != INVALID_HANDLE_VALUE) {
1002 CloseHandle(vol_h);
1003 }
1004 qapi_free_GuestDiskAddress(disk);
1005 g_free(extents);
1006 g_free(name);
1007
1008 return list;
1009 }
1010
1011 GuestDiskInfoList *qmp_guest_get_disks(Error **errp)
1012 {
1013 GuestDiskInfoList *ret = NULL;
1014 HDEVINFO dev_info;
1015 SP_DEVICE_INTERFACE_DATA dev_iface_data;
1016 int i;
1017
1018 dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
1019 DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
1020 if (dev_info == INVALID_HANDLE_VALUE) {
1021 error_setg_win32(errp, GetLastError(), "failed to get device tree");
1022 return NULL;
1023 }
1024
1025 g_debug("enumerating devices");
1026 dev_iface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
1027 for (i = 0;
1028 SetupDiEnumDeviceInterfaces(dev_info, NULL, &GUID_DEVINTERFACE_DISK,
1029 i, &dev_iface_data);
1030 i++) {
1031 GuestDiskAddress *address = NULL;
1032 GuestDiskInfo *disk = NULL;
1033 Error *local_err = NULL;
1034 g_autofree PSP_DEVICE_INTERFACE_DETAIL_DATA
1035 pdev_iface_detail_data = NULL;
1036 STORAGE_DEVICE_NUMBER sdn;
1037 HANDLE dev_file;
1038 DWORD size = 0;
1039 BOOL result;
1040 int attempt;
1041
1042 g_debug(" getting device path");
1043 for (attempt = 0, result = FALSE; attempt < 2 && !result; attempt++) {
1044 result = SetupDiGetDeviceInterfaceDetail(dev_info,
1045 &dev_iface_data, pdev_iface_detail_data, size, &size, NULL);
1046 if (result) {
1047 break;
1048 }
1049 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
1050 pdev_iface_detail_data = g_realloc(pdev_iface_detail_data,
1051 size);
1052 pdev_iface_detail_data->cbSize =
1053 sizeof(*pdev_iface_detail_data);
1054 } else {
1055 g_debug("failed to get device interface details");
1056 break;
1057 }
1058 }
1059 if (!result) {
1060 g_debug("skipping device");
1061 continue;
1062 }
1063
1064 g_debug(" device: %s", pdev_iface_detail_data->DevicePath);
1065 dev_file = CreateFile(pdev_iface_detail_data->DevicePath, 0,
1066 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
1067 if (!DeviceIoControl(dev_file, IOCTL_STORAGE_GET_DEVICE_NUMBER,
1068 NULL, 0, &sdn, sizeof(sdn), &size, NULL)) {
1069 CloseHandle(dev_file);
1070 debug_error("failed to get storage device number");
1071 continue;
1072 }
1073 CloseHandle(dev_file);
1074
1075 disk = g_new0(GuestDiskInfo, 1);
1076 disk->name = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
1077 sdn.DeviceNumber);
1078
1079 g_debug(" number: %lu", sdn.DeviceNumber);
1080 address = g_new0(GuestDiskAddress, 1);
1081 address->dev = g_strdup(disk->name);
1082 get_single_disk_info(sdn.DeviceNumber, address, &local_err);
1083 if (local_err) {
1084 g_debug("failed to get disk info: %s",
1085 error_get_pretty(local_err));
1086 error_free(local_err);
1087 qapi_free_GuestDiskAddress(address);
1088 address = NULL;
1089 } else {
1090 disk->address = address;
1091 }
1092
1093 QAPI_LIST_PREPEND(ret, disk);
1094 }
1095
1096 SetupDiDestroyDeviceInfoList(dev_info);
1097 return ret;
1098 }
1099
1100 static GuestFilesystemInfo *build_guest_fsinfo(char *guid, Error **errp)
1101 {
1102 DWORD info_size;
1103 char mnt, *mnt_point;
1104 wchar_t wfs_name[32];
1105 char fs_name[32];
1106 wchar_t vol_info[MAX_PATH + 1];
1107 size_t len;
1108 uint64_t i64FreeBytesToCaller, i64TotalBytes, i64FreeBytes;
1109 GuestFilesystemInfo *fs = NULL;
1110 HANDLE hLocalDiskHandle = INVALID_HANDLE_VALUE;
1111
1112 GetVolumePathNamesForVolumeName(guid, (LPCH)&mnt, 0, &info_size);
1113 if (GetLastError() != ERROR_MORE_DATA) {
1114 error_setg_win32(errp, GetLastError(), "failed to get volume name");
1115 return NULL;
1116 }
1117
1118 mnt_point = g_malloc(info_size + 1);
1119 if (!GetVolumePathNamesForVolumeName(guid, mnt_point, info_size,
1120 &info_size)) {
1121 error_setg_win32(errp, GetLastError(), "failed to get volume name");
1122 goto free;
1123 }
1124
1125 hLocalDiskHandle = CreateFile(guid, 0 , 0, NULL, OPEN_EXISTING,
1126 FILE_ATTRIBUTE_NORMAL |
1127 FILE_FLAG_BACKUP_SEMANTICS, NULL);
1128 if (INVALID_HANDLE_VALUE == hLocalDiskHandle) {
1129 error_setg_win32(errp, GetLastError(), "failed to get handle for volume");
1130 goto free;
1131 }
1132
1133 len = strlen(mnt_point);
1134 mnt_point[len] = '\\';
1135 mnt_point[len + 1] = 0;
1136
1137 if (!GetVolumeInformationByHandleW(hLocalDiskHandle, vol_info,
1138 sizeof(vol_info), NULL, NULL, NULL,
1139 (LPWSTR) & wfs_name, sizeof(wfs_name))) {
1140 if (GetLastError() != ERROR_NOT_READY) {
1141 error_setg_win32(errp, GetLastError(), "failed to get volume info");
1142 }
1143 goto free;
1144 }
1145
1146 fs = g_malloc(sizeof(*fs));
1147 fs->name = g_strdup(guid);
1148 fs->has_total_bytes = false;
1149 fs->has_used_bytes = false;
1150 if (len == 0) {
1151 fs->mountpoint = g_strdup("System Reserved");
1152 } else {
1153 fs->mountpoint = g_strndup(mnt_point, len);
1154 if (GetDiskFreeSpaceEx(fs->mountpoint,
1155 (PULARGE_INTEGER) & i64FreeBytesToCaller,
1156 (PULARGE_INTEGER) & i64TotalBytes,
1157 (PULARGE_INTEGER) & i64FreeBytes)) {
1158 fs->used_bytes = i64TotalBytes - i64FreeBytes;
1159 fs->total_bytes = i64TotalBytes;
1160 fs->has_total_bytes = true;
1161 fs->has_used_bytes = true;
1162 }
1163 }
1164 wcstombs(fs_name, wfs_name, sizeof(wfs_name));
1165 fs->type = g_strdup(fs_name);
1166 fs->disk = build_guest_disk_info(guid, errp);
1167 free:
1168 if (hLocalDiskHandle != INVALID_HANDLE_VALUE) {
1169 CloseHandle(hLocalDiskHandle);
1170 }
1171 g_free(mnt_point);
1172 return fs;
1173 }
1174
1175 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
1176 {
1177 HANDLE vol_h;
1178 GuestFilesystemInfoList *ret = NULL;
1179 char guid[256];
1180
1181 vol_h = FindFirstVolume(guid, sizeof(guid));
1182 if (vol_h == INVALID_HANDLE_VALUE) {
1183 error_setg_win32(errp, GetLastError(), "failed to find any volume");
1184 return NULL;
1185 }
1186
1187 do {
1188 Error *local_err = NULL;
1189 GuestFilesystemInfo *info = build_guest_fsinfo(guid, &local_err);
1190 if (local_err) {
1191 g_debug("failed to get filesystem info, ignoring error: %s",
1192 error_get_pretty(local_err));
1193 error_free(local_err);
1194 continue;
1195 }
1196 QAPI_LIST_PREPEND(ret, info);
1197 } while (FindNextVolume(vol_h, guid, sizeof(guid)));
1198
1199 if (GetLastError() != ERROR_NO_MORE_FILES) {
1200 error_setg_win32(errp, GetLastError(), "failed to find next volume");
1201 }
1202
1203 FindVolumeClose(vol_h);
1204 return ret;
1205 }
1206
1207 /*
1208 * Return status of freeze/thaw
1209 */
1210 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
1211 {
1212 if (!vss_initialized()) {
1213 error_setg(errp, QERR_UNSUPPORTED);
1214 return 0;
1215 }
1216
1217 if (ga_is_frozen(ga_state)) {
1218 return GUEST_FSFREEZE_STATUS_FROZEN;
1219 }
1220
1221 return GUEST_FSFREEZE_STATUS_THAWED;
1222 }
1223
1224 /*
1225 * Freeze local file systems using Volume Shadow-copy Service.
1226 * The frozen state is limited for up to 10 seconds by VSS.
1227 */
1228 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
1229 {
1230 return qmp_guest_fsfreeze_freeze_list(false, NULL, errp);
1231 }
1232
1233 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
1234 strList *mountpoints,
1235 Error **errp)
1236 {
1237 int i;
1238 Error *local_err = NULL;
1239
1240 if (!vss_initialized()) {
1241 error_setg(errp, QERR_UNSUPPORTED);
1242 return 0;
1243 }
1244
1245 slog("guest-fsfreeze called");
1246
1247 /* cannot risk guest agent blocking itself on a write in this state */
1248 ga_set_frozen(ga_state);
1249
1250 qga_vss_fsfreeze(&i, true, mountpoints, &local_err);
1251 if (local_err) {
1252 error_propagate(errp, local_err);
1253 goto error;
1254 }
1255
1256 return i;
1257
1258 error:
1259 local_err = NULL;
1260 qmp_guest_fsfreeze_thaw(&local_err);
1261 if (local_err) {
1262 g_debug("cleanup thaw: %s", error_get_pretty(local_err));
1263 error_free(local_err);
1264 }
1265 return 0;
1266 }
1267
1268 /*
1269 * Thaw local file systems using Volume Shadow-copy Service.
1270 */
1271 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1272 {
1273 int i;
1274
1275 if (!vss_initialized()) {
1276 error_setg(errp, QERR_UNSUPPORTED);
1277 return 0;
1278 }
1279
1280 qga_vss_fsfreeze(&i, false, NULL, errp);
1281
1282 ga_unset_frozen(ga_state);
1283 return i;
1284 }
1285
1286 static void guest_fsfreeze_cleanup(void)
1287 {
1288 Error *err = NULL;
1289
1290 if (!vss_initialized()) {
1291 return;
1292 }
1293
1294 if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1295 qmp_guest_fsfreeze_thaw(&err);
1296 if (err) {
1297 slog("failed to clean up frozen filesystems: %s",
1298 error_get_pretty(err));
1299 error_free(err);
1300 }
1301 }
1302
1303 vss_deinit(true);
1304 }
1305
1306 /*
1307 * Walk list of mounted file systems in the guest, and discard unused
1308 * areas.
1309 */
1310 GuestFilesystemTrimResponse *
1311 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1312 {
1313 GuestFilesystemTrimResponse *resp;
1314 HANDLE handle;
1315 WCHAR guid[MAX_PATH] = L"";
1316 OSVERSIONINFO osvi;
1317 BOOL win8_or_later;
1318
1319 ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
1320 osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1321 GetVersionEx(&osvi);
1322 win8_or_later = (osvi.dwMajorVersion > 6 ||
1323 ((osvi.dwMajorVersion == 6) &&
1324 (osvi.dwMinorVersion >= 2)));
1325 if (!win8_or_later) {
1326 error_setg(errp, "fstrim is only supported for Win8+");
1327 return NULL;
1328 }
1329
1330 handle = FindFirstVolumeW(guid, ARRAYSIZE(guid));
1331 if (handle == INVALID_HANDLE_VALUE) {
1332 error_setg_win32(errp, GetLastError(), "failed to find any volume");
1333 return NULL;
1334 }
1335
1336 resp = g_new0(GuestFilesystemTrimResponse, 1);
1337
1338 do {
1339 GuestFilesystemTrimResult *res;
1340 PWCHAR uc_path;
1341 DWORD char_count = 0;
1342 char *path, *out;
1343 GError *gerr = NULL;
1344 gchar *argv[4];
1345
1346 GetVolumePathNamesForVolumeNameW(guid, NULL, 0, &char_count);
1347
1348 if (GetLastError() != ERROR_MORE_DATA) {
1349 continue;
1350 }
1351 if (GetDriveTypeW(guid) != DRIVE_FIXED) {
1352 continue;
1353 }
1354
1355 uc_path = g_new(WCHAR, char_count);
1356 if (!GetVolumePathNamesForVolumeNameW(guid, uc_path, char_count,
1357 &char_count) || !*uc_path) {
1358 /* strange, but this condition could be faced even with size == 2 */
1359 g_free(uc_path);
1360 continue;
1361 }
1362
1363 res = g_new0(GuestFilesystemTrimResult, 1);
1364
1365 path = g_utf16_to_utf8(uc_path, char_count, NULL, NULL, &gerr);
1366
1367 g_free(uc_path);
1368
1369 if (!path) {
1370 res->error = g_strdup(gerr->message);
1371 g_error_free(gerr);
1372 break;
1373 }
1374
1375 res->path = path;
1376
1377 QAPI_LIST_PREPEND(resp->paths, res);
1378
1379 memset(argv, 0, sizeof(argv));
1380 argv[0] = (gchar *)"defrag.exe";
1381 argv[1] = (gchar *)"/L";
1382 argv[2] = path;
1383
1384 if (!g_spawn_sync(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL,
1385 &out /* stdout */, NULL /* stdin */,
1386 NULL, &gerr)) {
1387 res->error = g_strdup(gerr->message);
1388 g_error_free(gerr);
1389 } else {
1390 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1391 Error is reported in the output with something like
1392 (x89000020) etc code in the stdout */
1393
1394 int i;
1395 gchar **lines = g_strsplit(out, "\r\n", 0);
1396 g_free(out);
1397
1398 for (i = 0; lines[i] != NULL; i++) {
1399 if (g_strstr_len(lines[i], -1, "(0x") == NULL) {
1400 continue;
1401 }
1402 res->error = g_strdup(lines[i]);
1403 break;
1404 }
1405 g_strfreev(lines);
1406 }
1407 } while (FindNextVolumeW(handle, guid, ARRAYSIZE(guid)));
1408
1409 FindVolumeClose(handle);
1410 return resp;
1411 }
1412
1413 typedef enum {
1414 GUEST_SUSPEND_MODE_DISK,
1415 GUEST_SUSPEND_MODE_RAM
1416 } GuestSuspendMode;
1417
1418 static void check_suspend_mode(GuestSuspendMode mode, Error **errp)
1419 {
1420 SYSTEM_POWER_CAPABILITIES sys_pwr_caps;
1421
1422 ZeroMemory(&sys_pwr_caps, sizeof(sys_pwr_caps));
1423 if (!GetPwrCapabilities(&sys_pwr_caps)) {
1424 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1425 "failed to determine guest suspend capabilities");
1426 return;
1427 }
1428
1429 switch (mode) {
1430 case GUEST_SUSPEND_MODE_DISK:
1431 if (!sys_pwr_caps.SystemS4) {
1432 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1433 "suspend-to-disk not supported by OS");
1434 }
1435 break;
1436 case GUEST_SUSPEND_MODE_RAM:
1437 if (!sys_pwr_caps.SystemS3) {
1438 error_setg(errp, QERR_QGA_COMMAND_FAILED,
1439 "suspend-to-ram not supported by OS");
1440 }
1441 break;
1442 default:
1443 abort();
1444 }
1445 }
1446
1447 static DWORD WINAPI do_suspend(LPVOID opaque)
1448 {
1449 GuestSuspendMode *mode = opaque;
1450 DWORD ret = 0;
1451
1452 if (!SetSuspendState(*mode == GUEST_SUSPEND_MODE_DISK, TRUE, TRUE)) {
1453 g_autofree gchar *emsg = g_win32_error_message(GetLastError());
1454 slog("failed to suspend guest: %s", emsg);
1455 ret = -1;
1456 }
1457 g_free(mode);
1458 return ret;
1459 }
1460
1461 void qmp_guest_suspend_disk(Error **errp)
1462 {
1463 Error *local_err = NULL;
1464 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1465
1466 *mode = GUEST_SUSPEND_MODE_DISK;
1467 check_suspend_mode(*mode, &local_err);
1468 if (local_err) {
1469 goto out;
1470 }
1471 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1472 if (local_err) {
1473 goto out;
1474 }
1475 execute_async(do_suspend, mode, &local_err);
1476
1477 out:
1478 if (local_err) {
1479 error_propagate(errp, local_err);
1480 g_free(mode);
1481 }
1482 }
1483
1484 void qmp_guest_suspend_ram(Error **errp)
1485 {
1486 Error *local_err = NULL;
1487 GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1488
1489 *mode = GUEST_SUSPEND_MODE_RAM;
1490 check_suspend_mode(*mode, &local_err);
1491 if (local_err) {
1492 goto out;
1493 }
1494 acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1495 if (local_err) {
1496 goto out;
1497 }
1498 execute_async(do_suspend, mode, &local_err);
1499
1500 out:
1501 if (local_err) {
1502 error_propagate(errp, local_err);
1503 g_free(mode);
1504 }
1505 }
1506
1507 void qmp_guest_suspend_hybrid(Error **errp)
1508 {
1509 error_setg(errp, QERR_UNSUPPORTED);
1510 }
1511
1512 static IP_ADAPTER_ADDRESSES *guest_get_adapters_addresses(Error **errp)
1513 {
1514 IP_ADAPTER_ADDRESSES *adptr_addrs = NULL;
1515 ULONG adptr_addrs_len = 0;
1516 DWORD ret;
1517
1518 /* Call the first time to get the adptr_addrs_len. */
1519 GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1520 NULL, adptr_addrs, &adptr_addrs_len);
1521
1522 adptr_addrs = g_malloc(adptr_addrs_len);
1523 ret = GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1524 NULL, adptr_addrs, &adptr_addrs_len);
1525 if (ret != ERROR_SUCCESS) {
1526 error_setg_win32(errp, ret, "failed to get adapters addresses");
1527 g_free(adptr_addrs);
1528 adptr_addrs = NULL;
1529 }
1530 return adptr_addrs;
1531 }
1532
1533 static char *guest_wctomb_dup(WCHAR *wstr)
1534 {
1535 char *str;
1536 size_t str_size;
1537
1538 str_size = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, NULL, 0, NULL, NULL);
1539 /* add 1 to str_size for NULL terminator */
1540 str = g_malloc(str_size + 1);
1541 WideCharToMultiByte(CP_UTF8, 0, wstr, -1, str, str_size, NULL, NULL);
1542 return str;
1543 }
1544
1545 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS *ip_addr,
1546 Error **errp)
1547 {
1548 char addr_str[INET6_ADDRSTRLEN + INET_ADDRSTRLEN];
1549 DWORD len;
1550 int ret;
1551
1552 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET ||
1553 ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1554 len = sizeof(addr_str);
1555 ret = WSAAddressToString(ip_addr->Address.lpSockaddr,
1556 ip_addr->Address.iSockaddrLength,
1557 NULL,
1558 addr_str,
1559 &len);
1560 if (ret != 0) {
1561 error_setg_win32(errp, WSAGetLastError(),
1562 "failed address presentation form conversion");
1563 return NULL;
1564 }
1565 return g_strdup(addr_str);
1566 }
1567 return NULL;
1568 }
1569
1570 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS *ip_addr)
1571 {
1572 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1573 * field to obtain the prefix.
1574 */
1575 return ip_addr->OnLinkPrefixLength;
1576 }
1577
1578 #define INTERFACE_PATH_BUF_SZ 512
1579
1580 static DWORD get_interface_index(const char *guid)
1581 {
1582 ULONG index;
1583 DWORD status;
1584 wchar_t wbuf[INTERFACE_PATH_BUF_SZ];
1585 snwprintf(wbuf, INTERFACE_PATH_BUF_SZ, L"\\device\\tcpip_%s", guid);
1586 wbuf[INTERFACE_PATH_BUF_SZ - 1] = 0;
1587 status = GetAdapterIndex (wbuf, &index);
1588 if (status != NO_ERROR) {
1589 return (DWORD)~0;
1590 } else {
1591 return index;
1592 }
1593 }
1594
1595 typedef NETIOAPI_API (WINAPI *GetIfEntry2Func)(PMIB_IF_ROW2 Row);
1596
1597 static int guest_get_network_stats(const char *name,
1598 GuestNetworkInterfaceStat *stats)
1599 {
1600 OSVERSIONINFO os_ver;
1601
1602 os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1603 GetVersionEx(&os_ver);
1604 if (os_ver.dwMajorVersion >= 6) {
1605 MIB_IF_ROW2 a_mid_ifrow;
1606 GetIfEntry2Func getifentry2_ex;
1607 DWORD if_index = 0;
1608 HMODULE module = GetModuleHandle("iphlpapi");
1609 PVOID func = GetProcAddress(module, "GetIfEntry2");
1610
1611 if (func == NULL) {
1612 return -1;
1613 }
1614
1615 getifentry2_ex = (GetIfEntry2Func)func;
1616 if_index = get_interface_index(name);
1617 if (if_index == (DWORD)~0) {
1618 return -1;
1619 }
1620
1621 memset(&a_mid_ifrow, 0, sizeof(a_mid_ifrow));
1622 a_mid_ifrow.InterfaceIndex = if_index;
1623 if (NO_ERROR == getifentry2_ex(&a_mid_ifrow)) {
1624 stats->rx_bytes = a_mid_ifrow.InOctets;
1625 stats->rx_packets = a_mid_ifrow.InUcastPkts;
1626 stats->rx_errs = a_mid_ifrow.InErrors;
1627 stats->rx_dropped = a_mid_ifrow.InDiscards;
1628 stats->tx_bytes = a_mid_ifrow.OutOctets;
1629 stats->tx_packets = a_mid_ifrow.OutUcastPkts;
1630 stats->tx_errs = a_mid_ifrow.OutErrors;
1631 stats->tx_dropped = a_mid_ifrow.OutDiscards;
1632 return 0;
1633 }
1634 }
1635 return -1;
1636 }
1637
1638 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
1639 {
1640 IP_ADAPTER_ADDRESSES *adptr_addrs, *addr;
1641 IP_ADAPTER_UNICAST_ADDRESS *ip_addr = NULL;
1642 GuestNetworkInterfaceList *head = NULL, **tail = &head;
1643 GuestIpAddressList *head_addr, **tail_addr;
1644 GuestNetworkInterface *info;
1645 GuestNetworkInterfaceStat *interface_stat = NULL;
1646 GuestIpAddress *address_item = NULL;
1647 unsigned char *mac_addr;
1648 char *addr_str;
1649 WORD wsa_version;
1650 WSADATA wsa_data;
1651 int ret;
1652
1653 adptr_addrs = guest_get_adapters_addresses(errp);
1654 if (adptr_addrs == NULL) {
1655 return NULL;
1656 }
1657
1658 /* Make WSA APIs available. */
1659 wsa_version = MAKEWORD(2, 2);
1660 ret = WSAStartup(wsa_version, &wsa_data);
1661 if (ret != 0) {
1662 error_setg_win32(errp, ret, "failed socket startup");
1663 goto out;
1664 }
1665
1666 for (addr = adptr_addrs; addr; addr = addr->Next) {
1667 info = g_malloc0(sizeof(*info));
1668
1669 QAPI_LIST_APPEND(tail, info);
1670
1671 info->name = guest_wctomb_dup(addr->FriendlyName);
1672
1673 if (addr->PhysicalAddressLength != 0) {
1674 mac_addr = addr->PhysicalAddress;
1675
1676 info->hardware_address =
1677 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1678 (int) mac_addr[0], (int) mac_addr[1],
1679 (int) mac_addr[2], (int) mac_addr[3],
1680 (int) mac_addr[4], (int) mac_addr[5]);
1681 }
1682
1683 head_addr = NULL;
1684 tail_addr = &head_addr;
1685 for (ip_addr = addr->FirstUnicastAddress;
1686 ip_addr;
1687 ip_addr = ip_addr->Next) {
1688 addr_str = guest_addr_to_str(ip_addr, errp);
1689 if (addr_str == NULL) {
1690 continue;
1691 }
1692
1693 address_item = g_malloc0(sizeof(*address_item));
1694
1695 QAPI_LIST_APPEND(tail_addr, address_item);
1696
1697 address_item->ip_address = addr_str;
1698 address_item->prefix = guest_ip_prefix(ip_addr);
1699 if (ip_addr->Address.lpSockaddr->sa_family == AF_INET) {
1700 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV4;
1701 } else if (ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1702 address_item->ip_address_type = GUEST_IP_ADDRESS_TYPE_IPV6;
1703 }
1704 }
1705 if (head_addr) {
1706 info->has_ip_addresses = true;
1707 info->ip_addresses = head_addr;
1708 }
1709 if (!info->statistics) {
1710 interface_stat = g_malloc0(sizeof(*interface_stat));
1711 if (guest_get_network_stats(addr->AdapterName, interface_stat)
1712 == -1) {
1713 g_free(interface_stat);
1714 } else {
1715 info->statistics = interface_stat;
1716 }
1717 }
1718 }
1719 WSACleanup();
1720 out:
1721 g_free(adptr_addrs);
1722 return head;
1723 }
1724
1725 static int64_t filetime_to_ns(const FILETIME *tf)
1726 {
1727 return ((((int64_t)tf->dwHighDateTime << 32) | tf->dwLowDateTime)
1728 - W32_FT_OFFSET) * 100;
1729 }
1730
1731 void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
1732 {
1733 Error *local_err = NULL;
1734 SYSTEMTIME ts;
1735 FILETIME tf;
1736 LONGLONG time;
1737
1738 if (!has_time) {
1739 /* Unfortunately, Windows libraries don't provide an easy way to access
1740 * RTC yet:
1741 *
1742 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1743 *
1744 * Instead, a workaround is to use the Windows win32tm command to
1745 * resync the time using the Windows Time service.
1746 */
1747 LPVOID msg_buffer;
1748 DWORD ret_flags;
1749
1750 HRESULT hr = system("w32tm /resync /nowait");
1751
1752 if (GetLastError() != 0) {
1753 strerror_s((LPTSTR) & msg_buffer, 0, errno);
1754 error_setg(errp, "system(...) failed: %s", (LPCTSTR)msg_buffer);
1755 } else if (hr != 0) {
1756 if (hr == HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)) {
1757 error_setg(errp, "Windows Time service not running on the "
1758 "guest");
1759 } else {
1760 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
1761 FORMAT_MESSAGE_FROM_SYSTEM |
1762 FORMAT_MESSAGE_IGNORE_INSERTS, NULL,
1763 (DWORD)hr, MAKELANGID(LANG_NEUTRAL,
1764 SUBLANG_DEFAULT), (LPTSTR) & msg_buffer, 0,
1765 NULL)) {
1766 error_setg(errp, "w32tm failed with error (0x%lx), couldn'"
1767 "t retrieve error message", hr);
1768 } else {
1769 error_setg(errp, "w32tm failed with error (0x%lx): %s", hr,
1770 (LPCTSTR)msg_buffer);
1771 LocalFree(msg_buffer);
1772 }
1773 }
1774 } else if (!InternetGetConnectedState(&ret_flags, 0)) {
1775 error_setg(errp, "No internet connection on guest, sync not "
1776 "accurate");
1777 }
1778 return;
1779 }
1780
1781 /* Validate time passed by user. */
1782 if (time_ns < 0 || time_ns / 100 > INT64_MAX - W32_FT_OFFSET) {
1783 error_setg(errp, "Time %" PRId64 "is invalid", time_ns);
1784 return;
1785 }
1786
1787 time = time_ns / 100 + W32_FT_OFFSET;
1788
1789 tf.dwLowDateTime = (DWORD) time;
1790 tf.dwHighDateTime = (DWORD) (time >> 32);
1791
1792 if (!FileTimeToSystemTime(&tf, &ts)) {
1793 error_setg(errp, "Failed to convert system time %d",
1794 (int)GetLastError());
1795 return;
1796 }
1797
1798 acquire_privilege(SE_SYSTEMTIME_NAME, &local_err);
1799 if (local_err) {
1800 error_propagate(errp, local_err);
1801 return;
1802 }
1803
1804 if (!SetSystemTime(&ts)) {
1805 error_setg(errp, "Failed to set time to guest: %d", (int)GetLastError());
1806 return;
1807 }
1808 }
1809
1810 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
1811 {
1812 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi, ptr;
1813 DWORD length;
1814 GuestLogicalProcessorList *head, **tail;
1815 Error *local_err = NULL;
1816 int64_t current;
1817
1818 ptr = pslpi = NULL;
1819 length = 0;
1820 current = 0;
1821 head = NULL;
1822 tail = &head;
1823
1824 if ((GetLogicalProcessorInformation(pslpi, &length) == FALSE) &&
1825 (GetLastError() == ERROR_INSUFFICIENT_BUFFER) &&
1826 (length > sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION))) {
1827 ptr = pslpi = g_malloc0(length);
1828 if (GetLogicalProcessorInformation(pslpi, &length) == FALSE) {
1829 error_setg(&local_err, "Failed to get processor information: %d",
1830 (int)GetLastError());
1831 }
1832 } else {
1833 error_setg(&local_err,
1834 "Failed to get processor information buffer length: %d",
1835 (int)GetLastError());
1836 }
1837
1838 while ((local_err == NULL) && (length > 0)) {
1839 if (pslpi->Relationship == RelationProcessorCore) {
1840 ULONG_PTR cpu_bits = pslpi->ProcessorMask;
1841
1842 while (cpu_bits > 0) {
1843 if (!!(cpu_bits & 1)) {
1844 GuestLogicalProcessor *vcpu;
1845
1846 vcpu = g_malloc0(sizeof *vcpu);
1847 vcpu->logical_id = current++;
1848 vcpu->online = true;
1849 vcpu->has_can_offline = true;
1850
1851 QAPI_LIST_APPEND(tail, vcpu);
1852 }
1853 cpu_bits >>= 1;
1854 }
1855 }
1856 length -= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION);
1857 pslpi++; /* next entry */
1858 }
1859
1860 g_free(ptr);
1861
1862 if (local_err == NULL) {
1863 if (head != NULL) {
1864 return head;
1865 }
1866 /* there's no guest with zero VCPUs */
1867 error_setg(&local_err, "Guest reported zero VCPUs");
1868 }
1869
1870 qapi_free_GuestLogicalProcessorList(head);
1871 error_propagate(errp, local_err);
1872 return NULL;
1873 }
1874
1875 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
1876 {
1877 error_setg(errp, QERR_UNSUPPORTED);
1878 return -1;
1879 }
1880
1881 static gchar *
1882 get_net_error_message(gint error)
1883 {
1884 HMODULE module = NULL;
1885 gchar *retval = NULL;
1886 wchar_t *msg = NULL;
1887 int flags;
1888 size_t nchars;
1889
1890 flags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
1891 FORMAT_MESSAGE_IGNORE_INSERTS |
1892 FORMAT_MESSAGE_FROM_SYSTEM;
1893
1894 if (error >= NERR_BASE && error <= MAX_NERR) {
1895 module = LoadLibraryExW(L"netmsg.dll", NULL, LOAD_LIBRARY_AS_DATAFILE);
1896
1897 if (module != NULL) {
1898 flags |= FORMAT_MESSAGE_FROM_HMODULE;
1899 }
1900 }
1901
1902 FormatMessageW(flags, module, error, 0, (LPWSTR)&msg, 0, NULL);
1903
1904 if (msg != NULL) {
1905 nchars = wcslen(msg);
1906
1907 if (nchars >= 2 &&
1908 msg[nchars - 1] == L'\n' &&
1909 msg[nchars - 2] == L'\r') {
1910 msg[nchars - 2] = L'\0';
1911 }
1912
1913 retval = g_utf16_to_utf8(msg, -1, NULL, NULL, NULL);
1914
1915 LocalFree(msg);
1916 }
1917
1918 if (module != NULL) {
1919 FreeLibrary(module);
1920 }
1921
1922 return retval;
1923 }
1924
1925 void qmp_guest_set_user_password(const char *username,
1926 const char *password,
1927 bool crypted,
1928 Error **errp)
1929 {
1930 NET_API_STATUS nas;
1931 char *rawpasswddata = NULL;
1932 size_t rawpasswdlen;
1933 wchar_t *user = NULL, *wpass = NULL;
1934 USER_INFO_1003 pi1003 = { 0, };
1935 GError *gerr = NULL;
1936
1937 if (crypted) {
1938 error_setg(errp, QERR_UNSUPPORTED);
1939 return;
1940 }
1941
1942 rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
1943 if (!rawpasswddata) {
1944 return;
1945 }
1946 rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
1947 rawpasswddata[rawpasswdlen] = '\0';
1948
1949 user = g_utf8_to_utf16(username, -1, NULL, NULL, &gerr);
1950 if (!user) {
1951 goto done;
1952 }
1953
1954 wpass = g_utf8_to_utf16(rawpasswddata, -1, NULL, NULL, &gerr);
1955 if (!wpass) {
1956 goto done;
1957 }
1958
1959 pi1003.usri1003_password = wpass;
1960 nas = NetUserSetInfo(NULL, user,
1961 1003, (LPBYTE)&pi1003,
1962 NULL);
1963
1964 if (nas != NERR_Success) {
1965 gchar *msg = get_net_error_message(nas);
1966 error_setg(errp, "failed to set password: %s", msg);
1967 g_free(msg);
1968 }
1969
1970 done:
1971 if (gerr) {
1972 error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
1973 g_error_free(gerr);
1974 }
1975 g_free(user);
1976 g_free(wpass);
1977 g_free(rawpasswddata);
1978 }
1979
1980 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
1981 {
1982 error_setg(errp, QERR_UNSUPPORTED);
1983 return NULL;
1984 }
1985
1986 GuestMemoryBlockResponseList *
1987 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
1988 {
1989 error_setg(errp, QERR_UNSUPPORTED);
1990 return NULL;
1991 }
1992
1993 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
1994 {
1995 error_setg(errp, QERR_UNSUPPORTED);
1996 return NULL;
1997 }
1998
1999 /* add unsupported commands to the list of blocked RPCs */
2000 GList *ga_command_init_blockedrpcs(GList *blockedrpcs)
2001 {
2002 const char *list_unsupported[] = {
2003 "guest-suspend-hybrid",
2004 "guest-set-vcpus",
2005 "guest-get-memory-blocks", "guest-set-memory-blocks",
2006 "guest-get-memory-block-size", "guest-get-memory-block-info",
2007 NULL};
2008 char **p = (char **)list_unsupported;
2009
2010 while (*p) {
2011 blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
2012 }
2013
2014 if (!vss_init(true)) {
2015 g_debug("vss_init failed, vss commands are going to be disabled");
2016 const char *list[] = {
2017 "guest-get-fsinfo", "guest-fsfreeze-status",
2018 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL};
2019 p = (char **)list;
2020
2021 while (*p) {
2022 blockedrpcs = g_list_append(blockedrpcs, g_strdup(*p++));
2023 }
2024 }
2025
2026 return blockedrpcs;
2027 }
2028
2029 /* register init/cleanup routines for stateful command groups */
2030 void ga_command_state_init(GAState *s, GACommandState *cs)
2031 {
2032 if (!vss_initialized()) {
2033 ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
2034 }
2035 }
2036
2037 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
2038 typedef struct _GA_WTSINFOA {
2039 WTS_CONNECTSTATE_CLASS State;
2040 DWORD SessionId;
2041 DWORD IncomingBytes;
2042 DWORD OutgoingBytes;
2043 DWORD IncomingFrames;
2044 DWORD OutgoingFrames;
2045 DWORD IncomingCompressedBytes;
2046 DWORD OutgoingCompressedBy;
2047 CHAR WinStationName[WINSTATIONNAME_LENGTH];
2048 CHAR Domain[DOMAIN_LENGTH];
2049 CHAR UserName[USERNAME_LENGTH + 1];
2050 LARGE_INTEGER ConnectTime;
2051 LARGE_INTEGER DisconnectTime;
2052 LARGE_INTEGER LastInputTime;
2053 LARGE_INTEGER LogonTime;
2054 LARGE_INTEGER CurrentTime;
2055
2056 } GA_WTSINFOA;
2057
2058 GuestUserList *qmp_guest_get_users(Error **errp)
2059 {
2060 #define QGA_NANOSECONDS 10000000
2061
2062 GHashTable *cache = NULL;
2063 GuestUserList *head = NULL, **tail = &head;
2064
2065 DWORD buffer_size = 0, count = 0, i = 0;
2066 GA_WTSINFOA *info = NULL;
2067 WTS_SESSION_INFOA *entries = NULL;
2068 GuestUser *user = NULL;
2069 gpointer value = NULL;
2070 INT64 login = 0;
2071 double login_time = 0;
2072
2073 cache = g_hash_table_new(g_str_hash, g_str_equal);
2074
2075 if (WTSEnumerateSessionsA(NULL, 0, 1, &entries, &count)) {
2076 for (i = 0; i < count; ++i) {
2077 buffer_size = 0;
2078 info = NULL;
2079 if (WTSQuerySessionInformationA(
2080 NULL,
2081 entries[i].SessionId,
2082 WTSSessionInfo,
2083 (LPSTR *)&info,
2084 &buffer_size
2085 )) {
2086
2087 if (strlen(info->UserName) == 0) {
2088 WTSFreeMemory(info);
2089 continue;
2090 }
2091
2092 login = info->LogonTime.QuadPart;
2093 login -= W32_FT_OFFSET;
2094 login_time = ((double)login) / QGA_NANOSECONDS;
2095
2096 if (g_hash_table_contains(cache, info->UserName)) {
2097 value = g_hash_table_lookup(cache, info->UserName);
2098 user = (GuestUser *)value;
2099 if (user->login_time > login_time) {
2100 user->login_time = login_time;
2101 }
2102 } else {
2103 user = g_new0(GuestUser, 1);
2104
2105 user->user = g_strdup(info->UserName);
2106 user->domain = g_strdup(info->Domain);
2107
2108 user->login_time = login_time;
2109
2110 g_hash_table_add(cache, user->user);
2111
2112 QAPI_LIST_APPEND(tail, user);
2113 }
2114 }
2115 WTSFreeMemory(info);
2116 }
2117 WTSFreeMemory(entries);
2118 }
2119 g_hash_table_destroy(cache);
2120 return head;
2121 }
2122
2123 typedef struct _ga_matrix_lookup_t {
2124 int major;
2125 int minor;
2126 char const *version;
2127 char const *version_id;
2128 } ga_matrix_lookup_t;
2129
2130 static ga_matrix_lookup_t const WIN_VERSION_MATRIX[2][7] = {
2131 {
2132 /* Desktop editions */
2133 { 5, 0, "Microsoft Windows 2000", "2000"},
2134 { 5, 1, "Microsoft Windows XP", "xp"},
2135 { 6, 0, "Microsoft Windows Vista", "vista"},
2136 { 6, 1, "Microsoft Windows 7" "7"},
2137 { 6, 2, "Microsoft Windows 8", "8"},
2138 { 6, 3, "Microsoft Windows 8.1", "8.1"},
2139 { 0, 0, 0}
2140 },{
2141 /* Server editions */
2142 { 5, 2, "Microsoft Windows Server 2003", "2003"},
2143 { 6, 0, "Microsoft Windows Server 2008", "2008"},
2144 { 6, 1, "Microsoft Windows Server 2008 R2", "2008r2"},
2145 { 6, 2, "Microsoft Windows Server 2012", "2012"},
2146 { 6, 3, "Microsoft Windows Server 2012 R2", "2012r2"},
2147 { 0, 0, 0},
2148 { 0, 0, 0}
2149 }
2150 };
2151
2152 typedef struct _ga_win_10_0_t {
2153 int first_build;
2154 char const *version;
2155 char const *version_id;
2156 } ga_win_10_0_t;
2157
2158 static ga_win_10_0_t const WIN_10_0_SERVER_VERSION_MATRIX[4] = {
2159 {14393, "Microsoft Windows Server 2016", "2016"},
2160 {17763, "Microsoft Windows Server 2019", "2019"},
2161 {20344, "Microsoft Windows Server 2022", "2022"},
2162 {0, 0}
2163 };
2164
2165 static ga_win_10_0_t const WIN_10_0_CLIENT_VERSION_MATRIX[3] = {
2166 {10240, "Microsoft Windows 10", "10"},
2167 {22000, "Microsoft Windows 11", "11"},
2168 {0, 0}
2169 };
2170
2171 static void ga_get_win_version(RTL_OSVERSIONINFOEXW *info, Error **errp)
2172 {
2173 typedef NTSTATUS(WINAPI *rtl_get_version_t)(
2174 RTL_OSVERSIONINFOEXW *os_version_info_ex);
2175
2176 info->dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
2177
2178 HMODULE module = GetModuleHandle("ntdll");
2179 PVOID fun = GetProcAddress(module, "RtlGetVersion");
2180 if (fun == NULL) {
2181 error_setg(errp, QERR_QGA_COMMAND_FAILED,
2182 "Failed to get address of RtlGetVersion");
2183 return;
2184 }
2185
2186 rtl_get_version_t rtl_get_version = (rtl_get_version_t)fun;
2187 rtl_get_version(info);
2188 return;
2189 }
2190
2191 static char *ga_get_win_name(OSVERSIONINFOEXW const *os_version, bool id)
2192 {
2193 DWORD major = os_version->dwMajorVersion;
2194 DWORD minor = os_version->dwMinorVersion;
2195 DWORD build = os_version->dwBuildNumber;
2196 int tbl_idx = (os_version->wProductType != VER_NT_WORKSTATION);
2197 ga_matrix_lookup_t const *table = WIN_VERSION_MATRIX[tbl_idx];
2198 ga_win_10_0_t const *win_10_0_table = tbl_idx ?
2199 WIN_10_0_SERVER_VERSION_MATRIX : WIN_10_0_CLIENT_VERSION_MATRIX;
2200 ga_win_10_0_t const *win_10_0_version = NULL;
2201 while (table->version != NULL) {
2202 if (major == 10 && minor == 0) {
2203 while (win_10_0_table->version != NULL) {
2204 if (build >= win_10_0_table->first_build) {
2205 win_10_0_version = win_10_0_table;
2206 }
2207 win_10_0_table++;
2208 }
2209 if (win_10_0_table) {
2210 if (id) {
2211 return g_strdup(win_10_0_version->version_id);
2212 } else {
2213 return g_strdup(win_10_0_version->version);
2214 }
2215 }
2216 } else if (major == table->major && minor == table->minor) {
2217 if (id) {
2218 return g_strdup(table->version_id);
2219 } else {
2220 return g_strdup(table->version);
2221 }
2222 }
2223 ++table;
2224 }
2225 slog("failed to lookup Windows version: major=%lu, minor=%lu",
2226 major, minor);
2227 return g_strdup("N/A");
2228 }
2229
2230 static char *ga_get_win_product_name(Error **errp)
2231 {
2232 HKEY key = INVALID_HANDLE_VALUE;
2233 DWORD size = 128;
2234 char *result = g_malloc0(size);
2235 LONG err = ERROR_SUCCESS;
2236
2237 err = RegOpenKeyA(HKEY_LOCAL_MACHINE,
2238 "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2239 &key);
2240 if (err != ERROR_SUCCESS) {
2241 error_setg_win32(errp, err, "failed to open registry key");
2242 g_free(result);
2243 return NULL;
2244 }
2245
2246 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2247 (LPBYTE)result, &size);
2248 if (err == ERROR_MORE_DATA) {
2249 slog("ProductName longer than expected (%lu bytes), retrying",
2250 size);
2251 g_free(result);
2252 result = NULL;
2253 if (size > 0) {
2254 result = g_malloc0(size);
2255 err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2256 (LPBYTE)result, &size);
2257 }
2258 }
2259 if (err != ERROR_SUCCESS) {
2260 error_setg_win32(errp, err, "failed to retrive ProductName");
2261 goto fail;
2262 }
2263
2264 RegCloseKey(key);
2265 return result;
2266
2267 fail:
2268 if (key != INVALID_HANDLE_VALUE) {
2269 RegCloseKey(key);
2270 }
2271 g_free(result);
2272 return NULL;
2273 }
2274
2275 static char *ga_get_current_arch(void)
2276 {
2277 SYSTEM_INFO info;
2278 GetNativeSystemInfo(&info);
2279 char *result = NULL;
2280 switch (info.wProcessorArchitecture) {
2281 case PROCESSOR_ARCHITECTURE_AMD64:
2282 result = g_strdup("x86_64");
2283 break;
2284 case PROCESSOR_ARCHITECTURE_ARM:
2285 result = g_strdup("arm");
2286 break;
2287 case PROCESSOR_ARCHITECTURE_IA64:
2288 result = g_strdup("ia64");
2289 break;
2290 case PROCESSOR_ARCHITECTURE_INTEL:
2291 result = g_strdup("x86");
2292 break;
2293 case PROCESSOR_ARCHITECTURE_UNKNOWN:
2294 default:
2295 slog("unknown processor architecture 0x%0x",
2296 info.wProcessorArchitecture);
2297 result = g_strdup("unknown");
2298 break;
2299 }
2300 return result;
2301 }
2302
2303 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
2304 {
2305 Error *local_err = NULL;
2306 OSVERSIONINFOEXW os_version = {0};
2307 bool server;
2308 char *product_name;
2309 GuestOSInfo *info;
2310
2311 ga_get_win_version(&os_version, &local_err);
2312 if (local_err) {
2313 error_propagate(errp, local_err);
2314 return NULL;
2315 }
2316
2317 server = os_version.wProductType != VER_NT_WORKSTATION;
2318 product_name = ga_get_win_product_name(errp);
2319 if (product_name == NULL) {
2320 return NULL;
2321 }
2322
2323 info = g_new0(GuestOSInfo, 1);
2324
2325 info->kernel_version = g_strdup_printf("%lu.%lu",
2326 os_version.dwMajorVersion,
2327 os_version.dwMinorVersion);
2328 info->kernel_release = g_strdup_printf("%lu",
2329 os_version.dwBuildNumber);
2330 info->machine = ga_get_current_arch();
2331
2332 info->id = g_strdup("mswindows");
2333 info->name = g_strdup("Microsoft Windows");
2334 info->pretty_name = product_name;
2335 info->version = ga_get_win_name(&os_version, false);
2336 info->version_id = ga_get_win_name(&os_version, true);
2337 info->variant = g_strdup(server ? "server" : "client");
2338 info->variant_id = g_strdup(server ? "server" : "client");
2339
2340 return info;
2341 }
2342
2343 /*
2344 * Safely get device property. Returned strings are using wide characters.
2345 * Caller is responsible for freeing the buffer.
2346 */
2347 static LPBYTE cm_get_property(DEVINST devInst, const DEVPROPKEY *propName,
2348 PDEVPROPTYPE propType)
2349 {
2350 CONFIGRET cr;
2351 g_autofree LPBYTE buffer = NULL;
2352 ULONG buffer_len = 0;
2353
2354 /* First query for needed space */
2355 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2356 buffer, &buffer_len, 0);
2357 if (cr != CR_SUCCESS && cr != CR_BUFFER_SMALL) {
2358
2359 slog("failed to get property size, error=0x%lx", cr);
2360 return NULL;
2361 }
2362 buffer = g_new0(BYTE, buffer_len + 1);
2363 cr = CM_Get_DevNode_PropertyW(devInst, propName, propType,
2364 buffer, &buffer_len, 0);
2365 if (cr != CR_SUCCESS) {
2366 slog("failed to get device property, error=0x%lx", cr);
2367 return NULL;
2368 }
2369 return g_steal_pointer(&buffer);
2370 }
2371
2372 static GStrv ga_get_hardware_ids(DEVINST devInstance)
2373 {
2374 GArray *values = NULL;
2375 DEVPROPTYPE cm_type;
2376 LPWSTR id;
2377 g_autofree LPWSTR property = (LPWSTR)cm_get_property(devInstance,
2378 &qga_DEVPKEY_Device_HardwareIds, &cm_type);
2379 if (property == NULL) {
2380 slog("failed to get hardware IDs");
2381 return NULL;
2382 }
2383 if (*property == '\0') {
2384 /* empty list */
2385 return NULL;
2386 }
2387 values = g_array_new(TRUE, TRUE, sizeof(gchar *));
2388 for (id = property; '\0' != *id; id += lstrlenW(id) + 1) {
2389 gchar *id8 = g_utf16_to_utf8(id, -1, NULL, NULL, NULL);
2390 g_array_append_val(values, id8);
2391 }
2392 return (GStrv)g_array_free(values, FALSE);
2393 }
2394
2395 /*
2396 * https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
2397 */
2398 #define DEVICE_PCI_RE "PCI\\\\VEN_(1AF4|1B36)&DEV_([0-9A-B]{4})(&|$)"
2399
2400 GuestDeviceInfoList *qmp_guest_get_devices(Error **errp)
2401 {
2402 GuestDeviceInfoList *head = NULL, **tail = &head;
2403 HDEVINFO dev_info = INVALID_HANDLE_VALUE;
2404 SP_DEVINFO_DATA dev_info_data;
2405 int i, j;
2406 GError *gerr = NULL;
2407 g_autoptr(GRegex) device_pci_re = NULL;
2408 DEVPROPTYPE cm_type;
2409
2410 device_pci_re = g_regex_new(DEVICE_PCI_RE,
2411 G_REGEX_ANCHORED | G_REGEX_OPTIMIZE, 0,
2412 &gerr);
2413 g_assert(device_pci_re != NULL);
2414
2415 dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
2416 dev_info = SetupDiGetClassDevs(0, 0, 0, DIGCF_PRESENT | DIGCF_ALLCLASSES);
2417 if (dev_info == INVALID_HANDLE_VALUE) {
2418 error_setg(errp, "failed to get device tree");
2419 return NULL;
2420 }
2421
2422 slog("enumerating devices");
2423 for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
2424 bool skip = true;
2425 g_autofree LPWSTR name = NULL;
2426 g_autofree LPFILETIME date = NULL;
2427 g_autofree LPWSTR version = NULL;
2428 g_auto(GStrv) hw_ids = NULL;
2429 g_autoptr(GuestDeviceInfo) device = g_new0(GuestDeviceInfo, 1);
2430 g_autofree char *vendor_id = NULL;
2431 g_autofree char *device_id = NULL;
2432
2433 name = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2434 &qga_DEVPKEY_NAME, &cm_type);
2435 if (name == NULL) {
2436 slog("failed to get device description");
2437 continue;
2438 }
2439 device->driver_name = g_utf16_to_utf8(name, -1, NULL, NULL, NULL);
2440 if (device->driver_name == NULL) {
2441 error_setg(errp, "conversion to utf8 failed (driver name)");
2442 return NULL;
2443 }
2444 slog("querying device: %s", device->driver_name);
2445 hw_ids = ga_get_hardware_ids(dev_info_data.DevInst);
2446 if (hw_ids == NULL) {
2447 continue;
2448 }
2449 for (j = 0; hw_ids[j] != NULL; j++) {
2450 g_autoptr(GMatchInfo) match_info;
2451 GuestDeviceIdPCI *id;
2452 if (!g_regex_match(device_pci_re, hw_ids[j], 0, &match_info)) {
2453 continue;
2454 }
2455 skip = false;
2456
2457 vendor_id = g_match_info_fetch(match_info, 1);
2458 device_id = g_match_info_fetch(match_info, 2);
2459
2460 device->id = g_new0(GuestDeviceId, 1);
2461 device->id->type = GUEST_DEVICE_TYPE_PCI;
2462 id = &device->id->u.pci;
2463 id->vendor_id = g_ascii_strtoull(vendor_id, NULL, 16);
2464 id->device_id = g_ascii_strtoull(device_id, NULL, 16);
2465
2466 break;
2467 }
2468 if (skip) {
2469 continue;
2470 }
2471
2472 version = (LPWSTR)cm_get_property(dev_info_data.DevInst,
2473 &qga_DEVPKEY_Device_DriverVersion, &cm_type);
2474 if (version == NULL) {
2475 slog("failed to get driver version");
2476 continue;
2477 }
2478 device->driver_version = g_utf16_to_utf8(version, -1, NULL,
2479 NULL, NULL);
2480 if (device->driver_version == NULL) {
2481 error_setg(errp, "conversion to utf8 failed (driver version)");
2482 return NULL;
2483 }
2484
2485 date = (LPFILETIME)cm_get_property(dev_info_data.DevInst,
2486 &qga_DEVPKEY_Device_DriverDate, &cm_type);
2487 if (date == NULL) {
2488 slog("failed to get driver date");
2489 continue;
2490 }
2491 device->driver_date = filetime_to_ns(date);
2492 device->has_driver_date = true;
2493
2494 slog("driver: %s\ndriver version: %" PRId64 ",%s\n",
2495 device->driver_name, device->driver_date,
2496 device->driver_version);
2497 QAPI_LIST_APPEND(tail, g_steal_pointer(&device));
2498 }
2499
2500 if (dev_info != INVALID_HANDLE_VALUE) {
2501 SetupDiDestroyDeviceInfoList(dev_info);
2502 }
2503 return head;
2504 }
2505
2506 char *qga_get_host_name(Error **errp)
2507 {
2508 wchar_t tmp[MAX_COMPUTERNAME_LENGTH + 1];
2509 DWORD size = G_N_ELEMENTS(tmp);
2510
2511 if (GetComputerNameW(tmp, &size) == 0) {
2512 error_setg_win32(errp, GetLastError(), "failed close handle");
2513 return NULL;
2514 }
2515
2516 return g_utf16_to_utf8(tmp, size, NULL, NULL, NULL);
2517 }
2518
2519 GuestDiskStatsInfoList *qmp_guest_get_diskstats(Error **errp)
2520 {
2521 error_setg(errp, QERR_UNSUPPORTED);
2522 return NULL;
2523 }
2524
2525 GuestCpuStatsList *qmp_guest_get_cpustats(Error **errp)
2526 {
2527 error_setg(errp, QERR_UNSUPPORTED);
2528 return NULL;
2529 }