2 This file is part of GNUnet.
3 Copyright (C) 2008--2013 GNUnet e.V.
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.
22 * @file testbed/gnunet-service-testbed_barriers.c
23 * @brief barrier handling at the testbed controller
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
27 #include "gnunet-service-testbed.h"
28 #include "gnunet-service-testbed_barriers.h"
29 #include "testbed_api.h"
33 * timeout for outgoing message transmissions in seconds
35 #define MESSAGE_SEND_TIMEOUT(s) \
36 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, s)
40 * Test to see if local peers have reached the required quorum of a barrier
42 #define LOCAL_QUORUM_REACHED(barrier) \
43 ((barrier->quorum * GST_num_local_peers) <= (barrier->nreached * 100))
53 #define LOG(kind,...) \
54 GNUNET_log_from (kind, "testbed-barriers", __VA_ARGS__)
64 * Context to be associated with each client
69 * The barrier this client is waiting for
71 struct Barrier *barrier;
76 struct ClientCtx *next;
81 struct ClientCtx *prev;
86 struct GNUNET_SERVICE_Client *client;
92 * Wrapper around Barrier handle
99 struct WBarrier *next;
104 struct WBarrier *prev;
107 * The local barrier associated with the creation of this wrapper
109 struct Barrier *barrier;
112 * The barrier handle from API
114 struct GNUNET_TESTBED_Barrier *hbarrier;
117 * Has this barrier been crossed?
129 * The hashcode of the barrier name
131 struct GNUNET_HashCode hash;
134 * The client handle to the master controller
136 struct GNUNET_SERVICE_Client *mc;
139 * The name of the barrier
144 * DLL head for the list of clients waiting for this barrier
146 struct ClientCtx *head;
149 * DLL tail for the list of clients waiting for this barrier
151 struct ClientCtx *tail;
154 * DLL head for the list of barrier handles
156 struct WBarrier *whead;
159 * DLL tail for the list of barrier handles
161 struct WBarrier *wtail;
164 * Identifier for the timeout task
166 struct GNUNET_SCHEDULER_Task *tout_task;
169 * The status of this barrier
171 enum GNUNET_TESTBED_BarrierStatus status;
174 * Number of barriers wrapped in the above DLL
176 unsigned int num_wbarriers;
179 * Number of wrapped barriers reached so far
181 unsigned int num_wbarriers_reached;
184 * Number of wrapped barrier initialised so far
186 unsigned int num_wbarriers_inited;
189 * Number of peers which have reached this barrier
191 unsigned int nreached;
194 * Number of slaves we have initialised this barrier
196 unsigned int nslaves;
199 * Quorum percentage to be reached
207 * Hashtable handle for storing initialised barriers
209 static struct GNUNET_CONTAINER_MultiHashMap *barrier_map;
214 static struct GNUNET_SERVICE_Handle *ctx;
218 * Function to remove a barrier from the barrier map and cleanup resources
219 * occupied by a barrier
221 * @param barrier the barrier handle
224 remove_barrier (struct Barrier *barrier)
226 struct ClientCtx *ctx;
228 GNUNET_assert (GNUNET_YES ==
229 GNUNET_CONTAINER_multihashmap_remove (barrier_map,
232 while (NULL != (ctx = barrier->head))
234 GNUNET_CONTAINER_DLL_remove (barrier->head,
239 GNUNET_free (barrier->name);
240 GNUNET_free (barrier);
245 * Cancels all subcontroller barrier handles
247 * @param barrier the local barrier
250 cancel_wrappers (struct Barrier *barrier)
252 struct WBarrier *wrapper;
254 while (NULL != (wrapper = barrier->whead))
256 GNUNET_TESTBED_barrier_cancel (wrapper->hbarrier);
257 GNUNET_CONTAINER_DLL_remove (barrier->whead,
260 GNUNET_free (wrapper);
266 * Send a status message about a barrier to the given client
268 * @param client the client to send the message to
269 * @param name the barrier name
270 * @param status the status of the barrier
271 * @param emsg the error message; should be non-NULL for
272 * status=GNUNET_TESTBED_BARRIERSTATUS_ERROR
275 send_client_status_msg (struct GNUNET_SERVICE_Client *client,
277 enum GNUNET_TESTBED_BarrierStatus status,
280 struct GNUNET_MQ_Envelope *env;
281 struct GNUNET_TESTBED_BarrierStatusMsg *msg;
285 GNUNET_assert ( (NULL == emsg) ||
286 (GNUNET_TESTBED_BARRIERSTATUS_ERROR == status) );
287 name_len = strlen (name) + 1;
288 err_len = ((NULL == emsg) ? 0 : (strlen (emsg) + 1));
289 env = GNUNET_MQ_msg_extra (msg,
291 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS);
292 msg->status = htons (status);
293 msg->name_len = htons ((uint16_t) name_len - 1);
294 GNUNET_memcpy (msg->data,
297 GNUNET_memcpy (msg->data + name_len,
300 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
306 * Sends a barrier failed message
308 * @param barrier the corresponding barrier
309 * @param emsg the error message; should be non-NULL for
310 * status=GNUNET_TESTBED_BARRIERSTATUS_ERROR
313 send_barrier_status_msg (struct Barrier *barrier,
316 GNUNET_assert (0 != barrier->status);
317 send_client_status_msg (barrier->mc,
325 * Check #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT messages.
327 * @param cls identification of the client
328 * @param message the actual message
331 check_barrier_wait (void *cls,
332 const struct GNUNET_TESTBED_BarrierWait *msg)
334 return GNUNET_OK; /* always well-formed */
339 * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT messages. This
340 * message should come from peers or a shared helper service using the
341 * testbed-barrier client API (@see gnunet_testbed_barrier_service.h)
343 * This handler is queued in the main service and will handle the messages sent
344 * either from the testbed driver or from a high level controller
346 * @param cls identification of the client
347 * @param message the actual message
350 handle_barrier_wait (void *cls,
351 const struct GNUNET_TESTBED_BarrierWait *msg)
353 struct ClientCtx *client_ctx = cls;
354 struct Barrier *barrier;
356 struct GNUNET_HashCode key;
360 msize = ntohs (msg->header.size);
361 if (NULL == barrier_map)
364 GNUNET_SERVICE_client_drop (client_ctx->client);
367 name_len = msize - sizeof (struct GNUNET_TESTBED_BarrierWait);
368 name = GNUNET_malloc (name_len + 1);
369 name[name_len] = '\0';
373 LOG_DEBUG ("Received BARRIER_WAIT for barrier `%s'\n",
375 GNUNET_CRYPTO_hash (name,
379 if (NULL == (barrier = GNUNET_CONTAINER_multihashmap_get (barrier_map, &key)))
382 GNUNET_SERVICE_client_drop (client_ctx->client);
385 if (NULL != client_ctx->barrier)
388 GNUNET_SERVICE_client_drop (client_ctx->client);
391 client_ctx->barrier = barrier;
392 GNUNET_CONTAINER_DLL_insert_tail (barrier->head,
396 if ( (barrier->num_wbarriers_reached == barrier->num_wbarriers) &&
397 (LOCAL_QUORUM_REACHED (barrier)) )
399 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_CROSSED;
400 send_barrier_status_msg (barrier,
403 GNUNET_SERVICE_client_continue (client_ctx->client);
408 * Function called when a client connects to the testbed-barrier service.
411 * @param client the connecting client
412 * @param mq queue to talk to @a client
413 * @return our `struct ClientCtx`
416 connect_cb (void *cls,
417 struct GNUNET_SERVICE_Client *client,
418 struct GNUNET_MQ_Handle *mq)
420 struct ClientCtx *client_ctx;
422 LOG_DEBUG ("Client connected to testbed-barrier service\n");
423 client_ctx = GNUNET_new (struct ClientCtx);
424 client_ctx->client = client;
430 * Functions with this signature are called whenever a client
431 * is disconnected on the network level.
434 * @param client identification of the client; NULL
435 * for the last call when the server is destroyed
438 disconnect_cb (void *cls,
439 struct GNUNET_SERVICE_Client *client,
442 struct ClientCtx *client_ctx = app_ctx;
443 struct Barrier *barrier = client_ctx->barrier;
447 GNUNET_CONTAINER_DLL_remove (barrier->head,
450 client_ctx->barrier = NULL;
452 GNUNET_free (client_ctx);
453 LOG_DEBUG ("Client disconnected from testbed-barrier service\n");
458 * Function to initialise barrriers component
460 * @param cfg the configuration to use for initialisation
463 GST_barriers_init (struct GNUNET_CONFIGURATION_Handle *cfg)
465 struct GNUNET_MQ_MessageHandler message_handlers[] = {
466 GNUNET_MQ_hd_var_size (barrier_wait,
467 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT,
468 struct GNUNET_TESTBED_BarrierWait,
470 GNUNET_MQ_handler_end ()
473 LOG_DEBUG ("Launching testbed-barrier service\n");
474 barrier_map = GNUNET_CONTAINER_multihashmap_create (3,
476 ctx = GNUNET_SERVICE_starT ("testbed-barrier",
486 * Iterator over hash map entries.
489 * @param key current key code
490 * @param value value in the hash map
491 * @return #GNUNET_YES if we should continue to
496 barrier_destroy_iterator (void *cls,
497 const struct GNUNET_HashCode *key,
500 struct Barrier *barrier = value;
502 GNUNET_assert (NULL != barrier);
503 cancel_wrappers (barrier);
504 remove_barrier (barrier);
510 * Function to stop the barrier service
513 GST_barriers_destroy ()
515 GNUNET_assert (NULL != barrier_map);
516 GNUNET_assert (GNUNET_SYSERR !=
517 GNUNET_CONTAINER_multihashmap_iterate (barrier_map,
518 &barrier_destroy_iterator,
520 GNUNET_CONTAINER_multihashmap_destroy (barrier_map);
521 GNUNET_assert (NULL != ctx);
522 GNUNET_SERVICE_stoP (ctx);
527 * Functions of this type are to be given as callback argument to
528 * GNUNET_TESTBED_barrier_init(). The callback will be called when status
529 * information is available for the barrier.
531 * @param cls the closure given to GNUNET_TESTBED_barrier_init()
532 * @param name the name of the barrier
533 * @param b_ the barrier handle
534 * @param status status of the barrier; #GNUNET_OK if the barrier is crossed;
535 * #GNUNET_SYSERR upon error
536 * @param emsg if the status were to be #GNUNET_SYSERR, this parameter has the
540 wbarrier_status_cb (void *cls,
542 struct GNUNET_TESTBED_Barrier *b_,
543 enum GNUNET_TESTBED_BarrierStatus status,
546 struct WBarrier *wrapper = cls;
547 struct Barrier *barrier = wrapper->barrier;
549 GNUNET_assert (b_ == wrapper->hbarrier);
550 wrapper->hbarrier = NULL;
551 GNUNET_CONTAINER_DLL_remove (barrier->whead,
554 GNUNET_free (wrapper);
557 case GNUNET_TESTBED_BARRIERSTATUS_ERROR:
558 LOG (GNUNET_ERROR_TYPE_ERROR,
559 "Initialising barrier `%s' failed at a sub-controller: %s\n",
561 (NULL != emsg) ? emsg : "NULL");
562 cancel_wrappers (barrier);
564 emsg = "Initialisation failed at a sub-controller";
565 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_ERROR;
566 send_barrier_status_msg (barrier, emsg);
568 case GNUNET_TESTBED_BARRIERSTATUS_CROSSED:
569 if (GNUNET_TESTBED_BARRIERSTATUS_INITIALISED != barrier->status)
574 barrier->num_wbarriers_reached++;
575 if ((barrier->num_wbarriers_reached == barrier->num_wbarriers)
576 && (LOCAL_QUORUM_REACHED (barrier)))
578 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_CROSSED;
579 send_barrier_status_msg (barrier, NULL);
582 case GNUNET_TESTBED_BARRIERSTATUS_INITIALISED:
583 if (0 != barrier->status)
588 barrier->num_wbarriers_inited++;
589 if (barrier->num_wbarriers_inited == barrier->num_wbarriers)
591 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_INITIALISED;
592 send_barrier_status_msg (barrier, NULL);
600 * Function called upon timeout while waiting for a response from the
601 * subcontrollers to barrier init message
606 fwd_tout_barrier_init (void *cls)
608 struct Barrier *barrier = cls;
610 cancel_wrappers (barrier);
611 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_ERROR;
612 send_barrier_status_msg (barrier,
613 "Timedout while propagating barrier initialisation\n");
614 remove_barrier (barrier);
620 * Check #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_INIT messages.
622 * @param cls identification of the client
623 * @param msg the actual message
624 * @return #GNUNET_OK if @a msg is well-formed
627 check_barrier_init (void *cls,
628 const struct GNUNET_TESTBED_BarrierInit *msg)
630 return GNUNET_OK; /* always well-formed */
635 * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_INIT messages. This
636 * message should always come from a parent controller or the testbed API if we
637 * are the root controller.
639 * This handler is queued in the main service and will handle the messages sent
640 * either from the testbed driver or from a high level controller
642 * @param cls identification of the client
643 * @param msg the actual message
646 handle_barrier_init (void *cls,
647 const struct GNUNET_TESTBED_BarrierInit *msg)
649 struct GNUNET_SERVICE_Client *client = cls;
651 struct Barrier *barrier;
653 struct WBarrier *wrapper;
654 struct GNUNET_HashCode hash;
659 if (NULL == GST_context)
662 GNUNET_SERVICE_client_drop (client);
665 if (client != GST_context->client)
668 GNUNET_SERVICE_client_drop (client);
671 msize = ntohs (msg->header.size);
672 name_len = (size_t) msize - sizeof (struct GNUNET_TESTBED_BarrierInit);
673 name = GNUNET_malloc (name_len + 1);
674 GNUNET_memcpy (name, msg->name, name_len);
675 GNUNET_CRYPTO_hash (name, name_len, &hash);
676 LOG_DEBUG ("Received BARRIER_INIT for barrier `%s'\n",
679 GNUNET_CONTAINER_multihashmap_contains (barrier_map,
682 send_client_status_msg (client,
684 GNUNET_TESTBED_BARRIERSTATUS_ERROR,
685 "A barrier with the same name already exists");
687 GNUNET_SERVICE_client_continue (client);
690 barrier = GNUNET_new (struct Barrier);
691 barrier->hash = hash;
692 barrier->quorum = msg->quorum;
693 barrier->name = name;
694 barrier->mc = client;
695 GNUNET_assert (GNUNET_OK ==
696 GNUNET_CONTAINER_multihashmap_put (barrier_map,
699 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
700 GNUNET_SERVICE_client_continue (client);
701 /* Propagate barrier init to subcontrollers */
702 for (cnt = 0; cnt < GST_slave_list_size; cnt++)
704 if (NULL == (slave = GST_slave_list[cnt]))
706 if (NULL == slave->controller)
708 GNUNET_break (0);/* May happen when we are connecting to the controller */
711 wrapper = GNUNET_new (struct WBarrier);
712 wrapper->barrier = barrier;
713 GNUNET_CONTAINER_DLL_insert_tail (barrier->whead,
716 wrapper->hbarrier = GNUNET_TESTBED_barrier_init_ (slave->controller,
723 if (NULL == barrier->whead) /* No further propagation */
725 barrier->status = GNUNET_TESTBED_BARRIERSTATUS_INITIALISED;
726 LOG_DEBUG ("Sending GNUNET_TESTBED_BARRIERSTATUS_INITIALISED for barrier `%s'\n",
728 send_barrier_status_msg (barrier, NULL);
730 barrier->tout_task = GNUNET_SCHEDULER_add_delayed (MESSAGE_SEND_TIMEOUT (30),
731 &fwd_tout_barrier_init,
737 * Check #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_CANCEL messages.
739 * @param cls identification of the client
740 * @param msg the actual message
741 * @return #GNUNET_OK if @a msg is well-formed
744 check_barrier_cancel (void *cls,
745 const struct GNUNET_TESTBED_BarrierCancel *msg)
747 return GNUNET_OK; /* all are well-formed */
752 * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_CANCEL messages. This
753 * message should always come from a parent controller or the testbed API if we
754 * are the root controller.
756 * This handler is queued in the main service and will handle the messages sent
757 * either from the testbed driver or from a high level controller
759 * @param cls identification of the client
760 * @param msg the actual message
763 handle_barrier_cancel (void *cls,
764 const struct GNUNET_TESTBED_BarrierCancel *msg)
766 struct GNUNET_SERVICE_Client *client = cls;
768 struct Barrier *barrier;
769 struct GNUNET_HashCode hash;
773 if (NULL == GST_context)
776 GNUNET_SERVICE_client_drop (client);
779 if (client != GST_context->client)
782 GNUNET_SERVICE_client_drop (client);
785 msize = ntohs (msg->header.size);
786 name_len = msize - sizeof (struct GNUNET_TESTBED_BarrierCancel);
787 name = GNUNET_malloc (name_len + 1);
791 LOG_DEBUG ("Received BARRIER_CANCEL for barrier `%s'\n",
793 GNUNET_CRYPTO_hash (name,
797 GNUNET_CONTAINER_multihashmap_contains (barrier_map,
801 GNUNET_SERVICE_client_drop (client);
804 barrier = GNUNET_CONTAINER_multihashmap_get (barrier_map,
806 GNUNET_assert (NULL != barrier);
807 cancel_wrappers (barrier);
808 remove_barrier (barrier);
809 GNUNET_SERVICE_client_continue (client);
814 * Check #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS messages.
816 * @param cls identification of the client
817 * @param msg the actual message
818 * @return #GNUNET_OK if @a msg is well-formed
821 check_barrier_status (void *cls,
822 const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
827 enum GNUNET_TESTBED_BarrierStatus status;
829 msize = ntohs (msg->header.size) - sizeof (*msg);
830 status = ntohs (msg->status);
831 if (GNUNET_TESTBED_BARRIERSTATUS_CROSSED != status)
833 GNUNET_break_op (0); /* current we only expect BARRIER_CROSSED
834 status message this way */
835 return GNUNET_SYSERR;
838 name_len = ntohs (msg->name_len);
839 if ((name_len + 1) != msize)
842 return GNUNET_SYSERR;
844 if ('\0' != name[name_len])
847 return GNUNET_SYSERR;
854 * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS messages.
855 * This handler is queued in the main service and will handle the messages sent
856 * either from the testbed driver or from a high level controller
858 * @param cls identification of the client
859 * @param msg the actual message
862 handle_barrier_status (void *cls,
863 const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
865 struct GNUNET_SERVICE_Client *client = cls;
866 struct Barrier *barrier;
867 struct ClientCtx *client_ctx;
869 struct GNUNET_HashCode key;
871 struct GNUNET_MQ_Envelope *env;
873 if (NULL == GST_context)
876 GNUNET_SERVICE_client_drop (client);
879 if (client != GST_context->client)
882 GNUNET_SERVICE_client_drop (client);
886 name_len = ntohs (msg->name_len);
887 LOG_DEBUG ("Received BARRIER_STATUS for barrier `%s'\n",
889 GNUNET_CRYPTO_hash (name,
892 barrier = GNUNET_CONTAINER_multihashmap_get (barrier_map,
897 GNUNET_SERVICE_client_drop (client);
900 GNUNET_SERVICE_client_continue (client);
901 while (NULL != (client_ctx = barrier->head)) /* Notify peers */
903 env = GNUNET_MQ_msg_copy (&msg->header);
904 GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
906 GNUNET_CONTAINER_DLL_remove (barrier->head,
909 client_ctx->barrier = NULL;
913 /* end of gnunet-service-testbed_barriers.c */