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
|
// Copyright 2020 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef PERFORMANCE_TEST_FIXTURE__PERFORMANCE_TEST_FIXTURE_HPP_
#define PERFORMANCE_TEST_FIXTURE__PERFORMANCE_TEST_FIXTURE_HPP_
#include <benchmark/benchmark.h>
#include <atomic>
#include "osrf_testing_tools_cpp/memory_tools/memory_tools.hpp"
#include "performance_test_fixture/visibility_control.hpp"
namespace performance_test_fixture
{
class PerformanceTest : public ::benchmark::Fixture
{
public:
PERFORMANCE_TEST_FIXTURE_PUBLIC
PerformanceTest();
PERFORMANCE_TEST_FIXTURE_PUBLIC
void SetUp(::benchmark::State & state);
PERFORMANCE_TEST_FIXTURE_PUBLIC
void TearDown(::benchmark::State & state);
protected:
PERFORMANCE_TEST_FIXTURE_PUBLIC
void on_alloc(osrf_testing_tools_cpp::memory_tools::MemoryToolsService & service);
PERFORMANCE_TEST_FIXTURE_PUBLIC
void reset_heap_counters();
PERFORMANCE_TEST_FIXTURE_PUBLIC
void set_are_allocation_measurements_active(bool value);
private:
std::atomic_size_t allocation_count;
bool suppress_memory_tools_logging;
bool are_allocation_measurements_active;
};
} // namespace performance_test_fixture
/**
* Macro to pause timing and heap allocation measurements over a section of code.
*
* This is useful if there is setup or teardown that has to occur with every iteration.
* For example, if you wanted to measure only construction of a rclcpp::Node and not its
* destruction.
*
* state.PauseTiming() does not allocate, so it should go first to minimize discrepencies in
* measuring timing
*/
#define PERFORMANCE_TEST_FIXTURE_PAUSE_MEASUREMENTS(state, code) \
do { \
state.PauseTiming(); \
set_are_allocation_measurements_active(false); \
code; \
set_are_allocation_measurements_active(true); \
state.ResumeTiming(); \
} while (0)
#endif // PERFORMANCE_TEST_FIXTURE__PERFORMANCE_TEST_FIXTURE_HPP_
|
