src/include/gnunet_datastore_plugin.h

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