]>
Commit | Line | Data |
---|---|---|
d8ca685a MR |
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> | |
aa59637e | 8 | * Gal Hammer <ghammer@redhat.com> |
d8ca685a MR |
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 | #include <glib.h> | |
aa59637e GH |
15 | #include <wtypes.h> |
16 | #include <powrprof.h> | |
d8ca685a | 17 | #include "qga/guest-agent-core.h" |
64c00317 | 18 | #include "qga/vss-win32.h" |
d8ca685a | 19 | #include "qga-qmp-commands.h" |
7b1b5d19 | 20 | #include "qapi/qmp/qerror.h" |
d8ca685a | 21 | |
546b60d0 MR |
22 | #ifndef SHTDN_REASON_FLAG_PLANNED |
23 | #define SHTDN_REASON_FLAG_PLANNED 0x80000000 | |
24 | #endif | |
25 | ||
3f2a6087 LL |
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)) | |
31 | ||
77dbc81b | 32 | static void acquire_privilege(const char *name, Error **errp) |
d8ca685a | 33 | { |
546b60d0 MR |
34 | HANDLE token; |
35 | TOKEN_PRIVILEGES priv; | |
aa59637e GH |
36 | Error *local_err = NULL; |
37 | ||
77dbc81b | 38 | if (error_is_set(errp)) { |
aa59637e GH |
39 | return; |
40 | } | |
41 | ||
42 | if (OpenProcessToken(GetCurrentProcess(), | |
43 | TOKEN_ADJUST_PRIVILEGES|TOKEN_QUERY, &token)) | |
44 | { | |
45 | if (!LookupPrivilegeValue(NULL, name, &priv.Privileges[0].Luid)) { | |
46 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
47 | "no luid for requested privilege"); | |
48 | goto out; | |
49 | } | |
50 | ||
51 | priv.PrivilegeCount = 1; | |
52 | priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED; | |
53 | ||
54 | if (!AdjustTokenPrivileges(token, FALSE, &priv, 0, NULL, 0)) { | |
55 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
56 | "unable to acquire requested privilege"); | |
57 | goto out; | |
58 | } | |
59 | ||
60 | CloseHandle(token); | |
61 | } else { | |
62 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
63 | "failed to open privilege token"); | |
64 | } | |
65 | ||
66 | out: | |
67 | if (local_err) { | |
77dbc81b | 68 | error_propagate(errp, local_err); |
aa59637e GH |
69 | } |
70 | } | |
71 | ||
77dbc81b MA |
72 | static void execute_async(DWORD WINAPI (*func)(LPVOID), LPVOID opaque, |
73 | Error **errp) | |
aa59637e GH |
74 | { |
75 | Error *local_err = NULL; | |
76 | ||
77dbc81b | 77 | if (error_is_set(errp)) { |
aa59637e GH |
78 | return; |
79 | } | |
80 | HANDLE thread = CreateThread(NULL, 0, func, opaque, 0, NULL); | |
81 | if (!thread) { | |
82 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
83 | "failed to dispatch asynchronous command"); | |
77dbc81b | 84 | error_propagate(errp, local_err); |
aa59637e GH |
85 | } |
86 | } | |
87 | ||
77dbc81b | 88 | void qmp_guest_shutdown(bool has_mode, const char *mode, Error **errp) |
aa59637e | 89 | { |
546b60d0 MR |
90 | UINT shutdown_flag = EWX_FORCE; |
91 | ||
92 | slog("guest-shutdown called, mode: %s", mode); | |
93 | ||
94 | if (!has_mode || strcmp(mode, "powerdown") == 0) { | |
95 | shutdown_flag |= EWX_POWEROFF; | |
96 | } else if (strcmp(mode, "halt") == 0) { | |
97 | shutdown_flag |= EWX_SHUTDOWN; | |
98 | } else if (strcmp(mode, "reboot") == 0) { | |
99 | shutdown_flag |= EWX_REBOOT; | |
100 | } else { | |
77dbc81b | 101 | error_set(errp, QERR_INVALID_PARAMETER_VALUE, "mode", |
546b60d0 MR |
102 | "halt|powerdown|reboot"); |
103 | return; | |
104 | } | |
105 | ||
106 | /* Request a shutdown privilege, but try to shut down the system | |
107 | anyway. */ | |
77dbc81b MA |
108 | acquire_privilege(SE_SHUTDOWN_NAME, errp); |
109 | if (error_is_set(errp)) { | |
aa59637e | 110 | return; |
546b60d0 MR |
111 | } |
112 | ||
113 | if (!ExitWindowsEx(shutdown_flag, SHTDN_REASON_FLAG_PLANNED)) { | |
16f4e8fa | 114 | slog("guest-shutdown failed: %lu", GetLastError()); |
77dbc81b | 115 | error_set(errp, QERR_UNDEFINED_ERROR); |
546b60d0 | 116 | } |
d8ca685a MR |
117 | } |
118 | ||
77dbc81b MA |
119 | int64_t qmp_guest_file_open(const char *path, bool has_mode, const char *mode, |
120 | Error **errp) | |
d8ca685a | 121 | { |
77dbc81b | 122 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
123 | return 0; |
124 | } | |
125 | ||
77dbc81b | 126 | void qmp_guest_file_close(int64_t handle, Error **errp) |
d8ca685a | 127 | { |
77dbc81b | 128 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
129 | } |
130 | ||
131 | GuestFileRead *qmp_guest_file_read(int64_t handle, bool has_count, | |
77dbc81b | 132 | int64_t count, Error **errp) |
d8ca685a | 133 | { |
77dbc81b | 134 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
135 | return 0; |
136 | } | |
137 | ||
138 | GuestFileWrite *qmp_guest_file_write(int64_t handle, const char *buf_b64, | |
77dbc81b MA |
139 | bool has_count, int64_t count, |
140 | Error **errp) | |
d8ca685a | 141 | { |
77dbc81b | 142 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
143 | return 0; |
144 | } | |
145 | ||
146 | GuestFileSeek *qmp_guest_file_seek(int64_t handle, int64_t offset, | |
77dbc81b | 147 | int64_t whence, Error **errp) |
d8ca685a | 148 | { |
77dbc81b | 149 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
150 | return 0; |
151 | } | |
152 | ||
77dbc81b | 153 | void qmp_guest_file_flush(int64_t handle, Error **errp) |
d8ca685a | 154 | { |
77dbc81b | 155 | error_set(errp, QERR_UNSUPPORTED); |
d8ca685a MR |
156 | } |
157 | ||
158 | /* | |
159 | * Return status of freeze/thaw | |
160 | */ | |
77dbc81b | 161 | GuestFsfreezeStatus qmp_guest_fsfreeze_status(Error **errp) |
d8ca685a | 162 | { |
64c00317 | 163 | if (!vss_initialized()) { |
77dbc81b | 164 | error_set(errp, QERR_UNSUPPORTED); |
64c00317 TS |
165 | return 0; |
166 | } | |
167 | ||
168 | if (ga_is_frozen(ga_state)) { | |
169 | return GUEST_FSFREEZE_STATUS_FROZEN; | |
170 | } | |
171 | ||
172 | return GUEST_FSFREEZE_STATUS_THAWED; | |
d8ca685a MR |
173 | } |
174 | ||
175 | /* | |
64c00317 TS |
176 | * Freeze local file systems using Volume Shadow-copy Service. |
177 | * The frozen state is limited for up to 10 seconds by VSS. | |
d8ca685a | 178 | */ |
77dbc81b | 179 | int64_t qmp_guest_fsfreeze_freeze(Error **errp) |
d8ca685a | 180 | { |
64c00317 TS |
181 | int i; |
182 | Error *local_err = NULL; | |
183 | ||
184 | if (!vss_initialized()) { | |
77dbc81b | 185 | error_set(errp, QERR_UNSUPPORTED); |
64c00317 TS |
186 | return 0; |
187 | } | |
188 | ||
189 | slog("guest-fsfreeze called"); | |
190 | ||
191 | /* cannot risk guest agent blocking itself on a write in this state */ | |
192 | ga_set_frozen(ga_state); | |
193 | ||
77dbc81b MA |
194 | qga_vss_fsfreeze(&i, errp, true); |
195 | if (error_is_set(errp)) { | |
64c00317 TS |
196 | goto error; |
197 | } | |
198 | ||
199 | return i; | |
200 | ||
201 | error: | |
202 | qmp_guest_fsfreeze_thaw(&local_err); | |
84d18f06 | 203 | if (local_err) { |
64c00317 TS |
204 | g_debug("cleanup thaw: %s", error_get_pretty(local_err)); |
205 | error_free(local_err); | |
206 | } | |
d8ca685a MR |
207 | return 0; |
208 | } | |
209 | ||
210 | /* | |
64c00317 | 211 | * Thaw local file systems using Volume Shadow-copy Service. |
d8ca685a | 212 | */ |
77dbc81b | 213 | int64_t qmp_guest_fsfreeze_thaw(Error **errp) |
d8ca685a | 214 | { |
64c00317 TS |
215 | int i; |
216 | ||
217 | if (!vss_initialized()) { | |
77dbc81b | 218 | error_set(errp, QERR_UNSUPPORTED); |
64c00317 TS |
219 | return 0; |
220 | } | |
221 | ||
77dbc81b | 222 | qga_vss_fsfreeze(&i, errp, false); |
64c00317 TS |
223 | |
224 | ga_unset_frozen(ga_state); | |
225 | return i; | |
226 | } | |
227 | ||
228 | static void guest_fsfreeze_cleanup(void) | |
229 | { | |
230 | Error *err = NULL; | |
231 | ||
232 | if (!vss_initialized()) { | |
233 | return; | |
234 | } | |
235 | ||
236 | if (ga_is_frozen(ga_state) == GUEST_FSFREEZE_STATUS_FROZEN) { | |
237 | qmp_guest_fsfreeze_thaw(&err); | |
238 | if (err) { | |
239 | slog("failed to clean up frozen filesystems: %s", | |
240 | error_get_pretty(err)); | |
241 | error_free(err); | |
242 | } | |
243 | } | |
244 | ||
245 | vss_deinit(true); | |
d8ca685a MR |
246 | } |
247 | ||
eab5fd59 PB |
248 | /* |
249 | * Walk list of mounted file systems in the guest, and discard unused | |
250 | * areas. | |
251 | */ | |
77dbc81b | 252 | void qmp_guest_fstrim(bool has_minimum, int64_t minimum, Error **errp) |
eab5fd59 | 253 | { |
77dbc81b | 254 | error_set(errp, QERR_UNSUPPORTED); |
eab5fd59 PB |
255 | } |
256 | ||
aa59637e | 257 | typedef enum { |
f54603b6 MR |
258 | GUEST_SUSPEND_MODE_DISK, |
259 | GUEST_SUSPEND_MODE_RAM | |
aa59637e GH |
260 | } GuestSuspendMode; |
261 | ||
77dbc81b | 262 | static void check_suspend_mode(GuestSuspendMode mode, Error **errp) |
aa59637e GH |
263 | { |
264 | SYSTEM_POWER_CAPABILITIES sys_pwr_caps; | |
265 | Error *local_err = NULL; | |
266 | ||
77dbc81b | 267 | if (error_is_set(errp)) { |
aa59637e GH |
268 | return; |
269 | } | |
270 | ZeroMemory(&sys_pwr_caps, sizeof(sys_pwr_caps)); | |
271 | if (!GetPwrCapabilities(&sys_pwr_caps)) { | |
272 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
273 | "failed to determine guest suspend capabilities"); | |
274 | goto out; | |
275 | } | |
276 | ||
f54603b6 MR |
277 | switch (mode) { |
278 | case GUEST_SUSPEND_MODE_DISK: | |
279 | if (!sys_pwr_caps.SystemS4) { | |
280 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
281 | "suspend-to-disk not supported by OS"); | |
aa59637e | 282 | } |
f54603b6 MR |
283 | break; |
284 | case GUEST_SUSPEND_MODE_RAM: | |
285 | if (!sys_pwr_caps.SystemS3) { | |
286 | error_set(&local_err, QERR_QGA_COMMAND_FAILED, | |
287 | "suspend-to-ram not supported by OS"); | |
288 | } | |
289 | break; | |
290 | default: | |
aa59637e GH |
291 | error_set(&local_err, QERR_INVALID_PARAMETER_VALUE, "mode", |
292 | "GuestSuspendMode"); | |
aa59637e GH |
293 | } |
294 | ||
aa59637e GH |
295 | out: |
296 | if (local_err) { | |
77dbc81b | 297 | error_propagate(errp, local_err); |
aa59637e GH |
298 | } |
299 | } | |
300 | ||
301 | static DWORD WINAPI do_suspend(LPVOID opaque) | |
302 | { | |
303 | GuestSuspendMode *mode = opaque; | |
304 | DWORD ret = 0; | |
305 | ||
306 | if (!SetSuspendState(*mode == GUEST_SUSPEND_MODE_DISK, TRUE, TRUE)) { | |
16f4e8fa | 307 | slog("failed to suspend guest, %lu", GetLastError()); |
aa59637e GH |
308 | ret = -1; |
309 | } | |
310 | g_free(mode); | |
311 | return ret; | |
312 | } | |
313 | ||
77dbc81b | 314 | void qmp_guest_suspend_disk(Error **errp) |
11d0f125 | 315 | { |
aa59637e GH |
316 | GuestSuspendMode *mode = g_malloc(sizeof(GuestSuspendMode)); |
317 | ||
318 | *mode = GUEST_SUSPEND_MODE_DISK; | |
77dbc81b MA |
319 | check_suspend_mode(*mode, errp); |
320 | acquire_privilege(SE_SHUTDOWN_NAME, errp); | |
321 | execute_async(do_suspend, mode, errp); | |
aa59637e | 322 | |
77dbc81b | 323 | if (error_is_set(errp)) { |
aa59637e GH |
324 | g_free(mode); |
325 | } | |
11d0f125 LC |
326 | } |
327 | ||
77dbc81b | 328 | void qmp_guest_suspend_ram(Error **errp) |
fbf42210 | 329 | { |
f54603b6 MR |
330 | GuestSuspendMode *mode = g_malloc(sizeof(GuestSuspendMode)); |
331 | ||
332 | *mode = GUEST_SUSPEND_MODE_RAM; | |
77dbc81b MA |
333 | check_suspend_mode(*mode, errp); |
334 | acquire_privilege(SE_SHUTDOWN_NAME, errp); | |
335 | execute_async(do_suspend, mode, errp); | |
f54603b6 | 336 | |
77dbc81b | 337 | if (error_is_set(errp)) { |
f54603b6 MR |
338 | g_free(mode); |
339 | } | |
fbf42210 LC |
340 | } |
341 | ||
77dbc81b | 342 | void qmp_guest_suspend_hybrid(Error **errp) |
95f4f404 | 343 | { |
77dbc81b | 344 | error_set(errp, QERR_UNSUPPORTED); |
95f4f404 LC |
345 | } |
346 | ||
77dbc81b | 347 | GuestNetworkInterfaceList *qmp_guest_network_get_interfaces(Error **errp) |
3424fc9f | 348 | { |
77dbc81b | 349 | error_set(errp, QERR_UNSUPPORTED); |
3424fc9f MP |
350 | return NULL; |
351 | } | |
352 | ||
6912e6a9 LL |
353 | int64_t qmp_guest_get_time(Error **errp) |
354 | { | |
3f2a6087 LL |
355 | SYSTEMTIME ts = {0}; |
356 | int64_t time_ns; | |
357 | FILETIME tf; | |
358 | ||
359 | GetSystemTime(&ts); | |
360 | if (ts.wYear < 1601 || ts.wYear > 30827) { | |
361 | error_setg(errp, "Failed to get time"); | |
362 | return -1; | |
363 | } | |
364 | ||
365 | if (!SystemTimeToFileTime(&ts, &tf)) { | |
366 | error_setg(errp, "Failed to convert system time: %d", (int)GetLastError()); | |
367 | return -1; | |
368 | } | |
369 | ||
370 | time_ns = ((((int64_t)tf.dwHighDateTime << 32) | tf.dwLowDateTime) | |
371 | - W32_FT_OFFSET) * 100; | |
372 | ||
373 | return time_ns; | |
6912e6a9 LL |
374 | } |
375 | ||
2c958923 | 376 | void qmp_guest_set_time(bool has_time, int64_t time_ns, Error **errp) |
a1bca57f | 377 | { |
b8f954fe LL |
378 | SYSTEMTIME ts; |
379 | FILETIME tf; | |
380 | LONGLONG time; | |
381 | ||
2c958923 MP |
382 | if (has_time) { |
383 | /* Okay, user passed a time to set. Validate it. */ | |
384 | if (time_ns < 0 || time_ns / 100 > INT64_MAX - W32_FT_OFFSET) { | |
385 | error_setg(errp, "Time %" PRId64 "is invalid", time_ns); | |
386 | return; | |
387 | } | |
b8f954fe | 388 | |
2c958923 | 389 | time = time_ns / 100 + W32_FT_OFFSET; |
b8f954fe | 390 | |
2c958923 MP |
391 | tf.dwLowDateTime = (DWORD) time; |
392 | tf.dwHighDateTime = (DWORD) (time >> 32); | |
b8f954fe | 393 | |
2c958923 MP |
394 | if (!FileTimeToSystemTime(&tf, &ts)) { |
395 | error_setg(errp, "Failed to convert system time %d", | |
396 | (int)GetLastError()); | |
397 | return; | |
398 | } | |
399 | } else { | |
400 | /* Otherwise read the time from RTC which contains the correct value. | |
401 | * Hopefully. */ | |
402 | GetSystemTime(&ts); | |
403 | if (ts.wYear < 1601 || ts.wYear > 30827) { | |
404 | error_setg(errp, "Failed to get time"); | |
405 | return; | |
406 | } | |
b8f954fe LL |
407 | } |
408 | ||
409 | acquire_privilege(SE_SYSTEMTIME_NAME, errp); | |
410 | if (error_is_set(errp)) { | |
411 | return; | |
412 | } | |
413 | ||
414 | if (!SetSystemTime(&ts)) { | |
415 | error_setg(errp, "Failed to set time to guest: %d", (int)GetLastError()); | |
416 | return; | |
417 | } | |
a1bca57f LL |
418 | } |
419 | ||
70e133a7 LE |
420 | GuestLogicalProcessorList *qmp_guest_get_vcpus(Error **errp) |
421 | { | |
422 | error_set(errp, QERR_UNSUPPORTED); | |
423 | return NULL; | |
424 | } | |
425 | ||
426 | int64_t qmp_guest_set_vcpus(GuestLogicalProcessorList *vcpus, Error **errp) | |
427 | { | |
428 | error_set(errp, QERR_UNSUPPORTED); | |
429 | return -1; | |
430 | } | |
431 | ||
d8ca685a MR |
432 | /* register init/cleanup routines for stateful command groups */ |
433 | void ga_command_state_init(GAState *s, GACommandState *cs) | |
434 | { | |
64c00317 TS |
435 | if (vss_init(true)) { |
436 | ga_command_state_add(cs, NULL, guest_fsfreeze_cleanup); | |
437 | } | |
d8ca685a | 438 | } |