2 This file is part of GNUnet.
3 (C) 2009, 2010, 2012 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file statistics/gnunet-service-statistics.c
23 * @brief program that tracks statistics
24 * @author Christian Grothoff
27 #include "gnunet_bio_lib.h"
28 #include "gnunet_container_lib.h"
29 #include "gnunet_disk_lib.h"
30 #include "gnunet_getopt_lib.h"
31 #include "gnunet_protocols.h"
32 #include "gnunet_service_lib.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_strings_lib.h"
35 #include "gnunet_time_lib.h"
36 #include "statistics.h"
45 * Watch entries are kept in a linked list.
47 struct WatchEntry *next;
50 * Watch entries are kept in a linked list.
52 struct WatchEntry *prev;
55 * For which client is this watch entry?
57 struct GNUNET_SERVER_Client *client;
60 * Last value we communicated to the client for this watch entry.
65 * Unique watch number for this client and this watched value.
78 * Clients are kept in a linked list.
80 struct ClientEntry *next;
83 * Clients are kept in a linked list.
85 struct ClientEntry *prev;
88 * Corresponding server handle.
90 struct GNUNET_SERVER_Client *client;
93 * Maximum watch ID used by this client so far.
100 * Entry in the statistics list.
105 * This is a linked list.
107 struct StatsEntry *next;
110 * Name of the service, points into the
116 * Name for the value, points into
122 * Message that can be used to set this value,
123 * stored at the end of the memory used by
126 struct GNUNET_STATISTICS_SetMessage *msg;
129 * Watch context for changes to this
130 * value, or NULL for none.
132 struct WatchEntry *we_head;
135 * Watch context for changes to this
136 * value, or NULL for none.
138 struct WatchEntry *we_tail;
151 * Is this value persistent?
160 static const struct GNUNET_CONFIGURATION_Handle *cfg;
163 * Linked list of our active statistics.
165 static struct StatsEntry *start;
168 * Head of linked list of connected clients.
170 static struct ClientEntry *client_head;
173 * Tail of linked list of connected clients.
175 static struct ClientEntry *client_tail;
178 * Handle to our server.
180 static struct GNUNET_SERVER_Handle *srv;
183 * Our notification context.
185 static struct GNUNET_SERVER_NotificationContext *nc;
188 * Counter used to generate unique values.
190 static uint32_t uidgen;
193 * Set to YES if we are shutting down as soon as possible.
195 static int in_shutdown;
199 * Inject a message to our server with a client of 'NULL'.
201 * @param cls the 'struct GNUNET_SERVER_Handle'
202 * @param client unused
203 * @param msg message to inject
206 inject_message (void *cls, void *client, const struct GNUNET_MessageHeader *msg)
208 struct GNUNET_SERVER_Handle *server = cls;
210 GNUNET_break (GNUNET_OK == GNUNET_SERVER_inject (server, NULL, msg));
215 * Load persistent values from disk. Disk format is
216 * exactly the same format that we also use for
217 * setting the values over the network.
219 * @param server handle to the server context
222 load (struct GNUNET_SERVER_Handle *server)
225 struct GNUNET_BIO_ReadHandle *rh;
229 struct GNUNET_SERVER_MessageStreamTokenizer *mst;
232 fn = GNUNET_DISK_get_home_filename (cfg, "statistics", "statistics.data",
236 if ((GNUNET_OK != GNUNET_DISK_file_size (fn, &fsize, GNUNET_NO, GNUNET_YES)) || (fsize == 0))
241 buf = GNUNET_malloc (fsize);
242 rh = GNUNET_BIO_read_open (fn);
249 if (GNUNET_OK != GNUNET_BIO_read (rh, fn, buf, fsize))
251 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "read", fn);
252 GNUNET_break (GNUNET_OK == GNUNET_BIO_read_close (rh, &emsg));
254 GNUNET_free_non_null (emsg);
258 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
259 _("Loading %llu bytes of statistics from `%s'\n"),
261 mst = GNUNET_SERVER_mst_create (&inject_message, server);
262 GNUNET_break (GNUNET_OK ==
263 GNUNET_SERVER_mst_receive (mst, NULL, buf, fsize,
264 GNUNET_YES, GNUNET_NO));
265 GNUNET_SERVER_mst_destroy (mst);
267 GNUNET_break (GNUNET_OK == GNUNET_BIO_read_close (rh, &emsg));
268 GNUNET_free_non_null (emsg);
274 * Write persistent statistics to disk.
279 struct StatsEntry *pos;
281 struct GNUNET_BIO_WriteHandle *wh;
284 unsigned long long total;
287 fn = GNUNET_DISK_get_home_filename (cfg, "statistics", "statistics.data",
290 wh = GNUNET_BIO_write_open (fn);
292 while (NULL != (pos = start))
295 if ((pos->persistent) && (NULL != wh))
297 size = htons (pos->msg->header.size);
298 if (GNUNET_OK != GNUNET_BIO_write (wh, pos->msg, size))
300 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
301 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
302 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "close", fn);
312 if (GNUNET_OK != GNUNET_BIO_write_close (wh))
313 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "close", fn);
315 GNUNET_break (0 == UNLINK (fn));
317 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
318 _("Wrote %llu bytes of statistics to `%s'\n"), total, fn);
320 GNUNET_free_non_null (fn);
325 * Transmit the given stats value.
327 * @param client receiver of the value
328 * @param e value to transmit
331 transmit (struct GNUNET_SERVER_Client *client, const struct StatsEntry *e)
333 struct GNUNET_STATISTICS_ReplyMessage *m;
337 sizeof (struct GNUNET_STATISTICS_ReplyMessage) + strlen (e->service) + 1 +
338 strlen (e->name) + 1;
339 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
340 m = GNUNET_malloc (size);
341 m->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_VALUE);
342 m->header.size = htons (size);
343 m->uid = htonl (e->uid);
345 m->uid |= htonl (GNUNET_STATISTICS_PERSIST_BIT);
346 m->value = GNUNET_htonll (e->value);
347 size -= sizeof (struct GNUNET_STATISTICS_ReplyMessage);
348 GNUNET_assert (size ==
349 GNUNET_STRINGS_buffer_fill ((char *) &m[1], size, 2,
350 e->service, e->name));
351 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
352 "Transmitting value for `%s:%s' (%d): %llu\n", e->service,
353 e->name, e->persistent, e->value);
354 GNUNET_SERVER_notification_context_unicast (nc, client, &m->header,
361 * Does this entry match the request?
364 * @param service name of service to match
365 * @param name value to match
366 * @return 1 if they match, 0 if not
369 matches (const struct StatsEntry *e, const char *service, const char *name)
371 return ((0 == strlen (service)) || (0 == strcmp (service, e->service))) &&
372 ((0 == strlen (name)) || (0 == strcmp (name, e->name)));
377 * Find a client entry for the given client handle, or create one.
379 * @param client handle to match
380 * @return corresponding client entry struct
382 static struct ClientEntry *
383 make_client_entry (struct GNUNET_SERVER_Client *client)
385 struct ClientEntry *ce;
387 GNUNET_assert (client != NULL);
391 if (ce->client == client)
397 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
400 ce = GNUNET_malloc (sizeof (struct ClientEntry));
402 GNUNET_SERVER_client_keep (client);
403 GNUNET_CONTAINER_DLL_insert (client_head, client_tail, ce);
404 GNUNET_SERVER_notification_context_add (nc, client);
410 * Handle GET-message.
413 * @param client identification of the client
414 * @param message the actual message
415 * @return GNUNET_OK to keep the connection open,
416 * GNUNET_SYSERR to close it (signal serious error)
419 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
420 const struct GNUNET_MessageHeader *message)
422 struct GNUNET_MessageHeader end;
425 struct StatsEntry *pos;
428 if ( (NULL != client) &&
429 (NULL == make_client_entry (client)) )
430 return; /* new client during shutdown */
431 size = ntohs (message->size) - sizeof (struct GNUNET_MessageHeader);
433 GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1], size, 2,
437 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
440 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
441 "Received request for statistics on `%s:%s'\n",
442 strlen (service) ? service : "*", strlen (name) ? name : "*");
443 for (pos = start; NULL != pos; pos = pos->next)
444 if (matches (pos, service, name))
445 transmit (client, pos);
446 end.size = htons (sizeof (struct GNUNET_MessageHeader));
447 end.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_END);
448 GNUNET_SERVER_notification_context_unicast (nc, client, &end, GNUNET_NO);
449 GNUNET_SERVER_receive_done (client, GNUNET_OK);
454 * Notify all clients listening about a change to a value.
456 * @param se value that changed
459 notify_change (struct StatsEntry *se)
461 struct GNUNET_STATISTICS_WatchValueMessage wvm;
462 struct WatchEntry *pos;
464 for (pos = se->we_head; NULL != pos; pos = pos->next)
466 if (pos->last_value == se->value)
468 wvm.header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE);
470 htons (sizeof (struct GNUNET_STATISTICS_WatchValueMessage));
471 wvm.flags = htonl (se->persistent ? GNUNET_STATISTICS_PERSIST_BIT : 0);
472 wvm.wid = htonl (pos->wid);
473 wvm.reserved = htonl (0);
474 wvm.value = GNUNET_htonll (se->value);
475 GNUNET_SERVER_notification_context_unicast (nc, pos->client, &wvm.header,
477 pos->last_value = se->value;
482 * Handle SET-message.
485 * @param client identification of the client
486 * @param message the actual message
489 handle_set (void *cls, struct GNUNET_SERVER_Client *client,
490 const struct GNUNET_MessageHeader *message)
496 const struct GNUNET_STATISTICS_SetMessage *msg;
497 struct StatsEntry *pos;
498 struct StatsEntry *prev;
504 if ( (NULL != client) &&
505 (NULL == make_client_entry (client)) )
506 return; /* new client during shutdown */
507 msize = ntohs (message->size);
508 if (msize < sizeof (struct GNUNET_STATISTICS_SetMessage))
511 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
514 size = msize - sizeof (struct GNUNET_STATISTICS_SetMessage);
515 msg = (const struct GNUNET_STATISTICS_SetMessage *) message;
518 GNUNET_STRINGS_buffer_tokenize ((const char *) &msg[1], size, 2, &service,
522 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
525 flags = ntohl (msg->flags);
526 value = GNUNET_ntohll (msg->value);
527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
528 "Received request to update statistic on `%s:%s' (%u) to/by %llu\n",
529 service, name, (unsigned int) flags, (unsigned long long) value);
534 if (matches (pos, service, name))
536 if ((flags & GNUNET_STATISTICS_SETFLAG_RELATIVE) == 0)
538 changed = (pos->value != value);
543 delta = (int64_t) value;
544 if ((delta < 0) && (pos->value < -delta))
546 changed = (pos->value != 0);
551 changed = (delta != 0);
552 GNUNET_break ((delta <= 0) || (pos->value + delta > pos->value));
556 pos->msg->value = GNUNET_htonll (pos->value);
557 pos->msg->flags = msg->flags;
558 pos->persistent = (0 != (flags & GNUNET_STATISTICS_SETFLAG_PERSISTENT));
561 /* move to front for faster setting next time! */
562 prev->next = pos->next;
566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
567 "Statistic `%s:%s' updated to value %llu.\n", service, name,
571 GNUNET_SERVER_receive_done (client, GNUNET_OK);
577 pos = GNUNET_malloc (sizeof (struct StatsEntry) + msize);
579 if (((flags & GNUNET_STATISTICS_SETFLAG_RELATIVE) == 0) ||
580 (0 < (int64_t) GNUNET_ntohll (msg->value)))
581 pos->value = GNUNET_ntohll (msg->value);
583 pos->persistent = (0 != (flags & GNUNET_STATISTICS_SETFLAG_PERSISTENT));
584 pos->msg = (void *) &pos[1];
585 memcpy (pos->msg, message, ntohs (message->size));
586 pos->service = (const char *) &pos->msg[1];
587 pos->name = &pos->service[strlen (pos->service) + 1];
590 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
591 "New statistic on `%s:%s' with value %llu created.\n", service,
593 GNUNET_SERVER_receive_done (client, GNUNET_OK);
598 * Handle WATCH-message.
601 * @param client identification of the client
602 * @param message the actual message
605 handle_watch (void *cls, struct GNUNET_SERVER_Client *client,
606 const struct GNUNET_MessageHeader *message)
612 struct StatsEntry *pos;
613 struct ClientEntry *ce;
614 struct WatchEntry *we;
619 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
622 ce = make_client_entry (client);
623 msize = ntohs (message->size);
624 if (msize < sizeof (struct GNUNET_MessageHeader))
627 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
630 size = msize - sizeof (struct GNUNET_MessageHeader);
632 GNUNET_STRINGS_buffer_tokenize ((const char *) &message[1], size, 2,
636 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
639 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
640 "Received request to watch statistic on `%s:%s'\n", service,
645 if (matches (pos, service, name))
652 GNUNET_malloc (sizeof (struct StatsEntry) +
653 sizeof (struct GNUNET_STATISTICS_SetMessage) + size);
656 pos->msg = (void *) &pos[1];
657 pos->msg->header.size =
658 htons (sizeof (struct GNUNET_STATISTICS_SetMessage) + size);
659 pos->msg->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_SET);
660 pos->service = (const char *) &pos->msg[1];
661 slen = strlen (service) + 1;
662 memcpy ((void *) pos->service, service, slen);
663 pos->name = &pos->service[slen];
664 memcpy ((void *) pos->name, name, strlen (name) + 1);
667 we = GNUNET_malloc (sizeof (struct WatchEntry));
669 GNUNET_SERVER_client_keep (client);
670 we->wid = ce->max_wid++;
671 GNUNET_CONTAINER_DLL_insert (pos->we_head, pos->we_tail, we);
674 GNUNET_SERVER_receive_done (client, GNUNET_OK);
679 * Actually perform the shutdown.
684 struct WatchEntry *we;
685 struct StatsEntry *se;
690 GNUNET_SERVER_notification_context_destroy (nc);
692 GNUNET_assert (NULL == client_head);
693 while (NULL != (se = start))
696 while (NULL != (we = se->we_head))
698 GNUNET_SERVER_client_drop (we->client);
699 GNUNET_CONTAINER_DLL_remove (se->we_head, se->we_tail, we);
708 * Task run during shutdown.
714 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
716 in_shutdown = GNUNET_YES;
717 if (NULL != client_head)
724 * A client disconnected. Remove all of its data structure entries.
726 * @param cls closure, NULL
727 * @param client identification of the client
730 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
732 struct ClientEntry *ce;
733 struct WatchEntry *we;
734 struct WatchEntry *wen;
735 struct StatsEntry *se;
740 if (ce->client == client)
742 GNUNET_SERVER_client_drop (ce->client);
743 GNUNET_CONTAINER_DLL_remove (client_head, client_tail, ce);
753 while (NULL != (we = wen))
756 if (we->client != client)
758 GNUNET_SERVER_client_drop (we->client);
759 GNUNET_CONTAINER_DLL_remove (se->we_head, se->we_tail, we);
764 if ( (NULL == client_head) &&
765 (GNUNET_YES == in_shutdown) )
771 * Process statistics requests.
774 * @param server the initialized server
775 * @param c configuration to use
778 run (void *cls, struct GNUNET_SERVER_Handle *server,
779 const struct GNUNET_CONFIGURATION_Handle *c)
781 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
782 {&handle_set, NULL, GNUNET_MESSAGE_TYPE_STATISTICS_SET, 0},
783 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_STATISTICS_GET, 0},
784 {&handle_watch, NULL, GNUNET_MESSAGE_TYPE_STATISTICS_WATCH, 0},
789 GNUNET_SERVER_add_handlers (server, handlers);
790 GNUNET_SERVER_ignore_shutdown (server, GNUNET_YES);
791 nc = GNUNET_SERVER_notification_context_create (server, 16);
792 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
794 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
800 * The main function for the statistics service.
802 * @param argc number of arguments from the command line
803 * @param argv command line arguments
804 * @return 0 ok, 1 on error
807 main (int argc, char *const *argv)
810 GNUNET_SERVICE_run (argc, argv, "statistics",
811 GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
814 /* end of gnunet-service-statistics.c */