From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3382E285CAE; Wed, 2 Jul 2025 13:19:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751462370; cv=none; b=nLQBBEHPmYi2joa+VNa+82EuZYcfYM6TFoMxueGwaB/l5XlWMf2ub2WGbmfsXGNU2gS18Xh/mU4qz+6YTFvz06a6VLG4USCdTZWEWJ6qMcqPElLrV6NfO8mUGC1Mb9sBdmPtUzWY2xiowPVUDW5oOTwMA82gG3yj0DwqvlkrYOQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751462370; c=relaxed/simple; bh=jGEnrWIIT/lKD8zW7gGS66LGISTk7EsrbXLXQLSwNQY=; h=From:Subject:Date:Message-Id:MIME-Version:Content-Type:To:Cc; b=NEl+/bCfBh3850X35Zp4KC5m6JFmrxFBt7H4om35qgnhaTrbPTmgUhptTv0pDusqner3pWRbE0vhLkQvLXsGtuHnpu+kVa2m4JIa2A7tN6/ZU2fe2HNCVjaLPnZhsI8g+pcpOuQ/Y3v6efwUWhVzVr2aXId5flPKFVbhd4qXQ4Q= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=h6RIIp0V; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="h6RIIp0V" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 79431C4CEED; Wed, 2 Jul 2025 13:19:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751462369; bh=jGEnrWIIT/lKD8zW7gGS66LGISTk7EsrbXLXQLSwNQY=; h=From:Subject:Date:To:Cc:From; b=h6RIIp0VkvKAE9z8z4GiLTktw9dww86vwjK7/U/UIDZtrIzgAHrrmzteegvwFZ+Oo 8DypfJLn4QKDe5D6cOUZM1j2oT1Hlih6CA5zIe5qaPo/AvQm6elWvL3O+Jii+egYBT qTmL9fbfiJL4YPFu8VSzpgXrAqgBmSAS7hgcXO14R0UO1LDzK+/UvuCN1wkj76YudG QJPOyv5UEexYOObbAmES/8pwfcCAa/JGPwCwDpjK53vHUWiMpK4IZWz1BBImXl2LJ0 pdl76yMFJBweiGB1glkTmDfQRZAq+ByQGQy7ewpufeJpPFphB4ryBoYmFMnFZdf3+6 DAC2lKgXnvmSA== From: Andreas Hindborg Subject: [PATCH v14 0/7] rust: extend `module!` macro with integer parameter support Date: Wed, 02 Jul 2025 15:18:32 +0200 Message-Id: <20250702-module-params-v3-v14-0-5b1cc32311af@kernel.org> Precedence: bulk X-Mailing-List: rust-for-linux@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit X-B4-Tracking: v=1; b=H4sIAKgxZWgC/23Ty07rMBAA0F+psr6OPH6nK/4DsfBjUqLbJOC0E Qjx70wKqEF2lI0t+Yw9j49mwTzg0hwPH03GdViGeaIFqH+HJj776YRsSLTRCC4UCAA2zul6Rvb isx8Xtkrm0aKOLrmgfUPHXjL2w9vNfHyi9fOwXOb8fguxym33F5MlRj9nymnPQfsoYv/wH/OE5 3bOp2bTVvUraA68qwiKhCi4C7EPCFAK+i4IriqCJiH0GklRYIQuBLMTailZDQlCBdHZlKKSqRD sXnAVwZKgEXzvQ/QRQiG4nSBsRXBbHpA+p1MnlS2E7i5IUXtFt73ChY7rXqBUZR6A3wkqR4UAv tUzeSppkpSIigF7Q9QMIMPwzjirvQjWlYbYG6ZmiC0bXCXHoyMESkPeDQPVe2y9GaKALibwsv9 7j8/v1s/4eqUpunz3fxP8gizO4zhcjofVtGBYjrCNyYjL4m/jdTz8BHVgFFWqhc6BZcDC/Hqd2 h6n08Np9MO5JYgCfX4BLAtXT7YDAAA= X-Change-ID: 20241211-module-params-v3-ae7e5c8d8b5a To: Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Alice Ryhl , Masahiro Yamada , Nathan Chancellor , Luis Chamberlain , Danilo Krummrich , Benno Lossin , Benno Lossin , Nicolas Schier Cc: Trevor Gross , Adam Bratschi-Kaye , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kbuild@vger.kernel.org, Petr Pavlu , Sami Tolvanen , Daniel Gomez , Simona Vetter , Greg KH , Fiona Behrens , Daniel Almeida , linux-modules@vger.kernel.org, Andreas Hindborg X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=9707; i=a.hindborg@kernel.org; h=from:subject:message-id; bh=jGEnrWIIT/lKD8zW7gGS66LGISTk7EsrbXLXQLSwNQY=; b=owEBbQKS/ZANAwAIAeG4Gj55KGN3AcsmYgBoZTGvzFPn4u+arW/81huJrsfDfu8zgGrOAt7Nv FvUh5ntcyCJAjMEAAEIAB0WIQQSwflHVr98KhXWwBLhuBo+eShjdwUCaGUxrwAKCRDhuBo+eShj dx4QD/4/wWt7EtbJbBTQyNeQ1gaSWhbC5/iPswcV8l7vVAQ0vDO7Y/18ZUFSQuHVUZB4GIt78Hb V4Z4VMV9Ys9HLELVAK59JMwCzaQ486xUlN0WGBLmdzDauuJAyptusGChPh4CpaWux/sc8mS7Z1y KXX/NhFFf9sxFDif2COJM6yv7iY4dXpDXJMzHc3ZgIWZC1wOSRD9rFzkbrwhzdvdy3wJ5sd9csh yuj2Vkv/AERm3Gbr7gtnca8olpKZ1dzNE7YG2Gwrsmxf5ZfcqbzpRl2AdK3nMzAnJgLj6Mf0gtd whiNKuIXGOL2FWbEiRiHrZ+/b+zrq/ZeAdeggtaKm+vCybFaROP2ZbXPD/jRQXD+MxutXWBfv5E stT/ukR88Ft4W+GsD8NYW4Ipeb+rCnYutweVbujLYedh4RC/pNOZ6MjGc/tk8qGe5+pPolYCPDC DylETaz+lTQF5/fGcMnSSGgvvEu8z/Wv9OrJwhBSz83LI37TZ8AnIC1Rd15XnAnPZ5mW8dl746w UUne/O7y+MUJ8D4yBMQGQalfPTCqsLN0rAzz5zgMci28TcXySqPEfHCHLWMvRtFAysmiTB4QxXt KktX8U0Mp5iUqNHqC4wY67fo1DNZ6Ul1FMjjAvd7o5cOq8WuMRX0VsiiPBXvVMjXwlr+utnHYon ffI6E04OV70Typw== X-Developer-Key: i=a.hindborg@kernel.org; a=openpgp; fpr=3108C10F46872E248D1FB221376EB100563EF7A7 Extend the `module!` macro with support module parameters. Also add some string to integer parsing functions and updates `BStr` with a method to strip a string prefix. Based on code by Adam Bratschi-Kaye lifted from the original `rust` branch [1]. Link: https://github.com/Rust-for-Linux/linux/tree/bc22545f38d74473cfef3e9fd65432733435b79f [1] Signed-off-by: Andreas Hindborg --- Note: This series now depends on the atomics series [1]. [1] https://lore.kernel.org/all/20250618164934.19817-1-boqun.feng@gmail.com Changes in v14: - Remove unnecessary `crate::` prefix from `module_param::set_param`. - Make `FromStrRadix` safe again by moving unsafe blocks to macro implementation (thanks Benno). - Use `core::ptr::write` in `set_param` and drop safety requirement regarding initialization. - Add a TODO to use `SyncUnsafeCell` for `ModuleParamAccess` when available. - Add a NOTE regarding `Copy` bound on `ModuleParam`. - Remove `'static` lifetime qualifier from `ModuleParam::try_from_param_arg` argument. - Fix a typo in the safety requirements for `set_param`. - Remove unused `#[macro_export]` attribute. - Remove obsolete documentation for `ModuleParam::try_from_param_arg`. - Make `RacyKernelParam` tuple field private. - Introduce `OnceLock` and use that to synchronize population of parameter values. - Link to v13: https://lore.kernel.org/r/20250612-module-params-v3-v13-0-bc219cd1a3f8@kernel.org Changes in v13: - remove absolute path for `ffi` types. - Split patch 2 into 4 separate patches. - Overhaul safety framework for `set_param`. - Remove generated docs for `kernel_param_ops`. - Move `parse_int` to separate file. - Rebase on v6.16-rc1 - Link to v12: https://lore.kernel.org/r/20250506-module-params-v3-v12-0-c04d80c8a2b1@kernel.org Changes in v12: - Assign through pointer rather than using `core::ptr::replace`. - Prevent a potential use-after-free during module teardown. - Link to v11: https://lore.kernel.org/r/20250502-module-params-v3-v11-0-6096875a2b78@kernel.org Changes in v11: - Apply a few nits from Miguel. - Link to v10: https://lore.kernel.org/r/20250501-module-params-v3-v10-0-4da485d343d5@kernel.org Changes in v10: - Apply fixups from Miguel: - Add integer type suffixes to `assert!` in tests. - Fix links to docs.kernel.org. - Applyy markdown and intra-doc links where possible. - Change to `///` for `mod` docs. - Slightly reword a comment. - Pluralize "Examples" section name. - Hide `use`s in example. - Removed `#[expect]` for the `rusttest` target. - Link to v9: https://lore.kernel.org/r/20250321-module-params-v3-v9-0-28b905f2e345@kernel.org Changes in v9: - Remove UB when parsing the minimum integer values. - Make `FromStr` trait unsafe, since wrong implementations can cause UB. - Drop patches that were applied to rust-next. - Link to v8: https://lore.kernel.org/r/20250227-module-params-v3-v8-0-ceeee85d9347@kernel.org Changes in v8: - Change print statement in sample to better communicate parameter name. - Use imperative mode in commit messages. - Remove prefix path from `EINVAL`. - Change `try_from_param_arg` to accept `&BStr` rather than `&[u8]`. - Parse integers without 128 bit integer types. - Seal trait `FromStrRadix`. - Strengthen safety requirement of `set_param`. - Remove comment about Display and `PAGE_SIZE`. - Add note describing why `ModuleParamAccess` is pub. - Typo and grammar fixes for documentation. - Update MAINTAINERS with rust module files. - Link to v7: https://lore.kernel.org/r/20250218-module-params-v3-v7-0-5e1afabcac1b@kernel.org Changes in v7: - Remove dependency on `pr_warn_once` patches, replace with TODO. - Rework `ParseInt::from_str` to avoid allocating. - Add a comment explaining how we parse "0". - Change trait bound on `Index` impl for `BStr` to match std library approach. - Link to v6: https://lore.kernel.org/r/20250211-module-params-v3-v6-0-24b297ddc43d@kernel.org Changes in v6: - Fix a bug that prevented parsing of negative default values for parameters in the `module!` macro. - Fix a bug that prevented parsing zero in `strip_radix`. Also add a test case for this. - Add `AsRef` for `[u8]` and `BStr`. - Use `impl AsRef` as type of prefix in `BStr::strip_prefix`. - Link to v5: https://lore.kernel.org/r/20250204-module-params-v3-v5-0-bf5ec2041625@kernel.org Changes in v5: - Fix a typo in a safety comment in `set_param`. - Use a match statement in `parse_int::strip_radix`. - Add an implementation of `Index` for `BStr`. - Fix a logic inversion bug where parameters would not be parsed. - Use `kernel::ffi::c_char` in `set_param` rather than the one in `core`. - Use `kernel::c_str!` rather than `c"..."` literal in module macro. - Rebase on v6.14-rc1. - Link to v4: https://lore.kernel.org/r/20250109-module-params-v3-v4-0-c208bcfbe11f@kernel.org Changes in v4: - Add module maintainers to Cc list (sorry) - Add a few missing [`doc_links`] - Add panic section to `expect_string_field` - Fix a typo in safety requirement of `module_params::free` - Change `assert!` to `pr_warn_once!` in `module_params::set_param` - Remove `module_params::get_param` and install null pointer instead - Remove use of the unstable feature `sync_unsafe_cell` - Link to v3: https://lore.kernel.org/r/20241213-module-params-v3-v3-0-485a015ac2cf@kernel.org Changes in v3: - use `SyncUnsafeCell` rather than `static mut` and simplify parameter access - remove `Display` bound from `ModuleParam` - automatically generate documentation for `PARAM_OPS_.*` - remove `as *const _ as *mut_` phrasing - inline parameter name in struct instantiation in `emit_params` - move `RacyKernelParam` out of macro template - use C string literals rather than byte string literals with explicit null - template out `__{name}_{param_name}` in `emit_param` - indent template in `emit_params` - use let-else expression in `emit_params` to get rid of an indentation level - document `expect_string_field` - move invication of `impl_int_module_param` to be closer to macro def - move attributes after docs in `make_param_ops` - rename `impl_module_param` to impl_int_module_param` - use `ty` instead of `ident` in `impl_parse_int` - use `BStr` instead of `&str` for string manipulation - move string parsing functions to seperate patch and add examples, fix bugs - degrade comment about future support from doc comment to regular comment - remove std lib path from `Sized` marker - update documentation for `trait ModuleParam` - Link to v2: https://lore.kernel.org/all/20240819133345.3438739-1-nmi@metaspace.dk/ Changes in v2: - Remove support for params without values (`NOARG_ALLOWED`). - Improve documentation for `try_from_param_arg`. - Use prelude import. - Refactor `try_from_param_arg` to return `Result`. - Refactor `ParseInt::from_str` to return `Result`. - Move C callable functions out of `ModuleParam` trait. - Rename literal string field parser to `expect_string_field`. - Move parameter parsing from generation to parsing stage. - Use absolute type paths in macro code. - Inline `kparam`and `read_func` values. - Resolve TODO regarding alignment attributes. - Remove unnecessary unsafe blocks in macro code. - Improve error message for unrecognized parameter types. - Do not use `self` receiver when reading parameter value. - Add parameter documentation to `module!` macro. - Use empty `enum` for parameter type. - Use `addr_of_mut` to get address of parameter value variable. - Enabled building of docs for for `module_param` module. - Link to v1: https://lore.kernel.org/rust-for-linux/20240705111455.142790-1-nmi@metaspace.dk/ --- Andreas Hindborg (7): rust: sync: add `OnceLock` rust: str: add radix prefixed integer parsing functions rust: introduce module_param module rust: module: use a reference in macros::module::module rust: module: update the module macro with module parameter support rust: samples: add a module parameter to the rust_minimal sample modules: add rust modules files to MAINTAINERS MAINTAINERS | 2 + rust/kernel/lib.rs | 1 + rust/kernel/module_param.rs | 191 ++++++++++++++++++++++++++++++++++++++++ rust/kernel/str.rs | 2 + rust/kernel/str/parse_int.rs | 148 +++++++++++++++++++++++++++++++ rust/kernel/sync.rs | 1 + rust/kernel/sync/once_lock.rs | 104 ++++++++++++++++++++++ rust/macros/helpers.rs | 25 ++++++ rust/macros/lib.rs | 31 +++++++ rust/macros/module.rs | 197 +++++++++++++++++++++++++++++++++++++----- samples/rust/rust_minimal.rs | 10 +++ 11 files changed, 692 insertions(+), 20 deletions(-) --- base-commit: d9946fe286439c2aeaa7953b8c316efe5b83d515 change-id: 20241211-module-params-v3-ae7e5c8d8b5a prerequisite-message-id: 20250618164934.19817-1-boqun.feng@gmail.com prerequisite-patch-id: 997f74bd63d81dc66725d7f84ffcf5a3517da1eb prerequisite-patch-id: 3e3f8bdada027406a356a2b35aebe13edbda0a94 prerequisite-patch-id: 468b093532aa503c23302142b8cfe7989e3cb8f1 prerequisite-patch-id: 96ca162a1e95a29d3aca2e748d600a31417b83e5 prerequisite-patch-id: 8f78abede975c0c9690ee0f4cf4e7af3cb145191 prerequisite-patch-id: a716ee7a51184d224ef60812ecfffadb51980153 prerequisite-patch-id: e54f74896a75147b66e509c1281804047d41f08b prerequisite-patch-id: 3f77e2179901ae664a2d2e58965a9725ad13189e prerequisite-patch-id: e964a9576f9c3970bb7a34b4d2891ffb92939d0e prerequisite-patch-id: bba35ecdf783653e0fa46015bc289706508fac55 Best regards, -- Andreas Hindborg