https://github.com/ptrcnull/vsock
Package vsock provides access to Linux VM sockets (AF_VSOCK) for communication between a hypervisor and its virtual machines. MIT Licensed.
https://github.com/ptrcnull/vsock
Last synced: 5 months ago
JSON representation
Package vsock provides access to Linux VM sockets (AF_VSOCK) for communication between a hypervisor and its virtual machines. MIT Licensed.
- Host: GitHub
- URL: https://github.com/ptrcnull/vsock
- Owner: ptrcnull
- License: mit
- Fork: true (mdlayher/vsock)
- Created: 2021-11-10T03:55:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-10T04:02:16.000Z (over 4 years ago)
- Last Synced: 2024-06-20T16:42:44.396Z (about 2 years ago)
- Language: Go
- Size: 133 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# vsock [](https://builds.sr.ht/~mdlayher/vsock?) [](https://godoc.org/github.com/mdlayher/vsock) [](https://goreportcard.com/report/github.com/mdlayher/vsock)
Package `vsock` provides access to Linux VM sockets (`AF_VSOCK`) for
communication between a hypervisor and its virtual machines. MIT Licensed.
For more information about VM sockets, check out my blog about
[Linux VM sockets in Go](https://medium.com/@mdlayher/linux-vm-sockets-in-go-ea11768e9e67).
## Go version support
This package supports varying levels of functionality depending on the version
of Go used during compilation. The `Listener` and `Conn` types produced by this
package are backed by non-blocking I/O, in order to integrate with Go's runtime
network poller in Go 1.11+. Additional functionality is available starting in Go
1.12+. The older Go 1.10 is only supported in a blocking-only mode.
A comprehensive list of functionality for supported Go versions can be found on
[package vsock's GoDoc page](https://godoc.org/github.com/mdlayher/vsock#hdr-Go_version_support).
## Stability
At this time, package `vsock` is in a pre-v1.0.0 state. Changes are being made
which may impact the exported API of this package and others in its ecosystem.
**If you depend on this package in your application, please use Go modules when
building your application.**
## Requirements
To make use of VM sockets with QEMU and virtio-vsock, you must have:
- a Linux hypervisor with kernel 4.8+
- a Linux virtual machine on that hypervisor with kernel 4.8+
- QEMU 2.8+ on the hypervisor, running the virtual machine
Before using VM sockets, following modules must be removed on hypervisor:
- `modprobe -r vmw_vsock_vmci_transport`
- `modprobe -r vmw_vsock_virtio_transport_common`
- `modprobe -r vsock`
Once removed, `vhost_vsock` module needs to be enabled on hypervisor:
- `modprobe vhost_vsock`
On VM, you have to enable `vmw_vsock_virtio_transport` module. This module should automatically load during boot when the vsock device is detected.
To utilize VM sockets, VM needs to be powered on with following `-device` flag:
- `-device vhost-vsock-pci,id=vhost-vsock-pci0,guest-cid=3`
Check out the
[QEMU wiki page on virtio-vsock](http://wiki.qemu-project.org/Features/VirtioVsock)
for more details. More detail on setting up this environment will be provided
in the future.
## Usage
To try out VM sockets and see an example of how they work, see
[cmd/vscp](https://github.com/mdlayher/vsock/tree/master/cmd/vscp).
This command shows usage of the `vsock.ListenStream` and `vsock.DialStream`
APIs, and allows users to easily test VM sockets on their systems.