derek/gem5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stdlib: Add checkpoint to Simulator

Browse Source 
This change modifies the Simulator constructor to optionally
take a checkpoint directory as an input so that the m5 can
instantiate from the saved checkpoint.

A new method is also added to the Simulator class. The function
will save the checkpoint to the specified directory.

Change-Id: I58b686b6b4f69260ab45709c6ef0bddf4539f0c4
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/58789
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>
Reviewed-by: Bobby Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
This commit is contained in:
Hoa Nguyen
2022-04-11 15:32:45 -07:00
parent 851c86af6d
commit c088af945e
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/python/gem5/simulate/simulator.py
View File

@@ -32,6 +32,7 @@ from m5.objects import Root
from m5.util import warn
import os
from pathlib import Path
from typing import Optional, List, Tuple, Dict, Generator, Union
from .exit_event_generators import (
@@ -76,6 +77,7 @@ class Simulator:
Dict[Union[str, ExitEvent], Generator[Optional[bool], None, None]]
] = None,
expected_execution_order: Optional[List[ExitEvent]] = None,
checkpoint_path: Optional[Path] = None,
) -> None:
"""
:param board: The board to be simulated.
@@ -91,6 +93,9 @@ class Simulator:
encountered (e.g., 'Workbegin', 'Workend', then 'Exit'), an Exception
is thrown. If this parameter is not specified, any ordering of exit
events is valid.
:param checkpoint_path: An optional parameter specifying the directory
of the checkpoint to instantiate from. When the path is None, no
checkpoint will be loaded. By default, the path is None.
`on_exit_event` usage notes
---------------------------
@@ -178,6 +183,8 @@ class Simulator:
self._last_exit_event = None
self._exit_event_count = 0
self._checkpoint_path = checkpoint_path
def get_stats(self) -> Dict:
"""
Obtain the current simulation statistics as a Dictionary, conforming
@@ -283,7 +290,10 @@ class Simulator:
m5.ticks.fixGlobalFrequency()
root.sim_quantum = m5.ticks.fromSeconds(0.001)
m5.instantiate()
# m5.instantiate() takes a parameter specifying the path to the
# checkpoint directory. If the parameter is None, no checkpoint
# will be restored.
m5.instantiate(self._checkpoint_path)
self._instantiated = True
def run(self, max_ticks: int = m5.MaxTick) -> None:
@@ -353,3 +363,13 @@ class Simulator:
# run loop.
if exit_on_completion:
return
def save_checkpoint(self, checkpoint_dir: Path) -> None:
"""
This function will save the checkpoint to the specified directory.
:param checkpoint_dir: The path to the directory where the checkpoint
will be saved.
"""
m5.checkpoint(str(checkpoint_dir))