module labn-munet-config {
  yang-version 1.1;
  namespace "urn:labn:yang:labn-munet-config";
  prefix c;

  organization
    "LabN Consulting, L.L.C.";

  contact
    "Author: Christian Hopps
             <mailto:chopps@labn.net>";

  description
    "This module defines the configuration state for munet.";

  revision 2021-12-18 {
    description "Initial Revision";
    reference "https://github.com/LabNConsulting/munet/blob/main/README.md";
  }

  typedef number64 {
    type union {
      type uint64;
      type string {
        pattern '[0-9]+([KMGTPE]i?)?';
      }
    }
    description
      "A number with optional suffix, where suffix means:
         K -> value*10^3, Ki -> value*2^10,
         M -> value*10^6, Mi -> value*2^20,
         G -> value*10^9, Gi -> value*2^30,
         T -> value*10^12, Gi -> value*2^40,
         P -> value*10^15, Gi -> value*2^50,
         E -> value*10^18, Gi -> value*2^60";
  }

  grouping intf-constraints {
    description "traffic control based interface constraints";
    leaf delay {
      type uint64;
      description "number of microseconds of delay";
    }
    leaf jitter {
      type uint64;
      must "../delay";
      description "number of microseconds of possible jitter";
    }
    leaf jitter-correlation {
      type decimal64 {
        fraction-digits 16;
        range "0..100";
      }
      must "../jitter";
      description "percent correlation between consecutive jitter values";
    }
    leaf loss {
      type uint64;
      must "../delay";
      description "number of microseconds of possible jitter";
    }
    leaf loss-correlation {
      type decimal64 {
        fraction-digits 16;
        range "0..100";
      }
      must "../loss";
      description "percent correlation between consecutive loss values";
    }
    container rate {
      description "bits per second maximum rate with possible limit and burst";
      leaf rate {
        type number64;
        description "bits per second maximum rate";
      }
      leaf limit {
        type number64;
        must "../rate";
        description "bits per second maximum rate";
      }
      leaf burst {
        type number64;
        must "../rate";
        description "bits per second maximum rate";
      }
    }
  }

  grouping common-node {
    description "Common node properties";
    leaf-list cap-add {
      type string;
      description "Capabilities to add to a container.";
      reference "https://man7.org/linux/man-pages/man7/capabilities.7.html";
    }
    leaf-list cap-remove {
      type string;
      description "Capabilities to remove from a container.";
      reference "https://man7.org/linux/man-pages/man7/capabilities.7.html";
    }
    leaf cmd {
      type string;
      description "Shell command[s] to execute when creating the node.";
    }
    leaf cleanup-cmd {
      type string;
      description
        "Shell command[s] to execute when deleting the node.

         NOTE: With container nodes, the cleanup-cmd will be run
         prior to the `cmd` being killed, so that the container is
         present. For Qemu/VM nodes the cleanup command is run prior
         to the VM being brought down.";
    }
    leaf ready-cmd {
      type string;
      description
        "Shell command[s] to execute to determine if the node is ready";
    }
    leaf image {
      type string;
      must "not(../hostnet) and not(../qemu) and not(../server)" {
        error-message "Can only have one of hostnet, image, server or qemu";
      }
      description "Container image specification.";
    }
    leaf hostnet {
      type boolean;
      must "not(../image) and not(../qemu) and not(../server)" {
        error-message "Can only have one of hostnet, image, server or qemu";
      }
      description
        "Node that runs commands in the host network namespace. For this
         to work correclty the munet object should not be created with
         unshare inline.";
    }
    leaf server {
      type string;
      must "not(../hostnet) and not(../image) and not(../qemu)" {
        error-message "Can only have one of hostnet, image, server or qemu";
      }
      description
        "Name of server for SSHRemote node functionality. If using
         within pytest make sure you utilize the `unet_share` fixture
         instead of the normal `unet` one, otherwise ssh may not
         work as it is executing inside the munet namespace.";
    }
    leaf server-port {
      type uint16;
      must "../server" {
        error-message "server-port requires a server";
      }
      default 22;
      description
        "SSH port to connect to server on";
    }
    leaf ssh-identity-file {
      type string;
      description
        "Path to an SSH private key file for logging into either a remote ssh
         `server` or a qemu node with a running ssh server.";
    }
    leaf ssh-user {
      type string;
      description
        "The user to use when logging into either a remote ssh `server` or a
         qemu node with a running ssh server.";
    }
    leaf ssh-password {
      type string;
      description
        "The password to use when creating a 'console' to a remote ssh
         `server` node.";
    }
    container qemu {
      must "not(../hostnet) and not(../image) and not(../server)" {
        error-message "Can only have one of hostnet, image, server or qemu";
      }
      description "Specify parameters for Qemu VM node";
      leaf bios {
        type string;
        description
          "'open-firmare' to use open firmware bios, or a path to
           bios image file";
      }
      leaf disk {
        type string;
        description "Path to disk image possibly to boot from";
      }
      leaf disk-driver {
        type string;
        default "virtio";
        description
          "Disk driver to use, either 'sata' or 'virtio'. Some router images
           only work with 'sata', normally this should not be specified so that
           the default 'virtio' is used";
      }
      leaf disk-template {
        type string;
        description
          "Path to disk image template. If a ../disk image is not specified, or
           does not yet exist. Then this template is used to create a new disk
           image. If ../disk is not specified then the disk image path will be
           %RUNDIR%/%NAME%-<disk-template-basename>";
      }
      leaf initial-cmd {
        type string;
        description
          "Shell command[s] to execute when creating the node from a disk
           template. These commands are run prior to the standard ../../cmd
           when a disk is first created from a disk template";
      }
      leaf kerenel {
        type string;
        description "path to kernel image (e.g,. bzImage) to boot";
      }
      leaf initrd {
        type string;
        description "path to initrd image (e.g,. rootfs.ext2) to boot";
      }
      leaf kvm {
        type boolean;
        default true;
        description "Run with HW acceleration";
      }
      leaf ncpu {
        type uint32;
        default 1;
        description "Number of cores";
      }
      leaf memory {
        type string;
        default "512M";
        description "ammount of memory for VM.";
      }
      leaf root {
        type string;
        default "/dev/ram0";
        description "root file system passed in cmdline as root=<value>";
      }
      leaf cmdline-extra {
        type string;
        description "string to add to the kernel cmdline (qemu -append)";
      }
      leaf extra-args {
        type string;
        description "extra qemu args passed when launching";
      }
      container console {
        description "Configuration for console handling";
        leaf user {
          type string;
          description "User to login to console with";
        }
        leaf password {
          type string;
          description "Password to login to console with";
        }
        leaf initial-password {
          type string;
          description
            "The initial password. If the VM disk is newly created from a
             template, this value can be used to specify an initial password
             for the user. Often part of the bring-up process will set a new
             password and that should then be stored in the ../password leaf.";
        }
        leaf-list expects {
          type string;
          description "Strings to expect for logging into the console";
        }
        leaf-list sends {
          type string;
          description
            "Strings paired to `expects` for logging into the
             console. These are sent to the console when the
             corresponding expect is seen, zero length strings are
             allowed which indicate send nothing. An Expect with a
             send nothing could be used to reset the timeout timer on
             long boots";
        }
        leaf timeout {
          type uint32;
          description "Timeout for logging into the console";
        }
      }
    }
    list connections {
      must "not(../hostnet) and not(../server)" {
        error-message "SSHRemote and hostnet nodes have no munet connections.";
      }
      key to;
      description "Connections to other networks or nodes from this node";

      leaf to {
        type string;
        description "The target of this connection.";
      }
      leaf ip {
        type string;
        description "IPv4 address and mask for the connection (interface).";
      }
      leaf ipv6 {
        type string;
        description "IPv6 address and mask for the connection (interface).";
      }
      leaf name {
        type string;
        description "Name for the connection (interface name).";
      }
      leaf hostintf {
        type string;
        description
          "Host interface for wired connections. This will move the given host
           interface into the namespace. The value is the name of the
           interface on the host (e.g., 'enp216s0f0v0') it will be renamed
           inside the namespace accordingly (either using automatic naming
           (e.g., 'eth1') or the name specified in ../name leaf.";
      }
      leaf physical {
        type string;
        description
          "Physical PCI interface address for wired connections. This is the
           PCI address of the form xxxx:xx:xx.x (e.g., 0000:1b:02.0) this will
           detach the given PCI device from it's native driver and reattach it
           to the vfio-dev PCI driver. This is used primarily by Qemu nodes;
           however, it can also be used by user processes that directly
           control physical devices such as DPDK, TREX, or VPP";
      }
      leaf remote-name {
        type string;
        description
          "The remote name of a p2p connection. This is used for disambiguation
           when there are multiple point-to-point connections to the same
           remote node.";
      }
      leaf driver {
        type string;
        default "virtio-net-pc";
        description "driver name for qemu based interfaces";
      }
      uses intf-constraints;
    }
    list env {
      key name;
      description
        "List of environment variable to add to the `cmd` execution
         environment";
      leaf name {
        type string;
        description "Environment variable name.";
      }
      leaf value {
        type string;
        description "Environment variable value.";
      }
    }
    leaf gdb-cmd {
      type string;
      description "Command to execute when --gdb option specified" ;
    }
    leaf-list gdb-target-cmds {
      type string;
      description
        "GDB commands to execute to prior to setting breakpoints" ;
    }
    leaf-list gdb-run-cmds {
      type string;
      description
        "GDB commands to send to gdb (e.g., to start the process running)" ;
    }
    leaf init {
      type union {
        type boolean;
        type string;
      }
      description "Controls use of an init process.";
    }
    list mounts {
      key destination;
      description
        "Mounts to be made inside the namespace. Currently only supported for
         container based nodes.";

      leaf destination {
        type string;
        description
          "The inner mount point. If no source is given this will be a tmpfs
           mount, otherwise the it is a bind mount from the `source`.";
      }
      leaf source {
        type string;
        description "The source of the bind mount.";
      }
      leaf tmpfs-size {
        type string;
        description "The size of the tmpfs.";
      }
      leaf type {
        type string;
        description "The type of the mount (currently bind or tmpfs).";
      }
    }
    leaf name {
      type string;
      description "Name of this node or kind.";
    }
    container podman {
      description "Configuration related to podman containers.";
      leaf-list extra-args {
        type string;
        description "list of CLI arguments to add to the podman run command.";
      }
    }
    leaf privileged {
      type boolean;
      description "Controls running the container in privileged mode.";
    }
    leaf shell {
      type union {
        type boolean;
        type string;
      }
      description
        "Controls use of an shell process for `cmd` execution. If 'false' then
         `cmd` will be run directly with exec(1), otherwise a shell will be
         used. If this value is `true` then the default shell will be used,
         otherwise it is a string which specifies the path to the shell to
         use.";
    }
    leaf-list volumes {
      type string;
      description
        "Bind or tmpfs mounts. For bind mounts the format of the string is
         <outer>:<inner>, for tmpfs it's simply the inner mount path.";
    }
  }

  container cli {
    description "CLI additions.";
    list commands {
      key name;
      description "A command to add to the CLI.";

      leaf exec {
        type string;
        description
          "Command to execute when the CLI command is given. The string is
           evaluated as a python f-string with `{host}` set to the current
           host object (or None) `{unet}` set to the Munet object, and
           `{user_input}` to any user input that follows the command (or '' if
           none specified).";
      }
      list exec-kind {
        key kind;
        description "A kind specific execution formats.";

        leaf kind {
          type string;
          description "Kind for which this command format should be used.";
        }
        leaf exec {
          type string;
          description
            "Command to execute when the CLI command is given. The string is
             evaluated as a python f-string with `{host}` set to the current
             host object (or None) `{unet}` set to the Munet object, and
             `{user_input}` to any user input that follows the command (or ''
             if none specified).";
        }
      }
      leaf format {
        type string;
        description
          "The format of the command. Used to print help string for user.";
      }
      leaf help {
        type string;
        description
          "The description of the command. Used to print help string for
           user.";
      }
      leaf interactive {
        type boolean;
        description
          "Run the command in interactive pty.";
      }
      leaf-list kinds {
        type leafref {
          path "../../../kinds/name";
        }
        description
          "List of kinds for which this command should be restricted to
           running on.";
      }
      leaf name {
        type string;
        description "CLI command name.";
      }
      leaf new-window {
        type boolean;
        description
          "Controls if the command runs in the CLI window or opens a new
           terminal window to run the command in.";
      }
      leaf top-level {
        type boolean;
        default false;
        description
          "If true the command is run in the top-level containing namespace.
           This is the namespace from which each of the hosts allocated
           sub-namespaces from. Multple hosts are still allowed and their
           variables will be substituted accordingly.";
      }
    }
  }

  list kinds {
    key name;
    description
      "List of kinds used to group and share common node properities.";

    leaf-list merge {
      type string;
      description
        "List of properties which should be merged with their node specific
         values, rather than being replaced by the node specific version.";
    }
    uses common-node;
  }

  container topology {
    description "The topology munet should create.";

    leaf dns-network {
      type leafref {
        path "../networks/name";
      }
      description "network used for DNS addresses of hosts in hosts files.";
    }

    leaf ipv6-enable {
      type boolean;
      default false;
      description
        "Controls if IPv6 is enabled or disabled.";
    }

    leaf networks-autonumber {
      type boolean;
      description
        "Controls if networks and node connections are given IP addresses if
         not explicitly configured.";
    }

    list networks {
      key name;
      description "List of networks to create.";

      leaf name {
        type string {
          length "1..11";
          pattern "[-a-zA-Z0-9_]+";
        }
        description "Name of the network";
      }
      leaf ip {
        type string;
        must "not (../external)";
        description
          "IPv4 prefix for the network. If host bit's are set then the linux
           bridge will be assigned that IP.";
      }
      leaf ipv6 {
        type string;
        must "not (../external)";
        description
          "IPv6 prefix for the network. If host bit's are set then the linux
           bridge will be assigned that IP.";
      }
      leaf external {
        type boolean;
        default false;
        description
          "This is a placeholder network for an externally defined network.
           This is most useful when adding host interfaces to nodes as the
           connection point.";
      }
    }

    list nodes {
      key name;
      description "Nodes in the topology.";

      leaf id {
        type uint32;
        description "Explicitly set the ID for the node.";
      }
      leaf kind {
        type leafref {
          path "../../../kinds/name";
        }
        description
          "Indicate the kind of this node, which pulls in the properies of that
           `kind` for this node.";
      }
      uses common-node;
    }
  }
  leaf version {
    type uint32;
    description "version of this config";
  }
}