mnl/VM-Operator
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 4 Wiki Activity Actions

Add powerdown through guest agent (more reliable).

Browse source
This commit is contained in:
Michael Lipp 2025-03-13 17:45:28 +01:00
parent 2a3774ae24
commit 2d16cbc352
5 changed files with 181 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
org.jdrupes.vmoperator.runner.qemu/src/org/jdrupes/vmoperator/runner/qemu/AgentConnector.java
View file

@ -92,8 +92,12 @@ public abstract class AgentConnector extends QemuConnector {
*/
@Handler
public void onVserportChanged(VserportChangeEvent event) {
if (event.id().equals(channelId) && event.isOpen()) {
agentConnected();
if (event.id().equals(channelId)) {
if (event.isOpen()) {
agentConnected();
} else {
agentDisconnected();
}
}
}
@ -105,4 +109,14 @@ public abstract class AgentConnector extends QemuConnector {
protected void agentConnected() {
// Default is to do nothing.
}
/**
* Called when the agent in the VM closes the connection. The
* default implementation does nothing.
*/
@SuppressWarnings("PMD.EmptyMethodInAbstractClassShouldBeAbstract")
protected void agentDisconnected() {
// Default is to do nothing.
}
}

111
org.jdrupes.vmoperator.runner.qemu/src/org/jdrupes/vmoperator/runner/qemu/GuestAgentClient.java
View file

@ -21,15 +21,23 @@ package org.jdrupes.vmoperator.runner.qemu;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.node.ObjectNode;
import java.io.IOException;
import java.time.Instant;
import java.util.LinkedList;
import java.util.Queue;
import java.util.logging.Level;
import org.jdrupes.vmoperator.runner.qemu.Constants.ProcessName;
import org.jdrupes.vmoperator.runner.qemu.commands.QmpCommand;
import org.jdrupes.vmoperator.runner.qemu.commands.QmpGuestGetOsinfo;
import org.jdrupes.vmoperator.runner.qemu.commands.QmpGuestPowerdown;
import org.jdrupes.vmoperator.runner.qemu.events.ConfigureQemu;
import org.jdrupes.vmoperator.runner.qemu.events.GuestAgentCommand;
import org.jdrupes.vmoperator.runner.qemu.events.OsinfoEvent;
import org.jgrapes.core.Channel;
import org.jgrapes.core.Components;
import org.jgrapes.core.Components.Timer;
import org.jgrapes.core.annotation.Handler;
import org.jgrapes.core.events.Stop;
import org.jgrapes.io.events.ProcessExited;
/**
* A component that handles the communication with the guest agent.
@ -39,7 +47,12 @@ import org.jgrapes.core.annotation.Handler;
*/
public class GuestAgentClient extends AgentConnector {
private boolean connected;
private Instant powerdownStartedAt;
private int powerdownTimeout;
private Timer powerdownTimer;
private final Queue<QmpCommand> executing = new LinkedList<>();
private Stop suspendedStop;
/**
* Instantiates a new guest agent client.
@ -56,9 +69,17 @@ public class GuestAgentClient extends AgentConnector {
*/
@Override
protected void agentConnected() {
logger.fine(() -> "guest agent connected");
connected = true;
rep().fire(new GuestAgentCommand(new QmpGuestGetOsinfo()));
}
@Override
protected void agentDisconnected() {
logger.fine(() -> "guest agent disconnected");
connected = false;
}
/**
* Process agent input.
*
@ -88,10 +109,11 @@ public class GuestAgentClient extends AgentConnector {
* On guest agent command.
*
* @param event the event
* @throws IOException
* @throws IOException Signals that an I/O exception has occurred.
*/
@Handler
@SuppressWarnings("PMD.AvoidSynchronizedStatement")
@SuppressWarnings({ "PMD.AvoidSynchronizedStatement",
"PMD.AvoidDuplicateLiterals" })
public void onGuestAgentCommand(GuestAgentCommand event)
throws IOException {
if (qemuChannel() == null) {
@ -114,4 +136,89 @@ public class GuestAgentClient extends AgentConnector {
}
}
}
/**
* Shutdown the VM.
*
* @param event the event
*/
@Handler(priority = 200)
@SuppressWarnings("PMD.AvoidSynchronizedStatement")
public void onStop(Stop event) {
if (!connected) {
logger.fine(() -> "No guest agent connection,"
+ " cannot send shutdown command");
return;
}
// We have a connection to the guest agent attempt shutdown.
powerdownStartedAt = event.associated(Instant.class).orElseGet(() -> {
var now = Instant.now();
event.setAssociated(Instant.class, now);
return now;
});
var waitUntil = powerdownStartedAt.plusSeconds(powerdownTimeout);
if (waitUntil.isBefore(Instant.now())) {
return;
}
event.suspendHandling();
suspendedStop = event;
logger.fine(() -> "Sending powerdown command, waiting for"
+ " termination until " + waitUntil);
powerdownTimer = Components.schedule(t -> {
logger.fine(() -> "Powerdown timeout reached.");
synchronized (this) {
powerdownTimer = null;
if (suspendedStop != null) {
suspendedStop.resumeHandling();
suspendedStop = null;
}
}
}, waitUntil);
rep().fire(new GuestAgentCommand(new QmpGuestPowerdown()));
}
/**
* On process exited.
*
* @param event the event
*/
@Handler
@SuppressWarnings("PMD.AvoidSynchronizedStatement")
public void onProcessExited(ProcessExited event) {
if (!event.startedBy().associated(CommandDefinition.class)
.map(cd -> ProcessName.QEMU.equals(cd.name())).orElse(false)) {
return;
}
synchronized (this) {
if (powerdownTimer != null) {
powerdownTimer.cancel();
}
if (suspendedStop != null) {
suspendedStop.resumeHandling();
suspendedStop = null;
}
}
}
/**
* On configure qemu.
*
* @param event the event
*/
@Handler
@SuppressWarnings("PMD.AvoidSynchronizedStatement")
public void onConfigureQemu(ConfigureQemu event) {
int newTimeout = event.configuration().vm.powerdownTimeout;
if (powerdownTimeout != newTimeout) {
powerdownTimeout = newTimeout;
synchronized (this) {
if (powerdownTimer != null) {
powerdownTimer
.reschedule(powerdownStartedAt.plusSeconds(newTimeout));
}
}
}
}
}

20
org.jdrupes.vmoperator.runner.qemu/src/org/jdrupes/vmoperator/runner/qemu/QemuMonitor.java
View file

@ -197,12 +197,20 @@ public class QemuMonitor extends QemuConnector {
return;
}
// We have a connection to Qemu, attempt ACPI shutdown.
// We have a connection to Qemu, attempt ACPI shutdown if time left
powerdownStartedAt = event.associated(Instant.class).orElseGet(() -> {
var now = Instant.now();
event.setAssociated(Instant.class, now);
return now;
});
if (powerdownStartedAt.plusSeconds(powerdownTimeout)
.isBefore(Instant.now())) {
return;
}
event.suspendHandling();
suspendedStop = event;
// Attempt powerdown command. If not confirmed, assume
// "hanging" qemu process.
// Send command. If not confirmed, assume "hanging" qemu process.
powerdownTimer = Components.schedule(t -> {
logger.fine(() -> "QMP powerdown command not confirmed");
synchronized (this) {
@ -213,9 +221,8 @@ public class QemuMonitor extends QemuConnector {
}
}
}, Duration.ofSeconds(5));
logger.fine(() -> "Attempting QMP powerdown.");
powerdownStartedAt = Instant.now();
fire(new MonitorCommand(new QmpPowerdown()));
logger.fine(() -> "Attempting QMP (ACPI) powerdown.");
rep().fire(new MonitorCommand(new QmpPowerdown()));
}
/**
@ -241,6 +248,7 @@ public class QemuMonitor extends QemuConnector {
powerdownTimer = Components.schedule(t -> {
logger.fine(() -> "Powerdown timeout reached.");
synchronized (this) {
powerdownTimer = null;
if (suspendedStop != null) {
suspendedStop.resumeHandling();
suspendedStop = null;

41
org.jdrupes.vmoperator.runner.qemu/src/org/jdrupes/vmoperator/runner/qemu/commands/QmpGuestPowerdown.java Normal file
View file

@ -0,0 +1,41 @@
/*
* VM-Operator
* Copyright (C) 2025 Michael N. Lipp
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package org.jdrupes.vmoperator.runner.qemu.commands;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
/**
* A {@link QmpCommand} that powers down the guest.
*/
public class QmpGuestPowerdown extends QmpCommand {
@Override
public JsonNode toJson() {
ObjectNode cmd = mapper.createObjectNode();
cmd.put("execute", "guest-shutdown");
return cmd;
}
@Override
public String toString() {
return "QmpGuestPowerdown()";
}
}