<div dir="ltr">Thanks!<div><br></div><div>-- Sean Silva</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Nov 24, 2015 at 5:13 PM, Xinliang David Li via llvm-commits <span dir="ltr"><<a href="mailto:llvm-commits@lists.llvm.org" target="_blank">llvm-commits@lists.llvm.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Author: davidxl<br>
Date: Tue Nov 24 19:13:44 2015<br>
New Revision: 254051<br>
<br>
URL: <a href="http://llvm.org/viewvc/llvm-project?rev=254051&view=rev" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project?rev=254051&view=rev</a><br>
Log:<br>
Add missing documentation. (NFC)<br>
<br>
Modified:<br>
    llvm/trunk/include/llvm/ProfileData/InstrProf.h<br>
<br>
Modified: llvm/trunk/include/llvm/ProfileData/InstrProf.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/ProfileData/InstrProf.h?rev=254051&r1=254050&r2=254051&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/ProfileData/InstrProf.h?rev=254051&r1=254050&r2=254051&view=diff</a><br>
==============================================================================<br>
--- llvm/trunk/include/llvm/ProfileData/InstrProf.h (original)<br>
+++ llvm/trunk/include/llvm/ProfileData/InstrProf.h Tue Nov 24 19:13:44 2015<br>
@@ -545,15 +545,34 @@ typedef struct ValueProfData {<br>
   ValueProfRecord *getFirstValueProfRecord();<br>
 } ValueProfData;<br>
<br>
+/* The closure is designed to abstact away two types of value profile data:<br>
+ *  - InstrProfRecord which is the primary data structure used to<br>
+ *    represent profile data in host tools (reader, writer, and profile-use)<br>
+ * - value profile runtime data structure suitable to be used by C<br>
+ *    runtime library.<br>
+ *<br>
+ * Both sources of data need to serialize to disk/memory-buffer in common<br>
+ * format: ValueProfData. The abstraction allows compiler-rt's raw profiler<br>
+ * writer to share * the same code with indexed profile writer.<br>
+ *<br>
+ * For documentation of the member methods below, refer to corresponding methods<br>
+ * in class InstrProfRecord.<br>
+ */<br>
 typedef struct ValueProfRecordClosure {<br>
   void *Record;<br>
   uint32_t (*GetNumValueKinds)(void *Record);<br>
   uint32_t (*GetNumValueSites)(void *Record, uint32_t VKind);<br>
   uint32_t (*GetNumValueData)(void *Record, uint32_t VKind);<br>
   uint32_t (*GetNumValueDataForSite)(void *R, uint32_t VK, uint32_t S);<br>
-  uint64_t (*RemapValueData)(uint64_t Value);<br>
-  void (*GetValueForSite)(InstrProfValueData Dst[], void *R, uint32_t K,<br>
-                          uint32_t S);<br>
+<br>
+  /* After extracting the value profile data from the value profile record,<br>
+   * this method is used to map the in-memory value to on-disk value. If<br>
+   * the method is null, value will be written out untranslated.<br>
+   */<br>
+  uint64_t (*RemapValueData)(uint32_t, uint64_t Value);<br>
+  void (*GetValueForSite)(InstrProfValueData *Dst, void *R, uint32_t K,<br>
+                          uint32_t S, uint64_t (*Mapper)(uint32_t, uint64_t));<br>
+<br>
   ValueProfData *(*AllocateValueProfData)(size_t TotalSizeInBytes);<br>
 } ValueProfRecordClosure;<br>
<br>
<br>
<br>
_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@lists.llvm.org">llvm-commits@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-commits" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-commits</a><br>
</blockquote></div><br></div>