1 /*
   2  * Copyright (c) 2012, 2016, 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 #include "precompiled.hpp"
  26 #include "logging/log.hpp"
  27 #include "memory/allocation.hpp"
  28 #include "memory/metaspace/metachunk.hpp"
  29 #include "memory/metaspace/occupancyMap.hpp"
  30 #include "memory/metaspace/virtualSpaceNode.hpp"
  31 #include "utilities/align.hpp"
  32 #include "utilities/copy.hpp"
  33 #include "utilities/debug.hpp"
  34 
  35 namespace metaspace {
  36 
  37 size_t Metachunk::object_alignment() {
  38   // Must align pointers and sizes to 8,
  39   // so that 64 bit types get correctly aligned.
  40   const size_t alignment = 8;
  41 
  42   // Make sure that the Klass alignment also agree.
  43   STATIC_ASSERT(alignment == (size_t)KlassAlignmentInBytes);
  44 
  45   return alignment;
  46 }
  47 
  48 size_t Metachunk::overhead() {
  49   return align_up(sizeof(Metachunk), object_alignment()) / BytesPerWord;
  50 }
  51 
  52 // Metachunk methods
  53 
  54 Metachunk::Metachunk(ChunkIndex chunktype, bool is_class, size_t word_size,
  55                      VirtualSpaceNode* container)
  56     : Metabase<Metachunk>(word_size),
  57     _container(container),
  58     _top(NULL),
  59     _sentinel(CHUNK_SENTINEL),
  60     _chunk_type(chunktype),
  61     _is_class(is_class),
  62     _origin(origin_normal),
  63     _use_count(0)
  64 {
  65   _top = initial_top();
  66   set_is_tagged_free(false);
  67 #ifdef ASSERT
  68   mangle(uninitMetaWordVal);
  69   verify();
  70 #endif
  71 }
  72 
  73 MetaWord* Metachunk::allocate(size_t word_size) {
  74   MetaWord* result = NULL;
  75   // If available, bump the pointer to allocate.
  76   if (free_word_size() >= word_size) {
  77     result = _top;
  78     _top = _top + word_size;
  79   }
  80   return result;
  81 }
  82 
  83 // _bottom points to the start of the chunk including the overhead.
  84 size_t Metachunk::used_word_size() const {
  85   return pointer_delta(_top, bottom(), sizeof(MetaWord));
  86 }
  87 
  88 size_t Metachunk::free_word_size() const {
  89   return pointer_delta(end(), _top, sizeof(MetaWord));
  90 }
  91 
  92 void Metachunk::print_on(outputStream* st) const {
  93   st->print_cr("Metachunk:"
  94                " bottom " PTR_FORMAT " top " PTR_FORMAT
  95                " end " PTR_FORMAT " size " SIZE_FORMAT " (%s)",
  96                p2i(bottom()), p2i(_top), p2i(end()), word_size(),
  97                chunk_size_name(get_chunk_type()));
  98   if (Verbose) {
  99     st->print_cr("    used " SIZE_FORMAT " free " SIZE_FORMAT,
 100                  used_word_size(), free_word_size());
 101   }
 102 }
 103 
 104 #ifdef ASSERT
 105 void Metachunk::mangle(juint word_value) {
 106   // Overwrite the payload of the chunk and not the links that
 107   // maintain list of chunks.
 108   HeapWord* start = (HeapWord*)initial_top();
 109   size_t size = word_size() - overhead();
 110   Copy::fill_to_words(start, size, word_value);
 111 }
 112 
 113 void Metachunk::verify() const {
 114   assert(is_valid_sentinel(), "Chunk " PTR_FORMAT ": sentinel invalid", p2i(this));
 115   const ChunkIndex chunk_type = get_chunk_type();
 116   assert(is_valid_chunktype(chunk_type), "Chunk " PTR_FORMAT ": Invalid chunk type.", p2i(this));
 117   if (chunk_type != HumongousIndex) {
 118     assert(word_size() == get_size_for_nonhumongous_chunktype(chunk_type, is_class()),
 119            "Chunk " PTR_FORMAT ": wordsize " SIZE_FORMAT " does not fit chunk type %s.",
 120            p2i(this), word_size(), chunk_size_name(chunk_type));
 121   }
 122   assert(is_valid_chunkorigin(get_origin()), "Chunk " PTR_FORMAT ": Invalid chunk origin.", p2i(this));
 123   assert(bottom() <= _top && _top <= (MetaWord*)end(),
 124          "Chunk " PTR_FORMAT ": Chunk top out of chunk bounds.", p2i(this));
 125 
 126   // For non-humongous chunks, starting address shall be aligned
 127   // to its chunk size. Humongous chunks start address is
 128   // aligned to specialized chunk size.
 129   const size_t required_alignment =
 130     (chunk_type != HumongousIndex ? word_size() : get_size_for_nonhumongous_chunktype(SpecializedIndex, is_class())) * sizeof(MetaWord);
 131   assert(is_aligned((address)this, required_alignment),
 132          "Chunk " PTR_FORMAT ": (size " SIZE_FORMAT ") not aligned to " SIZE_FORMAT ".",
 133          p2i(this), word_size() * sizeof(MetaWord), required_alignment);
 134 }
 135 
 136 #endif // ASSERT
 137 
 138 bool Metachunk::calc_uncommit_range(address* start, size_t* len) const {
 139   // All but the first page (which contains the header) can be uncommitted
 140   if (size() * sizeof(MetaWord) > (size_t)os::vm_page_size()) {
 141     address from = align_up((address)initial_top(), os::vm_page_size());
 142     address to = align_down((address)end(), os::vm_page_size());
 143     if (from < to) {
 144       *start = from;
 145       *len = to - from;
 146       return true;
 147     }
 148   }
 149   return false;
 150 }
 151 
 152 bool Metachunk::commit() {
 153   bool rc = false;
 154   address p = NULL; size_t len = 0;
 155   if (calc_uncommit_range(&p, &len)) {
 156     rc = os::commit_memory((char*)p, len, false);
 157     if (rc) {
 158       log_info(gc, metaspace)("Committed chunk " PTR_FORMAT " (payload area from " PTR_FORMAT " to " PTR_FORMAT ")",
 159                               p2i(this), p2i(p), p2i(p + len));
 160     }
 161   }
 162   return rc;
 163 }
 164 
 165 bool Metachunk::uncommit() {
 166   bool rc = false;
 167   address p = NULL; size_t len = 0;
 168   if (calc_uncommit_range(&p, &len)) {
 169     rc = os::uncommit_memory((char*)p, len);
 170     if (rc) {
 171       log_info(gc, metaspace)("Uncommitted chunk " PTR_FORMAT " (payload area from " PTR_FORMAT " to " PTR_FORMAT ")",
 172                               p2i(this), p2i(p), p2i(p + len));
 173     }
 174   }
 175   return rc;
 176 }
 177 
 178 // Helper, returns a descriptive name for the given index.
 179 const char* chunk_size_name(ChunkIndex index) {
 180   switch (index) {
 181     case SpecializedIndex:
 182       return "specialized";
 183     case SmallIndex:
 184       return "small";
 185     case MediumIndex:
 186       return "medium";
 187     case HumongousIndex:
 188       return "humongous";
 189     default:
 190       return "Invalid index";
 191   }
 192 }
 193 
 194 #ifdef ASSERT
 195 void do_verify_chunk(Metachunk* chunk) {
 196   guarantee(chunk != NULL, "Sanity");
 197   // Verify chunk itself; then verify that it is consistent with the
 198   // occupany map of its containing node.
 199   chunk->verify();
 200   VirtualSpaceNode* const vsn = chunk->container();
 201   OccupancyMap* const ocmap = vsn->occupancy_map();
 202   ocmap->verify_for_chunk(chunk);
 203 }
 204 #endif
 205 
 206 void do_update_in_use_info_for_chunk(Metachunk* chunk, bool inuse) {
 207   chunk->set_is_tagged_free(!inuse);
 208   OccupancyMap* const ocmap = chunk->container()->occupancy_map();
 209   ocmap->set_region_in_use((MetaWord*)chunk, chunk->word_size(), inuse);
 210 }
 211 
 212 } // namespace metaspace
 213