1 /*
2 * Copyright (c) 1997, 2025, 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 #include "code/codeCache.hpp"
26 #include "code/compiledIC.hpp"
27 #include "code/nmethod.hpp"
28 #include "code/relocInfo.hpp"
29 #include "memory/resourceArea.hpp"
30 #include "memory/universe.hpp"
31 #include "oops/compressedOops.inline.hpp"
32 #include "oops/oop.inline.hpp"
33 #include "runtime/flags/flagSetting.hpp"
34 #include "runtime/stubCodeGenerator.hpp"
35 #include "utilities/align.hpp"
36 #include "utilities/checkedCast.hpp"
37 #include "utilities/copy.hpp"
38
39 #include <new>
40 #include <type_traits>
41
42 const RelocationHolder RelocationHolder::none; // its type is relocInfo::none
43
44
45 // Implementation of relocInfo
46
47 #ifdef ASSERT
48 relocInfo::relocType relocInfo::check_relocType(relocType type) {
49 assert(type != data_prefix_tag, "cannot build a prefix this way");
50 assert((type & type_mask) == type, "wrong type");
51 return type;
52 }
53
54 void relocInfo::check_offset_and_format(int offset, int format) {
55 assert(offset >= 0 && offset < offset_limit(), "offset out off bounds");
56 assert(is_aligned(offset, offset_unit), "misaligned offset");
57 assert((format & format_mask) == format, "wrong format");
58 }
59 #endif // ASSERT
60
61 void relocInfo::initialize(CodeSection* dest, Relocation* reloc) {
62 relocInfo* data = this+1; // here's where the data might go
63 dest->set_locs_end(data); // sync end: the next call may read dest.locs_end
64 reloc->pack_data_to(dest); // maybe write data into locs, advancing locs_end
65 relocInfo* data_limit = dest->locs_end();
66 if (data_limit > data) {
67 relocInfo suffix = (*this);
68 data_limit = this->finish_prefix((short*) data_limit);
69 // Finish up with the suffix. (Hack note: pack_data_to might edit this.)
70 *data_limit = suffix;
71 dest->set_locs_end(data_limit+1);
72 }
73 }
74
75 relocInfo* relocInfo::finish_prefix(short* prefix_limit) {
76 assert(sizeof(relocInfo) == sizeof(short), "change this code");
77 short* p = (short*)(this+1);
78 assert(prefix_limit >= p, "must be a valid span of data");
79 int plen = checked_cast<int>(prefix_limit - p);
80 if (plen == 0) {
81 DEBUG_ONLY(_value = 0xFFFF);
82 return this; // no data: remove self completely
83 }
84 if (plen == 1 && fits_into_immediate(p[0])) {
85 (*this) = immediate_relocInfo(p[0]); // move data inside self
86 return this+1;
87 }
88 // cannot compact, so just update the count and return the limit pointer
89 (*this) = prefix_info(plen); // write new datalen
90 assert(data() + datalen() == prefix_limit, "pointers must line up");
91 return (relocInfo*)prefix_limit;
92 }
93
94 void relocInfo::set_type(relocType t) {
95 int old_offset = addr_offset();
96 int old_format = format();
97 (*this) = relocInfo(t, old_offset, old_format);
98 assert(type()==(int)t, "sanity check");
99 assert(addr_offset()==old_offset, "sanity check");
100 assert(format()==old_format, "sanity check");
101 }
102
103 void relocInfo::change_reloc_info_for_address(RelocIterator *itr, address pc, relocType old_type, relocType new_type) {
104 bool found = false;
105 while (itr->next() && !found) {
106 if (itr->addr() == pc) {
107 assert(itr->type()==old_type, "wrong relocInfo type found");
108 itr->current()->set_type(new_type);
109 found=true;
110 }
111 }
112 assert(found, "no relocInfo found for pc");
113 }
114
115
116 // ----------------------------------------------------------------------------------------------------
117 // Implementation of RelocIterator
118
119 // A static dummy to serve as a safe pointer when there is no relocation info.
120 static relocInfo dummy_relocInfo = relocInfo(relocInfo::none, 0);
121
122 void RelocIterator::initialize(nmethod* nm, address begin, address limit) {
123 initialize_misc();
124
125 if (nm == nullptr && begin != nullptr) {
126 // allow nmethod to be deduced from beginning address
127 CodeBlob* cb = CodeCache::find_blob(begin);
128 nm = (cb != nullptr) ? cb->as_nmethod_or_null() : nullptr;
129 }
130 guarantee(nm != nullptr, "must be able to deduce nmethod from other arguments");
131
132 _code = nm;
133 if (nm->relocation_size() == 0) {
134 _current = &dummy_relocInfo - 1;
135 _end = &dummy_relocInfo;
136 } else {
137 assert(((nm->relocation_begin() != nullptr) && (nm->relocation_end() != nullptr)), "valid start and end pointer");
138 _current = nm->relocation_begin() - 1;
139 _end = nm->relocation_end();
140 }
141 _addr = nm->content_begin();
142
143 // Initialize code sections.
144 _section_start[CodeBuffer::SECT_CONSTS] = nm->consts_begin();
145 _section_start[CodeBuffer::SECT_INSTS ] = nm->insts_begin() ;
146 _section_start[CodeBuffer::SECT_STUBS ] = nm->stub_begin() ;
147
148 _section_end [CodeBuffer::SECT_CONSTS] = nm->consts_end() ;
149 _section_end [CodeBuffer::SECT_INSTS ] = nm->insts_end() ;
150 _section_end [CodeBuffer::SECT_STUBS ] = nm->stub_end() ;
151
152 assert(!has_current(), "just checking");
153 assert(begin == nullptr || begin >= nm->code_begin(), "in bounds");
154 assert(limit == nullptr || limit <= nm->code_end(), "in bounds");
155 set_limits(begin, limit);
156 }
157
158
159 RelocIterator::RelocIterator(CodeSection* cs, address begin, address limit) {
160 initialize_misc();
161 assert(((cs->locs_start() != nullptr) && (cs->locs_end() != nullptr)), "valid start and end pointer");
162 _current = cs->locs_start() - 1;
163 _end = cs->locs_end();
164 _addr = cs->start();
165 _code = nullptr; // Not cb->blob();
166
167 CodeBuffer* cb = cs->outer();
168 assert((int) SECT_LIMIT == CodeBuffer::SECT_LIMIT, "my copy must be equal");
169 for (int n = (int) CodeBuffer::SECT_FIRST; n < (int) CodeBuffer::SECT_LIMIT; n++) {
170 CodeSection* cs = cb->code_section(n);
171 _section_start[n] = cs->start();
172 _section_end [n] = cs->end();
173 }
174
175 assert(!has_current(), "just checking");
176
177 assert(begin == nullptr || begin >= cs->start(), "in bounds");
178 assert(limit == nullptr || limit <= cs->end(), "in bounds");
179 set_limits(begin, limit);
180 }
181
182 RelocIterator::RelocIterator(CodeBlob* cb) {
183 initialize_misc();
184 if (cb->is_nmethod()) {
185 _code = cb->as_nmethod();
186 } else {
187 _code = nullptr;
188 }
189 _current = cb->relocation_begin() - 1;
190 _end = cb->relocation_end();
191 _addr = cb->content_begin();
192
193 _section_start[CodeBuffer::SECT_CONSTS] = cb->content_begin();
194 _section_start[CodeBuffer::SECT_INSTS ] = cb->code_begin();
195 _section_start[CodeBuffer::SECT_STUBS ] = cb->code_end();
196
197 _section_end [CodeBuffer::SECT_CONSTS] = cb->code_begin();
198 _section_end [CodeBuffer::SECT_INSTS ] = cb->code_end();
199 _section_end [CodeBuffer::SECT_STUBS ] = cb->code_end();
200
201 assert(!has_current(), "just checking");
202 set_limits(nullptr, nullptr);
203 }
204
205 bool RelocIterator::addr_in_const() const {
206 const int n = CodeBuffer::SECT_CONSTS;
207 if (_section_start[n] == nullptr) {
208 return false;
209 }
210 return section_start(n) <= addr() && addr() < section_end(n);
211 }
212
213
214 void RelocIterator::set_limits(address begin, address limit) {
215 _limit = limit;
216
217 // the limit affects this next stuff:
218 if (begin != nullptr) {
219 relocInfo* backup;
220 address backup_addr;
221 while (true) {
222 backup = _current;
223 backup_addr = _addr;
224 if (!next() || addr() >= begin) break;
225 }
226 // At this point, either we are at the first matching record,
227 // or else there is no such record, and !has_current().
228 // In either case, revert to the immediately preceding state.
229 _current = backup;
230 _addr = backup_addr;
231 set_has_current(false);
232 }
233 }
234
235
236 // All the strange bit-encodings are in here.
237 // The idea is to encode relocation data which are small integers
238 // very efficiently (a single extra halfword). Larger chunks of
239 // relocation data need a halfword header to hold their size.
240 void RelocIterator::advance_over_prefix() {
241 if (_current->is_datalen()) {
242 _data = (short*) _current->data();
243 _datalen = _current->datalen();
244 _current += _datalen + 1; // skip the embedded data & header
245 } else {
246 _databuf = _current->immediate();
247 _data = &_databuf;
248 _datalen = 1;
249 _current++; // skip the header
250 }
251 // The client will see the following relocInfo, whatever that is.
252 // It is the reloc to which the preceding data applies.
253 }
254
255
256 void RelocIterator::initialize_misc() {
257 set_has_current(false);
258 for (int i = (int) CodeBuffer::SECT_FIRST; i < (int) CodeBuffer::SECT_LIMIT; i++) {
259 _section_start[i] = nullptr; // these will be lazily computed, if needed
260 _section_end [i] = nullptr;
261 }
262 }
263
264
265 Relocation* RelocIterator::reloc() {
266 // (take the "switch" out-of-line)
267 relocInfo::relocType t = type();
268 if (false) {}
269 #define EACH_TYPE(name) \
270 else if (t == relocInfo::name##_type) { \
271 return name##_reloc(); \
272 }
273 APPLY_TO_RELOCATIONS(EACH_TYPE);
274 #undef EACH_TYPE
275 assert(t == relocInfo::none, "must be padding");
276 _rh = RelocationHolder::none;
277 return _rh.reloc();
278 }
279
280 // Verify all the destructors are trivial, so we don't need to worry about
281 // destroying old contents of a RelocationHolder being assigned or destroyed.
282 #define VERIFY_TRIVIALLY_DESTRUCTIBLE_AUX(Reloc) \
283 static_assert(std::is_trivially_destructible<Reloc>::value, "must be");
284
285 #define VERIFY_TRIVIALLY_DESTRUCTIBLE(name) \
286 VERIFY_TRIVIALLY_DESTRUCTIBLE_AUX(PASTE_TOKENS(name, _Relocation));
287
288 APPLY_TO_RELOCATIONS(VERIFY_TRIVIALLY_DESTRUCTIBLE)
289 VERIFY_TRIVIALLY_DESTRUCTIBLE_AUX(Relocation)
290
291 #undef VERIFY_TRIVIALLY_DESTRUCTIBLE_AUX
292 #undef VERIFY_TRIVIALLY_DESTRUCTIBLE
293
294 // Define all the copy_into functions. These rely on all Relocation types
295 // being trivially destructible (verified above). So it doesn't matter
296 // whether the target holder has been previously initialized or not. There's
297 // no need to consider that distinction and destruct the relocation in an
298 // already initialized holder.
299 #define DEFINE_COPY_INTO_AUX(Reloc) \
300 void Reloc::copy_into(RelocationHolder& holder) const { \
301 copy_into_helper(*this, holder); \
302 }
303
304 #define DEFINE_COPY_INTO(name) \
305 DEFINE_COPY_INTO_AUX(PASTE_TOKENS(name, _Relocation))
306
307 APPLY_TO_RELOCATIONS(DEFINE_COPY_INTO)
308 DEFINE_COPY_INTO_AUX(Relocation)
309
310 #undef DEFINE_COPY_INTO_AUX
311 #undef DEFINE_COPY_INTO
312
313 //////// Methods for flyweight Relocation types
314
315 // some relocations can compute their own values
316 address Relocation::value() {
317 ShouldNotReachHere();
318 return nullptr;
319 }
320
321
322 void Relocation::set_value(address x) {
323 ShouldNotReachHere();
324 }
325
326 void Relocation::const_set_data_value(address x) {
327 #ifdef _LP64
328 if (format() == relocInfo::narrow_oop_in_const) {
329 *(narrowOop*)addr() = CompressedOops::encode(cast_to_oop(x));
330 } else {
331 #endif
332 *(address*)addr() = x;
333 #ifdef _LP64
334 }
335 #endif
336 }
337
338 void Relocation::const_verify_data_value(address x) {
339 #ifdef _LP64
340 if (format() == relocInfo::narrow_oop_in_const) {
341 guarantee(*(narrowOop*)addr() == CompressedOops::encode(cast_to_oop(x)), "must agree");
342 } else {
343 #endif
344 guarantee(*(address*)addr() == x, "must agree");
345 #ifdef _LP64
346 }
347 #endif
348 }
349
350
351 RelocationHolder Relocation::spec_simple(relocInfo::relocType rtype) {
352 if (rtype == relocInfo::none) return RelocationHolder::none;
353 relocInfo ri = relocInfo(rtype, 0);
354 RelocIterator itr;
355 itr.set_current(ri);
356 itr.reloc();
357 return itr._rh;
358 }
359
360 address Relocation::old_addr_for(address newa,
361 const CodeBuffer* src, CodeBuffer* dest) {
362 int sect = dest->section_index_of(newa);
363 guarantee(sect != CodeBuffer::SECT_NONE, "lost track of this address");
364 address ostart = src->code_section(sect)->start();
365 address nstart = dest->code_section(sect)->start();
366 return ostart + (newa - nstart);
367 }
368
369 address Relocation::new_addr_for(address olda,
370 const CodeBuffer* src, CodeBuffer* dest) {
371 DEBUG_ONLY(const CodeBuffer* src0 = src);
372 int sect = CodeBuffer::SECT_NONE;
373 // Look for olda in the source buffer, and all previous incarnations
374 // if the source buffer has been expanded.
375 for (; src != nullptr; src = src->before_expand()) {
376 sect = src->section_index_of(olda);
377 if (sect != CodeBuffer::SECT_NONE) break;
378 }
379 guarantee(sect != CodeBuffer::SECT_NONE, "lost track of this address");
380 address ostart = src->code_section(sect)->start();
381 address nstart = dest->code_section(sect)->start();
382 return nstart + (olda - ostart);
383 }
384
385 void Relocation::normalize_address(address& addr, const CodeSection* dest, bool allow_other_sections) {
386 address addr0 = addr;
387 if (addr0 == nullptr || dest->allocates2(addr0)) return;
388 CodeBuffer* cb = dest->outer();
389 addr = new_addr_for(addr0, cb, cb);
390 assert(allow_other_sections || dest->contains2(addr),
391 "addr must be in required section");
392 }
393
394
395 void CallRelocation::set_destination(address x) {
396 pd_set_call_destination(x);
397 }
398
399 void CallRelocation::fix_relocation_after_move(const CodeBuffer* src, CodeBuffer* dest) {
400 // Usually a self-relative reference to an external routine.
401 // On some platforms, the reference is absolute (not self-relative).
402 // The enhanced use of pd_call_destination sorts this all out.
403 address orig_addr = old_addr_for(addr(), src, dest);
404 address callee = pd_call_destination(orig_addr);
405 // Reassert the callee address, this time in the new copy of the code.
406 pd_set_call_destination(callee);
407 }
408
409
410 #ifdef USE_TRAMPOLINE_STUB_FIX_OWNER
411 void trampoline_stub_Relocation::fix_relocation_after_move(const CodeBuffer* src, CodeBuffer* dest) {
412 // Finalize owner destination only for nmethods
413 if (dest->blob() != nullptr) return;
414 pd_fix_owner_after_move();
415 }
416 #endif
417
418 //// pack/unpack methods
419
420 void oop_Relocation::pack_data_to(CodeSection* dest) {
421 short* p = (short*) dest->locs_end();
422 p = pack_1_int_to(p, _oop_index);
423 dest->set_locs_end((relocInfo*) p);
424 }
425
426
427 void oop_Relocation::unpack_data() {
428 _oop_index = unpack_1_int();
429 }
430
431 void metadata_Relocation::pack_data_to(CodeSection* dest) {
432 short* p = (short*) dest->locs_end();
433 p = pack_1_int_to(p, _metadata_index);
434 dest->set_locs_end((relocInfo*) p);
435 }
436
437
438 void metadata_Relocation::unpack_data() {
439 _metadata_index = unpack_1_int();
440 }
441
442
443 void virtual_call_Relocation::pack_data_to(CodeSection* dest) {
444 short* p = (short*) dest->locs_end();
445 address point = dest->locs_point();
446
447 normalize_address(_cached_value, dest);
448 jint x0 = scaled_offset_null_special(_cached_value, point);
449 p = pack_2_ints_to(p, x0, _method_index);
450 dest->set_locs_end((relocInfo*) p);
451 }
452
453
454 void virtual_call_Relocation::unpack_data() {
455 jint x0 = 0;
456 unpack_2_ints(x0, _method_index);
457 address point = addr();
458 _cached_value = x0==0? nullptr: address_from_scaled_offset(x0, point);
459 }
460
461 void runtime_call_w_cp_Relocation::pack_data_to(CodeSection * dest) {
462 short* p = pack_1_int_to((short *)dest->locs_end(), (jint)(_offset >> 2));
463 dest->set_locs_end((relocInfo*) p);
464 }
465
466 void runtime_call_w_cp_Relocation::unpack_data() {
467 _offset = unpack_1_int() << 2;
468 }
469
470 void static_stub_Relocation::pack_data_to(CodeSection* dest) {
471 short* p = (short*) dest->locs_end();
472 CodeSection* insts = dest->outer()->insts();
473 normalize_address(_static_call, insts);
474 p = pack_1_int_to(p, scaled_offset(_static_call, insts->start()));
475 dest->set_locs_end((relocInfo*) p);
476 }
477
478 void static_stub_Relocation::unpack_data() {
479 address base = binding()->section_start(CodeBuffer::SECT_INSTS);
480 jint offset = unpack_1_int();
481 _static_call = address_from_scaled_offset(offset, base);
482 }
483
484 void trampoline_stub_Relocation::pack_data_to(CodeSection* dest ) {
485 short* p = (short*) dest->locs_end();
486 CodeSection* insts = dest->outer()->insts();
487 normalize_address(_owner, insts);
488 p = pack_1_int_to(p, scaled_offset(_owner, insts->start()));
489 dest->set_locs_end((relocInfo*) p);
490 }
491
492 void trampoline_stub_Relocation::unpack_data() {
493 address base = binding()->section_start(CodeBuffer::SECT_INSTS);
494 _owner = address_from_scaled_offset(unpack_1_int(), base);
495 }
496
497 void external_word_Relocation::pack_data_to(CodeSection* dest) {
498 short* p = (short*) dest->locs_end();
499 int index = ExternalsRecorder::find_index(_target);
500 // Use 4 bytes to store index to be able patch it when
501 // updating relocations in AOTCodeReader::read_relocations().
502 p = add_jint(p, index);
503 dest->set_locs_end((relocInfo*) p);
504 }
505
506
507 void external_word_Relocation::unpack_data() {
508 int index = unpack_1_int();
509 _target = ExternalsRecorder::at(index);
510 }
511
512
513 void internal_word_Relocation::pack_data_to(CodeSection* dest) {
514 short* p = (short*) dest->locs_end();
515 normalize_address(_target, dest, true);
516
517 // Check whether my target address is valid within this section.
518 // If not, strengthen the relocation type to point to another section.
519 int sindex = _section;
520 if (sindex == CodeBuffer::SECT_NONE && _target != nullptr
521 && (!dest->allocates(_target) || _target == dest->locs_point())) {
522 sindex = dest->outer()->section_index_of(_target);
523 guarantee(sindex != CodeBuffer::SECT_NONE, "must belong somewhere");
524 relocInfo* base = dest->locs_end() - 1;
525 assert(base->type() == this->type(), "sanity");
526 // Change the written type, to be section_word_type instead.
527 base->set_type(relocInfo::section_word_type);
528 }
529
530 // Note: An internal_word relocation cannot refer to its own instruction,
531 // because we reserve "0" to mean that the pointer itself is embedded
532 // in the code stream. We use a section_word relocation for such cases.
533
534 if (sindex == CodeBuffer::SECT_NONE) {
535 assert(type() == relocInfo::internal_word_type, "must be base class");
536 guarantee(_target == nullptr || dest->allocates2(_target), "must be within the given code section");
537 jint x0 = scaled_offset_null_special(_target, dest->locs_point());
538 assert(!(x0 == 0 && _target != nullptr), "correct encoding of null target");
539 p = pack_1_int_to(p, x0);
540 } else {
541 assert(_target != nullptr, "sanity");
542 CodeSection* sect = dest->outer()->code_section(sindex);
543 guarantee(sect->allocates2(_target), "must be in correct section");
544 address base = sect->start();
545 jint offset = scaled_offset(_target, base);
546 assert((uint)sindex < (uint)CodeBuffer::SECT_LIMIT, "sanity");
547 assert(CodeBuffer::SECT_LIMIT <= (1 << section_width), "section_width++");
548 p = pack_1_int_to(p, (offset << section_width) | sindex);
549 }
550
551 dest->set_locs_end((relocInfo*) p);
552 }
553
554
555 void internal_word_Relocation::unpack_data() {
556 jint x0 = unpack_1_int();
557 _target = x0==0? nullptr: address_from_scaled_offset(x0, addr());
558 _section = CodeBuffer::SECT_NONE;
559 }
560
561
562 void section_word_Relocation::unpack_data() {
563 jint x = unpack_1_int();
564 jint offset = (x >> section_width);
565 int sindex = (x & ((1<<section_width)-1));
566 address base = binding()->section_start(sindex);
567
568 _section = sindex;
569 _target = address_from_scaled_offset(offset, base);
570 }
571
572 //// miscellaneous methods
573 oop* oop_Relocation::oop_addr() {
574 int n = _oop_index;
575 if (n == 0) {
576 // oop is stored in the code stream
577 return (oop*) pd_address_in_code();
578 } else {
579 // oop is stored in table at nmethod::oops_begin
580 return code()->oop_addr_at(n);
581 }
582 }
583
584
585 oop oop_Relocation::oop_value() {
586 // clean inline caches store a special pseudo-null
587 if (Universe::contains_non_oop_word(oop_addr())) {
588 return nullptr;
589 }
590 return *oop_addr();
591 }
592
593
594 void oop_Relocation::fix_oop_relocation() {
595 if (!oop_is_immediate()) {
596 // get the oop from the pool, and re-insert it into the instruction:
597 set_value(value());
598 }
599 }
600
601
602 void oop_Relocation::verify_oop_relocation() {
603 if (!oop_is_immediate()) {
604 // get the oop from the pool, and re-insert it into the instruction:
605 verify_value(value());
606 }
607 }
608
609 // meta data versions
610 Metadata** metadata_Relocation::metadata_addr() {
611 int n = _metadata_index;
612 if (n == 0) {
613 // metadata is stored in the code stream
614 return (Metadata**) pd_address_in_code();
615 } else {
616 // metadata is stored in table at nmethod::metadatas_begin
617 return code()->metadata_addr_at(n);
618 }
619 }
620
621
622 Metadata* metadata_Relocation::metadata_value() {
623 Metadata* v = *metadata_addr();
624 // clean inline caches store a special pseudo-null
625 if (v == (Metadata*)Universe::non_oop_word()) v = nullptr;
626 return v;
627 }
628
629
630 void metadata_Relocation::fix_metadata_relocation() {
631 if (!metadata_is_immediate()) {
632 // get the metadata from the pool, and re-insert it into the instruction:
633 pd_fix_value(value());
634 }
635 }
636
637 address virtual_call_Relocation::cached_value() {
638 assert(_cached_value != nullptr && _cached_value < addr(), "must precede ic_call");
639 return _cached_value;
640 }
641
642 Method* virtual_call_Relocation::method_value() {
643 nmethod* nm = code();
644 if (nm == nullptr) return (Method*)nullptr;
645 Metadata* m = nm->metadata_at(_method_index);
646 assert(m != nullptr || _method_index == 0, "should be non-null for non-zero index");
647 assert(m == nullptr || m->is_method(), "not a method");
648 return (Method*)m;
649 }
650
651 void virtual_call_Relocation::clear_inline_cache() {
652 ResourceMark rm;
653 CompiledIC* icache = CompiledIC_at(this);
654 icache->set_to_clean();
655 }
656
657
658 void opt_virtual_call_Relocation::pack_data_to(CodeSection* dest) {
659 short* p = (short*) dest->locs_end();
660 p = pack_1_int_to(p, _method_index);
661 dest->set_locs_end((relocInfo*) p);
662 }
663
664 void opt_virtual_call_Relocation::unpack_data() {
665 _method_index = unpack_1_int();
666 }
667
668 Method* opt_virtual_call_Relocation::method_value() {
669 nmethod* nm = code();
670 if (nm == nullptr) return (Method*)nullptr;
671 Metadata* m = nm->metadata_at(_method_index);
672 assert(m != nullptr || _method_index == 0, "should be non-null for non-zero index");
673 assert(m == nullptr || m->is_method(), "not a method");
674 return (Method*)m;
675 }
676
677 void opt_virtual_call_Relocation::clear_inline_cache() {
678 ResourceMark rm;
679 CompiledDirectCall* callsite = CompiledDirectCall::at(this);
680 callsite->set_to_clean();
681 }
682
683 address opt_virtual_call_Relocation::static_stub() {
684 // search for the static stub who points back to this static call
685 address static_call_addr = addr();
686 RelocIterator iter(code());
687 while (iter.next()) {
688 if (iter.type() == relocInfo::static_stub_type) {
689 static_stub_Relocation* stub_reloc = iter.static_stub_reloc();
690 if (stub_reloc->static_call() == static_call_addr) {
691 return iter.addr();
692 }
693 }
694 }
695 return nullptr;
696 }
697
698 Method* static_call_Relocation::method_value() {
699 nmethod* nm = code();
700 if (nm == nullptr) return (Method*)nullptr;
701 Metadata* m = nm->metadata_at(_method_index);
702 assert(m != nullptr || _method_index == 0, "should be non-null for non-zero index");
703 assert(m == nullptr || m->is_method(), "not a method");
704 return (Method*)m;
705 }
706
707 void static_call_Relocation::pack_data_to(CodeSection* dest) {
708 short* p = (short*) dest->locs_end();
709 p = pack_1_int_to(p, _method_index);
710 dest->set_locs_end((relocInfo*) p);
711 }
712
713 void static_call_Relocation::unpack_data() {
714 _method_index = unpack_1_int();
715 }
716
717 void static_call_Relocation::clear_inline_cache() {
718 ResourceMark rm;
719 CompiledDirectCall* callsite = CompiledDirectCall::at(this);
720 callsite->set_to_clean();
721 }
722
723
724 address static_call_Relocation::static_stub() {
725 // search for the static stub who points back to this static call
726 address static_call_addr = addr();
727 RelocIterator iter(code());
728 while (iter.next()) {
729 if (iter.type() == relocInfo::static_stub_type) {
730 static_stub_Relocation* stub_reloc = iter.static_stub_reloc();
731 if (stub_reloc->static_call() == static_call_addr) {
732 return iter.addr();
733 }
734 }
735 }
736 return nullptr;
737 }
738
739 // Finds the trampoline address for a call. If no trampoline stub is
740 // found nullptr is returned which can be handled by the caller.
741 address trampoline_stub_Relocation::get_trampoline_for(address call, nmethod* code) {
742 // There are no relocations available when the code gets relocated
743 // because of CodeBuffer expansion.
744 if (code->relocation_size() == 0)
745 return nullptr;
746
747 RelocIterator iter(code, call);
748 while (iter.next()) {
749 if (iter.type() == relocInfo::trampoline_stub_type) {
750 if (iter.trampoline_stub_reloc()->owner() == call) {
751 return iter.addr();
752 }
753 }
754 }
755
756 return nullptr;
757 }
758
759 void static_stub_Relocation::clear_inline_cache() {
760 // Call stub is only used when calling the interpreted code.
761 // It does not really need to be cleared, except that we want to clean out the methodoop.
762 CompiledDirectCall::set_stub_to_clean(this);
763 }
764
765
766 void external_word_Relocation::fix_relocation_after_move(const CodeBuffer* src, CodeBuffer* dest) {
767 if (_target != nullptr) {
768 // Probably this reference is absolute, not relative, so the following is
769 // probably a no-op.
770 set_value(_target);
771 }
772 // If target is nullptr, this is an absolute embedded reference to an external
773 // location, which means there is nothing to fix here. In either case, the
774 // resulting target should be an "external" address.
775 postcond(src->section_index_of(target()) == CodeBuffer::SECT_NONE);
776 postcond(dest->section_index_of(target()) == CodeBuffer::SECT_NONE);
777 }
778
779
780 address external_word_Relocation::target() {
781 address target = _target;
782 if (target == nullptr) {
783 target = pd_get_address_from_code();
784 }
785 return target;
786 }
787
788
789 void internal_word_Relocation::fix_relocation_after_move(const CodeBuffer* src, CodeBuffer* dest) {
790 address target = _target;
791 if (target == nullptr) {
792 target = new_addr_for(this->target(), src, dest);
793 }
794 set_value(target);
795 }
796
797 void internal_word_Relocation::fix_relocation_after_aot_load(address orig_base_addr, address current_base_addr) {
798 address target = _target;
799 if (target == nullptr) {
800 target = this->target();
801 target = current_base_addr + (target - orig_base_addr);
802 }
803 set_value(target);
804 }
805
806 address internal_word_Relocation::target() {
807 address target = _target;
808 if (target == nullptr) {
809 if (addr_in_const()) {
810 target = *(address*)addr();
811 } else {
812 target = pd_get_address_from_code();
813 }
814 }
815 return target;
816 }
817
818 const char* relocInfo::type_name(relocInfo::relocType t) {
819 switch (t) {
820 #define EACH_CASE(name) \
821 case relocInfo::name##_type: \
822 return #name;
823
824 APPLY_TO_RELOCATIONS(EACH_CASE);
825 #undef EACH_CASE
826
827 case relocInfo::none:
828 return "none";
829 case relocInfo::data_prefix_tag:
830 return "prefix";
831 default:
832 return "UNKNOWN RELOC TYPE";
833 }
834 }
835
836 void RelocIterator::print_current_on(outputStream* st) {
837 if (!has_current()) {
838 st->print_cr("(no relocs)");
839 return;
840 }
841 st->print("relocInfo@" INTPTR_FORMAT " [type=%d(%s) addr=" INTPTR_FORMAT " offset=%d",
842 p2i(_current), type(), relocInfo::type_name((relocInfo::relocType) type()), p2i(_addr), _current->addr_offset());
843 if (current()->format() != 0)
844 st->print(" format=%d", current()->format());
845 if (datalen() == 1) {
846 st->print(" data=%d", data()[0]);
847 } else if (datalen() > 0) {
848 st->print(" data={");
849 for (int i = 0; i < datalen(); i++) {
850 st->print("%04x", data()[i] & 0xFFFF);
851 }
852 st->print("}");
853 }
854 st->print("]");
855 switch (type()) {
856 case relocInfo::oop_type:
857 {
858 oop_Relocation* r = oop_reloc();
859 oop* oop_addr = nullptr;
860 oop raw_oop = nullptr;
861 oop oop_value = nullptr;
862 if (code() != nullptr || r->oop_is_immediate()) {
863 oop_addr = r->oop_addr();
864 raw_oop = *oop_addr;
865 oop_value = r->oop_value();
866 }
867 st->print(" | [oop_addr=" INTPTR_FORMAT " *=" INTPTR_FORMAT "]",
868 p2i(oop_addr), p2i(raw_oop));
869 // Do not print the oop by default--we want this routine to
870 // work even during GC or other inconvenient times.
871 if (WizardMode && oop_value != nullptr) {
872 st->print("oop_value=" INTPTR_FORMAT ": ", p2i(oop_value));
873 if (oopDesc::is_oop(oop_value)) {
874 oop_value->print_value_on(st);
875 }
876 }
877 break;
878 }
879 case relocInfo::metadata_type:
880 {
881 metadata_Relocation* r = metadata_reloc();
882 Metadata** metadata_addr = nullptr;
883 Metadata* raw_metadata = nullptr;
884 Metadata* metadata_value = nullptr;
885 if (code() != nullptr || r->metadata_is_immediate()) {
886 metadata_addr = r->metadata_addr();
887 raw_metadata = *metadata_addr;
888 metadata_value = r->metadata_value();
889 }
890 st->print(" | [metadata_addr=" INTPTR_FORMAT " *=" INTPTR_FORMAT "]",
891 p2i(metadata_addr), p2i(raw_metadata));
892 if (metadata_value != nullptr) {
893 st->print("metadata_value=" INTPTR_FORMAT ": ", p2i(metadata_value));
894 metadata_value->print_value_on(st);
895 }
896 break;
897 }
898 case relocInfo::external_word_type:
899 case relocInfo::internal_word_type:
900 case relocInfo::section_word_type:
901 {
902 DataRelocation* r = (DataRelocation*) reloc();
903 st->print(" | [target=" INTPTR_FORMAT "]", p2i(r->value())); //value==target
904 break;
905 }
906 case relocInfo::static_call_type:
907 {
908 static_call_Relocation* r = (static_call_Relocation*) reloc();
909 st->print(" | [destination=" INTPTR_FORMAT " metadata=" INTPTR_FORMAT "]",
910 p2i(r->destination()), p2i(r->method_value()));
911 CodeBlob* cb = CodeCache::find_blob(r->destination());
912 if (cb != nullptr) {
913 st->print(" Blob::%s", cb->name());
914 }
915 break;
916 }
917 case relocInfo::runtime_call_type:
918 case relocInfo::runtime_call_w_cp_type:
919 {
920 CallRelocation* r = (CallRelocation*) reloc();
921 address dest = r->destination();
922 st->print(" | [destination=" INTPTR_FORMAT "]", p2i(dest));
923 if (StubRoutines::contains(dest)) {
924 StubCodeDesc* desc = StubCodeDesc::desc_for(dest);
925 if (desc == nullptr) {
926 desc = StubCodeDesc::desc_for(dest + frame::pc_return_offset);
927 }
928 if (desc != nullptr) {
929 st->print(" Stub::%s", desc->name());
930 }
931 } else {
932 CodeBlob* cb = CodeCache::find_blob(dest);
933 if (cb != nullptr) {
934 st->print(" %s", cb->name());
935 } else {
936 ResourceMark rm;
937 const int buflen = 1024;
938 char* buf = NEW_RESOURCE_ARRAY(char, buflen);
939 int offset;
940 if (os::dll_address_to_function_name(dest, buf, buflen, &offset)) {
941 st->print(" %s", buf);
942 if (offset != 0) {
943 st->print("+%d", offset);
944 }
945 }
946 }
947 }
948 break;
949 }
950 case relocInfo::virtual_call_type:
951 {
952 virtual_call_Relocation* r = (virtual_call_Relocation*) reloc();
953 st->print(" | [destination=" INTPTR_FORMAT " cached_value=" INTPTR_FORMAT " metadata=" INTPTR_FORMAT "]",
954 p2i(r->destination()), p2i(r->cached_value()), p2i(r->method_value()));
955 CodeBlob* cb = CodeCache::find_blob(r->destination());
956 if (cb != nullptr) {
957 st->print(" Blob::%s", cb->name());
958 }
959 break;
960 }
961 case relocInfo::static_stub_type:
962 {
963 static_stub_Relocation* r = (static_stub_Relocation*) reloc();
964 st->print(" | [static_call=" INTPTR_FORMAT "]", p2i(r->static_call()));
965 break;
966 }
967 case relocInfo::trampoline_stub_type:
968 {
969 trampoline_stub_Relocation* r = (trampoline_stub_Relocation*) reloc();
970 st->print(" | [trampoline owner=" INTPTR_FORMAT "]", p2i(r->owner()));
971 break;
972 }
973 case relocInfo::opt_virtual_call_type:
974 {
975 opt_virtual_call_Relocation* r = (opt_virtual_call_Relocation*) reloc();
976 st->print(" | [destination=" INTPTR_FORMAT " metadata=" INTPTR_FORMAT "]",
977 p2i(r->destination()), p2i(r->method_value()));
978 CodeBlob* cb = CodeCache::find_blob(r->destination());
979 if (cb != nullptr) {
980 st->print(" Blob::%s", cb->name());
981 }
982 break;
983 }
984 default:
985 break;
986 }
987 st->cr();
988 }
989
990
991 void RelocIterator::print_on(outputStream* st) {
992 RelocIterator save_this = (*this);
993 relocInfo* scan = _current;
994 if (!has_current()) scan += 1; // nothing to scan here!
995
996 bool skip_next = has_current();
997 bool got_next;
998 while (true) {
999 got_next = (skip_next || next());
1000 skip_next = false;
1001
1002 st->print(" @" INTPTR_FORMAT ": ", p2i(scan));
1003 relocInfo* newscan = _current+1;
1004 if (!has_current()) newscan -= 1; // nothing to scan here!
1005 while (scan < newscan) {
1006 st->print("%04x", *(short*)scan & 0xFFFF);
1007 scan++;
1008 }
1009 st->cr();
1010
1011 if (!got_next) break;
1012 print_current_on(st);
1013 }
1014
1015 (*this) = save_this;
1016 }
1017
1018 //---------------------------------------------------------------------------------
1019 // Non-product code
1020
1021 #ifndef PRODUCT
1022
1023 // For the debugger:
1024 extern "C"
1025 void print_blob_locs(nmethod* nm) {
1026 nm->print();
1027 RelocIterator iter(nm);
1028 iter.print_on(tty);
1029 }
1030 extern "C"
1031 void print_buf_locs(CodeBuffer* cb) {
1032 FlagSetting fs(PrintRelocations, true);
1033 cb->print_on(tty);
1034 }
1035 #endif // !PRODUCT