-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The beginning of a set of Rust modules that showcase how Rust modules look like and how to use the abstracted kernel features. It also includes an example of a Rust host program with several modules. These samples also double as tests in the CI. Reviewed-by: Kees Cook <keescook@chromium.org> Co-developed-by: Alex Gaynor <alex.gaynor@gmail.com> Signed-off-by: Alex Gaynor <alex.gaynor@gmail.com> Co-developed-by: Finn Behrens <me@kloenk.de> Signed-off-by: Finn Behrens <me@kloenk.de> Co-developed-by: Wedson Almeida Filho <wedsonaf@google.com> Signed-off-by: Wedson Almeida Filho <wedsonaf@google.com> Co-developed-by: Milan Landaverde <milan@mdaverde.com> Signed-off-by: Milan Landaverde <milan@mdaverde.com> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
- Loading branch information
Miguel Ojeda
committed
Sep 27, 2022
1 parent
c7fe19d
commit 61b337f
Showing
10 changed files
with
108 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# SPDX-License-Identifier: GPL-2.0 | ||
|
||
menuconfig SAMPLES_RUST | ||
bool "Rust samples" | ||
depends on RUST | ||
help | ||
You can build sample Rust kernel code here. | ||
|
||
If unsure, say N. | ||
|
||
if SAMPLES_RUST | ||
|
||
config SAMPLE_RUST_MINIMAL | ||
tristate "Minimal" | ||
help | ||
This option builds the Rust minimal module sample. | ||
|
||
To compile this as a module, choose M here: | ||
the module will be called rust_minimal. | ||
|
||
If unsure, say N. | ||
|
||
config SAMPLE_RUST_HOSTPROGS | ||
bool "Host programs" | ||
help | ||
This option builds the Rust host program samples. | ||
|
||
If unsure, say N. | ||
|
||
endif # SAMPLES_RUST |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# SPDX-License-Identifier: GPL-2.0 | ||
|
||
obj-$(CONFIG_SAMPLE_RUST_MINIMAL) += rust_minimal.o | ||
|
||
subdir-$(CONFIG_SAMPLE_RUST_HOSTPROGS) += hostprogs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# SPDX-License-Identifier: GPL-2.0 | ||
|
||
single |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# SPDX-License-Identifier: GPL-2.0 | ||
|
||
hostprogs-always-y := single | ||
|
||
single-rust := y |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
// SPDX-License-Identifier: GPL-2.0 | ||
|
||
//! Rust single host program sample: module `a`. | ||
|
||
pub(crate) fn f(x: i32) { | ||
println!("The number is {}.", x); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
// SPDX-License-Identifier: GPL-2.0 | ||
|
||
//! Rust single host program sample: module `b`. | ||
|
||
pub(crate) const CONSTANT: i32 = 42; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
// SPDX-License-Identifier: GPL-2.0 | ||
|
||
//! Rust single host program sample. | ||
|
||
mod a; | ||
mod b; | ||
|
||
fn main() { | ||
println!("Hello world!"); | ||
|
||
a::f(b::CONSTANT); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
// SPDX-License-Identifier: GPL-2.0 | ||
|
||
//! Rust minimal sample. | ||
|
||
use kernel::prelude::*; | ||
|
||
module! { | ||
type: RustMinimal, | ||
name: b"rust_minimal", | ||
author: b"Rust for Linux Contributors", | ||
description: b"Rust minimal sample", | ||
license: b"GPL", | ||
} | ||
|
||
struct RustMinimal { | ||
numbers: Vec<i32>, | ||
} | ||
|
||
impl kernel::Module for RustMinimal { | ||
fn init(_module: &'static ThisModule) -> Result<Self> { | ||
pr_info!("Rust minimal sample (init)\n"); | ||
pr_info!("Am I built-in? {}\n", !cfg!(MODULE)); | ||
|
||
let mut numbers = Vec::new(); | ||
numbers.try_push(72)?; | ||
numbers.try_push(108)?; | ||
numbers.try_push(200)?; | ||
|
||
Ok(RustMinimal { numbers }) | ||
} | ||
} | ||
|
||
impl Drop for RustMinimal { | ||
fn drop(&mut self) { | ||
pr_info!("My numbers are {:?}\n", self.numbers); | ||
pr_info!("Rust minimal sample (exit)\n"); | ||
} | ||
} |