001/*
002 * Copyright (c) 2011, 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.memory;
024
025import jdk.internal.jvmci.meta.*;
026
027import com.oracle.graal.graph.*;
028import com.oracle.graal.nodes.*;
029
030/**
031 * This interface marks subclasses of {@link FixedNode} that kill a set of memory locations
032 * represented by location identities (i.e. change a value at one or more locations that belong to
033 * these location identities).
034 */
035public interface MemoryCheckpoint extends MemoryNode {
036
037    FixedNode asNode();
038
039    interface Single extends MemoryCheckpoint {
040
041        /**
042         * This method is used to determine which memory location is killed by this node. Returning
043         * the special value {@link LocationIdentity#any()} will kill all memory locations.
044         *
045         * @return the identity of the location killed by this node.
046         */
047        LocationIdentity getLocationIdentity();
048
049    }
050
051    interface Multi extends MemoryCheckpoint {
052
053        /**
054         * This method is used to determine which set of memory locations is killed by this node.
055         * Returning the special value {@link LocationIdentity#any()} will kill all memory
056         * locations.
057         *
058         * @return the identities of all locations killed by this node.
059         */
060        LocationIdentity[] getLocationIdentities();
061
062    }
063
064    public class TypeAssertion {
065
066        public static boolean correctType(Node node) {
067            return !(node instanceof MemoryCheckpoint) || (node instanceof MemoryCheckpoint.Single ^ node instanceof MemoryCheckpoint.Multi);
068        }
069    }
070}