001/*
002 * Copyright (c) 2014, 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.compiler.match;
024
025import java.lang.annotation.*;
026
027import com.oracle.graal.nodes.*;
028
029/**
030 * Describes the properties of a node for use when building a {@link MatchPattern}. These
031 * declarations are required when parsing a {@link MatchRule}. They are expected to be found on a
032 * super type of the holder of the method declaring the {@link MatchRule}.
033 */
034@Retention(RetentionPolicy.RUNTIME)
035@Target(ElementType.TYPE)
036@Repeatable(value = MatchableNodes.class)
037public @interface MatchableNode {
038
039    /**
040     * The {@link ValueNode} subclass this annotation describes. These annotations might work better
041     * if they were directly on the node being described but that may complicate the annotation
042     * processing.
043     */
044    Class<? extends ValueNode> nodeClass();
045
046    /**
047     * The names of the inputs in the order they should appear in the match.
048     */
049    String[] inputs() default {};
050
051    /**
052     * Can a pattern be matched with the operands swapped. This will cause swapped versions of
053     * patterns to be automatically generated.
054     */
055    boolean commutative() default false;
056
057    /**
058     * Can a node with multiple uses be safely matched by a rule.
059     */
060    boolean shareable() default false;
061}