# Copyright (c) 2022 The Regents of the University of California
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""
This configuration script is used to test running a simulation to a specified
maximum tick. This script was setup to test setting the number of ticks to
run before, at, or after the running of `simulator.run`.

**Note:** There can only ever be one MAX_TICK exit event scheduled at any one
time.
"""

from gem5.resources.resource import Resource
from gem5.isas import ISA
from gem5.components.memory import SingleChannelDDR3_1600
from gem5.components.boards.simple_board import SimpleBoard
from gem5.components.cachehierarchies.classic.no_cache import NoCache
from gem5.components.processors.simple_processor import SimpleProcessor
from gem5.components.processors.cpu_types import CPUTypes
from gem5.simulate.simulator import Simulator

import m5

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(
    "-b",
    "--set-ticks-before",
    type=int,
    required=False,
    help="Set the number of ticks to run to prior to executing "
    "`simulator.run`.",
)

parser.add_argument(
    "-e",
    "--set-ticks-at-execution",
    type=int,
    required=False,
    help="Set the number of ticks to run via `simulator.run`.",
)

parser.add_argument(
    "-a",
    "--set-ticks-after",
    type=int,
    required=False,
    help="Set the number of ticks to run after `simulator.run` has ceased "
    "execution.",
)

parser.add_argument(
    "-r",
    "--resource-directory",
    type=str,
    required=False,
    help="The directory in which resources will be downloaded or exist.",
)

args = parser.parse_args()

# Setup the system.
motherboard = SimpleBoard(
    clk_freq="3GHz",
    processor=SimpleProcessor(
        cpu_type=CPUTypes.TIMING,
        isa=ISA.X86,
        num_cores=1,
    ),
    memory=SingleChannelDDR3_1600(),
    cache_hierarchy=NoCache(),
)

# Set the workload
binary = Resource(
    "x86-hello64-static", resource_directory=args.resource_directory
)
motherboard.set_se_binary_workload(binary)

# Set the max ticks before setting up the simulation, if applicable.
if args.set_ticks_before:
    m5.setMaxTick(args.set_ticks_before)

# Run the simulation
simulator = Simulator(board=motherboard)

if args.set_ticks_at_execution:
    simulator.run(max_ticks=args.set_ticks_at_execution)
else:
    simulator.run()

# Set the max ticks after the simulator run.
if args.set_ticks_after:
    m5.setMaxTick(args.set_ticks_after)

print(f"Current Tick: {m5.curTick()}")
print(f"Current Max Tick: {m5.getMaxTick()}")
print(f"Ticks until max: {m5.getTicksUntilMax()}")