src/share/vm/memory/binaryTreeDictionary.hpp

Tue, 11 Feb 2014 09:34:50 +0100

author
goetz
date
Tue, 11 Feb 2014 09:34:50 +0100
changeset 6337
ab36007d6358
parent 6198
55fb97c4c58d
child 6876
710a3c8b516e
permissions
-rw-r--r--

8034171: Remove use of template template parameters from binaryTreeDictionary.
Reviewed-by: mgerdin, jmasa
Contributed-by: matthias.baesken@sap.com

duke@435 1 /*
mikael@6198 2 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
jmasa@3730 25 #ifndef SHARE_VM_MEMORY_BINARYTREEDICTIONARY_HPP
jmasa@3730 26 #define SHARE_VM_MEMORY_BINARYTREEDICTIONARY_HPP
stefank@2314 27
jmasa@3730 28 #include "memory/freeBlockDictionary.hpp"
jmasa@3730 29 #include "memory/freeList.hpp"
stefank@2314 30
duke@435 31 /*
duke@435 32 * A binary tree based search structure for free blocks.
jmasa@3730 33 * This is currently used in the Concurrent Mark&Sweep implementation, but
jmasa@3730 34 * will be used for free block management for metadata.
duke@435 35 */
duke@435 36
duke@435 37 // A TreeList is a FreeList which can be used to maintain a
duke@435 38 // binary tree of free lists.
duke@435 39
goetz@6337 40 template <class Chunk_t, class FreeList_t> class TreeChunk;
goetz@6337 41 template <class Chunk_t, class FreeList_t> class BinaryTreeDictionary;
goetz@6337 42 template <class Chunk_t, class FreeList_t> class AscendTreeCensusClosure;
goetz@6337 43 template <class Chunk_t, class FreeList_t> class DescendTreeCensusClosure;
goetz@6337 44 template <class Chunk_t, class FreeList_t> class DescendTreeSearchClosure;
duke@435 45
jmasa@4488 46 class FreeChunk;
jmasa@4488 47 template <class> class AdaptiveFreeList;
goetz@6337 48 typedef BinaryTreeDictionary<FreeChunk, AdaptiveFreeList<FreeChunk> > AFLBinaryTreeDictionary;
jmasa@4488 49
goetz@6337 50 template <class Chunk_t, class FreeList_t>
goetz@6337 51 class TreeList : public FreeList_t {
jmasa@4196 52 friend class TreeChunk<Chunk_t, FreeList_t>;
jmasa@4196 53 friend class BinaryTreeDictionary<Chunk_t, FreeList_t>;
jmasa@4196 54 friend class AscendTreeCensusClosure<Chunk_t, FreeList_t>;
jmasa@4196 55 friend class DescendTreeCensusClosure<Chunk_t, FreeList_t>;
jmasa@4196 56 friend class DescendTreeSearchClosure<Chunk_t, FreeList_t>;
jmasa@3730 57
jmasa@4196 58 TreeList<Chunk_t, FreeList_t>* _parent;
jmasa@4196 59 TreeList<Chunk_t, FreeList_t>* _left;
jmasa@4196 60 TreeList<Chunk_t, FreeList_t>* _right;
duke@435 61
duke@435 62 protected:
jmasa@3730 63
jmasa@4196 64 TreeList<Chunk_t, FreeList_t>* parent() const { return _parent; }
jmasa@4196 65 TreeList<Chunk_t, FreeList_t>* left() const { return _left; }
jmasa@4196 66 TreeList<Chunk_t, FreeList_t>* right() const { return _right; }
jmasa@3730 67
jmasa@4196 68 // Wrapper on call to base class, to get the template to compile.
goetz@6337 69 Chunk_t* head() const { return FreeList_t::head(); }
goetz@6337 70 Chunk_t* tail() const { return FreeList_t::tail(); }
goetz@6337 71 void set_head(Chunk_t* head) { FreeList_t::set_head(head); }
goetz@6337 72 void set_tail(Chunk_t* tail) { FreeList_t::set_tail(tail); }
mgerdin@3822 73
goetz@6337 74 size_t size() const { return FreeList_t::size(); }
duke@435 75
duke@435 76 // Accessors for links in tree.
duke@435 77
jmasa@4196 78 void set_left(TreeList<Chunk_t, FreeList_t>* tl) {
duke@435 79 _left = tl;
duke@435 80 if (tl != NULL)
jmasa@3732 81 tl->set_parent(this);
duke@435 82 }
jmasa@4196 83 void set_right(TreeList<Chunk_t, FreeList_t>* tl) {
duke@435 84 _right = tl;
duke@435 85 if (tl != NULL)
jmasa@3732 86 tl->set_parent(this);
duke@435 87 }
jmasa@4196 88 void set_parent(TreeList<Chunk_t, FreeList_t>* tl) { _parent = tl; }
duke@435 89
jmasa@4196 90 void clear_left() { _left = NULL; }
jmasa@3732 91 void clear_right() { _right = NULL; }
jmasa@3732 92 void clear_parent() { _parent = NULL; }
goetz@6337 93 void initialize() { clear_left(); clear_right(), clear_parent(); FreeList_t::initialize(); }
duke@435 94
duke@435 95 // For constructing a TreeList from a Tree chunk or
duke@435 96 // address and size.
jmasa@4196 97 TreeList();
jmasa@4196 98 static TreeList<Chunk_t, FreeList_t>*
jmasa@4196 99 as_TreeList(TreeChunk<Chunk_t, FreeList_t>* tc);
jmasa@4196 100 static TreeList<Chunk_t, FreeList_t>* as_TreeList(HeapWord* addr, size_t size);
duke@435 101
duke@435 102 // Returns the head of the free list as a pointer to a TreeChunk.
jmasa@4196 103 TreeChunk<Chunk_t, FreeList_t>* head_as_TreeChunk();
duke@435 104
duke@435 105 // Returns the first available chunk in the free list as a pointer
duke@435 106 // to a TreeChunk.
jmasa@4196 107 TreeChunk<Chunk_t, FreeList_t>* first_available();
duke@435 108
ysr@1580 109 // Returns the block with the largest heap address amongst
ysr@1580 110 // those in the list for this size; potentially slow and expensive,
ysr@1580 111 // use with caution!
jmasa@4196 112 TreeChunk<Chunk_t, FreeList_t>* largest_address();
jmasa@4196 113
jmasa@4196 114 TreeList<Chunk_t, FreeList_t>* get_better_list(
jmasa@4196 115 BinaryTreeDictionary<Chunk_t, FreeList_t>* dictionary);
ysr@1580 116
jmasa@3732 117 // remove_chunk_replace_if_needed() removes the given "tc" from the TreeList.
duke@435 118 // If "tc" is the first chunk in the list, it is also the
jmasa@3732 119 // TreeList that is the node in the tree. remove_chunk_replace_if_needed()
duke@435 120 // returns the possibly replaced TreeList* for the node in
duke@435 121 // the tree. It also updates the parent of the original
duke@435 122 // node to point to the new node.
jmasa@4196 123 TreeList<Chunk_t, FreeList_t>* remove_chunk_replace_if_needed(TreeChunk<Chunk_t, FreeList_t>* tc);
duke@435 124 // See FreeList.
jmasa@4196 125 void return_chunk_at_head(TreeChunk<Chunk_t, FreeList_t>* tc);
jmasa@4196 126 void return_chunk_at_tail(TreeChunk<Chunk_t, FreeList_t>* tc);
duke@435 127 };
duke@435 128
jmasa@3730 129 // A TreeChunk is a subclass of a Chunk that additionally
duke@435 130 // maintains a pointer to the free list on which it is currently
duke@435 131 // linked.
duke@435 132 // A TreeChunk is also used as a node in the binary tree. This
duke@435 133 // allows the binary tree to be maintained without any additional
duke@435 134 // storage (the free chunks are used). In a binary tree the first
duke@435 135 // chunk in the free list is also the tree node. Note that the
duke@435 136 // TreeChunk has an embedded TreeList for this purpose. Because
duke@435 137 // the first chunk in the list is distinguished in this fashion
duke@435 138 // (also is the node in the tree), it is the last chunk to be found
duke@435 139 // on the free list for a node in the tree and is only removed if
duke@435 140 // it is the last chunk on the free list.
duke@435 141
goetz@6337 142 template <class Chunk_t, class FreeList_t>
jmasa@4196 143 class TreeChunk : public Chunk_t {
jmasa@4196 144 friend class TreeList<Chunk_t, FreeList_t>;
jmasa@4196 145 TreeList<Chunk_t, FreeList_t>* _list;
jmasa@4196 146 TreeList<Chunk_t, FreeList_t> _embedded_list; // if non-null, this chunk is on _list
jmasa@4196 147
jmasa@4196 148 static size_t _min_tree_chunk_size;
jmasa@4196 149
duke@435 150 protected:
jmasa@4196 151 TreeList<Chunk_t, FreeList_t>* embedded_list() const { return (TreeList<Chunk_t, FreeList_t>*) &_embedded_list; }
jmasa@4196 152 void set_embedded_list(TreeList<Chunk_t, FreeList_t>* v) { _embedded_list = *v; }
duke@435 153 public:
jmasa@4196 154 TreeList<Chunk_t, FreeList_t>* list() { return _list; }
jmasa@4196 155 void set_list(TreeList<Chunk_t, FreeList_t>* v) { _list = v; }
jmasa@4196 156 static TreeChunk<Chunk_t, FreeList_t>* as_TreeChunk(Chunk_t* fc);
duke@435 157 // Initialize fields in a TreeChunk that should be
duke@435 158 // initialized when the TreeChunk is being added to
duke@435 159 // a free list in the tree.
duke@435 160 void initialize() { embedded_list()->initialize(); }
duke@435 161
jmasa@4196 162 Chunk_t* next() const { return Chunk_t::next(); }
jmasa@4196 163 Chunk_t* prev() const { return Chunk_t::prev(); }
jmasa@4196 164 size_t size() const volatile { return Chunk_t::size(); }
jmasa@4196 165
jmasa@4196 166 static size_t min_size() {
jmasa@4196 167 return _min_tree_chunk_size;
jmasa@4196 168 }
jmasa@3730 169
duke@435 170 // debugging
jmasa@3732 171 void verify_tree_chunk_list() const;
jmasa@4196 172 void assert_is_mangled() const;
duke@435 173 };
duke@435 174
duke@435 175
goetz@6337 176 template <class Chunk_t, class FreeList_t>
jmasa@4196 177 class BinaryTreeDictionary: public FreeBlockDictionary<Chunk_t> {
dcubed@587 178 friend class VMStructs;
jmasa@3732 179 size_t _total_size;
jmasa@3732 180 size_t _total_free_blocks;
jmasa@4196 181 TreeList<Chunk_t, FreeList_t>* _root;
duke@435 182
duke@435 183 // private accessors
jmasa@3732 184 void set_total_size(size_t v) { _total_size = v; }
jmasa@3732 185 virtual void inc_total_size(size_t v);
jmasa@3732 186 virtual void dec_total_size(size_t v);
jmasa@3732 187 void set_total_free_blocks(size_t v) { _total_free_blocks = v; }
jmasa@4196 188 TreeList<Chunk_t, FreeList_t>* root() const { return _root; }
jmasa@4196 189 void set_root(TreeList<Chunk_t, FreeList_t>* v) { _root = v; }
jmasa@3730 190
jmasa@3730 191 // This field is added and can be set to point to the
jmasa@3730 192 // the Mutex used to synchronize access to the
jmasa@3730 193 // dictionary so that assertion checking can be done.
jmasa@3730 194 // For example it is set to point to _parDictionaryAllocLock.
jmasa@3730 195 NOT_PRODUCT(Mutex* _lock;)
duke@435 196
duke@435 197 // Remove a chunk of size "size" or larger from the tree and
duke@435 198 // return it. If the chunk
duke@435 199 // is the last chunk of that size, remove the node for that size
duke@435 200 // from the tree.
jmasa@4196 201 TreeChunk<Chunk_t, FreeList_t>* get_chunk_from_tree(size_t size, enum FreeBlockDictionary<Chunk_t>::Dither dither);
jmasa@4196 202 // Remove this chunk from the tree. If the removal results
jmasa@4196 203 // in an empty list in the tree, remove the empty list.
jmasa@4196 204 TreeChunk<Chunk_t, FreeList_t>* remove_chunk_from_tree(TreeChunk<Chunk_t, FreeList_t>* tc);
jmasa@4196 205 // Remove the node in the trees starting at tl that has the
jmasa@4196 206 // minimum value and return it. Repair the tree as needed.
jmasa@4196 207 TreeList<Chunk_t, FreeList_t>* remove_tree_minimum(TreeList<Chunk_t, FreeList_t>* tl);
jmasa@4196 208 // Add this free chunk to the tree.
jmasa@4196 209 void insert_chunk_in_tree(Chunk_t* freeChunk);
jmasa@4196 210 public:
jmasa@4196 211
duke@435 212 // Return a list of the specified size or NULL from the tree.
duke@435 213 // The list is not removed from the tree.
jmasa@4196 214 TreeList<Chunk_t, FreeList_t>* find_list (size_t size) const;
jmasa@3730 215
jmasa@3732 216 void verify_tree() const;
duke@435 217 // verify that the given chunk is in the tree.
jmasa@4196 218 bool verify_chunk_in_free_list(Chunk_t* tc) const;
duke@435 219 private:
jmasa@4196 220 void verify_tree_helper(TreeList<Chunk_t, FreeList_t>* tl) const;
jmasa@4196 221 static size_t verify_prev_free_ptrs(TreeList<Chunk_t, FreeList_t>* tl);
duke@435 222
duke@435 223 // Returns the total number of chunks in the list.
jmasa@4196 224 size_t total_list_length(TreeList<Chunk_t, FreeList_t>* tl) const;
duke@435 225 // Returns the total number of words in the chunks in the tree
duke@435 226 // starting at "tl".
jmasa@4196 227 size_t total_size_in_tree(TreeList<Chunk_t, FreeList_t>* tl) const;
duke@435 228 // Returns the sum of the square of the size of each block
duke@435 229 // in the tree starting at "tl".
jmasa@4196 230 double sum_of_squared_block_sizes(TreeList<Chunk_t, FreeList_t>* const tl) const;
duke@435 231 // Returns the total number of free blocks in the tree starting
duke@435 232 // at "tl".
jmasa@4196 233 size_t total_free_blocks_in_tree(TreeList<Chunk_t, FreeList_t>* tl) const;
jmasa@4196 234 size_t num_free_blocks() const;
jmasa@4196 235 size_t tree_height() const;
jmasa@4196 236 size_t tree_height_helper(TreeList<Chunk_t, FreeList_t>* tl) const;
jmasa@4196 237 size_t total_nodes_in_tree(TreeList<Chunk_t, FreeList_t>* tl) const;
jmasa@4196 238 size_t total_nodes_helper(TreeList<Chunk_t, FreeList_t>* tl) const;
duke@435 239
duke@435 240 public:
duke@435 241 // Constructor
jmasa@4196 242 BinaryTreeDictionary() :
jmasa@4196 243 _total_size(0), _total_free_blocks(0), _root(0) {}
jmasa@4196 244
jmasa@4196 245 BinaryTreeDictionary(MemRegion mr);
jmasa@3730 246
jmasa@3730 247 // Public accessors
jmasa@3732 248 size_t total_size() const { return _total_size; }
jmasa@4196 249 size_t total_free_blocks() const { return _total_free_blocks; }
duke@435 250
duke@435 251 // Reset the dictionary to the initial conditions with
duke@435 252 // a single free chunk.
duke@435 253 void reset(MemRegion mr);
duke@435 254 void reset(HeapWord* addr, size_t size);
duke@435 255 // Reset the dictionary to be empty.
duke@435 256 void reset();
duke@435 257
duke@435 258 // Return a chunk of size "size" or greater from
duke@435 259 // the tree.
jmasa@4196 260 Chunk_t* get_chunk(size_t size, enum FreeBlockDictionary<Chunk_t>::Dither dither) {
jmasa@4196 261 FreeBlockDictionary<Chunk_t>::verify_par_locked();
jmasa@4196 262 Chunk_t* res = get_chunk_from_tree(size, dither);
jmasa@3732 263 assert(res == NULL || res->is_free(),
duke@435 264 "Should be returning a free chunk");
jmasa@4196 265 assert(dither != FreeBlockDictionary<Chunk_t>::exactly ||
jmasa@4197 266 res == NULL || res->size() == size, "Not correct size");
duke@435 267 return res;
duke@435 268 }
duke@435 269
jmasa@4196 270 void return_chunk(Chunk_t* chunk) {
jmasa@4196 271 FreeBlockDictionary<Chunk_t>::verify_par_locked();
jmasa@3732 272 insert_chunk_in_tree(chunk);
duke@435 273 }
duke@435 274
jmasa@4196 275 void remove_chunk(Chunk_t* chunk) {
jmasa@4196 276 FreeBlockDictionary<Chunk_t>::verify_par_locked();
jmasa@4196 277 remove_chunk_from_tree((TreeChunk<Chunk_t, FreeList_t>*)chunk);
jmasa@3732 278 assert(chunk->is_free(), "Should still be a free chunk");
duke@435 279 }
duke@435 280
jmasa@3732 281 size_t max_chunk_size() const;
jmasa@3732 282 size_t total_chunk_size(debug_only(const Mutex* lock)) const {
duke@435 283 debug_only(
duke@435 284 if (lock != NULL && lock->owned_by_self()) {
jmasa@3732 285 assert(total_size_in_tree(root()) == total_size(),
jmasa@3732 286 "_total_size inconsistency");
duke@435 287 }
duke@435 288 )
jmasa@3732 289 return total_size();
duke@435 290 }
duke@435 291
jmasa@3732 292 size_t min_size() const {
jmasa@4196 293 return TreeChunk<Chunk_t, FreeList_t>::min_size();
duke@435 294 }
duke@435 295
duke@435 296 double sum_of_squared_block_sizes() const {
duke@435 297 return sum_of_squared_block_sizes(root());
duke@435 298 }
duke@435 299
jmasa@4196 300 Chunk_t* find_chunk_ends_at(HeapWord* target) const;
duke@435 301
duke@435 302 // Find the list with size "size" in the binary tree and update
duke@435 303 // the statistics in the list according to "split" (chunk was
duke@435 304 // split or coalesce) and "birth" (chunk was added or removed).
jmasa@4196 305 void dict_census_update(size_t size, bool split, bool birth);
duke@435 306 // Return true if the dictionary is overpopulated (more chunks of
duke@435 307 // this size than desired) for size "size".
jmasa@3732 308 bool coal_dict_over_populated(size_t size);
duke@435 309 // Methods called at the beginning of a sweep to prepare the
duke@435 310 // statistics for the sweep.
jmasa@3732 311 void begin_sweep_dict_census(double coalSurplusPercent,
ysr@1580 312 float inter_sweep_current,
ysr@1580 313 float inter_sweep_estimate,
ysr@1580 314 float intra_sweep_estimate);
duke@435 315 // Methods called after the end of a sweep to modify the
duke@435 316 // statistics for the sweep.
jmasa@3732 317 void end_sweep_dict_census(double splitSurplusPercent);
duke@435 318 // Return the largest free chunk in the tree.
jmasa@4196 319 Chunk_t* find_largest_dict() const;
duke@435 320 // Accessors for statistics
jmasa@3732 321 void set_tree_surplus(double splitSurplusPercent);
jmasa@3732 322 void set_tree_hints(void);
duke@435 323 // Reset statistics for all the lists in the tree.
jmasa@3732 324 void clear_tree_census(void);
duke@435 325 // Print the statistcis for all the lists in the tree. Also may
duke@435 326 // print out summaries.
jmasa@3732 327 void print_dict_census(void) const;
ysr@1580 328 void print_free_lists(outputStream* st) const;
duke@435 329
jmasa@3732 330 // For debugging. Returns the sum of the _returned_bytes for
duke@435 331 // all lists in the tree.
jmasa@3732 332 size_t sum_dict_returned_bytes() PRODUCT_RETURN0;
jmasa@3732 333 // Sets the _returned_bytes for all the lists in the tree to zero.
jmasa@3732 334 void initialize_dict_returned_bytes() PRODUCT_RETURN;
duke@435 335 // For debugging. Return the total number of chunks in the dictionary.
jmasa@3732 336 size_t total_count() PRODUCT_RETURN0;
duke@435 337
jmasa@3732 338 void report_statistics() const;
duke@435 339
duke@435 340 void verify() const;
duke@435 341 };
stefank@2314 342
jmasa@3730 343 #endif // SHARE_VM_MEMORY_BINARYTREEDICTIONARY_HPP

mercurial