p2pool/bitcoin/worker_interface.py

   1 from __future__ import division
   2
   3 import base64
   4 import json
   5 import random
   6
   7 from twisted.internet import defer, reactor
   8 from twisted.python import log
   9
  10 import p2pool
  11 from p2pool import data as p2pool_data
  12 from p2pool.util import jsonrpc, deferred_resource, variable
  13 from p2pool.bitcoin import getwork
  14
  15 def get_memory(request):
  16     if request.getHeader('X-Miner-Extensions') is not None and 'workidentifier' in request.getHeader('X-Miner-Extensions').split(' '):
  17         return 0
  18     if request.getHeader('X-Work-Identifier') is not None:
  19         return 0
  20     user_agent = request.getHeader('User-Agent')
  21     user_agent2 = '' if user_agent is None else user_agent.lower()
  22     if 'java' in user_agent2 or 'diablominer' in user_agent2: return 0 # hopefully diablominer...
  23     if 'cpuminer' in user_agent2: return 0
  24     if 'tenebrix miner' in user_agent2: return 0
  25     if 'ufasoft' in user_agent2: return 0 # not confirmed
  26     if 'cgminer' in user_agent2: return 0
  27     if 'jansson' in user_agent2: return 0 # a version of optimized scrypt miner, once in Wuala. works fine here
  28     if 'poclbm' in user_agent2: return 1
  29     if 'phoenix' in user_agent2: return 2
  30     print 'Unknown miner User-Agent:', repr(user_agent)
  31     return 0
  32
  33 def get_max_target(request): # inclusive
  34     if request.getHeader('X-All-Targets') is not None or (request.getHeader('X-Miner-Extensions') is not None and 'alltargets' in request.getHeader('X-Miner-Extensions')):
  35         return 2**256-1
  36     user_agent = request.getHeader('User-Agent')
  37     user_agent2 = '' if user_agent is None else user_agent.lower()
  38     if 'java' in user_agent2 or 'diablominer' in user_agent2: return 2**256//2**32-1 # hopefully diablominer...
  39     if 'cpuminer' in user_agent2: return 2**256-1
  40     if 'tenebrix miner' in user_agent2: return 2**256-1
  41     if 'jansson' in user_agent2: return 2**256-1 # a version of optimized scrypt miner, once in Wuala. works fine here
  42     if 'cgminer' in user_agent2: return 2**256//2**32-1
  43     if 'poclbm' in user_agent2: return 2**256//2**32-1
  44     if 'phoenix' in user_agent2: return 2**256//2**32-1
  45     print 'Unknown miner User-Agent:', repr(user_agent)
  46     return 2**256//2**32-1
  47
  48 def get_username(request):
  49     try:
  50         return base64.b64decode(request.getHeader('Authorization').split(' ', 1)[1]).split(':')[0]
  51     except: # XXX
  52         return None
  53
  54 def get_id(request):
  55     return request.getClientIP(), request.getHeader('Authorization')
  56
  57 class Holds(object):
  58     def __init__(self):
  59         self.holds = {}
  60
  61     @defer.inlineCallbacks
  62     def wait_hold(self, request_id):
  63         while request_id in self.holds:
  64             yield self.holds[request_id].get_deferred()
  65
  66     def set_hold(self, request_id, dt):
  67         if request_id in self.holds:
  68             raise ValueError('hold already present!')
  69         self.holds[request_id] = variable.Event()
  70         self.holds[request_id].status = 0
  71         def cb():
  72             if self.holds[request_id].status != 0:
  73                 raise AssertionError()
  74             self.holds[request_id].status = 1
  75             self.holds.pop(request_id).happened()
  76         reactor.callLater(dt, cb)
  77
  78 class LongPollingWorkerInterface(deferred_resource.DeferredResource):
  79     def __init__(self, parent):
  80         self.parent = parent
  81
  82     @defer.inlineCallbacks
  83     def render_GET(self, request):
  84         request.setHeader('Content-Type', 'application/json')
  85         request.setHeader('X-Long-Polling', '/long-polling')
  86         request.setHeader('X-Roll-NTime', 'expire=60')
  87         try:
  88             try:
  89                 request.write(json.dumps({
  90                     'jsonrpc': '2.0',
  91                     'id': 0,
  92                     'result': (yield self.parent.getwork(request, long_poll=True)),
  93                     'error': None,
  94                 }))
  95             except jsonrpc.Error:
  96                 raise
  97             except Exception:
  98                 log.err(None, 'Squelched long polling error:')
  99                 raise jsonrpc.Error(-32099, u'Unknown error')
 100         except jsonrpc.Error, e:
 101             request.write(json.dumps({
 102                 'jsonrpc': '2.0',
 103                 'id': 0,
 104                 'result': None,
 105                 'error': e._to_obj(),
 106             }))
 107     render_POST = render_GET
 108
 109 class WorkerInterface(jsonrpc.Server):
 110     def __init__(self, compute, response_callback, new_work_event=variable.Event()):
 111         jsonrpc.Server.__init__(self)
 112
 113         self.compute = compute
 114         self.response_callback = response_callback
 115         self.new_work_event = new_work_event
 116
 117         self.holds = Holds()
 118         self.worker_views = {}
 119
 120         self.putChild('long-polling', LongPollingWorkerInterface(self))
 121         self.putChild('', self)
 122
 123     @defer.inlineCallbacks
 124     def rpc_getwork(self, request, data=None):
 125         request.setHeader('X-Long-Polling', '/long-polling')
 126         request.setHeader('X-Roll-NTime', 'expire=60')
 127
 128         if data is not None:
 129             defer.returnValue(self.response_callback(getwork.decode_data(data), request))
 130
 131         defer.returnValue((yield self.getwork(request)))
 132
 133     @defer.inlineCallbacks
 134     def getwork(self, request, long_poll=False):
 135         request_id = get_id(request)
 136         memory = get_memory(request)
 137
 138         id = random.randrange(10000)
 139         if p2pool.DEBUG:
 140             print 'POLL %i START long_poll=%r user_agent=%r x-work-identifier=%r user=%r' % (id, long_poll, request.getHeader('User-Agent'), request.getHeader('X-Work-Identifier'), get_username(request))
 141
 142         if request_id not in self.worker_views:
 143             self.worker_views[request_id] = variable.Variable((0, (None, None))) # times, (previous_block/-1, previous_block/-2)
 144
 145         thought_times, thought_work = self.worker_views[request_id].value
 146
 147         if long_poll and thought_times == self.new_work_event.times:
 148             if p2pool.DEBUG:
 149                 print 'POLL %i WAITING user=%r' % (id, get_username(request))
 150             yield defer.DeferredList([self.new_work_event.get_deferred(), self.worker_views[request_id].changed.get_deferred()], fireOnOneCallback=True)
 151
 152         yield self.holds.wait_hold(request_id)
 153
 154         res, identifier = self.compute(request)
 155
 156         if thought_work[-1] is not None and self.new_work_event.times != thought_times and any(x is None or res.previous_block == x for x in thought_work[-memory or len(thought_work):]):
 157             # clients won't believe the update
 158             res = res.update(previous_block=random.randrange(2**256))
 159             if p2pool.DEBUG:
 160                 print 'POLL %i FAKED user=%r' % (id, get_username(request))
 161             self.holds.set_hold(request_id, .01)
 162
 163         self.worker_views[request_id].set((self.new_work_event.times if long_poll else thought_times, (thought_work[-1], res.previous_block)))
 164         if p2pool.DEBUG:
 165             print 'POLL %i END %s user=%r' % (id, p2pool_data.format_hash(identifier), get_username(request)) # XXX identifier is hack
 166
 167         res = res.update(share_target=min(res.share_target, get_max_target(request)))
 168
 169         defer.returnValue(res.getwork(identifier=str(identifier)))