mfbt/MemoryChecking.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /*
   8  * Provides a common interface to the ASan (AddressSanitizer) and Valgrind
   9  * functions used to mark memory in certain ways. In detail, the following
  10  * three macros are provided:
  11  *
  12  *   MOZ_MAKE_MEM_NOACCESS  - Mark memory as unsafe to access (e.g. freed)
  13  *   MOZ_MAKE_MEM_UNDEFINED - Mark memory as accessible, with content undefined
  14  *   MOZ_MAKE_MEM_DEFINED - Mark memory as accessible, with content defined
  15  *
  16  * With Valgrind in use, these directly map to the three respective Valgrind
  17  * macros. With ASan in use, the NOACCESS macro maps to poisoning the memory,
  18  * while the UNDEFINED/DEFINED macros unpoison memory.
  19  *
  20  * With no memory checker available, all macros expand to the empty statement.
  21  */
  22
  23 #ifndef mozilla_MemoryChecking_h
  24 #define mozilla_MemoryChecking_h
  25
  26 #if defined(MOZ_VALGRIND)
  27 #include "valgrind/memcheck.h"
  28 #endif
  29
  30 #if defined(MOZ_ASAN) || defined(MOZ_VALGRIND)
  31 #define MOZ_HAVE_MEM_CHECKS 1
  32 #endif
  33
  34 #if defined(MOZ_ASAN)
  35 #include <stddef.h>
  36
  37 #include "mozilla/Types.h"
  38
  39 extern "C" {
  40 /* These definitions are usually provided through the
  41  * sanitizer/asan_interface.h header installed by ASan.
  42  */
  43 void MOZ_EXPORT
  44 __asan_poison_memory_region(void const volatile *addr, size_t size);
  45 void MOZ_EXPORT
  46 __asan_unpoison_memory_region(void const volatile *addr, size_t size);
  47
  48 #define MOZ_MAKE_MEM_NOACCESS(addr, size) \
  49   __asan_poison_memory_region((addr), (size))
  50
  51 #define MOZ_MAKE_MEM_UNDEFINED(addr, size) \
  52   __asan_unpoison_memory_region((addr), (size))
  53
  54 #define MOZ_MAKE_MEM_DEFINED(addr, size) \
  55   __asan_unpoison_memory_region((addr), (size))
  56 }
  57 #elif defined(MOZ_VALGRIND)
  58 #define MOZ_MAKE_MEM_NOACCESS(addr, size) \
  59   VALGRIND_MAKE_MEM_NOACCESS((addr), (size))
  60
  61 #define MOZ_MAKE_MEM_UNDEFINED(addr, size) \
  62   VALGRIND_MAKE_MEM_UNDEFINED((addr), (size))
  63
  64 #define MOZ_MAKE_MEM_DEFINED(addr, size) \
  65   VALGRIND_MAKE_MEM_DEFINED((addr), (size))
  66 #else
  67
  68 #define MOZ_MAKE_MEM_NOACCESS(addr, size) do {} while (0)
  69 #define MOZ_MAKE_MEM_UNDEFINED(addr, size) do {} while (0)
  70 #define MOZ_MAKE_MEM_DEFINED(addr, size) do {} while (0)
  71
  72 #endif
  73
  74 #endif /* mozilla_MemoryChecking_h */