001/*
002 * Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.nodes;
024
025import com.oracle.graal.compiler.common.type.*;
026import com.oracle.graal.graph.*;
027import com.oracle.graal.nodeinfo.*;
028
029/**
030 * The {@code ControlSplitNode} is a base class for all instructions that split the control flow
031 * (ie. have more than one successor).
032 */
033@NodeInfo
034public abstract class ControlSplitNode extends FixedNode implements IterableNodeType {
035    public static final NodeClass<ControlSplitNode> TYPE = NodeClass.create(ControlSplitNode.class);
036
037    protected ControlSplitNode(NodeClass<? extends ControlSplitNode> c, Stamp stamp) {
038        super(c, stamp);
039    }
040
041    public abstract double probability(AbstractBeginNode successor);
042
043    /**
044     * Primary successor of the control split. Data dependencies on the node have to be scheduled in
045     * the primary successor.
046     *
047     * @return the primary successor
048     */
049    public abstract AbstractBeginNode getPrimarySuccessor();
050}