1 /*
2 * Copyright (c) 1998, 2010, 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 // CodeBlob - superclass for all entries in the CodeCache.
26 //
27 // Suptypes are:
28 // nmethod : Compiled Java methods (include method that calls to native code)
29 // RuntimeStub : Call to VM runtime methods
30 // DeoptimizationBlob : Used for deoptimizatation
31 // ExceptionBlob : Used for stack unrolling
32 // SafepointBlob : Used to handle illegal instruction exceptions
33 //
34 //
35 // Layout:
36 // - header
37 // - relocation
38 // - content space
39 // - instruction space
40 // - data space
41 class DeoptimizationBlob;
42
43 class CodeBlob VALUE_OBJ_CLASS_SPEC {
44
45 friend class VMStructs;
46
47 private:
48 const char* _name;
49 int _size; // total size of CodeBlob in bytes
50 int _header_size; // size of header (depends on subclass)
51 int _relocation_size; // size of relocation
52 int _content_offset; // offset to where content region begins (this includes consts, insts, stubs)
53 int _code_offset; // offset to where instructions region begins (this includes insts, stubs)
54 int _frame_complete_offset; // instruction offsets in [0.._frame_complete_offset) have
55 // not finished setting up their frame. Beware of pc's in
56 // that range. There is a similar range(s) on returns
57 // which we don't detect.
58 int _data_offset; // offset to where data region begins
59 int _frame_size; // size of stack frame
60 OopMapSet* _oop_maps; // OopMap for this CodeBlob
61 CodeComments _comments;
62
63 friend class OopRecorder;
64
65 public:
66 // Returns the space needed for CodeBlob
67 static unsigned int allocation_size(CodeBuffer* cb, int header_size);
68
69 // Creation
70 // a) simple CodeBlob
71 // frame_complete is the offset from the beginning of the instructions
72 // to where the frame setup (from stackwalk viewpoint) is complete.
73 CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);
74
75 // b) full CodeBlob
76 CodeBlob(
77 const char* name,
78 CodeBuffer* cb,
79 int header_size,
80 int size,
81 int frame_complete,
82 int frame_size,
83 OopMapSet* oop_maps
84 );
85
86 // Deletion
87 void flush();
88
89 // Typing
90 virtual bool is_buffer_blob() const { return false; }
91 virtual bool is_nmethod() const { return false; }
92 virtual bool is_runtime_stub() const { return false; }
93 virtual bool is_deoptimization_stub() const { return false; }
94 virtual bool is_uncommon_trap_stub() const { return false; }
95 virtual bool is_exception_stub() const { return false; }
96 virtual bool is_safepoint_stub() const { return false; }
97 virtual bool is_adapter_blob() const { return false; }
98 virtual bool is_method_handles_adapter_blob() const { return false; }
99
100 virtual bool is_compiled_by_c2() const { return false; }
101 virtual bool is_compiled_by_c1() const { return false; }
102
103 // Casting
104 nmethod* as_nmethod_or_null() { return is_nmethod() ? (nmethod*) this : NULL; }
105
106 // Boundaries
107 address header_begin() const { return (address) this; }
108 address header_end() const { return ((address) this) + _header_size; };
109 relocInfo* relocation_begin() const { return (relocInfo*) header_end(); };
110 relocInfo* relocation_end() const { return (relocInfo*)(header_end() + _relocation_size); }
111 address content_begin() const { return (address) header_begin() + _content_offset; }
112 address content_end() const { return (address) header_begin() + _data_offset; }
113 address code_begin() const { return (address) header_begin() + _code_offset; }
114 address code_end() const { return (address) header_begin() + _data_offset; }
115 address data_begin() const { return (address) header_begin() + _data_offset; }
116 address data_end() const { return (address) header_begin() + _size; }
117
118 // Offsets
119 int relocation_offset() const { return _header_size; }
120 int content_offset() const { return _content_offset; }
121 int code_offset() const { return _code_offset; }
122 int data_offset() const { return _data_offset; }
123
124 // Sizes
125 int size() const { return _size; }
126 int header_size() const { return _header_size; }
127 int relocation_size() const { return (address) relocation_end() - (address) relocation_begin(); }
128 int content_size() const { return content_end() - content_begin(); }
129 int code_size() const { return code_end() - code_begin(); }
130 int data_size() const { return data_end() - data_begin(); }
131
132 // Containment
133 bool blob_contains(address addr) const { return header_begin() <= addr && addr < data_end(); }
134 bool relocation_contains(relocInfo* addr) const{ return relocation_begin() <= addr && addr < relocation_end(); }
135 bool content_contains(address addr) const { return content_begin() <= addr && addr < content_end(); }
136 bool code_contains(address addr) const { return code_begin() <= addr && addr < code_end(); }
137 bool data_contains(address addr) const { return data_begin() <= addr && addr < data_end(); }
138 bool contains(address addr) const { return content_contains(addr); }
139 bool is_frame_complete_at(address addr) const { return code_contains(addr) &&
140 addr >= code_begin() + _frame_complete_offset; }
141
142 // CodeCache support: really only used by the nmethods, but in order to get
143 // asserts and certain bookkeeping to work in the CodeCache they are defined
144 // virtual here.
145 virtual bool is_zombie() const { return false; }
146 virtual bool is_locked_by_vm() const { return false; }
147
148 virtual bool is_unloaded() const { return false; }
149 virtual bool is_not_entrant() const { return false; }
150
151 // GC support
152 virtual bool is_alive() const = 0;
153
154 // OopMap for frame
155 OopMapSet* oop_maps() const { return _oop_maps; }
156 void set_oop_maps(OopMapSet* p);
157 OopMap* oop_map_for_return_address(address return_address);
158 virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { ShouldNotReachHere(); }
159
160 // Frame support
161 int frame_size() const { return _frame_size; }
162 void set_frame_size(int size) { _frame_size = size; }
163
164 // Returns true, if the next frame is responsible for GC'ing oops passed as arguments
165 virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }
166
167 // Naming
168 const char* name() const { return _name; }
169 void set_name(const char* name) { _name = name; }
170
171 // Debugging
172 virtual void verify();
173 void print() const { print_on(tty); }
174 virtual void print_on(outputStream* st) const;
175 virtual void print_value_on(outputStream* st) const;
176
177 // Print the comment associated with offset on stream, if there is one
178 virtual void print_block_comment(outputStream* stream, address block_begin) {
179 intptr_t offset = (intptr_t)(block_begin - code_begin());
180 _comments.print_block_comment(stream, offset);
181 }
182
183 // Transfer ownership of comments to this CodeBlob
184 void set_comments(CodeComments& comments) {
185 _comments.assign(comments);
186 }
187 };
188
189
190 //----------------------------------------------------------------------------------------------------
191 // BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.
192
193 class BufferBlob: public CodeBlob {
194 friend class VMStructs;
195 friend class AdapterBlob;
196 friend class MethodHandlesAdapterBlob;
197
198 private:
199 // Creation support
200 BufferBlob(const char* name, int size);
201 BufferBlob(const char* name, int size, CodeBuffer* cb);
202
203 void* operator new(size_t s, unsigned size);
204
205 public:
206 // Creation
207 static BufferBlob* create(const char* name, int buffer_size);
208 static BufferBlob* create(const char* name, CodeBuffer* cb);
209
210 static void free(BufferBlob* buf);
211
212 // Typing
213 virtual bool is_buffer_blob() const { return true; }
214
215 // GC/Verification support
216 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
217 bool is_alive() const { return true; }
218
219 void verify();
220 void print_on(outputStream* st) const;
221 void print_value_on(outputStream* st) const;
222 };
223
224
225 //----------------------------------------------------------------------------------------------------
226 // AdapterBlob: used to hold C2I/I2C adapters
227
228 class AdapterBlob: public BufferBlob {
229 private:
230 AdapterBlob(int size, CodeBuffer* cb);
231
232 public:
233 // Creation
234 static AdapterBlob* create(CodeBuffer* cb);
235
236 // Typing
237 virtual bool is_adapter_blob() const { return true; }
238 };
239
240
241 //----------------------------------------------------------------------------------------------------
242 // MethodHandlesAdapterBlob: used to hold MethodHandles adapters
243
244 class MethodHandlesAdapterBlob: public BufferBlob {
245 private:
246 MethodHandlesAdapterBlob(int size) : BufferBlob("MethodHandles adapters", size) {}
247 MethodHandlesAdapterBlob(int size, CodeBuffer* cb) : BufferBlob("MethodHandles adapters", size, cb) {}
248
249 public:
250 // Creation
251 static MethodHandlesAdapterBlob* create(int buffer_size);
252
253 // Typing
254 virtual bool is_method_handles_adapter_blob() const { return true; }
255 };
256
257
258 //----------------------------------------------------------------------------------------------------
259 // RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine
260
261 class RuntimeStub: public CodeBlob {
262 friend class VMStructs;
263 private:
264 bool _caller_must_gc_arguments;
265
266 // Creation support
267 RuntimeStub(
268 const char* name,
269 CodeBuffer* cb,
270 int size,
271 int frame_complete,
272 int frame_size,
273 OopMapSet* oop_maps,
274 bool caller_must_gc_arguments
275 );
276
277 void* operator new(size_t s, unsigned size);
278
279 public:
280 // Creation
281 static RuntimeStub* new_runtime_stub(
282 const char* stub_name,
283 CodeBuffer* cb,
284 int frame_complete,
285 int frame_size,
286 OopMapSet* oop_maps,
287 bool caller_must_gc_arguments
288 );
289
290 // Typing
291 bool is_runtime_stub() const { return true; }
292
293 // GC support
294 bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }
295
296 address entry_point() { return code_begin(); }
297
298 // GC/Verification support
299 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* nothing to do */ }
300 bool is_alive() const { return true; }
301
302 void verify();
303 void print_on(outputStream* st) const;
304 void print_value_on(outputStream* st) const;
305 };
306
307
308 //----------------------------------------------------------------------------------------------------
309 // Super-class for all blobs that exist in only one instance. Implements default behaviour.
310
311 class SingletonBlob: public CodeBlob {
312 friend class VMStructs;
313 public:
314 SingletonBlob(
315 const char* name,
316 CodeBuffer* cb,
317 int header_size,
318 int size,
319 int frame_size,
320 OopMapSet* oop_maps
321 )
322 : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)
323 {};
324
325 address entry_point() { return code_begin(); }
326
327 bool is_alive() const { return true; }
328
329 void verify(); // does nothing
330 void print_on(outputStream* st) const;
331 void print_value_on(outputStream* st) const;
332 };
333
334
335 //----------------------------------------------------------------------------------------------------
336 // DeoptimizationBlob
337
338 class DeoptimizationBlob: public SingletonBlob {
339 friend class VMStructs;
340 private:
341 int _unpack_offset;
342 int _unpack_with_exception;
343 int _unpack_with_reexecution;
344
345 int _unpack_with_exception_in_tls;
346
347 // Creation support
348 DeoptimizationBlob(
349 CodeBuffer* cb,
350 int size,
351 OopMapSet* oop_maps,
352 int unpack_offset,
353 int unpack_with_exception_offset,
354 int unpack_with_reexecution_offset,
355 int frame_size
356 );
357
358 void* operator new(size_t s, unsigned size);
359
360 public:
361 // Creation
362 static DeoptimizationBlob* create(
363 CodeBuffer* cb,
364 OopMapSet* oop_maps,
365 int unpack_offset,
366 int unpack_with_exception_offset,
367 int unpack_with_reexecution_offset,
368 int frame_size
369 );
370
371 // Typing
372 bool is_deoptimization_stub() const { return true; }
373 const DeoptimizationBlob *as_deoptimization_stub() const { return this; }
374 bool exception_address_is_unpack_entry(address pc) const {
375 address unpack_pc = unpack();
376 return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);
377 }
378
379
380
381
382 // GC for args
383 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }
384
385 // Printing
386 void print_value_on(outputStream* st) const;
387
388 address unpack() const { return code_begin() + _unpack_offset; }
389 address unpack_with_exception() const { return code_begin() + _unpack_with_exception; }
390 address unpack_with_reexecution() const { return code_begin() + _unpack_with_reexecution; }
391
392 // Alternate entry point for C1 where the exception and issuing pc
393 // are in JavaThread::_exception_oop and JavaThread::_exception_pc
394 // instead of being in registers. This is needed because C1 doesn't
395 // model exception paths in a way that keeps these registers free so
396 // there may be live values in those registers during deopt.
397 void set_unpack_with_exception_in_tls_offset(int offset) {
398 _unpack_with_exception_in_tls = offset;
399 assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");
400 }
401 address unpack_with_exception_in_tls() const { return code_begin() + _unpack_with_exception_in_tls; }
402 };
403
404
405 //----------------------------------------------------------------------------------------------------
406 // UncommonTrapBlob (currently only used by Compiler 2)
407
408 #ifdef COMPILER2
409
410 class UncommonTrapBlob: public SingletonBlob {
411 friend class VMStructs;
412 private:
413 // Creation support
414 UncommonTrapBlob(
415 CodeBuffer* cb,
416 int size,
417 OopMapSet* oop_maps,
418 int frame_size
419 );
420
421 void* operator new(size_t s, unsigned size);
422
423 public:
424 // Creation
425 static UncommonTrapBlob* create(
426 CodeBuffer* cb,
427 OopMapSet* oop_maps,
428 int frame_size
429 );
430
431 // GC for args
432 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* nothing to do */ }
433
434 // Typing
435 bool is_uncommon_trap_stub() const { return true; }
436 };
437
438
439 //----------------------------------------------------------------------------------------------------
440 // ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)
441
442 class ExceptionBlob: public SingletonBlob {
443 friend class VMStructs;
444 private:
445 // Creation support
446 ExceptionBlob(
447 CodeBuffer* cb,
448 int size,
449 OopMapSet* oop_maps,
450 int frame_size
451 );
452
453 void* operator new(size_t s, unsigned size);
454
455 public:
456 // Creation
457 static ExceptionBlob* create(
458 CodeBuffer* cb,
459 OopMapSet* oop_maps,
460 int frame_size
461 );
462
463 // GC for args
464 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
465
466 // Typing
467 bool is_exception_stub() const { return true; }
468 };
469 #endif // COMPILER2
470
471
472 //----------------------------------------------------------------------------------------------------
473 // SafepointBlob: handles illegal_instruction exceptions during a safepoint
474
475 class SafepointBlob: public SingletonBlob {
476 friend class VMStructs;
477 private:
478 // Creation support
479 SafepointBlob(
480 CodeBuffer* cb,
481 int size,
482 OopMapSet* oop_maps,
483 int frame_size
484 );
485
486 void* operator new(size_t s, unsigned size);
487
488 public:
489 // Creation
490 static SafepointBlob* create(
491 CodeBuffer* cb,
492 OopMapSet* oop_maps,
493 int frame_size
494 );
495
496 // GC for args
497 void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f) { /* nothing to do */ }
498
499 // Typing
500 bool is_safepoint_stub() const { return true; }
501 };