aboutsummaryrefslogtreecommitdiff
path: root/src/contrib/service/set/set_api.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/contrib/service/set/set_api.c')
-rw-r--r--src/contrib/service/set/set_api.c1199
1 files changed, 1199 insertions, 0 deletions
diff --git a/src/contrib/service/set/set_api.c b/src/contrib/service/set/set_api.c
new file mode 100644
index 000000000..4f73ff06c
--- /dev/null
+++ b/src/contrib/service/set/set_api.c
@@ -0,0 +1,1199 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2012-2016 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 * @file set/set_api.c
22 * @brief api for the set service
23 * @author Florian Dold
24 * @author Christian Grothoff
25 */
26#include "platform.h"
27#include "gnunet_util_lib.h"
28#include "gnunet_protocols.h"
29#include "gnunet_set_service.h"
30#include "set.h"
31
32
33#define LOG(kind, ...) GNUNET_log_from (kind, "set-api", __VA_ARGS__)
34
35struct SetCopyRequest
36{
37 struct SetCopyRequest *next;
38
39 struct SetCopyRequest *prev;
40
41 void *cls;
42
43 GNUNET_SET_CopyReadyCallback cb;
44};
45
46/**
47 * Opaque handle to a set.
48 */
49struct GNUNET_SET_Handle
50{
51 /**
52 * Message queue for @e client.
53 */
54 struct GNUNET_MQ_Handle *mq;
55
56 /**
57 * Linked list of operations on the set.
58 */
59 struct GNUNET_SET_OperationHandle *ops_head;
60
61 /**
62 * Linked list of operations on the set.
63 */
64 struct GNUNET_SET_OperationHandle *ops_tail;
65
66 /**
67 * Callback for the current iteration over the set,
68 * NULL if no iterator is active.
69 */
70 GNUNET_SET_ElementIterator iterator;
71
72 /**
73 * Closure for @e iterator
74 */
75 void *iterator_cls;
76
77 /**
78 * Should the set be destroyed once all operations are gone?
79 * #GNUNET_SYSERR if #GNUNET_SET_destroy() must raise this flag,
80 * #GNUNET_YES if #GNUNET_SET_destroy() did raise this flag.
81 */
82 int destroy_requested;
83
84 /**
85 * Has the set become invalid (e.g. service died)?
86 */
87 int invalid;
88
89 /**
90 * Both client and service count the number of iterators
91 * created so far to match replies with iterators.
92 */
93 uint16_t iteration_id;
94
95 /**
96 * Configuration, needed when creating (lazy) copies.
97 */
98 const struct GNUNET_CONFIGURATION_Handle *cfg;
99
100 /**
101 * Doubly linked list of copy requests.
102 */
103 struct SetCopyRequest *copy_req_head;
104
105 /**
106 * Doubly linked list of copy requests.
107 */
108 struct SetCopyRequest *copy_req_tail;
109};
110
111
112/**
113 * Handle for a set operation request from another peer.
114 */
115struct GNUNET_SET_Request
116{
117 /**
118 * Id of the request, used to identify the request when
119 * accepting/rejecting it.
120 */
121 uint32_t accept_id;
122
123 /**
124 * Has the request been accepted already?
125 * #GNUNET_YES/#GNUNET_NO
126 */
127 int accepted;
128};
129
130
131/**
132 * Handle to an operation. Only known to the service after committing
133 * the handle with a set.
134 */
135struct GNUNET_SET_OperationHandle
136{
137 /**
138 * Function to be called when we have a result,
139 * or an error.
140 */
141 GNUNET_SET_ResultIterator result_cb;
142
143 /**
144 * Closure for @e result_cb.
145 */
146 void *result_cls;
147
148 /**
149 * Local set used for the operation,
150 * NULL if no set has been provided by conclude yet.
151 */
152 struct GNUNET_SET_Handle *set;
153
154 /**
155 * Message sent to the server on calling conclude,
156 * NULL if conclude has been called.
157 */
158 struct GNUNET_MQ_Envelope *conclude_mqm;
159
160 /**
161 * Address of the request if in the conclude message,
162 * used to patch the request id into the message when the set is known.
163 */
164 uint32_t *request_id_addr;
165
166 /**
167 * Handles are kept in a linked list.
168 */
169 struct GNUNET_SET_OperationHandle *prev;
170
171 /**
172 * Handles are kept in a linked list.
173 */
174 struct GNUNET_SET_OperationHandle *next;
175
176 /**
177 * Request ID to identify the operation within the set.
178 */
179 uint32_t request_id;
180};
181
182
183/**
184 * Opaque handle to a listen operation.
185 */
186struct GNUNET_SET_ListenHandle
187{
188 /**
189 * Message queue for the client.
190 */
191 struct GNUNET_MQ_Handle*mq;
192
193 /**
194 * Configuration handle for the listener, stored
195 * here to be able to reconnect transparently on
196 * connection failure.
197 */
198 const struct GNUNET_CONFIGURATION_Handle *cfg;
199
200 /**
201 * Function to call on a new incoming request,
202 * or on error.
203 */
204 GNUNET_SET_ListenCallback listen_cb;
205
206 /**
207 * Closure for @e listen_cb.
208 */
209 void *listen_cls;
210
211 /**
212 * Application ID we listen for.
213 */
214 struct GNUNET_HashCode app_id;
215
216 /**
217 * Time to wait until we try to reconnect on failure.
218 */
219 struct GNUNET_TIME_Relative reconnect_backoff;
220
221 /**
222 * Task for reconnecting when the listener fails.
223 */
224 struct GNUNET_SCHEDULER_Task *reconnect_task;
225
226 /**
227 * Operation we listen for.
228 */
229 enum GNUNET_SET_OperationType operation;
230};
231
232
233/* mutual recursion with handle_copy_lazy */
234static struct GNUNET_SET_Handle *
235create_internal (const struct GNUNET_CONFIGURATION_Handle *cfg,
236 enum GNUNET_SET_OperationType op,
237 const uint32_t *cookie);
238
239
240/**
241 * Handle element for iteration over the set. Notifies the
242 * iterator and sends an acknowledgement to the service.
243 *
244 * @param cls the `struct GNUNET_SET_Handle *`
245 * @param msg the message
246 */
247static void
248handle_copy_lazy (void *cls,
249 const struct GNUNET_SET_CopyLazyResponseMessage *msg)
250{
251 struct GNUNET_SET_Handle *set = cls;
252 struct SetCopyRequest *req;
253 struct GNUNET_SET_Handle *new_set;
254
255 req = set->copy_req_head;
256 if (NULL == req)
257 {
258 /* Service sent us unsolicited lazy copy response */
259 GNUNET_break (0);
260 return;
261 }
262
263 LOG (GNUNET_ERROR_TYPE_DEBUG,
264 "Handling response to lazy copy\n");
265 GNUNET_CONTAINER_DLL_remove (set->copy_req_head,
266 set->copy_req_tail,
267 req);
268 // We pass none as operation here, since it doesn't matter when
269 // cloning.
270 new_set = create_internal (set->cfg,
271 GNUNET_SET_OPERATION_NONE,
272 &msg->cookie);
273 req->cb (req->cls, new_set);
274 GNUNET_free (req);
275}
276
277
278/**
279 * Check that the given @a msg is well-formed.
280 *
281 * @param cls closure
282 * @param msg message to check
283 * @return #GNUNET_OK if message is well-formed
284 */
285static int
286check_iter_element (void *cls,
287 const struct GNUNET_SET_IterResponseMessage *msg)
288{
289 /* minimum size was already checked, everything else is OK! */
290 return GNUNET_OK;
291}
292
293
294/**
295 * Handle element for iteration over the set. Notifies the
296 * iterator and sends an acknowledgement to the service.
297 *
298 * @param cls the `struct GNUNET_SET_Handle *`
299 * @param msg the message
300 */
301static void
302handle_iter_element (void *cls,
303 const struct GNUNET_SET_IterResponseMessage *msg)
304{
305 struct GNUNET_SET_Handle *set = cls;
306 GNUNET_SET_ElementIterator iter = set->iterator;
307 struct GNUNET_SET_Element element;
308 struct GNUNET_SET_IterAckMessage *ack_msg;
309 struct GNUNET_MQ_Envelope *ev;
310 uint16_t msize;
311
312 LOG (GNUNET_ERROR_TYPE_DEBUG,
313 "Received element in set iteration\n");
314 msize = ntohs (msg->header.size);
315 if (set->iteration_id != ntohs (msg->iteration_id))
316 {
317 /* element from a previous iteration, skip! */
318 iter = NULL;
319 }
320 if (NULL != iter)
321 {
322 element.size = msize - sizeof(struct GNUNET_SET_IterResponseMessage);
323 element.element_type = ntohs (msg->element_type);
324 element.data = &msg[1];
325 iter (set->iterator_cls,
326 &element);
327 }
328 ev = GNUNET_MQ_msg (ack_msg,
329 GNUNET_MESSAGE_TYPE_SET_ITER_ACK);
330 ack_msg->send_more = htonl ((NULL != iter));
331 GNUNET_MQ_send (set->mq, ev);
332}
333
334
335/**
336 * Handle message signalling conclusion of iteration over the set.
337 * Notifies the iterator that we are done.
338 *
339 * @param cls the set
340 * @param mh the message
341 */
342static void
343handle_iter_done (void *cls,
344 const struct GNUNET_MessageHeader *mh)
345{
346 struct GNUNET_SET_Handle *set = cls;
347 GNUNET_SET_ElementIterator iter = set->iterator;
348
349 if (NULL == iter)
350 {
351 /* FIXME: if this is true, could cancel+start a fresh one
352 cause elements to go to the wrong iteration? */
353 LOG (GNUNET_ERROR_TYPE_INFO,
354 "Service completed set iteration that was already cancelled\n");
355 return;
356 }
357 LOG (GNUNET_ERROR_TYPE_DEBUG,
358 "Set iteration completed\n");
359 set->destroy_requested = GNUNET_SYSERR;
360 set->iterator = NULL;
361 set->iteration_id++;
362 iter (set->iterator_cls,
363 NULL);
364 if (GNUNET_SYSERR == set->destroy_requested)
365 set->destroy_requested = GNUNET_NO;
366 if (GNUNET_YES == set->destroy_requested)
367 GNUNET_SET_destroy (set);
368}
369
370
371/**
372 * Check that the given @a msg is well-formed.
373 *
374 * @param cls closure
375 * @param msg message to check
376 * @return #GNUNET_OK if message is well-formed
377 */
378static int
379check_result (void *cls,
380 const struct GNUNET_SET_ResultMessage *msg)
381{
382 /* minimum size was already checked, everything else is OK! */
383 return GNUNET_OK;
384}
385
386
387/**
388 * Handle result message for a set operation.
389 *
390 * @param cls the set
391 * @param mh the message
392 */
393static void
394handle_result (void *cls,
395 const struct GNUNET_SET_ResultMessage *msg)
396{
397 struct GNUNET_SET_Handle *set = cls;
398 struct GNUNET_SET_OperationHandle *oh;
399 struct GNUNET_SET_Element e;
400 enum GNUNET_SET_Status result_status;
401 int destroy_set;
402
403 GNUNET_assert (NULL != set->mq);
404 result_status = (enum GNUNET_SET_Status) ntohs (msg->result_status);
405 LOG (GNUNET_ERROR_TYPE_DEBUG,
406 "Got result message with status %d\n",
407 result_status);
408
409 oh = GNUNET_MQ_assoc_get (set->mq,
410 ntohl (msg->request_id));
411 if (NULL == oh)
412 {
413 /* 'oh' can be NULL if we canceled the operation, but the service
414 did not get the cancel message yet. */
415 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
416 "Ignoring result from canceled operation\n");
417 return;
418 }
419
420 switch (result_status)
421 {
422 case GNUNET_SET_STATUS_OK:
423 case GNUNET_SET_STATUS_ADD_LOCAL:
424 case GNUNET_SET_STATUS_ADD_REMOTE:
425 goto do_element;
426
427 case GNUNET_SET_STATUS_FAILURE:
428 case GNUNET_SET_STATUS_DONE:
429 goto do_final;
430
431 case GNUNET_SET_STATUS_HALF_DONE:
432 /* not used anymore */
433 GNUNET_assert (0);
434 }
435
436do_final:
437 LOG (GNUNET_ERROR_TYPE_DEBUG,
438 "Treating result as final status\n");
439 GNUNET_MQ_assoc_remove (set->mq,
440 ntohl (msg->request_id));
441 GNUNET_CONTAINER_DLL_remove (set->ops_head,
442 set->ops_tail,
443 oh);
444 /* Need to do this calculation _before_ the result callback,
445 as IF the application still has a valid set handle, it
446 may trigger destruction of the set during the callback. */
447 destroy_set = (GNUNET_YES == set->destroy_requested) &&
448 (NULL == set->ops_head);
449 if (NULL != oh->result_cb)
450 {
451 oh->result_cb (oh->result_cls,
452 NULL,
453 GNUNET_ntohll (msg->current_size),
454 result_status);
455 }
456 else
457 {
458 LOG (GNUNET_ERROR_TYPE_DEBUG,
459 "No callback for final status\n");
460 }
461 if (destroy_set)
462 GNUNET_SET_destroy (set);
463 GNUNET_free (oh);
464 return;
465
466do_element:
467 LOG (GNUNET_ERROR_TYPE_DEBUG,
468 "Treating result as element\n");
469 e.data = &msg[1];
470 e.size = ntohs (msg->header.size) - sizeof(struct GNUNET_SET_ResultMessage);
471 e.element_type = ntohs (msg->element_type);
472 if (NULL != oh->result_cb)
473 oh->result_cb (oh->result_cls,
474 &e,
475 GNUNET_ntohll (msg->current_size),
476 result_status);
477}
478
479
480/**
481 * Destroy the given set operation.
482 *
483 * @param oh set operation to destroy
484 */
485static void
486set_operation_destroy (struct GNUNET_SET_OperationHandle *oh)
487{
488 struct GNUNET_SET_Handle *set = oh->set;
489 struct GNUNET_SET_OperationHandle *h_assoc;
490
491 if (NULL != oh->conclude_mqm)
492 GNUNET_MQ_discard (oh->conclude_mqm);
493 /* is the operation already committed? */
494 if (NULL != set)
495 {
496 GNUNET_CONTAINER_DLL_remove (set->ops_head,
497 set->ops_tail,
498 oh);
499 h_assoc = GNUNET_MQ_assoc_remove (set->mq,
500 oh->request_id);
501 GNUNET_assert ((NULL == h_assoc) ||
502 (h_assoc == oh));
503 }
504 GNUNET_free (oh);
505}
506
507
508/**
509 * Cancel the given set operation. We need to send an explicit cancel
510 * message, as all operations one one set communicate using one
511 * handle.
512 *
513 * @param oh set operation to cancel
514 */
515void
516GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh)
517{
518 struct GNUNET_SET_Handle *set = oh->set;
519 struct GNUNET_SET_CancelMessage *m;
520 struct GNUNET_MQ_Envelope *mqm;
521
522 LOG (GNUNET_ERROR_TYPE_DEBUG,
523 "Cancelling SET operation\n");
524 if (NULL != set)
525 {
526 mqm = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_SET_CANCEL);
527 m->request_id = htonl (oh->request_id);
528 GNUNET_MQ_send (set->mq, mqm);
529 }
530 set_operation_destroy (oh);
531 if ((NULL != set) &&
532 (GNUNET_YES == set->destroy_requested) &&
533 (NULL == set->ops_head))
534 {
535 LOG (GNUNET_ERROR_TYPE_DEBUG,
536 "Destroying set after operation cancel\n");
537 GNUNET_SET_destroy (set);
538 }
539}
540
541
542/**
543 * We encountered an error communicating with the set service while
544 * performing a set operation. Report to the application.
545 *
546 * @param cls the `struct GNUNET_SET_Handle`
547 * @param error error code
548 */
549static void
550handle_client_set_error (void *cls,
551 enum GNUNET_MQ_Error error)
552{
553 struct GNUNET_SET_Handle *set = cls;
554 GNUNET_SET_ElementIterator iter = set->iterator;
555
556 LOG (GNUNET_ERROR_TYPE_ERROR,
557 "Handling client set error %d\n",
558 error);
559 while (NULL != set->ops_head)
560 {
561 if ((NULL != set->ops_head->result_cb) &&
562 (GNUNET_NO == set->destroy_requested))
563 set->ops_head->result_cb (set->ops_head->result_cls,
564 NULL,
565 0,
566 GNUNET_SET_STATUS_FAILURE);
567 set_operation_destroy (set->ops_head);
568 }
569 set->iterator = NULL;
570 set->iteration_id++;
571 set->invalid = GNUNET_YES;
572 if (NULL != iter)
573 iter (set->iterator_cls,
574 NULL);
575}
576
577
578/**
579 * FIXME.
580 */
581static struct GNUNET_SET_Handle *
582create_internal (const struct GNUNET_CONFIGURATION_Handle *cfg,
583 enum GNUNET_SET_OperationType op,
584 const uint32_t *cookie)
585{
586 struct GNUNET_SET_Handle *set = GNUNET_new (struct GNUNET_SET_Handle);
587 struct GNUNET_MQ_MessageHandler mq_handlers[] = {
588 GNUNET_MQ_hd_var_size (result,
589 GNUNET_MESSAGE_TYPE_SET_RESULT,
590 struct GNUNET_SET_ResultMessage,
591 set),
592 GNUNET_MQ_hd_var_size (iter_element,
593 GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT,
594 struct GNUNET_SET_IterResponseMessage,
595 set),
596 GNUNET_MQ_hd_fixed_size (iter_done,
597 GNUNET_MESSAGE_TYPE_SET_ITER_DONE,
598 struct GNUNET_MessageHeader,
599 set),
600 GNUNET_MQ_hd_fixed_size (copy_lazy,
601 GNUNET_MESSAGE_TYPE_SET_COPY_LAZY_RESPONSE,
602 struct GNUNET_SET_CopyLazyResponseMessage,
603 set),
604 GNUNET_MQ_handler_end ()
605 };
606 struct GNUNET_MQ_Envelope *mqm;
607 struct GNUNET_SET_CreateMessage *create_msg;
608 struct GNUNET_SET_CopyLazyConnectMessage *copy_msg;
609
610 set->cfg = cfg;
611 set->mq = GNUNET_CLIENT_connect (cfg,
612 "set",
613 mq_handlers,
614 &handle_client_set_error,
615 set);
616 if (NULL == set->mq)
617 {
618 GNUNET_free (set);
619 return NULL;
620 }
621 if (NULL == cookie)
622 {
623 LOG (GNUNET_ERROR_TYPE_DEBUG,
624 "Creating new set (operation %u)\n",
625 op);
626 mqm = GNUNET_MQ_msg (create_msg,
627 GNUNET_MESSAGE_TYPE_SET_CREATE);
628 create_msg->operation = htonl (op);
629 }
630 else
631 {
632 LOG (GNUNET_ERROR_TYPE_DEBUG,
633 "Creating new set (lazy copy)\n");
634 mqm = GNUNET_MQ_msg (copy_msg,
635 GNUNET_MESSAGE_TYPE_SET_COPY_LAZY_CONNECT);
636 copy_msg->cookie = *cookie;
637 }
638 GNUNET_MQ_send (set->mq,
639 mqm);
640 return set;
641}
642
643
644/**
645 * Create an empty set, supporting the specified operation.
646 *
647 * @param cfg configuration to use for connecting to the
648 * set service
649 * @param op operation supported by the set
650 * Note that the operation has to be specified
651 * beforehand, as certain set operations need to maintain
652 * data structures specific to the operation
653 * @return a handle to the set
654 */
655struct GNUNET_SET_Handle *
656GNUNET_SET_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
657 enum GNUNET_SET_OperationType op)
658{
659 struct GNUNET_SET_Handle *set;
660
661 set = create_internal (cfg,
662 op,
663 NULL);
664 LOG (GNUNET_ERROR_TYPE_DEBUG,
665 "Creating set %p for operation %d\n",
666 set,
667 op);
668 return set;
669}
670
671
672int
673GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
674 const struct GNUNET_SET_Element *element,
675 GNUNET_SET_Continuation cont,
676 void *cont_cls)
677{
678 struct GNUNET_MQ_Envelope *mqm;
679 struct GNUNET_SET_ElementMessage *msg;
680
681 LOG (GNUNET_ERROR_TYPE_DEBUG,
682 "adding element of type %u to set %p\n",
683 (unsigned int) element->element_type,
684 set);
685 GNUNET_assert (NULL != set);
686 if (GNUNET_YES == set->invalid)
687 {
688 if (NULL != cont)
689 cont (cont_cls);
690 return GNUNET_SYSERR;
691 }
692 mqm = GNUNET_MQ_msg_extra (msg,
693 element->size,
694 GNUNET_MESSAGE_TYPE_SET_ADD);
695 msg->element_type = htons (element->element_type);
696 GNUNET_memcpy (&msg[1],
697 element->data,
698 element->size);
699 GNUNET_MQ_notify_sent (mqm,
700 cont, cont_cls);
701 GNUNET_MQ_send (set->mq, mqm);
702 return GNUNET_OK;
703}
704
705
706int
707GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
708 const struct GNUNET_SET_Element *element,
709 GNUNET_SET_Continuation cont,
710 void *cont_cls)
711{
712 struct GNUNET_MQ_Envelope *mqm;
713 struct GNUNET_SET_ElementMessage *msg;
714
715 LOG (GNUNET_ERROR_TYPE_DEBUG,
716 "Removing element from set %p\n",
717 set);
718 if (GNUNET_YES == set->invalid)
719 {
720 if (NULL != cont)
721 cont (cont_cls);
722 return GNUNET_SYSERR;
723 }
724 mqm = GNUNET_MQ_msg_extra (msg,
725 element->size,
726 GNUNET_MESSAGE_TYPE_SET_REMOVE);
727 msg->element_type = htons (element->element_type);
728 GNUNET_memcpy (&msg[1],
729 element->data,
730 element->size);
731 GNUNET_MQ_notify_sent (mqm,
732 cont, cont_cls);
733 GNUNET_MQ_send (set->mq, mqm);
734 return GNUNET_OK;
735}
736
737
738/**
739 * Destroy the set handle if no operations are left, mark the set
740 * for destruction otherwise.
741 *
742 * @param set set handle to destroy
743 */
744void
745GNUNET_SET_destroy (struct GNUNET_SET_Handle *set)
746{
747 /* destroying set while iterator is active is currently
748 not supported; we should expand the API to allow
749 clients to explicitly cancel the iteration! */
750 GNUNET_assert (NULL != set);
751 if ((NULL != set->ops_head) ||
752 (NULL != set->iterator) ||
753 (GNUNET_SYSERR == set->destroy_requested))
754 {
755 LOG (GNUNET_ERROR_TYPE_DEBUG,
756 "Set operations are pending, delaying set destruction\n");
757 set->destroy_requested = GNUNET_YES;
758 return;
759 }
760 LOG (GNUNET_ERROR_TYPE_DEBUG,
761 "Really destroying set\n");
762 if (NULL != set->mq)
763 {
764 GNUNET_MQ_destroy (set->mq);
765 set->mq = NULL;
766 }
767 GNUNET_free (set);
768}
769
770
771struct GNUNET_SET_OperationHandle *
772GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
773 const struct GNUNET_HashCode *app_id,
774 const struct GNUNET_MessageHeader *context_msg,
775 enum GNUNET_SET_ResultMode result_mode,
776 struct GNUNET_SET_Option options[],
777 GNUNET_SET_ResultIterator result_cb,
778 void *result_cls)
779{
780 struct GNUNET_MQ_Envelope *mqm;
781 struct GNUNET_SET_OperationHandle *oh;
782 struct GNUNET_SET_EvaluateMessage *msg;
783 struct GNUNET_SET_Option *opt;
784
785 LOG (GNUNET_ERROR_TYPE_DEBUG,
786 "Client prepares set operation (%d)\n",
787 result_mode);
788 oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
789 oh->result_cb = result_cb;
790 oh->result_cls = result_cls;
791 mqm = GNUNET_MQ_msg_nested_mh (msg,
792 GNUNET_MESSAGE_TYPE_SET_EVALUATE,
793 context_msg);
794 msg->app_id = *app_id;
795 msg->result_mode = htonl (result_mode);
796 msg->target_peer = *other_peer;
797 for (opt = options; opt->type != 0; opt++)
798 {
799 switch (opt->type)
800 {
801 case GNUNET_SET_OPTION_BYZANTINE:
802 msg->byzantine = GNUNET_YES;
803 msg->byzantine_lower_bound = opt->v.num;
804 break;
805
806 case GNUNET_SET_OPTION_FORCE_FULL:
807 msg->force_full = GNUNET_YES;
808 break;
809
810 case GNUNET_SET_OPTION_FORCE_DELTA:
811 msg->force_delta = GNUNET_YES;
812 break;
813
814 default:
815 LOG (GNUNET_ERROR_TYPE_ERROR,
816 "Option with type %d not recognized\n", (int) opt->type);
817 }
818 }
819 oh->conclude_mqm = mqm;
820 oh->request_id_addr = &msg->request_id;
821
822 return oh;
823}
824
825
826/**
827 * Connect to the set service in order to listen for requests.
828 *
829 * @param cls the `struct GNUNET_SET_ListenHandle *` to connect
830 */
831static void
832listen_connect (void *cls);
833
834
835/**
836 * Check validity of request message for a listen operation
837 *
838 * @param cls the listen handle
839 * @param msg the message
840 * @return #GNUNET_OK if the message is well-formed
841 */
842static int
843check_request (void *cls,
844 const struct GNUNET_SET_RequestMessage *msg)
845{
846 const struct GNUNET_MessageHeader *context_msg;
847
848 if (ntohs (msg->header.size) == sizeof(*msg))
849 return GNUNET_OK; /* no context message is OK */
850 context_msg = GNUNET_MQ_extract_nested_mh (msg);
851 if (NULL == context_msg)
852 {
853 /* malformed context message is NOT ok */
854 GNUNET_break_op (0);
855 return GNUNET_SYSERR;
856 }
857 return GNUNET_OK;
858}
859
860
861/**
862 * Handle request message for a listen operation
863 *
864 * @param cls the listen handle
865 * @param msg the message
866 */
867static void
868handle_request (void *cls,
869 const struct GNUNET_SET_RequestMessage *msg)
870{
871 struct GNUNET_SET_ListenHandle *lh = cls;
872 struct GNUNET_SET_Request req;
873 const struct GNUNET_MessageHeader *context_msg;
874 struct GNUNET_MQ_Envelope *mqm;
875 struct GNUNET_SET_RejectMessage *rmsg;
876
877 LOG (GNUNET_ERROR_TYPE_DEBUG,
878 "Processing incoming operation request with id %u\n",
879 ntohl (msg->accept_id));
880 /* we got another valid request => reset the backoff */
881 lh->reconnect_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
882 req.accept_id = ntohl (msg->accept_id);
883 req.accepted = GNUNET_NO;
884 context_msg = GNUNET_MQ_extract_nested_mh (msg);
885 /* calling #GNUNET_SET_accept() in the listen cb will set req->accepted */
886 lh->listen_cb (lh->listen_cls,
887 &msg->peer_id,
888 context_msg,
889 &req);
890 if (GNUNET_YES == req.accepted)
891 return; /* the accept-case is handled in #GNUNET_SET_accept() */
892 LOG (GNUNET_ERROR_TYPE_DEBUG,
893 "Rejected request %u\n",
894 ntohl (msg->accept_id));
895 mqm = GNUNET_MQ_msg (rmsg,
896 GNUNET_MESSAGE_TYPE_SET_REJECT);
897 rmsg->accept_reject_id = msg->accept_id;
898 GNUNET_MQ_send (lh->mq, mqm);
899}
900
901
902/**
903 * Our connection with the set service encountered an error,
904 * re-initialize with exponential back-off.
905 *
906 * @param cls the `struct GNUNET_SET_ListenHandle *`
907 * @param error reason for the disconnect
908 */
909static void
910handle_client_listener_error (void *cls,
911 enum GNUNET_MQ_Error error)
912{
913 struct GNUNET_SET_ListenHandle *lh = cls;
914
915 LOG (GNUNET_ERROR_TYPE_DEBUG,
916 "Listener broke down (%d), re-connecting\n",
917 (int) error);
918 GNUNET_MQ_destroy (lh->mq);
919 lh->mq = NULL;
920 lh->reconnect_task = GNUNET_SCHEDULER_add_delayed (lh->reconnect_backoff,
921 &listen_connect,
922 lh);
923 lh->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (lh->reconnect_backoff);
924}
925
926
927/**
928 * Connect to the set service in order to listen for requests.
929 *
930 * @param cls the `struct GNUNET_SET_ListenHandle *` to connect
931 */
932static void
933listen_connect (void *cls)
934{
935 struct GNUNET_SET_ListenHandle *lh = cls;
936 struct GNUNET_MQ_MessageHandler mq_handlers[] = {
937 GNUNET_MQ_hd_var_size (request,
938 GNUNET_MESSAGE_TYPE_SET_REQUEST,
939 struct GNUNET_SET_RequestMessage,
940 lh),
941 GNUNET_MQ_handler_end ()
942 };
943 struct GNUNET_MQ_Envelope *mqm;
944 struct GNUNET_SET_ListenMessage *msg;
945
946 lh->reconnect_task = NULL;
947 GNUNET_assert (NULL == lh->mq);
948 lh->mq = GNUNET_CLIENT_connect (lh->cfg,
949 "set",
950 mq_handlers,
951 &handle_client_listener_error,
952 lh);
953 if (NULL == lh->mq)
954 return;
955 mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_LISTEN);
956 msg->operation = htonl (lh->operation);
957 msg->app_id = lh->app_id;
958 GNUNET_MQ_send (lh->mq,
959 mqm);
960}
961
962
963/**
964 * Wait for set operation requests for the given application id
965 *
966 * @param cfg configuration to use for connecting to
967 * the set service, needs to be valid for the lifetime of the listen handle
968 * @param operation operation we want to listen for
969 * @param app_id id of the application that handles set operation requests
970 * @param listen_cb called for each incoming request matching the operation
971 * and application id
972 * @param listen_cls handle for @a listen_cb
973 * @return a handle that can be used to cancel the listen operation
974 */
975struct GNUNET_SET_ListenHandle *
976GNUNET_SET_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
977 enum GNUNET_SET_OperationType operation,
978 const struct GNUNET_HashCode *app_id,
979 GNUNET_SET_ListenCallback listen_cb,
980 void *listen_cls)
981{
982 struct GNUNET_SET_ListenHandle *lh;
983
984 LOG (GNUNET_ERROR_TYPE_DEBUG,
985 "Starting listener for app %s\n",
986 GNUNET_h2s (app_id));
987 lh = GNUNET_new (struct GNUNET_SET_ListenHandle);
988 lh->listen_cb = listen_cb;
989 lh->listen_cls = listen_cls;
990 lh->cfg = cfg;
991 lh->operation = operation;
992 lh->app_id = *app_id;
993 lh->reconnect_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
994 listen_connect (lh);
995 if (NULL == lh->mq)
996 {
997 GNUNET_free (lh);
998 return NULL;
999 }
1000 return lh;
1001}
1002
1003
1004/**
1005 * Cancel the given listen operation.
1006 *
1007 * @param lh handle for the listen operation
1008 */
1009void
1010GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh)
1011{
1012 LOG (GNUNET_ERROR_TYPE_DEBUG,
1013 "Canceling listener %s\n",
1014 GNUNET_h2s (&lh->app_id));
1015 if (NULL != lh->mq)
1016 {
1017 GNUNET_MQ_destroy (lh->mq);
1018 lh->mq = NULL;
1019 }
1020 if (NULL != lh->reconnect_task)
1021 {
1022 GNUNET_SCHEDULER_cancel (lh->reconnect_task);
1023 lh->reconnect_task = NULL;
1024 }
1025 GNUNET_free (lh);
1026}
1027
1028
1029struct GNUNET_SET_OperationHandle *
1030GNUNET_SET_accept (struct GNUNET_SET_Request *request,
1031 enum GNUNET_SET_ResultMode result_mode,
1032 struct GNUNET_SET_Option options[],
1033 GNUNET_SET_ResultIterator result_cb,
1034 void *result_cls)
1035{
1036 struct GNUNET_MQ_Envelope *mqm;
1037 struct GNUNET_SET_OperationHandle *oh;
1038 struct GNUNET_SET_AcceptMessage *msg;
1039
1040 GNUNET_assert (GNUNET_NO == request->accepted);
1041 LOG (GNUNET_ERROR_TYPE_DEBUG,
1042 "Client accepts set operation (%d) with id %u\n",
1043 result_mode,
1044 request->accept_id);
1045 request->accepted = GNUNET_YES;
1046 mqm = GNUNET_MQ_msg (msg,
1047 GNUNET_MESSAGE_TYPE_SET_ACCEPT);
1048 msg->accept_reject_id = htonl (request->accept_id);
1049 msg->result_mode = htonl (result_mode);
1050 oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
1051 oh->result_cb = result_cb;
1052 oh->result_cls = result_cls;
1053 oh->conclude_mqm = mqm;
1054 oh->request_id_addr = &msg->request_id;
1055 return oh;
1056}
1057
1058
1059/**
1060 * Commit a set to be used with a set operation.
1061 * This function is called once we have fully constructed
1062 * the set that we want to use for the operation. At this
1063 * time, the P2P protocol can then begin to exchange the
1064 * set information and call the result callback with the
1065 * result information.
1066 *
1067 * @param oh handle to the set operation
1068 * @param set the set to use for the operation
1069 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
1070 * set is invalid (e.g. the set service crashed)
1071 */
1072int
1073GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
1074 struct GNUNET_SET_Handle *set)
1075{
1076 if (NULL != oh->set)
1077 {
1078 /* Some other set was already committed for this
1079 * operation, there is a logic bug in the client of this API */
1080 GNUNET_break (0);
1081 return GNUNET_OK;
1082 }
1083 GNUNET_assert (NULL != set);
1084 if (GNUNET_YES == set->invalid)
1085 return GNUNET_SYSERR;
1086 LOG (GNUNET_ERROR_TYPE_DEBUG,
1087 "Client commits to SET\n");
1088 GNUNET_assert (NULL != oh->conclude_mqm);
1089 oh->set = set;
1090 GNUNET_CONTAINER_DLL_insert (set->ops_head,
1091 set->ops_tail,
1092 oh);
1093 oh->request_id = GNUNET_MQ_assoc_add (set->mq,
1094 oh);
1095 *oh->request_id_addr = htonl (oh->request_id);
1096 GNUNET_MQ_send (set->mq,
1097 oh->conclude_mqm);
1098 oh->conclude_mqm = NULL;
1099 oh->request_id_addr = NULL;
1100 return GNUNET_OK;
1101}
1102
1103
1104/**
1105 * Iterate over all elements in the given set. Note that this
1106 * operation involves transferring every element of the set from the
1107 * service to the client, and is thus costly.
1108 *
1109 * @param set the set to iterate over
1110 * @param iter the iterator to call for each element
1111 * @param iter_cls closure for @a iter
1112 * @return #GNUNET_YES if the iteration started successfully,
1113 * #GNUNET_NO if another iteration is active
1114 * #GNUNET_SYSERR if the set is invalid (e.g. the server crashed, disconnected)
1115 */
1116int
1117GNUNET_SET_iterate (struct GNUNET_SET_Handle *set,
1118 GNUNET_SET_ElementIterator iter,
1119 void *iter_cls)
1120{
1121 struct GNUNET_MQ_Envelope *ev;
1122
1123 GNUNET_assert (NULL != iter);
1124 if (GNUNET_YES == set->invalid)
1125 return GNUNET_SYSERR;
1126 if (NULL != set->iterator)
1127 return GNUNET_NO;
1128 LOG (GNUNET_ERROR_TYPE_DEBUG,
1129 "Iterating over set\n");
1130 set->iterator = iter;
1131 set->iterator_cls = iter_cls;
1132 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST);
1133 GNUNET_MQ_send (set->mq, ev);
1134 return GNUNET_YES;
1135}
1136
1137
1138void
1139GNUNET_SET_copy_lazy (struct GNUNET_SET_Handle *set,
1140 GNUNET_SET_CopyReadyCallback cb,
1141 void *cls)
1142{
1143 struct GNUNET_MQ_Envelope *ev;
1144 struct SetCopyRequest *req;
1145
1146 LOG (GNUNET_ERROR_TYPE_DEBUG,
1147 "Creating lazy copy of set\n");
1148 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_COPY_LAZY_PREPARE);
1149 GNUNET_MQ_send (set->mq, ev);
1150
1151 req = GNUNET_new (struct SetCopyRequest);
1152 req->cb = cb;
1153 req->cls = cls;
1154 GNUNET_CONTAINER_DLL_insert (set->copy_req_head,
1155 set->copy_req_tail,
1156 req);
1157}
1158
1159
1160/**
1161 * Create a copy of an element. The copy
1162 * must be GNUNET_free-d by the caller.
1163 *
1164 * @param element the element to copy
1165 * @return the copied element
1166 */
1167struct GNUNET_SET_Element *
1168GNUNET_SET_element_dup (const struct GNUNET_SET_Element *element)
1169{
1170 struct GNUNET_SET_Element *copy;
1171
1172 copy = GNUNET_malloc (element->size + sizeof(struct GNUNET_SET_Element));
1173 copy->size = element->size;
1174 copy->element_type = element->element_type;
1175 copy->data = &copy[1];
1176 GNUNET_memcpy (&copy[1],
1177 element->data,
1178 copy->size);
1179 return copy;
1180}
1181
1182
1183void
1184GNUNET_SET_element_hash (const struct GNUNET_SET_Element *element,
1185 struct GNUNET_HashCode *ret_hash)
1186{
1187 struct GNUNET_HashContext *ctx = GNUNET_CRYPTO_hash_context_start ();
1188
1189 /* It's not guaranteed that the element data is always after the element header,
1190 so we need to hash the chunks separately. */
1191 GNUNET_CRYPTO_hash_context_read (ctx, &element->size, sizeof(uint16_t));
1192 GNUNET_CRYPTO_hash_context_read (ctx, &element->element_type,
1193 sizeof(uint16_t));
1194 GNUNET_CRYPTO_hash_context_read (ctx, element->data, element->size);
1195 GNUNET_CRYPTO_hash_context_finish (ctx, ret_hash);
1196}
1197
1198
1199/* end of set_api.c */