xref: /openbmc/qemu/qga/commands-win32.c (revision 438c78da)
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 
14 #ifndef _WIN32_WINNT
15 #   define _WIN32_WINNT 0x0600
16 #endif
17 
18 #include "qemu/osdep.h"
19 #include <wtypes.h>
20 #include <powrprof.h>
21 #include <winsock2.h>
22 #include <ws2tcpip.h>
23 #include <iptypes.h>
24 #include <iphlpapi.h>
25 #ifdef CONFIG_QGA_NTDDSCSI
26 #include <winioctl.h>
27 #include <ntddscsi.h>
28 #include <setupapi.h>
29 #include <initguid.h>
30 #endif
31 #include <lm.h>
32 #include <wtsapi32.h>
33 #include <wininet.h>
34 
35 #include "guest-agent-core.h"
36 #include "vss-win32.h"
37 #include "qga-qapi-commands.h"
38 #include "qapi/error.h"
39 #include "qapi/qmp/qerror.h"
40 #include "qemu/queue.h"
41 #include "qemu/host-utils.h"
42 #include "qemu/base64.h"
43 
44 #ifndef SHTDN_REASON_FLAG_PLANNED
45 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
46 #endif
47 
48 /* multiple of 100 nanoseconds elapsed between windows baseline
49  *    (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
50 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
51                        (365 * (1970 - 1601) +       \
52                         (1970 - 1601) / 4 - 3))
53 
54 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
55 
56 typedef struct GuestFileHandle {
57     int64_t id;
58     HANDLE fh;
59     QTAILQ_ENTRY(GuestFileHandle) next;
60 } GuestFileHandle;
61 
62 static struct {
63     QTAILQ_HEAD(, GuestFileHandle) filehandles;
64 } guest_file_state = {
65     .filehandles = QTAILQ_HEAD_INITIALIZER(guest_file_state.filehandles),
66 };
67 
68 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
69 
70 typedef struct OpenFlags {
71     const char *forms;
72     DWORD desired_access;
73     DWORD creation_disposition;
74 } OpenFlags;
75 static OpenFlags guest_file_open_modes[] = {
76     {"r",   GENERIC_READ,                     OPEN_EXISTING},
77     {"rb",  GENERIC_READ,                     OPEN_EXISTING},
78     {"w",   GENERIC_WRITE,                    CREATE_ALWAYS},
79     {"wb",  GENERIC_WRITE,                    CREATE_ALWAYS},
80     {"a",   FILE_GENERIC_APPEND,              OPEN_ALWAYS  },
81     {"r+",  GENERIC_WRITE|GENERIC_READ,       OPEN_EXISTING},
82     {"rb+", GENERIC_WRITE|GENERIC_READ,       OPEN_EXISTING},
83     {"r+b", GENERIC_WRITE|GENERIC_READ,       OPEN_EXISTING},
84     {"w+",  GENERIC_WRITE|GENERIC_READ,       CREATE_ALWAYS},
85     {"wb+", GENERIC_WRITE|GENERIC_READ,       CREATE_ALWAYS},
86     {"w+b", GENERIC_WRITE|GENERIC_READ,       CREATE_ALWAYS},
87     {"a+",  FILE_GENERIC_APPEND|GENERIC_READ, OPEN_ALWAYS  },
88     {"ab+", FILE_GENERIC_APPEND|GENERIC_READ, OPEN_ALWAYS  },
89     {"a+b", FILE_GENERIC_APPEND|GENERIC_READ, OPEN_ALWAYS  }
90 };
91 
92 #define debug_error(msg) do { \
93     char *suffix = g_win32_error_message(GetLastError()); \
94     g_debug("%s: %s", (msg), suffix); \
95     g_free(suffix); \
96 } while (0)
97 
98 static OpenFlags *find_open_flag(const char *mode_str)
99 {
100     int mode;
101     Error **errp = NULL;
102 
103     for (mode = 0; mode < ARRAY_SIZE(guest_file_open_modes); ++mode) {
104         OpenFlags *flags = guest_file_open_modes + mode;
105 
106         if (strcmp(flags->forms, mode_str) == 0) {
107             return flags;
108         }
109     }
110 
111     error_setg(errp, "invalid file open mode '%s'", mode_str);
112     return NULL;
113 }
114 
115 static int64_t guest_file_handle_add(HANDLE fh, Error **errp)
116 {
117     GuestFileHandle *gfh;
118     int64_t handle;
119 
120     handle = ga_get_fd_handle(ga_state, errp);
121     if (handle < 0) {
122         return -1;
123     }
124     gfh = g_new0(GuestFileHandle, 1);
125     gfh->id = handle;
126     gfh->fh = fh;
127     QTAILQ_INSERT_TAIL(&guest_file_state.filehandles, gfh, next);
128 
129     return handle;
130 }
131 
132 static GuestFileHandle *guest_file_handle_find(int64_t id, Error **errp)
133 {
134     GuestFileHandle *gfh;
135     QTAILQ_FOREACH(gfh, &guest_file_state.filehandles, next) {
136         if (gfh->id == id) {
137             return gfh;
138         }
139     }
140     error_setg(errp, "handle '%" PRId64 "' has not been found", id);
141     return NULL;
142 }
143 
144 static void handle_set_nonblocking(HANDLE fh)
145 {
146     DWORD file_type, pipe_state;
147     file_type = GetFileType(fh);
148     if (file_type != FILE_TYPE_PIPE) {
149         return;
150     }
151     /* If file_type == FILE_TYPE_PIPE, according to MSDN
152      * the specified file is socket or named pipe */
153     if (!GetNamedPipeHandleState(fh, &pipe_state, NULL,
154                                  NULL, NULL, NULL, 0)) {
155         return;
156     }
157     /* The fd is named pipe fd */
158     if (pipe_state & PIPE_NOWAIT) {
159         return;
160     }
161 
162     pipe_state |= PIPE_NOWAIT;
163     SetNamedPipeHandleState(fh, &pipe_state, NULL, NULL);
164 }
165 
166 int64_t qmp_guest_file_open(const char *path, bool has_mode,
167                             const char *mode, Error **errp)
168 {
169     int64_t fd = -1;
170     HANDLE fh;
171     HANDLE templ_file = NULL;
172     DWORD share_mode = FILE_SHARE_READ;
173     DWORD flags_and_attr = FILE_ATTRIBUTE_NORMAL;
174     LPSECURITY_ATTRIBUTES sa_attr = NULL;
175     OpenFlags *guest_flags;
176     GError *gerr = NULL;
177     wchar_t *w_path = NULL;
178 
179     if (!has_mode) {
180         mode = "r";
181     }
182     slog("guest-file-open called, filepath: %s, mode: %s", path, mode);
183     guest_flags = find_open_flag(mode);
184     if (guest_flags == NULL) {
185         error_setg(errp, "invalid file open mode");
186         goto done;
187     }
188 
189     w_path = g_utf8_to_utf16(path, -1, NULL, NULL, &gerr);
190     if (!w_path) {
191         goto done;
192     }
193 
194     fh = CreateFileW(w_path, guest_flags->desired_access, share_mode, sa_attr,
195                     guest_flags->creation_disposition, flags_and_attr,
196                     templ_file);
197     if (fh == INVALID_HANDLE_VALUE) {
198         error_setg_win32(errp, GetLastError(), "failed to open file '%s'",
199                          path);
200         goto done;
201     }
202 
203     /* set fd non-blocking to avoid common use cases (like reading from a
204      * named pipe) from hanging the agent
205      */
206     handle_set_nonblocking(fh);
207 
208     fd = guest_file_handle_add(fh, errp);
209     if (fd < 0) {
210         CloseHandle(fh);
211         error_setg(errp, "failed to add handle to qmp handle table");
212         goto done;
213     }
214 
215     slog("guest-file-open, handle: % " PRId64, fd);
216 
217 done:
218     if (gerr) {
219         error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
220         g_error_free(gerr);
221     }
222     g_free(w_path);
223     return fd;
224 }
225 
226 void qmp_guest_file_close(int64_t handle, Error **errp)
227 {
228     bool ret;
229     GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
230     slog("guest-file-close called, handle: %" PRId64, handle);
231     if (gfh == NULL) {
232         return;
233     }
234     ret = CloseHandle(gfh->fh);
235     if (!ret) {
236         error_setg_win32(errp, GetLastError(), "failed close handle");
237         return;
238     }
239 
240     QTAILQ_REMOVE(&guest_file_state.filehandles, gfh, next);
241     g_free(gfh);
242 }
243 
244 static void acquire_privilege(const char *name, Error **errp)
245 {
246     HANDLE token = NULL;
247     TOKEN_PRIVILEGES priv;
248     Error *local_err = NULL;
249 
250     if (OpenProcessToken(GetCurrentProcess(),
251         TOKEN_ADJUST_PRIVILEGES|TOKEN_QUERY, &token))
252     {
253         if (!LookupPrivilegeValue(NULL, name, &priv.Privileges[0].Luid)) {
254             error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
255                        "no luid for requested privilege");
256             goto out;
257         }
258 
259         priv.PrivilegeCount = 1;
260         priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
261 
262         if (!AdjustTokenPrivileges(token, FALSE, &priv, 0, NULL, 0)) {
263             error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
264                        "unable to acquire requested privilege");
265             goto out;
266         }
267 
268     } else {
269         error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
270                    "failed to open privilege token");
271     }
272 
273 out:
274     if (token) {
275         CloseHandle(token);
276     }
277     error_propagate(errp, local_err);
278 }
279 
280 static void execute_async(DWORD WINAPI (*func)(LPVOID), LPVOID opaque,
281                           Error **errp)
282 {
283     Error *local_err = NULL;
284 
285     HANDLE thread = CreateThread(NULL, 0, func, opaque, 0, NULL);
286     if (!thread) {
287         error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
288                    "failed to dispatch asynchronous command");
289         error_propagate(errp, local_err);
290     }
291 }
292 
293 void qmp_guest_shutdown(bool has_mode, const char *mode, Error **errp)
294 {
295     Error *local_err = NULL;
296     UINT shutdown_flag = EWX_FORCE;
297 
298     slog("guest-shutdown called, mode: %s", mode);
299 
300     if (!has_mode || strcmp(mode, "powerdown") == 0) {
301         shutdown_flag |= EWX_POWEROFF;
302     } else if (strcmp(mode, "halt") == 0) {
303         shutdown_flag |= EWX_SHUTDOWN;
304     } else if (strcmp(mode, "reboot") == 0) {
305         shutdown_flag |= EWX_REBOOT;
306     } else {
307         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "mode",
308                    "halt|powerdown|reboot");
309         return;
310     }
311 
312     /* Request a shutdown privilege, but try to shut down the system
313        anyway. */
314     acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
315     if (local_err) {
316         error_propagate(errp, local_err);
317         return;
318     }
319 
320     if (!ExitWindowsEx(shutdown_flag, SHTDN_REASON_FLAG_PLANNED)) {
321         slog("guest-shutdown failed: %lu", GetLastError());
322         error_setg(errp, QERR_UNDEFINED_ERROR);
323     }
324 }
325 
326 GuestFileRead *qmp_guest_file_read(int64_t handle, bool has_count,
327                                    int64_t count, Error **errp)
328 {
329     GuestFileRead *read_data = NULL;
330     guchar *buf;
331     HANDLE fh;
332     bool is_ok;
333     DWORD read_count;
334     GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
335 
336     if (!gfh) {
337         return NULL;
338     }
339     if (!has_count) {
340         count = QGA_READ_COUNT_DEFAULT;
341     } else if (count < 0 || count >= UINT32_MAX) {
342         error_setg(errp, "value '%" PRId64
343                    "' is invalid for argument count", count);
344         return NULL;
345     }
346 
347     fh = gfh->fh;
348     buf = g_malloc0(count+1);
349     is_ok = ReadFile(fh, buf, count, &read_count, NULL);
350     if (!is_ok) {
351         error_setg_win32(errp, GetLastError(), "failed to read file");
352         slog("guest-file-read failed, handle %" PRId64, handle);
353     } else {
354         buf[read_count] = 0;
355         read_data = g_new0(GuestFileRead, 1);
356         read_data->count = (size_t)read_count;
357         read_data->eof = read_count == 0;
358 
359         if (read_count != 0) {
360             read_data->buf_b64 = g_base64_encode(buf, read_count);
361         }
362     }
363     g_free(buf);
364 
365     return read_data;
366 }
367 
368 GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64,
369                                      bool has_count, int64_t count,
370                                      Error **errp)
371 {
372     GuestFileWrite *write_data = NULL;
373     guchar *buf;
374     gsize buf_len;
375     bool is_ok;
376     DWORD write_count;
377     GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
378     HANDLE fh;
379 
380     if (!gfh) {
381         return NULL;
382     }
383     fh = gfh->fh;
384     buf = qbase64_decode(buf_b64, -1, &buf_len, errp);
385     if (!buf) {
386         return NULL;
387     }
388 
389     if (!has_count) {
390         count = buf_len;
391     } else if (count < 0 || count > buf_len) {
392         error_setg(errp, "value '%" PRId64
393                    "' is invalid for argument count", count);
394         goto done;
395     }
396 
397     is_ok = WriteFile(fh, buf, count, &write_count, NULL);
398     if (!is_ok) {
399         error_setg_win32(errp, GetLastError(), "failed to write to file");
400         slog("guest-file-write-failed, handle: %" PRId64, handle);
401     } else {
402         write_data = g_new0(GuestFileWrite, 1);
403         write_data->count = (size_t) write_count;
404     }
405 
406 done:
407     g_free(buf);
408     return write_data;
409 }
410 
411 GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset,
412                                    GuestFileWhence *whence_code,
413                                    Error **errp)
414 {
415     GuestFileHandle *gfh;
416     GuestFileSeek *seek_data;
417     HANDLE fh;
418     LARGE_INTEGER new_pos, off_pos;
419     off_pos.QuadPart = offset;
420     BOOL res;
421     int whence;
422     Error *err = NULL;
423 
424     gfh = guest_file_handle_find(handle, errp);
425     if (!gfh) {
426         return NULL;
427     }
428 
429     /* We stupidly exposed 'whence':'int' in our qapi */
430     whence = ga_parse_whence(whence_code, &err);
431     if (err) {
432         error_propagate(errp, err);
433         return NULL;
434     }
435 
436     fh = gfh->fh;
437     res = SetFilePointerEx(fh, off_pos, &new_pos, whence);
438     if (!res) {
439         error_setg_win32(errp, GetLastError(), "failed to seek file");
440         return NULL;
441     }
442     seek_data = g_new0(GuestFileSeek, 1);
443     seek_data->position = new_pos.QuadPart;
444     return seek_data;
445 }
446 
447 void qmp_guest_file_flush(int64_t handle, Error **errp)
448 {
449     HANDLE fh;
450     GuestFileHandle *gfh = guest_file_handle_find(handle, errp);
451     if (!gfh) {
452         return;
453     }
454 
455     fh = gfh->fh;
456     if (!FlushFileBuffers(fh)) {
457         error_setg_win32(errp, GetLastError(), "failed to flush file");
458     }
459 }
460 
461 #ifdef CONFIG_QGA_NTDDSCSI
462 
463 static STORAGE_BUS_TYPE win2qemu[] = {
464     [BusTypeUnknown] = GUEST_DISK_BUS_TYPE_UNKNOWN,
465     [BusTypeScsi] = GUEST_DISK_BUS_TYPE_SCSI,
466     [BusTypeAtapi] = GUEST_DISK_BUS_TYPE_IDE,
467     [BusTypeAta] = GUEST_DISK_BUS_TYPE_IDE,
468     [BusType1394] = GUEST_DISK_BUS_TYPE_IEEE1394,
469     [BusTypeSsa] = GUEST_DISK_BUS_TYPE_SSA,
470     [BusTypeFibre] = GUEST_DISK_BUS_TYPE_SSA,
471     [BusTypeUsb] = GUEST_DISK_BUS_TYPE_USB,
472     [BusTypeRAID] = GUEST_DISK_BUS_TYPE_RAID,
473 #if (_WIN32_WINNT >= 0x0600)
474     [BusTypeiScsi] = GUEST_DISK_BUS_TYPE_ISCSI,
475     [BusTypeSas] = GUEST_DISK_BUS_TYPE_SAS,
476     [BusTypeSata] = GUEST_DISK_BUS_TYPE_SATA,
477     [BusTypeSd] =  GUEST_DISK_BUS_TYPE_SD,
478     [BusTypeMmc] = GUEST_DISK_BUS_TYPE_MMC,
479 #endif
480 #if (_WIN32_WINNT >= 0x0601)
481     [BusTypeVirtual] = GUEST_DISK_BUS_TYPE_VIRTUAL,
482     [BusTypeFileBackedVirtual] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL,
483 #endif
484 };
485 
486 static GuestDiskBusType find_bus_type(STORAGE_BUS_TYPE bus)
487 {
488     if (bus >= ARRAY_SIZE(win2qemu) || (int)bus < 0) {
489         return GUEST_DISK_BUS_TYPE_UNKNOWN;
490     }
491     return win2qemu[(int)bus];
492 }
493 
494 /* XXX: The following function is BROKEN!
495  *
496  * It does not work and probably has never worked. When we query for list of
497  * disks we get cryptic names like "\Device\0000001d" instead of
498  * "\PhysicalDriveX" or "\HarddiskX". Whether the names can be translated one
499  * way or the other for comparison is an open question.
500  *
501  * When we query volume names (the original version) we are able to match those
502  * but then the property queries report error "Invalid function". (duh!)
503  */
504 
505 /*
506 DEFINE_GUID(GUID_DEVINTERFACE_VOLUME,
507         0x53f5630dL, 0xb6bf, 0x11d0, 0x94, 0xf2,
508         0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
509 */
510 DEFINE_GUID(GUID_DEVINTERFACE_DISK,
511         0x53f56307L, 0xb6bf, 0x11d0, 0x94, 0xf2,
512         0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
513 
514 
515 static GuestPCIAddress *get_pci_info(char *guid, Error **errp)
516 {
517     HDEVINFO dev_info;
518     SP_DEVINFO_DATA dev_info_data;
519     DWORD size = 0;
520     int i;
521     char dev_name[MAX_PATH];
522     char *buffer = NULL;
523     GuestPCIAddress *pci = NULL;
524     char *name = NULL;
525     bool partial_pci = false;
526     pci = g_malloc0(sizeof(*pci));
527     pci->domain = -1;
528     pci->slot = -1;
529     pci->function = -1;
530     pci->bus = -1;
531 
532     if (g_str_has_prefix(guid, "\\\\.\\") ||
533         g_str_has_prefix(guid, "\\\\?\\")) {
534         name = g_strdup(guid + 4);
535     } else {
536         name = g_strdup(guid);
537     }
538 
539     if (!QueryDosDevice(name, dev_name, ARRAY_SIZE(dev_name))) {
540         error_setg_win32(errp, GetLastError(), "failed to get dos device name");
541         goto out;
542     }
543 
544     dev_info = SetupDiGetClassDevs(&GUID_DEVINTERFACE_DISK, 0, 0,
545                                    DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
546     if (dev_info == INVALID_HANDLE_VALUE) {
547         error_setg_win32(errp, GetLastError(), "failed to get devices tree");
548         goto out;
549     }
550 
551     g_debug("enumerating devices");
552     dev_info_data.cbSize = sizeof(SP_DEVINFO_DATA);
553     for (i = 0; SetupDiEnumDeviceInfo(dev_info, i, &dev_info_data); i++) {
554         DWORD addr, bus, slot, data, size2;
555         int func, dev;
556         while (!SetupDiGetDeviceRegistryProperty(dev_info, &dev_info_data,
557                                             SPDRP_PHYSICAL_DEVICE_OBJECT_NAME,
558                                             &data, (PBYTE)buffer, size,
559                                             &size2)) {
560             size = MAX(size, size2);
561             if (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
562                 g_free(buffer);
563                 /* Double the size to avoid problems on
564                  * W2k MBCS systems per KB 888609.
565                  * https://support.microsoft.com/en-us/kb/259695 */
566                 buffer = g_malloc(size * 2);
567             } else {
568                 error_setg_win32(errp, GetLastError(),
569                         "failed to get device name");
570                 goto free_dev_info;
571             }
572         }
573 
574         if (g_strcmp0(buffer, dev_name)) {
575             continue;
576         }
577         g_debug("found device %s", dev_name);
578 
579         /* There is no need to allocate buffer in the next functions. The size
580          * is known and ULONG according to
581          * https://support.microsoft.com/en-us/kb/253232
582          * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
583          */
584         if (!SetupDiGetDeviceRegistryProperty(dev_info, &dev_info_data,
585                    SPDRP_BUSNUMBER, &data, (PBYTE)&bus, size, NULL)) {
586             debug_error("failed to get bus");
587             bus = -1;
588             partial_pci = true;
589         }
590 
591         /* The function retrieves the device's address. This value will be
592          * transformed into device function and number */
593         if (!SetupDiGetDeviceRegistryProperty(dev_info, &dev_info_data,
594                    SPDRP_ADDRESS, &data, (PBYTE)&addr, size, NULL)) {
595             debug_error("failed to get address");
596             addr = -1;
597             partial_pci = true;
598         }
599 
600         /* This call returns UINumber of DEVICE_CAPABILITIES structure.
601          * This number is typically a user-perceived slot number. */
602         if (!SetupDiGetDeviceRegistryProperty(dev_info, &dev_info_data,
603                    SPDRP_UI_NUMBER, &data, (PBYTE)&slot, size, NULL)) {
604             debug_error("failed to get slot");
605             slot = -1;
606             partial_pci = true;
607         }
608 
609         /* SetupApi gives us the same information as driver with
610          * IoGetDeviceProperty. According to Microsoft
611          * https://support.microsoft.com/en-us/kb/253232
612          * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF);
613          * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF);
614          * SPDRP_ADDRESS is propertyAddress, so we do the same.*/
615 
616         if (partial_pci) {
617             pci->domain = -1;
618             pci->slot = -1;
619             pci->function = -1;
620             pci->bus = -1;
621         } else {
622             func = ((int) addr == -1) ? -1 : addr & 0x0000FFFF;
623             dev = ((int) addr == -1) ? -1 : (addr >> 16) & 0x0000FFFF;
624             pci->domain = dev;
625             pci->slot = (int) slot;
626             pci->function = func;
627             pci->bus = (int) bus;
628         }
629         break;
630     }
631 
632 free_dev_info:
633     SetupDiDestroyDeviceInfoList(dev_info);
634 out:
635     g_free(buffer);
636     g_free(name);
637     return pci;
638 }
639 
640 static void get_disk_properties(HANDLE vol_h, GuestDiskAddress *disk,
641     Error **errp)
642 {
643     STORAGE_PROPERTY_QUERY query;
644     STORAGE_DEVICE_DESCRIPTOR *dev_desc, buf;
645     DWORD received;
646     ULONG size = sizeof(buf);
647 
648     dev_desc = &buf;
649     query.PropertyId = StorageDeviceProperty;
650     query.QueryType = PropertyStandardQuery;
651 
652     if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
653                          sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
654                          size, &received, NULL)) {
655         error_setg_win32(errp, GetLastError(), "failed to get bus type");
656         return;
657     }
658     disk->bus_type = find_bus_type(dev_desc->BusType);
659     g_debug("bus type %d", disk->bus_type);
660 
661     /* Query once more. Now with long enough buffer. */
662     size = dev_desc->Size;
663     dev_desc = g_malloc0(size);
664     if (!DeviceIoControl(vol_h, IOCTL_STORAGE_QUERY_PROPERTY, &query,
665                          sizeof(STORAGE_PROPERTY_QUERY), dev_desc,
666                          size, &received, NULL)) {
667         error_setg_win32(errp, GetLastError(), "failed to get serial number");
668         g_debug("failed to get serial number");
669         goto out_free;
670     }
671     if (dev_desc->SerialNumberOffset > 0) {
672         const char *serial;
673         size_t len;
674 
675         if (dev_desc->SerialNumberOffset >= received) {
676             error_setg(errp, "failed to get serial number: offset outside the buffer");
677             g_debug("serial number offset outside the buffer");
678             goto out_free;
679         }
680         serial = (char *)dev_desc + dev_desc->SerialNumberOffset;
681         len = received - dev_desc->SerialNumberOffset;
682         g_debug("serial number \"%s\"", serial);
683         if (*serial != 0) {
684             disk->serial = g_strndup(serial, len);
685             disk->has_serial = true;
686         }
687     }
688 out_free:
689     g_free(dev_desc);
690 
691     return;
692 }
693 
694 static void get_single_disk_info(GuestDiskAddress *disk, Error **errp)
695 {
696     SCSI_ADDRESS addr, *scsi_ad;
697     DWORD len;
698     HANDLE disk_h;
699     Error *local_err = NULL;
700 
701     scsi_ad = &addr;
702 
703     g_debug("getting disk info for: %s", disk->dev);
704     disk_h = CreateFile(disk->dev, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
705                        0, NULL);
706     if (disk_h == INVALID_HANDLE_VALUE) {
707         error_setg_win32(errp, GetLastError(), "failed to open disk");
708         return;
709     }
710 
711     get_disk_properties(disk_h, disk, &local_err);
712     if (local_err) {
713         error_propagate(errp, local_err);
714         goto err_close;
715     }
716 
717     g_debug("bus type %d", disk->bus_type);
718     /* always set pci_controller as required by schema. get_pci_info() should
719      * report -1 values for non-PCI buses rather than fail. fail the command
720      * if that doesn't hold since that suggests some other unexpected
721      * breakage
722      */
723     disk->pci_controller = get_pci_info(disk->dev, &local_err);
724     if (local_err) {
725         error_propagate(errp, local_err);
726         goto err_close;
727     }
728     if (disk->bus_type == GUEST_DISK_BUS_TYPE_SCSI
729             || disk->bus_type == GUEST_DISK_BUS_TYPE_IDE
730             || disk->bus_type == GUEST_DISK_BUS_TYPE_RAID
731 #if (_WIN32_WINNT >= 0x0600)
732             /* This bus type is not supported before Windows Server 2003 SP1 */
733             || disk->bus_type == GUEST_DISK_BUS_TYPE_SAS
734 #endif
735         ) {
736         /* We are able to use the same ioctls for different bus types
737          * according to Microsoft docs
738          * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
739         g_debug("getting pci-controller info");
740         if (DeviceIoControl(disk_h, IOCTL_SCSI_GET_ADDRESS, NULL, 0, scsi_ad,
741                             sizeof(SCSI_ADDRESS), &len, NULL)) {
742             disk->unit = addr.Lun;
743             disk->target = addr.TargetId;
744             disk->bus = addr.PathId;
745         }
746         /* We do not set error in this case, because we still have enough
747          * information about volume. */
748     }
749 
750 err_close:
751     CloseHandle(disk_h);
752     return;
753 }
754 
755 /* VSS provider works with volumes, thus there is no difference if
756  * the volume consist of spanned disks. Info about the first disk in the
757  * volume is returned for the spanned disk group (LVM) */
758 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
759 {
760     Error *local_err = NULL;
761     GuestDiskAddressList *list = NULL, *cur_item = NULL;
762     GuestDiskAddress *disk = NULL;
763     int i;
764     HANDLE vol_h;
765     DWORD size;
766     PVOLUME_DISK_EXTENTS extents = NULL;
767 
768     /* strip final backslash */
769     char *name = g_strdup(guid);
770     if (g_str_has_suffix(name, "\\")) {
771         name[strlen(name) - 1] = 0;
772     }
773 
774     g_debug("opening %s", name);
775     vol_h = CreateFile(name, 0, FILE_SHARE_READ, NULL, OPEN_EXISTING,
776                        0, NULL);
777     if (vol_h == INVALID_HANDLE_VALUE) {
778         error_setg_win32(errp, GetLastError(), "failed to open volume");
779         goto out;
780     }
781 
782     /* Get list of extents */
783     g_debug("getting disk extents");
784     size = sizeof(VOLUME_DISK_EXTENTS);
785     extents = g_malloc0(size);
786     if (!DeviceIoControl(vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
787                          0, extents, size, NULL, NULL)) {
788         DWORD last_err = GetLastError();
789         if (last_err == ERROR_MORE_DATA) {
790             /* Try once more with big enough buffer */
791             size = sizeof(VOLUME_DISK_EXTENTS)
792                 + extents->NumberOfDiskExtents*sizeof(DISK_EXTENT);
793             g_free(extents);
794             extents = g_malloc0(size);
795             if (!DeviceIoControl(
796                     vol_h, IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS, NULL,
797                     0, extents, size, NULL, NULL)) {
798                 error_setg_win32(errp, GetLastError(),
799                     "failed to get disk extents");
800                 return NULL;
801             }
802         } else if (last_err == ERROR_INVALID_FUNCTION) {
803             /* Possibly CD-ROM or a shared drive. Try to pass the volume */
804             g_debug("volume not on disk");
805             disk = g_malloc0(sizeof(GuestDiskAddress));
806             disk->has_dev = true;
807             disk->dev = g_strdup(name);
808             get_single_disk_info(disk, &local_err);
809             if (local_err) {
810                 g_debug("failed to get disk info, ignoring error: %s",
811                     error_get_pretty(local_err));
812                 error_free(local_err);
813                 goto out;
814             }
815             list = g_malloc0(sizeof(*list));
816             list->value = disk;
817             disk = NULL;
818             list->next = NULL;
819             goto out;
820         } else {
821             error_setg_win32(errp, GetLastError(),
822                 "failed to get disk extents");
823             goto out;
824         }
825     }
826     g_debug("Number of extents: %lu", extents->NumberOfDiskExtents);
827 
828     /* Go through each extent */
829     for (i = 0; i < extents->NumberOfDiskExtents; i++) {
830         disk = g_malloc0(sizeof(GuestDiskAddress));
831 
832         /* Disk numbers directly correspond to numbers used in UNCs
833          *
834          * See documentation for DISK_EXTENT:
835          * https://docs.microsoft.com/en-us/windows/desktop/api/winioctl/ns-winioctl-_disk_extent
836          *
837          * See also Naming Files, Paths and Namespaces:
838          * https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#win32-device-namespaces
839          */
840         disk->has_dev = true;
841         disk->dev = g_strdup_printf("\\\\.\\PhysicalDrive%lu",
842             extents->Extents[i].DiskNumber);
843 
844         get_single_disk_info(disk, &local_err);
845         if (local_err) {
846             error_propagate(errp, local_err);
847             goto out;
848         }
849         cur_item = g_malloc0(sizeof(*list));
850         cur_item->value = disk;
851         disk = NULL;
852         cur_item->next = list;
853         list = cur_item;
854     }
855 
856 
857 out:
858     qapi_free_GuestDiskAddress(disk);
859     g_free(extents);
860     g_free(name);
861 
862     return list;
863 }
864 
865 #else
866 
867 static GuestDiskAddressList *build_guest_disk_info(char *guid, Error **errp)
868 {
869     return NULL;
870 }
871 
872 #endif /* CONFIG_QGA_NTDDSCSI */
873 
874 static GuestFilesystemInfo *build_guest_fsinfo(char *guid, Error **errp)
875 {
876     DWORD info_size;
877     char mnt, *mnt_point;
878     char fs_name[32];
879     char vol_info[MAX_PATH+1];
880     size_t len;
881     uint64_t i64FreeBytesToCaller, i64TotalBytes, i64FreeBytes;
882     GuestFilesystemInfo *fs = NULL;
883 
884     GetVolumePathNamesForVolumeName(guid, (LPCH)&mnt, 0, &info_size);
885     if (GetLastError() != ERROR_MORE_DATA) {
886         error_setg_win32(errp, GetLastError(), "failed to get volume name");
887         return NULL;
888     }
889 
890     mnt_point = g_malloc(info_size + 1);
891     if (!GetVolumePathNamesForVolumeName(guid, mnt_point, info_size,
892                                          &info_size)) {
893         error_setg_win32(errp, GetLastError(), "failed to get volume name");
894         goto free;
895     }
896 
897     len = strlen(mnt_point);
898     mnt_point[len] = '\\';
899     mnt_point[len+1] = 0;
900     if (!GetVolumeInformation(mnt_point, vol_info, sizeof(vol_info), NULL, NULL,
901                               NULL, (LPSTR)&fs_name, sizeof(fs_name))) {
902         if (GetLastError() != ERROR_NOT_READY) {
903             error_setg_win32(errp, GetLastError(), "failed to get volume info");
904         }
905         goto free;
906     }
907 
908     fs_name[sizeof(fs_name) - 1] = 0;
909     fs = g_malloc(sizeof(*fs));
910     fs->name = g_strdup(guid);
911     fs->has_total_bytes = false;
912     fs->has_used_bytes = false;
913     if (len == 0) {
914         fs->mountpoint = g_strdup("System Reserved");
915     } else {
916         fs->mountpoint = g_strndup(mnt_point, len);
917         if (GetDiskFreeSpaceEx(fs->mountpoint,
918                                (PULARGE_INTEGER) & i64FreeBytesToCaller,
919                                (PULARGE_INTEGER) & i64TotalBytes,
920                                (PULARGE_INTEGER) & i64FreeBytes)) {
921             fs->used_bytes = i64TotalBytes - i64FreeBytes;
922             fs->total_bytes = i64TotalBytes;
923             fs->has_total_bytes = true;
924             fs->has_used_bytes = true;
925         }
926     }
927     fs->type = g_strdup(fs_name);
928     fs->disk = build_guest_disk_info(guid, errp);
929 free:
930     g_free(mnt_point);
931     return fs;
932 }
933 
934 GuestFilesystemInfoList *qmp_guest_get_fsinfo(Error **errp)
935 {
936     HANDLE vol_h;
937     GuestFilesystemInfoList *new, *ret = NULL;
938     char guid[256];
939 
940     vol_h = FindFirstVolume(guid, sizeof(guid));
941     if (vol_h == INVALID_HANDLE_VALUE) {
942         error_setg_win32(errp, GetLastError(), "failed to find any volume");
943         return NULL;
944     }
945 
946     do {
947         GuestFilesystemInfo *info = build_guest_fsinfo(guid, errp);
948         if (info == NULL) {
949             continue;
950         }
951         new = g_malloc(sizeof(*ret));
952         new->value = info;
953         new->next = ret;
954         ret = new;
955     } while (FindNextVolume(vol_h, guid, sizeof(guid)));
956 
957     if (GetLastError() != ERROR_NO_MORE_FILES) {
958         error_setg_win32(errp, GetLastError(), "failed to find next volume");
959     }
960 
961     FindVolumeClose(vol_h);
962     return ret;
963 }
964 
965 /*
966  * Return status of freeze/thaw
967  */
968 GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp)
969 {
970     if (!vss_initialized()) {
971         error_setg(errp, QERR_UNSUPPORTED);
972         return 0;
973     }
974 
975     if (ga_is_frozen(ga_state)) {
976         return GUEST_FSFREEZE_STATUS_FROZEN;
977     }
978 
979     return GUEST_FSFREEZE_STATUS_THAWED;
980 }
981 
982 /*
983  * Freeze local file systems using Volume Shadow-copy Service.
984  * The frozen state is limited for up to 10 seconds by VSS.
985  */
986 int64_t qmp_guest_fsfreeze_freeze(Error **errp)
987 {
988     return qmp_guest_fsfreeze_freeze_list(false, NULL, errp);
989 }
990 
991 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints,
992                                        strList *mountpoints,
993                                        Error **errp)
994 {
995     int i;
996     Error *local_err = NULL;
997 
998     if (!vss_initialized()) {
999         error_setg(errp, QERR_UNSUPPORTED);
1000         return 0;
1001     }
1002 
1003     slog("guest-fsfreeze called");
1004 
1005     /* cannot risk guest agent blocking itself on a write in this state */
1006     ga_set_frozen(ga_state);
1007 
1008     qga_vss_fsfreeze(&i, true, mountpoints, &local_err);
1009     if (local_err) {
1010         error_propagate(errp, local_err);
1011         goto error;
1012     }
1013 
1014     return i;
1015 
1016 error:
1017     local_err = NULL;
1018     qmp_guest_fsfreeze_thaw(&local_err);
1019     if (local_err) {
1020         g_debug("cleanup thaw: %s", error_get_pretty(local_err));
1021         error_free(local_err);
1022     }
1023     return 0;
1024 }
1025 
1026 /*
1027  * Thaw local file systems using Volume Shadow-copy Service.
1028  */
1029 int64_t qmp_guest_fsfreeze_thaw(Error **errp)
1030 {
1031     int i;
1032 
1033     if (!vss_initialized()) {
1034         error_setg(errp, QERR_UNSUPPORTED);
1035         return 0;
1036     }
1037 
1038     qga_vss_fsfreeze(&i, false, NULL, errp);
1039 
1040     ga_unset_frozen(ga_state);
1041     return i;
1042 }
1043 
1044 static void guest_fsfreeze_cleanup(void)
1045 {
1046     Error *err = NULL;
1047 
1048     if (!vss_initialized()) {
1049         return;
1050     }
1051 
1052     if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) {
1053         qmp_guest_fsfreeze_thaw(&err);
1054         if (err) {
1055             slog("failed to clean up frozen filesystems: %s",
1056                  error_get_pretty(err));
1057             error_free(err);
1058         }
1059     }
1060 
1061     vss_deinit(true);
1062 }
1063 
1064 /*
1065  * Walk list of mounted file systems in the guest, and discard unused
1066  * areas.
1067  */
1068 GuestFilesystemTrimResponse *
1069 qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp)
1070 {
1071     GuestFilesystemTrimResponse *resp;
1072     HANDLE handle;
1073     WCHAR guid[MAX_PATH] = L"";
1074     OSVERSIONINFO osvi;
1075     BOOL win8_or_later;
1076 
1077     ZeroMemory(&osvi, sizeof(OSVERSIONINFO));
1078     osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1079     GetVersionEx(&osvi);
1080     win8_or_later = (osvi.dwMajorVersion > 6 ||
1081                           ((osvi.dwMajorVersion == 6) &&
1082                            (osvi.dwMinorVersion >= 2)));
1083     if (!win8_or_later) {
1084         error_setg(errp, "fstrim is only supported for Win8+");
1085         return NULL;
1086     }
1087 
1088     handle = FindFirstVolumeW(guid, ARRAYSIZE(guid));
1089     if (handle == INVALID_HANDLE_VALUE) {
1090         error_setg_win32(errp, GetLastError(), "failed to find any volume");
1091         return NULL;
1092     }
1093 
1094     resp = g_new0(GuestFilesystemTrimResponse, 1);
1095 
1096     do {
1097         GuestFilesystemTrimResult *res;
1098         GuestFilesystemTrimResultList *list;
1099         PWCHAR uc_path;
1100         DWORD char_count = 0;
1101         char *path, *out;
1102         GError *gerr = NULL;
1103         gchar * argv[4];
1104 
1105         GetVolumePathNamesForVolumeNameW(guid, NULL, 0, &char_count);
1106 
1107         if (GetLastError() != ERROR_MORE_DATA) {
1108             continue;
1109         }
1110         if (GetDriveTypeW(guid) != DRIVE_FIXED) {
1111             continue;
1112         }
1113 
1114         uc_path = g_malloc(sizeof(WCHAR) * char_count);
1115         if (!GetVolumePathNamesForVolumeNameW(guid, uc_path, char_count,
1116                                               &char_count) || !*uc_path) {
1117             /* strange, but this condition could be faced even with size == 2 */
1118             g_free(uc_path);
1119             continue;
1120         }
1121 
1122         res = g_new0(GuestFilesystemTrimResult, 1);
1123 
1124         path = g_utf16_to_utf8(uc_path, char_count, NULL, NULL, &gerr);
1125 
1126         g_free(uc_path);
1127 
1128         if (!path) {
1129             res->has_error = true;
1130             res->error = g_strdup(gerr->message);
1131             g_error_free(gerr);
1132             break;
1133         }
1134 
1135         res->path = path;
1136 
1137         list = g_new0(GuestFilesystemTrimResultList, 1);
1138         list->value = res;
1139         list->next = resp->paths;
1140 
1141         resp->paths = list;
1142 
1143         memset(argv, 0, sizeof(argv));
1144         argv[0] = (gchar *)"defrag.exe";
1145         argv[1] = (gchar *)"/L";
1146         argv[2] = path;
1147 
1148         if (!g_spawn_sync(NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL,
1149                           &out /* stdout */, NULL /* stdin */,
1150                           NULL, &gerr)) {
1151             res->has_error = true;
1152             res->error = g_strdup(gerr->message);
1153             g_error_free(gerr);
1154         } else {
1155             /* defrag.exe is UGLY. Exit code is ALWAYS zero.
1156                Error is reported in the output with something like
1157                (x89000020) etc code in the stdout */
1158 
1159             int i;
1160             gchar **lines = g_strsplit(out, "\r\n", 0);
1161             g_free(out);
1162 
1163             for (i = 0; lines[i] != NULL; i++) {
1164                 if (g_strstr_len(lines[i], -1, "(0x") == NULL) {
1165                     continue;
1166                 }
1167                 res->has_error = true;
1168                 res->error = g_strdup(lines[i]);
1169                 break;
1170             }
1171             g_strfreev(lines);
1172         }
1173     } while (FindNextVolumeW(handle, guid, ARRAYSIZE(guid)));
1174 
1175     FindVolumeClose(handle);
1176     return resp;
1177 }
1178 
1179 typedef enum {
1180     GUEST_SUSPEND_MODE_DISK,
1181     GUEST_SUSPEND_MODE_RAM
1182 } GuestSuspendMode;
1183 
1184 static void check_suspend_mode(GuestSuspendMode mode, Error **errp)
1185 {
1186     SYSTEM_POWER_CAPABILITIES sys_pwr_caps;
1187     Error *local_err = NULL;
1188 
1189     ZeroMemory(&sys_pwr_caps, sizeof(sys_pwr_caps));
1190     if (!GetPwrCapabilities(&sys_pwr_caps)) {
1191         error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
1192                    "failed to determine guest suspend capabilities");
1193         goto out;
1194     }
1195 
1196     switch (mode) {
1197     case GUEST_SUSPEND_MODE_DISK:
1198         if (!sys_pwr_caps.SystemS4) {
1199             error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
1200                        "suspend-to-disk not supported by OS");
1201         }
1202         break;
1203     case GUEST_SUSPEND_MODE_RAM:
1204         if (!sys_pwr_caps.SystemS3) {
1205             error_setg(&local_err, QERR_QGA_COMMAND_FAILED,
1206                        "suspend-to-ram not supported by OS");
1207         }
1208         break;
1209     default:
1210         error_setg(&local_err, QERR_INVALID_PARAMETER_VALUE, "mode",
1211                    "GuestSuspendMode");
1212     }
1213 
1214 out:
1215     error_propagate(errp, local_err);
1216 }
1217 
1218 static DWORD WINAPI do_suspend(LPVOID opaque)
1219 {
1220     GuestSuspendMode *mode = opaque;
1221     DWORD ret = 0;
1222 
1223     if (!SetSuspendState(*mode == GUEST_SUSPEND_MODE_DISK, TRUE, TRUE)) {
1224         slog("failed to suspend guest, %lu", GetLastError());
1225         ret = -1;
1226     }
1227     g_free(mode);
1228     return ret;
1229 }
1230 
1231 void qmp_guest_suspend_disk(Error **errp)
1232 {
1233     Error *local_err = NULL;
1234     GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1235 
1236     *mode = GUEST_SUSPEND_MODE_DISK;
1237     check_suspend_mode(*mode, &local_err);
1238     acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1239     execute_async(do_suspend, mode, &local_err);
1240 
1241     if (local_err) {
1242         error_propagate(errp, local_err);
1243         g_free(mode);
1244     }
1245 }
1246 
1247 void qmp_guest_suspend_ram(Error **errp)
1248 {
1249     Error *local_err = NULL;
1250     GuestSuspendMode *mode = g_new(GuestSuspendMode, 1);
1251 
1252     *mode = GUEST_SUSPEND_MODE_RAM;
1253     check_suspend_mode(*mode, &local_err);
1254     acquire_privilege(SE_SHUTDOWN_NAME, &local_err);
1255     execute_async(do_suspend, mode, &local_err);
1256 
1257     if (local_err) {
1258         error_propagate(errp, local_err);
1259         g_free(mode);
1260     }
1261 }
1262 
1263 void qmp_guest_suspend_hybrid(Error **errp)
1264 {
1265     error_setg(errp, QERR_UNSUPPORTED);
1266 }
1267 
1268 static IP_ADAPTER_ADDRESSES *guest_get_adapters_addresses(Error **errp)
1269 {
1270     IP_ADAPTER_ADDRESSES *adptr_addrs = NULL;
1271     ULONG adptr_addrs_len = 0;
1272     DWORD ret;
1273 
1274     /* Call the first time to get the adptr_addrs_len. */
1275     GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1276                          NULL, adptr_addrs, &adptr_addrs_len);
1277 
1278     adptr_addrs = g_malloc(adptr_addrs_len);
1279     ret = GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_INCLUDE_PREFIX,
1280                                NULL, adptr_addrs, &adptr_addrs_len);
1281     if (ret != ERROR_SUCCESS) {
1282         error_setg_win32(errp, ret, "failed to get adapters addresses");
1283         g_free(adptr_addrs);
1284         adptr_addrs = NULL;
1285     }
1286     return adptr_addrs;
1287 }
1288 
1289 static char *guest_wctomb_dup(WCHAR *wstr)
1290 {
1291     char *str;
1292     size_t i;
1293 
1294     i = wcslen(wstr) + 1;
1295     str = g_malloc(i);
1296     WideCharToMultiByte(CP_ACP, WC_COMPOSITECHECK,
1297                         wstr, -1, str, i, NULL, NULL);
1298     return str;
1299 }
1300 
1301 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS *ip_addr,
1302                                Error **errp)
1303 {
1304     char addr_str[INET6_ADDRSTRLEN + INET_ADDRSTRLEN];
1305     DWORD len;
1306     int ret;
1307 
1308     if (ip_addr->Address.lpSockaddr->sa_family == AF_INET ||
1309             ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1310         len = sizeof(addr_str);
1311         ret = WSAAddressToString(ip_addr->Address.lpSockaddr,
1312                                  ip_addr->Address.iSockaddrLength,
1313                                  NULL,
1314                                  addr_str,
1315                                  &len);
1316         if (ret != 0) {
1317             error_setg_win32(errp, WSAGetLastError(),
1318                 "failed address presentation form conversion");
1319             return NULL;
1320         }
1321         return g_strdup(addr_str);
1322     }
1323     return NULL;
1324 }
1325 
1326 #if (_WIN32_WINNT >= 0x0600)
1327 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS *ip_addr)
1328 {
1329     /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1330      * field to obtain the prefix.
1331      */
1332     return ip_addr->OnLinkPrefixLength;
1333 }
1334 #else
1335 /* When using the Windows XP and 2003 build environment, do the best we can to
1336  * figure out the prefix.
1337  */
1338 static IP_ADAPTER_INFO *guest_get_adapters_info(void)
1339 {
1340     IP_ADAPTER_INFO *adptr_info = NULL;
1341     ULONG adptr_info_len = 0;
1342     DWORD ret;
1343 
1344     /* Call the first time to get the adptr_info_len. */
1345     GetAdaptersInfo(adptr_info, &adptr_info_len);
1346 
1347     adptr_info = g_malloc(adptr_info_len);
1348     ret = GetAdaptersInfo(adptr_info, &adptr_info_len);
1349     if (ret != ERROR_SUCCESS) {
1350         g_free(adptr_info);
1351         adptr_info = NULL;
1352     }
1353     return adptr_info;
1354 }
1355 
1356 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS *ip_addr)
1357 {
1358     int64_t prefix = -1; /* Use for AF_INET6 and unknown/undetermined values. */
1359     IP_ADAPTER_INFO *adptr_info, *info;
1360     IP_ADDR_STRING *ip;
1361     struct in_addr *p;
1362 
1363     if (ip_addr->Address.lpSockaddr->sa_family != AF_INET) {
1364         return prefix;
1365     }
1366     adptr_info = guest_get_adapters_info();
1367     if (adptr_info == NULL) {
1368         return prefix;
1369     }
1370 
1371     /* Match up the passed in ip_addr with one found in adaptr_info.
1372      * The matching one in adptr_info will have the netmask.
1373      */
1374     p = &((struct sockaddr_in *)ip_addr->Address.lpSockaddr)->sin_addr;
1375     for (info = adptr_info; info; info = info->Next) {
1376         for (ip = &info->IpAddressList; ip; ip = ip->Next) {
1377             if (p->S_un.S_addr == inet_addr(ip->IpAddress.String)) {
1378                 prefix = ctpop32(inet_addr(ip->IpMask.String));
1379                 goto out;
1380             }
1381         }
1382     }
1383 out:
1384     g_free(adptr_info);
1385     return prefix;
1386 }
1387 #endif
1388 
1389 #define INTERFACE_PATH_BUF_SZ 512
1390 
1391 static DWORD get_interface_index(const char *guid)
1392 {
1393     ULONG index;
1394     DWORD status;
1395     wchar_t wbuf[INTERFACE_PATH_BUF_SZ];
1396     snwprintf(wbuf, INTERFACE_PATH_BUF_SZ, L"\\device\\tcpip_%s", guid);
1397     wbuf[INTERFACE_PATH_BUF_SZ - 1] = 0;
1398     status = GetAdapterIndex (wbuf, &index);
1399     if (status != NO_ERROR) {
1400         return (DWORD)~0;
1401     } else {
1402         return index;
1403     }
1404 }
1405 
1406 typedef NETIOAPI_API (WINAPI *GetIfEntry2Func)(PMIB_IF_ROW2 Row);
1407 
1408 static int guest_get_network_stats(const char *name,
1409                                    GuestNetworkInterfaceStat *stats)
1410 {
1411     OSVERSIONINFO os_ver;
1412 
1413     os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
1414     GetVersionEx(&os_ver);
1415     if (os_ver.dwMajorVersion >= 6) {
1416         MIB_IF_ROW2 a_mid_ifrow;
1417         GetIfEntry2Func getifentry2_ex;
1418         DWORD if_index = 0;
1419         HMODULE module = GetModuleHandle("iphlpapi");
1420         PVOID func = GetProcAddress(module, "GetIfEntry2");
1421 
1422         if (func == NULL) {
1423             return -1;
1424         }
1425 
1426         getifentry2_ex = (GetIfEntry2Func)func;
1427         if_index = get_interface_index(name);
1428         if (if_index == (DWORD)~0) {
1429             return -1;
1430         }
1431 
1432         memset(&a_mid_ifrow, 0, sizeof(a_mid_ifrow));
1433         a_mid_ifrow.InterfaceIndex = if_index;
1434         if (NO_ERROR == getifentry2_ex(&a_mid_ifrow)) {
1435             stats->rx_bytes = a_mid_ifrow.InOctets;
1436             stats->rx_packets = a_mid_ifrow.InUcastPkts;
1437             stats->rx_errs = a_mid_ifrow.InErrors;
1438             stats->rx_dropped = a_mid_ifrow.InDiscards;
1439             stats->tx_bytes = a_mid_ifrow.OutOctets;
1440             stats->tx_packets = a_mid_ifrow.OutUcastPkts;
1441             stats->tx_errs = a_mid_ifrow.OutErrors;
1442             stats->tx_dropped = a_mid_ifrow.OutDiscards;
1443             return 0;
1444         }
1445     }
1446     return -1;
1447 }
1448 
1449 GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp)
1450 {
1451     IP_ADAPTER_ADDRESSES *adptr_addrs, *addr;
1452     IP_ADAPTER_UNICAST_ADDRESS *ip_addr = NULL;
1453     GuestNetworkInterfaceList *head = NULL, *cur_item = NULL;
1454     GuestIpAddressList *head_addr, *cur_addr;
1455     GuestNetworkInterfaceList *info;
1456     GuestNetworkInterfaceStat *interface_stat = NULL;
1457     GuestIpAddressList *address_item = NULL;
1458     unsigned char *mac_addr;
1459     char *addr_str;
1460     WORD wsa_version;
1461     WSADATA wsa_data;
1462     int ret;
1463 
1464     adptr_addrs = guest_get_adapters_addresses(errp);
1465     if (adptr_addrs == NULL) {
1466         return NULL;
1467     }
1468 
1469     /* Make WSA APIs available. */
1470     wsa_version = MAKEWORD(2, 2);
1471     ret = WSAStartup(wsa_version, &wsa_data);
1472     if (ret != 0) {
1473         error_setg_win32(errp, ret, "failed socket startup");
1474         goto out;
1475     }
1476 
1477     for (addr = adptr_addrs; addr; addr = addr->Next) {
1478         info = g_malloc0(sizeof(*info));
1479 
1480         if (cur_item == NULL) {
1481             head = cur_item = info;
1482         } else {
1483             cur_item->next = info;
1484             cur_item = info;
1485         }
1486 
1487         info->value = g_malloc0(sizeof(*info->value));
1488         info->value->name = guest_wctomb_dup(addr->FriendlyName);
1489 
1490         if (addr->PhysicalAddressLength != 0) {
1491             mac_addr = addr->PhysicalAddress;
1492 
1493             info->value->hardware_address =
1494                 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1495                                 (int) mac_addr[0], (int) mac_addr[1],
1496                                 (int) mac_addr[2], (int) mac_addr[3],
1497                                 (int) mac_addr[4], (int) mac_addr[5]);
1498 
1499             info->value->has_hardware_address = true;
1500         }
1501 
1502         head_addr = NULL;
1503         cur_addr = NULL;
1504         for (ip_addr = addr->FirstUnicastAddress;
1505                 ip_addr;
1506                 ip_addr = ip_addr->Next) {
1507             addr_str = guest_addr_to_str(ip_addr, errp);
1508             if (addr_str == NULL) {
1509                 continue;
1510             }
1511 
1512             address_item = g_malloc0(sizeof(*address_item));
1513 
1514             if (!cur_addr) {
1515                 head_addr = cur_addr = address_item;
1516             } else {
1517                 cur_addr->next = address_item;
1518                 cur_addr = address_item;
1519             }
1520 
1521             address_item->value = g_malloc0(sizeof(*address_item->value));
1522             address_item->value->ip_address = addr_str;
1523             address_item->value->prefix = guest_ip_prefix(ip_addr);
1524             if (ip_addr->Address.lpSockaddr->sa_family == AF_INET) {
1525                 address_item->value->ip_address_type =
1526                     GUEST_IP_ADDRESS_TYPE_IPV4;
1527             } else if (ip_addr->Address.lpSockaddr->sa_family == AF_INET6) {
1528                 address_item->value->ip_address_type =
1529                     GUEST_IP_ADDRESS_TYPE_IPV6;
1530             }
1531         }
1532         if (head_addr) {
1533             info->value->has_ip_addresses = true;
1534             info->value->ip_addresses = head_addr;
1535         }
1536         if (!info->value->has_statistics) {
1537             interface_stat = g_malloc0(sizeof(*interface_stat));
1538             if (guest_get_network_stats(addr->AdapterName,
1539                 interface_stat) == -1) {
1540                 info->value->has_statistics = false;
1541                 g_free(interface_stat);
1542             } else {
1543                 info->value->statistics = interface_stat;
1544                 info->value->has_statistics = true;
1545             }
1546         }
1547     }
1548     WSACleanup();
1549 out:
1550     g_free(adptr_addrs);
1551     return head;
1552 }
1553 
1554 int64_t qmp_guest_get_time(Error **errp)
1555 {
1556     SYSTEMTIME ts = {0};
1557     FILETIME tf;
1558 
1559     GetSystemTime(&ts);
1560     if (ts.wYear < 1601 || ts.wYear > 30827) {
1561         error_setg(errp, "Failed to get time");
1562         return -1;
1563     }
1564 
1565     if (!SystemTimeToFileTime(&ts, &tf)) {
1566         error_setg(errp, "Failed to convert system time: %d", (int)GetLastError());
1567         return -1;
1568     }
1569 
1570     return ((((int64_t)tf.dwHighDateTime << 32) | tf.dwLowDateTime)
1571                 - W32_FT_OFFSET) * 100;
1572 }
1573 
1574 void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp)
1575 {
1576     Error *local_err = NULL;
1577     SYSTEMTIME ts;
1578     FILETIME tf;
1579     LONGLONG time;
1580 
1581     if (!has_time) {
1582         /* Unfortunately, Windows libraries don't provide an easy way to access
1583          * RTC yet:
1584          *
1585          * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1586          *
1587          * Instead, a workaround is to use the Windows win32tm command to
1588          * resync the time using the Windows Time service.
1589          */
1590         LPVOID msg_buffer;
1591         DWORD ret_flags;
1592 
1593         HRESULT hr = system("w32tm /resync /nowait");
1594 
1595         if (GetLastError() != 0) {
1596             strerror_s((LPTSTR) & msg_buffer, 0, errno);
1597             error_setg(errp, "system(...) failed: %s", (LPCTSTR)msg_buffer);
1598         } else if (hr != 0) {
1599             if (hr == HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)) {
1600                 error_setg(errp, "Windows Time service not running on the "
1601                                  "guest");
1602             } else {
1603                 if (!FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
1604                                    FORMAT_MESSAGE_FROM_SYSTEM |
1605                                    FORMAT_MESSAGE_IGNORE_INSERTS, NULL,
1606                                    (DWORD)hr, MAKELANGID(LANG_NEUTRAL,
1607                                    SUBLANG_DEFAULT), (LPTSTR) & msg_buffer, 0,
1608                                    NULL)) {
1609                     error_setg(errp, "w32tm failed with error (0x%lx), couldn'"
1610                                      "t retrieve error message", hr);
1611                 } else {
1612                     error_setg(errp, "w32tm failed with error (0x%lx): %s", hr,
1613                                (LPCTSTR)msg_buffer);
1614                     LocalFree(msg_buffer);
1615                 }
1616             }
1617         } else if (!InternetGetConnectedState(&ret_flags, 0)) {
1618             error_setg(errp, "No internet connection on guest, sync not "
1619                              "accurate");
1620         }
1621         return;
1622     }
1623 
1624     /* Validate time passed by user. */
1625     if (time_ns < 0 || time_ns / 100 > INT64_MAX - W32_FT_OFFSET) {
1626         error_setg(errp, "Time %" PRId64 "is invalid", time_ns);
1627         return;
1628     }
1629 
1630     time = time_ns / 100 + W32_FT_OFFSET;
1631 
1632     tf.dwLowDateTime = (DWORD) time;
1633     tf.dwHighDateTime = (DWORD) (time >> 32);
1634 
1635     if (!FileTimeToSystemTime(&tf, &ts)) {
1636         error_setg(errp, "Failed to convert system time %d",
1637                    (int)GetLastError());
1638         return;
1639     }
1640 
1641     acquire_privilege(SE_SYSTEMTIME_NAME, &local_err);
1642     if (local_err) {
1643         error_propagate(errp, local_err);
1644         return;
1645     }
1646 
1647     if (!SetSystemTime(&ts)) {
1648         error_setg(errp, "Failed to set time to guest: %d", (int)GetLastError());
1649         return;
1650     }
1651 }
1652 
1653 GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp)
1654 {
1655     PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi, ptr;
1656     DWORD length;
1657     GuestLogicalProcessorList *head, **link;
1658     Error *local_err = NULL;
1659     int64_t current;
1660 
1661     ptr = pslpi = NULL;
1662     length = 0;
1663     current = 0;
1664     head = NULL;
1665     link = &head;
1666 
1667     if ((GetLogicalProcessorInformation(pslpi, &length) == FALSE) &&
1668         (GetLastError() == ERROR_INSUFFICIENT_BUFFER) &&
1669         (length > sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION))) {
1670         ptr = pslpi = g_malloc0(length);
1671         if (GetLogicalProcessorInformation(pslpi, &length) == FALSE) {
1672             error_setg(&local_err, "Failed to get processor information: %d",
1673                        (int)GetLastError());
1674         }
1675     } else {
1676         error_setg(&local_err,
1677                    "Failed to get processor information buffer length: %d",
1678                    (int)GetLastError());
1679     }
1680 
1681     while ((local_err == NULL) && (length > 0)) {
1682         if (pslpi->Relationship == RelationProcessorCore) {
1683             ULONG_PTR cpu_bits = pslpi->ProcessorMask;
1684 
1685             while (cpu_bits > 0) {
1686                 if (!!(cpu_bits & 1)) {
1687                     GuestLogicalProcessor *vcpu;
1688                     GuestLogicalProcessorList *entry;
1689 
1690                     vcpu = g_malloc0(sizeof *vcpu);
1691                     vcpu->logical_id = current++;
1692                     vcpu->online = true;
1693                     vcpu->has_can_offline = true;
1694 
1695                     entry = g_malloc0(sizeof *entry);
1696                     entry->value = vcpu;
1697 
1698                     *link = entry;
1699                     link = &entry->next;
1700                 }
1701                 cpu_bits >>= 1;
1702             }
1703         }
1704         length -= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION);
1705         pslpi++; /* next entry */
1706     }
1707 
1708     g_free(ptr);
1709 
1710     if (local_err == NULL) {
1711         if (head != NULL) {
1712             return head;
1713         }
1714         /* there's no guest with zero VCPUs */
1715         error_setg(&local_err, "Guest reported zero VCPUs");
1716     }
1717 
1718     qapi_free_GuestLogicalProcessorList(head);
1719     error_propagate(errp, local_err);
1720     return NULL;
1721 }
1722 
1723 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp)
1724 {
1725     error_setg(errp, QERR_UNSUPPORTED);
1726     return -1;
1727 }
1728 
1729 static gchar *
1730 get_net_error_message(gint error)
1731 {
1732     HMODULE module = NULL;
1733     gchar *retval = NULL;
1734     wchar_t *msg = NULL;
1735     int flags;
1736     size_t nchars;
1737 
1738     flags = FORMAT_MESSAGE_ALLOCATE_BUFFER |
1739         FORMAT_MESSAGE_IGNORE_INSERTS |
1740         FORMAT_MESSAGE_FROM_SYSTEM;
1741 
1742     if (error >= NERR_BASE && error <= MAX_NERR) {
1743         module = LoadLibraryExW(L"netmsg.dll", NULL, LOAD_LIBRARY_AS_DATAFILE);
1744 
1745         if (module != NULL) {
1746             flags |= FORMAT_MESSAGE_FROM_HMODULE;
1747         }
1748     }
1749 
1750     FormatMessageW(flags, module, error, 0, (LPWSTR)&msg, 0, NULL);
1751 
1752     if (msg != NULL) {
1753         nchars = wcslen(msg);
1754 
1755         if (nchars >= 2 &&
1756             msg[nchars - 1] == L'\n' &&
1757             msg[nchars - 2] == L'\r') {
1758             msg[nchars - 2] = L'\0';
1759         }
1760 
1761         retval = g_utf16_to_utf8(msg, -1, NULL, NULL, NULL);
1762 
1763         LocalFree(msg);
1764     }
1765 
1766     if (module != NULL) {
1767         FreeLibrary(module);
1768     }
1769 
1770     return retval;
1771 }
1772 
1773 void qmp_guest_set_user_password(const char *username,
1774                                  const char *password,
1775                                  bool crypted,
1776                                  Error **errp)
1777 {
1778     NET_API_STATUS nas;
1779     char *rawpasswddata = NULL;
1780     size_t rawpasswdlen;
1781     wchar_t *user = NULL, *wpass = NULL;
1782     USER_INFO_1003 pi1003 = { 0, };
1783     GError *gerr = NULL;
1784 
1785     if (crypted) {
1786         error_setg(errp, QERR_UNSUPPORTED);
1787         return;
1788     }
1789 
1790     rawpasswddata = (char *)qbase64_decode(password, -1, &rawpasswdlen, errp);
1791     if (!rawpasswddata) {
1792         return;
1793     }
1794     rawpasswddata = g_renew(char, rawpasswddata, rawpasswdlen + 1);
1795     rawpasswddata[rawpasswdlen] = '\0';
1796 
1797     user = g_utf8_to_utf16(username, -1, NULL, NULL, &gerr);
1798     if (!user) {
1799         goto done;
1800     }
1801 
1802     wpass = g_utf8_to_utf16(rawpasswddata, -1, NULL, NULL, &gerr);
1803     if (!wpass) {
1804         goto done;
1805     }
1806 
1807     pi1003.usri1003_password = wpass;
1808     nas = NetUserSetInfo(NULL, user,
1809                          1003, (LPBYTE)&pi1003,
1810                          NULL);
1811 
1812     if (nas != NERR_Success) {
1813         gchar *msg = get_net_error_message(nas);
1814         error_setg(errp, "failed to set password: %s", msg);
1815         g_free(msg);
1816     }
1817 
1818 done:
1819     if (gerr) {
1820         error_setg(errp, QERR_QGA_COMMAND_FAILED, gerr->message);
1821         g_error_free(gerr);
1822     }
1823     g_free(user);
1824     g_free(wpass);
1825     g_free(rawpasswddata);
1826 }
1827 
1828 GuestMemoryBlockList *qmp_guest_get_memory_blocks(Error **errp)
1829 {
1830     error_setg(errp, QERR_UNSUPPORTED);
1831     return NULL;
1832 }
1833 
1834 GuestMemoryBlockResponseList *
1835 qmp_guest_set_memory_blocks(GuestMemoryBlockList *mem_blks, Error **errp)
1836 {
1837     error_setg(errp, QERR_UNSUPPORTED);
1838     return NULL;
1839 }
1840 
1841 GuestMemoryBlockInfo *qmp_guest_get_memory_block_info(Error **errp)
1842 {
1843     error_setg(errp, QERR_UNSUPPORTED);
1844     return NULL;
1845 }
1846 
1847 /* add unsupported commands to the blacklist */
1848 GList *ga_command_blacklist_init(GList *blacklist)
1849 {
1850     const char *list_unsupported[] = {
1851         "guest-suspend-hybrid",
1852         "guest-set-vcpus",
1853         "guest-get-memory-blocks", "guest-set-memory-blocks",
1854         "guest-get-memory-block-size",
1855         NULL};
1856     char **p = (char **)list_unsupported;
1857 
1858     while (*p) {
1859         blacklist = g_list_append(blacklist, g_strdup(*p++));
1860     }
1861 
1862     if (!vss_init(true)) {
1863         g_debug("vss_init failed, vss commands are going to be disabled");
1864         const char *list[] = {
1865             "guest-get-fsinfo", "guest-fsfreeze-status",
1866             "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL};
1867         p = (char **)list;
1868 
1869         while (*p) {
1870             blacklist = g_list_append(blacklist, g_strdup(*p++));
1871         }
1872     }
1873 
1874     return blacklist;
1875 }
1876 
1877 /* register init/cleanup routines for stateful command groups */
1878 void ga_command_state_init(GAState *s, GACommandState *cs)
1879 {
1880     if (!vss_initialized()) {
1881         ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup);
1882     }
1883 }
1884 
1885 /* MINGW is missing two fields: IncomingFrames & OutgoingFrames */
1886 typedef struct _GA_WTSINFOA {
1887     WTS_CONNECTSTATE_CLASS State;
1888     DWORD SessionId;
1889     DWORD IncomingBytes;
1890     DWORD OutgoingBytes;
1891     DWORD IncomingFrames;
1892     DWORD OutgoingFrames;
1893     DWORD IncomingCompressedBytes;
1894     DWORD OutgoingCompressedBy;
1895     CHAR WinStationName[WINSTATIONNAME_LENGTH];
1896     CHAR Domain[DOMAIN_LENGTH];
1897     CHAR UserName[USERNAME_LENGTH + 1];
1898     LARGE_INTEGER ConnectTime;
1899     LARGE_INTEGER DisconnectTime;
1900     LARGE_INTEGER LastInputTime;
1901     LARGE_INTEGER LogonTime;
1902     LARGE_INTEGER CurrentTime;
1903 
1904 } GA_WTSINFOA;
1905 
1906 GuestUserList *qmp_guest_get_users(Error **err)
1907 {
1908 #if (_WIN32_WINNT >= 0x0600)
1909 #define QGA_NANOSECONDS 10000000
1910 
1911     GHashTable *cache = NULL;
1912     GuestUserList *head = NULL, *cur_item = NULL;
1913 
1914     DWORD buffer_size = 0, count = 0, i = 0;
1915     GA_WTSINFOA *info = NULL;
1916     WTS_SESSION_INFOA *entries = NULL;
1917     GuestUserList *item = NULL;
1918     GuestUser *user = NULL;
1919     gpointer value = NULL;
1920     INT64 login = 0;
1921     double login_time = 0;
1922 
1923     cache = g_hash_table_new(g_str_hash, g_str_equal);
1924 
1925     if (WTSEnumerateSessionsA(NULL, 0, 1, &entries, &count)) {
1926         for (i = 0; i < count; ++i) {
1927             buffer_size = 0;
1928             info = NULL;
1929             if (WTSQuerySessionInformationA(
1930                 NULL,
1931                 entries[i].SessionId,
1932                 WTSSessionInfo,
1933                 (LPSTR *)&info,
1934                 &buffer_size
1935             )) {
1936 
1937                 if (strlen(info->UserName) == 0) {
1938                     WTSFreeMemory(info);
1939                     continue;
1940                 }
1941 
1942                 login = info->LogonTime.QuadPart;
1943                 login -= W32_FT_OFFSET;
1944                 login_time = ((double)login) / QGA_NANOSECONDS;
1945 
1946                 if (g_hash_table_contains(cache, info->UserName)) {
1947                     value = g_hash_table_lookup(cache, info->UserName);
1948                     user = (GuestUser *)value;
1949                     if (user->login_time > login_time) {
1950                         user->login_time = login_time;
1951                     }
1952                 } else {
1953                     item = g_new0(GuestUserList, 1);
1954                     item->value = g_new0(GuestUser, 1);
1955 
1956                     item->value->user = g_strdup(info->UserName);
1957                     item->value->domain = g_strdup(info->Domain);
1958                     item->value->has_domain = true;
1959 
1960                     item->value->login_time = login_time;
1961 
1962                     g_hash_table_add(cache, item->value->user);
1963 
1964                     if (!cur_item) {
1965                         head = cur_item = item;
1966                     } else {
1967                         cur_item->next = item;
1968                         cur_item = item;
1969                     }
1970                 }
1971             }
1972             WTSFreeMemory(info);
1973         }
1974         WTSFreeMemory(entries);
1975     }
1976     g_hash_table_destroy(cache);
1977     return head;
1978 #else
1979     error_setg(err, QERR_UNSUPPORTED);
1980     return NULL;
1981 #endif
1982 }
1983 
1984 typedef struct _ga_matrix_lookup_t {
1985     int major;
1986     int minor;
1987     char const *version;
1988     char const *version_id;
1989 } ga_matrix_lookup_t;
1990 
1991 static ga_matrix_lookup_t const WIN_VERSION_MATRIX[2][8] = {
1992     {
1993         /* Desktop editions */
1994         { 5, 0, "Microsoft Windows 2000",   "2000"},
1995         { 5, 1, "Microsoft Windows XP",     "xp"},
1996         { 6, 0, "Microsoft Windows Vista",  "vista"},
1997         { 6, 1, "Microsoft Windows 7"       "7"},
1998         { 6, 2, "Microsoft Windows 8",      "8"},
1999         { 6, 3, "Microsoft Windows 8.1",    "8.1"},
2000         {10, 0, "Microsoft Windows 10",     "10"},
2001         { 0, 0, 0}
2002     },{
2003         /* Server editions */
2004         { 5, 2, "Microsoft Windows Server 2003",        "2003"},
2005         { 6, 0, "Microsoft Windows Server 2008",        "2008"},
2006         { 6, 1, "Microsoft Windows Server 2008 R2",     "2008r2"},
2007         { 6, 2, "Microsoft Windows Server 2012",        "2012"},
2008         { 6, 3, "Microsoft Windows Server 2012 R2",     "2012r2"},
2009         {10, 0, "Microsoft Windows Server 2016",        "2016"},
2010         { 0, 0, 0},
2011         { 0, 0, 0}
2012     }
2013 };
2014 
2015 static void ga_get_win_version(RTL_OSVERSIONINFOEXW *info, Error **errp)
2016 {
2017     typedef NTSTATUS(WINAPI * rtl_get_version_t)(
2018         RTL_OSVERSIONINFOEXW *os_version_info_ex);
2019 
2020     info->dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
2021 
2022     HMODULE module = GetModuleHandle("ntdll");
2023     PVOID fun = GetProcAddress(module, "RtlGetVersion");
2024     if (fun == NULL) {
2025         error_setg(errp, QERR_QGA_COMMAND_FAILED,
2026             "Failed to get address of RtlGetVersion");
2027         return;
2028     }
2029 
2030     rtl_get_version_t rtl_get_version = (rtl_get_version_t)fun;
2031     rtl_get_version(info);
2032     return;
2033 }
2034 
2035 static char *ga_get_win_name(OSVERSIONINFOEXW const *os_version, bool id)
2036 {
2037     DWORD major = os_version->dwMajorVersion;
2038     DWORD minor = os_version->dwMinorVersion;
2039     int tbl_idx = (os_version->wProductType != VER_NT_WORKSTATION);
2040     ga_matrix_lookup_t const *table = WIN_VERSION_MATRIX[tbl_idx];
2041     while (table->version != NULL) {
2042         if (major == table->major && minor == table->minor) {
2043             if (id) {
2044                 return g_strdup(table->version_id);
2045             } else {
2046                 return g_strdup(table->version);
2047             }
2048         }
2049         ++table;
2050     }
2051     slog("failed to lookup Windows version: major=%lu, minor=%lu",
2052         major, minor);
2053     return g_strdup("N/A");
2054 }
2055 
2056 static char *ga_get_win_product_name(Error **errp)
2057 {
2058     HKEY key = NULL;
2059     DWORD size = 128;
2060     char *result = g_malloc0(size);
2061     LONG err = ERROR_SUCCESS;
2062 
2063     err = RegOpenKeyA(HKEY_LOCAL_MACHINE,
2064                       "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion",
2065                       &key);
2066     if (err != ERROR_SUCCESS) {
2067         error_setg_win32(errp, err, "failed to open registry key");
2068         goto fail;
2069     }
2070 
2071     err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2072                             (LPBYTE)result, &size);
2073     if (err == ERROR_MORE_DATA) {
2074         slog("ProductName longer than expected (%lu bytes), retrying",
2075                 size);
2076         g_free(result);
2077         result = NULL;
2078         if (size > 0) {
2079             result = g_malloc0(size);
2080             err = RegQueryValueExA(key, "ProductName", NULL, NULL,
2081                                     (LPBYTE)result, &size);
2082         }
2083     }
2084     if (err != ERROR_SUCCESS) {
2085         error_setg_win32(errp, err, "failed to retrive ProductName");
2086         goto fail;
2087     }
2088 
2089     return result;
2090 
2091 fail:
2092     g_free(result);
2093     return NULL;
2094 }
2095 
2096 static char *ga_get_current_arch(void)
2097 {
2098     SYSTEM_INFO info;
2099     GetNativeSystemInfo(&info);
2100     char *result = NULL;
2101     switch (info.wProcessorArchitecture) {
2102     case PROCESSOR_ARCHITECTURE_AMD64:
2103         result = g_strdup("x86_64");
2104         break;
2105     case PROCESSOR_ARCHITECTURE_ARM:
2106         result = g_strdup("arm");
2107         break;
2108     case PROCESSOR_ARCHITECTURE_IA64:
2109         result = g_strdup("ia64");
2110         break;
2111     case PROCESSOR_ARCHITECTURE_INTEL:
2112         result = g_strdup("x86");
2113         break;
2114     case PROCESSOR_ARCHITECTURE_UNKNOWN:
2115     default:
2116         slog("unknown processor architecture 0x%0x",
2117             info.wProcessorArchitecture);
2118         result = g_strdup("unknown");
2119         break;
2120     }
2121     return result;
2122 }
2123 
2124 GuestOSInfo *qmp_guest_get_osinfo(Error **errp)
2125 {
2126     Error *local_err = NULL;
2127     OSVERSIONINFOEXW os_version = {0};
2128     bool server;
2129     char *product_name;
2130     GuestOSInfo *info;
2131 
2132     ga_get_win_version(&os_version, &local_err);
2133     if (local_err) {
2134         error_propagate(errp, local_err);
2135         return NULL;
2136     }
2137 
2138     server = os_version.wProductType != VER_NT_WORKSTATION;
2139     product_name = ga_get_win_product_name(&local_err);
2140     if (product_name == NULL) {
2141         error_propagate(errp, local_err);
2142         return NULL;
2143     }
2144 
2145     info = g_new0(GuestOSInfo, 1);
2146 
2147     info->has_kernel_version = true;
2148     info->kernel_version = g_strdup_printf("%lu.%lu",
2149         os_version.dwMajorVersion,
2150         os_version.dwMinorVersion);
2151     info->has_kernel_release = true;
2152     info->kernel_release = g_strdup_printf("%lu",
2153         os_version.dwBuildNumber);
2154     info->has_machine = true;
2155     info->machine = ga_get_current_arch();
2156 
2157     info->has_id = true;
2158     info->id = g_strdup("mswindows");
2159     info->has_name = true;
2160     info->name = g_strdup("Microsoft Windows");
2161     info->has_pretty_name = true;
2162     info->pretty_name = product_name;
2163     info->has_version = true;
2164     info->version = ga_get_win_name(&os_version, false);
2165     info->has_version_id = true;
2166     info->version_id = ga_get_win_name(&os_version, true);
2167     info->has_variant = true;
2168     info->variant = g_strdup(server ? "server" : "client");
2169     info->has_variant_id = true;
2170     info->variant_id = g_strdup(server ? "server" : "client");
2171 
2172     return info;
2173 }
2174