/* This file is part of GNUnet. Copyright (C) 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 . */ /** * @file rps/rps_api.c * @brief API for rps * @author Julius Bünger */ #include "platform.h" #include "gnunet_util_lib.h" #include "rps.h" #include "gnunet_rps_service.h" #include "gnunet-service-rps_sampler.h" #include #define LOG(kind,...) GNUNET_log_from (kind, "rps-api",__VA_ARGS__) /** * Handle for a request to get peers from biased stream of ids */ struct GNUNET_RPS_StreamRequestHandle { /** * The client issuing the request. */ struct GNUNET_RPS_Handle *rps_handle; /** * The number of requested peers. */ uint32_t num_peers_left; /** * The callback to be called when we receive an answer. */ GNUNET_RPS_NotifyReadyCB ready_cb; /** * The closure for the callback. */ void *ready_cb_cls; /** * @brief Next element of the DLL */ struct GNUNET_RPS_StreamRequestHandle *next; /** * @brief Previous element of the DLL */ struct GNUNET_RPS_StreamRequestHandle *prev; }; /** * Handler to handle requests from a client. */ struct GNUNET_RPS_Handle { /** * The handle to the client configuration. */ const struct GNUNET_CONFIGURATION_Handle *cfg; /** * The message queue to the client. */ struct GNUNET_MQ_Handle *mq; /** * @brief Callback called on each update of the view */ GNUNET_RPS_NotifyReadyCB view_update_cb; /** * @brief Closure to each requested update of the view */ void *view_update_cls; /** * @brief Closure to each requested peer from the biased stream */ void *stream_input_cls; /** * @brief Head of the DLL of stream requests */ struct GNUNET_RPS_StreamRequestHandle *stream_requests_head; /** * @brief Tail of the DLL of stream requests */ struct GNUNET_RPS_StreamRequestHandle *stream_requests_tail; }; /** * Handler for a single request from a client. */ struct GNUNET_RPS_Request_Handle { /** * The client issuing the request. */ struct GNUNET_RPS_Handle *rps_handle; /** * The number of requested peers. */ uint32_t num_requests; /** * @brief The Sampler for the client request */ struct RPS_Sampler *sampler; /** * @brief Request handle of the request to the sampler - needed to cancel the request */ struct RPS_SamplerRequestHandle *sampler_rh; /** * @brief Request handle of the request of the biased stream of peers - * needed to cancel the request */ struct GNUNET_RPS_StreamRequestHandle *srh; /** * The callback to be called when we receive an answer. */ GNUNET_RPS_NotifyReadyCB ready_cb; /** * The closure for the callback. */ void *ready_cb_cls; }; /** * Struct used to pack the callback, its closure (provided by the caller) * and the connection handler to the service to pass it to a callback function. */ struct cb_cls_pack { /** * Callback provided by the client */ GNUNET_RPS_NotifyReadyCB cb; /** * Closure provided by the client */ void *cls; /** * Handle to the service connection */ struct GNUNET_CLIENT_Connection *service_conn; }; /** * @brief Create a new handle for a stream request * * @param rps_handle The rps handle * @param num_peers The number of desired peers * @param ready_cb The callback to be called, once all peers are ready * @param cls The colsure to provide to the callback * * @return The handle to the stream request */ static struct GNUNET_RPS_StreamRequestHandle * new_stream_request (struct GNUNET_RPS_Handle *rps_handle, uint64_t num_peers, GNUNET_RPS_NotifyReadyCB ready_cb, void *cls) { struct GNUNET_RPS_StreamRequestHandle *srh; srh = GNUNET_new (struct GNUNET_RPS_StreamRequestHandle); srh->rps_handle = rps_handle; srh->num_peers_left = num_peers; srh->ready_cb = ready_cb; srh->ready_cb_cls = cls; GNUNET_CONTAINER_DLL_insert (rps_handle->stream_requests_head, rps_handle->stream_requests_tail, srh); return srh; } /** * @brief Remove the given stream request from the list of requests and memory * * @param srh The request to be removed * @param srh_head Head of the DLL to remove request from * @param srh_tail Tail of the DLL to remove request from */ static void remove_stream_request (struct GNUNET_RPS_StreamRequestHandle *srh, struct GNUNET_RPS_StreamRequestHandle *srh_head, struct GNUNET_RPS_StreamRequestHandle *srh_tail) { GNUNET_CONTAINER_DLL_remove (srh_head, srh_tail, srh); GNUNET_free (srh); } /** * @brief Called once the sampler has collected all requested peers. * * Calls the callback provided by the client with the corresponding cls. * * @param peers The array of @a num_peers that has been returned. * @param num_peers The number of peers that have been returned * @param cls The #GNUNET_RPS_Request_Handle */ void peers_ready_cb (const struct GNUNET_PeerIdentity *peers, uint32_t num_peers, void *cls) { struct GNUNET_RPS_Request_Handle *rh = cls; rh->ready_cb (rh->ready_cb_cls, num_peers, peers); // TODO cleanup, sampler, rh, cancel stuff // TODO screw this function. We can give the cb,cls directly to the sampler. } /** * @brief Callback to collect the peers from the biased stream and put those * into the sampler. * * @param cls The #GNUNET_RPS_Request_Handle * @param num_peers The number of peer that have been returned * @param peers The array of @a num_peers that have been returned */ void collect_peers_cb (void *cls, uint64_t num_peers, const struct GNUNET_PeerIdentity *peers) { struct GNUNET_RPS_Request_Handle *rh = cls; for (uint64_t i = 0; i < num_peers; i++) { RPS_sampler_update (rh->sampler, &peers[i]); } } /** * @brief Create new request handle * * @param rps_handle Handle to the service * @param num_requests Number of requests * @param ready_cb Callback * @param cls Closure * * @return The newly created request handle */ static struct GNUNET_RPS_Request_Handle * new_request_handle (struct GNUNET_RPS_Handle *rps_handle, uint64_t num_requests, GNUNET_RPS_NotifyReadyCB ready_cb, void *cls) { struct GNUNET_RPS_Request_Handle *rh; rh = GNUNET_new (struct GNUNET_RPS_Request_Handle); rh->rps_handle = rps_handle; rh->num_requests = num_requests; rh->sampler = RPS_sampler_mod_init (num_requests, GNUNET_TIME_UNIT_SECONDS); // TODO remove this time-stuff rh->sampler_rh = RPS_sampler_get_n_rand_peers (rh->sampler, num_requests, peers_ready_cb, rh); rh->srh = GNUNET_RPS_stream_request (rps_handle, 0, /* infinite updates */ collect_peers_cb, rh); /* cls */ rh->ready_cb = ready_cb; rh->ready_cb_cls = cls; return rh; } /* Get internals for debugging/profiling purposes */ /** * Request updates of view * * @param rps_handle handle to the rps service * @param num_req_peers number of peers we want to receive * (0 for infinite updates) * @param cls a closure that will be given to the callback * @param ready_cb the callback called when the peers are available */ void GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle, uint32_t num_updates, GNUNET_RPS_NotifyReadyCB view_update_cb, void *cls) { struct GNUNET_MQ_Envelope *ev; struct GNUNET_RPS_CS_DEBUG_ViewRequest *msg; LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requests %" PRIu32 " view updates\n", num_updates); rps_handle->view_update_cb = view_update_cb; rps_handle->view_update_cls = cls; ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_VIEW_REQUEST); msg->num_updates = htonl (num_updates); GNUNET_MQ_send (rps_handle->mq, ev); } /** * Request biased stream of peers that are being put into the sampler * * @param rps_handle handle to the rps service * @param num_req_peers number of peers we want to receive * (0 for infinite updates) * @param cls a closure that will be given to the callback * @param ready_cb the callback called when the peers are available */ struct GNUNET_RPS_StreamRequestHandle * GNUNET_RPS_stream_request (struct GNUNET_RPS_Handle *rps_handle, uint32_t num_peers, GNUNET_RPS_NotifyReadyCB stream_input_cb, void *cls) { struct GNUNET_RPS_StreamRequestHandle *srh; struct GNUNET_MQ_Envelope *ev; struct GNUNET_RPS_CS_DEBUG_StreamRequest *msg; srh = new_stream_request (rps_handle, num_peers, /* num requests */ stream_input_cb, cls); LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requests %" PRIu32 " biased stream updates\n", num_peers); ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_STREAM_REQUEST); GNUNET_MQ_send (rps_handle->mq, ev); return srh; } /** * This function is called, when the service updates the view. * It verifies that @a msg is well-formed. * * @param cls the closure * @param msg the message * @return #GNUNET_OK if @a msg is well-formed */ static int check_view_update (void *cls, const struct GNUNET_RPS_CS_DEBUG_ViewReply *msg) { uint16_t msize = ntohs (msg->header.size); uint32_t num_peers = ntohl (msg->num_peers); (void) cls; msize -= sizeof (struct GNUNET_RPS_CS_DEBUG_ViewReply); if ( (msize / sizeof (struct GNUNET_PeerIdentity) != num_peers) || (msize % sizeof (struct GNUNET_PeerIdentity) != 0) ) { GNUNET_break (0); return GNUNET_SYSERR; } return GNUNET_OK; } /** * This function is called, when the service updated its view. * It calls the callback the caller provided * and disconnects afterwards. * * @param msg the message */ static void handle_view_update (void *cls, const struct GNUNET_RPS_CS_DEBUG_ViewReply *msg) { struct GNUNET_RPS_Handle *h = cls; struct GNUNET_PeerIdentity *peers; /* Give the peers back */ LOG (GNUNET_ERROR_TYPE_DEBUG, "New view of %" PRIu32 " peers:\n", ntohl (msg->num_peers)); peers = (struct GNUNET_PeerIdentity *) &msg[1]; GNUNET_assert (NULL != h); GNUNET_assert (NULL != h->view_update_cb); h->view_update_cb (h->view_update_cls, ntohl (msg->num_peers), peers); } /** * @brief Send message to service that this client does not want to receive * further updates from the biased peer stream * * @param rps_handle The handle representing the service to the client */ static void cancel_stream (struct GNUNET_RPS_Handle *rps_handle) { struct GNUNET_MQ_Envelope *ev; ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_STREAM_CANCEL); GNUNET_MQ_send (rps_handle->mq, ev); } /** * @brief Cancel a specific request for updates from the biased peer stream * * @param srh The request handle to cancel */ void GNUNET_RPS_stream_cancel (struct GNUNET_RPS_StreamRequestHandle *srh) { struct GNUNET_RPS_Handle *rps_handle; rps_handle = srh->rps_handle; GNUNET_CONTAINER_DLL_remove (rps_handle->stream_requests_head, rps_handle->stream_requests_tail, srh); GNUNET_free (srh); if (NULL == rps_handle->stream_requests_head) cancel_stream (rps_handle); } /** * This function is called, when the service sends another peer from the biased * stream. * It calls the callback the caller provided * and disconnects afterwards. * * TODO merge with check_view_update * * @param msg the message */ static int check_stream_input (void *cls, const struct GNUNET_RPS_CS_DEBUG_StreamReply *msg) { uint16_t msize = ntohs (msg->header.size); uint32_t num_peers = ntohl (msg->num_peers); (void) cls; msize -= sizeof (struct GNUNET_RPS_CS_DEBUG_StreamReply); if ( (msize / sizeof (struct GNUNET_PeerIdentity) != num_peers) || (msize % sizeof (struct GNUNET_PeerIdentity) != 0) ) { GNUNET_break (0); return GNUNET_SYSERR; } return GNUNET_OK; } /** * This function is called, when the service sends another peer from the biased * stream. * It calls the callback the caller provided * and disconnects afterwards. * * @param msg the message */ static void handle_stream_input (void *cls, const struct GNUNET_RPS_CS_DEBUG_StreamReply *msg) { struct GNUNET_RPS_Handle *h = cls; const struct GNUNET_PeerIdentity *peers; /* The following two pointers are used to prevent that new handles are * inserted into the DLL, that is currently iterated over, from within a call * to that handler_cb, are executed and in turn again add themselves to the * iterated DLL infinitely */ struct GNUNET_RPS_StreamRequestHandle *srh_head_tmp; struct GNUNET_RPS_StreamRequestHandle *srh_tail_tmp; uint64_t num_peers; uint64_t num_peers_return; peers = (struct GNUNET_PeerIdentity *) &msg[1]; num_peers = ntohl (msg->num_peers); LOG (GNUNET_ERROR_TYPE_DEBUG, "Received %" PRIu64 " peer(s) from stream input.\n", num_peers); srh_head_tmp = h->stream_requests_head; srh_tail_tmp = h->stream_requests_tail; h->stream_requests_head = NULL; h->stream_requests_tail = NULL; for (struct GNUNET_RPS_StreamRequestHandle *srh_iter = srh_head_tmp; NULL != srh_iter; srh_iter = srh_iter->next) { LOG (GNUNET_ERROR_TYPE_DEBUG, "Calling srh - left: %" PRIu64 "\n", srh_iter->num_peers_left); if (0 == srh_iter->num_peers_left) /* infinite updates */ { num_peers_return = num_peers; } else if (num_peers > srh_iter->num_peers_left) { num_peers_return = num_peers - srh_iter->num_peers_left; } else /* num_peers <= srh_iter->num_peers_left */ { num_peers_return = srh_iter->num_peers_left - num_peers; } srh_iter->ready_cb (srh_iter->ready_cb_cls, num_peers_return, peers); if (0 == srh_iter->num_peers_left) ; else if (num_peers_return >= srh_iter->num_peers_left) { remove_stream_request (srh_iter, srh_head_tmp, srh_tail_tmp); } else { srh_iter->num_peers_left -= num_peers_return; } } for (struct GNUNET_RPS_StreamRequestHandle *srh_iter = srh_head_tmp; NULL != srh_iter; srh_iter = srh_iter->next) { GNUNET_CONTAINER_DLL_insert (h->stream_requests_head, h->stream_requests_tail, srh_iter); } if (NULL == h->stream_requests_head) { cancel_stream (h); } } /** * Reconnect to the service */ static void reconnect (struct GNUNET_RPS_Handle *h); /** * Error handler for mq. * * This function is called whan mq encounters an error. * Until now mq doesn't provide useful error messages. * * @param cls the closure * @param error error code without specyfied meaning */ static void mq_error_handler (void *cls, enum GNUNET_MQ_Error error) { struct GNUNET_RPS_Handle *h = cls; //TODO LOG LOG (GNUNET_ERROR_TYPE_WARNING, "Problem with message queue. error: %i\n\ 1: READ,\n\ 2: WRITE,\n\ 4: TIMEOUT\n", error); reconnect (h); /* Resend all pending request as the service destroyed its knowledge * about them */ } /** * Reconnect to the service */ static void reconnect (struct GNUNET_RPS_Handle *h) { struct GNUNET_MQ_MessageHandler mq_handlers[] = { GNUNET_MQ_hd_var_size (view_update, GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_VIEW_REPLY, struct GNUNET_RPS_CS_DEBUG_ViewReply, h), GNUNET_MQ_hd_var_size (stream_input, GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_STREAM_REPLY, struct GNUNET_RPS_CS_DEBUG_StreamReply, h), GNUNET_MQ_handler_end () }; if (NULL != h->mq) GNUNET_MQ_destroy (h->mq); h->mq = GNUNET_CLIENT_connect (h->cfg, "rps", mq_handlers, &mq_error_handler, h); } /** * Connect to the rps service * * @param cfg configuration to use * @return a handle to the service */ struct GNUNET_RPS_Handle * GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg) { struct GNUNET_RPS_Handle *h; h = GNUNET_new (struct GNUNET_RPS_Handle); h->cfg = cfg; reconnect (h); if (NULL == h->mq) { GNUNET_free (h); return NULL; } return h; } /** * Request n random peers. * * @param rps_handle handle to the rps service * @param num_req_peers number of peers we want to receive * @param ready_cb the callback called when the peers are available * @param cls closure given to the callback * @return a handle to cancel this request */ struct GNUNET_RPS_Request_Handle * GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *rps_handle, uint32_t num_req_peers, GNUNET_RPS_NotifyReadyCB ready_cb, void *cls) { struct GNUNET_RPS_Request_Handle *rh; rh = new_request_handle (rps_handle, num_req_peers, ready_cb, cls); return rh; } /** * Seed rps service with peerIDs. * * @param h handle to the rps service * @param n number of peers to seed * @param ids the ids of the peers seeded */ void GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n, const struct GNUNET_PeerIdentity *ids) { size_t size_needed; uint32_t num_peers_max; const struct GNUNET_PeerIdentity *tmp_peer_pointer; struct GNUNET_MQ_Envelope *ev; struct GNUNET_RPS_CS_SeedMessage *msg; unsigned int i; LOG (GNUNET_ERROR_TYPE_DEBUG, "Client wants to seed %" PRIu32 " peers:\n", n); for (i = 0 ; i < n ; i++) LOG (GNUNET_ERROR_TYPE_DEBUG, "%u. peer: %s\n", i, GNUNET_i2s (&ids[i])); /* The actual size the message occupies */ size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) + n * sizeof (struct GNUNET_PeerIdentity); /* The number of peers that fits in one message together with * the respective header */ num_peers_max = (GNUNET_MAX_MESSAGE_SIZE - sizeof (struct GNUNET_RPS_CS_SeedMessage)) / sizeof (struct GNUNET_PeerIdentity); tmp_peer_pointer = ids; while (GNUNET_MAX_MESSAGE_SIZE < size_needed) { ev = GNUNET_MQ_msg_extra (msg, num_peers_max * sizeof (struct GNUNET_PeerIdentity), GNUNET_MESSAGE_TYPE_RPS_CS_SEED); msg->num_peers = htonl (num_peers_max); GNUNET_memcpy (&msg[1], tmp_peer_pointer, num_peers_max * sizeof (struct GNUNET_PeerIdentity)); GNUNET_MQ_send (h->mq, ev); n -= num_peers_max; size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) + n * sizeof (struct GNUNET_PeerIdentity); /* Set pointer to beginning of next block of num_peers_max peers */ tmp_peer_pointer = &ids[num_peers_max]; } ev = GNUNET_MQ_msg_extra (msg, n * sizeof (struct GNUNET_PeerIdentity), GNUNET_MESSAGE_TYPE_RPS_CS_SEED); msg->num_peers = htonl (n); GNUNET_memcpy (&msg[1], tmp_peer_pointer, n * sizeof (struct GNUNET_PeerIdentity)); GNUNET_MQ_send (h->mq, ev); } #ifdef ENABLE_MALICIOUS /** * Turn RPS service to act malicious. * * @param h handle to the rps service * @param type which type of malicious peer to turn to. * 0 Don't act malicious at all * 1 Try to maximise representation * 2 Try to partition the network * (isolate one peer from the rest) * @param n number of @a ids * @param ids the ids of the malicious peers * if @type is 2 the last id is the id of the * peer to be isolated from the rest */ void GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h, uint32_t type, uint32_t num_peers, const struct GNUNET_PeerIdentity *peer_ids, const struct GNUNET_PeerIdentity *target_peer) { size_t size_needed; uint32_t num_peers_max; const struct GNUNET_PeerIdentity *tmp_peer_pointer; struct GNUNET_MQ_Envelope *ev; struct GNUNET_RPS_CS_ActMaliciousMessage *msg; unsigned int i; LOG (GNUNET_ERROR_TYPE_DEBUG, "Client turns malicious (type %" PRIu32 ") with %" PRIu32 " other peers:\n", type, num_peers); for (i = 0 ; i < num_peers ; i++) LOG (GNUNET_ERROR_TYPE_DEBUG, "%u. peer: %s\n", i, GNUNET_i2s (&peer_ids[i])); /* The actual size the message would occupy */ size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) + num_peers * sizeof (struct GNUNET_PeerIdentity); /* The number of peers that fit in one message together with * the respective header */ num_peers_max = (GNUNET_MAX_MESSAGE_SIZE - sizeof (struct GNUNET_RPS_CS_SeedMessage)) / sizeof (struct GNUNET_PeerIdentity); tmp_peer_pointer = peer_ids; while (GNUNET_MAX_MESSAGE_SIZE < size_needed) { LOG (GNUNET_ERROR_TYPE_DEBUG, "Too many peers to send at once, sending %" PRIu32 " (all we can so far)\n", num_peers_max); ev = GNUNET_MQ_msg_extra (msg, num_peers_max * sizeof (struct GNUNET_PeerIdentity), GNUNET_MESSAGE_TYPE_RPS_ACT_MALICIOUS); msg->type = htonl (type); msg->num_peers = htonl (num_peers_max); if ( (2 == type) || (3 == type) ) msg->attacked_peer = peer_ids[num_peers]; GNUNET_memcpy (&msg[1], tmp_peer_pointer, num_peers_max * sizeof (struct GNUNET_PeerIdentity)); GNUNET_MQ_send (h->mq, ev); num_peers -= num_peers_max; size_needed = sizeof (struct GNUNET_RPS_CS_SeedMessage) + num_peers * sizeof (struct GNUNET_PeerIdentity); /* Set pointer to beginning of next block of num_peers_max peers */ tmp_peer_pointer = &peer_ids[num_peers_max]; } ev = GNUNET_MQ_msg_extra (msg, num_peers * sizeof (struct GNUNET_PeerIdentity), GNUNET_MESSAGE_TYPE_RPS_ACT_MALICIOUS); msg->type = htonl (type); msg->num_peers = htonl (num_peers); if ( (2 == type) || (3 == type) ) msg->attacked_peer = *target_peer; GNUNET_memcpy (&msg[1], tmp_peer_pointer, num_peers * sizeof (struct GNUNET_PeerIdentity)); GNUNET_MQ_send (h->mq, ev); } #endif /* ENABLE_MALICIOUS */ /** * Cancle an issued request. * * @param rh request handle of request to cancle */ void GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh) { struct GNUNET_RPS_Handle *h; h = rh->rps_handle; if (NULL != rh->srh) { remove_stream_request (rh->srh, h->stream_requests_head, h->stream_requests_tail); } if (NULL == h->stream_requests_head) cancel_stream(h); if (NULL != rh->sampler_rh) { RPS_sampler_request_cancel (rh->sampler_rh); } RPS_sampler_destroy (rh->sampler); GNUNET_free (rh); } /** * Disconnect from the rps service * * @param h the handle to the rps service */ void GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h) { GNUNET_MQ_destroy (h->mq); if (NULL != h->stream_requests_head) { LOG (GNUNET_ERROR_TYPE_WARNING, "Still waiting for requests\n"); } GNUNET_free (h); } /* end of rps_api.c */