Re: [PATCH 02/14] prepare-kernel.sh: Add reverse mode

[Richard Weinberger <richard@sigma-star.at>]

Am Dienstag, 25. Juni 2024, 18:20:45 CEST schrieb 'Jan Kiszka' via upstream:
> On 24.06.24 22:33, Richard Weinberger wrote:
> > There is currently no way to undo preparing of a kernel, except using
> > --outpatch and reverting the resulting patch later.
> > But in link mode the kernel tree needs manual cleaning,
> > which can be tedious if a git clean -f -d -x is not possible.
> > 
> > The new --reverse flag offers this feature, it removes all previously
> > created symlinks and directories.
> > To be able to undo effects by patch_append(), keep a .orig file link
> > as the script already does for symlinks in the linux tree.
> > 
> > Signed-off-by: Richard Weinberger <richard@nod.at>
> > ---
> >  scripts/prepare-kernel.sh | 71 +++++++++++++++++++++++++++++++--------
> >  1 file changed, 57 insertions(+), 14 deletions(-)
> > 
> > diff --git a/scripts/prepare-kernel.sh b/scripts/prepare-kernel.sh
> > index 9299aaa97..f294ef0fa 100755
> > --- a/scripts/prepare-kernel.sh
> > +++ b/scripts/prepare-kernel.sh
> > @@ -55,6 +55,8 @@ patch_append() {
> >  		if test -L "$linux_tree/$file" ; then
> >  			mv "$linux_tree/$file" "$linux_tree/$file.orig"
> >  			cp "$linux_tree/$file.orig" "$linux_tree/$file"
> > +		else
> > +			cp "$linux_tree/$file" "$linux_tree/$file.orig"
> >  		fi
> >  		chmod +w "$linux_tree/$file"
> >  		cat >> "$linux_tree/$file"
> > @@ -66,6 +68,16 @@ patch_append() {
> >  	fi
> >  }
> >  
> > +patch_reverse() {
> > +	file="$1"
> > +	if test "x$output_patch" = "x"; then
> > +		if test -L "$linux_tree/$file" ; then
> > +			rm "$linux_tree/$file"
> > +		fi
> > +		mv "$linux_tree/$file.orig" "$linux_tree/$file"
> > +	fi
> > +}
> > +
> >  patch_link() {
> >  	recursive="$1"		   # "r" or "n"
> >  	link_file="$2"		   # "m", "n" or some file (basename) from $target_dir
> > @@ -104,11 +116,15 @@ patch_link() {
> >  		f=`echo $f | cut -d/ -f2-`
> >  		d=`dirname $f`
> >  		if test "x$output_patch" = "x"; then
> > -			mkdir -p $linux_tree/$link_dir/$d
> > -			if test x$forcelink = x1 -o \
> > -				! $xenomai_root/$target_dir/$f -ef $linux_tree/$link_dir/$f;
> > -			then
> > -				ln -sf $xenomai_root/$target_dir/$f $linux_tree/$link_dir/$f
> > +			if test x$reverse = x1; then
> > +				rm -f $linux_tree/$link_dir/$f
> > +			else
> > +				mkdir -p $linux_tree/$link_dir/$d
> > +				if test x$forcelink = x1 -o \
> > +					! $xenomai_root/$target_dir/$f -ef $linux_tree/$link_dir/$f;
> > +				then
> > +					ln -sf $xenomai_root/$target_dir/$f $linux_tree/$link_dir/$f
> > +				fi
> >  			fi
> >  		else
> >  			if test `check_filter $link_dir/$f` = "ok"; then
> > @@ -120,6 +136,11 @@ patch_link() {
> >  			fi
> >  		fi
> >  	done
> > +	if test x$reverse = x1; then
> > +		if ! find $linux_tree/$link_dir -not -type d | grep -q . ; then
> > +			rm -rf $linux_tree/$link_dir
> > +		fi
> > +	fi
> >  	)
> >  }
> >  
> > @@ -135,8 +156,7 @@ generate_patch() {
> >  	)
> >  }
> >  
> > -
> > -usage='usage: prepare-kernel --linux=<linux-tree> [--dovetail=<dovetail-patch>] [--arch=<arch>] [--outpatch=<file> [--filterkvers=y|n] [--filterarch=y|n]] [--forcelink] [--default] [--verbose]'
> > +usage='usage: prepare-kernel --linux=<linux-tree> [--dovetail=<dovetail-patch>] [--arch=<arch>] [--outpatch=<file> [--filterkvers=y|n] [--filterarch=y|n]] [--forcelink] [--default] [--verbose] [--reverse]'
> >  me=`basename $0`
> >  
> >  while test $# -gt 0; do
> > @@ -172,6 +192,9 @@ while test $# -gt 0; do
> >  	--verbose)
> >  		verbose=1
> >  	;;
> > +	--reverse)
> > +		reverse=1
> > +	;;
> >  	--help)
> >  		echo "$usage"
> >  		exit 0
> > @@ -221,6 +244,13 @@ if test \! -r $linux_tree/Makefile; then
> >  	exit 2
> >  fi
> >  
> > +if test x$reverse = x1; then
> > +	if ! grep -q CONFIG_XENOMAI $linux_tree/arch/$linux_arch/Makefile; then
> > +		echo "$me: $linux_tree is not prepared with Xenomai" >&2
> > +		exit 2
> > +	fi
> > +fi
> > +
> >  # Create an empty output patch file, and initialize the temporary tree.
> >  if test "x$output_patch" != "x"; then
> >  	temp_tree=`mktemp -d prepare-kernel-XXX --tmpdir`
> > @@ -229,6 +259,11 @@ if test "x$output_patch" != "x"; then
> >  		exit 1
> >  	fi
> >  
> > +	if test x$reverse = x1; then
> > +		echo "$me: --reverse and --outpatch are not compatible"
> > +		exit 1
> > +	fi
> > +
> >  	patchdir=`dirname $output_patch`
> >  	patchdir=`cd $patchdir && pwd`
> >  	output_patch=$patchdir/`basename $output_patch`
> > @@ -364,10 +399,11 @@ case $linux_VERSION.$linux_PATCHLEVEL in
> >  test "x$CONFIG_XENO_REVISION_LEVEL" = "x" && CONFIG_XENO_REVISION_LEVEL=0
> >  
> >  	if ! grep -q CONFIG_XENOMAI $linux_tree/arch/$linux_arch/Makefile; then
> > -		p="KBUILD_CFLAGS += -I\$(srctree)/arch/\$(SRCARCH)/xenomai/include -I\$(srctree)/include/xenomai"
> > -		(echo; echo $p) | patch_append arch/$linux_arch/Makefile
> > -		p="core-\$(CONFIG_XENOMAI)	+= arch/$linux_arch/xenomai/"
> > -		echo $p | patch_append arch/$linux_arch/Makefile
> > +		p1="KBUILD_CFLAGS += -I\$(srctree)/arch/\$(SRCARCH)/xenomai/include -I\$(srctree)/include/xenomai"
> > +		p2="core-\$(CONFIG_XENOMAI)	+= arch/$linux_arch/xenomai/"
> > +		(echo; echo $p1; echo $p2) | patch_append arch/$linux_arch/Makefile
> > +	elif test x$reverse = x1; then
> > +		patch_reverse arch/$linux_arch/Makefile
> >  	fi
> >  
> >  	patch_architecture_specific="n"
> > @@ -375,11 +411,15 @@ test "x$CONFIG_XENO_REVISION_LEVEL" = "x" && CONFIG_XENO_REVISION_LEVEL=0
> >  	if ! grep -q CONFIG_XENOMAI $linux_tree/drivers/Makefile; then
> >  		p="obj-\$(CONFIG_XENOMAI)		+= xenomai/"
> >  		( echo ; echo $p ) | patch_append drivers/Makefile
> > +	elif test x$reverse = x1; then
> > +		patch_reverse drivers/Makefile
> >  	fi
> >  
> >  	if ! grep -q CONFIG_XENOMAI $linux_tree/kernel/Makefile; then
> >  		p="obj-\$(CONFIG_XENOMAI)		+= xenomai/"
> >  		( echo ; echo $p ) | patch_append kernel/Makefile
> > +	elif test x$reverse = x1; then
> > +		patch_reverse kernel/Makefile
> >  	fi
> >  	;;
> >  esac
> > @@ -387,13 +427,15 @@ esac
> >  # Create local directories then symlink to the source files from
> >  # there, so that we don't pollute the Xenomai source tree with
> >  # compilation files.
> > +#
> > +# Keep link dirs (4th parameter) descending, otherwise --reverse
> > +# is not able to cleanup these directories!
> >  
> >  patch_kernelversion_specific="n"
> >  patch_architecture_specific="y"
> >  patch_link r m kernel/cobalt/arch/$linux_arch arch/$linux_arch/xenomai
> >  patch_link n n kernel/cobalt/include/dovetail arch/$linux_arch/include/dovetail
> >  patch_architecture_specific="n"
> > -patch_link n m kernel/cobalt kernel/xenomai
> >  patch_link n cobalt-core.h kernel/cobalt/trace include/trace/events
> >  patch_link n cobalt-rtdm.h kernel/cobalt/trace include/trace/events
> >  patch_link n cobalt-posix.h kernel/cobalt/trace include/trace/events
> > @@ -401,14 +443,15 @@ patch_link r n kernel/cobalt/include/asm-generic/xenomai include/asm-generic/xen
> >  patch_link n m kernel/cobalt/posix kernel/xenomai/posix
> >  patch_link n m kernel/cobalt/rtdm kernel/xenomai/rtdm
> >  patch_link n m kernel/cobalt/dovetail kernel/xenomai/pipeline
> > +patch_link n m kernel/cobalt kernel/xenomai
> >  patch_link r m kernel/drivers drivers/xenomai
> >  patch_link n n include/cobalt/kernel include/xenomai/cobalt/kernel
> > -patch_link r n include/cobalt/kernel/rtdm include/xenomai/rtdm
> >  patch_link r n include/cobalt/kernel/dovetail/pipeline include/xenomai/pipeline
> >  patch_link r n include/cobalt/uapi include/xenomai/cobalt/uapi
> >  patch_link r n include/rtdm/uapi include/xenomai/rtdm/uapi
> > -patch_link n version.h include/xenomai include/xenomai
> > +patch_link r n include/cobalt/kernel/rtdm include/xenomai/rtdm
> >  patch_link n stdarg.h kernel/cobalt/include/linux include/xenomai/linux
> > +patch_link n version.h include/xenomai include/xenomai
> >  
> >  if test "x$output_patch" != "x"; then
> >  	if test x$verbose = x1; then
> 
> This breaks rtdm/uapi/rtdm.h, at least. Didn't debug yet, just bisected.

I found the problem.
The order of calls to patch_link() matters in wicked ways. :-/
It used to work before I have further "cleaned up".

I'll look into a fix after dinner.

Thanks,
//richard

-- 
​​​​​sigma star gmbh | Eduard-Bodem-Gasse 6, 6020 Innsbruck, AUT
UID/VAT Nr: ATU 66964118 | FN: 374287y