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.
23 #ifdef CONFIG_QGA_NTDDSCSI
31 #include "qga/guest-agent-core.h"
32 #include "qga/vss-win32.h"
33 #include "qga-qmp-commands.h"
34 #include "qapi/qmp/qerror.h"
35 #include "qemu/queue.h"
36 #include "qemu/host-utils.h"
38 #ifndef SHTDN_REASON_FLAG_PLANNED
39 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
42 /* multiple of 100 nanoseconds elapsed between windows baseline
43 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
44 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
45 (365 * (1970 - 1601) + \
46 (1970 - 1601) / 4 - 3))
48 #define INVALID_SET_FILE_POINTER ((DWORD)-1)
50 typedef struct GuestFileHandle
{
53 QTAILQ_ENTRY(GuestFileHandle
) next
;
57 QTAILQ_HEAD(, GuestFileHandle
) filehandles
;
58 } guest_file_state
= {
59 .filehandles
= QTAILQ_HEAD_INITIALIZER(guest_file_state
.filehandles
),
62 #define FILE_GENERIC_APPEND (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
64 typedef struct OpenFlags
{
67 DWORD creation_disposition
;
69 static OpenFlags guest_file_open_modes
[] = {
70 {"r", GENERIC_READ
, OPEN_EXISTING
},
71 {"rb", GENERIC_READ
, OPEN_EXISTING
},
72 {"w", GENERIC_WRITE
, CREATE_ALWAYS
},
73 {"wb", GENERIC_WRITE
, CREATE_ALWAYS
},
74 {"a", FILE_GENERIC_APPEND
, OPEN_ALWAYS
},
75 {"r+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
76 {"rb+", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
77 {"r+b", GENERIC_WRITE
|GENERIC_READ
, OPEN_EXISTING
},
78 {"w+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
79 {"wb+", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
80 {"w+b", GENERIC_WRITE
|GENERIC_READ
, CREATE_ALWAYS
},
81 {"a+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
82 {"ab+", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
},
83 {"a+b", FILE_GENERIC_APPEND
|GENERIC_READ
, OPEN_ALWAYS
}
86 static OpenFlags
*find_open_flag(const char *mode_str
)
91 for (mode
= 0; mode
< ARRAY_SIZE(guest_file_open_modes
); ++mode
) {
92 OpenFlags
*flags
= guest_file_open_modes
+ mode
;
94 if (strcmp(flags
->forms
, mode_str
) == 0) {
99 error_setg(errp
, "invalid file open mode '%s'", mode_str
);
103 static int64_t guest_file_handle_add(HANDLE fh
, Error
**errp
)
105 GuestFileHandle
*gfh
;
108 handle
= ga_get_fd_handle(ga_state
, errp
);
112 gfh
= g_new0(GuestFileHandle
, 1);
115 QTAILQ_INSERT_TAIL(&guest_file_state
.filehandles
, gfh
, next
);
120 static GuestFileHandle
*guest_file_handle_find(int64_t id
, Error
**errp
)
122 GuestFileHandle
*gfh
;
123 QTAILQ_FOREACH(gfh
, &guest_file_state
.filehandles
, next
) {
128 error_setg(errp
, "handle '%" PRId64
"' has not been found", id
);
132 static void handle_set_nonblocking(HANDLE fh
)
134 DWORD file_type
, pipe_state
;
135 file_type
= GetFileType(fh
);
136 if (file_type
!= FILE_TYPE_PIPE
) {
139 /* If file_type == FILE_TYPE_PIPE, according to MSDN
140 * the specified file is socket or named pipe */
141 if (!GetNamedPipeHandleState(fh
, &pipe_state
, NULL
,
142 NULL
, NULL
, NULL
, 0)) {
145 /* The fd is named pipe fd */
146 if (pipe_state
& PIPE_NOWAIT
) {
150 pipe_state
|= PIPE_NOWAIT
;
151 SetNamedPipeHandleState(fh
, &pipe_state
, NULL
, NULL
);
154 int64_t qmp_guest_file_open(const char *path
, bool has_mode
,
155 const char *mode
, Error
**errp
)
159 HANDLE templ_file
= NULL
;
160 DWORD share_mode
= FILE_SHARE_READ
;
161 DWORD flags_and_attr
= FILE_ATTRIBUTE_NORMAL
;
162 LPSECURITY_ATTRIBUTES sa_attr
= NULL
;
163 OpenFlags
*guest_flags
;
168 slog("guest-file-open called, filepath: %s, mode: %s", path
, mode
);
169 guest_flags
= find_open_flag(mode
);
170 if (guest_flags
== NULL
) {
171 error_setg(errp
, "invalid file open mode");
175 fh
= CreateFile(path
, guest_flags
->desired_access
, share_mode
, sa_attr
,
176 guest_flags
->creation_disposition
, flags_and_attr
,
178 if (fh
== INVALID_HANDLE_VALUE
) {
179 error_setg_win32(errp
, GetLastError(), "failed to open file '%s'",
184 /* set fd non-blocking to avoid common use cases (like reading from a
185 * named pipe) from hanging the agent
187 handle_set_nonblocking(fh
);
189 fd
= guest_file_handle_add(fh
, errp
);
192 error_setg(errp
, "failed to add handle to qmp handle table");
196 slog("guest-file-open, handle: % " PRId64
, fd
);
200 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
203 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
204 slog("guest-file-close called, handle: %" PRId64
, handle
);
208 ret
= CloseHandle(gfh
->fh
);
210 error_setg_win32(errp
, GetLastError(), "failed close handle");
214 QTAILQ_REMOVE(&guest_file_state
.filehandles
, gfh
, next
);
218 static void acquire_privilege(const char *name
, Error
**errp
)
221 TOKEN_PRIVILEGES priv
;
222 Error
*local_err
= NULL
;
224 if (OpenProcessToken(GetCurrentProcess(),
225 TOKEN_ADJUST_PRIVILEGES
|TOKEN_QUERY
, &token
))
227 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
228 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
229 "no luid for requested privilege");
233 priv
.PrivilegeCount
= 1;
234 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
236 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
237 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
238 "unable to acquire requested privilege");
243 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
244 "failed to open privilege token");
252 error_propagate(errp
, local_err
);
256 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
259 Error
*local_err
= NULL
;
261 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
263 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
264 "failed to dispatch asynchronous command");
265 error_propagate(errp
, local_err
);
269 void qmp_guest_shutdown(bool has_mode
, const char *mode
, Error
**errp
)
271 Error
*local_err
= NULL
;
272 UINT shutdown_flag
= EWX_FORCE
;
274 slog("guest-shutdown called, mode: %s", mode
);
276 if (!has_mode
|| strcmp(mode
, "powerdown") == 0) {
277 shutdown_flag
|= EWX_POWEROFF
;
278 } else if (strcmp(mode
, "halt") == 0) {
279 shutdown_flag
|= EWX_SHUTDOWN
;
280 } else if (strcmp(mode
, "reboot") == 0) {
281 shutdown_flag
|= EWX_REBOOT
;
283 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
284 "halt|powerdown|reboot");
288 /* Request a shutdown privilege, but try to shut down the system
290 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
292 error_propagate(errp
, local_err
);
296 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
297 slog("guest-shutdown failed: %lu", GetLastError());
298 error_setg(errp
, QERR_UNDEFINED_ERROR
);
302 GuestFileRead
*qmp_guest_file_read(int64_t handle
, bool has_count
,
303 int64_t count
, Error
**errp
)
305 GuestFileRead
*read_data
= NULL
;
310 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
316 count
= QGA_READ_COUNT_DEFAULT
;
317 } else if (count
< 0) {
318 error_setg(errp
, "value '%" PRId64
319 "' is invalid for argument count", count
);
324 buf
= g_malloc0(count
+1);
325 is_ok
= ReadFile(fh
, buf
, count
, &read_count
, NULL
);
327 error_setg_win32(errp
, GetLastError(), "failed to read file");
328 slog("guest-file-read failed, handle %" PRId64
, handle
);
331 read_data
= g_new0(GuestFileRead
, 1);
332 read_data
->count
= (size_t)read_count
;
333 read_data
->eof
= read_count
== 0;
335 if (read_count
!= 0) {
336 read_data
->buf_b64
= g_base64_encode(buf
, read_count
);
344 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
345 bool has_count
, int64_t count
,
348 GuestFileWrite
*write_data
= NULL
;
353 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
360 buf
= g_base64_decode(buf_b64
, &buf_len
);
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 int64_t whence
, Error
**errp
)
387 GuestFileHandle
*gfh
;
388 GuestFileSeek
*seek_data
;
390 LARGE_INTEGER new_pos
, off_pos
;
391 off_pos
.QuadPart
= offset
;
393 gfh
= guest_file_handle_find(handle
, errp
);
399 res
= SetFilePointerEx(fh
, off_pos
, &new_pos
, whence
);
401 error_setg_win32(errp
, GetLastError(), "failed to seek file");
404 seek_data
= g_new0(GuestFileSeek
, 1);
405 seek_data
->position
= new_pos
.QuadPart
;
409 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
412 GuestFileHandle
*gfh
= guest_file_handle_find(handle
, errp
);
418 if (!FlushFileBuffers(fh
)) {
419 error_setg_win32(errp
, GetLastError(), "failed to flush file");
423 #ifdef CONFIG_QGA_NTDDSCSI
425 static STORAGE_BUS_TYPE win2qemu
[] = {
426 [BusTypeUnknown
] = GUEST_DISK_BUS_TYPE_UNKNOWN
,
427 [BusTypeScsi
] = GUEST_DISK_BUS_TYPE_SCSI
,
428 [BusTypeAtapi
] = GUEST_DISK_BUS_TYPE_IDE
,
429 [BusTypeAta
] = GUEST_DISK_BUS_TYPE_IDE
,
430 [BusType1394
] = GUEST_DISK_BUS_TYPE_IEEE1394
,
431 [BusTypeSsa
] = GUEST_DISK_BUS_TYPE_SSA
,
432 [BusTypeFibre
] = GUEST_DISK_BUS_TYPE_SSA
,
433 [BusTypeUsb
] = GUEST_DISK_BUS_TYPE_USB
,
434 [BusTypeRAID
] = GUEST_DISK_BUS_TYPE_RAID
,
435 #if (_WIN32_WINNT >= 0x0600)
436 [BusTypeiScsi
] = GUEST_DISK_BUS_TYPE_ISCSI
,
437 [BusTypeSas
] = GUEST_DISK_BUS_TYPE_SAS
,
438 [BusTypeSata
] = GUEST_DISK_BUS_TYPE_SATA
,
439 [BusTypeSd
] = GUEST_DISK_BUS_TYPE_SD
,
440 [BusTypeMmc
] = GUEST_DISK_BUS_TYPE_MMC
,
442 #if (_WIN32_WINNT >= 0x0601)
443 [BusTypeVirtual
] = GUEST_DISK_BUS_TYPE_VIRTUAL
,
444 [BusTypeFileBackedVirtual
] = GUEST_DISK_BUS_TYPE_FILE_BACKED_VIRTUAL
,
448 static GuestDiskBusType
find_bus_type(STORAGE_BUS_TYPE bus
)
450 if (bus
> ARRAY_SIZE(win2qemu
) || (int)bus
< 0) {
451 return GUEST_DISK_BUS_TYPE_UNKNOWN
;
453 return win2qemu
[(int)bus
];
456 DEFINE_GUID(GUID_DEVINTERFACE_VOLUME
,
457 0x53f5630dL
, 0xb6bf, 0x11d0, 0x94, 0xf2,
458 0x00, 0xa0, 0xc9, 0x1e, 0xfb, 0x8b);
460 static GuestPCIAddress
*get_pci_info(char *guid
, Error
**errp
)
463 SP_DEVINFO_DATA dev_info_data
;
466 char dev_name
[MAX_PATH
];
468 GuestPCIAddress
*pci
= NULL
;
469 char *name
= g_strdup(&guid
[4]);
471 if (!QueryDosDevice(name
, dev_name
, ARRAY_SIZE(dev_name
))) {
472 error_setg_win32(errp
, GetLastError(), "failed to get dos device name");
476 dev_info
= SetupDiGetClassDevs(&GUID_DEVINTERFACE_VOLUME
, 0, 0,
477 DIGCF_PRESENT
| DIGCF_DEVICEINTERFACE
);
478 if (dev_info
== INVALID_HANDLE_VALUE
) {
479 error_setg_win32(errp
, GetLastError(), "failed to get devices tree");
483 dev_info_data
.cbSize
= sizeof(SP_DEVINFO_DATA
);
484 for (i
= 0; SetupDiEnumDeviceInfo(dev_info
, i
, &dev_info_data
); i
++) {
485 DWORD addr
, bus
, slot
, func
, dev
, data
, size2
;
486 while (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
487 SPDRP_PHYSICAL_DEVICE_OBJECT_NAME
,
488 &data
, (PBYTE
)buffer
, size
,
490 size
= MAX(size
, size2
);
491 if (GetLastError() == ERROR_INSUFFICIENT_BUFFER
) {
493 /* Double the size to avoid problems on
494 * W2k MBCS systems per KB 888609.
495 * https://support.microsoft.com/en-us/kb/259695 */
496 buffer
= g_malloc(size
* 2);
498 error_setg_win32(errp
, GetLastError(),
499 "failed to get device name");
504 if (g_strcmp0(buffer
, dev_name
)) {
508 /* There is no need to allocate buffer in the next functions. The size
509 * is known and ULONG according to
510 * https://support.microsoft.com/en-us/kb/253232
511 * https://msdn.microsoft.com/en-us/library/windows/hardware/ff543095(v=vs.85).aspx
513 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
514 SPDRP_BUSNUMBER
, &data
, (PBYTE
)&bus
, size
, NULL
)) {
518 /* The function retrieves the device's address. This value will be
519 * transformed into device function and number */
520 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
521 SPDRP_ADDRESS
, &data
, (PBYTE
)&addr
, size
, NULL
)) {
525 /* This call returns UINumber of DEVICE_CAPABILITIES structure.
526 * This number is typically a user-perceived slot number. */
527 if (!SetupDiGetDeviceRegistryProperty(dev_info
, &dev_info_data
,
528 SPDRP_UI_NUMBER
, &data
, (PBYTE
)&slot
, size
, NULL
)) {
532 /* SetupApi gives us the same information as driver with
533 * IoGetDeviceProperty. According to Microsoft
534 * https://support.microsoft.com/en-us/kb/253232
535 * FunctionNumber = (USHORT)((propertyAddress) & 0x0000FFFF);
536 * DeviceNumber = (USHORT)(((propertyAddress) >> 16) & 0x0000FFFF);
537 * SPDRP_ADDRESS is propertyAddress, so we do the same.*/
539 func
= addr
& 0x0000FFFF;
540 dev
= (addr
>> 16) & 0x0000FFFF;
541 pci
= g_malloc0(sizeof(*pci
));
544 pci
->function
= func
;
554 static int get_disk_bus_type(HANDLE vol_h
, Error
**errp
)
556 STORAGE_PROPERTY_QUERY query
;
557 STORAGE_DEVICE_DESCRIPTOR
*dev_desc
, buf
;
561 dev_desc
->Size
= sizeof(buf
);
562 query
.PropertyId
= StorageDeviceProperty
;
563 query
.QueryType
= PropertyStandardQuery
;
565 if (!DeviceIoControl(vol_h
, IOCTL_STORAGE_QUERY_PROPERTY
, &query
,
566 sizeof(STORAGE_PROPERTY_QUERY
), dev_desc
,
567 dev_desc
->Size
, &received
, NULL
)) {
568 error_setg_win32(errp
, GetLastError(), "failed to get bus type");
572 return dev_desc
->BusType
;
575 /* VSS provider works with volumes, thus there is no difference if
576 * the volume consist of spanned disks. Info about the first disk in the
577 * volume is returned for the spanned disk group (LVM) */
578 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
580 GuestDiskAddressList
*list
= NULL
;
581 GuestDiskAddress
*disk
;
582 SCSI_ADDRESS addr
, *scsi_ad
;
588 char *name
= g_strndup(guid
, strlen(guid
)-1);
590 vol_h
= CreateFile(name
, 0, FILE_SHARE_READ
, NULL
, OPEN_EXISTING
,
592 if (vol_h
== INVALID_HANDLE_VALUE
) {
593 error_setg_win32(errp
, GetLastError(), "failed to open volume");
597 bus
= get_disk_bus_type(vol_h
, errp
);
602 disk
= g_malloc0(sizeof(*disk
));
603 disk
->bus_type
= find_bus_type(bus
);
604 if (bus
== BusTypeScsi
|| bus
== BusTypeAta
|| bus
== BusTypeRAID
605 #if (_WIN32_WINNT >= 0x0600)
606 /* This bus type is not supported before Windows Server 2003 SP1 */
610 /* We are able to use the same ioctls for different bus types
611 * according to Microsoft docs
612 * https://technet.microsoft.com/en-us/library/ee851589(v=ws.10).aspx */
613 if (DeviceIoControl(vol_h
, IOCTL_SCSI_GET_ADDRESS
, NULL
, 0, scsi_ad
,
614 sizeof(SCSI_ADDRESS
), &len
, NULL
)) {
615 disk
->unit
= addr
.Lun
;
616 disk
->target
= addr
.TargetId
;
617 disk
->bus
= addr
.PathId
;
618 disk
->pci_controller
= get_pci_info(name
, errp
);
620 /* We do not set error in this case, because we still have enough
621 * information about volume. */
623 disk
->pci_controller
= NULL
;
626 list
= g_malloc0(sizeof(*list
));
638 static GuestDiskAddressList
*build_guest_disk_info(char *guid
, Error
**errp
)
643 #endif /* CONFIG_QGA_NTDDSCSI */
645 static GuestFilesystemInfo
*build_guest_fsinfo(char *guid
, Error
**errp
)
648 char mnt
, *mnt_point
;
650 char vol_info
[MAX_PATH
+1];
652 GuestFilesystemInfo
*fs
= NULL
;
654 GetVolumePathNamesForVolumeName(guid
, (LPCH
)&mnt
, 0, &info_size
);
655 if (GetLastError() != ERROR_MORE_DATA
) {
656 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
660 mnt_point
= g_malloc(info_size
+ 1);
661 if (!GetVolumePathNamesForVolumeName(guid
, mnt_point
, info_size
,
663 error_setg_win32(errp
, GetLastError(), "failed to get volume name");
667 len
= strlen(mnt_point
);
668 mnt_point
[len
] = '\\';
669 mnt_point
[len
+1] = 0;
670 if (!GetVolumeInformation(mnt_point
, vol_info
, sizeof(vol_info
), NULL
, NULL
,
671 NULL
, (LPSTR
)&fs_name
, sizeof(fs_name
))) {
672 if (GetLastError() != ERROR_NOT_READY
) {
673 error_setg_win32(errp
, GetLastError(), "failed to get volume info");
678 fs_name
[sizeof(fs_name
) - 1] = 0;
679 fs
= g_malloc(sizeof(*fs
));
680 fs
->name
= g_strdup(guid
);
682 fs
->mountpoint
= g_strdup("System Reserved");
684 fs
->mountpoint
= g_strndup(mnt_point
, len
);
686 fs
->type
= g_strdup(fs_name
);
687 fs
->disk
= build_guest_disk_info(guid
, errp
);
693 GuestFilesystemInfoList
*qmp_guest_get_fsinfo(Error
**errp
)
696 GuestFilesystemInfoList
*new, *ret
= NULL
;
699 vol_h
= FindFirstVolume(guid
, sizeof(guid
));
700 if (vol_h
== INVALID_HANDLE_VALUE
) {
701 error_setg_win32(errp
, GetLastError(), "failed to find any volume");
706 GuestFilesystemInfo
*info
= build_guest_fsinfo(guid
, errp
);
710 new = g_malloc(sizeof(*ret
));
714 } while (FindNextVolume(vol_h
, guid
, sizeof(guid
)));
716 if (GetLastError() != ERROR_NO_MORE_FILES
) {
717 error_setg_win32(errp
, GetLastError(), "failed to find next volume");
720 FindVolumeClose(vol_h
);
725 * Return status of freeze/thaw
727 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
729 if (!vss_initialized()) {
730 error_setg(errp
, QERR_UNSUPPORTED
);
734 if (ga_is_frozen(ga_state
)) {
735 return GUEST_FSFREEZE_STATUS_FROZEN
;
738 return GUEST_FSFREEZE_STATUS_THAWED
;
742 * Freeze local file systems using Volume Shadow-copy Service.
743 * The frozen state is limited for up to 10 seconds by VSS.
745 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
748 Error
*local_err
= NULL
;
750 if (!vss_initialized()) {
751 error_setg(errp
, QERR_UNSUPPORTED
);
755 slog("guest-fsfreeze called");
757 /* cannot risk guest agent blocking itself on a write in this state */
758 ga_set_frozen(ga_state
);
760 qga_vss_fsfreeze(&i
, &local_err
, true);
762 error_propagate(errp
, local_err
);
770 qmp_guest_fsfreeze_thaw(&local_err
);
772 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
773 error_free(local_err
);
778 int64_t qmp_guest_fsfreeze_freeze_list(bool has_mountpoints
,
779 strList
*mountpoints
,
782 error_setg(errp
, QERR_UNSUPPORTED
);
788 * Thaw local file systems using Volume Shadow-copy Service.
790 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
794 if (!vss_initialized()) {
795 error_setg(errp
, QERR_UNSUPPORTED
);
799 qga_vss_fsfreeze(&i
, errp
, false);
801 ga_unset_frozen(ga_state
);
805 static void guest_fsfreeze_cleanup(void)
809 if (!vss_initialized()) {
813 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
814 qmp_guest_fsfreeze_thaw(&err
);
816 slog("failed to clean up frozen filesystems: %s",
817 error_get_pretty(err
));
826 * Walk list of mounted file systems in the guest, and discard unused
829 GuestFilesystemTrimResponse
*
830 qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
832 error_setg(errp
, QERR_UNSUPPORTED
);
837 GUEST_SUSPEND_MODE_DISK
,
838 GUEST_SUSPEND_MODE_RAM
841 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
843 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
844 Error
*local_err
= NULL
;
846 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
847 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
848 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
849 "failed to determine guest suspend capabilities");
854 case GUEST_SUSPEND_MODE_DISK
:
855 if (!sys_pwr_caps
.SystemS4
) {
856 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
857 "suspend-to-disk not supported by OS");
860 case GUEST_SUSPEND_MODE_RAM
:
861 if (!sys_pwr_caps
.SystemS3
) {
862 error_setg(&local_err
, QERR_QGA_COMMAND_FAILED
,
863 "suspend-to-ram not supported by OS");
867 error_setg(&local_err
, QERR_INVALID_PARAMETER_VALUE
, "mode",
873 error_propagate(errp
, local_err
);
877 static DWORD WINAPI
do_suspend(LPVOID opaque
)
879 GuestSuspendMode
*mode
= opaque
;
882 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
883 slog("failed to suspend guest, %lu", GetLastError());
890 void qmp_guest_suspend_disk(Error
**errp
)
892 Error
*local_err
= NULL
;
893 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
895 *mode
= GUEST_SUSPEND_MODE_DISK
;
896 check_suspend_mode(*mode
, &local_err
);
897 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
898 execute_async(do_suspend
, mode
, &local_err
);
901 error_propagate(errp
, local_err
);
906 void qmp_guest_suspend_ram(Error
**errp
)
908 Error
*local_err
= NULL
;
909 GuestSuspendMode
*mode
= g_new(GuestSuspendMode
, 1);
911 *mode
= GUEST_SUSPEND_MODE_RAM
;
912 check_suspend_mode(*mode
, &local_err
);
913 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
914 execute_async(do_suspend
, mode
, &local_err
);
917 error_propagate(errp
, local_err
);
922 void qmp_guest_suspend_hybrid(Error
**errp
)
924 error_setg(errp
, QERR_UNSUPPORTED
);
927 static IP_ADAPTER_ADDRESSES
*guest_get_adapters_addresses(Error
**errp
)
929 IP_ADAPTER_ADDRESSES
*adptr_addrs
= NULL
;
930 ULONG adptr_addrs_len
= 0;
933 /* Call the first time to get the adptr_addrs_len. */
934 GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
935 NULL
, adptr_addrs
, &adptr_addrs_len
);
937 adptr_addrs
= g_malloc(adptr_addrs_len
);
938 ret
= GetAdaptersAddresses(AF_UNSPEC
, GAA_FLAG_INCLUDE_PREFIX
,
939 NULL
, adptr_addrs
, &adptr_addrs_len
);
940 if (ret
!= ERROR_SUCCESS
) {
941 error_setg_win32(errp
, ret
, "failed to get adapters addresses");
948 static char *guest_wctomb_dup(WCHAR
*wstr
)
953 i
= wcslen(wstr
) + 1;
955 WideCharToMultiByte(CP_ACP
, WC_COMPOSITECHECK
,
956 wstr
, -1, str
, i
, NULL
, NULL
);
960 static char *guest_addr_to_str(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
,
963 char addr_str
[INET6_ADDRSTRLEN
+ INET_ADDRSTRLEN
];
967 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
||
968 ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
969 len
= sizeof(addr_str
);
970 ret
= WSAAddressToString(ip_addr
->Address
.lpSockaddr
,
971 ip_addr
->Address
.iSockaddrLength
,
976 error_setg_win32(errp
, WSAGetLastError(),
977 "failed address presentation form conversion");
980 return g_strdup(addr_str
);
985 #if (_WIN32_WINNT >= 0x0600)
986 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
988 /* For Windows Vista/2008 and newer, use the OnLinkPrefixLength
989 * field to obtain the prefix.
991 return ip_addr
->OnLinkPrefixLength
;
994 /* When using the Windows XP and 2003 build environment, do the best we can to
995 * figure out the prefix.
997 static IP_ADAPTER_INFO
*guest_get_adapters_info(void)
999 IP_ADAPTER_INFO
*adptr_info
= NULL
;
1000 ULONG adptr_info_len
= 0;
1003 /* Call the first time to get the adptr_info_len. */
1004 GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1006 adptr_info
= g_malloc(adptr_info_len
);
1007 ret
= GetAdaptersInfo(adptr_info
, &adptr_info_len
);
1008 if (ret
!= ERROR_SUCCESS
) {
1015 static int64_t guest_ip_prefix(IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
)
1017 int64_t prefix
= -1; /* Use for AF_INET6 and unknown/undetermined values. */
1018 IP_ADAPTER_INFO
*adptr_info
, *info
;
1022 if (ip_addr
->Address
.lpSockaddr
->sa_family
!= AF_INET
) {
1025 adptr_info
= guest_get_adapters_info();
1026 if (adptr_info
== NULL
) {
1030 /* Match up the passed in ip_addr with one found in adaptr_info.
1031 * The matching one in adptr_info will have the netmask.
1033 p
= &((struct sockaddr_in
*)ip_addr
->Address
.lpSockaddr
)->sin_addr
;
1034 for (info
= adptr_info
; info
; info
= info
->Next
) {
1035 for (ip
= &info
->IpAddressList
; ip
; ip
= ip
->Next
) {
1036 if (p
->S_un
.S_addr
== inet_addr(ip
->IpAddress
.String
)) {
1037 prefix
= ctpop32(inet_addr(ip
->IpMask
.String
));
1048 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
1050 IP_ADAPTER_ADDRESSES
*adptr_addrs
, *addr
;
1051 IP_ADAPTER_UNICAST_ADDRESS
*ip_addr
= NULL
;
1052 GuestNetworkInterfaceList
*head
= NULL
, *cur_item
= NULL
;
1053 GuestIpAddressList
*head_addr
, *cur_addr
;
1054 GuestNetworkInterfaceList
*info
;
1055 GuestIpAddressList
*address_item
= NULL
;
1056 unsigned char *mac_addr
;
1062 adptr_addrs
= guest_get_adapters_addresses(errp
);
1063 if (adptr_addrs
== NULL
) {
1067 /* Make WSA APIs available. */
1068 wsa_version
= MAKEWORD(2, 2);
1069 ret
= WSAStartup(wsa_version
, &wsa_data
);
1071 error_setg_win32(errp
, ret
, "failed socket startup");
1075 for (addr
= adptr_addrs
; addr
; addr
= addr
->Next
) {
1076 info
= g_malloc0(sizeof(*info
));
1078 if (cur_item
== NULL
) {
1079 head
= cur_item
= info
;
1081 cur_item
->next
= info
;
1085 info
->value
= g_malloc0(sizeof(*info
->value
));
1086 info
->value
->name
= guest_wctomb_dup(addr
->FriendlyName
);
1088 if (addr
->PhysicalAddressLength
!= 0) {
1089 mac_addr
= addr
->PhysicalAddress
;
1091 info
->value
->hardware_address
=
1092 g_strdup_printf("%02x:%02x:%02x:%02x:%02x:%02x",
1093 (int) mac_addr
[0], (int) mac_addr
[1],
1094 (int) mac_addr
[2], (int) mac_addr
[3],
1095 (int) mac_addr
[4], (int) mac_addr
[5]);
1097 info
->value
->has_hardware_address
= true;
1102 for (ip_addr
= addr
->FirstUnicastAddress
;
1104 ip_addr
= ip_addr
->Next
) {
1105 addr_str
= guest_addr_to_str(ip_addr
, errp
);
1106 if (addr_str
== NULL
) {
1110 address_item
= g_malloc0(sizeof(*address_item
));
1113 head_addr
= cur_addr
= address_item
;
1115 cur_addr
->next
= address_item
;
1116 cur_addr
= address_item
;
1119 address_item
->value
= g_malloc0(sizeof(*address_item
->value
));
1120 address_item
->value
->ip_address
= addr_str
;
1121 address_item
->value
->prefix
= guest_ip_prefix(ip_addr
);
1122 if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET
) {
1123 address_item
->value
->ip_address_type
=
1124 GUEST_IP_ADDRESS_TYPE_IPV4
;
1125 } else if (ip_addr
->Address
.lpSockaddr
->sa_family
== AF_INET6
) {
1126 address_item
->value
->ip_address_type
=
1127 GUEST_IP_ADDRESS_TYPE_IPV6
;
1131 info
->value
->has_ip_addresses
= true;
1132 info
->value
->ip_addresses
= head_addr
;
1137 g_free(adptr_addrs
);
1141 int64_t qmp_guest_get_time(Error
**errp
)
1143 SYSTEMTIME ts
= {0};
1148 if (ts
.wYear
< 1601 || ts
.wYear
> 30827) {
1149 error_setg(errp
, "Failed to get time");
1153 if (!SystemTimeToFileTime(&ts
, &tf
)) {
1154 error_setg(errp
, "Failed to convert system time: %d", (int)GetLastError());
1158 time_ns
= ((((int64_t)tf
.dwHighDateTime
<< 32) | tf
.dwLowDateTime
)
1159 - W32_FT_OFFSET
) * 100;
1164 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
1166 Error
*local_err
= NULL
;
1172 /* Unfortunately, Windows libraries don't provide an easy way to access
1175 * https://msdn.microsoft.com/en-us/library/aa908981.aspx
1177 error_setg(errp
, "Time argument is required on this platform");
1181 /* Validate time passed by user. */
1182 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
1183 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
1187 time
= time_ns
/ 100 + W32_FT_OFFSET
;
1189 tf
.dwLowDateTime
= (DWORD
) time
;
1190 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
1192 if (!FileTimeToSystemTime(&tf
, &ts
)) {
1193 error_setg(errp
, "Failed to convert system time %d",
1194 (int)GetLastError());
1198 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
1200 error_propagate(errp
, local_err
);
1204 if (!SetSystemTime(&ts
)) {
1205 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
1210 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
1212 error_setg(errp
, QERR_UNSUPPORTED
);
1216 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
1218 error_setg(errp
, QERR_UNSUPPORTED
);
1223 get_net_error_message(gint error
)
1225 HMODULE module
= NULL
;
1226 gchar
*retval
= NULL
;
1227 wchar_t *msg
= NULL
;
1230 flags
= FORMAT_MESSAGE_ALLOCATE_BUFFER
1231 |FORMAT_MESSAGE_IGNORE_INSERTS
1232 |FORMAT_MESSAGE_FROM_SYSTEM
;
1234 if (error
>= NERR_BASE
&& error
<= MAX_NERR
) {
1235 module
= LoadLibraryExW(L
"netmsg.dll", NULL
, LOAD_LIBRARY_AS_DATAFILE
);
1237 if (module
!= NULL
) {
1238 flags
|= FORMAT_MESSAGE_FROM_HMODULE
;
1242 FormatMessageW(flags
, module
, error
, 0, (LPWSTR
)&msg
, 0, NULL
);
1245 nchars
= wcslen(msg
);
1247 if (nchars
> 2 && msg
[nchars
-1] == '\n' && msg
[nchars
-2] == '\r') {
1248 msg
[nchars
-2] = '\0';
1251 retval
= g_utf16_to_utf8(msg
, -1, NULL
, NULL
, NULL
);
1256 if (module
!= NULL
) {
1257 FreeLibrary(module
);
1263 void qmp_guest_set_user_password(const char *username
,
1264 const char *password
,
1269 char *rawpasswddata
= NULL
;
1270 size_t rawpasswdlen
;
1271 wchar_t *user
, *wpass
;
1272 USER_INFO_1003 pi1003
= { 0, };
1275 error_setg(errp
, QERR_UNSUPPORTED
);
1279 rawpasswddata
= (char *)g_base64_decode(password
, &rawpasswdlen
);
1280 rawpasswddata
= g_renew(char, rawpasswddata
, rawpasswdlen
+ 1);
1281 rawpasswddata
[rawpasswdlen
] = '\0';
1283 user
= g_utf8_to_utf16(username
, -1, NULL
, NULL
, NULL
);
1284 wpass
= g_utf8_to_utf16(rawpasswddata
, -1, NULL
, NULL
, NULL
);
1286 pi1003
.usri1003_password
= wpass
;
1287 nas
= NetUserSetInfo(NULL
, user
,
1288 1003, (LPBYTE
)&pi1003
,
1291 if (nas
!= NERR_Success
) {
1292 gchar
*msg
= get_net_error_message(nas
);
1293 error_setg(errp
, "failed to set password: %s", msg
);
1299 g_free(rawpasswddata
);
1302 GuestMemoryBlockList
*qmp_guest_get_memory_blocks(Error
**errp
)
1304 error_setg(errp
, QERR_UNSUPPORTED
);
1308 GuestMemoryBlockResponseList
*
1309 qmp_guest_set_memory_blocks(GuestMemoryBlockList
*mem_blks
, Error
**errp
)
1311 error_setg(errp
, QERR_UNSUPPORTED
);
1315 GuestMemoryBlockInfo
*qmp_guest_get_memory_block_info(Error
**errp
)
1317 error_setg(errp
, QERR_UNSUPPORTED
);
1321 /* add unsupported commands to the blacklist */
1322 GList
*ga_command_blacklist_init(GList
*blacklist
)
1324 const char *list_unsupported
[] = {
1325 "guest-suspend-hybrid",
1326 "guest-get-vcpus", "guest-set-vcpus",
1327 "guest-get-memory-blocks", "guest-set-memory-blocks",
1328 "guest-get-memory-block-size",
1329 "guest-fsfreeze-freeze-list",
1330 "guest-fstrim", NULL
};
1331 char **p
= (char **)list_unsupported
;
1334 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1337 if (!vss_init(true)) {
1338 g_debug("vss_init failed, vss commands are going to be disabled");
1339 const char *list
[] = {
1340 "guest-get-fsinfo", "guest-fsfreeze-status",
1341 "guest-fsfreeze-freeze", "guest-fsfreeze-thaw", NULL
};
1345 blacklist
= g_list_append(blacklist
, g_strdup(*p
++));
1352 /* register init/cleanup routines for stateful command groups */
1353 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
1355 if (!vss_initialized()) {
1356 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);