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     def packed_size(self, obj):
  80         if hasattr(obj, '_packed_size') and obj._packed_size is not None:
  81             type_obj, packed_size = obj._packed_size
  82             if type_obj is self:
  83                 return packed_size
  84
  85         packed_size = len(self.pack(obj))
  86
  87         if hasattr(obj, '_packed_size'):
  88             obj._packed_size = self, packed_size
  89
  90         return packed_size
  91
  92 class VarIntType(Type):
  93     def read(self, file):
  94         data, file = read(file, 1)
  95         first = ord(data)
  96         if first < 0xfd:
  97             return first, file
  98         if first == 0xfd:
  99             desc, length, minimum = '<H', 2, 0xfd
 100         elif first == 0xfe:
 101             desc, length, minimum = '<I', 4, 2**16
 102         elif first == 0xff:
 103             desc, length, minimum = '<Q', 8, 2**32
 104         else:
 105             raise AssertionError()
 106         data2, file = read(file, length)
 107         res, = struct.unpack(desc, data2)
 108         if res < minimum:
 109             raise AssertionError('VarInt not canonically packed')
 110         return res, file
 111
 112     def write(self, file, item):
 113         if item < 0xfd:
 114             return file, struct.pack('<B', item)
 115         elif item <= 0xffff:
 116             return file, struct.pack('<BH', 0xfd, item)
 117         elif item <= 0xffffffff:
 118             return file, struct.pack('<BI', 0xfe, item)
 119         elif item <= 0xffffffffffffffff:
 120             return file, struct.pack('<BQ', 0xff, item)
 121         else:
 122             raise ValueError('int too large for varint')
 123
 124 class VarStrType(Type):
 125     _inner_size = VarIntType()
 126
 127     def read(self, file):
 128         length, file = self._inner_size.read(file)
 129         return read(file, length)
 130
 131     def write(self, file, item):
 132         return self._inner_size.write(file, len(item)), item
 133
 134 class EnumType(Type):
 135     def __init__(self, inner, pack_to_unpack):
 136         self.inner = inner
 137         self.pack_to_unpack = pack_to_unpack
 138
 139         self.unpack_to_pack = {}
 140         for k, v in pack_to_unpack.iteritems():
 141             if v in self.unpack_to_pack:
 142                 raise ValueError('duplicate value in pack_to_unpack')
 143             self.unpack_to_pack[v] = k
 144
 145     def read(self, file):
 146         data, file = self.inner.read(file)
 147         if data not in self.pack_to_unpack:
 148             raise ValueError('enum data (%r) not in pack_to_unpack (%r)' % (data, self.pack_to_unpack))
 149         return self.pack_to_unpack[data], file
 150
 151     def write(self, file, item):
 152         if item not in self.unpack_to_pack:
 153             raise ValueError('enum item (%r) not in unpack_to_pack (%r)' % (item, self.unpack_to_pack))
 154         return self.inner.write(file, self.unpack_to_pack[item])
 155
 156 class ListType(Type):
 157     _inner_size = VarIntType()
 158
 159     def __init__(self, type):
 160         self.type = type
 161
 162     def read(self, file):
 163         length, file = self._inner_size.read(file)
 164         res = []
 165         for i in xrange(length):
 166             item, file = self.type.read(file)
 167             res.append(item)
 168         return res, file
 169
 170     def write(self, file, item):
 171         file = self._inner_size.write(file, len(item))
 172         for subitem in item:
 173             file = self.type.write(file, subitem)
 174         return file
 175
 176 class StructType(Type):
 177     __slots__ = 'desc length'.split(' ')
 178
 179     def __init__(self, desc):
 180         self.desc = desc
 181         self.length = struct.calcsize(self.desc)
 182
 183     def read(self, file):
 184         data, file = read(file, self.length)
 185         return struct.unpack(self.desc, data)[0], file
 186
 187     def write(self, file, item):
 188         return file, struct.pack(self.desc, item)
 189
 190 class IntType(Type):
 191     __slots__ = 'bytes step format_str max'.split(' ')
 192
 193     def __new__(cls, bits, endianness='little'):
 194         assert bits % 8 == 0
 195         assert endianness in ['little', 'big']
 196         if bits in [8, 16, 32, 64]:
 197             return StructType(('<' if endianness == 'little' else '>') + {8: 'B', 16: 'H', 32: 'I', 64: 'Q'}[bits])
 198         else:
 199             return Type.__new__(cls, bits, endianness)
 200
 201     def __init__(self, bits, endianness='little'):
 202         assert bits % 8 == 0
 203         assert endianness in ['little', 'big']
 204         self.bytes = bits//8
 205         self.step = -1 if endianness == 'little' else 1
 206         self.format_str = '%%0%ix' % (2*self.bytes)
 207         self.max = 2**bits
 208
 209     def read(self, file, b2a_hex=binascii.b2a_hex):
 210         if self.bytes == 0:
 211             return 0, file
 212         data, file = read(file, self.bytes)
 213         return int(b2a_hex(data[::self.step]), 16), file
 214
 215     def write(self, file, item, a2b_hex=binascii.a2b_hex):
 216         if self.bytes == 0:
 217             return file
 218         if not 0 <= item < self.max:
 219             raise ValueError('invalid int value - %r' % (item,))
 220         return file, a2b_hex(self.format_str % (item,))[::self.step]
 221
 222 class IPV6AddressType(Type):
 223     def read(self, file):
 224         data, file = read(file, 16)
 225         if data[:12] == '00000000000000000000ffff'.decode('hex'):
 226             return '.'.join(str(ord(x)) for x in data[12:]), file
 227         return ':'.join(data[i*2:(i+1)*2].encode('hex') for i in xrange(8)), file
 228
 229     def write(self, file, item):
 230         if ':' in item:
 231             data = ''.join(item.replace(':', '')).decode('hex')
 232         else:
 233             bits = map(int, item.split('.'))
 234             if len(bits) != 4:
 235                 raise ValueError('invalid address: %r' % (bits,))
 236             data = '00000000000000000000ffff'.decode('hex') + ''.join(chr(x) for x in bits)
 237         assert len(data) == 16, len(data)
 238         return file, data
 239
 240 _record_types = {}
 241
 242 def get_record(fields):
 243     fields = tuple(sorted(fields))
 244     if 'keys' in fields or '_packed_size' in fields:
 245         raise ValueError()
 246     if fields not in _record_types:
 247         class _Record(object):
 248             __slots__ = fields + ('_packed_size',)
 249             def __init__(self):
 250                 self._packed_size = None
 251             def __repr__(self):
 252                 return repr(dict(self))
 253             def __getitem__(self, key):
 254                 return getattr(self, key)
 255             def __setitem__(self, key, value):
 256                 setattr(self, key, value)
 257             #def __iter__(self):
 258             #    for field in fields:
 259             #        yield field, getattr(self, field)
 260             def keys(self):
 261                 return fields
 262             def get(self, key, default=None):
 263                 return getattr(self, key, default)
 264             def __eq__(self, other):
 265                 if isinstance(other, dict):
 266                     return dict(self) == other
 267                 elif isinstance(other, _Record):
 268                     return all(self[k] == other[k] for k in self.keys())
 269                 elif other is None:
 270                     return False
 271                 raise TypeError()
 272             def __ne__(self, other):
 273                 return not (self == other)
 274         _record_types[fields] = _Record
 275     return _record_types[fields]()
 276
 277 class ComposedType(Type):
 278     def __init__(self, fields):
 279         self.fields = tuple(fields)
 280         self.field_names = set(k for k, v in fields)
 281
 282     def read(self, file):
 283         item = get_record(k for k, v in self.fields)
 284         for key, type_ in self.fields:
 285             item[key], file = type_.read(file)
 286         return item, file
 287
 288     def write(self, file, item):
 289         assert set(item.keys()) == self.field_names, (set(item.keys()) - self.field_names, self.field_names - set(item.keys()))
 290         for key, type_ in self.fields:
 291             file = type_.write(file, item[key])
 292         return file
 293
 294 class PossiblyNoneType(Type):
 295     def __init__(self, none_value, inner):
 296         self.none_value = none_value
 297         self.inner = inner
 298
 299     def read(self, file):
 300         value, file = self.inner.read(file)
 301         return None if value == self.none_value else value, file
 302
 303     def write(self, file, item):
 304         if item == self.none_value:
 305             raise ValueError('none_value used')
 306         return self.inner.write(file, self.none_value if item is None else item)
 307
 308 class FixedStrType(Type):
 309     def __init__(self, length):
 310         self.length = length
 311
 312     def read(self, file):
 313         return read(file, self.length)
 314
 315     def write(self, file, item):
 316         if len(item) != self.length:
 317             raise ValueError('incorrect length item!')
 318         return file, item