1 /*
   2  * Copyright (c) 2011, 2019, 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 
  24 
  25 package org.graalvm.compiler.phases.common.inlining.policy;
  26 
  27 import org.graalvm.compiler.nodes.StructuredGraph;
  28 import org.graalvm.compiler.nodes.spi.Replacements;
  29 import org.graalvm.compiler.phases.common.inlining.info.InlineInfo;
  30 import org.graalvm.compiler.phases.common.inlining.walker.MethodInvocation;
  31 
  32 public interface InliningPolicy {
  33     class Decision {
  34         public static final Decision YES = new Decision(true, "(unknown reason)");
  35         public static final Decision NO = new Decision(false, "(unknown reason)");
  36 
  37         private final boolean shouldInline;
  38         private final String reason;
  39 
  40         private Decision(boolean shouldInline, String reason) {
  41             this.shouldInline = shouldInline;
  42             this.reason = reason;
  43         }
  44 
  45         public boolean shouldInline() {
  46             return shouldInline;
  47         }
  48 
  49         public String getReason() {
  50             return reason;
  51         }
  52 
  53         public Decision withReason(boolean isTracing, String newReason, Object... args) {
  54             if (isTracing) {
  55                 return new Decision(shouldInline, String.format(newReason, args));
  56             } else {
  57                 return this;
  58             }
  59         }
  60     }
  61 
  62     boolean continueInlining(StructuredGraph graph);
  63 
  64     Decision isWorthInlining(Replacements replacements, MethodInvocation invocation, InlineInfo calleeInfo, int inliningDepth, boolean fullyProcessed);
  65 }