Skip to content

sim,python: Document and name the hypercall exit APIs#83

Open
erin-le wants to merge 1 commit into
labeler-actionfrom
pr-2983
Open

sim,python: Document and name the hypercall exit APIs#83
erin-le wants to merge 1 commit into
labeler-actionfrom
pr-2983

Conversation

@erin-le
Copy link
Copy Markdown
Owner

@erin-le erin-le commented May 6, 2026

  • add "include/gem5/exit_hypercalls.hh" and expand it into the C++ enum, the kExitHypercall* constants, the pybind enum, and the guest-facing M5_HYPERCALL_* macros so every layer pulls its IDs from the same source,

  • expose the enum to Python, allow ExitHandlers to be registered via enums/strings, add a hypercall= alias for the old hypercall_num argument, and update the sample configs/tests to use the descriptive names

  • flesh out the "sim_exit.hh" docs so it is clear when to use the legacy exitSimLoop* helpers, the transitional exitSimLoopWithHypercall, or the new exitSimulationLoop* APIs

- add "include/gem5/exit_hypercalls.hh" and expand it into the C++ enum,
  the `kExitHypercall*` constants, the pybind enum, and the
  guest-facing `M5_HYPERCALL_*` macros so every layer pulls its IDs
  from the same source,

- expose the enum to Python, allow `ExitHandler`s to be registered via
  enums/strings, add a `hypercall=` alias for the old `hypercall_num`
  argument, and update the sample configs/tests to use the descriptive
  names

- flesh out the "sim_exit.hh" docs so it is clear when to use the legacy
  `exitSimLoop*` helpers, the transitional `exitSimLoopWithHypercall`,
  or the new `exitSimulationLoop*` APIs
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

I added these labels: configs,python,sim,stdlib,tests,util

@erin-le erin-le force-pushed the labeler-action branch 3 times, most recently from 4c4507a to a85cdb8 Compare May 13, 2026 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants