src/arch/arm/utility.hh

   1 /*
   2  * Copyright (c) 2010, 2012-2013, 2016-2019 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 2003-2005 The Regents of The University of Michigan
  15  * Copyright (c) 2007-2008 The Florida State University
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions are
  20  * met: redistributions of source code must retain the above copyright
  21  * notice, this list of conditions and the following disclaimer;
  22  * redistributions in binary form must reproduce the above copyright
  23  * notice, this list of conditions and the following disclaimer in the
  24  * documentation and/or other materials provided with the distribution;
  25  * neither the name of the copyright holders nor the names of its
  26  * contributors may be used to endorse or promote products derived from
  27  * this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  30  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  31  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  32  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  33  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  34  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  36  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  37  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  39  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  * Authors: Korey Sewell
  42  *          Stephen Hines
  43  */
  44
  45 #ifndef __ARCH_ARM_UTILITY_HH__
  46 #define __ARCH_ARM_UTILITY_HH__
  47
  48 #include "arch/arm/isa_traits.hh"
  49 #include "arch/arm/miscregs.hh"
  50 #include "arch/arm/types.hh"
  51 #include "base/logging.hh"
  52 #include "base/trace.hh"
  53 #include "base/types.hh"
  54 #include "cpu/static_inst.hh"
  55 #include "cpu/thread_context.hh"
  56
  57 class ArmSystem;
  58
  59 namespace ArmISA {
  60
  61 inline PCState
  62 buildRetPC(const PCState &curPC, const PCState &callPC)
  63 {
  64     PCState retPC = callPC;
  65     retPC.uEnd();
  66     return retPC;
  67 }
  68
  69 inline bool
  70 testPredicate(uint32_t nz, uint32_t c, uint32_t v, ConditionCode code)
  71 {
  72     bool n = (nz & 0x2);
  73     bool z = (nz & 0x1);
  74
  75     switch (code)
  76     {
  77         case COND_EQ: return  z;
  78         case COND_NE: return !z;
  79         case COND_CS: return  c;
  80         case COND_CC: return !c;
  81         case COND_MI: return  n;
  82         case COND_PL: return !n;
  83         case COND_VS: return  v;
  84         case COND_VC: return !v;
  85         case COND_HI: return  (c && !z);
  86         case COND_LS: return !(c && !z);
  87         case COND_GE: return !(n ^ v);
  88         case COND_LT: return  (n ^ v);
  89         case COND_GT: return !(n ^ v || z);
  90         case COND_LE: return  (n ^ v || z);
  91         case COND_AL: return true;
  92         case COND_UC: return true;
  93         default:
  94             panic("Unhandled predicate condition: %d\n", code);
  95     }
  96 }
  97
  98 /**
  99  * Function to insure ISA semantics about 0 registers.
 100  * @param tc The thread context.
 101  */
 102 template <class TC>
 103 void zeroRegisters(TC *tc);
 104
 105 inline void startupCPU(ThreadContext *tc, int cpuId)
 106 {
 107     tc->activate();
 108 }
 109
 110 void copyRegs(ThreadContext *src, ThreadContext *dest);
 111
 112 static inline void
 113 copyMiscRegs(ThreadContext *src, ThreadContext *dest)
 114 {
 115     panic("Copy Misc. Regs Not Implemented Yet\n");
 116 }
 117
 118 void initCPU(ThreadContext *tc, int cpuId);
 119
 120 /** Send an event (SEV) to a specific PE if there isn't
 121  * already a pending event */
 122 void sendEvent(ThreadContext *tc);
 123
 124 static inline bool
 125 inUserMode(CPSR cpsr)
 126 {
 127     return cpsr.mode == MODE_USER || cpsr.mode == MODE_EL0T;
 128 }
 129
 130 static inline bool
 131 inUserMode(ThreadContext *tc)
 132 {
 133     return inUserMode(tc->readMiscRegNoEffect(MISCREG_CPSR));
 134 }
 135
 136 static inline bool
 137 inPrivilegedMode(CPSR cpsr)
 138 {
 139     return !inUserMode(cpsr);
 140 }
 141
 142 static inline bool
 143 inPrivilegedMode(ThreadContext *tc)
 144 {
 145     return !inUserMode(tc);
 146 }
 147
 148 bool inAArch64(ThreadContext *tc);
 149
 150 static inline OperatingMode
 151 currOpMode(ThreadContext *tc)
 152 {
 153     CPSR cpsr = tc->readMiscReg(MISCREG_CPSR);
 154     return (OperatingMode) (uint8_t) cpsr.mode;
 155 }
 156
 157 static inline ExceptionLevel
 158 currEL(ThreadContext *tc)
 159 {
 160     return opModeToEL(currOpMode(tc));
 161 }
 162
 163 inline ExceptionLevel
 164 currEL(CPSR cpsr)
 165 {
 166     return opModeToEL((OperatingMode) (uint8_t)cpsr.mode);
 167 }
 168
 169 bool HaveVirtHostExt(ThreadContext *tc);
 170 bool HaveSecureEL2Ext(ThreadContext *tc);
 171 bool IsSecureEL2Enabled(ThreadContext *tc);
 172 bool EL2Enabled(ThreadContext *tc);
 173
 174 /**
 175  * This function checks whether selected EL provided as an argument
 176  * is using the AArch32 ISA. This information might be unavailable
 177  * at the current EL status: it hence returns a pair of boolean values:
 178  * a first boolean, true if information is available (known),
 179  * and a second one, true if EL is using AArch32, false for AArch64.
 180  *
 181  * @param tc The thread context.
 182  * @param el The target exception level.
 183  * @retval known is FALSE for EL0 if the current Exception level
 184  *               is not EL0 and EL1 is using AArch64, since it cannot
 185  *               determine the state of EL0; TRUE otherwise.
 186  * @retval aarch32 is TRUE if the specified Exception level is using AArch32;
 187  *                 FALSE otherwise.
 188  */
 189 std::pair<bool, bool>
 190 ELUsingAArch32K(ThreadContext *tc, ExceptionLevel el);
 191
 192 bool ELIs32(ThreadContext *tc, ExceptionLevel el);
 193
 194 bool ELIs64(ThreadContext *tc, ExceptionLevel el);
 195
 196 /**
 197  * Returns true if the current exception level `el` is executing a Host OS or
 198  * an application of a Host OS (Armv8.1 Virtualization Host Extensions).
 199  */
 200 bool ELIsInHost(ThreadContext *tc, ExceptionLevel el);
 201
 202 bool isBigEndian64(ThreadContext *tc);
 203
 204 /**
 205  * badMode is checking if the execution mode provided as an argument is
 206  * valid and implemented for AArch32
 207  *
 208  * @param tc ThreadContext
 209  * @param mode OperatingMode to check
 210  * @return false if mode is valid and implemented, true otherwise
 211  */
 212 bool badMode32(ThreadContext *tc, OperatingMode mode);
 213
 214 /**
 215  * badMode is checking if the execution mode provided as an argument is
 216  * valid and implemented.
 217  *
 218  * @param tc ThreadContext
 219  * @param mode OperatingMode to check
 220  * @return false if mode is valid and implemented, true otherwise
 221  */
 222 bool badMode(ThreadContext *tc, OperatingMode mode);
 223
 224 static inline uint8_t
 225 itState(CPSR psr)
 226 {
 227     ITSTATE it = 0;
 228     it.top6 = psr.it2;
 229     it.bottom2 = psr.it1;
 230
 231     return (uint8_t)it;
 232 }
 233
 234 /**
 235  * Removes the tag from tagged addresses if that mode is enabled.
 236  * @param addr The address to be purified.
 237  * @param tc The thread context.
 238  * @param el The controlled exception level.
 239  * @return The purified address.
 240  */
 241 Addr purifyTaggedAddr(Addr addr, ThreadContext *tc, ExceptionLevel el,
 242                       TTBCR tcr);
 243 Addr purifyTaggedAddr(Addr addr, ThreadContext *tc, ExceptionLevel el);
 244
 245 static inline bool
 246 inSecureState(SCR scr, CPSR cpsr)
 247 {
 248     switch ((OperatingMode) (uint8_t) cpsr.mode) {
 249       case MODE_MON:
 250       case MODE_EL3T:
 251       case MODE_EL3H:
 252         return true;
 253       case MODE_HYP:
 254       case MODE_EL2T:
 255       case MODE_EL2H:
 256         return false;
 257       default:
 258         return !scr.ns;
 259     }
 260 }
 261
 262 bool inSecureState(ThreadContext *tc);
 263
 264 /**
 265  * Return TRUE if an Exception level below EL3 is in Secure state.
 266  * Differs from inSecureState in that it ignores the current EL
 267  * or Mode in considering security state.
 268  */
 269 inline bool isSecureBelowEL3(ThreadContext *tc);
 270
 271 bool longDescFormatInUse(ThreadContext *tc);
 272
 273 /** This helper function is either returing the value of
 274  * MPIDR_EL1 (by calling getMPIDR), or it is issuing a read
 275  * to VMPIDR_EL2 (as it happens in virtualized systems) */
 276 RegVal readMPIDR(ArmSystem *arm_sys, ThreadContext *tc);
 277
 278 /** This helper function is returing the value of MPIDR_EL1 */
 279 RegVal getMPIDR(ArmSystem *arm_sys, ThreadContext *tc);
 280
 281 static inline uint32_t
 282 mcrMrcIssBuild(bool isRead, uint32_t crm, IntRegIndex rt, uint32_t crn,
 283                uint32_t opc1, uint32_t opc2)
 284 {
 285     return (isRead <<  0) |
 286            (crm    <<  1) |
 287            (rt     <<  5) |
 288            (crn    << 10) |
 289            (opc1   << 14) |
 290            (opc2   << 17);
 291 }
 292
 293 static inline void
 294 mcrMrcIssExtract(uint32_t iss, bool &isRead, uint32_t &crm, IntRegIndex &rt,
 295                  uint32_t &crn, uint32_t &opc1, uint32_t &opc2)
 296 {
 297     isRead = (iss >>  0) & 0x1;
 298     crm    = (iss >>  1) & 0xF;
 299     rt     = (IntRegIndex) ((iss >>  5) & 0xF);
 300     crn    = (iss >> 10) & 0xF;
 301     opc1   = (iss >> 14) & 0x7;
 302     opc2   = (iss >> 17) & 0x7;
 303 }
 304
 305 static inline uint32_t
 306 mcrrMrrcIssBuild(bool isRead, uint32_t crm, IntRegIndex rt, IntRegIndex rt2,
 307                  uint32_t opc1)
 308 {
 309     return (isRead <<  0) |
 310            (crm    <<  1) |
 311            (rt     <<  5) |
 312            (rt2    << 10) |
 313            (opc1   << 16);
 314 }
 315
 316 static inline uint32_t
 317 msrMrs64IssBuild(bool isRead, uint32_t op0, uint32_t op1, uint32_t crn,
 318                  uint32_t crm, uint32_t op2, IntRegIndex rt)
 319 {
 320     return isRead |
 321         (crm << 1) |
 322         (rt << 5) |
 323         (crn << 10) |
 324         (op1 << 14) |
 325         (op2 << 17) |
 326         (op0 << 20);
 327 }
 328
 329 bool
 330 mcrMrc15TrapToHyp(const MiscRegIndex miscReg, ThreadContext *tc, uint32_t iss);
 331
 332 bool
 333 mcrMrc14TrapToHyp(const MiscRegIndex miscReg, HCR hcr, CPSR cpsr, SCR scr,
 334                   HDCR hdcr, HSTR hstr, HCPTR hcptr, uint32_t iss);
 335 bool
 336 mcrrMrrc15TrapToHyp(const MiscRegIndex miscReg, CPSR cpsr, SCR scr, HSTR hstr,
 337                     HCR hcr, uint32_t iss);
 338
 339 bool SPAlignmentCheckEnabled(ThreadContext* tc);
 340
 341 uint64_t getArgument(ThreadContext *tc, int &number, uint16_t size, bool fp);
 342
 343 void skipFunction(ThreadContext *tc);
 344
 345 inline void
 346 advancePC(PCState &pc, const StaticInstPtr &inst)
 347 {
 348     inst->advancePC(pc);
 349 }
 350
 351 Addr truncPage(Addr addr);
 352 Addr roundPage(Addr addr);
 353
 354 inline uint64_t
 355 getExecutingAsid(ThreadContext *tc)
 356 {
 357     return tc->readMiscReg(MISCREG_CONTEXTIDR);
 358 }
 359
 360 // Decodes the register index to access based on the fields used in a MSR
 361 // or MRS instruction
 362 bool
 363 decodeMrsMsrBankedReg(uint8_t sysM, bool r, bool &isIntReg, int &regIdx,
 364                       CPSR cpsr, SCR scr, NSACR nsacr,
 365                       bool checkSecurity = true);
 366
 367 // This wrapper function is used to turn the register index into a source
 368 // parameter for the instruction. See Operands.isa
 369 static inline int
 370 decodeMrsMsrBankedIntRegIndex(uint8_t sysM, bool r)
 371 {
 372     int  regIdx;
 373     bool isIntReg;
 374     bool validReg;
 375
 376     validReg = decodeMrsMsrBankedReg(sysM, r, isIntReg, regIdx, 0, 0, 0, false);
 377     return (validReg && isIntReg) ? regIdx : INTREG_DUMMY;
 378 }
 379
 380 /**
 381  * Returns the n. of PA bits corresponding to the specified encoding.
 382  */
 383 int decodePhysAddrRange64(uint8_t pa_enc);
 384
 385 /**
 386  * Returns the encoding corresponding to the specified n. of PA bits.
 387  */
 388 uint8_t encodePhysAddrRange64(int pa_size);
 389
 390 inline ByteOrder byteOrder(ThreadContext *tc)
 391 {
 392     return isBigEndian64(tc) ? BigEndianByteOrder : LittleEndianByteOrder;
 393 };
 394
 395 }
 396
 397 #endif