codspeed 4.5.0

Core instrumentation library for CodSpeed
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

#include <stdio.h>
#ifdef _WIN32
#include <process.h>
#define getpid _getpid
#else
#include <unistd.h>
#endif

#include "core.h"

static int fib(int n) {
  if (n <= 1) return n;
  return fib(n - 1) + fib(n - 2);
}

static void expensive_setup(void) { fib(30); }

void example_function() {
  // Simulate some work
  for (volatile int i = 0; i < 100000; i++)
    ;
  printf("Benchmark executed\n");
}

int main() {
  instrument_hooks_set_feature(FEATURE_DISABLE_CALLGRIND_MARKERS, true);

  InstrumentHooks *hooks = instrument_hooks_init();
  if (!hooks) {
    printf("Failed to initialize instrument hooks\n");
    return 1;
  }

  if (instrument_hooks_is_instrumented(hooks)) {
    printf("Running under instrumentation\n");
  } else {
    printf("Not running under instrumentation\n");
  }

  instrument_hooks_set_integration(hooks, "example", "1.0.0");

  printf("Starting benchmark...\n");
  if (instrument_hooks_start_benchmark_inline(hooks) != 0) {
    printf("Failed to start benchmark\n");
    instrument_hooks_deinit(hooks);
    return 1;
  }

  uint32_t pid = getpid();
  for (int i = 0; i < 10; i++) {
    // This won't be displayed in the flamegraph, because it's outside
    // the benchmark marker regions.
    expensive_setup();

    uint64_t start_time = instrument_hooks_current_timestamp();
    example_function();
    uint64_t end_time = instrument_hooks_current_timestamp();

    // Add the markers which mark when the benchmarked function was running
    instrument_hooks_add_marker(hooks, pid, MARKER_TYPE_BENCHMARK_START,
                                start_time);
    instrument_hooks_add_marker(hooks, pid, MARKER_TYPE_BENCHMARK_END,
                                end_time);
  }

  if (instrument_hooks_stop_benchmark_inline(hooks) != 0) {
    printf("Failed to stop benchmark\n");
    instrument_hooks_deinit(hooks);
    return 1;
  }

  if (instrument_hooks_set_executed_benchmark(hooks, pid,
                                              "example_benchmark") != 0) {
    printf("Failed to report benchmark execution\n");
    instrument_hooks_deinit(hooks);
    return 1;
  }

  printf("Benchmark completed successfully\n");

  instrument_hooks_deinit(hooks);

  return 0;
}