REL: 1.0.2 release (Intel GVT-g + Looking Glass support)

.gitignore

@@ -2,6 +2,7 @@
 *
 !*.*
 !*/
+!*/.gitkeep
 
 *.exe
 
@@ -17,3 +18,5 @@ $RECYCLE.BIN/
 
 # Ignoring binary files produced by debugger.
 nimcache/
+
+optional/

CHANGLOG.md

@@ -1,6 +1,14 @@
+# 1.0.2
+
+- Intel GVT-g support
+- Looking Glass support
+- Inter-VM Shared Memory (IVMSHMEM) resource management
+- Automated mediated device provisioning
+- Installer script (Supports Ubuntu 20.04)
+
 # 1.0.1
 
-- NVidia Support (nvidia-mdev only currently)
+- Nvidia Support (nvidia-mdev only currently)
 - Additional Documentations
 - Deployment script
 - Undeployment script

README.md

@@ -1,12 +1,10 @@
-# LibVFIO
+# LibVF.IO
 
-This is a project designed to serve as a replacement to
-libvirt, with a focus on GPU/Compute device multitenancy.
+LibVF.IO is a vendor neutral GPU multiplexing tool driven by YAML & VFIO.
 
 # Documentation
 
-Here are some key components to the documentation that we
-currently have:
+The following pages provide a basic introduction to LibVF.IO:
 
 1. [Deploy](docs/deployment.md)
 2. [Using](docs/using.md)
@@ -15,23 +13,25 @@ currently have:
 
 # Release Features
 
-1. AMDGPU mediated device support
-2. Nvidia mediated device support
-3. YAML Configuration files
-4. Create VM
-5. Start VM
-6. Stop VM
-7. List available kernels
-8. List available states
-9. List running kernels
-10. Deploy script
-11. Undeploy script
+1. Automated installation
+2. Intel mediated device support
+3. Nvidia mediated device support
+4. AMDGPU mediated device support
+5. YAML Configuration files
+6. Create VM
+7. Start VM
+8. Stop VM
+9. List available kernels
+10. List available states
+11. List running kernels
+12. Deploy script
+13. Undeploy script
 
 # Future Features
 
-1. Intel GVT-g support
-2. Snapshot features + Block diff copy
-3. Hotplugging functionality
+1. Wider OS support for automated installation
+2. Snapshot + Block diff copy
+3. Runtime hot-plugging/hot-unplugging
 
 # License
 

example/amd-mdev-preinstall.yaml

@@ -0,0 +1,37 @@
+%YAML 1.2
+%TAG !n! tag:nimyaml.org,2016:
+--- !n!custom:Config 
+startintro: false
+nographics: false
+spice: false
+introspect: "looking-glass"
+shareddir: !!null ~
+connectivity: 
+  exposedPorts: 
+    - 
+      guest: 22
+      host: 2222
+container: 
+  kernel: windows.arc
+  state: []
+  initialSize: 20
+  iso: !!null ~
+cpus: 
+  cores: 8
+  sockets: 1
+  threads: 2
+  ramAlloc: 8192
+gpus: 
+  - 
+    -
+      gpuType: "sriovdev"
+    - 
+      acceptableTypes: [S7150]
+    - 
+      maxVRam: 8192
+    - 
+      minVRam: 0
+nics: []
+root: /opt/arc
+sudo: false
+commands: []

example/amd-mdev.yaml

@@ -1,19 +1,18 @@
 %YAML 1.2
 %TAG !n! tag:nimyaml.org,2016:
 --- !n!custom:Config 
+startintro: true
+nographics: true
+spice: true
+introspect: "looking-glass"
+shareddir: !!null ~
 connectivity: 
   exposedPorts: 
     - 
       guest: 22
       host: 2222
-    - 
-      guest: 5901
-      host: 5900
-    - 
-      guest: 8080
-      host: 8000
 container: 
-  kernel: "ubuntu-20.04.arc"
+  kernel: windows.arc
   state: []
   initialSize: 20
   iso: !!null ~
@@ -24,9 +23,14 @@ cpus:
   ramAlloc: 8192
 gpus: 
   - 
-    acceptableTypes: [S7150]
-    maxVRam: 8000
-    minVRam: 0
+    -
+      gpuType: "sriovdev"
+    - 
+      acceptableTypes: [S7150]
+    - 
+      maxVRam: 8192
+    - 
+      minVRam: 0
 nics: []
 root: /opt/arc
 sudo: false

example/intel-mdev-preinstall.yaml

@@ -0,0 +1,37 @@
+%YAML 1.2
+%TAG !n! tag:nimyaml.org,2016:
+--- !n!custom:Config 
+startintro: false
+nographics: false
+spice: false
+introspect: "looking-glass"
+shareddir: !!null ~
+connectivity: 
+  exposedPorts: 
+    - 
+      guest: 22
+      host: 2222
+container: 
+  kernel: windows.arc
+  state: []
+  initialSize: 20
+  iso: !!null ~
+cpus: 
+  cores: 8
+  sockets: 1
+  threads: 2
+  ramAlloc: 8192
+gpus: 
+  - 
+    -
+      gpuType: "sysfsdev"
+    - 
+      parentPort: "0000:01:00.0"
+    - 
+      mdevType: "i915-GVTg_V4_1"
+    - 
+      devId: hostdev0
+nics: []
+root: /data/arc
+sudo: false
+commands: []

example/intel-mdev.yaml

@@ -0,0 +1,37 @@
+%YAML 1.2
+%TAG !n! tag:nimyaml.org,2016:
+--- !n!custom:Config 
+startintro: true
+nographics: true
+spice: true
+introspect: "looking-glass"
+shareddir: !!null ~
+connectivity: 
+  exposedPorts: 
+    - 
+      guest: 22
+      host: 2222
+container: 
+  kernel: windows.arc
+  state: []
+  initialSize: 20
+  iso: !!null ~
+cpus: 
+  cores: 8
+  sockets: 1
+  threads: 2
+  ramAlloc: 8192
+gpus: 
+  - 
+    -
+      gpuType: "sysfsdev"
+    - 
+      parentPort: "0000:01:00.0"
+    - 
+      mdevType: "i915-GVTg_V4_1"
+    - 
+      devId: hostdev0
+nics: []
+root: /data/arc
+sudo: false
+commands: []

example/nvidia-mdev-preinstall.yaml

@@ -0,0 +1,37 @@
+%YAML 1.2
+%TAG !n! tag:nimyaml.org,2016:
+--- !n!custom:Config 
+startintro: false
+nographics: false
+spice: false
+introspect: "looking-glass"
+shareddir: !!null ~
+connectivity: 
+  exposedPorts: 
+    - 
+      guest: 22
+      host: 2222
+container: 
+  kernel: windows.arc
+  state: []
+  initialSize: 20
+  iso: !!null ~
+cpus: 
+  cores: 8
+  sockets: 1
+  threads: 2
+  ramAlloc: 8192
+gpus: 
+  - 
+    - 
+      gpuType: "sysfsdev"
+    - 
+      parentPort: "0000:01:00.0"
+    - 
+      mdevType: "nvidia-48"
+    - 
+      devId: hostdev0
+nics: []
+root: /data/arc
+sudo: false
+commands: []

example/nvidia-mdev.yaml

@@ -1,19 +1,18 @@
 %YAML 1.2
 %TAG !n! tag:nimyaml.org,2016:
 --- !n!custom:Config 
+startintro: true
+nographics: true
+spice: true
+introspect: "looking-glass"
+shareddir: !!null ~
 connectivity: 
   exposedPorts: 
     - 
       guest: 22
       host: 2222
-    - 
-      guest: 5901
-      host: 5900
-    - 
-      guest: 8080
-      host: 8000
 container: 
-  kernel: "ubuntu-20.04.arc"
+  kernel: windows.arc
   state: []
   initialSize: 20
   iso: !!null ~
@@ -22,15 +21,17 @@ cpus:
   sockets: 1
   threads: 2
   ramAlloc: 8192
-gpus: []
-nics: []
-root: /opt/arc
-sudo: true
-commands: 
+gpus: 
   - 
-    arg: "-device"
-    values: 
-      - "vfio-pci"
-      - id=hostdev0
-      - "sysfsdev=/sys/bus/mdev/devices/3ab19d97-d8a0-4617-8ab5-b3b1753f257d"
-      - display=off
+    - 
+      gpuType: "sysfsdev"
+    - 
+      parentPort: "0000:01:00.0"
+    - 
+      mdevType: "nvidia-48"
+    - 
+      devId: hostdev0
+nics: []
+root: /data/arc
+sudo: false
+commands: []

libvfio.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "1.0.1"
+version       = "1.0.2"
 author        = "2666680 Ontario Inc."
 description   = "Release 1"
 license       = "AGPL"