src/fs/gnunet-service-fs_lc.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_lc.c
  23  * @brief API to handle 'connected peers'
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet-service-fs_lc.h"
  29
  30
  31 /**
  32  * Doubly-linked list of requests we are performing
  33  * on behalf of the same client.
  34  */
  35 struct ClientRequest
  36 {
  37
  38   /**
  39    * This is a doubly-linked list.
  40    */
  41   struct ClientRequest *next;
  42
  43   /**
  44    * This is a doubly-linked list.
  45    */
  46   struct ClientRequest *prev;
  47
  48   /**
  49    * Request this entry represents.
  50    */
  51   struct GSF_PendingRequest *pr;
  52
  53   /**
  54    * Client list this request belongs to.
  55    */
  56   struct GSF_LocalClient *lc;
  57
  58 };
  59
  60
  61
  62 /**
  63  * Replies to be transmitted to the client.  The actual
  64  * response message is allocated after this struct.
  65  */
  66 struct ClientResponse
  67 {
  68   /**
  69    * This is a doubly-linked list.
  70    */
  71   struct ClientResponse *next;
  72
  73   /**
  74    * This is a doubly-linked list.
  75    */
  76   struct ClientResponse *prev;
  77
  78   /**
  79    * Client list entry this response belongs to.
  80    */
  81   struct GSF_LocalClient *lc;
  82
  83   /**
  84    * Number of bytes in the response.
  85    */
  86   size_t msize;
  87 };
  88
  89
  90
  91 /**
  92  * A local client.
  93  */
  94 struct GSF_LocalClient
  95 {
  96
  97   /**
  98    * We keep clients in a DLL.
  99    */
 100   struct GSF_LocalClient *next;
 101
 102   /**
 103    * We keep clients in a DLL.
 104    */
 105   struct GSF_LocalClient *prev;
 106
 107   /**
 108    * ID of the client.
 109    */
 110   struct GNUNET_SERVER_Client *client;
 111
 112   /**
 113    * Head of list of requests performed on behalf
 114    * of this client right now.
 115    */
 116   struct ClientRequest *cr_head;
 117
 118   /**
 119    * Tail of list of requests performed on behalf
 120    * of this client right now.
 121    */
 122   struct ClientRequest *cr_tail;
 123
 124   /**
 125    * Head of linked list of responses.
 126    */
 127   struct ClientResponse *res_head;
 128
 129   /**
 130    * Tail of linked list of responses.
 131    */
 132   struct ClientResponse *res_tail;
 133
 134   /**
 135    * Context for sending replies.
 136    */
 137   struct GNUNET_CONNECTION_TransmitHandle *th;
 138
 139 };
 140
 141
 142 /**
 143  * Head of linked list of our local clients.
 144  */
 145 static struct GSF_LocalClient *client_head;
 146
 147
 148 /**
 149  * Head of linked list of our local clients.
 150  */
 151 static struct GSF_LocalClient *client_tail;
 152
 153
 154 /**
 155  * Look up a local client record or create one if it
 156  * doesn't exist yet.
 157  *
 158  * @param client handle of the client
 159  * @return handle to local client entry
 160  */
 161 struct GSF_LocalClient *
 162 GSF_local_client_lookup_ (struct GNUNET_SERVER_Client *client)
 163 {
 164   struct GSF_LocalClient *pos;
 165
 166   pos = client_head;
 167   while ( (pos != NULL) &&
 168           (pos->client != client) )
 169     pos = pos->next;
 170   if (pos != NULL)
 171     return pos;
 172   pos = GNUNET_malloc (sizeof (struct GSF_LocalClient));
 173   pos->client = client;
 174   GNUNET_CONTAINER_DLL_insert (client_head,
 175                                client_tail,
 176                                pos);
 177   return pos;
 178 }
 179
 180
 181 /**
 182  * Handle a reply to a pending request.  Also called if a request
 183  * expires (then with data == NULL).  The handler may be called
 184  * many times (depending on the request type), but will not be
 185  * called during or after a call to GSF_pending_request_cancel
 186  * and will also not be called anymore after a call signalling
 187  * expiration.
 188  *
 189  * @param cls user-specified closure
 190  * @param pr handle to the original pending request
 191  * @param data response data, NULL on request expiration
 192  * @param data_len number of bytes in data
 193  */
 194 static void
 195 client_response_handler (void *cls,
 196                          struct GSF_PendingRequest *pr,
 197                          const void *data,
 198                          size_t data_len)
 199 {
 200   /* FIXME: adapt old code below to new API! */
 201
 202       GNUNET_STATISTICS_update (stats,
 203                                 gettext_noop ("# replies received for local clients"),
 204                                 1,
 205                                 GNUNET_NO);
 206       cl = pr->client_request_list->client_list;
 207       msize = sizeof (struct PutMessage) + prq->size;
 208       creply = GNUNET_malloc (msize + sizeof (struct ClientResponseMessage));
 209       creply->msize = msize;
 210       creply->client_list = cl;
 211       GNUNET_CONTAINER_DLL_insert_after (cl->res_head,
 212                                          cl->res_tail,
 213                                          cl->res_tail,
 214                                          creply);
 215       pm = (struct PutMessage*) &creply[1];
 216       pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
 217       pm->header.size = htons (msize);
 218       pm->type = htonl (prq->type);
 219       pm->expiration = GNUNET_TIME_absolute_hton (prq->expiration);
 220       memcpy (&pm[1], prq->data, prq->size);
 221       if (NULL == cl->th)
 222         {
 223 #if DEBUG_FS
 224           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 225                       "Transmitting result for query `%s' to client\n",
 226                       GNUNET_h2s (key));
 227 #endif
 228           cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
 229                                                         msize,
 230                                                         GNUNET_TIME_UNIT_FOREVER_REL,
 231                                                         &transmit_to_client,
 232                                                         cl);
 233         }
 234       GNUNET_break (cl->th != NULL);
 235       if (pr->do_remove)
 236         {
 237           prq->finished = GNUNET_YES;
 238           destroy_pending_request (pr);
 239         }
 240
 241 }
 242
 243
 244
 245 /**
 246  * Handle START_SEARCH-message (search request from local client).
 247  *
 248  * @param client identification of the client
 249  * @param message the actual message
 250  * @return pending request handle for the request, NULL on error
 251  */
 252 struct GSF_PendingRequest *
 253 GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
 254                                         const struct GNUNET_MessageHeader *message)
 255 {
 256   static GNUNET_HashCode all_zeros;
 257   const struct SearchMessage *sm;
 258   struct GSF_LocalClient *lc;
 259   struct ClientRequest *cr;
 260   struct GSF_PendingRequest *pr;
 261   uint16_t msize;
 262   unsigned int sc;
 263   enum GNUNET_BLOCK_Type type;
 264   enum GSF_PendingRequestOptions options;
 265
 266   msize = ntohs (message->size);
 267   if ( (msize < sizeof (struct SearchMessage)) ||
 268        (0 != (msize - sizeof (struct SearchMessage)) % sizeof (GNUNET_HashCode)) )
 269     {
 270       GNUNET_break (0);
 271       GNUNET_SERVER_receive_done (client,
 272                                   GNUNET_SYSERR);
 273       return NULL;
 274     }
 275   GNUNET_STATISTICS_update (stats,
 276                             gettext_noop ("# client searches received"),
 277                             1,
 278                             GNUNET_NO);
 279   sc = (msize - sizeof (struct SearchMessage)) / sizeof (GNUNET_HashCode);
 280   sm = (const struct SearchMessage*) message;
 281   type = ntohl (sm->type);
 282 #if DEBUG_FS
 283   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 284               "Received request for `%s' of type %u from local client\n",
 285               GNUNET_h2s (&sm->query),
 286               (unsigned int) type);
 287 #endif
 288   lc = GSF_local_client_lookup_ (client);
 289
 290   /* detect duplicate KBLOCK requests */
 291   if ( (type == GNUNET_BLOCK_TYPE_FS_KBLOCK) ||
 292        (type == GNUNET_BLOCK_TYPE_FS_NBLOCK) ||
 293        (type == GNUNET_BLOCK_TYPE_ANY) )
 294     {
 295       cr = lc->cr_head;
 296       while ( (cl != NULL) &&
 297               ( (0 != memcmp (GSF_pending_request_get_query_ (cr->pr),
 298                               &sm->query,
 299                               sizeof (GNUNET_HashCode))) ||
 300                 (GSF_pending_request_get_type_ (cr->pr) != type) ) )
 301         cr = cr->next;
 302       if (crl != NULL)
 303         {
 304 #if DEBUG_FS
 305           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 306                       "Have existing request, merging content-seen lists.\n");
 307 #endif
 308           GSF_pending_request_update_ (cr->pr,
 309                                        &sm[1],
 310                                        sc);
 311           GNUNET_STATISTICS_update (stats,
 312                                     gettext_noop ("# client searches updated (merged content seen list)"),
 313                                     1,
 314                                     GNUNET_NO);
 315           GNUNET_SERVER_receive_done (client,
 316                                       GNUNET_OK);
 317           return NULL;
 318         }
 319     }
 320
 321   GNUNET_STATISTICS_update (stats,
 322                             gettext_noop ("# client searches active"),
 323                             1,
 324                             GNUNET_NO);
 325   cr = GNUNET_malloc (sizeof (struct ClientRequest));
 326   cr->lc = lc;
 327   GNUNET_CONTAINER_DLL_insert (lc->cr_head,
 328                                lc->cr_tail,
 329                                cr);
 330   options = GSF_PRO_LOCAL_REQUEST;
 331   if (0 != (1 & ntohl (sm->options)))
 332     options |= GSF_PRO_LOCAL_ONLY;
 333   cr->pr = GSF_pending_request_create_ (options,
 334                                         type,
 335                                         &sm->query,
 336                                         (type == GNUNET_BLOCK_TYPE_SBLOCK)
 337                                         ? &sm->target /* namespace */
 338                                         : NULL,
 339                                         (0 != memcmp (&sm->target,
 340                                                       &all_zeros,
 341                                                       sizeof (GNUNET_HashCode)))
 342                                         ? &sm->target,
 343                                         : NULL,
 344                                         NULL, 0, 0 /* bf */,
 345                                         ntohl (sm->anonymity_level),
 346                                         0 /* priority */,
 347                                         &sm[1], sc,
 348                                         &client_response_handler,
 349                                         cr);
 350   return cr->pr;
 351 }
 352
 353
 354 /**
 355  * Transmit the given message by copying it to the target buffer
 356  * "buf".  "buf" will be NULL and "size" zero if the socket was closed
 357  * for writing in the meantime.  In that case, do nothing
 358  * (the disconnect or shutdown handler will take care of the rest).
 359  * If we were able to transmit messages and there are still more
 360  * pending, ask core again for further calls to this function.
 361  *
 362  * @param cls closure, pointer to the 'struct GSF_LocalClient'
 363  * @param size number of bytes available in buf
 364  * @param buf where the callee should write the message
 365  * @return number of bytes written to buf
 366  */
 367 static size_t
 368 transmit_to_client (void *cls,
 369                     size_t size,
 370                     void *buf)
 371 {
 372   struct GSF_LocalClient *lc = cls;
 373   char *cbuf = buf;
 374   struct ClientResponse *res;
 375   size_t msize;
 376
 377   cl->th = NULL;
 378   if (NULL == buf)
 379     return 0;
 380   msize = 0;
 381   while ( (NULL != (res = lc->res_head) ) &&
 382           (res->msize <= size) )
 383     {
 384       memcpy (&cbuf[msize], &res[1], res->msize);
 385       msize += res->msize;
 386       size -= res->msize;
 387       GNUNET_CONTAINER_DLL_remove (cl->res_head,
 388                                    cl->res_tail,
 389                                    res);
 390       GNUNET_free (res);
 391     }
 392   if (NULL != res)
 393     lc->th = GNUNET_SERVER_notify_transmit_ready (lc->client,
 394                                                   res->msize,
 395                                                   GNUNET_TIME_UNIT_FOREVER_REL,
 396                                                   &transmit_to_client,
 397                                                   lc);
 398   return msize;
 399 }
 400
 401
 402 /**
 403  * Transmit a message to the given local client as soon as possible.
 404  * If the client disconnects before transmission, the message is
 405  * simply discarded.
 406  *
 407  * @param lc recipient
 408  * @param msg message to transmit to client
 409  */
 410 void
 411 GSF_local_client_transmit_ (struct GSF_LocalClient *lc,
 412                             const struct GNUNET_MessageHeader *msg)
 413 {
 414   struct ClientResponse *res;
 415   size_t msize;
 416
 417   msize = ntohs (msg->size);
 418   res = GNUNET_malloc (sizeof (struct ClientResponse) + msize);
 419   res->lc = lc;
 420   res->msize = msize;
 421   GNUNET_CONTAINER_DLL_insert_tail (lc->res_head,
 422                                     lc->res_tail,
 423                                     res);
 424   if (NULL == lc->tc)
 425     lc->tc = GNUNET_CLIENT_notify_transmit_ready (lc->client,
 426                                                   msize,
 427                                                   GNUNET_TIME_UNIT_FOREVER_REL,
 428                                                   GNUNET_NO,
 429                                                   &transmit_to_client,
 430                                                   lc);
 431 }
 432
 433
 434 /**
 435  * A client disconnected from us.  Tear down the local client
 436  * record.
 437  *
 438  * @param cls unused
 439  * @param client handle of the client
 440  */
 441 void
 442 GSF_client_disconnect_handler_ (void *cls,
 443                                 const struct GNUNET_SERVER_Client *client)
 444 {
 445   struct GSF_LocalClient *pos;
 446   struct DisconnectCallback *dc;
 447   struct ClientRequest *cr;
 448   struct ClientResponse *res;
 449
 450   pos = client_head;
 451   while ( (pos != NULL) &&
 452           (pos->client != client) )
 453     pos = pos->next;
 454   if (pos == NULL)
 455     return pos;
 456   while (NULL != (cr = pos->cr_head))
 457     {
 458       GNUNET_CONTAINER_DLL_remove (pos->cr_head,
 459                                    pos->cr_tail,
 460                                    cr);
 461       GSF_pending_request_cancel_ (cr->pr);
 462       GNUNET_free (cr);
 463     }
 464   while (NULL != (res = pos->res_head))
 465     {
 466       GNUNET_CONTAINER_DLL_remove (pos->res_head,
 467                                    pos->res_tail,
 468                                    res);
 469       GNUNET_free (res);
 470     }
 471   if (pos->th != NULL)
 472     {
 473       GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
 474       pos->th = NULL;
 475     }
 476   GSF_handle_local_client_disconnect_ (pos);
 477   GNUNET_free (pos);
 478 }
 479
 480
 481 /* end of gnunet-service-fs_lc.c */