1# Copyright (c) 2018 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
38from m5.defines import buildEnv
39from m5.SimObject import *
40
41from m5.objects.BaseTrafficGen import *
42
43class PyTrafficGen(BaseTrafficGen):
44    type = 'PyTrafficGen'
45    cxx_header = "cpu/testers/traffic_gen/pygen.hh"
46
47    @cxxMethod
48    def start(self, meta_generator):
49        """
50        Start generating traffic using the provided meta-generator. The
51        meta-generator is an iterable Python object that describes a
52        list of traffic generator instances.
53        """
54        pass
55
56    cxx_exports = [
57        PyBindMethod("createIdle"),
58        PyBindMethod("createExit"),
59        PyBindMethod("createLinear"),
60        PyBindMethod("createRandom"),
61        PyBindMethod("createDram"),
62        PyBindMethod("createDramRot"),
63    ]
64
65    @cxxMethod(override=True)
66    def createTrace(self, duration, trace_file, addr_offset=0):
67        if buildEnv['HAVE_PROTOBUF']:
68            return self.getCCObject().createTrace(duration, trace_file,
69                                                  addr_offset=addr_offset)
70        else:
71            raise NotImplementedError("Trace playback requires that gem5 "
72                                      "was built with protobuf support.")
73