2 This file is part of GNUnet.
3 Copyright (C) 2018 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file util/benchmark.h
23 * @brief benchmarking for various operations
24 * @author Florian Dold <flo@dold.me>
30 #include "gnunet_time_lib.h"
33 * Maximum length of URLs considered for benchmarking.
34 * Shorter URLs are simply truncated.
36 #define MAX_BENCHMARK_URL_LEN 128
39 #define BENCHMARK_START(opname) \
40 struct GNUNET_TIME_Absolute _benchmark_##opname##_start = GNUNET_TIME_absolute_get ()
41 #define BENCHMARK_END(opname) do { \
43 struct GNUNET_TIME_Absolute _benchmark_##opname##_end = GNUNET_TIME_absolute_get (); \
44 struct BenchmarkData *bd = get_benchmark_data (); \
45 bd->opname##_count++; \
47 GNUNET_TIME_relative_add (bd->opname##_time, \
48 GNUNET_TIME_absolute_get_difference (_benchmark_##opname##_start, \
49 _benchmark_##opname##_end)); \
53 #define BENCHMARK_START(opname) do { } while (0)
54 #define BENCHMARK_END(opname) do { } while (0)
59 * Struct for benchmark data for one URL.
64 * Request URL, truncated (but 0-terminated).
66 char request_url[MAX_BENCHMARK_URL_LEN];
74 * How often was the URL requested?
79 * How many bytes were sent in total to request the URL.
84 * How many bytes were received in total as response to requesting this URL.
86 uint64_t bytes_received;
89 * Total time spent requesting this URL.
91 struct GNUNET_TIME_Relative time;
94 * Slowest time to response.
96 struct GNUNET_TIME_Relative time_max;
99 * Fastest time to response.
101 struct GNUNET_TIME_Relative time_min;
104 #define GNUNET_DECLARE_BENCHMARK_OP(opname) \
105 uint64_t opname##_count; \
106 struct GNUNET_TIME_Relative opname##_time
109 * Thread-local struct for benchmarking data.
113 GNUNET_DECLARE_BENCHMARK_OP (ecc_ecdh);
114 GNUNET_DECLARE_BENCHMARK_OP (ecdh_eddsa);
115 GNUNET_DECLARE_BENCHMARK_OP (ecdhe_key_create);
116 GNUNET_DECLARE_BENCHMARK_OP (ecdhe_key_get_public);
117 GNUNET_DECLARE_BENCHMARK_OP (ecdsa_ecdh);
118 GNUNET_DECLARE_BENCHMARK_OP (ecdsa_key_create);
119 GNUNET_DECLARE_BENCHMARK_OP (ecdsa_key_get_public);
120 GNUNET_DECLARE_BENCHMARK_OP (ecdsa_sign);
121 GNUNET_DECLARE_BENCHMARK_OP (ecdsa_verify);
122 GNUNET_DECLARE_BENCHMARK_OP (eddsa_ecdh);
123 GNUNET_DECLARE_BENCHMARK_OP (eddsa_key_create);
124 GNUNET_DECLARE_BENCHMARK_OP (eddsa_key_get_public);
125 GNUNET_DECLARE_BENCHMARK_OP (eddsa_sign);
126 GNUNET_DECLARE_BENCHMARK_OP (eddsa_verify);
127 GNUNET_DECLARE_BENCHMARK_OP (hash);
128 GNUNET_DECLARE_BENCHMARK_OP (hash_context_finish);
129 GNUNET_DECLARE_BENCHMARK_OP (hash_context_read);
130 GNUNET_DECLARE_BENCHMARK_OP (hash_context_start);
131 GNUNET_DECLARE_BENCHMARK_OP (hkdf);
132 GNUNET_DECLARE_BENCHMARK_OP (rsa_blind);
133 GNUNET_DECLARE_BENCHMARK_OP (rsa_private_key_create);
134 GNUNET_DECLARE_BENCHMARK_OP (rsa_private_key_get_public);
135 GNUNET_DECLARE_BENCHMARK_OP (rsa_sign_blinded);
136 GNUNET_DECLARE_BENCHMARK_OP (rsa_unblind);
137 GNUNET_DECLARE_BENCHMARK_OP (rsa_verify);
139 struct UrlRequestData *urd;
141 unsigned int urd_len;
143 unsigned int urd_capacity;
146 #undef GNUNET_DECLARE_BENCHMARK_OP
150 * Acquire the benchmark data for the current thread, allocate if necessary.
151 * Installs handler to collect the benchmark data on thread termination.
153 * @return benchmark data for the current thread
155 struct BenchmarkData *
156 get_benchmark_data (void);
159 * Get benchmark data for a URL. If the URL is too long, it's truncated
160 * before looking up the correspoding benchmark data.
162 * Statistics are bucketed by URL and status code.
164 * @param url url to get request data for
165 * @param status http status code
167 struct UrlRequestData *
168 get_url_benchmark_data (char *url, unsigned int status);
170 #endif /* BENCHMARK_H_ */