add asm_check tool and one-off asm test#23
Open
oliverlee wants to merge 1 commit into
Open
Conversation
Adds `tools/asm_check`, a Rust binary that checks assembly output against a TOML config file specifying per-function `must_contain` and `must_not_contain` regex patterns, with optional function exclude patterns. Provies a one-off asm test using `sh_binary` and a manually generated TOML config for `mod_layout`. Adds `anyhow`, `clap`, `regex`, `serde`, and `toml` to the `tool_crates` extension to support the new binary.
Comment on lines
+23
to
+37
| write_file( | ||
| name = "mod_layout_asm_check_config", | ||
| out = "mod_layout_asm_check.toml", | ||
| content = [ | ||
| "[[check]]", | ||
| "functions = [\"mod_layout::tests::test_layout_(right|left)_mapping_stride_out_of_bounds\"]", | ||
| "must_contain = [\"bl[[:space:]]+_core::panicking::panic_fmt\"]", | ||
| "", | ||
| "[[check]]", | ||
| "functions = [\"mod_layout::.*\"]", | ||
| "exclude = [\"mod_layout::tests::test_layout_(right|left)_mapping_stride_out_of_bounds\"]", | ||
| "must_not_contain = [\"bl[[:space:]]+_core::panicking::panic_fmt\"]", | ||
| "", | ||
| ], | ||
| ) |
Collaborator
There was a problem hiding this comment.
Curiosity: Why does this need to be written by bazel?
Collaborator
Author
There was a problem hiding this comment.
No reason. We could create the file and check it in instead of generating it.
Collaborator
There was a problem hiding this comment.
Oh okay. Maybe it'll read better and get syntax highlighting if we materialize it.
Collaborator
Author
There was a problem hiding this comment.
I'll update this PR later and add the file.
oliverlee
commented
Mar 25, 2026
Comment on lines
+121
to
+148
| fn parse_functions<'a>(asm: &'a str) -> BTreeMap<&'a str, Vec<&'a str>> { | ||
| let mut chunks: Vec<Vec<&str>> = vec![]; | ||
|
|
||
| for line in asm.lines() { | ||
| let is_label = line.ends_with(':') && !line.starts_with(|c: char| c.is_whitespace()); | ||
|
|
||
| if is_label { | ||
| chunks.push(vec![line]); | ||
| } else if let Some(chunk) = chunks.last_mut() { | ||
| chunk.push(line); | ||
| } | ||
| } | ||
|
|
||
| for i in (1..chunks.len()).rev() { | ||
| if chunks[i][0].trim_end_matches(':').starts_with("Lloh") { | ||
| let lloh = chunks.remove(i); | ||
| chunks[i - 1].extend(lloh); | ||
| } | ||
| } | ||
|
|
||
| chunks | ||
| .into_iter() | ||
| .map(|mut chunk| { | ||
| let name = chunk.remove(0).trim_end_matches(':'); | ||
| (name, chunk) | ||
| }) | ||
| .collect() | ||
| } |
Collaborator
Author
There was a problem hiding this comment.
I based this on the ASM on my machine. This will probably differ for Linux and bare-metal targets.
oliverlee
commented
Mar 25, 2026
| .cfi_endproc | ||
|
|
||
| .p2align 2 | ||
| "#; |
Collaborator
Author
There was a problem hiding this comment.
The last function is copy/pasted from the asm on my machine. The ones above were generated by Claude.
@mickvangelderen can you add a function based on the output of your machine?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
tools/asm_check, a Rust binary that checks assembly output against a TOML config file specifying per-functionmust_containandmust_not_containregex patterns, with optional function exclude patterns.Provies a one-off asm test using
sh_binaryand a manually generated TOML config formod_layout.Adds
anyhow,clap,regex,serde, andtomlto thetool_cratesextension to support the new binary.