sanitizer_common.h revision 90629fb8072efc95e46a0cbc641293511fbaba2e
1//===-- sanitizer_common.h --------------------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file is shared between AddressSanitizer and ThreadSanitizer 11// run-time libraries. 12// It declares common functions and classes that are used in both runtimes. 13// Implementation of some functions are provided in sanitizer_common, while 14// others must be defined by run-time library itself. 15//===----------------------------------------------------------------------===// 16#ifndef SANITIZER_COMMON_H 17#define SANITIZER_COMMON_H 18 19#include "sanitizer_internal_defs.h" 20#include "sanitizer_libc.h" 21#include "sanitizer_mutex.h" 22 23namespace __sanitizer { 24struct StackTrace; 25 26// Constants. 27const uptr kWordSize = SANITIZER_WORDSIZE / 8; 28const uptr kWordSizeInBits = 8 * kWordSize; 29 30#if defined(__powerpc__) || defined(__powerpc64__) 31const uptr kCacheLineSize = 128; 32#else 33const uptr kCacheLineSize = 64; 34#endif 35 36const uptr kMaxPathLength = 512; 37 38extern const char *SanitizerToolName; // Can be changed by the tool. 39extern uptr SanitizerVerbosity; 40 41uptr GetPageSize(); 42uptr GetPageSizeCached(); 43uptr GetMmapGranularity(); 44uptr GetMaxVirtualAddress(); 45// Threads 46uptr GetTid(); 47uptr GetThreadSelf(); 48void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top, 49 uptr *stack_bottom); 50void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size, 51 uptr *tls_addr, uptr *tls_size); 52 53// Memory management 54void *MmapOrDie(uptr size, const char *mem_type); 55void UnmapOrDie(void *addr, uptr size); 56void *MmapFixedNoReserve(uptr fixed_addr, uptr size); 57void *MmapFixedOrDie(uptr fixed_addr, uptr size); 58void *Mprotect(uptr fixed_addr, uptr size); 59// Map aligned chunk of address space; size and alignment are powers of two. 60void *MmapAlignedOrDie(uptr size, uptr alignment, const char *mem_type); 61// Used to check if we can map shadow memory to a fixed location. 62bool MemoryRangeIsAvailable(uptr range_start, uptr range_end); 63void FlushUnneededShadowMemory(uptr addr, uptr size); 64 65// InternalScopedBuffer can be used instead of large stack arrays to 66// keep frame size low. 67// FIXME: use InternalAlloc instead of MmapOrDie once 68// InternalAlloc is made libc-free. 69template<typename T> 70class InternalScopedBuffer { 71 public: 72 explicit InternalScopedBuffer(uptr cnt) { 73 cnt_ = cnt; 74 ptr_ = (T*)MmapOrDie(cnt * sizeof(T), "InternalScopedBuffer"); 75 } 76 ~InternalScopedBuffer() { 77 UnmapOrDie(ptr_, cnt_ * sizeof(T)); 78 } 79 T &operator[](uptr i) { return ptr_[i]; } 80 T *data() { return ptr_; } 81 uptr size() { return cnt_ * sizeof(T); } 82 83 private: 84 T *ptr_; 85 uptr cnt_; 86 // Disallow evil constructors. 87 InternalScopedBuffer(const InternalScopedBuffer&); 88 void operator=(const InternalScopedBuffer&); 89}; 90 91// Simple low-level (mmap-based) allocator for internal use. Doesn't have 92// constructor, so all instances of LowLevelAllocator should be 93// linker initialized. 94class LowLevelAllocator { 95 public: 96 // Requires an external lock. 97 void *Allocate(uptr size); 98 private: 99 char *allocated_end_; 100 char *allocated_current_; 101}; 102typedef void (*LowLevelAllocateCallback)(uptr ptr, uptr size); 103// Allows to register tool-specific callbacks for LowLevelAllocator. 104// Passing NULL removes the callback. 105void SetLowLevelAllocateCallback(LowLevelAllocateCallback callback); 106 107// IO 108void RawWrite(const char *buffer); 109bool PrintsToTty(); 110void Printf(const char *format, ...); 111void Report(const char *format, ...); 112void SetPrintfAndReportCallback(void (*callback)(const char *)); 113// Can be used to prevent mixing error reports from different sanitizers. 114extern StaticSpinMutex CommonSanitizerReportMutex; 115void MaybeOpenReportFile(); 116extern fd_t report_fd; 117 118uptr OpenFile(const char *filename, bool write); 119// Opens the file 'file_name" and reads up to 'max_len' bytes. 120// The resulting buffer is mmaped and stored in '*buff'. 121// The size of the mmaped region is stored in '*buff_size', 122// Returns the number of read bytes or 0 if file can not be opened. 123uptr ReadFileToBuffer(const char *file_name, char **buff, 124 uptr *buff_size, uptr max_len); 125// Maps given file to virtual memory, and returns pointer to it 126// (or NULL if the mapping failes). Stores the size of mmaped region 127// in '*buff_size'. 128void *MapFileToMemory(const char *file_name, uptr *buff_size); 129 130// OS 131void DisableCoreDumper(); 132void DumpProcessMap(); 133bool FileExists(const char *filename); 134const char *GetEnv(const char *name); 135bool SetEnv(const char *name, const char *value); 136const char *GetPwd(); 137u32 GetUid(); 138void ReExec(); 139bool StackSizeIsUnlimited(); 140void SetStackSizeLimitInBytes(uptr limit); 141void PrepareForSandboxing(); 142 143void InitTlsSize(); 144uptr GetTlsSize(); 145 146// Other 147void SleepForSeconds(int seconds); 148void SleepForMillis(int millis); 149u64 NanoTime(); 150int Atexit(void (*function)(void)); 151void SortArray(uptr *array, uptr size); 152 153// Exit 154void NORETURN Abort(); 155void NORETURN Die(); 156void NORETURN 157CheckFailed(const char *file, int line, const char *cond, u64 v1, u64 v2); 158 159// Set the name of the current thread to 'name', return true on succees. 160// The name may be truncated to a system-dependent limit. 161bool SanitizerSetThreadName(const char *name); 162// Get the name of the current thread (no more than max_len bytes), 163// return true on succees. name should have space for at least max_len+1 bytes. 164bool SanitizerGetThreadName(char *name, int max_len); 165 166// Specific tools may override behavior of "Die" and "CheckFailed" functions 167// to do tool-specific job. 168typedef void (*DieCallbackType)(void); 169void SetDieCallback(DieCallbackType); 170DieCallbackType GetDieCallback(); 171typedef void (*CheckFailedCallbackType)(const char *, int, const char *, 172 u64, u64); 173void SetCheckFailedCallback(CheckFailedCallbackType callback); 174 175// Construct a one-line string like 176// SanitizerToolName: error_type file:line function 177// and call __sanitizer_report_error_summary on it. 178void ReportErrorSummary(const char *error_type, const char *file, 179 int line, const char *function); 180 181// Math 182#if SANITIZER_WINDOWS && !defined(__clang__) && !defined(__GNUC__) 183extern "C" { 184unsigned char _BitScanForward(unsigned long *index, unsigned long mask); // NOLINT 185unsigned char _BitScanReverse(unsigned long *index, unsigned long mask); // NOLINT 186#if defined(_WIN64) 187unsigned char _BitScanForward64(unsigned long *index, unsigned __int64 mask); // NOLINT 188unsigned char _BitScanReverse64(unsigned long *index, unsigned __int64 mask); // NOLINT 189#endif 190} 191#endif 192 193INLINE uptr MostSignificantSetBitIndex(uptr x) { 194 CHECK_NE(x, 0U); 195 unsigned long up; // NOLINT 196#if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__) 197 up = SANITIZER_WORDSIZE - 1 - __builtin_clzl(x); 198#elif defined(_WIN64) 199 _BitScanReverse64(&up, x); 200#else 201 _BitScanReverse(&up, x); 202#endif 203 return up; 204} 205 206INLINE bool IsPowerOfTwo(uptr x) { 207 return (x & (x - 1)) == 0; 208} 209 210INLINE uptr RoundUpToPowerOfTwo(uptr size) { 211 CHECK(size); 212 if (IsPowerOfTwo(size)) return size; 213 214 uptr up = MostSignificantSetBitIndex(size); 215 CHECK(size < (1ULL << (up + 1))); 216 CHECK(size > (1ULL << up)); 217 return 1UL << (up + 1); 218} 219 220INLINE uptr RoundUpTo(uptr size, uptr boundary) { 221 CHECK(IsPowerOfTwo(boundary)); 222 return (size + boundary - 1) & ~(boundary - 1); 223} 224 225INLINE uptr RoundDownTo(uptr x, uptr boundary) { 226 return x & ~(boundary - 1); 227} 228 229INLINE bool IsAligned(uptr a, uptr alignment) { 230 return (a & (alignment - 1)) == 0; 231} 232 233INLINE uptr Log2(uptr x) { 234 CHECK(IsPowerOfTwo(x)); 235#if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__) 236 return __builtin_ctzl(x); 237#elif defined(_WIN64) 238 unsigned long ret; // NOLINT 239 _BitScanForward64(&ret, x); 240 return ret; 241#else 242 unsigned long ret; // NOLINT 243 _BitScanForward(&ret, x); 244 return ret; 245#endif 246} 247 248// Don't use std::min, std::max or std::swap, to minimize dependency 249// on libstdc++. 250template<class T> T Min(T a, T b) { return a < b ? a : b; } 251template<class T> T Max(T a, T b) { return a > b ? a : b; } 252template<class T> void Swap(T& a, T& b) { 253 T tmp = a; 254 a = b; 255 b = tmp; 256} 257 258// Char handling 259INLINE bool IsSpace(int c) { 260 return (c == ' ') || (c == '\n') || (c == '\t') || 261 (c == '\f') || (c == '\r') || (c == '\v'); 262} 263INLINE bool IsDigit(int c) { 264 return (c >= '0') && (c <= '9'); 265} 266INLINE int ToLower(int c) { 267 return (c >= 'A' && c <= 'Z') ? (c + 'a' - 'A') : c; 268} 269 270#if SANITIZER_WORDSIZE == 64 271# define FIRST_32_SECOND_64(a, b) (b) 272#else 273# define FIRST_32_SECOND_64(a, b) (a) 274#endif 275 276// A low-level vector based on mmap. May incur a significant memory overhead for 277// small vectors. 278// WARNING: The current implementation supports only POD types. 279template<typename T> 280class InternalMmapVector { 281 public: 282 explicit InternalMmapVector(uptr initial_capacity) { 283 CHECK_GT(initial_capacity, 0); 284 capacity_ = initial_capacity; 285 size_ = 0; 286 data_ = (T *)MmapOrDie(capacity_ * sizeof(T), "InternalMmapVector"); 287 } 288 ~InternalMmapVector() { 289 UnmapOrDie(data_, capacity_ * sizeof(T)); 290 } 291 T &operator[](uptr i) { 292 CHECK_LT(i, size_); 293 return data_[i]; 294 } 295 const T &operator[](uptr i) const { 296 CHECK_LT(i, size_); 297 return data_[i]; 298 } 299 void push_back(const T &element) { 300 CHECK_LE(size_, capacity_); 301 if (size_ == capacity_) { 302 uptr new_capacity = RoundUpToPowerOfTwo(size_ + 1); 303 Resize(new_capacity); 304 } 305 data_[size_++] = element; 306 } 307 T &back() { 308 CHECK_GT(size_, 0); 309 return data_[size_ - 1]; 310 } 311 void pop_back() { 312 CHECK_GT(size_, 0); 313 size_--; 314 } 315 uptr size() const { 316 return size_; 317 } 318 const T *data() const { 319 return data_; 320 } 321 uptr capacity() const { 322 return capacity_; 323 } 324 325 private: 326 void Resize(uptr new_capacity) { 327 CHECK_GT(new_capacity, 0); 328 CHECK_LE(size_, new_capacity); 329 T *new_data = (T *)MmapOrDie(new_capacity * sizeof(T), 330 "InternalMmapVector"); 331 internal_memcpy(new_data, data_, size_ * sizeof(T)); 332 T *old_data = data_; 333 data_ = new_data; 334 UnmapOrDie(old_data, capacity_ * sizeof(T)); 335 capacity_ = new_capacity; 336 } 337 // Disallow evil constructors. 338 InternalMmapVector(const InternalMmapVector&); 339 void operator=(const InternalMmapVector&); 340 341 T *data_; 342 uptr capacity_; 343 uptr size_; 344}; 345 346// HeapSort for arrays and InternalMmapVector. 347template<class Container, class Compare> 348void InternalSort(Container *v, uptr size, Compare comp) { 349 if (size < 2) 350 return; 351 // Stage 1: insert elements to the heap. 352 for (uptr i = 1; i < size; i++) { 353 uptr j, p; 354 for (j = i; j > 0; j = p) { 355 p = (j - 1) / 2; 356 if (comp((*v)[p], (*v)[j])) 357 Swap((*v)[j], (*v)[p]); 358 else 359 break; 360 } 361 } 362 // Stage 2: swap largest element with the last one, 363 // and sink the new top. 364 for (uptr i = size - 1; i > 0; i--) { 365 Swap((*v)[0], (*v)[i]); 366 uptr j, max_ind; 367 for (j = 0; j < i; j = max_ind) { 368 uptr left = 2 * j + 1; 369 uptr right = 2 * j + 2; 370 max_ind = j; 371 if (left < i && comp((*v)[max_ind], (*v)[left])) 372 max_ind = left; 373 if (right < i && comp((*v)[max_ind], (*v)[right])) 374 max_ind = right; 375 if (max_ind != j) 376 Swap((*v)[j], (*v)[max_ind]); 377 else 378 break; 379 } 380 } 381} 382 383} // namespace __sanitizer 384 385#endif // SANITIZER_COMMON_H 386