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