/*
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


package org.graalvm.compiler.nodeinfo;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_UNSET;
import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_UNSET;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface NodeInfo {

    String shortName() default "";

    
The template used to build the Verbosity.Name version. Variable part are specified using {i#inputName} or {p#propertyName}. /**
     * The template used to build the {@link Verbosity#Name} version. Variable part are specified
     * using {i#inputName} or {p#propertyName}.
     */
    String nameTemplate() default "";

    InputType[] allowedUsageTypes() default {};

    
An estimation of the number of CPU cycles needed to execute this node that can be used to compare its execution cost against other nodes. Implementations of graph cost models based on this value might throw an exception if a node's NodeCycles value is NodeCycles.CYCLES_UNSET. As such, it is recommended to specify a value for nodes likely to be inputs to a graph cost model. /**
     * An estimation of the number of CPU cycles needed to execute this node that can be used to
     * compare its execution cost against other nodes.
     *
     * Implementations of graph cost models based on this value might throw an exception if a node's
     * {@link NodeCycles} value is {@link NodeCycles#CYCLES_UNSET}. As such, it is recommended to
     * specify a value for nodes likely to be inputs to a graph cost model.
     */
    NodeCycles cycles() default CYCLES_UNSET;

    
A rationale for the chosen cycles() value. /**
     * A rationale for the chosen {@link NodeInfo#cycles()} value.
     */
    String cyclesRationale() default "";

    
An estimation of the code size needed to represent this node in machine code that can be used to compare its size cost against other nodes. Implementations of graph cost models based on this value might throw an exception if a node's NodeSize value is NodeSize.SIZE_UNSET. As such, it is recommended to specify a value for nodes likely to be inputs to a graph cost model. /**
     * An estimation of the code size needed to represent this node in machine code that can be used
     * to compare its size cost against other nodes.
     *
     * Implementations of graph cost models based on this value might throw an exception if a node's
     * {@link NodeSize} value is {@link NodeSize#SIZE_UNSET}. As such, it is recommended to specify
     * a value for nodes likely to be inputs to a graph cost model.
     */
    NodeSize size() default SIZE_UNSET;

    
A rationale for the chosen size() value. /**
     * A rationale for the chosen {@link NodeInfo#size()} value.
     */
    String sizeRationale() default "";
}