Add enabling perf and its options to Parameters struct

This allows users to set these. Also disabled perf when not running on Linux, this won't be enough to pass tests as perf is not always available. I want to default to perf on so work needs to be done. Also docs + tests to do.

Author: Zentrik

docs/src/manual.md

@@ -85,6 +85,8 @@ You can pass the following keyword arguments to `@benchmark`, `@benchmarkable`,
 - `gcsample`: If `true`, run `gc()` before each sample. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.gcsample = false`.
 - `time_tolerance`: The noise tolerance for the benchmark's time estimate, as a percentage. This is utilized after benchmark execution, when analyzing results. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.time_tolerance = 0.05`.
 - `memory_tolerance`: The noise tolerance for the benchmark's memory estimate, as a percentage. This is utilized after benchmark execution, when analyzing results. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.memory_tolerance = 0.01`.
+- `experimental_enable_linux_perf`: 
+- `linux_perf_opts`:
 
 To change the default values of the above fields, one can mutate the fields of `BenchmarkTools.DEFAULT_PARAMETERS`, for example:
 

src/execution.jl

@@ -540,9 +540,6 @@ function generate_benchmark_definition(
             end
         )
     end
-    experimental_enable_linux_perf = true # TODO: take this as input from the user
-    # TODO: let the user actually provide these options.
-    linux_perf_opts = LinuxPerf.parse_pstats_options([])
     return Core.eval(
         eval_module,
         quote
@@ -575,13 +572,13 @@ function generate_benchmark_definition(
                         __evals,
                     ),
                 )
-                if $(experimental_enable_linux_perf)
+                if $(params.experimental_enable_linux_perf)
                     # Based on https://github.com/JuliaPerf/LinuxPerf.jl/blob/a7fee0ff261a5b5ce7a903af7b38d1b5c27dd931/src/LinuxPerf.jl#L1043-L1061
                     __linux_perf_groups = BenchmarkTools.LinuxPerf.set_default_spaces(
-                        $(linux_perf_opts.events), $(linux_perf_opts.spaces)
+                        $(params.linux_perf_options.events), $(params.linux_perf_options.spaces)
                     )
                     __linux_perf_bench = BenchmarkTools.LinuxPerf.make_bench_threaded(
-                        __linux_perf_groups; threads=$(linux_perf_opts.threads)
+                        __linux_perf_groups; threads=$(params.linux_perf_options.threads)
                     )
                     BenchmarkTools.LinuxPerf.enable!(__linux_perf_bench)
                     # We'll just run it one time.
@@ -595,6 +592,9 @@ function generate_benchmark_definition(
                             __linux_perf_bench
                         )
                     end
+                else
+                    __return_val_2 = nothing
+                    __linux_perf_stats = nothing
                 end
                 return BenchmarkTools.TrialContents(
                     __time,

src/parameters.jl

@@ -15,9 +15,12 @@ mutable struct Parameters
     gcsample::Bool
     time_tolerance::Float64
     memory_tolerance::Float64
+    experimental_enable_linux_perf::Bool
+    linux_perf_options::@NamedTuple{events::Expr, spaces::Expr, threads::Bool}
 end
 
-const DEFAULT_PARAMETERS = Parameters(5.0, 10000, 1, false, 0, true, false, 0.05, 0.01)
+# TODO: determine whether perf is available
+const DEFAULT_PARAMETERS = Parameters(5.0, 10000, 1, false, 0, true, false, 0.05, 0.01, Sys.islinux(), LinuxPerf.parse_pstats_options([]))
 
 function Parameters(;
     seconds=DEFAULT_PARAMETERS.seconds,
@@ -29,6 +32,8 @@ function Parameters(;
     gcsample=DEFAULT_PARAMETERS.gcsample,
     time_tolerance=DEFAULT_PARAMETERS.time_tolerance,
     memory_tolerance=DEFAULT_PARAMETERS.memory_tolerance,
+    experimental_enable_linux_perf=DEFAULT_PARAMETERS.experimental_enable_linux_perf,
+    linux_perf_options=DEFAULT_PARAMETERS.linux_perf_options,
 )
     return Parameters(
         seconds,
@@ -40,6 +45,8 @@ function Parameters(;
         gcsample,
         time_tolerance,
         memory_tolerance,
+        experimental_enable_linux_perf,
+        linux_perf_options,
     )
 end
 
@@ -53,6 +60,8 @@ function Parameters(
     gcsample=nothing,
     time_tolerance=nothing,
     memory_tolerance=nothing,
+    experimental_enable_linux_perf=nothing,
+    linux_perf_options=nothing,
 )
     params = Parameters()
     params.seconds = seconds != nothing ? seconds : default.seconds
@@ -65,6 +74,10 @@ function Parameters(
         time_tolerance != nothing ? time_tolerance : default.time_tolerance
     params.memory_tolerance =
         memory_tolerance != nothing ? memory_tolerance : default.memory_tolerance
+    params.experimental_enable_linux_perf =
+        experimental_enable_linux_perf != nothing ? experimental_enable_linux_perf : default.experimental_enable_linux_perf
+    params.linux_perf_options =
+        linux_perf_options != nothing ? linux_perf_options : default.linux_perf_options
     return params::BenchmarkTools.Parameters
 end
 
@@ -76,7 +89,9 @@ 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.experimental_enable_linux_perf == b.experimental_enable_linux_perf &&
+           a.linux_perf_options == b.linux_perf_options
 end
 
 function Base.copy(p::Parameters)
@@ -90,6 +105,8 @@ function Base.copy(p::Parameters)
         p.gcsample,
         p.time_tolerance,
         p.memory_tolerance,
+        p.experimental_enable_linux_perf,
+        p.linux_perf_options, # Is this really a copy, the values contain Expr's which store Vector's.
     )
 end