traffic_gen.hh revision 12085
19241Sandreas.hansson@arm.com/* 211491Sandreas.hansson@arm.com * Copyright (c) 2012-2013, 2016 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 */ 419666Sandreas.hansson@arm.com#ifndef __CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 429666Sandreas.hansson@arm.com#define __CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 439241Sandreas.hansson@arm.com 4411168Sandreas.hansson@arm.com#include <unordered_map> 4511168Sandreas.hansson@arm.com 469719Sandreas.hansson@arm.com#include "base/statistics.hh" 479666Sandreas.hansson@arm.com#include "cpu/testers/traffic_gen/generators.hh" 489241Sandreas.hansson@arm.com#include "mem/mem_object.hh" 499241Sandreas.hansson@arm.com#include "mem/qport.hh" 509241Sandreas.hansson@arm.com#include "params/TrafficGen.hh" 519241Sandreas.hansson@arm.com 529241Sandreas.hansson@arm.com/** 539241Sandreas.hansson@arm.com * The traffic generator is a master module that generates stimuli for 549717Sandreas.hansson@arm.com * the memory system, based on a collection of simple generator 559717Sandreas.hansson@arm.com * behaviours that are either probabilistic or based on traces. It can 569717Sandreas.hansson@arm.com * be used stand alone for creating test cases for interconnect and 579717Sandreas.hansson@arm.com * memory controllers, or function as a black box replacement for 589717Sandreas.hansson@arm.com * system components that are not yet modelled in detail, e.g. a video 599717Sandreas.hansson@arm.com * engine or baseband subsystem. 609241Sandreas.hansson@arm.com */ 619241Sandreas.hansson@arm.comclass TrafficGen : public MemObject 629241Sandreas.hansson@arm.com{ 639241Sandreas.hansson@arm.com 649241Sandreas.hansson@arm.com private: 659241Sandreas.hansson@arm.com 669241Sandreas.hansson@arm.com /** 679717Sandreas.hansson@arm.com * Determine next state and perform the transition. 689717Sandreas.hansson@arm.com */ 699717Sandreas.hansson@arm.com void transition(); 709717Sandreas.hansson@arm.com 719717Sandreas.hansson@arm.com /** 729717Sandreas.hansson@arm.com * Enter a new state. 739717Sandreas.hansson@arm.com * 749717Sandreas.hansson@arm.com * @param newState identifier of state to enter 759717Sandreas.hansson@arm.com */ 769717Sandreas.hansson@arm.com void enterState(uint32_t newState); 779717Sandreas.hansson@arm.com 789717Sandreas.hansson@arm.com /** 7911540Sandreas.sandberg@arm.com * Resolve a file path in the configuration file. 8011540Sandreas.sandberg@arm.com * 8111540Sandreas.sandberg@arm.com * This method resolves a relative path to a file that has been 8211540Sandreas.sandberg@arm.com * referenced in the configuration file. It first tries to resolve 8311540Sandreas.sandberg@arm.com * the file relative to the configuration file's path. If that 8411540Sandreas.sandberg@arm.com * fails, it falls back to constructing a path relative to the 8511540Sandreas.sandberg@arm.com * current working directory. 8611540Sandreas.sandberg@arm.com * 8711540Sandreas.sandberg@arm.com * Absolute paths are returned unmodified. 8811540Sandreas.sandberg@arm.com * 8911540Sandreas.sandberg@arm.com * @param name Path to resolve 9011540Sandreas.sandberg@arm.com */ 9111540Sandreas.sandberg@arm.com std::string resolveFile(const std::string &name); 9211540Sandreas.sandberg@arm.com 9311540Sandreas.sandberg@arm.com /** 949717Sandreas.hansson@arm.com * Parse the config file and build the state map and 959717Sandreas.hansson@arm.com * transition matrix. 969717Sandreas.hansson@arm.com */ 979718Sandreas.hansson@arm.com void parseConfig(); 989717Sandreas.hansson@arm.com 999717Sandreas.hansson@arm.com /** 1009717Sandreas.hansson@arm.com * Schedules event for next update and executes an update on the 1019717Sandreas.hansson@arm.com * state graph, either performing a state transition or executing 1029717Sandreas.hansson@arm.com * the current state, depending on the current time. 1039717Sandreas.hansson@arm.com */ 1049717Sandreas.hansson@arm.com void update(); 1059717Sandreas.hansson@arm.com 1069719Sandreas.hansson@arm.com /** 1079719Sandreas.hansson@arm.com * Receive a retry from the neighbouring port and attempt to 1089719Sandreas.hansson@arm.com * resend the waiting packet. 1099719Sandreas.hansson@arm.com */ 11010713Sandreas.hansson@arm.com void recvReqRetry(); 1119719Sandreas.hansson@arm.com 11211491Sandreas.hansson@arm.com /** 11311491Sandreas.hansson@arm.com * Method to inform the user we have made no progress. 11411491Sandreas.hansson@arm.com */ 11511491Sandreas.hansson@arm.com void noProgress(); 11611491Sandreas.hansson@arm.com 1179717Sandreas.hansson@arm.com /** Struct to represent a probabilistic transition during parsing. */ 1189717Sandreas.hansson@arm.com struct Transition { 1199717Sandreas.hansson@arm.com uint32_t from; 1209717Sandreas.hansson@arm.com uint32_t to; 1219717Sandreas.hansson@arm.com double p; 1229717Sandreas.hansson@arm.com }; 1239717Sandreas.hansson@arm.com 1249717Sandreas.hansson@arm.com /** 1259241Sandreas.hansson@arm.com * The system used to determine which mode we are currently operating 1269241Sandreas.hansson@arm.com * in. 1279241Sandreas.hansson@arm.com */ 1289241Sandreas.hansson@arm.com System* system; 1299241Sandreas.hansson@arm.com 1309241Sandreas.hansson@arm.com /** 1319241Sandreas.hansson@arm.com * MasterID used in generated requests. 1329241Sandreas.hansson@arm.com */ 1339241Sandreas.hansson@arm.com MasterID masterID; 1349241Sandreas.hansson@arm.com 1359718Sandreas.hansson@arm.com /** 1369718Sandreas.hansson@arm.com * The config file to parse. 1379718Sandreas.hansson@arm.com */ 1389718Sandreas.hansson@arm.com const std::string configFile; 1399718Sandreas.hansson@arm.com 1409720Sandreas.hansson@arm.com /** 1419720Sandreas.hansson@arm.com * Determine whether to add elasticity in the request injection, 1429720Sandreas.hansson@arm.com * thus responding to backpressure by slowing things down. 1439720Sandreas.hansson@arm.com */ 1449720Sandreas.hansson@arm.com const bool elasticReq; 1459720Sandreas.hansson@arm.com 14611491Sandreas.hansson@arm.com /** 14711491Sandreas.hansson@arm.com * Time to tolerate waiting for retries (not making progress), 14811491Sandreas.hansson@arm.com * until we declare things broken. 14911491Sandreas.hansson@arm.com */ 15011491Sandreas.hansson@arm.com const Tick progressCheck; 15111491Sandreas.hansson@arm.com 15211491Sandreas.hansson@arm.com /** 15311491Sandreas.hansson@arm.com * Event to keep track of our progress, or lack thereof. 15411491Sandreas.hansson@arm.com */ 15512085Sspwilson2@wisc.edu EventFunctionWrapper noProgressEvent; 15611491Sandreas.hansson@arm.com 1579717Sandreas.hansson@arm.com /** Time of next transition */ 1589717Sandreas.hansson@arm.com Tick nextTransitionTick; 1599241Sandreas.hansson@arm.com 1609719Sandreas.hansson@arm.com /** Time of the next packet. */ 1619719Sandreas.hansson@arm.com Tick nextPacketTick; 1629719Sandreas.hansson@arm.com 1639717Sandreas.hansson@arm.com /** State transition matrix */ 1649717Sandreas.hansson@arm.com std::vector<std::vector<double> > transitionMatrix; 1659241Sandreas.hansson@arm.com 1669717Sandreas.hansson@arm.com /** Index of the current state */ 1679717Sandreas.hansson@arm.com uint32_t currState; 1689241Sandreas.hansson@arm.com 1699717Sandreas.hansson@arm.com /** Map of generator states */ 17011168Sandreas.hansson@arm.com std::unordered_map<uint32_t, BaseGen*> states; 1719241Sandreas.hansson@arm.com 1729719Sandreas.hansson@arm.com /** Master port specialisation for the traffic generator */ 1739719Sandreas.hansson@arm.com class TrafficGenPort : public MasterPort 1749241Sandreas.hansson@arm.com { 1759241Sandreas.hansson@arm.com public: 1769241Sandreas.hansson@arm.com 1779719Sandreas.hansson@arm.com TrafficGenPort(const std::string& name, TrafficGen& traffic_gen) 1789719Sandreas.hansson@arm.com : MasterPort(name, &traffic_gen), trafficGen(traffic_gen) 1799241Sandreas.hansson@arm.com { } 1809241Sandreas.hansson@arm.com 1819241Sandreas.hansson@arm.com protected: 1829241Sandreas.hansson@arm.com 18310713Sandreas.hansson@arm.com void recvReqRetry() { trafficGen.recvReqRetry(); } 1849719Sandreas.hansson@arm.com 1859241Sandreas.hansson@arm.com bool recvTimingResp(PacketPtr pkt); 1869241Sandreas.hansson@arm.com 18710704Sandreas.hansson@arm.com void recvTimingSnoopReq(PacketPtr pkt) { } 18810704Sandreas.hansson@arm.com 18910704Sandreas.hansson@arm.com void recvFunctionalSnoop(PacketPtr pkt) { } 19010704Sandreas.hansson@arm.com 19110704Sandreas.hansson@arm.com Tick recvAtomicSnoop(PacketPtr pkt) { return 0; } 19210704Sandreas.hansson@arm.com 1939241Sandreas.hansson@arm.com private: 1949241Sandreas.hansson@arm.com 1959719Sandreas.hansson@arm.com TrafficGen& trafficGen; 1969241Sandreas.hansson@arm.com 1979241Sandreas.hansson@arm.com }; 1989241Sandreas.hansson@arm.com 1999717Sandreas.hansson@arm.com /** The instance of master port used by the traffic generator. */ 2009241Sandreas.hansson@arm.com TrafficGenPort port; 2019241Sandreas.hansson@arm.com 2029719Sandreas.hansson@arm.com /** Packet waiting to be sent. */ 2039719Sandreas.hansson@arm.com PacketPtr retryPkt; 2049719Sandreas.hansson@arm.com 2059719Sandreas.hansson@arm.com /** Tick when the stalled packet was meant to be sent. */ 2069719Sandreas.hansson@arm.com Tick retryPktTick; 2079719Sandreas.hansson@arm.com 2089717Sandreas.hansson@arm.com /** Event for scheduling updates */ 20912085Sspwilson2@wisc.edu EventFunctionWrapper updateEvent; 2109241Sandreas.hansson@arm.com 21111393Sandreas.hansson@arm.com uint64_t numSuppressed; 21211393Sandreas.hansson@arm.com 2139719Sandreas.hansson@arm.com /** Count the number of generated packets. */ 2149719Sandreas.hansson@arm.com Stats::Scalar numPackets; 2159719Sandreas.hansson@arm.com 2169719Sandreas.hansson@arm.com /** Count the number of retries. */ 2179719Sandreas.hansson@arm.com Stats::Scalar numRetries; 2189719Sandreas.hansson@arm.com 2199719Sandreas.hansson@arm.com /** Count the time incurred from back-pressure. */ 2209719Sandreas.hansson@arm.com Stats::Scalar retryTicks; 2219241Sandreas.hansson@arm.com 2229241Sandreas.hansson@arm.com public: 2239241Sandreas.hansson@arm.com 2249241Sandreas.hansson@arm.com TrafficGen(const TrafficGenParams* p); 2259241Sandreas.hansson@arm.com 2269241Sandreas.hansson@arm.com ~TrafficGen() {} 2279241Sandreas.hansson@arm.com 22811169Sandreas.hansson@arm.com BaseMasterPort& getMasterPort(const std::string &if_name, 22911169Sandreas.hansson@arm.com PortID idx = InvalidPortID) override; 2309241Sandreas.hansson@arm.com 23111169Sandreas.hansson@arm.com void init() override; 2329241Sandreas.hansson@arm.com 23311169Sandreas.hansson@arm.com void initState() override; 2349241Sandreas.hansson@arm.com 23511168Sandreas.hansson@arm.com DrainState drain() override; 2369241Sandreas.hansson@arm.com 23711168Sandreas.hansson@arm.com void serialize(CheckpointOut &cp) const override; 23811168Sandreas.hansson@arm.com void unserialize(CheckpointIn &cp) override; 2399241Sandreas.hansson@arm.com 2409719Sandreas.hansson@arm.com /** Register statistics */ 24111169Sandreas.hansson@arm.com void regStats() override; 2429719Sandreas.hansson@arm.com 2439241Sandreas.hansson@arm.com}; 2449241Sandreas.hansson@arm.com 2459666Sandreas.hansson@arm.com#endif //__CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 246