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, values):
 123         self.inner = inner
 124         self.values = values
 125
 126         keys = {}
 127         for k, v in values.iteritems():
 128             if v in keys:
 129                 raise ValueError('duplicate value in values')
 130             keys[v] = k
 131         self.keys = keys
 132
 133     def read(self, file):
 134         data, file = self.inner.read(file)
 135         if data not in self.keys:
 136             raise ValueError('enum data (%r) not in values (%r)' % (data, self.values))
 137         return self.keys[data], file
 138
 139     def write(self, file, item):
 140         if item not in self.values:
 141             raise ValueError('enum item (%r) not in values (%r)' % (item, self.values))
 142         return self.inner.write(file, self.values[item])
 143
 144 class ListType(Type):
 145     _inner_size = VarIntType()
 146
 147     def __init__(self, type):
 148         self.type = type
 149
 150     def read(self, file):
 151         length, file = self._inner_size.read(file)
 152         res = []
 153         for i in xrange(length):
 154             item, file = self.type.read(file)
 155             res.append(item)
 156         return res, file
 157
 158     def write(self, file, item):
 159         file = self._inner_size.write(file, len(item))
 160         for subitem in item:
 161             file = self.type.write(file, subitem)
 162         return file
 163
 164 class StructType(Type):
 165     __slots__ = 'desc length'.split(' ')
 166
 167     def __init__(self, desc):
 168         self.desc = desc
 169         self.length = struct.calcsize(self.desc)
 170
 171     def read(self, file):
 172         data, file = read(file, self.length)
 173         return struct.unpack(self.desc, data)[0], file
 174
 175     def write(self, file, item):
 176         return file, struct.pack(self.desc, item)
 177
 178 class IntType(Type):
 179     __slots__ = 'bytes step format_str max'.split(' ')
 180
 181     def __new__(cls, bits, endianness='little'):
 182         assert bits % 8 == 0
 183         assert endianness in ['little', 'big']
 184         if bits in [8, 16, 32, 64]:
 185             return StructType(('<' if endianness == 'little' else '>') + {8: 'B', 16: 'H', 32: 'I', 64: 'Q'}[bits])
 186         else:
 187             return Type.__new__(cls, bits, endianness)
 188
 189     def __init__(self, bits, endianness='little'):
 190         assert bits % 8 == 0
 191         assert endianness in ['little', 'big']
 192         self.bytes = bits//8
 193         self.step = -1 if endianness == 'little' else 1
 194         self.format_str = '%%0%ix' % (2*self.bytes)
 195         self.max = 2**bits
 196
 197     def read(self, file, b2a_hex=binascii.b2a_hex):
 198         data, file = read(file, self.bytes)
 199         return int(b2a_hex(data[::self.step]), 16), file
 200
 201     def write(self, file, item, a2b_hex=binascii.a2b_hex):
 202         if not 0 <= item < self.max:
 203             raise ValueError('invalid int value - %r' % (item,))
 204         return file, a2b_hex(self.format_str % (item,))[::self.step]
 205
 206 class IPV6AddressType(Type):
 207     def read(self, file):
 208         data, file = read(file, 16)
 209         if data[:12] != '00000000000000000000ffff'.decode('hex'):
 210             raise ValueError('ipv6 addresses not supported yet')
 211         return '.'.join(str(ord(x)) for x in data[12:]), file
 212
 213     def write(self, file, item):
 214         bits = map(int, item.split('.'))
 215         if len(bits) != 4:
 216             raise ValueError('invalid address: %r' % (bits,))
 217         data = '00000000000000000000ffff'.decode('hex') + ''.join(chr(x) for x in bits)
 218         assert len(data) == 16, len(data)
 219         return file, data
 220
 221 _record_types = {}
 222
 223 def get_record(fields):
 224     fields = tuple(sorted(fields))
 225     if 'keys' in fields:
 226         raise ValueError()
 227     if fields not in _record_types:
 228         class _Record(object):
 229             __slots__ = fields
 230             def __repr__(self):
 231                 return repr(dict(self))
 232             def __getitem__(self, key):
 233                 return getattr(self, key)
 234             def __setitem__(self, key, value):
 235                 setattr(self, key, value)
 236             #def __iter__(self):
 237             #    for field in self.__slots__:
 238             #        yield field, getattr(self, field)
 239             def keys(self):
 240                 return self.__slots__
 241             def get(self, key, default=None):
 242                 return getattr(self, key, default)
 243             def __eq__(self, other):
 244                 if isinstance(other, dict):
 245                     return dict(self) == other
 246                 elif isinstance(other, _Record):
 247                     return all(self[k] == other[k] for k in self.keys())
 248                 raise TypeError()
 249             def __ne__(self, other):
 250                 return not (self == other)
 251         _record_types[fields] = _Record
 252     return _record_types[fields]()
 253
 254 class ComposedType(Type):
 255     def __init__(self, fields):
 256         self.fields = tuple(fields)
 257         self.field_names = set(k for k, v in fields)
 258
 259     def read(self, file):
 260         item = get_record(k for k, v in self.fields)
 261         for key, type_ in self.fields:
 262             item[key], file = type_.read(file)
 263         return item, file
 264
 265     def write(self, file, item):
 266         assert set(item.keys()) == self.field_names
 267         for key, type_ in self.fields:
 268             file = type_.write(file, item[key])
 269         return file
 270
 271 class PossiblyNoneType(Type):
 272     def __init__(self, none_value, inner):
 273         self.none_value = none_value
 274         self.inner = inner
 275
 276     def read(self, file):
 277         value, file = self.inner.read(file)
 278         return None if value == self.none_value else value, file
 279
 280     def write(self, file, item):
 281         if item == self.none_value:
 282             raise ValueError('none_value used')
 283         return self.inner.write(file, self.none_value if item is None else item)
 284
 285 class FixedStrType(Type):
 286     def __init__(self, length):
 287         self.length = length
 288
 289     def read(self, file):
 290         return read(file, self.length)
 291
 292     def write(self, file, item):
 293         if len(item) != self.length:
 294             raise ValueError('incorrect length item!')
 295         return file, item