Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Stephen Brennan <stephen.s.brennan@oracle.com>
To:     Baoquan He <bhe@redhat.com>
Cc:     linux-kernel@vger.kernel.org, kexec@lists.infradead.org,
        Nick Desaulniers <ndesaulniers@google.com>,
        Dave Young <dyoung@redhat.com>,
        Kees Cook <keescook@chromium.org>,
        Stephen Brennan <stephen.s.brennan@oracle.com>,
        Jiri Olsa <jolsa@kernel.org>,
        Stephen Boyd <swboyd@chromium.org>,
        Bixuan Cui <cuibixuan@huawei.com>,
        David Vernet <void@manifault.com>,
        Vivek Goyal <vgoyal@redhat.com>,
        Sami Tolvanen <samitolvanen@google.com>
Subject: [PATCH 2/2] vmcoreinfo: Include kallsyms symbols
Date:   Mon, 16 May 2022 17:05:08 -0700
Message-Id: <20220517000508.777145-3-stephen.s.brennan@oracle.com>
In-Reply-To: <20220517000508.777145-1-stephen.s.brennan@oracle.com>
References: <20220517000508.777145-1-stephen.s.brennan@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?LDXht1fjxyUiOoA5tA7nO26hTiS6/m4Tw/BCvBXAztFCh98VEKOY+tmzF2ZB?=
 =?us-ascii?Q?8kM+cx0mtrlvJxHf2QmkcR96tl7pxgJTRBJFwpBrpntqX5FOC4c3veqia37x?=
 =?us-ascii?Q?oVDTquxBjbyOns9RyaceETl8C/CHnBxoTKf0W0LJP16Po5uQw3yykcYC5SQv?=
 =?us-ascii?Q?KWD3nQ3m9ZiYtYlWyUz/SkhewV5xfZfnlglF+gN7yg/EDt2Dfa0Vj5j/0WSo?=
 =?us-ascii?Q?j1z0tBS9B0SI6NvrGgEJvvpPvZbguMzfYTkrCug+JpZ3XtnKXP8dyBbTPb9P?=
 =?us-ascii?Q?zhzCZSdK46QwGBcCEGTYIsypCSQ3xEX0HCeI6fbKo9ysR1pUQKdHfwRhY+8s?=
 =?us-ascii?Q?hCpY48Qa+RxjeCNfrysqKiHKhLYFK9um1WkJE5Si4WuCWYMo2VsgZRVBWZfF?=
 =?us-ascii?Q?YWDmqAaBM9dFctWtfbNzZ4wHamky6H0nuqUT9a2mI9h94fkjoqqUrsjO9hp2?=
 =?us-ascii?Q?bVgIXSbrEgbX4sAxt8h2MkE8B07RMQHYx7Bh37S3Tg1+D+2eG7/yyOZRzb2T?=
 =?us-ascii?Q?26SFp/6XzdlrWkD+fILBT0qG6bK/wYr1Htq6Ng0Z9f1pvBoOSfKMpYKK/0le?=
 =?us-ascii?Q?wvL+oUAu7yQGZVwGahKUOMc2/LIL+4OqAJ1auZKQ9yd/QBGwJf8qQmVgZ1iN?=
 =?us-ascii?Q?pNUTl9o1N3ou+4TBQy/IBX4b458v4fsn30Gl0WdDBWu6Facty6mbCu3kvJxo?=
 =?us-ascii?Q?n3Qe9+weSfLkvk7XyB53140HapBGHyJkRlUeRy4Iv/e2RpspzFK3jYvsqbrX?=
 =?us-ascii?Q?n6y+C1RX2cK6iyKtXz/p7WHVwIWuwNEbWWbrYlQGIoM3Fz+rt+vwjrII7bss?=
 =?us-ascii?Q?8JxvcnZ/PKQGEQrGs6qAbiShGtytuKkvGdcSSqtKqOzNQI4jVJFBAROW04Y4?=
 =?us-ascii?Q?Anv2bURHiTvZTv+/a1TYacEZX2lvzXOUmkXvE2KjgX9jgPUSsCMdM87aL85x?=
 =?us-ascii?Q?RBBzvnAlLIv76M09Lu9xeOuYZPWt5dipOkzgAzBTQO6z+StmfyiYJu1guY6U?=
 =?us-ascii?Q?LewkvdXcCDHuRQNyEqzofw8J/CLX4MLjzjDUau2X2NdGW6B6lwPk2mEldUld?=
 =?us-ascii?Q?SCkNVaWstISBnns8s9SwjHm+uF+Mr8XyQjvgUvogTqcWxmoCErKeFcI6ME4b?=
 =?us-ascii?Q?lcBpsZqnZ19pMOJF8wkhYpgbMaUM0/+GPezF/xRhBwGc+LLP2h2lQbr5Kovg?=
 =?us-ascii?Q?bIU3f/G6S+D+Nh1T350HX6dhzrw08pZR8/E3KbYngMBh+LAgOSDYv6Q7w3+g?=
 =?us-ascii?Q?9Eo1hfw/cnqp1ovBxX2kT++VY+csGr8lNNsElpinlGlzdI1mNlOaX6a9TYPm?=
 =?us-ascii?Q?yeQFHtBcFC9QTk+07bYpCufaRop+2+oEeVe+lSwRz8MrdfZCB/1nloV3IxqH?=
 =?us-ascii?Q?X4kqXEsWbutH0ukRo2yuGqzpON6Z01b1sQY0Fqf4A9XDBO/xGpZHopVQVTOz?=
 =?us-ascii?Q?oQ+8RhZlW44bb8oG5stsxXLgBX01B+3erjOJ/0pvIqs3DQcP5x31mK0UXJH5?=
 =?us-ascii?Q?MYCnIAZOaRju4EBnvECaiRLXBhbw+nLVdVDi3e3lDlSjCBKhUqYfZ/FHwS+h?=
 =?us-ascii?Q?7gvUEJrcYFU7XbSYixAt7Ez73BVQTHj9NXDebrSXwRCAujK6XnZGJCHkc1u4?=
 =?us-ascii?Q?rcREmG7Upws88pl0PnlwAMK53IctRmWgjLwLu4CT5fdiIEORd/kyJFScsXr+?=
 =?us-ascii?Q?WSCXb+BDEKnU9GS5wABurO6EHGy/nKnt9NkwETEjjP4/LQYYlBFJt9xmK8US?=
 =?us-ascii?Q?I4jTgXadzBrie68CZ/Wtjig2KZKqRtY=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7ad6fc99-0bb6-46e7-a553-08da3798eb0e
X-MS-Exchange-CrossTenant-AuthSource: CH2PR10MB4166.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 May 2022 00:05:14.5728
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: SvAJxCRX/IiqROdNIRyGFrPeUuIoED4Al8rliLaoqTxLlCrkVHnH/vIBqYNjCwYzMZz9aFUynBB69JqJzTv1wi9zKH10N0rey/WxoiXjpzo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR10MB5572
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.486,18.0.858
 definitions=2022-05-16_16:2022-05-16,2022-05-16 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxscore=0 malwarescore=0
 suspectscore=0 mlxlogscore=999 adultscore=0 phishscore=0 spamscore=0
 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2202240000 definitions=main-2205160132
X-Proofpoint-GUID: rxGGkH56-SRzw4ftr0Lyz_qKyKOQIHHA
X-Proofpoint-ORIG-GUID: rxGGkH56-SRzw4ftr0Lyz_qKyKOQIHHA
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE,
        SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

The internal kallsyms tables contain information which could be quite
useful to a debugging tool in the absence of other debuginfo. If
kallsyms is enabled, then a debugging tool could parse it and use it as
a fallback symbol table. Combined with BTF data, live & post-mortem
debuggers can support basic operations without needing a large DWARF
debuginfo file available. As many as five symbols are necessary to
properly parse kallsyms names and addresses.  Add these to the
vmcoreinfo note.

CONFIG_KALLSYMS_ABSOLUTE_PERCPU does impact the computation of symbol
addresses. However, a debugger can infer this configuration value by
comparing the address of _stext in the vmcoreinfo with the address
computed via kallsyms. So there's no need to include information about
this config value in the vmcoreinfo note.

To verify that we're still well below the maximum of 4096 bytes, I
created a script[1] to compute a rough upper bound on the possible size
of vmcoreinfo. On v5.18-rc7, the script reports 3106 bytes, and with
this patch, the maximum become 3370 bytes.

[1]: https://github.com/brenns10/kernel_stuff/blob/master/vmcoreinfosize/

Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>
---
 kernel/crash_core.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/kernel/crash_core.c b/kernel/crash_core.c
index 256cf6db573c..b9c89b80856d 100644
--- a/kernel/crash_core.c
+++ b/kernel/crash_core.c
@@ -15,6 +15,8 @@
 
 #include <crypto/sha1.h>
 
+#include "kallsyms_internal.h"
+
 /* vmcoreinfo stuff */
 unsigned char *vmcoreinfo_data;
 size_t vmcoreinfo_size;
@@ -484,6 +486,18 @@ static int __init crash_save_vmcoreinfo_init(void)
 	VMCOREINFO_NUMBER(PAGE_OFFLINE_MAPCOUNT_VALUE);
 #endif
 
+#ifdef CONFIG_KALLSYMS
+	VMCOREINFO_SYMBOL(kallsyms_names);
+	VMCOREINFO_SYMBOL(kallsyms_token_table);
+	VMCOREINFO_SYMBOL(kallsyms_token_index);
+#ifdef CONFIG_KALLSYMS_BASE_RELATIVE
+	VMCOREINFO_SYMBOL(kallsyms_offsets);
+	VMCOREINFO_SYMBOL(kallsyms_relative_base);
+#else
+	VMCOREINFO_SYMBOL(kallsyms_addresses);
+#endif /* CONFIG_KALLSYMS_BASE_RELATIVE */
+#endif /* CONFIG_KALLSYMS */
+
 	arch_crash_save_vmcoreinfo();
 	update_vmcoreinfo_note();
 
-- 
2.30.2