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(__arm__) && !defined(USE_SIMULATOR)
  42
  43 // When running without a simulator we call the entry directly.
  44 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
  45   (entry(p0, p1, p2, p3, p4))
  46
  47 // The stack limit beyond which we will throw stack overflow errors in
  48 // generated code. Because generated code on arm uses the C stack, we
  49 // just use the C stack limit.
  50 class SimulatorStack : public v8::internal::AllStatic {
  51  public:
  52   static inline uintptr_t JsLimitFromCLimit(uintptr_t c_limit) {
  53     return c_limit;
  54   }
  55
  56   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
  57     return try_catch_address;
  58   }
  59
  60   static inline void UnregisterCTryCatch() { }
  61 };
  62
  63
  64 // Call the generated regexp code directly. The entry function pointer should
  65 // expect eight int/pointer sized arguments and return an int.
  66 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6) \
  67   entry(p0, p1, p2, p3, p4, p5, p6)
  68
  69 #define TRY_CATCH_FROM_ADDRESS(try_catch_address) \
  70   reinterpret_cast<TryCatch*>(try_catch_address)
  71
  72
  73 #else  // !defined(__arm__) || defined(USE_SIMULATOR)
  74
  75 // When running with the simulator transition into simulated execution at this
  76 // point.
  77 #define CALL_GENERATED_CODE(entry, p0, p1, p2, p3, p4) \
  78   reinterpret_cast<Object*>( \
  79       assembler::arm::Simulator::current()->Call(FUNCTION_ADDR(entry), 5, \
  80                                                  p0, p1, p2, p3, p4))
  81
  82 #define CALL_GENERATED_REGEXP_CODE(entry, p0, p1, p2, p3, p4, p5, p6) \
  83   assembler::arm::Simulator::current()->Call( \
  84     FUNCTION_ADDR(entry), 7, p0, p1, p2, p3, p4, p5, p6)
  85
  86 #define TRY_CATCH_FROM_ADDRESS(try_catch_address) \
  87   try_catch_address == NULL ? \
  88       NULL : *(reinterpret_cast<TryCatch**>(try_catch_address))
  89
  90
  91 #include "constants-arm.h"
  92 #include "hashmap.h"
  93
  94
  95 namespace assembler {
  96 namespace arm {
  97
  98 class CachePage {
  99  public:
 100   static const int LINE_VALID = 0;
 101   static const int LINE_INVALID = 1;
 102
 103   static const int kPageShift = 12;
 104   static const int kPageSize = 1 << kPageShift;
 105   static const int kPageMask = kPageSize - 1;
 106   static const int kLineShift = 2;  // The cache line is only 4 bytes right now.
 107   static const int kLineLength = 1 << kLineShift;
 108   static const int kLineMask = kLineLength - 1;
 109
 110   CachePage() {
 111     memset(&validity_map_, LINE_INVALID, sizeof(validity_map_));
 112   }
 113
 114   char* ValidityByte(int offset) {
 115     return &validity_map_[offset >> kLineShift];
 116   }
 117
 118   char* CachedData(int offset) {
 119     return &data_[offset];
 120   }
 121
 122  private:
 123   char data_[kPageSize];   // The cached data.
 124   static const int kValidityMapSize = kPageSize >> kLineShift;
 125   char validity_map_[kValidityMapSize];  // One byte per line.
 126 };
 127
 128
 129 class Simulator {
 130  public:
 131   friend class Debugger;
 132   enum Register {
 133     no_reg = -1,
 134     r0 = 0, r1, r2, r3, r4, r5, r6, r7,
 135     r8, r9, r10, r11, r12, r13, r14, r15,
 136     num_registers,
 137     sp = 13,
 138     lr = 14,
 139     pc = 15,
 140     s0 = 0, s1, s2, s3, s4, s5, s6, s7,
 141     s8, s9, s10, s11, s12, s13, s14, s15,
 142     s16, s17, s18, s19, s20, s21, s22, s23,
 143     s24, s25, s26, s27, s28, s29, s30, s31,
 144     num_s_registers = 32,
 145     d0 = 0, d1, d2, d3, d4, d5, d6, d7,
 146     d8, d9, d10, d11, d12, d13, d14, d15,
 147     num_d_registers = 16
 148   };
 149
 150   Simulator();
 151   ~Simulator();
 152
 153   // The currently executing Simulator instance. Potentially there can be one
 154   // for each native thread.
 155   static Simulator* current();
 156
 157   // Accessors for register state. Reading the pc value adheres to the ARM
 158   // architecture specification and is off by a 8 from the currently executing
 159   // instruction.
 160   void set_register(int reg, int32_t value);
 161   int32_t get_register(int reg) const;
 162   void set_dw_register(int dreg, const int* dbl);
 163
 164   // Support for VFP.
 165   void set_s_register(int reg, unsigned int value);
 166   unsigned int get_s_register(int reg) const;
 167   void set_d_register_from_double(int dreg, const double& dbl);
 168   double get_double_from_d_register(int dreg);
 169   void set_s_register_from_float(int sreg, const float dbl);
 170   float get_float_from_s_register(int sreg);
 171   void set_s_register_from_sinteger(int reg, const int value);
 172   int get_sinteger_from_s_register(int reg);
 173
 174   // Special case of set_register and get_register to access the raw PC value.
 175   void set_pc(int32_t value);
 176   int32_t get_pc() const;
 177
 178   // Accessor to the internal simulator stack area.
 179   uintptr_t StackLimit() const;
 180
 181   // Executes ARM instructions until the PC reaches end_sim_pc.
 182   void Execute();
 183
 184   // Call on program start.
 185   static void Initialize();
 186
 187   // V8 generally calls into generated JS code with 5 parameters and into
 188   // generated RegExp code with 7 parameters. This is a convenience function,
 189   // which sets up the simulator state and grabs the result on return.
 190   int32_t Call(byte* entry, int argument_count, ...);
 191
 192   // Push an address onto the JS stack.
 193   uintptr_t PushAddress(uintptr_t address);
 194
 195   // Pop an address from the JS stack.
 196   uintptr_t PopAddress();
 197
 198   // ICache checking.
 199   static void FlushICache(void* start, size_t size);
 200
 201  private:
 202   enum special_values {
 203     // Known bad pc value to ensure that the simulator does not execute
 204     // without being properly setup.
 205     bad_lr = -1,
 206     // A pc value used to signal the simulator to stop execution.  Generally
 207     // the lr is set to this value on transition from native C code to
 208     // simulated execution, so that the simulator can "return" to the native
 209     // C code.
 210     end_sim_pc = -2
 211   };
 212
 213   // Unsupported instructions use Format to print an error and stop execution.
 214   void Format(Instr* instr, const char* format);
 215
 216   // Checks if the current instruction should be executed based on its
 217   // condition bits.
 218   bool ConditionallyExecute(Instr* instr);
 219
 220   // Helper functions to set the conditional flags in the architecture state.
 221   void SetNZFlags(int32_t val);
 222   void SetCFlag(bool val);
 223   void SetVFlag(bool val);
 224   bool CarryFrom(int32_t left, int32_t right);
 225   bool BorrowFrom(int32_t left, int32_t right);
 226   bool OverflowFrom(int32_t alu_out,
 227                     int32_t left,
 228                     int32_t right,
 229                     bool addition);
 230
 231   // Support for VFP.
 232   void Compute_FPSCR_Flags(double val1, double val2);
 233   void Copy_FPSCR_to_APSR();
 234
 235   // Helper functions to decode common "addressing" modes
 236   int32_t GetShiftRm(Instr* instr, bool* carry_out);
 237   int32_t GetImm(Instr* instr, bool* carry_out);
 238   void HandleRList(Instr* instr, bool load);
 239   void SoftwareInterrupt(Instr* instr);
 240
 241   // Read and write memory.
 242   inline uint8_t ReadBU(int32_t addr);
 243   inline int8_t ReadB(int32_t addr);
 244   inline void WriteB(int32_t addr, uint8_t value);
 245   inline void WriteB(int32_t addr, int8_t value);
 246
 247   inline uint16_t ReadHU(int32_t addr, Instr* instr);
 248   inline int16_t ReadH(int32_t addr, Instr* instr);
 249   // Note: Overloaded on the sign of the value.
 250   inline void WriteH(int32_t addr, uint16_t value, Instr* instr);
 251   inline void WriteH(int32_t addr, int16_t value, Instr* instr);
 252
 253   inline int ReadW(int32_t addr, Instr* instr);
 254   inline void WriteW(int32_t addr, int value, Instr* instr);
 255
 256   int32_t* ReadDW(int32_t addr);
 257   void WriteDW(int32_t addr, int32_t value1, int32_t value2);
 258
 259   // Executing is handled based on the instruction type.
 260   void DecodeType01(Instr* instr);  // both type 0 and type 1 rolled into one
 261   void DecodeType2(Instr* instr);
 262   void DecodeType3(Instr* instr);
 263   void DecodeType4(Instr* instr);
 264   void DecodeType5(Instr* instr);
 265   void DecodeType6(Instr* instr);
 266   void DecodeType7(Instr* instr);
 267   void DecodeUnconditional(Instr* instr);
 268
 269   // Support for VFP.
 270   void DecodeTypeVFP(Instr* instr);
 271   void DecodeType6CoprocessorIns(Instr* instr);
 272
 273   void DecodeVMOVBetweenCoreAndSinglePrecisionRegisters(Instr* instr);
 274   void DecodeVCMP(Instr* instr);
 275   void DecodeVCVTBetweenDoubleAndSingle(Instr* instr);
 276   void DecodeVCVTBetweenFloatingPointAndInteger(Instr* instr);
 277
 278   // Executes one instruction.
 279   void InstructionDecode(Instr* instr);
 280
 281   // ICache.
 282   static void CheckICache(Instr* instr);
 283   static void FlushOnePage(intptr_t start, int size);
 284   static CachePage* GetCachePage(void* page);
 285
 286   // Runtime call support.
 287   static void* RedirectExternalReference(void* external_function,
 288                                          bool fp_return);
 289
 290   // For use in calls that take two double values, constructed from r0, r1, r2
 291   // and r3.
 292   void GetFpArgs(double* x, double* y);
 293   void SetFpResult(const double& result);
 294   void TrashCallerSaveRegisters();
 295
 296   // Architecture state.
 297   // Saturating instructions require a Q flag to indicate saturation.
 298   // There is currently no way to read the CPSR directly, and thus read the Q
 299   // flag, so this is left unimplemented.
 300   int32_t registers_[16];
 301   bool n_flag_;
 302   bool z_flag_;
 303   bool c_flag_;
 304   bool v_flag_;
 305
 306   // VFP architecture state.
 307   unsigned int vfp_register[num_s_registers];
 308   bool n_flag_FPSCR_;
 309   bool z_flag_FPSCR_;
 310   bool c_flag_FPSCR_;
 311   bool v_flag_FPSCR_;
 312
 313   // VFP FP exception flags architecture state.
 314   bool inv_op_vfp_flag_;
 315   bool div_zero_vfp_flag_;
 316   bool overflow_vfp_flag_;
 317   bool underflow_vfp_flag_;
 318   bool inexact_vfp_flag_;
 319
 320   // Simulator support.
 321   char* stack_;
 322   bool pc_modified_;
 323   int icount_;
 324   static bool initialized_;
 325
 326   // Icache simulation
 327   static v8::internal::HashMap* i_cache_;
 328
 329   // Registered breakpoints.
 330   Instr* break_pc_;
 331   instr_t break_instr_;
 332 };
 333
 334 } }  // namespace assembler::arm
 335
 336
 337 // The simulator has its own stack. Thus it has a different stack limit from
 338 // the C-based native code.  Setting the c_limit to indicate a very small
 339 // stack cause stack overflow errors, since the simulator ignores the input.
 340 // This is unlikely to be an issue in practice, though it might cause testing
 341 // trouble down the line.
 342 class SimulatorStack : public v8::internal::AllStatic {
 343  public:
 344   static inline uintptr_t JsLimitFromCLimit(uintptr_t c_limit) {
 345     return assembler::arm::Simulator::current()->StackLimit();
 346   }
 347
 348   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
 349     assembler::arm::Simulator* sim = assembler::arm::Simulator::current();
 350     return sim->PushAddress(try_catch_address);
 351   }
 352
 353   static inline void UnregisterCTryCatch() {
 354     assembler::arm::Simulator::current()->PopAddress();
 355   }
 356 };
 357
 358
 359 #endif  // !defined(__arm__) || defined(USE_SIMULATOR)
 360
 361 #endif  // V8_ARM_SIMULATOR_ARM_H_