dead
[oweals/gnunet.git] / src / fs / gnunet-service-fs.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010 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 2, 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.c
23  * @brief gnunet anonymity protocol implementation
24  * @author Christian Grothoff
25  *
26  * FIXME:
27  * - code not clear in terms of which function initializes bloomfilter when!
28  * TODO:
29  * - have non-zero preference / priority for requests we initiate!
30  * - track stats for hot-path routing
31  * - implement hot-path routing decision procedure
32  * - implement: bound_priority, test_load_too_high, validate_nblock
33  * - add content migration support (store locally) [or create new service]
34  * - statistics
35  */
36 #include "platform.h"
37 #include <float.h>
38 #include "gnunet_constants.h"
39 #include "gnunet_core_service.h"
40 #include "gnunet_datastore_service.h"
41 #include "gnunet_peer_lib.h"
42 #include "gnunet_protocols.h"
43 #include "gnunet_signatures.h"
44 #include "gnunet_statistics_service.h"
45 #include "gnunet_util_lib.h"
46 #include "gnunet-service-fs_drq.h"
47 #include "gnunet-service-fs_indexing.h"
48 #include "fs.h"
49
50 #define DEBUG_FS GNUNET_YES
51
52 /**
53  * Maximum number of outgoing messages we queue per peer.
54  * FIXME: make configurable?
55  */
56 #define MAX_QUEUE_PER_PEER 16
57
58 /**
59  * Inverse of the probability that we will submit the same query
60  * to the same peer again.  If the same peer already got the query
61  * repeatedly recently, the probability is multiplied by the inverse
62  * of this number each time.  Note that we only try about every TTL_DECREMENT/2
63  * plus MAX_CORK_DELAY (so roughly every 3.5s).
64  */
65 #define RETRY_PROBABILITY_INV 3
66
67 /**
68  * What is the maximum delay for a P2P FS message (in our interaction
69  * with core)?  FS-internal delays are another story.  The value is
70  * chosen based on the 32k block size.  Given that peers typcially
71  * have at least 1 kb/s bandwidth, 45s waits give us a chance to
72  * transmit one message even to the lowest-bandwidth peers.
73  */
74 #define MAX_TRANSMIT_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 45)
75
76
77
78 /**
79  * Maximum number of requests (from other peers) that we're
80  * willing to have pending at any given point in time.
81  * FIXME: set from configuration.
82  */
83 static uint64_t max_pending_requests = (32 * 1024);
84
85
86 /**
87  * Information we keep for each pending reply.  The
88  * actual message follows at the end of this struct.
89  */
90 struct PendingMessage;
91
92
93 /**
94  * Function called upon completion of a transmission.
95  *
96  * @param cls closure
97  * @param pid ID of receiving peer, 0 on transmission error
98  */
99 typedef void (*TransmissionContinuation)(void * cls, 
100                                          GNUNET_PEER_Id tpid);
101
102
103 /**
104  * Information we keep for each pending message (GET/PUT).  The
105  * actual message follows at the end of this struct.
106  */
107 struct PendingMessage
108 {
109   /**
110    * This is a doubly-linked list of messages to the same peer.
111    */
112   struct PendingMessage *next;
113
114   /**
115    * This is a doubly-linked list of messages to the same peer.
116    */
117   struct PendingMessage *prev;
118
119   /**
120    * Entry in pending message list for this pending message.
121    */ 
122   struct PendingMessageList *pml;  
123
124   /**
125    * Function to call immediately once we have transmitted this
126    * message.
127    */
128   TransmissionContinuation cont;
129
130   /**
131    * Closure for cont.
132    */
133   void *cont_cls;
134
135   /**
136    * Size of the reply; actual reply message follows
137    * at the end of this struct.
138    */
139   size_t msize;
140   
141   /**
142    * How important is this message for us?
143    */
144   uint32_t priority;
145  
146 };
147
148
149 /**
150  * Information about a peer that we are connected to.
151  * We track data that is useful for determining which
152  * peers should receive our requests.  We also keep
153  * a list of messages to transmit to this peer.
154  */
155 struct ConnectedPeer
156 {
157
158   /**
159    * List of the last clients for which this peer successfully
160    * answered a query.
161    */
162   struct GNUNET_SERVER_Client *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
163
164   /**
165    * List of the last PIDs for which
166    * this peer successfully answered a query;
167    * We use 0 to indicate no successful reply.
168    */
169   GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
170
171   /**
172    * Average delay between sending the peer a request and
173    * getting a reply (only calculated over the requests for
174    * which we actually got a reply).   Calculated
175    * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
176    */ 
177   struct GNUNET_TIME_Relative avg_delay;
178
179   /**
180    * Handle for an active request for transmission to this
181    * peer, or NULL.
182    */
183   struct GNUNET_CORE_TransmitHandle *cth;
184
185   /**
186    * Messages (replies, queries, content migration) we would like to
187    * send to this peer in the near future.  Sorted by priority, head.
188    */
189   struct PendingMessage *pending_messages_head;
190
191   /**
192    * Messages (replies, queries, content migration) we would like to
193    * send to this peer in the near future.  Sorted by priority, tail.
194    */
195   struct PendingMessage *pending_messages_tail;
196
197   /**
198    * Average priority of successful replies.  Calculated
199    * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
200    */
201   double avg_priority;
202
203   /**
204    * Increase in traffic preference still to be submitted
205    * to the core service for this peer. FIXME: double or 'uint64_t'?
206    */
207   double inc_preference;
208
209   /**
210    * The peer's identity.
211    */
212   GNUNET_PEER_Id pid;  
213
214   /**
215    * Size of the linked list of 'pending_messages'.
216    */
217   unsigned int pending_requests;
218
219   /**
220    * Which offset in "last_p2p_replies" will be updated next?
221    * (we go round-robin).
222    */
223   unsigned int last_p2p_replies_woff;
224
225   /**
226    * Which offset in "last_client_replies" will be updated next?
227    * (we go round-robin).
228    */
229   unsigned int last_client_replies_woff;
230
231 };
232
233
234 /**
235  * Information we keep for each pending request.  We should try to
236  * keep this struct as small as possible since its memory consumption
237  * is key to how many requests we can have pending at once.
238  */
239 struct PendingRequest;
240
241
242 /**
243  * Doubly-linked list of requests we are performing
244  * on behalf of the same client.
245  */
246 struct ClientRequestList
247 {
248
249   /**
250    * This is a doubly-linked list.
251    */
252   struct ClientRequestList *next;
253
254   /**
255    * This is a doubly-linked list.
256    */
257   struct ClientRequestList *prev;
258
259   /**
260    * Request this entry represents.
261    */
262   struct PendingRequest *req;
263
264   /**
265    * Client list this request belongs to.
266    */
267   struct ClientList *client_list;
268
269 };
270
271
272 /**
273  * Replies to be transmitted to the client.  The actual
274  * response message is allocated after this struct.
275  */
276 struct ClientResponseMessage
277 {
278   /**
279    * This is a doubly-linked list.
280    */
281   struct ClientResponseMessage *next;
282
283   /**
284    * This is a doubly-linked list.
285    */
286   struct ClientResponseMessage *prev;
287
288   /**
289    * Client list entry this response belongs to.
290    */
291   struct ClientList *client_list;
292
293   /**
294    * Number of bytes in the response.
295    */
296   size_t msize;
297 };
298
299
300 /**
301  * Linked list of clients we are performing requests
302  * for right now.
303  */
304 struct ClientList
305 {
306   /**
307    * This is a linked list.
308    */
309   struct ClientList *next;
310
311   /**
312    * ID of a client making a request, NULL if this entry is for a
313    * peer.
314    */
315   struct GNUNET_SERVER_Client *client;
316
317   /**
318    * Head of list of requests performed on behalf
319    * of this client right now.
320    */
321   struct ClientRequestList *rl_head;
322
323   /**
324    * Tail of list of requests performed on behalf
325    * of this client right now.
326    */
327   struct ClientRequestList *rl_tail;
328
329   /**
330    * Head of linked list of responses.
331    */
332   struct ClientResponseMessage *res_head;
333
334   /**
335    * Tail of linked list of responses.
336    */
337   struct ClientResponseMessage *res_tail;
338
339   /**
340    * Context for sending replies.
341    */
342   struct GNUNET_CONNECTION_TransmitHandle *th;
343
344 };
345
346
347 /**
348  * Doubly-linked list of messages we are performing
349  * due to a pending request.
350  */
351 struct PendingMessageList
352 {
353
354   /**
355    * This is a doubly-linked list of messages on behalf of the same request.
356    */
357   struct PendingMessageList *next;
358
359   /**
360    * This is a doubly-linked list of messages on behalf of the same request.
361    */
362   struct PendingMessageList *prev;
363
364   /**
365    * Message this entry represents.
366    */
367   struct PendingMessage *pm;
368
369   /**
370    * Request this entry belongs to.
371    */
372   struct PendingRequest *req;
373
374   /**
375    * Peer this message is targeted for.
376    */
377   struct ConnectedPeer *target;
378
379 };
380
381
382 /**
383  * Information we keep for each pending request.  We should try to
384  * keep this struct as small as possible since its memory consumption
385  * is key to how many requests we can have pending at once.
386  */
387 struct PendingRequest
388 {
389
390   /**
391    * If this request was made by a client, this is our entry in the
392    * client request list; otherwise NULL.
393    */
394   struct ClientRequestList *client_request_list;
395
396   /**
397    * Entry of peer responsible for this entry (if this request
398    * was made by a peer).
399    */
400   struct ConnectedPeer *cp;
401
402   /**
403    * If this is a namespace query, pointer to the hash of the public
404    * key of the namespace; otherwise NULL.  Pointer will be to the 
405    * end of this struct (so no need to free it).
406    */
407   const GNUNET_HashCode *namespace;
408
409   /**
410    * Bloomfilter we use to filter out replies that we don't care about
411    * (anymore).  NULL as long as we are interested in all replies.
412    */
413   struct GNUNET_CONTAINER_BloomFilter *bf;
414
415   /**
416    * Context of our GNUNET_CORE_peer_change_preference call.
417    */
418   struct GNUNET_CORE_InformationRequestContext *irc;
419
420   /**
421    * Hash code of all replies that we have seen so far (only valid
422    * if client is not NULL since we only track replies like this for
423    * our own clients).
424    */
425   GNUNET_HashCode *replies_seen;
426
427   /**
428    * Node in the heap representing this entry; NULL
429    * if we have no heap node.
430    */
431   struct GNUNET_CONTAINER_HeapNode *hnode;
432
433   /**
434    * Head of list of messages being performed on behalf of this
435    * request.
436    */
437   struct PendingMessageList *pending_head;
438
439   /**
440    * Tail of list of messages being performed on behalf of this
441    * request.
442    */
443   struct PendingMessageList *pending_tail;
444
445   /**
446    * When did we first see this request (form this peer), or, if our
447    * client is initiating, when did we last initiate a search?
448    */
449   struct GNUNET_TIME_Absolute start_time;
450
451   /**
452    * The query that this request is for.
453    */
454   GNUNET_HashCode query;
455
456   /**
457    * The task responsible for transmitting queries
458    * for this request.
459    */
460   GNUNET_SCHEDULER_TaskIdentifier task;
461
462   /**
463    * (Interned) Peer identifier that identifies a preferred target
464    * for requests.
465    */
466   GNUNET_PEER_Id target_pid;
467
468   /**
469    * (Interned) Peer identifiers of peers that have already
470    * received our query for this content.
471    */
472   GNUNET_PEER_Id *used_pids;
473   
474   /**
475    * Our entry in the DRQ (non-NULL while we wait for our
476    * turn to interact with the local database).
477    */
478   struct DatastoreRequestQueue *drq;
479
480   /**
481    * Size of the 'bf' (in bytes).
482    */
483   size_t bf_size;
484
485   /**
486    * Desired anonymity level; only valid for requests from a local client.
487    */
488   uint32_t anonymity_level;
489
490   /**
491    * How many entries in "used_pids" are actually valid?
492    */
493   unsigned int used_pids_off;
494
495   /**
496    * How long is the "used_pids" array?
497    */
498   unsigned int used_pids_size;
499
500   /**
501    * Number of results found for this request.
502    */
503   unsigned int results_found;
504
505   /**
506    * How many entries in "replies_seen" are actually valid?
507    */
508   unsigned int replies_seen_off;
509
510   /**
511    * How long is the "replies_seen" array?
512    */
513   unsigned int replies_seen_size;
514   
515   /**
516    * Priority with which this request was made.  If one of our clients
517    * made the request, then this is the current priority that we are
518    * using when initiating the request.  This value is used when
519    * we decide to reward other peers with trust for providing a reply.
520    */
521   uint32_t priority;
522
523   /**
524    * Priority points left for us to spend when forwarding this request
525    * to other peers.
526    */
527   uint32_t remaining_priority;
528
529   /**
530    * Number to mingle hashes for bloom-filter tests with.
531    */
532   int32_t mingle;
533
534   /**
535    * TTL with which we saw this request (or, if we initiated, TTL that
536    * we used for the request).
537    */
538   int32_t ttl;
539   
540   /**
541    * Type of the content that this request is for.
542    */
543   uint32_t type;
544
545   /**
546    * Remove this request after transmission of the current response.
547    */
548   int do_remove;
549
550 };
551
552
553 /**
554  * Our scheduler.
555  */
556 static struct GNUNET_SCHEDULER_Handle *sched;
557
558 /**
559  * Our configuration.
560  */
561 static const struct GNUNET_CONFIGURATION_Handle *cfg;
562
563 /**
564  * Map of peer identifiers to "struct ConnectedPeer" (for that peer).
565  */
566 static struct GNUNET_CONTAINER_MultiHashMap *connected_peers;
567
568 /**
569  * Map of peer identifiers to "struct PendingRequest" (for that peer).
570  */
571 static struct GNUNET_CONTAINER_MultiHashMap *peer_request_map;
572
573 /**
574  * Map of query identifiers to "struct PendingRequest" (for that query).
575  */
576 static struct GNUNET_CONTAINER_MultiHashMap *query_request_map;
577
578 /**
579  * Heap with the request that will expire next at the top.  Contains
580  * pointers of type "struct PendingRequest*"; these will *also* be
581  * aliased from the "requests_by_peer" data structures and the
582  * "requests_by_query" table.  Note that requests from our clients
583  * don't expire and are thus NOT in the "requests_by_expiration"
584  * (or the "requests_by_peer" tables).
585  */
586 static struct GNUNET_CONTAINER_Heap *requests_by_expiration_heap;
587
588 /**
589  * Handle for reporting statistics.
590  */
591 static struct GNUNET_STATISTICS_Handle *stats;
592
593 /**
594  * Linked list of clients we are currently processing requests for.
595  */
596 static struct ClientList *client_list;
597
598 /**
599  * Pointer to handle to the core service (points to NULL until we've
600  * connected to it).
601  */
602 static struct GNUNET_CORE_Handle *core;
603
604
605 /* ******************* clean up functions ************************ */
606
607
608 /**
609  * We're done with a particular message list entry.
610  * Free all associated resources.
611  * 
612  * @param pml entry to destroy
613  */
614 static void
615 destroy_pending_message_list_entry (struct PendingMessageList *pml)
616 {
617   GNUNET_CONTAINER_DLL_remove (pml->req->pending_head,
618                                pml->req->pending_tail,
619                                pml);
620   GNUNET_CONTAINER_DLL_remove (pml->target->pending_messages_head,
621                                pml->target->pending_messages_tail,
622                                pml->pm);
623   pml->target->pending_requests--;
624   GNUNET_free (pml->pm);
625   GNUNET_free (pml);
626 }
627
628
629 /**
630  * Destroy the given pending message (and call the respective
631  * continuation).
632  *
633  * @param pm message to destroy
634  * @param tpid id of peer that the message was delivered to, or 0 for none
635  */
636 static void
637 destroy_pending_message (struct PendingMessage *pm,
638                          GNUNET_PEER_Id tpid)
639 {
640   struct PendingMessageList *pml = pm->pml;
641   TransmissionContinuation cont;
642   void *cont_cls;
643
644   GNUNET_assert (pml->pm == pm);
645   GNUNET_assert ( (tpid == 0) || (tpid == pml->target->pid) );
646   cont = pm->cont;
647   cont_cls = pm->cont_cls;
648   destroy_pending_message_list_entry (pml);
649   cont (cont_cls, tpid);  
650 }
651
652
653 /**
654  * We're done processing a particular request.
655  * Free all associated resources.
656  *
657  * @param pr request to destroy
658  */
659 static void
660 destroy_pending_request (struct PendingRequest *pr)
661 {
662   struct GNUNET_PeerIdentity pid;
663
664   if (pr->hnode != NULL)
665     {
666       GNUNET_CONTAINER_heap_remove_node (requests_by_expiration_heap,
667                                          pr->hnode);
668       pr->hnode = NULL;
669       GNUNET_STATISTICS_update (stats,
670                                 gettext_noop ("# P2P searches active"),
671                                 -1,
672                                 GNUNET_NO);
673     }
674   else
675     {
676       GNUNET_STATISTICS_update (stats,
677                                 gettext_noop ("# client searches active"),
678                                 -1,
679                                 GNUNET_NO);
680     }
681   /* might have already been removed from map in 'process_reply' (if
682      there was a unique reply) or never inserted if it was a
683      duplicate; hence ignore the return value here */
684   (void) GNUNET_CONTAINER_multihashmap_remove (query_request_map,
685                                                &pr->query,
686                                                pr);
687   if (pr->drq != NULL)
688     {
689       GNUNET_FS_drq_get_cancel (pr->drq);
690       pr->drq = NULL;
691     }
692   if (pr->client_request_list != NULL)
693     {
694       GNUNET_CONTAINER_DLL_remove (pr->client_request_list->client_list->rl_head,
695                                    pr->client_request_list->client_list->rl_tail,
696                                    pr->client_request_list);
697       GNUNET_free (pr->client_request_list);
698       pr->client_request_list = NULL;
699     }
700   if (pr->cp != NULL)
701     {
702       GNUNET_PEER_resolve (pr->cp->pid,
703                            &pid);
704       (void) GNUNET_CONTAINER_multihashmap_remove (peer_request_map,
705                                                    &pid.hashPubKey,
706                                                    pr);
707       pr->cp = NULL;
708     }
709   if (pr->bf != NULL)
710     {
711       GNUNET_CONTAINER_bloomfilter_free (pr->bf);                                        
712       pr->bf = NULL;
713     }
714   if (pr->irc != NULL)
715     {
716       GNUNET_CORE_peer_change_preference_cancel (pr->irc);
717       pr->irc = NULL;
718     }
719   if (pr->replies_seen != NULL)
720     {
721       GNUNET_free (pr->replies_seen);
722       pr->replies_seen = NULL;
723     }
724   if (pr->task != GNUNET_SCHEDULER_NO_TASK)
725     {
726       GNUNET_SCHEDULER_cancel (sched,
727                                pr->task);
728       pr->task = GNUNET_SCHEDULER_NO_TASK;
729     }
730   while (NULL != pr->pending_head)    
731     destroy_pending_message_list_entry (pr->pending_head);
732   GNUNET_PEER_change_rc (pr->target_pid, -1);
733   if (pr->used_pids != NULL)
734     {
735       GNUNET_PEER_decrement_rcs (pr->used_pids, pr->used_pids_off);
736       GNUNET_free (pr->used_pids);
737       pr->used_pids_off = 0;
738       pr->used_pids_size = 0;
739       pr->used_pids = NULL;
740     }
741   GNUNET_free (pr);
742 }
743
744
745 /**
746  * Method called whenever a given peer connects.
747  *
748  * @param cls closure, not used
749  * @param peer peer identity this notification is about
750  * @param latency reported latency of the connection with 'other'
751  * @param distance reported distance (DV) to 'other' 
752  */
753 static void 
754 peer_connect_handler (void *cls,
755                       const struct
756                       GNUNET_PeerIdentity * peer,
757                       struct GNUNET_TIME_Relative latency,
758                       uint32_t distance)
759 {
760   struct ConnectedPeer *cp;
761
762   cp = GNUNET_malloc (sizeof (struct ConnectedPeer));
763   cp->pid = GNUNET_PEER_intern (peer);
764   GNUNET_CONTAINER_multihashmap_put (connected_peers,
765                                      &peer->hashPubKey,
766                                      cp,
767                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
768 }
769
770
771 /**
772  * Free (each) request made by the peer.
773  *
774  * @param cls closure, points to peer that the request belongs to
775  * @param key current key code
776  * @param value value in the hash map
777  * @return GNUNET_YES (we should continue to iterate)
778  */
779 static int
780 destroy_request (void *cls,
781                  const GNUNET_HashCode * key,
782                  void *value)
783 {
784   const struct GNUNET_PeerIdentity * peer = cls;
785   struct PendingRequest *pr = value;
786   
787   GNUNET_CONTAINER_multihashmap_remove (peer_request_map,
788                                         &peer->hashPubKey,
789                                         pr);
790   destroy_pending_request (pr);
791   return GNUNET_YES;
792 }
793
794
795 /**
796  * Method called whenever a peer disconnects.
797  *
798  * @param cls closure, not used
799  * @param peer peer identity this notification is about
800  */
801 static void
802 peer_disconnect_handler (void *cls,
803                          const struct
804                          GNUNET_PeerIdentity * peer)
805 {
806   struct ConnectedPeer *cp;
807   struct PendingMessage *pm;
808   unsigned int i;
809
810   GNUNET_CONTAINER_multihashmap_get_multiple (peer_request_map,
811                                               &peer->hashPubKey,
812                                               &destroy_request,
813                                               (void*) peer);
814   cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
815                                           &peer->hashPubKey);
816   if (cp == NULL)
817     return;
818   for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
819     {
820       if (NULL != cp->last_client_replies[i])
821         {
822           GNUNET_SERVER_client_drop (cp->last_client_replies[i]);
823           cp->last_client_replies[i] = NULL;
824         }
825     }
826   GNUNET_CONTAINER_multihashmap_remove (connected_peers,
827                                         &peer->hashPubKey,
828                                         cp);
829   GNUNET_PEER_change_rc (cp->pid, -1);
830   GNUNET_PEER_decrement_rcs (cp->last_p2p_replies, P2P_SUCCESS_LIST_SIZE);
831   if (NULL != cp->cth)
832     GNUNET_CORE_notify_transmit_ready_cancel (cp->cth);
833   while (NULL != (pm = cp->pending_messages_head))
834     destroy_pending_message (pm, 0 /* delivery failed */);
835   GNUNET_break (0 == cp->pending_requests);
836   GNUNET_free (cp);
837 }
838
839
840 /**
841  * Iterator over hash map entries that removes all occurences
842  * of the given 'client' from the 'last_client_replies' of the
843  * given connected peer.
844  *
845  * @param cls closure, the 'struct GNUNET_SERVER_Client*' to remove
846  * @param key current key code (unused)
847  * @param value value in the hash map (the 'struct ConnectedPeer*' to change)
848  * @return GNUNET_YES (we should continue to iterate)
849  */
850 static int
851 remove_client_from_last_client_replies (void *cls,
852                                         const GNUNET_HashCode * key,
853                                         void *value)
854 {
855   struct GNUNET_SERVER_Client *client = cls;
856   struct ConnectedPeer *cp = value;
857   unsigned int i;
858
859   for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
860     {
861       if (cp->last_client_replies[i] == client)
862         {
863           GNUNET_SERVER_client_drop (cp->last_client_replies[i]);
864           cp->last_client_replies[i] = NULL;
865         }
866     }  
867   return GNUNET_YES;
868 }
869
870
871 /**
872  * A client disconnected.  Remove all of its pending queries.
873  *
874  * @param cls closure, NULL
875  * @param client identification of the client
876  */
877 static void
878 handle_client_disconnect (void *cls,
879                           struct GNUNET_SERVER_Client
880                           * client)
881 {
882   struct ClientList *pos;
883   struct ClientList *prev;
884   struct ClientRequestList *rcl;
885   struct ClientResponseMessage *creply;
886
887   if (client == NULL)
888     return;
889   prev = NULL;
890   pos = client_list;
891   while ( (NULL != pos) &&
892           (pos->client != client) )
893     {
894       prev = pos;
895       pos = pos->next;
896     }
897   if (pos == NULL)
898     return; /* no requests pending for this client */
899   while (NULL != (rcl = pos->rl_head))
900     {
901       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
902                   "Destroying pending request `%s' on disconnect\n",
903                   GNUNET_h2s (&rcl->req->query));
904       destroy_pending_request (rcl->req);
905     }
906   if (prev == NULL)
907     client_list = pos->next;
908   else
909     prev->next = pos->next;
910   if (pos->th != NULL)
911     {
912       GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
913       pos->th = NULL;
914     }
915   while (NULL != (creply = pos->res_head))
916     {
917       GNUNET_CONTAINER_DLL_remove (pos->res_head,
918                                    pos->res_tail,
919                                    creply);
920       GNUNET_free (creply);
921     }    
922   GNUNET_SERVER_client_drop (pos->client);
923   GNUNET_free (pos);
924   GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
925                                          &remove_client_from_last_client_replies,
926                                          client);
927 }
928
929
930 /**
931  * Iterator to free peer entries.
932  *
933  * @param cls closure, unused
934  * @param key current key code
935  * @param value value in the hash map (peer entry)
936  * @return GNUNET_YES (we should continue to iterate)
937  */
938 static int 
939 clean_peer (void *cls,
940             const GNUNET_HashCode * key,
941             void *value)
942 {
943   peer_disconnect_handler (NULL, (const struct GNUNET_PeerIdentity*) key);
944   return GNUNET_YES;
945 }
946
947
948 /**
949  * Task run during shutdown.
950  *
951  * @param cls unused
952  * @param tc unused
953  */
954 static void
955 shutdown_task (void *cls,
956                const struct GNUNET_SCHEDULER_TaskContext *tc)
957 {
958   while (client_list != NULL)
959     handle_client_disconnect (NULL,
960                               client_list->client);
961   GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
962                                          &clean_peer,
963                                          NULL);
964   GNUNET_break (0 == GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap));
965   GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
966   requests_by_expiration_heap = 0;
967   GNUNET_CONTAINER_multihashmap_destroy (connected_peers);
968   connected_peers = NULL;
969   GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_size (query_request_map));
970   GNUNET_CONTAINER_multihashmap_destroy (query_request_map);
971   query_request_map = NULL;
972   GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_size (peer_request_map));
973   GNUNET_CONTAINER_multihashmap_destroy (peer_request_map);
974   peer_request_map = NULL;
975   GNUNET_assert (NULL != core);
976   GNUNET_CORE_disconnect (core);
977   core = NULL;
978   if (stats != NULL)
979     {
980       GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
981       stats = NULL;
982     }
983   sched = NULL;
984   cfg = NULL;  
985 }
986
987
988 /* ******************* Utility functions  ******************** */
989
990
991 /**
992  * Transmit the given message by copying it to the target buffer
993  * "buf".  "buf" will be NULL and "size" zero if the socket was closed
994  * for writing in the meantime.  In that case, do nothing
995  * (the disconnect or shutdown handler will take care of the rest).
996  * If we were able to transmit messages and there are still more
997  * pending, ask core again for further calls to this function.
998  *
999  * @param cls closure, pointer to the 'struct ConnectedPeer*'
1000  * @param size number of bytes available in buf
1001  * @param buf where the callee should write the message
1002  * @return number of bytes written to buf
1003  */
1004 static size_t
1005 transmit_to_peer (void *cls,
1006                   size_t size, void *buf)
1007 {
1008   struct ConnectedPeer *cp = cls;
1009   char *cbuf = buf;
1010   struct GNUNET_PeerIdentity pid;
1011   struct PendingMessage *pm;
1012   size_t msize;
1013  
1014   cp->cth = NULL;
1015   if (NULL == buf)
1016     {
1017 #if DEBUG_FS
1018       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1019                   "Dropping message, core too busy.\n");
1020 #endif
1021       return 0;
1022     }
1023   msize = 0;
1024   while ( (NULL != (pm = cp->pending_messages_head) ) &&
1025           (pm->msize <= size) )
1026     {
1027       memcpy (&cbuf[msize], &pm[1], pm->msize);
1028       msize += pm->msize;
1029       size -= pm->msize;
1030       destroy_pending_message (pm, cp->pid);
1031     }
1032   if (NULL != pm)
1033     {
1034       GNUNET_PEER_resolve (cp->pid,
1035                            &pid);
1036       cp->cth = GNUNET_CORE_notify_transmit_ready (core,
1037                                                    pm->priority,
1038                                                    GNUNET_CONSTANTS_SERVICE_TIMEOUT,
1039                                                    &pid,
1040                                                    pm->msize,
1041                                                    &transmit_to_peer,
1042                                                    cp);
1043     }
1044 #if DEBUG_FS > 2
1045   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1046               "Transmitting %u bytes to peer %u.\n",
1047               msize,
1048               cp->pid);
1049 #endif
1050   return msize;
1051 }
1052
1053
1054 /**
1055  * Add a message to the set of pending messages for the given peer.
1056  *
1057  * @param cp peer to send message to
1058  * @param pm message to queue
1059  * @param pr request on which behalf this message is being queued
1060  */
1061 static void
1062 add_to_pending_messages_for_peer (struct ConnectedPeer *cp,
1063                                   struct PendingMessage *pm,
1064                                   struct PendingRequest *pr)
1065 {
1066   struct PendingMessage *pos;
1067   struct PendingMessageList *pml;
1068   struct GNUNET_PeerIdentity pid;
1069
1070   GNUNET_assert (pm->next == NULL);
1071   GNUNET_assert (pm->pml == NULL);    
1072   pml = GNUNET_malloc (sizeof (struct PendingMessageList));
1073   pml->req = pr;
1074   pml->target = cp;
1075   pml->pm = pm;
1076   pm->pml = pml;  
1077   GNUNET_CONTAINER_DLL_insert (pr->pending_head,
1078                                pr->pending_tail,
1079                                pml);
1080   pos = cp->pending_messages_head;
1081   while ( (pos != NULL) &&
1082           (pm->priority < pos->priority) )
1083     pos = pos->next;    
1084   GNUNET_CONTAINER_DLL_insert_after (cp->pending_messages_head,
1085                                      cp->pending_messages_tail,
1086                                      pos,
1087                                      pm);
1088   cp->pending_requests++;
1089   if (cp->pending_requests > MAX_QUEUE_PER_PEER)
1090     destroy_pending_message (cp->pending_messages_tail, 0);  
1091   if (cp->cth == NULL)
1092     {
1093       /* need to schedule transmission */
1094       GNUNET_PEER_resolve (cp->pid, &pid);
1095       cp->cth = GNUNET_CORE_notify_transmit_ready (core,
1096                                                    cp->pending_messages_head->priority,
1097                                                    MAX_TRANSMIT_DELAY,
1098                                                    &pid,
1099                                                    cp->pending_messages_head->msize,
1100                                                    &transmit_to_peer,
1101                                                    cp);
1102     }
1103   if (cp->cth == NULL)
1104     {
1105 #if DEBUG_FS
1106       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1107                   "Failed to schedule transmission with core!\n");
1108 #endif
1109       /* FIXME: call stats (rare, bad case) */
1110     }
1111 }
1112
1113
1114 /**
1115  * Mingle hash with the mingle_number to produce different bits.
1116  */
1117 static void
1118 mingle_hash (const GNUNET_HashCode * in,
1119              int32_t mingle_number, 
1120              GNUNET_HashCode * hc)
1121 {
1122   GNUNET_HashCode m;
1123
1124   GNUNET_CRYPTO_hash (&mingle_number, 
1125                       sizeof (int32_t), 
1126                       &m);
1127   GNUNET_CRYPTO_hash_xor (&m, in, hc);
1128 }
1129
1130
1131 /**
1132  * Test if the load on this peer is too high
1133  * to even consider processing the query at
1134  * all.
1135  * 
1136  * @return GNUNET_YES if the load is too high, GNUNET_NO otherwise
1137  */
1138 static int
1139 test_load_too_high ()
1140 {
1141   return GNUNET_NO; // FIXME
1142 }
1143
1144
1145 /* ******************* Pending Request Refresh Task ******************** */
1146
1147
1148
1149 /**
1150  * We use a random delay to make the timing of requests less
1151  * predictable.  This function returns such a random delay.  We add a base
1152  * delay of MAX_CORK_DELAY (1s).
1153  *
1154  * FIXME: make schedule dependent on the specifics of the request?
1155  * Or bandwidth and number of connected peers and load?
1156  *
1157  * @return random delay to use for some request, between 1s and 1000+TTL_DECREMENT ms
1158  */
1159 static struct GNUNET_TIME_Relative
1160 get_processing_delay ()
1161 {
1162   return 
1163     GNUNET_TIME_relative_add (GNUNET_CONSTANTS_MAX_CORK_DELAY,
1164                               GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1165                                                              GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1166                                                                                        TTL_DECREMENT)));
1167 }
1168
1169
1170 /**
1171  * We're processing a GET request from another peer and have decided
1172  * to forward it to other peers.  This function is called periodically
1173  * and should forward the request to other peers until we have all
1174  * possible replies.  If we have transmitted the *only* reply to
1175  * the initiator we should destroy the pending request.  If we have
1176  * many replies in the queue to the initiator, we should delay sending
1177  * out more queries until the reply queue has shrunk some.
1178  *
1179  * @param cls our "struct ProcessGetContext *"
1180  * @param tc unused
1181  */
1182 static void
1183 forward_request_task (void *cls,
1184                       const struct GNUNET_SCHEDULER_TaskContext *tc);
1185
1186
1187 /**
1188  * Function called after we either failed or succeeded
1189  * at transmitting a query to a peer.  
1190  *
1191  * @param cls the requests "struct PendingRequest*"
1192  * @param tpid ID of receiving peer, 0 on transmission error
1193  */
1194 static void
1195 transmit_query_continuation (void *cls,
1196                              GNUNET_PEER_Id tpid)
1197 {
1198   struct PendingRequest *pr = cls;
1199
1200   if (tpid == 0)   
1201     {
1202 #if DEBUG_FS
1203       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1204                   "Transmission of request failed, will try again later.\n");
1205 #endif
1206       if (pr->task == GNUNET_SCHEDULER_NO_TASK)
1207         pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1208                                                  get_processing_delay (),
1209                                                  &forward_request_task,
1210                                                  pr); 
1211       return;    
1212     }
1213   GNUNET_STATISTICS_update (stats,
1214                             gettext_noop ("# queries forwarded"),
1215                             1,
1216                             GNUNET_NO);
1217   GNUNET_PEER_change_rc (tpid, 1);
1218   if (pr->used_pids_off == pr->used_pids_size)
1219     GNUNET_array_grow (pr->used_pids,
1220                        pr->used_pids_size,
1221                        pr->used_pids_size * 2 + 2);
1222   pr->used_pids[pr->used_pids_off++] = tpid;
1223   if (pr->task == GNUNET_SCHEDULER_NO_TASK)
1224     pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1225                                              get_processing_delay (),
1226                                              &forward_request_task,
1227                                              pr);
1228 }
1229
1230
1231 /**
1232  * How many bytes should a bloomfilter be if we have already seen
1233  * entry_count responses?  Note that BLOOMFILTER_K gives us the number
1234  * of bits set per entry.  Furthermore, we should not re-size the
1235  * filter too often (to keep it cheap).
1236  *
1237  * Since other peers will also add entries but not resize the filter,
1238  * we should generally pick a slightly larger size than what the
1239  * strict math would suggest.
1240  *
1241  * @return must be a power of two and smaller or equal to 2^15.
1242  */
1243 static size_t
1244 compute_bloomfilter_size (unsigned int entry_count)
1245 {
1246   size_t size;
1247   unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
1248   uint16_t max = 1 << 15;
1249
1250   if (entry_count > max)
1251     return max;
1252   size = 8;
1253   while ((size < max) && (size < ideal))
1254     size *= 2;
1255   if (size > max)
1256     return max;
1257   return size;
1258 }
1259
1260
1261 /**
1262  * Recalculate our bloom filter for filtering replies.
1263  *
1264  * @param count number of entries we are filtering right now
1265  * @param mingle set to our new mingling value
1266  * @param bf_size set to the size of the bloomfilter
1267  * @param entries the entries to filter
1268  * @return updated bloomfilter, NULL for none
1269  */
1270 static struct GNUNET_CONTAINER_BloomFilter *
1271 refresh_bloomfilter (unsigned int count,
1272                      int32_t * mingle,
1273                      size_t *bf_size,
1274                      const GNUNET_HashCode *entries)
1275 {
1276   struct GNUNET_CONTAINER_BloomFilter *bf;
1277   size_t nsize;
1278   unsigned int i;
1279   GNUNET_HashCode mhash;
1280
1281   if (0 == count)
1282     return NULL;
1283   nsize = compute_bloomfilter_size (count);
1284   *mingle = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, -1);
1285   *bf_size = nsize;
1286   bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 
1287                                           nsize,
1288                                           BLOOMFILTER_K);
1289   for (i=0;i<count;i++)
1290     {
1291       mingle_hash (&entries[i], *mingle, &mhash);
1292       GNUNET_CONTAINER_bloomfilter_add (bf, &mhash);
1293     }
1294   return bf;
1295 }
1296
1297
1298 /**
1299  * Function called after we've tried to reserve a certain amount of
1300  * bandwidth for a reply.  Check if we succeeded and if so send our
1301  * query.
1302  *
1303  * @param cls the requests "struct PendingRequest*"
1304  * @param peer identifies the peer
1305  * @param bpm_in set to the current bandwidth limit (receiving) for this peer
1306  * @param bpm_out set to the current bandwidth limit (sending) for this peer
1307  * @param amount set to the amount that was actually reserved or unreserved
1308  * @param preference current traffic preference for the given peer
1309  */
1310 static void
1311 target_reservation_cb (void *cls,
1312                        const struct
1313                        GNUNET_PeerIdentity * peer,
1314                        struct GNUNET_BANDWIDTH_Value32NBO bpm_in,
1315                        struct GNUNET_BANDWIDTH_Value32NBO bpm_out,
1316                        int amount,
1317                        uint64_t preference)
1318 {
1319   struct PendingRequest *pr = cls;
1320   struct ConnectedPeer *cp;
1321   struct PendingMessage *pm;
1322   struct GetMessage *gm;
1323   GNUNET_HashCode *ext;
1324   char *bfdata;
1325   size_t msize;
1326   unsigned int k;
1327   int no_route;
1328   uint32_t bm;
1329
1330   pr->irc = NULL;
1331   if (peer == NULL)
1332     {
1333       /* error in communication with core, try again later */
1334       if (pr->task == GNUNET_SCHEDULER_NO_TASK)
1335         pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1336                                                  get_processing_delay (),
1337                                                  &forward_request_task,
1338                                                  pr);
1339       return;
1340     }
1341   // (3) transmit, update ttl/priority
1342   cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
1343                                           &peer->hashPubKey);
1344   if (cp == NULL)
1345     {
1346       /* Peer must have just left */
1347 #if DEBUG_FS
1348       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1349                   "Selected peer disconnected!\n");
1350 #endif
1351       if (pr->task == GNUNET_SCHEDULER_NO_TASK)
1352         pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1353                                                  get_processing_delay (),
1354                                                  &forward_request_task,
1355                                                  pr);
1356       return;
1357     }
1358   no_route = GNUNET_NO;
1359   /* FIXME: check against DBLOCK_SIZE and possibly return
1360      amount to reserve; however, this also needs to work
1361      with testcases which currently start out with a far
1362      too low per-peer bw limit, so they would never send
1363      anything.  Big issue. */
1364   if (amount == 0)
1365     {
1366       if (pr->cp == NULL)
1367         {
1368 #if DEBUG_FS > 1
1369           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1370                       "Failed to reserve bandwidth for reply (got %d/%u bytes only)!\n",
1371                       amount,
1372                       DBLOCK_SIZE);
1373 #endif
1374           GNUNET_STATISTICS_update (stats,
1375                                     gettext_noop ("# reply bandwidth reservation requests failed"),
1376                                     1,
1377                                     GNUNET_NO);
1378           if (pr->task == GNUNET_SCHEDULER_NO_TASK)
1379             pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1380                                                      get_processing_delay (),
1381                                                      &forward_request_task,
1382                                                      pr);
1383           return;  /* this target round failed */
1384         }
1385       /* FIXME: if we are "quite" busy, we may still want to skip
1386          this round; need more load detection code! */
1387       no_route = GNUNET_YES;
1388     }
1389   
1390   GNUNET_STATISTICS_update (stats,
1391                             gettext_noop ("# requests forwarded"),
1392                             1,
1393                             GNUNET_NO);
1394   /* build message and insert message into priority queue */
1395 #if DEBUG_FS
1396   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1397               "Forwarding request `%s' to `%4s'!\n",
1398               GNUNET_h2s (&pr->query),
1399               GNUNET_i2s (peer));
1400 #endif
1401   k = 0;
1402   bm = 0;
1403   if (GNUNET_YES == no_route)
1404     {
1405       bm |= GET_MESSAGE_BIT_RETURN_TO;
1406       k++;      
1407     }
1408   if (pr->namespace != NULL)
1409     {
1410       bm |= GET_MESSAGE_BIT_SKS_NAMESPACE;
1411       k++;
1412     }
1413   if (pr->target_pid != 0)
1414     {
1415       bm |= GET_MESSAGE_BIT_TRANSMIT_TO;
1416       k++;
1417     }
1418   msize = sizeof (struct GetMessage) + pr->bf_size + k * sizeof(GNUNET_HashCode);
1419   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
1420   pm = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1421   pm->msize = msize;
1422   gm = (struct GetMessage*) &pm[1];
1423   gm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_GET);
1424   gm->header.size = htons (msize);
1425   gm->type = htonl (pr->type);
1426   pr->remaining_priority /= 2;
1427   gm->priority = htonl (pr->remaining_priority);
1428   gm->ttl = htonl (pr->ttl);
1429   gm->filter_mutator = htonl(pr->mingle); 
1430   gm->hash_bitmap = htonl (bm);
1431   gm->query = pr->query;
1432   ext = (GNUNET_HashCode*) &gm[1];
1433   k = 0;
1434   if (GNUNET_YES == no_route)
1435     GNUNET_PEER_resolve (pr->cp->pid, (struct GNUNET_PeerIdentity*) &ext[k++]);
1436   if (pr->namespace != NULL)
1437     memcpy (&ext[k++], pr->namespace, sizeof (GNUNET_HashCode));
1438   if (pr->target_pid != 0)
1439     GNUNET_PEER_resolve (pr->target_pid, (struct GNUNET_PeerIdentity*) &ext[k++]);
1440   bfdata = (char *) &ext[k];
1441   if (pr->bf != NULL)
1442     GNUNET_CONTAINER_bloomfilter_get_raw_data (pr->bf,
1443                                                bfdata,
1444                                                pr->bf_size);
1445   pm->cont = &transmit_query_continuation;
1446   pm->cont_cls = pr;
1447   add_to_pending_messages_for_peer (cp, pm, pr);
1448 }
1449
1450
1451 /**
1452  * Closure used for "target_peer_select_cb".
1453  */
1454 struct PeerSelectionContext 
1455 {
1456   /**
1457    * The request for which we are selecting
1458    * peers.
1459    */
1460   struct PendingRequest *pr;
1461
1462   /**
1463    * Current "prime" target.
1464    */
1465   struct GNUNET_PeerIdentity target;
1466
1467   /**
1468    * How much do we like this target?
1469    */
1470   double target_score;
1471
1472 };
1473
1474
1475 /**
1476  * Function called for each connected peer to determine
1477  * which one(s) would make good targets for forwarding.
1478  *
1479  * @param cls closure (struct PeerSelectionContext)
1480  * @param key current key code (peer identity)
1481  * @param value value in the hash map (struct ConnectedPeer)
1482  * @return GNUNET_YES if we should continue to
1483  *         iterate,
1484  *         GNUNET_NO if not.
1485  */
1486 static int
1487 target_peer_select_cb (void *cls,
1488                        const GNUNET_HashCode * key,
1489                        void *value)
1490 {
1491   struct PeerSelectionContext *psc = cls;
1492   struct ConnectedPeer *cp = value;
1493   struct PendingRequest *pr = psc->pr;
1494   double score;
1495   unsigned int i;
1496   unsigned int pc;
1497   
1498   /* 1) check if we have already (recently) forwarded to this peer */
1499   pc = 0;
1500   for (i=0;i<pr->used_pids_off;i++)
1501     if (pr->used_pids[i] == cp->pid) 
1502       {
1503         pc++;
1504         if (0 != GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1505                                            RETRY_PROBABILITY_INV))
1506           {
1507 #if DEBUG_FS
1508             GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1509                         "NOT re-trying query that was previously transmitted %u times\n",
1510                         (unsigned int) pr->used_pids_off);
1511 #endif
1512             return GNUNET_YES; /* skip */
1513           }
1514       }
1515 #if DEBUG_FS
1516   if (0 < pc)
1517     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1518                 "Re-trying query that was previously transmitted %u times to this peer\n",
1519                 (unsigned int) pc);
1520 #endif
1521   // 2) calculate how much we'd like to forward to this peer
1522   score = 42; // FIXME!
1523   // FIXME: also need API to gather data on responsiveness
1524   // of this peer (we have fields for that in 'cp', but
1525   // they are never set!)
1526   
1527   /* store best-fit in closure */
1528   if (score > psc->target_score)
1529     {
1530       psc->target_score = score;
1531       psc->target.hashPubKey = *key; 
1532     }
1533   return GNUNET_YES;
1534 }
1535   
1536
1537 /**
1538  * We're processing a GET request from another peer and have decided
1539  * to forward it to other peers.  This function is called periodically
1540  * and should forward the request to other peers until we have all
1541  * possible replies.  If we have transmitted the *only* reply to
1542  * the initiator we should destroy the pending request.  If we have
1543  * many replies in the queue to the initiator, we should delay sending
1544  * out more queries until the reply queue has shrunk some.
1545  *
1546  * @param cls our "struct ProcessGetContext *"
1547  * @param tc unused
1548  */
1549 static void
1550 forward_request_task (void *cls,
1551                      const struct GNUNET_SCHEDULER_TaskContext *tc)
1552 {
1553   struct PendingRequest *pr = cls;
1554   struct PeerSelectionContext psc;
1555   struct ConnectedPeer *cp; 
1556   struct GNUNET_TIME_Relative delay;
1557
1558   pr->task = GNUNET_SCHEDULER_NO_TASK;
1559   if (pr->irc != NULL)
1560     {
1561 #if DEBUG_FS
1562       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1563                   "Forwarding of query `%s' not attempted due to pending local lookup!\n",
1564                   GNUNET_h2s (&pr->query));
1565 #endif
1566       return; /* already pending */
1567     }
1568   /* (1) select target */
1569   psc.pr = pr;
1570   psc.target_score = DBL_MIN;
1571   GNUNET_CONTAINER_multihashmap_iterate (connected_peers,
1572                                          &target_peer_select_cb,
1573                                          &psc);  
1574   if (psc.target_score == DBL_MIN)
1575     {
1576       delay = get_processing_delay ();
1577 #if DEBUG_FS 
1578       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1579                   "No peer selected for forwarding of query `%s', will try again in %llu ms!\n",
1580                   GNUNET_h2s (&pr->query),
1581                   delay.value);
1582 #endif
1583       pr->task = GNUNET_SCHEDULER_add_delayed (sched,
1584                                                delay,
1585                                                &forward_request_task,
1586                                                pr);
1587       return; /* nobody selected */
1588     }
1589
1590   /* (2) reserve reply bandwidth */
1591   cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
1592                                           &psc.target.hashPubKey);
1593   pr->irc = GNUNET_CORE_peer_change_preference (sched, cfg,
1594                                                 &psc.target,
1595                                                 GNUNET_CONSTANTS_SERVICE_TIMEOUT, 
1596                                                 GNUNET_BANDWIDTH_value_init ((uint32_t) -1 /* no limit */), 
1597                                                 DBLOCK_SIZE, 
1598                                                 (uint64_t) cp->inc_preference,
1599                                                 &target_reservation_cb,
1600                                                 pr);
1601   cp->inc_preference = 0.0;
1602 }
1603
1604
1605 /* **************************** P2P PUT Handling ************************ */
1606
1607
1608 /**
1609  * Function called after we either failed or succeeded
1610  * at transmitting a reply to a peer.  
1611  *
1612  * @param cls the requests "struct PendingRequest*"
1613  * @param tpid ID of receiving peer, 0 on transmission error
1614  */
1615 static void
1616 transmit_reply_continuation (void *cls,
1617                              GNUNET_PEER_Id tpid)
1618 {
1619   struct PendingRequest *pr = cls;
1620   
1621   switch (pr->type)
1622     {
1623     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
1624     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
1625       /* only one reply expected, done with the request! */
1626       destroy_pending_request (pr);
1627       break;
1628     case GNUNET_DATASTORE_BLOCKTYPE_ANY:
1629     case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
1630     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
1631       break;
1632     default:
1633       GNUNET_break (0);
1634       break;
1635     }
1636 }
1637
1638
1639 /**
1640  * Check if the given KBlock is well-formed.
1641  *
1642  * @param kb the kblock data (or at least "dsize" bytes claiming to be one)
1643  * @param dsize size of "kb" in bytes; check for < sizeof(struct KBlock)!
1644  * @param query where to store the query that this block answers
1645  * @return GNUNET_OK if this is actually a well-formed KBlock
1646  */
1647 static int
1648 check_kblock (const struct KBlock *kb,
1649               size_t dsize,
1650               GNUNET_HashCode *query)
1651 {
1652   if (dsize < sizeof (struct KBlock))
1653     {
1654       GNUNET_break_op (0);
1655       return GNUNET_SYSERR;
1656     }
1657   if (dsize - sizeof (struct KBlock) !=
1658       ntohl (kb->purpose.size) 
1659       - sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) 
1660       - sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) ) 
1661     {
1662       GNUNET_break_op (0);
1663       return GNUNET_SYSERR;
1664     }
1665   if (GNUNET_OK !=
1666       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_KBLOCK,
1667                                 &kb->purpose,
1668                                 &kb->signature,
1669                                 &kb->keyspace)) 
1670     {
1671       GNUNET_break_op (0);
1672       return GNUNET_SYSERR;
1673     }
1674   if (query != NULL)
1675     GNUNET_CRYPTO_hash (&kb->keyspace,
1676                         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1677                         query);
1678   return GNUNET_OK;
1679 }
1680
1681
1682 /**
1683  * Check if the given NBlock is well-formed.
1684  *
1685  * @param nb the nblock data (or at least "dsize" bytes claiming to be one)
1686  * @param dsize size of "nb" in bytes; check for < sizeof(struct NBlock)!
1687  * @param query where to store the query that this block answers
1688  * @return GNUNET_OK if this is actually a well-formed NBlock
1689  */
1690 static int
1691 check_nblock (const struct NBlock *nb,
1692               size_t dsize,
1693               GNUNET_HashCode *query)
1694 {
1695   if (dsize < sizeof (struct NBlock))
1696     {
1697       GNUNET_break_op (0);
1698       return GNUNET_SYSERR;
1699     }
1700   if (dsize - sizeof (struct NBlock) !=
1701       ntohl (nb->ns_purpose.size) 
1702       - sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) 
1703       - sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) ) 
1704     {
1705       GNUNET_break_op (0);
1706       return GNUNET_SYSERR;
1707     }
1708   if (dsize !=
1709       ntohl (nb->ksk_purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
1710     {
1711       GNUNET_break_op (0);
1712       return GNUNET_SYSERR;
1713     }
1714   if (GNUNET_OK !=
1715       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK_KSIG,
1716                                 &nb->ksk_purpose,
1717                                 &nb->ksk_signature,
1718                                 &nb->keyspace)) 
1719     {
1720       GNUNET_break_op (0);
1721       return GNUNET_SYSERR;
1722     }
1723   if (GNUNET_OK !=
1724       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK,
1725                                 &nb->ns_purpose,
1726                                 &nb->ns_signature,
1727                                 &nb->subspace)) 
1728     {
1729       GNUNET_break_op (0);
1730       return GNUNET_SYSERR;
1731     }
1732   if (query != NULL)
1733     GNUNET_CRYPTO_hash (&nb->keyspace,
1734                         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1735                         query);
1736   return GNUNET_OK;
1737 }
1738
1739
1740 /**
1741  * Check if the given SBlock is well-formed.
1742  *
1743  * @param sb the sblock data (or at least "dsize" bytes claiming to be one)
1744  * @param dsize size of "kb" in bytes; check for < sizeof(struct SBlock)!
1745  * @param query where to store the query that this block answers
1746  * @param namespace where to store the namespace that this block belongs to
1747  * @return GNUNET_OK if this is actually a well-formed SBlock
1748  */
1749 static int
1750 check_sblock (const struct SBlock *sb,
1751               size_t dsize,
1752               GNUNET_HashCode *query,   
1753               GNUNET_HashCode *namespace)
1754 {
1755   if (dsize < sizeof (struct SBlock))
1756     {
1757       GNUNET_break_op (0);
1758       return GNUNET_SYSERR;
1759     }
1760   if (dsize !=
1761       ntohl (sb->purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
1762     {
1763       GNUNET_break_op (0);
1764       return GNUNET_SYSERR;
1765     }
1766   if (GNUNET_OK !=
1767       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK,
1768                                 &sb->purpose,
1769                                 &sb->signature,
1770                                 &sb->subspace)) 
1771     {
1772       GNUNET_break_op (0);
1773       return GNUNET_SYSERR;
1774     }
1775   if (query != NULL)
1776     *query = sb->identifier;
1777   if (namespace != NULL)
1778     GNUNET_CRYPTO_hash (&sb->subspace,
1779                         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1780                         namespace);
1781   return GNUNET_OK;
1782 }
1783
1784
1785 /**
1786  * Transmit the given message by copying it to the target buffer
1787  * "buf".  "buf" will be NULL and "size" zero if the socket was closed
1788  * for writing in the meantime.  In that case, do nothing
1789  * (the disconnect or shutdown handler will take care of the rest).
1790  * If we were able to transmit messages and there are still more
1791  * pending, ask core again for further calls to this function.
1792  *
1793  * @param cls closure, pointer to the 'struct ClientList*'
1794  * @param size number of bytes available in buf
1795  * @param buf where the callee should write the message
1796  * @return number of bytes written to buf
1797  */
1798 static size_t
1799 transmit_to_client (void *cls,
1800                   size_t size, void *buf)
1801 {
1802   struct ClientList *cl = cls;
1803   char *cbuf = buf;
1804   struct ClientResponseMessage *creply;
1805   size_t msize;
1806   
1807   cl->th = NULL;
1808   if (NULL == buf)
1809     {
1810 #if DEBUG_FS
1811       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1812                   "Not sending reply, client communication problem.\n");
1813 #endif
1814       return 0;
1815     }
1816   msize = 0;
1817   while ( (NULL != (creply = cl->res_head) ) &&
1818           (creply->msize <= size) )
1819     {
1820       memcpy (&cbuf[msize], &creply[1], creply->msize);
1821       msize += creply->msize;
1822       size -= creply->msize;
1823       GNUNET_CONTAINER_DLL_remove (cl->res_head,
1824                                    cl->res_tail,
1825                                    creply);
1826       GNUNET_free (creply);
1827     }
1828   if (NULL != creply)
1829     cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
1830                                                   creply->msize,
1831                                                   GNUNET_TIME_UNIT_FOREVER_REL,
1832                                                   &transmit_to_client,
1833                                                   cl);
1834 #if DEBUG_FS
1835   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1836               "Transmitted %u bytes to client\n",
1837               (unsigned int) msize);
1838 #endif
1839   return msize;
1840 }
1841
1842
1843 /**
1844  * Closure for "process_reply" function.
1845  */
1846 struct ProcessReplyClosure
1847 {
1848   /**
1849    * The data for the reply.
1850    */
1851   const void *data;
1852
1853   // FIXME: add 'struct ConnectedPeer' to track 'last_xxx_replies' here!
1854
1855   /**
1856    * When the reply expires.
1857    */
1858   struct GNUNET_TIME_Absolute expiration;
1859
1860   /**
1861    * Size of data.
1862    */
1863   size_t size;
1864
1865   /**
1866    * Namespace that this reply belongs to
1867    * (if it is of type SBLOCK).
1868    */
1869   GNUNET_HashCode namespace;
1870
1871   /**
1872    * Type of the block.
1873    */
1874   uint32_t type;
1875
1876   /**
1877    * How much was this reply worth to us?
1878    */
1879   uint32_t priority;
1880 };
1881
1882
1883 /**
1884  * We have received a reply; handle it!
1885  *
1886  * @param cls response (struct ProcessReplyClosure)
1887  * @param key our query
1888  * @param value value in the hash map (info about the query)
1889  * @return GNUNET_YES (we should continue to iterate)
1890  */
1891 static int
1892 process_reply (void *cls,
1893                const GNUNET_HashCode * key,
1894                void *value)
1895 {
1896   struct ProcessReplyClosure *prq = cls;
1897   struct PendingRequest *pr = value;
1898   struct PendingMessage *reply;
1899   struct ClientResponseMessage *creply;
1900   struct ClientList *cl;
1901   struct PutMessage *pm;
1902   struct ConnectedPeer *cp;
1903   GNUNET_HashCode chash;
1904   GNUNET_HashCode mhash;
1905   size_t msize;
1906
1907 #if DEBUG_FS
1908   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1909               "Matched result (type %u) for query `%s' with pending request\n",
1910               (unsigned int) prq->type,
1911               GNUNET_h2s (key));
1912 #endif  
1913   GNUNET_STATISTICS_update (stats,
1914                             gettext_noop ("# replies received and matched"),
1915                             1,
1916                             GNUNET_NO);
1917   GNUNET_CRYPTO_hash (prq->data,
1918                       prq->size,
1919                       &chash);
1920   switch (prq->type)
1921     {
1922     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
1923     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
1924       /* only possible reply, stop requesting! */
1925       while (NULL != pr->pending_head)
1926         destroy_pending_message_list_entry (pr->pending_head);
1927       if (pr->drq != NULL)
1928         {
1929           if (pr->client_request_list != NULL)
1930             GNUNET_SERVER_receive_done (pr->client_request_list->client_list->client, 
1931                                         GNUNET_YES);
1932           GNUNET_FS_drq_get_cancel (pr->drq);
1933           pr->drq = NULL;
1934         }
1935       pr->do_remove = GNUNET_YES;
1936       if (pr->task != GNUNET_SCHEDULER_NO_TASK)
1937         {
1938           GNUNET_SCHEDULER_cancel (sched,
1939                                    pr->task);
1940           pr->task = GNUNET_SCHEDULER_NO_TASK;
1941         }
1942       GNUNET_break (GNUNET_YES ==
1943                     GNUNET_CONTAINER_multihashmap_remove (query_request_map,
1944                                                           key,
1945                                                           pr));
1946       break;
1947     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
1948       if (pr->namespace == NULL)
1949         {
1950           GNUNET_break (0);
1951           return GNUNET_YES;
1952         }
1953       if (0 != memcmp (pr->namespace,
1954                        &prq->namespace,
1955                        sizeof (GNUNET_HashCode)))
1956         {
1957           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1958                       _("Reply mismatched in terms of namespace.  Discarded.\n"));
1959           return GNUNET_YES; /* wrong namespace */      
1960         }
1961       /* then: fall-through! */
1962     case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
1963     case GNUNET_DATASTORE_BLOCKTYPE_NBLOCK:
1964       if (pr->bf != NULL) 
1965         {
1966           mingle_hash (&chash, pr->mingle, &mhash);
1967           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (pr->bf,
1968                                                                &mhash))
1969             {
1970               GNUNET_STATISTICS_update (stats,
1971                                         gettext_noop ("# duplicate replies discarded (bloomfilter)"),
1972                                         1,
1973                                         GNUNET_NO);
1974 #if DEBUG_FS
1975               GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1976                           "Duplicate response `%s', discarding.\n",
1977                           GNUNET_h2s (&mhash));
1978 #endif
1979               return GNUNET_YES; /* duplicate */
1980             }
1981 #if DEBUG_FS
1982           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1983                       "New response `%s', adding to filter.\n",
1984                       GNUNET_h2s (&mhash));
1985 #endif
1986           GNUNET_CONTAINER_bloomfilter_add (pr->bf,
1987                                             &mhash);
1988         }
1989       if (pr->client_request_list != NULL)
1990         {
1991           if (pr->replies_seen_size == pr->replies_seen_off)
1992             {
1993               GNUNET_array_grow (pr->replies_seen,
1994                                  pr->replies_seen_size,
1995                                  pr->replies_seen_size * 2 + 4);
1996               if (pr->bf != NULL)
1997                 GNUNET_CONTAINER_bloomfilter_free (pr->bf);
1998               pr->bf = refresh_bloomfilter (pr->replies_seen_off,
1999                                             &pr->mingle,
2000                                             &pr->bf_size,
2001                                             pr->replies_seen);
2002             }
2003             pr->replies_seen[pr->replies_seen_off++] = chash;         
2004         }
2005       break;
2006     default:
2007       GNUNET_break (0);
2008       return GNUNET_YES;
2009     }
2010   prq->priority += pr->remaining_priority;
2011   pr->remaining_priority = 0;
2012   if (pr->client_request_list != NULL)
2013     {
2014 #if DEBUG_FS
2015       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2016                   "Transmitting result for query `%s' to local client\n",
2017                   GNUNET_h2s (key));
2018 #endif  
2019       GNUNET_STATISTICS_update (stats,
2020                                 gettext_noop ("# replies received for local clients"),
2021                                 1,
2022                                 GNUNET_NO);
2023       cl = pr->client_request_list->client_list;
2024       msize = sizeof (struct PutMessage) + prq->size;
2025       creply = GNUNET_malloc (msize + sizeof (struct ClientResponseMessage));
2026       creply->msize = msize;
2027       creply->client_list = cl;
2028       GNUNET_CONTAINER_DLL_insert_after (cl->res_head,
2029                                          cl->res_tail,
2030                                          cl->res_tail,
2031                                          creply);      
2032       pm = (struct PutMessage*) &creply[1];
2033       pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
2034       pm->header.size = htons (msize);
2035       pm->type = htonl (prq->type);
2036       pm->expiration = GNUNET_TIME_absolute_hton (prq->expiration);
2037       memcpy (&pm[1], prq->data, prq->size);      
2038       if (NULL == cl->th)
2039         {
2040 #if DEBUG_FS
2041           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2042                       "Transmitting result for query `%s' to client\n",
2043                       GNUNET_h2s (key));
2044 #endif  
2045           cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
2046                                                         msize,
2047                                                         GNUNET_TIME_UNIT_FOREVER_REL,
2048                                                         &transmit_to_client,
2049                                                         cl);
2050         }
2051       GNUNET_break (cl->th != NULL);
2052       if (pr->do_remove)                
2053         destroy_pending_request (pr);           
2054     }
2055   else
2056     {
2057       cp = pr->cp;
2058 #if DEBUG_FS
2059       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2060                   "Transmitting result for query `%s' to other peer (PID=%u)\n",
2061                   GNUNET_h2s (key),
2062                   (unsigned int) cp->pid);
2063 #endif  
2064       GNUNET_STATISTICS_update (stats,
2065                                 gettext_noop ("# replies received for other peers"),
2066                                 1,
2067                                 GNUNET_NO);
2068       msize = sizeof (struct PutMessage) + prq->size;
2069       reply = GNUNET_malloc (msize + sizeof (struct PendingMessage));
2070       reply->cont = &transmit_reply_continuation;
2071       reply->cont_cls = pr;
2072       reply->msize = msize;
2073       reply->priority = (uint32_t) -1; /* send replies first! */
2074       pm = (struct PutMessage*) &reply[1];
2075       pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
2076       pm->header.size = htons (msize);
2077       pm->type = htonl (prq->type);
2078       pm->expiration = GNUNET_TIME_absolute_hton (prq->expiration);
2079       memcpy (&pm[1], prq->data, prq->size);
2080       add_to_pending_messages_for_peer (cp, reply, pr);
2081     }
2082   // FIXME: implement hot-path routing statistics keeping!
2083   return GNUNET_YES;
2084 }
2085
2086
2087 /**
2088  * Handle P2P "PUT" message.
2089  *
2090  * @param cls closure, always NULL
2091  * @param other the other peer involved (sender or receiver, NULL
2092  *        for loopback messages where we are both sender and receiver)
2093  * @param message the actual message
2094  * @param latency reported latency of the connection with 'other'
2095  * @param distance reported distance (DV) to 'other' 
2096  * @return GNUNET_OK to keep the connection open,
2097  *         GNUNET_SYSERR to close it (signal serious error)
2098  */
2099 static int
2100 handle_p2p_put (void *cls,
2101                 const struct GNUNET_PeerIdentity *other,
2102                 const struct GNUNET_MessageHeader *message,
2103                 struct GNUNET_TIME_Relative latency,
2104                 uint32_t distance)
2105 {
2106   const struct PutMessage *put;
2107   uint16_t msize;
2108   size_t dsize;
2109   uint32_t type;
2110   struct GNUNET_TIME_Absolute expiration;
2111   GNUNET_HashCode query;
2112   struct ProcessReplyClosure prq;
2113
2114   msize = ntohs (message->size);
2115   if (msize < sizeof (struct PutMessage))
2116     {
2117       GNUNET_break_op(0);
2118       return GNUNET_SYSERR;
2119     }
2120   put = (const struct PutMessage*) message;
2121   dsize = msize - sizeof (struct PutMessage);
2122   type = ntohl (put->type);
2123   expiration = GNUNET_TIME_absolute_ntoh (put->expiration);
2124
2125   /* first, validate! */
2126   switch (type)
2127     {
2128     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2129     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2130       GNUNET_CRYPTO_hash (&put[1], dsize, &query);
2131       break;
2132     case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
2133       if (GNUNET_OK !=
2134           check_kblock ((const struct KBlock*) &put[1],
2135                         dsize,
2136                         &query))
2137         return GNUNET_SYSERR;
2138       break;
2139     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2140       if (GNUNET_OK !=
2141           check_sblock ((const struct SBlock*) &put[1],
2142                         dsize,
2143                         &query,
2144                         &prq.namespace))
2145         return GNUNET_SYSERR;
2146       break;
2147     case GNUNET_DATASTORE_BLOCKTYPE_NBLOCK:
2148       if (GNUNET_OK !=
2149           check_nblock ((const struct NBlock*) &put[1],
2150                         dsize,
2151                         &query))
2152         return GNUNET_SYSERR;
2153       return GNUNET_OK;
2154     default:
2155       /* unknown block type */
2156       GNUNET_break_op (0);
2157       return GNUNET_SYSERR;
2158     }
2159
2160 #if DEBUG_FS
2161   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2162               "Received result for query `%s' from peer `%4s'\n",
2163               GNUNET_h2s (&query),
2164               GNUNET_i2s (other));
2165 #endif
2166   GNUNET_STATISTICS_update (stats,
2167                             gettext_noop ("# replies received (overall)"),
2168                             1,
2169                             GNUNET_NO);
2170   /* now, lookup 'query' */
2171   prq.data = (const void*) &put[1];
2172   prq.size = dsize;
2173   prq.type = type;
2174   prq.expiration = expiration;
2175   prq.priority = 0;
2176   GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
2177                                               &query,
2178                                               &process_reply,
2179                                               &prq);
2180   // FIXME: if migration is on and load is low,
2181   // queue to store data in datastore;
2182   // use "prq.priority" for that!
2183   return GNUNET_OK;
2184 }
2185
2186
2187 /* **************************** P2P GET Handling ************************ */
2188
2189
2190 /**
2191  * Closure for 'check_duplicate_request_{peer,client}'.
2192  */
2193 struct CheckDuplicateRequestClosure
2194 {
2195   /**
2196    * The new request we should check if it already exists.
2197    */
2198   const struct PendingRequest *pr;
2199
2200   /**
2201    * Existing request found by the checker, NULL if none.
2202    */
2203   struct PendingRequest *have;
2204 };
2205
2206
2207 /**
2208  * Iterator over entries in the 'query_request_map' that
2209  * tries to see if we have the same request pending from
2210  * the same client already.
2211  *
2212  * @param cls closure (our 'struct CheckDuplicateRequestClosure')
2213  * @param key current key code (query, ignored, must match)
2214  * @param value value in the hash map (a 'struct PendingRequest' 
2215  *              that already exists)
2216  * @return GNUNET_YES if we should continue to
2217  *         iterate (no match yet)
2218  *         GNUNET_NO if not (match found).
2219  */
2220 static int
2221 check_duplicate_request_client (void *cls,
2222                                 const GNUNET_HashCode * key,
2223                                 void *value)
2224 {
2225   struct CheckDuplicateRequestClosure *cdc = cls;
2226   struct PendingRequest *have = value;
2227
2228   if (have->client_request_list == NULL)
2229     return GNUNET_YES;
2230   if ( (cdc->pr->client_request_list->client_list->client == have->client_request_list->client_list->client) &&
2231        (cdc->pr != have) )
2232     {
2233       cdc->have = have;
2234       return GNUNET_NO;
2235     }
2236   return GNUNET_YES;
2237 }
2238
2239
2240 /**
2241  * We're processing (local) results for a search request
2242  * from another peer.  Pass applicable results to the
2243  * peer and if we are done either clean up (operation
2244  * complete) or forward to other peers (more results possible).
2245  *
2246  * @param cls our closure (struct LocalGetContext)
2247  * @param key key for the content
2248  * @param size number of bytes in data
2249  * @param data content stored
2250  * @param type type of the content
2251  * @param priority priority of the content
2252  * @param anonymity anonymity-level for the content
2253  * @param expiration expiration time for the content
2254  * @param uid unique identifier for the datum;
2255  *        maybe 0 if no unique identifier is available
2256  */
2257 static void
2258 process_local_reply (void *cls,
2259                      const GNUNET_HashCode * key,
2260                      uint32_t size,
2261                      const void *data,
2262                      uint32_t type,
2263                      uint32_t priority,
2264                      uint32_t anonymity,
2265                      struct GNUNET_TIME_Absolute
2266                      expiration, 
2267                      uint64_t uid)
2268 {
2269   struct PendingRequest *pr = cls;
2270   struct ProcessReplyClosure prq;
2271   struct CheckDuplicateRequestClosure cdrc;
2272   GNUNET_HashCode dhash;
2273   GNUNET_HashCode mhash;
2274   GNUNET_HashCode query;
2275   
2276   if (NULL == key)
2277     {
2278 #if DEBUG_FS > 1
2279       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2280                   "Done processing local replies, forwarding request to other peers.\n");
2281 #endif
2282       pr->drq = NULL;
2283       if (pr->client_request_list != NULL)
2284         {
2285           GNUNET_SERVER_receive_done (pr->client_request_list->client_list->client, 
2286                                       GNUNET_YES);
2287           /* Figure out if this is a duplicate request and possibly
2288              merge 'struct PendingRequest' entries */
2289           cdrc.have = NULL;
2290           cdrc.pr = pr;
2291           GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
2292                                                       &pr->query,
2293                                                       &check_duplicate_request_client,
2294                                                       &cdrc);
2295           if (cdrc.have != NULL)
2296             {
2297 #if DEBUG_FS
2298               GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2299                           "Received request for block `%s' twice from client, will only request once.\n",
2300                           GNUNET_h2s (&pr->query));
2301 #endif
2302               
2303               destroy_pending_request (pr);
2304               return;
2305             }
2306         }
2307
2308       /* no more results */
2309       if (pr->task == GNUNET_SCHEDULER_NO_TASK)
2310         pr->task = GNUNET_SCHEDULER_add_now (sched,
2311                                              &forward_request_task,
2312                                              pr);      
2313       return;
2314     }
2315 #if DEBUG_FS
2316   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2317               "New local response to `%s' of type %u.\n",
2318               GNUNET_h2s (key),
2319               type);
2320 #endif
2321   if (type == GNUNET_DATASTORE_BLOCKTYPE_ONDEMAND)
2322     {
2323 #if DEBUG_FS
2324       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2325                   "Found ONDEMAND block, performing on-demand encoding\n");
2326 #endif
2327       GNUNET_STATISTICS_update (stats,
2328                                 gettext_noop ("# on-demand blocks matched requests"),
2329                                 1,
2330                                 GNUNET_NO);
2331       if (GNUNET_OK != 
2332           GNUNET_FS_handle_on_demand_block (key, size, data, type, priority, 
2333                                             anonymity, expiration, uid, 
2334                                             &process_local_reply,
2335                                             pr))
2336         GNUNET_FS_drq_get_next (GNUNET_YES);
2337       return;
2338     }
2339   /* check for duplicates */
2340   GNUNET_CRYPTO_hash (data, size, &dhash);
2341   mingle_hash (&dhash, 
2342                pr->mingle,
2343                &mhash);
2344   if ( (pr->bf != NULL) &&
2345        (GNUNET_YES ==
2346         GNUNET_CONTAINER_bloomfilter_test (pr->bf,
2347                                            &mhash)) )
2348     {      
2349 #if DEBUG_FS
2350       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2351                   "Result from datastore filtered by bloomfilter (duplicate).\n");
2352 #endif
2353       GNUNET_STATISTICS_update (stats,
2354                                 gettext_noop ("# results filtered by query bloomfilter"),
2355                                 1,
2356                                 GNUNET_NO);
2357       GNUNET_FS_drq_get_next (GNUNET_YES);
2358       return;
2359     }
2360 #if DEBUG_FS
2361   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2362               "Found result for query `%s' in local datastore\n",
2363               GNUNET_h2s (key));
2364 #endif
2365   GNUNET_STATISTICS_update (stats,
2366                             gettext_noop ("# results found locally"),
2367                             1,
2368                             GNUNET_NO);
2369   pr->results_found++;
2370   if ( (pr->type == GNUNET_DATASTORE_BLOCKTYPE_KBLOCK) ||
2371        (pr->type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) ||
2372        (pr->type == GNUNET_DATASTORE_BLOCKTYPE_NBLOCK) )
2373     {
2374       if (pr->bf == NULL)
2375         {
2376           pr->bf_size = 32;
2377           pr->bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
2378                                                       pr->bf_size, 
2379                                                       BLOOMFILTER_K);
2380         }
2381 #if DEBUG_FS
2382       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2383                   "New local response `%s', adding to filter.\n",
2384                   GNUNET_h2s (&mhash));
2385 #endif
2386 #if 0
2387       /* this would break stuff since we will check the bf later
2388          again (and would then discard the reply!) */
2389       GNUNET_CONTAINER_bloomfilter_add (pr->bf, 
2390                                         &mhash);
2391 #endif
2392     }
2393   memset (&prq, 0, sizeof (prq));
2394   prq.data = data;
2395   prq.expiration = expiration;
2396   prq.size = size;  
2397   if ( (type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) &&
2398        (GNUNET_OK != check_sblock ((const struct SBlock*) data,
2399                                    size,
2400                                    &query,
2401                                    &prq.namespace)) )
2402     {
2403       GNUNET_break (0);
2404       /* FIXME: consider removing the block? */
2405       GNUNET_FS_drq_get_next (GNUNET_YES);
2406       return;
2407     }
2408   prq.type = type;
2409   prq.priority = priority;  
2410   process_reply (&prq, key, pr);
2411
2412   if ( (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK) ||
2413        (type == GNUNET_DATASTORE_BLOCKTYPE_IBLOCK) ) 
2414     {
2415       GNUNET_FS_drq_get_next (GNUNET_NO);
2416       return;
2417     }
2418   if ( (pr->client_request_list == NULL) &&
2419        ( (GNUNET_YES == test_load_too_high()) ||
2420          (pr->results_found > 5 + 2 * pr->priority) ) )
2421     {
2422 #if DEBUG_FS > 2
2423       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2424                   "Load too high, done with request\n");
2425 #endif
2426       GNUNET_STATISTICS_update (stats,
2427                                 gettext_noop ("# processing result set cut short due to load"),
2428                                 1,
2429                                 GNUNET_NO);
2430       GNUNET_FS_drq_get_next (GNUNET_NO);
2431       return;
2432     }
2433   GNUNET_FS_drq_get_next (GNUNET_YES);
2434 }
2435
2436
2437 /**
2438  * The priority level imposes a bound on the maximum
2439  * value for the ttl that can be requested.
2440  *
2441  * @param ttl_in requested ttl
2442  * @param prio given priority
2443  * @return ttl_in if ttl_in is below the limit,
2444  *         otherwise the ttl-limit for the given priority
2445  */
2446 static int32_t
2447 bound_ttl (int32_t ttl_in, uint32_t prio)
2448 {
2449   unsigned long long allowed;
2450
2451   if (ttl_in <= 0)
2452     return ttl_in;
2453   allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000; 
2454   if (ttl_in > allowed)      
2455     {
2456       if (allowed >= (1 << 30))
2457         return 1 << 30;
2458       return allowed;
2459     }
2460   return ttl_in;
2461 }
2462
2463
2464 /**
2465  * We've received a request with the specified priority.  Bound it
2466  * according to how much we trust the given peer.
2467  * 
2468  * @param prio_in requested priority
2469  * @param cp the peer making the request
2470  * @return effective priority
2471  */
2472 static uint32_t
2473 bound_priority (uint32_t prio_in,
2474                 struct ConnectedPeer *cp)
2475 {
2476   return 0; // FIXME!
2477 }
2478
2479
2480 /**
2481  * Iterator over entries in the 'query_request_map' that
2482  * tries to see if we have the same request pending from
2483  * the same peer already.
2484  *
2485  * @param cls closure (our 'struct CheckDuplicateRequestClosure')
2486  * @param key current key code (query, ignored, must match)
2487  * @param value value in the hash map (a 'struct PendingRequest' 
2488  *              that already exists)
2489  * @return GNUNET_YES if we should continue to
2490  *         iterate (no match yet)
2491  *         GNUNET_NO if not (match found).
2492  */
2493 static int
2494 check_duplicate_request_peer (void *cls,
2495                               const GNUNET_HashCode * key,
2496                               void *value)
2497 {
2498   struct CheckDuplicateRequestClosure *cdc = cls;
2499   struct PendingRequest *have = value;
2500
2501   if (cdc->pr->target_pid == have->target_pid)
2502     {
2503       cdc->have = have;
2504       return GNUNET_NO;
2505     }
2506   return GNUNET_YES;
2507 }
2508
2509
2510 /**
2511  * Handle P2P "GET" request.
2512  *
2513  * @param cls closure, always NULL
2514  * @param other the other peer involved (sender or receiver, NULL
2515  *        for loopback messages where we are both sender and receiver)
2516  * @param message the actual message
2517  * @param latency reported latency of the connection with 'other'
2518  * @param distance reported distance (DV) to 'other' 
2519  * @return GNUNET_OK to keep the connection open,
2520  *         GNUNET_SYSERR to close it (signal serious error)
2521  */
2522 static int
2523 handle_p2p_get (void *cls,
2524                 const struct GNUNET_PeerIdentity *other,
2525                 const struct GNUNET_MessageHeader *message,
2526                 struct GNUNET_TIME_Relative latency,
2527                 uint32_t distance)
2528 {
2529   struct PendingRequest *pr;
2530   struct ConnectedPeer *cp;
2531   struct ConnectedPeer *cps;
2532   struct CheckDuplicateRequestClosure cdc;
2533   struct GNUNET_TIME_Relative timeout;
2534   uint16_t msize;
2535   const struct GetMessage *gm;
2536   unsigned int bits;
2537   const GNUNET_HashCode *opt;
2538   uint32_t bm;
2539   size_t bfsize;
2540   uint32_t ttl_decrement;
2541   uint32_t type;
2542   double preference;
2543   int have_ns;
2544
2545   msize = ntohs(message->size);
2546   if (msize < sizeof (struct GetMessage))
2547     {
2548       GNUNET_break_op (0);
2549       return GNUNET_SYSERR;
2550     }
2551   gm = (const struct GetMessage*) message;
2552   type = ntohl (gm->type);
2553   switch (type)
2554     {
2555     case GNUNET_DATASTORE_BLOCKTYPE_ANY:
2556     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2557     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2558     case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
2559     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2560       break;
2561     default:
2562       GNUNET_break_op (0);
2563       return GNUNET_SYSERR;
2564     }
2565   bm = ntohl (gm->hash_bitmap);
2566   bits = 0;
2567   while (bm > 0)
2568     {
2569       if (1 == (bm & 1))
2570         bits++;
2571       bm >>= 1;
2572     }
2573   if (msize < sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode))
2574     {
2575       GNUNET_break_op (0);
2576       return GNUNET_SYSERR;
2577     }  
2578   opt = (const GNUNET_HashCode*) &gm[1];
2579   bfsize = msize - sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode);
2580   bm = ntohl (gm->hash_bitmap);
2581   if ( (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE)) &&
2582        (type != GNUNET_DATASTORE_BLOCKTYPE_SBLOCK) )
2583     {
2584       GNUNET_break_op (0);
2585       return GNUNET_SYSERR;      
2586     }
2587   bits = 0;
2588   cps = GNUNET_CONTAINER_multihashmap_get (connected_peers,
2589                                            &other->hashPubKey);
2590   GNUNET_assert (NULL != cps);
2591   if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
2592     cp = GNUNET_CONTAINER_multihashmap_get (connected_peers,
2593                                             &opt[bits++]);
2594   else
2595     cp = cps;
2596   if (cp == NULL)
2597     {
2598 #if DEBUG_FS
2599       if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
2600         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2601                     "Failed to find RETURN-TO peer `%4s' in connection set. Dropping query.\n",
2602                     GNUNET_i2s ((const struct GNUNET_PeerIdentity*) &opt[bits-1]));
2603       
2604       else
2605         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2606                     "Failed to find peer `%4s' in connection set. Dropping query.\n",
2607                     GNUNET_i2s (other));
2608 #endif
2609       GNUNET_STATISTICS_update (stats,
2610                                 gettext_noop ("# requests dropped due to missing reverse route"),
2611                                 1,
2612                                 GNUNET_NO);
2613      /* FIXME: try connect? */
2614       return GNUNET_OK;
2615     }
2616   /* note that we can really only check load here since otherwise
2617      peers could find out that we are overloaded by not being
2618      disconnected after sending us a malformed query... */
2619   if (GNUNET_YES == test_load_too_high ())
2620     {
2621 #if DEBUG_FS
2622       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2623                   "Dropping query from `%s', this peer is too busy.\n",
2624                   GNUNET_i2s (other));
2625 #endif
2626       GNUNET_STATISTICS_update (stats,
2627                                 gettext_noop ("# requests dropped due to high load"),
2628                                 1,
2629                                 GNUNET_NO);
2630       return GNUNET_OK;
2631     }
2632
2633 #if DEBUG_FS 
2634   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2635               "Received request for `%s' of type %u from peer `%4s' with flags %u\n",
2636               GNUNET_h2s (&gm->query),
2637               (unsigned int) type,
2638               GNUNET_i2s (other),
2639               (unsigned int) bm);
2640 #endif
2641   have_ns = (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE));
2642   pr = GNUNET_malloc (sizeof (struct PendingRequest) + 
2643                       (have_ns ? sizeof(GNUNET_HashCode) : 0));
2644   if (have_ns)
2645     pr->namespace = (GNUNET_HashCode*) &pr[1];
2646   pr->type = type;
2647   pr->mingle = ntohl (gm->filter_mutator);
2648   if (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE))    
2649     memcpy (&pr[1], &opt[bits++], sizeof (GNUNET_HashCode));
2650   if (0 != (bm & GET_MESSAGE_BIT_TRANSMIT_TO))
2651     pr->target_pid = GNUNET_PEER_intern ((const struct GNUNET_PeerIdentity*) &opt[bits++]);
2652
2653   pr->anonymity_level = 1;
2654   pr->priority = bound_priority (ntohl (gm->priority), cps);
2655   pr->ttl = bound_ttl (ntohl (gm->ttl), pr->priority);
2656   pr->query = gm->query;
2657   /* decrement ttl (always) */
2658   ttl_decrement = 2 * TTL_DECREMENT +
2659     GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
2660                               TTL_DECREMENT);
2661   if ( (pr->ttl < 0) &&
2662        (pr->ttl - ttl_decrement > 0) )
2663     {
2664 #if DEBUG_FS
2665       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2666                   "Dropping query from `%s' due to TTL underflow.\n",
2667                   GNUNET_i2s (other));
2668 #endif
2669       GNUNET_STATISTICS_update (stats,
2670                                 gettext_noop ("# requests dropped due TTL underflow"),
2671                                 1,
2672                                 GNUNET_NO);
2673       /* integer underflow => drop (should be very rare)! */
2674       GNUNET_free (pr);
2675       return GNUNET_OK;
2676     } 
2677   pr->ttl -= ttl_decrement;
2678   pr->start_time = GNUNET_TIME_absolute_get ();
2679
2680   /* get bloom filter */
2681   if (bfsize > 0)
2682     {
2683       pr->bf = GNUNET_CONTAINER_bloomfilter_init ((const char*) &opt[bits],
2684                                                   bfsize,
2685                                                   BLOOMFILTER_K);
2686       pr->bf_size = bfsize;
2687     }
2688
2689   cdc.have = NULL;
2690   cdc.pr = pr;
2691   GNUNET_CONTAINER_multihashmap_get_multiple (query_request_map,
2692                                               &gm->query,
2693                                               &check_duplicate_request_peer,
2694                                               &cdc);
2695   if (cdc.have != NULL)
2696     {
2697       if (cdc.have->start_time.value + cdc.have->ttl >=
2698           pr->start_time.value + pr->ttl)
2699         {
2700           /* existing request has higher TTL, drop new one! */
2701           cdc.have->priority += pr->priority;
2702           destroy_pending_request (pr);
2703 #if DEBUG_FS
2704           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2705                       "Have existing request with higher TTL, dropping new request.\n",
2706                       GNUNET_i2s (other));
2707 #endif
2708           GNUNET_STATISTICS_update (stats,
2709                                     gettext_noop ("# requests dropped due to existing request with higher TTL"),
2710                                     1,
2711                                     GNUNET_NO);
2712           return GNUNET_OK;
2713         }
2714       else
2715         {
2716           /* existing request has lower TTL, drop old one! */
2717           pr->priority += cdc.have->priority;
2718           /* Possible optimization: if we have applicable pending
2719              replies in 'cdc.have', we might want to move those over
2720              (this is a really rare special-case, so it is not clear
2721              that this would be worth it) */
2722           destroy_pending_request (cdc.have);
2723           /* keep processing 'pr'! */
2724         }
2725     }
2726
2727   pr->cp = cp;
2728   GNUNET_CONTAINER_multihashmap_put (query_request_map,
2729                                      &gm->query,
2730                                      pr,
2731                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2732   GNUNET_CONTAINER_multihashmap_put (peer_request_map,
2733                                      &other->hashPubKey,
2734                                      pr,
2735                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2736   
2737   pr->hnode = GNUNET_CONTAINER_heap_insert (requests_by_expiration_heap,
2738                                             pr,
2739                                             pr->start_time.value + pr->ttl);
2740
2741   GNUNET_STATISTICS_update (stats,
2742                             gettext_noop ("# P2P searches active"),
2743                             1,
2744                             GNUNET_NO);
2745
2746   /* calculate change in traffic preference */
2747   preference = (double) pr->priority;
2748   if (preference < QUERY_BANDWIDTH_VALUE)
2749     preference = QUERY_BANDWIDTH_VALUE;
2750   cps->inc_preference += preference;
2751
2752   /* process locally */
2753   if (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK)
2754     type = GNUNET_DATASTORE_BLOCKTYPE_ANY; /* to get on-demand as well */
2755   timeout = GNUNET_TIME_relative_multiply (BASIC_DATASTORE_REQUEST_DELAY,
2756                                            (pr->priority + 1)); 
2757   pr->drq = GNUNET_FS_drq_get (&gm->query,
2758                                type,                           
2759                                &process_local_reply,
2760                                pr,
2761                                timeout,
2762                                GNUNET_NO);
2763
2764   /* Are multiple results possible?  If so, start processing remotely now! */
2765   switch (pr->type)
2766     {
2767     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2768     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2769       /* only one result, wait for datastore */
2770       break;
2771     default:
2772       if (pr->task == GNUNET_SCHEDULER_NO_TASK)
2773         pr->task = GNUNET_SCHEDULER_add_now (sched,
2774                                              &forward_request_task,
2775                                              pr);
2776     }
2777
2778   /* make sure we don't track too many requests */
2779   if (GNUNET_CONTAINER_heap_get_size (requests_by_expiration_heap) > max_pending_requests)
2780     {
2781       pr = GNUNET_CONTAINER_heap_peek (requests_by_expiration_heap);
2782       destroy_pending_request (pr);
2783     }
2784   return GNUNET_OK;
2785 }
2786
2787
2788 /* **************************** CS GET Handling ************************ */
2789
2790
2791 /**
2792  * Handle START_SEARCH-message (search request from client).
2793  *
2794  * @param cls closure
2795  * @param client identification of the client
2796  * @param message the actual message
2797  */
2798 static void
2799 handle_start_search (void *cls,
2800                      struct GNUNET_SERVER_Client *client,
2801                      const struct GNUNET_MessageHeader *message)
2802 {
2803   static GNUNET_HashCode all_zeros;
2804   const struct SearchMessage *sm;
2805   struct ClientList *cl;
2806   struct ClientRequestList *crl;
2807   struct PendingRequest *pr;
2808   uint16_t msize;
2809   unsigned int sc;
2810   uint32_t type;
2811
2812   msize = ntohs (message->size);
2813   if ( (msize < sizeof (struct SearchMessage)) ||
2814        (0 != (msize - sizeof (struct SearchMessage)) % sizeof (GNUNET_HashCode)) )
2815     {
2816       GNUNET_break (0);
2817       GNUNET_SERVER_receive_done (client,
2818                                   GNUNET_SYSERR);
2819       return;
2820     }
2821   sc = (msize - sizeof (struct SearchMessage)) / sizeof (GNUNET_HashCode);
2822   sm = (const struct SearchMessage*) message;
2823
2824   cl = client_list;
2825   while ( (cl != NULL) &&
2826           (cl->client != client) )
2827     cl = cl->next;
2828   if (cl == NULL)
2829     {
2830       cl = GNUNET_malloc (sizeof (struct ClientList));
2831       cl->client = client;
2832       GNUNET_SERVER_client_keep (client);
2833       cl->next = client_list;
2834       client_list = cl;
2835     }
2836   type = ntohl (sm->type);
2837 #if DEBUG_FS
2838   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2839               "Received request for `%s' of type %u from local client\n",
2840               GNUNET_h2s (&sm->query),
2841               (unsigned int) type);
2842 #endif
2843   switch (type)
2844     {
2845     case GNUNET_DATASTORE_BLOCKTYPE_ANY:
2846     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2847     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2848     case GNUNET_DATASTORE_BLOCKTYPE_KBLOCK:
2849     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2850     case GNUNET_DATASTORE_BLOCKTYPE_NBLOCK:
2851       break;
2852     default:
2853       GNUNET_break (0);
2854       GNUNET_SERVER_receive_done (client,
2855                                   GNUNET_SYSERR);
2856       return;
2857     }  
2858
2859   /* detect duplicate KBLOCK requests */
2860   if ( (type == GNUNET_DATASTORE_BLOCKTYPE_KBLOCK) ||
2861        (type == GNUNET_DATASTORE_BLOCKTYPE_NBLOCK) ||
2862        (type == GNUNET_DATASTORE_BLOCKTYPE_ANY) )
2863     {
2864       crl = cl->rl_head;
2865       while ( (crl != NULL) &&
2866               ( (0 != memcmp (&crl->req->query,
2867                               &sm->query,
2868                               sizeof (GNUNET_HashCode))) ||
2869                 (crl->req->type != type) ) )
2870         crl = crl->next;
2871       if (crl != NULL)  
2872         { 
2873 #if DEBUG_FS
2874           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2875                       "Have existing request, merging content-seen lists.\n");
2876 #endif
2877           pr = crl->req;
2878           /* Duplicate request (used to send long list of
2879              known/blocked results); merge 'pr->replies_seen'
2880              and update bloom filter */
2881           GNUNET_array_grow (pr->replies_seen,
2882                              pr->replies_seen_size,
2883                              pr->replies_seen_off + sc);
2884           memcpy (&pr->replies_seen[pr->replies_seen_off],
2885                   &sm[1],
2886                   sc * sizeof (GNUNET_HashCode));
2887           pr->replies_seen_off += sc;
2888           if (pr->bf != NULL)
2889             GNUNET_CONTAINER_bloomfilter_free (pr->bf);
2890           pr->bf = refresh_bloomfilter (pr->replies_seen_off,
2891                                         &pr->mingle,
2892                                         &pr->bf_size,
2893                                         pr->replies_seen);
2894           GNUNET_STATISTICS_update (stats,
2895                                     gettext_noop ("# client searches updated (merged content seen list)"),
2896                                     1,
2897                                     GNUNET_NO);
2898           GNUNET_SERVER_receive_done (client,
2899                                       GNUNET_OK);
2900           return;
2901         }
2902     }
2903   GNUNET_STATISTICS_update (stats,
2904                             gettext_noop ("# client searches active"),
2905                             1,
2906                             GNUNET_NO);
2907   pr = GNUNET_malloc (sizeof (struct PendingRequest) + 
2908                       ((type == GNUNET_DATASTORE_BLOCKTYPE_SBLOCK)?sizeof(GNUNET_HashCode):0));
2909   crl = GNUNET_malloc (sizeof (struct ClientRequestList));
2910   memset (crl, 0, sizeof (struct ClientRequestList));
2911   crl->client_list = cl;
2912   GNUNET_CONTAINER_DLL_insert (cl->rl_head,
2913                                cl->rl_tail,
2914                                crl);  
2915   crl->req = pr;
2916   pr->type = type;
2917   pr->client_request_list = crl;
2918   GNUNET_array_grow (pr->replies_seen,
2919                      pr->replies_seen_size,
2920                      sc);
2921   memcpy (pr->replies_seen,
2922           &sm[1],
2923           sc * sizeof (GNUNET_HashCode));
2924   pr->replies_seen_off = sc;
2925   pr->anonymity_level = ntohl (sm->anonymity_level); 
2926   pr->bf = refresh_bloomfilter (pr->replies_seen_off,
2927                                 &pr->mingle,
2928                                 &pr->bf_size,
2929                                 pr->replies_seen);
2930  pr->query = sm->query;
2931   switch (type)
2932     {
2933     case GNUNET_DATASTORE_BLOCKTYPE_DBLOCK:
2934     case GNUNET_DATASTORE_BLOCKTYPE_IBLOCK:
2935       if (0 != memcmp (&sm->target,
2936                        &all_zeros,
2937                        sizeof (GNUNET_HashCode)))
2938         pr->target_pid = GNUNET_PEER_intern ((const struct GNUNET_PeerIdentity*) &sm->target);
2939       break;
2940     case GNUNET_DATASTORE_BLOCKTYPE_SBLOCK:
2941       pr->namespace = (GNUNET_HashCode*) &pr[1];
2942       memcpy (&pr[1], &sm->target, sizeof (GNUNET_HashCode));
2943       break;
2944     default:
2945       break;
2946     }
2947   GNUNET_CONTAINER_multihashmap_put (query_request_map,
2948                                      &sm->query,
2949                                      pr,
2950                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2951   if (type == GNUNET_DATASTORE_BLOCKTYPE_DBLOCK)
2952     type = GNUNET_DATASTORE_BLOCKTYPE_ANY; /* get on-demand blocks too! */
2953   pr->drq = GNUNET_FS_drq_get (&sm->query,
2954                                type,                           
2955                                &process_local_reply,
2956                                pr,
2957                                GNUNET_CONSTANTS_SERVICE_TIMEOUT,
2958                                GNUNET_YES);
2959 }
2960
2961
2962 /* **************************** Startup ************************ */
2963
2964
2965 /**
2966  * List of handlers for P2P messages
2967  * that we care about.
2968  */
2969 static struct GNUNET_CORE_MessageHandler p2p_handlers[] =
2970   {
2971     { &handle_p2p_get, 
2972       GNUNET_MESSAGE_TYPE_FS_GET, 0 },
2973     { &handle_p2p_put, 
2974       GNUNET_MESSAGE_TYPE_FS_PUT, 0 },
2975     { NULL, 0, 0 }
2976   };
2977
2978
2979 /**
2980  * List of handlers for the messages understood by this
2981  * service.
2982  */
2983 static struct GNUNET_SERVER_MessageHandler handlers[] = {
2984   {&GNUNET_FS_handle_index_start, NULL, 
2985    GNUNET_MESSAGE_TYPE_FS_INDEX_START, 0},
2986   {&GNUNET_FS_handle_index_list_get, NULL, 
2987    GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET, sizeof(struct GNUNET_MessageHeader) },
2988   {&GNUNET_FS_handle_unindex, NULL, GNUNET_MESSAGE_TYPE_FS_UNINDEX, 
2989    sizeof (struct UnindexMessage) },
2990   {&handle_start_search, NULL, GNUNET_MESSAGE_TYPE_FS_START_SEARCH, 
2991    0 },
2992   {NULL, NULL, 0, 0}
2993 };
2994
2995
2996 /**
2997  * Process fs requests.
2998  *
2999  * @param s scheduler to use
3000  * @param server the initialized server
3001  * @param c configuration to use
3002  */
3003 static int
3004 main_init (struct GNUNET_SCHEDULER_Handle *s,
3005            struct GNUNET_SERVER_Handle *server,
3006            const struct GNUNET_CONFIGURATION_Handle *c)
3007 {
3008   sched = s;
3009   cfg = c;
3010   stats = GNUNET_STATISTICS_create (sched, "fs", cfg);
3011   connected_peers = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
3012   query_request_map = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
3013   peer_request_map = GNUNET_CONTAINER_multihashmap_create (128); // FIXME: get size from config
3014   requests_by_expiration_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN); 
3015   core = GNUNET_CORE_connect (sched,
3016                               cfg,
3017                               GNUNET_TIME_UNIT_FOREVER_REL,
3018                               NULL,
3019                               NULL,
3020                               NULL,
3021                               &peer_connect_handler,
3022                               &peer_disconnect_handler,
3023                               NULL, GNUNET_NO,
3024                               NULL, GNUNET_NO,
3025                               p2p_handlers);
3026   if (NULL == core)
3027     {
3028       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3029                   _("Failed to connect to `%s' service.\n"),
3030                   "core");
3031       GNUNET_CONTAINER_multihashmap_destroy (connected_peers);
3032       connected_peers = NULL;
3033       GNUNET_CONTAINER_multihashmap_destroy (query_request_map);
3034       query_request_map = NULL;
3035       GNUNET_CONTAINER_heap_destroy (requests_by_expiration_heap);
3036       requests_by_expiration_heap = NULL;
3037       GNUNET_CONTAINER_multihashmap_destroy (peer_request_map);
3038       peer_request_map = NULL;
3039
3040       return GNUNET_SYSERR;
3041     }  
3042   GNUNET_SERVER_disconnect_notify (server, 
3043                                    &handle_client_disconnect,
3044                                    NULL);
3045   GNUNET_SERVER_add_handlers (server, handlers);
3046   GNUNET_SCHEDULER_add_delayed (sched,
3047                                 GNUNET_TIME_UNIT_FOREVER_REL,
3048                                 &shutdown_task,
3049                                 NULL);
3050   return GNUNET_OK;
3051 }
3052
3053
3054 /**
3055  * Process fs requests.
3056  *
3057  * @param cls closure
3058  * @param sched scheduler to use
3059  * @param server the initialized server
3060  * @param cfg configuration to use
3061  */
3062 static void
3063 run (void *cls,
3064      struct GNUNET_SCHEDULER_Handle *sched,
3065      struct GNUNET_SERVER_Handle *server,
3066      const struct GNUNET_CONFIGURATION_Handle *cfg)
3067 {
3068   if ( (GNUNET_OK != GNUNET_FS_drq_init (sched, cfg)) ||
3069        (GNUNET_OK != GNUNET_FS_indexing_init (sched, cfg)) ||
3070        (GNUNET_OK != main_init (sched, server, cfg)) )
3071     {    
3072       GNUNET_SCHEDULER_shutdown (sched);
3073       return;   
3074     }
3075 }
3076
3077
3078 /**
3079  * The main function for the fs service.
3080  *
3081  * @param argc number of arguments from the command line
3082  * @param argv command line arguments
3083  * @return 0 ok, 1 on error
3084  */
3085 int
3086 main (int argc, char *const *argv)
3087 {
3088   return (GNUNET_OK ==
3089           GNUNET_SERVICE_run (argc,
3090                               argv,
3091                               "fs",
3092                               GNUNET_SERVICE_OPTION_NONE,
3093                               &run, NULL)) ? 0 : 1;
3094 }
3095
3096 /* end of gnunet-service-fs.c */