2 This file is part of GNUnet
3 (C) 2008--2012 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file testbed/testbed_api_topology.c
23 * @brief topology-generation functions
24 * @author Christian Grothoff
27 #include "gnunet_testbed_service.h"
28 #include "testbed_api.h"
29 #include "testbed_api_peers.h"
30 #include "testbed_api_operations.h"
31 #include "testbed_api_topology.h"
34 * Generic loggins shorthand
36 #define LOG(kind,...) \
37 GNUNET_log_from (kind, "testbed-api-topology", __VA_ARGS__)
41 * Default number of retires
43 #define DEFAULT_RETRY_CNT 3
47 * Context information for topology operations
49 struct TopologyContext;
53 * Representation of an overlay link
59 * An operation corresponding to this link
61 struct GNUNET_TESTBED_Operation *op;
64 * The topology context this link is a part of
66 struct TopologyContext *tc;
69 * position of peer A's handle in peers array
74 * position of peer B's handle in peers array
84 * the next pointer for the DLL
86 struct RetryListEntry *next;
89 * the prev pointer for the DLL
91 struct RetryListEntry *prev;
94 * The link to be retired
96 struct OverlayLink *link;
101 * Context information for topology operations
103 struct TopologyContext
108 struct GNUNET_TESTBED_Peer **peers;
111 * An array of links; this array is of size link_array_size
113 struct OverlayLink *link_array;
116 * The operation closure
121 * topology generation completion callback
123 GNUNET_TESTBED_TopologyCompletionCallback comp_cb;
126 * The closure for the above callback
131 * DLL head for retry list
133 struct RetryListEntry *rl_head;
136 * DLL tail for retry list
138 struct RetryListEntry *rl_tail;
141 * The number of peers
143 unsigned int num_peers;
146 * The size of the link array
148 unsigned int link_array_size;
151 * How many retries to do before we give up
153 unsigned int retry_cnt;
156 * Number of links to try
161 * How many links have been completed
163 unsigned int ncompleted;
166 * Total successfully established overlay connections
168 unsigned int nsuccess;
171 * Total failed overlay connections
173 unsigned int nfailures;
178 * A array of names representing topologies. Should be in sync with enum
179 * GNUNET_TESTBED_TopologyOption
181 const char *topology_strings[] = {
184 * A clique (everyone connected to everyone else). No options. If there are N
185 * peers this topology results in (N * (N -1)) connections.
190 * Small-world network (2d torus plus random links). Followed
191 * by the number of random links to add (unsigned int).
196 * Small-world network (ring plus random links). Followed
197 * by the number of random links to add (unsigned int).
202 * Ring topology. No options.
207 * 2-d torus. No options.
212 * Random graph. Followed by the number of random links to be established
215 "RANDOM", // GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI
218 * Certain percentage of peers are unable to communicate directly
219 * replicating NAT conditions. Followed by the fraction of
220 * NAT'ed peers (float).
225 * Scale free topology. No options.
230 * Straight line topology. No options.
235 * Read a topology from a given file. Followed by the name of the file (const char *).
240 * All peers are disconnected. No options.
252 * Callback to be called when an overlay_link operation complete
254 * @param cls element of the link_op array which points to the corresponding operation
255 * @param op the operation that has been finished
256 * @param emsg error message in case the operation has failed; will be NULL if
257 * operation has executed successfully.
260 overlay_link_completed (void *cls, struct GNUNET_TESTBED_Operation *op,
263 struct OverlayLink *link = cls;
264 struct TopologyContext *tc;
265 struct RetryListEntry *retry_entry;
267 GNUNET_assert (op == link->op);
268 GNUNET_TESTBED_operation_done (op);
274 if (0 != tc->retry_cnt)
276 LOG (GNUNET_ERROR_TYPE_WARNING,
277 "Error while establishing a link: %s -- Retrying\n", emsg);
278 retry_entry = GNUNET_malloc (sizeof (struct RetryListEntry));
279 retry_entry->link = link;
280 GNUNET_CONTAINER_DLL_insert_tail (tc->rl_head, tc->rl_tail, retry_entry);
286 if (tc->ncompleted < tc->nlinks)
288 if ((0 != tc->retry_cnt) && (NULL != tc->rl_head))
293 while (NULL != (retry_entry = tc->rl_head))
295 link = retry_entry->link;
297 GNUNET_TESTBED_overlay_connect (tc->op_cls, &overlay_link_completed,
298 link, tc->peers[link->A],
301 GNUNET_CONTAINER_DLL_remove (tc->rl_head, tc->rl_tail, retry_entry);
302 GNUNET_free (retry_entry);
306 if (NULL != tc->comp_cb)
308 tc->comp_cb (tc->comp_cb_cls, tc->nsuccess, tc->nfailures);
315 * Function called when a overlay connect operation is ready
317 * @param cls the Topology context
320 opstart_overlay_configure_topology (void *cls)
322 struct TopologyContext *tc = cls;
325 tc->nlinks = tc->link_array_size;
326 for (p = 0; p < tc->link_array_size; p++)
328 tc->link_array[p].op =
329 GNUNET_TESTBED_overlay_connect (tc->op_cls, &overlay_link_completed,
331 tc->peers[tc->link_array[p].A],
332 tc->peers[tc->link_array[p].B]);
338 * Callback which will be called when overlay connect operation is released
340 * @param cls the Topology context
343 oprelease_overlay_configure_topology (void *cls)
345 struct TopologyContext *tc = cls;
346 struct RetryListEntry *retry_entry;
349 while (NULL != (retry_entry = tc->rl_head))
351 GNUNET_CONTAINER_DLL_remove (tc->rl_head, tc->rl_tail, retry_entry);
352 GNUNET_free (retry_entry);
354 if (NULL != tc->link_array)
356 for (p = 0; p < tc->link_array_size; p++)
357 if (NULL != tc->link_array[p].op)
358 GNUNET_TESTBED_operation_done (tc->link_array[p].op);
359 GNUNET_free (tc->link_array);
366 * Populates the OverlayLink structure.
368 * @param link the OverlayLink
369 * @param A the peer A. Should be different from B
370 * @param B the peer B. Should be different from A
371 * @param tc the TopologyContext
375 make_link (struct OverlayLink *link, uint32_t A, uint32_t B,
376 struct TopologyContext *tc)
378 GNUNET_assert (A != B);
379 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting peer %u to %u\n", B, A);
388 * Generates line topology
390 * @param tc the topology context
393 gen_topo_line (struct TopologyContext *tc)
397 tc->link_array_size = tc->num_peers - 1;
399 GNUNET_malloc (sizeof (struct OverlayLink) * tc->link_array_size);
400 for (cnt = 0; cnt < (tc->num_peers - 1); cnt++)
401 make_link (&tc->link_array[cnt], cnt, cnt + 1, tc);
406 * Generates ring topology
408 * @param tc the topology context
411 gen_topo_ring (struct TopologyContext *tc)
414 tc->link_array_size++;
416 GNUNET_realloc (tc->link_array,
417 sizeof (struct OverlayLink) * tc->link_array_size);
418 make_link (&tc->link_array[tc->link_array_size - 1], tc->num_peers - 1, 0,
424 * Returns the number of links that are required to generate a 2d torus for the
425 * given number of peers. Also returns the arrangment (number of rows and the
426 * length of each row)
428 * @param num_peers number of peers
429 * @param rows number of rows in the 2d torus. Can be NULL
430 * @param rows_len the length of each row. This array will be allocated
431 * fresh. The caller should free it. Can be NULL
434 GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
435 unsigned int **rows_len)
438 unsigned int sq_floor;
440 unsigned int *_rows_len;
443 unsigned int _num_peers;
446 sq = sqrt (num_peers);
448 sq_floor = (unsigned int) sq;
449 _rows = (sq_floor + 1);
450 _rows_len = GNUNET_malloc (sizeof (unsigned int) * _rows);
451 for (y = 0; y < _rows - 1; y++)
452 _rows_len[y] = sq_floor;
453 _num_peers = sq_floor * sq_floor;
454 cnt = 2 * _num_peers;
457 while (_num_peers < num_peers)
460 _rows_len[_rows - 1] = ++x;
465 cnt += (x < 2) ? x : 2 * x;
466 cnt += (y < 2) ? y : 2 * y;
467 if (0 == _rows_len[_rows - 1])
471 if (NULL != rows_len)
472 *rows_len = _rows_len;
474 GNUNET_free (_rows_len);
480 * Generates ring topology
482 * @param tc the topology context
485 gen_topo_2dtorus (struct TopologyContext *tc)
488 unsigned int *rows_len;
494 tc->link_array_size =
495 GNUNET_TESTBED_2dtorus_calc_links (tc->num_peers, &rows, &rows_len);
497 GNUNET_malloc (sizeof (struct OverlayLink) * tc->link_array_size);
500 for (y = 0; y < rows; y++)
502 for (x = 0; x < rows_len[y] - 1; x++)
504 make_link (&tc->link_array[cnt], offset + x, offset + x + 1, tc);
509 make_link (&tc->link_array[cnt], offset + x, offset, tc);
511 offset += rows_len[y];
513 for (x = 0; x < rows_len[0]; x++)
516 for (y = 0; y < rows - 1; y++)
518 if (x >= rows_len[y + 1])
520 GNUNET_assert (x < rows_len[y + 1]);
521 make_link (&tc->link_array[cnt], offset + x, offset + rows_len[y] + x,
523 offset += rows_len[y];
528 make_link (&tc->link_array[cnt], offset + x, x, tc);
531 GNUNET_assert (cnt == tc->link_array_size);
532 GNUNET_free (rows_len);
537 * Generates ring topology
539 * @param tc the topology context
540 * @param links the number of random links to establish
541 * @param append GNUNET_YES to add links to existing link array; GNUNET_NO to
542 * create a new link array
545 gen_topo_random (struct TopologyContext *tc, unsigned int links, int append)
552 if (GNUNET_YES == append)
554 GNUNET_assert ((0 < tc->link_array_size) && (NULL != tc->link_array));
555 index = tc->link_array_size;
556 tc->link_array_size += links;
558 GNUNET_realloc (tc->link_array,
559 sizeof (struct OverlayLink) * tc->link_array_size);
563 GNUNET_assert ((0 == tc->link_array_size) && (NULL == tc->link_array));
565 tc->link_array_size = links;
567 GNUNET_malloc (sizeof (struct OverlayLink) * tc->link_array_size);
569 for (cnt = 0; cnt < links; cnt++)
574 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, tc->num_peers);
576 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, tc->num_peers);
578 while (A_rand == B_rand);
579 make_link (&tc->link_array[index + cnt], A_rand, B_rand, tc);
585 * Generates scale free network. Its construction is described in:
587 * "Emergence of Scaling in Random Networks." Science 286, 509-512, 1999.
589 * @param tc the topology context
592 gen_scale_free (struct TopologyContext *tc)
597 unsigned int previous_connections;
599 uint16_t *popularity;
601 popularity = GNUNET_malloc (sizeof (uint16_t) * tc->num_peers);
602 /* Initially connect peer 1 to peer 0 */
603 tc->link_array_size = 1;
604 tc->link_array = GNUNET_malloc (sizeof (struct OverlayLink));
605 make_link (&tc->link_array[0], 0, 1, tc);
606 popularity[0]++; /* increase popularity of 0 as 1 connected to it */
607 for (cnt = 1; cnt < tc->num_peers; cnt++)
609 previous_connections = tc->link_array_size;
610 for (i = 0; i < cnt; i++)
612 probability = ((double) popularity[i]) / ((double) previous_connections);
615 GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
616 UINT64_MAX)) / ((double) UINT64_MAX);
617 if (random < probability)
619 tc->link_array_size++;
621 GNUNET_realloc (tc->link_array,
622 (sizeof (struct OverlayLink) *
623 tc->link_array_size));
624 make_link (&tc->link_array[tc->link_array_size - 1], cnt, i, tc);
629 GNUNET_free (popularity);
634 * Generates topology from the given file
636 * @param tc the topology context
637 * @param filename the filename of the file containing topology data
640 gen_topo_from_file (struct TopologyContext *tc, const char *filename)
647 unsigned long int peer_id;
648 unsigned long int other_peer_id;
653 * We read the peer index
658 * We read the other peer indices
665 status = GNUNET_SYSERR;
666 if (GNUNET_YES != GNUNET_DISK_file_test (filename))
668 LOG (GNUNET_ERROR_TYPE_ERROR, _("Topology file %s not found\n"), filename);
672 GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
674 LOG (GNUNET_ERROR_TYPE_ERROR, _("Topology file %s has no data\n"),
678 data = GNUNET_malloc (fs);
679 if (fs != GNUNET_DISK_fn_read (filename, data, fs))
681 LOG (GNUNET_ERROR_TYPE_ERROR, _("Topology file %s cannot be read\n"),
692 if (0 != isspace (data[offset]))
700 buf = strchr (&data[offset], ':');
703 LOG (GNUNET_ERROR_TYPE_ERROR,
704 _("Failed to read peer index from toology file: %s"), filename);
709 peer_id = (unsigned int) strtoul (&data[offset], &end, 10);
712 LOG (GNUNET_ERROR_TYPE_ERROR,
713 _("Value in given topology file: %s out of range\n"), filename);
716 if (&data[offset] == end)
718 LOG (GNUNET_ERROR_TYPE_ERROR,
719 _("Failed to read peer index from topology file: %s"), filename);
722 if (tc->num_peers <= peer_id)
724 LOG (GNUNET_ERROR_TYPE_ERROR,
725 _("Topology file needs more peers than given ones\n"), filename);
728 state = OTHER_PEER_INDEX;
729 offset += ((unsigned int) (buf - &data[offset])) + 1;
731 case OTHER_PEER_INDEX:
733 other_peer_id = (unsigned int) strtoul (&data[offset], &end, 10);
736 LOG (GNUNET_ERROR_TYPE_ERROR,
737 _("Value in given topology file: %s out of range\n"), filename);
740 if (&data[offset] == end)
742 LOG (GNUNET_ERROR_TYPE_ERROR,
743 _("Failed to read peer index from topology file: %s"), filename);
746 if (tc->num_peers <= other_peer_id)
748 LOG (GNUNET_ERROR_TYPE_ERROR,
749 _("Topology file needs more peers than given ones\n"), filename);
752 if (peer_id != other_peer_id)
754 tc->link_array_size++;
756 GNUNET_realloc (tc->link_array,
757 sizeof (struct OverlayLink) * tc->link_array_size);
758 offset += end - &data[offset];
759 make_link (&tc->link_array[tc->link_array_size - 1], peer_id,
763 LOG (GNUNET_ERROR_TYPE_WARNING,
764 _("Ignoring to connect peer %u to peer %u\n"), peer_id,
766 while (('\n' != data[offset]) && ('|' != data[offset]) && (offset < fs))
768 if ('\n' == data[offset])
770 else if ('|' == data[offset])
772 state = OTHER_PEER_INDEX;
782 if (GNUNET_OK != status)
784 LOG (GNUNET_ERROR_TYPE_WARNING, "Removing link data read from the file\n");
785 tc->link_array_size = 0;
786 GNUNET_free_non_null (tc->link_array);
787 tc->link_array = NULL;
793 * Configure overall network topology to have a particular shape.
795 * @param op_cls closure argument to give with the operation event
796 * @param num_peers number of peers in 'peers'
797 * @param peers array of 'num_peers' with the peers to configure
798 * @param topo desired underlay topology to use
799 * @param ap topology-specific options
800 * @return handle to the operation, NULL if configuring the topology
801 * is not allowed at this time
803 struct GNUNET_TESTBED_Operation *
804 GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
805 unsigned int num_peers,
806 struct GNUNET_TESTBED_Peer
809 GNUNET_TESTBED_TopologyOption
818 * Configure overall network topology to have a particular shape.
820 * @param op_cls closure argument to give with the operation event
821 * @param num_peers number of peers in 'peers'
822 * @param peers array of 'num_peers' with the peers to configure
823 * @param topo desired underlay topology to use
824 * @param ... topology-specific options
825 * @return handle to the operation, NULL if configuring the topology
826 * is not allowed at this time
828 struct GNUNET_TESTBED_Operation *
829 GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
830 unsigned int num_peers,
831 struct GNUNET_TESTBED_Peer **peers,
832 enum GNUNET_TESTBED_TopologyOption
841 * All peers must have been started before calling this function.
842 * This function then connects the given peers in the P2P overlay
843 * using the given topology.
845 * @param op_cls closure argument to give with the peer connect operation events
846 * generated through this function
847 * @param num_peers number of peers in 'peers'
848 * @param peers array of 'num_peers' with the peers to configure
849 * @param max_connections the maximums number of overlay connections that will
850 * be made to achieve the given topology
851 * @param comp_cb the completion callback to call when the topology generation
853 * @param comp_cb_cls closure for the above completion callback
854 * @param topo desired underlay topology to use
855 * @param va topology-specific options
856 * @return handle to the operation, NULL if connecting these
857 * peers is fundamentally not possible at this time (peers
858 * not running or underlay disallows) or if num_peers is less than 2
860 struct GNUNET_TESTBED_Operation *
861 GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
862 unsigned int num_peers,
863 struct GNUNET_TESTBED_Peer **peers,
864 unsigned int *max_connections,
865 GNUNET_TESTBED_TopologyCompletionCallback
868 enum GNUNET_TESTBED_TopologyOption topo,
871 struct TopologyContext *tc;
872 struct GNUNET_TESTBED_Operation *op;
873 struct GNUNET_TESTBED_Controller *c;
874 enum GNUNET_TESTBED_TopologyOption secondary_option;
879 c = peers[0]->controller;
880 tc = GNUNET_malloc (sizeof (struct TopologyContext));
882 tc->num_peers = num_peers;
884 tc->retry_cnt = DEFAULT_RETRY_CNT;
885 tc->comp_cb = comp_cb;
886 tc->comp_cb_cls = comp_cb_cls;
889 case GNUNET_TESTBED_TOPOLOGY_LINE:
892 case GNUNET_TESTBED_TOPOLOGY_RING:
895 case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
896 gen_topo_random (tc, va_arg (va, unsigned int), GNUNET_NO);
898 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
900 gen_topo_random (tc, va_arg (va, unsigned int), GNUNET_YES);
902 case GNUNET_TESTBED_TOPOLOGY_CLIQUE:
903 tc->link_array_size = num_peers * (num_peers - 1);
905 GNUNET_malloc (sizeof (struct OverlayLink) * tc->link_array_size);
910 for (cnt = 0; cnt < num_peers; cnt++)
912 unsigned int neighbour;
914 for (neighbour = 0; neighbour < num_peers; neighbour++)
916 if (neighbour == cnt)
918 tc->link_array[offset].A = cnt;
919 tc->link_array[offset].B = neighbour;
920 tc->link_array[offset].tc = tc;
926 case GNUNET_TESTBED_TOPOLOGY_2D_TORUS:
927 gen_topo_2dtorus (tc);
929 case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
930 gen_topo_2dtorus (tc);
931 gen_topo_random (tc, va_arg (va, unsigned int), GNUNET_YES);
934 case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
937 case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
939 const char *filename;
941 filename = va_arg (va, const char *);
943 GNUNET_assert (NULL != filename);
944 gen_topo_from_file (tc, filename);
954 secondary_option = va_arg (va, enum GNUNET_TESTBED_TopologyOption);
956 switch (secondary_option)
958 case GNUNET_TESTBED_TOPOLOGY_RETRY_CNT:
959 tc->retry_cnt = va_arg (va, unsigned int);
961 case GNUNET_TESTBED_TOPOLOGY_OPTION_END:
964 GNUNET_break (0); /* Should not use any other option apart from
965 * the ones handled here */
966 GNUNET_free_non_null (tc->link_array);
971 while (GNUNET_TESTBED_TOPOLOGY_OPTION_END != secondary_option);
972 op = GNUNET_TESTBED_operation_create_ (tc,
973 &opstart_overlay_configure_topology,
974 &oprelease_overlay_configure_topology);
975 GNUNET_TESTBED_operation_queue_insert_
976 (c->opq_parallel_topology_config_operations, op);
977 GNUNET_TESTBED_operation_begin_wait_ (op);
978 LOG (GNUNET_ERROR_TYPE_DEBUG, "Generated %u connections\n",
979 tc->link_array_size);
980 if (NULL != max_connections)
981 *max_connections = tc->link_array_size;
987 * All peers must have been started before calling this function.
988 * This function then connects the given peers in the P2P overlay
989 * using the given topology.
991 * @param op_cls closure argument to give with the peer connect operation events
992 * generated through this function
993 * @param num_peers number of peers in 'peers'
994 * @param peers array of 'num_peers' with the peers to configure
995 * @param max_connections the maximums number of overlay connections that will
996 * be made to achieve the given topology
997 * @param comp_cb the completion callback to call when the topology generation
999 * @param comp_cb_cls closure for the above completion callback
1000 * @param topo desired underlay topology to use
1001 * @param ... topology-specific options
1002 * @return handle to the operation, NULL if connecting these
1003 * peers is fundamentally not possible at this time (peers
1004 * not running or underlay disallows) or if num_peers is less than 2
1006 struct GNUNET_TESTBED_Operation *
1007 GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
1008 unsigned int num_peers,
1009 struct GNUNET_TESTBED_Peer **peers,
1010 unsigned int *max_connections,
1011 GNUNET_TESTBED_TopologyCompletionCallback
1014 enum GNUNET_TESTBED_TopologyOption topo,
1017 struct GNUNET_TESTBED_Operation *op;
1020 GNUNET_assert (topo < GNUNET_TESTBED_TOPOLOGY_OPTION_END);
1021 va_start (vargs, topo);
1022 op = GNUNET_TESTBED_overlay_configure_topology_va (op_cls, num_peers, peers,
1024 comp_cb, comp_cb_cls,
1033 * Get a topology from a string input.
1035 * @param topology where to write the retrieved topology
1036 * @param topology_string The string to attempt to
1037 * get a configuration value from
1038 * @return GNUNET_YES if topology string matched a
1039 * known topology, GNUNET_NO if not
1042 GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
1043 const char *topology_string)
1047 for (cnt = 0; NULL != topology_strings[cnt]; cnt++)
1049 if (0 == strcasecmp (topology_string, topology_strings[cnt]))
1051 if (NULL != topology)
1052 *topology = (enum GNUNET_TESTBED_TopologyOption) cnt;
1061 * Returns the string corresponding to the given topology
1063 * @param topology the topology
1064 * @return the string (freshly allocated) of given topology; NULL if topology cannot be
1065 * expressed as a string
1068 GNUNET_TESTBED_topology_to_str_ (enum GNUNET_TESTBED_TopologyOption topology)
1070 if (GNUNET_TESTBED_TOPOLOGY_OPTION_END <= topology)
1072 return GNUNET_strdup (topology_strings[topology]);
1075 /* end of testbed_api_topology.c */