1 /*
2  * Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 #ifndef SHARE_ASM_CODEBUFFER_HPP
26 #define SHARE_ASM_CODEBUFFER_HPP
27 
28 #include "code/oopRecorder.hpp"
29 #include "code/relocInfo.hpp"
30 #include "utilities/align.hpp"
31 #include "utilities/debug.hpp"
32 #include "utilities/macros.hpp"
33 
34 class CodeStrings;
35 class PhaseCFG;
36 class Compile;
37 class BufferBlob;
38 class CodeBuffer;
39 class Label;
40 
41 class CodeOffsets: public StackObj {
42 public:
43   enum Entries { Entry,
44                  Verified_Entry,
45                  Frame_Complete, // Offset in the code where the frame setup is (for forte stackwalks) is complete
46                  OSR_Entry,
47                  Exceptions,     // Offset where exception handler lives
48                  Deopt,          // Offset where deopt handler lives
49                  DeoptMH,        // Offset where MethodHandle deopt handler lives
50                  UnwindHandler,  // Offset to default unwind handler
51                  max_Entries };
52 
53   // special value to note codeBlobs where profile (forte) stack walking is
54   // always dangerous and suspect.
55 
56   enum { frame_never_safe = -1 };
57 
58 private:
59   int _values[max_Entries];
60 
61 public:
CodeOffsets()62   CodeOffsets() {
63     _values[Entry         ] = 0;
64     _values[Verified_Entry] = 0;
65     _values[Frame_Complete] = frame_never_safe;
66     _values[OSR_Entry     ] = 0;
67     _values[Exceptions    ] = -1;
68     _values[Deopt         ] = -1;
69     _values[DeoptMH       ] = -1;
70     _values[UnwindHandler ] = -1;
71   }
72 
value(Entries e)73   int value(Entries e) { return _values[e]; }
set_value(Entries e,int val)74   void set_value(Entries e, int val) { _values[e] = val; }
75 };
76 
77 // This class represents a stream of code and associated relocations.
78 // There are a few in each CodeBuffer.
79 // They are filled concurrently, and concatenated at the end.
80 class CodeSection {
81   friend class CodeBuffer;
82  public:
83   typedef int csize_t;  // code size type; would be size_t except for history
84 
85  private:
86   address     _start;           // first byte of contents (instructions)
87   address     _mark;            // user mark, usually an instruction beginning
88   address     _end;             // current end address
89   address     _limit;           // last possible (allocated) end address
90   relocInfo*  _locs_start;      // first byte of relocation information
91   relocInfo*  _locs_end;        // first byte after relocation information
92   relocInfo*  _locs_limit;      // first byte after relocation information buf
93   address     _locs_point;      // last relocated position (grows upward)
94   bool        _locs_own;        // did I allocate the locs myself?
95   bool        _scratch_emit;    // Buffer is used for scratch emit, don't relocate.
96   char        _index;           // my section number (SECT_INST, etc.)
97   CodeBuffer* _outer;           // enclosing CodeBuffer
98 
99   // (Note:  _locs_point used to be called _last_reloc_offset.)
100 
CodeSection()101   CodeSection() {
102     _start         = NULL;
103     _mark          = NULL;
104     _end           = NULL;
105     _limit         = NULL;
106     _locs_start    = NULL;
107     _locs_end      = NULL;
108     _locs_limit    = NULL;
109     _locs_point    = NULL;
110     _locs_own      = false;
111     _scratch_emit  = false;
112     debug_only(_index = (char)-1);
113     debug_only(_outer = (CodeBuffer*)badAddress);
114   }
115 
initialize_outer(CodeBuffer * outer,int index)116   void initialize_outer(CodeBuffer* outer, int index) {
117     _outer = outer;
118     _index = index;
119   }
120 
initialize(address start,csize_t size=0)121   void initialize(address start, csize_t size = 0) {
122     assert(_start == NULL, "only one init step, please");
123     _start         = start;
124     _mark          = NULL;
125     _end           = start;
126 
127     _limit         = start + size;
128     _locs_point    = start;
129   }
130 
131   void initialize_locs(int locs_capacity);
132   void expand_locs(int new_capacity);
133   void initialize_locs_from(const CodeSection* source_cs);
134 
135   // helper for CodeBuffer::expand()
take_over_code_from(CodeSection * cs)136   void take_over_code_from(CodeSection* cs) {
137     _start      = cs->_start;
138     _mark       = cs->_mark;
139     _end        = cs->_end;
140     _limit      = cs->_limit;
141     _locs_point = cs->_locs_point;
142   }
143 
144  public:
start() const145   address     start() const         { return _start; }
mark() const146   address     mark() const          { return _mark; }
end() const147   address     end() const           { return _end; }
limit() const148   address     limit() const         { return _limit; }
size() const149   csize_t     size() const          { return (csize_t)(_end - _start); }
mark_off() const150   csize_t     mark_off() const      { assert(_mark != NULL, "not an offset");
151                                       return (csize_t)(_mark - _start); }
capacity() const152   csize_t     capacity() const      { return (csize_t)(_limit - _start); }
remaining() const153   csize_t     remaining() const     { return (csize_t)(_limit - _end); }
154 
locs_start() const155   relocInfo*  locs_start() const    { return _locs_start; }
locs_end() const156   relocInfo*  locs_end() const      { return _locs_end; }
locs_count() const157   int         locs_count() const    { return (int)(_locs_end - _locs_start); }
locs_limit() const158   relocInfo*  locs_limit() const    { return _locs_limit; }
locs_point() const159   address     locs_point() const    { return _locs_point; }
locs_point_off() const160   csize_t     locs_point_off() const{ return (csize_t)(_locs_point - _start); }
locs_capacity() const161   csize_t     locs_capacity() const { return (csize_t)(_locs_limit - _locs_start); }
162 
index() const163   int         index() const         { return _index; }
is_allocated() const164   bool        is_allocated() const  { return _start != NULL; }
is_empty() const165   bool        is_empty() const      { return _start == _end; }
has_locs() const166   bool        has_locs() const      { return _locs_end != NULL; }
167 
168   // Mark scratch buffer.
set_scratch_emit()169   void        set_scratch_emit()    { _scratch_emit = true; }
scratch_emit()170   bool        scratch_emit()        { return _scratch_emit; }
171 
outer() const172   CodeBuffer* outer() const         { return _outer; }
173 
174   // is a given address in this section?  (2nd version is end-inclusive)
contains(address pc) const175   bool contains(address pc) const   { return pc >= _start && pc <  _end; }
contains2(address pc) const176   bool contains2(address pc) const  { return pc >= _start && pc <= _end; }
allocates(address pc) const177   bool allocates(address pc) const  { return pc >= _start && pc <  _limit; }
allocates2(address pc) const178   bool allocates2(address pc) const { return pc >= _start && pc <= _limit; }
179 
180   // checks if two CodeSections are disjoint
181   //
182   // limit is an exclusive address and can be the start of another
183   // section.
disjoint(CodeSection * cs) const184   bool disjoint(CodeSection* cs) const { return cs->_limit <= _start || cs->_start >= _limit; }
185 
set_end(address pc)186   void    set_end(address pc)       { assert(allocates2(pc), "not in CodeBuffer memory: " INTPTR_FORMAT " <= " INTPTR_FORMAT " <= " INTPTR_FORMAT, p2i(_start), p2i(pc), p2i(_limit)); _end = pc; }
set_mark(address pc)187   void    set_mark(address pc)      { assert(contains2(pc), "not in codeBuffer");
188                                       _mark = pc; }
set_mark()189   void    set_mark()                { _mark = _end; }
clear_mark()190   void    clear_mark()              { _mark = NULL; }
191 
set_locs_end(relocInfo * p)192   void    set_locs_end(relocInfo* p) {
193     assert(p <= locs_limit(), "locs data fits in allocated buffer");
194     _locs_end = p;
195   }
set_locs_point(address pc)196   void    set_locs_point(address pc) {
197     assert(pc >= locs_point(), "relocation addr may not decrease");
198     assert(allocates2(pc),     "relocation addr must be in this section");
199     _locs_point = pc;
200   }
201 
202   // Code emission
emit_int8(int8_t x1)203   void emit_int8(int8_t x1) {
204     address curr = end();
205     *((int8_t*)  curr++) = x1;
206     set_end(curr);
207   }
208 
emit_int16(int16_t x)209   void emit_int16(int16_t x) { *((int16_t*) end()) = x; set_end(end() + sizeof(int16_t)); }
emit_int16(int8_t x1,int8_t x2)210   void emit_int16(int8_t x1, int8_t x2) {
211     address curr = end();
212     *((int8_t*)  curr++) = x1;
213     *((int8_t*)  curr++) = x2;
214     set_end(curr);
215   }
216 
emit_int24(int8_t x1,int8_t x2,int8_t x3)217   void emit_int24(int8_t x1, int8_t x2, int8_t x3)  {
218     address curr = end();
219     *((int8_t*)  curr++) = x1;
220     *((int8_t*)  curr++) = x2;
221     *((int8_t*)  curr++) = x3;
222     set_end(curr);
223   }
224 
emit_int32(int32_t x)225   void emit_int32(int32_t x) { *((int32_t*) end()) = x; set_end(end() + sizeof(int32_t)); }
emit_int32(int8_t x1,int8_t x2,int8_t x3,int8_t x4)226   void emit_int32(int8_t x1, int8_t x2, int8_t x3, int8_t x4)  {
227     address curr = end();
228     *((int8_t*)  curr++) = x1;
229     *((int8_t*)  curr++) = x2;
230     *((int8_t*)  curr++) = x3;
231     *((int8_t*)  curr++) = x4;
232     set_end(curr);
233   }
234 
emit_int64(int64_t x)235   void emit_int64( int64_t x)  { *((int64_t*) end()) = x; set_end(end() + sizeof(int64_t)); }
236 
emit_float(jfloat x)237   void emit_float( jfloat  x)  { *((jfloat*)  end()) = x; set_end(end() + sizeof(jfloat)); }
emit_double(jdouble x)238   void emit_double(jdouble x)  { *((jdouble*) end()) = x; set_end(end() + sizeof(jdouble)); }
emit_address(address x)239   void emit_address(address x) { *((address*) end()) = x; set_end(end() + sizeof(address)); }
240 
241   // Share a scratch buffer for relocinfo.  (Hacky; saves a resource allocation.)
242   void initialize_shared_locs(relocInfo* buf, int length);
243 
244   // Manage labels and their addresses.
245   address target(Label& L, address branch_pc);
246 
247   // Emit a relocation.
248   void relocate(address at, RelocationHolder const& rspec, int format = 0);
249   void relocate(address at,    relocInfo::relocType rtype, int format = 0, jint method_index = 0);
250 
251   // alignment requirement for starting offset
252   // Requirements are that the instruction area and the
253   // stubs area must start on CodeEntryAlignment, and
254   // the ctable on sizeof(jdouble)
alignment() const255   int alignment() const             { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
256 
257   // Slop between sections, used only when allocating temporary BufferBlob buffers.
end_slop()258   static csize_t end_slop()         { return MAX2((int)sizeof(jdouble), (int)CodeEntryAlignment); }
259 
align_at_start(csize_t off) const260   csize_t align_at_start(csize_t off) const { return (csize_t) align_up(off, alignment()); }
261 
262   // Ensure there's enough space left in the current section.
263   // Return true if there was an expansion.
264   bool maybe_expand_to_ensure_remaining(csize_t amount);
265 
266 #ifndef PRODUCT
267   void decode();
268   void print(const char* name);
269 #endif //PRODUCT
270 };
271 
272 class CodeString;
273 class CodeStrings {
274 private:
275 #ifndef PRODUCT
276   CodeString* _strings;
277   CodeString* _strings_last;
278 #ifdef ASSERT
279   // Becomes true after copy-out, forbids further use.
280   bool _defunct; // Zero bit pattern is "valid", see memset call in decode_env::decode_env
281 #endif
282   static const char* _prefix; // defaults to " ;; "
283 
284   CodeString* find(intptr_t offset) const;
285   CodeString* find_last(intptr_t offset) const;
286 
set_null_and_invalidate()287   void set_null_and_invalidate() {
288     _strings = NULL;
289     _strings_last = NULL;
290 #ifdef ASSERT
291     _defunct = true;
292 #endif
293   }
294 #endif
295 
296 public:
CodeStrings()297   CodeStrings() {
298 #ifndef PRODUCT
299     _strings = NULL;
300     _strings_last = NULL;
301 #ifdef ASSERT
302     _defunct = false;
303 #endif
304 #endif
305   }
306 
307 #ifndef PRODUCT
is_null()308   bool is_null() {
309 #ifdef ASSERT
310     return _strings == NULL;
311 #else
312     return true;
313 #endif
314   }
315 
316   const char* add_string(const char * string);
317 
318   void add_comment(intptr_t offset, const char * comment);
319   void print_block_comment(outputStream* stream, intptr_t offset) const;
320   int  count() const;
321   // COPY strings from other to this; leave other valid.
322   void copy(CodeStrings& other);
323   // FREE strings; invalidate this.
324   void free();
325 
326   // Guarantee that _strings are used at most once; assign and free invalidate a buffer.
check_valid() const327   inline void check_valid() const {
328     assert(!_defunct, "Use of invalid CodeStrings");
329   }
330 
set_prefix(const char * prefix)331   static void set_prefix(const char *prefix) {
332     _prefix = prefix;
333   }
334 #endif // !PRODUCT
335 };
336 
337 // A CodeBuffer describes a memory space into which assembly
338 // code is generated.  This memory space usually occupies the
339 // interior of a single BufferBlob, but in some cases it may be
340 // an arbitrary span of memory, even outside the code cache.
341 //
342 // A code buffer comes in two variants:
343 //
344 // (1) A CodeBuffer referring to an already allocated piece of memory:
345 //     This is used to direct 'static' code generation (e.g. for interpreter
346 //     or stubroutine generation, etc.).  This code comes with NO relocation
347 //     information.
348 //
349 // (2) A CodeBuffer referring to a piece of memory allocated when the
350 //     CodeBuffer is allocated.  This is used for nmethod generation.
351 //
352 // The memory can be divided up into several parts called sections.
353 // Each section independently accumulates code (or data) an relocations.
354 // Sections can grow (at the expense of a reallocation of the BufferBlob
355 // and recopying of all active sections).  When the buffered code is finally
356 // written to an nmethod (or other CodeBlob), the contents (code, data,
357 // and relocations) of the sections are padded to an alignment and concatenated.
358 // Instructions and data in one section can contain relocatable references to
359 // addresses in a sibling section.
360 
361 class CodeBuffer: public StackObj {
362   friend class CodeSection;
363   friend class StubCodeGenerator;
364 
365  private:
366   // CodeBuffers must be allocated on the stack except for a single
367   // special case during expansion which is handled internally.  This
368   // is done to guarantee proper cleanup of resources.
operator new(size_t size)369   void* operator new(size_t size) throw() { return ResourceObj::operator new(size); }
operator delete(void * p)370   void  operator delete(void* p)          { ShouldNotCallThis(); }
371 
372  public:
373   typedef int csize_t;  // code size type; would be size_t except for history
374   enum {
375     // Here is the list of all possible sections.  The order reflects
376     // the final layout.
377     SECT_FIRST = 0,
378     SECT_CONSTS = SECT_FIRST, // Non-instruction data:  Floats, jump tables, etc.
379     SECT_INSTS,               // Executable instructions.
380     SECT_STUBS,               // Outbound trampolines for supporting call sites.
381     SECT_LIMIT, SECT_NONE = -1
382   };
383 
384  private:
385   enum {
386     sect_bits = 2,      // assert (SECT_LIMIT <= (1<<sect_bits))
387     sect_mask = (1<<sect_bits)-1
388   };
389 
390   const char*  _name;
391 
392   CodeSection  _consts;             // constants, jump tables
393   CodeSection  _insts;              // instructions (the main section)
394   CodeSection  _stubs;              // stubs (call site support), deopt, exception handling
395 
396   CodeBuffer*  _before_expand;  // dead buffer, from before the last expansion
397 
398   BufferBlob*  _blob;           // optional buffer in CodeCache for generated code
399   address      _total_start;    // first address of combined memory buffer
400   csize_t      _total_size;     // size in bytes of combined memory buffer
401 
402   OopRecorder* _oop_recorder;
403 
404   OopRecorder  _default_oop_recorder;  // override with initialize_oop_recorder
405   Arena*       _overflow_arena;
406 
407   address      _last_insn;      // used to merge consecutive memory barriers, loads or stores.
408 
409 #ifndef PRODUCT
410   CodeStrings  _code_strings;
411   bool         _collect_comments; // Indicate if we need to collect block comments at all.
412   address      _decode_begin;     // start address for decode
413   address      decode_begin();
414 #endif
415 
initialize_misc(const char * name)416   void initialize_misc(const char * name) {
417     // all pointers other than code_start/end and those inside the sections
418     assert(name != NULL, "must have a name");
419     _name            = name;
420     _before_expand   = NULL;
421     _blob            = NULL;
422     _oop_recorder    = NULL;
423     _overflow_arena  = NULL;
424     _last_insn       = NULL;
425 
426 #ifndef PRODUCT
427     _decode_begin    = NULL;
428     _code_strings    = CodeStrings();
429     // Collect block comments, but restrict collection to cases where a disassembly is output.
430     _collect_comments = ( PrintAssembly
431                        || PrintStubCode
432                        || PrintMethodHandleStubs
433                        || PrintInterpreter
434                        || PrintSignatureHandlers
435                        || UnlockDiagnosticVMOptions
436                         );
437 #endif
438   }
439 
initialize(address code_start,csize_t code_size)440   void initialize(address code_start, csize_t code_size) {
441     _consts.initialize_outer(this,  SECT_CONSTS);
442     _insts.initialize_outer(this,   SECT_INSTS);
443     _stubs.initialize_outer(this,   SECT_STUBS);
444     _total_start = code_start;
445     _total_size  = code_size;
446     // Initialize the main section:
447     _insts.initialize(code_start, code_size);
448     assert(!_stubs.is_allocated(),  "no garbage here");
449     assert(!_consts.is_allocated(), "no garbage here");
450     _oop_recorder = &_default_oop_recorder;
451   }
452 
453   void initialize_section_size(CodeSection* cs, csize_t size);
454 
455   // helper for CodeBuffer::expand()
456   void take_over_code_from(CodeBuffer* cs);
457 
458   // ensure sections are disjoint, ordered, and contained in the blob
459   void verify_section_allocation();
460 
461   // copies combined relocations to the blob, returns bytes copied
462   // (if target is null, it is a dry run only, just for sizing)
463   csize_t copy_relocations_to(CodeBlob* blob) const;
464 
465   // copies combined code to the blob (assumes relocs are already in there)
466   void copy_code_to(CodeBlob* blob);
467 
468   // moves code sections to new buffer (assumes relocs are already in there)
469   void relocate_code_to(CodeBuffer* cb) const;
470 
471   // set up a model of the final layout of my contents
472   void compute_final_layout(CodeBuffer* dest) const;
473 
474   // Expand the given section so at least 'amount' is remaining.
475   // Creates a new, larger BufferBlob, and rewrites the code & relocs.
476   void expand(CodeSection* which_cs, csize_t amount);
477 
478   // Helper for expand.
479   csize_t figure_expanded_capacities(CodeSection* which_cs, csize_t amount, csize_t* new_capacity);
480 
481  public:
482   // (1) code buffer referring to pre-allocated instruction memory
CodeBuffer(address code_start,csize_t code_size)483   CodeBuffer(address code_start, csize_t code_size) {
484     assert(code_start != NULL, "sanity");
485     initialize_misc("static buffer");
486     initialize(code_start, code_size);
487     debug_only(verify_section_allocation();)
488   }
489 
490   // (2) CodeBuffer referring to pre-allocated CodeBlob.
491   CodeBuffer(CodeBlob* blob);
492 
493   // (3) code buffer allocating codeBlob memory for code & relocation
494   // info but with lazy initialization.  The name must be something
495   // informative.
CodeBuffer(const char * name)496   CodeBuffer(const char* name) {
497     initialize_misc(name);
498   }
499 
500   // (4) code buffer allocating codeBlob memory for code & relocation
501   // info.  The name must be something informative and code_size must
502   // include both code and stubs sizes.
CodeBuffer(const char * name,csize_t code_size,csize_t locs_size)503   CodeBuffer(const char* name, csize_t code_size, csize_t locs_size) {
504     initialize_misc(name);
505     initialize(code_size, locs_size);
506   }
507 
508   ~CodeBuffer();
509 
510   // Initialize a CodeBuffer constructed using constructor 3.  Using
511   // constructor 4 is equivalent to calling constructor 3 and then
512   // calling this method.  It's been factored out for convenience of
513   // construction.
514   void initialize(csize_t code_size, csize_t locs_size);
515 
consts()516   CodeSection* consts() { return &_consts; }
insts()517   CodeSection* insts() { return &_insts; }
stubs()518   CodeSection* stubs() { return &_stubs; }
519 
insts() const520   const CodeSection* insts() const { return &_insts; }
521 
522   // present sections in order; return NULL at end; consts is #0, etc.
code_section(int n)523   CodeSection* code_section(int n) {
524     // This makes the slightly questionable but portable assumption
525     // that the various members (_consts, _insts, _stubs, etc.) are
526     // adjacent in the layout of CodeBuffer.
527     CodeSection* cs = &_consts + n;
528     assert(cs->index() == n || !cs->is_allocated(), "sanity");
529     return cs;
530   }
code_section(int n) const531   const CodeSection* code_section(int n) const {  // yucky const stuff
532     return ((CodeBuffer*)this)->code_section(n);
533   }
534   static const char* code_section_name(int n);
535   int section_index_of(address addr) const;
contains(address addr) const536   bool contains(address addr) const {
537     // handy for debugging
538     return section_index_of(addr) > SECT_NONE;
539   }
540 
541   // A stable mapping between 'locators' (small ints) and addresses.
locator_pos(int locator)542   static int locator_pos(int locator)   { return locator >> sect_bits; }
locator_sect(int locator)543   static int locator_sect(int locator)  { return locator &  sect_mask; }
locator(int pos,int sect)544   static int locator(int pos, int sect) { return (pos << sect_bits) | sect; }
545   int        locator(address addr) const;
locator_address(int locator) const546   address    locator_address(int locator) const {
547     if (locator < 0)  return NULL;
548     address start = code_section(locator_sect(locator))->start();
549     return start + locator_pos(locator);
550   }
551 
552   // Heuristic for pre-packing the taken/not-taken bit of a predicted branch.
553   bool is_backward_branch(Label& L);
554 
555   // Properties
name() const556   const char* name() const                  { return _name; }
set_name(const char * name)557   void set_name(const char* name)           { _name = name; }
before_expand() const558   CodeBuffer* before_expand() const         { return _before_expand; }
blob() const559   BufferBlob* blob() const                  { return _blob; }
560   void    set_blob(BufferBlob* blob);
561   void   free_blob();                       // Free the blob, if we own one.
562 
563   // Properties relative to the insts section:
insts_begin() const564   address       insts_begin() const      { return _insts.start();      }
insts_end() const565   address       insts_end() const        { return _insts.end();        }
set_insts_end(address end)566   void      set_insts_end(address end)   {        _insts.set_end(end); }
insts_mark() const567   address       insts_mark() const       { return _insts.mark();       }
set_insts_mark()568   void      set_insts_mark()             {        _insts.set_mark();   }
569 
570   // is there anything in the buffer other than the current section?
is_pure() const571   bool    is_pure() const                { return insts_size() == total_content_size(); }
572 
573   // size in bytes of output so far in the insts sections
insts_size() const574   csize_t insts_size() const             { return _insts.size(); }
575 
576   // same as insts_size(), except that it asserts there is no non-code here
pure_insts_size() const577   csize_t pure_insts_size() const        { assert(is_pure(), "no non-code");
578                                            return insts_size(); }
579   // capacity in bytes of the insts sections
insts_capacity() const580   csize_t insts_capacity() const         { return _insts.capacity(); }
581 
582   // number of bytes remaining in the insts section
insts_remaining() const583   csize_t insts_remaining() const        { return _insts.remaining(); }
584 
585   // is a given address in the insts section?  (2nd version is end-inclusive)
insts_contains(address pc) const586   bool insts_contains(address pc) const  { return _insts.contains(pc); }
insts_contains2(address pc) const587   bool insts_contains2(address pc) const { return _insts.contains2(pc); }
588 
589   // Record any extra oops required to keep embedded metadata alive
590   void finalize_oop_references(const methodHandle& method);
591 
592   // Allocated size in all sections, when aligned and concatenated
593   // (this is the eventual state of the content in its final
594   // CodeBlob).
595   csize_t total_content_size() const;
596 
597   // Combined offset (relative to start of first section) of given
598   // section, as eventually found in the final CodeBlob.
599   csize_t total_offset_of(const CodeSection* cs) const;
600 
601   // allocated size of all relocation data, including index, rounded up
602   csize_t total_relocation_size() const;
603 
604   csize_t copy_relocations_to(address buf, csize_t buf_limit, bool only_inst) const;
605 
606   // allocated size of any and all recorded oops
total_oop_size() const607   csize_t total_oop_size() const {
608     OopRecorder* recorder = oop_recorder();
609     return (recorder == NULL)? 0: recorder->oop_size();
610   }
611 
612   // allocated size of any and all recorded metadata
total_metadata_size() const613   csize_t total_metadata_size() const {
614     OopRecorder* recorder = oop_recorder();
615     return (recorder == NULL)? 0: recorder->metadata_size();
616   }
617 
618   // Configuration functions, called immediately after the CB is constructed.
619   // The section sizes are subtracted from the original insts section.
620   // Note:  Call them in reverse section order, because each steals from insts.
initialize_consts_size(csize_t size)621   void initialize_consts_size(csize_t size)            { initialize_section_size(&_consts,  size); }
initialize_stubs_size(csize_t size)622   void initialize_stubs_size(csize_t size)             { initialize_section_size(&_stubs,   size); }
623   // Override default oop recorder.
624   void initialize_oop_recorder(OopRecorder* r);
625 
oop_recorder() const626   OopRecorder* oop_recorder() const { return _oop_recorder; }
627 
last_insn() const628   address last_insn() const { return _last_insn; }
set_last_insn(address a)629   void set_last_insn(address a) { _last_insn = a; }
clear_last_insn()630   void clear_last_insn() { set_last_insn(NULL); }
631 
632 #ifndef PRODUCT
strings()633   CodeStrings& strings() { return _code_strings; }
634 
free_strings()635   void free_strings() {
636     if (!_code_strings.is_null()) {
637       _code_strings.free(); // sets _strings Null as a side-effect.
638     }
639   }
640 #endif
641 
642   // Code generation
relocate(address at,RelocationHolder const & rspec,int format=0)643   void relocate(address at, RelocationHolder const& rspec, int format = 0) {
644     _insts.relocate(at, rspec, format);
645   }
relocate(address at,relocInfo::relocType rtype,int format=0)646   void relocate(address at,    relocInfo::relocType rtype, int format = 0) {
647     _insts.relocate(at, rtype, format);
648   }
649 
650   // Management of overflow storage for binding of Labels.
651   GrowableArray<int>* create_patch_overflow();
652 
653   // NMethod generation
copy_code_and_locs_to(CodeBlob * blob)654   void copy_code_and_locs_to(CodeBlob* blob) {
655     assert(blob != NULL, "sane");
656     copy_relocations_to(blob);
657     copy_code_to(blob);
658   }
copy_values_to(nmethod * nm)659   void copy_values_to(nmethod* nm) {
660     if (!oop_recorder()->is_unused()) {
661       oop_recorder()->copy_values_to(nm);
662     }
663   }
664 
665   void block_comment(intptr_t offset, const char * comment) PRODUCT_RETURN;
666   const char* code_string(const char* str) PRODUCT_RETURN_(return NULL;);
667 
668   // Log a little info about section usage in the CodeBuffer
669   void log_section_sizes(const char* name);
670 
671 #ifndef PRODUCT
672  public:
673   // Printing / Decoding
674   // decodes from decode_begin() to code_end() and sets decode_begin to end
675   void    decode();
676   void    print();
677 #endif
678   // Directly disassemble code buffer.
679   void    decode(address start, address end);
680 
681   // The following header contains architecture-specific implementations
682 #include CPU_HEADER(codeBuffer)
683 
684 };
685 
maybe_expand_to_ensure_remaining(csize_t amount)686 inline bool CodeSection::maybe_expand_to_ensure_remaining(csize_t amount) {
687   if (remaining() < amount) { _outer->expand(this, amount); return true; }
688   return false;
689 }
690 
691 #endif // SHARE_ASM_CODEBUFFER_HPP
692