aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Analysis
diff options
context:
space:
mode:
authorArnold Schwaighofer <aschwaighofer@apple.com>2013-03-05 16:53:24 +0000
committerArnold Schwaighofer <aschwaighofer@apple.com>2013-03-05 16:53:24 +0000
commit1c9bdf1e5e4b128206e1699c1bb82457118601e4 (patch)
treeff08ba4e0b441f7fb9907c3aac9f72f200356ed2 /include/llvm/Analysis
parent81ee0f73685f966ea279b01cbb9587c70ad91bed (diff)
downloadexternal_llvm-1c9bdf1e5e4b128206e1699c1bb82457118601e4.zip
external_llvm-1c9bdf1e5e4b128206e1699c1bb82457118601e4.tar.gz
external_llvm-1c9bdf1e5e4b128206e1699c1bb82457118601e4.tar.bz2
Clarify comment for function getObjectSize
Clarify that we mean the object starting at the pointer to the end of the underlying object and not the size of the whole allocated object. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@176491 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Analysis')
-rw-r--r--include/llvm/Analysis/MemoryBuiltins.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/llvm/Analysis/MemoryBuiltins.h b/include/llvm/Analysis/MemoryBuiltins.h
index cc1a882..ba1df00 100644
--- a/include/llvm/Analysis/MemoryBuiltins.h
+++ b/include/llvm/Analysis/MemoryBuiltins.h
@@ -138,7 +138,9 @@ static inline CallInst *isFreeCall(Value *I, const TargetLibraryInfo *TLI) {
//
/// \brief Compute the size of the object pointed by Ptr. Returns true and the
-/// object size in Size if successful, and false otherwise.
+// object size in Size if successful, and false otherwise. In this context, by
+// object we mean the region of memory starting at Ptr to the end of the
+// underlying object pointed to by Ptr.
/// If RoundToAlign is true, then Size is rounded up to the aligment of allocas,
/// byval arguments, and global variables.
bool getObjectSize(const Value *Ptr, uint64_t &Size, const DataLayout *TD,