regexp-macro-assembler-arm.h revision eab96aab0834f21954b5d6aa6366bcfb348ed811
1// Copyright 2006-2008 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#ifndef V8_ARM_REGEXP_MACRO_ASSEMBLER_ARM_H_ 29#define V8_ARM_REGEXP_MACRO_ASSEMBLER_ARM_H_ 30 31namespace v8 { 32namespace internal { 33 34 35#ifndef V8_NATIVE_REGEXP 36class RegExpMacroAssemblerARM: public RegExpMacroAssembler { 37 public: 38 RegExpMacroAssemblerARM(); 39 virtual ~RegExpMacroAssemblerARM(); 40}; 41 42#else 43class RegExpMacroAssemblerARM: public NativeRegExpMacroAssembler { 44 public: 45 RegExpMacroAssemblerARM(Mode mode, int registers_to_save); 46 virtual ~RegExpMacroAssemblerARM(); 47 virtual int stack_limit_slack(); 48 virtual void AdvanceCurrentPosition(int by); 49 virtual void AdvanceRegister(int reg, int by); 50 virtual void Backtrack(); 51 virtual void Bind(Label* label); 52 virtual void CheckAtStart(Label* on_at_start); 53 virtual void CheckCharacter(uint32_t c, Label* on_equal); 54 virtual void CheckCharacterAfterAnd(uint32_t c, 55 uint32_t mask, 56 Label* on_equal); 57 virtual void CheckCharacterGT(uc16 limit, Label* on_greater); 58 virtual void CheckCharacterLT(uc16 limit, Label* on_less); 59 virtual void CheckCharacters(Vector<const uc16> str, 60 int cp_offset, 61 Label* on_failure, 62 bool check_end_of_string); 63 // A "greedy loop" is a loop that is both greedy and with a simple 64 // body. It has a particularly simple implementation. 65 virtual void CheckGreedyLoop(Label* on_tos_equals_current_position); 66 virtual void CheckNotAtStart(Label* on_not_at_start); 67 virtual void CheckNotBackReference(int start_reg, Label* on_no_match); 68 virtual void CheckNotBackReferenceIgnoreCase(int start_reg, 69 Label* on_no_match); 70 virtual void CheckNotRegistersEqual(int reg1, int reg2, Label* on_not_equal); 71 virtual void CheckNotCharacter(uint32_t c, Label* on_not_equal); 72 virtual void CheckNotCharacterAfterAnd(uint32_t c, 73 uint32_t mask, 74 Label* on_not_equal); 75 virtual void CheckNotCharacterAfterMinusAnd(uc16 c, 76 uc16 minus, 77 uc16 mask, 78 Label* on_not_equal); 79 // Checks whether the given offset from the current position is before 80 // the end of the string. 81 virtual void CheckPosition(int cp_offset, Label* on_outside_input); 82 virtual bool CheckSpecialCharacterClass(uc16 type, 83 Label* on_no_match); 84 virtual void Fail(); 85 virtual Handle<Object> GetCode(Handle<String> source); 86 virtual void GoTo(Label* label); 87 virtual void IfRegisterGE(int reg, int comparand, Label* if_ge); 88 virtual void IfRegisterLT(int reg, int comparand, Label* if_lt); 89 virtual void IfRegisterEqPos(int reg, Label* if_eq); 90 virtual IrregexpImplementation Implementation(); 91 virtual void LoadCurrentCharacter(int cp_offset, 92 Label* on_end_of_input, 93 bool check_bounds = true, 94 int characters = 1); 95 virtual void PopCurrentPosition(); 96 virtual void PopRegister(int register_index); 97 virtual void PushBacktrack(Label* label); 98 virtual void PushCurrentPosition(); 99 virtual void PushRegister(int register_index, 100 StackCheckFlag check_stack_limit); 101 virtual void ReadCurrentPositionFromRegister(int reg); 102 virtual void ReadStackPointerFromRegister(int reg); 103 virtual void SetRegister(int register_index, int to); 104 virtual void Succeed(); 105 virtual void WriteCurrentPositionToRegister(int reg, int cp_offset); 106 virtual void ClearRegisters(int reg_from, int reg_to); 107 virtual void WriteStackPointerToRegister(int reg); 108 109 // Called from RegExp if the stack-guard is triggered. 110 // If the code object is relocated, the return address is fixed before 111 // returning. 112 static int CheckStackGuardState(Address* return_address, 113 Code* re_code, 114 Address re_frame); 115 private: 116 // Offsets from frame_pointer() of function parameters and stored registers. 117 static const int kFramePointer = 0; 118 119 // Above the frame pointer - Stored registers and stack passed parameters. 120 // Register 4..11. 121 static const int kStoredRegisters = kFramePointer; 122 // Return address (stored from link register, read into pc on return). 123 static const int kReturnAddress = kStoredRegisters + 8 * kPointerSize; 124 // Stack parameters placed by caller. 125 static const int kRegisterOutput = kReturnAddress + kPointerSize; 126 static const int kAtStart = kRegisterOutput + kPointerSize; 127 static const int kStackHighEnd = kAtStart + kPointerSize; 128 static const int kDirectCall = kStackHighEnd + kPointerSize; 129 130 // Below the frame pointer. 131 // Register parameters stored by setup code. 132 static const int kInputEnd = kFramePointer - kPointerSize; 133 static const int kInputStart = kInputEnd - kPointerSize; 134 static const int kStartIndex = kInputStart - kPointerSize; 135 static const int kInputString = kStartIndex - kPointerSize; 136 // When adding local variables remember to push space for them in 137 // the frame in GetCode. 138 static const int kInputStartMinusOne = kInputString - kPointerSize; 139 // First register address. Following registers are below it on the stack. 140 static const int kRegisterZero = kInputStartMinusOne - kPointerSize; 141 142 // Initial size of code buffer. 143 static const size_t kRegExpCodeSize = 1024; 144 145 static const int kBacktrackConstantPoolSize = 4; 146 147 // Load a number of characters at the given offset from the 148 // current position, into the current-character register. 149 void LoadCurrentCharacterUnchecked(int cp_offset, int character_count); 150 151 // Check whether preemption has been requested. 152 void CheckPreemption(); 153 154 // Check whether we are exceeding the stack limit on the backtrack stack. 155 void CheckStackLimit(); 156 157 void EmitBacktrackConstantPool(); 158 int GetBacktrackConstantPoolEntry(); 159 160 161 // Generate a call to CheckStackGuardState. 162 void CallCheckStackGuardState(Register scratch); 163 164 // The ebp-relative location of a regexp register. 165 MemOperand register_location(int register_index); 166 167 // Register holding the current input position as negative offset from 168 // the end of the string. 169 inline Register current_input_offset() { return r6; } 170 171 // The register containing the current character after LoadCurrentCharacter. 172 inline Register current_character() { return r7; } 173 174 // Register holding address of the end of the input string. 175 inline Register end_of_input_address() { return r10; } 176 177 // Register holding the frame address. Local variables, parameters and 178 // regexp registers are addressed relative to this. 179 inline Register frame_pointer() { return fp; } 180 181 // The register containing the backtrack stack top. Provides a meaningful 182 // name to the register. 183 inline Register backtrack_stackpointer() { return r8; } 184 185 // Register holding pointer to the current code object. 186 inline Register code_pointer() { return r5; } 187 188 // Byte size of chars in the string to match (decided by the Mode argument) 189 inline int char_size() { return static_cast<int>(mode_); } 190 191 // Equivalent to a conditional branch to the label, unless the label 192 // is NULL, in which case it is a conditional Backtrack. 193 void BranchOrBacktrack(Condition condition, Label* to); 194 195 // Call and return internally in the generated code in a way that 196 // is GC-safe (i.e., doesn't leave absolute code addresses on the stack) 197 inline void SafeCall(Label* to, Condition cond = al); 198 inline void SafeReturn(); 199 inline void SafeCallTarget(Label* name); 200 201 // Pushes the value of a register on the backtrack stack. Decrements the 202 // stack pointer by a word size and stores the register's value there. 203 inline void Push(Register source); 204 205 // Pops a value from the backtrack stack. Reads the word at the stack pointer 206 // and increments it by a word size. 207 inline void Pop(Register target); 208 209 // Before calling a C-function from generated code, align arguments on stack. 210 // After aligning the frame, non-register arguments must be stored in 211 // sp[0], sp[4], etc., not pushed. The argument count assumes all arguments 212 // are word sized. 213 // Some compilers/platforms require the stack to be aligned when calling 214 // C++ code. 215 // Needs a scratch register to do some arithmetic. This register will be 216 // trashed. 217 inline void FrameAlign(int num_arguments, Register scratch); 218 219 // Calls a C function and cleans up the space for arguments allocated 220 // by FrameAlign. The called function is not allowed to trigger a garbage 221 // collection. 222 inline void CallCFunction(ExternalReference function, 223 int num_arguments); 224 225 // Calls a C function and cleans up the frame alignment done by 226 // by FrameAlign. The called function *is* allowed to trigger a garbage 227 // collection, but may not take more than four arguments (no arguments 228 // passed on the stack), and the first argument will be a pointer to the 229 // return address. 230 inline void CallCFunctionUsingStub(ExternalReference function, 231 int num_arguments); 232 233 234 MacroAssembler* masm_; 235 236 // Which mode to generate code for (ASCII or UC16). 237 Mode mode_; 238 239 // One greater than maximal register index actually used. 240 int num_registers_; 241 242 // Number of registers to output at the end (the saved registers 243 // are always 0..num_saved_registers_-1) 244 int num_saved_registers_; 245 246 // Manage a small pre-allocated pool for writing label targets 247 // to for pushing backtrack addresses. 248 int backtrack_constant_pool_offset_; 249 int backtrack_constant_pool_capacity_; 250 251 // Labels used internally. 252 Label entry_label_; 253 Label start_label_; 254 Label success_label_; 255 Label backtrack_label_; 256 Label exit_label_; 257 Label check_preempt_label_; 258 Label stack_overflow_label_; 259}; 260 261 262// Enter C code from generated RegExp code in a way that allows 263// the C code to fix the return address in case of a GC. 264// Currently only needed on ARM. 265class RegExpCEntryStub: public CodeStub { 266 public: 267 RegExpCEntryStub() {} 268 virtual ~RegExpCEntryStub() {} 269 void Generate(MacroAssembler* masm); 270 271 private: 272 Major MajorKey() { return RegExpCEntry; } 273 int MinorKey() { return 0; } 274 const char* GetName() { return "RegExpCEntryStub"; } 275}; 276 277#endif // V8_NATIVE_REGEXP 278 279 280}} // namespace v8::internal 281 282#endif // V8_ARM_REGEXP_MACRO_ASSEMBLER_ARM_H_ 283