src/share/vm/memory/binaryTreeDictionary.hpp

Tue, 30 Oct 2012 10:23:55 -0700

author
jmasa
date
Tue, 30 Oct 2012 10:23:55 -0700
changeset 4234
3fadc0e8cffe
parent 4197
476718ea6759
child 4488
3c327c2b6782
permissions
-rw-r--r--

8000988: VM deadlock when running btree006 on windows-i586
Reviewed-by: johnc, jcoomes, ysr

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

mercurial