apt_dht_Khashmir/DHT.py

   1
   2 import os, sha, random
   3
   4 from twisted.internet import defer, reactor
   5 from twisted.internet.abstract import isIPAddress
   6 from twisted.trial import unittest
   7 from zope.interface import implements
   8
   9 from apt_dht.interfaces import IDHT
  10 from khashmir import Khashmir
  11
  12 class DHTError(Exception):
  13     """Represents errors that occur in the DHT."""
  14
  15 class DHT:
  16
  17     implements(IDHT)
  18
  19     def __init__(self):
  20         self.config = None
  21         self.cache_dir = ''
  22         self.bootstrap = []
  23         self.bootstrap_node = False
  24         self.joining = None
  25         self.joined = False
  26         self.storing = {}
  27         self.retrieving = {}
  28         self.retrieved = {}
  29
  30     def loadConfig(self, config, section):
  31         """See L{apt_dht.interfaces.IDHT}."""
  32         self.config_parser = config
  33         self.section = section
  34         self.config = {}
  35         self.cache_dir = self.config_parser.get('DEFAULT', 'cache_dir')
  36         self.bootstrap = self.config_parser.getstringlist(section, 'BOOTSTRAP')
  37         self.bootstrap_node = self.config_parser.getboolean(section, 'BOOTSTRAP_NODE')
  38         for k in self.config_parser.options(section):
  39             if k in ['K', 'HASH_LENGTH', 'CONCURRENT_REQS', 'STORE_REDUNDANCY',
  40                      'MAX_FAILURES', 'PORT']:
  41                 self.config[k] = self.config_parser.getint(section, k)
  42             elif k in ['CHECKPOINT_INTERVAL', 'MIN_PING_INTERVAL',
  43                        'BUCKET_STALENESS', 'KEINITIAL_DELAY', 'KE_DELAY', 'KE_AGE']:
  44                 self.config[k] = self.config_parser.gettime(section, k)
  45             else:
  46                 self.config[k] = self.config_parser.get(section, k)
  47         if 'PORT' not in self.config:
  48             self.config['PORT'] = self.config_parser.getint('DEFAULT', 'PORT')
  49
  50     def join(self):
  51         """See L{apt_dht.interfaces.IDHT}."""
  52         if self.config is None:
  53             raise DHTError, "configuration not loaded"
  54         if self.joining:
  55             raise DHTError, "a join is already in progress"
  56
  57         self.khashmir = Khashmir(self.config, self.cache_dir)
  58
  59         self.joining = defer.Deferred()
  60         for node in self.bootstrap:
  61             host, port = node.rsplit(':', 1)
  62             port = int(port)
  63             if isIPAddress(host):
  64                 self._join_gotIP(host, port)
  65             else:
  66                 reactor.resolve(host).addCallback(self._join_gotIP, port)
  67
  68         return self.joining
  69
  70     def _join_gotIP(self, ip, port):
  71         """Called after an IP address has been found for a single bootstrap node."""
  72         self.khashmir.addContact(ip, port, self._join_single)
  73
  74     def _join_single(self):
  75         """Called when a single bootstrap node has been added."""
  76         self.khashmir.findCloseNodes(self._join_complete)
  77
  78     def _join_complete(self, result):
  79         """Called when the tables have been initialized with nodes."""
  80         if not self.joined:
  81             self.joined = True
  82             if len(result) > 0 or self.bootstrap_node:
  83                 df = self.joining
  84                 self.joining = None
  85                 df.callback(result)
  86             else:
  87                 df = self.joining
  88                 self.joining = None
  89                 df.errback(DHTError('could not find any nodes to bootstrap to'))
  90
  91     def leave(self):
  92         """See L{apt_dht.interfaces.IDHT}."""
  93         if self.config is None:
  94             raise DHTError, "configuration not loaded"
  95
  96         if self.joined or self.joining:
  97             if self.joining:
  98                 self.joining.errback(DHTError('still joining when leave was called'))
  99                 self.joining = None
 100             self.joined = False
 101             self.khashmir.shutdown()
 102
 103     def getValue(self, key):
 104         """See L{apt_dht.interfaces.IDHT}."""
 105         if self.config is None:
 106             raise DHTError, "configuration not loaded"
 107         if not self.joined:
 108             raise DHTError, "have not joined a network yet"
 109
 110         d = defer.Deferred()
 111         if key not in self.retrieving:
 112             self.khashmir.valueForKey(key, self._getValue)
 113         self.retrieving.setdefault(key, []).append(d)
 114         return d
 115
 116     def _getValue(self, key, result):
 117         if result:
 118             self.retrieved.setdefault(key, []).extend(result)
 119         else:
 120             final_result = []
 121             if key in self.retrieved:
 122                 final_result = self.retrieved[key]
 123                 del self.retrieved[key]
 124             for i in range(len(self.retrieving[key])):
 125                 d = self.retrieving[key].pop(0)
 126                 d.callback(final_result)
 127             del self.retrieving[key]
 128
 129     def storeValue(self, key, value):
 130         """See L{apt_dht.interfaces.IDHT}."""
 131         if self.config is None:
 132             raise DHTError, "configuration not loaded"
 133         if not self.joined:
 134             raise DHTError, "have not joined a network yet"
 135
 136         if key in self.storing and value in self.storing[key]:
 137             raise DHTError, "already storing that key with the same value"
 138
 139         d = defer.Deferred()
 140         self.khashmir.storeValueForKey(key, value, self._storeValue)
 141         self.storing.setdefault(key, {})[value] = d
 142         return d
 143
 144     def _storeValue(self, key, value, result):
 145         if key in self.storing and value in self.storing[key]:
 146             if len(result) > 0:
 147                 self.storing[key][value].callback(result)
 148             else:
 149                 self.storing[key][value].errback(DHTError('could not store value %s in key %s' % (value, key)))
 150             del self.storing[key][value]
 151             if len(self.storing[key].keys()) == 0:
 152                 del self.storing[key]
 153
 154 class TestSimpleDHT(unittest.TestCase):
 155     """Unit tests for the DHT."""
 156
 157     timeout = 2
 158     DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
 159                     'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
 160                     'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
 161                     'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
 162                     'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
 163                     'KE_AGE': 3600, }
 164
 165     def setUp(self):
 166         self.a = DHT()
 167         self.b = DHT()
 168         self.a.config = self.DHT_DEFAULTS.copy()
 169         self.a.config['PORT'] = 4044
 170         self.a.bootstrap = ["127.0.0.1:4044"]
 171         self.a.bootstrap_node = True
 172         self.a.cache_dir = '/tmp'
 173         self.b.config = self.DHT_DEFAULTS.copy()
 174         self.b.config['PORT'] = 4045
 175         self.b.bootstrap = ["127.0.0.1:4044"]
 176         self.b.cache_dir = '/tmp'
 177
 178     def test_bootstrap_join(self):
 179         d = self.a.join()
 180         return d
 181
 182     def node_join(self, result):
 183         d = self.b.join()
 184         return d
 185
 186     def test_join(self):
 187         self.lastDefer = defer.Deferred()
 188         d = self.a.join()
 189         d.addCallback(self.node_join)
 190         d.addCallback(self.lastDefer.callback)
 191         return self.lastDefer
 192
 193     def value_stored(self, result, value):
 194         self.stored -= 1
 195         if self.stored == 0:
 196             self.get_values()
 197
 198     def store_values(self, result):
 199         self.stored = 3
 200         d = self.a.storeValue(sha.new('4045').digest(), str(4045*3))
 201         d.addCallback(self.value_stored, 4045)
 202         d = self.a.storeValue(sha.new('4044').digest(), str(4044*2))
 203         d.addCallback(self.value_stored, 4044)
 204         d = self.b.storeValue(sha.new('4045').digest(), str(4045*2))
 205         d.addCallback(self.value_stored, 4045)
 206
 207     def check_values(self, result, values):
 208         self.checked -= 1
 209         self.failUnless(len(result) == len(values))
 210         for v in result:
 211             self.failUnless(v in values)
 212         if self.checked == 0:
 213             self.lastDefer.callback(1)
 214
 215     def get_values(self):
 216         self.checked = 4
 217         d = self.a.getValue(sha.new('4044').digest())
 218         d.addCallback(self.check_values, [str(4044*2)])
 219         d = self.b.getValue(sha.new('4044').digest())
 220         d.addCallback(self.check_values, [str(4044*2)])
 221         d = self.a.getValue(sha.new('4045').digest())
 222         d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
 223         d = self.b.getValue(sha.new('4045').digest())
 224         d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
 225
 226     def test_store(self):
 227         from twisted.internet.base import DelayedCall
 228         DelayedCall.debug = True
 229         self.lastDefer = defer.Deferred()
 230         d = self.a.join()
 231         d.addCallback(self.node_join)
 232         d.addCallback(self.store_values)
 233         return self.lastDefer
 234
 235     def tearDown(self):
 236         self.a.leave()
 237         try:
 238             os.unlink(self.a.khashmir.db)
 239         except:
 240             pass
 241         self.b.leave()
 242         try:
 243             os.unlink(self.b.khashmir.db)
 244         except:
 245             pass
 246
 247 class TestMultiDHT(unittest.TestCase):
 248
 249     timeout = 60
 250     num = 20
 251     DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
 252                     'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
 253                     'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
 254                     'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
 255                     'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
 256                     'KE_AGE': 3600, }
 257
 258     def setUp(self):
 259         self.l = []
 260         self.startport = 4081
 261         for i in range(self.num):
 262             self.l.append(DHT())
 263             self.l[i].config = self.DHT_DEFAULTS.copy()
 264             self.l[i].config['PORT'] = self.startport + i
 265             self.l[i].bootstrap = ["127.0.0.1:" + str(self.startport)]
 266             self.l[i].cache_dir = '/tmp'
 267         self.l[0].bootstrap_node = True
 268
 269     def node_join(self, result, next_node):
 270         d = self.l[next_node].join()
 271         if next_node + 1 < len(self.l):
 272             d.addCallback(self.node_join, next_node + 1)
 273         else:
 274             d.addCallback(self.lastDefer.callback)
 275
 276     def test_join(self):
 277         self.timeout = 2
 278         self.lastDefer = defer.Deferred()
 279         d = self.l[0].join()
 280         d.addCallback(self.node_join, 1)
 281         return self.lastDefer
 282
 283     def value_stored(self, result, value):
 284         self.stored -= 1
 285         if self.stored == 0:
 286             self.get_values()
 287
 288     def store_values(self, result):
 289         self.stored = 0
 290         for i in range(len(self.l)):
 291             for j in range(0, i+1):
 292                 self.stored += 1
 293                 d = self.l[j].storeValue(sha.new(str(self.startport+i)).digest(), str((self.startport+i)*(j+1)))
 294                 d.addCallback(self.value_stored, self.startport+i)
 295
 296     def check_values(self, result, values):
 297         self.checked -= 1
 298         self.failUnless(len(result) == len(values))
 299         for v in result:
 300             self.failUnless(v in values)
 301         if self.checked == 0:
 302             self.lastDefer.callback(1)
 303
 304     def get_values(self):
 305         self.checked = 0
 306         for i in range(len(self.l)):
 307             for j in random.sample(xrange(len(self.l)), 4):
 308                 self.checked += 1
 309                 d = self.l[i].getValue(sha.new(str(self.startport+j)).digest())
 310                 check = []
 311                 for k in range(self.startport+j, (self.startport+j)*(j+1)+1, self.startport+j):
 312                     check.append(str(k))
 313                 d.addCallback(self.check_values, check)
 314
 315     def store_join(self, result, next_node):
 316         d = self.l[next_node].join()
 317         if next_node + 1 < len(self.l):
 318             d.addCallback(self.store_join, next_node + 1)
 319         else:
 320             d.addCallback(self.store_values)
 321
 322     def test_store(self):
 323         from twisted.internet.base import DelayedCall
 324         DelayedCall.debug = True
 325         self.lastDefer = defer.Deferred()
 326         d = self.l[0].join()
 327         d.addCallback(self.store_join, 1)
 328         return self.lastDefer
 329
 330     def tearDown(self):
 331         for i in self.l:
 332             try:
 333                 i.leave()
 334                 os.unlink(i.khashmir.db)
 335             except:
 336                 pass