StateMachine.py (8651:c3d878fbdaea) StateMachine.py (8683:9feb100066e1)
1# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
2# Copyright (c) 2009 The Hewlett-Packard Development Company
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
28from m5.util import orderdict
29
30from slicc.symbols.Symbol import Symbol
31from slicc.symbols.Var import Var
32import slicc.generate.html as html
33import re
34
35python_class_map = {"int": "Int",
36 "std::string": "String",
37 "bool": "Bool",
38 "CacheMemory": "RubyCache",
39 "WireBuffer": "RubyWireBuffer",
40 "Sequencer": "RubySequencer",
41 "DirectoryMemory": "RubyDirectoryMemory",
42 "MemoryControl": "RubyMemoryControl",
43 "DMASequencer": "DMASequencer"
44 }
45
46class StateMachine(Symbol):
47 def __init__(self, symtab, ident, location, pairs, config_parameters):
48 super(StateMachine, self).__init__(symtab, ident, location, pairs)
49 self.table = None
50 self.config_parameters = config_parameters
51
52 for param in config_parameters:
53 if param.pointer:
54 var = Var(symtab, param.name, location, param.type_ast.type,
55 "(*m_%s_ptr)" % param.name, {}, self)
56 else:
57 var = Var(symtab, param.name, location, param.type_ast.type,
58 "m_%s" % param.name, {}, self)
59 self.symtab.registerSym(param.name, var)
60
61 self.states = orderdict()
62 self.events = orderdict()
63 self.actions = orderdict()
64 self.transitions = []
65 self.in_ports = []
66 self.functions = []
67 self.objects = []
68 self.TBEType = None
69 self.EntryType = None
70
71 self.message_buffer_names = []
72
73 def __repr__(self):
74 return "[StateMachine: %s]" % self.ident
75
76 def addState(self, state):
77 assert self.table is None
78 self.states[state.ident] = state
79
80 def addEvent(self, event):
81 assert self.table is None
82 self.events[event.ident] = event
83
84 def addAction(self, action):
85 assert self.table is None
86
87 # Check for duplicate action
88 for other in self.actions.itervalues():
89 if action.ident == other.ident:
90 action.warning("Duplicate action definition: %s" % action.ident)
91 action.error("Duplicate action definition: %s" % action.ident)
92 if action.short == other.short:
93 other.warning("Duplicate action shorthand: %s" % other.ident)
94 other.warning(" shorthand = %s" % other.short)
95 action.warning("Duplicate action shorthand: %s" % action.ident)
96 action.error(" shorthand = %s" % action.short)
97
98 self.actions[action.ident] = action
99
100 def addTransition(self, trans):
101 assert self.table is None
102 self.transitions.append(trans)
103
104 def addInPort(self, var):
105 self.in_ports.append(var)
106
107 def addFunc(self, func):
108 # register func in the symbol table
109 self.symtab.registerSym(str(func), func)
110 self.functions.append(func)
111
112 def addObject(self, obj):
113 self.objects.append(obj)
114
115 def addType(self, type):
116 type_ident = '%s' % type.c_ident
117
118 if type_ident == "%s_TBE" %self.ident:
119 if self.TBEType != None:
120 self.error("Multiple Transaction Buffer types in a " \
121 "single machine.");
122 self.TBEType = type
123
124 elif "interface" in type and "AbstractCacheEntry" == type["interface"]:
125 if self.EntryType != None:
126 self.error("Multiple AbstractCacheEntry types in a " \
127 "single machine.");
128 self.EntryType = type
129
130 # Needs to be called before accessing the table
131 def buildTable(self):
132 assert self.table is None
133
134 table = {}
135
136 for trans in self.transitions:
137 # Track which actions we touch so we know if we use them
138 # all -- really this should be done for all symbols as
139 # part of the symbol table, then only trigger it for
140 # Actions, States, Events, etc.
141
142 for action in trans.actions:
143 action.used = True
144
145 index = (trans.state, trans.event)
146 if index in table:
147 table[index].warning("Duplicate transition: %s" % table[index])
148 trans.error("Duplicate transition: %s" % trans)
149 table[index] = trans
150
151 # Look at all actions to make sure we used them all
152 for action in self.actions.itervalues():
153 if not action.used:
154 error_msg = "Unused action: %s" % action.ident
155 if "desc" in action:
156 error_msg += ", " + action.desc
157 action.warning(error_msg)
158 self.table = table
159
160 def writeCodeFiles(self, path):
161 self.printControllerPython(path)
162 self.printControllerHH(path)
163 self.printControllerCC(path)
164 self.printCSwitch(path)
165 self.printCWakeup(path)
166 self.printProfilerCC(path)
167 self.printProfilerHH(path)
168 self.printProfileDumperCC(path)
169 self.printProfileDumperHH(path)
170
171 def printControllerPython(self, path):
172 code = self.symtab.codeFormatter()
173 ident = self.ident
174 py_ident = "%s_Controller" % ident
175 c_ident = "%s_Controller" % self.ident
176 code('''
177from m5.params import *
178from m5.SimObject import SimObject
179from Controller import RubyController
180
181class $py_ident(RubyController):
182 type = '$py_ident'
183''')
184 code.indent()
185 for param in self.config_parameters:
186 dflt_str = ''
187 if param.default is not None:
188 dflt_str = str(param.default) + ', '
189 if python_class_map.has_key(param.type_ast.type.c_ident):
190 python_type = python_class_map[param.type_ast.type.c_ident]
191 code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")')
192 else:
193 self.error("Unknown c++ to python class conversion for c++ " \
194 "type: '%s'. Please update the python_class_map " \
195 "in StateMachine.py", param.type_ast.type.c_ident)
196 code.dedent()
197 code.write(path, '%s.py' % py_ident)
198
199
200 def printControllerHH(self, path):
201 '''Output the method declarations for the class declaration'''
202 code = self.symtab.codeFormatter()
203 ident = self.ident
204 c_ident = "%s_Controller" % self.ident
205
206 self.message_buffer_names = []
207
208 code('''
209/** \\file $c_ident.hh
210 *
211 * Auto generated C++ code started by $__file__:$__line__
212 * Created by slicc definition of Module "${{self.short}}"
213 */
214
215#ifndef __${ident}_CONTROLLER_HH__
216#define __${ident}_CONTROLLER_HH__
217
218#include <iostream>
219#include <sstream>
220#include <string>
221
222#include "mem/protocol/${ident}_ProfileDumper.hh"
223#include "mem/protocol/${ident}_Profiler.hh"
224#include "mem/protocol/TransitionResult.hh"
225#include "mem/protocol/Types.hh"
226#include "mem/ruby/common/Consumer.hh"
227#include "mem/ruby/common/Global.hh"
228#include "mem/ruby/slicc_interface/AbstractController.hh"
229#include "params/$c_ident.hh"
230''')
231
232 seen_types = set()
233 for var in self.objects:
234 if var.type.ident not in seen_types and not var.type.isPrimitive:
235 code('#include "mem/protocol/${{var.type.c_ident}}.hh"')
236 seen_types.add(var.type.ident)
237
238 # for adding information to the protocol debug trace
239 code('''
240extern std::stringstream ${ident}_transitionComment;
241
242class $c_ident : public AbstractController
243{
244// the coherence checker needs to call isBlockExclusive() and isBlockShared()
245// making the Chip a friend class is an easy way to do this for now
246
247public:
248 typedef ${c_ident}Params Params;
249 $c_ident(const Params *p);
250 static int getNumControllers();
251 void init();
252 MessageBuffer* getMandatoryQueue() const;
253 const int & getVersion() const;
254 const std::string toString() const;
255 const std::string getName() const;
256 void stallBuffer(MessageBuffer* buf, Address addr);
257 void wakeUpBuffers(Address addr);
258 void wakeUpAllBuffers();
259 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; }
260 void print(std::ostream& out) const;
261 void printConfig(std::ostream& out) const;
262 void wakeup();
263 void printStats(std::ostream& out) const;
264 void clearStats();
265 void blockOnQueue(Address addr, MessageBuffer* port);
266 void unblock(Address addr);
1# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
2# Copyright (c) 2009 The Hewlett-Packard Development Company
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
28from m5.util import orderdict
29
30from slicc.symbols.Symbol import Symbol
31from slicc.symbols.Var import Var
32import slicc.generate.html as html
33import re
34
35python_class_map = {"int": "Int",
36 "std::string": "String",
37 "bool": "Bool",
38 "CacheMemory": "RubyCache",
39 "WireBuffer": "RubyWireBuffer",
40 "Sequencer": "RubySequencer",
41 "DirectoryMemory": "RubyDirectoryMemory",
42 "MemoryControl": "RubyMemoryControl",
43 "DMASequencer": "DMASequencer"
44 }
45
46class StateMachine(Symbol):
47 def __init__(self, symtab, ident, location, pairs, config_parameters):
48 super(StateMachine, self).__init__(symtab, ident, location, pairs)
49 self.table = None
50 self.config_parameters = config_parameters
51
52 for param in config_parameters:
53 if param.pointer:
54 var = Var(symtab, param.name, location, param.type_ast.type,
55 "(*m_%s_ptr)" % param.name, {}, self)
56 else:
57 var = Var(symtab, param.name, location, param.type_ast.type,
58 "m_%s" % param.name, {}, self)
59 self.symtab.registerSym(param.name, var)
60
61 self.states = orderdict()
62 self.events = orderdict()
63 self.actions = orderdict()
64 self.transitions = []
65 self.in_ports = []
66 self.functions = []
67 self.objects = []
68 self.TBEType = None
69 self.EntryType = None
70
71 self.message_buffer_names = []
72
73 def __repr__(self):
74 return "[StateMachine: %s]" % self.ident
75
76 def addState(self, state):
77 assert self.table is None
78 self.states[state.ident] = state
79
80 def addEvent(self, event):
81 assert self.table is None
82 self.events[event.ident] = event
83
84 def addAction(self, action):
85 assert self.table is None
86
87 # Check for duplicate action
88 for other in self.actions.itervalues():
89 if action.ident == other.ident:
90 action.warning("Duplicate action definition: %s" % action.ident)
91 action.error("Duplicate action definition: %s" % action.ident)
92 if action.short == other.short:
93 other.warning("Duplicate action shorthand: %s" % other.ident)
94 other.warning(" shorthand = %s" % other.short)
95 action.warning("Duplicate action shorthand: %s" % action.ident)
96 action.error(" shorthand = %s" % action.short)
97
98 self.actions[action.ident] = action
99
100 def addTransition(self, trans):
101 assert self.table is None
102 self.transitions.append(trans)
103
104 def addInPort(self, var):
105 self.in_ports.append(var)
106
107 def addFunc(self, func):
108 # register func in the symbol table
109 self.symtab.registerSym(str(func), func)
110 self.functions.append(func)
111
112 def addObject(self, obj):
113 self.objects.append(obj)
114
115 def addType(self, type):
116 type_ident = '%s' % type.c_ident
117
118 if type_ident == "%s_TBE" %self.ident:
119 if self.TBEType != None:
120 self.error("Multiple Transaction Buffer types in a " \
121 "single machine.");
122 self.TBEType = type
123
124 elif "interface" in type and "AbstractCacheEntry" == type["interface"]:
125 if self.EntryType != None:
126 self.error("Multiple AbstractCacheEntry types in a " \
127 "single machine.");
128 self.EntryType = type
129
130 # Needs to be called before accessing the table
131 def buildTable(self):
132 assert self.table is None
133
134 table = {}
135
136 for trans in self.transitions:
137 # Track which actions we touch so we know if we use them
138 # all -- really this should be done for all symbols as
139 # part of the symbol table, then only trigger it for
140 # Actions, States, Events, etc.
141
142 for action in trans.actions:
143 action.used = True
144
145 index = (trans.state, trans.event)
146 if index in table:
147 table[index].warning("Duplicate transition: %s" % table[index])
148 trans.error("Duplicate transition: %s" % trans)
149 table[index] = trans
150
151 # Look at all actions to make sure we used them all
152 for action in self.actions.itervalues():
153 if not action.used:
154 error_msg = "Unused action: %s" % action.ident
155 if "desc" in action:
156 error_msg += ", " + action.desc
157 action.warning(error_msg)
158 self.table = table
159
160 def writeCodeFiles(self, path):
161 self.printControllerPython(path)
162 self.printControllerHH(path)
163 self.printControllerCC(path)
164 self.printCSwitch(path)
165 self.printCWakeup(path)
166 self.printProfilerCC(path)
167 self.printProfilerHH(path)
168 self.printProfileDumperCC(path)
169 self.printProfileDumperHH(path)
170
171 def printControllerPython(self, path):
172 code = self.symtab.codeFormatter()
173 ident = self.ident
174 py_ident = "%s_Controller" % ident
175 c_ident = "%s_Controller" % self.ident
176 code('''
177from m5.params import *
178from m5.SimObject import SimObject
179from Controller import RubyController
180
181class $py_ident(RubyController):
182 type = '$py_ident'
183''')
184 code.indent()
185 for param in self.config_parameters:
186 dflt_str = ''
187 if param.default is not None:
188 dflt_str = str(param.default) + ', '
189 if python_class_map.has_key(param.type_ast.type.c_ident):
190 python_type = python_class_map[param.type_ast.type.c_ident]
191 code('${{param.name}} = Param.${{python_type}}(${dflt_str}"")')
192 else:
193 self.error("Unknown c++ to python class conversion for c++ " \
194 "type: '%s'. Please update the python_class_map " \
195 "in StateMachine.py", param.type_ast.type.c_ident)
196 code.dedent()
197 code.write(path, '%s.py' % py_ident)
198
199
200 def printControllerHH(self, path):
201 '''Output the method declarations for the class declaration'''
202 code = self.symtab.codeFormatter()
203 ident = self.ident
204 c_ident = "%s_Controller" % self.ident
205
206 self.message_buffer_names = []
207
208 code('''
209/** \\file $c_ident.hh
210 *
211 * Auto generated C++ code started by $__file__:$__line__
212 * Created by slicc definition of Module "${{self.short}}"
213 */
214
215#ifndef __${ident}_CONTROLLER_HH__
216#define __${ident}_CONTROLLER_HH__
217
218#include <iostream>
219#include <sstream>
220#include <string>
221
222#include "mem/protocol/${ident}_ProfileDumper.hh"
223#include "mem/protocol/${ident}_Profiler.hh"
224#include "mem/protocol/TransitionResult.hh"
225#include "mem/protocol/Types.hh"
226#include "mem/ruby/common/Consumer.hh"
227#include "mem/ruby/common/Global.hh"
228#include "mem/ruby/slicc_interface/AbstractController.hh"
229#include "params/$c_ident.hh"
230''')
231
232 seen_types = set()
233 for var in self.objects:
234 if var.type.ident not in seen_types and not var.type.isPrimitive:
235 code('#include "mem/protocol/${{var.type.c_ident}}.hh"')
236 seen_types.add(var.type.ident)
237
238 # for adding information to the protocol debug trace
239 code('''
240extern std::stringstream ${ident}_transitionComment;
241
242class $c_ident : public AbstractController
243{
244// the coherence checker needs to call isBlockExclusive() and isBlockShared()
245// making the Chip a friend class is an easy way to do this for now
246
247public:
248 typedef ${c_ident}Params Params;
249 $c_ident(const Params *p);
250 static int getNumControllers();
251 void init();
252 MessageBuffer* getMandatoryQueue() const;
253 const int & getVersion() const;
254 const std::string toString() const;
255 const std::string getName() const;
256 void stallBuffer(MessageBuffer* buf, Address addr);
257 void wakeUpBuffers(Address addr);
258 void wakeUpAllBuffers();
259 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; }
260 void print(std::ostream& out) const;
261 void printConfig(std::ostream& out) const;
262 void wakeup();
263 void printStats(std::ostream& out) const;
264 void clearStats();
265 void blockOnQueue(Address addr, MessageBuffer* port);
266 void unblock(Address addr);
267 void recordCacheTrace(int cntrl, CacheRecorder* tr);
268 Sequencer* getSequencer() const;
267
268private:
269''')
270
271 code.indent()
272 # added by SS
273 for param in self.config_parameters:
274 if param.pointer:
275 code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;')
276 else:
277 code('${{param.type_ast.type}} m_${{param.ident}};')
278
279 code('''
280int m_number_of_TBEs;
281
282TransitionResult doTransition(${ident}_Event event,
283''')
284
285 if self.EntryType != None:
286 code('''
287 ${{self.EntryType.c_ident}}* m_cache_entry_ptr,
288''')
289 if self.TBEType != None:
290 code('''
291 ${{self.TBEType.c_ident}}* m_tbe_ptr,
292''')
293
294 code('''
295 const Address& addr);
296
297TransitionResult doTransitionWorker(${ident}_Event event,
298 ${ident}_State state,
299 ${ident}_State& next_state,
300''')
301
302 if self.TBEType != None:
303 code('''
304 ${{self.TBEType.c_ident}}*& m_tbe_ptr,
305''')
306 if self.EntryType != None:
307 code('''
308 ${{self.EntryType.c_ident}}*& m_cache_entry_ptr,
309''')
310
311 code('''
312 const Address& addr);
313
314std::string m_name;
315int m_transitions_per_cycle;
316int m_buffer_size;
317int m_recycle_latency;
318std::map<std::string, std::string> m_cfg;
319NodeID m_version;
320Network* m_net_ptr;
321MachineID m_machineID;
322bool m_is_blocking;
323std::map<Address, MessageBuffer*> m_block_map;
324typedef std::vector<MessageBuffer*> MsgVecType;
325typedef m5::hash_map< Address, MsgVecType* > WaitingBufType;
326WaitingBufType m_waiting_buffers;
327int m_max_in_port_rank;
328int m_cur_in_port_rank;
329static ${ident}_ProfileDumper s_profileDumper;
330${ident}_Profiler m_profiler;
331static int m_num_controllers;
332
333// Internal functions
334''')
335
336 for func in self.functions:
337 proto = func.prototype
338 if proto:
339 code('$proto')
340
341 if self.EntryType != None:
342 code('''
343
344// Set and Reset for cache_entry variable
345void set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry);
346void unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr);
347''')
348
349 if self.TBEType != None:
350 code('''
351
352// Set and Reset for tbe variable
353void set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${ident}_TBE* m_new_tbe);
354void unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr);
355''')
356
357 code('''
358
359// Actions
360''')
361 if self.TBEType != None and self.EntryType != None:
362 for action in self.actions.itervalues():
363 code('/** \\brief ${{action.desc}} */')
364 code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);')
365 elif self.TBEType != None:
366 for action in self.actions.itervalues():
367 code('/** \\brief ${{action.desc}} */')
368 code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr);')
369 elif self.EntryType != None:
370 for action in self.actions.itervalues():
371 code('/** \\brief ${{action.desc}} */')
372 code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);')
373 else:
374 for action in self.actions.itervalues():
375 code('/** \\brief ${{action.desc}} */')
376 code('void ${{action.ident}}(const Address& addr);')
377
378 # the controller internal variables
379 code('''
380
381// Objects
382''')
383 for var in self.objects:
384 th = var.get("template_hack", "")
385 code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;')
386
387 if var.type.ident == "MessageBuffer":
388 self.message_buffer_names.append("m_%s_ptr" % var.c_ident)
389
390 code.dedent()
391 code('};')
392 code('#endif // __${ident}_CONTROLLER_H__')
393 code.write(path, '%s.hh' % c_ident)
394
395 def printControllerCC(self, path):
396 '''Output the actions for performing the actions'''
397
398 code = self.symtab.codeFormatter()
399 ident = self.ident
400 c_ident = "%s_Controller" % self.ident
401
402 code('''
403/** \\file $c_ident.cc
404 *
405 * Auto generated C++ code started by $__file__:$__line__
406 * Created by slicc definition of Module "${{self.short}}"
407 */
408
409#include <cassert>
410#include <sstream>
411#include <string>
412
413#include "base/compiler.hh"
414#include "base/cprintf.hh"
415#include "debug/RubyGenerated.hh"
416#include "debug/RubySlicc.hh"
417#include "mem/protocol/${ident}_Controller.hh"
418#include "mem/protocol/${ident}_Event.hh"
419#include "mem/protocol/${ident}_State.hh"
420#include "mem/protocol/Types.hh"
421#include "mem/ruby/common/Global.hh"
422#include "mem/ruby/slicc_interface/RubySlicc_includes.hh"
423#include "mem/ruby/system/System.hh"
424
425using namespace std;
426''')
427
428 # include object classes
429 seen_types = set()
430 for var in self.objects:
431 if var.type.ident not in seen_types and not var.type.isPrimitive:
432 code('#include "mem/protocol/${{var.type.c_ident}}.hh"')
433 seen_types.add(var.type.ident)
434
435 code('''
436$c_ident *
437${c_ident}Params::create()
438{
439 return new $c_ident(this);
440}
441
442int $c_ident::m_num_controllers = 0;
443${ident}_ProfileDumper $c_ident::s_profileDumper;
444
445// for adding information to the protocol debug trace
446stringstream ${ident}_transitionComment;
447#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str)
448
449/** \\brief constructor */
450$c_ident::$c_ident(const Params *p)
451 : AbstractController(p)
452{
453 m_version = p->version;
454 m_transitions_per_cycle = p->transitions_per_cycle;
455 m_buffer_size = p->buffer_size;
456 m_recycle_latency = p->recycle_latency;
457 m_number_of_TBEs = p->number_of_TBEs;
458 m_is_blocking = false;
459 m_name = "${ident}";
460''')
461 #
462 # max_port_rank is used to size vectors and thus should be one plus the
463 # largest port rank
464 #
465 max_port_rank = self.in_ports[0].pairs["max_port_rank"] + 1
466 code(' m_max_in_port_rank = $max_port_rank;')
467 code.indent()
468
469 #
470 # After initializing the universal machine parameters, initialize the
471 # this machines config parameters. Also detemine if these configuration
472 # params include a sequencer. This information will be used later for
473 # contecting the sequencer back to the L1 cache controller.
474 #
475 contains_dma_sequencer = False
476 sequencers = []
477 for param in self.config_parameters:
478 if param.name == "dma_sequencer":
479 contains_dma_sequencer = True
480 elif re.compile("sequencer").search(param.name):
481 sequencers.append(param.name)
482 if param.pointer:
483 code('m_${{param.name}}_ptr = p->${{param.name}};')
484 else:
485 code('m_${{param.name}} = p->${{param.name}};')
486
487 #
488 # For the l1 cache controller, add the special atomic support which
489 # includes passing the sequencer a pointer to the controller.
490 #
491 if self.ident == "L1Cache":
492 if not sequencers:
493 self.error("The L1Cache controller must include the sequencer " \
494 "configuration parameter")
495
496 for seq in sequencers:
497 code('''
498m_${{seq}}_ptr->setController(this);
499 ''')
500 #
501 # For the DMA controller, pass the sequencer a pointer to the
502 # controller.
503 #
504 if self.ident == "DMA":
505 if not contains_dma_sequencer:
506 self.error("The DMA controller must include the sequencer " \
507 "configuration parameter")
508
509 code('''
510m_dma_sequencer_ptr->setController(this);
511''')
512
513 code('m_num_controllers++;')
514 for var in self.objects:
515 if var.ident.find("mandatoryQueue") >= 0:
516 code('m_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}();')
517
518 code.dedent()
519 code('''
520}
521
522void
523$c_ident::init()
524{
525 MachineType machine_type;
526 int base;
527
528 m_machineID.type = MachineType_${ident};
529 m_machineID.num = m_version;
530
531 // initialize objects
532 m_profiler.setVersion(m_version);
533 s_profileDumper.registerProfiler(&m_profiler);
534
535''')
536
537 code.indent()
538 for var in self.objects:
539 vtype = var.type
540 vid = "m_%s_ptr" % var.c_ident
541 if "network" not in var:
542 # Not a network port object
543 if "primitive" in vtype:
544 code('$vid = new ${{vtype.c_ident}};')
545 if "default" in var:
546 code('(*$vid) = ${{var["default"]}};')
547 else:
548 # Normal Object
549 # added by SS
550 if "factory" in var:
551 code('$vid = ${{var["factory"]}};')
552 elif var.ident.find("mandatoryQueue") < 0:
553 th = var.get("template_hack", "")
554 expr = "%s = new %s%s" % (vid, vtype.c_ident, th)
555
556 args = ""
557 if "non_obj" not in vtype and not vtype.isEnumeration:
558 if expr.find("TBETable") >= 0:
559 args = "m_number_of_TBEs"
560 else:
561 args = var.get("constructor_hack", "")
562
563 code('$expr($args);')
564
565 code('assert($vid != NULL);')
566
567 if "default" in var:
568 code('*$vid = ${{var["default"]}}; // Object default')
569 elif "default" in vtype:
570 comment = "Type %s default" % vtype.ident
571 code('*$vid = ${{vtype["default"]}}; // $comment')
572
573 # Set ordering
574 if "ordered" in var and "trigger_queue" not in var:
575 # A buffer
576 code('$vid->setOrdering(${{var["ordered"]}});')
577
578 # Set randomization
579 if "random" in var:
580 # A buffer
581 code('$vid->setRandomization(${{var["random"]}});')
582
583 # Set Priority
584 if vtype.isBuffer and \
585 "rank" in var and "trigger_queue" not in var:
586 code('$vid->setPriority(${{var["rank"]}});')
587
588 else:
589 # Network port object
590 network = var["network"]
591 ordered = var["ordered"]
592 vnet = var["virtual_network"]
593 vnet_type = var["vnet_type"]
594
595 assert var.machine is not None
596 code('''
597machine_type = string_to_MachineType("${{var.machine.ident}}");
598base = MachineType_base_number(machine_type);
599$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet, "$vnet_type");
600''')
601
602 code('assert($vid != NULL);')
603
604 # Set ordering
605 if "ordered" in var:
606 # A buffer
607 code('$vid->setOrdering(${{var["ordered"]}});')
608
609 # Set randomization
610 if "random" in var:
611 # A buffer
612 code('$vid->setRandomization(${{var["random"]}});')
613
614 # Set Priority
615 if "rank" in var:
616 code('$vid->setPriority(${{var["rank"]}})')
617
618 # Set buffer size
619 if vtype.isBuffer:
620 code('''
621if (m_buffer_size > 0) {
622 $vid->resize(m_buffer_size);
623}
624''')
625
626 # set description (may be overriden later by port def)
627 code('''
628$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]");
629
630''')
631
632 if vtype.isBuffer:
633 if "recycle_latency" in var:
634 code('$vid->setRecycleLatency(${{var["recycle_latency"]}});')
635 else:
636 code('$vid->setRecycleLatency(m_recycle_latency);')
637
638
639 # Set the queue consumers
640 code()
641 for port in self.in_ports:
642 code('${{port.code}}.setConsumer(this);')
643
644 # Set the queue descriptions
645 code()
646 for port in self.in_ports:
647 code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");')
648
649 # Initialize the transition profiling
650 code()
651 for trans in self.transitions:
652 # Figure out if we stall
653 stall = False
654 for action in trans.actions:
655 if action.ident == "z_stall":
656 stall = True
657
658 # Only possible if it is not a 'z' case
659 if not stall:
660 state = "%s_State_%s" % (self.ident, trans.state.ident)
661 event = "%s_Event_%s" % (self.ident, trans.event.ident)
662 code('m_profiler.possibleTransition($state, $event);')
663
664 code.dedent()
665 code('}')
666
667 has_mandatory_q = False
668 for port in self.in_ports:
669 if port.code.find("mandatoryQueue_ptr") >= 0:
670 has_mandatory_q = True
671
672 if has_mandatory_q:
673 mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident
674 else:
675 mq_ident = "NULL"
676
269
270private:
271''')
272
273 code.indent()
274 # added by SS
275 for param in self.config_parameters:
276 if param.pointer:
277 code('${{param.type_ast.type}}* m_${{param.ident}}_ptr;')
278 else:
279 code('${{param.type_ast.type}} m_${{param.ident}};')
280
281 code('''
282int m_number_of_TBEs;
283
284TransitionResult doTransition(${ident}_Event event,
285''')
286
287 if self.EntryType != None:
288 code('''
289 ${{self.EntryType.c_ident}}* m_cache_entry_ptr,
290''')
291 if self.TBEType != None:
292 code('''
293 ${{self.TBEType.c_ident}}* m_tbe_ptr,
294''')
295
296 code('''
297 const Address& addr);
298
299TransitionResult doTransitionWorker(${ident}_Event event,
300 ${ident}_State state,
301 ${ident}_State& next_state,
302''')
303
304 if self.TBEType != None:
305 code('''
306 ${{self.TBEType.c_ident}}*& m_tbe_ptr,
307''')
308 if self.EntryType != None:
309 code('''
310 ${{self.EntryType.c_ident}}*& m_cache_entry_ptr,
311''')
312
313 code('''
314 const Address& addr);
315
316std::string m_name;
317int m_transitions_per_cycle;
318int m_buffer_size;
319int m_recycle_latency;
320std::map<std::string, std::string> m_cfg;
321NodeID m_version;
322Network* m_net_ptr;
323MachineID m_machineID;
324bool m_is_blocking;
325std::map<Address, MessageBuffer*> m_block_map;
326typedef std::vector<MessageBuffer*> MsgVecType;
327typedef m5::hash_map< Address, MsgVecType* > WaitingBufType;
328WaitingBufType m_waiting_buffers;
329int m_max_in_port_rank;
330int m_cur_in_port_rank;
331static ${ident}_ProfileDumper s_profileDumper;
332${ident}_Profiler m_profiler;
333static int m_num_controllers;
334
335// Internal functions
336''')
337
338 for func in self.functions:
339 proto = func.prototype
340 if proto:
341 code('$proto')
342
343 if self.EntryType != None:
344 code('''
345
346// Set and Reset for cache_entry variable
347void set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry);
348void unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr);
349''')
350
351 if self.TBEType != None:
352 code('''
353
354// Set and Reset for tbe variable
355void set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${ident}_TBE* m_new_tbe);
356void unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr);
357''')
358
359 code('''
360
361// Actions
362''')
363 if self.TBEType != None and self.EntryType != None:
364 for action in self.actions.itervalues():
365 code('/** \\brief ${{action.desc}} */')
366 code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);')
367 elif self.TBEType != None:
368 for action in self.actions.itervalues():
369 code('/** \\brief ${{action.desc}} */')
370 code('void ${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr);')
371 elif self.EntryType != None:
372 for action in self.actions.itervalues():
373 code('/** \\brief ${{action.desc}} */')
374 code('void ${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr);')
375 else:
376 for action in self.actions.itervalues():
377 code('/** \\brief ${{action.desc}} */')
378 code('void ${{action.ident}}(const Address& addr);')
379
380 # the controller internal variables
381 code('''
382
383// Objects
384''')
385 for var in self.objects:
386 th = var.get("template_hack", "")
387 code('${{var.type.c_ident}}$th* m_${{var.c_ident}}_ptr;')
388
389 if var.type.ident == "MessageBuffer":
390 self.message_buffer_names.append("m_%s_ptr" % var.c_ident)
391
392 code.dedent()
393 code('};')
394 code('#endif // __${ident}_CONTROLLER_H__')
395 code.write(path, '%s.hh' % c_ident)
396
397 def printControllerCC(self, path):
398 '''Output the actions for performing the actions'''
399
400 code = self.symtab.codeFormatter()
401 ident = self.ident
402 c_ident = "%s_Controller" % self.ident
403
404 code('''
405/** \\file $c_ident.cc
406 *
407 * Auto generated C++ code started by $__file__:$__line__
408 * Created by slicc definition of Module "${{self.short}}"
409 */
410
411#include <cassert>
412#include <sstream>
413#include <string>
414
415#include "base/compiler.hh"
416#include "base/cprintf.hh"
417#include "debug/RubyGenerated.hh"
418#include "debug/RubySlicc.hh"
419#include "mem/protocol/${ident}_Controller.hh"
420#include "mem/protocol/${ident}_Event.hh"
421#include "mem/protocol/${ident}_State.hh"
422#include "mem/protocol/Types.hh"
423#include "mem/ruby/common/Global.hh"
424#include "mem/ruby/slicc_interface/RubySlicc_includes.hh"
425#include "mem/ruby/system/System.hh"
426
427using namespace std;
428''')
429
430 # include object classes
431 seen_types = set()
432 for var in self.objects:
433 if var.type.ident not in seen_types and not var.type.isPrimitive:
434 code('#include "mem/protocol/${{var.type.c_ident}}.hh"')
435 seen_types.add(var.type.ident)
436
437 code('''
438$c_ident *
439${c_ident}Params::create()
440{
441 return new $c_ident(this);
442}
443
444int $c_ident::m_num_controllers = 0;
445${ident}_ProfileDumper $c_ident::s_profileDumper;
446
447// for adding information to the protocol debug trace
448stringstream ${ident}_transitionComment;
449#define APPEND_TRANSITION_COMMENT(str) (${ident}_transitionComment << str)
450
451/** \\brief constructor */
452$c_ident::$c_ident(const Params *p)
453 : AbstractController(p)
454{
455 m_version = p->version;
456 m_transitions_per_cycle = p->transitions_per_cycle;
457 m_buffer_size = p->buffer_size;
458 m_recycle_latency = p->recycle_latency;
459 m_number_of_TBEs = p->number_of_TBEs;
460 m_is_blocking = false;
461 m_name = "${ident}";
462''')
463 #
464 # max_port_rank is used to size vectors and thus should be one plus the
465 # largest port rank
466 #
467 max_port_rank = self.in_ports[0].pairs["max_port_rank"] + 1
468 code(' m_max_in_port_rank = $max_port_rank;')
469 code.indent()
470
471 #
472 # After initializing the universal machine parameters, initialize the
473 # this machines config parameters. Also detemine if these configuration
474 # params include a sequencer. This information will be used later for
475 # contecting the sequencer back to the L1 cache controller.
476 #
477 contains_dma_sequencer = False
478 sequencers = []
479 for param in self.config_parameters:
480 if param.name == "dma_sequencer":
481 contains_dma_sequencer = True
482 elif re.compile("sequencer").search(param.name):
483 sequencers.append(param.name)
484 if param.pointer:
485 code('m_${{param.name}}_ptr = p->${{param.name}};')
486 else:
487 code('m_${{param.name}} = p->${{param.name}};')
488
489 #
490 # For the l1 cache controller, add the special atomic support which
491 # includes passing the sequencer a pointer to the controller.
492 #
493 if self.ident == "L1Cache":
494 if not sequencers:
495 self.error("The L1Cache controller must include the sequencer " \
496 "configuration parameter")
497
498 for seq in sequencers:
499 code('''
500m_${{seq}}_ptr->setController(this);
501 ''')
502 #
503 # For the DMA controller, pass the sequencer a pointer to the
504 # controller.
505 #
506 if self.ident == "DMA":
507 if not contains_dma_sequencer:
508 self.error("The DMA controller must include the sequencer " \
509 "configuration parameter")
510
511 code('''
512m_dma_sequencer_ptr->setController(this);
513''')
514
515 code('m_num_controllers++;')
516 for var in self.objects:
517 if var.ident.find("mandatoryQueue") >= 0:
518 code('m_${{var.c_ident}}_ptr = new ${{var.type.c_ident}}();')
519
520 code.dedent()
521 code('''
522}
523
524void
525$c_ident::init()
526{
527 MachineType machine_type;
528 int base;
529
530 m_machineID.type = MachineType_${ident};
531 m_machineID.num = m_version;
532
533 // initialize objects
534 m_profiler.setVersion(m_version);
535 s_profileDumper.registerProfiler(&m_profiler);
536
537''')
538
539 code.indent()
540 for var in self.objects:
541 vtype = var.type
542 vid = "m_%s_ptr" % var.c_ident
543 if "network" not in var:
544 # Not a network port object
545 if "primitive" in vtype:
546 code('$vid = new ${{vtype.c_ident}};')
547 if "default" in var:
548 code('(*$vid) = ${{var["default"]}};')
549 else:
550 # Normal Object
551 # added by SS
552 if "factory" in var:
553 code('$vid = ${{var["factory"]}};')
554 elif var.ident.find("mandatoryQueue") < 0:
555 th = var.get("template_hack", "")
556 expr = "%s = new %s%s" % (vid, vtype.c_ident, th)
557
558 args = ""
559 if "non_obj" not in vtype and not vtype.isEnumeration:
560 if expr.find("TBETable") >= 0:
561 args = "m_number_of_TBEs"
562 else:
563 args = var.get("constructor_hack", "")
564
565 code('$expr($args);')
566
567 code('assert($vid != NULL);')
568
569 if "default" in var:
570 code('*$vid = ${{var["default"]}}; // Object default')
571 elif "default" in vtype:
572 comment = "Type %s default" % vtype.ident
573 code('*$vid = ${{vtype["default"]}}; // $comment')
574
575 # Set ordering
576 if "ordered" in var and "trigger_queue" not in var:
577 # A buffer
578 code('$vid->setOrdering(${{var["ordered"]}});')
579
580 # Set randomization
581 if "random" in var:
582 # A buffer
583 code('$vid->setRandomization(${{var["random"]}});')
584
585 # Set Priority
586 if vtype.isBuffer and \
587 "rank" in var and "trigger_queue" not in var:
588 code('$vid->setPriority(${{var["rank"]}});')
589
590 else:
591 # Network port object
592 network = var["network"]
593 ordered = var["ordered"]
594 vnet = var["virtual_network"]
595 vnet_type = var["vnet_type"]
596
597 assert var.machine is not None
598 code('''
599machine_type = string_to_MachineType("${{var.machine.ident}}");
600base = MachineType_base_number(machine_type);
601$vid = m_net_ptr->get${network}NetQueue(m_version + base, $ordered, $vnet, "$vnet_type");
602''')
603
604 code('assert($vid != NULL);')
605
606 # Set ordering
607 if "ordered" in var:
608 # A buffer
609 code('$vid->setOrdering(${{var["ordered"]}});')
610
611 # Set randomization
612 if "random" in var:
613 # A buffer
614 code('$vid->setRandomization(${{var["random"]}});')
615
616 # Set Priority
617 if "rank" in var:
618 code('$vid->setPriority(${{var["rank"]}})')
619
620 # Set buffer size
621 if vtype.isBuffer:
622 code('''
623if (m_buffer_size > 0) {
624 $vid->resize(m_buffer_size);
625}
626''')
627
628 # set description (may be overriden later by port def)
629 code('''
630$vid->setDescription("[Version " + to_string(m_version) + ", ${ident}, name=${{var.c_ident}}]");
631
632''')
633
634 if vtype.isBuffer:
635 if "recycle_latency" in var:
636 code('$vid->setRecycleLatency(${{var["recycle_latency"]}});')
637 else:
638 code('$vid->setRecycleLatency(m_recycle_latency);')
639
640
641 # Set the queue consumers
642 code()
643 for port in self.in_ports:
644 code('${{port.code}}.setConsumer(this);')
645
646 # Set the queue descriptions
647 code()
648 for port in self.in_ports:
649 code('${{port.code}}.setDescription("[Version " + to_string(m_version) + ", $ident, $port]");')
650
651 # Initialize the transition profiling
652 code()
653 for trans in self.transitions:
654 # Figure out if we stall
655 stall = False
656 for action in trans.actions:
657 if action.ident == "z_stall":
658 stall = True
659
660 # Only possible if it is not a 'z' case
661 if not stall:
662 state = "%s_State_%s" % (self.ident, trans.state.ident)
663 event = "%s_Event_%s" % (self.ident, trans.event.ident)
664 code('m_profiler.possibleTransition($state, $event);')
665
666 code.dedent()
667 code('}')
668
669 has_mandatory_q = False
670 for port in self.in_ports:
671 if port.code.find("mandatoryQueue_ptr") >= 0:
672 has_mandatory_q = True
673
674 if has_mandatory_q:
675 mq_ident = "m_%s_mandatoryQueue_ptr" % self.ident
676 else:
677 mq_ident = "NULL"
678
679 seq_ident = "NULL"
680 for param in self.config_parameters:
681 if param.name == "sequencer":
682 assert(param.pointer)
683 seq_ident = "m_%s_ptr" % param.name
684
677 code('''
678int
679$c_ident::getNumControllers()
680{
681 return m_num_controllers;
682}
683
684MessageBuffer*
685$c_ident::getMandatoryQueue() const
686{
687 return $mq_ident;
688}
689
685 code('''
686int
687$c_ident::getNumControllers()
688{
689 return m_num_controllers;
690}
691
692MessageBuffer*
693$c_ident::getMandatoryQueue() const
694{
695 return $mq_ident;
696}
697
698Sequencer*
699$c_ident::getSequencer() const
700{
701 return $seq_ident;
702}
703
690const int &
691$c_ident::getVersion() const
692{
693 return m_version;
694}
695
696const string
697$c_ident::toString() const
698{
699 return "$c_ident";
700}
701
702const string
703$c_ident::getName() const
704{
705 return m_name;
706}
707
708void
709$c_ident::stallBuffer(MessageBuffer* buf, Address addr)
710{
711 if (m_waiting_buffers.count(addr) == 0) {
712 MsgVecType* msgVec = new MsgVecType;
713 msgVec->resize(m_max_in_port_rank, NULL);
714 m_waiting_buffers[addr] = msgVec;
715 }
716 (*(m_waiting_buffers[addr]))[m_cur_in_port_rank] = buf;
717}
718
719void
720$c_ident::wakeUpBuffers(Address addr)
721{
722 if (m_waiting_buffers.count(addr) > 0) {
723 //
724 // Wake up all possible lower rank (i.e. lower priority) buffers that could
725 // be waiting on this message.
726 //
727 for (int in_port_rank = m_cur_in_port_rank - 1;
728 in_port_rank >= 0;
729 in_port_rank--) {
730 if ((*(m_waiting_buffers[addr]))[in_port_rank] != NULL) {
731 (*(m_waiting_buffers[addr]))[in_port_rank]->reanalyzeMessages(addr);
732 }
733 }
734 delete m_waiting_buffers[addr];
735 m_waiting_buffers.erase(addr);
736 }
737}
738
739void
740$c_ident::wakeUpAllBuffers()
741{
742 //
743 // Wake up all possible buffers that could be waiting on any message.
744 //
745
746 std::vector<MsgVecType*> wokeUpMsgVecs;
747
748 if(m_waiting_buffers.size() > 0) {
749 for (WaitingBufType::iterator buf_iter = m_waiting_buffers.begin();
750 buf_iter != m_waiting_buffers.end();
751 ++buf_iter) {
752 for (MsgVecType::iterator vec_iter = buf_iter->second->begin();
753 vec_iter != buf_iter->second->end();
754 ++vec_iter) {
755 if (*vec_iter != NULL) {
756 (*vec_iter)->reanalyzeAllMessages();
757 }
758 }
759 wokeUpMsgVecs.push_back(buf_iter->second);
760 }
761
762 for (std::vector<MsgVecType*>::iterator wb_iter = wokeUpMsgVecs.begin();
763 wb_iter != wokeUpMsgVecs.end();
764 ++wb_iter) {
765 delete (*wb_iter);
766 }
767
768 m_waiting_buffers.clear();
769 }
770}
771
772void
773$c_ident::blockOnQueue(Address addr, MessageBuffer* port)
774{
775 m_is_blocking = true;
776 m_block_map[addr] = port;
777}
778
779void
780$c_ident::unblock(Address addr)
781{
782 m_block_map.erase(addr);
783 if (m_block_map.size() == 0) {
784 m_is_blocking = false;
785 }
786}
787
788void
789$c_ident::print(ostream& out) const
790{
791 out << "[$c_ident " << m_version << "]";
792}
793
794void
795$c_ident::printConfig(ostream& out) const
796{
797 out << "$c_ident config: " << m_name << endl;
798 out << " version: " << m_version << endl;
799 map<string, string>::const_iterator it;
800 for (it = m_cfg.begin(); it != m_cfg.end(); it++)
801 out << " " << it->first << ": " << it->second << endl;
802}
803
804void
805$c_ident::printStats(ostream& out) const
806{
807''')
808 #
809 # Cache and Memory Controllers have specific profilers associated with
810 # them. Print out these stats before dumping state transition stats.
811 #
812 for param in self.config_parameters:
813 if param.type_ast.type.ident == "CacheMemory" or \
814 param.type_ast.type.ident == "DirectoryMemory" or \
815 param.type_ast.type.ident == "MemoryControl":
816 assert(param.pointer)
817 code(' m_${{param.ident}}_ptr->printStats(out);')
818
819 code('''
820 if (m_version == 0) {
821 s_profileDumper.dumpStats(out);
822 }
823}
824
825void $c_ident::clearStats() {
826''')
827 #
828 # Cache and Memory Controllers have specific profilers associated with
829 # them. These stats must be cleared too.
830 #
831 for param in self.config_parameters:
832 if param.type_ast.type.ident == "CacheMemory" or \
833 param.type_ast.type.ident == "MemoryControl":
834 assert(param.pointer)
835 code(' m_${{param.ident}}_ptr->clearStats();')
836
837 code('''
838 m_profiler.clearStats();
839}
840''')
841
842 if self.EntryType != None:
843 code('''
844
845// Set and Reset for cache_entry variable
846void
847$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry)
848{
849 m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry;
850}
851
852void
853$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr)
854{
855 m_cache_entry_ptr = 0;
856}
857''')
858
859 if self.TBEType != None:
860 code('''
861
862// Set and Reset for tbe variable
863void
864$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe)
865{
866 m_tbe_ptr = m_new_tbe;
867}
868
869void
870$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr)
871{
872 m_tbe_ptr = NULL;
873}
874''')
875
876 code('''
877
704const int &
705$c_ident::getVersion() const
706{
707 return m_version;
708}
709
710const string
711$c_ident::toString() const
712{
713 return "$c_ident";
714}
715
716const string
717$c_ident::getName() const
718{
719 return m_name;
720}
721
722void
723$c_ident::stallBuffer(MessageBuffer* buf, Address addr)
724{
725 if (m_waiting_buffers.count(addr) == 0) {
726 MsgVecType* msgVec = new MsgVecType;
727 msgVec->resize(m_max_in_port_rank, NULL);
728 m_waiting_buffers[addr] = msgVec;
729 }
730 (*(m_waiting_buffers[addr]))[m_cur_in_port_rank] = buf;
731}
732
733void
734$c_ident::wakeUpBuffers(Address addr)
735{
736 if (m_waiting_buffers.count(addr) > 0) {
737 //
738 // Wake up all possible lower rank (i.e. lower priority) buffers that could
739 // be waiting on this message.
740 //
741 for (int in_port_rank = m_cur_in_port_rank - 1;
742 in_port_rank >= 0;
743 in_port_rank--) {
744 if ((*(m_waiting_buffers[addr]))[in_port_rank] != NULL) {
745 (*(m_waiting_buffers[addr]))[in_port_rank]->reanalyzeMessages(addr);
746 }
747 }
748 delete m_waiting_buffers[addr];
749 m_waiting_buffers.erase(addr);
750 }
751}
752
753void
754$c_ident::wakeUpAllBuffers()
755{
756 //
757 // Wake up all possible buffers that could be waiting on any message.
758 //
759
760 std::vector<MsgVecType*> wokeUpMsgVecs;
761
762 if(m_waiting_buffers.size() > 0) {
763 for (WaitingBufType::iterator buf_iter = m_waiting_buffers.begin();
764 buf_iter != m_waiting_buffers.end();
765 ++buf_iter) {
766 for (MsgVecType::iterator vec_iter = buf_iter->second->begin();
767 vec_iter != buf_iter->second->end();
768 ++vec_iter) {
769 if (*vec_iter != NULL) {
770 (*vec_iter)->reanalyzeAllMessages();
771 }
772 }
773 wokeUpMsgVecs.push_back(buf_iter->second);
774 }
775
776 for (std::vector<MsgVecType*>::iterator wb_iter = wokeUpMsgVecs.begin();
777 wb_iter != wokeUpMsgVecs.end();
778 ++wb_iter) {
779 delete (*wb_iter);
780 }
781
782 m_waiting_buffers.clear();
783 }
784}
785
786void
787$c_ident::blockOnQueue(Address addr, MessageBuffer* port)
788{
789 m_is_blocking = true;
790 m_block_map[addr] = port;
791}
792
793void
794$c_ident::unblock(Address addr)
795{
796 m_block_map.erase(addr);
797 if (m_block_map.size() == 0) {
798 m_is_blocking = false;
799 }
800}
801
802void
803$c_ident::print(ostream& out) const
804{
805 out << "[$c_ident " << m_version << "]";
806}
807
808void
809$c_ident::printConfig(ostream& out) const
810{
811 out << "$c_ident config: " << m_name << endl;
812 out << " version: " << m_version << endl;
813 map<string, string>::const_iterator it;
814 for (it = m_cfg.begin(); it != m_cfg.end(); it++)
815 out << " " << it->first << ": " << it->second << endl;
816}
817
818void
819$c_ident::printStats(ostream& out) const
820{
821''')
822 #
823 # Cache and Memory Controllers have specific profilers associated with
824 # them. Print out these stats before dumping state transition stats.
825 #
826 for param in self.config_parameters:
827 if param.type_ast.type.ident == "CacheMemory" or \
828 param.type_ast.type.ident == "DirectoryMemory" or \
829 param.type_ast.type.ident == "MemoryControl":
830 assert(param.pointer)
831 code(' m_${{param.ident}}_ptr->printStats(out);')
832
833 code('''
834 if (m_version == 0) {
835 s_profileDumper.dumpStats(out);
836 }
837}
838
839void $c_ident::clearStats() {
840''')
841 #
842 # Cache and Memory Controllers have specific profilers associated with
843 # them. These stats must be cleared too.
844 #
845 for param in self.config_parameters:
846 if param.type_ast.type.ident == "CacheMemory" or \
847 param.type_ast.type.ident == "MemoryControl":
848 assert(param.pointer)
849 code(' m_${{param.ident}}_ptr->clearStats();')
850
851 code('''
852 m_profiler.clearStats();
853}
854''')
855
856 if self.EntryType != None:
857 code('''
858
859// Set and Reset for cache_entry variable
860void
861$c_ident::set_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, AbstractCacheEntry* m_new_cache_entry)
862{
863 m_cache_entry_ptr = (${{self.EntryType.c_ident}}*)m_new_cache_entry;
864}
865
866void
867$c_ident::unset_cache_entry(${{self.EntryType.c_ident}}*& m_cache_entry_ptr)
868{
869 m_cache_entry_ptr = 0;
870}
871''')
872
873 if self.TBEType != None:
874 code('''
875
876// Set and Reset for tbe variable
877void
878$c_ident::set_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.TBEType.c_ident}}* m_new_tbe)
879{
880 m_tbe_ptr = m_new_tbe;
881}
882
883void
884$c_ident::unset_tbe(${{self.TBEType.c_ident}}*& m_tbe_ptr)
885{
886 m_tbe_ptr = NULL;
887}
888''')
889
890 code('''
891
892void
893$c_ident::recordCacheTrace(int cntrl, CacheRecorder* tr)
894{
895''')
896 #
897 # Record cache contents for all associated caches.
898 #
899 code.indent()
900 for param in self.config_parameters:
901 if param.type_ast.type.ident == "CacheMemory":
902 assert(param.pointer)
903 code('m_${{param.ident}}_ptr->recordCacheContents(cntrl, tr);')
904
905 code.dedent()
906 code('''
907}
908
878// Actions
879''')
880 if self.TBEType != None and self.EntryType != None:
881 for action in self.actions.itervalues():
882 if "c_code" not in action:
883 continue
884
885 code('''
886/** \\brief ${{action.desc}} */
887void
888$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr)
889{
890 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
891 ${{action["c_code"]}}
892}
893
894''')
895 elif self.TBEType != None:
896 for action in self.actions.itervalues():
897 if "c_code" not in action:
898 continue
899
900 code('''
901/** \\brief ${{action.desc}} */
902void
903$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr)
904{
905 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
906 ${{action["c_code"]}}
907}
908
909''')
910 elif self.EntryType != None:
911 for action in self.actions.itervalues():
912 if "c_code" not in action:
913 continue
914
915 code('''
916/** \\brief ${{action.desc}} */
917void
918$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr)
919{
920 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
921 ${{action["c_code"]}}
922}
923
924''')
925 else:
926 for action in self.actions.itervalues():
927 if "c_code" not in action:
928 continue
929
930 code('''
931/** \\brief ${{action.desc}} */
932void
933$c_ident::${{action.ident}}(const Address& addr)
934{
935 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
936 ${{action["c_code"]}}
937}
938
939''')
940 for func in self.functions:
941 code(func.generateCode())
942
943 code.write(path, "%s.cc" % c_ident)
944
945 def printCWakeup(self, path):
946 '''Output the wakeup loop for the events'''
947
948 code = self.symtab.codeFormatter()
949 ident = self.ident
950
951 code('''
952// Auto generated C++ code started by $__file__:$__line__
953// ${ident}: ${{self.short}}
954
955#include <cassert>
956
957#include "base/misc.hh"
958#include "debug/RubySlicc.hh"
959#include "mem/protocol/${ident}_Controller.hh"
960#include "mem/protocol/${ident}_Event.hh"
961#include "mem/protocol/${ident}_State.hh"
962#include "mem/protocol/Types.hh"
963#include "mem/ruby/common/Global.hh"
964#include "mem/ruby/slicc_interface/RubySlicc_includes.hh"
965#include "mem/ruby/system/System.hh"
966
967using namespace std;
968
969void
970${ident}_Controller::wakeup()
971{
972 int counter = 0;
973 while (true) {
974 // Some cases will put us into an infinite loop without this limit
975 assert(counter <= m_transitions_per_cycle);
976 if (counter == m_transitions_per_cycle) {
977 // Count how often we are fully utilized
978 g_system_ptr->getProfiler()->controllerBusy(m_machineID);
979
980 // Wakeup in another cycle and try again
981 g_eventQueue_ptr->scheduleEvent(this, 1);
982 break;
983 }
984''')
985
986 code.indent()
987 code.indent()
988
989 # InPorts
990 #
991 for port in self.in_ports:
992 code.indent()
993 code('// ${ident}InPort $port')
994 if port.pairs.has_key("rank"):
995 code('m_cur_in_port_rank = ${{port.pairs["rank"]}};')
996 else:
997 code('m_cur_in_port_rank = 0;')
998 code('${{port["c_code_in_port"]}}')
999 code.dedent()
1000
1001 code('')
1002
1003 code.dedent()
1004 code.dedent()
1005 code('''
1006 break; // If we got this far, we have nothing left todo
1007 }
1008 // g_eventQueue_ptr->scheduleEvent(this, 1);
1009}
1010''')
1011
1012 code.write(path, "%s_Wakeup.cc" % self.ident)
1013
1014 def printCSwitch(self, path):
1015 '''Output switch statement for transition table'''
1016
1017 code = self.symtab.codeFormatter()
1018 ident = self.ident
1019
1020 code('''
1021// Auto generated C++ code started by $__file__:$__line__
1022// ${ident}: ${{self.short}}
1023
1024#include <cassert>
1025
1026#include "base/misc.hh"
1027#include "base/trace.hh"
1028#include "debug/ProtocolTrace.hh"
1029#include "debug/RubyGenerated.hh"
1030#include "mem/protocol/${ident}_Controller.hh"
1031#include "mem/protocol/${ident}_Event.hh"
1032#include "mem/protocol/${ident}_State.hh"
1033#include "mem/protocol/Types.hh"
1034#include "mem/ruby/common/Global.hh"
1035#include "mem/ruby/system/System.hh"
1036
1037#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event))
1038
1039#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str())
1040#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str(""))
1041
1042TransitionResult
1043${ident}_Controller::doTransition(${ident}_Event event,
1044''')
1045 if self.EntryType != None:
1046 code('''
1047 ${{self.EntryType.c_ident}}* m_cache_entry_ptr,
1048''')
1049 if self.TBEType != None:
1050 code('''
1051 ${{self.TBEType.c_ident}}* m_tbe_ptr,
1052''')
1053 code('''
1054 const Address &addr)
1055{
1056''')
1057 if self.TBEType != None and self.EntryType != None:
1058 code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);')
1059 elif self.TBEType != None:
1060 code('${ident}_State state = getState(m_tbe_ptr, addr);')
1061 elif self.EntryType != None:
1062 code('${ident}_State state = getState(m_cache_entry_ptr, addr);')
1063 else:
1064 code('${ident}_State state = getState(addr);')
1065
1066 code('''
1067 ${ident}_State next_state = state;
1068
1069 DPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n",
1070 *this,
1071 g_eventQueue_ptr->getTime(),
1072 ${ident}_State_to_string(state),
1073 ${ident}_Event_to_string(event),
1074 addr);
1075
1076 TransitionResult result =
1077''')
1078 if self.TBEType != None and self.EntryType != None:
1079 code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);')
1080 elif self.TBEType != None:
1081 code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);')
1082 elif self.EntryType != None:
1083 code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);')
1084 else:
1085 code('doTransitionWorker(event, state, next_state, addr);')
1086
1087 code('''
1088 if (result == TransitionResult_Valid) {
1089 DPRINTF(RubyGenerated, "next_state: %s\\n",
1090 ${ident}_State_to_string(next_state));
1091 m_profiler.countTransition(state, event);
1092 DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n",
1093 curTick(), m_version, "${ident}",
1094 ${ident}_Event_to_string(event),
1095 ${ident}_State_to_string(state),
1096 ${ident}_State_to_string(next_state),
1097 addr, GET_TRANSITION_COMMENT());
1098
1099 CLEAR_TRANSITION_COMMENT();
1100''')
1101 if self.TBEType != None and self.EntryType != None:
1102 code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);')
1103 code('setAccessPermission(m_cache_entry_ptr, addr, next_state);')
1104 elif self.TBEType != None:
1105 code('setState(m_tbe_ptr, addr, next_state);')
1106 code('setAccessPermission(addr, next_state);')
1107 elif self.EntryType != None:
1108 code('setState(m_cache_entry_ptr, addr, next_state);')
1109 code('setAccessPermission(m_cache_entry_ptr, addr, next_state);')
1110 else:
1111 code('setState(addr, next_state);')
1112 code('setAccessPermission(addr, next_state);')
1113
1114 code('''
1115 } else if (result == TransitionResult_ResourceStall) {
1116 DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n",
1117 curTick(), m_version, "${ident}",
1118 ${ident}_Event_to_string(event),
1119 ${ident}_State_to_string(state),
1120 ${ident}_State_to_string(next_state),
1121 addr, "Resource Stall");
1122 } else if (result == TransitionResult_ProtocolStall) {
1123 DPRINTF(RubyGenerated, "stalling\\n");
1124 DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n",
1125 curTick(), m_version, "${ident}",
1126 ${ident}_Event_to_string(event),
1127 ${ident}_State_to_string(state),
1128 ${ident}_State_to_string(next_state),
1129 addr, "Protocol Stall");
1130 }
1131
1132 return result;
1133}
1134
1135TransitionResult
1136${ident}_Controller::doTransitionWorker(${ident}_Event event,
1137 ${ident}_State state,
1138 ${ident}_State& next_state,
1139''')
1140
1141 if self.TBEType != None:
1142 code('''
1143 ${{self.TBEType.c_ident}}*& m_tbe_ptr,
1144''')
1145 if self.EntryType != None:
1146 code('''
1147 ${{self.EntryType.c_ident}}*& m_cache_entry_ptr,
1148''')
1149 code('''
1150 const Address& addr)
1151{
1152 switch(HASH_FUN(state, event)) {
1153''')
1154
1155 # This map will allow suppress generating duplicate code
1156 cases = orderdict()
1157
1158 for trans in self.transitions:
1159 case_string = "%s_State_%s, %s_Event_%s" % \
1160 (self.ident, trans.state.ident, self.ident, trans.event.ident)
1161
1162 case = self.symtab.codeFormatter()
1163 # Only set next_state if it changes
1164 if trans.state != trans.nextState:
1165 ns_ident = trans.nextState.ident
1166 case('next_state = ${ident}_State_${ns_ident};')
1167
1168 actions = trans.actions
1169
1170 # Check for resources
1171 case_sorter = []
1172 res = trans.resources
1173 for key,val in res.iteritems():
1174 if key.type.ident != "DNUCAStopTable":
1175 val = '''
1176if (!%s.areNSlotsAvailable(%s))
1177 return TransitionResult_ResourceStall;
1178''' % (key.code, val)
1179 case_sorter.append(val)
1180
1181
1182 # Emit the code sequences in a sorted order. This makes the
1183 # output deterministic (without this the output order can vary
1184 # since Map's keys() on a vector of pointers is not deterministic
1185 for c in sorted(case_sorter):
1186 case("$c")
1187
1188 # Figure out if we stall
1189 stall = False
1190 for action in actions:
1191 if action.ident == "z_stall":
1192 stall = True
1193 break
1194
1195 if stall:
1196 case('return TransitionResult_ProtocolStall;')
1197 else:
1198 if self.TBEType != None and self.EntryType != None:
1199 for action in actions:
1200 case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);')
1201 elif self.TBEType != None:
1202 for action in actions:
1203 case('${{action.ident}}(m_tbe_ptr, addr);')
1204 elif self.EntryType != None:
1205 for action in actions:
1206 case('${{action.ident}}(m_cache_entry_ptr, addr);')
1207 else:
1208 for action in actions:
1209 case('${{action.ident}}(addr);')
1210 case('return TransitionResult_Valid;')
1211
1212 case = str(case)
1213
1214 # Look to see if this transition code is unique.
1215 if case not in cases:
1216 cases[case] = []
1217
1218 cases[case].append(case_string)
1219
1220 # Walk through all of the unique code blocks and spit out the
1221 # corresponding case statement elements
1222 for case,transitions in cases.iteritems():
1223 # Iterative over all the multiple transitions that share
1224 # the same code
1225 for trans in transitions:
1226 code(' case HASH_FUN($trans):')
1227 code(' $case')
1228
1229 code('''
1230 default:
1231 fatal("Invalid transition\\n"
1232 "%s time: %d addr: %s event: %s state: %s\\n",
1233 name(), g_eventQueue_ptr->getTime(), addr, event, state);
1234 }
1235 return TransitionResult_Valid;
1236}
1237''')
1238 code.write(path, "%s_Transitions.cc" % self.ident)
1239
1240 def printProfileDumperHH(self, path):
1241 code = self.symtab.codeFormatter()
1242 ident = self.ident
1243
1244 code('''
1245// Auto generated C++ code started by $__file__:$__line__
1246// ${ident}: ${{self.short}}
1247
1248#ifndef __${ident}_PROFILE_DUMPER_HH__
1249#define __${ident}_PROFILE_DUMPER_HH__
1250
1251#include <cassert>
1252#include <iostream>
1253#include <vector>
1254
1255#include "${ident}_Event.hh"
1256#include "${ident}_Profiler.hh"
1257
1258typedef std::vector<${ident}_Profiler *> ${ident}_profilers;
1259
1260class ${ident}_ProfileDumper
1261{
1262 public:
1263 ${ident}_ProfileDumper();
1264 void registerProfiler(${ident}_Profiler* profiler);
1265 void dumpStats(std::ostream& out) const;
1266
1267 private:
1268 ${ident}_profilers m_profilers;
1269};
1270
1271#endif // __${ident}_PROFILE_DUMPER_HH__
1272''')
1273 code.write(path, "%s_ProfileDumper.hh" % self.ident)
1274
1275 def printProfileDumperCC(self, path):
1276 code = self.symtab.codeFormatter()
1277 ident = self.ident
1278
1279 code('''
1280// Auto generated C++ code started by $__file__:$__line__
1281// ${ident}: ${{self.short}}
1282
1283#include "mem/protocol/${ident}_ProfileDumper.hh"
1284
1285${ident}_ProfileDumper::${ident}_ProfileDumper()
1286{
1287}
1288
1289void
1290${ident}_ProfileDumper::registerProfiler(${ident}_Profiler* profiler)
1291{
1292 m_profilers.push_back(profiler);
1293}
1294
1295void
1296${ident}_ProfileDumper::dumpStats(std::ostream& out) const
1297{
1298 out << " --- ${ident} ---\\n";
1299 out << " - Event Counts -\\n";
1300 for (${ident}_Event event = ${ident}_Event_FIRST;
1301 event < ${ident}_Event_NUM;
1302 ++event) {
1303 out << (${ident}_Event) event << " [";
1304 uint64 total = 0;
1305 for (int i = 0; i < m_profilers.size(); i++) {
1306 out << m_profilers[i]->getEventCount(event) << " ";
1307 total += m_profilers[i]->getEventCount(event);
1308 }
1309 out << "] " << total << "\\n";
1310 }
1311 out << "\\n";
1312 out << " - Transitions -\\n";
1313 for (${ident}_State state = ${ident}_State_FIRST;
1314 state < ${ident}_State_NUM;
1315 ++state) {
1316 for (${ident}_Event event = ${ident}_Event_FIRST;
1317 event < ${ident}_Event_NUM;
1318 ++event) {
1319 if (m_profilers[0]->isPossible(state, event)) {
1320 out << (${ident}_State) state << " "
1321 << (${ident}_Event) event << " [";
1322 uint64 total = 0;
1323 for (int i = 0; i < m_profilers.size(); i++) {
1324 out << m_profilers[i]->getTransitionCount(state, event) << " ";
1325 total += m_profilers[i]->getTransitionCount(state, event);
1326 }
1327 out << "] " << total << "\\n";
1328 }
1329 }
1330 out << "\\n";
1331 }
1332}
1333''')
1334 code.write(path, "%s_ProfileDumper.cc" % self.ident)
1335
1336 def printProfilerHH(self, path):
1337 code = self.symtab.codeFormatter()
1338 ident = self.ident
1339
1340 code('''
1341// Auto generated C++ code started by $__file__:$__line__
1342// ${ident}: ${{self.short}}
1343
1344#ifndef __${ident}_PROFILER_HH__
1345#define __${ident}_PROFILER_HH__
1346
1347#include <cassert>
1348#include <iostream>
1349
1350#include "mem/protocol/${ident}_Event.hh"
1351#include "mem/protocol/${ident}_State.hh"
1352#include "mem/ruby/common/TypeDefines.hh"
1353
1354class ${ident}_Profiler
1355{
1356 public:
1357 ${ident}_Profiler();
1358 void setVersion(int version);
1359 void countTransition(${ident}_State state, ${ident}_Event event);
1360 void possibleTransition(${ident}_State state, ${ident}_Event event);
1361 uint64 getEventCount(${ident}_Event event);
1362 bool isPossible(${ident}_State state, ${ident}_Event event);
1363 uint64 getTransitionCount(${ident}_State state, ${ident}_Event event);
1364 void clearStats();
1365
1366 private:
1367 int m_counters[${ident}_State_NUM][${ident}_Event_NUM];
1368 int m_event_counters[${ident}_Event_NUM];
1369 bool m_possible[${ident}_State_NUM][${ident}_Event_NUM];
1370 int m_version;
1371};
1372
1373#endif // __${ident}_PROFILER_HH__
1374''')
1375 code.write(path, "%s_Profiler.hh" % self.ident)
1376
1377 def printProfilerCC(self, path):
1378 code = self.symtab.codeFormatter()
1379 ident = self.ident
1380
1381 code('''
1382// Auto generated C++ code started by $__file__:$__line__
1383// ${ident}: ${{self.short}}
1384
1385#include <cassert>
1386
1387#include "mem/protocol/${ident}_Profiler.hh"
1388
1389${ident}_Profiler::${ident}_Profiler()
1390{
1391 for (int state = 0; state < ${ident}_State_NUM; state++) {
1392 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1393 m_possible[state][event] = false;
1394 m_counters[state][event] = 0;
1395 }
1396 }
1397 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1398 m_event_counters[event] = 0;
1399 }
1400}
1401
1402void
1403${ident}_Profiler::setVersion(int version)
1404{
1405 m_version = version;
1406}
1407
1408void
1409${ident}_Profiler::clearStats()
1410{
1411 for (int state = 0; state < ${ident}_State_NUM; state++) {
1412 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1413 m_counters[state][event] = 0;
1414 }
1415 }
1416
1417 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1418 m_event_counters[event] = 0;
1419 }
1420}
1421void
1422${ident}_Profiler::countTransition(${ident}_State state, ${ident}_Event event)
1423{
1424 assert(m_possible[state][event]);
1425 m_counters[state][event]++;
1426 m_event_counters[event]++;
1427}
1428void
1429${ident}_Profiler::possibleTransition(${ident}_State state,
1430 ${ident}_Event event)
1431{
1432 m_possible[state][event] = true;
1433}
1434
1435uint64
1436${ident}_Profiler::getEventCount(${ident}_Event event)
1437{
1438 return m_event_counters[event];
1439}
1440
1441bool
1442${ident}_Profiler::isPossible(${ident}_State state, ${ident}_Event event)
1443{
1444 return m_possible[state][event];
1445}
1446
1447uint64
1448${ident}_Profiler::getTransitionCount(${ident}_State state,
1449 ${ident}_Event event)
1450{
1451 return m_counters[state][event];
1452}
1453
1454''')
1455 code.write(path, "%s_Profiler.cc" % self.ident)
1456
1457 # **************************
1458 # ******* HTML Files *******
1459 # **************************
1460 def frameRef(self, click_href, click_target, over_href, over_num, text):
1461 code = self.symtab.codeFormatter(fix_newlines=False)
1462 code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\"
1463 if (parent.frames[$over_num].location != parent.location + '$over_href') {
1464 parent.frames[$over_num].location='$over_href'
1465 }\">
1466 ${{html.formatShorthand(text)}}
1467 </A>""")
1468 return str(code)
1469
1470 def writeHTMLFiles(self, path):
1471 # Create table with no row hilighted
1472 self.printHTMLTransitions(path, None)
1473
1474 # Generate transition tables
1475 for state in self.states.itervalues():
1476 self.printHTMLTransitions(path, state)
1477
1478 # Generate action descriptions
1479 for action in self.actions.itervalues():
1480 name = "%s_action_%s.html" % (self.ident, action.ident)
1481 code = html.createSymbol(action, "Action")
1482 code.write(path, name)
1483
1484 # Generate state descriptions
1485 for state in self.states.itervalues():
1486 name = "%s_State_%s.html" % (self.ident, state.ident)
1487 code = html.createSymbol(state, "State")
1488 code.write(path, name)
1489
1490 # Generate event descriptions
1491 for event in self.events.itervalues():
1492 name = "%s_Event_%s.html" % (self.ident, event.ident)
1493 code = html.createSymbol(event, "Event")
1494 code.write(path, name)
1495
1496 def printHTMLTransitions(self, path, active_state):
1497 code = self.symtab.codeFormatter()
1498
1499 code('''
1500<HTML>
1501<BODY link="blue" vlink="blue">
1502
1503<H1 align="center">${{html.formatShorthand(self.short)}}:
1504''')
1505 code.indent()
1506 for i,machine in enumerate(self.symtab.getAllType(StateMachine)):
1507 mid = machine.ident
1508 if i != 0:
1509 extra = " - "
1510 else:
1511 extra = ""
1512 if machine == self:
1513 code('$extra$mid')
1514 else:
1515 code('$extra<A target="Table" href="${mid}_table.html">$mid</A>')
1516 code.dedent()
1517
1518 code("""
1519</H1>
1520
1521<TABLE border=1>
1522<TR>
1523 <TH> </TH>
1524""")
1525
1526 for event in self.events.itervalues():
1527 href = "%s_Event_%s.html" % (self.ident, event.ident)
1528 ref = self.frameRef(href, "Status", href, "1", event.short)
1529 code('<TH bgcolor=white>$ref</TH>')
1530
1531 code('</TR>')
1532 # -- Body of table
1533 for state in self.states.itervalues():
1534 # -- Each row
1535 if state == active_state:
1536 color = "yellow"
1537 else:
1538 color = "white"
1539
1540 click = "%s_table_%s.html" % (self.ident, state.ident)
1541 over = "%s_State_%s.html" % (self.ident, state.ident)
1542 text = html.formatShorthand(state.short)
1543 ref = self.frameRef(click, "Table", over, "1", state.short)
1544 code('''
1545<TR>
1546 <TH bgcolor=$color>$ref</TH>
1547''')
1548
1549 # -- One column for each event
1550 for event in self.events.itervalues():
1551 trans = self.table.get((state,event), None)
1552 if trans is None:
1553 # This is the no transition case
1554 if state == active_state:
1555 color = "#C0C000"
1556 else:
1557 color = "lightgrey"
1558
1559 code('<TD bgcolor=$color>&nbsp;</TD>')
1560 continue
1561
1562 next = trans.nextState
1563 stall_action = False
1564
1565 # -- Get the actions
1566 for action in trans.actions:
1567 if action.ident == "z_stall" or \
1568 action.ident == "zz_recycleMandatoryQueue":
1569 stall_action = True
1570
1571 # -- Print out "actions/next-state"
1572 if stall_action:
1573 if state == active_state:
1574 color = "#C0C000"
1575 else:
1576 color = "lightgrey"
1577
1578 elif active_state and next.ident == active_state.ident:
1579 color = "aqua"
1580 elif state == active_state:
1581 color = "yellow"
1582 else:
1583 color = "white"
1584
1585 code('<TD bgcolor=$color>')
1586 for action in trans.actions:
1587 href = "%s_action_%s.html" % (self.ident, action.ident)
1588 ref = self.frameRef(href, "Status", href, "1",
1589 action.short)
1590 code(' $ref')
1591 if next != state:
1592 if trans.actions:
1593 code('/')
1594 click = "%s_table_%s.html" % (self.ident, next.ident)
1595 over = "%s_State_%s.html" % (self.ident, next.ident)
1596 ref = self.frameRef(click, "Table", over, "1", next.short)
1597 code("$ref")
1598 code("</TD>")
1599
1600 # -- Each row
1601 if state == active_state:
1602 color = "yellow"
1603 else:
1604 color = "white"
1605
1606 click = "%s_table_%s.html" % (self.ident, state.ident)
1607 over = "%s_State_%s.html" % (self.ident, state.ident)
1608 ref = self.frameRef(click, "Table", over, "1", state.short)
1609 code('''
1610 <TH bgcolor=$color>$ref</TH>
1611</TR>
1612''')
1613 code('''
1614<!- Column footer->
1615<TR>
1616 <TH> </TH>
1617''')
1618
1619 for event in self.events.itervalues():
1620 href = "%s_Event_%s.html" % (self.ident, event.ident)
1621 ref = self.frameRef(href, "Status", href, "1", event.short)
1622 code('<TH bgcolor=white>$ref</TH>')
1623 code('''
1624</TR>
1625</TABLE>
1626</BODY></HTML>
1627''')
1628
1629
1630 if active_state:
1631 name = "%s_table_%s.html" % (self.ident, active_state.ident)
1632 else:
1633 name = "%s_table.html" % self.ident
1634 code.write(path, name)
1635
1636__all__ = [ "StateMachine" ]
909// Actions
910''')
911 if self.TBEType != None and self.EntryType != None:
912 for action in self.actions.itervalues():
913 if "c_code" not in action:
914 continue
915
916 code('''
917/** \\brief ${{action.desc}} */
918void
919$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, ${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr)
920{
921 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
922 ${{action["c_code"]}}
923}
924
925''')
926 elif self.TBEType != None:
927 for action in self.actions.itervalues():
928 if "c_code" not in action:
929 continue
930
931 code('''
932/** \\brief ${{action.desc}} */
933void
934$c_ident::${{action.ident}}(${{self.TBEType.c_ident}}*& m_tbe_ptr, const Address& addr)
935{
936 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
937 ${{action["c_code"]}}
938}
939
940''')
941 elif self.EntryType != None:
942 for action in self.actions.itervalues():
943 if "c_code" not in action:
944 continue
945
946 code('''
947/** \\brief ${{action.desc}} */
948void
949$c_ident::${{action.ident}}(${{self.EntryType.c_ident}}*& m_cache_entry_ptr, const Address& addr)
950{
951 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
952 ${{action["c_code"]}}
953}
954
955''')
956 else:
957 for action in self.actions.itervalues():
958 if "c_code" not in action:
959 continue
960
961 code('''
962/** \\brief ${{action.desc}} */
963void
964$c_ident::${{action.ident}}(const Address& addr)
965{
966 DPRINTF(RubyGenerated, "executing ${{action.ident}}\\n");
967 ${{action["c_code"]}}
968}
969
970''')
971 for func in self.functions:
972 code(func.generateCode())
973
974 code.write(path, "%s.cc" % c_ident)
975
976 def printCWakeup(self, path):
977 '''Output the wakeup loop for the events'''
978
979 code = self.symtab.codeFormatter()
980 ident = self.ident
981
982 code('''
983// Auto generated C++ code started by $__file__:$__line__
984// ${ident}: ${{self.short}}
985
986#include <cassert>
987
988#include "base/misc.hh"
989#include "debug/RubySlicc.hh"
990#include "mem/protocol/${ident}_Controller.hh"
991#include "mem/protocol/${ident}_Event.hh"
992#include "mem/protocol/${ident}_State.hh"
993#include "mem/protocol/Types.hh"
994#include "mem/ruby/common/Global.hh"
995#include "mem/ruby/slicc_interface/RubySlicc_includes.hh"
996#include "mem/ruby/system/System.hh"
997
998using namespace std;
999
1000void
1001${ident}_Controller::wakeup()
1002{
1003 int counter = 0;
1004 while (true) {
1005 // Some cases will put us into an infinite loop without this limit
1006 assert(counter <= m_transitions_per_cycle);
1007 if (counter == m_transitions_per_cycle) {
1008 // Count how often we are fully utilized
1009 g_system_ptr->getProfiler()->controllerBusy(m_machineID);
1010
1011 // Wakeup in another cycle and try again
1012 g_eventQueue_ptr->scheduleEvent(this, 1);
1013 break;
1014 }
1015''')
1016
1017 code.indent()
1018 code.indent()
1019
1020 # InPorts
1021 #
1022 for port in self.in_ports:
1023 code.indent()
1024 code('// ${ident}InPort $port')
1025 if port.pairs.has_key("rank"):
1026 code('m_cur_in_port_rank = ${{port.pairs["rank"]}};')
1027 else:
1028 code('m_cur_in_port_rank = 0;')
1029 code('${{port["c_code_in_port"]}}')
1030 code.dedent()
1031
1032 code('')
1033
1034 code.dedent()
1035 code.dedent()
1036 code('''
1037 break; // If we got this far, we have nothing left todo
1038 }
1039 // g_eventQueue_ptr->scheduleEvent(this, 1);
1040}
1041''')
1042
1043 code.write(path, "%s_Wakeup.cc" % self.ident)
1044
1045 def printCSwitch(self, path):
1046 '''Output switch statement for transition table'''
1047
1048 code = self.symtab.codeFormatter()
1049 ident = self.ident
1050
1051 code('''
1052// Auto generated C++ code started by $__file__:$__line__
1053// ${ident}: ${{self.short}}
1054
1055#include <cassert>
1056
1057#include "base/misc.hh"
1058#include "base/trace.hh"
1059#include "debug/ProtocolTrace.hh"
1060#include "debug/RubyGenerated.hh"
1061#include "mem/protocol/${ident}_Controller.hh"
1062#include "mem/protocol/${ident}_Event.hh"
1063#include "mem/protocol/${ident}_State.hh"
1064#include "mem/protocol/Types.hh"
1065#include "mem/ruby/common/Global.hh"
1066#include "mem/ruby/system/System.hh"
1067
1068#define HASH_FUN(state, event) ((int(state)*${ident}_Event_NUM)+int(event))
1069
1070#define GET_TRANSITION_COMMENT() (${ident}_transitionComment.str())
1071#define CLEAR_TRANSITION_COMMENT() (${ident}_transitionComment.str(""))
1072
1073TransitionResult
1074${ident}_Controller::doTransition(${ident}_Event event,
1075''')
1076 if self.EntryType != None:
1077 code('''
1078 ${{self.EntryType.c_ident}}* m_cache_entry_ptr,
1079''')
1080 if self.TBEType != None:
1081 code('''
1082 ${{self.TBEType.c_ident}}* m_tbe_ptr,
1083''')
1084 code('''
1085 const Address &addr)
1086{
1087''')
1088 if self.TBEType != None and self.EntryType != None:
1089 code('${ident}_State state = getState(m_tbe_ptr, m_cache_entry_ptr, addr);')
1090 elif self.TBEType != None:
1091 code('${ident}_State state = getState(m_tbe_ptr, addr);')
1092 elif self.EntryType != None:
1093 code('${ident}_State state = getState(m_cache_entry_ptr, addr);')
1094 else:
1095 code('${ident}_State state = getState(addr);')
1096
1097 code('''
1098 ${ident}_State next_state = state;
1099
1100 DPRINTF(RubyGenerated, "%s, Time: %lld, state: %s, event: %s, addr: %s\\n",
1101 *this,
1102 g_eventQueue_ptr->getTime(),
1103 ${ident}_State_to_string(state),
1104 ${ident}_Event_to_string(event),
1105 addr);
1106
1107 TransitionResult result =
1108''')
1109 if self.TBEType != None and self.EntryType != None:
1110 code('doTransitionWorker(event, state, next_state, m_tbe_ptr, m_cache_entry_ptr, addr);')
1111 elif self.TBEType != None:
1112 code('doTransitionWorker(event, state, next_state, m_tbe_ptr, addr);')
1113 elif self.EntryType != None:
1114 code('doTransitionWorker(event, state, next_state, m_cache_entry_ptr, addr);')
1115 else:
1116 code('doTransitionWorker(event, state, next_state, addr);')
1117
1118 code('''
1119 if (result == TransitionResult_Valid) {
1120 DPRINTF(RubyGenerated, "next_state: %s\\n",
1121 ${ident}_State_to_string(next_state));
1122 m_profiler.countTransition(state, event);
1123 DPRINTFR(ProtocolTrace, "%15d %3s %10s%20s %6s>%-6s %s %s\\n",
1124 curTick(), m_version, "${ident}",
1125 ${ident}_Event_to_string(event),
1126 ${ident}_State_to_string(state),
1127 ${ident}_State_to_string(next_state),
1128 addr, GET_TRANSITION_COMMENT());
1129
1130 CLEAR_TRANSITION_COMMENT();
1131''')
1132 if self.TBEType != None and self.EntryType != None:
1133 code('setState(m_tbe_ptr, m_cache_entry_ptr, addr, next_state);')
1134 code('setAccessPermission(m_cache_entry_ptr, addr, next_state);')
1135 elif self.TBEType != None:
1136 code('setState(m_tbe_ptr, addr, next_state);')
1137 code('setAccessPermission(addr, next_state);')
1138 elif self.EntryType != None:
1139 code('setState(m_cache_entry_ptr, addr, next_state);')
1140 code('setAccessPermission(m_cache_entry_ptr, addr, next_state);')
1141 else:
1142 code('setState(addr, next_state);')
1143 code('setAccessPermission(addr, next_state);')
1144
1145 code('''
1146 } else if (result == TransitionResult_ResourceStall) {
1147 DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n",
1148 curTick(), m_version, "${ident}",
1149 ${ident}_Event_to_string(event),
1150 ${ident}_State_to_string(state),
1151 ${ident}_State_to_string(next_state),
1152 addr, "Resource Stall");
1153 } else if (result == TransitionResult_ProtocolStall) {
1154 DPRINTF(RubyGenerated, "stalling\\n");
1155 DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\\n",
1156 curTick(), m_version, "${ident}",
1157 ${ident}_Event_to_string(event),
1158 ${ident}_State_to_string(state),
1159 ${ident}_State_to_string(next_state),
1160 addr, "Protocol Stall");
1161 }
1162
1163 return result;
1164}
1165
1166TransitionResult
1167${ident}_Controller::doTransitionWorker(${ident}_Event event,
1168 ${ident}_State state,
1169 ${ident}_State& next_state,
1170''')
1171
1172 if self.TBEType != None:
1173 code('''
1174 ${{self.TBEType.c_ident}}*& m_tbe_ptr,
1175''')
1176 if self.EntryType != None:
1177 code('''
1178 ${{self.EntryType.c_ident}}*& m_cache_entry_ptr,
1179''')
1180 code('''
1181 const Address& addr)
1182{
1183 switch(HASH_FUN(state, event)) {
1184''')
1185
1186 # This map will allow suppress generating duplicate code
1187 cases = orderdict()
1188
1189 for trans in self.transitions:
1190 case_string = "%s_State_%s, %s_Event_%s" % \
1191 (self.ident, trans.state.ident, self.ident, trans.event.ident)
1192
1193 case = self.symtab.codeFormatter()
1194 # Only set next_state if it changes
1195 if trans.state != trans.nextState:
1196 ns_ident = trans.nextState.ident
1197 case('next_state = ${ident}_State_${ns_ident};')
1198
1199 actions = trans.actions
1200
1201 # Check for resources
1202 case_sorter = []
1203 res = trans.resources
1204 for key,val in res.iteritems():
1205 if key.type.ident != "DNUCAStopTable":
1206 val = '''
1207if (!%s.areNSlotsAvailable(%s))
1208 return TransitionResult_ResourceStall;
1209''' % (key.code, val)
1210 case_sorter.append(val)
1211
1212
1213 # Emit the code sequences in a sorted order. This makes the
1214 # output deterministic (without this the output order can vary
1215 # since Map's keys() on a vector of pointers is not deterministic
1216 for c in sorted(case_sorter):
1217 case("$c")
1218
1219 # Figure out if we stall
1220 stall = False
1221 for action in actions:
1222 if action.ident == "z_stall":
1223 stall = True
1224 break
1225
1226 if stall:
1227 case('return TransitionResult_ProtocolStall;')
1228 else:
1229 if self.TBEType != None and self.EntryType != None:
1230 for action in actions:
1231 case('${{action.ident}}(m_tbe_ptr, m_cache_entry_ptr, addr);')
1232 elif self.TBEType != None:
1233 for action in actions:
1234 case('${{action.ident}}(m_tbe_ptr, addr);')
1235 elif self.EntryType != None:
1236 for action in actions:
1237 case('${{action.ident}}(m_cache_entry_ptr, addr);')
1238 else:
1239 for action in actions:
1240 case('${{action.ident}}(addr);')
1241 case('return TransitionResult_Valid;')
1242
1243 case = str(case)
1244
1245 # Look to see if this transition code is unique.
1246 if case not in cases:
1247 cases[case] = []
1248
1249 cases[case].append(case_string)
1250
1251 # Walk through all of the unique code blocks and spit out the
1252 # corresponding case statement elements
1253 for case,transitions in cases.iteritems():
1254 # Iterative over all the multiple transitions that share
1255 # the same code
1256 for trans in transitions:
1257 code(' case HASH_FUN($trans):')
1258 code(' $case')
1259
1260 code('''
1261 default:
1262 fatal("Invalid transition\\n"
1263 "%s time: %d addr: %s event: %s state: %s\\n",
1264 name(), g_eventQueue_ptr->getTime(), addr, event, state);
1265 }
1266 return TransitionResult_Valid;
1267}
1268''')
1269 code.write(path, "%s_Transitions.cc" % self.ident)
1270
1271 def printProfileDumperHH(self, path):
1272 code = self.symtab.codeFormatter()
1273 ident = self.ident
1274
1275 code('''
1276// Auto generated C++ code started by $__file__:$__line__
1277// ${ident}: ${{self.short}}
1278
1279#ifndef __${ident}_PROFILE_DUMPER_HH__
1280#define __${ident}_PROFILE_DUMPER_HH__
1281
1282#include <cassert>
1283#include <iostream>
1284#include <vector>
1285
1286#include "${ident}_Event.hh"
1287#include "${ident}_Profiler.hh"
1288
1289typedef std::vector<${ident}_Profiler *> ${ident}_profilers;
1290
1291class ${ident}_ProfileDumper
1292{
1293 public:
1294 ${ident}_ProfileDumper();
1295 void registerProfiler(${ident}_Profiler* profiler);
1296 void dumpStats(std::ostream& out) const;
1297
1298 private:
1299 ${ident}_profilers m_profilers;
1300};
1301
1302#endif // __${ident}_PROFILE_DUMPER_HH__
1303''')
1304 code.write(path, "%s_ProfileDumper.hh" % self.ident)
1305
1306 def printProfileDumperCC(self, path):
1307 code = self.symtab.codeFormatter()
1308 ident = self.ident
1309
1310 code('''
1311// Auto generated C++ code started by $__file__:$__line__
1312// ${ident}: ${{self.short}}
1313
1314#include "mem/protocol/${ident}_ProfileDumper.hh"
1315
1316${ident}_ProfileDumper::${ident}_ProfileDumper()
1317{
1318}
1319
1320void
1321${ident}_ProfileDumper::registerProfiler(${ident}_Profiler* profiler)
1322{
1323 m_profilers.push_back(profiler);
1324}
1325
1326void
1327${ident}_ProfileDumper::dumpStats(std::ostream& out) const
1328{
1329 out << " --- ${ident} ---\\n";
1330 out << " - Event Counts -\\n";
1331 for (${ident}_Event event = ${ident}_Event_FIRST;
1332 event < ${ident}_Event_NUM;
1333 ++event) {
1334 out << (${ident}_Event) event << " [";
1335 uint64 total = 0;
1336 for (int i = 0; i < m_profilers.size(); i++) {
1337 out << m_profilers[i]->getEventCount(event) << " ";
1338 total += m_profilers[i]->getEventCount(event);
1339 }
1340 out << "] " << total << "\\n";
1341 }
1342 out << "\\n";
1343 out << " - Transitions -\\n";
1344 for (${ident}_State state = ${ident}_State_FIRST;
1345 state < ${ident}_State_NUM;
1346 ++state) {
1347 for (${ident}_Event event = ${ident}_Event_FIRST;
1348 event < ${ident}_Event_NUM;
1349 ++event) {
1350 if (m_profilers[0]->isPossible(state, event)) {
1351 out << (${ident}_State) state << " "
1352 << (${ident}_Event) event << " [";
1353 uint64 total = 0;
1354 for (int i = 0; i < m_profilers.size(); i++) {
1355 out << m_profilers[i]->getTransitionCount(state, event) << " ";
1356 total += m_profilers[i]->getTransitionCount(state, event);
1357 }
1358 out << "] " << total << "\\n";
1359 }
1360 }
1361 out << "\\n";
1362 }
1363}
1364''')
1365 code.write(path, "%s_ProfileDumper.cc" % self.ident)
1366
1367 def printProfilerHH(self, path):
1368 code = self.symtab.codeFormatter()
1369 ident = self.ident
1370
1371 code('''
1372// Auto generated C++ code started by $__file__:$__line__
1373// ${ident}: ${{self.short}}
1374
1375#ifndef __${ident}_PROFILER_HH__
1376#define __${ident}_PROFILER_HH__
1377
1378#include <cassert>
1379#include <iostream>
1380
1381#include "mem/protocol/${ident}_Event.hh"
1382#include "mem/protocol/${ident}_State.hh"
1383#include "mem/ruby/common/TypeDefines.hh"
1384
1385class ${ident}_Profiler
1386{
1387 public:
1388 ${ident}_Profiler();
1389 void setVersion(int version);
1390 void countTransition(${ident}_State state, ${ident}_Event event);
1391 void possibleTransition(${ident}_State state, ${ident}_Event event);
1392 uint64 getEventCount(${ident}_Event event);
1393 bool isPossible(${ident}_State state, ${ident}_Event event);
1394 uint64 getTransitionCount(${ident}_State state, ${ident}_Event event);
1395 void clearStats();
1396
1397 private:
1398 int m_counters[${ident}_State_NUM][${ident}_Event_NUM];
1399 int m_event_counters[${ident}_Event_NUM];
1400 bool m_possible[${ident}_State_NUM][${ident}_Event_NUM];
1401 int m_version;
1402};
1403
1404#endif // __${ident}_PROFILER_HH__
1405''')
1406 code.write(path, "%s_Profiler.hh" % self.ident)
1407
1408 def printProfilerCC(self, path):
1409 code = self.symtab.codeFormatter()
1410 ident = self.ident
1411
1412 code('''
1413// Auto generated C++ code started by $__file__:$__line__
1414// ${ident}: ${{self.short}}
1415
1416#include <cassert>
1417
1418#include "mem/protocol/${ident}_Profiler.hh"
1419
1420${ident}_Profiler::${ident}_Profiler()
1421{
1422 for (int state = 0; state < ${ident}_State_NUM; state++) {
1423 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1424 m_possible[state][event] = false;
1425 m_counters[state][event] = 0;
1426 }
1427 }
1428 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1429 m_event_counters[event] = 0;
1430 }
1431}
1432
1433void
1434${ident}_Profiler::setVersion(int version)
1435{
1436 m_version = version;
1437}
1438
1439void
1440${ident}_Profiler::clearStats()
1441{
1442 for (int state = 0; state < ${ident}_State_NUM; state++) {
1443 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1444 m_counters[state][event] = 0;
1445 }
1446 }
1447
1448 for (int event = 0; event < ${ident}_Event_NUM; event++) {
1449 m_event_counters[event] = 0;
1450 }
1451}
1452void
1453${ident}_Profiler::countTransition(${ident}_State state, ${ident}_Event event)
1454{
1455 assert(m_possible[state][event]);
1456 m_counters[state][event]++;
1457 m_event_counters[event]++;
1458}
1459void
1460${ident}_Profiler::possibleTransition(${ident}_State state,
1461 ${ident}_Event event)
1462{
1463 m_possible[state][event] = true;
1464}
1465
1466uint64
1467${ident}_Profiler::getEventCount(${ident}_Event event)
1468{
1469 return m_event_counters[event];
1470}
1471
1472bool
1473${ident}_Profiler::isPossible(${ident}_State state, ${ident}_Event event)
1474{
1475 return m_possible[state][event];
1476}
1477
1478uint64
1479${ident}_Profiler::getTransitionCount(${ident}_State state,
1480 ${ident}_Event event)
1481{
1482 return m_counters[state][event];
1483}
1484
1485''')
1486 code.write(path, "%s_Profiler.cc" % self.ident)
1487
1488 # **************************
1489 # ******* HTML Files *******
1490 # **************************
1491 def frameRef(self, click_href, click_target, over_href, over_num, text):
1492 code = self.symtab.codeFormatter(fix_newlines=False)
1493 code("""<A href=\"$click_href\" target=\"$click_target\" onmouseover=\"
1494 if (parent.frames[$over_num].location != parent.location + '$over_href') {
1495 parent.frames[$over_num].location='$over_href'
1496 }\">
1497 ${{html.formatShorthand(text)}}
1498 </A>""")
1499 return str(code)
1500
1501 def writeHTMLFiles(self, path):
1502 # Create table with no row hilighted
1503 self.printHTMLTransitions(path, None)
1504
1505 # Generate transition tables
1506 for state in self.states.itervalues():
1507 self.printHTMLTransitions(path, state)
1508
1509 # Generate action descriptions
1510 for action in self.actions.itervalues():
1511 name = "%s_action_%s.html" % (self.ident, action.ident)
1512 code = html.createSymbol(action, "Action")
1513 code.write(path, name)
1514
1515 # Generate state descriptions
1516 for state in self.states.itervalues():
1517 name = "%s_State_%s.html" % (self.ident, state.ident)
1518 code = html.createSymbol(state, "State")
1519 code.write(path, name)
1520
1521 # Generate event descriptions
1522 for event in self.events.itervalues():
1523 name = "%s_Event_%s.html" % (self.ident, event.ident)
1524 code = html.createSymbol(event, "Event")
1525 code.write(path, name)
1526
1527 def printHTMLTransitions(self, path, active_state):
1528 code = self.symtab.codeFormatter()
1529
1530 code('''
1531<HTML>
1532<BODY link="blue" vlink="blue">
1533
1534<H1 align="center">${{html.formatShorthand(self.short)}}:
1535''')
1536 code.indent()
1537 for i,machine in enumerate(self.symtab.getAllType(StateMachine)):
1538 mid = machine.ident
1539 if i != 0:
1540 extra = " - "
1541 else:
1542 extra = ""
1543 if machine == self:
1544 code('$extra$mid')
1545 else:
1546 code('$extra<A target="Table" href="${mid}_table.html">$mid</A>')
1547 code.dedent()
1548
1549 code("""
1550</H1>
1551
1552<TABLE border=1>
1553<TR>
1554 <TH> </TH>
1555""")
1556
1557 for event in self.events.itervalues():
1558 href = "%s_Event_%s.html" % (self.ident, event.ident)
1559 ref = self.frameRef(href, "Status", href, "1", event.short)
1560 code('<TH bgcolor=white>$ref</TH>')
1561
1562 code('</TR>')
1563 # -- Body of table
1564 for state in self.states.itervalues():
1565 # -- Each row
1566 if state == active_state:
1567 color = "yellow"
1568 else:
1569 color = "white"
1570
1571 click = "%s_table_%s.html" % (self.ident, state.ident)
1572 over = "%s_State_%s.html" % (self.ident, state.ident)
1573 text = html.formatShorthand(state.short)
1574 ref = self.frameRef(click, "Table", over, "1", state.short)
1575 code('''
1576<TR>
1577 <TH bgcolor=$color>$ref</TH>
1578''')
1579
1580 # -- One column for each event
1581 for event in self.events.itervalues():
1582 trans = self.table.get((state,event), None)
1583 if trans is None:
1584 # This is the no transition case
1585 if state == active_state:
1586 color = "#C0C000"
1587 else:
1588 color = "lightgrey"
1589
1590 code('<TD bgcolor=$color>&nbsp;</TD>')
1591 continue
1592
1593 next = trans.nextState
1594 stall_action = False
1595
1596 # -- Get the actions
1597 for action in trans.actions:
1598 if action.ident == "z_stall" or \
1599 action.ident == "zz_recycleMandatoryQueue":
1600 stall_action = True
1601
1602 # -- Print out "actions/next-state"
1603 if stall_action:
1604 if state == active_state:
1605 color = "#C0C000"
1606 else:
1607 color = "lightgrey"
1608
1609 elif active_state and next.ident == active_state.ident:
1610 color = "aqua"
1611 elif state == active_state:
1612 color = "yellow"
1613 else:
1614 color = "white"
1615
1616 code('<TD bgcolor=$color>')
1617 for action in trans.actions:
1618 href = "%s_action_%s.html" % (self.ident, action.ident)
1619 ref = self.frameRef(href, "Status", href, "1",
1620 action.short)
1621 code(' $ref')
1622 if next != state:
1623 if trans.actions:
1624 code('/')
1625 click = "%s_table_%s.html" % (self.ident, next.ident)
1626 over = "%s_State_%s.html" % (self.ident, next.ident)
1627 ref = self.frameRef(click, "Table", over, "1", next.short)
1628 code("$ref")
1629 code("</TD>")
1630
1631 # -- Each row
1632 if state == active_state:
1633 color = "yellow"
1634 else:
1635 color = "white"
1636
1637 click = "%s_table_%s.html" % (self.ident, state.ident)
1638 over = "%s_State_%s.html" % (self.ident, state.ident)
1639 ref = self.frameRef(click, "Table", over, "1", state.short)
1640 code('''
1641 <TH bgcolor=$color>$ref</TH>
1642</TR>
1643''')
1644 code('''
1645<!- Column footer->
1646<TR>
1647 <TH> </TH>
1648''')
1649
1650 for event in self.events.itervalues():
1651 href = "%s_Event_%s.html" % (self.ident, event.ident)
1652 ref = self.frameRef(href, "Status", href, "1", event.short)
1653 code('<TH bgcolor=white>$ref</TH>')
1654 code('''
1655</TR>
1656</TABLE>
1657</BODY></HTML>
1658''')
1659
1660
1661 if active_state:
1662 name = "%s_table_%s.html" % (self.ident, active_state.ident)
1663 else:
1664 name = "%s_table.html" % self.ident
1665 code.write(path, name)
1666
1667__all__ = [ "StateMachine" ]