1 /*
   2  * Copyright (c) 2001, 2014, 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 #include "precompiled.hpp"
  26 #include "gc_implementation/g1/heapRegion.hpp"
  27 #include "gc_implementation/g1/heapRegionSeq.inline.hpp"
  28 #include "gc_implementation/g1/heapRegionSet.inline.hpp"
  29 #include "gc_implementation/g1/g1CollectedHeap.inline.hpp"
  30 #include "gc_implementation/g1/concurrentG1Refine.hpp"
  31 #include "memory/allocation.hpp"
  32 
  33 void HeapRegionSeq::initialize(G1RegionToSpaceMapper* heap_storage,
  34                                G1RegionToSpaceMapper* prev_bitmap,
  35                                G1RegionToSpaceMapper* next_bitmap,
  36                                G1RegionToSpaceMapper* bot,
  37                                G1RegionToSpaceMapper* cardtable,
  38                                G1RegionToSpaceMapper* card_counts) {
  39   _allocated_heapregions_length = 0;
  40 
  41   _heap_mapper = heap_storage;
  42 
  43   _prev_bitmap_mapper = prev_bitmap;
  44   _next_bitmap_mapper = next_bitmap;
  45 
  46   _bot_mapper = bot;
  47   _cardtable_mapper = cardtable;
  48 
  49   _card_counts_mapper = card_counts;
  50 
  51   MemRegion reserved = heap_storage->reserved();
  52   _regions.initialize(reserved.start(), reserved.end(), HeapRegion::GrainBytes);
  53 
  54   _available_map.resize(_regions.length(), false);
  55   _available_map.clear();
  56 }
  57 
  58 bool HeapRegionSeq::is_available(uint region) const {
  59   return _available_map.at(region);
  60 }
  61 
  62 #ifdef ASSERT
  63 bool HeapRegionSeq::is_free(HeapRegion* hr) const {
  64   return _free_list.contains(hr);
  65 }
  66 #endif
  67 
  68 HeapRegion* HeapRegionSeq::new_heap_region(uint hrs_index) {
  69   HeapWord* bottom = G1CollectedHeap::heap()->bottom_addr_for_region(hrs_index);
  70   MemRegion mr(bottom, bottom + HeapRegion::GrainWords);
  71   assert(reserved().contains(mr), "invariant");
  72   return new HeapRegion(hrs_index, G1CollectedHeap::heap()->bot_shared(), mr);
  73 }
  74 
  75 void HeapRegionSeq::commit_regions(uint index, size_t num_regions) {
  76   guarantee(num_regions > 0, "Must commit more than zero regions");
  77   guarantee(_num_committed + num_regions <= max_length(), "Cannot commit more than the maximum amount of regions");
  78 
  79   _num_committed += (uint)num_regions;
  80 
  81   _heap_mapper->commit_regions(index, num_regions);
  82 
  83   // Also commit auxiliary data
  84   _prev_bitmap_mapper->commit_regions(index, num_regions);
  85   _next_bitmap_mapper->commit_regions(index, num_regions);
  86 
  87   _bot_mapper->commit_regions(index, num_regions);
  88   _cardtable_mapper->commit_regions(index, num_regions);
  89 
  90   _card_counts_mapper->commit_regions(index, num_regions);
  91 }
  92 
  93 void HeapRegionSeq::uncommit_regions(uint start, size_t num_regions) {
  94   guarantee(num_regions >= 1, err_msg("Need to specify at least one region to uncommit, tried to uncommit zero regions at %u", start));
  95   guarantee(_num_committed >= num_regions, "pre-condition");
  96 
  97   // Print before uncommitting.
  98   if (G1CollectedHeap::heap()->hr_printer()->is_active()) {
  99     for (uint i = start; i < start + num_regions; i++) {
 100       HeapRegion* hr = at(i);
 101       G1CollectedHeap::heap()->hr_printer()->uncommit(hr->bottom(), hr->end());
 102     }
 103   }
 104 
 105   _num_committed -= (uint)num_regions;
 106 
 107   _available_map.par_clear_range(start, start + num_regions, BitMap::unknown_range);
 108   _heap_mapper->uncommit_regions(start, num_regions);
 109 
 110   // Also uncommit auxiliary data
 111   _prev_bitmap_mapper->uncommit_regions(start, num_regions);
 112   _next_bitmap_mapper->uncommit_regions(start, num_regions);
 113 
 114   _bot_mapper->uncommit_regions(start, num_regions);
 115   _cardtable_mapper->uncommit_regions(start, num_regions);
 116 
 117   _card_counts_mapper->uncommit_regions(start, num_regions);
 118 }
 119 
 120 void HeapRegionSeq::make_regions_available(uint start, uint num_regions) {
 121   guarantee(num_regions > 0, "No point in calling this for zero regions");
 122   commit_regions(start, num_regions);
 123   for (uint i = start; i < start + num_regions; i++) {
 124     if (_regions.get_by_index(i) == NULL) {
 125       HeapRegion* new_hr = new_heap_region(i);
 126       _regions.set_by_index(i, new_hr);
 127       _allocated_heapregions_length = MAX2(_allocated_heapregions_length, i + 1);
 128     }
 129   }
 130 
 131   _available_map.par_set_range(start, start + num_regions, BitMap::unknown_range);
 132 
 133   for (uint i = start; i < start + num_regions; i++) {
 134     assert(is_available(i), err_msg("Just made region %u available but is apparently not.", i));
 135     HeapRegion* hr = at(i);
 136     if (G1CollectedHeap::heap()->hr_printer()->is_active()) {
 137       G1CollectedHeap::heap()->hr_printer()->commit(hr->bottom(), hr->end());
 138     }
 139     HeapWord* bottom = G1CollectedHeap::heap()->bottom_addr_for_region(i);
 140     MemRegion mr(bottom, bottom + HeapRegion::GrainWords);
 141 
 142     hr->initialize(mr);
 143     insert_into_free_list(at(i));
 144   }
 145 }
 146 
 147 uint HeapRegionSeq::expand_by(uint num_regions) {
 148   return expand_at(0, num_regions);
 149 }
 150 
 151 uint HeapRegionSeq::expand_at(uint start, uint num_regions) {
 152   if (num_regions == 0) {
 153     return 0;
 154   }
 155 
 156   uint cur = start;
 157   uint idx_last_found = 0;
 158   uint num_last_found = 0;
 159 
 160   uint expanded = 0;
 161 
 162   while (expanded < num_regions &&
 163          (num_last_found = find_unavailable_from_idx(cur, &idx_last_found)) > 0) {
 164     uint to_expand = MIN2(num_regions - expanded, num_last_found);
 165     make_regions_available(idx_last_found, to_expand);
 166     expanded += to_expand;
 167     cur = idx_last_found + num_last_found + 1;
 168   }
 169 
 170   verify_optional();
 171   return expanded;
 172 }
 173 
 174 uint HeapRegionSeq::find_contiguous(size_t num, bool empty_only) {
 175   uint found = 0;
 176   size_t length_found = 0;
 177   uint cur = 0;
 178 
 179   while (length_found < num && cur < max_length()) {
 180     HeapRegion* hr = _regions.get_by_index(cur);
 181     if ((!empty_only && !is_available(cur)) || (is_available(cur) && hr != NULL && hr->is_empty())) {
 182       // This region is a potential candidate for allocation into.
 183       length_found++;
 184     } else {
 185       // This region is not a candidate. The next region is the next possible one.
 186       found = cur + 1;
 187       length_found = 0;
 188     }
 189     cur++;
 190   }
 191 
 192   if (length_found == num) {
 193     for (uint i = found; i < (found + num); i++) {
 194       HeapRegion* hr = _regions.get_by_index(i);
 195       // sanity check
 196       guarantee((!empty_only && !is_available(i)) || (is_available(i) && hr != NULL && hr->is_empty()),
 197                 err_msg("Found region sequence starting at " UINT32_FORMAT ", length " SIZE_FORMAT
 198                         " that is not empty at " UINT32_FORMAT ". Hr is " PTR_FORMAT, found, num, i, p2i(hr)));
 199     }
 200     return found;
 201   } else {
 202     return G1_NO_HRS_INDEX;
 203   }
 204 }
 205 
 206 HeapRegion* HeapRegionSeq::next_region_in_heap(const HeapRegion* r) const {
 207   guarantee(r != NULL, "Start region must be a valid region");
 208   guarantee(is_available(r->hrs_index()), err_msg("Trying to iterate starting from region %u which is not in the heap", r->hrs_index()));
 209   for (uint i = r->hrs_index() + 1; i < _allocated_heapregions_length; i++) {
 210     HeapRegion* hr = _regions.get_by_index(i);
 211     if (is_available(i)) {
 212       return hr;
 213     }
 214   }
 215   return NULL;
 216 }
 217 
 218 void HeapRegionSeq::iterate(HeapRegionClosure* blk) const {
 219   uint len = max_length();
 220   iterate_range(blk, 0, len);
 221 }
 222 
 223 void HeapRegionSeq::iterate_range(HeapRegionClosure* blk, uint start, uint end) const {
 224   assert(start <= end && end <= max_length(), "Invalid range.");
 225   for (uint i = start; i < end; i++) {
 226     if (!is_available(i)) {
 227       continue;
 228     }
 229     guarantee(at(i) != NULL, err_msg("Tried to access region %u that has a NULL HeapRegion*", i));
 230     bool res = blk->doHeapRegion(at(i));
 231     if (res) {
 232       blk->incomplete();
 233       return;
 234     }
 235   }
 236 }
 237 
 238 uint HeapRegionSeq::find_unavailable_from_idx(uint start_idx, uint* res_idx) const {
 239   guarantee(res_idx != NULL, "checking");
 240   guarantee(start_idx <= (max_length() + 1), "checking");
 241 
 242   uint num_regions = 0;
 243 
 244   uint cur = start_idx;
 245   while (cur < max_length() && is_available(cur)) {
 246     cur++;
 247   }
 248   if (cur == max_length()) {
 249     return num_regions;
 250   }
 251   *res_idx = cur;
 252   while (cur < max_length() && !is_available(cur)) {
 253     cur++;
 254   }
 255   num_regions = cur - *res_idx;
 256 #ifdef ASSERT
 257   for (uint i = *res_idx; i < (*res_idx + num_regions); i++) {
 258     assert(!is_available(i), "just checking");
 259   }
 260   assert(cur == max_length() || num_regions == 0 || is_available(cur),
 261          err_msg("The region at the current position %u must be available or at the end of the heap.", cur));
 262 #endif
 263   return num_regions;
 264 }
 265 
 266 uint HeapRegionSeq::start_region_for_worker(uint worker_i, uint num_workers, uint num_regions) const {
 267   return num_regions * worker_i / num_workers;
 268 }
 269 
 270 void HeapRegionSeq::par_iterate(HeapRegionClosure* blk, uint worker_id, uint num_workers, jint claim_value) const {
 271   const uint start_index = start_region_for_worker(worker_id, num_workers, _allocated_heapregions_length);
 272 
 273   // Every worker will actually look at all regions, skipping over regions that
 274   // are currently not committed.
 275   // This also (potentially) iterates over regions newly allocated during GC. This
 276   // is no problem except for some extra work.
 277   for (uint count = 0; count < _allocated_heapregions_length; count++) {
 278     const uint index = (start_index + count) % _allocated_heapregions_length;
 279     assert(0 <= index && index < _allocated_heapregions_length, "sanity");
 280     // Skip over unavailable regions
 281     if (!is_available(index)) {
 282       continue;
 283     }
 284     HeapRegion* r = _regions.get_by_index(index);
 285     // We'll ignore "continues humongous" regions (we'll process them
 286     // when we come across their corresponding "start humongous"
 287     // region) and regions already claimed.
 288     if (r->claim_value() == claim_value || r->continuesHumongous()) {
 289       continue;
 290     }
 291     // OK, try to claim it
 292     if (!r->claimHeapRegion(claim_value)) {
 293       continue;
 294     }
 295     // Success!
 296     if (r->startsHumongous()) {
 297       // If the region is "starts humongous" we'll iterate over its
 298       // "continues humongous" first; in fact we'll do them
 299       // first. The order is important. In one case, calling the
 300       // closure on the "starts humongous" region might de-allocate
 301       // and clear all its "continues humongous" regions and, as a
 302       // result, we might end up processing them twice. So, we'll do
 303       // them first (note: most closures will ignore them anyway) and
 304       // then we'll do the "starts humongous" region.
 305       for (uint ch_index = index + 1; ch_index < index + r->region_num(); ch_index++) {
 306         HeapRegion* chr = _regions.get_by_index(ch_index);
 307 
 308         assert(chr->continuesHumongous(), "Must be humongous region");
 309         assert(chr->humongous_start_region() == r,
 310                err_msg("Must work on humongous continuation of the original start region "
 311                        PTR_FORMAT ", but is " PTR_FORMAT, p2i(r), p2i(chr)));
 312         assert(chr->claim_value() != claim_value,
 313                "Must not have been claimed yet because claiming of humongous continuation first claims the start region");
 314 
 315         bool claim_result = chr->claimHeapRegion(claim_value);
 316         // We should always be able to claim it; no one else should
 317         // be trying to claim this region.
 318         guarantee(claim_result, "We should always be able to claim the continuesHumongous part of the humongous object");
 319 
 320         bool res2 = blk->doHeapRegion(chr);
 321         if (res2) {
 322           return;
 323         }
 324 
 325         // Right now, this holds (i.e., no closure that actually
 326         // does something with "continues humongous" regions
 327         // clears them). We might have to weaken it in the future,
 328         // but let's leave these two asserts here for extra safety.
 329         assert(chr->continuesHumongous(), "should still be the case");
 330         assert(chr->humongous_start_region() == r, "sanity");
 331       }
 332     }
 333 
 334     bool res = blk->doHeapRegion(r);
 335     if (res) {
 336       return;
 337     }
 338   }
 339 }
 340 
 341 uint HeapRegionSeq::shrink_by(uint num_regions_to_remove) {
 342   assert(length() > 0, "the region sequence should not be empty");
 343   assert(length() <= _allocated_heapregions_length, "invariant");
 344   assert(_allocated_heapregions_length > 0, "we should have at least one region committed");
 345   assert(num_regions_to_remove < length(), "We should never remove all regions");
 346 
 347   if (num_regions_to_remove == 0) {
 348     return 0;
 349   }
 350 
 351   uint removed = 0;
 352   uint cur = _allocated_heapregions_length - 1;
 353   uint idx_last_found = 0;
 354   uint num_last_found = 0;
 355 
 356   while ((removed < num_regions_to_remove) &&
 357       (num_last_found = find_empty_from_idx_reverse(cur, &idx_last_found)) > 0) {
 358     // Only allow uncommit from the end of the heap.
 359     if ((idx_last_found + num_last_found) != _allocated_heapregions_length) {
 360       return 0;
 361     }
 362     uint to_remove = MIN2(num_regions_to_remove - removed, num_last_found);
 363 
 364     uncommit_regions(idx_last_found + num_last_found - to_remove, to_remove);
 365 
 366     cur -= num_last_found;
 367     removed += to_remove;
 368   }
 369 
 370   verify_optional();
 371 
 372   return removed;
 373 }
 374 
 375 uint HeapRegionSeq::find_empty_from_idx_reverse(uint start_idx, uint* res_idx) const {
 376   guarantee(start_idx < _allocated_heapregions_length, "checking");
 377   guarantee(res_idx != NULL, "checking");
 378 
 379   uint num_regions_found = 0;
 380 
 381   jlong cur = start_idx;
 382   while (cur != -1 && !(is_available(cur) && at(cur)->is_empty())) {
 383     cur--;
 384   }
 385   if (cur == -1) {
 386     return num_regions_found;
 387   }
 388   jlong old_cur = cur;
 389   // cur indexes the first empty region
 390   while (cur != -1 && is_available(cur) && at(cur)->is_empty()) {
 391     cur--;
 392   }
 393   *res_idx = cur + 1;
 394   num_regions_found = old_cur - cur;
 395 
 396 #ifdef ASSERT
 397   for (uint i = *res_idx; i < (*res_idx + num_regions_found); i++) {
 398     assert(at(i)->is_empty(), "just checking");
 399   }
 400 #endif
 401   return num_regions_found;
 402 }
 403 
 404 void HeapRegionSeq::verify() {
 405   guarantee(length() <= _allocated_heapregions_length,
 406             err_msg("invariant: _length: %u _allocated_length: %u",
 407                     length(), _allocated_heapregions_length));
 408   guarantee(_allocated_heapregions_length <= max_length(),
 409             err_msg("invariant: _allocated_length: %u _max_length: %u",
 410                     _allocated_heapregions_length, max_length()));
 411 
 412   bool prev_committed = true;
 413   uint num_committed = 0;
 414   HeapWord* prev_end = heap_bottom();
 415   for (uint i = 0; i < _allocated_heapregions_length; i++) {
 416     if (!is_available(i)) {
 417       prev_committed = false;
 418       continue;
 419     }
 420     num_committed++;
 421     HeapRegion* hr = _regions.get_by_index(i);
 422     guarantee(hr != NULL, err_msg("invariant: i: %u", i));
 423     guarantee(!prev_committed || hr->bottom() == prev_end,
 424               err_msg("invariant i: %u "HR_FORMAT" prev_end: "PTR_FORMAT,
 425                       i, HR_FORMAT_PARAMS(hr), p2i(prev_end)));
 426     guarantee(hr->hrs_index() == i,
 427               err_msg("invariant: i: %u hrs_index(): %u", i, hr->hrs_index()));
 428     // Asserts will fire if i is >= _length
 429     HeapWord* addr = hr->bottom();
 430     guarantee(addr_to_region(addr) == hr, "sanity");
 431     // We cannot check whether the region is part of a particular set: at the time
 432     // this method may be called, we have only completed allocation of the regions,
 433     // but not put into a region set.
 434     prev_committed = true;
 435     if (hr->startsHumongous()) {
 436       prev_end = hr->orig_end();
 437     } else {
 438       prev_end = hr->end();
 439     }
 440   }
 441   for (uint i = _allocated_heapregions_length; i < max_length(); i++) {
 442     guarantee(_regions.get_by_index(i) == NULL, err_msg("invariant i: %u", i));
 443   }
 444 
 445   guarantee(num_committed == _num_committed, err_msg("Found %u committed regions, but should be %u", num_committed, _num_committed));
 446   _free_list.verify();
 447 }
 448 
 449 #ifndef PRODUCT
 450 void HeapRegionSeq::verify_optional() {
 451   verify();
 452 }
 453 #endif // PRODUCT
 454