libsanitizer/sanitizer_common/sanitizer_common.h

   1 //===-- sanitizer_common.h --------------------------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   6 //===----------------------------------------------------------------------===//
   7 //
   8 // This file is shared between AddressSanitizer and ThreadSanitizer
   9 // run-time libraries.
  10 // It declares common functions and classes that are used in both runtimes.
  11 // Implementation of some functions are provided in sanitizer_common, while
  12 // others must be defined by run-time library itself.
  13 //===----------------------------------------------------------------------===//
  14 #ifndef SANITIZER_COMMON_H
  15 #define SANITIZER_COMMON_H
  16
  17 #include "sanitizer_internal_defs.h"
  18 #include "sanitizer_libc.h"
  19 #include "sanitizer_mutex.h"
  20
  21 namespace __sanitizer {
  22 struct StackTrace;
  23
  24 // Constants.
  25 const uptr kWordSize = SANITIZER_WORDSIZE / 8;
  26 const uptr kWordSizeInBits = 8 * kWordSize;
  27
  28 #if defined(__powerpc__) || defined(__powerpc64__)
  29 const uptr kCacheLineSize = 128;
  30 #else
  31 const uptr kCacheLineSize = 64;
  32 #endif
  33
  34 const uptr kMaxPathLength = 512;
  35
  36 extern const char *SanitizerToolName;  // Can be changed by the tool.
  37
  38 uptr GetPageSize();
  39 uptr GetPageSizeCached();
  40 uptr GetMmapGranularity();
  41 uptr GetMaxVirtualAddress();
  42 // Threads
  43 uptr GetTid();
  44 uptr GetThreadSelf();
  45 void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
  46                                 uptr *stack_bottom);
  47 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
  48                           uptr *tls_addr, uptr *tls_size);
  49
  50 // Memory management
  51 void *MmapOrDie(uptr size, const char *mem_type);
  52 void UnmapOrDie(void *addr, uptr size);
  53 void *MmapFixedNoReserve(uptr fixed_addr, uptr size);
  54 void *MmapFixedOrDie(uptr fixed_addr, uptr size);
  55 void *Mprotect(uptr fixed_addr, uptr size);
  56 // Map aligned chunk of address space; size and alignment are powers of two.
  57 void *MmapAlignedOrDie(uptr size, uptr alignment, const char *mem_type);
  58 // Used to check if we can map shadow memory to a fixed location.
  59 bool MemoryRangeIsAvailable(uptr range_start, uptr range_end);
  60 void FlushUnneededShadowMemory(uptr addr, uptr size);
  61
  62 // InternalScopedBuffer can be used instead of large stack arrays to
  63 // keep frame size low.
  64 // FIXME: use InternalAlloc instead of MmapOrDie once
  65 // InternalAlloc is made libc-free.
  66 template<typename T>
  67 class InternalScopedBuffer {
  68  public:
  69   explicit InternalScopedBuffer(uptr cnt) {
  70     cnt_ = cnt;
  71     ptr_ = (T*)MmapOrDie(cnt * sizeof(T), "InternalScopedBuffer");
  72   }
  73   ~InternalScopedBuffer() {
  74     UnmapOrDie(ptr_, cnt_ * sizeof(T));
  75   }
  76   T &operator[](uptr i) { return ptr_[i]; }
  77   T *data() { return ptr_; }
  78   uptr size() { return cnt_ * sizeof(T); }
  79
  80  private:
  81   T *ptr_;
  82   uptr cnt_;
  83   // Disallow evil constructors.
  84   InternalScopedBuffer(const InternalScopedBuffer&);
  85   void operator=(const InternalScopedBuffer&);
  86 };
  87
  88 class InternalScopedString : public InternalScopedBuffer<char> {
  89  public:
  90   explicit InternalScopedString(uptr max_length)
  91       : InternalScopedBuffer<char>(max_length), length_(0) {
  92     (*this)[0] = '\0';
  93   }
  94   uptr length() { return length_; }
  95   void clear() {
  96     (*this)[0] = '\0';
  97     length_ = 0;
  98   }
  99   void append(const char *format, ...);
 100
 101  private:
 102   uptr length_;
 103 };
 104
 105 // Simple low-level (mmap-based) allocator for internal use. Doesn't have
 106 // constructor, so all instances of LowLevelAllocator should be
 107 // linker initialized.
 108 class LowLevelAllocator {
 109  public:
 110   // Requires an external lock.
 111   void *Allocate(uptr size);
 112  private:
 113   char *allocated_end_;
 114   char *allocated_current_;
 115 };
 116 typedef void (*LowLevelAllocateCallback)(uptr ptr, uptr size);
 117 // Allows to register tool-specific callbacks for LowLevelAllocator.
 118 // Passing NULL removes the callback.
 119 void SetLowLevelAllocateCallback(LowLevelAllocateCallback callback);
 120
 121 // IO
 122 void RawWrite(const char *buffer);
 123 bool PrintsToTty();
 124 // Caching version of PrintsToTty(). Not thread-safe.
 125 bool PrintsToTtyCached();
 126 void Printf(const char *format, ...);
 127 void Report(const char *format, ...);
 128 void SetPrintfAndReportCallback(void (*callback)(const char *));
 129
 130 // Can be used to prevent mixing error reports from different sanitizers.
 131 extern StaticSpinMutex CommonSanitizerReportMutex;
 132 void MaybeOpenReportFile();
 133 extern fd_t report_fd;
 134 extern bool log_to_file;
 135 extern char report_path_prefix[4096];
 136 extern uptr report_fd_pid;
 137 extern uptr stoptheworld_tracer_pid;
 138 extern uptr stoptheworld_tracer_ppid;
 139
 140 uptr OpenFile(const char *filename, bool write);
 141 // Opens the file 'file_name" and reads up to 'max_len' bytes.
 142 // The resulting buffer is mmaped and stored in '*buff'.
 143 // The size of the mmaped region is stored in '*buff_size',
 144 // Returns the number of read bytes or 0 if file can not be opened.
 145 uptr ReadFileToBuffer(const char *file_name, char **buff,
 146                       uptr *buff_size, uptr max_len);
 147 // Maps given file to virtual memory, and returns pointer to it
 148 // (or NULL if the mapping failes). Stores the size of mmaped region
 149 // in '*buff_size'.
 150 void *MapFileToMemory(const char *file_name, uptr *buff_size);
 151
 152 // Error report formatting.
 153 const char *StripPathPrefix(const char *filepath,
 154                             const char *strip_file_prefix);
 155 void PrintSourceLocation(InternalScopedString *buffer, const char *file,
 156                          int line, int column);
 157 void PrintModuleAndOffset(InternalScopedString *buffer,
 158                           const char *module, uptr offset);
 159
 160 // OS
 161 void DisableCoreDumper();
 162 void DumpProcessMap();
 163 bool FileExists(const char *filename);
 164 const char *GetEnv(const char *name);
 165 bool SetEnv(const char *name, const char *value);
 166 const char *GetPwd();
 167 char *FindPathToBinary(const char *name);
 168 u32 GetUid();
 169 void ReExec();
 170 bool StackSizeIsUnlimited();
 171 void SetStackSizeLimitInBytes(uptr limit);
 172 void PrepareForSandboxing();
 173
 174 void InitTlsSize();
 175 uptr GetTlsSize();
 176
 177 // Other
 178 void SleepForSeconds(int seconds);
 179 void SleepForMillis(int millis);
 180 u64 NanoTime();
 181 int Atexit(void (*function)(void));
 182 void SortArray(uptr *array, uptr size);
 183 // Strip the directories from the module name, return a new string allocated
 184 // with internal_strdup.
 185 char *StripModuleName(const char *module);
 186
 187 // Exit
 188 void NORETURN Abort();
 189 void NORETURN Die();
 190 void NORETURN
 191 CheckFailed(const char *file, int line, const char *cond, u64 v1, u64 v2);
 192
 193 // Set the name of the current thread to 'name', return true on succees.
 194 // The name may be truncated to a system-dependent limit.
 195 bool SanitizerSetThreadName(const char *name);
 196 // Get the name of the current thread (no more than max_len bytes),
 197 // return true on succees. name should have space for at least max_len+1 bytes.
 198 bool SanitizerGetThreadName(char *name, int max_len);
 199
 200 // Specific tools may override behavior of "Die" and "CheckFailed" functions
 201 // to do tool-specific job.
 202 typedef void (*DieCallbackType)(void);
 203 void SetDieCallback(DieCallbackType);
 204 DieCallbackType GetDieCallback();
 205 typedef void (*CheckFailedCallbackType)(const char *, int, const char *,
 206                                        u64, u64);
 207 void SetCheckFailedCallback(CheckFailedCallbackType callback);
 208
 209 // We don't want a summary too long.
 210 const int kMaxSummaryLength = 1024;
 211 // Construct a one-line string:
 212 //   SUMMARY: SanitizerToolName: error_message
 213 // and pass it to __sanitizer_report_error_summary.
 214 void ReportErrorSummary(const char *error_message);
 215 // Same as above, but construct error_message as:
 216 //   error_type: file:line function
 217 void ReportErrorSummary(const char *error_type, const char *file,
 218                         int line, const char *function);
 219 void ReportErrorSummary(const char *error_type, StackTrace *trace);
 220
 221 // Math
 222 #if SANITIZER_WINDOWS && !defined(__clang__) && !defined(__GNUC__)
 223 extern "C" {
 224 unsigned char _BitScanForward(unsigned long *index, unsigned long mask);  // NOLINT
 225 unsigned char _BitScanReverse(unsigned long *index, unsigned long mask);  // NOLINT
 226 #if defined(_WIN64)
 227 unsigned char _BitScanForward64(unsigned long *index, unsigned __int64 mask);  // NOLINT
 228 unsigned char _BitScanReverse64(unsigned long *index, unsigned __int64 mask);  // NOLINT
 229 #endif
 230 }
 231 #endif
 232
 233 INLINE uptr MostSignificantSetBitIndex(uptr x) {
 234   CHECK_NE(x, 0U);
 235   unsigned long up;  // NOLINT
 236 #if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__)
 237   up = SANITIZER_WORDSIZE - 1 - __builtin_clzl(x);
 238 #elif defined(_WIN64)
 239   _BitScanReverse64(&up, x);
 240 #else
 241   _BitScanReverse(&up, x);
 242 #endif
 243   return up;
 244 }
 245
 246 INLINE bool IsPowerOfTwo(uptr x) {
 247   return (x & (x - 1)) == 0;
 248 }
 249
 250 INLINE uptr RoundUpToPowerOfTwo(uptr size) {
 251   CHECK(size);
 252   if (IsPowerOfTwo(size)) return size;
 253
 254   uptr up = MostSignificantSetBitIndex(size);
 255   CHECK(size < (1ULL << (up + 1)));
 256   CHECK(size > (1ULL << up));
 257   return 1UL << (up + 1);
 258 }
 259
 260 INLINE uptr RoundUpTo(uptr size, uptr boundary) {
 261   CHECK(IsPowerOfTwo(boundary));
 262   return (size + boundary - 1) & ~(boundary - 1);
 263 }
 264
 265 INLINE uptr RoundDownTo(uptr x, uptr boundary) {
 266   return x & ~(boundary - 1);
 267 }
 268
 269 INLINE bool IsAligned(uptr a, uptr alignment) {
 270   return (a & (alignment - 1)) == 0;
 271 }
 272
 273 INLINE uptr Log2(uptr x) {
 274   CHECK(IsPowerOfTwo(x));
 275 #if !SANITIZER_WINDOWS || defined(__clang__) || defined(__GNUC__)
 276   return __builtin_ctzl(x);
 277 #elif defined(_WIN64)
 278   unsigned long ret;  // NOLINT
 279   _BitScanForward64(&ret, x);
 280   return ret;
 281 #else
 282   unsigned long ret;  // NOLINT
 283   _BitScanForward(&ret, x);
 284   return ret;
 285 #endif
 286 }
 287
 288 // Don't use std::min, std::max or std::swap, to minimize dependency
 289 // on libstdc++.
 290 template<class T> T Min(T a, T b) { return a < b ? a : b; }
 291 template<class T> T Max(T a, T b) { return a > b ? a : b; }
 292 template<class T> void Swap(T& a, T& b) {
 293   T tmp = a;
 294   a = b;
 295   b = tmp;
 296 }
 297
 298 // Char handling
 299 INLINE bool IsSpace(int c) {
 300   return (c == ' ') || (c == '\n') || (c == '\t') ||
 301          (c == '\f') || (c == '\r') || (c == '\v');
 302 }
 303 INLINE bool IsDigit(int c) {
 304   return (c >= '0') && (c <= '9');
 305 }
 306 INLINE int ToLower(int c) {
 307   return (c >= 'A' && c <= 'Z') ? (c + 'a' - 'A') : c;
 308 }
 309
 310 #if SANITIZER_WORDSIZE == 64
 311 # define FIRST_32_SECOND_64(a, b) (b)
 312 #else
 313 # define FIRST_32_SECOND_64(a, b) (a)
 314 #endif
 315
 316 // A low-level vector based on mmap. May incur a significant memory overhead for
 317 // small vectors.
 318 // WARNING: The current implementation supports only POD types.
 319 template<typename T>
 320 class InternalMmapVector {
 321  public:
 322   explicit InternalMmapVector(uptr initial_capacity) {
 323     capacity_ = Max(initial_capacity, (uptr)1);
 324     size_ = 0;
 325     data_ = (T *)MmapOrDie(capacity_ * sizeof(T), "InternalMmapVector");
 326   }
 327   ~InternalMmapVector() {
 328     UnmapOrDie(data_, capacity_ * sizeof(T));
 329   }
 330   T &operator[](uptr i) {
 331     CHECK_LT(i, size_);
 332     return data_[i];
 333   }
 334   const T &operator[](uptr i) const {
 335     CHECK_LT(i, size_);
 336     return data_[i];
 337   }
 338   void push_back(const T &element) {
 339     CHECK_LE(size_, capacity_);
 340     if (size_ == capacity_) {
 341       uptr new_capacity = RoundUpToPowerOfTwo(size_ + 1);
 342       Resize(new_capacity);
 343     }
 344     data_[size_++] = element;
 345   }
 346   T &back() {
 347     CHECK_GT(size_, 0);
 348     return data_[size_ - 1];
 349   }
 350   void pop_back() {
 351     CHECK_GT(size_, 0);
 352     size_--;
 353   }
 354   uptr size() const {
 355     return size_;
 356   }
 357   const T *data() const {
 358     return data_;
 359   }
 360   uptr capacity() const {
 361     return capacity_;
 362   }
 363
 364   void clear() { size_ = 0; }
 365
 366  private:
 367   void Resize(uptr new_capacity) {
 368     CHECK_GT(new_capacity, 0);
 369     CHECK_LE(size_, new_capacity);
 370     T *new_data = (T *)MmapOrDie(new_capacity * sizeof(T),
 371                                  "InternalMmapVector");
 372     internal_memcpy(new_data, data_, size_ * sizeof(T));
 373     T *old_data = data_;
 374     data_ = new_data;
 375     UnmapOrDie(old_data, capacity_ * sizeof(T));
 376     capacity_ = new_capacity;
 377   }
 378   // Disallow evil constructors.
 379   InternalMmapVector(const InternalMmapVector&);
 380   void operator=(const InternalMmapVector&);
 381
 382   T *data_;
 383   uptr capacity_;
 384   uptr size_;
 385 };
 386
 387 // HeapSort for arrays and InternalMmapVector.
 388 template<class Container, class Compare>
 389 void InternalSort(Container *v, uptr size, Compare comp) {
 390   if (size < 2)
 391     return;
 392   // Stage 1: insert elements to the heap.
 393   for (uptr i = 1; i < size; i++) {
 394     uptr j, p;
 395     for (j = i; j > 0; j = p) {
 396       p = (j - 1) / 2;
 397       if (comp((*v)[p], (*v)[j]))
 398         Swap((*v)[j], (*v)[p]);
 399       else
 400         break;
 401     }
 402   }
 403   // Stage 2: swap largest element with the last one,
 404   // and sink the new top.
 405   for (uptr i = size - 1; i > 0; i--) {
 406     Swap((*v)[0], (*v)[i]);
 407     uptr j, max_ind;
 408     for (j = 0; j < i; j = max_ind) {
 409       uptr left = 2 * j + 1;
 410       uptr right = 2 * j + 2;
 411       max_ind = j;
 412       if (left < i && comp((*v)[max_ind], (*v)[left]))
 413         max_ind = left;
 414       if (right < i && comp((*v)[max_ind], (*v)[right]))
 415         max_ind = right;
 416       if (max_ind != j)
 417         Swap((*v)[j], (*v)[max_ind]);
 418       else
 419         break;
 420     }
 421   }
 422 }
 423
 424 template<class Container, class Value, class Compare>
 425 uptr InternalBinarySearch(const Container &v, uptr first, uptr last,
 426                           const Value &val, Compare comp) {
 427   uptr not_found = last + 1;
 428   while (last >= first) {
 429     uptr mid = (first + last) / 2;
 430     if (comp(v[mid], val))
 431       first = mid + 1;
 432     else if (comp(val, v[mid]))
 433       last = mid - 1;
 434     else
 435       return mid;
 436   }
 437   return not_found;
 438 }
 439
 440 // Represents a binary loaded into virtual memory (e.g. this can be an
 441 // executable or a shared object).
 442 class LoadedModule {
 443  public:
 444   LoadedModule(const char *module_name, uptr base_address);
 445   void addAddressRange(uptr beg, uptr end);
 446   bool containsAddress(uptr address) const;
 447
 448   const char *full_name() const { return full_name_; }
 449   uptr base_address() const { return base_address_; }
 450
 451  private:
 452   struct AddressRange {
 453     uptr beg;
 454     uptr end;
 455   };
 456   char *full_name_;
 457   uptr base_address_;
 458   static const uptr kMaxNumberOfAddressRanges = 6;
 459   AddressRange ranges_[kMaxNumberOfAddressRanges];
 460   uptr n_ranges_;
 461 };
 462
 463 // OS-dependent function that fills array with descriptions of at most
 464 // "max_modules" currently loaded modules. Returns the number of
 465 // initialized modules. If filter is nonzero, ignores modules for which
 466 // filter(full_name) is false.
 467 typedef bool (*string_predicate_t)(const char *);
 468 uptr GetListOfModules(LoadedModule *modules, uptr max_modules,
 469                       string_predicate_t filter);
 470
 471 #if SANITIZER_POSIX
 472 const uptr kPthreadDestructorIterations = 4;
 473 #else
 474 // Unused on Windows.
 475 const uptr kPthreadDestructorIterations = 0;
 476 #endif
 477
 478 // Callback type for iterating over a set of memory ranges.
 479 typedef void (*RangeIteratorCallback)(uptr begin, uptr end, void *arg);
 480 }  // namespace __sanitizer
 481
 482 inline void *operator new(__sanitizer::operator_new_size_type size,
 483                           __sanitizer::LowLevelAllocator &alloc) {
 484   return alloc.Allocate(size);
 485 }
 486
 487 #endif  // SANITIZER_COMMON_H