]>
Commit | Line | Data |
---|---|---|
30a3378a DM |
1 | package PVE::QMPClient; |
2 | ||
3 | use strict; | |
990fc5e2 | 4 | use warnings; |
30a3378a DM |
5 | use PVE::QemuServer; |
6 | use IO::Multiplex; | |
2ae10d4e | 7 | use POSIX qw(EINTR EAGAIN); |
30a3378a | 8 | use JSON; |
2ae10d4e | 9 | use Time::HiRes qw(usleep gettimeofday tv_interval); |
b3ea07f7 | 10 | use Scalar::Util qw(weaken); |
558f1644 | 11 | use PVE::IPCC; |
2ae10d4e | 12 | |
30a3378a DM |
13 | use Data::Dumper; |
14 | ||
15 | # Qemu Monitor Protocol (QMP) client. | |
16 | # | |
17 | # This implementation uses IO::Multiplex (libio-multiplex-perl) and | |
7a6c2150 | 18 | # allows you to issue qmp and qga commands to different VMs in parallel. |
30a3378a | 19 | |
7a6c2150 | 20 | # Note: qemu can onyl handle 1 connection, so we close connections asap |
30a3378a DM |
21 | |
22 | sub new { | |
c5a07de5 | 23 | my ($class, $eventcb) = @_; |
30a3378a DM |
24 | |
25 | my $mux = new IO::Multiplex; | |
26 | ||
27 | my $self = bless { | |
28 | mux => $mux, | |
7a6c2150 DM |
29 | queue_lookup => {}, # $fh => $queue_info |
30 | queue_info => {}, | |
30a3378a DM |
31 | }, $class; |
32 | ||
33 | $self->{eventcb} = $eventcb if $eventcb; | |
34 | ||
35 | $mux->set_callback_object($self); | |
36 | ||
558f1644 | 37 | # make sure perl doesn't believe this is a circular reference as we |
b3ea07f7 DM |
38 | # delete mux in DESTROY |
39 | weaken($mux->{_object}); | |
40 | ||
30a3378a DM |
41 | return $self; |
42 | } | |
43 | ||
7a6c2150 DM |
44 | # Note: List of special QGA command. Those commands can close the connection |
45 | # without sending a response. | |
46 | ||
47 | my $qga_allow_close_cmds = { | |
48 | 'guest-shutdown' => 1, | |
49 | 'guest-suspend-ram' => 1, | |
50 | 'guest-suspend-disk' => 1, | |
51 | 'guest-suspend-hybrid' => 1, | |
52 | }; | |
53 | ||
54 | my $push_cmd_to_queue = sub { | |
55 | my ($self, $vmid, $cmd) = @_; | |
56 | ||
57 | my $execute = $cmd->{execute} || die "no command name specified"; | |
58 | ||
59 | my $qga = ($execute =~ /^guest\-+/) ? 1 : 0; | |
60 | ||
61 | my $sname = PVE::QemuServer::qmp_socket($vmid, $qga); | |
62 | ||
63 | $self->{queue_info}->{$sname} = { qga => $qga, vmid => $vmid, sname => $sname, cmds => [] } | |
64 | if !$self->{queue_info}->{$sname}; | |
65 | ||
66 | push @{$self->{queue_info}->{$sname}->{cmds}}, $cmd; | |
67 | ||
68 | return $self->{queue_info}->{$sname}; | |
69 | }; | |
70 | ||
558f1644 | 71 | # add a single command to the queue for later execution |
30a3378a DM |
72 | # with queue_execute() |
73 | sub queue_cmd { | |
74 | my ($self, $vmid, $callback, $execute, %params) = @_; | |
75 | ||
76 | my $cmd = {}; | |
77 | $cmd->{execute} = $execute; | |
78 | $cmd->{arguments} = \%params; | |
79 | $cmd->{callback} = $callback; | |
80 | ||
7a6c2150 DM |
81 | &$push_cmd_to_queue($self, $vmid, $cmd); |
82 | ||
83 | return undef; | |
30a3378a DM |
84 | } |
85 | ||
86 | # execute a single command | |
87 | sub cmd { | |
f0002f62 | 88 | my ($self, $vmid, $cmd, $timeout) = @_; |
30a3378a DM |
89 | |
90 | my $result; | |
91 | ||
92 | my $callback = sub { | |
93 | my ($vmid, $resp) = @_; | |
94 | $result = $resp->{'return'}; | |
95 | }; | |
96 | ||
7a6c2150 | 97 | die "no command specified" if !($cmd && $cmd->{execute}); |
f0002f62 | 98 | |
30a3378a DM |
99 | $cmd->{callback} = $callback; |
100 | $cmd->{arguments} = {} if !defined($cmd->{arguments}); | |
101 | ||
7a6c2150 | 102 | my $queue_info = &$push_cmd_to_queue($self, $vmid, $cmd); |
30a3378a | 103 | |
f0002f62 DM |
104 | if (!$timeout) { |
105 | # hack: monitor sometime blocks | |
106 | if ($cmd->{execute} eq 'query-migrate') { | |
107 | $timeout = 60*60; # 1 hour | |
108 | } elsif ($cmd->{execute} =~ m/^(eject|change)/) { | |
109 | $timeout = 60; # note: cdrom mount command is slow | |
9dcf4909 DM |
110 | } elsif ($cmd->{execute} eq 'savevm-start' || |
111 | $cmd->{execute} eq 'savevm-end' || | |
558f1644 | 112 | $cmd->{execute} eq 'query-backup' || |
4fca0153 | 113 | $cmd->{execute} eq 'query-block-jobs' || |
fc97ae27 | 114 | $cmd->{execute} eq 'backup-cancel' || |
9dcf4909 | 115 | $cmd->{execute} eq 'query-savevm' || |
1c0c1c17 WL |
116 | $cmd->{execute} eq 'delete-drive-snapshot' || |
117 | $cmd->{execute} eq 'guest-shutdown' || | |
9d689077 DM |
118 | $cmd->{execute} eq 'snapshot-drive' ) { |
119 | $timeout = 10*60; # 10 mins ? | |
14db5366 DM |
120 | } else { |
121 | $timeout = 3; # default | |
f0002f62 DM |
122 | } |
123 | } | |
124 | ||
125 | $self->queue_execute($timeout); | |
30a3378a | 126 | |
7a6c2150 DM |
127 | |
128 | die "VM $vmid qmp command '$cmd->{execute}' failed - $queue_info->{error}" | |
129 | if defined($queue_info->{error}); | |
30a3378a DM |
130 | |
131 | return $result; | |
132 | }; | |
133 | ||
134 | my $cmdid_seq = 0; | |
c5a07de5 | 135 | my $cmdid_seq_qga = 0; |
7a6c2150 | 136 | |
30a3378a | 137 | my $next_cmdid = sub { |
c5a07de5 WL |
138 | my ($qga) = @_; |
139 | ||
140 | if($qga){ | |
141 | $cmdid_seq_qga++; | |
142 | return "$$"."0".$cmdid_seq_qga; | |
143 | } else { | |
144 | $cmdid_seq++; | |
145 | return "$$:$cmdid_seq"; | |
146 | } | |
30a3378a DM |
147 | }; |
148 | ||
7a6c2150 DM |
149 | my $lookup_queue_info = sub { |
150 | my ($self, $fh, $noerr) = @_; | |
558f1644 | 151 | |
7a6c2150 DM |
152 | my $queue_info = $self->{queue_lookup}->{$fh}; |
153 | if (!$queue_info) { | |
154 | warn "internal error - unable to lookup queue info" if !$noerr; | |
155 | return undef; | |
156 | } | |
157 | return $queue_info; | |
158 | }; | |
558f1644 | 159 | |
7a6c2150 DM |
160 | my $close_connection = sub { |
161 | my ($self, $queue_info) = @_; | |
30a3378a | 162 | |
7a6c2150 DM |
163 | if (my $fh = delete $queue_info->{fh}) { |
164 | delete $self->{queue_lookup}->{$fh}; | |
165 | $self->{mux}->close($fh); | |
166 | } | |
30a3378a DM |
167 | }; |
168 | ||
169 | my $open_connection = sub { | |
7a6c2150 DM |
170 | my ($self, $queue_info, $timeout) = @_; |
171 | ||
172 | die "duplicate call to open" if defined($queue_info->{fh}); | |
173 | ||
174 | my $vmid = $queue_info->{vmid}; | |
175 | my $qga = $queue_info->{qga}; | |
30a3378a | 176 | |
c5a07de5 | 177 | my $sname = PVE::QemuServer::qmp_socket($vmid, $qga); |
30a3378a | 178 | |
6d042176 DM |
179 | $timeout = 1 if !$timeout; |
180 | ||
2ae10d4e DM |
181 | my $fh; |
182 | my $starttime = [gettimeofday]; | |
183 | my $count = 0; | |
7a6c2150 DM |
184 | |
185 | my $sotype = $qga ? 'qga' : 'qmp'; | |
186 | ||
2ae10d4e DM |
187 | for (;;) { |
188 | $count++; | |
189 | $fh = IO::Socket::UNIX->new(Peer => $sname, Blocking => 0, Timeout => 1); | |
190 | last if $fh; | |
191 | if ($! != EINTR && $! != EAGAIN) { | |
7a6c2150 | 192 | die "unable to connect to VM $vmid $sotype socket - $!\n"; |
2ae10d4e DM |
193 | } |
194 | my $elapsed = tv_interval($starttime, [gettimeofday]); | |
6d042176 | 195 | if ($elapsed >= $timeout) { |
7a6c2150 | 196 | die "unable to connect to VM $vmid $sotype socket - timeout after $count retries\n"; |
2ae10d4e DM |
197 | } |
198 | usleep(100000); | |
199 | } | |
30a3378a | 200 | |
7a6c2150 DM |
201 | $queue_info->{fh} = $fh; |
202 | ||
203 | $self->{queue_lookup}->{$fh} = $queue_info; | |
204 | ||
30a3378a | 205 | $self->{mux}->add($fh); |
7a6c2150 | 206 | $self->{mux}->set_timeout($fh, $timeout); |
558f1644 | 207 | |
30a3378a DM |
208 | return $fh; |
209 | }; | |
210 | ||
211 | my $check_queue = sub { | |
212 | my ($self) = @_; | |
213 | ||
214 | my $running = 0; | |
558f1644 | 215 | |
7a6c2150 DM |
216 | foreach my $sname (keys %{$self->{queue_info}}) { |
217 | my $queue_info = $self->{queue_info}->{$sname}; | |
218 | my $fh = $queue_info->{fh}; | |
30a3378a DM |
219 | next if !$fh; |
220 | ||
7a6c2150 DM |
221 | my $qga = $queue_info->{qga}; |
222 | ||
223 | if ($queue_info->{error}) { | |
224 | &$close_connection($self, $queue_info); | |
30a3378a DM |
225 | next; |
226 | } | |
227 | ||
7a6c2150 | 228 | if ($queue_info->{current}) { # command running, waiting for response |
30a3378a DM |
229 | $running++; |
230 | next; | |
231 | } | |
232 | ||
7a6c2150 DM |
233 | if (!scalar(@{$queue_info->{cmds}})) { # no more commands |
234 | &$close_connection($self, $queue_info); | |
30a3378a DM |
235 | next; |
236 | } | |
237 | ||
238 | eval { | |
239 | ||
7a6c2150 DM |
240 | my $cmd = $queue_info->{current} = shift @{$queue_info->{cmds}}; |
241 | $cmd->{id} = &$next_cmdid($qga); | |
30a3378a | 242 | |
558f1644 | 243 | my $fd = -1; |
a0e7a5d0 | 244 | if ($cmd->{execute} eq 'add-fd' || $cmd->{execute} eq 'getfd') { |
558f1644 DM |
245 | $fd = $cmd->{arguments}->{fd}; |
246 | delete $cmd->{arguments}->{fd}; | |
247 | } | |
248 | ||
7a6c2150 | 249 | my $qmpcmd; |
a45a14fc | 250 | |
7a6c2150 | 251 | if ($qga) { |
a45a14fc | 252 | |
7a6c2150 DM |
253 | $qmpcmd = to_json({ execute => 'guest-sync', arguments => { id => int($cmd->{id})}}) . |
254 | to_json({ execute => $cmd->{execute}, arguments => $cmd->{arguments}}); | |
a45a14fc | 255 | |
7a6c2150 | 256 | } else { |
a45a14fc AD |
257 | |
258 | $qmpcmd = to_json({ | |
259 | execute => $cmd->{execute}, | |
260 | arguments => $cmd->{arguments}, | |
261 | id => $cmd->{id}}); | |
262 | } | |
30a3378a | 263 | |
558f1644 DM |
264 | if ($fd >= 0) { |
265 | my $ret = PVE::IPCC::sendfd(fileno($fh), $fd, $qmpcmd); | |
266 | die "sendfd failed" if $ret < 0; | |
267 | } else { | |
268 | $self->{mux}->write($fh, $qmpcmd); | |
269 | } | |
30a3378a DM |
270 | }; |
271 | if (my $err = $@) { | |
7a6c2150 | 272 | $queue_info->{error} = $err; |
30a3378a DM |
273 | } else { |
274 | $running++; | |
275 | } | |
276 | } | |
277 | ||
278 | $self->{mux}->endloop() if !$running; | |
279 | ||
280 | return $running; | |
281 | }; | |
282 | ||
283 | # execute all queued command | |
284 | sub queue_execute { | |
285 | my ($self, $timeout) = @_; | |
286 | ||
287 | $timeout = 3 if !$timeout; | |
288 | ||
30a3378a | 289 | # open all necessary connections |
7a6c2150 DM |
290 | foreach my $sname (keys %{$self->{queue_info}}) { |
291 | my $queue_info = $self->{queue_info}->{$sname}; | |
292 | next if !scalar(@{$queue_info->{cmds}}); # no commands | |
293 | ||
294 | $queue_info->{error} = undef; | |
295 | $queue_info->{current} = undef; | |
c5a07de5 WL |
296 | |
297 | eval { | |
7a6c2150 | 298 | &$open_connection($self, $queue_info, $timeout); |
c6fb6a69 | 299 | |
7a6c2150 DM |
300 | if (!$queue_info->{qga}) { |
301 | my $cap_cmd = { execute => 'qmp_capabilities', arguments => {} }; | |
302 | unshift @{$queue_info->{cmds}}, $cap_cmd; | |
c6fb6a69 | 303 | } |
30a3378a DM |
304 | }; |
305 | if (my $err = $@) { | |
306 | warn $err; | |
7a6c2150 | 307 | $queue_info->{error} = $err; |
30a3378a DM |
308 | } |
309 | } | |
310 | ||
311 | my $running; | |
312 | ||
313 | for (;;) { | |
314 | ||
315 | $running = &$check_queue($self); | |
316 | ||
317 | last if !$running; | |
318 | ||
319 | $self->{mux}->loop; | |
320 | } | |
321 | ||
322 | # make sure we close everything | |
7a6c2150 DM |
323 | foreach my $sname (keys %{$self->{queue_info}}) { |
324 | &$close_connection($self, $self->{queue_info}->{$sname}); | |
30a3378a DM |
325 | } |
326 | ||
7a6c2150 | 327 | $self->{queue_info} = $self->{queue_lookup} = {}; |
30a3378a DM |
328 | } |
329 | ||
b006e70b DM |
330 | sub mux_close { |
331 | my ($self, $mux, $fh) = @_; | |
332 | ||
7a6c2150 DM |
333 | my $queue_info = &$lookup_queue_info($self, $fh, 1); |
334 | return if !$queue_info; | |
b006e70b | 335 | |
7a6c2150 DM |
336 | $queue_info->{error} = "client closed connection\n" |
337 | if !$queue_info->{error}; | |
b006e70b DM |
338 | } |
339 | ||
30a3378a DM |
340 | # mux_input is called when input is available on one of |
341 | # the descriptors. | |
342 | sub mux_input { | |
343 | my ($self, $mux, $fh, $input) = @_; | |
344 | ||
7a6c2150 DM |
345 | my $queue_info = &$lookup_queue_info($self, $fh); |
346 | return if !$queue_info; | |
347 | ||
348 | my $sname = $queue_info->{sname}; | |
349 | my $vmid = $queue_info->{vmid}; | |
350 | my $qga = $queue_info->{qga}; | |
c5a07de5 | 351 | |
7a6c2150 DM |
352 | my $curcmd = $queue_info->{current}; |
353 | die "unable to lookup current command for VM $vmid ($sname)\n" if !$curcmd; | |
354 | ||
bcfbc40b AD |
355 | my $raw; |
356 | ||
7a6c2150 | 357 | if ($qga) { |
bcfbc40b AD |
358 | return if $$input !~ s/^([^\n]+}\n[^\n]+})\n(.*)$/$2/so; |
359 | $raw = $1; | |
c5a07de5 | 360 | } else { |
bcfbc40b AD |
361 | return if $$input !~ s/^([^\n]+})\r?\n(.*)$/$2/so; |
362 | $raw = $1; | |
363 | } | |
30a3378a | 364 | |
30a3378a DM |
365 | eval { |
366 | my @jsons = split("\n", $raw); | |
367 | ||
7a6c2150 | 368 | if ($qga) { |
bcfbc40b AD |
369 | |
370 | die "response is not complete" if @jsons != 2 ; | |
371 | ||
372 | my $obj = from_json($jsons[0]); | |
7a6c2150 | 373 | my $cmdid = $obj->{'return'}; |
bcfbc40b | 374 | die "received responsed without command id\n" if !$cmdid; |
7a6c2150 DM |
375 | |
376 | delete $queue_info->{current}; | |
bcfbc40b AD |
377 | |
378 | if ($curcmd->{id} ne $cmdid) { | |
379 | die "got wrong command id '$cmdid' (expected $curcmd->{id})\n"; | |
380 | } | |
381 | ||
382 | $obj = from_json($jsons[1]); | |
383 | ||
384 | if (my $callback = $curcmd->{callback}) { | |
385 | &$callback($vmid, $obj); | |
386 | } | |
387 | ||
388 | return; | |
389 | } | |
390 | ||
30a3378a DM |
391 | foreach my $json (@jsons) { |
392 | my $obj = from_json($json); | |
393 | next if defined($obj->{QMP}); # skip monitor greeting | |
394 | ||
395 | if (exists($obj->{error}->{desc})) { | |
396 | my $desc = $obj->{error}->{desc}; | |
397 | chomp $desc; | |
398 | die "$desc\n" if $desc !~ m/Connection can not be completed immediately/; | |
399 | next; | |
400 | } | |
401 | ||
30a3378a DM |
402 | if (defined($obj->{event})) { |
403 | if (my $eventcb = $self->{eventcb}) { | |
404 | &$eventcb($obj); | |
405 | } | |
406 | next; | |
407 | } | |
408 | ||
409 | my $cmdid = $obj->{id}; | |
410 | die "received responsed without command id\n" if !$cmdid; | |
411 | ||
7a6c2150 | 412 | delete $queue_info->{current}; |
558f1644 | 413 | |
30a3378a DM |
414 | if ($curcmd->{id} ne $cmdid) { |
415 | die "got wrong command id '$cmdid' (expected $curcmd->{id})\n"; | |
416 | } | |
417 | ||
418 | if (my $callback = $curcmd->{callback}) { | |
419 | &$callback($vmid, $obj); | |
420 | } | |
421 | } | |
422 | }; | |
423 | if (my $err = $@) { | |
7a6c2150 | 424 | $queue_info->{error} = $err; |
30a3378a DM |
425 | } |
426 | ||
427 | &$check_queue($self); | |
428 | } | |
429 | ||
430 | # This gets called every second to update player info, etc... | |
431 | sub mux_timeout { | |
432 | my ($self, $mux, $fh) = @_; | |
433 | ||
7a6c2150 DM |
434 | if (my $queue_info = &$lookup_queue_info($self, $fh)) { |
435 | $queue_info->{error} = "got timeout\n"; | |
30a3378a DM |
436 | } |
437 | ||
438 | &$check_queue($self); | |
439 | } | |
440 | ||
1c0c1c17 WL |
441 | sub mux_eof { |
442 | my ($self, $mux, $fh, $input) = @_; | |
443 | ||
7a6c2150 DM |
444 | my $queue_info = &$lookup_queue_info($self, $fh); |
445 | return if !$queue_info; | |
1c0c1c17 | 446 | |
7a6c2150 DM |
447 | my $sname = $queue_info->{sname}; |
448 | my $vmid = $queue_info->{vmid}; | |
449 | my $qga = $queue_info->{qga}; | |
450 | ||
451 | my $curcmd = $queue_info->{current}; | |
452 | die "unable to lookup current command for VM $vmid ($sname)\n" if !$curcmd; | |
1c0c1c17 | 453 | |
7a6c2150 | 454 | if ($qga && $qga_allow_close_cmds->{$curcmd->{execute}}) { |
1c0c1c17 | 455 | |
7a6c2150 | 456 | return if $$input !~ s/^([^\n]+})\n(.*)$/$2/so; |
1c0c1c17 | 457 | |
7a6c2150 | 458 | my @jsons = split("\n", $1); |
1c0c1c17 | 459 | |
7a6c2150 DM |
460 | my $obj = from_json($jsons[0]); |
461 | ||
462 | my $cmdid = $obj->{'return'}; | |
463 | die "received responsed without command id\n" if !$cmdid; | |
464 | ||
465 | delete $queue_info->{current}; | |
1c0c1c17 | 466 | |
7a6c2150 | 467 | &$close_connection($self, $queue_info); |
1c0c1c17 | 468 | } |
1c0c1c17 WL |
469 | } |
470 | ||
26f11676 | 471 | 1; |