ArrayRangeWriteNode.java revision 12651:6ef01bd40ce2 
1/*
2 * Copyright (c) 2013, 2015, 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.nodes.extended;
24
25import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_UNKNOWN;
26import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_UNKNOWN;
27
28import org.graalvm.compiler.core.common.type.Stamp;
29import org.graalvm.compiler.graph.NodeClass;
30import org.graalvm.compiler.nodeinfo.NodeInfo;
31import org.graalvm.compiler.nodes.ValueNode;
32import org.graalvm.compiler.nodes.memory.AbstractMemoryCheckpoint;
33
34/**
35 * Base class for nodes that modify a range of an array.
36 */
37@NodeInfo(cycles = CYCLES_UNKNOWN, size = SIZE_UNKNOWN)
38public abstract class ArrayRangeWriteNode extends AbstractMemoryCheckpoint {
39
40    public static final NodeClass<ArrayRangeWriteNode> TYPE = NodeClass.create(ArrayRangeWriteNode.class);
41
42    protected ArrayRangeWriteNode(NodeClass<? extends ArrayRangeWriteNode> c, Stamp stamp) {
43        super(c, stamp);
44    }
45
46    /**
47     * The array that is written to.
48     */
49    public abstract ValueNode getArray();
50
51    /**
52     * The first modified index.
53     */
54    public abstract ValueNode getIndex();
55
56    /**
57     * The length of the modified range.
58     */
59    public abstract ValueNode getLength();
60
61    /**
62     * Return true if the written array is an object array, false if it is a primitive array.
63     */
64    public abstract boolean isObjectArray();
65
66    /**
67     * Returns whether this write is the initialization of the written location. If it is true, the
68     * old value of the memory location is either uninitialized or zero. If it is false, the memory
69     * location is guaranteed to contain a valid value or zero.
70     */
71    public abstract boolean isInitialization();
72}
73