1 /*
   2  * Copyright (c) 1997, 2012, 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  */
  24 
  25 #ifndef SHARE_VM_CLASSFILE_SYSTEMDICTIONARY_HPP
  26 #define SHARE_VM_CLASSFILE_SYSTEMDICTIONARY_HPP
  27 
  28 #include "classfile/classFileStream.hpp"
  29 #include "classfile/classLoader.hpp"
  30 #include "oops/objArrayOop.hpp"
  31 #include "oops/symbol.hpp"
  32 #include "runtime/java.hpp"
  33 #include "runtime/reflectionUtils.hpp"
  34 #include "utilities/hashtable.hpp"
  35 #include "utilities/hashtable.inline.hpp"
  36 
  37 // The system dictionary stores all loaded classes and maps:
  38 //
  39 //   [class name,class loader] -> class   i.e.  [Symbol*,oop] -> Klass*
  40 //
  41 // Classes are loaded lazily. The default VM class loader is
  42 // represented as NULL.
  43 
  44 // The underlying data structure is an open hash table with a fixed number
  45 // of buckets. During loading the loader object is locked, (for the VM loader
  46 // a private lock object is used). Class loading can thus be done concurrently,
  47 // but only by different loaders.
  48 //
  49 // During loading a placeholder (name, loader) is temporarily placed in
  50 // a side data structure, and is used to detect ClassCircularityErrors
  51 // and to perform verification during GC.  A GC can occur in the midst
  52 // of class loading, as we call out to Java, have to take locks, etc.
  53 //
  54 // When class loading is finished, a new entry is added to the system
  55 // dictionary and the place holder is removed. Note that the protection
  56 // domain field of the system dictionary has not yet been filled in when
  57 // the "real" system dictionary entry is created.
  58 //
  59 // Clients of this class who are interested in finding if a class has
  60 // been completely loaded -- not classes in the process of being loaded --
  61 // can read the SystemDictionary unlocked. This is safe because
  62 //    - entries are only deleted at safepoints
  63 //    - readers cannot come to a safepoint while actively examining
  64 //         an entry  (an entry cannot be deleted from under a reader)
  65 //    - entries must be fully formed before they are available to concurrent
  66 //         readers (we must ensure write ordering)
  67 //
  68 // Note that placeholders are deleted at any time, as they are removed
  69 // when a class is completely loaded. Therefore, readers as well as writers
  70 // of placeholders must hold the SystemDictionary_lock.
  71 //
  72 
  73 class Dictionary;
  74 class PlaceholderTable;
  75 class LoaderConstraintTable;
  76 template <MEMFLAGS F> class HashtableBucket;
  77 class ResolutionErrorTable;
  78 class SymbolPropertyTable;
  79 
  80 // Certain classes are preloaded, such as java.lang.Object and java.lang.String.
  81 // They are all "well-known", in the sense that no class loader is allowed
  82 // to provide a different definition.
  83 //
  84 // These klasses must all have names defined in vmSymbols.
  85 
  86 #define WK_KLASS_ENUM_NAME(kname)    kname##_knum
  87 
  88 // Each well-known class has a short klass name (like object_klass),
  89 // a vmSymbol name (like java_lang_Object), and a flag word
  90 // that makes some minor distinctions, like whether the klass
  91 // is preloaded, optional, release-specific, etc.
  92 // The order of these definitions is significant; it is the order in which
  93 // preloading is actually performed by initialize_preloaded_classes.
  94 
  95 #define WK_KLASSES_DO(do_klass)                                                                                          \
  96   /* well-known classes */                                                                                               \
  97   do_klass(Object_klass,                                java_lang_Object,                          Pre_Link            ) \
  98   do_klass(String_klass,                                java_lang_String,                          Pre_Link            ) \
  99   do_klass(Class_klass,                                 java_lang_Class,                           Pre_Link            ) \
 100   do_klass(Cloneable_klass,                             java_lang_Cloneable,                       Pre_Link            ) \
 101   do_klass(ClassLoader_klass,                           java_lang_ClassLoader,                     Pre_Link            ) \
 102   do_klass(Serializable_klass,                          java_io_Serializable,                      Pre_Link            ) \
 103   do_klass(System_klass,                                java_lang_System,                          Pre_Link            ) \
 104   do_klass(Throwable_klass,                             java_lang_Throwable,                       Pre_Link            ) \
 105   do_klass(Error_klass,                                 java_lang_Error,                           Pre_Link            ) \
 106   do_klass(ThreadDeath_klass,                           java_lang_ThreadDeath,                     Pre_Link            ) \
 107   do_klass(Exception_klass,                             java_lang_Exception,                       Pre_Link            ) \
 108   do_klass(RuntimeException_klass,                      java_lang_RuntimeException,                Pre_Link            ) \
 109   do_klass(ProtectionDomain_klass,                      java_security_ProtectionDomain,            Pre_Link            ) \
 110   do_klass(AccessControlContext_klass,                  java_security_AccessControlContext,        Pre_Link            ) \
 111   do_klass(ClassNotFoundException_klass,                java_lang_ClassNotFoundException,          Pre_Link            ) \
 112   do_klass(NoClassDefFoundError_klass,                  java_lang_NoClassDefFoundError,            Pre_Link            ) \
 113   do_klass(LinkageError_klass,                          java_lang_LinkageError,                    Pre_Link            ) \
 114   do_klass(ClassCastException_klass,                    java_lang_ClassCastException,              Pre_Link            ) \
 115   do_klass(ArrayStoreException_klass,                   java_lang_ArrayStoreException,             Pre_Link            ) \
 116   do_klass(VirtualMachineError_klass,                   java_lang_VirtualMachineError,             Pre_Link            ) \
 117   do_klass(OutOfMemoryError_klass,                      java_lang_OutOfMemoryError,                Pre_Link            ) \
 118   do_klass(StackOverflowError_klass,                    java_lang_StackOverflowError,              Pre_Link            ) \
 119   do_klass(IllegalMonitorStateException_klass,          java_lang_IllegalMonitorStateException,    Pre_Link            ) \
 120   do_klass(Reference_klass,                             java_lang_ref_Reference,                   Pre_Link            ) \
 121                                                                                                                          \
 122   /* Preload ref klasses and set reference types */                                                                      \
 123   do_klass(SoftReference_klass,                         java_lang_ref_SoftReference,               Pre_Link            ) \
 124   do_klass(WeakReference_klass,                         java_lang_ref_WeakReference,               Pre_Link            ) \
 125   do_klass(FinalReference_klass,                        java_lang_ref_FinalReference,              Pre                 ) \
 126   do_klass(PhantomReference_klass,                      java_lang_ref_PhantomReference,            Pre_Link            ) \
 127   do_klass(Finalizer_klass,                             java_lang_ref_Finalizer,                   Pre                 ) \
 128                                                                                                                          \
 129   do_klass(Thread_klass,                                java_lang_Thread,                          Pre_Link            ) \
 130   do_klass(ThreadGroup_klass,                           java_lang_ThreadGroup,                     Pre_Link            ) \
 131   do_klass(Properties_klass,                            java_util_Properties,                      Pre_Link            ) \
 132   do_klass(reflect_AccessibleObject_klass,              java_lang_reflect_AccessibleObject,        Pre_Link            ) \
 133   do_klass(reflect_Field_klass,                         java_lang_reflect_Field,                   Pre_Link            ) \
 134   do_klass(reflect_Method_klass,                        java_lang_reflect_Method,                  Pre_Link            ) \
 135   do_klass(reflect_Constructor_klass,                   java_lang_reflect_Constructor,             Pre_Link            ) \
 136                                                                                                                          \
 137   /* NOTE: needed too early in bootstrapping process to have checks based on JDK version */                              \
 138   /* Universe::is_gte_jdk14x_version() is not set up by this point. */                                                   \
 139   /* It's okay if this turns out to be NULL in non-1.4 JDKs. */                                                          \
 140   do_klass(reflect_MagicAccessorImpl_klass,             sun_reflect_MagicAccessorImpl,             Opt                 ) \
 141   do_klass(reflect_MethodAccessorImpl_klass,            sun_reflect_MethodAccessorImpl,            Opt_Only_JDK14NewRef) \
 142   do_klass(reflect_ConstructorAccessorImpl_klass,       sun_reflect_ConstructorAccessorImpl,       Opt_Only_JDK14NewRef) \
 143   do_klass(reflect_DelegatingClassLoader_klass,         sun_reflect_DelegatingClassLoader,         Opt                 ) \
 144   do_klass(reflect_ConstantPool_klass,                  sun_reflect_ConstantPool,                  Opt_Only_JDK15      ) \
 145   do_klass(reflect_UnsafeStaticFieldAccessorImpl_klass, sun_reflect_UnsafeStaticFieldAccessorImpl, Opt_Only_JDK15      ) \
 146                                                                                                                          \
 147   /* support for dynamic typing; it's OK if these are NULL in earlier JDKs */                                            \
 148   do_klass(MethodHandle_klass,                          java_lang_invoke_MethodHandle,             Pre_Link            ) \
 149   do_klass(MemberName_klass,                            java_lang_invoke_MemberName,               Pre                 ) \
 150   do_klass(MethodHandleNatives_klass,                   java_lang_invoke_MethodHandleNatives,      Pre                 ) \
 151   do_klass(LambdaForm_klass,                            java_lang_invoke_LambdaForm,               Opt                 ) \
 152   do_klass(MethodType_klass,                            java_lang_invoke_MethodType,               Pre_Link            ) \
 153   do_klass(BootstrapMethodError_klass,                  java_lang_BootstrapMethodError,            Pre_Link            ) \
 154   do_klass(CallSite_klass,                              java_lang_invoke_CallSite,                 Pre_Link            ) \
 155   do_klass(ConstantCallSite_klass,                      java_lang_invoke_ConstantCallSite,         Pre_Link            ) \
 156   do_klass(MutableCallSite_klass,                       java_lang_invoke_MutableCallSite,          Pre_Link            ) \
 157   do_klass(VolatileCallSite_klass,                      java_lang_invoke_VolatileCallSite,         Pre_Link            ) \
 158   /* Note: MethodHandle must be first, and VolatileCallSite last in group */                                             \
 159                                                                                                                          \
 160   do_klass(StringBuffer_klass,                          java_lang_StringBuffer,                    Pre_Link            ) \
 161   do_klass(StringBuilder_klass,                         java_lang_StringBuilder,                   Pre_Link            ) \
 162                                                                                                                          \
 163   /* It's NULL in non-1.4 JDKs. */                                                                                       \
 164   do_klass(StackTraceElement_klass,                     java_lang_StackTraceElement,               Opt                 ) \
 165   /* Universe::is_gte_jdk14x_version() is not set up by this point. */                                                   \
 166   /* It's okay if this turns out to be NULL in non-1.4 JDKs. */                                                          \
 167   do_klass(nio_Buffer_klass,                            java_nio_Buffer,                           Opt                 ) \
 168                                                                                                                          \
 169   do_klass(DownloadManager_klass,                       sun_jkernel_DownloadManager,               Opt_Kernel          ) \
 170                                                                                                                          \
 171   do_klass(PostVMInitHook_klass,                        sun_misc_PostVMInitHook,                   Opt                 ) \
 172                                                                                                                          \
 173   /* Preload boxing klasses */                                                                                           \
 174   do_klass(Boolean_klass,                               java_lang_Boolean,                         Pre_Link            ) \
 175   do_klass(Character_klass,                             java_lang_Character,                       Pre_Link            ) \
 176   do_klass(Float_klass,                                 java_lang_Float,                           Pre_Link            ) \
 177   do_klass(Double_klass,                                java_lang_Double,                          Pre_Link            ) \
 178   do_klass(Byte_klass,                                  java_lang_Byte,                            Pre_Link            ) \
 179   do_klass(Short_klass,                                 java_lang_Short,                           Pre_Link            ) \
 180   do_klass(Integer_klass,                               java_lang_Integer,                         Pre_Link            ) \
 181   do_klass(Long_klass,                                  java_lang_Long,                            Pre_Link            ) \
 182   /*end*/
 183 
 184 
 185 class SystemDictionary : AllStatic {
 186   friend class VMStructs;
 187   friend class SystemDictionaryHandles;
 188 
 189  public:
 190   enum WKID {
 191     NO_WKID = 0,
 192 
 193     #define WK_KLASS_ENUM(name, symbol, ignore_o) WK_KLASS_ENUM_NAME(name), WK_KLASS_ENUM_NAME(symbol) = WK_KLASS_ENUM_NAME(name),
 194     WK_KLASSES_DO(WK_KLASS_ENUM)
 195     #undef WK_KLASS_ENUM
 196 
 197     WKID_LIMIT,
 198 
 199     FIRST_WKID = NO_WKID + 1
 200   };
 201 
 202   enum InitOption {
 203     Pre,                        // preloaded; error if not present
 204     Pre_Link,                   // preloaded; error if not present; link as well-known
 205 
 206     // Order is significant.  Options before this point require resolve_or_fail.
 207     // Options after this point will use resolve_or_null instead.
 208 
 209     Opt,                        // preload tried; NULL if not present
 210     Opt_Only_JDK14NewRef,       // preload tried; use only with NewReflection
 211     Opt_Only_JDK15,             // preload tried; use only with JDK1.5+
 212     Opt_Kernel,                 // preload tried only #ifdef KERNEL
 213     OPTION_LIMIT,
 214     CEIL_LG_OPTION_LIMIT = 4    // OPTION_LIMIT <= (1<<CEIL_LG_OPTION_LIMIT)
 215   };
 216 
 217 
 218   // Returns a class with a given class name and class loader.  Loads the
 219   // class if needed. If not found a NoClassDefFoundError or a
 220   // ClassNotFoundException is thrown, depending on the value on the
 221   // throw_error flag.  For most uses the throw_error argument should be set
 222   // to true.
 223 
 224   static Klass* resolve_or_fail(Symbol* class_name, Handle class_loader, Handle protection_domain, bool throw_error, TRAPS);
 225   // Convenient call for null loader and protection domain.
 226   static Klass* resolve_or_fail(Symbol* class_name, bool throw_error, TRAPS);
 227 private:
 228   // handle error translation for resolve_or_null results
 229   static Klass* handle_resolution_exception(Symbol* class_name, Handle class_loader, Handle protection_domain, bool throw_error, KlassHandle klass_h, TRAPS);
 230 
 231 public:
 232 
 233   // Returns a class with a given class name and class loader.
 234   // Loads the class if needed. If not found NULL is returned.
 235   static Klass* resolve_or_null(Symbol* class_name, Handle class_loader, Handle protection_domain, TRAPS);
 236   // Version with null loader and protection domain
 237   static Klass* resolve_or_null(Symbol* class_name, TRAPS);
 238 
 239   // Resolve a superclass or superinterface. Called from ClassFileParser,
 240   // parse_interfaces, resolve_instance_class_or_null, load_shared_class
 241   // "child_name" is the class whose super class or interface is being resolved.
 242   static Klass* resolve_super_or_fail(Symbol* child_name,
 243                                         Symbol* class_name,
 244                                         Handle class_loader,
 245                                         Handle protection_domain,
 246                                         bool is_superclass,
 247                                         TRAPS);
 248 
 249   // Parse new stream. This won't update the system dictionary or
 250   // class hierarchy, simply parse the stream. Used by JVMTI RedefineClasses.
 251   static Klass* parse_stream(Symbol* class_name,
 252                                Handle class_loader,
 253                                Handle protection_domain,
 254                                ClassFileStream* st,
 255                                TRAPS) {
 256     KlassHandle nullHandle;
 257     return parse_stream(class_name, class_loader, protection_domain, st, nullHandle, NULL, THREAD);
 258   }
 259   static Klass* parse_stream(Symbol* class_name,
 260                                Handle class_loader,
 261                                Handle protection_domain,
 262                                ClassFileStream* st,
 263                                KlassHandle host_klass,
 264                                GrowableArray<Handle>* cp_patches,
 265                                TRAPS);
 266 
 267   // Resolve from stream (called by jni_DefineClass and JVM_DefineClass)
 268   static Klass* resolve_from_stream(Symbol* class_name, Handle class_loader,
 269                                       Handle protection_domain,
 270                                       ClassFileStream* st, bool verify, TRAPS);
 271 
 272   // Lookup an already loaded class. If not found NULL is returned.
 273   static Klass* find(Symbol* class_name, Handle class_loader, Handle protection_domain, TRAPS);
 274 
 275   // Lookup an already loaded instance or array class.
 276   // Do not make any queries to class loaders; consult only the cache.
 277   // If not found NULL is returned.
 278   static Klass* find_instance_or_array_klass(Symbol* class_name,
 279                                                Handle class_loader,
 280                                                Handle protection_domain,
 281                                                TRAPS);
 282 
 283   // If the given name is known to vmSymbols, return the well-know klass:
 284   static Klass* find_well_known_klass(Symbol* class_name);
 285 
 286   // Lookup an instance or array class that has already been loaded
 287   // either into the given class loader, or else into another class
 288   // loader that is constrained (via loader constraints) to produce
 289   // a consistent class.  Do not take protection domains into account.
 290   // Do not make any queries to class loaders; consult only the cache.
 291   // Return NULL if the class is not found.
 292   //
 293   // This function is a strict superset of find_instance_or_array_klass.
 294   // This function (the unchecked version) makes a conservative prediction
 295   // of the result of the checked version, assuming successful lookup.
 296   // If both functions return non-null, they must return the same value.
 297   // Also, the unchecked version may sometimes be non-null where the
 298   // checked version is null.  This can occur in several ways:
 299   //   1. No query has yet been made to the class loader.
 300   //   2. The class loader was queried, but chose not to delegate.
 301   //   3. ClassLoader.checkPackageAccess rejected a proposed protection domain.
 302   //   4. Loading was attempted, but there was a linkage error of some sort.
 303   // In all of these cases, the loader constraints on this type are
 304   // satisfied, and it is safe for classes in the given class loader
 305   // to manipulate strongly-typed values of the found class, subject
 306   // to local linkage and access checks.
 307   static Klass* find_constrained_instance_or_array_klass(Symbol* class_name,
 308                                                            Handle class_loader,
 309                                                            TRAPS);
 310 
 311   // Iterate over all klasses in dictionary
 312   //   Just the classes from defining class loaders
 313   static void classes_do(void f(Klass*));
 314   // Added for initialize_itable_for_klass to handle exceptions
 315   static void classes_do(void f(Klass*, TRAPS), TRAPS);
 316   //   All classes, and their class loaders
 317   static void classes_do(void f(Klass*, ClassLoaderData*));
 318   //   All classes, and their class loaders
 319   //   (added for helpers that use HandleMarks and ResourceMarks)
 320   static void classes_do(void f(Klass*, ClassLoaderData*, TRAPS), TRAPS);
 321   // All entries in the placeholder table and their class loaders
 322   static void placeholders_do(void f(Symbol*));
 323 
 324   // Iterate over all methods in all klasses in dictionary
 325   static void methods_do(void f(Method*));
 326 
 327   // Garbage collection support
 328 
 329   // This method applies "blk->do_oop" to all the pointers to "system"
 330   // classes and loaders.
 331   static void always_strong_oops_do(OopClosure* blk);
 332   static void always_strong_classes_do(KlassClosure* closure);
 333 
 334   // Unload (that is, break root links to) all unmarked classes and
 335   // loaders.  Returns "true" iff something was unloaded.
 336   static bool do_unloading(BoolObjectClosure* is_alive);
 337 
 338   static int calculate_systemdictionary_size(int loadedclasses);
 339 
 340   // Applies "f->do_oop" to all root oops in the system dictionary.
 341   static void oops_do(OopClosure* f);
 342 
 343   // System loader lock
 344   static oop system_loader_lock()           { return _system_loader_lock_obj; }
 345 
 346 private:
 347   // Extended Redefine classes support (tbi)
 348   static void preloaded_classes_do(KlassClosure* f);
 349   static void lazily_loaded_classes_do(KlassClosure* f);
 350 public:
 351   // Sharing support.
 352   static void reorder_dictionary();
 353   static void copy_buckets(char** top, char* end);
 354   static void copy_table(char** top, char* end);
 355   static void reverse();
 356   static void set_shared_dictionary(HashtableBucket<mtClass>* t, int length,
 357                                     int number_of_entries);
 358   // Printing
 359   static void print()                   PRODUCT_RETURN;
 360   static void print_class_statistics()  PRODUCT_RETURN;
 361   static void print_method_statistics() PRODUCT_RETURN;
 362 
 363   // Number of contained klasses
 364   // This is both fully loaded classes and classes in the process
 365   // of being loaded
 366   static int number_of_classes();
 367 
 368   // Monotonically increasing counter which grows as classes are
 369   // loaded or modifications such as hot-swapping or setting/removing
 370   // of breakpoints are performed
 371   static inline int number_of_modifications()     { assert_locked_or_safepoint(Compile_lock); return _number_of_modifications; }
 372   // Needed by evolution and breakpoint code
 373   static inline void notice_modification()        { assert_locked_or_safepoint(Compile_lock); ++_number_of_modifications;      }
 374 
 375   // Verification
 376   static void verify();
 377 
 378 #ifdef ASSERT
 379   static bool is_internal_format(Symbol* class_name);
 380 #endif
 381 
 382   // Verify class is in dictionary
 383   static void verify_obj_klass_present(Symbol* class_name,
 384                                        ClassLoaderData* loader_data);
 385 
 386   // Initialization
 387   static void initialize(TRAPS);
 388 
 389   // Fast access to commonly used classes (preloaded)
 390   static Klass* check_klass(Klass* k) {
 391     assert(k != NULL, "preloaded klass not initialized");
 392     return k;
 393   }
 394 
 395   static Klass* check_klass_Pre(       Klass* k) { return check_klass(k); }
 396   static Klass* check_klass_Pre_Link(  Klass* k) { return check_klass(k); }
 397   static Klass* check_klass_Opt(       Klass* k) { return k; }
 398   static Klass* check_klass_Opt_Kernel(Klass* k) { return k; } //== Opt
 399   static Klass* check_klass_Opt_Only_JDK15(Klass* k) {
 400     assert(JDK_Version::is_gte_jdk15x_version(), "JDK 1.5 only");
 401     return k;
 402   }
 403   static Klass* check_klass_Opt_Only_JDK14NewRef(Klass* k) {
 404     assert(JDK_Version::is_gte_jdk14x_version() && UseNewReflection, "JDK 1.4 only");
 405     // despite the optional loading, if you use this it must be present:
 406     return check_klass(k);
 407   }
 408 
 409   static bool initialize_wk_klass(WKID id, int init_opt, TRAPS);
 410   static void initialize_wk_klasses_until(WKID limit_id, WKID &start_id, TRAPS);
 411   static void initialize_wk_klasses_through(WKID end_id, WKID &start_id, TRAPS) {
 412     int limit = (int)end_id + 1;
 413     initialize_wk_klasses_until((WKID) limit, start_id, THREAD);
 414   }
 415 
 416   static void check_wk_pre_link_klasses() NOT_DEBUG_RETURN;
 417 
 418 public:
 419   #define WK_KLASS_DECLARE(name, symbol, option) \
 420     static Klass* name() { return check_klass_##option(_well_known_klasses[WK_KLASS_ENUM_NAME(name)]); } \
 421     static Klass** name##_addr() {                                                                       \
 422       return &SystemDictionary::_well_known_klasses[SystemDictionary::WK_KLASS_ENUM_NAME(name)];           \
 423     }
 424   WK_KLASSES_DO(WK_KLASS_DECLARE);
 425   #undef WK_KLASS_DECLARE
 426 
 427   static Klass* well_known_klass(WKID id) {
 428     assert(id >= (int)FIRST_WKID && id < (int)WKID_LIMIT, "oob");
 429     return _well_known_klasses[id];
 430   }
 431 
 432   static Klass** well_known_klass_addr(WKID id) {
 433     assert(id >= (int)FIRST_WKID && id < (int)WKID_LIMIT, "oob");
 434     return &_well_known_klasses[id];
 435   }
 436 
 437   // Local definition for direct access to the private array:
 438   #define WK_KLASS(name) _well_known_klasses[SystemDictionary::WK_KLASS_ENUM_NAME(name)]
 439 
 440   static Klass* box_klass(BasicType t) {
 441     assert((uint)t < T_VOID+1, "range check");
 442     return check_klass(_box_klasses[t]);
 443   }
 444   static BasicType box_klass_type(Klass* k);  // inverse of box_klass
 445 
 446   // methods returning lazily loaded klasses
 447   // The corresponding method to load the class must be called before calling them.
 448   static Klass* abstract_ownable_synchronizer_klass() { return check_klass(_abstract_ownable_synchronizer_klass); }
 449 
 450   static void load_abstract_ownable_synchronizer_klass(TRAPS);
 451 
 452 private:
 453   // Tells whether ClassLoader.loadClassInternal is present
 454   static bool has_loadClassInternal()       { return _has_loadClassInternal; }
 455 
 456   // Returns the class loader data to be used when looking up/updating the
 457   // system dictionary.
 458   static ClassLoaderData *class_loader_data(Handle class_loader) {
 459     return ClassLoaderData::class_loader_data(class_loader());
 460   }
 461 
 462 public:
 463   // Tells whether ClassLoader.checkPackageAccess is present
 464   static bool has_checkPackageAccess()      { return _has_checkPackageAccess; }
 465 
 466   static bool Class_klass_loaded()          { return WK_KLASS(Class_klass) != NULL; }
 467   static bool Cloneable_klass_loaded()      { return WK_KLASS(Cloneable_klass) != NULL; }
 468   static bool Object_klass_loaded()         { return WK_KLASS(Object_klass) != NULL; }
 469   static bool ClassLoader_klass_loaded()    { return WK_KLASS(ClassLoader_klass) != NULL; }
 470 
 471   // Returns default system loader
 472   static oop java_system_loader();
 473 
 474   // Compute the default system loader
 475   static void compute_java_system_loader(TRAPS);
 476 
 477   // Register a new class loader
 478   static ClassLoaderData* register_loader(Handle class_loader);
 479 private:
 480   // Mirrors for primitive classes (created eagerly)
 481   static oop check_mirror(oop m) {
 482     assert(m != NULL, "mirror not initialized");
 483     return m;
 484   }
 485 
 486 public:
 487   // Note:  java_lang_Class::primitive_type is the inverse of java_mirror
 488 
 489   // Check class loader constraints
 490   static bool add_loader_constraint(Symbol* name, Handle loader1,
 491                                     Handle loader2, TRAPS);
 492   static char* check_signature_loaders(Symbol* signature, Handle loader1,
 493                                        Handle loader2, bool is_method, TRAPS);
 494 
 495   // JSR 292
 496   // find a java.lang.invoke.MethodHandle.invoke* method for a given signature
 497   // (asks Java to compute it if necessary, except in a compiler thread)
 498   static methodHandle find_method_handle_invoker(Symbol* name,
 499                                                  Symbol* signature,
 500                                                  KlassHandle accessing_klass,
 501                                                  Handle *appendix_result,
 502                                                  Handle *method_type_result,
 503                                                  TRAPS);
 504   // for a given signature, find the internal MethodHandle method (linkTo* or invokeBasic)
 505   // (does not ask Java, since this is a low-level intrinsic defined by the JVM)
 506   static methodHandle find_method_handle_intrinsic(vmIntrinsics::ID iid,
 507                                                    Symbol* signature,
 508                                                    TRAPS);
 509   // find a java.lang.invoke.MethodType object for a given signature
 510   // (asks Java to compute it if necessary, except in a compiler thread)
 511   static Handle    find_method_handle_type(Symbol* signature,
 512                                            KlassHandle accessing_klass,
 513                                            TRAPS);
 514 
 515   // ask Java to compute a java.lang.invoke.MethodHandle object for a given CP entry
 516   static Handle    link_method_handle_constant(KlassHandle caller,
 517                                                int ref_kind, //e.g., JVM_REF_invokeVirtual
 518                                                KlassHandle callee,
 519                                                Symbol* name,
 520                                                Symbol* signature,
 521                                                TRAPS);
 522 
 523   // ask Java to create a dynamic call site, while linking an invokedynamic op
 524   static methodHandle find_dynamic_call_site_invoker(KlassHandle caller,
 525                                                      Handle bootstrap_method,
 526                                                      Symbol* name,
 527                                                      Symbol* type,
 528                                                      Handle *appendix_result,
 529                                                      Handle *method_type_result,
 530                                                      TRAPS);
 531 
 532   // Utility for printing loader "name" as part of tracing constraints
 533   static const char* loader_name(oop loader) {
 534     return ((loader) == NULL ? "<bootloader>" :
 535             InstanceKlass::cast((loader)->klass())->name()->as_C_string() );
 536   }
 537   static const char* loader_name(ClassLoaderData* loader_data) {
 538     return (loader_data->is_the_null_class_loader_data() ? "<bootloader>" :
 539             InstanceKlass::cast((loader_data->class_loader())->klass())->name()->as_C_string() );
 540   }
 541 
 542   // Record the error when the first attempt to resolve a reference from a constant
 543   // pool entry to a class fails.
 544   static void add_resolution_error(constantPoolHandle pool, int which, Symbol* error);
 545   static void delete_resolution_error(ConstantPool* pool);
 546   static Symbol* find_resolution_error(constantPoolHandle pool, int which);
 547 
 548  private:
 549 
 550   enum Constants {
 551     _loader_constraint_size = 107,                     // number of entries in constraint table
 552     _resolution_error_size  = 107,                     // number of entries in resolution error table
 553     _invoke_method_size     = 139,                     // number of entries in invoke method table
 554     _nof_buckets            = 1009,                    // number of buckets in hash table for placeholders
 555     _old_default_sdsize     = 1009,                    // backward compat for system dictionary size
 556     _prime_array_size       = 8,                       // array of primes for system dictionary size
 557     _average_depth_goal     = 3                        // goal for lookup length
 558   };
 559 
 560 
 561   // Static variables
 562 
 563   // hashtable sizes for system dictionary to allow growth
 564   // prime numbers for system dictionary size
 565   static int                     _sdgeneration;
 566   static const int               _primelist[_prime_array_size];
 567 
 568   // Hashtable holding loaded classes.
 569   static Dictionary*            _dictionary;
 570 
 571   // Hashtable holding placeholders for classes being loaded.
 572   static PlaceholderTable*       _placeholders;
 573 
 574   // Hashtable holding classes from the shared archive.
 575   static Dictionary*             _shared_dictionary;
 576 
 577   // Monotonically increasing counter which grows with
 578   // _number_of_classes as well as hot-swapping and breakpoint setting
 579   // and removal.
 580   static int                     _number_of_modifications;
 581 
 582   // Lock object for system class loader
 583   static oop                     _system_loader_lock_obj;
 584 
 585   // Constraints on class loaders
 586   static LoaderConstraintTable*  _loader_constraints;
 587 
 588   // Resolution errors
 589   static ResolutionErrorTable*   _resolution_errors;
 590 
 591   // Invoke methods (JSR 292)
 592   static SymbolPropertyTable*    _invoke_method_table;
 593 
 594 public:
 595   // for VM_CounterDecay iteration support
 596   friend class CounterDecay;
 597   static Klass* try_get_next_class();
 598 
 599 private:
 600   static void validate_protection_domain(instanceKlassHandle klass,
 601                                          Handle class_loader,
 602                                          Handle protection_domain, TRAPS);
 603 
 604   friend class VM_PopulateDumpSharedSpace;
 605   friend class TraversePlaceholdersClosure;
 606   static Dictionary*         dictionary() { return _dictionary; }
 607   static Dictionary*         shared_dictionary() { return _shared_dictionary; }
 608   static PlaceholderTable*   placeholders() { return _placeholders; }
 609   static LoaderConstraintTable* constraints() { return _loader_constraints; }
 610   static ResolutionErrorTable* resolution_errors() { return _resolution_errors; }
 611   static SymbolPropertyTable* invoke_method_table() { return _invoke_method_table; }
 612 
 613   // Basic loading operations
 614   static Klass* resolve_instance_class_or_null(Symbol* class_name, Handle class_loader, Handle protection_domain, TRAPS);
 615   static Klass* resolve_array_class_or_null(Symbol* class_name, Handle class_loader, Handle protection_domain, TRAPS);
 616   static instanceKlassHandle handle_parallel_super_load(Symbol* class_name, Symbol* supername, Handle class_loader, Handle protection_domain, Handle lockObject, TRAPS);
 617   // Wait on SystemDictionary_lock; unlocks lockObject before
 618   // waiting; relocks lockObject with correct recursion count
 619   // after waiting, but before reentering SystemDictionary_lock
 620   // to preserve lock order semantics.
 621   static void double_lock_wait(Handle lockObject, TRAPS);
 622   static void define_instance_class(instanceKlassHandle k, TRAPS);
 623   static instanceKlassHandle find_or_define_instance_class(Symbol* class_name,
 624                                                 Handle class_loader,
 625                                                 instanceKlassHandle k, TRAPS);
 626   static instanceKlassHandle load_shared_class(Symbol* class_name,
 627                                                Handle class_loader, TRAPS);
 628   static instanceKlassHandle load_shared_class(instanceKlassHandle ik,
 629                                                Handle class_loader, TRAPS);
 630   static instanceKlassHandle load_instance_class(Symbol* class_name, Handle class_loader, TRAPS);
 631   static Handle compute_loader_lock_object(Handle class_loader, TRAPS);
 632   static void check_loader_lock_contention(Handle loader_lock, TRAPS);
 633   static bool is_parallelCapable(Handle class_loader);
 634   static bool is_parallelDefine(Handle class_loader);
 635 
 636   static Klass* find_shared_class(Symbol* class_name);
 637 
 638   // Setup link to hierarchy
 639   static void add_to_hierarchy(instanceKlassHandle k, TRAPS);
 640 
 641 private:
 642   // We pass in the hashtable index so we can calculate it outside of
 643   // the SystemDictionary_lock.
 644 
 645   // Basic find on loaded classes
 646   static Klass* find_class(int index, unsigned int hash,
 647                              Symbol* name, ClassLoaderData* loader_data);
 648   static Klass* find_class(Symbol* class_name, ClassLoaderData* loader_data);
 649 
 650   // Basic find on classes in the midst of being loaded
 651   static Symbol* find_placeholder(Symbol* name, ClassLoaderData* loader_data);
 652 
 653   // Updating entry in dictionary
 654   // Add a completely loaded class
 655   static void add_klass(int index, Symbol* class_name,
 656                         ClassLoaderData* loader_data, KlassHandle obj);
 657 
 658   // Add a placeholder for a class being loaded
 659   static void add_placeholder(int index,
 660                               Symbol* class_name,
 661                               ClassLoaderData* loader_data);
 662   static void remove_placeholder(int index,
 663                                  Symbol* class_name,
 664                                  ClassLoaderData* loader_data);
 665 
 666   // Performs cleanups after resolve_super_or_fail. This typically needs
 667   // to be called on failure.
 668   // Won't throw, but can block.
 669   static void resolution_cleanups(Symbol* class_name,
 670                                   ClassLoaderData* loader_data,
 671                                   TRAPS);
 672 
 673   // Initialization
 674   static void initialize_preloaded_classes(TRAPS);
 675 
 676   // Class loader constraints
 677   static void check_constraints(int index, unsigned int hash,
 678                                 instanceKlassHandle k, Handle loader,
 679                                 bool defining, TRAPS);
 680   static void update_dictionary(int d_index, unsigned int d_hash,
 681                                 int p_index, unsigned int p_hash,
 682                                 instanceKlassHandle k, Handle loader,
 683                                 TRAPS);
 684 
 685   // Variables holding commonly used klasses (preloaded)
 686   static Klass* _well_known_klasses[];
 687 
 688   // Lazily loaded klasses
 689   static Klass* volatile _abstract_ownable_synchronizer_klass;
 690 
 691   // table of box klasses (int_klass, etc.)
 692   static Klass* _box_klasses[T_VOID+1];
 693 
 694   static oop  _java_system_loader;
 695 
 696   static bool _has_loadClassInternal;
 697   static bool _has_checkPackageAccess;
 698 };
 699 
 700 #endif // SHARE_VM_CLASSFILE_SYSTEMDICTIONARY_HPP