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