| Sergey Matveev | f4633ac | 2013-05-14 15:48:54 +0000 | [diff] [blame] | 1 | ================ |
| 2 | LeakSanitizer |
| 3 | ================ |
| 4 | |
| 5 | .. contents:: |
| 6 | :local: |
| 7 | |
| 8 | Introduction |
| 9 | ============ |
| 10 | |
| Sergey Matveev | 072db59 | 2013-12-10 20:10:30 +0000 | [diff] [blame] | 11 | LeakSanitizer is a run-time memory leak detector. It can be combined with |
| 12 | :doc:`AddressSanitizer` to get both memory error and leak detection. |
| 13 | LeakSanitizer does not introduce any additional slowdown when used in this mode. |
| 14 | The LeakSanitizer runtime can also be linked in separately to get leak detection |
| 15 | only, at a minimal performance cost. |
| Sergey Matveev | f4633ac | 2013-05-14 15:48:54 +0000 | [diff] [blame] | 16 | |
| 17 | Current status |
| 18 | ============== |
| 19 | |
| Anna Zaks | 8264a8c | 2015-06-25 23:36:44 +0000 | [diff] [blame] | 20 | LeakSanitizer is turned on by default, but it is only supported on x86\_64 |
| 21 | Linux. |
| Sergey Matveev | 072db59 | 2013-12-10 20:10:30 +0000 | [diff] [blame] | 22 | |
| 23 | The combined mode has been tested on fairly large software projects. The |
| 24 | stand-alone mode has received much less testing. |
| 25 | |
| 26 | There are plans to support LeakSanitizer in :doc:`MemorySanitizer` builds. |
| Sergey Matveev | f4633ac | 2013-05-14 15:48:54 +0000 | [diff] [blame] | 27 | |
| 28 | More Information |
| 29 | ================ |
| 30 | |
| Alexey Samsonov | 2e2469d | 2015-12-04 00:38:13 +0000 | [diff] [blame] | 31 | `<https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer>`_ |