duke@435: /*
mikael@4153:  * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #ifndef SHARE_VM_MEMORY_THREADLOCALALLOCBUFFER_HPP
stefank@2314: #define SHARE_VM_MEMORY_THREADLOCALALLOCBUFFER_HPP
stefank@2314: 
stefank@2314: #include "gc_implementation/shared/gcUtil.hpp"
stefank@2314: #include "oops/typeArrayOop.hpp"
stefank@2314: #include "runtime/perfData.hpp"
stefank@2314: 
duke@435: class GlobalTLABStats;
duke@435: 
duke@435: // ThreadLocalAllocBuffer: a descriptor for thread-local storage used by
duke@435: // the threads for allocation.
duke@435: //            It is thread-private at any time, but maybe multiplexed over
duke@435: //            time across multiple threads. The park()/unpark() pair is
jwilhelm@4129: //            used to make it available for such multiplexing.
zgu@3900: class ThreadLocalAllocBuffer: public CHeapObj<mtThread> {
duke@435:   friend class VMStructs;
duke@435: private:
duke@435:   HeapWord* _start;                              // address of TLAB
duke@435:   HeapWord* _top;                                // address after last allocation
duke@435:   HeapWord* _pf_top;                             // allocation prefetch watermark
duke@435:   HeapWord* _end;                                // allocation end (excluding alignment_reserve)
duke@435:   size_t    _desired_size;                       // desired size   (including alignment_reserve)
duke@435:   size_t    _refill_waste_limit;                 // hold onto tlab if free() is larger than this
brutisso@6376:   size_t    _allocated_before_last_gc;           // total bytes allocated up until the last gc
duke@435: 
brutisso@6376:   static size_t   _max_size;                     // maximum size of any TLAB
duke@435:   static unsigned _target_refills;               // expected number of refills between GCs
duke@435: 
duke@435:   unsigned  _number_of_refills;
duke@435:   unsigned  _fast_refill_waste;
duke@435:   unsigned  _slow_refill_waste;
duke@435:   unsigned  _gc_waste;
duke@435:   unsigned  _slow_allocations;
duke@435: 
duke@435:   AdaptiveWeightedAverage _allocation_fraction;  // fraction of eden allocated in tlabs
duke@435: 
duke@435:   void accumulate_statistics();
duke@435:   void initialize_statistics();
duke@435: 
duke@435:   void set_start(HeapWord* start)                { _start = start; }
duke@435:   void set_end(HeapWord* end)                    { _end = end; }
duke@435:   void set_top(HeapWord* top)                    { _top = top; }
duke@435:   void set_pf_top(HeapWord* pf_top)              { _pf_top = pf_top; }
duke@435:   void set_desired_size(size_t desired_size)     { _desired_size = desired_size; }
duke@435:   void set_refill_waste_limit(size_t waste)      { _refill_waste_limit = waste;  }
duke@435: 
duke@435:   size_t initial_refill_waste_limit()            { return desired_size() / TLABRefillWasteFraction; }
duke@435: 
duke@435:   static int    target_refills()                 { return _target_refills; }
duke@435:   size_t initial_desired_size();
duke@435: 
duke@435:   size_t remaining() const                       { return end() == NULL ? 0 : pointer_delta(hard_end(), top()); }
duke@435: 
duke@435:   // Make parsable and release it.
duke@435:   void reset();
duke@435: 
duke@435:   // Resize based on amount of allocation, etc.
duke@435:   void resize();
duke@435: 
duke@435:   void invariants() const { assert(top() >= start() && top() <= end(), "invalid tlab"); }
duke@435: 
duke@435:   void initialize(HeapWord* start, HeapWord* top, HeapWord* end);
duke@435: 
duke@435:   void print_stats(const char* tag);
duke@435: 
duke@435:   Thread* myThread();
duke@435: 
duke@435:   // statistics
duke@435: 
duke@435:   int number_of_refills() const { return _number_of_refills; }
duke@435:   int fast_refill_waste() const { return _fast_refill_waste; }
duke@435:   int slow_refill_waste() const { return _slow_refill_waste; }
duke@435:   int gc_waste() const          { return _gc_waste; }
duke@435:   int slow_allocations() const  { return _slow_allocations; }
duke@435: 
duke@435:   static GlobalTLABStats* _global_stats;
duke@435:   static GlobalTLABStats* global_stats() { return _global_stats; }
duke@435: 
duke@435: public:
brutisso@6376:   ThreadLocalAllocBuffer() : _allocation_fraction(TLABAllocationWeight), _allocated_before_last_gc(0) {
duke@435:     // do nothing.  tlabs must be inited by initialize() calls
duke@435:   }
duke@435: 
mgerdin@7470:   static const size_t min_size()                 { return align_object_size(MinTLABSize / HeapWordSize) + alignment_reserve(); }
brutisso@6376:   static const size_t max_size()                 { assert(_max_size != 0, "max_size not set up"); return _max_size; }
brutisso@6376:   static void set_max_size(size_t max_size)      { _max_size = max_size; }
duke@435: 
duke@435:   HeapWord* start() const                        { return _start; }
duke@435:   HeapWord* end() const                          { return _end; }
duke@435:   HeapWord* hard_end() const                     { return _end + alignment_reserve(); }
duke@435:   HeapWord* top() const                          { return _top; }
duke@435:   HeapWord* pf_top() const                       { return _pf_top; }
duke@435:   size_t desired_size() const                    { return _desired_size; }
phh@2423:   size_t used() const                            { return pointer_delta(top(), start()); }
phh@2423:   size_t used_bytes() const                      { return pointer_delta(top(), start(), 1); }
duke@435:   size_t free() const                            { return pointer_delta(end(), top()); }
duke@435:   // Don't discard tlab if remaining space is larger than this.
duke@435:   size_t refill_waste_limit() const              { return _refill_waste_limit; }
duke@435: 
duke@435:   // Allocate size HeapWords. The memory is NOT initialized to zero.
duke@435:   inline HeapWord* allocate(size_t size);
kvn@1802: 
kvn@1802:   // Reserve space at the end of TLAB
kvn@1802:   static size_t end_reserve() {
kvn@1802:     int reserve_size = typeArrayOopDesc::header_size(T_INT);
kvn@3052:     return MAX2(reserve_size, VM_Version::reserve_for_allocation_prefetch());
kvn@1802:   }
kvn@1802:   static size_t alignment_reserve()              { return align_object_size(end_reserve()); }
duke@435:   static size_t alignment_reserve_in_bytes()     { return alignment_reserve() * HeapWordSize; }
duke@435: 
duke@435:   // Return tlab size or remaining space in eden such that the
duke@435:   // space is large enough to hold obj_size and necessary fill space.
duke@435:   // Otherwise return 0;
duke@435:   inline size_t compute_size(size_t obj_size);
duke@435: 
duke@435:   // Record slow allocation
duke@435:   inline void record_slow_allocation(size_t obj_size);
duke@435: 
duke@435:   // Initialization at startup
duke@435:   static void startup_initialization();
duke@435: 
duke@435:   // Make an in-use tlab parsable, optionally also retiring it.
duke@435:   void make_parsable(bool retire);
duke@435: 
duke@435:   // Retire in-use tlab before allocation of a new tlab
duke@435:   void clear_before_allocation();
duke@435: 
duke@435:   // Accumulate statistics across all tlabs before gc
duke@435:   static void accumulate_statistics_before_gc();
duke@435: 
duke@435:   // Resize tlabs for all threads
duke@435:   static void resize_all_tlabs();
duke@435: 
duke@435:   void fill(HeapWord* start, HeapWord* top, size_t new_size);
duke@435:   void initialize();
duke@435: 
duke@435:   static size_t refill_waste_limit_increment()   { return TLABWasteIncrement; }
duke@435: 
duke@435:   // Code generation support
duke@435:   static ByteSize start_offset()                 { return byte_offset_of(ThreadLocalAllocBuffer, _start); }
duke@435:   static ByteSize end_offset()                   { return byte_offset_of(ThreadLocalAllocBuffer, _end  ); }
duke@435:   static ByteSize top_offset()                   { return byte_offset_of(ThreadLocalAllocBuffer, _top  ); }
duke@435:   static ByteSize pf_top_offset()                { return byte_offset_of(ThreadLocalAllocBuffer, _pf_top  ); }
duke@435:   static ByteSize size_offset()                  { return byte_offset_of(ThreadLocalAllocBuffer, _desired_size ); }
duke@435:   static ByteSize refill_waste_limit_offset()    { return byte_offset_of(ThreadLocalAllocBuffer, _refill_waste_limit ); }
duke@435: 
duke@435:   static ByteSize number_of_refills_offset()     { return byte_offset_of(ThreadLocalAllocBuffer, _number_of_refills ); }
duke@435:   static ByteSize fast_refill_waste_offset()     { return byte_offset_of(ThreadLocalAllocBuffer, _fast_refill_waste ); }
duke@435:   static ByteSize slow_allocations_offset()      { return byte_offset_of(ThreadLocalAllocBuffer, _slow_allocations ); }
duke@435: 
duke@435:   void verify();
duke@435: };
duke@435: 
zgu@3900: class GlobalTLABStats: public CHeapObj<mtThread> {
duke@435: private:
duke@435: 
duke@435:   // Accumulate perfdata in private variables because
duke@435:   // PerfData should be write-only for security reasons
duke@435:   // (see perfData.hpp)
duke@435:   unsigned _allocating_threads;
duke@435:   unsigned _total_refills;
duke@435:   unsigned _max_refills;
duke@435:   size_t   _total_allocation;
duke@435:   size_t   _total_gc_waste;
duke@435:   size_t   _max_gc_waste;
duke@435:   size_t   _total_slow_refill_waste;
duke@435:   size_t   _max_slow_refill_waste;
duke@435:   size_t   _total_fast_refill_waste;
duke@435:   size_t   _max_fast_refill_waste;
duke@435:   unsigned _total_slow_allocations;
duke@435:   unsigned _max_slow_allocations;
duke@435: 
duke@435:   PerfVariable* _perf_allocating_threads;
duke@435:   PerfVariable* _perf_total_refills;
duke@435:   PerfVariable* _perf_max_refills;
duke@435:   PerfVariable* _perf_allocation;
duke@435:   PerfVariable* _perf_gc_waste;
duke@435:   PerfVariable* _perf_max_gc_waste;
duke@435:   PerfVariable* _perf_slow_refill_waste;
duke@435:   PerfVariable* _perf_max_slow_refill_waste;
duke@435:   PerfVariable* _perf_fast_refill_waste;
duke@435:   PerfVariable* _perf_max_fast_refill_waste;
duke@435:   PerfVariable* _perf_slow_allocations;
duke@435:   PerfVariable* _perf_max_slow_allocations;
duke@435: 
duke@435:   AdaptiveWeightedAverage _allocating_threads_avg;
duke@435: 
duke@435: public:
duke@435:   GlobalTLABStats();
duke@435: 
duke@435:   // Initialize all counters
duke@435:   void initialize();
duke@435: 
duke@435:   // Write all perf counters to the perf_counters
duke@435:   void publish();
duke@435: 
duke@435:   void print();
duke@435: 
duke@435:   // Accessors
duke@435:   unsigned allocating_threads_avg() {
duke@435:     return MAX2((unsigned)(_allocating_threads_avg.average() + 0.5), 1U);
duke@435:   }
duke@435: 
duke@435:   size_t allocation() {
duke@435:     return _total_allocation;
duke@435:   }
duke@435: 
duke@435:   // Update methods
duke@435: 
duke@435:   void update_allocating_threads() {
duke@435:     _allocating_threads++;
duke@435:   }
duke@435:   void update_number_of_refills(unsigned value) {
duke@435:     _total_refills += value;
duke@435:     _max_refills    = MAX2(_max_refills, value);
duke@435:   }
duke@435:   void update_allocation(size_t value) {
duke@435:     _total_allocation += value;
duke@435:   }
duke@435:   void update_gc_waste(size_t value) {
duke@435:     _total_gc_waste += value;
duke@435:     _max_gc_waste    = MAX2(_max_gc_waste, value);
duke@435:   }
duke@435:   void update_fast_refill_waste(size_t value) {
duke@435:     _total_fast_refill_waste += value;
duke@435:     _max_fast_refill_waste    = MAX2(_max_fast_refill_waste, value);
duke@435:   }
duke@435:   void update_slow_refill_waste(size_t value) {
duke@435:     _total_slow_refill_waste += value;
duke@435:     _max_slow_refill_waste    = MAX2(_max_slow_refill_waste, value);
duke@435:   }
duke@435:   void update_slow_allocations(unsigned value) {
duke@435:     _total_slow_allocations += value;
duke@435:     _max_slow_allocations    = MAX2(_max_slow_allocations, value);
duke@435:   }
duke@435: };
stefank@2314: 
stefank@2314: #endif // SHARE_VM_MEMORY_THREADLOCALALLOCBUFFER_HPP