sanitizer_common.h revision 650c7d44b659ddfb4af471dc2ad79a727b7de939
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(); 110// Caching version of PrintsToTty(). Not thread-safe. 111bool PrintsToTtyCached(); 112void Printf(const char *format, ...); 113void Report(const char *format, ...); 114void SetPrintfAndReportCallback(void (*callback)(const char *)); 115// Can be used to prevent mixing error reports from different sanitizers. 116extern StaticSpinMutex CommonSanitizerReportMutex; 117void MaybeOpenReportFile(); 118extern fd_t report_fd; 119 120uptr OpenFile(const char *filename, bool write); 121// Opens the file 'file_name" and reads up to 'max_len' bytes. 122// The resulting buffer is mmaped and stored in '*buff'. 123// The size of the mmaped region is stored in '*buff_size', 124// Returns the number of read bytes or 0 if file can not be opened. 125uptr ReadFileToBuffer(const char *file_name, char **buff, 126 uptr *buff_size, uptr max_len); 127// Maps given file to virtual memory, and returns pointer to it 128// (or NULL if the mapping failes). Stores the size of mmaped region 129// in '*buff_size'. 130void *MapFileToMemory(const char *file_name, uptr *buff_size); 131 132// OS 133void DisableCoreDumper(); 134void DumpProcessMap(); 135bool FileExists(const char *filename); 136const char *GetEnv(const char *name); 137bool SetEnv(const char *name, const char *value); 138const char *GetPwd(); 139char *FindPathToBinary(const char *name); 140u32 GetUid(); 141void ReExec(); 142bool StackSizeIsUnlimited(); 143void SetStackSizeLimitInBytes(uptr limit); 144void PrepareForSandboxing(); 145 146void InitTlsSize(); 147uptr GetTlsSize(); 148 149// Other 150void SleepForSeconds(int seconds); 151void SleepForMillis(int millis); 152u64 NanoTime(); 153int Atexit(void (*function)(void)); 154void SortArray(uptr *array, uptr size); 155 156// Exit 157void NORETURN Abort(); 158void NORETURN Die(); 159void NORETURN 160CheckFailed(const char *file, int line, const char *cond, u64 v1, u64 v2); 161 162// Set the name of the current thread to 'name', return true on succees. 163// The name may be truncated to a system-dependent limit. 164bool SanitizerSetThreadName(const char *name); 165// Get the name of the current thread (no more than max_len bytes), 166// return true on succees. name should have space for at least max_len+1 bytes. 167bool SanitizerGetThreadName(char *name, int max_len); 168 169// Specific tools may override behavior of "Die" and "CheckFailed" functions 170// to do tool-specific job. 171typedef void (*DieCallbackType)(void); 172void SetDieCallback(DieCallbackType); 173DieCallbackType GetDieCallback(); 174typedef void (*CheckFailedCallbackType)(const char *, int, const char *, 175 u64, u64); 176void SetCheckFailedCallback(CheckFailedCallbackType callback); 177 178// Construct a one-line string like 179// SanitizerToolName: error_type file:line function 180// and call __sanitizer_report_error_summary on it. 181void ReportErrorSummary(const char *error_type, const char *file, 182 int line, const char *function); 183 184// Math 185#if SANITIZER_WINDOWS && !defined(__clang__) && !defined(__GNUC__) 186extern "C" { 187unsigned char _BitScanForward(unsigned long *index, unsigned long mask); // NOLINT 188unsigned char _BitScanReverse(unsigned long *index, unsigned long mask); // NOLINT 189#if defined(_WIN64) 190unsigned char _BitScanForward64(unsigned long *index, unsigned __int64 mask); // NOLINT 191unsigned char _BitScanReverse64(unsigned long *index, unsigned __int64 mask); // NOLINT 192#endif 193} 194#endif 195 196INLINE uptr MostSignificantSetBitIndex(uptr x) { 197 CHECK_NE(x, 0U); 198 unsigned long up; // NOLINT 199#if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__) 200 up = SANITIZER_WORDSIZE - 1 - __builtin_clzl(x); 201#elif defined(_WIN64) 202 _BitScanReverse64(&up, x); 203#else 204 _BitScanReverse(&up, x); 205#endif 206 return up; 207} 208 209INLINE bool IsPowerOfTwo(uptr x) { 210 return (x & (x - 1)) == 0; 211} 212 213INLINE uptr RoundUpToPowerOfTwo(uptr size) { 214 CHECK(size); 215 if (IsPowerOfTwo(size)) return size; 216 217 uptr up = MostSignificantSetBitIndex(size); 218 CHECK(size < (1ULL << (up + 1))); 219 CHECK(size > (1ULL << up)); 220 return 1UL << (up + 1); 221} 222 223INLINE uptr RoundUpTo(uptr size, uptr boundary) { 224 CHECK(IsPowerOfTwo(boundary)); 225 return (size + boundary - 1) & ~(boundary - 1); 226} 227 228INLINE uptr RoundDownTo(uptr x, uptr boundary) { 229 return x & ~(boundary - 1); 230} 231 232INLINE bool IsAligned(uptr a, uptr alignment) { 233 return (a & (alignment - 1)) == 0; 234} 235 236INLINE uptr Log2(uptr x) { 237 CHECK(IsPowerOfTwo(x)); 238#if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__) 239 return __builtin_ctzl(x); 240#elif defined(_WIN64) 241 unsigned long ret; // NOLINT 242 _BitScanForward64(&ret, x); 243 return ret; 244#else 245 unsigned long ret; // NOLINT 246 _BitScanForward(&ret, x); 247 return ret; 248#endif 249} 250 251// Don't use std::min, std::max or std::swap, to minimize dependency 252// on libstdc++. 253template<class T> T Min(T a, T b) { return a < b ? a : b; } 254template<class T> T Max(T a, T b) { return a > b ? a : b; } 255template<class T> void Swap(T& a, T& b) { 256 T tmp = a; 257 a = b; 258 b = tmp; 259} 260 261// Char handling 262INLINE bool IsSpace(int c) { 263 return (c == ' ') || (c == '\n') || (c == '\t') || 264 (c == '\f') || (c == '\r') || (c == '\v'); 265} 266INLINE bool IsDigit(int c) { 267 return (c >= '0') && (c <= '9'); 268} 269INLINE int ToLower(int c) { 270 return (c >= 'A' && c <= 'Z') ? (c + 'a' - 'A') : c; 271} 272 273#if SANITIZER_WORDSIZE == 64 274# define FIRST_32_SECOND_64(a, b) (b) 275#else 276# define FIRST_32_SECOND_64(a, b) (a) 277#endif 278 279// A low-level vector based on mmap. May incur a significant memory overhead for 280// small vectors. 281// WARNING: The current implementation supports only POD types. 282template<typename T> 283class InternalMmapVector { 284 public: 285 explicit InternalMmapVector(uptr initial_capacity) { 286 CHECK_GT(initial_capacity, 0); 287 capacity_ = initial_capacity; 288 size_ = 0; 289 data_ = (T *)MmapOrDie(capacity_ * sizeof(T), "InternalMmapVector"); 290 } 291 ~InternalMmapVector() { 292 UnmapOrDie(data_, capacity_ * sizeof(T)); 293 } 294 T &operator[](uptr i) { 295 CHECK_LT(i, size_); 296 return data_[i]; 297 } 298 const T &operator[](uptr i) const { 299 CHECK_LT(i, size_); 300 return data_[i]; 301 } 302 void push_back(const T &element) { 303 CHECK_LE(size_, capacity_); 304 if (size_ == capacity_) { 305 uptr new_capacity = RoundUpToPowerOfTwo(size_ + 1); 306 Resize(new_capacity); 307 } 308 data_[size_++] = element; 309 } 310 T &back() { 311 CHECK_GT(size_, 0); 312 return data_[size_ - 1]; 313 } 314 void pop_back() { 315 CHECK_GT(size_, 0); 316 size_--; 317 } 318 uptr size() const { 319 return size_; 320 } 321 const T *data() const { 322 return data_; 323 } 324 uptr capacity() const { 325 return capacity_; 326 } 327 328 private: 329 void Resize(uptr new_capacity) { 330 CHECK_GT(new_capacity, 0); 331 CHECK_LE(size_, new_capacity); 332 T *new_data = (T *)MmapOrDie(new_capacity * sizeof(T), 333 "InternalMmapVector"); 334 internal_memcpy(new_data, data_, size_ * sizeof(T)); 335 T *old_data = data_; 336 data_ = new_data; 337 UnmapOrDie(old_data, capacity_ * sizeof(T)); 338 capacity_ = new_capacity; 339 } 340 // Disallow evil constructors. 341 InternalMmapVector(const InternalMmapVector&); 342 void operator=(const InternalMmapVector&); 343 344 T *data_; 345 uptr capacity_; 346 uptr size_; 347}; 348 349// HeapSort for arrays and InternalMmapVector. 350template<class Container, class Compare> 351void InternalSort(Container *v, uptr size, Compare comp) { 352 if (size < 2) 353 return; 354 // Stage 1: insert elements to the heap. 355 for (uptr i = 1; i < size; i++) { 356 uptr j, p; 357 for (j = i; j > 0; j = p) { 358 p = (j - 1) / 2; 359 if (comp((*v)[p], (*v)[j])) 360 Swap((*v)[j], (*v)[p]); 361 else 362 break; 363 } 364 } 365 // Stage 2: swap largest element with the last one, 366 // and sink the new top. 367 for (uptr i = size - 1; i > 0; i--) { 368 Swap((*v)[0], (*v)[i]); 369 uptr j, max_ind; 370 for (j = 0; j < i; j = max_ind) { 371 uptr left = 2 * j + 1; 372 uptr right = 2 * j + 2; 373 max_ind = j; 374 if (left < i && comp((*v)[max_ind], (*v)[left])) 375 max_ind = left; 376 if (right < i && comp((*v)[max_ind], (*v)[right])) 377 max_ind = right; 378 if (max_ind != j) 379 Swap((*v)[j], (*v)[max_ind]); 380 else 381 break; 382 } 383 } 384} 385 386template<class Container, class Value, class Compare> 387uptr InternalBinarySearch(const Container &v, uptr first, uptr last, 388 const Value &val, Compare comp) { 389 uptr not_found = last + 1; 390 while (last >= first) { 391 uptr mid = (first + last) / 2; 392 if (comp(v[mid], val)) 393 first = mid + 1; 394 else if (comp(val, v[mid])) 395 last = mid - 1; 396 else 397 return mid; 398 } 399 return not_found; 400} 401 402} // namespace __sanitizer 403 404#endif // SANITIZER_COMMON_H 405