traffic_gen.hh revision 10704
19241Sandreas.hansson@arm.com/* 29717Sandreas.hansson@arm.com * Copyright (c) 2012-2013 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 449241Sandreas.hansson@arm.com#include "base/hashmap.hh" 459719Sandreas.hansson@arm.com#include "base/statistics.hh" 469666Sandreas.hansson@arm.com#include "cpu/testers/traffic_gen/generators.hh" 479241Sandreas.hansson@arm.com#include "mem/mem_object.hh" 489241Sandreas.hansson@arm.com#include "mem/qport.hh" 499241Sandreas.hansson@arm.com#include "params/TrafficGen.hh" 509241Sandreas.hansson@arm.com 519241Sandreas.hansson@arm.com/** 529241Sandreas.hansson@arm.com * The traffic generator is a master module that generates stimuli for 539717Sandreas.hansson@arm.com * the memory system, based on a collection of simple generator 549717Sandreas.hansson@arm.com * behaviours that are either probabilistic or based on traces. It can 559717Sandreas.hansson@arm.com * be used stand alone for creating test cases for interconnect and 569717Sandreas.hansson@arm.com * memory controllers, or function as a black box replacement for 579717Sandreas.hansson@arm.com * system components that are not yet modelled in detail, e.g. a video 589717Sandreas.hansson@arm.com * engine or baseband subsystem. 599241Sandreas.hansson@arm.com */ 609241Sandreas.hansson@arm.comclass TrafficGen : public MemObject 619241Sandreas.hansson@arm.com{ 629241Sandreas.hansson@arm.com 639241Sandreas.hansson@arm.com private: 649241Sandreas.hansson@arm.com 659241Sandreas.hansson@arm.com /** 669717Sandreas.hansson@arm.com * Determine next state and perform the transition. 679717Sandreas.hansson@arm.com */ 689717Sandreas.hansson@arm.com void transition(); 699717Sandreas.hansson@arm.com 709717Sandreas.hansson@arm.com /** 719717Sandreas.hansson@arm.com * Enter a new state. 729717Sandreas.hansson@arm.com * 739717Sandreas.hansson@arm.com * @param newState identifier of state to enter 749717Sandreas.hansson@arm.com */ 759717Sandreas.hansson@arm.com void enterState(uint32_t newState); 769717Sandreas.hansson@arm.com 779717Sandreas.hansson@arm.com /** 789717Sandreas.hansson@arm.com * Parse the config file and build the state map and 799717Sandreas.hansson@arm.com * transition matrix. 809717Sandreas.hansson@arm.com */ 819718Sandreas.hansson@arm.com void parseConfig(); 829717Sandreas.hansson@arm.com 839717Sandreas.hansson@arm.com /** 849717Sandreas.hansson@arm.com * Schedules event for next update and executes an update on the 859717Sandreas.hansson@arm.com * state graph, either performing a state transition or executing 869717Sandreas.hansson@arm.com * the current state, depending on the current time. 879717Sandreas.hansson@arm.com */ 889717Sandreas.hansson@arm.com void update(); 899717Sandreas.hansson@arm.com 909719Sandreas.hansson@arm.com /** 919719Sandreas.hansson@arm.com * Receive a retry from the neighbouring port and attempt to 929719Sandreas.hansson@arm.com * resend the waiting packet. 939719Sandreas.hansson@arm.com */ 949719Sandreas.hansson@arm.com void recvRetry(); 959719Sandreas.hansson@arm.com 969717Sandreas.hansson@arm.com /** Struct to represent a probabilistic transition during parsing. */ 979717Sandreas.hansson@arm.com struct Transition { 989717Sandreas.hansson@arm.com uint32_t from; 999717Sandreas.hansson@arm.com uint32_t to; 1009717Sandreas.hansson@arm.com double p; 1019717Sandreas.hansson@arm.com }; 1029717Sandreas.hansson@arm.com 1039717Sandreas.hansson@arm.com /** 1049241Sandreas.hansson@arm.com * The system used to determine which mode we are currently operating 1059241Sandreas.hansson@arm.com * in. 1069241Sandreas.hansson@arm.com */ 1079241Sandreas.hansson@arm.com System* system; 1089241Sandreas.hansson@arm.com 1099241Sandreas.hansson@arm.com /** 1109241Sandreas.hansson@arm.com * MasterID used in generated requests. 1119241Sandreas.hansson@arm.com */ 1129241Sandreas.hansson@arm.com MasterID masterID; 1139241Sandreas.hansson@arm.com 1149718Sandreas.hansson@arm.com /** 1159718Sandreas.hansson@arm.com * The config file to parse. 1169718Sandreas.hansson@arm.com */ 1179718Sandreas.hansson@arm.com const std::string configFile; 1189718Sandreas.hansson@arm.com 1199720Sandreas.hansson@arm.com /** 1209720Sandreas.hansson@arm.com * Determine whether to add elasticity in the request injection, 1219720Sandreas.hansson@arm.com * thus responding to backpressure by slowing things down. 1229720Sandreas.hansson@arm.com */ 1239720Sandreas.hansson@arm.com const bool elasticReq; 1249720Sandreas.hansson@arm.com 1259717Sandreas.hansson@arm.com /** Time of next transition */ 1269717Sandreas.hansson@arm.com Tick nextTransitionTick; 1279241Sandreas.hansson@arm.com 1289719Sandreas.hansson@arm.com /** Time of the next packet. */ 1299719Sandreas.hansson@arm.com Tick nextPacketTick; 1309719Sandreas.hansson@arm.com 1319717Sandreas.hansson@arm.com /** State transition matrix */ 1329717Sandreas.hansson@arm.com std::vector<std::vector<double> > transitionMatrix; 1339241Sandreas.hansson@arm.com 1349717Sandreas.hansson@arm.com /** Index of the current state */ 1359717Sandreas.hansson@arm.com uint32_t currState; 1369241Sandreas.hansson@arm.com 1379717Sandreas.hansson@arm.com /** Map of generator states */ 1389717Sandreas.hansson@arm.com m5::hash_map<uint32_t, BaseGen*> states; 1399241Sandreas.hansson@arm.com 1409719Sandreas.hansson@arm.com /** Master port specialisation for the traffic generator */ 1419719Sandreas.hansson@arm.com class TrafficGenPort : public MasterPort 1429241Sandreas.hansson@arm.com { 1439241Sandreas.hansson@arm.com public: 1449241Sandreas.hansson@arm.com 1459719Sandreas.hansson@arm.com TrafficGenPort(const std::string& name, TrafficGen& traffic_gen) 1469719Sandreas.hansson@arm.com : MasterPort(name, &traffic_gen), trafficGen(traffic_gen) 1479241Sandreas.hansson@arm.com { } 1489241Sandreas.hansson@arm.com 1499241Sandreas.hansson@arm.com protected: 1509241Sandreas.hansson@arm.com 1519719Sandreas.hansson@arm.com void recvRetry() { trafficGen.recvRetry(); } 1529719Sandreas.hansson@arm.com 1539241Sandreas.hansson@arm.com bool recvTimingResp(PacketPtr pkt); 1549241Sandreas.hansson@arm.com 15510704Sandreas.hansson@arm.com void recvTimingSnoopReq(PacketPtr pkt) { } 15610704Sandreas.hansson@arm.com 15710704Sandreas.hansson@arm.com void recvFunctionalSnoop(PacketPtr pkt) { } 15810704Sandreas.hansson@arm.com 15910704Sandreas.hansson@arm.com Tick recvAtomicSnoop(PacketPtr pkt) { return 0; } 16010704Sandreas.hansson@arm.com 1619241Sandreas.hansson@arm.com private: 1629241Sandreas.hansson@arm.com 1639719Sandreas.hansson@arm.com TrafficGen& trafficGen; 1649241Sandreas.hansson@arm.com 1659241Sandreas.hansson@arm.com }; 1669241Sandreas.hansson@arm.com 1679717Sandreas.hansson@arm.com /** The instance of master port used by the traffic generator. */ 1689241Sandreas.hansson@arm.com TrafficGenPort port; 1699241Sandreas.hansson@arm.com 1709719Sandreas.hansson@arm.com /** Packet waiting to be sent. */ 1719719Sandreas.hansson@arm.com PacketPtr retryPkt; 1729719Sandreas.hansson@arm.com 1739719Sandreas.hansson@arm.com /** Tick when the stalled packet was meant to be sent. */ 1749719Sandreas.hansson@arm.com Tick retryPktTick; 1759719Sandreas.hansson@arm.com 1769717Sandreas.hansson@arm.com /** Event for scheduling updates */ 1779717Sandreas.hansson@arm.com EventWrapper<TrafficGen, &TrafficGen::update> updateEvent; 1789241Sandreas.hansson@arm.com 1799719Sandreas.hansson@arm.com /** Manager to signal when drained */ 1809719Sandreas.hansson@arm.com DrainManager* drainManager; 1819719Sandreas.hansson@arm.com 1829719Sandreas.hansson@arm.com /** Count the number of generated packets. */ 1839719Sandreas.hansson@arm.com Stats::Scalar numPackets; 1849719Sandreas.hansson@arm.com 1859719Sandreas.hansson@arm.com /** Count the number of retries. */ 1869719Sandreas.hansson@arm.com Stats::Scalar numRetries; 1879719Sandreas.hansson@arm.com 1889719Sandreas.hansson@arm.com /** Count the time incurred from back-pressure. */ 1899719Sandreas.hansson@arm.com Stats::Scalar retryTicks; 1909241Sandreas.hansson@arm.com 1919241Sandreas.hansson@arm.com public: 1929241Sandreas.hansson@arm.com 1939241Sandreas.hansson@arm.com TrafficGen(const TrafficGenParams* p); 1949241Sandreas.hansson@arm.com 1959241Sandreas.hansson@arm.com ~TrafficGen() {} 1969241Sandreas.hansson@arm.com 1979294Sandreas.hansson@arm.com virtual BaseMasterPort& getMasterPort(const std::string &if_name, 1989294Sandreas.hansson@arm.com PortID idx = InvalidPortID); 1999241Sandreas.hansson@arm.com 2009241Sandreas.hansson@arm.com void init(); 2019241Sandreas.hansson@arm.com 2029241Sandreas.hansson@arm.com void initState(); 2039241Sandreas.hansson@arm.com 2049342SAndreas.Sandberg@arm.com unsigned int drain(DrainManager *dm); 2059241Sandreas.hansson@arm.com 2069241Sandreas.hansson@arm.com void serialize(std::ostream &os); 2079241Sandreas.hansson@arm.com 2089241Sandreas.hansson@arm.com void unserialize(Checkpoint* cp, const std::string& section); 2099241Sandreas.hansson@arm.com 2109719Sandreas.hansson@arm.com /** Register statistics */ 2119719Sandreas.hansson@arm.com void regStats(); 2129719Sandreas.hansson@arm.com 2139241Sandreas.hansson@arm.com}; 2149241Sandreas.hansson@arm.com 2159666Sandreas.hansson@arm.com#endif //__CPU_TRAFFIC_GEN_TRAFFIC_GEN_HH__ 216