Add memory usage test bench

.gitignore

@@ -20,6 +20,7 @@ __pycache__
 # Stuff dump core all over the place.
 core
 vgcore.*
+massif.out.*
 # Development
 tags
 .tags

tests/membench/README.md

+Memory benchmark
+================
+This contains script and tool set for updater to do memory usage benchmarks. The
+idea is simple: We run updater in common way with Valgrind tool Massif.
+
+Using
+-----
+Run script corresponding to bench and you should get in current working directory
+a files with following names: `massif.out.BENCH.PID` where `BENCH` is name of used
+bench and `PID` is pid. The most interesting massif is the one with lowest pid
+because that is trace of whole program execution. The rest of those files are from
+subprocesses.
+
+To visualize massif files you can use Massif Visualizer (massif-visualizer).
+
+Benches
+-------
+
+### Install transaction (installone.sh)
+This simply installs package with `pkgtransaction`. This gives an idea on how
+single givem enough size package influences memory usage of transaction.
+
+### Install transaction (updateone.sh)
+This installs package with `pkgupdate`. This gives an idea on how single givem
+enough size package influences memory usage of whole execution.
+
+### Full system install (fullrun.sh)
+This simulates complete run of updater. It plans and installs multiple packages to
+system.

tests/membench/common.sh

+# Copyright 2019, CZ.NIC z.s.p.o. (http://www.nic.cz/)
+#
+# This file is part of the Turris Updater.
+#
+# Updater is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+# Updater is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Updater.  If not, see <http://www.gnu.org/licenses/>.
+set -e
+
+[ -n "$BENCH" ] || {
+	echo "BENCH has to be defined before common.sh is included!" >&2
+	exit 1
+}
+
+# Path to updater repository root
+sroot="$(readlink -f "$src/../..")"
+
+_exit_cleanup() {
+	if [ -n "$root_dir" ]; then
+		if [ -n "$PRESERVE_ROOT" ]; then
+			echo "Preserving root: $root_dir" >&2
+		else
+			rm -rf "$root_dir"
+		fi
+	fi
+}
+trap _exit_cleanup EXIT TERM INT QUIT ABRT HUP
+
+_run_updater() {
+	local bin="$1"
+	shift
+	[ -n "$root_dir" ] || {
+		echo "Error: you have to use prepare_root before updater!" >&2
+		exit 1
+	}
+	make -C "$sroot" "bin/$bin"
+	valgrind --tool=massif --massif-out-file="massif.out.$BENCH.%p" \
+		"$sroot/bin/$bin" -R "$root_dir" "$@"
+}
+
+pkgupdate() {
+	_run_updater pkgupdate "$@"
+}
+
+pkgtransaction() {
+	_run_updater pkgtransaction "$@"
+}
+
+# Creates new root for updater
+prepare_root() {
+	root_dir="$(mktemp -d)"
+
+	## Create base filesystem for updater
+	ln -sf tmp "$root_dir/var"
+	# Create lock required by updater
+	mkdir -p "$root_dir/tmp/lock"
+	# Create opkg status file and info file
+	mkdir -p "$root_dir/usr/lib/opkg/info"
+	touch "$root_dir/usr/lib/opkg/status"
+	# And updater directory
+	mkdir -p "$root_dir/usr/share/updater"
+}
+
+# Following functions can be used to create new packages and repository
+
+# This copies new package template for package PKGNAME in directory PKGNAME
+# Usage: package_template PKGNAME [VERSION}]
+package_template() {
+	local pkgname="$1"
+	local pkgversion="${2:-1.0}"
+	cp -r "$sroot/utils/opkg-create/template" "$pkgname"
+	sed -i "s#^Package:.*\$#Package: $pkgname#;s#^Version:.*\$#Version: $pkgversion#" "$pkgname/control"
+	rm "$pkgname/data/file"
+}
+
+# Generate ipk from package template
+# Usage: package_pack PKGNAME
+package_pack() {
+	local package="$1"
+	"$sroot/utils/opkg-create/opkg-create-package" "$package"
+	[ -z "$package" ] || rm -rf "$package"
+}
+
+# Generate repository index for all packages in current directory
+repo_gen() {
+	"$sroot/utils/opkg-create/opkg-create-repo"
+	echo "== Repository sizes =="
+	du -h *
+	echo "======================"
+}

tests/membench/fullrun.sh

+#!/bin/bash
+# Copyright 2019, CZ.NIC z.s.p.o. (http://www.nic.cz/)
+#
+# This file is part of the Turris Updater.
+#
+# Updater is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+# Updater is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Updater.  If not, see <http://www.gnu.org/licenses/>.
+BENCH=fullrun
+src="$(dirname "$0")"
+. "$src/common.sh"
+
+prepare_root
+pushd "$root_dir"
+
+mkdir repo
+pushd repo
+for i in $(seq 50); do
+	package_template "test_$i"
+	openssl rand -out "test_$i/data/file.$i" $(( i * 1000000 ))
+	package_pack "test_$i"
+done
+repo_gen
+popd
+
+cat >script.lua <<EOF
+Repository("repo", "file://$(pwd)/repo")
+for i = 1,50,1 do
+	Install("test_" .. tostring(i))
+end
+EOF
+
+popd
+
+pkgupdate --model none --board none --batch "file://$root_dir/script.lua"

tests/membench/installone.sh

+#!/bin/bash
+# Copyright 2019, CZ.NIC z.s.p.o. (http://www.nic.cz/)
+#
+# This file is part of the Turris Updater.
+#
+# Updater is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+# Updater is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Updater.  If not, see <http://www.gnu.org/licenses/>.
+BENCH=installone
+src="$(dirname "$0")"
+. "$src/common.sh"
+
+prepare_root
+pushd "$root_dir"
+
+package_template test_big
+openssl rand -out "test_big/data/file" 100000000
+package_pack test_big
+du -h test_big.ipk
+
+popd
+
+pkgtransaction -a "$root_dir/test_big.ipk"

tests/membench/updateone.sh

+#!/bin/bash
+# Copyright 2019, CZ.NIC z.s.p.o. (http://www.nic.cz/)
+#
+# This file is part of the Turris Updater.
+#
+# Updater is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+# Updater is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Updater.  If not, see <http://www.gnu.org/licenses/>.
+BENCH=updateone
+src="$(dirname "$0")"
+. "$src/common.sh"
+
+prepare_root
+pushd "$root_dir"
+
+mkdir repo
+pushd repo
+package_template test_big
+openssl rand -out "test_big/data/file" 100000000
+package_pack test_big
+repo_gen
+popd
+
+cat >script.lua <<EOF
+Repository("repo", "file://$(pwd)/repo")
+Install("test_big")
+EOF
+
+popd
+
+pkgupdate --model none --board none --batch "file://$root_dir/script.lua"