p2pool/p2p.py

   1 from __future__ import division
   2
   3 import random
   4 import time
   5
   6 from twisted.internet import defer, protocol, reactor
   7 from twisted.python import log
   8
   9 import p2pool
  10 from p2pool import data as p2pool_data
  11 from p2pool.bitcoin import p2p as bitcoin_p2p
  12 from p2pool.bitcoin import data as bitcoin_data
  13 from p2pool.util import deferral, pack
  14
  15 class PeerMisbehavingError(Exception):
  16     pass
  17
  18 class Protocol(bitcoin_p2p.BaseProtocol):
  19     def __init__(self, node, incoming):
  20         bitcoin_p2p.BaseProtocol.__init__(self, node.net.PREFIX, 1000000)
  21         self.node = node
  22         self.incoming = incoming
  23
  24         self.other_version = None
  25         self.connected2 = False
  26
  27     def connectionMade(self):
  28         self.factory.proto_made_connection(self)
  29
  30         self.addr = self.transport.getPeer().host, self.transport.getPeer().port
  31
  32         self.send_version(
  33             version=3,
  34             services=0,
  35             addr_to=dict(
  36                 services=0,
  37                 address=self.transport.getPeer().host,
  38                 port=self.transport.getPeer().port,
  39             ),
  40             addr_from=dict(
  41                 services=0,
  42                 address=self.transport.getHost().host,
  43                 port=self.transport.getHost().port,
  44             ),
  45             nonce=self.node.nonce,
  46             sub_version=p2pool.__version__,
  47             mode=1,
  48             best_share_hash=self.node.best_share_hash_func(),
  49         )
  50
  51         reactor.callLater(10, self._connect_timeout)
  52         self.timeout_delayed = reactor.callLater(100, self._timeout)
  53
  54         old_dataReceived = self.dataReceived
  55         def new_dataReceived(data):
  56             if not self.timeout_delayed.called:
  57                 self.timeout_delayed.reset(100)
  58             old_dataReceived(data)
  59         self.dataReceived = new_dataReceived
  60
  61     def _connect_timeout(self):
  62         if not self.connected2 and self.transport.connected:
  63             print 'Handshake timed out, disconnecting from %s:%i' % self.addr
  64             self.transport.loseConnection()
  65
  66     def packetReceived(self, command, payload2):
  67         try:
  68             if command != 'version' and not self.connected2:
  69                 raise PeerMisbehavingError('first message was not version message')
  70             bitcoin_p2p.BaseProtocol.packetReceived(self, command, payload2)
  71         except PeerMisbehavingError, e:
  72             print 'Peer %s:%i misbehaving, will drop and ban. Reason:' % self.addr, e.message
  73             self.badPeerHappened()
  74
  75     def badPeerHappened(self):
  76         self.transport.loseConnection()
  77         self.node.bans[self.transport.getPeer().host] = time.time() + 60*60
  78
  79     def _timeout(self):
  80         if self.transport.connected:
  81             print 'Connection timed out, disconnecting from %s:%i' % self.addr
  82             self.transport.loseConnection()
  83
  84     @defer.inlineCallbacks
  85     def _think(self):
  86         while self.connected2:
  87             self.send_ping()
  88             yield deferral.sleep(random.expovariate(1/100))
  89
  90     @defer.inlineCallbacks
  91     def _think2(self):
  92         while self.connected2:
  93             self.send_addrme(port=self.node.port)
  94             #print 'sending addrme'
  95             yield deferral.sleep(random.expovariate(1/(100*len(self.node.peers) + 1)))
  96
  97     message_version = pack.ComposedType([
  98         ('version', pack.IntType(32)),
  99         ('services', pack.IntType(64)),
 100         ('addr_to', bitcoin_data.address_type),
 101         ('addr_from', bitcoin_data.address_type),
 102         ('nonce', pack.IntType(64)),
 103         ('sub_version', pack.VarStrType()),
 104         ('mode', pack.IntType(32)), # always 1 for legacy compatibility
 105         ('best_share_hash', pack.PossiblyNoneType(0, pack.IntType(256))),
 106     ])
 107     def handle_version(self, version, services, addr_to, addr_from, nonce, sub_version, mode, best_share_hash):
 108         if self.other_version is not None or version < 2:
 109             raise PeerMisbehavingError('more than one version message')
 110
 111         self.other_version = version
 112         self.other_sub_version = sub_version[:512]
 113         self.other_services = services
 114
 115         if nonce == self.node.nonce:
 116             raise PeerMisbehavingError('was connected to self')
 117         if nonce in self.node.peers:
 118             #print 'Detected duplicate connection, disconnecting from %s:%i' % self.addr
 119             self.transport.loseConnection()
 120             return
 121
 122         self.nonce = nonce
 123         self.connected2 = True
 124         self.factory.proto_connected(self)
 125
 126         self._think()
 127         self._think2()
 128
 129         if best_share_hash is not None:
 130             self.node.handle_share_hashes([best_share_hash], self)
 131
 132     message_ping = pack.ComposedType([])
 133     def handle_ping(self):
 134         pass
 135
 136     message_addrme = pack.ComposedType([
 137         ('port', pack.IntType(16)),
 138     ])
 139     def handle_addrme(self, port):
 140         host = self.transport.getPeer().host
 141         #print 'addrme from', host, port
 142         if host == '127.0.0.1':
 143             if random.random() < .8 and self.node.peers:
 144                 random.choice(self.node.peers.values()).send_addrme(port=port) # services...
 145         else:
 146             self.node.got_addr((self.transport.getPeer().host, port), self.other_services, int(time.time()))
 147             if random.random() < .8 and self.node.peers:
 148                 random.choice(self.node.peers.values()).send_addrs(addrs=[
 149                     dict(
 150                         address=dict(
 151                             services=self.other_services,
 152                             address=host,
 153                             port=port,
 154                         ),
 155                         timestamp=int(time.time()),
 156                     ),
 157                 ])
 158
 159     message_addrs = pack.ComposedType([
 160         ('addrs', pack.ListType(pack.ComposedType([
 161             ('timestamp', pack.IntType(64)),
 162             ('address', bitcoin_data.address_type),
 163         ]))),
 164     ])
 165     def handle_addrs(self, addrs):
 166         for addr_record in addrs:
 167             self.node.got_addr((addr_record['address']['address'], addr_record['address']['port']), addr_record['address']['services'], min(int(time.time()), addr_record['timestamp']))
 168             if random.random() < .8 and self.node.peers:
 169                 random.choice(self.node.peers.values()).send_addrs(addrs=[addr_record])
 170
 171     message_getaddrs = pack.ComposedType([
 172         ('count', pack.IntType(32)),
 173     ])
 174     def handle_getaddrs(self, count):
 175         if count > 100:
 176             count = 100
 177         self.send_addrs(addrs=[
 178             dict(
 179                 timestamp=self.node.addr_store[host, port][2],
 180                 address=dict(
 181                     services=self.node.addr_store[host, port][0],
 182                     address=host,
 183                     port=port,
 184                 ),
 185             ) for host, port in
 186             self.node.get_good_peers(count)
 187         ])
 188
 189     message_getshares = pack.ComposedType([
 190         ('hashes', pack.ListType(pack.IntType(256))),
 191         ('parents', pack.VarIntType()),
 192         ('stops', pack.ListType(pack.IntType(256))),
 193     ])
 194     def handle_getshares(self, hashes, parents, stops):
 195         self.node.handle_get_shares(hashes, parents, stops, self)
 196
 197     message_shares = pack.ComposedType([
 198         ('shares', pack.ListType(p2pool_data.share_type)),
 199     ])
 200     def handle_shares(self, shares):
 201         self.node.handle_shares([p2pool_data.Share.from_share(share, self.node.net, self) for share in shares], self)
 202
 203     def sendShares(self, shares):
 204         def att(f, **kwargs):
 205             try:
 206                 f(**kwargs)
 207             except bitcoin_p2p.TooLong:
 208                 att(f, **dict((k, v[:len(v)//2]) for k, v in kwargs.iteritems()))
 209                 att(f, **dict((k, v[len(v)//2:]) for k, v in kwargs.iteritems()))
 210         if shares:
 211             att(self.send_shares, shares=[share.as_share() for share in shares])
 212
 213     def connectionLost(self, reason):
 214         if self.connected2:
 215             self.factory.proto_disconnected(self, reason)
 216             self.connected2 = False
 217         self.factory.proto_lost_connection(self, reason)
 218
 219 class ServerFactory(protocol.ServerFactory):
 220     def __init__(self, node, max_conns):
 221         self.node = node
 222         self.max_conns = max_conns
 223
 224         self.conns = {}
 225         self.running = False
 226
 227     def buildProtocol(self, addr):
 228         if sum(self.conns.itervalues()) >= self.max_conns or self.conns.get(self._host_to_ident(addr.host), 0) >= 3:
 229             return None
 230         if addr.host in self.node.bans and self.node.bans[addr.host] > time.time():
 231             return None
 232         p = Protocol(self.node, True)
 233         p.factory = self
 234         return p
 235
 236     def _host_to_ident(self, host):
 237         a, b, c, d = host.split('.')
 238         return a, b
 239
 240     def proto_made_connection(self, proto):
 241         ident = self._host_to_ident(proto.transport.getPeer().host)
 242         self.conns[ident] = self.conns.get(ident, 0) + 1
 243     def proto_lost_connection(self, proto, reason):
 244         ident = self._host_to_ident(proto.transport.getPeer().host)
 245         self.conns[ident] -= 1
 246         if not self.conns[ident]:
 247             del self.conns[ident]
 248
 249     def proto_connected(self, proto):
 250         self.node.got_conn(proto)
 251     def proto_disconnected(self, proto, reason):
 252         self.node.lost_conn(proto, reason)
 253
 254     def start(self):
 255         assert not self.running
 256         self.running = True
 257
 258         def attempt_listen():
 259             if self.running:
 260                 self.listen_port = reactor.listenTCP(self.node.port, self)
 261         deferral.retry('Error binding to P2P port:', traceback=False)(attempt_listen)()
 262
 263     def stop(self):
 264         assert self.running
 265         self.running = False
 266
 267         self.listen_port.stopListening()
 268
 269 class ClientFactory(protocol.ClientFactory):
 270     def __init__(self, node, desired_conns, max_attempts):
 271         self.node = node
 272         self.desired_conns = desired_conns
 273         self.max_attempts = max_attempts
 274
 275         self.attempts = set()
 276         self.conns = set()
 277         self.running = False
 278
 279     def _host_to_ident(self, host):
 280         a, b, c, d = host.split('.')
 281         return a, b
 282
 283     def buildProtocol(self, addr):
 284         p = Protocol(self.node, False)
 285         p.factory = self
 286         return p
 287
 288     def startedConnecting(self, connector):
 289         ident = self._host_to_ident(connector.getDestination().host)
 290         if ident in self.attempts:
 291             raise AssertionError('already have attempt')
 292         self.attempts.add(ident)
 293
 294     def clientConnectionFailed(self, connector, reason):
 295         self.attempts.remove(self._host_to_ident(connector.getDestination().host))
 296
 297     def clientConnectionLost(self, connector, reason):
 298         self.attempts.remove(self._host_to_ident(connector.getDestination().host))
 299
 300     def proto_made_connection(self, proto):
 301         pass
 302     def proto_lost_connection(self, proto, reason):
 303         pass
 304
 305     def proto_connected(self, proto):
 306         self.conns.add(proto)
 307         self.node.got_conn(proto)
 308     def proto_disconnected(self, proto, reason):
 309         self.conns.remove(proto)
 310         self.node.lost_conn(proto, reason)
 311
 312     def start(self):
 313         assert not self.running
 314         self.running = True
 315         self._think()
 316     def stop(self):
 317         assert self.running
 318         self.running = False
 319
 320     @defer.inlineCallbacks
 321     def _think(self):
 322         while self.running:
 323             try:
 324                 if len(self.conns) < self.desired_conns and len(self.attempts) < self.max_attempts and self.node.addr_store:
 325                     (host, port), = self.node.get_good_peers(1)
 326
 327                     if self._host_to_ident(host) in self.attempts:
 328                         pass
 329                     elif host in self.node.bans and self.node.bans[host] > time.time():
 330                         pass
 331                     else:
 332                         #print 'Trying to connect to', host, port
 333                         reactor.connectTCP(host, port, self, timeout=5)
 334             except:
 335                 log.err()
 336
 337             yield deferral.sleep(random.expovariate(1/1))
 338
 339 class SingleClientFactory(protocol.ReconnectingClientFactory):
 340     def __init__(self, node):
 341         self.node = node
 342
 343     def buildProtocol(self, addr):
 344         p = Protocol(self.node, incoming=False)
 345         p.factory = self
 346         return p
 347
 348     def proto_made_connection(self, proto):
 349         pass
 350     def proto_lost_connection(self, proto, reason):
 351         pass
 352
 353     def proto_connected(self, proto):
 354         self.resetDelay()
 355         self.node.got_conn(proto)
 356     def proto_disconnected(self, proto, reason):
 357         self.node.lost_conn(proto, reason)
 358
 359 class Node(object):
 360     def __init__(self, best_share_hash_func, port, net, addr_store={}, connect_addrs=set(), desired_outgoing_conns=10, max_outgoing_attempts=30, max_incoming_conns=50, preferred_storage=1000):
 361         self.best_share_hash_func = best_share_hash_func
 362         self.port = port
 363         self.net = net
 364         self.addr_store = dict(addr_store)
 365         self.connect_addrs = connect_addrs
 366         self.preferred_storage = preferred_storage
 367
 368         self.nonce = random.randrange(2**64)
 369         self.peers = {}
 370         self.bans = {} # address -> end_time
 371         self.clientfactory = ClientFactory(self, desired_outgoing_conns, max_outgoing_attempts)
 372         self.serverfactory = ServerFactory(self, max_incoming_conns)
 373         self.running = False
 374
 375     def start(self):
 376         if self.running:
 377             raise ValueError('already running')
 378
 379         self.clientfactory.start()
 380         self.serverfactory.start()
 381         self.singleclientconnectors = [reactor.connectTCP(addr, port, SingleClientFactory(self)) for addr, port in self.connect_addrs]
 382
 383         self.running = True
 384
 385         self._think2()
 386
 387     @defer.inlineCallbacks
 388     def _think2(self):
 389         while self.running:
 390             try:
 391                 if len(self.addr_store) < self.preferred_storage and self.peers:
 392                     random.choice(self.peers.values()).send_getaddrs(count=8)
 393             except:
 394                 log.err()
 395
 396             yield deferral.sleep(random.expovariate(1/20))
 397
 398     def stop(self):
 399         if not self.running:
 400             raise ValueError('already stopped')
 401
 402         self.running = False
 403
 404         self.clientfactory.stop()
 405         self.serverfactory.stop()
 406         for singleclientconnector in self.singleclientconnectors:
 407             singleclientconnector.factory.stopTrying() # XXX will this disconnect a current connection?
 408         del self.singleclientconnectors
 409
 410     def got_conn(self, conn):
 411         if conn.nonce in self.peers:
 412             raise ValueError('already have peer')
 413         self.peers[conn.nonce] = conn
 414
 415         print '%s connection to peer %s:%i established. p2pool version: %i %r' % ('Incoming' if conn.incoming else 'Outgoing', conn.addr[0], conn.addr[1], conn.other_version, conn.other_sub_version)
 416
 417     def lost_conn(self, conn, reason):
 418         if conn.nonce not in self.peers:
 419             raise ValueError('''don't have peer''')
 420         if conn is not self.peers[conn.nonce]:
 421             raise ValueError('wrong conn')
 422         del self.peers[conn.nonce]
 423
 424         print 'Lost peer %s:%i - %s' % (conn.addr[0], conn.addr[1], reason.getErrorMessage())
 425
 426
 427     def got_addr(self, (host, port), services, timestamp):
 428         if (host, port) in self.addr_store:
 429             old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
 430             self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
 431         else:
 432             self.addr_store[host, port] = services, timestamp, timestamp
 433
 434     def handle_shares(self, shares, peer):
 435         print 'handle_shares', (shares, peer)
 436
 437     def handle_share_hashes(self, hashes, peer):
 438         print 'handle_share_hashes', (hashes, peer)
 439
 440     def handle_get_shares(self, hashes, parents, stops, peer):
 441         print 'handle_get_shares', (hashes, parents, stops, peer)
 442
 443     def get_good_peers(self, max_count):
 444         t = time.time()
 445         return [x[0] for x in sorted(self.addr_store.iteritems(), key=lambda (k, (services, first_seen, last_seen)): -max(3600, last_seen - first_seen)/max(3600, t - last_seen)*random.expovariate(1))][:max_count]
 446
 447 if __name__ == '__main__':
 448     p = random.randrange(2**15, 2**16)
 449     for i in xrange(5):
 450         p2 = random.randrange(2**15, 2**16)
 451         print p, p2
 452         n = Node(p2, True, {addrdb_key.pack(dict(address='127.0.0.1', port=p)): addrdb_value.pack(dict(services=0, first_seen=int(time.time())-10, last_seen=int(time.time())))})
 453         n.start()
 454         p = p2
 455
 456     reactor.run()