FlowControl.py 43 KB
Newer Older
1
import cython
2 3 4 5 6 7
cython.declare(PyrexTypes=object, ExprNodes=object, Nodes=object,
               Builtin=object, InternalError=object,
               error=object, warning=object,
               py_object_type=object, unspecified_type=object,
               object_expr=object, object_expr_not_none=object,
               fake_rhs_expr=object, TypedExprNode=object)
8 9 10 11

import Builtin
import ExprNodes
import Nodes
12
from PyrexTypes import py_object_type, unspecified_type
13
import PyrexTypes
14 15

from Visitor import TreeVisitor, CythonTransform
16
from Errors import error, warning, InternalError
17 18

class TypedExprNode(ExprNodes.ExprNode):
19
    # Used for declaring assignments of a specified type without a known entry.
20
    def __init__(self, type, may_be_none=None, pos=None):
21
        super(TypedExprNode, self).__init__(pos)
22
        self.type = type
23
        self._may_be_none = may_be_none
24

25 26 27 28 29
    def may_be_none(self):
        return self._may_be_none != False

object_expr = TypedExprNode(py_object_type, may_be_none=True)
object_expr_not_none = TypedExprNode(py_object_type, may_be_none=False)
30 31 32
# Fake rhs to silence "unused variable" warning
fake_rhs_expr = TypedExprNode(unspecified_type)

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

class ControlBlock(object):
    """Control flow graph node. Sequence of assignments and name references.

       children  set of children nodes
       parents   set of parent nodes
       positions set of position markers

       stats     list of block statements
       gen       dict of assignments generated by this block
       bounded   set  of entries that are definitely bounded in this block

       Example:

        a = 1
        b = a + c # 'c' is already bounded or exception here

        stats = [Assignment(a), NameReference(a), NameReference(c),
                     Assignment(b)]
        gen = {Entry(a): Assignment(a), Entry(b): Assignment(b)}
        bounded = set([Entry(a), Entry(c)])

    """

    def __init__(self):
        self.children = set()
        self.parents = set()
        self.positions = set()

        self.stats = []
        self.gen = {}
        self.bounded = set()

66 67 68 69 70 71
        self.i_input = 0
        self.i_output = 0
        self.i_gen = 0
        self.i_kill = 0
        self.i_state = 0

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
    def empty(self):
        return (not self.stats and not self.positions)

    def detach(self):
        """Detach block from parents and children."""
        for child in self.children:
            child.parents.remove(self)
        for parent in self.parents:
            parent.children.remove(self)
        self.parents.clear()
        self.children.clear()

    def add_child(self, block):
        self.children.add(block)
        block.parents.add(self)


class ExitBlock(ControlBlock):
    """Non-empty exit point block."""

    def empty(self):
        return False


96
class AssignmentList(object):
97 98 99 100
    def __init__(self):
        self.stats = []


101 102 103 104 105 106 107 108 109 110 111 112
class ControlFlow(object):
    """Control-flow graph.

       entry_point ControlBlock entry point for this graph
       exit_point  ControlBlock normal exit point
       block       ControlBlock current block
       blocks      set    children nodes
       entries     set    tracked entries
       loops       list   stack for loop descriptors
       exceptions  list   stack for exception descriptors
    """

113
    def __init__(self):
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
        self.blocks = set()
        self.entries = set()
        self.loops = []
        self.exceptions = []

        self.entry_point = ControlBlock()
        self.exit_point = ExitBlock()
        self.blocks.add(self.exit_point)
        self.block = self.entry_point

    def newblock(self, parent=None):
        """Create floating block linked to `parent` if given.

           NOTE: Block is NOT added to self.blocks
        """
        block = ControlBlock()
        self.blocks.add(block)
        if parent:
            parent.add_child(block)
        return block

    def nextblock(self, parent=None):
        """Create block children block linked to current or `parent` if given.

           NOTE: Block is added to self.blocks
        """
        block = ControlBlock()
        self.blocks.add(block)
        if parent:
            parent.add_child(block)
        elif self.block:
            self.block.add_child(block)
        self.block = block
        return self.block

    def is_tracked(self, entry):
        if entry.is_anonymous:
            return False
Vitja Makarov's avatar
Vitja Makarov committed
152
        return (entry.is_local or entry.is_pyclass_attr or entry.is_arg or
Vitja Makarov's avatar
Vitja Makarov committed
153 154
                entry.from_closure or entry.in_closure or
                entry.error_on_uninitialized)
155

156 157 158 159 160 161 162 163 164
    def is_statically_assigned(self, entry):
        if (entry.is_local and entry.is_variable and
                (entry.type.is_struct_or_union or
                 entry.type.is_array or
                 entry.type.is_cpp_class)):
            # stack allocated structured variable => never uninitialised
            return True
        return False

165 166 167 168 169
    def mark_position(self, node):
        """Mark position, will be used to draw graph nodes."""
        if self.block:
            self.block.positions.add(node.pos[:2])

170
    def mark_assignment(self, lhs, rhs, entry):
171
        if self.block and self.is_tracked(entry):
172 173 174 175 176 177 178 179 180 181 182 183 184 185
            assignment = NameAssignment(lhs, rhs, entry)
            self.block.stats.append(assignment)
            self.block.gen[entry] = assignment
            self.entries.add(entry)

    def mark_argument(self, lhs, rhs, entry):
        if self.block and self.is_tracked(entry):
            assignment = Argument(lhs, rhs, entry)
            self.block.stats.append(assignment)
            self.block.gen[entry] = assignment
            self.entries.add(entry)

    def mark_deletion(self, node, entry):
        if self.block and self.is_tracked(entry):
186
            assignment = NameDeletion(node, entry)
187 188 189 190 191 192 193 194
            self.block.stats.append(assignment)
            self.block.gen[entry] = Uninitialized
            self.entries.add(entry)

    def mark_reference(self, node, entry):
        if self.block and self.is_tracked(entry):
            self.block.stats.append(NameReference(node, entry))
            # Local variable is definitely bound after this reference
195 196
            if not node.allow_null:
                self.block.bounded.add(entry)
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
            self.entries.add(entry)

    def normalize(self):
        """Delete unreachable and orphan blocks."""
        queue = set([self.entry_point])
        visited = set()
        while queue:
            root = queue.pop()
            visited.add(root)
            for child in root.children:
                if child not in visited:
                    queue.add(child)
        unreachable = self.blocks - visited
        for block in unreachable:
            block.detach()
        visited.remove(self.entry_point)
        for block in visited:
            if block.empty():
                for parent in block.parents: # Re-parent
                    for child in block.children:
                        parent.add_child(child)
                block.detach()
                unreachable.add(block)
        self.blocks -= unreachable

222 223 224 225
    def initialize(self):
        """Set initial state, map assignments to bits."""
        self.assmts = {}

Stefan Behnel's avatar
Stefan Behnel committed
226
        bit = 1
227 228
        for entry in self.entries:
            assmts = AssignmentList()
Stefan Behnel's avatar
Stefan Behnel committed
229
            assmts.mask = assmts.bit = bit
230
            self.assmts[entry] = assmts
Stefan Behnel's avatar
Stefan Behnel committed
231
            bit <<= 1
232 233 234 235

        for block in self.blocks:
            for stat in block.stats:
                if isinstance(stat, NameAssignment):
Stefan Behnel's avatar
Stefan Behnel committed
236
                    stat.bit = bit
237 238
                    assmts = self.assmts[stat.entry]
                    assmts.stats.append(stat)
Stefan Behnel's avatar
Stefan Behnel committed
239 240
                    assmts.mask |= bit
                    bit <<= 1
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

        for block in self.blocks:
            for entry, stat in block.gen.items():
                assmts = self.assmts[entry]
                if stat is Uninitialized:
                    block.i_gen |= assmts.bit
                else:
                    block.i_gen |= stat.bit
                block.i_kill |= assmts.mask
            block.i_output = block.i_gen
            for entry in block.bounded:
                block.i_kill |= self.assmts[entry].bit

        for assmts in self.assmts.itervalues():
            self.entry_point.i_gen |= assmts.bit
        self.entry_point.i_output = self.entry_point.i_gen

    def map_one(self, istate, entry):
        ret = set()
        assmts = self.assmts[entry]
        if istate & assmts.bit:
262 263 264
            if self.is_statically_assigned(entry):
                ret.add(StaticAssignment(entry))
            elif entry.from_closure:
265 266 267
                ret.add(Unknown)
            else:
                ret.add(Uninitialized)
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
        for assmt in assmts.stats:
            if istate & assmt.bit:
                ret.add(assmt)
        return ret

    def reaching_definitions(self):
        """Per-block reaching definitions analysis."""
        dirty = True
        while dirty:
            dirty = False
            for block in self.blocks:
                i_input = 0
                for parent in block.parents:
                    i_input |= parent.i_output
                i_output = (i_input & ~block.i_kill) | block.i_gen
                if i_output != block.i_output:
                    dirty = True
                block.i_input = i_input
                block.i_output = i_output

288 289 290 291 292

class LoopDescr(object):
    def __init__(self, next_block, loop_block):
        self.next_block = next_block
        self.loop_block = loop_block
293
        self.exceptions = []
294

295

296 297 298 299 300 301 302 303 304 305 306 307 308
class ExceptionDescr(object):
    """Exception handling helper.

    entry_point   ControlBlock Exception handling entry point
    finally_enter ControlBlock Normal finally clause entry point
    finally_exit  ControlBlock Normal finally clause exit point
    """

    def __init__(self, entry_point, finally_enter=None, finally_exit=None):
        self.entry_point = entry_point
        self.finally_enter = finally_enter
        self.finally_exit = finally_exit

309

310 311
class NameAssignment(object):
    def __init__(self, lhs, rhs, entry):
312 313
        if lhs.cf_state is None:
            lhs.cf_state = set()
314 315 316 317 318
        self.lhs = lhs
        self.rhs = rhs
        self.entry = entry
        self.pos = lhs.pos
        self.refs = set()
319
        self.is_arg = False
320
        self.is_deletion = False
321 322 323 324

    def __repr__(self):
        return '%s(entry=%r)' % (self.__class__.__name__, self.entry)

325 326 327 328 329 330
    def infer_type(self, scope):
        return self.rhs.infer_type(scope)

    def type_dependencies(self, scope):
        return self.rhs.type_dependencies(scope)

331

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
class StaticAssignment(NameAssignment):
    """Initialised at declaration time, e.g. stack allocation."""
    def __init__(self, entry):
        if not entry.type.is_pyobject:
            may_be_none = False
        else:
            may_be_none = None  # unknown
        lhs = TypedExprNode(
            entry.type, may_be_none=may_be_none, pos=entry.pos)
        super(StaticAssignment, self).__init__(lhs, lhs, entry)

    def infer_type(self, scope):
        return self.entry.type

    def type_dependencies(self, scope):
        return []


350
class Argument(NameAssignment):
Vitja Makarov's avatar
Vitja Makarov committed
351 352 353
    def __init__(self, lhs, rhs, entry):
        NameAssignment.__init__(self, lhs, rhs, entry)
        self.is_arg = True
354

355 356 357 358 359 360

class NameDeletion(NameAssignment):
    def __init__(self, lhs, entry):
        NameAssignment.__init__(self, lhs, lhs, entry)
        self.is_deletion = True

361 362 363 364 365 366 367
    def infer_type(self, scope):
        inferred_type = self.rhs.infer_type(scope)
        if (not inferred_type.is_pyobject and
            inferred_type.can_coerce_to_pyobject(scope)):
            return py_object_type
        return inferred_type

368

369
class Uninitialized(object):
370 371 372 373 374 375
    """Definitely not initialised yet."""


class Unknown(object):
    """Coming from outer closure, might be initialised or not."""

376 377 378

class NameReference(object):
    def __init__(self, node, entry):
379 380
        if node.cf_state is None:
            node.cf_state = set()
381 382 383 384 385 386 387 388
        self.node = node
        self.entry = entry
        self.pos = node.pos

    def __repr__(self):
        return '%s(entry=%r)' % (self.__class__.__name__, self.entry)


389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
class ControlFlowState(list):
    # Keeps track of Node's entry assignments
    #
    # cf_is_null        [boolean] It is uninitialized
    # cf_maybe_null     [boolean] May be uninitialized
    # is_single         [boolean] Has only one assignment at this point

    cf_maybe_null = False
    cf_is_null = False
    is_single = False

    def __init__(self, state):
        if Uninitialized in state:
            state.discard(Uninitialized)
            self.cf_maybe_null = True
            if not state:
                self.cf_is_null = True
406 407 408
        elif Unknown in state:
            state.discard(Unknown)
            self.cf_maybe_null = True
409 410 411 412 413 414 415 416 417
        else:
            if len(state) == 1:
                self.is_single = True
        super(ControlFlowState, self).__init__(state)

    def one(self):
        return self[0]


418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
class GVContext(object):
    """Graphviz subgraph object."""

    def __init__(self):
        self.blockids = {}
        self.nextid = 0
        self.children = []
        self.sources = {}

    def add(self, child):
        self.children.append(child)

    def nodeid(self, block):
        if block not in self.blockids:
            self.blockids[block] = 'block%d' % self.nextid
            self.nextid += 1
        return self.blockids[block]

    def extract_sources(self, block):
        if not block.positions:
            return ''
        start = min(block.positions)
        stop = max(block.positions)
        srcdescr = start[0]
        if not srcdescr in self.sources:
            self.sources[srcdescr] = list(srcdescr.get_lines())
        lines = self.sources[srcdescr]
        return '\\n'.join([l.strip() for l in lines[start[1] - 1:stop[1]]])

    def render(self, fp, name, annotate_defs=False):
        """Render graphviz dot graph"""
        fp.write('digraph %s {\n' % name)
        fp.write(' node [shape=box];\n')
        for child in self.children:
            child.render(fp, self, annotate_defs)
        fp.write('}\n')

    def escape(self, text):
        return text.replace('"', '\\"').replace('\n', '\\n')

458

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
class GV(object):
    """Graphviz DOT renderer."""

    def __init__(self, name, flow):
        self.name = name
        self.flow = flow

    def render(self, fp, ctx, annotate_defs=False):
        fp.write(' subgraph %s {\n' % self.name)
        for block in self.flow.blocks:
            label = ctx.extract_sources(block)
            if annotate_defs:
                for stat in block.stats:
                    if isinstance(stat, NameAssignment):
                        label += '\n %s [definition]' % stat.entry.name
                    elif isinstance(stat, NameReference):
                        if stat.entry:
                            label += '\n %s [reference]' % stat.entry.name
            if not label:
                label = 'empty'
            pid = ctx.nodeid(block)
            fp.write('  %s [label="%s"];\n' % (pid, ctx.escape(label)))
        for block in self.flow.blocks:
            pid = ctx.nodeid(block)
            for child in block.children:
                fp.write('  %s -> %s;\n' % (pid, ctx.nodeid(child)))
        fp.write(' }\n')

487

488
class MessageCollection(object):
489
    """Collect error/warnings messages first then sort"""
490 491
    def __init__(self):
        self.messages = []
492 493

    def error(self, pos, message):
494
        self.messages.append((pos, True, message))
495 496

    def warning(self, pos, message):
497
        self.messages.append((pos, False, message))
498

499 500 501 502 503 504 505
    def report(self):
        self.messages.sort()
        for pos, is_error, message in self.messages:
            if is_error:
                error(pos, message)
            else:
                warning(pos, message, 2)
506 507 508


def check_definitions(flow, compiler_directives):
509 510
    flow.initialize()
    flow.reaching_definitions()
511 512 513

    # Track down state
    assignments = set()
514 515 516 517
    # Node to entry map
    references = {}
    assmt_nodes = set()

518
    for block in flow.blocks:
519
        i_state = block.i_input
520
        for stat in block.stats:
521 522
            i_assmts = flow.assmts[stat.entry]
            state = flow.map_one(i_state, stat.entry)
523
            if isinstance(stat, NameAssignment):
524
                stat.lhs.cf_state.update(state)
525
                assmt_nodes.add(stat.lhs)
526
                i_state = i_state & ~i_assmts.mask
527
                if stat.is_deletion:
528
                    i_state |= i_assmts.bit
529 530
                else:
                    i_state |= stat.bit
531
                assignments.add(stat)
532 533
                if stat.rhs is not fake_rhs_expr:
                    stat.entry.cf_assignments.append(stat)
534
            elif isinstance(stat, NameReference):
535
                references[stat.node] = stat.entry
536
                stat.entry.cf_references.append(stat)
537
                stat.node.cf_state.update(state)
538
                if not stat.node.allow_null:
539
                    i_state &= ~i_assmts.bit
540
                # after successful read, the state is known to be initialised
541
                state.discard(Uninitialized)
542
                state.discard(Unknown)
543 544
                for assmt in state:
                    assmt.refs.add(stat)
545 546

    # Check variable usage
547
    warn_maybe_uninitialized = compiler_directives['warn.maybe_uninitialized']
548 549 550 551
    warn_unused_result = compiler_directives['warn.unused_result']
    warn_unused = compiler_directives['warn.unused']
    warn_unused_arg = compiler_directives['warn.unused_arg']

552 553 554 555 556 557 558 559 560 561
    messages = MessageCollection()

    # assignment hints
    for node in assmt_nodes:
        if Uninitialized in node.cf_state:
            node.cf_maybe_null = True
            if len(node.cf_state) == 1:
                node.cf_is_null = True
            else:
                node.cf_is_null = False
562 563
        elif Unknown in node.cf_state:
            node.cf_maybe_null = True
564 565 566 567 568 569 570 571
        else:
            node.cf_is_null = False
            node.cf_maybe_null = False

    # Find uninitialized references and cf-hints
    for node, entry in references.iteritems():
        if Uninitialized in node.cf_state:
            node.cf_maybe_null = True
572 573
            if not entry.from_closure and len(node.cf_state) == 1:
                node.cf_is_null = True
574
            if node.allow_null or entry.from_closure or entry.is_pyclass_attr:
575
                pass # Can be uninitialized here
576
            elif node.cf_is_null:
577 578
                if (entry.type.is_pyobject or entry.type.is_unspecified or
                        entry.error_on_uninitialized):
579 580 581 582
                    messages.error(
                        node.pos,
                        "local variable '%s' referenced before assignment"
                        % entry.name)
583 584 585 586 587
                else:
                    messages.warning(
                        node.pos,
                        "local variable '%s' referenced before assignment"
                        % entry.name)
588 589 590 591 592
            elif warn_maybe_uninitialized:
                messages.warning(
                    node.pos,
                    "local variable '%s' might be referenced before assignment"
                    % entry.name)
593 594 595 596 597 598
        elif Unknown in node.cf_state:
            # TODO: better cross-closure analysis to know when inner functions
            #       are being called before a variable is being set, and when
            #       a variable is known to be set before even defining the
            #       inner function, etc.
            node.cf_maybe_null = True
599 600 601 602 603
        else:
            node.cf_is_null = False
            node.cf_maybe_null = False

    # Unused result
604
    for assmt in assignments:
Vitja Makarov's avatar
Vitja Makarov committed
605 606
        if (not assmt.refs and not assmt.entry.is_pyclass_attr
            and not assmt.entry.in_closure):
607
            if assmt.entry.cf_references and warn_unused_result:
608
                if assmt.is_arg:
Vitja Makarov's avatar
Vitja Makarov committed
609 610
                    messages.warning(assmt.pos, "Unused argument value '%s'" %
                                     assmt.entry.name)
611
                else:
Vitja Makarov's avatar
Vitja Makarov committed
612 613
                    messages.warning(assmt.pos, "Unused result in '%s'" %
                                     assmt.entry.name)
614
            assmt.lhs.cf_used = False
615

616
    # Unused entries
617
    for entry in flow.entries:
618
        if (not entry.cf_references
619
                and not entry.is_pyclass_attr):
620 621 622 623 624 625 626 627 628 629
            if entry.name != '_':
                # '_' is often used for unused variables, e.g. in loops
                if entry.is_arg:
                    if warn_unused_arg:
                        messages.warning(entry.pos, "Unused argument '%s'" %
                                         entry.name)
                else:
                    if warn_unused:
                        messages.warning(entry.pos, "Unused entry '%s'" %
                                         entry.name)
630
            entry.cf_used = False
631

632
    messages.report()
633

634
    for node in assmt_nodes:
635
        node.cf_state = ControlFlowState(node.cf_state)
636
    for node in references:
637
        node.cf_state = ControlFlowState(node.cf_state)
638

639 640 641 642 643 644 645

class AssignmentCollector(TreeVisitor):
    def __init__(self):
        super(AssignmentCollector, self).__init__()
        self.assignments = []

    def visit_Node(self):
646
        self._visitchildren(self, None)
647 648 649 650 651 652 653 654 655

    def visit_SingleAssignmentNode(self, node):
        self.assignments.append((node.lhs, node.rhs))

    def visit_CascadedAssignmentNode(self, node):
        for lhs in node.lhs_list:
            self.assignments.append((lhs, node.rhs))


656
class ControlFlowAnalysis(CythonTransform):
657

658 659 660
    def visit_ModuleNode(self, node):
        self.gv_ctx = GVContext()

661
        # Set of NameNode reductions
Robert Bradshaw's avatar
Robert Bradshaw committed
662
        self.reductions = set()
663

664
        self.in_inplace_assignment = False
665 666 667 668 669 670
        self.env_stack = []
        self.env = node.scope
        self.stack = []
        self.flow = ControlFlow()
        self.visitchildren(node)

671 672
        check_definitions(self.flow, self.current_directives)

673 674 675 676 677 678 679 680 681 682 683
        dot_output = self.current_directives['control_flow.dot_output']
        if dot_output:
            annotate_defs = self.current_directives['control_flow.dot_annotate_defs']
            fp = open(dot_output, 'wt')
            try:
                self.gv_ctx.render(fp, 'module', annotate_defs=annotate_defs)
            finally:
                fp.close()
        return node

    def visit_FuncDefNode(self, node):
684 685 686
        for arg in node.args:
            if arg.default:
                self.visitchildren(arg)
687
        self.visitchildren(node, ('decorators',))
688 689 690
        self.env_stack.append(self.env)
        self.env = node.local_scope
        self.stack.append(self.flow)
691
        self.flow = ControlFlow()
692

693 694 695 696 697
        # Collect all entries
        for entry in node.local_scope.entries.values():
            if self.flow.is_tracked(entry):
                self.flow.entries.add(entry)

698 699 700 701
        self.mark_position(node)
        # Function body block
        self.flow.nextblock()

702
        for arg in node.args:
703
            self._visit(arg)
704 705
        if node.star_arg:
            self.flow.mark_argument(node.star_arg,
706 707
                                    TypedExprNode(Builtin.tuple_type,
                                                  may_be_none=False),
708 709 710
                                    node.star_arg.entry)
        if node.starstar_arg:
            self.flow.mark_argument(node.starstar_arg,
711 712
                                    TypedExprNode(Builtin.dict_type,
                                                  may_be_none=False),
713
                                    node.starstar_arg.entry)
714
        self._visit(node.body)
Vitja Makarov's avatar
Vitja Makarov committed
715 716
        # Workaround for generators
        if node.is_generator:
717
            self._visit(node.gbody.body)
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737

        # Exit point
        if self.flow.block:
            self.flow.block.add_child(self.flow.exit_point)

        # Cleanup graph
        self.flow.normalize()
        check_definitions(self.flow, self.current_directives)
        self.flow.blocks.add(self.flow.entry_point)

        self.gv_ctx.add(GV(node.local_scope.name, self.flow))

        self.flow = self.stack.pop()
        self.env = self.env_stack.pop()
        return node

    def visit_DefNode(self, node):
        node.used = True
        return self.visit_FuncDefNode(node)

Vitja Makarov's avatar
Vitja Makarov committed
738 739 740
    def visit_GeneratorBodyDefNode(self, node):
        return node

741 742 743 744 745 746 747 748 749 750 751 752 753 754
    def visit_CTypeDefNode(self, node):
        return node

    def mark_assignment(self, lhs, rhs=None):
        if not self.flow.block:
            return
        if self.flow.exceptions:
            exc_descr = self.flow.exceptions[-1]
            self.flow.block.add_child(exc_descr.entry_point)
            self.flow.nextblock()

        if not rhs:
            rhs = object_expr
        if lhs.is_name:
755 756 757 758 759
            if lhs.entry is not None:
                entry = lhs.entry
            else:
                entry = self.env.lookup(lhs.name)
            if entry is None: # TODO: This shouldn't happen...
760
                return
761
            self.flow.mark_assignment(lhs, rhs, entry)
762 763 764 765
        elif isinstance(lhs, ExprNodes.SequenceNode):
            for arg in lhs.args:
                self.mark_assignment(arg)
        else:
766
            self._visit(lhs)
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784

        if self.flow.exceptions:
            exc_descr = self.flow.exceptions[-1]
            self.flow.block.add_child(exc_descr.entry_point)
            self.flow.nextblock()

    def mark_position(self, node):
        """Mark position if DOT output is enabled."""
        if self.current_directives['control_flow.dot_output']:
            self.flow.mark_position(node)

    def visit_FromImportStatNode(self, node):
        for name, target in node.items:
            if name != "*":
                self.mark_assignment(target)
        self.visitchildren(node)
        return node

785 786 787
    def visit_AssignmentNode(self, node):
        raise InternalError, "Unhandled assignment node"

788
    def visit_SingleAssignmentNode(self, node):
789
        self._visit(node.rhs)
790
        self.mark_assignment(node.lhs, node.rhs)
791 792 793
        return node

    def visit_CascadedAssignmentNode(self, node):
794
        self._visit(node.rhs)
795 796 797 798 799 800 801 802
        for lhs in node.lhs_list:
            self.mark_assignment(lhs, node.rhs)
        return node

    def visit_ParallelAssignmentNode(self, node):
        collector = AssignmentCollector()
        collector.visitchildren(node)
        for lhs, rhs in collector.assignments:
803
            self._visit(rhs)
804 805 806 807 808
        for lhs, rhs in collector.assignments:
            self.mark_assignment(lhs, rhs)
        return node

    def visit_InPlaceAssignmentNode(self, node):
Mark Florisson's avatar
Mark Florisson committed
809
        self.in_inplace_assignment = True
810
        self.visitchildren(node)
Mark Florisson's avatar
Mark Florisson committed
811
        self.in_inplace_assignment = False
812
        self.mark_assignment(node.lhs, node.create_binop_node())
813 814 815 816 817
        return node

    def visit_DelStatNode(self, node):
        for arg in node.args:
            if arg.is_name:
Vitja Makarov's avatar
Vitja Makarov committed
818 819
                entry = arg.entry or self.env.lookup(arg.name)
                if entry.in_closure or entry.from_closure:
Vitja Makarov's avatar
Vitja Makarov committed
820 821 822
                    error(arg.pos,
                          "can not delete variable '%s' "
                          "referenced in nested scope" % entry.name)
Vitja Makarov's avatar
Vitja Makarov committed
823
                # Mark reference
824
                self._visit(arg)
Vitja Makarov's avatar
Vitja Makarov committed
825
                self.flow.mark_deletion(arg, entry)
826 827 828 829
        return node

    def visit_CArgDeclNode(self, node):
        entry = self.env.lookup(node.name)
830
        if entry:
831
            may_be_none = not node.not_none
832 833
            self.flow.mark_argument(
                node, TypedExprNode(entry.type, may_be_none), entry)
834 835 836 837 838 839 840
        return node

    def visit_NameNode(self, node):
        if self.flow.block:
            entry = node.entry or self.env.lookup(node.name)
            if entry:
                self.flow.mark_reference(node, entry)
Mark Florisson's avatar
Mark Florisson committed
841 842 843 844 845

                if entry in self.reductions and not self.in_inplace_assignment:
                    error(node.pos,
                          "Cannot read reduction variable in loop body")

846 847 848
        return node

    def visit_StatListNode(self, node):
849 850
        if self.flow.block:
            for stat in node.stats:
851
                self._visit(stat)
852 853 854
                if not self.flow.block:
                    stat.is_terminator = True
                    break
855 856 857 858 859 860 861 862 863 864 865 866 867
        return node

    def visit_Node(self, node):
        self.visitchildren(node)
        self.mark_position(node)
        return node

    def visit_IfStatNode(self, node):
        next_block = self.flow.newblock()
        parent = self.flow.block
        # If clauses
        for clause in node.if_clauses:
            parent = self.flow.nextblock(parent)
868
            self._visit(clause.condition)
869
            self.flow.nextblock()
870
            self._visit(clause.body)
871 872 873 874 875
            if self.flow.block:
                self.flow.block.add_child(next_block)
        # Else clause
        if node.else_clause:
            self.flow.nextblock(parent=parent)
876
            self._visit(node.else_clause)
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
            if self.flow.block:
                self.flow.block.add_child(next_block)
        else:
            parent.add_child(next_block)

        if next_block.parents:
            self.flow.block = next_block
        else:
            self.flow.block = None
        return node

    def visit_WhileStatNode(self, node):
        condition_block = self.flow.nextblock()
        next_block = self.flow.newblock()
        # Condition block
        self.flow.loops.append(LoopDescr(next_block, condition_block))
893
        self._visit(node.condition)
894 895
        # Body block
        self.flow.nextblock()
896
        self._visit(node.body)
897
        self.flow.loops.pop()
898 899 900 901 902 903 904
        # Loop it
        if self.flow.block:
            self.flow.block.add_child(condition_block)
            self.flow.block.add_child(next_block)
        # Else clause
        if node.else_clause:
            self.flow.nextblock(parent=condition_block)
905
            self._visit(node.else_clause)
906 907 908 909
            if self.flow.block:
                self.flow.block.add_child(next_block)
        else:
            condition_block.add_child(next_block)
910 911 912 913 914

        if next_block.parents:
            self.flow.block = next_block
        else:
            self.flow.block = None
915 916
        return node

917 918 919 920
    def mark_forloop_target(self, node):
        # TODO: Remove redundancy with range optimization...
        is_special = False
        sequence = node.iterator.sequence
921
        target = node.target
922 923 924
        if isinstance(sequence, ExprNodes.SimpleCallNode):
            function = sequence.function
            if sequence.self is None and function.is_name:
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
                entry = self.env.lookup(function.name)
                if not entry or entry.is_builtin:
                    if function.name == 'reversed' and len(sequence.args) == 1:
                        sequence = sequence.args[0]
                    elif function.name == 'enumerate' and len(sequence.args) == 1:
                        if target.is_sequence_constructor and len(target.args) == 2:
                            iterator = sequence.args[0]
                            if iterator.is_name:
                                iterator_type = iterator.infer_type(self.env)
                                if iterator_type.is_builtin_type:
                                    # assume that builtin types have a length within Py_ssize_t
                                    self.mark_assignment(
                                        target.args[0],
                                        ExprNodes.IntNode(target.pos, value='PY_SSIZE_T_MAX',
                                                          type=PyrexTypes.c_py_ssize_t_type))
                                    target = target.args[1]
                                    sequence = sequence.args[0]
942 943 944
        if isinstance(sequence, ExprNodes.SimpleCallNode):
            function = sequence.function
            if sequence.self is None and function.is_name:
945 946 947 948 949 950 951 952 953 954 955 956 957
                entry = self.env.lookup(function.name)
                if not entry or entry.is_builtin:
                    if function.name in ('range', 'xrange'):
                        is_special = True
                        for arg in sequence.args[:2]:
                            self.mark_assignment(target, arg)
                        if len(sequence.args) > 2:
                            self.mark_assignment(
                                target,
                                ExprNodes.binop_node(node.pos,
                                                     '+',
                                                     sequence.args[0],
                                                     sequence.args[2]))
958 959 960 961 962 963 964

        if not is_special:
            # A for-loop basically translates to subsequent calls to
            # __getitem__(), so using an IndexNode here allows us to
            # naturally infer the base type of pointers, C arrays,
            # Python strings, etc., while correctly falling back to an
            # object type when the base type cannot be handled.
965 966

            self.mark_assignment(target, node.item)
967

968 969 970 971 972
    def visit_ForInStatNode(self, node):
        condition_block = self.flow.nextblock()
        next_block = self.flow.newblock()
        # Condition with iterator
        self.flow.loops.append(LoopDescr(next_block, condition_block))
973
        self._visit(node.iterator)
974 975
        # Target assignment
        self.flow.nextblock()
976 977 978 979 980

        if isinstance(node, Nodes.ForInStatNode):
            self.mark_forloop_target(node)
        else: # Parallel
            self.mark_assignment(node.target)
Mark Florisson's avatar
Mark Florisson committed
981

982
        # Body block
Mark Florisson's avatar
Mark Florisson committed
983 984 985 986
        if isinstance(node, Nodes.ParallelRangeNode):
            # In case of an invalid
            self._delete_privates(node, exclude=node.target.entry)

987
        self.flow.nextblock()
988
        self._visit(node.body)
989
        self.flow.loops.pop()
Mark Florisson's avatar
Mark Florisson committed
990

991 992 993 994 995 996
        # Loop it
        if self.flow.block:
            self.flow.block.add_child(condition_block)
        # Else clause
        if node.else_clause:
            self.flow.nextblock(parent=condition_block)
997
            self._visit(node.else_clause)
998 999 1000 1001
            if self.flow.block:
                self.flow.block.add_child(next_block)
        else:
            condition_block.add_child(next_block)
1002 1003 1004 1005 1006

        if next_block.parents:
            self.flow.block = next_block
        else:
            self.flow.block = None
1007 1008
        return node

Mark Florisson's avatar
Mark Florisson committed
1009 1010 1011 1012 1013
    def _delete_privates(self, node, exclude=None):
        for private_node in node.assigned_nodes:
            if not exclude or private_node.entry is not exclude:
                self.flow.mark_deletion(private_node, private_node.entry)

1014
    def visit_ParallelRangeNode(self, node):
Mark Florisson's avatar
Mark Florisson committed
1015 1016 1017 1018 1019
        reductions = self.reductions

        # if node.target is None or not a NameNode, an error will have
        # been previously issued
        if hasattr(node.target, 'entry'):
Robert Bradshaw's avatar
Robert Bradshaw committed
1020
            self.reductions = set(reductions)
Mark Florisson's avatar
Mark Florisson committed
1021 1022 1023 1024 1025 1026 1027

            for private_node in node.assigned_nodes:
                private_node.entry.error_on_uninitialized = True
                pos, reduction = node.assignments[private_node.entry]
                if reduction:
                    self.reductions.add(private_node.entry)

1028 1029
            node = self.visit_ForInStatNode(node)

Mark Florisson's avatar
Mark Florisson committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
        self.reductions = reductions
        return node

    def visit_ParallelWithBlockNode(self, node):
        for private_node in node.assigned_nodes:
            private_node.entry.error_on_uninitialized = True

        self._delete_privates(node)
        self.visitchildren(node)
        self._delete_privates(node)

1041 1042
        return node

1043 1044 1045 1046 1047
    def visit_ForFromStatNode(self, node):
        condition_block = self.flow.nextblock()
        next_block = self.flow.newblock()
        # Condition with iterator
        self.flow.loops.append(LoopDescr(next_block, condition_block))
1048 1049
        self._visit(node.bound1)
        self._visit(node.bound2)
1050
        if node.step is not None:
1051
            self._visit(node.step)
1052 1053
        # Target assignment
        self.flow.nextblock()
1054 1055 1056 1057 1058
        self.mark_assignment(node.target, node.bound1)
        if node.step is not None:
            self.mark_assignment(node.target,
                                 ExprNodes.binop_node(node.pos, '+',
                                                      node.bound1, node.step))
1059 1060
        # Body block
        self.flow.nextblock()
1061
        self._visit(node.body)
1062
        self.flow.loops.pop()
1063 1064 1065 1066 1067 1068
        # Loop it
        if self.flow.block:
            self.flow.block.add_child(condition_block)
        # Else clause
        if node.else_clause:
            self.flow.nextblock(parent=condition_block)
1069
            self._visit(node.else_clause)
1070 1071 1072 1073
            if self.flow.block:
                self.flow.block.add_child(next_block)
        else:
            condition_block.add_child(next_block)
1074 1075 1076 1077 1078

        if next_block.parents:
            self.flow.block = next_block
        else:
            self.flow.block = None
1079 1080 1081 1082 1083
        return node

    def visit_LoopNode(self, node):
        raise InternalError, "Generic loops are not supported"

1084
    def visit_WithTargetAssignmentStatNode(self, node):
1085
        self.mark_assignment(node.lhs, node.rhs)
1086 1087
        return node

1088
    def visit_WithStatNode(self, node):
1089 1090 1091
        self._visit(node.manager)
        self._visit(node.enter_call)
        self._visit(node.body)
1092
        return node
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105

    def visit_TryExceptStatNode(self, node):
        # After exception handling
        next_block = self.flow.newblock()
        # Body block
        self.flow.newblock()
        # Exception entry point
        entry_point = self.flow.newblock()
        self.flow.exceptions.append(ExceptionDescr(entry_point))
        self.flow.nextblock()
        ## XXX: links to exception handling point should be added by
        ## XXX: children nodes
        self.flow.block.add_child(entry_point)
1106
        self._visit(node.body)
1107 1108 1109 1110 1111 1112
        self.flow.exceptions.pop()

        # After exception
        if self.flow.block:
            if node.else_clause:
                self.flow.nextblock()
1113
                self._visit(node.else_clause)
1114 1115 1116 1117 1118 1119 1120
            if self.flow.block:
                self.flow.block.add_child(next_block)

        for clause in node.except_clauses:
            self.flow.block = entry_point
            if clause.pattern:
                for pattern in clause.pattern:
1121
                    self._visit(pattern)
1122 1123 1124 1125 1126
            else:
                # TODO: handle * pattern
                pass
            entry_point = self.flow.newblock(parent=self.flow.block)
            self.flow.nextblock()
1127 1128
            if clause.target:
                self.mark_assignment(clause.target)
1129
            self._visit(clause.body)
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
            if self.flow.block:
                self.flow.block.add_child(next_block)

        if self.flow.exceptions:
            entry_point.add_child(self.flow.exceptions[-1].entry_point)

        if next_block.parents:
            self.flow.block = next_block
        else:
            self.flow.block = None
        return node

    def visit_TryFinallyStatNode(self, node):
        body_block = self.flow.nextblock()

        # Exception entry point
        entry_point = self.flow.newblock()
        self.flow.block = entry_point
1148
        self._visit(node.finally_clause)
1149

1150 1151 1152
        if self.flow.block and self.flow.exceptions:
            self.flow.block.add_child(self.flow.exceptions[-1].entry_point)

1153 1154 1155
        # Normal execution
        finally_enter = self.flow.newblock()
        self.flow.block = finally_enter
1156
        self._visit(node.finally_clause)
1157 1158
        finally_exit = self.flow.block

1159 1160 1161 1162
        descr = ExceptionDescr(entry_point, finally_enter, finally_exit)
        self.flow.exceptions.append(descr)
        if self.flow.loops:
            self.flow.loops[-1].exceptions.append(descr)
1163 1164 1165
        self.flow.block = body_block
        ## XXX: Is it still required
        body_block.add_child(entry_point)
1166
        self._visit(node.body)
1167
        self.flow.exceptions.pop()
1168 1169
        if self.flow.loops:
            self.flow.loops[-1].exceptions.pop()
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180

        if self.flow.block:
            self.flow.block.add_child(finally_enter)
            if finally_exit:
                self.flow.block = self.flow.nextblock(parent=finally_exit)
            else:
                self.flow.block = None
        return node

    def visit_RaiseStatNode(self, node):
        self.mark_position(node)
Vitja Makarov's avatar
Vitja Makarov committed
1181
        self.visitchildren(node)
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
        if self.flow.exceptions:
            self.flow.block.add_child(self.flow.exceptions[-1].entry_point)
        self.flow.block = None
        return node

    def visit_ReraiseStatNode(self, node):
        self.mark_position(node)
        if self.flow.exceptions:
            self.flow.block.add_child(self.flow.exceptions[-1].entry_point)
        self.flow.block = None
        return node

    def visit_ReturnStatNode(self, node):
        self.mark_position(node)
        self.visitchildren(node)

        for exception in self.flow.exceptions[::-1]:
            if exception.finally_enter:
                self.flow.block.add_child(exception.finally_enter)
                if exception.finally_exit:
                    exception.finally_exit.add_child(self.flow.exit_point)
                break
        else:
            if self.flow.block:
                self.flow.block.add_child(self.flow.exit_point)
        self.flow.block = None
        return node

    def visit_BreakStatNode(self, node):
        if not self.flow.loops:
            #error(node.pos, "break statement not inside loop")
            return node
        loop = self.flow.loops[-1]
        self.mark_position(node)
1216
        for exception in loop.exceptions[::-1]:
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
            if exception.finally_enter:
                self.flow.block.add_child(exception.finally_enter)
                if exception.finally_exit:
                    exception.finally_exit.add_child(loop.next_block)
                break
        else:
            self.flow.block.add_child(loop.next_block)
        self.flow.block = None
        return node

    def visit_ContinueStatNode(self, node):
        if not self.flow.loops:
            #error(node.pos, "continue statement not inside loop")
            return node
        loop = self.flow.loops[-1]
        self.mark_position(node)
1233
        for exception in loop.exceptions[::-1]:
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
            if exception.finally_enter:
                self.flow.block.add_child(exception.finally_enter)
                if exception.finally_exit:
                    exception.finally_exit.add_child(loop.loop_block)
                break
        else:
            self.flow.block.add_child(loop.loop_block)
        self.flow.block = None
        return node

    def visit_ComprehensionNode(self, node):
        if node.expr_scope:
            self.env_stack.append(self.env)
            self.env = node.expr_scope
        # Skip append node here
1249
        self._visit(node.loop)
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
        if node.expr_scope:
            self.env = self.env_stack.pop()
        return node

    def visit_ScopedExprNode(self, node):
        if node.expr_scope:
            self.env_stack.append(self.env)
            self.env = node.expr_scope
        self.visitchildren(node)
        if node.expr_scope:
            self.env = self.env_stack.pop()
        return node

    def visit_PyClassDefNode(self, node):
1264 1265
        self.visitchildren(node, ('dict', 'metaclass',
                                  'mkw', 'bases', 'class_result'))
1266 1267
        self.flow.mark_assignment(node.target, object_expr_not_none,
                                  self.env.lookup(node.name))
1268 1269 1270
        self.env_stack.append(self.env)
        self.env = node.scope
        self.flow.nextblock()
1271
        self.visitchildren(node, ('body',))
1272 1273 1274
        self.flow.nextblock()
        self.env = self.env_stack.pop()
        return node
1275 1276 1277 1278

    def visit_AmpersandNode(self, node):
        if node.operand.is_name:
            # Fake assignment to silence warning
1279
            self.mark_assignment(node.operand, fake_rhs_expr)
1280 1281
        self.visitchildren(node)
        return node