gem5.simulate.exit_event_generators module

gem5.simulate.exit_event_generators.dump_reset_generator()

A generator for doing statstic dump and reset. It will reset the simulation statistics and then dump simulation statistics.

The Simulation run loop will continue after executing the behavior of the generator.

gem5.simulate.exit_event_generators.dump_stats_generator()

This generator dumps the stats every time it is called.

gem5.simulate.exit_event_generators.exit_generator()

A default generator for an exit event. It will return True, indicating that the Simulator run loop should exit.

gem5.simulate.exit_event_generators.looppoint_save_checkpoint_generator(checkpoint_dir: Path, looppoint: Looppoint, update_relatives: bool = True, exit_when_empty: bool = True)

A generator for taking a checkpoint for LoopPoint. It will save the checkpoints in the checkpoint_dir path with the Region id.

(i.e. “cpt.Region10) It only takes a checkpoint if the current PC Count pair is a significant PC Count Pair. This is determined in the LoopPoint module. The simulation loop continues after exiting this generator.

Parameters:

  • checkpoint_dir – Where to save the checkpoints.

  • loopoint – The LoopPoint object used in the configuration script

  • update_relative – If the generator should update the relative count information in the output json file, then it should be True. It is default as True.

  • exit_when_empty – If the generator should exit the simulation loop if all PC paris have been discovered, then it should be True. It is default as True.

gem5.simulate.exit_event_generators.reset_stats_generator()

This generator resets the stats every time it is called. It does not dump the stats before resetting them.

gem5.simulate.exit_event_generators.save_checkpoint_generator(checkpoint_dir: Path | None = None)

A generator for taking a checkpoint. It will take a checkpoint with the input path and the current simulation Ticks.

The Simulation run loop will continue after executing the behavior of the generator.

gem5.simulate.exit_event_generators.simpoints_save_checkpoint_generator(checkpoint_dir: Path, simpoint: SimpointResource)

A generator for taking multiple checkpoints for SimPoints. It will save the checkpoints in the checkpoint_dir path with the SimPoints’ index. The Simulation run loop will continue after executing the behavior of the generator until all the SimPoints in the simpoint_list has taken a checkpoint.

gem5.simulate.exit_event_generators.skip_generator()

This generator does nothing when on the exit event.

The simulation will continue after this generator.

gem5.simulate.exit_event_generators.spatter_exit_generator(spatter_gen: SpatterGenerator)
gem5.simulate.exit_event_generators.switch_generator(processor: AbstractProcessor)

A default generator for a switch exit event. If the processor is a SwitchableProcessor, this generator will switch it. Otherwise nothing will happen.

gem5.simulate.exit_event_generators.warn_default_decorator(gen: Generator, type: str, effect: str)

A decortator for generators which will print a warning that it is a default generator.