duke@435: /*
trims@1907:  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
duke@435:  *
duke@435:  */
duke@435: 
stefank@2314: #include "precompiled.hpp"
stefank@2314: #include "jvmtifiles/jvmtiEnv.hpp"
stefank@2314: #include "prims/jvmtiExport.hpp"
stefank@2314: #include "prims/jvmtiManageCapabilities.hpp"
duke@435: static const jint CAPA_SIZE = (JVMTI_INTERNAL_CAPABILITY_COUNT + 7) / 8;
duke@435: 
duke@435:   // capabilities which are always potentially available
duke@435: jvmtiCapabilities JvmtiManageCapabilities::always_capabilities;
duke@435: 
duke@435:   // capabilities which are potentially available during OnLoad
duke@435: jvmtiCapabilities JvmtiManageCapabilities::onload_capabilities;
duke@435: 
duke@435:   // capabilities which are always potentially available
duke@435:   // but to only one environment
duke@435: jvmtiCapabilities JvmtiManageCapabilities::always_solo_capabilities;
duke@435: 
duke@435:   // capabilities which are potentially available during OnLoad
duke@435:   // but to only one environment
duke@435: jvmtiCapabilities JvmtiManageCapabilities::onload_solo_capabilities;
duke@435: 
duke@435:   // remaining capabilities which are always potentially available
duke@435:   // but to only one environment
duke@435: jvmtiCapabilities JvmtiManageCapabilities::always_solo_remaining_capabilities;
duke@435: 
duke@435:   // remaining capabilities which are potentially available during OnLoad
duke@435:   // but to only one environment
duke@435: jvmtiCapabilities JvmtiManageCapabilities::onload_solo_remaining_capabilities;
duke@435: 
duke@435:   // all capabilities ever acquired
duke@435: jvmtiCapabilities JvmtiManageCapabilities::acquired_capabilities;
duke@435: 
duke@435: void JvmtiManageCapabilities::initialize() {
duke@435:   always_capabilities = init_always_capabilities();
duke@435:   if (JvmtiEnv::get_phase() != JVMTI_PHASE_ONLOAD) {
duke@435:     recompute_always_capabilities();
duke@435:   }
duke@435:   onload_capabilities = init_onload_capabilities();
duke@435:   always_solo_capabilities = init_always_solo_capabilities();
duke@435:   onload_solo_capabilities = init_onload_solo_capabilities();
duke@435:   always_solo_remaining_capabilities = init_always_solo_capabilities();
duke@435:   onload_solo_remaining_capabilities = init_onload_solo_capabilities();
duke@435:   memset(&acquired_capabilities, 0, sizeof(acquired_capabilities));
duke@435: }
duke@435: 
duke@435: // if the capability sets are initialized in the onload phase then
duke@435: // it happens before class data sharing (CDS) is initialized. If it
duke@435: // turns out that CDS gets disabled then we must adjust the always
duke@435: // capabilities. To ensure a consistent view of the capabililties
duke@435: // anything we add here should already be in the onload set.
duke@435: void JvmtiManageCapabilities::recompute_always_capabilities() {
duke@435:   if (!UseSharedSpaces) {
duke@435:     jvmtiCapabilities jc = always_capabilities;
duke@435:     jc.can_generate_all_class_hook_events = 1;
duke@435:     always_capabilities = jc;
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: // corresponding init functions
duke@435: jvmtiCapabilities JvmtiManageCapabilities::init_always_capabilities() {
duke@435:   jvmtiCapabilities jc;
duke@435: 
duke@435:   memset(&jc, 0, sizeof(jc));
duke@435:   jc.can_get_bytecodes = 1;
duke@435:   jc.can_signal_thread = 1;
duke@435:   jc.can_get_source_file_name = 1;
duke@435:   jc.can_get_line_numbers = 1;
duke@435:   jc.can_get_synthetic_attribute = 1;
duke@435:   jc.can_get_monitor_info = 1;
duke@435:   jc.can_get_constant_pool = 1;
duke@435:   jc.can_generate_monitor_events = 1;
duke@435:   jc.can_generate_garbage_collection_events = 1;
duke@435:   jc.can_generate_compiled_method_load_events = 1;
duke@435:   jc.can_generate_native_method_bind_events = 1;
duke@435:   jc.can_generate_vm_object_alloc_events = 1;
duke@435:   if (os::is_thread_cpu_time_supported()) {
duke@435:     jc.can_get_current_thread_cpu_time = 1;
duke@435:     jc.can_get_thread_cpu_time = 1;
duke@435:   }
duke@435:   jc.can_redefine_classes = 1;
duke@435:   jc.can_redefine_any_class = 1;
duke@435:   jc.can_retransform_classes = 1;
duke@435:   jc.can_retransform_any_class = 1;
duke@435:   jc.can_set_native_method_prefix = 1;
duke@435:   jc.can_tag_objects = 1;
duke@435:   jc.can_generate_object_free_events = 1;
duke@435:   jc.can_generate_resource_exhaustion_heap_events = 1;
duke@435:   jc.can_generate_resource_exhaustion_threads_events = 1;
duke@435:   return jc;
duke@435: }
duke@435: 
duke@435: jvmtiCapabilities JvmtiManageCapabilities::init_onload_capabilities() {
duke@435:   jvmtiCapabilities jc;
duke@435: 
duke@435:   memset(&jc, 0, sizeof(jc));
goetz@6470: #ifndef ZERO
duke@435:   jc.can_pop_frame = 1;
duke@435:   jc.can_force_early_return = 1;
goetz@6470: #endif // !ZERO
duke@435:   jc.can_get_source_debug_extension = 1;
duke@435:   jc.can_access_local_variables = 1;
duke@435:   jc.can_maintain_original_method_order = 1;
duke@435:   jc.can_generate_all_class_hook_events = 1;
duke@435:   jc.can_generate_single_step_events = 1;
duke@435:   jc.can_generate_exception_events = 1;
duke@435:   jc.can_generate_frame_pop_events = 1;
duke@435:   jc.can_generate_method_entry_events = 1;
duke@435:   jc.can_generate_method_exit_events = 1;
duke@435:   jc.can_get_owned_monitor_info = 1;
duke@435:   jc.can_get_owned_monitor_stack_depth_info = 1;
duke@435:   jc.can_get_current_contended_monitor = 1;
duke@435:   // jc.can_get_monitor_info = 1;
duke@435:   jc.can_tag_objects = 1;                 // TODO: this should have been removed
duke@435:   jc.can_generate_object_free_events = 1; // TODO: this should have been removed
duke@435:   return jc;
duke@435: }
duke@435: 
duke@435: 
duke@435: jvmtiCapabilities JvmtiManageCapabilities::init_always_solo_capabilities() {
duke@435:   jvmtiCapabilities jc;
duke@435: 
duke@435:   memset(&jc, 0, sizeof(jc));
duke@435:   jc.can_suspend = 1;
duke@435:   return jc;
duke@435: }
duke@435: 
duke@435: 
duke@435: jvmtiCapabilities JvmtiManageCapabilities::init_onload_solo_capabilities() {
duke@435:   jvmtiCapabilities jc;
duke@435: 
duke@435:   memset(&jc, 0, sizeof(jc));
duke@435:   jc.can_generate_field_modification_events = 1;
duke@435:   jc.can_generate_field_access_events = 1;
duke@435:   jc.can_generate_breakpoint_events = 1;
duke@435:   return jc;
duke@435: }
duke@435: 
duke@435: 
duke@435: jvmtiCapabilities *JvmtiManageCapabilities::either(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
duke@435:                                                    jvmtiCapabilities *result) {
duke@435:   char *ap = (char *)a;
duke@435:   char *bp = (char *)b;
duke@435:   char *resultp = (char *)result;
duke@435: 
duke@435:   for (int i = 0; i < CAPA_SIZE; ++i) {
duke@435:     *resultp++ = *ap++ | *bp++;
duke@435:   }
duke@435: 
duke@435:   return result;
duke@435: }
duke@435: 
duke@435: 
duke@435: jvmtiCapabilities *JvmtiManageCapabilities::both(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
duke@435:                                                     jvmtiCapabilities *result) {
duke@435:   char *ap = (char *)a;
duke@435:   char *bp = (char *)b;
duke@435:   char *resultp = (char *)result;
duke@435: 
duke@435:   for (int i = 0; i < CAPA_SIZE; ++i) {
duke@435:     *resultp++ = *ap++ & *bp++;
duke@435:   }
duke@435: 
duke@435:   return result;
duke@435: }
duke@435: 
duke@435: 
duke@435: jvmtiCapabilities *JvmtiManageCapabilities::exclude(const jvmtiCapabilities *a, const jvmtiCapabilities *b,
duke@435:                                                     jvmtiCapabilities *result) {
duke@435:   char *ap = (char *)a;
duke@435:   char *bp = (char *)b;
duke@435:   char *resultp = (char *)result;
duke@435: 
duke@435:   for (int i = 0; i < CAPA_SIZE; ++i) {
duke@435:     *resultp++ = *ap++ & ~*bp++;
duke@435:   }
duke@435: 
duke@435:   return result;
duke@435: }
duke@435: 
duke@435: 
duke@435: bool JvmtiManageCapabilities::has_some(const jvmtiCapabilities *a) {
duke@435:   char *ap = (char *)a;
duke@435: 
duke@435:   for (int i = 0; i < CAPA_SIZE; ++i) {
duke@435:     if (*ap++ != 0) {
duke@435:       return true;
duke@435:     }
duke@435:   }
duke@435: 
duke@435:   return false;
duke@435: }
duke@435: 
duke@435: 
duke@435: void JvmtiManageCapabilities::copy_capabilities(const jvmtiCapabilities *from, jvmtiCapabilities *to) {
duke@435:   char *ap = (char *)from;
duke@435:   char *resultp = (char *)to;
duke@435: 
duke@435:   for (int i = 0; i < CAPA_SIZE; ++i) {
duke@435:     *resultp++ = *ap++;
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: void JvmtiManageCapabilities::get_potential_capabilities(const jvmtiCapabilities *current,
duke@435:                                                          const jvmtiCapabilities *prohibited,
duke@435:                                                          jvmtiCapabilities *result) {
duke@435:   // exclude prohibited capabilities, must be before adding current
duke@435:   exclude(&always_capabilities, prohibited, result);
duke@435: 
duke@435:   // must include current since it may possess solo capabilities and now prohibited
duke@435:   either(result, current, result);
duke@435: 
duke@435:   // add other remaining
duke@435:   either(result, &always_solo_remaining_capabilities, result);
duke@435: 
duke@435:   // if this is during OnLoad more capabilities are available
duke@435:   if (JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
duke@435:     either(result, &onload_capabilities, result);
duke@435:     either(result, &onload_solo_remaining_capabilities, result);
duke@435:   }
duke@435: }
duke@435: 
duke@435: jvmtiError JvmtiManageCapabilities::add_capabilities(const jvmtiCapabilities *current,
duke@435:                                                      const jvmtiCapabilities *prohibited,
duke@435:                                                      const jvmtiCapabilities *desired,
duke@435:                                                      jvmtiCapabilities *result) {
duke@435:   // check that the capabilities being added are potential capabilities
duke@435:   jvmtiCapabilities temp;
duke@435:   get_potential_capabilities(current, prohibited, &temp);
duke@435:   if (has_some(exclude(desired, &temp, &temp))) {
duke@435:     return JVMTI_ERROR_NOT_AVAILABLE;
duke@435:   }
duke@435: 
duke@435:   // add to the set of ever acquired capabilities
duke@435:   either(&acquired_capabilities, desired, &acquired_capabilities);
duke@435: 
duke@435:   // onload capabilities that got added are now permanent - so, also remove from onload
duke@435:   both(&onload_capabilities, desired, &temp);
duke@435:   either(&always_capabilities, &temp, &always_capabilities);
duke@435:   exclude(&onload_capabilities, &temp, &onload_capabilities);
duke@435: 
duke@435:   // same for solo capabilities (transferred capabilities in the remaining sets handled as part of standard grab - below)
duke@435:   both(&onload_solo_capabilities, desired, &temp);
duke@435:   either(&always_solo_capabilities, &temp, &always_solo_capabilities);
duke@435:   exclude(&onload_solo_capabilities, &temp, &onload_solo_capabilities);
duke@435: 
duke@435:   // remove solo capabilities that are now taken
duke@435:   exclude(&always_solo_remaining_capabilities, desired, &always_solo_remaining_capabilities);
duke@435:   exclude(&onload_solo_remaining_capabilities, desired, &onload_solo_remaining_capabilities);
duke@435: 
duke@435:   // return the result
duke@435:   either(current, desired, result);
duke@435: 
duke@435:   update();
duke@435: 
duke@435:   return JVMTI_ERROR_NONE;
duke@435: }
duke@435: 
duke@435: 
duke@435: void JvmtiManageCapabilities::relinquish_capabilities(const jvmtiCapabilities *current,
duke@435:                                                       const jvmtiCapabilities *unwanted,
duke@435:                                                       jvmtiCapabilities *result) {
duke@435:   jvmtiCapabilities to_trash;
duke@435:   jvmtiCapabilities temp;
duke@435: 
duke@435:   // can't give up what you don't have
duke@435:   both(current, unwanted, &to_trash);
duke@435: 
duke@435:   // restore solo capabilities but only those that belong
duke@435:   either(&always_solo_remaining_capabilities, both(&always_solo_capabilities, &to_trash, &temp),
duke@435:          &always_solo_remaining_capabilities);
duke@435:   either(&onload_solo_remaining_capabilities, both(&onload_solo_capabilities, &to_trash, &temp),
duke@435:          &onload_solo_remaining_capabilities);
duke@435: 
duke@435:   update();
duke@435: 
duke@435:   // return the result
duke@435:   exclude(current, unwanted, result);
duke@435: }
duke@435: 
duke@435: 
duke@435: void JvmtiManageCapabilities::update() {
duke@435:   jvmtiCapabilities avail;
duke@435: 
duke@435:   // all capabilities
duke@435:   either(&always_capabilities, &always_solo_capabilities, &avail);
duke@435: 
duke@435:   bool interp_events =
duke@435:     avail.can_generate_field_access_events ||
duke@435:     avail.can_generate_field_modification_events ||
duke@435:     avail.can_generate_single_step_events ||
duke@435:     avail.can_generate_frame_pop_events ||
duke@435:     avail.can_generate_method_entry_events ||
duke@435:     avail.can_generate_method_exit_events;
duke@435:   bool enter_all_methods =
duke@435:     interp_events ||
duke@435:     avail.can_generate_breakpoint_events;
never@2724:   if (enter_all_methods) {
never@2724:     // Disable these when tracking the bytecodes
never@2724:     UseFastEmptyMethods = false;
never@2724:     UseFastAccessorMethods = false;
never@2724:   }
duke@435: 
duke@435:   if (avail.can_generate_breakpoint_events) {
duke@435:     RewriteFrequentPairs = false;
duke@435:   }
duke@435: 
duke@435:   // If can_redefine_classes is enabled in the onload phase then we know that the
duke@435:   // dependency information recorded by the compiler is complete.
duke@435:   if ((avail.can_redefine_classes || avail.can_retransform_classes) &&
duke@435:       JvmtiEnv::get_phase() == JVMTI_PHASE_ONLOAD) {
duke@435:     JvmtiExport::set_all_dependencies_are_recorded(true);
duke@435:   }
duke@435: 
duke@435:   JvmtiExport::set_can_get_source_debug_extension(avail.can_get_source_debug_extension);
duke@435:   JvmtiExport::set_can_maintain_original_method_order(avail.can_maintain_original_method_order);
duke@435:   JvmtiExport::set_can_post_interpreter_events(interp_events);
duke@435:   JvmtiExport::set_can_hotswap_or_post_breakpoint(
duke@435:     avail.can_generate_breakpoint_events ||
duke@435:     avail.can_redefine_classes ||
duke@435:     avail.can_retransform_classes);
duke@435:   JvmtiExport::set_can_modify_any_class(
duke@435:     avail.can_generate_breakpoint_events ||
duke@435:     avail.can_generate_all_class_hook_events);
duke@435:   JvmtiExport::set_can_walk_any_space(
duke@435:     avail.can_tag_objects);   // disable sharing in onload phase
never@1832:   // This controls whether the compilers keep extra locals live to
never@1832:   // improve the debugging experience so only set them if the selected
never@1832:   // capabilities look like a debugger.
duke@435:   JvmtiExport::set_can_access_local_variables(
never@1832:     avail.can_access_local_variables ||
never@1832:     avail.can_generate_breakpoint_events ||
never@1832:     avail.can_generate_frame_pop_events);
dcubed@1648:   JvmtiExport::set_can_post_on_exceptions(
duke@435:     avail.can_generate_exception_events ||
duke@435:     avail.can_generate_frame_pop_events ||
duke@435:     avail.can_generate_method_exit_events);
duke@435:   JvmtiExport::set_can_post_breakpoint(avail.can_generate_breakpoint_events);
duke@435:   JvmtiExport::set_can_post_field_access(avail.can_generate_field_access_events);
duke@435:   JvmtiExport::set_can_post_field_modification(avail.can_generate_field_modification_events);
duke@435:   JvmtiExport::set_can_post_method_entry(avail.can_generate_method_entry_events);
duke@435:   JvmtiExport::set_can_post_method_exit(avail.can_generate_method_exit_events ||
duke@435:                                         avail.can_generate_frame_pop_events);
duke@435:   JvmtiExport::set_can_pop_frame(avail.can_pop_frame);
duke@435:   JvmtiExport::set_can_force_early_return(avail.can_force_early_return);
duke@435:   JvmtiExport::set_should_clean_up_heap_objects(avail.can_generate_breakpoint_events);
duke@435: }
duke@435: 
duke@435: #ifndef PRODUCT
duke@435: 
duke@435: void JvmtiManageCapabilities:: print(const jvmtiCapabilities* cap) {
duke@435:   tty->print_cr("----- capabilities -----");
duke@435:   if (cap->can_tag_objects)
duke@435:     tty->print_cr("can_tag_objects");
duke@435:   if (cap->can_generate_field_modification_events)
duke@435:     tty->print_cr("can_generate_field_modification_events");
duke@435:   if (cap->can_generate_field_access_events)
duke@435:     tty->print_cr("can_generate_field_access_events");
duke@435:   if (cap->can_get_bytecodes)
duke@435:     tty->print_cr("can_get_bytecodes");
duke@435:   if (cap->can_get_synthetic_attribute)
duke@435:     tty->print_cr("can_get_synthetic_attribute");
duke@435:   if (cap->can_get_owned_monitor_info)
duke@435:     tty->print_cr("can_get_owned_monitor_info");
duke@435:   if (cap->can_get_current_contended_monitor)
duke@435:     tty->print_cr("can_get_current_contended_monitor");
duke@435:   if (cap->can_get_monitor_info)
duke@435:     tty->print_cr("can_get_monitor_info");
duke@435:   if (cap->can_get_constant_pool)
duke@435:     tty->print_cr("can_get_constant_pool");
duke@435:   if (cap->can_pop_frame)
duke@435:     tty->print_cr("can_pop_frame");
duke@435:   if (cap->can_force_early_return)
duke@435:     tty->print_cr("can_force_early_return");
duke@435:   if (cap->can_redefine_classes)
duke@435:     tty->print_cr("can_redefine_classes");
duke@435:   if (cap->can_retransform_classes)
duke@435:     tty->print_cr("can_retransform_classes");
duke@435:   if (cap->can_signal_thread)
duke@435:     tty->print_cr("can_signal_thread");
duke@435:   if (cap->can_get_source_file_name)
duke@435:     tty->print_cr("can_get_source_file_name");
duke@435:   if (cap->can_get_line_numbers)
duke@435:     tty->print_cr("can_get_line_numbers");
duke@435:   if (cap->can_get_source_debug_extension)
duke@435:     tty->print_cr("can_get_source_debug_extension");
duke@435:   if (cap->can_access_local_variables)
duke@435:     tty->print_cr("can_access_local_variables");
duke@435:   if (cap->can_maintain_original_method_order)
duke@435:     tty->print_cr("can_maintain_original_method_order");
duke@435:   if (cap->can_generate_single_step_events)
duke@435:     tty->print_cr("can_generate_single_step_events");
duke@435:   if (cap->can_generate_exception_events)
duke@435:     tty->print_cr("can_generate_exception_events");
duke@435:   if (cap->can_generate_frame_pop_events)
duke@435:     tty->print_cr("can_generate_frame_pop_events");
duke@435:   if (cap->can_generate_breakpoint_events)
duke@435:     tty->print_cr("can_generate_breakpoint_events");
duke@435:   if (cap->can_suspend)
duke@435:     tty->print_cr("can_suspend");
duke@435:   if (cap->can_redefine_any_class )
duke@435:     tty->print_cr("can_redefine_any_class");
duke@435:   if (cap->can_retransform_any_class )
duke@435:     tty->print_cr("can_retransform_any_class");
duke@435:   if (cap->can_get_current_thread_cpu_time)
duke@435:     tty->print_cr("can_get_current_thread_cpu_time");
duke@435:   if (cap->can_get_thread_cpu_time)
duke@435:     tty->print_cr("can_get_thread_cpu_time");
duke@435:   if (cap->can_generate_method_entry_events)
duke@435:     tty->print_cr("can_generate_method_entry_events");
duke@435:   if (cap->can_generate_method_exit_events)
duke@435:     tty->print_cr("can_generate_method_exit_events");
duke@435:   if (cap->can_generate_all_class_hook_events)
duke@435:     tty->print_cr("can_generate_all_class_hook_events");
duke@435:   if (cap->can_generate_compiled_method_load_events)
duke@435:     tty->print_cr("can_generate_compiled_method_load_events");
duke@435:   if (cap->can_generate_monitor_events)
duke@435:     tty->print_cr("can_generate_monitor_events");
duke@435:   if (cap->can_generate_vm_object_alloc_events)
duke@435:     tty->print_cr("can_generate_vm_object_alloc_events");
duke@435:   if (cap->can_generate_native_method_bind_events)
duke@435:     tty->print_cr("can_generate_native_method_bind_events");
duke@435:   if (cap->can_generate_garbage_collection_events)
duke@435:     tty->print_cr("can_generate_garbage_collection_events");
duke@435:   if (cap->can_generate_object_free_events)
duke@435:     tty->print_cr("can_generate_object_free_events");
duke@435:   if (cap->can_generate_resource_exhaustion_heap_events)
duke@435:     tty->print_cr("can_generate_resource_exhaustion_heap_events");
duke@435:   if (cap->can_generate_resource_exhaustion_threads_events)
duke@435:     tty->print_cr("can_generate_resource_exhaustion_threads_events");
duke@435: }
duke@435: 
duke@435: #endif