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