[mirror_ubuntu-bionic-kernel.git] / scripts / gen_initramfs_list.sh

#!/bin/sh
# Copyright (C) Martin Schlemmer <azarah@nosferatu.za.org>
# Copyright (C) 2006 Sam Ravnborg <sam@ravnborg.org>
#
# Released under the terms of the GNU GPL
#
# Generate a cpio packed initramfs. It uses gen_init_cpio to generate
# the cpio archive, and then compresses it.
# The script may also be used to generate the inputfile used for gen_init_cpio
# This script assumes that gen_init_cpio is located in usr/ directory

# error out on errors
set -e

usage() {
cat << EOF
Usage:
$0 [-o <file>] [-u <uid>] [-g <gid>] {-d | <cpio_source>} ...
	-o <file>      Create compressed initramfs file named <file> using
		       gen_init_cpio and compressor depending on the extension
	-u <uid>       User ID to map to user ID 0 (root).
		       <uid> is only meaningful if <cpio_source> is a
		       directory.  "squash" forces all files to uid 0.
	-g <gid>       Group ID to map to group ID 0 (root).
		       <gid> is only meaningful if <cpio_source> is a
		       directory.  "squash" forces all files to gid 0.
	<cpio_source>  File list or directory for cpio archive.
		       If <cpio_source> is a .cpio file it will be used
		       as direct input to initramfs.
	-d             Output the default cpio list.

All options except -o and -l may be repeated and are interpreted
sequentially and immediately.  -u and -g states are preserved across
<cpio_source> options so an explicit "-u 0 -g 0" is required
to reset the root/group mapping.
EOF
}

# awk style field access
# $1 - field number; rest is argument string
field() {
	shift $1 ; echo $1
}

list_default_initramfs() {
	# echo usr/kinit/kinit
	:
}

default_initramfs() {
	cat <<-EOF >> ${output}
		# This is a very simple, default initramfs

		dir /dev 0755 0 0
		nod /dev/console 0600 0 0 c 5 1
		dir /root 0700 0 0
		# file /kinit usr/kinit/kinit 0755 0 0
		# slink /init kinit 0755 0 0
	EOF
}

filetype() {
	local argv1="$1"

	# symlink test must come before file test
	if [ -L "${argv1}" ]; then
		echo "slink"
	elif [ -f "${argv1}" ]; then
		echo "file"
	elif [ -d "${argv1}" ]; then
		echo "dir"
	elif [ -b "${argv1}" -o -c "${argv1}" ]; then
		echo "nod"
	elif [ -p "${argv1}" ]; then
		echo "pipe"
	elif [ -S "${argv1}" ]; then
		echo "sock"
	else
		echo "invalid"
	fi
	return 0
}

list_print_mtime() {
	:
}

print_mtime() {
	local my_mtime="0"

	if [ -e "$1" ]; then
		my_mtime=$(find "$1" -printf "%T@\n" | sort -r | head -n 1)
	fi

	echo "# Last modified: ${my_mtime}" >> ${output}
	echo "" >> ${output}
}

list_parse() {
	if [ -L "$1" ]; then
		return
	fi
	echo "$1" | sed 's/:/\\:/g; s/$/ \\/'
}

# for each file print a line in following format
# <filetype> <name> <path to file> <octal mode> <uid> <gid>
# for links, devices etc the format differs. See gen_init_cpio for details
parse() {
	local location="$1"
	local name="/${location#${srcdir}}"
	# change '//' into '/'
	name=$(echo "$name" | sed -e 's://*:/:g')
	local mode="$2"
	local uid="$3"
	local gid="$4"
	local ftype=$(filetype "${location}")
	# remap uid/gid to 0 if necessary
	[ "$root_uid" = "squash" ] && uid=0 || [ "$uid" -eq "$root_uid" ] && uid=0
	[ "$root_gid" = "squash" ] && gid=0 || [ "$gid" -eq "$root_gid" ] && gid=0
	local str="${mode} ${uid} ${gid}"

	[ "${ftype}" = "invalid" ] && return 0
	[ "${location}" = "${srcdir}" ] && return 0

	case "${ftype}" in
		"file")
			str="${ftype} ${name} ${location} ${str}"
			;;
		"nod")
			local dev=`LC_ALL=C ls -l "${location}"`
			local maj=`field 5 ${dev}`
			local min=`field 6 ${dev}`
			maj=${maj%,}

			[ -b "${location}" ] && dev="b" || dev="c"

			str="${ftype} ${name} ${str} ${dev} ${maj} ${min}"
			;;
		"slink")
			local target=`readlink "${location}"`
			str="${ftype} ${name} ${target} ${str}"
			;;
		*)
			str="${ftype} ${name} ${str}"
			;;
	esac

	echo "${str}" >> ${output}

	return 0
}

unknown_option() {
	printf "ERROR: unknown option \"$arg\"\n" >&2
	printf "If the filename validly begins with '-', " >&2
	printf "then it must be prefixed\n" >&2
	printf "by './' so that it won't be interpreted as an option." >&2
	printf "\n" >&2
	usage >&2
	exit 1
}

list_header() {
	:
}

header() {
	printf "\n#####################\n# $1\n" >> ${output}
}

# process one directory (incl sub-directories)
dir_filelist() {
	${dep_list}header "$1"

	srcdir=$(echo "$1" | sed -e 's://*:/:g')
	dirlist=$(find "${srcdir}" -printf "%p %m %U %G\n" | sort)

	# If $dirlist is only one line, then the directory is empty
	if [  "$(echo "${dirlist}" | wc -l)" -gt 1 ]; then
		${dep_list}print_mtime "$1"

		echo "${dirlist}" | \
		while read x; do
			${dep_list}parse ${x}
		done
	fi
}

# if only one file is specified and it is .cpio file then use it direct as fs
# if a directory is specified then add all files in given direcotry to fs
# if a regular file is specified assume it is in gen_initramfs format
input_file() {
	source="$1"
	if [ -f "$1" ]; then
		${dep_list}header "$1"
		is_cpio="$(echo "$1" | sed 's/^.*\.cpio\(\..*\)\?/cpio/')"
		if [ $2 -eq 0 -a ${is_cpio} = "cpio" ]; then
			cpio_file=$1
			echo "$1" | grep -q '^.*\.cpio\..*' && is_cpio_compressed="compressed"
			[ ! -z ${dep_list} ] && echo "$1"
			return 0
		fi
		if [ -z ${dep_list} ]; then
			print_mtime "$1" >> ${output}
			cat "$1"         >> ${output}
		else
		        echo "$1 \\"
			cat "$1" | while read type dir file perm ; do
				if [ "$type" = "file" ]; then
					echo "$file \\";
				fi
			done
		fi
	elif [ -d "$1" ]; then
		dir_filelist "$1"
	else
		echo "  ${prog}: Cannot open '$1'" >&2
		exit 1
	fi
}

prog=$0
root_uid=0
root_gid=0
dep_list=
cpio_file=
cpio_list=
output="/dev/stdout"
output_file=""
is_cpio_compressed=
compr="gzip -n -9 -f"

arg="$1"
case "$arg" in
	"-l")	# files included in initramfs - used by kbuild
		dep_list="list_"
		echo "deps_initramfs := $0 \\"
		shift
		;;
	"-o")	# generate compressed cpio image named $1
		shift
		output_file="$1"
		cpio_list="$(mktemp ${TMPDIR:-/tmp}/cpiolist.XXXXXX)"
		output=${cpio_list}
		echo "$output_file" | grep -q "\.gz$" \
                && [ -x "`which gzip 2> /dev/null`" ] \
                && compr="gzip -n -9 -f"
		echo "$output_file" | grep -q "\.bz2$" \
                && [ -x "`which bzip2 2> /dev/null`" ] \
                && compr="bzip2 -9 -f"
		echo "$output_file" | grep -q "\.lzma$" \
                && [ -x "`which lzma 2> /dev/null`" ] \
                && compr="lzma -9 -f"
		echo "$output_file" | grep -q "\.xz$" \
                && [ -x "`which xz 2> /dev/null`" ] \
                && compr="xz --check=crc32 --lzma2=dict=1MiB"
		echo "$output_file" | grep -q "\.lzo$" \
                && [ -x "`which lzop 2> /dev/null`" ] \
                && compr="lzop -9 -f"
		echo "$output_file" | grep -q "\.lz4$" \
                && [ -x "`which lz4 2> /dev/null`" ] \
                && compr="lz4 -l -9 -f"
		echo "$output_file" | grep -q "\.cpio$" && compr="cat"
		shift
		;;
esac
while [ $# -gt 0 ]; do
	arg="$1"
	shift
	case "$arg" in
		"-u")	# map $1 to uid=0 (root)
			root_uid="$1"
			[ "$root_uid" = "-1" ] && root_uid=$(id -u || echo 0)
			shift
			;;
		"-g")	# map $1 to gid=0 (root)
			root_gid="$1"
			[ "$root_gid" = "-1" ] && root_gid=$(id -g || echo 0)
			shift
			;;
		"-d")	# display default initramfs list
			default_list="$arg"
			${dep_list}default_initramfs
			;;
		"-h")
			usage
			exit 0
			;;
		*)
			case "$arg" in
				"-"*)
					unknown_option
					;;
				*)	# input file/dir - process it
					input_file "$arg" "$#"
					;;
			esac
			;;
	esac
done

# If output_file is set we will generate cpio archive and compress it
# we are careful to delete tmp files
if [ ! -z ${output_file} ]; then
	if [ -z ${cpio_file} ]; then
		timestamp=
		if test -n "$KBUILD_BUILD_TIMESTAMP"; then
			timestamp="$(date -d"$KBUILD_BUILD_TIMESTAMP" +%s || :)"
			if test -n "$timestamp"; then
				timestamp="-t $timestamp"
			fi
		fi
		cpio_tfile="$(mktemp ${TMPDIR:-/tmp}/cpiofile.XXXXXX)"
		usr/gen_init_cpio $timestamp ${cpio_list} > ${cpio_tfile}
	else
		cpio_tfile=${cpio_file}
	fi
	rm ${cpio_list}
	if [ "${is_cpio_compressed}" = "compressed" ]; then
		cat ${cpio_tfile} > ${output_file}
	else
		(cat ${cpio_tfile} | ${compr}  - > ${output_file}) \
		|| (rm -f ${output_file} ; false)
	fi
	[ -z ${cpio_file} ] && rm ${cpio_tfile}
fi
exit 0
Commit	Line	Data
153f0114	1	#!/bin/sh
1da177e4	2	# Copyright (C) Martin Schlemmer <azarah@nosferatu.za.org>
f6112ec2	3	# Copyright (C) 2006 Sam Ravnborg <sam@ravnborg.org>
1da177e4	4	#
d39a206b	5	# Released under the terms of the GNU GPL
1da177e4	6	#
d39a206b	7	# Generate a cpio packed initramfs. It uses gen_init_cpio to generate
a26ee60f	8	# the cpio archive, and then compresses it.
d39a206b SR	9	# The script may also be used to generate the inputfile used for gen_init_cpio
	10	# This script assumes that gen_init_cpio is located in usr/ directory
	11
	12	# error out on errors
	13	set -e
	14
	15	usage() {
	16	cat << EOF
	17	Usage:
	18	$0 [-o <file>] [-u <uid>] [-g <gid>] {-d \| <cpio_source>} ...
a26ee60f AK	19	-o <file> Create compressed initramfs file named <file> using
a26ee60f AK	20	gen_init_cpio and compressor depending on the extension
d39a206b	21	-u <uid> User ID to map to user ID 0 (root).
4c6f2eb9 MF	22	<uid> is only meaningful if <cpio_source> is a
4c6f2eb9 MF	23	directory. "squash" forces all files to uid 0.
d39a206b	24	-g <gid> Group ID to map to group ID 0 (root).
4c6f2eb9 MF	25	<gid> is only meaningful if <cpio_source> is a
4c6f2eb9 MF	26	directory. "squash" forces all files to gid 0.
d39a206b	27	<cpio_source> File list or directory for cpio archive.
f6112ec2	28	If <cpio_source> is a .cpio file it will be used
d39a206b SR	29	as direct input to initramfs.
	30	-d Output the default cpio list.
	31
	32	All options except -o and -l may be repeated and are interpreted
	33	sequentially and immediately. -u and -g states are preserved across
	34	<cpio_source> options so an explicit "-u 0 -g 0" is required
	35	to reset the root/group mapping.
	36	EOF
	37	}
	38
f6112ec2 OV	39	# awk style field access
	40	# $1 - field number; rest is argument string
	41	field() {
	42	shift $1 ; echo $1
	43	}
	44
d39a206b SR	45	list_default_initramfs() {
	46	# echo usr/kinit/kinit
	47	:
	48	}
1da177e4 LT	49
1da177e4 LT	50	default_initramfs() {
d39a206b	51	cat <<-EOF >> ${output}
1da177e4 LT	52	# This is a very simple, default initramfs
	53
	54	dir /dev 0755 0 0
	55	nod /dev/console 0600 0 0 c 5 1
	56	dir /root 0700 0 0
d39a206b SR	57	# file /kinit usr/kinit/kinit 0755 0 0
d39a206b SR	58	# slink /init kinit 0755 0 0
1da177e4 LT	59	EOF
	60	}
	61
	62	filetype() {
	63	local argv1="$1"
	64
	65	# symlink test must come before file test
	66	if [ -L "${argv1}" ]; then
	67	echo "slink"
	68	elif [ -f "${argv1}" ]; then
	69	echo "file"
	70	elif [ -d "${argv1}" ]; then
	71	echo "dir"
	72	elif [ -b "${argv1}" -o -c "${argv1}" ]; then
	73	echo "nod"
	74	elif [ -p "${argv1}" ]; then
	75	echo "pipe"
	76	elif [ -S "${argv1}" ]; then
	77	echo "sock"
	78	else
	79	echo "invalid"
	80	fi
	81	return 0
	82	}
	83
d39a206b SR	84	list_print_mtime() {
	85	:
	86	}
	87
1da177e4	88	print_mtime() {
1da177e4 LT	89	local my_mtime="0"
1da177e4 LT	90
d39a206b SR	91	if [ -e "$1" ]; then
d39a206b SR	92	my_mtime=$(find "$1" -printf "%T@\n" \| sort -r \| head -n 1)
1da177e4	93	fi
d39a206b SR	94
	95	echo "# Last modified: ${my_mtime}" >> ${output}
	96	echo "" >> ${output}
	97	}
	98
	99	list_parse() {
590abbdd MM	100	if [ -L "$1" ]; then
	101	return
	102	fi
	103	echo "$1" \| sed 's/:/\\:/g; s/$/ \\/'
1da177e4 LT	104	}
1da177e4 LT	105
d39a206b SR	106	# for each file print a line in following format
	107	# <filetype> <name> <path to file> <octal mode> <uid> <gid>
	108	# for links, devices etc the format differs. See gen_init_cpio for details
1da177e4 LT	109	parse() {
1da177e4 LT	110	local location="$1"
153f0114	111	local name="/${location#${srcdir}}"
1da177e4	112	# change '//' into '/'
153f0114	113	name=$(echo "$name" \| sed -e 's://*:/:g')
1da177e4 LT	114	local mode="$2"
	115	local uid="$3"
	116	local gid="$4"
	117	local ftype=$(filetype "${location}")
	118	# remap uid/gid to 0 if necessary
4c6f2eb9 MF	119	[ "$root_uid" = "squash" ] && uid=0 \|\| [ "$uid" -eq "$root_uid" ] && uid=0
4c6f2eb9 MF	120	[ "$root_gid" = "squash" ] && gid=0 \|\| [ "$gid" -eq "$root_gid" ] && gid=0
1da177e4 LT	121	local str="${mode} ${uid} ${gid}"
1da177e4 LT	122
153f0114 JS	123	[ "${ftype}" = "invalid" ] && return 0
153f0114 JS	124	[ "${location}" = "${srcdir}" ] && return 0
1da177e4 LT	125
	126	case "${ftype}" in
	127	"file")
	128	str="${ftype} ${name} ${location} ${str}"
	129	;;
	130	"nod")
f6112ec2 OV	131	local dev=`LC_ALL=C ls -l "${location}"`
	132	local maj=`field 5 ${dev}`
	133	local min=`field 6 ${dev}`
	134	maj=${maj%,}
	135
	136	[ -b "${location}" ] && dev="b" \|\| dev="c"
	137
	138	str="${ftype} ${name} ${str} ${dev} ${maj} ${min}"
1da177e4 LT	139	;;
1da177e4 LT	140	"slink")
b5a5e4c7	141	local target=`readlink "${location}"`
1da177e4 LT	142	str="${ftype} ${name} ${target} ${str}"
	143	;;
	144	*)
	145	str="${ftype} ${name} ${str}"
	146	;;
	147	esac
	148
d39a206b	149	echo "${str}" >> ${output}
1da177e4 LT	150
	151	return 0
	152	}
	153
d39a206b SR	154	unknown_option() {
	155	printf "ERROR: unknown option \"$arg\"\n" >&2
	156	printf "If the filename validly begins with '-', " >&2
	157	printf "then it must be prefixed\n" >&2
	158	printf "by './' so that it won't be interpreted as an option." >&2
	159	printf "\n" >&2
	160	usage >&2
	161	exit 1
	162	}
	163
	164	list_header() {
a26d79ca	165	:
d39a206b SR	166	}
	167
	168	header() {
	169	printf "\n#####################\n# $1\n" >> ${output}
	170	}
	171
	172	# process one directory (incl sub-directories)
	173	dir_filelist() {
	174	${dep_list}header "$1"
	175
	176	srcdir=$(echo "$1" \| sed -e 's://*:/:g')
9e6e0d5f	177	dirlist=$(find "${srcdir}" -printf "%p %m %U %G\n" \| sort)
d39a206b SR	178
	179	# If $dirlist is only one line, then the directory is empty
	180	if [ "$(echo "${dirlist}" \| wc -l)" -gt 1 ]; then
	181	${dep_list}print_mtime "$1"
	182
	183	echo "${dirlist}" \| \
	184	while read x; do
	185	${dep_list}parse ${x}
	186	done
	187	fi
1da177e4 LT	188	}
1da177e4 LT	189
d39a206b SR	190	# if only one file is specified and it is .cpio file then use it direct as fs
	191	# if a directory is specified then add all files in given direcotry to fs
	192	# if a regular file is specified assume it is in gen_initramfs format
	193	input_file() {
	194	source="$1"
	195	if [ -f "$1" ]; then
	196	${dep_list}header "$1"
c299ec2d	197	is_cpio="$(echo "$1" \| sed 's/^.\.cpio\(\..\)\?/cpio/')"
153f0114	198	if [ $2 -eq 0 -a ${is_cpio} = "cpio" ]; then
d39a206b	199	cpio_file=$1
c299ec2d	200	echo "$1" \| grep -q '^.\.cpio\..' && is_cpio_compressed="compressed"
d39a206b SR	201	[ ! -z ${dep_list} ] && echo "$1"
	202	return 0
	203	fi
	204	if [ -z ${dep_list} ]; then
	205	print_mtime "$1" >> ${output}
	206	cat "$1" >> ${output}
1da177e4	207	else
b8341936	208	echo "$1 \\"
46ed981d	209	cat "$1" \| while read type dir file perm ; do
153f0114	210	if [ "$type" = "file" ]; then
46ed981d SR	211	echo "$file \\";
	212	fi
	213	done
1da177e4	214	fi
d39a206b SR	215	elif [ -d "$1" ]; then
d39a206b SR	216	dir_filelist "$1"
1da177e4	217	else
d39a206b	218	echo " ${prog}: Cannot open '$1'" >&2
1da177e4 LT	219	exit 1
	220	fi
	221	}
	222
d39a206b	223	prog=$0
1da177e4 LT	224	root_uid=0
1da177e4 LT	225	root_gid=0
d39a206b SR	226	dep_list=
	227	cpio_file=
	228	cpio_list=
	229	output="/dev/stdout"
	230	output_file=""
c299ec2d	231	is_cpio_compressed=
6ae9ecb8	232	compr="gzip -n -9 -f"
1da177e4	233
d39a206b SR	234	arg="$1"
	235	case "$arg" in
	236	"-l") # files included in initramfs - used by kbuild
	237	dep_list="list_"
b8341936	238	echo "deps_initramfs := $0 \\"
d39a206b SR	239	shift
d39a206b SR	240	;;
a26ee60f	241	"-o") # generate compressed cpio image named $1
d39a206b SR	242	shift
	243	output_file="$1"
	244	cpio_list="$(mktemp ${TMPDIR:-/tmp}/cpiolist.XXXXXX)"
	245	output=${cpio_list}
9ba4bcb6	246	echo "$output_file" \| grep -q "\.gz$" \
	247	&& [ -x "`which gzip 2> /dev/null`" ] \
	248	&& compr="gzip -n -9 -f"
	249	echo "$output_file" \| grep -q "\.bz2$" \
	250	&& [ -x "`which bzip2 2> /dev/null`" ] \
	251	&& compr="bzip2 -9 -f"
	252	echo "$output_file" \| grep -q "\.lzma$" \
	253	&& [ -x "`which lzma 2> /dev/null`" ] \
	254	&& compr="lzma -9 -f"
	255	echo "$output_file" \| grep -q "\.xz$" \
	256	&& [ -x "`which xz 2> /dev/null`" ] \
	257	&& compr="xz --check=crc32 --lzma2=dict=1MiB"
	258	echo "$output_file" \| grep -q "\.lzo$" \
	259	&& [ -x "`which lzop 2> /dev/null`" ] \
	260	&& compr="lzop -9 -f"
	261	echo "$output_file" \| grep -q "\.lz4$" \
	262	&& [ -x "`which lz4 2> /dev/null`" ] \
5ec384d4	263	&& compr="lz4 -l -9 -f"
a26ee60f	264	echo "$output_file" \| grep -q "\.cpio$" && compr="cat"
d39a206b SR	265	shift
	266	;;
	267	esac
1da177e4 LT	268	while [ $# -gt 0 ]; do
	269	arg="$1"
	270	shift
	271	case "$arg" in
d39a206b	272	"-u") # map $1 to uid=0 (root)
1da177e4	273	root_uid="$1"
595a22ac	274	[ "$root_uid" = "-1" ] && root_uid=$(id -u \|\| echo 0)
1da177e4 LT	275	shift
1da177e4 LT	276	;;
d39a206b	277	"-g") # map $1 to gid=0 (root)
1da177e4	278	root_gid="$1"
595a22ac	279	[ "$root_gid" = "-1" ] && root_gid=$(id -g \|\| echo 0)
1da177e4 LT	280	shift
1da177e4 LT	281	;;
d39a206b	282	"-d") # display default initramfs list
1da177e4	283	default_list="$arg"
d39a206b	284	${dep_list}default_initramfs
1da177e4 LT	285	;;
	286	"-h")
	287	usage
	288	exit 0
	289	;;
	290	*)
	291	case "$arg" in
	292	"-"*)
d39a206b	293	unknown_option
1da177e4	294	;;
d39a206b SR	295	*) # input file/dir - process it
d39a206b SR	296	input_file "$arg" "$#"
1da177e4 LT	297	;;
	298	esac
	299	;;
	300	esac
	301	done
	302
a26ee60f	303	# If output_file is set we will generate cpio archive and compress it
25985edc	304	# we are careful to delete tmp files
d39a206b SR	305	if [ ! -z ${output_file} ]; then
d39a206b SR	306	if [ -z ${cpio_file} ]; then
a8b8017c MM	307	timestamp=
	308	if test -n "$KBUILD_BUILD_TIMESTAMP"; then
	309	timestamp="$(date -d"$KBUILD_BUILD_TIMESTAMP" +%s \|\| :)"
	310	if test -n "$timestamp"; then
	311	timestamp="-t $timestamp"
	312	fi
	313	fi
d39a206b	314	cpio_tfile="$(mktemp ${TMPDIR:-/tmp}/cpiofile.XXXXXX)"
a8b8017c	315	usr/gen_init_cpio $timestamp ${cpio_list} > ${cpio_tfile}
d39a206b SR	316	else
	317	cpio_tfile=${cpio_file}
	318	fi
	319	rm ${cpio_list}
c299ec2d AL	320	if [ "${is_cpio_compressed}" = "compressed" ]; then
	321	cat ${cpio_tfile} > ${output_file}
	322	else
ab59d3b7 AK	323	(cat ${cpio_tfile} \| ${compr} - > ${output_file}) \
ab59d3b7 AK	324	\|\| (rm -f ${output_file} ; false)
c299ec2d	325	fi
d39a206b SR	326	[ -z ${cpio_file} ] && rm ${cpio_tfile}
d39a206b SR	327	fi
1da177e4	328	exit 0