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 CodeEmitInfo* _info;
241
242 public:
243 LoadFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr result, CodeEmitInfo* info);
244 virtual void emit_code(LIR_Assembler* e);
245 virtual CodeEmitInfo* info() const { return _info; }
246 virtual void visit(LIR_OpVisitState* visitor);
247 #ifndef PRODUCT
248 virtual void print_name(outputStream* out) const { out->print("LoadFlattenedArrayStub"); }
249 #endif // PRODUCT
250 };
251
252
253 class StoreFlattenedArrayStub: public CodeStub {
254 private:
255 LIR_Opr _array;
256 LIR_Opr _index;
257 LIR_Opr _value;
258 CodeEmitInfo* _info;
259
260 public:
261 StoreFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr value, CodeEmitInfo* info);
262 virtual void emit_code(LIR_Assembler* e);
263 virtual CodeEmitInfo* info() const { return _info; }
264 virtual void visit(LIR_OpVisitState* visitor) {
265 visitor->do_slow_case(_info);
266 visitor->do_input(_array);
267 visitor->do_input(_index);
268 visitor->do_input(_value);
269 }
270 #ifndef PRODUCT
271 virtual void print_name(outputStream* out) const { out->print("StoreFlattenedArrayStub"); }
272 #endif // PRODUCT
273 };
274
275
276 class NewInstanceStub: public CodeStub {
277 private:
278 ciInstanceKlass* _klass;
279 LIR_Opr _klass_reg;
280 LIR_Opr _result;
281 CodeEmitInfo* _info;
282 Runtime1::StubID _stub_id;
283
284 public:
285 NewInstanceStub(LIR_Opr klass_reg, LIR_Opr result, ciInstanceKlass* klass, CodeEmitInfo* info, Runtime1::StubID stub_id);
286 virtual void emit_code(LIR_Assembler* e);
287 virtual CodeEmitInfo* info() const { return _info; }
288 virtual void visit(LIR_OpVisitState* visitor) {
289 visitor->do_slow_case(_info);
290 visitor->do_input(_klass_reg);
291 visitor->do_output(_result);
292 }
293 #ifndef PRODUCT
294 virtual void print_name(outputStream* out) const { out->print("NewInstanceStub"); }
295 #endif // PRODUCT
296 };
297
298
299 class NewTypeArrayStub: public CodeStub {
300 private:
301 LIR_Opr _klass_reg;
302 LIR_Opr _length;
303 LIR_Opr _result;
304 CodeEmitInfo* _info;
305
306 public:
307 NewTypeArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info);
308 virtual void emit_code(LIR_Assembler* e);
309 virtual CodeEmitInfo* info() const { return _info; }
310 virtual void visit(LIR_OpVisitState* visitor) {
311 visitor->do_slow_case(_info);
312 visitor->do_input(_klass_reg);
313 visitor->do_input(_length);
314 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result);
315 }
316 #ifndef PRODUCT
317 virtual void print_name(outputStream* out) const { out->print("NewTypeArrayStub"); }
318 #endif // PRODUCT
319 };
320
321
322 class NewObjectArrayStub: public CodeStub {
323 private:
324 LIR_Opr _klass_reg;
325 LIR_Opr _length;
326 LIR_Opr _result;
327 CodeEmitInfo* _info;
328 bool _is_value_type;
329 public:
330 NewObjectArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info, bool is_value_type);
331 virtual void emit_code(LIR_Assembler* e);
332 virtual CodeEmitInfo* info() const { return _info; }
333 virtual void visit(LIR_OpVisitState* visitor) {
334 visitor->do_slow_case(_info);
335 visitor->do_input(_klass_reg);
336 visitor->do_input(_length);
337 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result);
338 }
339 #ifndef PRODUCT
340 virtual void print_name(outputStream* out) const { out->print("NewObjectArrayStub"); }
341 #endif // PRODUCT
342 };
343
344
345 class MonitorAccessStub: public CodeStub {
346 protected:
347 LIR_Opr _obj_reg;
348 LIR_Opr _lock_reg;
349
350 public:
351 MonitorAccessStub(LIR_Opr obj_reg, LIR_Opr lock_reg) {
352 _obj_reg = obj_reg;
353 _lock_reg = lock_reg;
354 }
355
356 #ifndef PRODUCT
357 virtual void print_name(outputStream* out) const { out->print("MonitorAccessStub"); }
358 #endif // PRODUCT
359 };
360
361
362 class MonitorEnterStub: public MonitorAccessStub {
363 private:
364 CodeEmitInfo* _info;
365 CodeStub* _throw_imse_stub;
366 LIR_Opr _scratch_reg;
367
368 public:
369 MonitorEnterStub(LIR_Opr obj_reg, LIR_Opr lock_reg, CodeEmitInfo* info, CodeStub* throw_imse_stub = NULL, LIR_Opr scratch_reg = LIR_OprFact::illegalOpr);
370
371 virtual void emit_code(LIR_Assembler* e);
372 virtual CodeEmitInfo* info() const { return _info; }
373 virtual void visit(LIR_OpVisitState* visitor) {
374 visitor->do_input(_obj_reg);
375 visitor->do_input(_lock_reg);
376 if (_scratch_reg != LIR_OprFact::illegalOpr) {
377 visitor->do_temp(_scratch_reg);
378 }
379 visitor->do_slow_case(_info);
380 }
381 #ifndef PRODUCT
382 virtual void print_name(outputStream* out) const { out->print("MonitorEnterStub"); }
383 #endif // PRODUCT
384 };
385
386
387 class MonitorExitStub: public MonitorAccessStub {
388 private:
389 bool _compute_lock;
390 int _monitor_ix;
391
392 public:
393 MonitorExitStub(LIR_Opr lock_reg, bool compute_lock, int monitor_ix)
394 : MonitorAccessStub(LIR_OprFact::illegalOpr, lock_reg),
395 _compute_lock(compute_lock), _monitor_ix(monitor_ix) { }
396 virtual void emit_code(LIR_Assembler* e);
397 virtual void visit(LIR_OpVisitState* visitor) {
398 assert(_obj_reg->is_illegal(), "unused");
399 if (_compute_lock) {
400 visitor->do_temp(_lock_reg);
401 } else {
402 visitor->do_input(_lock_reg);
403 }
404 }
405 #ifndef PRODUCT
406 virtual void print_name(outputStream* out) const { out->print("MonitorExitStub"); }
407 #endif // PRODUCT
408 };
409
410
411 class PatchingStub: public CodeStub {
412 public:
413 enum PatchID {
414 access_field_id,
415 load_klass_id,
416 load_mirror_id,
417 load_appendix_id
418 };
419 enum constants {
420 patch_info_size = 3
421 };
422 private:
423 PatchID _id;
424 address _pc_start;
425 int _bytes_to_copy;
426 Label _patched_code_entry;
427 Label _patch_site_entry;
428 Label _patch_site_continuation;
429 Register _obj;
430 CodeEmitInfo* _info;
431 int _index; // index of the patchable oop or Klass* in nmethod oop or metadata table if needed
432 static int _patch_info_offset;
433
434 void align_patch_site(MacroAssembler* masm);
435
436 public:
437 static int patch_info_offset() { return _patch_info_offset; }
438
439 PatchingStub(MacroAssembler* masm, PatchID id, int index = -1):
440 _id(id)
441 , _info(NULL)
442 , _index(index) {
443 // force alignment of patch sites so we
444 // can guarantee atomic writes to the patch site.
445 align_patch_site(masm);
446 _pc_start = masm->pc();
447 masm->bind(_patch_site_entry);
448 }
449
450 void install(MacroAssembler* masm, LIR_PatchCode patch_code, Register obj, CodeEmitInfo* info) {
451 _info = info;
452 _obj = obj;
453 masm->bind(_patch_site_continuation);
454 _bytes_to_copy = masm->pc() - pc_start();
455 if (_id == PatchingStub::access_field_id) {
456 // embed a fixed offset to handle long patches which need to be offset by a word.
457 // the patching code will just add the field offset field to this offset so
458 // that we can refernce either the high or low word of a double word field.
459 int field_offset = 0;
460 switch (patch_code) {
461 case lir_patch_low: field_offset = lo_word_offset_in_bytes; break;
462 case lir_patch_high: field_offset = hi_word_offset_in_bytes; break;
463 case lir_patch_normal: field_offset = 0; break;
464 default: ShouldNotReachHere();
465 }
466 NativeMovRegMem* n_move = nativeMovRegMem_at(pc_start());
467 n_move->set_offset(field_offset);
468 } else if (_id == load_klass_id || _id == load_mirror_id || _id == load_appendix_id) {
469 assert(_obj != noreg, "must have register object for load_klass/load_mirror");
470 #ifdef ASSERT
471 // verify that we're pointing at a NativeMovConstReg
472 nativeMovConstReg_at(pc_start());
473 #endif
474 } else {
475 ShouldNotReachHere();
476 }
477 assert(_bytes_to_copy <= (masm->pc() - pc_start()), "not enough bytes");
478 }
479
480 address pc_start() const { return _pc_start; }
481 PatchID id() const { return _id; }
482
483 virtual void emit_code(LIR_Assembler* e);
484 virtual CodeEmitInfo* info() const { return _info; }
485 virtual void visit(LIR_OpVisitState* visitor) {
486 visitor->do_slow_case(_info);
487 }
488 #ifndef PRODUCT
489 virtual void print_name(outputStream* out) const { out->print("PatchingStub"); }
490 #endif // PRODUCT
491 };
492
493
494 //------------------------------------------------------------------------------
495 // DeoptimizeStub
496 //
497 class DeoptimizeStub : public CodeStub {
498 private:
499 CodeEmitInfo* _info;
500 jint _trap_request;
501
502 public:
503 DeoptimizeStub(CodeEmitInfo* info, Deoptimization::DeoptReason reason, Deoptimization::DeoptAction action) :
504 _info(new CodeEmitInfo(info)), _trap_request(Deoptimization::make_trap_request(reason, action)) {}
505
506 virtual void emit_code(LIR_Assembler* e);
507 virtual CodeEmitInfo* info() const { return _info; }
508 virtual bool is_exception_throw_stub() const { return true; }
509 virtual void visit(LIR_OpVisitState* visitor) {
510 visitor->do_slow_case(_info);
511 }
512 #ifndef PRODUCT
513 virtual void print_name(outputStream* out) const { out->print("DeoptimizeStub"); }
514 #endif // PRODUCT
515 };
516
517
518 class SimpleExceptionStub: public CodeStub {
519 private:
520 LIR_Opr _obj;
521 Runtime1::StubID _stub;
522 CodeEmitInfo* _info;
523
524 public:
525 SimpleExceptionStub(Runtime1::StubID stub, LIR_Opr obj, CodeEmitInfo* info):
526 _obj(obj), _stub(stub), _info(info) {
527 }
528
529 void set_obj(LIR_Opr obj) {
530 _obj = obj;
531 }
532
533 virtual void emit_code(LIR_Assembler* e);
534 virtual CodeEmitInfo* info() const { return _info; }
535 virtual bool is_exception_throw_stub() const { return true; }
536 virtual bool is_simple_exception_stub() const { return true; }
537 virtual void visit(LIR_OpVisitState* visitor) {
538 if (_obj->is_valid()) visitor->do_input(_obj);
539 visitor->do_slow_case(_info);
540 }
541 #ifndef PRODUCT
542 virtual void print_name(outputStream* out) const { out->print("SimpleExceptionStub"); }
543 #endif // PRODUCT
544 };
545
546
547
548 class ArrayStoreExceptionStub: public SimpleExceptionStub {
549 private:
550 CodeEmitInfo* _info;
551
552 public:
553 ArrayStoreExceptionStub(LIR_Opr obj, CodeEmitInfo* info): SimpleExceptionStub(Runtime1::throw_array_store_exception_id, obj, info) {}
554 #ifndef PRODUCT
555 virtual void print_name(outputStream* out) const { out->print("ArrayStoreExceptionStub"); }
556 #endif // PRODUCT
557 };
558
559
560 class ArrayCopyStub: public CodeStub {
561 private:
562 LIR_OpArrayCopy* _op;
563
564 public:
565 ArrayCopyStub(LIR_OpArrayCopy* op): _op(op) { }
566
567 LIR_Opr src() const { return _op->src(); }
568 LIR_Opr src_pos() const { return _op->src_pos(); }
569 LIR_Opr dst() const { return _op->dst(); }
570 LIR_Opr dst_pos() const { return _op->dst_pos(); }
571 LIR_Opr length() const { return _op->length(); }
572 LIR_Opr tmp() const { return _op->tmp(); }
573
574 virtual void emit_code(LIR_Assembler* e);
575 virtual CodeEmitInfo* info() const { return _op->info(); }
576 virtual void visit(LIR_OpVisitState* visitor) {
577 // don't pass in the code emit info since it's processed in the fast path
578 visitor->do_slow_case();
579 }
580 #ifndef PRODUCT
581 virtual void print_name(outputStream* out) const { out->print("ArrayCopyStub"); }
582 #endif // PRODUCT
583 };
584
585 #endif // SHARE_C1_C1_CODESTUBS_HPP