diff options
author | Riken Gohil <Riken.Gohil@arm.com> | 2017-07-12 17:33:11 +0100 |
---|---|---|
committer | Andreas Sandberg <andreas.sandberg@arm.com> | 2017-12-19 13:14:38 +0000 |
commit | 2a8e7a9ee62ec5caf1c08817005466c10a04c6e3 (patch) | |
tree | 37d20e4df6c5ce2ce0a1f5520032130a8bc5132c /src/cpu/testers/traffic_gen/base_gen.hh | |
parent | 6ab6c52b0bf9c91ef9249613cb4c9d8ab579b4f3 (diff) | |
download | gem5-2a8e7a9ee62ec5caf1c08817005466c10a04c6e3.tar.xz |
cpu-tester: Refactoring traffic generators into separate files.
Change-Id: I2372a0a88e276dcb0c06c3d0a789e010cfba8013
Reviewed-by: Matteo Andreozzi <matteo.andreozzi@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/5722
Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Diffstat (limited to 'src/cpu/testers/traffic_gen/base_gen.hh')
-rw-r--r-- | src/cpu/testers/traffic_gen/base_gen.hh | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/src/cpu/testers/traffic_gen/base_gen.hh b/src/cpu/testers/traffic_gen/base_gen.hh new file mode 100644 index 000000000..26aa62df4 --- /dev/null +++ b/src/cpu/testers/traffic_gen/base_gen.hh @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2012-2013, 2017 ARM Limited + * All rights reserved + * + * The license below extends only to copyright in the software and shall + * not be construed as granting a license to any other intellectual + * property including but not limited to intellectual property relating + * to a hardware implementation of the functionality of the software + * licensed here under. You may use the software subject to the license + * terms below provided that you ensure that this notice is replicated + * unmodified and in its entirety in all distributions of the software, + * modified or unmodified, in source code or in binary form. + * + * 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. + * + * Authors: Thomas Grass + * Andreas Hansson + * Sascha Bischoff + * Neha Agarwal + */ + +/** + * @file + * Declaration of the base generator class for all generators. + */ + +#ifndef __CPU_TRAFFIC_GEN_BASE_GEN_HH__ +#define __CPU_TRAFFIC_GEN_BASE_GEN_HH__ + +#include "base/bitfield.hh" +#include "base/intmath.hh" +#include "mem/packet.hh" +#include "proto/protoio.hh" + +/** + * Base class for all generators, with the shared functionality and + * virtual functions for entering, executing and leaving the + * generator. + */ +class BaseGen +{ + + protected: + + /** Name to use for status and debug printing */ + const std::string _name; + + /** The MasterID used for generating requests */ + const MasterID masterID; + + /** + * Generate a new request and associated packet + * + * @param addr Physical address to use + * @param size Size of the request + * @param cmd Memory command to send + * @param flags Optional request flags + */ + PacketPtr getPacket(Addr addr, unsigned size, const MemCmd& cmd, + Request::FlagsType flags = 0); + + public: + + /** Time to spend in this state */ + const Tick duration; + + /** + * Create a base generator. + * + * @param _name Name to use for status and debug + * @param master_id MasterID set on each request + * @param _duration duration of this state before transitioning + */ + BaseGen(const std::string& _name, MasterID master_id, Tick _duration); + + virtual ~BaseGen() { } + + /** + * Get the name, useful for DPRINTFs. + * + * @return the given name + */ + std::string name() const { return _name; } + + /** + * Enter this generator state. + */ + virtual void enter() = 0; + + /** + * Get the next generated packet. + * + * @return A packet to be sent at the current tick + */ + virtual PacketPtr getNextPacket() = 0; + + /** + * Exit this generator state. By default do nothing. + */ + virtual void exit() { }; + + /** + * Determine the tick when the next packet is available. MaxTick + * means that there will not be any further packets in the current + * activation cycle of the generator. + * + * @param elastic should the injection respond to flow control or not + * @param delay time the previous packet spent waiting + * @return next tick when a packet is available + */ + virtual Tick nextPacketTick(bool elastic, Tick delay) const = 0; + +}; + +#endif |