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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// This file was manually created and exposes the functions of this library.
// TODO: Can we automatically generate this file?

#ifndef CORE_H
#define CORE_H

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef _WIN32
#include "callgrind.h"
#include "valgrind.h"
#else
#define CALLGRIND_START_INSTRUMENTATION
#define CALLGRIND_STOP_INSTRUMENTATION
#define CALLGRIND_ZERO_STATS
#endif

typedef uint64_t* InstrumentHooks;

InstrumentHooks* instrument_hooks_init(void);
void instrument_hooks_deinit(InstrumentHooks*);

bool instrument_hooks_is_instrumented(InstrumentHooks*);
uint8_t instrument_hooks_start_benchmark(InstrumentHooks*);
uint8_t instrument_hooks_stop_benchmark(InstrumentHooks*);
uint8_t instrument_hooks_set_executed_benchmark(InstrumentHooks*, int32_t pid,
                                                const char* uri);
// Deprecated: use instrument_hooks_set_executed_benchmark instead
uint8_t instrument_hooks_executed_benchmark(InstrumentHooks*, int32_t pid,
                                            const char* uri);
uint8_t instrument_hooks_set_integration(InstrumentHooks*, const char* name,
                                         const char* version);

#define MARKER_TYPE_SAMPLE_START 0
#define MARKER_TYPE_SAMPLE_END 1
#define MARKER_TYPE_BENCHMARK_START 2
#define MARKER_TYPE_BENCHMARK_END 3

uint8_t instrument_hooks_add_marker(InstrumentHooks*, uint32_t pid,
                                    uint8_t marker_type, uint64_t timestamp);
uint64_t instrument_hooks_current_timestamp(void);

void callgrind_start_instrumentation();
void callgrind_stop_instrumentation();

// Feature flags for instrument hooks

typedef enum {
  FEATURE_DISABLE_CALLGRIND_MARKERS = 0,
} instrument_hooks_feature_t;

void instrument_hooks_set_feature(instrument_hooks_feature_t feature,
                                  bool enabled);

// Environment collection
// Call set_environment to register key-value pairs grouped by section.
// Call collect_linked_libraries to gather linked library metadata.
// Then call write_environment to flush everything to
// $CODSPEED_PROFILE_FOLDER/environment-<pid>.json.
uint8_t instrument_hooks_set_environment(InstrumentHooks*,
                                         const char* section_name,
                                         const char* key, const char* value);
uint8_t instrument_hooks_set_environment_list(InstrumentHooks*,
                                              const char* section_name,
                                              const char* key,
                                              const char* const* values,
                                              uint32_t count);
uint8_t instrument_hooks_write_environment(InstrumentHooks*, uint32_t pid);

// Header functions that will be inlined. This can be used by languages that
// directly consume the headers such as C or C++. This will allow for more
// precise tracking of the benchmark performance.

static inline uint8_t instrument_hooks_start_benchmark_inline(
    InstrumentHooks* instance) {
  instrument_hooks_set_feature(FEATURE_DISABLE_CALLGRIND_MARKERS, true);
  if (instrument_hooks_start_benchmark(instance) != 0) {
    return 1;
  }

  CALLGRIND_ZERO_STATS;
  CALLGRIND_START_INSTRUMENTATION;
  return 0;
}

static inline uint8_t instrument_hooks_stop_benchmark_inline(
    InstrumentHooks* instance) {
  CALLGRIND_STOP_INSTRUMENTATION;
  return instrument_hooks_stop_benchmark(instance);
}

#ifdef __cplusplus
}
#endif

#endif