Merge pull request #46 from mdlayher/mdl-rewrite

vsock: rewrite on top of socket.Conn

Author: mdlayher

.builds/freebsd.yml

@@ -0,0 +1,36 @@
+name: Linux Integration Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        go-version: [1.12, 1.17]
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go-version }}
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Load the vhost_vsock kernel module
+      run: sudo modprobe vhost_vsock
+
+    - name: Change the permissions of /dev/vsock for integration tests
+      run: sudo chmod 666 /dev/vsock
+
+    - name: Run integration tests
+      run: go test -v -race -run TestIntegration ./...
+

.builds/go-1.10.yml

@@ -0,0 +1,29 @@
+name: Linux Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        go-version: [1.12, 1.17]
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go-version }}
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Run tests
+      run: go test -v -race ./...

.builds/go-1.11.yml

@@ -0,0 +1,29 @@
+name: macOS Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        go-version: [1.12]
+    runs-on: macos-latest
+
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go-version }}
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Run tests
+      run: go test -v -race ./...

.builds/go-stable.yml

@@ -0,0 +1,38 @@
+name: Static Analysis
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        go-version: [1.17]
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go-version }}
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Install staticcheck
+      run: go install honnef.co/go/tools/cmd/staticcheck@latest
+
+    - name: Print staticcheck version
+      run: staticcheck -version
+
+    - name: Run staticcheck
+      run: staticcheck ./...
+
+    - name: Run go vet
+      run: go vet ./...

.github/workflows/linux-integration-test.yml

@@ -0,0 +1,18 @@
+# CHANGELOG
+
+## Unreleased
+
+## v1.0.0
+
+**This is the first release of package vsock that only supports Go 1.12+.
+Users on older versions of Go must use an unstable release.**
+
+- Initial stable commit!
+- [API change]: the `vsock.Dial` and `vsock.Listen` constructors now accept an
+  optional `*vsock.Config` parameter to enable future expansion in v1.x.x
+  without prompting further breaking API changes. Because `vsock.Config` has no
+  options as of this release, `nil` may be passed in all call sites to fix
+  existing code upon upgrading to v1.0.0.
+- [New API]: the `vsock.ListenContextID` function can be used to create a
+  `*vsock.Listener` which is bound to an explicit context ID address, rather
+  than inferring one automatically as `vsock.Listen` does.

.github/workflows/linux-test.yml

@@ -1,7 +1,6 @@
-MIT License
-===========
+# MIT License
 
-Copyright (C) 2017 Matt Layher
+Copyright (C) 2017-2022 Matt Layher
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

.github/workflows/macos-test.yml

@@ -1,32 +1,30 @@
-# vsock [![builds.sr.ht status](https://builds.sr.ht/~mdlayher/vsock.svg)](https://builds.sr.ht/~mdlayher/vsock?) [![GoDoc](https://godoc.org/github.com/mdlayher/vsock?status.svg)](https://godoc.org/github.com/mdlayher/vsock) [![Go Report Card](https://goreportcard.com/badge/github.com/mdlayher/vsock)](https://goreportcard.com/report/github.com/mdlayher/vsock)
+# vsock [![Test Status](https://github.com/mdlayher/vsock/workflows/Linux%20Test/badge.svg)](https://github.com/mdlayher/vsock/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/mdlayher/vsock.svg)](https://pkg.go.dev/github.com/mdlayher/vsock)  [![Go Report Card](https://goreportcard.com/badge/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).
+[Linux VM sockets in Go](https://mdlayher.com/blog/linux-vm-sockets-in-go/).
 
-## 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.
+## Stability
 
-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).
+See the [CHANGELOG](./CHANGELOG.md) file for a description of changes between
+releases.
 
-## Stability
+This package has a stable v1 API and any future breaking changes will prompt
+the release of a new major version. Features and bug fixes will continue to
+occur in the v1.x.x series.
 
-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.
+In order to reduce the maintenance burden, this package is only supported on
+Go 1.12+. Older versions of Go lack critical features and APIs which are
+necessary for this package to function correctly.
 
-**If you depend on this package in your application, please use Go modules when
-building your application.**
+**If you depend on this package in your applications, please use Go modules.**
 
 ## Requirements
 
+**It's possible these requirements are out of date. PRs are welcome.**
+
 To make use of VM sockets with QEMU and virtio-vsock, you must have:
 
 - a Linux hypervisor with kernel 4.8+
@@ -53,10 +51,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.

.github/workflows/static-analysis.yml

@@ -14,12 +14,9 @@ import (
 	"time"
 
 	"github.com/mdlayher/vsock"
-	"github.com/mdlayher/vsock/internal/vsutil"
 )
 
-var (
-	flagVerbose = flag.Bool("v", false, "enable verbose logging to stderr")
-)
+var flagVerbose = flag.Bool("v", false, "enable verbose logging to stderr")
 
 func main() {
 	var (
@@ -96,7 +93,9 @@ func receive(target string, port uint32, timeout time.Duration, checksum bool) {
 
 	logf("opening listener: %d", port)
 
-	l, err := vsock.Listen(port)
+	// TODO(mdlayher): support vsock.Local binds for testing.
+
+	l, err := vsock.Listen(port, nil)
 	if err != nil {
 		fatalf("failed to listen: %v", err)
 	}
@@ -106,7 +105,7 @@ func receive(target string, port uint32, timeout time.Duration, checksum bool) {
 	log.Printf("receive: listening: %s", l.Addr())
 
 	// Accept a single connection, and receive stream from that connection.
-	c, err := vsutil.Accept(l, timeout)
+	c, err := l.Accept()
 	if err != nil {
 		fatalf("failed to accept: %v", err)
 	}
@@ -173,7 +172,7 @@ func send(target string, cid, port uint32, checksum bool) {
 	logf("dialing: %d.%d", cid, port)
 
 	// Dial a remote server and send a stream to that server.
-	c, err := vsock.Dial(cid, port)
+	c, err := vsock.Dial(cid, port, nil)
 	if err != nil {
 		fatalf("failed to dial: %v", err)
 	}