contrib/compiler-rt/lib/sanitizer_common/sanitizer_posix.cc

   1 //===-- sanitizer_posix.cc ------------------------------------------------===//
   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 and implements POSIX-specific functions from
  12 // sanitizer_posix.h.
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "sanitizer_platform.h"
  16
  17 #if SANITIZER_POSIX
  18
  19 #include "sanitizer_common.h"
  20 #include "sanitizer_libc.h"
  21 #include "sanitizer_posix.h"
  22 #include "sanitizer_procmaps.h"
  23 #include "sanitizer_stacktrace.h"
  24
  25 #include <errno.h>
  26 #include <fcntl.h>
  27 #include <signal.h>
  28 #include <sys/mman.h>
  29
  30 #if SANITIZER_LINUX
  31 #include <sys/utsname.h>
  32 #endif
  33
  34 #if SANITIZER_LINUX && !SANITIZER_ANDROID
  35 #include <sys/personality.h>
  36 #endif
  37
  38 #if SANITIZER_FREEBSD
  39 // The MAP_NORESERVE define has been removed in FreeBSD 11.x, and even before
  40 // that, it was never implemented.  So just define it to zero.
  41 #undef  MAP_NORESERVE
  42 #define MAP_NORESERVE 0
  43 #endif
  44
  45 namespace __sanitizer {
  46
  47 // ------------- sanitizer_common.h
  48 uptr GetMmapGranularity() {
  49   return GetPageSize();
  50 }
  51
  52 #if SANITIZER_WORDSIZE == 32
  53 // Take care of unusable kernel area in top gigabyte.
  54 static uptr GetKernelAreaSize() {
  55 #if SANITIZER_LINUX && !SANITIZER_X32
  56   const uptr gbyte = 1UL << 30;
  57
  58   // Firstly check if there are writable segments
  59   // mapped to top gigabyte (e.g. stack).
  60   MemoryMappingLayout proc_maps(/*cache_enabled*/true);
  61   uptr end, prot;
  62   while (proc_maps.Next(/*start*/nullptr, &end,
  63                         /*offset*/nullptr, /*filename*/nullptr,
  64                         /*filename_size*/0, &prot)) {
  65     if ((end >= 3 * gbyte)
  66         && (prot & MemoryMappingLayout::kProtectionWrite) != 0)
  67       return 0;
  68   }
  69
  70 #if !SANITIZER_ANDROID
  71   // Even if nothing is mapped, top Gb may still be accessible
  72   // if we are running on 64-bit kernel.
  73   // Uname may report misleading results if personality type
  74   // is modified (e.g. under schroot) so check this as well.
  75   struct utsname uname_info;
  76   int pers = personality(0xffffffffUL);
  77   if (!(pers & PER_MASK)
  78       && uname(&uname_info) == 0
  79       && internal_strstr(uname_info.machine, "64"))
  80     return 0;
  81 #endif  // SANITIZER_ANDROID
  82
  83   // Top gigabyte is reserved for kernel.
  84   return gbyte;
  85 #else
  86   return 0;
  87 #endif  // SANITIZER_LINUX && !SANITIZER_X32
  88 }
  89 #endif  // SANITIZER_WORDSIZE == 32
  90
  91 uptr GetMaxVirtualAddress() {
  92 #if SANITIZER_WORDSIZE == 64
  93 # if defined(__aarch64__) && SANITIZER_IOS && !SANITIZER_IOSSIM
  94   // Ideally, we would derive the upper bound from MACH_VM_MAX_ADDRESS. The
  95   // upper bound can change depending on the device.
  96   return 0x200000000 - 1;
  97 # elif defined(__powerpc64__) || defined(__aarch64__)
  98   // On PowerPC64 we have two different address space layouts: 44- and 46-bit.
  99   // We somehow need to figure out which one we are using now and choose
 100   // one of 0x00000fffffffffffUL and 0x00003fffffffffffUL.
 101   // Note that with 'ulimit -s unlimited' the stack is moved away from the top
 102   // of the address space, so simply checking the stack address is not enough.
 103   // This should (does) work for both PowerPC64 Endian modes.
 104   // Similarly, aarch64 has multiple address space layouts: 39, 42 and 47-bit.
 105   return (1ULL << (MostSignificantSetBitIndex(GET_CURRENT_FRAME()) + 1)) - 1;
 106 # elif defined(__mips64)
 107   return (1ULL << 40) - 1;  // 0x000000ffffffffffUL;
 108 # elif defined(__s390x__)
 109   return (1ULL << 53) - 1;  // 0x001fffffffffffffUL;
 110 # else
 111   return (1ULL << 47) - 1;  // 0x00007fffffffffffUL;
 112 # endif
 113 #else  // SANITIZER_WORDSIZE == 32
 114 # if defined(__s390__)
 115   return (1ULL << 31) - 1;  // 0x7fffffff;
 116 # else
 117   uptr res = (1ULL << 32) - 1;  // 0xffffffff;
 118   if (!common_flags()->full_address_space)
 119     res -= GetKernelAreaSize();
 120   CHECK_LT(reinterpret_cast<uptr>(&res), res);
 121   return res;
 122 # endif
 123 #endif  // SANITIZER_WORDSIZE
 124 }
 125
 126 void *MmapOrDie(uptr size, const char *mem_type, bool raw_report) {
 127   size = RoundUpTo(size, GetPageSizeCached());
 128   uptr res = internal_mmap(nullptr, size,
 129                            PROT_READ | PROT_WRITE,
 130                            MAP_PRIVATE | MAP_ANON, -1, 0);
 131   int reserrno;
 132   if (UNLIKELY(internal_iserror(res, &reserrno)))
 133     ReportMmapFailureAndDie(size, mem_type, "allocate", reserrno, raw_report);
 134   IncreaseTotalMmap(size);
 135   return (void *)res;
 136 }
 137
 138 void UnmapOrDie(void *addr, uptr size) {
 139   if (!addr || !size) return;
 140   uptr res = internal_munmap(addr, size);
 141   if (UNLIKELY(internal_iserror(res))) {
 142     Report("ERROR: %s failed to deallocate 0x%zx (%zd) bytes at address %p\n",
 143            SanitizerToolName, size, size, addr);
 144     CHECK("unable to unmap" && 0);
 145   }
 146   DecreaseTotalMmap(size);
 147 }
 148
 149 void *MmapOrDieOnFatalError(uptr size, const char *mem_type) {
 150   size = RoundUpTo(size, GetPageSizeCached());
 151   uptr res = internal_mmap(nullptr, size,
 152                            PROT_READ | PROT_WRITE,
 153                            MAP_PRIVATE | MAP_ANON, -1, 0);
 154   int reserrno;
 155   if (UNLIKELY(internal_iserror(res, &reserrno))) {
 156     if (reserrno == ENOMEM)
 157       return nullptr;
 158     ReportMmapFailureAndDie(size, mem_type, "allocate", reserrno);
 159   }
 160   IncreaseTotalMmap(size);
 161   return (void *)res;
 162 }
 163
 164 // We want to map a chunk of address space aligned to 'alignment'.
 165 // We do it by maping a bit more and then unmaping redundant pieces.
 166 // We probably can do it with fewer syscalls in some OS-dependent way.
 167 void *MmapAlignedOrDieOnFatalError(uptr size, uptr alignment,
 168                                    const char *mem_type) {
 169   CHECK(IsPowerOfTwo(size));
 170   CHECK(IsPowerOfTwo(alignment));
 171   uptr map_size = size + alignment;
 172   uptr map_res = (uptr)MmapOrDieOnFatalError(map_size, mem_type);
 173   if (UNLIKELY(!map_res))
 174     return nullptr;
 175   uptr map_end = map_res + map_size;
 176   uptr res = map_res;
 177   if (!IsAligned(res, alignment)) {
 178     res = (map_res + alignment - 1) & ~(alignment - 1);
 179     UnmapOrDie((void*)map_res, res - map_res);
 180   }
 181   uptr end = res + size;
 182   if (end != map_end)
 183     UnmapOrDie((void*)end, map_end - end);
 184   return (void*)res;
 185 }
 186
 187 void *MmapNoReserveOrDie(uptr size, const char *mem_type) {
 188   uptr PageSize = GetPageSizeCached();
 189   uptr p = internal_mmap(nullptr,
 190                          RoundUpTo(size, PageSize),
 191                          PROT_READ | PROT_WRITE,
 192                          MAP_PRIVATE | MAP_ANON | MAP_NORESERVE,
 193                          -1, 0);
 194   int reserrno;
 195   if (UNLIKELY(internal_iserror(p, &reserrno)))
 196     ReportMmapFailureAndDie(size, mem_type, "allocate noreserve", reserrno);
 197   IncreaseTotalMmap(size);
 198   return (void *)p;
 199 }
 200
 201 void *MmapFixedImpl(uptr fixed_addr, uptr size, bool tolerate_enomem) {
 202   uptr PageSize = GetPageSizeCached();
 203   uptr p = internal_mmap((void*)(fixed_addr & ~(PageSize - 1)),
 204       RoundUpTo(size, PageSize),
 205       PROT_READ | PROT_WRITE,
 206       MAP_PRIVATE | MAP_ANON | MAP_FIXED,
 207       -1, 0);
 208   int reserrno;
 209   if (UNLIKELY(internal_iserror(p, &reserrno))) {
 210     if (tolerate_enomem && reserrno == ENOMEM)
 211       return nullptr;
 212     char mem_type[40];
 213     internal_snprintf(mem_type, sizeof(mem_type), "memory at address 0x%zx",
 214                       fixed_addr);
 215     ReportMmapFailureAndDie(size, mem_type, "allocate", reserrno);
 216   }
 217   IncreaseTotalMmap(size);
 218   return (void *)p;
 219 }
 220
 221 void *MmapFixedOrDie(uptr fixed_addr, uptr size) {
 222   return MmapFixedImpl(fixed_addr, size, false /*tolerate_enomem*/);
 223 }
 224
 225 void *MmapFixedOrDieOnFatalError(uptr fixed_addr, uptr size) {
 226   return MmapFixedImpl(fixed_addr, size, true /*tolerate_enomem*/);
 227 }
 228
 229 bool MprotectNoAccess(uptr addr, uptr size) {
 230   return 0 == internal_mprotect((void*)addr, size, PROT_NONE);
 231 }
 232
 233 bool MprotectReadOnly(uptr addr, uptr size) {
 234   return 0 == internal_mprotect((void *)addr, size, PROT_READ);
 235 }
 236
 237 fd_t OpenFile(const char *filename, FileAccessMode mode, error_t *errno_p) {
 238   int flags;
 239   switch (mode) {
 240     case RdOnly: flags = O_RDONLY; break;
 241     case WrOnly: flags = O_WRONLY | O_CREAT; break;
 242     case RdWr: flags = O_RDWR | O_CREAT; break;
 243   }
 244   fd_t res = internal_open(filename, flags, 0660);
 245   if (internal_iserror(res, errno_p))
 246     return kInvalidFd;
 247   return res;
 248 }
 249
 250 void CloseFile(fd_t fd) {
 251   internal_close(fd);
 252 }
 253
 254 bool ReadFromFile(fd_t fd, void *buff, uptr buff_size, uptr *bytes_read,
 255                   error_t *error_p) {
 256   uptr res = internal_read(fd, buff, buff_size);
 257   if (internal_iserror(res, error_p))
 258     return false;
 259   if (bytes_read)
 260     *bytes_read = res;
 261   return true;
 262 }
 263
 264 bool WriteToFile(fd_t fd, const void *buff, uptr buff_size, uptr *bytes_written,
 265                  error_t *error_p) {
 266   uptr res = internal_write(fd, buff, buff_size);
 267   if (internal_iserror(res, error_p))
 268     return false;
 269   if (bytes_written)
 270     *bytes_written = res;
 271   return true;
 272 }
 273
 274 bool RenameFile(const char *oldpath, const char *newpath, error_t *error_p) {
 275   uptr res = internal_rename(oldpath, newpath);
 276   return !internal_iserror(res, error_p);
 277 }
 278
 279 void *MapFileToMemory(const char *file_name, uptr *buff_size) {
 280   fd_t fd = OpenFile(file_name, RdOnly);
 281   CHECK(fd != kInvalidFd);
 282   uptr fsize = internal_filesize(fd);
 283   CHECK_NE(fsize, (uptr)-1);
 284   CHECK_GT(fsize, 0);
 285   *buff_size = RoundUpTo(fsize, GetPageSizeCached());
 286   uptr map = internal_mmap(nullptr, *buff_size, PROT_READ, MAP_PRIVATE, fd, 0);
 287   return internal_iserror(map) ? nullptr : (void *)map;
 288 }
 289
 290 void *MapWritableFileToMemory(void *addr, uptr size, fd_t fd, OFF_T offset) {
 291   uptr flags = MAP_SHARED;
 292   if (addr) flags |= MAP_FIXED;
 293   uptr p = internal_mmap(addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
 294   int mmap_errno = 0;
 295   if (internal_iserror(p, &mmap_errno)) {
 296     Printf("could not map writable file (%d, %lld, %zu): %zd, errno: %d\n",
 297            fd, (long long)offset, size, p, mmap_errno);
 298     return nullptr;
 299   }
 300   return (void *)p;
 301 }
 302
 303 static inline bool IntervalsAreSeparate(uptr start1, uptr end1,
 304                                         uptr start2, uptr end2) {
 305   CHECK(start1 <= end1);
 306   CHECK(start2 <= end2);
 307   return (end1 < start2) || (end2 < start1);
 308 }
 309
 310 // FIXME: this is thread-unsafe, but should not cause problems most of the time.
 311 // When the shadow is mapped only a single thread usually exists (plus maybe
 312 // several worker threads on Mac, which aren't expected to map big chunks of
 313 // memory).
 314 bool MemoryRangeIsAvailable(uptr range_start, uptr range_end) {
 315   MemoryMappingLayout proc_maps(/*cache_enabled*/true);
 316   uptr start, end;
 317   while (proc_maps.Next(&start, &end,
 318                         /*offset*/nullptr, /*filename*/nullptr,
 319                         /*filename_size*/0, /*protection*/nullptr)) {
 320     if (start == end) continue;  // Empty range.
 321     CHECK_NE(0, end);
 322     if (!IntervalsAreSeparate(start, end - 1, range_start, range_end))
 323       return false;
 324   }
 325   return true;
 326 }
 327
 328 void DumpProcessMap() {
 329   MemoryMappingLayout proc_maps(/*cache_enabled*/true);
 330   uptr start, end;
 331   const sptr kBufSize = 4095;
 332   char *filename = (char*)MmapOrDie(kBufSize, __func__);
 333   Report("Process memory map follows:\n");
 334   while (proc_maps.Next(&start, &end, /* file_offset */nullptr,
 335                         filename, kBufSize, /* protection */nullptr)) {
 336     Printf("\t%p-%p\t%s\n", (void*)start, (void*)end, filename);
 337   }
 338   Report("End of process memory map.\n");
 339   UnmapOrDie(filename, kBufSize);
 340 }
 341
 342 const char *GetPwd() {
 343   return GetEnv("PWD");
 344 }
 345
 346 bool IsPathSeparator(const char c) {
 347   return c == '/';
 348 }
 349
 350 bool IsAbsolutePath(const char *path) {
 351   return path != nullptr && IsPathSeparator(path[0]);
 352 }
 353
 354 void ReportFile::Write(const char *buffer, uptr length) {
 355   SpinMutexLock l(mu);
 356   static const char *kWriteError =
 357       "ReportFile::Write() can't output requested buffer!\n";
 358   ReopenIfNecessary();
 359   if (length != internal_write(fd, buffer, length)) {
 360     internal_write(fd, kWriteError, internal_strlen(kWriteError));
 361     Die();
 362   }
 363 }
 364
 365 bool GetCodeRangeForFile(const char *module, uptr *start, uptr *end) {
 366   uptr s, e, off, prot;
 367   InternalScopedString buff(kMaxPathLength);
 368   MemoryMappingLayout proc_maps(/*cache_enabled*/false);
 369   while (proc_maps.Next(&s, &e, &off, buff.data(), buff.size(), &prot)) {
 370     if ((prot & MemoryMappingLayout::kProtectionExecute) != 0
 371         && internal_strcmp(module, buff.data()) == 0) {
 372       *start = s;
 373       *end = e;
 374       return true;
 375     }
 376   }
 377   return false;
 378 }
 379
 380 SignalContext SignalContext::Create(void *siginfo, void *context) {
 381   auto si = (siginfo_t *)siginfo;
 382   uptr addr = (uptr)si->si_addr;
 383   uptr pc, sp, bp;
 384   GetPcSpBp(context, &pc, &sp, &bp);
 385   WriteFlag write_flag = GetWriteFlag(context);
 386   bool is_memory_access = si->si_signo == SIGSEGV;
 387   return SignalContext(context, addr, pc, sp, bp, is_memory_access, write_flag);
 388 }
 389
 390 const char *DescribeSignalOrException(int signo) {
 391   switch (signo) {
 392     case SIGFPE:
 393       return "FPE";
 394     case SIGILL:
 395       return "ILL";
 396     case SIGABRT:
 397       return "ABRT";
 398     case SIGSEGV:
 399       return "SEGV";
 400     case SIGBUS:
 401       return "BUS";
 402   }
 403   return "UNKNOWN SIGNAL";
 404 }
 405
 406 } // namespace __sanitizer
 407
 408 #endif // SANITIZER_POSIX