Merge non-moving garbage collector
authorBen Gamari <ben@smart-cactus.org>
Wed, 23 Oct 2019 18:01:45 +0000 (14:01 -0400)
committerBen Gamari <ben@smart-cactus.org>
Wed, 23 Oct 2019 18:56:46 +0000 (14:56 -0400)
This introduces a concurrent mark & sweep garbage collector to manage the old
generation. The concurrent nature of this collector typically results in
significantly reduced maximum and mean pause times in applications with large
working sets.

Due to the large and intricate nature of the change I have opted to
preserve the fully-buildable history, including merge commits, which is
described in the "Branch overview" section below.

Collector design
================

The full design of the collector implemented here is described in detail
in a technical note

> B. Gamari. "A Concurrent Garbage Collector For the Glasgow Haskell
> Compiler" (2018)

This document can be requested from @bgamari.
The basic heap structure used in this design is heavily inspired by

> K. Ueno & A. Ohori. "A fully concurrent garbage collector for
> functional programs on multicore processors." /ACM SIGPLAN Notices/
> Vol. 51. No. 9 (presented at ICFP 2016)

This design is intended to allow both marking and sweeping
concurrent to execution of a multi-core mutator. Unlike the Ueno design,
which requires no global synchronization pauses, the collector
introduced here requires a stop-the-world pause at the beginning and end
of the mark phase.

To avoid heap fragmentation, the allocator consists of a number of
fixed-size /sub-allocators/. Each of these sub-allocators allocators into
its own set of /segments/, themselves allocated from the block
allocator. Each segment is broken into a set of fixed-size allocation
blocks (which back allocations) in addition to a bitmap (used to track
the liveness of blocks) and some additional metadata (used also used
to track liveness).

This heap structure enables collection via mark-and-sweep, which can be
performed concurrently via a snapshot-at-the-beginning scheme (although
concurrent collection is not implemented in this patch).

Implementation structure
========================

The majority of the collector is implemented in a handful of files:

 * `rts/Nonmoving.c` is the heart of the beast. It implements the entry-point
   to the nonmoving collector (`nonmoving_collect`), as well as the allocator
   (`nonmoving_allocate`) and a number of utilities for manipulating the heap.

 * `rts/NonmovingMark.c` implements the mark queue functionality, update
   remembered set, and mark loop.

 * `rts/NonmovingSweep.c` implements the sweep loop.

 * `rts/NonmovingScav.c` implements the logic necessary to scavenge the
   nonmoving heap.

Branch overview
===============

```
 * wip/gc/opt-pause:
 |   A variety of small optimisations to further reduce pause times.
 |
 * wip/gc/compact-nfdata:
 |   Introduce support for compact regions into the non-moving
 |\  collector
 | \
 |  \
 | | * wip/gc/segment-header-to-bdescr:
 | | |   Another optimization that we are considering, pushing
 | | |   some segment metadata into the segment descriptor for
 | | |   the sake of locality during mark
 | | |
 | * | wip/gc/shortcutting:
 | | |   Support for indirection shortcutting and the selector optimization
 | | |   in the non-moving heap.
 | | |
 * | | wip/gc/docs:
 | |/    Work on implementation documentation.
 | /
 |/
 * wip/gc/everything:
 |   A roll-up of everything below.
 |\
 | \
 | |\
 | | \
 | | * wip/gc/optimize:
 | | |   A variety of optimizations, primarily to the mark loop.
 | | |   Some of these are microoptimizations but a few are quite
 | | |   significant. In particular, the prefetch patches have
 | | |   produced a nontrivial improvement in mark performance.
 | | |
 | | * wip/gc/aging:
 | | |   Enable support for aging in major collections.
 | | |
 | * | wip/gc/test:
 | | |   Fix up the testsuite to more or less pass.
 | | |
 * | | wip/gc/instrumentation:
 | | |   A variety of runtime instrumentation including statistics
 | | /   support, the nonmoving census, and eventlog support.
 | |/
 | /
 |/
 * wip/gc/nonmoving-concurrent:
 |   The concurrent write barriers.
 |
 * wip/gc/nonmoving-nonconcurrent:
 |   The nonmoving collector without the write barriers necessary
 |   for concurrent collection.
 |
 * wip/gc/preparation:
 |   A merge of the various preparatory patches that aren't directly
 |   implementing the GC.
 |
 |
 * GHC HEAD
 .
 .
 .
```

17 files changed:
1  2 
includes/Rts.h
includes/rts/EventLogFormat.h
includes/stg/SMP.h
includes/stg/Types.h
libraries/base/tests/all.T
rts/Capability.h
rts/PrimOps.cmm
rts/RtsSymbols.c
rts/Schedule.c
rts/Schedule.h
rts/Trace.c
rts/Trace.h
rts/eventlog/EventLog.c
rts/eventlog/EventLog.h
rts/ghc.mk
rts/rts.cabal.in
testsuite/tests/perf/compiler/all.T

diff --cc includes/Rts.h
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
Simple merge
diff --cc rts/PrimOps.cmm
Simple merge
Simple merge
diff --cc rts/Schedule.c
Simple merge
diff --cc rts/Schedule.h
Simple merge
diff --cc rts/Trace.c
Simple merge
diff --cc rts/Trace.h
@@@ -301,12 -304,18 +304,22 @@@ void traceHeapProfCostCentre(StgWord32 
                               StgBool is_caf);
  void traceHeapProfSampleCostCentre(StgWord8 profile_id,
                                     CostCentreStack *stack, StgWord residency);
 +
 +void traceProfSampleCostCentre(Capability *cap,
 +                               CostCentreStack *stack, StgWord ticks);
 +void traceProfBegin(void);
  #endif /* PROFILING */
  
+ void traceConcMarkBegin(void);
+ void traceConcMarkEnd(StgWord32 marked_obj_count);
+ void traceConcSyncBegin(void);
+ void traceConcSyncEnd(void);
+ void traceConcSweepBegin(void);
+ void traceConcSweepEnd(void);
+ void traceConcUpdRemSetFlush(Capability *cap);
+ void traceNonmovingHeapCensus(uint32_t log_blk_size,
+                               const struct NonmovingAllocCensus *census);
  void flushTrace(void);
  
  #else /* !TRACING */
@@@ -107,9 -107,15 +107,17 @@@ char *EventDesc[] = 
    [EVENT_HEAP_PROF_SAMPLE_END]    = "End of heap profile sample",
    [EVENT_HEAP_PROF_SAMPLE_STRING] = "Heap profile string sample",
    [EVENT_HEAP_PROF_SAMPLE_COST_CENTRE] = "Heap profile cost-centre sample",
-   [EVENT_USER_BINARY_MSG]     = "User binary message"
 +  [EVENT_PROF_SAMPLE_COST_CENTRE] = "Time profile cost-centre stack",
 +  [EVENT_PROF_BEGIN] = "Start of a time profile",
+   [EVENT_USER_BINARY_MSG]     = "User binary message",
+   [EVENT_CONC_MARK_BEGIN]        = "Begin concurrent mark phase",
+   [EVENT_CONC_MARK_END]          = "End concurrent mark phase",
+   [EVENT_CONC_SYNC_BEGIN]        = "Begin concurrent GC synchronisation",
+   [EVENT_CONC_SYNC_END]          = "End concurrent GC synchronisation",
+   [EVENT_CONC_SWEEP_BEGIN]       = "Begin concurrent sweep",
+   [EVENT_CONC_SWEEP_END]         = "End concurrent sweep",
+   [EVENT_CONC_UPD_REM_SET_FLUSH] = "Update remembered set flushed",
+   [EVENT_NONMOVING_HEAP_CENSUS]  = "Nonmoving heap census"
  };
  
  // Event type.
@@@ -157,13 -159,13 +159,18 @@@ void postHeapProfCostCentre(StgWord32 c
  void postHeapProfSampleCostCentre(StgWord8 profile_id,
                                    CostCentreStack *stack,
                                    StgWord64 residency);
 +
 +void postProfSampleCostCentre(Capability *cap,
 +                              CostCentreStack *stack,
 +                              StgWord64 ticks);
 +void postProfBegin(void);
  #endif /* PROFILING */
  
+ void postConcUpdRemSetFlush(Capability *cap);
+ void postConcMarkEnd(StgWord32 marked_obj_count);
+ void postNonmovingHeapCensus(int log_blk_size,
+                              const struct NonmovingAllocCensus *census);
  #else /* !TRACING */
  
  INLINE_HEADER void postSchedEvent (Capability *cap  STG_UNUSED,
diff --cc rts/ghc.mk
Simple merge
Simple merge
Simple merge