src/arm/simulator-arm.h

   1 // Copyright 2012 the V8 project authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5
   6 // Declares a Simulator for ARM instructions if we are not generating a native
   7 // ARM binary. This Simulator allows us to run and debug ARM code generation on
   8 // regular desktop machines.
   9 // V8 calls into generated code by "calling" the CALL_GENERATED_CODE macro,
  10 // which will start execution in the Simulator or forwards to the real entry
  11 // on a ARM HW platform.
  12
  13 #ifndef V8_ARM_SIMULATOR_ARM_H_
  14 #define V8_ARM_SIMULATOR_ARM_H_
  15
  16 #include "src/allocation.h"
  17
  18 #if !defined(USE_SIMULATOR)
  19 // Running without a simulator on a native arm platform.
  20
  21 namespace v8 {
  22 namespace internal {
  23
  24 // When running without a simulator we call the entry directly.
  25 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
  26   (entry(p0, p1, p2, p3, p4))
  27
  28 typedef int (*arm_regexp_matcher)(String*, int, const byte*, const byte*,
  29                                   void*, int*, int, Address, int, Isolate*);
  30
  31
  32 // Call the generated regexp code directly. The code at the entry address
  33 // should act as a function matching the type arm_regexp_matcher.
  34 // The fifth argument is a dummy that reserves the space used for
  35 // the return address added by the ExitFrame in native calls.
  36 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6, p7, p8) \
  37   (FUNCTION_CAST<arm_regexp_matcher>(entry)(                              \
  38       p0, p1, p2, p3, NULL, p4, p5, p6, p7, p8))
  39
  40 // The stack limit beyond which we will throw stack overflow errors in
  41 // generated code. Because generated code on arm uses the C stack, we
  42 // just use the C stack limit.
  43 class SimulatorStack : public v8::internal::AllStatic {
  44  public:
  45   static inline uintptr_t JsLimitFromCLimit(v8::internal::Isolate* isolate,
  46                                             uintptr_t c_limit) {
  47     USE(isolate);
  48     return c_limit;
  49   }
  50
  51   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
  52     return try_catch_address;
  53   }
  54
  55   static inline void UnregisterCTryCatch() { }
  56 };
  57
  58 } }  // namespace v8::internal
  59
  60 #else  // !defined(USE_SIMULATOR)
  61 // Running with a simulator.
  62
  63 #include "src/arm/constants-arm.h"
  64 #include "src/assembler.h"
  65 #include "src/hashmap.h"
  66
  67 namespace v8 {
  68 namespace internal {
  69
  70 class CachePage {
  71  public:
  72   static const int LINE_VALID = 0;
  73   static const int LINE_INVALID = 1;
  74
  75   static const int kPageShift = 12;
  76   static const int kPageSize = 1 << kPageShift;
  77   static const int kPageMask = kPageSize - 1;
  78   static const int kLineShift = 2;  // The cache line is only 4 bytes right now.
  79   static const int kLineLength = 1 << kLineShift;
  80   static const int kLineMask = kLineLength - 1;
  81
  82   CachePage() {
  83     memset(&validity_map_, LINE_INVALID, sizeof(validity_map_));
  84   }
  85
  86   char* ValidityByte(int offset) {
  87     return &validity_map_[offset >> kLineShift];
  88   }
  89
  90   char* CachedData(int offset) {
  91     return &data_[offset];
  92   }
  93
  94  private:
  95   char data_[kPageSize];   // The cached data.
  96   static const int kValidityMapSize = kPageSize >> kLineShift;
  97   char validity_map_[kValidityMapSize];  // One byte per line.
  98 };
  99
 100
 101 class Simulator {
 102  public:
 103   friend class ArmDebugger;
 104   enum Register {
 105     no_reg = -1,
 106     r0 = 0, r1, r2, r3, r4, r5, r6, r7,
 107     r8, r9, r10, r11, r12, r13, r14, r15,
 108     num_registers,
 109     sp = 13,
 110     lr = 14,
 111     pc = 15,
 112     s0 = 0, s1, s2, s3, s4, s5, s6, s7,
 113     s8, s9, s10, s11, s12, s13, s14, s15,
 114     s16, s17, s18, s19, s20, s21, s22, s23,
 115     s24, s25, s26, s27, s28, s29, s30, s31,
 116     num_s_registers = 32,
 117     d0 = 0, d1, d2, d3, d4, d5, d6, d7,
 118     d8, d9, d10, d11, d12, d13, d14, d15,
 119     d16, d17, d18, d19, d20, d21, d22, d23,
 120     d24, d25, d26, d27, d28, d29, d30, d31,
 121     num_d_registers = 32,
 122     q0 = 0, q1, q2, q3, q4, q5, q6, q7,
 123     q8, q9, q10, q11, q12, q13, q14, q15,
 124     num_q_registers = 16
 125   };
 126
 127   explicit Simulator(Isolate* isolate);
 128   ~Simulator();
 129
 130   // The currently executing Simulator instance. Potentially there can be one
 131   // for each native thread.
 132   static Simulator* current(v8::internal::Isolate* isolate);
 133
 134   // Accessors for register state. Reading the pc value adheres to the ARM
 135   // architecture specification and is off by a 8 from the currently executing
 136   // instruction.
 137   void set_register(int reg, int32_t value);
 138   int32_t get_register(int reg) const;
 139   double get_double_from_register_pair(int reg);
 140   void set_register_pair_from_double(int reg, double* value);
 141   void set_dw_register(int dreg, const int* dbl);
 142
 143   // Support for VFP.
 144   void get_d_register(int dreg, uint64_t* value);
 145   void set_d_register(int dreg, const uint64_t* value);
 146   void get_d_register(int dreg, uint32_t* value);
 147   void set_d_register(int dreg, const uint32_t* value);
 148   void get_q_register(int qreg, uint64_t* value);
 149   void set_q_register(int qreg, const uint64_t* value);
 150   void get_q_register(int qreg, uint32_t* value);
 151   void set_q_register(int qreg, const uint32_t* value);
 152
 153   void set_s_register(int reg, unsigned int value);
 154   unsigned int get_s_register(int reg) const;
 155
 156   void set_d_register_from_double(int dreg, const double& dbl) {
 157     SetVFPRegister<double, 2>(dreg, dbl);
 158   }
 159
 160   double get_double_from_d_register(int dreg) {
 161     return GetFromVFPRegister<double, 2>(dreg);
 162   }
 163
 164   void set_s_register_from_float(int sreg, const float flt) {
 165     SetVFPRegister<float, 1>(sreg, flt);
 166   }
 167
 168   float get_float_from_s_register(int sreg) {
 169     return GetFromVFPRegister<float, 1>(sreg);
 170   }
 171
 172   void set_s_register_from_sinteger(int sreg, const int sint) {
 173     SetVFPRegister<int, 1>(sreg, sint);
 174   }
 175
 176   int get_sinteger_from_s_register(int sreg) {
 177     return GetFromVFPRegister<int, 1>(sreg);
 178   }
 179
 180   // Special case of set_register and get_register to access the raw PC value.
 181   void set_pc(int32_t value);
 182   int32_t get_pc() const;
 183
 184   Address get_sp() {
 185     return reinterpret_cast<Address>(static_cast<intptr_t>(get_register(sp)));
 186   }
 187
 188   // Accessor to the internal simulator stack area.
 189   uintptr_t StackLimit() const;
 190
 191   // Executes ARM instructions until the PC reaches end_sim_pc.
 192   void Execute();
 193
 194   // Call on program start.
 195   static void Initialize(Isolate* isolate);
 196
 197   static void TearDown(HashMap* i_cache, Redirection* first);
 198
 199   // V8 generally calls into generated JS code with 5 parameters and into
 200   // generated RegExp code with 7 parameters. This is a convenience function,
 201   // which sets up the simulator state and grabs the result on return.
 202   int32_t Call(byte* entry, int argument_count, ...);
 203   // Alternative: call a 2-argument double function.
 204   void CallFP(byte* entry, double d0, double d1);
 205   int32_t CallFPReturnsInt(byte* entry, double d0, double d1);
 206   double CallFPReturnsDouble(byte* entry, double d0, double d1);
 207
 208   // Push an address onto the JS stack.
 209   uintptr_t PushAddress(uintptr_t address);
 210
 211   // Pop an address from the JS stack.
 212   uintptr_t PopAddress();
 213
 214   // Debugger input.
 215   void set_last_debugger_input(char* input);
 216   char* last_debugger_input() { return last_debugger_input_; }
 217
 218   // ICache checking.
 219   static void FlushICache(v8::internal::HashMap* i_cache, void* start,
 220                           size_t size);
 221
 222   // Returns true if pc register contains one of the 'special_values' defined
 223   // below (bad_lr, end_sim_pc).
 224   bool has_bad_pc() const;
 225
 226   // EABI variant for double arguments in use.
 227   bool use_eabi_hardfloat() {
 228 #if USE_EABI_HARDFLOAT
 229     return true;
 230 #else
 231     return false;
 232 #endif
 233   }
 234
 235  private:
 236   enum special_values {
 237     // Known bad pc value to ensure that the simulator does not execute
 238     // without being properly setup.
 239     bad_lr = -1,
 240     // A pc value used to signal the simulator to stop execution.  Generally
 241     // the lr is set to this value on transition from native C code to
 242     // simulated execution, so that the simulator can "return" to the native
 243     // C code.
 244     end_sim_pc = -2
 245   };
 246
 247   // Unsupported instructions use Format to print an error and stop execution.
 248   void Format(Instruction* instr, const char* format);
 249
 250   // Checks if the current instruction should be executed based on its
 251   // condition bits.
 252   inline bool ConditionallyExecute(Instruction* instr);
 253
 254   // Helper functions to set the conditional flags in the architecture state.
 255   void SetNZFlags(int32_t val);
 256   void SetCFlag(bool val);
 257   void SetVFlag(bool val);
 258   bool CarryFrom(int32_t left, int32_t right, int32_t carry = 0);
 259   bool BorrowFrom(int32_t left, int32_t right);
 260   bool OverflowFrom(int32_t alu_out,
 261                     int32_t left,
 262                     int32_t right,
 263                     bool addition);
 264
 265   inline int GetCarry() {
 266     return c_flag_ ? 1 : 0;
 267   }
 268
 269   // Support for VFP.
 270   void Compute_FPSCR_Flags(float val1, float val2);
 271   void Compute_FPSCR_Flags(double val1, double val2);
 272   void Copy_FPSCR_to_APSR();
 273   inline float canonicalizeNaN(float value);
 274   inline double canonicalizeNaN(double value);
 275
 276   // Helper functions to decode common "addressing" modes
 277   int32_t GetShiftRm(Instruction* instr, bool* carry_out);
 278   int32_t GetImm(Instruction* instr, bool* carry_out);
 279   int32_t ProcessPU(Instruction* instr,
 280                     int num_regs,
 281                     int operand_size,
 282                     intptr_t* start_address,
 283                     intptr_t* end_address);
 284   void HandleRList(Instruction* instr, bool load);
 285   void HandleVList(Instruction* inst);
 286   void SoftwareInterrupt(Instruction* instr);
 287
 288   // Stop helper functions.
 289   inline bool isStopInstruction(Instruction* instr);
 290   inline bool isWatchedStop(uint32_t bkpt_code);
 291   inline bool isEnabledStop(uint32_t bkpt_code);
 292   inline void EnableStop(uint32_t bkpt_code);
 293   inline void DisableStop(uint32_t bkpt_code);
 294   inline void IncreaseStopCounter(uint32_t bkpt_code);
 295   void PrintStopInfo(uint32_t code);
 296
 297   // Read and write memory.
 298   inline uint8_t ReadBU(int32_t addr);
 299   inline int8_t ReadB(int32_t addr);
 300   inline void WriteB(int32_t addr, uint8_t value);
 301   inline void WriteB(int32_t addr, int8_t value);
 302
 303   inline uint16_t ReadHU(int32_t addr, Instruction* instr);
 304   inline int16_t ReadH(int32_t addr, Instruction* instr);
 305   // Note: Overloaded on the sign of the value.
 306   inline void WriteH(int32_t addr, uint16_t value, Instruction* instr);
 307   inline void WriteH(int32_t addr, int16_t value, Instruction* instr);
 308
 309   inline int ReadW(int32_t addr, Instruction* instr);
 310   inline void WriteW(int32_t addr, int value, Instruction* instr);
 311
 312   int32_t* ReadDW(int32_t addr);
 313   void WriteDW(int32_t addr, int32_t value1, int32_t value2);
 314
 315   // Executing is handled based on the instruction type.
 316   // Both type 0 and type 1 rolled into one.
 317   void DecodeType01(Instruction* instr);
 318   void DecodeType2(Instruction* instr);
 319   void DecodeType3(Instruction* instr);
 320   void DecodeType4(Instruction* instr);
 321   void DecodeType5(Instruction* instr);
 322   void DecodeType6(Instruction* instr);
 323   void DecodeType7(Instruction* instr);
 324
 325   // Support for VFP.
 326   void DecodeTypeVFP(Instruction* instr);
 327   void DecodeType6CoprocessorIns(Instruction* instr);
 328   void DecodeSpecialCondition(Instruction* instr);
 329
 330   void DecodeVMOVBetweenCoreAndSinglePrecisionRegisters(Instruction* instr);
 331   void DecodeVCMP(Instruction* instr);
 332   void DecodeVCVTBetweenDoubleAndSingle(Instruction* instr);
 333   void DecodeVCVTBetweenFloatingPointAndInteger(Instruction* instr);
 334
 335   // Executes one instruction.
 336   void InstructionDecode(Instruction* instr);
 337
 338   // ICache.
 339   static void CheckICache(v8::internal::HashMap* i_cache, Instruction* instr);
 340   static void FlushOnePage(v8::internal::HashMap* i_cache, intptr_t start,
 341                            int size);
 342   static CachePage* GetCachePage(v8::internal::HashMap* i_cache, void* page);
 343
 344   // Runtime call support.
 345   static void* RedirectExternalReference(
 346       void* external_function,
 347       v8::internal::ExternalReference::Type type);
 348
 349   // Handle arguments and return value for runtime FP functions.
 350   void GetFpArgs(double* x, double* y, int32_t* z);
 351   void SetFpResult(const double& result);
 352   void TrashCallerSaveRegisters();
 353
 354   template<class ReturnType, int register_size>
 355       ReturnType GetFromVFPRegister(int reg_index);
 356
 357   template<class InputType, int register_size>
 358       void SetVFPRegister(int reg_index, const InputType& value);
 359
 360   void CallInternal(byte* entry);
 361
 362   // Architecture state.
 363   // Saturating instructions require a Q flag to indicate saturation.
 364   // There is currently no way to read the CPSR directly, and thus read the Q
 365   // flag, so this is left unimplemented.
 366   int32_t registers_[16];
 367   bool n_flag_;
 368   bool z_flag_;
 369   bool c_flag_;
 370   bool v_flag_;
 371
 372   // VFP architecture state.
 373   unsigned int vfp_registers_[num_d_registers * 2];
 374   bool n_flag_FPSCR_;
 375   bool z_flag_FPSCR_;
 376   bool c_flag_FPSCR_;
 377   bool v_flag_FPSCR_;
 378
 379   // VFP rounding mode. See ARM DDI 0406B Page A2-29.
 380   VFPRoundingMode FPSCR_rounding_mode_;
 381   bool FPSCR_default_NaN_mode_;
 382
 383   // VFP FP exception flags architecture state.
 384   bool inv_op_vfp_flag_;
 385   bool div_zero_vfp_flag_;
 386   bool overflow_vfp_flag_;
 387   bool underflow_vfp_flag_;
 388   bool inexact_vfp_flag_;
 389
 390   // Simulator support.
 391   char* stack_;
 392   bool pc_modified_;
 393   int icount_;
 394
 395   // Debugger input.
 396   char* last_debugger_input_;
 397
 398   // Icache simulation
 399   v8::internal::HashMap* i_cache_;
 400
 401   // Registered breakpoints.
 402   Instruction* break_pc_;
 403   Instr break_instr_;
 404
 405   v8::internal::Isolate* isolate_;
 406
 407   // A stop is watched if its code is less than kNumOfWatchedStops.
 408   // Only watched stops support enabling/disabling and the counter feature.
 409   static const uint32_t kNumOfWatchedStops = 256;
 410
 411   // Breakpoint is disabled if bit 31 is set.
 412   static const uint32_t kStopDisabledBit = 1 << 31;
 413
 414   // A stop is enabled, meaning the simulator will stop when meeting the
 415   // instruction, if bit 31 of watched_stops_[code].count is unset.
 416   // The value watched_stops_[code].count & ~(1 << 31) indicates how many times
 417   // the breakpoint was hit or gone through.
 418   struct StopCountAndDesc {
 419     uint32_t count;
 420     char* desc;
 421   };
 422   StopCountAndDesc watched_stops_[kNumOfWatchedStops];
 423 };
 424
 425
 426 // When running with the simulator transition into simulated execution at this
 427 // point.
 428 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
 429   reinterpret_cast<Object*>(Simulator::current(Isolate::Current())->Call( \
 430       FUNCTION_ADDR(entry), 5, p0, p1, p2, p3, p4))
 431
 432 #define CALL_GENERATED_FP_INT(entry, p0, p1) \
 433   Simulator::current(Isolate::Current())->CallFPReturnsInt( \
 434       FUNCTION_ADDR(entry), p0, p1)
 435
 436 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6, p7, p8) \
 437   Simulator::current(Isolate::Current())->Call( \
 438       entry, 10, p0, p1, p2, p3, NULL, p4, p5, p6, p7, p8)
 439
 440
 441 // The simulator has its own stack. Thus it has a different stack limit from
 442 // the C-based native code.  Setting the c_limit to indicate a very small
 443 // stack cause stack overflow errors, since the simulator ignores the input.
 444 // This is unlikely to be an issue in practice, though it might cause testing
 445 // trouble down the line.
 446 class SimulatorStack : public v8::internal::AllStatic {
 447  public:
 448   static inline uintptr_t JsLimitFromCLimit(v8::internal::Isolate* isolate,
 449                                             uintptr_t c_limit) {
 450     return Simulator::current(isolate)->StackLimit();
 451   }
 452
 453   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
 454     Simulator* sim = Simulator::current(Isolate::Current());
 455     return sim->PushAddress(try_catch_address);
 456   }
 457
 458   static inline void UnregisterCTryCatch() {
 459     Simulator::current(Isolate::Current())->PopAddress();
 460   }
 461 };
 462
 463 } }  // namespace v8::internal
 464
 465 #endif  // !defined(USE_SIMULATOR)
 466 #endif  // V8_ARM_SIMULATOR_ARM_H_