Add utility macros

Co-authored-by: Nathan Daly <[email protected]>

Author: vchuravy

src/LinuxPerf.jl

@@ -2,11 +2,31 @@ module LinuxPerf
 
 using Printf
 
+export @measure, @measured
 export make_bench, enable!, disable!, reset!, reasonable_defaults, counters
 
 import Base: show, length, close
 
-const SYS_perf_event_open = 298
+macro measure(expr, args...)
+    esc(quote
+        local bench
+        _, bench = $LinuxPerf.@measured($expr, $(args...))
+        $counters(bench)
+    end)
+end
+macro measured(expr, events = reasonable_defaults)
+    quote
+        local bench = $make_bench($events);
+        local v
+        try
+            $enable!(bench)
+            v = $(esc(expr))
+        finally
+            $disable!(bench)
+        end
+        (v, bench)
+    end
+end
 
 mutable struct perf_event_attr
     typ::UInt32

test/runtests.jl

@@ -2,18 +2,34 @@ using LinuxPerf
 using Test
 
 import LinuxPerf: make_bench, enable!, disable!, reset!, reasonable_defaults, counters
-const bench = make_bench(reasonable_defaults);
-@noinline function g(a)
-    enable!(bench)
-    c = 0
-    for x in a
-        if x > 0
-            c += 1
+
+@testset "simple benchmark" begin
+    @test begin
+        bench = make_bench(reasonable_defaults);
+        @noinline function g(a)
+            enable!(bench)
+            c = 0
+            for x in a
+                if x > 0
+                    c += 1
+                end
+            end
+            disable!(bench)
+            c
         end
+        g(zeros(10000))
+
+        counters(bench)
+
+        true  # Succeeded without any exceptions...
     end
-    disable!(bench)
-    c
 end
-g(zeros(10000))
 
-counters(bench)
+
+@testset "@measure" begin
+    c1 = @measure 2 + 2
+    v, b1 = @measured 2 + 2
+
+    @test v === 4
+    @test typeof(c1) == typeof(counters(b1))
+end