data_types.py 17.4 KB
Newer Older
1
import ctypes
2
import sympy as sp
3
import numpy as np
4
import llvmlite.ir as ir
5
from sympy.core.cache import cacheit
6

7
from pystencils.cache import memorycache
8
9
from pystencils.utils import allEqual

10
11
12
13
14
15
16
17
18
19

# to work in conditions of sp.Piecewise castFunc has to be of type Relational as well
class castFunc(sp.Function, sp.Rel):

    @property
    def canonical(self):
        if hasattr(self.args[0], 'canonical'):
            return self.args[0].canonical
        else:
            raise NotImplementedError()
20
21


22
23
24
25
26
27
28
29
30
31
class pointerArithmeticFunc(sp.Function, sp.Rel):

    @property
    def canonical(self):
        if hasattr(self.args[0], 'canonical'):
            return self.args[0].canonical
        else:
            raise NotImplementedError()


32
class TypedSymbol(sp.Symbol):
Martin Bauer's avatar
Martin Bauer committed
33
34
    def __new__(cls, *args, **kwds):
        obj = TypedSymbol.__xnew_cached_(cls, *args, **kwds)
35
36
        return obj

37
    def __new_stage2__(cls, name, dtype):
38
        obj = super(TypedSymbol, cls).__xnew__(cls, name)
39
40
41
42
43
        try:
            obj._dtype = createType(dtype)
        except TypeError:
            # on error keep the string
            obj._dtype = dtype
44
45
46
47
48
49
50
51
52
53
54
        return obj

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

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

    def _hashable_content(self):
        superClassContents = list(super(TypedSymbol, self)._hashable_content())
55
        return tuple(superClassContents + [hash(str(self._dtype))])
56
57

    def __getnewargs__(self):
58
59
60
        return self.name, self.dtype


61
def createType(specification):
Jan Hoenig's avatar
Jan Hoenig committed
62
63
64
65
66
    """
    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
    """
67
68
69
70
71
72
    if isinstance(specification, Type):
        return specification
    elif isinstance(specification, str):
        return createTypeFromString(specification)
    else:
        npDataType = np.dtype(specification)
73
74
75
76
        if npDataType.fields is None:
            return BasicType(npDataType, const=False)
        else:
            return StructType(npDataType, const=False)
77
78


79
@memorycache(maxsize=64)
80
def createTypeFromString(specification):
Jan Hoenig's avatar
Jan Hoenig committed
81
82
83
84
85
    """
    Creates a new Type object from a c-like string specification
    :param specification: Specification string
    :return: Type object
    """
86
87
88
89
90
91
92
    specification = specification.lower().split()
    parts = []
    current = []
    for s in specification:
        if s == '*':
            parts.append(current)
            current = [s]
93
        else:
94
95
96
            current.append(s)
    if len(current) > 0:
        parts.append(current)
Jan Hoenig's avatar
Jan Hoenig committed
97
        # Parse native part
98
99
100
101
102
103
    basePart = parts.pop(0)
    const = False
    if 'const' in basePart:
        const = True
        basePart.remove('const')
    assert len(basePart) == 1
Jan Hoenig's avatar
Jan Hoenig committed
104
105
106
    if basePart[0][-1] == "*":
        basePart[0] = basePart[0][:-1]
        parts.append('*')
107
108
109
110
    try:
        baseType = BasicType(basePart[0], const)
    except TypeError:
        baseType = BasicType(createTypeFromString.map[basePart[0]], const)
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
    currentType = baseType
    # 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] == '*'
        currentType = PointerType(currentType, const, restrict)
    return currentType

126
127
128
129
130
131
132
createTypeFromString.map = {
    'i64': np.int64,
    'i32': np.int32,
    'i16': np.int16,
    'i8': np.int8,
}

133
134
135
136
137
138
139
140

def getBaseType(type):
    while type.baseType is not None:
        type = type.baseType
    return type


def toCtypes(dataType):
Jan Hoenig's avatar
Jan Hoenig committed
141
142
143
144
145
    """
    Transforms a given Type into ctypes
    :param dataType: Subclass of Type
    :return: ctypes type object
    """
146
147
    if isinstance(dataType, PointerType):
        return ctypes.POINTER(toCtypes(dataType.baseType))
148
149
    elif isinstance(dataType, StructType):
        return ctypes.POINTER(ctypes.c_uint8)
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
    else:
        return toCtypes.map[dataType.numpyDtype]

toCtypes.map = {
    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,
}


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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def ctypes_from_llvm(data_type):
    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
    """
    if isinstance(data_type, PointerType):
        return to_llvm_type(data_type.baseType).as_pointer()
    else:
        return to_llvm_type.map[data_type.numpyDtype]

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(),
}

223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
def peelOffType(dtype, typeToPeelOff):
    while type(dtype) is typeToPeelOff:
        dtype = dtype.baseType
    return dtype


def collateTypes(types):
    """
    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):
        pointerType = None
        for t in types:
            if type(t) is PointerType:
                if pointerType is not None:
                    raise ValueError("Cannot collate the combination of two pointer types")
                pointerType = t
            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")
        return pointerType

    # peel of vector types, if at least one vector type occurred the result will also be the vector type
    vectorType = [t for t in types if type(t) is VectorType]
    if not allEqual(t.width for t in vectorType):
        raise ValueError("Collation failed because of vector types with different width")
    types = [peelOffType(t, VectorType) for t in types]

    # 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
    resultNumpyType = np.result_type(*(t.numpyDtype for t in types))
    result = BasicType(resultNumpyType)
    if vectorType:
        result = VectorType(result, vectorType[0].width)
    return result


@memorycache(maxsize=2048)
268
def getTypeOfExpression(expr):
269
270
271
272
273
274
275
276
277
    from pystencils.astnodes import ResolvedFieldAccess
    expr = sp.sympify(expr)
    if isinstance(expr, sp.Integer):
        return createTypeFromString("int")
    elif isinstance(expr, sp.Rational) or isinstance(expr, sp.Float):
        return createTypeFromString("double")
    elif isinstance(expr, ResolvedFieldAccess):
        return expr.field.dtype
    elif isinstance(expr, TypedSymbol):
278
        return expr.dtype
279
280
281
282
283
284
285
286
287
    elif isinstance(expr, sp.Symbol):
        raise ValueError("All symbols inside this expression have to be typed!")
    elif hasattr(expr, 'func') and expr.func == castFunc:
        return expr.args[1]
    elif hasattr(expr, 'func') and expr.func == sp.Piecewise:
        branchResults = [a[0] for a in expr.args]
        return collateTypes(tuple(getTypeOfExpression(a) for a in branchResults))
    elif isinstance(expr, sp.Indexed):
        typedSymbol = expr.base.label
288
        return typedSymbol.dtype.baseType
289
290
291
292
293
294
295
    elif isinstance(expr, sp.boolalg.Boolean):
        # if any arg is of vector type return a vector boolean, else return a normal scalar boolean
        result = createTypeFromString("bool")
        vecArgs = [getTypeOfExpression(a) for a in expr.args if isinstance(getTypeOfExpression(a), VectorType)]
        if vecArgs:
            result = VectorType(result, width=vecArgs[0].width)
        return result
296
297
298
299
    elif isinstance(expr, sp.Expr):
        types = tuple(getTypeOfExpression(a) for a in expr.args)
        return collateTypes(types)

300
    raise NotImplementedError("Could not determine type for", expr, type(expr))
301
302


303
304
305
class Type(sp.Basic):
    def __new__(cls, *args, **kwargs):
        return sp.Basic.__new__(cls)
306

307
    def __lt__(self, other):  # deprecated
Jan Hoenig's avatar
Jan Hoenig committed
308
309
310
        # Needed for sorting the types inside an expression
        if isinstance(self, BasicType):
            if isinstance(other, BasicType):
311
312
                return self.numpyDtype > other.numpyDtype  # TODO const
            elif isinstance(other, PointerType):
313
                return False
314
            else:  # isinstance(other, StructType):
Jan Hoenig's avatar
Jan Hoenig committed
315
                raise NotImplementedError("Struct type comparison is not yet implemented")
316
        elif isinstance(self, PointerType):
Jan Hoenig's avatar
Jan Hoenig committed
317
            if isinstance(other, BasicType):
318
                return True
319
320
321
            elif isinstance(other, PointerType):
                return self.baseType > other.baseType  # TODO const, restrict
            else:  # isinstance(other, StructType):
Jan Hoenig's avatar
Jan Hoenig committed
322
                raise NotImplementedError("Struct type comparison is not yet implemented")
323
        elif isinstance(self, StructType):
Jan Hoenig's avatar
Jan Hoenig committed
324
            raise NotImplementedError("Struct type comparison is not yet implemented")
325
326
327
328
329
        else:
            raise NotImplementedError

    def _sympystr(self, *args, **kwargs):
        return str(self)
330
331
332
333
334


class BasicType(Type):
    @staticmethod
    def numpyNameToC(name):
Jan Hoenig's avatar
Jan Hoenig committed
335
336
337
338
        if name == 'float64':
            return 'double'
        elif name == 'float32':
            return 'float'
339
340
341
342
        elif name.startswith('int'):
            width = int(name[len("int"):])
            return "int%d_t" % (width,)
        elif name.startswith('uint'):
343
            width = int(name[len("uint"):])
344
345
346
347
348
349
350
351
            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
352
353
354
355
        if isinstance(dtype, Type):
            self._dtype = dtype.numpyDtype
        else:
            self._dtype = np.dtype(dtype)
356
357
358
359
        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

360
361
362
    def __getnewargs__(self):
        return self.numpyDtype, self.const

363
364
365
    @property
    def baseType(self):
        return None
366

367
368
369
370
    @property
    def numpyDtype(self):
        return self._dtype

371
372
373
374
    @property
    def itemSize(self):
        return 1

375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
    def is_int(self):
        return self.numpyDtype in np.sctypes['int']

    def is_float(self):
        return self.numpyDtype in np.sctypes['float']

    def is_uint(self):
        return self.numpyDtype in np.sctypes['uint']

    def is_comlex(self):
        return self.numpyDtype in np.sctypes['complex']

    def is_other(self):
        return self.numpyDtype in np.sctypes['others']

390
391
392
393
    @property
    def baseName(self):
        return BasicType.numpyNameToC(str(self._dtype))

Jan Hoenig's avatar
Jan Hoenig committed
394
    def __str__(self):
395
396
397
398
        result = BasicType.numpyNameToC(str(self._dtype))
        if self.const:
            result += " const"
        return result
Jan Hoenig's avatar
Jan Hoenig committed
399

400
401
402
    def __repr__(self):
        return str(self)

Jan Hoenig's avatar
Jan Hoenig committed
403
    def __eq__(self, other):
404
405
        if not isinstance(other, BasicType):
            return False
Jan Hoenig's avatar
Jan Hoenig committed
406
        else:
407
408
409
410
411
412
            return (self.numpyDtype, self.const) == (other.numpyDtype, other.const)

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


413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
class VectorType(Type):
    instructionSet = None

    def __init__(self, baseType, width=4):
        self._baseType = baseType
        self.width = width

    @property
    def baseType(self):
        return self._baseType

    @property
    def itemSize(self):
        return self.width * self.baseType.itemSize

    def __eq__(self, other):
        if not isinstance(other, VectorType):
            return False
        else:
            return (self.baseType, self.width) == (other.baseType, other.width)

    def __str__(self):
        if self.instructionSet is None:
            return "%s[%d]" % (self.baseType, self.width)
        else:
            if self.baseType == createTypeFromString("int64"):
                return self.instructionSet['int']
            elif self.baseType == createTypeFromString("double"):
                return self.instructionSet['double']
            elif self.baseType == createTypeFromString("float"):
                return self.instructionSet['float']
444
445
            elif self.baseType == createTypeFromString("bool"):
                return self.instructionSet['bool']
446
447
448
449
450
451
452
            else:
                raise NotImplementedError()

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


453
454
455
456
457
458
class PointerType(Type):
    def __init__(self, baseType, const=False, restrict=True):
        self._baseType = baseType
        self.const = const
        self.restrict = restrict

459
460
461
    def __getnewargs__(self):
        return self.baseType, self.const, self.restrict

462
463
464
465
466
467
468
469
    @property
    def alias(self):
        return not self.restrict

    @property
    def baseType(self):
        return self._baseType

470
471
472
473
    @property
    def itemSize(self):
        return self.baseType.itemSize

474
475
    def __eq__(self, other):
        if not isinstance(other, PointerType):
Jan Hoenig's avatar
Jan Hoenig committed
476
            return False
477
478
479
        else:
            return (self.baseType, self.const, self.restrict) == (other.baseType, other.const, other.restrict)

Jan Hoenig's avatar
Jan Hoenig committed
480
    def __str__(self):
Jan Hoenig's avatar
Jan Hoenig committed
481
        return "%s *%s%s" % (self.baseType, " RESTRICT " if self.restrict else "", " const " if self.const else "")
482

483
484
485
    def __repr__(self):
        return str(self)

486
487
488
    def __hash__(self):
        return hash(str(self))

Jan Hoenig's avatar
Jan Hoenig committed
489

490
class StructType(object):
491
492
    def __init__(self, numpyType, const=False):
        self.const = const
493
        self._dtype = np.dtype(numpyType)
Martin Bauer's avatar
Martin Bauer committed
494

495
496
497
    def __getnewargs__(self):
        return self.numpyDtype, self.const

498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    @property
    def baseType(self):
        return None

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

    @property
    def itemSize(self):
        return self.numpyDtype.itemsize

    def getElementOffset(self, elementName):
        return self.numpyDtype.fields[elementName][1]

    def getElementType(self, elementName):
        npElementType = self.numpyDtype.fields[elementName][0]
        return BasicType(npElementType, self.const)

517
518
519
    def hasElement(self, elementName):
        return elementName in self.numpyDtype.fields

520
521
522
523
524
525
526
527
528
529
530
531
532
    def __eq__(self, other):
        if not isinstance(other, StructType):
            return False
        else:
            return (self.numpyDtype, self.const) == (other.numpyDtype, other.const)

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

533
534
535
    def __repr__(self):
        return str(self)

536
537
    def __hash__(self):
        return hash((self.numpyDtype, self.const))
538

Jan Hoenig's avatar
Jan Hoenig committed
539
    # TODO this should not work at all!!!
Jan Hoenig's avatar
Jan Hoenig committed
540
541
542
543
544
545
546
    def __gt__(self, other):
        if self.ptr and not other.ptr:
            return True
        if self.dtype > other.dtype:
            return True


Jan Hoenig's avatar
Jan Hoenig committed
547
def get_type_from_sympy(node):
Jan Hoenig's avatar
Jan Hoenig committed
548
549
550
551
552
    """
    Creates a Type object from a Sympy object
    :param node: Sympy object
    :return: Type object
    """
Jan Hoenig's avatar
Jan Hoenig committed
553
554
555
556
557
558
559
560
561
562
    # Rational, NumberSymbol?
    # Zero, One, NegativeOne )= Integer
    # Half )= Rational
    # NAN, Infinity, Negative Inifinity,
    # Exp1, Imaginary Unit, Pi, EulerGamma, Catalan, Golden Ratio
    # Pow, Mul, Add, Mod, Relational
    if not isinstance(node, sp.Number):
        raise TypeError(node, 'is not a sp.Number')

    if isinstance(node, sp.Float) or isinstance(node, sp.RealNumber):
Jan Hoenig's avatar
Jan Hoenig committed
563
        return createType('double'), float(node)
Jan Hoenig's avatar
Jan Hoenig committed
564
    elif isinstance(node, sp.Integer):
Jan Hoenig's avatar
Jan Hoenig committed
565
        return createType('int'), int(node)
Jan Hoenig's avatar
Jan Hoenig committed
566
    elif isinstance(node, sp.Rational):
567
568
        # TODO is it always float?
        return createType('double'), float(node.p/node.q)
Jan Hoenig's avatar
Jan Hoenig committed
569
    else:
Jan Hoenig's avatar
Jan Hoenig committed
570
        raise TypeError(node, ' is not a supported type (yet)!')