Mon, 01 Feb 2010 19:29:46 +0100
6921352: JSR 292 needs its own deopt handler
Summary: We need to introduce a new MH deopt handler so we can easily determine if the deopt happened at a MH call site or not.
Reviewed-by: never, jrose
1 /*
2 * Copyright 1997-2010 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
25 class CodeComments;
26 class AbstractAssembler;
27 class MacroAssembler;
28 class PhaseCFG;
29 class Compile;
30 class BufferBlob;
31 class CodeBuffer;
33 class CodeOffsets: public StackObj {
34 public:
35 enum Entries { Entry,
36 Verified_Entry,
37 Frame_Complete, // Offset in the code where the frame setup is (for forte stackwalks) is complete
38 OSR_Entry,
39 Dtrace_trap = OSR_Entry, // dtrace probes can never have an OSR entry so reuse it
40 Exceptions, // Offset where exception handler lives
41 Deopt, // Offset where deopt handler lives
42 DeoptMH, // Offset where MethodHandle deopt handler lives
43 max_Entries };
45 // special value to note codeBlobs where profile (forte) stack walking is
46 // always dangerous and suspect.
48 enum { frame_never_safe = -1 };
50 private:
51 int _values[max_Entries];
53 public:
54 CodeOffsets() {
55 _values[Entry ] = 0;
56 _values[Verified_Entry] = 0;
57 _values[Frame_Complete] = frame_never_safe;
58 _values[OSR_Entry ] = 0;
59 _values[Exceptions ] = -1;
60 _values[Deopt ] = -1;
61 _values[DeoptMH ] = -1;
62 }
64 int value(Entries e) { return _values[e]; }
65 void set_value(Entries e, int val) { _values[e] = val; }
66 };
68 // This class represents a stream of code and associated relocations.
69 // There are a few in each CodeBuffer.
70 // They are filled concurrently, and concatenated at the end.
71 class CodeSection VALUE_OBJ_CLASS_SPEC {
72 friend class CodeBuffer;
73 public:
74 typedef int csize_t; // code size type; would be size_t except for history
76 private:
77 address _start; // first byte of contents (instructions)
78 address _mark; // user mark, usually an instruction beginning
79 address _end; // current end address
80 address _limit; // last possible (allocated) end address
81 relocInfo* _locs_start; // first byte of relocation information
82 relocInfo* _locs_end; // first byte after relocation information
83 relocInfo* _locs_limit; // first byte after relocation information buf
84 address _locs_point; // last relocated position (grows upward)
85 bool _locs_own; // did I allocate the locs myself?
86 bool _frozen; // no more expansion of this section
87 char _index; // my section number (SECT_INST, etc.)
88 CodeBuffer* _outer; // enclosing CodeBuffer
90 // (Note: _locs_point used to be called _last_reloc_offset.)
92 CodeSection() {
93 _start = NULL;
94 _mark = NULL;
95 _end = NULL;
96 _limit = NULL;
97 _locs_start = NULL;
98 _locs_end = NULL;
99 _locs_limit = NULL;
100 _locs_point = NULL;
101 _locs_own = false;
102 _frozen = false;
103 debug_only(_index = -1);
104 debug_only(_outer = (CodeBuffer*)badAddress);
105 }
107 void initialize_outer(CodeBuffer* outer, int index) {
108 _outer = outer;
109 _index = index;
110 }
112 void initialize(address start, csize_t size = 0) {
113 assert(_start == NULL, "only one init step, please");
114 _start = start;
115 _mark = NULL;
116 _end = start;
118 _limit = start + size;
119 _locs_point = start;
120 }
122 void initialize_locs(int locs_capacity);
123 void expand_locs(int new_capacity);
124 void initialize_locs_from(const CodeSection* source_cs);
126 // helper for CodeBuffer::expand()
127 void take_over_code_from(CodeSection* cs) {
128 _start = cs->_start;
129 _mark = cs->_mark;
130 _end = cs->_end;
131 _limit = cs->_limit;
132 _locs_point = cs->_locs_point;
133 }
135 public:
136 address start() const { return _start; }
137 address mark() const { return _mark; }
138 address end() const { return _end; }
139 address limit() const { return _limit; }
140 csize_t size() const { return (csize_t)(_end - _start); }
141 csize_t mark_off() const { assert(_mark != NULL, "not an offset");
142 return (csize_t)(_mark - _start); }
143 csize_t capacity() const { return (csize_t)(_limit - _start); }
144 csize_t remaining() const { return (csize_t)(_limit - _end); }
146 relocInfo* locs_start() const { return _locs_start; }
147 relocInfo* locs_end() const { return _locs_end; }
148 int locs_count() const { return (int)(_locs_end - _locs_start); }
149 relocInfo* locs_limit() const { return _locs_limit; }
150 address locs_point() const { return _locs_point; }
151 csize_t locs_point_off() const{ return (csize_t)(_locs_point - _start); }
152 csize_t locs_capacity() const { return (csize_t)(_locs_limit - _locs_start); }
153 csize_t locs_remaining()const { return (csize_t)(_locs_limit - _locs_end); }
155 int index() const { return _index; }
156 bool is_allocated() const { return _start != NULL; }
157 bool is_empty() const { return _start == _end; }
158 bool is_frozen() const { return _frozen; }
159 bool has_locs() const { return _locs_end != NULL; }
161 CodeBuffer* outer() const { return _outer; }
163 // is a given address in this section? (2nd version is end-inclusive)
164 bool contains(address pc) const { return pc >= _start && pc < _end; }
165 bool contains2(address pc) const { return pc >= _start && pc <= _end; }
166 bool allocates(address pc) const { return pc >= _start && pc < _limit; }
167 bool allocates2(address pc) const { return pc >= _start && pc <= _limit; }
169 void set_end(address pc) { assert(allocates2(pc),""); _end = pc; }
170 void set_mark(address pc) { assert(contains2(pc),"not in codeBuffer");
171 _mark = pc; }
172 void set_mark_off(int offset) { assert(contains2(offset+_start),"not in codeBuffer");
173 _mark = offset + _start; }
174 void set_mark() { _mark = _end; }
175 void clear_mark() { _mark = NULL; }
177 void set_locs_end(relocInfo* p) {
178 assert(p <= locs_limit(), "locs data fits in allocated buffer");
179 _locs_end = p;
180 }
181 void set_locs_point(address pc) {
182 assert(pc >= locs_point(), "relocation addr may not decrease");
183 assert(allocates2(pc), "relocation addr must be in this section");
184 _locs_point = pc;
185 }
187 // Share a scratch buffer for relocinfo. (Hacky; saves a resource allocation.)
188 void initialize_shared_locs(relocInfo* buf, int length);
190 // Manage labels and their addresses.
191 address target(Label& L, address branch_pc);
193 // Emit a relocation.
194 void relocate(address at, RelocationHolder const& rspec, int format = 0);
195 void relocate(address at, relocInfo::relocType rtype, int format = 0) {
196 if (rtype != relocInfo::none)
197 relocate(at, Relocation::spec_simple(rtype), format);
198 }
200 // alignment requirement for starting offset
201 // Requirements are that the instruction area and the
202 // stubs area must start on CodeEntryAlignment, and
203 // the ctable on sizeof(jdouble)
204 int alignment() const { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
206 // Slop between sections, used only when allocating temporary BufferBlob buffers.
207 static csize_t end_slop() { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
209 csize_t align_at_start(csize_t off) const { return (csize_t) align_size_up(off, alignment()); }
211 // Mark a section frozen. Assign its remaining space to
212 // the following section. It will never expand after this point.
213 inline void freeze(); // { _outer->freeze_section(this); }
215 // Ensure there's enough space left in the current section.
216 // Return true if there was an expansion.
217 bool maybe_expand_to_ensure_remaining(csize_t amount);
219 #ifndef PRODUCT
220 void decode();
221 void dump();
222 void print(const char* name);
223 #endif //PRODUCT
224 };
226 class CodeComment;
227 class CodeComments VALUE_OBJ_CLASS_SPEC {
228 private:
229 #ifndef PRODUCT
230 CodeComment* _comments;
231 #endif
233 public:
234 CodeComments() {
235 #ifndef PRODUCT
236 _comments = NULL;
237 #endif
238 }
240 void add_comment(intptr_t offset, const char * comment) PRODUCT_RETURN;
241 void print_block_comment(outputStream* stream, intptr_t offset) PRODUCT_RETURN;
242 void assign(CodeComments& other) PRODUCT_RETURN;
243 void free() PRODUCT_RETURN;
244 };
247 // A CodeBuffer describes a memory space into which assembly
248 // code is generated. This memory space usually occupies the
249 // interior of a single BufferBlob, but in some cases it may be
250 // an arbitrary span of memory, even outside the code cache.
251 //
252 // A code buffer comes in two variants:
253 //
254 // (1) A CodeBuffer referring to an already allocated piece of memory:
255 // This is used to direct 'static' code generation (e.g. for interpreter
256 // or stubroutine generation, etc.). This code comes with NO relocation
257 // information.
258 //
259 // (2) A CodeBuffer referring to a piece of memory allocated when the
260 // CodeBuffer is allocated. This is used for nmethod generation.
261 //
262 // The memory can be divided up into several parts called sections.
263 // Each section independently accumulates code (or data) an relocations.
264 // Sections can grow (at the expense of a reallocation of the BufferBlob
265 // and recopying of all active sections). When the buffered code is finally
266 // written to an nmethod (or other CodeBlob), the contents (code, data,
267 // and relocations) of the sections are padded to an alignment and concatenated.
268 // Instructions and data in one section can contain relocatable references to
269 // addresses in a sibling section.
271 class CodeBuffer: public StackObj {
272 friend class CodeSection;
274 private:
275 // CodeBuffers must be allocated on the stack except for a single
276 // special case during expansion which is handled internally. This
277 // is done to guarantee proper cleanup of resources.
278 void* operator new(size_t size) { return ResourceObj::operator new(size); }
279 void operator delete(void* p) { ResourceObj::operator delete(p); }
281 public:
282 typedef int csize_t; // code size type; would be size_t except for history
283 enum {
284 // Here is the list of all possible sections, in order of ascending address.
285 SECT_INSTS, // Executable instructions.
286 SECT_STUBS, // Outbound trampolines for supporting call sites.
287 SECT_CONSTS, // Non-instruction data: Floats, jump tables, etc.
288 SECT_LIMIT, SECT_NONE = -1
289 };
291 private:
292 enum {
293 sect_bits = 2, // assert (SECT_LIMIT <= (1<<sect_bits))
294 sect_mask = (1<<sect_bits)-1
295 };
297 const char* _name;
299 CodeSection _insts; // instructions (the main section)
300 CodeSection _stubs; // stubs (call site support), deopt, exception handling
301 CodeSection _consts; // constants, jump tables
303 CodeBuffer* _before_expand; // dead buffer, from before the last expansion
305 BufferBlob* _blob; // optional buffer in CodeCache for generated code
306 address _total_start; // first address of combined memory buffer
307 csize_t _total_size; // size in bytes of combined memory buffer
309 OopRecorder* _oop_recorder;
310 CodeComments _comments;
311 OopRecorder _default_oop_recorder; // override with initialize_oop_recorder
312 Arena* _overflow_arena;
314 address _decode_begin; // start address for decode
315 address decode_begin();
317 void initialize_misc(const char * name) {
318 // all pointers other than code_start/end and those inside the sections
319 assert(name != NULL, "must have a name");
320 _name = name;
321 _before_expand = NULL;
322 _blob = NULL;
323 _oop_recorder = NULL;
324 _decode_begin = NULL;
325 _overflow_arena = NULL;
326 }
328 void initialize(address code_start, csize_t code_size) {
329 _insts.initialize_outer(this, SECT_INSTS);
330 _stubs.initialize_outer(this, SECT_STUBS);
331 _consts.initialize_outer(this, SECT_CONSTS);
332 _total_start = code_start;
333 _total_size = code_size;
334 // Initialize the main section:
335 _insts.initialize(code_start, code_size);
336 assert(!_stubs.is_allocated(), "no garbage here");
337 assert(!_consts.is_allocated(), "no garbage here");
338 _oop_recorder = &_default_oop_recorder;
339 }
341 void initialize_section_size(CodeSection* cs, csize_t size);
343 void freeze_section(CodeSection* cs);
345 // helper for CodeBuffer::expand()
346 void take_over_code_from(CodeBuffer* cs);
348 #ifdef ASSERT
349 // ensure sections are disjoint, ordered, and contained in the blob
350 bool verify_section_allocation();
351 #endif
353 // copies combined relocations to the blob, returns bytes copied
354 // (if target is null, it is a dry run only, just for sizing)
355 csize_t copy_relocations_to(CodeBlob* blob) const;
357 // copies combined code to the blob (assumes relocs are already in there)
358 void copy_code_to(CodeBlob* blob);
360 // moves code sections to new buffer (assumes relocs are already in there)
361 void relocate_code_to(CodeBuffer* cb) const;
363 // set up a model of the final layout of my contents
364 void compute_final_layout(CodeBuffer* dest) const;
366 // Expand the given section so at least 'amount' is remaining.
367 // Creates a new, larger BufferBlob, and rewrites the code & relocs.
368 void expand(CodeSection* which_cs, csize_t amount);
370 // Helper for expand.
371 csize_t figure_expanded_capacities(CodeSection* which_cs, csize_t amount, csize_t* new_capacity);
373 public:
374 // (1) code buffer referring to pre-allocated instruction memory
375 CodeBuffer(address code_start, csize_t code_size);
377 // (2) code buffer allocating codeBlob memory for code & relocation
378 // info but with lazy initialization. The name must be something
379 // informative.
380 CodeBuffer(const char* name) {
381 initialize_misc(name);
382 }
385 // (3) code buffer allocating codeBlob memory for code & relocation
386 // info. The name must be something informative and code_size must
387 // include both code and stubs sizes.
388 CodeBuffer(const char* name, csize_t code_size, csize_t locs_size) {
389 initialize_misc(name);
390 initialize(code_size, locs_size);
391 }
393 ~CodeBuffer();
395 // Initialize a CodeBuffer constructed using constructor 2. Using
396 // constructor 3 is equivalent to calling constructor 2 and then
397 // calling this method. It's been factored out for convenience of
398 // construction.
399 void initialize(csize_t code_size, csize_t locs_size);
401 CodeSection* insts() { return &_insts; }
402 CodeSection* stubs() { return &_stubs; }
403 CodeSection* consts() { return &_consts; }
405 // present sections in order; return NULL at end; insts is #0, etc.
406 CodeSection* code_section(int n) {
407 // This makes the slightly questionable but portable assumption that
408 // the various members (_insts, _stubs, etc.) are adjacent in the
409 // layout of CodeBuffer.
410 CodeSection* cs = &_insts + n;
411 assert(cs->index() == n || !cs->is_allocated(), "sanity");
412 return cs;
413 }
414 const CodeSection* code_section(int n) const { // yucky const stuff
415 return ((CodeBuffer*)this)->code_section(n);
416 }
417 static const char* code_section_name(int n);
418 int section_index_of(address addr) const;
419 bool contains(address addr) const {
420 // handy for debugging
421 return section_index_of(addr) > SECT_NONE;
422 }
424 // A stable mapping between 'locators' (small ints) and addresses.
425 static int locator_pos(int locator) { return locator >> sect_bits; }
426 static int locator_sect(int locator) { return locator & sect_mask; }
427 static int locator(int pos, int sect) { return (pos << sect_bits) | sect; }
428 int locator(address addr) const;
429 address locator_address(int locator) const;
431 // Properties
432 const char* name() const { return _name; }
433 CodeBuffer* before_expand() const { return _before_expand; }
434 BufferBlob* blob() const { return _blob; }
435 void set_blob(BufferBlob* blob);
436 void free_blob(); // Free the blob, if we own one.
438 // Properties relative to the insts section:
439 address code_begin() const { return _insts.start(); }
440 address code_end() const { return _insts.end(); }
441 void set_code_end(address end) { _insts.set_end(end); }
442 address code_limit() const { return _insts.limit(); }
443 address inst_mark() const { return _insts.mark(); }
444 void set_inst_mark() { _insts.set_mark(); }
445 void clear_inst_mark() { _insts.clear_mark(); }
447 // is there anything in the buffer other than the current section?
448 bool is_pure() const { return code_size() == total_code_size(); }
450 // size in bytes of output so far in the insts sections
451 csize_t code_size() const { return _insts.size(); }
453 // same as code_size(), except that it asserts there is no non-code here
454 csize_t pure_code_size() const { assert(is_pure(), "no non-code");
455 return code_size(); }
456 // capacity in bytes of the insts sections
457 csize_t code_capacity() const { return _insts.capacity(); }
459 // number of bytes remaining in the insts section
460 csize_t code_remaining() const { return _insts.remaining(); }
462 // is a given address in the insts section? (2nd version is end-inclusive)
463 bool code_contains(address pc) const { return _insts.contains(pc); }
464 bool code_contains2(address pc) const { return _insts.contains2(pc); }
466 // allocated size of code in all sections, when aligned and concatenated
467 // (this is the eventual state of the code in its final CodeBlob)
468 csize_t total_code_size() const;
470 // combined offset (relative to start of insts) of given address,
471 // as eventually found in the final CodeBlob
472 csize_t total_offset_of(address addr) const;
474 // allocated size of all relocation data, including index, rounded up
475 csize_t total_relocation_size() const;
477 // allocated size of any and all recorded oops
478 csize_t total_oop_size() const {
479 OopRecorder* recorder = oop_recorder();
480 return (recorder == NULL)? 0: recorder->oop_size();
481 }
483 // Configuration functions, called immediately after the CB is constructed.
484 // The section sizes are subtracted from the original insts section.
485 // Note: Call them in reverse section order, because each steals from insts.
486 void initialize_consts_size(csize_t size) { initialize_section_size(&_consts, size); }
487 void initialize_stubs_size(csize_t size) { initialize_section_size(&_stubs, size); }
488 // Override default oop recorder.
489 void initialize_oop_recorder(OopRecorder* r);
491 OopRecorder* oop_recorder() const { return _oop_recorder; }
492 CodeComments& comments() { return _comments; }
494 // Code generation
495 void relocate(address at, RelocationHolder const& rspec, int format = 0) {
496 _insts.relocate(at, rspec, format);
497 }
498 void relocate(address at, relocInfo::relocType rtype, int format = 0) {
499 _insts.relocate(at, rtype, format);
500 }
502 // Management of overflow storage for binding of Labels.
503 GrowableArray<int>* create_patch_overflow();
505 // NMethod generation
506 void copy_code_and_locs_to(CodeBlob* blob) {
507 assert(blob != NULL, "sane");
508 copy_relocations_to(blob);
509 copy_code_to(blob);
510 }
511 void copy_oops_to(CodeBlob* blob) {
512 if (!oop_recorder()->is_unused()) {
513 oop_recorder()->copy_to(blob);
514 }
515 }
517 // Transform an address from the code in this code buffer to a specified code buffer
518 address transform_address(const CodeBuffer &cb, address addr) const;
520 void block_comment(intptr_t offset, const char * comment) PRODUCT_RETURN;
522 #ifndef PRODUCT
523 public:
524 // Printing / Decoding
525 // decodes from decode_begin() to code_end() and sets decode_begin to end
526 void decode();
527 void decode_all(); // decodes all the code
528 void skip_decode(); // sets decode_begin to code_end();
529 void print();
530 #endif
533 // The following header contains architecture-specific implementations
534 #include "incls/_codeBuffer_pd.hpp.incl"
535 };
538 inline void CodeSection::freeze() {
539 _outer->freeze_section(this);
540 }
542 inline bool CodeSection::maybe_expand_to_ensure_remaining(csize_t amount) {
543 if (remaining() < amount) { _outer->expand(this, amount); return true; }
544 return false;
545 }