Introduce in-kernel headers and other artifacts which are made available as an archive through proc (/proc/kheaders.txz file). This archive makes it possible to build kernel modules, run eBPF programs, and other tracing programs that need to extend the kernel for tracing purposes without any dependency on the file system having headers and build artifacts.
On Android and embedded systems, it is common to switch kernels but not have kernel headers available on the file system. Raw kernel headers also cannot be copied into the filesystem like they can be on other distros, due to licensing and other issues. There's no linux-headers package on Android. Further once a different kernel is booted, any headers stored on the file system will no longer be useful. By storing the headers as a compressed archive within the kernel, we can avoid these issues that have been a hindrance for a long time.
The feature is also buildable as a module just in case the user desires it not being part of the kernel image. This makes it possible to load and unload the headers on demand. A tracing program, or a kernel module builder can load the module, do its operations, and then unload the module to save kernel memory. The total memory needed is 3.8MB.
The code to read the headers is based on /proc/config.gz code and uses the same technique to embed the headers.
To build a module, the below steps have been tested on an x86 machine: modprobe kheaders rm -rf $HOME/headers mkdir -p $HOME/headers tar -xvf /proc/kheaders.txz -C $HOME/headers >/dev/null cd my-kernel-module make -C $HOME/headers M=$(pwd) modules rmmod kheaders
Signed-off-by: Joel Fernandes (Google) joel@joelfernandes.org --- Changes since RFC: Both changes bring size down to 3.8MB: - use xz for compression - strip comments except SPDX lines - Call out the module name in Kconfig - Also added selftests in second patch to ensure headers are always working.
Documentation/dontdiff | 1 + arch/x86/Makefile | 2 ++ init/Kconfig | 11 ++++++ kernel/.gitignore | 2 ++ kernel/Makefile | 29 +++++++++++++++ kernel/kheaders.c | 74 +++++++++++++++++++++++++++++++++++++++ scripts/gen_ikh_data.sh | 19 ++++++++++ scripts/strip-comments.pl | 8 +++++ 8 files changed, 146 insertions(+) create mode 100644 kernel/kheaders.c create mode 100755 scripts/gen_ikh_data.sh create mode 100755 scripts/strip-comments.pl
diff --git a/Documentation/dontdiff b/Documentation/dontdiff index 2228fcc8e29f..05a2319ee2a2 100644 --- a/Documentation/dontdiff +++ b/Documentation/dontdiff @@ -151,6 +151,7 @@ int8.c kallsyms kconfig keywords.c +kheaders_data.h* ksym.c* ksym.h* kxgettext diff --git a/arch/x86/Makefile b/arch/x86/Makefile index 88398fdf8129..ad176d669da4 100644 --- a/arch/x86/Makefile +++ b/arch/x86/Makefile @@ -240,6 +240,8 @@ archmacros: ASM_MACRO_FLAGS = -Wa,arch/x86/kernel/macros.s export ASM_MACRO_FLAGS KBUILD_CFLAGS += $(ASM_MACRO_FLAGS) +IKH_EXTRA += arch/x86/kernel/macros.s +export IKH_EXTRA
### # Kernel objects diff --git a/init/Kconfig b/init/Kconfig index a4112e95724a..b95d769b6098 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -549,6 +549,17 @@ config IKCONFIG_PROC This option enables access to the kernel configuration file through /proc/config.gz.
+config IKHEADERS_PROC + tristate "Enable kernel header artifacts through /proc/kheaders.txz" + select BUILD_BIN2C + depends on PROC_FS + help + This option enables access to the kernel header and other artifacts that + are generated during the build process. These can be used to build kernel + modules, and other in-kernel programs such as those generated by eBPF + and systemtap tools. If you build the headers as a module, a module + called kheaders.ko is built which can be loaded to get access to them. + config LOG_BUF_SHIFT int "Kernel log buffer size (16 => 64KB, 17 => 128KB)" range 12 25 diff --git a/kernel/.gitignore b/kernel/.gitignore index b3097bde4e9c..6acf71acbdcb 100644 --- a/kernel/.gitignore +++ b/kernel/.gitignore @@ -3,5 +3,7 @@ # config_data.h config_data.gz +kheaders_data.h +kheaders_data.txz timeconst.h hz.bc diff --git a/kernel/Makefile b/kernel/Makefile index 7343b3a9bff0..aa2d3f9b9f49 100644 --- a/kernel/Makefile +++ b/kernel/Makefile @@ -73,6 +73,7 @@ obj-$(CONFIG_UTS_NS) += utsname.o obj-$(CONFIG_USER_NS) += user_namespace.o obj-$(CONFIG_PID_NS) += pid_namespace.o obj-$(CONFIG_IKCONFIG) += configs.o +obj-$(CONFIG_IKHEADERS_PROC) += kheaders.o obj-$(CONFIG_SMP) += stop_machine.o obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o obj-$(CONFIG_AUDIT) += audit.o auditfilter.o @@ -131,3 +132,31 @@ $(obj)/config_data.gz: $(KCONFIG_CONFIG) FORCE targets += config_data.h $(obj)/config_data.h: $(obj)/config_data.gz FORCE $(call filechk,ikconfiggz) + +# Build a list of in-kernel headers for building kernel modules +# Any other files will be stored in IKH_EXTRA variable. +ikh_file_list := include/ +ikh_file_list += arch/$(ARCH)/Makefile +ikh_file_list += arch/$(ARCH)/include/ +ikh_file_list += $(IKH_EXTRA) +ikh_file_list += scripts/ +ikh_file_list += Makefile +ikh_file_list += Module.symvers +ifeq ($(CONFIG_STACK_VALIDATION), y) +ikh_file_list += $(objtree)/tools/objtool/objtool +endif + +$(obj)/kheaders.o: $(obj)/kheaders_data.h + +targets += kheaders_data.txz + +quiet_cmd_genikh = GEN $(obj)/kheaders_data.txz +cmd_genikh = $(srctree)/scripts/gen_ikh_data.sh $@ $^ >/dev/null 2>&1 +$(obj)/kheaders_data.txz: $(ikh_file_list) FORCE + $(call cmd,genikh) + +filechk_ikheadersxz = (echo "static const char kernel_headers_data[] __used = KH_MAGIC_START"; cat $< | scripts/bin2c; echo "KH_MAGIC_END;") + +targets += kheaders_data.h +$(obj)/kheaders_data.h: $(obj)/kheaders_data.txz FORCE + $(call filechk,ikheadersxz) diff --git a/kernel/kheaders.c b/kernel/kheaders.c new file mode 100644 index 000000000000..c39930f51202 --- /dev/null +++ b/kernel/kheaders.c @@ -0,0 +1,74 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * kernel/kheaders.c + * Provide headers and artifacts needed to build kernel modules. + * (Borrowed code from kernel/configs.c) + */ + +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/proc_fs.h> +#include <linux/seq_file.h> +#include <linux/init.h> +#include <linux/uaccess.h> + +/* + * Define kernel_headers_data and kernel_headers_data_size, which contains the + * compressed kernel headers. The file is first compressed with xz and then + * bounded by two eight byte magic numbers to allow extraction from a binary + * kernel image: + * + * IKHD_ST + * <image> + * IKHD_ED + */ +#define KH_MAGIC_START "IKHD_ST" +#define KH_MAGIC_END "IKHD_ED" +#include "kheaders_data.h" + + +#define KH_MAGIC_SIZE (sizeof(KH_MAGIC_START) - 1) +#define kernel_headers_data_size \ + (sizeof(kernel_headers_data) - 1 - KH_MAGIC_SIZE * 2) + +static ssize_t +ikheaders_read_current(struct file *file, char __user *buf, + size_t len, loff_t *offset) +{ + return simple_read_from_buffer(buf, len, offset, + kernel_headers_data + KH_MAGIC_SIZE, + kernel_headers_data_size); +} + +static const struct file_operations ikheaders_file_ops = { + .owner = THIS_MODULE, + .read = ikheaders_read_current, + .llseek = default_llseek, +}; + +static int __init ikheaders_init(void) +{ + struct proc_dir_entry *entry; + + /* create the current headers file */ + entry = proc_create("kheaders.txz", S_IFREG | S_IRUGO, NULL, + &ikheaders_file_ops); + if (!entry) + return -ENOMEM; + + proc_set_size(entry, kernel_headers_data_size); + + return 0; +} + +static void __exit ikheaders_cleanup(void) +{ + remove_proc_entry("kheaders.txz", NULL); +} + +module_init(ikheaders_init); +module_exit(ikheaders_cleanup); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Joel Fernandes"); +MODULE_DESCRIPTION("Echo the kernel header artifacts used to build the kernel"); diff --git a/scripts/gen_ikh_data.sh b/scripts/gen_ikh_data.sh new file mode 100755 index 000000000000..609196b5cea2 --- /dev/null +++ b/scripts/gen_ikh_data.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0 + +spath="$(dirname "$(readlink -f "$0")")" + +rm -rf $1.tmp +mkdir $1.tmp + +for f in "${@:2}"; + do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*"; +done | cpio -pd $1.tmp + +for f in $(find $1.tmp); do + $spath/strip-comments.pl $f +done + +tar -Jcf $1 -C $1.tmp/ . > /dev/null + +rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0 + +# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers. + +BEGIN {undef $/;} +s//*((?!SPDX).)*?*///smg;
This test tries to build a module successfully using the in-kernel headers found in /proc/kheaders.txz.
Verified pass and fail scenarios by running: make -C tools/testing/selftests TARGETS=kheaders run_tests
Signed-off-by: Joel Fernandes (Google) joel@joelfernandes.org --- tools/testing/selftests/kheaders/Makefile | 5 +++++ tools/testing/selftests/kheaders/config | 1 + .../kheaders/run_kheaders_modbuild.sh | 18 ++++++++++++++++++ .../selftests/kheaders/testmod/Makefile | 3 +++ .../testing/selftests/kheaders/testmod/test.c | 19 +++++++++++++++++++ 5 files changed, 46 insertions(+) create mode 100644 tools/testing/selftests/kheaders/Makefile create mode 100644 tools/testing/selftests/kheaders/config create mode 100755 tools/testing/selftests/kheaders/run_kheaders_modbuild.sh create mode 100644 tools/testing/selftests/kheaders/testmod/Makefile create mode 100644 tools/testing/selftests/kheaders/testmod/test.c
diff --git a/tools/testing/selftests/kheaders/Makefile b/tools/testing/selftests/kheaders/Makefile new file mode 100644 index 000000000000..51035ab0732b --- /dev/null +++ b/tools/testing/selftests/kheaders/Makefile @@ -0,0 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0 + +TEST_PROGS := run_kheaders_modbuild.sh + +include ../lib.mk diff --git a/tools/testing/selftests/kheaders/config b/tools/testing/selftests/kheaders/config new file mode 100644 index 000000000000..5221f9fb5e79 --- /dev/null +++ b/tools/testing/selftests/kheaders/config @@ -0,0 +1 @@ +CONFIG_IKHEADERS_PROC=y diff --git a/tools/testing/selftests/kheaders/run_kheaders_modbuild.sh b/tools/testing/selftests/kheaders/run_kheaders_modbuild.sh new file mode 100755 index 000000000000..c5cb191da9c7 --- /dev/null +++ b/tools/testing/selftests/kheaders/run_kheaders_modbuild.sh @@ -0,0 +1,18 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 + +HEADERS_XZ=/proc/kheaders.txz +TMP_DIR_HEADERS=$(mktemp -d) +TMP_DIR_MODULE=$(mktemp -d) +SPATH="$(dirname "$(readlink -f "$0")")" + +tar -xvf $HEADERS_XZ -C $TMP_DIR_HEADERS > /dev/null + +cp -r $SPATH/testmod $TMP_DIR_MODULE/ + +pushd $TMP_DIR_MODULE/testmod +make -C $TMP_DIR_HEADERS M=$(pwd) modules +popd + +rm -rf $TMP_DIR_HEADERS +rm -rf $TMP_DIR_MODULE diff --git a/tools/testing/selftests/kheaders/testmod/Makefile b/tools/testing/selftests/kheaders/testmod/Makefile new file mode 100644 index 000000000000..7083e28706e8 --- /dev/null +++ b/tools/testing/selftests/kheaders/testmod/Makefile @@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-m += test.o diff --git a/tools/testing/selftests/kheaders/testmod/test.c b/tools/testing/selftests/kheaders/testmod/test.c new file mode 100644 index 000000000000..eae030aab5db --- /dev/null +++ b/tools/testing/selftests/kheaders/testmod/test.c @@ -0,0 +1,19 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include <linux/module.h> +#include <linux/kernel.h> +#include <linux/init.h> + +static int __init hello_init(void) +{ + printk(KERN_INFO "Hello, world\n"); + return 0; +} + +static void __exit hello_exit(void) +{ + printk(KERN_INFO "Goodbye, world\n"); +} + +module_init(hello_init); +module_exit(hello_exit);
On Thu, 7 Feb 2019 16:11:01 -0500 "Joel Fernandes (Google)" joel@joelfernandes.org wrote:
+# Build a list of in-kernel headers for building kernel modules +# Any other files will be stored in IKH_EXTRA variable. +ikh_file_list := include/ +ikh_file_list += arch/$(ARCH)/Makefile +ikh_file_list += arch/$(ARCH)/include/ +ikh_file_list += $(IKH_EXTRA) +ikh_file_list += scripts/ +ikh_file_list += Makefile +ikh_file_list += Module.symvers +ifeq ($(CONFIG_STACK_VALIDATION), y) +ikh_file_list += $(objtree)/tools/objtool/objtool +endif
+$(obj)/kheaders.o: $(obj)/kheaders_data.h
+targets += kheaders_data.txz
+quiet_cmd_genikh = GEN $(obj)/kheaders_data.txz +cmd_genikh = $(srctree)/scripts/gen_ikh_data.sh $@ $^ >/dev/null 2>&1 +$(obj)/kheaders_data.txz: $(ikh_file_list) FORCE
- $(call cmd,genikh)
+filechk_ikheadersxz = (echo "static const char kernel_headers_data[] __used = KH_MAGIC_START"; cat $< | scripts/bin2c; echo "KH_MAGIC_END;")
+targets += kheaders_data.h +$(obj)/kheaders_data.h: $(obj)/kheaders_data.txz FORCE
- $(call filechk,ikheadersxz)
diff --git a/scripts/gen_ikh_data.sh b/scripts/gen_ikh_data.sh new file mode 100755 index 000000000000..609196b5cea2 --- /dev/null +++ b/scripts/gen_ikh_data.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0
+spath="$(dirname "$(readlink -f "$0")")"
+rm -rf $1.tmp +mkdir $1.tmp
+for f in "${@:2}";
- do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*";
I wonder if it is a good idea to pick all files in the directories defined in ikh_file_list, and not just explicitly list what we want, with a '*.h' and such?
+done | cpio -pd $1.tmp
+for f in $(find $1.tmp); do
- $spath/strip-comments.pl $f
+done
+tar -Jcf $1 -C $1.tmp/ . > /dev/null
+rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0
+# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers.
+BEGIN {undef $/;} +s//*((?!SPDX).)*?*///smg;
Hmm, I'm also wondering if we could us the C pre-processor for the stripping of everything from the header file. We would then even get the header files only having what is necessary for the running kernel.
-- Steve
Hi Steve,
On Thu, Feb 07, 2019 at 05:52:39PM -0500, Steven Rostedt wrote:
On Thu, 7 Feb 2019 16:11:01 -0500 "Joel Fernandes (Google)" joel@joelfernandes.org wrote:
+# Build a list of in-kernel headers for building kernel modules +# Any other files will be stored in IKH_EXTRA variable. +ikh_file_list := include/ +ikh_file_list += arch/$(ARCH)/Makefile +ikh_file_list += arch/$(ARCH)/include/ +ikh_file_list += $(IKH_EXTRA) +ikh_file_list += scripts/ +ikh_file_list += Makefile +ikh_file_list += Module.symvers +ifeq ($(CONFIG_STACK_VALIDATION), y) +ikh_file_list += $(objtree)/tools/objtool/objtool +endif
+$(obj)/kheaders.o: $(obj)/kheaders_data.h
+targets += kheaders_data.txz
+quiet_cmd_genikh = GEN $(obj)/kheaders_data.txz +cmd_genikh = $(srctree)/scripts/gen_ikh_data.sh $@ $^ >/dev/null 2>&1 +$(obj)/kheaders_data.txz: $(ikh_file_list) FORCE
- $(call cmd,genikh)
+filechk_ikheadersxz = (echo "static const char kernel_headers_data[] __used = KH_MAGIC_START"; cat $< | scripts/bin2c; echo "KH_MAGIC_END;")
+targets += kheaders_data.h +$(obj)/kheaders_data.h: $(obj)/kheaders_data.txz FORCE
- $(call filechk,ikheadersxz)
diff --git a/scripts/gen_ikh_data.sh b/scripts/gen_ikh_data.sh new file mode 100755 index 000000000000..609196b5cea2 --- /dev/null +++ b/scripts/gen_ikh_data.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0
+spath="$(dirname "$(readlink -f "$0")")"
+rm -rf $1.tmp +mkdir $1.tmp
+for f in "${@:2}";
- do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*";
I wonder if it is a good idea to pick all files in the directories defined in ikh_file_list, and not just explicitly list what we want, with a '*.h' and such?
I also need few files in the archive that are not .h, these don't take up much space but are needed to make an out-of-tree kernel module build succeed.
One of my goals with this was to make a self-contained module that could be loaded to build other modules. Majority of the files are kernel headers, but some are not, such as Module.symvers and other scripts. Then one can run systemtap on Android which can be made to build modules using the embedded headers.
+done | cpio -pd $1.tmp
+for f in $(find $1.tmp); do
- $spath/strip-comments.pl $f
+done
+tar -Jcf $1 -C $1.tmp/ . > /dev/null
+rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0
+# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers.
+BEGIN {undef $/;} +s//*((?!SPDX).)*?*///smg;
Hmm, I'm also wondering if we could us the C pre-processor for the stripping of everything from the header file. We would then even get the header files only having what is necessary for the running kernel.
I thought about this too. An issue with that is it is going to be really slow due to the large number of headers. The other is, I think it will actually make the headers bigger and take up more space - because all the include directives will also be expanded and have more duplication. Let me know if I missed something though.
thanks,
- Joel
On Thu, 7 Feb 2019 18:39:02 -0500 Joel Fernandes joel@joelfernandes.org wrote:
+spath="$(dirname "$(readlink -f "$0")")"
+rm -rf $1.tmp +mkdir $1.tmp
+for f in "${@:2}";
- do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*";
I wonder if it is a good idea to pick all files in the directories defined in ikh_file_list, and not just explicitly list what we want, with a '*.h' and such?
I also need few files in the archive that are not .h, these don't take up much space but are needed to make an out-of-tree kernel module build succeed.
One of my goals with this was to make a self-contained module that could be loaded to build other modules. Majority of the files are kernel headers, but some are not, such as Module.symvers and other scripts. Then one can run systemtap on Android which can be made to build modules using the embedded headers.
Have you audited what it picks up? My main concern is that we start adding files that are not necessary or just simply added in the directory that are not needed for this.
+done | cpio -pd $1.tmp
+for f in $(find $1.tmp); do
- $spath/strip-comments.pl $f
+done
+tar -Jcf $1 -C $1.tmp/ . > /dev/null
+rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0
+# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers.
+BEGIN {undef $/;} +s//*((?!SPDX).)*?*///smg;
Hmm, I'm also wondering if we could us the C pre-processor for the stripping of everything from the header file. We would then even get the header files only having what is necessary for the running kernel.
I thought about this too. An issue with that is it is going to be really slow due to the large number of headers. The other is, I think it will actually make the headers bigger and take up more space - because all the include directives will also be expanded and have more duplication. Let me know if I missed something though.
Good point about the duplication. I was mostly thinking of getting rid of "#ifdef" blocks.
BTW, these comments are more of a "have you thought about this" and not really action comments.
-- Steve
On Thu, Feb 07, 2019 at 06:50:42PM -0500, Steven Rostedt wrote:
On Thu, 7 Feb 2019 18:39:02 -0500 Joel Fernandes joel@joelfernandes.org wrote:
+spath="$(dirname "$(readlink -f "$0")")"
+rm -rf $1.tmp +mkdir $1.tmp
+for f in "${@:2}";
- do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*";
I wonder if it is a good idea to pick all files in the directories defined in ikh_file_list, and not just explicitly list what we want, with a '*.h' and such?
I also need few files in the archive that are not .h, these don't take up much space but are needed to make an out-of-tree kernel module build succeed.
One of my goals with this was to make a self-contained module that could be loaded to build other modules. Majority of the files are kernel headers, but some are not, such as Module.symvers and other scripts. Then one can run systemtap on Android which can be made to build modules using the embedded headers.
Have you audited what it picks up? My main concern is that we start adding files that are not necessary or just simply added in the directory that are not needed for this.
Yes, I audited what is needed to be picked up. It turned out that I ended up nitpicking files for not much space-saving advantage while causing the list of files that need to be picked to be long, because most of the space is taken by the headers.
+done | cpio -pd $1.tmp
+for f in $(find $1.tmp); do
- $spath/strip-comments.pl $f
+done
+tar -Jcf $1 -C $1.tmp/ . > /dev/null
+rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0
+# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers.
+BEGIN {undef $/;} +s//*((?!SPDX).)*?*///smg;
Hmm, I'm also wondering if we could us the C pre-processor for the stripping of everything from the header file. We would then even get the header files only having what is necessary for the running kernel.
I thought about this too. An issue with that is it is going to be really slow due to the large number of headers. The other is, I think it will actually make the headers bigger and take up more space - because all the include directives will also be expanded and have more duplication. Let me know if I missed something though.
Good point about the duplication. I was mostly thinking of getting rid of "#ifdef" blocks. BTW, these comments are more of a "have you thought about this" and not really action comments.
Ok, thanks for the comments :)
- Joel
On Fri, Feb 8, 2019 at 6:13 AM Joel Fernandes (Google) joel@joelfernandes.org wrote:
Introduce in-kernel headers and other artifacts which are made available as an archive through proc (/proc/kheaders.txz file). This archive makes it possible to build kernel modules, run eBPF programs, and other tracing programs that need to extend the kernel for tracing purposes without any dependency on the file system having headers and build artifacts.
On Android and embedded systems, it is common to switch kernels but not have kernel headers available on the file system. Raw kernel headers also cannot be copied into the filesystem like they can be on other distros, due to licensing and other issues. There's no linux-headers package on Android. Further once a different kernel is booted, any headers stored on the file system will no longer be useful. By storing the headers as a compressed archive within the kernel, we can avoid these issues that have been a hindrance for a long time.
The feature is also buildable as a module just in case the user desires it not being part of the kernel image. This makes it possible to load and unload the headers on demand. A tracing program, or a kernel module builder can load the module, do its operations, and then unload the module to save kernel memory. The total memory needed is 3.8MB.
The code to read the headers is based on /proc/config.gz code and uses the same technique to embed the headers.
To build a module, the below steps have been tested on an x86 machine: modprobe kheaders rm -rf $HOME/headers mkdir -p $HOME/headers tar -xvf /proc/kheaders.txz -C $HOME/headers >/dev/null cd my-kernel-module make -C $HOME/headers M=$(pwd) modules rmmod kheaders
Signed-off-by: Joel Fernandes (Google) joel@joelfernandes.org
Changes since RFC: Both changes bring size down to 3.8MB:
- use xz for compression
- strip comments except SPDX lines
- Call out the module name in Kconfig
- Also added selftests in second patch to ensure headers are always
working.
Documentation/dontdiff | 1 + arch/x86/Makefile | 2 ++ init/Kconfig | 11 ++++++ kernel/.gitignore | 2 ++ kernel/Makefile | 29 +++++++++++++++ kernel/kheaders.c | 74 +++++++++++++++++++++++++++++++++++++++ scripts/gen_ikh_data.sh | 19 ++++++++++ scripts/strip-comments.pl | 8 +++++ 8 files changed, 146 insertions(+) create mode 100644 kernel/kheaders.c create mode 100755 scripts/gen_ikh_data.sh create mode 100755 scripts/strip-comments.pl
diff --git a/Documentation/dontdiff b/Documentation/dontdiff index 2228fcc8e29f..05a2319ee2a2 100644 --- a/Documentation/dontdiff +++ b/Documentation/dontdiff @@ -151,6 +151,7 @@ int8.c kallsyms kconfig keywords.c +kheaders_data.h* ksym.c* ksym.h* kxgettext diff --git a/arch/x86/Makefile b/arch/x86/Makefile index 88398fdf8129..ad176d669da4 100644 --- a/arch/x86/Makefile +++ b/arch/x86/Makefile @@ -240,6 +240,8 @@ archmacros: ASM_MACRO_FLAGS = -Wa,arch/x86/kernel/macros.s export ASM_MACRO_FLAGS KBUILD_CFLAGS += $(ASM_MACRO_FLAGS) +IKH_EXTRA += arch/x86/kernel/macros.s +export IKH_EXTRA
This does not exist in any of released kernels.
See commit 6ac389346e6
### # Kernel objects diff --git a/init/Kconfig b/init/Kconfig index a4112e95724a..b95d769b6098 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -549,6 +549,17 @@ config IKCONFIG_PROC This option enables access to the kernel configuration file through /proc/config.gz.
+config IKHEADERS_PROC
tristate "Enable kernel header artifacts through /proc/kheaders.txz"select BUILD_BIN2Cdepends on PROC_FShelpThis option enables access to the kernel header and other artifacts thatare generated during the build process. These can be used to build kernelmodules, and other in-kernel programs such as those generated by eBPFand systemtap tools. If you build the headers as a module, a modulecalled kheaders.ko is built which can be loaded to get access to them.config LOG_BUF_SHIFT int "Kernel log buffer size (16 => 64KB, 17 => 128KB)" range 12 25 diff --git a/kernel/.gitignore b/kernel/.gitignore index b3097bde4e9c..6acf71acbdcb 100644 --- a/kernel/.gitignore +++ b/kernel/.gitignore @@ -3,5 +3,7 @@ # config_data.h config_data.gz +kheaders_data.h +kheaders_data.txz timeconst.h hz.bc diff --git a/kernel/Makefile b/kernel/Makefile index 7343b3a9bff0..aa2d3f9b9f49 100644 --- a/kernel/Makefile +++ b/kernel/Makefile @@ -73,6 +73,7 @@ obj-$(CONFIG_UTS_NS) += utsname.o obj-$(CONFIG_USER_NS) += user_namespace.o obj-$(CONFIG_PID_NS) += pid_namespace.o obj-$(CONFIG_IKCONFIG) += configs.o +obj-$(CONFIG_IKHEADERS_PROC) += kheaders.o obj-$(CONFIG_SMP) += stop_machine.o obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o obj-$(CONFIG_AUDIT) += audit.o auditfilter.o @@ -131,3 +132,31 @@ $(obj)/config_data.gz: $(KCONFIG_CONFIG) FORCE targets += config_data.h $(obj)/config_data.h: $(obj)/config_data.gz FORCE $(call filechk,ikconfiggz)
+# Build a list of in-kernel headers for building kernel modules +# Any other files will be stored in IKH_EXTRA variable. +ikh_file_list := include/ +ikh_file_list += arch/$(ARCH)/Makefile +ikh_file_list += arch/$(ARCH)/include/ +ikh_file_list += $(IKH_EXTRA)
IKH_EXTRA is unneeded.
+ikh_file_list += scripts/ +ikh_file_list += Makefile +ikh_file_list += Module.symvers +ifeq ($(CONFIG_STACK_VALIDATION), y) +ikh_file_list += $(objtree)/tools/objtool/objtool +endif
+$(obj)/kheaders.o: $(obj)/kheaders_data.h
+targets += kheaders_data.txz
+quiet_cmd_genikh = GEN $(obj)/kheaders_data.txz +cmd_genikh = $(srctree)/scripts/gen_ikh_data.sh $@ $^ >/dev/null 2>&1 +$(obj)/kheaders_data.txz: $(ikh_file_list) FORCE
$(call cmd,genikh)+filechk_ikheadersxz = (echo "static const char kernel_headers_data[] __used = KH_MAGIC_START"; cat $< | scripts/bin2c; echo "KH_MAGIC_END;")
+targets += kheaders_data.h +$(obj)/kheaders_data.h: $(obj)/kheaders_data.txz FORCE
$(call filechk,ikheadersxz)diff --git a/kernel/kheaders.c b/kernel/kheaders.c new file mode 100644 index 000000000000..c39930f51202 --- /dev/null +++ b/kernel/kheaders.c @@ -0,0 +1,74 @@ +// SPDX-License-Identifier: GPL-2.0 +/*
- kernel/kheaders.c
- Provide headers and artifacts needed to build kernel modules.
- (Borrowed code from kernel/configs.c)
- */
+#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/proc_fs.h> +#include <linux/seq_file.h> +#include <linux/init.h> +#include <linux/uaccess.h>
+/*
- Define kernel_headers_data and kernel_headers_data_size, which contains the
- compressed kernel headers. The file is first compressed with xz and then
- bounded by two eight byte magic numbers to allow extraction from a binary
- kernel image:
- IKHD_ST
<image>
- IKHD_ED
- */
+#define KH_MAGIC_START "IKHD_ST" +#define KH_MAGIC_END "IKHD_ED" +#include "kheaders_data.h"
+#define KH_MAGIC_SIZE (sizeof(KH_MAGIC_START) - 1) +#define kernel_headers_data_size \
(sizeof(kernel_headers_data) - 1 - KH_MAGIC_SIZE * 2)+static ssize_t +ikheaders_read_current(struct file *file, char __user *buf,
size_t len, loff_t *offset)+{
return simple_read_from_buffer(buf, len, offset,kernel_headers_data + KH_MAGIC_SIZE,kernel_headers_data_size);+}
+static const struct file_operations ikheaders_file_ops = {
.owner = THIS_MODULE,.read = ikheaders_read_current,.llseek = default_llseek,+};
+static int __init ikheaders_init(void) +{
struct proc_dir_entry *entry;/* create the current headers file */entry = proc_create("kheaders.txz", S_IFREG | S_IRUGO, NULL,&ikheaders_file_ops);if (!entry)return -ENOMEM;proc_set_size(entry, kernel_headers_data_size);return 0;+}
+static void __exit ikheaders_cleanup(void) +{
remove_proc_entry("kheaders.txz", NULL);+}
+module_init(ikheaders_init); +module_exit(ikheaders_cleanup);
+MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Joel Fernandes"); +MODULE_DESCRIPTION("Echo the kernel header artifacts used to build the kernel"); diff --git a/scripts/gen_ikh_data.sh b/scripts/gen_ikh_data.sh new file mode 100755 index 000000000000..609196b5cea2 --- /dev/null +++ b/scripts/gen_ikh_data.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# SPDX-License-Identifier: GPL-2.0
+spath="$(dirname "$(readlink -f "$0")")"
+rm -rf $1.tmp +mkdir $1.tmp
+for f in "${@:2}";
do find "$f" ! -name "*.c" ! -name "*.o" ! -name "*.cmd" ! -name ".*";+done | cpio -pd $1.tmp
+for f in $(find $1.tmp); do
$spath/strip-comments.pl $f+done
+tar -Jcf $1 -C $1.tmp/ . > /dev/null
+rm -rf $1.tmp diff --git a/scripts/strip-comments.pl b/scripts/strip-comments.pl new file mode 100755 index 000000000000..f8ada87c5802 --- /dev/null +++ b/scripts/strip-comments.pl @@ -0,0 +1,8 @@ +#!/usr/bin/perl -pi +# SPDX-License-Identifier: GPL-2.0
+# This script removes /**/ comments from a file, unless such comments +# contain "SPDX". It is used when building compressed in-kernel headers.
+BEGIN {undef $/;}
+s//*((?!SPDX).)*?*///smg;
2.20.1.611.gfbb209baf1-goog
On Mon, Feb 11, 2019 at 10:39:43AM +0900, Masahiro Yamada wrote:
On Fri, Feb 8, 2019 at 6:13 AM Joel Fernandes (Google) joel@joelfernandes.org wrote:
Introduce in-kernel headers and other artifacts which are made available as an archive through proc (/proc/kheaders.txz file). This archive makes it possible to build kernel modules, run eBPF programs, and other tracing programs that need to extend the kernel for tracing purposes without any dependency on the file system having headers and build artifacts.
On Android and embedded systems, it is common to switch kernels but not have kernel headers available on the file system. Raw kernel headers also cannot be copied into the filesystem like they can be on other distros, due to licensing and other issues. There's no linux-headers package on Android. Further once a different kernel is booted, any headers stored on the file system will no longer be useful. By storing the headers as a compressed archive within the kernel, we can avoid these issues that have been a hindrance for a long time.
The feature is also buildable as a module just in case the user desires it not being part of the kernel image. This makes it possible to load and unload the headers on demand. A tracing program, or a kernel module builder can load the module, do its operations, and then unload the module to save kernel memory. The total memory needed is 3.8MB.
The code to read the headers is based on /proc/config.gz code and uses the same technique to embed the headers.
To build a module, the below steps have been tested on an x86 machine: modprobe kheaders rm -rf $HOME/headers mkdir -p $HOME/headers tar -xvf /proc/kheaders.txz -C $HOME/headers >/dev/null cd my-kernel-module make -C $HOME/headers M=$(pwd) modules rmmod kheaders
Signed-off-by: Joel Fernandes (Google) joel@joelfernandes.org
Changes since RFC: Both changes bring size down to 3.8MB:
- use xz for compression
- strip comments except SPDX lines
- Call out the module name in Kconfig
- Also added selftests in second patch to ensure headers are always
working.
Documentation/dontdiff | 1 + arch/x86/Makefile | 2 ++ init/Kconfig | 11 ++++++ kernel/.gitignore | 2 ++ kernel/Makefile | 29 +++++++++++++++ kernel/kheaders.c | 74 +++++++++++++++++++++++++++++++++++++++ scripts/gen_ikh_data.sh | 19 ++++++++++ scripts/strip-comments.pl | 8 +++++ 8 files changed, 146 insertions(+) create mode 100644 kernel/kheaders.c create mode 100755 scripts/gen_ikh_data.sh create mode 100755 scripts/strip-comments.pl
diff --git a/Documentation/dontdiff b/Documentation/dontdiff index 2228fcc8e29f..05a2319ee2a2 100644 --- a/Documentation/dontdiff +++ b/Documentation/dontdiff @@ -151,6 +151,7 @@ int8.c kallsyms kconfig keywords.c +kheaders_data.h* ksym.c* ksym.h* kxgettext diff --git a/arch/x86/Makefile b/arch/x86/Makefile index 88398fdf8129..ad176d669da4 100644 --- a/arch/x86/Makefile +++ b/arch/x86/Makefile @@ -240,6 +240,8 @@ archmacros: ASM_MACRO_FLAGS = -Wa,arch/x86/kernel/macros.s export ASM_MACRO_FLAGS KBUILD_CFLAGS += $(ASM_MACRO_FLAGS) +IKH_EXTRA += arch/x86/kernel/macros.s +export IKH_EXTRA
This does not exist in any of released kernels.
See commit 6ac389346e6
Ok, thanks fixed it in v2 which I just sent and rebased on linus master branch.
- Joel
linux-kselftest-mirror@lists.linaro.org
-
Joel Fernandes -
Joel Fernandes (Google)
-
Masahiro Yamada -
Steven Rostedt