diff options
Diffstat (limited to 'src/setu/gnunet-service-setu_protocol.h')
-rw-r--r-- | src/setu/gnunet-service-setu_protocol.h | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/src/setu/gnunet-service-setu_protocol.h b/src/setu/gnunet-service-setu_protocol.h new file mode 100644 index 000000000..a2803ee47 --- /dev/null +++ b/src/setu/gnunet-service-setu_protocol.h | |||
@@ -0,0 +1,226 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2013, 2014 GNUnet e.V. | ||
4 | |||
5 | GNUnet is free software: you can redistribute it and/or modify it | ||
6 | under the terms of the GNU Affero General Public License as published | ||
7 | by the Free Software Foundation, either version 3 of the License, | ||
8 | or (at your 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 | Affero General Public License for more details. | ||
14 | |||
15 | You should have received a copy of the GNU Affero General Public License | ||
16 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
17 | |||
18 | SPDX-License-Identifier: AGPL3.0-or-later | ||
19 | */ | ||
20 | /** | ||
21 | * @author Florian Dold | ||
22 | * @author Christian Grothoff | ||
23 | * @file set/gnunet-service-set_protocol.h | ||
24 | * @brief Peer-to-Peer messages for gnunet set | ||
25 | */ | ||
26 | #ifndef SET_PROTOCOL_H | ||
27 | #define SET_PROTOCOL_H | ||
28 | |||
29 | #include "platform.h" | ||
30 | #include "gnunet_common.h" | ||
31 | |||
32 | |||
33 | GNUNET_NETWORK_STRUCT_BEGIN | ||
34 | |||
35 | struct OperationRequestMessage | ||
36 | { | ||
37 | /** | ||
38 | * Type: #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST | ||
39 | */ | ||
40 | struct GNUNET_MessageHeader header; | ||
41 | |||
42 | /** | ||
43 | * Operation to request, values from `enum GNUNET_SET_OperationType` | ||
44 | */ | ||
45 | uint32_t operation GNUNET_PACKED; | ||
46 | |||
47 | /** | ||
48 | * For Intersection: my element count | ||
49 | */ | ||
50 | uint32_t element_count GNUNET_PACKED; | ||
51 | |||
52 | /** | ||
53 | * Application-specific identifier of the request. | ||
54 | */ | ||
55 | struct GNUNET_HashCode app_idX; | ||
56 | |||
57 | /* rest: optional message */ | ||
58 | }; | ||
59 | |||
60 | |||
61 | /** | ||
62 | * Message containing buckets of an invertible bloom filter. | ||
63 | * | ||
64 | * If an IBF has too many buckets for an IBF message, | ||
65 | * it is split into multiple messages. | ||
66 | */ | ||
67 | struct IBFMessage | ||
68 | { | ||
69 | /** | ||
70 | * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF | ||
71 | */ | ||
72 | struct GNUNET_MessageHeader header; | ||
73 | |||
74 | /** | ||
75 | * Order of the whole ibf, where | ||
76 | * num_buckets = 2^order | ||
77 | */ | ||
78 | uint8_t order; | ||
79 | |||
80 | /** | ||
81 | * Padding, must be 0. | ||
82 | */ | ||
83 | uint8_t reserved1; | ||
84 | |||
85 | /** | ||
86 | * Padding, must be 0. | ||
87 | */ | ||
88 | uint16_t reserved2 GNUNET_PACKED; | ||
89 | |||
90 | /** | ||
91 | * Offset of the strata in the rest of the message | ||
92 | */ | ||
93 | uint32_t offset GNUNET_PACKED; | ||
94 | |||
95 | /** | ||
96 | * Salt used when hashing elements for this IBF. | ||
97 | */ | ||
98 | uint32_t salt GNUNET_PACKED; | ||
99 | |||
100 | /* rest: buckets */ | ||
101 | }; | ||
102 | |||
103 | |||
104 | struct InquiryMessage | ||
105 | { | ||
106 | /** | ||
107 | * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF | ||
108 | */ | ||
109 | struct GNUNET_MessageHeader header; | ||
110 | |||
111 | /** | ||
112 | * Salt used when hashing elements for this inquiry. | ||
113 | */ | ||
114 | uint32_t salt GNUNET_PACKED; | ||
115 | |||
116 | /** | ||
117 | * Reserved, set to 0. | ||
118 | */ | ||
119 | uint32_t reserved GNUNET_PACKED; | ||
120 | |||
121 | /* rest: inquiry IBF keys */ | ||
122 | }; | ||
123 | |||
124 | |||
125 | /** | ||
126 | * During intersection, the first (and possibly second) message | ||
127 | * send it the number of elements in the set, to allow the peers | ||
128 | * to decide who should start with the Bloom filter. | ||
129 | */ | ||
130 | struct IntersectionElementInfoMessage | ||
131 | { | ||
132 | /** | ||
133 | * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO | ||
134 | */ | ||
135 | struct GNUNET_MessageHeader header; | ||
136 | |||
137 | /** | ||
138 | * mutator used with this bloomfilter. | ||
139 | */ | ||
140 | uint32_t sender_element_count GNUNET_PACKED; | ||
141 | }; | ||
142 | |||
143 | |||
144 | /** | ||
145 | * Bloom filter messages exchanged for set intersection calculation. | ||
146 | */ | ||
147 | struct BFMessage | ||
148 | { | ||
149 | /** | ||
150 | * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF | ||
151 | */ | ||
152 | struct GNUNET_MessageHeader header; | ||
153 | |||
154 | /** | ||
155 | * Number of elements the sender still has in the set. | ||
156 | */ | ||
157 | uint32_t sender_element_count GNUNET_PACKED; | ||
158 | |||
159 | /** | ||
160 | * XOR of all hashes over all elements remaining in the set. | ||
161 | * Used to determine termination. | ||
162 | */ | ||
163 | struct GNUNET_HashCode element_xor_hash; | ||
164 | |||
165 | /** | ||
166 | * Mutator used with this bloomfilter. | ||
167 | */ | ||
168 | uint32_t sender_mutator GNUNET_PACKED; | ||
169 | |||
170 | /** | ||
171 | * Total length of the bloomfilter data. | ||
172 | */ | ||
173 | uint32_t bloomfilter_total_length GNUNET_PACKED; | ||
174 | |||
175 | /** | ||
176 | * Number of bits (k-value) used in encoding the bloomfilter. | ||
177 | */ | ||
178 | uint32_t bits_per_element GNUNET_PACKED; | ||
179 | |||
180 | /** | ||
181 | * rest: the sender's bloomfilter | ||
182 | */ | ||
183 | }; | ||
184 | |||
185 | |||
186 | /** | ||
187 | * Last message, send to confirm the final set. Contains the element | ||
188 | * count as it is possible that the peer determined that we were done | ||
189 | * by getting the empty set, which in that case also needs to be | ||
190 | * communicated. | ||
191 | */ | ||
192 | struct IntersectionDoneMessage | ||
193 | { | ||
194 | /** | ||
195 | * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_DONE | ||
196 | */ | ||
197 | struct GNUNET_MessageHeader header; | ||
198 | |||
199 | /** | ||
200 | * Final number of elements in intersection. | ||
201 | */ | ||
202 | uint32_t final_element_count GNUNET_PACKED; | ||
203 | |||
204 | /** | ||
205 | * XOR of all hashes over all elements remaining in the set. | ||
206 | */ | ||
207 | struct GNUNET_HashCode element_xor_hash; | ||
208 | }; | ||
209 | |||
210 | |||
211 | /** | ||
212 | * Strata estimator together with the peer's overall set size. | ||
213 | */ | ||
214 | struct StrataEstimatorMessage | ||
215 | { | ||
216 | /** | ||
217 | * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_SE(C) | ||
218 | */ | ||
219 | struct GNUNET_MessageHeader header; | ||
220 | |||
221 | uint64_t set_size; | ||
222 | }; | ||
223 | |||
224 | GNUNET_NETWORK_STRUCT_END | ||
225 | |||
226 | #endif | ||