src/regex/regex_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012,2013 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  * @author Bartlomiej Polot
  23  * @file regex/regex_block_lib.h
  24  * @brief common function to manipulate blocks stored by regex in the DHT
  25  */
  26
  27 #ifndef REGEX_BLOCK_LIB_H_
  28 #define REGEX_BLOCK_LIB_H_
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0
  34   /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "platform.h"
  40 #include "block_regex.h"
  41
  42
  43 /**
  44  * Edge representation.
  45  */
  46 struct REGEX_BLOCK_Edge
  47 {
  48   /**
  49    * Label of the edge.  FIXME: might want to not consume exactly multiples of 8 bits, need length!
  50    */
  51   const char *label;
  52
  53   /**
  54    * Destionation of the edge.
  55    */
  56   struct GNUNET_HashCode destination;
  57 };
  58
  59
  60 /**
  61  * Check if the given 'proof' matches the given 'key'.
  62  *
  63  * @param proof partial regex of a state
  64  * @param proof_len number of bytes in 'proof'
  65  * @param key hash of a state.
  66  *
  67  * @return GNUNET_OK if the proof is valid for the given key.
  68  */
  69 int
  70 REGEX_BLOCK_check_proof (const char *proof,
  71                          size_t proof_len,
  72                          const struct GNUNET_HashCode *key);
  73
  74
  75 /**
  76  * Check if the regex block is well formed, including all edges.
  77  *
  78  * @param block The start of the block.
  79  * @param size The size of the block.
  80  * @param query the query for the block
  81  * @param xquery String describing the edge we are looking for.
  82  *               Can be NULL in case this is a put block.
  83  *
  84  * @return GNUNET_OK in case it's fine.
  85  *         GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
  86  *         GNUNET_SYSERR if the block is invalid.
  87  */
  88 int
  89 REGEX_BLOCK_check (const struct RegexBlock *block,
  90                    size_t size,
  91                    const struct GNUNET_HashCode *query,
  92                    const char *xquery);
  93
  94
  95 /* FIXME: might want to use 'struct REGEX_BLOCK_Edge' here instead of 3 arguments! */
  96
  97 /**
  98  * Iterator over edges in a block.
  99  *
 100  * @param cls Closure.
 101  * @param token Token that follows to next state.
 102  * @param len Length of token.
 103  * @param key Hash of next state.
 104  *
 105  * @return GNUNET_YES if should keep iterating, GNUNET_NO otherwise.
 106  */
 107 typedef int (*REGEX_INTERNAL_EgdeIterator)(void *cls,
 108                                            const char *token,
 109                                            size_t len,
 110                                            const struct GNUNET_HashCode *key);
 111
 112
 113 /**
 114  * Iterate over all edges of a block of a regex state.
 115  *
 116  * @param block Block to iterate over.
 117  * @param size Size of block.
 118  * @param iterator Function to call on each edge in the block.
 119  * @param iter_cls Closure for the iterator.
 120  *
 121  * @return GNUNET_SYSERR if an error has been encountered.
 122  *         GNUNET_OK if no error has been encountered.
 123  *           Note that if the iterator stops the iteration by returning
 124  *         GNUNET_NO, the block will no longer be checked for further errors.
 125  *           The return value will be GNUNET_OK meaning that no errors were
 126  *         found until the edge last notified to the iterator, but there might
 127  *         be errors in further edges.
 128  */
 129 int
 130 REGEX_BLOCK_iterate (const struct RegexBlock *block,
 131                             size_t size,
 132                             REGEX_INTERNAL_EgdeIterator iterator,
 133                             void *iter_cls);
 134
 135 /**
 136  * Obtain the key that a particular block is to be stored under.
 137  *
 138  * @param block block to get the key from
 139  * @param block_len number of bytes in block
 140  * @param query where to store the key
 141  * @return GNUNET_OK on success, GNUNET_SYSERR if the block is malformed
 142  */
 143 int
 144 REGEX_BLOCK_get_key (const struct RegexBlock *block,
 145                      size_t block_len,
 146                      struct GNUNET_HashCode *key);
 147
 148
 149
 150 /**
 151  * Construct a regex block to be stored in the DHT.
 152  *
 153  * @param proof proof string for the block
 154  * @param num_edges number of edges in the block
 155  * @param edges the edges of the block
 156  * @param accepting is this an accepting state
 157  * @param rsize set to the size of the returned block (OUT-only)
 158  * @return the regex block, NULL on error
 159  */
 160 struct RegexBlock *
 161 REGEX_BLOCK_create (const char *proof,
 162                     unsigned int num_edges,
 163                     const struct REGEX_BLOCK_Edge *edges,
 164                     int accepting,
 165                     size_t *rsize);
 166
 167
 168 #if 0                           /* keep Emacsens' auto-indent happy */
 169 {
 170 #endif
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 /* ifndef REGEX_BLOCK_LIB_H */
 176 #endif
 177 /* end of regex_block_lib.h */