tools/syz-testbuild: add utility for kernel build testing

syz-testbuild tests kernel build/boot on releases as it will be done by pkg/bisect. This allows to ensure that, for example, a change to kernel config won't break build/boot on older releases and consequently won't break bisection process. The binary needs to run under root because it creates images. The kernel checkout given to the tool will be cleaned and used for in-tree builds. Example invocation: sudo syz-testbuild -kernel_src $LINUX_CHECKOUT \ -config dashboard/config/upstream-kasan.config \ -sysctl dashboard/config/upstream.sysctl \ -cmdline dashboard/config/upstream-apparmor.cmdline \ -userspace $WHEEZY_USERSPACE \ -bisect_bin $BISECT_BIN A suitable wheezy userspace can be downloaded from: https://storage.googleapis.com/syzkaller/wheezy.tar.gz A set of binaries required for bisection (older compilers) can be downloaded from: https://storage.googleapis.com/syzkaller/bisect_bin.tar.gz
google · Mar 17, 2019 · 93e723a · 93e723a
1 parent 1f6fc9f
commit 93e723a
Showing 1 changed file with 204 additions and 0 deletions.
diff --git a/tools/syz-testbuild/testbuild.go b/tools/syz-testbuild/testbuild.go
@@ -0,0 +1,204 @@
+// Copyright 2019 syzkaller project authors. All rights reserved.
+// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.
+
+// syz-testbuild tests kernel build/boot on releases as it will be done by pkg/bisect.
+// This allows to ensure that, for example, a change to kernel config won't break
+// build/boot on older releases and consequently won't break bisection process.
+// The binary needs to run under root because it creates images.
+// The kernel checkout given to the tool will be cleaned and used for in-tree builds.
+// Example invocation:
+//
+// sudo syz-testbuild -kernel_src $LINUX_CHECKOUT \
+//	-config dashboard/config/upstream-kasan.config \
+//	-sysctl dashboard/config/upstream.sysctl \
+//	-cmdline dashboard/config/upstream-apparmor.cmdline \
+//	-userspace $WHEEZY_USERSPACE \
+//	-bisect_bin $BISECT_BIN
+//
+// A suitable wheezy userspace can be downloaded from:
+// https://storage.googleapis.com/syzkaller/wheezy.tar.gz
+// A set of binaries required for bisection (older compilers) can be downloaded from:
+// https://storage.googleapis.com/syzkaller/bisect_bin.tar.gz
+package main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+	"path/filepath"
+	"runtime"
+
+	"github.com/google/syzkaller/pkg/build"
+	"github.com/google/syzkaller/pkg/instance"
+	"github.com/google/syzkaller/pkg/mgrconfig"
+	"github.com/google/syzkaller/pkg/osutil"
+	"github.com/google/syzkaller/pkg/vcs"
+)
+
+var (
+	flagOS            = flag.String("os", runtime.GOOS, "OS to test")
+	flagArch          = flag.String("arch", runtime.GOARCH, "arch to test")
+	flagKernelSrc     = flag.String("kernel_src", "", "path to kernel checkout")
+	flagKernelConfig  = flag.String("config", "", "kernel config")
+	flagKernelSysctl  = flag.String("sysctl", "", "kernel sysctl file")
+	flagKernelCmdline = flag.String("cmdline", "", "kernel cmdline file")
+	flagUserspace     = flag.String("userspace", "", "path to userspace for build")
+	flagBisectBin     = flag.String("bisect_bin", "", "path to bisection binaries")
+	flagSyzkaller     = flag.String("syzkaller", ".", "path to built syzkaller")
+	flagSandbox       = flag.String("sandbox", "namespace", "sandbox to use for testing")
+)
+
+const (
+	vmType   = "qemu"
+	numTests = 5
+)
+
+func main() {
+	flag.Parse()
+	if os.Getuid() != 0 {
+		failf("image build will fail, run under root")
+	}
+	os.Setenv("SYZ_DISABLE_SANDBOXING", "yes")
+	dir, err := ioutil.TempDir("", "syz-testbuild")
+	if err != nil {
+		fail(err)
+	}
+	defer os.RemoveAll(dir)
+	cfg := &mgrconfig.Config{
+		Target:       *flagOS + "/" + *flagArch,
+		TargetOS:     *flagOS,
+		TargetArch:   *flagArch,
+		TargetVMArch: *flagArch,
+		HTTP:         ":0",
+		Workdir:      dir,
+		KernelSrc:    *flagKernelSrc,
+		KernelObj:    *flagKernelSrc,
+		Syzkaller:    *flagSyzkaller,
+		Sandbox:      *flagSandbox,
+		SSHUser:      "root",
+		Procs:        1,
+		Cover:        false,
+		Type:         vmType,
+		VM:           json.RawMessage([]byte(fmt.Sprintf(`{ "count": %v, "cpu": 2, "mem": 2048 }`, numTests))),
+	}
+	if err := mgrconfig.Complete(cfg); err != nil {
+		fail(err)
+	}
+	repo, err := vcs.NewRepo(*flagOS, vmType, *flagKernelSrc)
+	if err != nil {
+		fail(err)
+	}
+	bisecter := repo.(vcs.Bisecter)
+	head, err := repo.HeadCommit()
+	if err != nil {
+		fail(err)
+	}
+	log.Printf("HEAD is on %v %v", head.Hash, head.Title)
+	tags, err := bisecter.PreviousReleaseTags(head.Hash)
+	if err != nil {
+		fail(err)
+	}
+	log.Printf("tags: %v", tags)
+	kernelConfig, err := ioutil.ReadFile(*flagKernelConfig)
+	if err != nil {
+		fail(err)
+	}
+	env, err := instance.NewEnv(cfg)
+	if err != nil {
+		fail(err)
+	}
+	test(repo, bisecter, kernelConfig, env, head)
+	for _, tag := range tags {
+		com, err := repo.SwitchCommit(tag)
+		if err != nil {
+			fail(err)
+		}
+		test(repo, bisecter, kernelConfig, env, com)
+	}
+}
+
+func test(repo vcs.Repo, bisecter vcs.Bisecter, kernelConfig []byte, env *instance.Env, com *vcs.Commit) {
+	bisectEnv, err := bisecter.EnvForCommit(com.Hash, kernelConfig)
+	if err != nil {
+		fail(err)
+	}
+	log.Printf("testing: %v %v using %v", com.Hash, com.Title, bisectEnv.Compiler)
+	compiler := filepath.Join(*flagBisectBin, bisectEnv.Compiler, "bin", "gcc")
+	if err := build.Clean(*flagOS, *flagArch, vmType, *flagKernelSrc); err != nil {
+		fail(err)
+	}
+	err = env.BuildKernel(compiler, *flagUserspace, *flagKernelCmdline, *flagKernelSysctl, bisectEnv.KernelConfig)
+	if err != nil {
+		if verr, ok := err.(*osutil.VerboseError); ok {
+			log.Printf("BUILD BROKEN: %v", verr.Title)
+			saveLog(com.Hash, 0, verr.Output)
+		} else {
+			log.Printf("BUILD BROKEN: %v", err)
+		}
+		return
+	}
+	log.Printf("build OK")
+	results, err := env.Test(numTests, nil, nil, nil)
+	if err != nil {
+		fail(err)
+	}
+	var verdicts []string
+	for i, res := range results {
+		if res == nil {
+			verdicts = append(verdicts, "OK")
+			continue
+		}
+		switch err := res.(type) {
+		case *instance.TestError:
+			if err.Boot {
+				verdicts = append(verdicts, fmt.Sprintf("boot failed: %v", err))
+			} else {
+				verdicts = append(verdicts, fmt.Sprintf("basic kernel testing failed: %v", err))
+			}
+			output := err.Output
+			if err.Report != nil {
+				output = err.Report.Output
+			}
+			saveLog(com.Hash, i, output)
+		case *instance.CrashError:
+			verdicts = append(verdicts, fmt.Sprintf("crashed: %v", err))
+			output := err.Report.Report
+			if len(output) == 0 {
+				output = err.Report.Output
+			}
+			saveLog(com.Hash, i, output)
+		default:
+			verdicts = append(verdicts, fmt.Sprintf("failed: %v", err))
+		}
+	}
+	unique := make(map[string]bool)
+	for _, verdict := range verdicts {
+		unique[verdict] = true
+	}
+	if len(unique) == 1 {
+		log.Printf("all runs: %v", verdicts[0])
+	} else {
+		for i, verdict := range verdicts {
+			log.Printf("run #%v: %v", i, verdict)
+		}
+	}
+}
+
+func saveLog(hash string, idx int, data []byte) {
+	if len(data) == 0 {
+		return
+	}
+	osutil.WriteFile(fmt.Sprintf("%v.%v", hash, idx), data)
+}
+
+func fail(err error) {
+	failf("%v", err)
+}
+
+func failf(msg string, args ...interface{}) {
+	fmt.Fprintf(os.Stderr, msg+"\n", args...)
+	os.Exit(1)
+}