MemoryCheckpoint.java revision 13175:3df8ef613001 
1/*
2 * Copyright (c) 2011, 2016, 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.memory;
24
25import org.graalvm.compiler.graph.Node;
26import org.graalvm.compiler.nodes.FixedNode;
27import org.graalvm.compiler.nodes.FixedNodeInterface;
28import org.graalvm.word.LocationIdentity;
29
30/**
31 * This interface marks subclasses of {@link FixedNode} that kill a set of memory locations
32 * represented by location identities (i.e. change a value at one or more locations that belong to
33 * these location identities).
34 */
35public interface MemoryCheckpoint extends MemoryNode, FixedNodeInterface {
36
37    interface Single extends MemoryCheckpoint {
38
39        /**
40         * This method is used to determine which memory location is killed by this node. Returning
41         * the special value {@link LocationIdentity#any()} will kill all memory locations.
42         *
43         * @return the identity of the location killed by this node.
44         */
45        LocationIdentity getLocationIdentity();
46
47    }
48
49    interface Multi extends MemoryCheckpoint {
50
51        /**
52         * This method is used to determine which set of memory locations is killed by this node.
53         * Returning the special value {@link LocationIdentity#any()} will kill all memory
54         * locations.
55         *
56         * @return the identities of all locations killed by this node.
57         */
58        LocationIdentity[] getLocationIdentities();
59
60    }
61
62    class TypeAssertion {
63
64        public static boolean correctType(Node node) {
65            return !(node instanceof MemoryCheckpoint) || (node instanceof MemoryCheckpoint.Single ^ node instanceof MemoryCheckpoint.Multi);
66        }
67    }
68}
69