Merge branch 'release/0.0.5'

Release: com.io7m.waxmill 0.0.5
Change: Refactor ZFS handling (Ticket: #29)

README-CHANGES.xml

@@ -35,15 +35,24 @@
         </c:change>
       </c:changes>
     </c:release>
-    <c:release date="2020-07-28T15:55:45+00:00" ticket-system="com.github.io7m.waxmill" version="0.0.4">
+    <c:release date="2020-07-28T00:00:00+00:00" ticket-system="com.github.io7m.waxmill" version="0.0.4">
       <c:changes>
-        <c:change date="2020-07-28T15:55:45+00:00" summary="Fix issue creating ZFS volumes">
+        <c:change date="2020-07-28T00:00:00+00:00" summary="Fix issue creating ZFS volumes">
           <c:tickets>
             <c:ticket id="28"/>
           </c:tickets>
         </c:change>
       </c:changes>
     </c:release>
+    <c:release date="2020-07-29T18:45:21+00:00" ticket-system="com.github.io7m.waxmill" version="0.0.5">
+      <c:changes>
+        <c:change date="2020-07-29T18:45:21+00:00" summary="Refactor ZFS handling">
+          <c:tickets>
+            <c:ticket id="29"/>
+          </c:tickets>
+        </c:change>
+      </c:changes>
+    </c:release>
   </c:releases>
   <c:ticket-systems>
     <c:ticket-system default="true" id="com.github.io7m.waxmill" url="https://www.github.com/io7m/waxmill/issues/"/>

com.io7m.waxmill.boot/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.waxmill</artifactId>
     <groupId>com.io7m.waxmill</groupId>
-    <version>0.0.4</version>
+    <version>0.0.5</version>
   </parent>
 
   <artifactId>com.io7m.waxmill.boot</artifactId>

com.io7m.waxmill.boot/src/main/java/com/io7m/waxmill/boot/WXMBootConfigurationEvaluator.java

@@ -39,6 +39,7 @@
 import com.io7m.waxmill.machines.WXMDeviceLPC;
 import com.io7m.waxmill.machines.WXMDevicePassthru;
 import com.io7m.waxmill.machines.WXMDeviceSlot;
+import com.io7m.waxmill.machines.WXMDeviceSlots;
 import com.io7m.waxmill.machines.WXMDeviceType;
 import com.io7m.waxmill.machines.WXMDeviceVirtioBlockStorage;
 import com.io7m.waxmill.machines.WXMDeviceVirtioNetwork;
@@ -50,14 +51,16 @@
 import com.io7m.waxmill.machines.WXMNetworkDeviceBackendType;
 import com.io7m.waxmill.machines.WXMOpenOption;
 import com.io7m.waxmill.machines.WXMStorageBackendFile;
-import com.io7m.waxmill.machines.WXMStorageBackends;
 import com.io7m.waxmill.machines.WXMTTYBackendFile;
 import com.io7m.waxmill.machines.WXMTTYBackendNMDM;
 import com.io7m.waxmill.machines.WXMTTYBackendStdio;
 import com.io7m.waxmill.machines.WXMTap;
 import com.io7m.waxmill.machines.WXMVMNet;
 import com.io7m.waxmill.machines.WXMVirtualMachine;
+import com.io7m.waxmill.machines.WXMZFSFilesystems;
+import com.io7m.waxmill.machines.WXMZFSVolumes;
 
+import java.io.IOException;
 import java.net.Inet4Address;
 import java.net.Inet6Address;
 import java.net.InetAddress;
@@ -483,10 +486,15 @@ private void networkDeviceBackendCommands(
 
   private WXMCommandExecution generateGRUBBhyveCommand()
   {
-    final var machineId =
-      this.machine.id();
+    final String machineId =
+      this.machine.id().toString();
+
     final var basePath =
-      this.clientConfiguration.virtualMachineRuntimeDirectoryFor(machineId);
+      WXMZFSFilesystems.resolve(
+        this.clientConfiguration.virtualMachineRuntimeFilesystem(),
+        machineId
+      ).mountPoint();
+
     final var deviceMapPath =
       this.grubDeviceMapPath();
 
@@ -500,7 +508,7 @@ private WXMCommandExecution generateGRUBBhyveCommand()
       .addArguments("--root=host")
       .addArguments(String.format("--directory=%s", basePath))
       .addArguments(String.format("--memory=%sM", memoryMB))
-      .addArguments(machineId.toString())
+      .addArguments(machineId)
       .build();
   }
 
@@ -731,7 +739,8 @@ private void configureBhyveDeviceLPCBackend(
             "%s,%s",
             nmdm.device(),
             nmdmPath(
-              this.clientConfiguration.virtualMachineRuntimeDirectory()
+              this.clientConfiguration.virtualMachineRuntimeFilesystem()
+                .mountPoint()
                 .getFileSystem(),
               this.machine.id(),
               NMDM_HOST
@@ -812,10 +821,13 @@ private String configureBhyveDeviceStorageBackend(
   private String configureBhyveStorageZFS(
     final WXMDeviceType device)
   {
-    return WXMStorageBackends.determineZFSVolumePath(
-      this.clientConfiguration.virtualMachineRuntimeDirectory(),
-      this.machine.id(),
-      device.deviceSlot())
+    final var vmFs =
+      this.clientConfiguration.virtualMachineRuntimeFilesystemFor(this.machine.id());
+    final var diskName =
+      WXMDeviceSlots.asDiskName(device.deviceSlot());
+
+    return WXMZFSVolumes.resolve(vmFs, diskName)
+      .device()
       .toString();
   }
 
@@ -881,20 +893,22 @@ private WXMEvaluatedBootConfigurationGRUBBhyve evaluateGRUBConfigurationOpenBSD(
 
   private Path grubDeviceMapPath()
   {
-    final var machineId =
-      this.machine.id();
-    final var basePath =
-      this.clientConfiguration.virtualMachineRuntimeDirectoryFor(machineId);
-    return basePath.resolve("grub-device.map");
+    final var machineId = this.machine.id();
+    return WXMZFSFilesystems.resolve(
+      this.clientConfiguration.virtualMachineRuntimeFilesystem(),
+      machineId.toString()
+    ).mountPoint()
+      .resolve("grub-device.map");
   }
 
   private Path grubConfigPath()
   {
-    final var machineId =
-      this.machine.id();
-    final var basePath =
-      this.clientConfiguration.virtualMachineRuntimeDirectoryFor(machineId);
-    return basePath.resolve("grub.cfg");
+    final var machineId = this.machine.id();
+    return WXMZFSFilesystems.resolve(
+      this.clientConfiguration.virtualMachineRuntimeFilesystem(),
+      machineId.toString()
+    ).mountPoint()
+      .resolve("grub.cfg");
   }
 
   private WXMEvaluatedBootConfigurationGRUBBhyve evaluateGRUBConfigurationLinux(
@@ -941,23 +955,27 @@ public WXMEvaluatedBootConfigurationType evaluate()
           this.errorNoSuchConfiguration()
         ));
 
-    final var deviceMap =
-      WXMDeviceMap.create(
-        this.messages,
-        this.clientConfiguration,
-        configuration,
-        this.machine
-      );
-
-    switch (configuration.kind()) {
-      case GRUB_BHYVE:
-        return this.evaluateGRUBConfiguration(
-          (WXMBootConfigurationGRUBBhyve) configuration, deviceMap
-        );
-      case UEFI:
-        return this.evaluateUEFIConfiguration(
-          (WXMBootConfigurationUEFI) configuration, deviceMap
+    try {
+      final var deviceMap =
+        WXMDeviceMap.create(
+          this.messages,
+          this.clientConfiguration,
+          configuration,
+          this.machine
         );
+
+      switch (configuration.kind()) {
+        case GRUB_BHYVE:
+          return this.evaluateGRUBConfiguration(
+            (WXMBootConfigurationGRUBBhyve) configuration, deviceMap
+          );
+        case UEFI:
+          return this.evaluateUEFIConfiguration(
+            (WXMBootConfigurationUEFI) configuration, deviceMap
+          );
+      }
+    } catch (final IOException e) {
+      throw new WXMException(e);
     }
 
     throw new UnreachableCodeException();
@@ -1016,6 +1034,7 @@ private WXMEvaluatedBootConfigurationUEFI evaluateUEFIConfiguration(
   private WXMEvaluatedBootConfigurationGRUBBhyve evaluateGRUBConfiguration(
     final WXMBootConfigurationGRUBBhyve configuration,
     final WXMDeviceMap deviceMap)
+    throws IOException
   {
     final var kernel =
       configuration.kernelInstructions();

com.io7m.waxmill.boot/src/main/java/com/io7m/waxmill/boot/WXMBootConfigurationExecutor.java

@@ -25,6 +25,7 @@
 import com.io7m.waxmill.machines.WXMDryRun;
 import com.io7m.waxmill.machines.WXMEvaluatedBootCommands;
 import com.io7m.waxmill.machines.WXMVirtualMachine;
+import com.io7m.waxmill.machines.WXMZFSFilesystems;
 import com.io7m.waxmill.process.api.WXMProcessDescription;
 import com.io7m.waxmill.process.api.WXMProcessesType;
 import org.slf4j.Logger;
@@ -210,7 +211,9 @@ private void checkRequiredPaths()
     }
     if (!missingPaths.isEmpty()) {
       if (!missingNMDMs.isEmpty()) {
-        throw new IOException(this.errorRequiredPathsMissingWithNMDMs(missingPaths, missingNMDMs));
+        throw new IOException(this.errorRequiredPathsMissingWithNMDMs(
+          missingPaths,
+          missingNMDMs));
       }
       throw new IOException(this.errorRequiredPathsMissing(missingPaths));
     }
@@ -261,11 +264,13 @@ private void executeGRUBBhyve(
     final WXMEvaluatedBootConfigurationGRUBBhyveType grubBhyveConfiguration)
     throws IOException, WXMException, InterruptedException
   {
-    final var lockFile =
-      this.clientConfiguration.virtualMachineRuntimeDirectory()
-        .resolve(this.machine.id().toString())
-        .resolve("lock");
+    final var machineFs =
+      WXMZFSFilesystems.resolve(
+        this.clientConfiguration.virtualMachineRuntimeFilesystem(),
+        this.machine.id().toString()
+      );
 
+    final var lockFile = machineFs.mountPoint().resolve("lock");
     try (var ignored = WXMFileLock.acquire(lockFile)) {
       writeGrubDeviceMap(execute, grubBhyveConfiguration);
       writeGrubConfig(execute, grubBhyveConfiguration);

com.io7m.waxmill.boot/src/main/java/com/io7m/waxmill/boot/internal/WXMDeviceMap.java

@@ -26,12 +26,14 @@
 import com.io7m.waxmill.machines.WXMDeviceAHCIDisk;
 import com.io7m.waxmill.machines.WXMDeviceLPC;
 import com.io7m.waxmill.machines.WXMDeviceSlot;
+import com.io7m.waxmill.machines.WXMDeviceSlots;
 import com.io7m.waxmill.machines.WXMDeviceType;
 import com.io7m.waxmill.machines.WXMDeviceVirtioBlockStorage;
 import com.io7m.waxmill.machines.WXMStorageBackendFile;
-import com.io7m.waxmill.machines.WXMStorageBackends;
 import com.io7m.waxmill.machines.WXMTTYBackendFile;
 import com.io7m.waxmill.machines.WXMVirtualMachine;
+import com.io7m.waxmill.machines.WXMZFSFilesystems;
+import com.io7m.waxmill.machines.WXMZFSVolumes;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -202,7 +204,9 @@ private static void processLPC(
           break;
         case WXM_NMDM:
           final Path path = nmdmPath(
-            clientConfiguration.virtualMachineRuntimeDirectory().getFileSystem(),
+            clientConfiguration.virtualMachineRuntimeFilesystem()
+              .mountPoint()
+              .getFileSystem(),
             machine.id(),
             NMDM_HOST
           );
@@ -264,19 +268,21 @@ private static WXMDeviceAndPath makeDeviceMapPathStorageBackend(
     final WXMVirtualMachine machine)
   {
     switch (backend.kind()) {
-      case WXM_STORAGE_FILE:
+      case WXM_STORAGE_FILE: {
         final var file = (WXMStorageBackendFile) backend;
         return new WXMDeviceAndPath(index, device, file.file());
-
-      case WXM_STORAGE_ZFS_VOLUME:
-        final Path path =
-          WXMStorageBackends.determineZFSVolumePath(
-            clientConfiguration.virtualMachineRuntimeDirectory(),
-            machine.id(),
-            device.deviceSlot()
+      }
+      case WXM_STORAGE_ZFS_VOLUME: {
+        final var volume =
+          WXMZFSVolumes.resolve(
+            WXMZFSFilesystems.resolve(
+              clientConfiguration.virtualMachineRuntimeFilesystem(),
+              machine.id().toString()
+            ),
+            WXMDeviceSlots.asDiskName(device.deviceSlot())
           );
-        return new WXMDeviceAndPath(index, device, path);
-
+        return new WXMDeviceAndPath(index, device, volume.device());
+      }
       case WXM_SCSI:
         throw new UnimplementedCodeException();
     }

com.io7m.waxmill.client.api/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.waxmill</artifactId>
     <groupId>com.io7m.waxmill</groupId>
-    <version>0.0.4</version>
+    <version>0.0.5</version>
   </parent>
 
   <artifactId>com.io7m.waxmill.client.api</artifactId>

com.io7m.waxmill.client.api/src/main/java/com/io7m/waxmill/client/api/WXMClientConfigurationType.java

@@ -18,6 +18,8 @@
 
 import com.io7m.immutables.styles.ImmutablesStyleType;
 import com.io7m.jaffirm.core.Preconditions;
+import com.io7m.waxmill.machines.WXMZFSFilesystem;
+import com.io7m.waxmill.machines.WXMZFSFilesystems;
 import org.immutables.value.Value;
 
 import java.nio.file.Path;
@@ -41,13 +43,17 @@ public interface WXMClientConfigurationType
   Path virtualMachineConfigurationDirectory();
 
   /**
-   * A directory that contains virtual machines. This directory will contain
-   * one ZFS filesystem per virtual machine.
+   * A ZFS filesystem that contains virtual machines. This directory will
+   * contain one ZFS filesystem per virtual machine. Note that this value is
+   * the name of the ZFS filesystem, and this doesn't necessarily match where
+   * that filesystem is mounted! For example, {@code zfs create x/y/z && zfs set mountpoint=/a/b/c x/y/z}
+   * will create a ZFS filesystem {@code x/y/z} and mount it at {@code /a/b/c};
+   * the value expected here is {@code x/y/z}.
    *
-   * @return The ZFS directory containing virtual machines
+   * @return The ZFS filesystem containing virtual machines
    */
 
-  Path virtualMachineRuntimeDirectory();
+  WXMZFSFilesystem virtualMachineRuntimeFilesystem();
 
   /**
    * @return The "bhyve" executable path, such as {@code /usr/sbin/bhyve}
@@ -129,14 +135,13 @@ default Path cuExecutable()
    * @return A runtime directory
    */
 
-  default Path virtualMachineRuntimeDirectoryFor(
+  default WXMZFSFilesystem virtualMachineRuntimeFilesystemFor(
     final UUID machineId)
   {
     Objects.requireNonNull(machineId, "machineId");
 
-    return this.virtualMachineRuntimeDirectory()
-      .resolve(machineId.toString())
-      .toAbsolutePath();
+    return WXMZFSFilesystems.resolve(
+      this.virtualMachineRuntimeFilesystem(), machineId.toString());
   }
 
   /**
@@ -175,12 +180,6 @@ default void checkPreconditions()
       Path::isAbsolute,
       path -> "Virtual machine configuration directory must be absolute"
     );
-
-    Preconditions.checkPrecondition(
-      this.virtualMachineRuntimeDirectory(),
-      Path::isAbsolute,
-      path -> "Virtual machine runtime directory must be absolute"
-    );
   }
 }
 

com.io7m.waxmill.client.vanilla/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.waxmill</artifactId>
     <groupId>com.io7m.waxmill</groupId>
-    <version>0.0.4</version>
+    <version>0.0.5</version>
   </parent>
 
   <artifactId>com.io7m.waxmill.client.vanilla</artifactId>