src/share/vm/gc_implementation/parallelScavenge/parMarkBitMap.hpp

Wed, 24 Apr 2013 20:13:37 +0200

author
stefank
date
Wed, 24 Apr 2013 20:13:37 +0200
changeset 5018
b06ac540229e
parent 4904
7b835924c31c
child 5117
4868caa99ecf
permissions
-rw-r--r--

8013132: Add a flag to turn off the output of the verbose verification code
Reviewed-by: johnc, brutisso

duke@435 1 /*
mikael@4153 2 * Copyright (c) 2005, 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
stefank@2314 25 #ifndef SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARMARKBITMAP_HPP
stefank@2314 26 #define SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARMARKBITMAP_HPP
stefank@2314 27
stefank@2325 28 #include "memory/memRegion.hpp"
stefank@2314 29 #include "gc_implementation/parallelScavenge/psVirtualspace.hpp"
stefank@2314 30 #include "utilities/bitMap.inline.hpp"
stefank@2314 31
duke@435 32 class oopDesc;
duke@435 33 class ParMarkBitMapClosure;
duke@435 34
zgu@3900 35 class ParMarkBitMap: public CHeapObj<mtGC>
duke@435 36 {
duke@435 37 public:
duke@435 38 typedef BitMap::idx_t idx_t;
duke@435 39
duke@435 40 // Values returned by the iterate() methods.
duke@435 41 enum IterationStatus { incomplete, complete, full, would_overflow };
duke@435 42
duke@435 43 inline ParMarkBitMap();
duke@435 44 inline ParMarkBitMap(MemRegion covered_region);
duke@435 45 bool initialize(MemRegion covered_region);
duke@435 46
duke@435 47 // Atomically mark an object as live.
duke@435 48 bool mark_obj(HeapWord* addr, size_t size);
duke@435 49 inline bool mark_obj(oop obj, int size);
duke@435 50 inline bool mark_obj(oop obj);
duke@435 51
duke@435 52 // Return whether the specified begin or end bit is set.
duke@435 53 inline bool is_obj_beg(idx_t bit) const;
duke@435 54 inline bool is_obj_end(idx_t bit) const;
duke@435 55
duke@435 56 // Traditional interface for testing whether an object is marked or not (these
duke@435 57 // test only the begin bits).
duke@435 58 inline bool is_marked(idx_t bit) const;
duke@435 59 inline bool is_marked(HeapWord* addr) const;
duke@435 60 inline bool is_marked(oop obj) const;
duke@435 61
duke@435 62 inline bool is_unmarked(idx_t bit) const;
duke@435 63 inline bool is_unmarked(HeapWord* addr) const;
duke@435 64 inline bool is_unmarked(oop obj) const;
duke@435 65
duke@435 66 // Convert sizes from bits to HeapWords and back. An object that is n bits
duke@435 67 // long will be bits_to_words(n) words long. An object that is m words long
duke@435 68 // will take up words_to_bits(m) bits in the bitmap.
duke@435 69 inline static size_t bits_to_words(idx_t bits);
duke@435 70 inline static idx_t words_to_bits(size_t words);
duke@435 71
duke@435 72 // Return the size in words of an object given a begin bit and an end bit, or
duke@435 73 // the equivalent beg_addr and end_addr.
duke@435 74 inline size_t obj_size(idx_t beg_bit, idx_t end_bit) const;
duke@435 75 inline size_t obj_size(HeapWord* beg_addr, HeapWord* end_addr) const;
duke@435 76
duke@435 77 // Return the size in words of the object (a search is done for the end bit).
duke@435 78 inline size_t obj_size(idx_t beg_bit) const;
duke@435 79 inline size_t obj_size(HeapWord* addr) const;
duke@435 80 inline size_t obj_size(oop obj) const;
duke@435 81
duke@435 82 // Synonyms for the above.
duke@435 83 size_t obj_size_in_words(oop obj) const { return obj_size((HeapWord*)obj); }
duke@435 84 size_t obj_size_in_words(HeapWord* addr) const { return obj_size(addr); }
duke@435 85
duke@435 86 // Apply live_closure to each live object that lies completely within the
duke@435 87 // range [live_range_beg, live_range_end). This is used to iterate over the
duke@435 88 // compacted region of the heap. Return values:
duke@435 89 //
duke@435 90 // incomplete The iteration is not complete. The last object that
duke@435 91 // begins in the range does not end in the range;
duke@435 92 // closure->source() is set to the start of that object.
duke@435 93 //
duke@435 94 // complete The iteration is complete. All objects in the range
duke@435 95 // were processed and the closure is not full;
duke@435 96 // closure->source() is set one past the end of the range.
duke@435 97 //
duke@435 98 // full The closure is full; closure->source() is set to one
duke@435 99 // past the end of the last object processed.
duke@435 100 //
duke@435 101 // would_overflow The next object in the range would overflow the closure;
duke@435 102 // closure->source() is set to the start of that object.
duke@435 103 IterationStatus iterate(ParMarkBitMapClosure* live_closure,
duke@435 104 idx_t range_beg, idx_t range_end) const;
duke@435 105 inline IterationStatus iterate(ParMarkBitMapClosure* live_closure,
duke@435 106 HeapWord* range_beg,
duke@435 107 HeapWord* range_end) const;
duke@435 108
duke@435 109 // Apply live closure as above and additionally apply dead_closure to all dead
duke@435 110 // space in the range [range_beg, dead_range_end). Note that dead_range_end
duke@435 111 // must be >= range_end. This is used to iterate over the dense prefix.
duke@435 112 //
duke@435 113 // This method assumes that if the first bit in the range (range_beg) is not
duke@435 114 // marked, then dead space begins at that point and the dead_closure is
duke@435 115 // applied. Thus callers must ensure that range_beg is not in the middle of a
duke@435 116 // live object.
duke@435 117 IterationStatus iterate(ParMarkBitMapClosure* live_closure,
duke@435 118 ParMarkBitMapClosure* dead_closure,
duke@435 119 idx_t range_beg, idx_t range_end,
duke@435 120 idx_t dead_range_end) const;
duke@435 121 inline IterationStatus iterate(ParMarkBitMapClosure* live_closure,
duke@435 122 ParMarkBitMapClosure* dead_closure,
duke@435 123 HeapWord* range_beg,
duke@435 124 HeapWord* range_end,
duke@435 125 HeapWord* dead_range_end) const;
duke@435 126
duke@435 127 // Return the number of live words in the range [beg_addr, end_addr) due to
duke@435 128 // objects that start in the range. If a live object extends onto the range,
duke@435 129 // the caller must detect and account for any live words due to that object.
duke@435 130 // If a live object extends beyond the end of the range, only the words within
duke@435 131 // the range are included in the result.
duke@435 132 size_t live_words_in_range(HeapWord* beg_addr, HeapWord* end_addr) const;
duke@435 133
duke@435 134 // Same as the above, except the end of the range must be a live object, which
duke@435 135 // is the case when updating pointers. This allows a branch to be removed
duke@435 136 // from inside the loop.
duke@435 137 size_t live_words_in_range(HeapWord* beg_addr, oop end_obj) const;
duke@435 138
duke@435 139 inline HeapWord* region_start() const;
duke@435 140 inline HeapWord* region_end() const;
duke@435 141 inline size_t region_size() const;
duke@435 142 inline size_t size() const;
duke@435 143
duke@435 144 // Convert a heap address to/from a bit index.
duke@435 145 inline idx_t addr_to_bit(HeapWord* addr) const;
duke@435 146 inline HeapWord* bit_to_addr(idx_t bit) const;
duke@435 147
duke@435 148 // Return the bit index of the first marked object that begins (or ends,
duke@435 149 // respectively) in the range [beg, end). If no object is found, return end.
duke@435 150 inline idx_t find_obj_beg(idx_t beg, idx_t end) const;
duke@435 151 inline idx_t find_obj_end(idx_t beg, idx_t end) const;
duke@435 152
duke@435 153 inline HeapWord* find_obj_beg(HeapWord* beg, HeapWord* end) const;
duke@435 154 inline HeapWord* find_obj_end(HeapWord* beg, HeapWord* end) const;
duke@435 155
duke@435 156 // Clear a range of bits or the entire bitmap (both begin and end bits are
duke@435 157 // cleared).
duke@435 158 inline void clear_range(idx_t beg, idx_t end);
duke@435 159 inline void clear() { clear_range(0, size()); }
duke@435 160
duke@435 161 // Return the number of bits required to represent the specified number of
duke@435 162 // HeapWords, or the specified region.
duke@435 163 static inline idx_t bits_required(size_t words);
duke@435 164 static inline idx_t bits_required(MemRegion covered_region);
duke@435 165 static inline idx_t words_required(MemRegion covered_region);
duke@435 166
duke@435 167 #ifndef PRODUCT
duke@435 168 // CAS statistics.
duke@435 169 size_t cas_tries() { return _cas_tries; }
duke@435 170 size_t cas_retries() { return _cas_retries; }
duke@435 171 size_t cas_by_another() { return _cas_by_another; }
duke@435 172
duke@435 173 void reset_counters();
duke@435 174 #endif // #ifndef PRODUCT
duke@435 175
stefank@4904 176 void print_on_error(outputStream* st) const {
stefank@4904 177 st->print_cr("Marking Bits: (ParMarkBitMap*) " PTR_FORMAT, this);
stefank@4904 178 _beg_bits.print_on_error(st, " Begin Bits: ");
stefank@4904 179 _end_bits.print_on_error(st, " End Bits: ");
stefank@4904 180 }
stefank@4904 181
duke@435 182 #ifdef ASSERT
duke@435 183 void verify_clear() const;
duke@435 184 inline void verify_bit(idx_t bit) const;
duke@435 185 inline void verify_addr(HeapWord* addr) const;
duke@435 186 #endif // #ifdef ASSERT
duke@435 187
duke@435 188 private:
duke@435 189 // Each bit in the bitmap represents one unit of 'object granularity.' Objects
duke@435 190 // are double-word aligned in 32-bit VMs, but not in 64-bit VMs, so the 32-bit
duke@435 191 // granularity is 2, 64-bit is 1.
duke@435 192 static inline size_t obj_granularity() { return size_t(MinObjAlignment); }
jcoomes@1243 193 static inline int obj_granularity_shift() { return LogMinObjAlignment; }
duke@435 194
duke@435 195 HeapWord* _region_start;
duke@435 196 size_t _region_size;
duke@435 197 BitMap _beg_bits;
duke@435 198 BitMap _end_bits;
duke@435 199 PSVirtualSpace* _virtual_space;
duke@435 200
duke@435 201 #ifndef PRODUCT
duke@435 202 size_t _cas_tries;
duke@435 203 size_t _cas_retries;
duke@435 204 size_t _cas_by_another;
duke@435 205 #endif // #ifndef PRODUCT
duke@435 206 };
duke@435 207
duke@435 208 inline ParMarkBitMap::ParMarkBitMap():
ysr@777 209 _beg_bits(),
ysr@777 210 _end_bits()
duke@435 211 {
duke@435 212 _region_start = 0;
duke@435 213 _virtual_space = 0;
duke@435 214 }
duke@435 215
duke@435 216 inline ParMarkBitMap::ParMarkBitMap(MemRegion covered_region):
ysr@777 217 _beg_bits(),
ysr@777 218 _end_bits()
duke@435 219 {
duke@435 220 initialize(covered_region);
duke@435 221 }
duke@435 222
duke@435 223 inline void ParMarkBitMap::clear_range(idx_t beg, idx_t end)
duke@435 224 {
duke@435 225 _beg_bits.clear_range(beg, end);
duke@435 226 _end_bits.clear_range(beg, end);
duke@435 227 }
duke@435 228
duke@435 229 inline ParMarkBitMap::idx_t
duke@435 230 ParMarkBitMap::bits_required(size_t words)
duke@435 231 {
duke@435 232 // Need two bits (one begin bit, one end bit) for each unit of 'object
duke@435 233 // granularity' in the heap.
duke@435 234 return words_to_bits(words * 2);
duke@435 235 }
duke@435 236
duke@435 237 inline ParMarkBitMap::idx_t
duke@435 238 ParMarkBitMap::bits_required(MemRegion covered_region)
duke@435 239 {
duke@435 240 return bits_required(covered_region.word_size());
duke@435 241 }
duke@435 242
duke@435 243 inline ParMarkBitMap::idx_t
duke@435 244 ParMarkBitMap::words_required(MemRegion covered_region)
duke@435 245 {
duke@435 246 return bits_required(covered_region) / BitsPerWord;
duke@435 247 }
duke@435 248
duke@435 249 inline HeapWord*
duke@435 250 ParMarkBitMap::region_start() const
duke@435 251 {
duke@435 252 return _region_start;
duke@435 253 }
duke@435 254
duke@435 255 inline HeapWord*
duke@435 256 ParMarkBitMap::region_end() const
duke@435 257 {
duke@435 258 return region_start() + region_size();
duke@435 259 }
duke@435 260
duke@435 261 inline size_t
duke@435 262 ParMarkBitMap::region_size() const
duke@435 263 {
duke@435 264 return _region_size;
duke@435 265 }
duke@435 266
duke@435 267 inline size_t
duke@435 268 ParMarkBitMap::size() const
duke@435 269 {
duke@435 270 return _beg_bits.size();
duke@435 271 }
duke@435 272
duke@435 273 inline bool ParMarkBitMap::is_obj_beg(idx_t bit) const
duke@435 274 {
duke@435 275 return _beg_bits.at(bit);
duke@435 276 }
duke@435 277
duke@435 278 inline bool ParMarkBitMap::is_obj_end(idx_t bit) const
duke@435 279 {
duke@435 280 return _end_bits.at(bit);
duke@435 281 }
duke@435 282
duke@435 283 inline bool ParMarkBitMap::is_marked(idx_t bit) const
duke@435 284 {
duke@435 285 return is_obj_beg(bit);
duke@435 286 }
duke@435 287
duke@435 288 inline bool ParMarkBitMap::is_marked(HeapWord* addr) const
duke@435 289 {
duke@435 290 return is_marked(addr_to_bit(addr));
duke@435 291 }
duke@435 292
duke@435 293 inline bool ParMarkBitMap::is_marked(oop obj) const
duke@435 294 {
duke@435 295 return is_marked((HeapWord*)obj);
duke@435 296 }
duke@435 297
duke@435 298 inline bool ParMarkBitMap::is_unmarked(idx_t bit) const
duke@435 299 {
duke@435 300 return !is_marked(bit);
duke@435 301 }
duke@435 302
duke@435 303 inline bool ParMarkBitMap::is_unmarked(HeapWord* addr) const
duke@435 304 {
duke@435 305 return !is_marked(addr);
duke@435 306 }
duke@435 307
duke@435 308 inline bool ParMarkBitMap::is_unmarked(oop obj) const
duke@435 309 {
duke@435 310 return !is_marked(obj);
duke@435 311 }
duke@435 312
duke@435 313 inline size_t
duke@435 314 ParMarkBitMap::bits_to_words(idx_t bits)
duke@435 315 {
jcoomes@1243 316 return bits << obj_granularity_shift();
duke@435 317 }
duke@435 318
duke@435 319 inline ParMarkBitMap::idx_t
duke@435 320 ParMarkBitMap::words_to_bits(size_t words)
duke@435 321 {
jcoomes@1243 322 return words >> obj_granularity_shift();
duke@435 323 }
duke@435 324
duke@435 325 inline size_t ParMarkBitMap::obj_size(idx_t beg_bit, idx_t end_bit) const
duke@435 326 {
duke@435 327 DEBUG_ONLY(verify_bit(beg_bit);)
duke@435 328 DEBUG_ONLY(verify_bit(end_bit);)
duke@435 329 return bits_to_words(end_bit - beg_bit + 1);
duke@435 330 }
duke@435 331
duke@435 332 inline size_t
duke@435 333 ParMarkBitMap::obj_size(HeapWord* beg_addr, HeapWord* end_addr) const
duke@435 334 {
duke@435 335 DEBUG_ONLY(verify_addr(beg_addr);)
duke@435 336 DEBUG_ONLY(verify_addr(end_addr);)
duke@435 337 return pointer_delta(end_addr, beg_addr) + obj_granularity();
duke@435 338 }
duke@435 339
duke@435 340 inline size_t ParMarkBitMap::obj_size(idx_t beg_bit) const
duke@435 341 {
ysr@777 342 const idx_t end_bit = _end_bits.get_next_one_offset_inline(beg_bit, size());
duke@435 343 assert(is_marked(beg_bit), "obj not marked");
duke@435 344 assert(end_bit < size(), "end bit missing");
duke@435 345 return obj_size(beg_bit, end_bit);
duke@435 346 }
duke@435 347
duke@435 348 inline size_t ParMarkBitMap::obj_size(HeapWord* addr) const
duke@435 349 {
duke@435 350 return obj_size(addr_to_bit(addr));
duke@435 351 }
duke@435 352
duke@435 353 inline size_t ParMarkBitMap::obj_size(oop obj) const
duke@435 354 {
duke@435 355 return obj_size((HeapWord*)obj);
duke@435 356 }
duke@435 357
duke@435 358 inline ParMarkBitMap::IterationStatus
duke@435 359 ParMarkBitMap::iterate(ParMarkBitMapClosure* live_closure,
duke@435 360 HeapWord* range_beg,
duke@435 361 HeapWord* range_end) const
duke@435 362 {
duke@435 363 return iterate(live_closure, addr_to_bit(range_beg), addr_to_bit(range_end));
duke@435 364 }
duke@435 365
duke@435 366 inline ParMarkBitMap::IterationStatus
duke@435 367 ParMarkBitMap::iterate(ParMarkBitMapClosure* live_closure,
duke@435 368 ParMarkBitMapClosure* dead_closure,
duke@435 369 HeapWord* range_beg,
duke@435 370 HeapWord* range_end,
duke@435 371 HeapWord* dead_range_end) const
duke@435 372 {
duke@435 373 return iterate(live_closure, dead_closure,
duke@435 374 addr_to_bit(range_beg), addr_to_bit(range_end),
duke@435 375 addr_to_bit(dead_range_end));
duke@435 376 }
duke@435 377
duke@435 378 inline bool
duke@435 379 ParMarkBitMap::mark_obj(oop obj, int size)
duke@435 380 {
duke@435 381 return mark_obj((HeapWord*)obj, (size_t)size);
duke@435 382 }
duke@435 383
duke@435 384 inline BitMap::idx_t
duke@435 385 ParMarkBitMap::addr_to_bit(HeapWord* addr) const
duke@435 386 {
duke@435 387 DEBUG_ONLY(verify_addr(addr);)
duke@435 388 return words_to_bits(pointer_delta(addr, region_start()));
duke@435 389 }
duke@435 390
duke@435 391 inline HeapWord*
duke@435 392 ParMarkBitMap::bit_to_addr(idx_t bit) const
duke@435 393 {
duke@435 394 DEBUG_ONLY(verify_bit(bit);)
duke@435 395 return region_start() + bits_to_words(bit);
duke@435 396 }
duke@435 397
duke@435 398 inline ParMarkBitMap::idx_t
duke@435 399 ParMarkBitMap::find_obj_beg(idx_t beg, idx_t end) const
duke@435 400 {
ysr@777 401 return _beg_bits.get_next_one_offset_inline_aligned_right(beg, end);
duke@435 402 }
duke@435 403
duke@435 404 inline ParMarkBitMap::idx_t
duke@435 405 ParMarkBitMap::find_obj_end(idx_t beg, idx_t end) const
duke@435 406 {
ysr@777 407 return _end_bits.get_next_one_offset_inline_aligned_right(beg, end);
duke@435 408 }
duke@435 409
duke@435 410 inline HeapWord*
duke@435 411 ParMarkBitMap::find_obj_beg(HeapWord* beg, HeapWord* end) const
duke@435 412 {
duke@435 413 const idx_t beg_bit = addr_to_bit(beg);
duke@435 414 const idx_t end_bit = addr_to_bit(end);
duke@435 415 const idx_t search_end = BitMap::word_align_up(end_bit);
duke@435 416 const idx_t res_bit = MIN2(find_obj_beg(beg_bit, search_end), end_bit);
duke@435 417 return bit_to_addr(res_bit);
duke@435 418 }
duke@435 419
duke@435 420 inline HeapWord*
duke@435 421 ParMarkBitMap::find_obj_end(HeapWord* beg, HeapWord* end) const
duke@435 422 {
duke@435 423 const idx_t beg_bit = addr_to_bit(beg);
duke@435 424 const idx_t end_bit = addr_to_bit(end);
duke@435 425 const idx_t search_end = BitMap::word_align_up(end_bit);
duke@435 426 const idx_t res_bit = MIN2(find_obj_end(beg_bit, search_end), end_bit);
duke@435 427 return bit_to_addr(res_bit);
duke@435 428 }
duke@435 429
duke@435 430 #ifdef ASSERT
duke@435 431 inline void ParMarkBitMap::verify_bit(idx_t bit) const {
duke@435 432 // Allow one past the last valid bit; useful for loop bounds.
duke@435 433 assert(bit <= _beg_bits.size(), "bit out of range");
duke@435 434 }
duke@435 435
duke@435 436 inline void ParMarkBitMap::verify_addr(HeapWord* addr) const {
duke@435 437 // Allow one past the last valid address; useful for loop bounds.
duke@435 438 assert(addr >= region_start(), "addr too small");
duke@435 439 assert(addr <= region_start() + region_size(), "addr too big");
duke@435 440 }
duke@435 441 #endif // #ifdef ASSERT
stefank@2314 442
stefank@2314 443 #endif // SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARMARKBITMAP_HPP

mercurial