annotate graal/com.oracle.jvmci.debug/src/com/oracle/jvmci/debug/Fingerprint.java @ 21754:aa5fa1190d6c

count all type check hint misses not just the last one
author Doug Simon <doug.simon@oracle.com>
date Fri, 05 Jun 2015 23:03:41 +0200
parents d563baeca9df
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
1 /*
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
4 *
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
7 * published by the Free Software Foundation.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
8 *
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
13 * accompanied this code).
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
14 *
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
18 *
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
21 * questions.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
22 */
21554
b1530a6cce8c renamed com.oracle.graal.[debug|options|hotspotvmconfig]* modules to com.oracle.jvmci.[debug|options|hotspotvmconfig]* modules (JBS:GRAAL-53)
Doug Simon <doug.simon@oracle.com>
parents: 18894
diff changeset
23 package com.oracle.jvmci.debug;
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
24
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
25 import java.util.*;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
26 import java.util.stream.*;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
27
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
28 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
29 * Facility for fingerprinting execution.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
30 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
31 public class Fingerprint implements AutoCloseable {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
32
21558
d563baeca9df changed uses of Graal terminology to JVMCI (JBS:GRAAL-53)
Doug Simon <doug.simon@oracle.com>
parents: 21554
diff changeset
33 public static final String ENABLED_PROPERTY_NAME = "jvmci.fingerprint";
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
34
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
35 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
36 * Determines whether fingerprinting is enabled. This is set by the
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
37 * {@value #ENABLED_PROPERTY_NAME} system property when this class is initialized.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
38 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
39 public static final boolean ENABLED = Boolean.getBoolean(ENABLED_PROPERTY_NAME);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
40
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
41 private static final ThreadLocal<Fingerprint> current = ENABLED ? new ThreadLocal<>() : null;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
42
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
43 private final List<String> events;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
44 private int index;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
45
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
46 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
47 * Creates an object to record a fingerprint.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
48 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
49 public Fingerprint() {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
50 events = new ArrayList<>();
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
51 index = -1;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
52 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
53
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
54 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
55 * Creates an object to verify execution matches a given fingerprint.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
56 *
18894
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
57 * @param toVerifyAgainst the fingerprint events to verify against
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
58 */
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
59 public Fingerprint(List<String> toVerifyAgainst) {
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
60 this.events = toVerifyAgainst;
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
61 index = 0;
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
62 }
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
63
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
64 /**
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
65 * Creates an object to verify execution matches a given fingerprint.
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
66 *
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
67 * @param toVerifyAgainst the fingerprint to verify against
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
68 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
69 public Fingerprint(Fingerprint toVerifyAgainst) {
18894
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
70 this(toVerifyAgainst.events);
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
71 }
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
72
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
73 public Collection<String> getEvents() {
203618cfd638 added Fingerprint constructor that takes a list of events
Doug Simon <doug.simon@oracle.com>
parents: 18883
diff changeset
74 return Collections.unmodifiableCollection(events);
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
75 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
76
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
77 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
78 * Starts fingerprint recording or verification for the current thread. At most one fingerprint
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
79 * object can be active for any thread.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
80 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
81 public Fingerprint open() {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
82 if (ENABLED) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
83 assert current.get() == null;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
84 current.set(this);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
85 return this;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
86 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
87 return null;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
88 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
89
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
90 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
91 * Finishes fingerprint recording or verification for the current thread.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
92 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
93 public void close() {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
94 if (ENABLED) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
95 assert current.get() == this;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
96 current.set(null);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
97 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
98 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
99
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
100 private static final int BREAKPOINT_EVENT = Integer.getInteger(ENABLED_PROPERTY_NAME + ".breakpointEvent", -1);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
101
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
102 /**
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
103 * Submits an execution event for the purpose of recording or verifying a fingerprint. This must
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
104 * only be called if {@link #ENABLED} is {@code true}.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
105 */
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
106 public static void submit(String format, Object... args) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
107 assert ENABLED : "fingerprinting must be enabled (-D" + ENABLED_PROPERTY_NAME + "=true)";
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
108 Fingerprint fingerprint = current.get();
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
109 if (fingerprint != null) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
110 int eventId = fingerprint.nextEventId();
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
111 if (eventId == BREAKPOINT_EVENT) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
112 // Set IDE breakpoint on the following line and set the relevant
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
113 // system property to debug a fingerprint verification error.
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
114 System.console();
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
115 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
116 fingerprint.event(String.format(eventId + ": " + format, args));
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
117 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
118 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
119
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
120 private int nextEventId() {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
121 return index == -1 ? events.size() : index;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
122 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
123
21558
d563baeca9df changed uses of Graal terminology to JVMCI (JBS:GRAAL-53)
Doug Simon <doug.simon@oracle.com>
parents: 21554
diff changeset
124 private static final int MAX_EVENT_TAIL_IN_ERROR_MESSAGE = Integer.getInteger("jvmci.fingerprint.errorEventTailLength", 50);
18883
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
125
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
126 private String tail() {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
127 int start = Math.max(index - MAX_EVENT_TAIL_IN_ERROR_MESSAGE, 0);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
128 return events.subList(start, index).stream().collect(Collectors.joining(String.format("%n")));
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
129 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
130
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
131 private void event(String entry) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
132 if (index == -1) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
133 events.add(entry);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
134 } else {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
135 if (index > events.size()) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
136 throw new InternalError(String.format("%s%nOriginal fingerprint limit reached", tail()));
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
137 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
138 String l = events.get(index);
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
139 if (!l.equals(entry)) {
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
140 throw new InternalError(String.format("%s%nFingerprint differs at event %d%nexpected: %s%n actual: %s", tail(), index, l, entry));
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
141 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
142 index++;
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
143 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
144 }
fe7a58f50fe4 added Fingerprint class
Doug Simon <doug.simon@oracle.com>
parents:
diff changeset
145 }