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.phases.common.inlining.walker;
024
025import jdk.internal.jvmci.meta.*;
026
027import com.oracle.graal.nodes.*;
028
029/**
030 * Information about a graph that will potentially be inlined. This includes tracking the
031 * invocations in graph that will subject to inlining themselves.
032 */
033public abstract class CallsiteHolder {
034
035    /**
036     * Gets the method associated with the {@linkplain #graph() graph} represented by this object.
037     */
038    public abstract ResolvedJavaMethod method();
039
040    /**
041     * The stack realized by {@link InliningData} grows upon {@link InliningData#moveForward()}
042     * deciding to explore (depth-first) a callsite of the graph associated to this
043     * {@link CallsiteHolder}. The list of not-yet-considered callsites is managed by
044     * {@link CallsiteHolderExplorable}, and this method reports whether any such candidates remain.
045     */
046    public abstract boolean hasRemainingInvokes();
047
048    /**
049     * The graph about which this object contains inlining information.
050     */
051    public abstract StructuredGraph graph();
052
053}