[llvm-commits] [poolalloc] r108361 - /poolalloc/trunk/lib/DSA/StdLibPass.cpp

[John Criswell]

Author: criswell
Date: Wed Jul 14 16:22:27 2010
New Revision: 108361

URL: http://llvm.org/viewvc/llvm-project?rev=108361&view=rev
Log:
Added comments.
No functionality changes.

Modified:
    poolalloc/trunk/lib/DSA/StdLibPass.cpp

Modified: poolalloc/trunk/lib/DSA/StdLibPass.cpp
URL: http://llvm.org/viewvc/llvm-project/poolalloc/trunk/lib/DSA/StdLibPass.cpp?rev=108361&r1=108360&r2=108361&view=diff
==============================================================================
--- poolalloc/trunk/lib/DSA/StdLibPass.cpp (original)
+++ poolalloc/trunk/lib/DSA/StdLibPass.cpp Wed Jul 14 16:22:27 2010
@@ -34,12 +34,32 @@
 
 #define numOps 10
 
+//
+// Structure: libAction
+//
+// Description:
+//  Describe how the DSGraph of a function should be built.  Note that for the
+//  boolean arrays of arity numOps, the first element is a flag describing the
+//  return value, and the remaining elements are flags describing the
+//  function's arguments.
+//
 struct libAction {
+  // The return value/arguments that should be marked read.
   bool read[numOps];
+
+  // The return value/arguments that should be marked modified.
   bool write[numOps];
+
+  // The return value/arguments that should be marked as heap.
   bool heap[numOps];
+
+  // Flags whether all arguments should be merged together.
   bool mergeAllArgs;
+
+  // Flags whether the return value should be merged with all arguments.
   bool mergeWithRet;
+
+  // Flags whether the return value and arguments should be folded.
   bool collapse;
 };