Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 1 | /* Copyright (C) 2016 The Android Open Source Project |
| 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 3 | * |
| 4 | * This file implements interfaces from the file jvmti.h. This implementation |
| 5 | * is licensed under the same terms as the file jvmti.h. The |
| 6 | * copyright and license information for the file jvmti.h follows. |
| 7 | * |
| 8 | * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. |
| 9 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 10 | * |
| 11 | * This code is free software; you can redistribute it and/or modify it |
| 12 | * under the terms of the GNU General Public License version 2 only, as |
| 13 | * published by the Free Software Foundation. Oracle designates this |
| 14 | * particular file as subject to the "Classpath" exception as provided |
| 15 | * by Oracle in the LICENSE file that accompanied this code. |
| 16 | * |
| 17 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 18 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 19 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 20 | * version 2 for more details (a copy is included in the LICENSE file that |
| 21 | * accompanied this code). |
| 22 | * |
| 23 | * You should have received a copy of the GNU General Public License version |
| 24 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 25 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 26 | * |
| 27 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 28 | * or visit www.oracle.com if you need additional information or have any |
| 29 | * questions. |
| 30 | */ |
| 31 | |
| 32 | #ifndef ART_RUNTIME_OPENJDKJVMTI_ART_JVMTI_H_ |
| 33 | #define ART_RUNTIME_OPENJDKJVMTI_ART_JVMTI_H_ |
| 34 | |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 35 | #include <memory> |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 36 | #include <type_traits> |
Alex Light | 084fa37 | 2017-06-16 08:58:34 -0700 | [diff] [blame^] | 37 | #include <unordered_set> |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 38 | |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 39 | #include <jni.h> |
| 40 | |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 41 | #include "base/casts.h" |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 42 | #include "base/logging.h" |
| 43 | #include "base/macros.h" |
Andreas Gampe | f45d61c | 2017-06-07 10:29:33 -0700 | [diff] [blame] | 44 | #include "base/strlcpy.h" |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 45 | #include "events.h" |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 46 | #include "java_vm_ext.h" |
| 47 | #include "jni_env_ext.h" |
| 48 | #include "jvmti.h" |
| 49 | |
Alex Light | 084fa37 | 2017-06-16 08:58:34 -0700 | [diff] [blame^] | 50 | namespace art { |
| 51 | class ArtField; |
| 52 | } |
| 53 | |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 54 | namespace openjdkjvmti { |
| 55 | |
Andreas Gampe | de19eb9 | 2017-02-24 16:21:18 -0800 | [diff] [blame] | 56 | class ObjectTagTable; |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 57 | |
| 58 | // A structure that is a jvmtiEnv with additional information for the runtime. |
| 59 | struct ArtJvmTiEnv : public jvmtiEnv { |
| 60 | art::JavaVMExt* art_vm; |
| 61 | void* local_data; |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 62 | jvmtiCapabilities capabilities; |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 63 | |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 64 | EventMasks event_masks; |
| 65 | std::unique_ptr<jvmtiEventCallbacks> event_callbacks; |
| 66 | |
Andreas Gampe | de19eb9 | 2017-02-24 16:21:18 -0800 | [diff] [blame] | 67 | // Tagging is specific to the jvmtiEnv. |
| 68 | std::unique_ptr<ObjectTagTable> object_tag_table; |
| 69 | |
Alex Light | 084fa37 | 2017-06-16 08:58:34 -0700 | [diff] [blame^] | 70 | // Set of watched fields is unique to each jvmtiEnv. |
| 71 | // TODO It might be good to follow the RI and only let one jvmtiEnv ever have the watch caps so |
| 72 | // we can record this on the field directly. We could do this either using free access-flag bits |
| 73 | // or by putting a list in the ClassExt of a field's DeclaringClass. |
| 74 | // TODO Maybe just have an extension to let one put a watch on every field, that would probably be |
| 75 | // good enough maybe since you probably want either a few or all/almost all of them. |
| 76 | std::unordered_set<art::ArtField*> access_watched_fields; |
| 77 | std::unordered_set<art::ArtField*> modify_watched_fields; |
| 78 | |
Andreas Gampe | de19eb9 | 2017-02-24 16:21:18 -0800 | [diff] [blame] | 79 | ArtJvmTiEnv(art::JavaVMExt* runtime, EventHandler* event_handler); |
Andreas Gampe | 77708d9 | 2016-10-07 11:48:21 -0700 | [diff] [blame] | 80 | |
| 81 | static ArtJvmTiEnv* AsArtJvmTiEnv(jvmtiEnv* env) { |
| 82 | return art::down_cast<ArtJvmTiEnv*>(env); |
| 83 | } |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 84 | }; |
| 85 | |
| 86 | // Macro and constexpr to make error values less annoying to write. |
| 87 | #define ERR(e) JVMTI_ERROR_ ## e |
| 88 | static constexpr jvmtiError OK = JVMTI_ERROR_NONE; |
| 89 | |
| 90 | // Special error code for unimplemented functions in JVMTI |
| 91 | static constexpr jvmtiError ERR(NOT_IMPLEMENTED) = JVMTI_ERROR_NOT_AVAILABLE; |
| 92 | |
| 93 | static inline JNIEnv* GetJniEnv(jvmtiEnv* env) { |
| 94 | JNIEnv* ret_value = nullptr; |
| 95 | jint res = reinterpret_cast<ArtJvmTiEnv*>(env)->art_vm->GetEnv( |
| 96 | reinterpret_cast<void**>(&ret_value), JNI_VERSION_1_1); |
| 97 | if (res != JNI_OK) { |
| 98 | return nullptr; |
| 99 | } |
| 100 | return ret_value; |
| 101 | } |
| 102 | |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 103 | template <typename T> |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 104 | class JvmtiDeleter { |
| 105 | public: |
| 106 | JvmtiDeleter() : env_(nullptr) {} |
| 107 | explicit JvmtiDeleter(jvmtiEnv* env) : env_(env) {} |
| 108 | |
| 109 | JvmtiDeleter(JvmtiDeleter&) = default; |
| 110 | JvmtiDeleter(JvmtiDeleter&&) = default; |
| 111 | JvmtiDeleter& operator=(const JvmtiDeleter&) = default; |
| 112 | |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 113 | void operator()(T* ptr) const { |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 114 | CHECK(env_ != nullptr); |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 115 | jvmtiError ret = env_->Deallocate(reinterpret_cast<unsigned char*>(ptr)); |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 116 | CHECK(ret == ERR(NONE)); |
| 117 | } |
| 118 | |
| 119 | private: |
| 120 | mutable jvmtiEnv* env_; |
| 121 | }; |
| 122 | |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 123 | template <typename T> |
| 124 | class JvmtiDeleter<T[]> { |
| 125 | public: |
| 126 | JvmtiDeleter() : env_(nullptr) {} |
| 127 | explicit JvmtiDeleter(jvmtiEnv* env) : env_(env) {} |
| 128 | |
| 129 | JvmtiDeleter(JvmtiDeleter&) = default; |
| 130 | JvmtiDeleter(JvmtiDeleter&&) = default; |
| 131 | JvmtiDeleter& operator=(const JvmtiDeleter&) = default; |
| 132 | |
| 133 | template <typename U> |
| 134 | void operator()(U* ptr) const { |
| 135 | CHECK(env_ != nullptr); |
| 136 | jvmtiError ret = env_->Deallocate(reinterpret_cast<unsigned char*>(ptr)); |
| 137 | CHECK(ret == ERR(NONE)); |
| 138 | } |
| 139 | |
| 140 | private: |
| 141 | mutable jvmtiEnv* env_; |
| 142 | }; |
| 143 | |
| 144 | template <typename T> |
| 145 | using JvmtiUniquePtr = std::unique_ptr<T, JvmtiDeleter<T>>; |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 146 | |
Andreas Gampe | 1bdaf73 | 2017-01-09 19:21:06 -0800 | [diff] [blame] | 147 | template <typename T> |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 148 | ALWAYS_INLINE |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 149 | static inline JvmtiUniquePtr<T> MakeJvmtiUniquePtr(jvmtiEnv* env, T* mem) { |
| 150 | return JvmtiUniquePtr<T>(mem, JvmtiDeleter<T>(env)); |
| 151 | } |
| 152 | |
| 153 | template <typename T> |
| 154 | ALWAYS_INLINE |
| 155 | static inline JvmtiUniquePtr<T> MakeJvmtiUniquePtr(jvmtiEnv* env, unsigned char* mem) { |
| 156 | return JvmtiUniquePtr<T>(reinterpret_cast<T*>(mem), JvmtiDeleter<T>(env)); |
| 157 | } |
| 158 | |
| 159 | template <typename T> |
| 160 | ALWAYS_INLINE |
| 161 | static inline JvmtiUniquePtr<T> AllocJvmtiUniquePtr(jvmtiEnv* env, jvmtiError* error) { |
| 162 | unsigned char* tmp; |
| 163 | *error = env->Allocate(sizeof(T), &tmp); |
| 164 | if (*error != ERR(NONE)) { |
| 165 | return JvmtiUniquePtr<T>(); |
| 166 | } |
| 167 | return JvmtiUniquePtr<T>(tmp, JvmtiDeleter<T>(env)); |
| 168 | } |
| 169 | |
| 170 | template <typename T> |
| 171 | ALWAYS_INLINE |
| 172 | static inline JvmtiUniquePtr<T> AllocJvmtiUniquePtr(jvmtiEnv* env, |
| 173 | size_t count, |
| 174 | jvmtiError* error) { |
| 175 | unsigned char* tmp; |
| 176 | *error = env->Allocate(sizeof(typename std::remove_extent<T>::type) * count, &tmp); |
| 177 | if (*error != ERR(NONE)) { |
| 178 | return JvmtiUniquePtr<T>(); |
| 179 | } |
| 180 | return JvmtiUniquePtr<T>(reinterpret_cast<typename std::remove_extent<T>::type*>(tmp), |
| 181 | JvmtiDeleter<T>(env)); |
Andreas Gampe | 3c252f0 | 2016-10-27 18:25:17 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Andreas Gampe | e492ae3 | 2016-10-28 19:34:57 -0700 | [diff] [blame] | 184 | ALWAYS_INLINE |
Alex Light | 440b5d9 | 2017-01-24 15:32:25 -0800 | [diff] [blame] | 185 | static inline jvmtiError CopyDataIntoJvmtiBuffer(ArtJvmTiEnv* env, |
| 186 | const unsigned char* source, |
| 187 | jint len, |
| 188 | /*out*/unsigned char** dest) { |
| 189 | jvmtiError res = env->Allocate(len, dest); |
| 190 | if (res != OK) { |
| 191 | return res; |
| 192 | } |
| 193 | memcpy(reinterpret_cast<void*>(*dest), |
| 194 | reinterpret_cast<const void*>(source), |
| 195 | len); |
| 196 | return OK; |
| 197 | } |
| 198 | |
| 199 | ALWAYS_INLINE |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 200 | static inline JvmtiUniquePtr<char[]> CopyString(jvmtiEnv* env, const char* src, jvmtiError* error) { |
Andreas Gampe | e492ae3 | 2016-10-28 19:34:57 -0700 | [diff] [blame] | 201 | size_t len = strlen(src) + 1; |
Andreas Gampe | 5471141 | 2017-02-21 12:41:43 -0800 | [diff] [blame] | 202 | JvmtiUniquePtr<char[]> ret = AllocJvmtiUniquePtr<char[]>(env, len, error); |
| 203 | if (ret != nullptr) { |
Andreas Gampe | f45d61c | 2017-06-07 10:29:33 -0700 | [diff] [blame] | 204 | strlcpy(ret.get(), src, len); |
Andreas Gampe | e492ae3 | 2016-10-28 19:34:57 -0700 | [diff] [blame] | 205 | } |
Andreas Gampe | e492ae3 | 2016-10-28 19:34:57 -0700 | [diff] [blame] | 206 | return ret; |
| 207 | } |
| 208 | |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 209 | const jvmtiCapabilities kPotentialCapabilities = { |
| 210 | .can_tag_objects = 1, |
Alex Light | 084fa37 | 2017-06-16 08:58:34 -0700 | [diff] [blame^] | 211 | .can_generate_field_modification_events = 1, |
| 212 | .can_generate_field_access_events = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 213 | .can_get_bytecodes = 0, |
Alex Light | 9db679d | 2017-01-25 15:28:04 -0800 | [diff] [blame] | 214 | .can_get_synthetic_attribute = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 215 | .can_get_owned_monitor_info = 0, |
| 216 | .can_get_current_contended_monitor = 0, |
| 217 | .can_get_monitor_info = 0, |
| 218 | .can_pop_frame = 0, |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 219 | .can_redefine_classes = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 220 | .can_signal_thread = 0, |
| 221 | .can_get_source_file_name = 0, |
Alex Light | 9db679d | 2017-01-25 15:28:04 -0800 | [diff] [blame] | 222 | .can_get_line_numbers = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 223 | .can_get_source_debug_extension = 0, |
| 224 | .can_access_local_variables = 0, |
| 225 | .can_maintain_original_method_order = 0, |
| 226 | .can_generate_single_step_events = 0, |
| 227 | .can_generate_exception_events = 0, |
| 228 | .can_generate_frame_pop_events = 0, |
| 229 | .can_generate_breakpoint_events = 0, |
| 230 | .can_suspend = 0, |
| 231 | .can_redefine_any_class = 0, |
| 232 | .can_get_current_thread_cpu_time = 0, |
| 233 | .can_get_thread_cpu_time = 0, |
Alex Light | b7edcda | 2017-04-27 13:20:31 -0700 | [diff] [blame] | 234 | .can_generate_method_entry_events = 1, |
| 235 | .can_generate_method_exit_events = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 236 | .can_generate_all_class_hook_events = 0, |
| 237 | .can_generate_compiled_method_load_events = 0, |
| 238 | .can_generate_monitor_events = 0, |
Alex Light | 9db679d | 2017-01-25 15:28:04 -0800 | [diff] [blame] | 239 | .can_generate_vm_object_alloc_events = 1, |
Alex Light | d78ddec | 2017-04-18 15:20:38 -0700 | [diff] [blame] | 240 | .can_generate_native_method_bind_events = 1, |
Alex Light | 9db679d | 2017-01-25 15:28:04 -0800 | [diff] [blame] | 241 | .can_generate_garbage_collection_events = 1, |
| 242 | .can_generate_object_free_events = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 243 | .can_force_early_return = 0, |
| 244 | .can_get_owned_monitor_stack_depth_info = 0, |
| 245 | .can_get_constant_pool = 0, |
| 246 | .can_set_native_method_prefix = 0, |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 247 | .can_retransform_classes = 1, |
Alex Light | e657424 | 2016-08-17 09:56:24 -0700 | [diff] [blame] | 248 | .can_retransform_any_class = 0, |
| 249 | .can_generate_resource_exhaustion_heap_events = 0, |
| 250 | .can_generate_resource_exhaustion_threads_events = 0, |
| 251 | }; |
| 252 | |
Andreas Gampe | db6dcb6 | 2016-09-13 09:05:59 -0700 | [diff] [blame] | 253 | } // namespace openjdkjvmti |
| 254 | |
| 255 | #endif // ART_RUNTIME_OPENJDKJVMTI_ART_JVMTI_H_ |