1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
This file is part of GNUnet.
Copyright (C) 2012,2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @author Bartlomiej Polot
* @file regex/regex_block_lib.h
* @brief common function to manipulate blocks stored by regex in the DHT
*/
#ifndef REGEX_BLOCK_LIB_H_
#define REGEX_BLOCK_LIB_H_
#ifdef __cplusplus
extern "C"
{
#if 0
/* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "platform.h"
#include "block_regex.h"
/**
* Representation of a Regex node (and edges) in the DHT.
*/
struct RegexBlock;
/**
* Edge representation.
*/
struct REGEX_BLOCK_Edge
{
/**
* Label of the edge. FIXME: might want to not consume exactly
* multiples of 8 bits, need length!
*/
const char *label;
/**
* Destionation of the edge.
*/
struct GNUNET_HashCode destination;
};
/**
* Check if the given 'proof' matches the given 'key'.
*
* @param proof partial regex of a state
* @param proof_len number of bytes in @a proof
* @param key hash of a state.
* @return #GNUNET_OK if the proof is valid for the given key.
*/
int
REGEX_BLOCK_check_proof (const char *proof,
size_t proof_len,
const struct GNUNET_HashCode *key);
/**
* Check if the regex block is well formed, including all edges.
*
* @param block The start of the block.
* @param size The size of the @a block.
* @param query the query for the @a block
* @param xquery String describing the edge we are looking for.
* Can be NULL in case this is a put block.
* @return #GNUNET_OK in case it's fine.
* #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
* #GNUNET_SYSERR if the block is invalid.
*/
int
REGEX_BLOCK_check (const struct RegexBlock *block,
size_t size,
const struct GNUNET_HashCode *query,
const char *xquery);
/* FIXME: might want to use 'struct REGEX_BLOCK_Edge' here instead of 3 arguments! */
/**
* Iterator over edges in a block.
*
* @param cls Closure.
* @param token Token that follows to next state.
* @param len Length of token.
* @param key Hash of next state.
* @return #GNUNET_YES if should keep iterating, #GNUNET_NO otherwise.
*/
typedef int
(*REGEX_INTERNAL_EgdeIterator)(void *cls,
const char *token,
size_t len,
const struct GNUNET_HashCode *key);
/**
* Iterate over all edges of a block of a regex state.
*
* @param block Block to iterate over.
* @param size Size of block.
* @param iterator Function to call on each edge in the block.
* @param iter_cls Closure for the @a iterator.
* @return #GNUNET_SYSERR if an error has been encountered.
* #GNUNET_OK if no error has been encountered.
* Note that if the iterator stops the iteration by returning
* #GNUNET_NO, the block will no longer be checked for further errors.
* The return value will be #GNUNET_OK meaning that no errors were
* found until the edge last notified to the iterator, but there might
* be errors in further edges.
*/
int
REGEX_BLOCK_iterate (const struct RegexBlock *block,
size_t size,
REGEX_INTERNAL_EgdeIterator iterator,
void *iter_cls);
/**
* Obtain the key that a particular block is to be stored under.
*
* @param block block to get the key from
* @param block_len number of bytes in @a block
* @param key where to store the key
* @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
*/
int
REGEX_BLOCK_get_key (const struct RegexBlock *block,
size_t block_len,
struct GNUNET_HashCode *key);
/**
* Test if this block is marked as being an accept state.
*
* @param block block to test
* @param size number of bytes in block
* @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not
*/
int
GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
size_t block_len);
/**
* Construct a regex block to be stored in the DHT.
*
* @param proof proof string for the block
* @param num_edges number of edges in the block
* @param edges the edges of the block
* @param accepting is this an accepting state
* @param rsize set to the size of the returned block (OUT-only)
* @return the regex block, NULL on error
*/
struct RegexBlock *
REGEX_BLOCK_create (const char *proof,
unsigned int num_edges,
const struct REGEX_BLOCK_Edge *edges,
int accepting,
size_t *rsize);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef REGEX_BLOCK_LIB_H */
#endif
/* end of regex_block_lib.h */
|
