test/internal/mountinfo: move from sandbox

This also improves its API.

Signed-off-by: Ophestra <cat@gensokyo.uk>

3 files changed, 15 insertions, 313 deletions

diff --git a/test/internal/sandbox/assert.go b/test/internal/sandbox/assert.go
index e6fe926b..2125419b 100644
--- a/test/internal/sandbox/assert.go
+++ b/test/internal/sandbox/assert.go
@@ -19,6 +19,8 @@ import (
 	"os"
 	"path/filepath"
 	"syscall"
+
+	"hakurei.app/test/internal/mountinfo"
 )
 
 var (
@@ -31,10 +33,10 @@ func printf(format string, v ...any) { printfFunc(format, v...) }
 func fatalf(format string, v ...any) { fatalfFunc(format, v...) }
 
 type TestCase struct {
-	Env     []string          `json:"env"`
-	FS      *FS               `json:"fs"`
-	Mount   []*MountinfoEntry `json:"mount"`
-	Seccomp bool              `json:"seccomp"`
+	Env     []string           `json:"env"`
+	FS      *FS                `json:"fs"`
+	Mount   []*mountinfo.Entry `json:"mount"`
+	Seccomp bool               `json:"seccomp"`
 
 	TrySocket      string `json:"try_socket,omitempty"`
 	SocketAbstract bool   `json:"socket_abstract,omitempty"`
@@ -120,15 +122,18 @@ func (t *T) MustCheck(want *TestCase) {
 		var fail bool
 		m := mustParseMountinfo(t.MountsPath)
 		i := 0
-		for ent := range m.Entries() {
+		var ent mountinfo.Entry
+		for m.Next() {
+			m.Copy(&ent)
+
 			if i == len(want.Mount) {
 				fatalf("got more than %d entries", i)
 			}
 			if !ent.EqualWithIgnore(want.Mount[i], "//ignore") {
 				fail = true
-				printf("[FAIL] %s", ent)
+				printf("[FAIL] %s", &ent)
 			} else {
-				printf("[ OK ] %s", ent)
+				printf("[ OK ] %s", &ent)
 			}
 
 			i++
@@ -262,9 +267,9 @@ func mustDecode(wantFilePath string, v any) {
 	}
 }
 
-func mustParseMountinfo(name string) *Mountinfo {
-	m := NewMountinfo(name)
-	if err := m.Parse(); err != nil {
+func mustParseMountinfo(name string) *mountinfo.Iter {
+	m, err := mountinfo.Open(name)
+	if err != nil {
 		fatalf("%v", err)
 		panic("unreachable")
 	}
diff --git a/test/internal/sandbox/mount.go b/test/internal/sandbox/mount.go
deleted file mode 100644
index 791a68b9..00000000
--- a/test/internal/sandbox/mount.go
+++ /dev/null
@@ -1,159 +0,0 @@
-//go:build testtool
-
-package sandbox
-
-/*
-#cgo linux pkg-config: --static mount
-
-#include <stdlib.h>
-#include <stdio.h>
-#include <libmount.h>
-
-const char *HAKUREI_MOUNTINFO_PATH = "/proc/self/mountinfo";
-*/
-import "C"
-
-import (
-	"errors"
-	"fmt"
-	"iter"
-	"runtime"
-	"sync"
-	"unsafe"
-)
-
-var (
-	ErrMountinfoParse = errors.New("invalid mountinfo records")
-	ErrMountinfoIter  = errors.New("cannot allocate iterator")
-	ErrMountinfoFault = errors.New("cannot iterate on filesystems")
-)
-
-type (
-	Mountinfo struct {
-		mu  sync.RWMutex
-		p   string
-		err error
-
-		tb  *C.struct_libmnt_table
-		itr *C.struct_libmnt_iter
-
-		fs *C.struct_libmnt_fs
-	}
-
-	// MountinfoEntry represents deterministic mountinfo parts of a libmnt_fs entry.
-	MountinfoEntry struct {
-		// mount ID: a unique ID for the mount (may be reused after umount(2)).
-		ID int `json:"id"`
-		// parent ID: the ID of the parent mount (or of self for the root of this mount namespace's mount tree).
-		Parent int `json:"parent"`
-		// root: the pathname of the directory in the filesystem which forms the root of this mount.
-		Root string `json:"root"`
-		// mount point: the pathname of the mount point relative to the process's root directory.
-		Target string `json:"target"`
-		// mount options: per-mount options (see mount(2)).
-		VfsOptstr string `json:"vfs_optstr"`
-		// filesystem type: the filesystem type in the form "type[.subtype]".
-		FsType string `json:"fstype"`
-		// mount source: filesystem-specific information or "none".
-		Source string `json:"source"`
-		// super options: per-superblock options (see mount(2)).
-		FsOptstr string `json:"fs_optstr"`
-	}
-)
-
-func (m *Mountinfo) copy(v *MountinfoEntry) {
-	if m.fs == nil {
-		panic("invalid entry")
-	}
-	v.ID = int(C.mnt_fs_get_id(m.fs))
-	v.Parent = int(C.mnt_fs_get_parent_id(m.fs))
-	v.Root = C.GoString(C.mnt_fs_get_root(m.fs))
-	v.Target = C.GoString(C.mnt_fs_get_target(m.fs))
-	v.VfsOptstr = C.GoString(C.mnt_fs_get_vfs_options(m.fs))
-	v.FsType = C.GoString(C.mnt_fs_get_fstype(m.fs))
-	v.Source = C.GoString(C.mnt_fs_get_source(m.fs))
-	v.FsOptstr = C.GoString(C.mnt_fs_get_fs_options(m.fs))
-}
-
-func NewMountinfo(p string) *Mountinfo { m := new(Mountinfo); m.p = p; return m }
-
-func (m *Mountinfo) Err() error { m.mu.RLock(); defer m.mu.RUnlock(); return m.err }
-
-func (m *Mountinfo) Parse() error {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	if m.tb != nil {
-		panic("open called twice")
-	}
-
-	if m.p == "" {
-		m.tb = C.mnt_new_table_from_file(C.HAKUREI_MOUNTINFO_PATH)
-	} else {
-		name := C.CString(m.p)
-		m.tb = C.mnt_new_table_from_file(name)
-		C.free(unsafe.Pointer(name))
-	}
-	if m.tb == nil {
-		return ErrMountinfoParse
-	}
-	m.itr = C.mnt_new_iter(C.MNT_ITER_FORWARD)
-	if m.itr == nil {
-		C.mnt_unref_table(m.tb)
-		return ErrMountinfoIter
-	}
-
-	runtime.SetFinalizer(m, (*Mountinfo).Unref)
-	return nil
-}
-
-func (m *Mountinfo) Unref() {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	if m.tb == nil {
-		panic("unref called before parse")
-	}
-
-	C.mnt_unref_table(m.tb)
-	C.mnt_free_iter(m.itr)
-	runtime.SetFinalizer(m, nil)
-}
-
-func (m *Mountinfo) Entries() iter.Seq[*MountinfoEntry] {
-	return func(yield func(*MountinfoEntry) bool) {
-		m.mu.Lock()
-		defer m.mu.Unlock()
-
-		C.mnt_reset_iter(m.itr, -1)
-
-		var rc C.int
-		ent := new(MountinfoEntry)
-		for rc = C.mnt_table_next_fs(m.tb, m.itr, &m.fs); rc == 0; rc = C.mnt_table_next_fs(m.tb, m.itr, &m.fs) {
-			m.copy(ent)
-			if !yield(ent) {
-				return
-			}
-		}
-		if rc < 0 {
-			m.err = ErrMountinfoFault
-			return
-		}
-	}
-}
-
-func (e *MountinfoEntry) EqualWithIgnore(want *MountinfoEntry, ignore string) bool {
-	return (e.ID == want.ID || want.ID == -1) &&
-		(e.Parent == want.Parent || want.Parent == -1) &&
-		(e.Root == want.Root || want.Root == ignore) &&
-		(e.Target == want.Target || want.Target == ignore) &&
-		(e.VfsOptstr == want.VfsOptstr || want.VfsOptstr == ignore) &&
-		(e.FsType == want.FsType || want.FsType == ignore) &&
-		(e.Source == want.Source || want.Source == ignore) &&
-		(e.FsOptstr == want.FsOptstr || want.FsOptstr == ignore)
-}
-
-func (e *MountinfoEntry) String() string {
-	return fmt.Sprintf("%d %d %s %s %s %s %s %s",
-		e.ID, e.Parent, e.Root, e.Target, e.VfsOptstr, e.FsType, e.Source, e.FsOptstr)
-}
diff --git a/test/internal/sandbox/mount_test.go b/test/internal/sandbox/mount_test.go
deleted file mode 100644
index a565b0a0..00000000
--- a/test/internal/sandbox/mount_test.go
+++ /dev/null
@@ -1,144 +0,0 @@
-//go:build testtool
-
-package sandbox_test
-
-import (
-	"os"
-	"path/filepath"
-	"testing"
-
-	"hakurei.app/test/internal/sandbox"
-)
-
-func TestMountinfo(t *testing.T) {
-	testCases := []struct {
-		name string
-
-		sample string
-		want   []*sandbox.MountinfoEntry
-	}{
-		{"util-linux", `15 20 0:3 / /proc rw,relatime - proc /proc rw
-16 20 0:15 / /sys rw,relatime - sysfs /sys rw
-17 20 0:5 / /dev rw,relatime - devtmpfs udev rw,size=1983516k,nr_inodes=495879,mode=755
-18 17 0:10 / /dev/pts rw,relatime - devpts devpts rw,gid=5,mode=620,ptmxmode=000
-19 17 0:16 / /dev/shm rw,relatime - tmpfs tmpfs rw
-20 1 8:4 / / rw,noatime - ext3 /dev/sda4 rw,errors=continue,user_xattr,acl,barrier=0,data=ordered
-21 16 0:17 / /sys/fs/cgroup rw,nosuid,nodev,noexec,relatime - tmpfs tmpfs rw,mode=755
-22 21 0:18 / /sys/fs/cgroup/systemd rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,release_agent=/lib/systemd/systemd-cgroups-agent,name=systemd
-23 21 0:19 / /sys/fs/cgroup/cpuset rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,cpuset
-24 21 0:20 / /sys/fs/cgroup/ns rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,ns
-25 21 0:21 / /sys/fs/cgroup/cpu rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,cpu
-26 21 0:22 / /sys/fs/cgroup/cpuacct rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,cpuacct
-27 21 0:23 / /sys/fs/cgroup/memory rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,memory
-28 21 0:24 / /sys/fs/cgroup/devices rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,devices
-29 21 0:25 / /sys/fs/cgroup/freezer rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,freezer
-30 21 0:26 / /sys/fs/cgroup/net_cls rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,net_cls
-31 21 0:27 / /sys/fs/cgroup/blkio rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,blkio
-32 16 0:28 / /sys/kernel/security rw,relatime - autofs systemd-1 rw,fd=22,pgrp=1,timeout=300,minproto=5,maxproto=5,direct
-33 17 0:29 / /dev/hugepages rw,relatime - autofs systemd-1 rw,fd=23,pgrp=1,timeout=300,minproto=5,maxproto=5,direct
-34 16 0:30 / /sys/kernel/debug rw,relatime - autofs systemd-1 rw,fd=24,pgrp=1,timeout=300,minproto=5,maxproto=5,direct
-35 15 0:31 / /proc/sys/fs/binfmt_misc rw,relatime - autofs systemd-1 rw,fd=25,pgrp=1,timeout=300,minproto=5,maxproto=5,direct
-36 17 0:32 / /dev/mqueue rw,relatime - autofs systemd-1 rw,fd=26,pgrp=1,timeout=300,minproto=5,maxproto=5,direct
-37 15 0:14 / /proc/bus/usb rw,relatime - usbfs /proc/bus/usb rw
-38 33 0:33 / /dev/hugepages rw,relatime - hugetlbfs hugetlbfs rw
-39 36 0:12 / /dev/mqueue rw,relatime - mqueue mqueue rw
-40 20 8:6 / /boot rw,noatime - ext3 /dev/sda6 rw,errors=continue,barrier=0,data=ordered
-41 20 253:0 / /home/kzak rw,noatime - ext4 /dev/mapper/kzak-home rw,barrier=1,data=ordered
-42 35 0:34 / /proc/sys/fs/binfmt_misc rw,relatime - binfmt_misc none rw
-43 16 0:35 / /sys/fs/fuse/connections rw,relatime - fusectl fusectl rw
-44 41 0:36 / /home/kzak/.gvfs rw,nosuid,nodev,relatime - fuse.gvfs-fuse-daemon gvfs-fuse-daemon rw,user_id=500,group_id=500
-45 20 0:37 / /var/lib/nfs/rpc_pipefs rw,relatime - rpc_pipefs sunrpc rw
-47 20 0:38 / /mnt/sounds rw,relatime - cifs //foo.home/bar/ rw,unc=\\foo.home\bar,username=kzak,domain=SRGROUP,uid=0,noforceuid,gid=0,noforcegid,addr=192.168.111.1,posixpaths,serverino,acl,rsize=16384,wsize=57344
-49 20 0:56 / /mnt/test/foobar rw,relatime,nosymfollow shared:323 - tmpfs tmpfs rw`, []*sandbox.MountinfoEntry{
-			e(15, 20, "/", "/proc", "rw,relatime", "proc", "/proc", "rw"),
-			e(16, 20, "/", "/sys", "rw,relatime", "sysfs", "/sys", "rw"),
-			e(17, 20, "/", "/dev", "rw,relatime", "devtmpfs", "udev", "rw,size=1983516k,nr_inodes=495879,mode=755"),
-			e(18, 17, "/", "/dev/pts", "rw,relatime", "devpts", "devpts", "rw,gid=5,mode=620,ptmxmode=000"),
-			e(19, 17, "/", "/dev/shm", "rw,relatime", "tmpfs", "tmpfs", "rw"),
-			e(20, 1, "/", "/", "rw,noatime", "ext3", "/dev/sda4", "rw,errors=continue,user_xattr,acl,barrier=0,data=ordered"),
-			e(21, 16, "/", "/sys/fs/cgroup", "rw,nosuid,nodev,noexec,relatime", "tmpfs", "tmpfs", "rw,mode=755"),
-			e(22, 21, "/", "/sys/fs/cgroup/systemd", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,release_agent=/lib/systemd/systemd-cgroups-agent,name=systemd"),
-			e(23, 21, "/", "/sys/fs/cgroup/cpuset", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,cpuset"),
-			e(24, 21, "/", "/sys/fs/cgroup/ns", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,ns"),
-			e(25, 21, "/", "/sys/fs/cgroup/cpu", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,cpu"),
-			e(26, 21, "/", "/sys/fs/cgroup/cpuacct", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,cpuacct"),
-			e(27, 21, "/", "/sys/fs/cgroup/memory", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,memory"),
-			e(28, 21, "/", "/sys/fs/cgroup/devices", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,devices"),
-			e(29, 21, "/", "/sys/fs/cgroup/freezer", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,freezer"),
-			e(30, 21, "/", "/sys/fs/cgroup/net_cls", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,net_cls"),
-			e(31, 21, "/", "/sys/fs/cgroup/blkio", "rw,nosuid,nodev,noexec,relatime", "cgroup", "cgroup", "rw,blkio"),
-			e(32, 16, "/", "/sys/kernel/security", "rw,relatime", "autofs", "systemd-1", "rw,fd=22,pgrp=1,timeout=300,minproto=5,maxproto=5,direct"),
-			e(33, 17, "/", "/dev/hugepages", "rw,relatime", "autofs", "systemd-1", "rw,fd=23,pgrp=1,timeout=300,minproto=5,maxproto=5,direct"),
-			e(34, 16, "/", "/sys/kernel/debug", "rw,relatime", "autofs", "systemd-1", "rw,fd=24,pgrp=1,timeout=300,minproto=5,maxproto=5,direct"),
-			e(35, 15, "/", "/proc/sys/fs/binfmt_misc", "rw,relatime", "autofs", "systemd-1", "rw,fd=25,pgrp=1,timeout=300,minproto=5,maxproto=5,direct"),
-			e(36, 17, "/", "/dev/mqueue", "rw,relatime", "autofs", "systemd-1", "rw,fd=26,pgrp=1,timeout=300,minproto=5,maxproto=5,direct"),
-			e(37, 15, "/", "/proc/bus/usb", "rw,relatime", "usbfs", "/proc/bus/usb", "rw"),
-			e(38, 33, "/", "/dev/hugepages", "rw,relatime", "hugetlbfs", "hugetlbfs", "rw"),
-			e(39, 36, "/", "/dev/mqueue", "rw,relatime", "mqueue", "mqueue", "rw"),
-			e(40, 20, "/", "/boot", "rw,noatime", "ext3", "/dev/sda6", "rw,errors=continue,barrier=0,data=ordered"),
-			e(41, 20, "/", "/home/kzak", "rw,noatime", "ext4", "/dev/mapper/kzak-home", "rw,barrier=1,data=ordered"),
-			e(42, 35, "/", "/proc/sys/fs/binfmt_misc", "rw,relatime", "binfmt_misc", "none", "rw"),
-			e(43, 16, "/", "/sys/fs/fuse/connections", "rw,relatime", "fusectl", "fusectl", "rw"),
-			e(44, 41, "/", "/home/kzak/.gvfs", "rw,nosuid,nodev,relatime", "fuse.gvfs-fuse-daemon", "gvfs-fuse-daemon", "rw,user_id=500,group_id=500"),
-			e(45, 20, "/", "/var/lib/nfs/rpc_pipefs", "rw,relatime", "rpc_pipefs", "sunrpc", "rw"),
-			e(47, 20, "/", "/mnt/sounds", "rw,relatime", "cifs", "//foo.home/bar/", "rw,unc=\\\\foo.home\\bar,username=kzak,domain=SRGROUP,uid=0,noforceuid,gid=0,noforcegid,addr=192.168.111.1,posixpaths,serverino,acl,rsize=16384,wsize=57344"),
-			e(49, 20, "/", "/mnt/test/foobar", "rw,relatime,nosymfollow", "tmpfs", "tmpfs", "rw"),
-		}},
-	}
-
-	for _, tc := range testCases {
-		name := filepath.Join(t.TempDir(), "sample")
-		if err := os.WriteFile(name, []byte(tc.sample), 0400); err != nil {
-			t.Fatalf("cannot write sample: %v", err)
-		}
-
-		t.Run(tc.name, func(t *testing.T) {
-			m := sandbox.NewMountinfo(name)
-			if err := m.Parse(); err != nil {
-				t.Fatalf("Parse: error = %v", err)
-			}
-
-			i := 0
-			for ent := range m.Entries() {
-				if i == len(tc.want) {
-					t.Errorf("Entries: got more than %d entries", i)
-					t.FailNow()
-				}
-				if !ent.EqualWithIgnore(tc.want[i], "\x00") {
-					t.Errorf("Entries: entry %d\n got: %#v\nwant: %#v", i,
-						ent, &tc.want[i])
-					t.FailNow()
-				} else {
-					t.Logf("%s", ent)
-				}
-
-				i++
-			}
-
-			if err := m.Err(); err != nil {
-				t.Fatalf("Mountinfo: error = %v", err)
-			}
-
-			m.Unref()
-		})
-
-		if err := os.Remove(name); err != nil {
-			t.Fatalf("cannot remove %q: %v", name, err)
-		}
-	}
-}
-
-func e(
-	id, parent int, root, target, vfsOptstr string, fsType, source, fsOptstr string,
-) *sandbox.MountinfoEntry {
-	return &sandbox.MountinfoEntry{
-		ID:        id,
-		Parent:    parent,
-		Root:      root,
-		Target:    target,
-		VfsOptstr: vfsOptstr,
-		FsType:    fsType,
-		Source:    source,
-		FsOptstr:  fsOptstr,
-	}
-}