random_gen.hh revision 12396:3d04ea44fafb 
1/*
2 * Copyright (c) 2012-2013, 2017 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 * Authors: Thomas Grass
38 *          Andreas Hansson
39 *          Sascha Bischoff
40 *          Neha Agarwal
41 */
42
43/**
44 * @file
45 * Declaration of the random generator that randomly selects
46 * addresses within a range.
47 */
48
49#ifndef __CPU_TRAFFIC_GEN_RANDOM_GEN_HH__
50#define __CPU_TRAFFIC_GEN_RANDOM_GEN_HH__
51
52#include "base/bitfield.hh"
53#include "base/intmath.hh"
54#include "base_gen.hh"
55#include "mem/packet.hh"
56#include "proto/protoio.hh"
57
58/**
59 * The random generator is similar to the linear one, but does
60 * not generate sequential addresses. Instead it randomly
61 * picks an address in the range, aligned to the block size.
62 */
63class RandomGen : public BaseGen
64{
65
66  public:
67
68    /**
69     * Create a random address sequence generator. Set
70     * min_period == max_period for a fixed inter-transaction
71     * time.
72     *
73     * @param _name Name to use for status and debug
74     * @param master_id MasterID set on each request
75     * @param _duration duration of this state before transitioning
76     * @param start_addr Start address
77     * @param end_addr End address
78     * @param _blocksize Size used for transactions injected
79     * @param min_period Lower limit of random inter-transaction time
80     * @param max_period Upper limit of random inter-transaction time
81     * @param read_percent Percent of transactions that are reads
82     * @param data_limit Upper limit on how much data to read/write
83     */
84    RandomGen(const std::string& _name, MasterID master_id, Tick _duration,
85              Addr start_addr, Addr end_addr, Addr _blocksize,
86              Tick min_period, Tick max_period,
87              uint8_t read_percent, Addr data_limit)
88        : BaseGen(_name, master_id, _duration),
89          startAddr(start_addr), endAddr(end_addr),
90          blocksize(_blocksize), minPeriod(min_period),
91          maxPeriod(max_period), readPercent(read_percent),
92          dataLimit(data_limit), dataManipulated(0)
93    { }
94
95    void enter();
96
97    PacketPtr getNextPacket();
98
99    Tick nextPacketTick(bool elastic, Tick delay) const;
100
101  protected:
102
103    /** Start of address range */
104    const Addr startAddr;
105
106    /** End of address range */
107    const Addr endAddr;
108
109    /** Block size */
110    const Addr blocksize;
111
112    /** Request generation period */
113    const Tick minPeriod;
114    const Tick maxPeriod;
115
116    /**
117     * Percent of generated transactions that should be reads
118     */
119    const uint8_t readPercent;
120
121    /** Maximum amount of data to manipulate */
122    const Addr dataLimit;
123
124    /**
125     * Counter to determine the amount of data
126     * manipulated. Used to determine if we should continue
127     * generating requests.
128     */
129    Addr dataManipulated;
130};
131
132#endif
133