style and import fixes
[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, dicts
14
15 class Protocol(bitcoin_p2p.BaseProtocol):
16     version = 1
17     sub_version = p2pool.__version__
18     
19     def __init__(self, node):
20         self.node = node
21         
22         self._prefix = self.node.net.PREFIX
23     
24     max_payload_length = 1000000
25     use_checksum = True
26     
27     other_version = None
28     connected2 = False
29     
30     def connectionMade(self):
31         bitcoin_p2p.BaseProtocol.connectionMade(self)
32         
33         self.addr = self.transport.getPeer().host, self.transport.getPeer().port
34         
35         self.send_version(
36             version=self.version,
37             services=0,
38             addr_to=dict(
39                 services=0,
40                 address=self.transport.getPeer().host,
41                 port=self.transport.getPeer().port,
42             ),
43             addr_from=dict(
44                 services=0,
45                 address=self.transport.getHost().host,
46                 port=self.transport.getHost().port,
47             ),
48             nonce=self.node.nonce,
49             sub_version=self.sub_version,
50             mode=1,
51             best_share_hash=self.node.current_work.value['best_share_hash'],
52         )
53         
54         reactor.callLater(10, self._connect_timeout)
55         self.timeout_delayed = reactor.callLater(100, self._timeout)
56     
57     def _connect_timeout(self):
58         if not self.connected2 and self.transport.connected:
59             print 'Handshake timed out, disconnecting from %s:%i' % self.addr
60             self.transport.loseConnection()
61     
62     def gotPacket(self):
63         if not self.timeout_delayed.called:
64             self.timeout_delayed.cancel()
65             self.timeout_delayed = reactor.callLater(100, self._timeout)
66     
67     def _timeout(self):
68         if self.transport.connected:
69             print 'Connection timed out, disconnecting from %s:%i' % self.addr
70             self.transport.loseConnection()
71     
72     @defer.inlineCallbacks
73     def _think(self):
74         while self.connected2:
75             self.send_ping()
76             yield deferral.sleep(random.expovariate(1/100))
77     
78     @defer.inlineCallbacks
79     def _think2(self):
80         while self.connected2:
81             self.send_addrme(port=self.node.port)
82             #print 'sending addrme'
83             yield deferral.sleep(random.expovariate(1/(100*len(self.node.peers) + 1)))
84     
85     message_version = bitcoin_data.ComposedType([
86         ('version', bitcoin_data.StructType('<I')),
87         ('services', bitcoin_data.StructType('<Q')),
88         ('addr_to', bitcoin_data.address_type),
89         ('addr_from', bitcoin_data.address_type),
90         ('nonce', bitcoin_data.StructType('<Q')),
91         ('sub_version', bitcoin_data.VarStrType()),
92         ('mode', bitcoin_data.StructType('<I')), # always 1 for legacy compatibility
93         ('best_share_hash', bitcoin_data.PossiblyNoneType(0, bitcoin_data.HashType())),
94     ])
95     def handle_version(self, version, services, addr_to, addr_from, nonce, sub_version, mode, best_share_hash):
96         self.other_version = version
97         self.other_sub_version = sub_version[:512]
98         self.other_services = services
99         
100         if nonce == self.node.nonce:
101             #print 'Detected connection to self, disconnecting from %s:%i' % self.addr
102             self.transport.loseConnection()
103             return
104         if nonce in self.node.peers:
105             #print 'Detected duplicate connection, disconnecting from %s:%i' % self.addr
106             self.transport.loseConnection()
107             return
108         
109         self.nonce = nonce
110         self.connected2 = True
111         self.node.got_conn(self)
112         
113         self._think()
114         self._think2()
115         
116         if best_share_hash is not None:
117             self.node.handle_share_hashes([best_share_hash], self)
118     
119     message_ping = bitcoin_data.ComposedType([])
120     def handle_ping(self):
121         pass
122     
123     message_addrme = bitcoin_data.ComposedType([
124         ('port', bitcoin_data.StructType('<H')),
125     ])
126     def handle_addrme(self, port):
127         host = self.transport.getPeer().host
128         #print 'addrme from', host, port
129         if host == '127.0.0.1':
130             if random.random() < .8 and self.node.peers:
131                 random.choice(self.node.peers.values()).send_addrme(port=port) # services...
132         else:
133             self.node.got_addr((self.transport.getPeer().host, port), self.other_services, int(time.time()))
134             if random.random() < .8 and self.node.peers:
135                 random.choice(self.node.peers.values()).send_addrs(addrs=[
136                     dict(
137                         address=dict(
138                             services=self.other_services,
139                             address=host,
140                             port=port,
141                         ),
142                         timestamp=int(time.time()),
143                     ),
144                 ])
145     
146     message_addrs = bitcoin_data.ComposedType([
147         ('addrs', bitcoin_data.ListType(bitcoin_data.ComposedType([
148             ('timestamp', bitcoin_data.StructType('<Q')),
149             ('address', bitcoin_data.address_type),
150         ]))),
151     ])
152     def handle_addrs(self, addrs):
153         for addr_record in addrs:
154             self.node.got_addr((addr_record['address']['address'], addr_record['address']['port']), addr_record['address']['services'], min(int(time.time()), addr_record['timestamp']))
155             if random.random() < .8 and self.node.peers:
156                 random.choice(self.node.peers.values()).send_addrs(addrs=[addr_record])
157     
158     message_getaddrs = bitcoin_data.ComposedType([
159         ('count', bitcoin_data.StructType('<I')),
160     ])
161     def handle_getaddrs(self, count):
162         if count > 100:
163             count = 100
164         self.send_addrs(addrs=[
165             dict(
166                 timestamp=self.node.addr_store[host, port][2],
167                 address=dict(
168                     services=self.node.addr_store[host, port][0],
169                     address=host,
170                     port=port,
171                 ),
172             ) for host, port in
173             random.sample(self.node.addr_store.keys(), min(count, len(self.node.addr_store)))
174         ])
175     
176     message_getshares = bitcoin_data.ComposedType([
177         ('hashes', bitcoin_data.ListType(bitcoin_data.HashType())),
178         ('parents', bitcoin_data.VarIntType()),
179         ('stops', bitcoin_data.ListType(bitcoin_data.HashType())),
180     ])
181     def handle_getshares(self, hashes, parents, stops):
182         self.node.handle_get_shares(hashes, parents, stops, self)
183     
184     message_shares = bitcoin_data.ComposedType([
185         ('shares', bitcoin_data.ListType(p2pool_data.new_share_type)),
186     ])
187     def handle_shares(self, shares):
188         res = []
189         for share in shares:
190             share_obj = p2pool_data.NewShare.from_share(share, self.node.net)
191             share_obj.peer = self
192             res.append(share_obj)
193         self.node.handle_shares(res)
194     
195     def sendShares(self, shares, full=False):
196         new_shares = []
197         # XXX doesn't need to send full block when it's not urgent
198         # eg. when getting history
199         for share in shares:
200             new_shares.append(share.as_share())
201         def att(f, **kwargs):
202             try:
203                 f(**kwargs)
204             except bitcoin_p2p.TooLong:
205                 att(f, **dict((k, v[:len(v)//2]) for k, v in kwargs.iteritems()))
206                 att(f, **dict((k, v[len(v)//2:]) for k, v in kwargs.iteritems()))
207         if new_shares: att(self.send_shares, shares=new_shares)
208     
209     def connectionLost(self, reason):
210         if self.connected2:
211             self.node.lost_conn(self)
212
213 class ServerFactory(protocol.ServerFactory):
214     def __init__(self, node):
215         self.node = node
216     
217     def buildProtocol(self, addr):
218         p = Protocol(self.node)
219         p.factory = self
220         return p
221
222 class ClientFactory(protocol.ClientFactory):
223     def __init__(self, node):
224         self.node = node
225     
226     def buildProtocol(self, addr):
227         p = Protocol(self.node)
228         p.factory = self
229         return p
230     
231     def startedConnecting(self, connector):
232         self.node.attempt_started(connector)
233     
234     def clientConnectionFailed(self, connector, reason):
235         self.node.attempt_failed(connector)
236     
237     def clientConnectionLost(self, connector, reason):
238         self.node.attempt_ended(connector)
239
240 addrdb_key = bitcoin_data.ComposedType([
241     ('address', bitcoin_data.IPV6AddressType()),
242     ('port', bitcoin_data.StructType('>H')),
243 ])
244 addrdb_value = bitcoin_data.ComposedType([
245     ('services', bitcoin_data.StructType('<Q')),
246     ('first_seen', bitcoin_data.StructType('<Q')),
247     ('last_seen', bitcoin_data.StructType('<Q')),
248 ])
249
250 class AddrStore(dicts.DictWrapper):
251     def encode_key(self, (address, port)):
252         return addrdb_key.pack(dict(address=address, port=port))
253     def decode_key(self, encoded_key):
254         k = addrdb_key.unpack(encoded_key)
255         return k['address'], k['port']
256     
257     def encode_value(self, (services, first_seen, last_seen)):
258         return addrdb_value.pack(dict(services=services, first_seen=first_seen, last_seen=last_seen))
259     def decode_value(self, encoded_value):
260         v = addrdb_value.unpack(encoded_value)
261         return v['services'], v['first_seen'], v['last_seen']
262
263 class Node(object):
264     def __init__(self, current_work, port, net, addr_store=None, preferred_addrs=set(), desired_peers=10, max_attempts=100, preferred_storage=1000):
265         if addr_store is None:
266             addr_store = {}
267         
268         self.port = port
269         self.net = net
270         self.addr_store = AddrStore(addr_store)
271         self.preferred_addrs = preferred_addrs
272         self.desired_peers = desired_peers
273         self.max_attempts = max_attempts
274         self.current_work = current_work
275         self.preferred_storage = preferred_storage
276         
277         self.nonce = random.randrange(2**64)
278         self.attempts = {}
279         self.peers = {}
280         self.running = False
281     
282     def start(self):
283         if self.running:
284             raise ValueError('already running')
285         
286         self.running = True
287         
288         self.listen_port = reactor.listenTCP(self.port, ServerFactory(self))
289         
290         self._think()
291         self._think2()
292     
293     @defer.inlineCallbacks
294     def _think(self):
295         while self.running:
296             try:
297                 if len(self.peers) < self.desired_peers and len(self.attempts) < self.max_attempts and (len(self.preferred_addrs) or len(self.addr_store)):
298                     if (random.randrange(2) and len(self.preferred_addrs)) or not len(self.addr_store):
299                         host, port = random.choice(list(self.preferred_addrs))
300                     else:
301                         host, port = random.choice(self.addr_store.keys())
302                     
303                     if (host, port) not in self.attempts:
304                         #print 'Trying to connect to', host, port
305                         reactor.connectTCP(host, port, ClientFactory(self), timeout=10)
306             except:
307                 log.err()
308             
309             yield deferral.sleep(random.expovariate(1/5))
310     
311     @defer.inlineCallbacks
312     def _think2(self):
313         while self.running:
314             try:
315                 if len(self.addr_store) < self.preferred_storage and self.peers:
316                     random.choice(self.peers.values()).send_getaddrs(count=8)
317             except:
318                 log.err()
319             
320             yield deferral.sleep(random.expovariate(1/20))
321     
322     def stop(self):
323         if not self.running:
324             raise ValueError('already stopped')
325         
326         self.running = False
327         
328         self.listen_port.stopListening()
329     
330     
331     def attempt_started(self, connector):
332         host, port = connector.getDestination().host, connector.getDestination().port
333         if (host, port) in self.attempts:
334             raise ValueError('already have attempt')
335         self.attempts[host, port] = connector
336     
337     def attempt_failed(self, connector):
338         self.attempt_ended(connector)
339     
340     def attempt_ended(self, connector):
341         host, port = connector.getDestination().host, connector.getDestination().port
342         if (host, port) not in self.attempts:
343             raise ValueError('''don't have attempt''')
344         if connector is not self.attempts[host, port]:
345             raise ValueError('wrong connector')
346         del self.attempts[host, port]
347     
348     
349     def got_conn(self, conn):
350         if conn.nonce in self.peers:
351             raise ValueError('already have peer')
352         self.peers[conn.nonce] = conn
353         
354         print 'Connected to peer %s:%i. p2pool version: %r' % (conn.addr[0], conn.addr[1], conn.other_sub_version)
355     
356     def lost_conn(self, conn):
357         if conn.nonce not in self.peers:
358             raise ValueError('''don't have peer''')
359         if conn is not self.peers[conn.nonce]:
360             raise ValueError('wrong conn')
361         del self.peers[conn.nonce]
362         
363         print 'Lost peer %s:%i' % (conn.addr[0], conn.addr[1])
364     
365     
366     def got_addr(self, (host, port), services, timestamp):
367         if (host, port) in self.addr_store:
368             old_services, old_first_seen, old_last_seen = self.addr_store[host, port]
369             self.addr_store[host, port] = services, old_first_seen, max(old_last_seen, timestamp)
370         else:
371             self.addr_store[host, port] = services, timestamp, timestamp
372     
373     def handle_shares(self, shares, peer):
374         print 'handle_shares', (shares, peer)
375     
376     def handle_share_hashes(self, hashes, peer):
377         print 'handle_share_hashes', (hashes, peer)
378     
379     def handle_get_shares(self, hashes, parents, stops, peer):
380         print 'handle_get_shares', (hashes, parents, stops, peer)
381
382 if __name__ == '__main__':
383     p = random.randrange(2**15, 2**16)
384     for i in xrange(5):
385         p2 = random.randrange(2**15, 2**16)
386         print p, p2
387         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())))})
388         n.start()
389         p = p2
390     
391     reactor.run()