1 /*
   2  * Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2018, 2020 SAP SE. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef SHARE_MEMORY_METASPACE_METASPACEREPORT_HPP
  27 #define SHARE_MEMORY_METASPACE_METASPACEREPORT_HPP
  28 
  29 #include "memory/allocation.hpp"
  30 
  31 namespace metaspace {
  32 
  33 class MetaspaceReporter : public AllStatic {
  34 public:
  35 
  36   // Flags for print_report().
  37   enum ReportFlag {
  38     // Show usage by class loader.
  39     rf_show_loaders                 = (1 << 0),
  40     // Breaks report down by chunk type (small, medium, ...).
  41     rf_break_down_by_chunktype      = (1 << 1),
  42     // Breaks report down by space type (anonymous, reflection, ...).
  43     rf_break_down_by_spacetype      = (1 << 2),
  44     // Print details about the underlying virtual spaces.
  45     rf_show_vslist                  = (1 << 3),
  46     // If show_loaders: show loaded classes for each loader.
  47     rf_show_classes                 = (1 << 4)
  48   };
  49 
  50   // This will print out a basic metaspace usage report but
  51   // unlike print_report() is guaranteed not to lock or to walk the CLDG.
  52   static void print_basic_report(outputStream* st, size_t scale);
  53 
  54   // Prints a report about the current metaspace state.
  55   // Optional parts can be enabled via flags.
  56   // Function will walk the CLDG and will lock the expand lock; if that is not
  57   // convenient, use print_basic_report() instead.
  58   static void print_report(outputStream* out, size_t scale = 0, int flags = 0);
  59 
  60 };
  61 
  62 } // namespace metaspace
  63 
  64 #endif // SHARE_MEMORY_METASPACE_METASPACEREPORT_HPP