1 /*
2 * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_C1_C1_CODESTUBS_HPP
26 #define SHARE_C1_C1_CODESTUBS_HPP
27
28 #include "c1/c1_FrameMap.hpp"
29 #include "c1/c1_IR.hpp"
30 #include "c1/c1_Instruction.hpp"
31 #include "c1/c1_LIR.hpp"
32 #include "c1/c1_Runtime1.hpp"
33 #include "code/nativeInst.hpp"
34 #include "utilities/growableArray.hpp"
35 #include "utilities/macros.hpp"
36
37 class CodeEmitInfo;
38 class LIR_Assembler;
39 class LIR_OpVisitState;
40
41 // CodeStubs are little 'out-of-line' pieces of code that
42 // usually handle slow cases of operations. All code stubs
43 // are collected and code is emitted at the end of the
44 // nmethod.
45
46 class CodeStub: public CompilationResourceObj {
47 protected:
48 Label _entry; // label at the stub entry point
49 Label _continuation; // label where stub continues, if any
50
51 public:
52 CodeStub() {}
53
54 // code generation
55 void assert_no_unbound_labels() { assert(!_entry.is_unbound() && !_continuation.is_unbound(), "unbound label"); }
56 virtual void emit_code(LIR_Assembler* e) = 0;
57 virtual CodeEmitInfo* info() const { return NULL; }
58 virtual bool is_exception_throw_stub() const { return false; }
59 virtual bool is_range_check_stub() const { return false; }
60 virtual bool is_divbyzero_stub() const { return false; }
61 virtual bool is_simple_exception_stub() const { return false; }
62 #ifndef PRODUCT
63 virtual void print_name(outputStream* out) const = 0;
64 #endif
65
66 // label access
67 Label* entry() { return &_entry; }
68 Label* continuation() { return &_continuation; }
69 // for LIR
70 virtual void visit(LIR_OpVisitState* visit) {
71 #ifndef PRODUCT
72 if (LIRTracePeephole && Verbose) {
73 tty->print("no visitor for ");
74 print_name(tty);
75 tty->cr();
76 }
77 #endif
78 }
79 };
80
81 class CodeStubList: public GrowableArray<CodeStub*> {
82 public:
83 CodeStubList(): GrowableArray<CodeStub*>() {}
84
85 void append(CodeStub* stub) {
86 if (!contains(stub)) {
87 GrowableArray<CodeStub*>::append(stub);
88 }
89 }
90 };
91
92 class CounterOverflowStub: public CodeStub {
93 private:
94 CodeEmitInfo* _info;
95 int _bci;
96 LIR_Opr _method;
97
98 public:
99 CounterOverflowStub(CodeEmitInfo* info, int bci, LIR_Opr method) : _info(info), _bci(bci), _method(method) {
100 }
101
102 virtual void emit_code(LIR_Assembler* e);
103
104 virtual void visit(LIR_OpVisitState* visitor) {
105 visitor->do_slow_case(_info);
106 visitor->do_input(_method);
107 }
108
109 #ifndef PRODUCT
110 virtual void print_name(outputStream* out) const { out->print("CounterOverflowStub"); }
111 #endif // PRODUCT
112
113 };
114
115 class ConversionStub: public CodeStub {
116 private:
117 Bytecodes::Code _bytecode;
118 LIR_Opr _input;
119 LIR_Opr _result;
120
121 static float float_zero;
122 static double double_zero;
123 public:
124 ConversionStub(Bytecodes::Code bytecode, LIR_Opr input, LIR_Opr result)
125 : _bytecode(bytecode), _input(input), _result(result) {
126 }
127
128 Bytecodes::Code bytecode() { return _bytecode; }
129 LIR_Opr input() { return _input; }
130 LIR_Opr result() { return _result; }
131
132 virtual void emit_code(LIR_Assembler* e);
133 virtual void visit(LIR_OpVisitState* visitor) {
134 visitor->do_slow_case();
135 visitor->do_input(_input);
136 visitor->do_output(_result);
137 }
138 #ifndef PRODUCT
139 virtual void print_name(outputStream* out) const { out->print("ConversionStub"); }
140 #endif // PRODUCT
141 };
142
143
144 // Throws ArrayIndexOutOfBoundsException by default but can be
145 // configured to throw IndexOutOfBoundsException in constructor
146 class RangeCheckStub: public CodeStub {
147 private:
148 CodeEmitInfo* _info;
149 LIR_Opr _index;
150 LIR_Opr _array;
151 bool _throw_index_out_of_bounds_exception;
152
153 public:
154 // For ArrayIndexOutOfBoundsException.
155 RangeCheckStub(CodeEmitInfo* info, LIR_Opr index, LIR_Opr array);
156 // For IndexOutOfBoundsException.
157 RangeCheckStub(CodeEmitInfo* info, LIR_Opr index);
158 virtual void emit_code(LIR_Assembler* e);
159 virtual CodeEmitInfo* info() const { return _info; }
160 virtual bool is_exception_throw_stub() const { return true; }
161 virtual bool is_range_check_stub() const { return true; }
162 virtual void visit(LIR_OpVisitState* visitor) {
163 visitor->do_slow_case(_info);
164 visitor->do_input(_index);
165 if (_array) { visitor->do_input(_array); }
166 }
167 #ifndef PRODUCT
168 virtual void print_name(outputStream* out) const { out->print("RangeCheckStub"); }
169 #endif // PRODUCT
170 };
171
172 // stub used when predicate fails and deoptimization is needed
173 class PredicateFailedStub: public CodeStub {
174 private:
175 CodeEmitInfo* _info;
176
177 public:
178 PredicateFailedStub(CodeEmitInfo* info);
179 virtual void emit_code(LIR_Assembler* e);
180 virtual CodeEmitInfo* info() const { return _info; }
181 virtual void visit(LIR_OpVisitState* visitor) {
182 visitor->do_slow_case(_info);
183 }
184 #ifndef PRODUCT
185 virtual void print_name(outputStream* out) const { out->print("PredicateFailedStub"); }
186 #endif // PRODUCT
187 };
188
189 class DivByZeroStub: public CodeStub {
190 private:
191 CodeEmitInfo* _info;
192 int _offset;
193
194 public:
195 DivByZeroStub(CodeEmitInfo* info)
196 : _info(info), _offset(-1) {
197 }
198 DivByZeroStub(int offset, CodeEmitInfo* info)
199 : _info(info), _offset(offset) {
200 }
201 virtual void emit_code(LIR_Assembler* e);
202 virtual CodeEmitInfo* info() const { return _info; }
203 virtual bool is_exception_throw_stub() const { return true; }
204 virtual bool is_divbyzero_stub() const { return true; }
205 virtual void visit(LIR_OpVisitState* visitor) {
206 visitor->do_slow_case(_info);
207 }
208 #ifndef PRODUCT
209 virtual void print_name(outputStream* out) const { out->print("DivByZeroStub"); }
210 #endif // PRODUCT
211 };
212
213
214 class ImplicitNullCheckStub: public CodeStub {
215 private:
216 CodeEmitInfo* _info;
217 int _offset;
218
219 public:
220 ImplicitNullCheckStub(int offset, CodeEmitInfo* info)
221 : _info(info), _offset(offset) {
222 }
223 virtual void emit_code(LIR_Assembler* e);
224 virtual CodeEmitInfo* info() const { return _info; }
225 virtual bool is_exception_throw_stub() const { return true; }
226 virtual void visit(LIR_OpVisitState* visitor) {
227 visitor->do_slow_case(_info);
228 }
229 #ifndef PRODUCT
230 virtual void print_name(outputStream* out) const { out->print("ImplicitNullCheckStub"); }
231 #endif // PRODUCT
232 };
233
234
235 class LoadFlattenedArrayStub: public CodeStub {
236 private:
237 LIR_Opr _array;
238 LIR_Opr _index;
239 LIR_Opr _result;
240 LIR_Opr _scratch_reg;
241 CodeEmitInfo* _info;
242
243 public:
244 LoadFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr result, CodeEmitInfo* info);
245 virtual void emit_code(LIR_Assembler* e);
246 virtual CodeEmitInfo* info() const { return _info; }
247 virtual void visit(LIR_OpVisitState* visitor) {
248 visitor->do_slow_case(_info);
249 visitor->do_input(_array);
250 visitor->do_input(_index);
251 visitor->do_output(_result);
252 if (_scratch_reg != LIR_OprFact::illegalOpr) {
253 visitor->do_temp(_scratch_reg);
254 }
255 // Tell the register allocator that the runtime call will scratch rax.
256 visitor->do_output(FrameMap::rax_oop_opr);
257 }
258
259
260 #ifndef PRODUCT
261 virtual void print_name(outputStream* out) const { out->print("LoadFlattenedArrayStub"); }
262 #endif // PRODUCT
263 };
264
265
266 class StoreFlattenedArrayStub: public CodeStub {
267 private:
268 LIR_Opr _array;
269 LIR_Opr _index;
270 LIR_Opr _value;
271 CodeEmitInfo* _info;
272
273 public:
274 StoreFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr value, CodeEmitInfo* info);
275 virtual void emit_code(LIR_Assembler* e);
276 virtual CodeEmitInfo* info() const { return _info; }
277 virtual void visit(LIR_OpVisitState* visitor) {
278 visitor->do_slow_case(_info);
279 visitor->do_input(_array);
280 visitor->do_input(_index);
281 visitor->do_input(_value);
282 }
283 #ifndef PRODUCT
284 virtual void print_name(outputStream* out) const { out->print("StoreFlattenedArrayStub"); }
285 #endif // PRODUCT
286 };
287
288
289 class NewInstanceStub: public CodeStub {
290 private:
291 ciInstanceKlass* _klass;
292 LIR_Opr _klass_reg;
293 LIR_Opr _result;
294 CodeEmitInfo* _info;
295 Runtime1::StubID _stub_id;
296
297 public:
298 NewInstanceStub(LIR_Opr klass_reg, LIR_Opr result, ciInstanceKlass* klass, CodeEmitInfo* info, Runtime1::StubID stub_id);
299 virtual void emit_code(LIR_Assembler* e);
300 virtual CodeEmitInfo* info() const { return _info; }
301 virtual void visit(LIR_OpVisitState* visitor) {
302 visitor->do_slow_case(_info);
303 visitor->do_input(_klass_reg);
304 visitor->do_output(_result);
305 }
306 #ifndef PRODUCT
307 virtual void print_name(outputStream* out) const { out->print("NewInstanceStub"); }
308 #endif // PRODUCT
309 };
310
311
312 class NewTypeArrayStub: public CodeStub {
313 private:
314 LIR_Opr _klass_reg;
315 LIR_Opr _length;
316 LIR_Opr _result;
317 CodeEmitInfo* _info;
318
319 public:
320 NewTypeArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info);
321 virtual void emit_code(LIR_Assembler* e);
322 virtual CodeEmitInfo* info() const { return _info; }
323 virtual void visit(LIR_OpVisitState* visitor) {
324 visitor->do_slow_case(_info);
325 visitor->do_input(_klass_reg);
326 visitor->do_input(_length);
327 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result);
328 }
329 #ifndef PRODUCT
330 virtual void print_name(outputStream* out) const { out->print("NewTypeArrayStub"); }
331 #endif // PRODUCT
332 };
333
334
335 class NewObjectArrayStub: public CodeStub {
336 private:
337 LIR_Opr _klass_reg;
338 LIR_Opr _length;
339 LIR_Opr _result;
340 CodeEmitInfo* _info;
341 bool _is_value_type;
342 public:
343 NewObjectArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info, bool is_value_type);
344 virtual void emit_code(LIR_Assembler* e);
345 virtual CodeEmitInfo* info() const { return _info; }
346 virtual void visit(LIR_OpVisitState* visitor) {
347 visitor->do_slow_case(_info);
348 visitor->do_input(_klass_reg);
349 visitor->do_input(_length);
350 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result);
351 }
352 #ifndef PRODUCT
353 virtual void print_name(outputStream* out) const { out->print("NewObjectArrayStub"); }
354 #endif // PRODUCT
355 };
356
357
358 class MonitorAccessStub: public CodeStub {
359 protected:
360 LIR_Opr _obj_reg;
361 LIR_Opr _lock_reg;
362
363 public:
364 MonitorAccessStub(LIR_Opr obj_reg, LIR_Opr lock_reg) {
365 _obj_reg = obj_reg;
366 _lock_reg = lock_reg;
367 }
368
369 #ifndef PRODUCT
370 virtual void print_name(outputStream* out) const { out->print("MonitorAccessStub"); }
371 #endif // PRODUCT
372 };
373
374
375 class MonitorEnterStub: public MonitorAccessStub {
376 private:
377 CodeEmitInfo* _info;
378 CodeStub* _throw_imse_stub;
379 LIR_Opr _scratch_reg;
380
381 public:
382 MonitorEnterStub(LIR_Opr obj_reg, LIR_Opr lock_reg, CodeEmitInfo* info, CodeStub* throw_imse_stub = NULL, LIR_Opr scratch_reg = LIR_OprFact::illegalOpr);
383
384 virtual void emit_code(LIR_Assembler* e);
385 virtual CodeEmitInfo* info() const { return _info; }
386 virtual void visit(LIR_OpVisitState* visitor) {
387 visitor->do_input(_obj_reg);
388 visitor->do_input(_lock_reg);
389 if (_scratch_reg != LIR_OprFact::illegalOpr) {
390 visitor->do_temp(_scratch_reg);
391 }
392 visitor->do_slow_case(_info);
393 }
394 #ifndef PRODUCT
395 virtual void print_name(outputStream* out) const { out->print("MonitorEnterStub"); }
396 #endif // PRODUCT
397 };
398
399
400 class MonitorExitStub: public MonitorAccessStub {
401 private:
402 bool _compute_lock;
403 int _monitor_ix;
404
405 public:
406 MonitorExitStub(LIR_Opr lock_reg, bool compute_lock, int monitor_ix)
407 : MonitorAccessStub(LIR_OprFact::illegalOpr, lock_reg),
408 _compute_lock(compute_lock), _monitor_ix(monitor_ix) { }
409 virtual void emit_code(LIR_Assembler* e);
410 virtual void visit(LIR_OpVisitState* visitor) {
411 assert(_obj_reg->is_illegal(), "unused");
412 if (_compute_lock) {
413 visitor->do_temp(_lock_reg);
414 } else {
415 visitor->do_input(_lock_reg);
416 }
417 }
418 #ifndef PRODUCT
419 virtual void print_name(outputStream* out) const { out->print("MonitorExitStub"); }
420 #endif // PRODUCT
421 };
422
423
424 class PatchingStub: public CodeStub {
425 public:
426 enum PatchID {
427 access_field_id,
428 load_klass_id,
429 load_mirror_id,
430 load_appendix_id
431 };
432 enum constants {
433 patch_info_size = 3
434 };
435 private:
436 PatchID _id;
437 address _pc_start;
438 int _bytes_to_copy;
439 Label _patched_code_entry;
440 Label _patch_site_entry;
441 Label _patch_site_continuation;
442 Register _obj;
443 CodeEmitInfo* _info;
444 int _index; // index of the patchable oop or Klass* in nmethod oop or metadata table if needed
445 static int _patch_info_offset;
446
447 void align_patch_site(MacroAssembler* masm);
448
449 public:
450 static int patch_info_offset() { return _patch_info_offset; }
451
452 PatchingStub(MacroAssembler* masm, PatchID id, int index = -1):
453 _id(id)
454 , _info(NULL)
455 , _index(index) {
456 // force alignment of patch sites so we
457 // can guarantee atomic writes to the patch site.
458 align_patch_site(masm);
459 _pc_start = masm->pc();
460 masm->bind(_patch_site_entry);
461 }
462
463 void install(MacroAssembler* masm, LIR_PatchCode patch_code, Register obj, CodeEmitInfo* info) {
464 _info = info;
465 _obj = obj;
466 masm->bind(_patch_site_continuation);
467 _bytes_to_copy = masm->pc() - pc_start();
468 if (_id == PatchingStub::access_field_id) {
469 // embed a fixed offset to handle long patches which need to be offset by a word.
470 // the patching code will just add the field offset field to this offset so
471 // that we can refernce either the high or low word of a double word field.
472 int field_offset = 0;
473 switch (patch_code) {
474 case lir_patch_low: field_offset = lo_word_offset_in_bytes; break;
475 case lir_patch_high: field_offset = hi_word_offset_in_bytes; break;
476 case lir_patch_normal: field_offset = 0; break;
477 default: ShouldNotReachHere();
478 }
479 NativeMovRegMem* n_move = nativeMovRegMem_at(pc_start());
480 n_move->set_offset(field_offset);
481 } else if (_id == load_klass_id || _id == load_mirror_id || _id == load_appendix_id) {
482 assert(_obj != noreg, "must have register object for load_klass/load_mirror");
483 #ifdef ASSERT
484 // verify that we're pointing at a NativeMovConstReg
485 nativeMovConstReg_at(pc_start());
486 #endif
487 } else {
488 ShouldNotReachHere();
489 }
490 assert(_bytes_to_copy <= (masm->pc() - pc_start()), "not enough bytes");
491 }
492
493 address pc_start() const { return _pc_start; }
494 PatchID id() const { return _id; }
495
496 virtual void emit_code(LIR_Assembler* e);
497 virtual CodeEmitInfo* info() const { return _info; }
498 virtual void visit(LIR_OpVisitState* visitor) {
499 visitor->do_slow_case(_info);
500 }
501 #ifndef PRODUCT
502 virtual void print_name(outputStream* out) const { out->print("PatchingStub"); }
503 #endif // PRODUCT
504 };
505
506
507 //------------------------------------------------------------------------------
508 // DeoptimizeStub
509 //
510 class DeoptimizeStub : public CodeStub {
511 private:
512 CodeEmitInfo* _info;
513 jint _trap_request;
514
515 public:
516 DeoptimizeStub(CodeEmitInfo* info, Deoptimization::DeoptReason reason, Deoptimization::DeoptAction action) :
517 _info(new CodeEmitInfo(info)), _trap_request(Deoptimization::make_trap_request(reason, action)) {}
518
519 virtual void emit_code(LIR_Assembler* e);
520 virtual CodeEmitInfo* info() const { return _info; }
521 virtual bool is_exception_throw_stub() const { return true; }
522 virtual void visit(LIR_OpVisitState* visitor) {
523 visitor->do_slow_case(_info);
524 }
525 #ifndef PRODUCT
526 virtual void print_name(outputStream* out) const { out->print("DeoptimizeStub"); }
527 #endif // PRODUCT
528 };
529
530
531 class SimpleExceptionStub: public CodeStub {
532 private:
533 LIR_Opr _obj;
534 Runtime1::StubID _stub;
535 CodeEmitInfo* _info;
536
537 public:
538 SimpleExceptionStub(Runtime1::StubID stub, LIR_Opr obj, CodeEmitInfo* info):
539 _obj(obj), _stub(stub), _info(info) {
540 }
541
542 void set_obj(LIR_Opr obj) {
543 _obj = obj;
544 }
545
546 virtual void emit_code(LIR_Assembler* e);
547 virtual CodeEmitInfo* info() const { return _info; }
548 virtual bool is_exception_throw_stub() const { return true; }
549 virtual bool is_simple_exception_stub() const { return true; }
550 virtual void visit(LIR_OpVisitState* visitor) {
551 if (_obj->is_valid()) visitor->do_input(_obj);
552 visitor->do_slow_case(_info);
553 }
554 #ifndef PRODUCT
555 virtual void print_name(outputStream* out) const { out->print("SimpleExceptionStub"); }
556 #endif // PRODUCT
557 };
558
559
560
561 class ArrayStoreExceptionStub: public SimpleExceptionStub {
562 private:
563 CodeEmitInfo* _info;
564
565 public:
566 ArrayStoreExceptionStub(LIR_Opr obj, CodeEmitInfo* info): SimpleExceptionStub(Runtime1::throw_array_store_exception_id, obj, info) {}
567 #ifndef PRODUCT
568 virtual void print_name(outputStream* out) const { out->print("ArrayStoreExceptionStub"); }
569 #endif // PRODUCT
570 };
571
572
573 class ArrayCopyStub: public CodeStub {
574 private:
575 LIR_OpArrayCopy* _op;
576
577 public:
578 ArrayCopyStub(LIR_OpArrayCopy* op): _op(op) { }
579
580 LIR_Opr src() const { return _op->src(); }
581 LIR_Opr src_pos() const { return _op->src_pos(); }
582 LIR_Opr dst() const { return _op->dst(); }
583 LIR_Opr dst_pos() const { return _op->dst_pos(); }
584 LIR_Opr length() const { return _op->length(); }
585 LIR_Opr tmp() const { return _op->tmp(); }
586
587 virtual void emit_code(LIR_Assembler* e);
588 virtual CodeEmitInfo* info() const { return _op->info(); }
589 virtual void visit(LIR_OpVisitState* visitor) {
590 // don't pass in the code emit info since it's processed in the fast path
591 visitor->do_slow_case();
592 }
593 #ifndef PRODUCT
594 virtual void print_name(outputStream* out) const { out->print("ArrayCopyStub"); }
595 #endif // PRODUCT
596 };
597
598 #endif // SHARE_C1_C1_CODESTUBS_HPP