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    * Current TTL for the request.
  96    */
  97   struct GNUNET_TIME_Absolute ttl;
  98
  99   /**
 100    * When did we start with the request.
 101    */
 102   struct GNUNET_TIME_Absolute start_time;
 103
 104   /**
 105    * Desired anonymity level.
 106    */
 107   uint32_t anonymity_level;
 108
 109   /**
 110    * Priority that this request (still) has for us.
 111    */
 112   uint32_t priority;
 113
 114   /**
 115    * Priority that this request (originally) had for us.
 116    */
 117   uint32_t original_priority;
 118
 119   /**
 120    * Options for the request.
 121    */
 122   enum GSF_PendingRequestOptions options;
 123
 124   /**
 125    * Type of the requested block.
 126    */
 127   enum GNUNET_BLOCK_Type type;
 128
 129   /**
 130    * Number of results we have found for this request so far.
 131    */
 132   unsigned int results_found;
 133
 134   /**
 135    * Is the 'target' value set to a valid peer identity?
 136    */
 137   int has_target;
 138
 139 };
 140
 141
 142 /**
 143  * Handle a reply to a pending request.  Also called if a request
 144  * expires (then with data == NULL).  The handler may be called
 145  * many times (depending on the request type), but will not be
 146  * called during or after a call to GSF_pending_request_cancel
 147  * and will also not be called anymore after a call signalling
 148  * expiration.
 149  *
 150  * @param cls user-specified closure
 151  * @param pr handle to the original pending request
 152  * @param expiration when does 'data' expire?
 153  * @param data response data, NULL on request expiration
 154  * @param data_len number of bytes in data
 155  * @param more GNUNET_YES if the request remains active (may call
 156  *             this function again), GNUNET_NO if the request is
 157  *             finished (client must not call GSF_pending_request_cancel_)
 158  */
 159 typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
 160                                                struct GSF_PendingRequest *pr,
 161                                                struct GNUNET_TIME_Absolute expiration,
 162                                                const void *data,
 163                                                size_t data_len,
 164                                                int more);
 165
 166
 167 /**
 168  * Create a new pending request.
 169  *
 170  * @param options request options
 171  * @param type type of the block that is being requested
 172  * @param query key for the lookup
 173  * @param namespace namespace to lookup, NULL for no namespace
 174  * @param target preferred target for the request, NULL for none
 175  * @param bf_data raw data for bloom filter for known replies, can be NULL
 176  * @param bf_size number of bytes in bf_data
 177  * @param mingle mingle value for bf
 178  * @param anonymity_level desired anonymity level
 179  * @param priority maximum outgoing cummulative request priority to use
 180  * @param ttl current time-to-live for the request
 181  * @param replies_seen hash codes of known local replies
 182  * @param replies_seen_count size of the 'replies_seen' array
 183  * @param rh handle to call when we get a reply
 184  * @param rh_cls closure for rh
 185  * @return handle for the new pending request
 186  */
 187 struct GSF_PendingRequest *
 188 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
 189                              enum GNUNET_BLOCK_Type type,
 190                              const GNUNET_HashCode *query,
 191                              const GNUNET_HashCode *namespace,
 192                              const struct GNUNET_PeerIdentity *target,
 193                              const char *bf_data,
 194                              size_t bf_size,
 195                              uint32_t mingle,
 196                              uint32_t anonymity_level,
 197                              uint32_t priority,
 198                              int32_t ttl,
 199                              const GNUNET_HashCode *replies_seen,
 200                              unsigned int replies_seen_count,
 201                              GSF_PendingRequestReplyHandler rh,
 202                              void *rh_cls);
 203
 204
 205 /**
 206  * Update a given pending request with additional replies
 207  * that have been seen.
 208  *
 209  * @param pr request to update
 210  * @param replies_seen hash codes of replies that we've seen
 211  * @param replies_seen_count size of the replies_seen array
 212  */
 213 void
 214 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
 215                              const GNUNET_HashCode *replies_seen,
 216                              unsigned int replies_seen_count);
 217
 218
 219 /**
 220  * Obtain the public data associated with a pending request
 221  *
 222  * @param pr pending request
 223  * @return associated public data
 224  */
 225 struct GSF_PendingRequestData *
 226 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
 227
 228
 229 /**
 230  * Generate the message corresponding to the given pending request for
 231  * transmission to other peers (or at least determine its size).
 232  *
 233  * @param pr request to generate the message for
 234  * @param do_route are we routing the reply
 235  * @param buf_size number of bytes available in buf
 236  * @param buf where to copy the message (can be NULL)
 237  * @return number of bytes needed (if buf_size too small) or used
 238  */
 239 size_t
 240 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
 241                                   int do_route,
 242                                   size_t buf_size,
 243                                   void *buf);
 244
 245
 246 /**
 247  * Explicitly cancel a pending request.
 248  *
 249  * @param pr request to cancel
 250  */
 251 void
 252 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr);
 253
 254
 255 /**
 256  * Signature of function called on each request.
 257  * (Note: 'subtype' of GNUNET_CONTAINER_HashMapIterator).
 258  *
 259  * @param cls closure
 260  * @param key query for the request
 261  * @param pr handle to the pending request
 262  * @return GNUNET_YES to continue to iterate
 263  */
 264 typedef int (*GSF_PendingRequestIterator)(void *cls,
 265                                           const GNUNET_HashCode *key,
 266                                           struct GSF_PendingRequest *pr);
 267
 268
 269 /**
 270  * Iterate over all pending requests.
 271  *
 272  * @param it function to call for each request
 273  * @param cls closure for it
 274  */
 275 void
 276 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
 277                                void *cls);
 278
 279
 280 /**
 281  * Handle P2P "CONTENT" message.  Checks that the message is
 282  * well-formed and then checks if there are any pending requests for
 283  * this content and possibly passes it on (to local clients or other
 284  * peers).  Does NOT perform migration (content caching at this peer).
 285  *
 286  * @param cp the other peer involved (sender or receiver, NULL
 287  *        for loopback messages where we are both sender and receiver)
 288  * @param message the actual message
 289  * @return GNUNET_OK if the message was well-formed,
 290  *         GNUNET_SYSERR if the message was malformed (close connection,
 291  *         do not cache under any circumstances)
 292  */
 293 int
 294 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
 295                          const struct GNUNET_MessageHeader *message);
 296
 297
 298 /**
 299  * Iterator called on each result obtained for a DHT
 300  * operation that expects a reply
 301  *
 302  * @param cls closure, the 'struct GSF_PendingRequest *'.
 303  * @param exp when will this value expire
 304  * @param key key of the result
 305  * @param get_path NULL-terminated array of pointers
 306  *                 to the peers on reverse GET path (or NULL if not recorded)
 307  * @param put_path NULL-terminated array of pointers
 308  *                 to the peers on the PUT path (or NULL if not recorded)
 309  * @param type type of the result
 310  * @param size number of bytes in data
 311  * @param data pointer to the result data
 312  */
 313 void
 314 GSF_handle_dht_reply_ (void *cls,
 315                        struct GNUNET_TIME_Absolute exp,
 316                        const GNUNET_HashCode * key,
 317                        const struct GNUNET_PeerIdentity * const *get_path,
 318                        const struct GNUNET_PeerIdentity * const *put_path,
 319                        enum GNUNET_BLOCK_Type type,
 320                        size_t size,
 321                        const void *data);
 322
 323
 324 /**
 325  * Setup the subsystem.
 326  */
 327 void
 328 GSF_pending_request_init_ (void);
 329
 330
 331 /**
 332  * Shutdown the subsystem.
 333  */
 334 void
 335 GSF_pending_request_done_ (void);
 336
 337
 338 #endif
 339 /* end of gnunet-service-fs_pr.h */