001/*
002 * Copyright (c) 2013, 2015, 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.nodes.extended;
024
025import com.oracle.graal.compiler.common.type.*;
026import com.oracle.graal.graph.*;
027import com.oracle.graal.nodeinfo.*;
028import com.oracle.graal.nodes.*;
029import com.oracle.graal.nodes.memory.*;
030
031/**
032 * Base class for nodes that modify a range of an array.
033 */
034@NodeInfo
035public abstract class ArrayRangeWriteNode extends AbstractMemoryCheckpoint {
036
037    public static final NodeClass<ArrayRangeWriteNode> TYPE = NodeClass.create(ArrayRangeWriteNode.class);
038
039    protected ArrayRangeWriteNode(NodeClass<? extends ArrayRangeWriteNode> c, Stamp stamp) {
040        super(c, stamp);
041    }
042
043    /**
044     * The array that is written to.
045     */
046    public abstract ValueNode getArray();
047
048    /**
049     * The first modified index.
050     */
051    public abstract ValueNode getIndex();
052
053    /**
054     * The length of the modified range.
055     */
056    public abstract ValueNode getLength();
057
058    /**
059     * Return true if the written array is an object array, false if it is a primitive array.
060     */
061    public abstract boolean isObjectArray();
062
063    /**
064     * Returns whether this write is the initialization of the written location. If it is true, the
065     * old value of the memory location is either uninitialized or zero. If it is false, the memory
066     * location is guaranteed to contain a valid value or zero.
067     */
068    public abstract boolean isInitialization();
069}