/*
 * Copyright (c) 2013, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.graal.phases.common;

import java.util.*;

import com.oracle.graal.debug.*;
import com.oracle.graal.graph.*;
import com.oracle.graal.graph.iterators.*;
import com.oracle.graal.nodes.*;
import com.oracle.graal.nodes.cfg.*;
import com.oracle.graal.nodes.extended.*;
import com.oracle.graal.phases.*;

public class OptimizeGuardAnchorsPhase extends Phase {
    private static final DebugMetric metricGuardsAnchorOptimized = Debug.metric("GuardsAnchorOptimized");
    private static final DebugMetric metricGuardsOptimizedAtSplit = Debug.metric("GuardsOptimizedAtSplit");

    public static class LazyCFG {
        private ControlFlowGraph cfg;
        private StructuredGraph graph;

        public LazyCFG(StructuredGraph graph) {
            this.graph = graph;
        }

        public ControlFlowGraph get() {
            if (cfg == null) {
                cfg = ControlFlowGraph.compute(graph, true, false, true, true);
            }
            return cfg;
        }
    }

    @Override
    protected void run(StructuredGraph graph) {
        LazyCFG cfg = new LazyCFG(graph);
        for (BeginNode begin : graph.getNodes(BeginNode.class)) {
            if (!(begin instanceof StartNode || begin.predecessor() instanceof ControlSplitNode)) {
                NodeIterable<GuardNode> guards = begin.guards();
                if (guards.isNotEmpty()) {
                    BeginNode newAnchor = computeOptimalAnchor(cfg.get(), begin);
                    // newAnchor == begin is possible because postdominator computation assumes that
                    // loops never end
                    if (newAnchor != begin) {
                        for (GuardNode guard : guards.snapshot()) {
                            guard.setAnchor(newAnchor);
                        }
                        metricGuardsAnchorOptimized.increment();
                    }
                }
            }
        }
        for (ControlSplitNode controlSplit : graph.getNodes(ControlSplitNode.class)) {
            optimizeAtControlSplit(controlSplit, cfg);
        }
    }

    public static BeginNode getOptimalAnchor(LazyCFG cfg, BeginNode begin) {
        if (begin instanceof StartNode || begin.predecessor() instanceof ControlSplitNode) {
            return begin;
        }
        return computeOptimalAnchor(cfg.get(), begin);
    }

    private static BeginNode computeOptimalAnchor(ControlFlowGraph cfg, BeginNode begin) {
        Block anchor = cfg.blockFor(begin);
        while (anchor.getDominator() != null && anchor.getDominator().getPostdominator() == anchor) {
            anchor = anchor.getDominator();
        }
        return anchor.getBeginNode();
    }

    private static void optimizeAtControlSplit(ControlSplitNode controlSplit, LazyCFG cfg) {
        BeginNode successor = findMinimumUsagesSuccessor(controlSplit);
        int successorCount = controlSplit.successors().count();
        List<GuardNode> otherGuards = new ArrayList<>(successorCount - 1);
        for (GuardNode guard : successor.guards().snapshot()) {
            if (guard.isDeleted() || guard.condition().usages().count() < successorCount) {
                continue;
            }
            for (GuardNode conditonGuard : guard.condition().usages().filter(GuardNode.class)) {
                if (conditonGuard != guard) {
                    AnchoringNode conditonGuardAnchor = conditonGuard.getAnchor();
                    if (conditonGuardAnchor.asNode().predecessor() == controlSplit && compatibleGuards(guard, conditonGuard)) {
                        otherGuards.add(conditonGuard);
                    }
                }
            }

            if (otherGuards.size() == successorCount - 1) {
                BeginNode anchor = computeOptimalAnchor(cfg.get(), BeginNode.prevBegin(controlSplit));
                GuardNode newGuard = controlSplit.graph().unique(GuardNode.create(guard.condition(), anchor, guard.reason(), guard.action(), guard.isNegated(), guard.getSpeculation()));
                for (GuardNode otherGuard : otherGuards) {
                    otherGuard.replaceAndDelete(newGuard);
                }
                guard.replaceAndDelete(newGuard);
                metricGuardsOptimizedAtSplit.increment();
            }
            otherGuards.clear();
        }
    }

    private static boolean compatibleGuards(GuardNode guard, GuardNode conditonGuard) {
        return conditonGuard.isNegated() == guard.isNegated() && conditonGuard.action() == guard.action() && conditonGuard.reason() == guard.reason() &&
                        conditonGuard.getSpeculation().equals(guard.getSpeculation());
    }

    private static BeginNode findMinimumUsagesSuccessor(ControlSplitNode controlSplit) {
        NodePosIterator successors = controlSplit.successors().iterator();
        BeginNode min = (BeginNode) successors.next();
        int minUsages = min.usages().count();
        while (successors.hasNext()) {
            BeginNode successor = (BeginNode) successors.next();
            int count = successor.usages().count();
            if (count < minUsages) {
                minUsages = count;
                min = successor;
            }
        }
        return min;
    }
}
