From nobody Mon Nov 25 02:38:46 2024 Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2813D14F9FA for ; Fri, 1 Nov 2024 06:45:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443519; cv=none; b=IRBCpCXQ5wiM5fWiCCYKkQXLEBageZQelCVCHztsNWvpq0qQfOByhCAmmHuFDy5dC3beuFoztS/Pym7664kYUk15+FDJ+wT0sxG6v2XsdrBGzFjvYpLG1o5FBXB6whDlaMSDt1bMnYPCFmM2i0CqhQVntQxPzQpEL0rA+OqtAQ4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443519; c=relaxed/simple; bh=1IKZAnyZPpVktxHC9zRma8YOuWXM4MGCEBdsXQkjzIo=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=ViQomPkBd+QwxMjuIRUi8r4/EshH0dmnTQMyJRQjhXLZ+H81tQlpO+s0v9uJuwWIlCElGZ8n5JvcVbqWnS8Ec+lNEhQRfWUT6MZmTdI5OyW1jmAgfW7EN6UhJy2hfZfjch/bImb9Zv+iUKNm2gcNt2HBxJW9iE9aa329GMtRSB8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--davidgow.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=fF5YjBoB; arc=none smtp.client-ip=209.85.219.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--davidgow.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="fF5YjBoB" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e290b8b69f8so3257110276.2 for ; Thu, 31 Oct 2024 23:45:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730443515; x=1731048315; darn=vger.kernel.org; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:from:to:cc:subject:date:message-id :reply-to; bh=HN46+Rtavp3etuaSPyEP0rFqZqnfBVs2LrQ3ai2Thlw=; b=fF5YjBoBAdWQfF7bKOSamDnPodcGGvu0jzwB4wby3JCSBvVipeCiNNoNAyDeLKcdWI OAt7o0OS8/sNtW5yLGwDL8HTwMwAfYZZmDZlgNik8FwpF3eq9TpgGXIbmNqbCiFPgY9E nr/tVHAFBZpRnH/9ARO6nPGWG8jelw78cDLo5XAo2Te13QfZ955ivHEcGhTfzyv6ufyF RAk46s91zUvN54BMm/+Suq9TSx0F34NWYbgQ1hJyVc1nKOny29Cgk4od/PaND4Pc8xTW pg1LDk+oPF2cCwQzYcaTmvH5V0zSSnmO66bgJmjK219CEut/pTkrEHMIi9gaqYzXMqTm CINA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730443515; x=1731048315; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=HN46+Rtavp3etuaSPyEP0rFqZqnfBVs2LrQ3ai2Thlw=; b=ntZ6bF6ru/7U2uzPejq90qnYbxXpEUqCE0rQBut1OTOmUaR+qkeovYBubEGVTQFKD1 X2dVdf1OVzQ6TxIj01xvHMa9UUB+fw0tczMfCS0ip2hjyAyh0YfZwUXsX0UnTGIzNM3o S3OyviEp5wkDnC9HXTBfzRwDvi8H/Gs2W2ErZlqs4S3FviFvXMKzOzyDYMiwbmhw1OHv dE1FCUzn8z/cJ8ajGekKkPTTCr5QetQQGkD658ASlUlqfQpXtOOgg7HHVWUkejCuLeqN Mbh5NITQuNkt6SBtoIlVoO0sCSliShvGrEfcT3gNfqwoevJ4IP5epWDFMWze+woeqPom zd9w== X-Forwarded-Encrypted: i=1; AJvYcCVo583PbaMJSbOvzP/kV8Dr9yv2B/hyyenGhkIS1DF6bZJQJUAoUeV41KdF0Qxs9PcJ6sa1Osf4sPv9wLI=@vger.kernel.org X-Gm-Message-State: AOJu0YzXrKd1VUspGImn8N/6JFhG9CSYXVG7rYvsMJpfRObgmHw6rzap QfMrPht9vgv8diNMRv740vg1G1565fMnP2y5mrzlMmNBT1hAl67HcqffzlhilV2zzCkyGiNsQGZ SOtrBYY9Bzw== X-Google-Smtp-Source: AGHT+IHT+oXP1IDEHV+YQkcgyEE3wRqCvILeKKI81XEVSowpz4ckxeKqpkDRwBLTQD+CXRtdhovD3Rs6VjwQDw== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a05:6902:181e:b0:e28:fdfc:b788 with SMTP id 3f1490d57ef6-e30cf4d455bmr6497276.9.1730443515109; Thu, 31 Oct 2024 23:45:15 -0700 (PDT) Date: Fri, 1 Nov 2024 14:45:00 +0800 In-Reply-To: <20241101064505.3820737-1-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241101064505.3820737-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Message-ID: <20241101064505.3820737-2-davidgow@google.com> Subject: [PATCH v4 1/3] rust: kunit: add KUnit case and suite macros From: David Gow To: Miguel Ojeda , "=?UTF-8?q?Jos=C3=A9=20Exp=C3=B3sito?=" , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , "=?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?=" , Alice Ryhl , Matt Gilbride Cc: kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, David Gow Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Jos=C3=A9 Exp=C3=B3sito Add a couple of Rust const functions and macros to allow to develop KUnit tests without relying on generated C code: - The `kunit_unsafe_test_suite!` Rust macro is similar to the `kunit_test_suite` C macro. It requires a NULL-terminated array of test cases (see below). - The `kunit_case` Rust function is similar to the `KUNIT_CASE` C macro. It generates as case from the name and function. - The `kunit_case_null` Rust function generates a NULL test case, which is to be used as delimiter in `kunit_test_suite!`. While these functions and macros can be used on their own, a future patch will introduce=C2=A0another macro to create KUnit tests using a user-space like syntax. Signed-off-by: Jos=C3=A9 Exp=C3=B3sito Co-developed-by: Matt Gilbride Signed-off-by: Matt Gilbride Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-4-davidgow@g= oogle.com/ - The kunit_unsafe_test_suite!() macro now panic!s if the suite name is too long, triggering a compile error. (Thanks, Alice!) Changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-2-davidgow@g= oogle.com/ - The kunit_unsafe_test_suite!() macro will truncate the name of the suite if it is too long. (Thanks Alice!) - We no longer needlessly use UnsafeCell<> in kunit_unsafe_test_suite!(). (Thanks Alice!) Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-1-c80db349e3b5@google.com/ - Rebase on top of rust-next - As a result, KUnit attributes are new set. These are hardcoded to the defaults of "normal" speed and no module name. - Split the kunit_case!() macro into two const functions, kunit_case() and kunit_case_null() (for the NULL terminator). --- rust/kernel/kunit.rs | 112 +++++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 2 files changed, 113 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..85bc1faff0d5 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -161,3 +161,115 @@ macro_rules! kunit_assert_eq { $crate::kunit_assert!($name, $file, $diff, $left =3D=3D $right); }}; } + +/// Represents an individual test case. +/// +/// The test case should have the signature +/// `unsafe extern "C" fn test_case(test: *mut crate::bindings::kunit)`. +/// +/// The `kunit_unsafe_test_suite!` macro expects a NULL-terminated list of= test cases. +/// Use `kunit_case_null` to generate such a delimeter. +const fn kunit_case(name: &'static kernel::str::CStr, run_case: unsafe ext= ern "C" fn(*mut kernel::bindings::kunit)) -> kernel::bindings::kunit_case { + kernel::bindings::kunit_case { + run_case: Some(run_case), + name: name.as_char_ptr(), + attr: kernel::bindings::kunit_attributes { + speed: kernel::bindings::kunit_speed_KUNIT_SPEED_NORMAL, + }, + generate_params: None, + status: kernel::bindings::kunit_status_KUNIT_SUCCESS, + module_name: core::ptr::null_mut(), + log: core::ptr::null_mut(), + } +} + +/// Represents the NULL test case delimiter. +/// +/// The `kunit_unsafe_test_suite!` macro expects a NULL-terminated list of= test cases. This +/// function retuns such a delimiter. +const fn kunit_case_null() -> kernel::bindings::kunit_case { + kernel::bindings::kunit_case { + run_case: None, + name: core::ptr::null_mut(), + generate_params: None, + attr: kernel::bindings::kunit_attributes { + speed: kernel::bindings::kunit_speed_KUNIT_SPEED_NORMAL, + }, + status: kernel::bindings::kunit_status_KUNIT_SUCCESS, + module_name: core::ptr::null_mut(), + log: core::ptr::null_mut(), + } +} + + +/// Registers a KUnit test suite. +/// +/// # Safety +/// +/// `test_cases` must be a NULL terminated array of test cases. +/// +/// # Examples +/// +/// ```ignore +/// unsafe extern "C" fn test_fn(_test: *mut crate::bindings::kunit) { +/// let actual =3D 1 + 1; +/// let expected =3D 2; +/// assert_eq!(actual, expected); +/// } +/// +/// static mut KUNIT_TEST_CASE: crate::bindings::kunit_case =3D crate::kun= it_case(name, test_fn); +/// static mut KUNIT_NULL_CASE: crate::bindings::kunit_case =3D crate::kun= it_case_null(); +/// static mut KUNIT_TEST_CASES: &mut[crate::bindings::kunit_case] =3D uns= afe { +/// &mut[KUNIT_TEST_CASE, KUNIT_NULL_CASE] +/// }; +/// crate::kunit_unsafe_test_suite!(suite_name, KUNIT_TEST_CASES); +/// ``` +#[macro_export] +macro_rules! kunit_unsafe_test_suite { + ($name:ident, $test_cases:ident) =3D> { + const _: () =3D { + static KUNIT_TEST_SUITE_NAME: [i8; 256] =3D { + let name_u8 =3D core::stringify!($name).as_bytes(); + let mut ret =3D [0; 256]; + + if name_u8.len() > 255 { + panic!(concat!("The test suite name `", core::stringif= y!($name), "` exceeds the maximum length of 255 bytes.")); + } + + let mut i =3D 0; + while i < name_u8.len() { + ret[i] =3D name_u8[i] as i8; + i +=3D 1; + } + + ret + }; + + static mut KUNIT_TEST_SUITE: $crate::bindings::kunit_suite =3D + $crate::bindings::kunit_suite { + name: KUNIT_TEST_SUITE_NAME, + // SAFETY: User is expected to pass a correct `test_ca= ses`, hence this macro + // named 'unsafe'. + test_cases: unsafe { $test_cases.as_mut_ptr() }, + suite_init: None, + suite_exit: None, + init: None, + exit: None, + attr: $crate::bindings::kunit_attributes { + speed: $crate::bindings::kunit_speed_KUNIT_SPEED_N= ORMAL, + }, + status_comment: [0; 256usize], + debugfs: core::ptr::null_mut(), + log: core::ptr::null_mut(), + suite_init_err: 0, + is_init: false, + }; + + #[used] + #[link_section =3D ".kunit_test_suites"] + static mut KUNIT_TEST_SUITE_ENTRY: *const $crate::bindings::ku= nit_suite =3D + // SAFETY: `KUNIT_TEST_SUITE` is static. + unsafe { core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) }; + }; + }; +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index b62451f64f6e..d662aa37070f 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -18,6 +18,7 @@ #![feature(inline_const)] #![feature(lint_reasons)] #![feature(unsize)] +#![feature(const_mut_refs)] =20 // Ensure conditional compilation based on the kernel configuration works; // otherwise we may silently break things like initcall handling. --=20 2.47.0.199.ga7371fff76-goog