001/*
002 * Copyright (c) 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.spi;
024
025/**
026 * This interface allows a node to convey information about what its effect would be if some of its
027 * inputs were virtualized. The {@link #virtualize(VirtualizerTool)} method will only be called for
028 * nodes that have some interaction with virtualized nodes. However, the virtualized nodes might
029 * have been re-materialized in the meantime.
030 */
031public interface Virtualizable {
032
033    /**
034     * A node class can implement this method to convey information about what its effect would be
035     * if some of its inputs were virtualized. All modifications must be made through the supplied
036     * tool, and not directly on the node, because by the time this method is called the
037     * virtualized/non-virtualized state is still speculative and might not hold because of loops,
038     * etc.
039     *
040     * @param tool the tool used to describe the effects of this node
041     */
042    void virtualize(VirtualizerTool tool);
043}