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