Mercurial > hg > truffle

annotate graal/com.oracle.graal.phases/src/com/oracle/graal/phases/verify/VerifyUsageWithEquals.java @ 9800:2eaac2c3670b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
VerifyUsageWithEquals/VerifyPhase: add documentation
author Bernhard Urban <bernhard.urban@jku.at>
date Thu, 23 May 2013 12:00:40 +0200
parents 41de6947dbc9
children d1682d1df0a3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
1 /*
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
4 *
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
7 * published by the Free Software Foundation.
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
8 *
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
13 * accompanied this code).
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
14 *
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
18 *
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
21 * questions.
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
22 */
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
23 package com.oracle.graal.phases.verify;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
24
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
25 import com.oracle.graal.api.meta.*;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
26 import com.oracle.graal.nodes.*;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
27 import com.oracle.graal.nodes.calc.*;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
28 import com.oracle.graal.nodes.type.*;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
29 import com.oracle.graal.phases.*;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
30
9800
2eaac2c3670b VerifyUsageWithEquals/VerifyPhase: add documentation
Bernhard Urban <bernhard.urban@jku.at>
parents: 9799
diff changeset
31 /**
2eaac2c3670b VerifyUsageWithEquals/VerifyPhase: add documentation
Bernhard Urban <bernhard.urban@jku.at>
parents: 9799
diff changeset
32 * For certain types object identity should not be used for object equality check. This phase checks
2eaac2c3670b VerifyUsageWithEquals/VerifyPhase: add documentation
Bernhard Urban <bernhard.urban@jku.at>
parents: 9799
diff changeset
33 * the correct usage of the given type. Equality checks with == or != (except null checks) results
2eaac2c3670b VerifyUsageWithEquals/VerifyPhase: add documentation
Bernhard Urban <bernhard.urban@jku.at>
parents: 9799
diff changeset
34 * in an {@link AssertionError}.
2eaac2c3670b VerifyUsageWithEquals/VerifyPhase: add documentation
Bernhard Urban <bernhard.urban@jku.at>
parents: 9799
diff changeset
35 */
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
36 public class VerifyUsageWithEquals extends VerifyPhase {
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
37
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
38 private MetaAccessProvider runtime;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
39 private Class<?> klass;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
40
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
41 public VerifyUsageWithEquals(MetaAccessProvider runtime, Class<?> klass) {
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
42 this.runtime = runtime;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
43 this.klass = klass;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
44 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
45
9789
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
46 private boolean isAssignableType(ValueNode node) {
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
47 if (node.stamp() instanceof ObjectStamp) {
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
48 ResolvedJavaType valueType = runtime.lookupJavaType(klass);
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
49 ResolvedJavaType nodeType = node.objectStamp().type();
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
50
9799
41de6947dbc9 VerifyUsageWithEquals: check for null before passing it to isAssignableForm()
Bernhard Urban <bernhard.urban@jku.at>
parents: 9789
diff changeset
51 if (nodeType != null && valueType.isAssignableFrom(nodeType)) {
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
52 return true;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
53 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
54 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
55 return false;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
56 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
57
9789
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
58 private static boolean isNullConstant(ValueNode node) {
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
59 return node.isConstant() && node.asConstant().isNull();
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
60 }
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
61
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
62 private boolean checkUsage(ValueNode x, ValueNode y) {
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
63 return isAssignableType(x) && !isNullConstant(y);
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
64 }
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
65
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
66 private static boolean isEqualsMethod(StructuredGraph graph) {
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
67 Signature signature = graph.method().getSignature();
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
68 return graph.method().getName().equals("equals") && signature.getParameterCount(false) == 1 && signature.getParameterKind(0).equals(Kind.Object);
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
69 }
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
70
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
71 @Override
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
72 protected boolean verify(StructuredGraph graph) {
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
73 for (ObjectEqualsNode cn : graph.getNodes().filter(ObjectEqualsNode.class)) {
9789
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
74 if (!isEqualsMethod(graph)) {
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
75 // bail out if we compare an object of type klass with == or != (except null checks)
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
76 assert !(checkUsage(cn.x(), cn.y()) && checkUsage(cn.y(), cn.x())) : "VerifyUsage of " + klass.getName() + ": " + cn.x() + " or " + cn.y() + " in " + graph.method() +
ad50389f1da4 VerifyUsageWithEquals: refactoring
Bernhard Urban <bernhard.urban@jku.at>
parents: 9788
diff changeset
77 " uses object identity. Should use equals() instead.";
9788
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
78 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
79 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
80 return true;
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
81 }
1bd67c5bdab8 VerifyUsageWithEquals: allow to pass a class to the phase
Bernhard Urban <bernhard.urban@jku.at>
parents:
diff changeset
82 }