Skip to content
This repository has been archived by the owner on Apr 20, 2024. It is now read-only.

Commit

Permalink
Add interface groups to the data model
Browse files Browse the repository at this point in the history
This adds support for interface groups to the data model, but does
not yet provide any commands to manipulate them.

Affects: #24
  • Loading branch information
io7m committed Jul 19, 2020
1 parent e781ed3 commit 6c0f426
Show file tree
Hide file tree
Showing 25 changed files with 523 additions and 160 deletions.
Expand Up @@ -70,7 +70,8 @@
import java.util.stream.Collectors;

import static com.io7m.waxmill.machines.WXMBootConfigurationType.WXMEvaluatedBootConfigurationType;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMDeviceVirtioNetworkType.WXMNetworkDeviceBackendType;

import com.io7m.waxmill.machines.WXMNetworkDeviceBackendType;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMDeviceVirtioNetworkType.WXMTTYBackendType;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMStorageBackendType;
import static com.io7m.waxmill.machines.WXMTTYBackends.NMDMSide.NMDM_HOST;
Expand Down
Expand Up @@ -34,7 +34,8 @@
import java.util.UUID;

import static com.io7m.claypot.core.CLPCommandType.Status.SUCCESS;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMNetworkDeviceBackendType;

import com.io7m.waxmill.machines.WXMNetworkDeviceBackendType;

@Parameters(commandDescription = "Add an e1000 network device to a virtual machine.")
public final class WXMCommandVMAddE1000NetworkDevice
Expand Down
Expand Up @@ -34,7 +34,8 @@
import java.util.UUID;

import static com.io7m.claypot.core.CLPCommandType.Status.SUCCESS;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMNetworkDeviceBackendType;

import com.io7m.waxmill.machines.WXMNetworkDeviceBackendType;

@Parameters(commandDescription = "Add a virtio network device to a virtual machine.")
public final class WXMCommandVMAddVirtioNetworkDevice
Expand Down
Expand Up @@ -23,7 +23,7 @@
import com.io7m.waxmill.machines.WXMVMNet;
import com.io7m.waxmill.machines.WXMVMNetDeviceName;

import static com.io7m.waxmill.machines.WXMDeviceType.WXMNetworkDeviceBackendType;
import com.io7m.waxmill.machines.WXMNetworkDeviceBackendType;

public final class WXMNetworkBackendConverter
implements IStringConverter<WXMNetworkDeviceBackendType>
Expand Down
Expand Up @@ -232,6 +232,12 @@ interface WXMGRUBKernelInstructionsType

Kind kind();

/**
* @return The slots required to have assigned storage
*/

Set<WXMDeviceSlot> requiredDevices();

/**
* The kind of kernels.
*/
Expand All @@ -250,12 +256,6 @@ enum Kind

KERNEL_LINUX
}

/**
* @return The slots required to have assigned storage
*/

Set<WXMDeviceSlot> requiredDevices();
}

/**
Expand Down
Expand Up @@ -42,8 +42,6 @@
import static com.io7m.waxmill.machines.WXMDeviceType.Kind.WXM_PASSTHRU;
import static com.io7m.waxmill.machines.WXMDeviceType.Kind.WXM_VIRTIO_BLOCK;
import static com.io7m.waxmill.machines.WXMDeviceType.Kind.WXM_VIRTIO_NETWORK;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMNetworkDeviceBackendType.Kind.WXM_TAP;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMNetworkDeviceBackendType.Kind.WXM_VMNET;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMStorageBackendType.Kind.WXM_STORAGE_FILE;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMStorageBackendType.Kind.WXM_STORAGE_ZFS_VOLUME;
import static com.io7m.waxmill.machines.WXMDeviceType.WXMTTYBackendType.Kind.WXM_FILE;
Expand Down Expand Up @@ -189,6 +187,27 @@ enum Kind
WXM_FRAMEBUFFER
}

enum WXMLPCTTYNames
{
WXM_COM1("com1"),
WXM_COM2("com2"),
WXM_BOOTROM("bootrom");

private final String deviceName;

WXMLPCTTYNames(
final String inDeviceName)
{
this.deviceName =
Objects.requireNonNull(inDeviceName, "deviceName");
}

public String deviceName()
{
return this.deviceName;
}
}

/**
* A PCI passthru device.
*/
Expand Down Expand Up @@ -491,116 +510,6 @@ default String comment()
WXMNetworkDeviceBackendType backend();
}

/**
* The type of network device backends.
*/

interface WXMNetworkDeviceBackendType
{
/**
* @return The backend kind
*/

Kind kind();

/**
* @return A descriptive comment
*/

@Value.Default
default String comment()
{
return "";
}

/**
* The kind of backend.
*/

enum Kind
{
/**
* The device is backed by a tap device.
*/

WXM_TAP,

/**
* The device is backed by a vmnet device.
*/

WXM_VMNET
}
}

/**
* A TAP device.
*/

@ImmutablesStyleType
@Value.Immutable
interface WXMTapType extends WXMNetworkDeviceBackendType
{
@Override
default Kind kind()
{
return WXM_TAP;
}

/**
* @return The underlying device name
*/

WXMTAPDeviceName name();

/**
* @return The underlying device MAC address
*/

WXMMACAddress address();

@Override
@Value.Default
default String comment()
{
return "";
}
}

/**
* A vmnet device.
*/

@ImmutablesStyleType
@Value.Immutable
interface WXMVMNetType extends WXMNetworkDeviceBackendType
{
@Override
default Kind kind()
{
return WXM_VMNET;
}

/**
* @return The underlying device name
*/

WXMVMNetDeviceName name();

/**
* @return The underlying device MAC address
*/

WXMMACAddress address();

@Override
@Value.Default
default String comment()
{
return "";
}
}

interface WXMStorageBackendType
{
Kind kind();
Expand Down Expand Up @@ -890,27 +799,6 @@ default String comment()
}
}

enum WXMLPCTTYNames
{
WXM_COM1("com1"),
WXM_COM2("com2"),
WXM_BOOTROM("bootrom");

private final String deviceName;

public String deviceName()
{
return this.deviceName;
}

WXMLPCTTYNames(
final String inDeviceName)
{
this.deviceName =
Objects.requireNonNull(inDeviceName, "deviceName");
}
}

@ImmutablesStyleType
@Value.Immutable
interface WXMDeviceLPCType extends WXMDeviceType
Expand Down
@@ -0,0 +1,46 @@
/*
* Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
* IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

package com.io7m.waxmill.machines;

import com.io7m.immutables.styles.ImmutablesStyleType;
import org.immutables.value.Value;

/**
* A TAP device name, such as {@code tap23}.
*/

@Value.Immutable
@ImmutablesStyleType
public interface WXMInterfaceGroupNameType
{
/**
* @return The device name
*/

@Value.Parameter
String value();

/**
* Check preconditions for the type.
*/

@Value.Check
default void checkPreconditions()
{
WXMInterfaceGroupNames.checkValid(this.value());
}
}
@@ -0,0 +1,70 @@
/*
* Copyright © 2020 Mark Raynsford <code@io7m.com> http://io7m.com
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
* IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

package com.io7m.waxmill.machines;

import java.util.Objects;
import java.util.regex.Pattern;

/**
* Functions over interface group names.
*/

public final class WXMInterfaceGroupNames
{
private static final Pattern VALID_NAME =
Pattern.compile("[A-Za-z_]{1,15}");

private WXMInterfaceGroupNames()
{

}

/**
* @param name The raw name string
*
* @return {@code true} if the given string represents a valid interface group name
*/

public static boolean isValid(
final String name)
{
return VALID_NAME.matcher(
Objects.requireNonNull(name, "name")
).matches();
}

/**
* Check that a string represents a valid interface group name.
*
* @param name The raw name string
*
* @return {@code name}
*
* @throws IllegalArgumentException If the string is not a interface group name
*/

public static String checkValid(
final String name)
{
if (isValid(name)) {
return name;
}
throw new IllegalArgumentException(
String.format("Invalid name '%s': Must match %s", name, VALID_NAME)
);
}
}

0 comments on commit 6c0f426

Please sign in to comment.