Changes in .gitignore

a66d733d - rust: support running Rust documentation tests as KUnit ones

Tue, 18 Jul 2023 05:27:51 +0000

rust: support running Rust documentation tests as KUnit onesRust has documentation tests: these are typically examples ofusage of any item (e.g. function, struct, module...).They are very convenient because they are just writtenalongside the documentation. For instance: /// Sums two numbers. /// /// ``` /// assert_eq!(mymod::f(10, 20), 30); /// ``` pub fn f(a: i32, b: i32) -> i32 { a + b }In userspace, the tests are collected and run via `rustdoc`.Using the tool as-is would be useful already, since it allowsto compile-test most tests (thus enforcing they are keptin sync with the code they document) and run those that do notdepend on in-kernel APIs.However, by transforming the tests into a KUnit test suite,they can also be run inside the kernel. Moreover, the testsget to be compiled as other Rust kernel objects instead oftargeting userspace.On top of that, the integration with KUnit means the Rustsupport gets to reuse the existing testing facilities. Forinstance, the kernel log would look like: KTAP version 1 1..1 KTAP version 1 # Subtest: rust_doctests_kernel 1..59 # rust_doctest_kernel_build_assert_rs_0.location: rust/kernel/build_assert.rs:13 ok 1 rust_doctest_kernel_build_assert_rs_0 # rust_doctest_kernel_build_assert_rs_1.location: rust/kernel/build_assert.rs:56 ok 2 rust_doctest_kernel_build_assert_rs_1 # rust_doctest_kernel_init_rs_0.location: rust/kernel/init.rs:122 ok 3 rust_doctest_kernel_init_rs_0 ... # rust_doctest_kernel_types_rs_2.location: rust/kernel/types.rs:150 ok 59 rust_doctest_kernel_types_rs_2 # rust_doctests_kernel: pass:59 fail:0 skip:0 total:59 # Totals: pass:59 fail:0 skip:0 total:59 ok 1 rust_doctests_kernelTherefore, add support for running Rust documentation testsin KUnit. Some other notes about the current implementationand support follow.The transformation is performed by a couple scripts writtenas Rust hostprogs.Tests using the `?` operator are also supported as usual, e.g.: /// ``` /// # use kernel::{spawn_work_item, workqueue}; /// spawn_work_item!(workqueue::system(), || pr_info!("x"))?; /// # Ok::<(), Error>(()) /// ```The tests are also compiled with Clippy under `CLIPPY=1`, justlike normal code, thus also benefitting from extra linting.The names of the tests are currently automatically generated.This allows to reduce the burden for documentation writers,while keeping them fairly stable for bisection. This is animprovement over the `rustdoc`-generated names, which includethe line number; but ideally we would like to get `rustdoc` toprovide the Rust item path and a number (for multiple examplesin a single documented Rust item).In order for developers to easily see from which original linea failed doctests came from, a KTAP diagnostic line is printedto the log, containing the location (file and line) of theoriginal test (i.e. instead of the location in the generatedRust file): # rust_doctest_kernel_types_rs_2.location: rust/kernel/types.rs:150This line follows the syntax for declaring test metadata in theproposed KTAP v2 spec [1], which may be used for the proposedKUnit test attributes API [2]. Thus hopefully this will makemigration easier later on (suggested by David [3]).The original line in that test attribute is figured out byproviding an anchor (suggested by Boqun [4]). The original fileis found by walking the filesystem, checking directory prefixesto reduce the amount of combinations to check, and it is onlydone once per file. Ambiguities are detected and reported.A notable difference from KUnit C tests is that the Rust testsappear to assert using the usual `assert!` and `assert_eq!`macros from the Rust standard library (`core`). We providea custom version that forwards the call to KUnit instead.Importantly, these macros do not require passing context,unlike the KUnit C ones (i.e. `struct kunit *`). This makesthem easier to use, and readers of the documentation do not needto care about which testing framework is used. In addition, itmay allow us to test third-party code more easily in the future.However, a current limitation is that KUnit does not supportassertions in other tasks. Thus we presently simply print anerror to the kernel log if an assertion actually failed. Thisshould be revisited to properly fail the test, perhaps savingthe context somewhere else, or letting KUnit handle it.Link: https://lore.kernel.org/lkml/20230420205734.1288498-1-rmoar@google.com/ [1]Link: https://lore.kernel.org/linux-kselftest/20230707210947.1208717-1-rmoar@google.com/ [2]Link: https://lore.kernel.org/rust-for-linux/CABVgOSkOLO-8v6kdAGpmYnZUb+LKOX0CtYCo-Bge7r_2YTuXDQ@mail.gmail.com/ [3]Link: https://lore.kernel.org/rust-for-linux/ZIps86MbJF%2FiGIzd@boqun-archlinux/ [4]Signed-off-by: Miguel Ojeda Reviewed-by: David Gow Signed-off-by: Shuah Khan List of files: /linux-6.15/rust/.gitignore

4e174665 - rust: uapi: Add UAPI crate

Mon, 03 Apr 2023 09:33:52 +0000

rust: uapi: Add UAPI crateThis crate mirrors the `bindings` crate, but will contain only UAPIbindings. Unlike the bindings crate, drivers may directly use this crateif they have to interface with userspace.Initially, just bind the generic ioctl stuff.In the future, we would also like to add additional checks to ensurethat all types exposed by this crate satisfy UAPI-safety guarantees(that is, they are safely castable to/from a "bag of bits").[ Miguel: added support for the `rustdoc` and `rusttest` targets, since otherwise they fail, and we want to keep them working. ]Reviewed-by: Martin Rodriguez Reboredo Signed-off-by: Asahi Lina Link: https://lore.kernel.org/r/20230329-rust-uapi-v2-1-bca5fb4d4a12@asahilina.netSigned-off-by: Miguel Ojeda List of files: /linux-6.15/rust/.gitignore

c83b16ce - kbuild: rust: move rust/target.json to scripts/

Sat, 07 Jan 2023 09:45:45 +0000

kbuild: rust: move rust/target.json to scripts/scripts/ is a better place to generate files used treewide.With target.json moved to scripts/, you do not need to add target.jsonto no-clean-files or MRPROPER_FILES.'make clean' does not visit scripts/, but 'make mrproper' does.Signed-off-by: Masahiro Yamada Reviewed-by: Miguel Ojeda Tested-by: Miguel Ojeda List of files: /linux-6.15/rust/.gitignore

2f7ab126 - Kbuild: add Rust support

Sat, 03 Jul 2021 14:42:57 +0000

Kbuild: add Rust supportHaving most of the new files in place, we now enable Rust supportin the build system, including `Kconfig` entries related to Rust,the Rust configuration printer and a few other bits.Reviewed-by: Kees Cook Reviewed-by: Nick Desaulniers Tested-by: Nick Desaulniers Reviewed-by: Greg Kroah-Hartman Co-developed-by: Alex Gaynor Signed-off-by: Alex Gaynor Co-developed-by: Finn Behrens Signed-off-by: Finn Behrens Co-developed-by: Adam Bratschi-Kaye Signed-off-by: Adam Bratschi-Kaye Co-developed-by: Wedson Almeida Filho Signed-off-by: Wedson Almeida Filho Co-developed-by: Michael Ellerman Signed-off-by: Michael Ellerman Co-developed-by: Sven Van Asbroeck Signed-off-by: Sven Van Asbroeck Co-developed-by: Gary Guo Signed-off-by: Gary Guo Co-developed-by: Boris-Chengbiao Zhou Signed-off-by: Boris-Chengbiao Zhou Co-developed-by: Boqun Feng Signed-off-by: Boqun Feng Co-developed-by: Douglas Su Signed-off-by: Douglas Su Co-developed-by: Dariusz Sosnowski Signed-off-by: Dariusz Sosnowski Co-developed-by: Antonio Terceiro Signed-off-by: Antonio Terceiro Co-developed-by: Daniel Xu Signed-off-by: Daniel Xu Co-developed-by: Björn Roy Baron Signed-off-by: Björn Roy Baron Co-developed-by: Martin Rodriguez Reboredo Signed-off-by: Martin Rodriguez Reboredo Signed-off-by: Miguel Ojeda List of files: /linux-6.15/rust/.gitignore