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__)
  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 seven 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__)
  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
  93
  94 namespace assembler {
  95 namespace arm {
  96
  97 class Simulator {
  98  public:
  99   friend class Debugger;
 100
 101   enum Register {
 102     no_reg = -1,
 103     r0 = 0, r1, r2, r3, r4, r5, r6, r7,
 104     r8, r9, r10, r11, r12, r13, r14, r15,
 105     num_registers,
 106     sp = 13,
 107     lr = 14,
 108     pc = 15
 109   };
 110
 111   Simulator();
 112   ~Simulator();
 113
 114   // The currently executing Simulator instance. Potentially there can be one
 115   // for each native thread.
 116   static Simulator* current();
 117
 118   // Accessors for register state. Reading the pc value adheres to the ARM
 119   // architecture specification and is off by a 8 from the currently executing
 120   // instruction.
 121   void set_register(int reg, int32_t value);
 122   int32_t get_register(int reg) const;
 123
 124   // Special case of set_register and get_register to access the raw PC value.
 125   void set_pc(int32_t value);
 126   int32_t get_pc() const;
 127
 128   // Accessor to the internal simulator stack area.
 129   uintptr_t StackLimit() const;
 130
 131   // Executes ARM instructions until the PC reaches end_sim_pc.
 132   void Execute();
 133
 134   // Call on program start.
 135   static void Initialize();
 136
 137   // V8 generally calls into generated JS code with 5 parameters and into
 138   // generated RegExp code with 7 parameters. This is a convenience function,
 139   // which sets up the simulator state and grabs the result on return.
 140   int32_t Call(byte* entry, int argument_count, ...);
 141
 142   // Push an address onto the JS stack.
 143   uintptr_t PushAddress(uintptr_t address);
 144
 145   // Pop an address from the JS stack.
 146   uintptr_t PopAddress();
 147
 148  private:
 149   enum special_values {
 150     // Known bad pc value to ensure that the simulator does not execute
 151     // without being properly setup.
 152     bad_lr = -1,
 153     // A pc value used to signal the simulator to stop execution.  Generally
 154     // the lr is set to this value on transition from native C code to
 155     // simulated execution, so that the simulator can "return" to the native
 156     // C code.
 157     end_sim_pc = -2
 158   };
 159
 160   // Unsupported instructions use Format to print an error and stop execution.
 161   void Format(Instr* instr, const char* format);
 162
 163   // Checks if the current instruction should be executed based on its
 164   // condition bits.
 165   bool ConditionallyExecute(Instr* instr);
 166
 167   // Helper functions to set the conditional flags in the architecture state.
 168   void SetNZFlags(int32_t val);
 169   void SetCFlag(bool val);
 170   void SetVFlag(bool val);
 171   bool CarryFrom(int32_t left, int32_t right);
 172   bool BorrowFrom(int32_t left, int32_t right);
 173   bool OverflowFrom(int32_t alu_out,
 174                     int32_t left,
 175                     int32_t right,
 176                     bool addition);
 177
 178   // Helper functions to decode common "addressing" modes
 179   int32_t GetShiftRm(Instr* instr, bool* carry_out);
 180   int32_t GetImm(Instr* instr, bool* carry_out);
 181   void HandleRList(Instr* instr, bool load);
 182   void SoftwareInterrupt(Instr* instr);
 183
 184   // Read and write memory.
 185   inline uint8_t ReadBU(int32_t addr);
 186   inline int8_t ReadB(int32_t addr);
 187   inline void WriteB(int32_t addr, uint8_t value);
 188   inline void WriteB(int32_t addr, int8_t value);
 189
 190   inline uint16_t ReadHU(int32_t addr, Instr* instr);
 191   inline int16_t ReadH(int32_t addr, Instr* instr);
 192   // Note: Overloaded on the sign of the value.
 193   inline void WriteH(int32_t addr, uint16_t value, Instr* instr);
 194   inline void WriteH(int32_t addr, int16_t value, Instr* instr);
 195
 196   inline int ReadW(int32_t addr, Instr* instr);
 197   inline void WriteW(int32_t addr, int value, Instr* instr);
 198
 199   // Executing is handled based on the instruction type.
 200   void DecodeType01(Instr* instr);  // both type 0 and type 1 rolled into one
 201   void DecodeType2(Instr* instr);
 202   void DecodeType3(Instr* instr);
 203   void DecodeType4(Instr* instr);
 204   void DecodeType5(Instr* instr);
 205   void DecodeType6(Instr* instr);
 206   void DecodeType7(Instr* instr);
 207   void DecodeUnconditional(Instr* instr);
 208
 209   // Executes one instruction.
 210   void InstructionDecode(Instr* instr);
 211
 212   // Runtime call support.
 213   static void* RedirectExternalReference(void* external_function,
 214                                          bool fp_return);
 215
 216   // For use in calls that take two double values, constructed from r0, r1, r2
 217   // and r3.
 218   void GetFpArgs(double* x, double* y);
 219   void SetFpResult(const double& result);
 220   void TrashCallerSaveRegisters();
 221
 222   // Architecture state.
 223   int32_t registers_[16];
 224   bool n_flag_;
 225   bool z_flag_;
 226   bool c_flag_;
 227   bool v_flag_;
 228
 229   // Simulator support.
 230   char* stack_;
 231   bool pc_modified_;
 232   int icount_;
 233   static bool initialized_;
 234
 235   // Registered breakpoints.
 236   Instr* break_pc_;
 237   instr_t break_instr_;
 238 };
 239
 240 } }  // namespace assembler::arm
 241
 242
 243 // The simulator has its own stack. Thus it has a different stack limit from
 244 // the C-based native code.  Setting the c_limit to indicate a very small
 245 // stack cause stack overflow errors, since the simulator ignores the input.
 246 // This is unlikely to be an issue in practice, though it might cause testing
 247 // trouble down the line.
 248 class SimulatorStack : public v8::internal::AllStatic {
 249  public:
 250   static inline uintptr_t JsLimitFromCLimit(uintptr_t c_limit) {
 251     return assembler::arm::Simulator::current()->StackLimit();
 252   }
 253
 254   static inline uintptr_t RegisterCTryCatch(uintptr_t try_catch_address) {
 255     assembler::arm::Simulator* sim = assembler::arm::Simulator::current();
 256     return sim->PushAddress(try_catch_address);
 257   }
 258
 259   static inline void UnregisterCTryCatch() {
 260     assembler::arm::Simulator::current()->PopAddress();
 261   }
 262 };
 263
 264
 265 #endif  // defined(__arm__)
 266
 267 #endif  // V8_ARM_SIMULATOR_ARM_H_