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#ifndef V8_NATIVE_REGEXP
35class RegExpMacroAssemblerIA32: public RegExpMacroAssembler {
36 public:
37  RegExpMacroAssemblerIA32() { }
38  virtual ~RegExpMacroAssemblerIA32() { }
39};
40
41#else
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 SetRegister(int register_index, int to);
102  virtual void Succeed();
103  virtual void WriteCurrentPositionToRegister(int reg, int cp_offset);
104  virtual void ClearRegisters(int reg_from, int reg_to);
105  virtual void WriteStackPointerToRegister(int reg);
106
107  // Called from RegExp if the stack-guard is triggered.
108  // If the code object is relocated, the return address is fixed before
109  // returning.
110  static int CheckStackGuardState(Address* return_address,
111                                  Code* re_code,
112                                  Address re_frame);
113
114 private:
115  // Offsets from ebp of function parameters and stored registers.
116  static const int kFramePointer = 0;
117  // Above the frame pointer - function parameters and return address.
118  static const int kReturn_eip = kFramePointer + kPointerSize;
119  static const int kFrameAlign = kReturn_eip + kPointerSize;
120  // Parameters.
121  static const int kInputString = kFrameAlign;
122  static const int kStartIndex = kInputString + kPointerSize;
123  static const int kInputStart = kStartIndex + kPointerSize;
124  static const int kInputEnd = kInputStart + kPointerSize;
125  static const int kRegisterOutput = kInputEnd + kPointerSize;
126  static const int kStackHighEnd = kRegisterOutput + kPointerSize;
127  static const int kDirectCall = kStackHighEnd + kPointerSize;
128  // Below the frame pointer - local stack variables.
129  // When adding local variables remember to push space for them in
130  // the frame in GetCode.
131  static const int kBackup_esi = kFramePointer - kPointerSize;
132  static const int kBackup_edi = kBackup_esi - kPointerSize;
133  static const int kBackup_ebx = kBackup_edi - kPointerSize;
134  static const int kInputStartMinusOne = kBackup_ebx - kPointerSize;
135  static const int kAtStart = kInputStartMinusOne - kPointerSize;
136  // First register address. Following registers are below it on the stack.
137  static const int kRegisterZero = kAtStart - kPointerSize;
138
139  // Initial size of code buffer.
140  static const size_t kRegExpCodeSize = 1024;
141
142  // Load a number of characters at the given offset from the
143  // current position, into the current-character register.
144  void LoadCurrentCharacterUnchecked(int cp_offset, int character_count);
145
146  // Check whether preemption has been requested.
147  void CheckPreemption();
148
149  // Check whether we are exceeding the stack limit on the backtrack stack.
150  void CheckStackLimit();
151
152  // Generate a call to CheckStackGuardState.
153  void CallCheckStackGuardState(Register scratch);
154
155  // The ebp-relative location of a regexp register.
156  Operand register_location(int register_index);
157
158  // The register containing the current character after LoadCurrentCharacter.
159  inline Register current_character() { return edx; }
160
161  // The register containing the backtrack stack top. Provides a meaningful
162  // name to the register.
163  inline Register backtrack_stackpointer() { return ecx; }
164
165  // Byte size of chars in the string to match (decided by the Mode argument)
166  inline int char_size() { return static_cast<int>(mode_); }
167
168  // Equivalent to a conditional branch to the label, unless the label
169  // is NULL, in which case it is a conditional Backtrack.
170  void BranchOrBacktrack(Condition condition, Label* to, Hint hint = no_hint);
171
172  // Call and return internally in the generated code in a way that
173  // is GC-safe (i.e., doesn't leave absolute code addresses on the stack)
174  inline void SafeCall(Label* to);
175  inline void SafeReturn();
176  inline void SafeCallTarget(Label* name);
177
178  // Pushes the value of a register on the backtrack stack. Decrements the
179  // stack pointer (ecx) by a word size and stores the register's value there.
180  inline void Push(Register source);
181
182  // Pushes a value on the backtrack stack. Decrements the stack pointer (ecx)
183  // by a word size and stores the value there.
184  inline void Push(Immediate value);
185
186  // Pops a value from the backtrack stack. Reads the word at the stack pointer
187  // (ecx) and increments it by a word size.
188  inline void Pop(Register target);
189
190  // Before calling a C-function from generated code, align arguments on stack.
191  // After aligning the frame, arguments must be stored in esp[0], esp[4],
192  // etc., not pushed. The argument count assumes all arguments are word sized.
193  // Some compilers/platforms require the stack to be aligned when calling
194  // C++ code.
195  // Needs a scratch register to do some arithmetic. This register will be
196  // trashed.
197  inline void FrameAlign(int num_arguments, Register scratch);
198
199  // Calls a C function and cleans up the space for arguments allocated
200  // by FrameAlign. The called function is not allowed to trigger a garbage
201  // collection, since that might move the code and invalidate the return
202  // address (unless this is somehow accounted for).
203  inline void CallCFunction(ExternalReference function, int num_arguments);
204
205  MacroAssembler* masm_;
206
207  // Which mode to generate code for (ASCII or UC16).
208  Mode mode_;
209
210  // One greater than maximal register index actually used.
211  int num_registers_;
212
213  // Number of registers to output at the end (the saved registers
214  // are always 0..num_saved_registers_-1)
215  int num_saved_registers_;
216
217  // Labels used internally.
218  Label entry_label_;
219  Label start_label_;
220  Label success_label_;
221  Label backtrack_label_;
222  Label exit_label_;
223  Label check_preempt_label_;
224  Label stack_overflow_label_;
225};
226#endif  // V8_NATIVE_REGEXP
227
228}}  // namespace v8::internal
229
230#endif  // V8_IA32_REGEXP_MACRO_ASSEMBLER_IA32_H_
231