InstructionValueProcedure.java revision 12657:6ef01bd40ce2
1/*
2 * Copyright (c) 2014, 2014, 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 */
23package org.graalvm.compiler.lir;
24
25import java.util.EnumSet;
26
27import org.graalvm.compiler.lir.LIRInstruction.OperandFlag;
28import org.graalvm.compiler.lir.LIRInstruction.OperandMode;
29
30import jdk.vm.ci.meta.Value;
31
32/**
33 * Functional interface for iterating over a list of values, possibly returning a value to replace
34 * the old value.
35 */
36@FunctionalInterface
37public interface InstructionValueProcedure {
38
39    /**
40     * Iterator method to be overwritten.
41     *
42     * @param instruction The current instruction.
43     * @param value The value that is iterated.
44     * @param mode The operand mode for the value.
45     * @param flags A set of flags for the value.
46     * @return The new value to replace the value that was passed in.
47     */
48    Value doValue(LIRInstruction instruction, Value value, OperandMode mode, EnumSet<OperandFlag> flags);
49
50}
51