The initial commit of socket_vmnet (Forked from [email protected])

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

.github/workflows/test.yml

@@ -24,25 +24,23 @@ jobs:
           uname -a
           sw_vers
           ifconfig
-      - name: Install build dependencies of VDE
-        run: brew install autoconf automake
       - name: Make Install (x86_64)
         run: |
           # compile for x86_64
-          sudo make PREFIX=/opt/vde install
-          if file /opt/vde/bin/* | grep -q arm64 ; then false ; fi
+          sudo make PREFIX=/opt/socket_vmnet install
+          if file /opt/socket_vmnet/bin/* | grep -q arm64 ; then false ; fi
       - name: Cleanup
         run: |
           sudo make clean
       - name: Make Install (arm64)
         run: |
           # cross-compile for arm64
-          sudo make PREFIX=/opt/vde.arm64 ARCH=arm64 install
-          if file /opt/vde.arm64/bin/* | grep -q x86_64 ; then false ; fi
+          sudo make PREFIX=/opt/socket_vmnet.arm64 ARCH=arm64 install
+          if file /opt/socket_vmnet.arm64/bin/* | grep -q x86_64 ; then false ; fi
       - name: Print launchd status (shared mode)
-        run: launchctl print system/io.github.lima-vm.vde_vmnet.plist
+        run: launchctl print system/io.github.lima-vm.socket_vmnet.plist
       - name: Install test dependencies
         run: brew install qemu bash coreutils
       - name: Test (shared mode)
-        run: ./test/test.sh /var/run/vde.ctl
+        run: ./test/test.sh /var/run/socket_vmnet
 # Bridged mode cannot be tested on GHA

.gitignore

@@ -1,2 +1,3 @@
-/vde_vmnet
+/socket_vmnet
+/socket_vmnet_client
 *.o

.gitmodules

@@ -1,100 +1,80 @@
 # PREFIX should be only writable by the root to avoid privilege escalation with launchd or sudo
-PREFIX ?= /opt/vde
+PREFIX ?= /opt/socket_vmnet
 
-# VDEPREFIX should be only writable by the root to avoid privilege escalation with launchd or sudo
-VDEPREFIX ?= $(PREFIX)
-
-VMNET_CFLAGS ?= -O3
+CFLAGS ?= -O3
 
 VERSION ?= $(shell git describe --match 'v[0-9]*' --dirty='.m' --always --tags)
 
-VMNET_CFLAGS += -I"$(VDEPREFIX)/include" -DVERSION=\"$(VERSION)\"
+CFLAGS += -DVERSION=\"$(VERSION)\"
 
-VMNET_LDFLAGS += -L"$(VDEPREFIX)/lib" -lvdeplug -framework vmnet
+LDFLAGS ?=
+VMNET_LDFLAGS = -framework vmnet
 
 # ARCH support arm64 and x86_64
 ARCH ?=
 
 ifneq (,$(findstring arm64,$(ARCH)))
 	HOST ?= --host arm-apple-darwin
-	VMNET_CFLAGS += -arch arm64
-	VDE2_CFLAGS += -arch arm64 -Wno-error=implicit-function-declaration
+	CFLAGS += -arch arm64
 else ifneq (,$(findstring x86_64,$(ARCH)))
 	HOST ?= --host x86_64-apple-darwin
-	VMNET_CFLAGS += -arch x86_64
-	VDE2_CFLAGS += -arch x86_64 -Wno-error=implicit-function-declaration
+	CFLAGS += -arch x86_64
 endif
 
 # Interface name for bridged mode. Empty value (default) disables bridged mode.
 BRIDGED ?=
 
-all: vde_vmnet
-
-OBJS = $(patsubst %.c, %.o, $(wildcard *.c))
+all: socket_vmnet socket_vmnet_client
 
 %.o: %.c *.h
-	$(CC) $(VMNET_CFLAGS) -c $< -o $@
+	$(CC) $(CFLAGS) -c $< -o $@
 
-vde_vmnet: $(OBJS)
-	$(CC) $(VMNET_CFLAGS) -o $@ $(VMNET_LDFLAGS) $(OBJS)
+socket_vmnet: $(patsubst %.c, %.o, $(wildcard *.c))
+	$(CC) $(CFLAGS) -o $@ $(LDFLAGS) $(VMNET_LDFLAGS) $^
 
-install.bin: vde_vmnet
-	install vde_vmnet "$(DESTDIR)/$(PREFIX)/bin/vde_vmnet"
+socket_vmnet_client: $(patsubst %.c, %.o, $(wildcard client/*.c))
+	$(CC) $(CFLAGS) -o $@ $(LDFLAGS) $^
 
-install.vde-2:
-	git submodule update --init
-	cd vde-2 && autoreconf -fis && CFLAGS="$(VDE2_CFLAGS)" ./configure --prefix=$(VDEPREFIX) $(HOST) && make && make install
+install.bin: socket_vmnet socket_vmnet_client
+	mkdir -p "$(DESTDIR)/$(PREFIX)/bin"
+	install socket_vmnet "$(DESTDIR)/$(PREFIX)/bin/socket_vmnet"
+	install socket_vmnet_client "$(DESTDIR)/$(PREFIX)/bin/socket_vmnet_client"
 
 install.launchd.plist: launchd/*.plist
-	sed -e "s@/opt/vde@$(PREFIX)@g" launchd/io.github.virtualsquare.vde-2.vde_switch.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.plist"
-	sed -e "s@/opt/vde@$(PREFIX)@g" launchd/io.github.lima-vm.vde_vmnet.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.plist"
+	sed -e "s@/opt/socket_vmnet@$(PREFIX)@g" launchd/io.github.lima-vm.socket_vmnet.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.plist"
 
 ifneq ($(BRIDGED),)
-	sed -e "s@/opt/vde@$(PREFIX)@g" -e "s/en0/$(BRIDGED)/g" launchd/io.github.virtualsquare.vde-2.vde_switch.bridged.en0.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.bridged.$(BRIDGED).plist"
-	sed -e "s@/opt/vde@$(PREFIX)@g" -e "s/en0/$(BRIDGED)/g" launchd/io.github.lima-vm.vde_vmnet.bridged.en0.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.bridged.$(BRIDGED).plist"
+	sed -e "s@/opt/socket_vmnet@$(PREFIX)@g" -e "s/en0/$(BRIDGED)/g" launchd/io.github.lima-vm.socket_vmnet.bridged.en0.plist > "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.bridged.$(BRIDGED).plist"
 endif
 
 install.launchd: install.launchd.plist
-	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.plist"
-	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.plist"
+	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.plist"
 ifneq ($(BRIDGED),)
-	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.bridged.$(BRIDGED).plist"
-	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.bridged.$(BRIDGED).plist"
+	launchctl load -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.bridged.$(BRIDGED).plist"
 endif
 
-install: install.vde-2 install.bin install.launchd
+install: install.bin install.launchd
 
 .PHONY: uninstall.bin
 uninstall.bin:
-	rm -f "$(DESTDIR)/$(PREFIX)/bin/vde_vmnet"
-
-.PHONY: uninstall.vde-2
-uninstall.vde-2:
-	cd vde-2 && make uninstall
+	rm -f "$(DESTDIR)/$(PREFIX)/bin/socket_vmnet"
+	rm -f "$(DESTDIR)/$(PREFIX)/bin/socket_vmnet_client"
 
 .PHONY: uninstall.launchd
 uninstall.launchd:
-	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.plist"
-	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.plist"
+	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.plist"
 ifneq ($(BRIDGED),)
-	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.bridged.$(BRIDGED).plist"
-	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.bridged.$(BRIDGED).plist"
+	launchctl unload -w "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.bridged.$(BRIDGED).plist"
 endif
 
 uninstall.launchd.plist: uninstall.launchd
-	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.plist"
-	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.plist"
+	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.plist"
 ifneq ($(BRIDGED),)
-	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.bridged.$(BRIDGED).plist"
-	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.bridged.$(BRIDGED).plist"
+	rm -f "$(DESTDIR)/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.bridged.$(BRIDGED).plist"
 endif
 
-uninstall: uninstall.launchd.plist uninstall.bin uninstall.vde-2
-
-.PHONY: clean.vde-2
-clean.vde-2:
-	cd vde-2 && make distclean
+uninstall: uninstall.launchd.plist uninstall.bin
 
 .PHONY: clean
-clean: clean.vde-2
-	rm -f vde_vmnet *.o
+clean:
+	rm -f socket_vmnet socket_vmnet_client *.o client/*.o

Makefile

@@ -1,41 +1,43 @@
-# vde_vmnet: vmnet.framework support for rootless QEMU
+# socket_vmnet: vmnet.framework support for rootless and VDE-less QEMU
 
-`vde_vmnet` provides [vmnet.framework](https://developer.apple.com/documentation/vmnet) support for VDE applications such as QEMU.
+`socket_vmnet` provides [vmnet.framework](https://developer.apple.com/documentation/vmnet) support for QEMU.
 
-`vde_vmnet` does not require QEMU to run as the root user.
+`socket_vmnet` does not require QEMU to run as the root user.
 
-(But `vde_vmnet` itself has to run as the root, in most cases.)
+(But `socket_vmnet` itself has to run as the root, in most cases.)
+
+`socket_vmnet` was forked from [`vde_vmnet`](https://github.com/lima-vm/vde_vmnet) v0.6.0.
+Unlike `vde_vmnet`, `socket_vmnet` does not depend on VDE.
 
 ## Install
 
 Requires macOS 10.15 or later.
 
-Install [vde-2](https://github.com/virtualsquare/vde-2) and vde_vmnet from source.
+Install from source:
 ```bash
-sudo make PREFIX=/opt/vde install
+sudo make PREFIX=/opt/socket_vmnet install
 ```
 
-The `PREFIX` dir below does not necessarily need to be `/opt/vde`, however, it is highly recommended
+The `PREFIX` dir below does not necessarily need to be `/opt/socket_vmnet`, however, it is highly recommended
 to set the prefix to a directory that can be only written by the root.
 
 Note that `/usr/local` is typically chowned for a non-root user on Homebrew environments, so
 `/usr/local` is *not* an appropriate prefix.
 
 The following files will be installed:
-- `/opt/vde/bin/vde_switch` (from vde-2)
-- `/opt/vde/bin/vde_vmnet`
-- `/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.plist`
-- `/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.plist`
+- `/opt/socket_vmnet/bin/socket_vmnet`
+- `/opt/socket_vmnet/bin/socket_vmnet_client`
+- `/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.plist`
   - Configured to use `192.168.105.0/24`. Modifiy the file if it conflicts with your local network.
 
 See ["Testing without launchd"](#testing-without-launchd) if you don't prefer to use launchd.
 
 ## Usage
 
 ```console
-qemu-system-x86_64 \
-  -device virtio-net-pci,netdev=net0 -netdev vde,id=net0,sock=/var/run/vde.ctl \
-  -m 4096 -accel hvf -cdrom ubuntu-21.04-desktop-amd64.iso
+/opt/socket_vmnet/bin/socket_vmnet_client /var/run/socket_vmnet qemu-system-x86_64 \
+  -device virtio-net-pci,netdev=net0 -netdev socket,id=net0,fd=3 \
+  -m 4096 -accel hvf -cdrom ubuntu-22.04-desktop-amd64.iso
 ```
 
 The guest IP is assigned by the DHCP server provided by macOS.
@@ -46,70 +48,44 @@ To confirm, run `sudo apt-get update && sudo apt-get install -y apache2` in the
 
 ### Lima integration
 
-See https://github.com/lima-vm/lima/blob/master/docs/network.md to learn how to use `vde_vmnet` with [Lima](https://github.com/lima-vm/lima).
+(WIP)
 
 ### Multi VM
-Multiple VMs can be connected to a single `vde_vmnet` instance.
+Multiple VMs can be connected to a single `socket_vmnet` instance.
 
 Make sure to specify unique MAC addresses to VMs: `-device virtio-net-pci,netdev=net0,mac=de:ad:be:ef:00:01` .
 
-NOTE: don't confuse MAC addresses of VMs with the MAC address of `vde_vmnet` itself that is printed as `vmnet_mac_address` in the debug log.
-You do not need to configure (and you can't, currently) the MAC address of `vde_vmnet` itself.
+NOTE: don't confuse MAC addresses of VMs with the MAC address of `socket_vmnet` itself that is printed as `vmnet_mac_address` in the debug log.
+You do not need to configure (and you can't, currently) the MAC address of `socket_vmnet` itself.
 
 ### Bridged mode
 
 Run `sudo make install BRIDGED=en0`.
 
-The following additional files will be installed:
-- `/Library/LaunchDaemons/io.github.virtualsquare.vde-2.vde_switch.bridged.en0.plist`
-- `/Library/LaunchDaemons/io.github.lima-vm.vde_vmnet.bridged.en0.plist`
+The following additional file will be installed:
+- `/Library/LaunchDaemons/io.github.lima-vm.socket_vmnet.bridged.en0.plist`
 
-Use `/var/run/vde.bridged.en0.ctl` as the VDE socket path.
+Use `/var/run/socket_vmnet.bridged.en0` as the socket.
 
 ## Advanced usage
 
 ### Testing without launchd
 
 ```console
-sudo make install.vde-2
-
 sudo make install.bin
 ```
 
 ```console
-vde_switch --unix /tmp/vde.ctl
-```
-
-```console
-sudo vde_vmnet --vmnet-gateway=192.168.105.1 /tmp/vde.ctl
+sudo socket_vmnet --vmnet-gateway=192.168.105.1 /tmp/socket_vmnet
 ```
 
-Note: make sure to run `vde_vmnet` with root (`sudo`). See [FAQs](#FAQs) for the reason.
-`vde_switch` does not need to be executed as root.
-
-### PTP mode (Switchless mode)
-
-- Pros: doesn't require the `vde_switch` process to be running
-- Cons: Only single QEMU process can connect to the socket. Multiple `vde_vmnet` processes need to be launched for multiple QEMU processes.
-
-To enable PTP mode, append `[]` to the socket path argument of `vde_vmnet`.
-
-```console
-sudo vde_vmnet /tmp/vde.ptp[]
-```
-
-QEMU has to be launched with `port=65535` without `[]`.
-
-```console
-qemu-system-x86_64 -netdev vde,id=net0,sock=/tmp/vde.ptp,port=65535 ...
-```
-
-The "port" number here has nothing to do with TCP/UDP ports.
+Note: make sure to run `socket_vmnet` with root (`sudo`). See [FAQs](#FAQs) for the reason.
 
 ## FAQs
-### Why does `vde_vmnet` require root?
 
-Running `vde_vmnet` without root could be possible by signing the `vde_vmnet` binary with `com.apple.vm.networking` entitlement.
+### Why does `socket_vmnet` require root?
+
+Running `socket_vmnet` without root could be possible by signing the `socket_vmnet` binary with `com.apple.vm.networking` entitlement.
 
 However, signing a binary with `com.apple.vm.networking` entitlement seems to require some contract with Apple.
 :disappointed:
@@ -118,22 +94,25 @@ However, signing a binary with `com.apple.vm.networking` entitlement seems to re
 
 https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_vm_networking
 
-### Is it possible to run `vde_vmnet` with SETUID?
+### Is it possible to run `socket_vmnet` with SETUID?
 
 Yes, but discouraged, as it allows non-root users to write arbitrary files, by specifying certain CLI args and environment variables.
 
 Instead, consider using launchd or sudo.
 
-See [`./etc_sudoers.d/vde_vmnet`](./etc_sudoers.d/vde_vmnet) to allow running `sudo vde_vmnet` with reduced set of args and environment variables.
+See [`./etc_sudoers.d/socket_vmnet`](./etc_sudoers.d/socket_vmnet) to allow running `sudo socket_vmnet` with reduced set of args and environment variables.
+
+### How is socket_vmnet related to vde_vmnet?
+
+`socket_vmnet` was forked from [`vde_vmnet`](https://github.com/lima-vm/vde_vmnet) v0.6.0.
+Unlike `vde_vmnet`, `socket_vmnet` does not depend on VDE.
 
-### How is vde_vmnet related to QEMU-builtin vmnet support?
-There are proposal to add builtin vmnet support for QEMU:
-- https://lore.kernel.org/qemu-devel/[email protected]/
-- https://lore.kernel.org/qemu-devel/[email protected]/
+### How is socket_vmnet related to QEMU-builtin vmnet support?
+There is a proposal to add builtin vmnet support for QEMU: [`[v22] Add vmnet.framework based network backend`](https://patchwork.kernel.org/project/qemu-devel/cover/[email protected]/).
 
-However, QEMU-builtin vmnet is highly likely to require running the entire QEMU process as root.
+However, QEMU-builtin vmnet requires running the entire QEMU process as root.
 
-On the other hand, `vde_vmnet` does not require the entire QEMU process to run as root, though `vde_vmnet` has to run as root.
+On the other hand, `socket_vmnet` does not require the entire QEMU process to run as root, though `socket_vmnet` has to run as root.
 
 ### How to use static IP addresses?
 When `--vmnet-gateway=IP` is set to "192.168.105.1", the whole subnet (192.168.105.2-192.168.105.254) is used as the DHCP range.
@@ -164,8 +143,8 @@ sudo /bin/launchctl load -w /System/Library/LaunchDaemons/bootps.plist
 
 - Run QEMU with the MAC address: `-device virtio-net-pci,netdev=net0,mac=de:ad:be:ef:00:01` .
 
-NOTE: don't confuse MAC addresses of VMs with the MAC address of `vde_vmnet` itself that is printed as `vmnet_mac_address` in the debug log.
-You do not need to configure (and you can't, currently) the MAC address of `vde_vmnet` itself.
+NOTE: don't confuse MAC addresses of VMs with the MAC address of `socket_vmnet` itself that is printed as `vmnet_mac_address` in the debug log.
+You do not need to configure (and you can't, currently) the MAC address of `socket_vmnet` itself.
 
 ## Links
 - https://developer.apple.com/documentation/vmnet
@@ -174,4 +153,4 @@ You do not need to configure (and you can't, currently) the MAC address of `vde_
 
 ## Troubleshooting
 - Set environment variable `DEBUG=1`
-- See `/var/run/vde_vmnet.{stdout,stderr}` (when using launchd)
+- See `/var/run/socket_vmnet.{stdout,stderr}` (when using launchd)