traffic_gen.hh revision 12396
19241Sandreas.hansson@arm.com/* 212396SRiken.Gohil@arm.com * Copyright (c) 2012-2013, 2016-2017 ARM Limited 39241Sandreas.hansson@arm.com * All rights reserved 49241Sandreas.hansson@arm.com * 59241Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 69241Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 79241Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 89241Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 99241Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 109241Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 119241Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 129241Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 139241Sandreas.hansson@arm.com * 149241Sandreas.hansson@arm.com * Redistribution and use in source and binary forms, with or without 159241Sandreas.hansson@arm.com * modification, are permitted provided that the following conditions are 169241Sandreas.hansson@arm.com * met: redistributions of source code must retain the above copyright 179241Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer; 189241Sandreas.hansson@arm.com * redistributions in binary form must reproduce the above copyright 199241Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer in the 209241Sandreas.hansson@arm.com * documentation and/or other materials provided with the distribution; 219241Sandreas.hansson@arm.com * neither the name of the copyright holders nor the names of its 229241Sandreas.hansson@arm.com * contributors may be used to endorse or promote products derived from 239241Sandreas.hansson@arm.com * this software without specific prior written permission. 249241Sandreas.hansson@arm.com * 259241Sandreas.hansson@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 269241Sandreas.hansson@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 279241Sandreas.hansson@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 289241Sandreas.hansson@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 299241Sandreas.hansson@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 309241Sandreas.hansson@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 319241Sandreas.hansson@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 329241Sandreas.hansson@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 339241Sandreas.hansson@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 349241Sandreas.hansson@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 359241Sandreas.hansson@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 369241Sandreas.hansson@arm.com * 379241Sandreas.hansson@arm.com * Authors: Thomas Grass 389241Sandreas.hansson@arm.com * Andreas Hansson 399241Sandreas.hansson@arm.com * Sascha Bischoff 409241Sandreas.hansson@arm.com */ 4112396SRiken.Gohil@arm.com 429666Sandreas.hansson@arm.com#ifndef __CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 439666Sandreas.hansson@arm.com#define __CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 449241Sandreas.hansson@arm.com 4511168Sandreas.hansson@arm.com#include <unordered_map> 4611168Sandreas.hansson@arm.com 479719Sandreas.hansson@arm.com#include "base/statistics.hh" 4812396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/base_gen.hh" 4912396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/dram_gen.hh" 5012396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/dram_rot_gen.hh" 5112396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/idle_gen.hh" 5212396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/linear_gen.hh" 5312396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/random_gen.hh" 5412396SRiken.Gohil@arm.com#include "cpu/testers/traffic_gen/trace_gen.hh" 559241Sandreas.hansson@arm.com#include "mem/mem_object.hh" 569241Sandreas.hansson@arm.com#include "mem/qport.hh" 579241Sandreas.hansson@arm.com#include "params/TrafficGen.hh" 589241Sandreas.hansson@arm.com 599241Sandreas.hansson@arm.com/** 609241Sandreas.hansson@arm.com * The traffic generator is a master module that generates stimuli for 619717Sandreas.hansson@arm.com * the memory system, based on a collection of simple generator 629717Sandreas.hansson@arm.com * behaviours that are either probabilistic or based on traces. It can 639717Sandreas.hansson@arm.com * be used stand alone for creating test cases for interconnect and 649717Sandreas.hansson@arm.com * memory controllers, or function as a black box replacement for 659717Sandreas.hansson@arm.com * system components that are not yet modelled in detail, e.g. a video 669717Sandreas.hansson@arm.com * engine or baseband subsystem. 679241Sandreas.hansson@arm.com */ 689241Sandreas.hansson@arm.comclass TrafficGen : public MemObject 699241Sandreas.hansson@arm.com{ 709241Sandreas.hansson@arm.com 719241Sandreas.hansson@arm.com private: 729241Sandreas.hansson@arm.com 739241Sandreas.hansson@arm.com /** 749717Sandreas.hansson@arm.com * Determine next state and perform the transition. 759717Sandreas.hansson@arm.com */ 769717Sandreas.hansson@arm.com void transition(); 779717Sandreas.hansson@arm.com 789717Sandreas.hansson@arm.com /** 799717Sandreas.hansson@arm.com * Enter a new state. 809717Sandreas.hansson@arm.com * 819717Sandreas.hansson@arm.com * @param newState identifier of state to enter 829717Sandreas.hansson@arm.com */ 839717Sandreas.hansson@arm.com void enterState(uint32_t newState); 849717Sandreas.hansson@arm.com 859717Sandreas.hansson@arm.com /** 8611540Sandreas.sandberg@arm.com * Resolve a file path in the configuration file. 8711540Sandreas.sandberg@arm.com * 8811540Sandreas.sandberg@arm.com * This method resolves a relative path to a file that has been 8911540Sandreas.sandberg@arm.com * referenced in the configuration file. It first tries to resolve 9011540Sandreas.sandberg@arm.com * the file relative to the configuration file's path. If that 9111540Sandreas.sandberg@arm.com * fails, it falls back to constructing a path relative to the 9211540Sandreas.sandberg@arm.com * current working directory. 9311540Sandreas.sandberg@arm.com * 9411540Sandreas.sandberg@arm.com * Absolute paths are returned unmodified. 9511540Sandreas.sandberg@arm.com * 9611540Sandreas.sandberg@arm.com * @param name Path to resolve 9711540Sandreas.sandberg@arm.com */ 9811540Sandreas.sandberg@arm.com std::string resolveFile(const std::string &name); 9911540Sandreas.sandberg@arm.com 10011540Sandreas.sandberg@arm.com /** 1019717Sandreas.hansson@arm.com * Parse the config file and build the state map and 1029717Sandreas.hansson@arm.com * transition matrix. 1039717Sandreas.hansson@arm.com */ 1049718Sandreas.hansson@arm.com void parseConfig(); 1059717Sandreas.hansson@arm.com 1069717Sandreas.hansson@arm.com /** 1079717Sandreas.hansson@arm.com * Schedules event for next update and executes an update on the 1089717Sandreas.hansson@arm.com * state graph, either performing a state transition or executing 1099717Sandreas.hansson@arm.com * the current state, depending on the current time. 1109717Sandreas.hansson@arm.com */ 1119717Sandreas.hansson@arm.com void update(); 1129717Sandreas.hansson@arm.com 1139719Sandreas.hansson@arm.com /** 1149719Sandreas.hansson@arm.com * Receive a retry from the neighbouring port and attempt to 1159719Sandreas.hansson@arm.com * resend the waiting packet. 1169719Sandreas.hansson@arm.com */ 11710713Sandreas.hansson@arm.com void recvReqRetry(); 1189719Sandreas.hansson@arm.com 11911491Sandreas.hansson@arm.com /** 12011491Sandreas.hansson@arm.com * Method to inform the user we have made no progress. 12111491Sandreas.hansson@arm.com */ 12211491Sandreas.hansson@arm.com void noProgress(); 12311491Sandreas.hansson@arm.com 1249717Sandreas.hansson@arm.com /** Struct to represent a probabilistic transition during parsing. */ 1259717Sandreas.hansson@arm.com struct Transition { 1269717Sandreas.hansson@arm.com uint32_t from; 1279717Sandreas.hansson@arm.com uint32_t to; 1289717Sandreas.hansson@arm.com double p; 1299717Sandreas.hansson@arm.com }; 1309717Sandreas.hansson@arm.com 1319717Sandreas.hansson@arm.com /** 1329241Sandreas.hansson@arm.com * The system used to determine which mode we are currently operating 1339241Sandreas.hansson@arm.com * in. 1349241Sandreas.hansson@arm.com */ 1359241Sandreas.hansson@arm.com System* system; 1369241Sandreas.hansson@arm.com 1379241Sandreas.hansson@arm.com /** 1389241Sandreas.hansson@arm.com * MasterID used in generated requests. 1399241Sandreas.hansson@arm.com */ 1409241Sandreas.hansson@arm.com MasterID masterID; 1419241Sandreas.hansson@arm.com 1429718Sandreas.hansson@arm.com /** 1439718Sandreas.hansson@arm.com * The config file to parse. 1449718Sandreas.hansson@arm.com */ 1459718Sandreas.hansson@arm.com const std::string configFile; 1469718Sandreas.hansson@arm.com 1479720Sandreas.hansson@arm.com /** 1489720Sandreas.hansson@arm.com * Determine whether to add elasticity in the request injection, 1499720Sandreas.hansson@arm.com * thus responding to backpressure by slowing things down. 1509720Sandreas.hansson@arm.com */ 1519720Sandreas.hansson@arm.com const bool elasticReq; 1529720Sandreas.hansson@arm.com 15311491Sandreas.hansson@arm.com /** 15411491Sandreas.hansson@arm.com * Time to tolerate waiting for retries (not making progress), 15511491Sandreas.hansson@arm.com * until we declare things broken. 15611491Sandreas.hansson@arm.com */ 15711491Sandreas.hansson@arm.com const Tick progressCheck; 15811491Sandreas.hansson@arm.com 15911491Sandreas.hansson@arm.com /** 16011491Sandreas.hansson@arm.com * Event to keep track of our progress, or lack thereof. 16111491Sandreas.hansson@arm.com */ 16212085Sspwilson2@wisc.edu EventFunctionWrapper noProgressEvent; 16311491Sandreas.hansson@arm.com 1649717Sandreas.hansson@arm.com /** Time of next transition */ 1659717Sandreas.hansson@arm.com Tick nextTransitionTick; 1669241Sandreas.hansson@arm.com 1679719Sandreas.hansson@arm.com /** Time of the next packet. */ 1689719Sandreas.hansson@arm.com Tick nextPacketTick; 1699719Sandreas.hansson@arm.com 1709717Sandreas.hansson@arm.com /** State transition matrix */ 1719717Sandreas.hansson@arm.com std::vector<std::vector<double> > transitionMatrix; 1729241Sandreas.hansson@arm.com 1739717Sandreas.hansson@arm.com /** Index of the current state */ 1749717Sandreas.hansson@arm.com uint32_t currState; 1759241Sandreas.hansson@arm.com 1769717Sandreas.hansson@arm.com /** Map of generator states */ 17711168Sandreas.hansson@arm.com std::unordered_map<uint32_t, BaseGen*> states; 1789241Sandreas.hansson@arm.com 1799719Sandreas.hansson@arm.com /** Master port specialisation for the traffic generator */ 1809719Sandreas.hansson@arm.com class TrafficGenPort : public MasterPort 1819241Sandreas.hansson@arm.com { 1829241Sandreas.hansson@arm.com public: 1839241Sandreas.hansson@arm.com 1849719Sandreas.hansson@arm.com TrafficGenPort(const std::string& name, TrafficGen& traffic_gen) 1859719Sandreas.hansson@arm.com : MasterPort(name, &traffic_gen), trafficGen(traffic_gen) 1869241Sandreas.hansson@arm.com { } 1879241Sandreas.hansson@arm.com 1889241Sandreas.hansson@arm.com protected: 1899241Sandreas.hansson@arm.com 19010713Sandreas.hansson@arm.com void recvReqRetry() { trafficGen.recvReqRetry(); } 1919719Sandreas.hansson@arm.com 1929241Sandreas.hansson@arm.com bool recvTimingResp(PacketPtr pkt); 1939241Sandreas.hansson@arm.com 19410704Sandreas.hansson@arm.com void recvTimingSnoopReq(PacketPtr pkt) { } 19510704Sandreas.hansson@arm.com 19610704Sandreas.hansson@arm.com void recvFunctionalSnoop(PacketPtr pkt) { } 19710704Sandreas.hansson@arm.com 19810704Sandreas.hansson@arm.com Tick recvAtomicSnoop(PacketPtr pkt) { return 0; } 19910704Sandreas.hansson@arm.com 2009241Sandreas.hansson@arm.com private: 2019241Sandreas.hansson@arm.com 2029719Sandreas.hansson@arm.com TrafficGen& trafficGen; 2039241Sandreas.hansson@arm.com 2049241Sandreas.hansson@arm.com }; 2059241Sandreas.hansson@arm.com 2069717Sandreas.hansson@arm.com /** The instance of master port used by the traffic generator. */ 2079241Sandreas.hansson@arm.com TrafficGenPort port; 2089241Sandreas.hansson@arm.com 2099719Sandreas.hansson@arm.com /** Packet waiting to be sent. */ 2109719Sandreas.hansson@arm.com PacketPtr retryPkt; 2119719Sandreas.hansson@arm.com 2129719Sandreas.hansson@arm.com /** Tick when the stalled packet was meant to be sent. */ 2139719Sandreas.hansson@arm.com Tick retryPktTick; 2149719Sandreas.hansson@arm.com 2159717Sandreas.hansson@arm.com /** Event for scheduling updates */ 21612085Sspwilson2@wisc.edu EventFunctionWrapper updateEvent; 2179241Sandreas.hansson@arm.com 21811393Sandreas.hansson@arm.com uint64_t numSuppressed; 21911393Sandreas.hansson@arm.com 2209719Sandreas.hansson@arm.com /** Count the number of generated packets. */ 2219719Sandreas.hansson@arm.com Stats::Scalar numPackets; 2229719Sandreas.hansson@arm.com 2239719Sandreas.hansson@arm.com /** Count the number of retries. */ 2249719Sandreas.hansson@arm.com Stats::Scalar numRetries; 2259719Sandreas.hansson@arm.com 2269719Sandreas.hansson@arm.com /** Count the time incurred from back-pressure. */ 2279719Sandreas.hansson@arm.com Stats::Scalar retryTicks; 2289241Sandreas.hansson@arm.com 2299241Sandreas.hansson@arm.com public: 2309241Sandreas.hansson@arm.com 2319241Sandreas.hansson@arm.com TrafficGen(const TrafficGenParams* p); 2329241Sandreas.hansson@arm.com 2339241Sandreas.hansson@arm.com ~TrafficGen() {} 2349241Sandreas.hansson@arm.com 23511169Sandreas.hansson@arm.com BaseMasterPort& getMasterPort(const std::string &if_name, 23611169Sandreas.hansson@arm.com PortID idx = InvalidPortID) override; 2379241Sandreas.hansson@arm.com 23811169Sandreas.hansson@arm.com void init() override; 2399241Sandreas.hansson@arm.com 24011169Sandreas.hansson@arm.com void initState() override; 2419241Sandreas.hansson@arm.com 24211168Sandreas.hansson@arm.com DrainState drain() override; 2439241Sandreas.hansson@arm.com 24411168Sandreas.hansson@arm.com void serialize(CheckpointOut &cp) const override; 24511168Sandreas.hansson@arm.com void unserialize(CheckpointIn &cp) override; 2469241Sandreas.hansson@arm.com 2479719Sandreas.hansson@arm.com /** Register statistics */ 24811169Sandreas.hansson@arm.com void regStats() override; 2499719Sandreas.hansson@arm.com 2509241Sandreas.hansson@arm.com}; 2519241Sandreas.hansson@arm.com 2529666Sandreas.hansson@arm.com#endif //__CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 253