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 START_SEARCH-message (search request from local client).
 183  *
 184  * @param client identification of the client
 185  * @param message the actual message
 186  * @return pending request handle for the request, NULL on error
 187  */
 188 struct GSF_PendingRequest *
 189 GSF_local_client_start_search_handler_ (struct GNUNET_SERVER_Client *client,
 190                                         const struct GNUNET_MessageHeader *message)
 191 {
 192   static GNUNET_HashCode all_zeros;
 193   const struct SearchMessage *sm;
 194   struct GSF_LocalClient *lc;
 195   struct ClientRequest *cr;
 196   struct GSF_PendingRequest *pr;
 197   uint16_t msize;
 198   unsigned int sc;
 199   enum GNUNET_BLOCK_Type type;
 200   enum GSF_PendingRequestOptions options;
 201
 202   msize = ntohs (message->size);
 203   if ( (msize < sizeof (struct SearchMessage)) ||
 204        (0 != (msize - sizeof (struct SearchMessage)) % sizeof (GNUNET_HashCode)) )
 205     {
 206       GNUNET_break (0);
 207       GNUNET_SERVER_receive_done (client,
 208                                   GNUNET_SYSERR);
 209       return NULL;
 210     }
 211   GNUNET_STATISTICS_update (stats,
 212                             gettext_noop ("# client searches received"),
 213                             1,
 214                             GNUNET_NO);
 215   sc = (msize - sizeof (struct SearchMessage)) / sizeof (GNUNET_HashCode);
 216   sm = (const struct SearchMessage*) message;
 217   type = ntohl (sm->type);
 218 #if DEBUG_FS
 219   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 220               "Received request for `%s' of type %u from local client\n",
 221               GNUNET_h2s (&sm->query),
 222               (unsigned int) type);
 223 #endif
 224   lc = GSF_local_client_lookup_ (client);
 225
 226   /* detect duplicate KBLOCK requests */
 227   if ( (type == GNUNET_BLOCK_TYPE_FS_KBLOCK) ||
 228        (type == GNUNET_BLOCK_TYPE_FS_NBLOCK) ||
 229        (type == GNUNET_BLOCK_TYPE_ANY) )
 230     {
 231       cr = lc->cr_head;
 232       while ( (cl != NULL) &&
 233               ( (0 != memcmp (GSF_pending_request_get_query_ (cr->pr),
 234                               &sm->query,
 235                               sizeof (GNUNET_HashCode))) ||
 236                 (GSF_pending_request_get_type_ (cr->pr) != type) ) )
 237         cr = cr->next;
 238       if (crl != NULL)
 239         {
 240 #if DEBUG_FS
 241           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242                       "Have existing request, merging content-seen lists.\n");
 243 #endif
 244           GSF_pending_request_update_ (cr->pr,
 245                                        &sm[1],
 246                                        sc);
 247           GNUNET_STATISTICS_update (stats,
 248                                     gettext_noop ("# client searches updated (merged content seen list)"),
 249                                     1,
 250                                     GNUNET_NO);
 251           GNUNET_SERVER_receive_done (client,
 252                                       GNUNET_OK);
 253           return NULL;
 254         }
 255     }
 256
 257   GNUNET_STATISTICS_update (stats,
 258                             gettext_noop ("# client searches active"),
 259                             1,
 260                             GNUNET_NO);
 261   cr = GNUNET_malloc (sizeof (struct ClientRequest));
 262   cr->lc = lc;
 263   GNUNET_CONTAINER_DLL_insert (lc->cr_head,
 264                                lc->cr_tail,
 265                                cr);
 266   options = GSF_PRO_LOCAL_REQUEST;
 267   if (0 != (1 & ntohl (sm->options)))
 268     options |= GSF_PRO_LOCAL_ONLY;
 269   cr->pr = GSF_pending_request_create_ (options,
 270                                         type,
 271                                         &sm->query,
 272                                         (type == GNUNET_BLOCK_TYPE_SBLOCK)
 273                                         ? &sm->target /* namespace */
 274                                         : NULL,
 275                                         (0 != memcmp (&sm->target,
 276                                                       &all_zeros,
 277                                                       sizeof (GNUNET_HashCode)))
 278                                         ? &sm->target,
 279                                         : NULL,
 280                                         NULL /* bf */, 0 /* mingle */,
 281                                         ntohl (sm->anonymity_level),
 282                                         0 /* priority */,
 283                                         &sm[1], sc,
 284                                         &client_response_handler,
 285                                         cr);
 286   return cr->pr;
 287 }
 288
 289
 290 /**
 291  * Transmit the given message by copying it to the target buffer
 292  * "buf".  "buf" will be NULL and "size" zero if the socket was closed
 293  * for writing in the meantime.  In that case, do nothing
 294  * (the disconnect or shutdown handler will take care of the rest).
 295  * If we were able to transmit messages and there are still more
 296  * pending, ask core again for further calls to this function.
 297  *
 298  * @param cls closure, pointer to the 'struct GSF_LocalClient'
 299  * @param size number of bytes available in buf
 300  * @param buf where the callee should write the message
 301  * @return number of bytes written to buf
 302  */
 303 static size_t
 304 transmit_to_client (void *cls,
 305                     size_t size,
 306                     void *buf)
 307 {
 308   struct GSF_LocalClient *lc = cls;
 309   char *cbuf = buf;
 310   struct ClientResponse *res;
 311   size_t msize;
 312
 313   cl->th = NULL;
 314   if (NULL == buf)
 315     return 0;
 316   msize = 0;
 317   while ( (NULL != (res = lc->res_head) ) &&
 318           (res->msize <= size) )
 319     {
 320       memcpy (&cbuf[msize], &res[1], res->msize);
 321       msize += res->msize;
 322       size -= res->msize;
 323       GNUNET_CONTAINER_DLL_remove (cl->res_head,
 324                                    cl->res_tail,
 325                                    res);
 326       GNUNET_free (res);
 327     }
 328   if (NULL != res)
 329     lc->th = GNUNET_SERVER_notify_transmit_ready (lc->client,
 330                                                   res->msize,
 331                                                   GNUNET_TIME_UNIT_FOREVER_REL,
 332                                                   &transmit_to_client,
 333                                                   lc);
 334   return msize;
 335 }
 336
 337
 338 /**
 339  * Transmit a message to the given local client as soon as possible.
 340  * If the client disconnects before transmission, the message is
 341  * simply discarded.
 342  *
 343  * @param lc recipient
 344  * @param msg message to transmit to client
 345  */
 346 void
 347 GSF_local_client_transmit_ (struct GSF_LocalClient *lc,
 348                             const struct GNUNET_MessageHeader *msg)
 349 {
 350   struct ClientResponse *res;
 351   size_t msize;
 352
 353   msize = ntohs (msg->size);
 354   res = GNUNET_malloc (sizeof (struct ClientResponse) + msize);
 355   res->lc = lc;
 356   res->msize = msize;
 357   GNUNET_CONTAINER_DLL_insert_tail (lc->res_head,
 358                                     lc->res_tail,
 359                                     res);
 360   if (NULL == lc->tc)
 361     lc->tc = GNUNET_CLIENT_notify_transmit_ready (lc->client,
 362                                                   msize,
 363                                                   GNUNET_TIME_UNIT_FOREVER_REL,
 364                                                   GNUNET_NO,
 365                                                   &transmit_to_client,
 366                                                   lc);
 367 }
 368
 369
 370 /**
 371  * A client disconnected from us.  Tear down the local client
 372  * record.
 373  *
 374  * @param cls unused
 375  * @param client handle of the client
 376  */
 377 void
 378 GSF_client_disconnect_handler_ (void *cls,
 379                                 const struct GNUNET_SERVER_Client *client)
 380 {
 381   struct GSF_LocalClient *pos;
 382   struct DisconnectCallback *dc;
 383   struct ClientRequest *cr;
 384   struct ClientResponse *res;
 385
 386   pos = client_head;
 387   while ( (pos != NULL) &&
 388           (pos->client != client) )
 389     pos = pos->next;
 390   if (pos == NULL)
 391     return pos;
 392   while (NULL != (cr = pos->cr_head))
 393     {
 394       GNUNET_CONTAINER_DLL_remove (pos->cr_head,
 395                                    pos->cr_tail,
 396                                    cr);
 397       GSF_pending_request_cancel_ (cr->pr);
 398       GNUNET_free (cr);
 399     }
 400   while (NULL != (res = pos->res_head))
 401     {
 402       GNUNET_CONTAINER_DLL_remove (pos->res_head,
 403                                    pos->res_tail,
 404                                    res);
 405       GNUNET_free (res);
 406     }
 407   if (pos->th != NULL)
 408     {
 409       GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
 410       pos->th = NULL;
 411     }
 412   GSF_handle_local_client_disconnect_ (pos);
 413   GNUNET_free (pos);
 414 }
 415
 416
 417 /* end of gnunet-service-fs_lc.c */