Home » SSTDocumentation » SST Core Output Class

SST Core Output Class

The SST Output class provides a standardized method to format and output logging messages

Introduction

The SST Output class provides a standardized method to format and output logging messages. It is used by the SST core and SST Elements (Components).

Details

The SST Output class provides a standardized method to format and output logging messages. It is used by the SST core and SST Elements (Components). It should also be used in any “glue” software in the SST repository that interfaces to an external component.
The class is part of the SST Core in the sst/core/output.h and sst/core/output.cc files.
It is intended that all SST Components use the output class for consistency.
The output can be targeted to stderr, stdout, a file, or bit bucket as necessary.
Output targeted to a file will always go to file “sst_output” unless the sst runtime option “debug-file” is used.
Many of the functions provide the ability to set logging levels and masking bits to control the level of detail of the output.
Each instantiation of the class provides:
- Prefix Data - A formatted text string that may be outputted before the users normal output.
- Verbose Level - Output will only occur if output level is above the verbose level.
- Verbose Mask - Output will only occur if output bits match the bits set in the Verbose Mask.
- Target Output Location - stderr, stdout, file or none.
The Prefix Data formatted data may contain user data along with selectable SST information such as MPI rank info, timestamp or calling function, line number and file.
A CALL_INFO macro is provided to support easy access to parameters for calling function, line and file.
The class provides functions for:
- Output - Like a standard printf, may also contain prefix data.
- Verbose - Like the output function but with prefix data and controlled with logging level and mask.
- Debug - Similar to verbose function, but calls are not compiled unless the -enable-debug flag is set in the SST configuration.
- Fatal - Fatal error message that will terminate the simulation (and call MPI_Abort). The output is always sent to stderr regardless of users target output location.
Support functions exist to change prefix, verbose level, verbose mask, and target output.
EXAMPLE

Source

Output testoutput("Prefix-File=@f; Line=@l; Func=@p; Time=@t; Rank=@r -- ", 4, 0x01, SST::Output::STDOUT);
Testoutput.verbose(CALL_INFO, 0, 0x00, "FORMAT %d DATA\n", 1234);
Testoutput.verbose(CALL_INFO, 5, 0x00, "THIS WILL NOT PRINT\n");

Output

Prefix-File=simpleOutputTestComponent.cc; Line=39; Func=simpleOutputTest; Time=0; Rank=0 -- FORMAT 1234 DATA