util: futurize contrib/scripts/terminate
[oweals/gnunet.git] / src / consensus / consensus-simulation.py.in
1 #!@PYTHON@
2 # This file is part of GNUnet
3 # (C) 2013, 2018 Christian Grothoff (and other contributing authors)
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 from __future__ import absolute_import
21 from __future__ import print_function
22 import argparse
23 import random
24 from math import ceil, log, floor
25 from past.builtins import xrange
26
27
28 def bsc(n):
29     """ count the bits set in n"""
30     l = n.bit_length()
31     c = 0
32     x = 1
33     for _ in range(0, l):
34         if n & x:
35             c = c + 1
36         x = x << 1
37     return c
38
39
40 def simulate(k, n, verbose):
41     assert k < n
42     largest_arc = int(2**ceil(log(n, 2))) / 2
43     num_ghosts = (2 * largest_arc) - n
44     if verbose:
45         print("we have", num_ghosts, "ghost peers")
46         # n.b. all peers with idx<k are evil
47     peers = range(n)
48     # py2-3 compatible, backwards.
49     # refer to http://python-future.org/compatible_idioms.html#xrange
50     info = [1 << x for x in xrange(n)]
51
52     def done_p():
53         for x in xrange(k, n):
54             if bsc(info[x]) < n-k:
55                 return False
56         return True
57     rounds = 0
58     while not done_p():
59         if verbose:
60             print("-- round --")
61         arc = 1
62         while arc <= largest_arc:
63             if verbose:
64                 print("-- subround --")
65             new_info = [x for x in info]
66             for peer_physical in xrange(n):
67                 peer_logical = peers[peer_physical]
68                 peer_type = None
69                 partner_logical = (peer_logical + arc) % n
70                 partner_physical = peers.index(partner_logical)
71                 if peer_physical < k or partner_physical < k:
72                     if verbose:
73                         print("bad peer in connection", peer_physical, "--", partner_physical)
74                     continue
75                 if peer_logical & arc == 0:
76                     # we are outgoing
77                     if verbose:
78                         print(peer_physical, "connects to", partner_physical)
79                     peer_type = "outgoing"
80                     if peer_logical < num_ghosts:
81                         # we have a ghost, check if the peer who connects
82                         # to our ghost is actually outgoing
83                         ghost_partner_logical = (peer_logical - arc) % n
84                         if ghost_partner_logical & arc == 0:
85                             peer_type = peer_type + ", ghost incoming"
86                     new_info[peer_physical] = new_info[peer_physical] | info[peer_physical] | info[partner_physical]
87                     new_info[partner_physical] = new_info[partner_physical] | info[peer_physical] | info[partner_physical]
88                 else:
89                     peer_type = "incoming"
90                 if verbose > 1:
91                     print("type of", str(peer_physical) + ":", peer_type)
92             info = new_info
93             arc = arc << 1
94         rounds = rounds + 1
95         random.shuffle(peers)
96     return rounds
97
98
99 if __name__ == "__main__":
100     parser = argparse.ArgumentParser()
101     parser.add_argument("k", metavar="k", type=int, help="#(bad peers)")
102     parser.add_argument("n", metavar="n", type=int, help="#(all peers)")
103     parser.add_argument("r", metavar="r", type=int, help="#(rounds)")
104     parser.add_argument('--verbose', '-v', action='count')
105
106     args = parser.parse_args()
107     sum = 0.0
108     for n in xrange(0, args.r):
109         sum += simulate(args.k, args.n, args.verbose)
110     print(sum / args.r)