From 25d60de1461863cdbf2c3fb26a1026fb5bdf4fd2 Mon Sep 17 00:00:00 2001 From: Mathieu Tarral Date: Fri, 1 Oct 2021 16:13:51 +0200 Subject: [PATCH 1/2] doc/tutorial/installation: add windows entry and add bundled drivers info --- doc/src/tutorial/installation.md | 50 ++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/doc/src/tutorial/installation.md b/doc/src/tutorial/installation.md index 96292bcf..dc49f523 100644 --- a/doc/src/tutorial/installation.md +++ b/doc/src/tutorial/installation.md @@ -1,4 +1,4 @@ -# installation +# Installation This section details how to install the officially distributed version of libmicrovmi. @@ -7,21 +7,18 @@ libmicrovmi is accessible through the following languages - C - Python -It comes bundled by default with the following Linux drivers: -- Xen -- KVM -- VirtualBox -- memflow - -# Rust - Crates.io +## Rust - Crates.io The crate is available on crates.io: [![Crates.io](https://img.shields.io/crates/v/microvmi?logo=rust&style=for-the-badge)](https://crates.io/crates/microvmi) -# C - Debian package +Bundled drivers: +- Xen + +## C - Debian package -A Debian package is available on [Github releases](https://github.com/Wenzel/libmicrovmi/releases): +A Debian package `microvmi_x.x.x_amd64.deb` is available on [Github releases](https://github.com/Wenzel/libmicrovmi/releases): [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Wenzel/libmicrovmi?color=yellowgreen&logo=github&style=for-the-badge)](https://github.com/Wenzel/libmicrovmi/releases) @@ -30,7 +27,28 @@ It contains both the library and the headers to get started with C development - `/usr/lib/libmicrovmi.so` - `/usr/include/libmicrovmi.h` -# Python - PyPI +Bundled drivers: +- Xen +- KVM +- VirtualBox +- memflow + +## C - Windows zip archive + +A zip archive `microvmi_win32.zip` containing a Windows release of `libmicrovmi` is available on [Github releases](https://github.com/Wenzel/libmicrovmi/releases): + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Wenzel/libmicrovmi?color=blue&logo=github&style=for-the-badge)](https://github.com/Wenzel/libmicrovmi/releases) + +It contains both the library and the headers to get started with C development + +- `microvmi.dll` +- `libmicrovmi.h` + +Bundled drivers: +- Virtualbox +- memflow + +## Python - PyPI libmicrovmi is exposing a Python interface through a native extension. @@ -44,4 +62,12 @@ $ virtualenv -p python3 venv (venv) $ pip install microvmi ~~~ -Note: this extension is completely independant from any existing `libmicrovmi.so` installation on you system. Hence you don't have to install the debian package above. +Note: this extension is completely independant from any existing `libmicrovmi.so` installation on you system. + +Note2: the native extension has been compiled for **Linux only**. + +Bundled drivers: +- Xen +- KVM +- VirtualBox +- memflow From 5c6a16d93fca71622737c3d5abf841da820401df Mon Sep 17 00:00:00 2001 From: Mathieu Tarral Date: Fri, 1 Oct 2021 16:15:44 +0200 Subject: [PATCH 2/2] doc/reference/drivers: add platform info --- doc/src/reference/drivers/kvm.md | 1 + doc/src/reference/drivers/memflow.md | 1 + doc/src/reference/drivers/virtualbox.md | 3 ++- doc/src/reference/drivers/xen.md | 1 + 4 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/src/reference/drivers/kvm.md b/doc/src/reference/drivers/kvm.md index 3d631561..c4b6975f 100644 --- a/doc/src/reference/drivers/kvm.md +++ b/doc/src/reference/drivers/kvm.md @@ -3,6 +3,7 @@ ## Requirements - QEMU and KVM needs to be modified: [KVM-VMI setup](https://kvm-vmi.github.io/kvm-vmi/master/) +- Platform: Linux ## Initialization parameters diff --git a/doc/src/reference/drivers/memflow.md b/doc/src/reference/drivers/memflow.md index 2a5bcef6..a04aa1be 100644 --- a/doc/src/reference/drivers/memflow.md +++ b/doc/src/reference/drivers/memflow.md @@ -12,6 +12,7 @@ It has multiple connectors which can be used to access physical memory: - memflow connector [project setup](https://github.com/memflow/memflow) - root privileges +- Platform: Windows/Linux ## Initialization parameters diff --git a/doc/src/reference/drivers/virtualbox.md b/doc/src/reference/drivers/virtualbox.md index 46b3b2da..6b1aa045 100644 --- a/doc/src/reference/drivers/virtualbox.md +++ b/doc/src/reference/drivers/virtualbox.md @@ -3,6 +3,7 @@ ## Requirements - virtualbox modified via [icebox](https://github.com/thalium/icebox) project +- Platform: Windows/Linux To compile `libFDP` ~~~ @@ -15,4 +16,4 @@ $ sudo mv libFDP.so /usr/local/lib/ ## Initialization parameters -- `vm_name`: required \ No newline at end of file +- `vm_name`: required diff --git a/doc/src/reference/drivers/xen.md b/doc/src/reference/drivers/xen.md index 831db70b..fb9bd0e5 100644 --- a/doc/src/reference/drivers/xen.md +++ b/doc/src/reference/drivers/xen.md @@ -4,6 +4,7 @@ - Xen >= 4.11 - root privileges +- Platform: Linux ## Initialization parameters