cbackend.py 17.5 KB
Newer Older
Martin Bauer's avatar
Martin Bauer committed
1
import sympy as sp
Martin Bauer's avatar
Martin Bauer committed
2
3
from collections import namedtuple
from sympy.core import S
Martin Bauer's avatar
Martin Bauer committed
4
from typing import Optional, Set
Martin Bauer's avatar
Martin Bauer committed
5

Martin Bauer's avatar
Martin Bauer committed
6
7
try:
    from sympy.printing.ccode import C99CodePrinter as CCodePrinter
Martin Bauer's avatar
Martin Bauer committed
8
9
except ImportError:
    from sympy.printing.ccode import CCodePrinter  # for sympy versions < 1.1
Martin Bauer's avatar
Martin Bauer committed
10

Martin Bauer's avatar
Martin Bauer committed
11
from pystencils.integer_functions import bitwise_xor, bit_shift_right, bit_shift_left, bitwise_and, \
Martin Bauer's avatar
Martin Bauer committed
12
13
14
15
    bitwise_or, modulo_floor, modulo_ceil
from pystencils.astnodes import Node, ResolvedFieldAccess, KernelFunction
from pystencils.data_types import create_type, PointerType, get_type_of_expression, VectorType, cast_func, \
    vector_memory_access
16

Martin Bauer's avatar
Martin Bauer committed
17
__all__ = ['generate_c', 'CustomCppCode', 'PrintNode', 'get_headers', 'CustomSympyPrinter']
18

Martin Bauer's avatar
Martin Bauer committed
19

Martin Bauer's avatar
Martin Bauer committed
20
def generate_c(ast_node: Node, signature_only: bool = False, use_float_constants: Optional[bool] = None) -> str:
Martin Bauer's avatar
Martin Bauer committed
21
22
23
24
25
26
27
28
29
30
31
32
33
    """Prints an abstract syntax tree node as C or CUDA code.

    This function does not need to distinguish between C, C++ or CUDA code, it just prints 'C-like' code as encoded
    in the abstract syntax tree (AST). The AST is built differently for C or CUDA by calling different create_kernel
    functions.

    Args:
        ast_node:
        signature_only:
        use_float_constants:

    Returns:
        C-like code for the ast node and its descendants
Martin Bauer's avatar
Martin Bauer committed
34
    """
Martin Bauer's avatar
Martin Bauer committed
35
36
37
38
    if use_float_constants is None:
        field_types = set(o.field.dtype for o in ast_node.atoms(ResolvedFieldAccess))
        double = create_type('double')
        use_float_constants = double not in field_types
39

Martin Bauer's avatar
Martin Bauer committed
40
    printer = CBackend(constants_as_floats=use_float_constants, signature_only=signature_only,
Martin Bauer's avatar
Martin Bauer committed
41
                       vector_instruction_set=ast_node.instruction_set)
Martin Bauer's avatar
Martin Bauer committed
42
    return printer(ast_node)
43
44


Martin Bauer's avatar
Martin Bauer committed
45
46
def get_headers(ast_node: Node) -> Set[str]:
    """Return a set of header files, necessary to compile the printed C-like code."""
47
48
    headers = set()

Martin Bauer's avatar
Martin Bauer committed
49
50
51
    if isinstance(ast_node, KernelFunction) and ast_node.instruction_set:
        headers.update(ast_node.instruction_set['headers'])

Martin Bauer's avatar
Martin Bauer committed
52
53
54
    if hasattr(ast_node, 'headers'):
        headers.update(ast_node.headers)
    for a in ast_node.args:
55
        if isinstance(a, Node):
Martin Bauer's avatar
Martin Bauer committed
56
            headers.update(get_headers(a))
57
58

    return headers
59
60


61
62
63
64
# --------------------------------------- Backend Specific Nodes -------------------------------------------------------


class CustomCppCode(Node):
Martin Bauer's avatar
Martin Bauer committed
65
66
    def __init__(self, code, symbols_read, symbols_defined, parent=None):
        super(CustomCppCode, self).__init__(parent=parent)
67
        self._code = "\n" + code
Martin Bauer's avatar
Martin Bauer committed
68
69
        self._symbolsRead = set(symbols_read)
        self._symbolsDefined = set(symbols_defined)
70
        self.headers = []
71
72
73
74
75
76
77
78
79
80

    @property
    def code(self):
        return self._code

    @property
    def args(self):
        return []

    @property
Martin Bauer's avatar
Martin Bauer committed
81
    def symbols_defined(self):
82
83
84
        return self._symbolsDefined

    @property
Martin Bauer's avatar
Martin Bauer committed
85
86
    def undefined_symbols(self):
        return self.symbols_defined - self._symbolsRead
87
88
89


class PrintNode(CustomCppCode):
Martin Bauer's avatar
Martin Bauer committed
90
91
92
93
    # noinspection SpellCheckingInspection
    def __init__(self, symbol_to_print):
        code = '\nstd::cout << "%s  =  " << %s << std::endl; \n' % (symbol_to_print.name, symbol_to_print.name)
        super(PrintNode, self).__init__(code, symbols_read=[symbol_to_print], symbols_defined=set())
94
        self.headers.append("<iostream>")
95
96
97
98


# ------------------------------------------- Printer ------------------------------------------------------------------

99

Martin Bauer's avatar
Martin Bauer committed
100
101
# noinspection PyPep8Naming
class CBackend:
102

Martin Bauer's avatar
Martin Bauer committed
103
104
105
106
    def __init__(self, constants_as_floats=False, sympy_printer=None,
                 signature_only=False, vector_instruction_set=None):
        if sympy_printer is None:
            if vector_instruction_set is not None:
Martin Bauer's avatar
Martin Bauer committed
107
                self.sympy_printer = VectorizedCustomSympyPrinter(vector_instruction_set, constants_as_floats)
108
            else:
Martin Bauer's avatar
Martin Bauer committed
109
                self.sympy_printer = CustomSympyPrinter(constants_as_floats)
110
        else:
Martin Bauer's avatar
Martin Bauer committed
111
            self.sympy_printer = sympy_printer
112

Martin Bauer's avatar
Martin Bauer committed
113
        self._vectorInstructionSet = vector_instruction_set
114
        self._indent = "   "
Martin Bauer's avatar
Martin Bauer committed
115
        self._signatureOnly = signature_only
116
117

    def __call__(self, node):
Martin Bauer's avatar
Martin Bauer committed
118
119
        prev_is = VectorType.instruction_set
        VectorType.instruction_set = self._vectorInstructionSet
120
        result = str(self._print(node))
Martin Bauer's avatar
Martin Bauer committed
121
        VectorType.instruction_set = prev_is
122
        return result
123
124
125

    def _print(self, node):
        for cls in type(node).__mro__:
Martin Bauer's avatar
Martin Bauer committed
126
127
128
            method_name = "_print_" + cls.__name__
            if hasattr(self, method_name):
                return getattr(self, method_name)(node)
129

Martin Bauer's avatar
Martin Bauer committed
130
        raise NotImplementedError("CBackend does not support node of type " + str(type(node)))
131
132

    def _print_KernelFunction(self, node):
Martin Bauer's avatar
Martin Bauer committed
133
        function_arguments = ["%s %s" % (str(s.dtype), s.name) for s in node.parameters]
Martin Bauer's avatar
Martin Bauer committed
134
        func_declaration = "FUNC_PREFIX void %s(%s)" % (node.function_name, ", ".join(function_arguments))
135
        if self._signatureOnly:
Martin Bauer's avatar
Martin Bauer committed
136
            return func_declaration
137

138
        body = self._print(node.body)
Martin Bauer's avatar
Martin Bauer committed
139
        return func_declaration + "\n" + body
140
141

    def _print_Block(self, node):
Martin Bauer's avatar
Martin Bauer committed
142
143
        block_contents = "\n".join([self._print(child) for child in node.args])
        return "{\n%s\n}" % (self._indent + self._indent.join(block_contents.splitlines(True)))
144
145

    def _print_PragmaBlock(self, node):
Martin Bauer's avatar
Martin Bauer committed
146
        return "%s\n%s" % (node.pragma_line, self._print_Block(node))
147
148

    def _print_LoopOverCoordinate(self, node):
Martin Bauer's avatar
Martin Bauer committed
149
        counter_symbol = node.loop_counter_name
Martin Bauer's avatar
Martin Bauer committed
150
151
152
153
        start = "int %s = %s" % (counter_symbol, self.sympy_printer.doprint(node.start))
        condition = "%s < %s" % (counter_symbol, self.sympy_printer.doprint(node.stop))
        update = "%s += %s" % (counter_symbol, self.sympy_printer.doprint(node.step),)
        loop_str = "for (%s; %s; %s)" % (start, condition, update)
154

Martin Bauer's avatar
Martin Bauer committed
155
        prefix = "\n".join(node.prefix_lines)
156
157
        if prefix:
            prefix += "\n"
Martin Bauer's avatar
Martin Bauer committed
158
        return "%s%s\n%s" % (prefix, loop_str, self._print(node.body))
159
160

    def _print_SympyAssignment(self, node):
Martin Bauer's avatar
Martin Bauer committed
161
162
        if node.is_declaration:
            data_type = "const " + str(node.lhs.dtype) + " " if node.is_const else str(node.lhs.dtype) + " "
163
164
            return "%s%s = %s;" % (data_type, self.sympy_printer.doprint(node.lhs),
                                   self.sympy_printer.doprint(node.rhs))
165
        else:
Martin Bauer's avatar
Martin Bauer committed
166
            lhs_type = get_type_of_expression(node.lhs)
Martin Bauer's avatar
Martin Bauer committed
167
168
169
170
171
172
173
174
            if type(lhs_type) is VectorType and isinstance(node.lhs, cast_func):
                arg, data_type, aligned, nontemporal = node.lhs.args
                instr = 'storeU'
                if aligned:
                    instr = 'stream' if nontemporal else 'storeA'

                return self._vectorInstructionSet[instr].format("&" + self.sympy_printer.doprint(node.lhs.args[0]),
                                                                self.sympy_printer.doprint(node.rhs)) + ';'
175
            else:
Martin Bauer's avatar
Martin Bauer committed
176
                return "%s = %s;" % (self.sympy_printer.doprint(node.lhs), self.sympy_printer.doprint(node.rhs))
177
178

    def _print_TemporaryMemoryAllocation(self, node):
179
        align = 64
Martin Bauer's avatar
Martin Bauer committed
180
181
182
183
184
185
        np_dtype = node.symbol.dtype.base_type.numpy_dtype
        required_size = np_dtype.itemsize * node.size + align
        size = modulo_ceil(required_size, align)
        code = "{dtype} {name}=({dtype})aligned_alloc({align}, {size}) + {offset};"
        return code.format(dtype=node.symbol.dtype,
                           name=self.sympy_printer.doprint(node.symbol.name),
186
                           size=self.sympy_printer.doprint(size),
Martin Bauer's avatar
Martin Bauer committed
187
188
                           offset=int(node.offset(align)),
                           align=align)
189
190

    def _print_TemporaryMemoryFree(self, node):
191
        align = 64
Martin Bauer's avatar
Martin Bauer committed
192
        return "free(%s - %d);" % (self.sympy_printer.doprint(node.symbol.name), node.offset(align))
193

Martin Bauer's avatar
Martin Bauer committed
194
195
    @staticmethod
    def _print_CustomCppCode(node):
196
        return node.code
197

198
    def _print_Conditional(self, node):
Martin Bauer's avatar
Martin Bauer committed
199
200
        condition_expr = self.sympy_printer.doprint(node.condition_expr)
        true_block = self._print_Block(node.true_block)
Martin Bauer's avatar
Martin Bauer committed
201
        result = "if (%s)\n%s " % (condition_expr, true_block)
Martin Bauer's avatar
Martin Bauer committed
202
203
        if node.false_block:
            false_block = self._print_Block(node.false_block)
Martin Bauer's avatar
Martin Bauer committed
204
            result += "else " + false_block
205
206
        return result

207
208
209
210

# ------------------------------------------ Helper function & classes -------------------------------------------------


Martin Bauer's avatar
Martin Bauer committed
211
# noinspection PyPep8Naming
212
class CustomSympyPrinter(CCodePrinter):
Martin Bauer's avatar
Martin Bauer committed
213

Martin Bauer's avatar
Martin Bauer committed
214
215
    def __init__(self, constants_as_floats=False):
        self._constantsAsFloats = constants_as_floats
Martin Bauer's avatar
Martin Bauer committed
216
        super(CustomSympyPrinter, self).__init__()
217
        self._float_type = create_type("float32")
Martin Bauer's avatar
Martin Bauer committed
218

219
220
221
    def _print_Pow(self, expr):
        """Don't use std::pow function, for small integer exponents, write as multiplication"""
        if expr.exp.is_integer and expr.exp.is_number and 0 < expr.exp < 8:
222
            return "(" + self._print(sp.Mul(*[expr.base] * expr.exp, evaluate=False)) + ")"
223
224
225
226
227
        else:
            return super(CustomSympyPrinter, self)._print_Pow(expr)

    def _print_Rational(self, expr):
        """Evaluate all rationals i.e. print 0.25 instead of 1.0/4.0"""
Martin Bauer's avatar
Martin Bauer committed
228
229
        res = str(expr.evalf().num)
        return res
230
231
232
233
234
235
236
237

    def _print_Equality(self, expr):
        """Equality operator is not printable in default printer"""
        return '((' + self._print(expr.lhs) + ") == (" + self._print(expr.rhs) + '))'

    def _print_Piecewise(self, expr):
        """Print piecewise in one line (remove newlines)"""
        result = super(CustomSympyPrinter, self)._print_Piecewise(expr)
Martin Bauer's avatar
Martin Bauer committed
238
239
        return result.replace("\n", "")

240
    def _print_Function(self, expr):
Martin Bauer's avatar
Martin Bauer committed
241
        function_map = {
Martin Bauer's avatar
Martin Bauer committed
242
243
244
245
246
            bitwise_xor: '^',
            bit_shift_right: '>>',
            bit_shift_left: '<<',
            bitwise_or: '|',
            bitwise_and: '&',
Martin Bauer's avatar
Martin Bauer committed
247
        }
Martin Bauer's avatar
Martin Bauer committed
248
249
        if hasattr(expr, 'to_c'):
            return expr.to_c(self._print)
Martin Bauer's avatar
Martin Bauer committed
250
        if expr.func == cast_func:
Martin Bauer's avatar
Martin Bauer committed
251
            arg, data_type = expr.args
252
253
254
255
            if isinstance(arg, sp.Number):
                return self._typed_number(arg, data_type)
            else:
                return "*((%s)(& %s))" % (PointerType(data_type), self._print(arg))
Martin Bauer's avatar
Martin Bauer committed
256
257
258
        elif expr.func == modulo_floor:
            assert all(get_type_of_expression(e).is_int() for e in expr.args)
            return "({dtype})({0} / {1}) * {1}".format(*expr.args, dtype=get_type_of_expression(expr.args[0]))
Martin Bauer's avatar
Martin Bauer committed
259
260
        elif expr.func in function_map:
            return "(%s %s %s)" % (self._print(expr.args[0]), function_map[expr.func], self._print(expr.args[1]))
261
        else:
262
            return super(CustomSympyPrinter, self)._print_Function(expr)
Martin Bauer's avatar
Martin Bauer committed
263

264
265
    def _typed_number(self, number, dtype):
        res = self._print(number)
266
        if dtype.is_float():
267
268
269
270
271
272
273
274
            if dtype == self._float_type:
                if '.' not in res:
                    res += ".0f"
                else:
                    res += "f"
            return res
        else:
            return res
275

276

Martin Bauer's avatar
Martin Bauer committed
277
# noinspection PyPep8Naming
278
279
280
class VectorizedCustomSympyPrinter(CustomSympyPrinter):
    SummandInfo = namedtuple("SummandInfo", ['sign', 'term'])

Martin Bauer's avatar
Martin Bauer committed
281
282
    def __init__(self, instruction_set, constants_as_floats=False):
        super(VectorizedCustomSympyPrinter, self).__init__(constants_as_floats)
Martin Bauer's avatar
Martin Bauer committed
283
        self.instruction_set = instruction_set
284

Martin Bauer's avatar
Martin Bauer committed
285
286
287
288
    def _scalarFallback(self, func_name, expr, *args, **kwargs):
        expr_type = get_type_of_expression(expr)
        if type(expr_type) is not VectorType:
            return getattr(super(VectorizedCustomSympyPrinter, self), func_name)(expr, *args, **kwargs)
289
        else:
Martin Bauer's avatar
Martin Bauer committed
290
            assert self.instruction_set['width'] == expr_type.width
291
292
            return None

293
    def _print_Function(self, expr):
Martin Bauer's avatar
Martin Bauer committed
294
295
296
297
298
        if expr.func == vector_memory_access:
            arg, data_type, aligned, _ = expr.args
            instruction = self.instruction_set['loadA'] if aligned else self.instruction_set['loadU']
            return instruction.format("& " + self._print(arg))
        elif expr.func == cast_func:
Martin Bauer's avatar
Martin Bauer committed
299
300
            arg, data_type = expr.args
            if type(data_type) is VectorType:
Martin Bauer's avatar
Martin Bauer committed
301
                return self.instruction_set['makeVec'].format(self._print(arg))
302
303
304

        return super(VectorizedCustomSympyPrinter, self)._print_Function(expr)

305
306
307
308
309
    def _print_And(self, expr):
        result = self._scalarFallback('_print_And', expr)
        if result:
            return result

Martin Bauer's avatar
Martin Bauer committed
310
311
312
313
        arg_strings = [self._print(a) for a in expr.args]
        assert len(arg_strings) > 0
        result = arg_strings[0]
        for item in arg_strings[1:]:
Martin Bauer's avatar
Martin Bauer committed
314
            result = self.instruction_set['&'].format(result, item)
315
316
317
318
319
320
321
        return result

    def _print_Or(self, expr):
        result = self._scalarFallback('_print_Or', expr)
        if result:
            return result

Martin Bauer's avatar
Martin Bauer committed
322
323
324
325
        arg_strings = [self._print(a) for a in expr.args]
        assert len(arg_strings) > 0
        result = arg_strings[0]
        for item in arg_strings[1:]:
Martin Bauer's avatar
Martin Bauer committed
326
            result = self.instruction_set['|'].format(result, item)
327
328
        return result

329
    def _print_Add(self, expr, order=None):
330
331
332
        result = self._scalarFallback('_print_Add', expr)
        if result:
            return result
333
334
335
336

        summands = []
        for term in expr.args:
            if term.func == sp.Mul:
Martin Bauer's avatar
Martin Bauer committed
337
                sign, t = self._print_Mul(term, inside_add=True)
338
339
340
341
342
343
344
345
346
347
348
349
350
            else:
                t = self._print(term)
                sign = 1
            summands.append(self.SummandInfo(sign, t))
        # Use positive terms first
        summands.sort(key=lambda e: e.sign, reverse=True)
        # if no positive term exists, prepend a zero
        if summands[0].sign == -1:
            summands.insert(0, self.SummandInfo(1, "0"))

        assert len(summands) >= 2
        processed = summands[0].term
        for summand in summands[1:]:
Martin Bauer's avatar
Martin Bauer committed
351
            func = self.instruction_set['-'] if summand.sign == -1 else self.instruction_set['+']
352
353
354
            processed = func.format(processed, summand.term)
        return processed

355
    def _print_Pow(self, expr):
356
357
358
        result = self._scalarFallback('_print_Pow', expr)
        if result:
            return result
359
360
361
362
363

        if expr.exp.is_integer and expr.exp.is_number and 0 < expr.exp < 8:
            return "(" + self._print(sp.Mul(*[expr.base] * expr.exp, evaluate=False)) + ")"
        else:
            if expr.exp == -1:
Martin Bauer's avatar
Martin Bauer committed
364
365
                one = self.instruction_set['makeVec'].format(1.0)
                return self.instruction_set['/'].format(one, self._print(expr.base))
366
            elif expr.exp == 0.5:
Martin Bauer's avatar
Martin Bauer committed
367
                return self.instruction_set['sqrt'].format(self._print(expr.base))
368
369
370
            else:
                raise ValueError("Generic exponential not supported")

Martin Bauer's avatar
Martin Bauer committed
371
372
373
374
    def _print_Mul(self, expr, inside_add=False):
        # noinspection PyProtectedMember
        from sympy.core.mul import _keep_coeff

375
376
377
        result = self._scalarFallback('_print_Mul', expr)
        if result:
            return result
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

        c, e = expr.as_coeff_Mul()
        if c < 0:
            expr = _keep_coeff(-c, e)
            sign = -1
        else:
            sign = 1

        a = []  # items in the numerator
        b = []  # items that are in the denominator (if any)

        # Gather args for numerator/denominator
        for item in expr.as_ordered_factors():
            if item.is_commutative and item.is_Pow and item.exp.is_Rational and item.exp.is_negative:
                if item.exp != -1:
                    b.append(sp.Pow(item.base, -item.exp, evaluate=False))
                else:
                    b.append(sp.Pow(item.base, -item.exp))
            else:
                a.append(item)

        a = a or [S.One]

        a_str = [self._print(x) for x in a]
        b_str = [self._print(x) for x in b]

        result = a_str[0]
        for item in a_str[1:]:
Martin Bauer's avatar
Martin Bauer committed
406
            result = self.instruction_set['*'].format(result, item)
407
408
409
410

        if len(b) > 0:
            denominator_str = b_str[0]
            for item in b_str[1:]:
Martin Bauer's avatar
Martin Bauer committed
411
412
                denominator_str = self.instruction_set['*'].format(denominator_str, item)
            result = self.instruction_set['/'].format(result, denominator_str)
413

Martin Bauer's avatar
Martin Bauer committed
414
        if inside_add:
415
416
417
            return sign, result
        else:
            if sign < 0:
Martin Bauer's avatar
Martin Bauer committed
418
                return self.instruction_set['*'].format(self._print(S.NegativeOne), result)
419
420
421
            else:
                return result

422
    def _print_Relational(self, expr):
423
424
425
        result = self._scalarFallback('_print_Relational', expr)
        if result:
            return result
Martin Bauer's avatar
Martin Bauer committed
426
        return self.instruction_set[expr.rel_op].format(self._print(expr.lhs), self._print(expr.rhs))
427
428

    def _print_Equality(self, expr):
429
430
431
        result = self._scalarFallback('_print_Equality', expr)
        if result:
            return result
Martin Bauer's avatar
Martin Bauer committed
432
        return self.instruction_set['=='].format(self._print(expr.lhs), self._print(expr.rhs))
433
434

    def _print_Piecewise(self, expr):
435
436
437
        result = self._scalarFallback('_print_Piecewise', expr)
        if result:
            return result
438

Martin Bauer's avatar
Martin Bauer committed
439
        if expr.args[-1].cond.args[0] is not sp.sympify(True):
440
441
442
443
444
445
446
447
448
            # We need the last conditional to be a True, otherwise the resulting
            # function may not return a result.
            raise ValueError("All Piecewise expressions must contain an "
                             "(expr, True) statement to be used as a default "
                             "condition. Without one, the generated "
                             "expression may not evaluate to anything under "
                             "some condition.")

        result = self._print(expr.args[-1][0])
Martin Bauer's avatar
Martin Bauer committed
449
        for true_expr, condition in reversed(expr.args[:-1]):
Martin Bauer's avatar
Martin Bauer committed
450
            # noinspection SpellCheckingInspection
Martin Bauer's avatar
Martin Bauer committed
451
            result = self.instruction_set['blendv'].format(result, self._print(true_expr), self._print(condition))
452
        return result