From be0a8794c22d0c679d5677ddbcafd73b788d8c48 Mon Sep 17 00:00:00 2001
From: Major Taylor <majorjctaylor@gmail.com>
Date: Sat, 18 Apr 2020 21:40:32 -0400
Subject: [PATCH] time: add Timer; refactor benchmark to use Timer

---
 vlib/benchmark/benchmark.v | 45 ++++++++++++----------------
 vlib/time/timer.v          | 60 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+), 26 deletions(-)
 create mode 100644 vlib/time/timer.v

diff --git a/vlib/benchmark/benchmark.v b/vlib/benchmark/benchmark.v
index 6702d9f7ca..82c551cb29 100644
--- a/vlib/benchmark/benchmark.v
+++ b/vlib/benchmark/benchmark.v
@@ -54,10 +54,8 @@ const (
 
 pub struct Benchmark {
 pub mut:
-	bench_start_time i64
-	bench_end_time   i64
-	step_start_time  i64
-	step_end_time    i64
+	bench_timer      time.Timer
+	step_timer       time.Timer
 	ntotal           int
 	nok              int
 	nfail            int
@@ -72,14 +70,14 @@ pub mut:
 
 pub fn new_benchmark() Benchmark {
 	return Benchmark{
-		bench_start_time: benchmark.now()
+		bench_timer: time.new_timer()
 		verbose: true
 	}
 }
 
 pub fn new_benchmark_no_cstep() Benchmark {
 	return Benchmark{
-		bench_start_time: benchmark.now()
+		bench_timer: time.new_timer()
 		verbose: true
 		no_cstep: true
 	}
@@ -87,7 +85,7 @@ pub fn new_benchmark_no_cstep() Benchmark {
 
 pub fn new_benchmark_pointer() &Benchmark {
 	return &Benchmark{
-		bench_start_time: benchmark.now()
+		bench_timer: time.new_timer()
 		verbose: true
 	}
 }
@@ -97,48 +95,48 @@ pub fn (b mut Benchmark) set_total_expected_steps(n int) {
 }
 
 pub fn (b mut Benchmark) stop() {
-	b.bench_end_time = benchmark.now()
+	b.bench_timer.stop()
 }
 
 pub fn (b mut Benchmark) step() {
-	b.step_start_time = benchmark.now()
+	b.step_timer.restart()
 	if !b.no_cstep {
 		b.cstep++
 	}
 }
 
 pub fn (b mut Benchmark) fail() {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 	b.ntotal++
 	b.nfail++
 }
 
 pub fn (b mut Benchmark) ok() {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 	b.ntotal++
 	b.nok++
 }
 
 pub fn (b mut Benchmark) skip() {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 	b.ntotal++
 	b.nskip++
 }
 
 pub fn (b mut Benchmark) fail_many(n int) {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 	b.ntotal += n
 	b.nfail += n
 }
 
 pub fn (b mut Benchmark) ok_many(n int) {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 	b.ntotal += n
 	b.nok += n
 }
 
 pub fn (b mut Benchmark) neither_fail_nor_ok() {
-	b.step_end_time = benchmark.now()
+	b.step_timer.stop()
 }
 
 pub fn start() Benchmark {
@@ -149,7 +147,7 @@ pub fn start() Benchmark {
 
 pub fn (b mut Benchmark) measure(label string) i64 {
 	b.ok()
-	res := b.step_end_time - b.step_start_time
+	res := b.step_timer.elapsed()
 	println(b.step_message_with_label(BSPENT, 'in $label'))
 	b.step()
 	return res
@@ -174,10 +172,10 @@ pub fn (b &Benchmark) step_message_with_label(label string, msg string) string {
 				'${b.cstep:3d}/${b.nexpected_steps:3d}'
 			}
 		}
-		timed_line = b.tdiff_in_ms('[${sprogress}] $msg', b.step_start_time, b.step_end_time)
+		timed_line = b.tdiff_in_ms('[${sprogress}] $msg', b.step_timer.elapsed())
 	}
 	else {
-		timed_line = b.tdiff_in_ms(msg, b.step_start_time, b.step_end_time)
+		timed_line = b.tdiff_in_ms(msg, b.step_timer.elapsed())
 	}
 	return '${label:-5s}${timed_line}'
 }
@@ -203,22 +201,17 @@ pub fn (b &Benchmark) total_message(msg string) string {
 	if b.verbose {
 		tmsg = '<=== total time spent $tmsg'
 	}
-	return '  ' + b.tdiff_in_ms(tmsg, b.bench_start_time, b.bench_end_time)
+	return '  ' + b.tdiff_in_ms(tmsg, b.bench_timer.elapsed())
 }
 
 pub fn (b &Benchmark) total_duration() i64 {
-	return (b.bench_end_time - b.bench_start_time)
+	return b.bench_timer.elapsed()
 }
 
 // //////////////////////////////////////////////////////////////////
-fn (b &Benchmark) tdiff_in_ms(s string, sticks i64, eticks i64) string {
+fn (b &Benchmark) tdiff_in_ms(s string, tdiff i64) string {
 	if b.verbose {
-		tdiff := (eticks - sticks)
 		return '${tdiff:6d} ms $s'
 	}
 	return s
 }
-
-fn now() i64 {
-	return time.ticks()
-}
diff --git a/vlib/time/timer.v b/vlib/time/timer.v
new file mode 100644
index 0000000000..dc7bdde059
--- /dev/null
+++ b/vlib/time/timer.v
@@ -0,0 +1,60 @@
+// Copyright (c) 2019-2020 Alexander Medvednikov. All rights reserved.
+// Use of this source code is governed by an MIT license
+// that can be found in the LICENSE file.
+module time
+
+// Timer struct and functions
+// start and end are # of ms since start of system.
+// When end_ticks == 0, this means the timer is actively "running"
+pub struct Timer {
+	pause_start i64
+pub:
+	start_ticks i64
+	end_ticks   i64
+}
+
+// start Starts the timer. If the timer was paused, restarts counting.
+pub fn (t mut Timer) start() {
+	if t.pause_start == 0 {
+		t.start_ticks = ticks()
+	} else {
+		// We were paused, so pretend like the time we were paused didn't
+		// happen
+		t.start_ticks += ticks() - t.pause_start
+	}
+	t.end_ticks = 0
+	t.pause_start = 0
+}
+
+pub fn (t mut Timer) restart() {
+	t.end_ticks = 0
+	t.pause_start = 0
+	t.start_ticks = ticks()
+}
+
+pub fn (t mut Timer) pause() {
+	t.pause_start = ticks()
+	t.end_ticks = t.pause_start // so elapsed() still keeps track of the cared-amount of time
+}
+
+pub fn (t mut Timer) stop() {
+	t.end_ticks = ticks()
+	t.pause_start = 0
+}
+
+// elapsed If the Timer is stopped, returns the number of milliseconds between
+// the last start and stop.
+// If the Timer is still running, returns the number of milliseconds from the
+// last start to now.
+pub fn (t Timer) elapsed() i64 {
+	if t.end_ticks == 0 {
+		return ticks() - t.start_ticks
+	} else {
+		return t.end_ticks - t.start_ticks
+	}
+}
+
+pub fn new_timer() Timer {
+	return Timer{start_ticks: ticks()}
+}
+