diff options
author | Fangrui Song <maskray@google.com> | 2018-10-31 00:31:02 +0000 |
---|---|---|
committer | Fangrui Song <maskray@google.com> | 2018-10-31 00:31:02 +0000 |
commit | c0bdded1a2bc3032ab5414817ca3b1bb53f52948 (patch) | |
tree | a852ffbd194b402aed06cc2b653329a46ee4c6f2 | |
parent | 377f9f9b3f65b530887d6bf0042799d1765b42d6 (diff) | |
download | bcm5719-llvm-c0bdded1a2bc3032ab5414817ca3b1bb53f52948.tar.gz bcm5719-llvm-c0bdded1a2bc3032ab5414817ca3b1bb53f52948.zip |
Don't duplicate function/class name at the beginning of the comment. NFC
llvm-svn: 345681
-rw-r--r-- | llvm/include/llvm/Transforms/Utils/Cloning.h | 36 |
1 files changed, 16 insertions, 20 deletions
diff --git a/llvm/include/llvm/Transforms/Utils/Cloning.h b/llvm/include/llvm/Transforms/Utils/Cloning.h index e4d6053b70b..d7dce53fc76 100644 --- a/llvm/include/llvm/Transforms/Utils/Cloning.h +++ b/llvm/include/llvm/Transforms/Utils/Cloning.h @@ -49,7 +49,6 @@ class ProfileSummaryInfo; class ReturnInst; /// Return an exact copy of the specified module -/// std::unique_ptr<Module> CloneModule(const Module &M); std::unique_ptr<Module> CloneModule(const Module &M, ValueToValueMapTy &VMap); @@ -61,17 +60,15 @@ std::unique_ptr<Module> CloneModule(const Module &M, ValueToValueMapTy &VMap, function_ref<bool(const GlobalValue *)> ShouldCloneDefinition); -/// ClonedCodeInfo - This struct can be used to capture information about code +/// This struct can be used to capture information about code /// being cloned, while it is being cloned. struct ClonedCodeInfo { - /// ContainsCalls - This is set to true if the cloned code contains a normal - /// call instruction. + /// This is set to true if the cloned code contains a normal call instruction. bool ContainsCalls = false; - /// ContainsDynamicAllocas - This is set to true if the cloned code contains - /// a 'dynamic' alloca. Dynamic allocas are allocas that are either not in - /// the entry block or they are in the entry block but are not a constant - /// size. + /// This is set to true if the cloned code contains a 'dynamic' alloca. + /// Dynamic allocas are allocas that are either not in the entry block or they + /// are in the entry block but are not a constant size. bool ContainsDynamicAllocas = false; /// All cloned call sites that have operand bundles attached are appended to @@ -82,7 +79,7 @@ struct ClonedCodeInfo { ClonedCodeInfo() = default; }; -/// CloneBasicBlock - Return a copy of the specified basic block, but without +/// Return a copy of the specified basic block, but without /// embedding the block into a particular function. The block returned is an /// exact copy of the specified basic block, without any remapping having been /// performed. Because of this, this is only suitable for applications where @@ -109,13 +106,12 @@ struct ClonedCodeInfo { /// If you would like to collect additional information about the cloned /// function, you can specify a ClonedCodeInfo object with the optional fifth /// parameter. -/// BasicBlock *CloneBasicBlock(const BasicBlock *BB, ValueToValueMapTy &VMap, const Twine &NameSuffix = "", Function *F = nullptr, ClonedCodeInfo *CodeInfo = nullptr, DebugInfoFinder *DIFinder = nullptr); -/// CloneFunction - Return a copy of the specified function and add it to that +/// Return a copy of the specified function and add it to that /// function's module. Also, any references specified in the VMap are changed /// to refer to their mapped value instead of the original one. If any of the /// arguments to the function are in the VMap, the arguments are deleted from @@ -154,7 +150,7 @@ void CloneAndPruneIntoFromInst(Function *NewFunc, const Function *OldFunc, const char *NameSuffix = "", ClonedCodeInfo *CodeInfo = nullptr); -/// CloneAndPruneFunctionInto - This works exactly like CloneFunctionInto, +/// This works exactly like CloneFunctionInto, /// except that it does some simple constant prop and DCE on the fly. The /// effect of this is to copy significantly less code in cases where (for /// example) a function call with constant arguments is inlined, and those @@ -172,8 +168,8 @@ void CloneAndPruneFunctionInto(Function *NewFunc, const Function *OldFunc, ClonedCodeInfo *CodeInfo = nullptr, Instruction *TheCall = nullptr); -/// InlineFunctionInfo - This class captures the data input to the -/// InlineFunction call, and records the auxiliary results produced by it. +/// This class captures the data input to the InlineFunction call, and records +/// the auxiliary results produced by it. class InlineFunctionInfo { public: explicit InlineFunctionInfo(CallGraph *cg = nullptr, @@ -185,19 +181,19 @@ public: : CG(cg), GetAssumptionCache(GetAssumptionCache), PSI(PSI), CallerBFI(CallerBFI), CalleeBFI(CalleeBFI) {} - /// CG - If non-null, InlineFunction will update the callgraph to reflect the + /// If non-null, InlineFunction will update the callgraph to reflect the /// changes it makes. CallGraph *CG; std::function<AssumptionCache &(Function &)> *GetAssumptionCache; ProfileSummaryInfo *PSI; BlockFrequencyInfo *CallerBFI, *CalleeBFI; - /// StaticAllocas - InlineFunction fills this in with all static allocas that - /// get copied into the caller. + /// InlineFunction fills this in with all static allocas that get copied into + /// the caller. SmallVector<AllocaInst *, 4> StaticAllocas; - /// InlinedCalls - InlineFunction fills this in with callsites that were - /// inlined from the callee. This is only filled in if CG is non-null. + /// InlineFunction fills this in with callsites that were inlined from the + /// callee. This is only filled in if CG is non-null. SmallVector<WeakTrackingVH, 8> InlinedCalls; /// All of the new call sites inlined into the caller. @@ -214,7 +210,7 @@ public: } }; -/// InlineFunction - This function inlines the called function into the basic +/// This function inlines the called function into the basic /// block of the caller. This returns false if it is not possible to inline /// this call. The program is still in a well defined state if this occurs /// though. |