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.
macros.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/** \file timemory/utility/bits/macros.hpp
26 * \headerfile timemory/utility/bits/macros.hpp "timemory/utility/bits/macros.hpp"
27 * Deprecated macros
28 */
29
30//======================================================================================//
31//
32// ALL OF THESE MACROS ARE DEPRECATED!
33//
34//======================================================================================//
35
36#pragma once
37
38//======================================================================================//
39//
40// OBJECT MACROS
41//
42//======================================================================================//
43
44/// \deprecated
45#define TIMEMORY_BLANK_OBJECT(type, ...) TIMEMORY_BLANK_MARKER(type, __VA_ARGS__)
46
47//--------------------------------------------------------------------------------------//
48
49/// \deprecated
50#define TIMEMORY_BASIC_OBJECT(type, ...) TIMEMORY_BASIC_MARKER(type, __VA_ARGS__)
51
52//--------------------------------------------------------------------------------------//
53
54/// \deprecated
55#define TIMEMORY_OBJECT(type, ...) TIMEMORY_MARKER(type, __VA_ARGS__)
56
57//======================================================================================//
58//
59// INSTANCE MACROS
60//
61//======================================================================================//
62
63/// \deprecated
64#define TIMEMORY_BLANK_INSTANCE(type, ...) TIMEMORY_BLANK_HANDLE(type, __VA_ARGS__)
65
66//--------------------------------------------------------------------------------------//
67
68/// \deprecated
69#define TIMEMORY_BASIC_INSTANCE(type, ...) TIMEMORY_BASIC_HANDLE(type, __VA_ARGS__)
70
71//--------------------------------------------------------------------------------------//
72
73/// \deprecated
74#define TIMEMORY_INSTANCE(type, ...) TIMEMORY_HANDLE(type, __VA_ARGS__)
75
76//======================================================================================//
77//
78// AUTO_TUPLE MACROS
79//
80//======================================================================================//
81
82// DEPRECATED use macros in timemory/variadic/macros.hpp!
83/// \deprecated
84#define TIMEMORY_BLANK_AUTO_TUPLE(auto_tuple_type, ...) \
85 TIMEMORY_BLANK_MARKER(auto_tuple_type, __VA_ARGS__)
86
87/// \deprecated
88#define TIMEMORY_BASIC_AUTO_TUPLE(auto_tuple_type, ...) \
89 TIMEMORY_BASIC_MARKER(auto_tuple_type, __VA_ARGS__)
90
91/// \deprecated
92#define TIMEMORY_AUTO_TUPLE(auto_tuple_type, ...) \
93 TIMEMORY_MARKER(auto_tuple_type, __VA_ARGS__)
94
95//--------------------------------------------------------------------------------------//
96// caliper versions -- DEPRECATED use macros in timemory/variadic/macros.hpp!
97
98/// \deprecated
99#define TIMEMORY_BLANK_AUTO_TUPLE_CALIPER(id, auto_tuple_type, ...) \
100 TIMEMORY_BLANK_CALIPER(id, auto_tuple_type, __VA_ARGS__)
101
102/// \deprecated
103#define TIMEMORY_BASIC_AUTO_TUPLE_CALIPER(id, auto_tuple_type, ...) \
104 TIMEMORY_BASIC_CALIPER(id, auto_tuple_type, __VA_ARGS__)
105
106/// \deprecated
107#define TIMEMORY_AUTO_TUPLE_CALIPER(id, auto_tuple_type, ...) \
108 TIMEMORY_CALIPER(id, auto_tuple_type, __VA_ARGS__)
109
110//--------------------------------------------------------------------------------------//
111// instance versions -- DEPRECATED use macros in timemory/variadic/macros.hpp!
112
113/// \deprecated
114#define TIMEMORY_BLANK_AUTO_TUPLE_INSTANCE(auto_tuple_type, ...) \
115 TIMEMORY_BLANK_HANDLE(auto_tuple_type, __VA_ARGS__)
116
117/// \deprecated
118#define TIMEMORY_BASIC_AUTO_TUPLE_INSTANCE(auto_tuple_type, ...) \
119 TIMEMORY_BASIC_HANDLE(auto_tuple_type, __VA_ARGS__)
120
121/// \deprecated
122#define TIMEMORY_AUTO_TUPLE_INSTANCE(auto_tuple_type, ...) \
123 TIMEMORY_HANDLE(auto_tuple_type, __VA_ARGS__)
124
125//--------------------------------------------------------------------------------------//
126// debug versions -- DEPRECATED use macros in timemory/variadic/macros.hpp!
127
128/// \deprecated
129#define TIMEMORY_DEBUG_BASIC_AUTO_TUPLE(auto_tuple_type, ...) \
130 TIMEMORY_DEBUG_BASIC_MARKER(auto_tuple_type, __VA_ARGS__)
131
132/// \deprecated
133#define TIMEMORY_DEBUG_AUTO_TUPLE(auto_tuple_type, ...) \
134 TIMEMORY_DEBUG_MARKER(auto_tuple_type, __VA_ARGS__)
135
136//======================================================================================//
137//
138// AUTO_LIST MACROS
139//
140//======================================================================================//
141
142/// \deprecated
143#define TIMEMORY_BLANK_AUTO_LIST(auto_list_type, ...) \
144 TIMEMORY_BLANK_MARKER(auto_list_type, __VA_ARGS__)
145
146/// \deprecated
147#define TIMEMORY_BASIC_AUTO_LIST(auto_list_type, ...) \
148 TIMEMORY_BASIC_MARKER(auto_list_type, __VA_ARGS__)
149
150/// \deprecated
151#define TIMEMORY_AUTO_LIST(auto_list_type, ...) \
152 TIMEMORY_MARKER(auto_list_type, __VA_ARGS__)
153
154//--------------------------------------------------------------------------------------//
155// caliper versions
156
157/// \deprecated
158#define TIMEMORY_BLANK_AUTO_LIST_CALIPER(id, auto_list_type, ...) \
159 TIMEMORY_BLANK_CALIPER(id, auto_list_type, __VA_ARGS__)
160
161/// \deprecated
162#define TIMEMORY_BASIC_AUTO_LIST_CALIPER(id, auto_list_type, ...) \
163 TIMEMORY_BASIC_CALIPER(id, auto_list_type, __VA_ARGS__)
164
165/// \deprecated
166#define TIMEMORY_AUTO_LIST_CALIPER(id, auto_list_type, ...) \
167 TIMEMORY_CALIPER(id, auto_list_type, __VA_ARGS__)
168
169//--------------------------------------------------------------------------------------//
170// instance versions
171
172/// \deprecated
173#define TIMEMORY_BLANK_AUTO_LIST_INSTANCE(auto_list_type, ...) \
174 TIMEMORY_BLANK_HANDLE(auto_list_type, __VA_ARGS__)
175
176/// \deprecated
177#define TIMEMORY_BASIC_AUTO_LIST_INSTANCE(auto_list_type, ...) \
178 TIMEMORY_BASIC_HANDLE(auto_list_type, __VA_ARGS__)
179
180/// \deprecated
181#define TIMEMORY_AUTO_LIST_INSTANCE(auto_list_type, ...) \
182 TIMEMORY_HANDLE(auto_list_type, __VA_ARGS__)
183
184//--------------------------------------------------------------------------------------//
185// debug versions
186
187/// \deprecated
188#define TIMEMORY_DEBUG_BASIC_AUTO_LIST(auto_list_type, ...) \
189 TIMEMORY_DEBUG_BASIC_MARKER(auto_list_type, __VA_ARGS__)
190
191/// \deprecated
192#define TIMEMORY_DEBUG_AUTO_LIST(auto_list_type, ...) \
193 TIMEMORY_DEBUG_MARKER(auto_list_type, __VA_ARGS__)
194
195//--------------------------------------------------------------------------------------//
196
197/// \deprecated
198#define TIMEMORY_CALIPER_MARK_STREAM_BEGIN(id, stream) \
199 TIMEMORY_CALIPER_APPLY(id, mark_begin, stream)
200
201//--------------------------------------------------------------------------------------//
202
203/// \deprecated
204#define TIMEMORY_CALIPER_MARK_STREAM_END(id, stream) \
205 TIMEMORY_CALIPER_APPLY(id, mark_end, stream)