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
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 ( \
35 GNUNET_TIME_UNIT_MILLISECONDS, 1)
38 * How long do we wait until we consider a request failed by default?
40 #define DEF_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
44 * We distinguish between different categories of
45 * requests, for which we track statistics separately.
46 * However, this process does not change how it acts
47 * based on the category.
54 * Must be last and match number of categories.
61 * Request we should make. We keep this struct in memory per request,
62 * 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;
110 static struct GNUNET_GNS_Handle *gns;
113 * Number of lookups we performed overall per category.
115 static unsigned int lookups[RC_MAX];
118 * Number of replies we got per category.
120 static unsigned int replies[RC_MAX];
123 * Number of replies we got per category.
125 static unsigned int failures[RC_MAX];
128 * Sum of the observed latencies of successful queries,
131 static struct GNUNET_TIME_Relative latency_sum[RC_MAX];
134 * Active requests are kept in a DLL.
136 static struct Request *act_head;
139 * Active requests are kept in a DLL.
141 static struct Request *act_tail;
144 * Completed successful requests are kept in a DLL.
146 static struct Request *succ_head;
149 * Completed successful requests are kept in a DLL.
151 static struct Request *succ_tail;
154 * Yet to be started requests are kept in a DLL.
156 static struct Request *todo_head;
159 * Yet to be started requests are kept in a DLL.
161 static struct Request *todo_tail;
166 static struct GNUNET_SCHEDULER_Task *t;
169 * Delay between requests.
171 static struct GNUNET_TIME_Relative request_delay;
174 * Timeout for requests.
176 static struct GNUNET_TIME_Relative timeout;
179 * Number of requests we have concurrently active.
181 static unsigned int active_cnt;
184 * Look for GNS2DNS records specifically?
189 * Free @a req and data structures reachable from it.
191 * @param req request to free
194 free_request (struct Request *req)
197 GNUNET_GNS_lookup_with_tld_cancel (req->lr);
203 * Function called with the result of a GNS resolution.
205 * @param cls closure with the `struct Request`
206 * @param gns_tld #GNUNET_YES if GNS lookup was attempted
207 * @param rd_count number of records in @a rd
208 * @param rd the records in reply
211 process_result (void *cls,
214 const struct GNUNET_GNSRECORD_Data *rd)
216 struct Request *req = cls;
222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
223 "Got response for request `%s'\n",
226 req->latency = GNUNET_TIME_absolute_get_duration (req->op_start_time);
227 GNUNET_CONTAINER_DLL_remove (act_head,
230 GNUNET_CONTAINER_DLL_insert (succ_head,
234 latency_sum[req->cat]
235 = GNUNET_TIME_relative_add (latency_sum[req->cat],
241 * Process request from the queue.
246 process_queue (void *cls)
249 struct GNUNET_TIME_Relative duration;
253 /* check for expired requests */
254 while (NULL != (req = act_head))
256 duration = GNUNET_TIME_absolute_get_duration (req->op_start_time);
257 if (duration.rel_value_us < timeout.rel_value_us)
259 GNUNET_CONTAINER_DLL_remove (act_head,
262 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
263 "Failing request `%s' due to timeout\n",
265 failures[req->cat]++;
269 if (NULL == (req = todo_head))
271 struct GNUNET_TIME_Absolute at;
273 if (NULL == (req = act_head))
275 GNUNET_SCHEDULER_shutdown ();
278 at = GNUNET_TIME_absolute_add (req->op_start_time,
280 t = GNUNET_SCHEDULER_add_at (at,
285 GNUNET_CONTAINER_DLL_remove (todo_head,
288 GNUNET_CONTAINER_DLL_insert_tail (act_head,
293 req->op_start_time = GNUNET_TIME_absolute_get ();
294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
295 "Starting request `%s' (%u in parallel)\n",
298 req->lr = GNUNET_GNS_lookup_with_tld (gns,
301 ? GNUNET_GNSRECORD_TYPE_GNS2DNS
302 : GNUNET_GNSRECORD_TYPE_ANY,
303 GNUNET_GNS_LO_DEFAULT,
306 t = GNUNET_SCHEDULER_add_delayed (request_delay,
313 * Compare two requests by latency for qsort().
315 * @param c1 pointer to `struct Request *`
316 * @param c2 pointer to `struct Request *`
317 * @return -1 if c1<c2, 1 if c1>c2, 0 if c1==c2.
320 compare_req (const void *c1,
323 const struct Request *r1 = *(void **) c1;
324 const struct Request *r2 = *(void **) c2;
326 if (r1->latency.rel_value_us < r2->latency.rel_value_us)
328 if (r1->latency.rel_value_us > r2->latency.rel_value_us)
335 * Output statistics, then clean up and terminate the process.
340 do_shutdown (void *cls)
343 struct Request **ra[RC_MAX];
344 unsigned int rp[RC_MAX];
347 for (enum RequestCategory rc = 0; rc < RC_MAX; rc++)
349 ra[rc] = GNUNET_new_array (replies[rc],
353 for (req = succ_head; NULL != req; req = req->next)
355 GNUNET_assert (rp[req->cat] < replies[req->cat]);
356 ra[req->cat][rp[req->cat]++] = req;
358 for (enum RequestCategory rc = 0; rc < RC_MAX; rc++)
366 "\tlookups: %u replies: %u failures: %u\n",
374 sizeof(struct Request *),
376 latency_sum[rc] = GNUNET_TIME_relative_divide (latency_sum[rc],
380 GNUNET_STRINGS_relative_time_to_string (latency_sum[rc],
382 off = rp[rc] * 50 / 100;
384 "\tmedian(50): %s\n",
385 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
387 off = rp[rc] * 75 / 100;
389 "\tquantile(75): %s\n",
390 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
392 off = rp[rc] * 90 / 100;
394 "\tquantile(90): %s\n",
395 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
397 off = rp[rc] * 99 / 100;
399 "\tquantile(99): %s\n",
400 GNUNET_STRINGS_relative_time_to_string (ra[rc][off]->latency,
402 GNUNET_free (ra[rc]);
406 GNUNET_SCHEDULER_cancel (t);
409 while (NULL != (req = act_head))
411 GNUNET_CONTAINER_DLL_remove (act_head,
416 while (NULL != (req = succ_head))
418 GNUNET_CONTAINER_DLL_remove (succ_head,
423 while (NULL != (req = todo_head))
425 GNUNET_CONTAINER_DLL_remove (todo_head,
432 GNUNET_GNS_disconnect (gns);
439 * Add @a hostname to the list of requests to be made.
441 * @param hostname name to resolve
442 * @param cat category of the @a hostname
445 queue (const char *hostname,
446 enum RequestCategory cat)
452 dot = strchr (hostname,
453 (unsigned char) '.');
456 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
457 "Refusing invalid hostname `%s' (lacks '.')\n",
461 hlen = strlen (hostname) + 1;
462 req = GNUNET_malloc (sizeof(struct Request) + hlen);
464 req->hostname = (char *) &req[1];
465 GNUNET_memcpy (&req[1],
468 GNUNET_CONTAINER_DLL_insert (todo_head,
475 * Begin processing hostnames from stdin.
480 process_stdin (void *cls)
482 static struct GNUNET_TIME_Absolute last;
483 static uint64_t idot;
496 hn[strlen (in) - 1] = '\0'; /* eat newline */
497 if ((2 != sscanf (in,
504 "Malformed input line `%s', skipping\n",
509 last = GNUNET_TIME_absolute_get ();
511 if (0 == idot % 100000)
513 struct GNUNET_TIME_Relative delta;
515 delta = GNUNET_TIME_absolute_get_duration (last);
516 last = GNUNET_TIME_absolute_get ();
518 "Read 100000 domain names in %s\n",
519 GNUNET_STRINGS_relative_time_to_string (delta,
523 (enum RequestCategory) cat);
526 "Done reading %llu domain names\n",
527 (unsigned long long) idot);
528 t = GNUNET_SCHEDULER_add_now (&process_queue,
534 * Process requests from the queue, then if the queue is
535 * not empty, try again.
538 * @param args remaining command-line arguments
539 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
540 * @param cfg configuration
546 const struct GNUNET_CONFIGURATION_Handle *cfg)
551 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
553 gns = GNUNET_GNS_connect (cfg);
557 GNUNET_SCHEDULER_shutdown ();
560 t = GNUNET_SCHEDULER_add_now (&process_stdin,
566 * Call with list of names with numeric category to query.
570 * @return 0 on success
577 struct GNUNET_GETOPT_CommandLineOption options[] = {
578 GNUNET_GETOPT_option_relative_time ('d',
582 "how long to wait between queries"),
584 GNUNET_GETOPT_option_relative_time ('t',
588 "how long to wait for an answer"),
590 GNUNET_GETOPT_option_flag ('2',
593 "look for GNS2DNS records instead of ANY"),
595 GNUNET_GETOPT_OPTION_END
599 GNUNET_STRINGS_get_utf8_args (argc, argv,
602 timeout = DEF_TIMEOUT;
603 request_delay = DEF_REQUEST_DELAY;
605 GNUNET_PROGRAM_run (argc,
607 "gnunet-gns-benchmark",
608 "resolve GNS names and measure performance",
613 GNUNET_free ((void *) argv);
618 /* end of gnunet-gns-benchmark.c */