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 2, 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  *
  92  * @return GNUNET_OK to keep the item
  93  *         GNUNET_NO to delete the item
  94  */
  95 typedef int (*PluginDatumProcessor) (void *cls, const GNUNET_HashCode * key,
  96                                      uint32_t size, const void *data,
  97                                      enum GNUNET_BLOCK_Type type,
  98                                      uint32_t priority, uint32_t anonymity,
  99                                      struct GNUNET_TIME_Absolute expiration,
 100                                      uint64_t uid);
 101
 102 /**
 103  * Get an estimate of how much space the database is
 104  * currently using.
 105  *
 106  * @param cls closure
 107  * @return number of bytes used on disk
 108  */
 109 typedef unsigned long long (*PluginEstimateSize) (void *cls);
 110
 111
 112 /**
 113  * Store an item in the datastore.  If the item is already present,
 114  * the priorities and replication levels are summed up and the higher
 115  * expiration time and lower anonymity level is used.
 116  *
 117  * @param cls closure
 118  * @param key key for the item
 119  * @param size number of bytes in data
 120  * @param data content stored
 121  * @param type type of the content
 122  * @param priority priority of the content
 123  * @param anonymity anonymity-level for the content
 124  * @param replication replication-level for the content
 125  * @param expiration expiration time for the content
 126  * @param msg set to an error message (on failure)
 127  * @return GNUNET_OK on success,
 128  *         GNUNET_SYSERR on failure
 129  */
 130 typedef int (*PluginPut) (void *cls, const GNUNET_HashCode * key, uint32_t size,
 131                           const void *data, enum GNUNET_BLOCK_Type type,
 132                           uint32_t priority, uint32_t anonymity,
 133                           uint32_t replication,
 134                           struct GNUNET_TIME_Absolute expiration, char **msg);
 135
 136
 137 /**
 138  * Get one of the results for a particular key in the datastore.
 139  *
 140  * @param cls closure
 141  * @param offset offset of the result (modulo num-results);
 142  *               specific ordering does not matter for the offset
 143  * @param key key to match, never NULL
 144  * @param vhash hash of the value, maybe NULL (to
 145  *        match all values that have the right key).
 146  *        Note that for DBlocks there is no difference
 147  *        betwen key and vhash, but for other blocks
 148  *        there may be!
 149  * @param type entries of which type are relevant?
 150  *     Use 0 for any type.
 151  * @param proc function to call on the matching value;
 152  *        proc should be called with NULL if there is no result
 153  * @param proc_cls closure for proc
 154  */
 155 typedef void (*PluginGetKey) (void *cls, uint64_t offset,
 156                               const GNUNET_HashCode * key,
 157                               const GNUNET_HashCode * vhash,
 158                               enum GNUNET_BLOCK_Type type,
 159                               PluginDatumProcessor proc, void *proc_cls);
 160
 161
 162
 163 /**
 164  * Get a random item (additional constraints may apply depending on
 165  * the specific implementation).  Calls 'proc' with all values ZERO or
 166  * NULL if no item applies, otherwise 'proc' is called once and only
 167  * once with an item.
 168  *
 169  * @param cls closure
 170  * @param proc function to call the value (once only).
 171  * @param proc_cls closure for proc
 172  */
 173 typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
 174                                  void *proc_cls);
 175
 176
 177 /**
 178  * Update the priority for a particular key in the datastore.  If
 179  * the expiration time in value is different than the time found in
 180  * the datastore, the higher value should be kept.  For the
 181  * anonymity level, the lower value is to be used.  The specified
 182  * priority should be added to the existing priority, ignoring the
 183  * priority in value.
 184  *
 185  * Note that it is possible for multiple values to match this put.
 186  * In that case, all of the respective values are updated.
 187  *
 188  * @param cls closure
 189  * @param uid unique identifier of the datum
 190  * @param delta by how much should the priority
 191  *     change?  If priority + delta < 0 the
 192  *     priority should be set to 0 (never go
 193  *     negative).
 194  * @param expire new expiration time should be the
 195  *     MAX of any existing expiration time and
 196  *     this value
 197  * @param msg set to an error message (on error)
 198  * @return GNUNET_OK on success
 199  */
 200 typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
 201                              struct GNUNET_TIME_Absolute expire, char **msg);
 202
 203
 204 /**
 205  * Select a single item from the datastore at the specified offset
 206  * (among those applicable).
 207  *
 208  * @param cls closure
 209  * @param offset offset of the result (modulo num-results);
 210  *               specific ordering does not matter for the offset
 211  * @param type entries of which type should be considered?
 212  *        Must not be zero (ANY).
 213  * @param proc function to call on the matching value
 214  * @param proc_cls closure for proc
 215  */
 216 typedef void (*PluginGetType) (void *cls, uint64_t offset,
 217                                enum GNUNET_BLOCK_Type type,
 218                                PluginDatumProcessor proc, void *proc_cls);
 219
 220
 221 /**
 222  * Drop database.
 223  *
 224  * @param cls closure
 225  */
 226 typedef void (*PluginDrop) (void *cls);
 227
 228
 229
 230 /**
 231  * Each plugin is required to return a pointer to a struct of this
 232  * type as the return value from its entry point.
 233  */
 234 struct GNUNET_DATASTORE_PluginFunctions
 235 {
 236
 237   /**
 238    * Closure to use for all of the following callbacks
 239    * (except "next_request").
 240    */
 241   void *cls;
 242
 243   /**
 244    * Calculate the current on-disk size of the SQ store.  Estimates
 245    * are fine, if that's the only thing available.
 246    */
 247   PluginEstimateSize estimate_size;
 248
 249   /**
 250    * Function to store an item in the datastore.
 251    */
 252   PluginPut put;
 253
 254   /**
 255    * Update the priority for a particular key in the datastore.  If
 256    * the expiration time in value is different than the time found in
 257    * the datastore, the higher value should be kept.  For the
 258    * anonymity level, the lower value is to be used.  The specified
 259    * priority should be added to the existing priority, ignoring the
 260    * priority in value.
 261    */
 262   PluginUpdate update;
 263
 264   /**
 265    * Get a particular datum matching a given hash from the datastore.
 266    */
 267   PluginGetKey get_key;
 268
 269   /**
 270    * Get datum (of the specified type) with anonymity level zero.
 271    * This function is allowed to ignore the 'offset' argument
 272    * and instead return a random result (with zero anonymity of
 273    * the correct type) if implementing an offset is expensive.
 274    */
 275   PluginGetType get_zero_anonymity;
 276
 277   /**
 278    * Function to get a random item with high replication score from
 279    * the database, lowering the item's replication score.  Returns a
 280    * single random item from those with the highest replication
 281    * counters.  The item's replication counter is decremented by one
 282    * IF it was positive before.
 283    */
 284   PluginGetRandom get_replication;
 285
 286   /**
 287    * Function to get a random expired item or, if none are expired,
 288    * either the oldest entry or one with a low priority (depending
 289    * on what was efficiently implementable).
 290    */
 291   PluginGetRandom get_expiration;
 292
 293   /**
 294    * Delete the database.  The next operation is
 295    * guaranteed to be unloading of the module.
 296    */
 297   PluginDrop drop;
 298
 299 };
 300
 301
 302 #endif