1 /*
2 * Copyright (c) 2003, 2016, 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 *
23 */
24
25 #include "precompiled.hpp"
26 #include "jvmtifiles/jvmtiEnv.hpp"
27 #include "logging/log.hpp"
28 #include "prims/jvmtiExport.hpp"
29 #include "prims/jvmtiManageCapabilities.hpp"
30
31 static const jint CAPA_SIZE = (JVMTI_INTERNAL_CAPABILITY_COUNT + 7) / 8;
32
33 // capabilities which are always potentially available
34 jvmtiCapabilities JvmtiManageCapabilities::always_capabilities;
35
36 // capabilities which are potentially available during OnLoad
37 jvmtiCapabilities JvmtiManageCapabilities::onload_capabilities;
38
39 // capabilities which are always potentially available
40 // but to only one environment
41 jvmtiCapabilities JvmtiManageCapabilities::always_solo_capabilities;
42
43 // capabilities which are potentially available during OnLoad
44 // but to only one environment
45 jvmtiCapabilities JvmtiManageCapabilities::onload_solo_capabilities;
46
47 // remaining capabilities which are always potentially available
48 // but to only one environment
49 jvmtiCapabilities JvmtiManageCapabilities::always_solo_remaining_capabilities;
50
51 // remaining capabilities which are potentially available during OnLoad
52 // but to only one environment
53 jvmtiCapabilities JvmtiManageCapabilities::onload_solo_remaining_capabilities;
54
55 // all capabilities ever acquired
56 jvmtiCapabilities JvmtiManageCapabilities::acquired_capabilities;
57
58 void JvmtiManageCapabilities::initialize() {
59 always_capabilities = init_always_capabilities();
60 if (JvmtiEnv::get_phase() != JVMTI_PHASE_ONLOAD) {
61 recompute_always_capabilities();
62 }
63 onload_capabilities = init_onload_capabilities();
64 always_solo_capabilities = init_always_solo_capabilities();
65 onload_solo_capabilities = init_onload_solo_capabilities();
66 always_solo_remaining_capabilities = init_always_solo_capabilities();
67 onload_solo_remaining_capabilities = init_onload_solo_capabilities();
68 memset(&acquired_capabilities, 0, sizeof(acquired_capabilities));
69 }
70
71 // if the capability sets are initialized in the onload phase then
72 // it happens before class data sharing (CDS) is initialized. If it
73 // turns out that CDS gets disabled then we must adjust the always
74 // capabilities. To ensure a consistent view of the capabililties
75 // anything we add here should already be in the onload set.
76 void JvmtiManageCapabilities::recompute_always_capabilities() {
77 if (!UseSharedSpaces) {
78 jvmtiCapabilities jc = always_capabilities;
79 jc.can_generate_all_class_hook_events = 1;
80 always_capabilities = jc;
81 }
82 }
83
84
85 // corresponding init functions
86 jvmtiCapabilities JvmtiManageCapabilities::init_always_capabilities() {
87 jvmtiCapabilities jc;
88
89 memset(&jc, 0, sizeof(jc));
90 jc.can_get_bytecodes = 1;
91 jc.can_signal_thread = 1;
92 jc.can_get_source_file_name = 1;
93 jc.can_get_line_numbers = 1;
94 jc.can_get_synthetic_attribute = 1;
95 jc.can_get_monitor_info = 1;
96 jc.can_get_constant_pool = 1;
97 jc.can_generate_monitor_events = 1;
98 jc.can_generate_garbage_collection_events = 1;
99 jc.can_generate_compiled_method_load_events = 1;
100 jc.can_generate_native_method_bind_events = 1;
101 jc.can_generate_vm_object_alloc_events = 1;
102 if (os::is_thread_cpu_time_supported()) {
103 jc.can_get_current_thread_cpu_time = 1;
104 jc.can_get_thread_cpu_time = 1;
105 }
106 jc.can_redefine_classes = 1;
107 jc.can_redefine_any_class = 1;
108 jc.can_retransform_classes = 1;
109 jc.can_retransform_any_class = 1;
110 jc.can_set_native_method_prefix = 1;
111 jc.can_tag_objects = 1;
112 jc.can_generate_object_free_events = 1;
113 jc.can_generate_resource_exhaustion_heap_events = 1;
114 jc.can_generate_resource_exhaustion_threads_events = 1;
115 return jc;
116 }
117
118 jvmtiCapabilities JvmtiManageCapabilities::init_onload_capabilities() {
119 jvmtiCapabilities jc;
120
121 memset(&jc, 0, sizeof(jc));
122 #ifndef ZERO
123 jc.can_pop_frame = 1;
124 jc.can_force_early_return = 1;
125 #endif // !ZERO
126 jc.can_get_source_debug_extension = 1;
127 jc.can_access_local_variables = 1;
128 jc.can_maintain_original_method_order = 1;
129 jc.can_generate_all_class_hook_events = 1;
130 jc.can_generate_single_step_events = 1;
131 jc.can_generate_exception_events = 1;
132 jc.can_generate_frame_pop_events = 1;
133 jc.can_generate_method_entry_events = 1;
134 jc.can_generate_method_exit_events = 1;
135 jc.can_get_owned_monitor_info = 1;
136 jc.can_get_owned_monitor_stack_depth_info = 1;
137 jc.can_get_current_contended_monitor = 1;
138 jc.can_generate_early_vmstart = 1;
139 jc.can_generate_early_class_hook_events = 1;
140 return jc;
141 }
142
143
144 jvmtiCapabilities JvmtiManageCapabilities::init_always_solo_capabilities() {
145 jvmtiCapabilities jc;
146
147 memset(&jc, 0, sizeof(jc));
148 jc.can_suspend = 1;
149 return jc;
150 }
151
152
153 jvmtiCapabilities JvmtiManageCapabilities::init_onload_solo_capabilities() {
154 jvmtiCapabilities jc;
155
156 memset(&jc, 0, sizeof(jc));
157 jc.can_generate_field_modification_events = 1;
158 jc.can_generate_field_access_events = 1;
159 jc.can_generate_breakpoint_events = 1;
160 jc.can_sample_heap = 1;
161 return jc;
162 }
163
164
165 jvmtiCapabilities *JvmtiManageCapabilities::either(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
166 jvmtiCapabilities *result) {
167 char *ap = (char *)a;
168 char *bp = (char *)b;
169 char *resultp = (char *)result;
170
171 for (int i = 0; i < CAPA_SIZE; ++i) {
172 *resultp++ = *ap++ | *bp++;
173 }
174
175 return result;
176 }
177
178
179 jvmtiCapabilities *JvmtiManageCapabilities::both(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
180 jvmtiCapabilities *result) {
181 char *ap = (char *)a;
182 char *bp = (char *)b;
183 char *resultp = (char *)result;
184
185 for (int i = 0; i < CAPA_SIZE; ++i) {
186 *resultp++ = *ap++ & *bp++;
187 }
188
189 return result;
190 }
191
192
193 jvmtiCapabilities *JvmtiManageCapabilities::exclude(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
194 jvmtiCapabilities *result) {
195 char *ap = (char *)a;
196 char *bp = (char *)b;
197 char *resultp = (char *)result;
198
199 for (int i = 0; i < CAPA_SIZE; ++i) {
200 *resultp++ = *ap++ & ~*bp++;
201 }
202
203 return result;
204 }
205
206
207 bool JvmtiManageCapabilities::has_some(const jvmtiCapabilities *a) {
208 char *ap = (char *)a;
209
210 for (int i = 0; i < CAPA_SIZE; ++i) {
211 if (*ap++ != 0) {
212 return true;
213 }
214 }
215
216 return false;
217 }
218
219
220 void JvmtiManageCapabilities::copy_capabilities(const jvmtiCapabilities *from, jvmtiCapabilities *to) {
221 char *ap = (char *)from;
222 char *resultp = (char *)to;
223
224 for (int i = 0; i < CAPA_SIZE; ++i) {
225 *resultp++ = *ap++;
226 }
227 }
228
229
230 void JvmtiManageCapabilities::get_potential_capabilities(const jvmtiCapabilities *current,
231 const jvmtiCapabilities *prohibited,
232 jvmtiCapabilities *result) {
233 // exclude prohibited capabilities, must be before adding current
234 exclude(&always_capabilities, prohibited, result);
235
236 // must include current since it may possess solo capabilities and now prohibited
237 either(result, current, result);
238
239 // add other remaining
240 either(result, &always_solo_remaining_capabilities, result);
241
242 // if this is during OnLoad more capabilities are available
243 if (JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
244 either(result, &onload_capabilities, result);
245 either(result, &onload_solo_remaining_capabilities, result);
246 }
247 }
248
249 jvmtiError JvmtiManageCapabilities::add_capabilities(const jvmtiCapabilities *current,
250 const jvmtiCapabilities *prohibited,
251 const jvmtiCapabilities *desired,
252 jvmtiCapabilities *result) {
253 // check that the capabilities being added are potential capabilities
254 jvmtiCapabilities temp;
255 get_potential_capabilities(current, prohibited, &temp);
256 if (has_some(exclude(desired, &temp, &temp))) {
257 return JVMTI_ERROR_NOT_AVAILABLE;
258 }
259
260 // add to the set of ever acquired capabilities
261 either(&acquired_capabilities, desired, &acquired_capabilities);
262
263 // onload capabilities that got added are now permanent - so, also remove from onload
264 both(&onload_capabilities, desired, &temp);
265 either(&always_capabilities, &temp, &always_capabilities);
266 exclude(&onload_capabilities, &temp, &onload_capabilities);
267
268 // same for solo capabilities (transferred capabilities in the remaining sets handled as part of standard grab - below)
269 both(&onload_solo_capabilities, desired, &temp);
270 either(&always_solo_capabilities, &temp, &always_solo_capabilities);
271 exclude(&onload_solo_capabilities, &temp, &onload_solo_capabilities);
272
273 // remove solo capabilities that are now taken
274 exclude(&always_solo_remaining_capabilities, desired, &always_solo_remaining_capabilities);
275 exclude(&onload_solo_remaining_capabilities, desired, &onload_solo_remaining_capabilities);
276
277 // return the result
278 either(current, desired, result);
279
280 update();
281
282 return JVMTI_ERROR_NONE;
283 }
284
285
286 void JvmtiManageCapabilities::relinquish_capabilities(const jvmtiCapabilities *current,
287 const jvmtiCapabilities *unwanted,
288 jvmtiCapabilities *result) {
289 jvmtiCapabilities to_trash;
290 jvmtiCapabilities temp;
291
292 // can't give up what you don't have
293 both(current, unwanted, &to_trash);
294
295 // restore solo capabilities but only those that belong
296 either(&always_solo_remaining_capabilities, both(&always_solo_capabilities, &to_trash, &temp),
297 &always_solo_remaining_capabilities);
298 either(&onload_solo_remaining_capabilities, both(&onload_solo_capabilities, &to_trash, &temp),
299 &onload_solo_remaining_capabilities);
300
301 update();
302
303 // return the result
304 exclude(current, unwanted, result);
305 }
306
307
308 void JvmtiManageCapabilities::update() {
309 jvmtiCapabilities avail;
310
311 // all capabilities
312 either(&always_capabilities, &always_solo_capabilities, &avail);
313
314 bool interp_events =
315 avail.can_generate_field_access_events ||
316 avail.can_generate_field_modification_events ||
317 avail.can_generate_single_step_events ||
318 avail.can_generate_frame_pop_events ||
319 avail.can_generate_method_entry_events ||
320 avail.can_generate_method_exit_events;
321 #ifdef ZERO
322 bool enter_all_methods =
323 interp_events ||
324 avail.can_generate_breakpoint_events;
325 if (enter_all_methods) {
326 // Disable these when tracking the bytecodes
327 UseFastEmptyMethods = false;
328 UseFastAccessorMethods = false;
329 }
330 #endif // ZERO
331
332 if (avail.can_generate_breakpoint_events) {
333 RewriteFrequentPairs = false;
334 }
335
336 // If can_redefine_classes is enabled in the onload phase then we know that the
337 // dependency information recorded by the compiler is complete.
338 if ((avail.can_redefine_classes || avail.can_retransform_classes) &&
339 JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
340 JvmtiExport::set_all_dependencies_are_recorded(true);
341 }
342
343 JvmtiExport::set_can_get_source_debug_extension(avail.can_get_source_debug_extension);
344 JvmtiExport::set_can_maintain_original_method_order(avail.can_maintain_original_method_order);
345 JvmtiExport::set_can_post_interpreter_events(interp_events);
346 JvmtiExport::set_can_hotswap_or_post_breakpoint(
347 avail.can_generate_breakpoint_events ||
348 avail.can_redefine_classes ||
349 avail.can_retransform_classes);
350 JvmtiExport::set_can_modify_any_class(
351 avail.can_generate_breakpoint_events ||
352 avail.can_generate_all_class_hook_events);
353 JvmtiExport::set_can_walk_any_space(
354 avail.can_tag_objects); // disable sharing in onload phase
355 // This controls whether the compilers keep extra locals live to
356 // improve the debugging experience so only set them if the selected
357 // capabilities look like a debugger.
358 JvmtiExport::set_can_access_local_variables(
359 avail.can_access_local_variables ||
360 avail.can_generate_breakpoint_events ||
361 avail.can_generate_frame_pop_events);
362 JvmtiExport::set_can_post_on_exceptions(
363 avail.can_generate_exception_events ||
364 avail.can_generate_frame_pop_events ||
365 avail.can_generate_method_exit_events);
366 JvmtiExport::set_can_post_breakpoint(avail.can_generate_breakpoint_events);
367 JvmtiExport::set_can_post_field_access(avail.can_generate_field_access_events);
368 JvmtiExport::set_can_post_field_modification(avail.can_generate_field_modification_events);
369 JvmtiExport::set_can_post_method_entry(avail.can_generate_method_entry_events);
370 JvmtiExport::set_can_post_method_exit(avail.can_generate_method_exit_events ||
371 avail.can_generate_frame_pop_events);
372 JvmtiExport::set_can_pop_frame(avail.can_pop_frame);
373 JvmtiExport::set_can_force_early_return(avail.can_force_early_return);
374 JvmtiExport::set_should_clean_up_heap_objects(avail.can_generate_breakpoint_events);
375 }
376
377 #ifndef PRODUCT
378
379 void JvmtiManageCapabilities:: print(const jvmtiCapabilities* cap) {
380 log_trace(jvmti)("----- capabilities -----");
381 if (cap->can_tag_objects)
382 log_trace(jvmti)("can_tag_objects");
383 if (cap->can_generate_field_modification_events)
384 log_trace(jvmti)("can_generate_field_modification_events");
385 if (cap->can_generate_field_access_events)
386 log_trace(jvmti)("can_generate_field_access_events");
387 if (cap->can_get_bytecodes)
388 log_trace(jvmti)("can_get_bytecodes");
389 if (cap->can_get_synthetic_attribute)
390 log_trace(jvmti)("can_get_synthetic_attribute");
391 if (cap->can_get_owned_monitor_info)
392 log_trace(jvmti)("can_get_owned_monitor_info");
393 if (cap->can_get_current_contended_monitor)
394 log_trace(jvmti)("can_get_current_contended_monitor");
395 if (cap->can_get_monitor_info)
396 log_trace(jvmti)("can_get_monitor_info");
397 if (cap->can_get_constant_pool)
398 log_trace(jvmti)("can_get_constant_pool");
399 if (cap->can_pop_frame)
400 log_trace(jvmti)("can_pop_frame");
401 if (cap->can_force_early_return)
402 log_trace(jvmti)("can_force_early_return");
403 if (cap->can_redefine_classes)
404 log_trace(jvmti)("can_redefine_classes");
405 if (cap->can_retransform_classes)
406 log_trace(jvmti)("can_retransform_classes");
407 if (cap->can_signal_thread)
408 log_trace(jvmti)("can_signal_thread");
409 if (cap->can_get_source_file_name)
410 log_trace(jvmti)("can_get_source_file_name");
411 if (cap->can_get_line_numbers)
412 log_trace(jvmti)("can_get_line_numbers");
413 if (cap->can_get_source_debug_extension)
414 log_trace(jvmti)("can_get_source_debug_extension");
415 if (cap->can_access_local_variables)
416 log_trace(jvmti)("can_access_local_variables");
417 if (cap->can_maintain_original_method_order)
418 log_trace(jvmti)("can_maintain_original_method_order");
419 if (cap->can_generate_single_step_events)
420 log_trace(jvmti)("can_generate_single_step_events");
421 if (cap->can_generate_exception_events)
422 log_trace(jvmti)("can_generate_exception_events");
423 if (cap->can_generate_frame_pop_events)
424 log_trace(jvmti)("can_generate_frame_pop_events");
425 if (cap->can_generate_breakpoint_events)
426 log_trace(jvmti)("can_generate_breakpoint_events");
427 if (cap->can_sample_heap)
428 log_trace(jvmti)("can_sample_heap");
429 if (cap->can_suspend)
430 log_trace(jvmti)("can_suspend");
431 if (cap->can_redefine_any_class )
432 log_trace(jvmti)("can_redefine_any_class");
433 if (cap->can_retransform_any_class )
434 log_trace(jvmti)("can_retransform_any_class");
435 if (cap->can_get_current_thread_cpu_time)
436 log_trace(jvmti)("can_get_current_thread_cpu_time");
437 if (cap->can_get_thread_cpu_time)
438 log_trace(jvmti)("can_get_thread_cpu_time");
439 if (cap->can_generate_method_entry_events)
440 log_trace(jvmti)("can_generate_method_entry_events");
441 if (cap->can_generate_method_exit_events)
442 log_trace(jvmti)("can_generate_method_exit_events");
443 if (cap->can_generate_all_class_hook_events)
444 log_trace(jvmti)("can_generate_all_class_hook_events");
445 if (cap->can_generate_compiled_method_load_events)
446 log_trace(jvmti)("can_generate_compiled_method_load_events");
447 if (cap->can_generate_monitor_events)
448 log_trace(jvmti)("can_generate_monitor_events");
449 if (cap->can_generate_vm_object_alloc_events)
450 log_trace(jvmti)("can_generate_vm_object_alloc_events");
451 if (cap->can_generate_native_method_bind_events)
452 log_trace(jvmti)("can_generate_native_method_bind_events");
453 if (cap->can_generate_garbage_collection_events)
454 log_trace(jvmti)("can_generate_garbage_collection_events");
455 if (cap->can_generate_object_free_events)
456 log_trace(jvmti)("can_generate_object_free_events");
457 if (cap->can_generate_resource_exhaustion_heap_events)
458 log_trace(jvmti)("can_generate_resource_exhaustion_heap_events");
459 if (cap->can_generate_resource_exhaustion_threads_events)
460 log_trace(jvmti)("can_generate_resource_exhaustion_threads_events");
461 if (cap->can_generate_early_vmstart)
462 log_trace(jvmti)("can_generate_early_vmstart");
463 if (cap->can_generate_early_class_hook_events)
464 log_trace(jvmti)("can_generate_early_class_hook_events");
465 }
466
467 #endif