Method Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 apply_config_settings
 apply_config_settings_mode
B
 begin_tr
C
 cleanup_phase
 compose_report_message
D
 debug_connected_to
 debug_create_by_name
 debug_create_by_type
 debug_provided_to
 debug_report_catcher
 do_check_error
 do_close
 do_close_db
 do_compare
 do_copy
 do_establish_link
 do_free
 do_open
 do_open_db
 do_open_recorder
 do_open_stream
 do_read
 do_write
 drop_objection
E
 end_phase
 evict
 evict_to_max
 execute_on
 execute_phase
 exists
F
 find_unused_resources
 finish_phase
 flush
G
 get
 get_by_name
 get_by_type
 get_comp
 get_connected_to
 get_default_map
 get_default_printer
 get_enable_print_topology
 get_first_copy
 get_global_hopper
 get_imp
 get_last_copy
 get_max_size
 get_next_copy
 get_num_copies
 get_objection
 get_objection_count
 get_objection_total
 get_phase_hopper
 get_prev_copy
 get_print_config_matches
 get_rand_mode
I
 is_tracing
K
 keys
N
 new
P
 pack_object_with_meta
 peek
 print_accessors
 print_catcher
 print_config
 process_phase
 put
R
 raise_objection
 read
 read_by_name
 read_by_type
 record_read_access
 record_write_access
 run_phases
S
 set
 set_anonymous
 set_default
 set_enable_print_topology
 set_file_name
 set_imp
 set_max_size
 set_override
 set_override_name
 set_override_type
 set_print_config_matches
 set_rand_mode
 set_recording_enabled
 set_type_alias
 show_msg
 size
 start_phase
T
 Transitions
 traverse_on
 trigger_modified
 try_get
 try_peek
 try_put
 turn_off_tracing
 turn_on_tracing
U
 unpack_object_with_meta
 uvm_init
 uvm_wait_for_nba_region
W
 wait_for_objection
 wait_for_waiters
 wait_modified
 write
 write_attribute
 write_attribute_int
 write_by_name
 write_by_type
The apply_config_settings method diverges from the 1800.2 standard definition, using apply_config_settings_mode to determine how the resource pool shall be queried.
virtual function config_mode_t apply_config_settings_mode()
Controls the configuration mode for uvm_component::apply_config_settings.
Implementation of uvm_component::begin_tr as described in IEEE 1800.2-2020.
protected virtual task cleanup_phase(
    uvm_phase  phase
)
Performs actions associated with transitioning phase state to the UVM_PHASE_CLEANUP or UVM_PHASE_JUMPING state.
virtual function string compose_report_message(
    uvm_report_message  report_message,   
    string  report_object_name  =  ""
)
Constructs the actual string sent to the file or command line from the report message.
function void debug_connected_to (
    int  level  =  0,
    int  max_level  =  -1
)
The debug_connected_to method outputs a visual text display of the port/export/imp network to which this port connects (i.e., the port’s fanout).
virtual function void debug_create_by_name (
    string  requested_type_name,   
    string  parent_inst_path  =  "",
    string  name  =  ""
)
Debug traces for create_*_by_name methods.
virtual function void debug_create_by_type (
    uvm_object_wrapper  requested_type,   
    string  parent_inst_path  =  "",
    string  name  =  ""
)
Debug traces for create_*_by_type methods.
function void debug_provided_to (
    int  level  =  0,
    int  max_level  =  -1
)
The debug_provided_to method outputs a visual display of the port/export network that ultimately connect to this port (i.e., the port’s fanin).
static function void debug_report_catcher(
    int  what  =  0
)
Turn on report catching debug information.
virtual function void do_check_error(
    uvm_reg  this_reg,
    uvm_reg_data_t  expected,
    uvm_reg_data_t  actual,
    uvm_reg_map  map,
    uvm_reg_data_t  valid_bits_mask
)
Called when do_check finds a mismatch to create the error message and any other supporting information.
protected virtual function void do_close()
Callback triggered via uvm_tr_stream::close.
protected virtual function bit do_close_db()
Close the backend connection to the database.
function bit do_compare(
    uvm_object  rhs,
    uvm_comparer  comparer
)
Compares this generic payload to rhs.
virtual function void do_copy(
    uvm_object  rhs
)
Copy the rhs object into this object.
protected virtual function void do_establish_link(
    uvm_link_base  link
)
Establishes a link between two elements in the database
protected virtual function void do_free()
Callback triggered via uvm_tr_stream::free.
protected virtual function void do_open(
    uvm_tr_database  db,
    string  scope,
    string  stream_type_name
)
Callback triggered via uvm_tr_database::open_stream.
protected virtual function bit do_open_db()
Open the backend connection to the database.
protected virtual function uvm_recorder do_open_recorder(
    string  name,
    time  open_time,
    string  type_name
)
Marks the beginning of a new record in the stream
protected virtual function uvm_tr_stream do_open_stream(
    string  name,
    string  scope,
    string  type_name
)
Provides a reference to a stream within the database.
protected virtual function void drop_objection(
    uvm_object  obj,   
    string  description  =  "",
    int  count  =  1
)
This is a pass through to uvm_objection::drop_objection on the objection returned by get_objection.
protected virtual task end_phase(
    uvm_phase  phase
)
Performs actions associated with transitioning phase state to the UVM_PHASE_ENDED state.
pure virtual function optional_data evict(
    KEY_T  key
)
Removes the data at key from the cache.
virtual function optional_data evict(
    KEY_T  key
)
Removes the data at key from the cache.
pure virtual protected function void evict_to_max()
Hook for evicting all keys greater than maximum size.
protected virtual function void evict_to_max()
Implementation of uvm_cache#(KEY_T,DATA_T)::evict_to_max hook.
virtual function void execute_on(
    uvm_phase  imp,
    uvm_component  comp,
    uvm_phase  node
)
Calls execute on imp, passing in comp, and node.
protected virtual task execute_phase(
    uvm_phase  phase
)
Performs actions associated with transitioning phase state to the UVM_PHASE_EXECUTING state.
pure virtual function bit exists(
    KEY_T  key
)
Returns true if key exists in the cache, otherwise returns false.
virtual function bit exists(
    uvm_component  cntxt,
    string  inst_name,
    string  field_name,
    bit  rpterr
)
Provides an implementation of get @uvm-accellera
pure virtual function bit exists(
    uvm_component  cntxt,
    string  inst_name,
    string  field_name,
    bit  rpterr
)
Intended to provide the functionality for uvm_config_db#(T)::exists @uvm-contrib
virtual function bit exists(
    KEY_T  key
)
Returns true if key exists in the cache, otherwise returns false.
function uvm_resource_types::rsrc_q_t find_unused_resources()
Locate all the resources that have at least one write and no reads
protected virtual task finish_phase(
    uvm_phase  phase
)
Performs actions associated with transitioning phase state to the UVM_PHASE_DONE state.
virtual function void flush()
Evicts all keys from the cache.
virtual function void flush()
Clear the state of the predictor including the pending writes.
pure virtual function optional_data get(
    KEY_T  key
)
Returns data associated with key.
virtual function bit get (
    uvm_component  cntxt,
    string  inst_name,
    string  field_name,
    inout  value
)
Provides an implementation of get, including support for config_db tracing @uvm-accellera
pure virtual function bit get (
    uvm_component  cntxt,
    string  inst_name,
    string  field_name,
    inout  value
)
Intended to provide the functionality for uvm_config_db#(T)::get @uvm-contrib
virtual function optional_data get(
    KEY_T  key
)
Returns data associated with key.
protected virtual task get(
    output  uvm_phase  phase
)
Retrieves the next phase from the hopper.
virtual function rsrc_t get_by_name(
    string  scope,
    string  name,
    bit  rpterr
)
Provides an implementation of get_by_name, with a warning if the matching resource is the wrong type.
pure virtual function rsrc_t get_by_name(
    string  scope,
    string  name,
    bit  rpterr
)
Intended to provide the functionality for uvm_resource_db#(T)::get_by_name @uvm-contrib
virtual function rsrc_t get_by_type(
    string  scope
)
Provides an implementation of get_by_type, with a warning if the resource was not located.
pure virtual function rsrc_t get_by_type(
    string  scope
)
Intended to provide the functionality for uvm_resource_db#(T)::get_by_type @uvm-contrib
virtual function uvm_port_component_base get_comp()
Returns a handle to the internal proxy component representing this port.
virtual function void get_connected_to(
    ref  uvm_port_list  list
)
Implementation of the pure function declared in uvm_port_component_base
pure virtual function void get_connected_to(
    ref  uvm_port_list  list
)
For a port or export type, this function fills list with all of the ports, exports and implementations that this port is connected to.
virtual function uvm_reg_map get_default_map ()
virtual function uvm_printer get_default_printer()
Implementation of the get_default_printer method, as defined in section F.4.1.4.13 of 1800.2-2020.
function bit get_enable_print_topology ()
Gets the variable to enable printing the entire testbench topology just after completion of the end_of_elaboration phase..
static function uvm_phase_hopper get_global_hopper()
Returns the global phase hopper.
static function uvm_config_db_implementation_t #(
    T
) get_imp()
Returns the implementation instance to be used.
static function uvm_resource_db_implementation_t #(
    T
) get_imp ()
Returns the implementation instance to be used.
virtual function size_t get_max_size()
Returns the current maximum size of the cache.
function int unsigned get_num_copies(
    uvm_object  rhs
)
Returns the number of times the rhs has been copied to a unique lhs
protected virtual function uvm_objection get_objection()
Retrieves the Active Phase Objection.
virtual function int get_objection_count(
    uvm_object  obj  =  null
)
This is a pass through to uvm_objection::get_objection_count on the objection returned by get_objection.
virtual function int get_objection_total(
    uvm_object  obj  =  null
)
This is a pass through to uvm_objection::get_objection_total on the objection returned by get_objection.
pure virtual function uvm_phase_hopper get_phase_hopper()
Returns the uvm_phase_hopper (singleton) instance for this environment
static function bit get_print_config_matches()
static function bit get_print_config_matches()
virtual function bit get_rand_mode()
Returns the rand_mode of the field instance
static function bit is_tracing()
Returns 1 if the tracing facility is on and 0 if it is off.
static function bit is_tracing()
Returns 1 if the tracing facility is on and 0 if it is off.
pure virtual function optional_keys keys()
Returns a queue of all keys currently in the cache.
virtual function optional_keys keys()
Returns a queue of all keys currently in the cache.
function new(
    string  name  =  "unnamed-uvm_cache",
    size_t  max_size  =  256
)
Constructor, initializes the cache.
function new(
    string  name  =  "unnamed-uvm_lru_cache",
    size_t  max_size  =  256
)
Constructor, initializes the cache.
function new(
    string  name  =  "uvm_phase_hopper"
)
Creates a new uvm_phase_hopper instance with name.
function new(
    string  name  =  "unnamed-uvm_text_tr_database"
)
Constructor
function new(
    string  name  =  "unnamed-uvm_text_tr_stream"
)
Constructor
function void uvm_packer::pack_object_with_meta(
    uvm_object  value
)
Packs obj into the packer data stream, such that it can be unpacked via an associated unpack_object_with_meta call.
protected virtual task peek(
    output  uvm_phase  phase
)
Copies a phase from the hopper.
virtual function void print_accessors()
Delegates to the <uvm_resource_debug::print_access function to print the read/write access history of the resource, using the accessor argument accessor which is passed to the uvm_resource#(T)::read and uvm_resource#(T)::write
virtual function void print_accessors()
Print the read/write access history of the resource, using the accessor argument accessor which is passed to the uvm_resource#(T)::read and uvm_resource#(T)::write
static function void print_catcher(
    UVM_FILE  file  =  0
)
Prints debug information about all of the typewide report catchers that are registered.
function void print_config(
    bit  recurse  =  0,
    bit  audit  =  0
)
Print_config prints all configuration information for this component, as set by previous calls to uvm_config_db::set() and exports to the resources pool.
protected virtual task process_phase(
    uvm_phase  phase
)
Processes a phase.
pure virtual function void put(
    KEY_T  key,
    DATA_T  data
)
Puts data in cache at index key.
virtual function void put(
    KEY_T  key,
    DATA_T  data
)
Puts data in cache at index key.
protected virtual function void raise_objection(
    uvm_object  obj,   
    string  description  =  "",
    int  count  =  1
)
This is a pass through to uvm_objection::raise_objection on the objection returned by get_objection.
virtual function bit read_by_name(
    string  scope,
    string  name,
    inout  val,
    input  uvm_object  accessor
)
Provides an implementation of read_by_name, including support for resource tracing @uvm-accellera
pure virtual function bit read_by_name(
    string  scope,
    string  name,
    inout  val,
    input  uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::read_by_name @uvm-contrib
virtual function bit read_by_type(
    input  string  scope,
    inout  val,
    input  uvm_object  accessor
)
Provides an implementation of read_by_type, including support for resource tracing @uvm-accellera
pure virtual function bit read_by_type(
    string  scope,
    inout  val,
    input  uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::read_by_type @uvm-contrib
function void record_read_access(
    uvm_object  accessor  =  null
)
Delegates to the <uvm_resource_debug::record_read_access function to record read access information for this resource for debug purposes, information used by print_accessors function.
virtual function void record_read_access(
    uvm_object  accessor  =  null
)
Record the read access information for this resource for debug purposes.
function void record_write_access(
    uvm_object  accessor  =  null
)
Delegates to the <uvm_resource_debug::record_write_access function to record write access information for this resource for debug purposes, information used by print_accessors function.
virtual function void record_write_access(
    uvm_object  accessor  =  null
)
Record the write access information for this resource for debug purposes.
virtual task run_phases()
Runs all phases associated with a test.
virtual function void set(
    string  cntxt_name,
    string  inst_name,
    string  field_name,
    value,
    int  cntxt_depth,
    uvm_pool#(string, uvm_resource#(T))  pool,
    uvm_component  cntxt
)
Provides an implementation of set, including support for config_db tracing @uvm-accellera
pure virtual function void set(
    string  cntxt_name,
    string  inst_name,
    string  field_name,
    value,
    int  cntxt_depth,
    uvm_pool#(string, uvm_resource#(T))  pool,
    uvm_component  cntxt
)
Intended to provide the functionality for uvm_config_db#(T)::set @uvm-contrib
virtual function void set(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Provides an implementation of set, including support for resource tracing @uvm-accellera
pure virtual function void set(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::set @uvm-contrib
virtual function void set_anonymous(
    string  scope,
    val,
    uvm_object  accessor
)
Provides an implementation of set_anonymous, including support for resource tracing @uvm-accellera
pure virtual function void set_anonymous(
    string  scope,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::set_anonymous @uvm-contrib
virtual function rsrc_t set_default(
    string  scope,
    string  name
)
Provides an implementation of set_default.
pure virtual function rsrc_t set_default(
    string  scope,
    string  name
)
Intended to provide the functionality for uvm_resource_db#(T)::set_default @uvm-contrib
function void set_enable_print_topology (
    bit  enable
)
Sets the variable to enable printing the entire testbench topology just after completion of the end_of_elaboration phase.
function void set_file_name(
    string  filename
)
Sets the file name which will be used for output.
static function void set_imp(
    uvm_config_db_implementation_t  #(T)  imp  =  null
)
1) the imp argument if it is not null, else 2) the relevant factory override of uvm_config_db_implementation_t#(T) if such an override exists, else 3) a new creation of uvm_config_db_default_implementation_t#(T) @uvm-contrib
static function void set_imp(
    uvm_resource_db_implementation_t  #(T)  imp  =  null
)
1) the imp argument if it is not null, else 2) the relevant factory override of uvm_resource_db_implementation_t#(T) if such an override exists, else 3) a new creation of uvm_resource_db_default_implementation_t#(T) @uvm-contrib
virtual function void set_max_size(
    size_t  max_size  =  256
)
Sets the maximum size of the cache to max_size.
static function void set_override(
    input  string  scope,   
    input  string  name,   
    val,   
    uvm_object  accessor  =  null
)
Create a new resource, write val to it, and set it into the database.
virtual function void set_override(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Provides an implementation of set_override, including support for resource tracing @uvm-accellera
pure virtual function void set_override(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::set_override @uvm-contrib
static function void set_override_name(
    input  string  scope,   
    input  string  name,   
    val,   
    uvm_object  accessor  =  null
)
Create a new resource, write val to it, and set it into the database.
virtual function void set_override_name(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Provides an implementation of set_override_name, including support for resource tracing @uvm-accellera
pure virtual function void set_override_name(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::set_override_name @uvm-contrib
static function void set_override_type(
    input  string  scope,   
    input  string  name,   
    val,   
    uvm_object  accessor  =  null
)
Create a new resource, write val to it, and set it into the database.
virtual function void set_override_type(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Provides an implementation of set_override_type, including support for resource tracing @uvm-accellera
pure virtual function void set_override_type(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::set_override_type @uvm-contrib
static function void set_print_config_matches(
    bit  val
)
static function void set_print_config_matches(bit val)
virtual function void set_rand_mode(
    bit  rand_mode
)
Modifies the rand_mode for the field instance to the specified one
static function bit set_type_alias(
    string  alias_name
)
Sets a type alias for this wrapper in the default factory.
static function bit set_type_alias(
    string  alias_name
)
Sets a type alias for this wrapper in the default factory.
static function bit set_type_alias(
    string  alias_name
)
Sets a type alias for this wrapper in the default factory.
static function bit set_type_alias(
    string  alias_name
)
Sets a type alias for this wrapper in the default factory.
virtual function void show_msg(
    string  id,
    string  rtype,
    string  action,
    string  scope,
    string  name,
    uvm_object  accessor,
    rsrc_t  rsrc
)
Provides an implementation of show_msg.
pure virtual function void show_msg(
    string  id,
    string  rtype,
    string  action,
    string  scope,
    string  name,
    uvm_object  accessor,
    rsrc_t  rsrc
)
Intended to print a formatted string regarding an access of a particular config item @uvm-contrib
virtual function void show_msg(
    string  id,
    string  rtype,
    string  action,
    string  scope,
    string  name,
    uvm_object  accessor,
    rsrc_t  rsrc
)
Provides an implementation of show_msg.
pure virtual function void show_msg(
    string  id,
    string  rtype,
    string  action,
    string  scope,
    string  name,
    uvm_object  accessor,
    rsrc_t  rsrc
)
Intended to print a formatted string regarding an access of a particular resource @uvm-contrib
pure virtual function size_t size()
Returns the current number of elements in the cache.
virtual function size_t size()
Returns the current number of elements in the cache.
protected virtual task start_phase(
    uvm_phase  phase
)
Performs actions associated with transitioning phase state to the UVM_PHASE_STARTED state.
Performs actions associated with transitioning phase state to the UVM_PHASE_SYNCING state.
virtual function void traverse_on(
    uvm_phase  imp,
    uvm_component  comp,
    uvm_phase  node,
    uvm_phase_state  state
)
Calls traverse on imp, passing in comp, node, and state.
virtual function void trigger_modified(
    string  inst_name,
    string  field_name
)
@uvm-accellera
pure virtual function void trigger_modified(
    string  inst_name,
    string  field_name
)
Triggers the event associated with inst_name and field_name, potentially unblocking calls to wait_modified.
protected virtual function bit try_get(
    inout  uvm_phase  phase
)
Attempts to retrieve the next phase from the hopper.
protected virtual function bit try_peek(
    inout  uvm_phase  phase
)
Attempts to copy a phase from the hopper.
virtual function bit try_put(
    uvm_phase  phase
)
Attempts to add a new phase to the hopper.
static function void turn_off_tracing()
Turn tracing off for the configuration database.
static function void turn_off_tracing()
Turn tracing off for the resource database.
static function void turn_on_tracing()
Turn tracing on for the configuration database.
static function void turn_on_tracing()
Turn tracing on for the resource database.
function void uvm_packer::unpack_object_with_meta(
    inout  uvm_object  value
)
Unpacks an object which was packed into the packer data stream using pack_object_with_meta.
Implementation of uvm_init, as defined in section F.3.1.3 in 1800.2-2020.
task uvm_wait_for_nba_region
This task will block until SystemVerilog’s NBA region (or Re-NBA region if called from a program context).
virtual task wait_for_objection(
    uvm_objection_event  objt_event,   
    uvm_object  obj  =  null
)
This is a pass through to uvm_objection::wait_for on the objection returned by get_objection.
protected virtual task wait_for_waiters(
    uvm_phase  phase,
    uvm_phase_state  prev_state
)
Delays execution to allow waiters on phase state changes to react.
virtual task wait_modified(
    uvm_component  cntxt,
    string  inst_name,
    string  field_name
)
Provides an implementation of wait_modified @uvm-accellera
pure virtual task wait_modified(
    uvm_component  cntxt,
    string  inst_name,
    string  field_name
)
Intended to provide the functionality for uvm_config_db#(T)::wait_modified @uvm-contrib
function void write_attribute(
    string  nm,   
    uvm_bitstream_t  value,   
    uvm_radix_enum  radix,   
    int  numbits  =  $bits(uvm_bitstream_t)
)
Outputs a uvm_bitstream_t attribute to the textual log.
function void write_attribute_int(
    string  nm,   
    uvm_integral_t  value,   
    uvm_radix_enum  radix,   
    int  numbits  =  $bits(uvm_bitstream_t)
)
Outputs an uvm_integral_t attribute to the textual log
virtual function bit write_by_name(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Provides an implementation of write_by_name, including support for resource tracing @uvm-accellera
pure virtual function bit write_by_name(
    string  scope,
    string  name,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::write_by_name @uvm-contrib
virtual function bit write_by_type(
    string  scope,
    val,
    uvm_object  accessor
)
Provides an implementation of write_by_type, including support for resource tracing @uvm-accellera
pure virtual function bit write_by_type(
    string  scope,
    val,
    uvm_object  accessor
)
Intended to provide the functionality for uvm_resource_db#(T)::write_by_type @uvm-contrib