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