annotate src/share/vm/code/debugInfoRec.hpp @ 4583:597bc897257d

Made DebugInformationRecorder::describe_scope() take both a methodHandle _and_ a ciMethod* parameter to avoid creating handles in scopes where it is not allowed.
author Doug Simon <doug.simon@oracle.com>
date Mon, 13 Feb 2012 23:15:53 +0100
parents 648a7873cea2
children 51111665eda6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
2 * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1253
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1253
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 1253
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
25 #ifndef SHARE_VM_CODE_DEBUGINFOREC_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
26 #define SHARE_VM_CODE_DEBUGINFOREC_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
27
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
28 #include "ci/ciClassList.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
29 #include "ci/ciInstanceKlass.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
30 #include "ci/ciMethod.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
31 #include "code/debugInfo.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
32 #include "code/location.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
33 #include "code/pcDesc.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
34 #include "compiler/oopMap.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
35 #include "oops/oop.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
36 #include "utilities/growableArray.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
37
0
a61af66fc99e Initial load
duke
parents:
diff changeset
38 //** The DebugInformationRecorder collects debugging information
a61af66fc99e Initial load
duke
parents:
diff changeset
39 // for a compiled method.
a61af66fc99e Initial load
duke
parents:
diff changeset
40 // Debugging information is used for:
a61af66fc99e Initial load
duke
parents:
diff changeset
41 // - garbage collecting compiled frames
a61af66fc99e Initial load
duke
parents:
diff changeset
42 // - stack tracing across compiled frames
a61af66fc99e Initial load
duke
parents:
diff changeset
43 // - deoptimizating compiled frames
a61af66fc99e Initial load
duke
parents:
diff changeset
44 //
a61af66fc99e Initial load
duke
parents:
diff changeset
45 // The implementation requires the compiler to use the recorder
a61af66fc99e Initial load
duke
parents:
diff changeset
46 // in the following order:
a61af66fc99e Initial load
duke
parents:
diff changeset
47 // 1) Describe debug information for safepoints at increasing addresses.
a61af66fc99e Initial load
duke
parents:
diff changeset
48 // a) Add safepoint entry (use add_safepoint or add_non_safepoint)
a61af66fc99e Initial load
duke
parents:
diff changeset
49 // b) Describe scopes for that safepoint
a61af66fc99e Initial load
duke
parents:
diff changeset
50 // - create locals if needed (use create_scope_values)
a61af66fc99e Initial load
duke
parents:
diff changeset
51 // - create expressions if needed (use create_scope_values)
a61af66fc99e Initial load
duke
parents:
diff changeset
52 // - create monitor stack if needed (use create_monitor_values)
a61af66fc99e Initial load
duke
parents:
diff changeset
53 // - describe scope (use describe_scope)
a61af66fc99e Initial load
duke
parents:
diff changeset
54 // "repeat last four steps for all scopes"
a61af66fc99e Initial load
duke
parents:
diff changeset
55 // "outer most scope first and inner most scope last"
a61af66fc99e Initial load
duke
parents:
diff changeset
56 // NB: nodes from create_scope_values and create_locations
a61af66fc99e Initial load
duke
parents:
diff changeset
57 // can be reused for simple sharing.
a61af66fc99e Initial load
duke
parents:
diff changeset
58 // - mark the end of the scopes (end_safepoint or end_non_safepoint)
a61af66fc99e Initial load
duke
parents:
diff changeset
59 // 2) Use oop_size, data_size, pcs_size to create the nmethod and
a61af66fc99e Initial load
duke
parents:
diff changeset
60 // finally migrate the debugging information into the nmethod
a61af66fc99e Initial load
duke
parents:
diff changeset
61 // by calling copy_to.
a61af66fc99e Initial load
duke
parents:
diff changeset
62
a61af66fc99e Initial load
duke
parents:
diff changeset
63 class DebugToken; // Opaque datatype for stored:
a61af66fc99e Initial load
duke
parents:
diff changeset
64 // - GrowableArray<ScopeValue*>
a61af66fc99e Initial load
duke
parents:
diff changeset
65 // - GrowableArray<MonitorValue*>
a61af66fc99e Initial load
duke
parents:
diff changeset
66
a61af66fc99e Initial load
duke
parents:
diff changeset
67 // Alias for InvocationEntryBci.
a61af66fc99e Initial load
duke
parents:
diff changeset
68 // Both constants are used for a pseudo-BCI which refers
a61af66fc99e Initial load
duke
parents:
diff changeset
69 // to the state just _before_ a method is entered.
a61af66fc99e Initial load
duke
parents:
diff changeset
70 // SynchronizationEntryBCI is used where the emphasis
a61af66fc99e Initial load
duke
parents:
diff changeset
71 // is on the implicit monitorenter of a synchronized method.
a61af66fc99e Initial load
duke
parents:
diff changeset
72 const int SynchronizationEntryBCI = InvocationEntryBci;
a61af66fc99e Initial load
duke
parents:
diff changeset
73
a61af66fc99e Initial load
duke
parents:
diff changeset
74 class DIR_Chunk; // private class, a nugget of collected information
a61af66fc99e Initial load
duke
parents:
diff changeset
75
a61af66fc99e Initial load
duke
parents:
diff changeset
76 class DebugInformationRecorder: public ResourceObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
77 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
78 // constructor
a61af66fc99e Initial load
duke
parents:
diff changeset
79 DebugInformationRecorder(OopRecorder* oop_recorder);
a61af66fc99e Initial load
duke
parents:
diff changeset
80
a61af66fc99e Initial load
duke
parents:
diff changeset
81 // adds an oopmap at a specific offset
a61af66fc99e Initial load
duke
parents:
diff changeset
82 void add_oopmap(int pc_offset, OopMap* map);
a61af66fc99e Initial load
duke
parents:
diff changeset
83
a61af66fc99e Initial load
duke
parents:
diff changeset
84 // adds a jvm mapping at pc-offset, for a safepoint only
a61af66fc99e Initial load
duke
parents:
diff changeset
85 void add_safepoint(int pc_offset, OopMap* map);
a61af66fc99e Initial load
duke
parents:
diff changeset
86
a61af66fc99e Initial load
duke
parents:
diff changeset
87 // adds a jvm mapping at pc-offset, for a non-safepoint (profile point)
a61af66fc99e Initial load
duke
parents:
diff changeset
88 void add_non_safepoint(int pc_offset);
a61af66fc99e Initial load
duke
parents:
diff changeset
89
a61af66fc99e Initial load
duke
parents:
diff changeset
90 // Describes debugging information for a scope at the given pc_offset.
a61af66fc99e Initial load
duke
parents:
diff changeset
91 // Calls must be in non-decreasing order of pc_offset.
a61af66fc99e Initial load
duke
parents:
diff changeset
92 // If there are several calls at a single pc_offset,
a61af66fc99e Initial load
duke
parents:
diff changeset
93 // then they occur in the same order as they were performed by the JVM,
a61af66fc99e Initial load
duke
parents:
diff changeset
94 // with the most recent (innermost) call being described last.
a61af66fc99e Initial load
duke
parents:
diff changeset
95 // For a safepoint, the pc_offset must have been mentioned
a61af66fc99e Initial load
duke
parents:
diff changeset
96 // previously by add_safepoint.
a61af66fc99e Initial load
duke
parents:
diff changeset
97 // Otherwise, the pc_offset must have been mentioned previously
a61af66fc99e Initial load
duke
parents:
diff changeset
98 // by add_non_safepoint, and the locals, expressions, and monitors
a61af66fc99e Initial load
duke
parents:
diff changeset
99 // must all be null.
a61af66fc99e Initial load
duke
parents:
diff changeset
100 void describe_scope(int pc_offset,
4583
597bc897257d Made DebugInformationRecorder::describe_scope() take both a methodHandle _and_ a ciMethod* parameter to avoid creating handles in scopes where it is not allowed.
Doug Simon <doug.simon@oracle.com>
parents: 4417
diff changeset
101 methodHandle methodH,
597bc897257d Made DebugInformationRecorder::describe_scope() take both a methodHandle _and_ a ciMethod* parameter to avoid creating handles in scopes where it is not allowed.
Doug Simon <doug.simon@oracle.com>
parents: 4417
diff changeset
102 ciMethod* method,
0
a61af66fc99e Initial load
duke
parents:
diff changeset
103 int bci,
900
9987d9d5eb0e 6833129: specjvm98 fails with NullPointerException in the compiler with -XX:DeoptimizeALot
cfang
parents: 0
diff changeset
104 bool reexecute,
4417
648a7873cea2 Made it possible to build and run the client and server VM with a new '--vm' option to 'mx build' and a global option of the same name.
Doug Simon <doug.simon@oracle.com>
parents: 3650
diff changeset
105 bool rethrow_exception = false,
1135
e66fd840cb6b 6893081: method handle & invokedynamic code needs additional cleanup (post 6815692, 6858164)
twisti
parents: 948
diff changeset
106 bool is_method_handle_invoke = false,
1253
f70b0d9ab095 6910618: C2: Error: assert(d->is_oop(),"JVM_ArrayCopy: dst not an oop")
kvn
parents: 1135
diff changeset
107 bool return_oop = false,
0
a61af66fc99e Initial load
duke
parents:
diff changeset
108 DebugToken* locals = NULL,
a61af66fc99e Initial load
duke
parents:
diff changeset
109 DebugToken* expressions = NULL,
a61af66fc99e Initial load
duke
parents:
diff changeset
110 DebugToken* monitors = NULL);
a61af66fc99e Initial load
duke
parents:
diff changeset
111
a61af66fc99e Initial load
duke
parents:
diff changeset
112
a61af66fc99e Initial load
duke
parents:
diff changeset
113 void dump_object_pool(GrowableArray<ScopeValue*>* objects);
a61af66fc99e Initial load
duke
parents:
diff changeset
114
a61af66fc99e Initial load
duke
parents:
diff changeset
115 // This call must follow every add_safepoint,
a61af66fc99e Initial load
duke
parents:
diff changeset
116 // after any intervening describe_scope calls.
a61af66fc99e Initial load
duke
parents:
diff changeset
117 void end_safepoint(int pc_offset) { end_scopes(pc_offset, true); }
a61af66fc99e Initial load
duke
parents:
diff changeset
118 void end_non_safepoint(int pc_offset) { end_scopes(pc_offset, false); }
a61af66fc99e Initial load
duke
parents:
diff changeset
119
a61af66fc99e Initial load
duke
parents:
diff changeset
120 // helper fuctions for describe_scope to enable sharing
a61af66fc99e Initial load
duke
parents:
diff changeset
121 DebugToken* create_scope_values(GrowableArray<ScopeValue*>* values);
a61af66fc99e Initial load
duke
parents:
diff changeset
122 DebugToken* create_monitor_values(GrowableArray<MonitorValue*>* monitors);
a61af66fc99e Initial load
duke
parents:
diff changeset
123
a61af66fc99e Initial load
duke
parents:
diff changeset
124 // returns the size of the generated scopeDescs.
a61af66fc99e Initial load
duke
parents:
diff changeset
125 int data_size();
a61af66fc99e Initial load
duke
parents:
diff changeset
126 int pcs_size();
a61af66fc99e Initial load
duke
parents:
diff changeset
127 int oop_size() { return oop_recorder()->oop_size(); }
a61af66fc99e Initial load
duke
parents:
diff changeset
128
a61af66fc99e Initial load
duke
parents:
diff changeset
129 // copy the generated debugging information to nmethod
a61af66fc99e Initial load
duke
parents:
diff changeset
130 void copy_to(nmethod* nm);
a61af66fc99e Initial load
duke
parents:
diff changeset
131
a61af66fc99e Initial load
duke
parents:
diff changeset
132 // verifies the debug information
a61af66fc99e Initial load
duke
parents:
diff changeset
133 void verify(const nmethod* code);
a61af66fc99e Initial load
duke
parents:
diff changeset
134
a61af66fc99e Initial load
duke
parents:
diff changeset
135 static void print_statistics() PRODUCT_RETURN;
a61af66fc99e Initial load
duke
parents:
diff changeset
136
a61af66fc99e Initial load
duke
parents:
diff changeset
137 // Method for setting oopmaps to temporarily preserve old handling of oopmaps
a61af66fc99e Initial load
duke
parents:
diff changeset
138 OopMapSet *_oopmaps;
a61af66fc99e Initial load
duke
parents:
diff changeset
139 void set_oopmaps(OopMapSet *oopmaps) { _oopmaps = oopmaps; }
a61af66fc99e Initial load
duke
parents:
diff changeset
140
a61af66fc99e Initial load
duke
parents:
diff changeset
141 OopRecorder* oop_recorder() { return _oop_recorder; }
a61af66fc99e Initial load
duke
parents:
diff changeset
142
a61af66fc99e Initial load
duke
parents:
diff changeset
143 int last_pc_offset() { return last_pc()->pc_offset(); }
a61af66fc99e Initial load
duke
parents:
diff changeset
144
a61af66fc99e Initial load
duke
parents:
diff changeset
145 bool recording_non_safepoints() { return _recording_non_safepoints; }
a61af66fc99e Initial load
duke
parents:
diff changeset
146
a61af66fc99e Initial load
duke
parents:
diff changeset
147 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
148 friend class ScopeDesc;
a61af66fc99e Initial load
duke
parents:
diff changeset
149 friend class vframeStreamCommon;
a61af66fc99e Initial load
duke
parents:
diff changeset
150 friend class DIR_Chunk;
a61af66fc99e Initial load
duke
parents:
diff changeset
151
a61af66fc99e Initial load
duke
parents:
diff changeset
152 // True if we are recording non-safepoint scopes.
a61af66fc99e Initial load
duke
parents:
diff changeset
153 // This flag is set if DebugNonSafepoints is true, or if
a61af66fc99e Initial load
duke
parents:
diff changeset
154 // JVMTI post_compiled_method_load events are enabled.
a61af66fc99e Initial load
duke
parents:
diff changeset
155 const bool _recording_non_safepoints;
a61af66fc99e Initial load
duke
parents:
diff changeset
156
a61af66fc99e Initial load
duke
parents:
diff changeset
157 DebugInfoWriteStream* _stream;
a61af66fc99e Initial load
duke
parents:
diff changeset
158
a61af66fc99e Initial load
duke
parents:
diff changeset
159 DebugInfoWriteStream* stream() const { return _stream; }
a61af66fc99e Initial load
duke
parents:
diff changeset
160
a61af66fc99e Initial load
duke
parents:
diff changeset
161 OopRecorder* _oop_recorder;
a61af66fc99e Initial load
duke
parents:
diff changeset
162
a61af66fc99e Initial load
duke
parents:
diff changeset
163 // Scopes that have been described so far.
a61af66fc99e Initial load
duke
parents:
diff changeset
164 GrowableArray<DIR_Chunk*>* _all_chunks;
a61af66fc99e Initial load
duke
parents:
diff changeset
165 GrowableArray<DIR_Chunk*>* _shared_chunks;
a61af66fc99e Initial load
duke
parents:
diff changeset
166 DIR_Chunk* _next_chunk;
a61af66fc99e Initial load
duke
parents:
diff changeset
167 DIR_Chunk* _next_chunk_limit;
a61af66fc99e Initial load
duke
parents:
diff changeset
168
a61af66fc99e Initial load
duke
parents:
diff changeset
169 #ifdef ASSERT
a61af66fc99e Initial load
duke
parents:
diff changeset
170 enum { rs_null, rs_safepoint, rs_non_safepoint };
a61af66fc99e Initial load
duke
parents:
diff changeset
171 int _recording_state;
a61af66fc99e Initial load
duke
parents:
diff changeset
172 #endif
a61af66fc99e Initial load
duke
parents:
diff changeset
173
a61af66fc99e Initial load
duke
parents:
diff changeset
174 PcDesc* _pcs;
a61af66fc99e Initial load
duke
parents:
diff changeset
175 int _pcs_size;
a61af66fc99e Initial load
duke
parents:
diff changeset
176 int _pcs_length;
a61af66fc99e Initial load
duke
parents:
diff changeset
177 // Note: Would use GrowableArray<PcDesc>, but structs are not supported.
a61af66fc99e Initial load
duke
parents:
diff changeset
178
a61af66fc99e Initial load
duke
parents:
diff changeset
179 // PC of most recent real safepoint before the current one,
a61af66fc99e Initial load
duke
parents:
diff changeset
180 // updated after end_scopes.
a61af66fc99e Initial load
duke
parents:
diff changeset
181 int _prev_safepoint_pc;
a61af66fc99e Initial load
duke
parents:
diff changeset
182
a61af66fc99e Initial load
duke
parents:
diff changeset
183 PcDesc* last_pc() {
a61af66fc99e Initial load
duke
parents:
diff changeset
184 guarantee(_pcs_length > 0, "a safepoint must be declared already");
a61af66fc99e Initial load
duke
parents:
diff changeset
185 return &_pcs[_pcs_length-1];
a61af66fc99e Initial load
duke
parents:
diff changeset
186 }
a61af66fc99e Initial load
duke
parents:
diff changeset
187 PcDesc* prev_pc() {
a61af66fc99e Initial load
duke
parents:
diff changeset
188 guarantee(_pcs_length > 1, "a safepoint must be declared already");
a61af66fc99e Initial load
duke
parents:
diff changeset
189 return &_pcs[_pcs_length-2];
a61af66fc99e Initial load
duke
parents:
diff changeset
190 }
a61af66fc99e Initial load
duke
parents:
diff changeset
191 void add_new_pc_offset(int pc_offset);
a61af66fc99e Initial load
duke
parents:
diff changeset
192 void end_scopes(int pc_offset, bool is_safepoint);
a61af66fc99e Initial load
duke
parents:
diff changeset
193
a61af66fc99e Initial load
duke
parents:
diff changeset
194 int serialize_monitor_values(GrowableArray<MonitorValue*>* monitors);
a61af66fc99e Initial load
duke
parents:
diff changeset
195 int serialize_scope_values(GrowableArray<ScopeValue*>* values);
a61af66fc99e Initial load
duke
parents:
diff changeset
196 int find_sharable_decode_offset(int stream_offset);
a61af66fc99e Initial load
duke
parents:
diff changeset
197
a61af66fc99e Initial load
duke
parents:
diff changeset
198 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
199 enum { serialized_null = 0 };
a61af66fc99e Initial load
duke
parents:
diff changeset
200 };
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
201
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
202 #endif // SHARE_VM_CODE_DEBUGINFOREC_HPP