1/*
2 * Copyright (c) 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.instrumentation;
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.InputType;
31import org.graalvm.compiler.nodeinfo.NodeInfo;
32import org.graalvm.compiler.nodes.ValueNode;
33import org.graalvm.compiler.nodes.calc.FloatingNode;
34import org.graalvm.compiler.nodes.java.MonitorIdNode;
35import org.graalvm.compiler.nodes.java.RawMonitorEnterNode;
36
37/**
38 * The {@code MonitorProxyNode} represents the InstrumentationNode's target when the original
39 * MonitorEnterNode is invalid. Such situation occurs when the escape analysis removes the
40 * MonitorEnterNode and aggregates the monitor logic in a CommitAllocationNode.
41 */
42@NodeInfo(cycles = CYCLES_IGNORED, size = SIZE_IGNORED)
43public class MonitorProxyNode extends FloatingNode {
44
45    public static final NodeClass<MonitorProxyNode> TYPE = NodeClass.create(MonitorProxyNode.class);
46
47    @OptionalInput(value = InputType.Unchecked) protected ValueNode object;
48    @OptionalInput(value = InputType.Association) protected MonitorIdNode monitorId;
49
50    public MonitorProxyNode(ValueNode object, MonitorIdNode monitorId) {
51        super(TYPE, StampFactory.forVoid());
52        this.object = object;
53        this.monitorId = monitorId;
54    }
55
56    public ValueNode object() {
57        return object;
58    }
59
60    public MonitorIdNode getMonitorId() {
61        return monitorId;
62    }
63
64    /**
65     * @return the first RawMonitorEnterNode that shares the same MonitorIdNode and the same lock
66     *         object with this MonitorProxyNode.
67     */
68    public RawMonitorEnterNode findFirstMatch() {
69        for (RawMonitorEnterNode monitorEnter : monitorId.usages().filter(RawMonitorEnterNode.class)) {
70            if (monitorEnter.object() == object) {
71                return monitorEnter;
72            }
73        }
74        return null;
75    }
76
77}
78