Wed, 25 Aug 2010 05:27:54 -0700
6978355: renaming for 6961697
Summary: This is the renaming part of 6961697 to keep the actual changes small for review.
Reviewed-by: kvn, never
1 /*
2 * Copyright (c) 1997, 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 */
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 UnwindHandler, // Offset to default unwind handler
44 max_Entries };
46 // special value to note codeBlobs where profile (forte) stack walking is
47 // always dangerous and suspect.
49 enum { frame_never_safe = -1 };
51 private:
52 int _values[max_Entries];
54 public:
55 CodeOffsets() {
56 _values[Entry ] = 0;
57 _values[Verified_Entry] = 0;
58 _values[Frame_Complete] = frame_never_safe;
59 _values[OSR_Entry ] = 0;
60 _values[Exceptions ] = -1;
61 _values[Deopt ] = -1;
62 _values[DeoptMH ] = -1;
63 _values[UnwindHandler ] = -1;
64 }
66 int value(Entries e) { return _values[e]; }
67 void set_value(Entries e, int val) { _values[e] = val; }
68 };
70 // This class represents a stream of code and associated relocations.
71 // There are a few in each CodeBuffer.
72 // They are filled concurrently, and concatenated at the end.
73 class CodeSection VALUE_OBJ_CLASS_SPEC {
74 friend class CodeBuffer;
75 public:
76 typedef int csize_t; // code size type; would be size_t except for history
78 private:
79 address _start; // first byte of contents (instructions)
80 address _mark; // user mark, usually an instruction beginning
81 address _end; // current end address
82 address _limit; // last possible (allocated) end address
83 relocInfo* _locs_start; // first byte of relocation information
84 relocInfo* _locs_end; // first byte after relocation information
85 relocInfo* _locs_limit; // first byte after relocation information buf
86 address _locs_point; // last relocated position (grows upward)
87 bool _locs_own; // did I allocate the locs myself?
88 bool _frozen; // no more expansion of this section
89 char _index; // my section number (SECT_INST, etc.)
90 CodeBuffer* _outer; // enclosing CodeBuffer
92 // (Note: _locs_point used to be called _last_reloc_offset.)
94 CodeSection() {
95 _start = NULL;
96 _mark = NULL;
97 _end = NULL;
98 _limit = NULL;
99 _locs_start = NULL;
100 _locs_end = NULL;
101 _locs_limit = NULL;
102 _locs_point = NULL;
103 _locs_own = false;
104 _frozen = false;
105 debug_only(_index = (char)-1);
106 debug_only(_outer = (CodeBuffer*)badAddress);
107 }
109 void initialize_outer(CodeBuffer* outer, int index) {
110 _outer = outer;
111 _index = index;
112 }
114 void initialize(address start, csize_t size = 0) {
115 assert(_start == NULL, "only one init step, please");
116 _start = start;
117 _mark = NULL;
118 _end = start;
120 _limit = start + size;
121 _locs_point = start;
122 }
124 void initialize_locs(int locs_capacity);
125 void expand_locs(int new_capacity);
126 void initialize_locs_from(const CodeSection* source_cs);
128 // helper for CodeBuffer::expand()
129 void take_over_code_from(CodeSection* cs) {
130 _start = cs->_start;
131 _mark = cs->_mark;
132 _end = cs->_end;
133 _limit = cs->_limit;
134 _locs_point = cs->_locs_point;
135 }
137 public:
138 address start() const { return _start; }
139 address mark() const { return _mark; }
140 address end() const { return _end; }
141 address limit() const { return _limit; }
142 csize_t size() const { return (csize_t)(_end - _start); }
143 csize_t mark_off() const { assert(_mark != NULL, "not an offset");
144 return (csize_t)(_mark - _start); }
145 csize_t capacity() const { return (csize_t)(_limit - _start); }
146 csize_t remaining() const { return (csize_t)(_limit - _end); }
148 relocInfo* locs_start() const { return _locs_start; }
149 relocInfo* locs_end() const { return _locs_end; }
150 int locs_count() const { return (int)(_locs_end - _locs_start); }
151 relocInfo* locs_limit() const { return _locs_limit; }
152 address locs_point() const { return _locs_point; }
153 csize_t locs_point_off() const{ return (csize_t)(_locs_point - _start); }
154 csize_t locs_capacity() const { return (csize_t)(_locs_limit - _locs_start); }
155 csize_t locs_remaining()const { return (csize_t)(_locs_limit - _locs_end); }
157 int index() const { return _index; }
158 bool is_allocated() const { return _start != NULL; }
159 bool is_empty() const { return _start == _end; }
160 bool is_frozen() const { return _frozen; }
161 bool has_locs() const { return _locs_end != NULL; }
163 CodeBuffer* outer() const { return _outer; }
165 // is a given address in this section? (2nd version is end-inclusive)
166 bool contains(address pc) const { return pc >= _start && pc < _end; }
167 bool contains2(address pc) const { return pc >= _start && pc <= _end; }
168 bool allocates(address pc) const { return pc >= _start && pc < _limit; }
169 bool allocates2(address pc) const { return pc >= _start && pc <= _limit; }
171 void set_end(address pc) { assert(allocates2(pc),""); _end = pc; }
172 void set_mark(address pc) { assert(contains2(pc),"not in codeBuffer");
173 _mark = pc; }
174 void set_mark_off(int offset) { assert(contains2(offset+_start),"not in codeBuffer");
175 _mark = offset + _start; }
176 void set_mark() { _mark = _end; }
177 void clear_mark() { _mark = NULL; }
179 void set_locs_end(relocInfo* p) {
180 assert(p <= locs_limit(), "locs data fits in allocated buffer");
181 _locs_end = p;
182 }
183 void set_locs_point(address pc) {
184 assert(pc >= locs_point(), "relocation addr may not decrease");
185 assert(allocates2(pc), "relocation addr must be in this section");
186 _locs_point = pc;
187 }
189 // Code emission
190 void emit_int8 (int8_t x) { *((int8_t*) end()) = x; set_end(end() + 1); }
191 void emit_int16(int16_t x) { *((int16_t*) end()) = x; set_end(end() + 2); }
192 void emit_int32(int32_t x) { *((int32_t*) end()) = x; set_end(end() + 4); }
193 void emit_int64(int64_t x) { *((int64_t*) end()) = x; set_end(end() + 8); }
195 // Share a scratch buffer for relocinfo. (Hacky; saves a resource allocation.)
196 void initialize_shared_locs(relocInfo* buf, int length);
198 // Manage labels and their addresses.
199 address target(Label& L, address branch_pc);
201 // Emit a relocation.
202 void relocate(address at, RelocationHolder const& rspec, int format = 0);
203 void relocate(address at, relocInfo::relocType rtype, int format = 0) {
204 if (rtype != relocInfo::none)
205 relocate(at, Relocation::spec_simple(rtype), format);
206 }
208 // alignment requirement for starting offset
209 // Requirements are that the instruction area and the
210 // stubs area must start on CodeEntryAlignment, and
211 // the ctable on sizeof(jdouble)
212 int alignment() const { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
214 // Slop between sections, used only when allocating temporary BufferBlob buffers.
215 static csize_t end_slop() { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
217 csize_t align_at_start(csize_t off) const { return (csize_t) align_size_up(off, alignment()); }
219 // Mark a section frozen. Assign its remaining space to
220 // the following section. It will never expand after this point.
221 inline void freeze(); // { _outer->freeze_section(this); }
223 // Ensure there's enough space left in the current section.
224 // Return true if there was an expansion.
225 bool maybe_expand_to_ensure_remaining(csize_t amount);
227 #ifndef PRODUCT
228 void decode();
229 void dump();
230 void print(const char* name);
231 #endif //PRODUCT
232 };
234 class CodeComment;
235 class CodeComments VALUE_OBJ_CLASS_SPEC {
236 private:
237 #ifndef PRODUCT
238 CodeComment* _comments;
239 #endif
241 public:
242 CodeComments() {
243 #ifndef PRODUCT
244 _comments = NULL;
245 #endif
246 }
248 void add_comment(intptr_t offset, const char * comment) PRODUCT_RETURN;
249 void print_block_comment(outputStream* stream, intptr_t offset) PRODUCT_RETURN;
250 void assign(CodeComments& other) PRODUCT_RETURN;
251 void free() PRODUCT_RETURN;
252 };
255 // A CodeBuffer describes a memory space into which assembly
256 // code is generated. This memory space usually occupies the
257 // interior of a single BufferBlob, but in some cases it may be
258 // an arbitrary span of memory, even outside the code cache.
259 //
260 // A code buffer comes in two variants:
261 //
262 // (1) A CodeBuffer referring to an already allocated piece of memory:
263 // This is used to direct 'static' code generation (e.g. for interpreter
264 // or stubroutine generation, etc.). This code comes with NO relocation
265 // information.
266 //
267 // (2) A CodeBuffer referring to a piece of memory allocated when the
268 // CodeBuffer is allocated. This is used for nmethod generation.
269 //
270 // The memory can be divided up into several parts called sections.
271 // Each section independently accumulates code (or data) an relocations.
272 // Sections can grow (at the expense of a reallocation of the BufferBlob
273 // and recopying of all active sections). When the buffered code is finally
274 // written to an nmethod (or other CodeBlob), the contents (code, data,
275 // and relocations) of the sections are padded to an alignment and concatenated.
276 // Instructions and data in one section can contain relocatable references to
277 // addresses in a sibling section.
279 class CodeBuffer: public StackObj {
280 friend class CodeSection;
282 private:
283 // CodeBuffers must be allocated on the stack except for a single
284 // special case during expansion which is handled internally. This
285 // is done to guarantee proper cleanup of resources.
286 void* operator new(size_t size) { return ResourceObj::operator new(size); }
287 void operator delete(void* p) { ShouldNotCallThis(); }
289 public:
290 typedef int csize_t; // code size type; would be size_t except for history
291 enum {
292 // Here is the list of all possible sections, in order of ascending address.
293 SECT_INSTS, // Executable instructions.
294 SECT_STUBS, // Outbound trampolines for supporting call sites.
295 SECT_CONSTS, // Non-instruction data: Floats, jump tables, etc.
296 SECT_LIMIT, SECT_NONE = -1
297 };
299 private:
300 enum {
301 sect_bits = 2, // assert (SECT_LIMIT <= (1<<sect_bits))
302 sect_mask = (1<<sect_bits)-1
303 };
305 const char* _name;
307 CodeSection _insts; // instructions (the main section)
308 CodeSection _stubs; // stubs (call site support), deopt, exception handling
309 CodeSection _consts; // constants, jump tables
311 CodeBuffer* _before_expand; // dead buffer, from before the last expansion
313 BufferBlob* _blob; // optional buffer in CodeCache for generated code
314 address _total_start; // first address of combined memory buffer
315 csize_t _total_size; // size in bytes of combined memory buffer
317 OopRecorder* _oop_recorder;
318 CodeComments _comments;
319 OopRecorder _default_oop_recorder; // override with initialize_oop_recorder
320 Arena* _overflow_arena;
322 address _decode_begin; // start address for decode
323 address decode_begin();
325 void initialize_misc(const char * name) {
326 // all pointers other than code_start/end and those inside the sections
327 assert(name != NULL, "must have a name");
328 _name = name;
329 _before_expand = NULL;
330 _blob = NULL;
331 _oop_recorder = NULL;
332 _decode_begin = NULL;
333 _overflow_arena = NULL;
334 }
336 void initialize(address code_start, csize_t code_size) {
337 _insts.initialize_outer(this, SECT_INSTS);
338 _stubs.initialize_outer(this, SECT_STUBS);
339 _consts.initialize_outer(this, SECT_CONSTS);
340 _total_start = code_start;
341 _total_size = code_size;
342 // Initialize the main section:
343 _insts.initialize(code_start, code_size);
344 assert(!_stubs.is_allocated(), "no garbage here");
345 assert(!_consts.is_allocated(), "no garbage here");
346 _oop_recorder = &_default_oop_recorder;
347 }
349 void initialize_section_size(CodeSection* cs, csize_t size);
351 void freeze_section(CodeSection* cs);
353 // helper for CodeBuffer::expand()
354 void take_over_code_from(CodeBuffer* cs);
356 #ifdef ASSERT
357 // ensure sections are disjoint, ordered, and contained in the blob
358 bool verify_section_allocation();
359 #endif
361 // copies combined relocations to the blob, returns bytes copied
362 // (if target is null, it is a dry run only, just for sizing)
363 csize_t copy_relocations_to(CodeBlob* blob) const;
365 // copies combined code to the blob (assumes relocs are already in there)
366 void copy_code_to(CodeBlob* blob);
368 // moves code sections to new buffer (assumes relocs are already in there)
369 void relocate_code_to(CodeBuffer* cb) const;
371 // set up a model of the final layout of my contents
372 void compute_final_layout(CodeBuffer* dest) const;
374 // Expand the given section so at least 'amount' is remaining.
375 // Creates a new, larger BufferBlob, and rewrites the code & relocs.
376 void expand(CodeSection* which_cs, csize_t amount);
378 // Helper for expand.
379 csize_t figure_expanded_capacities(CodeSection* which_cs, csize_t amount, csize_t* new_capacity);
381 public:
382 // (1) code buffer referring to pre-allocated instruction memory
383 CodeBuffer(address code_start, csize_t code_size) {
384 assert(code_start != NULL, "sanity");
385 initialize_misc("static buffer");
386 initialize(code_start, code_size);
387 assert(verify_section_allocation(), "initial use of buffer OK");
388 }
390 // (2) CodeBuffer referring to pre-allocated CodeBlob.
391 CodeBuffer(CodeBlob* blob);
393 // (3) code buffer allocating codeBlob memory for code & relocation
394 // info but with lazy initialization. The name must be something
395 // informative.
396 CodeBuffer(const char* name) {
397 initialize_misc(name);
398 }
401 // (4) code buffer allocating codeBlob memory for code & relocation
402 // info. The name must be something informative and code_size must
403 // include both code and stubs sizes.
404 CodeBuffer(const char* name, csize_t code_size, csize_t locs_size) {
405 initialize_misc(name);
406 initialize(code_size, locs_size);
407 }
409 ~CodeBuffer();
411 // Initialize a CodeBuffer constructed using constructor 3. Using
412 // constructor 4 is equivalent to calling constructor 3 and then
413 // calling this method. It's been factored out for convenience of
414 // construction.
415 void initialize(csize_t code_size, csize_t locs_size);
417 CodeSection* insts() { return &_insts; }
418 CodeSection* stubs() { return &_stubs; }
419 CodeSection* consts() { return &_consts; }
421 // present sections in order; return NULL at end; insts is #0, etc.
422 CodeSection* code_section(int n) {
423 // This makes the slightly questionable but portable assumption that
424 // the various members (_insts, _stubs, etc.) are adjacent in the
425 // layout of CodeBuffer.
426 CodeSection* cs = &_insts + n;
427 assert(cs->index() == n || !cs->is_allocated(), "sanity");
428 return cs;
429 }
430 const CodeSection* code_section(int n) const { // yucky const stuff
431 return ((CodeBuffer*)this)->code_section(n);
432 }
433 static const char* code_section_name(int n);
434 int section_index_of(address addr) const;
435 bool contains(address addr) const {
436 // handy for debugging
437 return section_index_of(addr) > SECT_NONE;
438 }
440 // A stable mapping between 'locators' (small ints) and addresses.
441 static int locator_pos(int locator) { return locator >> sect_bits; }
442 static int locator_sect(int locator) { return locator & sect_mask; }
443 static int locator(int pos, int sect) { return (pos << sect_bits) | sect; }
444 int locator(address addr) const;
445 address locator_address(int locator) const;
447 // Properties
448 const char* name() const { return _name; }
449 CodeBuffer* before_expand() const { return _before_expand; }
450 BufferBlob* blob() const { return _blob; }
451 void set_blob(BufferBlob* blob);
452 void free_blob(); // Free the blob, if we own one.
454 // Properties relative to the insts section:
455 address insts_begin() const { return _insts.start(); }
456 address insts_end() const { return _insts.end(); }
457 void set_insts_end(address end) { _insts.set_end(end); }
458 address insts_limit() const { return _insts.limit(); }
459 address insts_mark() const { return _insts.mark(); }
460 void set_insts_mark() { _insts.set_mark(); }
461 void clear_insts_mark() { _insts.clear_mark(); }
463 // is there anything in the buffer other than the current section?
464 bool is_pure() const { return insts_size() == total_content_size(); }
466 // size in bytes of output so far in the insts sections
467 csize_t insts_size() const { return _insts.size(); }
469 // same as insts_size(), except that it asserts there is no non-code here
470 csize_t pure_insts_size() const { assert(is_pure(), "no non-code");
471 return insts_size(); }
472 // capacity in bytes of the insts sections
473 csize_t insts_capacity() const { return _insts.capacity(); }
475 // number of bytes remaining in the insts section
476 csize_t insts_remaining() const { return _insts.remaining(); }
478 // is a given address in the insts section? (2nd version is end-inclusive)
479 bool insts_contains(address pc) const { return _insts.contains(pc); }
480 bool insts_contains2(address pc) const { return _insts.contains2(pc); }
482 // Allocated size in all sections, when aligned and concatenated
483 // (this is the eventual state of the content in its final
484 // CodeBlob).
485 csize_t total_content_size() const;
487 // combined offset (relative to start of insts) of given address,
488 // as eventually found in the final CodeBlob
489 csize_t total_offset_of(address addr) const;
491 // allocated size of all relocation data, including index, rounded up
492 csize_t total_relocation_size() const;
494 // allocated size of any and all recorded oops
495 csize_t total_oop_size() const {
496 OopRecorder* recorder = oop_recorder();
497 return (recorder == NULL)? 0: recorder->oop_size();
498 }
500 // Configuration functions, called immediately after the CB is constructed.
501 // The section sizes are subtracted from the original insts section.
502 // Note: Call them in reverse section order, because each steals from insts.
503 void initialize_consts_size(csize_t size) { initialize_section_size(&_consts, size); }
504 void initialize_stubs_size(csize_t size) { initialize_section_size(&_stubs, size); }
505 // Override default oop recorder.
506 void initialize_oop_recorder(OopRecorder* r);
508 OopRecorder* oop_recorder() const { return _oop_recorder; }
509 CodeComments& comments() { return _comments; }
511 // Code generation
512 void relocate(address at, RelocationHolder const& rspec, int format = 0) {
513 _insts.relocate(at, rspec, format);
514 }
515 void relocate(address at, relocInfo::relocType rtype, int format = 0) {
516 _insts.relocate(at, rtype, format);
517 }
519 // Management of overflow storage for binding of Labels.
520 GrowableArray<int>* create_patch_overflow();
522 // NMethod generation
523 void copy_code_and_locs_to(CodeBlob* blob) {
524 assert(blob != NULL, "sane");
525 copy_relocations_to(blob);
526 copy_code_to(blob);
527 }
528 void copy_oops_to(nmethod* nm) {
529 if (!oop_recorder()->is_unused()) {
530 oop_recorder()->copy_to(nm);
531 }
532 }
534 // Transform an address from the code in this code buffer to a specified code buffer
535 address transform_address(const CodeBuffer &cb, address addr) const;
537 void block_comment(intptr_t offset, const char * comment) PRODUCT_RETURN;
539 #ifndef PRODUCT
540 public:
541 // Printing / Decoding
542 // decodes from decode_begin() to code_end() and sets decode_begin to end
543 void decode();
544 void decode_all(); // decodes all the code
545 void skip_decode(); // sets decode_begin to code_end();
546 void print();
547 #endif
550 // The following header contains architecture-specific implementations
551 #include "incls/_codeBuffer_pd.hpp.incl"
552 };
555 inline void CodeSection::freeze() {
556 _outer->freeze_section(this);
557 }
559 inline bool CodeSection::maybe_expand_to_ensure_remaining(csize_t amount) {
560 if (remaining() < amount) { _outer->expand(this, amount); return true; }
561 return false;
562 }