regexp-macro-assembler-ia32.h revision 44f0eee88ff00398ff7f715fab053374d808c90d 
1// Copyright 2008-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#ifndef V8_IA32_REGEXP_MACRO_ASSEMBLER_IA32_H_
29#define V8_IA32_REGEXP_MACRO_ASSEMBLER_IA32_H_
30
31namespace v8 {
32namespace internal {
33
34#ifdef V8_INTERPRETED_REGEXP
35class RegExpMacroAssemblerIA32: public RegExpMacroAssembler {
36 public:
37  RegExpMacroAssemblerIA32() { }
38  virtual ~RegExpMacroAssemblerIA32() { }
39};
40
41#else  // V8_INTERPRETED_REGEXP
42class RegExpMacroAssemblerIA32: public NativeRegExpMacroAssembler {
43 public:
44  RegExpMacroAssemblerIA32(Mode mode, int registers_to_save);
45  virtual ~RegExpMacroAssemblerIA32();
46  virtual int stack_limit_slack();
47  virtual void AdvanceCurrentPosition(int by);
48  virtual void AdvanceRegister(int reg, int by);
49  virtual void Backtrack();
50  virtual void Bind(Label* label);
51  virtual void CheckAtStart(Label* on_at_start);
52  virtual void CheckCharacter(uint32_t c, Label* on_equal);
53  virtual void CheckCharacterAfterAnd(uint32_t c,
54                                      uint32_t mask,
55                                      Label* on_equal);
56  virtual void CheckCharacterGT(uc16 limit, Label* on_greater);
57  virtual void CheckCharacterLT(uc16 limit, Label* on_less);
58  virtual void CheckCharacters(Vector<const uc16> str,
59                               int cp_offset,
60                               Label* on_failure,
61                               bool check_end_of_string);
62  // A "greedy loop" is a loop that is both greedy and with a simple
63  // body. It has a particularly simple implementation.
64  virtual void CheckGreedyLoop(Label* on_tos_equals_current_position);
65  virtual void CheckNotAtStart(Label* on_not_at_start);
66  virtual void CheckNotBackReference(int start_reg, Label* on_no_match);
67  virtual void CheckNotBackReferenceIgnoreCase(int start_reg,
68                                               Label* on_no_match);
69  virtual void CheckNotRegistersEqual(int reg1, int reg2, Label* on_not_equal);
70  virtual void CheckNotCharacter(uint32_t c, Label* on_not_equal);
71  virtual void CheckNotCharacterAfterAnd(uint32_t c,
72                                         uint32_t mask,
73                                         Label* on_not_equal);
74  virtual void CheckNotCharacterAfterMinusAnd(uc16 c,
75                                              uc16 minus,
76                                              uc16 mask,
77                                              Label* on_not_equal);
78  // Checks whether the given offset from the current position is before
79  // the end of the string.
80  virtual void CheckPosition(int cp_offset, Label* on_outside_input);
81  virtual bool CheckSpecialCharacterClass(uc16 type, Label* on_no_match);
82  virtual void Fail();
83  virtual Handle<Object> GetCode(Handle<String> source);
84  virtual void GoTo(Label* label);
85  virtual void IfRegisterGE(int reg, int comparand, Label* if_ge);
86  virtual void IfRegisterLT(int reg, int comparand, Label* if_lt);
87  virtual void IfRegisterEqPos(int reg, Label* if_eq);
88  virtual IrregexpImplementation Implementation();
89  virtual void LoadCurrentCharacter(int cp_offset,
90                                    Label* on_end_of_input,
91                                    bool check_bounds = true,
92                                    int characters = 1);
93  virtual void PopCurrentPosition();
94  virtual void PopRegister(int register_index);
95  virtual void PushBacktrack(Label* label);
96  virtual void PushCurrentPosition();
97  virtual void PushRegister(int register_index,
98                            StackCheckFlag check_stack_limit);
99  virtual void ReadCurrentPositionFromRegister(int reg);
100  virtual void ReadStackPointerFromRegister(int reg);
101  virtual void SetCurrentPositionFromEnd(int by);
102  virtual void SetRegister(int register_index, int to);
103  virtual void Succeed();
104  virtual void WriteCurrentPositionToRegister(int reg, int cp_offset);
105  virtual void ClearRegisters(int reg_from, int reg_to);
106  virtual void WriteStackPointerToRegister(int reg);
107
108  // Called from RegExp if the stack-guard is triggered.
109  // If the code object is relocated, the return address is fixed before
110  // returning.
111  static int CheckStackGuardState(Address* return_address,
112                                  Code* re_code,
113                                  Address re_frame);
114
115 private:
116  // Offsets from ebp of function parameters and stored registers.
117  static const int kFramePointer = 0;
118  // Above the frame pointer - function parameters and return address.
119  static const int kReturn_eip = kFramePointer + kPointerSize;
120  static const int kFrameAlign = kReturn_eip + kPointerSize;
121  // Parameters.
122  static const int kInputString = kFrameAlign;
123  static const int kStartIndex = kInputString + kPointerSize;
124  static const int kInputStart = kStartIndex + kPointerSize;
125  static const int kInputEnd = kInputStart + kPointerSize;
126  static const int kRegisterOutput = kInputEnd + kPointerSize;
127  static const int kStackHighEnd = kRegisterOutput + kPointerSize;
128  static const int kDirectCall = kStackHighEnd + kPointerSize;
129  static const int kIsolate = kDirectCall + kPointerSize;
130  // Below the frame pointer - local stack variables.
131  // When adding local variables remember to push space for them in
132  // the frame in GetCode.
133  static const int kBackup_esi = kFramePointer - kPointerSize;
134  static const int kBackup_edi = kBackup_esi - kPointerSize;
135  static const int kBackup_ebx = kBackup_edi - kPointerSize;
136  static const int kInputStartMinusOne = kBackup_ebx - kPointerSize;
137  // First register address. Following registers are below it on the stack.
138  static const int kRegisterZero = kInputStartMinusOne - kPointerSize;
139
140  // Initial size of code buffer.
141  static const size_t kRegExpCodeSize = 1024;
142
143  // Load a number of characters at the given offset from the
144  // current position, into the current-character register.
145  void LoadCurrentCharacterUnchecked(int cp_offset, int character_count);
146
147  // Check whether preemption has been requested.
148  void CheckPreemption();
149
150  // Check whether we are exceeding the stack limit on the backtrack stack.
151  void CheckStackLimit();
152
153  // Generate a call to CheckStackGuardState.
154  void CallCheckStackGuardState(Register scratch);
155
156  // The ebp-relative location of a regexp register.
157  Operand register_location(int register_index);
158
159  // The register containing the current character after LoadCurrentCharacter.
160  inline Register current_character() { return edx; }
161
162  // The register containing the backtrack stack top. Provides a meaningful
163  // name to the register.
164  inline Register backtrack_stackpointer() { return ecx; }
165
166  // Byte size of chars in the string to match (decided by the Mode argument)
167  inline int char_size() { return static_cast<int>(mode_); }
168
169  // Equivalent to a conditional branch to the label, unless the label
170  // is NULL, in which case it is a conditional Backtrack.
171  void BranchOrBacktrack(Condition condition, Label* to, Hint hint = no_hint);
172
173  // Call and return internally in the generated code in a way that
174  // is GC-safe (i.e., doesn't leave absolute code addresses on the stack)
175  inline void SafeCall(Label* to);
176  inline void SafeReturn();
177  inline void SafeCallTarget(Label* name);
178
179  // Pushes the value of a register on the backtrack stack. Decrements the
180  // stack pointer (ecx) by a word size and stores the register's value there.
181  inline void Push(Register source);
182
183  // Pushes a value on the backtrack stack. Decrements the stack pointer (ecx)
184  // by a word size and stores the value there.
185  inline void Push(Immediate value);
186
187  // Pops a value from the backtrack stack. Reads the word at the stack pointer
188  // (ecx) and increments it by a word size.
189  inline void Pop(Register target);
190
191  MacroAssembler* masm_;
192
193  // Which mode to generate code for (ASCII or UC16).
194  Mode mode_;
195
196  // One greater than maximal register index actually used.
197  int num_registers_;
198
199  // Number of registers to output at the end (the saved registers
200  // are always 0..num_saved_registers_-1)
201  int num_saved_registers_;
202
203  // Labels used internally.
204  Label entry_label_;
205  Label start_label_;
206  Label success_label_;
207  Label backtrack_label_;
208  Label exit_label_;
209  Label check_preempt_label_;
210  Label stack_overflow_label_;
211};
212#endif  // V8_INTERPRETED_REGEXP
213
214}}  // namespace v8::internal
215
216#endif  // V8_IA32_REGEXP_MACRO_ASSEMBLER_IA32_H_
217