[PATCH] D74989: [LoopTerminology] Loop Simplify Form

[Stefanos Baziotis via Phabricator via llvm-commits]

baziotis updated this revision to Diff 246322.
baziotis added a comment.

- Link from one to the other in LoopSimplify.h and LoopTerminology.rst


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D74989/new/

https://reviews.llvm.org/D74989

Files:
  llvm/docs/LoopTerminology.rst
  llvm/include/llvm/Transforms/Utils/LoopSimplify.h


Index: llvm/include/llvm/Transforms/Utils/LoopSimplify.h
===================================================================
--- llvm/include/llvm/Transforms/Utils/LoopSimplify.h
+++ llvm/include/llvm/Transforms/Utils/LoopSimplify.h
@@ -8,7 +8,8 @@
 //
 // This pass performs several transformations to transform natural loops into a
 // simpler form, which makes subsequent analyses and transformations simpler and
-// more effective.
+// more effective. A summary of this pass is documented in
+// https://llvm.org/docs/LoopTerminology.html#loop-simplify-form
 //
 // Loop pre-header insertion guarantees that there is a single, non-critical
 // entry edge from outside of the loop to the loop header.  This simplifies a
Index: llvm/docs/LoopTerminology.rst
===================================================================
--- llvm/docs/LoopTerminology.rst
+++ llvm/docs/LoopTerminology.rst
@@ -144,7 +144,19 @@
 Loop Simplify Form
 ==================
 
-TBD
+The Loop Simplify Form is a canonical form that makes
+several analyses and transformations simpler and more effective.
+This loop is ensured by the LoopSimplify (`-loop-simplify`) pass
+and is automatically added by the pass managers when scheduling
+a LoopPass. This pass is implemented in
+`LoopInfo.h http://llvm.org/doxygen/LoopSimplify_8h_source.html`_.
+When it is successful, the loop has:
+
+* A preheader.
+* A single backedge (which implies that there is a single latch).
+* Dedicated exits. That is, no exit block for the loop
+  has a predecessor that is outside the loop. This implies
+  that all exit blocks are dominated by the loop header.
 
 
 Loop Closed SSA (LCSSA)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D74989.246322.patch
Type: text/x-patch
Size: 1651 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200224/797aebb5/attachment.bin>