8351568: Improve source code documentation for PhaseCFG::insert_anti_dependences

Reviewed-by: rcastanedalo, chagedorn

Author: Daniel Lundén

src/hotspot/share/adlc/output_h.cpp

@@ -1962,7 +1962,7 @@ void ArchDesc::declareClasses(FILE *fp) {
     else if( instr->is_ideal_box() ) {
       // BoxNode provides the address of a stack slot.
       // Define its bottom type to be TypeRawPtr::BOTTOM instead of TypePtr::BOTTOM
-      // This prevent s insert_anti_dependencies from complaining. It will
+      // This prevents raise_above_anti_dependences from complaining. It will
       // complain if it sees that the pointer base is TypePtr::BOTTOM since
       // it doesn't understand what that might alias.
       fprintf(fp,"  const Type            *bottom_type() const { return TypeRawPtr::BOTTOM; } // Box?\n");

src/hotspot/share/opto/block.hpp

@@ -210,7 +210,7 @@ class Block : public CFGElement {
   uint _freg_pressure;
   uint _fhrp_index;
 
-  // Mark and visited bits for an LCA calculation in insert_anti_dependences.
+  // Mark and visited bits for an LCA calculation in raise_above_anti_dependences.
   // Since they hold unique node indexes, they do not need reinitialization.
   node_idx_t _raise_LCA_mark;
   void    set_raise_LCA_mark(node_idx_t x)    { _raise_LCA_mark = x; }
@@ -487,10 +487,10 @@ class PhaseCFG : public Phase {
   // Used when building the CFG and creating end nodes for blocks.
   MachNode* _goto;
 
-  Block* insert_anti_dependences(Block* LCA, Node* load, bool verify = false);
+  Block* raise_above_anti_dependences(Block* LCA, Node* load, bool verify = false);
   void verify_anti_dependences(Block* LCA, Node* load) const {
     assert(LCA == get_block_for_node(load), "should already be scheduled");
-    const_cast<PhaseCFG*>(this)->insert_anti_dependences(LCA, load, true);
+    const_cast<PhaseCFG*>(this)->raise_above_anti_dependences(LCA, load, true);
   }
 
   bool move_to_next(Block* bx, uint b_index);

src/hotspot/share/opto/gcm.cpp

@@ -491,7 +491,7 @@ void PhaseCFG::implicit_null_check(Block* block, Node *proj, Node *val, int allo
       if (n->needs_anti_dependence_check() &&
           n->in(LoadNode::Memory) == best->in(StoreNode::Memory)) {
         // Found anti-dependent load
-        insert_anti_dependences(block, n);
+        raise_above_anti_dependences(block, n);
         if (C->failing()) {
           return;
         }
@@ -1363,7 +1363,7 @@ void PhaseCFG::call_catch_cleanup(Block* block) {
       sb->insert_node(clone, 1);
       map_node_to_block(clone, sb);
       if (clone->needs_anti_dependence_check()) {
-        insert_anti_dependences(sb, clone);
+        raise_above_anti_dependences(sb, clone);
         if (C->failing()) {
           return;
         }

src/hotspot/share/opto/lcm.cpp

@@ -24,7 +24,7 @@
 /*
  * @test
  * @bug 8333258
- * @summary C2: high memory usage in PhaseCFG::insert_anti_dependences()
+ * @summary C2: high memory usage in PhaseCFG::raise_above_anti_dependences()
  * @run main/othervm -XX:CompileOnly=TestAntiDependenciesHighMemUsage::test1 -Xcomp TestAntiDependenciesHighMemUsage
  */
 

test/hotspot/jtreg/compiler/codegen/TestAntiDependenciesHighMemUsage.java

@@ -24,7 +24,7 @@
 /*
  * @test
  * @bug 8333258
- * @summary C2: high memory usage in PhaseCFG::insert_anti_dependences()
+ * @summary C2: high memory usage in PhaseCFG::raise_above_anti_dependences()
  * @run main/othervm -XX:CompileOnly=TestAntiDependenciesHighMemUsage2::test1 -XX:-ClipInlining
  *                   -XX:-BackgroundCompilation -XX:-TieredCompilation -XX:-UseOnStackReplacement TestAntiDependenciesHighMemUsage2
  */

test/hotspot/jtreg/compiler/codegen/TestAntiDependenciesHighMemUsage2.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 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 @@ int test3(MyClass obj1, MyClass obj2) {
     }
 
     // Same as test2 but with reference to inner loop induction variable 'j' and different order of instructions.
-    // Triggers an assert in PhaseCFG::insert_anti_dependences if loop strip mining verification is disabled:
+    // Triggers an assert in PhaseCFG::raise_above_anti_dependences if loop strip mining verification is disabled:
     // assert(!LCA_orig->dominates(pred_block) || early->dominates(pred_block)) failed: early is high enough
     int test4(MyClass obj1, MyClass obj2) {
         for (int i = 0; i < 10; ++i) {