From 94a78597d21d778d44f86ce66110d2276825b076 Mon Sep 17 00:00:00 2001
From: phreakocious <phreakocious@users.noreply.github.com>
Date: Thu, 9 Jun 2022 08:21:38 -0500
Subject: [PATCH] Add `guest_agent` config option for QEMU driver (#12800)

Add boolean 'guest_agent' config option for QEMU driver, which will
create the socket file for the QEMU Guest Agent in the task dir when
enabled.
---
 .changelog/12800.txt                  |  3 +++
 drivers/qemu/driver.go                | 16 ++++++++++++++++
 website/content/docs/drivers/qemu.mdx |  7 +++++++
 3 files changed, 26 insertions(+)
 create mode 100644 .changelog/12800.txt

diff --git a/.changelog/12800.txt b/.changelog/12800.txt
new file mode 100644
index 000000000..b58a322a3
--- /dev/null
+++ b/.changelog/12800.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+qemu: add support for guest agent socket
+```
diff --git a/drivers/qemu/driver.go b/drivers/qemu/driver.go
index 12001b8c3..aaa8d0301 100644
--- a/drivers/qemu/driver.go
+++ b/drivers/qemu/driver.go
@@ -41,6 +41,9 @@ const (
 	qemuGracefulShutdownMsg = "system_powerdown\n"
 	qemuMonitorSocketName   = "qemu-monitor.sock"
 
+	// Socket file enabling communication with the Qemu Guest Agent (if enabled and running)
+	qemuGuestAgentSocketName = "qemu-guest-agent.sock"
+
 	// Maximum socket path length prior to qemu 2.10.1
 	qemuLegacyMaxMonitorPathLen = 108
 
@@ -94,6 +97,7 @@ var (
 		"image_path":        hclspec.NewAttr("image_path", "string", true),
 		"accelerator":       hclspec.NewAttr("accelerator", "string", false),
 		"graceful_shutdown": hclspec.NewAttr("graceful_shutdown", "bool", false),
+		"guest_agent":       hclspec.NewAttr("guest_agent", "bool", false),
 		"args":              hclspec.NewAttr("args", "list(string)", false),
 		"port_map":          hclspec.NewAttr("port_map", "list(map(number))", false),
 	})
@@ -121,6 +125,7 @@ type TaskConfig struct {
 	Args             []string           `codec:"args"`     // extra arguments to qemu executable
 	PortMap          hclutils.MapStrInt `codec:"port_map"` // A map of host port and the port name defined in the image manifest file
 	GracefulShutdown bool               `codec:"graceful_shutdown"`
+	GuestAgent       bool               `codec:"guest_agent"`
 }
 
 // TaskState is the state which is encoded in the handle returned in StartTask.
@@ -450,6 +455,17 @@ func (d *Driver) StartTask(cfg *drivers.TaskConfig) (*drivers.TaskHandle, *drive
 		args = append(args, "-monitor", fmt.Sprintf("unix:%s,server,nowait", monitorPath))
 	}
 
+	if driverConfig.GuestAgent {
+		if runtime.GOOS == "windows" {
+			return nil, nil, errors.New("QEMU Guest Agent socket is unsupported on the Windows platform")
+		}
+		// This socket will be used to communicate with the Guest Agent (if it's running)
+		taskDir := filepath.Join(cfg.AllocDir, cfg.Name)
+		args = append(args, "-chardev", fmt.Sprintf("socket,path=%s/%s,server,nowait,id=qga0", taskDir, qemuGuestAgentSocketName))
+		args = append(args, "-device", "virtio-serial")
+		args = append(args, "-device", "virtserialport,chardev=qga0,name=org.qemu.guest_agent.0")
+	}
+
 	// Add pass through arguments to qemu executable. A user can specify
 	// these arguments in driver task configuration. These arguments are
 	// passed directly to the qemu driver as command line options.
diff --git a/website/content/docs/drivers/qemu.mdx b/website/content/docs/drivers/qemu.mdx
index 7ba7630c3..30cb1bf0e 100644
--- a/website/content/docs/drivers/qemu.mdx
+++ b/website/content/docs/drivers/qemu.mdx
@@ -61,6 +61,13 @@ The `qemu` driver supports the following configuration in the job spec:
   [alloc_dir](/docs/configuration/client#alloc_dir)
   paths.) This feature is currently not supported on Windows.
 
+- `guest_agent` `(bool: false)` - Enable support for the [QEMU Guest 
+  Agent](https://wiki.qemu.org/Features/GuestAgent) for this virtual machine. This 
+  will add the necessary virtual hardware and create a `qemu-guest-agent.sock`
+  file in the task's working directory for interacting with the agent. The QEMU Guest
+  Agent must be running in the guest VM.  This feature is currently not supported
+  on Windows.
+
 - `port_map` - (Optional) A key-value map of port labels.
 
   ```hcl