From a196fc171a46e1192a0f8d0913d671544b56c8d8 Mon Sep 17 00:00:00 2001
From: Norman Feske <norman.feske@genode-labs.com>
Date: Wed, 29 Mar 2017 16:04:07 +0200
Subject: [PATCH] run: support for accessing depot content

Run scripts can use the new 'import_from_depot' function to incorporate
archive content from the depot into a scenario. The function must be
called after the 'create_boot_directory' function and takes any number
of pkg, src, or raw archives as arguments. An archive is specified as
depot-relative path of the form <user>/<type>/name. Run scripts may
call 'import_from_depot' repeatedly.

An argument can refer to a specific version of an archive or just the
version-less archive name. In the latter case, the current version (as
defined by a corresponding archive recipe in the source tree) is used.

If a 'src' archive is specified, the run tool integrates the content of
the corrsponding binary archive into the scenario. The binary archives
are selected according the spec values as defined for the build directory.
As of now, only x86_32 and x86_64 are supported by the 'depot_spec'
function.

Issue #2339
---
 tool/run/boot_dir/fiasco    |   7 +
 tool/run/boot_dir/foc       |   7 +
 tool/run/boot_dir/hw        |  13 ++
 tool/run/boot_dir/linux     |   6 +
 tool/run/boot_dir/nova      |   7 +
 tool/run/boot_dir/okl4      |   7 +
 tool/run/boot_dir/pistachio |   7 +
 tool/run/boot_dir/sel4      |   7 +
 tool/run/depot.inc          | 306 ++++++++++++++++++++++++++++++++++++
 tool/run/run                |   3 +
 10 files changed, 370 insertions(+)
 create mode 100644 tool/run/depot.inc

diff --git a/tool/run/boot_dir/fiasco b/tool/run/boot_dir/fiasco
index 4aaf6314b..4e4fc60d3 100644
--- a/tool/run/boot_dir/fiasco
+++ b/tool/run/boot_dir/fiasco
@@ -76,3 +76,10 @@ proc run_boot_dir {binaries} {
 		create_symlink_for_iso
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-fiasco }
+
diff --git a/tool/run/boot_dir/foc b/tool/run/boot_dir/foc
index 12007d880..a93372f47 100644
--- a/tool/run/boot_dir/foc
+++ b/tool/run/boot_dir/foc
@@ -183,3 +183,10 @@ proc run_boot_dir {binaries} {
 	if {[have_spec x86]} { return [run_boot_dir_x86 $binaries] }
 	if {[have_spec arm]} { return [run_boot_dir_arm $binaries] }
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-foc }
+
diff --git a/tool/run/boot_dir/hw b/tool/run/boot_dir/hw
index 496db4664..8c011845c 100644
--- a/tool/run/boot_dir/hw
+++ b/tool/run/boot_dir/hw
@@ -145,3 +145,16 @@ proc run_boot_dir {binaries} {
 		update_ipxe_boot_dir
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } {
+
+	if {[have_spec x86_64]} { return base-hw-pc }
+	if {[have_spec pbxa9]}  { return base-hw-pbxa9 }
+
+	puts stderr "base-hw kernel does not support this build configuration"
+	exit 1
+}
diff --git a/tool/run/boot_dir/linux b/tool/run/boot_dir/linux
index 149271354..e2da4430d 100644
--- a/tool/run/boot_dir/linux
+++ b/tool/run/boot_dir/linux
@@ -14,3 +14,9 @@ proc run_boot_dir {binaries} {
 		set src_binary_path "../../../../bin/[kernel_specific_binary $binary]"
 		exec ln -sf $src_binary_path [run_dir]/genode/$binary }
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-linux }
diff --git a/tool/run/boot_dir/nova b/tool/run/boot_dir/nova
index 82fd96aa2..a55e090fd 100644
--- a/tool/run/boot_dir/nova
+++ b/tool/run/boot_dir/nova
@@ -111,3 +111,10 @@ proc run_boot_dir {binaries} {
 		create_symlink_for_iso
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-nova }
+
diff --git a/tool/run/boot_dir/okl4 b/tool/run/boot_dir/okl4
index 5b8c234b9..cb3adbc46 100644
--- a/tool/run/boot_dir/okl4
+++ b/tool/run/boot_dir/okl4
@@ -207,3 +207,10 @@ proc run_boot_dir {binaries} {
 		generate_tftp_config
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-okl4 }
+
diff --git a/tool/run/boot_dir/pistachio b/tool/run/boot_dir/pistachio
index 2d5fb7663..7807dc8c8 100644
--- a/tool/run/boot_dir/pistachio
+++ b/tool/run/boot_dir/pistachio
@@ -69,3 +69,10 @@ proc run_boot_dir {binaries} {
 		generate_tftp_config
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-pistachio }
+
diff --git a/tool/run/boot_dir/sel4 b/tool/run/boot_dir/sel4
index ef7ff623e..3abcc0756 100644
--- a/tool/run/boot_dir/sel4
+++ b/tool/run/boot_dir/sel4
@@ -64,3 +64,10 @@ proc run_boot_dir {binaries} {
 		create_symlink_for_iso
 	}
 }
+
+
+##
+# Base source archive within depot
+#
+proc base_src { } { return base-sel4 }
+
diff --git a/tool/run/depot.inc b/tool/run/depot.inc
new file mode 100644
index 000000000..0802cb85a
--- /dev/null
+++ b/tool/run/depot.inc
@@ -0,0 +1,306 @@
+#
+# \brief  Utilities for accessing depot content from run scripts
+# \author Norman Feske
+# \date   2017-03-29
+#
+
+proc depot_dir { } { return [genode_dir]/depot }
+
+
+##
+# Return spec value to be used to access binary archives
+#
+proc depot_spec { } {
+	if {[have_spec x86_32]} { return "x86_32" }
+	if {[have_spec x86_64]} { return "x86_64" }
+	if {[have_spec arm_v7]} { return "arm_v7" }
+}
+
+
+#
+# Variable used for keeping track of archives that are missing from the
+# depot. The list is populated by calls of 'import_from_depot' and evaluated
+# at the boot-image-creation stage via 'check_for_missing_depot_archives'.
+#
+set _missing_depot_archives {}
+
+
+#
+# Pattern to parse an archive path into <user>, <type>, <name>
+#
+proc _depot_archive_path_pattern { } { return {^([\w\d]+)/([\w]+)/([\w\d\-_]+)$} }
+
+#
+# Pattern to parse an binary archive path into <user>, <spec>, <name>.
+#
+proc _depot_bin_archive_path_pattern { } { return {^([\w\d]+)/bin/([\w\d]+)/([\w\d\-_]+)$} }
+proc _depot_lib_archive_path_pattern { } { return {^([\w\d]+)/bin/([\w\d]+)/[\w\d\-_]+/([\w\d\-_]+)$} }
+
+
+##
+# Import a pkg archive and its dependencies
+#
+proc _import_pkg_archive_from_depot { user name } {
+
+	global _missing_depot_archives
+
+	set archive_dir "[depot_dir]/$user/pkg/$name"
+
+	if {![file exists $archive_dir/archives]} {
+		puts "Error: missing file $archive_dir/archives"
+		exit 1
+	}
+
+	set fh [open "$archive_dir/archives" "RDONLY"]
+	set archives [read $fh]
+	close $fh
+
+	foreach archive $archives {
+		if {[regexp [_depot_archive_path_pattern] $archive dummy user type name]} {
+			if {($type == "pkg") || ($type == "src") || ($type == "raw")} {
+				import_from_depot $archive
+			}
+		}
+	}
+}
+
+
+proc _copy_directory_content_to_run_dir { dir } {
+
+	if {![file isdirectory $dir]} {
+		puts stderr "Error: expected directory at '$dir'"
+		exit 1
+	}
+
+	foreach file [glob -directory $dir *] { file copy -force $file [run_dir]/genode/ }
+}
+
+
+proc _import_raw_archive_from_depot { user name } {
+
+	_copy_directory_content_to_run_dir "[depot_dir]/$user/raw/$name"
+}
+
+
+##
+# Copy the binary content for a given source archive into the run directory
+#
+proc _import_src_archive_from_depot { user name } {
+
+	global _missing_depot_archives;
+
+	set bin_archive "$user/bin/[depot_spec]/$name"
+
+	#
+	# If the binary archive contains a library, direct 'bin_archive' to the
+	# correct API sub directory.
+	#
+	set api_file_path "[depot_dir]/$user/src/$name/api"
+	if {[file exists $api_file_path]} {
+		set fh [open "$api_file_path" "RDONLY"]
+		set api [read $fh]
+		close $fh
+		regsub -all {\s} $api {} api
+		if {$api != ""} {
+			set bin_archive "$user/bin/[depot_spec]/$api/$name" }
+	}
+
+	if {[file exists [depot_dir]/$bin_archive]} {
+		_copy_directory_content_to_run_dir "[depot_dir]/$bin_archive"
+	} else {
+		lappend _missing_depot_archives $bin_archive
+	}
+}
+
+
+##
+# Determine the version-suffixed name of an archive
+#
+# This function return an empty string if the archive is missing from the
+# depot.
+#
+proc _versioned_depot_archive_name { user type name } {
+
+	# if correctly versioned archive is specified, use it
+	if {[file exists [depot_dir]/$user/$type/$name]} { return $name }
+
+	#
+	# The given archive name may lack the version identifier if it refers
+	# to an archive generated locally from the Genode repository. In this case,
+	# we try to determine the version information from the Genode source tree.
+	#
+	set hash_rel_path "recipes/$type/$name/hash"
+	set repo [repository_contains $hash_rel_path]
+
+	if {$repo != ""} {
+		set fh [open "$repo/$hash_rel_path" "RDONLY"]
+		set version [lindex [gets $fh] 0]
+		close $fh
+
+		append name "-" $version
+		if {[file exists [depot_dir]/$user/$type/$name]} {
+			return $name }
+	}
+
+	return ""
+}
+
+
+proc import_from_depot { args } {
+
+	global _missing_depot_archives
+
+	foreach archive $args {
+
+		if {[regexp [_depot_archive_path_pattern] $archive dummy user type name]} {
+
+			set versioned_name [_versioned_depot_archive_name $user $type $name]
+			if {$versioned_name == ""} {
+				lappend _missing_depot_archives $archive
+
+			} else {
+
+				switch $type {
+
+					"pkg" { _import_pkg_archive_from_depot $user $versioned_name }
+					"src" { _import_src_archive_from_depot $user $versioned_name }
+					"raw" { _import_raw_archive_from_depot $user $versioned_name }
+
+					default {
+						puts stderr "Error: unknown depot-archive type '$type'"
+						exit 1
+					}
+				}
+			}
+		} else {
+			puts stderr "Error: malformed depot-archive path '$archive',"
+			puts stderr "       expected '<user>/<type>/<name>'"
+			exit 1
+		}
+	}
+}
+
+
+proc _locally_available_recipe { user type name } {
+
+	if {[repository_contains "recipes/$type/$name/hash"] != ""} {
+		return $name }
+
+	#
+	# If the supplied 'name' is a versioned name (as obtained from a pkg
+	# 'archives' filed already stored in the depot, we try to find a recipe
+	# in the source tree that matches the specified name and version. If
+	# we find the matching recipe, we can build the archive locally using
+	# the version-less recipe name.
+	#
+	set version_suffix_pattern {\-[^\-/]*$}
+	set versioned_name $name
+
+	while {[regexp -- $version_suffix_pattern $name dummy]} {
+
+		# strip last part of version suffix
+		regsub -- $version_suffix_pattern $name "" name
+
+		if {[repository_contains "recipes/$type/$name/hash"] != ""} {
+			if {[_versioned_depot_archive_name $user $type $name] == $versioned_name} {
+				return $name } }
+	}
+	return ""
+}
+
+
+##
+# Check for the completeness of the imported depot content
+#
+# This function aborts the run script if any archives are missing.
+#
+proc check_for_missing_depot_archives { } {
+
+	global _missing_depot_archives
+
+	if {[llength $_missing_depot_archives] == 0} { return }
+
+	puts stderr "\nError: missing depot archives:"
+
+	#
+	# Try to assist the user with obtaining the missing archives
+	#
+	# For missing archives that belong to the configured depot user, the
+	# user should be able to created them from the source tree as long as
+	# recipe exists.
+	#
+	# Archives that do not belong to the configured depot user may be
+	# downloaded.
+	#
+	# XXX Present this option only if the URL and public key of the
+	#     archives user is known
+	# XXX Present download option even for archives that can be created locally
+	#
+
+	set nonexisting_archives {}
+	set local_user_archives {}
+	set foreign_archives {}
+
+	foreach archive $_missing_depot_archives {
+		puts stderr "       $archive"
+		if {[regexp [_depot_archive_path_pattern] $archive dummy user type name]} {
+
+			#
+			# If a pkg archive is missing, suggest to obtain the binary-pkg
+			# archive (matching the build directory) immediately, which implies
+			# the pkg archive. Otherwise, the user would first obtain the pkg
+			# archive and its source dependencies, and then get an error for
+			# the missing binary archives on the next attempt to execute the
+			# run script.
+			#
+			if {$type == "pkg"} { set archive "$user/pkg/[depot_spec]/$name" }
+			if {$type == "src"} { set archive "$user/bin/[depot_spec]/$name" }
+
+			if {[_locally_available_recipe $user $type $name] != ""} {
+				lappend local_user_archives $archive
+			} else {
+				lappend foreign_archives $archive
+			}
+		} elseif {[regexp [_depot_lib_archive_path_pattern] $archive dummy user spec name]
+		       || [regexp [_depot_bin_archive_path_pattern] $archive dummy user spec name]} {
+
+			# source code is present in the current source tree
+			set recipe [_locally_available_recipe $user src $name]
+			if {$recipe != ""} {
+				lappend local_user_archives $user/bin/$spec/$recipe
+
+			# source code is present in the depot
+			} elseif {[file isdirectory [depot_dir]/$user/src/$name]} {
+				lappend local_user_archives $user/bin/$spec/$name
+
+			} else {
+				lappend foreign_archives $archive
+			}
+		}
+	}
+
+	append create_args " CROSS_DEV_PREFIX=[cross_dev_prefix]"
+
+	if {[llength $local_user_archives]} {
+		puts stderr "You may create the following archives locally:\n"
+		puts stderr "  [genode_dir]/tool/depot/create $local_user_archives$create_args\n"
+	}
+
+	if {[llength $foreign_archives]} {
+		puts stderr "You may try to download the following archives:\n"
+		puts stderr "  [genode_dir]/tool/depot/download $foreign_archives\n"
+	}
+
+	exit 1
+}
+
+
+proc drivers_interactive_pkg { } {
+
+	if {[have_spec linux]} { return drivers_interactive-linux }
+	if {[have_spec x86]}   { return drivers_interactive-pc }
+	if {[have_spec pbxa9]} { return drivers_interactive-pbxa9 }
+
+	puts stderr "drivers_interactive package undefined for this build configuration"
+	exit 1
+}
diff --git a/tool/run/run b/tool/run/run
index 305005b81..c43f09e54 100755
--- a/tool/run/run
+++ b/tool/run/run
@@ -124,6 +124,7 @@ proc install_config {config} {
 #                  '<build-dir>/bin/' directory
 #
 proc build_boot_image {binaries} {
+	check_for_missing_depot_archives
 	run_boot_dir $binaries
 }
 
@@ -792,6 +793,8 @@ proc build_core_image {binaries} {
 	exec rm -rf [run_dir]/genode
 }
 
+source [genode_dir]/tool/run/depot.inc
+
 
 ##
 ## Execution of run scripts