data_types.py 15.8 KB
Newer Older
1
import ctypes
2
import sympy as sp
3
import numpy as np
4
5
6
7
8
try:
    import llvmlite.ir as ir
except ImportError as e:
    ir = None
    _ir_importerror = e
9
from sympy.core.cache import cacheit
10

11
from pystencils.cache import memorycache
Martin Bauer's avatar
Martin Bauer committed
12
from pystencils.utils import all_equal
13

14

Martin Bauer's avatar
Martin Bauer committed
15
# to work in conditions of sp.Piecewise cast_func has to be of type Relational as well
Martin Bauer's avatar
Martin Bauer committed
16
class cast_func(sp.Function, sp.Rel):
17
18
19
20
21
22
    @property
    def canonical(self):
        if hasattr(self.args[0], 'canonical'):
            return self.args[0].canonical
        else:
            raise NotImplementedError()
23

24
25
26
27
    @property
    def is_commutative(self):
        return self.args[0].is_commutative

28

Martin Bauer's avatar
Martin Bauer committed
29
class pointer_arithmetic_func(sp.Function, sp.Rel):
30
31
32
33
34
35
36
37
    @property
    def canonical(self):
        if hasattr(self.args[0], 'canonical'):
            return self.args[0].canonical
        else:
            raise NotImplementedError()


38
class TypedSymbol(sp.Symbol):
Martin Bauer's avatar
Martin Bauer committed
39
40
    def __new__(cls, *args, **kwds):
        obj = TypedSymbol.__xnew_cached_(cls, *args, **kwds)
41
42
        return obj

43
    def __new_stage2__(cls, name, dtype):
44
        obj = super(TypedSymbol, cls).__xnew__(cls, name)
45
        try:
Martin Bauer's avatar
Martin Bauer committed
46
            obj._dtype = create_type(dtype)
47
48
49
        except TypeError:
            # on error keep the string
            obj._dtype = dtype
50
51
52
53
54
55
56
57
58
59
        return obj

    __xnew__ = staticmethod(__new_stage2__)
    __xnew_cached_ = staticmethod(cacheit(__new_stage2__))

    @property
    def dtype(self):
        return self._dtype

    def _hashable_content(self):
Martin Bauer's avatar
Martin Bauer committed
60
61
        super_class_contents = list(super(TypedSymbol, self)._hashable_content())
        return tuple(super_class_contents + [hash(self._dtype)])
62
63

    def __getnewargs__(self):
64
65
66
        return self.name, self.dtype


Martin Bauer's avatar
Martin Bauer committed
67
def create_type(specification):
Jan Hoenig's avatar
Jan Hoenig committed
68
69
70
71
72
    """
    Create a subclass of Type according to a string or an object of subclass Type
    :param specification: Type object, or a string
    :return: Type object, or a new Type object parsed from the string
    """
73
74
75
    if isinstance(specification, Type):
        return specification
    else:
Martin Bauer's avatar
Martin Bauer committed
76
77
78
        numpy_dtype = np.dtype(specification)
        if numpy_dtype.fields is None:
            return BasicType(numpy_dtype, const=False)
79
        else:
Martin Bauer's avatar
Martin Bauer committed
80
            return StructType(numpy_dtype, const=False)
81
82


83
@memorycache(maxsize=64)
Martin Bauer's avatar
Martin Bauer committed
84
def create_composite_type_from_string(specification):
Jan Hoenig's avatar
Jan Hoenig committed
85
86
87
88
89
    """
    Creates a new Type object from a c-like string specification
    :param specification: Specification string
    :return: Type object
    """
90
91
92
93
94
95
96
    specification = specification.lower().split()
    parts = []
    current = []
    for s in specification:
        if s == '*':
            parts.append(current)
            current = [s]
97
        else:
98
99
100
            current.append(s)
    if len(current) > 0:
        parts.append(current)
Jan Hoenig's avatar
Jan Hoenig committed
101
        # Parse native part
Martin Bauer's avatar
Martin Bauer committed
102
    base_part = parts.pop(0)
103
    const = False
Martin Bauer's avatar
Martin Bauer committed
104
    if 'const' in base_part:
105
        const = True
Martin Bauer's avatar
Martin Bauer committed
106
107
108
109
        base_part.remove('const')
    assert len(base_part) == 1
    if base_part[0][-1] == "*":
        base_part[0] = base_part[0][:-1]
Jan Hoenig's avatar
Jan Hoenig committed
110
        parts.append('*')
Martin Bauer's avatar
Martin Bauer committed
111
    current_type = BasicType(np.dtype(base_part[0]), const)
112
113
114
115
116
117
118
119
120
121
122
    # Parse pointer parts
    for part in parts:
        restrict = False
        const = False
        if 'restrict' in part:
            restrict = True
            part.remove('restrict')
        if 'const' in part:
            const = True
            part.remove("const")
        assert len(part) == 1 and part[0] == '*'
Martin Bauer's avatar
Martin Bauer committed
123
124
        current_type = PointerType(current_type, const, restrict)
    return current_type
125
126


Martin Bauer's avatar
Martin Bauer committed
127
128
129
130
def get_base_type(data_type):
    while data_type.base_type is not None:
        data_type = data_type.base_type
    return data_type
131
132


Martin Bauer's avatar
Martin Bauer committed
133
def to_ctypes(data_type):
Jan Hoenig's avatar
Jan Hoenig committed
134
135
    """
    Transforms a given Type into ctypes
Martin Bauer's avatar
Martin Bauer committed
136
    :param data_type: Subclass of Type
Jan Hoenig's avatar
Jan Hoenig committed
137
138
    :return: ctypes type object
    """
Martin Bauer's avatar
Martin Bauer committed
139
140
141
    if isinstance(data_type, PointerType):
        return ctypes.POINTER(to_ctypes(data_type.base_type))
    elif isinstance(data_type, StructType):
142
        return ctypes.POINTER(ctypes.c_uint8)
143
    else:
Martin Bauer's avatar
Martin Bauer committed
144
        return to_ctypes.map[data_type.numpy_dtype]
145

Martin Bauer's avatar
Martin Bauer committed
146
147

to_ctypes.map = {
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    np.dtype(np.int8): ctypes.c_int8,
    np.dtype(np.int16): ctypes.c_int16,
    np.dtype(np.int32): ctypes.c_int32,
    np.dtype(np.int64): ctypes.c_int64,

    np.dtype(np.uint8): ctypes.c_uint8,
    np.dtype(np.uint16): ctypes.c_uint16,
    np.dtype(np.uint32): ctypes.c_uint32,
    np.dtype(np.uint64): ctypes.c_uint64,

    np.dtype(np.float32): ctypes.c_float,
    np.dtype(np.float64): ctypes.c_double,
}


163
def ctypes_from_llvm(data_type):
164
165
    if not ir:
        raise _ir_importerror
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
    if isinstance(data_type, ir.PointerType):
        ctype = ctypes_from_llvm(data_type.pointee)
        if ctype is None:
            return ctypes.c_void_p
        else:
            return ctypes.POINTER(ctype)
    elif isinstance(data_type, ir.IntType):
        if data_type.width == 8:
            return ctypes.c_int8
        elif data_type.width == 16:
            return ctypes.c_int16
        elif data_type.width == 32:
            return ctypes.c_int32
        elif data_type.width == 64:
            return ctypes.c_int64
        else:
            raise ValueError("Int width %d is not supported" % data_type.width)
    elif isinstance(data_type, ir.FloatType):
        return ctypes.c_float
    elif isinstance(data_type, ir.DoubleType):
        return ctypes.c_double
    elif isinstance(data_type, ir.VoidType):
        return None  # Void type is not supported by ctypes
    else:
        raise NotImplementedError('Data type %s of %s is not supported yet' % (type(data_type), data_type))


def to_llvm_type(data_type):
    """
    Transforms a given type into ctypes
    :param data_type: Subclass of Type
    :return: llvmlite type object
    """
199
200
    if not ir:
        raise _ir_importerror
201
    if isinstance(data_type, PointerType):
Martin Bauer's avatar
Martin Bauer committed
202
        return to_llvm_type(data_type.base_type).as_pointer()
203
    else:
Martin Bauer's avatar
Martin Bauer committed
204
205
        return to_llvm_type.map[data_type.numpy_dtype]

206

207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
if ir:
    to_llvm_type.map = {
        np.dtype(np.int8): ir.IntType(8),
        np.dtype(np.int16): ir.IntType(16),
        np.dtype(np.int32): ir.IntType(32),
        np.dtype(np.int64): ir.IntType(64),

        np.dtype(np.uint8): ir.IntType(8),
        np.dtype(np.uint16): ir.IntType(16),
        np.dtype(np.uint32): ir.IntType(32),
        np.dtype(np.uint64): ir.IntType(64),

        np.dtype(np.float32): ir.FloatType(),
        np.dtype(np.float64): ir.DoubleType(),
    }
222

223

Martin Bauer's avatar
Martin Bauer committed
224
225
226
def peel_off_type(dtype, type_to_peel_off):
    while type(dtype) is type_to_peel_off:
        dtype = dtype.base_type
227
228
229
    return dtype


Martin Bauer's avatar
Martin Bauer committed
230
def collate_types(types):
231
232
233
234
235
236
237
    """
    Takes a sequence of types and returns their "common type" e.g. (float, double, float) -> double
    Uses the collation rules from numpy.
    """

    # Pointer arithmetic case i.e. pointer + integer is allowed
    if any(type(t) is PointerType for t in types):
Martin Bauer's avatar
Martin Bauer committed
238
        pointer_type = None
239
240
        for t in types:
            if type(t) is PointerType:
Martin Bauer's avatar
Martin Bauer committed
241
                if pointer_type is not None:
242
                    raise ValueError("Cannot collate the combination of two pointer types")
Martin Bauer's avatar
Martin Bauer committed
243
                pointer_type = t
244
245
246
247
248
            elif type(t) is BasicType:
                if not (t.is_int() or t.is_uint()):
                    raise ValueError("Invalid pointer arithmetic")
            else:
                raise ValueError("Invalid pointer arithmetic")
Martin Bauer's avatar
Martin Bauer committed
249
        return pointer_type
250
251

    # peel of vector types, if at least one vector type occurred the result will also be the vector type
Martin Bauer's avatar
Martin Bauer committed
252
    vector_type = [t for t in types if type(t) is VectorType]
Martin Bauer's avatar
Martin Bauer committed
253
    if not all_equal(t.width for t in vector_type):
254
        raise ValueError("Collation failed because of vector types with different width")
Martin Bauer's avatar
Martin Bauer committed
255
    types = [peel_off_type(t, VectorType) for t in types]
256
257
258
259
260

    # now we should have a list of basic types - struct types are not yet supported
    assert all(type(t) is BasicType for t in types)

    # use numpy collation -> create type from numpy type -> and, put vector type around if necessary
Martin Bauer's avatar
Martin Bauer committed
261
262
263
264
    result_numpy_type = np.result_type(*(t.numpy_dtype for t in types))
    result = BasicType(result_numpy_type)
    if vector_type:
        result = VectorType(result, vector_type[0].width)
265
266
267
268
    return result


@memorycache(maxsize=2048)
Martin Bauer's avatar
Martin Bauer committed
269
def get_type_of_expression(expr):
270
271
272
    from pystencils.astnodes import ResolvedFieldAccess
    expr = sp.sympify(expr)
    if isinstance(expr, sp.Integer):
Martin Bauer's avatar
Martin Bauer committed
273
        return create_type("int")
274
    elif isinstance(expr, sp.Rational) or isinstance(expr, sp.Float):
Martin Bauer's avatar
Martin Bauer committed
275
        return create_type("double")
276
277
278
    elif isinstance(expr, ResolvedFieldAccess):
        return expr.field.dtype
    elif isinstance(expr, TypedSymbol):
279
        return expr.dtype
280
281
    elif isinstance(expr, sp.Symbol):
        raise ValueError("All symbols inside this expression have to be typed!")
Martin Bauer's avatar
Martin Bauer committed
282
    elif hasattr(expr, 'func') and expr.func == cast_func:
283
284
        return expr.args[1]
    elif hasattr(expr, 'func') and expr.func == sp.Piecewise:
Martin Bauer's avatar
Martin Bauer committed
285
286
287
288
289
        collated_result_type = collate_types(tuple(get_type_of_expression(a[0]) for a in expr.args))
        collated_condition_type = collate_types(tuple(get_type_of_expression(a[1]) for a in expr.args))
        if type(collated_condition_type) is VectorType and type(collated_result_type) is not VectorType:
            collated_result_type = VectorType(collated_result_type, width=collated_condition_type.width)
        return collated_result_type
290
    elif isinstance(expr, sp.Indexed):
Martin Bauer's avatar
Martin Bauer committed
291
292
        typed_symbol = expr.base.label
        return typed_symbol.dtype.base_type
293
    elif isinstance(expr, sp.boolalg.Boolean) or isinstance(expr, sp.boolalg.BooleanFunction):
294
        # if any arg is of vector type return a vector boolean, else return a normal scalar boolean
Martin Bauer's avatar
Martin Bauer committed
295
296
297
298
        result = create_type("bool")
        vec_args = [get_type_of_expression(a) for a in expr.args if isinstance(get_type_of_expression(a), VectorType)]
        if vec_args:
            result = VectorType(result, width=vec_args[0].width)
299
        return result
300
    elif isinstance(expr, sp.Expr):
Martin Bauer's avatar
Martin Bauer committed
301
302
        types = tuple(get_type_of_expression(a) for a in expr.args)
        return collate_types(types)
303

304
    raise NotImplementedError("Could not determine type for", expr, type(expr))
305
306


307
308
309
class Type(sp.Basic):
    def __new__(cls, *args, **kwargs):
        return sp.Basic.__new__(cls)
310

311
312
    def _sympystr(self, *args, **kwargs):
        return str(self)
313
314
315
316


class BasicType(Type):
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
317
    def numpy_name_to_c(name):
Jan Hoenig's avatar
Jan Hoenig committed
318
319
320
321
        if name == 'float64':
            return 'double'
        elif name == 'float32':
            return 'float'
322
323
324
325
        elif name.startswith('int'):
            width = int(name[len("int"):])
            return "int%d_t" % (width,)
        elif name.startswith('uint'):
326
            width = int(name[len("uint"):])
327
328
329
330
331
332
333
334
            return "uint%d_t" % (width,)
        elif name == 'bool':
            return 'bool'
        else:
            raise NotImplemented("Can map numpy to C name for %s" % (name,))

    def __init__(self, dtype, const=False):
        self.const = const
335
        if isinstance(dtype, Type):
Martin Bauer's avatar
Martin Bauer committed
336
            self._dtype = dtype.numpy_dtype
337
338
        else:
            self._dtype = np.dtype(dtype)
339
340
341
342
        assert self._dtype.fields is None, "Tried to initialize NativeType with a structured type"
        assert self._dtype.hasobject is False
        assert self._dtype.subdtype is None

343
    def __getnewargs__(self):
Martin Bauer's avatar
Martin Bauer committed
344
        return self.numpy_dtype, self.const
345

346
    @property
Martin Bauer's avatar
Martin Bauer committed
347
    def base_type(self):
348
        return None
349

350
    @property
Martin Bauer's avatar
Martin Bauer committed
351
    def numpy_dtype(self):
352
353
        return self._dtype

354
    @property
Martin Bauer's avatar
Martin Bauer committed
355
    def item_size(self):
356
357
        return 1

358
    def is_int(self):
Martin Bauer's avatar
Martin Bauer committed
359
        return self.numpy_dtype in np.sctypes['int']
360
361

    def is_float(self):
Martin Bauer's avatar
Martin Bauer committed
362
        return self.numpy_dtype in np.sctypes['float']
363
364

    def is_uint(self):
Martin Bauer's avatar
Martin Bauer committed
365
        return self.numpy_dtype in np.sctypes['uint']
366

Martin Bauer's avatar
Martin Bauer committed
367
368
    def is_complex(self):
        return self.numpy_dtype in np.sctypes['complex']
369
370

    def is_other(self):
Martin Bauer's avatar
Martin Bauer committed
371
        return self.numpy_dtype in np.sctypes['others']
372

373
    @property
Martin Bauer's avatar
Martin Bauer committed
374
375
    def base_name(self):
        return BasicType.numpy_name_to_c(str(self._dtype))
376

Jan Hoenig's avatar
Jan Hoenig committed
377
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
378
        result = BasicType.numpy_name_to_c(str(self._dtype))
379
380
381
        if self.const:
            result += " const"
        return result
Jan Hoenig's avatar
Jan Hoenig committed
382

383
384
385
    def __repr__(self):
        return str(self)

Jan Hoenig's avatar
Jan Hoenig committed
386
    def __eq__(self, other):
387
388
        if not isinstance(other, BasicType):
            return False
Jan Hoenig's avatar
Jan Hoenig committed
389
        else:
Martin Bauer's avatar
Martin Bauer committed
390
            return (self.numpy_dtype, self.const) == (other.numpy_dtype, other.const)
391
392
393
394
395

    def __hash__(self):
        return hash(str(self))


396
class VectorType(Type):
Martin Bauer's avatar
Martin Bauer committed
397
    instruction_set = None
398

Martin Bauer's avatar
Martin Bauer committed
399
400
    def __init__(self, base_type, width=4):
        self._base_type = base_type
401
402
403
        self.width = width

    @property
Martin Bauer's avatar
Martin Bauer committed
404
405
    def base_type(self):
        return self._base_type
406
407

    @property
Martin Bauer's avatar
Martin Bauer committed
408
409
    def item_size(self):
        return self.width * self.base_type.item_size
410
411
412
413
414

    def __eq__(self, other):
        if not isinstance(other, VectorType):
            return False
        else:
Martin Bauer's avatar
Martin Bauer committed
415
            return (self.base_type, self.width) == (other.base_type, other.width)
416
417

    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
418
        if self.instruction_set is None:
Martin Bauer's avatar
Martin Bauer committed
419
            return "%s[%d]" % (self.base_type, self.width)
420
        else:
Martin Bauer's avatar
Martin Bauer committed
421
            if self.base_type == create_type("int64"):
Martin Bauer's avatar
Martin Bauer committed
422
                return self.instruction_set['int']
Martin Bauer's avatar
Martin Bauer committed
423
            elif self.base_type == create_type("float64"):
Martin Bauer's avatar
Martin Bauer committed
424
                return self.instruction_set['double']
Martin Bauer's avatar
Martin Bauer committed
425
            elif self.base_type == create_type("float32"):
Martin Bauer's avatar
Martin Bauer committed
426
                return self.instruction_set['float']
Martin Bauer's avatar
Martin Bauer committed
427
            elif self.base_type == create_type("bool"):
Martin Bauer's avatar
Martin Bauer committed
428
                return self.instruction_set['bool']
429
430
431
432
            else:
                raise NotImplementedError()

    def __hash__(self):
Martin Bauer's avatar
Martin Bauer committed
433
        return hash((self.base_type, self.width))
434
435


436
class PointerType(Type):
Martin Bauer's avatar
Martin Bauer committed
437
438
    def __init__(self, base_type, const=False, restrict=True):
        self._base_type = base_type
439
440
441
        self.const = const
        self.restrict = restrict

442
    def __getnewargs__(self):
Martin Bauer's avatar
Martin Bauer committed
443
        return self.base_type, self.const, self.restrict
444

445
446
447
448
449
    @property
    def alias(self):
        return not self.restrict

    @property
Martin Bauer's avatar
Martin Bauer committed
450
451
    def base_type(self):
        return self._base_type
452

453
    @property
Martin Bauer's avatar
Martin Bauer committed
454
455
    def item_size(self):
        return self.base_type.item_size
456

457
458
    def __eq__(self, other):
        if not isinstance(other, PointerType):
Jan Hoenig's avatar
Jan Hoenig committed
459
            return False
460
        else:
Martin Bauer's avatar
Martin Bauer committed
461
            return (self.base_type, self.const, self.restrict) == (other.base_type, other.const, other.restrict)
462

Jan Hoenig's avatar
Jan Hoenig committed
463
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
464
        return "%s *%s%s" % (self.base_type, " RESTRICT " if self.restrict else "", " const " if self.const else "")
465

466
467
468
    def __repr__(self):
        return str(self)

469
    def __hash__(self):
Martin Bauer's avatar
Martin Bauer committed
470
        return hash((self._base_type, self.const, self.restrict))
471

Jan Hoenig's avatar
Jan Hoenig committed
472

473
class StructType(object):
Martin Bauer's avatar
Martin Bauer committed
474
    def __init__(self, numpy_type, const=False):
475
        self.const = const
Martin Bauer's avatar
Martin Bauer committed
476
        self._dtype = np.dtype(numpy_type)
Martin Bauer's avatar
Martin Bauer committed
477

478
    def __getnewargs__(self):
Martin Bauer's avatar
Martin Bauer committed
479
        return self.numpy_dtype, self.const
480

481
    @property
Martin Bauer's avatar
Martin Bauer committed
482
    def base_type(self):
483
484
485
        return None

    @property
Martin Bauer's avatar
Martin Bauer committed
486
    def numpy_dtype(self):
487
488
489
        return self._dtype

    @property
Martin Bauer's avatar
Martin Bauer committed
490
491
    def item_size(self):
        return self.numpy_dtype.itemsize
492

Martin Bauer's avatar
Martin Bauer committed
493
494
    def get_element_offset(self, element_name):
        return self.numpy_dtype.fields[element_name][1]
495

Martin Bauer's avatar
Martin Bauer committed
496
497
498
    def get_element_type(self, element_name):
        np_element_type = self.numpy_dtype.fields[element_name][0]
        return BasicType(np_element_type, self.const)
499

Martin Bauer's avatar
Martin Bauer committed
500
501
    def has_element(self, element_name):
        return element_name in self.numpy_dtype.fields
502

503
504
505
506
    def __eq__(self, other):
        if not isinstance(other, StructType):
            return False
        else:
Martin Bauer's avatar
Martin Bauer committed
507
            return (self.numpy_dtype, self.const) == (other.numpy_dtype, other.const)
508
509
510
511
512
513
514
515

    def __str__(self):
        # structs are handled byte-wise
        result = "uint8_t"
        if self.const:
            result += " const"
        return result

516
517
518
    def __repr__(self):
        return str(self)

519
    def __hash__(self):
Martin Bauer's avatar
Martin Bauer committed
520
        return hash((self.numpy_dtype, self.const))