1// Copyright 2015 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_S390_REGEXP_MACRO_ASSEMBLER_S390_H_
6#define V8_S390_REGEXP_MACRO_ASSEMBLER_S390_H_
7
8#include "src/macro-assembler.h"
9#include "src/regexp/regexp-macro-assembler.h"
10#include "src/s390/assembler-s390.h"
11#include "src/s390/frames-s390.h"
12
13namespace v8 {
14namespace internal {
15
16#ifndef V8_INTERPRETED_REGEXP
17class RegExpMacroAssemblerS390 : public NativeRegExpMacroAssembler {
18 public:
19  RegExpMacroAssemblerS390(Isolate* isolate, Zone* zone, Mode mode,
20                           int registers_to_save);
21  virtual ~RegExpMacroAssemblerS390();
22  virtual int stack_limit_slack();
23  virtual void AdvanceCurrentPosition(int by);
24  virtual void AdvanceRegister(int reg, int by);
25  virtual void Backtrack();
26  virtual void Bind(Label* label);
27  virtual void CheckAtStart(Label* on_at_start);
28  virtual void CheckCharacter(unsigned c, Label* on_equal);
29  virtual void CheckCharacterAfterAnd(unsigned c, unsigned 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(unsigned c, Label* on_not_equal);
43  virtual void CheckNotCharacterAfterAnd(unsigned c, unsigned mask,
44                                         Label* on_not_equal);
45  virtual void CheckNotCharacterAfterMinusAnd(uc16 c, uc16 minus, uc16 mask,
46                                              Label* on_not_equal);
47  virtual void CheckCharacterInRange(uc16 from, uc16 to, Label* on_in_range);
48  virtual void CheckCharacterNotInRange(uc16 from, uc16 to,
49                                        Label* on_not_in_range);
50  virtual void CheckBitInTable(Handle<ByteArray> table, Label* on_bit_set);
51
52  // Checks whether the given offset from the current position is before
53  // the end of the string.
54  virtual void CheckPosition(int cp_offset, Label* on_outside_input);
55  virtual bool CheckSpecialCharacterClass(uc16 type, Label* on_no_match);
56  virtual void Fail();
57  virtual Handle<HeapObject> GetCode(Handle<String> source);
58  virtual void GoTo(Label* label);
59  virtual void IfRegisterGE(int reg, int comparand, Label* if_ge);
60  virtual void IfRegisterLT(int reg, int comparand, Label* if_lt);
61  virtual void IfRegisterEqPos(int reg, Label* if_eq);
62  virtual IrregexpImplementation Implementation();
63  virtual void LoadCurrentCharacter(int cp_offset, Label* on_end_of_input,
64                                    bool check_bounds = true,
65                                    int characters = 1);
66  virtual void PopCurrentPosition();
67  virtual void PopRegister(int register_index);
68  virtual void PushBacktrack(Label* label);
69  virtual void PushCurrentPosition();
70  virtual void PushRegister(int register_index,
71                            StackCheckFlag check_stack_limit);
72  virtual void ReadCurrentPositionFromRegister(int reg);
73  virtual void ReadStackPointerFromRegister(int reg);
74  virtual void SetCurrentPositionFromEnd(int by);
75  virtual void SetRegister(int register_index, int to);
76  virtual bool Succeed();
77  virtual void WriteCurrentPositionToRegister(int reg, int cp_offset);
78  virtual void ClearRegisters(int reg_from, int reg_to);
79  virtual void WriteStackPointerToRegister(int reg);
80
81  // Called from RegExp if the stack-guard is triggered.
82  // If the code object is relocated, the return address is fixed before
83  // returning.
84  static int CheckStackGuardState(Address* return_address, Code* re_code,
85                                  Address re_frame);
86
87 private:
88  // Offsets from frame_pointer() of function parameters and stored registers.
89  static const int kFramePointer = 0;
90
91  // Above the frame pointer - Stored registers and stack passed parameters.
92  // Register 6-15(sp)
93  static const int kStoredRegisters = kFramePointer;
94  static const int kCallerFrame =
95      kStoredRegisters + kCalleeRegisterSaveAreaSize;
96  // Stack parameters placed by caller.
97  static const int kCaptureArraySize = kCallerFrame;
98  static const int kStackAreaBase = kCallerFrame + kPointerSize;
99  // kDirectCall again
100  static const int kSecondaryReturnAddress = kStackAreaBase + 2 * kPointerSize;
101  static const int kIsolate = kSecondaryReturnAddress + kPointerSize;
102
103  // Below the frame pointer.
104  // Register parameters stored by setup code.
105  static const int kDirectCall = kFramePointer - kPointerSize;
106  static const int kStackHighEnd = kDirectCall - kPointerSize;
107  static const int kNumOutputRegisters = kStackHighEnd - kPointerSize;
108  static const int kRegisterOutput = kNumOutputRegisters - kPointerSize;
109  static const int kInputEnd = kRegisterOutput - kPointerSize;
110  static const int kInputStart = kInputEnd - kPointerSize;
111  static const int kStartIndex = kInputStart - kPointerSize;
112  static const int kInputString = kStartIndex - kPointerSize;
113  // When adding local variables remember to push space for them in
114  // the frame in GetCode.
115  static const int kSuccessfulCaptures = kInputString - kPointerSize;
116  static const int kStringStartMinusOne = kSuccessfulCaptures - kPointerSize;
117  // First register address. Following registers are below it on the stack.
118  static const int kRegisterZero = kStringStartMinusOne - kPointerSize;
119
120  // Initial size of code buffer.
121  static const size_t kRegExpCodeSize = 1024;
122
123  // Load a number of characters at the given offset from the
124  // current position, into the current-character register.
125  void LoadCurrentCharacterUnchecked(int cp_offset, int character_count);
126
127  // Check whether preemption has been requested.
128  void CheckPreemption();
129
130  // Check whether we are exceeding the stack limit on the backtrack stack.
131  void CheckStackLimit();
132  void CallCFunctionUsingStub(ExternalReference function, int num_arguments);
133
134  // Generate a call to CheckStackGuardState.
135  void CallCheckStackGuardState(Register scratch);
136
137  // The ebp-relative location of a regexp register.
138  MemOperand register_location(int register_index);
139
140  // Register holding the current input position as negative offset from
141  // the end of the string.
142  inline Register current_input_offset() { return r8; }
143
144  // The register containing the current character after LoadCurrentCharacter.
145  inline Register current_character() { return r9; }
146
147  // Register holding address of the end of the input string.
148  inline Register end_of_input_address() { return r10; }
149
150  // Register holding the frame address. Local variables, parameters and
151  // regexp registers are addressed relative to this.
152  inline Register frame_pointer() { return fp; }
153
154  // The register containing the backtrack stack top. Provides a meaningful
155  // name to the register.
156  inline Register backtrack_stackpointer() { return r13; }
157
158  // Register holding pointer to the current code object.
159  inline Register code_pointer() { return r7; }
160
161  // Byte size of chars in the string to match (decided by the Mode argument)
162  inline int char_size() { return static_cast<int>(mode_); }
163
164  // Equivalent to a conditional branch to the label, unless the label
165  // is NULL, in which case it is a conditional Backtrack.
166  void BranchOrBacktrack(Condition condition, Label* to, CRegister cr = cr7);
167
168  // Call and return internally in the generated code in a way that
169  // is GC-safe (i.e., doesn't leave absolute code addresses on the stack)
170  inline void SafeCall(Label* to, Condition cond = al, CRegister cr = cr7);
171  inline void SafeReturn();
172  inline void SafeCallTarget(Label* name);
173
174  // Pushes the value of a register on the backtrack stack. Decrements the
175  // stack pointer by a word size and stores the register's value there.
176  inline void Push(Register source);
177
178  // Pops a value from the backtrack stack. Reads the word at the stack pointer
179  // and increments it by a word size.
180  inline void Pop(Register target);
181
182  Isolate* isolate() const { return masm_->isolate(); }
183
184  MacroAssembler* masm_;
185
186  // Which mode to generate code for (Latin1 or UC16).
187  Mode mode_;
188
189  // One greater than maximal register index actually used.
190  int num_registers_;
191
192  // Number of registers to output at the end (the saved registers
193  // are always 0..num_saved_registers_-1)
194  int num_saved_registers_;
195
196  // Labels used internally.
197  Label entry_label_;
198  Label start_label_;
199  Label success_label_;
200  Label backtrack_label_;
201  Label exit_label_;
202  Label check_preempt_label_;
203  Label stack_overflow_label_;
204  Label internal_failure_label_;
205};
206
207// Set of non-volatile registers saved/restored by generated regexp code.
208const RegList kRegExpCalleeSaved =
209    1 << 6 | 1 << 7 | 1 << 8 | 1 << 9 | 1 << 10 | 1 << 11 | 1 << 13;
210
211#endif  // V8_INTERPRETED_REGEXP
212}  // namespace internal
213}  // namespace v8
214
215#endif  // V8_S390_REGEXP_MACRO_ASSEMBLER_S390_H_
216