2 This file is part of GNUnet.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
24 * @author Julius Bünger
27 #include "gnunet_util_lib.h"
29 #include "gnunet_rps_service.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "rps-api",__VA_ARGS__)
36 * Handler to handle requests from a client.
38 struct GNUNET_RPS_Handle
41 * The handle to the client configuration.
43 struct GNUNET_CONFIGURATION_Handle *cfg;
46 * The connection to the client.
48 struct GNUNET_CLIENT_Connection *conn;
51 * The message queue to the client.
53 struct GNUNET_MQ_Handle *mq;
58 * Handler to single requests from the client.
60 struct GNUNET_RPS_Request_Handle
63 * The client issuing the request.
65 struct GNUNET_RPS_Handle *rps_handle;
68 * The id of the request.
73 * The callback to be called when we receive an answer.
75 GNUNET_RPS_NotifyReadyCB ready_cb;
78 * The closure for the callback.
85 * Array of Request_Handles.
87 struct GNUNET_RPS_Request_Handle *req_handlers = NULL;
90 * Current length of req_handlers.
92 unsigned int req_handlers_size = 0;
96 * Struct used to pack the callback, its closure (provided by the caller)
97 * and the connection handler to the service to pass it to a callback function.
102 * Callback provided by the client
104 GNUNET_RPS_NotifyReadyCB cb;
107 * Closure provided by the client
112 * Handle to the service connection
114 struct GNUNET_CLIENT_Connection *service_conn;
119 * This function is called, when the service replies to our request.
120 * It calls the callback the caller gave us with the provided closure
121 * and disconnects afterwards.
123 * @param cls the closure
124 * @param message the message
127 handle_reply (void *cls,
128 const struct GNUNET_MessageHeader *message)
130 struct GNUNET_RPS_CS_ReplyMessage *msg;
131 struct GNUNET_PeerIdentity *peers;
132 struct GNUNET_RPS_Request_Handle *rh;
134 /* Give the peers back */
135 msg = (struct GNUNET_RPS_CS_ReplyMessage *) message;
137 LOG (GNUNET_ERROR_TYPE_DEBUG,
138 "Service replied with %" PRIu32 " peers for id %" PRIu32 "\n",
139 ntohl (msg->num_peers),
142 peers = (struct GNUNET_PeerIdentity *) &msg[1];
143 rh = &req_handlers[ntohl (msg->id)];
144 rh->ready_cb((rh)->ready_cb_cls, ntohl (msg->num_peers), peers);
148 * Reconnect to the service
151 reconnect (struct GNUNET_RPS_Handle *h);
155 * Error handler for mq.
157 * This function is called whan mq encounters an error.
158 * Until now mq doesn't provide useful error messages.
160 * @param cls the closure
161 * @param error error code without specyfied meaning
164 mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
166 struct GNUNET_RPS_Handle *h = cls;
168 LOG (GNUNET_ERROR_TYPE_WARNING, "Some problem with the message queue. error: %i\n\
177 * Reconnect to the service
180 reconnect (struct GNUNET_RPS_Handle *h)
182 static const struct GNUNET_MQ_MessageHandler mq_handlers[] = {
183 {&handle_reply, GNUNET_MESSAGE_TYPE_RPS_CS_REPLY, 0},
184 GNUNET_MQ_HANDLERS_END
188 GNUNET_MQ_destroy (h->mq);
190 GNUNET_CLIENT_disconnect (h->conn);
191 h->conn = GNUNET_CLIENT_connect ("rps", h->cfg);
192 GNUNET_assert (NULL != h->conn);
193 h->mq = GNUNET_MQ_queue_for_connection_client(h->conn,
195 mq_error_handler, // TODO implement
200 * Connect to the rps service
202 * @param cfg configuration to use
203 * @return a handle to the service
205 struct GNUNET_RPS_Handle *
206 GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
208 struct GNUNET_RPS_Handle *h;
209 //struct GNUNET_RPS_Request_Handle *rh;
211 h = GNUNET_new(struct GNUNET_RPS_Handle);
212 h->cfg = GNUNET_CONFIGURATION_dup (cfg);
219 * Request n random peers.
221 * @param rps_handle handle to the rps service
222 * @param num_req_peers number of peers we want to receive
223 * @param ready_cb the callback called when the peers are available
224 * @param cls closure given to the callback
225 * @return a handle to cancel this request
227 struct GNUNET_RPS_Request_Handle *
228 GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *rps_handle,
229 uint32_t num_req_peers,
230 GNUNET_RPS_NotifyReadyCB ready_cb,
233 struct GNUNET_RPS_Request_Handle *rh;
234 struct GNUNET_MQ_Envelope *ev;
235 struct GNUNET_RPS_CS_RequestMessage *msg;
237 // assert func != NULL
238 rh = GNUNET_new (struct GNUNET_RPS_Request_Handle);
239 rh->rps_handle = rps_handle;
240 rh->id = req_handlers_size; // TODO ntoh
241 rh->ready_cb = ready_cb;
242 rh->ready_cb_cls = cls;
244 LOG (GNUNET_ERROR_TYPE_DEBUG,
245 "Requesting %" PRIu32 " peers with id %" PRIu32 "\n",
249 GNUNET_array_append (req_handlers, req_handlers_size, *rh);
250 //memcpy(&req_handlers[req_handlers_size-1], rh, sizeof(struct GNUNET_RPS_Request_Handle));
252 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST);
253 msg->num_peers = htonl (num_req_peers);
254 msg->id = htonl (rh->id);
255 GNUNET_MQ_send (rps_handle->mq, ev);
261 * Seed rps service with peerIDs.
263 * @param h handle to the rps service
264 * @param n number of peers to seed
265 * @param ids the ids of the peers seeded
268 GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h,
270 const struct GNUNET_PeerIdentity *ids)
273 uint32_t num_peers_max;
274 const struct GNUNET_PeerIdentity *tmp_peer_pointer;
275 struct GNUNET_MQ_Envelope *ev;
276 struct GNUNET_RPS_CS_SeedMessage *msg;
280 LOG (GNUNET_ERROR_TYPE_DEBUG,
281 "Client wants to seed %" PRIu32 " peers:\n",
283 for (i = 0 ; i < n ; i++)
284 LOG (GNUNET_ERROR_TYPE_DEBUG,
287 GNUNET_i2s (&ids[i]));
289 /* The actual size the message occupies */
290 size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) +
291 n * sizeof (struct GNUNET_PeerIdentity);
292 /* The number of peers that fits in one message together with
293 * the respective header */
294 num_peers_max = (GNUNET_SERVER_MAX_MESSAGE_SIZE -
295 sizeof (struct GNUNET_RPS_CS_SeedMessage)) /
296 sizeof (struct GNUNET_PeerIdentity);
297 tmp_peer_pointer = ids;
299 while (GNUNET_SERVER_MAX_MESSAGE_SIZE < size_needed)
301 ev = GNUNET_MQ_msg_extra (msg, num_peers_max * sizeof (struct GNUNET_PeerIdentity),
302 GNUNET_MESSAGE_TYPE_RPS_CS_SEED);
303 msg->num_peers = htonl (num_peers_max);
304 memcpy (&msg[1], tmp_peer_pointer, num_peers_max * sizeof (struct GNUNET_PeerIdentity));
305 GNUNET_MQ_send (h->mq, ev);
308 size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) +
309 n * sizeof (struct GNUNET_PeerIdentity);
310 /* Set pointer to beginning of next block of num_peers_max peers */
311 tmp_peer_pointer = &ids[num_peers_max];
314 ev = GNUNET_MQ_msg_extra (msg, n * sizeof (struct GNUNET_PeerIdentity),
315 GNUNET_MESSAGE_TYPE_RPS_CS_SEED);
316 msg->num_peers = htonl (n);
317 memcpy (&msg[1], tmp_peer_pointer, n * sizeof (struct GNUNET_PeerIdentity));
319 GNUNET_MQ_send (h->mq, ev);
323 #ifdef ENABLE_MALICIOUS
325 * Turn RPS service to act malicious.
327 * @param h handle to the rps service
328 * @param type which type of malicious peer to turn to.
329 * 0 Don't act malicious at all
330 * 1 Try to maximise representation
331 * 2 Try to partition the network
332 * (isolate one peer from the rest)
333 * @param n number of @a ids
334 * @param ids the ids of the malicious peers
335 * if @type is 2 the last id is the id of the
336 * peer to be isolated from the rest
339 GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
342 const struct GNUNET_PeerIdentity *peer_ids,
343 const struct GNUNET_PeerIdentity *target_peer)
346 uint32_t num_peers_max;
347 const struct GNUNET_PeerIdentity *tmp_peer_pointer;
348 struct GNUNET_MQ_Envelope *ev;
349 struct GNUNET_RPS_CS_ActMaliciousMessage *msg;
353 LOG (GNUNET_ERROR_TYPE_DEBUG,
354 "Client turns malicious (type %" PRIu32 ") with %" PRIu32 " other peers:\n",
357 for (i = 0 ; i < num_peers ; i++)
358 LOG (GNUNET_ERROR_TYPE_DEBUG,
361 GNUNET_i2s (&peer_ids[i]));
363 /* The actual size the message would occupy */
364 size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) +
365 num_peers * sizeof (struct GNUNET_PeerIdentity);
366 /* The number of peers that fit in one message together with
367 * the respective header */
368 num_peers_max = (GNUNET_SERVER_MAX_MESSAGE_SIZE -
369 sizeof (struct GNUNET_RPS_CS_SeedMessage)) /
370 sizeof (struct GNUNET_PeerIdentity);
371 tmp_peer_pointer = peer_ids;
373 while (GNUNET_SERVER_MAX_MESSAGE_SIZE < size_needed)
375 LOG (GNUNET_ERROR_TYPE_DEBUG,
376 "Too many peers to send at once, sending %" PRIu32 " (all we can so far)\n",
378 ev = GNUNET_MQ_msg_extra (msg,
379 num_peers_max * sizeof (struct GNUNET_PeerIdentity),
380 GNUNET_MESSAGE_TYPE_RPS_ACT_MALICIOUS);
381 msg->type = htonl (type);
382 msg->num_peers = htonl (num_peers_max);
385 msg->attacked_peer = peer_ids[num_peers];
388 num_peers_max * sizeof (struct GNUNET_PeerIdentity));
390 GNUNET_MQ_send (h->mq, ev);
392 num_peers -= num_peers_max;
393 size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) +
394 num_peers * sizeof (struct GNUNET_PeerIdentity);
395 /* Set pointer to beginning of next block of num_peers_max peers */
396 tmp_peer_pointer = &peer_ids[num_peers_max];
399 ev = GNUNET_MQ_msg_extra (msg,
400 num_peers * sizeof (struct GNUNET_PeerIdentity),
401 GNUNET_MESSAGE_TYPE_RPS_ACT_MALICIOUS);
402 msg->type = htonl (type);
403 msg->num_peers = htonl (num_peers);
406 msg->attacked_peer = *target_peer;
407 memcpy (&msg[1], tmp_peer_pointer, num_peers * sizeof (struct GNUNET_PeerIdentity));
409 GNUNET_MQ_send (h->mq, ev);
411 #endif /* ENABLE_MALICIOUS */
415 * Cancle an issued request.
417 * @param rh request handle of request to cancle
420 GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh)
422 struct GNUNET_MQ_Envelope *ev;
423 struct GNUNET_RPS_CS_RequestCancelMessage*msg;
425 LOG (GNUNET_ERROR_TYPE_DEBUG,
426 "Cancelling request with id %" PRIu32 "\n",
429 GNUNET_array_append (req_handlers, req_handlers_size, *rh);
430 ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST_CANCEL);
431 msg->id = htonl (rh->id);
432 GNUNET_MQ_send (rh->rps_handle->mq, ev);
437 * Disconnect from the rps service
439 * @param h the handle to the rps service
442 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h)
445 GNUNET_CLIENT_disconnect (h->conn);
446 GNUNET_CONFIGURATION_destroy (h->cfg);
447 GNUNET_MQ_destroy (h->mq);
452 /* end of rps_api.c */