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
194
195
196
197
198
199
|
/*
This file is part of GNUnet
Copyright (C) 2012 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @file set/gnunet-service-setu_strata_estimator.h
* @brief estimator of set difference
* @author Florian Dold
* @author Elias Summermatter
*/
#ifndef GNUNET_SERVICE_SETU_STRATA_ESTIMATOR_H
#define GNUNET_SERVICE_SETU_STRATA_ESTIMATOR_H
#include "platform.h"
#include "gnunet_common.h"
#include "gnunet_util_lib.h"
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* A handle to a strata estimator.
*/
struct StrataEstimator
{
/**
* The IBFs of this strata estimator.
*/
struct InvertibleBloomFilter **strata;
/**
* Size of the IBF array in @e strata
*/
unsigned int strata_count;
/**
* Size of each IBF stratum (in bytes)
*/
unsigned int ibf_size;
};
struct MultiStrataEstimator
{
/**
* Array of strata estimators
*/
struct StrataEstimator **stratas;
/**
* Number of strata estimators in struct
*/
uint8_t size;
};
/**
* Deteminate how many strata estimators in the message are necessary
* @param avg_element_size
* @param element_count
* @return number of strata's
*/
uint8_t
determine_strata_count (uint64_t avg_element_size,
uint64_t element_count);
/**
* Write the given strata estimator to the buffer.
*
* @param se strata estimator to serialize
* @param[out] buf buffer to write to, must be of appropriate size
* @return number of bytes written to @a buf
*/
size_t
strata_estimator_write (struct MultiStrataEstimator *se,
uint16_t se_ibf_total_size,
uint8_t number_se_send,
void *buf);
/**
* Read strata from the buffer into the given strata
* estimator. The strata estimator must already be allocated.
*
* @param buf buffer to read from
* @param buf_len number of bytes in @a buf
* @param is_compressed is the data compressed?
* @param[out] se strata estimator to write to
* @return #GNUNET_OK on success
*/
int
strata_estimator_read (const void *buf,
size_t buf_len,
int is_compressed,
uint8_t number_se_received,
uint16_t se_ibf_total_size,
struct MultiStrataEstimator *se);
/**
* Create a new strata estimator with the given parameters.
*
* @param strata_count number of stratas, that is, number of ibfs in the estimator
* @param ibf_size size of each ibf stratum
* @param ibf_hashnum hashnum parameter of each ibf
* @return a freshly allocated, empty strata estimator, NULL on error
*/
struct MultiStrataEstimator *
strata_estimator_create (unsigned int strata_count,
uint32_t ibf_size,
uint8_t ibf_hashnum);
/**
* Get an estimation of the symmetric difference of the elements
* contained in both strata estimators.
*
* @param se1 first strata estimator
* @param se2 second strata estimator
* @return nothing
*/
void
strata_estimator_difference (const struct MultiStrataEstimator *se1,
const struct MultiStrataEstimator *se2);
/**
* Add a key to the strata estimator.
*
* @param se strata estimator to add the key to
* @param key key to add
*/
void
strata_estimator_insert (struct MultiStrataEstimator *se,
struct IBF_Key key);
/**
* Remove a key from the strata estimator.
*
* @param se strata estimator to remove the key from
* @param key key to remove
*/
void
strata_estimator_remove (struct MultiStrataEstimator *se,
struct IBF_Key key);
/**
* Destroy a strata estimator, free all of its resources.
*
* @param se strata estimator to destroy.
*/
void
strata_estimator_destroy (struct MultiStrataEstimator *se);
/**
* Make a copy of a strata estimator.
*
* @param se the strata estimator to copy
* @return the copy
*/
struct MultiStrataEstimator *
strata_estimator_dup (struct MultiStrataEstimator *se);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
|
