Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [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_TI_REDEFINE_H_ |
| 33 | #define ART_RUNTIME_OPENJDKJVMTI_TI_REDEFINE_H_ |
| 34 | |
| 35 | #include <string> |
| 36 | |
| 37 | #include <jni.h> |
| 38 | |
| 39 | #include "art_jvmti.h" |
| 40 | #include "art_method.h" |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 41 | #include "base/array_slice.h" |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 42 | #include "class_linker.h" |
| 43 | #include "dex_file.h" |
| 44 | #include "gc_root-inl.h" |
| 45 | #include "globals.h" |
| 46 | #include "jni_env_ext-inl.h" |
| 47 | #include "jvmti.h" |
| 48 | #include "linear_alloc.h" |
| 49 | #include "mem_map.h" |
| 50 | #include "mirror/array-inl.h" |
| 51 | #include "mirror/array.h" |
| 52 | #include "mirror/class-inl.h" |
| 53 | #include "mirror/class.h" |
| 54 | #include "mirror/class_loader-inl.h" |
| 55 | #include "mirror/string-inl.h" |
| 56 | #include "oat_file.h" |
| 57 | #include "obj_ptr.h" |
| 58 | #include "scoped_thread_state_change-inl.h" |
| 59 | #include "stack.h" |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 60 | #include "ti_class_definition.h" |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 61 | #include "thread_list.h" |
| 62 | #include "transform.h" |
| 63 | #include "utf.h" |
| 64 | #include "utils/dex_cache_arrays_layout-inl.h" |
| 65 | |
| 66 | namespace openjdkjvmti { |
| 67 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 68 | class RedefinitionDataHolder; |
| 69 | |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 70 | // Class that can redefine a single class's methods. |
Alex Light | dba6148 | 2016-12-21 08:20:29 -0800 | [diff] [blame] | 71 | // TODO We should really make this be driven by an outside class so we can do multiple classes at |
| 72 | // the same time and have less required cleanup. |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 73 | class Redefiner { |
| 74 | public: |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 75 | // Redefine the given classes with the given dex data. Note this function does not take ownership |
| 76 | // of the dex_data pointers. It is not used after this call however and may be freed if desired. |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 77 | // The caller is responsible for freeing it. The runtime makes its own copy of the data. This |
| 78 | // function does not call the transformation events. |
| 79 | // TODO Check modified flag of the definitions. |
| 80 | static jvmtiError RedefineClassesDirect(ArtJvmTiEnv* env, |
| 81 | art::Runtime* runtime, |
| 82 | art::Thread* self, |
| 83 | const std::vector<ArtClassDefinition>& definitions, |
| 84 | /*out*/std::string* error_msg); |
| 85 | |
| 86 | // Redefine the given classes with the given dex data. Note this function does not take ownership |
| 87 | // of the dex_data pointers. It is not used after this call however and may be freed if desired. |
Alex Light | 0b77257 | 2016-12-02 17:27:31 -0800 | [diff] [blame] | 88 | // The caller is responsible for freeing it. The runtime makes its own copy of the data. |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 89 | // TODO This function should call the transformation events. |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 90 | static jvmtiError RedefineClasses(ArtJvmTiEnv* env, |
| 91 | art::Runtime* runtime, |
| 92 | art::Thread* self, |
| 93 | jint class_count, |
| 94 | const jvmtiClassDefinition* definitions, |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 95 | /*out*/std::string* error_msg); |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 96 | |
Alex Light | e4a8863 | 2017-01-10 07:41:24 -0800 | [diff] [blame] | 97 | static jvmtiError IsModifiableClass(jvmtiEnv* env, jclass klass, jboolean* is_redefinable); |
| 98 | |
Alex Light | 440b5d9 | 2017-01-24 15:32:25 -0800 | [diff] [blame] | 99 | static std::unique_ptr<art::MemMap> MoveDataToMemMap(const std::string& original_location, |
| 100 | jint data_len, |
| 101 | const unsigned char* dex_data, |
| 102 | std::string* error_msg); |
| 103 | |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 104 | private: |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 105 | class ClassRedefinition { |
| 106 | public: |
| 107 | ClassRedefinition(Redefiner* driver, |
| 108 | jclass klass, |
| 109 | const art::DexFile* redefined_dex_file, |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 110 | const char* class_sig, |
| 111 | art::ArraySlice<const unsigned char> orig_dex_file) |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 112 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 113 | |
| 114 | // NO_THREAD_SAFETY_ANALYSIS so we can unlock the class in the destructor. |
| 115 | ~ClassRedefinition() NO_THREAD_SAFETY_ANALYSIS; |
| 116 | |
| 117 | // Move constructor so we can put these into a vector. |
| 118 | ClassRedefinition(ClassRedefinition&& other) |
| 119 | : driver_(other.driver_), |
| 120 | klass_(other.klass_), |
| 121 | dex_file_(std::move(other.dex_file_)), |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 122 | class_sig_(std::move(other.class_sig_)), |
| 123 | original_dex_file_(other.original_dex_file_) { |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 124 | other.driver_ = nullptr; |
| 125 | } |
| 126 | |
| 127 | art::mirror::Class* GetMirrorClass() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 128 | art::mirror::ClassLoader* GetClassLoader() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 129 | |
Alex Light | 7916f20 | 2017-01-27 09:00:15 -0800 | [diff] [blame] | 130 | const art::DexFile& GetDexFile() { |
| 131 | return *dex_file_; |
| 132 | } |
| 133 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 134 | art::mirror::DexCache* CreateNewDexCache(art::Handle<art::mirror::ClassLoader> loader) |
| 135 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 136 | |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 137 | // This may return nullptr with a OOME pending if allocation fails. |
| 138 | art::mirror::ByteArray* AllocateOrGetOriginalDexFileBytes() |
| 139 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 140 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 141 | void RecordFailure(jvmtiError e, const std::string& err) { |
| 142 | driver_->RecordFailure(e, class_sig_, err); |
| 143 | } |
| 144 | |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 145 | bool FinishRemainingAllocations(int32_t klass_index, /*out*/RedefinitionDataHolder* holder) |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 146 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 147 | |
| 148 | void FindAndAllocateObsoleteMethods(art::mirror::Class* art_klass) |
| 149 | REQUIRES(art::Locks::mutator_lock_); |
| 150 | |
| 151 | void FillObsoleteMethodMap( |
| 152 | art::mirror::Class* art_klass, |
| 153 | const std::unordered_map<art::ArtMethod*, art::ArtMethod*>& obsoletes) |
| 154 | REQUIRES(art::Locks::mutator_lock_); |
| 155 | |
| 156 | |
| 157 | // Checks that the dex file contains only the single expected class and that the top-level class |
| 158 | // data has not been modified in an incompatible manner. |
| 159 | bool CheckClass() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 160 | |
| 161 | // Preallocates all needed allocations in klass so that we can pause execution safely. |
| 162 | // TODO We should be able to free the arrays if they end up not being used. Investigate doing |
| 163 | // this in the future. For now we will just take the memory hit. |
| 164 | bool EnsureClassAllocationsFinished() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 165 | |
| 166 | // This will check that no constraints are violated (more than 1 class in dex file, any changes |
| 167 | // in number/declaration of methods & fields, changes in access flags, etc.) |
| 168 | bool CheckRedefinitionIsValid() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 169 | |
| 170 | // Checks that the class can even be redefined. |
| 171 | bool CheckRedefinable() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 172 | |
Alex Light | 6161f13 | 2017-01-25 10:30:20 -0800 | [diff] [blame^] | 173 | // Checks that the dex file does not add/remove methods, or change their modifiers or types. |
| 174 | bool CheckSameMethods() REQUIRES_SHARED(art::Locks::mutator_lock_); |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 175 | |
Alex Light | 6161f13 | 2017-01-25 10:30:20 -0800 | [diff] [blame^] | 176 | // Checks that the dex file does not modify fields types or modifiers. |
| 177 | bool CheckSameFields() REQUIRES_SHARED(art::Locks::mutator_lock_); |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 178 | |
| 179 | void UpdateJavaDexFile(art::ObjPtr<art::mirror::Object> java_dex_file, |
| 180 | art::ObjPtr<art::mirror::LongArray> new_cookie) |
| 181 | REQUIRES(art::Locks::mutator_lock_); |
| 182 | |
| 183 | void UpdateFields(art::ObjPtr<art::mirror::Class> mclass) |
| 184 | REQUIRES(art::Locks::mutator_lock_); |
| 185 | |
| 186 | void UpdateMethods(art::ObjPtr<art::mirror::Class> mclass, |
| 187 | art::ObjPtr<art::mirror::DexCache> new_dex_cache, |
| 188 | const art::DexFile::ClassDef& class_def) |
| 189 | REQUIRES(art::Locks::mutator_lock_); |
| 190 | |
| 191 | void UpdateClass(art::ObjPtr<art::mirror::Class> mclass, |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 192 | art::ObjPtr<art::mirror::DexCache> new_dex_cache, |
| 193 | art::ObjPtr<art::mirror::ByteArray> original_dex_file) |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 194 | REQUIRES(art::Locks::mutator_lock_); |
| 195 | |
| 196 | void ReleaseDexFile() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 197 | |
| 198 | private: |
| 199 | Redefiner* driver_; |
| 200 | jclass klass_; |
| 201 | std::unique_ptr<const art::DexFile> dex_file_; |
| 202 | std::string class_sig_; |
Alex Light | a7e38d8 | 2017-01-19 14:57:28 -0800 | [diff] [blame] | 203 | art::ArraySlice<const unsigned char> original_dex_file_; |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 204 | }; |
| 205 | |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 206 | jvmtiError result_; |
| 207 | art::Runtime* runtime_; |
| 208 | art::Thread* self_; |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 209 | std::vector<ClassRedefinition> redefinitions_; |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 210 | // Kept as a jclass since we have weird run-state changes that make keeping it around as a |
| 211 | // mirror::Class difficult and confusing. |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 212 | std::string* error_msg_; |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 213 | |
| 214 | // TODO Maybe change jclass to a mirror::Class |
| 215 | Redefiner(art::Runtime* runtime, |
| 216 | art::Thread* self, |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 217 | std::string* error_msg) |
| 218 | : result_(ERR(INTERNAL)), |
| 219 | runtime_(runtime), |
| 220 | self_(self), |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 221 | redefinitions_(), |
| 222 | error_msg_(error_msg) { } |
| 223 | |
Alex Light | 6ac5750 | 2017-01-19 15:05:06 -0800 | [diff] [blame] | 224 | jvmtiError AddRedefinition(ArtJvmTiEnv* env, const ArtClassDefinition& def) |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 225 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 226 | |
Alex Light | e4a8863 | 2017-01-10 07:41:24 -0800 | [diff] [blame] | 227 | static jvmtiError GetClassRedefinitionError(art::Handle<art::mirror::Class> klass, |
| 228 | /*out*/std::string* error_msg) |
| 229 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 230 | |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 231 | // TODO Put on all the lock qualifiers. |
| 232 | jvmtiError Run() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 233 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 234 | bool CheckAllRedefinitionAreValid() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 235 | bool EnsureAllClassAllocationsFinished() REQUIRES_SHARED(art::Locks::mutator_lock_); |
| 236 | bool FinishAllRemainingAllocations(RedefinitionDataHolder& holder) |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 237 | REQUIRES_SHARED(art::Locks::mutator_lock_); |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 238 | void ReleaseAllDexFiles() REQUIRES_SHARED(art::Locks::mutator_lock_); |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 239 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 240 | void RecordFailure(jvmtiError result, const std::string& class_sig, const std::string& error_msg); |
| 241 | void RecordFailure(jvmtiError result, const std::string& error_msg) { |
| 242 | RecordFailure(result, "NO CLASS", error_msg); |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 243 | } |
| 244 | |
Alex Light | 0e69273 | 2017-01-10 15:00:05 -0800 | [diff] [blame] | 245 | friend struct CallbackCtx; |
Alex Light | a01de59 | 2016-11-15 10:43:06 -0800 | [diff] [blame] | 246 | }; |
| 247 | |
| 248 | } // namespace openjdkjvmti |
| 249 | |
| 250 | #endif // ART_RUNTIME_OPENJDKJVMTI_TI_REDEFINE_H_ |