looking-glass/module
Omar Pakker e3343cbd01 Rewrite dkms.conf
1) With the change to the Makefile, this update allows dkms to build and install the module for different kernels.
2) As per dkms documentation, no use of ${dkms_tree}.
3) Removed the use of REMAKE_INITRD as this module is not needed that early in the boot process.
4) Updated version to match what's defined in the module
2019-06-06 13:40:06 +10:00
..
dkms.conf Rewrite dkms.conf 2019-06-06 13:40:06 +10:00
kvmfr.c [all] update copyright dates 2019-02-22 22:16:14 +11:00
Makefile Update makefile to allow kernel override 2019-06-06 13:40:06 +10:00
README.md [module] update instructions and add dkms.conf 2019-05-23 18:46:27 +10:00

This kernel module implements a basic interface to the IVSHMEM device for LookingGlass when using LookingGlass in VM->VM mode.

Compiling (Manual)

Make sure you have your kernel headers installed first, on Debian/Ubuntu use the following command.

apt-get install linux-headers-$(uname -r)

Then simply run make and you're done.

Loading

This module requires the uio module to be loaded first, loading it is as simple as:

modprobe uio
insmod kvmfr.ko

Compiling & Installing (DKMS)

You can install this module into DKMS so that it persists across kernel upgrades. Simply run:

dkms install .

Loading

Simply modprobe the module:

modprobe kvmfr

Usage

This will create the /dev/uio0 node that represents the KVMFR interface. To use the interface you need permission to access it by either creating a udev rule to ensure your user can read and write to it, or simply change it's ownership manually, ie:

sudo chown user:user /dev/uid0

Usage with looking glass is simple, you only need to specify the path to the device node, for example:

./looking-glass-client -f /dev/uio0 -L 16