Skip to content

[WIP] Codegen tests#3042

Open
jswrenn wants to merge 1 commit intomainfrom
G5964d13c9ffb7a47ed4662892ef92c90ddc51e12
Open

[WIP] Codegen tests#3042
jswrenn wants to merge 1 commit intomainfrom
G5964d13c9ffb7a47ed4662892ef92c90ddc51e12

Conversation

@jswrenn
Copy link
Collaborator

@jswrenn jswrenn commented Feb 12, 2026


⬇️ Download this PR

Branch

git fetch origin refs/heads/G5964d13c9ffb7a47ed4662892ef92c90ddc51e12 && git checkout -b pr-G5964d13c9ffb7a47ed4662892ef92c90ddc51e12 FETCH_HEAD

Checkout

git fetch origin refs/heads/G5964d13c9ffb7a47ed4662892ef92c90ddc51e12 && git checkout FETCH_HEAD

Cherry Pick

git fetch origin refs/heads/G5964d13c9ffb7a47ed4662892ef92c90ddc51e12 && git cherry-pick FETCH_HEAD

Pull

git pull origin refs/heads/G5964d13c9ffb7a47ed4662892ef92c90ddc51e12

Stacked PRs enabled by GHerrit.

gherrit-pr-id: G5964d13c9ffb7a47ed4662892ef92c90ddc51e12
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jswrenn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request establishes a new framework for codegen testing within the zerocopy project. It leverages cargo asm and cargo-mca to capture and validate the generated assembly and micro-architectural performance of key zerocopy traits and macros. This system aims to prevent performance regressions and ensure optimal code generation for critical operations by comparing current output against stored reference files.

Highlights

  • New Codegen Test Suite: Introduced a new codegen test suite to analyze the generated assembly and micro-architectural performance of zerocopy operations.
  • Performance Benchmarks: Added specific benchmarks for TryFromBytes::try_ref_from_bytes and try_transmute_ref! using custom data structures.
  • Machine Code Analysis (MCA): Implemented a testing mechanism that uses cargo asm with cargo-mca to generate and compare detailed performance metrics for the compiled code.
  • Bless Mode for Expected Output: Included a 'bless' mode, activated via an environment variable, to easily update the expected .mca output files when code generation changes are intentional.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • benches/formats/coco.rs
    • Added a new Rust module defining data structures (C0, C0C0, Packet) used as targets for zerocopy operations in benchmarks.
  • benches/try_ref_from_bytes.icelake-server.mca
    • Added expected machine code analysis output for the try_ref_from_bytes benchmark on an Icelake server CPU.
  • benches/try_ref_from_bytes.rs
    • Added a new benchmark file for TryFromBytes::try_ref_from_bytes using the coco::Packet structure.
  • benches/try_transmute_ref.icelake-server.mca
    • Added expected machine code analysis output for the try_transmute_ref benchmark on an Icelake server CPU.
  • benches/try_transmute_ref.rs
    • Added a new benchmark file for try_transmute_ref! using a MinimialViableSource structure.
  • tests/codegen.rs
    • Added a new test file that orchestrates the execution of codegen benchmarks, captures their MCA output, and compares it against stored reference files, including a 'bless' functionality.
  • tools/update-expected-test-output.sh
    • Updated the script to include the new codegen test suite in its 'bless' operation, allowing for easy updating of expected MCA outputs.
Activity
  • The pull request is currently marked as '[WIP]', indicating that it is still under active development by the author.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces codegen tests, which is a valuable addition for ensuring the quality and performance of the generated code. My review identified a critical bug in the test runner's logic that would prevent the tests from working as intended, along with a minor typo in a data structure. Once these issues are addressed, the PR will be in great shape.

Comment on lines +44 to +67
let mut expected_file = OpenOptions::new()
.read(true)
.write(true)
.create(true)
.append(false)
.truncate(true)
.open(expected_file_path)
.unwrap();

let expected_result = {
let mut buf = Vec::new();
expected_file.read_to_end(&mut buf).unwrap();
buf
};

if bless {
expected_file.write_all(&actual_result).unwrap();
} else {
if actual_result == expected_result {
; // Success
} else {
panic!("Bless codegen tests with BLESS=1");
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The logic for checking against the blessed file is incorrect. OpenOptions is configured with .truncate(true), which means the expected output file is always cleared before being read. This results in expected_result always being empty, causing the test to fail incorrectly if there's any actual output.

The file handling logic should be separated for blessing and checking. When checking, the file should be opened for reading only. When blessing, it should be opened for writing and truncating.

Here's a more concise and correct implementation using std::fs::read and std::fs::write:

Suggested change
let mut expected_file = OpenOptions::new()
.read(true)
.write(true)
.create(true)
.append(false)
.truncate(true)
.open(expected_file_path)
.unwrap();
let expected_result = {
let mut buf = Vec::new();
expected_file.read_to_end(&mut buf).unwrap();
buf
};
if bless {
expected_file.write_all(&actual_result).unwrap();
} else {
if actual_result == expected_result {
; // Success
} else {
panic!("Bless codegen tests with BLESS=1");
}
}
if bless {
std::fs::write(expected_file_path, &actual_result).unwrap();
} else {
let expected_result = std::fs::read(expected_file_path).unwrap_or_default();
if actual_result != expected_result {
panic!("Bless codegen tests with BLESS=1");
}
}

Comment on lines +9 to +15
struct MinimialViableSource {
header: [u8; 4],
trailer: [[u8; 2]]
}

#[unsafe(no_mangle)]
fn codegen_test(source: &MinimialViableSource) -> Option<&coco::Packet> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in the struct name MinimialViableSource. It should be MinimalViableSource.

Suggested change
struct MinimialViableSource {
header: [u8; 4],
trailer: [[u8; 2]]
}
#[unsafe(no_mangle)]
fn codegen_test(source: &MinimialViableSource) -> Option<&coco::Packet> {
struct MinimalViableSource {
header: [u8; 4],
trailer: [[u8; 2]]
}
#[unsafe(no_mangle)]
fn codegen_test(source: &MinimalViableSource) -> Option<&coco::Packet> {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant