libsanitizer/include/sanitizer/lsan_interface.h

   1 //===-- sanitizer/lsan_interface.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 a part of LeakSanitizer.
   9 //
  10 // Public interface header.
  11 //===----------------------------------------------------------------------===//
  12 #ifndef SANITIZER_LSAN_INTERFACE_H
  13 #define SANITIZER_LSAN_INTERFACE_H
  14
  15 #include <sanitizer/common_interface_defs.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20   // Allocations made between calls to __lsan_disable() and __lsan_enable() will
  21   // be treated as non-leaks. Disable/enable pairs may be nested.
  22   void __lsan_disable();
  23   void __lsan_enable();
  24
  25   // The heap object into which p points will be treated as a non-leak.
  26   void __lsan_ignore_object(const void *p);
  27
  28   // Memory regions registered through this interface will be treated as sources
  29   // of live pointers during leak checking. Useful if you store pointers in
  30   // mapped memory.
  31   // Points of note:
  32   // - __lsan_unregister_root_region() must be called with the same pointer and
  33   // size that have earlier been passed to __lsan_register_root_region()
  34   // - LSan will skip any inaccessible memory when scanning a root region. E.g.,
  35   // if you map memory within a larger region that you have mprotect'ed, you can
  36   // register the entire large region.
  37   // - the implementation is not optimized for performance. This interface is
  38   // intended to be used for a small number of relatively static regions.
  39   void __lsan_register_root_region(const void *p, size_t size);
  40   void __lsan_unregister_root_region(const void *p, size_t size);
  41
  42   // Calling this function makes LSan enter the leak checking phase immediately.
  43   // Use this if normal end-of-process leak checking happens too late (e.g. if
  44   // you have intentional memory leaks in your shutdown code). Calling this
  45   // function overrides end-of-process leak checking; it must be called at
  46   // most once per process. This function will terminate the process if there
  47   // are memory leaks and the exit_code flag is non-zero.
  48   void __lsan_do_leak_check();
  49
  50   // The user may optionally provide this function to disallow leak checking
  51   // for the program it is linked into (if the return value is non-zero). This
  52   // function must be defined as returning a constant value; any behavior beyond
  53   // that is unsupported.
  54   int __lsan_is_turned_off();
  55
  56   // This function may be optionally provided by the user and should return
  57   // a string containing LSan suppressions.
  58   const char *__lsan_default_suppressions();
  59 #ifdef __cplusplus
  60 }  // extern "C"
  61
  62 namespace __lsan {
  63 class ScopedDisabler {
  64  public:
  65   ScopedDisabler() { __lsan_disable(); }
  66   ~ScopedDisabler() { __lsan_enable(); }
  67 };
  68 }  // namespace __lsan
  69 #endif
  70
  71 #endif  // SANITIZER_LSAN_INTERFACE_H