Skip to content

Behaviour.md

Latest commit

 

History

History
163 lines (115 loc) · 4.15 KB

Behaviour.md

File metadata and controls

163 lines (115 loc) · 4.15 KB

Behavior

The LeakSanitizer allows you to adjust its behavior using a set of environment variables.

Environment variables

LSAN_HUMAN_PRINT

Indicates whether to print in a human-readable format.

Type: Boolean
Default value: true

LSAN_PRINT_COUT

Whether to print to the standard output stream.

Type: Boolean
Default value: false

LSAN_PRINT_FORMATTED

Whether to print the output using ANSI escape codes.

Type: Boolean
Default value: true

LSAN_INVALID_CRASH

Whether to terminate the program once an invalid action is detected.

Type: Boolean
Default value: true

LSAN_INVALID_FREE

Whether to check for invalid memory deallocations.

Type: Boolean
Default value: true

LSAN_FREE_NULL

Whether to issue a warning when deallocating a null pointer.

Type: Boolean
Default value: false

LSAN_STATS_ACTIVE

Whether to activate the statistical bookkeeping.

The C API for the statistics is only functional if either this variable is set to true or LSAN_AUTO_STATS is set to a valid time interval.

Type: Boolean
Default value: false

LSAN_CALLSTACK_SIZE

Defines the number of lines for a callstack to print.

Type: Non-negative integral number
Default value: 20

LSAN_PRINT_EXIT_POINT

Whether to print the callstack of the exit point.

Might lead to strange callstacks since calling exit may optimize the stack for never returning from that function.

Type: Boolean
Default value: false
Since: v1.7

LSAN_PRINT_BINARIES

Whether to print the binary file names associated with a particular call frame within stacktraces.

Type: Boolean
Default value: true
Since: v1.8

LSAN_PRINT_FUNCTIONS

Whether to always print function names within stacktraces, even if debug symbols are available.

Type: Boolean
Default value: true
Since: v1.8

LSAN_RELATIVE_PATHS

Whether to use relative paths where appropriate.

Type: Boolean
Default value: true
Since: v1.8

LSAN_ZERO_ALLOCTION

Whether to issue a warning when allocating zero bytes of memory.

Type: Boolean
Default value: false
Since: v1.8

LSAN_AUTO_STATS

The time interval for printing the statistics automatically.

Implicitly sets LSAN_STATS_ACTIVE to true.

Types: Time interval, non-negative integral number (interpreted as seconds)
Default value: None
Since: v1.11

LSAN_SUPPRESSION_DEVELOPER

Whether to print errors and warnings related to the suppression system.

This might be helpful in order to write your own suppression files.

Type: Boolean
Default value: false
Since: v1.11

LSAN_INDIRECT_LEAKS

Whether to print the stacktraces of indirectly leaked memory allocations.

Type: Boolean
Default value: false
Since: v1.11

LSAN_REACHABLE_LEAKS

Whether to print the stacktraces of memory leaks to which a pointer was found.

Type: Boolean
Default value: true
Since: v1.11

LSAN_SUPPRESSION_FILES

List of additional suppression files to be considered.

Type: File list
Default value: None
Since: v1.11

LSAN_SYSTEM_LIBRARY_FILES

List of additional system library files to be considered.

Type: File list
Default value: None
Since: v1.11

Variable types

Boolean

Boolean variables can be assigned a number, they are interpreted as in the programming language C.
They can also be assigned (case-insensitive): true and false.

File list

File lists consist of file paths separated by :.

Time interval

Time intervals are defined as non-negative integral number, which may immediately be followed by the time unit, of which are supported:

  • ns: nanoseconds
  • us: microseconds
  • ms: milliseconds
  • s: seconds
  • m: minutes
  • h: hours