From 27920c8ddc609662540deaf5a3d3b4fce03abeea Mon Sep 17 00:00:00 2001
From: Austin Clements <austin@google.com>
Date: Fri, 28 Jul 2017 13:51:58 -0400
Subject: [PATCH] internal/trace: flags for what to include in GC utilization

Change-Id: I4ba963b003cb25b39d7575d423f17930d84f3f69
Reviewed-on: https://go-review.googlesource.com/c/60796
Run-TryBot: Austin Clements <austin@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
---
 src/cmd/trace/mmu.go                |  2 +-
 src/internal/traceparser/gc.go      | 48 ++++++++++++++++++++++++-----
 src/internal/traceparser/gc_test.go |  4 +--
 3 files changed, 43 insertions(+), 11 deletions(-)

diff --git a/src/cmd/trace/mmu.go b/src/cmd/trace/mmu.go
index f76e0d0e5f..2a07be4ba2 100644
--- a/src/cmd/trace/mmu.go
+++ b/src/cmd/trace/mmu.go
@@ -38,7 +38,7 @@ func getMMUCurve() ([]trace.MutatorUtil, *trace.MMUCurve, error) {
 		if err != nil {
 			mmuCache.err = err
 		} else {
-			mmuCache.util = tr.MutatorUtilization()
+			mmuCache.util = tr.MutatorUtilization(trace.UtilSTW | trace.UtilBackground | trace.UtilAssist)
 			mmuCache.mmuCurve = trace.NewMMUCurve(mmuCache.util)
 		}
 	})
diff --git a/src/internal/traceparser/gc.go b/src/internal/traceparser/gc.go
index 313e23edf6..ab0c640e26 100644
--- a/src/internal/traceparser/gc.go
+++ b/src/internal/traceparser/gc.go
@@ -22,11 +22,27 @@ type MutatorUtil struct {
 	Util float64
 }
 
+// UtilFlags controls the behavior of MutatorUtilization.
+type UtilFlags int
+
+const (
+	// UtilSTW means utilization should account for STW events.
+	UtilSTW UtilFlags = 1 << iota
+	// UtilBackground means utilization should account for
+	// background mark workers.
+	UtilBackground
+	// UtilAssist means utilization should account for mark
+	// assists.
+	UtilAssist
+	// UtilSweep means utilization should account for sweeping.
+	UtilSweep
+)
+
 // MutatorUtilization returns the mutator utilization function for the
 // given trace. This function will always end with 0 utilization. The
 // bounds of the function are implicit in the first and last event;
 // outside of these bounds the function is undefined.
-func (p *Parsed) MutatorUtilization() []MutatorUtil {
+func (p *Parsed) MutatorUtilization(flags UtilFlags) []MutatorUtil {
 	events := p.Events
 	if len(events) == 0 {
 		return nil
@@ -42,17 +58,33 @@ func (p *Parsed) MutatorUtilization() []MutatorUtil {
 		case EvGomaxprocs:
 			gomaxprocs = int(ev.Args[0])
 		case EvGCSTWStart:
-			stw++
+			if flags&UtilSTW != 0 {
+				stw++
+			}
 		case EvGCSTWDone:
-			stw--
+			if flags&UtilSTW != 0 {
+				stw--
+			}
 		case EvGCMarkAssistStart:
-			gcPs++
-			assists[ev.G] = true
+			if flags&UtilAssist != 0 {
+				gcPs++
+				assists[ev.G] = true
+			}
 		case EvGCMarkAssistDone:
-			gcPs--
-			delete(assists, ev.G)
+			if flags&UtilAssist != 0 {
+				gcPs--
+				delete(assists, ev.G)
+			}
+		case EvGCSweepStart:
+			if flags&UtilSweep != 0 {
+				gcPs++
+			}
+		case EvGCSweepDone:
+			if flags&UtilSweep != 0 {
+				gcPs--
+			}
 		case EvGoStartLabel:
-			if strings.HasPrefix(ev.SArgs[0], "GC ") && ev.SArgs[0] != "GC (idle)" {
+			if flags&UtilBackground != 0 && strings.HasPrefix(ev.SArgs[0], "GC ") && ev.SArgs[0] != "GC (idle)" {
 				// Background mark worker.
 				bgMark[ev.G] = true
 				gcPs++
diff --git a/src/internal/traceparser/gc_test.go b/src/internal/traceparser/gc_test.go
index 65772be717..f1416fa9f9 100644
--- a/src/internal/traceparser/gc_test.go
+++ b/src/internal/traceparser/gc_test.go
@@ -84,7 +84,7 @@ func TestMMUTrace(t *testing.T) {
 	if err := p.Parse(0, 1<<62, nil); err != nil {
 		t.Fatalf("failed to parse trace: %s", err)
 	}
-	mu := p.MutatorUtilization()
+	mu := p.MutatorUtilization(UtilSTW | UtilBackground | UtilAssist)
 	mmuCurve := NewMMUCurve(mu)
 
 	// Test the optimized implementation against the "obviously
@@ -106,7 +106,7 @@ func BenchmarkMMU(b *testing.B) {
 	if err := p.Parse(0, 1<<62, nil); err != nil {
 		b.Fatalf("failed to parse trace: %s", err)
 	}
-	mu := p.MutatorUtilization()
+	mu := p.MutatorUtilization(UtilSTW | UtilBackground | UtilAssist | UtilSweep)
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-- 
2.48.1