MIPS64: Improve long branches utilizing code range.
[platform/upstream/v8.git] / src / mips64 / assembler-mips64-inl.h
1
2 // Copyright (c) 1994-2006 Sun Microsystems Inc.
3 // All Rights Reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 //
12 // - Redistribution in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // - Neither the name of Sun Microsystems or the names of contributors may
17 // be used to endorse or promote products derived from this software without
18 // specific prior written permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 // The original source code covered by the above license above has been
33 // modified significantly by Google Inc.
34 // Copyright 2012 the V8 project authors. All rights reserved.
35
36
37 #ifndef V8_MIPS_ASSEMBLER_MIPS_INL_H_
38 #define V8_MIPS_ASSEMBLER_MIPS_INL_H_
39
40 #include "src/mips64/assembler-mips64.h"
41
42 #include "src/assembler.h"
43 #include "src/debug.h"
44
45
46 namespace v8 {
47 namespace internal {
48
49
50 bool CpuFeatures::SupportsCrankshaft() { return IsSupported(FPU); }
51
52
53 // -----------------------------------------------------------------------------
54 // Operand and MemOperand.
55
56 Operand::Operand(int64_t immediate, RelocInfo::Mode rmode)  {
57   rm_ = no_reg;
58   imm64_ = immediate;
59   rmode_ = rmode;
60 }
61
62
63 Operand::Operand(const ExternalReference& f)  {
64   rm_ = no_reg;
65   imm64_ = reinterpret_cast<int64_t>(f.address());
66   rmode_ = RelocInfo::EXTERNAL_REFERENCE;
67 }
68
69
70 Operand::Operand(Smi* value) {
71   rm_ = no_reg;
72   imm64_ =  reinterpret_cast<intptr_t>(value);
73   rmode_ = RelocInfo::NONE32;
74 }
75
76
77 Operand::Operand(Register rm) {
78   rm_ = rm;
79 }
80
81
82 bool Operand::is_reg() const {
83   return rm_.is_valid();
84 }
85
86
87 int Register::NumAllocatableRegisters() {
88     return kMaxNumAllocatableRegisters;
89 }
90
91
92 int DoubleRegister::NumRegisters() {
93     return FPURegister::kMaxNumRegisters;
94 }
95
96
97 int DoubleRegister::NumAllocatableRegisters() {
98     return FPURegister::kMaxNumAllocatableRegisters;
99 }
100
101
102 int DoubleRegister::NumAllocatableAliasedRegisters() {
103   return NumAllocatableRegisters();
104 }
105
106
107 int FPURegister::ToAllocationIndex(FPURegister reg) {
108   DCHECK(reg.code() % 2 == 0);
109   DCHECK(reg.code() / 2 < kMaxNumAllocatableRegisters);
110   DCHECK(reg.is_valid());
111   DCHECK(!reg.is(kDoubleRegZero));
112   DCHECK(!reg.is(kLithiumScratchDouble));
113   return (reg.code() / 2);
114 }
115
116
117 // -----------------------------------------------------------------------------
118 // RelocInfo.
119
120 void RelocInfo::apply(intptr_t delta, ICacheFlushMode icache_flush_mode) {
121   if (IsInternalReference(rmode_) || IsInternalReferenceEncoded(rmode_)) {
122     // Absolute code pointer inside code object moves with the code object.
123     byte* p = reinterpret_cast<byte*>(pc_);
124     int count = Assembler::RelocateInternalReference(rmode_, p, delta);
125     CpuFeatures::FlushICache(p, count * sizeof(uint32_t));
126   }
127 }
128
129
130 Address RelocInfo::target_address() {
131   DCHECK(IsCodeTarget(rmode_) || IsRuntimeEntry(rmode_));
132   return Assembler::target_address_at(pc_, host_);
133 }
134
135
136 Address RelocInfo::target_address_address() {
137   DCHECK(IsCodeTarget(rmode_) ||
138          IsRuntimeEntry(rmode_) ||
139          rmode_ == EMBEDDED_OBJECT ||
140          rmode_ == EXTERNAL_REFERENCE);
141   // Read the address of the word containing the target_address in an
142   // instruction stream.
143   // The only architecture-independent user of this function is the serializer.
144   // The serializer uses it to find out how many raw bytes of instruction to
145   // output before the next target.
146   // For an instruction like LUI/ORI where the target bits are mixed into the
147   // instruction bits, the size of the target will be zero, indicating that the
148   // serializer should not step forward in memory after a target is resolved
149   // and written. In this case the target_address_address function should
150   // return the end of the instructions to be patched, allowing the
151   // deserializer to deserialize the instructions as raw bytes and put them in
152   // place, ready to be patched with the target. After jump optimization,
153   // that is the address of the instruction that follows J/JAL/JR/JALR
154   // instruction.
155   // return reinterpret_cast<Address>(
156   //  pc_ + Assembler::kInstructionsFor32BitConstant * Assembler::kInstrSize);
157   return reinterpret_cast<Address>(
158     pc_ + Assembler::kInstructionsFor64BitConstant * Assembler::kInstrSize);
159 }
160
161
162 Address RelocInfo::constant_pool_entry_address() {
163   UNREACHABLE();
164   return NULL;
165 }
166
167
168 int RelocInfo::target_address_size() {
169   return Assembler::kSpecialTargetSize;
170 }
171
172
173 void RelocInfo::set_target_address(Address target,
174                                    WriteBarrierMode write_barrier_mode,
175                                    ICacheFlushMode icache_flush_mode) {
176   DCHECK(IsCodeTarget(rmode_) || IsRuntimeEntry(rmode_));
177   Assembler::set_target_address_at(pc_, host_, target, icache_flush_mode);
178   if (write_barrier_mode == UPDATE_WRITE_BARRIER &&
179       host() != NULL && IsCodeTarget(rmode_)) {
180     Object* target_code = Code::GetCodeFromTargetAddress(target);
181     host()->GetHeap()->incremental_marking()->RecordWriteIntoCode(
182         host(), this, HeapObject::cast(target_code));
183   }
184 }
185
186
187 Address Assembler::target_address_from_return_address(Address pc) {
188   return pc - kCallTargetAddressOffset;
189 }
190
191
192 Address Assembler::break_address_from_return_address(Address pc) {
193   return pc - Assembler::kPatchDebugBreakSlotReturnOffset;
194 }
195
196
197 void Assembler::set_target_internal_reference_encoded_at(Address pc,
198                                                          Address target) {
199   // Encoded internal references are j/jal instructions.
200   Instr instr = Assembler::instr_at(pc + 0 * Assembler::kInstrSize);
201
202   uint64_t imm28 =
203       (reinterpret_cast<uint64_t>(target) & static_cast<uint64_t>(kImm28Mask));
204
205   instr &= ~kImm26Mask;
206   uint64_t imm26 = imm28 >> 2;
207   DCHECK(is_uint26(imm26));
208
209   instr_at_put(pc, instr | (imm26 & kImm26Mask));
210   // Currently used only by deserializer, and all code will be flushed
211   // after complete deserialization, no need to flush on each reference.
212 }
213
214
215 void Assembler::deserialization_set_target_internal_reference_at(
216     Address pc, Address target, RelocInfo::Mode mode) {
217   if (mode == RelocInfo::INTERNAL_REFERENCE_ENCODED) {
218     DCHECK(IsJ(instr_at(pc)));
219     set_target_internal_reference_encoded_at(pc, target);
220   } else {
221     DCHECK(mode == RelocInfo::INTERNAL_REFERENCE);
222     Memory::Address_at(pc) = target;
223   }
224 }
225
226
227 Object* RelocInfo::target_object() {
228   DCHECK(IsCodeTarget(rmode_) || rmode_ == EMBEDDED_OBJECT);
229   return reinterpret_cast<Object*>(Assembler::target_address_at(pc_, host_));
230 }
231
232
233 Handle<Object> RelocInfo::target_object_handle(Assembler* origin) {
234   DCHECK(IsCodeTarget(rmode_) || rmode_ == EMBEDDED_OBJECT);
235   return Handle<Object>(reinterpret_cast<Object**>(
236       Assembler::target_address_at(pc_, host_)));
237 }
238
239
240 void RelocInfo::set_target_object(Object* target,
241                                   WriteBarrierMode write_barrier_mode,
242                                   ICacheFlushMode icache_flush_mode) {
243   DCHECK(IsCodeTarget(rmode_) || rmode_ == EMBEDDED_OBJECT);
244   Assembler::set_target_address_at(pc_, host_,
245                                    reinterpret_cast<Address>(target),
246                                    icache_flush_mode);
247   if (write_barrier_mode == UPDATE_WRITE_BARRIER &&
248       host() != NULL &&
249       target->IsHeapObject()) {
250     host()->GetHeap()->incremental_marking()->RecordWrite(
251         host(), &Memory::Object_at(pc_), HeapObject::cast(target));
252   }
253 }
254
255
256 Address RelocInfo::target_external_reference() {
257   DCHECK(rmode_ == EXTERNAL_REFERENCE);
258   return Assembler::target_address_at(pc_, host_);
259 }
260
261
262 Address RelocInfo::target_internal_reference() {
263   if (rmode_ == INTERNAL_REFERENCE) {
264     return Memory::Address_at(pc_);
265   } else {
266     // Encoded internal references are j/jal instructions.
267     DCHECK(rmode_ == INTERNAL_REFERENCE_ENCODED);
268     Instr instr = Assembler::instr_at(pc_ + 0 * Assembler::kInstrSize);
269     instr &= kImm26Mask;
270     uint64_t imm28 = instr << 2;
271     uint64_t segment =
272         (reinterpret_cast<uint64_t>(pc_) & ~static_cast<uint64_t>(kImm28Mask));
273     return reinterpret_cast<Address>(segment | imm28);
274   }
275 }
276
277
278 Address RelocInfo::target_internal_reference_address() {
279   DCHECK(rmode_ == INTERNAL_REFERENCE || rmode_ == INTERNAL_REFERENCE_ENCODED);
280   return reinterpret_cast<Address>(pc_);
281 }
282
283
284 Address RelocInfo::target_runtime_entry(Assembler* origin) {
285   DCHECK(IsRuntimeEntry(rmode_));
286   return target_address();
287 }
288
289
290 void RelocInfo::set_target_runtime_entry(Address target,
291                                          WriteBarrierMode write_barrier_mode,
292                                          ICacheFlushMode icache_flush_mode) {
293   DCHECK(IsRuntimeEntry(rmode_));
294   if (target_address() != target)
295     set_target_address(target, write_barrier_mode, icache_flush_mode);
296 }
297
298
299 Handle<Cell> RelocInfo::target_cell_handle() {
300   DCHECK(rmode_ == RelocInfo::CELL);
301   Address address = Memory::Address_at(pc_);
302   return Handle<Cell>(reinterpret_cast<Cell**>(address));
303 }
304
305
306 Cell* RelocInfo::target_cell() {
307   DCHECK(rmode_ == RelocInfo::CELL);
308   return Cell::FromValueAddress(Memory::Address_at(pc_));
309 }
310
311
312 void RelocInfo::set_target_cell(Cell* cell,
313                                 WriteBarrierMode write_barrier_mode,
314                                 ICacheFlushMode icache_flush_mode) {
315   DCHECK(rmode_ == RelocInfo::CELL);
316   Address address = cell->address() + Cell::kValueOffset;
317   Memory::Address_at(pc_) = address;
318   if (write_barrier_mode == UPDATE_WRITE_BARRIER && host() != NULL) {
319     // TODO(1550) We are passing NULL as a slot because cell can never be on
320     // evacuation candidate.
321     host()->GetHeap()->incremental_marking()->RecordWrite(
322         host(), NULL, cell);
323   }
324 }
325
326
327 static const int kNoCodeAgeSequenceLength = 9 * Assembler::kInstrSize;
328
329
330 Handle<Object> RelocInfo::code_age_stub_handle(Assembler* origin) {
331   UNREACHABLE();  // This should never be reached on Arm.
332   return Handle<Object>();
333 }
334
335
336 Code* RelocInfo::code_age_stub() {
337   DCHECK(rmode_ == RelocInfo::CODE_AGE_SEQUENCE);
338   return Code::GetCodeFromTargetAddress(
339       Assembler::target_address_at(pc_ + Assembler::kInstrSize, host_));
340 }
341
342
343 void RelocInfo::set_code_age_stub(Code* stub,
344                                   ICacheFlushMode icache_flush_mode) {
345   DCHECK(rmode_ == RelocInfo::CODE_AGE_SEQUENCE);
346   Assembler::set_target_address_at(pc_ + Assembler::kInstrSize,
347                                    host_,
348                                    stub->instruction_start());
349 }
350
351
352 Address RelocInfo::call_address() {
353   DCHECK((IsJSReturn(rmode()) && IsPatchedReturnSequence()) ||
354          (IsDebugBreakSlot(rmode()) && IsPatchedDebugBreakSlotSequence()));
355   // The pc_ offset of 0 assumes mips patched return sequence per
356   // debug-mips.cc BreakLocation::SetDebugBreakAtReturn(), or
357   // debug break slot per BreakLocation::SetDebugBreakAtSlot().
358   return Assembler::target_address_at(pc_, host_);
359 }
360
361
362 void RelocInfo::set_call_address(Address target) {
363   DCHECK((IsJSReturn(rmode()) && IsPatchedReturnSequence()) ||
364          (IsDebugBreakSlot(rmode()) && IsPatchedDebugBreakSlotSequence()));
365   // The pc_ offset of 0 assumes mips patched return sequence per
366   // debug-mips.cc BreakLocation::SetDebugBreakAtReturn(), or
367   // debug break slot per BreakLocation::SetDebugBreakAtSlot().
368   Assembler::set_target_address_at(pc_, host_, target);
369   if (host() != NULL) {
370     Object* target_code = Code::GetCodeFromTargetAddress(target);
371     host()->GetHeap()->incremental_marking()->RecordWriteIntoCode(
372         host(), this, HeapObject::cast(target_code));
373   }
374 }
375
376
377 Object* RelocInfo::call_object() {
378   return *call_object_address();
379 }
380
381
382 Object** RelocInfo::call_object_address() {
383   DCHECK((IsJSReturn(rmode()) && IsPatchedReturnSequence()) ||
384          (IsDebugBreakSlot(rmode()) && IsPatchedDebugBreakSlotSequence()));
385   return reinterpret_cast<Object**>(pc_ + 6 * Assembler::kInstrSize);
386 }
387
388
389 void RelocInfo::set_call_object(Object* target) {
390   *call_object_address() = target;
391 }
392
393
394 void RelocInfo::WipeOut() {
395   DCHECK(IsEmbeddedObject(rmode_) || IsCodeTarget(rmode_) ||
396          IsRuntimeEntry(rmode_) || IsExternalReference(rmode_) ||
397          IsInternalReference(rmode_) || IsInternalReferenceEncoded(rmode_));
398   if (IsInternalReference(rmode_)) {
399     Memory::Address_at(pc_) = NULL;
400   } else if (IsInternalReferenceEncoded(rmode_)) {
401     Assembler::set_target_internal_reference_encoded_at(pc_, nullptr);
402   } else {
403     Assembler::set_target_address_at(pc_, host_, NULL);
404   }
405 }
406
407
408 bool RelocInfo::IsPatchedReturnSequence() {
409   Instr instr0 = Assembler::instr_at(pc_);  // lui.
410   Instr instr1 = Assembler::instr_at(pc_ + 1 * Assembler::kInstrSize);  // ori.
411   Instr instr2 = Assembler::instr_at(pc_ + 2 * Assembler::kInstrSize);  // dsll.
412   Instr instr3 = Assembler::instr_at(pc_ + 3 * Assembler::kInstrSize);  // ori.
413   Instr instr4 = Assembler::instr_at(pc_ + 4 * Assembler::kInstrSize);  // jalr.
414
415   bool patched_return = ((instr0 & kOpcodeMask) == LUI &&
416                          (instr1 & kOpcodeMask) == ORI &&
417                          (instr2 & kFunctionFieldMask) == DSLL &&
418                          (instr3 & kOpcodeMask) == ORI &&
419                          (instr4 & kFunctionFieldMask) == JALR);
420   return patched_return;
421 }
422
423
424 bool RelocInfo::IsPatchedDebugBreakSlotSequence() {
425   Instr current_instr = Assembler::instr_at(pc_);
426   return !Assembler::IsNop(current_instr, Assembler::DEBUG_BREAK_NOP);
427 }
428
429
430 void RelocInfo::Visit(Isolate* isolate, ObjectVisitor* visitor) {
431   RelocInfo::Mode mode = rmode();
432   if (mode == RelocInfo::EMBEDDED_OBJECT) {
433     visitor->VisitEmbeddedPointer(this);
434   } else if (RelocInfo::IsCodeTarget(mode)) {
435     visitor->VisitCodeTarget(this);
436   } else if (mode == RelocInfo::CELL) {
437     visitor->VisitCell(this);
438   } else if (mode == RelocInfo::EXTERNAL_REFERENCE) {
439     visitor->VisitExternalReference(this);
440   } else if (mode == RelocInfo::INTERNAL_REFERENCE ||
441              mode == RelocInfo::INTERNAL_REFERENCE_ENCODED) {
442     visitor->VisitInternalReference(this);
443   } else if (RelocInfo::IsCodeAgeSequence(mode)) {
444     visitor->VisitCodeAgeSequence(this);
445   } else if (((RelocInfo::IsJSReturn(mode) &&
446               IsPatchedReturnSequence()) ||
447              (RelocInfo::IsDebugBreakSlot(mode) &&
448              IsPatchedDebugBreakSlotSequence())) &&
449              isolate->debug()->has_break_points()) {
450     visitor->VisitDebugTarget(this);
451   } else if (RelocInfo::IsRuntimeEntry(mode)) {
452     visitor->VisitRuntimeEntry(this);
453   }
454 }
455
456
457 template<typename StaticVisitor>
458 void RelocInfo::Visit(Heap* heap) {
459   RelocInfo::Mode mode = rmode();
460   if (mode == RelocInfo::EMBEDDED_OBJECT) {
461     StaticVisitor::VisitEmbeddedPointer(heap, this);
462   } else if (RelocInfo::IsCodeTarget(mode)) {
463     StaticVisitor::VisitCodeTarget(heap, this);
464   } else if (mode == RelocInfo::CELL) {
465     StaticVisitor::VisitCell(heap, this);
466   } else if (mode == RelocInfo::EXTERNAL_REFERENCE) {
467     StaticVisitor::VisitExternalReference(this);
468   } else if (mode == RelocInfo::INTERNAL_REFERENCE ||
469              mode == RelocInfo::INTERNAL_REFERENCE_ENCODED) {
470     StaticVisitor::VisitInternalReference(this);
471   } else if (RelocInfo::IsCodeAgeSequence(mode)) {
472     StaticVisitor::VisitCodeAgeSequence(heap, this);
473   } else if (heap->isolate()->debug()->has_break_points() &&
474              ((RelocInfo::IsJSReturn(mode) &&
475               IsPatchedReturnSequence()) ||
476              (RelocInfo::IsDebugBreakSlot(mode) &&
477               IsPatchedDebugBreakSlotSequence()))) {
478     StaticVisitor::VisitDebugTarget(heap, this);
479   } else if (RelocInfo::IsRuntimeEntry(mode)) {
480     StaticVisitor::VisitRuntimeEntry(this);
481   }
482 }
483
484
485 // -----------------------------------------------------------------------------
486 // Assembler.
487
488
489 void Assembler::CheckBuffer() {
490   if (buffer_space() <= kGap) {
491     GrowBuffer();
492   }
493 }
494
495
496 void Assembler::CheckTrampolinePoolQuick() {
497   if (pc_offset() >= next_buffer_check_) {
498     CheckTrampolinePool();
499   }
500 }
501
502
503 void Assembler::emit(Instr x) {
504   if (!is_buffer_growth_blocked()) {
505     CheckBuffer();
506   }
507   *reinterpret_cast<Instr*>(pc_) = x;
508   pc_ += kInstrSize;
509   CheckTrampolinePoolQuick();
510 }
511
512
513 void Assembler::emit(uint64_t x) {
514   if (!is_buffer_growth_blocked()) {
515     CheckBuffer();
516   }
517   *reinterpret_cast<uint64_t*>(pc_) = x;
518   pc_ += kInstrSize * 2;
519   CheckTrampolinePoolQuick();
520 }
521
522
523 } }  // namespace v8::internal
524
525 #endif  // V8_MIPS_ASSEMBLER_MIPS_INL_H_