live-build/scripts/build/chroot_sysfs

#!/bin/sh

## live-build(7) - System Build Scripts
## Copyright (C) 2016-2020 The Debian Live team
## Copyright (C) 2006-2015 Daniel Baumann <mail@daniel-baumann.ch>
##
## This program comes with ABSOLUTELY NO WARRANTY; for details see COPYING.
## This is free software, and you are welcome to redistribute it
## under certain conditions; see COPYING for details.


set -e

# Including common functions
[ -e "${LIVE_BUILD}/scripts/build.sh" ] && . "${LIVE_BUILD}/scripts/build.sh" || . /usr/lib/live/build.sh

# Setting static variables
DESCRIPTION="Mount /sys"
USAGE="${PROGRAM} {install|remove} [--force]"

# Processing arguments and configuration files
Init_config_data "${@}"

_ACTION="${1}"
shift

# Requiring stage file
Require_stagefiles config bootstrap

case "${_ACTION}" in
	install)
		Echo_message "Begin mounting /sys..."

		# Checking stage file
		Check_stagefile

		# Acquire lock file
		Acquire_lockfile

		# Create mountpoint
		mkdir -p chroot/sys

		# Mounting /sys
		mount -t sysfs -o x-gvfs-hide sysfs-live chroot/sys

		# Creating stage file
		Create_stagefile
		;;

	remove)
		Echo_message "Begin unmounting /sys..."

		# Checking stage file
		Ensure_stagefile_exists

		# Acquire lock file
		Acquire_lockfile

		# Unmounting /sys/firmware/efi/efivars
		if mountpoint -q chroot/sys/firmware/efi/efivars
		then
			umount chroot/sys/firmware/efi/efivars
		fi

		# Unmounting /sys
		if [ -e chroot/sys/class ]
		then
			umount chroot/sys
		fi

		# Removing stage file
		Remove_stagefile
		;;

	*)
		Echo_error "Invalid action parameter: '${_ACTION}'"
		Usage --fail
		;;
esac
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`#!/bin/sh`

Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`## live-build(7) - System Build Scripts`
amend copyright & licensing blocks Current versions of the project files are built upon versions published and licensed by Daniel Baumann, but are modified copies of those files and thus need to be marked as such per licensing requirements (afaik he did not pass along ownership / licensing rights to anyone when he left the project). We should also be careful to not be misrepresenting such modified copies as being attributed to Daniel. Adding a new copyright line referring to "The Debian Live team" should suffice for this. The authorship block in man pages has also similarly been updated. Notes: - tweaked a copy of daniel copyright lines stating 2014 instead of 2015. both of these cases were in files that i had personally introduced in some of my past merged commits that moved some code around. i don't know why they stated 2014. - binary_onie was introduced in 2018, so that has a 2018 date instead of 2016 unlike the rest. - 'efi-image' is a 3rd-party (Canonical Ltd) work that we bundle, but it has been modified by 674794a8f4d61a729d2dbd6d99385d2826138694 and 36a3ba76347ef72df1c316312ed3a26aa4b0c816 so I similarly added a debian live copyright line. - 'grub-cpmodules' is similar. it was only changed by the indentation fix of 36a3ba76347ef72df1c316312ed3a26aa4b0c816 but modification is modification, and this does help cover any possible future changes that might be made. 2020-03-11 09:07:21 -01:00			`## Copyright (C) 2016-2020 The Debian Live team`
Updating year in copyright notices to 2015. 2015-01-04 18:05:39 -01:00			`## Copyright (C) 2006-2015 Daniel Baumann <mail@daniel-baumann.ch>`
Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`##`
Updating GPL standard header in all files. 2012-07-29 23:59:00 +00:00			`## This program comes with ABSOLUTELY NO WARRANTY; for details see COPYING.`
Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`## This is free software, and you are welcome to redistribute it`
			`## under certain conditions; see COPYING for details.`

Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
			`set -e`

Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Including common functions`
Making build.sh sourcing more robust (Closes: #684896). 2012-08-27 13:52:29 +00:00			`[ -e "${LIVE_BUILD}/scripts/build.sh" ] && . "${LIVE_BUILD}/scripts/build.sh" \|\| . /usr/lib/live/build.sh`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Setting static variables`
help/usage: fix overly complex script description handling Closes: #952887 2015-02-05 02:30:47 -01:00			`DESCRIPTION="Mount /sys"`
Adding live-helper 1.0~a3-1. 2007-09-23 08:04:48 +00:00			`USAGE="${PROGRAM} {install\|remove} [--force]"`

tidy script init (1/4) - arg and config processing Partial fix for #952919 Gbp-Dch: Short 2015-02-05 02:30:47 -01:00			`# Processing arguments and configuration files`
			`Init_config_data "${@}"`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
adjust action arg consumption order did not properly consider all usage cases properly in deciding placement. this captured `--usage` in `$PROGRAM --usage` as the action for instance. Gbp-Dch: Ignore 2020-05-02 23:58:18 +00:00			`_ACTION="${1}"`
			`shift`

Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`# Requiring stage file`
stagefiles: s/Require_stagefile/Require_stagefiles/ this function takes one or more required stage fileS _plural_, and exits if any are missing (or at least it does now after the refactor). let's rename it to make things more clear Gbp-Dch: Short 2020-03-15 12:05:44 -01:00			`Require_stagefiles config bootstrap`
stagefiles: simplify & robustify - avoid all need to pass ".build/" path in stage file names into the functions - add a helper to remove a stage file (required to complete the above properly) - avoid duplicating filenames within scripts which makes them prone to mistakes (some instances of which I've actually encountered and had to fix) Gbp-Dch: Short 2020-03-12 00:21:39 -01:00
output error for incorrect action in chroot prep scripts ...alongside printing usage (which is perhaps unnecessary), so that it is actually clear to users that a problem occurred, and what. and capture it before option processing of remaining args. Gbp-Dch: Ignore 2020-05-02 12:41:01 +00:00			`case "${_ACTION}" in`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`install)`
Outputting an own message when having more than one case in a helper, instead of a global one. 2007-11-13 10:49:43 -01:00			`Echo_message "Begin mounting /sys..."`

Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`# Checking stage file`
stagefiles: further robustify with auto filenames as suggested by Raphaël rather than have fixed stagefile filename strings at all in the scripts, use `$(basename $0)` to use the name of the script (which is the same for almost all cases anyway, and the stage files are supposed to be almost exclusively unique per-script). we can thus simplify things by determining the filename for most use cases within the functions themselves. this does change the file used by a couple of scripts, affecting backwards compatibility of executing live-build upon an existing partially or fully completed build: - binary_grub-pc used "binary_grub" - chroot_includes used "includes.chroot" care had to be taken for the following cases: - there are some cases like bootstrap_cache, source_debian and bootstrap_debootstrap which are dealing with more than one file, and/or otherwise a filename that is not specific to the script itself exactly, or should not be based upon its name. - some cases like chroot_cache, bootstrap_cache and chroot_install-packages need to append something to the end of the name depending upon which pass/action mode the script is being executed with. - furthermore in the bootstrap_cache case one of the filenames is used within the bootstrap_debootstrap and thus needs very careful handling to be certain that a change in filename of bootstrap_cache does not break bootstrap_debootstrap. Gbp-Dch: Short 2020-03-13 16:11:53 -01:00			`Check_stagefile`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
fix comment typo Gbp-Dch: Ignore 2020-03-13 15:19:59 -01:00			`# Acquire lock file`
locks: tidy lock acquisition Combine the check+create done in each script. (The original functions are still callable as before, but a new combined `Aquire_lockfile` function can be called instead, as now used). Note, a further simplification could be done in removing the passing of the lock filename in as a parameter since every use of the functions is with ".lock". The lock functions already have a fallback to ".build/lock" though. Checking the history, the fallback used to be for a system wide lock, which was then replaced with this config-tree specific one. As long as that is not used implicitly by 3rd-party hooks then surely we are free to change the fallback to ".lock" and further remove passing in a name as a param...? history: db5d2b0dcdae96e712661605e17bc9875e224f9f 0aa8289a3773fd8a3885090b72622c2f95ab099c Gbp-Dch: Short Closes: #952918 2015-02-05 02:30:47 -01:00			`Acquire_lockfile`
Adding live-helper 1.0~a6-1. 2007-09-23 08:04:50 +00:00
Removing incomplete support for fakeroot. 2013-02-18 11:56:07 -01:00			`# Create mountpoint`
			`mkdir -p chroot/sys`

			`# Mounting /sys`
hide mountpoints from nautilus when building within a home directory, as /proc, /sys, etc are mounted and unmounted into the chroot at various points in the build, corresponding entries appear and disappear within the side panel of nautilus. this is obviously undesirable. use of `-o x-gvfs-hide` resolves this for the most part. i still see items occasionally pop up and having spent some time experimenting, i'm putting it down to buggy behaviour on the part of nautilus. (aside from those appearing when debootstrap is running - debootstrap also needs this fix). Gbp-Dch: Short 2020-03-12 13:52:58 -01:00			`mount -t sysfs -o x-gvfs-hide sysfs-live chroot/sys`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
			`# Creating stage file`
stagefiles: further robustify with auto filenames as suggested by Raphaël rather than have fixed stagefile filename strings at all in the scripts, use `$(basename $0)` to use the name of the script (which is the same for almost all cases anyway, and the stage files are supposed to be almost exclusively unique per-script). we can thus simplify things by determining the filename for most use cases within the functions themselves. this does change the file used by a couple of scripts, affecting backwards compatibility of executing live-build upon an existing partially or fully completed build: - binary_grub-pc used "binary_grub" - chroot_includes used "includes.chroot" care had to be taken for the following cases: - there are some cases like bootstrap_cache, source_debian and bootstrap_debootstrap which are dealing with more than one file, and/or otherwise a filename that is not specific to the script itself exactly, or should not be based upon its name. - some cases like chroot_cache, bootstrap_cache and chroot_install-packages need to append something to the end of the name depending upon which pass/action mode the script is being executed with. - furthermore in the bootstrap_cache case one of the filenames is used within the bootstrap_debootstrap and thus needs very careful handling to be certain that a change in filename of bootstrap_cache does not break bootstrap_debootstrap. Gbp-Dch: Short 2020-03-13 16:11:53 -01:00			`Create_stagefile`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`;;`

			`remove)`
Outputting an own message when having more than one case in a helper, instead of a global one. 2007-11-13 10:49:43 -01:00			`Echo_message "Begin unmounting /sys..."`

stagefiles: guard unnecessary chroot removal just as most scripts are skipped if their stagefile exists (indicating that they have already been run to completion), including chroot preparation scripts in install mode, this implements the same guard for chroot prep remove mode, such that they exit early if their stagefile does not exist, indicating that the modification has already been removed. (also override-able by --force in the same way). this basically just uses a tweaked copy of Check_stagefile(). Gbp-Dch: Short 2020-04-02 19:23:57 +00:00			`# Checking stage file`
			`Ensure_stagefile_exists`

fix comment typo Gbp-Dch: Ignore 2020-03-13 15:19:59 -01:00			`# Acquire lock file`
locks: tidy lock acquisition Combine the check+create done in each script. (The original functions are still callable as before, but a new combined `Aquire_lockfile` function can be called instead, as now used). Note, a further simplification could be done in removing the passing of the lock filename in as a parameter since every use of the functions is with ".lock". The lock functions already have a fallback to ".build/lock" though. Checking the history, the fallback used to be for a system wide lock, which was then replaced with this config-tree specific one. As long as that is not used implicitly by 3rd-party hooks then surely we are free to change the fallback to ".lock" and further remove passing in a name as a param...? history: db5d2b0dcdae96e712661605e17bc9875e224f9f 0aa8289a3773fd8a3885090b72622c2f95ab099c Gbp-Dch: Short Closes: #952918 2015-02-05 02:30:47 -01:00			`Acquire_lockfile`
Adding live-helper 1.0~a6-1. 2007-09-23 08:04:50 +00:00
chroot_sysfs: umount efivarfs if mounted Trying to umount /sys currently fails if efivarfs is mounted under it. Umount it first. Bug: #1053457 2023-11-06 15:31:13 -01:00			`# Unmounting /sys/firmware/efi/efivars`
			`if mountpoint -q chroot/sys/firmware/efi/efivars`
			`then`
			`umount chroot/sys/firmware/efi/efivars`
			`fi`

Removing incomplete support for fakeroot. 2013-02-18 11:56:07 -01:00			`# Unmounting /sys`
			`if [ -e chroot/sys/class ]`
Adding option to allow building in fakeroot/fakechroot environment, thanks to An-Cheng Huang <ancheng@vyatta.com>. 2007-11-10 16:39:49 -01:00			`then`
Removing incomplete support for fakeroot. 2013-02-18 11:56:07 -01:00			`umount chroot/sys`
Adding option to allow building in fakeroot/fakechroot environment, thanks to An-Cheng Huang <ancheng@vyatta.com>. 2007-11-10 16:39:49 -01:00			`fi`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
			`# Removing stage file`
stagefiles: further robustify with auto filenames as suggested by Raphaël rather than have fixed stagefile filename strings at all in the scripts, use `$(basename $0)` to use the name of the script (which is the same for almost all cases anyway, and the stage files are supposed to be almost exclusively unique per-script). we can thus simplify things by determining the filename for most use cases within the functions themselves. this does change the file used by a couple of scripts, affecting backwards compatibility of executing live-build upon an existing partially or fully completed build: - binary_grub-pc used "binary_grub" - chroot_includes used "includes.chroot" care had to be taken for the following cases: - there are some cases like bootstrap_cache, source_debian and bootstrap_debootstrap which are dealing with more than one file, and/or otherwise a filename that is not specific to the script itself exactly, or should not be based upon its name. - some cases like chroot_cache, bootstrap_cache and chroot_install-packages need to append something to the end of the name depending upon which pass/action mode the script is being executed with. - furthermore in the bootstrap_cache case one of the filenames is used within the bootstrap_debootstrap and thus needs very careful handling to be certain that a change in filename of bootstrap_cache does not break bootstrap_debootstrap. Gbp-Dch: Short 2020-03-13 16:11:53 -01:00			`Remove_stagefile`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`;;`

			`*)`
output error for incorrect action in chroot prep scripts ...alongside printing usage (which is perhaps unnecessary), so that it is actually clear to users that a problem occurred, and what. and capture it before option processing of remaining args. Gbp-Dch: Ignore 2020-05-02 12:41:01 +00:00			`Echo_error "Invalid action parameter: '${_ACTION}'"`
Use descriptive parameter names for Usage() 2020-04-23 14:38:59 +00:00			`Usage --fail`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`;;`
			`esac`