src/fs/gnunet-service-fs_pe.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 fs/gnunet-service-fs_pe.c
  23  * @brief API to manage query plan
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-fs.h"
  28 #include "gnunet-service-fs_cp.h"
  29 #include "gnunet-service-fs_pe.h"
  30 #include "gnunet-service-fs_pr.h"
  31
  32
  33 /**
  34  * Information we keep per request per peer.  This is a doubly-linked
  35  * list (with head and tail in the 'struct GSF_PendingRequestData')
  36  * with one entry in each heap of each 'struct PeerPlan'.  Each
  37  * entry tracks information relevant for this request and this peer.
  38  */
  39 struct GSF_RequestPlan
  40 {
  41
  42   /**
  43    * This is a doubly-linked list.
  44    */
  45   struct GSF_RequestPlan *next;
  46
  47   /**
  48    * This is a doubly-linked list.
  49    */
  50   struct GSF_RequestPlan *prev;
  51
  52   /**
  53    * Heap node associated with this request and this peer.
  54    */
  55   struct GNUNET_CONTAINER_HeapNode *hn;
  56
  57   /**
  58    * Associated pending request.
  59    */
  60   struct GSF_PendingRequest *pr;
  61
  62   /**
  63    * Earliest time we'd be happy to (re)transmit this request.
  64    */
  65   struct GNUNET_TIME_Absolute earliest_transmission;
  66
  67   /**
  68    * When was the last time we transmitted this request to this peer? 0 for never.
  69    */
  70   struct GNUNET_TIME_Absolute last_transmission;
  71
  72   /**
  73    * Current priority for this request for this target.
  74    */
  75   uint64_t priority;
  76
  77   /**
  78    * How often did we transmit this request to this peer?
  79    */
  80   unsigned int transmission_counter;
  81
  82 };
  83
  84
  85 /**
  86  * Transmission plan for a peer.
  87  */
  88 struct PeerPlan
  89 {
  90   /**
  91    * Heap with pending queries (struct GSF_RequestPlan), higher weights mean higher priority.
  92    */
  93   struct GNUNET_CONTAINER_Heap *priority_heap;
  94
  95   /**
  96    * Heap with pending queries (struct GSF_RequestPlan), by transmission time, lowest first.
  97    */
  98   struct GNUNET_CONTAINER_Heap *delay_heap;
  99
 100   /**
 101    * Current transmission request handle.
 102    */
 103   struct GSF_PeerTransmitHandle *pth;
 104
 105   /**
 106    * Peer for which this is the plan.
 107    */
 108   struct GSF_ConnectedPeer *cp;
 109
 110   /**
 111    * Current task for executing the plan.
 112    */
 113   GNUNET_SCHEDULER_TaskIdentifier task;
 114 };
 115
 116
 117 /**
 118  * Hash map from peer identities to PeerPlans.
 119  */
 120 static struct GNUNET_CONTAINER_MultiHashMap *plans;
 121
 122
 123 /**
 124  * Insert the given request plan into the heap with the appropriate weight.
 125  *
 126  * @param pp associated peer's plan
 127  * @param rp request to plan
 128  */
 129 static void
 130 plan (struct PeerPlan *pp,
 131       struct GSF_RequestPlan *rp)
 132 {
 133   struct GSF_PendingRequestData *prd;
 134
 135   prd = GSF_pending_request_get_data_ (rp->pr);
 136   // FIXME: calculate 'rp->earliest_transmission'!
 137   // fIXME: claculate 'rp->priority'!
 138
 139   if (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0)
 140     rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
 141                                            rp,
 142                                            rp->priority);
 143   else
 144     rp->hn = GNUNET_CONTAINER_heap_insert (pp->delay_heap,
 145                                            rp,
 146                                            rp->earliest_transmission.abs_value);
 147 }
 148
 149
 150 /**
 151  * Figure out when and how to transmit to the given peer.
 152  *
 153  * @param cls the 'struct GSF_ConnectedPeer' for transmission
 154  * @param tc scheduler context
 155  */
 156 static void
 157 schedule_peer_transmission (void *cls,
 158                             const struct GNUNET_SCHEDULER_TaskContext *tc);
 159
 160
 161 /**
 162  * Function called to get a message for transmission.
 163  *
 164  * @param cls closure
 165  * @param buf_size number of bytes available in buf
 166  * @param buf where to copy the message, NULL on error (peer disconnect)
 167  * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
 168  */
 169 static size_t
 170 transmit_message_callback (void *cls,
 171                            size_t buf_size,
 172                            void *buf)
 173 {
 174   struct PeerPlan *pp = cls;
 175   struct GSF_RequestPlan *rp;
 176   size_t msize;
 177
 178   pp->pth = NULL;
 179   if (NULL == buf)
 180     {
 181       /* failed, try again... */
 182       pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 183       return 0;
 184     }
 185   rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
 186   if (NULL == rp)
 187     {
 188       pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 189       return 0;
 190     }
 191   msize = GSF_pending_request_get_message_ (rp->pr, buf_size, buf);
 192   if (msize > buf_size)
 193     {
 194       /* buffer to small (message changed), try again */
 195       pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission, pp);
 196       return 0;
 197     }
 198   /* remove from root, add again elsewhere... */
 199   GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->priority_heap));
 200   rp->hn = NULL;
 201   rp->last_transmission = GNUNET_TIME_absolute_get ();
 202   rp->transmission_counter++;
 203 #if DEBUG_FS
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 205               "Executing plan %p executed %u times, planning retransmission\n",
 206               rp,
 207               rp->transmission_counter);
 208 #endif
 209   plan (pp, rp);
 210   return msize;
 211 }
 212
 213
 214 /**
 215  * Figure out when and how to transmit to the given peer.
 216  *
 217  * @param cls the 'struct PeerPlan'
 218  * @param tc scheduler context
 219  */
 220 static void
 221 schedule_peer_transmission (void *cls,
 222                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 223 {
 224   struct PeerPlan *pp = cls;
 225   struct GSF_RequestPlan *rp;
 226   size_t msize;
 227
 228   pp->task = GNUNET_SCHEDULER_NO_TASK;
 229   GNUNET_assert (NULL == pp->pth);
 230   /* move ready requests to priority queue */
 231   while ( (NULL != (rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap))) &&
 232           (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission).rel_value == 0) )
 233     {
 234       GNUNET_assert (rp == GNUNET_CONTAINER_heap_remove_root (pp->delay_heap));
 235       rp->hn = GNUNET_CONTAINER_heap_insert (pp->priority_heap,
 236                                              rp,
 237                                              rp->priority);
 238     }
 239   if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
 240     {
 241       /* priority heap (still) empty, check for delay... */
 242       rp = GNUNET_CONTAINER_heap_peek (pp->delay_heap);
 243       if (NULL == rp)
 244         return; /* both queues empty */
 245       pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
 246                                                &schedule_peer_transmission,
 247                                                pp);
 248       return;
 249     }
 250   /* process from priority heap */
 251   rp = GNUNET_CONTAINER_heap_peek (pp->priority_heap);
 252 #if DEBUG_FS
 253   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 254               "Executing query plan %p\n",
 255               rp);
 256 #endif
 257   GNUNET_assert (NULL != rp);
 258   msize = GSF_pending_request_get_message_ (rp->pr, 0, NULL);
 259   pp->pth = GSF_peer_transmit_ (pp->cp,
 260                                 GNUNET_YES,
 261                                 rp->priority,
 262                                 GNUNET_TIME_UNIT_FOREVER_REL,
 263                                 msize,
 264                                 &transmit_message_callback,
 265                                 pp);
 266   GNUNET_assert (NULL != pp->pth);
 267 }
 268
 269
 270 /**
 271  * Create a new query plan entry.
 272  *
 273  * @param cp peer with the entry
 274  * @param pr request with the entry
 275  */
 276 void
 277 GSF_plan_add_ (struct GSF_ConnectedPeer *cp,
 278                struct GSF_PendingRequest *pr)
 279 {
 280   struct GNUNET_PeerIdentity id;
 281   struct PeerPlan *pp;
 282   struct GSF_PendingRequestData *prd;
 283   struct GSF_RequestPlan *rp;
 284
 285   GSF_connected_peer_get_identity_ (cp, &id);
 286   pp = GNUNET_CONTAINER_multihashmap_get (plans,
 287                                           &id.hashPubKey);
 288   if (NULL == pp)
 289     {
 290       pp = GNUNET_malloc (sizeof (struct PeerPlan));
 291       pp->priority_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MAX);
 292       pp->delay_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
 293       pp->cp = cp;
 294       GNUNET_CONTAINER_multihashmap_put (plans,
 295                                          &id.hashPubKey,
 296                                          pp,
 297                                          GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 298     }
 299   prd = GSF_pending_request_get_data_ (pr);
 300   rp = GNUNET_malloc (sizeof (struct GSF_RequestPlan));
 301 #if DEBUG_FS
 302   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 303               "Planning transmission of query `%s' to peer `%s' (%p)\n",
 304               GNUNET_h2s (&prd->query),
 305               GNUNET_i2s (&id),
 306               rp);
 307 #endif
 308   rp->pr = pr;
 309   GNUNET_CONTAINER_DLL_insert (prd->rp_head,
 310                                prd->rp_tail,
 311                                rp);
 312   plan (pp, rp);
 313   if (0 == GNUNET_CONTAINER_heap_get_size (pp->priority_heap))
 314     {
 315       /* no request that should be done immediately, figure out delay */
 316       if (rp != GNUNET_CONTAINER_heap_peek (pp->delay_heap))
 317         return; /* did not change delay heap top, no need to do anything */
 318       GNUNET_assert (NULL == pp->pth);
 319       if (GNUNET_SCHEDULER_NO_TASK != pp->task)
 320         GNUNET_SCHEDULER_cancel (pp->task);
 321       pp->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (rp->earliest_transmission),
 322                                                &schedule_peer_transmission,
 323                                                pp);
 324       return;
 325     }
 326
 327   if (pp->pth != NULL)
 328     {
 329       if (rp != GNUNET_CONTAINER_heap_peek (pp->priority_heap))
 330         return; /* did not change priority heap top, no need to do anyhing */
 331       GSF_peer_transmit_cancel_ (pp->pth);
 332       pp->pth = NULL;
 333     }
 334   if (GNUNET_SCHEDULER_NO_TASK != pp->task)
 335     GNUNET_SCHEDULER_cancel (pp->task);
 336   pp->task = GNUNET_SCHEDULER_add_now (&schedule_peer_transmission,
 337                                        pp);
 338 }
 339
 340
 341 /**
 342  * Notify the plan about a peer being no longer available;
 343  * destroy all entries associated with this peer.
 344  *
 345  * @param cp connected peer
 346  */
 347 void
 348 GSF_plan_notify_peer_disconnect_ (const struct GSF_ConnectedPeer *cp)
 349 {
 350   struct GNUNET_PeerIdentity id;
 351   struct PeerPlan *pp;
 352   struct GSF_RequestPlan *rp;
 353   struct GSF_PendingRequestData *prd;
 354
 355   GSF_connected_peer_get_identity_ (cp, &id);
 356   pp = GNUNET_CONTAINER_multihashmap_get (plans,
 357                                           &id.hashPubKey);
 358   if (NULL == pp)
 359     return; /* nothing was ever planned for this peer */
 360   GNUNET_CONTAINER_multihashmap_remove (plans,
 361                                         &id.hashPubKey,
 362                                         pp);
 363   if (NULL != pp->pth)
 364     GSF_peer_transmit_cancel_ (pp->pth);
 365   if (GNUNET_SCHEDULER_NO_TASK != pp->task)
 366     GNUNET_SCHEDULER_cancel (pp->task);
 367   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->priority_heap)))
 368     {
 369       prd = GSF_pending_request_get_data_ (rp->pr);
 370       GNUNET_CONTAINER_DLL_remove (prd->rp_head,
 371                                    prd->rp_tail,
 372                                    rp);
 373       GNUNET_free (rp);
 374     }
 375   GNUNET_CONTAINER_heap_destroy (pp->priority_heap);
 376   while (NULL != (rp = GNUNET_CONTAINER_heap_remove_root (pp->delay_heap)))
 377     {
 378       prd = GSF_pending_request_get_data_ (rp->pr);
 379       GNUNET_CONTAINER_DLL_remove (prd->rp_head,
 380                                    prd->rp_tail,
 381                                    rp);
 382       GNUNET_free (rp);
 383     }
 384   GNUNET_CONTAINER_heap_destroy (pp->delay_heap);
 385   GNUNET_free (pp);
 386 }
 387
 388
 389 /**
 390  * Notify the plan about a request being done; destroy all entries
 391  * associated with this request.
 392  *
 393  * @param pr request that is done
 394  */
 395 void
 396 GSF_plan_notify_request_done_ (struct GSF_PendingRequest *pr)
 397 {
 398   struct GSF_RequestPlan *rp;
 399   struct GSF_PendingRequestData *prd;
 400
 401   prd = GSF_pending_request_get_data_ (pr);
 402   while (NULL != (rp = prd->rp_head))
 403     {
 404       GNUNET_CONTAINER_heap_remove_node (rp->hn);
 405       GNUNET_CONTAINER_DLL_remove (prd->rp_head,
 406                                    prd->rp_tail,
 407                                    rp);
 408       GNUNET_free (rp);
 409     }
 410 }
 411
 412
 413 /**
 414  * Initialize plan subsystem.
 415  */
 416 void
 417 GSF_plan_init ()
 418 {
 419   plans = GNUNET_CONTAINER_multihashmap_create (256);
 420 }
 421
 422
 423 /**
 424  * Shutdown plan subsystem.
 425  */
 426 void
 427 GSF_plan_done ()
 428 {
 429   GNUNET_assert (0 ==
 430                  GNUNET_CONTAINER_multihashmap_size (plans));
 431   GNUNET_CONTAINER_multihashmap_destroy (plans);
 432 }
 433
 434
 435
 436 /* end of gnunet-service-fs_pe.h */