001/*
002 * Copyright (c) 2013, 2013, 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.nodes.spi.*;
026
027/**
028 * Interface implemented by nodes which may need {@linkplain FrameState deoptimization information}.
029 */
030public interface DeoptimizingNode extends NodeWithState {
031
032    /**
033     * Determines if this node needs deoptimization information.
034     */
035    boolean canDeoptimize();
036
037    /**
038     * Interface for nodes that need a {@link FrameState} for deoptimizing to a point before their
039     * execution.
040     */
041    public interface DeoptBefore extends DeoptimizingNode {
042
043        /**
044         * Sets the {@link FrameState} describing the program state before the execution of this
045         * node.
046         */
047        void setStateBefore(FrameState state);
048
049        FrameState stateBefore();
050    }
051
052    /**
053     * Interface for nodes that need a {@link FrameState} for deoptimizing to a point after their
054     * execution.
055     */
056    public interface DeoptAfter extends DeoptimizingNode, StateSplit {
057    }
058
059    /**
060     * Interface for nodes that need a special {@link FrameState} for deoptimizing during their
061     * execution (e.g. {@link Invoke}).
062     */
063    public interface DeoptDuring extends DeoptimizingNode, StateSplit {
064
065        FrameState stateDuring();
066
067        /**
068         * Sets the {@link FrameState} describing the program state during the execution of this
069         * node.
070         */
071        void setStateDuring(FrameState state);
072
073        /**
074         * Compute the {@link FrameState} describing the program state during the execution of this
075         * node from an input {@link FrameState} describing the program state after finishing the
076         * execution of this node.
077         */
078        void computeStateDuring(FrameState stateAfter);
079    }
080}