p2pool/p2p.py

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