DEVELOPMENT.md

@@ -0,0 +1,86 @@
+### Debugging test
+
+#### MacOS
+
+You could debug tests with [Delve](https://github.com/go-delve/delve) debugger.
+Run:
+```shell
+make test-mac-debug
+```
+This command will run build `gvisor` binary with debugger enabled.
+
+>Note: By default it would use `--continue` `dlv` option to not pause `gvisor` execution on start, if debugger is not connected.
+> To pause `gvisor` execution until debugger is connected just remove `"--continue"` parameter from this [line](./test-vfkit/vfkit_suite_test.go#L93) 
+
+And debug server with `2345` port, you could use any `delve` client to interact with debugger
+
+##### GoLand Example
+Create new `Go Remote` debug configuration:
+1. Click Edit | Run Configurations. Alternatively, click the list of run/debug configurations on the toolbar and select Edit Configurations.
+2. In the Run/Debug Configurations dialog, click the Add button (the Add button) and select Go Remote.
+3. Set meaningful name
+4. In the Host field, keep `localhost`
+5. In the Port field, keep `2345` port number
+6. Click **OK** button
+
+Run `gvisor` tests with debug with:
+```shell
+make test-mac-debug
+```
+wait until `Listening for remote connections (connections are not authenticated nor encrypted)` message it appears.
+Click on debug button on Golang, ensure that your `Go Remote` profile is selected.
+
+Have fun with debugging.
+
+##### VSCode
+Create/edit `launch.json` by adding this configuration:
+```json
+   {
+      "name": "Connect to Gvisor",
+      "type": "go",
+      "request": "attach",
+      "mode": "remote",
+      "remotePath": "${workspaceFolder}",
+      "port": 2345,
+      "host": "localhost"
+    }
+```
+Run `gvisor` tests with debug with:
+```shell
+make test-mac-debug
+```
+wait until `Listening for remote connections (connections are not authenticated nor encrypted)` message it appears.
+Execute the launch attach request(`Connect to Gvisor`).
+
+Have fun with debugging.
+
+##### CLI Example
+
+Connect to debugger server with:
+```shell
+dlv connect :2345
+```
+Example of usage:
+```shell
+Type 'help' for list of commands.
+(dlv) break main.main
+Breakpoint 1 set at 0xe735776 for main.main() ./work/redhat/gvisor-tap-vsock/cmd/gvproxy/main.go:59
+(dlv) continue
+> [Breakpoint 1] main.main() ./work/redhat/gvisor-tap-vsock/cmd/gvproxy/main.go:59 (hits goroutine(1):1 total:1) (PC: 0xe735776)
+    54:         hostIP      = "192.168.127.254"
+    55:         host        = "host"
+    56:         gateway     = "gateway"
+    57: )
+    58:
+=>  59: func main() {
+    60:         version := types.NewVersion("gvproxy")
+    61:         version.AddFlag()
+    62:         flag.Var(&endpoints, "listen", "control endpoint")
+    63:         flag.BoolVar(&debug, "debug", false, "Print debug info")
+    64:         flag.IntVar(&mtu, "mtu", 1500, "Set the MTU")
+```
+More info about CLI client [here](https://github.com/go-delve/delve/blob/master/Documentation/cli/README.md)
+
+#### Editor integration
+
+For available editor integration look [there](https://github.com/go-delve/delve/blob/master/Documentation/EditorIntegration.md)

Makefile

@@ -78,3 +78,8 @@ test-qemu: gvproxy test-companion
 .PHONY: test-mac
 test-mac: gvproxy
 	go test -timeout 20m  -v ./test-vfkit
+
+.PHONY: test-mac-debug
+test-mac-debug:
+	go test -timeout 20m  -v ./test-vfkit --debug
+	rm -f ./test-vfkit/__debug_bin*

OWNERS

@@ -1,10 +1,13 @@
 approvers:
   - baude
   - cfergeau
+  - evidolob
+  - lstocchi
 
 reviewers:
   - baude
   - cfergeau
   - jakecorrenti
   - praveenkumar
   - evidolob
+  - lstocchi

README.md

@@ -112,7 +112,7 @@ With the executable:
 
 ### API
 
-When `gvproxy` is started with the `--listen` option, it exposes a HTTP API on the host.
+When `gvproxy` is started with the `--listen` or `--services` option, it exposes a HTTP API on the host.
 This API can be used with curl.
 
 ```
@@ -127,6 +127,8 @@ $ curl  --unix-socket /tmp/network.sock http:/unix/stats
 ...
 ```
 
+N.B: The `--services` option exposes the same HTTP API as the `--listen` option, but without the `/connect` endpoint. This is useful for scenarios where the `gvforwarder`/`vm` tool is not run on the guest but you still want to expose services and stats endpoints.
+
 ### Gateway
 
 The executable running on the host runs a virtual gateway that can be used by the VM.
@@ -144,7 +146,7 @@ nameserver 192.168.127.1
 ### Port forwarding
 
 Dynamic port forwarding is supported over the host HTTP API when `gvproxy` was
-started with `--listen`, but also in the VM over http://192.168.127.1:80.
+started with `--listen` or `--services`, but also in the VM over http://192.168.127.1:80.
 
 Expose a port:
 ```
@@ -207,3 +209,6 @@ This is the same behaviour as [slirp](https://wiki.qemu.org/index.php/Documentat
 2. Each time, a client sends a http request, the process creates and sends the appropriate Ethernet packets to the VM.
 3. The tap device receives the packets and injects them in the kernel.
 4. The http server receives the request and send back the response.
+
+### Development
+Developers who want to work on gvisor-tap-vsock should visit the [Development](./DEVELOPMENT.md) document.

cmd/gvproxy/main.go

@@ -30,22 +30,23 @@ import (
 )
 
 var (
-	debug           bool
-	mtu             int
-	endpoints       arrayFlags
-	vpnkitSocket    string
-	qemuSocket      string
-	bessSocket      string
-	stdioSocket     string
-	vfkitSocket     string
-	forwardSocket   arrayFlags
-	forwardDest     arrayFlags
-	forwardUser     arrayFlags
-	forwardIdentify arrayFlags
-	sshPort         int
-	pidFile         string
-	exitCode        int
-	logFile         string
+	debug            bool
+	mtu              int
+	endpoints        arrayFlags
+	vpnkitSocket     string
+	qemuSocket       string
+	bessSocket       string
+	stdioSocket      string
+	vfkitSocket      string
+	forwardSocket    arrayFlags
+	forwardDest      arrayFlags
+	forwardUser      arrayFlags
+	forwardIdentify  arrayFlags
+	sshPort          int
+	pidFile          string
+	exitCode         int
+	logFile          string
+	servicesEndpoint string
 )
 
 const (
@@ -74,6 +75,7 @@ func main() {
 	flag.Var(&forwardIdentify, "forward-identity", "Path to SSH identity key for forwarding")
 	flag.StringVar(&pidFile, "pid-file", "", "Generate a file with the PID in it")
 	flag.StringVar(&logFile, "log-file", "", "Output log messages (logrus) to a given file path")
+	flag.StringVar(&servicesEndpoint, "services", "", "Exposes the same HTTP API as the --listen flag, without the /connect endpoint")
 	flag.Parse()
 
 	if version.ShowVersion() {
@@ -262,7 +264,7 @@ func main() {
 	}
 
 	groupErrs.Go(func() error {
-		return run(ctx, groupErrs, &config, endpoints)
+		return run(ctx, groupErrs, &config, endpoints, servicesEndpoint)
 	})
 
 	// Wait for something to happen
@@ -310,7 +312,7 @@ func captureFile() string {
 	return "capture.pcap"
 }
 
-func run(ctx context.Context, g *errgroup.Group, configuration *types.Configuration, endpoints []string) error {
+func run(ctx context.Context, g *errgroup.Group, configuration *types.Configuration, endpoints []string, servicesEndpoint string) error {
 	vn, err := virtualnetwork.New(configuration)
 	if err != nil {
 		return err
@@ -326,6 +328,15 @@ func run(ctx context.Context, g *errgroup.Group, configuration *types.Configurat
 		httpServe(ctx, g, ln, withProfiler(vn))
 	}
 
+	if servicesEndpoint != "" {
+		log.Infof("enabling services API. Listening %s", servicesEndpoint)
+		ln, err := transport.Listen(servicesEndpoint)
+		if err != nil {
+			return errors.Wrap(err, "cannot listen")
+		}
+		httpServe(ctx, g, ln, vn.ServicesMux())
+	}
+
 	ln, err := vn.Listen("tcp", fmt.Sprintf("%s:80", gatewayIP))
 	if err != nil {
 		return err

go.mod

@@ -5,34 +5,33 @@ go 1.22.0
 require (
 	github.com/Microsoft/go-winio v0.6.2
 	github.com/apparentlymart/go-cidr v1.1.0
-	github.com/areYouLazy/libhosty v1.1.0
 	github.com/containers/winquit v1.1.0
 	github.com/coreos/stream-metadata-go v0.4.5
 	github.com/dustin/go-humanize v1.0.1
-	github.com/fsnotify/fsnotify v1.8.0
 	github.com/google/gopacket v1.1.19
 	github.com/insomniacslk/dhcp v0.0.0-20240710054256-ddd8a41251c9
 	github.com/linuxkit/virtsock v0.0.0-20220523201153-1a23e78aa7a2
 	github.com/mdlayher/vsock v1.2.1
-	github.com/miekg/dns v1.1.62
+	github.com/miekg/dns v1.1.63
 	github.com/onsi/ginkgo v1.16.5
 	github.com/onsi/gomega v1.36.2
 	github.com/opencontainers/go-digest v1.0.0
 	github.com/pkg/errors v0.9.1
-	github.com/qdm12/dns/v2 v2.0.0-rc6
 	github.com/sirupsen/logrus v1.9.3
 	github.com/songgao/packets v0.0.0-20160404182456-549a10cd4091
 	github.com/songgao/water v0.0.0-20200317203138-2b4b6d7c09d8
 	github.com/stretchr/testify v1.10.0
 	github.com/vishvananda/netlink v1.3.0
 	golang.org/x/crypto v0.32.0
+	golang.org/x/mod v0.22.0
 	golang.org/x/sync v0.10.0
 	golang.org/x/sys v0.29.0
 	gvisor.dev/gvisor v0.0.0-20240916094835-a174eb65023f
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/google/btree v1.1.2 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/mdlayher/socket v0.4.1 // indirect
@@ -43,7 +42,6 @@ require (
 	github.com/u-root/uio v0.0.0-20240224005618-d2acac8f3701 // indirect
 	github.com/vishvananda/netns v0.0.4 // indirect
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect
-	golang.org/x/mod v0.22.0 // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	golang.org/x/time v0.5.0 // indirect

go.sum

@@ -54,8 +54,8 @@ github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U
 github.com/mdlayher/socket v0.4.1/go.mod h1:cAqeGjoufqdxWkD7DkpyS+wcefOtmu5OQ8KuoJGIReA=
 github.com/mdlayher/vsock v1.2.1 h1:pC1mTJTvjo1r9n9fbm7S1j04rCgCzhCOS5DY0zqHlnQ=
 github.com/mdlayher/vsock v1.2.1/go.mod h1:NRfCibel++DgeMD8z/hP+PPTjlNJsdPOmxcnENvE+SE=
-github.com/miekg/dns v1.1.62 h1:cN8OuEF1/x5Rq6Np+h1epln8OiyPWV+lROx9LxcGgIQ=
-github.com/miekg/dns v1.1.62/go.mod h1:mvDlcItzm+br7MToIKqkglaGhlFMHJ9DTNNWONWXbNQ=
+github.com/miekg/dns v1.1.63 h1:8M5aAw6OMZfFXTT7K5V0Eu5YiiL8l7nUAkyN6C9YwaY=
+github.com/miekg/dns v1.1.63/go.mod h1:6NGHfjhpmr5lt3XPLuyfDJi5AXbNIPM9PY6H6sF1Nfs=
 github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
 github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE=
 github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU=