[llvm] r254051 - Add missing documentation. (NFC)

[Sean Silva via llvm-commits]

Thanks!

-- Sean Silva

On Tue, Nov 24, 2015 at 5:13 PM, Xinliang David Li via llvm-commits <
llvm-commits at lists.llvm.org> wrote:

> Author: davidxl
> Date: Tue Nov 24 19:13:44 2015
> New Revision: 254051
>
> URL: http://llvm.org/viewvc/llvm-project?rev=254051&view=rev
> Log:
> Add missing documentation. (NFC)
>
> Modified:
>     llvm/trunk/include/llvm/ProfileData/InstrProf.h
>
> Modified: llvm/trunk/include/llvm/ProfileData/InstrProf.h
> URL:
> http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/ProfileData/InstrProf.h?rev=254051&r1=254050&r2=254051&view=diff
>
> ==============================================================================
> --- llvm/trunk/include/llvm/ProfileData/InstrProf.h (original)
> +++ llvm/trunk/include/llvm/ProfileData/InstrProf.h Tue Nov 24 19:13:44
> 2015
> @@ -545,15 +545,34 @@ typedef struct ValueProfData {
>    ValueProfRecord *getFirstValueProfRecord();
>  } ValueProfData;
>
> +/* The closure is designed to abstact away two types of value profile
> data:
> + *  - InstrProfRecord which is the primary data structure used to
> + *    represent profile data in host tools (reader, writer, and
> profile-use)
> + * - value profile runtime data structure suitable to be used by C
> + *    runtime library.
> + *
> + * Both sources of data need to serialize to disk/memory-buffer in common
> + * format: ValueProfData. The abstraction allows compiler-rt's raw
> profiler
> + * writer to share * the same code with indexed profile writer.
> + *
> + * For documentation of the member methods below, refer to corresponding
> methods
> + * in class InstrProfRecord.
> + */
>  typedef struct ValueProfRecordClosure {
>    void *Record;
>    uint32_t (*GetNumValueKinds)(void *Record);
>    uint32_t (*GetNumValueSites)(void *Record, uint32_t VKind);
>    uint32_t (*GetNumValueData)(void *Record, uint32_t VKind);
>    uint32_t (*GetNumValueDataForSite)(void *R, uint32_t VK, uint32_t S);
> -  uint64_t (*RemapValueData)(uint64_t Value);
> -  void (*GetValueForSite)(InstrProfValueData Dst[], void *R, uint32_t K,
> -                          uint32_t S);
> +
> +  /* After extracting the value profile data from the value profile
> record,
> +   * this method is used to map the in-memory value to on-disk value. If
> +   * the method is null, value will be written out untranslated.
> +   */
> +  uint64_t (*RemapValueData)(uint32_t, uint64_t Value);
> +  void (*GetValueForSite)(InstrProfValueData *Dst, void *R, uint32_t K,
> +                          uint32_t S, uint64_t (*Mapper)(uint32_t,
> uint64_t));
> +
>    ValueProfData *(*AllocateValueProfData)(size_t TotalSizeInBytes);
>  } ValueProfRecordClosure;
>
>
>
> _______________________________________________
> llvm-commits mailing list
> llvm-commits at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-commits
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20151124/db569302/attachment.html>