astnodes.py 26 KB
Newer Older
1
2
import collections.abc
import itertools
Stephan Seitz's avatar
Stephan Seitz committed
3
import uuid
4
5
from typing import Any, List, Optional, Sequence, Set, Union

6
import sympy as sp
7

8
import pystencils
9
from pystencils.data_types import TypedImaginaryUnit, TypedSymbol, cast_func, create_type
10
from pystencils.field import Field
Martin Bauer's avatar
Martin Bauer committed
11
from pystencils.kernelparameters import FieldPointerSymbol, FieldShapeSymbol, FieldStrideSymbol
Martin Bauer's avatar
Martin Bauer committed
12
from pystencils.sympyextensions import fast_subs
Martin Bauer's avatar
Martin Bauer committed
13
14

NodeOrExpr = Union['Node', sp.Expr]
15
16


17
class Node:
Martin Bauer's avatar
Martin Bauer committed
18
    """Base class for all AST nodes."""
Martin Bauer's avatar
Martin Bauer committed
19

Martin Bauer's avatar
Martin Bauer committed
20
    def __init__(self, parent: Optional['Node'] = None):
21
22
        self.parent = parent

Martin Bauer's avatar
Martin Bauer committed
23
24
25
    @property
    def args(self) -> List[NodeOrExpr]:
        """Returns all arguments/children of this node."""
Martin Bauer's avatar
Martin Bauer committed
26
        raise NotImplementedError()
27
28

    @property
Martin Bauer's avatar
Martin Bauer committed
29
30
    def symbols_defined(self) -> Set[sp.Symbol]:
        """Set of symbols which are defined by this node."""
Martin Bauer's avatar
Martin Bauer committed
31
        raise NotImplementedError()
32
33

    @property
Martin Bauer's avatar
Martin Bauer committed
34
35
    def undefined_symbols(self) -> Set[sp.Symbol]:
        """Symbols which are used but are not defined inside this node."""
36
        raise NotImplementedError()
37

Martin Bauer's avatar
Martin Bauer committed
38
    def subs(self, subs_dict) -> None:
39
        """Inplace! Substitute, similar to sympy's but modifies the AST inplace."""
40
        for a in self.args:
Martin Bauer's avatar
Martin Bauer committed
41
            a.subs(subs_dict)
42

43
44
45
46
    @property
    def func(self):
        return self.__class__

Martin Bauer's avatar
Martin Bauer committed
47
48
    def atoms(self, arg_type) -> Set[Any]:
        """Returns a set of all descendants recursively, which are an instance of the given type."""
49
50
        result = set()
        for arg in self.args:
Martin Bauer's avatar
Martin Bauer committed
51
            if isinstance(arg, arg_type):
52
                result.add(arg)
Martin Bauer's avatar
Martin Bauer committed
53
            result.update(arg.atoms(arg_type))
54
55
56
        return result


57
class Conditional(Node):
Martin Bauer's avatar
Martin Bauer committed
58
59
60
61
62
63
64
65
66
67
68
    """Conditional that maps to a 'if' statement in C/C++.

    Try to avoid using this node inside of loops, since currently this construction can not be vectorized.
    Consider using assignments with sympy.Piecewise in this case.

    Args:
        condition_expr: sympy relational expression
        true_block: block which is run if conditional is true
        false_block: optional block which is run if conditional is false
    """

Martin Bauer's avatar
Martin Bauer committed
69
70
    def __init__(self, condition_expr: sp.Basic, true_block: Union['Block', 'SympyAssignment'],
                 false_block: Optional['Block'] = None) -> None:
Martin Bauer's avatar
Martin Bauer committed
71
72
        super(Conditional, self).__init__(parent=None)

Martin Bauer's avatar
Martin Bauer committed
73
        self.condition_expr = condition_expr
Martin Bauer's avatar
Martin Bauer committed
74
75

        def handle_child(c):
76
77
78
79
80
81
82
            if c is None:
                return None
            if not isinstance(c, Block):
                c = Block([c])
            c.parent = self
            return c

Martin Bauer's avatar
Martin Bauer committed
83
84
        self.true_block = handle_child(true_block)
        self.false_block = handle_child(false_block)
85

Martin Bauer's avatar
Martin Bauer committed
86
87
    def subs(self, subs_dict):
        self.true_block.subs(subs_dict)
Martin Bauer's avatar
Martin Bauer committed
88
        if self.false_block:
Martin Bauer's avatar
Martin Bauer committed
89
90
            self.false_block.subs(subs_dict)
        self.condition_expr = self.condition_expr.subs(subs_dict)
91
92
93

    @property
    def args(self):
Martin Bauer's avatar
Martin Bauer committed
94
95
96
        result = [self.condition_expr, self.true_block]
        if self.false_block:
            result.append(self.false_block)
97
98
99
        return result

    @property
Martin Bauer's avatar
Martin Bauer committed
100
    def symbols_defined(self):
101
102
103
        return set()

    @property
Martin Bauer's avatar
Martin Bauer committed
104
    def undefined_symbols(self):
Martin Bauer's avatar
Martin Bauer committed
105
106
107
        result = self.true_block.undefined_symbols
        if self.false_block:
            result.update(self.false_block.undefined_symbols)
108
109
        if hasattr(self.condition_expr, 'atoms'):
            result.update(self.condition_expr.atoms(sp.Symbol))
110
111
112
        return result

    def __str__(self):
113
        return self.__repr__()
114
115

    def __repr__(self):
116
117
118
119
120
121
122
123
        repr = 'if:({!r}) '.format(self.condition_expr)
        if self.true_block:
            repr += '\n\t{}) '.format(self.true_block)
        if self.false_block:
            repr = 'else: '.format(self.false_block)
            repr += '\n\t{} '.format(self.false_block)

        return repr
124

125
126
127
128
129
130
131
132
    def replace_by_true_block(self):
        """Replaces the conditional by its True block"""
        self.parent.replace(self, [self.true_block])

    def replace_by_false_block(self):
        """Replaces the conditional by its False block"""
        self.parent.replace(self, [self.false_block] if self.false_block else [])

133

134
135
class KernelFunction(Node):

136
137
138
139
140
141
142
143
144
145
146
    class Parameter:
        """Function parameter.

        Each undefined symbol in a `KernelFunction` node becomes a parameter to the function.
        Parameters are either symbols introduced by the user that never occur on the left hand side of an
        Assignment, or are related to fields/arrays passed to the function.

        A parameter consists of the typed symbol (symbol property). For field related parameters this is a symbol
        defined in pystencils.kernelparameters.
        If the parameter is related to one or multiple fields, these fields are referenced in the fields property.
        """
147

148
149
150
        def __init__(self, symbol, fields):
            self.symbol = symbol  # type: TypedSymbol
            self.fields = fields  # type: Sequence[Field]
151

152
        def __repr__(self):
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
            return repr(self.symbol)

        @property
        def is_field_stride(self):
            return isinstance(self.symbol, FieldStrideSymbol)

        @property
        def is_field_shape(self):
            return isinstance(self.symbol, FieldShapeSymbol)

        @property
        def is_field_pointer(self):
            return isinstance(self.symbol, FieldPointerSymbol)

        @property
        def is_field_parameter(self):
            return self.is_field_pointer or self.is_field_shape or self.is_field_stride

        @property
        def field_name(self):
            return self.fields[0].name
174

175
    def __init__(self, body, target, backend, compile_function, ghost_layers, function_name="kernel"):
176
177
        super(KernelFunction, self).__init__()
        self._body = body
178
        body.parent = self
Martin Bauer's avatar
Martin Bauer committed
179
        self.function_name = function_name
180
        self._body.parent = self
Martin Bauer's avatar
Martin Bauer committed
181
        self.ghost_layers = ghost_layers
182
183
        self._target = target
        self._backend = backend
184
        # these variables are assumed to be global, so no automatic parameter is generated for them
Martin Bauer's avatar
Martin Bauer committed
185
        self.global_variables = set()
Martin Bauer's avatar
Martin Bauer committed
186
        self.instruction_set = None  # used in `vectorize` function to tell the backend which i.s. (SSE,AVX) to use
187
188
189
190
191
192
193
194
195
196
197
198
        # function that compiles the node to a Python callable, is set by the backends
        self._compile_function = compile_function

    @property
    def target(self):
        """Currently either 'cpu' or 'gpu' """
        return self._target

    @property
    def backend(self):
        """Backend for generating the code e.g. 'llvm', 'c', 'cuda' """
        return self._backend
199
200

    @property
Martin Bauer's avatar
Martin Bauer committed
201
    def symbols_defined(self):
202
203
204
        return set()

    @property
Martin Bauer's avatar
Martin Bauer committed
205
    def undefined_symbols(self):
206
207
208
209
210
211
        return set()

    @property
    def body(self):
        return self._body

Martin Bauer's avatar
Martin Bauer committed
212
213
214
215
216
    @body.setter
    def body(self, value):
        self._body = value
        self._body.parent = self

217
218
    @property
    def args(self):
219
        return self._body,
220

221
    @property
222
    def fields_accessed(self) -> Set[Field]:
223
        """Set of Field instances: fields which are accessed inside this kernel function"""
224
225
        from pystencils.interpolation_astnodes import InterpolatorAccess
        return set(o.field for o in itertools.chain(self.atoms(ResolvedFieldAccess), self.atoms(InterpolatorAccess)))
226

227
    @property
228
    def fields_written(self) -> Set[Field]:
229
230
231
232
        assignments = self.atoms(SympyAssignment)
        return {a.lhs.field for a in assignments if isinstance(a.lhs, ResolvedFieldAccess)}

    @property
233
    def fields_read(self) -> Set[Field]:
234
235
236
        assignments = self.atoms(SympyAssignment)
        return set().union(itertools.chain.from_iterable([f.field for f in a.rhs.free_symbols if hasattr(f, 'field')]
                                                         for a in assignments))
237

238
239
240
241
242
    def get_parameters(self) -> Sequence['KernelFunction.Parameter']:
        """Returns list of parameters for this function.

        This function is expensive, cache the result where possible!
        """
243
        field_map = {f.name: f for f in self.fields_accessed}
244
245
246
247
248
249
250

        def get_fields(symbol):
            if hasattr(symbol, 'field_name'):
                return field_map[symbol.field_name],
            elif hasattr(symbol, 'field_names'):
                return tuple(field_map[fn] for fn in symbol.field_names)
            return ()
251

252
253
        argument_symbols = self._body.undefined_symbols - self.global_variables
        parameters = [self.Parameter(symbol, get_fields(symbol)) for symbol in argument_symbols]
254
255
        if hasattr(self, 'indexing'):
            parameters += [self.Parameter(s, []) for s in self.indexing.symbolic_parameters()]
256
257
        parameters.sort(key=lambda p: p.symbol.name)
        return parameters
258

259
    def __str__(self):
260
261
        params = [p.symbol for p in self.get_parameters()]
        return '{0} {1}({2})\n{3}'.format(type(self).__name__, self.function_name, params,
Michael Kuron's avatar
Michael Kuron committed
262
                                          ("\t" + "\t".join(str(self.body).splitlines(True))))
263
264

    def __repr__(self):
265
266
        params = [p.symbol for p in self.get_parameters()]
        return '{0} {1}({2})'.format(type(self).__name__, self.function_name, params)
267

268
269
270
271
272
    def compile(self, *args, **kwargs):
        if self._compile_function is None:
            raise ValueError("No compile-function provided for this KernelFunction node")
        return self._compile_function(self, *args, **kwargs)

273

Martin Bauer's avatar
Martin Bauer committed
274
275
276
277
278
279
280
281
282
283
284
285
286
287
class SkipIteration(Node):
    @property
    def args(self):
        return []

    @property
    def symbols_defined(self):
        return set()

    @property
    def undefined_symbols(self):
        return set()


288
class Block(Node):
Martin Bauer's avatar
Martin Bauer committed
289
290
291
    def __init__(self, nodes: List[Node]):
        super(Block, self).__init__()
        self._nodes = nodes
292
        self.parent = None
293
294
295
296
297
298
299
        for n in self._nodes:
            n.parent = self

    @property
    def args(self):
        return self._nodes

Martin Bauer's avatar
Martin Bauer committed
300
301
302
303
    def subs(self, subs_dict) -> None:
        for a in self.args:
            a.subs(subs_dict)

304
305
306
307
    def fast_subs(self, subs_dict, skip=None):
        self._nodes = [fast_subs(a, subs_dict, skip) for a in self._nodes]
        return self

Martin Bauer's avatar
Martin Bauer committed
308
    def insert_front(self, node):
309
310
311
312
313
314
315
316
317
        if isinstance(node, collections.abc.Iterable):
            node = list(node)
            for n in node:
                n.parent = self

            self._nodes = node + self._nodes
        else:
            node.parent = self
            self._nodes.insert(0, node)
318

Martin Bauer's avatar
Martin Bauer committed
319
320
    def insert_before(self, new_node, insert_before):
        new_node.parent = self
321
        assert self._nodes.count(insert_before) == 1
Martin Bauer's avatar
Martin Bauer committed
322
        idx = self._nodes.index(insert_before)
323
324

        # move all assignment (definitions to the top)
Martin Bauer's avatar
Martin Bauer committed
325
        if isinstance(new_node, SympyAssignment) and new_node.is_declaration:
Martin Bauer's avatar
Martin Bauer committed
326
327
328
329
330
331
            while idx > 0:
                pn = self._nodes[idx - 1]
                if isinstance(pn, LoopOverCoordinate) or isinstance(pn, Conditional):
                    idx -= 1
                else:
                    break
Martin Bauer's avatar
Martin Bauer committed
332
        self._nodes.insert(idx, new_node)
Martin Bauer's avatar
Martin Bauer committed
333

334
    def append(self, node):
335
336
337
338
339
340
341
        if isinstance(node, list) or isinstance(node, tuple):
            for n in node:
                n.parent = self
                self._nodes.append(n)
        else:
            node.parent = self
            self._nodes.append(node)
342

Martin Bauer's avatar
Martin Bauer committed
343
    def take_child_nodes(self):
344
345
346
347
348
        tmp = self._nodes
        self._nodes = []
        return tmp

    def replace(self, child, replacements):
349
        assert self._nodes.count(child) == 1
350
351
352
353
354
355
356
357
358
359
360
        idx = self._nodes.index(child)
        del self._nodes[idx]
        if type(replacements) is list:
            for e in replacements:
                e.parent = self
            self._nodes = self._nodes[:idx] + replacements + self._nodes[idx:]
        else:
            replacements.parent = self
            self._nodes.insert(idx, replacements)

    @property
Martin Bauer's avatar
Martin Bauer committed
361
    def symbols_defined(self):
362
363
        result = set()
        for a in self.args:
364
365
366
367
            if isinstance(a, pystencils.Assignment):
                result.update(a.free_symbols)
            else:
                result.update(a.symbols_defined)
368
369
370
        return result

    @property
Martin Bauer's avatar
Martin Bauer committed
371
    def undefined_symbols(self):
372
        result = set()
Martin Bauer's avatar
Martin Bauer committed
373
        defined_symbols = set()
374
        for a in self.args:
375
376
377
378
379
380
            if isinstance(a, pystencils.Assignment):
                result.update(a.free_symbols)
                defined_symbols.update({a.lhs})
            else:
                result.update(a.undefined_symbols)
                defined_symbols.update(a.symbols_defined)
Martin Bauer's avatar
Martin Bauer committed
381
        return result - defined_symbols
382

383
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
384
        return "Block " + ''.join('{!s}\n'.format(node) for node in self._nodes)
385
386

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
387
        return "Block"
388

389
390

class PragmaBlock(Block):
Martin Bauer's avatar
Martin Bauer committed
391
392
    def __init__(self, pragma_line, nodes):
        super(PragmaBlock, self).__init__(nodes)
Martin Bauer's avatar
Martin Bauer committed
393
        self.pragma_line = pragma_line
Martin Bauer's avatar
Martin Bauer committed
394
        for n in nodes:
Martin Bauer's avatar
Martin Bauer committed
395
396
397
            n.parent = self

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
398
        return self.pragma_line
399
400
401
402


class LoopOverCoordinate(Node):
    LOOP_COUNTER_NAME_PREFIX = "ctr"
Martin Bauer's avatar
Martin Bauer committed
403
    BlOCK_LOOP_COUNTER_NAME_PREFIX = "_blockctr"
404

Martin Bauer's avatar
Martin Bauer committed
405
    def __init__(self, body, coordinate_to_loop_over, start, stop, step=1, is_block_loop=False):
Martin Bauer's avatar
Martin Bauer committed
406
        super(LoopOverCoordinate, self).__init__(parent=None)
407
        self.body = body
408
        body.parent = self
Martin Bauer's avatar
Martin Bauer committed
409
        self.coordinate_to_loop_over = coordinate_to_loop_over
410
411
412
413
        self.start = start
        self.stop = stop
        self.step = step
        self.body.parent = self
Martin Bauer's avatar
Martin Bauer committed
414
        self.prefix_lines = []
Martin Bauer's avatar
Martin Bauer committed
415
        self.is_block_loop = is_block_loop
416

Martin Bauer's avatar
Martin Bauer committed
417
    def new_loop_with_different_body(self, new_body):
Martin Bauer's avatar
Martin Bauer committed
418
419
        result = LoopOverCoordinate(new_body, self.coordinate_to_loop_over, self.start, self.stop,
                                    self.step, self.is_block_loop)
Martin Bauer's avatar
Martin Bauer committed
420
        result.prefix_lines = [l for l in self.prefix_lines]
421
422
        return result

Martin Bauer's avatar
Martin Bauer committed
423
424
    def subs(self, subs_dict):
        self.body.subs(subs_dict)
425
        if hasattr(self.start, "subs"):
Martin Bauer's avatar
Martin Bauer committed
426
            self.start = self.start.subs(subs_dict)
427
        if hasattr(self.stop, "subs"):
Martin Bauer's avatar
Martin Bauer committed
428
            self.stop = self.stop.subs(subs_dict)
429
        if hasattr(self.step, "subs"):
Martin Bauer's avatar
Martin Bauer committed
430
            self.step = self.step.subs(subs_dict)
431

432
433
434
435
436
437
438
439
440
441
    def fast_subs(self, subs_dict, skip=None):
        self.body = fast_subs(self.body, subs_dict, skip)
        if isinstance(self.start, sp.Basic):
            self.start = fast_subs(self.start, subs_dict, skip)
        if isinstance(self.stop, sp.Basic):
            self.stop = fast_subs(self.stop, subs_dict, skip)
        if isinstance(self.step, sp.Basic):
            self.step = fast_subs(self.step, subs_dict, skip)
        return self

442
443
    @property
    def args(self):
444
445
        result = [self.body]
        for e in [self.start, self.stop, self.step]:
Martin Bauer's avatar
Martin Bauer committed
446
447
            if hasattr(e, "args"):
                result.append(e)
448
449
        return result

450
451
452
453
454
455
456
457
458
459
    def replace(self, child, replacement):
        if child == self.body:
            self.body = replacement
        elif child == self.start:
            self.start = replacement
        elif child == self.step:
            self.step = replacement
        elif child == self.stop:
            self.stop = replacement

460
    @property
Martin Bauer's avatar
Martin Bauer committed
461
462
    def symbols_defined(self):
        return {self.loop_counter_symbol}
463
464

    @property
Martin Bauer's avatar
Martin Bauer committed
465
466
    def undefined_symbols(self):
        result = self.body.undefined_symbols
Martin Bauer's avatar
Martin Bauer committed
467
468
469
        for possible_symbol in [self.start, self.stop, self.step]:
            if isinstance(possible_symbol, Node) or isinstance(possible_symbol, sp.Basic):
                result.update(possible_symbol.atoms(sp.Symbol))
Martin Bauer's avatar
Martin Bauer committed
470
        return result - {self.loop_counter_symbol}
471

Martin Bauer's avatar
Martin Bauer committed
472
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
473
474
    def get_loop_counter_name(coordinate_to_loop_over):
        return "%s_%s" % (LoopOverCoordinate.LOOP_COUNTER_NAME_PREFIX, coordinate_to_loop_over)
Martin Bauer's avatar
Martin Bauer committed
475

Martin Bauer's avatar
Martin Bauer committed
476
477
478
479
    @staticmethod
    def get_block_loop_counter_name(coordinate_to_loop_over):
        return "%s_%s" % (LoopOverCoordinate.BlOCK_LOOP_COUNTER_NAME_PREFIX, coordinate_to_loop_over)

480
    @property
Martin Bauer's avatar
Martin Bauer committed
481
    def loop_counter_name(self):
Martin Bauer's avatar
Martin Bauer committed
482
483
484
485
        if self.is_block_loop:
            return LoopOverCoordinate.get_block_loop_counter_name(self.coordinate_to_loop_over)
        else:
            return LoopOverCoordinate.get_loop_counter_name(self.coordinate_to_loop_over)
Martin Bauer's avatar
Martin Bauer committed
486

487
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
488
    def is_loop_counter_symbol(symbol):
489
490
491
        prefix = LoopOverCoordinate.LOOP_COUNTER_NAME_PREFIX
        if not symbol.name.startswith(prefix):
            return None
Martin Bauer's avatar
Martin Bauer committed
492
        if symbol.dtype != create_type('int'):
493
            return None
Martin Bauer's avatar
Martin Bauer committed
494
        coordinate = int(symbol.name[len(prefix) + 1:])
495
496
        return coordinate

Martin Bauer's avatar
Martin Bauer committed
497
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
498
    def get_loop_counter_symbol(coordinate_to_loop_over):
499
        return TypedSymbol(LoopOverCoordinate.get_loop_counter_name(coordinate_to_loop_over), 'int', nonnegative=True)
500

Martin Bauer's avatar
Martin Bauer committed
501
502
    @staticmethod
    def get_block_loop_counter_symbol(coordinate_to_loop_over):
503
504
505
        return TypedSymbol(LoopOverCoordinate.get_block_loop_counter_name(coordinate_to_loop_over),
                           'int',
                           nonnegative=True)
Martin Bauer's avatar
Martin Bauer committed
506

507
    @property
Martin Bauer's avatar
Martin Bauer committed
508
    def loop_counter_symbol(self):
Martin Bauer's avatar
Martin Bauer committed
509
510
511
512
        if self.is_block_loop:
            return self.get_block_loop_counter_symbol(self.coordinate_to_loop_over)
        else:
            return self.get_loop_counter_symbol(self.coordinate_to_loop_over)
513
514

    @property
Martin Bauer's avatar
Martin Bauer committed
515
    def is_outermost_loop(self):
Martin Bauer's avatar
Martin Bauer committed
516
517
        from pystencils.transformations import get_next_parent_of_type
        return get_next_parent_of_type(self, LoopOverCoordinate) is None
518
519

    @property
Martin Bauer's avatar
Martin Bauer committed
520
    def is_innermost_loop(self):
Martin Bauer's avatar
Martin Bauer committed
521
        return len(self.atoms(LoopOverCoordinate)) == 0
522

523
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
524
525
526
        return 'for({!s}={!s}; {!s}<{!s}; {!s}+={!s})\n{!s}'.format(self.loop_counter_name, self.start,
                                                                    self.loop_counter_name, self.stop,
                                                                    self.loop_counter_name, self.step,
527
                                                                    ("\t" + "\t".join(str(self.body).splitlines(True))))
528
529

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
530
531
532
        return 'for({!s}={!s}; {!s}<{!s}; {!s}+={!s})'.format(self.loop_counter_name, self.start,
                                                              self.loop_counter_name, self.stop,
                                                              self.loop_counter_name, self.step)
533

534
535

class SympyAssignment(Node):
536
    def __init__(self, lhs_symbol, rhs_expr, is_const=True, use_auto=False):
Martin Bauer's avatar
Martin Bauer committed
537
        super(SympyAssignment, self).__init__(parent=None)
Martin Bauer's avatar
Martin Bauer committed
538
        self._lhs_symbol = lhs_symbol
539
        self.rhs = sp.sympify(rhs_expr)
Martin Bauer's avatar
Martin Bauer committed
540
        self._is_const = is_const
Martin Bauer's avatar
Martin Bauer committed
541
        self._is_declaration = self.__is_declaration()
542
        self.use_auto = use_auto
Martin Bauer's avatar
Martin Bauer committed
543
544
545
546
547
548
549

    def __is_declaration(self):
        if isinstance(self._lhs_symbol, cast_func):
            return False
        if any(isinstance(self._lhs_symbol, c) for c in (Field.Access, sp.Indexed, TemporaryMemoryAllocation)):
            return False
        return True
550
551
552

    @property
    def lhs(self):
Martin Bauer's avatar
Martin Bauer committed
553
        return self._lhs_symbol
554
555

    @lhs.setter
Martin Bauer's avatar
Martin Bauer committed
556
    def lhs(self, new_value):
Martin Bauer's avatar
Martin Bauer committed
557
        self._lhs_symbol = new_value
Martin Bauer's avatar
Martin Bauer committed
558
        self._is_declaration = self.__is_declaration()
559

Martin Bauer's avatar
Martin Bauer committed
560
561
562
    def subs(self, subs_dict):
        self.lhs = fast_subs(self.lhs, subs_dict)
        self.rhs = fast_subs(self.rhs, subs_dict)
563

564
565
566
567
568
569
570
    def optimize(self, optimizations):
        try:
            from sympy.codegen.rewriting import optimize
            self.rhs = optimize(self.rhs, optimizations)
        except Exception:
            pass

571
572
    @property
    def args(self):
573
        return [self._lhs_symbol, self.rhs, sp.sympify(self._is_const)]
574
575

    @property
Martin Bauer's avatar
Martin Bauer committed
576
    def symbols_defined(self):
Martin Bauer's avatar
Martin Bauer committed
577
        if not self._is_declaration:
578
            return set()
Martin Bauer's avatar
Martin Bauer committed
579
        return {self._lhs_symbol}
580
581

    @property
Martin Bauer's avatar
Martin Bauer committed
582
    def undefined_symbols(self):
Stephan Seitz's avatar
Stephan Seitz committed
583
        result = {s for s in self.rhs.free_symbols if not isinstance(s, sp.Indexed)}
584
        # Add loop counters if there a field accesses
Martin Bauer's avatar
Martin Bauer committed
585
        loop_counters = set()
586
587
588
        for symbol in result:
            if isinstance(symbol, Field.Access):
                for i in range(len(symbol.offsets)):
Martin Bauer's avatar
Martin Bauer committed
589
                    loop_counters.add(LoopOverCoordinate.get_loop_counter_symbol(i))
590
        result = {r for r in result if not isinstance(r, TypedImaginaryUnit)}
Martin Bauer's avatar
Martin Bauer committed
591
        result.update(loop_counters)
Martin Bauer's avatar
Martin Bauer committed
592
        result.update(self._lhs_symbol.atoms(sp.Symbol))
593
594
595
        return result

    @property
Martin Bauer's avatar
Martin Bauer committed
596
    def is_declaration(self):
Martin Bauer's avatar
Martin Bauer committed
597
        return self._is_declaration
598
599

    @property
Martin Bauer's avatar
Martin Bauer committed
600
    def is_const(self):
Martin Bauer's avatar
Martin Bauer committed
601
        return self._is_const
602

Jan Hoenig's avatar
Jan Hoenig committed
603
604
    def replace(self, child, replacement):
        if child == self.lhs:
605
606
            replacement.parent = self
            self.lhs = replacement
Jan Hoenig's avatar
Jan Hoenig committed
607
608
609
610
611
612
        elif child == self.rhs:
            replacement.parent = self
            self.rhs = replacement
        else:
            raise ValueError('%s is not in args of %s' % (replacement, self.__class__))

613
    def __repr__(self):
614
        return repr(self.lhs) + " ← " + repr(self.rhs)
615

Martin Bauer's avatar
Martin Bauer committed
616
617
618
    def _repr_html_(self):
        printed_lhs = sp.latex(self.lhs)
        printed_rhs = sp.latex(self.rhs)
Martin Bauer's avatar
Martin Bauer committed
619
        return "${printed_lhs} \\leftarrow {printed_rhs}$".format(printed_lhs=printed_lhs, printed_rhs=printed_rhs)
Martin Bauer's avatar
Martin Bauer committed
620

621

Martin Bauer's avatar
Martin Bauer committed
622
class ResolvedFieldAccess(sp.Indexed):
Martin Bauer's avatar
Martin Bauer committed
623
    def __new__(cls, base, linearized_index, field, offsets, idx_coordinate_values):
624
        if not isinstance(base, sp.IndexedBase):
625
            assert isinstance(base, TypedSymbol)
626
            base = sp.IndexedBase(base, shape=(1,))
627
            assert isinstance(base.label, TypedSymbol)
Martin Bauer's avatar
Martin Bauer committed
628
        obj = super(ResolvedFieldAccess, cls).__new__(cls, base, linearized_index)
Martin Bauer's avatar
Martin Bauer committed
629
630
        obj.field = field
        obj.offsets = offsets
Martin Bauer's avatar
Martin Bauer committed
631
        obj.idx_coordinate_values = idx_coordinate_values
Martin Bauer's avatar
Martin Bauer committed
632
633
634
635
636
        return obj

    def _eval_subs(self, old, new):
        return ResolvedFieldAccess(self.args[0],
                                   self.args[1].subs(old, new),
Martin Bauer's avatar
Martin Bauer committed
637
                                   self.field, self.offsets, self.idx_coordinate_values)
Martin Bauer's avatar
Martin Bauer committed
638

639
    def fast_subs(self, substitutions, skip=None):
Martin Bauer's avatar
Martin Bauer committed
640
641
642
643
        if self in substitutions:
            return substitutions[self]
        return ResolvedFieldAccess(self.args[0].subs(substitutions),
                                   self.args[1].subs(substitutions),
Martin Bauer's avatar
Martin Bauer committed
644
                                   self.field, self.offsets, self.idx_coordinate_values)
Martin Bauer's avatar
Martin Bauer committed
645
646

    def _hashable_content(self):
Martin Bauer's avatar
Martin Bauer committed
647
        super_class_contents = super(ResolvedFieldAccess, self)._hashable_content()
Martin Bauer's avatar
Martin Bauer committed
648
        return super_class_contents + tuple(self.offsets) + (repr(self.idx_coordinate_values), hash(self.field))
Martin Bauer's avatar
Martin Bauer committed
649
650

    @property
Martin Bauer's avatar
Martin Bauer committed
651
    def typed_symbol(self):
Martin Bauer's avatar
Martin Bauer committed
652
653
654
655
        return self.base.label

    def __str__(self):
        top = super(ResolvedFieldAccess, self).__str__()
Martin Bauer's avatar
Martin Bauer committed
656
        return "%s (%s)" % (top, self.typed_symbol.dtype)
Martin Bauer's avatar
Martin Bauer committed
657
658

    def __getnewargs__(self):
Martin Bauer's avatar
Martin Bauer committed
659
        return self.base, self.indices[0], self.field, self.offsets, self.idx_coordinate_values
Martin Bauer's avatar
Martin Bauer committed
660
661


662
class TemporaryMemoryAllocation(Node):
Martin Bauer's avatar
Martin Bauer committed
663
664
665
666
667
668
669
670
671
    """Node for temporary memory buffer allocation.

    Always allocates aligned memory.

    Args:
        typed_symbol: symbol used as pointer (has to be typed)
        size: number of elements to allocate
        align_offset: the align_offset's element is aligned
    """
672

Martin Bauer's avatar
Martin Bauer committed
673
    def __init__(self, typed_symbol: TypedSymbol, size, align_offset):
Martin Bauer's avatar
Martin Bauer committed
674
675
        super(TemporaryMemoryAllocation, self).__init__(parent=None)
        self.symbol = typed_symbol
676
        self.size = size
Martin Bauer's avatar
Martin Bauer committed
677
678
        self.headers = ['<stdlib.h>']
        self._align_offset = align_offset
679
680

    @property
Martin Bauer's avatar
Martin Bauer committed
681
682
    def symbols_defined(self):
        return {self.symbol}
683
684

    @property
Martin Bauer's avatar
Martin Bauer committed
685
    def undefined_symbols(self):
686
687
688
689
        if isinstance(self.size, sp.Basic):
            return self.size.atoms(sp.Symbol)
        else:
            return set()
690
691
692

    @property
    def args(self):
693
        return [self.symbol]
694

Martin Bauer's avatar
Martin Bauer committed
695
696
697
698
699
700
    def offset(self, byte_alignment):
        """Number of ELEMENTS to skip for a pointer that is aligned to byte_alignment."""
        np_dtype = self.symbol.dtype.base_type.numpy_dtype
        assert byte_alignment % np_dtype.itemsize == 0
        return -self._align_offset % (byte_alignment / np_dtype.itemsize)

701
702

class TemporaryMemoryFree(Node):
Martin Bauer's avatar
Martin Bauer committed
703
    def __init__(self, alloc_node):
Martin Bauer's avatar
Martin Bauer committed
704
        super(TemporaryMemoryFree, self).__init__(parent=None)
Martin Bauer's avatar
Martin Bauer committed
705
706
707
708
709
710
711
712
        self.alloc_node = alloc_node

    @property
    def symbol(self):
        return self.alloc_node.symbol

    def offset(self, byte_alignment):
        return self.alloc_node.offset(byte_alignment)
713
714

    @property
Martin Bauer's avatar
Martin Bauer committed
715
    def symbols_defined(self):
716
717
718
        return set()

    @property
Martin Bauer's avatar
Martin Bauer committed
719
    def undefined_symbols(self):
720
721
722
723
724
        return set()

    @property
    def args(self):
        return []
Martin Bauer's avatar
Martin Bauer committed
725
726
727
728
729


def early_out(condition):
    from pystencils.cpu.vectorization import vec_all
    return Conditional(vec_all(condition), Block([SkipIteration()]))
730
731


Stephan Seitz's avatar
Stephan Seitz committed
732
733
def get_dummy_symbol(dtype='bool'):
    return TypedSymbol('dummy%s' % uuid.uuid4().hex, create_type(dtype))
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779


class SourceCodeComment(Node):
    def __init__(self, text):
        self.text = text

    @property
    def args(self):
        return []

    @property
    def symbols_defined(self):
        return set()

    @property
    def undefined_symbols(self):
        return set()

    def __str__(self):
        return "/* " + self.text + " */"

    def __repr__(self):
        return self.__str__()


class EmptyLine(Node):
    def __init__(self):
        pass

    @property
    def args(self):
        return []

    @property
    def symbols_defined(self):
        return set()

    @property
    def undefined_symbols(self):
        return set()

    def __str__(self):
        return ""

    def __repr__(self):
        return self.__str__()
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804


class ConditionalFieldAccess(sp.Function):
    """
    :class:`pystencils.Field.Access` that is only executed if a certain condition is met.
    Can be used, for instance, for out-of-bound checks.
    """

    def __new__(cls, field_access, outofbounds_condition, outofbounds_value=0):
        return sp.Function.__new__(cls, field_access, outofbounds_condition, sp.S(outofbounds_value))

    @property
    def access(self):
        return self.args[0]

    @property
    def outofbounds_condition(self):
        return self.args[1]

    @property
    def outofbounds_value(self):
        return self.args[2]

    def __getnewargs__(self):
        return self.access, self.outofbounds_condition, self.outofbounds_value