bench: add --help option to bench_internal #1445

pull theStack wants to merge 1 commits into bitcoin-core:master from theStack:add-bench_internal-help changing 1 files +31 −1

theStack commented at 5:08 PM on November 23, 2023: contributor

While coming up with commands for running the benchmarks for issue #726 (comment), I noticed that in contrast to bench{_ecmult}, bench_internal doesn't have a help option yet and figured it would be nice to have one. A comparable past PR is #1008. Benchmark categories appear in the same order as they are executed, the concrete benchmark names in parantheses per category are listed in alphabetical order.

in src/bench_internal.c:27 in e2cfea0c5d outdated

  22 | +    printf("    - Scalar operations (modulo the curve's order)\n");
  23 | +    printf("    - Field operations (modulo the curve's field size)\n");
  24 | +    printf("    - Group operations (both in Jacobian and affine coordinates)\n");
  25 | +    printf("    - Point multiplication\n");
  26 | +    printf("    - Hash algorithms\n");
  27 | +    printf("    - Context object handling\n");

real-or-random commented at 10:02 PM on November 23, 2023:

Perhaps it suffices to say "Benchmarks various internal routines". This list is mostly redundant to the list below. If we omit it, we won't need to (remember to) touch two lists every time we add or remove operations.

theStack commented at 1:35 AM on November 24, 2023:

Agree, done.

real-or-random commented at 10:02 PM on November 23, 2023: contributor

Concept ACK
real-or-random added the label refactor/smell on Nov 23, 2023
bench: add --help option to bench_internal 1ddd76af0a
theStack force-pushed on Nov 24, 2023
real-or-random approved
real-or-random commented at 7:53 AM on November 24, 2023: contributor

utACK 1ddd76af0a735b7fcbec7f37c0d99a7db9893ac1
siv2r commented at 1:11 PM on November 24, 2023: contributor

ACK 1ddd76a, tested the --help option locally, and it works as expected.
real-or-random merged this on Nov 24, 2023
real-or-random closed this on Nov 24, 2023
theStack deleted the branch on Nov 24, 2023

Contributors

Labels

Linked (view graph)

#726 Consider removing x86_64 field assembly #1008 bench.c: add `--help` option and ci: move env variables