VerifyHeapNode.java revision 13017:134219a5b0ec 
1/*
2 * Copyright (c) 2014, 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.debug;
24
25import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_IGNORED;
26import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_IGNORED;
27
28import org.graalvm.compiler.core.common.type.StampFactory;
29import org.graalvm.compiler.graph.NodeClass;
30import org.graalvm.compiler.nodeinfo.NodeInfo;
31import org.graalvm.compiler.nodes.FixedNode;
32import org.graalvm.compiler.nodes.FixedWithNextNode;
33import org.graalvm.compiler.nodes.StructuredGraph;
34import org.graalvm.compiler.nodes.spi.Lowerable;
35import org.graalvm.compiler.nodes.spi.LoweringTool;
36
37/**
38 * A node for platform dependent verification of the Java heap. Intended to be used for debugging
39 * heap corruption issues.
40 */
41//@formatter:off
42@NodeInfo(size = SIZE_IGNORED,
43        sizeRationale = "Node is a debugging node that should not be used in production.",
44        cycles = CYCLES_IGNORED,
45        cyclesRationale = "Node is a debugging node that should not be used in production.")
46//@formatter:on
47public final class VerifyHeapNode extends FixedWithNextNode implements Lowerable {
48
49    public static final NodeClass<VerifyHeapNode> TYPE = NodeClass.create(VerifyHeapNode.class);
50
51    public VerifyHeapNode() {
52        super(TYPE, StampFactory.forVoid());
53    }
54
55    @Override
56    public void lower(LoweringTool tool) {
57        tool.getLowerer().lower(this, tool);
58    }
59
60    public static void addBefore(FixedNode position) {
61        StructuredGraph graph = position.graph();
62        graph.addBeforeFixed(position, graph.add(new VerifyHeapNode()));
63    }
64
65    public static void addAfter(FixedWithNextNode position) {
66        StructuredGraph graph = position.graph();
67        graph.addAfterFixed(position, graph.add(new VerifyHeapNode()));
68    }
69
70}
71