astnodes.py 23.8 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

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

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


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

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

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

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

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

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

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

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


56
class Conditional(Node):
Martin Bauer's avatar
Martin Bauer committed
57
58
59
60
61
62
63
64
65
66
67
    """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
68
69
    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
70
71
        super(Conditional, self).__init__(parent=None)

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

        def handle_child(c):
75
76
77
78
79
80
81
            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
82
83
        self.true_block = handle_child(true_block)
        self.false_block = handle_child(false_block)
84

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

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

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

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

    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
112
        return 'if:({!s}) '.format(self.condition_expr)
113
114

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
115
        return 'if:({!r}) '.format(self.condition_expr)
116

117
118
119
120
121
122
123
124
    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 [])

125

126
127
class KernelFunction(Node):

128
129
130
131
132
133
134
135
136
137
138
    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.
        """
139

140
141
142
        def __init__(self, symbol, fields):
            self.symbol = symbol  # type: TypedSymbol
            self.fields = fields  # type: Sequence[Field]
143

144
        def __repr__(self):
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
            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
166

167
    def __init__(self, body, target, backend, compile_function, ghost_layers, function_name="kernel"):
168
169
        super(KernelFunction, self).__init__()
        self._body = body
170
        body.parent = self
Martin Bauer's avatar
Martin Bauer committed
171
        self.function_name = function_name
172
        self._body.parent = self
Martin Bauer's avatar
Martin Bauer committed
173
        self.ghost_layers = ghost_layers
174
175
        self._target = target
        self._backend = backend
176
        # these variables are assumed to be global, so no automatic parameter is generated for them
Martin Bauer's avatar
Martin Bauer committed
177
        self.global_variables = set()
Martin Bauer's avatar
Martin Bauer committed
178
        self.instruction_set = None  # used in `vectorize` function to tell the backend which i.s. (SSE,AVX) to use
179
180
181
182
183
184
185
186
187
188
189
190
        # 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
191
192

    @property
Martin Bauer's avatar
Martin Bauer committed
193
    def symbols_defined(self):
194
195
196
        return set()

    @property
Martin Bauer's avatar
Martin Bauer committed
197
    def undefined_symbols(self):
198
199
200
201
202
203
        return set()

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

Martin Bauer's avatar
Martin Bauer committed
204
205
206
207
208
    @body.setter
    def body(self, value):
        self._body = value
        self._body.parent = self

209
210
    @property
    def args(self):
211
        return self._body,
212

213
    @property
214
    def fields_accessed(self) -> Set[Field]:
215
        """Set of Field instances: fields which are accessed inside this kernel function"""
216
217
        from pystencils.interpolation_astnodes import InterpolatorAccess
        return set(o.field for o in itertools.chain(self.atoms(ResolvedFieldAccess), self.atoms(InterpolatorAccess)))
218

219
    @property
220
    def fields_written(self) -> Set[Field]:
221
222
223
224
        assignments = self.atoms(SympyAssignment)
        return {a.lhs.field for a in assignments if isinstance(a.lhs, ResolvedFieldAccess)}

    @property
225
    def fields_read(self) -> Set[Field]:
226
227
228
        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))
229

230
231
232
233
234
    def get_parameters(self) -> Sequence['KernelFunction.Parameter']:
        """Returns list of parameters for this function.

        This function is expensive, cache the result where possible!
        """
235
        field_map = {f.name: f for f in self.fields_accessed}
236
237
238
239
240
241
242

        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 ()
243

244
245
        argument_symbols = self._body.undefined_symbols - self.global_variables
        parameters = [self.Parameter(symbol, get_fields(symbol)) for symbol in argument_symbols]
246
247
        if hasattr(self, 'indexing'):
            parameters += [self.Parameter(s, []) for s in self.indexing.symbolic_parameters()]
248
249
        parameters.sort(key=lambda p: p.symbol.name)
        return parameters
250

251
    def __str__(self):
252
253
        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
254
                                          ("\t" + "\t".join(str(self.body).splitlines(True))))
255
256

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

260
261
262
263
264
    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)

265

Martin Bauer's avatar
Martin Bauer committed
266
267
268
269
270
271
272
273
274
275
276
277
278
279
class SkipIteration(Node):
    @property
    def args(self):
        return []

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

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


280
class Block(Node):
Martin Bauer's avatar
Martin Bauer committed
281
282
283
    def __init__(self, nodes: List[Node]):
        super(Block, self).__init__()
        self._nodes = nodes
284
        self.parent = None
285
286
287
288
289
290
291
        for n in self._nodes:
            n.parent = self

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

Martin Bauer's avatar
Martin Bauer committed
292
293
294
295
    def subs(self, subs_dict) -> None:
        for a in self.args:
            a.subs(subs_dict)

Martin Bauer's avatar
Martin Bauer committed
296
    def insert_front(self, node):
297
298
299
300
301
302
303
304
305
        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)
306

Martin Bauer's avatar
Martin Bauer committed
307
308
309
    def insert_before(self, new_node, insert_before):
        new_node.parent = self
        idx = self._nodes.index(insert_before)
310
311

        # move all assignment (definitions to the top)
Martin Bauer's avatar
Martin Bauer committed
312
        if isinstance(new_node, SympyAssignment) and new_node.is_declaration:
Martin Bauer's avatar
Martin Bauer committed
313
314
315
316
317
318
            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
319
        self._nodes.insert(idx, new_node)
Martin Bauer's avatar
Martin Bauer committed
320

321
    def append(self, node):
322
323
324
325
326
327
328
        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)
329

Martin Bauer's avatar
Martin Bauer committed
330
    def take_child_nodes(self):
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
        tmp = self._nodes
        self._nodes = []
        return tmp

    def replace(self, child, replacements):
        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
347
    def symbols_defined(self):
348
349
        result = set()
        for a in self.args:
Martin Bauer's avatar
Martin Bauer committed
350
            result.update(a.symbols_defined)
351
352
353
        return result

    @property
Martin Bauer's avatar
Martin Bauer committed
354
    def undefined_symbols(self):
355
        result = set()
Martin Bauer's avatar
Martin Bauer committed
356
        defined_symbols = set()
357
        for a in self.args:
Martin Bauer's avatar
Martin Bauer committed
358
359
            result.update(a.undefined_symbols)
            defined_symbols.update(a.symbols_defined)
Martin Bauer's avatar
Martin Bauer committed
360
        return result - defined_symbols
361

362
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
363
        return "Block " + ''.join('{!s}\n'.format(node) for node in self._nodes)
364
365

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
366
        return "Block"
367

368
369

class PragmaBlock(Block):
Martin Bauer's avatar
Martin Bauer committed
370
371
    def __init__(self, pragma_line, nodes):
        super(PragmaBlock, self).__init__(nodes)
Martin Bauer's avatar
Martin Bauer committed
372
        self.pragma_line = pragma_line
Martin Bauer's avatar
Martin Bauer committed
373
        for n in nodes:
Martin Bauer's avatar
Martin Bauer committed
374
375
376
            n.parent = self

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
377
        return self.pragma_line
378
379
380
381


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

Martin Bauer's avatar
Martin Bauer committed
384
    def __init__(self, body, coordinate_to_loop_over, start, stop, step=1, is_block_loop=False):
Martin Bauer's avatar
Martin Bauer committed
385
        super(LoopOverCoordinate, self).__init__(parent=None)
386
        self.body = body
387
        body.parent = self
Martin Bauer's avatar
Martin Bauer committed
388
        self.coordinate_to_loop_over = coordinate_to_loop_over
389
390
391
392
        self.start = start
        self.stop = stop
        self.step = step
        self.body.parent = self
Martin Bauer's avatar
Martin Bauer committed
393
        self.prefix_lines = []
Martin Bauer's avatar
Martin Bauer committed
394
        self.is_block_loop = is_block_loop
395

Martin Bauer's avatar
Martin Bauer committed
396
    def new_loop_with_different_body(self, new_body):
Martin Bauer's avatar
Martin Bauer committed
397
398
        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
399
        result.prefix_lines = [l for l in self.prefix_lines]
400
401
        return result

Martin Bauer's avatar
Martin Bauer committed
402
403
    def subs(self, subs_dict):
        self.body.subs(subs_dict)
404
        if hasattr(self.start, "subs"):
Martin Bauer's avatar
Martin Bauer committed
405
            self.start = self.start.subs(subs_dict)
406
        if hasattr(self.stop, "subs"):
Martin Bauer's avatar
Martin Bauer committed
407
            self.stop = self.stop.subs(subs_dict)
408
        if hasattr(self.step, "subs"):
Martin Bauer's avatar
Martin Bauer committed
409
            self.step = self.step.subs(subs_dict)
410

411
412
    @property
    def args(self):
413
414
        result = [self.body]
        for e in [self.start, self.stop, self.step]:
Martin Bauer's avatar
Martin Bauer committed
415
416
            if hasattr(e, "args"):
                result.append(e)
417
418
        return result

419
420
421
422
423
424
425
426
427
428
    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

429
    @property
Martin Bauer's avatar
Martin Bauer committed
430
431
    def symbols_defined(self):
        return {self.loop_counter_symbol}
432
433

    @property
Martin Bauer's avatar
Martin Bauer committed
434
435
    def undefined_symbols(self):
        result = self.body.undefined_symbols
Martin Bauer's avatar
Martin Bauer committed
436
437
438
        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
439
        return result - {self.loop_counter_symbol}
440

Martin Bauer's avatar
Martin Bauer committed
441
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
442
443
    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
444

Martin Bauer's avatar
Martin Bauer committed
445
446
447
448
    @staticmethod
    def get_block_loop_counter_name(coordinate_to_loop_over):
        return "%s_%s" % (LoopOverCoordinate.BlOCK_LOOP_COUNTER_NAME_PREFIX, coordinate_to_loop_over)

449
    @property
Martin Bauer's avatar
Martin Bauer committed
450
    def loop_counter_name(self):
Martin Bauer's avatar
Martin Bauer committed
451
452
453
454
        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
455

456
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
457
    def is_loop_counter_symbol(symbol):
458
459
460
        prefix = LoopOverCoordinate.LOOP_COUNTER_NAME_PREFIX
        if not symbol.name.startswith(prefix):
            return None
Martin Bauer's avatar
Martin Bauer committed
461
        if symbol.dtype != create_type('int'):
462
            return None
Martin Bauer's avatar
Martin Bauer committed
463
        coordinate = int(symbol.name[len(prefix) + 1:])
464
465
        return coordinate

Martin Bauer's avatar
Martin Bauer committed
466
    @staticmethod
Martin Bauer's avatar
Martin Bauer committed
467
468
    def get_loop_counter_symbol(coordinate_to_loop_over):
        return TypedSymbol(LoopOverCoordinate.get_loop_counter_name(coordinate_to_loop_over), 'int')
469

Martin Bauer's avatar
Martin Bauer committed
470
471
472
473
    @staticmethod
    def get_block_loop_counter_symbol(coordinate_to_loop_over):
        return TypedSymbol(LoopOverCoordinate.get_block_loop_counter_name(coordinate_to_loop_over), 'int')

474
    @property
Martin Bauer's avatar
Martin Bauer committed
475
    def loop_counter_symbol(self):
Martin Bauer's avatar
Martin Bauer committed
476
477
478
479
        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)
480
481

    @property
Martin Bauer's avatar
Martin Bauer committed
482
    def is_outermost_loop(self):
Martin Bauer's avatar
Martin Bauer committed
483
484
        from pystencils.transformations import get_next_parent_of_type
        return get_next_parent_of_type(self, LoopOverCoordinate) is None
485
486

    @property
Martin Bauer's avatar
Martin Bauer committed
487
    def is_innermost_loop(self):
Martin Bauer's avatar
Martin Bauer committed
488
        return len(self.atoms(LoopOverCoordinate)) == 0
489

490
    def __str__(self):
Martin Bauer's avatar
Martin Bauer committed
491
492
493
        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,
494
                                                                    ("\t" + "\t".join(str(self.body).splitlines(True))))
495
496

    def __repr__(self):
Martin Bauer's avatar
Martin Bauer committed
497
498
499
        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)
500

501
502

class SympyAssignment(Node):
Martin Bauer's avatar
Martin Bauer committed
503
504
    def __init__(self, lhs_symbol, rhs_expr, is_const=True):
        super(SympyAssignment, self).__init__(parent=None)
Martin Bauer's avatar
Martin Bauer committed
505
        self._lhs_symbol = lhs_symbol
506
        self.rhs = sp.simplify(rhs_expr)
Martin Bauer's avatar
Martin Bauer committed
507
        self._is_const = is_const
Martin Bauer's avatar
Martin Bauer committed
508
509
510
511
512
513
514
515
        self._is_declaration = self.__is_declaration()

    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
516
517
518

    @property
    def lhs(self):
Martin Bauer's avatar
Martin Bauer committed
519
        return self._lhs_symbol
520
521

    @lhs.setter
Martin Bauer's avatar
Martin Bauer committed
522
    def lhs(self, new_value):
Martin Bauer's avatar
Martin Bauer committed
523
        self._lhs_symbol = new_value
Martin Bauer's avatar
Martin Bauer committed
524
        self._is_declaration = self.__is_declaration()
525

Martin Bauer's avatar
Martin Bauer committed
526
527
528
    def subs(self, subs_dict):
        self.lhs = fast_subs(self.lhs, subs_dict)
        self.rhs = fast_subs(self.rhs, subs_dict)
529

530
531
532
533
534
535
536
    def optimize(self, optimizations):
        try:
            from sympy.codegen.rewriting import optimize
            self.rhs = optimize(self.rhs, optimizations)
        except Exception:
            pass

537
538
    @property
    def args(self):
Martin Bauer's avatar
Martin Bauer committed
539
        return [self._lhs_symbol, self.rhs]
540
541

    @property
Martin Bauer's avatar
Martin Bauer committed
542
    def symbols_defined(self):
Martin Bauer's avatar
Martin Bauer committed
543
        if not self._is_declaration:
544
            return set()
Martin Bauer's avatar
Martin Bauer committed
545
        return {self._lhs_symbol}
546
547

    @property
Martin Bauer's avatar
Martin Bauer committed
548
    def undefined_symbols(self):
Stephan Seitz's avatar
Stephan Seitz committed
549
        result = {s for s in self.rhs.free_symbols if not isinstance(s, sp.Indexed)}
550
        # Add loop counters if there a field accesses
Martin Bauer's avatar
Martin Bauer committed
551
        loop_counters = set()
552
553
554
        for symbol in result:
            if isinstance(symbol, Field.Access):
                for i in range(len(symbol.offsets)):
Martin Bauer's avatar
Martin Bauer committed
555
556
                    loop_counters.add(LoopOverCoordinate.get_loop_counter_symbol(i))
        result.update(loop_counters)
Martin Bauer's avatar
Martin Bauer committed
557
        result.update(self._lhs_symbol.atoms(sp.Symbol))
558
559
560
        return result

    @property
Martin Bauer's avatar
Martin Bauer committed
561
    def is_declaration(self):
Martin Bauer's avatar
Martin Bauer committed
562
        return self._is_declaration
563
564

    @property
Martin Bauer's avatar
Martin Bauer committed
565
    def is_const(self):
Martin Bauer's avatar
Martin Bauer committed
566
        return self._is_const
567

Jan Hoenig's avatar
Jan Hoenig committed
568
569
    def replace(self, child, replacement):
        if child == self.lhs:
570
571
            replacement.parent = self
            self.lhs = replacement
Jan Hoenig's avatar
Jan Hoenig committed
572
573
574
575
576
577
        elif child == self.rhs:
            replacement.parent = self
            self.rhs = replacement
        else:
            raise ValueError('%s is not in args of %s' % (replacement, self.__class__))

578
    def __repr__(self):
579
        return repr(self.lhs) + " ← " + repr(self.rhs)
580

Martin Bauer's avatar
Martin Bauer committed
581
582
583
    def _repr_html_(self):
        printed_lhs = sp.latex(self.lhs)
        printed_rhs = sp.latex(self.rhs)
Martin Bauer's avatar
Martin Bauer committed
584
        return "${printed_lhs} \\leftarrow {printed_rhs}$".format(printed_lhs=printed_lhs, printed_rhs=printed_rhs)
Martin Bauer's avatar
Martin Bauer committed
585

586

Martin Bauer's avatar
Martin Bauer committed
587
class ResolvedFieldAccess(sp.Indexed):
Martin Bauer's avatar
Martin Bauer committed
588
    def __new__(cls, base, linearized_index, field, offsets, idx_coordinate_values):
589
        if not isinstance(base, sp.IndexedBase):
590
            assert isinstance(base, TypedSymbol)
591
            base = sp.IndexedBase(base, shape=(1,))
592
            assert isinstance(base.label, TypedSymbol)
Martin Bauer's avatar
Martin Bauer committed
593
        obj = super(ResolvedFieldAccess, cls).__new__(cls, base, linearized_index)
Martin Bauer's avatar
Martin Bauer committed
594
595
        obj.field = field
        obj.offsets = offsets
Martin Bauer's avatar
Martin Bauer committed
596
        obj.idx_coordinate_values = idx_coordinate_values
Martin Bauer's avatar
Martin Bauer committed
597
598
599
600
601
        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
602
                                   self.field, self.offsets, self.idx_coordinate_values)
Martin Bauer's avatar
Martin Bauer committed
603

Martin Bauer's avatar
Martin Bauer committed
604
605
606
607
608
    def fast_subs(self, substitutions):
        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
609
                                   self.field, self.offsets, self.idx_coordinate_values)
Martin Bauer's avatar
Martin Bauer committed
610
611

    def _hashable_content(self):
Martin Bauer's avatar
Martin Bauer committed
612
        super_class_contents = super(ResolvedFieldAccess, self)._hashable_content()
Martin Bauer's avatar
Martin Bauer committed
613
        return super_class_contents + tuple(self.offsets) + (repr(self.idx_coordinate_values), hash(self.field))
Martin Bauer's avatar
Martin Bauer committed
614
615

    @property
Martin Bauer's avatar
Martin Bauer committed
616
    def typed_symbol(self):
Martin Bauer's avatar
Martin Bauer committed
617
618
619
620
        return self.base.label

    def __str__(self):
        top = super(ResolvedFieldAccess, self).__str__()
Martin Bauer's avatar
Martin Bauer committed
621
        return "%s (%s)" % (top, self.typed_symbol.dtype)
Martin Bauer's avatar
Martin Bauer committed
622
623

    def __getnewargs__(self):
Martin Bauer's avatar
Martin Bauer committed
624
        return self.base, self.indices[0], self.field, self.offsets, self.idx_coordinate_values
Martin Bauer's avatar
Martin Bauer committed
625
626


627
class TemporaryMemoryAllocation(Node):
Martin Bauer's avatar
Martin Bauer committed
628
629
630
631
632
633
634
635
636
    """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
    """
637

Martin Bauer's avatar
Martin Bauer committed
638
    def __init__(self, typed_symbol: TypedSymbol, size, align_offset):
Martin Bauer's avatar
Martin Bauer committed
639
640
        super(TemporaryMemoryAllocation, self).__init__(parent=None)
        self.symbol = typed_symbol
641
        self.size = size
Martin Bauer's avatar
Martin Bauer committed
642
643
        self.headers = ['<stdlib.h>']
        self._align_offset = align_offset
644
645

    @property
Martin Bauer's avatar
Martin Bauer committed
646
647
    def symbols_defined(self):
        return {self.symbol}
648
649

    @property
Martin Bauer's avatar
Martin Bauer committed
650
    def undefined_symbols(self):
651
652
653
654
        if isinstance(self.size, sp.Basic):
            return self.size.atoms(sp.Symbol)
        else:
            return set()
655
656
657

    @property
    def args(self):
658
        return [self.symbol]
659

Martin Bauer's avatar
Martin Bauer committed
660
661
662
663
664
665
    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)

666
667

class TemporaryMemoryFree(Node):
Martin Bauer's avatar
Martin Bauer committed
668
    def __init__(self, alloc_node):
Martin Bauer's avatar
Martin Bauer committed
669
        super(TemporaryMemoryFree, self).__init__(parent=None)
Martin Bauer's avatar
Martin Bauer committed
670
671
672
673
674
675
676
677
        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)
678
679

    @property
Martin Bauer's avatar
Martin Bauer committed
680
    def symbols_defined(self):
681
682
683
        return set()

    @property
Martin Bauer's avatar
Martin Bauer committed
684
    def undefined_symbols(self):
685
686
687
688
689
        return set()

    @property
    def args(self):
        return []
Martin Bauer's avatar
Martin Bauer committed
690
691
692
693
694


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


Stephan Seitz's avatar
Stephan Seitz committed
697
698
def get_dummy_symbol(dtype='bool'):
    return TypedSymbol('dummy%s' % uuid.uuid4().hex, create_type(dtype))
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744


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__()