1// Copyright 2011 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef V8_REGEXP_MIPS_REGEXP_MACRO_ASSEMBLER_MIPS_H_
6#define V8_REGEXP_MIPS_REGEXP_MACRO_ASSEMBLER_MIPS_H_
7
8#include "src/macro-assembler.h"
9#include "src/mips64/assembler-mips64.h"
10#include "src/regexp/regexp-macro-assembler.h"
11
12namespace v8 {
13namespace internal {
14
15#ifndef V8_INTERPRETED_REGEXP
16class RegExpMacroAssemblerMIPS: public NativeRegExpMacroAssembler {
17 public:
18  RegExpMacroAssemblerMIPS(Isolate* isolate, Zone* zone, Mode mode,
19                           int registers_to_save);
20  virtual ~RegExpMacroAssemblerMIPS();
21  virtual int stack_limit_slack();
22  virtual void AdvanceCurrentPosition(int by);
23  virtual void AdvanceRegister(int reg, int by);
24  virtual void Backtrack();
25  virtual void Bind(Label* label);
26  virtual void CheckAtStart(Label* on_at_start);
27  virtual void CheckCharacter(uint32_t c, Label* on_equal);
28  virtual void CheckCharacterAfterAnd(uint32_t c,
29                                      uint32_t mask,
30                                      Label* on_equal);
31  virtual void CheckCharacterGT(uc16 limit, Label* on_greater);
32  virtual void CheckCharacterLT(uc16 limit, Label* on_less);
33  // A "greedy loop" is a loop that is both greedy and with a simple
34  // body. It has a particularly simple implementation.
35  virtual void CheckGreedyLoop(Label* on_tos_equals_current_position);
36  virtual void CheckNotAtStart(int cp_offset, Label* on_not_at_start);
37  virtual void CheckNotBackReference(int start_reg, bool read_backward,
38                                     Label* on_no_match);
39  virtual void CheckNotBackReferenceIgnoreCase(int start_reg,
40                                               bool read_backward, bool unicode,
41                                               Label* on_no_match);
42  virtual void CheckNotCharacter(uint32_t c, Label* on_not_equal);
43  virtual void CheckNotCharacterAfterAnd(uint32_t c,
44                                         uint32_t mask,
45                                         Label* on_not_equal);
46  virtual void CheckNotCharacterAfterMinusAnd(uc16 c,
47                                              uc16 minus,
48                                              uc16 mask,
49                                              Label* on_not_equal);
50  virtual void CheckCharacterInRange(uc16 from,
51                                     uc16 to,
52                                     Label* on_in_range);
53  virtual void CheckCharacterNotInRange(uc16 from,
54                                        uc16 to,
55                                        Label* on_not_in_range);
56  virtual void CheckBitInTable(Handle<ByteArray> table, Label* on_bit_set);
57
58  // Checks whether the given offset from the current position is before
59  // the end of the string.
60  virtual void CheckPosition(int cp_offset, Label* on_outside_input);
61  virtual bool CheckSpecialCharacterClass(uc16 type,
62                                          Label* on_no_match);
63  virtual void Fail();
64  virtual Handle<HeapObject> GetCode(Handle<String> source);
65  virtual void GoTo(Label* label);
66  virtual void IfRegisterGE(int reg, int comparand, Label* if_ge);
67  virtual void IfRegisterLT(int reg, int comparand, Label* if_lt);
68  virtual void IfRegisterEqPos(int reg, Label* if_eq);
69  virtual IrregexpImplementation Implementation();
70  virtual void LoadCurrentCharacter(int cp_offset,
71                                    Label* on_end_of_input,
72                                    bool check_bounds = true,
73                                    int characters = 1);
74  virtual void PopCurrentPosition();
75  virtual void PopRegister(int register_index);
76  virtual void PushBacktrack(Label* label);
77  virtual void PushCurrentPosition();
78  virtual void PushRegister(int register_index,
79                            StackCheckFlag check_stack_limit);
80  virtual void ReadCurrentPositionFromRegister(int reg);
81  virtual void ReadStackPointerFromRegister(int reg);
82  virtual void SetCurrentPositionFromEnd(int by);
83  virtual void SetRegister(int register_index, int to);
84  virtual bool Succeed();
85  virtual void WriteCurrentPositionToRegister(int reg, int cp_offset);
86  virtual void ClearRegisters(int reg_from, int reg_to);
87  virtual void WriteStackPointerToRegister(int reg);
88  virtual bool CanReadUnaligned();
89
90  // Called from RegExp if the stack-guard is triggered.
91  // If the code object is relocated, the return address is fixed before
92  // returning.
93  static int64_t CheckStackGuardState(Address* return_address, Code* re_code,
94                                      Address re_frame);
95
96  void print_regexp_frame_constants();
97
98 private:
99  // Offsets from frame_pointer() of function parameters and stored registers.
100  static const int kFramePointer = 0;
101
102  // Above the frame pointer - Stored registers and stack passed parameters.
103  // Registers s0 to s7, fp, and ra.
104  static const int kStoredRegisters = kFramePointer;
105  // Return address (stored from link register, read into pc on return).
106
107  // TODO(plind): This 9 - is 8 s-regs (s0..s7) plus fp.
108
109  static const int kReturnAddress = kStoredRegisters + 9 * kPointerSize;
110  static const int kSecondaryReturnAddress = kReturnAddress + kPointerSize;
111  // Stack frame header.
112  static const int kStackFrameHeader = kSecondaryReturnAddress;
113  // Stack parameters placed by caller.
114  static const int kIsolate = kStackFrameHeader + kPointerSize;
115
116  // Below the frame pointer.
117  // Register parameters stored by setup code.
118  static const int kDirectCall = kFramePointer - kPointerSize;
119  static const int kStackHighEnd = kDirectCall - kPointerSize;
120  static const int kNumOutputRegisters = kStackHighEnd - kPointerSize;
121  static const int kRegisterOutput = kNumOutputRegisters - kPointerSize;
122  static const int kInputEnd = kRegisterOutput - kPointerSize;
123  static const int kInputStart = kInputEnd - kPointerSize;
124  static const int kStartIndex = kInputStart - kPointerSize;
125  static const int kInputString = kStartIndex - kPointerSize;
126  // When adding local variables remember to push space for them in
127  // the frame in GetCode.
128  static const int kSuccessfulCaptures = kInputString - kPointerSize;
129  static const int kStringStartMinusOne = kSuccessfulCaptures - kPointerSize;
130  // First register address. Following registers are below it on the stack.
131  static const int kRegisterZero = kStringStartMinusOne - kPointerSize;
132
133  // Initial size of code buffer.
134  static const size_t kRegExpCodeSize = 1024;
135
136  // Load a number of characters at the given offset from the
137  // current position, into the current-character register.
138  void LoadCurrentCharacterUnchecked(int cp_offset, int character_count);
139
140  // Check whether preemption has been requested.
141  void CheckPreemption();
142
143  // Check whether we are exceeding the stack limit on the backtrack stack.
144  void CheckStackLimit();
145
146
147  // Generate a call to CheckStackGuardState.
148  void CallCheckStackGuardState(Register scratch);
149
150  // The ebp-relative location of a regexp register.
151  MemOperand register_location(int register_index);
152
153  // Register holding the current input position as negative offset from
154  // the end of the string.
155  inline Register current_input_offset() { return a6; }
156
157  // The register containing the current character after LoadCurrentCharacter.
158  inline Register current_character() { return a7; }
159
160  // Register holding address of the end of the input string.
161  inline Register end_of_input_address() { return t2; }
162
163  // Register holding the frame address. Local variables, parameters and
164  // regexp registers are addressed relative to this.
165  inline Register frame_pointer() { return fp; }
166
167  // The register containing the backtrack stack top. Provides a meaningful
168  // name to the register.
169  inline Register backtrack_stackpointer() { return t0; }
170
171  // Register holding pointer to the current code object.
172  inline Register code_pointer() { return a5; }
173
174  // Byte size of chars in the string to match (decided by the Mode argument).
175  inline int char_size() { return static_cast<int>(mode_); }
176
177  // Equivalent to a conditional branch to the label, unless the label
178  // is NULL, in which case it is a conditional Backtrack.
179  void BranchOrBacktrack(Label* to,
180                         Condition condition,
181                         Register rs,
182                         const Operand& rt);
183
184  // Call and return internally in the generated code in a way that
185  // is GC-safe (i.e., doesn't leave absolute code addresses on the stack)
186  inline void SafeCall(Label* to,
187                       Condition cond,
188                       Register rs,
189                       const Operand& rt);
190  inline void SafeReturn();
191  inline void SafeCallTarget(Label* name);
192
193  // Pushes the value of a register on the backtrack stack. Decrements the
194  // stack pointer by a word size and stores the register's value there.
195  inline void Push(Register source);
196
197  // Pops a value from the backtrack stack. Reads the word at the stack pointer
198  // and increments it by a word size.
199  inline void Pop(Register target);
200
201  Isolate* isolate() const { return masm_->isolate(); }
202
203  MacroAssembler* masm_;
204
205  // Which mode to generate code for (Latin1 or UC16).
206  Mode mode_;
207
208  // One greater than maximal register index actually used.
209  int num_registers_;
210
211  // Number of registers to output at the end (the saved registers
212  // are always 0..num_saved_registers_-1).
213  int num_saved_registers_;
214
215  // Labels used internally.
216  Label entry_label_;
217  Label start_label_;
218  Label success_label_;
219  Label backtrack_label_;
220  Label exit_label_;
221  Label check_preempt_label_;
222  Label stack_overflow_label_;
223  Label internal_failure_label_;
224};
225
226#endif  // V8_INTERPRETED_REGEXP
227
228
229}  // namespace internal
230}  // namespace v8
231
232#endif  // V8_REGEXP_MIPS_REGEXP_MACRO_ASSEMBLER_MIPS_H_
233