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.