aboutsummaryrefslogtreecommitdiff
path: root/src/util/benchmark.h
blob: 6e00906c461c2e27984dbd967f1b17bf87e72d6b (plain) (blame)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
     This file is part of GNUnet.
     Copyright (C) 2018 GNUnet e.V.

     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
    
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file util/benchmark.h
 * @brief benchmarking for various operations
 * @author Florian Dold <flo@dold.me>
 */

#ifndef BENCHMARK_H_
#define BENCHMARK_H_

#include "gnunet_time_lib.h"

/**
 * Maximum length of URLs considered for benchmarking.
 * Shorter URLs are simply truncated.
 */
#define MAX_BENCHMARK_URL_LEN 128


/**
 * Struct for benchmark data for one URL.
 */
struct UrlRequestData
{
  /**
   * Request URL, truncated (but 0-terminated).
   */
  char request_url[MAX_BENCHMARK_URL_LEN];

  /**
   * HTTP status code.
   */
  unsigned int status;
  
  /**
   * How often was the URL requested?
   */
  uint64_t count;

  /**
   * Total time spent requesting this URL.
   */
  struct GNUNET_TIME_Relative time;

  /**
   * Slowest time to response.
   */
  struct GNUNET_TIME_Relative time_max;

  /**
   * Fastest time to response.
   */
  struct GNUNET_TIME_Relative time_min;
};

/**
 * Thread-local struct for benchmarking data.
 */
struct BenchmarkData
{
  /**
   * Number of eddsa_sign operations.
   */
  uint64_t eddsa_sign_count;

  /**
   * Time spent in eddsa_sign.
   */
  struct GNUNET_TIME_Relative eddsa_sign_time;

  struct UrlRequestData *urd;

  unsigned int urd_len;

  unsigned int urd_capacity;
};


/**
 * Acquire the benchmark data for the current thread, allocate if necessary.
 * Installs handler to collect the benchmark data on thread termination.
 *
 * @return benchmark data for the current thread
 */
struct BenchmarkData *
get_benchmark_data (void);

/**
 * Get benchmark data for a URL.  If the URL is too long, it's truncated
 * before looking up the correspoding benchmark data.
 *
 * Statistics are bucketed by URL and status code.
 *
 * @param url url to get request data for
 * @param status http status code
 */
struct UrlRequestData *
get_url_benchmark_data (char *url, unsigned int status);

#endif  /* BENCHMARK_H_ */