[people/stevee/pakfire.git] / src / libpakfire / build.c

/*#############################################################################
#                                                                             #
# Pakfire - The IPFire package management system                              #
# Copyright (C) 2021 Pakfire development team                                 #
#                                                                             #
# This program 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.                                         #
#                                                                             #
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
#############################################################################*/

#include <errno.h>
#include <stdlib.h>
#include <sys/mount.h>
#include <unistd.h>
#include <uuid/uuid.h>

#include <pakfire/build.h>
#include <pakfire/cgroup.h>
#include <pakfire/dependencies.h>
#include <pakfire/dist.h>
#include <pakfire/file.h>
#include <pakfire/i18n.h>
#include <pakfire/jail.h>
#include <pakfire/logging.h>
#include <pakfire/mount.h>
#include <pakfire/package.h>
#include <pakfire/packager.h>
#include <pakfire/parser.h>
#include <pakfire/private.h>
#include <pakfire/problem.h>
#include <pakfire/repo.h>
#include <pakfire/request.h>
#include <pakfire/scriptlet.h>
#include <pakfire/snapshot.h>
#include <pakfire/solution.h>
#include <pakfire/string.h>
#include <pakfire/util.h>

#define CCACHE_DIR "/var/cache/ccache"

// We guarantee 2 GiB of memory to every build container
#define PAKFIRE_BUILD_MEMORY_GUARANTEED		(size_t)2 * 1024 * 1024 * 1024

// We allow only up to 2048 processes/threads for every build container
#define PAKFIRE_BUILD_PID_LIMIT				(size_t)2048

struct pakfire_build {
	struct pakfire* pakfire;
	int nrefs;

	// Flags
	int flags;

	// Build ID
	uuid_t id;
	char _id[UUID_STR_LEN];

	char target[PATH_MAX];

	// cgroup
	struct pakfire_cgroup* cgroup;

	// Jail
	struct pakfire_jail* jail;

	// The build repository
	struct pakfire_repo* repo;

	// A list of all built packages
	struct pakfire_packagelist* packages;

	// Buildroot
	char buildroot[PATH_MAX];

	// States
	int init:1;
};

#define TEMPLATE \
	"#!/bin/bash --login\n" \
	"\n" \
	"set -e\n" \
	"set -x\n" \
	"\n" \
	"%%{_%s}\n" \
	"\n" \
	"exit 0\n"

static int pakfire_build_has_flag(struct pakfire_build* build, int flag) {
	return build->flags & flag;
}

static int __pakfire_build_setup_repo(struct pakfire* pakfire,
		struct pakfire_repo* repo, void* p) {
	char path[PATH_MAX];
	FILE* f = NULL;
	int r;

	struct pakfire_build* build = (struct pakfire_build*)p;

	// Skip processing the installed repository
	if (pakfire_repo_is_installed_repo(repo))
		return 0;

	// Skip processing any other internal repositories
	if (pakfire_repo_is_internal(repo))
		return 0;

	const char* name = pakfire_repo_get_name(repo);

	DEBUG(pakfire, "Exporting repository configuration for '%s'\n", name);

	// Make path for configuration file
	r = pakfire_path(build->pakfire, path, PAKFIRE_CONFIG_DIR "/repos/%s.repo", name);
	if (r) {
		ERROR(pakfire, "Could not make repository configuration path for %s: %m\n", name);
		goto ERROR;
	}

	// Open the repository configuration
	f = fopen(path, "w");
	if (!f) {
		ERROR(pakfire, "Could not open %s for writing: %m\n", path);
		goto ERROR;
	}

	// Write repository configuration
	r = pakfire_repo_write_config(repo, f);
	if (r) {
		ERROR(pakfire, "Could not write repository configuration for %s: %m\n", name);
		goto ERROR;
	}

	// Bind-mount any local repositories
	if (pakfire_repo_is_local(repo)) {
		const char* _path = pakfire_repo_get_path(repo);

		// Bind-mount the repository data read-only
		r = pakfire_jail_bind(build->jail, _path, _path, MS_RDONLY);
		if (r) {
			ERROR(pakfire, "Could not bind-mount the repository at %s: %m\n", _path);
			goto ERROR;
		}
	}

ERROR:
	if (f)
		fclose(f);

	return r;
}

/*
	This function enables the local repository so that it can be accessed by
	a pakfire instance running inside the chroot.
*/
static int pakfire_build_enable_repos(struct pakfire_build* build) {
	return pakfire_repo_walk(build->pakfire, __pakfire_build_setup_repo, build);
}

/*
	Drops the user into a shell
*/
static int pakfire_build_shell(struct pakfire_build* build) {
	int r;

	// Export local repository if running in interactive mode
	r = pakfire_build_enable_repos(build);
	if (r)
		return r;

	// Run shell
	return pakfire_jail_shell(build->jail);
}

static int pakfire_build_run_script(struct pakfire_build* build, const char* filename,
		const char* args[], char** output) {
	char* script = NULL;
	size_t size = 0;
	char path[PATH_MAX];

	DEBUG(build->pakfire, "Running build script '%s'...\n", filename);

	// Make the source path
	pakfire_path_join(path, PAKFIRE_SCRIPTS_DIR, filename);

	// Open the source script
	FILE* f = fopen(path, "r");
	if (!f) {
		ERROR(build->pakfire, "Could not open %s: %m\n", path);
		return 1;
	}

	// Read the script into memory
	int r = pakfire_read_file_into_buffer(f, &script, &size);
	if (r) {
		ERROR(build->pakfire, "Could not read script into memory: %m\n");
		goto ERROR;
	}

	// Execute the script
	r = pakfire_jail_exec_script(build->jail, script, size, args, output);
	if (r) {
		ERROR(build->pakfire, "Script '%s' failed with status %d\n", filename, r);
	}

ERROR:
	if (script)
		free(script);

	return r;
}

static int pakfire_build_find_dependencies(struct pakfire_build* build,
		struct pakfire_package* pkg, struct pakfire_filelist* filelist, const char* buildroot) {
	char* provides = NULL;
	char* requires = NULL;
	char path[PATH_MAX];

	// Allocate path to write the filelist to
	int r = pakfire_path(build->pakfire, path, "%s", "/var/tmp/.pakfire-filelist.XXXXXX");
	if (r)
		return 1;

	// Create a temporary file
	FILE* f = pakfire_mktemp(path, 0);
	if (!f)
		goto ERROR;

	// Write filelist to the temporary file
	r = pakfire_filelist_export(filelist, f);
	fclose(f);
	if (r) {
		ERROR(build->pakfire, "Could not export filelist: %m\n");
		goto ERROR;
	}

	const char* root = pakfire_get_path(build->pakfire);

	// Pass buildroot and the filelist as arguments
	const char* args[] = {
		buildroot, pakfire_path_relpath(root, path), NULL
	};

	// Find all provides
	r = pakfire_build_run_script(build, "find-provides", args, &provides);
	if (r) {
		ERROR(build->pakfire, "find-provides returned with error %d\n", r);
		goto ERROR;
	}

	// Find all requires
	r = pakfire_build_run_script(build, "find-requires", args, &requires);
	if (r) {
		ERROR(build->pakfire, "find-requires returned with error %d\n", r);
		goto ERROR;
	}

	// Add all provides to the package
	if (provides) {
		r = pakfire_str2deps(build->pakfire, pkg, PAKFIRE_PKG_PROVIDES, provides);
		if (r) {
			ERROR(build->pakfire, "Could not add provides: %m\n");
			goto ERROR;
		}
	}

	// Add all requires to the package
	if (requires) {
		r = pakfire_str2deps(build->pakfire, pkg, PAKFIRE_PKG_REQUIRES, requires);
		if (r) {
			ERROR(build->pakfire, "Could not add provides: %m\n");
			goto ERROR;
		}
	}

	// Success
	r = 0;

ERROR:
	if (provides)
		free(provides);
	if (requires)
		free(requires);
	unlink(path);

	return r;
}

static int append_to_array(const char*** array, const char* s) {
	unsigned int length = 0;

	// Determine the length of the existing array
	if (*array) {
		for (const char** element = *array; *element; element++)
			length++;
	}

	// Allocate space
	*array = reallocarray(*array, length + 2, sizeof(**array));
	if (!*array)
		return 1;

	// Append s and terminate the array
	(*array)[length] = s;
	(*array)[length + 1] = NULL;

	return 0;
}

static int pakfire_build_package_add_files(struct pakfire_build* build,
		struct pakfire_parser* makefile, const char* buildroot, const char* namespace,
		struct pakfire_package* pkg, struct pakfire_packager* packager) {
	struct pakfire_filelist* filelist = NULL;
	int r = 1;

	char** files = NULL;
	const char** includes = NULL;
	const char** excludes = NULL;

	// Fetch filelist from makefile
	files = pakfire_parser_get_split(makefile, namespace, "files", '\n');

	// No files to package?
	if (!files)
		return 0;

	// Split into includes and excludes
	for (char** file = files; *file; file++) {
		if (**file == '!')
			r = append_to_array(&excludes, *file);
		else
			r = append_to_array(&includes, *file);
		if (r)
			goto ERROR;
	}

	// Allocate a new filelist
	r = pakfire_filelist_create(&filelist, build->pakfire);
	if (r)
		goto ERROR;

	// Scan for files
	r = pakfire_filelist_scan(filelist, build->buildroot, includes, excludes);
	if (r)
		goto ERROR;

	const size_t length = pakfire_filelist_size(filelist);
	DEBUG(build->pakfire, "%zu file(s) found\n", length);

	// Nothing to do if the filelist is empty
	if (!length)
		goto ERROR;

	// Find dependencies
	r = pakfire_build_find_dependencies(build, pkg, filelist, buildroot);
	if (r) {
		ERROR(build->pakfire, "Finding dependencies failed: %m\n");
		goto ERROR;
	}

	// Add all files to the package
	r = pakfire_packager_add_files(packager, filelist);
	if (r)
		goto ERROR;

ERROR:
	if (filelist)
		pakfire_filelist_unref(filelist);
	if (files) {
		for (char** file = files; *file; file++)
			free(*file);
		free(files);
	}
	if (includes)
		free(includes);
	if (excludes)
		free(excludes);

	return r;
}

static int pakfire_build_add_scriptlet_requires(struct pakfire_build* build,
		struct pakfire_package* pkg, struct pakfire_scriptlet* scriptlet) {
	char* prerequires = NULL;
	char path[PATH_MAX];
	size_t size;
	int r;

	const char* root = pakfire_get_path(build->pakfire);

	// Make filename
	r = pakfire_path(build->pakfire, path, "%s", "/var/tmp/.pakfire-scriptlet.XXXXXX");
	if (r)
		return r;

	// Fetch scriptlet payload
	const char* data = pakfire_scriptlet_get_data(scriptlet, &size);

	// Create a temporary file
	FILE* f = pakfire_mktemp(path, 0);
	if (!f)
		return 1;

	// Write scriptlet
	ssize_t bytes_written = fwrite(data, 1, size, f);
	if (bytes_written < 0) {
		ERROR(build->pakfire, "Could not write to %s: %m\n", path);
		fclose(f);
		goto ERROR;
	}

	// Close file
	fclose(f);

	// Build commandline
	const char* args[] = {
		pakfire_path_relpath(root, path),
		NULL,
	};

	// Find all pre-requires
	r = pakfire_build_run_script(build, "find-prerequires", args, &prerequires);
	if (r)
		goto ERROR;

	// Add all pre-requires to the package
	if (prerequires) {
		r = pakfire_str2deps(build->pakfire, pkg, PAKFIRE_PKG_PREREQUIRES, prerequires);
		if (r) {
			ERROR(build->pakfire, "Could not add pre-requires: %m\n");
			goto ERROR;
		}
	}

ERROR:
	if (r && *path)
		unlink(path);
	if (prerequires)
		free(prerequires);
	return r;
}

static int pakfire_build_package_add_scriptlet(struct pakfire_build* build,
		struct pakfire_package* pkg, struct pakfire_packager* packager,
		const char* type, const char* data) {
	struct pakfire_scriptlet* scriptlet = NULL;
	char* shell = NULL;
	int r;

	// Wrap scriptlet into a shell script
	r = asprintf(&shell, "#!/bin/sh\n\nset -e\n\n%s\n\nexit 0\n", data);
	if (r < 0)
		goto ERROR;

	// Create a scriptlet
	r = pakfire_scriptlet_create(&scriptlet, build->pakfire, type, shell, 0);
	if (r)
		goto ERROR;

	// Add it to the package
	r = pakfire_packager_add_scriptlet(packager, scriptlet);
	if (r) {
		ERROR(build->pakfire, "Could not add scriptlet %s\n", type);
		goto ERROR;
	}

	// Add scriptlet requirements
	r = pakfire_build_add_scriptlet_requires(build, pkg, scriptlet);
	if (r) {
		ERROR(build->pakfire, "Could not add scriptlet requirements: %m\n");
		goto ERROR;
	}

	// Success
	r = 0;

ERROR:
	if (scriptlet)
		pakfire_scriptlet_unref(scriptlet);
	if (shell)
		free(shell);

	return r;
}

static int pakfire_build_package_add_scriptlets(struct pakfire_build* build,
		struct pakfire_parser* makefile, const char* namespace,
		struct pakfire_package* pkg, struct pakfire_packager* packager) {
	char name[NAME_MAX];
	int r;

	for (const char** type = pakfire_scriptlet_types; *type; type++) {
		r = pakfire_string_format(name, "scriptlet:%s", *type);
		if (r)
			return r;

		// Fetch the scriptlet
		char* data = pakfire_parser_get(makefile, namespace, name);
		if (!data)
			continue;

		// Add it to the package
		r = pakfire_build_package_add_scriptlet(build, pkg, packager, *type, data);
		if (r) {
			free(data);
			return r;
		}

		free(data);
	}

	return 0;
}

static int pakfire_build_package(struct pakfire_build* build, struct pakfire_parser* makefile,
		const char* buildroot, const char* namespace) {
	struct pakfire_package* pkg = NULL;
	struct pakfire_packager* packager = NULL;

	int r = 1;

	// Expand the handle into the package name
	char* name = pakfire_parser_expand(makefile, "packages", namespace);
	if (!name) {
		ERROR(build->pakfire, "Could not get package name: %m\n");
		goto ERROR;
	}

	INFO(build->pakfire, "Building package '%s'...\n", name);
	DEBUG(build->pakfire, "  buildroot = %s\n", buildroot);

	// Fetch build architecture
	const char* arch = pakfire_get_arch(build->pakfire);
	if (!arch)
		goto ERROR;

	// Fetch package from makefile
	r = pakfire_parser_create_package(makefile, &pkg, NULL, namespace, arch);
	if (r) {
		ERROR(build->pakfire, "Could not create package from makefile: %m\n");
		goto ERROR;
	}

	// Set distribution
	const char* distribution = pakfire_parser_get(makefile, NULL, "DISTRO_NAME");
	if (distribution) {
		r = pakfire_package_set_string(pkg, PAKFIRE_PKG_DISTRO, distribution);
		if (r)
			goto ERROR;
	}

	// Set build ID
	pakfire_package_set_uuid(pkg, PAKFIRE_PKG_BUILD_ID, build->id);

	// Set source package
	const char* source_name = pakfire_parser_get(makefile, NULL, "name");
	if (source_name) {
		r = pakfire_package_set_string(pkg, PAKFIRE_PKG_SOURCE_NAME, source_name);
		if (r)
			goto ERROR;
	}

	// Set source EVR
	const char* source_evr = pakfire_parser_get(makefile, NULL, "evr");
	if (source_evr) {
		r = pakfire_package_set_string(pkg, PAKFIRE_PKG_SOURCE_EVR, source_evr);
		if (r)
			goto ERROR;
	}

	// Set source arch
	r = pakfire_package_set_string(pkg, PAKFIRE_PKG_SOURCE_ARCH, "src");
	if (r)
		goto ERROR;

	// Create a packager
	r = pakfire_packager_create(&packager, build->pakfire, pkg);
	if (r)
		goto ERROR;

	// Add files
	r = pakfire_build_package_add_files(build, makefile, buildroot, namespace,
		pkg, packager);
	if (r)
		goto ERROR;

	// Add scriptlets
	r = pakfire_build_package_add_scriptlets(build, makefile, namespace,
		pkg, packager);
	if (r)
		goto ERROR;

	const char* path = pakfire_repo_get_path(build->repo);

	// Write the finished package
	r = pakfire_packager_finish_to_directory(packager, path, NULL);
	if (r) {
		ERROR(build->pakfire, "pakfire_packager_finish() failed: %m\n");
		goto ERROR;
	}

	// Cleanup all packaged files
	r = pakfire_packager_cleanup(packager);
	if (r)
		goto ERROR;

	// Success
	r = 0;

ERROR:
	if (packager)
		pakfire_packager_unref(packager);
	if (pkg)
		pakfire_package_unref(pkg);
	if (name)
		free(name);

	return r;
}

static int pakfire_build_package_dump(struct pakfire* pakfire,
		struct pakfire_package* pkg, void* p) {
	char* dump = pakfire_package_dump(pkg, PAKFIRE_PKG_DUMP_LONG);
	if (!dump)
		return 1;

	INFO(pakfire, "%s\n", dump);
	free(dump);

	return 0;
}

static int pakfire_build_packages(struct pakfire_build* build,
		struct pakfire_parser* makefile) {
	DEBUG(build->pakfire, "Creating packages...");
	int r = 1;

	const char* buildroot = pakfire_relpath(build->pakfire, build->buildroot);

	// Fetch a list all all packages
	char** packages = pakfire_parser_list_namespaces(makefile, "packages.package:*");
	if (!packages) {
		ERROR(build->pakfire, "Could not find any packages: %m\n");
		goto ERROR;
	}

	unsigned int num_packages = 0;

	// Count how many packages we have
	for (char** package = packages; *package; package++)
		num_packages++;

	DEBUG(build->pakfire, "Found %d package(s)\n", num_packages);

	// Build packages in reverse order
	for (int i = num_packages - 1; i >= 0; i--) {
		r = pakfire_build_package(build, makefile, buildroot, packages[i]);
		if (r)
			goto ERROR;
	}

	// Rescan the build repository to import all packages again
	r = pakfire_repo_scan(build->repo, 0);
	if (r)
		goto ERROR;

	// Fetch all packages
	r = pakfire_repo_create_packagelist(build->repo, &build->packages);
	if (r)
		goto ERROR;

	// Dump them all
	r = pakfire_packagelist_walk(build->packages, pakfire_build_package_dump, NULL);
	if (r)
		goto ERROR;

	// Success
	r = 0;

ERROR:
	if (packages)
		free(packages);

	return r;
}

static int pakfire_build_stage(struct pakfire_build* build,
		struct pakfire_parser* makefile, const char* stage) {
	char template[1024];

	// Prepare template for this stage
	int r = pakfire_string_format(template, TEMPLATE, stage);
	if (r)
		return r;

	// Fetch the environment
	char** envp = pakfire_parser_make_environ(makefile);

	// Create the build script
	char* script = pakfire_parser_expand(makefile, "build", template);
	if (!script) {
		ERROR(build->pakfire, "Could not generate the build script for stage '%s': %m\n",
			stage);
		goto ERROR;
	}

	INFO(build->pakfire, "Running build stage '%s'\n", stage);

	// Import environment
	// XXX is this a good idea?
	r = pakfire_jail_import_env(build->jail, (const char**)envp);
	if (r) {
		ERROR(build->pakfire, "Could not import environment: %m\n");
		goto ERROR;
	}

	// Run the script
	r = pakfire_jail_exec_script(build->jail, script, strlen(script), NULL, NULL);
	if (r) {
		ERROR(build->pakfire, "Build stage '%s' failed with status %d\n", stage, r);
	}

ERROR:
	if (envp) {
		for (char** e = envp; *e; e++)
			free(*e);
		free(envp);
	}
	if (script)
		free(script);

	return r;
}

static const char* post_build_scripts[] = {
	"remove-static-libs",
	"check-symlinks",
	"check-unsafe-files",
	"check-libraries",
	"check-rpaths",
	"check-buildroot",
	"check-include",
	"check-hardening",
	"check-interpreters",
	"check-fhs",
	"compress-man-pages",
	"strip",
	NULL,
};

static int pakfire_build_run_post_build_scripts(struct pakfire_build* build) {
	// Fetch buildroot
	const char* buildroot = pakfire_relpath(build->pakfire, build->buildroot);

	// Set default arguments for build scripts
	const char* args[] = {
		buildroot, NULL
	};

	// Run them one by one
	for (const char** script = post_build_scripts; *script; script++) {
		int r = pakfire_build_run_script(build, *script, args, NULL);
		if (r)
			return r;
	}

	return 0;
}

static void pakfire_build_free(struct pakfire_build* build) {
	if (build->packages)
		pakfire_packagelist_unref(build->packages);

	if (build->repo) {
		pakfire_repo_clean(build->repo, PAKFIRE_REPO_CLEAN_FLAGS_DESTROY);
		pakfire_repo_unref(build->repo);
	}

	if (build->jail)
		pakfire_jail_unref(build->jail);

	if (build->cgroup) {
		// Destroy the cgroup
		pakfire_cgroup_destroy(build->cgroup);

		// Free it
		pakfire_cgroup_unref(build->cgroup);
	}

	pakfire_unref(build->pakfire);
	free(build);
}

static int pakfire_build_parse_id(struct pakfire_build* build, const char* id) {
	int r;

	// Try parsing the Build ID
	if (id) {
		r = uuid_parse(id, build->id);
		if (r) {
			ERROR(build->pakfire, "Could not parse build ID '%s'\n", id);
			errno = EINVAL;
			return r;
		}

	// Otherwise initialize the Build ID with something random
	} else {
		uuid_generate_random(build->id);
	}

	// Store the ID as string, too
	uuid_unparse_lower(build->id, build->_id);

	return 0;
}

/*
	Sets up a new cgroup for this build
*/
static int pakfire_build_setup_cgroup(struct pakfire_build* build) {
	struct pakfire_config* config = NULL;
	char path[PATH_MAX];
	int r;

	// Compose path
	r = pakfire_string_format(path, "pakfire/build-%s", build->_id);
	if (r) {
		ERROR(build->pakfire, "Could not compose path for cgroup: %m\n");
		goto ERROR;
	}

	// Create a new cgroup
	r = pakfire_cgroup_open(&build->cgroup, build->pakfire, path,
		PAKFIRE_CGROUP_ENABLE_ACCOUNTING);
	if (r) {
		ERROR(build->pakfire, "Could not create cgroup for build %s: %m\n", build->_id);
		goto ERROR;
	}

	// Fetch config
	config = pakfire_get_config(build->pakfire);
	if (!config)
		goto ERROR;

	// Guarantee some minimum memory
	size_t memory_guaranteed = pakfire_config_get_bytes(config, "build",
		"memory_guaranteed", PAKFIRE_BUILD_MEMORY_GUARANTEED);
	if (memory_guaranteed) {
		r = pakfire_cgroup_set_guaranteed_memory(build->cgroup, memory_guaranteed);
		if (r)
			goto ERROR;
	}

	// Limit memory
	size_t memory_limit = pakfire_config_get_bytes(config, "build", "memory_limit", 0);
	if (memory_limit) {
		r = pakfire_cgroup_set_memory_limit(build->cgroup, memory_limit);
		if (r)
			goto ERROR;
	}

	// Set PID limit
	size_t pid_limit = pakfire_config_get_int(config, "build",
		"pid_limit", PAKFIRE_BUILD_PID_LIMIT);
	if (pid_limit) {
		r = pakfire_cgroup_set_pid_limit(build->cgroup, pid_limit);
		if (r)
			goto ERROR;
	}

ERROR:
	if (config)
		pakfire_config_unref(config);

	return r;
}

/*
	Sets up a new jail for this build
*/
static int pakfire_build_setup_jail(struct pakfire_build* build) {
	int r;

	// Create a new jail
	r = pakfire_jail_create(&build->jail, build->pakfire, 0);
	if (r) {
		ERROR(build->pakfire, "Could not create jail for build %s: %m\n", build->_id);
		return r;
	}

	// Connect the jail to our cgroup
	r = pakfire_jail_set_cgroup(build->jail, build->cgroup);
	if (r) {
		ERROR(build->pakfire, "Could not set cgroup for jail: %m\n");
		return r;
	}

	// Done
	return 0;
}

/*
	Sets up the ccache for this build
*/
static int pakfire_build_setup_ccache(struct pakfire_build* build) {
	char path[PATH_MAX];
	int r;

	// Check if we want a ccache
	if (pakfire_build_has_flag(build, PAKFIRE_BUILD_DISABLE_CCACHE)) {
		DEBUG(build->pakfire, "ccache usage has been disabled for this build\n");

		// Set CCACHE_DISABLE=1 so that if ccache is installed, it will disable itself
		r = pakfire_jail_set_env(build->jail, "CCACHE_DISABLE", "1");
		if (r) {
			ERROR(build->pakfire, "Could not disable ccache: %m\n");
			return r;
		}

		return 0;
	}

	// Compose path
	r = pakfire_cache_path(build->pakfire, path, "%s", "ccache");
	if (r) {
		ERROR(build->pakfire, "Could not compose ccache path: %m\n");
		return 1;
	}

	DEBUG(build->pakfire, "Mounting ccache from %s\n", path);

	// Ensure path exists
	r = pakfire_mkdir(path, 0755);
	if (r && errno != EEXIST) {
		ERROR(build->pakfire, "Could not create ccache directory %s: %m\n", path);
		return r;
	}

	// Bind-mount the directory
	r = pakfire_jail_bind(build->jail, path, CCACHE_DIR, MS_NOSUID|MS_NOEXEC|MS_NODEV);
	if (r) {
		ERROR(build->pakfire, "Could not mount ccache: %m\n");
		return r;
	}

	return 0;
}

static int pakfire_build_setup_repo(struct pakfire_build* build) {
	char path[PATH_MAX] = "/var/tmp/.pakfire-build-repo.XXXXXX";
	char url[PATH_MAX];
	int r;

	// Create a new repository
	r = pakfire_repo_create(&build->repo, build->pakfire, PAKFIRE_REPO_RESULT);
	if (r) {
		ERROR(build->pakfire, "Could not create repository %s: %m", PAKFIRE_REPO_RESULT);
		return r;
	}

	// Set description
	pakfire_repo_set_description(build->repo, _("Build Repository"));

	// Create a temporary directory
	const char* p = pakfire_mkdtemp(path);
	if (!p) {
		ERROR(build->pakfire, "Could not create a the build repository: %m\n");
		return 1;
	}

	// Format the URL
	r = pakfire_string_format(url, "file://%s", path);
	if (r)
		return r;

	// Set the URL
	pakfire_repo_set_baseurl(build->repo, url);

	return r;
}

PAKFIRE_EXPORT int pakfire_build_create(struct pakfire_build** build,
		struct pakfire* pakfire, const char* id, int flags) {
	int r;

	// Allocate build object
	struct pakfire_build* b = calloc(1, sizeof(*b));
	if (!b)
		return 1;

	// Reference pakfire
	b->pakfire = pakfire_ref(pakfire);

	// Initialize reference counter
	b->nrefs = 1;

	// Copy flags
	b->flags = flags;

	// Parse ID
	r = pakfire_build_parse_id(b, id);
	if (r)
		goto ERROR;

	// Setup repo
	r = pakfire_build_setup_repo(b);
	if (r)
		goto ERROR;

	// Create cgroup
	r = pakfire_build_setup_cgroup(b);
	if (r)
		goto ERROR;

	// Create jail
	r = pakfire_build_setup_jail(b);
	if (r)
		goto ERROR;

	// Setup ccache
	r = pakfire_build_setup_ccache(b);
	if (r)
		goto ERROR;

	*build = b;
	return 0;

ERROR:
	pakfire_build_free(b);
	return r;
}

PAKFIRE_EXPORT struct pakfire_build* pakfire_build_ref(struct pakfire_build* build) {
	++build->nrefs;

	return build;
}

PAKFIRE_EXPORT struct pakfire_build* pakfire_build_unref(struct pakfire_build* build) {
	if (--build->nrefs > 0)
		return build;

	pakfire_build_free(build);
	return NULL;
}

PAKFIRE_EXPORT int pakfire_build_set_target(
		struct pakfire_build* build, const char* target) {
	return pakfire_string_set(build->target, target);
}

static int pakfire_build_install_packages(struct pakfire_build* build,
		int* snapshot_needs_update) {
	char** packages = NULL;
	int r = 1;

	// Fetch configuration
	struct pakfire_config* config = pakfire_get_config(build->pakfire);
	if (!config) {
		ERROR(build->pakfire, "Could not fetch configuration: %m\n");
		r = 1;
		goto ERROR;
	}

	// Fetch build environment
	const char* requires = pakfire_config_get(config, "build", "requires", NULL);
	if (!requires) {
		ERROR(build->pakfire, "No build requirements have been defined\n");
		goto ERROR;
	}

	// Split requirements into packages
	packages = pakfire_string_split(requires, ',');
	if (!packages)
		goto ERROR;

	int changed = 0;

	// Install everything
	r = pakfire_install(build->pakfire, 0, 0, (const char**)packages, NULL, 0,
		&changed, NULL, NULL);
	if (r) {
		ERROR(build->pakfire, "Could not install build dependencies: %m\n");
		goto ERROR;
	}

	// Mark snapshot as changed if new packages were installed
	if (changed)
		*snapshot_needs_update = 1;

	// Update everything
	r = pakfire_sync(build->pakfire, 0, 0, &changed, NULL, NULL);
	if (r) {
		ERROR(build->pakfire, "Could not update packages: %m\n");
		goto ERROR;
	}

	// Has anything changed?
	if (changed)
		*snapshot_needs_update = 1;

	// Success
	r = 0;

ERROR:
	if (config)
		pakfire_config_unref(config);

	if (packages) {
		for (char** package = packages; *package; package++)
			free(*package);
		free(packages);
	}

	return r;
}

/*
	Initializes the build environment
*/
static int pakfire_build_init(struct pakfire_build* build) {
	char path[PATH_MAX];
	int r;

	// Don't do it again
	if (build->init) {
		DEBUG(build->pakfire, "Build environment has already been initialized\n");
		return 0;
	}

	// Compose path for snapshot
	r = pakfire_cache_path(build->pakfire, path, "%s", "snapshot.tar.zst");
	if (r) {
		ERROR(build->pakfire, "Could not compose snapshot path: %m\n");
		return 1;
	}

	// Tells us whether we need to (re-)create the snapshot
	int snapshot_needs_update = 0;

	// Extract snapshot
	if (!pakfire_build_has_flag(build, PAKFIRE_BUILD_DISABLE_SNAPSHOT)) {
		// Try restoring the snapshot
		r = pakfire_snapshot_restore(build->pakfire, path);
		if (r && errno != ENOENT)
			return r;
	}

	// Install or update any build dependencies
	r = pakfire_build_install_packages(build, &snapshot_needs_update);
	if (r)
		return r;

	// Update the snapshot if there were changes
	if (!pakfire_build_has_flag(build, PAKFIRE_BUILD_DISABLE_SNAPSHOT) && snapshot_needs_update) {
		// Create a new snapshot
		r = pakfire_snapshot_create(build->pakfire, path);
		if (r)
			return r;
	}

	// Mark as initialized
	build->init = 1;

	return 0;
}

static int pakfire_build_read_makefile(struct pakfire_build* build,
		struct pakfire_parser** parser, struct pakfire_package* package) {
	char path[PATH_MAX];
	int r;

	struct pakfire_parser_error* error = NULL;

	const char* nevra = pakfire_package_get_string(package, PAKFIRE_PKG_NEVRA);
	const char* name  = pakfire_package_get_string(package, PAKFIRE_PKG_NAME);

	// Compose path to makefile
	r = pakfire_path(build->pakfire, path, "/usr/src/packages/%s/%s.nm", nevra, name);
	if (r < 0)
		return 1;

	// Read makefile
	r = pakfire_read_makefile(parser, build->pakfire, path, &error);
	if (r) {
		if (error) {
			ERROR(build->pakfire, "Could not parse makefile %s: %s\n", path,
				pakfire_parser_error_get_message(error));
		} else {
			ERROR(build->pakfire, "Could not parse makefile %s: %m\n", path);
		}

		goto ERROR;
	}

	// Set BUILDROOT
	const char* buildroot = pakfire_relpath(build->pakfire, build->buildroot);
	if (buildroot)
		pakfire_parser_set(*parser, NULL, "BUILDROOT", buildroot, 0);

ERROR:
	if (error)
		pakfire_parser_error_unref(error);

	return r;
}

static int pakfire_build_perform(struct pakfire_build* build,
		struct pakfire_parser* makefile) {
	int r;

	// Prepare the build
	r = pakfire_build_stage(build, makefile, "prepare");
	if (r)
		goto ERROR;

	// Perform the build
	r = pakfire_build_stage(build, makefile, "build");
	if (r)
		goto ERROR;

	// Test the build
	if (!pakfire_build_has_flag(build, PAKFIRE_BUILD_DISABLE_TESTS)) {
		r = pakfire_build_stage(build, makefile, "test");
		if (r)
			goto ERROR;
	}

	// Install everything
	r = pakfire_build_stage(build, makefile, "install");
	if (r)
		goto ERROR;

	// Run post build scripts
	r = pakfire_build_run_post_build_scripts(build);
	if (r)
		goto ERROR;

	// Done!
	return 0;

ERROR:
	// Drop to a shell for debugging
	if (pakfire_has_flag(build->pakfire, PAKFIRE_BUILD_INTERACTIVE))
		pakfire_build_shell(build);

	return r;
}

static int __pakfire_build_unpackaged_file(struct pakfire* pakfire,
		struct pakfire_file* file, void* p) {
	char* s = pakfire_file_dump(file);
	if (s) {
		ERROR(pakfire, "%s\n", s);
		free(s);
	}

	return 0;
}

static int pakfire_build_check_unpackaged_files(struct pakfire_build* build) {
	struct pakfire_filelist* filelist = NULL;
	int r;

	// Create a new filelist
	r = pakfire_filelist_create(&filelist, build->pakfire);
	if (r)
		goto ERROR;

	// Scan for all files in BUILDROOT
	r = pakfire_filelist_scan(filelist, build->buildroot, NULL, NULL);
	if (r)
		goto ERROR;

	const size_t length = pakfire_filelist_size(filelist);

	if (length) {
		ERROR(build->pakfire, "Unpackaged files found:\n");

		r = pakfire_filelist_walk(filelist, __pakfire_build_unpackaged_file, NULL);
		if (r)
			goto ERROR;

		// Report an error
		r = 1;
	}

ERROR:
	if (filelist)
		pakfire_filelist_unref(filelist);

	return r;
}

static int pakfire_build_install_package(struct pakfire* pakfire,
		struct pakfire_package* pkg, void* p) {
	struct pakfire_request* request = (struct pakfire_request*)p;

	return pakfire_request_add_package(request, PAKFIRE_REQ_INSTALL, pkg, 0);
}

static int pakfire_build_install_test(struct pakfire_build* build) {
	struct pakfire_request* request = NULL;
	struct pakfire_problem* problem = NULL;
	struct pakfire_solution* solution = NULL;
	const char* s = NULL;
	int r;

	// Create a new request
	r = pakfire_request_create(&request, build->pakfire, 0);
	if (r)
		goto ERROR;

	// Add all packages
	r = pakfire_packagelist_walk(build->packages, pakfire_build_install_package, request);

	// Solve the request
	r = pakfire_request_solve(request);
	switch (r) {
		// All okay
		case 0:
			break;

		// Dependency Error
		case 2:
			ERROR(build->pakfire, "Install test failed:\n");

			// Walk through all problems
			for (;;) {
				r = pakfire_request_next_problem(request, &problem);
				if (r)
					goto ERROR;

				// There are no more problems
				if (!problem)
					break;

				// Format the problem into something human-readable
				s = pakfire_problem_to_string(problem);
				if (!s)
					continue;

				ERROR(build->pakfire, "  * %s\n", s);

				// Walk through all solutions
				for (;;) {
					r = pakfire_problem_next_solution(problem, &solution);
					if (r)
						goto ERROR;

					// There are no more solutions
					if (!solution)
						break;

					// Format the solution into something human-readable
					s = pakfire_solution_to_string(solution);
					if (!s)
						continue;

					ERROR(build->pakfire, "    * %s\n", s);
				}
			}

			break;

		// Any other errors
		default:
			goto ERROR;
	}

ERROR:
	if (r)
		ERROR(build->pakfire, "Install test failed: %m\n");
	if (request)
		pakfire_request_unref(request);
	if (problem)
		pakfire_problem_unref(problem);
	if (solution)
		pakfire_solution_unref(solution);

	return r;
}

static int pakfire_build_post_check(struct pakfire_build* build) {
	int r;

	// Check for unpackaged files
	r = pakfire_build_check_unpackaged_files(build);
	if (r)
		return r;

	// Perform install test
	r = pakfire_build_install_test(build);
	if (r)
		return r;

	return 0;
}

static int pakfire_build_copy_package(struct pakfire* pakfire,
		struct pakfire_package* pkg, void* p) {
	struct pakfire_archive* archive = NULL;
	char path[PATH_MAX];
	int r;

	const char* target = (const char*)p;

	if (!target) {
		errno = EINVAL;
		return 1;
	}

	// Fetch the package filename
	const char* filename = pakfire_package_get_string(pkg, PAKFIRE_PKG_FILENAME);
	if (!filename) {
		r = 1;
		goto ERROR;
	}

	// Format the destination path
	r = pakfire_string_format(path, "%s/%s", target, filename);
	if (r)
		goto ERROR;

	// Open the archive
	archive = pakfire_package_get_archive(pkg);
	if (!archive) {
		r = 1;
		goto ERROR;
	}

	// Copy it to its destination
	r = pakfire_archive_copy(archive, path);
	if (r)
		goto ERROR;

ERROR:
	if (archive)
		pakfire_archive_unref(archive);

	return r;
}

static int pakfire_build_copy_packages(struct pakfire_build* build) {
	struct pakfire_repo* local = NULL;
	int r = 0;

	DEBUG(build->pakfire, "Copying built packages\n");

	// Fetch local repository
	local = pakfire_get_repo(build->pakfire, PAKFIRE_REPO_LOCAL);

	// Copy all packages to the target path
	if (*build->target) {
		r = pakfire_packagelist_walk(build->packages,
			pakfire_build_copy_package, build->target);
		if (r)
			goto ERROR;
	}

	// If we have a local repository, we copy all packages to it
	if (local) {
		const char* path = pakfire_repo_get_path(local);
		if (path) {
			r = pakfire_packagelist_walk(build->packages,
				pakfire_build_copy_package, (void*)path);
			if (r)
				goto ERROR;
		}
	}

ERROR:
	if (local)
		pakfire_repo_unref(local);

	return r;
}

static int pakfire_build_install_source_package(
		struct pakfire_build* build, struct pakfire_package* package) {
	struct pakfire_request* request = NULL;
	struct pakfire_transaction* transaction = NULL;
	int r;

	// Create a new request
	r = pakfire_request_create(&request, build->pakfire, 0);
	if (r)
		goto ERROR;

	// Add the package
	r = pakfire_request_add_package(request, PAKFIRE_REQ_INSTALL, package,
		PAKFIRE_REQUEST_ESSENTIAL);
	if (r)
		goto ERROR;

	// Solve the request
	r = pakfire_request_solve(request);
	if (r)
		goto ERROR;

	// Fetch the transaction
	r = pakfire_request_get_transaction(request, &transaction);
	if (r)
		goto ERROR;

	// Set how many packages have been changed
	const size_t changes = pakfire_transaction_count(transaction);

	// Sanity check to see if we actually try to install anything
	if (!changes) {
		ERROR(build->pakfire, "The source package did not get installed\n");
		r = 1;
		goto ERROR;
	}

	// Run the transaction
	r = pakfire_transaction_run(transaction, 0);
	if (r)
		goto ERROR;

ERROR:
	if (transaction)
		pakfire_transaction_unref(transaction);
	if (request)
		pakfire_request_unref(request);

	return r;
}

PAKFIRE_EXPORT int pakfire_build_exec(struct pakfire_build* build, const char* path) {
	struct pakfire_package* package = NULL;
	struct pakfire_parser* makefile = NULL;
	char* buildroot = NULL;
	int r;

	// Set buildroot
	r = pakfire_path(build->pakfire, build->buildroot, "%s", "/var/tmp/.pakfire-buildroot.XXXXXX");
	if (r)
		goto ERROR;

	// Open the source package
	r = pakfire_commandline_add(build->pakfire, path, &package);
	if (r)
		goto ERROR;

	const char* nevra = pakfire_package_get_string(package, PAKFIRE_PKG_NEVRA);

	INFO(build->pakfire, "Building %s...\n", nevra);

	// Initialize the build environment
	r = pakfire_build_init(build);
	if (r)
		goto ERROR;

	// Install the source package
	r = pakfire_build_install_source_package(build, package);
	if (r) {
		ERROR(build->pakfire, "Could not install the source package: %m\n");
		goto ERROR;
	}

	// Create BUILDROOT
	buildroot = pakfire_mkdtemp(build->buildroot);
	if (!buildroot) {
		ERROR(build->pakfire, "Could not create BUILDROOT: %m\n");
		goto ERROR;
	}

	// Open the makefile
	r = pakfire_build_read_makefile(build, &makefile, package);
	if (r)
		goto ERROR;

	// Perform the actual build
	r = pakfire_build_perform(build, makefile);
	if (r)
		goto ERROR;

	// Create the packages
	r = pakfire_build_packages(build, makefile);
	if (r) {
		ERROR(build->pakfire, "Could not create packages: %m\n");
		goto ERROR;
	}

	// Perform post build checks
	r = pakfire_build_post_check(build);
	if (r)
		goto ERROR;

	// Copy packages to their destination
	r = pakfire_build_copy_packages(build);
	if (r)
		goto ERROR;

ERROR:
	if (makefile)
		pakfire_parser_unref(makefile);
	if (package)
		pakfire_package_unref(package);

	// Cleanup buildroot
	if (buildroot)
		pakfire_rmtree(buildroot, 0);

	return r;
}

/*
	Compatibility function to keep the legacy API.
*/
PAKFIRE_EXPORT int pakfire_build(struct pakfire* pakfire, const char* path,
		const char* target, const char* id, int flags) {
	struct pakfire_build* build = NULL;
	int r;

	// Check if path is set
	if (!path) {
		errno = EINVAL;
		return 1;
	}

	// Create a new build environment
	r = pakfire_build_create(&build, pakfire, id, flags);
	if (r)
		goto ERROR;

	// Set target
	if (target) {
		r = pakfire_build_set_target(build, target);
		if (r)
			goto ERROR;
	}

	// Run build
	r = pakfire_build_exec(build, path);

ERROR:
	if (build)
		pakfire_build_unref(build);

	return r;
}

int pakfire_build_clean(struct pakfire* pakfire, int flags) {
	struct pakfire_repo* local = NULL;
	int r = 0;

	// Fetch local repository
	local = pakfire_get_repo(pakfire, PAKFIRE_REPO_LOCAL);
	if (!local) {
		ERROR(pakfire, "Could not find repository %s: %m\n", PAKFIRE_REPO_LOCAL);
		goto ERROR;
	}

	// Destroy everything in it
	r = pakfire_repo_clean(local, PAKFIRE_REPO_CLEAN_FLAGS_DESTROY);
	if (r)
		goto ERROR;

ERROR:
	if (local)
		pakfire_repo_unref(local);

	return r;
}

/*
	This is a convenience function that sets up a build environment and
	then drops the user into an interactive shell.
*/
PAKFIRE_EXPORT int pakfire_shell(struct pakfire* pakfire, const char** packages) {
	struct pakfire_build* build = NULL;
	int r;

	// Create a new build environment
	r = pakfire_build_create(&build, pakfire, NULL, PAKFIRE_BUILD_INTERACTIVE);
	if (r) {
		ERROR(pakfire, "Could not create build: %m\n");
		goto ERROR;
	}

	// Initialize the build environment
	r = pakfire_build_init(build);
	if (r)
		goto ERROR;

	// Install any additional packages
	if (packages) {
		r = pakfire_install(build->pakfire, 0, 0, packages, NULL, 0, NULL, NULL, NULL);
		if (r)
			return r;
	}

	// Run shell
	r = pakfire_build_shell(build);

ERROR:
	if (build)
		pakfire_build_unref(build);

	return r;
}