1ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev//=-- lsan_common.h -------------------------------------------------------===// 2ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// 3ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// The LLVM Compiler Infrastructure 4ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// 5ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// This file is distributed under the University of Illinois Open Source 6ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// License. See LICENSE.TXT for details. 7ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// 8ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev//===----------------------------------------------------------------------===// 9ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// 10ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// This file is a part of LeakSanitizer. 11ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Private LSan header. 12ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// 13ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev//===----------------------------------------------------------------------===// 14ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 15ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#ifndef LSAN_COMMON_H 16ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#define LSAN_COMMON_H 17ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 18ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev#include "sanitizer_common/sanitizer_allocator.h" 19ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#include "sanitizer_common/sanitizer_common.h" 20ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#include "sanitizer_common/sanitizer_internal_defs.h" 219bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev#include "sanitizer_common/sanitizer_platform.h" 22ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#include "sanitizer_common/sanitizer_symbolizer.h" 23ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 242d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#if SANITIZER_LINUX && defined(__x86_64__) && (SANITIZER_WORDSIZE == 64) 259bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev#define CAN_SANITIZE_LEAKS 1 269bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev#else 279bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev#define CAN_SANITIZE_LEAKS 0 289bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev#endif 299bdf7802d403b53baee3433ddddc220f457e039cSergey Matveev 30ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevnamespace __lsan { 31ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 32ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Chunk tags. 33ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevenum ChunkTag { 34ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev kDirectlyLeaked = 0, // default 35ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev kIndirectlyLeaked = 1, 365e719a705666988781b9735d62cafc808ade60e2Sergey Matveev kReachable = 2, 37b3b46dad13a2111a51fb1a67f36c8b633410e9b7Sergey Matveev kIgnored = 3 38ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev}; 39ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 40ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevstruct Flags { 41ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr pointer_alignment() const { 42ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev return use_unaligned ? 1 : sizeof(uptr); 43ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev } 44ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 45b3b46dad13a2111a51fb1a67f36c8b633410e9b7Sergey Matveev // Print addresses of leaked objects after main leak report. 46b3b46dad13a2111a51fb1a67f36c8b633410e9b7Sergey Matveev bool report_objects; 47b3b46dad13a2111a51fb1a67f36c8b633410e9b7Sergey Matveev // Aggregate two objects into one leak if this many stack frames match. If 48ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev // zero, the entire stack trace must match. 49ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev int resolution; 50ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev // The number of leaks reported. 51ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev int max_leaks; 52969b529914f5bc17e4810076dccbaadf563d584cSergey Matveev // If nonzero kill the process with this exit code upon finding leaks. 53969b529914f5bc17e4810076dccbaadf563d584cSergey Matveev int exitcode; 542d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines // Print matched suppressions after leak checking. 552d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines bool print_suppressions; 56b33cfeb6004d3a93e6d35749c14db0190c6c2b4cSergey Matveev // Suppressions file name. 57b33cfeb6004d3a93e6d35749c14db0190c6c2b4cSergey Matveev const char* suppressions; 58ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 59ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // Flags controlling the root set of reachable memory. 60ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // Global variables (.data and .bss). 61ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev bool use_globals; 62ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // Thread stacks. 63ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev bool use_stacks; 64ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // Thread registers. 65ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev bool use_registers; 66ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // TLS and thread-specific storage. 67ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev bool use_tls; 682d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines // Regions added via __lsan_register_root_region(). 692d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines bool use_root_regions; 70ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev 71ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev // Consider unaligned pointers valid. 72ebe3a3608be122e799e264931f9cecf4cbc84eddSergey Matveev bool use_unaligned; 732d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines // Consider pointers found in poisoned memory to be valid. 742d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines bool use_poisoned; 75cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev 76ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev // Debug logging. 77ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev bool log_pointers; 78ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev bool log_threads; 79ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev}; 80ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 81ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevextern Flags lsan_flags; 82ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevinline Flags *flags() { return &lsan_flags; } 83ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 84ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevstruct Leak { 852d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines u32 id; 86ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr hit_count; 87ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr total_size; 88ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev u32 stack_trace_id; 89ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev bool is_directly_leaked; 90b33cfeb6004d3a93e6d35749c14db0190c6c2b4cSergey Matveev bool is_suppressed; 91ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev}; 92ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 932d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hinesstruct LeakedObject { 942d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines u32 leak_id; 952d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines uptr addr; 962d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines uptr size; 972d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines}; 982d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 99ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Aggregates leaks by stack trace prefix. 100ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevclass LeakReport { 101ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev public: 1022d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines LeakReport() : next_id_(0), leaks_(1), leaked_objects_(1) {} 1032d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void AddLeakedChunk(uptr chunk, u32 stack_trace_id, uptr leaked_size, 1042d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines ChunkTag tag); 1052d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void ReportTopLeaks(uptr max_leaks); 1066c3634b1d5eeb0bffea01df10caa7168c48c8c5dSergey Matveev void PrintSummary(); 1072d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void ApplySuppressions(); 1082d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines uptr UnsuppressedLeakCount(); 1092d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 1102d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 111ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev private: 1122d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void PrintReportForLeak(uptr index); 1132d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void PrintLeakedObjectsForLeak(uptr index); 1142d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 1152d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines u32 next_id_; 116a64d4359902f1f64992aedfe10d8882ae7c66f40Alexey Samsonov InternalMmapVector<Leak> leaks_; 1172d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines InternalMmapVector<LeakedObject> leaked_objects_; 118ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev}; 119ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 120dbeb48d34bb6447c33a0ef99aaf9ba36f7f4b852Alexey Samsonovtypedef InternalMmapVector<uptr> Frontier; 121dbeb48d34bb6447c33a0ef99aaf9ba36f7f4b852Alexey Samsonov 122ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Platform-specific functions. 123ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid InitializePlatformSpecificModules(); 124dbeb48d34bb6447c33a0ef99aaf9ba36f7f4b852Alexey Samsonovvoid ProcessGlobalRegions(Frontier *frontier); 125dbeb48d34bb6447c33a0ef99aaf9ba36f7f4b852Alexey Samsonovvoid ProcessPlatformSpecificAllocations(Frontier *frontier); 126ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 127a64d4359902f1f64992aedfe10d8882ae7c66f40Alexey Samsonovvoid ScanRangeForPointers(uptr begin, uptr end, 128dbeb48d34bb6447c33a0ef99aaf9ba36f7f4b852Alexey Samsonov Frontier *frontier, 129ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev const char *region_type, ChunkTag tag); 130ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 131cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveevenum IgnoreObjectResult { 132cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev kIgnoreObjectSuccess, 133cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev kIgnoreObjectAlreadyIgnored, 134cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev kIgnoreObjectInvalid 135cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev}; 136cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev 137200afbd8ba4904241c1ebcef4fa79d739ca01f73Sergey Matveev// Functions called from the parent tool. 138200afbd8ba4904241c1ebcef4fa79d739ca01f73Sergey Matveevvoid InitCommonLsan(); 139200afbd8ba4904241c1ebcef4fa79d739ca01f73Sergey Matveevvoid DoLeakCheck(); 140200afbd8ba4904241c1ebcef4fa79d739ca01f73Sergey Matveevbool DisabledInThisThread(); 141200afbd8ba4904241c1ebcef4fa79d739ca01f73Sergey Matveev 1422d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// Special case for "new T[0]" where T is a type with DTOR. 1432d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// new T[0] will allocate one word for the array size (0) and store a pointer 1442d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// to the end of allocated chunk. 1452d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hinesinline bool IsSpecialCaseOfOperatorNew0(uptr chunk_beg, uptr chunk_size, 1462d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines uptr addr) { 1472d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines return chunk_size == sizeof(uptr) && chunk_beg + chunk_size == addr && 1482d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines *reinterpret_cast<uptr *>(chunk_beg) == 0; 1492d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines} 1502d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 151ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// The following must be implemented in the parent tool. 152ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 153ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveevvoid ForEachChunk(ForEachChunkCallback callback, void *arg); 154ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev// Returns the address range occupied by the global allocator object. 155ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid GetAllocatorGlobalRange(uptr *begin, uptr *end); 156ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Wrappers for allocator's ForceLock()/ForceUnlock(). 157ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid LockAllocator(); 158ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid UnlockAllocator(); 1592d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// Returns true if [addr, addr + sizeof(void *)) is poisoned. 1602d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hinesbool WordIsPoisoned(uptr addr); 161ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Wrappers for ThreadRegistry access. 162ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid LockThreadRegistry(); 163ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevvoid UnlockThreadRegistry(); 164ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevbool GetThreadRangesLocked(uptr os_id, uptr *stack_begin, uptr *stack_end, 165ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr *tls_begin, uptr *tls_end, 166ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr *cache_begin, uptr *cache_end); 167c519335c2d6d32acaac32c0595f08a05081567e7Sergey Matveevvoid ForEachExtraStackRange(uptr os_id, RangeIteratorCallback callback, 168c519335c2d6d32acaac32c0595f08a05081567e7Sergey Matveev void *arg); 169c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// If called from the main thread, updates the main thread's TID in the thread 170c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// registry. We need this to handle processes that fork() without a subsequent 171c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// exec(), which invalidates the recorded TID. To update it, we must call 172c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// gettid() from the main thread. Our solution is to call this function before 173c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// leak checking and also before every call to pthread_create() (to handle cases 174c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveev// where leak checking is initiated from a non-main thread). 175c6ac98d7fcc81768b2ef7ddc785c27e3fc1bdef6Sergey Matveevvoid EnsureMainThreadIDIsCorrect(); 176ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev// If p points into a chunk that has been allocated to the user, returns its 177ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev// user-visible address. Otherwise, returns 0. 178ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveevuptr PointsIntoChunk(void *p); 179ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev// Returns address of user-visible chunk contained in this allocator chunk. 180ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveevuptr GetUserBegin(uptr chunk); 181cd571e07fd1179383188c70338fa0dc1c452cb19Sergey Matveev// Helper for __lsan_ignore_object(). 182cd571e07fd1179383188c70338fa0dc1c452cb19Sergey MatveevIgnoreObjectResult IgnoreObjectLocked(const void *p); 183ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev// Wrapper for chunk metadata operations. 184ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveevclass LsanMetadata { 185ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev public: 186ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev // Constructor accepts address of user-visible chunk. 187ac78d0087281e9b40bb043f827fbde8c05c6505aSergey Matveev explicit LsanMetadata(uptr chunk); 188ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev bool allocated() const; 189ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev ChunkTag tag() const; 190ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev void set_tag(ChunkTag value); 191ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev uptr requested_size() const; 192ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev u32 stack_trace_id() const; 193ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev private: 194ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev void *metadata_; 195ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev}; 196ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 197ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev} // namespace __lsan 198ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev 1999fbfd96608070eb71e11fbfe42ec9e84016429aeAlexey Samsonovextern "C" { 2003c80c6c574850106481f82b9e23d1c728458d4a9Timur IskhodzhanovSANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 2013c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanovint __lsan_is_turned_off(); 2023c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov 2033c80c6c574850106481f82b9e23d1c728458d4a9Timur IskhodzhanovSANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 2043c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanovconst char *__lsan_default_suppressions(); 2059fbfd96608070eb71e11fbfe42ec9e84016429aeAlexey Samsonov} // extern "C" 2069fbfd96608070eb71e11fbfe42ec9e84016429aeAlexey Samsonov 207ab0f74438abd73342a9d09e1d8b687461cf18da1Sergey Matveev#endif // LSAN_COMMON_H 208