src/nse/nse_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 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 3, 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 nse/nse_api.c
  23  * @brief api to get information from the network size estimation service
  24  * @author Nathan Evans
  25  *
  26  * TODO:
  27  */
  28 #include "platform.h"
  29 #include "gnunet_client_lib.h"
  30 #include "gnunet_constants.h"
  31 #include "gnunet_container_lib.h"
  32 #include "gnunet_arm_service.h"
  33 #include "gnunet_hello_lib.h"
  34 #include "gnunet_protocols.h"
  35 #include "gnunet_server_lib.h"
  36 #include "gnunet_time_lib.h"
  37 #include "gnunet_nse_service.h"
  38 #include "nse.h"
  39
  40
  41 /**
  42  * Handle for the service.
  43  */
  44 struct GNUNET_NSE_Handle
  45 {
  46   /**
  47    * Configuration to use.
  48    */
  49   const struct GNUNET_CONFIGURATION_Handle *cfg;
  50
  51   /**
  52    * Socket (if available).
  53    */
  54   struct GNUNET_CLIENT_Connection *client;
  55
  56   /**
  57    * Currently pending transmission request.
  58    */
  59   struct GNUNET_CLIENT_TransmitHandle *th;
  60
  61   /**
  62    * Task doing exponential back-off trying to reconnect.
  63    */
  64   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
  65
  66   /**
  67    * Time for next connect retry.
  68    */
  69   struct GNUNET_TIME_Relative reconnect_delay;
  70
  71   /**
  72    * Should this handle auto-destruct once all actions have
  73    * been processed?
  74    */
  75   int do_destroy;
  76
  77   /**
  78    * Are we currently receiving from the service?
  79    */
  80   int receiving;
  81
  82   /**
  83    * Callback function to call when message is received.
  84    */
  85   GNUNET_NSE_Callback recv_cb;
  86
  87   /**
  88    * Closure to pass to callback.
  89    */
  90   void *recv_cb_cls;
  91
  92 };
  93
  94
  95 /**
  96  * Type of a function to call when we receive a message
  97  * from the service.
  98  *
  99  * @param cls closure
 100  * @param msg message received, NULL on timeout or fatal error
 101  */
 102 void message_handler (void *cls,
 103                       const struct GNUNET_MessageHeader * msg)
 104 {
 105   struct GNUNET_NSE_Handle *h = cls;
 106   struct GNUNET_NSE_ClientMessage *client_msg;
 107
 108   if (msg == NULL) /* Error, timeout, death */
 109     return;
 110
 111   if ((ntohs (msg->size) < sizeof(struct GNUNET_NSE_ClientMessage))
 112       || (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_NSE_ESTIMATE))
 113     {
 114 #if DEBUG_NSE
 115       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 116                   "%s: received incorrect message (size %d < %d) from service!",
 117                   "NSE API", ntohs (msg->size),
 118                   sizeof(struct GNUNET_NSE_ClientMessage));
 119 #endif
 120       return;
 121     }
 122
 123   client_msg = (struct GNUNET_NSE_ClientMessage *)msg;
 124
 125   h->recv_cb (h->recv_cb_cls, client_msg->size_estimate,
 126               client_msg->std_deviation);
 127
 128   GNUNET_CLIENT_receive (h->client,
 129                          &message_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 130 }
 131
 132 static void
 133 reconnect (void *cls,
 134            const struct GNUNET_SCHEDULER_TaskContext *tc);
 135
 136 /**
 137  * Reschedule a connect attempt to the service.
 138  *
 139  * @param h transport service to reconnect
 140  */
 141 static void
 142 reschedule_connect (struct GNUNET_NSE_Handle *h)
 143 {
 144   GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
 145
 146   if (NULL != h->th)
 147     {
 148       GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 149       h->th = NULL;
 150     }
 151   if (NULL != h->client)
 152     {
 153       GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
 154       h->client = NULL;
 155     }
 156
 157 #if DEBUG_NSE
 158   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 159               "Scheduling task to reconnect to nse service in %llu ms.\n",
 160               h->reconnect_delay.rel_value);
 161 #endif
 162   h->reconnect_task
 163     = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
 164                                     &reconnect, h);
 165   if (h->reconnect_delay.rel_value == 0)
 166     {
 167       h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
 168     }
 169   else
 170     {
 171       h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
 172       h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
 173                                                      h->reconnect_delay);
 174     }
 175 }
 176
 177 /**
 178  * Transmit START message to service.
 179  *
 180  * @param cls unused
 181  * @param size number of bytes available in buf
 182  * @param buf where to copy the message
 183  * @return number of bytes copied to buf
 184  */
 185 static size_t
 186 send_start (void *cls, size_t size, void *buf)
 187 {
 188   struct GNUNET_NSE_Handle *h = cls;
 189   struct GNUNET_MessageHeader *msg;
 190
 191   h->th = NULL;
 192   if (buf == NULL)
 193     {
 194       /* Connect error... */
 195 #if DEBUG_NSE
 196       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 197                   "Shutdown while trying to transmit `%s' request.\n",
 198                   "START");
 199 #endif
 200       reschedule_connect(h);
 201       return 0;
 202     }
 203 #if DEBUG_NSE
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 205               "Transmitting `%s' request.\n", "START");
 206 #endif
 207   GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
 208
 209   msg = (struct GNUNET_MessageHeader *)buf;
 210   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 211   msg->type = htons (GNUNET_MESSAGE_TYPE_NSE_START);
 212   GNUNET_CLIENT_receive (h->client,
 213                          &message_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
 214   return sizeof (struct GNUNET_MessageHeader);
 215 }
 216
 217 /**
 218  * Try again to connect to network size estimation service.
 219  *
 220  * @param cls the handle to the transport service
 221  * @param tc scheduler context
 222  */
 223 static void
 224 reconnect (void *cls,
 225            const struct GNUNET_SCHEDULER_TaskContext *tc)
 226 {
 227   struct GNUNET_NSE_Handle *h = cls;
 228
 229   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 230   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 231     {
 232       /* shutdown, just give up */
 233       return;
 234     }
 235 #if DEBUG_NSE
 236   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 237               "Connecting to network size estimation service.\n");
 238 #endif
 239   GNUNET_assert (h->client == NULL);
 240   h->client = GNUNET_CLIENT_connect ("nse", h->cfg);
 241   GNUNET_assert (h->client != NULL);
 242
 243   h->th =
 244     GNUNET_CLIENT_notify_transmit_ready (h->client,
 245                                          sizeof(struct GNUNET_MessageHeader),
 246                                          GNUNET_TIME_UNIT_FOREVER_REL,
 247                                          GNUNET_NO,
 248                                          &send_start,
 249                                          h);
 250   GNUNET_assert(h->th != NULL);
 251 }
 252
 253 /**
 254  * Connect to the network size estimation service.
 255  *
 256  * @param cfg the configuration to use
 257  * @param func funtion to call with network size estimate
 258  * @param func_cls closure to pass for network size estimate callback
 259  *
 260  * @return handle to use
 261  */
 262 struct GNUNET_NSE_Handle *
 263 GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 264                     GNUNET_NSE_Callback func, void *func_cls)
 265 {
 266   struct GNUNET_NSE_Handle *ret;
 267
 268   ret = GNUNET_malloc (sizeof (struct GNUNET_NSE_Handle));
 269
 270   if (func == NULL)
 271     return NULL;
 272
 273   ret->cfg = cfg;
 274   ret->recv_cb = func;
 275   ret->recv_cb_cls = func_cls;
 276   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
 277   ret->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, ret);
 278   return ret;
 279 }
 280
 281 /**
 282  * Disconnect from network size estimation service
 283  *
 284  * @param h handle to destroy
 285  *
 286  */
 287 void
 288 GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h)
 289 {
 290   GNUNET_assert(h != NULL);
 291   if (h->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
 292     {
 293       GNUNET_SCHEDULER_cancel(h->reconnect_task);
 294       h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 295     }
 296   if (h->th != NULL)
 297     GNUNET_CLIENT_notify_transmit_ready_cancel(h->th);
 298   if (h->client != NULL)
 299     GNUNET_CLIENT_disconnect(h->client, GNUNET_NO);
 300
 301   GNUNET_free(h);
 302 }