heap.cc revision f85c2fb317399ab540854cd7551ac47690366543
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "heap.h"
18
19#define ATRACE_TAG ATRACE_TAG_DALVIK
20#include <cutils/trace.h>
21
22#include <limits>
23#include <memory>
24#include <vector>
25
26#include "base/histogram-inl.h"
27#include "base/stl_util.h"
28#include "common_throws.h"
29#include "cutils/sched_policy.h"
30#include "debugger.h"
31#include "gc/accounting/atomic_stack.h"
32#include "gc/accounting/card_table-inl.h"
33#include "gc/accounting/heap_bitmap-inl.h"
34#include "gc/accounting/mod_union_table.h"
35#include "gc/accounting/mod_union_table-inl.h"
36#include "gc/accounting/remembered_set.h"
37#include "gc/accounting/space_bitmap-inl.h"
38#include "gc/collector/concurrent_copying.h"
39#include "gc/collector/mark_compact.h"
40#include "gc/collector/mark_sweep-inl.h"
41#include "gc/collector/partial_mark_sweep.h"
42#include "gc/collector/semi_space.h"
43#include "gc/collector/sticky_mark_sweep.h"
44#include "gc/reference_processor.h"
45#include "gc/space/bump_pointer_space.h"
46#include "gc/space/dlmalloc_space-inl.h"
47#include "gc/space/image_space.h"
48#include "gc/space/large_object_space.h"
49#include "gc/space/rosalloc_space-inl.h"
50#include "gc/space/space-inl.h"
51#include "gc/space/zygote_space.h"
52#include "entrypoints/quick/quick_alloc_entrypoints.h"
53#include "heap-inl.h"
54#include "image.h"
55#include "mirror/art_field-inl.h"
56#include "mirror/class-inl.h"
57#include "mirror/object.h"
58#include "mirror/object-inl.h"
59#include "mirror/object_array-inl.h"
60#include "mirror/reference-inl.h"
61#include "object_utils.h"
62#include "os.h"
63#include "reflection.h"
64#include "runtime.h"
65#include "ScopedLocalRef.h"
66#include "scoped_thread_state_change.h"
67#include "handle_scope-inl.h"
68#include "thread_list.h"
69#include "well_known_classes.h"
70
71namespace art {
72
73namespace gc {
74
75static constexpr size_t kCollectorTransitionStressIterations = 0;
76static constexpr size_t kCollectorTransitionStressWait = 10 * 1000;  // Microseconds
77static constexpr bool kGCALotMode = false;
78static constexpr size_t kGcAlotInterval = KB;
79// Minimum amount of remaining bytes before a concurrent GC is triggered.
80static constexpr size_t kMinConcurrentRemainingBytes = 128 * KB;
81static constexpr size_t kMaxConcurrentRemainingBytes = 512 * KB;
82// Sticky GC throughput adjustment, divided by 4. Increasing this causes sticky GC to occur more
83// relative to partial/full GC. This may be desirable since sticky GCs interfere less with mutator
84// threads (lower pauses, use less memory bandwidth).
85static constexpr double kStickyGcThroughputAdjustment = 1.0;
86// Whether or not we use the free list large object space.
87static constexpr bool kUseFreeListSpaceForLOS = false;
88// Whether or not we compact the zygote in PreZygoteFork.
89static constexpr bool kCompactZygote = kMovingCollector;
90static constexpr size_t kNonMovingSpaceCapacity = 64 * MB;
91// How many reserve entries are at the end of the allocation stack, these are only needed if the
92// allocation stack overflows.
93static constexpr size_t kAllocationStackReserveSize = 1024;
94// Default mark stack size in bytes.
95static const size_t kDefaultMarkStackSize = 64 * KB;
96// Define space name.
97static const char* kDlMallocSpaceName[2] = {"main dlmalloc space", "main dlmalloc space 1"};
98static const char* kRosAllocSpaceName[2] = {"main rosalloc space", "main rosalloc space 1"};
99static const char* kMemMapSpaceName[2] = {"main space", "main space 1"};
100
101Heap::Heap(size_t initial_size, size_t growth_limit, size_t min_free, size_t max_free,
102           double target_utilization, double foreground_heap_growth_multiplier, size_t capacity,
103           const std::string& image_file_name, const InstructionSet image_instruction_set,
104           CollectorType foreground_collector_type, CollectorType background_collector_type,
105           size_t parallel_gc_threads, size_t conc_gc_threads, bool low_memory_mode,
106           size_t long_pause_log_threshold, size_t long_gc_log_threshold,
107           bool ignore_max_footprint, bool use_tlab,
108           bool verify_pre_gc_heap, bool verify_pre_sweeping_heap, bool verify_post_gc_heap,
109           bool verify_pre_gc_rosalloc, bool verify_pre_sweeping_rosalloc,
110           bool verify_post_gc_rosalloc, bool use_homogeneous_space_compaction_for_oom,
111           uint64_t min_interval_homogeneous_space_compaction_by_oom)
112    : non_moving_space_(nullptr),
113      rosalloc_space_(nullptr),
114      dlmalloc_space_(nullptr),
115      main_space_(nullptr),
116      collector_type_(kCollectorTypeNone),
117      foreground_collector_type_(foreground_collector_type),
118      background_collector_type_(background_collector_type),
119      desired_collector_type_(foreground_collector_type_),
120      heap_trim_request_lock_(nullptr),
121      last_trim_time_(0),
122      heap_transition_or_trim_target_time_(0),
123      heap_trim_request_pending_(false),
124      parallel_gc_threads_(parallel_gc_threads),
125      conc_gc_threads_(conc_gc_threads),
126      low_memory_mode_(low_memory_mode),
127      long_pause_log_threshold_(long_pause_log_threshold),
128      long_gc_log_threshold_(long_gc_log_threshold),
129      ignore_max_footprint_(ignore_max_footprint),
130      zygote_creation_lock_("zygote creation lock", kZygoteCreationLock),
131      have_zygote_space_(false),
132      large_object_threshold_(std::numeric_limits<size_t>::max()),  // Starts out disabled.
133      collector_type_running_(kCollectorTypeNone),
134      last_gc_type_(collector::kGcTypeNone),
135      next_gc_type_(collector::kGcTypePartial),
136      capacity_(capacity),
137      growth_limit_(growth_limit),
138      max_allowed_footprint_(initial_size),
139      native_footprint_gc_watermark_(initial_size),
140      native_footprint_limit_(2 * initial_size),
141      native_need_to_run_finalization_(false),
142      // Initially assume we perceive jank in case the process state is never updated.
143      process_state_(kProcessStateJankPerceptible),
144      concurrent_start_bytes_(std::numeric_limits<size_t>::max()),
145      total_bytes_freed_ever_(0),
146      total_objects_freed_ever_(0),
147      num_bytes_allocated_(0),
148      native_bytes_allocated_(0),
149      gc_memory_overhead_(0),
150      verify_missing_card_marks_(false),
151      verify_system_weaks_(false),
152      verify_pre_gc_heap_(verify_pre_gc_heap),
153      verify_pre_sweeping_heap_(verify_pre_sweeping_heap),
154      verify_post_gc_heap_(verify_post_gc_heap),
155      verify_mod_union_table_(false),
156      verify_pre_gc_rosalloc_(verify_pre_gc_rosalloc),
157      verify_pre_sweeping_rosalloc_(verify_pre_sweeping_rosalloc),
158      verify_post_gc_rosalloc_(verify_post_gc_rosalloc),
159      last_gc_time_ns_(NanoTime()),
160      allocation_rate_(0),
161      /* For GC a lot mode, we limit the allocations stacks to be kGcAlotInterval allocations. This
162       * causes a lot of GC since we do a GC for alloc whenever the stack is full. When heap
163       * verification is enabled, we limit the size of allocation stacks to speed up their
164       * searching.
165       */
166      max_allocation_stack_size_(kGCALotMode ? kGcAlotInterval
167          : (kVerifyObjectSupport > kVerifyObjectModeFast) ? KB : MB),
168      current_allocator_(kAllocatorTypeDlMalloc),
169      current_non_moving_allocator_(kAllocatorTypeNonMoving),
170      bump_pointer_space_(nullptr),
171      temp_space_(nullptr),
172      min_free_(min_free),
173      max_free_(max_free),
174      target_utilization_(target_utilization),
175      foreground_heap_growth_multiplier_(foreground_heap_growth_multiplier),
176      total_wait_time_(0),
177      total_allocation_time_(0),
178      verify_object_mode_(kVerifyObjectModeDisabled),
179      disable_moving_gc_count_(0),
180      running_on_valgrind_(Runtime::Current()->RunningOnValgrind()),
181      use_tlab_(use_tlab),
182      main_space_backup_(nullptr),
183      min_interval_homogeneous_space_compaction_by_oom_(min_interval_homogeneous_space_compaction_by_oom),
184      last_time_homogeneous_space_compaction_by_oom_(NanoTime()),
185      use_homogeneous_space_compaction_for_oom_(use_homogeneous_space_compaction_for_oom) {
186  if (VLOG_IS_ON(heap) || VLOG_IS_ON(startup)) {
187    LOG(INFO) << "Heap() entering";
188  }
189  const bool is_zygote = Runtime::Current()->IsZygote();
190  // If we aren't the zygote, switch to the default non zygote allocator. This may update the
191  // entrypoints.
192  if (!is_zygote) {
193    large_object_threshold_ = kDefaultLargeObjectThreshold;
194    // Background compaction is currently not supported for command line runs.
195    if (background_collector_type_ != foreground_collector_type_) {
196      VLOG(heap) << "Disabling background compaction for non zygote";
197      background_collector_type_ = foreground_collector_type_;
198    }
199  }
200  ChangeCollector(desired_collector_type_);
201
202  live_bitmap_.reset(new accounting::HeapBitmap(this));
203  mark_bitmap_.reset(new accounting::HeapBitmap(this));
204  // Requested begin for the alloc space, to follow the mapped image and oat files
205  byte* requested_alloc_space_begin = nullptr;
206  if (!image_file_name.empty()) {
207    space::ImageSpace* image_space = space::ImageSpace::Create(image_file_name.c_str(),
208                                                               image_instruction_set);
209    CHECK(image_space != nullptr) << "Failed to create space for " << image_file_name;
210    AddSpace(image_space);
211    // Oat files referenced by image files immediately follow them in memory, ensure alloc space
212    // isn't going to get in the middle
213    byte* oat_file_end_addr = image_space->GetImageHeader().GetOatFileEnd();
214    CHECK_GT(oat_file_end_addr, image_space->End());
215    requested_alloc_space_begin = AlignUp(oat_file_end_addr, kPageSize);
216  }
217
218  /*
219  requested_alloc_space_begin ->     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
220                                     +-  nonmoving space (kNonMovingSpaceCapacity) +-
221                                     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
222                                     +-        main alloc space (capacity_)        +-
223                                     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
224                                     +-       main alloc space 1 (capacity_)       +-
225                                     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
226  */
227  bool create_backup_main_space =
228      background_collector_type == gc::kCollectorTypeHomogeneousSpaceCompact ||
229      use_homogeneous_space_compaction_for_oom;
230  if (is_zygote) {
231    // Reserve the address range before we create the non moving space to make sure bitmaps don't
232    // take it.
233    std::string error_str;
234    MemMap* main_space_map = MemMap::MapAnonymous(
235        kMemMapSpaceName[0], requested_alloc_space_begin + kNonMovingSpaceCapacity, capacity_,
236        PROT_READ | PROT_WRITE, true, &error_str);
237    CHECK(main_space_map != nullptr) << error_str;
238    MemMap* main_space_1_map = nullptr;
239    // Attempt to reserve an extra mem_map for homogeneous space compaction right after the main space map.
240    if (create_backup_main_space) {
241      main_space_1_map = MemMap::MapAnonymous(kMemMapSpaceName[1], main_space_map->End(), capacity_,
242                                               PROT_READ | PROT_WRITE, true, &error_str);
243      if (main_space_1_map == nullptr) {
244        LOG(WARNING) << "Failed to create map " <<  kMemMapSpaceName[1] << " with error "
245                     << error_str;
246      }
247    }
248    // Non moving space is always dlmalloc since we currently don't have support for multiple
249    // active rosalloc spaces.
250    non_moving_space_ = space::DlMallocSpace::Create(
251        "zygote / non moving space", initial_size, kNonMovingSpaceCapacity,
252        kNonMovingSpaceCapacity, requested_alloc_space_begin, false);
253    non_moving_space_->SetFootprintLimit(non_moving_space_->Capacity());
254    CreateMainMallocSpace(main_space_map, initial_size, growth_limit_, capacity_);
255    if (main_space_1_map != nullptr) {
256      const char* name = kUseRosAlloc ? kRosAllocSpaceName[1] : kDlMallocSpaceName[1];
257      main_space_backup_ = CreateMallocSpaceFromMemMap(main_space_1_map, initial_size,
258                                                       growth_limit_, capacity_, name, true);
259    }
260  } else {
261    std::string error_str;
262    byte* request_begin = requested_alloc_space_begin;
263    if (request_begin == nullptr) {
264      // Disable homogeneous space compaction since we don't have an image.
265      create_backup_main_space = false;
266    }
267    MemMap* main_space_1_map = nullptr;
268    if (create_backup_main_space) {
269      request_begin += kNonMovingSpaceCapacity;
270      // Attempt to reserve an extra mem_map for homogeneous space compaction right after the main space map.
271      main_space_1_map = MemMap::MapAnonymous(kMemMapSpaceName[1], request_begin + capacity_,
272                                               capacity_, PROT_READ | PROT_WRITE, true, &error_str);
273      if (main_space_1_map == nullptr) {
274        LOG(WARNING) << "Failed to create map " <<  kMemMapSpaceName[1] << " with error "
275                     << error_str;
276        request_begin = requested_alloc_space_begin;
277      }
278    }
279    MemMap* main_space_map = MemMap::MapAnonymous(kMemMapSpaceName[0], request_begin, capacity_,
280                                                  PROT_READ | PROT_WRITE, true, &error_str);
281    CHECK(main_space_map != nullptr) << error_str;
282    // Introduce a seperate non moving space.
283    if (main_space_1_map != nullptr) {
284      // Do this before creating the main malloc space to prevent bitmaps from being placed here.
285      non_moving_space_ = space::DlMallocSpace::Create(
286          "non moving space", kDefaultInitialSize, kNonMovingSpaceCapacity, kNonMovingSpaceCapacity,
287          requested_alloc_space_begin, false);
288      non_moving_space_->SetFootprintLimit(non_moving_space_->Capacity());
289    }
290    // Create the main free list space, which doubles as the non moving space. We can do this since
291    // non zygote means that we won't have any background compaction.
292    CreateMainMallocSpace(main_space_map, initial_size, growth_limit_, capacity_);
293    if (main_space_1_map != nullptr) {
294      const char* name = kUseRosAlloc ? kRosAllocSpaceName[1] : kDlMallocSpaceName[1];
295      main_space_backup_ = CreateMallocSpaceFromMemMap(main_space_1_map, initial_size,
296                                                       growth_limit_, capacity_, name, true);
297      CHECK(main_space_backup_ != nullptr);
298    } else {
299      non_moving_space_ = main_space_;
300    }
301  }
302  CHECK(non_moving_space_ != nullptr);
303
304  // We need to create the bump pointer if the foreground collector is a compacting GC. We only
305  // create the bump pointer space if we are not a moving foreground collector but have a moving
306  // background collector since the heap transition code will create the temp space by recycling
307  // the bitmap from the main space.
308  if (kMovingCollector &&
309      (IsMovingGc(foreground_collector_type_) || IsMovingGc(background_collector_type_))) {
310    // TODO: Place bump-pointer spaces somewhere to minimize size of card table.
311    // Divide by 2 for a temporary fix for reducing virtual memory usage.
312    const size_t bump_pointer_space_capacity = capacity_ / 2;
313    bump_pointer_space_ = space::BumpPointerSpace::Create("Bump pointer space",
314                                                          bump_pointer_space_capacity, nullptr);
315    CHECK(bump_pointer_space_ != nullptr) << "Failed to create bump pointer space";
316    AddSpace(bump_pointer_space_);
317    temp_space_ = space::BumpPointerSpace::Create("Bump pointer space 2",
318                                                  bump_pointer_space_capacity, nullptr);
319    CHECK(temp_space_ != nullptr) << "Failed to create bump pointer space";
320    AddSpace(temp_space_);
321  }
322  if (non_moving_space_ != main_space_) {
323    AddSpace(non_moving_space_);
324  }
325  if (main_space_backup_ != nullptr) {
326    AddSpace(main_space_backup_);
327  } else {
328    const char* disable_msg = "Disabling homogenous space compact due to no backup main space";
329    if (background_collector_type_ == gc::kCollectorTypeHomogeneousSpaceCompact) {
330      background_collector_type_ = collector_type_;
331      LOG(WARNING) << disable_msg;
332    } else if (use_homogeneous_space_compaction_for_oom_) {
333      LOG(WARNING) << disable_msg;
334    }
335    use_homogeneous_space_compaction_for_oom_ = false;
336  }
337  if (main_space_ != nullptr) {
338    AddSpace(main_space_);
339  }
340
341  // Allocate the large object space.
342  if (kUseFreeListSpaceForLOS) {
343    large_object_space_ = space::FreeListSpace::Create("large object space", nullptr, capacity_);
344  } else {
345    large_object_space_ = space::LargeObjectMapSpace::Create("large object space");
346  }
347  CHECK(large_object_space_ != nullptr) << "Failed to create large object space";
348  AddSpace(large_object_space_);
349
350  // Compute heap capacity. Continuous spaces are sorted in order of Begin().
351  CHECK(!continuous_spaces_.empty());
352
353  // Relies on the spaces being sorted.
354  byte* heap_begin = continuous_spaces_.front()->Begin();
355  byte* heap_end = continuous_spaces_.back()->Limit();
356  size_t heap_capacity = heap_end - heap_begin;
357
358  // Allocate the card table.
359  card_table_.reset(accounting::CardTable::Create(heap_begin, heap_capacity));
360  CHECK(card_table_.get() != NULL) << "Failed to create card table";
361
362  // Card cache for now since it makes it easier for us to update the references to the copying
363  // spaces.
364  accounting::ModUnionTable* mod_union_table =
365      new accounting::ModUnionTableToZygoteAllocspace("Image mod-union table", this,
366                                                      GetImageSpace());
367  CHECK(mod_union_table != nullptr) << "Failed to create image mod-union table";
368  AddModUnionTable(mod_union_table);
369
370  if (collector::SemiSpace::kUseRememberedSet && non_moving_space_ != main_space_) {
371    accounting::RememberedSet* non_moving_space_rem_set =
372        new accounting::RememberedSet("Non-moving space remembered set", this, non_moving_space_);
373    CHECK(non_moving_space_rem_set != nullptr) << "Failed to create non-moving space remembered set";
374    AddRememberedSet(non_moving_space_rem_set);
375  }
376
377  // TODO: Count objects in the image space here.
378  num_bytes_allocated_.StoreRelaxed(0);
379
380  mark_stack_.reset(accounting::ObjectStack::Create("mark stack", kDefaultMarkStackSize,
381                                                    kDefaultMarkStackSize));
382  const size_t alloc_stack_capacity = max_allocation_stack_size_ + kAllocationStackReserveSize;
383  allocation_stack_.reset(accounting::ObjectStack::Create(
384      "allocation stack", max_allocation_stack_size_, alloc_stack_capacity));
385  live_stack_.reset(accounting::ObjectStack::Create(
386      "live stack", max_allocation_stack_size_, alloc_stack_capacity));
387
388  // It's still too early to take a lock because there are no threads yet, but we can create locks
389  // now. We don't create it earlier to make it clear that you can't use locks during heap
390  // initialization.
391  gc_complete_lock_ = new Mutex("GC complete lock");
392  gc_complete_cond_.reset(new ConditionVariable("GC complete condition variable",
393                                                *gc_complete_lock_));
394  heap_trim_request_lock_ = new Mutex("Heap trim request lock");
395  last_gc_size_ = GetBytesAllocated();
396
397  if (ignore_max_footprint_) {
398    SetIdealFootprint(std::numeric_limits<size_t>::max());
399    concurrent_start_bytes_ = std::numeric_limits<size_t>::max();
400  }
401  CHECK_NE(max_allowed_footprint_, 0U);
402
403  // Create our garbage collectors.
404  for (size_t i = 0; i < 2; ++i) {
405    const bool concurrent = i != 0;
406    garbage_collectors_.push_back(new collector::MarkSweep(this, concurrent));
407    garbage_collectors_.push_back(new collector::PartialMarkSweep(this, concurrent));
408    garbage_collectors_.push_back(new collector::StickyMarkSweep(this, concurrent));
409  }
410  if (kMovingCollector) {
411    // TODO: Clean this up.
412    const bool generational = foreground_collector_type_ == kCollectorTypeGSS;
413    semi_space_collector_ = new collector::SemiSpace(this, generational,
414                                                     generational ? "generational" : "");
415    garbage_collectors_.push_back(semi_space_collector_);
416    concurrent_copying_collector_ = new collector::ConcurrentCopying(this);
417    garbage_collectors_.push_back(concurrent_copying_collector_);
418    mark_compact_collector_ = new collector::MarkCompact(this);
419    garbage_collectors_.push_back(mark_compact_collector_);
420  }
421
422  if (GetImageSpace() != nullptr && main_space_ != nullptr) {
423    // Check that there's no gap between the image space and the main space so that the immune
424    // region won't break (eg. due to a large object allocated in the gap).
425    bool no_gap = MemMap::CheckNoGaps(GetImageSpace()->GetMemMap(), main_space_->GetMemMap());
426    if (!no_gap) {
427      MemMap::DumpMaps(LOG(ERROR));
428      LOG(FATAL) << "There's a gap between the image space and the main space";
429    }
430  }
431
432  if (running_on_valgrind_) {
433    Runtime::Current()->GetInstrumentation()->InstrumentQuickAllocEntryPoints();
434  }
435
436  if (VLOG_IS_ON(heap) || VLOG_IS_ON(startup)) {
437    LOG(INFO) << "Heap() exiting";
438  }
439}
440
441space::MallocSpace* Heap::CreateMallocSpaceFromMemMap(MemMap* mem_map, size_t initial_size,
442                                                      size_t growth_limit, size_t capacity,
443                                                      const char* name, bool can_move_objects) {
444  space::MallocSpace* malloc_space = nullptr;
445  if (kUseRosAlloc) {
446    // Create rosalloc space.
447    malloc_space = space::RosAllocSpace::CreateFromMemMap(mem_map, name, kDefaultStartingSize,
448                                                          initial_size, growth_limit, capacity,
449                                                          low_memory_mode_, can_move_objects);
450  } else {
451    malloc_space = space::DlMallocSpace::CreateFromMemMap(mem_map, name, kDefaultStartingSize,
452                                                          initial_size, growth_limit, capacity,
453                                                          can_move_objects);
454  }
455  if (collector::SemiSpace::kUseRememberedSet) {
456    accounting::RememberedSet* rem_set  =
457        new accounting::RememberedSet(std::string(name) + " remembered set", this, malloc_space);
458    CHECK(rem_set != nullptr) << "Failed to create main space remembered set";
459    AddRememberedSet(rem_set);
460  }
461  CHECK(malloc_space != nullptr) << "Failed to create " << name;
462  malloc_space->SetFootprintLimit(malloc_space->Capacity());
463  return malloc_space;
464}
465
466void Heap::CreateMainMallocSpace(MemMap* mem_map, size_t initial_size, size_t growth_limit,
467                                 size_t capacity) {
468  // Is background compaction is enabled?
469  bool can_move_objects = IsMovingGc(background_collector_type_) !=
470      IsMovingGc(foreground_collector_type_) || use_homogeneous_space_compaction_for_oom_;
471  // If we are the zygote and don't yet have a zygote space, it means that the zygote fork will
472  // happen in the future. If this happens and we have kCompactZygote enabled we wish to compact
473  // from the main space to the zygote space. If background compaction is enabled, always pass in
474  // that we can move objets.
475  if (kCompactZygote && Runtime::Current()->IsZygote() && !can_move_objects) {
476    // After the zygote we want this to be false if we don't have background compaction enabled so
477    // that getting primitive array elements is faster.
478    can_move_objects = !have_zygote_space_;
479  }
480  if (collector::SemiSpace::kUseRememberedSet && main_space_ != nullptr) {
481    RemoveRememberedSet(main_space_);
482  }
483  const char* name = kUseRosAlloc ? kRosAllocSpaceName[0] : kDlMallocSpaceName[0];
484  main_space_ = CreateMallocSpaceFromMemMap(mem_map, initial_size, growth_limit, capacity, name,
485                                            can_move_objects);
486  SetSpaceAsDefault(main_space_);
487  VLOG(heap) << "Created main space " << main_space_;
488}
489
490void Heap::ChangeAllocator(AllocatorType allocator) {
491  if (current_allocator_ != allocator) {
492    // These two allocators are only used internally and don't have any entrypoints.
493    CHECK_NE(allocator, kAllocatorTypeLOS);
494    CHECK_NE(allocator, kAllocatorTypeNonMoving);
495    current_allocator_ = allocator;
496    MutexLock mu(nullptr, *Locks::runtime_shutdown_lock_);
497    SetQuickAllocEntryPointsAllocator(current_allocator_);
498    Runtime::Current()->GetInstrumentation()->ResetQuickAllocEntryPoints();
499  }
500}
501
502void Heap::DisableCompaction() {
503  if (IsMovingGc(foreground_collector_type_)) {
504    foreground_collector_type_  = kCollectorTypeCMS;
505  }
506  if (IsMovingGc(background_collector_type_)) {
507    background_collector_type_ = foreground_collector_type_;
508  }
509  TransitionCollector(foreground_collector_type_);
510}
511
512std::string Heap::SafeGetClassDescriptor(mirror::Class* klass) {
513  if (!IsValidContinuousSpaceObjectAddress(klass)) {
514    return StringPrintf("<non heap address klass %p>", klass);
515  }
516  mirror::Class* component_type = klass->GetComponentType<kVerifyNone>();
517  if (IsValidContinuousSpaceObjectAddress(component_type) && klass->IsArrayClass<kVerifyNone>()) {
518    std::string result("[");
519    result += SafeGetClassDescriptor(component_type);
520    return result;
521  } else if (UNLIKELY(klass->IsPrimitive<kVerifyNone>())) {
522    return Primitive::Descriptor(klass->GetPrimitiveType<kVerifyNone>());
523  } else if (UNLIKELY(klass->IsProxyClass<kVerifyNone>())) {
524    return Runtime::Current()->GetClassLinker()->GetDescriptorForProxy(klass);
525  } else {
526    mirror::DexCache* dex_cache = klass->GetDexCache<kVerifyNone>();
527    if (!IsValidContinuousSpaceObjectAddress(dex_cache)) {
528      return StringPrintf("<non heap address dex_cache %p>", dex_cache);
529    }
530    const DexFile* dex_file = dex_cache->GetDexFile();
531    uint16_t class_def_idx = klass->GetDexClassDefIndex();
532    if (class_def_idx == DexFile::kDexNoIndex16) {
533      return "<class def not found>";
534    }
535    const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_idx);
536    const DexFile::TypeId& type_id = dex_file->GetTypeId(class_def.class_idx_);
537    return dex_file->GetTypeDescriptor(type_id);
538  }
539}
540
541std::string Heap::SafePrettyTypeOf(mirror::Object* obj) {
542  if (obj == nullptr) {
543    return "null";
544  }
545  mirror::Class* klass = obj->GetClass<kVerifyNone>();
546  if (klass == nullptr) {
547    return "(class=null)";
548  }
549  std::string result(SafeGetClassDescriptor(klass));
550  if (obj->IsClass()) {
551    result += "<" + SafeGetClassDescriptor(obj->AsClass<kVerifyNone>()) + ">";
552  }
553  return result;
554}
555
556void Heap::DumpObject(std::ostream& stream, mirror::Object* obj) {
557  if (obj == nullptr) {
558    stream << "(obj=null)";
559    return;
560  }
561  if (IsAligned<kObjectAlignment>(obj)) {
562    space::Space* space = nullptr;
563    // Don't use find space since it only finds spaces which actually contain objects instead of
564    // spaces which may contain objects (e.g. cleared bump pointer spaces).
565    for (const auto& cur_space : continuous_spaces_) {
566      if (cur_space->HasAddress(obj)) {
567        space = cur_space;
568        break;
569      }
570    }
571    // Unprotect all the spaces.
572    for (const auto& space : continuous_spaces_) {
573      mprotect(space->Begin(), space->Capacity(), PROT_READ | PROT_WRITE);
574    }
575    stream << "Object " << obj;
576    if (space != nullptr) {
577      stream << " in space " << *space;
578    }
579    mirror::Class* klass = obj->GetClass<kVerifyNone>();
580    stream << "\nclass=" << klass;
581    if (klass != nullptr) {
582      stream << " type= " << SafePrettyTypeOf(obj);
583    }
584    // Re-protect the address we faulted on.
585    mprotect(AlignDown(obj, kPageSize), kPageSize, PROT_NONE);
586  }
587}
588
589bool Heap::IsCompilingBoot() const {
590  for (const auto& space : continuous_spaces_) {
591    if (space->IsImageSpace() || space->IsZygoteSpace()) {
592      return false;
593    }
594  }
595  return true;
596}
597
598bool Heap::HasImageSpace() const {
599  for (const auto& space : continuous_spaces_) {
600    if (space->IsImageSpace()) {
601      return true;
602    }
603  }
604  return false;
605}
606
607void Heap::IncrementDisableMovingGC(Thread* self) {
608  // Need to do this holding the lock to prevent races where the GC is about to run / running when
609  // we attempt to disable it.
610  ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
611  MutexLock mu(self, *gc_complete_lock_);
612  ++disable_moving_gc_count_;
613  if (IsMovingGc(collector_type_running_)) {
614    WaitForGcToCompleteLocked(kGcCauseDisableMovingGc, self);
615  }
616}
617
618void Heap::DecrementDisableMovingGC(Thread* self) {
619  MutexLock mu(self, *gc_complete_lock_);
620  CHECK_GE(disable_moving_gc_count_, 0U);
621  --disable_moving_gc_count_;
622}
623
624void Heap::UpdateProcessState(ProcessState process_state) {
625  if (process_state_ != process_state) {
626    process_state_ = process_state;
627    for (size_t i = 1; i <= kCollectorTransitionStressIterations; ++i) {
628      // Start at index 1 to avoid "is always false" warning.
629      // Have iteration 1 always transition the collector.
630      TransitionCollector((((i & 1) == 1) == (process_state_ == kProcessStateJankPerceptible))
631                          ? foreground_collector_type_ : background_collector_type_);
632      usleep(kCollectorTransitionStressWait);
633    }
634    if (process_state_ == kProcessStateJankPerceptible) {
635      // Transition back to foreground right away to prevent jank.
636      RequestCollectorTransition(foreground_collector_type_, 0);
637    } else {
638      // Don't delay for debug builds since we may want to stress test the GC.
639      // If background_collector_type_ is kCollectorTypeHomogeneousSpaceCompact then we have
640      // special handling which does a homogenous space compaction once but then doesn't transition
641      // the collector.
642      RequestCollectorTransition(background_collector_type_,
643                                 kIsDebugBuild ? 0 : kCollectorTransitionWait);
644    }
645  }
646}
647
648void Heap::CreateThreadPool() {
649  const size_t num_threads = std::max(parallel_gc_threads_, conc_gc_threads_);
650  if (num_threads != 0) {
651    thread_pool_.reset(new ThreadPool("Heap thread pool", num_threads));
652  }
653}
654
655void Heap::VisitObjects(ObjectCallback callback, void* arg) {
656  Thread* self = Thread::Current();
657  // GCs can move objects, so don't allow this.
658  const char* old_cause = self->StartAssertNoThreadSuspension("Visiting objects");
659  if (bump_pointer_space_ != nullptr) {
660    // Visit objects in bump pointer space.
661    bump_pointer_space_->Walk(callback, arg);
662  }
663  // TODO: Switch to standard begin and end to use ranged a based loop.
664  for (mirror::Object** it = allocation_stack_->Begin(), **end = allocation_stack_->End();
665      it < end; ++it) {
666    mirror::Object* obj = *it;
667    if (obj != nullptr && obj->GetClass() != nullptr) {
668      // Avoid the race condition caused by the object not yet being written into the allocation
669      // stack or the class not yet being written in the object. Or, if kUseThreadLocalAllocationStack,
670      // there can be nulls on the allocation stack.
671      callback(obj, arg);
672    }
673  }
674  GetLiveBitmap()->Walk(callback, arg);
675  self->EndAssertNoThreadSuspension(old_cause);
676}
677
678void Heap::MarkAllocStackAsLive(accounting::ObjectStack* stack) {
679  space::ContinuousSpace* space1 = rosalloc_space_ != nullptr ? rosalloc_space_ : non_moving_space_;
680  space::ContinuousSpace* space2 = dlmalloc_space_ != nullptr ? dlmalloc_space_ : non_moving_space_;
681  // This is just logic to handle a case of either not having a rosalloc or dlmalloc space.
682  // TODO: Generalize this to n bitmaps?
683  if (space1 == nullptr) {
684    DCHECK(space2 != nullptr);
685    space1 = space2;
686  }
687  if (space2 == nullptr) {
688    DCHECK(space1 != nullptr);
689    space2 = space1;
690  }
691  MarkAllocStack(space1->GetLiveBitmap(), space2->GetLiveBitmap(),
692                 large_object_space_->GetLiveBitmap(), stack);
693}
694
695void Heap::DeleteThreadPool() {
696  thread_pool_.reset(nullptr);
697}
698
699void Heap::AddSpace(space::Space* space) {
700  CHECK(space != nullptr);
701  WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
702  if (space->IsContinuousSpace()) {
703    DCHECK(!space->IsDiscontinuousSpace());
704    space::ContinuousSpace* continuous_space = space->AsContinuousSpace();
705    // Continuous spaces don't necessarily have bitmaps.
706    accounting::ContinuousSpaceBitmap* live_bitmap = continuous_space->GetLiveBitmap();
707    accounting::ContinuousSpaceBitmap* mark_bitmap = continuous_space->GetMarkBitmap();
708    if (live_bitmap != nullptr) {
709      DCHECK(mark_bitmap != nullptr);
710      live_bitmap_->AddContinuousSpaceBitmap(live_bitmap);
711      mark_bitmap_->AddContinuousSpaceBitmap(mark_bitmap);
712    }
713    continuous_spaces_.push_back(continuous_space);
714    // Ensure that spaces remain sorted in increasing order of start address.
715    std::sort(continuous_spaces_.begin(), continuous_spaces_.end(),
716              [](const space::ContinuousSpace* a, const space::ContinuousSpace* b) {
717      return a->Begin() < b->Begin();
718    });
719  } else {
720    DCHECK(space->IsDiscontinuousSpace());
721    space::DiscontinuousSpace* discontinuous_space = space->AsDiscontinuousSpace();
722    live_bitmap_->AddLargeObjectBitmap(discontinuous_space->GetLiveBitmap());
723    mark_bitmap_->AddLargeObjectBitmap(discontinuous_space->GetMarkBitmap());
724    discontinuous_spaces_.push_back(discontinuous_space);
725  }
726  if (space->IsAllocSpace()) {
727    alloc_spaces_.push_back(space->AsAllocSpace());
728  }
729}
730
731void Heap::SetSpaceAsDefault(space::ContinuousSpace* continuous_space) {
732  WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
733  if (continuous_space->IsDlMallocSpace()) {
734    dlmalloc_space_ = continuous_space->AsDlMallocSpace();
735  } else if (continuous_space->IsRosAllocSpace()) {
736    rosalloc_space_ = continuous_space->AsRosAllocSpace();
737  }
738}
739
740void Heap::RemoveSpace(space::Space* space) {
741  DCHECK(space != nullptr);
742  WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
743  if (space->IsContinuousSpace()) {
744    DCHECK(!space->IsDiscontinuousSpace());
745    space::ContinuousSpace* continuous_space = space->AsContinuousSpace();
746    // Continuous spaces don't necessarily have bitmaps.
747    accounting::ContinuousSpaceBitmap* live_bitmap = continuous_space->GetLiveBitmap();
748    accounting::ContinuousSpaceBitmap* mark_bitmap = continuous_space->GetMarkBitmap();
749    if (live_bitmap != nullptr) {
750      DCHECK(mark_bitmap != nullptr);
751      live_bitmap_->RemoveContinuousSpaceBitmap(live_bitmap);
752      mark_bitmap_->RemoveContinuousSpaceBitmap(mark_bitmap);
753    }
754    auto it = std::find(continuous_spaces_.begin(), continuous_spaces_.end(), continuous_space);
755    DCHECK(it != continuous_spaces_.end());
756    continuous_spaces_.erase(it);
757  } else {
758    DCHECK(space->IsDiscontinuousSpace());
759    space::DiscontinuousSpace* discontinuous_space = space->AsDiscontinuousSpace();
760    live_bitmap_->RemoveLargeObjectBitmap(discontinuous_space->GetLiveBitmap());
761    mark_bitmap_->RemoveLargeObjectBitmap(discontinuous_space->GetMarkBitmap());
762    auto it = std::find(discontinuous_spaces_.begin(), discontinuous_spaces_.end(),
763                        discontinuous_space);
764    DCHECK(it != discontinuous_spaces_.end());
765    discontinuous_spaces_.erase(it);
766  }
767  if (space->IsAllocSpace()) {
768    auto it = std::find(alloc_spaces_.begin(), alloc_spaces_.end(), space->AsAllocSpace());
769    DCHECK(it != alloc_spaces_.end());
770    alloc_spaces_.erase(it);
771  }
772}
773
774void Heap::RegisterGCAllocation(size_t bytes) {
775  if (this != nullptr) {
776    gc_memory_overhead_.FetchAndAddSequentiallyConsistent(bytes);
777  }
778}
779
780void Heap::RegisterGCDeAllocation(size_t bytes) {
781  if (this != nullptr) {
782    gc_memory_overhead_.FetchAndSubSequentiallyConsistent(bytes);
783  }
784}
785
786void Heap::DumpGcPerformanceInfo(std::ostream& os) {
787  // Dump cumulative timings.
788  os << "Dumping cumulative Gc timings\n";
789  uint64_t total_duration = 0;
790  // Dump cumulative loggers for each GC type.
791  uint64_t total_paused_time = 0;
792  for (auto& collector : garbage_collectors_) {
793    const CumulativeLogger& logger = collector->GetCumulativeTimings();
794    const size_t iterations = logger.GetIterations();
795    const Histogram<uint64_t>& pause_histogram = collector->GetPauseHistogram();
796    if (iterations != 0 && pause_histogram.SampleSize() != 0) {
797      os << ConstDumpable<CumulativeLogger>(logger);
798      const uint64_t total_ns = logger.GetTotalNs();
799      const uint64_t total_pause_ns = collector->GetTotalPausedTimeNs();
800      double seconds = NsToMs(logger.GetTotalNs()) / 1000.0;
801      const uint64_t freed_bytes = collector->GetTotalFreedBytes();
802      const uint64_t freed_objects = collector->GetTotalFreedObjects();
803      Histogram<uint64_t>::CumulativeData cumulative_data;
804      pause_histogram.CreateHistogram(&cumulative_data);
805      pause_histogram.PrintConfidenceIntervals(os, 0.99, cumulative_data);
806      os << collector->GetName() << " total time: " << PrettyDuration(total_ns)
807         << " mean time: " << PrettyDuration(total_ns / iterations) << "\n"
808         << collector->GetName() << " freed: " << freed_objects
809         << " objects with total size " << PrettySize(freed_bytes) << "\n"
810         << collector->GetName() << " throughput: " << freed_objects / seconds << "/s / "
811         << PrettySize(freed_bytes / seconds) << "/s\n";
812      total_duration += total_ns;
813      total_paused_time += total_pause_ns;
814    }
815    collector->ResetMeasurements();
816  }
817  uint64_t allocation_time =
818      static_cast<uint64_t>(total_allocation_time_.LoadRelaxed()) * kTimeAdjust;
819  if (total_duration != 0) {
820    const double total_seconds = static_cast<double>(total_duration / 1000) / 1000000.0;
821    os << "Total time spent in GC: " << PrettyDuration(total_duration) << "\n";
822    os << "Mean GC size throughput: "
823       << PrettySize(GetBytesFreedEver() / total_seconds) << "/s\n";
824    os << "Mean GC object throughput: "
825       << (GetObjectsFreedEver() / total_seconds) << " objects/s\n";
826  }
827  size_t total_objects_allocated = GetObjectsAllocatedEver();
828  os << "Total number of allocations: " << total_objects_allocated << "\n";
829  size_t total_bytes_allocated = GetBytesAllocatedEver();
830  os << "Total bytes allocated " << PrettySize(total_bytes_allocated) << "\n";
831  if (kMeasureAllocationTime) {
832    os << "Total time spent allocating: " << PrettyDuration(allocation_time) << "\n";
833    os << "Mean allocation time: " << PrettyDuration(allocation_time / total_objects_allocated)
834       << "\n";
835  }
836  os << "Total mutator paused time: " << PrettyDuration(total_paused_time) << "\n";
837  os << "Total time waiting for GC to complete: " << PrettyDuration(total_wait_time_) << "\n";
838  os << "Approximate GC data structures memory overhead: " << gc_memory_overhead_.LoadRelaxed();
839  BaseMutex::DumpAll(os);
840}
841
842Heap::~Heap() {
843  VLOG(heap) << "Starting ~Heap()";
844  STLDeleteElements(&garbage_collectors_);
845  // If we don't reset then the mark stack complains in its destructor.
846  allocation_stack_->Reset();
847  live_stack_->Reset();
848  STLDeleteValues(&mod_union_tables_);
849  STLDeleteValues(&remembered_sets_);
850  STLDeleteElements(&continuous_spaces_);
851  STLDeleteElements(&discontinuous_spaces_);
852  delete gc_complete_lock_;
853  delete heap_trim_request_lock_;
854  VLOG(heap) << "Finished ~Heap()";
855}
856
857space::ContinuousSpace* Heap::FindContinuousSpaceFromObject(const mirror::Object* obj,
858                                                            bool fail_ok) const {
859  for (const auto& space : continuous_spaces_) {
860    if (space->Contains(obj)) {
861      return space;
862    }
863  }
864  if (!fail_ok) {
865    LOG(FATAL) << "object " << reinterpret_cast<const void*>(obj) << " not inside any spaces!";
866  }
867  return NULL;
868}
869
870space::DiscontinuousSpace* Heap::FindDiscontinuousSpaceFromObject(const mirror::Object* obj,
871                                                                  bool fail_ok) const {
872  for (const auto& space : discontinuous_spaces_) {
873    if (space->Contains(obj)) {
874      return space;
875    }
876  }
877  if (!fail_ok) {
878    LOG(FATAL) << "object " << reinterpret_cast<const void*>(obj) << " not inside any spaces!";
879  }
880  return NULL;
881}
882
883space::Space* Heap::FindSpaceFromObject(const mirror::Object* obj, bool fail_ok) const {
884  space::Space* result = FindContinuousSpaceFromObject(obj, true);
885  if (result != NULL) {
886    return result;
887  }
888  return FindDiscontinuousSpaceFromObject(obj, true);
889}
890
891space::ImageSpace* Heap::GetImageSpace() const {
892  for (const auto& space : continuous_spaces_) {
893    if (space->IsImageSpace()) {
894      return space->AsImageSpace();
895    }
896  }
897  return NULL;
898}
899
900void Heap::ThrowOutOfMemoryError(Thread* self, size_t byte_count, AllocatorType allocator_type) {
901  std::ostringstream oss;
902  size_t total_bytes_free = GetFreeMemory();
903  oss << "Failed to allocate a " << byte_count << " byte allocation with " << total_bytes_free
904      << " free bytes";
905  // If the allocation failed due to fragmentation, print out the largest continuous allocation.
906  if (total_bytes_free >= byte_count) {
907    space::MallocSpace* space = nullptr;
908    if (allocator_type == kAllocatorTypeNonMoving) {
909      space = non_moving_space_;
910    } else if (allocator_type == kAllocatorTypeRosAlloc ||
911               allocator_type == kAllocatorTypeDlMalloc) {
912      space = main_space_;
913    }
914    if (space != nullptr) {
915      space->LogFragmentationAllocFailure(oss, byte_count);
916    }
917  }
918  self->ThrowOutOfMemoryError(oss.str().c_str());
919}
920
921void Heap::DoPendingTransitionOrTrim() {
922  Thread* self = Thread::Current();
923  CollectorType desired_collector_type;
924  // Wait until we reach the desired transition time.
925  while (true) {
926    uint64_t wait_time;
927    {
928      MutexLock mu(self, *heap_trim_request_lock_);
929      desired_collector_type = desired_collector_type_;
930      uint64_t current_time = NanoTime();
931      if (current_time >= heap_transition_or_trim_target_time_) {
932        break;
933      }
934      wait_time = heap_transition_or_trim_target_time_ - current_time;
935    }
936    ScopedThreadStateChange tsc(self, kSleeping);
937    usleep(wait_time / 1000);  // Usleep takes microseconds.
938  }
939  // Launch homogeneous space compaction if it is desired.
940  if (desired_collector_type == kCollectorTypeHomogeneousSpaceCompact) {
941    if (!CareAboutPauseTimes()) {
942      PerformHomogeneousSpaceCompact();
943    }
944    // No need to Trim(). Homogeneous space compaction may free more virtual and physical memory.
945    desired_collector_type = collector_type_;
946    return;
947  }
948  // Transition the collector if the desired collector type is not the same as the current
949  // collector type.
950  TransitionCollector(desired_collector_type);
951  if (!CareAboutPauseTimes()) {
952    // Deflate the monitors, this can cause a pause but shouldn't matter since we don't care
953    // about pauses.
954    Runtime* runtime = Runtime::Current();
955    runtime->GetThreadList()->SuspendAll();
956    uint64_t start_time = NanoTime();
957    size_t count = runtime->GetMonitorList()->DeflateMonitors();
958    VLOG(heap) << "Deflating " << count << " monitors took "
959        << PrettyDuration(NanoTime() - start_time);
960    runtime->GetThreadList()->ResumeAll();
961  }
962  // Do a heap trim if it is needed.
963  Trim();
964}
965
966void Heap::Trim() {
967  Thread* self = Thread::Current();
968  {
969    MutexLock mu(self, *heap_trim_request_lock_);
970    if (!heap_trim_request_pending_ || last_trim_time_ + kHeapTrimWait >= NanoTime()) {
971      return;
972    }
973    last_trim_time_ = NanoTime();
974    heap_trim_request_pending_ = false;
975  }
976  {
977    // Need to do this before acquiring the locks since we don't want to get suspended while
978    // holding any locks.
979    ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
980    // Pretend we are doing a GC to prevent background compaction from deleting the space we are
981    // trimming.
982    MutexLock mu(self, *gc_complete_lock_);
983    // Ensure there is only one GC at a time.
984    WaitForGcToCompleteLocked(kGcCauseTrim, self);
985    collector_type_running_ = kCollectorTypeHeapTrim;
986  }
987  uint64_t start_ns = NanoTime();
988  // Trim the managed spaces.
989  uint64_t total_alloc_space_allocated = 0;
990  uint64_t total_alloc_space_size = 0;
991  uint64_t managed_reclaimed = 0;
992  for (const auto& space : continuous_spaces_) {
993    if (space->IsMallocSpace()) {
994      gc::space::MallocSpace* malloc_space = space->AsMallocSpace();
995      if (malloc_space->IsRosAllocSpace() || !CareAboutPauseTimes()) {
996        // Don't trim dlmalloc spaces if we care about pauses since this can hold the space lock
997        // for a long period of time.
998        managed_reclaimed += malloc_space->Trim();
999      }
1000      total_alloc_space_size += malloc_space->Size();
1001    }
1002  }
1003  total_alloc_space_allocated = GetBytesAllocated() - large_object_space_->GetBytesAllocated();
1004  if (bump_pointer_space_ != nullptr) {
1005    total_alloc_space_allocated -= bump_pointer_space_->Size();
1006  }
1007  const float managed_utilization = static_cast<float>(total_alloc_space_allocated) /
1008      static_cast<float>(total_alloc_space_size);
1009  uint64_t gc_heap_end_ns = NanoTime();
1010  // We never move things in the native heap, so we can finish the GC at this point.
1011  FinishGC(self, collector::kGcTypeNone);
1012  size_t native_reclaimed = 0;
1013  // Only trim the native heap if we don't care about pauses.
1014  if (!CareAboutPauseTimes()) {
1015#if defined(USE_DLMALLOC)
1016    // Trim the native heap.
1017    dlmalloc_trim(0);
1018    dlmalloc_inspect_all(DlmallocMadviseCallback, &native_reclaimed);
1019#elif defined(USE_JEMALLOC)
1020    // Jemalloc does it's own internal trimming.
1021#else
1022    UNIMPLEMENTED(WARNING) << "Add trimming support";
1023#endif
1024  }
1025  uint64_t end_ns = NanoTime();
1026  VLOG(heap) << "Heap trim of managed (duration=" << PrettyDuration(gc_heap_end_ns - start_ns)
1027      << ", advised=" << PrettySize(managed_reclaimed) << ") and native (duration="
1028      << PrettyDuration(end_ns - gc_heap_end_ns) << ", advised=" << PrettySize(native_reclaimed)
1029      << ") heaps. Managed heap utilization of " << static_cast<int>(100 * managed_utilization)
1030      << "%.";
1031}
1032
1033bool Heap::IsValidObjectAddress(const mirror::Object* obj) const {
1034  // Note: we deliberately don't take the lock here, and mustn't test anything that would require
1035  // taking the lock.
1036  if (obj == nullptr) {
1037    return true;
1038  }
1039  return IsAligned<kObjectAlignment>(obj) && FindSpaceFromObject(obj, true) != nullptr;
1040}
1041
1042bool Heap::IsNonDiscontinuousSpaceHeapAddress(const mirror::Object* obj) const {
1043  return FindContinuousSpaceFromObject(obj, true) != nullptr;
1044}
1045
1046bool Heap::IsValidContinuousSpaceObjectAddress(const mirror::Object* obj) const {
1047  if (obj == nullptr || !IsAligned<kObjectAlignment>(obj)) {
1048    return false;
1049  }
1050  for (const auto& space : continuous_spaces_) {
1051    if (space->HasAddress(obj)) {
1052      return true;
1053    }
1054  }
1055  return false;
1056}
1057
1058bool Heap::IsLiveObjectLocked(mirror::Object* obj, bool search_allocation_stack,
1059                              bool search_live_stack, bool sorted) {
1060  if (UNLIKELY(!IsAligned<kObjectAlignment>(obj))) {
1061    return false;
1062  }
1063  if (bump_pointer_space_ != nullptr && bump_pointer_space_->HasAddress(obj)) {
1064    mirror::Class* klass = obj->GetClass<kVerifyNone>();
1065    if (obj == klass) {
1066      // This case happens for java.lang.Class.
1067      return true;
1068    }
1069    return VerifyClassClass(klass) && IsLiveObjectLocked(klass);
1070  } else if (temp_space_ != nullptr && temp_space_->HasAddress(obj)) {
1071    // If we are in the allocated region of the temp space, then we are probably live (e.g. during
1072    // a GC). When a GC isn't running End() - Begin() is 0 which means no objects are contained.
1073    return temp_space_->Contains(obj);
1074  }
1075  space::ContinuousSpace* c_space = FindContinuousSpaceFromObject(obj, true);
1076  space::DiscontinuousSpace* d_space = nullptr;
1077  if (c_space != nullptr) {
1078    if (c_space->GetLiveBitmap()->Test(obj)) {
1079      return true;
1080    }
1081  } else {
1082    d_space = FindDiscontinuousSpaceFromObject(obj, true);
1083    if (d_space != nullptr) {
1084      if (d_space->GetLiveBitmap()->Test(obj)) {
1085        return true;
1086      }
1087    }
1088  }
1089  // This is covering the allocation/live stack swapping that is done without mutators suspended.
1090  for (size_t i = 0; i < (sorted ? 1 : 5); ++i) {
1091    if (i > 0) {
1092      NanoSleep(MsToNs(10));
1093    }
1094    if (search_allocation_stack) {
1095      if (sorted) {
1096        if (allocation_stack_->ContainsSorted(obj)) {
1097          return true;
1098        }
1099      } else if (allocation_stack_->Contains(obj)) {
1100        return true;
1101      }
1102    }
1103
1104    if (search_live_stack) {
1105      if (sorted) {
1106        if (live_stack_->ContainsSorted(obj)) {
1107          return true;
1108        }
1109      } else if (live_stack_->Contains(obj)) {
1110        return true;
1111      }
1112    }
1113  }
1114  // We need to check the bitmaps again since there is a race where we mark something as live and
1115  // then clear the stack containing it.
1116  if (c_space != nullptr) {
1117    if (c_space->GetLiveBitmap()->Test(obj)) {
1118      return true;
1119    }
1120  } else {
1121    d_space = FindDiscontinuousSpaceFromObject(obj, true);
1122    if (d_space != nullptr && d_space->GetLiveBitmap()->Test(obj)) {
1123      return true;
1124    }
1125  }
1126  return false;
1127}
1128
1129void Heap::DumpSpaces(std::ostream& stream) {
1130  for (const auto& space : continuous_spaces_) {
1131    accounting::ContinuousSpaceBitmap* live_bitmap = space->GetLiveBitmap();
1132    accounting::ContinuousSpaceBitmap* mark_bitmap = space->GetMarkBitmap();
1133    stream << space << " " << *space << "\n";
1134    if (live_bitmap != nullptr) {
1135      stream << live_bitmap << " " << *live_bitmap << "\n";
1136    }
1137    if (mark_bitmap != nullptr) {
1138      stream << mark_bitmap << " " << *mark_bitmap << "\n";
1139    }
1140  }
1141  for (const auto& space : discontinuous_spaces_) {
1142    stream << space << " " << *space << "\n";
1143  }
1144}
1145
1146void Heap::VerifyObjectBody(mirror::Object* obj) {
1147  if (this == nullptr && verify_object_mode_ == kVerifyObjectModeDisabled) {
1148    return;
1149  }
1150  // Ignore early dawn of the universe verifications.
1151  if (UNLIKELY(static_cast<size_t>(num_bytes_allocated_.LoadRelaxed()) < 10 * KB)) {
1152    return;
1153  }
1154  CHECK(IsAligned<kObjectAlignment>(obj)) << "Object isn't aligned: " << obj;
1155  mirror::Class* c = obj->GetFieldObject<mirror::Class, kVerifyNone>(mirror::Object::ClassOffset());
1156  CHECK(c != nullptr) << "Null class in object " << obj;
1157  CHECK(IsAligned<kObjectAlignment>(c)) << "Class " << c << " not aligned in object " << obj;
1158  CHECK(VerifyClassClass(c));
1159
1160  if (verify_object_mode_ > kVerifyObjectModeFast) {
1161    // Note: the bitmap tests below are racy since we don't hold the heap bitmap lock.
1162    if (!IsLiveObjectLocked(obj)) {
1163      DumpSpaces();
1164      LOG(FATAL) << "Object is dead: " << obj;
1165    }
1166  }
1167}
1168
1169void Heap::VerificationCallback(mirror::Object* obj, void* arg) {
1170  reinterpret_cast<Heap*>(arg)->VerifyObjectBody(obj);
1171}
1172
1173void Heap::VerifyHeap() {
1174  ReaderMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
1175  GetLiveBitmap()->Walk(Heap::VerificationCallback, this);
1176}
1177
1178void Heap::RecordFree(uint64_t freed_objects, int64_t freed_bytes) {
1179  // Use signed comparison since freed bytes can be negative when background compaction foreground
1180  // transitions occurs. This is caused by the moving objects from a bump pointer space to a
1181  // free list backed space typically increasing memory footprint due to padding and binning.
1182  DCHECK_LE(freed_bytes, static_cast<int64_t>(num_bytes_allocated_.LoadRelaxed()));
1183  // Note: This relies on 2s complement for handling negative freed_bytes.
1184  num_bytes_allocated_.FetchAndSubSequentiallyConsistent(static_cast<ssize_t>(freed_bytes));
1185  if (Runtime::Current()->HasStatsEnabled()) {
1186    RuntimeStats* thread_stats = Thread::Current()->GetStats();
1187    thread_stats->freed_objects += freed_objects;
1188    thread_stats->freed_bytes += freed_bytes;
1189    // TODO: Do this concurrently.
1190    RuntimeStats* global_stats = Runtime::Current()->GetStats();
1191    global_stats->freed_objects += freed_objects;
1192    global_stats->freed_bytes += freed_bytes;
1193  }
1194}
1195
1196space::RosAllocSpace* Heap::GetRosAllocSpace(gc::allocator::RosAlloc* rosalloc) const {
1197  for (const auto& space : continuous_spaces_) {
1198    if (space->AsContinuousSpace()->IsRosAllocSpace()) {
1199      if (space->AsContinuousSpace()->AsRosAllocSpace()->GetRosAlloc() == rosalloc) {
1200        return space->AsContinuousSpace()->AsRosAllocSpace();
1201      }
1202    }
1203  }
1204  return nullptr;
1205}
1206
1207mirror::Object* Heap::AllocateInternalWithGc(Thread* self, AllocatorType allocator,
1208                                             size_t alloc_size, size_t* bytes_allocated,
1209                                             size_t* usable_size,
1210                                             mirror::Class** klass) {
1211  bool was_default_allocator = allocator == GetCurrentAllocator();
1212  DCHECK(klass != nullptr);
1213  StackHandleScope<1> hs(self);
1214  HandleWrapper<mirror::Class> h(hs.NewHandleWrapper(klass));
1215  klass = nullptr;  // Invalidate for safety.
1216  // The allocation failed. If the GC is running, block until it completes, and then retry the
1217  // allocation.
1218  collector::GcType last_gc = WaitForGcToComplete(kGcCauseForAlloc, self);
1219  if (last_gc != collector::kGcTypeNone) {
1220    // If we were the default allocator but the allocator changed while we were suspended,
1221    // abort the allocation.
1222    if (was_default_allocator && allocator != GetCurrentAllocator()) {
1223      return nullptr;
1224    }
1225    // A GC was in progress and we blocked, retry allocation now that memory has been freed.
1226    mirror::Object* ptr = TryToAllocate<true, false>(self, allocator, alloc_size, bytes_allocated,
1227                                                     usable_size);
1228    if (ptr != nullptr) {
1229      return ptr;
1230    }
1231  }
1232
1233  collector::GcType tried_type = next_gc_type_;
1234  const bool gc_ran =
1235      CollectGarbageInternal(tried_type, kGcCauseForAlloc, false) != collector::kGcTypeNone;
1236  if (was_default_allocator && allocator != GetCurrentAllocator()) {
1237    return nullptr;
1238  }
1239  if (gc_ran) {
1240    mirror::Object* ptr = TryToAllocate<true, false>(self, allocator, alloc_size, bytes_allocated,
1241                                                     usable_size);
1242    if (ptr != nullptr) {
1243      return ptr;
1244    }
1245  }
1246
1247  // Loop through our different Gc types and try to Gc until we get enough free memory.
1248  for (collector::GcType gc_type : gc_plan_) {
1249    if (gc_type == tried_type) {
1250      continue;
1251    }
1252    // Attempt to run the collector, if we succeed, re-try the allocation.
1253    const bool gc_ran =
1254        CollectGarbageInternal(gc_type, kGcCauseForAlloc, false) != collector::kGcTypeNone;
1255    if (was_default_allocator && allocator != GetCurrentAllocator()) {
1256      return nullptr;
1257    }
1258    if (gc_ran) {
1259      // Did we free sufficient memory for the allocation to succeed?
1260      mirror::Object* ptr = TryToAllocate<true, false>(self, allocator, alloc_size, bytes_allocated,
1261                                                       usable_size);
1262      if (ptr != nullptr) {
1263        return ptr;
1264      }
1265    }
1266  }
1267  // Allocations have failed after GCs;  this is an exceptional state.
1268  // Try harder, growing the heap if necessary.
1269  mirror::Object* ptr = TryToAllocate<true, true>(self, allocator, alloc_size, bytes_allocated,
1270                                                  usable_size);
1271  if (ptr != nullptr) {
1272    return ptr;
1273  }
1274  // Most allocations should have succeeded by now, so the heap is really full, really fragmented,
1275  // or the requested size is really big. Do another GC, collecting SoftReferences this time. The
1276  // VM spec requires that all SoftReferences have been collected and cleared before throwing
1277  // OOME.
1278  VLOG(gc) << "Forcing collection of SoftReferences for " << PrettySize(alloc_size)
1279           << " allocation";
1280  // TODO: Run finalization, but this may cause more allocations to occur.
1281  // We don't need a WaitForGcToComplete here either.
1282  DCHECK(!gc_plan_.empty());
1283  CollectGarbageInternal(gc_plan_.back(), kGcCauseForAlloc, true);
1284  if (was_default_allocator && allocator != GetCurrentAllocator()) {
1285    return nullptr;
1286  }
1287  ptr = TryToAllocate<true, true>(self, allocator, alloc_size, bytes_allocated, usable_size);
1288  if (ptr == nullptr && use_homogeneous_space_compaction_for_oom_) {
1289    const uint64_t current_time = NanoTime();
1290    if ((allocator == kAllocatorTypeRosAlloc || allocator == kAllocatorTypeDlMalloc) &&
1291        current_time - last_time_homogeneous_space_compaction_by_oom_ >
1292        min_interval_homogeneous_space_compaction_by_oom_) {
1293      last_time_homogeneous_space_compaction_by_oom_ = current_time;
1294      HomogeneousSpaceCompactResult result = PerformHomogeneousSpaceCompact();
1295      switch (result) {
1296        case HomogeneousSpaceCompactResult::kSuccess:
1297          // If the allocation succeeded, we delayed an oom.
1298          ptr = TryToAllocate<true, true>(self, allocator, alloc_size, bytes_allocated, usable_size);
1299          if (ptr != nullptr) {
1300            count_delayed_oom_++;
1301          }
1302          break;
1303        case HomogeneousSpaceCompactResult::kErrorReject:
1304          // Reject due to disabled moving GC.
1305          break;
1306        case HomogeneousSpaceCompactResult::kErrorVMShuttingDown:
1307          // Throw OOM by default.
1308          break;
1309        default: {
1310          LOG(FATAL) << "Unimplemented homogeneous space compaction result " << static_cast<size_t>(result);
1311        }
1312      }
1313      // Always print that we ran homogeneous space compation since this can cause jank.
1314      VLOG(heap) << "Ran heap homogeneous space compaction, "
1315                << " requested defragmentation "
1316                << count_requested_homogeneous_space_compaction_.LoadSequentiallyConsistent()
1317                << " performed defragmentation "
1318                << count_performed_homogeneous_space_compaction_.LoadSequentiallyConsistent()
1319                << " ignored homogeneous space compaction "
1320                << count_ignored_homogeneous_space_compaction_.LoadSequentiallyConsistent()
1321                << " delayed count = "
1322                << count_delayed_oom_.LoadSequentiallyConsistent();
1323    }
1324  }
1325  // If the allocation hasn't succeeded by this point, throw an OOM error.
1326  if (ptr == nullptr) {
1327    ThrowOutOfMemoryError(self, alloc_size, allocator);
1328  }
1329  return ptr;
1330}
1331
1332void Heap::SetTargetHeapUtilization(float target) {
1333  DCHECK_GT(target, 0.0f);  // asserted in Java code
1334  DCHECK_LT(target, 1.0f);
1335  target_utilization_ = target;
1336}
1337
1338size_t Heap::GetObjectsAllocated() const {
1339  size_t total = 0;
1340  for (space::AllocSpace* space : alloc_spaces_) {
1341    total += space->GetObjectsAllocated();
1342  }
1343  return total;
1344}
1345
1346size_t Heap::GetObjectsAllocatedEver() const {
1347  return GetObjectsFreedEver() + GetObjectsAllocated();
1348}
1349
1350size_t Heap::GetBytesAllocatedEver() const {
1351  return GetBytesFreedEver() + GetBytesAllocated();
1352}
1353
1354class InstanceCounter {
1355 public:
1356  InstanceCounter(const std::vector<mirror::Class*>& classes, bool use_is_assignable_from, uint64_t* counts)
1357      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
1358      : classes_(classes), use_is_assignable_from_(use_is_assignable_from), counts_(counts) {
1359  }
1360  static void Callback(mirror::Object* obj, void* arg)
1361      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
1362    InstanceCounter* instance_counter = reinterpret_cast<InstanceCounter*>(arg);
1363    mirror::Class* instance_class = obj->GetClass();
1364    CHECK(instance_class != nullptr);
1365    for (size_t i = 0; i < instance_counter->classes_.size(); ++i) {
1366      if (instance_counter->use_is_assignable_from_) {
1367        if (instance_counter->classes_[i]->IsAssignableFrom(instance_class)) {
1368          ++instance_counter->counts_[i];
1369        }
1370      } else if (instance_class == instance_counter->classes_[i]) {
1371        ++instance_counter->counts_[i];
1372      }
1373    }
1374  }
1375
1376 private:
1377  const std::vector<mirror::Class*>& classes_;
1378  bool use_is_assignable_from_;
1379  uint64_t* const counts_;
1380  DISALLOW_COPY_AND_ASSIGN(InstanceCounter);
1381};
1382
1383void Heap::CountInstances(const std::vector<mirror::Class*>& classes, bool use_is_assignable_from,
1384                          uint64_t* counts) {
1385  // Can't do any GC in this function since this may move classes.
1386  Thread* self = Thread::Current();
1387  auto* old_cause = self->StartAssertNoThreadSuspension("CountInstances");
1388  InstanceCounter counter(classes, use_is_assignable_from, counts);
1389  WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1390  VisitObjects(InstanceCounter::Callback, &counter);
1391  self->EndAssertNoThreadSuspension(old_cause);
1392}
1393
1394class InstanceCollector {
1395 public:
1396  InstanceCollector(mirror::Class* c, int32_t max_count, std::vector<mirror::Object*>& instances)
1397      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
1398      : class_(c), max_count_(max_count), instances_(instances) {
1399  }
1400  static void Callback(mirror::Object* obj, void* arg)
1401      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
1402    DCHECK(arg != nullptr);
1403    InstanceCollector* instance_collector = reinterpret_cast<InstanceCollector*>(arg);
1404    mirror::Class* instance_class = obj->GetClass();
1405    if (instance_class == instance_collector->class_) {
1406      if (instance_collector->max_count_ == 0 ||
1407          instance_collector->instances_.size() < instance_collector->max_count_) {
1408        instance_collector->instances_.push_back(obj);
1409      }
1410    }
1411  }
1412
1413 private:
1414  mirror::Class* class_;
1415  uint32_t max_count_;
1416  std::vector<mirror::Object*>& instances_;
1417  DISALLOW_COPY_AND_ASSIGN(InstanceCollector);
1418};
1419
1420void Heap::GetInstances(mirror::Class* c, int32_t max_count,
1421                        std::vector<mirror::Object*>& instances) {
1422  // Can't do any GC in this function since this may move classes.
1423  Thread* self = Thread::Current();
1424  auto* old_cause = self->StartAssertNoThreadSuspension("GetInstances");
1425  InstanceCollector collector(c, max_count, instances);
1426  WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1427  VisitObjects(&InstanceCollector::Callback, &collector);
1428  self->EndAssertNoThreadSuspension(old_cause);
1429}
1430
1431class ReferringObjectsFinder {
1432 public:
1433  ReferringObjectsFinder(mirror::Object* object, int32_t max_count,
1434                         std::vector<mirror::Object*>& referring_objects)
1435      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_)
1436      : object_(object), max_count_(max_count), referring_objects_(referring_objects) {
1437  }
1438
1439  static void Callback(mirror::Object* obj, void* arg)
1440      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
1441    reinterpret_cast<ReferringObjectsFinder*>(arg)->operator()(obj);
1442  }
1443
1444  // For bitmap Visit.
1445  // TODO: Fix lock analysis to not use NO_THREAD_SAFETY_ANALYSIS, requires support for
1446  // annotalysis on visitors.
1447  void operator()(mirror::Object* o) const NO_THREAD_SAFETY_ANALYSIS {
1448    o->VisitReferences<true>(*this, VoidFunctor());
1449  }
1450
1451  // For Object::VisitReferences.
1452  void operator()(mirror::Object* obj, MemberOffset offset, bool /* is_static */) const
1453      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1454    mirror::Object* ref = obj->GetFieldObject<mirror::Object>(offset);
1455    if (ref == object_ && (max_count_ == 0 || referring_objects_.size() < max_count_)) {
1456      referring_objects_.push_back(obj);
1457    }
1458  }
1459
1460 private:
1461  mirror::Object* object_;
1462  uint32_t max_count_;
1463  std::vector<mirror::Object*>& referring_objects_;
1464  DISALLOW_COPY_AND_ASSIGN(ReferringObjectsFinder);
1465};
1466
1467void Heap::GetReferringObjects(mirror::Object* o, int32_t max_count,
1468                               std::vector<mirror::Object*>& referring_objects) {
1469  // Can't do any GC in this function since this may move the object o.
1470  Thread* self = Thread::Current();
1471  auto* old_cause = self->StartAssertNoThreadSuspension("GetReferringObjects");
1472  ReferringObjectsFinder finder(o, max_count, referring_objects);
1473  WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1474  VisitObjects(&ReferringObjectsFinder::Callback, &finder);
1475  self->EndAssertNoThreadSuspension(old_cause);
1476}
1477
1478void Heap::CollectGarbage(bool clear_soft_references) {
1479  // Even if we waited for a GC we still need to do another GC since weaks allocated during the
1480  // last GC will not have necessarily been cleared.
1481  CollectGarbageInternal(gc_plan_.back(), kGcCauseExplicit, clear_soft_references);
1482}
1483
1484HomogeneousSpaceCompactResult Heap::PerformHomogeneousSpaceCompact() {
1485  Thread* self = Thread::Current();
1486  // Inc requested homogeneous space compaction.
1487  count_requested_homogeneous_space_compaction_++;
1488  // Store performed homogeneous space compaction at a new request arrival.
1489  ThreadList* tl = Runtime::Current()->GetThreadList();
1490  ScopedThreadStateChange tsc(self, kWaitingPerformingGc);
1491  Locks::mutator_lock_->AssertNotHeld(self);
1492  {
1493    ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
1494    MutexLock mu(self, *gc_complete_lock_);
1495    // Ensure there is only one GC at a time.
1496    WaitForGcToCompleteLocked(kGcCauseHomogeneousSpaceCompact, self);
1497    // Homogeneous space compaction is a copying transition, can't run it if the moving GC disable count
1498    // is non zero.
1499    // If the collecotr type changed to something which doesn't benefit from homogeneous space compaction,
1500    // exit.
1501    if (disable_moving_gc_count_ != 0 || IsMovingGc(collector_type_)) {
1502      return HomogeneousSpaceCompactResult::kErrorReject;
1503    }
1504    collector_type_running_ = kCollectorTypeHomogeneousSpaceCompact;
1505  }
1506  if (Runtime::Current()->IsShuttingDown(self)) {
1507    // Don't allow heap transitions to happen if the runtime is shutting down since these can
1508    // cause objects to get finalized.
1509    FinishGC(self, collector::kGcTypeNone);
1510    return HomogeneousSpaceCompactResult::kErrorVMShuttingDown;
1511  }
1512  // Suspend all threads.
1513  tl->SuspendAll();
1514  uint64_t start_time = NanoTime();
1515  // Launch compaction.
1516  space::MallocSpace* to_space = main_space_backup_;
1517  space::MallocSpace* from_space = main_space_;
1518  to_space->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1519  const uint64_t space_size_before_compaction = from_space->Size();
1520  Compact(to_space, from_space, kGcCauseHomogeneousSpaceCompact);
1521  // Leave as prot read so that we can still run ROSAlloc verification on this space.
1522  from_space->GetMemMap()->Protect(PROT_READ);
1523  const uint64_t space_size_after_compaction = to_space->Size();
1524  std::swap(main_space_, main_space_backup_);
1525  SetSpaceAsDefault(main_space_);  // Set as default to reset the proper dlmalloc space.
1526  // Update performed homogeneous space compaction count.
1527  count_performed_homogeneous_space_compaction_++;
1528  // Print statics log and resume all threads.
1529  uint64_t duration = NanoTime() - start_time;
1530  LOG(INFO) << "Heap homogeneous space compaction took " << PrettyDuration(duration) << " size: "
1531            << PrettySize(space_size_before_compaction) << " -> "
1532            << PrettySize(space_size_after_compaction) << " compact-ratio: "
1533            << std::fixed << static_cast<double>(space_size_after_compaction) /
1534            static_cast<double>(space_size_before_compaction);
1535  tl->ResumeAll();
1536  // Finish GC.
1537  reference_processor_.EnqueueClearedReferences(self);
1538  GrowForUtilization(semi_space_collector_);
1539  FinishGC(self, collector::kGcTypeFull);
1540  return HomogeneousSpaceCompactResult::kSuccess;
1541}
1542
1543
1544void Heap::TransitionCollector(CollectorType collector_type) {
1545  if (collector_type == collector_type_) {
1546    return;
1547  }
1548  VLOG(heap) << "TransitionCollector: " << static_cast<int>(collector_type_)
1549             << " -> " << static_cast<int>(collector_type);
1550  uint64_t start_time = NanoTime();
1551  uint32_t before_allocated = num_bytes_allocated_.LoadSequentiallyConsistent();
1552  Runtime* const runtime = Runtime::Current();
1553  ThreadList* const tl = runtime->GetThreadList();
1554  Thread* const self = Thread::Current();
1555  ScopedThreadStateChange tsc(self, kWaitingPerformingGc);
1556  Locks::mutator_lock_->AssertNotHeld(self);
1557  const bool copying_transition =
1558      IsMovingGc(background_collector_type_) || IsMovingGc(foreground_collector_type_);
1559  // Busy wait until we can GC (StartGC can fail if we have a non-zero
1560  // compacting_gc_disable_count_, this should rarely occurs).
1561  for (;;) {
1562    {
1563      ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
1564      MutexLock mu(self, *gc_complete_lock_);
1565      // Ensure there is only one GC at a time.
1566      WaitForGcToCompleteLocked(kGcCauseCollectorTransition, self);
1567      // If someone else beat us to it and changed the collector before we could, exit.
1568      // This is safe to do before the suspend all since we set the collector_type_running_ before
1569      // we exit the loop. If another thread attempts to do the heap transition before we exit,
1570      // then it would get blocked on WaitForGcToCompleteLocked.
1571      if (collector_type == collector_type_) {
1572        return;
1573      }
1574      // GC can be disabled if someone has a used GetPrimitiveArrayCritical but not yet released.
1575      if (!copying_transition || disable_moving_gc_count_ == 0) {
1576        // TODO: Not hard code in semi-space collector?
1577        collector_type_running_ = copying_transition ? kCollectorTypeSS : collector_type;
1578        break;
1579      }
1580    }
1581    usleep(1000);
1582  }
1583  if (runtime->IsShuttingDown(self)) {
1584    // Don't allow heap transitions to happen if the runtime is shutting down since these can
1585    // cause objects to get finalized.
1586    FinishGC(self, collector::kGcTypeNone);
1587    return;
1588  }
1589  tl->SuspendAll();
1590  switch (collector_type) {
1591    case kCollectorTypeSS:
1592      // Fall-through.
1593    case kCollectorTypeGSS: {
1594      if (!IsMovingGc(collector_type_)) {
1595        // We are transitioning from non moving GC -> moving GC, since we copied from the bump
1596        // pointer space last transition it will be protected.
1597        bump_pointer_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1598        Compact(bump_pointer_space_, main_space_, kGcCauseCollectorTransition);
1599        // Remove the main space so that we don't try to trim it, this doens't work for debug
1600        // builds since RosAlloc attempts to read the magic number from a protected page.
1601        RemoveSpace(main_space_);
1602      }
1603      break;
1604    }
1605    case kCollectorTypeMS:
1606      // Fall through.
1607    case kCollectorTypeCMS: {
1608      if (IsMovingGc(collector_type_)) {
1609        // Compact to the main space from the bump pointer space, don't need to swap semispaces.
1610        AddSpace(main_space_);
1611        main_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1612        Compact(main_space_, bump_pointer_space_, kGcCauseCollectorTransition);
1613      }
1614      break;
1615    }
1616    default: {
1617      LOG(FATAL) << "Attempted to transition to invalid collector type "
1618                 << static_cast<size_t>(collector_type);
1619      break;
1620    }
1621  }
1622  ChangeCollector(collector_type);
1623  tl->ResumeAll();
1624  // Can't call into java code with all threads suspended.
1625  reference_processor_.EnqueueClearedReferences(self);
1626  uint64_t duration = NanoTime() - start_time;
1627  GrowForUtilization(semi_space_collector_);
1628  FinishGC(self, collector::kGcTypeFull);
1629  int32_t after_allocated = num_bytes_allocated_.LoadSequentiallyConsistent();
1630  int32_t delta_allocated = before_allocated - after_allocated;
1631  std::string saved_str;
1632  if (delta_allocated >= 0) {
1633    saved_str = " saved at least " + PrettySize(delta_allocated);
1634  } else {
1635    saved_str = " expanded " + PrettySize(-delta_allocated);
1636  }
1637  LOG(INFO) << "Heap transition to " << process_state_ << " took "
1638      << PrettyDuration(duration) << saved_str;
1639}
1640
1641void Heap::ChangeCollector(CollectorType collector_type) {
1642  // TODO: Only do this with all mutators suspended to avoid races.
1643  if (collector_type != collector_type_) {
1644    if (collector_type == kCollectorTypeMC) {
1645      // Don't allow mark compact unless support is compiled in.
1646      CHECK(kMarkCompactSupport);
1647    }
1648    collector_type_ = collector_type;
1649    gc_plan_.clear();
1650    switch (collector_type_) {
1651      case kCollectorTypeCC:  // Fall-through.
1652      case kCollectorTypeMC:  // Fall-through.
1653      case kCollectorTypeSS:  // Fall-through.
1654      case kCollectorTypeGSS: {
1655        gc_plan_.push_back(collector::kGcTypeFull);
1656        if (use_tlab_) {
1657          ChangeAllocator(kAllocatorTypeTLAB);
1658        } else {
1659          ChangeAllocator(kAllocatorTypeBumpPointer);
1660        }
1661        break;
1662      }
1663      case kCollectorTypeMS: {
1664        gc_plan_.push_back(collector::kGcTypeSticky);
1665        gc_plan_.push_back(collector::kGcTypePartial);
1666        gc_plan_.push_back(collector::kGcTypeFull);
1667        ChangeAllocator(kUseRosAlloc ? kAllocatorTypeRosAlloc : kAllocatorTypeDlMalloc);
1668        break;
1669      }
1670      case kCollectorTypeCMS: {
1671        gc_plan_.push_back(collector::kGcTypeSticky);
1672        gc_plan_.push_back(collector::kGcTypePartial);
1673        gc_plan_.push_back(collector::kGcTypeFull);
1674        ChangeAllocator(kUseRosAlloc ? kAllocatorTypeRosAlloc : kAllocatorTypeDlMalloc);
1675        break;
1676      }
1677      default: {
1678        LOG(FATAL) << "Unimplemented";
1679      }
1680    }
1681    if (IsGcConcurrent()) {
1682      concurrent_start_bytes_ =
1683          std::max(max_allowed_footprint_, kMinConcurrentRemainingBytes) - kMinConcurrentRemainingBytes;
1684    } else {
1685      concurrent_start_bytes_ = std::numeric_limits<size_t>::max();
1686    }
1687  }
1688}
1689
1690// Special compacting collector which uses sub-optimal bin packing to reduce zygote space size.
1691class ZygoteCompactingCollector FINAL : public collector::SemiSpace {
1692 public:
1693  explicit ZygoteCompactingCollector(gc::Heap* heap) : SemiSpace(heap, false, "zygote collector"),
1694      bin_live_bitmap_(nullptr), bin_mark_bitmap_(nullptr) {
1695  }
1696
1697  void BuildBins(space::ContinuousSpace* space) {
1698    bin_live_bitmap_ = space->GetLiveBitmap();
1699    bin_mark_bitmap_ = space->GetMarkBitmap();
1700    BinContext context;
1701    context.prev_ = reinterpret_cast<uintptr_t>(space->Begin());
1702    context.collector_ = this;
1703    WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
1704    // Note: This requires traversing the space in increasing order of object addresses.
1705    bin_live_bitmap_->Walk(Callback, reinterpret_cast<void*>(&context));
1706    // Add the last bin which spans after the last object to the end of the space.
1707    AddBin(reinterpret_cast<uintptr_t>(space->End()) - context.prev_, context.prev_);
1708  }
1709
1710 private:
1711  struct BinContext {
1712    uintptr_t prev_;  // The end of the previous object.
1713    ZygoteCompactingCollector* collector_;
1714  };
1715  // Maps from bin sizes to locations.
1716  std::multimap<size_t, uintptr_t> bins_;
1717  // Live bitmap of the space which contains the bins.
1718  accounting::ContinuousSpaceBitmap* bin_live_bitmap_;
1719  // Mark bitmap of the space which contains the bins.
1720  accounting::ContinuousSpaceBitmap* bin_mark_bitmap_;
1721
1722  static void Callback(mirror::Object* obj, void* arg)
1723      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1724    DCHECK(arg != nullptr);
1725    BinContext* context = reinterpret_cast<BinContext*>(arg);
1726    ZygoteCompactingCollector* collector = context->collector_;
1727    uintptr_t object_addr = reinterpret_cast<uintptr_t>(obj);
1728    size_t bin_size = object_addr - context->prev_;
1729    // Add the bin consisting of the end of the previous object to the start of the current object.
1730    collector->AddBin(bin_size, context->prev_);
1731    context->prev_ = object_addr + RoundUp(obj->SizeOf(), kObjectAlignment);
1732  }
1733
1734  void AddBin(size_t size, uintptr_t position) {
1735    if (size != 0) {
1736      bins_.insert(std::make_pair(size, position));
1737    }
1738  }
1739
1740  virtual bool ShouldSweepSpace(space::ContinuousSpace* space) const {
1741    // Don't sweep any spaces since we probably blasted the internal accounting of the free list
1742    // allocator.
1743    return false;
1744  }
1745
1746  virtual mirror::Object* MarkNonForwardedObject(mirror::Object* obj)
1747      EXCLUSIVE_LOCKS_REQUIRED(Locks::heap_bitmap_lock_, Locks::mutator_lock_) {
1748    size_t object_size = RoundUp(obj->SizeOf(), kObjectAlignment);
1749    mirror::Object* forward_address;
1750    // Find the smallest bin which we can move obj in.
1751    auto it = bins_.lower_bound(object_size);
1752    if (it == bins_.end()) {
1753      // No available space in the bins, place it in the target space instead (grows the zygote
1754      // space).
1755      size_t bytes_allocated;
1756      forward_address = to_space_->Alloc(self_, object_size, &bytes_allocated, nullptr);
1757      if (to_space_live_bitmap_ != nullptr) {
1758        to_space_live_bitmap_->Set(forward_address);
1759      } else {
1760        GetHeap()->GetNonMovingSpace()->GetLiveBitmap()->Set(forward_address);
1761        GetHeap()->GetNonMovingSpace()->GetMarkBitmap()->Set(forward_address);
1762      }
1763    } else {
1764      size_t size = it->first;
1765      uintptr_t pos = it->second;
1766      bins_.erase(it);  // Erase the old bin which we replace with the new smaller bin.
1767      forward_address = reinterpret_cast<mirror::Object*>(pos);
1768      // Set the live and mark bits so that sweeping system weaks works properly.
1769      bin_live_bitmap_->Set(forward_address);
1770      bin_mark_bitmap_->Set(forward_address);
1771      DCHECK_GE(size, object_size);
1772      AddBin(size - object_size, pos + object_size);  // Add a new bin with the remaining space.
1773    }
1774    // Copy the object over to its new location.
1775    memcpy(reinterpret_cast<void*>(forward_address), obj, object_size);
1776    if (kUseBakerOrBrooksReadBarrier) {
1777      obj->AssertReadBarrierPointer();
1778      if (kUseBrooksReadBarrier) {
1779        DCHECK_EQ(forward_address->GetReadBarrierPointer(), obj);
1780        forward_address->SetReadBarrierPointer(forward_address);
1781      }
1782      forward_address->AssertReadBarrierPointer();
1783    }
1784    return forward_address;
1785  }
1786};
1787
1788void Heap::UnBindBitmaps() {
1789  TimingLogger::ScopedTiming t("UnBindBitmaps", GetCurrentGcIteration()->GetTimings());
1790  for (const auto& space : GetContinuousSpaces()) {
1791    if (space->IsContinuousMemMapAllocSpace()) {
1792      space::ContinuousMemMapAllocSpace* alloc_space = space->AsContinuousMemMapAllocSpace();
1793      if (alloc_space->HasBoundBitmaps()) {
1794        alloc_space->UnBindBitmaps();
1795      }
1796    }
1797  }
1798}
1799
1800void Heap::PreZygoteFork() {
1801  CollectGarbageInternal(collector::kGcTypeFull, kGcCauseBackground, false);
1802  Thread* self = Thread::Current();
1803  MutexLock mu(self, zygote_creation_lock_);
1804  // Try to see if we have any Zygote spaces.
1805  if (have_zygote_space_) {
1806    return;
1807  }
1808  VLOG(heap) << "Starting PreZygoteFork";
1809  // Trim the pages at the end of the non moving space.
1810  non_moving_space_->Trim();
1811  // The end of the non-moving space may be protected, unprotect it so that we can copy the zygote
1812  // there.
1813  non_moving_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1814  // Change the collector to the post zygote one.
1815  if (kCompactZygote) {
1816    DCHECK(semi_space_collector_ != nullptr);
1817    // Temporarily disable rosalloc verification because the zygote
1818    // compaction will mess up the rosalloc internal metadata.
1819    ScopedDisableRosAllocVerification disable_rosalloc_verif(this);
1820    ZygoteCompactingCollector zygote_collector(this);
1821    zygote_collector.BuildBins(non_moving_space_);
1822    // Create a new bump pointer space which we will compact into.
1823    space::BumpPointerSpace target_space("zygote bump space", non_moving_space_->End(),
1824                                         non_moving_space_->Limit());
1825    // Compact the bump pointer space to a new zygote bump pointer space.
1826    bool reset_main_space = false;
1827    if (IsMovingGc(collector_type_)) {
1828      zygote_collector.SetFromSpace(bump_pointer_space_);
1829    } else {
1830      CHECK(main_space_ != nullptr);
1831      // Copy from the main space.
1832      zygote_collector.SetFromSpace(main_space_);
1833      reset_main_space = true;
1834    }
1835    zygote_collector.SetToSpace(&target_space);
1836    zygote_collector.SetSwapSemiSpaces(false);
1837    zygote_collector.Run(kGcCauseCollectorTransition, false);
1838    if (reset_main_space) {
1839      main_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1840      madvise(main_space_->Begin(), main_space_->Capacity(), MADV_DONTNEED);
1841      MemMap* mem_map = main_space_->ReleaseMemMap();
1842      RemoveSpace(main_space_);
1843      space::Space* old_main_space = main_space_;
1844      CreateMainMallocSpace(mem_map, kDefaultInitialSize, mem_map->Size(), mem_map->Size());
1845      delete old_main_space;
1846      AddSpace(main_space_);
1847    } else {
1848      bump_pointer_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
1849    }
1850    if (temp_space_ != nullptr) {
1851      CHECK(temp_space_->IsEmpty());
1852    }
1853    total_objects_freed_ever_ += GetCurrentGcIteration()->GetFreedObjects();
1854    total_bytes_freed_ever_ += GetCurrentGcIteration()->GetFreedBytes();
1855    // Update the end and write out image.
1856    non_moving_space_->SetEnd(target_space.End());
1857    non_moving_space_->SetLimit(target_space.Limit());
1858    VLOG(heap) << "Zygote space size " << non_moving_space_->Size() << " bytes";
1859  }
1860  ChangeCollector(foreground_collector_type_);
1861  // Save the old space so that we can remove it after we complete creating the zygote space.
1862  space::MallocSpace* old_alloc_space = non_moving_space_;
1863  // Turn the current alloc space into a zygote space and obtain the new alloc space composed of
1864  // the remaining available space.
1865  // Remove the old space before creating the zygote space since creating the zygote space sets
1866  // the old alloc space's bitmaps to nullptr.
1867  RemoveSpace(old_alloc_space);
1868  if (collector::SemiSpace::kUseRememberedSet) {
1869    // Sanity bound check.
1870    FindRememberedSetFromSpace(old_alloc_space)->AssertAllDirtyCardsAreWithinSpace();
1871    // Remove the remembered set for the now zygote space (the old
1872    // non-moving space). Note now that we have compacted objects into
1873    // the zygote space, the data in the remembered set is no longer
1874    // needed. The zygote space will instead have a mod-union table
1875    // from this point on.
1876    RemoveRememberedSet(old_alloc_space);
1877  }
1878  space::ZygoteSpace* zygote_space = old_alloc_space->CreateZygoteSpace("alloc space",
1879                                                                        low_memory_mode_,
1880                                                                        &non_moving_space_);
1881  delete old_alloc_space;
1882  CHECK(zygote_space != nullptr) << "Failed creating zygote space";
1883  AddSpace(zygote_space);
1884  non_moving_space_->SetFootprintLimit(non_moving_space_->Capacity());
1885  AddSpace(non_moving_space_);
1886  have_zygote_space_ = true;
1887  // Enable large object space allocations.
1888  large_object_threshold_ = kDefaultLargeObjectThreshold;
1889  // Create the zygote space mod union table.
1890  accounting::ModUnionTable* mod_union_table =
1891      new accounting::ModUnionTableCardCache("zygote space mod-union table", this, zygote_space);
1892  CHECK(mod_union_table != nullptr) << "Failed to create zygote space mod-union table";
1893  AddModUnionTable(mod_union_table);
1894  if (collector::SemiSpace::kUseRememberedSet) {
1895    // Add a new remembered set for the post-zygote non-moving space.
1896    accounting::RememberedSet* post_zygote_non_moving_space_rem_set =
1897        new accounting::RememberedSet("Post-zygote non-moving space remembered set", this,
1898                                      non_moving_space_);
1899    CHECK(post_zygote_non_moving_space_rem_set != nullptr)
1900        << "Failed to create post-zygote non-moving space remembered set";
1901    AddRememberedSet(post_zygote_non_moving_space_rem_set);
1902  }
1903}
1904
1905void Heap::FlushAllocStack() {
1906  MarkAllocStackAsLive(allocation_stack_.get());
1907  allocation_stack_->Reset();
1908}
1909
1910void Heap::MarkAllocStack(accounting::ContinuousSpaceBitmap* bitmap1,
1911                          accounting::ContinuousSpaceBitmap* bitmap2,
1912                          accounting::LargeObjectBitmap* large_objects,
1913                          accounting::ObjectStack* stack) {
1914  DCHECK(bitmap1 != nullptr);
1915  DCHECK(bitmap2 != nullptr);
1916  mirror::Object** limit = stack->End();
1917  for (mirror::Object** it = stack->Begin(); it != limit; ++it) {
1918    const mirror::Object* obj = *it;
1919    if (!kUseThreadLocalAllocationStack || obj != nullptr) {
1920      if (bitmap1->HasAddress(obj)) {
1921        bitmap1->Set(obj);
1922      } else if (bitmap2->HasAddress(obj)) {
1923        bitmap2->Set(obj);
1924      } else {
1925        large_objects->Set(obj);
1926      }
1927    }
1928  }
1929}
1930
1931void Heap::SwapSemiSpaces() {
1932  CHECK(bump_pointer_space_ != nullptr);
1933  CHECK(temp_space_ != nullptr);
1934  std::swap(bump_pointer_space_, temp_space_);
1935}
1936
1937void Heap::Compact(space::ContinuousMemMapAllocSpace* target_space,
1938                   space::ContinuousMemMapAllocSpace* source_space,
1939                   GcCause gc_cause) {
1940  CHECK(kMovingCollector);
1941  if (target_space != source_space) {
1942    // Don't swap spaces since this isn't a typical semi space collection.
1943    semi_space_collector_->SetSwapSemiSpaces(false);
1944    semi_space_collector_->SetFromSpace(source_space);
1945    semi_space_collector_->SetToSpace(target_space);
1946    semi_space_collector_->Run(gc_cause, false);
1947  } else {
1948    CHECK(target_space->IsBumpPointerSpace())
1949        << "In-place compaction is only supported for bump pointer spaces";
1950    mark_compact_collector_->SetSpace(target_space->AsBumpPointerSpace());
1951    mark_compact_collector_->Run(kGcCauseCollectorTransition, false);
1952  }
1953}
1954
1955collector::GcType Heap::CollectGarbageInternal(collector::GcType gc_type, GcCause gc_cause,
1956                                               bool clear_soft_references) {
1957  Thread* self = Thread::Current();
1958  Runtime* runtime = Runtime::Current();
1959  // If the heap can't run the GC, silently fail and return that no GC was run.
1960  switch (gc_type) {
1961    case collector::kGcTypePartial: {
1962      if (!have_zygote_space_) {
1963        return collector::kGcTypeNone;
1964      }
1965      break;
1966    }
1967    default: {
1968      // Other GC types don't have any special cases which makes them not runnable. The main case
1969      // here is full GC.
1970    }
1971  }
1972  ScopedThreadStateChange tsc(self, kWaitingPerformingGc);
1973  Locks::mutator_lock_->AssertNotHeld(self);
1974  if (self->IsHandlingStackOverflow()) {
1975    LOG(WARNING) << "Performing GC on a thread that is handling a stack overflow.";
1976  }
1977  bool compacting_gc;
1978  {
1979    gc_complete_lock_->AssertNotHeld(self);
1980    ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
1981    MutexLock mu(self, *gc_complete_lock_);
1982    // Ensure there is only one GC at a time.
1983    WaitForGcToCompleteLocked(gc_cause, self);
1984    compacting_gc = IsMovingGc(collector_type_);
1985    // GC can be disabled if someone has a used GetPrimitiveArrayCritical.
1986    if (compacting_gc && disable_moving_gc_count_ != 0) {
1987      LOG(WARNING) << "Skipping GC due to disable moving GC count " << disable_moving_gc_count_;
1988      return collector::kGcTypeNone;
1989    }
1990    collector_type_running_ = collector_type_;
1991  }
1992
1993  if (gc_cause == kGcCauseForAlloc && runtime->HasStatsEnabled()) {
1994    ++runtime->GetStats()->gc_for_alloc_count;
1995    ++self->GetStats()->gc_for_alloc_count;
1996  }
1997  uint64_t gc_start_time_ns = NanoTime();
1998  uint64_t gc_start_size = GetBytesAllocated();
1999  // Approximate allocation rate in bytes / second.
2000  uint64_t ms_delta = NsToMs(gc_start_time_ns - last_gc_time_ns_);
2001  // Back to back GCs can cause 0 ms of wait time in between GC invocations.
2002  if (LIKELY(ms_delta != 0)) {
2003    allocation_rate_ = ((gc_start_size - last_gc_size_) * 1000) / ms_delta;
2004    VLOG(heap) << "Allocation rate: " << PrettySize(allocation_rate_) << "/s";
2005  }
2006
2007  DCHECK_LT(gc_type, collector::kGcTypeMax);
2008  DCHECK_NE(gc_type, collector::kGcTypeNone);
2009
2010  collector::GarbageCollector* collector = nullptr;
2011  // TODO: Clean this up.
2012  if (compacting_gc) {
2013    DCHECK(current_allocator_ == kAllocatorTypeBumpPointer ||
2014           current_allocator_ == kAllocatorTypeTLAB);
2015    switch (collector_type_) {
2016      case kCollectorTypeSS:
2017        // Fall-through.
2018      case kCollectorTypeGSS:
2019        semi_space_collector_->SetFromSpace(bump_pointer_space_);
2020        semi_space_collector_->SetToSpace(temp_space_);
2021        semi_space_collector_->SetSwapSemiSpaces(true);
2022        collector = semi_space_collector_;
2023        break;
2024      case kCollectorTypeCC:
2025        collector = concurrent_copying_collector_;
2026        break;
2027      case kCollectorTypeMC:
2028        mark_compact_collector_->SetSpace(bump_pointer_space_);
2029        collector = mark_compact_collector_;
2030        break;
2031      default:
2032        LOG(FATAL) << "Invalid collector type " << static_cast<size_t>(collector_type_);
2033    }
2034    if (collector != mark_compact_collector_) {
2035      temp_space_->GetMemMap()->Protect(PROT_READ | PROT_WRITE);
2036      CHECK(temp_space_->IsEmpty());
2037    }
2038    gc_type = collector::kGcTypeFull;  // TODO: Not hard code this in.
2039  } else if (current_allocator_ == kAllocatorTypeRosAlloc ||
2040      current_allocator_ == kAllocatorTypeDlMalloc) {
2041    collector = FindCollectorByGcType(gc_type);
2042  } else {
2043    LOG(FATAL) << "Invalid current allocator " << current_allocator_;
2044  }
2045  CHECK(collector != nullptr)
2046      << "Could not find garbage collector with collector_type="
2047      << static_cast<size_t>(collector_type_) << " and gc_type=" << gc_type;
2048  collector->Run(gc_cause, clear_soft_references || runtime->IsZygote());
2049  total_objects_freed_ever_ += GetCurrentGcIteration()->GetFreedObjects();
2050  total_bytes_freed_ever_ += GetCurrentGcIteration()->GetFreedBytes();
2051  RequestHeapTrim();
2052  // Enqueue cleared references.
2053  reference_processor_.EnqueueClearedReferences(self);
2054  // Grow the heap so that we know when to perform the next GC.
2055  GrowForUtilization(collector);
2056  const size_t duration = GetCurrentGcIteration()->GetDurationNs();
2057  const std::vector<uint64_t>& pause_times = GetCurrentGcIteration()->GetPauseTimes();
2058  // Print the GC if it is an explicit GC (e.g. Runtime.gc()) or a slow GC
2059  // (mutator time blocked >= long_pause_log_threshold_).
2060  bool log_gc = gc_cause == kGcCauseExplicit;
2061  if (!log_gc && CareAboutPauseTimes()) {
2062    // GC for alloc pauses the allocating thread, so consider it as a pause.
2063    log_gc = duration > long_gc_log_threshold_ ||
2064        (gc_cause == kGcCauseForAlloc && duration > long_pause_log_threshold_);
2065    for (uint64_t pause : pause_times) {
2066      log_gc = log_gc || pause >= long_pause_log_threshold_;
2067    }
2068  }
2069  if (log_gc) {
2070    const size_t percent_free = GetPercentFree();
2071    const size_t current_heap_size = GetBytesAllocated();
2072    const size_t total_memory = GetTotalMemory();
2073    std::ostringstream pause_string;
2074    for (size_t i = 0; i < pause_times.size(); ++i) {
2075        pause_string << PrettyDuration((pause_times[i] / 1000) * 1000)
2076                     << ((i != pause_times.size() - 1) ? "," : "");
2077    }
2078    LOG(INFO) << gc_cause << " " << collector->GetName()
2079              << " GC freed "  << current_gc_iteration_.GetFreedObjects() << "("
2080              << PrettySize(current_gc_iteration_.GetFreedBytes()) << ") AllocSpace objects, "
2081              << current_gc_iteration_.GetFreedLargeObjects() << "("
2082              << PrettySize(current_gc_iteration_.GetFreedLargeObjectBytes()) << ") LOS objects, "
2083              << percent_free << "% free, " << PrettySize(current_heap_size) << "/"
2084              << PrettySize(total_memory) << ", " << "paused " << pause_string.str()
2085              << " total " << PrettyDuration((duration / 1000) * 1000);
2086    VLOG(heap) << ConstDumpable<TimingLogger>(*current_gc_iteration_.GetTimings());
2087  }
2088  FinishGC(self, gc_type);
2089  // Inform DDMS that a GC completed.
2090  Dbg::GcDidFinish();
2091  return gc_type;
2092}
2093
2094void Heap::FinishGC(Thread* self, collector::GcType gc_type) {
2095  MutexLock mu(self, *gc_complete_lock_);
2096  collector_type_running_ = kCollectorTypeNone;
2097  if (gc_type != collector::kGcTypeNone) {
2098    last_gc_type_ = gc_type;
2099  }
2100  // Wake anyone who may have been waiting for the GC to complete.
2101  gc_complete_cond_->Broadcast(self);
2102}
2103
2104static void RootMatchesObjectVisitor(mirror::Object** root, void* arg, uint32_t /*thread_id*/,
2105                                     RootType /*root_type*/) {
2106  mirror::Object* obj = reinterpret_cast<mirror::Object*>(arg);
2107  if (*root == obj) {
2108    LOG(INFO) << "Object " << obj << " is a root";
2109  }
2110}
2111
2112class ScanVisitor {
2113 public:
2114  void operator()(const mirror::Object* obj) const {
2115    LOG(ERROR) << "Would have rescanned object " << obj;
2116  }
2117};
2118
2119// Verify a reference from an object.
2120class VerifyReferenceVisitor {
2121 public:
2122  explicit VerifyReferenceVisitor(Heap* heap, Atomic<size_t>* fail_count, bool verify_referent)
2123      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_)
2124      : heap_(heap), fail_count_(fail_count), verify_referent_(verify_referent) {}
2125
2126  size_t GetFailureCount() const {
2127    return fail_count_->LoadSequentiallyConsistent();
2128  }
2129
2130  void operator()(mirror::Class* klass, mirror::Reference* ref) const
2131      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2132    if (verify_referent_) {
2133      VerifyReference(ref, ref->GetReferent(), mirror::Reference::ReferentOffset());
2134    }
2135  }
2136
2137  void operator()(mirror::Object* obj, MemberOffset offset, bool /*is_static*/) const
2138      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2139    VerifyReference(obj, obj->GetFieldObject<mirror::Object>(offset), offset);
2140  }
2141
2142  bool IsLive(mirror::Object* obj) const NO_THREAD_SAFETY_ANALYSIS {
2143    return heap_->IsLiveObjectLocked(obj, true, false, true);
2144  }
2145
2146  static void VerifyRootCallback(mirror::Object** root, void* arg, uint32_t thread_id,
2147                                 RootType root_type) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2148    VerifyReferenceVisitor* visitor = reinterpret_cast<VerifyReferenceVisitor*>(arg);
2149    if (!visitor->VerifyReference(nullptr, *root, MemberOffset(0))) {
2150      LOG(ERROR) << "Root " << *root << " is dead with type " << PrettyTypeOf(*root)
2151          << " thread_id= " << thread_id << " root_type= " << root_type;
2152    }
2153  }
2154
2155 private:
2156  // TODO: Fix the no thread safety analysis.
2157  // Returns false on failure.
2158  bool VerifyReference(mirror::Object* obj, mirror::Object* ref, MemberOffset offset) const
2159      NO_THREAD_SAFETY_ANALYSIS {
2160    if (ref == nullptr || IsLive(ref)) {
2161      // Verify that the reference is live.
2162      return true;
2163    }
2164    if (fail_count_->FetchAndAddSequentiallyConsistent(1) == 0) {
2165      // Print message on only on first failure to prevent spam.
2166      LOG(ERROR) << "!!!!!!!!!!!!!!Heap corruption detected!!!!!!!!!!!!!!!!!!!";
2167    }
2168    if (obj != nullptr) {
2169      // Only do this part for non roots.
2170      accounting::CardTable* card_table = heap_->GetCardTable();
2171      accounting::ObjectStack* alloc_stack = heap_->allocation_stack_.get();
2172      accounting::ObjectStack* live_stack = heap_->live_stack_.get();
2173      byte* card_addr = card_table->CardFromAddr(obj);
2174      LOG(ERROR) << "Object " << obj << " references dead object " << ref << " at offset "
2175                 << offset << "\n card value = " << static_cast<int>(*card_addr);
2176      if (heap_->IsValidObjectAddress(obj->GetClass())) {
2177        LOG(ERROR) << "Obj type " << PrettyTypeOf(obj);
2178      } else {
2179        LOG(ERROR) << "Object " << obj << " class(" << obj->GetClass() << ") not a heap address";
2180      }
2181
2182      // Attmept to find the class inside of the recently freed objects.
2183      space::ContinuousSpace* ref_space = heap_->FindContinuousSpaceFromObject(ref, true);
2184      if (ref_space != nullptr && ref_space->IsMallocSpace()) {
2185        space::MallocSpace* space = ref_space->AsMallocSpace();
2186        mirror::Class* ref_class = space->FindRecentFreedObject(ref);
2187        if (ref_class != nullptr) {
2188          LOG(ERROR) << "Reference " << ref << " found as a recently freed object with class "
2189                     << PrettyClass(ref_class);
2190        } else {
2191          LOG(ERROR) << "Reference " << ref << " not found as a recently freed object";
2192        }
2193      }
2194
2195      if (ref->GetClass() != nullptr && heap_->IsValidObjectAddress(ref->GetClass()) &&
2196          ref->GetClass()->IsClass()) {
2197        LOG(ERROR) << "Ref type " << PrettyTypeOf(ref);
2198      } else {
2199        LOG(ERROR) << "Ref " << ref << " class(" << ref->GetClass()
2200                   << ") is not a valid heap address";
2201      }
2202
2203      card_table->CheckAddrIsInCardTable(reinterpret_cast<const byte*>(obj));
2204      void* cover_begin = card_table->AddrFromCard(card_addr);
2205      void* cover_end = reinterpret_cast<void*>(reinterpret_cast<size_t>(cover_begin) +
2206          accounting::CardTable::kCardSize);
2207      LOG(ERROR) << "Card " << reinterpret_cast<void*>(card_addr) << " covers " << cover_begin
2208          << "-" << cover_end;
2209      accounting::ContinuousSpaceBitmap* bitmap =
2210          heap_->GetLiveBitmap()->GetContinuousSpaceBitmap(obj);
2211
2212      if (bitmap == nullptr) {
2213        LOG(ERROR) << "Object " << obj << " has no bitmap";
2214        if (!VerifyClassClass(obj->GetClass())) {
2215          LOG(ERROR) << "Object " << obj << " failed class verification!";
2216        }
2217      } else {
2218        // Print out how the object is live.
2219        if (bitmap->Test(obj)) {
2220          LOG(ERROR) << "Object " << obj << " found in live bitmap";
2221        }
2222        if (alloc_stack->Contains(const_cast<mirror::Object*>(obj))) {
2223          LOG(ERROR) << "Object " << obj << " found in allocation stack";
2224        }
2225        if (live_stack->Contains(const_cast<mirror::Object*>(obj))) {
2226          LOG(ERROR) << "Object " << obj << " found in live stack";
2227        }
2228        if (alloc_stack->Contains(const_cast<mirror::Object*>(ref))) {
2229          LOG(ERROR) << "Ref " << ref << " found in allocation stack";
2230        }
2231        if (live_stack->Contains(const_cast<mirror::Object*>(ref))) {
2232          LOG(ERROR) << "Ref " << ref << " found in live stack";
2233        }
2234        // Attempt to see if the card table missed the reference.
2235        ScanVisitor scan_visitor;
2236        byte* byte_cover_begin = reinterpret_cast<byte*>(card_table->AddrFromCard(card_addr));
2237        card_table->Scan(bitmap, byte_cover_begin,
2238                         byte_cover_begin + accounting::CardTable::kCardSize, scan_visitor);
2239      }
2240
2241      // Search to see if any of the roots reference our object.
2242      void* arg = const_cast<void*>(reinterpret_cast<const void*>(obj));
2243      Runtime::Current()->VisitRoots(&RootMatchesObjectVisitor, arg);
2244
2245      // Search to see if any of the roots reference our reference.
2246      arg = const_cast<void*>(reinterpret_cast<const void*>(ref));
2247      Runtime::Current()->VisitRoots(&RootMatchesObjectVisitor, arg);
2248    }
2249    return false;
2250  }
2251
2252  Heap* const heap_;
2253  Atomic<size_t>* const fail_count_;
2254  const bool verify_referent_;
2255};
2256
2257// Verify all references within an object, for use with HeapBitmap::Visit.
2258class VerifyObjectVisitor {
2259 public:
2260  explicit VerifyObjectVisitor(Heap* heap, Atomic<size_t>* fail_count, bool verify_referent)
2261      : heap_(heap), fail_count_(fail_count), verify_referent_(verify_referent) {
2262  }
2263
2264  void operator()(mirror::Object* obj) const
2265      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
2266    // Note: we are verifying the references in obj but not obj itself, this is because obj must
2267    // be live or else how did we find it in the live bitmap?
2268    VerifyReferenceVisitor visitor(heap_, fail_count_, verify_referent_);
2269    // The class doesn't count as a reference but we should verify it anyways.
2270    obj->VisitReferences<true>(visitor, visitor);
2271  }
2272
2273  static void VisitCallback(mirror::Object* obj, void* arg)
2274      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
2275    VerifyObjectVisitor* visitor = reinterpret_cast<VerifyObjectVisitor*>(arg);
2276    visitor->operator()(obj);
2277  }
2278
2279  size_t GetFailureCount() const {
2280    return fail_count_->LoadSequentiallyConsistent();
2281  }
2282
2283 private:
2284  Heap* const heap_;
2285  Atomic<size_t>* const fail_count_;
2286  const bool verify_referent_;
2287};
2288
2289void Heap::PushOnAllocationStackWithInternalGC(Thread* self, mirror::Object** obj) {
2290  // Slow path, the allocation stack push back must have already failed.
2291  DCHECK(!allocation_stack_->AtomicPushBack(*obj));
2292  do {
2293    // TODO: Add handle VerifyObject.
2294    StackHandleScope<1> hs(self);
2295    HandleWrapper<mirror::Object> wrapper(hs.NewHandleWrapper(obj));
2296    // Push our object into the reserve region of the allocaiton stack. This is only required due
2297    // to heap verification requiring that roots are live (either in the live bitmap or in the
2298    // allocation stack).
2299    CHECK(allocation_stack_->AtomicPushBackIgnoreGrowthLimit(*obj));
2300    CollectGarbageInternal(collector::kGcTypeSticky, kGcCauseForAlloc, false);
2301  } while (!allocation_stack_->AtomicPushBack(*obj));
2302}
2303
2304void Heap::PushOnThreadLocalAllocationStackWithInternalGC(Thread* self, mirror::Object** obj) {
2305  // Slow path, the allocation stack push back must have already failed.
2306  DCHECK(!self->PushOnThreadLocalAllocationStack(*obj));
2307  mirror::Object** start_address;
2308  mirror::Object** end_address;
2309  while (!allocation_stack_->AtomicBumpBack(kThreadLocalAllocationStackSize, &start_address,
2310                                            &end_address)) {
2311    // TODO: Add handle VerifyObject.
2312    StackHandleScope<1> hs(self);
2313    HandleWrapper<mirror::Object> wrapper(hs.NewHandleWrapper(obj));
2314    // Push our object into the reserve region of the allocaiton stack. This is only required due
2315    // to heap verification requiring that roots are live (either in the live bitmap or in the
2316    // allocation stack).
2317    CHECK(allocation_stack_->AtomicPushBackIgnoreGrowthLimit(*obj));
2318    // Push into the reserve allocation stack.
2319    CollectGarbageInternal(collector::kGcTypeSticky, kGcCauseForAlloc, false);
2320  }
2321  self->SetThreadLocalAllocationStack(start_address, end_address);
2322  // Retry on the new thread-local allocation stack.
2323  CHECK(self->PushOnThreadLocalAllocationStack(*obj));  // Must succeed.
2324}
2325
2326// Must do this with mutators suspended since we are directly accessing the allocation stacks.
2327size_t Heap::VerifyHeapReferences(bool verify_referents) {
2328  Thread* self = Thread::Current();
2329  Locks::mutator_lock_->AssertExclusiveHeld(self);
2330  // Lets sort our allocation stacks so that we can efficiently binary search them.
2331  allocation_stack_->Sort();
2332  live_stack_->Sort();
2333  // Since we sorted the allocation stack content, need to revoke all
2334  // thread-local allocation stacks.
2335  RevokeAllThreadLocalAllocationStacks(self);
2336  Atomic<size_t> fail_count_(0);
2337  VerifyObjectVisitor visitor(this, &fail_count_, verify_referents);
2338  // Verify objects in the allocation stack since these will be objects which were:
2339  // 1. Allocated prior to the GC (pre GC verification).
2340  // 2. Allocated during the GC (pre sweep GC verification).
2341  // We don't want to verify the objects in the live stack since they themselves may be
2342  // pointing to dead objects if they are not reachable.
2343  VisitObjects(VerifyObjectVisitor::VisitCallback, &visitor);
2344  // Verify the roots:
2345  Runtime::Current()->VisitRoots(VerifyReferenceVisitor::VerifyRootCallback, &visitor);
2346  if (visitor.GetFailureCount() > 0) {
2347    // Dump mod-union tables.
2348    for (const auto& table_pair : mod_union_tables_) {
2349      accounting::ModUnionTable* mod_union_table = table_pair.second;
2350      mod_union_table->Dump(LOG(ERROR) << mod_union_table->GetName() << ": ");
2351    }
2352    // Dump remembered sets.
2353    for (const auto& table_pair : remembered_sets_) {
2354      accounting::RememberedSet* remembered_set = table_pair.second;
2355      remembered_set->Dump(LOG(ERROR) << remembered_set->GetName() << ": ");
2356    }
2357    DumpSpaces();
2358  }
2359  return visitor.GetFailureCount();
2360}
2361
2362class VerifyReferenceCardVisitor {
2363 public:
2364  VerifyReferenceCardVisitor(Heap* heap, bool* failed)
2365      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_,
2366                            Locks::heap_bitmap_lock_)
2367      : heap_(heap), failed_(failed) {
2368  }
2369
2370  // TODO: Fix lock analysis to not use NO_THREAD_SAFETY_ANALYSIS, requires support for
2371  // annotalysis on visitors.
2372  void operator()(mirror::Object* obj, MemberOffset offset, bool is_static) const
2373      NO_THREAD_SAFETY_ANALYSIS {
2374    mirror::Object* ref = obj->GetFieldObject<mirror::Object>(offset);
2375    // Filter out class references since changing an object's class does not mark the card as dirty.
2376    // Also handles large objects, since the only reference they hold is a class reference.
2377    if (ref != nullptr && !ref->IsClass()) {
2378      accounting::CardTable* card_table = heap_->GetCardTable();
2379      // If the object is not dirty and it is referencing something in the live stack other than
2380      // class, then it must be on a dirty card.
2381      if (!card_table->AddrIsInCardTable(obj)) {
2382        LOG(ERROR) << "Object " << obj << " is not in the address range of the card table";
2383        *failed_ = true;
2384      } else if (!card_table->IsDirty(obj)) {
2385        // TODO: Check mod-union tables.
2386        // Card should be either kCardDirty if it got re-dirtied after we aged it, or
2387        // kCardDirty - 1 if it didnt get touched since we aged it.
2388        accounting::ObjectStack* live_stack = heap_->live_stack_.get();
2389        if (live_stack->ContainsSorted(ref)) {
2390          if (live_stack->ContainsSorted(obj)) {
2391            LOG(ERROR) << "Object " << obj << " found in live stack";
2392          }
2393          if (heap_->GetLiveBitmap()->Test(obj)) {
2394            LOG(ERROR) << "Object " << obj << " found in live bitmap";
2395          }
2396          LOG(ERROR) << "Object " << obj << " " << PrettyTypeOf(obj)
2397                    << " references " << ref << " " << PrettyTypeOf(ref) << " in live stack";
2398
2399          // Print which field of the object is dead.
2400          if (!obj->IsObjectArray()) {
2401            mirror::Class* klass = is_static ? obj->AsClass() : obj->GetClass();
2402            CHECK(klass != NULL);
2403            mirror::ObjectArray<mirror::ArtField>* fields = is_static ? klass->GetSFields()
2404                                                                      : klass->GetIFields();
2405            CHECK(fields != NULL);
2406            for (int32_t i = 0; i < fields->GetLength(); ++i) {
2407              mirror::ArtField* cur = fields->Get(i);
2408              if (cur->GetOffset().Int32Value() == offset.Int32Value()) {
2409                LOG(ERROR) << (is_static ? "Static " : "") << "field in the live stack is "
2410                          << PrettyField(cur);
2411                break;
2412              }
2413            }
2414          } else {
2415            mirror::ObjectArray<mirror::Object>* object_array =
2416                obj->AsObjectArray<mirror::Object>();
2417            for (int32_t i = 0; i < object_array->GetLength(); ++i) {
2418              if (object_array->Get(i) == ref) {
2419                LOG(ERROR) << (is_static ? "Static " : "") << "obj[" << i << "] = ref";
2420              }
2421            }
2422          }
2423
2424          *failed_ = true;
2425        }
2426      }
2427    }
2428  }
2429
2430 private:
2431  Heap* const heap_;
2432  bool* const failed_;
2433};
2434
2435class VerifyLiveStackReferences {
2436 public:
2437  explicit VerifyLiveStackReferences(Heap* heap)
2438      : heap_(heap),
2439        failed_(false) {}
2440
2441  void operator()(mirror::Object* obj) const
2442      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_, Locks::heap_bitmap_lock_) {
2443    VerifyReferenceCardVisitor visitor(heap_, const_cast<bool*>(&failed_));
2444    obj->VisitReferences<true>(visitor, VoidFunctor());
2445  }
2446
2447  bool Failed() const {
2448    return failed_;
2449  }
2450
2451 private:
2452  Heap* const heap_;
2453  bool failed_;
2454};
2455
2456bool Heap::VerifyMissingCardMarks() {
2457  Thread* self = Thread::Current();
2458  Locks::mutator_lock_->AssertExclusiveHeld(self);
2459
2460  // We need to sort the live stack since we binary search it.
2461  live_stack_->Sort();
2462  // Since we sorted the allocation stack content, need to revoke all
2463  // thread-local allocation stacks.
2464  RevokeAllThreadLocalAllocationStacks(self);
2465  VerifyLiveStackReferences visitor(this);
2466  GetLiveBitmap()->Visit(visitor);
2467
2468  // We can verify objects in the live stack since none of these should reference dead objects.
2469  for (mirror::Object** it = live_stack_->Begin(); it != live_stack_->End(); ++it) {
2470    if (!kUseThreadLocalAllocationStack || *it != nullptr) {
2471      visitor(*it);
2472    }
2473  }
2474
2475  if (visitor.Failed()) {
2476    DumpSpaces();
2477    return false;
2478  }
2479  return true;
2480}
2481
2482void Heap::SwapStacks(Thread* self) {
2483  if (kUseThreadLocalAllocationStack) {
2484    live_stack_->AssertAllZero();
2485  }
2486  allocation_stack_.swap(live_stack_);
2487}
2488
2489void Heap::RevokeAllThreadLocalAllocationStacks(Thread* self) {
2490  // This must be called only during the pause.
2491  CHECK(Locks::mutator_lock_->IsExclusiveHeld(self));
2492  MutexLock mu(self, *Locks::runtime_shutdown_lock_);
2493  MutexLock mu2(self, *Locks::thread_list_lock_);
2494  std::list<Thread*> thread_list = Runtime::Current()->GetThreadList()->GetList();
2495  for (Thread* t : thread_list) {
2496    t->RevokeThreadLocalAllocationStack();
2497  }
2498}
2499
2500void Heap::AssertAllBumpPointerSpaceThreadLocalBuffersAreRevoked() {
2501  if (kIsDebugBuild) {
2502    if (bump_pointer_space_ != nullptr) {
2503      bump_pointer_space_->AssertAllThreadLocalBuffersAreRevoked();
2504    }
2505  }
2506}
2507
2508accounting::ModUnionTable* Heap::FindModUnionTableFromSpace(space::Space* space) {
2509  auto it = mod_union_tables_.find(space);
2510  if (it == mod_union_tables_.end()) {
2511    return nullptr;
2512  }
2513  return it->second;
2514}
2515
2516accounting::RememberedSet* Heap::FindRememberedSetFromSpace(space::Space* space) {
2517  auto it = remembered_sets_.find(space);
2518  if (it == remembered_sets_.end()) {
2519    return nullptr;
2520  }
2521  return it->second;
2522}
2523
2524void Heap::ProcessCards(TimingLogger* timings, bool use_rem_sets) {
2525  TimingLogger::ScopedTiming t(__FUNCTION__, timings);
2526  // Clear cards and keep track of cards cleared in the mod-union table.
2527  for (const auto& space : continuous_spaces_) {
2528    accounting::ModUnionTable* table = FindModUnionTableFromSpace(space);
2529    accounting::RememberedSet* rem_set = FindRememberedSetFromSpace(space);
2530    if (table != nullptr) {
2531      const char* name = space->IsZygoteSpace() ? "ZygoteModUnionClearCards" :
2532          "ImageModUnionClearCards";
2533      TimingLogger::ScopedTiming t(name, timings);
2534      table->ClearCards();
2535    } else if (use_rem_sets && rem_set != nullptr) {
2536      DCHECK(collector::SemiSpace::kUseRememberedSet && collector_type_ == kCollectorTypeGSS)
2537          << static_cast<int>(collector_type_);
2538      TimingLogger::ScopedTiming t("AllocSpaceRemSetClearCards", timings);
2539      rem_set->ClearCards();
2540    } else if (space->GetType() != space::kSpaceTypeBumpPointerSpace) {
2541      TimingLogger::ScopedTiming t("AllocSpaceClearCards", timings);
2542      // No mod union table for the AllocSpace. Age the cards so that the GC knows that these cards
2543      // were dirty before the GC started.
2544      // TODO: Need to use atomic for the case where aged(cleaning thread) -> dirty(other thread)
2545      // -> clean(cleaning thread).
2546      // The races are we either end up with: Aged card, unaged card. Since we have the checkpoint
2547      // roots and then we scan / update mod union tables after. We will always scan either card.
2548      // If we end up with the non aged card, we scan it it in the pause.
2549      card_table_->ModifyCardsAtomic(space->Begin(), space->End(), AgeCardVisitor(),
2550                                     VoidFunctor());
2551    }
2552  }
2553}
2554
2555static void IdentityMarkHeapReferenceCallback(mirror::HeapReference<mirror::Object>*, void*) {
2556}
2557
2558void Heap::PreGcVerificationPaused(collector::GarbageCollector* gc) {
2559  Thread* const self = Thread::Current();
2560  TimingLogger* const timings = current_gc_iteration_.GetTimings();
2561  TimingLogger::ScopedTiming t(__FUNCTION__, timings);
2562  if (verify_pre_gc_heap_) {
2563    TimingLogger::ScopedTiming t("(Paused)PreGcVerifyHeapReferences", timings);
2564    ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
2565    size_t failures = VerifyHeapReferences();
2566    if (failures > 0) {
2567      LOG(FATAL) << "Pre " << gc->GetName() << " heap verification failed with " << failures
2568          << " failures";
2569    }
2570  }
2571  // Check that all objects which reference things in the live stack are on dirty cards.
2572  if (verify_missing_card_marks_) {
2573    TimingLogger::ScopedTiming t("(Paused)PreGcVerifyMissingCardMarks", timings);
2574    ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
2575    SwapStacks(self);
2576    // Sort the live stack so that we can quickly binary search it later.
2577    if (!VerifyMissingCardMarks()) {
2578      LOG(FATAL) << "Pre " << gc->GetName() << " missing card mark verification failed";
2579    }
2580    SwapStacks(self);
2581  }
2582  if (verify_mod_union_table_) {
2583    TimingLogger::ScopedTiming t("(Paused)PreGcVerifyModUnionTables", timings);
2584    ReaderMutexLock reader_lock(self, *Locks::heap_bitmap_lock_);
2585    for (const auto& table_pair : mod_union_tables_) {
2586      accounting::ModUnionTable* mod_union_table = table_pair.second;
2587      mod_union_table->UpdateAndMarkReferences(IdentityMarkHeapReferenceCallback, nullptr);
2588      mod_union_table->Verify();
2589    }
2590  }
2591}
2592
2593void Heap::PreGcVerification(collector::GarbageCollector* gc) {
2594  if (verify_pre_gc_heap_ || verify_missing_card_marks_ || verify_mod_union_table_) {
2595    collector::GarbageCollector::ScopedPause pause(gc);
2596    PreGcVerificationPaused(gc);
2597  }
2598}
2599
2600void Heap::PrePauseRosAllocVerification(collector::GarbageCollector* gc) {
2601  // TODO: Add a new runtime option for this?
2602  if (verify_pre_gc_rosalloc_) {
2603    RosAllocVerification(current_gc_iteration_.GetTimings(), "PreGcRosAllocVerification");
2604  }
2605}
2606
2607void Heap::PreSweepingGcVerification(collector::GarbageCollector* gc) {
2608  Thread* const self = Thread::Current();
2609  TimingLogger* const timings = current_gc_iteration_.GetTimings();
2610  TimingLogger::ScopedTiming t(__FUNCTION__, timings);
2611  // Called before sweeping occurs since we want to make sure we are not going so reclaim any
2612  // reachable objects.
2613  if (verify_pre_sweeping_heap_) {
2614    TimingLogger::ScopedTiming t("(Paused)PostSweepingVerifyHeapReferences", timings);
2615    CHECK_NE(self->GetState(), kRunnable);
2616    WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
2617    // Swapping bound bitmaps does nothing.
2618    gc->SwapBitmaps();
2619    // Pass in false since concurrent reference processing can mean that the reference referents
2620    // may point to dead objects at the point which PreSweepingGcVerification is called.
2621    size_t failures = VerifyHeapReferences(false);
2622    if (failures > 0) {
2623      LOG(FATAL) << "Pre sweeping " << gc->GetName() << " GC verification failed with " << failures
2624          << " failures";
2625    }
2626    gc->SwapBitmaps();
2627  }
2628  if (verify_pre_sweeping_rosalloc_) {
2629    RosAllocVerification(timings, "PreSweepingRosAllocVerification");
2630  }
2631}
2632
2633void Heap::PostGcVerificationPaused(collector::GarbageCollector* gc) {
2634  // Only pause if we have to do some verification.
2635  Thread* const self = Thread::Current();
2636  TimingLogger* const timings = GetCurrentGcIteration()->GetTimings();
2637  TimingLogger::ScopedTiming t(__FUNCTION__, timings);
2638  if (verify_system_weaks_) {
2639    ReaderMutexLock mu2(self, *Locks::heap_bitmap_lock_);
2640    collector::MarkSweep* mark_sweep = down_cast<collector::MarkSweep*>(gc);
2641    mark_sweep->VerifySystemWeaks();
2642  }
2643  if (verify_post_gc_rosalloc_) {
2644    RosAllocVerification(timings, "(Paused)PostGcRosAllocVerification");
2645  }
2646  if (verify_post_gc_heap_) {
2647    TimingLogger::ScopedTiming t("(Paused)PostGcVerifyHeapReferences", timings);
2648    ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
2649    size_t failures = VerifyHeapReferences();
2650    if (failures > 0) {
2651      LOG(FATAL) << "Pre " << gc->GetName() << " heap verification failed with " << failures
2652          << " failures";
2653    }
2654  }
2655}
2656
2657void Heap::PostGcVerification(collector::GarbageCollector* gc) {
2658  if (verify_system_weaks_ || verify_post_gc_rosalloc_ || verify_post_gc_heap_) {
2659    collector::GarbageCollector::ScopedPause pause(gc);
2660    PreGcVerificationPaused(gc);
2661  }
2662}
2663
2664void Heap::RosAllocVerification(TimingLogger* timings, const char* name) {
2665  TimingLogger::ScopedTiming t(name, timings);
2666  for (const auto& space : continuous_spaces_) {
2667    if (space->IsRosAllocSpace()) {
2668      VLOG(heap) << name << " : " << space->GetName();
2669      space->AsRosAllocSpace()->Verify();
2670    }
2671  }
2672}
2673
2674collector::GcType Heap::WaitForGcToComplete(GcCause cause, Thread* self) {
2675  ScopedThreadStateChange tsc(self, kWaitingForGcToComplete);
2676  MutexLock mu(self, *gc_complete_lock_);
2677  return WaitForGcToCompleteLocked(cause, self);
2678}
2679
2680collector::GcType Heap::WaitForGcToCompleteLocked(GcCause cause, Thread* self) {
2681  collector::GcType last_gc_type = collector::kGcTypeNone;
2682  uint64_t wait_start = NanoTime();
2683  while (collector_type_running_ != kCollectorTypeNone) {
2684    ATRACE_BEGIN("GC: Wait For Completion");
2685    // We must wait, change thread state then sleep on gc_complete_cond_;
2686    gc_complete_cond_->Wait(self);
2687    last_gc_type = last_gc_type_;
2688    ATRACE_END();
2689  }
2690  uint64_t wait_time = NanoTime() - wait_start;
2691  total_wait_time_ += wait_time;
2692  if (wait_time > long_pause_log_threshold_) {
2693    LOG(INFO) << "WaitForGcToComplete blocked for " << PrettyDuration(wait_time)
2694        << " for cause " << cause;
2695  }
2696  return last_gc_type;
2697}
2698
2699void Heap::DumpForSigQuit(std::ostream& os) {
2700  os << "Heap: " << GetPercentFree() << "% free, " << PrettySize(GetBytesAllocated()) << "/"
2701     << PrettySize(GetTotalMemory()) << "; " << GetObjectsAllocated() << " objects\n";
2702  DumpGcPerformanceInfo(os);
2703}
2704
2705size_t Heap::GetPercentFree() {
2706  return static_cast<size_t>(100.0f * static_cast<float>(GetFreeMemory()) / max_allowed_footprint_);
2707}
2708
2709void Heap::SetIdealFootprint(size_t max_allowed_footprint) {
2710  if (max_allowed_footprint > GetMaxMemory()) {
2711    VLOG(gc) << "Clamp target GC heap from " << PrettySize(max_allowed_footprint) << " to "
2712             << PrettySize(GetMaxMemory());
2713    max_allowed_footprint = GetMaxMemory();
2714  }
2715  max_allowed_footprint_ = max_allowed_footprint;
2716}
2717
2718bool Heap::IsMovableObject(const mirror::Object* obj) const {
2719  if (kMovingCollector) {
2720    space::Space* space = FindContinuousSpaceFromObject(obj, true);
2721    if (space != nullptr) {
2722      // TODO: Check large object?
2723      return space->CanMoveObjects();
2724    }
2725  }
2726  return false;
2727}
2728
2729void Heap::UpdateMaxNativeFootprint() {
2730  size_t native_size = native_bytes_allocated_.LoadRelaxed();
2731  // TODO: Tune the native heap utilization to be a value other than the java heap utilization.
2732  size_t target_size = native_size / GetTargetHeapUtilization();
2733  if (target_size > native_size + max_free_) {
2734    target_size = native_size + max_free_;
2735  } else if (target_size < native_size + min_free_) {
2736    target_size = native_size + min_free_;
2737  }
2738  native_footprint_gc_watermark_ = target_size;
2739  native_footprint_limit_ = 2 * target_size - native_size;
2740}
2741
2742collector::GarbageCollector* Heap::FindCollectorByGcType(collector::GcType gc_type) {
2743  for (const auto& collector : garbage_collectors_) {
2744    if (collector->GetCollectorType() == collector_type_ &&
2745        collector->GetGcType() == gc_type) {
2746      return collector;
2747    }
2748  }
2749  return nullptr;
2750}
2751
2752double Heap::HeapGrowthMultiplier() const {
2753  // If we don't care about pause times we are background, so return 1.0.
2754  if (!CareAboutPauseTimes() || IsLowMemoryMode()) {
2755    return 1.0;
2756  }
2757  return foreground_heap_growth_multiplier_;
2758}
2759
2760void Heap::GrowForUtilization(collector::GarbageCollector* collector_ran) {
2761  // We know what our utilization is at this moment.
2762  // This doesn't actually resize any memory. It just lets the heap grow more when necessary.
2763  const uint64_t bytes_allocated = GetBytesAllocated();
2764  last_gc_size_ = bytes_allocated;
2765  last_gc_time_ns_ = NanoTime();
2766  uint64_t target_size;
2767  collector::GcType gc_type = collector_ran->GetGcType();
2768  if (gc_type != collector::kGcTypeSticky) {
2769    // Grow the heap for non sticky GC.
2770    const float multiplier = HeapGrowthMultiplier();  // Use the multiplier to grow more for
2771    // foreground.
2772    intptr_t delta = bytes_allocated / GetTargetHeapUtilization() - bytes_allocated;
2773    CHECK_GE(delta, 0);
2774    target_size = bytes_allocated + delta * multiplier;
2775    target_size = std::min(target_size,
2776                           bytes_allocated + static_cast<uint64_t>(max_free_ * multiplier));
2777    target_size = std::max(target_size,
2778                           bytes_allocated + static_cast<uint64_t>(min_free_ * multiplier));
2779    native_need_to_run_finalization_ = true;
2780    next_gc_type_ = collector::kGcTypeSticky;
2781  } else {
2782    collector::GcType non_sticky_gc_type =
2783        have_zygote_space_ ? collector::kGcTypePartial : collector::kGcTypeFull;
2784    // Find what the next non sticky collector will be.
2785    collector::GarbageCollector* non_sticky_collector = FindCollectorByGcType(non_sticky_gc_type);
2786    // If the throughput of the current sticky GC >= throughput of the non sticky collector, then
2787    // do another sticky collection next.
2788    // We also check that the bytes allocated aren't over the footprint limit in order to prevent a
2789    // pathological case where dead objects which aren't reclaimed by sticky could get accumulated
2790    // if the sticky GC throughput always remained >= the full/partial throughput.
2791    if (current_gc_iteration_.GetEstimatedThroughput() * kStickyGcThroughputAdjustment >=
2792        non_sticky_collector->GetEstimatedMeanThroughput() &&
2793        non_sticky_collector->NumberOfIterations() > 0 &&
2794        bytes_allocated <= max_allowed_footprint_) {
2795      next_gc_type_ = collector::kGcTypeSticky;
2796    } else {
2797      next_gc_type_ = non_sticky_gc_type;
2798    }
2799    // If we have freed enough memory, shrink the heap back down.
2800    if (bytes_allocated + max_free_ < max_allowed_footprint_) {
2801      target_size = bytes_allocated + max_free_;
2802    } else {
2803      target_size = std::max(bytes_allocated, static_cast<uint64_t>(max_allowed_footprint_));
2804    }
2805  }
2806  if (!ignore_max_footprint_) {
2807    SetIdealFootprint(target_size);
2808    if (IsGcConcurrent()) {
2809      // Calculate when to perform the next ConcurrentGC.
2810      // Calculate the estimated GC duration.
2811      const double gc_duration_seconds = NsToMs(current_gc_iteration_.GetDurationNs()) / 1000.0;
2812      // Estimate how many remaining bytes we will have when we need to start the next GC.
2813      size_t remaining_bytes = allocation_rate_ * gc_duration_seconds;
2814      remaining_bytes = std::min(remaining_bytes, kMaxConcurrentRemainingBytes);
2815      remaining_bytes = std::max(remaining_bytes, kMinConcurrentRemainingBytes);
2816      if (UNLIKELY(remaining_bytes > max_allowed_footprint_)) {
2817        // A never going to happen situation that from the estimated allocation rate we will exceed
2818        // the applications entire footprint with the given estimated allocation rate. Schedule
2819        // another GC nearly straight away.
2820        remaining_bytes = kMinConcurrentRemainingBytes;
2821      }
2822      DCHECK_LE(remaining_bytes, max_allowed_footprint_);
2823      DCHECK_LE(max_allowed_footprint_, growth_limit_);
2824      // Start a concurrent GC when we get close to the estimated remaining bytes. When the
2825      // allocation rate is very high, remaining_bytes could tell us that we should start a GC
2826      // right away.
2827      concurrent_start_bytes_ = std::max(max_allowed_footprint_ - remaining_bytes,
2828                                         static_cast<size_t>(bytes_allocated));
2829    }
2830  }
2831}
2832
2833void Heap::ClearGrowthLimit() {
2834  growth_limit_ = capacity_;
2835  non_moving_space_->ClearGrowthLimit();
2836}
2837
2838void Heap::AddFinalizerReference(Thread* self, mirror::Object** object) {
2839  ScopedObjectAccess soa(self);
2840  ScopedLocalRef<jobject> arg(self->GetJniEnv(), soa.AddLocalReference<jobject>(*object));
2841  jvalue args[1];
2842  args[0].l = arg.get();
2843  InvokeWithJValues(soa, nullptr, WellKnownClasses::java_lang_ref_FinalizerReference_add, args);
2844  // Restore object in case it gets moved.
2845  *object = soa.Decode<mirror::Object*>(arg.get());
2846}
2847
2848void Heap::RequestConcurrentGCAndSaveObject(Thread* self, mirror::Object** obj) {
2849  StackHandleScope<1> hs(self);
2850  HandleWrapper<mirror::Object> wrapper(hs.NewHandleWrapper(obj));
2851  RequestConcurrentGC(self);
2852}
2853
2854void Heap::RequestConcurrentGC(Thread* self) {
2855  // Make sure that we can do a concurrent GC.
2856  Runtime* runtime = Runtime::Current();
2857  if (runtime == nullptr || !runtime->IsFinishedStarting() || runtime->IsShuttingDown(self) ||
2858      self->IsHandlingStackOverflow()) {
2859    return;
2860  }
2861  // We already have a request pending, no reason to start more until we update
2862  // concurrent_start_bytes_.
2863  concurrent_start_bytes_ = std::numeric_limits<size_t>::max();
2864  JNIEnv* env = self->GetJniEnv();
2865  DCHECK(WellKnownClasses::java_lang_Daemons != nullptr);
2866  DCHECK(WellKnownClasses::java_lang_Daemons_requestGC != nullptr);
2867  env->CallStaticVoidMethod(WellKnownClasses::java_lang_Daemons,
2868                            WellKnownClasses::java_lang_Daemons_requestGC);
2869  CHECK(!env->ExceptionCheck());
2870}
2871
2872void Heap::ConcurrentGC(Thread* self) {
2873  if (Runtime::Current()->IsShuttingDown(self)) {
2874    return;
2875  }
2876  // Wait for any GCs currently running to finish.
2877  if (WaitForGcToComplete(kGcCauseBackground, self) == collector::kGcTypeNone) {
2878    // If the we can't run the GC type we wanted to run, find the next appropriate one and try that
2879    // instead. E.g. can't do partial, so do full instead.
2880    if (CollectGarbageInternal(next_gc_type_, kGcCauseBackground, false) ==
2881        collector::kGcTypeNone) {
2882      for (collector::GcType gc_type : gc_plan_) {
2883        // Attempt to run the collector, if we succeed, we are done.
2884        if (gc_type > next_gc_type_ &&
2885            CollectGarbageInternal(gc_type, kGcCauseBackground, false) != collector::kGcTypeNone) {
2886          break;
2887        }
2888      }
2889    }
2890  }
2891}
2892
2893void Heap::RequestCollectorTransition(CollectorType desired_collector_type, uint64_t delta_time) {
2894  Thread* self = Thread::Current();
2895  {
2896    MutexLock mu(self, *heap_trim_request_lock_);
2897    if (desired_collector_type_ == desired_collector_type) {
2898      return;
2899    }
2900    heap_transition_or_trim_target_time_ =
2901        std::max(heap_transition_or_trim_target_time_, NanoTime() + delta_time);
2902    desired_collector_type_ = desired_collector_type;
2903  }
2904  SignalHeapTrimDaemon(self);
2905}
2906
2907void Heap::RequestHeapTrim() {
2908  // GC completed and now we must decide whether to request a heap trim (advising pages back to the
2909  // kernel) or not. Issuing a request will also cause trimming of the libc heap. As a trim scans
2910  // a space it will hold its lock and can become a cause of jank.
2911  // Note, the large object space self trims and the Zygote space was trimmed and unchanging since
2912  // forking.
2913
2914  // We don't have a good measure of how worthwhile a trim might be. We can't use the live bitmap
2915  // because that only marks object heads, so a large array looks like lots of empty space. We
2916  // don't just call dlmalloc all the time, because the cost of an _attempted_ trim is proportional
2917  // to utilization (which is probably inversely proportional to how much benefit we can expect).
2918  // We could try mincore(2) but that's only a measure of how many pages we haven't given away,
2919  // not how much use we're making of those pages.
2920
2921  Thread* self = Thread::Current();
2922  Runtime* runtime = Runtime::Current();
2923  if (runtime == nullptr || !runtime->IsFinishedStarting() || runtime->IsShuttingDown(self)) {
2924    // Heap trimming isn't supported without a Java runtime or Daemons (such as at dex2oat time)
2925    // Also: we do not wish to start a heap trim if the runtime is shutting down (a racy check
2926    // as we don't hold the lock while requesting the trim).
2927    return;
2928  }
2929  {
2930    MutexLock mu(self, *heap_trim_request_lock_);
2931    if (last_trim_time_ + kHeapTrimWait >= NanoTime()) {
2932      // We have done a heap trim in the last kHeapTrimWait nanosecs, don't request another one
2933      // just yet.
2934      return;
2935    }
2936    heap_trim_request_pending_ = true;
2937    uint64_t current_time = NanoTime();
2938    if (heap_transition_or_trim_target_time_ < current_time) {
2939      heap_transition_or_trim_target_time_ = current_time + kHeapTrimWait;
2940    }
2941  }
2942  // Notify the daemon thread which will actually do the heap trim.
2943  SignalHeapTrimDaemon(self);
2944}
2945
2946void Heap::SignalHeapTrimDaemon(Thread* self) {
2947  JNIEnv* env = self->GetJniEnv();
2948  DCHECK(WellKnownClasses::java_lang_Daemons != nullptr);
2949  DCHECK(WellKnownClasses::java_lang_Daemons_requestHeapTrim != nullptr);
2950  env->CallStaticVoidMethod(WellKnownClasses::java_lang_Daemons,
2951                            WellKnownClasses::java_lang_Daemons_requestHeapTrim);
2952  CHECK(!env->ExceptionCheck());
2953}
2954
2955void Heap::RevokeThreadLocalBuffers(Thread* thread) {
2956  if (rosalloc_space_ != nullptr) {
2957    rosalloc_space_->RevokeThreadLocalBuffers(thread);
2958  }
2959  if (bump_pointer_space_ != nullptr) {
2960    bump_pointer_space_->RevokeThreadLocalBuffers(thread);
2961  }
2962}
2963
2964void Heap::RevokeRosAllocThreadLocalBuffers(Thread* thread) {
2965  if (rosalloc_space_ != nullptr) {
2966    rosalloc_space_->RevokeThreadLocalBuffers(thread);
2967  }
2968}
2969
2970void Heap::RevokeAllThreadLocalBuffers() {
2971  if (rosalloc_space_ != nullptr) {
2972    rosalloc_space_->RevokeAllThreadLocalBuffers();
2973  }
2974  if (bump_pointer_space_ != nullptr) {
2975    bump_pointer_space_->RevokeAllThreadLocalBuffers();
2976  }
2977}
2978
2979bool Heap::IsGCRequestPending() const {
2980  return concurrent_start_bytes_ != std::numeric_limits<size_t>::max();
2981}
2982
2983void Heap::RunFinalization(JNIEnv* env) {
2984  // Can't do this in WellKnownClasses::Init since System is not properly set up at that point.
2985  if (WellKnownClasses::java_lang_System_runFinalization == nullptr) {
2986    CHECK(WellKnownClasses::java_lang_System != nullptr);
2987    WellKnownClasses::java_lang_System_runFinalization =
2988        CacheMethod(env, WellKnownClasses::java_lang_System, true, "runFinalization", "()V");
2989    CHECK(WellKnownClasses::java_lang_System_runFinalization != nullptr);
2990  }
2991  env->CallStaticVoidMethod(WellKnownClasses::java_lang_System,
2992                            WellKnownClasses::java_lang_System_runFinalization);
2993}
2994
2995void Heap::RegisterNativeAllocation(JNIEnv* env, int bytes) {
2996  Thread* self = ThreadForEnv(env);
2997  if (native_need_to_run_finalization_) {
2998    RunFinalization(env);
2999    UpdateMaxNativeFootprint();
3000    native_need_to_run_finalization_ = false;
3001  }
3002  // Total number of native bytes allocated.
3003  size_t new_native_bytes_allocated = native_bytes_allocated_.FetchAndAddSequentiallyConsistent(bytes);
3004  new_native_bytes_allocated += bytes;
3005  if (new_native_bytes_allocated > native_footprint_gc_watermark_) {
3006    collector::GcType gc_type = have_zygote_space_ ? collector::kGcTypePartial :
3007        collector::kGcTypeFull;
3008
3009    // The second watermark is higher than the gc watermark. If you hit this it means you are
3010    // allocating native objects faster than the GC can keep up with.
3011    if (new_native_bytes_allocated > native_footprint_limit_) {
3012      if (WaitForGcToComplete(kGcCauseForNativeAlloc, self) != collector::kGcTypeNone) {
3013        // Just finished a GC, attempt to run finalizers.
3014        RunFinalization(env);
3015        CHECK(!env->ExceptionCheck());
3016      }
3017      // If we still are over the watermark, attempt a GC for alloc and run finalizers.
3018      if (new_native_bytes_allocated > native_footprint_limit_) {
3019        CollectGarbageInternal(gc_type, kGcCauseForNativeAlloc, false);
3020        RunFinalization(env);
3021        native_need_to_run_finalization_ = false;
3022        CHECK(!env->ExceptionCheck());
3023      }
3024      // We have just run finalizers, update the native watermark since it is very likely that
3025      // finalizers released native managed allocations.
3026      UpdateMaxNativeFootprint();
3027    } else if (!IsGCRequestPending()) {
3028      if (IsGcConcurrent()) {
3029        RequestConcurrentGC(self);
3030      } else {
3031        CollectGarbageInternal(gc_type, kGcCauseForNativeAlloc, false);
3032      }
3033    }
3034  }
3035}
3036
3037void Heap::RegisterNativeFree(JNIEnv* env, int bytes) {
3038  int expected_size, new_size;
3039  do {
3040    expected_size = native_bytes_allocated_.LoadRelaxed();
3041    new_size = expected_size - bytes;
3042    if (UNLIKELY(new_size < 0)) {
3043      ScopedObjectAccess soa(env);
3044      env->ThrowNew(WellKnownClasses::java_lang_RuntimeException,
3045                    StringPrintf("Attempted to free %d native bytes with only %d native bytes "
3046                                 "registered as allocated", bytes, expected_size).c_str());
3047      break;
3048    }
3049  } while (!native_bytes_allocated_.CompareExchangeWeakRelaxed(expected_size, new_size));
3050}
3051
3052size_t Heap::GetTotalMemory() const {
3053  size_t ret = 0;
3054  for (const auto& space : continuous_spaces_) {
3055    // Currently don't include the image space.
3056    if (!space->IsImageSpace()) {
3057      ret += space->Size();
3058    }
3059  }
3060  for (const auto& space : discontinuous_spaces_) {
3061    if (space->IsLargeObjectSpace()) {
3062      ret += space->AsLargeObjectSpace()->GetBytesAllocated();
3063    }
3064  }
3065  return ret;
3066}
3067
3068void Heap::AddModUnionTable(accounting::ModUnionTable* mod_union_table) {
3069  DCHECK(mod_union_table != nullptr);
3070  mod_union_tables_.Put(mod_union_table->GetSpace(), mod_union_table);
3071}
3072
3073void Heap::CheckPreconditionsForAllocObject(mirror::Class* c, size_t byte_count) {
3074  CHECK(c == NULL || (c->IsClassClass() && byte_count >= sizeof(mirror::Class)) ||
3075        (c->IsVariableSize() || c->GetObjectSize() == byte_count) ||
3076        c->GetDescriptor().empty());
3077  CHECK_GE(byte_count, sizeof(mirror::Object));
3078}
3079
3080void Heap::AddRememberedSet(accounting::RememberedSet* remembered_set) {
3081  CHECK(remembered_set != nullptr);
3082  space::Space* space = remembered_set->GetSpace();
3083  CHECK(space != nullptr);
3084  CHECK(remembered_sets_.find(space) == remembered_sets_.end()) << space;
3085  remembered_sets_.Put(space, remembered_set);
3086  CHECK(remembered_sets_.find(space) != remembered_sets_.end()) << space;
3087}
3088
3089void Heap::RemoveRememberedSet(space::Space* space) {
3090  CHECK(space != nullptr);
3091  auto it = remembered_sets_.find(space);
3092  CHECK(it != remembered_sets_.end());
3093  remembered_sets_.erase(it);
3094  CHECK(remembered_sets_.find(space) == remembered_sets_.end());
3095}
3096
3097void Heap::ClearMarkedObjects() {
3098  // Clear all of the spaces' mark bitmaps.
3099  for (const auto& space : GetContinuousSpaces()) {
3100    accounting::ContinuousSpaceBitmap* mark_bitmap = space->GetMarkBitmap();
3101    if (space->GetLiveBitmap() != mark_bitmap) {
3102      mark_bitmap->Clear();
3103    }
3104  }
3105  // Clear the marked objects in the discontinous space object sets.
3106  for (const auto& space : GetDiscontinuousSpaces()) {
3107    space->GetMarkBitmap()->Clear();
3108  }
3109}
3110
3111}  // namespace gc
3112}  // namespace art
3113