1# Copyright (c) 2017 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Andreas Sandberg
37#          Stephan Diestelhorst
38
39# This configuration file extends the example ARM big.LITTLE(tm)
40# with example power models.
41
42from __future__ import print_function
43from __future__ import absolute_import
44
45import argparse
46import os
47
48import m5
49from m5.objects import MathExprPowerModel, PowerModel
50
51import fs_bigLITTLE as bL
52
53
54class CpuPowerOn(MathExprPowerModel):
55    # 2A per IPC, 3pA per cache miss
56    # and then convert to Watt
57    dyn = "voltage * (2 * ipc + " \
58            "3 * 0.000000001 * dcache.overall_misses / sim_seconds)"
59    st = "4 * temp"
60
61class CpuPowerOff(MathExprPowerModel):
62    dyn = "0"
63    st = "0"
64
65class CpuPowerModel(PowerModel):
66    pm = [
67        CpuPowerOn(), # ON
68        CpuPowerOff(), # CLK_GATED
69        CpuPowerOff(), # SRAM_RETENTION
70        CpuPowerOff(), # OFF
71    ]
72
73class L2PowerOn(MathExprPowerModel):
74    # Example to report l2 Cache overall_accesses
75    # The estimated power is converted to Watt and will vary based on the size of the cache
76    dyn = "overall_accesses*0.000018000"
77    st = "(voltage * 3)/10"
78
79class L2PowerOff(MathExprPowerModel):
80    dyn = "0"
81    st = "0"
82
83class L2PowerModel(PowerModel):
84    # Choose a power model for every power state
85    pm = [
86        L2PowerOn(), # ON
87        L2PowerOff(), # CLK_GATED
88        L2PowerOff(), # SRAM_RETENTION
89        L2PowerOff(), # OFF
90    ]
91
92
93def main():
94    parser = argparse.ArgumentParser(
95        description="Generic ARM big.LITTLE configuration with "\
96        "example power models")
97    bL.addOptions(parser)
98    options = parser.parse_args()
99
100    if options.cpu_type != "timing":
101        m5.fatal("The power example script requires 'timing' CPUs.")
102
103    root = bL.build(options)
104
105    # Wire up some example power models to the CPUs
106    for cpu in root.system.descendants():
107        if not isinstance(cpu, m5.objects.BaseCPU):
108            continue
109
110        cpu.default_p_state = "ON"
111        cpu.power_model = CpuPowerModel()
112
113    # Example power model for the L2 Cache of the bigCluster
114    for l2 in root.system.bigCluster.l2.descendants():
115        if not isinstance(l2, m5.objects.Cache):
116            continue
117
118        l2.default_p_state = "ON"
119        l2.power_model = L2PowerModel()
120
121    bL.instantiate(options)
122
123    print("*" * 70)
124    print("WARNING: The power numbers generated by this script are "
125        "examples. They are not representative of any particular "
126        "implementation or process.")
127    print("*" * 70)
128
129    # Dumping stats periodically
130    m5.stats.periodicStatDump(m5.ticks.fromSeconds(0.1E-3))
131    bL.run()
132
133
134if __name__ == "__m5_main__":
135    main()
136