From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8EBA11ABEDD for ; Tue, 24 Sep 2024 17:24:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=140.211.166.138 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1727198655; cv=none; b=Hbgm2IMpVtQyWZ95D+vqLkOpcK1/YgCH1X8jbkRVVvmAloJzidMB3SVDbP9fbvu4omaNMxrNg4SL2c9PSFDpincfWS+/xDDiGDNdojluHPK1dYq+gHrZpKriSGFg4mRb4ZrdBF2Xn7mA3qUKoI+rrqTWH5RLJVuheudfnJ7yw2s= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1727198655; c=relaxed/simple; bh=i2prbdZtMoWVyDoI4r/p//WUM6FxFMImdthGTI/8140=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version:Content-Type; b=ASbkYEJ+WQcifr6fXqPjwtJFM14nBu6Rv6oHJKK7lMil2nR0CQz/L6sNTPObqqNeNddymMBvxDRTUhVY2Jdb5BmZ2kpniQpDPp0N9O1pKfWveETS7Mlt/ElgtR0QbbmaeqSkt/feG2caG9PsiD9WGC3QQWp0eDGEqjEY+uzTXHc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=UvZEdl7N; arc=none smtp.client-ip=140.211.166.138 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="UvZEdl7N" Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 2369184193 for ; Tue, 24 Sep 2024 17:24:14 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org X-Spam-Flag: NO X-Spam-Score: -2.099 X-Spam-Level: Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id 0MDuzbgjexdm for ; Tue, 24 Sep 2024 17:24:13 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=2a00:1450:4864:20::42d; helo=mail-wr1-x42d.google.com; envelope-from=sergio.collado@gmail.com; receiver= DMARC-Filter: OpenDMARC Filter v1.4.2 smtp1.osuosl.org BE3F381E59 Authentication-Results: smtp1.osuosl.org; dmarc=pass (p=none dis=none) header.from=gmail.com DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org BE3F381E59 Authentication-Results: smtp1.osuosl.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20230601 header.b=UvZEdl7N Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by smtp1.osuosl.org (Postfix) with ESMTPS id BE3F381E59 for ; Tue, 24 Sep 2024 17:24:12 +0000 (UTC) Received: by mail-wr1-x42d.google.com with SMTP id ffacd0b85a97d-374b5f27cf2so3430438f8f.1 for ; Tue, 24 Sep 2024 10:24:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1727198651; x=1727803451; darn=lists.linuxfoundation.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=1Xa6ya8wdG3acprFrPFVxBRwnaLHUBcbgW6iKZmyPgA=; b=UvZEdl7NmROKFRC+N4skGR7i9FYFQvuvhQhtc/KYEIjvGIDc5R74EN7bdRQHpDuJqF 8K4lVcwUMjRMp7hQqassBiDItFNDRzT0y3/Tjls8N/Mlbh9cBrn+bMcvhBgOi+lypNrM ObZvh66RBcLt1Xzztu/md1cCQoMFJHuYRVEcO88uTx3NcMliaH1DnWXeMG/ahqpSMR02 DR7h0O+7pagahJBTuhaKdcbko1y8SaM3SQsZ79iRwgimDPWghftnKdTH4JUv3B63YJGo /cJ5pbWPLrWZ0V1BYs0oAhXCRiUiebVwaEKOIsKLq0LZH072+/SIvhOp2y6miNouvqpU ripw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727198651; x=1727803451; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=1Xa6ya8wdG3acprFrPFVxBRwnaLHUBcbgW6iKZmyPgA=; b=aMHPHviidiNxyLYvjPSHb9mBzwdQo96XBUE/TL9kr9GuFpk8/aDPxKyMBat5hXA7eW ulDOviSVS5P+VKHFtJuThVcMDyUhV3f/iZda5D3fD7ZW+5loy1SJsCXMytMjS3vTxI9g nrrF+UjvtoMoomTKzBEfAmuRdErlXadvFc64RfA8rmh9xG+uyWGYIIcT3EyGldpEPq22 3jiYUTweMyYYKqQ/XOR1ZUykOpzyXgHymjRqT3wuHFcVKnKUu1swMYtMTdwLg2TEKw+L +THqMSeFXov8a3+Y6iViKBDwNWlacRJB42sodJ5BV4bC/Y9aO0JhPVPUncjVBDExyChk ejQA== X-Forwarded-Encrypted: i=1; AJvYcCVcQbwmkkrrX3bR8cob+krVx1PjWLDGdBFNJ0T6uJP7cXt51TVd2lShihaWlDArTasXnLmCMSVNADpGupkmgXFFlPSgnA==@lists.linuxfoundation.org X-Gm-Message-State: AOJu0YxJJaa3Ny5KeUfuiwfBFpT8XNqB6CwAheOBya7KKTSmgTz1QYeO iqjsp9woUjyxDcUExtt9ITBIWKVnQnOXz329aP6k7nhBiU1QVYew X-Google-Smtp-Source: AGHT+IGTKSfyy9/yRkrIFuC7cBO7/BvzSRmazQjP6DBcmTpxOZ4uat6YRdZE94fpH202GnM/mUk8dA== X-Received: by 2002:a05:6000:8f:b0:374:c79b:ca5f with SMTP id ffacd0b85a97d-37cc24c26e2mr80226f8f.46.1727198650417; Tue, 24 Sep 2024 10:24:10 -0700 (PDT) Received: from laptop.home (188.75.217.87.dynamic.jazztel.es. [87.217.75.188]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-37cbc31f6e1sm2109535f8f.111.2024.09.24.10.24.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 24 Sep 2024 10:24:09 -0700 (PDT) From: =?UTF-8?q?Sergio=20Gonz=C3=A1lez=20Collado?= To: Brendan Higgins , David Gow , Miguel Ojeda , Alex Gaynor , linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, sergio.collado@gmail.com, Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , "H. Peter Anvin" Cc: Boqun Feng , Gary Guo , =?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , David Rheinsberg , rust-for-linux@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, skhan@linuxfoundation.org, ricardo.marliere@suse.com, Martin Rodriguez Reboredo Subject: [PATCH v4] Kunit to check the longest symbol length Date: Tue, 24 Sep 2024 19:23:51 +0200 Message-Id: <20240924172351.23225-1-sergio.collado@gmail.com> X-Mailer: git-send-email 2.39.2 Precedence: bulk X-Mailing-List: linux-kernel-mentees@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The longest length of a symbol (KSYM_NAME_LEN) was increased to 512 in the reference [1]. This patch adds a kunit test to check the longest symbol length. This test can also help other efforts for longer symbol lenght, like [2]. [1] https://lore.kernel.org/lkml/20220802015052.10452-6-ojeda@kernel.org/ [2] https://lore.kernel.org/lkml/20240605032120.3179157-1-song@kernel.org/ Tested-by: Martin Rodriguez Reboredo Signed-off-by: Sergio González Collado --- V1 -> V2: corrected CI tests. Added fix proposed at [3] [3] https://lore.kernel.org/lkml/Y9ES4UKl%2F+DtvAVS@gmail.com/T/#m3ef0e12bb834d01ed1ebdcae12ef5f2add342077 --- V2 -> V3: updated base and added MODULE_DESCRIPTION() and MODULE_AUTHOR() --- V3 -> V4: add x86 mantainers, add new reference. --- arch/x86/tools/insn_decoder_test.c | 3 +- lib/Kconfig.debug | 9 +++ lib/Makefile | 2 + lib/longest_symbol_kunit.c | 124 +++++++++++++++++++++++++++++ 4 files changed, 137 insertions(+), 1 deletion(-) create mode 100644 lib/longest_symbol_kunit.c diff --git a/arch/x86/tools/insn_decoder_test.c b/arch/x86/tools/insn_decoder_test.c index 472540aeabc2..3bde35ea4188 100644 --- a/arch/x86/tools/insn_decoder_test.c +++ b/arch/x86/tools/insn_decoder_test.c @@ -10,6 +10,7 @@ #include #include #include +#include #define unlikely(cond) (cond) @@ -106,7 +107,7 @@ static void parse_args(int argc, char **argv) } } -#define BUFSIZE 256 +#define BUFSIZE (256 + KSYM_NAME_LEN) int main(int argc, char **argv) { diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index bc8faa4509e1..09015e7e07f3 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -2805,6 +2805,15 @@ config FORTIFY_KUNIT_TEST by the str*() and mem*() family of functions. For testing runtime traps of FORTIFY_SOURCE, see LKDTM's "FORTIFY_*" tests. +config LONGEST_SYM_KUNIT_TEST + tristate "Test the longest symbol possible" if !KUNIT_ALL_TESTS + depends on KUNIT && KPROBES + default KUNIT_ALL_TESTS + help + Tests the longest symbol possible + + If unsure, say N. + config HW_BREAKPOINT_KUNIT_TEST bool "Test hw_breakpoint constraints accounting" if !KUNIT_ALL_TESTS depends on HAVE_HW_BREAKPOINT diff --git a/lib/Makefile b/lib/Makefile index 773adf88af41..fc878e716825 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -389,6 +389,8 @@ CFLAGS_fortify_kunit.o += $(DISABLE_STRUCTLEAK_PLUGIN) obj-$(CONFIG_FORTIFY_KUNIT_TEST) += fortify_kunit.o obj-$(CONFIG_SIPHASH_KUNIT_TEST) += siphash_kunit.o obj-$(CONFIG_USERCOPY_KUNIT_TEST) += usercopy_kunit.o +obj-$(CONFIG_LONGEST_SYM_KUNIT_TEST) += longest_symbol_kunit.o +CFLAGS_longest_symbol_kunit.o += $(call cc-disable-warning, missing-prototypes) obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o diff --git a/lib/longest_symbol_kunit.c b/lib/longest_symbol_kunit.c new file mode 100644 index 000000000000..557ad6eae56c --- /dev/null +++ b/lib/longest_symbol_kunit.c @@ -0,0 +1,124 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Test the longest symbol length. Execute with: + * ./tools/testing/kunit/kunit.py run longest-symbol + * --arch=x86_64 --kconfig_add CONFIG_KPROBES=y --kconfig_add CONFIG_MODULES=y + * --kconfig_add CONFIG_RETPOLINE=n + */ + +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt + +#include +#include +#include +#include + +#define DI(name) s##name##name +#define DDI(name) DI(n##name##name) +#define DDDI(name) DDI(n##name##name) +#define DDDDI(name) DDDI(n##name##name) +#define DDDDDI(name) DDDDI(n##name##name) + +#define PLUS1(name) __PASTE(name, e) + +/*Generate a symbol whose name length is 511 */ +#define LONGEST_SYM_NAME DDDDDI(g1h2i3j4k5l6m7n) + +/*Generate a symbol whose name length is 512 */ +#define LONGEST_SYM_NAME_PLUS1 PLUS1(LONGEST_SYM_NAME) + +#define RETURN_LONGEST_SYM 0xAAAAA +#define RETURN_LONGEST_SYM_PLUS1 0x55555 + +noinline int LONGEST_SYM_NAME(void); +noinline int LONGEST_SYM_NAME(void) +{ + return RETURN_LONGEST_SYM; +} + +noinline int LONGEST_SYM_NAME_PLUS1(void); +noinline int LONGEST_SYM_NAME_PLUS1(void) +{ + return RETURN_LONGEST_SYM_PLUS1; +} + +_Static_assert(sizeof(__stringify(LONGEST_SYM_NAME)) == KSYM_NAME_LEN, +"Incorrect symbol length found. Expected KSYM_NAME_LEN: " +__stringify(KSYM_NAME) ", but found: " +__stringify(sizeof(LONGEST_SYM_NAME))); + +static void test_longest_symbol(struct kunit *test) +{ + KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM, LONGEST_SYM_NAME()); +}; + +static void test_longest_symbol_kallsyms(struct kunit *test) +{ + unsigned long (*kallsyms_lookup_name)(const char *name); + static int (*longest_sym)(void); + + struct kprobe kp = { + .symbol_name = "kallsyms_lookup_name", + }; + + if (register_kprobe(&kp) < 0) { + pr_info("%s: kprobe not registered\n", __func__); + KUNIT_FAIL(test, "test_longest_symbol kallsysms: kprobe not registered\n"); + return; + } + + kunit_warn(test, "test_longest_symbol kallsyms: kprobe registered\n"); + kallsyms_lookup_name = (unsigned long (*)(const char *name))kp.addr; + unregister_kprobe(&kp); + + longest_sym = + (void *) kallsyms_lookup_name(__stringify(LONGEST_SYM_NAME)); + KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM, longest_sym()); +}; + +static void test_longest_symbol_plus1(struct kunit *test) +{ + KUNIT_EXPECT_EQ(test, RETURN_LONGEST_SYM_PLUS1, LONGEST_SYM_NAME_PLUS1()); +}; + +static void test_longest_symbol_plus1_kallsyms(struct kunit *test) +{ + unsigned long (*kallsyms_lookup_name)(const char *name); + static int (*longest_sym_plus1)(void); + + struct kprobe kp = { + .symbol_name = "kallsyms_lookup_name", + }; + + if (register_kprobe(&kp) < 0) { + pr_info("%s: kprobe not registered\n", __func__); + KUNIT_FAIL(test, "test_longest_symbol kallsysms: kprobe not registered\n"); + return; + } + + kunit_warn(test, "test_longest_symbol_plus1 kallsyms: kprobe registered\n"); + kallsyms_lookup_name = (unsigned long (*)(const char *name))kp.addr; + unregister_kprobe(&kp); + + longest_sym_plus1 = + (void *) kallsyms_lookup_name(__stringify(LONGEST_SYM_NAME_PLUS1)); + KUNIT_EXPECT_NULL(test, longest_sym_plus1); +}; + +static struct kunit_case longest_symbol_test_cases[] = { + KUNIT_CASE(test_longest_symbol), + KUNIT_CASE(test_longest_symbol_kallsyms), + KUNIT_CASE(test_longest_symbol_plus1), + KUNIT_CASE(test_longest_symbol_plus1_kallsyms), + {} +}; + +static struct kunit_suite longest_symbol_test_suite = { + .name = "longest-symbol", + .test_cases = longest_symbol_test_cases, +}; +kunit_test_suite(longest_symbol_test_suite); + +MODULE_LICENSE("GPL"); +MODULE_DESCRIPTION("Test the longest symbol length"); +MODULE_AUTHOR("Sergio González Collado"); base-commit: abf2050f51fdca0fd146388f83cddd95a57a008d -- 2.39.2