src/statistics/statistics_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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_protocols.h"
  29 #include "gnunet_server_lib.h"
  30 #include "gnunet_statistics_service.h"
  31 #include "gnunet_strings_lib.h"
  32 #include "statistics.h"
  33
  34 #define SET_TRANSMIT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  35
  36
  37 /**
  38  * Types of actions.
  39  */
  40 enum ActionType
  41 {
  42   ACTION_GET,
  43   ACTION_SET,
  44   ACTION_UPDATE
  45 };
  46
  47
  48 /**
  49  * Linked list of things we still need to do.
  50  */
  51 struct ActionItem
  52 {
  53   /**
  54    * This is a linked list.
  55    */
  56   struct ActionItem *next;
  57
  58   /**
  59    * What subsystem is this action about? (can be NULL)
  60    */
  61   char *subsystem;
  62
  63   /**
  64    * What value is this action about? (can be NULL)
  65    */
  66   char *name;
  67
  68   /**
  69    * Continuation to call once action is complete.
  70    */
  71   GNUNET_STATISTICS_Callback cont;
  72
  73   /**
  74    * Function to call (for GET actions only).
  75    */
  76   GNUNET_STATISTICS_Iterator proc;
  77
  78   /**
  79    * Closure for proc and cont.
  80    */
  81   void *cls;
  82
  83   /**
  84    * Timeout for this action.
  85    */
  86   struct GNUNET_TIME_Absolute timeout;
  87
  88   /**
  89    * Associated value.
  90    */
  91   unsigned long long value;
  92
  93   /**
  94    * Flag for SET/UPDATE actions.
  95    */
  96   int make_persistent;
  97
  98   /**
  99    * Has the current iteration been aborted; for GET actions.
 100    */
 101   int aborted;
 102
 103   /**
 104    * Is this a GET, SET or UPDATE?
 105    */
 106   enum ActionType type;
 107
 108   /**
 109    * Size of the message that we will be transmitting.
 110    */
 111   uint16_t msize;
 112
 113 };
 114
 115
 116 /**
 117  * Handle for the service.
 118  */
 119 struct GNUNET_STATISTICS_Handle
 120 {
 121   /**
 122    * Our scheduler.
 123    */
 124   struct GNUNET_SCHEDULER_Handle *sched;
 125
 126   /**
 127    * Name of our subsystem.
 128    */
 129   char *subsystem;
 130
 131   /**
 132    * Configuration to use.
 133    */
 134   struct GNUNET_CONFIGURATION_Handle *cfg;
 135
 136   /**
 137    * Socket (if available).
 138    */
 139   struct GNUNET_CLIENT_Connection *client;
 140
 141   /**
 142    * Head of the linked list of pending actions (first action
 143    * to be performed).
 144    */
 145   struct ActionItem *action_head;
 146
 147   /**
 148    * Tail of the linked list of actions (for fast append).
 149    */
 150   struct ActionItem *action_tail;
 151
 152   /**
 153    * Action we are currently busy with (action request has been
 154    * transmitted, we're now receiving the response from the
 155    * service).
 156    */
 157   struct ActionItem *current;
 158
 159   /**
 160    * Should this handle be destroyed once we've processed
 161    * all actions?
 162    */
 163   int do_destroy;
 164
 165 };
 166
 167
 168 /**
 169  * Try to (re)connect to the statistics service.
 170  *
 171  * @return GNUNET_YES on success, GNUNET_NO on failure.
 172  */
 173 static int
 174 try_connect (struct GNUNET_STATISTICS_Handle *ret)
 175 {
 176   if (ret->client != NULL)
 177     return GNUNET_OK;
 178   ret->client = GNUNET_CLIENT_connect (ret->sched, "statistics", ret->cfg);
 179   if (ret->client != NULL)
 180     return GNUNET_YES;
 181   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 182               _("Failed to connect to statistics service!\n"));
 183   return GNUNET_NO;
 184 }
 185
 186
 187 /**
 188  * Free memory associated with the given action item.
 189  */
 190 static void
 191 free_action_item (struct ActionItem *ai)
 192 {
 193   GNUNET_free_non_null (ai->subsystem);
 194   GNUNET_free_non_null (ai->name);
 195   GNUNET_free (ai);
 196 }
 197
 198
 199 /**
 200  * Get handle for the statistics service.
 201  *
 202  * @param subsystem name of subsystem using the service
 203  * @param cfg services configuration in use
 204  * @return handle to use
 205  */
 206 struct GNUNET_STATISTICS_Handle *
 207 GNUNET_STATISTICS_create (struct GNUNET_SCHEDULER_Handle *sched,
 208                           const char *subsystem,
 209                           struct GNUNET_CONFIGURATION_Handle *cfg)
 210 {
 211   struct GNUNET_STATISTICS_Handle *ret;
 212
 213   GNUNET_assert (subsystem != NULL);
 214   GNUNET_assert (sched != NULL);
 215   GNUNET_assert (cfg != NULL);
 216   ret = GNUNET_malloc (sizeof (struct GNUNET_STATISTICS_Handle));
 217   ret->sched = sched;
 218   ret->cfg = cfg;
 219   ret->subsystem = GNUNET_strdup (subsystem);
 220   try_connect (ret);
 221   return ret;
 222 }
 223
 224
 225 /**
 226  * Actually free the handle.
 227  */
 228 static void
 229 do_destroy (struct GNUNET_STATISTICS_Handle *h)
 230 {
 231   GNUNET_assert (h->action_head == NULL);
 232   GNUNET_assert (h->current == NULL);
 233   if (h->client != NULL)
 234     {
 235       GNUNET_CLIENT_disconnect (h->client);
 236       h->client = NULL;
 237     }
 238   GNUNET_free (h->subsystem);
 239   GNUNET_free (h);
 240 }
 241
 242
 243 /**
 244  * Destroy a handle (free all state associated with
 245  * it).
 246  */
 247 void
 248 GNUNET_STATISTICS_destroy (struct GNUNET_STATISTICS_Handle *handle)
 249 {
 250   GNUNET_assert (handle->do_destroy == GNUNET_NO);
 251   if ((handle->action_head != NULL) || (handle->current != NULL))
 252     {
 253       handle->do_destroy = GNUNET_YES;
 254       return;
 255     }
 256   do_destroy (handle);
 257 }
 258
 259
 260 /**
 261  * Process the message.
 262  *
 263  * @return GNUNET_OK if the message was well-formed
 264  */
 265 static int
 266 process_message (struct GNUNET_STATISTICS_Handle *h,
 267                  const struct GNUNET_MessageHeader *msg)
 268 {
 269   char *service;
 270   char *name;
 271   const struct GNUNET_STATISTICS_ReplyMessage *smsg;
 272   uint16_t size;
 273
 274   if (h->current->aborted)
 275     return GNUNET_OK;           /* don't bother */
 276   size = ntohs (msg->size);
 277   if (size < sizeof (struct GNUNET_STATISTICS_ReplyMessage))
 278     {
 279       GNUNET_break (0);
 280       return GNUNET_SYSERR;
 281     }
 282   smsg = (const struct GNUNET_STATISTICS_ReplyMessage *) msg;
 283   size -= sizeof (struct GNUNET_STATISTICS_ReplyMessage);
 284   if (size != GNUNET_STRINGS_buffer_tokenize ((const char *) &smsg[1],
 285                                               size, 2, &service, &name))
 286     {
 287       GNUNET_break (0);
 288       return GNUNET_SYSERR;
 289     }
 290 #if DEBUG_STATISTICS
 291   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 292               "Received valid statistic on `%s:%s': %llu\n",
 293               service, name, GNUNET_ntohll (smsg->value));
 294 #endif
 295   if (GNUNET_OK !=
 296       h->current->proc (h->current->cls,
 297                         service,
 298                         name,
 299                         GNUNET_ntohll (smsg->value),
 300                         0 !=
 301                         (ntohl (smsg->uid) & GNUNET_STATISTICS_PERSIST_BIT)))
 302     {
 303 #if DEBUG_STATISTICS
 304       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 305                   "Processing of remaining statistics aborted by client.\n");
 306 #endif
 307       h->current->aborted = GNUNET_YES;
 308     }
 309   return GNUNET_OK;
 310 }
 311
 312
 313
 314 /**
 315  * Schedule the next action to be performed.
 316  */
 317 static void schedule_action (struct GNUNET_STATISTICS_Handle *h);
 318
 319
 320 /**
 321  * GET processing is complete, tell client about it.
 322  */
 323 static void
 324 finish (struct GNUNET_STATISTICS_Handle *h, int code)
 325 {
 326   struct ActionItem *pos = h->current;
 327   h->current = NULL;
 328   schedule_action (h);
 329   if (pos->cont != NULL)
 330     pos->cont (pos->cls, code);
 331   free_action_item (pos);
 332 }
 333
 334
 335 /**
 336  * Function called with messages from stats service.
 337  *
 338  * @param cls closure
 339  * @param msg message received, NULL on timeout or fatal error
 340  */
 341 static void
 342 receive_stats (void *cls, const struct GNUNET_MessageHeader *msg)
 343 {
 344   struct GNUNET_STATISTICS_Handle *h = cls;
 345
 346   if (msg == NULL)
 347     {
 348       GNUNET_CLIENT_disconnect (h->client);
 349       h->client = NULL;
 350       GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
 351                   _
 352                   ("Error receiving statistics from service, is the service running?\n"));
 353       finish (h, GNUNET_SYSERR);
 354       return;
 355     }
 356   switch (ntohs (msg->type))
 357     {
 358     case GNUNET_MESSAGE_TYPE_STATISTICS_END:
 359 #if DEBUG_STATISTICS
 360       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 361                   "Received end of statistics marker\n");
 362 #endif
 363       finish (h, GNUNET_OK);
 364       return;
 365     case GNUNET_MESSAGE_TYPE_STATISTICS_VALUE:
 366       if (GNUNET_OK == process_message (h, msg))
 367         {
 368           /* finally, look for more! */
 369           GNUNET_CLIENT_receive (h->client,
 370                                  &receive_stats,
 371                                  h,
 372                                  GNUNET_TIME_absolute_get_remaining
 373                                  (h->current->timeout));
 374           return;
 375         }
 376       GNUNET_break (0);
 377       break;
 378     default:
 379       GNUNET_break (0);
 380       break;
 381     }
 382   GNUNET_CLIENT_disconnect (h->client);
 383   h->client = NULL;
 384   finish (h, GNUNET_SYSERR);
 385 }
 386
 387
 388 /**
 389  * Transmit a GET request (and if successful, start to receive
 390  * the response).
 391  */
 392 static size_t
 393 transmit_get (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
 394 {
 395   struct GNUNET_MessageHeader *hdr;
 396   size_t slen1;
 397   size_t slen2;
 398   uint16_t msize;
 399
 400   if (buf == NULL)
 401     {
 402       /* timeout / error */
 403       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 404                   _("Transmission of request for statistics failed!\n"));
 405       finish (handle, GNUNET_SYSERR);
 406       return 0;
 407     }
 408   slen1 = strlen (handle->current->subsystem) + 1;
 409   slen2 = strlen (handle->current->name) + 1;
 410   msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
 411   GNUNET_assert (msize <= size);
 412   hdr = (struct GNUNET_MessageHeader *) buf;
 413   hdr->size = htons (msize);
 414   hdr->type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_GET);
 415   GNUNET_assert (slen1 + slen2 ==
 416                  GNUNET_STRINGS_buffer_fill ((char *) &hdr[1],
 417                                              slen1 + slen2,
 418                                              2,
 419                                              handle->current->subsystem,
 420                                              handle->current->name));
 421   GNUNET_CLIENT_receive (handle->client,
 422                          &receive_stats,
 423                          handle,
 424                          GNUNET_TIME_absolute_get_remaining (handle->
 425                                                              current->timeout));
 426   return msize;
 427 }
 428
 429
 430
 431 /**
 432  * Transmit a SET/UPDATE request.
 433  */
 434 static size_t
 435 transmit_set (struct GNUNET_STATISTICS_Handle *handle, size_t size, void *buf)
 436 {
 437   struct GNUNET_STATISTICS_SetMessage *r;
 438   size_t slen;
 439   size_t nlen;
 440   size_t nsize;
 441
 442   if (NULL == buf)
 443     {
 444       finish (handle, GNUNET_SYSERR);
 445       return 0;
 446     }
 447
 448   slen = strlen (handle->current->subsystem) + 1;
 449   nlen = strlen (handle->current->name) + 1;
 450   nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
 451   if (size < nsize)
 452     {
 453       GNUNET_break (0);
 454       finish (handle, GNUNET_SYSERR);
 455       return 0;
 456     }
 457   r = buf;
 458   r->header.size = htons (nsize);
 459   r->header.type = htons (GNUNET_MESSAGE_TYPE_STATISTICS_SET);
 460   r->flags = 0;
 461   r->value = GNUNET_htonll (handle->current->value);
 462   if (handle->current->make_persistent)
 463     r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_PERSISTENT);
 464   if (handle->current->type == ACTION_UPDATE)
 465     r->flags |= htonl (GNUNET_STATISTICS_SETFLAG_RELATIVE);
 466   GNUNET_assert (slen + nlen ==
 467                  GNUNET_STRINGS_buffer_fill ((char *) &r[1],
 468                                              slen + nlen,
 469                                              2,
 470                                              handle->current->subsystem,
 471                                              handle->current->name));
 472   finish (handle, GNUNET_OK);
 473   return nsize;
 474 }
 475
 476
 477 static size_t
 478 transmit_action (void *cls, size_t size, void *buf)
 479 {
 480   struct GNUNET_STATISTICS_Handle *handle = cls;
 481   size_t ret;
 482
 483   switch (handle->current->type)
 484     {
 485     case ACTION_GET:
 486       ret = transmit_get (handle, size, buf);
 487       break;
 488     case ACTION_SET:
 489     case ACTION_UPDATE:
 490       ret = transmit_set (handle, size, buf);
 491       break;
 492     }
 493   return ret;
 494 }
 495
 496
 497 /**
 498  * Schedule the next action to be performed.
 499  */
 500 static void
 501 schedule_action (struct GNUNET_STATISTICS_Handle *h)
 502 {
 503   struct GNUNET_TIME_Relative timeout;
 504
 505   if (h->current != NULL)
 506     return;                     /* action already pending */
 507   if (GNUNET_YES != try_connect (h))
 508     {
 509       finish (h, GNUNET_SYSERR);
 510       return;
 511     }
 512
 513   /* schedule next action */
 514   h->current = h->action_head;
 515   if (NULL == h->current)
 516     {
 517       /* no pending network action, check destroy! */
 518       if (h->do_destroy != GNUNET_YES)
 519         return;
 520       do_destroy (h);
 521       return;
 522     }
 523   h->action_head = h->action_head->next;
 524   if (NULL == h->action_head)
 525     h->action_tail = NULL;
 526   h->current->next = NULL;
 527
 528   timeout = GNUNET_TIME_absolute_get_remaining (h->current->timeout);
 529   if (NULL ==
 530       GNUNET_CLIENT_notify_transmit_ready (h->client,
 531                                            h->current->msize,
 532                                            timeout, &transmit_action, h))
 533     {
 534       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 535                   "Failed to transmit request to statistics service.\n");
 536       finish (h, GNUNET_SYSERR);
 537     }
 538 }
 539
 540
 541 static void
 542 insert_ai (struct GNUNET_STATISTICS_Handle *h, struct ActionItem *ai)
 543 {
 544   if (h->action_tail == NULL)
 545     {
 546       h->action_head = ai;
 547       h->action_tail = ai;
 548       schedule_action (h);
 549     }
 550   else
 551     {
 552       h->action_tail->next = ai;
 553       h->action_tail = ai;
 554     }
 555 }
 556
 557
 558 /**
 559  * Get statistic from the peer.
 560  *
 561  * @param handle identification of the statistics service
 562  * @param subsystem limit to the specified subsystem, NULL for our subsystem
 563  * @param name name of the statistic value, NULL for all values
 564  * @param timeout after how long should we give up (and call
 565  *        cont with an error code)?
 566  * @param cont continuation to call when done (can be NULL)
 567  * @param proc function to call on each value
 568  * @param cls closure for cont and proc
 569  */
 570 void
 571 GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
 572                        const char *subsystem,
 573                        const char *name,
 574                        struct GNUNET_TIME_Relative timeout,
 575                        GNUNET_STATISTICS_Callback cont,
 576                        GNUNET_STATISTICS_Iterator proc, void *cls)
 577 {
 578   size_t slen1;
 579   size_t slen2;
 580   struct ActionItem *ai;
 581
 582   GNUNET_assert (handle != NULL);
 583   GNUNET_assert (proc != NULL);
 584   if (GNUNET_YES != try_connect (handle))
 585     {
 586       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 587                   "Failed to connect to statistics service, can not get value `%s:%s'.\n",
 588                   strlen (subsystem) ? subsystem : "*",
 589                   strlen (name) ? name : "*");
 590       cont (cls, GNUNET_SYSERR);
 591       return;
 592     }
 593   if (subsystem == NULL)
 594     subsystem = "";
 595   if (name == NULL)
 596     name = "";
 597   slen1 = strlen (subsystem);
 598   slen2 = strlen (name);
 599   GNUNET_assert (slen1 + slen2 + sizeof (struct GNUNET_MessageHeader) <
 600                  GNUNET_SERVER_MAX_MESSAGE_SIZE);
 601   ai = GNUNET_malloc (sizeof (struct ActionItem));
 602   ai->subsystem = GNUNET_strdup (subsystem);
 603   ai->name = GNUNET_strdup (name);
 604   ai->cont = cont;
 605   ai->proc = proc;
 606   ai->cls = cls;
 607   ai->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 608   ai->type = ACTION_GET;
 609   ai->msize = slen1 + slen2 + sizeof (struct GNUNET_MessageHeader);
 610   insert_ai (handle, ai);
 611 }
 612
 613
 614 static void
 615 add_setter_action (struct GNUNET_STATISTICS_Handle *h,
 616                    const char *name,
 617                    int make_persistent,
 618                    unsigned long long value, enum ActionType type)
 619 {
 620   struct ActionItem *ai;
 621   size_t slen;
 622   size_t nlen;
 623   size_t nsize;
 624
 625   GNUNET_assert (h != NULL);
 626   GNUNET_assert (name != NULL);
 627   if (GNUNET_YES != try_connect (h))
 628     return;
 629   slen = strlen (h->subsystem) + 1;
 630   nlen = strlen (name) + 1;
 631   nsize = sizeof (struct GNUNET_STATISTICS_SetMessage) + slen + nlen;
 632   if (nsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 633     {
 634       GNUNET_break (0);
 635       return;
 636     }
 637   ai = GNUNET_malloc (sizeof (struct ActionItem));
 638   ai->subsystem = GNUNET_strdup (h->subsystem);
 639   ai->name = GNUNET_strdup (name);
 640   ai->timeout = GNUNET_TIME_relative_to_absolute (SET_TRANSMIT_TIMEOUT);
 641   ai->make_persistent = make_persistent;
 642   ai->msize = nsize;
 643   ai->value = value;
 644   ai->type = type;
 645   insert_ai (h, ai);
 646   schedule_action (h);
 647 }
 648
 649
 650 /**
 651  * Set statistic value for the peer.  Will always use our
 652  * subsystem (the argument used when "handle" was created).
 653  *
 654  * @param handle identification of the statistics service
 655  * @param name name of the statistic value
 656  * @param value new value to set
 657  * @param make_persistent should the value be kept across restarts?
 658  */
 659 void
 660 GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
 661                        const char *name,
 662                        unsigned long long value, int make_persistent)
 663 {
 664   add_setter_action (handle, name, make_persistent, value, ACTION_SET);
 665 }
 666
 667
 668 /**
 669  * Set statistic value for the peer.  Will always use our
 670  * subsystem (the argument used when "handle" was created).
 671  *
 672  * @param handle identification of the statistics service
 673  * @param name name of the statistic value
 674  * @param delta change in value (added to existing value)
 675  * @param make_persistent should the value be kept across restarts?
 676  */
 677 void
 678 GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
 679                           const char *name,
 680                           long long delta, int make_persistent)
 681 {
 682   add_setter_action (handle, name, make_persistent,
 683                      (unsigned long long) delta, ACTION_UPDATE);
 684 }
 685
 686
 687 /* end of statistics_api.c */