1 /*
   2  * Copyright (c) 2012, 2015, 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_MEMORY_METASPACESHARED_HPP
  26 #define SHARE_VM_MEMORY_METASPACESHARED_HPP
  27 
  28 #include "classfile/compactHashtable.hpp"
  29 #include "memory/allocation.hpp"
  30 #include "memory/memRegion.hpp"
  31 #include "memory/virtualspace.hpp"
  32 #include "utilities/exceptions.hpp"
  33 #include "utilities/macros.hpp"
  34 
  35 #define DEFAULT_VTBL_LIST_SIZE          (17)  // number of entries in the shared space vtable list.
  36 #define DEFAULT_VTBL_VIRTUALS_COUNT     (200) // maximum number of virtual functions
  37 // If virtual functions are added to Metadata,
  38 // this number needs to be increased.  Also,
  39 // SharedMiscCodeSize will need to be increased.
  40 // The following 2 sizes were based on
  41 // MetaspaceShared::generate_vtable_methods()
  42 #define DEFAULT_VTBL_METHOD_SIZE        (16)  // conservative size of the mov1 and jmp instructions
  43 // for the x64 platform
  44 #define DEFAULT_VTBL_COMMON_CODE_SIZE   (1*K) // conservative size of the "common_code" for the x64 platform
  45 
  46 #define DEFAULT_SHARED_READ_WRITE_SIZE  (NOT_LP64(12*M) LP64_ONLY(16*M))
  47 #define MIN_SHARED_READ_WRITE_SIZE      (NOT_LP64(7*M) LP64_ONLY(12*M))
  48 
  49 #define DEFAULT_SHARED_READ_ONLY_SIZE   (NOT_LP64(12*M) LP64_ONLY(16*M))
  50 #define MIN_SHARED_READ_ONLY_SIZE       (NOT_LP64(8*M) LP64_ONLY(9*M))
  51 
  52 // the MIN_SHARED_MISC_DATA_SIZE and MIN_SHARED_MISC_CODE_SIZE estimates are based on
  53 // MetaspaceShared::generate_vtable_methods().
  54 // The minimum size only accounts for the vtable methods. Any size less than the
  55 // minimum required size would cause vm crash when allocating the vtable methods.
  56 #define SHARED_MISC_SIZE_FOR(size)      (DEFAULT_VTBL_VIRTUALS_COUNT*DEFAULT_VTBL_LIST_SIZE*size)
  57 
  58 #define DEFAULT_SHARED_MISC_DATA_SIZE   (NOT_LP64(2*M) LP64_ONLY(4*M))
  59 #define MIN_SHARED_MISC_DATA_SIZE       (SHARED_MISC_SIZE_FOR(sizeof(void*)))
  60 
  61 #define DEFAULT_SHARED_MISC_CODE_SIZE   (120*K)
  62 #define MIN_SHARED_MISC_CODE_SIZE       (SHARED_MISC_SIZE_FOR(sizeof(void*))+SHARED_MISC_SIZE_FOR(DEFAULT_VTBL_METHOD_SIZE)+DEFAULT_VTBL_COMMON_CODE_SIZE)
  63 
  64 #define DEFAULT_COMBINED_SIZE           (DEFAULT_SHARED_READ_WRITE_SIZE+DEFAULT_SHARED_READ_ONLY_SIZE+DEFAULT_SHARED_MISC_DATA_SIZE+DEFAULT_SHARED_MISC_CODE_SIZE)
  65 
  66 // the max size is the MAX size (ie. 0x7FFFFFFF) - the total size of
  67 // the other 3 sections - page size (to avoid overflow in case the final
  68 // size will get aligned up on page size)
  69 #define SHARED_PAGE                     ((size_t)os::vm_page_size())
  70 #define MAX_SHARED_DELTA                (0x7FFFFFFF)
  71 #define MAX_SHARED_READ_WRITE_SIZE      (MAX_SHARED_DELTA-(MIN_SHARED_READ_ONLY_SIZE+MIN_SHARED_MISC_DATA_SIZE+MIN_SHARED_MISC_CODE_SIZE)-SHARED_PAGE)
  72 #define MAX_SHARED_READ_ONLY_SIZE       (MAX_SHARED_DELTA-(MIN_SHARED_READ_WRITE_SIZE+MIN_SHARED_MISC_DATA_SIZE+MIN_SHARED_MISC_CODE_SIZE)-SHARED_PAGE)
  73 #define MAX_SHARED_MISC_DATA_SIZE       (MAX_SHARED_DELTA-(MIN_SHARED_READ_WRITE_SIZE+MIN_SHARED_READ_ONLY_SIZE+MIN_SHARED_MISC_CODE_SIZE)-SHARED_PAGE)
  74 #define MAX_SHARED_MISC_CODE_SIZE       (MAX_SHARED_DELTA-(MIN_SHARED_READ_WRITE_SIZE+MIN_SHARED_READ_ONLY_SIZE+MIN_SHARED_MISC_DATA_SIZE)-SHARED_PAGE)
  75 
  76 #define LargeSharedArchiveSize          (300*M)
  77 #define HugeSharedArchiveSize           (800*M)
  78 #define ReadOnlyRegionPercentage        0.4
  79 #define ReadWriteRegionPercentage       0.55
  80 #define MiscDataRegionPercentage        0.03
  81 #define MiscCodeRegionPercentage        0.02
  82 #define LargeThresholdClassCount        5000
  83 #define HugeThresholdClassCount         40000
  84 
  85 #define SET_ESTIMATED_SIZE(type, region)                              \
  86   Shared ##region## Size  = FLAG_IS_DEFAULT(Shared ##region## Size) ? \
  87     (uintx)(type ## SharedArchiveSize *  region ## RegionPercentage) : Shared ## region ## Size
  88 
  89 class FileMapInfo;
  90 
  91 class MetaspaceSharedStats VALUE_OBJ_CLASS_SPEC {
  92 public:
  93   MetaspaceSharedStats() {
  94     memset(this, 0, sizeof(*this));
  95   }
  96   CompactHashtableStats symbol;
  97   CompactHashtableStats string;
  98 };
  99 
 100 // Class Data Sharing Support
 101 class MetaspaceShared : AllStatic {
 102 
 103   // CDS support
 104   static ReservedSpace* _shared_rs;
 105   static int _max_alignment;
 106   static MetaspaceSharedStats _stats;
 107   static bool _link_classes_made_progress;
 108   static bool _check_classes_made_progress;
 109   static bool _has_error_classes;
 110   static bool _archive_loading_failed;
 111  public:
 112   enum {
 113     vtbl_list_size         = DEFAULT_VTBL_LIST_SIZE,
 114     num_virtuals           = DEFAULT_VTBL_VIRTUALS_COUNT,
 115     vtbl_method_size       = DEFAULT_VTBL_METHOD_SIZE,
 116     vtbl_common_code_size  = DEFAULT_VTBL_COMMON_CODE_SIZE
 117   };
 118 
 119   enum {
 120     ro = 0,  // read-only shared space in the heap
 121     rw = 1,  // read-write shared space in the heap
 122     md = 2,  // miscellaneous data for initializing tables, etc.
 123     mc = 3,  // miscellaneous code - vtable replacement.
 124     max_strings = 2, // max number of string regions in string space
 125     num_non_strings = 4, // number of non-string regions
 126     first_string = num_non_strings, // index of first string region
 127     n_regions = max_strings + num_non_strings // total number of regions
 128   };
 129 
 130   // Accessor functions to save shared space created for metadata, which has
 131   // extra space allocated at the end for miscellaneous data and code.
 132   static void set_max_alignment(int alignment) {
 133     CDS_ONLY(_max_alignment = alignment);
 134   }
 135 
 136   static int max_alignment() {
 137     CDS_ONLY(return _max_alignment);
 138     NOT_CDS(return 0);
 139   }
 140 
 141   static void prepare_for_dumping() NOT_CDS_RETURN;
 142   static void preload_and_dump(TRAPS) NOT_CDS_RETURN;
 143   static int preload_and_dump(const char * class_list_path,
 144                               GrowableArray<Klass*>* class_promote_order,
 145                               TRAPS) NOT_CDS_RETURN_(0);
 146 
 147   static ReservedSpace* shared_rs() {
 148     CDS_ONLY(return _shared_rs);
 149     NOT_CDS(return NULL);
 150   }
 151 
 152   static void set_shared_rs(ReservedSpace* rs) {
 153     CDS_ONLY(_shared_rs = rs;)
 154   }
 155 
 156   static void set_archive_loading_failed() {
 157     _archive_loading_failed = true;
 158   }
 159   static bool map_shared_spaces(FileMapInfo* mapinfo) NOT_CDS_RETURN_(false);
 160   static void initialize_shared_spaces() NOT_CDS_RETURN;
 161   static void fixup_shared_string_regions() NOT_CDS_RETURN;
 162 
 163   // Return true if given address is in the mapped shared space.
 164   static bool is_in_shared_space(const void* p) NOT_CDS_RETURN_(false);
 165 
 166   static bool is_string_region(int idx) NOT_CDS_RETURN_(false);
 167 
 168   static void generate_vtable_methods(void** vtbl_list,
 169                                       void** vtable,
 170                                       char** md_top, char* md_end,
 171                                       char** mc_top, char* mc_end);
 172   static void serialize(SerializeClosure* sc);
 173 
 174   static MetaspaceSharedStats* stats() {
 175     return &_stats;
 176   }
 177 
 178   // JVM/TI RedefineClasses() support:
 179   // Remap the shared readonly space to shared readwrite, private if
 180   // sharing is enabled. Simply returns true if sharing is not enabled
 181   // or if the remapping has already been done by a prior call.
 182   static bool remap_shared_readonly_as_readwrite() NOT_CDS_RETURN_(true);
 183 
 184   static void print_shared_spaces();
 185 
 186   static bool try_link_class(InstanceKlass* ik, TRAPS);
 187   static void link_one_shared_class(Klass* obj, TRAPS);
 188   static void check_one_shared_class(Klass* obj);
 189   static void link_and_cleanup_shared_classes(TRAPS);
 190 
 191   static int count_class(const char* classlist_file);
 192   static void estimate_regions_size() NOT_CDS_RETURN;
 193 };
 194 #endif // SHARE_VM_MEMORY_METASPACESHARED_HPP