1 /*
   2  * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.graalvm.compiler.phases.common.inlining.walker;
  24 
  25 import org.graalvm.compiler.nodes.StructuredGraph;
  26 
  27 import jdk.vm.ci.meta.ResolvedJavaMethod;
  28 
  29 /**
  30  * Information about a graph that will potentially be inlined. This includes tracking the
  31  * invocations in graph that will subject to inlining themselves.
  32  */
  33 public abstract class CallsiteHolder {
  34 
  35     /**
  36      * Gets the method associated with the {@linkplain #graph() graph} represented by this object.
  37      */
  38     public abstract ResolvedJavaMethod method();
  39 
  40     /**
  41      * The stack realized by {@link InliningData} grows upon {@link InliningData#moveForward()}
  42      * deciding to explore (depth-first) a callsite of the graph associated to this
  43      * {@link CallsiteHolder}. The list of not-yet-considered callsites is managed by
  44      * {@link CallsiteHolderExplorable}, and this method reports whether any such candidates remain.
  45      */
  46     public abstract boolean hasRemainingInvokes();
  47 
  48     /**
  49      * The graph about which this object contains inlining information.
  50      */
  51     public abstract StructuredGraph graph();
  52 
  53 }