1 /*
   2 * Copyright (c) 2015, 2019, 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_CLASSFILE_KLASSFACTORY_HPP
  26 #define SHARE_CLASSFILE_KLASSFACTORY_HPP
  27 
  28 #include "memory/allocation.hpp"
  29 #include "runtime/handles.hpp"
  30 
  31 class ClassFileStream;
  32 class ClassLoaderData;
  33 class ClassLoadInfo;
  34 template <typename>
  35 class GrowableArray;
  36 class Klass;
  37 class Symbol;
  38 class TempNewSymbol;
  39 
  40 /*
  41  * KlassFactory is an interface to implementations of the following mapping/function:
  42  *
  43  * Summary: create a VM internal runtime representation ("Klass")
  44             from a bytestream (classfile).
  45  *
  46  * Input:  a named bytestream in the Java class file format (see JVMS, chapter 4).
  47  * Output: a VM runtime representation of a Java class
  48  *
  49  * Pre-conditions:
  50  *   a non-NULL ClassFileStream* // the classfile bytestream
  51  *   a non-NULL Symbol*          // the name of the class
  52  *   a non-NULL ClassLoaderData* // the metaspace allocator
  53  *   (no pending exceptions)
  54  *
  55  * Returns:
  56  *   if the returned value is non-NULL, that value is an indirection (pointer/handle)
  57  *   to a Klass. The caller will not have a pending exception.
  58  *
  59  *   On broken invariants and/or runtime errors the returned value will be
  60  *   NULL (or a NULL handle) and the caller *might* now have a pending exception.
  61  *
  62  */
  63 
  64 class KlassFactory : AllStatic {
  65 
  66   // approved clients
  67   friend class ClassLoader;
  68   friend class ClassLoaderExt;
  69   friend class SystemDictionary;
  70 
  71  private:
  72   static InstanceKlass* create_from_stream(ClassFileStream* stream,
  73                                            Symbol* name,
  74                                            ClassLoaderData* loader_data,
  75                                            const ClassLoadInfo& cl_info,
  76                                            TRAPS);
  77  public:
  78   static InstanceKlass* check_shared_class_file_load_hook(
  79                                           InstanceKlass* ik,
  80                                           Symbol* class_name,
  81                                           Handle class_loader,
  82                                           Handle protection_domain,
  83                                           const ClassFileStream *cfs,
  84                                           TRAPS);
  85 };
  86 
  87 #endif // SHARE_CLASSFILE_KLASSFACTORY_HPP