p2pool/util/pack.py

   1 import binascii
   2 import struct
   3
   4 import p2pool
   5
   6 class EarlyEnd(Exception):
   7     pass
   8
   9 class LateEnd(Exception):
  10     pass
  11
  12 def read((data, pos), length):
  13     data2 = data[pos:pos + length]
  14     if len(data2) != length:
  15         raise EarlyEnd()
  16     return data2, (data, pos + length)
  17
  18 def size((data, pos)):
  19     return len(data) - pos
  20
  21 class Type(object):
  22     __slots__ = []
  23
  24     def __hash__(self):
  25         rval = getattr(self, '_hash', None)
  26         if rval is None:
  27             try:
  28                 rval = self._hash = hash((type(self), frozenset(self.__dict__.items())))
  29             except:
  30                 print self.__dict__
  31                 raise
  32         return rval
  33
  34     def __eq__(self, other):
  35         return type(other) is type(self) and other.__dict__ == self.__dict__
  36
  37     def __ne__(self, other):
  38         return not (self == other)
  39
  40     def _unpack(self, data):
  41         obj, (data2, pos) = self.read((data, 0))
  42
  43         assert data2 is data
  44
  45         if pos != len(data):
  46             raise LateEnd()
  47
  48         return obj
  49
  50     def _pack(self, obj):
  51         f = self.write(None, obj)
  52
  53         res = []
  54         while f is not None:
  55             res.append(f[1])
  56             f = f[0]
  57         res.reverse()
  58         return ''.join(res)
  59
  60
  61     def unpack(self, data):
  62         obj = self._unpack(data)
  63
  64         if p2pool.DEBUG:
  65             if self._pack(obj) != data:
  66                 raise AssertionError()
  67
  68         return obj
  69
  70     def pack(self, obj):
  71         data = self._pack(obj)
  72
  73         if p2pool.DEBUG:
  74             if self._unpack(data) != obj:
  75                 raise AssertionError((self._unpack(data), obj))
  76
  77         return data
  78
  79 class VarIntType(Type):
  80     def read(self, file):
  81         data, file = read(file, 1)
  82         first = ord(data)
  83         if first < 0xfd:
  84             return first, file
  85         if first == 0xfd:
  86             desc, length, minimum = '<H', 2, 0xfd
  87         elif first == 0xfe:
  88             desc, length, minimum = '<I', 4, 2**16
  89         elif first == 0xff:
  90             desc, length, minimum = '<Q', 8, 2**32
  91         else:
  92             raise AssertionError()
  93         data2, file = read(file, length)
  94         res, = struct.unpack(desc, data2)
  95         if res < minimum:
  96             raise AssertionError('VarInt not canonically packed')
  97         return res, file
  98
  99     def write(self, file, item):
 100         if item < 0xfd:
 101             return file, struct.pack('<B', item)
 102         elif item <= 0xffff:
 103             return file, struct.pack('<BH', 0xfd, item)
 104         elif item <= 0xffffffff:
 105             return file, struct.pack('<BI', 0xfe, item)
 106         elif item <= 0xffffffffffffffff:
 107             return file, struct.pack('<BQ', 0xff, item)
 108         else:
 109             raise ValueError('int too large for varint')
 110
 111 class VarStrType(Type):
 112     _inner_size = VarIntType()
 113
 114     def read(self, file):
 115         length, file = self._inner_size.read(file)
 116         return read(file, length)
 117
 118     def write(self, file, item):
 119         return self._inner_size.write(file, len(item)), item
 120
 121 class EnumType(Type):
 122     def __init__(self, inner, pack_to_unpack):
 123         self.inner = inner
 124         self.pack_to_unpack = pack_to_unpack
 125
 126         self.unpack_to_pack = {}
 127         for k, v in pack_to_unpack.iteritems():
 128             if v in self.unpack_to_pack:
 129                 raise ValueError('duplicate value in pack_to_unpack')
 130             self.unpack_to_pack[v] = k
 131
 132     def read(self, file):
 133         data, file = self.inner.read(file)
 134         if data not in self.pack_to_unpack:
 135             raise ValueError('enum data (%r) not in pack_to_unpack (%r)' % (data, self.pack_to_unpack))
 136         return self.pack_to_unpack[data], file
 137
 138     def write(self, file, item):
 139         if item not in self.unpack_to_pack:
 140             raise ValueError('enum item (%r) not in unpack_to_pack (%r)' % (item, self.unpack_to_pack))
 141         return self.inner.write(file, self.unpack_to_pack[item])
 142
 143 class ListType(Type):
 144     _inner_size = VarIntType()
 145
 146     def __init__(self, type):
 147         self.type = type
 148
 149     def read(self, file):
 150         length, file = self._inner_size.read(file)
 151         res = []
 152         for i in xrange(length):
 153             item, file = self.type.read(file)
 154             res.append(item)
 155         return res, file
 156
 157     def write(self, file, item):
 158         file = self._inner_size.write(file, len(item))
 159         for subitem in item:
 160             file = self.type.write(file, subitem)
 161         return file
 162
 163 class StructType(Type):
 164     __slots__ = 'desc length'.split(' ')
 165
 166     def __init__(self, desc):
 167         self.desc = desc
 168         self.length = struct.calcsize(self.desc)
 169
 170     def read(self, file):
 171         data, file = read(file, self.length)
 172         return struct.unpack(self.desc, data)[0], file
 173
 174     def write(self, file, item):
 175         return file, struct.pack(self.desc, item)
 176
 177 class IntType(Type):
 178     __slots__ = 'bytes step format_str max'.split(' ')
 179
 180     def __new__(cls, bits, endianness='little'):
 181         assert bits % 8 == 0
 182         assert endianness in ['little', 'big']
 183         if bits in [8, 16, 32, 64]:
 184             return StructType(('<' if endianness == 'little' else '>') + {8: 'B', 16: 'H', 32: 'I', 64: 'Q'}[bits])
 185         else:
 186             return Type.__new__(cls, bits, endianness)
 187
 188     def __init__(self, bits, endianness='little'):
 189         assert bits % 8 == 0
 190         assert endianness in ['little', 'big']
 191         self.bytes = bits//8
 192         self.step = -1 if endianness == 'little' else 1
 193         self.format_str = '%%0%ix' % (2*self.bytes)
 194         self.max = 2**bits
 195
 196     def read(self, file, b2a_hex=binascii.b2a_hex):
 197         if self.bytes == 0:
 198             return 0, file
 199         data, file = read(file, self.bytes)
 200         return int(b2a_hex(data[::self.step]), 16), file
 201
 202     def write(self, file, item, a2b_hex=binascii.a2b_hex):
 203         if self.bytes == 0:
 204             return file
 205         if not 0 <= item < self.max:
 206             raise ValueError('invalid int value - %r' % (item,))
 207         return file, a2b_hex(self.format_str % (item,))[::self.step]
 208
 209 class IPV6AddressType(Type):
 210     def read(self, file):
 211         data, file = read(file, 16)
 212         if data[:12] == '00000000000000000000ffff'.decode('hex'):
 213             return '.'.join(str(ord(x)) for x in data[12:]), file
 214         return ':'.join(data[i*2:(i+1)*2].encode('hex') for i in xrange(8)), file
 215
 216     def write(self, file, item):
 217         if ':' in item:
 218             data = ''.join(item.replace(':', '')).decode('hex')
 219         else:
 220             bits = map(int, item.split('.'))
 221             if len(bits) != 4:
 222                 raise ValueError('invalid address: %r' % (bits,))
 223             data = '00000000000000000000ffff'.decode('hex') + ''.join(chr(x) for x in bits)
 224         assert len(data) == 16, len(data)
 225         return file, data
 226
 227 _record_types = {}
 228
 229 def get_record(fields):
 230     fields = tuple(sorted(fields))
 231     if 'keys' in fields:
 232         raise ValueError()
 233     if fields not in _record_types:
 234         class _Record(object):
 235             __slots__ = fields
 236             def __repr__(self):
 237                 return repr(dict(self))
 238             def __getitem__(self, key):
 239                 return getattr(self, key)
 240             def __setitem__(self, key, value):
 241                 setattr(self, key, value)
 242             #def __iter__(self):
 243             #    for field in self.__slots__:
 244             #        yield field, getattr(self, field)
 245             def keys(self):
 246                 return self.__slots__
 247             def get(self, key, default=None):
 248                 return getattr(self, key, default)
 249             def __eq__(self, other):
 250                 if isinstance(other, dict):
 251                     return dict(self) == other
 252                 elif isinstance(other, _Record):
 253                     return all(self[k] == other[k] for k in self.keys())
 254                 elif other is None:
 255                     return False
 256                 raise TypeError()
 257             def __ne__(self, other):
 258                 return not (self == other)
 259         _record_types[fields] = _Record
 260     return _record_types[fields]()
 261
 262 class ComposedType(Type):
 263     def __init__(self, fields):
 264         self.fields = tuple(fields)
 265         self.field_names = set(k for k, v in fields)
 266
 267     def read(self, file):
 268         item = get_record(k for k, v in self.fields)
 269         for key, type_ in self.fields:
 270             item[key], file = type_.read(file)
 271         return item, file
 272
 273     def write(self, file, item):
 274         assert set(item.keys()) == self.field_names, (set(item.keys()) - self.field_names, self.field_names - set(item.keys()))
 275         for key, type_ in self.fields:
 276             file = type_.write(file, item[key])
 277         return file
 278
 279 class PossiblyNoneType(Type):
 280     def __init__(self, none_value, inner):
 281         self.none_value = none_value
 282         self.inner = inner
 283
 284     def read(self, file):
 285         value, file = self.inner.read(file)
 286         return None if value == self.none_value else value, file
 287
 288     def write(self, file, item):
 289         if item == self.none_value:
 290             raise ValueError('none_value used')
 291         return self.inner.write(file, self.none_value if item is None else item)
 292
 293 class FixedStrType(Type):
 294     def __init__(self, length):
 295         self.length = length
 296
 297     def read(self, file):
 298         return read(file, self.length)
 299
 300     def write(self, file, item):
 301         if len(item) != self.length:
 302             raise ValueError('incorrect length item!')
 303         return file, item