priv.isa revision 10196:be0e1724eb39
16157Snate@binkert.org// Copyright (c) 2006-2007 The Regents of The University of Michigan 26157Snate@binkert.org// All rights reserved. 36157Snate@binkert.org// 46157Snate@binkert.org// Redistribution and use in source and binary forms, with or without 56157Snate@binkert.org// modification, are permitted provided that the following conditions are 66157Snate@binkert.org// met: redistributions of source code must retain the above copyright 76157Snate@binkert.org// notice, this list of conditions and the following disclaimer; 86157Snate@binkert.org// redistributions in binary form must reproduce the above copyright 96157Snate@binkert.org// notice, this list of conditions and the following disclaimer in the 106157Snate@binkert.org// documentation and/or other materials provided with the distribution; 116157Snate@binkert.org// neither the name of the copyright holders nor the names of its 126157Snate@binkert.org// contributors may be used to endorse or promote products derived from 136157Snate@binkert.org// this software without specific prior written permission. 146157Snate@binkert.org// 156157Snate@binkert.org// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 166157Snate@binkert.org// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 176157Snate@binkert.org// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 186157Snate@binkert.org// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 196157Snate@binkert.org// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 206157Snate@binkert.org// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 216157Snate@binkert.org// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 226157Snate@binkert.org// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 236157Snate@binkert.org// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 246157Snate@binkert.org// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 256157Snate@binkert.org// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 266157Snate@binkert.org// 276157Snate@binkert.org// Authors: Ali Saidi 286157Snate@binkert.org// Gabe Black 296157Snate@binkert.org// Steve Reinhardt 306157Snate@binkert.org 316157Snate@binkert.org//////////////////////////////////////////////////////////////////// 326157Snate@binkert.org// 338492Snilay@cs.wisc.edu// Privilege mode instructions 346168Snate@binkert.org// 356168Snate@binkert.org 368439Snilay@cs.wisc.eduoutput header {{ 376876Ssteve.reinhardt@amd.com /** 388439Snilay@cs.wisc.edu * Base class for privelege mode operations. 396876Ssteve.reinhardt@amd.com */ 408191SLisa.Hsu@amd.com class Priv : public SparcStaticInst 416876Ssteve.reinhardt@amd.com { 426876Ssteve.reinhardt@amd.com protected: 436286Snate@binkert.org // Constructor 446157Snate@binkert.org Priv(const char *mnem, ExtMachInst _machInst, OpClass __opClass) : 457025SBrad.Beckmann@amd.com SparcStaticInst(mnem, _machInst, __opClass) 466782SBrad.Beckmann@amd.com { 476157Snate@binkert.org } 488191SLisa.Hsu@amd.com 496157Snate@binkert.org std::string generateDisassembly(Addr pc, 506797SBrad.Beckmann@amd.com const SymbolTable *symtab) const; 516286Snate@binkert.org }; 528641Snate@binkert.org 536157Snate@binkert.org // This class is for instructions that explicitly read control 546157Snate@binkert.org // registers. It provides a special generateDisassembly function. 55 class RdPriv : public Priv 56 { 57 protected: 58 // Constructor 59 RdPriv(const char *mnem, ExtMachInst _machInst, 60 OpClass __opClass, char const * _regName) : 61 Priv(mnem, _machInst, __opClass), regName(_regName) 62 { 63 } 64 65 std::string generateDisassembly(Addr pc, 66 const SymbolTable *symtab) const; 67 68 char const * regName; 69 }; 70 71 // This class is for instructions that explicitly write control 72 // registers. It provides a special generateDisassembly function. 73 class WrPriv : public Priv 74 { 75 protected: 76 // Constructor 77 WrPriv(const char *mnem, ExtMachInst _machInst, 78 OpClass __opClass, char const * _regName) : 79 Priv(mnem, _machInst, __opClass), regName(_regName) 80 { 81 } 82 83 std::string generateDisassembly(Addr pc, 84 const SymbolTable *symtab) const; 85 86 char const * regName; 87 }; 88 89 /** 90 * Base class for privelege mode operations with immediates. 91 */ 92 class PrivImm : public Priv 93 { 94 protected: 95 // Constructor 96 PrivImm(const char *mnem, ExtMachInst _machInst, 97 OpClass __opClass) : 98 Priv(mnem, _machInst, __opClass), imm(SIMM13) 99 { 100 } 101 102 int32_t imm; 103 }; 104 105 // This class is for instructions that explicitly write control 106 // registers. It provides a special generateDisassembly function. 107 class WrPrivImm : public PrivImm 108 { 109 protected: 110 // Constructor 111 WrPrivImm(const char *mnem, ExtMachInst _machInst, 112 OpClass __opClass, char const * _regName) : 113 PrivImm(mnem, _machInst, __opClass), regName(_regName) 114 { 115 } 116 117 std::string generateDisassembly(Addr pc, 118 const SymbolTable *symtab) const; 119 120 char const * regName; 121 }; 122}}; 123 124output decoder {{ 125 std::string 126 Priv::generateDisassembly(Addr pc, const SymbolTable *symtab) const 127 { 128 std::stringstream response; 129 130 printMnemonic(response, mnemonic); 131 132 return response.str(); 133 } 134 135 std::string 136 RdPriv::generateDisassembly(Addr pc, const SymbolTable *symtab) const 137 { 138 std::stringstream response; 139 140 printMnemonic(response, mnemonic); 141 142 ccprintf(response, " %%%s, ", regName); 143 printDestReg(response, 0); 144 145 return response.str(); 146 } 147 148 std::string 149 WrPriv::generateDisassembly(Addr pc, const SymbolTable *symtab) const 150 { 151 std::stringstream response; 152 153 printMnemonic(response, mnemonic); 154 155 ccprintf(response, " "); 156 // If the first reg is %g0, don't print it. 157 // This improves readability 158 if (_srcRegIdx[0] != 0) { 159 printSrcReg(response, 0); 160 ccprintf(response, ", "); 161 } 162 printSrcReg(response, 1); 163 ccprintf(response, ", %%%s", regName); 164 165 return response.str(); 166 } 167 168 std::string WrPrivImm::generateDisassembly(Addr pc, 169 const SymbolTable *symtab) const 170 { 171 std::stringstream response; 172 173 printMnemonic(response, mnemonic); 174 175 ccprintf(response, " "); 176 // If the first reg is %g0, don't print it. 177 // This improves readability 178 if (_srcRegIdx[0] != 0) { 179 printSrcReg(response, 0); 180 ccprintf(response, ", "); 181 } 182 ccprintf(response, "0x%x, %%%s", imm, regName); 183 184 return response.str(); 185 } 186}}; 187 188def template ControlRegConstructor {{ 189 %(class_name)s::%(class_name)s(ExtMachInst machInst) 190 : %(base_class)s("%(mnemonic)s", machInst, 191 %(op_class)s, "%(reg_name)s") 192 { 193 %(constructor)s; 194 } 195}}; 196 197def template PrivExecute {{ 198 Fault %(class_name)s::execute(CPU_EXEC_CONTEXT *xc, 199 Trace::InstRecord *traceData) const 200 { 201 %(op_decl)s; 202 %(op_rd)s; 203 204 // If the processor isn't in privileged mode, fault out right away 205 if (%(check)s) 206 return new PrivilegedAction; 207 208 if (%(tlCheck)s) 209 return new IllegalInstruction; 210 211 Fault fault = NoFault; 212 %(code)s; 213 %(op_wb)s; 214 return fault; 215 } 216}}; 217 218let {{ 219 def doPrivFormat(code, checkCode, name, Name, tlCheck, opt_flags): 220 (usesImm, code, immCode, 221 rString, iString) = splitOutImm(code) 222 #If these are rd, rdpr, rdhpr, wr, wrpr, or wrhpr instructions, 223 #cut any other info out of the mnemonic. Also pick a different 224 #base class. 225 regBase = 'Priv' 226 regName = '' 227 for mnem in ["rdhpr", "rdpr", "rd"]: 228 if name.startswith(mnem): 229 regName = name[len(mnem):] 230 name = mnem 231 regBase = 'RdPriv' 232 break 233 for mnem in ["wrhpr", "wrpr", "wr"]: 234 if name.startswith(mnem): 235 regName = name[len(mnem):] 236 name = mnem 237 regBase = 'WrPriv' 238 break 239 iop = InstObjParams(name, Name, regBase, 240 {"code": code, "check": checkCode, 241 "tlCheck": tlCheck, "reg_name": regName}, 242 opt_flags) 243 header_output = BasicDeclare.subst(iop) 244 if regName == '': 245 decoder_output = BasicConstructor.subst(iop) 246 else: 247 decoder_output = ControlRegConstructor.subst(iop) 248 exec_output = PrivExecute.subst(iop) 249 if usesImm: 250 imm_iop = InstObjParams(name, Name + 'Imm', regBase + 'Imm', 251 {"code": immCode, "check": checkCode, 252 "tlCheck": tlCheck, "reg_name": regName}, 253 opt_flags) 254 header_output += BasicDeclare.subst(imm_iop) 255 if regName == '': 256 decoder_output += BasicConstructor.subst(imm_iop) 257 else: 258 decoder_output += ControlRegConstructor.subst(imm_iop) 259 exec_output += PrivExecute.subst(imm_iop) 260 decode_block = ROrImmDecode.subst(iop) 261 else: 262 decode_block = BasicDecode.subst(iop) 263 return (header_output, decoder_output, exec_output, decode_block) 264}}; 265 266def format Priv(code, extraCond=true, checkTl=false, *opt_flags) {{ 267 checkCode = "(%s) && !(Pstate.priv || Hpstate.hpriv)" % extraCond 268 if checkTl != "false": 269 tlCheck = "Tl == 0" 270 else: 271 tlCheck = "false" 272 (header_output, decoder_output, 273 exec_output, decode_block) = doPrivFormat(code, 274 checkCode, name, Name, tlCheck, opt_flags) 275}}; 276 277def format NoPriv(code, checkTl=false, *opt_flags) {{ 278 #Instructions which use this format don't really check for 279 #any particular mode, but the disassembly is performed 280 #using the control registers actual name 281 checkCode = "false" 282 if checkTl != "false": 283 tlCheck = "Tl == 0" 284 else: 285 tlCheck = "false" 286 (header_output, decoder_output, 287 exec_output, decode_block) = doPrivFormat(code, 288 checkCode, name, Name, tlCheck, opt_flags) 289}}; 290 291def format HPriv(code, checkTl=false, *opt_flags) {{ 292 checkCode = "!Hpstate.hpriv" 293 if checkTl != "false": 294 tlCheck = "Tl == 0" 295 else: 296 tlCheck = "false" 297 (header_output, decoder_output, 298 exec_output, decode_block) = doPrivFormat(code, 299 checkCode, name, Name, tlCheck, opt_flags) 300}}; 301 302