2 * QEMU Guest Agent win32-specific command implementations
4 * Copyright IBM Corp. 2012
7 * Michael Roth <mdroth@linux.vnet.ibm.com>
8 * Gal Hammer <ghammer@redhat.com>
10 * This work is licensed under the terms of the GNU GPL, version 2 or later.
11 * See the COPYING file in the top-level directory.
14 #include "qemu/osdep.h"
21 #ifdef CONFIG_QGA_NTDDSCSI
29 #include "qga/guest-agent-core.h"
30 #include "qga/vss-win32.h"
31 #include "qga-qmp-commands.h"
32 #include "qapi/qmp/qerror.h"
33 #include "qemu/queue.h"
34 #include "qemu/host-utils.h"
35 #include "qemu/base64.h"
37 #ifndef SHTDN_REASON_FLAG_PLANNED
38 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
41 /* multiple of 100 nanoseconds elapsed between windows baseline
42 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
43 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
44 (365 * (1970 - 1601) + \
45 (1970 - 1601) / 4 - 3))
47 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
49 typedef struct GuestFileHandle
{
52 QTAILQ_ENTRY(GuestFileHandle
) next
;
56 QTAILQ_HEAD(, GuestFileHandle
) filehandles
;
57 } guest_file_state
= {
58 .filehandles
= QTAILQ_HEAD_INITIALIZER(guest_file_state
.filehandles
),
61 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
63 typedef struct OpenFlags
{
66 DWORD creation_disposition
;
68 static OpenFlags guest_file_open_modes
[] = {
69 {"r", GENERIC_READ
, OPEN_EXISTING
},
70 {"rb", GENERIC_READ
, OPEN_EXISTING
},
71 {"w", GENERIC_WRITE
, CREATE_ALWAYS
},
72 {"wb", GENERIC_WRITE
, CREATE_ALWAYS
},
73 {"a", FILE_GENERIC_APPEND
, OPEN_ALWAYS
},
74 {"r+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
75 {"rb+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
76 {"r+b", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
77 {"w+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
78 {"wb+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
79 {"w+b", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
80 {"a+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
81 {"ab+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
82 {"a+b", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
}
85 static OpenFlags
*find_open_flag(const char *mode_str
)
90 for (mode
= 0; mode
< ARRAY_SIZE(guest_file_open_modes
); ++mode
) {
91 OpenFlags
*flags
= guest_file_open_modes
+ mode
;
93 if (strcmp(flags
->forms
, mode_str
) == 0) {
98 error_setg(errp
, "invalid file open mode '%s'", mode_str
);
102 static int64_t guest_file_handle_add(HANDLE fh
, Error
**errp
)
104 GuestFileHandle
*gfh
;
107 handle
= ga_get_fd_handle(ga_state
, errp
);
111 gfh
= g_new0(GuestFileHandle
, 1);
114 QTAILQ_INSERT_TAIL(&guest_file_state
.filehandles
, gfh
, next
);
119 static GuestFileHandle
*guest_file_handle_find(int64_t id
, Error
**errp
)
121 GuestFileHandle
*gfh
;
122 QTAILQ_FOREACH(gfh
, &guest_file_state
.filehandles
, next
) {
127 error_setg(errp
, "handle '%" PRId64
"' has not been found", id
);
131 static void handle_set_nonblocking(HANDLE fh
)
133 DWORD file_type
, pipe_state
;
134 file_type
= GetFileType(fh
);
135 if (file_type
!= FILE_TYPE_PIPE
) {
138 /* If file_type == FILE_TYPE_PIPE, according to MSDN
139 * the specified file is socket or named pipe */
140 if (!GetNamedPipeHandleState(fh
, &pipe_state
, NULL
,
141 NULL
, NULL
, NULL
, 0)) {
144 /* The fd is named pipe fd */
145 if (pipe_state
& PIPE_NOWAIT
) {
149 pipe_state
|= PIPE_NOWAIT
;
150 SetNamedPipeHandleState(fh
, &pipe_state
, NULL
, NULL
);
153 int64_t qmp_guest_file_open(const char *path
, bool has_mode
,
154 const char *mode
, Error
**errp
)
158 HANDLE templ_file
= NULL
;
159 DWORD share_mode
= FILE_SHARE_READ
;
160 DWORD flags_and_attr
= FILE_ATTRIBUTE_NORMAL
;
161 LPSECURITY_ATTRIBUTES sa_attr
= NULL
;
162 OpenFlags
*guest_flags
;
167 slog("guest-file-open called, filepath: %s, mode: %s", path
, mode
);
168 guest_flags
= find_open_flag(mode
);
169 if (guest_flags
== NULL
) {
170 error_setg(errp
, "invalid file open mode");
174 fh
= CreateFile(path
, guest_flags
->desired_access
, share_mode
, sa_attr
,
175 guest_flags
->creation_disposition
, flags_and_attr
,
177 if (fh
== INVALID_HANDLE_VALUE
) {
178 error_setg_win32(errp
, GetLastError(), "failed to open file '%s'",
183 /* set fd non-blocking to avoid common use cases (like reading from a
184 * named pipe) from hanging the agent
186 handle_set_nonblocking(fh
);
188 fd
= guest_file_handle_add(fh
, errp
);
191 error_setg(errp
, "failed to add handle to qmp handle table");
195 slog("guest-file-open, handle: % " PRId64
, fd
);
199 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
202 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
203 slog("guest-file-close called, handle: %" PRId64
, handle
);
207 ret
= CloseHandle(gfh
->fh
);
209 error_setg_win32(errp
, GetLastError(), "failed close handle");
213 QTAILQ_REMOVE(&guest_file_state
.filehandles
, gfh
, next
);
217 static void acquire_privilege(const char *name
, Error
**errp
)
220 TOKEN_PRIVILEGES priv
;
221 Error
*local_err
= NULL
;
223 if (OpenProcessToken(GetCurrentProcess(),
224 TOKEN_ADJUST_PRIVILEGES
|TOKEN_QUERY
, &token
))
226 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
227 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
228 "no luid for requested privilege");
232 priv
.PrivilegeCount
= 1;
233 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
235 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
236 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
237 "unable to acquire requested privilege");
242 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
243 "failed to open privilege token");
250 error_propagate(errp
, local_err
);
253 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
256 Error
*local_err
= NULL
;
258 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
260 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
261 "failed to dispatch asynchronous command");
262 error_propagate(errp
, local_err
);
266 void qmp_guest_shutdown(bool has_mode
, const char *mode
, Error
**errp
)
268 Error
*local_err
= NULL
;
269 UINT shutdown_flag
= EWX_FORCE
;
271 slog("guest-shutdown called, mode: %s", mode
);
273 if (!has_mode
|| strcmp(mode
, "powerdown") == 0) {
274 shutdown_flag
|= EWX_POWEROFF
;
275 } else if (strcmp(mode
, "halt") == 0) {
276 shutdown_flag
|= EWX_SHUTDOWN
;
277 } else if (strcmp(mode
, "reboot") == 0) {
278 shutdown_flag
|= EWX_REBOOT
;
280 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
281 "halt|powerdown|reboot");
285 /* Request a shutdown privilege, but try to shut down the system
287 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
289 error_propagate(errp
, local_err
);
293 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
294 slog("guest-shutdown failed: %lu", GetLastError());
295 error_setg(errp
, QERR_UNDEFINED_ERROR
);
299 GuestFileRead
*qmp_guest_file_read(int64_t handle
, bool has_count
,
300 int64_t count
, Error
**errp
)
302 GuestFileRead
*read_data
= NULL
;
307 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
313 count
= QGA_READ_COUNT_DEFAULT
;
314 } else if (count
< 0) {
315 error_setg(errp
, "value '%" PRId64
316 "' is invalid for argument count", count
);
321 buf
= g_malloc0(count
+1);
322 is_ok
= ReadFile(fh
, buf
, count
, &read_count
, NULL
);
324 error_setg_win32(errp
, GetLastError(), "failed to read file");
325 slog("guest-file-read failed, handle %" PRId64
, handle
);
328 read_data
= g_new0(GuestFileRead
, 1);
329 read_data
->count
= (size_t)read_count
;
330 read_data
->eof
= read_count
== 0;
332 if (read_count
!= 0) {
333 read_data
->buf_b64
= g_base64_encode(buf
, read_count
);
341 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
342 bool has_count
, int64_t count
,
345 GuestFileWrite
*write_data
= NULL
;
350 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
357 buf
= qbase64_decode(buf_b64
, -1, &buf_len
, errp
);
364 } else if (count
< 0 || count
> buf_len
) {
365 error_setg(errp
, "value '%" PRId64
366 "' is invalid for argument count", count
);
370 is_ok
= WriteFile(fh
, buf
, count
, &write_count
, NULL
);
372 error_setg_win32(errp
, GetLastError(), "failed to write to file");
373 slog("guest-file-write-failed, handle: %" PRId64
, handle
);
375 write_data
= g_new0(GuestFileWrite
, 1);
376 write_data
->count
= (size_t) write_count
;
384 GuestFileSeek
*qmp_guest_file_seek(int64_t handle
, int64_t offset
,
385 GuestFileWhence
*whence_code
,
388 GuestFileHandle
*gfh
;
389 GuestFileSeek
*seek_data
;
391 LARGE_INTEGER new_pos
, off_pos
;
392 off_pos
.QuadPart
= offset
;
397 gfh
= guest_file_handle_find(handle
, errp
);
402 /* We stupidly exposed 'whence':'int' in our qapi */
403 whence
= ga_parse_whence(whence_code
, &err
);
405 error_propagate(errp
, err
);
410 res
= SetFilePointerEx(fh
, off_pos
, &new_pos
, whence
);
412 error_setg_win32(errp
, GetLastError(), "failed to seek file");
415 seek_data
= g_new0(GuestFileSeek
, 1);
416 seek_data
->position
= new_pos
.QuadPart
;
420 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
423 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
429 if (!FlushFileBuffers(fh
)) {
430 error_setg_win32(errp
, GetLastError(), "failed to flush file");
434 #ifdef CONFIG_QGA_NTDDSCSI
436 static STORAGE_BUS_TYPE win2qemu
[] = {
437 [BusTypeUnknown
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
438 [BusTypeScsi
] = GUEST_DISK_BUS_TYPE_SCSI
,
439 [BusTypeAtapi
] = GUEST_DISK_BUS_TYPE_IDE
,
440 [BusTypeAta
] = GUEST_DISK_BUS_TYPE_IDE
,
441 [BusType1394
] = GUEST_DISK_BUS_TYPE_IEEE1394
,
442 [BusTypeSsa
] = GUEST_DISK_BUS_TYPE_SSA
,
443 [BusTypeFibre
] = GUEST_DISK_BUS_TYPE_SSA
,
444 [BusTypeUsb
] = GUEST_DISK_BUS_TYPE_USB
,
445 [BusTypeRAID
] = GUEST_DISK_BUS_TYPE_RAID
,
446 #if (_WIN32_WINNT >= 0x0600)
447 [BusTypeiScsi
] = GUEST_DISK_BUS_TYPE_ISCSI
,
448 [BusTypeSas
] = GUEST_DISK_BUS_TYPE_SAS
,
449 [BusTypeSata
] = GUEST_DISK_BUS_TYPE_SATA
,
450 [BusTypeSd
] = GUEST_DISK_BUS_TYPE_SD
,
451 [BusTypeMmc
] = GUEST_DISK_BUS_TYPE_MMC
,
453 #if (_WIN32_WINNT >= 0x0601)
454 [BusTypeVirtual
] = GUEST_DISK_BUS_TYPE_VIRTUAL
,
455 [BusTypeFileBackedVirtual
] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL
,
459 static GuestDiskBusType
find_bus_type(STORAGE_BUS_TYPE bus
)
461 if (bus
> ARRAY_SIZE(win2qemu
) || (int)bus
< 0) {
462 return GUEST_DISK_BUS_TYPE_UNKNOWN
;
464 return win2qemu
[(int)bus
];
467 DEFINE_GUID(GUID_DEVINTERFACE_VOLUME
,
468 0x53f5630dL
, 0xb6bf, 0x11d0, 0x94, 0xf2,
469 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
471 static GuestPCIAddress
*get_pci_info(char *guid
, Error
**errp
)
474 SP_DEVINFO_DATA dev_info_data
;
477 char dev_name
[MAX_PATH
];
479 GuestPCIAddress
*pci
= NULL
;
480 char *name
= g_strdup(&guid
[4]);
482 if (!QueryDosDevice(name
, dev_name
, ARRAY_SIZE(dev_name
))) {
483 error_setg_win32(errp
, GetLastError(), "failed to get dos device name");
487 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_VOLUME
, 0, 0,
488 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
489 if (dev_info
== INVALID_HANDLE_VALUE
) {
490 error_setg_win32(errp
, GetLastError(), "failed to get devices tree");
494 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
495 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
496 DWORD addr
, bus
, slot
, func
, dev
, data
, size2
;
497 while (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
498 SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
,
499 &data
, (PBYTE
)buffer
, size
,
501 size
= MAX(size
, size2
);
502 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
504 /* Double the size to avoid problems on
505 * W2k MBCS systems per KB 888609.
506 * https://support.microsoft.com/en-us/kb/259695 */
507 buffer
= g_malloc(size
* 2);
509 error_setg_win32(errp
, GetLastError(),
510 "failed to get device name");
515 if (g_strcmp0(buffer
, dev_name
)) {
519 /* There is no need to allocate buffer in the next functions. The size
520 * is known and ULONG according to
521 * https://support.microsoft.com/en-us/kb/253232
522 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
524 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
525 SPDRP_BUSNUMBER
, &data
, (PBYTE
)&bus
, size
, NULL
)) {
529 /* The function retrieves the device's address. This value will be
530 * transformed into device function and number */
531 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
532 SPDRP_ADDRESS
, &data
, (PBYTE
)&addr
, size
, NULL
)) {
536 /* This call returns UINumber of DEVICE_CAPABILITIES structure.
537 * This number is typically a user-perceived slot number. */
538 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
539 SPDRP_UI_NUMBER
, &data
, (PBYTE
)&slot
, size
, NULL
)) {
543 /* SetupApi gives us the same information as driver with
544 * IoGetDeviceProperty. According to Microsoft
545 * https://support.microsoft.com/en-us/kb/253232
546 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF);
547 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF);
548 * SPDRP_ADDRESS is propertyAddress, so we do the same.*/
550 func
= addr
& 0x0000FFFF;
551 dev
= (addr
>> 16) & 0x0000FFFF;
552 pci
= g_malloc0(sizeof(*pci
));
555 pci
->function
= func
;
565 static int get_disk_bus_type(HANDLE vol_h
, Error
**errp
)
567 STORAGE_PROPERTY_QUERY query
;
568 STORAGE_DEVICE_DESCRIPTOR
*dev_desc
, buf
;
572 dev_desc
->Size
= sizeof(buf
);
573 query
.PropertyId
= StorageDeviceProperty
;
574 query
.QueryType
= PropertyStandardQuery
;
576 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
577 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
578 dev_desc
->Size
, &received
, NULL
)) {
579 error_setg_win32(errp
, GetLastError(), "failed to get bus type");
583 return dev_desc
->BusType
;
586 /* VSS provider works with volumes, thus there is no difference if
587 * the volume consist of spanned disks. Info about the first disk in the
588 * volume is returned for the spanned disk group (LVM) */
589 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
591 GuestDiskAddressList
*list
= NULL
;
592 GuestDiskAddress
*disk
;
593 SCSI_ADDRESS addr
, *scsi_ad
;
599 char *name
= g_strndup(guid
, strlen(guid
)-1);
601 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
603 if (vol_h
== INVALID_HANDLE_VALUE
) {
604 error_setg_win32(errp
, GetLastError(), "failed to open volume");
608 bus
= get_disk_bus_type(vol_h
, errp
);
613 disk
= g_malloc0(sizeof(*disk
));
614 disk
->bus_type
= find_bus_type(bus
);
615 if (bus
== BusTypeScsi
|| bus
== BusTypeAta
|| bus
== BusTypeRAID
616 #if (_WIN32_WINNT >= 0x0600)
617 /* This bus type is not supported before Windows Server 2003 SP1 */
621 /* We are able to use the same ioctls for different bus types
622 * according to Microsoft docs
623 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
624 if (DeviceIoControl(vol_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
625 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
626 disk
->unit
= addr
.Lun
;
627 disk
->target
= addr
.TargetId
;
628 disk
->bus
= addr
.PathId
;
629 disk
->pci_controller
= get_pci_info(name
, errp
);
631 /* We do not set error in this case, because we still have enough
632 * information about volume. */
634 disk
->pci_controller
= NULL
;
637 list
= g_malloc0(sizeof(*list
));
649 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
654 #endif /* CONFIG_QGA_NTDDSCSI */
656 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
659 char mnt
, *mnt_point
;
661 char vol_info
[MAX_PATH
+1];
663 GuestFilesystemInfo
*fs
= NULL
;
665 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
666 if (GetLastError() != ERROR_MORE_DATA
) {
667 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
671 mnt_point
= g_malloc(info_size
+ 1);
672 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
674 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
678 len
= strlen(mnt_point
);
679 mnt_point
[len
] = '\\';
680 mnt_point
[len
+1] = 0;
681 if (!GetVolumeInformation(mnt_point
, vol_info
, sizeof(vol_info
), NULL
, NULL
,
682 NULL
, (LPSTR
)&fs_name
, sizeof(fs_name
))) {
683 if (GetLastError() != ERROR_NOT_READY
) {
684 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
689 fs_name
[sizeof(fs_name
) - 1] = 0;
690 fs
= g_malloc(sizeof(*fs
));
691 fs
->name
= g_strdup(guid
);
693 fs
->mountpoint
= g_strdup("System Reserved");
695 fs
->mountpoint
= g_strndup(mnt_point
, len
);
697 fs
->type
= g_strdup(fs_name
);
698 fs
->disk
= build_guest_disk_info(guid
, errp
);
704 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
707 GuestFilesystemInfoList
*new, *ret
= NULL
;
710 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
711 if (vol_h
== INVALID_HANDLE_VALUE
) {
712 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
717 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, errp
);
721 new = g_malloc(sizeof(*ret
));
725 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
727 if (GetLastError() != ERROR_NO_MORE_FILES
) {
728 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
731 FindVolumeClose(vol_h
);
736 * Return status of freeze/thaw
738 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
740 if (!vss_initialized()) {
741 error_setg(errp
, QERR_UNSUPPORTED
);
745 if (ga_is_frozen(ga_state
)) {
746 return GUEST_FSFREEZE_STATUS_FROZEN
;
749 return GUEST_FSFREEZE_STATUS_THAWED
;
753 * Freeze local file systems using Volume Shadow-copy Service.
754 * The frozen state is limited for up to 10 seconds by VSS.
756 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
759 Error
*local_err
= NULL
;
761 if (!vss_initialized()) {
762 error_setg(errp
, QERR_UNSUPPORTED
);
766 slog("guest-fsfreeze called");
768 /* cannot risk guest agent blocking itself on a write in this state */
769 ga_set_frozen(ga_state
);
771 qga_vss_fsfreeze(&i
, &local_err
, true);
773 error_propagate(errp
, local_err
);
781 qmp_guest_fsfreeze_thaw(&local_err
);
783 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
784 error_free(local_err
);
789 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
790 strList
*mountpoints
,
793 error_setg(errp
, QERR_UNSUPPORTED
);
799 * Thaw local file systems using Volume Shadow-copy Service.
801 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
805 if (!vss_initialized()) {
806 error_setg(errp
, QERR_UNSUPPORTED
);
810 qga_vss_fsfreeze(&i
, errp
, false);
812 ga_unset_frozen(ga_state
);
816 static void guest_fsfreeze_cleanup(void)
820 if (!vss_initialized()) {
824 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
825 qmp_guest_fsfreeze_thaw(&err
);
827 slog("failed to clean up frozen filesystems: %s",
828 error_get_pretty(err
));
837 * Walk list of mounted file systems in the guest, and discard unused
840 GuestFilesystemTrimResponse
*
841 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
843 GuestFilesystemTrimResponse
*resp
;
845 WCHAR guid
[MAX_PATH
] = L
"";
847 handle
= FindFirstVolumeW(guid
, ARRAYSIZE(guid
));
848 if (handle
== INVALID_HANDLE_VALUE
) {
849 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
853 resp
= g_new0(GuestFilesystemTrimResponse
, 1);
856 GuestFilesystemTrimResult
*res
;
857 GuestFilesystemTrimResultList
*list
;
859 DWORD char_count
= 0;
864 GetVolumePathNamesForVolumeNameW(guid
, NULL
, 0, &char_count
);
866 if (GetLastError() != ERROR_MORE_DATA
) {
869 if (GetDriveTypeW(guid
) != DRIVE_FIXED
) {
873 uc_path
= g_malloc(sizeof(WCHAR
) * char_count
);
874 if (!GetVolumePathNamesForVolumeNameW(guid
, uc_path
, char_count
,
875 &char_count
) || !*uc_path
) {
876 /* strange, but this condition could be faced even with size == 2 */
881 res
= g_new0(GuestFilesystemTrimResult
, 1);
883 path
= g_utf16_to_utf8(uc_path
, char_count
, NULL
, NULL
, &gerr
);
888 res
->has_error
= true;
889 res
->error
= g_strdup(gerr
->message
);
896 list
= g_new0(GuestFilesystemTrimResultList
, 1);
898 list
->next
= resp
->paths
;
902 memset(argv
, 0, sizeof(argv
));
903 argv
[0] = (gchar
*)"defrag.exe";
904 argv
[1] = (gchar
*)"/L";
907 if (!g_spawn_sync(NULL
, argv
, NULL
, G_SPAWN_SEARCH_PATH
, NULL
, NULL
,
908 &out
/* stdout */, NULL
/* stdin */,
910 res
->has_error
= true;
911 res
->error
= g_strdup(gerr
->message
);
914 /* defrag.exe is UGLY. Exit code is ALWAYS zero.
915 Error is reported in the output with something like
916 (x89000020) etc code in the stdout */
919 gchar
**lines
= g_strsplit(out
, "\r\n", 0);
922 for (i
= 0; lines
[i
] != NULL
; i
++) {
923 if (g_strstr_len(lines
[i
], -1, "(0x") == NULL
) {
926 res
->has_error
= true;
927 res
->error
= g_strdup(lines
[i
]);
932 } while (FindNextVolumeW(handle
, guid
, ARRAYSIZE(guid
)));
934 FindVolumeClose(handle
);
939 GUEST_SUSPEND_MODE_DISK
,
940 GUEST_SUSPEND_MODE_RAM
943 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
945 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
946 Error
*local_err
= NULL
;
948 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
949 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
950 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
951 "failed to determine guest suspend capabilities");
956 case GUEST_SUSPEND_MODE_DISK
:
957 if (!sys_pwr_caps
.SystemS4
) {
958 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
959 "suspend-to-disk not supported by OS");
962 case GUEST_SUSPEND_MODE_RAM
:
963 if (!sys_pwr_caps
.SystemS3
) {
964 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
965 "suspend-to-ram not supported by OS");
969 error_setg(&local_err
, QERR_INVALID_PARAMETER_VALUE
, "mode",
974 error_propagate(errp
, local_err
);
977 static DWORD WINAPI
do_suspend(LPVOID opaque
)
979 GuestSuspendMode
*mode
= opaque
;
982 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
983 slog("failed to suspend guest, %lu", GetLastError());
990 void qmp_guest_suspend_disk(Error
**errp
)
992 Error
*local_err
= NULL
;
993 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
995 *mode
= GUEST_SUSPEND_MODE_DISK
;
996 check_suspend_mode(*mode
, &local_err
);
997 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
998 execute_async(do_suspend
, mode
, &local_err
);
1001 error_propagate(errp
, local_err
);
1006 void qmp_guest_suspend_ram(Error
**errp
)
1008 Error
*local_err
= NULL
;
1009 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
1011 *mode
= GUEST_SUSPEND_MODE_RAM
;
1012 check_suspend_mode(*mode
, &local_err
);
1013 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
1014 execute_async(do_suspend
, mode
, &local_err
);
1017 error_propagate(errp
, local_err
);
1022 void qmp_guest_suspend_hybrid(Error
**errp
)
1024 error_setg(errp
, QERR_UNSUPPORTED
);
1027 static IP_ADAPTER_ADDRESSES
*guest_get_adapters_addresses(Error
**errp
)
1029 IP_ADAPTER_ADDRESSES
*adptr_addrs
= NULL
;
1030 ULONG adptr_addrs_len
= 0;
1033 /* Call the first time to get the adptr_addrs_len. */
1034 GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1035 NULL
, adptr_addrs
, &adptr_addrs_len
);
1037 adptr_addrs
= g_malloc(adptr_addrs_len
);
1038 ret
= GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
1039 NULL
, adptr_addrs
, &adptr_addrs_len
);
1040 if (ret
!= ERROR_SUCCESS
) {
1041 error_setg_win32(errp
, ret
, "failed to get adapters addresses");
1042 g_free(adptr_addrs
);
1048 static char *guest_wctomb_dup(WCHAR
*wstr
)
1053 i
= wcslen(wstr
) + 1;
1055 WideCharToMultiByte(CP_ACP
, WC_COMPOSITECHECK
,
1056 wstr
, -1, str
, i
, NULL
, NULL
);
1060 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
,
1063 char addr_str
[INET6_ADDRSTRLEN
+ INET_ADDRSTRLEN
];
1067 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
||
1068 ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1069 len
= sizeof(addr_str
);
1070 ret
= WSAAddressToString(ip_addr
->Address
.lpSockaddr
,
1071 ip_addr
->Address
.iSockaddrLength
,
1076 error_setg_win32(errp
, WSAGetLastError(),
1077 "failed address presentation form conversion");
1080 return g_strdup(addr_str
);
1085 #if (_WIN32_WINNT >= 0x0600)
1086 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1088 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
1089 * field to obtain the prefix.
1091 return ip_addr
->OnLinkPrefixLength
;
1094 /* When using the Windows XP and 2003 build environment, do the best we can to
1095 * figure out the prefix.
1097 static IP_ADAPTER_INFO
*guest_get_adapters_info(void)
1099 IP_ADAPTER_INFO
*adptr_info
= NULL
;
1100 ULONG adptr_info_len
= 0;
1103 /* Call the first time to get the adptr_info_len. */
1104 GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1106 adptr_info
= g_malloc(adptr_info_len
);
1107 ret
= GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1108 if (ret
!= ERROR_SUCCESS
) {
1115 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1117 int64_t prefix
= -1; /* Use for AF_INET6 and unknown/undetermined values. */
1118 IP_ADAPTER_INFO
*adptr_info
, *info
;
1122 if (ip_addr
->Address
.lpSockaddr
->sa_family
!= AF_INET
) {
1125 adptr_info
= guest_get_adapters_info();
1126 if (adptr_info
== NULL
) {
1130 /* Match up the passed in ip_addr with one found in adaptr_info.
1131 * The matching one in adptr_info will have the netmask.
1133 p
= &((struct sockaddr_in
*)ip_addr
->Address
.lpSockaddr
)->sin_addr
;
1134 for (info
= adptr_info
; info
; info
= info
->Next
) {
1135 for (ip
= &info
->IpAddressList
; ip
; ip
= ip
->Next
) {
1136 if (p
->S_un
.S_addr
== inet_addr(ip
->IpAddress
.String
)) {
1137 prefix
= ctpop32(inet_addr(ip
->IpMask
.String
));
1148 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
1150 IP_ADAPTER_ADDRESSES
*adptr_addrs
, *addr
;
1151 IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
= NULL
;
1152 GuestNetworkInterfaceList
*head
= NULL
, *cur_item
= NULL
;
1153 GuestIpAddressList
*head_addr
, *cur_addr
;
1154 GuestNetworkInterfaceList
*info
;
1155 GuestIpAddressList
*address_item
= NULL
;
1156 unsigned char *mac_addr
;
1162 adptr_addrs
= guest_get_adapters_addresses(errp
);
1163 if (adptr_addrs
== NULL
) {
1167 /* Make WSA APIs available. */
1168 wsa_version
= MAKEWORD(2, 2);
1169 ret
= WSAStartup(wsa_version
, &wsa_data
);
1171 error_setg_win32(errp
, ret
, "failed socket startup");
1175 for (addr
= adptr_addrs
; addr
; addr
= addr
->Next
) {
1176 info
= g_malloc0(sizeof(*info
));
1178 if (cur_item
== NULL
) {
1179 head
= cur_item
= info
;
1181 cur_item
->next
= info
;
1185 info
->value
= g_malloc0(sizeof(*info
->value
));
1186 info
->value
->name
= guest_wctomb_dup(addr
->FriendlyName
);
1188 if (addr
->PhysicalAddressLength
!= 0) {
1189 mac_addr
= addr
->PhysicalAddress
;
1191 info
->value
->hardware_address
=
1192 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1193 (int) mac_addr
[0], (int) mac_addr
[1],
1194 (int) mac_addr
[2], (int) mac_addr
[3],
1195 (int) mac_addr
[4], (int) mac_addr
[5]);
1197 info
->value
->has_hardware_address
= true;
1202 for (ip_addr
= addr
->FirstUnicastAddress
;
1204 ip_addr
= ip_addr
->Next
) {
1205 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1206 if (addr_str
== NULL
) {
1210 address_item
= g_malloc0(sizeof(*address_item
));
1213 head_addr
= cur_addr
= address_item
;
1215 cur_addr
->next
= address_item
;
1216 cur_addr
= address_item
;
1219 address_item
->value
= g_malloc0(sizeof(*address_item
->value
));
1220 address_item
->value
->ip_address
= addr_str
;
1221 address_item
->value
->prefix
= guest_ip_prefix(ip_addr
);
1222 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1223 address_item
->value
->ip_address_type
=
1224 GUEST_IP_ADDRESS_TYPE_IPV4
;
1225 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1226 address_item
->value
->ip_address_type
=
1227 GUEST_IP_ADDRESS_TYPE_IPV6
;
1231 info
->value
->has_ip_addresses
= true;
1232 info
->value
->ip_addresses
= head_addr
;
1237 g_free(adptr_addrs
);
1241 int64_t qmp_guest_get_time(Error
**errp
)
1243 SYSTEMTIME ts
= {0};
1247 if (ts
.wYear
< 1601 || ts
.wYear
> 30827) {
1248 error_setg(errp
, "Failed to get time");
1252 if (!SystemTimeToFileTime(&ts
, &tf
)) {
1253 error_setg(errp
, "Failed to convert system time: %d", (int)GetLastError());
1257 return ((((int64_t)tf
.dwHighDateTime
<< 32) | tf
.dwLowDateTime
)
1258 - W32_FT_OFFSET
) * 100;
1261 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
1263 Error
*local_err
= NULL
;
1269 /* Unfortunately, Windows libraries don't provide an easy way to access
1272 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1274 error_setg(errp
, "Time argument is required on this platform");
1278 /* Validate time passed by user. */
1279 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
1280 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
1284 time
= time_ns
/ 100 + W32_FT_OFFSET
;
1286 tf
.dwLowDateTime
= (DWORD
) time
;
1287 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
1289 if (!FileTimeToSystemTime(&tf
, &ts
)) {
1290 error_setg(errp
, "Failed to convert system time %d",
1291 (int)GetLastError());
1295 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
1297 error_propagate(errp
, local_err
);
1301 if (!SetSystemTime(&ts
)) {
1302 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
1307 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
1309 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION pslpi
, ptr
;
1311 GuestLogicalProcessorList
*head
, **link
;
1312 Error
*local_err
= NULL
;
1321 if ((GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) &&
1322 (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) &&
1323 (length
> sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
))) {
1324 ptr
= pslpi
= g_malloc0(length
);
1325 if (GetLogicalProcessorInformation(pslpi
, &length
) == FALSE
) {
1326 error_setg(&local_err
, "Failed to get processor information: %d",
1327 (int)GetLastError());
1330 error_setg(&local_err
,
1331 "Failed to get processor information buffer length: %d",
1332 (int)GetLastError());
1335 while ((local_err
== NULL
) && (length
> 0)) {
1336 if (pslpi
->Relationship
== RelationProcessorCore
) {
1337 ULONG_PTR cpu_bits
= pslpi
->ProcessorMask
;
1339 while (cpu_bits
> 0) {
1340 if (!!(cpu_bits
& 1)) {
1341 GuestLogicalProcessor
*vcpu
;
1342 GuestLogicalProcessorList
*entry
;
1344 vcpu
= g_malloc0(sizeof *vcpu
);
1345 vcpu
->logical_id
= current
++;
1346 vcpu
->online
= true;
1347 vcpu
->has_can_offline
= false;
1349 entry
= g_malloc0(sizeof *entry
);
1350 entry
->value
= vcpu
;
1353 link
= &entry
->next
;
1358 length
-= sizeof(SYSTEM_LOGICAL_PROCESSOR_INFORMATION
);
1359 pslpi
++; /* next entry */
1364 if (local_err
== NULL
) {
1368 /* there's no guest with zero VCPUs */
1369 error_setg(&local_err
, "Guest reported zero VCPUs");
1372 qapi_free_GuestLogicalProcessorList(head
);
1373 error_propagate(errp
, local_err
);
1377 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
1379 error_setg(errp
, QERR_UNSUPPORTED
);
1384 get_net_error_message(gint error
)
1386 HMODULE module
= NULL
;
1387 gchar
*retval
= NULL
;
1388 wchar_t *msg
= NULL
;
1392 flags
= FORMAT_MESSAGE_ALLOCATE_BUFFER
|
1393 FORMAT_MESSAGE_IGNORE_INSERTS
|
1394 FORMAT_MESSAGE_FROM_SYSTEM
;
1396 if (error
>= NERR_BASE
&& error
<= MAX_NERR
) {
1397 module
= LoadLibraryExW(L
"netmsg.dll", NULL
, LOAD_LIBRARY_AS_DATAFILE
);
1399 if (module
!= NULL
) {
1400 flags
|= FORMAT_MESSAGE_FROM_HMODULE
;
1404 FormatMessageW(flags
, module
, error
, 0, (LPWSTR
)&msg
, 0, NULL
);
1407 nchars
= wcslen(msg
);
1410 msg
[nchars
- 1] == L
'\n' &&
1411 msg
[nchars
- 2] == L
'\r') {
1412 msg
[nchars
- 2] = L
'\0';
1415 retval
= g_utf16_to_utf8(msg
, -1, NULL
, NULL
, NULL
);
1420 if (module
!= NULL
) {
1421 FreeLibrary(module
);
1427 void qmp_guest_set_user_password(const char *username
,
1428 const char *password
,
1433 char *rawpasswddata
= NULL
;
1434 size_t rawpasswdlen
;
1435 wchar_t *user
= NULL
, *wpass
= NULL
;
1436 USER_INFO_1003 pi1003
= { 0, };
1437 GError
*gerr
= NULL
;
1440 error_setg(errp
, QERR_UNSUPPORTED
);
1444 rawpasswddata
= (char *)qbase64_decode(password
, -1, &rawpasswdlen
, errp
);
1445 if (!rawpasswddata
) {
1448 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
1449 rawpasswddata
[rawpasswdlen
] = '\0';
1451 user
= g_utf8_to_utf16(username
, -1, NULL
, NULL
, &gerr
);
1456 wpass
= g_utf8_to_utf16(rawpasswddata
, -1, NULL
, NULL
, &gerr
);
1461 pi1003
.usri1003_password
= wpass
;
1462 nas
= NetUserSetInfo(NULL
, user
,
1463 1003, (LPBYTE
)&pi1003
,
1466 if (nas
!= NERR_Success
) {
1467 gchar
*msg
= get_net_error_message(nas
);
1468 error_setg(errp
, "failed to set password: %s", msg
);
1474 error_setg(errp
, QERR_QGA_COMMAND_FAILED
, gerr
->message
);
1479 g_free(rawpasswddata
);
1482 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
1484 error_setg(errp
, QERR_UNSUPPORTED
);
1488 GuestMemoryBlockResponseList
*
1489 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
1491 error_setg(errp
, QERR_UNSUPPORTED
);
1495 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
1497 error_setg(errp
, QERR_UNSUPPORTED
);
1501 /* add unsupported commands to the blacklist */
1502 GList
*ga_command_blacklist_init(GList
*blacklist
)
1504 const char *list_unsupported
[] = {
1505 "guest-suspend-hybrid",
1507 "guest-get-memory-blocks", "guest-set-memory-blocks",
1508 "guest-get-memory-block-size",
1509 "guest-fsfreeze-freeze-list",
1511 char **p
= (char **)list_unsupported
;
1514 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1517 if (!vss_init(true)) {
1518 g_debug("vss_init failed, vss commands are going to be disabled");
1519 const char *list
[] = {
1520 "guest-get-fsinfo", "guest-fsfreeze-status",
1521 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL
};
1525 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1532 /* register init/cleanup routines for stateful command groups */
1533 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
1535 if (!vss_initialized()) {
1536 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);