rev 50392 : JEP 331

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