Support FreeBSD

.gitignore

@@ -1,5 +1,6 @@
 /.idea/
 /vendor/
 .DS_Store
+.worktrees/
 !/README.md
 /*.md

Makefile

@@ -6,7 +6,9 @@ build:
 	GOOS=linux GOARCH=386 go build -v -tags with_gvisor .
 	GOOS=linux GOARCH=arm go build -v -tags with_gvisor .
 	GOOS=android GOARCH=arm64 go build -v -tags with_gvisor .
+	GOOS=freebsd GOARCH=amd64 go build -v -tags with_gvisor .
 	GOOS=windows GOARCH=amd64 go build -v -tags with_gvisor .
+	GOOS=freebsd GOARCH=amd64 go build -v -tags with_gvisor .
 
 fmt:
 	@gofumpt -l -w .

internal/gtcpip/header/checksum.go → gtcpip/header/checksum.go

@@ -20,8 +20,8 @@ import (
 	"encoding/binary"
 	"fmt"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 )
 
 // PseudoHeaderChecksum calculates the pseudo-header checksum for the given

internal/gtcpip/header/eth.go → gtcpip/header/eth.go

@@ -17,7 +17,7 @@ package header
 import (
 	"encoding/binary"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip"
 )
 
 const (

internal/gtcpip/header/icmpv4.go → gtcpip/header/icmpv4.go

@@ -17,8 +17,8 @@ package header
 import (
 	"encoding/binary"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 )
 
 // ICMPv4 represents an ICMPv4 header stored in a byte array.

internal/gtcpip/header/icmpv6.go → gtcpip/header/icmpv6.go

@@ -17,8 +17,8 @@ package header
 import (
 	"encoding/binary"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 )
 
 // ICMPv6 represents an ICMPv6 header stored in a byte array.

internal/gtcpip/header/interfaces.go → gtcpip/header/interfaces.go

@@ -17,7 +17,7 @@ package header
 import (
 	"net/netip"
 
-	tcpip "github.com/sagernet/sing-tun/internal/gtcpip"
+	tcpip "github.com/sagernet/sing-tun/gtcpip"
 )
 
 const (

internal/gtcpip/header/ipv4.go → gtcpip/header/ipv4.go

@@ -20,8 +20,8 @@ import (
 	"net/netip"
 	"time"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 	"github.com/sagernet/sing/common"
 )
 

internal/gtcpip/header/ipv6.go → gtcpip/header/ipv6.go

@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"net/netip"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip"
 )
 
 const (

internal/gtcpip/header/ipv6_extension_headers.go → gtcpip/header/ipv6_extension_headers.go

@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"math"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip"
 	"github.com/sagernet/sing/common"
 )
 

internal/gtcpip/header/ipv6_fragment.go → gtcpip/header/ipv6_fragment.go

@@ -17,7 +17,7 @@ package header
 import (
 	"encoding/binary"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip"
 )
 
 const (

internal/gtcpip/header/ndp_neighbor_advert.go → gtcpip/header/ndp_neighbor_advert.go

@@ -14,7 +14,7 @@
 
 package header
 
-import "github.com/sagernet/sing-tun/internal/gtcpip"
+import "github.com/sagernet/sing-tun/gtcpip"
 
 // NDPNeighborAdvert is an NDP Neighbor Advertisement message. It will
 // only contain the body of an ICMPv6 packet.

internal/gtcpip/header/ndp_neighbor_solicit.go → gtcpip/header/ndp_neighbor_solicit.go

@@ -14,7 +14,7 @@
 
 package header
 
-import "github.com/sagernet/sing-tun/internal/gtcpip"
+import "github.com/sagernet/sing-tun/gtcpip"
 
 // NDPNeighborSolicit is an NDP Neighbor Solicitation message. It will only
 // contain the body of an ICMPv6 packet.

internal/gtcpip/header/ndp_options.go → gtcpip/header/ndp_options.go

@@ -23,7 +23,7 @@ import (
 	"math"
 	"time"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip"
 	"github.com/sagernet/sing/common"
 )
 

internal/gtcpip/header/tcp.go → gtcpip/header/tcp.go

@@ -17,9 +17,9 @@ package header
 import (
 	"encoding/binary"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
-	"github.com/sagernet/sing-tun/internal/gtcpip/seqnum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip/seqnum"
 
 	"github.com/google/btree"
 )

internal/gtcpip/header/udp.go → gtcpip/header/udp.go

@@ -18,8 +18,8 @@ import (
 	"encoding/binary"
 	"math"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip"
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 )
 
 const (

internal/checksum_test/sum_bench_test.go

@@ -4,7 +4,7 @@ import (
 	"crypto/rand"
 	"testing"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip/checksum"
+	"github.com/sagernet/sing-tun/gtcpip/checksum"
 	"github.com/sagernet/sing-tun/internal/tschecksum"
 )
 

monitor_freebsd.go

@@ -0,0 +1,174 @@
+package tun
+
+import (
+	"net"
+	"net/netip"
+	"os"
+	"sync"
+
+	"github.com/sagernet/sing/common/buf"
+	"github.com/sagernet/sing/common/control"
+	E "github.com/sagernet/sing/common/exceptions"
+	"github.com/sagernet/sing/common/logger"
+	"github.com/sagernet/sing/common/x/list"
+	"golang.org/x/net/route"
+	"golang.org/x/sys/unix"
+)
+
+var _ NetworkUpdateMonitor = (*networkUpdateMonitor)(nil)
+
+type networkUpdateMonitor struct {
+	access          sync.Mutex
+	callbacks       list.List[NetworkUpdateCallback]
+	routeSocketFile *os.File
+	closeOnce       sync.Once
+	done            chan struct{}
+	logger          logger.Logger
+}
+
+func NewNetworkUpdateMonitor(logger logger.Logger) (NetworkUpdateMonitor, error) {
+
+	return &networkUpdateMonitor{
+		logger: logger,
+		done:   make(chan struct{}),
+	}, nil
+}
+
+// Close implements NetworkUpdateMonitor.
+func (m *networkUpdateMonitor) Close() error {
+	m.closeOnce.Do(func() {
+		close(m.done)
+	})
+	return nil
+}
+
+// Start implements NetworkUpdateMonitor.
+func (m *networkUpdateMonitor) Start() error {
+	go m.loopUpdate()
+	return nil
+}
+
+func (m *networkUpdateMonitor) loopUpdate() {
+	for {
+		select {
+		case <-m.done:
+			return
+		default:
+		}
+		err := m.loopUpdate0()
+		if err != nil {
+			m.logger.Error("listen network update: ", err)
+			return
+		}
+	}
+}
+
+func (m *networkUpdateMonitor) loopUpdate0() error {
+	routeSocket, err := unix.Socket(unix.AF_ROUTE, unix.SOCK_RAW, 0)
+	if err != nil {
+		return err
+	}
+	err = unix.SetNonblock(routeSocket, true)
+	if err != nil {
+		unix.Close(routeSocket)
+		return err
+	}
+	routeSocketFile := os.NewFile(uintptr(routeSocket), "route")
+	defer routeSocketFile.Close()
+	m.routeSocketFile = routeSocketFile
+	m.loopUpdate1(routeSocketFile)
+	return nil
+}
+
+func (m *networkUpdateMonitor) loopUpdate1(routeSocketFile *os.File) {
+	buffer := buf.NewPacket()
+	defer buffer.Release()
+
+	done := make(chan struct{})
+	go func() {
+		select {
+		case <-m.done:
+			routeSocketFile.Close()
+		case <-done:
+		}
+	}()
+	n, err := routeSocketFile.Read(buffer.FreeBytes())
+	close(done)
+	if err != nil {
+		return
+	}
+	buffer.Truncate(n)
+
+	messages, err := route.ParseRIB(route.RIBTypeRoute, buffer.Bytes())
+	if err != nil {
+		return
+	}
+
+	for _, message := range messages {
+		if _, isRouteMessage := message.(*route.RouteMessage); isRouteMessage {
+			m.emit()
+			return
+		}
+	}
+}
+
+// checkUpdate finds the first IPv4 default gateway and emits an update event.
+func (m *defaultInterfaceMonitor) checkUpdate() error {
+	var defaultInterface *control.Interface
+	ribMessage, err := route.FetchRIB(unix.AF_INET, route.RIBTypeRoute, 0)
+	if err != nil {
+		return err
+	}
+	routeMessages, err := route.ParseRIB(route.RIBTypeRoute, ribMessage)
+	if err != nil {
+		return err
+	}
+
+	for _, rawRouteMessage := range routeMessages {
+		routeMessage := rawRouteMessage.(*route.RouteMessage)
+		if len(routeMessage.Addrs) <= unix.RTAX_NETMASK {
+			continue
+		}
+		destination, isIPv4Destination := routeMessage.Addrs[unix.RTAX_DST].(*route.Inet4Addr)
+		if !isIPv4Destination || destination.IP != netip.IPv4Unspecified().As4() {
+			continue
+		}
+		mask, isIPv4Mask := routeMessage.Addrs[unix.RTAX_NETMASK].(*route.Inet4Addr)
+		if !isIPv4Mask {
+			continue
+		}
+		if ones, _ := net.IPMask(mask.IP[:]).Size(); ones != 0 {
+			continue
+		}
+		flag := unix.RTF_UP | unix.RTF_GATEWAY | unix.RTF_STATIC
+		if routeMessage.Flags&(flag) != flag {
+			continue
+		}
+		routeInterface, err := m.interfaceFinder.ByIndex(routeMessage.Index)
+		if err != nil {
+			return err
+		}
+		if routeInterface.Flags&net.FlagLoopback != 0 {
+			continue
+		}
+		defaultInterface = routeInterface
+		break
+	}
+
+	if defaultInterface == nil {
+		if m.underNetworkExtension {
+			m.logger.Warn("Not implemented: UnderNetworkExtension")
+		}
+		return ErrNoRoute
+	}
+	newInterface, err := m.interfaceFinder.ByIndex(defaultInterface.Index)
+	if err != nil {
+		return E.Cause(err, "find updated interface: ", defaultInterface.Name)
+	}
+	oldInterface := m.defaultInterface.Swap(newInterface)
+	if oldInterface != nil && oldInterface.Equals(*newInterface) {
+		return nil
+	}
+	m.emit(newInterface, 0)
+	return nil
+}

monitor_other.go

@@ -1,4 +1,4 @@
-//go:build !(linux || windows || darwin)
+//go:build !(linux || windows || darwin || freebsd)
 
 package tun
 

monitor_shared.go

@@ -1,4 +1,4 @@
-//go:build linux || windows || darwin
+//go:build linux || windows || darwin || freebsd
 
 package tun
 

nfqueue_linux.go

@@ -7,7 +7,7 @@ import (
 	"errors"
 	"sync/atomic"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip/header"
+	"github.com/sagernet/sing-tun/gtcpip/header"
 	E "github.com/sagernet/sing/common/exceptions"
 	"github.com/sagernet/sing/common/logger"
 	M "github.com/sagernet/sing/common/metadata"

ping/destination.go

@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/sagernet/sing-tun"
-	"github.com/sagernet/sing-tun/internal/gtcpip/header"
+	"github.com/sagernet/sing-tun/gtcpip/header"
 	"github.com/sagernet/sing/common/buf"
 	"github.com/sagernet/sing/common/control"
 	E "github.com/sagernet/sing/common/exceptions"

ping/destination_rewriter.go

@@ -4,7 +4,7 @@ import (
 	"net/netip"
 
 	"github.com/sagernet/sing-tun"
-	"github.com/sagernet/sing-tun/internal/gtcpip/header"
+	"github.com/sagernet/sing-tun/gtcpip/header"
 	"github.com/sagernet/sing/common/buf"
 )
 

ping/ping.go

@@ -9,7 +9,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/sagernet/sing-tun/internal/gtcpip/header"
+	"github.com/sagernet/sing-tun/gtcpip/header"
 	"github.com/sagernet/sing/common"
 	"github.com/sagernet/sing/common/buf"
 	"github.com/sagernet/sing/common/control"

ping/ping_test.go

@@ -9,7 +9,7 @@ import (
 	"time"
 
 	"github.com/sagernet/gvisor/pkg/rand"
-	"github.com/sagernet/sing-tun/internal/gtcpip/header"
+	"github.com/sagernet/sing-tun/gtcpip/header"
 	"github.com/sagernet/sing-tun/ping"
 	"github.com/sagernet/sing/common/buf"