Header LALDebugLevel.h

Detailed Description

Control LALSuite debugging information verbosity and memory debugging features.

Author

Jolien Creighton, Kipp Cannon, Karl Wette

The LAL_DEBUG_LEVEL environment variable

Synopsis

$ export LAL_DEBUG_LEVEL=level[,level...]
 
$ env LAL_DEBUG_LEVEL=level[,level...] lalsuite-executable [args...]

Description

The environment variable LAL_DEBUG_LEVEL controls the default verbosity of LALSuite debugging information printed through the functions defined in Header LALError.h and Header XLALError.h . It also controls several memory debugging features implemented for memory allocated using the functions defined in Header LALMalloc.h .

Options

LAL_DEBUG_LEVEL is parsed as a comma-separated series of levels. (Empty levels are ignored.) Each level is a case-insensitive string, and may be one of the following:

• NDEBUG: No debugging information is printed and memory debugging features are disabled. This cancels out the effect of any previously-specified levels.
• Debugging information verbosity levels:
  • ERROR: Error messages are printed (default).
  • WARNING: Warning messages are printed.
  • INFO: Information messages are printed.
  • TRACE: Function call tracing messages are printed.
  • MSGLVL1: Equivalent to ERROR.
  • MSGLVL2: Equivalent to ERROR and WARNING combined.
  • MSGLVL3: Equivalent to ERROR, WARNING, and INFO combined.
• Memory debugging levels:
  • MEMDBG: Debugging of memory allocation routines is enabled, but no function call or memory allocation tracing messages are printed.
  • MEMTRACE: Debugging of memory allocation routines is enabled, and in addition function call and memory allocation tracing messages are printed.
• ALLDBG: All debugging information messages are printed, and all memory debugging features are enabled.

Prototypes
int	XLALGetDebugLevel (void)
void	XLALClobberDebugLevel (int level)

Enumerations
enum	{   LALERRORBIT = 0001 , LALWARNINGBIT = 0002 , LALINFOBIT = 0004 , LALTRACEBIT = 0010 ,   LALMEMDBGBIT = 0020 , LALMEMPADBIT = 0040 , LALMEMTRKBIT = 0100 , LALMEMINFOBIT = 0200 }
	lalDebugLevel bit field values More...
enum	{   LALNDEBUG = 0 , LALERROR = LALERRORBIT , LALWARNING = LALWARNINGBIT , LALINFO = LALINFOBIT ,   LALTRACE = LALTRACEBIT , LALMSGLVL1 = LALERRORBIT , LALMSGLVL2 = LALERRORBIT | LALWARNINGBIT , LALMSGLVL3 = LALERRORBIT | LALWARNINGBIT | LALINFOBIT ,   LALMEMDBG = LALMEMDBGBIT | LALMEMPADBIT | LALMEMTRKBIT , LALMEMTRACE = LALTRACEBIT | LALMEMDBG | LALMEMINFOBIT , LALALLDBG = ~LALNDEBUG }
	composite lalDebugLevel values More...

Macros
#define	lalDebugLevel   (XLALGetDebugLevel())

Function Documentation

XLALGetDebugLevel()

int XLALGetDebugLevel

(

void

)

Definition at line 117 of file LALDebugLevel.c.

XLALClobberDebugLevel()

void XLALClobberDebugLevel

(

int

level

)

Definition at line 54 of file LALDebugLevel.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

lalDebugLevel bit field values

Enumerator
LALERRORBIT	enable error messages
LALWARNINGBIT	enable warning messages
LALINFOBIT	enable info messages
LALTRACEBIT	enable tracing messages
LALMEMDBGBIT	enable memory debugging routines
LALMEMPADBIT	enable memory padding
LALMEMTRKBIT	enable memory tracking
LALMEMINFOBIT	enable memory info messages

Definition at line 32 of file LALDebugLevel.h.

anonymous enum

anonymous enum

composite lalDebugLevel values

Enumerator
LALNDEBUG	no debug
LALERROR	enable error messages
LALWARNING	enable warning messages
LALINFO	enable info messages
LALTRACE	enable tracing messages
LALMSGLVL1	enable error messages
LALMSGLVL2	enable error and warning messages
LALMSGLVL3	enable error, warning, and info messages
LALMEMDBG	enable memory debugging tools
LALMEMTRACE	enable memory tracing tools
LALALLDBG	enable all debugging

Definition at line 44 of file LALDebugLevel.h.

Macro Definition Documentation

lalDebugLevel

#define lalDebugLevel   (XLALGetDebugLevel())

Definition at line 58 of file LALDebugLevel.h.