Update benchmarks

- Add concurrent benchmark
- Cleaned up
- Add results to README

Author: markus-wa

README.md

@@ -91,10 +91,41 @@ This doesn't look too interesting on it's own but that can be helped by quickly
 * Access to all net-messages
 * Chat & console messages <sup id="achat1">1</sup>
 * [Easy debugging](#debugging) via build-flags
-* Built with concurrency in mind
+* Built with performance & concurrency in mind
 
 1. <small id="f1">Only for some demos; in MM demos the chat is encrypted for example.</small>
 
+## Performance / Benchmarks
+
+One of the top priorities of this parser is performance and concurrency.
+
+Here are some benchmark results from a system with a Intel i7 2600k CPU and SSD disk running Windows 10 and a demo with 85'000 frames.
+
+### Overview
+
+|Benchmark|Description|Average Duration|Speed|
+|-|-|-|-|
+|`BenchmarkConcurrent`|Read and parse 8 demos concurrently|2.90 s (per 8 demos)|~234'000 ticks / s|
+|`BenchmarkDemoInfoCs`|Read demo from drive and parse|1.39 s|~61'000 ticks / s
+|`BenchmarkInMemory`|Read demo from memory and parse|1.38 s|~61'000 ticks / s
+
+### Raw output
+
+```
+$ go test -run _NONE_ -bench . -benchtime 30s -benchmem -concurrentdemos 8
+goos: windows
+goarch: amd64
+pkg: github.com/markus-wa/demoinfocs-golang
+BenchmarkDemoInfoCs-8                 30        1397398190 ns/op        162254528 B/op    839779 allocs/op
+BenchmarkInMemory-8                   30        1384877250 ns/op        162109924 B/op    839628 allocs/op
+BenchmarkConcurrent-8                 20        2902574295 ns/op        1297042534 B/op  6717163 allocs/op
+--- BENCH: BenchmarkConcurrent-8
+        demoinfocs_test.go:425: Running concurrency benchmark with 8 demos
+        demoinfocs_test.go:425: Running concurrency benchmark with 8 demos
+PASS
+ok      github.com/markus-wa/demoinfocs-golang  147.800s
+```
+
 ## Versioning
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/markus-wa/demoinfocs-golang/tags).

demoinfocs_test.go

@@ -3,6 +3,7 @@ package demoinfocs_test
 import (
 	"bytes"
 	"crypto/rand"
+	"flag"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -28,7 +29,12 @@ const defaultDemPath = csDemosPath + "/default.dem"
 const unexpectedEndOfDemoPath = csDemosPath + "/unexpected_end_of_demo.dem"
 const valveMatchmakingDemoPath = csDemosPath + "/valve_matchmaking.dem"
 
+var concurrentDemos int
+
 func init() {
+	flag.IntVar(&concurrentDemos, "concurrentdemos", 2, "The `number` of current demos")
+	flag.Parse()
+
 	if _, err := os.Stat(defaultDemPath); err != nil {
 		panic(fmt.Sprintf("Failed to read test demo %q", defaultDemPath))
 	}
@@ -287,36 +293,46 @@ func TestHeaderNotParsed(t *testing.T) {
 }
 
 func TestConcurrent(t *testing.T) {
+	t.Logf("Running concurrency test with %d demos\n", concurrentDemos)
+
 	var i int64
 	runner := func() {
-		f, err := os.Open(defaultDemPath)
-		if err != nil {
-			t.Fatal(err)
-		}
-		defer f.Close()
-
-		p := dem.NewParser(f)
-
-		_, err = p.ParseHeader()
-		if err != nil {
-			t.Fatal(err)
-		}
-
 		n := atomic.AddInt64(&i, 1)
-		fmt.Printf("Starting runner %d\n", n)
+		fmt.Printf("Starting concurrent runner %d\n", n)
 
 		ts := time.Now()
 
-		err = p.ParseToEnd()
-		if err != nil {
-			t.Fatal(err)
-		}
+		parseDefaultDemo(t)
 
 		fmt.Printf("Runner %d took %s\n", n, time.Since(ts))
 	}
 
+	runConcurrently(runner)
+}
+
+func parseDefaultDemo(tb testing.TB) {
+	f, err := os.Open(defaultDemPath)
+	if err != nil {
+		tb.Fatal(err)
+	}
+	defer f.Close()
+
+	p := dem.NewParser(f)
+
+	_, err = p.ParseHeader()
+	if err != nil {
+		tb.Fatal(err)
+	}
+
+	err = p.ParseToEnd()
+	if err != nil {
+		tb.Fatal(err)
+	}
+}
+
+func runConcurrently(runner func()) {
 	var wg sync.WaitGroup
-	for j := 0; j < 2; j++ {
+	for i := 0; i < concurrentDemos; i++ {
 		wg.Add(1)
 		go func() { runner(); wg.Done() }()
 	}
@@ -344,7 +360,7 @@ func TestDemoSet(t *testing.T) {
 				defer func() {
 					pErr := recover()
 					if pErr != nil {
-						t.Errorf("Failed to parse '%s/%s': %s\n", demSetPath, name, pErr)
+						t.Errorf("Parsing of '%s/%s' paniced: %s\n", demSetPath, name, pErr)
 					}
 				}()
 
@@ -367,29 +383,7 @@ func TestDemoSet(t *testing.T) {
 
 func BenchmarkDemoInfoCs(b *testing.B) {
 	for i := 0; i < b.N; i++ {
-		func() {
-			f, err := os.Open(defaultDemPath)
-			if err != nil {
-				b.Fatal(err)
-			}
-			defer f.Close()
-
-			p := dem.NewParser(f)
-
-			_, err = p.ParseHeader()
-			if err != nil {
-				b.Fatal(err)
-			}
-
-			ts := time.Now()
-
-			err = p.ParseToEnd()
-			if err != nil {
-				b.Fatal(err)
-			}
-
-			b.Logf("Took %s\n", time.Since(ts))
-		}()
+		parseDefaultDemo(b)
 	}
 }
 
@@ -420,13 +414,17 @@ func BenchmarkInMemory(b *testing.B) {
 			b.Fatal(err)
 		}
 
-		ts := time.Now()
-
 		err = p.ParseToEnd()
 		if err != nil {
 			b.Fatal(err)
 		}
+	}
+}
 
-		b.Logf("Took %s\n", time.Since(ts))
+func BenchmarkConcurrent(b *testing.B) {
+	b.Logf("Running concurrency benchmark with %d demos\n", concurrentDemos)
+
+	for i := 0; i < b.N; i++ {
+		runConcurrently(func() { parseDefaultDemo(b) })
 	}
 }