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 jc.can_generate_sampled_object_alloc_events = 1;
162 return jc;
163 }
164
165
166 jvmtiCapabilities *JvmtiManageCapabilities::either(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
167 jvmtiCapabilities *result) {
168 char *ap = (char *)a;
169 char *bp = (char *)b;
170 char *resultp = (char *)result;
171
172 for (int i = 0; i < CAPA_SIZE; ++i) {
173 *resultp++ = *ap++ | *bp++;
174 }
175
176 return result;
177 }
178
179
180 jvmtiCapabilities *JvmtiManageCapabilities::both(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
181 jvmtiCapabilities *result) {
182 char *ap = (char *)a;
183 char *bp = (char *)b;
184 char *resultp = (char *)result;
185
186 for (int i = 0; i < CAPA_SIZE; ++i) {
187 *resultp++ = *ap++ & *bp++;
188 }
189
190 return result;
191 }
192
193
194 jvmtiCapabilities *JvmtiManageCapabilities::exclude(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
195 jvmtiCapabilities *result) {
196 char *ap = (char *)a;
197 char *bp = (char *)b;
198 char *resultp = (char *)result;
199
200 for (int i = 0; i < CAPA_SIZE; ++i) {
201 *resultp++ = *ap++ & ~*bp++;
202 }
203
204 return result;
205 }
206
207
208 bool JvmtiManageCapabilities::has_some(const jvmtiCapabilities *a) {
209 char *ap = (char *)a;
210
211 for (int i = 0; i < CAPA_SIZE; ++i) {
212 if (*ap++ != 0) {
213 return true;
214 }
215 }
216
217 return false;
218 }
219
220
221 void JvmtiManageCapabilities::copy_capabilities(const jvmtiCapabilities *from, jvmtiCapabilities *to) {
222 char *ap = (char *)from;
223 char *resultp = (char *)to;
224
225 for (int i = 0; i < CAPA_SIZE; ++i) {
226 *resultp++ = *ap++;
227 }
228 }
229
230
231 void JvmtiManageCapabilities::get_potential_capabilities(const jvmtiCapabilities *current,
232 const jvmtiCapabilities *prohibited,
233 jvmtiCapabilities *result) {
234 // exclude prohibited capabilities, must be before adding current
235 exclude(&always_capabilities, prohibited, result);
236
237 // must include current since it may possess solo capabilities and now prohibited
238 either(result, current, result);
239
240 // add other remaining
241 either(result, &always_solo_remaining_capabilities, result);
242
243 // if this is during OnLoad more capabilities are available
244 if (JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
245 either(result, &onload_capabilities, result);
246 either(result, &onload_solo_remaining_capabilities, result);
247 }
248 }
249
250 jvmtiError JvmtiManageCapabilities::add_capabilities(const jvmtiCapabilities *current,
251 const jvmtiCapabilities *prohibited,
252 const jvmtiCapabilities *desired,
253 jvmtiCapabilities *result) {
254 // check that the capabilities being added are potential capabilities
255 jvmtiCapabilities temp;
256 get_potential_capabilities(current, prohibited, &temp);
257 if (has_some(exclude(desired, &temp, &temp))) {
258 return JVMTI_ERROR_NOT_AVAILABLE;
259 }
260
261 // add to the set of ever acquired capabilities
262 either(&acquired_capabilities, desired, &acquired_capabilities);
263
264 // onload capabilities that got added are now permanent - so, also remove from onload
265 both(&onload_capabilities, desired, &temp);
266 either(&always_capabilities, &temp, &always_capabilities);
267 exclude(&onload_capabilities, &temp, &onload_capabilities);
268
269 // same for solo capabilities (transferred capabilities in the remaining sets handled as part of standard grab - below)
270 both(&onload_solo_capabilities, desired, &temp);
271 either(&always_solo_capabilities, &temp, &always_solo_capabilities);
272 exclude(&onload_solo_capabilities, &temp, &onload_solo_capabilities);
273
274 // remove solo capabilities that are now taken
275 exclude(&always_solo_remaining_capabilities, desired, &always_solo_remaining_capabilities);
276 exclude(&onload_solo_remaining_capabilities, desired, &onload_solo_remaining_capabilities);
277
278 // return the result
279 either(current, desired, result);
280
281 update();
282
283 return JVMTI_ERROR_NONE;
284 }
285
286
287 void JvmtiManageCapabilities::relinquish_capabilities(const jvmtiCapabilities *current,
288 const jvmtiCapabilities *unwanted,
289 jvmtiCapabilities *result) {
290 jvmtiCapabilities to_trash;
291 jvmtiCapabilities temp;
292
293 // can't give up what you don't have
294 both(current, unwanted, &to_trash);
295
296 // restore solo capabilities but only those that belong
297 either(&always_solo_remaining_capabilities, both(&always_solo_capabilities, &to_trash, &temp),
298 &always_solo_remaining_capabilities);
299 either(&onload_solo_remaining_capabilities, both(&onload_solo_capabilities, &to_trash, &temp),
300 &onload_solo_remaining_capabilities);
301
302 update();
303
304 // return the result
305 exclude(current, unwanted, result);
306 }
307
308
309 void JvmtiManageCapabilities::update() {
310 jvmtiCapabilities avail;
311
312 // all capabilities
313 either(&always_capabilities, &always_solo_capabilities, &avail);
314
315 bool interp_events =
316 avail.can_generate_field_access_events ||
317 avail.can_generate_field_modification_events ||
318 avail.can_generate_single_step_events ||
319 avail.can_generate_frame_pop_events ||
320 avail.can_generate_method_entry_events ||
321 avail.can_generate_method_exit_events;
322 #ifdef ZERO
323 bool enter_all_methods =
324 interp_events ||
325 avail.can_generate_breakpoint_events;
326 if (enter_all_methods) {
327 // Disable these when tracking the bytecodes
328 UseFastEmptyMethods = false;
329 UseFastAccessorMethods = false;
330 }
331 #endif // ZERO
332
333 if (avail.can_generate_breakpoint_events) {
334 RewriteFrequentPairs = false;
335 }
336
337 // If can_redefine_classes is enabled in the onload phase then we know that the
338 // dependency information recorded by the compiler is complete.
339 if ((avail.can_redefine_classes || avail.can_retransform_classes) &&
340 JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
341 JvmtiExport::set_all_dependencies_are_recorded(true);
342 }
343
344 JvmtiExport::set_can_get_source_debug_extension(avail.can_get_source_debug_extension);
345 JvmtiExport::set_can_maintain_original_method_order(avail.can_maintain_original_method_order);
346 JvmtiExport::set_can_post_interpreter_events(interp_events);
347 JvmtiExport::set_can_hotswap_or_post_breakpoint(
348 avail.can_generate_breakpoint_events ||
349 avail.can_redefine_classes ||
350 avail.can_retransform_classes);
351 JvmtiExport::set_can_modify_any_class(
352 avail.can_generate_breakpoint_events ||
353 avail.can_generate_all_class_hook_events);
354 JvmtiExport::set_can_walk_any_space(
355 avail.can_tag_objects); // disable sharing in onload phase
356 // This controls whether the compilers keep extra locals live to
357 // improve the debugging experience so only set them if the selected
358 // capabilities look like a debugger.
359 JvmtiExport::set_can_access_local_variables(
360 avail.can_access_local_variables ||
361 avail.can_generate_breakpoint_events ||
362 avail.can_generate_frame_pop_events);
363 JvmtiExport::set_can_post_on_exceptions(
364 avail.can_generate_exception_events ||
365 avail.can_generate_frame_pop_events ||
366 avail.can_generate_method_exit_events);
367 JvmtiExport::set_can_post_breakpoint(avail.can_generate_breakpoint_events);
368 JvmtiExport::set_can_post_field_access(avail.can_generate_field_access_events);
369 JvmtiExport::set_can_post_field_modification(avail.can_generate_field_modification_events);
370 JvmtiExport::set_can_post_method_entry(avail.can_generate_method_entry_events);
371 JvmtiExport::set_can_post_method_exit(avail.can_generate_method_exit_events ||
372 avail.can_generate_frame_pop_events);
373 JvmtiExport::set_can_pop_frame(avail.can_pop_frame);
374 JvmtiExport::set_can_force_early_return(avail.can_force_early_return);
375 JvmtiExport::set_should_clean_up_heap_objects(avail.can_generate_breakpoint_events);
376 }
377
378 #ifndef PRODUCT
379
380 void JvmtiManageCapabilities:: print(const jvmtiCapabilities* cap) {
381 log_trace(jvmti)("----- capabilities -----");
382 if (cap->can_tag_objects)
383 log_trace(jvmti)("can_tag_objects");
384 if (cap->can_generate_field_modification_events)
385 log_trace(jvmti)("can_generate_field_modification_events");
386 if (cap->can_generate_field_access_events)
387 log_trace(jvmti)("can_generate_field_access_events");
388 if (cap->can_get_bytecodes)
389 log_trace(jvmti)("can_get_bytecodes");
390 if (cap->can_get_synthetic_attribute)
391 log_trace(jvmti)("can_get_synthetic_attribute");
392 if (cap->can_get_owned_monitor_info)
393 log_trace(jvmti)("can_get_owned_monitor_info");
394 if (cap->can_get_current_contended_monitor)
395 log_trace(jvmti)("can_get_current_contended_monitor");
396 if (cap->can_get_monitor_info)
397 log_trace(jvmti)("can_get_monitor_info");
398 if (cap->can_get_constant_pool)
399 log_trace(jvmti)("can_get_constant_pool");
400 if (cap->can_pop_frame)
401 log_trace(jvmti)("can_pop_frame");
402 if (cap->can_force_early_return)
403 log_trace(jvmti)("can_force_early_return");
404 if (cap->can_redefine_classes)
405 log_trace(jvmti)("can_redefine_classes");
406 if (cap->can_retransform_classes)
407 log_trace(jvmti)("can_retransform_classes");
408 if (cap->can_signal_thread)
409 log_trace(jvmti)("can_signal_thread");
410 if (cap->can_get_source_file_name)
411 log_trace(jvmti)("can_get_source_file_name");
412 if (cap->can_get_line_numbers)
413 log_trace(jvmti)("can_get_line_numbers");
414 if (cap->can_get_source_debug_extension)
415 log_trace(jvmti)("can_get_source_debug_extension");
416 if (cap->can_access_local_variables)
417 log_trace(jvmti)("can_access_local_variables");
418 if (cap->can_maintain_original_method_order)
419 log_trace(jvmti)("can_maintain_original_method_order");
420 if (cap->can_generate_single_step_events)
421 log_trace(jvmti)("can_generate_single_step_events");
422 if (cap->can_generate_exception_events)
423 log_trace(jvmti)("can_generate_exception_events");
424 if (cap->can_generate_frame_pop_events)
425 log_trace(jvmti)("can_generate_frame_pop_events");
426 if (cap->can_generate_breakpoint_events)
427 log_trace(jvmti)("can_generate_breakpoint_events");
428 if (cap->can_sample_heap)
429 log_trace(jvmti)("can_sample_heap");
430 if (cap->can_generate_sampled_object_alloc_events)
431 log_trace(jvmti)("can_generate_sampled_object_alloc_events");
432 if (cap->can_suspend)
433 log_trace(jvmti)("can_suspend");
434 if (cap->can_redefine_any_class )
435 log_trace(jvmti)("can_redefine_any_class");
436 if (cap->can_retransform_any_class )
437 log_trace(jvmti)("can_retransform_any_class");
438 if (cap->can_get_current_thread_cpu_time)
439 log_trace(jvmti)("can_get_current_thread_cpu_time");
440 if (cap->can_get_thread_cpu_time)
441 log_trace(jvmti)("can_get_thread_cpu_time");
442 if (cap->can_generate_method_entry_events)
443 log_trace(jvmti)("can_generate_method_entry_events");
444 if (cap->can_generate_method_exit_events)
445 log_trace(jvmti)("can_generate_method_exit_events");
446 if (cap->can_generate_all_class_hook_events)
447 log_trace(jvmti)("can_generate_all_class_hook_events");
448 if (cap->can_generate_compiled_method_load_events)
449 log_trace(jvmti)("can_generate_compiled_method_load_events");
450 if (cap->can_generate_monitor_events)
451 log_trace(jvmti)("can_generate_monitor_events");
452 if (cap->can_generate_vm_object_alloc_events)
453 log_trace(jvmti)("can_generate_vm_object_alloc_events");
454 if (cap->can_generate_native_method_bind_events)
455 log_trace(jvmti)("can_generate_native_method_bind_events");
456 if (cap->can_generate_garbage_collection_events)
457 log_trace(jvmti)("can_generate_garbage_collection_events");
458 if (cap->can_generate_object_free_events)
459 log_trace(jvmti)("can_generate_object_free_events");
460 if (cap->can_generate_resource_exhaustion_heap_events)
461 log_trace(jvmti)("can_generate_resource_exhaustion_heap_events");
462 if (cap->can_generate_resource_exhaustion_threads_events)
463 log_trace(jvmti)("can_generate_resource_exhaustion_threads_events");
464 if (cap->can_generate_early_vmstart)
465 log_trace(jvmti)("can_generate_early_vmstart");
466 if (cap->can_generate_early_class_hook_events)
467 log_trace(jvmti)("can_generate_early_class_hook_events");
468 }
469
470 #endif