1 // Copyright (c) 2008 The Hewlett-Packard Development Company
2 // All rights reserved.
4 // The license below extends only to copyright in the software and shall
5 // not be construed as granting a license to any other intellectual
6 // property including but not limited to intellectual property relating
7 // to a hardware implementation of the functionality of the software
8 // licensed hereunder. You may use the software subject to the license
9 // terms below provided that you ensure that this notice is replicated
10 // unmodified and in its entirety in all distributions of the software,
11 // modified or unmodified, in source code or in binary form.
13 // Redistribution and use in source and binary forms, with or without
14 // modification, are permitted provided that the following conditions are
15 // met: redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer;
17 // redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution;
20 // neither the name of the copyright holders nor the names of its
21 // contributors may be used to endorse or promote products derived from
22 // this software without specific prior written permission.
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 // Authors: Gabe Black
38 //////////////////////////////////////////////////////////////////////////
42 //////////////////////////////////////////////////////////////////////////
45 class MicroDebugBase : public X86ISA::X86MicroopBase
48 typedef GenericISA::M5DebugFault::DebugFunc DebugFunc;
54 MicroDebugBase(ExtMachInst machInst, const char * mnem,
55 const char * instMnem, uint64_t setFlags,
56 DebugFunc _func, std::string _message, uint8_t _cc) :
57 X86MicroopBase(machInst, mnem, instMnem, setFlags, No_OpClass),
58 func(_func), message(_message), cc(_cc)
62 generateDisassembly(Addr pc, const SymbolTable *symtab) const
64 std::stringstream response;
66 printMnemonic(response, instMnem, mnemonic);
67 response << "\"" << message << "\"";
69 return response.str();
74 def template MicroDebugDeclare {{
75 class %(class_name)s : public %(base_class)s
78 %(class_name)s(ExtMachInst _machInst, const char * instMnem,
79 uint64_t setFlags, std::string _message, uint8_t _cc);
85 def template MicroDebugExecute {{
87 %(class_name)s::execute(%(CPU_exec_context)s *xc,
88 Trace::InstRecord *traceData) const
93 return new GenericISA::M5DebugFault(func, message);
100 def template MicroDebugConstructor {{
101 inline %(class_name)s::%(class_name)s(
102 ExtMachInst machInst, const char * instMnem, uint64_t setFlags,
103 std::string _message, uint8_t _cc) :
104 %(base_class)s(machInst, "%(func)s", instMnem,
105 setFlags, %(func_num)s, _message, _cc)
112 class MicroDebug(X86Microop):
113 def __init__(self, message, flags=None):
114 self.message = message
116 if not isinstance(flags, (list, tuple)):
117 raise Exception, "flags must be a list or tuple of flags"
118 self.cond = " | ".join(flags)
119 self.className += "Flags"
123 def getAllocator(self, microFlags):
124 allocator = '''new %(class_name)s(machInst, macrocodeBlock,
125 %(flags)s, "%(message)s", %(cc)s)''' % {
126 "class_name" : self.className,
127 "flags" : self.microFlagsText(microFlags),
128 "message" : self.message,
136 def buildDebugMicro(func, func_num):
137 global exec_output, header_output, decoder_output
139 iop = InstObjParams(func, "Micro%sFlags" % func.capitalize(),
143 "func_num": "GenericISA::M5DebugFault::%s" % func_num,
144 "cond_test": "checkCondition(ccFlagBits, cc)"})
145 exec_output += MicroDebugExecute.subst(iop)
146 header_output += MicroDebugDeclare.subst(iop)
147 decoder_output += MicroDebugConstructor.subst(iop)
149 iop = InstObjParams(func, "Micro%s" % func.capitalize(),
153 "func_num": "GenericISA::M5DebugFault::%s" % func_num,
154 "cond_test": "true"})
155 exec_output += MicroDebugExecute.subst(iop)
156 header_output += MicroDebugDeclare.subst(iop)
157 decoder_output += MicroDebugConstructor.subst(iop)
159 class MicroDebugChild(MicroDebug):
160 className = "Micro%s" % func.capitalize()
162 global microopClasses
163 microopClasses[func] = MicroDebugChild
165 buildDebugMicro("panic", "PanicFunc")
166 buildDebugMicro("fatal", "FatalFunc")
167 buildDebugMicro("warn", "WarnFunc")
168 buildDebugMicro("warn_once", "WarnOnceFunc")