From patchwork Sat Feb 15 09:06:18 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13975976 Received: from mail-pj1-f73.google.com (mail-pj1-f73.google.com [209.85.216.73]) (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 4498F19F48D for ; Sat, 15 Feb 2025 09:06:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610398; cv=none; b=ck577tlN1AXpC3V8MxHivlUib7U9YOzTP3bQXwUZCFgdFT1ZnXPOezYHqLPcPW87Ut/y0zH2u4qMR81JB79OMAxjIJGTPIu5VtMTTSLNiImste6XDx7br2xKjWZ5vfMRUtxdXZpnryxfMGxoMGvvqqNw5PyX+MRaDGOkOl8rLyI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610398; c=relaxed/simple; bh=GagErhGsHpp3IGT4h4dC4/7to7kdouV1RwL8jKYaTjk=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=pnfErmXzh3SrCHh3d1SIwKpd+cQlosKibDx7mpMR6xhVUeDrdSS391zIl0ODlGiGANBy4wLWFKh8uDz6FQOaxPLqaldWG69Ft5z6XL1cQ2QNcrBIgma/eW33P/2bpg1/RbDDFvseg68JhaHXXeVF/q0Ct8UHpYqxToDnqM71gLU= 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=hdh97DW+; arc=none smtp.client-ip=209.85.216.73 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="hdh97DW+" Received: by mail-pj1-f73.google.com with SMTP id 98e67ed59e1d1-2fbff6426f5so5943374a91.3 for ; Sat, 15 Feb 2025 01:06:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1739610395; x=1740215195; 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=mWQaqrhkGlaLBfu/rmr596S3UsF7HKNYDc8qgpOE2V4=; b=hdh97DW+ZpAMDWHFpoJUQzWy7OqpKfaFXuq0vGNyM6Rkwfho/XpPaS1Vn81SCnOWg2 jgnHK8bmAplbKZ+nSAuLA/g09J5vdwr6zpsP58THTliffmkD22S3NHbpq44/eA/n0NXV BX9UL32vnTtU7G04JX7TILKCAymK2TGc9NhukwWglqvlgDN3nWZqn7HOmOpanBHxDYsZ C/l1P7KXzWflI1Dl4+tMc3MoYwGxYGUXZHLlcKJsJBmZPg1SiNwcv6l+8k+NziI3d/uB gjMerlGecu8y9cVEjWx/s5gwA64xtHdk/TV/bbEHPu4UTRM6/V482eiqswraMc+nXO/i 0hyg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739610395; x=1740215195; 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=mWQaqrhkGlaLBfu/rmr596S3UsF7HKNYDc8qgpOE2V4=; b=bGUvIlhVfCxUFf2NGMaO/PSLTwTeHM+h+gAFOEqyUTiXkYbh3hMy1AYG8S36Rs9fys d0eY9lg4z3HsnPmRdunlFN4/RVUBJVdzSOjPWImDn1ynZqRqRzeOYr5GFY3s3uwHJghl MRUxXrF903KBY1Al9+XvHGvYl+ODoRAaBGYoTnq68wlV7BYC2vM2YSALWJlvgdoWhPe3 GjMy5wuQxcwCup3yNzkGb1nQzpz0aGPZ7zLWh6TY6iPuYgB14Bf6q7hBRFHoqaRNx8UK G4XiygjE5HCcwm3sP8f2mI8j9aWwlSRDXa4vKhWafA6l7+9Il6aAp7VKP5SXYMN9wBl5 kGcQ== X-Forwarded-Encrypted: i=1; AJvYcCW1kRoFDJwZt27vwj0+d1HxSTPc6VT97/fMqpgBca2mFA95icpyLx0qgXbf8XnbQI3XxaK6kx5X+hbleqc0eRY=@vger.kernel.org X-Gm-Message-State: AOJu0YzNTDrWvnSdQcWUiDIFViiZ7ufjLL+Sg1CXDENligy87wSMkRf+ EXK9Q8UpsxYdvBEK5jVF7p+Wv1X9XKTjPlDXsd3m5yW9apDHBDmUZ71hbA8dB0Bi21Docpq17hV jYtndumUauA== X-Google-Smtp-Source: AGHT+IFHDTbfpLDgjvBT6wwAVZ9QgzzcV5wj0a+ddj4HjyXvsLUa35Bhrp84KvOB0nJ7on+IsQR7ktnFyZK72g== X-Received: from pjbnd14.prod.google.com ([2002:a17:90b:4cce:b0:2fb:fa62:d40]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a17:90b:3f06:b0:2ee:c91a:ad05 with SMTP id 98e67ed59e1d1-2fc40d14c84mr3609691a91.3.1739610395592; Sat, 15 Feb 2025 01:06:35 -0800 (PST) Date: Sat, 15 Feb 2025 17:06:18 +0800 In-Reply-To: <20250215090622.2381038-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: <20250215090622.2381038-1-davidgow@google.com> X-Mailer: git-send-email 2.48.1.601.g30ceb7b040-goog Message-ID: <20250215090622.2381038-2-davidgow@google.com> Subject: [PATCH v7 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 , Brendan Higgins , Tamir Duberstein 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: Miguel Ojeda Signed-off-by: Miguel Ojeda Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v6: https://lore.kernel.org/rust-for-linux/20250214074051.1619256-2-davidgow@google.com/ - Fixed an [allow(unused_unsafe)] which ended up in patch 2 instead of patch 1. (Thanks, Tamir!) - Doc comments now have several useful links. (Thanks, Tamir!) - Fix a potential compile error under macos. (Thanks, Tamir!) - Several small tidy-ups to limit unsafe usage. (Thanks, Tamir!) Changes since v5: https://lore.kernel.org/all/20241213081035.2069066-2-davidgow@google.com/ - Rebased against 6.14-rc1 - Several documentation touch-ups, including noting that the example test function need not be unsafe. (Thanks, Miguel) - Remove the need for static_mut_refs, by using core::addr_of_mut!() combined with a cast. (Thanks, Miguel) - While this should also avoid the need for const_mut_refs, it seems to have been enabled for other users anyway. - Use ::kernel::ffi::c_char for C strings, rather than i8 directly. (Thanks, Miguel) 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 | 122 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..ffb3606f748c 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -161,3 +161,125 @@ macro_rules! kunit_assert_eq { $crate::kunit_assert!($name, $file, $diff, $left == $right); }}; } + +/// Represents an individual test case. +/// +/// The [`kunit_unsafe_test_suite!`] macro expects a NULL-terminated list of valid test cases. +/// Use [`kunit_case_null`] to generate such a delimiter. +#[doc(hidden)] +pub 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 returns such a delimiter. +#[doc(hidden)] +pub 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 valid test cases. +/// +/// # Examples +/// +/// ```ignore +/// extern "C" fn test_fn(_test: *mut kernel::bindings::kunit) { +/// let actual = 1 + 1; +/// let expected = 2; +/// assert_eq!(actual, expected); +/// } +/// +/// static mut KUNIT_TEST_CASES: [kernel::bindings::kunit_case; 2] = [ +/// kernel::kunit::kunit_case(kernel::c_str!("name"), test_fn), +/// kernel::kunit::kunit_case_null(), +/// ]; +/// kernel::kunit_unsafe_test_suite!(suite_name, KUNIT_TEST_CASES); +/// ``` +#[doc(hidden)] +#[macro_export] +macro_rules! kunit_unsafe_test_suite { + ($name:ident, $test_cases:ident) => { + const _: () = { + const KUNIT_TEST_SUITE_NAME: [::kernel::ffi::c_char; 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 ::kernel::ffi::c_char; + i += 1; + } + + ret + }; + + static mut KUNIT_TEST_SUITE: ::kernel::bindings::kunit_suite = + ::kernel::bindings::kunit_suite { + name: KUNIT_TEST_SUITE_NAME, + #[allow(unused_unsafe)] + // SAFETY: User is expected to pass a correct `test_cases`, given the safety + // precondition; hence this macro named `unsafe`. + test_cases: unsafe { + ::core::ptr::addr_of_mut!($test_cases) + .cast::<::kernel::bindings::kunit_case>() + }, + suite_init: None, + suite_exit: None, + init: None, + exit: None, + attr: ::kernel::bindings::kunit_attributes { + speed: ::kernel::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] + #[allow(unused_unsafe)] + #[cfg_attr(not(target_os = "macos"), link_section = ".kunit_test_suites")] + static mut KUNIT_TEST_SUITE_ENTRY: *const ::kernel::bindings::kunit_suite = + // SAFETY: `KUNIT_TEST_SUITE` is static. + unsafe { ::core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) }; + }; + }; +} From patchwork Sat Feb 15 09:06:19 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13975977 Received: from mail-pl1-f201.google.com (mail-pl1-f201.google.com [209.85.214.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 D34131A2385 for ; Sat, 15 Feb 2025 09:06:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610403; cv=none; b=DJ4giBLvyekBb5XQU2w+YULAM23iWtjo9dshkdsQvI17/KePAhSq8d9ma99GSN8lR4gPGHQVEKyQjNPj6hydCOAPph/dI9bpZf3YnmotFDo5VY9pKEozER+Mng6SFA1BpJYE5FLIl4lFwX77oRIIiduLJD6hIF4WnlnNnfAvXOE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610403; c=relaxed/simple; bh=Nbtx1ZZG8G7zpHKsLhRI5JfHcsoGpOWh6u+1onWJlzc=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=iOXhgtUi/hIijAgbQjZYVqS/CbvueLzXBS0l7yVGSAUitlhpoaXsc63+xphCI7pFtfrAWABAXs+HT1oCRfbPuBRRGfDTiMWdqBR3v7mlzyFJkrAdu78tinTBj5dX/z1zPKTPc5oMhYamvXahTvPVzCNCdJQCYk3fDa1sOxeDxDA= 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=EF0k0G8r; arc=none smtp.client-ip=209.85.214.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="EF0k0G8r" Received: by mail-pl1-f201.google.com with SMTP id d9443c01a7336-220f0382404so31102085ad.1 for ; Sat, 15 Feb 2025 01:06:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1739610400; x=1740215200; 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=NZQS1//8LDuq5E99gzZTq+mP8zSK2QukTZe2LwXRVVI=; b=EF0k0G8rg4xi++VIPxZd6YX69oqtCQxUNTNKjDs7o2rhkr/i28q8n0JDEP+EB2DdTu SICgdOPOf7Z8Lzqx3GzZDVT23jQtmpzzCtogvr0FEU6K5GIwFOkHgSTkXK9PM4tcodVO YA+BRnsMzK6G/Vl5eDEwrFZRGdbndp7xb+TnKv8bdhe6FoNwV8YnF8KfKfO/YTPxtg7r NgMCSFH51f55Fy3PA1EDsWclhW5qQOPkX+1f6AMMnHspJLj5Ex/SlayaDezpmdEFZBvH l+GcieXL6GzTT6oOwhZAEx7ZI8VMDT5Hsju62qaTSF8yT8lt/U3jkHZnjzJhJ9v1U+U/ Sx0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739610400; x=1740215200; 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=NZQS1//8LDuq5E99gzZTq+mP8zSK2QukTZe2LwXRVVI=; b=L4WlfT8f2I3nwktsUGTgqnKiCixzkpUTPGmxeWq9rPyQsPJxmUdBitIWserPmcfUdQ tOFGV4KVd41z1spU20fKuojMDn3i4PIw8DXEfWCctUymHgGfu3CWv0/48EPZPajDqJB5 Atm40X5JwmIXMmt7w54OZLql1umUHE0yI4mfkA+zZ6NC0pqzSicUTfWl4Lwsly1DtLow Vn2DDDyPlLDRibiNEicCEOhpfaugdlznL4wPGE6SACa6xDo62ZkVo5NorTshy8OgRytT P5YqvCAhzvXEuLWO/6tcALYvp4DSOzzAUCEXvSXxn6wNOpW4X3qH8V/iVnl69SGKqPoX eukw== X-Forwarded-Encrypted: i=1; AJvYcCVazdb9IHjPPyI5WNIKHCEwInRitr9MYAxhKUCKMYvMjBL9Dx9MSishV4+nD97SGQMLflk/JAlTcWsehanu62k=@vger.kernel.org X-Gm-Message-State: AOJu0Yys4q5KXzT8fUeXT++NjVF95AmQi/FcnmYMIJboQPscT3KLCViJ ekyR/o7uH0E/arhEdOtkH2O1Y3qIaUt/eK5Bu0Flty/wtCVDXxzq/vyBKObj6DR+Y5a+GbqSupn T2cBOusTK+Q== X-Google-Smtp-Source: AGHT+IHmQuuP8sHvg+8cVuSmaU83MYhNZBI7kGvCYKd0VfQryt/GZhhRmPZcConpYuh4c8yfjPhUocc+on2+3Q== X-Received: from pgn7.prod.google.com ([2002:a63:d47:0:b0:ad5:52c1:c4dc]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a17:902:f68d:b0:220:efa7:7bd3 with SMTP id d9443c01a7336-221040c0838mr33342275ad.43.1739610400078; Sat, 15 Feb 2025 01:06:40 -0800 (PST) Date: Sat, 15 Feb 2025 17:06:19 +0800 In-Reply-To: <20250215090622.2381038-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: <20250215090622.2381038-1-davidgow@google.com> X-Mailer: git-send-email 2.48.1.601.g30ceb7b040-goog Message-ID: <20250215090622.2381038-3-davidgow@google.com> Subject: [PATCH v7 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 , Brendan Higgins , Tamir Duberstein 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 Co-developed-by: Boqun Feng Signed-off-by: Boqun Feng Co-developed-by: Miguel Ojeda Signed-off-by: Miguel Ojeda Reviewed-by: Tamir Duberstein Signed-off-by: David Gow --- Changes since v6: https://lore.kernel.org/rust-for-linux/20250214074051.1619256-3-davidgow@google.com/ - Fixed an [allow(unused_unsafe)] which ended up in patch 2 instead of patch 1. (Thanks, Tamir!) - Add Tamir's Reviewed-by tag. Changes since v5: https://lore.kernel.org/all/20241213081035.2069066-3-davidgow@google.com/ - Fix some rustfmt-related formatting shenanigans. (Thanks, Miguel) - Fix some documentation comment formatting as well. (Thanks, Miguel) - Tidy up the generated code to avoid unneeded &mut[] everywhere. (Thanks, Miguel) - Fix a new clippy warning for using .as_bytes().len() instead of .len() directly. 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 | 11 +++ rust/macros/kunit.rs | 161 +++++++++++++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++++++++ 4 files changed, 202 insertions(+) create mode 100644 rust/macros/kunit.rs diff --git a/MAINTAINERS b/MAINTAINERS index c8d9e8187eb0..4e7a6d2f2c49 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12677,6 +12677,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 ffb3606f748c..2131443a5f1e 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. @@ -283,3 +285,12 @@ macro_rules! kunit_unsafe_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..4f553ecf40c0 --- /dev/null +++ b/rust/macros/kunit.rs @@ -0,0 +1,161 @@ +// 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 { + let attr = attr.to_string(); + + if attr.is_empty() { + panic!("Missing test name in `#[kunit_tests(test_name)]` macro") + } + + if attr.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(); } + // unsafe extern "C" fn kunit_rust_wrapper_bar(_test: *mut kernel::bindings::kunit) { bar(); } + // + // static mut TEST_CASES: [kernel::bindings::kunit_case; 3] = [ + // kernel::kunit::kunit_case(kernel::c_str!("foo"), kunit_rust_wrapper_foo), + // kernel::kunit::kunit_case(kernel::c_str!("bar"), kunit_rust_wrapper_bar), + // kernel::kunit::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_wrapper = format!( + "unsafe extern \"C\" fn {}(_test: *mut kernel::bindings::kunit) {{ {}(); }}", + kunit_wrapper_fn_name, test + ); + writeln!(kunit_macros, "{kunit_wrapper}").unwrap(); + writeln!( + test_cases, + " kernel::kunit::kunit_case(kernel::c_str!(\"{}\"), {}),", + test, kunit_wrapper_fn_name + ) + .unwrap(); + } + + writeln!(kunit_macros).unwrap(); + writeln!( + kunit_macros, + "static mut TEST_CASES: [kernel::bindings::kunit_case; {}] = [\n{test_cases} kernel::kunit::kunit_case_null(),\n];", + tests.len() + 1 + ) + .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 d61bc6a56425..50b58259c577 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 Sat Feb 15 09:06:20 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13975978 Received: from mail-pl1-f202.google.com (mail-pl1-f202.google.com [209.85.214.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 559251A2C06 for ; Sat, 15 Feb 2025 09:06:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610407; cv=none; b=GJx27kxYlqiub5n4LmsVnB7CgIX+9TpYuCVJ0JRALoPl0dQjFss0WPCAPg3Es7am/fIOMsb+A8ZKzXTEYXE3T2jSjRtXoLsAVxdPJSdSgYp5tOS6yKxRC5K2F1WeFd5299w4F34uQUCh+gx9xdVHgFrclMrBz2kFtkBQdgME3sA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739610407; c=relaxed/simple; bh=Brif0Uu+CgbP+MFCn/3eNgcrnGLZavM1s9AzupsE6jE=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=EgFYN0KiIHCJwD7voB0Y18kPHsILr9+bkNzpOhFjBCQuYw4McFVdMMVxMTar8oQPrKMtwKk4cPGrFC40Dl2v0R3uiBjbG9C4VuC1Xbiu107G32SgDwaLWIBCxAKL3DdeVeQnVesrx3+9UlrGzcpwAqzBNazstAoAZRPSA/Iqhwc= 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=lOX6PmKl; arc=none smtp.client-ip=209.85.214.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="lOX6PmKl" Received: by mail-pl1-f202.google.com with SMTP id d9443c01a7336-220d1c24b25so60844605ad.0 for ; Sat, 15 Feb 2025 01:06:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1739610405; x=1740215205; 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=yNO63Q8fUF1rvzf4dCO7HftqO6PY/IYB86cB56hZgtY=; b=lOX6PmKl2IzOB8A/H3k0Rfrwx4xWA4iGwVyeJ3NURufEtJ/CPJQSnzXa0BnneysS/z l638Rqcg4Guj89aCYILmjWmP3aZ5AcgdLh33dX9WhRCxvZCWb9//rH6su2gx1Gf0tobW bd3nL0h2pXLLUVD6Qj73badNaLDSN13qvQc/2N8Mv0gMdnzW1iZPrFrC6ijPDzPBUBJk EWwPVyIX6tlWZ+t/XsIDdNv0uSJo4mXzrGkiFLAVq4xRZi5CrntgBvCfsvaD4cKxdQYO gwljaFQnYZ4gmjlzRWW5d6qFb/vYx0LNBomJSqRySc8Rg08VUuGGaqW/1CsQWIG3lyAt ELcA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739610405; x=1740215205; 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=yNO63Q8fUF1rvzf4dCO7HftqO6PY/IYB86cB56hZgtY=; b=Xya8s1dcrzWnJycCqJBzjbV8AXkE77utaMTfTsMVawGljfXnxd5isgL38AbGob9SF5 KI0SvKHgQla3yF7wyQWOJvFoc+39bFZ8EMHU8OJSFhW3ZmqeN6PO/ZwvklMR/B2CwnWl FAX9fxF+pcFcIy3sN+7RJOsUeqa7j70rG+Vy5XLecZVuY4Uyxah4FIeM4VXw2HB8K27q IVdHuxCfci0S/YL30jYe4r6F/4GssvJU0KSX7/Yepop0w8f2TWvOFhRWUYB9+b03iHK9 dIDIML1L6C4DQK2jxOqj8riYHaMhLkVtgrF/aFM9D937ICqtlyH5e3P8O3TBRVwZ1CWu 9faA== X-Forwarded-Encrypted: i=1; AJvYcCWxB3STToC+1uf8KaeFqRBFG4ZStieWixQRRVhz4qPxt3/jYjwJsq+qjJT/YDgfKmlA4shpLs2NfuUu4rhA6wo=@vger.kernel.org X-Gm-Message-State: AOJu0Yz2UBOrzP2Xkom1oqREsC3sraGL20Ef4NiT0VqGjM/tMUAfu2jF YYER6id757bY4mCfW+nlc3fC8UImY1mx4bxyOeFRVp22ljZIf+9YwwRsLbh+wuEdMSnMfinHAVA /BGrlZo1+mQ== X-Google-Smtp-Source: AGHT+IHtFENxipav4o9tqRA/ja1GzbDCGx7710bdD1BFLEpzmG+fgognz6SYkYpQwhD6qiYIX2BeQfkGlf/crg== X-Received: from pfbbq17.prod.google.com ([2002:a05:6a00:e11:b0:732:222e:ac25]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a21:999e:b0:1dc:7907:6d67 with SMTP id adf61e73a8af0-1ee8cbf7a69mr4953468637.40.1739610404506; Sat, 15 Feb 2025 01:06:44 -0800 (PST) Date: Sat, 15 Feb 2025 17:06:20 +0800 In-Reply-To: <20250215090622.2381038-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: <20250215090622.2381038-1-davidgow@google.com> X-Mailer: git-send-email 2.48.1.601.g30ceb7b040-goog Message-ID: <20250215090622.2381038-4-davidgow@google.com> Subject: [PATCH v7 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 , Brendan Higgins , Tamir Duberstein 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: Miguel Ojeda Signed-off-by: Miguel Ojeda Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v6: https://lore.kernel.org/rust-for-linux/20250214074051.1619256-4-davidgow@google.com/ - Doc comments now have a useful link. (Thanks, Tamir!) - A small tidy-up to limit unsafe usage. (Thanks, Tamir!) Changes since v5: https://lore.kernel.org/all/20241213081035.2069066-4-davidgow@google.com/ - Greatly improved documentation, which is both clearer and better matches the rustdoc norm. (Thanks, Miguel) - The examples and safety comments are also both more idiomatic an cleaner. (Thanks, Miguel) - More things sit appropriately behind CONFIG_KUNIT (Thanks, Miguel) 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 | 66 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 2131443a5f1e..91aa49da0265 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -286,11 +286,77 @@ macro_rules! kunit_unsafe_test_suite { }; } +/// Returns whether we are currently running a KUnit test. +/// +/// In some cases, you need to call test-only code from outside the test case, for example, to +/// create a function mock. This function allows to change behavior depending on 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() { +/// return 100; +/// } +/// +/// 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; +/// #[cfg(not(CONFIG_KUNIT))] +/// use kernel::bindings; +/// +/// // This module mocks `bindings`. +/// #[cfg(CONFIG_KUNIT)] +/// mod bindings_mock_example { +/// /// 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 { +/// 1234 +/// } +/// } +/// +/// // This is the function we want to test. Since `bindings` has been mocked, we can use its +/// // functions seamlessly. +/// fn get_boot_ns() -> u64 { +/// // SAFETY: `ktime_get_boot_fast_ns()` is always safe to call. +/// 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 (it has fallbacks for + // when KUnit is not enabled). + !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() { + assert!(in_kunit_test()); + } }