src/statistics/statistics_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file statistics/statistics_api.c
  23  * @brief API of the statistics service
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  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"
  35
  36 /**
  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).
  40  */
  41 #define SET_TRANSMIT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
  42
  43
  44 /**
  45  * Types of actions.
  46  */
  47 enum ActionType
  48 {
  49   ACTION_GET,
  50   ACTION_SET,
  51   ACTION_UPDATE,
  52   ACTION_WATCH
  53 };
  54
  55
  56 /**
  57  * Entry kept for each value we are watching.
  58  */
  59 struct GNUNET_STATISTICS_WatchEntry
  60 {
  61
  62   /**
  63    * What subsystem is this action about? (never NULL)
  64    */
  65   char *subsystem;
  66
  67   /**
  68    * What value is this action about? (never NULL)
  69    */
  70   char *name;
  71
  72   /**
  73    * Function to call
  74    */
  75   GNUNET_STATISTICS_Iterator proc;
  76
  77   /**
  78    * Closure for proc
  79    */
  80   void *proc_cls;
  81
  82 };
  83
  84
  85 /**
  86  * Linked list of things we still need to do.
  87  */
  88 struct GNUNET_STATISTICS_GetHandle
  89 {
  90
  91   /**
  92    * This is a doubly linked list.
  93    */
  94   struct GNUNET_STATISTICS_GetHandle *next;
  95
  96   /**
  97    * This is a doubly linked list.
  98    */
  99   struct GNUNET_STATISTICS_GetHandle *prev;
 100
 101   /**
 102    * Main statistics handle.
 103    */
 104   struct GNUNET_STATISTICS_Handle *sh;
 105
 106   /**
 107    * What subsystem is this action about? (can be NULL)
 108    */
 109   char *subsystem;
 110
 111   /**
 112    * What value is this action about? (can be NULL)
 113    */
 114   char *name;
 115
 116   /**
 117    * Continuation to call once action is complete.
 118    */
 119   GNUNET_STATISTICS_Callback cont;
 120
 121   /**
 122    * Function to call (for GET actions only).
 123    */
 124   GNUNET_STATISTICS_Iterator proc;
 125
 126   /**
 127    * Closure for proc and cont.
 128    */
 129   void *cls;
 130
 131   /**
 132    * Timeout for this action.
 133    */
 134   struct GNUNET_TIME_Absolute timeout;
 135
 136   /**
 137    * Associated value.
 138    */
 139   uint64_t value;
 140
 141   /**
 142    * Flag for SET/UPDATE actions.
 143    */
 144   int make_persistent;
 145
 146   /**
 147    * Has the current iteration been aborted; for GET actions.
 148    */
 149   int aborted;
 150
 151   /**
 152    * Is this a GET, SET, UPDATE or WATCH?
 153    */
 154   enum ActionType type;
 155
 156   /**
 157    * Size of the message that we will be transmitting.
 158    */
 159   uint16_t msize;
 160
 161 };
 162
 163
 164 /**
 165  * Handle for the service.
 166  */
 167 struct GNUNET_STATISTICS_Handle
 168 {
 169   /**
 170    * Name of our subsystem.
 171    */
 172   char *subsystem;
 173
 174   /**
 175    * Configuration to use.
 176    */
 177   const struct GNUNET_CONFIGURATION_Handle *cfg;
 178
 179   /**
 180    * Socket (if available).
 181    */
 182   struct GNUNET_CLIENT_Connection *client;
 183
 184   /**
 185    * Currently pending transmission request.
 186    */
 187   struct GNUNET_CLIENT_TransmitHandle *th;
 188
 189   /**
 190    * Head of the linked list of pending actions (first action
 191    * to be performed).
 192    */
 193   struct GNUNET_STATISTICS_GetHandle *action_head;
 194
 195   /**
 196    * Tail of the linked list of actions (for fast append).
 197    */
 198   struct GNUNET_STATISTICS_GetHandle *action_tail;
 199
 200   /**
 201    * Action we are currently busy with (action request has been
 202    * transmitted, we're now receiving the response from the
 203    * service).
 204    */
 205   struct GNUNET_STATISTICS_GetHandle *current;
 206
 207   /**
 208    * Array of watch entries.
 209    */
 210   struct GNUNET_STATISTICS_WatchEntry **watches;
 211
 212   /**
 213    * Task doing exponential back-off trying to reconnect.
 214    */
 215   GNUNET_SCHEDULER_TaskIdentifier backoff_task;
 216
 217   /**
 218    * Time for next connect retry.
 219    */
 220   struct GNUNET_TIME_Relative backoff;
 221
 222   /**
 223    * Size of the 'watches' array.
 224    */
 225   unsigned int watches_size;
 226
 227   /**
 228    * Should this handle auto-destruct once all actions have
 229    * been processed?
 230    */
 231   int do_destroy;
 232
 233   /**
 234    * Are we currently receiving from the service?
 235    */
 236   int receiving;
 237
 238 };
 239
 240
 241
 242 /**
 243  * Schedule the next action to be performed.
 244  */
 245 static void schedule_action (struct GNUNET_STATISTICS_Handle *h);
 246
 247 /**
 248  * Try to (re)connect to the statistics service.
 249  *
 250  * @return GNUNET_YES on success, GNUNET_NO on failure.
 251  */
 252 static int
 253 try_connect (struct GNUNET_STATISTICS_Handle *ret);
 254
 255
 256 static void
 257 insert_ai (struct GNUNET_STATISTICS_Handle *h, struct GNUNET_STATISTICS_GetHandle *ai)
 258 {
 259   GNUNET_CONTAINER_DLL_insert_after (h->action_head,
 260                                      h->action_tail,
 261                                      h->action_tail,
 262                                      ai);
 263   if (h->action_head == ai)
 264     schedule_action (h);
 265 }
 266
 267
 268 static void
 269 schedule_watch_request (struct GNUNET_STATISTICS_Handle *h,
 270                         struct GNUNET_STATISTICS_WatchEntry *watch)
 271 {
 272
 273   struct GNUNET_STATISTICS_GetHandle *ai;
 274   size_t slen;
 275   size_t nlen;
 276   size_t nsize;
 277
 278   GNUNET_assert (h != NULL);
 279   if (GNUNET_YES != try_connect (h))
 280     {
 281       schedule_action (h);
 282       return;
 283     }
 284   slen = strlen (watch->subsystem) + 1;
 285   nlen = strlen (watch->name) + 1;
 286   nsize = sizeof (struct GNUNET_MessageHeader) + slen + nlen;
 287   if (nsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 288     {
 289       GNUNET_break (0);
 290       return;
 291     }
 292   ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
 293   ai->sh = h;
 294   ai->subsystem = GNUNET_strdup (watch->subsystem);
 295   ai->name = GNUNET_strdup (watch->name);
 296   ai->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
 297   ai->msize = nsize;
 298   ai->type = ACTION_WATCH;
 299   ai->proc = watch->proc;
 300   ai->cls = watch->proc_cls;
 301   insert_ai (h, ai);
 302 }
 303
 304
 305 /**
 306  * Try to (re)connect to the statistics service.
 307  *
 308  * @return GNUNET_YES on success, GNUNET_NO on failure.
 309  */
 310 static int
 311 try_connect (struct GNUNET_STATISTICS_Handle *ret)
 312 {
 313   unsigned int i;
 314   if (ret->client != NULL)
 315     return GNUNET_YES;
 316   ret->client = GNUNET_CLIENT_connect ("statistics", ret->cfg);
 317   if (ret->client != NULL)
 318     {
 319       for (i=0;i<ret->watches_size;i++)
 320         schedule_watch_request (ret, ret->watches[i]);
 321       return GNUNET_YES;
 322     }
 323 #if DEBUG_STATISTICS
 324   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 325               _("Failed to connect to statistics service!\n"));
 326 #endif
 327   return GNUNET_NO;
 328 }
 329
 330
 331 /**
 332  * Free memory associated with the given action item.
 333  */
 334 static void
 335 free_action_item (struct GNUNET_STATISTICS_GetHandle *ai)
 336 {
 337   GNUNET_free_non_null (ai->subsystem);
 338   GNUNET_free_non_null (ai->name);
 339   GNUNET_free (ai);
 340 }
 341
 342
 343 /**
 344  * GET processing is complete, tell client about it.
 345  */
 346 static void
 347 finish (struct GNUNET_STATISTICS_Handle *h, int code)
 348 {
 349   struct GNUNET_STATISTICS_GetHandle *pos = h->current;
 350   h->current = NULL;
 351   schedule_action (h);
 352   if (pos != NULL)
 353     {
 354       if (pos->cont != NULL)
 355         pos->cont (pos->cls, code);
 356       free_action_item (pos);
 357     }
 358 }
 359
 360
 361 /**
 362  * Process the message.
 363  *
 364  * @return GNUNET_OK if the message was well-formed
 365  */
 366 static int
 367 process_message (struct GNUNET_STATISTICS_Handle *h,
 368                  const struct GNUNET_MessageHeader *msg)
 369 {
 370   char *service;
 371   char *name;
 372   const struct GNUNET_STATISTICS_ReplyMessage *smsg;
 373   uint16_t size;
 374
 375   if (h->current->aborted)
 376     {
 377 #if DEBUG_STATISTICS
 378       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 379                   "Iteration was aborted, ignoring VALUE\n");
 380 #endif
 381       return GNUNET_OK;           /* don't bother */
 382     }
 383   size = ntohs (msg->size);
 384   if (size < sizeof (struct GNUNET_STATISTICS_ReplyMessage))
 385     {
 386       GNUNET_break (0);
 387       return GNUNET_SYSERR;
 388     }
 389   smsg = (const struct GNUNET_STATISTICS_ReplyMessage *) msg;
 390   size -= sizeof (struct GNUNET_STATISTICS_ReplyMessage);
 391   if (size != GNUNET_STRINGS_buffer_tokenize ((const char *) &smsg[1],
 392                                               size, 2, &service, &name))
 393     {
 394       GNUNET_break (0);
 395       return GNUNET_SYSERR;
 396     }
 397 #if DEBUG_STATISTICS
 398   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 399               "Received valid statistic on `%s:%s': %llu\n",
 400               service, name, GNUNET_ntohll (smsg->value));
 401 #endif
 402   if (GNUNET_OK !=
 403       h->current->proc (h->current->cls,
 404                         service,
 405                         name,
 406                         GNUNET_ntohll (smsg->value),
 407                         0 !=
 408                         (ntohl (smsg->uid) & GNUNET_STATISTICS_PERSIST_BIT)))
 409     {
 410 #if DEBUG_STATISTICS
 411       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 412                   "Processing of remaining statistics aborted by client.\n");
 413 #endif
 414       h->current->aborted = GNUNET_YES;
 415     }
 416 #if DEBUG_STATISTICS
 417   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 418               "VALUE processed successfully\n");
 419 #endif
 420   return GNUNET_OK;
 421 }
 422
 423
 424 static int
 425 process_watch_value (struct GNUNET_STATISTICS_Handle *h,
 426                      const struct GNUNET_MessageHeader *msg)
 427 {
 428   const struct GNUNET_STATISTICS_WatchValueMessage *wvm;
 429   struct GNUNET_STATISTICS_WatchEntry *w;
 430   uint32_t wid;
 431
 432   if (sizeof(struct GNUNET_STATISTICS_WatchValueMessage) !=
 433       ntohs (msg->size))
 434     {
 435       GNUNET_break (0);
 436       return GNUNET_SYSERR;
 437     }
 438   wvm = (const struct GNUNET_STATISTICS_WatchValueMessage *)msg;
 439   GNUNET_break (0 == ntohl (wvm->reserved));
 440   wid = ntohl (wvm->wid);
 441   if (wid >= h->watches_size)
 442     {
 443       GNUNET_break (0);
 444       return GNUNET_SYSERR;
 445     }
 446   w = h->watches[wid];
 447   (void) w->proc (w->proc_cls,
 448                   w->subsystem,
 449                   w->name,
 450                   GNUNET_ntohll (wvm->value),
 451                   0 !=
 452                   (ntohl (wvm->flags) & GNUNET_STATISTICS_PERSIST_BIT));
 453   return GNUNET_OK;
 454 }
 455
 456
 457 /**
 458  * Function called with messages from stats service.
 459  *
 460  * @param cls closure
 461  * @param msg message received, NULL on timeout or fatal error
 462  */
 463 static void
 464 receive_stats (void *cls, const struct GNUNET_MessageHeader *msg)
 465 {
 466   struct GNUNET_STATISTICS_Handle *h = cls;
 467
 468   if (msg == NULL)
 469     {
 470       if (NULL != h->client)
 471         {
 472           GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
 473           h->client = NULL;
 474         }
 475 #if DEBUG_STATISTICS
 476       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 477                   "Error receiving statistics from service, is the service running?\n" );
 478 #endif
 479       finish (h, GNUNET_SYSERR);
 480       return;
 481     }
 482   switch (ntohs (msg->type))
 483     {
 484     case GNUNET_MESSAGE_TYPE_STATISTICS_END:
 485 #if DEBUG_STATISTICS
 486       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 487                   "Received end of statistics marker\n");
 488 #endif
 489       h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 490       if (h->watches_size > 0)
 491         {
 492           GNUNET_CLIENT_receive (h->client,
 493                                  &receive_stats,
 494                                  h,
 495                                  GNUNET_TIME_UNIT_FOREVER_REL);
 496         }
 497       else
 498         {
 499           h->receiving = GNUNET_NO;
 500         }
 501       finish (h, GNUNET_OK);
 502       return;
 503     case GNUNET_MESSAGE_TYPE_STATISTICS_VALUE:
 504       if (GNUNET_OK == process_message (h, msg))
 505         {
 506           /* finally, look for more! */
 507 #if DEBUG_STATISTICS
 508           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 509                       "Processing VALUE done, now reading more\n");
 510 #endif
 511           GNUNET_CLIENT_receive (h->client,
 512                                  &receive_stats,
 513                                  h,
 514                                  GNUNET_TIME_absolute_get_remaining
 515                                  (h->current->timeout));
 516           h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 517           return;
 518         }
 519       GNUNET_break (0);
 520       break;
 521     case GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE:
 522       if (GNUNET_OK ==
 523           process_watch_value (h,
 524                                msg))
 525         {
 526           h->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 527           GNUNET_assert (h->watches_size > 0);
 528           GNUNET_CLIENT_receive (h->client,
 529                                  &receive_stats,
 530                                  h,
 531                                  GNUNET_TIME_UNIT_FOREVER_REL);
 532           return;
 533         }
 534       GNUNET_break (0);
 535       break;
 536     default:
 537       GNUNET_break (0);
 538       break;
 539     }
 540   if (NULL != h->client)
 541     {
 542       GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
 543       h->client = NULL;
 544     }
 545   finish (h, GNUNET_SYSERR);
 546 }
 547
 548
 549 /**
 550  * Transmit a GET request (and if successful, start to receive
 551  * the response).
 552  */
 553 static size_t
 554 transmit_get (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
 555 {
 556   struct GNUNET_MessageHeader *hdr;
 557   size_t slen1;
 558   size_t slen2;
 559   uint16_t msize;
 560
 561   if (buf == NULL)
 562     {
 563       /* timeout / error */
 564 #if DEBUG_STATISTICS
 565       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 566                   "Transmission of request for statistics failed!\n");
 567 #endif
 568       finish (handle, GNUNET_SYSERR);
 569       return 0;
 570     }
 571   slen1 = strlen (handle->current->subsystem) + 1;
 572   slen2 = strlen (handle->current->name) + 1;
 573   msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
 574   GNUNET_assert (msize <= size);
 575   hdr = (struct GNUNET_MessageHeader *) buf;
 576   hdr->size = htons (msize);
 577   hdr->type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_GET);
 578   GNUNET_assert (slen1 + slen2 ==
 579                  GNUNET_STRINGS_buffer_fill ((char *) &hdr[1],
 580                                              slen1 + slen2,
 581                                              2,
 582                                              handle->current->subsystem,
 583                                              handle->current->name));
 584   if (! handle->receiving)
 585     {
 586 #if DEBUG_STATISTICS
 587       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 588                   "Transmission of GET done, now reading response\n");
 589 #endif
 590       handle->receiving = GNUNET_YES;
 591       GNUNET_CLIENT_receive (handle->client,
 592                              &receive_stats,
 593                              handle,
 594                              GNUNET_TIME_absolute_get_remaining (handle->
 595                                                                  current->timeout));
 596     }
 597   return msize;
 598 }
 599
 600
 601 /**
 602  * Transmit a WATCH request (and if successful, start to receive
 603  * the response).
 604  */
 605 static size_t
 606 transmit_watch (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
 607 {
 608   struct GNUNET_MessageHeader *hdr;
 609   size_t slen1;
 610   size_t slen2;
 611   uint16_t msize;
 612
 613   if (buf == NULL)
 614     {
 615       /* timeout / error */
 616 #if DEBUG_STATISTICS
 617       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 618                   "Transmission of request for statistics failed!\n");
 619 #endif
 620       finish (handle, GNUNET_SYSERR);
 621       return 0;
 622     }
 623 #if DEBUG_STATISTICS
 624   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 625               "Transmitting watch request for `%s'\n",
 626               handle->current->name);
 627 #endif
 628   slen1 = strlen (handle->current->subsystem) + 1;
 629   slen2 = strlen (handle->current->name) + 1;
 630   msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
 631   GNUNET_assert (msize <= size);
 632   hdr = (struct GNUNET_MessageHeader *) buf;
 633   hdr->size = htons (msize);
 634   hdr->type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_WATCH);
 635   GNUNET_assert (slen1 + slen2 ==
 636                  GNUNET_STRINGS_buffer_fill ((char *) &hdr[1],
 637                                              slen1 + slen2,
 638                                              2,
 639                                              handle->current->subsystem,
 640                                              handle->current->name));
 641   if (GNUNET_YES != handle->receiving)
 642     {
 643       handle->receiving = GNUNET_YES;
 644       GNUNET_CLIENT_receive (handle->client,
 645                              &receive_stats,
 646                              handle,
 647                              GNUNET_TIME_UNIT_FOREVER_REL);
 648     }
 649   finish (handle, GNUNET_OK);
 650   return msize;
 651 }
 652
 653
 654 /**
 655  * Transmit a SET/UPDATE request.
 656  */
 657 static size_t
 658 transmit_set (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
 659 {
 660   struct GNUNET_STATISTICS_SetMessage *r;
 661   size_t slen;
 662   size_t nlen;
 663   size_t nsize;
 664
 665   if (NULL == buf)
 666     {
 667       finish (handle, GNUNET_SYSERR);
 668       return 0;
 669     }
 670
 671   slen = strlen (handle->current->subsystem) + 1;
 672   nlen = strlen (handle->current->name) + 1;
 673   nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
 674   if (size < nsize)
 675     {
 676       GNUNET_break (0);
 677       finish (handle, GNUNET_SYSERR);
 678       return 0;
 679     }
 680   r = buf;
 681   r->header.size = htons (nsize);
 682   r->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_SET);
 683   r->flags = 0;
 684   r->value = GNUNET_htonll (handle->current->value);
 685   if (handle->current->make_persistent)
 686     r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_PERSISTENT);
 687   if (handle->current->type == ACTION_UPDATE)
 688     r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_RELATIVE);
 689   GNUNET_assert (slen + nlen ==
 690                  GNUNET_STRINGS_buffer_fill ((char *) &r[1],
 691                                              slen + nlen,
 692                                              2,
 693                                              handle->current->subsystem,
 694                                              handle->current->name));
 695   finish (handle, GNUNET_OK);
 696   return nsize;
 697 }
 698
 699
 700 static size_t
 701 transmit_action (void *cls, size_t size, void *buf)
 702 {
 703   struct GNUNET_STATISTICS_Handle *handle = cls;
 704   size_t ret;
 705
 706   handle->th = NULL;
 707   switch (handle->current->type)
 708     {
 709     case ACTION_GET:
 710       ret = transmit_get (handle, size, buf);
 711       break;
 712     case ACTION_SET:
 713     case ACTION_UPDATE:
 714       ret = transmit_set (handle, size, buf);
 715       break;
 716     case ACTION_WATCH:
 717       ret = transmit_watch (handle, size, buf);
 718       break;
 719     default:
 720       ret = 0;
 721       GNUNET_break (0);
 722       break;
 723     }
 724   return ret;
 725 }
 726
 727
 728 /**
 729  * Get handle for the statistics service.
 730  *
 731  * @param subsystem name of subsystem using the service
 732  * @param cfg services configuration in use
 733  * @return handle to use
 734  */
 735 struct GNUNET_STATISTICS_Handle *
 736 GNUNET_STATISTICS_create (const char *subsystem,
 737                           const struct GNUNET_CONFIGURATION_Handle *cfg)
 738 {
 739   struct GNUNET_STATISTICS_Handle *ret;
 740
 741   GNUNET_assert (subsystem != NULL);
 742   GNUNET_assert (cfg != NULL);
 743   ret = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_Handle));
 744   ret->cfg = cfg;
 745   ret->subsystem = GNUNET_strdup (subsystem);
 746   ret->backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 747   if (GNUNET_YES != try_connect (ret))
 748     {
 749       GNUNET_free (ret->subsystem);
 750       GNUNET_free (ret);
 751       return NULL;
 752     }
 753   return ret;
 754 }
 755
 756
 757 /**
 758  * Destroy a handle (free all state associated with
 759  * it).
 760  *
 761  * @param h statistics handle to destroy
 762  * @param sync_first set to GNUNET_YES if pending SET requests should
 763  *        be completed
 764  */
 765 void
 766 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *h,
 767                            int sync_first)
 768 {
 769   struct GNUNET_STATISTICS_GetHandle *pos;
 770   struct GNUNET_STATISTICS_GetHandle *next;
 771   struct GNUNET_STATISTICS_GetHandle *prev;
 772   struct GNUNET_TIME_Relative timeout;
 773   int i;
 774
 775   if (h == NULL)
 776     return;
 777   if (GNUNET_SCHEDULER_NO_TASK != h->backoff_task)
 778     GNUNET_SCHEDULER_cancel (h->backoff_task);
 779   if (sync_first)
 780     {
 781       if (h->current != NULL)
 782         {
 783           if (h->current->type == ACTION_GET)
 784             {
 785               GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 786               h->th = NULL;
 787               free_action_item (h->current);
 788               h->current = NULL;
 789             }
 790         }
 791       pos = h->action_head;
 792       prev = NULL;
 793       while (pos != NULL)
 794         {
 795           next = pos->next;
 796           if (pos->type == ACTION_GET)
 797             {
 798               if (prev == NULL)
 799                 h->action_head = next;
 800               else
 801                 prev->next = next;
 802               free_action_item (pos);
 803             }
 804           else
 805             {
 806               prev = pos;
 807             }
 808           pos = next;
 809         }
 810       h->action_tail = prev;
 811       if (h->current == NULL)
 812         {
 813           h->current = h->action_head;
 814           if (h->action_head != NULL)
 815             {
 816               h->action_head = h->action_head->next;
 817               if (h->action_head == NULL)
 818                 h->action_tail = NULL;
 819             }
 820         }
 821       h->do_destroy = GNUNET_YES;
 822       if ( (h->current != NULL) &&
 823            (h->th == NULL) )
 824         {
 825           timeout = GNUNET_TIME_absolute_get_remaining (h->current->timeout);
 826           h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
 827                                                        h->current->msize,
 828                                                        timeout,
 829                                                        GNUNET_YES,
 830                                                        &transmit_action, h);
 831           GNUNET_assert (NULL != h->th);
 832         }
 833       if (h->th != NULL)
 834         return;
 835     }
 836   if (NULL != h->th)
 837     {
 838       GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 839       h->th = NULL;
 840     }
 841   if (h->current != NULL)
 842     free_action_item (h->current);
 843   while (NULL != (pos = h->action_head))
 844     {
 845       h->action_head = pos->next;
 846       free_action_item (pos);
 847     }
 848   if (h->client != NULL)
 849     {
 850       GNUNET_CLIENT_disconnect (h->client, GNUNET_YES);
 851       h->client = NULL;
 852     }
 853   for (i=0;i<h->watches_size;i++)
 854     {
 855       GNUNET_free (h->watches[i]->subsystem);
 856       GNUNET_free (h->watches[i]->name);
 857       GNUNET_free (h->watches[i]);
 858     }
 859   GNUNET_array_grow (h->watches,
 860                      h->watches_size,
 861                      0);
 862   GNUNET_free (h->subsystem);
 863   GNUNET_free (h);
 864 }
 865
 866
 867 static void
 868 finish_task (void *cls,
 869              const struct GNUNET_SCHEDULER_TaskContext *tc)
 870 {
 871   struct GNUNET_STATISTICS_Handle *h = cls;
 872
 873   h->backoff_task = GNUNET_SCHEDULER_NO_TASK;
 874   finish (h, GNUNET_SYSERR);
 875 }
 876
 877
 878 /**
 879  * Schedule the next action to be performed.
 880  */
 881 static void
 882 schedule_action (struct GNUNET_STATISTICS_Handle *h)
 883 {
 884   struct GNUNET_TIME_Relative timeout;
 885
 886   if (h->current != NULL)
 887     return;                     /* action already pending */
 888   if (GNUNET_YES != try_connect (h))
 889     {
 890       h->backoff_task = GNUNET_SCHEDULER_add_delayed (h->backoff,
 891                                                       &finish_task,
 892                                                       h);
 893       h->backoff = GNUNET_TIME_relative_multiply (h->backoff, 2);
 894       h->backoff = GNUNET_TIME_relative_min (h->backoff,
 895                                              GNUNET_CONSTANTS_SERVICE_TIMEOUT);
 896       return;
 897     }
 898
 899   /* schedule next action */
 900   h->current = h->action_head;
 901   if (NULL == h->current)
 902     {
 903       if (h->do_destroy)
 904         {
 905           h->do_destroy = GNUNET_NO;
 906           GNUNET_STATISTICS_destroy (h, GNUNET_YES);
 907         }
 908       return;
 909     }
 910   GNUNET_CONTAINER_DLL_remove (h->action_head,
 911                                h->action_tail,
 912                                h->current);
 913   timeout = GNUNET_TIME_absolute_get_remaining (h->current->timeout);
 914   if (NULL ==
 915       (h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
 916                                                     h->current->msize,
 917                                                     timeout,
 918                                                     GNUNET_YES,
 919                                                     &transmit_action, h)))
 920     {
 921 #if DEBUG_STATISTICS
 922       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 923                   "Failed to transmit request to statistics service.\n");
 924 #endif
 925       finish (h, GNUNET_SYSERR);
 926     }
 927 }
 928
 929
 930 /**
 931  * Get statistic from the peer.
 932  *
 933  * @param handle identification of the statistics service
 934  * @param subsystem limit to the specified subsystem, NULL for our subsystem
 935  * @param name name of the statistic value, NULL for all values
 936  * @param timeout after how long should we give up (and call
 937  *        cont with an error code)?
 938  * @param cont continuation to call when done (can be NULL)
 939  * @param proc function to call on each value
 940  * @param cls closure for cont and proc
 941  * @return NULL on error
 942  */
 943 struct GNUNET_STATISTICS_GetHandle *
 944 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
 945                        const char *subsystem,
 946                        const char *name,
 947                        struct GNUNET_TIME_Relative timeout,
 948                        GNUNET_STATISTICS_Callback cont,
 949                        GNUNET_STATISTICS_Iterator proc, void *cls)
 950 {
 951   size_t slen1;
 952   size_t slen2;
 953   struct GNUNET_STATISTICS_GetHandle *ai;
 954
 955   GNUNET_assert (handle != NULL);
 956   GNUNET_assert (proc != NULL);
 957   GNUNET_assert (GNUNET_NO == handle->do_destroy);
 958   if (GNUNET_YES != try_connect (handle))
 959     {
 960 #if DEBUG_STATISTICS
 961       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 962                   "Failed to connect to statistics service, can not get value `%s:%s'.\n",
 963                   strlen (subsystem) ? subsystem : "*",
 964                   strlen (name) ? name : "*");
 965 #endif
 966       return NULL;
 967     }
 968   if (subsystem == NULL)
 969     subsystem = "";
 970   if (name == NULL)
 971     name = "";
 972   slen1 = strlen (subsystem) + 1;
 973   slen2 = strlen (name) + 1;
 974   GNUNET_assert (slen1 + slen2 + sizeof (struct GNUNET_MessageHeader) <
 975                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
 976   ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
 977   ai->sh = handle;
 978   ai->subsystem = GNUNET_strdup (subsystem);
 979   ai->name = GNUNET_strdup (name);
 980   ai->cont = cont;
 981   ai->proc = proc;
 982   ai->cls = cls;
 983   ai->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 984   ai->type = ACTION_GET;
 985   ai->msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
 986   insert_ai (handle, ai);
 987   return ai;
 988 }
 989
 990
 991 /**
 992  * Cancel a 'get' request.  Must be called before the 'cont'
 993  * function is called.
 994  *
 995  * @param gh handle of the request to cancel
 996  */
 997 void
 998 GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh)
 999 {
1000   if (gh->sh->current == gh)
1001     {
1002       gh->aborted = GNUNET_YES;
1003     }
1004   else
1005     {
1006       GNUNET_CONTAINER_DLL_remove (gh->sh->action_head,
1007                                    gh->sh->action_tail,
1008                                    gh);
1009       GNUNET_free (gh->name);
1010       GNUNET_free (gh->subsystem);
1011       GNUNET_free (gh);
1012     }
1013 }
1014
1015
1016 /**
1017  * Watch statistics from the peer (be notified whenever they change).
1018  * Note that the only way to cancel a "watch" request is to destroy
1019  * the statistics handle given as the first argument to this call.
1020  *
1021  * @param handle identification of the statistics service
1022  * @param subsystem limit to the specified subsystem, never NULL
1023  * @param name name of the statistic value, never NULL
1024  * @param proc function to call on each value
1025  * @param proc_cls closure for proc
1026  * @return GNUNET_OK on success, GNUNET_SYSERR on error
1027  */
1028 int
1029 GNUNET_STATISTICS_watch (struct GNUNET_STATISTICS_Handle *handle,
1030                          const char *subsystem,
1031                          const char *name,
1032                          GNUNET_STATISTICS_Iterator proc,
1033                          void *proc_cls)
1034 {
1035   struct GNUNET_STATISTICS_WatchEntry *w;
1036
1037   if (handle == NULL)
1038     return GNUNET_SYSERR;
1039   w = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_WatchEntry));
1040   w->subsystem = GNUNET_strdup (subsystem);
1041   w->name = GNUNET_strdup (name);
1042   w->proc = proc;
1043   w->proc_cls = proc_cls;
1044   GNUNET_array_append (handle->watches,
1045                        handle->watches_size,
1046                        w);
1047   schedule_watch_request (handle, w);
1048   return GNUNET_OK;
1049 }
1050
1051
1052 static void
1053 add_setter_action (struct GNUNET_STATISTICS_Handle *h,
1054                    const char *name,
1055                    int make_persistent,
1056                    uint64_t value, enum ActionType type)
1057 {
1058   struct GNUNET_STATISTICS_GetHandle *ai;
1059   size_t slen;
1060   size_t nlen;
1061   size_t nsize;
1062   int64_t delta;
1063
1064   GNUNET_assert (h != NULL);
1065   GNUNET_assert (name != NULL);
1066   if (GNUNET_YES != try_connect (h))
1067     return;
1068   slen = strlen (h->subsystem) + 1;
1069   nlen = strlen (name) + 1;
1070   nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
1071   if (nsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
1072     {
1073       GNUNET_break (0);
1074       return;
1075     }
1076   ai = h->action_head;
1077   while (ai != NULL)
1078     {
1079       if ( (0 == strcmp (ai->subsystem, h->subsystem)) &&
1080            (0 == strcmp (ai->name, name)) &&
1081            ( (ai->type == ACTION_UPDATE) ||
1082              (ai->type == ACTION_SET) ) )
1083         {
1084           if (ai->type == ACTION_SET)
1085             {
1086               if (type == ACTION_UPDATE)
1087                 {
1088                   delta = (int64_t) value;
1089                   if (delta > 0)
1090                     {
1091                       ai->value += delta;
1092                     }
1093                   else
1094                     {
1095                       if (ai->value < -delta)
1096                         ai->value = 0;
1097                       else
1098                         ai->value += delta;
1099                     }
1100                 }
1101               else
1102                 {
1103                   ai->value = value;
1104                 }
1105             }
1106           else
1107             {
1108               if (type == ACTION_UPDATE)
1109                 {
1110                   delta = (int64_t) value;
1111                   ai->value += delta;
1112                 }
1113               else
1114                 {
1115                   ai->value = value;
1116                   ai->type = type;
1117                 }
1118             }
1119           ai->timeout = GNUNET_TIME_relative_to_absolute (SET_TRANSMIT_TIMEOUT);
1120           ai->make_persistent = make_persistent;
1121           return;
1122         }
1123       ai = ai->next;
1124     }
1125   ai = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_GetHandle));
1126   ai->sh = h;
1127   ai->subsystem = GNUNET_strdup (h->subsystem);
1128   ai->name = GNUNET_strdup (name);
1129   ai->timeout = GNUNET_TIME_relative_to_absolute (SET_TRANSMIT_TIMEOUT);
1130   ai->make_persistent = make_persistent;
1131   ai->msize = nsize;
1132   ai->value = value;
1133   ai->type = type;
1134   insert_ai (h, ai);
1135 }
1136
1137
1138 /**
1139  * Set statistic value for the peer.  Will always use our
1140  * subsystem (the argument used when "handle" was created).
1141  *
1142  * @param handle identification of the statistics service
1143  * @param name name of the statistic value
1144  * @param value new value to set
1145  * @param make_persistent should the value be kept across restarts?
1146  */
1147 void
1148 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
1149                        const char *name,
1150                        uint64_t value, int make_persistent)
1151 {
1152   if (handle == NULL)
1153     return;
1154   GNUNET_assert (GNUNET_NO == handle->do_destroy);
1155   add_setter_action (handle, name, make_persistent, value, ACTION_SET);
1156 }
1157
1158
1159 /**
1160  * Set statistic value for the peer.  Will always use our
1161  * subsystem (the argument used when "handle" was created).
1162  *
1163  * @param handle identification of the statistics service
1164  * @param name name of the statistic value
1165  * @param delta change in value (added to existing value)
1166  * @param make_persistent should the value be kept across restarts?
1167  */
1168 void
1169 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
1170                           const char *name,
1171                           int64_t delta, int make_persistent)
1172 {
1173   if (handle == NULL)
1174     return;
1175   if (delta == 0)
1176     return;
1177   GNUNET_assert (GNUNET_NO == handle->do_destroy);
1178   add_setter_action (handle, name, make_persistent,
1179                      (uint64_t) delta, ACTION_UPDATE);
1180 }
1181
1182
1183 /* end of statistics_api.c */