system.hh revision 7723:ee4ac00d0774 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
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 * Authors: Steve Reinhardt
29 *          Lisa Hsu
30 *          Nathan Binkert
31 */
32
33#ifndef __SYSTEM_HH__
34#define __SYSTEM_HH__
35
36#include <string>
37#include <vector>
38
39#include "base/loader/symtab.hh"
40#include "base/misc.hh"
41#include "base/statistics.hh"
42#include "config/full_system.hh"
43#include "cpu/pc_event.hh"
44#include "enums/MemoryMode.hh"
45#include "mem/port.hh"
46#include "params/System.hh"
47#include "sim/sim_object.hh"
48
49#if FULL_SYSTEM
50#include "kern/system_events.hh"
51#endif
52
53class BaseCPU;
54class ThreadContext;
55class ObjectFile;
56class PhysicalMemory;
57
58#if FULL_SYSTEM
59class Platform;
60class FunctionalPort;
61class VirtualPort;
62#endif
63class GDBListener;
64class BaseRemoteGDB;
65
66class System : public SimObject
67{
68  public:
69
70    static const char *MemoryModeStrings[3];
71
72    Enums::MemoryMode
73    getMemoryMode()
74    {
75        assert(memoryMode);
76        return memoryMode;
77    }
78
79    /** Change the memory mode of the system. This should only be called by the
80     * python!!
81     * @param mode Mode to change to (atomic/timing)
82     */
83    void setMemoryMode(Enums::MemoryMode mode);
84
85    PhysicalMemory *physmem;
86    PCEventQueue pcEventQueue;
87
88    std::vector<ThreadContext *> threadContexts;
89    int _numContexts;
90
91    ThreadContext *getThreadContext(ThreadID tid)
92    {
93        return threadContexts[tid];
94    }
95
96    int numContexts()
97    {
98        assert(_numContexts == (int)threadContexts.size());
99        return _numContexts;
100    }
101
102    /** Return number of running (non-halted) thread contexts in
103     * system.  These threads could be Active or Suspended. */
104    int numRunningContexts();
105
106#if FULL_SYSTEM
107    Platform *platform;
108    uint64_t init_param;
109
110    /** Port to physical memory used for writing object files into ram at
111     * boot.*/
112    FunctionalPort *functionalPort;
113    VirtualPort *virtPort;
114
115    /** kernel symbol table */
116    SymbolTable *kernelSymtab;
117
118    /** Object pointer for the kernel code */
119    ObjectFile *kernel;
120
121    /** Begining of kernel code */
122    Addr kernelStart;
123
124    /** End of kernel code */
125    Addr kernelEnd;
126
127    /** Entry point in the kernel to start at */
128    Addr kernelEntry;
129
130    /** Mask that should be anded for binary/symbol loading.
131     * This allows one two different OS requirements for the same ISA to be
132     * handled.  Some OSes are compiled for a virtual address and need to be
133     * loaded into physical memory that starts at address 0, while other
134     * bare metal tools generate images that start at address 0.
135     */
136    Addr loadAddrMask;
137
138#else
139
140    int page_ptr;
141
142  protected:
143    uint64_t next_PID;
144
145  public:
146    uint64_t allocatePID()
147    {
148        return next_PID++;
149    }
150
151    /** Amount of physical memory that is still free */
152    Addr freeMemSize();
153
154    /** Amount of physical memory that exists */
155    Addr memSize();
156
157
158#endif // FULL_SYSTEM
159
160  protected:
161    Enums::MemoryMode memoryMode;
162
163#if FULL_SYSTEM
164    /**
165     * Fix up an address used to match PCs for hooking simulator
166     * events on to target function executions.  See comment in
167     * system.cc for details.
168     */
169    virtual Addr fixFuncEventAddr(Addr addr) = 0;
170
171    /**
172     * Add a function-based event to the given function, to be looked
173     * up in the specified symbol table.
174     */
175    template <class T>
176    T *addFuncEvent(SymbolTable *symtab, const char *lbl)
177    {
178        Addr addr = 0; // initialize only to avoid compiler warning
179
180        if (symtab->findAddress(lbl, addr)) {
181            T *ev = new T(&pcEventQueue, lbl, fixFuncEventAddr(addr));
182            return ev;
183        }
184
185        return NULL;
186    }
187
188    /** Add a function-based event to kernel code. */
189    template <class T>
190    T *addKernelFuncEvent(const char *lbl)
191    {
192        return addFuncEvent<T>(kernelSymtab, lbl);
193    }
194
195#endif
196  public:
197    std::vector<BaseRemoteGDB *> remoteGDB;
198    std::vector<GDBListener *> gdbListen;
199    bool breakpoint();
200
201  public:
202    typedef SystemParams Params;
203
204  protected:
205    Params *_params;
206
207  public:
208    System(Params *p);
209    ~System();
210
211    void startup();
212
213    const Params *params() const { return (const Params *)_params; }
214
215  public:
216
217#if FULL_SYSTEM
218    /**
219     * Returns the addess the kernel starts at.
220     * @return address the kernel starts at
221     */
222    Addr getKernelStart() const { return kernelStart; }
223
224    /**
225     * Returns the addess the kernel ends at.
226     * @return address the kernel ends at
227     */
228    Addr getKernelEnd() const { return kernelEnd; }
229
230    /**
231     * Returns the addess the entry point to the kernel code.
232     * @return entry point of the kernel code
233     */
234    Addr getKernelEntry() const { return kernelEntry; }
235
236#else
237
238    Addr new_page();
239
240#endif // FULL_SYSTEM
241
242    int registerThreadContext(ThreadContext *tc, int assigned=-1);
243    void replaceThreadContext(ThreadContext *tc, int context_id);
244
245    void serialize(std::ostream &os);
246    void unserialize(Checkpoint *cp, const std::string &section);
247
248  public:
249    ////////////////////////////////////////////
250    //
251    // STATIC GLOBAL SYSTEM LIST
252    //
253    ////////////////////////////////////////////
254
255    static std::vector<System *> systemList;
256    static int numSystemsRunning;
257
258    static void printSystems();
259
260
261};
262
263#endif // __SYSTEM_HH__
264