RFR: 8354362: Use automatic indentation in CollectedHeap printing [v7]

[Stefan Karlsson]

On Thu, 17 Apr 2025 12:15:45 GMT, Joel Sikström <jsikstro at openjdk.org> wrote:

>> Hello,
>> 
>>> This PR only focuses on fixing indentation and re-arranging some callsites. It does *not* change the contents of any output, apart from some (IMO relevant) indentation/whitespace additions.
>> 
>> Currently, the CollectedHeap printing code (print_on and print_on_error, with calls "below") prepends spaces in messages in a way that only makes sense if you write the code and then check the output to see if you've done everything correctly. To make writing and maintaining printing code easy, I propose we move to a system where each printing method, starting at callers of print_on and print_on_error, uses the indentation API in outputStream and does not rely on prepending spaces like is done right now.
>> 
>> What I propose is that any (GC) printing method should not make any assumptions of the indentation level of its caller(s). This means that each function shall:
>> 1. Not prepend any spaces to its printing, and instead expect that the caller(s) should handle any indentation before calling this function.
>> 2. Enforce its own indentation, by enabling auto indentation in its own context and for its "lower level" calls (which is often the desired outcome).
>> 
>> Combining these two rules means that *any* (GC) printing method can be called from anywhere and give sensible output, without (seemingly random) indentation of expectations elsewhere.
>> 
>> I have aggregated calls that print on the same indentation level to the same callsite. This makes it clear where to look in the code and also makes it easier to add/enforce indendation. To this end, I have re-arranged print_on_error so that it never includes print_on. The new system I propose is that print_on and print_on_error can be called separately for different information, which aligns well with having the same callsite for the same indentation. See changes in vmError.cpp for how this is implemented.
>> 
>> Instead of prepending spaces, I use StreamAutoIndentor, defined in ostream.hpp. To make using automatic indentation easier, I've made some changes to StreamAutoIndentor so that it inherits from streamIndentor and also add an *optional* argument to StreamAutoIndentor to apply an indentation. My reasoning for this is that most places that use streamIndentor also want to use StreamAutoIndentor (either immediately or some time before) so that it is automatically applied. A downside of this change is that any previous uses of StreamAutoIndentor now also needs to store an extra int worth of memory. To me, th...
>
> Joel Sikström has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Rename print_on_error() in the remaining call-paths from print_gc_on()

I think this looks good. Not yet a full review, thought, but just wanted to send out my +1 on the changes. I've added a couple of more suggestions.

src/hotspot/share/gc/serial/tenuredGeneration.cpp line 449:

> 447: 
> 448:   StreamAutoIndentor indentor(st, 1);
> 449:   st->print("the  "); _the_space->print_on(st);

Suggestion:

  st->print("the  ");
  _the_space->print_on(st);

src/hotspot/share/gc/z/zPageAllocator.cpp line 1171:

> 1169: }
> 1170: 
> 1171: void ZPartition::print_extended_cache_on(outputStream* st) const {

I would like to suggest that you flip the 'extended' and 'cache' words:
Suggestion:

void ZPartition::print_cache_extended_on(outputStream* st) const {


So, that we have the structure:

print_<what>_on
print_<what>_extended_on

-------------

PR Review: https://git.openjdk.org/jdk/pull/24593#pullrequestreview-2775538728
PR Review Comment: https://git.openjdk.org/jdk/pull/24593#discussion_r2048825842
PR Review Comment: https://git.openjdk.org/jdk/pull/24593#discussion_r2048839661