src/fs/gnunet-service-fs_pr.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file fs/gnunet-service-fs_pr.h
  23  * @brief API to handle pending requests
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_FS_PR_H
  27 #define GNUNET_SERVICE_FS_PR_H
  28
  29 #include "gnunet-service-fs.h"
  30
  31
  32 /**
  33  * Options for pending requests (bits to be ORed).
  34  */
  35 enum GSF_PendingRequestOptions
  36   {
  37     /**
  38      * Request must only be processed locally.
  39      */
  40     GSF_PRO_LOCAL_ONLY = 1,
  41
  42     /**
  43      * Request must only be forwarded (no routing)
  44      */
  45     GSF_PRO_FORWARD_ONLY = 2,
  46
  47     /**
  48      * Request persists indefinitely (no expiration).
  49      */
  50     GSF_PRO_REQUEST_EXPIRES = 4,
  51
  52     /**
  53      * Request is allowed to refresh bloomfilter and change mingle value.
  54      */
  55     GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,
  56
  57     /**
  58      * Request priority is allowed to be exceeded.
  59      */
  60     GSF_PRO_PRIORITY_UNLIMITED = 16,
  61
  62     /**
  63      * Option mask for typical local requests.
  64      */
  65     GSF_PRO_LOCAL_REQUEST = (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
  66
  67   };
  68
  69
  70 /**
  71  * Public data (in the sense of not encapsulated within
  72  * 'gnunet-service-fs_pr', not in the sense of network-wide
  73  * known) associated with each pending request.
  74  */
  75 struct GSF_PendingRequestData
  76 {
  77
  78   /**
  79    * Primary query hash for this request.
  80    */
  81   GNUNET_HashCode query;
  82
  83   /**
  84    * Namespace to query, only set if the type is SBLOCK.
  85    */
  86   GNUNET_HashCode namespace;
  87
  88   /**
  89    * Identity of a peer hosting the content, only set if
  90    * 'has_target' is GNUNET_YES.
  91    */
  92   struct GNUNET_PeerIdentity target;
  93
  94   /**
  95    * Fields for the plan module to track a DLL with the request.
  96    */
  97   struct GSF_RequestPlanReference *rpr_head;
  98
  99   /**
 100    * Fields for the plan module to track a DLL with the request.
 101    */
 102   struct GSF_RequestPlanReference *rpr_tail;
 103
 104   /**
 105    * Current TTL for the request.
 106    */
 107   struct GNUNET_TIME_Absolute ttl;
 108
 109   /**
 110    * When did we start with the request.
 111    */
 112   struct GNUNET_TIME_Absolute start_time;
 113
 114   /**
 115    * Desired anonymity level.
 116    */
 117   uint32_t anonymity_level;
 118
 119   /**
 120    * Priority that this request (still) has for us.
 121    */
 122   uint32_t priority;
 123
 124   /**
 125    * Priority that this request (originally) had for us.
 126    */
 127   uint32_t original_priority;
 128
 129   /**
 130    * Options for the request.
 131    */
 132   enum GSF_PendingRequestOptions options;
 133
 134   /**
 135    * Type of the requested block.
 136    */
 137   enum GNUNET_BLOCK_Type type;
 138
 139   /**
 140    * Number of results we have found for this request so far.
 141    */
 142   unsigned int results_found;
 143
 144   /**
 145    * Is the 'target' value set to a valid peer identity?
 146    */
 147   int has_target;
 148
 149 };
 150
 151
 152 /**
 153  * Handle a reply to a pending request.  Also called if a request
 154  * expires (then with data == NULL).  The handler may be called
 155  * many times (depending on the request type), but will not be
 156  * called during or after a call to GSF_pending_request_cancel
 157  * and will also not be called anymore after a call signalling
 158  * expiration.
 159  *
 160  * @param cls user-specified closure
 161  * @param eval evaluation of the result
 162  * @param pr handle to the original pending request
 163  * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
 164  * @param expiration when does 'data' expire?
 165  * @param type type of the block
 166  * @param data response data, NULL on request expiration
 167  * @param data_len number of bytes in data
 168  */
 169 typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
 170                                                enum GNUNET_BLOCK_EvaluationResult eval,
 171                                                struct GSF_PendingRequest *pr,
 172                                                uint32_t reply_anonymity_level,
 173                                                struct GNUNET_TIME_Absolute expiration,
 174                                                enum GNUNET_BLOCK_Type type,
 175                                                const void *data,
 176                                                size_t data_len);
 177
 178
 179 /**
 180  * Create a new pending request.
 181  *
 182  * @param options request options
 183  * @param type type of the block that is being requested
 184  * @param query key for the lookup
 185  * @param namespace namespace to lookup, NULL for no namespace
 186  * @param target preferred target for the request, NULL for none
 187  * @param bf_data raw data for bloom filter for known replies, can be NULL
 188  * @param bf_size number of bytes in bf_data
 189  * @param mingle mingle value for bf
 190  * @param anonymity_level desired anonymity level
 191  * @param priority maximum outgoing cummulative request priority to use
 192  * @param ttl current time-to-live for the request
 193  * @param sender_pid peer ID to use for the sender when forwarding, 0 for none;
 194  *                   reference counter is taken over by this function
 195  * @param replies_seen hash codes of known local replies
 196  * @param replies_seen_count size of the 'replies_seen' array
 197  * @param rh handle to call when we get a reply
 198  * @param rh_cls closure for rh
 199  * @return handle for the new pending request
 200  */
 201 struct GSF_PendingRequest *
 202 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
 203                              enum GNUNET_BLOCK_Type type,
 204                              const GNUNET_HashCode *query,
 205                              const GNUNET_HashCode *namespace,
 206                              const struct GNUNET_PeerIdentity *target,
 207                              const char *bf_data,
 208                              size_t bf_size,
 209                              uint32_t mingle,
 210                              uint32_t anonymity_level,
 211                              uint32_t priority,
 212                              int32_t ttl,
 213                              GNUNET_PEER_Id sender_pid,
 214                              const GNUNET_HashCode *replies_seen,
 215                              unsigned int replies_seen_count,
 216                              GSF_PendingRequestReplyHandler rh,
 217                              void *rh_cls);
 218
 219
 220 /**
 221  * Update a given pending request with additional replies
 222  * that have been seen.
 223  *
 224  * @param pr request to update
 225  * @param replies_seen hash codes of replies that we've seen
 226  * @param replies_seen_count size of the replies_seen array
 227  */
 228 void
 229 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
 230                              const GNUNET_HashCode *replies_seen,
 231                              unsigned int replies_seen_count);
 232
 233
 234 /**
 235  * Obtain the public data associated with a pending request
 236  *
 237  * @param pr pending request
 238  * @return associated public data
 239  */
 240 struct GSF_PendingRequestData *
 241 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
 242
 243
 244 /**
 245  * Test if two pending requests are compatible (would generate
 246  * the same query modulo filters and should thus be processed
 247  * jointly).
 248  *
 249  * @param pra a pending request
 250  * @param pra another pending request
 251  * @return GNUNET_OK if the requests are compatible
 252  */
 253 int
 254 GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
 255                                     struct GSF_PendingRequest *prb);
 256
 257
 258 /**
 259  * Generate the message corresponding to the given pending request for
 260  * transmission to other peers (or at least determine its size).
 261  *
 262  * @param pr request to generate the message for
 263  * @param buf_size number of bytes available in buf
 264  * @param buf where to copy the message (can be NULL)
 265  * @return number of bytes needed (if buf_size too small) or used
 266  */
 267 size_t
 268 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
 269                                   size_t buf_size,
 270                                   void *buf);
 271
 272
 273 /**
 274  * Explicitly cancel a pending request.
 275  *
 276  * @param pr request to cancel
 277  * @param full_cleanup fully purge the request
 278  */
 279 void
 280 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr,
 281                              int full_cleanup);
 282
 283
 284 /**
 285  * Signature of function called on each request.
 286  * (Note: 'subtype' of GNUNET_CONTAINER_HashMapIterator).
 287  *
 288  * @param cls closure
 289  * @param key query for the request
 290  * @param pr handle to the pending request
 291  * @return GNUNET_YES to continue to iterate
 292  */
 293 typedef int (*GSF_PendingRequestIterator)(void *cls,
 294                                           const GNUNET_HashCode *key,
 295                                           struct GSF_PendingRequest *pr);
 296
 297
 298 /**
 299  * Iterate over all pending requests.
 300  *
 301  * @param it function to call for each request
 302  * @param cls closure for it
 303  */
 304 void
 305 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
 306                                void *cls);
 307
 308
 309 /**
 310  * Handle P2P "CONTENT" message.  Checks that the message is
 311  * well-formed and then checks if there are any pending requests for
 312  * this content and possibly passes it on (to local clients or other
 313  * peers).  Does NOT perform migration (content caching at this peer).
 314  *
 315  * @param cp the other peer involved (sender or receiver, NULL
 316  *        for loopback messages where we are both sender and receiver)
 317  * @param message the actual message
 318  * @return GNUNET_OK if the message was well-formed,
 319  *         GNUNET_SYSERR if the message was malformed (close connection,
 320  *         do not cache under any circumstances)
 321  */
 322 int
 323 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
 324                          const struct GNUNET_MessageHeader *message);
 325
 326
 327 /**
 328  * Consider looking up the data in the DHT (anonymity-level permitting).
 329  *
 330  * @param pr the pending request to process
 331  */
 332 void
 333 GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
 334
 335
 336 /**
 337  * Function to be called after we're done processing
 338  * replies from the local lookup.
 339  *
 340  * @param cls closure
 341  * @param pr the pending request we were processing
 342  * @param result final datastore lookup result
 343  */
 344 typedef void (*GSF_LocalLookupContinuation)(void *cls,
 345                                             struct GSF_PendingRequest *pr,
 346                                             enum GNUNET_BLOCK_EvaluationResult result);
 347
 348
 349 /**
 350  * Look up the request in the local datastore.
 351  *
 352  * @param pr the pending request to process
 353  * @param cont function to call at the end
 354  * @param cont_cls closure for cont
 355  */
 356 void
 357 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
 358                    GSF_LocalLookupContinuation cont,
 359                    void *cont_cls);
 360
 361
 362 /**
 363  * Setup the subsystem.
 364  */
 365 void
 366 GSF_pending_request_init_ (void);
 367
 368
 369 /**
 370  * Shutdown the subsystem.
 371  */
 372 void
 373 GSF_pending_request_done_ (void);
 374
 375
 376 #endif
 377 /* end of gnunet-service-fs_pr.h */