From patchwork Sat Mar 26 23:53:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu (Google)" X-Patchwork-Id: 12792696 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 26A8DC433F5 for ; Sat, 26 Mar 2022 23:53:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230192AbiCZXzJ (ORCPT ); Sat, 26 Mar 2022 19:55:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55008 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230178AbiCZXzJ (ORCPT ); Sat, 26 Mar 2022 19:55:09 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B9E3A2DD47; Sat, 26 Mar 2022 16:53:26 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 08B2CB80B3F; Sat, 26 Mar 2022 23:53:25 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 65069C340F0; Sat, 26 Mar 2022 23:53:20 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1648338803; bh=SFAoQoDCZH9+H/cOjK0kYrO4Z6OtnYYL4lqW44mHkAk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Rgjq4kDTzv0x087ZZZGxYa4cBD9L/g/GyfOmArtVkaKzXAJHQJz/PeLS5URqDrhTO yhNQGANls19RviIlIqovJz9ZnNXOR0owPJHwmnBLl3Fh1AALz31XJSdbb5/2+P2ViR u1igf5ulkC5uW1Qjj1OVCgGeBFlM7T/BtlOk3EqrmWnbH6UEmopoqVjiw7Q1bsQhT2 a17zbuVzJ9mn5g1wsRMSbe9APw2+BNb+nh3/xhU60aW+Du9DmE6tRWoRBFCqa+/NdN dOn+tZJe4IqxpNkZBEwQq6k+6CzjyOf/Z7hNCS3t3jRUA3V3HLHiog92c7Dyc4zYPH 8yFs2zv8gYvCw== From: Masami Hiramatsu To: Steven Rostedt Cc: Masami Hiramatsu , Padmanabha Srinivasaiah , LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Randy Dunlap , Nick Desaulniers , Sami Tolvanen , Nathan Chancellor , llvm@lists.linux.dev, Masahiro Yamada , Linux Kbuild mailing list Subject: [PATCH v4 1/3] bootconfig: Check the checksum before removing the bootconfig from initrd Date: Sun, 27 Mar 2022 08:53:18 +0900 Message-Id: <164833879781.2575750.8980132935605494939.stgit@devnote2> X-Mailer: git-send-email 2.25.1 In-Reply-To: <164833878595.2575750.1483106296151574233.stgit@devnote2> References: <164833878595.2575750.1483106296151574233.stgit@devnote2> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org Check the bootconfig's checksum before removing the bootcinfig data from initrd to avoid modifying initrd by mistake. This will also simplifies the get_boot_config_from_initrd() interface. Signed-off-by: Masami Hiramatsu --- init/main.c | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/init/main.c b/init/main.c index 560f45c27ffe..4f3ba3b84e34 100644 --- a/init/main.c +++ b/init/main.c @@ -265,7 +265,7 @@ static int __init loglevel(char *str) early_param("loglevel", loglevel); #ifdef CONFIG_BLK_DEV_INITRD -static void * __init get_boot_config_from_initrd(u32 *_size, u32 *_csum) +static void * __init get_boot_config_from_initrd(u32 *_size) { u32 size, csum; char *data; @@ -299,17 +299,20 @@ static void * __init get_boot_config_from_initrd(u32 *_size, u32 *_csum) return NULL; } + if (xbc_calc_checksum(data, size) != csum) { + pr_err("bootconfig checksum failed\n"); + return NULL; + } + /* Remove bootconfig from initramfs/initrd */ initrd_end = (unsigned long)data; if (_size) *_size = size; - if (_csum) - *_csum = csum; return data; } #else -static void * __init get_boot_config_from_initrd(u32 *_size, u32 *_csum) +static void * __init get_boot_config_from_initrd(u32 *_size) { return NULL; } @@ -408,12 +411,12 @@ static void __init setup_boot_config(void) static char tmp_cmdline[COMMAND_LINE_SIZE] __initdata; const char *msg; int pos; - u32 size, csum; + u32 size; char *data, *err; int ret; /* Cut out the bootconfig data even if we have no bootconfig option */ - data = get_boot_config_from_initrd(&size, &csum); + data = get_boot_config_from_initrd(&size); strlcpy(tmp_cmdline, boot_command_line, COMMAND_LINE_SIZE); err = parse_args("bootconfig", tmp_cmdline, NULL, 0, 0, 0, NULL, @@ -437,11 +440,6 @@ static void __init setup_boot_config(void) return; } - if (xbc_calc_checksum(data, size) != csum) { - pr_err("bootconfig checksum failed\n"); - return; - } - ret = xbc_init(data, size, &msg, &pos); if (ret < 0) { if (pos < 0) @@ -470,7 +468,7 @@ static void __init exit_boot_config(void) static void __init setup_boot_config(void) { /* Remove bootconfig data from initrd */ - get_boot_config_from_initrd(NULL, NULL); + get_boot_config_from_initrd(NULL); } static int __init warn_bootconfig(char *str) From patchwork Sat Mar 26 23:53:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu (Google)" X-Patchwork-Id: 12792697 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7AF2FC433EF for ; Sat, 26 Mar 2022 23:54:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230274AbiCZXzj (ORCPT ); Sat, 26 Mar 2022 19:55:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55430 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230273AbiCZXzP (ORCPT ); Sat, 26 Mar 2022 19:55:15 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E07113C720; Sat, 26 Mar 2022 16:53:36 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 483FDB80B3F; Sat, 26 Mar 2022 23:53:35 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 7422AC340E8; Sat, 26 Mar 2022 23:53:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1648338814; bh=vc2yyA48mcGcaGfmuIwdFhFzR0od3OYHyuQGW2TVW+0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=f28XV2oQyGtBZj/ehlhTvX0mHvRRwgg7MJczgkz+owBCCQ5KQx7LSAjOwyEgIf+rf JAV5guJP7vmyC4aaQcKI8lVRdTDi+9DTdN2aG6TiQz1KY4ZeShOd/uUJ23nBNWh458 KpFoGa1/CBmIyUhBfv7Dok8AaOybG6OKZ1KcOVV6j0eoAZdvhO8Sdusub0zg+F/nR8 kvT+vSJnOLfUdhznCsMsQVpykINWP5y/nX4s+fkAiShm5WFcqOwBYakklhp7VUoKbK YPWy/XTFwYU3J8TDdoLF4WGe0X9iGOdkzkop6ksPYG7I+5KgfJys5Mn9iM6kevsjmg 3NlpMkVU6nIjw== From: Masami Hiramatsu To: Steven Rostedt Cc: Masami Hiramatsu , Padmanabha Srinivasaiah , LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Randy Dunlap , Nick Desaulniers , Sami Tolvanen , Nathan Chancellor , llvm@lists.linux.dev, Masahiro Yamada , Linux Kbuild mailing list Subject: [PATCH v4 2/3] bootconfig: Support embedding a bootconfig file in kernel Date: Sun, 27 Mar 2022 08:53:29 +0900 Message-Id: <164833880897.2575750.113875316750095499.stgit@devnote2> X-Mailer: git-send-email 2.25.1 In-Reply-To: <164833878595.2575750.1483106296151574233.stgit@devnote2> References: <164833878595.2575750.1483106296151574233.stgit@devnote2> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org This allows kernel developer to embed a default bootconfig file in the kernel instead of embedding it in the initrd. This will be good for who are using the kernel without initrd, or who needs a default bootconfigs. This needs to set two kconfigs: CONFIG_EMBED_BOOT_CONFIG=y and set the file path to CONFIG_EMBED_BOOT_CONFIG_FILE. Note that you still need 'bootconfig' command line option to load the embedded bootconfig. Also if you boot using an initrd with a different bootconfig, the kernel will use the bootconfig in the initrd, instead of the default bootconfig. Signed-off-by: Masami Hiramatsu --- Changes in v3: - Avoid updating the default.bconf if the file is not changed. --- include/linux/bootconfig.h | 10 ++++++++++ init/Kconfig | 21 +++++++++++++++++++++ init/main.c | 13 ++++++++----- lib/.gitignore | 1 + lib/Makefile | 10 ++++++++++ lib/bootconfig.c | 23 +++++++++++++++++++++++ 6 files changed, 73 insertions(+), 5 deletions(-) diff --git a/include/linux/bootconfig.h b/include/linux/bootconfig.h index a4665c7ab07c..5dbda5e3e9bb 100644 --- a/include/linux/bootconfig.h +++ b/include/linux/bootconfig.h @@ -289,4 +289,14 @@ int __init xbc_get_info(int *node_size, size_t *data_size); /* XBC cleanup data structures */ void __init xbc_exit(void); +/* XBC embedded bootconfig data in kernel */ +#ifdef CONFIG_EMBED_BOOT_CONFIG +char * __init xbc_get_embedded_bootconfig(size_t *size); +#else +static inline char *xbc_get_embedded_bootconfig(size_t *size) +{ + return NULL; +} +#endif + #endif diff --git a/init/Kconfig b/init/Kconfig index beb5b866c318..bff308a782f8 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1357,6 +1357,27 @@ config BOOT_CONFIG If unsure, say Y. +config EMBED_BOOT_CONFIG + bool "Embed bootconfig file in the kernel" + depends on BOOT_CONFIG + default n + help + Embed a bootconfig file given by EMBED_BOOT_CONFIG_FILE in the + kernel. Usually, the bootconfig file is loaded with the initrd + image. But if the system doesn't support initrd, this option will + help you by embedding a bootconfig file while building the kernel. + + If unsure, say N. + +config EMBED_BOOT_CONFIG_FILE + string "Embedded bootconfig file path" + default "" + depends on EMBED_BOOT_CONFIG + help + Specify a bootconfig file which will be embedded to the kernel. + This bootconfig will be used if there is no initrd or no other + bootconfig in the initrd. + choice prompt "Compiler optimization level" default CC_OPTIMIZE_FOR_PERFORMANCE diff --git a/init/main.c b/init/main.c index 4f3ba3b84e34..180511324c95 100644 --- a/init/main.c +++ b/init/main.c @@ -265,7 +265,7 @@ static int __init loglevel(char *str) early_param("loglevel", loglevel); #ifdef CONFIG_BLK_DEV_INITRD -static void * __init get_boot_config_from_initrd(u32 *_size) +static void * __init get_boot_config_from_initrd(size_t *_size) { u32 size, csum; char *data; @@ -411,12 +411,15 @@ static void __init setup_boot_config(void) static char tmp_cmdline[COMMAND_LINE_SIZE] __initdata; const char *msg; int pos; - u32 size; + size_t size; char *data, *err; int ret; /* Cut out the bootconfig data even if we have no bootconfig option */ data = get_boot_config_from_initrd(&size); + /* If there is no bootconfig in initrd, try embedded one. */ + if (!data) + data = xbc_get_embedded_bootconfig(&size); strlcpy(tmp_cmdline, boot_command_line, COMMAND_LINE_SIZE); err = parse_args("bootconfig", tmp_cmdline, NULL, 0, 0, 0, NULL, @@ -435,8 +438,8 @@ static void __init setup_boot_config(void) } if (size >= XBC_DATA_MAX) { - pr_err("bootconfig size %d greater than max size %d\n", - size, XBC_DATA_MAX); + pr_err("bootconfig size %ld greater than max size %d\n", + (long)size, XBC_DATA_MAX); return; } @@ -449,7 +452,7 @@ static void __init setup_boot_config(void) msg, pos); } else { xbc_get_info(&ret, NULL); - pr_info("Load bootconfig: %d bytes %d nodes\n", size, ret); + pr_info("Load bootconfig: %ld bytes %d nodes\n", (long)size, ret); /* keys starting with "kernel." are passed via cmdline */ extra_command_line = xbc_make_cmdline("kernel"); /* Also, "init." keys are init arguments */ diff --git a/lib/.gitignore b/lib/.gitignore index e5e217b8307b..30a2a5db7033 100644 --- a/lib/.gitignore +++ b/lib/.gitignore @@ -6,3 +6,4 @@ /oid_registry_data.c /test_fortify.log /test_fortify/*.log +/default.bconf diff --git a/lib/Makefile b/lib/Makefile index 353bc09ce38d..dd9f3ebb62ca 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -276,6 +276,16 @@ $(foreach file, $(libfdt_files), \ $(eval CFLAGS_$(file) = -I $(srctree)/scripts/dtc/libfdt)) lib-$(CONFIG_LIBFDT) += $(libfdt_files) +ifeq ($(CONFIG_EMBED_BOOT_CONFIG),y) +$(obj)/bootconfig.o: $(obj)/default.bconf + +targets += default.bconf +filechk_defbconf = cat /dev/null $(CONFIG_EMBED_BOOT_CONFIG_FILE) +$(obj)/default.bconf: FORCE + $(call filechk,defbconf) + +endif + lib-$(CONFIG_BOOT_CONFIG) += bootconfig.o obj-$(CONFIG_RBTREE_TEST) += rbtree_test.o diff --git a/lib/bootconfig.c b/lib/bootconfig.c index 74f3201ab8e5..3a3bf3a208e3 100644 --- a/lib/bootconfig.c +++ b/lib/bootconfig.c @@ -12,6 +12,29 @@ #include #include #include + +#ifdef CONFIG_EMBED_BOOT_CONFIG +asm ( +" .pushsection .init.data, \"aw\" \n" +" .global embedded_bootconfig_data \n" +"embedded_bootconfig_data: \n" +" .incbin \"lib/default.bconf\" \n" +" .global embedded_bootconfig_data_end \n" +"embedded_bootconfig_data_end: \n" +" .popsection \n" +); + +extern __visible char embedded_bootconfig_data[]; +extern __visible char embedded_bootconfig_data_end[]; + +char * __init xbc_get_embedded_bootconfig(size_t *size) +{ + *size = embedded_bootconfig_data_end - embedded_bootconfig_data; + return (*size) ? embedded_bootconfig_data : NULL; +} + +#endif + #else /* !__KERNEL__ */ /* * NOTE: This is only for tools/bootconfig, because tools/bootconfig will From patchwork Sat Mar 26 23:53:39 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu (Google)" X-Patchwork-Id: 12792698 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 914FFC433F5 for ; Sat, 26 Mar 2022 23:54:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230273AbiCZXzs (ORCPT ); Sat, 26 Mar 2022 19:55:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56016 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231463AbiCZXzX (ORCPT ); Sat, 26 Mar 2022 19:55:23 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A142644754; Sat, 26 Mar 2022 16:53:46 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 436C4B80BEB; Sat, 26 Mar 2022 23:53:45 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id A9C1EC340E8; Sat, 26 Mar 2022 23:53:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1648338823; bh=FwRy95YaoTK2BNBsAgnwyFkUwJ1K6hC1h5SRyvWqEcc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=TC7GMV4KOydd0o9Sv2pMrXCgkLtTtemg+MW7uzGGxJ1gFaosw14E060Fop5Oyv5hk A2i3gXa9ljAOqQsYlGKnDmSG6x1fouZxwUJL35FKIIsNBvFrCLvRa3WhL8bLA5Kd2H 0FjREGKR0cPpShhWmUyX5oT1w3Ta5Hq3YYKtDBiFnSi+APxqee2h3/+gjePI13c444 DCdnDh7TGLEyx4+QmzUCrADo5XHVQoH1ZI9+e+Apf/wUqmgFbxvq67N1B4sqyUTYoY I8wJmmR6m7qZTM4Z9O0PaBRdxxuYQmNHGvJFKzKFVvleXpD6WAG1FwJyYrUCnaJMA8 QD4fZPJJgWvhg== From: Masami Hiramatsu To: Steven Rostedt Cc: Masami Hiramatsu , Padmanabha Srinivasaiah , LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Randy Dunlap , Nick Desaulniers , Sami Tolvanen , Nathan Chancellor , llvm@lists.linux.dev, Masahiro Yamada , Linux Kbuild mailing list Subject: [PATCH v4 3/3] docs: bootconfig: Add how to embed the bootconfig into kernel Date: Sun, 27 Mar 2022 08:53:39 +0900 Message-Id: <164833881933.2575750.9855651229937143999.stgit@devnote2> X-Mailer: git-send-email 2.25.1 In-Reply-To: <164833878595.2575750.1483106296151574233.stgit@devnote2> References: <164833878595.2575750.1483106296151574233.stgit@devnote2> User-Agent: StGit/0.19 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org Add a description how to embed the bootconfig file into kernel. Signed-off-by: Masami Hiramatsu --- Changes in v3: - Fix typos. Changes in v2: - Corrected the text accoding to Randy's suggestion. - Do not reccomend to use relative path for CONFIG_EMBED_BOOT_CONFIG_FILE. --- Documentation/admin-guide/bootconfig.rst | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/Documentation/admin-guide/bootconfig.rst b/Documentation/admin-guide/bootconfig.rst index a1860fc0ca88..9028e0f1307b 100644 --- a/Documentation/admin-guide/bootconfig.rst +++ b/Documentation/admin-guide/bootconfig.rst @@ -158,9 +158,15 @@ Each key-value pair is shown in each line with following style:: Boot Kernel With a Boot Config ============================== -Since the boot configuration file is loaded with initrd, it will be added -to the end of the initrd (initramfs) image file with padding, size, -checksum and 12-byte magic word as below. +There are two options to boot the kernel with bootconfig: attaching the +bootconfig to the initrd image or embedding it in the kernel itself. + +Attaching a Boot Config to Initrd +--------------------------------- + +Since the boot configuration file is loaded with initrd by default, +it will be added to the end of the initrd (initramfs) image file with +padding, size, checksum and 12-byte magic word as below. [initrd][bootconfig][padding][size(le32)][checksum(le32)][#BOOTCONFIG\n] @@ -196,6 +202,24 @@ To remove the config from the image, you can use -d option as below:: Then add "bootconfig" on the normal kernel command line to tell the kernel to look for the bootconfig at the end of the initrd file. +Embedding a Boot Config into Kernel +----------------------------------- + +If you can not use initrd, you can also embed the bootconfig file in the +kernel by Kconfig options. In this case, you need to recompile the kernel +with the following configs:: + + CONFIG_EMBED_BOOT_CONFIG=y + CONFIG_EMBED_BOOT_CONFIG_FILE="/PATH/TO/BOOTCONFIG/FILE" + +``CONFIG_EMBED_BOOT_CONFIG_FILE`` requires a correct absolute path to +the bootconfig file. The kernel will embed it as the default bootconfig. + +Just as when attaching the bootconfig to the initrd, you need ``bootconfig`` +option on the kernel command line to enable the embedded bootconfig. + +Note that even if you set this option, you can override the embedded +bootconfig by another bootconfig which attached to the initrd. Kernel parameters via Boot Config =================================