From 37137150cb3bec5efc9112447b03d4999612e3d4 Mon Sep 17 00:00:00 2001
From: Dmitry Vyukov <dvyukov@google.com>
Date: Sat, 16 May 2020 07:14:45 +0200
Subject: tools: add syz-env

syz-env provides a canned dev environment with all tools necessary
(Go, gcc, clang-format, etc) for development/testing in a form
of a Docker image. Example use:

$ syz-env make presubmit
$ syz-env make extract SOURCEDIR=~/linux

Update #1699
---
 tools/Dockerfile | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++
 tools/syz-env    | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 123 insertions(+)
 create mode 100644 tools/Dockerfile
 create mode 100755 tools/syz-env

(limited to 'tools')

diff --git a/tools/Dockerfile b/tools/Dockerfile
new file mode 100644
index 000000000..fb1214e4c
--- /dev/null
+++ b/tools/Dockerfile
@@ -0,0 +1,58 @@
+# Copyright 2020 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.
+
+# The image provides dev environment suitable for syzkaller development/testing.
+# It includes Go toolchain, C/C++ cross-compilers, go-fuzz and golangci-lint.
+
+# The image is available as gcr.io/syzkaller/env.
+
+# To download and run locally:
+#	docker pull gcr.io/syzkaller/env
+#	docker run -it gcr.io/syzkaller/env
+
+# To build and push new version:
+#	docker build -t gcr.io/syzkaller/env tools
+#	gcloud auth login && gcloud auth configure-docker
+#	docker push gcr.io/syzkaller/env
+
+FROM debian:buster
+
+LABEL homepage="https://github.com/google/syzkaller"
+
+RUN dpkg --add-architecture i386 && \
+	apt-get update && \
+	DEBIAN_FRONTEND=noninteractive apt-get install -y -q --no-install-recommends \
+	sudo make nano git curl ca-certificates clang-format binutils g++ clang \
+	g++-arm-linux-gnueabi g++-aarch64-linux-gnu g++-powerpc64le-linux-gnu g++-mips64el-linux-gnuabi64 \
+	libc6-dev:i386 linux-libc-dev:i386 lib32gcc-8-dev lib32stdc++-8-dev \
+	# These are needed to build Linux kernel:
+	flex bison bc libelf-dev libssl-dev && \
+	apt-get -y autoremove && \
+	apt-get clean autoclean && \
+	rm -rf /var/lib/apt/lists/{apt,dpkg,cache,log} /tmp/* /var/tmp/*
+
+RUN curl https://dl.google.com/go/go1.14.2.linux-amd64.tar.gz | tar -C /usr/local -xz
+ENV PATH /usr/local/go/bin:/gopath/bin:$PATH
+ENV GOPATH /gopath
+
+# For golangci-lint we need only the binary.
+RUN GO111MODULE=on go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.26.0 && \
+	mv /gopath/bin/* /usr/local/bin/ && \
+	rm -rf /gopath
+
+# For go-fuzz we also need sources (go-fuzz-dep).
+RUN go get github.com/dvyukov/go-fuzz/go-fuzz github.com/dvyukov/go-fuzz/go-fuzz-build
+
+# Pre-create dirs for syz-dock.
+# This is necessary to make docker work with the current user,
+# otherwise --volume will create these dirs under root and then
+# the current user won't have access to them.
+RUN mkdir -p /syzkaller/gopath/src/github.com/google/syzkaller && \
+	mkdir -p /syzkaller/.cache && \
+	chmod -R 0777 /syzkaller
+
+# The default Docker prompt is too ugly and takes the whole line:
+# I have no name!@0f3331d2fb54:~/gopath/src/github.com/google/syzkaller$
+RUN echo "export PS1='syz-env🈴 '" > /syzkaller/.bashrc
+
+ENTRYPOINT ["bash"]
diff --git a/tools/syz-env b/tools/syz-env
new file mode 100755
index 000000000..e8686cf6c
--- /dev/null
+++ b/tools/syz-env
@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+# Copyright 2020 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-env is a wrapper around gcr.io/syzkaller/env container,
+# which includes all tools necessary to develop/test syzkaller.
+# It's recommended to create an alias for this script:
+#
+#	alias syz-env="$(go env GOPATH)/src/github.com/google/syzkaller/tools/syz-env"
+#
+# Then it can be used to wrap almost any make invocation as:
+#
+#	syz-env make format
+#	syz-env make presubmit
+#	syz-env make extract SOURCEDIR=~/linux
+#
+# Or you may run the shell inside of the container with just syz-env.
+#
+# Note: this way everything runs inside of the container
+# and uses all tools bundled in the container rather than host tools.
+#
+# Note: syz-env assumes a sudo-less Docker is installed, see:
+# https://docs.docker.com/engine/install
+# https://docs.docker.com/engine/install/linux-postinstall
+# (Googlers see go/docker).
+
+COMMAND=""
+DOCKERARGS=()
+for ARG in "$@"; do
+	while IFS='=' read KEY VAL; do
+		# If we have a kernel path passed in, we mount it in the container
+		# at /syzkaller/kernel and fix up SOURCEDIR argument.
+		if [ "$KEY" == "SOURCEDIR" ]; then
+			DOCKERARGS+=" --volume $VAL:/syzkaller/kernel"
+			COMMAND+=" SOURCEDIR=/syzkaller/kernel"
+		else
+			COMMAND+=" $ARG"
+		fi
+	done <<< "$ARG"
+done
+if [ "$CI" == "" ]; then
+	# This gives interactive shell and allows to abort commands with Ctrl+C.
+	DOCKERARGS+=" -it"
+fi
+if [ "$COMMAND" == "" ]; then
+	COMMAND="bash"
+fi
+
+SCRIPT_DIR="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd -P)"
+
+# Run everything as the host user, this is important for created/modified files.
+docker run \
+	--user $(id -u ${USER}):$(id -g ${USER}) \
+	--volume "$SCRIPT_DIR/..:/syzkaller/gopath/src/github.com/google/syzkaller" \
+	--volume "$HOME/.cache:/syzkaller/.cache" \
+	--volume "/var/run/docker.sock":"/var/run/docker.sock" \
+	--workdir /syzkaller/gopath/src/github.com/google/syzkaller \
+	--env HOME=/syzkaller \
+	--env GOPATH=/syzkaller/gopath:/gopath \
+	--env FUZZIT_API_KEY \
+	--env GITHUB_REF \
+	--env GITHUB_SHA \
+	--env CI \
+	${DOCKERARGS[@]} \
+	gcr.io/syzkaller/env -c "$COMMAND"
-- 
cgit mrf-deployment