1 /*
   2  * Copyright (c) 2016, 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.nodes.spi;
  24 
  25 import org.graalvm.compiler.graph.Node;
  26 import org.graalvm.compiler.nodeinfo.NodeCycles;
  27 import org.graalvm.compiler.nodeinfo.NodeInfo;
  28 import org.graalvm.compiler.nodeinfo.NodeSize;
  29 
  30 /**
  31  * A provider that enables overriding and customization of the {@link NodeCycles} and
  32  * {@link NodeSize} values for a {@linkplain Node node}.
  33  */
  34 public interface NodeCostProvider {
  35 
  36     /**
  37      * Gets the estimated size of machine code generated for {@code n}.
  38      */
  39     int getEstimatedCodeSize(Node n);
  40 
  41     /**
  42      * Gets the estimated execution cost for {@code n} in terms of CPU cycles.
  43      */
  44     int getEstimatedCPUCycles(Node n);
  45 
  46     /**
  47      * @see NodeInfo#size()
  48      */
  49     NodeSize size(Node n);
  50 
  51     /**
  52      * @see NodeInfo#cycles()
  53      */
  54     NodeCycles cycles(Node n);
  55 
  56 }