uvm_report_object

The uvm_report_object provides an interface to the UVM reporting facility.  Through this interface, components issue the various messages that occur during simulation.  Users can configure what actions are taken and what file(s) are output for individual messages from a particular component or for all messages from all components in the environment.  Defaults are applied where there is no explicit configuration.

Most methods in uvm_report_object are delegated to an internal instance of a uvm_report_handler, which stores the reporting configuration and determines whether an issued message should be displayed based on that configuration.  Then, to display a message, the report handler delegates the actual formatting and production of messages to a central uvm_report_server.

A report consists of an id string, severity, verbosity level, and the textual message itself.  They may optionally include the filename and line number from which the message came.  If the verbosity level of a report is greater than the configured maximum verbosity level of its report object, it is ignored.  If a report passes the verbosity filter in effect, the report’s action is determined.  If the action includes output to a file, the configured file descriptor(s) are determined.

Actionscan be set for (in increasing priority) severity, id, and (severity,id) pair.  They include output to the screen UVM_DISPLAY, whether the message counters should be incremented UVM_COUNT, and whether a $finish should occur UVM_EXIT.
Default ActionsThe following provides the default actions assigned to each severity.  These can be overridden by any of the set_*_action methods.
UVM_INFO -       UVM_DISPLAY
UVM_WARNING -    UVM_DISPLAY
UVM_ERROR -      UVM_DISPLAY | UVM_COUNT
UVM_FATAL -      UVM_DISPLAY | UVM_EXIT
File descriptorsThese can be set by (in increasing priority) default, severity level, an id, or (severity,id) pair.  File descriptors are standard SystemVerilog file descriptors; they may refer to more than one file.  It is the user’s responsibility to open and close them.
Default file handleThe default file handle is 0, which means that reports are not sent to a file even if a UVM_LOG attribute is set in the action associated with the report.  This can be overridden by any of the set_*_file methods.
Summary
uvm_report_object
The uvm_report_object provides an interface to the UVM reporting facility.
Class Hierarchy
uvm_void
uvm_object
uvm_report_object
Class Declaration
class uvm_report_object extends uvm_object
newCreates a new report object with the given name.
Reporting
uvm_get_report_objectReturns the nearest uvm_report_object when called.
uvm_report_enabledReturns 1 if the configured verbosity for this severity/id is greater than or equal to verbosity else returns 0.
uvm_report
uvm_report_info
uvm_report_warning
uvm_report_error
uvm_report_fatalThese are the primary reporting methods in the UVM.
uvm_process_report_messageThis method takes a preformed uvm_report_message, populates it with the report object and passes it to the report handler for processing.
Verbosity Configuration
get_report_verbosity_levelGets the verbosity level in effect for this object.
get_report_max_verbosity_levelGets the maximum verbosity level in effect for this report object.
set_report_verbosity_levelThis method sets the maximum verbosity level for reports for this component.
set_report_id_verbosity
set_report_severity_id_verbosityThese methods associate the specified verbosity threshold with reports of the given severity, id, or severity-id pair.
Action Configuration
get_report_actionGets the action associated with reports having the given severity and id.
set_report_severity_action
set_report_id_action
set_report_severity_id_actionThese methods associate the specified action or actions with reports of the given severity, id, or severity-id pair.
File Configuration
get_report_file_handleGets the file descriptor associated with reports having the given severity and id.
set_report_default_file
set_report_id_file
set_report_severity_file
set_report_severity_id_fileThese methods configure the report handler to direct some or all of its output to the given file descriptor.
Override Configuration
set_report_severity_override
set_report_severity_id_overrideThese methods provide the ability to upgrade or downgrade a message in terms of severity given severity and id.
Report Handler Configuration
set_report_handlerSets the report handler, overwriting the default instance.
get_report_handlerReturns the underlying report handler to which most reporting tasks are delegated.
reset_report_handlerResets the underlying report handler to its default settings.

new

function new(
    string  name  =  ""
)

Creates a new report object with the given name.  This method also creates a new uvm_report_handler object to which most tasks are delegated.

Reporting

uvm_get_report_object

function uvm_report_object uvm_get_report_object()

Returns the nearest uvm_report_object when called.  From inside a uvm_component, the method simply returns this.

See also the global version of uvm_get_report_object.

uvm_report_enabled

function int uvm_report_enabled(
    int  verbosity,   
    uvm_severity  severity  =  UVM_INFO,
    string  id  =  ""
)

Returns 1 if the configured verbosity for this severity/id is greater than or equal to verbosity else returns 0.

See also get_report_verbosity_level and the global version of uvm_report_enabled.

uvm_report

virtual function void uvm_report(
    uvm_severity  severity,   
    string  id,   
    string  message,   
    int  verbosity  =  (severity == uvm_severity'(UVM_ERROR)) ? UVM_LOW : (severity == uvm_severity'(UVM_FATAL)) ? UVM_NONE : UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)

uvm_report_info

virtual function void uvm_report_info(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)

uvm_report_warning

virtual function void uvm_report_warning(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)

uvm_report_error

virtual function void uvm_report_error(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_LOW,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)

uvm_report_fatal

virtual function void uvm_report_fatal(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_NONE,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)

These are the primary reporting methods in the UVM.  Using these instead of $display and other ad hoc approaches ensures consistent output and central control over where output is directed and any actions that result.  All reporting methods have the same arguments, although each has a different default verbosity:

ida unique id for the report or report group that can be used for identification and therefore targeted filtering.  You can configure an individual report’s actions and output file(s) using this id string.
messagethe message body, preformatted if necessary to a single string.
verbositythe verbosity of the message, indicating its relative importance.  If this number is less than or equal to the effective verbosity level, see set_report_verbosity_level, then the report is issued, subject to the configured action and file descriptor settings.  Verbosity is ignored for warnings, errors, and fatals.  However, if a warning, error or fatal is demoted to an info message using the uvm_report_catcher, then the verbosity is taken into account.
filename/line(Optional) The location from which the report was issued.  Use the predefined macros, `__FILE__ and `__LINE__.  If specified, it is displayed in the output.
context_name(Optional) The string context from where the message is originating.  This can be the %m of a module, a specific method, etc.
report_enabled_checked(Optional) This bit indicates whether the currently provided message has been checked as to whether the message should be processed.  If it hasn’t been checked, it will be checked inside the uvm_report function.

uvm_process_report_message

virtual function void uvm_process_report_message(
    uvm_report_message  report_message
)

This method takes a preformed uvm_report_message, populates it with the report object and passes it to the report handler for processing.  It is expected to be checked for verbosity and populated.

Verbosity Configuration

get_report_verbosity_level

function int get_report_verbosity_level(
    uvm_severity  severity  =  UVM_INFO,
    string  id  =  ""
)

Gets the verbosity level in effect for this object.  Reports issued with verbosity greater than this will be filtered out.  The severity and tag arguments check if the verbosity level has been modified for specific severity/tag combinations.

get_report_max_verbosity_level

function int get_report_max_verbosity_level()

Gets the maximum verbosity level in effect for this report object.  Any report from this component whose verbosity exceeds this maximum will be ignored.

set_report_verbosity_level

function void set_report_verbosity_level (
    int  verbosity_level
)

This method sets the maximum verbosity level for reports for this component.  Any report from this component whose verbosity exceeds this maximum will be ignored.

set_report_id_verbosity

function void set_report_id_verbosity (
    string  id,
    int  verbosity
)

set_report_severity_id_verbosity

function void set_report_severity_id_verbosity (
    uvm_severity  severity,
    string  id,
    int  verbosity
)

These methods associate the specified verbosity threshold with reports of the given severity, id, or severity-id pair.  This threshold is compared with the verbosity originally assigned to the report to decide whether it gets processed.  A verbosity threshold associated with a particular severity-id pair takes precedence over a verbosity threshold associated with id, which takes precedence over a verbosity threshold associated with a severity.

The verbosity argument can be any integer, but is most commonly a predefined uvm_verbosity value, UVM_NONE, UVM_LOW, UVM_MEDIUM, UVM_HIGH, UVM_FULL.

Action Configuration

get_report_action

function int get_report_action(
    uvm_severity  severity,
    string  id
)

Gets the action associated with reports having the given severity and id.

set_report_severity_action

function void set_report_severity_action (
    uvm_severity  severity,
    uvm_action  action
)

set_report_id_action

function void set_report_id_action (
    string  id,
    uvm_action  action
)

set_report_severity_id_action

function void set_report_severity_id_action (
    uvm_severity  severity,
    string  id,
    uvm_action  action
)

These methods associate the specified action or actions with reports of the given severity, id, or severity-id pair.  An action associated with a particular severity-id pair takes precedence over an action associated with id, which takes precedence over an action associated with a severity.

The action argument can take the value UVM_NO_ACTION, or it can be a bitwise OR of any combination of UVM_DISPLAY, UVM_LOG, UVM_COUNT, UVM_STOP, UVM_EXIT, and UVM_CALL_HOOK.

File Configuration

get_report_file_handle

function int get_report_file_handle(
    uvm_severity  severity,
    string  id
)

Gets the file descriptor associated with reports having the given severity and id.

set_report_default_file

function void set_report_default_file (
    UVM_FILE  file
)

set_report_id_file

function void set_report_id_file (
    string  id,
    UVM_FILE  file
)

set_report_severity_file

function void set_report_severity_file (
    uvm_severity  severity,
    UVM_FILE  file
)

set_report_severity_id_file

function void set_report_severity_id_file (
    uvm_severity  severity,
    string  id,
    UVM_FILE  file
)

These methods configure the report handler to direct some or all of its output to the given file descriptor.  The file argument must be a multi-channel descriptor (mcd) or file id compatible with $fdisplay.

A FILE descriptor can be associated with reports of the given severity, id, or severity-id pair.  A FILE associated with a particular severity-id pair takes precedence over a FILE associated with id, which take precedence over an a FILE associated with a severity, which takes precedence over the default FILE descriptor.

When a report is issued and its associated action has the UVM_LOG bit set, the report will be sent to its associated FILE descriptor.  The user is responsible for opening and closing these files.

Override Configuration

set_report_severity_override

function void set_report_severity_override(
    uvm_severity  cur_severity,
    uvm_severity  new_severity
)

set_report_severity_id_override

function void set_report_severity_id_override(
    uvm_severity  cur_severity,
    string  id,
    uvm_severity  new_severity
)

These methods provide the ability to upgrade or downgrade a message in terms of severity given severity and id.  An upgrade or downgrade for a specific id takes precedence over an upgrade or downgrade associated with a severity.

Report Handler Configuration

set_report_handler

function void set_report_handler(
    uvm_report_handler  handler
)

Sets the report handler, overwriting the default instance.  This allows more than one component to share the same report handler.

get_report_handler

function uvm_report_handler get_report_handler()

Returns the underlying report handler to which most reporting tasks are delegated.

reset_report_handler

function void reset_report_handler

Resets the underlying report handler to its default settings.  This clears any settings made with the set_report_* methods (see below).

virtual class uvm_void
The uvm_void class is the base class for all UVM classes.
virtual class uvm_object extends uvm_void
The uvm_object class is the base class for all UVM data and hierarchical classes.
class uvm_report_object extends uvm_object
The uvm_report_object provides an interface to the UVM reporting facility.
function new(
    string  name  =  ""
)
Creates a new report object with the given name.
function uvm_report_object uvm_get_report_object()
Returns the nearest uvm_report_object when called.
function int uvm_report_enabled(
    int  verbosity,   
    uvm_severity  severity  =  UVM_INFO,
    string  id  =  ""
)
Returns 1 if the configured verbosity for this severity/id is greater than or equal to verbosity else returns 0.
virtual function void uvm_report(
    uvm_severity  severity,   
    string  id,   
    string  message,   
    int  verbosity  =  (severity == uvm_severity'(UVM_ERROR)) ? UVM_LOW : (severity == uvm_severity'(UVM_FATAL)) ? UVM_NONE : UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)
virtual function void uvm_report_info(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)
virtual function void uvm_report_warning(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_MEDIUM,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)
virtual function void uvm_report_error(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_LOW,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)
virtual function void uvm_report_fatal(
    string  id,   
    string  message,   
    int  verbosity  =  UVM_NONE,
    string  filename  =  "",
    int  line  =  0,
    string  context_name  =  "",
    bit  report_enabled_checked  =  0
)
These are the primary reporting methods in the UVM.
virtual function void uvm_process_report_message(
    uvm_report_message  report_message
)
This method takes a preformed uvm_report_message, populates it with the report object and passes it to the report handler for processing.
function int get_report_verbosity_level(
    uvm_severity  severity  =  UVM_INFO,
    string  id  =  ""
)
Gets the verbosity level in effect for this object.
function int get_report_max_verbosity_level()
Gets the maximum verbosity level in effect for this report object.
function void set_report_verbosity_level (
    int  verbosity_level
)
This method sets the maximum verbosity level for reports for this component.
function void set_report_id_verbosity (
    string  id,
    int  verbosity
)
function void set_report_severity_id_verbosity (
    uvm_severity  severity,
    string  id,
    int  verbosity
)
These methods associate the specified verbosity threshold with reports of the given severity, id, or severity-id pair.
function int get_report_action(
    uvm_severity  severity,
    string  id
)
Gets the action associated with reports having the given severity and id.
function void set_report_severity_action (
    uvm_severity  severity,
    uvm_action  action
)
function void set_report_id_action (
    string  id,
    uvm_action  action
)
function void set_report_severity_id_action (
    uvm_severity  severity,
    string  id,
    uvm_action  action
)
These methods associate the specified action or actions with reports of the given severity, id, or severity-id pair.
function int get_report_file_handle(
    uvm_severity  severity,
    string  id
)
Gets the file descriptor associated with reports having the given severity and id.
function void set_report_default_file (
    UVM_FILE  file
)
function void set_report_id_file (
    string  id,
    UVM_FILE  file
)
function void set_report_severity_file (
    uvm_severity  severity,
    UVM_FILE  file
)
function void set_report_severity_id_file (
    uvm_severity  severity,
    string  id,
    UVM_FILE  file
)
These methods configure the report handler to direct some or all of its output to the given file descriptor.
function void set_report_severity_override(
    uvm_severity  cur_severity,
    uvm_severity  new_severity
)
function void set_report_severity_id_override(
    uvm_severity  cur_severity,
    string  id,
    uvm_severity  new_severity
)
These methods provide the ability to upgrade or downgrade a message in terms of severity given severity and id.
function void set_report_handler(
    uvm_report_handler  handler
)
Sets the report handler, overwriting the default instance.
function uvm_report_handler get_report_handler()
Returns the underlying report handler to which most reporting tasks are delegated.
function void reset_report_handler
Resets the underlying report handler to its default settings.
class uvm_report_handler extends uvm_object
The uvm_report_handler is the class to which most methods in uvm_report_object delegate.
uvm_report_server is a global server that processes all of the reports generated by a uvm_report_handler.
Sends the report to the standard output
Counts the number of reports with the COUNT attribute.
Terminates the simulation immediately.
virtual class uvm_report_catcher extends uvm_callback
The uvm_report_catcher is used to catch messages issued by the uvm report server.
Defines standard verbosity levels for reports.
Report is always printed.
Report is issued if configured verbosity is set to UVM_LOW or above.
Report is issued if configured verbosity is set to UVM_MEDIUM or above.
Report is issued if configured verbosity is set to UVM_HIGH or above.
Report is issued if configured verbosity is set to UVM_FULL or above.
No action is taken
Sends the report to the file(s) for this (severity,id) pair
Causes $stop to be executed, putting the simulation into interactive mode.
Callback the report hook methods