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.
17 #include "qga/guest-agent-core.h"
18 #include "qga/vss-win32.h"
19 #include "qga-qmp-commands.h"
20 #include "qapi/qmp/qerror.h"
22 #ifndef SHTDN_REASON_FLAG_PLANNED
23 #define SHTDN_REASON_FLAG_PLANNED 0x80000000
26 /* multiple of 100 nanoseconds elapsed between windows baseline
27 * (1/1/1601) and Unix Epoch (1/1/1970), accounting for leap years */
28 #define W32_FT_OFFSET (10000000ULL * 60 * 60 * 24 * \
29 (365 * (1970 - 1601) + \
30 (1970 - 1601) / 4 - 3))
32 static void acquire_privilege(const char *name
, Error
**errp
)
35 TOKEN_PRIVILEGES priv
;
36 Error
*local_err
= NULL
;
38 if (OpenProcessToken(GetCurrentProcess(),
39 TOKEN_ADJUST_PRIVILEGES
|TOKEN_QUERY
, &token
))
41 if (!LookupPrivilegeValue(NULL
, name
, &priv
.Privileges
[0].Luid
)) {
42 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
43 "no luid for requested privilege");
47 priv
.PrivilegeCount
= 1;
48 priv
.Privileges
[0].Attributes
= SE_PRIVILEGE_ENABLED
;
50 if (!AdjustTokenPrivileges(token
, FALSE
, &priv
, 0, NULL
, 0)) {
51 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
52 "unable to acquire requested privilege");
57 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
58 "failed to open privilege token");
66 error_propagate(errp
, local_err
);
70 static void execute_async(DWORD
WINAPI (*func
)(LPVOID
), LPVOID opaque
,
73 Error
*local_err
= NULL
;
75 HANDLE thread
= CreateThread(NULL
, 0, func
, opaque
, 0, NULL
);
77 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
78 "failed to dispatch asynchronous command");
79 error_propagate(errp
, local_err
);
83 void qmp_guest_shutdown(bool has_mode
, const char *mode
, Error
**errp
)
85 Error
*local_err
= NULL
;
86 UINT shutdown_flag
= EWX_FORCE
;
88 slog("guest-shutdown called, mode: %s", mode
);
90 if (!has_mode
|| strcmp(mode
, "powerdown") == 0) {
91 shutdown_flag
|= EWX_POWEROFF
;
92 } else if (strcmp(mode
, "halt") == 0) {
93 shutdown_flag
|= EWX_SHUTDOWN
;
94 } else if (strcmp(mode
, "reboot") == 0) {
95 shutdown_flag
|= EWX_REBOOT
;
97 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "mode",
98 "halt|powerdown|reboot");
102 /* Request a shutdown privilege, but try to shut down the system
104 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
106 error_propagate(errp
, local_err
);
110 if (!ExitWindowsEx(shutdown_flag
, SHTDN_REASON_FLAG_PLANNED
)) {
111 slog("guest-shutdown failed: %lu", GetLastError());
112 error_set(errp
, QERR_UNDEFINED_ERROR
);
116 int64_t qmp_guest_file_open(const char *path
, bool has_mode
, const char *mode
,
119 error_set(errp
, QERR_UNSUPPORTED
);
123 void qmp_guest_file_close(int64_t handle
, Error
**errp
)
125 error_set(errp
, QERR_UNSUPPORTED
);
128 GuestFileRead
*qmp_guest_file_read(int64_t handle
, bool has_count
,
129 int64_t count
, Error
**errp
)
131 error_set(errp
, QERR_UNSUPPORTED
);
135 GuestFileWrite
*qmp_guest_file_write(int64_t handle
, const char *buf_b64
,
136 bool has_count
, int64_t count
,
139 error_set(errp
, QERR_UNSUPPORTED
);
143 GuestFileSeek
*qmp_guest_file_seek(int64_t handle
, int64_t offset
,
144 int64_t whence
, Error
**errp
)
146 error_set(errp
, QERR_UNSUPPORTED
);
150 void qmp_guest_file_flush(int64_t handle
, Error
**errp
)
152 error_set(errp
, QERR_UNSUPPORTED
);
156 * Return status of freeze/thaw
158 GuestFsfreezeStatus
qmp_guest_fsfreeze_status(Error
**errp
)
160 if (!vss_initialized()) {
161 error_set(errp
, QERR_UNSUPPORTED
);
165 if (ga_is_frozen(ga_state
)) {
166 return GUEST_FSFREEZE_STATUS_FROZEN
;
169 return GUEST_FSFREEZE_STATUS_THAWED
;
173 * Freeze local file systems using Volume Shadow-copy Service.
174 * The frozen state is limited for up to 10 seconds by VSS.
176 int64_t qmp_guest_fsfreeze_freeze(Error
**errp
)
179 Error
*local_err
= NULL
;
181 if (!vss_initialized()) {
182 error_set(errp
, QERR_UNSUPPORTED
);
186 slog("guest-fsfreeze called");
188 /* cannot risk guest agent blocking itself on a write in this state */
189 ga_set_frozen(ga_state
);
191 qga_vss_fsfreeze(&i
, &local_err
, true);
193 error_propagate(errp
, local_err
);
201 qmp_guest_fsfreeze_thaw(&local_err
);
203 g_debug("cleanup thaw: %s", error_get_pretty(local_err
));
204 error_free(local_err
);
210 * Thaw local file systems using Volume Shadow-copy Service.
212 int64_t qmp_guest_fsfreeze_thaw(Error
**errp
)
216 if (!vss_initialized()) {
217 error_set(errp
, QERR_UNSUPPORTED
);
221 qga_vss_fsfreeze(&i
, errp
, false);
223 ga_unset_frozen(ga_state
);
227 static void guest_fsfreeze_cleanup(void)
231 if (!vss_initialized()) {
235 if (ga_is_frozen(ga_state
) == GUEST_FSFREEZE_STATUS_FROZEN
) {
236 qmp_guest_fsfreeze_thaw(&err
);
238 slog("failed to clean up frozen filesystems: %s",
239 error_get_pretty(err
));
248 * Walk list of mounted file systems in the guest, and discard unused
251 void qmp_guest_fstrim(bool has_minimum
, int64_t minimum
, Error
**errp
)
253 error_set(errp
, QERR_UNSUPPORTED
);
257 GUEST_SUSPEND_MODE_DISK
,
258 GUEST_SUSPEND_MODE_RAM
261 static void check_suspend_mode(GuestSuspendMode mode
, Error
**errp
)
263 SYSTEM_POWER_CAPABILITIES sys_pwr_caps
;
264 Error
*local_err
= NULL
;
266 ZeroMemory(&sys_pwr_caps
, sizeof(sys_pwr_caps
));
267 if (!GetPwrCapabilities(&sys_pwr_caps
)) {
268 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
269 "failed to determine guest suspend capabilities");
274 case GUEST_SUSPEND_MODE_DISK
:
275 if (!sys_pwr_caps
.SystemS4
) {
276 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
277 "suspend-to-disk not supported by OS");
280 case GUEST_SUSPEND_MODE_RAM
:
281 if (!sys_pwr_caps
.SystemS3
) {
282 error_set(&local_err
, QERR_QGA_COMMAND_FAILED
,
283 "suspend-to-ram not supported by OS");
287 error_set(&local_err
, QERR_INVALID_PARAMETER_VALUE
, "mode",
293 error_propagate(errp
, local_err
);
297 static DWORD WINAPI
do_suspend(LPVOID opaque
)
299 GuestSuspendMode
*mode
= opaque
;
302 if (!SetSuspendState(*mode
== GUEST_SUSPEND_MODE_DISK
, TRUE
, TRUE
)) {
303 slog("failed to suspend guest, %lu", GetLastError());
310 void qmp_guest_suspend_disk(Error
**errp
)
312 Error
*local_err
= NULL
;
313 GuestSuspendMode
*mode
= g_malloc(sizeof(GuestSuspendMode
));
315 *mode
= GUEST_SUSPEND_MODE_DISK
;
316 check_suspend_mode(*mode
, &local_err
);
317 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
318 execute_async(do_suspend
, mode
, &local_err
);
321 error_propagate(errp
, local_err
);
326 void qmp_guest_suspend_ram(Error
**errp
)
328 Error
*local_err
= NULL
;
329 GuestSuspendMode
*mode
= g_malloc(sizeof(GuestSuspendMode
));
331 *mode
= GUEST_SUSPEND_MODE_RAM
;
332 check_suspend_mode(*mode
, &local_err
);
333 acquire_privilege(SE_SHUTDOWN_NAME
, &local_err
);
334 execute_async(do_suspend
, mode
, &local_err
);
337 error_propagate(errp
, local_err
);
342 void qmp_guest_suspend_hybrid(Error
**errp
)
344 error_set(errp
, QERR_UNSUPPORTED
);
347 GuestNetworkInterfaceList
*qmp_guest_network_get_interfaces(Error
**errp
)
349 error_set(errp
, QERR_UNSUPPORTED
);
353 int64_t qmp_guest_get_time(Error
**errp
)
360 if (ts
.wYear
< 1601 || ts
.wYear
> 30827) {
361 error_setg(errp
, "Failed to get time");
365 if (!SystemTimeToFileTime(&ts
, &tf
)) {
366 error_setg(errp
, "Failed to convert system time: %d", (int)GetLastError());
370 time_ns
= ((((int64_t)tf
.dwHighDateTime
<< 32) | tf
.dwLowDateTime
)
371 - W32_FT_OFFSET
) * 100;
376 void qmp_guest_set_time(bool has_time
, int64_t time_ns
, Error
**errp
)
378 Error
*local_err
= NULL
;
384 /* Okay, user passed a time to set. Validate it. */
385 if (time_ns
< 0 || time_ns
/ 100 > INT64_MAX
- W32_FT_OFFSET
) {
386 error_setg(errp
, "Time %" PRId64
"is invalid", time_ns
);
390 time
= time_ns
/ 100 + W32_FT_OFFSET
;
392 tf
.dwLowDateTime
= (DWORD
) time
;
393 tf
.dwHighDateTime
= (DWORD
) (time
>> 32);
395 if (!FileTimeToSystemTime(&tf
, &ts
)) {
396 error_setg(errp
, "Failed to convert system time %d",
397 (int)GetLastError());
401 /* Otherwise read the time from RTC which contains the correct value.
404 if (ts
.wYear
< 1601 || ts
.wYear
> 30827) {
405 error_setg(errp
, "Failed to get time");
410 acquire_privilege(SE_SYSTEMTIME_NAME
, &local_err
);
412 error_propagate(errp
, local_err
);
416 if (!SetSystemTime(&ts
)) {
417 error_setg(errp
, "Failed to set time to guest: %d", (int)GetLastError());
422 GuestLogicalProcessorList
*qmp_guest_get_vcpus(Error
**errp
)
424 error_set(errp
, QERR_UNSUPPORTED
);
428 int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList
*vcpus
, Error
**errp
)
430 error_set(errp
, QERR_UNSUPPORTED
);
434 /* register init/cleanup routines for stateful command groups */
435 void ga_command_state_init(GAState
*s
, GACommandState
*cs
)
437 if (vss_init(true)) {
438 ga_command_state_add(cs
, NULL
, guest_fsfreeze_cleanup
);