RubySystem.hh revision 11430:bd1c6789c33f 
1/*
2 * Copyright (c) 1999-2012 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/*
30 * Contains all of the various parts of the system we are simulating.
31 * Performs allocation, deallocation, and setup of all the major
32 * components of the system
33 */
34
35#ifndef __MEM_RUBY_SYSTEM_SYSTEM_HH__
36#define __MEM_RUBY_SYSTEM_SYSTEM_HH__
37
38#include "base/callback.hh"
39#include "base/output.hh"
40#include "mem/packet.hh"
41#include "mem/ruby/profiler/Profiler.hh"
42#include "mem/ruby/slicc_interface/AbstractController.hh"
43#include "mem/ruby/system/CacheRecorder.hh"
44#include "params/RubySystem.hh"
45#include "sim/clocked_object.hh"
46
47class Network;
48class AbstractController;
49
50class RubySystem : public ClockedObject
51{
52  public:
53    class RubyEvent : public Event
54    {
55      public:
56        RubyEvent(RubySystem* _ruby_system)
57        {
58            m_ruby_system = _ruby_system;
59        }
60      private:
61        void process();
62
63        RubySystem* m_ruby_system;
64    };
65
66    friend class RubyEvent;
67
68    typedef RubySystemParams Params;
69    RubySystem(const Params *p);
70    ~RubySystem();
71
72    // config accessors
73    static int getRandomization() { return m_randomization; }
74    static uint32_t getBlockSizeBytes() { return m_block_size_bytes; }
75    static uint32_t getBlockSizeBits() { return m_block_size_bits; }
76    static uint32_t getMemorySizeBits() { return m_memory_size_bits; }
77    static bool getWarmupEnabled() { return m_warmup_enabled; }
78    static bool getCooldownEnabled() { return m_cooldown_enabled; }
79
80    SimpleMemory *getPhysMem() { return m_phys_mem; }
81    Cycles getStartCycle() { return m_start_cycle; }
82    bool getAccessBackingStore() { return m_access_backing_store; }
83
84    // Public Methods
85    Profiler*
86    getProfiler()
87    {
88        assert(m_profiler != NULL);
89        return m_profiler;
90    }
91
92    void regStats() override { m_profiler->regStats(name()); }
93    void collateStats() { m_profiler->collateStats(); }
94    void resetStats() override;
95
96    void memWriteback() override;
97    void serialize(CheckpointOut &cp) const override;
98    void unserialize(CheckpointIn &cp) override;
99    void drainResume() override;
100    void process();
101    void startup() override;
102    bool functionalRead(Packet *ptr);
103    bool functionalWrite(Packet *ptr);
104
105    void registerNetwork(Network*);
106    void registerAbstractController(AbstractController*);
107
108    bool eventQueueEmpty() { return eventq->empty(); }
109    void enqueueRubyEvent(Tick tick)
110    {
111        RubyEvent* e = new RubyEvent(this);
112        schedule(e, tick);
113    }
114
115  private:
116    // Private copy constructor and assignment operator
117    RubySystem(const RubySystem& obj);
118    RubySystem& operator=(const RubySystem& obj);
119
120    void makeCacheRecorder(uint8_t *uncompressed_trace,
121                           uint64_t cache_trace_size,
122                           uint64_t block_size_bytes);
123
124    static void readCompressedTrace(std::string filename,
125                                    uint8_t *&raw_data,
126                                    uint64_t &uncompressed_trace_size);
127    static void writeCompressedTrace(uint8_t *raw_data, std::string file,
128                                     uint64_t uncompressed_trace_size);
129
130  private:
131    // configuration parameters
132    static bool m_randomization;
133    static uint32_t m_block_size_bytes;
134    static uint32_t m_block_size_bits;
135    static uint32_t m_memory_size_bits;
136
137    static bool m_warmup_enabled;
138    static unsigned m_systems_to_warmup;
139    static bool m_cooldown_enabled;
140    SimpleMemory *m_phys_mem;
141    const bool m_access_backing_store;
142
143    Network* m_network;
144    std::vector<AbstractController *> m_abs_cntrl_vec;
145    Cycles m_start_cycle;
146
147  public:
148    Profiler* m_profiler;
149    CacheRecorder* m_cache_recorder;
150    std::vector<std::map<uint32_t, AbstractController *> > m_abstract_controls;
151};
152
153class RubyStatsCallback : public Callback
154{
155  private:
156    RubySystem *m_ruby_system;
157
158  public:
159    virtual ~RubyStatsCallback() {}
160    RubyStatsCallback(RubySystem *system) : m_ruby_system(system) {}
161    void process() { m_ruby_system->collateStats(); }
162};
163
164#endif // __MEM_RUBY_SYSTEM_SYSTEM_HH__
165