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
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file src/gns/gnunet-gns-benchmark.c
22 * @brief issue many queries to GNS and compute performance statistics
23 * @author Christian Grothoff
26 #include <gnunet_util_lib.h>
27 #include <gnunet_gnsrecord_lib.h>
28 #include <gnunet_gns_service.h>
32 * How long do we wait at least between requests by default?
34 #define DEF_REQUEST_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 1)
37 * How long do we wait until we consider a request failed by default?
39 #define DEF_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
43 * We distinguish between different categories of
44 * requests, for which we track statistics separately.
45 * However, this process does not change how it acts
46 * based on the category.
53 * Must be last and match number of categories.
60 * Request we should make. We keep this struct in memory per request,
61 * thus optimizing it is crucial for the overall memory consumption of
68 * Active requests are kept in a DLL.
73 * Active requests are kept in a DLL.
78 * Socket used to make the request, NULL if not active.
80 struct GNUNET_GNS_LookupWithTldRequest *lr;
83 * Hostname we are resolving, allocated at the end of
84 * this struct (optimizing memory consumption by reducing
85 * total number of allocations).
90 * While we are fetching the record, the value is set to the
91 * starting time of the GNS operation.
93 struct GNUNET_TIME_Absolute op_start_time;
96 * Observed latency, set once we got a reply.
98 struct GNUNET_TIME_Relative latency;
101 * Category of the request.
103 enum RequestCategory cat;
111 static struct GNUNET_GNS_Handle *gns;
114 * Number of lookups we performed overall per category.
116 static unsigned int lookups[RC_MAX];
119 * Number of replies we got per category.
121 static unsigned int replies[RC_MAX];
124 * Number of replies we got per category.
126 static unsigned int failures[RC_MAX];
129 * Sum of the observed latencies of successful queries,
132 static struct GNUNET_TIME_Relative latency_sum[RC_MAX];
135 * Active requests are kept in a DLL.
137 static struct Request *act_head;
140 * Active requests are kept in a DLL.
142 static struct Request *act_tail;
145 * Completed successful requests are kept in a DLL.
147 static struct Request *succ_head;
150 * Completed successful requests are kept in a DLL.
152 static struct Request *succ_tail;
155 * Yet to be started requests are kept in a DLL.
157 static struct Request *todo_head;
160 * Yet to be started requests are kept in a DLL.
162 static struct Request *todo_tail;
167 static struct GNUNET_SCHEDULER_Task *t;
170 * Delay between requests.
172 static struct GNUNET_TIME_Relative request_delay;
175 * Timeout for requests.
177 static struct GNUNET_TIME_Relative timeout;
180 * Number of requests we have concurrently active.
182 static unsigned int active_cnt;
186 * Free @a req and data structures reachable from it.
188 * @param req request to free
191 free_request (struct Request *req)
194 GNUNET_GNS_lookup_with_tld_cancel (req->lr);
200 * Function called with the result of a GNS resolution.
202 * @param cls closure with the `struct Request`
203 * @param gns_tld #GNUNET_YES if GNS lookup was attempted
204 * @param rd_count number of records in @a rd
205 * @param rd the records in reply
208 process_result (void *cls,
211 const struct GNUNET_GNSRECORD_Data *rd)
213 struct Request *req = cls;
219 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
220 "Got response for request `%s'\n",
223 req->latency = GNUNET_TIME_absolute_get_duration (req->op_start_time);
224 GNUNET_CONTAINER_DLL_remove (act_head,
227 GNUNET_CONTAINER_DLL_insert (succ_head,
231 latency_sum[req->cat]
232 = GNUNET_TIME_relative_add (latency_sum[req->cat],
238 * Process request from the queue.
243 process_queue (void *cls)
246 struct GNUNET_TIME_Relative duration;
250 /* check for expired requests */
251 while (NULL != (req = act_head))
253 duration = GNUNET_TIME_absolute_get_duration (req->op_start_time);
254 if (duration.rel_value_us < timeout.rel_value_us)
256 GNUNET_CONTAINER_DLL_remove (act_head,
259 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
260 "Failing request `%s' due to timeout\n",
262 failures[req->cat]++;
266 if (NULL == (req = todo_head))
268 struct GNUNET_TIME_Absolute at;
270 if (NULL == (req = act_head))
272 GNUNET_SCHEDULER_shutdown ();
275 at = GNUNET_TIME_absolute_add (req->op_start_time,
277 t = GNUNET_SCHEDULER_add_at (at,
282 GNUNET_CONTAINER_DLL_remove (todo_head,
285 GNUNET_CONTAINER_DLL_insert_tail (act_head,
290 req->op_start_time = GNUNET_TIME_absolute_get ();
291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
292 "Starting request `%s' (%u in parallel)\n",
295 req->lr = GNUNET_GNS_lookup_with_tld (gns,
297 GNUNET_GNSRECORD_TYPE_ANY,
298 GNUNET_GNS_LO_DEFAULT,
301 t = GNUNET_SCHEDULER_add_delayed (request_delay,
308 * Compare two requests by latency for qsort().
310 * @param c1 pointer to `struct Request *`
311 * @param c2 pointer to `struct Request *`
312 * @return -1 if c1<c2, 1 if c1>c2, 0 if c1==c2.
315 compare_req (const void *c1,
318 const struct Request *r1 = *(void **) c1;
319 const struct Request *r2 = *(void **) c2;
321 if (r1->latency.rel_value_us < r2->latency.rel_value_us)
323 if (r1->latency.rel_value_us > r2->latency.rel_value_us)
330 * Output statistics, then clean up and terminate the process.
335 do_shutdown (void *cls)
338 struct Request **ra[RC_MAX];
339 unsigned int rp[RC_MAX];
342 for (enum RequestCategory rc = 0;rc < RC_MAX;rc++)
344 ra[rc] = GNUNET_new_array (replies[rc],
348 for (req = succ_head;NULL != req; req = req->next)
350 GNUNET_assert (rp[req->cat] < replies[req->cat]);
351 ra[req->cat][rp[req->cat]++] = req;
353 for (enum RequestCategory rc = 0;rc < RC_MAX;rc++)
361 "\tlookups: %u replies: %u failures: %u\n",
369 sizeof (struct Request *),
371 latency_sum[rc] = GNUNET_TIME_relative_divide (latency_sum[rc],
375 GNUNET_STRINGS_relative_time_to_string (latency_sum[rc],
377 off = rp[rc] * 50 / 100;
379 "\tmedian(50): %s\n",
380 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
382 off = rp[rc] * 75 / 100;
384 "\tquantile(75): %s\n",
385 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
387 off = rp[rc] * 90 / 100;
389 "\tquantile(90): %s\n",
390 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
392 off = rp[rc] * 99 / 100;
394 "\tquantile(99): %s\n",
395 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
397 GNUNET_free (ra[rc]);
401 GNUNET_SCHEDULER_cancel (t);
404 while (NULL != (req = act_head))
406 GNUNET_CONTAINER_DLL_remove (act_head,
411 while (NULL != (req = succ_head))
413 GNUNET_CONTAINER_DLL_remove (succ_head,
418 while (NULL != (req = todo_head))
420 GNUNET_CONTAINER_DLL_remove (todo_head,
427 GNUNET_GNS_disconnect (gns);
434 * Add @a hostname to the list of requests to be made.
436 * @param hostname name to resolve
437 * @param cat category of the @a hostname
440 queue (const char *hostname,
441 enum RequestCategory cat)
447 dot = strchr (hostname,
448 (unsigned char) '.');
451 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
452 "Refusing invalid hostname `%s' (lacks '.')\n",
456 hlen = strlen (hostname) + 1;
457 req = GNUNET_malloc (sizeof (struct Request) + hlen);
459 req->hostname = (char *) &req[1];
460 GNUNET_memcpy (&req[1],
463 GNUNET_CONTAINER_DLL_insert (todo_head,
470 * Begin processing hostnames from stdin.
475 process_stdin (void *cls)
477 static struct GNUNET_TIME_Absolute last;
478 static uint64_t idot;
491 hn[strlen(in)-1] = '\0'; /* eat newline */
492 if ( (2 != sscanf (in,
499 "Malformed input line `%s', skipping\n",
504 last = GNUNET_TIME_absolute_get ();
506 if (0 == idot % 100000)
508 struct GNUNET_TIME_Relative delta;
510 delta = GNUNET_TIME_absolute_get_duration (last);
511 last = GNUNET_TIME_absolute_get ();
513 "Read 100000 domain names in %s\n",
514 GNUNET_STRINGS_relative_time_to_string (delta,
518 (enum RequestCategory) cat);
521 "Done reading %llu domain names\n",
522 (unsigned long long) idot);
523 t = GNUNET_SCHEDULER_add_now (&process_queue,
529 * Process requests from the queue, then if the queue is
530 * not empty, try again.
533 * @param args remaining command-line arguments
534 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
535 * @param cfg configuration
541 const struct GNUNET_CONFIGURATION_Handle *cfg)
546 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
548 gns = GNUNET_GNS_connect (cfg);
552 GNUNET_SCHEDULER_shutdown ();
555 t = GNUNET_SCHEDULER_add_now (&process_stdin,
561 * Call with list of names with numeric category to query.
565 * @return 0 on success
572 struct GNUNET_GETOPT_CommandLineOption options[] = {
573 GNUNET_GETOPT_option_relative_time ('d',
576 gettext_noop ("how long to wait between queries"),
578 GNUNET_GETOPT_option_relative_time ('t',
581 gettext_noop ("how long to wait for an answer"),
583 GNUNET_GETOPT_OPTION_END
587 GNUNET_STRINGS_get_utf8_args (argc, argv,
590 timeout = DEF_TIMEOUT;
591 request_delay = DEF_REQUEST_DELAY;
593 GNUNET_PROGRAM_run (argc,
595 "gnunet-gns-benchmark",
596 "resolve GNS names and measure performance",
601 GNUNET_free ((void*) argv);
605 /* end of gnunet-gns-benchmark.c */