blob: d1fbd758bd71246d0efcad21e16d4f8055cecada [file] [log] [blame]
Alex Lighta01de592016-11-15 10:43:06 -08001/* 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#include "ti_redefine.h"
33
34#include <limits>
35
Andreas Gampe46ee31b2016-12-14 10:11:49 -080036#include "android-base/stringprintf.h"
37
Alex Lighta01de592016-11-15 10:43:06 -080038#include "art_jvmti.h"
Alex Lighta7e38d82017-01-19 14:57:28 -080039#include "base/array_slice.h"
Alex Lighta01de592016-11-15 10:43:06 -080040#include "base/logging.h"
Alex Light460d1b42017-01-10 15:37:17 +000041#include "dex_file.h"
42#include "dex_file_types.h"
Alex Lighta01de592016-11-15 10:43:06 -080043#include "events-inl.h"
44#include "gc/allocation_listener.h"
Alex Light6abd5392017-01-05 17:53:00 -080045#include "gc/heap.h"
Alex Lighta01de592016-11-15 10:43:06 -080046#include "instrumentation.h"
Alex Lightdba61482016-12-21 08:20:29 -080047#include "jit/jit.h"
48#include "jit/jit_code_cache.h"
Alex Lighta01de592016-11-15 10:43:06 -080049#include "jni_env_ext-inl.h"
50#include "jvmti_allocator.h"
Alex Light6161f132017-01-25 10:30:20 -080051#include "mirror/class-inl.h"
Alex Lighta01de592016-11-15 10:43:06 -080052#include "mirror/class_ext.h"
53#include "mirror/object.h"
54#include "object_lock.h"
55#include "runtime.h"
56#include "ScopedLocalRef.h"
Alex Lighteb98b082017-01-25 13:02:32 -080057#include "ti_class_loader.h"
Alex Light0e692732017-01-10 15:00:05 -080058#include "transform.h"
Alex Lighta01de592016-11-15 10:43:06 -080059
60namespace openjdkjvmti {
61
Andreas Gampe46ee31b2016-12-14 10:11:49 -080062using android::base::StringPrintf;
63
Alex Lightdba61482016-12-21 08:20:29 -080064// This visitor walks thread stacks and allocates and sets up the obsolete methods. It also does
65// some basic sanity checks that the obsolete method is sane.
66class ObsoleteMethodStackVisitor : public art::StackVisitor {
67 protected:
68 ObsoleteMethodStackVisitor(
69 art::Thread* thread,
70 art::LinearAlloc* allocator,
71 const std::unordered_set<art::ArtMethod*>& obsoleted_methods,
Alex Light007ada22017-01-10 13:33:56 -080072 /*out*/std::unordered_map<art::ArtMethod*, art::ArtMethod*>* obsolete_maps)
Alex Lightdba61482016-12-21 08:20:29 -080073 : StackVisitor(thread,
74 /*context*/nullptr,
75 StackVisitor::StackWalkKind::kIncludeInlinedFrames),
76 allocator_(allocator),
77 obsoleted_methods_(obsoleted_methods),
Alex Light4ba388a2017-01-27 10:26:49 -080078 obsolete_maps_(obsolete_maps) { }
Alex Lightdba61482016-12-21 08:20:29 -080079
80 ~ObsoleteMethodStackVisitor() OVERRIDE {}
81
82 public:
83 // Returns true if we successfully installed obsolete methods on this thread, filling
84 // obsolete_maps_ with the translations if needed. Returns false and fills error_msg if we fail.
85 // The stack is cleaned up when we fail.
Alex Light007ada22017-01-10 13:33:56 -080086 static void UpdateObsoleteFrames(
Alex Lightdba61482016-12-21 08:20:29 -080087 art::Thread* thread,
88 art::LinearAlloc* allocator,
89 const std::unordered_set<art::ArtMethod*>& obsoleted_methods,
Alex Light007ada22017-01-10 13:33:56 -080090 /*out*/std::unordered_map<art::ArtMethod*, art::ArtMethod*>* obsolete_maps)
91 REQUIRES(art::Locks::mutator_lock_) {
Alex Lightdba61482016-12-21 08:20:29 -080092 ObsoleteMethodStackVisitor visitor(thread,
93 allocator,
94 obsoleted_methods,
Alex Light007ada22017-01-10 13:33:56 -080095 obsolete_maps);
Alex Lightdba61482016-12-21 08:20:29 -080096 visitor.WalkStack();
Alex Lightdba61482016-12-21 08:20:29 -080097 }
98
99 bool VisitFrame() OVERRIDE REQUIRES(art::Locks::mutator_lock_) {
100 art::ArtMethod* old_method = GetMethod();
Alex Lightdba61482016-12-21 08:20:29 -0800101 if (obsoleted_methods_.find(old_method) != obsoleted_methods_.end()) {
Alex Lightdba61482016-12-21 08:20:29 -0800102 // We cannot ensure that the right dex file is used in inlined frames so we don't support
103 // redefining them.
104 DCHECK(!IsInInlinedFrame()) << "Inlined frames are not supported when using redefinition";
105 // TODO We should really support intrinsic obsolete methods.
106 // TODO We should really support redefining intrinsics.
107 // We don't support intrinsics so check for them here.
108 DCHECK(!old_method->IsIntrinsic());
109 art::ArtMethod* new_obsolete_method = nullptr;
110 auto obsolete_method_pair = obsolete_maps_->find(old_method);
111 if (obsolete_method_pair == obsolete_maps_->end()) {
112 // Create a new Obsolete Method and put it in the list.
113 art::Runtime* runtime = art::Runtime::Current();
114 art::ClassLinker* cl = runtime->GetClassLinker();
115 auto ptr_size = cl->GetImagePointerSize();
116 const size_t method_size = art::ArtMethod::Size(ptr_size);
117 auto* method_storage = allocator_->Alloc(GetThread(), method_size);
Alex Light007ada22017-01-10 13:33:56 -0800118 CHECK(method_storage != nullptr) << "Unable to allocate storage for obsolete version of '"
119 << old_method->PrettyMethod() << "'";
Alex Lightdba61482016-12-21 08:20:29 -0800120 new_obsolete_method = new (method_storage) art::ArtMethod();
121 new_obsolete_method->CopyFrom(old_method, ptr_size);
122 DCHECK_EQ(new_obsolete_method->GetDeclaringClass(), old_method->GetDeclaringClass());
123 new_obsolete_method->SetIsObsolete();
124 obsolete_maps_->insert({old_method, new_obsolete_method});
125 // Update JIT Data structures to point to the new method.
126 art::jit::Jit* jit = art::Runtime::Current()->GetJit();
127 if (jit != nullptr) {
128 // Notify the JIT we are making this obsolete method. It will update the jit's internal
129 // structures to keep track of the new obsolete method.
130 jit->GetCodeCache()->MoveObsoleteMethod(old_method, new_obsolete_method);
131 }
132 } else {
133 new_obsolete_method = obsolete_method_pair->second;
134 }
135 DCHECK(new_obsolete_method != nullptr);
136 SetMethod(new_obsolete_method);
137 }
138 return true;
139 }
140
141 private:
142 // The linear allocator we should use to make new methods.
143 art::LinearAlloc* allocator_;
144 // The set of all methods which could be obsoleted.
145 const std::unordered_set<art::ArtMethod*>& obsoleted_methods_;
146 // A map from the original to the newly allocated obsolete method for frames on this thread. The
147 // values in this map must be added to the obsolete_methods_ (and obsolete_dex_caches_) fields of
148 // the redefined classes ClassExt by the caller.
149 std::unordered_map<art::ArtMethod*, art::ArtMethod*>* obsolete_maps_;
Alex Lightdba61482016-12-21 08:20:29 -0800150};
151
Alex Lighte4a88632017-01-10 07:41:24 -0800152jvmtiError Redefiner::IsModifiableClass(jvmtiEnv* env ATTRIBUTE_UNUSED,
153 jclass klass,
154 jboolean* is_redefinable) {
155 // TODO Check for the appropriate feature flags once we have enabled them.
156 art::Thread* self = art::Thread::Current();
157 art::ScopedObjectAccess soa(self);
158 art::StackHandleScope<1> hs(self);
159 art::ObjPtr<art::mirror::Object> obj(self->DecodeJObject(klass));
160 if (obj.IsNull()) {
161 return ERR(INVALID_CLASS);
162 }
163 art::Handle<art::mirror::Class> h_klass(hs.NewHandle(obj->AsClass()));
164 std::string err_unused;
165 *is_redefinable =
166 Redefiner::GetClassRedefinitionError(h_klass, &err_unused) == OK ? JNI_TRUE : JNI_FALSE;
167 return OK;
168}
169
170jvmtiError Redefiner::GetClassRedefinitionError(art::Handle<art::mirror::Class> klass,
171 /*out*/std::string* error_msg) {
172 if (klass->IsPrimitive()) {
173 *error_msg = "Modification of primitive classes is not supported";
174 return ERR(UNMODIFIABLE_CLASS);
175 } else if (klass->IsInterface()) {
176 *error_msg = "Modification of Interface classes is currently not supported";
177 return ERR(UNMODIFIABLE_CLASS);
178 } else if (klass->IsArrayClass()) {
179 *error_msg = "Modification of Array classes is not supported";
180 return ERR(UNMODIFIABLE_CLASS);
181 } else if (klass->IsProxyClass()) {
182 *error_msg = "Modification of proxy classes is not supported";
183 return ERR(UNMODIFIABLE_CLASS);
184 }
185
186 // TODO We should check if the class has non-obsoletable methods on the stack
187 LOG(WARNING) << "presence of non-obsoletable methods on stacks is not currently checked";
188 return OK;
189}
190
Alex Lighta01de592016-11-15 10:43:06 -0800191// Moves dex data to an anonymous, read-only mmap'd region.
192std::unique_ptr<art::MemMap> Redefiner::MoveDataToMemMap(const std::string& original_location,
193 jint data_len,
Alex Light0e692732017-01-10 15:00:05 -0800194 const unsigned char* dex_data,
Alex Lighta01de592016-11-15 10:43:06 -0800195 std::string* error_msg) {
196 std::unique_ptr<art::MemMap> map(art::MemMap::MapAnonymous(
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800197 StringPrintf("%s-transformed", original_location.c_str()).c_str(),
Alex Lighta01de592016-11-15 10:43:06 -0800198 nullptr,
199 data_len,
200 PROT_READ|PROT_WRITE,
201 /*low_4gb*/false,
202 /*reuse*/false,
203 error_msg));
204 if (map == nullptr) {
205 return map;
206 }
207 memcpy(map->Begin(), dex_data, data_len);
Alex Light0b772572016-12-02 17:27:31 -0800208 // Make the dex files mmap read only. This matches how other DexFiles are mmaped and prevents
209 // programs from corrupting it.
Alex Lighta01de592016-11-15 10:43:06 -0800210 map->Protect(PROT_READ);
211 return map;
212}
213
Alex Lighta7e38d82017-01-19 14:57:28 -0800214Redefiner::ClassRedefinition::ClassRedefinition(
215 Redefiner* driver,
216 jclass klass,
217 const art::DexFile* redefined_dex_file,
218 const char* class_sig,
219 art::ArraySlice<const unsigned char> orig_dex_file) :
220 driver_(driver),
221 klass_(klass),
222 dex_file_(redefined_dex_file),
223 class_sig_(class_sig),
224 original_dex_file_(orig_dex_file) {
Alex Light0e692732017-01-10 15:00:05 -0800225 GetMirrorClass()->MonitorEnter(driver_->self_);
226}
227
228Redefiner::ClassRedefinition::~ClassRedefinition() {
229 if (driver_ != nullptr) {
230 GetMirrorClass()->MonitorExit(driver_->self_);
231 }
232}
233
Alex Light0e692732017-01-10 15:00:05 -0800234jvmtiError Redefiner::RedefineClasses(ArtJvmTiEnv* env,
235 art::Runtime* runtime,
236 art::Thread* self,
237 jint class_count,
238 const jvmtiClassDefinition* definitions,
Alex Light6ac57502017-01-19 15:05:06 -0800239 /*out*/std::string* error_msg) {
Alex Light0e692732017-01-10 15:00:05 -0800240 if (env == nullptr) {
241 *error_msg = "env was null!";
242 return ERR(INVALID_ENVIRONMENT);
243 } else if (class_count < 0) {
244 *error_msg = "class_count was less then 0";
245 return ERR(ILLEGAL_ARGUMENT);
246 } else if (class_count == 0) {
247 // We don't actually need to do anything. Just return OK.
248 return OK;
249 } else if (definitions == nullptr) {
250 *error_msg = "null definitions!";
251 return ERR(NULL_POINTER);
252 }
Alex Light6ac57502017-01-19 15:05:06 -0800253 std::vector<ArtClassDefinition> def_vector;
254 def_vector.reserve(class_count);
255 for (jint i = 0; i < class_count; i++) {
256 // We make a copy of the class_bytes to pass into the retransformation.
257 // This makes cleanup easier (since we unambiguously own the bytes) and also is useful since we
258 // will need to keep the original bytes around unaltered for subsequent RetransformClasses calls
259 // to get the passed in bytes.
260 // TODO Implement saving the original bytes.
261 unsigned char* class_bytes_copy = nullptr;
262 jvmtiError res = env->Allocate(definitions[i].class_byte_count, &class_bytes_copy);
263 if (res != OK) {
264 return res;
265 }
266 memcpy(class_bytes_copy, definitions[i].class_bytes, definitions[i].class_byte_count);
267
268 ArtClassDefinition def;
269 def.dex_len = definitions[i].class_byte_count;
270 def.dex_data = MakeJvmtiUniquePtr(env, class_bytes_copy);
271 // We are definitely modified.
Alex Lighta7e38d82017-01-19 14:57:28 -0800272 def.SetModified();
273 def.original_dex_file = art::ArraySlice<const unsigned char>(definitions[i].class_bytes,
274 definitions[i].class_byte_count);
Alex Light6ac57502017-01-19 15:05:06 -0800275 res = Transformer::FillInTransformationData(env, definitions[i].klass, &def);
276 if (res != OK) {
277 return res;
278 }
279 def_vector.push_back(std::move(def));
280 }
281 // Call all the transformation events.
282 jvmtiError res = Transformer::RetransformClassesDirect(env,
283 self,
284 &def_vector);
285 if (res != OK) {
286 // Something went wrong with transformation!
287 return res;
288 }
289 return RedefineClassesDirect(env, runtime, self, def_vector, error_msg);
290}
291
292jvmtiError Redefiner::RedefineClassesDirect(ArtJvmTiEnv* env,
293 art::Runtime* runtime,
294 art::Thread* self,
295 const std::vector<ArtClassDefinition>& definitions,
296 std::string* error_msg) {
297 DCHECK(env != nullptr);
298 if (definitions.size() == 0) {
299 // We don't actually need to do anything. Just return OK.
300 return OK;
301 }
Alex Light0e692732017-01-10 15:00:05 -0800302 // Stop JIT for the duration of this redefine since the JIT might concurrently compile a method we
303 // are going to redefine.
304 art::jit::ScopedJitSuspend suspend_jit;
305 // Get shared mutator lock so we can lock all the classes.
306 art::ScopedObjectAccess soa(self);
Alex Light0e692732017-01-10 15:00:05 -0800307 Redefiner r(runtime, self, error_msg);
Alex Light6ac57502017-01-19 15:05:06 -0800308 for (const ArtClassDefinition& def : definitions) {
309 // Only try to transform classes that have been modified.
Alex Lighta7e38d82017-01-19 14:57:28 -0800310 if (def.IsModified(self)) {
Alex Light6ac57502017-01-19 15:05:06 -0800311 jvmtiError res = r.AddRedefinition(env, def);
312 if (res != OK) {
313 return res;
314 }
Alex Light0e692732017-01-10 15:00:05 -0800315 }
316 }
317 return r.Run();
318}
319
Alex Light6ac57502017-01-19 15:05:06 -0800320jvmtiError Redefiner::AddRedefinition(ArtJvmTiEnv* env, const ArtClassDefinition& def) {
Alex Light0e692732017-01-10 15:00:05 -0800321 std::string original_dex_location;
322 jvmtiError ret = OK;
323 if ((ret = GetClassLocation(env, def.klass, &original_dex_location))) {
324 *error_msg_ = "Unable to get original dex file location!";
325 return ret;
326 }
Alex Light52a2db52017-01-19 23:00:21 +0000327 char* generic_ptr_unused = nullptr;
328 char* signature_ptr = nullptr;
Alex Light6ac57502017-01-19 15:05:06 -0800329 if ((ret = env->GetClassSignature(def.klass, &signature_ptr, &generic_ptr_unused)) != OK) {
330 *error_msg_ = "Unable to get class signature!";
331 return ret;
Alex Light52a2db52017-01-19 23:00:21 +0000332 }
Alex Light52a2db52017-01-19 23:00:21 +0000333 JvmtiUniquePtr generic_unique_ptr(MakeJvmtiUniquePtr(env, generic_ptr_unused));
Alex Light6ac57502017-01-19 15:05:06 -0800334 JvmtiUniquePtr signature_unique_ptr(MakeJvmtiUniquePtr(env, signature_ptr));
335 std::unique_ptr<art::MemMap> map(MoveDataToMemMap(original_dex_location,
336 def.dex_len,
337 def.dex_data.get(),
338 error_msg_));
339 std::ostringstream os;
Alex Lighta01de592016-11-15 10:43:06 -0800340 if (map.get() == nullptr) {
Alex Light6ac57502017-01-19 15:05:06 -0800341 os << "Failed to create anonymous mmap for modified dex file of class " << def.name
Alex Light0e692732017-01-10 15:00:05 -0800342 << "in dex file " << original_dex_location << " because: " << *error_msg_;
343 *error_msg_ = os.str();
Alex Lighta01de592016-11-15 10:43:06 -0800344 return ERR(OUT_OF_MEMORY);
345 }
346 if (map->Size() < sizeof(art::DexFile::Header)) {
Alex Light0e692732017-01-10 15:00:05 -0800347 *error_msg_ = "Could not read dex file header because dex_data was too short";
Alex Lighta01de592016-11-15 10:43:06 -0800348 return ERR(INVALID_CLASS_FORMAT);
349 }
350 uint32_t checksum = reinterpret_cast<const art::DexFile::Header*>(map->Begin())->checksum_;
351 std::unique_ptr<const art::DexFile> dex_file(art::DexFile::Open(map->GetName(),
352 checksum,
353 std::move(map),
354 /*verify*/true,
355 /*verify_checksum*/true,
Alex Light0e692732017-01-10 15:00:05 -0800356 error_msg_));
Alex Lighta01de592016-11-15 10:43:06 -0800357 if (dex_file.get() == nullptr) {
Alex Light6ac57502017-01-19 15:05:06 -0800358 os << "Unable to load modified dex file for " << def.name << ": " << *error_msg_;
Alex Light0e692732017-01-10 15:00:05 -0800359 *error_msg_ = os.str();
Alex Lighta01de592016-11-15 10:43:06 -0800360 return ERR(INVALID_CLASS_FORMAT);
361 }
Alex Light0e692732017-01-10 15:00:05 -0800362 redefinitions_.push_back(
Alex Lighta7e38d82017-01-19 14:57:28 -0800363 Redefiner::ClassRedefinition(this,
364 def.klass,
365 dex_file.release(),
366 signature_ptr,
367 def.original_dex_file));
Alex Light0e692732017-01-10 15:00:05 -0800368 return OK;
Alex Lighta01de592016-11-15 10:43:06 -0800369}
370
Alex Light0e692732017-01-10 15:00:05 -0800371art::mirror::Class* Redefiner::ClassRedefinition::GetMirrorClass() {
372 return driver_->self_->DecodeJObject(klass_)->AsClass();
Alex Lighta01de592016-11-15 10:43:06 -0800373}
374
Alex Light0e692732017-01-10 15:00:05 -0800375art::mirror::ClassLoader* Redefiner::ClassRedefinition::GetClassLoader() {
Alex Lighta01de592016-11-15 10:43:06 -0800376 return GetMirrorClass()->GetClassLoader();
377}
378
Alex Light0e692732017-01-10 15:00:05 -0800379art::mirror::DexCache* Redefiner::ClassRedefinition::CreateNewDexCache(
380 art::Handle<art::mirror::ClassLoader> loader) {
381 return driver_->runtime_->GetClassLinker()->RegisterDexFile(*dex_file_, loader.Get());
Alex Lighta01de592016-11-15 10:43:06 -0800382}
383
Alex Light0e692732017-01-10 15:00:05 -0800384void Redefiner::RecordFailure(jvmtiError result,
385 const std::string& class_sig,
386 const std::string& error_msg) {
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800387 *error_msg_ = StringPrintf("Unable to perform redefinition of '%s': %s",
Alex Light0e692732017-01-10 15:00:05 -0800388 class_sig.c_str(),
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800389 error_msg.c_str());
Alex Lighta01de592016-11-15 10:43:06 -0800390 result_ = result;
391}
392
Alex Lighta7e38d82017-01-19 14:57:28 -0800393art::mirror::ByteArray* Redefiner::ClassRedefinition::AllocateOrGetOriginalDexFileBytes() {
394 // If we have been specifically given a new set of bytes use that
395 if (original_dex_file_.size() != 0) {
Alex Light440b5d92017-01-24 15:32:25 -0800396 return art::mirror::ByteArray::AllocateAndFill(
397 driver_->self_,
398 reinterpret_cast<const signed char*>(&original_dex_file_.At(0)),
399 original_dex_file_.size());
Alex Lighta01de592016-11-15 10:43:06 -0800400 }
Alex Lighta7e38d82017-01-19 14:57:28 -0800401
402 // See if we already have one set.
403 art::ObjPtr<art::mirror::ClassExt> ext(GetMirrorClass()->GetExtData());
404 if (!ext.IsNull()) {
405 art::ObjPtr<art::mirror::ByteArray> old_original_bytes(ext->GetOriginalDexFileBytes());
406 if (!old_original_bytes.IsNull()) {
407 // We do. Use it.
408 return old_original_bytes.Ptr();
409 }
Alex Lighta01de592016-11-15 10:43:06 -0800410 }
Alex Lighta7e38d82017-01-19 14:57:28 -0800411
412 // Copy the current dex_file
413 const art::DexFile& current_dex_file = GetMirrorClass()->GetDexFile();
414 // TODO Handle this or make it so it cannot happen.
415 if (current_dex_file.NumClassDefs() != 1) {
416 LOG(WARNING) << "Current dex file has more than one class in it. Calling RetransformClasses "
417 << "on this class might fail if no transformations are applied to it!";
Alex Lighta01de592016-11-15 10:43:06 -0800418 }
Alex Light440b5d92017-01-24 15:32:25 -0800419 return art::mirror::ByteArray::AllocateAndFill(
420 driver_->self_,
421 reinterpret_cast<const signed char*>(current_dex_file.Begin()),
422 current_dex_file.Size());
Alex Lighta01de592016-11-15 10:43:06 -0800423}
424
Alex Lightdba61482016-12-21 08:20:29 -0800425struct CallbackCtx {
Alex Lightdba61482016-12-21 08:20:29 -0800426 art::LinearAlloc* allocator;
427 std::unordered_map<art::ArtMethod*, art::ArtMethod*> obsolete_map;
428 std::unordered_set<art::ArtMethod*> obsolete_methods;
Alex Lightdba61482016-12-21 08:20:29 -0800429
Alex Light0e692732017-01-10 15:00:05 -0800430 explicit CallbackCtx(art::LinearAlloc* alloc) : allocator(alloc) {}
Alex Lightdba61482016-12-21 08:20:29 -0800431};
432
Alex Lightdba61482016-12-21 08:20:29 -0800433void DoAllocateObsoleteMethodsCallback(art::Thread* t, void* vdata) NO_THREAD_SAFETY_ANALYSIS {
434 CallbackCtx* data = reinterpret_cast<CallbackCtx*>(vdata);
Alex Light007ada22017-01-10 13:33:56 -0800435 ObsoleteMethodStackVisitor::UpdateObsoleteFrames(t,
436 data->allocator,
437 data->obsolete_methods,
438 &data->obsolete_map);
Alex Lightdba61482016-12-21 08:20:29 -0800439}
440
441// This creates any ArtMethod* structures needed for obsolete methods and ensures that the stack is
442// updated so they will be run.
Alex Light0e692732017-01-10 15:00:05 -0800443// TODO Rewrite so we can do this only once regardless of how many redefinitions there are.
444void Redefiner::ClassRedefinition::FindAndAllocateObsoleteMethods(art::mirror::Class* art_klass) {
Alex Lightdba61482016-12-21 08:20:29 -0800445 art::ScopedAssertNoThreadSuspension ns("No thread suspension during thread stack walking");
446 art::mirror::ClassExt* ext = art_klass->GetExtData();
447 CHECK(ext->GetObsoleteMethods() != nullptr);
Alex Light7916f202017-01-27 09:00:15 -0800448 art::ClassLinker* linker = driver_->runtime_->GetClassLinker();
449 CallbackCtx ctx(linker->GetAllocatorForClassLoader(art_klass->GetClassLoader()));
Alex Lightdba61482016-12-21 08:20:29 -0800450 // Add all the declared methods to the map
451 for (auto& m : art_klass->GetDeclaredMethods(art::kRuntimePointerSize)) {
452 ctx.obsolete_methods.insert(&m);
Alex Light007ada22017-01-10 13:33:56 -0800453 // TODO Allow this or check in IsModifiableClass.
454 DCHECK(!m.IsIntrinsic());
Alex Lightdba61482016-12-21 08:20:29 -0800455 }
456 {
Alex Light0e692732017-01-10 15:00:05 -0800457 art::MutexLock mu(driver_->self_, *art::Locks::thread_list_lock_);
Alex Lightdba61482016-12-21 08:20:29 -0800458 art::ThreadList* list = art::Runtime::Current()->GetThreadList();
459 list->ForEach(DoAllocateObsoleteMethodsCallback, static_cast<void*>(&ctx));
Alex Lightdba61482016-12-21 08:20:29 -0800460 }
461 FillObsoleteMethodMap(art_klass, ctx.obsolete_map);
Alex Lightdba61482016-12-21 08:20:29 -0800462}
463
464// Fills the obsolete method map in the art_klass's extData. This is so obsolete methods are able to
465// figure out their DexCaches.
Alex Light0e692732017-01-10 15:00:05 -0800466void Redefiner::ClassRedefinition::FillObsoleteMethodMap(
Alex Lightdba61482016-12-21 08:20:29 -0800467 art::mirror::Class* art_klass,
468 const std::unordered_map<art::ArtMethod*, art::ArtMethod*>& obsoletes) {
469 int32_t index = 0;
470 art::mirror::ClassExt* ext_data = art_klass->GetExtData();
471 art::mirror::PointerArray* obsolete_methods = ext_data->GetObsoleteMethods();
472 art::mirror::ObjectArray<art::mirror::DexCache>* obsolete_dex_caches =
473 ext_data->GetObsoleteDexCaches();
474 int32_t num_method_slots = obsolete_methods->GetLength();
475 // Find the first empty index.
476 for (; index < num_method_slots; index++) {
477 if (obsolete_methods->GetElementPtrSize<art::ArtMethod*>(
478 index, art::kRuntimePointerSize) == nullptr) {
479 break;
480 }
481 }
482 // Make sure we have enough space.
483 CHECK_GT(num_method_slots, static_cast<int32_t>(obsoletes.size() + index));
484 CHECK(obsolete_dex_caches->Get(index) == nullptr);
485 // Fill in the map.
486 for (auto& obs : obsoletes) {
487 obsolete_methods->SetElementPtrSize(index, obs.second, art::kRuntimePointerSize);
488 obsolete_dex_caches->Set(index, art_klass->GetDexCache());
489 index++;
490 }
491}
492
Alex Light6161f132017-01-25 10:30:20 -0800493// Try and get the declared method. First try to get a virtual method then a direct method if that's
494// not found.
495static art::ArtMethod* FindMethod(art::Handle<art::mirror::Class> klass,
496 const char* name,
497 art::Signature sig) REQUIRES_SHARED(art::Locks::mutator_lock_) {
498 art::ArtMethod* m = klass->FindDeclaredVirtualMethod(name, sig, art::kRuntimePointerSize);
499 if (m == nullptr) {
500 m = klass->FindDeclaredDirectMethod(name, sig, art::kRuntimePointerSize);
501 }
502 return m;
503}
504
505bool Redefiner::ClassRedefinition::CheckSameMethods() {
506 art::StackHandleScope<1> hs(driver_->self_);
507 art::Handle<art::mirror::Class> h_klass(hs.NewHandle(GetMirrorClass()));
508 DCHECK_EQ(dex_file_->NumClassDefs(), 1u);
509
510 art::ClassDataItemIterator new_iter(*dex_file_,
511 dex_file_->GetClassData(dex_file_->GetClassDef(0)));
512
513 // Make sure we have the same number of methods.
514 uint32_t num_new_method = new_iter.NumVirtualMethods() + new_iter.NumDirectMethods();
515 uint32_t num_old_method = h_klass->GetDeclaredMethodsSlice(art::kRuntimePointerSize).size();
516 if (num_new_method != num_old_method) {
517 bool bigger = num_new_method > num_old_method;
518 RecordFailure(bigger ? ERR(UNSUPPORTED_REDEFINITION_METHOD_ADDED)
519 : ERR(UNSUPPORTED_REDEFINITION_METHOD_DELETED),
520 StringPrintf("Total number of declared methods changed from %d to %d",
521 num_old_method, num_new_method));
522 return false;
523 }
524
525 // Skip all of the fields. We should have already checked this.
526 while (new_iter.HasNextStaticField() || new_iter.HasNextInstanceField()) {
527 new_iter.Next();
528 }
529 // Check each of the methods. NB we don't need to specifically check for removals since the 2 dex
530 // files have the same number of methods, which means there must be an equal amount of additions
531 // and removals.
532 for (; new_iter.HasNextVirtualMethod() || new_iter.HasNextDirectMethod(); new_iter.Next()) {
533 // Get the data on the method we are searching for
534 const art::DexFile::MethodId& new_method_id = dex_file_->GetMethodId(new_iter.GetMemberIndex());
535 const char* new_method_name = dex_file_->GetMethodName(new_method_id);
536 art::Signature new_method_signature = dex_file_->GetMethodSignature(new_method_id);
537 art::ArtMethod* old_method = FindMethod(h_klass, new_method_name, new_method_signature);
538 // If we got past the check for the same number of methods above that means there must be at
539 // least one added and one removed method. We will return the ADDED failure message since it is
540 // easier to get a useful error report for it.
541 if (old_method == nullptr) {
542 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_METHOD_ADDED),
543 StringPrintf("Unknown method '%s' (sig: %s) was added!",
544 new_method_name,
545 new_method_signature.ToString().c_str()));
546 return false;
547 }
548 // Since direct methods have different flags than virtual ones (specifically direct methods must
549 // have kAccPrivate or kAccStatic or kAccConstructor flags) we can tell if a method changes from
550 // virtual to direct.
551 uint32_t new_flags = new_iter.GetMethodAccessFlags();
552 if (new_flags != (old_method->GetAccessFlags() & art::kAccValidMethodFlags)) {
553 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_METHOD_MODIFIERS_CHANGED),
554 StringPrintf("method '%s' (sig: %s) had different access flags",
555 new_method_name,
556 new_method_signature.ToString().c_str()));
557 return false;
558 }
559 }
560 return true;
561}
562
563bool Redefiner::ClassRedefinition::CheckSameFields() {
564 art::StackHandleScope<1> hs(driver_->self_);
565 art::Handle<art::mirror::Class> h_klass(hs.NewHandle(GetMirrorClass()));
566 DCHECK_EQ(dex_file_->NumClassDefs(), 1u);
567 art::ClassDataItemIterator new_iter(*dex_file_,
568 dex_file_->GetClassData(dex_file_->GetClassDef(0)));
569 const art::DexFile& old_dex_file = h_klass->GetDexFile();
570 art::ClassDataItemIterator old_iter(old_dex_file,
571 old_dex_file.GetClassData(*h_klass->GetClassDef()));
572 // Instance and static fields can be differentiated by their flags so no need to check them
573 // separately.
574 while (new_iter.HasNextInstanceField() || new_iter.HasNextStaticField()) {
575 // Get the data on the method we are searching for
576 const art::DexFile::FieldId& new_field_id = dex_file_->GetFieldId(new_iter.GetMemberIndex());
577 const char* new_field_name = dex_file_->GetFieldName(new_field_id);
578 const char* new_field_type = dex_file_->GetFieldTypeDescriptor(new_field_id);
579
580 if (!(old_iter.HasNextInstanceField() || old_iter.HasNextStaticField())) {
581 // We are missing the old version of this method!
582 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_SCHEMA_CHANGED),
583 StringPrintf("Unknown field '%s' (type: %s) added!",
584 new_field_name,
585 new_field_type));
586 return false;
587 }
588
589 const art::DexFile::FieldId& old_field_id = old_dex_file.GetFieldId(old_iter.GetMemberIndex());
590 const char* old_field_name = old_dex_file.GetFieldName(old_field_id);
591 const char* old_field_type = old_dex_file.GetFieldTypeDescriptor(old_field_id);
592
593 // Check name and type.
594 if (strcmp(old_field_name, new_field_name) != 0 ||
595 strcmp(old_field_type, new_field_type) != 0) {
596 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_SCHEMA_CHANGED),
597 StringPrintf("Field changed from '%s' (sig: %s) to '%s' (sig: %s)!",
598 old_field_name,
599 old_field_type,
600 new_field_name,
601 new_field_type));
602 return false;
603 }
604
605 // Since static fields have different flags than instance ones (specifically static fields must
606 // have the kAccStatic flag) we can tell if a field changes from static to instance.
607 if (new_iter.GetFieldAccessFlags() != old_iter.GetFieldAccessFlags()) {
608 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_SCHEMA_CHANGED),
609 StringPrintf("Field '%s' (sig: %s) had different access flags",
610 new_field_name,
611 new_field_type));
612 return false;
613 }
614
615 new_iter.Next();
616 old_iter.Next();
617 }
618 if (old_iter.HasNextInstanceField() || old_iter.HasNextStaticField()) {
619 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_SCHEMA_CHANGED),
620 StringPrintf("field '%s' (sig: %s) is missing!",
621 old_dex_file.GetFieldName(old_dex_file.GetFieldId(
622 old_iter.GetMemberIndex())),
623 old_dex_file.GetFieldTypeDescriptor(old_dex_file.GetFieldId(
624 old_iter.GetMemberIndex()))));
625 return false;
626 }
627 return true;
628}
629
Alex Light0e692732017-01-10 15:00:05 -0800630bool Redefiner::ClassRedefinition::CheckClass() {
Alex Light460d1b42017-01-10 15:37:17 +0000631 // TODO Might just want to put it in a ObjPtr and NoSuspend assert.
Alex Light0e692732017-01-10 15:00:05 -0800632 art::StackHandleScope<1> hs(driver_->self_);
Alex Light460d1b42017-01-10 15:37:17 +0000633 // Easy check that only 1 class def is present.
634 if (dex_file_->NumClassDefs() != 1) {
635 RecordFailure(ERR(ILLEGAL_ARGUMENT),
636 StringPrintf("Expected 1 class def in dex file but found %d",
637 dex_file_->NumClassDefs()));
638 return false;
639 }
640 // Get the ClassDef from the new DexFile.
641 // Since the dex file has only a single class def the index is always 0.
642 const art::DexFile::ClassDef& def = dex_file_->GetClassDef(0);
643 // Get the class as it is now.
644 art::Handle<art::mirror::Class> current_class(hs.NewHandle(GetMirrorClass()));
645
646 // Check the access flags didn't change.
647 if (def.GetJavaAccessFlags() != (current_class->GetAccessFlags() & art::kAccValidClassFlags)) {
648 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_CLASS_MODIFIERS_CHANGED),
649 "Cannot change modifiers of class by redefinition");
650 return false;
651 }
652
653 // Check class name.
654 // These should have been checked by the dexfile verifier on load.
655 DCHECK_NE(def.class_idx_, art::dex::TypeIndex::Invalid()) << "Invalid type index";
656 const char* descriptor = dex_file_->StringByTypeIdx(def.class_idx_);
657 DCHECK(descriptor != nullptr) << "Invalid dex file structure!";
658 if (!current_class->DescriptorEquals(descriptor)) {
659 std::string storage;
660 RecordFailure(ERR(NAMES_DONT_MATCH),
661 StringPrintf("expected file to contain class called '%s' but found '%s'!",
662 current_class->GetDescriptor(&storage),
663 descriptor));
664 return false;
665 }
666 if (current_class->IsObjectClass()) {
667 if (def.superclass_idx_ != art::dex::TypeIndex::Invalid()) {
668 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_HIERARCHY_CHANGED), "Superclass added!");
669 return false;
670 }
671 } else {
672 const char* super_descriptor = dex_file_->StringByTypeIdx(def.superclass_idx_);
673 DCHECK(descriptor != nullptr) << "Invalid dex file structure!";
674 if (!current_class->GetSuperClass()->DescriptorEquals(super_descriptor)) {
675 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_HIERARCHY_CHANGED), "Superclass changed");
676 return false;
677 }
678 }
679 const art::DexFile::TypeList* interfaces = dex_file_->GetInterfacesList(def);
680 if (interfaces == nullptr) {
681 if (current_class->NumDirectInterfaces() != 0) {
682 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_HIERARCHY_CHANGED), "Interfaces added");
683 return false;
684 }
685 } else {
686 DCHECK(!current_class->IsProxyClass());
687 const art::DexFile::TypeList* current_interfaces = current_class->GetInterfaceTypeList();
688 if (current_interfaces == nullptr || current_interfaces->Size() != interfaces->Size()) {
689 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_HIERARCHY_CHANGED), "Interfaces added or removed");
690 return false;
691 }
692 // The order of interfaces is (barely) meaningful so we error if it changes.
693 const art::DexFile& orig_dex_file = current_class->GetDexFile();
694 for (uint32_t i = 0; i < interfaces->Size(); i++) {
695 if (strcmp(
696 dex_file_->StringByTypeIdx(interfaces->GetTypeItem(i).type_idx_),
697 orig_dex_file.StringByTypeIdx(current_interfaces->GetTypeItem(i).type_idx_)) != 0) {
698 RecordFailure(ERR(UNSUPPORTED_REDEFINITION_HIERARCHY_CHANGED),
699 "Interfaces changed or re-ordered");
700 return false;
701 }
702 }
703 }
704 LOG(WARNING) << "No verification is done on annotations of redefined classes.";
Alex Light0e692732017-01-10 15:00:05 -0800705 LOG(WARNING) << "Bytecodes of redefinitions are not verified.";
Alex Light460d1b42017-01-10 15:37:17 +0000706
707 return true;
708}
709
710// TODO Move this to use IsRedefinable when that function is made.
Alex Light0e692732017-01-10 15:00:05 -0800711bool Redefiner::ClassRedefinition::CheckRedefinable() {
Alex Lighte4a88632017-01-10 07:41:24 -0800712 std::string err;
Alex Light0e692732017-01-10 15:00:05 -0800713 art::StackHandleScope<1> hs(driver_->self_);
Alex Light460d1b42017-01-10 15:37:17 +0000714
Alex Lighte4a88632017-01-10 07:41:24 -0800715 art::Handle<art::mirror::Class> h_klass(hs.NewHandle(GetMirrorClass()));
716 jvmtiError res = Redefiner::GetClassRedefinitionError(h_klass, &err);
717 if (res != OK) {
718 RecordFailure(res, err);
719 return false;
720 } else {
721 return true;
722 }
Alex Light460d1b42017-01-10 15:37:17 +0000723}
724
Alex Light0e692732017-01-10 15:00:05 -0800725bool Redefiner::ClassRedefinition::CheckRedefinitionIsValid() {
Alex Light460d1b42017-01-10 15:37:17 +0000726 return CheckRedefinable() &&
727 CheckClass() &&
728 CheckSameFields() &&
729 CheckSameMethods();
730}
731
Alex Light0e692732017-01-10 15:00:05 -0800732// A wrapper that lets us hold onto the arbitrary sized data needed for redefinitions in a
733// reasonably sane way. This adds no fields to the normal ObjectArray. By doing this we can avoid
734// having to deal with the fact that we need to hold an arbitrary number of references live.
735class RedefinitionDataHolder {
736 public:
737 enum DataSlot : int32_t {
738 kSlotSourceClassLoader = 0,
739 kSlotJavaDexFile = 1,
740 kSlotNewDexFileCookie = 2,
741 kSlotNewDexCache = 3,
742 kSlotMirrorClass = 4,
Alex Lighta7e38d82017-01-19 14:57:28 -0800743 kSlotOrigDexFile = 5,
Alex Light0e692732017-01-10 15:00:05 -0800744
745 // Must be last one.
Alex Lighta7e38d82017-01-19 14:57:28 -0800746 kNumSlots = 6,
Alex Light0e692732017-01-10 15:00:05 -0800747 };
748
749 // This needs to have a HandleScope passed in that is capable of creating a new Handle without
750 // overflowing. Only one handle will be created. This object has a lifetime identical to that of
751 // the passed in handle-scope.
752 RedefinitionDataHolder(art::StackHandleScope<1>* hs,
753 art::Runtime* runtime,
754 art::Thread* self,
755 int32_t num_redefinitions) REQUIRES_SHARED(art::Locks::mutator_lock_) :
756 arr_(
757 hs->NewHandle(
758 art::mirror::ObjectArray<art::mirror::Object>::Alloc(
759 self,
760 runtime->GetClassLinker()->GetClassRoot(art::ClassLinker::kObjectArrayClass),
761 num_redefinitions * kNumSlots))) {}
762
763 bool IsNull() const REQUIRES_SHARED(art::Locks::mutator_lock_) {
764 return arr_.IsNull();
765 }
766
767 // TODO Maybe make an iterable view type to simplify using this.
768 art::mirror::ClassLoader* GetSourceClassLoader(jint klass_index)
769 REQUIRES_SHARED(art::Locks::mutator_lock_) {
770 return art::down_cast<art::mirror::ClassLoader*>(GetSlot(klass_index, kSlotSourceClassLoader));
771 }
772 art::mirror::Object* GetJavaDexFile(jint klass_index) REQUIRES_SHARED(art::Locks::mutator_lock_) {
773 return GetSlot(klass_index, kSlotJavaDexFile);
774 }
775 art::mirror::LongArray* GetNewDexFileCookie(jint klass_index)
776 REQUIRES_SHARED(art::Locks::mutator_lock_) {
777 return art::down_cast<art::mirror::LongArray*>(GetSlot(klass_index, kSlotNewDexFileCookie));
778 }
779 art::mirror::DexCache* GetNewDexCache(jint klass_index)
780 REQUIRES_SHARED(art::Locks::mutator_lock_) {
781 return art::down_cast<art::mirror::DexCache*>(GetSlot(klass_index, kSlotNewDexCache));
782 }
783 art::mirror::Class* GetMirrorClass(jint klass_index) REQUIRES_SHARED(art::Locks::mutator_lock_) {
784 return art::down_cast<art::mirror::Class*>(GetSlot(klass_index, kSlotMirrorClass));
785 }
786
Alex Lighta7e38d82017-01-19 14:57:28 -0800787 art::mirror::ByteArray* GetOriginalDexFileBytes(jint klass_index)
788 REQUIRES_SHARED(art::Locks::mutator_lock_) {
789 return art::down_cast<art::mirror::ByteArray*>(GetSlot(klass_index, kSlotOrigDexFile));
790 }
791
Alex Light0e692732017-01-10 15:00:05 -0800792 void SetSourceClassLoader(jint klass_index, art::mirror::ClassLoader* loader)
793 REQUIRES_SHARED(art::Locks::mutator_lock_) {
794 SetSlot(klass_index, kSlotSourceClassLoader, loader);
795 }
796 void SetJavaDexFile(jint klass_index, art::mirror::Object* dexfile)
797 REQUIRES_SHARED(art::Locks::mutator_lock_) {
798 SetSlot(klass_index, kSlotJavaDexFile, dexfile);
799 }
800 void SetNewDexFileCookie(jint klass_index, art::mirror::LongArray* cookie)
801 REQUIRES_SHARED(art::Locks::mutator_lock_) {
802 SetSlot(klass_index, kSlotNewDexFileCookie, cookie);
803 }
804 void SetNewDexCache(jint klass_index, art::mirror::DexCache* cache)
805 REQUIRES_SHARED(art::Locks::mutator_lock_) {
806 SetSlot(klass_index, kSlotNewDexCache, cache);
807 }
808 void SetMirrorClass(jint klass_index, art::mirror::Class* klass)
809 REQUIRES_SHARED(art::Locks::mutator_lock_) {
810 SetSlot(klass_index, kSlotMirrorClass, klass);
811 }
Alex Lighta7e38d82017-01-19 14:57:28 -0800812 void SetOriginalDexFileBytes(jint klass_index, art::mirror::ByteArray* bytes)
813 REQUIRES_SHARED(art::Locks::mutator_lock_) {
814 SetSlot(klass_index, kSlotOrigDexFile, bytes);
815 }
Alex Light0e692732017-01-10 15:00:05 -0800816
817 int32_t Length() REQUIRES_SHARED(art::Locks::mutator_lock_) {
818 return arr_->GetLength() / kNumSlots;
819 }
820
821 private:
822 art::Handle<art::mirror::ObjectArray<art::mirror::Object>> arr_;
823
824 art::mirror::Object* GetSlot(jint klass_index,
825 DataSlot slot) REQUIRES_SHARED(art::Locks::mutator_lock_) {
826 DCHECK_LT(klass_index, Length());
827 return arr_->Get((kNumSlots * klass_index) + slot);
828 }
829
830 void SetSlot(jint klass_index,
831 DataSlot slot,
832 art::ObjPtr<art::mirror::Object> obj) REQUIRES_SHARED(art::Locks::mutator_lock_) {
833 DCHECK(!art::Runtime::Current()->IsActiveTransaction());
834 DCHECK_LT(klass_index, Length());
835 arr_->Set<false>((kNumSlots * klass_index) + slot, obj);
836 }
837
838 DISALLOW_COPY_AND_ASSIGN(RedefinitionDataHolder);
839};
840
Alex Lighta7e38d82017-01-19 14:57:28 -0800841bool Redefiner::ClassRedefinition::FinishRemainingAllocations(
842 int32_t klass_index, /*out*/RedefinitionDataHolder* holder) {
Alex Light7916f202017-01-27 09:00:15 -0800843 art::ScopedObjectAccessUnchecked soa(driver_->self_);
Alex Lighta7e38d82017-01-19 14:57:28 -0800844 art::StackHandleScope<2> hs(driver_->self_);
845 holder->SetMirrorClass(klass_index, GetMirrorClass());
846 // This shouldn't allocate
847 art::Handle<art::mirror::ClassLoader> loader(hs.NewHandle(GetClassLoader()));
Alex Light7916f202017-01-27 09:00:15 -0800848 // The bootclasspath is handled specially so it doesn't have a j.l.DexFile.
849 if (!art::ClassLinker::IsBootClassLoader(soa, loader.Get())) {
850 holder->SetSourceClassLoader(klass_index, loader.Get());
851 art::Handle<art::mirror::Object> dex_file_obj(hs.NewHandle(
852 ClassLoaderHelper::FindSourceDexFileObject(driver_->self_, loader)));
853 holder->SetJavaDexFile(klass_index, dex_file_obj.Get());
854 if (dex_file_obj.Get() == nullptr) {
855 // TODO Better error msg.
856 RecordFailure(ERR(INTERNAL), "Unable to find dex file!");
857 return false;
858 }
859 holder->SetNewDexFileCookie(klass_index,
860 ClassLoaderHelper::AllocateNewDexFileCookie(driver_->self_,
861 dex_file_obj,
862 dex_file_.get()).Ptr());
863 if (holder->GetNewDexFileCookie(klass_index) == nullptr) {
864 driver_->self_->AssertPendingOOMException();
865 driver_->self_->ClearException();
866 RecordFailure(ERR(OUT_OF_MEMORY), "Unable to allocate dex file array for class loader");
867 return false;
868 }
Alex Lighta7e38d82017-01-19 14:57:28 -0800869 }
870 holder->SetNewDexCache(klass_index, CreateNewDexCache(loader));
871 if (holder->GetNewDexCache(klass_index) == nullptr) {
872 driver_->self_->AssertPendingOOMException();
873 driver_->self_->ClearException();
874 RecordFailure(ERR(OUT_OF_MEMORY), "Unable to allocate DexCache");
875 return false;
876 }
877
878 // We won't always need to set this field.
879 holder->SetOriginalDexFileBytes(klass_index, AllocateOrGetOriginalDexFileBytes());
880 if (holder->GetOriginalDexFileBytes(klass_index) == nullptr) {
881 driver_->self_->AssertPendingOOMException();
882 driver_->self_->ClearException();
883 RecordFailure(ERR(OUT_OF_MEMORY), "Unable to allocate array for original dex file");
884 return false;
885 }
886 return true;
887}
888
Alex Light0e692732017-01-10 15:00:05 -0800889bool Redefiner::CheckAllRedefinitionAreValid() {
890 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
891 if (!redef.CheckRedefinitionIsValid()) {
892 return false;
893 }
894 }
895 return true;
896}
897
898bool Redefiner::EnsureAllClassAllocationsFinished() {
899 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
900 if (!redef.EnsureClassAllocationsFinished()) {
901 return false;
902 }
903 }
904 return true;
905}
906
907bool Redefiner::FinishAllRemainingAllocations(RedefinitionDataHolder& holder) {
908 int32_t cnt = 0;
Alex Light0e692732017-01-10 15:00:05 -0800909 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
Alex Light0e692732017-01-10 15:00:05 -0800910 // Allocate the data this redefinition requires.
Alex Lighta7e38d82017-01-19 14:57:28 -0800911 if (!redef.FinishRemainingAllocations(cnt, &holder)) {
Alex Light0e692732017-01-10 15:00:05 -0800912 return false;
913 }
Alex Light0e692732017-01-10 15:00:05 -0800914 cnt++;
915 }
916 return true;
917}
918
919void Redefiner::ClassRedefinition::ReleaseDexFile() {
920 dex_file_.release();
921}
922
923void Redefiner::ReleaseAllDexFiles() {
924 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
925 redef.ReleaseDexFile();
926 }
927}
928
Alex Lighta01de592016-11-15 10:43:06 -0800929jvmtiError Redefiner::Run() {
Alex Light0e692732017-01-10 15:00:05 -0800930 art::StackHandleScope<1> hs(self_);
931 // Allocate an array to hold onto all java temporary objects associated with this redefinition.
932 // We will let this be collected after the end of this function.
933 RedefinitionDataHolder holder(&hs, runtime_, self_, redefinitions_.size());
934 if (holder.IsNull()) {
935 self_->AssertPendingOOMException();
936 self_->ClearException();
937 RecordFailure(ERR(OUT_OF_MEMORY), "Could not allocate storage for temporaries");
938 return result_;
939 }
940
Alex Lighta01de592016-11-15 10:43:06 -0800941 // First we just allocate the ClassExt and its fields that we need. These can be updated
942 // atomically without any issues (since we allocate the map arrays as empty) so we don't bother
943 // doing a try loop. The other allocations we need to ensure that nothing has changed in the time
944 // between allocating them and pausing all threads before we can update them so we need to do a
945 // try loop.
Alex Light0e692732017-01-10 15:00:05 -0800946 if (!CheckAllRedefinitionAreValid() ||
947 !EnsureAllClassAllocationsFinished() ||
948 !FinishAllRemainingAllocations(holder)) {
Alex Lighta01de592016-11-15 10:43:06 -0800949 // TODO Null out the ClassExt fields we allocated (if possible, might be racing with another
950 // redefineclass call which made it even bigger. Leak shouldn't be huge (2x array of size
Alex Light0e692732017-01-10 15:00:05 -0800951 // declared_methods_.length) but would be good to get rid of. All other allocations should be
952 // cleaned up by the GC eventually.
Alex Lighta01de592016-11-15 10:43:06 -0800953 return result_;
954 }
Alex Light7916f202017-01-27 09:00:15 -0800955 int32_t counter = 0;
956 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
957 if (holder.GetSourceClassLoader(counter) == nullptr) {
958 runtime_->GetClassLinker()->AppendToBootClassPath(self_, redef.GetDexFile());
959 }
960 counter++;
961 }
Alex Light6abd5392017-01-05 17:53:00 -0800962 // Disable GC and wait for it to be done if we are a moving GC. This is fine since we are done
963 // allocating so no deadlocks.
964 art::gc::Heap* heap = runtime_->GetHeap();
965 if (heap->IsGcConcurrentAndMoving()) {
966 // GC moving objects can cause deadlocks as we are deoptimizing the stack.
967 heap->IncrementDisableMovingGC(self_);
968 }
Alex Lighta01de592016-11-15 10:43:06 -0800969 // Do transition to final suspension
970 // TODO We might want to give this its own suspended state!
971 // TODO This isn't right. We need to change state without any chance of suspend ideally!
972 self_->TransitionFromRunnableToSuspended(art::ThreadState::kNative);
973 runtime_->GetThreadList()->SuspendAll(
Alex Light0e692732017-01-10 15:00:05 -0800974 "Final installation of redefined Classes!", /*long_suspend*/true);
Alex Lightdba61482016-12-21 08:20:29 -0800975 // TODO We need to invalidate all breakpoints in the redefined class with the debugger.
976 // TODO We need to deal with any instrumentation/debugger deoptimized_methods_.
977 // TODO We need to update all debugger MethodIDs so they note the method they point to is
978 // obsolete or implement some other well defined semantics.
979 // TODO We need to decide on & implement semantics for JNI jmethodids when we redefine methods.
Alex Light7916f202017-01-27 09:00:15 -0800980 counter = 0;
Alex Light0e692732017-01-10 15:00:05 -0800981 for (Redefiner::ClassRedefinition& redef : redefinitions_) {
Alex Lighteb98b082017-01-25 13:02:32 -0800982 art::ScopedAssertNoThreadSuspension nts("Updating runtime objects for redefinition");
Alex Light7916f202017-01-27 09:00:15 -0800983 if (holder.GetSourceClassLoader(counter) != nullptr) {
984 ClassLoaderHelper::UpdateJavaDexFile(holder.GetJavaDexFile(counter),
985 holder.GetNewDexFileCookie(counter));
986 }
987 art::mirror::Class* klass = holder.GetMirrorClass(counter);
Alex Light0e692732017-01-10 15:00:05 -0800988 // TODO Rewrite so we don't do a stack walk for each and every class.
989 redef.FindAndAllocateObsoleteMethods(klass);
Alex Light7916f202017-01-27 09:00:15 -0800990 redef.UpdateClass(klass, holder.GetNewDexCache(counter),
991 holder.GetOriginalDexFileBytes(counter));
992 counter++;
Alex Light0e692732017-01-10 15:00:05 -0800993 }
Alex Lightdba61482016-12-21 08:20:29 -0800994 // TODO Verify the new Class.
Alex Lightdba61482016-12-21 08:20:29 -0800995 // TODO Shrink the obsolete method maps if possible?
996 // TODO find appropriate class loader.
Alex Lighta01de592016-11-15 10:43:06 -0800997 // TODO Put this into a scoped thing.
998 runtime_->GetThreadList()->ResumeAll();
999 // Get back shared mutator lock as expected for return.
1000 self_->TransitionFromSuspendedToRunnable();
Alex Light0e692732017-01-10 15:00:05 -08001001 // TODO Do the dex_file release at a more reasonable place. This works but it muddles who really
1002 // owns the DexFile and when ownership is transferred.
1003 ReleaseAllDexFiles();
Alex Light6abd5392017-01-05 17:53:00 -08001004 if (heap->IsGcConcurrentAndMoving()) {
1005 heap->DecrementDisableMovingGC(self_);
1006 }
Alex Lighta01de592016-11-15 10:43:06 -08001007 return OK;
1008}
1009
Alex Light0e692732017-01-10 15:00:05 -08001010void Redefiner::ClassRedefinition::UpdateMethods(art::ObjPtr<art::mirror::Class> mclass,
1011 art::ObjPtr<art::mirror::DexCache> new_dex_cache,
1012 const art::DexFile::ClassDef& class_def) {
1013 art::ClassLinker* linker = driver_->runtime_->GetClassLinker();
Alex Lighta01de592016-11-15 10:43:06 -08001014 art::PointerSize image_pointer_size = linker->GetImagePointerSize();
Alex Light200b9d72016-12-15 11:34:13 -08001015 const art::DexFile::TypeId& declaring_class_id = dex_file_->GetTypeId(class_def.class_idx_);
Alex Lighta01de592016-11-15 10:43:06 -08001016 const art::DexFile& old_dex_file = mclass->GetDexFile();
Alex Light200b9d72016-12-15 11:34:13 -08001017 // Update methods.
Alex Lighta01de592016-11-15 10:43:06 -08001018 for (art::ArtMethod& method : mclass->GetMethods(image_pointer_size)) {
1019 const art::DexFile::StringId* new_name_id = dex_file_->FindStringId(method.GetName());
1020 art::dex::TypeIndex method_return_idx =
1021 dex_file_->GetIndexForTypeId(*dex_file_->FindTypeId(method.GetReturnTypeDescriptor()));
1022 const auto* old_type_list = method.GetParameterTypeList();
1023 std::vector<art::dex::TypeIndex> new_type_list;
1024 for (uint32_t i = 0; old_type_list != nullptr && i < old_type_list->Size(); i++) {
1025 new_type_list.push_back(
1026 dex_file_->GetIndexForTypeId(
1027 *dex_file_->FindTypeId(
1028 old_dex_file.GetTypeDescriptor(
1029 old_dex_file.GetTypeId(
1030 old_type_list->GetTypeItem(i).type_idx_)))));
1031 }
1032 const art::DexFile::ProtoId* proto_id = dex_file_->FindProtoId(method_return_idx,
1033 new_type_list);
Nicolas Geoffrayf6abcda2016-12-21 09:26:18 +00001034 // TODO Return false, cleanup.
Alex Lightdba61482016-12-21 08:20:29 -08001035 CHECK(proto_id != nullptr || old_type_list == nullptr);
Alex Lighta01de592016-11-15 10:43:06 -08001036 const art::DexFile::MethodId* method_id = dex_file_->FindMethodId(declaring_class_id,
1037 *new_name_id,
1038 *proto_id);
Nicolas Geoffrayf6abcda2016-12-21 09:26:18 +00001039 // TODO Return false, cleanup.
Alex Lightdba61482016-12-21 08:20:29 -08001040 CHECK(method_id != nullptr);
Alex Lighta01de592016-11-15 10:43:06 -08001041 uint32_t dex_method_idx = dex_file_->GetIndexForMethodId(*method_id);
1042 method.SetDexMethodIndex(dex_method_idx);
1043 linker->SetEntryPointsToInterpreter(&method);
Alex Light200b9d72016-12-15 11:34:13 -08001044 method.SetCodeItemOffset(dex_file_->FindCodeItemOffset(class_def, dex_method_idx));
Alex Lighta01de592016-11-15 10:43:06 -08001045 method.SetDexCacheResolvedMethods(new_dex_cache->GetResolvedMethods(), image_pointer_size);
Alex Lightdba61482016-12-21 08:20:29 -08001046 // Notify the jit that this method is redefined.
Alex Light0e692732017-01-10 15:00:05 -08001047 art::jit::Jit* jit = driver_->runtime_->GetJit();
Alex Lightdba61482016-12-21 08:20:29 -08001048 if (jit != nullptr) {
1049 jit->GetCodeCache()->NotifyMethodRedefined(&method);
1050 }
Alex Lighta01de592016-11-15 10:43:06 -08001051 }
Alex Light200b9d72016-12-15 11:34:13 -08001052}
1053
Alex Light0e692732017-01-10 15:00:05 -08001054void Redefiner::ClassRedefinition::UpdateFields(art::ObjPtr<art::mirror::Class> mclass) {
Alex Light200b9d72016-12-15 11:34:13 -08001055 // TODO The IFields & SFields pointers should be combined like the methods_ arrays were.
1056 for (auto fields_iter : {mclass->GetIFields(), mclass->GetSFields()}) {
1057 for (art::ArtField& field : fields_iter) {
1058 std::string declaring_class_name;
1059 const art::DexFile::TypeId* new_declaring_id =
1060 dex_file_->FindTypeId(field.GetDeclaringClass()->GetDescriptor(&declaring_class_name));
1061 const art::DexFile::StringId* new_name_id = dex_file_->FindStringId(field.GetName());
1062 const art::DexFile::TypeId* new_type_id = dex_file_->FindTypeId(field.GetTypeDescriptor());
1063 // TODO Handle error, cleanup.
1064 CHECK(new_name_id != nullptr && new_type_id != nullptr && new_declaring_id != nullptr);
1065 const art::DexFile::FieldId* new_field_id =
1066 dex_file_->FindFieldId(*new_declaring_id, *new_name_id, *new_type_id);
1067 CHECK(new_field_id != nullptr);
1068 // We only need to update the index since the other data in the ArtField cannot be updated.
1069 field.SetDexFieldIndex(dex_file_->GetIndexForFieldId(*new_field_id));
1070 }
1071 }
Alex Light200b9d72016-12-15 11:34:13 -08001072}
1073
1074// Performs updates to class that will allow us to verify it.
Alex Lighta7e38d82017-01-19 14:57:28 -08001075void Redefiner::ClassRedefinition::UpdateClass(
1076 art::ObjPtr<art::mirror::Class> mclass,
1077 art::ObjPtr<art::mirror::DexCache> new_dex_cache,
1078 art::ObjPtr<art::mirror::ByteArray> original_dex_file) {
Alex Light6ac57502017-01-19 15:05:06 -08001079 DCHECK_EQ(dex_file_->NumClassDefs(), 1u);
1080 const art::DexFile::ClassDef& class_def = dex_file_->GetClassDef(0);
1081 UpdateMethods(mclass, new_dex_cache, class_def);
Alex Light007ada22017-01-10 13:33:56 -08001082 UpdateFields(mclass);
Alex Light200b9d72016-12-15 11:34:13 -08001083
Alex Lighta01de592016-11-15 10:43:06 -08001084 // Update the class fields.
1085 // Need to update class last since the ArtMethod gets its DexFile from the class (which is needed
1086 // to call GetReturnTypeDescriptor and GetParameterTypeList above).
1087 mclass->SetDexCache(new_dex_cache.Ptr());
Alex Light6ac57502017-01-19 15:05:06 -08001088 mclass->SetDexClassDefIndex(dex_file_->GetIndexForClassDef(class_def));
Alex Light0e692732017-01-10 15:00:05 -08001089 mclass->SetDexTypeIndex(dex_file_->GetIndexForTypeId(*dex_file_->FindTypeId(class_sig_.c_str())));
Alex Lighta7e38d82017-01-19 14:57:28 -08001090 art::ObjPtr<art::mirror::ClassExt> ext(mclass->GetExtData());
1091 CHECK(!ext.IsNull());
1092 ext->SetOriginalDexFileBytes(original_dex_file);
Alex Lighta01de592016-11-15 10:43:06 -08001093}
1094
Alex Lighta01de592016-11-15 10:43:06 -08001095// This function does all (java) allocations we need to do for the Class being redefined.
1096// TODO Change this name maybe?
Alex Light0e692732017-01-10 15:00:05 -08001097bool Redefiner::ClassRedefinition::EnsureClassAllocationsFinished() {
1098 art::StackHandleScope<2> hs(driver_->self_);
1099 art::Handle<art::mirror::Class> klass(hs.NewHandle(
1100 driver_->self_->DecodeJObject(klass_)->AsClass()));
Alex Lighta01de592016-11-15 10:43:06 -08001101 if (klass.Get() == nullptr) {
1102 RecordFailure(ERR(INVALID_CLASS), "Unable to decode class argument!");
1103 return false;
1104 }
1105 // Allocate the classExt
Alex Light0e692732017-01-10 15:00:05 -08001106 art::Handle<art::mirror::ClassExt> ext(hs.NewHandle(klass->EnsureExtDataPresent(driver_->self_)));
Alex Lighta01de592016-11-15 10:43:06 -08001107 if (ext.Get() == nullptr) {
1108 // No memory. Clear exception (it's not useful) and return error.
1109 // TODO This doesn't need to be fatal. We could just not support obsolete methods after hitting
1110 // this case.
Alex Light0e692732017-01-10 15:00:05 -08001111 driver_->self_->AssertPendingOOMException();
1112 driver_->self_->ClearException();
Alex Lighta01de592016-11-15 10:43:06 -08001113 RecordFailure(ERR(OUT_OF_MEMORY), "Could not allocate ClassExt");
1114 return false;
1115 }
1116 // Allocate the 2 arrays that make up the obsolete methods map. Since the contents of the arrays
1117 // are only modified when all threads (other than the modifying one) are suspended we don't need
1118 // to worry about missing the unsyncronized writes to the array. We do synchronize when setting it
1119 // however, since that can happen at any time.
1120 // TODO Clear these after we walk the stacks in order to free them in the (likely?) event there
1121 // are no obsolete methods.
1122 {
Alex Light0e692732017-01-10 15:00:05 -08001123 art::ObjectLock<art::mirror::ClassExt> lock(driver_->self_, ext);
Alex Lighta01de592016-11-15 10:43:06 -08001124 if (!ext->ExtendObsoleteArrays(
Alex Light0e692732017-01-10 15:00:05 -08001125 driver_->self_, klass->GetDeclaredMethodsSlice(art::kRuntimePointerSize).size())) {
Alex Lighta01de592016-11-15 10:43:06 -08001126 // OOM. Clear exception and return error.
Alex Light0e692732017-01-10 15:00:05 -08001127 driver_->self_->AssertPendingOOMException();
1128 driver_->self_->ClearException();
Alex Lighta01de592016-11-15 10:43:06 -08001129 RecordFailure(ERR(OUT_OF_MEMORY), "Unable to allocate/extend obsolete methods map");
1130 return false;
1131 }
1132 }
1133 return true;
1134}
1135
1136} // namespace openjdkjvmti