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