1 /*
   2  * Copyright (c) 2014, 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 #include "precompiled.hpp"
  25 
  26 #include "runtime/atomic.hpp"
  27 #include "runtime/atomic.inline.hpp"
  28 #include "services/mallocSiteTable.hpp"
  29 #include "services/mallocTracker.hpp"
  30 #include "services/mallocTracker.inline.hpp"
  31 #include "services/memTracker.hpp"
  32 
  33 size_t MallocMemorySummary::_snapshot[CALC_OBJ_SIZE_IN_TYPE(MallocMemorySnapshot, size_t)];
  34 
  35 // Total malloc'd memory amount
  36 size_t MallocMemorySnapshot::total() const {
  37   size_t amount = 0;
  38   for (int index = 0; index < mt_number_of_types; index ++) {
  39     amount += _malloc[index].malloc_size();
  40   }
  41   amount += _tracking_header.size() + total_arena();
  42   return amount;
  43 }
  44 
  45 // Total malloc'd memory used by arenas
  46 size_t MallocMemorySnapshot::total_arena() const {
  47   size_t amount = 0;
  48   for (int index = 0; index < mt_number_of_types; index ++) {
  49     amount += _malloc[index].arena_size();
  50   }
  51   return amount;
  52 }
  53 
  54 // Make adjustment by subtracting chunks used by arenas
  55 // from total chunks to get total free chunck size
  56 void MallocMemorySnapshot::make_adjustment() {
  57   size_t arena_size = total_arena();
  58   int chunk_idx = NMTUtil::flag_to_index(mtChunk);
  59   _malloc[chunk_idx].record_free(arena_size);
  60 }
  61 
  62 
  63 void MallocMemorySummary::initialize() {
  64   assert(sizeof(_snapshot) >= sizeof(MallocMemorySnapshot), "Sanity Check");
  65   // Uses placement new operator to initialize static area.
  66   ::new ((void*)_snapshot)MallocMemorySnapshot();
  67 }
  68 
  69 void MallocHeader::release() const {
  70   // Tracking already shutdown, no housekeeping is needed anymore
  71   if (MemTracker::tracking_level() <= NMT_minimal) return;
  72 
  73   MallocMemorySummary::record_free(size(), flags());
  74   MallocMemorySummary::record_free_malloc_header(sizeof(MallocHeader));
  75   if (tracking_level() == NMT_detail) {
  76     MallocSiteTable::deallocation_at(size(), _bucket_idx, _pos_idx);
  77   }
  78 }
  79 
  80 bool MallocHeader::record_malloc_site(const NativeCallStack& stack, size_t size,
  81   size_t* bucket_idx, size_t* pos_idx) const {
  82   bool ret =  MallocSiteTable::allocation_at(stack, size, bucket_idx, pos_idx);
  83 
  84   // Something went wrong, could be OOM or overflow malloc site table.
  85   // We want to keep tracking data under OOM circumstance, so transition to
  86   // summary tracking.
  87   if (!ret) {
  88     MemTracker::transition_to(NMT_summary);
  89   }
  90   return ret;
  91 }
  92 
  93 bool MallocHeader::get_stack(NativeCallStack& stack) const {
  94   return MallocSiteTable::access_stack(stack, _bucket_idx, _pos_idx);
  95 }
  96 
  97 bool MallocTracker::initialize(NMT_TrackingLevel level) {
  98   if (level >= NMT_summary) {
  99     MallocMemorySummary::initialize();
 100   }
 101 
 102   if (level == NMT_detail) {
 103     return MallocSiteTable::initialize();
 104   }
 105   return true;
 106 }
 107 
 108 bool MallocTracker::transition(NMT_TrackingLevel from, NMT_TrackingLevel to) {
 109   assert(from != NMT_off, "Can not transition from off state");
 110   assert(to != NMT_off, "Can not transition to off state");
 111   assert (from != NMT_minimal, "cannot transition from minimal state");
 112 
 113   if (from == NMT_detail) {
 114     assert(to == NMT_minimal || to == NMT_summary, "Just check");
 115     MallocSiteTable::shutdown();
 116   }
 117   return true;
 118 }
 119 
 120 // Record a malloc memory allocation
 121 void* MallocTracker::record_malloc(void* malloc_base, size_t size, MEMFLAGS flags,
 122   const NativeCallStack& stack, NMT_TrackingLevel level) {
 123   void*         memblock;      // the address for user data
 124   MallocHeader* header = NULL;
 125 
 126   if (malloc_base == NULL) {
 127     return NULL;
 128   }
 129 
 130   // Uses placement global new operator to initialize malloc header
 131   switch(level) {
 132     case NMT_off:
 133       return malloc_base;
 134     case NMT_minimal: {
 135       MallocHeader* hdr = ::new (malloc_base) MallocHeader();
 136       break;
 137     }
 138     case NMT_summary: {
 139       assert(size <= MAX_MALLOC_SIZE, "malloc size overrun for NMT");
 140       header = ::new (malloc_base) MallocHeader(size, flags);
 141       break;
 142     }
 143     case NMT_detail: {
 144       assert(size <= MAX_MALLOC_SIZE, "malloc size overrun for NMT");
 145       header = ::new (malloc_base) MallocHeader(size, flags, stack);
 146       break;
 147     }
 148     default:
 149       ShouldNotReachHere();
 150   }
 151   memblock = (void*)((char*)malloc_base + sizeof(MallocHeader));
 152 
 153   // The alignment check: 8 bytes alignment for 32 bit systems.
 154   //                      16 bytes alignment for 64-bit systems.
 155   assert(((size_t)memblock & (sizeof(size_t) * 2 - 1)) == 0, "Alignment check");
 156 
 157   // Sanity check
 158   assert(get_memory_tracking_level(memblock) == level,
 159     "Wrong tracking level");
 160 
 161 #ifdef ASSERT
 162   if (level > NMT_minimal) {
 163     // Read back
 164     assert(get_size(memblock) == size,   "Wrong size");
 165     assert(get_flags(memblock) == flags, "Wrong flags");
 166   }
 167 #endif
 168 
 169   return memblock;
 170 }
 171 
 172 void* MallocTracker::record_free(void* memblock) {
 173   // Never turned on
 174   if (MemTracker::tracking_level() == NMT_off ||
 175       memblock == NULL) {
 176     return memblock;
 177   }
 178   MallocHeader* header = malloc_header(memblock);
 179   header->release();
 180 
 181   return (void*)header;
 182 }
 183 
 184