1 /*

     2  * Copyright (c) 2001, 2010, 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_GC_IMPLEMENTATION_CONCURRENTMARKSWEEP_FREEBLOCKDICTIONARY_HPP

    26 #define SHARE_VM_GC_IMPLEMENTATION_CONCURRENTMARKSWEEP_FREEBLOCKDICTIONARY_HPP

    27 

    28 #include "gc_implementation/concurrentMarkSweep/freeChunk.hpp"

    29 #include "memory/allocation.hpp"

    30 #include "memory/memRegion.hpp"

    31 #include "runtime/mutex.hpp"

    32 #include "utilities/debug.hpp"

    33 #include "utilities/globalDefinitions.hpp"

    34 #include "utilities/ostream.hpp"

    35 

    36 // A FreeBlockDictionary is an abstract superclass that will allow

    37 // a number of alternative implementations in the future.

    38 class FreeBlockDictionary: public CHeapObj {

    39  public:

    40   enum Dither {

    41     atLeast,

    42     exactly,

    43     roughly

    44   };

    45   enum DictionaryChoice {

    46     dictionaryBinaryTree = 0,

    47     dictionarySplayTree  = 1,

    48     dictionarySkipList   = 2

    49   };

    50 

    51  private:

    52   NOT_PRODUCT(Mutex* _lock;)

    53 

    54  public:

    55   virtual void       removeChunk(FreeChunk* fc) = 0;

    56   virtual FreeChunk* getChunk(size_t size, Dither dither = atLeast) = 0;

    57   virtual void       returnChunk(FreeChunk* chunk) = 0;

    58   virtual size_t     totalChunkSize(debug_only(const Mutex* lock)) const = 0;

    59   virtual size_t     maxChunkSize()   const = 0;

    60   virtual size_t     minSize()        const = 0;

    61   // Reset the dictionary to the initial conditions for a single

    62   // block.

    63   virtual void       reset(HeapWord* addr, size_t size) = 0;

    64   virtual void       reset() = 0;

    65 

    66   virtual void       dictCensusUpdate(size_t size, bool split, bool birth) = 0;

    67   virtual bool       coalDictOverPopulated(size_t size) = 0;

    68   virtual void       beginSweepDictCensus(double coalSurplusPercent,

    69                        float inter_sweep_current, float inter_sweep_estimate,

    70                        float intra__sweep_current) = 0;

    71   virtual void       endSweepDictCensus(double splitSurplusPercent) = 0;

    72   virtual FreeChunk* findLargestDict() const = 0;

    73   // verify that the given chunk is in the dictionary.

    74   virtual bool verifyChunkInFreeLists(FreeChunk* tc) const = 0;

    75 

    76   // Sigma_{all_free_blocks} (block_size^2)

    77   virtual double sum_of_squared_block_sizes() const = 0;

    78 

    79   virtual FreeChunk* find_chunk_ends_at(HeapWord* target) const = 0;

    80   virtual void inc_totalSize(size_t v) = 0;

    81   virtual void dec_totalSize(size_t v) = 0;

    82 

    83   NOT_PRODUCT (

    84     virtual size_t   sumDictReturnedBytes() = 0;

    85     virtual void     initializeDictReturnedBytes() = 0;

    86     virtual size_t   totalCount() = 0;

    87   )

    88 

    89   virtual void       reportStatistics() const {

    90     gclog_or_tty->print("No statistics available");

    91   }

    92 

    93   virtual void       printDictCensus() const = 0;

    94   virtual void       print_free_lists(outputStream* st) const = 0;

    95 

    96   virtual void       verify()         const = 0;

    97 

    98   Mutex* par_lock()                const PRODUCT_RETURN0;

    99   void   set_par_lock(Mutex* lock)       PRODUCT_RETURN;

   100   void   verify_par_locked()       const PRODUCT_RETURN;

   101 };

   102 

   103 #endif // SHARE_VM_GC_IMPLEMENTATION_CONCURRENTMARKSWEEP_FREEBLOCKDICTIONARY_HPP