From patchwork Fri Dec 13 08:10:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13906644 Received: from mail-pf1-f202.google.com (mail-pf1-f202.google.com [209.85.210.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 4CF801A7060 for ; Fri, 13 Dec 2024 08:10:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077450; cv=none; b=NJHOq2jzAe9x6QnDUMdbCgI15cG5pF+xUelktxcvYQIict32bx3pECJ5YcOK1/fNqyF7RHUHy11k8KwpLwXnYy+IyCnuVzawnxBmR9GaJ+KxEPpJhZOBtga0S0ORs8rYP4PUV/cCVa7oUWoaEXA+34mvqX5Ip73zGiEoL2RPQBA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077450; c=relaxed/simple; bh=z3WxWku3En1g2Q9vLxqxNomd35j6zMJzJtZtnxG9FvY=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=a+1pr+Tv6lihgN69YUomDlqFqM6yJovWBwNIJOeJENBchw5KthpiKnE3qqr86xV8PMVq33WPhZ3FJWCCvzMwPoT3IPb0tUah6uRr5akX2+k3IJT7kjTI3gQLLtGLYR/pVPUFNnnLGaQgjC4cJro5sMpi8qqcKpyM7r4R5/A3eQA= 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=MZs+az0W; arc=none smtp.client-ip=209.85.210.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="MZs+az0W" Received: by mail-pf1-f202.google.com with SMTP id d2e1a72fcca58-728eb2e190cso1489456b3a.3 for ; Fri, 13 Dec 2024 00:10:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1734077447; x=1734682247; 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=EutDnAY7mwrSXgsBtbyoYyBKsUYR7YsmiVo+T3wjJHs=; b=MZs+az0WHesd9OtvK8Q/QLYoBPGL1o/02cnPKIC9DO6qvvsqqwooei40fTyoCL8Utk 0pMrOH71PU1FylBDJBfjWAW29tSf69S0g9PUkQMPsrRXrerrSRlDu/6zzXV1vqd1VLfc DJU1TacFNGXkgFJMre1W/qX3QRKBvEl6PzNdMk4cykzkYSEvA4yFbxEXXgVBIy65E+r8 j9aSNLI/l+VFQe+omxab56Bqi7Jr12YvcZMTaXLcx8hCcLvgEVhfAGv6VF6wX+ZZ5kUb 3hfson0LjsSrWw/fa+hW8devxXouyC/qfNcmV76GDXjy/Jvt9i8Po/j/v2NPgofbxR2n fwHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1734077447; x=1734682247; 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=EutDnAY7mwrSXgsBtbyoYyBKsUYR7YsmiVo+T3wjJHs=; b=QOW0zfRFN3GSu55w9PLYJj8o7GownAOkUXv3z3YPnorIyYUejrqLvOKHPv9by78jZW zpmP33RDwJ99Dl/yo9UppA/w6Q9sJ8VgKWJyHtEfGG0T0nEBIG9KU8j6CwklKCqOBTso neMLvEneAa7uX6bBo1LbNQF8Gs8uv0NtRwkG6dGeQ9ghV9qc0UpkN8pG9FOisLEis3jZ Wn9fRZgwwCoyZRdMxMdYb8joFtovQpIdDfC4FmeLWkutgp6WLo8fVIw7kudnEKa72eD7 tMfj29OyTj2UtKWncfnTILB6VrbQzfIA2kLHDD8cxEFotd3LpWcC3XvgB77+mrjC92GO 1uIw== X-Forwarded-Encrypted: i=1; AJvYcCXan4M44RB8O/qdigkPlinrvcbm50pyTZiVpI2J9JIIjYTqK012rSvMJSQGOAuo/dWlf7i2BKf9G0I7BNhPfb0=@vger.kernel.org X-Gm-Message-State: AOJu0Yy4zSeq3KKIBLWZazYX9qIlU8Jw1URbdtHHluM+cgorFHmPQFGt DEM0+xDmbQnU5FyDqQSTnVKhqZQHmcwTHKVVOfdtEaD1CG0spqbyxeuaE6Z2dhyt9iIVGoPo0Q3 RCYPk4MM7uA== X-Google-Smtp-Source: AGHT+IGDiY8+0N79pRvt65uYS7KXWtzJASUKFTVyKWuq0+4SJtuOiujR82grnuUCLr/wzeFvwfC2q2i8AfacvQ== X-Received: from pgbcz4.prod.google.com ([2002:a05:6a02:2304:b0:7fd:3f0e:ce05]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a21:6da5:b0:1e1:ae68:d900 with SMTP id adf61e73a8af0-1e1dfd61f20mr2903081637.22.1734077447635; Fri, 13 Dec 2024 00:10:47 -0800 (PST) Date: Fri, 13 Dec 2024 16:10:30 +0800 In-Reply-To: <20241213081035.2069066-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: <20241213081035.2069066-1-davidgow@google.com> X-Mailer: git-send-email 2.47.1.613.gc27f4b7a9f-goog Message-ID: <20241213081035.2069066-2-davidgow@google.com> Subject: [PATCH v5 1/3] rust: kunit: add KUnit case and suite macros From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride Cc: Brendan Higgins , 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 v4: https://lore.kernel.org/linux-kselftest/20241101064505.3820737-2-davidgow@google.com/ - Rebased against 6.13-rc1 - Allowed an unused_unsafe warning after the behaviour of addr_of_mut!() changed in Rust 1.82. (Thanks Boqun, Miguel) - Fix a couple of minor rustfmt issues which were triggering checkpatch warnings. Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-4-davidgow@google.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@google.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 | 118 +++++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 2 files changed, 119 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..5003282cb4c4 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -161,3 +161,121 @@ 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: &'static 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]; + + if name_u8.len() > 255 { + panic!(concat!( + "The test suite name `", + core::stringify!($name), + "` exceeds the maximum length of 255 bytes." + )); + } + + let mut i = 0; + while i < name_u8.len() { + ret[i] = name_u8[i] as i8; + i += 1; + } + + ret + }; + + static mut KUNIT_TEST_SUITE: $crate::bindings::kunit_suite = + $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 { core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) }; + }; + }; +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index e1065a7551a3..02a70c5ad8ee 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 Fri Dec 13 08:10:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13906645 Received: from mail-pg1-f201.google.com (mail-pg1-f201.google.com [209.85.215.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 0BAAD1A8F87 for ; Fri, 13 Dec 2024 08:10:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077454; cv=none; b=OsivTxoivHbQlqNwRloOwz9oDTNd+VeZPrTnV9A19LwA4SCVxTY90CeoDIZ/AnGTFnk96bYcX5uv8H5JcSjsBL8tNYc/E17DoIEgr358F/V5YjoBpkk0Kc4LIsiRRIEscqO77Eqy6/T9x7LBLfdKC6hh656ZUNM+66+M7TW+yMw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077454; c=relaxed/simple; bh=7/nW0ckfgKpJRW919MG005R3p7WpMPh+JsAFJlKqdJc=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=EQhD/U0Vn1/em822tbE6wK5Ri9p5AF7+fvkYPS9udmxc89XN5zzaGdqB6rA3dBSlUzsDMRC51jGwOuzQM1XKLqK3M4DWhuWUPMRphnmgQcmie9zGcw8UR8o864/y+MMISE9RodcTWr1VeuA/sGB9osHJdc0zkbpOr44eS0AUBTg= 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=RfkoC/Ns; arc=none smtp.client-ip=209.85.215.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="RfkoC/Ns" Received: by mail-pg1-f201.google.com with SMTP id 41be03b00d2f7-7ee3c2a2188so1160595a12.3 for ; Fri, 13 Dec 2024 00:10:52 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1734077452; x=1734682252; 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=Z8EsYYrfTRnHJ854mShX5sHUQzRetRLmknKNMm7CO4o=; b=RfkoC/NsOwvjgKfgEWsXHi/pqhMK7TNrnoquBYjNjVq/z6i105w9p9/a7czNenw6x1 0/yvbWDB3ohEIAis+EGVC0f+8GEyVOswHWxZDrfdGARNPeUA+FhIBMepsivUiAy/JDKS ZUx48AfJB39IcbREXlUgQYyCUQre5unvKlgXMZKTySHIYtyfLUNd5D34/jSbU/6Vi0nb StRgAAaaMgW9WyIu2IiRCxSmFt0JfHIQc0/K7vU4c77Ls3ZCn5bscM/1/221/V7eUcVA Yx4sBVMdZiKDet0ees3kcy5T0N9QBfsdAsdvF0w/LgZOiL0Hybcmc6hBJRh/Gi4nLXVz MYRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1734077452; x=1734682252; 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=Z8EsYYrfTRnHJ854mShX5sHUQzRetRLmknKNMm7CO4o=; b=j/P6If0RwAKq4QqBRjmkxzWtwEYQghbDXuM6u/ikEZxgvf6jcH1nEy3ZtcvVXDIlK8 XhblWe7K6fU60NPyhf96HtegBRe9WpnFzMhRwDnqYdQN5tLCEu5mSLyVl7ppTo6EYhvM TvJDb+HPomfGOxOM8usNtyA0tdHCirXWQ+s5SavEMjND4wsDAeWOSf94Y763sJuPY168 SNuwZC3e6RUIP5smHHPq8TwEh94prKzfrPS4VEpQR30EkzBhGp7pkQg7/Z2i5Lk7Pb+w RqQsAUCbKbuFCvgNfVeZpX1v9LzJkvNv27rU+N49OP0Z+o/+mGldDqv10kdB9jz4hMfP 3HQw== X-Forwarded-Encrypted: i=1; AJvYcCVA5NTFX9cpmEYwo7BBruXNLeZP/5+BmkwivgHEJi3TQdpjGyZgyT64MdR8/ffR2qWHs3UrxgbtZjHT8WShxn4=@vger.kernel.org X-Gm-Message-State: AOJu0YyN5zpo/ahW6X4oLPQJGnb8qKnMjF0kNNwMOpaqV+u40R3TlTZs plJHQcY5Ixse50wuipjFK4mzfHxoa1bE8+BWMqbVQ0tyh3boOPaJydrKDPUWiCgu842681/JDUi WyMm4TXl7ng== X-Google-Smtp-Source: AGHT+IE4RG7hSV/cz72bXiXtWdIby/pWoMf5BmapVhhbDHIU0hrQVgg+nN9QGWLHgEq4UDHHiuUYijsgmssyvw== X-Received: from pfud22.prod.google.com ([2002:a05:6a00:10d6:b0:725:eb13:8be8]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a21:6da1:b0:1e1:a48f:1246 with SMTP id adf61e73a8af0-1e1dfe6170dmr2191944637.45.1734077452231; Fri, 13 Dec 2024 00:10:52 -0800 (PST) Date: Fri, 13 Dec 2024 16:10:31 +0800 In-Reply-To: <20241213081035.2069066-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: <20241213081035.2069066-1-davidgow@google.com> X-Mailer: git-send-email 2.47.1.613.gc27f4b7a9f-goog Message-ID: <20241213081035.2069066-3-davidgow@google.com> Subject: [PATCH v5 2/3] rust: macros: add macro to easily run KUnit tests From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride Cc: Brendan Higgins , 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 Co-developed-by: Boqun Feng Signed-off-by: Boqun Feng Signed-off-by: David Gow --- Changes since v4: https://lore.kernel.org/linux-kselftest/20241101064505.3820737-3-davidgow@google.com/ - Rebased against 6.13-rc1 - "Expect" that the sample assert_eq!(1+1, 2) produces a clippy warning due to a redundant assertion. (Thanks Boqun, Miguel) Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-6-davidgow@google.com/ - The #[kunit_tests()] macro now preserves span information, so errors can be better reported. (Thanks, Boqun!) - The example test has been replaced to no longer use assert_eq!() with a constant bool argument (which triggered a clippy warning now we have the span info). It now checks 1 + 1 == 2, to match the C example. - (The in_kunit_test() test in the next patch uses assert!() to check a bool, so having something different here seemed to make a better example.) Changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-3-davidgow@google.com/ - Include missing rust/macros/kunit.rs file from v2. (Thanks Boqun!) - The proc macro now emits an error if the suite name is too long. 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 | 16 ++++- rust/macros/kunit.rs | 168 +++++++++++++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++++++++ 4 files changed, 213 insertions(+), 1 deletion(-) create mode 100644 rust/macros/kunit.rs diff --git a/MAINTAINERS b/MAINTAINERS index e6e71b05710b..cbe5a99eefea 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12562,6 +12562,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 5003282cb4c4..a92f12da77d5 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. @@ -272,10 +274,22 @@ macro_rules! kunit_unsafe_test_suite { }; #[used] + #[allow(unused_unsafe)] #[link_section = ".kunit_test_suites"] static mut KUNIT_TEST_SUITE_ENTRY: *const $crate::bindings::kunit_suite = // SAFETY: `KUNIT_TEST_SUITE` is static. - unsafe { core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) }; + unsafe { + core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) + }; }; }; } + +#[kunit_tests(rust_kernel_kunit)] +mod tests { + #[test] + fn rust_test_kunit_example_test() { + #![expect(clippy::eq_op)] + assert_eq!(1 + 1, 2); + } +} diff --git a/rust/macros/kunit.rs b/rust/macros/kunit.rs new file mode 100644 index 000000000000..c421ff65f7f9 --- /dev/null +++ b/rust/macros/kunit.rs @@ -0,0 +1,168 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Procedural macro to run KUnit tests using a user-space like syntax. +//! +//! Copyright (c) 2023 José Expósito + +use proc_macro::{Delimiter, Group, TokenStream, TokenTree}; +use std::fmt::Write; + +pub(crate) fn kunit_tests(attr: TokenStream, ts: TokenStream) -> TokenStream { + if attr.to_string().is_empty() { + panic!("Missing test name in #[kunit_tests(test_name)] macro") + } + + if attr.to_string().as_bytes().len() > 255 { + panic!("The test suite name `{}` exceeds the maximum length of 255 bytes.", attr) + } + + let mut tokens: Vec<_> = ts.into_iter().collect(); + + // Scan for the "mod" keyword. + tokens + .iter() + .find_map(|token| match token { + TokenTree::Ident(ident) => match ident.to_string().as_str() { + "mod" => Some(true), + _ => None, + }, + _ => None, + }) + .expect("#[kunit_tests(test_name)] attribute should only be applied to modules"); + + // Retrieve the main body. The main body should be the last token tree. + let body = match tokens.pop() { + Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Brace => group, + _ => panic!("cannot locate main body of module"), + }; + + // Get the functions set as tests. Search for `[test]` -> `fn`. + let mut body_it = body.stream().into_iter(); + let mut tests = Vec::new(); + while let Some(token) = body_it.next() { + match token { + TokenTree::Group(ident) if ident.to_string() == "[test]" => match body_it.next() { + Some(TokenTree::Ident(ident)) if ident.to_string() == "fn" => { + let test_name = match body_it.next() { + Some(TokenTree::Ident(ident)) => ident.to_string(), + _ => continue, + }; + tests.push(test_name); + } + _ => continue, + }, + _ => (), + } + } + + // Add `#[cfg(CONFIG_KUNIT)]` before the module declaration. + let config_kunit = "#[cfg(CONFIG_KUNIT)]".to_owned().parse().unwrap(); + tokens.insert( + 0, + TokenTree::Group(Group::new(Delimiter::None, config_kunit)), + ); + + // Generate the test KUnit test suite and a test case for each `#[test]`. + // The code generated for the following test module: + // + // ``` + // #[kunit_tests(kunit_test_suit_name)] + // mod tests { + // #[test] + // fn foo() { + // assert_eq!(1, 1); + // } + // + // #[test] + // fn bar() { + // assert_eq!(2, 2); + // } + // ``` + // + // Looks like: + // + // ``` + // unsafe extern "C" fn kunit_rust_wrapper_foo(_test: *mut kernel::bindings::kunit) { + // foo(); + // } + // static mut KUNIT_CASE_FOO: kernel::bindings::kunit_case = + // kernel::kunit::kunit_case(foo, kunit_rust_wrapper_foo); + // + // unsafe extern "C" fn kunit_rust_wrapper_bar(_test: * mut kernel::bindings::kunit) { + // bar(); + // } + // static mut KUNIT_CASE_BAR: kernel::bindings::kunit_case = + // kernel::kunit::kunit_case(bar, kunit_rust_wrapper_bar); + // + // static mut KUNIT_CASE_NULL: kernel::bindings::kunit_case = kernel::kunit::kunit_case_null(); + // + // static mut TEST_CASES : &mut[kernel::bindings::kunit_case] = unsafe { + // &mut [KUNIT_CASE_FOO, KUNIT_CASE_BAR, KUNIT_CASE_NULL] + // }; + // + // kernel::kunit_unsafe_test_suite!(kunit_test_suit_name, TEST_CASES); + // ``` + let mut kunit_macros = "".to_owned(); + let mut test_cases = "".to_owned(); + for test in tests { + let kunit_wrapper_fn_name = format!("kunit_rust_wrapper_{}", test); + let kunit_case_name = format!("KUNIT_CASE_{}", test.to_uppercase()); + let kunit_wrapper = format!( + "unsafe extern \"C\" fn {}(_test: *mut kernel::bindings::kunit) {{ {}(); }}", + kunit_wrapper_fn_name, test + ); + let kunit_case = format!( + "static mut {}: kernel::bindings::kunit_case = kernel::kunit::kunit_case(kernel::c_str!(\"{}\"), {});", + kunit_case_name, test, kunit_wrapper_fn_name + ); + writeln!(kunit_macros, "{kunit_wrapper}").unwrap(); + writeln!(kunit_macros, "{kunit_case}").unwrap(); + writeln!(test_cases, "{kunit_case_name},").unwrap(); + } + + writeln!( + kunit_macros, + "static mut KUNIT_CASE_NULL: kernel::bindings::kunit_case = kernel::kunit::kunit_case_null();" + ) + .unwrap(); + + writeln!( + kunit_macros, + "static mut TEST_CASES : &mut[kernel::bindings::kunit_case] = unsafe {{ &mut[{test_cases} KUNIT_CASE_NULL] }};" + ) + .unwrap(); + + writeln!( + kunit_macros, + "kernel::kunit_unsafe_test_suite!({attr}, TEST_CASES);" + ) + .unwrap(); + + // Remove the `#[test]` macros. + // We do this at a token level, in order to preserve span information. + let mut new_body = vec![]; + let mut body_it = body.stream().into_iter(); + + while let Some(token) = body_it.next() { + match token { + TokenTree::Punct(ref c) if c.as_char() == '#' => { + match body_it.next() { + Some(TokenTree::Group(group)) if group.to_string() == "[test]" => (), + Some(next) => { new_body.extend([token, next]); }, + _ => { new_body.push(token); }, + } + }, + _ => { new_body.push(token); }, + } + } + + let mut new_body = TokenStream::from_iter(new_body); + new_body.extend::(kunit_macros.parse().unwrap()); + + tokens.push(TokenTree::Group(Group::new( + Delimiter::Brace, + new_body + ))); + + tokens.into_iter().collect() +} diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index 4ab94e44adfe..beff19cc6d16 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; @@ -492,3 +493,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 Fri Dec 13 08:10:32 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13906646 Received: from mail-pf1-f201.google.com (mail-pf1-f201.google.com [209.85.210.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 787A51A2645 for ; Fri, 13 Dec 2024 08:10:57 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077459; cv=none; b=UOQAuqc8BgvPtEVsxlUcO6UCWkpocnMA8LJwWYY6/4qBoxZk4P5eFUdT68q5wM5YcnABRqV+nMvLHVTPS0we9K/0Qo1ip1rHzLfWPq4uoKJw/MOl0jhRGld6RqqlMjK8HKbjOIJ9iPVP+t2k0X2i7+pR+7FfxFyiMzxY1HwqZuA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734077459; c=relaxed/simple; bh=muBuT3/fw4rFJrq5xFQ+Ra6MjOtPX4OZHijECqYG8dQ=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=eFm2W191oDG8uu4FYroWXOIl1e1eHNKj1i6Omu6kM4z4bidK2wyuA37HQ7UzlzfKbpuCDRn6HLOyWp3DKjCIacmeoA2ebBNHTSfpfgyAkHL4yN4ZLk32aKYzVOnkJpynSRptjD78OKcoSq/FoEyee/1HZfLD+Ac6NM+R2LLywHQ= 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=25CRHmzk; arc=none smtp.client-ip=209.85.210.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="25CRHmzk" Received: by mail-pf1-f201.google.com with SMTP id d2e1a72fcca58-72726ced3f3so1511890b3a.2 for ; Fri, 13 Dec 2024 00:10:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1734077457; x=1734682257; 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=PrQ0AlLgEYLxlOCFUZxHBj34RLTPvztlmnit/cu7UGM=; b=25CRHmzk7yLY0N38jE5zROx4cARvOQ7LvdnVauXbmDR6j87VbNg2ZYa5T+OeXGvhp5 4VCRE7q9S3l3Zt0trx2wr6ln48mqklTcWBWHgOrVPvlHm4DZPOa+REmN50cdxXMJigYR T7Mk4rPoPjzpliMXE5+T9hNYAh+YcabyBamuBJCMJ7Tfr7LbBEmKddfSlj6KFV4Wg3o6 f0YTZjBY9a56g3FQzuxyesiO3Wi+JLFyAdM2mZ0EB51D+s1fsWnyKtJb8EgVhY+0MYKf rIELucBYct8wURa1m87jbUgj1/lihDNuaoNjcFm/aoRzxwQMKTywXzITcj7snxYOaQeq 0jHQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1734077457; x=1734682257; 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=PrQ0AlLgEYLxlOCFUZxHBj34RLTPvztlmnit/cu7UGM=; b=CRJq0zcXfcSbr8m92f1jO/0SdPZmbArlsJ/0S5sx1k6Sq0WGscZ/UGF06l8pBXeXSv tfTBA/sLP5JvV4CqilADMDUVga3RVjqmbGusJs1NQypW4Ly0Tcd5luzvWTIE37V/fUw8 Jomq3lu2GbdVDTeV3X4u0EDV4p2FvwZi2dhEPuhEu0ZlxMVuVd6V+s4JFeaLVuOmrvUf t0WbvJ1sFhgl+OlGHjvYEwRBk0e/MbQkFB5olqGG8Y150a1wSynmr9GALFHXUHxvFmKB x4Pq5nVNvaEb5MPru5CZQRAsrpfyROWqa6JUXUgZhtcfUWOdNFWskB9JPyBQ3W6oVRIB iEAA== X-Forwarded-Encrypted: i=1; AJvYcCVXNUyZwooDn1W9cdd+X6LVD3CotJtaYHlIrBUum7g4s9rtfo20sIa9XiEexVLhs7ZUkrKthkgUP3BbrRYD0ok=@vger.kernel.org X-Gm-Message-State: AOJu0YwH1Czvxqo+kRYF82TKjOUA2PK2F33yAFqH2DoxdJDSsKaNKsfv cMrbOhpi9HDQXL4R+O/SATW3OJv7/YFhN9rt3GtOZVa4xqpc7j3gz1m+xWrgNShjjvpP9xfi5nz IQ0tGUWHqcQ== X-Google-Smtp-Source: AGHT+IE20r9i7LSXHxGlRRrGX5jraUibLl/FufsitEHqK5okZqnX9FSquFIcCA+5Lr9N/9ktxgLKuC+kX5f3rA== X-Received: from pfbhj4.prod.google.com ([2002:a05:6a00:8704:b0:728:c6d8:5683]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a20:c99a:b0:1e1:cd09:e08d with SMTP id adf61e73a8af0-1e1dfd3533bmr3125607637.11.1734077456782; Fri, 13 Dec 2024 00:10:56 -0800 (PST) Date: Fri, 13 Dec 2024 16:10:32 +0800 In-Reply-To: <20241213081035.2069066-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: <20241213081035.2069066-1-davidgow@google.com> X-Mailer: git-send-email 2.47.1.613.gc27f4b7a9f-goog Message-ID: <20241213081035.2069066-4-davidgow@google.com> Subject: [PATCH v5 3/3] rust: kunit: allow to know if we are in a test From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride Cc: Brendan Higgins , 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 v4: https://lore.kernel.org/linux-kselftest/20241101064505.3820737-4-davidgow@google.com/ - Rebased against 6.13-rc1 - Fix some missing safety comments, and remove some unneeded 'unsafe' blocks. (Thanks Boqun) Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-8-davidgow@google.com/ - The example test has been updated to no longer use assert_eq!() with a constant bool argument (fixes a clippy warning). No changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-4-davidgow@google.com/ 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 | 75 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index a92f12da77d5..2196e35e5d75 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -285,11 +285,86 @@ 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) fn ktime_get_boot_fast_ns() -> u64_ { +/// if in_kunit_test() { +/// 1234 +/// } else { +/// // SAFETY: ktime_get_boot_fast_ns() is safe to call, and just returns a u64. +/// // Additionally, this is never actually called in this example, as we're in a test +/// // and it's mocked out. +/// 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 { +/// 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_example_test() { #![expect(clippy::eq_op)] assert_eq!(1 + 1, 2); } + + #[test] + fn rust_test_kunit_in_kunit_test() { + let in_kunit = in_kunit_test(); + assert!(in_kunit); + } }