Inheritance diagram for class svt_debug_opts:
The svt_debug_opts class is a singleton class that contains the automated debug options requested by users. Options are provided through the use of runtime plusarg +svt_debug_opts are used to control the behavior of this feature.
The +svt_debug_opts plusarg accepts a string value with the following format: inst:
Public Member Functions | |
| static function void | add_force_cb_save_to_fsdb_type ( string add_type ) |
| function void | end_debug_verbosity ( ) |
| static function svt_debug_opts | get ( ) |
| function longint | get_end_time ( ) |
| function svt_debug_opts_carrier | get_playback_callback_data_carrier ( string cb_name ) |
| function longint | get_start_time ( ) |
| function int | get_transcript_fh ( ) |
| function int | get_verbosity ( ) |
| function svt_vip_writer | get_writer ( string inst_name ) |
| static function bit | has_force_cb_save_to_fsdb_type ( string cb_name, string obj_typeobj_type = [$] ) |
| function bit | is_debug_enabled ( string inst_name, string type_name ) |
| function bit | is_feature_match ( string feature ) |
| function bit | is_parent_debug_enabled ( string inst_name ) |
| function void | log_global_settings ( ) |
| function void | log_instance_info ( ) |
| function void | log_phase_times ( ) |
| function void | new ( ) |
| function void | parse_plusarg ( ) |
| function void | parse_secondary_plusargs ( ) |
| task | put_playback_callback_data_carrier ( string cb_name, svt_debug_opts_carrier pdc ) |
| function void | record_debug_property ( string inst, string prop_name, bit [1023:0] prop_val, bit status ) |
| function void | record_header_line ( string line ) |
| function void | record_package_timeunit ( string package_name, string timeunit_value ) |
| function void | record_phase_start_time ( string name ) |
| function void | record_vip_info ( string inst, string if_path ) |
| function void | restore_messaging ( uvm_report_object restore_reporter, int restore_verbosity ) |
| function void | set_is_playback_callback_available ( string cb_name ) |
| function void | set_messaging ( uvm_report_object set_reporter ) |
| function void | set_top_level_component ( string inst_name ) |
| function bit | split_leaf_path_from_top_level ( string leaf_inst, output string top_level_inst, output string leaf_path ) |
| function void | start_debug_verbosity ( ) |
| function void | track_messaging ( string inst_name, string type_name, uvm_report_object track_reporter, int original_verbosity ) |
Public Attributes | |
| svt_debug_opts_carrier | playback_callback_intermediate_data_carrier [string] |
| uvm_report_object | reporter = svt_non_abstract_report_object; |
Member Typedefs | |
| typedef struct | package_timeunit_struct |
| typedef struct | phase_start_time_struct |
|
||
Function used to add a callback method name or a list of object types to the list of types identified as types whose callbacks should be force saved to fsdb when debug_opts enabled.
add_type - Callback method name or object type to be force logged |
|
||
Restores the global reporter's original verboisity
|
|
||
Obtain a handle to the singleton instance.
Return values - handle to the svt_debug_opts singleton instance |
|
||
Obtains the end_time value supplied through the +svt_debug_opts plusarg.
Return values - End time value obtained |
|
||
Function used to obtain the patten data carrier object associated with a specific callback name. During playback these values are supplied via the Playback Testbench after being extracted from the FSDB file.
cb_name - Full path to the callback in question |
|
||
Obtains the start_time value supplied through the +svt_debug_opts plusarg.
Return values - Start time value obtained |
|
||
Obtains the file handle for the transcript file that contains VIP messages.
Return values - file handle |
|
||
Obtains the verbosity value supplied through the +svt_debug_opts plusarg.
Return values - Verbosity value obtained |
|
||
Returns the VIP writer reference for the supplied instance
inst_name - Instance name to update |
|
||
Function used to see if any of the specified callback method names or object types as callback arguments that have been identified as being needed to be force saved to fsdb when debug_opts enabled.
cb_name - Callback method name to force logging for obj_type - Queue of object types to force logging for |
|
||
Routine that tests whether the supplied instance name or type name matches the values supplied through the +svt_debug_opts plusarg. This method returns 0 if the supplied inst_name is a sub-component of a component that has been enabled for debug. The is_parent_debug_enabled() method can be used to determine if this condition was true.
This method also populates the vip_descr [string] storage array with the status of this VIP instance. If empty inst_name and type_name values are provided this method returns the an indication of whether debug is enabled for anything in the system.
inst_name - Instance name to check against type_name - Type name to check against Return values - 1 if the supplied instance name was enabled for debug |
|
||
Routine that tests whether the supplied feature name matches the value supplied through the +svt_debug_opts plusarg.
feature - Instance name to check against Return values - 1 if the supplied feature name was matched |
|
||
Routine that returns true if the supplied instance name refers to a component that is a sub-component of a component that has been enabled for debug.
inst_name - Instance name to check against Return values - 1 if the supplied instance name is a sub-component of a debug enabled component |
|
||
Logs the recorded general header information
|
|
||
Logs the recorded VIP header information
|
|
||
Logs the last debug information and closes the file handle
|
|
||
CONSTRUCTOR: Creates a new instance of the data class.
Note: Should not be called directly. Clients should instead call the static get method to obtain a handle to the singleton. |
|
||
Obtains the plusarg value supplied via +svt_debug_opts and parses this into internal control properties.
|
|
||
Obtains the debug_opts plusarg values supplied via keywords other than +svt_debug_opts, as adjuncts to the +svt_debug_opts options. Only executed if debug_opts have been enabled.
|
|
||
Task used to push the pattern data carrier associated with a specific callback name to the mailbox. During playback these are are supplied by the Playback Testbench after being extracted from the FSDB file.
cb_name - Full path to the callback in question pdc - Pattern Data Carrier object associated with the latest callback execution |
|
||
Stores the debug feature that is enabled through the auto-debug utility
inst - Instance name that the debug property is associated with prop_name - Property name being recorded prop_val - Property value being recorded, expressed as a 1024 bit quantity. status - Status that indicates whether the feature was succesfully enabled |
|
||
Records a line of header information. The following data is pushed to this method:
line - Single line of formatted header information |
|
||
Records the timeunits that have been compiled for each package
package_name - Name of the package for the supplied timeunit value timeunit_value - Timeunit value for the supplied package name |
|
||
Records the start time for each phase
name - Full context for the phase |
|
||
|
||
Used to restore reporter messaging to its original verbosity, and to redirect it to the display.
restore_reporter - The report object to be updated. restore_verbosity - The verbosity which is to be restored. |
|
||
Enables callback playback for the supplied callback name. When playback for a callback is not enabled the get_playback_callback_data_carrier method will return in zero time with a null reference for the pattern data carrier.
cb_name - Full path to the callback in question |
|
||
Used to update the reporter messaging to go to a log file based on the debug_opts verbosity settings.
set_reporter - The report object to be updated with the new verbosity. |
|
||
Marks the VIP descriptor entry for this instance as a top level component.
inst_name - Instance name to update |
|
||
Splits the leaf path from the top level instance if the component is enabled for debug.
leaf_inst - Full path name of a sub-component top_level_inst - Full path of the top-level component is returned leaf_path - Leaf path from the top level component is returned Return values - 1 if the component is a sub-component of a debug enabled component. |
|
||
Sets the global reporter to the debug verbosity
|
|
||
Used to track the debug_opts start/end settings and update the messaging as needed.
inst_name - Instance name to check against. type_name - Type name to check against. track_reporter - The report object to be updated at the start and end times. original_verbosity - Verbosity value saved prior to modification by the auto-debug features. Ignored if the start time has not occurred yet. |
|
|
associative array to hold pattern data carrier objects associated with callbacks which are received from mailbox but values are not updated in the task update_object_prop_vals in svt_debug_opts_carrier. the associative array is indexed by a string value representing the callback name. the callback name supplied is qualified with the full path to the component that owns it, and so it is guaranteed to be unique.
|
|
|
All messages routed through `SVT_XVM(top)
|
|
|