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