Bump version

.github/workflows/ubuntu.yml

@@ -24,7 +24,7 @@ jobs:
         sudo apt-get install qemu-system-x86
 
     - name: Bootstrap
-      run: ./tools/qemu-debian-img/bootstrap.sh
+      run: ./tools/qemu-ubuntu-img/bootstrap.sh
 
     - name: Unit Testing
       run: go test -parallel 1 -v ./...

CHANGELOG.md

@@ -4,6 +4,30 @@
 
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0]
+
+### Added
+
+- Graceful shutdown on ^C while kernels generation.
+
+- Flag to set the container runtime command.
+
+- out-of-tree image --dry-run for printing full qemu command.
+
+### Changed
+
+- No exit at the end of the retries, will continue with the other
+  kernels.
+
+- All temporary files moved to ~/.out-of-tree/tmp/.
+
+### Fixed
+
+- Discrepancies between /lib/modules and /boot should no longer lead
+  to fatal errors.
+
+- Podman support on macOS.
+
 ## [2.0.0]
 
 ### Breaking

README.md

@@ -23,8 +23,13 @@ Note that adding a user to group *docker* has serious security implications. Che
 
 ### macOS
 
-    $ brew install --cask docker
+Note: case-sensitive FS is required for the ~/.out-of-tree directory.
-    $ open --background -a Docker && sleep 1m
+
+    $ brew install podman
+    $ podman machine stop || true
+    $ podman machine rm || true
+    $ podman machine init --cpus=4 --memory=4096 -v $HOME:$HOME
+    $ podman machine start
     $ brew tap out-of-tree/repo
     $ brew install out-of-tree
 

container.go

@@ -20,6 +20,8 @@ import (
 	"code.dumpstack.io/tools/out-of-tree/config"
 )
 
+var containerRuntime = "docker"
+
 type ContainerCmd struct {
 	Filter string `help:"filter by name"`
 
@@ -56,7 +58,8 @@ type ContainerCleanupCmd struct{}
 func (cmd ContainerCleanupCmd) Run(containerCmd *ContainerCmd) (err error) {
 	var output []byte
 	for _, name := range containerCmd.Containers() {
-		output, err = exec.Command("docker", "image", "rm", name).CombinedOutput()
+		output, err = exec.Command(containerRuntime, "image", "rm", name).
+			CombinedOutput()
 		if err != nil {
 			log.Error().Err(err).Str("output", string(output)).Msg("")
 			return
@@ -72,7 +75,7 @@ type containerImageInfo struct {
 }
 
 func listContainerImages() (diis []containerImageInfo, err error) {
-	cmd := exec.Command("docker", "images")
+	cmd := exec.Command(containerRuntime, "images")
 	log.Debug().Msgf("%v", cmd)
 
 	rawOutput, err := cmd.CombinedOutput()
@@ -148,7 +151,7 @@ func (c container) Build(imagePath string) (output string, err error) {
 	args := []string{"build"}
 	args = append(args, "-t", c.name, imagePath)
 
-	cmd := exec.Command("docker", args...)
+	cmd := exec.Command(containerRuntime, args...)
 
 	flog := log.With().
 		Str("command", fmt.Sprintf("%v", cmd)).
@@ -188,14 +191,26 @@ func (c container) Run(workdir string, command string) (output string, err error
 	var args []string
 	args = append(args, "run", "--rm")
 	args = append(args, c.Args...)
-	args = append(args,
+	if workdir != "" {
-		"-v", workdir+":/work",
+		args = append(args, "-v", workdir+":/work")
-		"-v", c.Volumes.LibModules+":/lib/modules",
+	}
-		"-v", c.Volumes.UsrSrc+":/usr/src",
+	if c.Volumes.LibModules != "" {
-		"-v", c.Volumes.Boot+":/boot")
+		args = append(args, "-v", c.Volumes.LibModules+":/lib/modules")
-	args = append(args, c.name, "bash", "-c", "cd /work && "+command)
+	}
+	if c.Volumes.UsrSrc != "" {
+		args = append(args, "-v", c.Volumes.UsrSrc+":/usr/src")
+	}
+	if c.Volumes.Boot != "" {
+		args = append(args, "-v", c.Volumes.Boot+":/boot")
+	}
+	args = append(args, c.name, "bash", "-c")
+	if workdir != "" {
+		args = append(args, "cd /work && "+command)
+	} else {
+		args = append(args, command)
+	}
 
-	cmd := exec.Command("docker", args...)
+	cmd := exec.Command(containerRuntime, args...)
 
 	log.Debug().Msgf("%v", cmd)
 
@@ -207,6 +222,13 @@ func (c container) Run(workdir string, command string) (output string, err error
 
 	timer := time.AfterFunc(c.timeout, func() {
 		flog.Info().Msg("killing container by timeout")
+
+		flog.Debug().Msg("SIGINT")
+		cmd.Process.Signal(os.Interrupt)
+
+		time.Sleep(time.Minute)
+
+		flog.Debug().Msg("SIGKILL")
 		cmd.Process.Kill()
 	})
 	defer timer.Stop()

images.go

@@ -13,6 +13,7 @@ import (
 	"os"
 	"os/exec"
 	"os/user"
+	"strings"
 	"time"
 
 	"code.dumpstack.io/tools/out-of-tree/config"
@@ -47,6 +48,7 @@ func (cmd *ImageListCmd) Run(g *Globals) (err error) {
 
 type ImageEditCmd struct {
 	Name   string `help:"image name" required:""`
+	DryRun bool   `help:"do nothing, just print commands"`
 }
 
 func (cmd *ImageEditCmd) Run(g *Globals) (err error) {
@@ -86,6 +88,22 @@ func (cmd *ImageEditCmd) Run(g *Globals) (err error) {
 
 	q.Mutable = true
 
+	if cmd.DryRun {
+		s := q.Executable()
+		for _, arg := range q.Args() {
+			if strings.Contains(arg, " ") ||
+				strings.Contains(arg, ",") {
+
+				s += fmt.Sprintf(` "%s"`, arg)
+			} else {
+				s += fmt.Sprintf(" %s", arg)
+			}
+		}
+		fmt.Println(s)
+		fmt.Println(q.GetSSHCommand())
+		return
+	}
+
 	err = q.Start()
 	if err != nil {
 		fmt.Println("Qemu start error:", err)

kernel.go

@@ -12,6 +12,7 @@ import (
 	"math/rand"
 	"os"
 	"os/exec"
+	"os/signal"
 	"os/user"
 	"regexp"
 	"runtime"
@@ -68,6 +69,9 @@ func (cmd KernelAutogenCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 		return
 	}
 
+	shutdown := false
+	setSigintHandler(&shutdown)
+
 	for _, sk := range ka.SupportedKernels {
 		if sk.DistroRelease == "" {
 			err = errors.New("Please set distro_release")
@@ -82,10 +86,14 @@ func (cmd KernelAutogenCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 			kernelCmd.Force,
 			!kernelCmd.NoHeaders,
 			kernelCmd.Shuffle,
+			&shutdown,
 		)
 		if err != nil {
 			return
 		}
+		if shutdown {
+			break
+		}
 	}
 
 	return updateKernelsCfg(kernelCmd.UseHost, !kernelCmd.NoDownload)
@@ -102,6 +110,9 @@ func (cmd *KernelGenallCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 		return
 	}
 
+	shutdown := false
+	setSigintHandler(&shutdown)
+
 	km := config.KernelMask{
 		DistroType:    distroType,
 		DistroRelease: cmd.Ver,
@@ -115,6 +126,7 @@ func (cmd *KernelGenallCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 		kernelCmd.Force,
 		!kernelCmd.NoHeaders,
 		kernelCmd.Shuffle,
+		&shutdown,
 	)
 	if err != nil {
 		return
@@ -135,6 +147,9 @@ func (cmd *KernelInstallCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 		return
 	}
 
+	shutdown := false
+	setSigintHandler(&shutdown)
+
 	km := config.KernelMask{
 		DistroType:    distroType,
 		DistroRelease: cmd.Ver,
@@ -148,6 +163,7 @@ func (cmd *KernelInstallCmd) Run(kernelCmd *KernelCmd, g *Globals) (err error) {
 		kernelCmd.Force,
 		!kernelCmd.NoHeaders,
 		kernelCmd.Shuffle,
+		&shutdown,
 	)
 	if err != nil {
 		return
@@ -262,7 +278,8 @@ func generateBaseDockerImage(registry string, commands []config.DockerCommand,
 
 	d := "# BASE\n"
 
-	cmd := exec.Command("docker", "images", "-q", sk.DockerName())
+	// TODO move as function to container.go
+	cmd := exec.Command(containerRuntime, "images", "-q", sk.DockerName())
 	log.Debug().Msgf("run %v", cmd)
 
 	rawOutput, err := cmd.CombinedOutput()
@@ -356,7 +373,10 @@ func generateBaseDockerImage(registry string, commands []config.DockerCommand,
 		// Cache kernel package dependencies
 		d += "RUN export PKGNAME=$(yum search kernel-devel --showduplicates | grep '^kernel-devel' | cut -d ' ' -f 1 | head -n 1); " +
 			"yum -y install $PKGNAME $(echo $PKGNAME | sed 's/-devel//'); " +
-			fmt.Sprintf("yum -y remove $PKGNAME $(echo $PKGNAME | sed 's/-devel//') %s\n", flags)
+			fmt.Sprintf("yum -y remove $PKGNAME "+
+				"$(echo $PKGNAME | sed 's/-devel//') "+
+				"$(echo $PKGNAME | sed 's/-devel/-modules/') "+
+				"$(echo $PKGNAME | sed 's/-devel/-core/') %s\n", flags)
 	default:
 		err = fmt.Errorf("%s not yet supported", sk.DistroType.String())
 		return
@@ -389,17 +409,10 @@ func generateBaseDockerImage(registry string, commands []config.DockerCommand,
 }
 
 func installKernel(sk config.KernelMask, pkgname string, force, headers bool) (err error) {
-	tmpdir, err := os.MkdirTemp(tempDirBase, "out-of-tree-"+pkgname+"-")
-	if err != nil {
-		log.Fatal().Err(err).Msg("make tmp directory")
-	}
-	defer os.RemoveAll(tmpdir)
-
 	slog := log.With().
 		Str("distro_type", sk.DistroType.String()).
 		Str("distro_release", sk.DistroRelease).
 		Str("pkg", pkgname).
-		Str("tmpdir", tmpdir).
 		Logger()
 
 	c, err := NewContainer(sk.DockerName(), time.Hour) // TODO conf
@@ -425,17 +438,14 @@ func installKernel(sk config.KernelMask, pkgname string, force, headers bool) (e
 
 	volumes := c.Volumes
 
-	c.Volumes.LibModules = fmt.Sprintf("%s/libmodules", tmpdir)
+	c.Volumes.LibModules = ""
-	os.MkdirAll(c.Volumes.LibModules, 0777)
+	c.Volumes.UsrSrc = ""
-
+	c.Volumes.Boot = ""
-	c.Volumes.UsrSrc = fmt.Sprintf("%s/usrsrc", tmpdir)
-	os.MkdirAll(c.Volumes.UsrSrc, 0777)
-
-	c.Volumes.Boot = fmt.Sprintf("%s/boot", tmpdir)
-	os.MkdirAll(c.Volumes.Boot, 0777)
 
 	slog.Debug().Msgf("Installing kernel")
 
+	cmd := "true"
+
 	switch sk.DistroType {
 	case config.Ubuntu:
 		var headerspkg string
@@ -443,12 +453,7 @@ func installKernel(sk config.KernelMask, pkgname string, force, headers bool) (e
 			headerspkg = strings.Replace(pkgname, "image", "headers", -1)
 		}
 
-		cmd := fmt.Sprintf("apt-get install -y %s %s", pkgname, headerspkg)
+		cmd += fmt.Sprintf(" && apt-get install -y %s %s", pkgname, headerspkg)
-
-		_, err = c.Run(tempDirBase, cmd)
-		if err != nil {
-			return
-		}
 	case config.CentOS:
 		imagepkg := strings.Replace(pkgname, "-devel", "", -1)
 
@@ -457,19 +462,11 @@ func installKernel(sk config.KernelMask, pkgname string, force, headers bool) (e
 		if !headers {
 			pkgname = ""
 		}
-		cmd := fmt.Sprintf("yum -y install %s %s\n", imagepkg,
+		cmd += fmt.Sprintf(" && yum -y install %s %s", imagepkg,
 			pkgname)
-		_, err = c.Run(tempDirBase, cmd)
-		if err != nil {
-			return
-		}
 
-		cmd = fmt.Sprintf("dracut --add-drivers 'e1000 ext4' -f "+
+		cmd += fmt.Sprintf(" && dracut --add-drivers 'e1000 ext4' -f "+
-			"/boot/initramfs-%s.img %s\n", version, version)
+			"/boot/initramfs-%s.img %s", version, version)
-		_, err = c.Run(tempDirBase, cmd)
-		if err != nil {
-			return
-		}
 	default:
 		err = fmt.Errorf("%s not yet supported", sk.DistroType.String())
 		return
@@ -479,33 +476,11 @@ func installKernel(sk config.KernelMask, pkgname string, force, headers bool) (e
 	c.Args = append(c.Args, "-v", volumes.UsrSrc+":/target/usr/src")
 	c.Args = append(c.Args, "-v", volumes.Boot+":/target/boot")
 
-	cmd := "true"
+	cmd += " && cp -r /boot /target/"
+	cmd += " && cp -r /lib/modules /target/lib/"
+	cmd += " && cp -r /usr/src /target/usr/"
 
-	files, err := ioutil.ReadDir(c.Volumes.Boot)
+	_, err = c.Run("", cmd)
-	if err != nil {
-		return
-	}
-	if len(files) != 0 {
-		cmd += " && cp -r /boot/* /target/boot/"
-	}
-
-	files, err = ioutil.ReadDir(c.Volumes.LibModules)
-	if err != nil {
-		return
-	}
-	if len(files) != 0 {
-		cmd += " && cp -r /lib/modules/* /target/lib/modules/"
-	}
-
-	files, err = ioutil.ReadDir(c.Volumes.UsrSrc)
-	if err != nil {
-		return
-	}
-	if len(files) != 0 {
-		cmd += " && cp -r /usr/src/* /target/usr/src/"
-	}
-
-	_, err = c.Run(tempDirBase, cmd)
 	if err != nil {
 		return
 	}
@@ -703,20 +678,40 @@ func shuffleStrings(a []string) []string {
 	return a
 }
 
+func setSigintHandler(variable *bool) {
+	c := make(chan os.Signal, 1)
+	signal.Notify(c, os.Interrupt)
+	go func() {
+		counter := 0
+		for _ = range c {
+			if counter == 0 {
+				*variable = true
+				log.Warn().Msg("shutdown requested, finishing work")
+				log.Info().Msg("^C a couple of times more for an unsafe exit")
+			} else if counter >= 3 {
+				log.Fatal().Msg("unsafe exit")
+			}
+
+			counter += 1
+		}
+	}()
+
+}
+
 func generateKernels(km config.KernelMask, registry string,
 	commands []config.DockerCommand, max, retries int64,
-	download, force, headers, shuffle bool) (err error) {
+	download, force, headers, shuffle bool, shutdown *bool) (err error) {
 
 	log.Info().Msgf("Generating for kernel mask %v", km)
 
 	_, err = genRootfsImage(containerImageInfo{Name: km.DockerName()},
 		download)
-	if err != nil {
+	if err != nil || *shutdown {
 		return
 	}
 
 	err = generateBaseDockerImage(registry, commands, km)
-	if err != nil {
+	if err != nil || *shutdown {
 		return
 	}
 
@@ -730,7 +725,7 @@ func generateKernels(km config.KernelMask, registry string,
 	default:
 		err = fmt.Errorf("%s not yet supported", km.DistroType.String())
 	}
-	if err != nil {
+	if err != nil || *shutdown {
 		return
 	}
 
@@ -743,12 +738,21 @@ func generateKernels(km config.KernelMask, registry string,
 			break
 		}
 
+		if *shutdown {
+			err = nil
+			return
+		}
 		log.Info().Msgf("%d/%d %s", i+1, len(pkgs), pkg)
 
 		var attempt int64
 		for {
 			attempt++
 
+			if *shutdown {
+				err = nil
+				return
+			}
+
 			err = installKernel(km, pkg, force, headers)
 			if err == nil {
 				max--

main.go

@@ -9,6 +9,7 @@ import (
 	"io"
 	"math/rand"
 	"os"
+	"os/exec"
 	"os/user"
 	"runtime/debug"
 	"strconv"
@@ -44,6 +45,8 @@ type CLI struct {
 	Version VersionFlag `name:"version" help:"print version information and quit"`
 
 	LogLevel LogLevelFlag `enum:"trace,debug,info,warn,error" default:"info"`
+
+	ContainerRuntime string `enum:"podman,docker" default:"podman"`
 }
 
 type LogLevelFlag string
@@ -103,7 +106,7 @@ func main() {
 			Compact: true,
 		}),
 		kong.Vars{
-			"version": "2.0.6",
+			"version": "2.1.2",
 		},
 	)
 
@@ -153,6 +156,22 @@ func main() {
 		log.Debug().Msgf("%v", buildInfo.Settings)
 	}
 
+	_, err = exec.LookPath(cli.ContainerRuntime)
+	if err != nil {
+		if cli.ContainerRuntime == "podman" { // default value
+			log.Debug().Msgf("podman is not found in $PATH, " +
+				"fall back to docker")
+			cli.ContainerRuntime = "docker"
+		}
+
+		_, err = exec.LookPath(cli.ContainerRuntime)
+		if err != nil {
+			log.Fatal().Msgf("%v is not found in $PATH",
+				cli.ContainerRuntime)
+		}
+	}
+	containerRuntime = cli.ContainerRuntime
+
 	err = ctx.Run(&cli.Globals)
 	ctx.FatalIfErrorf(err)
 }

qemu/README.md

@@ -30,7 +30,7 @@ Note: qemu on macOS since v2.12 (24 April 2018) supports Hypervisor.framework.
 
 #### Generate image
 
-    $ cd $GOPATH/src/code.dumpstack.io/tools/out-of-tree/tools/qemu-debian-img
+    $ cd $GOPATH/src/code.dumpstack.io/tools/out-of-tree/tools/qemu-ubuntu-img
     $ ./bootstrap.sh
 
 ### Fill configuration file

qemu/qemu-kernel.go

@@ -208,14 +208,16 @@ func (q System) cmdline() (s string) {
 	return
 }
 
-// Start qemu process
+func (q System) Executable() string {
-func (q *System) Start() (err error) {
+	return "qemu-system-" + string(q.arch)
-	rand.Seed(time.Now().UnixNano()) // Are you sure?
+}
+
+func (q *System) Args() (qemuArgs []string) {
 	if q.sshAddrPort == "" {
 		q.sshAddrPort = getFreeAddrPort()
 	}
 	hostfwd := fmt.Sprintf("hostfwd=tcp:%s-:22", q.sshAddrPort)
-	qemuArgs := []string{"-nographic",
+	qemuArgs = []string{"-nographic",
 		"-hda", q.drivePath,
 		"-kernel", q.kernel.KernelPath,
 		"-smp", fmt.Sprintf("%d", q.Cpus),
@@ -245,8 +247,14 @@ func (q *System) Start() (err error) {
 	}
 
 	qemuArgs = append(qemuArgs, "-append", q.cmdline())
+	return
+}
 
-	q.cmd = exec.Command("qemu-system-"+string(q.arch), qemuArgs...)
+// Start qemu process
+func (q *System) Start() (err error) {
+	rand.Seed(time.Now().UnixNano()) // Are you sure?
+
+	q.cmd = exec.Command(q.Executable(), q.Args()...)
 	q.log.Debug().Msgf("%v", q.cmd)
 
 	if q.pipe.stdin, err = q.cmd.StdinPipe(); err != nil {
@@ -370,7 +378,11 @@ func (q System) Command(user, cmd string) (output string, err error) {
 	if err != nil {
 		return
 	}
-	session.Stderr = session.Stdout
+
+	stderr, err := session.StderrPipe()
+	if err != nil {
+		return
+	}
 
 	err = session.Start(cmd)
 	if err != nil {
@@ -387,6 +399,17 @@ func (q System) Command(user, cmd string) (output string, err error) {
 		output = strings.TrimSuffix(output, "\n")
 	}()
 
+	go func() {
+		scanner := bufio.NewScanner(stderr)
+		for scanner.Scan() {
+			m := scanner.Text()
+			output += m + "\n"
+			// Note: it prints stderr as stdout
+			flog.Trace().Str("stdout", m).Msg("")
+		}
+		output = strings.TrimSuffix(output, "\n")
+	}()
+
 	err = session.Wait()
 	return
 }

qemu/test.config.go

@@ -4,7 +4,7 @@
 
 package qemu
 
-const testConfigVmlinuz = "../tools/qemu-debian-img/ubuntu2204.vmlinuz"
+const testConfigVmlinuz = "../tools/qemu-ubuntu-img/ubuntu2204.vmlinuz"
-const testConfigInitrd = "../tools/qemu-debian-img/ubuntu2204.initrd"
+const testConfigInitrd = "../tools/qemu-ubuntu-img/ubuntu2204.initrd"
-const testConfigRootfs = "../tools/qemu-debian-img/ubuntu2204.img"
+const testConfigRootfs = "../tools/qemu-ubuntu-img/ubuntu2204.img"
-const testConfigSampleKo = "../tools/qemu-debian-img/ubuntu2204.ko"
+const testConfigSampleKo = "../tools/qemu-ubuntu-img/ubuntu2204.ko"