src/fs/gnunet-service-fs_cadet_server.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012, 2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file fs/gnunet-service-fs_cadet_server.c
  23  * @brief non-anonymous file-transfer
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - PORT is set to old application type, unsure if we should keep
  28  *   it that way (fine for now)
  29  */
  30 #include "platform.h"
  31 #include "gnunet_constants.h"
  32 #include "gnunet_util_lib.h"
  33 #include "gnunet_cadet_service.h"
  34 #include "gnunet_protocols.h"
  35 #include "gnunet_applications.h"
  36 #include "gnunet-service-fs.h"
  37 #include "gnunet-service-fs_indexing.h"
  38 #include "gnunet-service-fs_cadet.h"
  39
  40 /**
  41  * After how long do we termiante idle connections?
  42  */
  43 #define IDLE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
  44
  45
  46 /**
  47  * A message in the queue to be written to the cadet.
  48  */
  49 struct WriteQueueItem
  50 {
  51   /**
  52    * Kept in a DLL.
  53    */
  54   struct WriteQueueItem *next;
  55
  56   /**
  57    * Kept in a DLL.
  58    */
  59   struct WriteQueueItem *prev;
  60
  61   /**
  62    * Number of bytes of payload, allocated at the end of this struct.
  63    */
  64   size_t msize;
  65 };
  66
  67
  68 /**
  69  * Information we keep around for each active cadeting client.
  70  */
  71 struct CadetClient
  72 {
  73   /**
  74    * DLL
  75    */
  76   struct CadetClient *next;
  77
  78   /**
  79    * DLL
  80    */
  81   struct CadetClient *prev;
  82
  83   /**
  84    * Channel for communication.
  85    */
  86   struct GNUNET_CADET_Channel *channel;
  87
  88   /**
  89    * Handle for active write operation, or NULL.
  90    */
  91   struct GNUNET_CADET_TransmitHandle *wh;
  92
  93   /**
  94    * Head of write queue.
  95    */
  96   struct WriteQueueItem *wqi_head;
  97
  98   /**
  99    * Tail of write queue.
 100    */
 101   struct WriteQueueItem *wqi_tail;
 102
 103   /**
 104    * Current active request to the datastore, if we have one pending.
 105    */
 106   struct GNUNET_DATASTORE_QueueEntry *qe;
 107
 108   /**
 109    * Task that is scheduled to asynchronously terminate the connection.
 110    */
 111   struct GNUNET_SCHEDULER_Task * terminate_task;
 112
 113   /**
 114    * Task that is scheduled to terminate idle connections.
 115    */
 116   struct GNUNET_SCHEDULER_Task * timeout_task;
 117
 118   /**
 119    * Size of the last write that was initiated.
 120    */
 121   size_t reply_size;
 122
 123 };
 124
 125
 126 /**
 127  * Listen channel for incoming requests.
 128  */
 129 static struct GNUNET_CADET_Handle *listen_channel;
 130
 131 /**
 132  * Head of DLL of cadet clients.
 133  */
 134 static struct CadetClient *sc_head;
 135
 136 /**
 137  * Tail of DLL of cadet clients.
 138  */
 139 static struct CadetClient *sc_tail;
 140
 141 /**
 142  * Number of active cadet clients in the 'sc_*'-DLL.
 143  */
 144 static unsigned int sc_count;
 145
 146 /**
 147  * Maximum allowed number of cadet clients.
 148  */
 149 static unsigned long long sc_count_max;
 150
 151
 152
 153 /**
 154  * Task run to asynchronously terminate the cadet due to timeout.
 155  *
 156  * @param cls the 'struct CadetClient'
 157  */
 158 static void
 159 timeout_cadet_task (void *cls)
 160 {
 161   struct CadetClient *sc = cls;
 162   struct GNUNET_CADET_Channel *tun;
 163
 164   sc->timeout_task = NULL;
 165   tun = sc->channel;
 166   sc->channel = NULL;
 167   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 168               "Timeout for inactive cadet client %p\n",
 169               sc);
 170   GNUNET_CADET_channel_destroy (tun);
 171 }
 172
 173
 174 /**
 175  * Reset the timeout for the cadet client (due to activity).
 176  *
 177  * @param sc client handle to reset timeout for
 178  */
 179 static void
 180 refresh_timeout_task (struct CadetClient *sc)
 181 {
 182   if (NULL != sc->timeout_task)
 183     GNUNET_SCHEDULER_cancel (sc->timeout_task);
 184   sc->timeout_task = GNUNET_SCHEDULER_add_delayed (IDLE_TIMEOUT,
 185                                                    &timeout_cadet_task,
 186                                                    sc);
 187 }
 188
 189
 190 /**
 191  * We're done handling a request from a client, read the next one.
 192  *
 193  * @param sc client to continue reading requests from
 194  */
 195 static void
 196 continue_reading (struct CadetClient *sc)
 197 {
 198   refresh_timeout_task (sc);
 199   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 200               "Finished processing cadet request from client %p, ready to receive the next one\n",
 201               sc);
 202   GNUNET_CADET_receive_done (sc->channel);
 203 }
 204
 205
 206 /**
 207  * Transmit the next entry from the write queue.
 208  *
 209  * @param sc where to process the write queue
 210  */
 211 static void
 212 continue_writing (struct CadetClient *sc);
 213
 214
 215 /**
 216  * Send a reply now, cadet is ready.
 217  *
 218  * @param cls closure with the `struct CadetClient` which sent the query
 219  * @param size number of bytes available in @a buf
 220  * @param buf where to write the message
 221  * @return number of bytes written to @a buf
 222  */
 223 static size_t
 224 write_continuation (void *cls,
 225                     size_t size,
 226                     void *buf)
 227 {
 228   struct CadetClient *sc = cls;
 229   struct GNUNET_CADET_Channel *tun;
 230   struct WriteQueueItem *wqi;
 231   size_t ret;
 232
 233   sc->wh = NULL;
 234   if (NULL == (wqi = sc->wqi_head))
 235   {
 236     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 237                 "Write queue empty, reading more requests\n");
 238     return 0;
 239   }
 240   if ( (0 == size) ||
 241        (size < wqi->msize) )
 242   {
 243     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 244                 "Transmission of reply failed, terminating cadet\n");
 245     tun = sc->channel;
 246     sc->channel = NULL;
 247     GNUNET_CADET_channel_destroy (tun);
 248     return 0;
 249   }
 250   GNUNET_CONTAINER_DLL_remove (sc->wqi_head,
 251                                sc->wqi_tail,
 252                                wqi);
 253   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 254               "Transmitted %u byte reply via cadet to %p\n",
 255               (unsigned int) size,
 256               sc);
 257   GNUNET_STATISTICS_update (GSF_stats,
 258                             gettext_noop ("# Blocks transferred via cadet"), 1,
 259                             GNUNET_NO);
 260   memcpy (buf, &wqi[1], ret = wqi->msize);
 261   GNUNET_free (wqi);
 262   continue_writing (sc);
 263   return ret;
 264 }
 265
 266
 267 /**
 268  * Transmit the next entry from the write queue.
 269  *
 270  * @param sc where to process the write queue
 271  */
 272 static void
 273 continue_writing (struct CadetClient *sc)
 274 {
 275   struct WriteQueueItem *wqi;
 276   struct GNUNET_CADET_Channel *tun;
 277
 278   if (NULL != sc->wh)
 279   {
 280     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 281                 "Write pending, waiting for it to complete\n");
 282     return; /* write already pending */
 283   }
 284   if (NULL == (wqi = sc->wqi_head))
 285   {
 286     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 287                 "Write queue empty, reading more requests\n");
 288     continue_reading (sc);
 289     return;
 290   }
 291   sc->wh = GNUNET_CADET_notify_transmit_ready (sc->channel, GNUNET_NO,
 292                                               GNUNET_TIME_UNIT_FOREVER_REL,
 293                                               wqi->msize,
 294                                               &write_continuation,
 295                                               sc);
 296   if (NULL == sc->wh)
 297   {
 298     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 299                 "Write failed; terminating cadet\n");
 300     tun = sc->channel;
 301     sc->channel = NULL;
 302     GNUNET_CADET_channel_destroy (tun);
 303     return;
 304   }
 305 }
 306
 307
 308 /**
 309  * Process a datum that was stored in the datastore.
 310  *
 311  * @param cls closure with the `struct CadetClient` which sent the query
 312  * @param key key for the content
 313  * @param size number of bytes in @a data
 314  * @param data content stored
 315  * @param type type of the content
 316  * @param priority priority of the content
 317  * @param anonymity anonymity-level for the content
 318  * @param expiration expiration time for the content
 319  * @param uid unique identifier for the datum;
 320  *        maybe 0 if no unique identifier is available
 321  */
 322 static void
 323 handle_datastore_reply (void *cls,
 324                         const struct GNUNET_HashCode *key,
 325                         size_t size,
 326                         const void *data,
 327                         enum GNUNET_BLOCK_Type type,
 328                         uint32_t priority,
 329                         uint32_t anonymity,
 330                         struct GNUNET_TIME_Absolute expiration,
 331                         uint64_t uid)
 332 {
 333   struct CadetClient *sc = cls;
 334   size_t msize = size + sizeof (struct CadetReplyMessage);
 335   struct WriteQueueItem *wqi;
 336   struct CadetReplyMessage *srm;
 337
 338   sc->qe = NULL;
 339   if (NULL == data)
 340   {
 341     /* no result, this should not really happen, as for
 342        non-anonymous routing only peers that HAVE the
 343        answers should be queried; OTOH, this is not a
 344        hard error as we might have had the answer in the
 345        past and the user might have unindexed it. Hence
 346        we log at level "INFO" for now. */
 347     if (NULL == key)
 348     {
 349       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 350                   "Have no answer and the query was NULL\n");
 351     }
 352     else
 353     {
 354       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 355                   "Have no answer for query `%s'\n",
 356                   GNUNET_h2s (key));
 357     }
 358     GNUNET_STATISTICS_update (GSF_stats,
 359                               gettext_noop ("# queries received via CADET not answered"), 1,
 360                               GNUNET_NO);
 361     continue_writing (sc);
 362     return;
 363   }
 364   if (GNUNET_BLOCK_TYPE_FS_ONDEMAND == type)
 365   {
 366     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 367                 "Performing on-demand encoding for query %s\n",
 368                 GNUNET_h2s (key));
 369     if (GNUNET_OK !=
 370         GNUNET_FS_handle_on_demand_block (key,
 371                                           size, data, type,
 372                                           priority, anonymity,
 373                                           expiration, uid,
 374                                           &handle_datastore_reply,
 375                                           sc))
 376     {
 377       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 378                   "On-demand encoding request failed\n");
 379       continue_writing (sc);
 380     }
 381     return;
 382   }
 383   if (msize > GNUNET_SERVER_MAX_MESSAGE_SIZE)
 384   {
 385     GNUNET_break (0);
 386     continue_writing (sc);
 387     return;
 388   }
 389   GNUNET_break (GNUNET_BLOCK_TYPE_ANY != type);
 390   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 391               "Starting transmission of %u byte reply of type %d for query `%s' via cadet to %p\n",
 392               (unsigned int) size,
 393               (unsigned int) type,
 394               GNUNET_h2s (key),
 395               sc);
 396   wqi = GNUNET_malloc (sizeof (struct WriteQueueItem) + msize);
 397   wqi->msize = msize;
 398   srm = (struct CadetReplyMessage *) &wqi[1];
 399   srm->header.size = htons ((uint16_t) msize);
 400   srm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_CADET_REPLY);
 401   srm->type = htonl (type);
 402   srm->expiration = GNUNET_TIME_absolute_hton (expiration);
 403   memcpy (&srm[1], data, size);
 404   sc->reply_size = msize;
 405   GNUNET_CONTAINER_DLL_insert (sc->wqi_head,
 406                                sc->wqi_tail,
 407                                wqi);
 408   continue_writing (sc);
 409 }
 410
 411
 412 /**
 413  * Functions with this signature are called whenever a
 414  * complete query message is received.
 415  *
 416  * Do not call #GNUNET_SERVER_mst_destroy() in callback
 417  *
 418  * @param cls closure with the `struct CadetClient`
 419  * @param channel channel handle
 420  * @param channel_ctx channel context
 421  * @param message the actual message
 422  * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
 423  */
 424 static int
 425 request_cb (void *cls,
 426             struct GNUNET_CADET_Channel *channel,
 427             void **channel_ctx,
 428             const struct GNUNET_MessageHeader *message)
 429 {
 430   struct CadetClient *sc = *channel_ctx;
 431   const struct CadetQueryMessage *sqm;
 432
 433   sqm = (const struct CadetQueryMessage *) message;
 434   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 435               "Received query for `%s' via cadet from client %p\n",
 436               GNUNET_h2s (&sqm->query),
 437               sc);
 438   GNUNET_STATISTICS_update (GSF_stats,
 439                             gettext_noop ("# queries received via cadet"), 1,
 440                             GNUNET_NO);
 441   refresh_timeout_task (sc);
 442   sc->qe = GNUNET_DATASTORE_get_key (GSF_dsh,
 443                                      0,
 444                                      &sqm->query,
 445                                      ntohl (sqm->type),
 446                                      0 /* priority */,
 447                                      GSF_datastore_queue_size,
 448                                      GNUNET_TIME_UNIT_FOREVER_REL,
 449                                      &handle_datastore_reply, sc);
 450   if (NULL == sc->qe)
 451   {
 452     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 453                 "Queueing request with datastore failed (queue full?)\n");
 454     continue_writing (sc);
 455   }
 456   return GNUNET_OK;
 457 }
 458
 459
 460 /**
 461  * Functions of this type are called upon new cadet connection from other peers.
 462  *
 463  * @param cls the closure from GNUNET_CADET_connect
 464  * @param channel the channel representing the cadet
 465  * @param initiator the identity of the peer who wants to establish a cadet
 466  *            with us; NULL on binding error
 467  * @param port cadet port used for the incoming connection
 468  * @param options channel option flags
 469  * @return initial channel context (our 'struct CadetClient')
 470  */
 471 static void *
 472 accept_cb (void *cls,
 473            struct GNUNET_CADET_Channel *channel,
 474            const struct GNUNET_PeerIdentity *initiator,
 475            uint32_t port, enum GNUNET_CADET_ChannelOption options)
 476 {
 477   struct CadetClient *sc;
 478
 479   GNUNET_assert (NULL != channel);
 480   if (sc_count >= sc_count_max)
 481   {
 482     GNUNET_STATISTICS_update (GSF_stats,
 483                               gettext_noop ("# cadet client connections rejected"), 1,
 484                               GNUNET_NO);
 485     GNUNET_CADET_channel_destroy (channel);
 486     return NULL;
 487   }
 488   GNUNET_STATISTICS_update (GSF_stats,
 489                             gettext_noop ("# cadet connections active"), 1,
 490                             GNUNET_NO);
 491   sc = GNUNET_new (struct CadetClient);
 492   sc->channel = channel;
 493   GNUNET_CONTAINER_DLL_insert (sc_head,
 494                                sc_tail,
 495                                sc);
 496   sc_count++;
 497   refresh_timeout_task (sc);
 498   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 499               "Accepting inbound cadet connection from `%s' as client %p\n",
 500               GNUNET_i2s (initiator),
 501               sc);
 502   return sc;
 503 }
 504
 505
 506 /**
 507  * Function called by cadet when a client disconnects.
 508  * Cleans up our 'struct CadetClient' of that channel.
 509  *
 510  * @param cls NULL
 511  * @param channel channel of the disconnecting client
 512  * @param channel_ctx our 'struct CadetClient'
 513  */
 514 static void
 515 cleaner_cb (void *cls,
 516             const struct GNUNET_CADET_Channel *channel,
 517             void *channel_ctx)
 518 {
 519   struct CadetClient *sc = channel_ctx;
 520   struct WriteQueueItem *wqi;
 521
 522   if (NULL == sc)
 523     return;
 524   sc->channel = NULL;
 525   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 526               "Terminating cadet connection with client %p\n",
 527               sc);
 528   GNUNET_STATISTICS_update (GSF_stats,
 529                             gettext_noop ("# cadet connections active"), -1,
 530                             GNUNET_NO);
 531   if (NULL != sc->terminate_task)
 532     GNUNET_SCHEDULER_cancel (sc->terminate_task);
 533   if (NULL != sc->timeout_task)
 534     GNUNET_SCHEDULER_cancel (sc->timeout_task);
 535   if (NULL != sc->wh)
 536     GNUNET_CADET_notify_transmit_ready_cancel (sc->wh);
 537   if (NULL != sc->qe)
 538     GNUNET_DATASTORE_cancel (sc->qe);
 539   while (NULL != (wqi = sc->wqi_head))
 540   {
 541     GNUNET_CONTAINER_DLL_remove (sc->wqi_head,
 542                                  sc->wqi_tail,
 543                                  wqi);
 544     GNUNET_free (wqi);
 545   }
 546   GNUNET_CONTAINER_DLL_remove (sc_head,
 547                                sc_tail,
 548                                sc);
 549   sc_count--;
 550   GNUNET_free (sc);
 551 }
 552
 553
 554 /**
 555  * Initialize subsystem for non-anonymous file-sharing.
 556  */
 557 void
 558 GSF_cadet_start_server ()
 559 {
 560   static const struct GNUNET_CADET_MessageHandler handlers[] = {
 561     { &request_cb, GNUNET_MESSAGE_TYPE_FS_CADET_QUERY, sizeof (struct CadetQueryMessage)},
 562     { NULL, 0, 0 }
 563   };
 564   static const uint32_t ports[] = {
 565     GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
 566     0
 567   };
 568
 569   if (GNUNET_YES !=
 570       GNUNET_CONFIGURATION_get_value_number (GSF_cfg,
 571                                              "fs",
 572                                              "MAX_CADET_CLIENTS",
 573                                              &sc_count_max))
 574     return;
 575   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 576               "Initializing cadet FS server with a limit of %llu connections\n",
 577               sc_count_max);
 578   listen_channel = GNUNET_CADET_connect (GSF_cfg,
 579                                        NULL,
 580                                        &accept_cb,
 581                                        &cleaner_cb,
 582                                        handlers,
 583                                        ports);
 584 }
 585
 586
 587 /**
 588  * Shutdown subsystem for non-anonymous file-sharing.
 589  */
 590 void
 591 GSF_cadet_stop_server ()
 592 {
 593   if (NULL != listen_channel)
 594   {
 595     GNUNET_CADET_disconnect (listen_channel);
 596     listen_channel = NULL;
 597   }
 598   GNUNET_assert (NULL == sc_head);
 599   GNUNET_assert (0 == sc_count);
 600 }
 601
 602 /* end of gnunet-service-fs_cadet.c */