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