src/cpu/testers/traffic_gen/random_gen.hh

   1 /*
   2  * Copyright (c) 2012-2013, 2017-2018 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed here under.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 /**
  39  * @file
  40  * Declaration of the random generator that randomly selects
  41  * addresses within a range.
  42  */
  43
  44 #ifndef __CPU_TRAFFIC_GEN_RANDOM_GEN_HH__
  45 #define __CPU_TRAFFIC_GEN_RANDOM_GEN_HH__
  46
  47 #include "base/bitfield.hh"
  48 #include "base/intmath.hh"
  49 #include "base_gen.hh"
  50 #include "mem/packet.hh"
  51
  52 /**
  53  * The random generator is similar to the linear one, but does
  54  * not generate sequential addresses. Instead it randomly
  55  * picks an address in the range, aligned to the block size.
  56  */
  57 class RandomGen : public StochasticGen
  58 {
  59
  60   public:
  61
  62     /**
  63      * Create a random address sequence generator. Set
  64      * min_period == max_period for a fixed inter-transaction
  65      * time.
  66      *
  67      * @param gen Traffic generator owning this sequence generator
  68      * @param _duration duration of this state before transitioning
  69      * @param start_addr Start address
  70      * @param end_addr End address
  71      * @param _blocksize Size used for transactions injected
  72      * @param min_period Lower limit of random inter-transaction time
  73      * @param max_period Upper limit of random inter-transaction time
  74      * @param read_percent Percent of transactions that are reads
  75      * @param data_limit Upper limit on how much data to read/write
  76      */
  77     RandomGen(SimObject &obj,
  78               MasterID master_id, Tick _duration,
  79               Addr start_addr, Addr end_addr,
  80               Addr _blocksize, Addr cacheline_size,
  81               Tick min_period, Tick max_period,
  82               uint8_t read_percent, Addr data_limit)
  83         : StochasticGen(obj, master_id, _duration, start_addr, end_addr,
  84                         _blocksize, cacheline_size, min_period, max_period,
  85                         read_percent, data_limit),
  86           dataManipulated(0)
  87     { }
  88
  89     void enter();
  90
  91     PacketPtr getNextPacket();
  92
  93     Tick nextPacketTick(bool elastic, Tick delay) const;
  94
  95   protected:
  96     /**
  97      * Counter to determine the amount of data
  98      * manipulated. Used to determine if we should continue
  99      * generating requests.
 100      */
 101     Addr dataManipulated;
 102 };
 103
 104 #endif