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