[flang-commits] [flang] [mlir][Interfaces] `LoopLikeOpInterface`: Add helper to get yielded values (PR #67305)

[Matthias Springer via flang-commits]

================
@@ -20,6 +20,19 @@ def LoopLikeOpInterface : OpInterface<"LoopLikeOpInterface"> {
     Contains helper functions to query properties and perform transformations
     of a loop. Operations that implement this interface will be considered by
     loop-invariant code motion.
+
+    Loop-carried variables can be exposed through this interface. There are
+    3 components to a loop-carried variable.
+    - The "region iter_arg" is the block argument of the entry block that
+      represents the loop-carried variable in each iteration.
+    - The "init value" is an operand of the loop op that serves as the initial
+      region iter_arg value for the first iteration (if any).
+    - The "yielded" value is the value that is forwarded from one iteration to
+      serve as the region iter_arg of the next iteration.
+
+    If one of the respective interface methods is implemented, so must the other
+    two. The interface verifier ensures that the number of types of the region
----------------
matthias-springer wrote:

I could change rename `getInits`, `getYieldedValues`, `getRegionIterArgs` to `getLoopInits`, `getLoopYieldedValues`, `getLoopRegionIterArgs` and change the return value to `std::optional<...>`. Then a subset of the methods can be implemented. The renaming is needed because ops such as `scf::WhileOp` already have an auto-generated `getInits` function (that matches with the implementation that the interface expects).


https://github.com/llvm/llvm-project/pull/67305