Universal Verification Methodology
(UVM) 1.2 Class Reference
June 2014
Copyright
©
2011 - 2014 Accellera Systems Initiative (Accellera). All rights reserved.
Accellera Systems Initiative Inc., 1370 Trancas Street #163, Napa, CA 94558, USA.
Notices
Accellera Systems Initiative (Accellera) Standards documents are developed within Accellera and the Technical
Committees of Accellera. Accellera develops its standards through a consensus development process, approved by its
members and board of directors, which brings together volunteers representing varied viewpoints and interests to
achieve the final product. Volunteers are not necessarily members of Accellera and serve without compensation.
While Accellera administers the process and establishes rules to promote fairness in the consensus development pro-
cess, Accellera does not independently evaluate, test, or verify the accuracy of any of the information contained in its
standards.
Use of an Accellera Standard is wholly voluntary. Accellera disclaims liability for any personal injury, property or
other damage, of any nature whatsoever, whether special, indirect, consequential, or compensatory, directly or indi-
rectly resulting from the publication, use of, or reliance upon this, or any other Accellera Standard document.
Accellera does not warrant or represent the accuracy or content of the material contained herein, and expressly dis-
claims any express or implied warranty, including any implied warranty of merchantability or suitability for a specific
purpose, or that the use of the material contained herein is free from patent infringement. Accellera Standards docu-
ments are supplied “AS IS.”
The existence of an Accellera Standard does not imply that there are no other ways to produce, test, measure, pur-
chase, market, or provide other goods and services related to the scope of an Accellera Standard. Furthermore, the
viewpoint expressed at the time a standard is approved and issued is subject to change due to developments in the
state of the art and comments received from users of the standard. Every Accellera Standard is subjected to review
periodically for revision and update. Users are cautioned to check to determine that they have the latest edition of any
Accellera Standard.
In publishing and making this document available, Accellera is not suggesting or rendering professional or other ser-
vices for, or on behalf of, any person or entity. Nor is Accellera undertaking to perform any duty owed by any other
person or entity to another. Any person utilizing this, and any other Accellera Standards document, should rely upon
the advice of a competent professional in determining the exercise of reasonable care in any given circumstances.
Interpretations: Occasionally questions may arise regarding the meaning of portions of standards as they relate to spe-
cific applications. When the need for interpretations is brought to the attention of Accellera, Accellera will initiate
action to prepare appropriate responses. Since Accellera Standards represent a consensus of concerned interests, it is
important to ensure that any interpretation has also received the concurrence of a balance of interests. For this reason,
Accellera and the members of its Technical Committees are not able to provide an instant response to interpretation
requests except in those cases where the matter has previously received formal consideration.
Comments for revision of Accellera Standards are welcome from any interested party, regardless of membership
affiliation with Accellera. Suggestions for changes in documents should be in the form of a proposed change of text,
together with appropriate supporting comments. Comments on standards and requests for interpretations should be
addressed
to:
Accellera Systems Initiative Inc.
1370 Trancas Street #163
Napa, CA 94558
USA
Note: Attention is called to the possibility that implementation of this standard may require use of subject mat-
ter covered by patent rights. By publication of this standard, no position is taken with respect to the existence
or validity of any patent rights in connection therewith. Accellera shall not be responsible for identifying pat-
UVM 1.2 Class Reference
Front-2
ents for which a license may be required by an Accellera standard or for conducting inquiries into the legal
validity or scope of those patents that are brought to its attention.
Accellera is the sole entity that may authorize the use of Accellera-owned certification marks and/or trademarks to
indicate compliance with the materials set forth herein.
Authorization to photocopy portions of any individual standard for internal or personal use must be granted by Accel-
lera, provided that permission is obtained from and any required fee is paid to Accellera. To arrange for authorization
please contact Lynn Bannister, Accellera, 1370 Trancas Street #163, Napa, CA 94558, phone (707) 251-9977, e-mail
lynn@accellera.org. Permission to photocopy portions of any individual standard for educational classroom use can
also be obtained from Accellera.
Suggestions for improvements to the UVM 1.2 Class Reference are welcome. They should be sent to the UVM email
reflector
uvm-wg@lists.accellera.org
UVM 1.2 Class Reference
Front-3
Contents
1. Overview.............................................................................................................................................................1
1.1 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2. Normative References.........................................................................................................................................2
3. Definitions, Acronyms, and Abbreviations.........................................................................................................2
3.1 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3.2 Acronyms and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
4. Classes and Utilities............................................................................................................................................5
5. Core Base Classes ...............................................................................................................................................8
5.1 Miscellaneous Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2 uvm_object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.3 uvm_transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5.4 uvm_root. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
5.5 Port Base Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6. Reporting Classes..............................................................................................................................................46
6.1 uvm_report_message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.2 uvm_report_object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
6.3 uvm_report_handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
6.4 uvm_report_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
6.5 uvm_report_catcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7. Recording Classes .............................................................................................................................................89
7.1 uvm_tr_database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
7.2 uvm_tr_stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
8. Factory Classes ...............................................................................................................................................103
8.1 uvm_*_registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
8.2 uvm_factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
9. Phasing Classes ...............................................................................................................................................125
9.1 uvm_phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
9.2 uvm_domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
UVM 1.2 Class Reference
Front-4
9.3 uvm_bottomup_phase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
9.4 uvm_task_phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
9.5 uvm_topdown_phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
9.6 UVM Common Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
9.7 UVM Run-Time Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
9.8 User-Defined Phases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
10. Configuration and Resource Classes...............................................................................................................173
10.1 uvm_resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
10.2 uvm_resource_db . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
10.3 uvm_config_db. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
11. Synchronization Classes .................................................................................................................................202
11.1 uvm_event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
11.2 uvm_event_callback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
11.3 uvm_barrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
11.4 uvm_objection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
11.5 uvm_heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
11.6 uvm_callback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
12. Container Classes............................................................................................................................................232
12.1 uvm_pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
12.2 uvm_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
13. TLM Interfaces ...............................................................................................................................................241
14. TLM1 ..............................................................................................................................................................242
14.1 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
14.2 Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
14.3 Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
14.4 Imps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
14.5 FIFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
14.6 FIFO Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
14.7 Channel Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
14.8 Sequence Item Pull Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
14.9 Sequencer Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
UVM 1.2 Class Reference
Front-5
