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_SERVER_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 ((NULL != pos) && (pos->client != client))
 174     pos = pos->next;
 175   if (NULL != pos)
 176     return pos;
 177   pos = GNUNET_new (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_YES);
 201   GNUNET_STATISTICS_update (GSF_stats,
 202                             gettext_noop ("# client searches active"), -1,
 203                             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 last_transmission when was the last time we've tried to download this block? (FOREVER if unknown)
 222  * @param type type of the block
 223  * @param data response data, NULL on request expiration
 224  * @param data_len number of bytes in @e data
 225  */
 226 static void
 227 client_response_handler (void *cls, enum GNUNET_BLOCK_EvaluationResult eval,
 228                          struct GSF_PendingRequest *pr,
 229                          uint32_t reply_anonymity_level,
 230                          struct GNUNET_TIME_Absolute expiration,
 231                          struct GNUNET_TIME_Absolute last_transmission,
 232                          enum GNUNET_BLOCK_Type type, const void *data,
 233                          size_t data_len)
 234 {
 235   struct ClientRequest *cr = cls;
 236   struct GSF_LocalClient *lc;
 237   struct ClientPutMessage *pm;
 238   const struct GSF_PendingRequestData *prd;
 239   size_t msize;
 240
 241   if (NULL == data)
 242   {
 243     /* local-only request, with no result, clean up. */
 244     if (GNUNET_SCHEDULER_NO_TASK == cr->kill_task)
 245       cr->kill_task = GNUNET_SCHEDULER_add_now (&client_request_destroy,
 246                                                 cr);
 247     return;
 248   }
 249   prd = GSF_pending_request_get_data_ (pr);
 250   GNUNET_break (type != GNUNET_BLOCK_TYPE_ANY);
 251   if ((prd->type != type) && (prd->type != GNUNET_BLOCK_TYPE_ANY))
 252   {
 253     GNUNET_break (0);
 254     return;
 255   }
 256   GNUNET_STATISTICS_update (GSF_stats,
 257                             gettext_noop
 258                             ("# replies received for local clients"), 1,
 259                             GNUNET_NO);
 260   GNUNET_assert (pr == cr->pr);
 261   lc = cr->lc;
 262   msize = sizeof (struct ClientPutMessage) + data_len;
 263   {
 264     char buf[msize] GNUNET_ALIGN;
 265
 266     pm = (struct ClientPutMessage *) buf;
 267     pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
 268     pm->header.size = htons (msize);
 269     pm->type = htonl (type);
 270     pm->expiration = GNUNET_TIME_absolute_hton (expiration);
 271     pm->last_transmission = GNUNET_TIME_absolute_hton (last_transmission);
 272     pm->num_transmissions = htonl (prd->num_transmissions);
 273     pm->respect_offered = htonl (prd->respect_offered);
 274     memcpy (&pm[1], data, data_len);
 275     GSF_local_client_transmit_ (lc, &pm->header);
 276   }
 277   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 278               "Queued reply to query `%s' for local client\n",
 279               GNUNET_h2s (&prd->query), (unsigned int) prd->type);
 280   if (GNUNET_BLOCK_EVALUATION_OK_LAST != eval)
 281   {
 282     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 283                 "Evaluation %d - keeping query alive\n",
 284                 (int) eval);
 285     return;
 286   }
 287   if (GNUNET_SCHEDULER_NO_TASK == cr->kill_task)
 288     cr->kill_task = GNUNET_SCHEDULER_add_now (&client_request_destroy, cr);
 289 }
 290
 291
 292 /**
 293  * Handle START_SEARCH-message (search request from local client).
 294  * Only responsible for creating the request entry itself and setting
 295  * up reply callback and cancellation on client disconnect.  Does NOT
 296  * execute the actual request strategy (planning).
 297  *
 298  * @param client identification of the client
 299  * @param message the actual message
 300  * @param prptr where to store the pending request handle for the request
 301  * @return #GNUNET_YES to start local processing,
 302  *         #GNUNET_NO to not (yet) start local processing,
 303  *         #GNUNET_SYSERR on error
 304  */
 305 int
 306 GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
 307                                         const struct GNUNET_MessageHeader *message,
 308                                         struct GSF_PendingRequest **prptr)
 309 {
 310   static struct GNUNET_PeerIdentity all_zeros;
 311   const struct SearchMessage *sm;
 312   struct GSF_LocalClient *lc;
 313   struct ClientRequest *cr;
 314   struct GSF_PendingRequestData *prd;
 315   uint16_t msize;
 316   unsigned int sc;
 317   enum GNUNET_BLOCK_Type type;
 318   enum GSF_PendingRequestOptions options;
 319
 320   msize = ntohs (message->size);
 321   if ((msize < sizeof (struct SearchMessage)) ||
 322       (0 != (msize - sizeof (struct SearchMessage)) % sizeof (struct GNUNET_HashCode)))
 323   {
 324     GNUNET_break (0);
 325     *prptr = NULL;
 326     return GNUNET_SYSERR;
 327   }
 328   GNUNET_STATISTICS_update (GSF_stats,
 329                             gettext_noop ("# client searches received"), 1,
 330                             GNUNET_NO);
 331   sc = (msize - sizeof (struct SearchMessage)) / sizeof (struct GNUNET_HashCode);
 332   sm = (const struct SearchMessage *) message;
 333   type = ntohl (sm->type);
 334   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 335               "Received request for `%s' of type %u from local client\n",
 336               GNUNET_h2s (&sm->query), (unsigned int) type);
 337   lc = GSF_local_client_lookup_ (client);
 338   cr = NULL;
 339   /* detect duplicate UBLOCK requests */
 340   if ((type == GNUNET_BLOCK_TYPE_FS_UBLOCK) ||
 341       (type == GNUNET_BLOCK_TYPE_ANY))
 342   {
 343     cr = lc->cr_head;
 344     while (NULL != cr)
 345     {
 346       prd = GSF_pending_request_get_data_ (cr->pr);
 347       /* only unify with queries that hae not yet started local processing
 348          (SEARCH_MESSAGE_OPTION_CONTINUED was always set) and that have a
 349          matching query and type */
 350       if ((GNUNET_YES != prd->has_started) &&
 351           (0 != memcmp (&prd->query, &sm->query, sizeof (struct GNUNET_HashCode))) &&
 352           (prd->type == type))
 353         break;
 354       cr = cr->next;
 355     }
 356   }
 357   if (NULL != cr)
 358   {
 359     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 360                 "Have existing request, merging content-seen lists.\n");
 361     GSF_pending_request_update_ (cr->pr, (const struct GNUNET_HashCode *) &sm[1], sc);
 362     GNUNET_STATISTICS_update (GSF_stats,
 363                               gettext_noop
 364                               ("# client searches updated (merged content seen list)"),
 365                               1, GNUNET_NO);
 366   }
 367   else
 368   {
 369     GNUNET_STATISTICS_update (GSF_stats,
 370                               gettext_noop ("# client searches active"), 1,
 371                               GNUNET_NO);
 372     cr = GNUNET_new (struct ClientRequest);
 373     cr->lc = lc;
 374     GNUNET_CONTAINER_DLL_insert (lc->cr_head, lc->cr_tail, cr);
 375     options = GSF_PRO_LOCAL_REQUEST;
 376     if (0 != (SEARCH_MESSAGE_OPTION_LOOPBACK_ONLY & ntohl (sm->options)))
 377       options |= GSF_PRO_LOCAL_ONLY;
 378     cr->pr = GSF_pending_request_create_ (options, type,
 379                                           &sm->query,
 380                                           (0 !=
 381                                            memcmp (&sm->target, &all_zeros,
 382                                                    sizeof (struct GNUNET_PeerIdentity)))
 383                                           ? &sm->target : NULL, NULL, 0,
 384                                           0 /* bf */ ,
 385                                           ntohl (sm->anonymity_level),
 386                                           0 /* priority */ ,
 387                                           0 /* ttl */ ,
 388                                           0 /* sender PID */ ,
 389                                           0 /* origin PID */ ,
 390                                           (const struct GNUNET_HashCode *) &sm[1], sc,
 391                                           &client_response_handler, cr);
 392   }
 393   *prptr = cr->pr;
 394   return (0 !=
 395           (SEARCH_MESSAGE_OPTION_CONTINUED & ntohl (sm->options))) ? GNUNET_NO :
 396       GNUNET_YES;
 397 }
 398
 399
 400 /**
 401  * Transmit the given message by copying it to the target buffer
 402  * "buf".  "buf" will be NULL and "size" zero if the socket was closed
 403  * for writing in the meantime.  In that case, do nothing
 404  * (the disconnect or shutdown handler will take care of the rest).
 405  * If we were able to transmit messages and there are still more
 406  * pending, ask core again for further calls to this function.
 407  *
 408  * @param cls closure, pointer to the 'struct GSF_LocalClient'
 409  * @param size number of bytes available in buf
 410  * @param buf where the callee should write the message
 411  * @return number of bytes written to buf
 412  */
 413 static size_t
 414 transmit_to_client (void *cls, size_t size, void *buf)
 415 {
 416   struct GSF_LocalClient *lc = cls;
 417   char *cbuf = buf;
 418   struct ClientResponse *res;
 419   size_t msize;
 420
 421   lc->th = NULL;
 422   if (NULL == buf)
 423     return 0;
 424   msize = 0;
 425   while ((NULL != (res = lc->res_head)) && (res->msize <= size))
 426   {
 427     memcpy (&cbuf[msize], &res[1], res->msize);
 428     msize += res->msize;
 429     size -= res->msize;
 430     GNUNET_CONTAINER_DLL_remove (lc->res_head, lc->res_tail, res);
 431     GNUNET_free (res);
 432   }
 433   if (NULL != res)
 434     lc->th =
 435         GNUNET_SERVER_notify_transmit_ready (lc->client, res->msize,
 436                                              GNUNET_TIME_UNIT_FOREVER_REL,
 437                                              &transmit_to_client, lc);
 438   return msize;
 439 }
 440
 441
 442 /**
 443  * Transmit a message to the given local client as soon as possible.
 444  * If the client disconnects before transmission, the message is
 445  * simply discarded.
 446  *
 447  * @param lc recipient
 448  * @param msg message to transmit to client
 449  */
 450 void
 451 GSF_local_client_transmit_ (struct GSF_LocalClient *lc,
 452                             const struct GNUNET_MessageHeader *msg)
 453 {
 454   struct ClientResponse *res;
 455   size_t msize;
 456
 457   msize = ntohs (msg->size);
 458   res = GNUNET_malloc (sizeof (struct ClientResponse) + msize);
 459   res->lc = lc;
 460   res->msize = msize;
 461   memcpy (&res[1], msg, msize);
 462   GNUNET_CONTAINER_DLL_insert_tail (lc->res_head, lc->res_tail, res);
 463   if (NULL == lc->th)
 464     lc->th =
 465         GNUNET_SERVER_notify_transmit_ready (lc->client, msize,
 466                                              GNUNET_TIME_UNIT_FOREVER_REL,
 467                                              &transmit_to_client, lc);
 468 }
 469
 470
 471 /**
 472  * A client disconnected from us.  Tear down the local client
 473  * record.
 474  *
 475  * @param cls unused
 476  * @param client handle of the client
 477  */
 478 void
 479 GSF_client_disconnect_handler_ (void *cls, struct GNUNET_SERVER_Client *client)
 480 {
 481   struct GSF_LocalClient *pos;
 482   struct ClientRequest *cr;
 483   struct ClientResponse *res;
 484
 485   pos = client_head;
 486   while ((pos != NULL) && (pos->client != client))
 487     pos = pos->next;
 488   if (NULL == pos)
 489     return;
 490   while (NULL != (cr = pos->cr_head))
 491   {
 492     if (GNUNET_SCHEDULER_NO_TASK != cr->kill_task)
 493       GNUNET_SCHEDULER_cancel (cr->kill_task);
 494     client_request_destroy (cr, NULL);
 495   }
 496   while (NULL != (res = pos->res_head))
 497   {
 498     GNUNET_CONTAINER_DLL_remove (pos->res_head, pos->res_tail, res);
 499     GNUNET_free (res);
 500   }
 501   if (NULL != pos->th)
 502   {
 503     GNUNET_SERVER_notify_transmit_ready_cancel (pos->th);
 504     pos->th = NULL;
 505   }
 506   GSF_handle_local_client_disconnect_ (pos);
 507   GNUNET_CONTAINER_DLL_remove (client_head, client_tail, pos);
 508   GNUNET_free (pos);
 509 }
 510
 511
 512 /* end of gnunet-service-fs_lc.c */