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