timemory 3.3.0
Modular C++ Toolkit for Performance Analysis and Logging. Profiling API and Tools for C, C++, CUDA, Fortran, and Python. The C++ template API is essentially a framework to creating tools: it is designed to provide a unifying interface for recording various performance measurements alongside data logging and interfaces to other tools.
types.hpp
Go to the documentation of this file.
1// MIT License
2//
3// Copyright (c) 2020, The Regents of the University of California,
4// through Lawrence Berkeley National Laboratory (subject to receipt of any
5// required approvals from the U.S. Dept. of Energy). All rights reserved.
6//
7// Permission is hereby granted, free of charge, to any person obtaining a copy
8// of this software and associated documentation files (the "Software"), to deal
9// in the Software without restriction, including without limitation the rights
10// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11// copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in all
15// copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23// SOFTWARE.
24
25/** \headerfile "timemory/general/types.hpp"
26 */
27
28#pragma once
29
30#include <cstddef>
31
32namespace tim
33{
34//
35//--------------------------------------------------------------------------------------//
36//
37class source_location;
38//
39template <size_t, size_t, typename... Args>
40static inline auto&
41get_static_source_location(Args&&... args);
42//
43//--------------------------------------------------------------------------------------//
44//
45} // namespace tim
46
47#if !defined(TIMEMORY_SOURCE_LOCATION)
48
49# define _AUTO_LOCATION_COMBINE(X, Y) X##Y
50# define _AUTO_LOCATION(Y) _AUTO_LOCATION_COMBINE(timemory_source_location_, Y)
51
52# define TIMEMORY_SOURCE_LOCATION(MODE, ...) \
53 ::tim::source_location(MODE, __FUNCTION__, __LINE__, __FILE__, __VA_ARGS__)
54
55# define TIMEMORY_CAPTURE_MODE(MODE_TYPE) ::tim::source_location::mode::MODE_TYPE
56
57# define TIMEMORY_CAPTURE_ARGS(...) _AUTO_LOCATION(__LINE__).get_captured(__VA_ARGS__)
58
59# define TIMEMORY_INLINE_SOURCE_LOCATION(MODE, ...) \
60 ::tim::get_static_source_location<__LINE__, __COUNTER__>( \
61 TIMEMORY_CAPTURE_MODE(MODE), __FUNCTION__, __LINE__, __FILE__, __VA_ARGS__) \
62 .get_captured(__VA_ARGS__)
63
64# define _TIM_STATIC_SRC_LOCATION(MODE, ...) \
65 static thread_local auto _AUTO_LOCATION(__LINE__) = \
66 TIMEMORY_SOURCE_LOCATION(TIMEMORY_CAPTURE_MODE(MODE), __VA_ARGS__)
67
68#endif
Definition: kokkosp.cpp:39