src/share/vm/gc_implementation/concurrentMarkSweep/binaryTreeDictionary.hpp

Wed, 02 Jul 2008 12:55:16 -0700

author
xdono
date
Wed, 02 Jul 2008 12:55:16 -0700
changeset 631
d1605aabd0a1
parent 587
c70a245cad3a
child 1580
e018e6884bd8
permissions
-rw-r--r--

6719955: Update copyright year
Summary: Update copyright year for files that have been modified in 2008
Reviewed-by: ohair, tbell

duke@435 1 /*
xdono@631 2 * Copyright 2001-2008 Sun Microsystems, Inc. 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 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 /*
duke@435 26 * A binary tree based search structure for free blocks.
duke@435 27 * This is currently used in the Concurrent Mark&Sweep implementation.
duke@435 28 */
duke@435 29
duke@435 30 // A TreeList is a FreeList which can be used to maintain a
duke@435 31 // binary tree of free lists.
duke@435 32
duke@435 33 class TreeChunk;
duke@435 34 class BinaryTreeDictionary;
duke@435 35 class AscendTreeCensusClosure;
duke@435 36 class DescendTreeCensusClosure;
duke@435 37 class DescendTreeSearchClosure;
duke@435 38
duke@435 39 class TreeList: public FreeList {
duke@435 40 friend class TreeChunk;
duke@435 41 friend class BinaryTreeDictionary;
duke@435 42 friend class AscendTreeCensusClosure;
duke@435 43 friend class DescendTreeCensusClosure;
duke@435 44 friend class DescendTreeSearchClosure;
duke@435 45 TreeList* _parent;
duke@435 46 TreeList* _left;
duke@435 47 TreeList* _right;
duke@435 48
duke@435 49 protected:
duke@435 50 TreeList* parent() const { return _parent; }
duke@435 51 TreeList* left() const { return _left; }
duke@435 52 TreeList* right() const { return _right; }
duke@435 53
duke@435 54 // Accessors for links in tree.
duke@435 55
duke@435 56 void setLeft(TreeList* tl) {
duke@435 57 _left = tl;
duke@435 58 if (tl != NULL)
duke@435 59 tl->setParent(this);
duke@435 60 }
duke@435 61 void setRight(TreeList* tl) {
duke@435 62 _right = tl;
duke@435 63 if (tl != NULL)
duke@435 64 tl->setParent(this);
duke@435 65 }
duke@435 66 void setParent(TreeList* tl) { _parent = tl; }
duke@435 67
duke@435 68 void clearLeft() { _left = NULL; }
duke@435 69 void clearRight() { _right = NULL; }
duke@435 70 void clearParent() { _parent = NULL; }
duke@435 71 void initialize() { clearLeft(); clearRight(), clearParent(); }
duke@435 72
duke@435 73 // For constructing a TreeList from a Tree chunk or
duke@435 74 // address and size.
duke@435 75 static TreeList* as_TreeList(TreeChunk* tc);
duke@435 76 static TreeList* as_TreeList(HeapWord* addr, size_t size);
duke@435 77
duke@435 78 // Returns the head of the free list as a pointer to a TreeChunk.
duke@435 79 TreeChunk* head_as_TreeChunk();
duke@435 80
duke@435 81 // Returns the first available chunk in the free list as a pointer
duke@435 82 // to a TreeChunk.
duke@435 83 TreeChunk* first_available();
duke@435 84
duke@435 85 // removeChunkReplaceIfNeeded() removes the given "tc" from the TreeList.
duke@435 86 // If "tc" is the first chunk in the list, it is also the
duke@435 87 // TreeList that is the node in the tree. removeChunkReplaceIfNeeded()
duke@435 88 // returns the possibly replaced TreeList* for the node in
duke@435 89 // the tree. It also updates the parent of the original
duke@435 90 // node to point to the new node.
duke@435 91 TreeList* removeChunkReplaceIfNeeded(TreeChunk* tc);
duke@435 92 // See FreeList.
duke@435 93 void returnChunkAtHead(TreeChunk* tc);
duke@435 94 void returnChunkAtTail(TreeChunk* tc);
duke@435 95 };
duke@435 96
duke@435 97 // A TreeChunk is a subclass of a FreeChunk that additionally
duke@435 98 // maintains a pointer to the free list on which it is currently
duke@435 99 // linked.
duke@435 100 // A TreeChunk is also used as a node in the binary tree. This
duke@435 101 // allows the binary tree to be maintained without any additional
duke@435 102 // storage (the free chunks are used). In a binary tree the first
duke@435 103 // chunk in the free list is also the tree node. Note that the
duke@435 104 // TreeChunk has an embedded TreeList for this purpose. Because
duke@435 105 // the first chunk in the list is distinguished in this fashion
duke@435 106 // (also is the node in the tree), it is the last chunk to be found
duke@435 107 // on the free list for a node in the tree and is only removed if
duke@435 108 // it is the last chunk on the free list.
duke@435 109
duke@435 110 class TreeChunk : public FreeChunk {
duke@435 111 friend class TreeList;
duke@435 112 TreeList* _list;
duke@435 113 TreeList _embedded_list; // if non-null, this chunk is on _list
duke@435 114 protected:
duke@435 115 TreeList* embedded_list() const { return (TreeList*) &_embedded_list; }
duke@435 116 void set_embedded_list(TreeList* v) { _embedded_list = *v; }
duke@435 117 public:
duke@435 118 TreeList* list() { return _list; }
duke@435 119 void set_list(TreeList* v) { _list = v; }
duke@435 120 static TreeChunk* as_TreeChunk(FreeChunk* fc);
duke@435 121 // Initialize fields in a TreeChunk that should be
duke@435 122 // initialized when the TreeChunk is being added to
duke@435 123 // a free list in the tree.
duke@435 124 void initialize() { embedded_list()->initialize(); }
duke@435 125
duke@435 126 // debugging
duke@435 127 void verifyTreeChunkList() const;
duke@435 128 };
duke@435 129
duke@435 130 const size_t MIN_TREE_CHUNK_SIZE = sizeof(TreeChunk)/HeapWordSize;
duke@435 131
duke@435 132 class BinaryTreeDictionary: public FreeBlockDictionary {
dcubed@587 133 friend class VMStructs;
duke@435 134 bool _splay;
duke@435 135 size_t _totalSize;
duke@435 136 size_t _totalFreeBlocks;
duke@435 137 TreeList* _root;
duke@435 138
duke@435 139 // private accessors
duke@435 140 bool splay() const { return _splay; }
duke@435 141 void set_splay(bool v) { _splay = v; }
duke@435 142 size_t totalSize() const { return _totalSize; }
duke@435 143 void set_totalSize(size_t v) { _totalSize = v; }
duke@435 144 virtual void inc_totalSize(size_t v);
duke@435 145 virtual void dec_totalSize(size_t v);
duke@435 146 size_t totalFreeBlocks() const { return _totalFreeBlocks; }
duke@435 147 void set_totalFreeBlocks(size_t v) { _totalFreeBlocks = v; }
duke@435 148 TreeList* root() const { return _root; }
duke@435 149 void set_root(TreeList* v) { _root = v; }
duke@435 150
duke@435 151 // Remove a chunk of size "size" or larger from the tree and
duke@435 152 // return it. If the chunk
duke@435 153 // is the last chunk of that size, remove the node for that size
duke@435 154 // from the tree.
duke@435 155 TreeChunk* getChunkFromTree(size_t size, Dither dither, bool splay);
duke@435 156 // Return a list of the specified size or NULL from the tree.
duke@435 157 // The list is not removed from the tree.
duke@435 158 TreeList* findList (size_t size) const;
duke@435 159 // Remove this chunk from the tree. If the removal results
duke@435 160 // in an empty list in the tree, remove the empty list.
duke@435 161 TreeChunk* removeChunkFromTree(TreeChunk* tc);
duke@435 162 // Remove the node in the trees starting at tl that has the
duke@435 163 // minimum value and return it. Repair the tree as needed.
duke@435 164 TreeList* removeTreeMinimum(TreeList* tl);
duke@435 165 void semiSplayStep(TreeList* tl);
duke@435 166 // Add this free chunk to the tree.
duke@435 167 void insertChunkInTree(FreeChunk* freeChunk);
duke@435 168 public:
duke@435 169 void verifyTree() const;
duke@435 170 // verify that the given chunk is in the tree.
duke@435 171 bool verifyChunkInFreeLists(FreeChunk* tc) const;
duke@435 172 private:
duke@435 173 void verifyTreeHelper(TreeList* tl) const;
duke@435 174 static size_t verifyPrevFreePtrs(TreeList* tl);
duke@435 175
duke@435 176 // Returns the total number of chunks in the list.
duke@435 177 size_t totalListLength(TreeList* tl) const;
duke@435 178 // Returns the total number of words in the chunks in the tree
duke@435 179 // starting at "tl".
duke@435 180 size_t totalSizeInTree(TreeList* tl) const;
duke@435 181 // Returns the sum of the square of the size of each block
duke@435 182 // in the tree starting at "tl".
duke@435 183 double sum_of_squared_block_sizes(TreeList* const tl) const;
duke@435 184 // Returns the total number of free blocks in the tree starting
duke@435 185 // at "tl".
duke@435 186 size_t totalFreeBlocksInTree(TreeList* tl) const;
duke@435 187 size_t numFreeBlocks() const;
duke@435 188 size_t treeHeight() const;
duke@435 189 size_t treeHeightHelper(TreeList* tl) const;
duke@435 190 size_t totalNodesInTree(TreeList* tl) const;
duke@435 191 size_t totalNodesHelper(TreeList* tl) const;
duke@435 192
duke@435 193 public:
duke@435 194 // Constructor
duke@435 195 BinaryTreeDictionary(MemRegion mr, bool splay = false);
duke@435 196
duke@435 197 // Reset the dictionary to the initial conditions with
duke@435 198 // a single free chunk.
duke@435 199 void reset(MemRegion mr);
duke@435 200 void reset(HeapWord* addr, size_t size);
duke@435 201 // Reset the dictionary to be empty.
duke@435 202 void reset();
duke@435 203
duke@435 204 // Return a chunk of size "size" or greater from
duke@435 205 // the tree.
duke@435 206 // want a better dynamic splay strategy for the future.
duke@435 207 FreeChunk* getChunk(size_t size, Dither dither) {
duke@435 208 verify_par_locked();
duke@435 209 FreeChunk* res = getChunkFromTree(size, dither, splay());
duke@435 210 assert(res == NULL || res->isFree(),
duke@435 211 "Should be returning a free chunk");
duke@435 212 return res;
duke@435 213 }
duke@435 214
duke@435 215 void returnChunk(FreeChunk* chunk) {
duke@435 216 verify_par_locked();
duke@435 217 insertChunkInTree(chunk);
duke@435 218 }
duke@435 219
duke@435 220 void removeChunk(FreeChunk* chunk) {
duke@435 221 verify_par_locked();
duke@435 222 removeChunkFromTree((TreeChunk*)chunk);
duke@435 223 assert(chunk->isFree(), "Should still be a free chunk");
duke@435 224 }
duke@435 225
duke@435 226 size_t maxChunkSize() const;
duke@435 227 size_t totalChunkSize(debug_only(const Mutex* lock)) const {
duke@435 228 debug_only(
duke@435 229 if (lock != NULL && lock->owned_by_self()) {
duke@435 230 assert(totalSizeInTree(root()) == totalSize(),
duke@435 231 "_totalSize inconsistency");
duke@435 232 }
duke@435 233 )
duke@435 234 return totalSize();
duke@435 235 }
duke@435 236
duke@435 237 size_t minSize() const {
duke@435 238 return MIN_TREE_CHUNK_SIZE;
duke@435 239 }
duke@435 240
duke@435 241 double sum_of_squared_block_sizes() const {
duke@435 242 return sum_of_squared_block_sizes(root());
duke@435 243 }
duke@435 244
duke@435 245 FreeChunk* find_chunk_ends_at(HeapWord* target) const;
duke@435 246
duke@435 247 // Find the list with size "size" in the binary tree and update
duke@435 248 // the statistics in the list according to "split" (chunk was
duke@435 249 // split or coalesce) and "birth" (chunk was added or removed).
duke@435 250 void dictCensusUpdate(size_t size, bool split, bool birth);
duke@435 251 // Return true if the dictionary is overpopulated (more chunks of
duke@435 252 // this size than desired) for size "size".
duke@435 253 bool coalDictOverPopulated(size_t size);
duke@435 254 // Methods called at the beginning of a sweep to prepare the
duke@435 255 // statistics for the sweep.
duke@435 256 void beginSweepDictCensus(double coalSurplusPercent,
duke@435 257 float sweep_current,
duke@435 258 float sweep_estimate);
duke@435 259 // Methods called after the end of a sweep to modify the
duke@435 260 // statistics for the sweep.
duke@435 261 void endSweepDictCensus(double splitSurplusPercent);
duke@435 262 // Return the largest free chunk in the tree.
duke@435 263 FreeChunk* findLargestDict() const;
duke@435 264 // Accessors for statistics
duke@435 265 void setTreeSurplus(double splitSurplusPercent);
duke@435 266 void setTreeHints(void);
duke@435 267 // Reset statistics for all the lists in the tree.
duke@435 268 void clearTreeCensus(void);
duke@435 269 // Print the statistcis for all the lists in the tree. Also may
duke@435 270 // print out summaries.
duke@435 271 void printDictCensus(void) const;
duke@435 272
duke@435 273 // For debugging. Returns the sum of the _returnedBytes for
duke@435 274 // all lists in the tree.
duke@435 275 size_t sumDictReturnedBytes() PRODUCT_RETURN0;
duke@435 276 // Sets the _returnedBytes for all the lists in the tree to zero.
duke@435 277 void initializeDictReturnedBytes() PRODUCT_RETURN;
duke@435 278 // For debugging. Return the total number of chunks in the dictionary.
duke@435 279 size_t totalCount() PRODUCT_RETURN0;
duke@435 280
duke@435 281 void reportStatistics() const;
duke@435 282
duke@435 283 void verify() const;
duke@435 284 };

mercurial