RFR: 8340786: Introduce Predicate classes with predicate iterators and visitors for simplified walking [v2]

[Christian Hagedorn]

On Tue, 24 Sep 2024 21:18:11 GMT, Christian Hagedorn <chagedorn at openjdk.org> wrote:

>> This patch introduces new predicate classes which implement a new `Predicate` interface. These classes represent the different predicates in the C2 IR. They are used in combination with new predicate iterator and visitors classes to provide an easy way to walk and process predicates in the IR.
>> 
>> ### Predicate Interfaces and Implementing Classes 
>> - `Predicate` interface is implemented by four predicate classes:
>>   - `ParsePredicate` (existing class)
>>   - `RuntimePredicate` (existing and updated class)
>>   - `TemplateAssertionPredicate` (new class)
>>   - `InitializedAssertionPredicate` (new class, renamed old `InitializedAssertionPredicate` class to `InitializedAssertionPredicateCreator`)
>> 
>> ### Predicate Iterator with Visitor classes
>> There is a new `PredicateIterator` class which can be used to iterate through the predicates of a loop. For each predicate, a `PredicateVisitor` can be applied. The user can implement the `PredicateIterator` interface and override the default do-nothing implementations to the specific needs of the code. I've done this for a couple of places in the code by defining new visitors:
>> - `ParsePredicateUsefulMarker`: This visitor marks all Parse Predicates as useful. 
>>   - Replaces the old now retired `ParsePredicateIterator`.
>> - `DominatedPredicates`: This visitor checks the dominance relation to an `early` node when trying to figure out the latest legal placement for a node. The goal is to skip as many predicates as possible to avoid interference with Loop Predication and/or creating a Loop Limit Check Predicate. 
>>   - Replaces the old now retired `PredicateEntryIterator`.
>> - `Predicates::dump()`: Newly added dumping code for the predicates above a loop which uses a new `PredicatePrinter` visitor. This helps debugging issues with predicates.
>> 
>> #### To Be Replaced soon
>> There are a couple of places where we use similar code to walk predicates and apply some transformation/modifications to the IR. The goal is to replace these locations with the new visitors as well. This will incrementally be done with the next couple of PRs.
>> 
>> ### More Information
>> More information about specific classes and changes can be found as code comments and PR comments.
>> 
>> Thanks,
>> Christian
>
> Christian Hagedorn has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix dump_for_loop()

src/hotspot/share/opto/predicates.cpp line 98:

> 96:     return (deopt_reason == Deoptimization::Reason_loop_limit_check ||
> 97:             deopt_reason == Deoptimization::Reason_predicate ||
> 98:             deopt_reason == Deoptimization::Reason_profile_predicate);

extracted to new method `has_valid_uncommon_trap()`

src/hotspot/share/opto/predicates.cpp line 469:

> 467: 
> 468: // Dumps all predicates from the loop to the earliest predicate in a pretty format.
> 469: void Predicates::dump() const {

Example output:

239 OuterStripMinedLoop:
- Loop Limit Check Predicate Block:
  - Parse Predicate: 115 ParsePredicate
  - Runtime Predicate: 276 If
- Profiled Loop Predicate Block:
  - Parse Predicate: 104 ParsePredicate
- Loop Predicate Block:
  - Parse Predicate: 93 ParsePredicate
  - Template Assertion Predicate: 270 RangeCheck
  - Template Assertion Predicate: 260 RangeCheck
  - Runtime Predicate: 253 RangeCheck
  - Runtime Predicate: 283 RangeCheck

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

PR Review Comment: https://git.openjdk.org/jdk/pull/21161#discussion_r1774091984
PR Review Comment: https://git.openjdk.org/jdk/pull/21161#discussion_r1774103468