seccomp_test.go

// Copyright 2018 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package seccomp

import (
	"bytes"
	_ "embed"
	"fmt"
	"io"
	"io/ioutil"
	"math"
	"math/rand"
	"os"
	"os/exec"
	"reflect"
	"strings"
	"testing"
	"time"

	"golang.org/x/sys/unix"
	"gvisor.dev/gvisor/pkg/abi/linux"
	"gvisor.dev/gvisor/pkg/bpf"
)

//go:embed victim
var victimData []byte

// newVictim makes a victim binary.
func newVictim() (string, error) {
	f, err := ioutil.TempFile("", "victim")
	if err != nil {
		return "", err
	}
	defer f.Close()
	path := f.Name()
	if _, err := io.Copy(f, bytes.NewBuffer(victimData)); err != nil {
		os.Remove(path)
		return "", err
	}
	if err := os.Chmod(path, 0755); err != nil {
		os.Remove(path)
		return "", err
	}
	return path, nil
}

func TestBasic(t *testing.T) {
	buf := make([]byte, (&linux.SeccompData{}).SizeBytes())

	type spec struct {
		// desc is the test's description.
		desc string

		// data is the input data.
		data linux.SeccompData

		// want is the expected return value of the BPF program.
		want linux.BPFAction
	}

	for _, test := range []struct {
		name      string
		ruleSets  []RuleSet
		wantPanic bool
		options   ProgramOptions
		specs     []spec
	}{
		{
			name: "Single syscall",
			ruleSets: []RuleSet{
				{
					Rules:  MakeSyscallRules(map[uintptr]SyscallRule{1: MatchAll{}}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "syscall allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "syscall disallowed",
					data: linux.SeccompData{Nr: 2, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "Multiple rulesets",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							EqualTo(0x1),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: MatchAll{},
						2: MatchAll{},
					}),
					Action: linux.SECCOMP_RET_TRAP,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_KILL_THREAD,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "allowed (1a)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x1}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "allowed (1b)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "syscall 1 matched 2nd rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "no match",
					data: linux.SeccompData{Nr: 0, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_KILL_THREAD,
				},
			},
		},
		{
			name: "Multiple syscalls",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: MatchAll{},
						3: MatchAll{},
						5: MatchAll{},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "allowed (1)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "allowed (3)",
					data: linux.SeccompData{Nr: 3, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "allowed (5)",
					data: linux.SeccompData{Nr: 5, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "disallowed (0)",
					data: linux.SeccompData{Nr: 0, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "disallowed (2)",
					data: linux.SeccompData{Nr: 2, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "disallowed (4)",
					data: linux.SeccompData{Nr: 4, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "disallowed (6)",
					data: linux.SeccompData{Nr: 6, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "disallowed (100)",
					data: linux.SeccompData{Nr: 100, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "Wrong architecture",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: MatchAll{},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arch (123)",
					data: linux.SeccompData{Nr: 1, Arch: 123},
					want: linux.SECCOMP_RET_KILL_THREAD,
				},
			},
		},
		{
			name: "Syscall disallowed",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: MatchAll{},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "action trap",
					data: linux.SeccompData{Nr: 2, Arch: LINUX_AUDIT_ARCH},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "Syscall arguments",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							AnyValue{},
							EqualTo(0xf),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf, 0xf}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "disallowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf, 0xe}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "Multiple arguments",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: Or{
							PerArg{
								EqualTo(0xf),
							},
							PerArg{
								EqualTo(0xe),
							},
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "match first rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "match 2nd rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xe}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "match neither rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xd}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "empty Or is invalid",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: Or{},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			wantPanic: true,
		},
		{
			name: "And of multiple rules",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: And{
							PerArg{
								NotEqual(0xf),
							},
							PerArg{
								NotEqual(0xe),
							},
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "hit first rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "hit 2nd rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xe}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "hit neither rule",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xd}},
					want: linux.SECCOMP_RET_ALLOW,
				},
			},
		},
		{
			name: "empty And is invalid",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: And{},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			wantPanic: true,
		},
		{
			name: "EqualTo",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							EqualTo(0),
							EqualTo(math.MaxUint64 - 1),
							EqualTo(math.MaxUint32),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "argument allowed (all match)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0, math.MaxUint64 - 1, math.MaxUint32},
					},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "argument disallowed (one mismatch)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0, math.MaxUint64, math.MaxUint32},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "argument disallowed (multiple mismatch)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0, math.MaxUint64, math.MaxUint32 - 1},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "NotEqual",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							NotEqual(0x7aabbccdd),
							NotEqual(math.MaxUint64 - 1),
							NotEqual(math.MaxUint32),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0, math.MaxUint64, math.MaxUint32 - 1},
					},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (one equal)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0x7aabbccdd, math.MaxUint64, math.MaxUint32 - 1},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (all equal)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						Args: [6]uint64{0x7aabbccdd, math.MaxUint64 - 1, math.MaxUint32},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "GreaterThan",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							// 4294967298
							// Both upper 32 bits and lower 32 bits are non-zero.
							// 00000000000000000000000000000010
							// 00000000000000000000000000000010
							GreaterThan(0x00000002_00000002),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "high 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000003_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000003}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits equal",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000002}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000001}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000001_00000003}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "GreaterThan (multi)",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							GreaterThan(0xf),
							GreaterThan(0xabcd000d),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xffffffff}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (first arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (first arg smaller)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (second arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xabcd000d}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (second arg smaller)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xa000ffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "GreaterThanOrEqual",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							// 4294967298
							// Both upper 32 bits and lower 32 bits are non-zero.
							// 00000000000000000000000000000010
							// 00000000000000000000000000000010
							GreaterThanOrEqual(0x00000002_00000002),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "high 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000003_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000003}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits equal",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000001}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000001_00000002}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "GreaterThanOrEqual (multi)",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							GreaterThanOrEqual(0xf),
							GreaterThanOrEqual(0xabcd000d),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed (both greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xffffffff}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg allowed (first arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xf, 0xffffffff}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (first arg smaller)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg allowed (second arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xabcd000d}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (second arg smaller)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x10, 0xa000ffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (both arg smaller)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xa000ffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "LessThan",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							// 4294967298
							// Both upper 32 bits and lower 32 bits are non-zero.
							// 00000000000000000000000000000010
							// 00000000000000000000000000000010
							LessThan(0x00000002_00000002),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "high 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000003_00000002}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000003}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits equal",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000002}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000001}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000001_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
			},
		},
		{
			name: "LessThan (multi)",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							LessThan(0x1),
							LessThan(0xabcd000d),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0x0}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (first arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x1, 0x0}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (first arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x2, 0x0}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (second arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xabcd000d}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (second arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (both arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x2, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "LessThanOrEqual",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							// 4294967298
							// Both upper 32 bits and lower 32 bits are non-zero.
							// 00000000000000000000000000000010
							// 00000000000000000000000000000010
							LessThanOrEqual(0x00000002_00000002),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "high 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000003_00000002}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits greater",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000003}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "high 32bits equal, low 32bits equal",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits equal, low 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000002_00000001}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "high 32bits less",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x00000001_00000002}},
					want: linux.SECCOMP_RET_ALLOW,
				},
			},
		},

		{
			name: "LessThanOrEqual (multi)",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							LessThanOrEqual(0x1),
							LessThanOrEqual(0xabcd000d),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0x0}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg allowed (first arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x1, 0x0}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (first arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x2, 0x0}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg allowed (second arg equal)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xabcd000d}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (second arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (both arg greater)",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x2, 0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "MaskedEqual",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							// x & 00000001 00000011 (0x103) == 00000000 00000001 (0x1)
							// Input x must have lowest order bit set and
							// must *not* have 8th or second lowest order bit set.
							MaskedEqual(0x103, 0x1),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "arg allowed (low order mandatory bit)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						// 00000000 00000000 00000000 00000001
						Args: [6]uint64{0x1},
					},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg allowed (low order optional bit)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						// 00000000 00000000 00000000 00000101
						Args: [6]uint64{0x5},
					},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "arg disallowed (lowest order bit not set)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						// 00000000 00000000 00000000 00000010
						Args: [6]uint64{0x2},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (second lowest order bit set)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						// 00000000 00000000 00000000 00000011
						Args: [6]uint64{0x3},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "arg disallowed (8th bit set)",
					data: linux.SeccompData{
						Nr:   1,
						Arch: LINUX_AUDIT_ARCH,
						// 00000000 00000000 00000001 00000000
						Args: [6]uint64{0x100},
					},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "NonNegativeFD",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							NonNegativeFD{},
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "zero allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "one allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x0}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "seven allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x7}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "largest int32 allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x7fffffff}},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "negative 1 not allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x80000000}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "largest uint32 not allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "a positive int64 larger than max uint32 is not allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x100000000}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "largest int64 not allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0x7fffffffffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
				{
					desc: "largest uint64 not allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{0xffffffffffffffff}},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
		{
			name: "Instruction Pointer",
			ruleSets: []RuleSet{
				{
					Rules: MakeSyscallRules(map[uintptr]SyscallRule{
						1: PerArg{
							RuleIP: EqualTo(0x7aabbccdd),
						},
					}),
					Action: linux.SECCOMP_RET_ALLOW,
				},
			},
			options: ProgramOptions{
				DefaultAction: linux.SECCOMP_RET_TRAP,
				BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
			},
			specs: []spec{
				{
					desc: "allowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{}, InstructionPointer: 0x7aabbccdd},
					want: linux.SECCOMP_RET_ALLOW,
				},
				{
					desc: "disallowed",
					data: linux.SeccompData{Nr: 1, Arch: LINUX_AUDIT_ARCH, Args: [6]uint64{}, InstructionPointer: 0x711223344},
					want: linux.SECCOMP_RET_TRAP,
				},
			},
		},
	} {
		t.Run(test.name, func(t *testing.T) {
			var instrs []bpf.Instruction
			var panicErr any
			func() {
				t.Helper()
				defer func() {
					panicErr = recover()
					t.Helper()
				}()
				var err error
				instrs, _, err = BuildProgram(test.ruleSets, test.options)
				if err != nil {
					t.Fatalf("BuildProgram() got error: %v", err)
				}
			}()
			if test.wantPanic {
				if panicErr == nil {
					t.Fatal("BuildProgram did not panick")
				}
				return
			}
			if panicErr != nil {
				t.Fatalf("BuildProgram unexpectedly panicked: %v", panicErr)
			}
			p, err := bpf.Compile(instrs, true /* optimize */)
			if err != nil {
				t.Fatalf("bpf.Compile got error: %v", err)
			}
			for _, spec := range test.specs {
				got, err := bpf.Exec[bpf.NativeEndian](p, DataAsBPFInput(&spec.data, buf))
				if err != nil {
					t.Fatalf("%s: bpf.Exec got error: %v", spec.desc, err)
				}
				if got != uint32(spec.want) {
					// Include a decoded version of the program in output for debugging purposes.
					decoded, _ := bpf.DecodeInstructions(instrs)
					t.Fatalf("%s: got: %d, want: %d\nBPF Program\n%s", spec.desc, got, spec.want, decoded)
				}
			}
		})
	}
}

// TestRandom tests that randomly generated rules are encoded correctly.
func TestRandom(t *testing.T) {
	rand.Seed(time.Now().UnixNano())
	size := rand.Intn(50) + 1
	syscallRules := NewSyscallRules()
	for syscallRules.Size() < size {
		n := uintptr(rand.Intn(200))
		if !syscallRules.Has(n) {
			syscallRules.Set(n, MatchAll{})
		}
	}

	t.Logf("Testing filters: %v", syscallRules)
	instrs, _, err := BuildProgram([]RuleSet{
		{
			Rules:  syscallRules,
			Action: linux.SECCOMP_RET_ALLOW,
		},
	}, ProgramOptions{
		DefaultAction: linux.SECCOMP_RET_TRAP,
		BadArchAction: linux.SECCOMP_RET_KILL_THREAD,
	})
	if err != nil {
		t.Fatalf("buildProgram() got error: %v", err)
	}
	p, err := bpf.Compile(instrs, true /* optimize */)
	if err != nil {
		t.Fatalf("bpf.Compile got error: %v", err)
	}
	buf := make([]byte, (&linux.SeccompData{}).SizeBytes())
	for i := uint32(0); i < 200; i++ {
		data := linux.SeccompData{Nr: int32(i), Arch: LINUX_AUDIT_ARCH}
		got, err := bpf.Exec[bpf.NativeEndian](p, DataAsBPFInput(&data, buf))
		if err != nil {
			t.Errorf("bpf.Exec got error: %v, for syscall %d", err, i)
			continue
		}
		want := linux.SECCOMP_RET_TRAP
		if syscallRules.Has(uintptr(i)) {
			want = linux.SECCOMP_RET_ALLOW
		}
		if got != uint32(want) {
			t.Errorf("bpf.Exec = %d, want: %d, for syscall %d", got, want, i)
		}
	}
}

// TestReadDeal checks that a process dies when it trips over the filter and
// that it doesn't die when the filter is not triggered.
func TestRealDeal(t *testing.T) {
	for _, test := range []struct {
		name string
		die  bool
		want string
	}{
		{name: "bad syscall", die: true, want: "bad system call"},
		{name: "allowed syscall", die: false, want: "Syscall was allowed!!!"},
	} {
		t.Run(test.name, func(t *testing.T) {
			victim, err := newVictim()
			if err != nil {
				t.Fatalf("unable to get victim: %v", err)
			}
			defer func() {
				if err := os.Remove(victim); err != nil {
					t.Fatalf("Unable to remove victim: %v", err)
				}
			}()

			dieFlag := fmt.Sprintf("-die=%v", test.die)
			cmd := exec.Command(victim, dieFlag)
			out, err := cmd.CombinedOutput()
			if test.die {
				if err == nil {
					t.Fatalf("Victim was not killed as expected, output: %s", out)
				}
				// Depending on kernel version, either RET_TRAP or RET_KILL_PROCESS is
				// used. RET_TRAP dumps reason for exit in output, while RET_KILL_PROCESS
				// returns SIGSYS as exit status.
				if !strings.Contains(string(out), test.want) &&
					!strings.Contains(err.Error(), test.want) {
					t.Fatalf("Victim error is wrong, got: %v, err: %v, want: %v", string(out), err, test.want)
				}
				return
			}
			// test.die is false
			if err != nil {
				t.Logf("out: %s", string(out))
				t.Fatalf("Victim failed to execute, err: %v", err)
			}
			if !strings.Contains(string(out), test.want) {
				t.Fatalf("Victim output is wrong, got: %v, want: %v", string(out), test.want)
			}
		})
	}
}

// TestMerge ensures that empty rules are not erased when rules are merged.
func TestMerge(t *testing.T) {
	for _, tst := range []struct {
		name  string
		main  SyscallRule
		merge SyscallRule
		want  SyscallRule
	}{
		{
			name:  "MatchAll both",
			main:  MatchAll{},
			merge: MatchAll{},
			want:  Or{MatchAll{}, MatchAll{}},
		},
		{
			name:  "MatchAll and Or",
			main:  MatchAll{},
			merge: Or{PerArg{EqualTo(0)}},
			want:  Or{MatchAll{}, Or{PerArg{EqualTo(0)}}},
		},
		{
			name:  "Or and MatchAll",
			main:  Or{PerArg{EqualTo(0)}},
			merge: MatchAll{},
			want:  Or{Or{PerArg{EqualTo(0)}}, MatchAll{}},
		},
		{
			name:  "2 Ors",
			main:  Or{PerArg{EqualTo(0)}},
			merge: Or{PerArg{EqualTo(1)}},
			want:  Or{Or{PerArg{EqualTo(0)}}, Or{PerArg{EqualTo(1)}}},
		},
	} {
		t.Run(tst.name, func(t *testing.T) {
			mainRules := MakeSyscallRules(map[uintptr]SyscallRule{
				1: tst.main,
			}).Merge(MakeSyscallRules(map[uintptr]SyscallRule{
				1: tst.merge,
			}))
			wantRules := MakeSyscallRules(map[uintptr]SyscallRule{1: tst.want})
			if !reflect.DeepEqual(mainRules, wantRules) {
				t.Errorf("got rules:\n%v\nwant rules:\n%v\n", mainRules, wantRules)
			}
		})
	}
}

// TestOptimizeSyscallRule tests the behavior of syscall rule optimizers.
func TestOptimizeSyscallRule(t *testing.T) {
	// av is a shorthand for `AnyValue{}`, used below to keep `PerArg`
	// structs short enough to comfortably fit on one line.
	av := AnyValue{}

	// Some useful constants that are larger than uint32.
	const (
		a1 = 0xA1A1A1A1A1A1A1A1
		a2 = 0xA2A2A2A2A2A2A2A2
		b1 = 0xB1B1B1B1B1B1B1B1
		b2 = 0xB2B2B2B2B2B2B2B2
		b3 = 0xB3B3B3B3B3B3B3B3
		c1 = 0xC1C1C1C1C1C1C1C1
		c2 = 0xC2C2C2C2C2C2C2C2
		c3 = 0xC3C3C3C3C3C3C3C3
		d0 = 0xD0D0D0D0D0D0D0D0
		d1 = 0xD1D1D1D1D1D1D1D1
	)

	// split replaces a `splittableValueMatcher` rule with its `splitMatcher`
	// version.
	s := func(matcher splittableValueMatcher) ValueMatcher {
		return matcher.split()
	}

	highEq := func(val uintptr) splitMatcher {
		return high32BitsMatch(halfEqualTo(val))
	}
	lowEq := func(val uintptr) splitMatcher {
		return low32BitsMatch(halfEqualTo(val))
	}

	for _, test := range []struct {
		name       string
		rule       SyscallRule
		optimizers []ruleOptimizerFunc
		want       SyscallRule
	}{
		{
			name: "do nothing to a simple rule",
			rule: PerArg{NotEqual(0xff), av, av, av, av, av, av},
			want: PerArg{NotEqual(0xff), av, av, av, av, av, av},
		},
		{
			name: "flatten Or rule",
			rule: Or{
				Or{
					PerArg{EqualTo(a1)},
					Or{
						PerArg{EqualTo(b1)},
						PerArg{EqualTo(b2)},
					},
					PerArg{EqualTo(c1)},
				},
				Or{
					PerArg{EqualTo(d0)},
					PerArg{EqualTo(d1)},
				},
			},
			want: Or{
				PerArg{s(EqualTo(a1)), av, av, av, av, av, av},
				PerArg{s(EqualTo(b1)), av, av, av, av, av, av},
				PerArg{s(EqualTo(b2)), av, av, av, av, av, av},
				PerArg{s(EqualTo(c1)), av, av, av, av, av, av},
				PerArg{s(EqualTo(d0)), av, av, av, av, av, av},
				PerArg{s(EqualTo(d1)), av, av, av, av, av, av},
			},
		},
		{
			name: "flatten And rule",
			rule: And{
				And{
					PerArg{NotEqual(0x11)},
					And{
						PerArg{NotEqual(0x22)},
						PerArg{NotEqual(0x33)},
					},
					PerArg{NotEqual(0x44)},
				},
				And{
					PerArg{NotEqual(0x55)},
					PerArg{NotEqual(0x66)},
				},
			},
			want: And{
				PerArg{NotEqual(0x11), av, av, av, av, av, av},
				PerArg{NotEqual(0x22), av, av, av, av, av, av},
				PerArg{NotEqual(0x33), av, av, av, av, av, av},
				PerArg{NotEqual(0x44), av, av, av, av, av, av},
				PerArg{NotEqual(0x55), av, av, av, av, av, av},
				PerArg{NotEqual(0x66), av, av, av, av, av, av},
			},
		},
		{
			name: "simplify Or with single rule",
			rule: Or{
				PerArg{EqualTo(0x11)},
			},
			want: PerArg{s(EqualTo(0x11)), av, av, av, av, av, av},
		},
		{
			name: "simplify And with single rule",
			rule: And{
				PerArg{EqualTo(0x11)},
			},
			want: PerArg{s(EqualTo(0x11)), av, av, av, av, av, av},
		},
		{
			name: "simplify Or with MatchAll",
			rule: Or{
				PerArg{EqualTo(0x11)},
				Or{
					MatchAll{},
				},
				PerArg{EqualTo(0x22)},
			},
			want: MatchAll{},
		},
		{
			name: "single MatchAll in Or is not an empty rule",
			rule: Or{
				MatchAll{},
				MatchAll{},
			},
			optimizers: []ruleOptimizerFunc{
				convertMatchAllOrXToMatchAll,
			},
			want: MatchAll{},
		},
		{
			name: "simplify And with MatchAll",
			rule: And{
				PerArg{NotEqual(0x11)},
				And{
					MatchAll{},
				},
				PerArg{NotEqual(0x22)},
			},
			want: And{
				PerArg{NotEqual(0x11), av, av, av, av, av, av},
				PerArg{NotEqual(0x22), av, av, av, av, av, av},
			},
		},
		{
			name: "single MatchAll in And is not optimized to an empty rule",
			rule: And{
				MatchAll{},
				MatchAll{},
			},
			optimizers: []ruleOptimizerFunc{
				convertMatchAllAndXToX,
			},
			want: MatchAll{},
		},
		{
			name: "PerArg nil to AnyValue",
			rule: PerArg{av, EqualTo(0)},
			optimizers: []ruleOptimizerFunc{
				nilInPerArgToAnyValue,
			},
			want: PerArg{av, EqualTo(0), av, av, av, av, av},
		},
		{
			name: "Useless PerArg is MatchAll",
			rule: PerArg{av, av},
			optimizers: []ruleOptimizerFunc{
				nilInPerArgToAnyValue,
				convertUselessPerArgToMatchAll,
			},
			want: MatchAll{},
		},
		{
			name: "halfValueMatchers are simplified",
			rule: PerArg{
				EqualTo(0),
				splitMatcher{
					highMatcher: halfNotSet(0),
					lowMatcher: halfMaskedEqual{
						mask:  0,
						value: 0x89abcdef,
					},
				},
				splitMatcher{
					highMatcher: halfNotSet(1 << 4),
					lowMatcher: halfMaskedEqual{
						mask:  0xffffffff,
						value: 0x89abcdef,
					},
				},
				splitMatcher{
					highMatcher: halfNotSet(0),
					lowMatcher: halfMaskedEqual{
						mask:  0xffffffff,
						value: 0x89abcdef,
					},
				},
				splitMatcher{
					highMatcher: halfNotSet(0),
					lowMatcher: halfMaskedEqual{
						mask:  0,
						value: 0,
					},
				},
				splitMatcher{
					highMatcher: halfAnyValue{},
					lowMatcher: halfMaskedEqual{
						mask:  0x89abcdef,
						value: 0x89abcdef,
					},
				},
				BitsAllowlist(0xabcdef),
			},
			want: PerArg{
				s(EqualTo(0)),
				splitMatcher{
					highMatcher: halfAnyValue{},
					lowMatcher: halfMaskedEqual{
						mask:  0,
						value: 0x89abcdef,
					},
				},
				splitMatcher{
					highMatcher: halfNotSet(1 << 4),
					lowMatcher:  halfEqualTo(0x89abcdef),
				},
				splitMatcher{
					highMatcher: halfAnyValue{},
					lowMatcher:  halfEqualTo(0x89abcdef),
				},
				av, // Both halves are simplified to `halfAnyValue`.
				splitMatcher{
					highMatcher: halfAnyValue{},
					lowMatcher: halfMaskedEqual{
						mask:  0x89abcdef,
						value: 0x89abcdef,
					},
				},
				splitMatcher{
					// High half gets simplified to equaling zero.
					highMatcher: halfEqualTo(0),
					// Low half gets simplified to a bit-not-set check.
					lowMatcher: halfNotSet(^uint32(0xabcdef)),
					// Keep user-friendly representation.
					repr: fmt.Sprintf("& %#x == %#x", ^uint64(0xabcdef), 0),
				},
			},
		},
		{
			name: "Common value matchers in PerArg are extracted",
			rule: Or{
				PerArg{EqualTo(a1), EqualTo(b1), EqualTo(c1), EqualTo(d0)},
				PerArg{EqualTo(a2), EqualTo(b1), EqualTo(c1), EqualTo(d0)},
				PerArg{EqualTo(a1), EqualTo(b2), EqualTo(c2), EqualTo(d0)},
				PerArg{EqualTo(a2), EqualTo(b2), EqualTo(c2), EqualTo(d0)},
				PerArg{EqualTo(a1), EqualTo(b3), EqualTo(c3), EqualTo(d0)},
				PerArg{EqualTo(a2), EqualTo(b3), EqualTo(c3), EqualTo(d0)},
			},
			want: And{
				Or{
					PerArg{s(EqualTo(a1)), av, av, av, av, av, av},
					PerArg{s(EqualTo(a2)), av, av, av, av, av, av},
				},
				PerArg{av, av, av, s(EqualTo(d0)), av, av, av},
				Or{
					PerArg{av, s(EqualTo(b1)), s(EqualTo(c1)), av, av, av, av},
					PerArg{av, s(EqualTo(b2)), s(EqualTo(c2)), av, av, av, av},
					PerArg{av, s(EqualTo(b3)), s(EqualTo(c3)), av, av, av, av},
				},
			},
		},
		{
			name: "Common halfValueMatchers in splitMatchers are extracted",
			rule: Or{
				PerArg{EqualTo(0xA1), EqualTo(0xB1), EqualTo(c1), EqualTo(d0)},
				PerArg{EqualTo(0xA1), EqualTo(0xB1), EqualTo(c2), EqualTo(d0)},
				PerArg{EqualTo(0xA2), EqualTo(0xB2), EqualTo(c1), EqualTo(d0)},
				PerArg{EqualTo(0xA2), EqualTo(0xB2), EqualTo(c2), EqualTo(d0)},
			},
			want: And{
				PerArg{highEq(0), av, av, av, av, av, av},
				PerArg{av, highEq(0), av, av, av, av, av},
				Or{
					PerArg{av, av, s(EqualTo(c1)), av, av, av, av},
					PerArg{av, av, s(EqualTo(c2)), av, av, av, av},
				},
				PerArg{av, av, av, s(EqualTo(d0)), av, av, av},
				Or{
					PerArg{lowEq(0xA1), lowEq(0xB1), av, av, av, av, av},
					PerArg{lowEq(0xA2), lowEq(0xB2), av, av, av, av, av},
				},
			},
		},
	} {
		t.Run(test.name, func(t *testing.T) {
			var got SyscallRule
			if len(test.optimizers) == 0 {
				got = optimizeSyscallRule(test.rule)
			} else {
				got = (&optimizationRun{funcs: test.optimizers}).optimize(test.rule)
			}
			if !reflect.DeepEqual(got, test.want) {
				t.Errorf("got rule:\n%v\nwant rule:\n%v\n", got, test.want)
			}
		})
	}
}

func TestOrderRuleSets(t *testing.T) {
	for _, test := range []struct {
		name     string
		ruleSets []RuleSet
		options  ProgramOptions // Optimizations are always enabled regardless of this
		want     orderedRuleSets
		wantErr  bool
	}{
		{
			name:    "no RuleSets",
			options: DefaultProgramOptions(),
			want:    orderedRuleSets{},
		},
		{
			name:    "inconsistent vsyscall",
			options: DefaultProgramOptions(),
			ruleSets: []RuleSet{
				{
					Rules:    NewSyscallRules().Add(unix.SYS_READ, MatchAll{}),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
				{
					Rules:    NewSyscallRules().Add(unix.SYS_READ, MatchAll{}),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: true,
				},
			},
			wantErr: true,
		},
		{
			name: "single trivial rule",
			ruleSets: []RuleSet{
				{
					Rules:    NewSyscallRules().Add(unix.SYS_READ, MatchAll{}),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
			},
			options: DefaultProgramOptions(),
			want: orderedRuleSets{
				trivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
				},
			},
		},
		{
			name: "hot single trivial rule still ends up as trivial",
			ruleSets: []RuleSet{
				{
					Rules:    NewSyscallRules().Add(unix.SYS_READ, MatchAll{}),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{unix.SYS_READ},
			},
			want: orderedRuleSets{
				trivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
				},
			},
		},
		{
			name: "hot single non-trivial rule",
			ruleSets: []RuleSet{
				{
					Rules: NewSyscallRules().Add(
						unix.SYS_READ, PerArg{EqualTo(0)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{unix.SYS_READ},
			},
			want: orderedRuleSets{
				hotNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(0)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
				},
				hotNonTrivialOrder: []uintptr{unix.SYS_READ},
			},
		},
		{
			name: "hot rule ordering",
			ruleSets: []RuleSet{
				{
					Rules: NewSyscallRules().Add(
						unix.SYS_FLOCK, PerArg{EqualTo(0)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
				{
					Rules: NewSyscallRules().Add(
						unix.SYS_WRITE, PerArg{EqualTo(1)},
					).Add(
						unix.SYS_READ, PerArg{EqualTo(2)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{
					unix.SYS_READ,
					unix.SYS_WRITE,
					unix.SYS_FLOCK,
				},
			},
			want: orderedRuleSets{
				hotNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(2)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
					unix.SYS_WRITE: {
						sysno: unix.SYS_WRITE,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(1)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
					unix.SYS_FLOCK: {
						sysno: unix.SYS_FLOCK,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(0)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
				},
				hotNonTrivialOrder: []uintptr{
					unix.SYS_READ,
					unix.SYS_WRITE,
					unix.SYS_FLOCK,
				},
			},
		},
		{
			name: "cold single non-trivial non-vsyscall rule",
			ruleSets: []RuleSet{
				{
					Rules: NewSyscallRules().Add(
						unix.SYS_READ, PerArg{EqualTo(0)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{unix.SYS_WRITE},
			},
			want: orderedRuleSets{
				coldNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(0)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
				},
				hotNonTrivialOrder: nil, // Empty
			},
		},
		{
			name: "cold single non-trivial yes-vsyscall rule",
			ruleSets: []RuleSet{
				{
					Rules: NewSyscallRules().Add(
						unix.SYS_READ, PerArg{EqualTo(0)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: true,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{unix.SYS_WRITE},
			},
			want: orderedRuleSets{
				coldNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(0)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: true,
					},
				},
				hotNonTrivialOrder: nil, // Empty
			},
		},
		{
			name: "all rule types at once",
			ruleSets: []RuleSet{
				{
					Rules: NewSyscallRules().Add(
						// Hot, non-vsyscall, trivial
						unix.SYS_READ, MatchAll{},
					).Add(
						// Hot, non-vsyscall, non-trivial
						unix.SYS_WRITE, PerArg{EqualTo(4)},
					).Add(
						// Hot, non-vsyscall, non-trivial
						unix.SYS_FLOCK, PerArg{EqualTo(131)},
					),
					Action:   linux.SECCOMP_RET_TRACE,
					Vsyscall: false,
				},
				{
					Rules: NewSyscallRules().Add(
						// Hot, vsyscall, trivial (after optimizations)
						unix.SYS_FUTEX, PerArg{AnyValue{}},
					).Add(
						// Hot, vsyscall, non-trivial
						unix.SYS_GETPID, PerArg{EqualTo(20)},
					).Add(
						// Cold, vsyscall, trivial (after optimizations)
						unix.SYS_GETTIMEOFDAY, PerArg{AnyValue{}},
					).Add(
						// Cold, vsyscall, non-trivial
						unix.SYS_MINCORE, PerArg{EqualTo(78)},
					),
					Action:   linux.SECCOMP_RET_ERRNO,
					Vsyscall: true,
				},
				{
					Rules: NewSyscallRules().Add(
						// Hot, non-vsyscall, trivial (after optimizations)
						unix.SYS_CLOSE, PerArg{AnyValue{}},
					).Add(
						// Hot, non-vsyscall, non-trivial
						unix.SYS_OPENAT, PerArg{EqualTo(463)},
					).Add(
						// Cold, non-vsyscall, non-trivial
						unix.SYS_LINKAT, PerArg{EqualTo(471)},
					).Add(
						// Cold, non-vsyscall, trivial here but
						// a later RuleSet will make it non-trivial
						// overall.
						unix.SYS_UNLINKAT, MatchAll{},
					).Add(
						// Cold, non-vsyscall, trivial and another
						// later RuleSet will keep it trivial later.
						unix.SYS_CHDIR, MatchAll{},
					),
					Action:   linux.SECCOMP_RET_KILL_THREAD,
					Vsyscall: false,
				},
				{
					Rules: NewSyscallRules().Add(
						// Hot, non-vsyscall, non-trivial
						unix.SYS_OPENAT, PerArg{EqualTo(463463)},
					).Add(
						// Cold, non-vsyscall, non-trivial
						unix.SYS_LINKAT, PerArg{EqualTo(471471)},
					).Add(
						// Cold, non-vsyscall, no longer trivial.
						unix.SYS_UNLINKAT, PerArg{EqualTo(472)},
					).Add(
						// Cold, non-vsyscall, remains trivial.
						unix.SYS_FCHDIR, PerArg{AnyValue{}},
					),
					Action:   linux.SECCOMP_RET_KILL_PROCESS,
					Vsyscall: false,
				},
				{
					Rules: NewSyscallRules().Add(
						// Cold, non-vsyscall, adds to previous rule
						// after optimizations because it has the
						// same action.
						unix.SYS_UNLINKAT, PerArg{EqualTo(472472)},
					),
					Action:   linux.SECCOMP_RET_KILL_PROCESS,
					Vsyscall: false,
				},
				{
					Rules: NewSyscallRules().Add(
						// Cold, non-vsyscall, does not add to
						// previous rule because it has a different
						// action.
						unix.SYS_UNLINKAT, PerArg{EqualTo(472472472)},
					),
					Action:   linux.SECCOMP_RET_TRAP,
					Vsyscall: false,
				},
			},
			options: ProgramOptions{
				HotSyscalls: []uintptr{
					unix.SYS_READ,
					unix.SYS_WRITE,
					unix.SYS_FLOCK,
					unix.SYS_CLOSE,
					unix.SYS_OPENAT,
					unix.SYS_GETPID,
					// Note: not used in any RuleSet, so it should not
					// appear in `want`:
					unix.SYS_GETTID,
				},
			},
			want: orderedRuleSets{
				hotNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_WRITE: {
						sysno: unix.SYS_WRITE,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(4)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
					unix.SYS_FLOCK: {
						sysno: unix.SYS_FLOCK,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(131)},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
					unix.SYS_GETPID: {
						sysno: unix.SYS_GETPID,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(20)},
								action: linux.SECCOMP_RET_ERRNO,
							},
						},
						vsyscall: true,
					},
					unix.SYS_OPENAT: {
						sysno: unix.SYS_OPENAT,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(463)},
								action: linux.SECCOMP_RET_KILL_THREAD,
							},
							{
								rule:   PerArg{EqualTo(463463)},
								action: linux.SECCOMP_RET_KILL_PROCESS,
							},
						},
						vsyscall: false,
					},
				},
				coldNonTrivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_LINKAT: {
						sysno: unix.SYS_LINKAT,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(471)},
								action: linux.SECCOMP_RET_KILL_THREAD,
							},
							{
								rule:   PerArg{EqualTo(471471)},
								action: linux.SECCOMP_RET_KILL_PROCESS,
							},
						},
						vsyscall: false,
					},
					unix.SYS_UNLINKAT: {
						sysno: unix.SYS_UNLINKAT,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_KILL_THREAD,
							},
							{
								rule: Or{
									PerArg{EqualTo(472)},
									PerArg{EqualTo(472472)},
								},
								action: linux.SECCOMP_RET_KILL_PROCESS,
							},
							{
								rule:   PerArg{EqualTo(472472472)},
								action: linux.SECCOMP_RET_TRAP,
							},
						},
						vsyscall: false,
					},
					unix.SYS_MINCORE: {
						sysno: unix.SYS_MINCORE,
						rules: []syscallRuleAction{
							{
								rule:   PerArg{EqualTo(78)},
								action: linux.SECCOMP_RET_ERRNO,
							},
						},
						vsyscall: true,
					},
					unix.SYS_FUTEX: {
						sysno: unix.SYS_FUTEX,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_ERRNO,
							},
						},
						vsyscall: true,
					},
					unix.SYS_GETTIMEOFDAY: {
						sysno: unix.SYS_GETTIMEOFDAY,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_ERRNO,
							},
						},
						vsyscall: true,
					},
				},
				trivial: map[uintptr]singleSyscallRuleSet{
					unix.SYS_READ: {
						sysno: unix.SYS_READ,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_TRACE,
							},
						},
						vsyscall: false,
					},
					unix.SYS_CHDIR: {
						sysno: unix.SYS_CHDIR,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_KILL_THREAD,
							},
						},
						vsyscall: false,
					},
					unix.SYS_CLOSE: {
						sysno: unix.SYS_CLOSE,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_KILL_THREAD,
							},
						},
						vsyscall: false,
					},
					unix.SYS_FCHDIR: {
						sysno: unix.SYS_FCHDIR,
						rules: []syscallRuleAction{
							{
								rule:   MatchAll{},
								action: linux.SECCOMP_RET_KILL_PROCESS,
							},
						},
						vsyscall: false,
					},
				},
				hotNonTrivialOrder: []uintptr{
					// SYS_READ becomes trivial so it does not show up here.
					unix.SYS_WRITE,
					unix.SYS_FLOCK,
					// SYS_CLOSE also becomes trivial.
					unix.SYS_OPENAT,
					unix.SYS_GETPID,
					// SYS_GETTID does not show up in any RuleSet so it
					// also does not show up here.
				},
			},
		},
	} {
		t.Run(test.name, func(t *testing.T) {
			test.options.Optimize = true
			got, _, gotErr := orderRuleSets(test.ruleSets, test.options)
			if (gotErr != nil) != test.wantErr {
				t.Errorf("got error: %v, want error: %v", gotErr, test.wantErr)
			}
			if gotErr != nil || t.Failed() {
				return
			}
			// Replace empty maps with nil for simpler comparison output.
			for _, ors := range []*orderedRuleSets{&got, &test.want} {
				if len(ors.hotNonTrivial) == 0 {
					ors.hotNonTrivial = nil
				}
				if len(ors.hotNonTrivialOrder) == 0 {
					ors.hotNonTrivialOrder = nil
				}
				if len(ors.coldNonTrivial) == 0 {
					ors.coldNonTrivial = nil
				}
				if len(ors.trivial) == 0 {
					ors.trivial = nil
				}
			}
			// Run optimizers on all rules of `test.want`.
			for _, m := range []map[uintptr]singleSyscallRuleSet{
				test.want.hotNonTrivial,
				test.want.coldNonTrivial,
				test.want.trivial,
			} {
				for sysno, ssrs := range m {
					for i, r := range ssrs.rules {
						ssrs.rules[i].rule = optimizeSyscallRule(r.rule)
					}
					m[sysno] = ssrs
				}
			}
			if !reflect.DeepEqual(got, test.want) {
				t.Errorf("got orderedRuleSets:\n%v\nwant orderedRuleSets:\n%v\n", got, test.want)
				t.Error("got:")
				got.log(t.Errorf)
				t.Errorf("want:")
				test.want.log(t.Errorf)
				return
			}
			// Log the orderedRuleSet, if only to make sure the log function
			// actually works and doesn't panic:
			t.Log("orderedRuleSets matched expectations:")
			got.log(t.Logf)

			// Attempt to render the `orderedRuleSets`.
			// We don't check the instructions it generates, but the rendering
			// code checks itself and panics if it fails an assertion.
			program := &syscallProgram{bpf.NewProgramBuilder()}
			if err := got.render(program); err != nil {
				t.Fatalf("got unexpected error while rendering: %v", err)
			}
		})
	}
}