libsanitizer/asan/asan_poisoning.cc

   1 //===-- asan_poisoning.cc -------------------------------------------------===//
   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 a part of AddressSanitizer, an address sanity checker.
   9 //
  10 // Shadow memory poisoning by ASan RTL and by user application.
  11 //===----------------------------------------------------------------------===//
  12
  13 #include "asan_poisoning.h"
  14 #include "asan_report.h"
  15 #include "asan_stack.h"
  16 #include "sanitizer_common/sanitizer_atomic.h"
  17 #include "sanitizer_common/sanitizer_libc.h"
  18 #include "sanitizer_common/sanitizer_flags.h"
  19
  20 namespace __asan {
  21
  22 static atomic_uint8_t can_poison_memory;
  23
  24 void SetCanPoisonMemory(bool value) {
  25   atomic_store(&can_poison_memory, value, memory_order_release);
  26 }
  27
  28 bool CanPoisonMemory() {
  29   return atomic_load(&can_poison_memory, memory_order_acquire);
  30 }
  31
  32 void PoisonShadow(uptr addr, uptr size, u8 value) {
  33   if (!CanPoisonMemory()) return;
  34   CHECK(AddrIsAlignedByGranularity(addr));
  35   CHECK(AddrIsInMem(addr));
  36   CHECK(AddrIsAlignedByGranularity(addr + size));
  37   CHECK(AddrIsInMem(addr + size - SHADOW_GRANULARITY));
  38   CHECK(REAL(memset));
  39   FastPoisonShadow(addr, size, value);
  40 }
  41
  42 void PoisonShadowPartialRightRedzone(uptr addr,
  43                                      uptr size,
  44                                      uptr redzone_size,
  45                                      u8 value) {
  46   if (!CanPoisonMemory()) return;
  47   CHECK(AddrIsAlignedByGranularity(addr));
  48   CHECK(AddrIsInMem(addr));
  49   FastPoisonShadowPartialRightRedzone(addr, size, redzone_size, value);
  50 }
  51
  52 struct ShadowSegmentEndpoint {
  53   u8 *chunk;
  54   s8 offset;  // in [0, SHADOW_GRANULARITY)
  55   s8 value;  // = *chunk;
  56
  57   explicit ShadowSegmentEndpoint(uptr address) {
  58     chunk = (u8*)MemToShadow(address);
  59     offset = address & (SHADOW_GRANULARITY - 1);
  60     value = *chunk;
  61   }
  62 };
  63
  64 void FlushUnneededASanShadowMemory(uptr p, uptr size) {
  65     // Since asan's mapping is compacting, the shadow chunk may be
  66     // not page-aligned, so we only flush the page-aligned portion.
  67     uptr page_size = GetPageSizeCached();
  68     uptr shadow_beg = RoundUpTo(MemToShadow(p), page_size);
  69     uptr shadow_end = RoundDownTo(MemToShadow(p + size), page_size);
  70     ReleaseMemoryToOS(shadow_beg, shadow_end - shadow_beg);
  71 }
  72
  73 void AsanPoisonOrUnpoisonIntraObjectRedzone(uptr ptr, uptr size, bool poison) {
  74   uptr end = ptr + size;
  75   if (Verbosity()) {
  76     Printf("__asan_%spoison_intra_object_redzone [%p,%p) %zd\n",
  77            poison ? "" : "un", ptr, end, size);
  78     if (Verbosity() >= 2)
  79       PRINT_CURRENT_STACK();
  80   }
  81   CHECK(size);
  82   CHECK_LE(size, 4096);
  83   CHECK(IsAligned(end, SHADOW_GRANULARITY));
  84   if (!IsAligned(ptr, SHADOW_GRANULARITY)) {
  85     *(u8 *)MemToShadow(ptr) =
  86         poison ? static_cast<u8>(ptr % SHADOW_GRANULARITY) : 0;
  87     ptr |= SHADOW_GRANULARITY - 1;
  88     ptr++;
  89   }
  90   for (; ptr < end; ptr += SHADOW_GRANULARITY)
  91     *(u8*)MemToShadow(ptr) = poison ? kAsanIntraObjectRedzone : 0;
  92 }
  93
  94 }  // namespace __asan
  95
  96 // ---------------------- Interface ---------------- {{{1
  97 using namespace __asan;  // NOLINT
  98
  99 // Current implementation of __asan_(un)poison_memory_region doesn't check
 100 // that user program (un)poisons the memory it owns. It poisons memory
 101 // conservatively, and unpoisons progressively to make sure asan shadow
 102 // mapping invariant is preserved (see detailed mapping description here:
 103 // https://github.com/google/sanitizers/wiki/AddressSanitizerAlgorithm).
 104 //
 105 // * if user asks to poison region [left, right), the program poisons
 106 // at least [left, AlignDown(right)).
 107 // * if user asks to unpoison region [left, right), the program unpoisons
 108 // at most [AlignDown(left), right).
 109 void __asan_poison_memory_region(void const volatile *addr, uptr size) {
 110   if (!flags()->allow_user_poisoning || size == 0) return;
 111   uptr beg_addr = (uptr)addr;
 112   uptr end_addr = beg_addr + size;
 113   VPrintf(3, "Trying to poison memory region [%p, %p)\n", (void *)beg_addr,
 114           (void *)end_addr);
 115   ShadowSegmentEndpoint beg(beg_addr);
 116   ShadowSegmentEndpoint end(end_addr);
 117   if (beg.chunk == end.chunk) {
 118     CHECK_LT(beg.offset, end.offset);
 119     s8 value = beg.value;
 120     CHECK_EQ(value, end.value);
 121     // We can only poison memory if the byte in end.offset is unaddressable.
 122     // No need to re-poison memory if it is poisoned already.
 123     if (value > 0 && value <= end.offset) {
 124       if (beg.offset > 0) {
 125         *beg.chunk = Min(value, beg.offset);
 126       } else {
 127         *beg.chunk = kAsanUserPoisonedMemoryMagic;
 128       }
 129     }
 130     return;
 131   }
 132   CHECK_LT(beg.chunk, end.chunk);
 133   if (beg.offset > 0) {
 134     // Mark bytes from beg.offset as unaddressable.
 135     if (beg.value == 0) {
 136       *beg.chunk = beg.offset;
 137     } else {
 138       *beg.chunk = Min(beg.value, beg.offset);
 139     }
 140     beg.chunk++;
 141   }
 142   REAL(memset)(beg.chunk, kAsanUserPoisonedMemoryMagic, end.chunk - beg.chunk);
 143   // Poison if byte in end.offset is unaddressable.
 144   if (end.value > 0 && end.value <= end.offset) {
 145     *end.chunk = kAsanUserPoisonedMemoryMagic;
 146   }
 147 }
 148
 149 void __asan_unpoison_memory_region(void const volatile *addr, uptr size) {
 150   if (!flags()->allow_user_poisoning || size == 0) return;
 151   uptr beg_addr = (uptr)addr;
 152   uptr end_addr = beg_addr + size;
 153   VPrintf(3, "Trying to unpoison memory region [%p, %p)\n", (void *)beg_addr,
 154           (void *)end_addr);
 155   ShadowSegmentEndpoint beg(beg_addr);
 156   ShadowSegmentEndpoint end(end_addr);
 157   if (beg.chunk == end.chunk) {
 158     CHECK_LT(beg.offset, end.offset);
 159     s8 value = beg.value;
 160     CHECK_EQ(value, end.value);
 161     // We unpoison memory bytes up to enbytes up to end.offset if it is not
 162     // unpoisoned already.
 163     if (value != 0) {
 164       *beg.chunk = Max(value, end.offset);
 165     }
 166     return;
 167   }
 168   CHECK_LT(beg.chunk, end.chunk);
 169   if (beg.offset > 0) {
 170     *beg.chunk = 0;
 171     beg.chunk++;
 172   }
 173   REAL(memset)(beg.chunk, 0, end.chunk - beg.chunk);
 174   if (end.offset > 0 && end.value != 0) {
 175     *end.chunk = Max(end.value, end.offset);
 176   }
 177 }
 178
 179 int __asan_address_is_poisoned(void const volatile *addr) {
 180   return __asan::AddressIsPoisoned((uptr)addr);
 181 }
 182
 183 uptr __asan_region_is_poisoned(uptr beg, uptr size) {
 184   if (!size) return 0;
 185   uptr end = beg + size;
 186   if (!AddrIsInMem(beg)) return beg;
 187   if (!AddrIsInMem(end)) return end;
 188   CHECK_LT(beg, end);
 189   uptr aligned_b = RoundUpTo(beg, SHADOW_GRANULARITY);
 190   uptr aligned_e = RoundDownTo(end, SHADOW_GRANULARITY);
 191   uptr shadow_beg = MemToShadow(aligned_b);
 192   uptr shadow_end = MemToShadow(aligned_e);
 193   // First check the first and the last application bytes,
 194   // then check the SHADOW_GRANULARITY-aligned region by calling
 195   // mem_is_zero on the corresponding shadow.
 196   if (!__asan::AddressIsPoisoned(beg) &&
 197       !__asan::AddressIsPoisoned(end - 1) &&
 198       (shadow_end <= shadow_beg ||
 199        __sanitizer::mem_is_zero((const char *)shadow_beg,
 200                                 shadow_end - shadow_beg)))
 201     return 0;
 202   // The fast check failed, so we have a poisoned byte somewhere.
 203   // Find it slowly.
 204   for (; beg < end; beg++)
 205     if (__asan::AddressIsPoisoned(beg))
 206       return beg;
 207   UNREACHABLE("mem_is_zero returned false, but poisoned byte was not found");
 208   return 0;
 209 }
 210
 211 #define CHECK_SMALL_REGION(p, size, isWrite)                  \
 212   do {                                                        \
 213     uptr __p = reinterpret_cast<uptr>(p);                     \
 214     uptr __size = size;                                       \
 215     if (UNLIKELY(__asan::AddressIsPoisoned(__p) ||            \
 216         __asan::AddressIsPoisoned(__p + __size - 1))) {       \
 217       GET_CURRENT_PC_BP_SP;                                   \
 218       uptr __bad = __asan_region_is_poisoned(__p, __size);    \
 219       __asan_report_error(pc, bp, sp, __bad, isWrite, __size, 0);\
 220     }                                                         \
 221   } while (false);                                            \
 222
 223
 224 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 225 u16 __sanitizer_unaligned_load16(const uu16 *p) {
 226   CHECK_SMALL_REGION(p, sizeof(*p), false);
 227   return *p;
 228 }
 229
 230 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 231 u32 __sanitizer_unaligned_load32(const uu32 *p) {
 232   CHECK_SMALL_REGION(p, sizeof(*p), false);
 233   return *p;
 234 }
 235
 236 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 237 u64 __sanitizer_unaligned_load64(const uu64 *p) {
 238   CHECK_SMALL_REGION(p, sizeof(*p), false);
 239   return *p;
 240 }
 241
 242 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 243 void __sanitizer_unaligned_store16(uu16 *p, u16 x) {
 244   CHECK_SMALL_REGION(p, sizeof(*p), true);
 245   *p = x;
 246 }
 247
 248 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 249 void __sanitizer_unaligned_store32(uu32 *p, u32 x) {
 250   CHECK_SMALL_REGION(p, sizeof(*p), true);
 251   *p = x;
 252 }
 253
 254 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 255 void __sanitizer_unaligned_store64(uu64 *p, u64 x) {
 256   CHECK_SMALL_REGION(p, sizeof(*p), true);
 257   *p = x;
 258 }
 259
 260 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 261 void __asan_poison_cxx_array_cookie(uptr p) {
 262   if (SANITIZER_WORDSIZE != 64) return;
 263   if (!flags()->poison_array_cookie) return;
 264   uptr s = MEM_TO_SHADOW(p);
 265   *reinterpret_cast<u8*>(s) = kAsanArrayCookieMagic;
 266 }
 267
 268 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 269 uptr __asan_load_cxx_array_cookie(uptr *p) {
 270   if (SANITIZER_WORDSIZE != 64) return *p;
 271   if (!flags()->poison_array_cookie) return *p;
 272   uptr s = MEM_TO_SHADOW(reinterpret_cast<uptr>(p));
 273   u8 sval = *reinterpret_cast<u8*>(s);
 274   if (sval == kAsanArrayCookieMagic) return *p;
 275   // If sval is not kAsanArrayCookieMagic it can only be freed memory,
 276   // which means that we are going to get double-free. So, return 0 to avoid
 277   // infinite loop of destructors. We don't want to report a double-free here
 278   // though, so print a warning just in case.
 279   // CHECK_EQ(sval, kAsanHeapFreeMagic);
 280   if (sval == kAsanHeapFreeMagic) {
 281     Report("AddressSanitizer: loaded array cookie from free-d memory; "
 282            "expect a double-free report\n");
 283     return 0;
 284   }
 285   // The cookie may remain unpoisoned if e.g. it comes from a custom
 286   // operator new defined inside a class.
 287   return *p;
 288 }
 289
 290 // This is a simplified version of __asan_(un)poison_memory_region, which
 291 // assumes that left border of region to be poisoned is properly aligned.
 292 static void PoisonAlignedStackMemory(uptr addr, uptr size, bool do_poison) {
 293   if (size == 0) return;
 294   uptr aligned_size = size & ~(SHADOW_GRANULARITY - 1);
 295   PoisonShadow(addr, aligned_size,
 296                do_poison ? kAsanStackUseAfterScopeMagic : 0);
 297   if (size == aligned_size)
 298     return;
 299   s8 end_offset = (s8)(size - aligned_size);
 300   s8* shadow_end = (s8*)MemToShadow(addr + aligned_size);
 301   s8 end_value = *shadow_end;
 302   if (do_poison) {
 303     // If possible, mark all the bytes mapping to last shadow byte as
 304     // unaddressable.
 305     if (end_value > 0 && end_value <= end_offset)
 306       *shadow_end = (s8)kAsanStackUseAfterScopeMagic;
 307   } else {
 308     // If necessary, mark few first bytes mapping to last shadow byte
 309     // as addressable
 310     if (end_value != 0)
 311       *shadow_end = Max(end_value, end_offset);
 312   }
 313 }
 314
 315 void __asan_set_shadow_00(uptr addr, uptr size) {
 316   REAL(memset)((void *)addr, 0, size);
 317 }
 318
 319 void __asan_set_shadow_f1(uptr addr, uptr size) {
 320   REAL(memset)((void *)addr, 0xf1, size);
 321 }
 322
 323 void __asan_set_shadow_f2(uptr addr, uptr size) {
 324   REAL(memset)((void *)addr, 0xf2, size);
 325 }
 326
 327 void __asan_set_shadow_f3(uptr addr, uptr size) {
 328   REAL(memset)((void *)addr, 0xf3, size);
 329 }
 330
 331 void __asan_set_shadow_f5(uptr addr, uptr size) {
 332   REAL(memset)((void *)addr, 0xf5, size);
 333 }
 334
 335 void __asan_set_shadow_f8(uptr addr, uptr size) {
 336   REAL(memset)((void *)addr, 0xf8, size);
 337 }
 338
 339 void __asan_poison_stack_memory(uptr addr, uptr size) {
 340   VReport(1, "poisoning: %p %zx\n", (void *)addr, size);
 341   PoisonAlignedStackMemory(addr, size, true);
 342 }
 343
 344 void __asan_unpoison_stack_memory(uptr addr, uptr size) {
 345   VReport(1, "unpoisoning: %p %zx\n", (void *)addr, size);
 346   PoisonAlignedStackMemory(addr, size, false);
 347 }
 348
 349 void __sanitizer_annotate_contiguous_container(const void *beg_p,
 350                                                const void *end_p,
 351                                                const void *old_mid_p,
 352                                                const void *new_mid_p) {
 353   if (!flags()->detect_container_overflow) return;
 354   VPrintf(2, "contiguous_container: %p %p %p %p\n", beg_p, end_p, old_mid_p,
 355           new_mid_p);
 356   uptr beg = reinterpret_cast<uptr>(beg_p);
 357   uptr end = reinterpret_cast<uptr>(end_p);
 358   uptr old_mid = reinterpret_cast<uptr>(old_mid_p);
 359   uptr new_mid = reinterpret_cast<uptr>(new_mid_p);
 360   uptr granularity = SHADOW_GRANULARITY;
 361   if (!(beg <= old_mid && beg <= new_mid && old_mid <= end && new_mid <= end &&
 362         IsAligned(beg, granularity))) {
 363     GET_STACK_TRACE_FATAL_HERE;
 364     ReportBadParamsToAnnotateContiguousContainer(beg, end, old_mid, new_mid,
 365                                                  &stack);
 366   }
 367   CHECK_LE(end - beg,
 368            FIRST_32_SECOND_64(1UL << 30, 1ULL << 34)); // Sanity check.
 369
 370   uptr a = RoundDownTo(Min(old_mid, new_mid), granularity);
 371   uptr c = RoundUpTo(Max(old_mid, new_mid), granularity);
 372   uptr d1 = RoundDownTo(old_mid, granularity);
 373   // uptr d2 = RoundUpTo(old_mid, granularity);
 374   // Currently we should be in this state:
 375   // [a, d1) is good, [d2, c) is bad, [d1, d2) is partially good.
 376   // Make a quick sanity check that we are indeed in this state.
 377   //
 378   // FIXME: Two of these three checks are disabled until we fix
 379   // https://github.com/google/sanitizers/issues/258.
 380   // if (d1 != d2)
 381   //  CHECK_EQ(*(u8*)MemToShadow(d1), old_mid - d1);
 382   if (a + granularity <= d1)
 383     CHECK_EQ(*(u8*)MemToShadow(a), 0);
 384   // if (d2 + granularity <= c && c <= end)
 385   //   CHECK_EQ(*(u8 *)MemToShadow(c - granularity),
 386   //            kAsanContiguousContainerOOBMagic);
 387
 388   uptr b1 = RoundDownTo(new_mid, granularity);
 389   uptr b2 = RoundUpTo(new_mid, granularity);
 390   // New state:
 391   // [a, b1) is good, [b2, c) is bad, [b1, b2) is partially good.
 392   PoisonShadow(a, b1 - a, 0);
 393   PoisonShadow(b2, c - b2, kAsanContiguousContainerOOBMagic);
 394   if (b1 != b2) {
 395     CHECK_EQ(b2 - b1, granularity);
 396     *(u8*)MemToShadow(b1) = static_cast<u8>(new_mid - b1);
 397   }
 398 }
 399
 400 const void *__sanitizer_contiguous_container_find_bad_address(
 401     const void *beg_p, const void *mid_p, const void *end_p) {
 402   if (!flags()->detect_container_overflow)
 403     return nullptr;
 404   uptr beg = reinterpret_cast<uptr>(beg_p);
 405   uptr end = reinterpret_cast<uptr>(end_p);
 406   uptr mid = reinterpret_cast<uptr>(mid_p);
 407   CHECK_LE(beg, mid);
 408   CHECK_LE(mid, end);
 409   // Check some bytes starting from beg, some bytes around mid, and some bytes
 410   // ending with end.
 411   uptr kMaxRangeToCheck = 32;
 412   uptr r1_beg = beg;
 413   uptr r1_end = Min(end + kMaxRangeToCheck, mid);
 414   uptr r2_beg = Max(beg, mid - kMaxRangeToCheck);
 415   uptr r2_end = Min(end, mid + kMaxRangeToCheck);
 416   uptr r3_beg = Max(end - kMaxRangeToCheck, mid);
 417   uptr r3_end = end;
 418   for (uptr i = r1_beg; i < r1_end; i++)
 419     if (AddressIsPoisoned(i))
 420       return reinterpret_cast<const void *>(i);
 421   for (uptr i = r2_beg; i < mid; i++)
 422     if (AddressIsPoisoned(i))
 423       return reinterpret_cast<const void *>(i);
 424   for (uptr i = mid; i < r2_end; i++)
 425     if (!AddressIsPoisoned(i))
 426       return reinterpret_cast<const void *>(i);
 427   for (uptr i = r3_beg; i < r3_end; i++)
 428     if (!AddressIsPoisoned(i))
 429       return reinterpret_cast<const void *>(i);
 430   return nullptr;
 431 }
 432
 433 int __sanitizer_verify_contiguous_container(const void *beg_p,
 434                                             const void *mid_p,
 435                                             const void *end_p) {
 436   return __sanitizer_contiguous_container_find_bad_address(beg_p, mid_p,
 437                                                            end_p) == nullptr;
 438 }
 439
 440 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 441 void __asan_poison_intra_object_redzone(uptr ptr, uptr size) {
 442   AsanPoisonOrUnpoisonIntraObjectRedzone(ptr, size, true);
 443 }
 444
 445 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
 446 void __asan_unpoison_intra_object_redzone(uptr ptr, uptr size) {
 447   AsanPoisonOrUnpoisonIntraObjectRedzone(ptr, size, false);
 448 }
 449
 450 // --- Implementation of LSan-specific functions --- {{{1
 451 namespace __lsan {
 452 bool WordIsPoisoned(uptr addr) {
 453   return (__asan_region_is_poisoned(addr, sizeof(uptr)) != 0);
 454 }
 455 }