1 // Copyright 2012 the V8 project authors. All rights reserved.
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions are
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above
9 // copyright notice, this list of conditions and the following
10 // disclaimer in the documentation and/or other materials provided
11 // with the distribution.
12 // * Neither the name of Google Inc. nor the names of its
13 // contributors may be used to endorse or promote products derived
14 // from this software without specific prior written permission.
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef V8_MARK_COMPACT_H_
29 #define V8_MARK_COMPACT_H_
31 #include "compiler-intrinsics.h"
37 // Callback function, returns whether an object is alive. The heap size
38 // of the object is returned in size. It optionally updates the offset
39 // to the first live object in the page (only used for old and map objects).
40 typedef bool (*IsAliveFunction)(HeapObject* obj, int* size, int* offset);
42 // Forward declarations.
45 class MarkCompactCollector;
47 class RootMarkingVisitor;
52 explicit Marking(Heap* heap)
56 static inline MarkBit MarkBitFrom(Address addr);
58 static inline MarkBit MarkBitFrom(HeapObject* obj) {
59 return MarkBitFrom(reinterpret_cast<Address>(obj));
62 // Impossible markbits: 01
63 static const char* kImpossibleBitPattern;
64 static inline bool IsImpossible(MarkBit mark_bit) {
65 return !mark_bit.Get() && mark_bit.Next().Get();
68 // Black markbits: 10 - this is required by the sweeper.
69 static const char* kBlackBitPattern;
70 static inline bool IsBlack(MarkBit mark_bit) {
71 return mark_bit.Get() && !mark_bit.Next().Get();
74 // White markbits: 00 - this is required by the mark bit clearer.
75 static const char* kWhiteBitPattern;
76 static inline bool IsWhite(MarkBit mark_bit) {
77 return !mark_bit.Get();
81 static const char* kGreyBitPattern;
82 static inline bool IsGrey(MarkBit mark_bit) {
83 return mark_bit.Get() && mark_bit.Next().Get();
86 static inline void MarkBlack(MarkBit mark_bit) {
88 mark_bit.Next().Clear();
91 static inline void BlackToGrey(MarkBit markbit) {
95 static inline void WhiteToGrey(MarkBit markbit) {
100 static inline void GreyToBlack(MarkBit markbit) {
101 markbit.Next().Clear();
104 static inline void BlackToGrey(HeapObject* obj) {
105 BlackToGrey(MarkBitFrom(obj));
108 static inline void AnyToGrey(MarkBit markbit) {
110 markbit.Next().Set();
113 // Returns true if the the object whose mark is transferred is marked black.
114 bool TransferMark(Address old_start, Address new_start);
124 static const char* ColorName(ObjectColor color) {
126 case BLACK_OBJECT: return "black";
127 case WHITE_OBJECT: return "white";
128 case GREY_OBJECT: return "grey";
129 case IMPOSSIBLE_COLOR: return "impossible";
134 static ObjectColor Color(HeapObject* obj) {
135 return Color(Marking::MarkBitFrom(obj));
138 static ObjectColor Color(MarkBit mark_bit) {
139 if (IsBlack(mark_bit)) return BLACK_OBJECT;
140 if (IsWhite(mark_bit)) return WHITE_OBJECT;
141 if (IsGrey(mark_bit)) return GREY_OBJECT;
143 return IMPOSSIBLE_COLOR;
147 // Returns true if the transferred color is black.
148 INLINE(static bool TransferColor(HeapObject* from,
150 MarkBit from_mark_bit = MarkBitFrom(from);
151 MarkBit to_mark_bit = MarkBitFrom(to);
152 bool is_black = false;
153 if (from_mark_bit.Get()) {
155 is_black = true; // Looks black so far.
157 if (from_mark_bit.Next().Get()) {
158 to_mark_bit.Next().Set();
159 is_black = false; // Was actually gray.
168 // ----------------------------------------------------------------------------
169 // Marking deque for tracing live objects.
173 : array_(NULL), top_(0), bottom_(0), mask_(0), overflowed_(false) { }
175 void Initialize(Address low, Address high) {
176 HeapObject** obj_low = reinterpret_cast<HeapObject**>(low);
177 HeapObject** obj_high = reinterpret_cast<HeapObject**>(high);
179 mask_ = RoundDownToPowerOf2(static_cast<int>(obj_high - obj_low)) - 1;
184 inline bool IsFull() { return ((top_ + 1) & mask_) == bottom_; }
186 inline bool IsEmpty() { return top_ == bottom_; }
188 bool overflowed() const { return overflowed_; }
190 void ClearOverflowed() { overflowed_ = false; }
192 void SetOverflowed() { overflowed_ = true; }
194 // Push the (marked) object on the marking stack if there is room,
195 // otherwise mark the object as overflowed and wait for a rescan of the
197 inline void PushBlack(HeapObject* object) {
198 ASSERT(object->IsHeapObject());
200 Marking::BlackToGrey(object);
201 MemoryChunk::IncrementLiveBytesFromGC(object->address(), -object->Size());
204 array_[top_] = object;
205 top_ = ((top_ + 1) & mask_);
209 inline void PushGrey(HeapObject* object) {
210 ASSERT(object->IsHeapObject());
214 array_[top_] = object;
215 top_ = ((top_ + 1) & mask_);
219 inline HeapObject* Pop() {
221 top_ = ((top_ - 1) & mask_);
222 HeapObject* object = array_[top_];
223 ASSERT(object->IsHeapObject());
227 inline void UnshiftGrey(HeapObject* object) {
228 ASSERT(object->IsHeapObject());
232 bottom_ = ((bottom_ - 1) & mask_);
233 array_[bottom_] = object;
237 HeapObject** array() { return array_; }
238 int bottom() { return bottom_; }
239 int top() { return top_; }
240 int mask() { return mask_; }
241 void set_top(int top) { top_ = top; }
245 // array_[(top - 1) & mask_] is the top element in the deque. The Deque is
246 // empty when top_ == bottom_. It is full when top_ + 1 == bottom
253 DISALLOW_COPY_AND_ASSIGN(MarkingDeque);
257 class SlotsBufferAllocator {
259 SlotsBuffer* AllocateBuffer(SlotsBuffer* next_buffer);
260 void DeallocateBuffer(SlotsBuffer* buffer);
262 void DeallocateChain(SlotsBuffer** buffer_address);
266 // SlotsBuffer records a sequence of slots that has to be updated
267 // after live objects were relocated from evacuation candidates.
268 // All slots are either untyped or typed:
269 // - Untyped slots are expected to contain a tagged object pointer.
270 // They are recorded by an address.
271 // - Typed slots are expected to contain an encoded pointer to a heap
272 // object where the way of encoding depends on the type of the slot.
273 // They are recorded as a pair (SlotType, slot address).
274 // We assume that zero-page is never mapped this allows us to distinguish
275 // untyped slots from typed slots during iteration by a simple comparison:
276 // if element of slots buffer is less than NUMBER_OF_SLOT_TYPES then it
277 // is the first element of typed slot's pair.
280 typedef Object** ObjectSlot;
282 explicit SlotsBuffer(SlotsBuffer* next_buffer)
283 : idx_(0), chain_length_(1), next_(next_buffer) {
285 chain_length_ = next_->chain_length_ + 1;
292 void Add(ObjectSlot slot) {
293 ASSERT(0 <= idx_ && idx_ < kNumberOfElements);
294 slots_[idx_++] = slot;
298 EMBEDDED_OBJECT_SLOT,
299 RELOCATED_CODE_OBJECT,
307 void UpdateSlots(Heap* heap);
309 void UpdateSlotsWithFilter(Heap* heap);
311 SlotsBuffer* next() { return next_; }
313 static int SizeOfChain(SlotsBuffer* buffer) {
314 if (buffer == NULL) return 0;
315 return static_cast<int>(buffer->idx_ +
316 (buffer->chain_length_ - 1) * kNumberOfElements);
319 inline bool IsFull() {
320 return idx_ == kNumberOfElements;
323 inline bool HasSpaceForTypedSlot() {
324 return idx_ < kNumberOfElements - 1;
327 static void UpdateSlotsRecordedIn(Heap* heap,
329 bool code_slots_filtering_required) {
330 while (buffer != NULL) {
331 if (code_slots_filtering_required) {
332 buffer->UpdateSlotsWithFilter(heap);
334 buffer->UpdateSlots(heap);
336 buffer = buffer->next();
345 static bool ChainLengthThresholdReached(SlotsBuffer* buffer) {
346 return buffer != NULL && buffer->chain_length_ >= kChainLengthThreshold;
349 static bool AddTo(SlotsBufferAllocator* allocator,
350 SlotsBuffer** buffer_address,
353 SlotsBuffer* buffer = *buffer_address;
354 if (buffer == NULL || buffer->IsFull()) {
355 if (mode == FAIL_ON_OVERFLOW && ChainLengthThresholdReached(buffer)) {
356 allocator->DeallocateChain(buffer_address);
359 buffer = allocator->AllocateBuffer(buffer);
360 *buffer_address = buffer;
366 static bool IsTypedSlot(ObjectSlot slot);
368 static bool AddTo(SlotsBufferAllocator* allocator,
369 SlotsBuffer** buffer_address,
374 static const int kNumberOfElements = 1021;
377 static const int kChainLengthThreshold = 15;
380 intptr_t chain_length_;
382 ObjectSlot slots_[kNumberOfElements];
386 // -------------------------------------------------------------------------
387 // Marker shared between incremental and non-incremental marking
388 template<class BaseMarker> class Marker {
390 Marker(BaseMarker* base_marker, MarkCompactCollector* mark_compact_collector)
391 : base_marker_(base_marker),
392 mark_compact_collector_(mark_compact_collector) {}
394 // Mark pointers in a Map and its DescriptorArray together, possibly
395 // treating transitions or back pointers weak.
396 void MarkMapContents(Map* map);
397 void MarkDescriptorArray(DescriptorArray* descriptors);
398 void MarkAccessorPairSlot(AccessorPair* accessors, int offset);
401 BaseMarker* base_marker() {
405 MarkCompactCollector* mark_compact_collector() {
406 return mark_compact_collector_;
409 BaseMarker* base_marker_;
410 MarkCompactCollector* mark_compact_collector_;
414 // Defined in isolate.h.
415 class ThreadLocalTop;
418 // -------------------------------------------------------------------------
419 // Mark-Compact collector
420 class MarkCompactCollector {
422 // Type of functions to compute forwarding addresses of objects in
423 // compacted spaces. Given an object and its size, return a (non-failure)
424 // Object* that will be the object after forwarding. There is a separate
425 // allocation function for each (compactable) space based on the location
426 // of the object before compaction.
427 typedef MaybeObject* (*AllocationFunction)(Heap* heap,
431 // Type of functions to encode the forwarding address for an object.
432 // Given the object, its size, and the new (non-failure) object it will be
433 // forwarded to, encode the forwarding address. For paged spaces, the
434 // 'offset' input/output parameter contains the offset of the forwarded
435 // object from the forwarding address of the previous live object in the
436 // page as input, and is updated to contain the offset to be used for the
437 // next live object in the same page. For spaces using a different
438 // encoding (i.e., contiguous spaces), the offset parameter is ignored.
439 typedef void (*EncodingFunction)(Heap* heap,
440 HeapObject* old_object,
445 // Type of functions to process non-live objects.
446 typedef void (*ProcessNonLiveFunction)(HeapObject* object, Isolate* isolate);
448 // Pointer to member function, used in IterateLiveObjects.
449 typedef int (MarkCompactCollector::*LiveObjectCallback)(HeapObject* obj);
451 // Set the global flags, it must be called before Prepare to take effect.
452 inline void SetFlags(int flags);
454 static void Initialize();
456 void CollectEvacuationCandidates(PagedSpace* space);
458 void AddEvacuationCandidate(Page* p);
460 // Prepares for GC by resetting relocation info in old and map spaces and
461 // choosing spaces to compact.
462 void Prepare(GCTracer* tracer);
464 // Performs a global garbage collection.
465 void CollectGarbage();
467 enum CompactionMode {
468 INCREMENTAL_COMPACTION,
469 NON_INCREMENTAL_COMPACTION
472 bool StartCompaction(CompactionMode mode);
474 void AbortCompaction();
476 // During a full GC, there is a stack-allocated GCTracer that is used for
477 // bookkeeping information. Return a pointer to that tracer.
478 GCTracer* tracer() { return tracer_; }
481 // Checks whether performing mark-compact collection.
482 bool in_use() { return state_ > PREPARE_GC; }
483 bool are_map_pointers_encoded() { return state_ == UPDATE_POINTERS; }
486 // Determine type of object and emit deletion log event.
487 static void ReportDeleteIfNeeded(HeapObject* obj, Isolate* isolate);
489 // Distinguishable invalid map encodings (for single word and multiple words)
490 // that indicate free regions.
491 static const uint32_t kSingleFreeEncoding = 0;
492 static const uint32_t kMultiFreeEncoding = 1;
494 static inline bool IsMarked(Object* obj);
496 inline Heap* heap() const { return heap_; }
498 CodeFlusher* code_flusher() { return code_flusher_; }
499 inline bool is_code_flushing_enabled() const { return code_flusher_ != NULL; }
500 void EnableCodeFlushing(bool enable);
509 void VerifyMarkbitsAreClean();
510 static void VerifyMarkbitsAreClean(PagedSpace* space);
511 static void VerifyMarkbitsAreClean(NewSpace* space);
514 // Sweep a single page from the given space conservatively.
515 // Return a number of reclaimed bytes.
516 static intptr_t SweepConservatively(PagedSpace* space, Page* p);
518 INLINE(static bool ShouldSkipEvacuationSlotRecording(Object** anchor)) {
519 return Page::FromAddress(reinterpret_cast<Address>(anchor))->
520 ShouldSkipEvacuationSlotRecording();
523 INLINE(static bool ShouldSkipEvacuationSlotRecording(Object* host)) {
524 return Page::FromAddress(reinterpret_cast<Address>(host))->
525 ShouldSkipEvacuationSlotRecording();
528 INLINE(static bool IsOnEvacuationCandidate(Object* obj)) {
529 return Page::FromAddress(reinterpret_cast<Address>(obj))->
530 IsEvacuationCandidate();
533 void EvictEvacuationCandidate(Page* page) {
534 if (FLAG_trace_fragmentation) {
535 PrintF("Page %p is too popular. Disabling evacuation.\n",
536 reinterpret_cast<void*>(page));
539 // TODO(gc) If all evacuation candidates are too popular we
540 // should stop slots recording entirely.
541 page->ClearEvacuationCandidate();
543 // We were not collecting slots on this page that point
544 // to other evacuation candidates thus we have to
545 // rescan the page after evacuation to discover and update all
546 // pointers to evacuated objects.
547 if (page->owner()->identity() == OLD_DATA_SPACE) {
548 evacuation_candidates_.RemoveElement(page);
550 page->SetFlag(Page::RESCAN_ON_EVACUATION);
554 void RecordRelocSlot(RelocInfo* rinfo, Object* target);
555 void RecordCodeEntrySlot(Address slot, Code* target);
557 INLINE(void RecordSlot(Object** anchor_slot, Object** slot, Object* object));
559 void MigrateObject(Address dst,
562 AllocationSpace to_old_space);
564 bool TryPromoteObject(HeapObject* object, int object_size);
566 inline Object* encountered_weak_maps() { return encountered_weak_maps_; }
567 inline void set_encountered_weak_maps(Object* weak_map) {
568 encountered_weak_maps_ = weak_map;
571 void InvalidateCode(Code* code);
573 void ClearMarkbits();
575 bool is_compacting() const { return compacting_; }
578 MarkCompactCollector();
579 ~MarkCompactCollector();
581 bool MarkInvalidatedCode();
582 void RemoveDeadInvalidatedCode();
583 void ProcessInvalidatedCode(ObjectVisitor* visitor);
587 enum CollectorState {
592 ENCODE_FORWARDING_ADDRESSES,
597 // The current stage of the collector.
598 CollectorState state_;
601 // Global flag that forces sweeping to be precise, so we can traverse the
603 bool sweep_precisely_;
605 bool reduce_memory_footprint_;
607 bool abort_incremental_marking_;
609 // True if we are collecting slots to perform evacuation from evacuation
613 bool was_marked_incrementally_;
615 bool flush_monomorphic_ics_;
617 // A pointer to the current stack-allocated GC tracer object during a full
618 // collection (NULL before and after).
621 SlotsBufferAllocator slots_buffer_allocator_;
623 SlotsBuffer* migration_slots_buffer_;
625 // Finishes GC, performs heap verification if enabled.
628 // -----------------------------------------------------------------------
629 // Phase 1: Marking live objects.
631 // Before: The heap has been prepared for garbage collection by
632 // MarkCompactCollector::Prepare() and is otherwise in its
635 // After: Live objects are marked and non-live objects are unmarked.
637 friend class RootMarkingVisitor;
638 friend class MarkingVisitor;
639 friend class StaticMarkingVisitor;
640 friend class CodeMarkingVisitor;
641 friend class SharedFunctionInfoMarkingVisitor;
642 friend class Marker<IncrementalMarking>;
643 friend class Marker<MarkCompactCollector>;
645 // Mark non-optimize code for functions inlined into the given optimized
646 // code. This will prevent it from being flushed.
647 void MarkInlinedFunctionsCode(Code* code);
649 // Mark code objects that are active on the stack to prevent them
650 // from being flushed.
651 void PrepareThreadForCodeFlushing(Isolate* isolate, ThreadLocalTop* top);
653 void PrepareForCodeFlushing();
655 // Marking operations for objects reachable from roots.
656 void MarkLiveObjects();
660 // Marks the object black and pushes it on the marking stack.
661 // Returns true if object needed marking and false otherwise.
662 // This is for non-incremental marking only.
663 INLINE(bool MarkObjectAndPush(HeapObject* obj));
665 // Marks the object black and pushes it on the marking stack.
666 // This is for non-incremental marking only.
667 INLINE(void MarkObject(HeapObject* obj, MarkBit mark_bit));
669 // Marks the object black without pushing it on the marking stack.
670 // Returns true if object needed marking and false otherwise.
671 // This is for non-incremental marking only.
672 INLINE(bool MarkObjectWithoutPush(HeapObject* obj));
674 // Marks the object black assuming that it is not yet marked.
675 // This is for non-incremental marking only.
676 INLINE(void SetMark(HeapObject* obj, MarkBit mark_bit));
678 void ProcessNewlyMarkedObject(HeapObject* obj);
680 // Mark the heap roots and all objects reachable from them.
681 void MarkRoots(RootMarkingVisitor* visitor);
683 // Mark the symbol table specially. References to symbols from the
684 // symbol table are weak.
685 void MarkSymbolTable();
687 // Mark objects in object groups that have at least one object in the
689 void MarkObjectGroups();
691 // Mark objects in implicit references groups if their parent object
693 void MarkImplicitRefGroups();
695 // Mark all objects which are reachable due to host application
696 // logic like object groups or implicit references' groups.
697 void ProcessExternalMarking();
699 // Mark objects reachable (transitively) from objects in the marking stack
700 // or overflowed in the heap.
701 void ProcessMarkingDeque();
703 // Mark objects reachable (transitively) from objects in the marking
704 // stack. This function empties the marking stack, but may leave
705 // overflowed objects in the heap, in which case the marking stack's
706 // overflow flag will be set.
707 void EmptyMarkingDeque();
709 // Refill the marking stack with overflowed objects from the heap. This
710 // function either leaves the marking stack full or clears the overflow
711 // flag on the marking stack.
712 void RefillMarkingDeque();
714 // After reachable maps have been marked process per context object
715 // literal map caches removing unmarked entries.
716 void ProcessMapCaches();
718 // Callback function for telling whether the object *p is an unmarked
720 static bool IsUnmarkedHeapObject(Object** p);
722 // Map transitions from a live map to a dead map must be killed.
723 // We replace them with a null descriptor, with the same key.
724 void ClearNonLiveTransitions();
725 void ClearNonLivePrototypeTransitions(Map* map);
726 void ClearNonLiveMapTransitions(Map* map, MarkBit map_mark);
728 // Marking detaches initial maps from SharedFunctionInfo objects
729 // to make this reference weak. We need to reattach initial maps
730 // back after collection. This is either done during
731 // ClearNonLiveTransitions pass or by calling this function.
732 void ReattachInitialMaps();
734 // Mark all values associated with reachable keys in weak maps encountered
735 // so far. This might push new object or even new weak maps onto the
737 void ProcessWeakMaps();
739 // After all reachable objects have been marked those weak map entries
740 // with an unreachable key are removed from all encountered weak maps.
741 // The linked list of all encountered weak maps is destroyed.
742 void ClearWeakMaps();
744 // -----------------------------------------------------------------------
745 // Phase 2: Sweeping to clear mark bits and free non-live objects for
746 // a non-compacting collection.
748 // Before: Live objects are marked and non-live objects are unmarked.
750 // After: Live objects are unmarked, non-live regions have been added to
751 // their space's free list. Active eden semispace is compacted by
755 // If we are not compacting the heap, we simply sweep the spaces except
756 // for the large object space, clearing mark bits and adding unmarked
757 // regions to each space's free list.
760 void EvacuateNewSpace();
762 void EvacuateLiveObjectsFromPage(Page* p);
764 void EvacuatePages();
766 void EvacuateNewSpaceAndCandidates();
768 void SweepSpace(PagedSpace* space, SweeperType sweeper);
771 friend class MarkObjectVisitor;
772 static void VisitObject(HeapObject* obj);
774 friend class UnmarkObjectVisitor;
775 static void UnmarkObject(HeapObject* obj);
779 MarkingDeque marking_deque_;
780 CodeFlusher* code_flusher_;
781 Object* encountered_weak_maps_;
782 Marker<MarkCompactCollector> marker_;
784 List<Page*> evacuation_candidates_;
785 List<Code*> invalidated_code_;
791 const char* AllocationSpaceName(AllocationSpace space);
793 } } // namespace v8::internal
795 #endif // V8_MARK_COMPACT_H_