SystemVerilog Quick Reference Arrays and Queues

(10.5.3) Iterates over the elements of an array.

return [expression]; | break; | continue;
data_type [packed dimensions] name [unpacked dimensions];
(10.6) Jump statements.
Product Version: IUS 8.2 (5.2) Packed dimensions are declared before the array name.
Release Date: May 2008 Unpacked dimensions are declared after the array name. final function_statement
data_type name[]; (10.7) Executes when simulation ends, without delays.
This quick reference describes the SystemVerilog constructs
supported by Cadence Design Systems. (5.6) A dynamic array is one dimension of an unpacked array, begin [:block_id]{block_item_declaration}
whose size can be set or changed during simulation. {statement_or_null}
Note: Numbers in parentheses indicate the section of the IEEE 1800 end [:block_id]
data_type name [ index_type ];
Standard for SystemVerilog. Limitations for each construct are (10.8) Groups statements so that they execute in sequence.
described in the SystemVerilog Reference. (5.9) An associative array is declared using a data type as its
special array size. always @ (event iff expression)
Abbreviations data_type name [$[ :constant_expr ]]; (10.10) iff adds conditional qualification to an event control.
exprexpression argsarguments varvariable
(5.14) A queue is a dynamic array that can be dynamically Processes
numnumber decldeclaration ididentifier resized as data is ready or written.
always_comb procedural_statement;
Operators (11.2) Describes combinational logic.
Data Types
= += -= *= /= %= &= ^= |= always_latch procedural_statement;
logic [range] name [range] <<= >>= <<<= >>>= (11.3) Describes latched logic.
(4.3) A 1-bit, unsigned 4-state integer. (8.2) Assignment operators can be used on integral types and always_ff procedural_statement;
bit [range] name [range] within statements.
(11.4) Describes registered logic.
(4.3) A 1-bit, unsigned 4-state integer. ++ --
fork [:block_id]{block_item_declaration}
byte name [range] (8.2) Increment and decrement operators can be used on {statement_or_null} join | join_any | join_none [:block_id]
integral types.
(4.3) An 8-bit, signed 2-state integer or ASCII character. (11.6) fork...join completes when all spawned processes
==? !=? finish. fork...join_any completes when any of the
shortint name [range]
(8.5) Wild equality operator (==?) treats X or Z values in the processes finish. join_none completes a fork...join
(4.3) A 16-bit, signed 2-state integer. right-hand operand as dont care. Not equal counterpart is block immediately.
int name [range] (!=?). wait fork;
(4.3) 32-bit, signed 2-state integer. == equality != inequality [] indexing (11.8.1) Stops execution until all spawned processes finish.
{... ; ...} concatenation <, <=, >, >= boolean comparison
longint name [range] disable fork;
(4.7) Supported operators for strings.
(4.3) 64-bit, signed 2-state integer. (11.8.2) Disables all active threads of a calling process
<<, >>, <<<, and >>> shift operators % modulus operator
chandle name; / division * multiplication
(4.6) Stores pointers that are passed using DPI.
Tasks and Functions
(13.4) Supported operators for constraint expressions.
string name [= initial_value]; task [automatic | static] [interfaceOrclassId] task_id
Assignment Patterns [(ports)];
(4.7) Stores and manipulates ASCII strings. task_declarations
enum data_type {item1, item2...} var typeName'{key:value;{, key:value}} statements_or_null
or endtask[:task_id]
(4.9) User-defined enumerated type with a set of explicitly '{simple_type | default:value; {, key:value}}
named values. (12.1) Tasks can be used to hold blocks of statements or to
(8.13) Specifies the correspondence between a collection of execute a command sequence.
typedef data_type name; expressions and the elements of an array or the members of a function [automatic | static] [signed | unsigned]
(4.9) Declares a user-defined type. structure. [rangeOrtype] [interfaceOrclassid] function_id [(ports)];
struct [packed [signing]] { structure members } name; function_declarations
Procedural Statements and Control Flow statements_or_null
(4.11) Groups variables or constraints under a single name.
[unique | priority] if (condition) statement endfunction[:function_id]
union [packed [signing]] { union members } name; [else statement] (12.3) Groups statements together. Defines new logical or
(4.11) Similar to a structure, but members share the same (10.4) The unique keyword indicates that the order of the mathematical functions.
storage space. decision statements is not important and that they can be void' (some_function());
uwire variable_name; evaluated in parallel. The priority keyword indicates that
the order of the decision statements is important, and that (12.3.2) Discards a functions return values.
Behaves like a single-driver wire net.
tools must maintain the priority encoding. subroutine (ref type argument);
[virtual] class name [port_list][extends class_name];
class_item forever statement_or_null (12.4.2) Passes tasks and functions by reference.
endclass[:name] repeat (expression) statement_or_null subroutine (ref type argument);
while (expression) statement_or_null
(4.12) Object-oriented data type that encapsulates data (12.4.3) Specifies default argument values for tasks and
members and methods. (10.5) SystemVerilog enhances these Verilog loop statements functions.
by allowing null statements.
event variable_name [= initial_value];
do statement_or_null while (condition); Random Constraints
(4.3) Can be assigned, compared, and passed as arguments.
(10.5.1) Similar to Verilog while loop, except the condition is rand | randc <property>;
function void name[port_list]; checked after the loop executes.
function_body (13.3) Specifies that a property is either a random variable
endfunction for (for_initialization ; expr ; for_step) statement_or_null (randc) or a random-cyclic (randc) variable.
(12.3.1) Represents non-existent data. Casting to void (10.5.2) Enhances Verilog for by allowing loop variables and [static] constraint name {constraint_block}
discards a functions return value. by supporting multiple initializer and step assignments.
(13.4) Declares a constraint
foreach (name [ loop_vars ]) statement
 mailbox [#(<type>)] name [=new()];
Constraint Blocks Compiler Directives
(14.3) Class-based FIFO structure; allows procedures to
expr inside {set}; safely exchange data. `define
(13.4.3) Specifies a set of legal values for a given variable. ->> [delay_or_event_control] hierarchical_event_id; (23.2) Text substitution macro
expr dist {value_range := | :/ dist_weight, ...} (14.5.2) Non-blocking event trigger operator. `begin_keywords and `end_keywords
(13.4.4) Specifies a set of weighted values. hierarchical_event_id.triggered (23.4) Defines reserved keywords for a block of code.
expr -> constraint_set (14.5.4) Specifies that an event persist throughout the time `remove_keyword and `restore_keyword
(13.4.5) Constrains values when a condition is successful. step in which it was triggered. Removes particular keywords from any set of keywords.
if (expr) constraint_set [else constraint_set] Clocking Blocks Direct Programming Interface
(13.4.6) Constrains values when a condition is met.
[default] clocking name @(clocking_event); import {DPI | DPI-C} [context | pure] [c_id =]
foreach (array_id [loop_vars]) constraint_set default default_skew; | function function_data_type function_id ([tf_port_list]);
(13.4.7) Uses loop variables and indexing expressions to clocking_direction list_of_clocking_decl_assign;
specify iteration over elements in an array. endclocking[: name] (26.4.4) Imports C function using DPI.
solve identifier_list before identifier_list; (15.1) Defines a group of signals that are synchronized to a export {DPI | DPI-C} [c_id = ] function | task taskfunc_id;
specific clock. (26.6) Exports a SystemVerilog task or function using DPI.
(13.4.9) Defines the order in which random values should be
generated. Program Blocks String Methods
Randomization Methods and Functions program name [(port_list)]; Str.len() Str.hextoa(integer)
program items
randomize(<variable_or_property>) endprogram[: name] Str.getc(int) Str.octtoa(integer)
(13.5.1) Randomizes variables or class properties. (16.1) Similar to a module, but facilitates the creation of a Str.toupper() Str.bintoa(integer)
value = $urandom [( seed )] ; testbench and has special syntax and semantic restrictions. Str.tolower() Str.compare(Str2)
(13.12.1) Generates unsigned, 32-bit random numbers. Str.itoa(integer) Str.icompare(string)
Packages
value = $urandom_range (maxval, minval); Str.realtoa(real) Str.atoreal()
package name;
(13.12.2) Generates a random number within a specified [timeunits_decl] {{attribute_instance} package_item} Str.atoi() Str.substr(intA, intB)
range. endpackage [:name] Str.atobin() Str.atohex()
$srandom (seed); (19.2) Mechanism for sharing declarations among modules, Str.atooct() Str.putc(int, byte)
(13.12.3) Manually sets the RNG seed for subsequent calls. interfaces, and programs.
get_randstate(); package_id::item_name //Class scope resolution operator Enumeration Type Methods
(13.12.4) Gets current state of an objects RNG. import package_id :: *; // Wildcard import enum.first enum.prev
import package_id::item_name; // Explicit import
set_randstate(state); enum.last enum.num
(19.2.1) Ways to reference items within a package.
(13.12.5) Sets the state of an objects RNG. enum.next enum.name
randcase Interfaces
Array Locator Methods for Queues
expression : statement_or_null; interface name [(port_list)];
{expression : statement_or_null;} interface items queue_id.method (arguments) with (expression)
endcase endinterface [: name] (5.15) Syntax for using array locator methods on queues.
(13.15) Case statement that randomly selects one of its (20.2) Encapsulates the communication between blocks of a
branches, based on a branch weight. queueid.find queueid.find_index
digital system.
randsequence ([production_id]) queueid.find_first queueid.find_last
modport name (port_list);
production { production } queueid.find_first_index queueid.find_last_index
endsequence (20.4) Defines the direction of ports in an interface declaration.
(5.15.1) Supported array locator methods for queues.
(13.16) Defines a rules for generating a random sequence. interface_port_name.task_function_name(args);
(20.6) Declares tasks and functions in interfaces. Dynamic Array Methods
randsequence Production Statements
virtual [interface] name interface_id; new[expression][(expression)]]
if (expression) true_productionitem (20.8) Variable that represents an interface instance. arrayid.size arrayid.delete
[else false_productionitem]
(13.16.2) Specifies a conditional production System Tasks and Functions Associative Array Methods
case (expression) $root arrayid.num arrayid.last(index)
expression {,expression}: production_item1;
expression {,expression}: production_item2; (19.4) Lets you refer explicitly to a top-level instance. arrayid.delete[(index)] arrayid.next(index)
... $bits (expression); arrayid.exists(index) arrayid.prev(index)
default: default_production;
endcase (22.3) Returns the number of bits represented by an arrayid.first(index)
expression.
(13.6.3) Selects a production from a set of alternatives. Queue Methods
$left $right $low $high $increment $size
repeat (expression) production_item $dimensions $unpacked_dimensions queueid.insert(index, object) queueid.size
(13.6.4) Generates a production a set number of times. (5.5) Supported array querying functions. queueid.delete(index) queueid.pop_front
Interprocess Synchronization and Communication
semaphore name [=new(N)];
(14.2) Built-in class used for synchronization and the mutual
exclusion of resources. 20052007 Cadence Design Systems, Inc.
All rights reserved.
queueid.push_front(object) queueid.pop_back
queueid.push_back(object)

Semaphore Methods
new(keyCount) put(keyCount)
get(keyCount) try_get(keyCount)

Mailbox Methods
new(bound) mailbox_id.get(msg)
mailbox_id.num() mailbox_id.try_get(msg)
mailbox_id.put(msg) mailbox_id.peek(msg)
mailbox_id.try_put(msg) mailbox_id.try_peek(msg)

Note: This document does not cover Assertions or Coverage.

20052007 Cadence Design Systems, Inc.

All rights reserved.