1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #include "cha.h"
18 
19 #include "art_method-inl.h"
20 #include "base/logging.h"  // For VLOG
21 #include "base/mutex.h"
22 #include "jit/jit.h"
23 #include "jit/jit_code_cache.h"
24 #include "linear_alloc.h"
25 #include "mirror/class_loader.h"
26 #include "runtime.h"
27 #include "scoped_thread_state_change-inl.h"
28 #include "stack.h"
29 #include "thread.h"
30 #include "thread_list.h"
31 #include "thread_pool.h"
32 
33 namespace art HIDDEN {
34 
AddDependency(ArtMethod * method,ArtMethod * dependent_method,OatQuickMethodHeader * dependent_header)35 void ClassHierarchyAnalysis::AddDependency(ArtMethod* method,
36                                            ArtMethod* dependent_method,
37                                            OatQuickMethodHeader* dependent_header) {
38   const auto it = cha_dependency_map_.insert(
39       decltype(cha_dependency_map_)::value_type(method, ListOfDependentPairs())).first;
40   it->second.push_back({dependent_method, dependent_header});
41 }
42 
43 static const ClassHierarchyAnalysis::ListOfDependentPairs s_empty_vector;
44 
GetDependents(ArtMethod * method)45 const ClassHierarchyAnalysis::ListOfDependentPairs& ClassHierarchyAnalysis::GetDependents(
46     ArtMethod* method) {
47   auto it = cha_dependency_map_.find(method);
48   if (it != cha_dependency_map_.end()) {
49     return it->second;
50   }
51   return s_empty_vector;
52 }
53 
RemoveAllDependenciesFor(ArtMethod * method)54 void ClassHierarchyAnalysis::RemoveAllDependenciesFor(ArtMethod* method) {
55   cha_dependency_map_.erase(method);
56 }
57 
RemoveDependentsWithMethodHeaders(const std::unordered_set<OatQuickMethodHeader * > & method_headers)58 void ClassHierarchyAnalysis::RemoveDependentsWithMethodHeaders(
59     const std::unordered_set<OatQuickMethodHeader*>& method_headers) {
60   // Iterate through all entries in the dependency map and remove any entry that
61   // contains one of those in method_headers.
62   for (auto map_it = cha_dependency_map_.begin(); map_it != cha_dependency_map_.end(); ) {
63     ListOfDependentPairs& dependents = map_it->second;
64     dependents.erase(
65         std::remove_if(
66             dependents.begin(),
67             dependents.end(),
68             [&method_headers](MethodAndMethodHeaderPair& dependent) {
69               return method_headers.find(dependent.second) != method_headers.end();
70             }),
71         dependents.end());
72 
73     // Remove the map entry if there are no more dependents.
74     if (dependents.empty()) {
75       map_it = cha_dependency_map_.erase(map_it);
76     } else {
77       map_it++;
78     }
79   }
80 }
81 
ResetSingleImplementationInHierarchy(ObjPtr<mirror::Class> klass,const LinearAlloc * alloc,const PointerSize pointer_size) const82 void ClassHierarchyAnalysis::ResetSingleImplementationInHierarchy(ObjPtr<mirror::Class> klass,
83                                                                   const LinearAlloc* alloc,
84                                                                   const PointerSize pointer_size)
85                                                                   const {
86   // Presumably called from some sort of class visitor, no null pointers expected.
87   DCHECK(klass != nullptr);
88   DCHECK(alloc != nullptr);
89 
90   // Skip interfaces since they cannot provide SingleImplementations to work with.
91   if (klass->IsInterface()) {
92     return;
93   }
94 
95   // This method is called while visiting classes in the class table of a class loader.
96   // That means, some 'klass'es can belong to other classloaders. Argument 'alloc'
97   // allows to explicitly indicate a classloader, which is going to be deleted.
98   // Filter out classes, that do not belong to it.
99   if (!alloc->ContainsUnsafe(klass->GetMethodsPtr())) {
100     return;
101   }
102 
103   // CHA analysis is only applied to resolved classes.
104   if (!klass->IsResolved()) {
105     return;
106   }
107 
108   ObjPtr<mirror::Class> super = klass->GetSuperClass<kDefaultVerifyFlags, kWithoutReadBarrier>();
109 
110   // Skip Object class and primitive classes.
111   if (super == nullptr) {
112     return;
113   }
114 
115   // The class is going to be deleted. Iterate over the virtual methods of its superclasses to see
116   // if they have SingleImplementations methods defined by 'klass'.
117   // Skip all virtual methods that do not override methods from super class since they cannot be
118   // SingleImplementations for anything.
119   int32_t vtbl_size = super->GetVTableLength<kDefaultVerifyFlags>();
120   ObjPtr<mirror::ClassLoader> loader =
121       klass->GetClassLoader<kDefaultVerifyFlags, kWithoutReadBarrier>();
122   for (int vtbl_index = 0; vtbl_index < vtbl_size; ++vtbl_index) {
123     ArtMethod* method =
124         klass->GetVTableEntry<kDefaultVerifyFlags, kWithoutReadBarrier>(vtbl_index, pointer_size);
125     if (!alloc->ContainsUnsafe(method)) {
126       continue;
127     }
128 
129     // Find all occurrences of virtual methods in parents' SingleImplementations fields
130     // and reset them.
131     // No need to reset SingleImplementations for the method itself (it will be cleared anyways),
132     // so start with a superclass and move up looking into a corresponding vtbl slot.
133     for (ObjPtr<mirror::Class> super_it = super;
134          super_it != nullptr &&
135              super_it->GetVTableLength<kDefaultVerifyFlags>() > vtbl_index;
136          super_it = super_it->GetSuperClass<kDefaultVerifyFlags, kWithoutReadBarrier>()) {
137       // Skip superclasses that are also going to be unloaded.
138       ObjPtr<mirror::ClassLoader> super_loader = super_it->
139           GetClassLoader<kDefaultVerifyFlags, kWithoutReadBarrier>();
140       if (super_loader == loader) {
141         continue;
142       }
143 
144       ArtMethod* super_method = super_it->
145           GetVTableEntry<kDefaultVerifyFlags, kWithoutReadBarrier>(vtbl_index, pointer_size);
146       if (super_method->IsAbstract() &&
147           super_method->HasSingleImplementation() &&
148           super_method->GetSingleImplementation(pointer_size) == method) {
149         // Do like there was no single implementation defined previously
150         // for this method of the superclass.
151         super_method->SetSingleImplementation(nullptr, pointer_size);
152       } else {
153         // No related SingleImplementations could possibly be found any further.
154         DCHECK(!super_method->HasSingleImplementation());
155         break;
156       }
157     }
158   }
159 
160   // Check all possible interface methods too.
161   ObjPtr<mirror::IfTable> iftable = klass->GetIfTable<kDefaultVerifyFlags, kWithoutReadBarrier>();
162   const size_t ifcount = klass->GetIfTableCount<kDefaultVerifyFlags>();
163   for (size_t i = 0; i < ifcount; ++i) {
164     ObjPtr<mirror::Class> interface =
165         iftable->GetInterface<kDefaultVerifyFlags, kWithoutReadBarrier>(i);
166     for (size_t j = 0,
167          count = iftable->GetMethodArrayCount<kDefaultVerifyFlags, kWithoutReadBarrier>(i);
168          j < count;
169          ++j) {
170       ArtMethod* method = interface->GetVirtualMethod(j, pointer_size);
171       if (method->HasSingleImplementation() &&
172           alloc->ContainsUnsafe(method->GetSingleImplementation(pointer_size)) &&
173           !method->IsDefault()) {
174         // Do like there was no single implementation defined previously for this method.
175         method->SetSingleImplementation(nullptr, pointer_size);
176       }
177     }
178   }
179 }
180 
181 // This stack visitor walks the stack and for compiled code with certain method
182 // headers, sets the should_deoptimize flag on stack to 1.
183 // TODO: also set the register value to 1 when should_deoptimize is allocated in
184 // a register.
185 class CHAStackVisitor final  : public StackVisitor {
186  public:
CHAStackVisitor(Thread * thread_in,Context * context,const std::unordered_set<OatQuickMethodHeader * > & method_headers)187   CHAStackVisitor(Thread* thread_in,
188                   Context* context,
189                   const std::unordered_set<OatQuickMethodHeader*>& method_headers)
190       : StackVisitor(thread_in, context, StackVisitor::StackWalkKind::kSkipInlinedFrames),
191         method_headers_(method_headers) {
192   }
193 
VisitFrame()194   bool VisitFrame() override REQUIRES_SHARED(Locks::mutator_lock_) {
195     ArtMethod* method = GetMethod();
196     // Avoid types of methods that do not have an oat quick method header.
197     if (method == nullptr ||
198         method->IsRuntimeMethod() ||
199         method->IsNative() ||
200         method->IsProxyMethod()) {
201       return true;
202     }
203     if (GetCurrentQuickFrame() == nullptr) {
204       // Not compiled code.
205       return true;
206     }
207     // Method may have multiple versions of compiled code. Check
208     // the method header to see if it has should_deoptimize flag.
209     const OatQuickMethodHeader* method_header = GetCurrentOatQuickMethodHeader();
210     DCHECK(method_header != nullptr);
211     if (!method_header->HasShouldDeoptimizeFlag()) {
212       // This compiled version doesn't have should_deoptimize flag. Skip.
213       return true;
214     }
215     auto it = std::find(method_headers_.begin(), method_headers_.end(), method_header);
216     if (it == method_headers_.end()) {
217       // Not in the list of method headers that should be deoptimized.
218       return true;
219     }
220 
221     // The compiled code on stack is not valid anymore. Need to deoptimize.
222     SetShouldDeoptimizeFlag(DeoptimizeFlagValue::kCHA);
223 
224     return true;
225   }
226 
227  private:
228   // Set of method headers for compiled code that should be deoptimized.
229   const std::unordered_set<OatQuickMethodHeader*>& method_headers_;
230 
231   DISALLOW_COPY_AND_ASSIGN(CHAStackVisitor);
232 };
233 
234 class CHACheckpoint final : public Closure {
235  public:
CHACheckpoint(const std::unordered_set<OatQuickMethodHeader * > & method_headers)236   explicit CHACheckpoint(const std::unordered_set<OatQuickMethodHeader*>& method_headers)
237       : barrier_(0),
238         method_headers_(method_headers) {}
239 
Run(Thread * thread)240   void Run(Thread* thread) override REQUIRES_SHARED(Locks::mutator_lock_) {
241     // Note thread and self may not be equal if thread was already suspended at
242     // the point of the request.
243     Thread* self = Thread::Current();
244     CHAStackVisitor visitor(thread, nullptr, method_headers_);
245     visitor.WalkStack();
246     barrier_.Pass(self);
247   }
248 
WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint)249   void WaitForThreadsToRunThroughCheckpoint(size_t threads_running_checkpoint) {
250     Thread* self = Thread::Current();
251     ScopedThreadStateChange tsc(self, ThreadState::kWaitingForCheckPointsToRun);
252     barrier_.Increment(self, threads_running_checkpoint);
253   }
254 
255  private:
256   // The barrier to be passed through and for the requestor to wait upon.
257   Barrier barrier_;
258   // List of method headers for invalidated compiled code.
259   const std::unordered_set<OatQuickMethodHeader*>& method_headers_;
260 
261   DISALLOW_COPY_AND_ASSIGN(CHACheckpoint);
262 };
263 
264 
VerifyNonSingleImplementation(ObjPtr<mirror::Class> verify_class,uint16_t verify_index,ArtMethod * excluded_method)265 static void VerifyNonSingleImplementation(ObjPtr<mirror::Class> verify_class,
266                                           uint16_t verify_index,
267                                           ArtMethod* excluded_method)
268     REQUIRES_SHARED(Locks::mutator_lock_) {
269   if (!kIsDebugBuild) {
270     return;
271   }
272 
273   // Grab cha_lock_ to make sure all single-implementation updates are seen.
274   MutexLock cha_mu(Thread::Current(), *Locks::cha_lock_);
275 
276   PointerSize image_pointer_size =
277       Runtime::Current()->GetClassLinker()->GetImagePointerSize();
278 
279   ObjPtr<mirror::Class> input_verify_class = verify_class;
280 
281   while (verify_class != nullptr) {
282     if (verify_index >= verify_class->GetVTableLength()) {
283       return;
284     }
285     ArtMethod* verify_method = verify_class->GetVTableEntry(verify_index, image_pointer_size);
286     if (verify_method != excluded_method) {
287       auto construct_parent_chain = [](ObjPtr<mirror::Class> failed, ObjPtr<mirror::Class> in)
288           REQUIRES_SHARED(Locks::mutator_lock_) {
289         std::string tmp = in->PrettyClass();
290         while (in != failed) {
291           in = in->GetSuperClass();
292           tmp += "->" + in->PrettyClass();
293         }
294         return tmp;
295       };
296       DCHECK(!verify_method->HasSingleImplementation())
297           << "class: " << verify_class->PrettyClass()
298           << " verify_method: " << verify_method->PrettyMethod(true)
299           << " (" << construct_parent_chain(verify_class, input_verify_class) << ")"
300           << " excluded_method: " << ArtMethod::PrettyMethod(excluded_method);
301       if (verify_method->IsAbstract()) {
302         DCHECK(verify_method->GetSingleImplementation(image_pointer_size) == nullptr);
303       }
304     }
305     verify_class = verify_class->GetSuperClass();
306   }
307 }
308 
CheckVirtualMethodSingleImplementationInfo(Handle<mirror::Class> klass,ArtMethod * virtual_method,ArtMethod * method_in_super,std::unordered_set<ArtMethod * > & invalidated_single_impl_methods,PointerSize pointer_size)309 void ClassHierarchyAnalysis::CheckVirtualMethodSingleImplementationInfo(
310     Handle<mirror::Class> klass,
311     ArtMethod* virtual_method,
312     ArtMethod* method_in_super,
313     std::unordered_set<ArtMethod*>& invalidated_single_impl_methods,
314     PointerSize pointer_size) {
315   // TODO: if klass is not instantiable, virtual_method isn't invocable yet so
316   // even if it overrides, it doesn't invalidate single-implementation
317   // assumption.
318 
319   DCHECK_IMPLIES(virtual_method == method_in_super, virtual_method->IsAbstract());
320   DCHECK(method_in_super->GetDeclaringClass()->IsResolved()) << "class isn't resolved";
321   // If virtual_method doesn't come from a default interface method, it should
322   // be supplied by klass.
323   DCHECK(virtual_method == method_in_super ||
324          virtual_method->IsCopied() ||
325          virtual_method->GetDeclaringClass() == klass.Get());
326 
327   // To make updating single-implementation flags simple, we always maintain the following
328   // invariant:
329   // Say all virtual methods in the same vtable slot, starting from the bottom child class
330   // to super classes, is a sequence of unique methods m3, m2, m1, ... (after removing duplicate
331   // methods for inherited methods).
332   // For example for the following class hierarchy,
333   //   class A { void m() { ... } }
334   //   class B extends A { void m() { ... } }
335   //   class C extends B {}
336   //   class D extends C { void m() { ... } }
337   // the sequence is D.m(), B.m(), A.m().
338   // The single-implementation status for that sequence of methods begin with one or two true's,
339   // then become all falses. The only case where two true's are possible is for one abstract
340   // method m and one non-abstract method mImpl that overrides method m.
341   // With the invariant, when linking in a new class, we only need to at most update one or
342   // two methods in the sequence for their single-implementation status, in order to maintain
343   // the invariant.
344 
345   if (!method_in_super->HasSingleImplementation()) {
346     // method_in_super already has multiple implementations. All methods in the
347     // same vtable slots in its super classes should have
348     // non-single-implementation already.
349     VerifyNonSingleImplementation(klass->GetSuperClass()->GetSuperClass(),
350                                   method_in_super->GetMethodIndex(),
351                                   /* excluded_method= */ nullptr);
352     return;
353   }
354 
355   uint16_t method_index = method_in_super->GetMethodIndex();
356   if (method_in_super->IsAbstract()) {
357     // An abstract method should have made all methods in the same vtable
358     // slot above it in the class hierarchy having non-single-implementation.
359     VerifyNonSingleImplementation(klass->GetSuperClass()->GetSuperClass(),
360                                   method_index,
361                                   method_in_super);
362 
363     if (virtual_method->IsAbstract()) {
364       // SUPER: abstract, VIRTUAL: abstract.
365       if (method_in_super == virtual_method) {
366         DCHECK(klass->IsInstantiable());
367         // An instantiable subclass hasn't provided a concrete implementation of
368         // the abstract method. Invoking method_in_super may throw AbstractMethodError.
369         // This is an uncommon case, so we simply treat method_in_super as not
370         // having single-implementation.
371         invalidated_single_impl_methods.insert(method_in_super);
372         return;
373       } else {
374         // One abstract method overrides another abstract method. This is an uncommon
375         // case. We simply treat method_in_super as not having single-implementation.
376         invalidated_single_impl_methods.insert(method_in_super);
377         return;
378       }
379     } else {
380       // SUPER: abstract, VIRTUAL: non-abstract.
381       // A non-abstract method overrides an abstract method.
382       if (!virtual_method->IsDefaultConflicting() &&
383           method_in_super->GetSingleImplementation(pointer_size) == nullptr) {
384         // Abstract method_in_super has no implementation yet.
385         // We need to grab cha_lock_ since there may be multiple class linking
386         // going on that can check/modify the single-implementation flag/method
387         // of method_in_super.
388         MutexLock cha_mu(Thread::Current(), *Locks::cha_lock_);
389         if (!method_in_super->HasSingleImplementation()) {
390           return;
391         }
392         if (method_in_super->GetSingleImplementation(pointer_size) == nullptr) {
393           // virtual_method becomes the first implementation for method_in_super.
394           method_in_super->SetSingleImplementation(virtual_method, pointer_size);
395           // Keep method_in_super's single-implementation status.
396           return;
397         }
398         // Fall through to invalidate method_in_super's single-implementation status.
399       }
400       // Abstract method_in_super already got one implementation.
401       // Invalidate method_in_super's single-implementation status.
402       invalidated_single_impl_methods.insert(method_in_super);
403       return;
404     }
405   } else {
406     if (virtual_method->IsAbstract()) {
407       // SUPER: non-abstract, VIRTUAL: abstract.
408       // An abstract method overrides a non-abstract method. This is an uncommon
409       // case, we simply treat both methods as not having single-implementation.
410       invalidated_single_impl_methods.insert(virtual_method);
411       // Fall-through to handle invalidating method_in_super of its
412       // single-implementation status.
413     }
414 
415     // SUPER: non-abstract, VIRTUAL: non-abstract/abstract(fall-through from previous if).
416     // Invalidate method_in_super's single-implementation status.
417     invalidated_single_impl_methods.insert(method_in_super);
418 
419     // method_in_super might be the single-implementation of another abstract method,
420     // which should be also invalidated of its single-implementation status.
421     ObjPtr<mirror::Class> super_super = klass->GetSuperClass()->GetSuperClass();
422     while (super_super != nullptr &&
423            method_index < super_super->GetVTableLength()) {
424       ArtMethod* method_in_super_super = super_super->GetVTableEntry(method_index, pointer_size);
425       if (method_in_super_super != method_in_super) {
426         if (method_in_super_super->IsAbstract()) {
427           if (method_in_super_super->HasSingleImplementation()) {
428             // Invalidate method_in_super's single-implementation status.
429             invalidated_single_impl_methods.insert(method_in_super_super);
430             // No need to further traverse up the class hierarchy since if there
431             // are cases that one abstract method overrides another method, we
432             // should have made that method having non-single-implementation already.
433           } else {
434             // method_in_super_super is already non-single-implementation.
435             // No need to further traverse up the class hierarchy.
436           }
437         } else {
438           DCHECK(!method_in_super_super->HasSingleImplementation());
439           // No need to further traverse up the class hierarchy since two non-abstract
440           // methods (method_in_super and method_in_super_super) should have set all
441           // other methods (abstract or not) in the vtable slot to be non-single-implementation.
442         }
443 
444         VerifyNonSingleImplementation(super_super->GetSuperClass(),
445                                       method_index,
446                                       method_in_super_super);
447         // No need to go any further.
448         return;
449       } else {
450         super_super = super_super->GetSuperClass();
451       }
452     }
453   }
454 }
455 
CheckInterfaceMethodSingleImplementationInfo(Handle<mirror::Class> klass,ArtMethod * interface_method,ArtMethod * implementation_method,std::unordered_set<ArtMethod * > & invalidated_single_impl_methods,PointerSize pointer_size)456 void ClassHierarchyAnalysis::CheckInterfaceMethodSingleImplementationInfo(
457     Handle<mirror::Class> klass,
458     ArtMethod* interface_method,
459     ArtMethod* implementation_method,
460     std::unordered_set<ArtMethod*>& invalidated_single_impl_methods,
461     PointerSize pointer_size) {
462   DCHECK(klass->IsInstantiable());
463   DCHECK(interface_method->IsAbstract() || interface_method->IsDefault());
464 
465   if (!interface_method->HasSingleImplementation()) {
466     return;
467   }
468 
469   if (!implementation_method->IsInvokable()) {
470     DCHECK(implementation_method->IsAbstract() || implementation_method->IsDefaultConflicting());
471     // An instantiable class doesn't supply an implementation for interface_method,
472     // or has conflicting default method implementations. Invoking the interface method
473     // on the  class will throw AbstractMethodError or IncompatibleClassChangeError.
474     // (Note: The RI throws AME instead of ICCE for default conflict.) This is an uncommon
475     // case, so we simply treat interface_method as not having single-implementation.
476     invalidated_single_impl_methods.insert(interface_method);
477     return;
478   }
479 
480   // We need to grab cha_lock_ since there may be multiple class linking going
481   // on that can check/modify the single-implementation flag/method of
482   // interface_method.
483   MutexLock cha_mu(Thread::Current(), *Locks::cha_lock_);
484   // Do this check again after we grab cha_lock_.
485   if (!interface_method->HasSingleImplementation()) {
486     return;
487   }
488 
489   ArtMethod* single_impl = interface_method->GetSingleImplementation(pointer_size);
490   if (single_impl == nullptr) {
491     // implementation_method becomes the first implementation for
492     // interface_method.
493     interface_method->SetSingleImplementation(implementation_method, pointer_size);
494     // Keep interface_method's single-implementation status.
495     return;
496   }
497   DCHECK(single_impl->IsInvokable());
498   if ((single_impl->GetDeclaringClass() == implementation_method->GetDeclaringClass())) {
499     // Same implementation. Since implementation_method may be a copy of a default
500     // method, we need to check the declaring class for equality.
501     return;
502   }
503   // Another implementation for interface_method.
504   invalidated_single_impl_methods.insert(interface_method);
505 }
506 
InitSingleImplementationFlag(Handle<mirror::Class> klass,ArtMethod * method,PointerSize pointer_size)507 void ClassHierarchyAnalysis::InitSingleImplementationFlag(Handle<mirror::Class> klass,
508                                                           ArtMethod* method,
509                                                           PointerSize pointer_size) {
510   DCHECK(method->IsCopied() || method->GetDeclaringClass() == klass.Get());
511   if (klass->IsFinal() || method->IsFinal()) {
512     // Final classes or methods do not need CHA for devirtualization.
513     // This frees up modifier bits for intrinsics which currently are only
514     // used for static methods or methods of final classes.
515     return;
516   }
517   if (method->IsAbstract()) {
518     // single-implementation of abstract method shares the same field
519     // that's used for JNI function of native method. It's fine since a method
520     // cannot be both abstract and native.
521     DCHECK(!method->IsNative()) << "Abstract method cannot be native";
522 
523     if (method->GetDeclaringClass()->IsInstantiable()) {
524       // Rare case, but we do accept it (such as 800-smali/smali/b_26143249.smali).
525       // Do not attempt to devirtualize it.
526       method->SetHasSingleImplementation(false);
527       DCHECK(method->GetSingleImplementation(pointer_size) == nullptr);
528     } else {
529       // Abstract method starts with single-implementation flag set and null
530       // implementation method.
531       method->SetHasSingleImplementation(true);
532       DCHECK(!method->HasCodeItem()) << method->PrettyMethod();
533       DCHECK(method->GetSingleImplementation(pointer_size) == nullptr) << method->PrettyMethod();
534     }
535   // Default conflicting methods cannot be treated with single implementations,
536   // as we need to call them (and not inline them) in case of ICCE.
537   // See class_linker.cc:EnsureThrowsInvocationError.
538   } else if (!method->IsDefaultConflicting()) {
539     method->SetHasSingleImplementation(true);
540     // Single implementation of non-abstract method is itself.
541     DCHECK_EQ(method->GetSingleImplementation(pointer_size), method);
542   }
543 }
544 
UpdateAfterLoadingOf(Handle<mirror::Class> klass)545 void ClassHierarchyAnalysis::UpdateAfterLoadingOf(Handle<mirror::Class> klass) {
546   PointerSize image_pointer_size = Runtime::Current()->GetClassLinker()->GetImagePointerSize();
547   if (klass->IsInterface()) {
548     for (ArtMethod& method : klass->GetDeclaredVirtualMethods(image_pointer_size)) {
549       DCHECK(method.IsAbstract() || method.IsDefault());
550       InitSingleImplementationFlag(klass, &method, image_pointer_size);
551     }
552     return;
553   }
554 
555   ObjPtr<mirror::Class> super_class = klass->GetSuperClass();
556   if (super_class == nullptr) {
557     return;
558   }
559 
560   // Keeps track of all methods whose single-implementation assumption
561   // is invalidated by linking `klass`.
562   std::unordered_set<ArtMethod*> invalidated_single_impl_methods;
563 
564   // Do an entry-by-entry comparison of vtable contents with super's vtable.
565   for (int32_t i = 0; i < super_class->GetVTableLength(); ++i) {
566     ArtMethod* method = klass->GetVTableEntry(i, image_pointer_size);
567     ArtMethod* method_in_super = super_class->GetVTableEntry(i, image_pointer_size);
568     if (method == method_in_super) {
569       // vtable slot entry is inherited from super class.
570       if (method->IsAbstract() && klass->IsInstantiable()) {
571         // An instantiable class that inherits an abstract method is treated as
572         // supplying an implementation that throws AbstractMethodError.
573         CheckVirtualMethodSingleImplementationInfo(klass,
574                                                    method,
575                                                    method_in_super,
576                                                    invalidated_single_impl_methods,
577                                                    image_pointer_size);
578       }
579       continue;
580     }
581     InitSingleImplementationFlag(klass, method, image_pointer_size);
582     CheckVirtualMethodSingleImplementationInfo(klass,
583                                                method,
584                                                method_in_super,
585                                                invalidated_single_impl_methods,
586                                                image_pointer_size);
587   }
588   // For new virtual methods that don't override.
589   for (int32_t i = super_class->GetVTableLength(); i < klass->GetVTableLength(); ++i) {
590     ArtMethod* method = klass->GetVTableEntry(i, image_pointer_size);
591     InitSingleImplementationFlag(klass, method, image_pointer_size);
592   }
593 
594   if (klass->IsInstantiable()) {
595     ObjPtr<mirror::IfTable> iftable = klass->GetIfTable();
596     const size_t ifcount = klass->GetIfTableCount();
597     for (size_t i = 0; i < ifcount; ++i) {
598       ObjPtr<mirror::Class> interface = iftable->GetInterface(i);
599       for (size_t j = 0, count = iftable->GetMethodArrayCount(i); j < count; ++j) {
600         ArtMethod* interface_method = interface->GetVirtualMethod(j, image_pointer_size);
601         ObjPtr<mirror::PointerArray> method_array = iftable->GetMethodArray(i);
602         ArtMethod* implementation_method =
603             method_array->GetElementPtrSize<ArtMethod*>(j, image_pointer_size);
604         DCHECK(implementation_method != nullptr) << klass->PrettyClass();
605         CheckInterfaceMethodSingleImplementationInfo(klass,
606                                                      interface_method,
607                                                      implementation_method,
608                                                      invalidated_single_impl_methods,
609                                                      image_pointer_size);
610       }
611     }
612   }
613 
614   InvalidateSingleImplementationMethods(invalidated_single_impl_methods);
615 }
616 
InvalidateSingleImplementationMethods(std::unordered_set<ArtMethod * > & invalidated_single_impl_methods)617 void ClassHierarchyAnalysis::InvalidateSingleImplementationMethods(
618     std::unordered_set<ArtMethod*>& invalidated_single_impl_methods) {
619   if (!invalidated_single_impl_methods.empty()) {
620     Runtime* const runtime = Runtime::Current();
621     Thread *self = Thread::Current();
622     // Method headers for compiled code to be invalidated.
623     std::unordered_set<OatQuickMethodHeader*> dependent_method_headers;
624     PointerSize image_pointer_size =
625         Runtime::Current()->GetClassLinker()->GetImagePointerSize();
626 
627     {
628       // We do this under cha_lock_. Committing code also grabs this lock to
629       // make sure the code is only committed when all single-implementation
630       // assumptions are still true.
631       std::vector<std::pair<ArtMethod*, OatQuickMethodHeader*>> headers;
632       {
633         MutexLock cha_mu(self, *Locks::cha_lock_);
634         // Invalidate compiled methods that assume some virtual calls have only
635         // single implementations.
636         for (ArtMethod* invalidated : invalidated_single_impl_methods) {
637           if (!invalidated->HasSingleImplementation()) {
638             // It might have been invalidated already when other class linking is
639             // going on.
640             continue;
641           }
642           invalidated->SetHasSingleImplementation(false);
643           if (invalidated->IsAbstract()) {
644             // Clear the single implementation method.
645             invalidated->SetSingleImplementation(nullptr, image_pointer_size);
646           }
647 
648           if (runtime->IsAotCompiler()) {
649             // No need to invalidate any compiled code as the AotCompiler doesn't
650             // run any code.
651             continue;
652           }
653 
654           // Invalidate all dependents.
655           for (const auto& dependent : GetDependents(invalidated)) {
656             ArtMethod* method = dependent.first;;
657             OatQuickMethodHeader* method_header = dependent.second;
658             VLOG(class_linker) << "CHA invalidated compiled code for " << method->PrettyMethod();
659             DCHECK(runtime->UseJitCompilation());
660             // We need to call JitCodeCache::InvalidateCompiledCodeFor but we cannot do it here
661             // since it would run into problems with lock-ordering. We don't want to re-order the
662             // locks since that would make code-commit racy.
663             headers.push_back({method, method_header});
664             dependent_method_headers.insert(method_header);
665           }
666           RemoveAllDependenciesFor(invalidated);
667         }
668       }
669       // Since we are still loading the class that invalidated the code it's fine we have this after
670       // getting rid of the dependency. Any calls would need to be with the old version (since the
671       // new one isn't loaded yet) which still works fine. We will deoptimize just after this to
672       // ensure everything gets the new state.
673       jit::Jit* jit = Runtime::Current()->GetJit();
674       if (jit != nullptr) {
675         jit::JitCodeCache* code_cache = jit->GetCodeCache();
676         for (const auto& pair : headers) {
677           code_cache->InvalidateCompiledCodeFor(pair.first, pair.second);
678         }
679       }
680     }
681 
682     if (dependent_method_headers.empty()) {
683       return;
684     }
685     // Deoptimze compiled code on stack that should have been invalidated.
686     CHACheckpoint checkpoint(dependent_method_headers);
687     size_t threads_running_checkpoint = runtime->GetThreadList()->RunCheckpoint(&checkpoint);
688     if (threads_running_checkpoint != 0) {
689       checkpoint.WaitForThreadsToRunThroughCheckpoint(threads_running_checkpoint);
690     }
691   }
692 }
693 
RemoveDependenciesForLinearAlloc(Thread * self,const LinearAlloc * linear_alloc)694 void ClassHierarchyAnalysis::RemoveDependenciesForLinearAlloc(Thread* self,
695                                                               const LinearAlloc* linear_alloc) {
696   MutexLock mu(self, *Locks::cha_lock_);
697   for (auto it = cha_dependency_map_.begin(); it != cha_dependency_map_.end(); ) {
698     // Use unsafe to avoid locking since the allocator is going to be deleted.
699     if (linear_alloc->ContainsUnsafe(it->first)) {
700       // About to delete the ArtMethod, erase the entry from the map.
701       it = cha_dependency_map_.erase(it);
702     } else {
703       ++it;
704     }
705   }
706 }
707 
708 }  // namespace art
709