Add parameters for linux perf

Author: Zentrik

src/parameters.jl

@@ -15,9 +15,32 @@ mutable struct Parameters
     gcsample::Bool
     time_tolerance::Float64
     memory_tolerance::Float64
+    enable_linux_perf::Bool
+    linux_perf_groups::String
+    linux_perf_spaces::NTuple{3,Bool}
+    linux_perf_threads::Bool
+    linux_perf_gcscrub::Bool
 end
 
-const DEFAULT_PARAMETERS = Parameters(5.0, 10000, 1, false, 0, true, false, 0.05, 0.01)
+# Task clock has large overhead so is not useful for the short time we run functions under perf
+# Further we benchmark anyways so no need for cycles or task clock
+# I've tried to only use one group by getting rid of noisy or not useful metrics
+const DEFAULT_PARAMETERS = Parameters(
+    5.0,
+    10000,
+    1,
+    false,
+    0,
+    true,
+    false,
+    0.05,
+    0.01,
+    false,
+    "(instructions,branch-instructions)",
+    (true, false, false),
+    true,
+    true,
+)
 
 function Parameters(;
     seconds=DEFAULT_PARAMETERS.seconds,
@@ -29,6 +52,11 @@ function Parameters(;
     gcsample=DEFAULT_PARAMETERS.gcsample,
     time_tolerance=DEFAULT_PARAMETERS.time_tolerance,
     memory_tolerance=DEFAULT_PARAMETERS.memory_tolerance,
+    enable_linux_perf=DEFAULT_PARAMETERS.enable_linux_perf,
+    linux_perf_groups=DEFAULT_PARAMETERS.linux_perf_groups,
+    linux_perf_spaces=DEFAULT_PARAMETERS.linux_perf_spaces,
+    linux_perf_threads=DEFAULT_PARAMETERS.linux_perf_threads,
+    linux_perf_gcscrub=DEFAULT_PARAMETERS.linux_perf_gcscrub,
 )
     return Parameters(
         seconds,
@@ -40,6 +68,11 @@ function Parameters(;
         gcsample,
         time_tolerance,
         memory_tolerance,
+        enable_linux_perf,
+        linux_perf_groups,
+        linux_perf_spaces,
+        linux_perf_threads,
+        linux_perf_gcscrub,
     )
 end
 
@@ -53,6 +86,11 @@ function Parameters(
     gcsample=nothing,
     time_tolerance=nothing,
     memory_tolerance=nothing,
+    enable_linux_perf=nothing,
+    linux_perf_groups=nothing,
+    linux_perf_spaces=nothing,
+    linux_perf_threads=nothing,
+    linux_perf_gcscrub=nothing,
 )
     params = Parameters()
     params.seconds = seconds != nothing ? seconds : default.seconds
@@ -65,6 +103,31 @@ function Parameters(
         time_tolerance != nothing ? time_tolerance : default.time_tolerance
     params.memory_tolerance =
         memory_tolerance != nothing ? memory_tolerance : default.memory_tolerance
+    params.enable_linux_perf = if enable_linux_perf != nothing
+        enable_linux_perf
+    else
+        default.enable_linux_perf
+    end
+    params.linux_perf_groups = if linux_perf_groups != nothing
+        linux_perf_groups
+    else
+        default.linux_perf_groups
+    end
+    params.linux_perf_spaces = if linux_perf_spaces != nothing
+        linux_perf_spaces
+    else
+        default.linux_perf_spaces
+    end
+    params.linux_perf_threads = if linux_perf_threads != nothing
+        linux_perf_threads
+    else
+        default.linux_perf_threads
+    end
+    params.linux_perf_gcscrub = if linux_perf_gcscrub != nothing
+        linux_perf_gcscrub
+    else
+        default.linux_perf_gcscrub
+    end
     return params::BenchmarkTools.Parameters
 end
 
@@ -76,7 +139,12 @@ function Base.:(==)(a::Parameters, b::Parameters)
            a.gctrial == b.gctrial &&
            a.gcsample == b.gcsample &&
            a.time_tolerance == b.time_tolerance &&
-           a.memory_tolerance == b.memory_tolerance
+           a.memory_tolerance == b.memory_tolerance &&
+           a.enable_linux_perf == b.enable_linux_perf &&
+           a.linux_perf_groups == b.linux_perf_groups &&
+           a.linux_perf_spaces == b.linux_perf_spaces &&
+           a.linux_perf_threads == b.linux_perf_threads &&
+           a.linux_perf_gcscrub == b.linux_perf_gcscrub
 end
 
 function Base.copy(p::Parameters)
@@ -90,6 +158,11 @@ function Base.copy(p::Parameters)
         p.gcsample,
         p.time_tolerance,
         p.memory_tolerance,
+        p.enable_linux_perf,
+        p.linux_perf_groups,
+        p.linux_perf_spaces,
+        p.linux_perf_threads,
+        p.linux_perf_gcscrub,
     )
 end