2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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 2, 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/statistics_api.c
23 * @brief API of the statistics service
24 * @author Christian Grothoff
27 #include "gnunet_client_lib.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_container_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_server_lib.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_strings_lib.h"
34 #include "statistics.h"
37 * How long do we wait until a statistics request for setting
38 * a value times out? (The update will be lost if the
39 * service does not react within this timeframe).
41 #define SET_TRANSMIT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
43 #define LOG(kind,...) GNUNET_log_from (kind, "statistics-api",__VA_ARGS__)
73 * Entry kept for each value we are watching.
75 struct GNUNET_STATISTICS_WatchEntry
79 * What subsystem is this action about? (never NULL)
84 * What value is this action about? (never NULL)
91 GNUNET_STATISTICS_Iterator proc;
102 * Linked list of things we still need to do.
104 struct GNUNET_STATISTICS_GetHandle
108 * This is a doubly linked list.
110 struct GNUNET_STATISTICS_GetHandle *next;
113 * This is a doubly linked list.
115 struct GNUNET_STATISTICS_GetHandle *prev;
118 * Main statistics handle.
120 struct GNUNET_STATISTICS_Handle *sh;
123 * What subsystem is this action about? (can be NULL)
128 * What value is this action about? (can be NULL)
133 * Continuation to call once action is complete.
135 GNUNET_STATISTICS_Callback cont;
138 * Function to call (for GET actions only).
140 GNUNET_STATISTICS_Iterator proc;
143 * Closure for proc and cont.
148 * Timeout for this action.
150 struct GNUNET_TIME_Absolute timeout;
158 * Flag for SET/UPDATE actions.
163 * Has the current iteration been aborted; for GET actions.
168 * Is this a GET, SET, UPDATE or WATCH?
170 enum ActionType type;
173 * Size of the message that we will be transmitting.
181 * Handle for the service.
183 struct GNUNET_STATISTICS_Handle
186 * Name of our subsystem.
191 * Configuration to use.
193 const struct GNUNET_CONFIGURATION_Handle *cfg;
196 * Socket (if available).
198 struct GNUNET_CLIENT_Connection *client;
201 * Currently pending transmission request.
203 struct GNUNET_CLIENT_TransmitHandle *th;
206 * Head of the linked list of pending actions (first action
209 struct GNUNET_STATISTICS_GetHandle *action_head;
212 * Tail of the linked list of actions (for fast append).
214 struct GNUNET_STATISTICS_GetHandle *action_tail;
217 * Action we are currently busy with (action request has been
218 * transmitted, we're now receiving the response from the
221 struct GNUNET_STATISTICS_GetHandle *current;
224 * Array of watch entries.
226 struct GNUNET_STATISTICS_WatchEntry **watches;
229 * Task doing exponential back-off trying to reconnect.
231 GNUNET_SCHEDULER_TaskIdentifier backoff_task;
234 * Time for next connect retry.
236 struct GNUNET_TIME_Relative backoff;
239 * Maximum heap size observed so far (if available).
241 uint64_t peak_heap_size;
244 * Maximum resident set side observed so far (if available).
249 * Size of the 'watches' array.
251 unsigned int watches_size;
254 * Should this handle auto-destruct once all actions have
260 * Are we currently receiving from the service?
268 * Obtain statistics about this process's memory consumption and
269 * report those as well (if they changed).
272 update_memory_statistics (struct GNUNET_STATISTICS_Handle *h)
274 uint64_t current_heap_size = 0;
275 uint64_t current_rss = 0;
277 if (GNUNET_NO != h->do_destroy)
284 current_heap_size = mi.uordblks + mi.fordblks;
291 if (0 == getrusage (RUSAGE_SELF, &ru))
293 current_rss = 1024LL * ru.ru_maxrss;
297 if (current_heap_size > h->peak_heap_size)
299 h->peak_heap_size = current_heap_size;
300 GNUNET_STATISTICS_set (h, "# peak heap size", current_heap_size, GNUNET_NO);
302 if (current_rss > h->peak_rss)
304 h->peak_rss = current_rss;
305 GNUNET_STATISTICS_set (h, "# peak resident set size", current_rss, GNUNET_NO);
311 * Schedule the next action to be performed.
313 * @param h statistics handle to reconnect
316 schedule_action (struct GNUNET_STATISTICS_Handle *h);
320 * Transmit request to service that we want to watch
321 * the development of a particular value.
323 * @param h statistics handle
324 * @param watch watch entry of the value to watch
327 schedule_watch_request (struct GNUNET_STATISTICS_Handle *h,
328 struct GNUNET_STATISTICS_WatchEntry *watch)
331 struct GNUNET_STATISTICS_GetHandle *ai;
336 GNUNET_assert (NULL != h);
337 GNUNET_assert (NULL != watch);
339 slen = strlen (watch->subsystem) + 1;
340 nlen = strlen (watch->name) + 1;
341 nsize = sizeof (struct GNUNET_MessageHeader) + slen + nlen;
342 if (nsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
347 ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
349 ai->subsystem = GNUNET_strdup (watch->subsystem);
350 ai->name = GNUNET_strdup (watch->name);
351 ai->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
353 ai->type = ACTION_WATCH;
354 ai->proc = watch->proc;
355 ai->cls = watch->proc_cls;
356 GNUNET_CONTAINER_DLL_insert_tail (h->action_head, h->action_tail,
363 * Free memory associated with the given action item.
365 * @param gh action item to free
368 free_action_item (struct GNUNET_STATISTICS_GetHandle *gh)
370 GNUNET_free_non_null (gh->subsystem);
371 GNUNET_free_non_null (gh->name);
377 * Disconnect from the statistics service.
379 * @param h statistics handle to disconnect from
382 do_disconnect (struct GNUNET_STATISTICS_Handle *h)
384 struct GNUNET_STATISTICS_GetHandle *c;
388 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
391 if (NULL != h->client)
393 GNUNET_CLIENT_disconnect (h->client);
396 h->receiving = GNUNET_NO;
397 if (NULL != (c = h->current))
401 c->cont (c->cls, GNUNET_SYSERR);
402 free_action_item (c);
408 * Try to (re)connect to the statistics service.
410 * @param h statistics handle to reconnect
411 * @return GNUNET_YES on success, GNUNET_NO on failure.
414 try_connect (struct GNUNET_STATISTICS_Handle *h)
416 struct GNUNET_STATISTICS_GetHandle *gh;
417 struct GNUNET_STATISTICS_GetHandle *gn;
420 if (GNUNET_SCHEDULER_NO_TASK != h->backoff_task)
422 if (NULL != h->client)
424 h->client = GNUNET_CLIENT_connect ("statistics", h->cfg);
425 if (NULL != h->client)
428 while (NULL != (gh = gn))
431 if (gh->type == ACTION_WATCH)
433 GNUNET_CONTAINER_DLL_remove (h->action_head,
436 free_action_item (gh);
439 for (i = 0; i < h->watches_size; i++)
441 if (NULL != h->watches[i])
442 schedule_watch_request (h, h->watches[i]);
446 LOG (GNUNET_ERROR_TYPE_DEBUG,
447 "Failed to connect to statistics service!\n");
453 * We've waited long enough, reconnect now.
455 * @param cls the 'struct GNUNET_STATISTICS_Handle' to reconnect
456 * @param tc scheduler context (unused)
459 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
461 struct GNUNET_STATISTICS_Handle *h = cls;
463 h->backoff_task = GNUNET_SCHEDULER_NO_TASK;
469 * Task used by 'reconnect_later' to shutdown the handle
471 * @param cls the statistics handle
472 * @param tc scheduler context
475 do_destroy (void *cls,
476 const struct GNUNET_SCHEDULER_TaskContext *tc)
478 struct GNUNET_STATISTICS_Handle *h = cls;
480 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
485 * Reconnect at a later time, respecting back-off.
487 * @param h statistics handle
490 reconnect_later (struct GNUNET_STATISTICS_Handle *h)
493 struct GNUNET_STATISTICS_GetHandle *gh;
495 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->backoff_task);
496 if (GNUNET_YES == h->do_destroy)
498 /* So we are shutting down and the service is not reachable.
499 * Chances are that it's down for good and we are not going to connect to
501 * Give up and don't sync the rest of the data.
504 for (gh = h->action_head; NULL != gh; gh = gh->next)
505 if ( (gh->make_persistent) && (ACTION_SET == gh->type) )
507 if (GNUNET_YES == loss)
508 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
509 _("Could not save some persistent statistics\n"));
510 h->do_destroy = GNUNET_NO;
511 GNUNET_SCHEDULER_add_continuation (&do_destroy, h,
512 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
516 GNUNET_SCHEDULER_add_delayed (h->backoff, &reconnect_task, h);
517 h->backoff = GNUNET_TIME_relative_multiply (h->backoff, 2);
519 GNUNET_TIME_relative_min (h->backoff, GNUNET_CONSTANTS_SERVICE_TIMEOUT);
524 * Process a 'GNUNET_MESSAGE_TYPE_STATISTICS_VALUE' message.
526 * @param h statistics handle
527 * @param msg message received from the service, never NULL
528 * @return GNUNET_OK if the message was well-formed
531 process_statistics_value_message (struct GNUNET_STATISTICS_Handle *h,
532 const struct GNUNET_MessageHeader *msg)
536 const struct GNUNET_STATISTICS_ReplyMessage *smsg;
539 if (h->current->aborted)
541 LOG (GNUNET_ERROR_TYPE_DEBUG, "Iteration was aborted, ignoring VALUE\n");
542 return GNUNET_OK; /* don't bother */
544 size = ntohs (msg->size);
545 if (size < sizeof (struct GNUNET_STATISTICS_ReplyMessage))
548 return GNUNET_SYSERR;
550 smsg = (const struct GNUNET_STATISTICS_ReplyMessage *) msg;
551 size -= sizeof (struct GNUNET_STATISTICS_ReplyMessage);
553 GNUNET_STRINGS_buffer_tokenize ((const char *) &smsg[1], size, 2,
557 return GNUNET_SYSERR;
559 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received valid statistic on `%s:%s': %llu\n",
560 service, name, GNUNET_ntohll (smsg->value));
562 h->current->proc (h->current->cls, service, name,
563 GNUNET_ntohll (smsg->value),
565 (ntohl (smsg->uid) & GNUNET_STATISTICS_PERSIST_BIT)))
567 LOG (GNUNET_ERROR_TYPE_DEBUG,
568 "Processing of remaining statistics aborted by client.\n");
569 h->current->aborted = GNUNET_YES;
571 LOG (GNUNET_ERROR_TYPE_DEBUG, "VALUE processed successfully\n");
577 * We have received a watch value from the service. Process it.
579 * @param h statistics handle
580 * @param msg the watch value message
581 * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not,
582 * GNUNET_NO if this watch has been cancelled
585 process_watch_value (struct GNUNET_STATISTICS_Handle *h,
586 const struct GNUNET_MessageHeader *msg)
588 const struct GNUNET_STATISTICS_WatchValueMessage *wvm;
589 struct GNUNET_STATISTICS_WatchEntry *w;
592 if (sizeof (struct GNUNET_STATISTICS_WatchValueMessage) != ntohs (msg->size))
595 return GNUNET_SYSERR;
597 wvm = (const struct GNUNET_STATISTICS_WatchValueMessage *) msg;
598 GNUNET_break (0 == ntohl (wvm->reserved));
599 wid = ntohl (wvm->wid);
600 if (wid >= h->watches_size)
603 return GNUNET_SYSERR;
608 (void) w->proc (w->proc_cls, w->subsystem, w->name,
609 GNUNET_ntohll (wvm->value),
610 0 != (ntohl (wvm->flags) & GNUNET_STATISTICS_PERSIST_BIT));
616 destroy_task (void *cls,
617 const struct GNUNET_SCHEDULER_TaskContext *tc)
619 struct GNUNET_STATISTICS_Handle *h = cls;
621 GNUNET_STATISTICS_destroy (h, GNUNET_NO);
626 * Function called with messages from stats service.
629 * @param msg message received, NULL on timeout or fatal error
632 receive_stats (void *cls, const struct GNUNET_MessageHeader *msg)
634 struct GNUNET_STATISTICS_Handle *h = cls;
635 struct GNUNET_STATISTICS_GetHandle *c;
640 LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
641 "Error receiving statistics from service, is the service running?\n");
646 switch (ntohs (msg->type))
648 case GNUNET_MESSAGE_TYPE_TEST:
649 if (GNUNET_SYSERR != h->do_destroy)
651 /* not in shutdown, why do we get 'TEST'? */
657 h->do_destroy = GNUNET_NO;
658 GNUNET_SCHEDULER_add_continuation (&destroy_task, h,
659 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
661 case GNUNET_MESSAGE_TYPE_STATISTICS_END:
662 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received end of statistics marker\n");
663 if (NULL == (c = h->current))
670 h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
671 if (h->watches_size > 0)
673 GNUNET_CLIENT_receive (h->client, &receive_stats, h,
674 GNUNET_TIME_UNIT_FOREVER_REL);
678 h->receiving = GNUNET_NO;
683 c->cont (c->cls, GNUNET_OK);
684 free_action_item (c);
686 case GNUNET_MESSAGE_TYPE_STATISTICS_VALUE:
687 if (GNUNET_OK != process_statistics_value_message (h, msg))
693 /* finally, look for more! */
694 LOG (GNUNET_ERROR_TYPE_DEBUG,
695 "Processing VALUE done, now reading more\n");
696 GNUNET_CLIENT_receive (h->client, &receive_stats, h,
697 GNUNET_TIME_absolute_get_remaining (h->
699 h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
701 case GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE:
703 (ret = process_watch_value (h, msg)))
706 if (GNUNET_NO == ret)
707 h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
711 h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
712 GNUNET_assert (h->watches_size > 0);
713 GNUNET_CLIENT_receive (h->client, &receive_stats, h,
714 GNUNET_TIME_UNIT_FOREVER_REL);
726 * Transmit a GET request (and if successful, start to receive
729 * @param handle statistics handle
730 * @param size how many bytes can we write to buf
731 * @param buf where to write requests to the service
732 * @return number of bytes written to buf
735 transmit_get (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
737 struct GNUNET_STATISTICS_GetHandle *c;
738 struct GNUNET_MessageHeader *hdr;
743 GNUNET_assert (NULL != (c = handle->current));
746 /* timeout / error */
747 LOG (GNUNET_ERROR_TYPE_DEBUG,
748 "Transmission of request for statistics failed!\n");
749 do_disconnect (handle);
750 reconnect_later (handle);
753 slen1 = strlen (c->subsystem) + 1;
754 slen2 = strlen (c->name) + 1;
755 msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
756 GNUNET_assert (msize <= size);
757 hdr = (struct GNUNET_MessageHeader *) buf;
758 hdr->size = htons (msize);
759 hdr->type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_GET);
760 GNUNET_assert (slen1 + slen2 ==
761 GNUNET_STRINGS_buffer_fill ((char *) &hdr[1], slen1 + slen2, 2,
764 if (GNUNET_YES != handle->receiving)
766 LOG (GNUNET_ERROR_TYPE_DEBUG,
767 "Transmission of GET done, now reading response\n");
768 handle->receiving = GNUNET_YES;
769 GNUNET_CLIENT_receive (handle->client, &receive_stats, handle,
770 GNUNET_TIME_absolute_get_remaining (c->timeout));
777 * Transmit a WATCH request (and if successful, start to receive
780 * @param handle statistics handle
781 * @param size how many bytes can we write to buf
782 * @param buf where to write requests to the service
783 * @return number of bytes written to buf
786 transmit_watch (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
788 struct GNUNET_MessageHeader *hdr;
795 /* timeout / error */
796 LOG (GNUNET_ERROR_TYPE_DEBUG,
797 "Transmission of request for statistics failed!\n");
798 do_disconnect (handle);
799 reconnect_later (handle);
802 LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmitting watch request for `%s'\n",
803 handle->current->name);
804 slen1 = strlen (handle->current->subsystem) + 1;
805 slen2 = strlen (handle->current->name) + 1;
806 msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
807 GNUNET_assert (msize <= size);
808 hdr = (struct GNUNET_MessageHeader *) buf;
809 hdr->size = htons (msize);
810 hdr->type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_WATCH);
811 GNUNET_assert (slen1 + slen2 ==
812 GNUNET_STRINGS_buffer_fill ((char *) &hdr[1], slen1 + slen2, 2,
813 handle->current->subsystem,
814 handle->current->name));
815 if (GNUNET_YES != handle->receiving)
817 handle->receiving = GNUNET_YES;
818 GNUNET_CLIENT_receive (handle->client, &receive_stats, handle,
819 GNUNET_TIME_UNIT_FOREVER_REL);
821 GNUNET_assert (NULL == handle->current->cont);
822 free_action_item (handle->current);
823 handle->current = NULL;
829 * Transmit a SET/UPDATE request.
831 * @param handle statistics handle
832 * @param size how many bytes can we write to buf
833 * @param buf where to write requests to the service
834 * @return number of bytes written to buf
837 transmit_set (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
839 struct GNUNET_STATISTICS_SetMessage *r;
846 do_disconnect (handle);
847 reconnect_later (handle);
850 slen = strlen (handle->current->subsystem) + 1;
851 nlen = strlen (handle->current->name) + 1;
852 nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
856 do_disconnect (handle);
857 reconnect_later (handle);
861 r->header.size = htons (nsize);
862 r->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_SET);
864 r->value = GNUNET_htonll (handle->current->value);
865 if (handle->current->make_persistent)
866 r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_PERSISTENT);
867 if (handle->current->type == ACTION_UPDATE)
868 r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_RELATIVE);
869 GNUNET_assert (slen + nlen ==
870 GNUNET_STRINGS_buffer_fill ((char *) &r[1], slen + nlen, 2,
871 handle->current->subsystem,
872 handle->current->name));
873 GNUNET_assert (NULL == handle->current->cont);
874 free_action_item (handle->current);
875 handle->current = NULL;
876 update_memory_statistics (handle);
882 * Function called when we are ready to transmit a request to the service.
884 * @param cls the 'struct GNUNET_STATISTICS_Handle'
885 * @param size how many bytes can we write to buf
886 * @param buf where to write requests to the service
887 * @return number of bytes written to buf
890 transmit_action (void *cls, size_t size, void *buf)
892 struct GNUNET_STATISTICS_Handle *h = cls;
897 if (NULL != h->current)
898 switch (h->current->type)
901 ret = transmit_get (h, size, buf);
905 ret = transmit_set (h, size, buf);
908 ret = transmit_watch (h, size, buf);
920 * Get handle for the statistics service.
922 * @param subsystem name of subsystem using the service
923 * @param cfg services configuration in use
924 * @return handle to use
926 struct GNUNET_STATISTICS_Handle *
927 GNUNET_STATISTICS_create (const char *subsystem,
928 const struct GNUNET_CONFIGURATION_Handle *cfg)
930 struct GNUNET_STATISTICS_Handle *ret;
932 GNUNET_assert (NULL != subsystem);
933 GNUNET_assert (NULL != cfg);
934 ret = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_Handle));
936 ret->subsystem = GNUNET_strdup (subsystem);
937 ret->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
943 * Destroy a handle (free all state associated with
946 * @param h statistics handle to destroy
947 * @param sync_first set to GNUNET_YES if pending SET requests should
951 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h, int sync_first)
953 struct GNUNET_STATISTICS_GetHandle *pos;
954 struct GNUNET_STATISTICS_GetHandle *next;
955 struct GNUNET_TIME_Relative timeout;
960 GNUNET_assert (GNUNET_NO == h->do_destroy); // Don't call twice.
961 if (GNUNET_SCHEDULER_NO_TASK != h->backoff_task)
963 GNUNET_SCHEDULER_cancel (h->backoff_task);
964 h->backoff_task = GNUNET_SCHEDULER_NO_TASK;
968 if (NULL != h->current)
970 if (ACTION_GET == h->current->type)
972 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
974 free_action_item (h->current);
978 next = h->action_head;
979 while (NULL != (pos = next))
982 if (ACTION_GET == pos->type)
984 GNUNET_CONTAINER_DLL_remove (h->action_head,
987 free_action_item (pos);
990 if ( (NULL == h->current) &&
991 (NULL != (h->current = h->action_head)) )
992 GNUNET_CONTAINER_DLL_remove (h->action_head,
995 h->do_destroy = GNUNET_YES;
996 if ((NULL != h->current) && (NULL == h->th) &&
999 timeout = GNUNET_TIME_absolute_get_remaining (h->current->timeout);
1001 GNUNET_CLIENT_notify_transmit_ready (h->client, h->current->msize,
1002 timeout, GNUNET_YES,
1003 &transmit_action, h);
1004 GNUNET_assert (NULL != h->th);
1007 return; /* do not finish destruction just yet */
1009 while (NULL != (pos = h->action_head))
1011 GNUNET_CONTAINER_DLL_remove (h->action_head,
1014 free_action_item (pos);
1017 for (i = 0; i < h->watches_size; i++)
1019 if (NULL == h->watches[i])
1021 GNUNET_free (h->watches[i]->subsystem);
1022 GNUNET_free (h->watches[i]->name);
1023 GNUNET_free (h->watches[i]);
1025 GNUNET_array_grow (h->watches, h->watches_size, 0);
1026 GNUNET_free (h->subsystem);
1032 * Function called to transmit TEST message to service to
1033 * confirm that the service has received all of our 'SET'
1034 * messages (during statistics disconnect/shutdown).
1036 * @param cls the 'struct GNUNET_STATISTICS_Handle'
1037 * @param size how many bytes can we write to buf
1038 * @param buf where to write requests to the service
1039 * @return number of bytes written to buf
1042 transmit_test_on_shutdown (void *cls,
1046 struct GNUNET_STATISTICS_Handle *h = cls;
1047 struct GNUNET_MessageHeader hdr;
1052 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1053 _("Failed to receive acknowledgement from statistics service, some statistics might have been lost!\n"));
1054 h->do_destroy = GNUNET_NO;
1055 GNUNET_SCHEDULER_add_continuation (&destroy_task, h,
1056 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1059 hdr.type = htons (GNUNET_MESSAGE_TYPE_TEST);
1060 hdr.size = htons (sizeof (struct GNUNET_MessageHeader));
1061 memcpy (buf, &hdr, sizeof (hdr));
1062 if (GNUNET_YES != h->receiving)
1064 h->receiving = GNUNET_YES;
1065 GNUNET_CLIENT_receive (h->client, &receive_stats, h,
1066 GNUNET_TIME_UNIT_FOREVER_REL);
1068 return sizeof (struct GNUNET_MessageHeader);
1073 * Schedule the next action to be performed.
1075 * @param h statistics handle
1078 schedule_action (struct GNUNET_STATISTICS_Handle *h)
1080 struct GNUNET_TIME_Relative timeout;
1082 if ( (NULL != h->th) ||
1083 (GNUNET_SCHEDULER_NO_TASK != h->backoff_task) )
1084 return; /* action already pending */
1085 if (GNUNET_YES != try_connect (h))
1087 reconnect_later (h);
1090 if (NULL != h->current)
1091 return; /* action already pending */
1092 /* schedule next action */
1093 h->current = h->action_head;
1094 if (NULL == h->current)
1096 if (GNUNET_YES == h->do_destroy)
1098 h->do_destroy = GNUNET_SYSERR; /* in 'TEST' mode */
1099 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
1100 sizeof (struct GNUNET_MessageHeader),
1101 SET_TRANSMIT_TIMEOUT,
1103 &transmit_test_on_shutdown, h);
1107 GNUNET_CONTAINER_DLL_remove (h->action_head, h->action_tail, h->current);
1108 timeout = GNUNET_TIME_absolute_get_remaining (h->current->timeout);
1111 GNUNET_CLIENT_notify_transmit_ready (h->client, h->current->msize,
1112 timeout, GNUNET_YES,
1113 &transmit_action, h)))
1115 LOG (GNUNET_ERROR_TYPE_DEBUG,
1116 "Failed to transmit request to statistics service.\n");
1118 reconnect_later (h);
1124 * Get statistic from the peer.
1126 * @param handle identification of the statistics service
1127 * @param subsystem limit to the specified subsystem, NULL for our subsystem
1128 * @param name name of the statistic value, NULL for all values
1129 * @param timeout after how long should we give up (and call
1130 * cont with an error code)?
1131 * @param cont continuation to call when done (can be NULL)
1132 * This callback CANNOT destroy the statistics handle in the same call.
1133 * @param proc function to call on each value
1134 * @param cls closure for cont and proc
1135 * @return NULL on error
1137 struct GNUNET_STATISTICS_GetHandle *
1138 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
1139 const char *subsystem, const char *name,
1140 struct GNUNET_TIME_Relative timeout,
1141 GNUNET_STATISTICS_Callback cont,
1142 GNUNET_STATISTICS_Iterator proc, void *cls)
1146 struct GNUNET_STATISTICS_GetHandle *ai;
1150 GNUNET_assert (NULL != proc);
1151 GNUNET_assert (GNUNET_NO == handle->do_destroy);
1152 if (NULL == subsystem)
1156 slen1 = strlen (subsystem) + 1;
1157 slen2 = strlen (name) + 1;
1158 GNUNET_assert (slen1 + slen2 + sizeof (struct GNUNET_MessageHeader) <
1159 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1160 ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
1162 ai->subsystem = GNUNET_strdup (subsystem);
1163 ai->name = GNUNET_strdup (name);
1167 ai->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1168 ai->type = ACTION_GET;
1169 ai->msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
1170 GNUNET_CONTAINER_DLL_insert_tail (handle->action_head, handle->action_tail,
1172 schedule_action (handle);
1178 * Cancel a 'get' request. Must be called before the 'cont'
1179 * function is called.
1181 * @param gh handle of the request to cancel
1184 GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh)
1188 if (gh->sh->current == gh)
1190 gh->aborted = GNUNET_YES;
1194 GNUNET_CONTAINER_DLL_remove (gh->sh->action_head, gh->sh->action_tail, gh);
1195 GNUNET_free (gh->name);
1196 GNUNET_free (gh->subsystem);
1203 * Watch statistics from the peer (be notified whenever they change).
1205 * @param handle identification of the statistics service
1206 * @param subsystem limit to the specified subsystem, never NULL
1207 * @param name name of the statistic value, never NULL
1208 * @param proc function to call on each value
1209 * @param proc_cls closure for proc
1210 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1213 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
1214 const char *subsystem, const char *name,
1215 GNUNET_STATISTICS_Iterator proc, void *proc_cls)
1217 struct GNUNET_STATISTICS_WatchEntry *w;
1220 return GNUNET_SYSERR;
1221 w = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_WatchEntry));
1222 w->subsystem = GNUNET_strdup (subsystem);
1223 w->name = GNUNET_strdup (name);
1225 w->proc_cls = proc_cls;
1226 GNUNET_array_append (handle->watches, handle->watches_size, w);
1227 schedule_watch_request (handle, w);
1233 * Stop watching statistics from the peer.
1235 * @param handle identification of the statistics service
1236 * @param subsystem limit to the specified subsystem, never NULL
1237 * @param name name of the statistic value, never NULL
1238 * @param proc function to call on each value
1239 * @param proc_cls closure for proc
1240 * @return GNUNET_OK on success, GNUNET_SYSERR on error (no such watch)
1243 GNUNET_STATISTICS_watch_cancel (struct GNUNET_STATISTICS_Handle *handle,
1244 const char *subsystem, const char *name,
1245 GNUNET_STATISTICS_Iterator proc, void *proc_cls)
1247 struct GNUNET_STATISTICS_WatchEntry *w;
1251 return GNUNET_SYSERR;
1252 for (i=0;i<handle->watches_size;i++)
1254 w = handle->watches[i];
1257 if ( (w->proc == proc) &&
1258 (w->proc_cls == proc_cls) &&
1259 (0 == strcmp (w->name, name)) &&
1260 (0 == strcmp (w->subsystem, subsystem)) )
1262 GNUNET_free (w->name);
1263 GNUNET_free (w->subsystem);
1265 handle->watches[i] = NULL;
1269 return GNUNET_SYSERR;
1275 * Queue a request to change a statistic.
1277 * @param h statistics handle
1278 * @param name name of the value
1279 * @param make_persistent should the value be kept across restarts?
1280 * @param value new value or change
1281 * @param type type of the action (ACTION_SET or ACTION_UPDATE)
1284 add_setter_action (struct GNUNET_STATISTICS_Handle *h, const char *name,
1285 int make_persistent, uint64_t value, enum ActionType type)
1287 struct GNUNET_STATISTICS_GetHandle *ai;
1293 GNUNET_assert (NULL != h);
1294 GNUNET_assert (NULL != name);
1295 slen = strlen (h->subsystem) + 1;
1296 nlen = strlen (name) + 1;
1297 nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
1298 if (nsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1303 for (ai = h->action_head; NULL != ai; ai = ai->next)
1305 if (! ( (0 == strcmp (ai->subsystem, h->subsystem)) &&
1306 (0 == strcmp (ai->name, name)) &&
1307 ( (ACTION_UPDATE == ai->type) ||
1308 (ACTION_SET == ai->type) ) ) )
1310 if (ACTION_SET == ai->type)
1312 if (ACTION_UPDATE == type)
1314 delta = (int64_t) value;
1317 /* update old set by new delta */
1322 /* update old set by new delta, but never go negative */
1323 if (ai->value < -delta)
1331 /* new set overrides old set */
1337 if (ACTION_UPDATE == type)
1339 /* make delta cummulative */
1340 delta = (int64_t) value;
1345 /* drop old 'update', use new 'set' instead */
1350 ai->timeout = GNUNET_TIME_relative_to_absolute (SET_TRANSMIT_TIMEOUT);
1351 ai->make_persistent = make_persistent;
1354 /* no existing entry matches, create a fresh one */
1355 ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
1357 ai->subsystem = GNUNET_strdup (h->subsystem);
1358 ai->name = GNUNET_strdup (name);
1359 ai->timeout = GNUNET_TIME_relative_to_absolute (SET_TRANSMIT_TIMEOUT);
1360 ai->make_persistent = make_persistent;
1364 GNUNET_CONTAINER_DLL_insert_tail (h->action_head, h->action_tail,
1366 schedule_action (h);
1371 * Set statistic value for the peer. Will always use our
1372 * subsystem (the argument used when "handle" was created).
1374 * @param handle identification of the statistics service
1375 * @param name name of the statistic value
1376 * @param value new value to set
1377 * @param make_persistent should the value be kept across restarts?
1380 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
1381 const char *name, uint64_t value, int make_persistent)
1385 GNUNET_assert (GNUNET_NO == handle->do_destroy);
1386 add_setter_action (handle, name, make_persistent, value, ACTION_SET);
1391 * Set statistic value for the peer. Will always use our
1392 * subsystem (the argument used when "handle" was created).
1394 * @param handle identification of the statistics service
1395 * @param name name of the statistic value
1396 * @param delta change in value (added to existing value)
1397 * @param make_persistent should the value be kept across restarts?
1400 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
1401 const char *name, int64_t delta, int make_persistent)
1407 GNUNET_assert (GNUNET_NO == handle->do_destroy);
1408 add_setter_action (handle, name, make_persistent, (uint64_t) delta,
1413 /* end of statistics_api.c */