GNUnet 0.21.1
setu_api.c File Reference
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_setu_service.h"
#include "setu.h"
Include dependency graph for setu_api.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_SETU_Handle
 Opaque handle to a set. More...
 
struct  GNUNET_SETU_Request
 Handle for a set operation request from another peer. More...
 
struct  GNUNET_SETU_OperationHandle
 Handle to an operation. More...
 
struct  GNUNET_SETU_ListenHandle
 Opaque handle to a listen operation. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "set-api", __VA_ARGS__)
 

Functions

static int check_result (void *cls, const struct GNUNET_SETU_ResultMessage *msg)
 Check that the given msg is well-formed. More...
 
static void handle_result (void *cls, const struct GNUNET_SETU_ResultMessage *msg)
 Handle result message for a set operation. More...
 
static void set_operation_destroy (struct GNUNET_SETU_OperationHandle *oh)
 Destroy the given set operation. More...
 
void GNUNET_SETU_operation_cancel (struct GNUNET_SETU_OperationHandle *oh)
 Cancel the given set operation. More...
 
static void handle_client_set_error (void *cls, enum GNUNET_MQ_Error error)
 We encountered an error communicating with the set service while performing a set operation. More...
 
struct GNUNET_SETU_HandleGNUNET_SETU_create (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Create an empty set, supporting the specified operation. More...
 
int GNUNET_SETU_add_element (struct GNUNET_SETU_Handle *set, const struct GNUNET_SETU_Element *element, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
 Add an element to the given set. More...
 
void GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set)
 Destroy the set handle if no operations are left, mark the set for destruction otherwise. More...
 
struct GNUNET_SETU_OperationHandleGNUNET_SETU_prepare (const struct GNUNET_PeerIdentity *other_peer, const struct GNUNET_HashCode *app_id, const struct GNUNET_MessageHeader *context_msg, const struct GNUNET_SETU_Option options[], GNUNET_SETU_ResultIterator result_cb, void *result_cls)
 Prepare a set operation to be evaluated with another peer. More...
 
static void listen_connect (void *cls)
 Connect to the set service in order to listen for requests. More...
 
static int check_request (void *cls, const struct GNUNET_SETU_RequestMessage *msg)
 Check validity of request message for a listen operation. More...
 
static void handle_request (void *cls, const struct GNUNET_SETU_RequestMessage *msg)
 Handle request message for a listen operation. More...
 
static void handle_client_listener_error (void *cls, enum GNUNET_MQ_Error error)
 Our connection with the set service encountered an error, re-initialize with exponential back-off. More...
 
struct GNUNET_SETU_ListenHandleGNUNET_SETU_listen (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *app_id, GNUNET_SETU_ListenCallback listen_cb, void *listen_cls)
 Wait for set operation requests for the given application id. More...
 
void GNUNET_SETU_listen_cancel (struct GNUNET_SETU_ListenHandle *lh)
 Cancel the given listen operation. More...
 
struct GNUNET_SETU_OperationHandleGNUNET_SETU_accept (struct GNUNET_SETU_Request *request, const struct GNUNET_SETU_Option options[], GNUNET_SETU_ResultIterator result_cb, void *result_cls)
 Accept a request we got via GNUNET_SETU_listen(). More...
 
int GNUNET_SETU_commit (struct GNUNET_SETU_OperationHandle *oh, struct GNUNET_SETU_Handle *set)
 Commit a set to be used with a set operation. More...
 
void GNUNET_SETU_element_hash (const struct GNUNET_SETU_Element *element, struct GNUNET_HashCode *ret_hash)
 Hash a set element. More...
 

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "set-api", __VA_ARGS__)

Definition at line 34 of file setu_api.c.

Function Documentation

◆ check_result()

static int check_result ( void *  cls,
const struct GNUNET_SETU_ResultMessage msg 
)
static

Check that the given msg is well-formed.

Parameters
clsclosure
msgmessage to check
Returns
GNUNET_OK if message is well-formed

Definition at line 196 of file setu_api.c.

198{
199 /* minimum size was already checked, everything else is OK! */
200 return GNUNET_OK;
201}
@ GNUNET_OK

References GNUNET_OK.

◆ handle_result()

static void handle_result ( void *  cls,
const struct GNUNET_SETU_ResultMessage msg 
)
static

Handle result message for a set operation.

Parameters
clsthe set
mhthe message

Definition at line 211 of file setu_api.c.

213{
214 struct GNUNET_SETU_Handle *set = cls;
216 struct GNUNET_SETU_Element e;
217 enum GNUNET_SETU_Status result_status;
218 int destroy_set;
219
220 GNUNET_assert (NULL != set->mq);
221 result_status = (enum GNUNET_SETU_Status) ntohs (msg->result_status);
223 "Got result message with status %d\n",
224 result_status);
225 oh = GNUNET_MQ_assoc_get (set->mq,
226 ntohl (msg->request_id));
227 if (NULL == oh)
228 {
229 /* 'oh' can be NULL if we canceled the operation, but the service
230 did not get the cancel message yet. */
232 "Ignoring result from canceled operation\n");
233 return;
234 }
235
236 switch (result_status)
237 {
240 e.data = &msg[1];
241 e.size = ntohs (msg->header.size)
242 - sizeof(struct GNUNET_SETU_ResultMessage);
243 e.element_type = ntohs (msg->element_type);
244 if (NULL != oh->result_cb)
245 oh->result_cb (oh->result_cls,
246 &e,
247 GNUNET_ntohll (msg->current_size),
249 return;
253 "Treating result as final status\n");
255 ntohl (msg->request_id));
257 set->ops_tail,
258 oh);
259 /* Need to do this calculation _before_ the result callback,
260 as IF the application still has a valid set handle, it
261 may trigger destruction of the set during the callback. */
262 destroy_set = (GNUNET_YES == set->destroy_requested) &&
263 (NULL == set->ops_head);
264 if (NULL != oh->result_cb)
265 {
266 oh->result_cb (oh->result_cls,
267 NULL,
268 GNUNET_ntohll (msg->current_size),
270 }
271 else
272 {
274 "No callback for final status\n");
275 }
276 if (destroy_set)
278 GNUNET_free (oh);
279 return;
280 }
281}
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_log(kind,...)
uint64_t GNUNET_ntohll(uint64_t n)
Convert unsigned 64-bit integer to host byte order.
Definition: common_endian.c:54
@ GNUNET_YES
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_MQ_assoc_get(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Get the data associated with a request_id in a queue.
Definition: mq.c:604
void * GNUNET_MQ_assoc_remove(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Remove the association for a request_id.
Definition: mq.c:622
void GNUNET_SETU_destroy(struct GNUNET_SETU_Handle *set)
Destroy the set handle if no operations are left, mark the set for destruction otherwise.
Definition: setu_api.c:471
GNUNET_SETU_Status
Status for the result callback.
@ GNUNET_SETU_STATUS_DONE
Success, all elements have been sent (and received).
@ GNUNET_SETU_STATUS_ADD_REMOTE
Element should be added to the result set of the remote peer, i.e.
@ GNUNET_SETU_STATUS_FAILURE
The other peer refused to do the operation with us, or something went wrong.
@ GNUNET_SETU_STATUS_ADD_LOCAL
Element should be added to the result set of the local peer, i.e.
#define LOG(kind,...)
Definition: setu_api.c:34
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
Element stored in a set.
Opaque handle to a set.
Definition: setu_api.c:40
struct GNUNET_SETU_OperationHandle * ops_tail
Linked list of operations on the set.
Definition: setu_api.c:54
int destroy_requested
Should the set be destroyed once all operations are gone? GNUNET_SYSERR if GNUNET_SETU_destroy() must...
Definition: setu_api.c:61
struct GNUNET_SETU_OperationHandle * ops_head
Linked list of operations on the set.
Definition: setu_api.c:49
struct GNUNET_MQ_Handle * mq
Message queue for client.
Definition: setu_api.c:44
Handle to an operation.
Definition: setu_api.c:95
void * result_cls
Closure for result_cb.
Definition: setu_api.c:105
GNUNET_SETU_ResultIterator result_cb
Function to be called when we have a result, or an error.
Definition: setu_api.c:100
Message sent by the service to the client to indicate an element that is removed (set intersection) o...
Definition: setu.h:290
uint16_t result_status
Was the evaluation successful? Contains an enum GNUNET_SETU_Status in NBO.
Definition: setu.h:310

References GNUNET_SETU_Element::data, GNUNET_SETU_Handle::destroy_requested, GNUNET_SETU_Element::element_type, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_MQ_assoc_get(), GNUNET_MQ_assoc_remove(), GNUNET_ntohll(), GNUNET_SETU_destroy(), GNUNET_SETU_STATUS_ADD_LOCAL, GNUNET_SETU_STATUS_ADD_REMOTE, GNUNET_SETU_STATUS_DONE, GNUNET_SETU_STATUS_FAILURE, GNUNET_YES, LOG, GNUNET_SETU_Handle::mq, msg, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_Handle::ops_tail, GNUNET_SETU_OperationHandle::result_cb, GNUNET_SETU_OperationHandle::result_cls, GNUNET_SETU_ResultMessage::result_status, GNUNET_MessageHeader::size, and GNUNET_SETU_Element::size.

Here is the call graph for this function:

◆ set_operation_destroy()

static void set_operation_destroy ( struct GNUNET_SETU_OperationHandle oh)
static

Destroy the given set operation.

Parameters
ohset operation to destroy

Definition at line 290 of file setu_api.c.

291{
292 struct GNUNET_SETU_Handle *set = oh->set;
293 struct GNUNET_SETU_OperationHandle *h_assoc;
294
295 if (NULL != oh->conclude_mqm)
297 /* is the operation already committed? */
298 if (NULL != set)
299 {
301 set->ops_tail,
302 oh);
303 h_assoc = GNUNET_MQ_assoc_remove (set->mq,
304 oh->request_id);
305 GNUNET_assert ((NULL == h_assoc) ||
306 (h_assoc == oh));
307 }
308 GNUNET_free (oh);
309}
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *mqm)
Discard the message queue message, free all allocated resources.
Definition: mq.c:285
struct GNUNET_SETU_Handle * set
Local set used for the operation, NULL if no set has been provided by conclude yet.
Definition: setu_api.c:111
uint32_t request_id
Request ID to identify the operation within the set.
Definition: setu_api.c:138
struct GNUNET_MQ_Envelope * conclude_mqm
Message sent to the server on calling conclude, NULL if conclude has been called.
Definition: setu_api.c:117

References GNUNET_SETU_OperationHandle::conclude_mqm, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_assoc_remove(), GNUNET_MQ_discard(), GNUNET_SETU_Handle::mq, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_Handle::ops_tail, GNUNET_SETU_OperationHandle::request_id, and GNUNET_SETU_OperationHandle::set.

Referenced by GNUNET_SETU_operation_cancel(), and handle_client_set_error().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_client_set_error()

static void handle_client_set_error ( void *  cls,
enum GNUNET_MQ_Error  error 
)
static

We encountered an error communicating with the set service while performing a set operation.

Report to the application.

Parameters
clsthe struct GNUNET_SETU_Handle
errorerror code

Definition at line 354 of file setu_api.c.

356{
357 struct GNUNET_SETU_Handle *set = cls;
358
360 "Handling client set error %d\n",
361 error);
362 while (NULL != set->ops_head)
363 {
364 if ((NULL != set->ops_head->result_cb) &&
367 NULL,
368 0,
371 }
372 set->invalid = GNUNET_YES;
373}
@ GNUNET_NO
@ GNUNET_ERROR_TYPE_ERROR
static void set_operation_destroy(struct GNUNET_SETU_OperationHandle *oh)
Destroy the given set operation.
Definition: setu_api.c:290
int invalid
Has the set become invalid (e.g.
Definition: setu_api.c:66

References GNUNET_SETU_Handle::destroy_requested, GNUNET_ERROR_TYPE_ERROR, GNUNET_NO, GNUNET_SETU_STATUS_FAILURE, GNUNET_YES, GNUNET_SETU_Handle::invalid, LOG, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_OperationHandle::result_cb, GNUNET_SETU_OperationHandle::result_cls, and set_operation_destroy().

Referenced by GNUNET_SETU_create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ listen_connect()

static void listen_connect ( void *  cls)
static

Connect to the set service in order to listen for requests.

Parameters
clsthe struct GNUNET_SETU_ListenHandle * to connect

Definition at line 675 of file setu_api.c.

676{
677 struct GNUNET_SETU_ListenHandle *lh = cls;
678 struct GNUNET_MQ_MessageHandler mq_handlers[] = {
682 lh),
684 };
685 struct GNUNET_MQ_Envelope *mqm;
687
688 lh->reconnect_task = NULL;
689 GNUNET_assert (NULL == lh->mq);
690 lh->mq = GNUNET_CLIENT_connect (lh->cfg,
691 "setu",
692 mq_handlers,
694 lh);
695 if (NULL == lh->mq)
696 return;
697 mqm = GNUNET_MQ_msg (msg,
699 msg->app_id = lh->app_id;
700 GNUNET_MQ_send (lh->mq,
701 mqm);
702}
static struct GNUNET_VPN_RedirectionRequest * request
Opaque redirection request handle.
Definition: gnunet-vpn.c:40
struct GNUNET_MQ_Handle * GNUNET_CLIENT_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *error_handler_cls)
Create a message queue to connect to a GNUnet service.
Definition: client.c:1057
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:304
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:78
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_SETU_REQUEST
Notify the client of an incoming request from a remote peer.
#define GNUNET_MESSAGE_TYPE_SETU_LISTEN
Listen for operation requests.
static void handle_client_listener_error(void *cls, enum GNUNET_MQ_Error error)
Our connection with the set service encountered an error, re-initialize with exponential back-off.
Definition: setu_api.c:652
Message handler for a specific message type.
Opaque handle to a listen operation.
Definition: setu_api.c:146
struct GNUNET_HashCode app_id
Application ID we listen for.
Definition: setu_api.c:173
struct GNUNET_MQ_Handle * mq
Message queue for the client.
Definition: setu_api.c:150
struct GNUNET_SCHEDULER_Task * reconnect_task
Task for reconnecting when the listener fails.
Definition: setu_api.c:183
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration handle for the listener, stored here to be able to reconnect transparently on connectio...
Definition: setu_api.c:157
Message sent by the client to the service to start listening for incoming requests to perform a certa...
Definition: setu.h:56
A request for an operation with another client.
Definition: setu.h:175

References GNUNET_SETU_ListenHandle::app_id, GNUNET_SETU_ListenHandle::cfg, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_SETU_LISTEN, GNUNET_MESSAGE_TYPE_SETU_REQUEST, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), handle_client_listener_error(), GNUNET_SETU_ListenHandle::mq, msg, GNUNET_SETU_ListenHandle::reconnect_task, and request.

Referenced by GNUNET_SETU_listen(), and handle_client_listener_error().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_request()

static int check_request ( void *  cls,
const struct GNUNET_SETU_RequestMessage msg 
)
static

Check validity of request message for a listen operation.

Parameters
clsthe listen handle
msgthe message
Returns
GNUNET_OK if the message is well-formed

Definition at line 584 of file setu_api.c.

586{
587 const struct GNUNET_MessageHeader *context_msg;
588
589 if (ntohs (msg->header.size) == sizeof(*msg))
590 return GNUNET_OK; /* no context message is OK */
591 context_msg = GNUNET_MQ_extract_nested_mh (msg);
592 if (NULL == context_msg)
593 {
594 /* malformed context message is NOT ok */
595 GNUNET_break_op (0);
596 return GNUNET_SYSERR;
597 }
598 return GNUNET_OK;
599}
@ GNUNET_SYSERR
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_MQ_extract_nested_mh(var)
Return a pointer to the message at the end of the given message.
Header for all communications.

References GNUNET_break_op, GNUNET_MQ_extract_nested_mh, GNUNET_OK, GNUNET_SYSERR, msg, and GNUNET_MessageHeader::size.

◆ handle_request()

static void handle_request ( void *  cls,
const struct GNUNET_SETU_RequestMessage msg 
)
static

Handle request message for a listen operation.

Parameters
clsthe listen handle
msgthe message

Definition at line 609 of file setu_api.c.

611{
612 struct GNUNET_SETU_ListenHandle *lh = cls;
613 struct GNUNET_SETU_Request req;
614 const struct GNUNET_MessageHeader *context_msg;
615 struct GNUNET_MQ_Envelope *mqm;
616 struct GNUNET_SETU_RejectMessage *rmsg;
617
619 "Processing incoming operation request with id %u\n",
620 ntohl (msg->accept_id));
621 /* we got another valid request => reset the backoff */
623 req.accept_id = ntohl (msg->accept_id);
624 req.accepted = GNUNET_NO;
625 context_msg = GNUNET_MQ_extract_nested_mh (msg);
626 /* calling #GNUNET_SETU_accept() in the listen cb will set req->accepted */
627 lh->listen_cb (lh->listen_cls,
628 &msg->peer_id,
629 context_msg,
630 &req);
631 if (GNUNET_YES == req.accepted)
632 return; /* the accept-case is handled in #GNUNET_SETU_accept() */
634 "Rejected request %u\n",
635 ntohl (msg->accept_id));
636 mqm = GNUNET_MQ_msg (rmsg,
638 rmsg->accept_reject_id = msg->accept_id;
639 GNUNET_MQ_send (lh->mq,
640 mqm);
641}
#define GNUNET_MESSAGE_TYPE_SETU_REJECT
Reject a set request.
#define GNUNET_TIME_UNIT_MILLISECONDS
One millisecond.
GNUNET_SETU_ListenCallback listen_cb
Function to call on a new incoming request, or on error.
Definition: setu_api.c:163
void * listen_cls
Closure for listen_cb.
Definition: setu_api.c:168
struct GNUNET_TIME_Relative reconnect_backoff
Time to wait until we try to reconnect on failure.
Definition: setu_api.c:178
Message sent by a listening client to the service to reject performing the operation with the other p...
Definition: setu.h:158
uint32_t accept_reject_id
ID of the incoming request we want to reject.
Definition: setu.h:167
Handle for a set operation request from another peer.
Definition: setu_api.c:75

References GNUNET_SETU_Request::accept_id, GNUNET_SETU_RejectMessage::accept_reject_id, GNUNET_SETU_Request::accepted, GNUNET_ERROR_TYPE_DEBUG, GNUNET_MESSAGE_TYPE_SETU_REJECT, GNUNET_MQ_extract_nested_mh, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_NO, GNUNET_TIME_UNIT_MILLISECONDS, GNUNET_YES, GNUNET_SETU_ListenHandle::listen_cb, GNUNET_SETU_ListenHandle::listen_cls, LOG, GNUNET_SETU_ListenHandle::mq, msg, and GNUNET_SETU_ListenHandle::reconnect_backoff.

Here is the call graph for this function:

◆ handle_client_listener_error()

static void handle_client_listener_error ( void *  cls,
enum GNUNET_MQ_Error  error 
)
static

Our connection with the set service encountered an error, re-initialize with exponential back-off.

Parameters
clsthe struct GNUNET_SETU_ListenHandle *
errorreason for the disconnect

Definition at line 652 of file setu_api.c.

654{
655 struct GNUNET_SETU_ListenHandle *lh = cls;
656
658 "Listener broke down (%d), re-connecting\n",
659 (int) error);
660 GNUNET_MQ_destroy (lh->mq);
661 lh->mq = NULL;
664 lh);
666}
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:683
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1272
#define GNUNET_TIME_STD_BACKOFF(r)
Perform our standard exponential back-off calculation, starting at 1 ms and then going by a factor of...
static void listen_connect(void *cls)
Connect to the set service in order to listen for requests.
Definition: setu_api.c:675

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, listen_connect(), LOG, GNUNET_SETU_ListenHandle::mq, GNUNET_SETU_ListenHandle::reconnect_backoff, and GNUNET_SETU_ListenHandle::reconnect_task.

Referenced by listen_connect().

Here is the call graph for this function:
Here is the caller graph for this function: