[mlir][side effect] refactor(*): Include more precise side effects (#94213)

This patch adds more precise side effects to the current ops with memory
effects, allowing us to determine which OpOperand/OpResult/BlockArgument
the
operation reads or writes, rather than just recording the reading and
writing
of values. This allows for convenient use of precise side effects to
achieve
analysis and optimization.

Related discussions:
https://discourse.llvm.org/t/rfc-add-operandindex-to-sideeffect-instance/79243

Author: cxy-1993

flang/lib/Optimizer/Dialect/FIROps.cpp

@@ -1058,9 +1058,9 @@ void fir::BoxRankOp::getEffects(
     llvm::SmallVectorImpl<
         mlir::SideEffects::EffectInstance<mlir::MemoryEffects::Effect>>
         &effects) {
-  mlir::Value inputBox = getBox();
-  if (fir::isBoxAddress(inputBox.getType()))
-    effects.emplace_back(mlir::MemoryEffects::Read::get(), inputBox,
+  mlir::OpOperand &inputBox = getBoxMutable();
+  if (fir::isBoxAddress(inputBox.get().getType()))
+    effects.emplace_back(mlir::MemoryEffects::Read::get(), &inputBox,
                          mlir::SideEffects::DefaultResource::get());
 }
 
@@ -2901,9 +2901,9 @@ void fir::ReboxAssumedRankOp::getEffects(
     llvm::SmallVectorImpl<
         mlir::SideEffects::EffectInstance<mlir::MemoryEffects::Effect>>
         &effects) {
-  mlir::Value inputBox = getBox();
-  if (fir::isBoxAddress(inputBox.getType()))
-    effects.emplace_back(mlir::MemoryEffects::Read::get(), inputBox,
+  mlir::OpOperand &inputBox = getBoxMutable();
+  if (fir::isBoxAddress(inputBox.get().getType()))
+    effects.emplace_back(mlir::MemoryEffects::Read::get(), &inputBox,
                          mlir::SideEffects::DefaultResource::get());
 }
 

flang/lib/Optimizer/HLFIR/IR/HLFIROps.cpp

@@ -45,7 +45,7 @@ getIntrinsicEffects(mlir::Operation *self,
          "hlfir intrinsic ops only produce 1 result");
   if (mlir::isa<hlfir::ExprType>(self->getResult(0).getType()))
     effects.emplace_back(mlir::MemoryEffects::Allocate::get(),
-                         self->getResult(0),
+                         self->getOpResult(0),
                          mlir::SideEffects::DefaultResource::get());
 
   // read effect if we read from a pointer or refference type
@@ -59,10 +59,10 @@ getIntrinsicEffects(mlir::Operation *self,
   // } to {
   //   hlfir.yield %0#0 : !fir.box<!fir.array<?x?xf32>>
   // }
-  for (mlir::Value operand : self->getOperands()) {
-    mlir::Type opTy = operand.getType();
+  for (mlir::OpOperand &operand : self->getOpOperands()) {
+    mlir::Type opTy = operand.get().getType();
     if (fir::isa_ref_type(opTy) || fir::isa_box_type(opTy))
-      effects.emplace_back(mlir::MemoryEffects::Read::get(), operand,
+      effects.emplace_back(mlir::MemoryEffects::Read::get(), &operand,
                            mlir::SideEffects::DefaultResource::get());
   }
 }

flang/lib/Optimizer/HLFIR/Transforms/ScheduleOrderedAssignments.cpp

@@ -225,14 +225,14 @@ static void gatherMemoryEffects(
 
 /// Return the entity yielded by a region, or a null value if the region
 /// is not terminated by a yield.
-static mlir::Value getYieldedEntity(mlir::Region &region) {
+static mlir::OpOperand *getYieldedEntity(mlir::Region &region) {
   if (region.empty() || region.back().empty())
     return nullptr;
   if (auto yield = mlir::dyn_cast<hlfir::YieldOp>(region.back().back()))
-    return yield.getEntity();
+    return &yield.getEntityMutable();
   if (auto elementalAddr =
           mlir::dyn_cast<hlfir::ElementalAddrOp>(region.back().back()))
-    return elementalAddr.getYieldOp().getEntity();
+    return &elementalAddr.getYieldOp().getEntityMutable();
   return nullptr;
 }
 
@@ -244,7 +244,7 @@ static void gatherAssignEffects(
     hlfir::RegionAssignOp regionAssign,
     bool userDefAssignmentMayOnlyWriteToAssignedVariable,
     llvm::SmallVectorImpl<mlir::MemoryEffects::EffectInstance> &assignEffects) {
-  mlir::Value assignedVar = getYieldedEntity(regionAssign.getLhsRegion());
+  mlir::OpOperand *assignedVar = getYieldedEntity(regionAssign.getLhsRegion());
   assert(assignedVar && "lhs cannot be an empty region");
   assignEffects.emplace_back(mlir::MemoryEffects::Write::get(), assignedVar);
 
@@ -389,8 +389,8 @@ void Scheduler::saveEvaluationIfConflict(mlir::Region &yieldRegion,
   // with a finalizer, or a user defined assignment where the LHS is
   // intent(inout)).
   if (yieldIsImplicitRead) {
-    mlir::Value entity = getYieldedEntity(yieldRegion);
-    if (entity && hlfir::isFortranVariableType(entity.getType()))
+    mlir::OpOperand *entity = getYieldedEntity(yieldRegion);
+    if (entity && hlfir::isFortranVariableType(entity->get().getType()))
       effects.emplace_back(mlir::MemoryEffects::Read::get(), entity);
   }
   if (!leafRegionsMayOnlyRead && anyWrite(effects)) {
@@ -600,9 +600,9 @@ hlfir::buildEvaluationSchedule(hlfir::OrderedAssignmentTreeOpInterface root,
 }
 
 mlir::Value hlfir::SaveEntity::getSavedValue() {
-  mlir::Value saved = getYieldedEntity(*yieldRegion);
+  mlir::OpOperand *saved = getYieldedEntity(*yieldRegion);
   assert(saved && "SaveEntity must contain region terminated by YieldOp");
-  return saved;
+  return saved->get();
 }
 
 //===----------------------------------------------------------------------===//