Simplify LinuxPerf parameters

`linux_perf_options` is now significantly simpler, serialization doesn't require LinuxPerf to have a JSON extension.
Removed experimental from parameter name so that it's not breaking when this feature becomes non experimental and also because it isn't experimental in my view.

Author: Zentrik

docs/src/manual.md

@@ -85,8 +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`: If `true`, profile using perf once per sample and return result from last sample. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.experimental_enable_linux_perf`, which is `true` if perf is available and `false` otherwise.
-- `linux_perf_opts`: Options for perf profiling. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.linux_perf_opts = LinuxPerf.parse_pstats_options([])`.
+- `enable_linux_perf`: If `true`, profile using perf once. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.enable_linux_perf`, which is `true` if perf is available and `false` otherwise.
+- `linux_perf_opts`: Options for perf profiling. Defaults to `BenchmarkTools.DEFAULT_PARAMETERS.linux_perf_opts = String[]`. See LinuxPerf.jl for further details.
 
 To change the default values of the above fields, one can mutate the fields of `BenchmarkTools.DEFAULT_PARAMETERS`, for example:
 

src/execution.jl

@@ -117,7 +117,7 @@ function _run(b::Benchmark, p::Parameters; verbose=false, pad="", kwargs...)
         iters += 1
     end
 
-    if p.experimental_enable_linux_perf
+    if p.enable_linux_perf
         params.gcsample && gcscrub()
         trial.linux_perf_stats = b.linux_perf_func(b.quote_vals, params)
     end
@@ -586,15 +586,16 @@ function generate_benchmark_definition(
                 $(Expr(:tuple, quote_vars...)), __params::$BenchmarkTools.Parameters
             )
                 # Based on https://github.com/JuliaPerf/LinuxPerf.jl/blob/a7fee0ff261a5b5ce7a903af7b38d1b5c27dd931/src/LinuxPerf.jl#L1043-L1061
+                __linux_perf_options = $LinuxPerf.parse_pstats_options(
+                    __params.linux_perf_options
+                )
                 __linux_perf_groups = $LinuxPerf.set_default_spaces(
-                    eval(__params.linux_perf_options.events),
-                    eval(__params.linux_perf_options.spaces),
+                    eval(__linux_perf_options.events), eval(__linux_perf_options.spaces)
                 )
                 __linux_perf_bench = nothing
                 try
                     __linux_perf_bench = $LinuxPerf.make_bench_threaded(
-                        __linux_perf_groups;
-                        threads=eval(__params.linux_perf_options.threads),
+                        __linux_perf_groups; threads=eval(__linux_perf_options.threads)
                     )
                 catch e
                     if e isa ErrorException &&

src/parameters.jl

@@ -15,11 +15,11 @@ 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}
+    enable_linux_perf::Bool
+    linux_perf_options::Vector{String}
 end
 
-const DEFAULT_LINUX_PERF_OPTIONS = LinuxPerf.parse_pstats_options([])
+const DEFAULT_LINUX_PERF_OPTIONS = String[]
 
 function perf_available()
     if !Sys.islinux()
@@ -28,7 +28,7 @@ function perf_available()
 
     bench = nothing
     try
-        opts = DEFAULT_LINUX_PERF_OPTIONS
+        opts = LinuxPerf.parse_pstats_options(DEFAULT_LINUX_PERF_OPTIONS)
         groups = LinuxPerf.set_default_spaces(eval(opts.events), eval(opts.spaces))
         bench = LinuxPerf.make_bench_threaded(groups; threads=eval(opts.threads))
         return true
@@ -65,7 +65,7 @@ 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,
+    enable_linux_perf=DEFAULT_PARAMETERS.enable_linux_perf,
     linux_perf_options=DEFAULT_PARAMETERS.linux_perf_options,
 )
     return Parameters(
@@ -78,7 +78,7 @@ function Parameters(;
         gcsample,
         time_tolerance,
         memory_tolerance,
-        experimental_enable_linux_perf,
+        enable_linux_perf,
         linux_perf_options,
     )
 end
@@ -93,7 +93,7 @@ function Parameters(
     gcsample=nothing,
     time_tolerance=nothing,
     memory_tolerance=nothing,
-    experimental_enable_linux_perf=nothing,
+    enable_linux_perf=nothing,
     linux_perf_options=nothing,
 )
     params = Parameters()
@@ -107,10 +107,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 = if experimental_enable_linux_perf != nothing
-        experimental_enable_linux_perf
+    params.enable_linux_perf = if enable_linux_perf != nothing
+        enable_linux_perf
     else
-        default.experimental_enable_linux_perf
+        default.enable_linux_perf
     end
     params.linux_perf_options =
         linux_perf_options != nothing ? linux_perf_options : default.linux_perf_options
@@ -126,7 +126,7 @@ function Base.:(==)(a::Parameters, b::Parameters)
            a.gcsample == b.gcsample &&
            a.time_tolerance == b.time_tolerance &&
            a.memory_tolerance == b.memory_tolerance &&
-           a.experimental_enable_linux_perf == b.experimental_enable_linux_perf &&
+           a.enable_linux_perf == b.enable_linux_perf &&
            a.linux_perf_options == b.linux_perf_options
 end
 
@@ -141,12 +141,8 @@ function Base.copy(p::Parameters)
         p.gcsample,
         p.time_tolerance,
         p.memory_tolerance,
-        p.experimental_enable_linux_perf,
-        (
-            events=copy(p.linux_perf_options.events),
-            spaces=copy(p.linux_perf_options.spaces),
-            threads=copy(p.linux_perf_options.threads),
-        ),
+        p.enable_linux_perf,
+        copy(p.linux_perf_options),
     )
 end
 

src/serialization.jl

@@ -60,19 +60,6 @@ function recover(x::Vector)
             end
         elseif ft <: get(SUPPORTED_TYPES, nameof(ft), Union{})
             xsi = recover(fields[fn])
-        elseif fn == "linux_perf_options"
-            field_val = fields[fn]
-            xsi = (
-                events=Expr(
-                    Symbol(field_val["events"]["head"]),
-                    LinuxPerf.parse_groups,
-                    field_val["events"]["args"][2],
-                ),
-                spaces=Expr(
-                    Symbol(field_val["spaces"]["head"]), field_val["spaces"]["args"]...
-                ),
-                threads=field_val["threads"],
-            )
         else
             xsi = convert(ft, fields[fn])
         end

test/SerializationTests.jl

@@ -6,12 +6,7 @@ using Test
 function eq(x::T, y::T) where {T<:Union{values(BenchmarkTools.SUPPORTED_TYPES)...}}
     return all(i -> eq(getfield(x, i), getfield(y, i)), 1:fieldcount(T))
 end
-function eq(
-    x::@NamedTuple{events::Expr, spaces::Expr, threads::Bool},
-    y::@NamedTuple{events::Expr, spaces::Expr, threads::Bool},
-)
-    return x == y
-end
+eq(x::Vector{String}, y::Vector{String}) = x == y
 function eq(x::LinuxPerf.Stats, y::LinuxPerf.Stats)
     return all(a -> eq(a[1], a[2]), zip(x.threads, y.threads))
 end