8354362: Use automatic indentation in CollectedHeap printing

Reviewed-by: stefank, lkorinth, stuefe

Author: jsikstro

src/hotspot/share/gc/epsilon/epsilonHeap.cpp

@@ -37,6 +37,7 @@
 #include "memory/universe.hpp"
 #include "runtime/atomic.hpp"
 #include "runtime/globals.hpp"
+#include "utilities/ostream.hpp"
 
 jint EpsilonHeap::initialize() {
   size_t align = HeapAlignment;
@@ -297,26 +298,18 @@ void EpsilonHeap::object_iterate(ObjectClosure *cl) {
   _space->object_iterate(cl);
 }
 
-void EpsilonHeap::print_on(outputStream *st) const {
+void EpsilonHeap::print_heap_on(outputStream *st) const {
   st->print_cr("Epsilon Heap");
 
+  StreamAutoIndentor indentor(st, 1);
+
   _virtual_space.print_on(st);
 
   if (_space != nullptr) {
     st->print_cr("Allocation space:");
-    _space->print_on(st);
-  }
-
-  MetaspaceUtils::print_on(st);
-}
-
-void EpsilonHeap::print_on_error(outputStream *st) const {
-  print_on(st);
-  st->cr();
 
-  BarrierSet* bs = BarrierSet::barrier_set();
-  if (bs != nullptr) {
-    bs->print_on(st);
+    StreamAutoIndentor indentor(st, 1);
+    _space->print_on(st, "");
   }
 }
 

src/hotspot/share/gc/epsilon/epsilonHeap.hpp

@@ -131,8 +131,8 @@ class EpsilonHeap : public CollectedHeap {
   bool can_load_archived_objects() const override { return true; }
   HeapWord* allocate_loaded_archive_space(size_t size) override;
 
-  void print_on(outputStream* st) const override;
-  void print_on_error(outputStream* st) const override;
+  void print_heap_on(outputStream* st) const override;
+  void print_gc_on(outputStream* st) const override {}
   void print_tracing_info() const override;
   bool print_location(outputStream* st, void* addr) const override;
 

src/hotspot/share/gc/g1/g1CollectedHeap.cpp

@@ -2112,16 +2112,18 @@ void G1CollectedHeap::print_heap_regions() const {
   }
 }
 
-void G1CollectedHeap::print_on(outputStream* st) const {
+void G1CollectedHeap::print_heap_on(outputStream* st) const {
   size_t heap_used = Heap_lock->owned_by_self() ? used() : used_unlocked();
-  st->print(" %-20s", "garbage-first heap");
+  st->print("%-20s", "garbage-first heap");
   st->print(" total reserved %zuK, committed %zuK, used %zuK",
             _hrm.reserved().byte_size()/K, capacity()/K, heap_used/K);
   st->print(" [" PTR_FORMAT ", " PTR_FORMAT ")",
             p2i(_hrm.reserved().start()),
             p2i(_hrm.reserved().end()));
   st->cr();
-  st->print("  region size %zuK, ", G1HeapRegion::GrainBytes / K);
+
+  StreamAutoIndentor indentor(st, 1);
+  st->print("region size %zuK, ", G1HeapRegion::GrainBytes / K);
   uint young_regions = young_regions_count();
   st->print("%u young (%zuK), ", young_regions,
             (size_t) young_regions * G1HeapRegion::GrainBytes / K);
@@ -2131,15 +2133,14 @@ void G1CollectedHeap::print_on(outputStream* st) const {
   st->cr();
   if (_numa->is_enabled()) {
     uint num_nodes = _numa->num_active_nodes();
-    st->print("  remaining free region(s) on each NUMA node: ");
+    st->print("remaining free region(s) on each NUMA node: ");
     const uint* node_ids = _numa->node_ids();
     for (uint node_index = 0; node_index < num_nodes; node_index++) {
       uint num_free_regions = _hrm.num_free_regions(node_index);
       st->print("%u=%u ", node_ids[node_index], num_free_regions);
     }
     st->cr();
   }
-  MetaspaceUtils::print_on(st);
 }
 
 void G1CollectedHeap::print_regions_on(outputStream* st) const {
@@ -2153,15 +2154,16 @@ void G1CollectedHeap::print_regions_on(outputStream* st) const {
 }
 
 void G1CollectedHeap::print_extended_on(outputStream* st) const {
-  print_on(st);
+  print_heap_on(st);
 
   // Print the per-region information.
   st->cr();
   print_regions_on(st);
 }
 
-void G1CollectedHeap::print_on_error(outputStream* st) const {
-  print_extended_on(st);
+void G1CollectedHeap::print_gc_on(outputStream* st) const {
+  // Print the per-region information.
+  print_regions_on(st);
   st->cr();
 
   BarrierSet* bs = BarrierSet::barrier_set();
@@ -2171,7 +2173,7 @@ void G1CollectedHeap::print_on_error(outputStream* st) const {
 
   if (_cm != nullptr) {
     st->cr();
-    _cm->print_on_error(st);
+    _cm->print_on(st);
   }
 }
 

src/hotspot/share/gc/g1/g1CollectedHeap.hpp

@@ -1312,9 +1312,9 @@ class G1CollectedHeap : public CollectedHeap {
   void print_regions_on(outputStream* st) const;
 
 public:
-  void print_on(outputStream* st) const override;
+  void print_heap_on(outputStream* st) const override;
   void print_extended_on(outputStream* st) const;
-  void print_on_error(outputStream* st) const override;
+  void print_gc_on(outputStream* st) const override;
 
   void gc_threads_do(ThreadClosure* tc) const override;
 

src/hotspot/share/gc/g1/g1ConcurrentMark.cpp

@@ -2126,9 +2126,9 @@ void G1ConcurrentMark::threads_do(ThreadClosure* tc) const {
   _concurrent_workers->threads_do(tc);
 }
 
-void G1ConcurrentMark::print_on_error(outputStream* st) const {
+void G1ConcurrentMark::print_on(outputStream* st) const {
   st->print_cr("Marking Bits: (CMBitMap*) " PTR_FORMAT, p2i(mark_bitmap()));
-  _mark_bitmap.print_on_error(st, " Bits: ");
+  _mark_bitmap.print_on(st, " Bits: ");
 }
 
 static ReferenceProcessor* get_cm_oop_closure_ref_processor(G1CollectedHeap* g1h) {

src/hotspot/share/gc/g1/g1ConcurrentMark.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -707,7 +707,7 @@ class G1ConcurrentMark : public CHeapObj<mtGC> {
 
   void threads_do(ThreadClosure* tc) const;
 
-  void print_on_error(outputStream* st) const;
+  void print_on(outputStream* st) const;
 
   // Mark the given object on the marking bitmap if it is below TAMS.
   inline bool mark_in_bitmap(uint worker_id, oop const obj);

src/hotspot/share/gc/parallel/mutableNUMASpace.cpp

@@ -608,17 +608,20 @@ void MutableNUMASpace::print_short_on(outputStream* st) const {
   st->print(")");
 }
 
-void MutableNUMASpace::print_on(outputStream* st) const {
-  MutableSpace::print_on(st);
+void MutableNUMASpace::print_on(outputStream* st, const char* prefix) const {
+  MutableSpace::print_on(st, prefix);
+
+  StreamAutoIndentor indentor(st, 1);
   for (int i = 0; i < lgrp_spaces()->length(); i++) {
     LGRPSpace *ls = lgrp_spaces()->at(i);
-    st->print("    lgrp %u", ls->lgrp_id());
-    ls->space()->print_on(st);
+    FormatBuffer<128> lgrp_message("lgrp %u ", ls->lgrp_id());
+    ls->space()->print_on(st, lgrp_message);
     if (NUMAStats) {
+      StreamAutoIndentor indentor_numa(st, 1);
       for (int i = 0; i < lgrp_spaces()->length(); i++) {
         lgrp_spaces()->at(i)->accumulate_statistics(page_size());
       }
-      st->print("    local/remote/unbiased/uncommitted: %zuK/"
+      st->print("local/remote/unbiased/uncommitted: %zuK/"
                 "%zuK/%zuK/%zuK\n",
                 ls->space_stats()->_local_space / K,
                 ls->space_stats()->_remote_space / K,

src/hotspot/share/gc/parallel/mutableNUMASpace.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -186,7 +186,7 @@ class MutableNUMASpace : public MutableSpace {
   virtual HeapWord* cas_allocate(size_t word_size);
 
   // Debugging
-  virtual void print_on(outputStream* st) const;
+  virtual void print_on(outputStream* st, const char* prefix) const;
   virtual void print_short_on(outputStream* st) const;
   virtual void verify();
 

src/hotspot/share/gc/parallel/mutableSpace.cpp

@@ -232,12 +232,13 @@ void MutableSpace::object_iterate(ObjectClosure* cl) {
 
 void MutableSpace::print_short() const { print_short_on(tty); }
 void MutableSpace::print_short_on( outputStream* st) const {
-  st->print(" space %zuK, %d%% used", capacity_in_bytes() / K,
+  st->print("space %zuK, %d%% used", capacity_in_bytes() / K,
             (int) ((double) used_in_bytes() * 100 / capacity_in_bytes()));
 }
 
-void MutableSpace::print() const { print_on(tty); }
-void MutableSpace::print_on(outputStream* st) const {
+void MutableSpace::print() const { print_on(tty, ""); }
+void MutableSpace::print_on(outputStream* st, const char* prefix) const {
+  st->print("%s", prefix);
   MutableSpace::print_short_on(st);
   st->print_cr(" [" PTR_FORMAT "," PTR_FORMAT "," PTR_FORMAT ")",
                  p2i(bottom()), p2i(top()), p2i(end()));

src/hotspot/share/gc/parallel/mutableSpace.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -138,7 +138,7 @@ class MutableSpace: public CHeapObj<mtGC> {
 
   // Debugging
   virtual void print() const;
-  virtual void print_on(outputStream* st) const;
+  virtual void print_on(outputStream* st, const char* prefix) const;
   virtual void print_short() const;
   virtual void print_short_on(outputStream* st) const;
   virtual void verify();