1 /*
   2  * Copyright (c) 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_VM_GC_G1_NUMA_HPP
  26 #define SHARE_VM_GC_G1_NUMA_HPP
  27 
  28 #include "memory/allocation.hpp"
  29 #include "runtime/os.hpp"
  30 
  31 class HeapRegion;
  32 
  33 class G1NUMA: public CHeapObj<mtGC> {
  34   // Mapping of available node ids to  0-based index which can be used for
  35   // fast resource management. I.e. for every node id provides a unique value in
  36   // the range from [0, {# of nodes-1}].
  37   // For invalid node id, return UnknownNodeIndex.
  38   uint* _node_id_to_index_map;
  39   // Length of _num_active_node_ids_id to index map.
  40   int _len_node_id_to_index_map;
  41 
  42   // Current active node ids.
  43   int* _node_ids;
  44   // Total number of node ids.
  45   uint _num_active_node_ids;
  46 
  47   // Base address of Java heap
  48   void* _base_address;
  49   // HeapRegion size
  50   size_t _region_size;
  51   // Necessary when touching memory.
  52   size_t _page_size;
  53 
  54   void* base_address() const;
  55   size_t region_size() const;
  56   size_t page_size() const;
  57 
  58   // Returns node index of the given node id.
  59   // Precondition: node_id is an active node id.
  60   inline uint index_of_node_id(int node_id) const;
  61 
  62   // Creates node id and node index mapping table of _node_id_to_index_map.
  63   void init_node_id_to_index_map(const int* node_ids, uint num_node_ids);
  64 
  65   static G1NUMA* _inst;
  66 
  67   G1NUMA();
  68   void initialize(bool use_numa);
  69   void initialize_without_numa();
  70 
  71 public:
  72   static const uint UnknownNodeIndex = UINT_MAX;
  73   static const uint AnyNodeIndex = UnknownNodeIndex - 1;
  74 
  75   static G1NUMA* numa() { return _inst; }
  76 
  77   static G1NUMA* create();
  78 
  79   ~G1NUMA();
  80 
  81   // Set base address of heap, heap region size and page size after those values
  82   //  are determined at G1CollectedHeap::initialize().
  83   void set_region_info(void* base_address, size_t region_size, size_t page_size);
  84 
  85   // Print current active memory node count.
  86   uint num_active_nodes() const;
  87 
  88   bool is_enabled() const;
  89 
  90   int numa_id(int index) const;
  91 
  92   // Returns memory node ids
  93   const int* node_ids() const;
  94 
  95   // Returns node index of current calling thread.
  96   uint index_of_current_thread() const;
  97 
  98   // Returns the preferred index for the given HeapRegion index.
  99   // This assumes that HeapRegions are evenly spit, so we can decide preferred index
 100   // with the given HeapRegion index.
 101   // Result is less than num_active_nodes().
 102   uint preferred_node_index_for_index(uint region_index) const;
 103 
 104   // Retrieve node index of the given address.
 105   // Result is less than num_active_nodes() or is UnknownNodeIndex.
 106   // Precondition: address is in reserved range for heap.
 107   uint index_of_address(HeapWord* address) const;
 108 
 109   // If AlwaysPreTouch is enabled, return actual node index via system call.
 110   // If disabled, return preferred node index of the given heap region.
 111   uint index_for_region(HeapRegion* hr) const;
 112 
 113   // Request the given memory area to be located at the given node index.
 114   void request_memory_on_node(size_t start_page, size_t size_in_pages, uint region_index);
 115 
 116   // Returns maximum search depth which is used to limit heap region search iterations.
 117   // The number of active nodes, page size and heap region size are considered.
 118   uint max_search_depth() const;
 119 };
 120 
 121 #endif // SHARE_VM_GC_G1_NUMA_HPP