src/include/gnunet_datastore_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2009, 2011 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * API for the database backend plugins.
  26  *
  27  * @defgroup datastore-plugin  Data Store service plugin API
  28  * API for the database backend plugins.
  29  * @{
  30  */
  31 #ifndef PLUGIN_DATASTORE_H
  32 #define PLUGIN_DATASTORE_H
  33
  34 #include "gnunet_block_lib.h"
  35 #include "gnunet_configuration_lib.h"
  36 #include "gnunet_datastore_service.h"
  37 #include "gnunet_statistics_service.h"
  38 #include "gnunet_scheduler_lib.h"
  39
  40
  41 /**
  42  * How many bytes of overhead will we assume per entry
  43  * in any DB (for reservations)?
  44  */
  45 #define GNUNET_DATASTORE_ENTRY_OVERHEAD 256
  46
  47
  48 /**
  49  * Function invoked to notify service of disk utilization
  50  * changes.
  51  *
  52  * @param cls closure
  53  * @param delta change in disk utilization,
  54  *        0 for "reset to empty"
  55  */
  56 typedef void
  57 (*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls,
  58                                            int delta);
  59
  60
  61 /**
  62  * The datastore service will pass a pointer to a struct
  63  * of this type as the first and only argument to the
  64  * entry point of each datastore plugin.
  65  */
  66 struct GNUNET_DATASTORE_PluginEnvironment
  67 {
  68   /**
  69    * Configuration to use.
  70    */
  71   const struct GNUNET_CONFIGURATION_Handle *cfg;
  72
  73   /**
  74    * Function to call on disk utilization change.
  75    */
  76   GNUNET_DATASTORE_DiskUtilizationChange duc;
  77
  78   /**
  79    * Closure.
  80    */
  81   void *cls;
  82
  83 };
  84
  85
  86 /**
  87  * An processor over a set of items stored in the datastore.
  88  *
  89  * @param cls closure
  90  * @param key key for the content
  91  * @param size number of bytes in data
  92  * @param data content stored
  93  * @param type type of the content
  94  * @param priority priority of the content
  95  * @param anonymity anonymity-level for the content
  96  * @param expiration expiration time for the content
  97  * @param uid unique identifier for the datum
  98  * @return #GNUNET_OK to keep the item
  99  *         #GNUNET_NO to delete the item
 100  */
 101 typedef int
 102 (*PluginDatumProcessor) (void *cls,
 103                          const struct GNUNET_HashCode *key,
 104                          uint32_t size,
 105                          const void *data,
 106                          enum GNUNET_BLOCK_Type type,
 107                          uint32_t priority,
 108                          uint32_t anonymity,
 109                          struct GNUNET_TIME_Absolute expiration,
 110                          uint64_t uid);
 111
 112
 113 /**
 114  * Get an estimate of how much space the database is
 115  * currently using.
 116  *
 117  * NB: estimate is an output parameter because emscripten cannot handle
 118  * returning 64-bit integers from dynamically loaded modules.
 119  *
 120  * @param cls closure
 121  * @param estimate location to store estimate
 122  * @return number of bytes used on disk
 123  */
 124 typedef void
 125 (*PluginEstimateSize) (void *cls,
 126                        unsigned long long *estimate);
 127
 128
 129 /**
 130  * Put continuation.
 131  *
 132  * @param cls closure
 133  * @param key key for the item stored
 134  * @param size size of the item stored
 135  * @param status #GNUNET_OK or #GNUNET_SYSERROR
 136  * @param msg error message on error
 137  */
 138 typedef void
 139 (*PluginPutCont) (void *cls,
 140                   const struct GNUNET_HashCode *key,
 141                   uint32_t size,
 142                   int status,
 143                   const char *msg);
 144
 145
 146 /**
 147  * Store an item in the datastore.  If the item is already present,
 148  * the priorities and replication levels are summed up and the higher
 149  * expiration time and lower anonymity level is used.
 150  *
 151  * @param cls closure
 152  * @param key key for the item
 153  * @param size number of bytes in @a data
 154  * @param data content stored
 155  * @param type type of the content
 156  * @param priority priority of the content
 157  * @param anonymity anonymity-level for the content
 158  * @param replication replication-level for the content
 159  * @param expiration expiration time for the content
 160  * @param cont continuation called with success or failure status
 161  * @param cont_cls continuation closure for @a cont
 162  */
 163 typedef void
 164 (*PluginPut) (void *cls, const struct GNUNET_HashCode *key,
 165               uint32_t size,
 166               const void *data,
 167               enum GNUNET_BLOCK_Type type,
 168               uint32_t priority,
 169               uint32_t anonymity,
 170               uint32_t replication,
 171               struct GNUNET_TIME_Absolute expiration,
 172               PluginPutCont cont,
 173               void *cont_cls);
 174
 175
 176 /**
 177  * An processor over a set of keys stored in the datastore.
 178  *
 179  * @param cls closure
 180  * @param key key in the data store, if NULL iteration is finished
 181  * @param count how many values are stored under this key in the datastore
 182  */
 183 typedef void
 184 (*PluginKeyProcessor) (void *cls,
 185                        const struct GNUNET_HashCode *key,
 186                        unsigned int count);
 187
 188
 189 /**
 190  * Get all of the keys in the datastore.
 191  *
 192  * @param cls closure
 193  * @param proc function to call on each key
 194  * @param proc_cls closure for @a proc
 195  */
 196 typedef void
 197 (*PluginGetKeys) (void *cls,
 198                   PluginKeyProcessor proc,
 199                   void *proc_cls);
 200
 201
 202 /**
 203  * Get one of the results for a particular key in the datastore.
 204  *
 205  * @param cls closure
 206  * @param offset offset of the result (modulo num-results);
 207  *               specific ordering does not matter for the offset
 208  * @param key key to match, never NULL
 209  * @param vhash hash of the value, maybe NULL (to
 210  *        match all values that have the right key).
 211  *        Note that for DBlocks there is no difference
 212  *        betwen key and vhash, but for other blocks
 213  *        there may be!
 214  * @param type entries of which type are relevant?
 215  *     Use 0 for any type.
 216  * @param proc function to call on the matching value;
 217  *        proc should be called with NULL if there is no result
 218  * @param proc_cls closure for @a proc
 219  */
 220 typedef void
 221 (*PluginGetKey) (void *cls,
 222                  uint64_t offset,
 223                  const struct GNUNET_HashCode *key,
 224                  const struct GNUNET_HashCode *vhash,
 225                  enum GNUNET_BLOCK_Type type,
 226                  PluginDatumProcessor proc,
 227                  void *proc_cls);
 228
 229
 230 /**
 231  * Get a random item (additional constraints may apply depending on
 232  * the specific implementation).  Calls @a proc with all values ZERO or
 233  * NULL if no item applies, otherwise @a proc is called once and only
 234  * once with an item.
 235  *
 236  * @param cls closure
 237  * @param proc function to call the value (once only).
 238  * @param proc_cls closure for @a proc
 239  */
 240 typedef void
 241 (*PluginGetRandom) (void *cls,
 242                     PluginDatumProcessor proc,
 243                     void *proc_cls);
 244
 245
 246 /**
 247  * Update continuation.
 248  *
 249  * @param cls closure
 250  * @param status #GNUNET_OK or #GNUNET_SYSERR
 251  * @param msg error message on error
 252  */
 253 typedef void
 254 (*PluginUpdateCont) (void *cls,
 255                      int status,
 256                      const char *msg);
 257
 258
 259 /**
 260  * Update the priority for a particular key in the datastore.  If
 261  * the expiration time in value is different than the time found in
 262  * the datastore, the higher value should be kept.  For the
 263  * anonymity level, the lower value is to be used.  The specified
 264  * priority should be added to the existing priority, ignoring the
 265  * priority in value.
 266  *
 267  * @param cls closure
 268  * @param uid unique identifier of the datum
 269  * @param delta by how much should the priority
 270  *     change?  If priority + delta < 0 the
 271  *     priority should be set to 0 (never go
 272  *     negative).
 273  * @param expire new expiration time should be the
 274  *     MAX of any existing expiration time and
 275  *     this value
 276  * @param cont continuation called with success or failure status
 277  * @param cons_cls continuation closure
 278  */
 279 typedef void
 280 (*PluginUpdate) (void *cls,
 281                  uint64_t uid,
 282                  int delta,
 283                  struct GNUNET_TIME_Absolute expire,
 284                  PluginUpdateCont cont,
 285                  void *cont_cls);
 286
 287
 288 /**
 289  * Select a single item from the datastore at the specified offset
 290  * (among those applicable).
 291  *
 292  * @param cls closure
 293  * @param offset offset of the result (modulo num-results);
 294  *               specific ordering does not matter for the offset
 295  * @param type entries of which type should be considered?
 296  *        Must not be zero (ANY).
 297  * @param proc function to call on the matching value
 298  * @param proc_cls closure for @a proc
 299  */
 300 typedef void
 301 (*PluginGetType) (void *cls,
 302                   uint64_t offset,
 303                   enum GNUNET_BLOCK_Type type,
 304                   PluginDatumProcessor proc,
 305                   void *proc_cls);
 306
 307
 308 /**
 309  * Drop database.
 310  *
 311  * @param cls closure
 312  */
 313 typedef void
 314 (*PluginDrop) (void *cls);
 315
 316
 317 /**
 318  * Each plugin is required to return a pointer to a struct of this
 319  * type as the return value from its entry point.
 320  */
 321 struct GNUNET_DATASTORE_PluginFunctions
 322 {
 323
 324   /**
 325    * Closure to use for all of the following callbacks
 326    * (except "next_request").
 327    */
 328   void *cls;
 329
 330   /**
 331    * Calculate the current on-disk size of the SQ store.  Estimates
 332    * are fine, if that's the only thing available.
 333    */
 334   PluginEstimateSize estimate_size;
 335
 336   /**
 337    * Function to store an item in the datastore.
 338    */
 339   PluginPut put;
 340
 341   /**
 342    * Update the priority for a particular key in the datastore.  If
 343    * the expiration time in value is different than the time found in
 344    * the datastore, the higher value should be kept.  For the
 345    * anonymity level, the lower value is to be used.  The specified
 346    * priority should be added to the existing priority, ignoring the
 347    * priority in value.
 348    */
 349   PluginUpdate update;
 350
 351   /**
 352    * Get a particular datum matching a given hash from the datastore.
 353    */
 354   PluginGetKey get_key;
 355
 356   /**
 357    * Get datum (of the specified type) with anonymity level zero.
 358    * This function is allowed to ignore the 'offset' argument
 359    * and instead return a random result (with zero anonymity of
 360    * the correct type) if implementing an offset is expensive.
 361    */
 362   PluginGetType get_zero_anonymity;
 363
 364   /**
 365    * Function to get a random item with high replication score from
 366    * the database, lowering the item's replication score.  Returns a
 367    * single random item from those with the highest replication
 368    * counters.  The item's replication counter is decremented by one
 369    * IF it was positive before.
 370    */
 371   PluginGetRandom get_replication;
 372
 373   /**
 374    * Function to get a random expired item or, if none are expired,
 375    * either the oldest entry or one with a low priority (depending
 376    * on what was efficiently implementable).
 377    */
 378   PluginGetRandom get_expiration;
 379
 380   /**
 381    * Delete the database.  The next operation is
 382    * guaranteed to be unloading of the module.
 383    */
 384   PluginDrop drop;
 385
 386   /**
 387    * Iterate over all keys in the database.
 388    */
 389   PluginGetKeys get_keys;
 390
 391 };
 392
 393 #endif
 394
 395 /** @} */  /* end of group */