src/arm/simulator-arm.h

   1 // Copyright 2009 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28
  29 // Declares a Simulator for ARM instructions if we are not generating a native
  30 // ARM binary. This Simulator allows us to run and debug ARM code generation on
  31 // regular desktop machines.
  32 // V8 calls into generated code by "calling" the CALL_GENERATED_CODE macro,
  33 // which will start execution in the Simulator or forwards to the real entry
  34 // on a ARM HW platform.
  35
  36 #ifndef V8_ARM_SIMULATOR_ARM_H_
  37 #define V8_ARM_SIMULATOR_ARM_H_
  38
  39 #include "allocation.h"
  40
  41 #if !defined(USE_SIMULATOR)
  42 // Running without a simulator on a native arm platform.
  43
  44 namespace v8 {
  45 namespace internal {
  46
  47 // When running without a simulator we call the entry directly.
  48 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
  49   (entry(p0, p1, p2, p3, p4))
  50
  51 typedef int (*arm_regexp_matcher)(String*, int, const byte*, const byte*,
  52                                   void*, int*, Address, int);
  53
  54
  55 // Call the generated regexp code directly. The code at the entry address
  56 // should act as a function matching the type arm_regexp_matcher.
  57 // The fifth argument is a dummy that reserves the space used for
  58 // the return address added by the ExitFrame in native calls.
  59 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6) \
  60   (FUNCTION_CAST<arm_regexp_matcher>(entry)(p0, p1, p2, p3, NULL, p4, p5, p6))
  61
  62 #define TRY_CATCH_FROM_ADDRESS(try_catch_address) \
  63   (reinterpret_cast<TryCatch*>(try_catch_address))
  64
  65 // The stack limit beyond which we will throw stack overflow errors in
  66 // generated code. Because generated code on arm uses the C stack, we
  67 // just use the C stack limit.
  68 class SimulatorStack : public v8::internal::AllStatic {
  69  public:
  70   static inline uintptr_t JsLimitFromCLimit(uintptr_t c_limit) {
  71     return c_limit;
  72   }
  73
  74   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
  75     return try_catch_address;
  76   }
  77
  78   static inline void UnregisterCTryCatch() { }
  79 };
  80
  81 } }  // namespace v8::internal
  82
  83 #else  // !defined(USE_SIMULATOR)
  84 // Running with a simulator.
  85
  86 #include "constants-arm.h"
  87 #include "hashmap.h"
  88 #include "assembler.h"
  89
  90 namespace v8 {
  91 namespace internal {
  92
  93 class CachePage {
  94  public:
  95   static const int LINE_VALID = 0;
  96   static const int LINE_INVALID = 1;
  97
  98   static const int kPageShift = 12;
  99   static const int kPageSize = 1 << kPageShift;
 100   static const int kPageMask = kPageSize - 1;
 101   static const int kLineShift = 2;  // The cache line is only 4 bytes right now.
 102   static const int kLineLength = 1 << kLineShift;
 103   static const int kLineMask = kLineLength - 1;
 104
 105   CachePage() {
 106     memset(&validity_map_, LINE_INVALID, sizeof(validity_map_));
 107   }
 108
 109   char* ValidityByte(int offset) {
 110     return &validity_map_[offset >> kLineShift];
 111   }
 112
 113   char* CachedData(int offset) {
 114     return &data_[offset];
 115   }
 116
 117  private:
 118   char data_[kPageSize];   // The cached data.
 119   static const int kValidityMapSize = kPageSize >> kLineShift;
 120   char validity_map_[kValidityMapSize];  // One byte per line.
 121 };
 122
 123
 124 class Simulator {
 125  public:
 126   friend class Debugger;
 127   enum Register {
 128     no_reg = -1,
 129     r0 = 0, r1, r2, r3, r4, r5, r6, r7,
 130     r8, r9, r10, r11, r12, r13, r14, r15,
 131     num_registers,
 132     sp = 13,
 133     lr = 14,
 134     pc = 15,
 135     s0 = 0, s1, s2, s3, s4, s5, s6, s7,
 136     s8, s9, s10, s11, s12, s13, s14, s15,
 137     s16, s17, s18, s19, s20, s21, s22, s23,
 138     s24, s25, s26, s27, s28, s29, s30, s31,
 139     num_s_registers = 32,
 140     d0 = 0, d1, d2, d3, d4, d5, d6, d7,
 141     d8, d9, d10, d11, d12, d13, d14, d15,
 142     num_d_registers = 16
 143   };
 144
 145   Simulator();
 146   ~Simulator();
 147
 148   // The currently executing Simulator instance. Potentially there can be one
 149   // for each native thread.
 150   static Simulator* current();
 151
 152   // Accessors for register state. Reading the pc value adheres to the ARM
 153   // architecture specification and is off by a 8 from the currently executing
 154   // instruction.
 155   void set_register(int reg, int32_t value);
 156   int32_t get_register(int reg) const;
 157   void set_dw_register(int dreg, const int* dbl);
 158
 159   // Support for VFP.
 160   void set_s_register(int reg, unsigned int value);
 161   unsigned int get_s_register(int reg) const;
 162   void set_d_register_from_double(int dreg, const double& dbl);
 163   double get_double_from_d_register(int dreg);
 164   void set_s_register_from_float(int sreg, const float dbl);
 165   float get_float_from_s_register(int sreg);
 166   void set_s_register_from_sinteger(int reg, const int value);
 167   int get_sinteger_from_s_register(int reg);
 168
 169   // Special case of set_register and get_register to access the raw PC value.
 170   void set_pc(int32_t value);
 171   int32_t get_pc() const;
 172
 173   // Accessor to the internal simulator stack area.
 174   uintptr_t StackLimit() const;
 175
 176   // Executes ARM instructions until the PC reaches end_sim_pc.
 177   void Execute();
 178
 179   // Call on program start.
 180   static void Initialize();
 181
 182   // V8 generally calls into generated JS code with 5 parameters and into
 183   // generated RegExp code with 7 parameters. This is a convenience function,
 184   // which sets up the simulator state and grabs the result on return.
 185   int32_t Call(byte* entry, int argument_count, ...);
 186
 187   // Push an address onto the JS stack.
 188   uintptr_t PushAddress(uintptr_t address);
 189
 190   // Pop an address from the JS stack.
 191   uintptr_t PopAddress();
 192
 193   // ICache checking.
 194   static void FlushICache(void* start, size_t size);
 195
 196   // Returns true if pc register contains one of the 'special_values' defined
 197   // below (bad_lr, end_sim_pc).
 198   bool has_bad_pc() const;
 199
 200  private:
 201   enum special_values {
 202     // Known bad pc value to ensure that the simulator does not execute
 203     // without being properly setup.
 204     bad_lr = -1,
 205     // A pc value used to signal the simulator to stop execution.  Generally
 206     // the lr is set to this value on transition from native C code to
 207     // simulated execution, so that the simulator can "return" to the native
 208     // C code.
 209     end_sim_pc = -2
 210   };
 211
 212   // Unsupported instructions use Format to print an error and stop execution.
 213   void Format(Instruction* instr, const char* format);
 214
 215   // Checks if the current instruction should be executed based on its
 216   // condition bits.
 217   bool ConditionallyExecute(Instruction* instr);
 218
 219   // Helper functions to set the conditional flags in the architecture state.
 220   void SetNZFlags(int32_t val);
 221   void SetCFlag(bool val);
 222   void SetVFlag(bool val);
 223   bool CarryFrom(int32_t left, int32_t right);
 224   bool BorrowFrom(int32_t left, int32_t right);
 225   bool OverflowFrom(int32_t alu_out,
 226                     int32_t left,
 227                     int32_t right,
 228                     bool addition);
 229
 230   // Support for VFP.
 231   void Compute_FPSCR_Flags(double val1, double val2);
 232   void Copy_FPSCR_to_APSR();
 233
 234   // Helper functions to decode common "addressing" modes
 235   int32_t GetShiftRm(Instruction* instr, bool* carry_out);
 236   int32_t GetImm(Instruction* instr, bool* carry_out);
 237   void HandleRList(Instruction* instr, bool load);
 238   void SoftwareInterrupt(Instruction* instr);
 239
 240   // Stop helper functions.
 241   inline bool isStopInstruction(Instruction* instr);
 242   inline bool isWatchedStop(uint32_t bkpt_code);
 243   inline bool isEnabledStop(uint32_t bkpt_code);
 244   inline void EnableStop(uint32_t bkpt_code);
 245   inline void DisableStop(uint32_t bkpt_code);
 246   inline void IncreaseStopCounter(uint32_t bkpt_code);
 247   void PrintStopInfo(uint32_t code);
 248
 249   // Read and write memory.
 250   inline uint8_t ReadBU(int32_t addr);
 251   inline int8_t ReadB(int32_t addr);
 252   inline void WriteB(int32_t addr, uint8_t value);
 253   inline void WriteB(int32_t addr, int8_t value);
 254
 255   inline uint16_t ReadHU(int32_t addr, Instruction* instr);
 256   inline int16_t ReadH(int32_t addr, Instruction* instr);
 257   // Note: Overloaded on the sign of the value.
 258   inline void WriteH(int32_t addr, uint16_t value, Instruction* instr);
 259   inline void WriteH(int32_t addr, int16_t value, Instruction* instr);
 260
 261   inline int ReadW(int32_t addr, Instruction* instr);
 262   inline void WriteW(int32_t addr, int value, Instruction* instr);
 263
 264   int32_t* ReadDW(int32_t addr);
 265   void WriteDW(int32_t addr, int32_t value1, int32_t value2);
 266
 267   // Executing is handled based on the instruction type.
 268   // Both type 0 and type 1 rolled into one.
 269   void DecodeType01(Instruction* instr);
 270   void DecodeType2(Instruction* instr);
 271   void DecodeType3(Instruction* instr);
 272   void DecodeType4(Instruction* instr);
 273   void DecodeType5(Instruction* instr);
 274   void DecodeType6(Instruction* instr);
 275   void DecodeType7(Instruction* instr);
 276
 277   // Support for VFP.
 278   void DecodeTypeVFP(Instruction* instr);
 279   void DecodeType6CoprocessorIns(Instruction* instr);
 280
 281   void DecodeVMOVBetweenCoreAndSinglePrecisionRegisters(Instruction* instr);
 282   void DecodeVCMP(Instruction* instr);
 283   void DecodeVCVTBetweenDoubleAndSingle(Instruction* instr);
 284   void DecodeVCVTBetweenFloatingPointAndInteger(Instruction* instr);
 285
 286   // Executes one instruction.
 287   void InstructionDecode(Instruction* instr);
 288
 289   // ICache.
 290   static void CheckICache(Instruction* instr);
 291   static void FlushOnePage(intptr_t start, int size);
 292   static CachePage* GetCachePage(void* page);
 293
 294   // Runtime call support.
 295   static void* RedirectExternalReference(
 296       void* external_function,
 297       v8::internal::ExternalReference::Type type);
 298
 299   // For use in calls that take two double values, constructed from r0, r1, r2
 300   // and r3.
 301   void GetFpArgs(double* x, double* y);
 302   void SetFpResult(const double& result);
 303   void TrashCallerSaveRegisters();
 304
 305   // Architecture state.
 306   // Saturating instructions require a Q flag to indicate saturation.
 307   // There is currently no way to read the CPSR directly, and thus read the Q
 308   // flag, so this is left unimplemented.
 309   int32_t registers_[16];
 310   bool n_flag_;
 311   bool z_flag_;
 312   bool c_flag_;
 313   bool v_flag_;
 314
 315   // VFP architecture state.
 316   unsigned int vfp_register[num_s_registers];
 317   bool n_flag_FPSCR_;
 318   bool z_flag_FPSCR_;
 319   bool c_flag_FPSCR_;
 320   bool v_flag_FPSCR_;
 321
 322   // VFP rounding mode. See ARM DDI 0406B Page A2-29.
 323   VFPRoundingMode FPSCR_rounding_mode_;
 324
 325   // VFP FP exception flags architecture state.
 326   bool inv_op_vfp_flag_;
 327   bool div_zero_vfp_flag_;
 328   bool overflow_vfp_flag_;
 329   bool underflow_vfp_flag_;
 330   bool inexact_vfp_flag_;
 331
 332   // Simulator support.
 333   char* stack_;
 334   bool pc_modified_;
 335   int icount_;
 336   static bool initialized_;
 337
 338   // Icache simulation
 339   static v8::internal::HashMap* i_cache_;
 340
 341   // Registered breakpoints.
 342   Instruction* break_pc_;
 343   Instr break_instr_;
 344
 345   // A stop is watched if its code is less than kNumOfWatchedStops.
 346   // Only watched stops support enabling/disabling and the counter feature.
 347   static const uint32_t kNumOfWatchedStops = 256;
 348
 349   // Breakpoint is disabled if bit 31 is set.
 350   static const uint32_t kStopDisabledBit = 1 << 31;
 351
 352   // A stop is enabled, meaning the simulator will stop when meeting the
 353   // instruction, if bit 31 of watched_stops[code].count is unset.
 354   // The value watched_stops[code].count & ~(1 << 31) indicates how many times
 355   // the breakpoint was hit or gone through.
 356   struct StopCountAndDesc {
 357     uint32_t count;
 358     char* desc;
 359   };
 360   StopCountAndDesc watched_stops[kNumOfWatchedStops];
 361 };
 362
 363
 364 // When running with the simulator transition into simulated execution at this
 365 // point.
 366 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
 367   reinterpret_cast<Object*>(Simulator::current()->Call( \
 368       FUNCTION_ADDR(entry), 5, p0, p1, p2, p3, p4))
 369
 370 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6) \
 371   Simulator::current()->Call(entry, 8, p0, p1, p2, p3, NULL, p4, p5, p6)
 372
 373 #define TRY_CATCH_FROM_ADDRESS(try_catch_address) \
 374   try_catch_address == \
 375       NULL ? NULL : *(reinterpret_cast<TryCatch**>(try_catch_address))
 376
 377
 378 // The simulator has its own stack. Thus it has a different stack limit from
 379 // the C-based native code.  Setting the c_limit to indicate a very small
 380 // stack cause stack overflow errors, since the simulator ignores the input.
 381 // This is unlikely to be an issue in practice, though it might cause testing
 382 // trouble down the line.
 383 class SimulatorStack : public v8::internal::AllStatic {
 384  public:
 385   static inline uintptr_t JsLimitFromCLimit(uintptr_t c_limit) {
 386     return Simulator::current()->StackLimit();
 387   }
 388
 389   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
 390     Simulator* sim = Simulator::current();
 391     return sim->PushAddress(try_catch_address);
 392   }
 393
 394   static inline void UnregisterCTryCatch() {
 395     Simulator::current()->PopAddress();
 396   }
 397 };
 398
 399 } }  // namespace v8::internal
 400
 401 #endif  // !defined(USE_SIMULATOR)
 402 #endif  // V8_ARM_SIMULATOR_ARM_H_