Chapter 5, Basic OOP topics

Why OOP
OOP terminology
Classes
Objects
Custom constructors
Static variables/methods
Classes within classes
Handles
Copying objects

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.1 Introduction
Why OOP?
Gains in productivity/maintainability/thoroughness
Strongly couples data with code that manipulates it.
Allows the testbench to be reused
Facilitates testing at the transaction level
SystemVerilog allows inheritance and polymorphism

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.2 Think of Nouns, not Verbs

Scenario
Functional

Command

Signal

Environment

Generator

Agent

Scoreboard

Checker

Driver

Assertions

Monitor

DUT

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.5 OOP Terminology

Blueprint for a house

A complete house

House Address

123 Elm Street

Object

Class

Turn on/off switches

Methods

Handle
Light switches

Properties
Dr. Meeta Yadiv, ASIC Verification, North Carolina State University Fall 2007

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.5 OOP Terminology (cont)

Blueprint for
a house

A complete
house
Address of a
house
Light
switches
Turn on/off
switches

Class
Programming element containing related groups of features
and functionality
Provides a template for building objects
Can be used as a data structure

Object
An object is an instance of a class

Handle
Type-safe pointer to an object can not be corrupted

Properties
Variables contained in the instance of the class

Methods
Tasks/functions (algorithms) that operate on the properties in
this instance of the class
Dr. Meeta Yadiv, ASIC Verification, North Carolina State University Fall 2007

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.5 OOP Terminology (cont)

HDL

OOP

Verilog

SystemVerilog

Block definition

module

class

Block instance

instance

object

Block name

instance name

handle

Data Types

registers & wires

Executable Code
Communication
between blocks

Properties:
Variables
behavioral blocks
Methods: tasks
(always, initial), and functions
tasks, functions
Ports or crosstask/function
module task calls
calls,
mailboxes,
semaphores,
etc.

Dr. Meeta Yadiv, ASIC Verification, North Carolina State University Fall 2007

5.3 Your First Class

class Transaction;
bit [31:0] addr, crc, data[8];
function void display;
$display(Transaction: %h, addr);
endfunction : display
fuction void calc_crc;
crc = addr ^ data.xor;
endfunction : calc_crc

properties or variables
method

method

endclass: Transaction

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.4 Where to define (and use) a Class

A class can be defined in:
1. program
2. module
3. package
A class can be used in:
1. module
2. program
3. package
4. Can be constructed and extended
Locations for defining classes:
Each class in a separate file
Related classes in a package
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

5.6 Creating new objects

Call new() to allocate space for the object
Transaction tr;
tr = new();

handle

class
creates an object of class Transaction
tr now points to the object

OR
Transaction tr = new();

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

Class in a package
package abc;
class Transaction;
// Class body
endclass
endpackage
program automatic test;
import abc::*;
Transaction tr;
// Test code
endprogram

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

10

Class Exercise
Create a class called MemTrans that contains the following
members:
An 8-bit data_in of logic type
A 4-bit address of logic type
A void function that prints out the value of data_in and
address

Construct a MemTrans object in an initial block

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

11

5.6.2 Custom Constructor

For every class SystemVerilog creates a default new()
Memory space is allocated
All variables initialized to their default value
Use a custom constructor to override this behavior
class Transaction;
logic [31:0] addr, crc, data[8];
function new();
addr = 3;
data = '{default:5};
endfunction
endclass

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

12

Custom Constructor Exercise

Using your MemTrans class create a custom constructor so that
data_in and address are both initialized to 0.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

13

5.6.2 Custom Constructor with arguments

Make the custom constructor more flexible by passing in values
Defaults are used if argument(s) are not passed
class Transaction;
logic [31:0] addr, crc, data[8];
function new(logic [31:0] a=3, d=5);
addr = a;
data = '{default:d};
endfunction
endclass

tr1
tr2
tr3
tr4

=
=
=
=

new(10);
new(, 6);
new(10, 6);
new(.a(10), .d(6));
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

14

Custom Constructor with args Exercise

Using your MemTrans class create a custom constructor so that
data_in and address are both initialized to 0 but can also be
initialized through arguments passed into the constructor
1. Create 2 new MemTrans objects
2. Initialize address to 2 in the 1st object, passing arguments by
name
3. Initialize data_in to 3 and address to 4 in the 2nd object,
passing arguments by name.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

15

5.7 Object Deallocation

Garbage collection, i.e. reclaiming unused memory, is automatic
An object is deallocated if no handles point to it.
Transaction t1, t2;
t1 = new();
t2 = t1;

t1 = new();

t1 = null, t2=null
t2=null, t1
t2
t2

Object A

t1
Object A

t2
t1 = null;

Object A
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

Object B

t1 = null
Object B
16

5.8 Using Objects

Similar to Verilog use the . notation to access variables and
routines of a class
class Transaction;
bit [31:0] addr, crc, data[8];
function void display;
$display(Transaction: %h, addr);
endfunction
fuction void calc_crc;
crc = addr ^ data.xor;
endfunction
endclass
Transaction t;
t = new();
Usage:
t.addr = 32h42;
t.display();
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

17

Using Objects Exercise

Using the previous MemTrans exercise assign the address of the
first object to 4hF after construction
Use the print function to print out the values of data_in and
address for the 2 objects.
Explicitly deallocate the 2nd object.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

18

5.10 Defining Methods Outside of the Class

Done to keep the class definition readable
Define a prototype of the method in the class
Use the extern keyword to indicate the full definition is external
class PCI_Tran;
bit [31:0] addr, data;
extern function void display();
endclass

Specify the class that the function is defined for

function void PCI_Tran::display();
$display(%0t: PCI: addr = %h, data = %h,
$time, addr, data);
endfunction

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

19

5.11 Static Variables vs. Global Variables

Global variable has no limits on manipulation
Static variable:
Can only be modified by objects of one class
Shared among all objects
Associated with the class, not the object
class Transaction;
static int count = 0;
int id;
function new();
id = count++;
endfunction
endclass

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

20

5.11 Static/Global Variables (cont)

initial begin
Transaction t1, t2;
t1 = new();
$display("First id = %0d, count = %0d", t1.id, t1.count);
t2 = new();
$display("Second id = %0d, count = %0d", t2.id, t2.count);
end
# First id = 0, count = 1
# Second id = 1, count = 2

If count was not declared as static:

# First id = 0, count = 1
# Second id = 0, count = 1
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

21

5.11.2 Accessing Static Variables.....

Only one copy of a static variable exists.
Static variables can be accessed through the class or handle
initial begin
Transaction t1, t2;
$display("1) Transaction::count = %0d", Transaction::count);
t1 = new();
$display("First id = 0d%0d, count = 0d%0d", t1.id, t1.count);
t2 = new();
$display("Second id = 0d%0d, count = 0d%0d", t2.id, t2.count);
$display("2) Transaction::count = 0d%0d", Transaction::count);
end
#
#
#
#

1) Transaction::count = 0d0
First id = 0d0, count = 0d1
Second id = 0d1, count = 0d2
2) Transaction::count = 0d2
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

22

Static Variables Exercise

Using the previous MemTrans exercise create a static variable
last_address that holds the initial value of the address variable
from the most recently created object, as set in the constructor.
After allocating objects of class MemTrans (done in last exercise)
print out the current value of last_address.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

23

5.11.3 Initializing static variables

Useful when every instance of a class needs info from an object
of another class
class Transaction;
static Config cfg;
endclass

A handle with static storage

initial begin
Transaction::cfg = new(.num_trans(42));
end

Create a new config object.

and assign handle of new Config object
to static handle cfg in class Transaction

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

24

5.11.4 Static Methods

Manipulating static variables with a method accessed with the class
name requires a static method
class Transaction;
static int count = 0;
int id;
function new();
id = count++;
endfunction
static function void dec_count();
--count;
endfunction
dec_count must be declared as static
endclass
Transaction::dec_count();
$display("3) Transaction.count = %0d", Transaction::count);
# 3) Transaction.count = 1
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

25

5.11.3-4 Complete Code

program automatic top;
class Config;
int num_trans;
function new(int num_trans);
this.num_trans = num_trans;
endfunction
endclass

class Transaction;
static Config cfg;
static int count = 0;
int id;

Config cfg;
initial begin
cfg = new(.num_trans(42));
Transaction::cfg = cfg;
Transaction::display_statics(); // Static method call
end
endprogram : top

// Static method to display static variables.

static function void display_statics();
$display("Transaction cfg.num_trans=%0d,
count=%0d",
cfg.num_trans, count);
endfunction
endclass
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

26

Static Methods Exercise

Using the previous MemTrans exercise create a static method
called print_last_address that prints out the value of static
variable last_address
After allocating objects of class MemTrans, call the method
print_last_address to print out the value of
last_address

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

27

5.12 Scoping Rules

int limit;
program automatic p;
int limit;
class Foo;
int limit, array[];
function void print (int limit);
for (int i=0; i<limit; i++)
$display(%m: array[%0d]=%0d, i, array[i]);
endfunction
endclass
initial begin
int limit = $root.limit;
Foo bar;
bar = new();
bar.print(limit)
bar.print(bar.limit);
end endprogram
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

28

5.12 Scoping Rules (cont)

SystemVerilog searches up the scopes for variables
program automatic test;
int i;
class Bad;
logic [31:0] data[];
function void display;
for (i=0;i<data.size(); i++)
$display(data[%0d=%x, i, data[i]);
endfunction
endclass
endprogram

Declare classes in a package.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

29

5.12.1 What is this?

Keyword this allows unambiguous reference to class
variables/methods, etc.
Commonly used in custom constructors where argument to
constructor matches a class variable.
Lazy programming???
class Scoping;
string oname;
function new(string oname);
this.oname = oname;
endfunction
endclass

class Scoping;
string oname;
function new(string new_oname);
oname = new_oname;
endfunction
endclass

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

30

5.13 Using one Class Inside Another

Objects of a class can be created inside another class
Enables reuse and is similar to composition
class Statistics;
time startT; // Transaction start time
static int ntrans = 0; // Transaction count
static time total_elapsed_time = 0;
function void start();
startT = $time;
endfunction
function void stop();
time how_long = $time - startT;
ntrans++; // Another trans completed
total_elapsed_time += how_long;
endfunction
endclass
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

31

Using Statistics inside another Class

class BusTran;
bit [31:0] addr, src, data[8], crc;
Statistics stats;
function new();
stats=new();
endfunction
task create_packet();
// Fill packet with data
stats.start();
......
// Transmit packet
stats.stop();
endtask
endclass
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

32

5.13.2 Compilation Order Issue

Compilation order of classes is not as lenient as modules
Example: two classes each need a handle to the other.
class Transaction;
Statistics stats;
endclass

Invalid type 'Statistics'.

class Statistics;
endclass
typedef class Statistics;
class Transaction;
Statistics stats;
endclass
class Statistics;
endclass
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

33

Classes within Classes Exercise

Complete function print_all in class MemTrans to print out data_in
and address using base class PrintUtilities. Demonstrate its usage.
class PrintUtilities;
function void print_4(input string name, input [3:0] val_4bits);
$display("%t: %s = %h", $time, name, val_4bits);
endfunction
function void print_8(input string name, input [7:0] val_8bits);
$display("%t: %s = %h", $time, name, val_8bits);
endfunction
class MemTrans;
endclass
bit [7:0] data_in;
bit [3:0] address;
PrintUtilities print;
function new(); print = new(); endfunction
function void print_all;
......
endfunction
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2
34
endclass

5.14.1 Passing objects/handles to methods

What happens when an object is passed to a method?
The handle to the object is passed, not the object.
A copy of the handle is made
task generator;
Transaction gen;
gen =new;
transmit(gen);
endtask

gen

task transmit(input Transaction trans);

...........
endtask

object of class
Transaction
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

trans

35

5.14.2 Modifying a handle in a task

Specify ref on method arguments you want to modify
function void create(ref Transaction tr);
function void create(Transaction tr);
tr = new();
tr cannot be modified
tr.addr = 42;
.....
endfunction
Transaction t;
initial begin
create(t);
$display(t.addr);
end

What does t point to?

# 42

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

36

5.14.3 Modifying Objects in Flight

Be sure to create a new object for each transaction
Otherwise every object could be the same
task generator_bad(int n);
Transaction t;
t = new();
1 object shared by n transmit calls
repeat (n) begin
t.addr = $random();
$display(Sending addr = %h, t.addr);
transmit(t);
end
endtask

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

37

5.14.4 Array of Handles

Your testbench might need to store and reference many objects
An array of handles is convenient for this.
task generator();
Transaction tarray[10];
foreach (tarray[i]) begin
tarray[i] = new();
transmit(tarray[i]);
end
endtask

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

38

Objects and Handles Exercise

program automatic test;
import my_package::*;
initial begin
end
task generator

endtask

Declare an array of 5 Transaction handles

Call a generator task to create the objects
Complete the generator task header
Create objects for every handle in
the array and transmit the object.

task transmit(Transaction tr);

.......
endtask // transmit
endprogram
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

39

5.15 Copying Objects

Pass a copy of an object to a method to keep it from being modified
Any custom constructor is not called
class Transaction;
bit [31:0] addr;
static int count = 0;
int id;
Statistics stats;
function new();
stats = new()
id = count++;
endfunction
endclass

Transaction src, dst;

initial begin
src = new();
src.stats.StartT=42;

src

id=0
stats

startT=42

dst = new src;

src

id=0
stats

dst

id=0
stats

startT=42 96

dst.stats.StartT = 96;
Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

40

5.15.3 Writing a Deep Copy Function

Suggested for all but the most trivial classes
class Transaction;
bit [31:0] addr;
static int count = 0;
int id;
Statistics stats;
function new();
stats = new();
id = count++;
endfunction
function Transaction copy();
copy = new();
copy.addr = addr;
copy.stats = stats.copy();
endfunction
endclass

class Statistics;
time startT;
function Statistics copy();
copy = new();
copy.startT = startT;
endfunction
endclass

UVM data macros do this

for you automatically!

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

41

5.15.3 Using the Deep Copy Function

Transaction src, dst;
initial begin
src = new();
src.stats.StartT=42; src

id=0
stats

src

id=0
stats

startT=42

dst

id=1
stats

startT=42

dst = src.copy();

src

id=0
stats

startT=42

dst

id=1
stats

startT=96

dst.stats.StartT = 96;
end

startT=42

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

42

Copy Exercise
For the following class create a copy function and demonstrate its
usage. Assume the Statistics class has its own copy function.
package automatic my_package;
class MemTrans;
bit [7:0] data_in;
bit [3:0] address;
Statistics stats;
function new();
data_in = 3;
address = 5;
stats = new();
endfunction
endclass;
endpackage

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

43

5.17 Public vs Local

C++/Java
All variables in a class are local by default
Classes provide accessor functions to allow access.
Long term software stability is paramount.
SystemVerilog
All variables in a class are public by default
Variables can be labeled local or protected.
Tradeoff between software stability and flexibility.

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

44

5.18 Building a Testbench

Environment

Chapter 5 Copyright 2012 G. Tumbush, C. Spear v1.2

45