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