Tue, 05 Nov 2013 17:38:04 -0800
Merge
1 /*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #include "precompiled.hpp"
26 #include "classfile/bytecodeAssembler.hpp"
27 #include "classfile/defaultMethods.hpp"
28 #include "classfile/symbolTable.hpp"
29 #include "memory/allocation.hpp"
30 #include "memory/metadataFactory.hpp"
31 #include "memory/resourceArea.hpp"
32 #include "runtime/signature.hpp"
33 #include "runtime/thread.hpp"
34 #include "oops/instanceKlass.hpp"
35 #include "oops/klass.hpp"
36 #include "oops/method.hpp"
37 #include "utilities/accessFlags.hpp"
38 #include "utilities/exceptions.hpp"
39 #include "utilities/ostream.hpp"
40 #include "utilities/pair.hpp"
41 #include "utilities/resourceHash.hpp"
43 typedef enum { QUALIFIED, DISQUALIFIED } QualifiedState;
45 // Because we use an iterative algorithm when iterating over the type
46 // hierarchy, we can't use traditional scoped objects which automatically do
47 // cleanup in the destructor when the scope is exited. PseudoScope (and
48 // PseudoScopeMark) provides a similar functionality, but for when you want a
49 // scoped object in non-stack memory (such as in resource memory, as we do
50 // here). You've just got to remember to call 'destroy()' on the scope when
51 // leaving it (and marks have to be explicitly added).
52 class PseudoScopeMark : public ResourceObj {
53 public:
54 virtual void destroy() = 0;
55 };
57 class PseudoScope : public ResourceObj {
58 private:
59 GrowableArray<PseudoScopeMark*> _marks;
60 public:
62 static PseudoScope* cast(void* data) {
63 return static_cast<PseudoScope*>(data);
64 }
66 void add_mark(PseudoScopeMark* psm) {
67 _marks.append(psm);
68 }
70 void destroy() {
71 for (int i = 0; i < _marks.length(); ++i) {
72 _marks.at(i)->destroy();
73 }
74 }
75 };
77 #ifndef PRODUCT
78 static void print_slot(outputStream* str, Symbol* name, Symbol* signature) {
79 ResourceMark rm;
80 str->print("%s%s", name->as_C_string(), signature->as_C_string());
81 }
83 static void print_method(outputStream* str, Method* mo, bool with_class=true) {
84 ResourceMark rm;
85 if (with_class) {
86 str->print("%s.", mo->klass_name()->as_C_string());
87 }
88 print_slot(str, mo->name(), mo->signature());
89 }
90 #endif // ndef PRODUCT
92 /**
93 * Perform a depth-first iteration over the class hierarchy, applying
94 * algorithmic logic as it goes.
95 *
96 * This class is one half of the inheritance hierarchy analysis mechanism.
97 * It is meant to be used in conjunction with another class, the algorithm,
98 * which is indicated by the ALGO template parameter. This class can be
99 * paired with any algorithm class that provides the required methods.
100 *
101 * This class contains all the mechanics for iterating over the class hierarchy
102 * starting at a particular root, without recursing (thus limiting stack growth
103 * from this point). It visits each superclass (if present) and superinterface
104 * in a depth-first manner, with callbacks to the ALGO class as each class is
105 * encountered (visit()), The algorithm can cut-off further exploration of a
106 * particular branch by returning 'false' from a visit() call.
107 *
108 * The ALGO class, must provide a visit() method, which each of which will be
109 * called once for each node in the inheritance tree during the iteration. In
110 * addition, it can provide a memory block via new_node_data(InstanceKlass*),
111 * which it can use for node-specific storage (and access via the
112 * current_data() and data_at_depth(int) methods).
113 *
114 * Bare minimum needed to be an ALGO class:
115 * class Algo : public HierarchyVisitor<Algo> {
116 * void* new_node_data(InstanceKlass* cls) { return NULL; }
117 * void free_node_data(void* data) { return; }
118 * bool visit() { return true; }
119 * };
120 */
121 template <class ALGO>
122 class HierarchyVisitor : StackObj {
123 private:
125 class Node : public ResourceObj {
126 public:
127 InstanceKlass* _class;
128 bool _super_was_visited;
129 int _interface_index;
130 void* _algorithm_data;
132 Node(InstanceKlass* cls, void* data, bool visit_super)
133 : _class(cls), _super_was_visited(!visit_super),
134 _interface_index(0), _algorithm_data(data) {}
136 int number_of_interfaces() { return _class->local_interfaces()->length(); }
137 int interface_index() { return _interface_index; }
138 void set_super_visited() { _super_was_visited = true; }
139 void increment_visited_interface() { ++_interface_index; }
140 void set_all_interfaces_visited() {
141 _interface_index = number_of_interfaces();
142 }
143 bool has_visited_super() { return _super_was_visited; }
144 bool has_visited_all_interfaces() {
145 return interface_index() >= number_of_interfaces();
146 }
147 InstanceKlass* interface_at(int index) {
148 return InstanceKlass::cast(_class->local_interfaces()->at(index));
149 }
150 InstanceKlass* next_super() { return _class->java_super(); }
151 InstanceKlass* next_interface() {
152 return interface_at(interface_index());
153 }
154 };
156 bool _cancelled;
157 GrowableArray<Node*> _path;
159 Node* current_top() const { return _path.top(); }
160 bool has_more_nodes() const { return !_path.is_empty(); }
161 void push(InstanceKlass* cls, void* data) {
162 assert(cls != NULL, "Requires a valid instance class");
163 Node* node = new Node(cls, data, has_super(cls));
164 _path.push(node);
165 }
166 void pop() { _path.pop(); }
168 void reset_iteration() {
169 _cancelled = false;
170 _path.clear();
171 }
172 bool is_cancelled() const { return _cancelled; }
174 static bool has_super(InstanceKlass* cls) {
175 return cls->super() != NULL && !cls->is_interface();
176 }
178 Node* node_at_depth(int i) const {
179 return (i >= _path.length()) ? NULL : _path.at(_path.length() - i - 1);
180 }
182 protected:
184 // Accessors available to the algorithm
185 int current_depth() const { return _path.length() - 1; }
187 InstanceKlass* class_at_depth(int i) {
188 Node* n = node_at_depth(i);
189 return n == NULL ? NULL : n->_class;
190 }
191 InstanceKlass* current_class() { return class_at_depth(0); }
193 void* data_at_depth(int i) {
194 Node* n = node_at_depth(i);
195 return n == NULL ? NULL : n->_algorithm_data;
196 }
197 void* current_data() { return data_at_depth(0); }
199 void cancel_iteration() { _cancelled = true; }
201 public:
203 void run(InstanceKlass* root) {
204 ALGO* algo = static_cast<ALGO*>(this);
206 reset_iteration();
208 void* algo_data = algo->new_node_data(root);
209 push(root, algo_data);
210 bool top_needs_visit = true;
212 do {
213 Node* top = current_top();
214 if (top_needs_visit) {
215 if (algo->visit() == false) {
216 // algorithm does not want to continue along this path. Arrange
217 // it so that this state is immediately popped off the stack
218 top->set_super_visited();
219 top->set_all_interfaces_visited();
220 }
221 top_needs_visit = false;
222 }
224 if (top->has_visited_super() && top->has_visited_all_interfaces()) {
225 algo->free_node_data(top->_algorithm_data);
226 pop();
227 } else {
228 InstanceKlass* next = NULL;
229 if (top->has_visited_super() == false) {
230 next = top->next_super();
231 top->set_super_visited();
232 } else {
233 next = top->next_interface();
234 top->increment_visited_interface();
235 }
236 assert(next != NULL, "Otherwise we shouldn't be here");
237 algo_data = algo->new_node_data(next);
238 push(next, algo_data);
239 top_needs_visit = true;
240 }
241 } while (!is_cancelled() && has_more_nodes());
242 }
243 };
245 #ifndef PRODUCT
246 class PrintHierarchy : public HierarchyVisitor<PrintHierarchy> {
247 public:
249 bool visit() {
250 InstanceKlass* cls = current_class();
251 streamIndentor si(tty, current_depth() * 2);
252 tty->indent().print_cr("%s", cls->name()->as_C_string());
253 return true;
254 }
256 void* new_node_data(InstanceKlass* cls) { return NULL; }
257 void free_node_data(void* data) { return; }
258 };
259 #endif // ndef PRODUCT
261 // Used to register InstanceKlass objects and all related metadata structures
262 // (Methods, ConstantPools) as "in-use" by the current thread so that they can't
263 // be deallocated by class redefinition while we're using them. The classes are
264 // de-registered when this goes out of scope.
265 //
266 // Once a class is registered, we need not bother with methodHandles or
267 // constantPoolHandles for it's associated metadata.
268 class KeepAliveRegistrar : public StackObj {
269 private:
270 Thread* _thread;
271 GrowableArray<ConstantPool*> _keep_alive;
273 public:
274 KeepAliveRegistrar(Thread* thread) : _thread(thread), _keep_alive(20) {
275 assert(thread == Thread::current(), "Must be current thread");
276 }
278 ~KeepAliveRegistrar() {
279 for (int i = _keep_alive.length() - 1; i >= 0; --i) {
280 ConstantPool* cp = _keep_alive.at(i);
281 int idx = _thread->metadata_handles()->find_from_end(cp);
282 assert(idx > 0, "Must be in the list");
283 _thread->metadata_handles()->remove_at(idx);
284 }
285 }
287 // Register a class as 'in-use' by the thread. It's fine to register a class
288 // multiple times (though perhaps inefficient)
289 void register_class(InstanceKlass* ik) {
290 ConstantPool* cp = ik->constants();
291 _keep_alive.push(cp);
292 _thread->metadata_handles()->push(cp);
293 }
294 };
296 class KeepAliveVisitor : public HierarchyVisitor<KeepAliveVisitor> {
297 private:
298 KeepAliveRegistrar* _registrar;
300 public:
301 KeepAliveVisitor(KeepAliveRegistrar* registrar) : _registrar(registrar) {}
303 void* new_node_data(InstanceKlass* cls) { return NULL; }
304 void free_node_data(void* data) { return; }
306 bool visit() {
307 _registrar->register_class(current_class());
308 return true;
309 }
310 };
313 // A method family contains a set of all methods that implement a single
314 // erased method. As members of the set are collected while walking over the
315 // hierarchy, they are tagged with a qualification state. The qualification
316 // state for an erased method is set to disqualified if there exists a path
317 // from the root of hierarchy to the method that contains an interleaving
318 // erased method defined in an interface.
320 class MethodFamily : public ResourceObj {
321 private:
323 GrowableArray<Pair<Method*,QualifiedState> > _members;
324 ResourceHashtable<Method*, int> _member_index;
326 Method* _selected_target; // Filled in later, if a unique target exists
327 Symbol* _exception_message; // If no unique target is found
328 Symbol* _exception_name; // If no unique target is found
330 bool contains_method(Method* method) {
331 int* lookup = _member_index.get(method);
332 return lookup != NULL;
333 }
335 void add_method(Method* method, QualifiedState state) {
336 Pair<Method*,QualifiedState> entry(method, state);
337 _member_index.put(method, _members.length());
338 _members.append(entry);
339 }
341 void disqualify_method(Method* method) {
342 int* index = _member_index.get(method);
343 guarantee(index != NULL && *index >= 0 && *index < _members.length(), "bad index");
344 _members.at(*index).second = DISQUALIFIED;
345 }
347 Symbol* generate_no_defaults_message(TRAPS) const;
348 Symbol* generate_conflicts_message(GrowableArray<Method*>* methods, TRAPS) const;
350 public:
352 MethodFamily()
353 : _selected_target(NULL), _exception_message(NULL), _exception_name(NULL) {}
355 void set_target_if_empty(Method* m) {
356 if (_selected_target == NULL && !m->is_overpass()) {
357 _selected_target = m;
358 }
359 }
361 void record_qualified_method(Method* m) {
362 // If the method already exists in the set as qualified, this operation is
363 // redundant. If it already exists as disqualified, then we leave it as
364 // disqualfied. Thus we only add to the set if it's not already in the
365 // set.
366 if (!contains_method(m)) {
367 add_method(m, QUALIFIED);
368 }
369 }
371 void record_disqualified_method(Method* m) {
372 // If not in the set, add it as disqualified. If it's already in the set,
373 // then set the state to disqualified no matter what the previous state was.
374 if (!contains_method(m)) {
375 add_method(m, DISQUALIFIED);
376 } else {
377 disqualify_method(m);
378 }
379 }
381 bool has_target() const { return _selected_target != NULL; }
382 bool throws_exception() { return _exception_message != NULL; }
384 Method* get_selected_target() { return _selected_target; }
385 Symbol* get_exception_message() { return _exception_message; }
386 Symbol* get_exception_name() { return _exception_name; }
388 // Either sets the target or the exception error message
389 void determine_target(InstanceKlass* root, TRAPS) {
390 if (has_target() || throws_exception()) {
391 return;
392 }
394 GrowableArray<Method*> qualified_methods;
395 for (int i = 0; i < _members.length(); ++i) {
396 Pair<Method*,QualifiedState> entry = _members.at(i);
397 if (entry.second == QUALIFIED) {
398 qualified_methods.append(entry.first);
399 }
400 }
402 if (qualified_methods.length() == 0) {
403 _exception_message = generate_no_defaults_message(CHECK);
404 _exception_name = vmSymbols::java_lang_AbstractMethodError();
405 } else if (qualified_methods.length() == 1) {
406 // leave abstract methods alone, they will be found via normal search path
407 Method* method = qualified_methods.at(0);
408 if (!method->is_abstract()) {
409 _selected_target = qualified_methods.at(0);
410 }
411 } else {
412 _exception_message = generate_conflicts_message(&qualified_methods,CHECK);
413 _exception_name = vmSymbols::java_lang_IncompatibleClassChangeError();
414 if (TraceDefaultMethods) {
415 _exception_message->print_value_on(tty);
416 tty->print_cr("");
417 }
418 }
419 }
421 bool contains_signature(Symbol* query) {
422 for (int i = 0; i < _members.length(); ++i) {
423 if (query == _members.at(i).first->signature()) {
424 return true;
425 }
426 }
427 return false;
428 }
430 #ifndef PRODUCT
431 void print_sig_on(outputStream* str, Symbol* signature, int indent) const {
432 streamIndentor si(str, indent * 2);
434 str->indent().print_cr("Logical Method %s:", signature->as_C_string());
436 streamIndentor si2(str);
437 for (int i = 0; i < _members.length(); ++i) {
438 str->indent();
439 print_method(str, _members.at(i).first);
440 if (_members.at(i).second == DISQUALIFIED) {
441 str->print(" (disqualified)");
442 }
443 str->print_cr("");
444 }
446 if (_selected_target != NULL) {
447 print_selected(str, 1);
448 }
449 }
451 void print_selected(outputStream* str, int indent) const {
452 assert(has_target(), "Should be called otherwise");
453 streamIndentor si(str, indent * 2);
454 str->indent().print("Selected method: ");
455 print_method(str, _selected_target);
456 Klass* method_holder = _selected_target->method_holder();
457 if (!method_holder->is_interface()) {
458 tty->print(" : in superclass");
459 }
460 str->print_cr("");
461 }
463 void print_exception(outputStream* str, int indent) {
464 assert(throws_exception(), "Should be called otherwise");
465 assert(_exception_name != NULL, "exception_name should be set");
466 streamIndentor si(str, indent * 2);
467 str->indent().print_cr("%s: %s", _exception_name->as_C_string(), _exception_message->as_C_string());
468 }
469 #endif // ndef PRODUCT
470 };
472 Symbol* MethodFamily::generate_no_defaults_message(TRAPS) const {
473 return SymbolTable::new_symbol("No qualifying defaults found", CHECK_NULL);
474 }
476 Symbol* MethodFamily::generate_conflicts_message(GrowableArray<Method*>* methods, TRAPS) const {
477 stringStream ss;
478 ss.print("Conflicting default methods:");
479 for (int i = 0; i < methods->length(); ++i) {
480 Method* method = methods->at(i);
481 Symbol* klass = method->klass_name();
482 Symbol* name = method->name();
483 ss.print(" ");
484 ss.write((const char*)klass->bytes(), klass->utf8_length());
485 ss.print(".");
486 ss.write((const char*)name->bytes(), name->utf8_length());
487 }
488 return SymbolTable::new_symbol(ss.base(), (int)ss.size(), CHECK_NULL);
489 }
492 class StateRestorer;
494 // StatefulMethodFamily is a wrapper around a MethodFamily that maintains the
495 // qualification state during hierarchy visitation, and applies that state
496 // when adding members to the MethodFamily
497 class StatefulMethodFamily : public ResourceObj {
498 friend class StateRestorer;
499 private:
500 QualifiedState _qualification_state;
502 void set_qualification_state(QualifiedState state) {
503 _qualification_state = state;
504 }
506 protected:
507 MethodFamily* _method_family;
509 public:
510 StatefulMethodFamily() {
511 _method_family = new MethodFamily();
512 _qualification_state = QUALIFIED;
513 }
515 StatefulMethodFamily(MethodFamily* mf) {
516 _method_family = mf;
517 _qualification_state = QUALIFIED;
518 }
520 void set_target_if_empty(Method* m) { _method_family->set_target_if_empty(m); }
522 MethodFamily* get_method_family() { return _method_family; }
524 StateRestorer* record_method_and_dq_further(Method* mo);
525 };
527 class StateRestorer : public PseudoScopeMark {
528 private:
529 StatefulMethodFamily* _method;
530 QualifiedState _state_to_restore;
531 public:
532 StateRestorer(StatefulMethodFamily* dm, QualifiedState state)
533 : _method(dm), _state_to_restore(state) {}
534 ~StateRestorer() { destroy(); }
535 void restore_state() { _method->set_qualification_state(_state_to_restore); }
536 virtual void destroy() { restore_state(); }
537 };
539 StateRestorer* StatefulMethodFamily::record_method_and_dq_further(Method* mo) {
540 StateRestorer* mark = new StateRestorer(this, _qualification_state);
541 if (_qualification_state == QUALIFIED) {
542 _method_family->record_qualified_method(mo);
543 } else {
544 _method_family->record_disqualified_method(mo);
545 }
546 // Everything found "above"??? this method in the hierarchy walk is set to
547 // disqualified
548 set_qualification_state(DISQUALIFIED);
549 return mark;
550 }
552 // Represents a location corresponding to a vtable slot for methods that
553 // neither the class nor any of it's ancestors provide an implementaion.
554 // Default methods may be present to fill this slot.
555 class EmptyVtableSlot : public ResourceObj {
556 private:
557 Symbol* _name;
558 Symbol* _signature;
559 int _size_of_parameters;
560 MethodFamily* _binding;
562 public:
563 EmptyVtableSlot(Method* method)
564 : _name(method->name()), _signature(method->signature()),
565 _size_of_parameters(method->size_of_parameters()), _binding(NULL) {}
567 Symbol* name() const { return _name; }
568 Symbol* signature() const { return _signature; }
569 int size_of_parameters() const { return _size_of_parameters; }
571 void bind_family(MethodFamily* lm) { _binding = lm; }
572 bool is_bound() { return _binding != NULL; }
573 MethodFamily* get_binding() { return _binding; }
575 #ifndef PRODUCT
576 void print_on(outputStream* str) const {
577 print_slot(str, name(), signature());
578 }
579 #endif // ndef PRODUCT
580 };
582 static bool already_in_vtable_slots(GrowableArray<EmptyVtableSlot*>* slots, Method* m) {
583 bool found = false;
584 for (int j = 0; j < slots->length(); ++j) {
585 if (slots->at(j)->name() == m->name() &&
586 slots->at(j)->signature() == m->signature() ) {
587 found = true;
588 break;
589 }
590 }
591 return found;
592 }
594 static GrowableArray<EmptyVtableSlot*>* find_empty_vtable_slots(
595 InstanceKlass* klass, GrowableArray<Method*>* mirandas, TRAPS) {
597 assert(klass != NULL, "Must be valid class");
599 GrowableArray<EmptyVtableSlot*>* slots = new GrowableArray<EmptyVtableSlot*>();
601 // All miranda methods are obvious candidates
602 for (int i = 0; i < mirandas->length(); ++i) {
603 Method* m = mirandas->at(i);
604 if (!already_in_vtable_slots(slots, m)) {
605 slots->append(new EmptyVtableSlot(m));
606 }
607 }
609 // Also any overpasses in our superclasses, that we haven't implemented.
610 // (can't use the vtable because it is not guaranteed to be initialized yet)
611 InstanceKlass* super = klass->java_super();
612 while (super != NULL) {
613 for (int i = 0; i < super->methods()->length(); ++i) {
614 Method* m = super->methods()->at(i);
615 if (m->is_overpass()) {
616 // m is a method that would have been a miranda if not for the
617 // default method processing that occurred on behalf of our superclass,
618 // so it's a method we want to re-examine in this new context. That is,
619 // unless we have a real implementation of it in the current class.
620 Method* impl = klass->lookup_method(m->name(), m->signature());
621 if (impl == NULL || impl->is_overpass()) {
622 if (!already_in_vtable_slots(slots, m)) {
623 slots->append(new EmptyVtableSlot(m));
624 }
625 }
626 }
627 }
629 // also any default methods in our superclasses
630 if (super->default_methods() != NULL) {
631 for (int i = 0; i < super->default_methods()->length(); ++i) {
632 Method* m = super->default_methods()->at(i);
633 // m is a method that would have been a miranda if not for the
634 // default method processing that occurred on behalf of our superclass,
635 // so it's a method we want to re-examine in this new context. That is,
636 // unless we have a real implementation of it in the current class.
637 Method* impl = klass->lookup_method(m->name(), m->signature());
638 if (impl == NULL || impl->is_overpass()) {
639 if (!already_in_vtable_slots(slots, m)) {
640 slots->append(new EmptyVtableSlot(m));
641 }
642 }
643 }
644 }
645 super = super->java_super();
646 }
648 #ifndef PRODUCT
649 if (TraceDefaultMethods) {
650 tty->print_cr("Slots that need filling:");
651 streamIndentor si(tty);
652 for (int i = 0; i < slots->length(); ++i) {
653 tty->indent();
654 slots->at(i)->print_on(tty);
655 tty->print_cr("");
656 }
657 }
658 #endif // ndef PRODUCT
659 return slots;
660 }
662 // Iterates over the superinterface type hierarchy looking for all methods
663 // with a specific erased signature.
664 class FindMethodsByErasedSig : public HierarchyVisitor<FindMethodsByErasedSig> {
665 private:
666 // Context data
667 Symbol* _method_name;
668 Symbol* _method_signature;
669 StatefulMethodFamily* _family;
671 public:
672 FindMethodsByErasedSig(Symbol* name, Symbol* signature) :
673 _method_name(name), _method_signature(signature),
674 _family(NULL) {}
676 void get_discovered_family(MethodFamily** family) {
677 if (_family != NULL) {
678 *family = _family->get_method_family();
679 } else {
680 *family = NULL;
681 }
682 }
684 void* new_node_data(InstanceKlass* cls) { return new PseudoScope(); }
685 void free_node_data(void* node_data) {
686 PseudoScope::cast(node_data)->destroy();
687 }
689 // Find all methods on this hierarchy that match this
690 // method's erased (name, signature)
691 bool visit() {
692 PseudoScope* scope = PseudoScope::cast(current_data());
693 InstanceKlass* iklass = current_class();
695 Method* m = iklass->find_method(_method_name, _method_signature);
696 // private interface methods are not candidates for default methods
697 // invokespecial to private interface methods doesn't use default method logic
698 // future: take access controls into account for superclass methods
699 if (m != NULL && !m->is_static() && (!iklass->is_interface() || m->is_public())) {
700 if (_family == NULL) {
701 _family = new StatefulMethodFamily();
702 }
704 if (iklass->is_interface()) {
705 StateRestorer* restorer = _family->record_method_and_dq_further(m);
706 scope->add_mark(restorer);
707 } else {
708 // This is the rule that methods in classes "win" (bad word) over
709 // methods in interfaces. This works because of single inheritance
710 _family->set_target_if_empty(m);
711 }
712 }
713 return true;
714 }
716 };
720 static void create_defaults_and_exceptions(
721 GrowableArray<EmptyVtableSlot*>* slots, InstanceKlass* klass, TRAPS);
723 static void generate_erased_defaults(
724 InstanceKlass* klass, GrowableArray<EmptyVtableSlot*>* empty_slots,
725 EmptyVtableSlot* slot, TRAPS) {
727 // sets up a set of methods with the same exact erased signature
728 FindMethodsByErasedSig visitor(slot->name(), slot->signature());
729 visitor.run(klass);
731 MethodFamily* family;
732 visitor.get_discovered_family(&family);
733 if (family != NULL) {
734 family->determine_target(klass, CHECK);
735 slot->bind_family(family);
736 }
737 }
739 static void merge_in_new_methods(InstanceKlass* klass,
740 GrowableArray<Method*>* new_methods, TRAPS);
741 static void create_default_methods( InstanceKlass* klass,
742 GrowableArray<Method*>* new_methods, TRAPS);
744 // This is the guts of the default methods implementation. This is called just
745 // after the classfile has been parsed if some ancestor has default methods.
746 //
747 // First if finds any name/signature slots that need any implementation (either
748 // because they are miranda or a superclass's implementation is an overpass
749 // itself). For each slot, iterate over the hierarchy, to see if they contain a
750 // signature that matches the slot we are looking at.
751 //
752 // For each slot filled, we generate an overpass method that either calls the
753 // unique default method candidate using invokespecial, or throws an exception
754 // (in the case of no default method candidates, or more than one valid
755 // candidate). These methods are then added to the class's method list.
756 // The JVM does not create bridges nor handle generic signatures here.
757 void DefaultMethods::generate_default_methods(
758 InstanceKlass* klass, GrowableArray<Method*>* mirandas, TRAPS) {
760 // This resource mark is the bound for all memory allocation that takes
761 // place during default method processing. After this goes out of scope,
762 // all (Resource) objects' memory will be reclaimed. Be careful if adding an
763 // embedded resource mark under here as that memory can't be used outside
764 // whatever scope it's in.
765 ResourceMark rm(THREAD);
767 // Keep entire hierarchy alive for the duration of the computation
768 KeepAliveRegistrar keepAlive(THREAD);
769 KeepAliveVisitor loadKeepAlive(&keepAlive);
770 loadKeepAlive.run(klass);
772 #ifndef PRODUCT
773 if (TraceDefaultMethods) {
774 ResourceMark rm; // be careful with these!
775 tty->print_cr("Class %s requires default method processing",
776 klass->name()->as_klass_external_name());
777 PrintHierarchy printer;
778 printer.run(klass);
779 }
780 #endif // ndef PRODUCT
782 GrowableArray<EmptyVtableSlot*>* empty_slots =
783 find_empty_vtable_slots(klass, mirandas, CHECK);
785 for (int i = 0; i < empty_slots->length(); ++i) {
786 EmptyVtableSlot* slot = empty_slots->at(i);
787 #ifndef PRODUCT
788 if (TraceDefaultMethods) {
789 streamIndentor si(tty, 2);
790 tty->indent().print("Looking for default methods for slot ");
791 slot->print_on(tty);
792 tty->print_cr("");
793 }
794 #endif // ndef PRODUCT
796 generate_erased_defaults(klass, empty_slots, slot, CHECK);
797 }
798 #ifndef PRODUCT
799 if (TraceDefaultMethods) {
800 tty->print_cr("Creating overpasses...");
801 }
802 #endif // ndef PRODUCT
804 create_defaults_and_exceptions(empty_slots, klass, CHECK);
806 #ifndef PRODUCT
807 if (TraceDefaultMethods) {
808 tty->print_cr("Default method processing complete");
809 }
810 #endif // ndef PRODUCT
811 }
813 static int assemble_method_error(
814 BytecodeConstantPool* cp, BytecodeBuffer* buffer, Symbol* errorName, Symbol* message, TRAPS) {
816 Symbol* init = vmSymbols::object_initializer_name();
817 Symbol* sig = vmSymbols::string_void_signature();
819 BytecodeAssembler assem(buffer, cp);
821 assem._new(errorName);
822 assem.dup();
823 assem.load_string(message);
824 assem.invokespecial(errorName, init, sig);
825 assem.athrow();
827 return 3; // max stack size: [ exception, exception, string ]
828 }
830 static Method* new_method(
831 BytecodeConstantPool* cp, BytecodeBuffer* bytecodes, Symbol* name,
832 Symbol* sig, AccessFlags flags, int max_stack, int params,
833 ConstMethod::MethodType mt, TRAPS) {
835 address code_start = 0;
836 int code_length = 0;
837 InlineTableSizes sizes;
839 if (bytecodes != NULL && bytecodes->length() > 0) {
840 code_start = static_cast<address>(bytecodes->adr_at(0));
841 code_length = bytecodes->length();
842 }
844 Method* m = Method::allocate(cp->pool_holder()->class_loader_data(),
845 code_length, flags, &sizes,
846 mt, CHECK_NULL);
848 m->set_constants(NULL); // This will get filled in later
849 m->set_name_index(cp->utf8(name));
850 m->set_signature_index(cp->utf8(sig));
851 #ifdef CC_INTERP
852 ResultTypeFinder rtf(sig);
853 m->set_result_index(rtf.type());
854 #endif
855 m->set_size_of_parameters(params);
856 m->set_max_stack(max_stack);
857 m->set_max_locals(params);
858 m->constMethod()->set_stackmap_data(NULL);
859 m->set_code(code_start);
861 return m;
862 }
864 static void switchover_constant_pool(BytecodeConstantPool* bpool,
865 InstanceKlass* klass, GrowableArray<Method*>* new_methods, TRAPS) {
867 if (new_methods->length() > 0) {
868 ConstantPool* cp = bpool->create_constant_pool(CHECK);
869 if (cp != klass->constants()) {
870 klass->class_loader_data()->add_to_deallocate_list(klass->constants());
871 klass->set_constants(cp);
872 cp->set_pool_holder(klass);
874 for (int i = 0; i < new_methods->length(); ++i) {
875 new_methods->at(i)->set_constants(cp);
876 }
877 for (int i = 0; i < klass->methods()->length(); ++i) {
878 Method* mo = klass->methods()->at(i);
879 mo->set_constants(cp);
880 }
881 }
882 }
883 }
885 // Create default_methods list for the current class.
886 // With the VM only processing erased signatures, the VM only
887 // creates an overpass in a conflict case or a case with no candidates.
888 // This allows virtual methods to override the overpass, but ensures
889 // that a local method search will find the exception rather than an abstract
890 // or default method that is not a valid candidate.
891 static void create_defaults_and_exceptions(
892 GrowableArray<EmptyVtableSlot*>* slots,
893 InstanceKlass* klass, TRAPS) {
895 GrowableArray<Method*> overpasses;
896 GrowableArray<Method*> defaults;
897 BytecodeConstantPool bpool(klass->constants());
899 for (int i = 0; i < slots->length(); ++i) {
900 EmptyVtableSlot* slot = slots->at(i);
902 if (slot->is_bound()) {
903 MethodFamily* method = slot->get_binding();
904 BytecodeBuffer buffer;
906 #ifndef PRODUCT
907 if (TraceDefaultMethods) {
908 tty->print("for slot: ");
909 slot->print_on(tty);
910 tty->print_cr("");
911 if (method->has_target()) {
912 method->print_selected(tty, 1);
913 } else if (method->throws_exception()) {
914 method->print_exception(tty, 1);
915 }
916 }
917 #endif // ndef PRODUCT
919 if (method->has_target()) {
920 Method* selected = method->get_selected_target();
921 if (selected->method_holder()->is_interface()) {
922 defaults.push(selected);
923 }
924 } else if (method->throws_exception()) {
925 int max_stack = assemble_method_error(&bpool, &buffer,
926 method->get_exception_name(), method->get_exception_message(), CHECK);
927 AccessFlags flags = accessFlags_from(
928 JVM_ACC_PUBLIC | JVM_ACC_SYNTHETIC | JVM_ACC_BRIDGE);
929 Method* m = new_method(&bpool, &buffer, slot->name(), slot->signature(),
930 flags, max_stack, slot->size_of_parameters(),
931 ConstMethod::OVERPASS, CHECK);
932 // We push to the methods list:
933 // overpass methods which are exception throwing methods
934 if (m != NULL) {
935 overpasses.push(m);
936 }
937 }
938 }
939 }
941 #ifndef PRODUCT
942 if (TraceDefaultMethods) {
943 tty->print_cr("Created %d overpass methods", overpasses.length());
944 tty->print_cr("Created %d default methods", defaults.length());
945 }
946 #endif // ndef PRODUCT
948 if (overpasses.length() > 0) {
949 switchover_constant_pool(&bpool, klass, &overpasses, CHECK);
950 merge_in_new_methods(klass, &overpasses, CHECK);
951 }
952 if (defaults.length() > 0) {
953 create_default_methods(klass, &defaults, CHECK);
954 }
955 }
957 static void create_default_methods( InstanceKlass* klass,
958 GrowableArray<Method*>* new_methods, TRAPS) {
960 int new_size = new_methods->length();
961 Array<Method*>* total_default_methods = MetadataFactory::new_array<Method*>(
962 klass->class_loader_data(), new_size, NULL, CHECK);
963 for (int index = 0; index < new_size; index++ ) {
964 total_default_methods->at_put(index, new_methods->at(index));
965 }
966 Method::sort_methods(total_default_methods, false, false);
968 klass->set_default_methods(total_default_methods);
969 }
971 static void sort_methods(GrowableArray<Method*>* methods) {
972 // Note that this must sort using the same key as is used for sorting
973 // methods in InstanceKlass.
974 bool sorted = true;
975 for (int i = methods->length() - 1; i > 0; --i) {
976 for (int j = 0; j < i; ++j) {
977 Method* m1 = methods->at(j);
978 Method* m2 = methods->at(j + 1);
979 if ((uintptr_t)m1->name() > (uintptr_t)m2->name()) {
980 methods->at_put(j, m2);
981 methods->at_put(j + 1, m1);
982 sorted = false;
983 }
984 }
985 if (sorted) break;
986 sorted = true;
987 }
988 #ifdef ASSERT
989 uintptr_t prev = 0;
990 for (int i = 0; i < methods->length(); ++i) {
991 Method* mh = methods->at(i);
992 uintptr_t nv = (uintptr_t)mh->name();
993 assert(nv >= prev, "Incorrect overpass method ordering");
994 prev = nv;
995 }
996 #endif
997 }
999 static void merge_in_new_methods(InstanceKlass* klass,
1000 GrowableArray<Method*>* new_methods, TRAPS) {
1002 enum { ANNOTATIONS, PARAMETERS, DEFAULTS, NUM_ARRAYS };
1004 Array<Method*>* original_methods = klass->methods();
1005 Array<int>* original_ordering = klass->method_ordering();
1006 Array<int>* merged_ordering = Universe::the_empty_int_array();
1008 int new_size = klass->methods()->length() + new_methods->length();
1010 Array<Method*>* merged_methods = MetadataFactory::new_array<Method*>(
1011 klass->class_loader_data(), new_size, NULL, CHECK);
1013 if (original_ordering != NULL && original_ordering->length() > 0) {
1014 merged_ordering = MetadataFactory::new_array<int>(
1015 klass->class_loader_data(), new_size, CHECK);
1016 }
1017 int method_order_index = klass->methods()->length();
1019 sort_methods(new_methods);
1021 // Perform grand merge of existing methods and new methods
1022 int orig_idx = 0;
1023 int new_idx = 0;
1025 for (int i = 0; i < new_size; ++i) {
1026 Method* orig_method = NULL;
1027 Method* new_method = NULL;
1028 if (orig_idx < original_methods->length()) {
1029 orig_method = original_methods->at(orig_idx);
1030 }
1031 if (new_idx < new_methods->length()) {
1032 new_method = new_methods->at(new_idx);
1033 }
1035 if (orig_method != NULL &&
1036 (new_method == NULL || orig_method->name() < new_method->name())) {
1037 merged_methods->at_put(i, orig_method);
1038 original_methods->at_put(orig_idx, NULL);
1039 if (merged_ordering->length() > 0) {
1040 merged_ordering->at_put(i, original_ordering->at(orig_idx));
1041 }
1042 ++orig_idx;
1043 } else {
1044 merged_methods->at_put(i, new_method);
1045 if (merged_ordering->length() > 0) {
1046 merged_ordering->at_put(i, method_order_index++);
1047 }
1048 ++new_idx;
1049 }
1050 // update idnum for new location
1051 merged_methods->at(i)->set_method_idnum(i);
1052 }
1054 // Verify correct order
1055 #ifdef ASSERT
1056 uintptr_t prev = 0;
1057 for (int i = 0; i < merged_methods->length(); ++i) {
1058 Method* mo = merged_methods->at(i);
1059 uintptr_t nv = (uintptr_t)mo->name();
1060 assert(nv >= prev, "Incorrect method ordering");
1061 prev = nv;
1062 }
1063 #endif
1065 // Replace klass methods with new merged lists
1066 klass->set_methods(merged_methods);
1067 klass->set_initial_method_idnum(new_size);
1069 ClassLoaderData* cld = klass->class_loader_data();
1070 MetadataFactory::free_array(cld, original_methods);
1071 if (original_ordering->length() > 0) {
1072 klass->set_method_ordering(merged_ordering);
1073 MetadataFactory::free_array(cld, original_ordering);
1074 }
1075 }