leak_annotations.h 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. // Copyright (c) 2011 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #ifndef BASE_DEBUG_LEAK_ANNOTATIONS_H_
  5. #define BASE_DEBUG_LEAK_ANNOTATIONS_H_
  6. #include "base/macros.h"
  7. #include "build/build_config.h"
  8. // This file defines macros which can be used to annotate intentional memory
  9. // leaks. Support for annotations is implemented in LeakSanitizer. Annotated
  10. // objects will be treated as a source of live pointers, i.e. any heap objects
  11. // reachable by following pointers from an annotated object will not be
  12. // reported as leaks.
  13. //
  14. // ANNOTATE_SCOPED_MEMORY_LEAK: all allocations made in the current scope
  15. // will be annotated as leaks.
  16. // ANNOTATE_LEAKING_OBJECT_PTR(X): the heap object referenced by pointer X will
  17. // be annotated as a leak.
  18. #if defined(LEAK_SANITIZER) && !defined(OS_NACL)
  19. #include <sanitizer/lsan_interface.h>
  20. class ScopedLeakSanitizerDisabler {
  21. public:
  22. ScopedLeakSanitizerDisabler() { __lsan_disable(); }
  23. ~ScopedLeakSanitizerDisabler() { __lsan_enable(); }
  24. private:
  25. DISALLOW_COPY_AND_ASSIGN(ScopedLeakSanitizerDisabler);
  26. };
  27. #define ANNOTATE_SCOPED_MEMORY_LEAK \
  28. ScopedLeakSanitizerDisabler leak_sanitizer_disabler; static_cast<void>(0)
  29. #define ANNOTATE_LEAKING_OBJECT_PTR(X) __lsan_ignore_object(X);
  30. #else
  31. #define ANNOTATE_SCOPED_MEMORY_LEAK ((void)0)
  32. #define ANNOTATE_LEAKING_OBJECT_PTR(X) ((void)0)
  33. #endif
  34. #endif // BASE_DEBUG_LEAK_ANNOTATIONS_H_