From patchwork Tue Oct 29 09:24:17 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13854550 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (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 D0E8D203715 for ; Tue, 29 Oct 2024 09:24:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730193880; cv=none; b=jia75PjzifHJ3odOkU6uETj4oxaaaCm+zf/wkNB5BF6eaG33m6OkNmJSYiQV9U+9MvqsoFkGXpqwqZBnKL2buvVRhXw756oJk1dTTuTGO+SNLxWrxzd71tqFm6Ll+priEEba1YkGycrOjf6plSBpVsRYm68MgOjJDsCI6Whw5n8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730193880; c=relaxed/simple; bh=PUMO2JTw0uvnOJgP4Hq9WzubmyTpwyBsUVVr5ZHXO6Y=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=XCols7tcCCxm+BCCEd/yTQtOa50P1ojhqiRx7j2SfkFXQR/OOrinwl+7QwpXDn6qkoAx2or1lXfcMZk2rHC6D1Bjxe6FPXfr78sAfLEKYYHF64JLRYdfnunhdHvLx+6CuM8t4F4T6m5DZBQcfRCWNpt4+kSUMwAfx3ySzTy2NYo= 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=gHi61SHZ; arc=none smtp.client-ip=209.85.128.202 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="gHi61SHZ" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6e1fbe2a6b1so105817307b3.2 for ; Tue, 29 Oct 2024 02:24:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730193876; x=1730798676; 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=PZuhMQVPTPymU7myQUR1VYa3MCKqa4irr2PmBoZb9nA=; b=gHi61SHZ+007DRjWvu+k5lukOjNH1Bc9XKV4l3DYfPbwVfQgeOOYdgpOiyDlAcPUWY XX0vVU6Xt/EnmZH4o/Ep+4O5dacZb4q7bQyWwh1nwtf5oFcfcN6Yg2VTj7MbjUTvv7wv gn7JQj50DA7C9YxC3qIB9P8JB1S1tmPXNwxOPGHePzB7V/6i6y7Uc+aJmDKVeWRSdwN3 ctNj5j/x6If0n2mVe1k6kSxy2cil1ur/DCqjILauIL0MmK0o9EMRGyZisi5TYdRPZfCt RUYUMLGPF9yaXqA7vbMDDC49kP+ySlbQHnNoquk46ZMVf95WGPQnSiNizNjm1mkHeZDj 4QfA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730193876; x=1730798676; 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=PZuhMQVPTPymU7myQUR1VYa3MCKqa4irr2PmBoZb9nA=; b=EnMfjRuv+fGPxcYVMNQb1L/f+DYkBmCiThYOGPbSb3dTXxxIHzjV+imT+ORJjoWWyI pWhVR2H48msEV/PajxRsEVpKP71vNMuRq2YHSeM4jABFqjgcaw/LZanzzchmE7F9JGR9 W/7RaKZ9S1OXA4bbe5EdhGyIYTA04/elgiO+es+ItCN1bSQBB+ghKgOParM3zv8iC9g5 7Ie7eNl68EW/QHrdDAYD4Fc1WCPr+pDi/QkvUB7JcUkXHePOZGDFnkUrEo7/2XrhuGNC j3AoRGFFQyi6/xiyHXPiuPTiEAJCyXQxmO9DktkWEch4OIffvUyNmU4I5NTCgaBOfqMB n84g== X-Forwarded-Encrypted: i=1; AJvYcCVRNQIDf+Vj4Nyslrnck4Rw1UnCMnBXZyfsmMX0DjWvjQzJXjJx0Vs6nMg+9QGj9DAqevvvrnM/Z8Ha/FVEFNc=@vger.kernel.org X-Gm-Message-State: AOJu0YzCQhPb66/zpyVGLpw47B10f/qwvZ/pVPXsJAzjDh80m2Y6tbV2 1PcZHp+kiHoPHpEbB5mO9zD0Sqd/xAuj2Hc5feiUwFEY/W8YTxO0UXj4jKcEgqr27UQ9kPTWwLX TRPjyzSc+OA== X-Google-Smtp-Source: AGHT+IHK8ryBZsvSi4wvFVc+Ay6NDJsB7SRCJCku/YEE0/wdui/z1CUXbVkxSDodtLGAZ8vJdEdaFz5r5Ory0A== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a05:6902:b02:b0:e30:b820:dd14 with SMTP id 3f1490d57ef6-e30b820defemr117546276.9.1730193875754; Tue, 29 Oct 2024 02:24:35 -0700 (PDT) Date: Tue, 29 Oct 2024 17:24:17 +0800 In-Reply-To: <20241029092422.2884505-1-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241029092422.2884505-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241029092422.2884505-2-davidgow@google.com> Subject: [PATCH v2 1/3] rust: kunit: add KUnit case and suite macros From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , 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 From: José Expósito 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 another macro to create KUnit tests using a user-space like syntax. Signed-off-by: José Expósito Co-developed-by: Matt Gilbride Signed-off-by: Matt Gilbride Co-developed-by: David Gow Signed-off-by: David Gow --- 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 | 108 +++++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 2 files changed, 109 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..fc2d259db458 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -161,3 +161,111 @@ macro_rules! kunit_assert_eq { $crate::kunit_assert!($name, $file, $diff, $left == $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: &kernel::str::CStr, run_case: unsafe extern "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 = 1 + 1; +/// let expected = 2; +/// assert_eq!(actual, expected); +/// } +/// +/// static mut KUNIT_TEST_CASE: crate::bindings::kunit_case = crate::kunit_case(name, test_fn); +/// static mut KUNIT_NULL_CASE: crate::bindings::kunit_case = crate::kunit_case_null(); +/// static mut KUNIT_TEST_CASES: &mut[crate::bindings::kunit_case] = unsafe { +/// &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) => { + const _: () = { + static KUNIT_TEST_SUITE_NAME: [i8; 256] = { + let name_u8 = core::stringify!($name).as_bytes(); + let mut ret = [0; 256]; + + let mut i = 0; + while i < name_u8.len() { + ret[i] = name_u8[i] as i8; + i += 1; + } + + ret + }; + + static mut KUNIT_TEST_SUITE: core::cell::UnsafeCell<$crate::bindings::kunit_suite> = + core::cell::UnsafeCell::new($crate::bindings::kunit_suite { + name: KUNIT_TEST_SUITE_NAME, + // SAFETY: User is expected to pass a correct `test_cases`, 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_NORMAL, + }, + status_comment: [0; 256usize], + debugfs: core::ptr::null_mut(), + log: core::ptr::null_mut(), + suite_init_err: 0, + is_init: false, + }); + + #[used] + #[link_section = ".kunit_test_suites"] + static mut KUNIT_TEST_SUITE_ENTRY: *const $crate::bindings::kunit_suite = + // SAFETY: `KUNIT_TEST_SUITE` is static. + unsafe { KUNIT_TEST_SUITE.get() }; + }; + }; +} 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)] // Ensure conditional compilation based on the kernel configuration works; // otherwise we may silently break things like initcall handling. From patchwork Tue Oct 29 09:24:18 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13854551 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 3E6AE204032 for ; Tue, 29 Oct 2024 09:24:41 +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=1730193883; cv=none; b=T/gWvL5+U3UUNr0Zfm796NpxWdT7hEPf5X/9bfG6N2ZfRusKBVx8cCqFhq9vcFpcFA8snUF7YxnF3NS9G3QqieGVJ97a/BojT0B7040wOOx0g9ZBFkMAy3fYJ9Tfq6VPJSHB6pVdD4D3i8Dn3mgxW079HlQwETtsgjqlA3IWXWI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730193883; c=relaxed/simple; bh=4kN9i92hlnE0wmXPl+ENU7TbH9RwQ/rN4/YrZobYVrE=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=KNmDj09waumlDfD6yWRf33uqbfys3osb9q5PoHDLT46UzQ7EotfssVL/4F8wbE3f24n/PQTWgXwotX76m3+ZtKHdEVDZfpl7QZf2pFMu9pIpW3oyRs9xKB78G8yWigbG97EU7tlE50lCavir37w4m5LgQPtPC/AJVgQ8xp9Z2fg= 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=J4FbJqFL; 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="J4FbJqFL" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e2946a143efso7030347276.1 for ; Tue, 29 Oct 2024 02:24:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730193880; x=1730798680; 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=/e/K1PoHQ1ZWLXaF3jCF9hLNTpdzMLuZ5eUsJNHKGQU=; b=J4FbJqFLSIoY71yomsudA3Fw+03kFxVCoBmxXRQMXIXB66t5c/hW5tteYFxuWT/Wyl +EY6mx8jtyTzpPzZ2g/LkuizP+Nkjw/n4bUqyNEl8OeOUCPGj8ehIDsOOiKjELgdItiv lUGffSTcjW2YflhXCh/PBtngVlGZh126a7UUjj8BiDEOJcwdbRNod7YnAosfGuLjEsvE RN7lR0reB+sDk4830TYMBo8vB4NuMHvC7S34Vnm2oFdjVoRndOroblGW7FPeZRWWI+3o tbOedO0kQgFwy3wPwuPRX60kHDk8QYKp19IcTAnfH6+ZRusFClO4WZcUu8TrazZ31vD4 8c/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730193880; x=1730798680; 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=/e/K1PoHQ1ZWLXaF3jCF9hLNTpdzMLuZ5eUsJNHKGQU=; b=Kxk0cdvGmywlEoeonv68isW4Td7P42eQUoNwh+Y0OnQtkycV7z1L1rUPyNm68TI11j 1VX7j547tCoWKGs2UVRJh1XGIzfyqHg7qxRFvWa5BoWWxTdUXBYZ4VTapkZQh0AUm3/p iFE75lXb6Vp++5WPVtjWppoL0OU6+BZOYkhu8ezlD8yUuAtuhrO4SEosy2+ai/zGo/9R l4GywdGom5BCWIJZks5vty6RaRCSmTu1CeMbqdqUQL2DIuQhreChT3v4RS6DNypzi6s+ xE7itrgxSELVHN6ilKZjE8nVlsl6cosUfLpZnWY1UZPLMeK+p7M4kebA6/66d/B2ZYuH GMBw== X-Forwarded-Encrypted: i=1; AJvYcCWTYA6KsB6cVWhQ1FufvGo/84c40uEKdDIkJHytl/MC3/OJHBU6ladoniVN3VA+XtkHat3kRg2BLKUUbqFErD4=@vger.kernel.org X-Gm-Message-State: AOJu0YyHOI/abUCHiut68f6GKeRreVjmGpYgyIL6jvEx9zeWtPeqIoOY lhq7iHAnjwIkEjD0S1qe7bhXmolX+Pjq7EZlUHVILkcExFfhpTvVramS03ExyUf00MUC0LmmrkN 3ZZstlBPJlw== X-Google-Smtp-Source: AGHT+IHb7K7be6vvr7Lz0o1myzy7kRdN5S2epEVxI2qbDBPCGbnJZwBdPfhyQpr+WatB5sq5LzQNvAGK5j80sQ== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a5b:750:0:b0:e26:3788:9ea2 with SMTP id 3f1490d57ef6-e30c16724f7mr21596276.0.1730193880123; Tue, 29 Oct 2024 02:24:40 -0700 (PDT) Date: Tue, 29 Oct 2024 17:24:18 +0800 In-Reply-To: <20241029092422.2884505-1-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241029092422.2884505-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241029092422.2884505-3-davidgow@google.com> Subject: [PATCH v2 2/3] rust: macros: add macro to easily run KUnit tests From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , 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 From: José Expósito Add a new procedural macro (`#[kunit_tests(kunit_test_suit_name)]`) to run KUnit tests using a user-space like syntax. The macro, that should be used on modules, transforms every `#[test]` in a `kunit_case!` and adds a `kunit_unsafe_test_suite!` registering all of them. The only difference with user-space tests is that instead of using `#[cfg(test)]`, `#[kunit_tests(kunit_test_suit_name)]` is used. Note that `#[cfg(CONFIG_KUNIT)]` is added so the test module is not compiled when `CONFIG_KUNIT` is set to `n`. Reviewed-by: David Gow Signed-off-by: José Expósito [Updated to use new const fn.] Signed-off-by: David Gow --- Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-2-c80db349e3b5@google.com/ - Rebased on top of rust-next - Make use of the new const functions, rather than the kunit_case!() macro. --- MAINTAINERS | 1 + rust/kernel/kunit.rs | 11 +++++++++++ rust/macros/lib.rs | 29 +++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index b77f4495dcf4..b65035ede675 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12433,6 +12433,7 @@ F: Documentation/dev-tools/kunit/ F: include/kunit/ F: lib/kunit/ F: rust/kernel/kunit.rs +F: rust/macros/kunit.rs F: scripts/rustdoc_test_* F: tools/testing/kunit/ diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index fc2d259db458..abcf0229ffee 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -40,6 +40,8 @@ pub fn info(args: fmt::Arguments<'_>) { } } +use macros::kunit_tests; + /// Asserts that a boolean expression is `true` at runtime. /// /// Public but hidden since it should only be used from generated tests. @@ -269,3 +271,12 @@ macro_rules! kunit_unsafe_test_suite { }; }; } + +#[kunit_tests(rust_kernel_kunit)] +mod tests { + #[test] + fn rust_test_kunit_kunit_tests() { + let running = true; + assert_eq!(running, true); + } +} diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index 939ae00b723a..098925b99982 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -10,6 +10,7 @@ mod quote; mod concat_idents; mod helpers; +mod kunit; mod module; mod paste; mod pin_data; @@ -430,3 +431,31 @@ pub fn paste(input: TokenStream) -> TokenStream { pub fn derive_zeroable(input: TokenStream) -> TokenStream { zeroable::derive(input) } + +/// Registers a KUnit test suite and its test cases using a user-space like syntax. +/// +/// This macro should be used on modules. If `CONFIG_KUNIT` (in `.config`) is `n`, the target module +/// is ignored. +/// +/// # Examples +/// +/// ```ignore +/// # use macros::kunit_tests; +/// +/// #[kunit_tests(kunit_test_suit_name)] +/// mod tests { +/// #[test] +/// fn foo() { +/// assert_eq!(1, 1); +/// } +/// +/// #[test] +/// fn bar() { +/// assert_eq!(2, 2); +/// } +/// } +/// ``` +#[proc_macro_attribute] +pub fn kunit_tests(attr: TokenStream, ts: TokenStream) -> TokenStream { + kunit::kunit_tests(attr, ts) +} From patchwork Tue Oct 29 09:24:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13854552 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) (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 0C7A4203708 for ; Tue, 29 Oct 2024 09:24:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730193888; cv=none; b=U+dC9juP/xjg+Vy+/rgXDwaIue0jzz3B8oIgMwHhg6yNUKeg9bVs0DR4TZrCyL7q9LoRQCMblMK7CUq2/JSnwuy6moYFpLC2rGH/qUDVCYVV/HP8ikYtetsl/+kLzibiNr3KZIZMjdFd39woaFYu0bbEXUmOXRIzia5G9GCSTZc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730193888; c=relaxed/simple; bh=lvKDYgMcSvvhTyIBb6ECAc1q865WqLsWsBgNoK5wF70=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=aZo/yzyHjPqmciyGdfA4y0t4l43wUeH2+w12LLbhONpNjTKtxkUhzd2h7DfNiMMOXKKujaGOXyJerMEoxSq5O8NqCPh+8GITQ/Hv0U+2H8iuri2l2qdY/QVkjDZu+pIA7TzCsVXBGRTQ7T8455a52XyueSMqwp/37st1mzGG1JI= 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=NWsuspQ4; arc=none smtp.client-ip=209.85.219.202 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="NWsuspQ4" Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-e290947f6f8so9361977276.2 for ; Tue, 29 Oct 2024 02:24:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730193885; x=1730798685; 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=ci1oKFH7l7WT9pl4IwsUJvvMv23hze9L/lrXNyoJlVo=; b=NWsuspQ4VW5XaQgZXor47tgDVdnrt9Fq80ycCRpfD4phtzLiR/T7C2X4JImcNhwsTY o93zF+dQUTDr5VD+m7UgKWfEzLfoSmmug8FCtLOgeMkrAhxpRH6FcZ8IT7sW/lVxrqUv wonhjgnHysSjYPah294jE28LVB/cNcEe1jTCr1ZwDWQj69d/uS9vDjUxTi+7C6OCYfV7 tIxTnnDOsaVuoVKHZHXyF0HPx1l0X2SE37DzSJz7Vfy8Ss39IUMsykztOfBrX1/n/Z35 8+AAKLoo39AznLENhwdD80zIFr3pIlaALJuNeBWA6cvwRfZiFfeBSPZIXP4ljG041Mda lk3g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730193885; x=1730798685; 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=ci1oKFH7l7WT9pl4IwsUJvvMv23hze9L/lrXNyoJlVo=; b=pLWvzXrG5uc7gzHZ0NriyBDtRDSG1IH8hS6WhERtIF4zJvT23DzIPfrV6GtZdb+2Oc 4YC9slMIN0pD3OemzZcxF3IZ/S/37VwuP99YML2DTR84IuxGnsNrbMUwZniyTua1Q/G7 2SkRDPupVB1mMiHv3Md+WTw9nVAgIF1xau3NgDvrw66eD8gz2G8QhdAoCclMeJcR99Po apD0RAN/ooogMVGo16EMOGfdBSSCW8suTOUGR8msC+vYy5bLJeLNlN+hLCtALiJTHYqA AImi9He3jomHAIGrX5h+N/H71iFUvsKnL7meNGkb83COkVI/yoM4p5XUq8uOPCUtGvS8 j4KA== X-Forwarded-Encrypted: i=1; AJvYcCWSaV3V94h46bQ32SL8gwVZ83q4PX9kGdxKXjKkpTrB/WWvXN7aIyCBmRnrklifNNPGu7+pOioIjIJCUGj0vWY=@vger.kernel.org X-Gm-Message-State: AOJu0Yxt4D6lXsahG1Y7NKYuBBaqsJwBT7HklLzxbcISqVNFz4t4drZR 6m5PBIIpgAVe568TkYcZpdyKckfg5GOVmaGNUHDIIDSL/WJ3UxY2J7aiDMe4w0Q6MG9/40s/wkS HOLcjOuDdqQ== X-Google-Smtp-Source: AGHT+IEqlyW4/tadreX6bN11wpCmzXQCZWMdmwaTsthqhgrxW9b3cNSTo/5NH/qdY8Gte5je22w3U1+J/ieEyw== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a5b:2ca:0:b0:e30:bf92:7a64 with SMTP id 3f1490d57ef6-e30bf927b96mr1319276.2.1730193884736; Tue, 29 Oct 2024 02:24:44 -0700 (PDT) Date: Tue, 29 Oct 2024 17:24:19 +0800 In-Reply-To: <20241029092422.2884505-1-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241029092422.2884505-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241029092422.2884505-4-davidgow@google.com> Subject: [PATCH v2 3/3] rust: kunit: allow to know if we are in a test From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , 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 From: José Expósito In some cases, we need to call test-only code from outside the test case, for example, to mock a function or a module. In order to check whether we are in a test or not, we need to test if `CONFIG_KUNIT` is set. Unfortunately, we cannot rely only on this condition because: - a test could be running in another thread, - some distros compile KUnit in production kernels, so checking at runtime that `current->kunit_test != NULL` is required. Forturately, KUnit provides an optimised check in `kunit_get_current_test()`, which checks CONFIG_KUNIT, a global static key, and then the current thread's running KUnit test. Add a safe wrapper function around this to know whether or not we are in a KUnit test and examples showing how to mock a function and a module. Signed-off-by: José Expósito Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-3-c80db349e3b5@google.com/ - Rebased on top of rust-next. - Use the `kunit_get_current_test()` C function, which wasn't previously available, instead of rolling our own. - (Thanks also to Boqun for suggesting a nicer way of implementing this, which I tried, but the `kunit_get_current_test()` version obsoleted.) --- rust/kernel/kunit.rs | 72 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index abcf0229ffee..bfc80394546a 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -272,11 +272,83 @@ macro_rules! kunit_unsafe_test_suite { }; } +/// In some cases, you need to call test-only code from outside the test case, for example, to +/// create a function mock. This function can be invoked to know whether we are currently running a +/// KUnit test or not. +/// +/// # Examples +/// +/// This example shows how a function can be mocked to return a well-known value while testing: +/// +/// ``` +/// # use kernel::kunit::in_kunit_test; +/// # +/// fn fn_mock_example(n: i32) -> i32 { +/// if in_kunit_test() { +/// 100 +/// } else { +/// n + 1 +/// } +/// } +/// +/// let mock_res = fn_mock_example(5); +/// assert_eq!(mock_res, 100); +/// ``` +/// +/// Sometimes, you don't control the code that needs to be mocked. This example shows how the +/// `bindings` module can be mocked: +/// +/// ``` +/// // Import our mock naming it as the real module. +/// #[cfg(CONFIG_KUNIT)] +/// use bindings_mock_example as bindings; +/// +/// // This module mocks `bindings`. +/// mod bindings_mock_example { +/// use kernel::kunit::in_kunit_test; +/// use kernel::bindings::u64_; +/// +/// // Make the other binding functions available. +/// pub(crate) use kernel::bindings::*; +/// +/// // Mock `ktime_get_boot_fast_ns` to return a well-known value when running a KUnit test. +/// pub(crate) unsafe fn ktime_get_boot_fast_ns() -> u64_ { +/// if in_kunit_test() { +/// 1234 +/// } else { +/// unsafe { kernel::bindings::ktime_get_boot_fast_ns() } +/// } +/// } +/// } +/// +/// // This is the function we want to test. Since `bindings` has been mocked, we can use its +/// // functions seamlessly. +/// fn get_boot_ns() -> u64 { +/// unsafe { bindings::ktime_get_boot_fast_ns() } +/// } +/// +/// let time = get_boot_ns(); +/// assert_eq!(time, 1234); +/// ``` +pub fn in_kunit_test() -> bool { + // SAFETY: kunit_get_current_test() is always safe to call from C (it has fallbacks for + // when KUnit is not enabled), and we're only comparing the result to NULL. + unsafe { !bindings::kunit_get_current_test().is_null() } +} + #[kunit_tests(rust_kernel_kunit)] mod tests { + use super::*; + #[test] fn rust_test_kunit_kunit_tests() { let running = true; assert_eq!(running, true); } + + #[test] + fn rust_test_kunit_in_kunit_test() { + let in_kunit = in_kunit_test(); + assert_eq!(in_kunit, true); + } }