From patchwork Wed Oct 30 04:57:12 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13855914 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.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 C77C7194143 for ; Wed, 30 Oct 2024 04:57:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730264271; cv=none; b=O/xGhaut88Nj7xvMe+v0YD96xF+uwpOhEFEKek/U20qYgxN1SM7KsiAHgtP+dEjX6G+AQBiGh5ale575xP800+iHGFbWP582h1S/V6GwsqPpe3F302I+LNbH/jJ0SLkNOf4xkc7PfxUgBNOwmLDYAhAlTOf+WZGvfhH45ueCrYM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730264271; c=relaxed/simple; bh=ofdkUPJlxuL46W/T+59jOFZ2yuwS+E3iRYMwYsa9j/Y=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=sixaIJr0gxW9sWsYG3Kdt1p+McpzkDAEuIIUyEPU1c+WaGSuNpx3SOLAAmzpPATiUElCwLx5N/ejWEpIjxUAB3R4YPss8azIhA9jWIrjQB+Nh+rC5Movva6sMObmAp4bMAvx2+gaOq/nWTPSoHN2tTGR4VRAQl4NYsuB0hJJm2Q= 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=WoWi7NnR; arc=none smtp.client-ip=209.85.128.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="WoWi7NnR" Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6ea33140094so24748257b3.1 for ; Tue, 29 Oct 2024 21:57:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730264267; x=1730869067; 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=YTuusXd3hhJ3dEnI/ZXmmiM2jcBROg0gUL5aBvA3L34=; b=WoWi7NnR+5gSaFf9rO1jbp/vBouE/beMz9Jdeion2GKx2mFbvhsbPfKpLOFcvTaKN8 zMdsCzMWCXduV6H14H/VJkVhml2LpideFtGVHZw/6i//Hxv8VahEcm/AnH8MbUBiaWD9 4zVC4zVS012LB6+a4XVz81LgGl6ajbOoBJB/ND9f8IopSV0gpCJWp1TP2bm/cp3WAYyX xZygOju41BtfjU5IqOki+XpyisYpvVlMLz3IL42/o7bzuNjRNJG5Bdn2myLRrdWD4vRc ZJgW2HUTRll9IfsnA0MPAKD54Rx15zrJCtkCMPIhV4+mzoNWemCD8lrBO0v4vCLPL2Bp c63w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730264267; x=1730869067; 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=YTuusXd3hhJ3dEnI/ZXmmiM2jcBROg0gUL5aBvA3L34=; b=PfLBpkljbYLKw8qdGRX+wJzWHO49iE25JQfJptx3EsFxWH71sJvYlAafCH3BRAGQzf xOnzMcAA3oJA1pe60GRwR6u4q0kSxRuzFgZz9dL5T00ofxDvXt6MM26n3LhVks1FAnUn qHqte7T7JWcO2QK6+hX0PTJZ005kssMiRaGo/UlwsQxIhjNbyz2jUwC15eI7YfCB12GJ c/1+N8F0HTf87AsBVnIXXSUogtsuS0PAhFlf9tUEX1xR33J46z76qbrJZNYisR7ym59z uuKRmEKH5l1dgfoIJzNX3aYojLbhtaO7NWd/si7OGuCHW2bUTKbagzUhTM2u1DqWRhU2 l/VA== X-Forwarded-Encrypted: i=1; AJvYcCXZXYt4ZfxiDb5MR5BAYaUfvnk20v2rqJjHi1KgYydZavlzkSTLokaH4f0oyb80vURXvcy5IX8Rc2a700L0iwI=@vger.kernel.org X-Gm-Message-State: AOJu0YzU9XVIFQVAIUajOm4OgSRdUCEng9b1m1/8ZTph64Bv1kzX54eV nuypKP6XLP/OztgRSMR6DweETJh9oTTDFH3XM8a57ef+MuyonSk+z/0GnsvQok27/jm4xLTZGZF keAAHX/1IQA== X-Google-Smtp-Source: AGHT+IFNeZ/cLwpQ1iHhtQMFGT9RXhAzCHnLFR9ILDekhdgcluikbDQVZ32PNJA8Ev+3bAXCQgkuRsdVRWhYVQ== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a81:a884:0:b0:6e7:e493:2da6 with SMTP id 00721157ae682-6e9d8b16e66mr2494047b3.6.1730264266742; Tue, 29 Oct 2024 21:57:46 -0700 (PDT) Date: Wed, 30 Oct 2024 12:57:12 +0800 In-Reply-To: <20241030045719.3085147-2-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241030045719.3085147-2-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241030045719.3085147-4-davidgow@google.com> Subject: [PATCH v3 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 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 | 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..27bc4139d352 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: &'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]; + + let mut i = 0; + while i < name_u8.len() && i < 256 { + 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 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 Wed Oct 30 04:57:14 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13855915 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.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 55A41198E9E for ; Wed, 30 Oct 2024 04:58:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730264291; cv=none; b=Oly/YT53l+cEhWW2pkwDDoYeOf+W1+LAi28NJfHrTEno4MkPZceBe4jpoxxFhostJPF6SDAJYl3x/gQ/Wdv+NZp6UkROh9QlTQjxe10AjRhGKO2RrxHj6koYsbllCS55xZs+bZ2y1x9nO/0TwDKTCpKn3wo3BZFx0+pNFdm1IuA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730264291; c=relaxed/simple; bh=IsP2QsBuhSMQv2TLDNhGZT53gA6T/nJME1+2FfZ8xF8=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=UszThU1e0cBGYmXKK3/R3aDCfzX7m4COhAd59NCGuBUoV3tlare8fn7L9QGQoAg1BkoVp34WC8tt7M04Us8CcLPCyZpTPrpc+vWr+NbtuicOuApgJcwsRkeYm06PuGtufaJZLlz0GLXslFbu9bRIMFApZzTjeLz38RKft0yMXX0= 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=x+QwqxXp; arc=none smtp.client-ip=209.85.128.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="x+QwqxXp" Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e7f633af02so88858937b3.3 for ; Tue, 29 Oct 2024 21:58:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730264288; x=1730869088; 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=Ku4FplA1xCd+FjxcfF6HZsAqyqZMYh/cz6ZleWHy2rE=; b=x+QwqxXp04ARLsal/ffxExQ2en5/uxSkbkpC/mB6ZjptRMrV4TQYgJai8tReibRz0V B9sGKLMEqLq9JGuTMlu13pY9umg7d2TqNmMSls4ZfPLbBD30vhxoyMZjNT9WPJpj1p7V P+ULM+1R9Swfsz6REayBYyKXztxzvG7wzZ1c+1Ne9KwDh4AjcFYJMgMQgBvSe4uUksQd pMdLwhCfUDR2Ivpfe0Dc8MaLC4wH34wSf441xfDE+FCwUY+L7dZlLlZaA3t4i9HFY4Cm za8Kjz1HQKw+zwxX1T8Ja/oLd17ZV95EWSCQMfnWzKSPD0Z7VSLdHMZuUkBUx5YjB9kZ 4KuQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730264288; x=1730869088; 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=Ku4FplA1xCd+FjxcfF6HZsAqyqZMYh/cz6ZleWHy2rE=; b=RXuwrr2Ucysxn4RSRt9WinZIi8kzfXjacW6P0davbxTT6nUJriYmewR4wp4jEqer0l F8seTn70psex0e1aayjtPr5dlaNo1/hC3NEn1RzTHhEeN9Rm31vOc1oHkMzWiuN4mKtp wIXzTQZWwBa8OHtRrKdChiGsVxTFqGS/9BrqKJnLsYZJsOu3U9pZDLPmbzkLqaNDQDho IUp9FmQyLUWnodrvnGvyPIh36lKS4QBV4tUdyQSUX28N4Zbp8xPQKxWeb0qCvkGnsk/r xloFpUQIT8KX5b+3hCNgl2oZrQzeqksXOu2hrI/ODx4Ri4cNJZMQO5d/+7atcEyU51R5 e+wQ== X-Forwarded-Encrypted: i=1; AJvYcCUA8Q4n0tfoQweyQ6wHoefUbre/7IxWBob+gYQ7CZk45UyrLcebLhS5tbXrkpN0b9m5G8QSNbWr4x4FCNuZvTg=@vger.kernel.org X-Gm-Message-State: AOJu0YxIo+THm8mohmsOwx9itJkfEXkBMlYb3j0R1LCi+rBDeNLCyc/4 xXTBnQOlvXa14U30comwT8HlpAAJlyu/fOaUmkFRmzUvwf6vbrMAVCXWUwl1mmrPvXCDkeVpEui Q6W44sSso5A== X-Google-Smtp-Source: AGHT+IH2/QGIvkRbQn2mHuCqyA9ZUpW+z3HCpJCs203sNfUQXCp7VWprsRKrCkWkAC5om8Zlsmlm97Q+Vvb4Yg== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a05:690c:6e13:b0:6e3:6597:2225 with SMTP id 00721157ae682-6e9d8c2a7b3mr9752737b3.7.1730264288352; Tue, 29 Oct 2024 21:58:08 -0700 (PDT) Date: Wed, 30 Oct 2024 12:57:14 +0800 In-Reply-To: <20241030045719.3085147-2-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241030045719.3085147-2-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241030045719.3085147-6-davidgow@google.com> Subject: [PATCH v3 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 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 | 153 +++++++++++++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++++++++ 4 files changed, 194 insertions(+) create mode 100644 rust/macros/kunit.rs 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 27bc4139d352..ac296467a552 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/kunit.rs b/rust/macros/kunit.rs new file mode 100644 index 000000000000..850d268cc96a --- /dev/null +++ b/rust/macros/kunit.rs @@ -0,0 +1,153 @@ +// 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(); + + let new_body: TokenStream = vec![body.stream(), kunit_macros.parse().unwrap()] + .into_iter() + .collect(); + + // Remove the `#[test]` macros. + let new_body = new_body.to_string().replace("#[test]", ""); + tokens.push(TokenTree::Group(Group::new( + Delimiter::Brace, + new_body.parse().unwrap(), + ))); + + tokens.into_iter().collect() +} 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 Wed Oct 30 04:57:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13855916 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 70E3E19884C for ; Wed, 30 Oct 2024 04:59:30 +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=1730264372; cv=none; b=J1O2CfZB7QkMzmf45tbVYyGQn4eThD+X+Z/q88E0DWmGs69nnmpVZXfEnGkoXByPFNHkmt7Vv9haHt+GiMWaBVIPCKy+wbBw+LH/JWhhLwPefQF1y/EYvNvp8JEPltzg7oV4iHD1EDyXmCb5PLgmVJq3PZm1f+QUwX8+/zFny0E= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730264372; c=relaxed/simple; bh=ckB9pUMTNSWy4prV1cOfoPbmEn3v96IADds04sKuQUM=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=udS76Svp6vuYlxWbuEWOQfXWwIgQNm86d2lnCJryml/CfCT5hDwSiG8mVf5R/oyrffF3RXmLBIS7FGaZgP4hbmqmOUZQ3R8zgTCI+E4kCb1VYBix0xdsLk2azIWQMnUwmQwDuE4iyXyu3T74ll0cNNagQqXGh5jYB8ijyTJl/bc= 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=NbmhR6S9; 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="NbmhR6S9" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e30daaf5928so107518276.1 for ; Tue, 29 Oct 2024 21:59:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730264369; x=1730869169; 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=FDWFvWINPVq6lF2SwqYloaVF+/6pFtfjGvv1V4TTOR4=; b=NbmhR6S974n+ai2b4Qud6M1FvQaoW2Ur6A0b+gM3CnyOni2Hu5wTAMNC7W598m97si TctBB5qV9nxUskP8XtQj1fYI3m/KKZxBoltwX08xBb6ZQuVoLiPI3Ik/uMFh2Gi/WbG7 +IrSQXkXaYUhG9L1c12uhr/tDwmflhm+wzTW+MpCsjl6QrYqwqMivKg8SSOmHBZmJsFc 51R8ABuNsRn7JLq+8GtHaIADlNXXMSdHGmBOzrKxC2olC2HprfbK3OUd1/9+QE2sqEvi H/LTD8nMzARq9SsNzerAcZFRwZy2Xv2boN39gQ7uR+I7s+9cowG+R001kNLXQSyjvjCB UpAQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730264369; x=1730869169; 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=FDWFvWINPVq6lF2SwqYloaVF+/6pFtfjGvv1V4TTOR4=; b=hcCWpAVHnLdzLDvHlqMV0LcpoiBB6MhBmS8KCicClXDwfT/scx9lzNGmzSe+i0Omjp sP8rCQGt32IzmQd9gdzDv6dyFYy3mYxEl7cM5FrV8kbEPc9lnzX3uZZHIMxusidF3gvU dn+c9Y3qwlnruMPPhzMrUstVCLch6xcxUR7QcdN/J++L2Vga3IDerK+Cc+czBECSbdMV NRRVnmhfWBnp76p315U/mc8+L3zrrgXX+KHywry1UwVE7KeDJD5Xq4s/vRI3L+XUCvGK iIkH3eUKfxjtqWXl0YJCVGMKq7U+P50aVW5emfJKeCuLtvFtWC/LhiPxUuRkPnLVzjIu FCng== X-Forwarded-Encrypted: i=1; AJvYcCVSPNhzLMUgIVKdtCwCt+ajX58aSpnf3j+Y8DzzMRvOnk0qh87lAhN40zKrW/nMc+rU52SZywGXvtuOvH/IcrA=@vger.kernel.org X-Gm-Message-State: AOJu0YwooRdM7Ba2TlZJtU/oRTpMDGWCN4Sa7Bf+W7x+CNdbXNJtQcQi T6F7ZlYeQLRBA5jodFoWrTR980OqChy2ATawqTteZ/tQQ/A3PVQ9Gw5wr8GP8SCfifIwkm7qy4w 6j/yRjY2XqQ== X-Google-Smtp-Source: AGHT+IGekxcLmEJS2haephcXYwaPtTFGVJy9oILsQ6O/T5joWShJw7lDLxlgK2wdbCm786occ2gOaxQlBRU5Nw== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a25:a549:0:b0:e30:c6ce:1165 with SMTP id 3f1490d57ef6-e30c6ce1d94mr23975276.1.1730264369395; Tue, 29 Oct 2024 21:59:29 -0700 (PDT) Date: Wed, 30 Oct 2024 12:57:16 +0800 In-Reply-To: <20241030045719.3085147-2-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241030045719.3085147-2-davidgow@google.com> X-Mailer: git-send-email 2.47.0.163.g1226f6d8fa-goog Message-ID: <20241030045719.3085147-8-davidgow@google.com> Subject: [PATCH v3 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 --- 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 | 72 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index ac296467a552..d5926f7ef405 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); + } }