100% found this document useful (2 votes)

7K views172 pages

Linking Novas Files With Simulators and Enabling FSDB Dumping

verdi

Uploaded by

Marko Nedic

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

100% found this document useful (2 votes)

7K views172 pages

Linking Novas Files With Simulators and Enabling FSDB Dumping

verdi

Uploaded by

Marko Nedic

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 172

Linking Novas Files with

Simulators and Enabling

FSDB Dumping
Version M-2017.03, March 2017
Copyright Notice and Proprietary Information
© 2017 Synopsys, Inc. All rights reserved. This software and documentation contain confidential and proprietary
information that is the property of Synopsys, Inc. The software and documentation are furnished under a license
agreement and may be used or copied only in accordance with the terms of the license agreement. No part of the
software and documentation may be reproduced, transmitted, or translated, in any form or by any means, electronic,
mechanical, manual, optical, or otherwise, without prior written permission of Synopsys, Inc., or as expressly provided
by the license agreement.
Third-Party Software Notices
Verdi® Automated Debug Platform includes or is bundled with software licensed to Synopsys under free or open-
source licenses. For additional information, see the third_party_notices.txt file in the INSTALL_PATH/doc directory of
the Verdi software installation.
Destination Control Statement
All technical data contained in this publication is subject to the export control laws of the United States of America.
Disclosure to nationals of other countries contrary to United States law is prohibited. It is the reader's responsibility to
determine the applicable regulations and to comply with them.
Disclaimer
SYNOPSYS, INC., AND ITS LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH
REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Trademarks
Synopsys and certain Synopsys product names are trademarks of Synopsys, as set forth at
http://www.synopsys.com/Company/Pages/Trademarks.aspx.
All other product or company names may be trademarks of their respective owners.
Third-Party Links
Any links to third-party websites included in this document are for your convenience only. Synopsys does not endorse
and is not responsible for such websites and their practices, including privacy practices, availability, and content.

Synopsys, Inc.
690 E. Middlefield Road
Mountain View, CA 94043
www.synopsys.com
Contents

Contents
About This Book 1
Purpose ...............................................................................................................1
Audience .............................................................................................................1
Book Organization..............................................................................................2
Conventions Used in This Book .........................................................................3
Related Publications ...........................................................................................4

Overview 5
FSDB Format......................................................................................................5
FSDB Related Environment Variables...............................................................6
Novas Object File Cross Reference Matrix ........................................................7

FSDB Dumping Commands 9

FSDB Command Line, Environment Variable, and Dump Command Options.9
FSDB Dumping Commands Used with Verilog ..............................................27
FSDB Dumping Commands Used in VHDL....................................................77

Linking with Synopsys Simulators 107

VCS.................................................................................................................107
VCS/VCS MX (VCS/VCS MX 2014.03 and Later Versions) - SystemC and HDL
(Verilog/ SystemVerilog, VHDL) Mixed.......................................................109
VCS and Virtualizer .......................................................................................112

Linking with Cadence Simulators 113

IUS (13.1 or Later Versions) - Verilog Only..................................................113
IUS (IUS13.1 and Later Versions) - Verilog, VHDL or Mixed.....................120
IUS (IUS13.1 and Later Versions) - SystemC and HDL (Verilog/SystemVerilog,
VHDL) Mixed ................................................................................................128
SystemC Dumper for Cadence SCV Transaction...........................................130

Linking with ModelSim Simulators 133

ModelSim (10.2 or Later Versions) - Verilog Only .......................................133
ModelSim (SE 10.2 or Later Versions) - VHDL or Mixed Only...................136
ModelSim (SE 10.2 and Later Versions) - SystemC and HDL (Verilog/

Linking Novas Files with Simulators and Enabling FSDB Dumping i

Contents

SystemVerilog, VHDL) Mixed ......................................................................140

SystemC Dumper to Open SystemC Initiative Simulator 143

Simulators, Platforms, and Compilers Supported by Verdi ...........................143

Appendix A: Third Party Integration 151

Linking with Synopsys VCS Simulators (VCS 2014.03 or Later Versions)..151
Linking with Cadence Simulators (IUS 13.1 or Later Versions) ...................151
Linking with ModelSim Simulators (10.2 or Later Versions)........................154

Appendix B: Required VCS MX Options for Linking with FSDB

Dumper 155
Appendix C: Dumping to Multiple Files with FSDB Commands159
Overview.........................................................................................................159
Default FSDB Files and Target FSDB Files...................................................160

Appendix D: Switch Dumping with Simulator Restore 163

Synopsys VCS Simulators..............................................................................163
ModelSim Simulators .....................................................................................164
Cadence IUS Simulators.................................................................................165
Miscellaneous Rules .......................................................................................166

ii Linking Novas Files with Simulators and Enabling FSDB Dumping

About This Book

Purpose
This book explains how to link the Novas object files for FSDB dumping with
various standard simulators. The manual should be read from beginning to end,
although you may skip any sections with which you are already familiar.
For detailed descriptions of commands for the Verdi platform, please refer to the
appropriate chapter of the Verdi and Siloti Command Reference Manual.

Audience
The audience for this manual includes engineers who are familiar with languages
and tools used in design and verification such as Verilog, VHDL, SystemVerilog,
and typically install, set-up and run simulators.
This document assumes that you have a basic knowledge of the platform on
which your version of the Verdi platform runs: Unix or Linux, and that you are
knowledgeable in design and verification languages, simulation software, and
digital logic design.

Linking Novas Files with Simulators and Enabling FSDB Dumping 1

About This Book

Book Organization
This Linking Novas Files with Simulators and Enabling FSDB Dumping is
organized as follows:
• About This Book provides an introduction to this book and explains how to
use it.
• Overview summarizes the basic information needed to generate FSDB files.
• FSDB Dumping Commands summarizes the common usage of FSDB
dumping commands.
• Linking with Cadence Simulators summarizes the steps for linking the
Novas object files with the Cadence IUS simulator for Verilog, VHDL and
mixed designs.
• Linking with ModelSim Simulators summarizes the steps for linking the
Novas object files with the ModelSim simulator.
• Linking with Synopsys Simulators summarizes the steps for linking the
Novas object files with the Synopsys simulator.
• Appendix A: Third Party Integration provides examples for linking the
object files for FSDB dumping with 3rd-party libraries.
• Appendix B: Required VCS MX Options for Linking with FSDB Dumper
summarizes additional options to use with VCS MX when linking the object
files for FSDB dumping.
• Appendix C: Dumping to Multiple Files with FSDB Commands provides
details on using the FSDB dumping commands to dump to multiple FSDB
files.
• Appendix D: Switch Dumping with Simulator Restore provides details on
switching dumping between FSDB files while also using simulator restore
commands.

2 Linking Novas Files with Simulators and Enabling FSDB Dumping

About This Book

Conventions Used in This Book

The following conventions are used in this book:
• Italics font is used for emphasizes, book titles, section names, design names,
file path, and file names within paragraphs.
• Bold is used to emphasize text, highlight titles, menu items, and other Verdi
terms.
• Courier type is used for program listings. It is also used for test
messages that the Verdi platform displays on the screen.
• NOTE describes important information, warnings, or unique commands.
• Menu->Command identifies the path used to select a menu command.
• Left-click or Click means click the left mouse button on the indicated item.
• Middle-click means click the middle mouse button on the indicated item.
• Right-click means click the right mouse button on the indicated item.
• Double-click means click twice consecutively with the left mouse button.
• Shift-left-click means press and hold the <Shift> key then click the left
mouse button on the indicated item.
• Drag-left means press and hold the left mouse button, then move the pointer
to the destination and release the button.
• Drag means press and hold the middle mouse button on the indicated item
then move and drop the item to the other window.

Linking Novas Files with Simulators and Enabling FSDB Dumping 3

About This Book

Related Publications
• Installation and System Administration Guide - explains how to install the
Verdi and Siloti systems.
• Verdi and Siloti Quick Reference Guide - provides a quick reference for
using the Verdi and Siloti systems with typical debug scenarios.
• Verdi and Siloti Command Reference Manual - gives detailed information
on the Verdi and Siloti command set.
• Verdi User Guide and Tutorial - provides detailed information on
using the Verdi platform.
• nAnalyzer User Guide and Tutorial - provides detailed information on using
the nAnalyzer Design Analysis module.
• nECO User Guide and Tutorial - provides detailed information on using the
nECO Automated Netlist Modification module.
• Siloti User Guide and Tutorial - provides detailed information on using the
Siloti system.
• Release Notes - for current information about the latest software version.
Refer to the 'View release notes' link on the product downloads page.
• Language Documentation
Hardware description (Verilog, VHDL, SystemVerilog, etc.) and
verification language reference materials are not included in this manual.
For language related documents, please refer to the appropriate language
standards board (www.ieee.org, www.accellera.org) or vendor
(www.synopsys.com, www.cadence.com) websites.

4 Linking Novas Files with Simulators and Enabling FSDB Dumping

Overview

FSDB Format
The Verdi platform supports an open file format called Fast Signal Database
(FSDB) that has the following advantages over the standard VCD file format:
• An FSDB file is more compact than a standard VCD file. Typically, an
FSDB file is about 5 to 50 times smaller than a VCD file.
• Using FSDB files, the Verdi platform displays waveform and back-
annotated signal values faster.
Synopsys provides a set of object and support files in the Verdi package that can
be linked with popular simulators to extend the simulator command set to
support dumping FSDB files directly during simulation instead of VCD files. For
existing VCD files, the conversion utility vfast is provided in the Verdi package
and is used to convert VCD files into FSDB files. In addition, VCD files are
converted to FSDB files automatically when a VCD file is opened using the
nTrace File -> Load Simulation Results command or the nWave File -> Open
command. Another conversion utility, fsdb2vcd, is provided in the Verdi package
and converts FSDB files back to VCD format.
If FSDB dumper support for a simulator version is over 18 month and there are
already more than 3 major simulator version for that vendor, we put this FSDB
dumper into legacy dumper.
For older simulator versions, please contact Synopsys support:
https://solvnet.synopsys.com

Linking Novas Files with Simulators and Enabling FSDB Dumping 5

Overview

FSDB Related Environment Variables

Refer to Appendix A in the Verdi and Siloti Command Reference Manual for
details on FSDB dumping related environment variables.

NOTE: A novas_dump.log file gets created during simulation to record some

essential simulation/dumping information, such as the simulation
options used, the environment variable settings, and the Novas object
directories that were linked. This log file is needed to report a dumper
related issue effectively.

6 Linking Novas Files with Simulators and Enabling FSDB Dumping

Overview

Novas Object File Cross Reference Matrix

The following table summarizes which Novas object file directory should be
used for which language and simulator version to enable FSDB dumping or
interactive mode on specific platforms.
For Solaris, Linux and IBM platforms:

Supported Items
Product Name
Supported 1. Simulator
Vendor (Interface
Language 2. Version
Type)
3. FSDB Dumping Platform

Verilog/
1. Synopsys VCS (VCSMX)
SystemVerilog/
VCS 2. VCS MX 2014.03 or later
Synopsys SVA/
(DKI/UCLI) 3. SOL2/SOL7/LINUX/
Verilog(SV)+/
LINUX64/SUSE32/SUSE64
VHDL Mixed

Verilog/ 1. Cadence NC-Sim

SystemVerilog/ 2. IUS 13.1 or later
IUS
Cadence SVA/VHDL/ 3. SOL2/SOL7/LINUX/
(PLI/FMI/CFC)
Verilog(SV)+/ LINUX64/IBM32/ IBM64/
VHDL Mixed SUSE32/SUSE64

Verilog/
1. ModelTech ModelSim
SystemVerilog/
MODELSIM 2. ModelSim SE 10.2 or later
Modeltech SVA/VHDL/
(FLI/PLI) 3. SOL2/SOL7/LINUX/
Verilog(SV)+/
LINUX64/SUSE32/SUSE64
VHDL Mixed

Subdirectory and Platform Mapping

The following table summarizes which object file sub-directory should be used
for which platforms.

Subdirectory
Platform
${PLATFORM}

SOL2 & SOLARIS2 SunOS 5.x (32 bit)

SOL7 SunOS 5.x (64 bit)

LINUX Linux OS (32 bit)

LINUX64 Linux OS (64 bit)

Linking Novas Files with Simulators and Enabling FSDB Dumping 7

Overview

Subdirectory
Platform
${PLATFORM}

IBM32 IBM-AIX 5.3 (32 bit)

IBM64 IBM-AIX 5.3 (64 bit)

SUSE32 SUSE OS (32 bit)

SUSE64 SUSE OS (64 bit)

8 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

FSDB Command Line, Environment

Variable, and Dump Command Options
The unified FSDB dumper supports three methods for specifying options. The
methods are:
1. Specify an option on the simulator command line. Refer to the FSDB
Dumping Command Line Options section for details on the command line
options.
2. Specify an option using an environment variable. Refer to Appendix A in the
Verdi and Siloti Command Reference Manual for details on the environment
variables.
3. Specify an option in an FSDB dumping command. Refer to the FSDB
Dumping Command Option table for details on using options with the dump
commands.
If the same option is set using more than one method, the resolution is:
Method 1 > Method 2 > Method 3.
For example, the FSDB dump file name can be set via one of the following
methods:
a. Specify the file name on the simulator command line:
> simv +fsdbfile+high.fsdb

b. Specify the file name via an environment variable:

> setenv NOVAS_FSDB_FILE mid_prio.fsdb

c. Specify the file name in an FSDB dumping command:

$fsdbDumpvars("+fsdbfile+low_prio.fsdb");

which means, in this example, the resolved FSDB file name is "high.fsdb".

Linking Novas Files with Simulators and Enabling FSDB Dumping 9

FSDB Dumping Commands

Mapping Command Line, Environment Variable, and

Dumping Command Options
The following table maps the simulator command line options to their equivalent
environment variables and FSDB dumping command options.

NOTE: An option which can be set on the simulator command line may not
always have an equivalent mapping environment variable or FSDB
dumping command option.

NOTE: A novas_dump.log file gets created during simulation to record some

Specify with
Specify on Simulator Specify using Environment
FSDB Dumping
Command Line Variable
Command

+fsdb+delta FSDB_DELTA None

+fsdb+dump_limit=size FSDB_DUMP_LIMIT None

+fsdbfile+filenam
+fsdbfile+filename NOVAS_FSDB_FILE
e

+fsdbLogOff None None

+fsdbLog=severity None None

+fsdb+all[=on|off] NOVAS_FSDB_ALL +all

+fsdb+autoflush None None

+fsdb+dumpoff_glitch+time
None None
[+htime]

+fsdb+dumpon_glitch+time
None None
[+htime]

10 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Specify with
Specify on Simulator Specify using Environment
FSDB Dumping
Command Line Variable
Command

+fsdb+dumpoff_sequence
+time[+htime]
None None
+fsdb+dumpoff_sequence
+time[time_unit]

+fsdb+dumpon_sequence
+time[+htime]
None None
+fsdb+dumpon_sequence
+time[time_unit]

+fsdb+dump_log[=on|off] FSDB_DUMP_LOG None

+fsdb+dumpon+time[+htime] None None

+fsdb+dumpoff+time[+htime] None None

+fsdb+esconfig="filename"
FSDB_ESCONFIG
NOTE: This option and the
+fsdb+esoptions option are NOTE: When this environment
exclusive. variable and the
NOTE: When this option and FSDB_ESOPTIONS environment None
the ESCONFIG or variables are specified
FSDB_ESOPTIONS simultaneously, the
environment variable are FSDB_ESOPTIONS environment
specified simultaneously, this variable will be ignored.
option will be ignored.

+fsdb+esdb="esdb_filename" FSDB_ESDB None

+fsdb+esdb_es_only[=on|off] FSDB_ESDB_ES_ONLY None

Linking Novas Files with Simulators and Enabling FSDB Dumping 11

FSDB Dumping Commands

Specify with
Specify on Simulator Specify using Environment
FSDB Dumping
Command Line Variable
Command

+fsdb+esoptions="ESAoption"

NOTE: This option and the

+fsdb+esconfig option are FSDB_ESOPTIONS
exclusive.
NOTE: When this option and NOTE: When this environment
the FSDB_ESOPTIONS or variable and the ESCONFIG
None
ESCONFIG environment environment variables are
variable are specified specified simultaneously, the
simultaneously, this option will FSDB_ESOPTIONS environment
be ignored. variable will be ignored.
NOTE: Refer to the table after
the examples for all available
ESA options.

+fsdb+force FSDB_FORCE None

FSDB_FUNCTIONS
+fsdb+functions
NOTE: The
NOTE: The
-debug_access+dmptf option
-debug_access+dmptf option +functions
must be specified for VCS
must be specified for VCS
compile before setting the
compile before setting the
FSDB_FUNCTIONS
+fsdb+functions option.
environment variable.

NOVAS_FSDB_ENV_MAX_G
+fsdb+glitch=num None
LITCH_NUM

+fsdb+ignore_vhdl_complex NOVAS_FSDB_IGNORE_
None
[=on|off] VHDL_COMPLEX

+fsdb+io_only FSDB_IO_ONLY +IO_Only

+fsdb+keep_cell_module=
FSDB_KEEP_CELL_MODULE None
module_name

+fsdb+mda[=on|off] NOVAS_FSDB_MDA +mda

+fsdb+msv+i FSDB_MSV_I +msv+i

+fsdb+msv+i= FSDB_MSV_IN n +msv+i=n

+fsdb+msv+isub FSDB_MSV_ISUB +msv+isub

+fsdb+msv+v FSDB_MSV_V +msv+v

12 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Specify with
Specify on Simulator Specify using Environment
FSDB Dumping
Command Line Variable
Command

+fsdb+msv+v= FSDB_MSV_VN n +msv+v=n

+fsdb+msv+vaI FSDB_MSV_VAI +msv+vaI

+fsdb+msv+vaV FSDB_MSV_VAV +msv+vaV

+fsdb+msv+va SDB_MSV_VA +msv+va

+fsdb+packedmda[=on|off] NOVAS_FSDB_PACKEDMDA +packedmda

+fsdb+no_all_msg None None

+fsdb+no_error None None

+fsdb+no_msg_in_file+
None None
filename

+fsdb+no_msg+
None None
pattern1[+pattern2..]

+fsdb+no_parallel FSDB_NO_PARALLEL None

+fsdb+no_psl_scope FSDB_NO_PSL_SCOPE +no_psl_scope

+fsdb+no_warning None None

NOVAS_FSDB_
+fsdb+parameter[=on|off] +parameter
PARAMETER

+fsdb+psl_prop FSDB_DUMP_PSL_PROP +psl_prop

+fsdb+reg_only FSDB_REG_ONLY +Reg_Only

+fsdb+region FSDB_REGION None

+fsdb+reserve NOVAS_FSDB_RESERVE None

+fsdb+reuse_filename FSDB_REUSE_FILENAME None

NOVAS_FSDB_ENV_DUMP_S
+fsdb+sequential None
EQ_NUM

+fsdb+skip_cell_instance= NOVAS_FSDB_SKIP_CELL_ +skip_cell_

mode INSTANCE instance

+fsdb+strength[=on|off] NOVAS_FSDB_ STRENGTH +strength

+fsdb+struct[=on|off] NOVAS_FSDB_STRUCT +struct

Linking Novas Files with Simulators and Enabling FSDB Dumping 13

FSDB Dumping Commands

Specify with
Specify on Simulator Specify using Environment
FSDB Dumping
Command Line Variable
Command

+fsdb+sva_index_info FSDB_SVA_INDEX_INFO None

+fsdb+sva_status FSDB_SVA_STATUS +sva_status

+fsdb+time_precision=
FSDB_TIME_PRECISION None
time_unit

NOVAS_FSDB_TRACE_
+fsdb+trace_process[=on|off] +trace_process
PROCESS

NOVAS_FSDB_TRANS_
+fsdb+trans_begin_callstack None
BEGIN_CALLSTACK

NOVAS_FSDB_TRANS_
+fsdb+trans_end_callstack None
END_CALLSTACK

FSDB_TRANS_ERROR_
+fsdb+trans_error_callstack None
CALLSTACK

FSDB_TRANS_HIDE_
+fsdb+trans_hide_error None
ERROR

+fsdb+vhdl_package_lib=
FSDB_VHDL_PACKAGE_LIB None
+all|lib_name1:lib_name2:...

+fsdb+writer_mem_limit= NOVAS_FSDB_ENV_
None
num WRITER_MEM_LIMIT

+fsdb_trans_file+filename FSDB_TRANS_FILE None

NOVAS_FSDB_DEFAULT_
None None
FILE_NAME

Some options are related to one another in behavior. For example, the
NOVAS_FSDB_MDA option can enable/disable MDA signal dumping and the
NOVAS_FSDB_ALL option can enable/disable all supported signal type
dumping. This makes NOVAS_FSDB_ALL a superset of
NOVAS_FSDB_MDA. When such options are set using different methods at the
same time, the effect of the setting is determined as follows:
1. Resolve each option's value using the simulator command line then
environment variable, and then FSDB dumping command resolution
priority.
2. Behave according to the union of all the option settings.

14 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Example 1
1. Specify the environment variable to enable dumping MDA signals:
setenv NOVAS_FSDB_MDA 1

2. Specify the option in an FSDB dumping command to enable dumping all

supported signals:
$fsdbDumpvars("+all");

It would seem that the environment variable (1) should have priority over the
setting in the FSDB dumping command (2). However, these two options are not
the same, so the resolution for the three methods cannot be applied. The effect of
the setting in this example is the union of the option setting of
NOVAS_FSDB_MDA(+fsdb+mda) and NOVAS_FSDB_ALL(+fsdb+all) and
that is "to enable dumping of all supported signals".

Example 2
1. Specify the option on the simulator command line to enable dumping
packed MDA signals:
simv +fsdb+packedmda

2. Specify the environment variable to enable dumping MDA signals:

setenv NOVAS_FSDB_MDA 1

The NOVAS_FSDB_MDA environment variable which is equal to the

+fsdb+mda option is resolved to be on. The effect of the two related options
+fsdb+mda (=on) and the +fsdb+packedmda (=on) are then unified as "to
enable dumping of all MDA signals".

Example 3
Specify the options on the simulator command line to filter all dumper messages,
warning messages, and error messages:
simv +fsdb+no_warning +fsdb+no_error +fsdb+no_all_msg

The effect of the three related options is the union of the three which is "to filter
all dumper messages".

Linking Novas Files with Simulators and Enabling FSDB Dumping 15

FSDB Dumping Commands

FSDB Dumping Command Line Options

The simulator command line options that can be used to configure FSDB
dumping are summarized in the table below.
Table: Simulation Command Line Options

Option Description Example

Enable the following options,

specifying the glitch value:
+fsdb+glitch=0
+fsdb+sequential
+fsdb+region

+fsdb+delta NOTE: If the +fsdb+glitch +fsdb+delta

option is also enabled
individually, the glitch value
specified with the +fsdb+glitch
option will overwrite the glitch
value specified with the
+fsdb+delta option.

Limit the size of the FSDB file.

The default is 10MB.

+fsdb+dump_limit= NOTE: The minimum limit size

+fsdb+dump_limit=15
size is 10MB. If limit size is set to
less than 10MB, the limit size
will be set to 10MB
automatically.

Specify the FSDB file name. If it

+fsdbfile+filename is not specified, the default +fsdbfile+test1.fsdb
FSDB file name is "novas.fsdb".

+fsdbLogOff Do not dump logging messages. +fsdbLogOff

+fsdbLog=3
+fsdbLog=-1
Dump logging messages by level +fsdbLog=~5 ...
+fsdbLog=severity
of severity. +fsdbLog=7~ ...
+fsdbLog=5~7 ...
+fsdbLog=7~5 ...

16 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Option Description Example

Enable dumping of all signals

including memory, MDA,
packed array, structure, union,
power-related, and packed
+fsdb+all[=on|off] +fsdb+all=on
structure in all scopes specified
in $fsdbDumpvars or the entire
design if no scope is specified.
The default is off.

Enable the automatic flush

function when the simulation is
stopped with the $stop dumping
command or by pressing the
+fsdb+autoflush Ctrl-C key. +fsdb+autoflush
This option is useful when
dumping the FSDB file in batch
mode and to view the results on
nWave immediately.

+fsdb+dump_log Enable/disable novas_dump.log.

+fsdb+dump_log=on
[=on|off] The default is on.

Specify the time {htime, time} to

disable dumping of glitches.
+fsdb+dumpoff_ glitch
NOTE: The +fsdb+glitch=num
+123+2
option is required before this
+fsdb+dumpoff_glitch (Turn off dumping
option works.
+time[+htime glitch commands at the
NOTE: When the time_unit is
or specified time:
not specified, the simulation
+fsdb+dumpoff_glitch {32'd<2>, 32'd<123>})
time unit of Verilog will be used
+time[time_unit or
as the default time unit.
+fsdb+dumpoff_ glitch
NOTE: If multiple dump off
+3000ps
times are needed, repeat this
option for each dump time.

Turn off dumping sequence +fsdb+dumpoff_sequence

commands at the specified time +123+2
{htime, time}. (Turn off dumping
+fsdb+dumpoff_sequen
NOTE: When the time_unit is sequence commands at the
ce+time[+htime]
not specified, the simulation specified time:
or
time unit of Verilog will be used {32'd<2>, 32'd<123>})
+fsdb+dumpoff_sequen
as the default time unit.
ce+time[time_unit]
NOTE: If multiple dump off or
times are needed, repeat this +fsdb+dumpoff_sequence
option for each dump time. +3000ps

Linking Novas Files with Simulators and Enabling FSDB Dumping 17

FSDB Dumping Commands

Option Description Example

Turn off dumping commands at

+fsdb+dumpoff+2500+2
the specified time {htime, time}.
(Turn off dumping
+fsdb+dumpoff+time NOTE: When the time_unit is
sequence commands at the
[+htime] not specified, the simulation
specified time:
or time unit of Verilog will be used
{32'd<2>, 32'd<2500>})
+fsdb+dumpoff+time as the default time unit.
[time_unit] NOTE: If multiple dump off
or
times are needed, repeat this
+fsdb+dumpoff+2500ps
option for each dump time.

Specify the time {htime, time} to

enable dumping of glitches.
+fsdb+dumpon_ glitch
NOTE: The +fsdb+glitch=num
+123+2
option is required before this
+fsdb+dumpon_glitch (Turn on dumping
option works.
+time[+htime] glitch commands at the
NOTE: When the time_unit is
or specified time:
not specified, the simulation
+fsdb+dumpon_glitch {32'd<2>, 32'd<123>})
time unit of Verilog will be used
+time[time_unit] or
as the default time unit.
+fsdb+dumpon_ glitch
NOTE: If multiple dump off
+3000ps
times are needed, repeat this
option for each dump time.

Turn on dumping sequence +fsdb+dumpon_sequence

commands at the specified time +123+2
{htime, time}. (Turn on dumping
+fsdb+dumpon_sequen
NOTE: When the time_unit is sequence commands at the
ce+time[+htime]
not specified, the simulation specified time:
or
time unit of Verilog will be used {32'd<2>, 32'd<123>})
+fsdb+dumpon_sequen
as the default time unit.
ce+time[time_unit]
NOTE: If multiple dump on or
times are needed, repeat this +fsdb+dumpon_sequence
option for each dump time. +3000ps

Turn on dumping commands at

the specified time {htime, time}. +fsdb+dumpon+500+2
+fsdb+dumpon+time[+ NOTE: When the time_unit is (Turn on dumping
htime] not specified, the simulation sequence commands at the
or time unit of Verilog will be used specified time:
+fsdb+dumpon+time[ti as the default time unit. {32'd<2>, 32'd<500>})
me_unit] NOTE: If multiple dump on or
times are needed, repeat this +fsdb+dumpon+2500ps
option for each dump time.

18 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Option Description Example

Specify the ESA options in a text

file. Options in the file can be
+fsdb+esconfig="filena +fsdb+esconfig="My_ES
separated by spaces or lines.
me" A_option.txt"
Refer to the ESA Options section
for available options.

Specify the ESDB file name. The

FSDB dumper uses the essential
signals in this file to determine
+fsdb+esdb="esdb_file
which signals to dump. +fsdb+esdb="es"
name"
NOTE: esdb_filename is the file
generated by the esa utility with
the -db option.

+fsdb+esdb_es_only Enable Essential Signal

+fsdb+esdb_es_only=on
[=on|off] dumping. The default is on.

Specify the ESA options. Refer +fsdb+esoptions="

+fsdb+esoptions="ESA
to the ESA Options section for -xsignalfile my.list -xscope
options"
available options. top"

Enable dumping the force status

+fsdb+force +fsdb+force
of the Verilog signal.

Set to enable dumping the

signals in function and task.

NOTE: The
+fsdb+functions +fsdb+functions
-debug_access+dmptf option
must be specified for VCS
compile before setting the
+fsdb+functions option.

Enable specifying the glitch

number. Range: 0 ~ 254
Number:
0: All glitches are stored.
1: The last glitch is stored.
+fsdb+glitch=num +fsdb+glitch=0
2: The first and the last glitches
are stored. Refer to the
NOVAS_FSDB_ENV_MAX_
GLITCH_NUM environment
variable for details.

Linking Novas Files with Simulators and Enabling FSDB Dumping 19

FSDB Dumping Commands

Option Description Example

Do not dump complex signal

+fsdb+ignore_vhdl_ types for VHDL such as records, +fsdb+ignore_vhdl_
complex[=on|off] multi-dimensional arrays, and complex=on
array of records.

Dump only input/output port

+fsdb+io_only +fsdb+io_only
signals.

Specify the module that will not

be skipped when the
skip_cell_instance option is
turned on. The wildcard
character (*) is supported.
NOTE: This option can be
specified multiple times in one
simulation and multiple cell +fsdb+keep_cell_module=
+fsdb+keep_cell_ modules will be kept. cell_b
module= NOTE: When specifying this or
module_name option multiple times, use the +fsdb+keep_cell_module=
following format: "cell_*"
+fsdb+keep_cell_module=PD
+fsdb+keep_cell_module=PD1
+ fsdb+keep_cell_module=PD2
Using the following format will
report an error:
+fsdb+keep_cell_module=PD+
PD1+PD2.

Enable/disable dumping all

+fsdb+mda[=on|off] +fsdb+mda=off
MDA signals. The default is off.

Enable/disable dumping packed

+fsdb+packedmda MDA signals. The default is off.
+fsdb+packedmda=on
[=on|off] NOTE: This option replaces the
+mda+packedOnly option.

20 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Option Description Example

Dump analog current signals.

NOTE: Additional current
voltage signals will be dumped
with this option.
NOTE: It is required to turn off
the shadow module optimization
in the CustomSim initial file and
+fsdb+msv+i +fsdb+msv+i
compile the -debug_access
option.
NOTE: It is required to add the
iprobe_wavefore_current in the
CustomSim configure for
dumping the current with this
option.

Dump the current of terminals. n

is a positive integer. When all is
specified, the currents of all
terminals are dumped.
NOTE: Additional analog
current signals can be dumped
with this option. +fsdb+msv+i=1
NOTE: It is required to turn off +fsdb+msv+i=2
+fsdb+msv+i=[n|all] the shadow module optimization …
in the CustomSim initial file and or
compile the -debug_access +fsdb+msv+i=all
option.
NOTE: It is required to add the
iprobe_wavefore_current in the
CustomSim configure for
dumping the current with this
option.

Dump analog voltage signals.

NOTE: Additional analog
voltage signals can be dumped
with this option.
+fsdb+msv+v NOTE: It is required to turn off +fsdb+msv+v
the shadow module optimization
in the CustomSim initial file and
compile the -debug_access
option.

Linking Novas Files with Simulators and Enabling FSDB Dumping 21

FSDB Dumping Commands

Option Description Example

Dump the voltage of terminals.

n is a positive integer. When all
is specified, the voltages of all
terminals are dumped.
+fsdb+msv+v=1
NOTE: Additional analog
+fsdb+msv+v=2
voltage signals can be dumped
+fsdb+msv+v=[n|all] …
with this option.
or
NOTE: It is required to turn off
+fsdb+msv+v=all
the shadow module optimization
in the CustomSim initial file and
compile the -debug_access
option.

Dump the total current flows into

+fsdb+msv+isub +fsdb+msv+isub
the subcircuit port.

Filter all FSDB dumper

+fsdb+no_all_msg +fsdb+no_all_msg
messages.

+fsdb+no_error Filter the error message. +fsdb+no_error

Filter the messages which are

+fsdb+no_msg_in_ +fsdb+no_msg_in_file+
specified in a file (e.g.
file+filename no_msg_list.txt
no_msg_list.txt).

Filter the messages which

+fsdb+no_msg+
contain the specified strings (e.g. +fsdb+no_msg+Analog
pattern1[+pattern2..]
"Analog").

+fsdb+no_parallel Disable parallel dumping. +fsdb+no_parallel

Skip dumping the PSL scope

named cds_assertion_models
+fsdb+no_psl_scope +fsdb+no_psl_scope
that is generated automatically in
the simulator.

+fsdb+no_warning Filter the warning message. +fsdb+no_warning

+fsdb+parameter Enable/disable parameter

+fsdb+parameter=on
[=on|off] dumping. The default is off.

+fsdb+psl_prop Dump the PSL property. +fsdb+psl_prop

+fsdb+reg_only Dump only register type signals. +fsdb+reg_only

+fsdb+region Enable region mode dumping. +fsdb+region

22 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Option Description Example

Do not overwrite the existing

FSDB file. Upcoming FSDB
files, which share the same name
+fsdb+reserve +fsdb+reserve
as the reserved one, would be
re-named as xxx_r0.fsdb,
instead.

Reuse an existing FSDB

filename if the file itself is
+fsdb+reuse_filename +fsdb+reuse_filename
removed while the simulation is
running.

Enable sequence dumping. Refer

to the FSDB_ENV_DUMP_
+fsdb+sequential +fsdb+sequential
SEQ_NUM environment
variable for details.

Enable/Disable dumping of cell

instance where mode means:
0: Disable functionality.
1: Skip dumping `celldefine and
–v/-y library cells.
2: Skip dumping the content of
`celldefine and –v/-y library cells
but keep dumping ports.
+fsdb+skip_cell_ +fsdb+skip_cell_instance=
3: Skip dumping `celldefine
instance=mode 2
library cells and keep dumping
–v/-y library cells.
4: Skip dumping `celldefine
library cells but keep the ports of
the `celldefine library cell. Keep
dumping –v/-y library cells.
Others: Show error message and
ignore it.

+fsdb+strength Enable/disable dumping

+fsdb+strength=on
[=on|off] strength. The default is off.

Enable/disable dumping struct

+fsdb+struct[=on|off] +fsdb+struct=on
signals. The default is off.

Dump the assertion index

+fsdb+sva_index_info +fsdb+sva_index_info
information.

+fsdb+sva_status Dump the assertion status. +fsdb+sva_status

+fsdb+time_precision Manually set the time precision

+fsdb+timeprecision=1ns
=time_unit in the FSDB file.

Linking Novas Files with Simulators and Enabling FSDB Dumping 23

FSDB Dumping Commands

Option Description Example

Enable/disable dumping VHDL

variables under processes. The
default is off.
+fsdb+trace_process
NOTE: For VCS users, the VCS +fsdb+trace_process=on
[=on|off]
debug level option needs to be
set as "-debug_all" for dumping
process variables.

Dump the full call stack for each

+fsdb+trans_error_ transaction error message from +fsdb+trans_error_
callstack the Novas object files for FSDB callstack
dumping.

Hide all transaction error

+fsdb+trans_hide_ +fsdb+trans_hide_
messages from the Novas object
error error
files for FSDB dumping.

+fsdb+vhdl_package_li Dump the packages under all

+fsdb+vhdl_package_lib=
b=+all libraries or the specified
+all
or libraries.
or
+fsdb+vhdl_package_li NOTE: If the library is not
+fsdb+vhdl_package_lib=
b=lib_name1: specified, no packages will be
work:std:ieee
lib_name2:... dumped.

Specify the limit for the FSDB

writer to flush value changes in
memory.
The default value is 64 when the
FSDB file has less than 5M
+fsdb+writer_mem_ signals. The default value is 128 +fsdb+writer_mem_limit=
limit=num when the FSDB file has 5M - 64
10M signals. The default value is
256 when the FSDB file has
more than 10M signals. Valid
range is from 4 to 2048. The
units are in MB.

Specify a transaction FSDB file.

NOTE: When this option and
+fsdb_trans_file+ +fsdb_trans_file+
the +fsdbfile+filename option
filename test1.fsdb
are specified simultaneously, this
option will be ignored.

24 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

ESA Options
The ESA options used for +fsdb+esoptions="ESAoption" are summarized in the
table below. These options are optional.
Table: ESA Options Supported in Simulator Runtime Phase

Option Syntax Description

Specify the clock and reset signal dumping option. The

-dumpclk none(n)|all(a)
default is 'all'.

-exclude_floating 0|1 Exclude floating net if set to 1. The default is 0.

Exclude signals inside the instances specified in the

-exclude_inst_file filename
file.

If outputs of library cells cannot be computed,

-exclude_nd_module 0|1 automatically dump the outputs and exclude the
internals of the cell. The default is 0.

-hier_replace Replace the current hierarchy name of the scope with

source_scope=target_scope the specified hierarchy name.

-IO instance Dump I/O ports of instances.

Specify the level for -IO. This is optional. The default

-IO_level N
is N=1.

Suppress Essential Signal dumping for all modules

-suppress_mfile filename
listed in the specified file.

-xscope instance Dump all signals for the specified instance.

Linking Novas Files with Simulators and Enabling FSDB Dumping 25

FSDB Dumping Commands

Option Syntax Description

Dump all signals for the instances specified in the file.

Multiple scopes with different levels can be specified.
Each pair of the level-scope is separated by a line. If the
level of scopes is not specified, its value is the same as
the -xscope_level value (the default is 1). The format
of xscopefile.f is:
2 top.a
0 top.b
top.c
-xscopefile filename
Example:
simv +vcs+lic+wait +fsdb+esdb=es
+fsdb+esoptions="-xscope
tb_CPUsystem.i_CPUsystem
-xscope_level 1 -xscopefile xscopefile.f"

In the xscopefile.f:
2 tb_CPUsystem.i_CPUsystem.i
_CPU

-xscope_level N Specify the level for -xscope. The default is N=1.

Dump the signals from the specified legacy

hierarchical Essential Signal list (text format).
-xsignalfile filename
NOTE: To dump the signals from the legacy plain
Essential Signal list, use $fsdbDumpvarsByFile.

26 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

FSDB Dumping Commands Used with

Verilog
The Novas object files for FSDB dumping provide the following FSDB dumping
commands for Verilog:
$fsdbAutoSwitchDumpfile
$fsdbDumpfile
$fsdbDumpflush
$fsdbDumpon, $fsdbDumpoff
$fsdbDumpvars
$fsdbDumpvarsByFile
$fsdbDumpFinish
$fsdbDumpMDA
$fsdbDumpMDAByFile
$fsdbDumpPSL
$fsdbDumpSVA
$fsdbLog
$fsdbSuppress
$fsdbSwitchDumpfile

Supported Simulators for FSDB Dumping Commands

The following table illustrates the supported simulator version for each FSDB
dumping command.

IUS 13.1 and VCS 2014.03 and ModelSim 10.2

Verilog Task Name
later later and later
$fsdbAutoSwitchDumpf
x x x
ile
$fsdbDumpfile x x x
$fsdbDumpflush x x x
$fsdbDumpoff x x x
$fsdbDumpon x x x
$fsdbDumpvars x x x
$fsdbDumpvarsByFile x x x
$fsdbDumpFinish x x x
$fsdbDumpMDA x x x

Linking Novas Files with Simulators and Enabling FSDB Dumping 27

FSDB Dumping Commands

$fsdbDumpSVA x x x
$fsdbLog x x x
$fsdbSuppress x x x
$fsdbSwitchDumpfile x x x

General Dumping Commands

$fsdbDumpfile

Description
Specify the FSDB file name created by the Novas object files for FSDB
dumping. If not specified, the default FSDB file name is "novas.fsdb". This
command is valid only before $fsdbDumpvars is executed and is ignored if
specified after $fsdbDumpvars.
To restrict the largest dump file size to the user-defined size limitation, please
specify the limit size in megabyte format. This function will affect the FSDB file
that is specified in "FSDB_Name". The FSDB dumper uses the sliding window
scheme to keep the last signal values in the FSDB file. It drops the old values if
file size exceeds the user-specified limitation.
For $fsdbDumpvars, $fsdbDumpMDA, $fsdbDumpSVA and
$fsdbDumpvarsByFile, user can use the option "+fsdbfile+filename.fsdb" to
specify the target FSDB file to dump. It is equal to using $fsdbDumpfile then
$fsdbDumpvars.

NOTE: To leverage the memory consumption, the maximum number of opened

FSDB files for dumping in a single simulation run should be no more
than 32 files.

Syntax
When specified in the design:
$fsdbDumpfile("FSDB_Name" | FSDB_Name_var [ ,Limit_Size |
,Limit_Size_var ]);

When specified on the simulator command line:

Synopsys:
fsdbDumpfile "FSDB_Name"
fsdbDumpfile "FSDB_Name" Limit_Size

28 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Cadence:
call fsdbDumpfile "FSDB_Name"
call fsdbDumpfile "FSDB_Name" Limit_Size

ModelSim:
fsdbDumpfile "FSDB_Name"
fsdbDumpfile "FSDB_Name" Limit_Size

Arguments
FSDB_Name
Specify the name of the FSDB file generated by the Novas object files for
FSDB dumping.
FSDB_Name_var
Specify the FSDB file name in a variable.

NOTE: Valid only if the command is specified inside the design.

Limit_Size
Specify the maximum FSDB file size in megabyte.
Limit_Size_var
Specify the maximum FSDB file size in a variable.

NOTE: Valid only if the command is specified inside the design.

NOTE: The minimum file size of the FSDB file is 10M. If you set the size to
less than 10M, it will be set to 10M instead.

Variable Example
If specified in the design, the design variable could be passed as command
argument.
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
reg [15:0] limit_size_reg = 1000;
string newDumpfile_string = "novas_new.fsdb";
reg [1023:0] newDumpfile_reg = "novas_new.fsdb";

Linking Novas Files with Simulators and Enabling FSDB Dumping 29

FSDB Dumping Commands

$fsdbDumpfile("novas.fsdb");
$fsdbDumpfile(newDumpfile_string, 1000);
$fsdbDumpfile(newDumpfile_reg, limit_size_reg);

$fsdbDumpFinish

Description
Close all FSDB files in the current simulation and stop dumping the signals.
Although all FSDB files are closed automatically at the simulation finish, this
dumping command can be invoked to explicitly close the FSDB files during the
simulation. A new FSDB file can be created after the old FSDB file is closed.
New dumping data cannot be appended to a closed FSDB file due to the current
limitation of the FSDB file architecture. If the same file name as a closed FSDB
file name is opened again during the same simulation run, the new FSDB file will
be renamed automatically.

Syntax
When specified in the design:
$fsdbDumpFinish;

When specified on the simulator command line:

Synopsys:
fsdbDumpFinish

Cadence:
call fsdbDumpFinish

ModelSim:
fsdbDumpFinish

$fsdbDumpflush

Description
This FSDB dumping command may be used in the HDL code and also via the
command line for interactive simulation control. The command forces the signal
values to be flushed to the FSDB file while the simulation is running. Therefore,
the current simulation results can be checked whenever necessary instead of
waiting for the simulation to end or the internal buffer to be filled.

NOTE: The Novas object files for FSDB dumping will automatically flush the
value change data to the FSDB file on disk under the following
conditions:

30 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

- The simulation stop is due to a $stop statement in the design.

- The simulation stops at a user specified breakpoint.
- The user uses Ctrl-C to break the simulation.

Syntax
When specified in the design:
$fsdbDumpflush;

When specified on the simulator command line:

Synopsys:
fsdbDumpflush

Cadence:
call fsdbDumpflush

ModelSim:
fsdbDumpflush

$fsdbDumpon, $fsdbDumpoff

Description
These FSDB dumping commands turn dumping on and off. $fsdbDumpon and
$fsdbDumpoff have the highest priority and will override all other FSDB
dumping commands such as $fsdbDumpvars, $fsdbDumpMDA, $fsdbDumpSVA,
or $fsdbDumpvarsByFile.
In the nWave window, blue solid blocks are displayed during the period when
dumping is turned off by the $fsdbDumpoff command and no signals are dumped.
All signals are assigned with the NV (No Value) data value in the value pane of
the nWave window and for Active Annotation in other windows. In addition, the
full scale ruler will mark this period with red box.

Linking Novas Files with Simulators and Enabling FSDB Dumping 31

FSDB Dumping Commands

Figure: Dump-Off Period in the nWave Window - No Value Signal

Signals that have not started dumping values at the time the FSDB file specified
by the $fsdbDumpfile command is opened will be assigned with the NF (Not
Found) data value in the value pane of the nWave window.

Figure: Dump-Off Period in the nWave Window - Not Found Signal

NOTE: $fsdbDumpon and $fsdbDumpoff are not restricted to only

$fsdbDumpvars.
If multiple FSDB files are open for dumping at one simulation run,
$fsdbDumpon and $fsdbDumpoff may only affect a specific FSDB file
by specifying the specific file name.

NOTE: $fsdbDumpon and $fsdbDumpoff only support integers as the argument

for time.

Syntax
When specified in the design:
$fsdbDumpon([ "option"| option_var| ]);

32 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

$fsdbDumpoff([ "option"| option_var]);

When specified on the simulator command line:
Synopsys:
fsdbDumpon [option]
fsdbDumpoff [option]

Cadence:
call fsdbDumpon [option]
call fsdbDumpoff [option]

ModelSim:
fsdbDumpon [option]
fsdbDumpoff [option]

Arguments
option

For $fsdbDumpon, specify the target FSDB file name for

"Dump On". If not specified, dumping for all FSDB files
will be turned on.
+fsdbfile+filename
For $fsdbDumpoff, specify the target FSDB file name for
"Dump off". If not specified, dumping for all FSDB files
will be turned off.
For $fsdbDumpon, specify the time to enable dumping
of glitches.
NOTE: The +fsdb+glitch=num option is required
before this option works. The +fsdb+glitch=num option
specifies the glitch number ranging from 0 to 254.
"+glitch"
For $fsdbDumpoff, specify the time to disable dumping
of glitches.
NOTE: The +fsdb+glitch=num option is required
before this option works. The +fsdb+glitch=num option
specifies the glitch number ranging from 0 to 254.

option_var
Specify the FSDB file name option in a variable.

NOTE: Valid only if the command is specified inside the design.

Examples
NOTE: The following examples use the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
initial

Linking Novas Files with Simulators and Enabling FSDB Dumping 33

FSDB Dumping Commands

begin
#50000
$fsdbDumpvars;
#50000
$fsdbDumpoff;
#50000
$fsdbDumpon;
#50000
$finish;
end

The value changes for all variables in this design example are dumped from
time 50000 to time 100000 and from time 150000 to time 200000.
initial begin
$fsdbDumpoff("+glitch")
#10
$fsdbDumpvars;
#10
$fsdbDumpon("+glitch");
#10
$fsdbDumpoff("+glitch");
$finish;
end

Any glitches in this design example are enabled for dumping from time 20
to time 30.
Variable Example
If specified in the design, design variable can be passed as an argument.
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
string option_string = "+fsdbfile+novas.fsdb";

$fsdbDumpon();
$fsdbDumpon("+fsdbfile+novas.fsdb");
$fsdbDumpon(option_reg);
$fsdbDumpon(option_string);

reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";

string option_string = "+fsdbfile+novas.fsdb";

$fsdbDumpoff();
$fsdbDumpoff("+fsdbfile+novas.fsdb");
$fsdbDumpoff(option_reg);
$fsdbDumpoff(option_string);

$fsdbDumpvars

Description
Dump signal-value-change information to the FSDB file.

34 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

NOTE:
1. For VCS users, to include memory, MDA, packed array and structure
information in the generated FSDB file, the -debug_pp option or
alternative +vpi, +memcbk and +vcsd options must be included when
VCS is invoked to compile the design.
2. The generated FSDB can be converted to VCD which will include
the MDA and structure data.

Syntax
When specified in the design:
$fsdbDumpvars([ depth, | "level=",depth_var, ]
[instance | "instance=",instance_var]
[ ,"option" | ,"option=",option_var ]*);

$fsdbDumpvars;
$fsdbDumpvars([depth] [, instance ]);
$fsdbDumpvars("level=", depth_var [, instance ]);
$fsdbDumpvars( ["level=", depth_var] [,"option"]*);
$fsdbDumpvars([depth] [,"option=", option_var]*);

NOTE:
1. Dumping design variables only supports dumping commands that
have been specified inside the source code of the design; for interactive
mode, use the task in the simulator command line format instead.
2. After a dumping command has been specified inside the design, it is
compatible with both dumping variable and simulator interactive mode
formats.
When specified on the simulator command line:
Synopsys:
fsdbDumpvars
fsdbDumpvars depth instance [option]*
fsdbDumpvars depth [instance]
fsdbDumpvars [option]*

Cadence:
call fsdbDumpvars
call fsdbDumpvars depth instance [option]*
call fsdbDumpvars [option]*

Linking Novas Files with Simulators and Enabling FSDB Dumping 35

FSDB Dumping Commands

Modelsim:
fsdbDumpvars
fsdbDumpvars depth instance [option]*

Arguments
depth
Specify how many levels of hierarchy to dump for the subsequent scopes. If
the subsequent arguments are signals, only these signals will be dumped.

NOTE: When specified in the design, if the depth argument is specified as a

variable type, the first argument must be specified as a string literal
"level=" and the second argument as level argument. The default level
value is 0. Level values have the following meanings:
0: all signals in all scopes.
1: all signals in current scope.
2: all signals in the current scope and all scopes one level below.
n: all signals in the current scope and all scopes n-1 levels below.
"level="
Keyword to identify the next argument is a number.

NOTE: Valid only if the command is specified inside the design.

depth_var
Specify how many levels of hierarchy to dump for the subsequent scopes in
a variable.

NOTE: Valid only if the command is specified inside the design.

instance
This definition gives the module scope or signals in full hierarchy format
that specify the objects to dump.

NOTE: If this FSDB dump command is included in a VHDL design, double

quotes are required for all signals under a VHDL scope. If this FSDB
dump command is included in a Verilog design, double quotes are not
required.
"instance="
Keyword to identify the content of the next argument is a module scope or
signal.

NOTE: Valid only if the command is specified inside the design.

36 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

instance_var
This definition gives the module scope or signal which represented by
instance_var that specify the object to dump.

NOTE: Valid only if the command is specified inside the design.

option
Specify one or more of the following options.

"+IO_Only" Only IO port signals will be dumped.

"+Reg_Only" Only reg type signals will be dumped.
Dump all memory and MDA signals in all scopes specified in
$fsdbDumpvars or the entire design if no scope is specified.
This option is covered by the "+all" option and is effective for
SystemVerilog's MDAs only. For VCS users, the VCS option
"+mda"
"+memcbk" may be needed while compiling the design.
NOTE: This option does not apply to VHDL arrays because
they are dumped by default without this option.
Example: $fsdbDumpvars("+mda");
"+msv+v=N" Dump signal voltage for the specified terminal.
"+msv+v=all" Dump signal voltage for all terminals.
"+msv+i=N" Dump signal current for the specified terminal.
"+msv+i=all" Dump signal current for all terminals.
Dump the packed signals in the design. Refer to the Supported
MDA Format Table for a summary of which packed or
unpacked one-dimensional/two-dimensional signals are
"+packedmda" dumped with or without the +packedmda and +mda options.
This option is covered by the "+mda" option.
Example: $fsdbDumpvars("+packedmda");
NOTE: This option replaces the +mda+packedOnly option.
Dump the struct or the struct in packed MDA.
+packedmda+struct
Example: $fsdbDumpvars("+packedmda+struct ");
Dump all structs in all scopes specified in fsdbDumpvars or in
the entire design if no scope is specified. This option is covered
"+struct" by the "+all" option and is effective for SystemVerilog struct
syntax only.
Example: $fsdbDumpvars("+struct");
Enable/Disable dumping of cell instance where mode means:
0: disable functionality.
"+skip_cell_instance 1: Skip all cell info.
=mode" 2: Dump all ports of cell instance.
Others: Show error message and ignore it.
Example: $fsdbDumpvars("+skip_cell_instance");

Linking Novas Files with Simulators and Enabling FSDB Dumping 37

FSDB Dumping Commands

Enable strength dumping.

"+strength"
Example: $fsdbDumpvars("+strength");
Dump all signals including memory, MDA, packed array,
structure, union, power-related, and packed structure in all
scopes specified in $fsdbDumpvars or the entire design if no
scope is specified.
For VCS users, the VCS option "+memcbk" may be needed
"+all" when compiling the design.
NOTE: Power-related signals include power supply nets and
power domain states. Power-related signals are dumped
hierarchically under the $power_root folder.
NOTE: If the "+all" or "+power" options are not specified, the
power-related signals will not be dumped.
Dump parameters.
Example: $fsdbDumpvars("+parameter");
"+parameter"
NOTE: If the parameter type is "scalar", "real", or "string", the
name will be displayed without range information.
Dump power-related signals.
Example: $fsdbDumpvars("+power");
NOTE: Power-related signals include the power supply nets and
"+power" power domain states. Power-related signals are dumped
hierarchically under the $power_root folder.
NOTE: If the "+power" or "+all" options are not specified, the
power-related signals will not be dumped.
Dump VHDL processes.
"+trace_process"
Example: $fsdbDumpvars("+trace_process");
Enable dumping of functions in the design.
"+functions"
Example: $fsdbDumpvars("+functions");
Specify the FSDB file name. If not specified, the default FSDB
file name is "novas.fsdb".
NOTE: An environment variable can be used as part of the
filename string argument. Refer to the Use Environment
"+fsdbfile+filename"
Variable(s) in the String Argument section for an example.
When an environment variable is defined and then embedded
into the option, the FSDB dumper will replace the environment
variable with the given definition.
Dump the Verilog-A parameter probe. The signals dumped by
the command line are integer, real, genvar, and parameter.
+msv+va NOTE: An error message appears and the Verilog-A probes are
not dumped if the -- iprobe_waveform_va
command is not specified in the CustomSim configuration file.

38 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Dump the Verilog-A voltage probe. The signals dumped by the

command line are module port voltage, terminal voltage, and
branch voltage.
+msv+vaV NOTE: An error message appears and the Verilog-A probes are
not dumped if the -iprobe_waveform_va
-branch_voltage command is not specified in the
CustomSim configuration file.
Dump the Verilog-A current probe. Module port current,
terminal current, and branch current.
NOTE: An error message appears and the Verilog-A probes are
+msv+vaI not dumped if the Parameter probe
-iprobe_waveform_va -branch_current and
iprobe_waveform_current command is not
specified in the CustomSim configuration file.

Supported MDA Format Table

Unpacked 1D Unpacked 2D Packed 1D Packed 2D

Options
e.g. T a[ ]; e.g. T a[ ][ ]; e.g. T [ ]a; e.g. T [ ][ ]a;

None Yes

"+packedmda" Yes Yes

"+mda" Yes Yes Yes Yes

"option="
Keyword to identify the next argument is a string.

NOTE: Valid only if the command is specified inside the design.

option_var
Specify the option in a variable.

NOTE: Valid only if the command is specified inside the design.

Linking Novas Files with Simulators and Enabling FSDB Dumping 39

FSDB Dumping Commands

Dump all signals in the module instances below system.

$fsdbDumpvars(0, system, "+fsdbfile+novas.fsdb");
Dump all signals in the module instances below system to the specified
FSDB file named "novas.fsdb"
$fsdbDumpvars(1, top.dut1.u1.clk);
Dump the clk signal under top.dut1.u1 when top and u1 are Verilog scopes
and dut1 is a VHDL scope. This command is included in a Verilog design.
$fsdbDumpvars("level=", level_reg, system);
Dump all signals in the system instance and module instances below it up to
the depth that level_reg variable indicates.
$fsdbDumpvars("+fsdbfile+my.fsdb")
Dump all signals of all scopes to the specified FSDB file, “my.fsdb”.
Variable Example
Specified in the design, a runtime variable can be passed as an argument.
reg [255:0] depth_reg = 10;
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
string option_string = "+fsdbfile+novas.fsdb";
string depth_string = "10";// invalid, number in string format
reg [32*8-1:0] depth_str_reg = "10"; // invalid.
reg [1023:0] instance_reg = "top";
string instance_string = "top";

$fsdbDumpvars(1, top, "+fsdbfile+novas.fsdb");

$fsdbDumpvars("level=", depth_reg);
$fsdbDumpvars("option=", option_reg);
$fsdbDumpvars("option=", option_string);
$fsdbDumpvars("level=", depth_reg, "option=", option_reg);
$fsdbDumpvars("level=", depth_reg, top, "option=",
option_string);
$fsdbDumpvars("instance=", instance_reg);
$fsdbDumpvars(1, "instance=", instance_string);

The dumping command of $fsdbDumpvars(0, design_top,

"+fsdbfile+novas.fsdb"); is equal to the combination of the two dumping
commands: $fsdbDumpfile("novas.fsdb"); $fsdbDumpvars(0, design_top);

NOTE: Refer to the $fsdbSuppress FSDB dumping command for details on

suppressing individual signals or scopes from the design.

Use Environment Variable(s) in the String Argument

Instead of modifying the file name path with each simulation run, an
environment variable can be added to the argument and then the value of the

40 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

environment variable can be changed for each simulation run. For example,
assume a variable path location is desired for the +fsdbfile+filename string
argument in the $fsdbDumpvars dumping command and the following is
specified:
• On the Unix command line:
setenv MY_FSDB_FILE_PATH /home/test
• In the testbench for simulation:
$fsdbDumpvars("+fsdbfile+${MY_FSDB_FILE_PATH}/test.fsdb");
• Multiple environment variables in the testbench for simulation:
setenv MY_FSDB_FILE_PATH /home/test
setenv MY_FSDB_FILE test
$fsdbDumpvars("+fsdbfile+${MY_FSDB_FILE_PATH}/
${MY_FSDB_FILE}.fsdb");
Then, during simulation, the FSDB dumper will replace
${MY_FSDB_FILE_PATH} with "/home/test", and the dumping command will
become $fsdbDumpvars("+fsdbfile+/home/test/test.fsdb").

$fsdbDumpvarsByFile

Description
Dump several scopes and signals defined in a text file to a designated FSDB file.
$fsdbDumpvarsByFile can be invoked more than once to dump several scopes/
signals defined in different text files to specific FSDB files. There are two
schemes to specify designated FSDB files:
1. No FSDB file name specified in $fsdbDumpvarsByFile (only one argument
needed). If no FSDB file is specified, the default file, novas.fsdb, or the
previously specified one will be taken as the default.
2. Specify the FSDB file name in $fsdbDumpvarsByFile (two arguments
needed). The argument "+fsdbfile+filename.fsdb" can be used to specify the
designated FSDB file.

NOTE: " #" can be used to comment within the text file used by
$fsdbDumpvarsByFile. The items after " #" will be ignored.

Syntax
When specified in the design:

Linking Novas Files with Simulators and Enabling FSDB Dumping 41

FSDB Dumping Commands

$fsdbDumpvarsByFile ("textFileName" | textfile_var [,"option"

|,option_var ]);

$fsdbDumpvarsByFile("textFileName");
$fsdbDumpvarsByFile("textFileName", "option");

When specified on the simulator command line:

Synopsys:
fsdbDumpvarsByFile "textFileName" [option]

Cadence:
call fsdbDumpvarsByFile "textFileName" [option]

ModelSim:
fsdbDumpvarsByFile "textFileName" [option]

Arguments
"textFileName"
Specify the name of the text file containing the scopes to dump (in plain text
format).

42 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

textfile_var
Specify the text file name in a variable.

NOTE: Valid only if the command is specified inside the design.

option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".

option_var
Specify the FSDB file name option in a variable.

NOTE: Valid only if the command is specified inside the design.

File Format of the Text File

# [pragma]
# comment
[option_in_file]* [depth] instance_name

Similar to $fsdbDumpvars, the options in the following table are for the text
file only. They can only be specified in the [option_in_file] location
of the "textfile" only. For example:
+all 1 system
+mda +struct 3 system.i_cpu

"+IO_Only" Only IO port signals will be dumped.

"+functions" Enable dumping of functions in the design.
"+Reg_Only" Only reg type signals will be dumped.
Dump all memory and MDA signals in all scopes
specified in $fsdbDumpvars or the entire design if no
scope is specified.
"+mda" This option is covered by the "+all" option and is
effective for SystemVerilog's MDAs only. For VCS
users, the VCS option "+memcbk" may be needed when
compiling the design.
"+msv+v=N" Dump signal voltage for the specified terminal.
"+msv+v=all" Dump signal voltage for all terminals.
"+msv+v" Dump analog voltage signals.
"+msv+i=N" Dump signal current for the specified terminal.
"+msv+i=all" Dump signal current for all terminals.

Linking Novas Files with Simulators and Enabling FSDB Dumping 43

FSDB Dumping Commands

"+msv+i" Dump analog current signals.

Only dump the packed signals in the design (without
array and memory types). The Supported MDA Format
Table summarizes if the packed or unpacked
one-dimensional/two-dimensional signals are dumped
"+packedmda"
with or without the +packedmda and +mda options.
Example: $fsdbDumpvars("+packedmda");
NOTE: This option replaces the +mda+packedOnly
option.
Dump the struct or the struct in packed MDA.
+packedmda+struct
Example: $fsdbDumpvars("+packedmda+struct ");
Dump all structs in all scopes specified in fsdbDumpvars
or in the entire design if no scope is specified. This
"+struct" option is covered by the "+all" option and is effective for
SystemVerilog struct syntax only.
Example: $fsdbDumpvars("+struct");
Enable/Disable dumping of cell instance where mode
means:
0: disable functionality.
"+skip_cell_instance=mode"
1: Skip all cell info.
2: Dump all ports of cell instance.
Others: Show error message and ignore it.
"+strength" Enable strength dumping.
Dump all signals including the memory, MDA, packed
array, structure, power related signals, union and packed
structure signals in all scopes specified in
"+all"
$fsdbDumpvars or the entire design if no scope is
specified. For VCS users, the VCS option "+memcbk"
may be needed when compiling the design.
Dump parameters.
NOTE: If the parameter type is “scalar”, “real”, or
"+parameter"
“string”, the name will be displayed without range
information.
"+trace_process" Dump VHDL process.
Dump power-related signals.
Example: $fsdbDumpvars("+power");
NOTE: Power-related signals include the power supply
"+power" nets and power domain states. Power-related signals are
dumped hierarchically under the $power_root folder.
NOTE: If the "+power" or "+all" options are not
specified, the power-related signals will not be dumped.

44 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

The following pragma can optionally be specified as the first line in the text file:

Do not perform Essential Signal Dumping (ESD) with

#__NOESD__ the dumping command that uses the file with this
pragma included.

Examples
NOTE: The following example uses the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
$fsdbDumpvarsByFile("./case1.lst","+fsdbfile+case1.fsdb");
where case1.lst contains:
[case1.lst]
+Reg_Only 0 top.type_dut.regInst
+parameter 0 top.type_dut.parameterInst
+functions 5 top.type_dut.FunAndTaskInst
+skip_cell_instance=0 0 top.type_dut.tri0Inst
+skip_cell_instance=1 +mda 0 top.type_dut.tri1Inst
+skip_cell_instance=2 +packedmda 0 top.type_dut.triInst
+mda 3 top.type_dut.enumInst
+packedmda 3 top.type_dut.logicInst
+struct top.type_dut.pstructInst

Variable Example
Specified in the design, the runtime variable can be passed as an argument.
...
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
reg [1023:0] suppressFile_reg = "suppress.list"; // reg string
string dumpListFile_string = "dump.list";//string
...

$fsdbDumpvarsByFile("dump.list", "+fsdbfile+novas.fsdb");
$fsdbDumpvarsByFile(dumpListFile_reg);
$fsdbDumpvarsByFile(dumpListFile_string, option_reg);

$fsdbLog

Description
Record a message to the specified message stream. Each message stream is
organized under a scope named "msg_root" in the FSDB file. For example:
msg_root
|--- status_stream

Linking Novas Files with Simulators and Enabling FSDB Dumping 45

FSDB Dumping Commands

|--- compare_result_stream

NOTE: To use $fsdbLog, two simulator compile options must be specified for
VCS. One is -debug_pp and the other is +cli+3. For example:
vcs -debug_pp +cli+3 -sverilog test.sv -P $tab
$pli

NOTE: $fsdbLog does not support the complex expression as the argument. If
users want to pass a complex expression to $fsdbLog, a variable can be
used to save the result and pass the expression to $fsdbLog. For
example:
$fsdbLog((stats_ctl ? "CTL" : "NCTL"),
"GMX",,"inb_stats", "val"); can be changed to
string label = (stats_ctl ? "CTL" : "NCTL");
$fsdbLog(label, "GMX",,"inb_stats", "val");

Syntax
$fsdbLog(["label"], ["message"], [severity], ["stream_name"]
[["format"]*, variables | "string"]* );

NOTE: $fsdbLog can only be specified inside the design.

NOTE: The comma (",") for each argument cannot be omitted even if the
argument is not specified. For example:
$fsdbLog( , , , , var1);

Arguments
label
Specify the label for the message in the string. This argument is optional
and can be empty. If a label is not specified, a default label "Unnamed
Label" will be given. If the label needs to be formatted, $psprintf can be
passed as the argument.
message
Specify the message in the string. This argument is optional and can be
empty. If this argument is empty, an empty message will be written to the
message attribute in the record of the message stream.
If the message needs to be formatted, $psprintf can be passed as the
argument. Format tokens, such as %d, %b, %h, in the message are not
currently supported. For example:
$fsdbLog("label", "var1=%d", 1, "stream1", var1);
Message is logged as "var1=%d" instead of "var1=3".

46 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

$fsdbLog("label", $psprintf("var1=%d", var1), 1, "stream1");

Message is logged as "var1=3".
$fsdbLog("label", "", "stream1", var1);
Message is logged as "".
severity
Specify the severity as a positive integer, negative integer, or empty.
Severity will be recorded as an attribute in the message record. When the
severity is empty, no severity attribute will be dumped. This argument is
optional and can be empty.
stream_name
Specify the stream name to be created if it does not already exist. If the
stream name needs to be formatted, $psprintf can be passed as the
argument. This argument is optional and can be empty. Below are two
examples.
Example 1
$fsdbLog called inside p.classAInst.funA.
The stream name will be assigned as "p_classAInst".
$fsdbLog called inside
p.classAInst.funB.classBInst.funC.funD.
The stream name will be assigned as "p_classAInst_classBInst".
Example 2
"\test.a.b.c* " or "test\.a\.b\.c\* "

Legal stream name rules are composed of 0-9, a-z, and A-Z. The '\' should
be added in the prefix when the name contains a special character.
Alternatively, the '\' can be added before each special character.

NOTE: Any of the first four arguments can be empty. However, the commas
between the empty arguments should be placed properly. For example:
$fsdbLog( , , , , var1);
or
$fsdbLog(, , , );
format
Specify whether the logged information with the specified radix will be
shown on nWave or nTA. If the radix is not specified, the logged information
will be displayed as the default format of the variable. The format is shown
below.
Supported format: format ::= %h, %x , %b, %d, %o, %A, ["str_name" |
str_var]

Linking Novas Files with Simulators and Enabling FSDB Dumping 47

FSDB Dumping Commands

%h ::=hexadecimal format
%x ::=hexadecimal format
%b ::=binary format
%d ::=decimal format
%o ::=octal format
%A ::=change the attribute name

NOTE: When the format "%A" is used, the next argument must be a string
value.
Example 1
program p;
class Foo1;
function new (int i);
...
$fsdbLog("label","message",1,...);
...
endclass
...
$fsdbLog("label","message",1,"stream_name","%h",info);
//specified radix with 'hexadecimal' format
...
$fsdbLog("label","message",2,"stream_name",info2);
...
endprogram

Example 2
int intVar = 255;
$fsdbLog("L", "M", 3, "S", intVar);

$fsdbLog("L", "M", 3, "S", "%A", "ConstStrName", intVar);

48 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

//specified radix with related format

$fsdbLog("L", "M", 3, "S", "%A", "ConstStrName", "%h",
intVar);

$fsdbLog("L", "M", 3, "S", "%h", "%A", "ConstStrName",

intVar);

variable
Specify the variable to log. An object with the vcsd_handle type can be
passed here; however, the variable type is limited to string, longint, time
integer, int, shortint, byte, logic, bit, reg, and real. In addition, an array
element can be passed if the type of the element is one of the supported
variable types listed above. For example, int i[0:1][0:3]; i[1][3] is allowed.
string
Specify a constant string to log. An attribute name for the constant string
will be automatically assigned.
Multiple string arguments are allowed. However, the total number of string
and variable arguments is limited to less than 1024.
Each string argument is added as an attribute to the message record:
attribute_name = value

where the attribute_name is automatically assigned. The first one is named

"Const_Msg0", and the second one is named "Const_Msg1". The value is
the string itself. For example:
virtual function cpu_word_queue_t pack();
pack.push_back(operation); // 8 bit field
if (mode != NoOperand) begin
pack.push_back(operand); // 8 bit field
end
$fsdbLog(

Linking Novas Files with Simulators and Enabling FSDB Dumping 49

FSDB Dumping Commands

//Label
$psprintf("About to pack %s",operation.name()),
//Message & severity
"cpu_word_queue_t",5,
//stream name
$psprintf("%m"),
//string #1
$psprintf("op=%x, operand=%x ",operation,operand),
//string #2
$psprintf("Mode=%s,Size=%d",mode.name(),pack.size()
));
...
endfunction: pack

Examples
Example 1
function void func(ref logic [2:0] gg);
if(gg==3'b101) begin
gg = 3'b111;
$fsdbLog("REF","changed","3","ref","gg",$bits(gg));
$display("[%0t]REF-changed-gg=%b",$time,gg);
end else
$fsdbLog("REF","unchanged",,"ref",gg);
$display("[%0t]REF-unchanged-gg=%b",$time,gg);
endfunction

Example 2
class c_type2;
rand int i;
endclass

class c_type1;
typedef enum reg [1:0] {ONE=1,TWO,THREE} number;
number num;
rand reg [1:0][1:0] r_mda1;
reg [1:0] mda1;
c_type2 c2 = new;
function void disp;
$fsdbLog("L1",
$psprintf("Time:[%0t] num=%d(%d)",$time,num,THREE),
1,
"",
num,
THREE,
"This is RAW string1",
$psprintf("%d",c2.randomize()),
$psprintf("%d",r_mda1),
mda1);
endfunction
endclass

50 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Limit FSDB Size

$fsdbAutoSwitchDumpfile

Description
Automatically switch to a new dump file when the working FSDB file reaches
the specified size limitation. The unit associated with
$fsdbAutoSwitchDumpfile's File_Size parameter is a megabyte. After the
dumping is finished, a virtual FSDB file will be automatically created and list all
of the generated FSDB files with the correct sequence. Only the virtual FSDB
file, rather than all of the FSDB files, needs to be loaded to view the simulation
results.

Syntax
When specified in the design:
$fsdbAutoSwitchDumpfile(File_Size | File_Size_var, "FSDB_Name" |
FSDB_Name_var, Number_of_Files | Number_of_Files_var
[ ,"log_filename" | ,log_filename_var ], ["+fsdb+no_overwrite"]);

When specified on the simulator command line:

Synopsys:
fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

Cadence:
call fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

ModelSim:
fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

Arguments
File_Size
The FSDB file size limit.

NOTE: The minimum file size of the FSDB file is 10M. If the size is set to less
than 10M, it will be set to 10M automatically.
File_Size_var

Linking Novas Files with Simulators and Enabling FSDB Dumping 51

FSDB Dumping Commands

Specify the FSDB file size in a variable.

NOTE: Valid only if the command is specified inside the design.

FSDB_Name
Specify the FSDB file generated by the Novas object files for FSDB
dumping.
FSDB_Name_var
Specify the FSDB file name in a variable.

NOTE: Valid only if the command is specified inside the design.

Number_of_Files
The maximum number of FSDB files to generate. When the +no_overwrite
option is also used, this option specifies the maximum number of FSDB
files to be dumped.

NOTE: If the number is set as 0, the dumper will create new FSDB files without
file number limitation.

52 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Number_of_Files_var
Specify the maximum number of FSDB files to generate in a variable.
When the +no_overwrite option is also used, the variable specifies the
maximum number of FSDB files to be dumped.

NOTE: Valid only if the command is specified inside the design.

Log_filename
This argument is optional. Specify the file name for the log file.
log_filename_var
Specify the log file name in a variable.

NOTE: Valid only if the command is specified inside the design.

+fsdb+no_overwrite
Stop dumping to the FSDB file when the file number restriction is reached.

NOTE: Specify the file number using the option Number_of_Files or

Number_of_Files_var before using this option.

The first FSDB file will be named as test_000.fsdb. The second FSDB file
test_001.fsdb will be created when the file size of test_000.fsdb reaches near
10MB. The third FSDB file test_002.fsdb will be created when the file size
of test_001.fsdb reaches near 10MB and so on. The first FSDB file
test_000.fsdb will be overwritten when the file size of test_019.fsdb reaches
near 10MB. The default test.log file will list the time range of each FSDB
file.
$fsdbAutoSwitchDumpfile(10, "test.fsdb", 20, "my.log");
$fsdbDumpvars(0, system);

The number and the maximum file size of the FSDB file are as the same as
the previous example, but the log file is set to my.log.

Linking Novas Files with Simulators and Enabling FSDB Dumping 53

FSDB Dumping Commands

Variable Example
If specified in the design, the design variable can be passed as a command
argument.
reg [255:0] File_Size_reg = 50;
reg [255:0] File_Size_reg1 = "50";
/* Not support number in string format */
string FSDB_Name _string = "FSDB_Name.fsdb";
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
reg [15:0] Number_of_Files_reg = 1000;
string log_filename_string = "fsdb.log";
reg [1023:0] FSDB_Name_reg = "FSDB_Name.fsdb";

$fsdbAutoSwitchDumpfile(50, "FSDB_Name", 1000, "fsdb.log");

$fsdbAutoSwitchDumpfile(File_Size_reg, FSDB_Name_string, 1000);
$fsdbAutoSwitchDumpfile(50, FSDB_Name_reg, Number_of_Files_reg,
log_filename_string);

$fsdbSuppress

Description
Specify the scopes that will not be dumped by the $fsdbDumpvars,
$fsdbDumpvarsByFile, or $fsdbDumpMDA commands. $fsdbSuppress supports
suppressing by file name or the target scopes passed as arguments. The supported
target scope could be modules, instances, scopes, or signals in full hierarchical
format. Each format has to be called in different $fsdbSuppress calls.

NOTE: $fsdbSuppress must be specified before $fsdbDumpvars,

$fsdbDumpvarsByFile, $fsdbDumpMDA; otherwise, $fsdbSuppress
will not work.

NOTE: The setting of $fsdbSuppress will be reset after $fsdbDumpFinish is

executed.

$fsdbSuppress("suppress_file");
$fsdbSuppress(instance[,instance]*);
$fsdbSuppress("instance=",instance_var[,instance_var]*);
$fsdbSuppress("file=", file_var);
$fsdbSuppress("module_file=","filename");
$fsdbSuppress("module_base=","module_name"[,"module_name"]*);

54 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

$fsdbSuppress("signal_prefix=");

NOTE: If the variable field options are used, the variable must be assigned
before being called.
When specified on simulator command line:
Synopsys:
fsdbSuppress "suppress_file"
fsdbSuppress instance [instance]*

Cadence:
call fsdbSuppress "suppress_file"
call fsdbSuppress instance [instance]*

ModelSim:
fsdbSuppress "suppress_file"
fsdbSuppress instance [instance]*

Arguments
suppress_file
Specify the file containing the names of the scopes that will not be dumped.

NOTE: For the suppress file format, each line of the file is the full name of a
scope that you do not want to be dumped.
instance
Specify one or more scopes or signals that will not be dumped.
file=
Keyword to identify the next argument is a string.

NOTE: Valid only if the command is specified inside the design.

file_var
Specify the suppress file name in a variable.

NOTE: Valid only if the command is specified inside the design.

"instance="
Keyword to identify the content of the next argument is a module scope or
signal.

NOTE: Valid only if the command is specified inside the design.

Linking Novas Files with Simulators and Enabling FSDB Dumping 55

FSDB Dumping Commands

instance_var
Gives the module scope or signal represented by instance_var that specifies
the object to dump.

NOTE: The option, "instance=" is needed only if providing a full hierarchical

scope (or signal) in variable format. For those requirements of scope in
explicitly plain string format, pass them as an argument, no "instance="
option needed.
"module_file="
Keyword to identify the content of the next argument is a string.
"filename"
Specify the file containing the names of the modules that will not be
dumped.
"module_base="
Keyword to identify the content of the next argument(s) is a module.
"module_name"
Specify the module from which the instantiated scopes will not be dumped.

NOTE: All supported suppression methods should be used separately for each
$fsdbSuppress called; multiple suppression types cannot be combined
in one $fsdbSuppress command.
"signal_prefix="
Specify the prefix pattern. Signals that match this pattern will not be
dumped.

$fsdbSuppress("./suppress.lst");

where suppress.list contains:

[suppress.lst]
system.R_W
system.i_cpu.C0
system.i_cpu.C1
system.i_cpu.C5

56 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

system.i_cpu.C6
...

NOTE: The scopes to suppress, passed as task parameters or listed in the

suppression list, support both instance and module format.
Variable Example
Specified in the design, the runtime variable can be passed as an argument.
...
reg [1023:0] suppressFile_reg = "suppress.list";
reg [1023:0] suppressFile_reg = "suppress.list"; // reg string
string suppressFile_string = "suppress.list";
string instance_string = "scope_a";
reg [1023:0] instance_reg = "scope_b";
...

$fsdbSuppress("suppress.list");
$fsdbSuppress(top.u1.u2);
$fsdbSuppress(top.u1.u2, top.x1.x2);
$fsdbSuppress("file=", suppressFile_reg);
$fsdbSuppress("file=", suppressFile_string);
//full hierarchy variable.
$fsdbsuppress("instance=", instance_string, instance_reg);
$fsdbSuppress("file=", suppressFile_string); // list file
variable
$fsdbSuppress("module_file=", "suppress_module.list");
$fsdbSuppress("module_base=", "module_1", "module_2",
"module_3");
$fsdbSuppress("signal_prefix=", "_zy", "_zz", "zz_", "zy_");

$fsdbSwitchDumpfile

Description
Support multiple FSDB files during a simulation run by specifying the currently
active FSDB file name. When this command is executed, the previously opened
FSDB file is closed and the new FSDB file is created to continue saving the
values change data and act as the current active FSDB file.
Since the FSDB dumper may support more then one open file for saving data
simultaneously, the source file that is supposed to be switched can be specified
by the option "+fsdbfile+sourcefilename", otherwise the source file would be the
currently active FSDB file.

Syntax
When specified in the design:

Linking Novas Files with Simulators and Enabling FSDB Dumping 57

FSDB Dumping Commands

$fsdbSwitchDumpfile("NewFileName" | NewFileName_var
[ ,"+fsdbfile+src_file"| ,src_file_var ]*);

When specified on the simulator command line:

Synopsys:
fsdbSwitchDumpfile "NewFileName"
fsdbSwitchDumpfile "NewFileName" +fsdbfile+src_file

Cadence:
call fsdbSwitchDumpfile "NewFileName"
call fsdbSwitchDumpfile "NewFileName" "+fsdbfile+src_file"

ModelSim:
fsdbSwitchDumpfile "NewFileName"
fsdbSwitchDumpfile "NewFileName" "+fsdbfile+src_file"

Arguments
NewFileName
The new name of the FSDB file generated by the Novas object files for
FSDB dumping.
NewFileName_var
Specify the new FSDB file name in a variable.

NOTE: Valid only if the command is specified inside the design.

+fsdbfile+src_file
Specify the source FSDB file to be switched (include the .fsdb file extension
in the name). This is optional; if not specified, the FSDB dumper will
switch dump finish on all active FSDB files.
src_file_var
Specify the FSDB source file option in a variable.

NOTE: Valid only if the command is specified inside the design.

58 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

#1000
$fsdbSwitchDumpfile("test1.fsdb", "+fsdbfile+test0.fsdb");
#1000
$fsdbSwitchDumpfile("test2.fsdb", "+fsdbfile+f1.fsdb");

Create test0.fsdb to dump the design initially. Create f1.fsdb to dump a

different depth of design. Switch test0.fsdb to test1.fsdb at simulation time
1000. Then switch f1.fsdb to test2.fsdb at simulation time 2000.
Example 2
If specified in the design, the design variable can be passed as a command
argument.
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
string newDumpfile_string = "novas_new.fsdb";
reg [1023:0] newDumpfile_reg = "novas_new.fsdb";

$fsdbSwitchDumpfile("novas_new.fsdb");
/* switch current file to novas_new.fsdb */

$fsdbSwitchDumpfile(newDumpfile_reg, "+fsdbfile+novas.fsdb");
/* switch novas.fsdb file to be novas_new.fsdb */

$fsdbSwitchDumpfile(newDumpfile_string, option_reg);
/* switch novas.fsdb to novas_new.fsdb */

Memory/MDA Dumping Command

$fsdbDumpMDA

Description
Dump value changes of MDA (multidimensional array) signals to the FSDB file.
All memories and MDAs within the specified instance are dumped. In addition,
partial range dumping of a specific MDA instance's value change data into the
FSDB file is supported.

NOTE:
1. For VCS users, to include memory, MDA, packed array, and
structure information in the generated FSDB file, the VCS option
-debug_pp is required when VCS is invoked to compile the design.
2. The generated FSDB can be converted to VCD which will include
the MDA and structure data.

Syntax
When specified in the design:

Linking Novas Files with Simulators and Enabling FSDB Dumping 59

FSDB Dumping Commands

$fsdbDumpMDA([ depth, | "level=",depth_var, ]

[instance | "instance=", instance_var ]
[ ,"option" | ,"option=",option_var ]*);

$fsdbDumpMDA( mda_instance [, 1st_dim_begin_index [, 1st_dim_size

[, 2nd_dim_begin_index [, 2nd_dim_size
...]]]]);

$fsdbDumpMDA ("mda_instance=", mda_instance_var,

[, "begin_index=", 1st_dim_begin_index
[, "dim_size=", 1st_dim_size
[, "begin_index=", 2nd_dim_begin_index
[, "dim_size=", 2nd_dim_size...]]]]);

When specified on the simulator command line:

Synopsys:
fsdbDumpMDA
fsdbDumpMDA [depth] [instance] ["option"]*
or
fsdbDumpMDA mda_instance [1st_dim_begin_index [1st_dim_size
[2nd_dim_begin_index [2nd_dim_size
...]]]]

Cadence:
call fsdbDumpMDA [instance] ["option"]*
call fsdbDumpMDA [depth] [instance]
or
call fsdbDumpMDA mda_instance [1st_dim_begin_index [1st_dim_size
[2nd_dim_begin_index [2nd_dim_size
...]]]]

Modelsim:
fsdbDumpMDA
fsdbDumpMDA [depth] [instance] ["option"]*
or
fsdbDumpMDA mda_instance [1st_dim_begin_index [1st_dim_size
[2nd_dim_begin_index [2nd_dim_size
...]]]]

Arguments
depth
Specify how many levels of hierarchy to dump for the subsequent scopes.

60 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

"level="
Keyword to identify the next argument is a number.

NOTE: Valid only if the command is specified inside the design.

depth_var
Specify how many levels of hierarchy to dump for the subsequent scopes in
a variable.

NOTE: Valid only if the command is specified inside the design.

instance
Give the module scope or signal that contains the MDA objects to dump.
"instance="
Keyword to identify the content of the next argument is a module scope or
signal.
instance_var
Give the module scope or signal represented by instance_var that specifies
the object to dump.
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".
Enable/Disable dumping of cell instance where mode
means:
"+skip_cell_instance=mode" 0: Disable functionality.
1 or 2: Skip all cell information.
Others: Show error message and ignore it.

Supported MDA Format Table

Unpacked 1D Unpacked 2D Packed 1D Packed 2D

e.g. T a[ ]; e.g. T a[ ][ ]; e.g. T [ ]a; e.g. T [ ][ ]a;
Yes Yes No Yes

"option="
Keyword to identify the next argument is a string.

NOTE: Valid only if the command is specified inside the design.

option_var

Linking Novas Files with Simulators and Enabling FSDB Dumping 61

FSDB Dumping Commands

Specify the option in a variable.

NOTE: Valid only if the command is specified inside the design.

mda_instance
The target MDA instance to select ranges from.
Nth_dim_begin_index
The beginning index number of the Nth dimension.
Nth_dim_size
The size of the Nth dimension to dump.

NOTE: Partially selecting MDA's dimensions is valid for SystemVerilog MDA

statements only. It will not be valid if used by the VHDL procedure call,
fsdbDumpMDA.

Dump value changes of MDA (multidimensional array) signals to the FSDB file:

Dumping Command Dumping Result

$fsdbDumpMDA(screen); Dump all cells of MDA screen.
$fsdbDumpMDA(screen, 10); Dump screen[10:10][0:24][7:0]
$fsdbDumpMDA(screen, 10, 1); Dump screen[10:10][0:24][7:0]
$fsdbDumpMDA(screen, 10, 1, 12); Dump screen[10:10][12:12][7:0]
$fsdbDumpMDA(screen, 10, 1, 12,
Dump screen[10:10][12:13][7:0]
2);
$fsdbDumpMDA(screen, 10, 1, 12, 2, The packed dimension is not
7); supported.
$fsdbDumpMDA(screen, 10, 1, 12, 2, The packed dimension is not
7, 3); supported.

$fsdbDumpMDA(system);
Dump all memories and MDAs under the system scope and its child scopes.

62 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

$fsdbDumpMDA(1, system.i_pram);
Dump all memories and MDAs under the system.pram scope.
$fsdbDumpMDA(0, top, "+skip_cell_instance=1",
"+fsdbfile+dump.fsdb");
Dump all memories and MDAs under top scope and skip cell instance.
Variable Example
If specified in the design, the design variable can be passed as an argument.
reg [255:0] depth_reg = 10;
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
string option_string = "+fsdbfile+novas.fsdb";
string depth_string = "10";// invalid, number in string format
reg [32*8-1:0] depth_str_reg = "10"; // invalid.
reg [1023:0] instance_reg = "top";

$fsdbDumpMDA(1, top, "+fsdbfile+novas.fsdb");

$fsdbDumpMDA("level=", depth_reg, "option=", option_string);
$fsdbDumpMDA("level=", depth_reg, top, "option=", option_reg);
$fsdbDumpMDA("instance=", instance_reg);

$fsdbDumpMDAByFile

Description
Dump the value changes of MDA (multidimensional array) signals in a text file
to a designated FSDB file. $fsdbDumpMDAByFile can be invoked more than
once to dump several scopes/signals defined in different text files to specific
FSDB files. There are two schemes to specify designated FSDB files:
1. No FSDB file name specified in $fsdbDumpMDAByFile (only one
argument needed). If no FSDB file is specified, the default file, novas.fsdb,
or the previously specified one will be taken as the default.
2. Specify the FSDB file name in $fsdbDumpMDAByFile (two arguments
needed). The argument "+fsdbfile+filename.fsdb" can be used to specify the
designated FSDB file.

Syntax
When specified in the design:
$fsdbDumpMDAByFile ("textFileName" | textfile_var [,"option"
|,option_var ]);

$fsdbDumpMDAByFile("textFileName");
$fsdbDumpMDAByFile("textFileName", "option");

When specified on the simulator command line:

Linking Novas Files with Simulators and Enabling FSDB Dumping 63

FSDB Dumping Commands

Synopsys:
fsdbDumpMDAByFile "textFileName" [option]

Cadence:
call fsdbDumpMDAByFile "textFileName" [option]

ModelSim:
fsdbDumpMDAByFile "textFileName" [option]

Arguments
"textFileName"
Specify the name of the text file containing the scopes to dump (in plain text
format).
textfile_var
Specify the text file name in a variable.

NOTE: Valid only if the command is specified inside the design.

option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".

Supported MDA Format Table

Unpacked 1D Unpacked 2D Packed 1D Packed 2D

e.g. T a[ ]; e.g. T a[ ][ ]; e.g. T [ ]a; e.g. T [ ][ ]a;
Yes Yes No Yes

option_var
Specify the FSDB file name option in a variable.

NOTE: Valid only if the command is specified inside the design.

File Format of the Text File

# comment
# Specify the scope instance:
[option_in_file] [depth] instance
# Specify the MDA variable:
[option_in_file] mda_variable [1st_dim_begin_idx
[1st_dim_size [2st_dim_begin_idx [2st_dim_size]]]]

64 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Similar to $fsdbDumpMDA, the option in the following table is for the text
file only. It can only be specified in the [option_in_file] location of
the "textfile". For example:
+skip_cell_instance=0 1 system
system.i_cpu

Enable/Disable dumping of cell instance where mode

means:
0: disable functionality.
"+skip_cell_instance=mode"
1: Skip all cell info.
2: Dump all ports of cell instance.
Others: Show error message and ignore it.

Examples
NOTE: The following example uses the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
fsdbDumpMDAByFile("./case1.lst","+fsdbfile+case1.fsdb");
where case1.lst contains:
[case1.lst]
Specify the scope instance:
0 top.type_dut.regInst
0 top.type_dut.parameterInst
5 top.type_dut.FunAndTaskInst
+skip_cell_instance=0 0 top.type_dut.tri0Inst
+skip_cell_instance=1 0 top.type_dut.tri1Inst
+skip_cell_instance=2 0 top.type_dut.triInst
3 top.type_dut.enumInst
3 top.type_dut.logicInst
top.type_dut.pstructInst

Specify the MDA variable:

top.type_dut.mdaInst 0
top.type_dut.mdaInst 0 1 0 2
top.type_dut.mdaInst 0 1 0 2 0 1
+skip_cell_instance=0 top.type_dut.mdaInst 0
+skip_cell_instance=1 top.type_dut.mdaInst 0 1 0 2

Variable Example
Specified in the design, the runtime variable can be passed as an argument.
...
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";

Linking Novas Files with Simulators and Enabling FSDB Dumping 65

FSDB Dumping Commands

reg [1023:0] suppressFile_reg = "suppress.list"; // reg string

string dumpListFile_string = "dump.list";//string
...

fsdbDumpMDAByFile("dump.list", "+fsdbfile+novas.fsdb");
fsdbDumpMDAByFile(dumpListFile_reg);
fsdbDumpMDAByFile(dumpListFile_string, option_reg);

Assertion Dumping Command

$fsdbDumpSVA

Description
Dump SVA results to the FSDB file. The results of SVA assertions within the
specified scopes and/or modules can be dumped and saved to the same FSDB file
that contains dumped results for design signals or to a separate file.

Syntax
When specified in the design:
$fsdbDumpSVA([ depth, | "level=",depth_var, ]
[instance | "instance=", instance_var ]
[ ,"option" | ,"option=",option_var ]*);

$fsdbDumpSVA;
$fsdbDumpSVA([depth] [, instance] [, "option"]*

When specified on the simulator command line:

Synopsys:
fsdbDumpSVA [depth] [instance] ["option"]*

Cadence:
call fsdbDumpSVA [depth] [instance] ["option"]*

Modelsim:
fsdbDumpSVA
fsdbDumpSVA [depth] [instance] ["option"]*

Arguments
depth
Specify the levels of hierarchy to dump for the subsequent scopes.

66 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

"level="
Keyword to identify the next argument is a number.

NOTE: Valid only if the command is specified inside the design.

depth_var
Specify how many levels of hierarchy to dump for the subsequent scopes in
a variable.

NOTE: Valid only if the command is specified inside the design.

instance
Specify the instance name for which all SVA assertions below it will be
dumped.
"instance="
Keyword to identify the content of the next argument is a module scope or
signal.
instance_var
This definition gives the module scope or signal represented by
instance_var that specifies the object to dump.
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".
Enable dumping the SVA in functions in the design.
"+functions"
Example: $fsdbDumpSVA("functions");
+fsdb+sva_success Specify at runtime to dump the successful assertion.
Enable/Disable dumping of cell instance where mode
means:
"+skip_cell_instance=mode" 0: Disable functionality.
1 or 2: Skip all cell information.
Others: Show error message and ignore it.

"option="
Keyword to identify the next argument is a string.

NOTE: Valid only if the command is specified inside the design.

option_var

Linking Novas Files with Simulators and Enabling FSDB Dumping 67

FSDB Dumping Commands

Specify the option in a variable.

NOTE: Valid only if the command is specified inside the design.

Examples
NOTE: The following examples use the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
initial begin
$fsdbDumpvars("+fsdbfile+1.fsdb");
$fsdbDumpSVA("+fsdbfile+1.fsdb");
$fsdbDumpSVA("+fsdb+sva_success","+fsdbfile+fsdb+sva_success");
#40 $fsdbDumpoff;
#40 $fsdbDumpon;
#10 $fsdbDumpFinish;
#30 $fsdbDumpfile("2.fsdb");
$fsdbDumpSVA(1,top); //dump sva to 2.fsdb
#43 $finish;
end

$fsdbDumpSVA;
Dump all SVA assertions from design top and its descendents.
$fsdbDumpSVA(0, system);
Dump all SVA assertions under system and its descendents
$fsdbDumpSVA(1, system.arbiter);
Dump all SVA assertions under system.arbiter. The dumping level is set to
1, so dumping will exclude the SVA assertions under their descendent
scopes.
$fsdbDumpvarsByFile("scope_lst.txt", "+fsdbfile=hdl.fsdb");
$fsdbDumpSVA(system.arbiter, "+fsdbfile=SVA.fsdb");

68 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

The first dumping command dumps design signals to the hdl.fsdb file. The
second dumping command dumps all SVA assertions under system.arbiter
scope and its descendents to the SVA.fsdb file.

NOTE: For VCS users, the -sverilog and -debug_pp command line options are
necessary to dump SVA signals.

NOTE: For ModelSim users, the -sva and -assertdebug options should be
specified in the vsim command line options when dumping assertions.
For example,
> vsim -c top -pli novas_fli.so -sva -assertdebug

NOTE: To dump vacuous successes correctly with VCS 2014.03 and later
versions, specify the -assert vacuous option when calling the VCS
executable.
The following is a code example for a vacuous success:
property P5;
@(posedge clk)
disable iff (rst)
(c) |=> (##[0:$] d);
endproperty : P5
Variable Example
If specified in the design, the design variable can be passed as an argument.
reg [255:0] depth_reg = 10;
reg [32*8-1:0] option_reg = "+fsdbfile+novas.fsdb";
string option_string = "+fsdbfile+novas.fsdb";
string depth_string = "10";// invalid, number in string format
reg [32*8-1:0] depth_str_reg = "10"; // invalid.
string instance_string = "top";

$fsdbDumpSVA(1, top, "+fsdbfile+novas.fsdb");

$fsdbDumpSVA(1, "option=", option_reg);
$fsdbDumpSVA(top, "option=", option_string);
$fsdbDumpSVA("level=", depth_reg, "+fsdbfile+novas.fsdb");
$fsdbDumpSVA("instance=", instance_string, "option=",
option_reg);

NOTE:
1. Immediate assertion (e.g. A1: assert(...) ...else $error, A2 assert
finial(....)) will be dumped in FSDB dumper only for VCS simulators.
2. Sequence (e.g. sequence .... endsequence) and property
(property...endproperty) won't be dumped in FSDB dumper.

Linking Novas Files with Simulators and Enabling FSDB Dumping 69

FSDB Dumping Commands

$fsdbDumpPSL

Description
Dump the PSL assert directives in the Verilog or VHDL design to the FSDB file.

NOTE: This command supports the dumper for IUS 13.1, VCS 2014.03,
ModelSim 10.2, and their later versions.

NOTE: If the IUS simulator is used, the +psl_prop option needs to be in order
to dump the PSL properties in the Verilog or VHDL design. This option
is not required to be specified in the VCS simulator.

Syntax
$fsdbDumpPSL([ depth, | “level=”,depth_var, ]
[instance | “instance=”,instance_var]);
[ ,”option” | ,”option=”,option_var ]*);

Arguments
depth
Specify the levels of hierarchy to dump for the subsequent scopes. If the
subsequent arguments are signals, only these signals will be dumped.

70 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

"level="
Keyword to identify the next argument is a number.

NOTE: Valid only if the command is specified inside the design.

depth_var
Specify how many levels of hierarchy to dump for the subsequent scopes in
a variable.

NOTE: Valid only if the command is specified inside the design.

instance
Specify the instance name for which all SVA assertions below it will be
dumped.
"instance="
Keyword to identify the content of the next argument is a module scope or
signal.
instance_var
This definition gives the module scope or signal represented by the
instance_var that specifies the object to dump. The HDL type should be
string.
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".
+psl_prop Dump the PSL properties.

"option="
Keyword to identify the next argument is a string.

NOTE: Valid only if the command is specified inside the design.

option_var
Specify the option in a variable.

NOTE: Valid only if the command is specified inside the design.

Linking Novas Files with Simulators and Enabling FSDB Dumping 71

FSDB Dumping Commands

Supported Directive and Verification Unit Types

The $fsdbDumpPSL command supports dumping for some directive and
verification units.
Table: Supported Directive Types

Directive Type Support Status (Yes/No)

assert Yes

assume Yes

cover Yes

assume_guarantee No

restrict_guarantee No

fairness No

strong_fairness No

No
NOTE:
restrict The restrict directive will not be dumped. When the
+psl_prop option is specified, the property under the
restrict directive will be created.

The $fsdbDumpPSL command supports dumping for the following verification

unit types:
• vunit
• vprop
• vmode

Examples
# inline
Assume that the file name is case.v:
module top;
reg clk = 0;
always #1 clk = ~clk;
//psl property p1 = {clk==1;clk==0} @(posedge clk); ---(A)
//psl assert always {clk==1;clk==0} @(posedge clk); ---(B)
endmodule

By default, (B) will be dumped. If the “+fsdb+psl_prop” option is specified, (A)

will also be dumped.

72 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

# vunit / vprop / vmode

Assume that the file name is case.v.
module top;
reg clk = 0;
always #1 clk = ~clk;
endmodule

Assume that the file name is casevunit.v and this file can only be loaded and
compiled with the option:
vunit v1 (top) {
default clock = @(posedge top.clk);
property p2 = {clk==1;clk==0} @(posedge clk); ---(C)
assert always {clk==1;clk==0}; ---(D)
}
By default, (D) will be dumped. If the “+fsdb+psl_prop” option is specified, (C)
will also be dumped.

Extra Scope Creation

An extra scope will be created when binding the verification unit with the
instance, for example:
File: unit.v
vunit VUNIT_NAME(top.sub_Inst){
…
}
File: top.v
module top;
…
sub sub_Inst();
endmodule

module sub;
…
endmodule

In this case, an extra scope named “VUNIT_NAME” is created under

top.sub_Inst. The same result will be obtained in vprop and vmode.

Naming Rules
When naming the design, the following rules should be followed:
• assert/assume/cover should be keywords when naming the design. For
example:
• top.A1_$assert // (This is an assert.)
• top.6_case302_v_cover // (This is a cover.)

Linking Novas Files with Simulators and Enabling FSDB Dumping 73

FSDB Dumping Commands

• The restrict directive will not be dumped. When the +psl_prop option is
specified, the property under the restrict directive will be created.
• The cover directive does not have an underlying property.
# Unnamed Assertion
[case1]
module top;
reg clk =0;
reg chk = 1;
always #1 clk = ~clk;

//psl property p1 = {clk} @(posedge clk);

//psl assert always {clk} @(posedge clk);

initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is:

top.7_case302_v_assert.

If the +psl_prop option is specified, the dumping result is:

top.7_case302_v_assert
top.p1

[case2]
module top;
reg clk =0;
reg chk = 1;
always #1 clk = ~clk;

//psl property p1 = {clk} @(posedge clk);

//psl assert always p1;

initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is:

top.7_case302_v_assert

If the +psl_prop option is specified, the dumping result is:

top.7_case302_v_assert
top.p1

# Named Assertion

74 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

[case1]
module top;
reg clk =0;
reg chk = 1;
always #1 clk = ~clk;

//psl property p1 = {clk} @(posedge clk);

//psl A1: assert always {clk} @(posedge clk);

initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is:

top.A1_$assert
top.A1 // (This module has the same value change as
top.A1_$assert.)

If the +psl_prop option is specified, the dumping result is:

top.A1_$assert
top.A1
top.p1

[case2]
module top;
reg clk =0;
reg chk = 1;
always #1 clk = ~clk;

//psl property p1 = {clk} @(posedge clk);

//psl A1: assert always p1;
8
initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is:

top.A1_$assert
top.A1

If the +psl_prop option is specified, the dumping result is:

top.A1_$assert
top.A1
top.p1

# Unnamed Restrict
module top;
reg clk =0;

Linking Novas Files with Simulators and Enabling FSDB Dumping 75

FSDB Dumping Commands

reg chk = 1;
always #1 clk = ~clk;

//psl restrict {clk} @(posedge clk);

initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is: none.
If the +psl_prop option is specified, the dumping result is:
top.__restrict1

# Named Restrict
module top;
reg clk =0;
reg chk = 1;
always #1 clk = ~clk;

//psl R1: restrict {clk} @(posedge clk);

initial begin
$fsdbDumpPSL;

If the +psl_prop option is not specified, the dumping result is: none.
If the +psl_prop option is specified, the dumping result is:
top.R1

Compilation Tips
The "-assert" option should be specified for PSL execution.
> irun –assert design_files -propfile_vlog vlog_vunit_file
-propfile_vhdl vhdl_vunit_file …
Bind the vunit in the irun command line.

> ncvlog … -assert -propfile vlog_vunit_file

Bind the vunit in the ncvlog command line.

> ncvhdl … -assert -propfile vhdl_vunit_file

Bind the vunit in the ncvhdl command line.

76 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

FSDB Dumping Commands Used in VHDL

The Novas object files for FSDB dumping provide the following FSDB dumping
commands for VHDL.
fsdbAutoSwitchDumpfile
fsdbDumpfile
fsdbDumpflush
fsdbDumpon, fsdbDumpoff
fsdbDumpvars
fsdbDumpvarsByFile
fsdbDumpvarsES
fsdbDumpFinish
fsdbDumpMDA
fsdbDumpSVA
fsdbDumpVariable
fsdbDumpVariableByFile
fsdbSuppress
fsdbSwitchDumpfile

Supported Simulators for VHDL FSDB Dumping

Commands
The following table illustrates the supported simulator version for each FSDB
dumping command.

VHDL Command IUS 13.1 and VCSMX 2014.03 and ModelSim 10.2 and
Name later later later
fsdbAutoSwitchDump
x x x
file
fsdbDumpfile x x x
fsdbDumpflush x x x
fsdbDumpoff x x x
fsdbDumpon x x x
fsdbDumpvars x x x
fsdbDumpvarsByFile x x x
fsdbDumpvarsES x x x
fsdbDumpFinish x x x
fsdbDumpMDA* x* x* x*

Linking Novas Files with Simulators and Enabling FSDB Dumping 77

FSDB Dumping Commands

fsdbDumpSVA x x x
fsdbDumpVariable x
fsdbDumpVariableBy
x
File
fsdbSuppress x x x
fsdbSwitchDumpfile x x x

*fsdbDumpMDA supports Verilog/SystemVerilog memory or MDA

(multi-dimensional array) statements only.

General Dumping Commands

fsdbDumpvars

Description
Dump signals under the specified scopes with the arguments instance and depth.
The signals are saved in the FSDB file created by fsdbDumpfile or the
+fsdbfile+filename option. If an FSDB file name is not specified, novas.fsdb will
be taken as the default.

Syntax
When specified in the design:
fsdbDumpvars(depth, “instance”[,“option,*”]);

When specified on the simulator command line:

Synopsys:
When specified on the VCS MX UCLI command prompt.
fsdbDumpvars [depth] [instance] [option]*

Cadence:
call fsdbDumpvars
call fsdbDumpvars [depth][instance][option]*

Modelsim:
fsdbDumpvars
fsdbDumpvars [depth] [instance]

NOTE: For users of VCS, if there is a Verilog top, use the syntax from the
Verilog section.

78 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Arguments
depth
Specify how many sub-scope levels under the given scope you want to
dump. Specify this argument as 1 to dump the signals under the given
scope. Specify this argument as 0 to dump all signals under the given scope
and its descendant scopes.
instance
Specify the full path name of the scope you want to dump. The different
simulators have different naming rules for describing the full path name of a
scope. You can refer to the simulator documents for complete details.
Assume the VHDL root scope is root_scope, scope1 is the child scope
under root_scope, and scope2 is the child scope under scope1. In IUS, the
full path name of a scope is :scope1:scope2. The left-most colon indicates
the root scope and the other colons are used to separate the scope name. In
ModelSim, the full path name of a scope can be either
root_scope.scope1.scope2 or /root_scope/scope1/scope2. In VCS MX, the
full path name of a scope is:root_scope:scope1:scope2, the left-most colon
can be ignored.
option
Specify one or more of the following options.

"+IO_Only" Only IO port signals will be dumped.

Enable dumping of functions in the design.
"+functions"
Example: $fsdbDumpvars("+functions");
"+Reg_Only" Only reg type signals will be dumped.
Dump all memory and MDA signals in all scopes specified in
fsdbDumpvars or the entire design if no scope is specified.
"+mda" This option is covered by the "+all" option and is effective for
SystemVerilog's MDAs only. For VCS users, the VCS option
"+memcbk" may be needed while compiling the design.
Only dump the packed signals in the design (without array and
memory types). Refer to the Supported MDA Format Table for
a summary of which packed or unpacked one-dimensional/
"+packedmda" two-dimensional signals are dumped with or without the
+packedmda and +mda options.
Example: $fsdbDumpvars("+packedmda");
NOTE: This option replaces the +mda+packedOnly option.
Dump the struct or the struct in packed MDA.
+packedmda+struct
Example: $fsdbDumpvars("+packedmda+struct ");

Linking Novas Files with Simulators and Enabling FSDB Dumping 79

FSDB Dumping Commands

Dump all structs in all scopes specified in fsdbDumpvars or in

the entire design if no scope is specified. This option is covered
"+struct"
by the "+all" option and is effective for SystemVerilog struct
syntax only.
Enable/Disable dumping of cell instance where mode means:
0: disable functionality.
"+skip_cell_instance
1: Skip all cell info.
=mode"
2: Dump all ports of cell instance.
Others: Show error message and ignore it.
"+strength" Enable strength dumping.
Dump all signals including the memory, MDA, packed array,
structure, union and packed structure signals in all scopes
specified in fsdbDumpvars or the entire design if no scope is
"+all"
specified.
For VCS users, the VCS option "+memcbk" may be needed
when compiling the design.
Dump parameters.
"+parameter" NOTE: If the parameter type of Verilog is “scalar”, “real”, or
“string”, the name will be displayed without range information.
"+trace_process" Dump VHDL processes.
Specify the FSDB file name.
"+fsdbfile+filename"
If not specified, the default FSDB file name is "novas.fsdb".

Supported MDA Format Table

Unpacked 1D Unpacked 2D Packed 1D Packed 2D

Options
e.g. T a[ ]; e.g. T a[ ][ ]; e.g. T [ ]a; e.g. T [ ][ ]a;

None Yes

"+packedmda" Yes Yes

"+mda" Yes Yes Yes Yes

NOTE: For VCS and IUS users, to allow fsdbDumpvars to dump the variables
under the processes and the shared variables under the region scopes by
default, you can use one of the following methods:
- Add the task option “+traces_process” when fsdbDumpvars is
specified in the design. For example:
fsdbDumpvars(0, “:”, “+trace_process”);
- Specify the plus option +fsdb+trace_process while running “ncsim”
or “simv”. For example:
> ncsim work.system:BLK +fsdb+trace_process -tcl
> simv system +fsdb+trace_process

80 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

- Set the system environment variable

NOVAS_FSDB_TRACE_PROCESS to a non-zero value before run the
simulation. For example:
> setenv NOVAS_FSDB_TRACE_PROCESS 1
> ncsim work.system:BLK -tcl

For ModelSim users, you can use fsdbDumpVariable to dump variables.

For VCS users, the VCS debug level option needs to be set as
"-debug_all" for dumping variables under VHDL process.

Examples
NOTE: The following examples use the syntax for calling the command in the
design. Refer to the syntax section for the correct format for the
simulator command line.
In IUS
fsdbDumpvars(0,":");
Dump all signals under all scopes of a design.
fsdbDumpvars(1,":i_CPU");
Only dump the signals under the scope i_CPU that is a child scope under the
root scope.
fsdbDumpvars(0,":",”+fsdbfile+test.fsdb,+mda”);
Dump all signals under all scopes to the specified FSDB file, “test.fsdb”. If
the design contains SystemVerilog code, also dump MDA signals within the
SystemVerilog code under all scopes to the FSDB file.

NOTE: Use a comma to separate options and leave no space between options.
A colon ":" is suggested for use in the hierarchy expression under a
VHDL top design scenario (mixed).
In ModelSim
fsdbDumpvars(0,"/system");
Dump all signals under the root scope system and its descendant scopes.
fsdbDumpvars(1,"/system/i_CPU");
Only dump the signals under the scope i_CPU that is a child scope under the
root scope system.
fsdbDumpvars(0,"/system",”+trace_process,+fsdbfile+test.fsdb”);
Dump all signals under the root scope to the specified FSDB file,
“test.fsdb”. If the design contains SystemVerilog code, also dump all

Linking Novas Files with Simulators and Enabling FSDB Dumping 81

FSDB Dumping Commands

processes within the SystemVerilog code under the root scope to the FSDB
file.

NOTE: Use a comma to separate options and leave no space between options.
A slash "/" or dot "." is suggested for use in the hierarchy expression
under a VHDL top design scenario (mixed or pure VHDL).
In VCS MX
fsdbDumpvars(0,":system");
Dump all signals under the root scope system and its descendant scopes.
fsdbDumpvars(1,":system:i_CPU");
Only dump the signals under the scope i_CPU that is a child scope under the
root scope system.
fsdbDumpvars(0,":system",”+trace_process,+fsdbfile+test.fsdb”);
Dump all signals under system scope and all variables under VHDL
processes to the specified FSDB file, “test.fsdb”.
fsdbDumpvars("+fsdbfile+my.fsdb")
Dump all signals under system scope to the specified FSDB file, "my.fsdb".

NOTE: Use a comma to separate options and leave no space between options.
A colon ":" is suggested for use in the hierarchy expression under a
VHDL top design scenario (mixed or pure VHDL).
The following examples are for mixed-HDL designs. Assume vlog_inst# is the
Verilog scope name and vhdl_ent# is the VHDL scope name. The design
hierarchies of 2 theoretical mixed-HDL designs are:
1.
vhdl_top --+-- vhdl_ent1 --+-- vhdl_ent2
| |
| +-- vlog_inst2
|
+-- vlog_inst1 -+-- vhdl_ent3
|
+-- vlog_inst3
2.
vlog_top --+-- vhdl_ent1 --+-- vhdl_ent2
| |
| +-- vlog_inst2
|
+-- vlog_inst1 -+-- vhdl_ent3
|
+-- vlog_inst3

82 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

The following examples are recommended when specifying the path name in
fsdbDumpvars to dump a specific scope with simulator dependency delimiter
when specified in the design.
In IUS
fsdbDumpvars(1,":");
fsdbDumpvars(1,":vhdl_ent1");
fsdbDumpvars(1,":vhdl_ent1:vhdl_ent2");
fsdbDumpvars(1,":vhdl_ent1:vlog_inst2");
fsdbDumpvars(1,":vlog_inst1");
fsdbDumpvars(1,":vlog_inst1.vhdl_ent3");
fsdbDumpvars(1,":vlog_inst1.vlog_ins3");

fsdbDumpvars(1,"vlog_top");
fsdbDumpvars(1,"vlog_top.vhdl_ent1");
fsdbDumpvars(1,"vlog_top.vhdl_ent1:vhdl_ent2");
fsdbDumpvars(1,"vlog_top.vhdl_ent1:vlog_inst2");
fsdbDumpvars(1,"vlog_top.vlog_inst1");
fsdbDumpvars(1,"vlog_top.vlog_inst1.vhdl_ent3");
fsdbDumpvars(1,"vlog_top.vlog_inst1.vlog_ins3");

In ModelSim
fsdbDumpvars(1,"/vhdl_top");
fsdbDumpvars(1,"/vhdl_top/vhdl_ent1");
fsdbDumpvars(1,"/vhdl_top/vhdl_ent1/vhdl_ent2");
fsdbDumpvars(1,"/vhdl_top/vhdl_ent1/vlog_inst2");
fsdbDumpvars(1,"/vhdl_top/vlog_inst1");
fsdbDumpvars(1,"/vhdl_top/vlog_inst1/vhdl_ent3");
fsdbDumpvars(1,"/vhdl_top/vlog_inst1/vlog_ins3");

fsdbDumpvars(1,"/vlog_top");
fsdbDumpvars(1,"/vlog_top/vhdl_ent1");
fsdbDumpvars(1,"/vlog_top/vhdl_ent1/vhdl_ent2");
fsdbDumpvars(1,"/vlog_top/vhdl_ent1/vlog_inst2");
fsdbDumpvars(1,"/vlog_top/vlog_inst1");
fsdbDumpvars(1,"/vlog_top/vlog_inst1/vhdl_ent3");
fsdbDumpvars(1,"/vlog_top/vlog_inst1/vlog_ins3");

Alternatively, you can use a dot (.) as the separator in the scope path names.
fsdbDumpvars(1,"vhdl_top");
fsdbDumpvars(1,"vhdl_top.vhdl_ent1");
fsdbDumpvars(1,"vhdl_top.vhdl_ent1.vhdl_ent2");
fsdbDumpvars(1,"vhdl_top.vhdl_ent1.vlog_inst2");
fsdbDumpvars(1,"vhdl_top.vlog_inst1");
fsdbDumpvars(1,"vhdl_top.vlog_inst1.vhdl_ent3");
fsdbDumpvars(1,"vhdl_top.vlog_inst1.vlog_ins3");

fsdbDumpvars(1,"vlog_top");
fsdbDumpvars(1,"vlog_top.vhdl_ent1");
fsdbDumpvars(1,"vlog_top.vhdl_ent1.vhdl_ent2");

Linking Novas Files with Simulators and Enabling FSDB Dumping 83

FSDB Dumping Commands

fsdbDumpvars(1,"vlog_top.vhdl_ent1.vlog_inst2");
fsdbDumpvars(1,"vlog_top.vlog_inst1");
fsdbDumpvars(1,"vlog_top.vlog_inst1.vhdl_ent3");
fsdbDumpvars(1,"vlog_top.vlog_inst1.vlog_ins3");

In VCS MX
fsdbDumpvars(1,":vhdl_top");
fsdbDumpvars(1,":vhdl_top:vhdl_ent1");
fsdbDumpvars(1,":vhdl_top:vhdl_ent1:vhdl_ent2");
fsdbDumpvars(1,":vhdl_top:vhdl_ent1:vlog_inst2");
fsdbDumpvars(1,":vhdl_top:vlog_inst1");
fsdbDumpvars(1,":vhdl_top:vlog_inst1:vhdl_ent3");
fsdbDumpvars(1,":vhdl_top:vlog_inst1:vlog_ins3");

fsdbDumpvars(1,":vlog_top");
fsdbDumpvars(1,":vlog_top:vhdl_ent1");
fsdbDumpvars(1,":vlog_top:vhdl_ent1:vhdl_ent2");
fsdbDumpvars(1,":vlog_top:vhdl_ent1:vlog_inst2");
fsdbDumpvars(1,":vlog_top:vlog_inst1");
fsdbDumpvars(1,":vlog_top:vlog_inst1:vhdl_ent3");

NOTE: The rule of delimiters regarding hierarchy expressions is simulator

dependent. The above usage is based on the earliest supporting build in
simulators, and later builds in simulators may allow more free styles on
delimiters or changes without notice.

fsdbDumpvarsES

Description
Dump signal-value-change information to the FSDB file for the signals in the
specified Essential Signal list which are within the specified scopes and levels.

LIMITATIONS:
Only hierarchical format for the Essential Signal list is supported.
Multiple trees are created in the FSDB file when multiple
fsdbDumpvarsES system tasks are specified.

Syntax
When specified in the design:
fsdbDumpvarsES( depth, “instance”, "es_list_file”[, “option,*”]);

NOTE: The first three arguments depth, instance and es_list_file are required.
You can place a delimiter in the instance argument to represent the
design top. For users of ModelSim, the delimiter between the

84 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

hierarchical names is slash (/). For users of IUS or VCS, the delimiter
is colon (:).For example, fsdbDumpvarsES(0, ":", myeslist.txt,
"+fsdbfile+dump.fsdb").
When specified on the simulator command line:
Synopsys: (VCS_MX UCLI command prompt)
fsdbDumpvarsES ESFileName
fsdbDumpvarsES [insatnce] ESFileName
fsdbDumpvarsES [depth] [instance] [option]* ESFileName

Cadence:
call fsdbDumpvarsES ESFileName
call fsdbDumpvarsES [instance] ESFileName
call fsdbDumpvarsES [depth] [instance] [option]* ESFileName

ModelSim:
fsdbDumpvarsES ESFileName
fsdbDumpvarsES [instance] ESFileName
fsdbDumpvarsES [depth] [instance] [option]* ESFileName

Arguments
depth
Specify how many levels of hierarchy to dump for the subsequent scopes.
instance
This definition gives the module scope or signals that specify the objects to
dump.
es_list_file
Specify the es list filename.
The file format of the Essential Signal file is as follows:
#ESD
# The first line should be "#ESD".
# Used to recognize the file format.

#V2
# The second line should be “#V2”.
# The following is the signal list.
# The first character '<' means the beginning of a scope.
# The scope name is specified sequentially.
<scope_instance_name

# List all signals under the same scope.

signal_instance_name
...
<scope_instance_name
...

Linking Novas Files with Simulators and Enabling FSDB Dumping 85

FSDB Dumping Commands

>
# The first character '>' indicates move to the next
# higher scope.
...
>

# The following are option values you want to save in FSDB.

# They will be saved under a hidden scope called
# $$ESD_OPTIONS.
# Syntax - $var_name="value"
$op1="system.i_cpu.i_PCU"
# The first character '$' means an option and its value are
# specified sequentially.

option
Specify one or more of the following options:

Specify the FSDB file name. If not specified, the default

Examples
NOTE: The following example uses the syntax for calling the system task in the
design. Refer to the syntax section for the correct format for the
simulator command line.
fsdbDumpvarsES(0, ":", "myeslist.list");
Dumps all signals in the Essential Signal list to the FSDB. Hierarchical
format is used in myeslist.list.
fsdbDumpvarsES(1, "system.i_CPU.i_ALUB", "+fsdbfile+target.fsdb"
, "myeslist.list")
Dumps all signals in the Essential Signal file (myeslist.list) which are also
within the specified scope(s) and level to target.fsdb. The immediate child
scope(s) of the specified scope(s) and level are identified. If the child scope
is a library cell instance, it will be ignored. For other immediate child
scopes, the external nets of output boundary signals will be dumped.

86 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

fsdbDumpMDA

Description
Dump value changes of SystemVerilog MDA (one or multi-dimensional array)
signals to the FSDB file.

NOTE: fsdbDumpMDA supports MDA statements that are specified in the

Verilog/SystemVerilog portion of a mixed language design only. For
pure VHDL arrays, which can be dumped by fsdbDumpvars, there is no
specific command for doing so.

NOTE: fsdbDumpMDA needs to be added in the initial block. Invoking

fsdbDumpMDA multiple times in the source code, like specifying
inside the always block, may cause the FSDB size to be increased, since
fsdbDumpMDA will traverse the design each time it is invoked and save
the hierarchy tree into the FSDB file.

Syntax
When specified in the design:
fsdbDumpMDA( depth, "instance" [,"option,*"] );

NOTE: Inside quotation marks, use a comma to separate options and leave no
space between options.

NOTE: The first two arguments depth and instance are required. You can place
a delimiter in the instance argument to represent the design top. For
example, fsdbDumpMDA(0, “:”). For ModelSim users, the delimiter
between the hierarchical names is slash (/).
When specified on the simulator command line:
Synopsys: (VCS_MX UCLI command prompt)
fsdbDumpMDA [depth] [instance]
fsdbDumpMDA [depth] [instance] [option]*

Cadence:
call fsdbDumpMDA [depth] [instance]
call fsdbDumpMDA [depth] [instance] [option]*

Modelsim:
fsdbDumpMDA [depth] [instance]
fsdbDumpMDA [depth] [instance] [option]*

Arguments
depth

Linking Novas Files with Simulators and Enabling FSDB Dumping 87

FSDB Dumping Commands

Specify how many levels of hierarchy to dump for the subsequent scopes.
instance
This definition gives the instance/signal that contains the MDA objects you
want to dump.
option

Specify the FSDB file name. If not specified, the default

Examples
Assume the following memory and MDA signal are defined in SystemVerilog
design part of mixed HDL design:
reg [7:0] plane [15:0];
reg [7:0] screen [79:0][0:24][1:0];

The following examples are specified in a VHDL design.

fsdbDumpMDA(0, “plane” );
Dump all cells of memory plane.
fsdbDumpMDA(0, “system”);
Dump all memories and MDAs under the system scope and its child scopes.
fsdbDumpMDA(1, “system.i_pram”);
Dump all memories and MDAs under the system.i_pram scope.
fsdbDumpMDA(0, top, “+skip_cell_instance=1,+fsdbfile+dump.fsdb”);
Dump all memories and MDAs under top scope and skip cell instance.

fsdbDumpSVA

Description
Dump SystemVerilog Assertion (SVA) results to the FSDB file. The results of
SVA within the specified scopes and/or modules can be dumped and saved to the
same FSDB file that contains dumped results for design signals or to a separate
file.

88 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Syntax
When specified in the design:
fsdbDumpSVA( depth, "instance" [,"option,*"] );
fsdbDumpSVA( depth, ":" ,"+fsdbfile=filename,+fsdb+sva_success");

NOTE: The first two arguments depth and instance are required. You can place
a delimiter in the instance argument to represent the design top. For
example, “:”. For the users of ModelSim, the delimiter between the
hierarchical names is slash (/).
When specified on the simulator command line:
Synopsys: (VCS_MX UCLI command prompt)
fsdbDumpSVA
fsdbDumpSVA [depth] [instance] [option]*

Cadence:
call fsdbDumpSVA
call fsdbDumpSVA [depth] [instance] [option]*

Modelsim:
fsdbDumpSVA
fsdbDumpSVA [depth] [instance][option]*

Arguments
depth
Specify the levels of hierarchy to dump for the subsequent scopes.
instance
Specify the instance name for dumping all SVA assertions below it.
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".
+fsdb+sva_success Specify at runtime to dump the successful assertion.
Enable/Disable dumping of cell instance where mode
means:
"+skip_cell_instance=mode" 0: Disable functionality.
1 or 2: Skip all cell information.
Others: Show error message and ignore it.

NOTE: For VCS users, the -sverilog and -debug_pp command line options are
necessary to dump SVA signals.

Linking Novas Files with Simulators and Enabling FSDB Dumping 89

FSDB Dumping Commands

Examples
NOTE: The following examples use the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
process begin
fsdbDumpvars(0, “top”, “+fsdbfile+my.fsdb”);
fsdbDumpSVA(0, “top”);
(“+fsdb+sva_success,+fsdbfile+fsdb+sva_success.fsdb”);
wait for 5 ns;
fsdbDumpoff;
wait for 5 ns;
fsdbDumpon;
wait for 5 ns;
fsdbDumpFinish;
fsdbDumpfile("2.fsdb");
fsdbDumpSVA(1, “top”); --dump sva to 2.fsdb
wait for 5 ns;
wait;
end process;

fsdbDumpSVA(0, “:”);
Dump all SVA assertions from design top and its descendents.
fsdbDumpSVA(0, “system”);
Dump all SVA assertions under system and its descendents.
fsdbDumpSVA(1, “system.arbiter”);
Dump all SVA assertions under system.arbiter. The dumping level is set to
1, so dumping will exclude the SVA assertions under their descendent
scopes.

90 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

fsdbDumpvarsByFile(“scope_lst.txt”, “+fsdbfile=hdl.fsdb”);
fsdbDumpSVA(0, “system.arbiter”, “+fsdbfile=SVA.fsdb”);
The first dumping command dumps design signals to the hdl.fsdb file. The
second dumping command dumps all SVA assertions under system.arbiter
scope and its descendents to the SVA.fsdb file.

NOTE:
1. Immediate assertion (like A1: assert(….) ...else $error, A2 assert
finial(…)) won't be dumped in FSDB Dumper.
2. Sequences (like sequence … endsequence) and properties
(property…endproperty) won't be dumped by the FSDB dumper.

fsdbDumpvarsByFile

Description
Dump several scopes and signals defined in a text file to the designated FSDB
file. fsdbDumpvarsByFile can be invoked more than once to dump several
scopes/signals defined in different text files to specific FSDB files. There are two
schemes to specify designated FSDB files:
1. No FSDB file name specified in fsdbDumpvarsByFile (only one argument
needed). You may use $fsdbDumpfile or use argument
“+fsdbfile+filename.fsdb” (takes another argument) to specify the
designated FSDB file. If there is no FSDB file specified, novas.fsdb will be
taken as the default.
2. Specify FSDB file name in fsdbDumpvarsByFile (two arguments needed).
You have to use different FSDB files for each call.

NOTE: fsdbDumpvarsByFile does not support text files in Essential Signal

Dumping (ESD) file format. The alternative is to use fsdbDumpvarsES
dumping command.

Syntax
When specified in the design:
fsdbDumpvarsByFile ( "textFileName" [,"+fsdbfile+filename”] );

When specified on the simulator command line:

Synopsys:
fsdbDumpvarsByFile textFileName [+fsdbfile+filename]

Cadence:
call fsdbDumpvarsByFile textFileName [+fsdbfile+filename]

Linking Novas Files with Simulators and Enabling FSDB Dumping 91

FSDB Dumping Commands

ModelSim:
fsdbDumpvarsByFile textFileName [+fsdbfile+filename]

Arguments
“textFileName”
Specify the name of the text file containing the scopes to dump (in plain text
format).
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".

File Format of the Text File

# comment
[option_in_file]* [depth] instance_name

The options are the same as fsdbDumpvars (repeated below for

convenience). Options in the following table are for the text file only. They
can only be specified in the [option_in_file] location of the "textfile" only.
For example:
+all 1 system
+mda +struct 3 system.i_cpu

"+IO_Only" Only IO port signals will be dumped.

"+functions" Enable dumping of functions in the design.
"+Reg_Only" Only reg type signals will be dumped.
Dump all memory and MDA signals in all scopes
specified in fsdbDumpvars or the entire design if no
scope is specified.
"+mda" This option is covered by the "+all" option and is
effective for SystemVerilog's MDAs only. For VCS
users, the VCS option "+memcbk" may be needed when
compiling the design.
Only dump the packed signals in the design (without
array and memory types). The Supported MDA Format
Table summarizes if the packed or unpacked
one-dimensional/two-dimensional signals are dumped
"+packedmda"
with or without the +packedmda and +mda options.
Example: $fsdbDumpvars("+packedmda");
NOTE: This option replaces the +mda+packedOnly
option.

92 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Dump the struct or the struct in packed MDA.

+packedmda+struct
Example: $fsdbDumpvars("+packedmda+struct ");
Dump all structs in all scopes specified in fsdbDumpvars
or in the entire design if no scope is specified. This
"+struct"
option is covered by the "+all" option and is effective for
SystemVerilog struct syntax only.
Enable/Disable dumping of cell instance where mode
means:
0: disable functionality.
"+skip_cell_instance=mode"
1: Skip all cell info.
2: Dump all ports of cell instance.
Others: Show error message and ignore it.
"+strength" Enable strength dumping.
Dump all signals including the memory, MDA, packed
array, structure, union and packed structure signals in all
"+all" scopes specified in fsdbDumpvars or the entire design if
no scope is specified. For VCS users, the VCS option
"+memcbk" may be needed when compiling the design.
Dump parameters.
NOTE: If the parameter type of Verilog is “scalar”,
"+parameter"
“real”, or “string”, the name will be displayed without
range information.
"+trace_process" Dump VHDL process.

Supported MDA Format Table

Unpacked 1D Unpacked 2D Packed 1D Packed 2D

Options
e.g. T a[ ]; e.g. T a[ ][ ]; e.g. T [ ]a; e.g. T [ ][ ]a;

None Yes

"+packedmda" Yes Yes

"+mda" Yes Yes Yes Yes

Examples
fsdbDumpvarsByFile("./case1.lst","+fsdbfile+case1.fsdb");

[case1.lst]
+Reg_Only 0 top.type_dut.regInst
+parameter 0 top.type_dut.parameterInst
+functions 5 top.type_dut.FunAndTaskInst
+skip_cell_instance=1 0 top.type_dut.tri0Inst
+skip_cell_instance=1 +mda 0 top.type_dut.tri1Inst
+skip_cell_instance=1 +packedmda 0 top.type_dut.triInst
+mda 3 top.type_dut.enumInst

Linking Novas Files with Simulators and Enabling FSDB Dumping 93

FSDB Dumping Commands

+packedmda 3 top.type_dut.logicInst
+struct top.type_dut.pstructInst

fsdbSuppress

Description
Specify the scopes that will not be dumped by the fsdbDumpvars,
fsdbDumpvarsByFile, fsdbDumpMDA or fsdbDumpVariable commands.
fsdbSuppress supports suppressing by file name or the target scopes passed as
arguments. The supported target scope could be modules, instances, scopes or
signals in full hierarchical format. Each format has to be called in different
fsdbSuppress calls respectively.

NOTE: fsdbSuppress should be specified before fsdbDumpvars,

fsdbDumpvarsByFile, fsdbDumpMDA, or fsdbDumpVariable;
otherwise, fsdbSuppress will not work.

NOTE: The setting of fsdbSuppress will be reset after fsdbDumpFinish is

executed.

Syntax
When specified in the design:
fsdbSuppress( "suppress_file" | "instance,*");

fsdbSuppress("suppress_file");
fsdbSuppress("instance,*");

NOTE: Use a comma to separate instances or signal_names and leave no space

between the instances or signal_names.
When specified on the simulator command line:
Synopsys:
fsdbSuppress suppress_file
fsdbSuppress instance*

Cadence:
call fsdbSuppress suppress_file
call fsdbSuppress instance*

ModelSim:
fsdbSuppress suppress_file
fsdbSuppress instance*

94 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

Arguments
suppress_file
Specify the file containing the names of the scopes that will not be dumped.
“instance”
Specify one or more scopes that will not be dumped.
“signal_name”
Specify the signal in full hierarchical format that will not be dumped.

NOTE: All supported suppression methods should be used separately for each
fsdbSuppress called; cannot combine multiple suppression types in one
fsdbSuppress command.

NOTE: For file syntax, each line of the file is the full name of a scope that you
do not want to be dumped.

Examples
Example 1
fsdbSuppress(dump_top,system.i_pram);
fsdbDumpvars(0,dump_top);

Example 2
fsdbSuppress(“./suppress.lst”);

[suppress.lst]
system.R_W
system.i_cpu.C0
system.i_cpu.C1
system.i_cpu.C5
system.i_cpu.C6
...

NOTE: Both target scopes specified as task parameters or listed in suppression

file supports in instances and modules format.

fsdbDumpon, fsdbDumpoff

Description
These FSDB dumping commands turn dumping on and off. fsdbDumpon/
fsdbDumpoff has the highest priority and will override all other FSDB dumping

Linking Novas Files with Simulators and Enabling FSDB Dumping 95

FSDB Dumping Commands

commands such as fsdbDumpvars, fsdbDumpvarsES, fsdbDumpMDA,

fsdbDumpSVA, fsdbDumpvarsByFile or fsdbDumpVariable.

NOTE: fsdbDumpon/fsdbDumpoff is not restricted to only fsdbDumpvars.

If there is more than one FSDB file open for dumping at one simulation
run, fsdbDumpon/fsdbDumpoff may only affect a specific FSDB file by
specifying the specific file name.

Syntax
When specified in the design:
fsdbDumpon( ["+fsdbfile+filename"] );
fsdbDumpoff( ["+fsdbfile+filename"] );

When specified on the simulator command line:

Synopsys: (VCS_MX UCLI command prompt)
fsdbDumpon [+fsdbfile+filename]
fsdbDumpoff [+fsdbfile+filename]

Cadence:
call fsdbDumpon [+fsdbfile+filename]
call fsdbDumpoff [+fsdbfile+filename]

ModelSim:
fsdbDumpon [+fsdbfile+filename]
fsdbDumpoff [+fsdbfile+filename]

Arguments
option

Specify the FSDB file name. If not specified, the default

+fsdbfile+filename
FSDB file name is "novas.fsdb".

96 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

end process;

The value changes for all variables in this design example are dumped from
time 5ns to time 10ns and from time 15ns to time 20ns.

fsdbSwitchDumpfile

Description
Support multiple FSDB files during a simulation run by specifying the currently
active FSDB file name. When this command is executed, the previously opened
FSDB file is closed and the new FSDB file is created to continue saving the
values change data and act as current active FSDB file.
Since the FSDB dumper supports more then one open file for saving data
simultaneously, the source file that is supposed to be switched can be specified
by option “+fsdbfile+sourcefilename”, otherwise the source file would be the
currently active FSDB file.

Syntax
When specified in the design:
fsdbSwitchDumpfile("NewFileName" [ ,"+fsdbfile+src_file"] );

fsdbSwitchDumpfile("NewFileName");
fsdbSwitchDumpfile("NewFileName", "+fsdbfile+src_file");

When specified on the simulator command line:

Synopsys and ModelSim:
fsdbSwitchDumpfile NewFileName
fsdbSwitchDumpfile NewFileName +fsdbfile+src_file

Cadence:
call fsdbSwitchDumpfile NewFileName
call fsdbSwitchDumpfile NewFileName +fsdbfile+src_file

Arguments
NewFileName
The target new name of the FSDB file generating by the Novas object files
for FSDB dumping.
Option

Specify the source FSDB file to be switched. (include

the .fsdb file extension in the name). This is optional; if
+fsdbfile+src_file
not specified, the FSDB dumper will switch dump finish
on all active FSDB files.

Linking Novas Files with Simulators and Enabling FSDB Dumping 97

FSDB Dumping Commands

Examples
NOTE: The following example uses the syntax for calling the FSDB dumping
command in the design. Refer to the syntax section for the correct
format for the simulator command line.
fsdbDumpfile("test0.fsdb");
fsdbDumpvars(0, “system”);
fsdbDumpvars(3, “system”, “+fsdbfile+f1.fsdb);
wait for 100 ns
fsdbSwitchDumpfile(“test1.fsdb”, “+fsdbfile+test0.fsdb”);
wait for 100 ns
fsdbSwitchDumpfile("test2.fsdb", “+fsdbfile+f1.fsdb”);

Create test0.fsdb to dump the design initially. Create f1.fsdb to dump the
different depth of design. Switch test0.fsdb to test1.fsdb at the simulation
time 100ns. Then switch f1.fsdb to test2.fsdb at the simulation time 200ns.

fsdbDumpfile

Description
Specify the FSDB file name created by the Novas object files for FSDB
dumping. If not specified, the default FSDB file name is "novas.fsdb". This
command is valid only before fsdbDumpvars is executed and is ignored if
specified after fsdbDumpvars.
To restrict the largest dump-file size to the user-defined size limitation, specify
the limit size in megabyte format. This function will affect the FSDB file that is
specified in “FSDB_Name”. The FSDB dumper uses the sliding window scheme
to keep the last signal values in the FSDB file. It drops the old values if file size
exceeds the user-specified limitation.
For fsdbDumpvars, fsdbDumpMDA, fsdbDumpvarsES, fsdbDumpSVA and
fsdbDumpvarsByFile, user can use the option “+fsdbfile+filename.fsdb” to
specify the target FSDB file to dump. It is equal to using fsdbDumpfile then
fsdbDumpvars.

NOTE: To leverage the memory consumption, the maximum number of opened

FSDB files for dumping in one simulation run should be no more than
32 files.

Syntax
When specified in the design:
fsdbDumpfile( "FSDB_Name" [ ,limit_size] );

98 Linking Novas Files with Simulators and Enabling FSDB Dumping

FSDB Dumping Commands

When specified on the simulator command line:

Synopsys: (VCS_MX UCLI command prompt)
fsdbDumpfile FSDB_Name [limit_size]

Cadence:
call fsdbDumpfile FSDB_Name [limit_size]

ModelSim:
fsdbDumpfile FSDB_Name [limit_size]

Arguments
FSDB_Name
Specify the name of the FSDB file generated by the Novas object files for
FSDB dumping.
limit_size
Specify the maximum FSDB file size in megabyte.

NOTE: The minimum file size of the FSDB file is 10M. If you set the size less
than 10M, it will be set to 10M instead.

fsdbAutoSwitchDumpfile

Description
Automatically switch to a new dump file when the working FSDB file hits the
specified size limitation. The unit associated with the fsdbAutoSwitchDumpfile
File_Size parameter is a megabyte.

Syntax
When specified in the design:
fsdbAutoSwitchDumpfile( File_Size, "FSDB_Name", Number_of_Files
[,"log_filename"] );

When specified on the simulator command line:

Linking Novas Files with Simulators and Enabling FSDB Dumping 99

FSDB Dumping Commands

Synopsys:
fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

Cadence:
call fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

ModelSim:
fsdbAutoSwitchDumpfile File_Size FSDB_name Number_of_Files
[log_filename]

Arguments
File_Size
The FSDB file size limit in MB.

NOTE: The minimum file size of the FSDB file is 10MB. If you set the size less
than 10MB, it will be set to 10MB instead.
FSDB_name
FSDB file generating by the Novas object files for FSDB dumping.
Number_of_Files
The maximum number of FSDB files you wish to be created.

NOTE: If the number is put as 0, the FSDB dumper will create new FSDB files
without file number limitation.
log_filename
This argument is optional. You can specify the filename for the log file.

Examples
NOTE: The following examples use the syntax for calling the FSDB dumping
command in the VDHL design. Refer to the syntax section for the
correct format for the simulator command line.
process
begin
fsdbAutoSwitchDumpfile(10, "test.fsdb", 20);
fsdbDumpvars(0, “:system”);
wait;
end process;

100 Linking Novas Files with Simulators and Enabling FSDB Dumping
FSDB Dumping Commands

test_000.fsdb will be overwritten when the file size of test_019.fsdb reaches

near 10MB. The default test.log file will list the time range of each FSDB
file.
process begin
fsdbAutoSwitchDumpfile(10, "test.fsdb", 20, "my.log");
fsdbDumpvars(0, “system”);
wait;
end process;

The number and the maximum file size of the FSDB file are the same as the
previous example, but the log file is set to my.log.

fsdbDumpFinish

Description
Close all FSDB files in the current simulation and stop dumping the signals.
Although all FSDB files are closed automatically at the simulation finish, you
can invoke this dumping command to explicitly close the FSDB files during the
simulation. You can create a new FSDB file after you have closed the FSDB file.
You cannot append the new dumping data to a closed FSDB file due to the
current limitation of the FSDB file architecture. If you try to open the same
filename of FSDB file again during the same simulation run, the new FSDB file
will be renamed automatically.

Syntax
When specified in the design:
fsdbDumpFinish;

When specified on the simulator command line:

Synopsys and ModelSim:
fsdbDumpFinish

Cadence:
call fsdbDumpFinish

Examples
NOTE: The following examples use the syntax for calling the commands in the
design. Refer to the syntax section for the correct format for the
simulator command line.
Example 1
fsdbDumpfile("CPU.fsdb");

Linking Novas Files with Simulators and Enabling FSDB Dumping 101
FSDB Dumping Commands

fsdbDumpvars(0, ":"); -- IUS

-- fsdbDumpvars(0, "system"); -- ModelSim
-- fsdbDumpvars(0, ":system"); -- VCS-MX
wait for 2000 ns;
fsdbDumpFinish;

Close the CPU.fsdb file at 2000 ns.

Example 2
fsdbDumpfile("CPU.fsdb");
fsdbDumpvars(0, ":"); -- IUS
-- fsdbDumpvars(0, "system"); -- ModelSim
-- fsdbDumpvars(0, ":system"); -- VCS-MX
wait for 2000 ns;
fsdbDumpFinish;
wait for 2000 ns;
fsdbDumpfile("CPU.fsdb");
fsdbDumpvars(0, ":i_CPU"); -- IUS
-- fsdbDumpvars(0, "system/i_CPU"); -- ModelSim
-- fsdbDumpvars(0, ":system:i_CPU"); -- VCS-MX
wait;

Close the CPU.fsdb file at 2000 ns. Then open a new FSDB file at 4000 ns.
Because the same FSDB file is reopened, this new FSDB file will be
renamed as CPU_r000.fsdb. Only system.i_CPU and its child regions are
dumped to CPU_r000.fsdb.

fsdbDumpflush

Description
This FSDB dumping command may be used in your HDL code and also via the
command line for interactive simulation control. The command forces the signal
values to be flushed to the FSDB file while the simulation is running. This allows
you to check the current simulation results whenever is ready instead of waiting
for the simulation to end or the internal buffer to be filled.

NOTE: The Novas object files for FSDB dumping will automatically flush the
value change data to the FSDB file on disk under the following
conditions:
- The simulation stops is due to a $stop statement in Verilog design.
- The simulation stops at a user specified breakpoint.
- The user uses Ctrl-C to break the simulation.

Syntax
When specified in the design:

102 Linking Novas Files with Simulators and Enabling FSDB Dumping
FSDB Dumping Commands

fsdbDumpflush;

When specified on the simulator command line:

Synopsys and ModelSim:
fsdbDumpflush

Cadence:
call fsdbDumpflush

fsdbDumpVariable

Description
This dumping command dumps the specified variable value changes to the file
created by fsdbDumpfile or by +fsdbfile+filename option. It is valid only in
ModelSim. The variable name must be specified using its full hierarchical path.
Refer to the ModelTech definitions for the full syntax. For example, the delimiter
of the full hierarchy path in ModelSim should be “/” or “.”.

NOTE: The FSDB dumper only flushes the current value of variables into the
FSDB file as MTI does not currently support a value change callback
for variables. To generate variable information throughout the
simulation, specify fsdbDumpVariable in a process, not at the vsim
prompt. For example:
P1: process(...)
...
begin
fsdbDumpVariable(...);
...
end process P1;

Syntax
When specified in the design:
fsdbDumpVariable("variableName" [, “+fsdbfile+filename”]);

When specified on the ModelSim simulator command line:

fsdbDumpVariable variableName [+fsdbfile+filename]

Arguments
variableName
Specify the variable name in full hierarchy format whose value changes
should be dumped to the FSDB file.

Linking Novas Files with Simulators and Enabling FSDB Dumping 103
FSDB Dumping Commands

option

Specify the FSDB file name. If not specified, FSDB

+fsdbfile+filename
dumper will dump the result into default file.

fsdbDumpVariableByFile

Description
Dump several variables defined in a text file to the file created by fsdbDumpfile.
It is valid only in ModelSim.

NOTE: The FSDB dumper only flushes the current value of variables into the
FSDB file as MTI does not currently support a value change callback
for variables. To generate variable information throughout the
simulation, use fsdbDumpVariableByFile in a process, not at the vsim
prompt. For example:
P1: process(...)
...
begin
fsdbDumpVariableByFile(...);
...
end process P1;

Syntax
When specified in the design:
fsdbDumpVariableByFile("txt_filename" [, "+fsdbfile+filename"]);

When specified on the ModelSim simulator command line:

fsdbDumpVariableByFile txt_filename [+fsdbfile+filename]

Arguments
txt_filename
Specify the text file containing variable name whose value changes should
be dumped to the FSDB file.

104 Linking Novas Files with Simulators and Enabling FSDB Dumping
FSDB Dumping Commands

The file format of the text file is as follows:

# comment
variable_instance_name
variable_instance_name
...

The variable name must be specified using its full hierarchical path. Refer
to the ModelTech definitions for the full syntax.
option

Specify the FSDB file name. If not specified, FSDB

+fsdbfile+filename
dumper will dump the result into default file.

NOTE: Specify the full hierarchy path of the variables with ModelSim VHDL
delimiters “/” or “.”. For example, /system/i_pram2/pram2/innermem
or system.i_pram2.pram2.innermem.

Examples
NOTE: The following example uses the syntax for calling the commands in the
design. Refer to the syntax section for the correct format for the
simulator command line.
fsdbDumpVariableByFile(“dump.lst”, “+fsdbfile+dump.fsdb”);
To dump variable instances defined in dump.lst file into dump.fsdb file. The
dump.lst file contains the following text:
# For ModelSim
/system/i_pram2/pram2/innermem
/system/i_pram2/pram2/memaddr

Linking Novas Files with Simulators and Enabling FSDB Dumping 105
FSDB Dumping Commands

106 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Synopsys Simulators

Linking with Synopsys

Simulators
NOTE: A novas_dump.log file gets created during simulation to record some
essential simulation/dumping information, such as simulation options
used, environment variable settings, and Novas object directories
linked. This log file is needed to report a dumper related issue
effectively.

VCS
Set the VCS_HOME environment variable.
> setenv VCS_HOME $VCS_INST_DIR

Before running the simulation (simv), the VERDI_HOME environment variable

must be set and point to the directory where the Verdi application is installed. For
example:
> setenv VERDI_HOME $VERDI_INST_DIR

Compile the design with the following options:

-debug_access+pp or -debug_access or -deubug_access+all
The correct version of the FSDB dumper is automatically linked regardless of the
VCS version you are running.
The VCS option, -debug_access+pp, is an aggregation of +vpi, +vcsd, and
+memcbk, and it contains the minimal required debug capability for post-
processing debug's need. For other VCS options in different debug level
capabilities, refer to VCS' documentation or Appendix B: Required VCS MX
Options for Linking with FSDB Dumper for more details.
Example of Linux 32bit Platforms
> vcs -debug_access+pp design.v

Linking Novas Files with Simulators and Enabling FSDB Dumping 107
Linking with Synopsys Simulators

Linking with VCS using VHDL Dumping Commands

If you want to invoke any FSDB dumping command in VHDL, or any FSDB
foreign functions in the VHDL code, you must compile and include a VHDL
package in your design.
Use the following steps:
1. Use VCS MX analyzer, vhdlan, to compile the Verdi-provided VHDL file
to the same directory as the design is saved.
$VERDI_HOME/share/PLI/VCS/${PLATFORM}/novas.vhd
> vhdlan ${NOVAS_HOME}/share/PLI/VCS/${PLATFORM}/novas.vhd
The VHDL file novas.vhd contains the definitions of the FSDB foreign
functions.
2. Use the novas package in any VHDL design file that invokes FSDB foreign
functions. For example:
library IEEE;
use IEEE.std_1364.all;
use work.novas.all; --using novas package.
entity testbench is
end;
architecture blk testbench is
Begin
...
Process begin: dump
fsdbDumpvars(0, “:”, “+fsdbfile+signal.fsdb”); -- call
VHDL procedure
wait;
end process
end;
3. Recompile the modified VHDL files.
VCS MX loads the Novas object files for FSDB dumping during the
simulation.
To learn more about the usage of the FSDB foreign functions, refer to the
FSDB Dumping Commands Used in VHDL section.

108 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Synopsys Simulators

VCS/VCS MX (VCS/VCS MX 2014.03 and

Later Versions) - SystemC and HDL (Verilog/
SystemVerilog, VHDL) Mixed
SystemC Dumper for Synopsys VCS/VCS MX 2014.03 / SystemC 2.2.0

Platform Compiler Library Directory

Linux (32-bit) GNU GCC-4.1.2 / 4.2.2 / 4.5.2 share/PLI/VCS/LINUX
Linux (64-bit) GNU GCC-4.1.2 / 4.2.2 / 4.5.2 share/PLI/VCS/LINUX64
SUSE (32-bit) GNU GCC-4.1.2 / 4.2.2 / 4.5.2 share/PLI/VCS/SUSE32
SUSE (64-bit) GNU GCC-4.1.2 / 4.2.2 / 4.5.2 share/PLI/VCS/SUSE64

SystemC Dumper for Synopsys VCS/VCS MX 2014.03 / SystemC 2.3.0

Platform Compiler Library Directory

Linux (32-bit) GNU GCC-4.5.2 share/PLI/VCS/LINUX
Linux (64-bit) GNU GCC-4.5.2 share/PLI/VCS/LINUX64
SUSE (32-bit) GNU GCC-4.5.2 share/PLI/VCS/SUSE32
SUSE (64-bit) GNU GCC-4.5.2 share/PLI/VCS/SUSE64

SystemC Dumper for Synopsys VCS/VCS MX 2014.03 and later /

SystemC 2.2.0

Platform Compiler Library Directory

Linux (32-bit) GNU GCC-4.2.2 / 4.5.2 / 4.7.2 share/PLI/VCS/LINUX
Linux (64-bit) GNU GCC-4.2.2 / 4.5.2 / 4.7.2 share/PLI/VCS/LINUX64
SUSE (32-bit) GNU GCC-4.2.2 / 4.5.2 / 4.7.2 share/PLI/VCS/SUSE32
SUSE (64-bit) GNU GCC-4.2.2 / 4.5.2 / 4.7.2 share/PLI/VCS/SUSE64

Linking Novas Files with Simulators and Enabling FSDB Dumping 109
Linking with Synopsys Simulators

SystemC Dumper for Synopsys VCS/VCS MX 2014.03 and later /

SystemC 2.3.0

Platform Compiler Library Directory

Linux (32-bit) GNU GCC-4.5.2 / 4.7.2 share/PLI/VCS/LINUX
Linux (64-bit) GNU GCC-4.5.2 / 4.7.2 share/PLI/VCS/LINUX64
SUSE (32-bit) GNU GCC-4.5.2 / 4.7.2 share/PLI/VCS/SUSE32
SUSE (64-bit) GNU GCC-4.5.2 / 4.7.2 share/PLI/VCS/SUSE64

The libraries are located under the <VERDI_HOME>/ directory.

VCS simulator
Novas object files for FSDB dumping in mixed SystemC/Verilog designs are
provided for the VCS simulator. To dump SystemC and Verilog signals to FSDB
files, you can use the FSDB Verilog FSDB dumping commands at the VCS
prompt or add the FSDB dumping commands to the Verilog code. The related
Novas object files for FSDB dumping for mixed SystemC/Verilog designs with
VCS are located under the <VERDI_HOME>/share/PLI/VCS/ ${PLATFORM}.
The environment variable, LD_LIBRARY_PATH should be set by pointing to the
<VERDI_HOME>/share/PLI/VCS/ ${PLATFORM} directory before running
the simulation, "simv".

NOTE: To specify FSDB dumping commands at the UCLI prompt, the -load
libnovas.so:FSDBDumpCmd option is required when running the
VCS compilation.

Linking the Novas Library with the VCS Simulator

NOTE: VCS2014.03 (LINUX) is used as an example in the following steps.

1. Set the system's shared library search path to include the directory for the
Novas object files for FSDB dumping:
>setenv LD_LIBRARY_PATH \
<VERDI_HOME>/share/PLI/VCS/<PLATFORM>: \
$LD_LIBRARY_PATH

110 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Synopsys Simulators

2. Use VCS to compile your design.

Compile Design with g++34
>vcs -cpp g++34 -sysc=220 *.v *.cpp
-P<VERDI_HOME>/share/PLI/VCS/<PLATFORM>/novas.tab
<VERDI_HOME>/share/PLI/VCS/<PLATFORM>/pli.a
+vcsd -debug_access +memcbk +v2k $OTHER_VCS_OPTIONS

Compile Design with g++41

>vcs -cpp g++41 -sysc=220 *.v *.cpp
-P<VERDI_HOME>/share/PLI/VCS/<PLATFORM>/novas.tab
<VERDI_HOME>/share/PLI/VCS/<PLATFORM>/pli.a
+vcsd -debug_access +memcbk +v2k $OTHER_VCS_OPTIONS

3. Run simulation.
>./simv

Mixed SystemC/HDL Dumping Limitations

Non-intuitive names, such as, signal_1, are shown as signal names if no signal
names have been passed in a member initializer for the object.

Linking Novas Files with Simulators and Enabling FSDB Dumping 111
Linking with Synopsys Simulators

VCS and Virtualizer

Verdi FSDB dumping in the mixed SystemC/Verilog designs supports the
co-simulation of VCS and Virtualizer. To dump SystemC and Verilog signals to
FSDB files, use the FSDB dumping commands at the VCS prompt or add the
FSDB dumping commands to the Verilog code.
Linking the Novas Library with the VCS and Virtualizer:
1. Setup environment:
setenv COWARE_CXX_COMPILER gcc-4.7.2-64
setenv COWAREHOME $SNPS_VP_HOME
source $SNPS_VP_HOME/setup.csh -pa
setenv LD_LIBRARY_PATH ${VERDI_HOME}/share/PLI/VCS/
<PLATFORM>:$ LD_LIBRARY_PATH
setenv FSDB_DUMP_RIDB 1
setenv FSDB_ALL 1

2. Compile design:
vlogan *.v
vlogan *.v -sysc=snps_vp -sc_module *
syscan -cflags -g *.cpp -sysc=snps_vp
vcs -debug_access+r -sysc -sysc=snps_vp -lca sc_main -fsdb

3. Run simulation:
./simv -ucli

112 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

Linking with Cadence

IUS (13.1 or Later Versions) - Verilog Only

The Novas object file for FSDB dumping supports signal dumping in pure
Verilog designs with IUS. The object file for pure Verilog designs with IUS is
called libpli.so and is located under the <VERDI_HOME>/share/PLI/IUS/
${PLATFORM} directory. To link this object file, set the LD_LIBRARY_PATH
environment variable to point to the correct directory and then the correct file
will be loaded for FSDB Dumping.

Quick Start Steps

1. Specify the paths to the FSDB PLI library and dumper engine as paths of
the LD_LIBRARY_PATH environment variable.
> setenv LD_LIBRARY_PATH \
<VERDI_HOME>/share/PLI/IUS/${PLATFORM}: \
$LD_LIBRARY_PATH

NOTE: This needs to be specified regardless of how the simulator is linked and
run.
2. Specify FSDB dumping commands inside the design like:
top.v:

module top;
...
initial
begin

Linking Novas Files with Simulators and Enabling FSDB Dumping 113
Linking with Cadence Simulators

$fsdbDumpfile("my_nc_test.fsdb");
$fsdbDumpvars;
..
end // initial block

3. Choose the preferred method to run IUS.

Using "ncvlog", "ncelab", "ncsim" trilogy:
> ncvlog top.v
ncvlog top.v
ncvlog: 12.20-s017: (c) Copyright 1995-2013 Cadence Design
Systems, Inc.

> ncelab top -access +r

> ncsim top

ncsim: 12.20-s017: (c) Copyright 1995-2013 Cadence Design
Systems, Inc.
*Verdi* Loading libsscore_ius122.so

ncsim> run
Simulation complete via $finish(1) at time 30 NS + 0
./top.v:13 #10 $finish;
ncsim> exit

Using "ncverilog":
> ncverilog top.v -access +r
ncverilog: 12.20-s017: (c) Copyright 1995-2013 Cadence Design
Systems, Inc.

...
*Verdi* Loading libsscore_ius122.so
FSDB Dumper for IUS, Release Verdi_M-2017.03,
Linux, 10/20/2014 (C) 1996 - 2014 by Synopsys, Inc.

Using "irun":
> irun top.v -access +r
irun: 12.20-s017: (c) Copyright 1995-2013 Cadence Design
Systems, Inc.

...
*Verdi* Loading libsscore_ius122.so
FSDB Dumper for IUS, Release Verdi_M-2017.03,
Linux, 10/20/2014 (C) 1996 - 2014 by Synopsys, Inc.

4. Use IUS with FSDB dumping commands specified in Tcl format, cmd.tcl.
cmd.tcl:

114 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

call {$fsdbDumpfile} {"my.fsdb"}

call {$fsdbDumpvars} {top}
run
exit

Using "ncvlog", "ncelab", "ncsim" trilogy:

> ncvlog top.v
> ncelab top -access +r
> ncsim top -i cmd.tcl

Using "ncverilog":
> ncverilog top.v -access +r +tcl+cmd.tcl

Using "irun":
> irun top.v -access +r +tcl+cmd.tcl

5. Use IUS PLI boot method while FSDB dumping commands specified in Tcl
format, cmd.tcl.
Using "ncvlog", "ncelab", "ncsim" trilogy:
> ncvlog top.v
> ncelab top -access +r -loadpli1 debpli:novas_pli_boot
> ncsim top -i cmd.tcl

Using "ncverilog":
> ncverilog top.v -access +r +tcl+cmd.tcl -loadpli1
debpli:novas_pli_boot

Using "irun":
> irun top.v -access +r +tcl+cmd.tcl -loadpli1
debpli:novas_pli_boot

Dynamic Linking
If the IUS execution files (ncelab and ncsim) being used do not statically link
with any other applications, dynamic linking can be used to link the Novas
shared library file (libpli.so or libpli.sl) for FSDB dumping with IUS for pure
Verilog designs. These files can be found under the <VERDI_HOME>/share/
PLI/IUS/${PLATFORM}/ directories.

Specify Shared Library Search Path

IUS searches and loads only one libpli.so (libpli.sl) file from the shared library
paths. The system shared library search path must be set before running ncelab,
ncsim or ncverilog.

Linking Novas Files with Simulators and Enabling FSDB Dumping 115
Linking with Cadence Simulators

Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}/: \
$LD_LIBRARY_PATH

Perform Elaboration and Run Simulation

If you use the ncverilog command to run IUS, you must specify the -access +r
(+ncaccess+r) or +linedebug options to enable read access of the design object.
> ncverilog +ncaccess+r -f run.f

or
> ncverilog +linedebug -f run.f

You must specify +linedebug when running the ncverilog command if you want
to set line break points or run the design step by step using interactive mode in
the Verdi platform.
If you use the ncvlog, ncelab and ncsim trilogy to run the IUS simulation, you
must specify the -access +r option with ncelab or specify the -linedebug option
with ncvlog to enable read access of the design object.
> ncvlog -linedebug -f ncvlog.args
> ncelab -f ncelab.args

Or
> ncvlog -f ncvlog.args
> ncelab -access +r -f ncelab.args

Then,
> ncsim -f ncsim.args

You must specify -linedebug with ncvlog to compile the designs if you want to
set line break points or run the design step by step using interactive mode in the
Verdi platform.
You can check whether IUS linked with the Novas object file for FSDB dumping
successfully by using the call command at the ncsim prompt (use ncsim top -tcl
to enter ncsim prompt). Specifying the call command without any options will
list all the Verilog FSDB dumping commands that are available in the IUS
simulation. For example:
> ncsim -f ncsim.args -tcl
ncsim> call
Available C function names:
fsdbDumpvars

116 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

fsdbDumpvarsES
fsdbDumpMDA
fsdbDumpSVA
fsdbDumpvarsByFile
fsdbSuppress
fsdbDumpon
fsdbDumpoff
fsdbSwitchDumpfile
fsdbDumpfile
fsdbAutoSwitchDumpfile
fsdbDumpFinish
fsdbDumpflush

$fsdbDumpvars
$fsdbDumpMDA
$fsdbDumpSVA
$fsdbDumpvarsByFile
$fsdbSuppress
$fsdbDumpon
$fsdbDumpoff
$fsdbSwitchDumpfile
$fsdbDumpfile
$fsdbAutoSwitchDumpfile
$fsdbDumpFinish
$fsdbDumpflush
$fsdbLog

Dynamic Loading
Dynamic loading is another easy way to link the Novas shared library file for
FSDB dumping and other applications with IUS simultaneously. For dynamic
loading with IUS, the Novas shared library file for FSDB dumping is libIUS.so
These files can be found under the <VERDI_HOME>/share/PLI/IUS/
${PLATFORM}/ directories.

Specify Shared Library Search Path

Set the system shared library search path to include the directory for the Novas
object file for FSDB dumping.
Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}/boot: \
$LD_LIBRARY_PATH

Load and Link the Novas Object File

If you use the ncverilog command to run IUS, specify the
+loadpli1=debpli:novas_pli_boot option with ncverilog. debpli is the library file

Linking Novas Files with Simulators and Enabling FSDB Dumping 117
Linking with Cadence Simulators

name of the dynamic loading version of the FSDB dumper. novas_pli_boot is the
booting function of the FSDB dumper. You also need to specify the +ncaccess+r
or +linedebug option to enable read access of the design object.
> ncverilog +ncaccess+r \
+loadpli1=debpli:novas_pli_boot -f run.f
or
> ncverilog +linedebug \
+loadpli1=debpli:novas_pli_boot -f run.f

NOTE: To load the CFC function library, add the additional option -loadcfc
debcfc:novas_cfc_boot as follows:
> ncverilog +ncaccess+r \
+loadpli1=debpli:novas_pli_boot \
-loadcfc debcfc:novas_cfc_boot \
-f run.f
or
> irun +ncaccess+r \
+loadpli1=debpli:novas_pli_boot \
-loadcfc debcfc:novas_cfc_boot \
-f run.f
The message "*** Registering Novas CFC commands..." will be
displayed once it succeeds.
You must specify +linedebug with ncverilog if you want to set line break points
or run the design step by step using interactive mode in the Verdi platform.
If you use the ncvlog, ncelab, and ncsim trilogy to run the IUS simulation, specify
the -loadpli1 debpli:novas_pli_boot option with ncelab. You must specify the
-access +r option with ncelab or specify the -access +r option with ncvlog to
enable read access of the design object.
> ncvlog -linedebug -f ncvlog.args
> ncelab -loadpli1 debpli:novas_pli_boot -f ncelab.args

or
> ncvlog -f ncvlog.args
> ncelab -access +r -loadpli1 debpli:novas_pli_boot -f
ncelab.args

You must specify -linedebug with ncvlog to compile the design if you want to set
line break points or run the design step by step using interactive mode in the
Verdi platform.

NOTE: For backward compatibility, deb_PLIPtr or debpli_boot can be used as

the booting function.

118 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

If IUS loads the FSDB dumper successfully, you will see the following message
when ncsim starts,
*Verdi* Loading libsscore_ius122.so

Specifying the call command without any options will list all the Verilog FSDB
dumping commands that are available in the IUS simulation. For example:
*Verdi* Loading libsscore_ius122.so
ncsim> run
Simulation stopped via $stop(1) at time 0 FS + 0
./a.v:8 $stop;
ncsim> call
Available C function names:
fsdbDumpvars
fsdbDumpvarsES
fsdbDumpMDA
fsdbDumpSVA
fsdbDumpvarsByFile
fsdbSuppress
fsdbDumpon
fsdbDumpoff
fsdbSwitchDumpfile
fsdbDumpfile
fsdbAutoSwitchDumpfile
fsdbDumpFinish
fsdbDumpflush

$fsdbDumpvars
$fsdbDumpMDA
$fsdbDumpSVA
$fsdbDumpvarsByFile
$fsdbSuppress
$fsdbDumpon
$fsdbDumpoff
$fsdbSwitchDumpfile
$fsdbDumpfile
$fsdbAutoSwitchDumpfile
$fsdbDumpFinish
$fsdbDumpflush
$fsdbLog

Linking Novas Files with Simulators and Enabling FSDB Dumping 119
Linking with Cadence Simulators

IUS (IUS13.1 and Later Versions) - Verilog,

VHDL or Mixed
The Novas object file for FSDB dumping in the ${VERDI_HOME}/share/PLI/
IUS/${PLATFORM} directory is for both a VPI-based and VHPI-based FSDB
dumping and supports signal dumping in pure VHDL or mixed-HDL designs.
There are several files included in the directory.

${VERDI_HOME}/share/PLI/IUS/ FSDB dumping

libpli.so
${PLATFORM}/ task library
${VERDI_HOME}/share/PLI/IUS/
libcfc.so C command library
${PLATFORM}/
${VERDI_HOME}/share/PLI/IUS/ VHDL procedure
libfmi.so
${PLATFORM}/ library
${VERDI_HOME}/share/PLI/IUS/
novas.vhd VHDL procedure
${PLATFORM}/
${VERDI_HOME}/share/PLI/lib/ FSDB dumper
libsscore_iusXXX.so
${PLATFORM}/ engine library

The libpli.so file provides the FSDB Verilog FSDB dumping commands,
libfmi.so file provides the FSDB VHDL foreign functions, and libcfc.so file
provides the FSDB C commands. The novas.vhd contains the FSDB dumping
command in VHDL procedure format. The libsscore_iusXXX.so is the FSDB
dumper engine library.
If you use any of the three previously mentioned programming interfaces as
provided by other vendors or your own, you may have to merge and rebuild these
shared libraries. Otherwise, you can link the FSDB dumper with the Dynamic
Loading (bootstrap) method. The detailed steps for merging these files with other
vendors will be discussed later.

Dynamic Linking
By default, IUS automatically searches for and loads the libpli.so, libfmi.so, and
libcfc.so files according to the LD_LIBRARY_PATH setting. If you do not use any
PLI, CFC or FMI programs from other vendors or your own, you can directly use
these files from the Novas package.
To link the Novas object files for FSDB dumping with IUS, specify the shared
library path, and then compile and include the FSDB dumping commands.

120 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

Specify Shared Library Search Path

Set the system shared library search path to include the directory of the Novas
object file for FSDB dumping before running ncelab and ncsim.
Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}: \
$LD_LIBRARY_PATH

Compile and Include FSDB Dumping Commands

When invoking FSDB dumping commands at the simulator command prompt
(“ncsimv >”) or in VHDL design is needed, one of the following methods must
be used to compile and include the FSDB dumping commands.

Method 1: Using ncvhdl, ncvlog, ncelab and ncsim:

1. Compile the novas.vhd file into the default design working library. This
VHDL file is found in the <VERDI_HOME>/share/PLI/IUS/
${PLATFORM} directory.
> ncvhdl -message \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}/novas.vhd

The novas.vhd file contains the declarations of the FSDB foreign functions
in the pkg and novas packages.
2. Use the novas package in any VHDL files that call any FSDB foreign
functions. Assume the novas.vhd file is compiled into the default working
library. Use the novas package in the VHDL code as shown in the following
example:
library IEEE;
use IEEE.std_logic_1164.all;
library work;
use work.novas.all;

The following example shows how to include the FSDB foreign functions
in the VHDL code.
process
begin
fsdbDumpfile("test.fsdb");
fsdbDumpvars(0, ":");
wait ;
end process;

Linking Novas Files with Simulators and Enabling FSDB Dumping 121
Linking with Cadence Simulators

Re-compile any VHDL files that were modified. To learn more about the usage
and syntax of the FSDB foreign functions, refer to the FSDB Dumping
Commands Used in VHDL section.

Enable Read Access

To enable read access of the design objects, the -linedebug option must be
included with ncvhdl, ncvlog, or the -access +r option specified with ncelab. For
example:
> ncvlog -message -linedebug test.v
or
> ncvhdl -message -linedebug test.vhd
or
> ncelab -message -access +r WORK.TOP:BLK

The -linedebug command line option must be specified with ncvhdl or ncvlog to
compile the design if you want to set line break points or run the design step by
step using interactive mode in the Verdi platform.

Method 2: Using irun:

Use the novas package in any VHDL files that call any FSDB foreign functions.
Assume the novas.vhd file is compiled into the default working library. Use the
novas package in the VHDL code as shown in the following example:
library IEEE;
use IEEE.std_logic_1164.all;
library work;
use work.novas.all;

The following example shows how to include the FSDB foreign functions in the
VHDL code.
process
begin
fsdbDumpfile("test.fsdb");
fsdbDumpvars(0, ":");
wait ;
end process;

Re-compile any VHDL files that were modified. To learn more about the usage
and syntax of the FSDB foreign functions, refer to the FSDB Dumping
Commands Used in VHDL section.

NOTE: The file novas.vhd file must be compiled before other files which use
“use work.novas.all. For example,
Assume the design file vhdl_design.f contains file paths for VHDL

122 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

design portion:
./src/vhdl/TOP.vhd
./src/vhdl/sytem.vhd
./src/vhdl/tb_CPUsystem.vhd
...
Then the path of novas.vhd must be list before other files which include
“use work.novas.all”.
${VERDI_HOME}/share/PLI/IUS/LINUX/novas.vhd
./src/vhdl/TOP.vhd
./src/vhdl/sytem.vhd
./src/vhdl/tb_CPUsystem.vhd
...

Enable Read Access

To enable read access of the design objects, the -linedebug option must be
included. For example:
> irun -message -linedebug –f vhdl_design.f –f verilog_design.f
–loadpli1 debpli:novas_pli_boot

When the linking is successful, a Verdi banner will be shown to indicate the
coordinating FSDB dumper engine is loading:
*Novas* Loading libsscore_iusXXX.so

Dynamic Loading
Additional options can be specified to tell IUS to load the PLI/CFC/FMI libraries
for the Novas FSDB dumper from a non-default filename.

${VERDI_HOME}/share/PLI/IUS/ FSDB Dumper

debpli.so
${PLATFORM}/boot task library
${VERDI_HOME}/share/PLI/IUS/ C command
debcfc.so
${PLATFORM}/boot library
${VERDI_HOME}/share/PLI/IUS/ VHDL procedure
debfmi.so
${PLATFORM}/boot library
${VERDI_HOME}/share/PLI/IUS/
novas.vhd VHDL procedure
${PLATFORM}/boot

It is convenient to directly use the FSDB dumper without rebuilding new

libraries to merge with other third party programs. To dynamically load the
FSDB dumper with IUS, specify the shared library path, and then compile and
include the FSDB dumping commands.

Linking Novas Files with Simulators and Enabling FSDB Dumping 123
Linking with Cadence Simulators

Specify Shared Library Search Path

Set the system shared library search path to include the directory of the dynamic
loading version of the FSDB dumper before running ncelab and ncsim.
Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}/boot:\
$LD_LIBRARY_PATH

Compile and Include FSDB Dumping Commands

This is optional; however, if the FSDB dumping commands will be invoked at
the simulator prompt, in the VHDL design, or run the simulation using
interactive mode in the Verdi platform, the following method must be used to
compile and include the FSDB dumping commands.

Method: Using ncvhdl, ncvlog, ncelab and ncsim:

1. Compile the novas.vhd file into the default design working library. You can
find this VHDL file in the <VERDI_HOME>/share/PLI/IUS/
${PLATFORM} directory.
> ncvhdl -message \
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}/novas.vhd

The following example shows how to include the FSDB foreign functions
in the VHDL code.
process
begin
fsdbDumpfile("test.fsdb");
fsdbDumpvars(0, ":");
wait ;
end process;

124 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

Re-compile any VHDL files that were modified. To learn more about the
usage and syntax of the FSDB foreign functions, refer to the FSDB
Dumping Commands Used in VHDL section.
3. To enable read access of the design objects, the -linedebug option must be
included with ncvhdl, ncvlog, or the -access +r option specified with
ncelab. For example:
> ncvlog -message -linedebug test.v
or
> ncvhdl -message -linedebug test.vhd
or
> ncelab -message -access +r WORK.TOP:BLK

This is optional; however, if you want to set line break points or run the
design step by step using interactive mode in the Verdi platform, the
-linedebug command line option must be specified with ncvlog to compile
the design.
> ncvlog -message -linedebug test.v
or
> ncvhdl -message -linedebug test.vhd

4. Specify the -loadpli1 debpli:novas_pli_boot option with ncelab. The

-access +r option must also be specified with ncelab to enable read access
of the design object.
> ncelab -access +r -loadpli1 debpli:novas_pli_boot \
-VHDLEXPAND WORK.TOP:BLK

NOTE: From Cadence IUS 5.5 and later versions, the symbols in PLI
applications are not exported by default. This may cause a crash if you
load several PLI applications that contain the FSDB writer library. To
avoid the crash, you can add the :export qualifier to each -loadpli
option. This will export the symbols in the PLI applications. For
example:
> ncelab -access +r \
-loadpli1 debpli:novas_pli_boot:export\
-VHDLEXPAND WORK.TOP:BLK

Instead of adding the :export qualifier , you can use the -pli_export
option. For example:
> ncelab -access +r \
-loadpli1 debpli:novas_pli_boot \
-VHDLEXPAND WORK.TOP:BLK -pli_export

Linking Novas Files with Simulators and Enabling FSDB Dumping 125
Linking with Cadence Simulators

5. Specify the -loadcfc debcfc:novas_cfc_boot and -loadfmi

debfmi:novas_fmi_boot options with ncsim.
> ncsim -loadcfc debcfc:novas_cfc_boot \
-loadfmi debfmi:novas_fmi_boot \
WORK.TOP:BLK -tcl

NOTE: For backward compatibility, debcfc_boot can be used as the booting

function of debcfc and use debfmi_boot as the booting function of
debfmi.
When the linking is successful, a Novas banner will be shown to indicate the
coordinating FSDB dumper engine is loading:
*Verdi* Loading libsscore_ius122.so

NOTE: To load the CFC function library with irun, add the additional option
-loadcfc debcfc:novas_cfc_boot as follows:
> irun +ncaccess+r \
+loadpli1=debpli:novas_pli_boot \
-loadcfc debcfc:novas_cfc_boot \
<file(s)>
The message "*** Registering Novas CFC commands..." will be
displayed once it succeeds.

Calling CFC Functions from the ncsim Prompt

To check whether IUS linked the Novas object file for FSDB dumping
successfully, use the call command at the ncsim prompt. Specifying the call
command without any options will list all CFC commands and Verilog FSDB
dumping commands that are available in ncsim. For example:
ncsim> call

*** Registering Novas CFC commands...

Available C function names:
fsdbDumpvars
fsdbDumpvarsES
fsdbDumpMDA
fsdbDumpSVA
fsdbDumpvarsByFile
fsdbSuppress
fsdbDumpon
fsdbDumpoff
fsdbSwitchDumpfile
fsdbDumpfile
fsdbAutoSwitchDumpfile
fsdbDumpFinish
fsdbDumpflush

126 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

$fsdbDumpvars
$fsdbDumpMDA
$fsdbDumpSVA
$fsdbDumpvarsByFile
$fsdbSuppress
$fsdbDumpon
$fsdbDumpoff
$fsdbSwitchDumpfile
$fsdbDumpfile
$fsdbAutoSwitchDumpfile
$fsdbDumpFinish
$fsdbDumpflush
$fsdbLog

The FSDB dumping commands can be called at the ncsim prompt to dump the
design directly. In the following example, two FSDB dumping commands are
called at the ncsim prompt to dump the entire design to test.fsdb:
ncsim> call fsdbDumpfile test.fsdb
ncsim> call fsdbDumpvars 0 :

For more usage information about these FSDB commands, refer to the FSDB
Dumping Commands Used in VHDL section.

NOTE: If you run a pure Verilog design or mixed-HDL design with a Verilog
top module and Novas VHPI/VPI, follow the IUS signals/scopes
naming convention for pure Verilog design to call Novas VHPI/VPI
FSDB dumping commands. If you run a pure VHDL design or mixed-
HDL design with VHDL top module and Novas VHPI/VPI, follow the
NC-SIM signals/scopes naming convention for pure VHDL design to
call Novas VHPI/VPI FSDB dumping commands.

Linking Novas Files with Simulators and Enabling FSDB Dumping 127
Linking with Cadence Simulators

IUS (IUS13.1 and Later Versions) - SystemC

and HDL (Verilog/SystemVerilog, VHDL)
Mixed
SystemC Dumper for Cadence Simulator

Simulator Version Platform Compiler Library Directory

Sun Solaris 5.10
GNU GCC-4.1 No Support
(32-bit)
Linux (32-bit) GNU GCC-4.1 share/PLI/IUS/LINUX
Linux (64-bit) GNU GCC-4.1 share/PLI/IUS/LINUX64
SUSE (32-bit) GNU GCC-4.1 share/PLI/IUS/SUSE32
IUS 13.1/13.2 SUSE (64-bit) GNU GCC-4.1 share/PLI/IUS/SUSE64
14.1/14.2
15.1 Sun Solaris 5.10
GNU GCC-4.4 No Support
(32-bit)
Linux (32-bit) GNU GCC-4.4 share/PLI/IUS/LINUX
Linux (64-bit) GNU GCC-4.4 share/PLI/IUS/LINUX64
SUSE (32-bit) GNU GCC-4.4 share/PLI/IUS/SUSE32
SUSE (64-bit) GNU GCC-4.4 share/PLI/IUS/SUSE64

The libraries are located under the <VERDI_HOME>/ directory.

NC-SystemC Simulator
The following functions are provided to create an FSDB file that contains the
values of signals when values of signals change during the simulation:

Functions
• fsdbDumpfile
• fsdbDumpSC
• fsdbSwitchDumpfile
• fsdbAutoSwitchDumpfile
• fsdbDumpFinish
• fsdbDumpon
• fsdbDumpoff

128 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

Linking the FSDB Dumper Library with the NC-SystemC

Simulator
NOTE: Linux and IUS13.1 are used as an example in the following steps. These
steps are valid only when the dumping commands have been specified
inside the SystemC source code (a .cpp file).
To link the FSDB Dumper Library with the NC-SystemC simulator, use the
following steps:
1. Include the header file fsdb_nc_mix.h.
#include "systemc.h"
#include "fsdb_nc_mix.h"
...

2. Invoke the dumping functions to dump module instance(s) or signal(s)

explicitly.
fsdbDumpSC(0,"my_system");

3. Set the library path.

>setenv LD_LIBRARY_PATH
<VERDI_HOME>/share/PLI/IUS/<PLATFORM>: \
$LD_LIBRARY_PATH

Simulate SystemC Design with ncsc_run

4. Compile your SystemC Design with ncsc_run and run the simulation.
>ncsc_run *.cpp *.v *.vhdl -TOP <top module>

To dump the signals in your mixed SystemC/HDL design, modify your

SystemC code with the following steps:
-I<VERDI_HOME>/share/PLI/IUS/<PLATFORM> \
-L<VERDI_HOME>/share/PLI/IUS/<PLATFORM> \
-lfsdbSC

Mixed SystemC/HDL Dumping Limitations

Non-intuitive names, such as, signal_1, are shown as signal names if no signal
names have been passed in a member initializer for the object.

Linking Novas Files with Simulators and Enabling FSDB Dumping 129
Linking with Cadence Simulators

SystemC Dumper for Cadence SCV

Transaction
To dump transactions, your SystemC code must be modified with the following
steps:
1. Include the header file scv_tr_fsdb.h.
#include "scv.h"
#include "scv_tr_fsdb.h"

Include -I<VERDI_HOME>/share/PLI/IUS/LINUX in the c++ compiler

options you specify to compile your design.
2. Invoke scv_tr_fsdb_init() before opening a file for recording the
transactions.
int sc_main (int argc , char *argv[]) {
scv_tr_fsdb_init();
scv_tr_db db("my_db");
scv_tr_db::set_default_db(&db);
...
}

Then the transaction which records the classes and methods you invoked in your
design will be saved in an FSDB file.
If you use the SCV (CVE) library of Cadence NCSC13.1, NCSC13.2,
NCSC14.1, NCSC14.2, and NCSC15.1 the current release supports the
following libraries for the various C++ compilers and platforms:

130 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with Cadence Simulators

SystemC Verification Transaction Recording Library for Cadence

Simulator Version Platform Compiler Library Directory

The libraries are located under the <VERDI_HOME>/ directory.

To dynamically link the simulation execution file with the SCV FSDB
transaction recording library, you must set the system environment variable
LD_LIBRARY_PATH to include the directories of libscv_tr_fsdb.so.
> setenv LD_LIBRARY_PATH
${VERDI_HOME}/share/PLI/IUS/${PLATFORM}:
$LD_LIBRARY_PATH

If you use the SCV (CVE) library of Cadence IUS 13.1 and use gcc 4.1.x on
Linux (64bit for example), you need to specify additional options to let NCSC
dynamically link the SCV FSDB transaction recording library and the FSDB
writer into the final simulation file. For example:
> cve main.cpp mybus_data.cpp mybus_master.cpp -DSDI -GNU
-L${VERDI_HOME}/share/PLI/IUS/LINUX64
-lscv_tr_fsdb

Linking Novas Files with Simulators and Enabling FSDB Dumping 131
Linking with Cadence Simulators

132 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with ModelSim Simulators

Linking with ModelSim

ModelSim (10.2 or Later Versions) - Verilog

Only
The Novas object files for FSDB dumping support signal dumping in pure
Verilog designs with ModelSim. To dump Verilog signals to the FSDB files, you
can use the FSDB dumping commands at the vsim prompt or in the Verilog code.
The related files for FSDB dumping of pure Verilog designs with ModelSim are
in the <VERDI_HOME>/share/PLI/MODELSIM/${PLATFORM} directory.
The FSDB dumper is a shared library file called novas_fli.so. It has to be loaded
in vsim when running the ModelSim simulation.
To link the Novas object files for FSDB dumping with ModelSim, specify the
shared library path and then load the FSDB dumper.

Specify Shared Library Search Path

Set the system shared library search path to include the directory of the Novas
object files for FSDB dumping.
Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/MODELSIM/${PLATFORM}:\
$LD_LIBRARY_PATH

Linking Novas Files with Simulators and Enabling FSDB Dumping 133
Linking with ModelSim Simulators

Load the FSDB Dumper

There are three methods to load the FSDB dumper novas_fli.so into vsim during
simulation.

Method 1: -pli Option

Use the -pli option with vsim. For example:
Solaris/Linux Platforms
> vsim -pli novas_fli.so top ...

Method 2: veriuser Entry

Set the veriuser entry in the modelsim.ini file. For example:
Solaris/Linux Platforms
[vsim]
...
veriuser=novas_fli.so

Method 3: PLIOBJS Environment Variable

Set the PLIOBJS system environment variable before running vsim. For
example:
Solaris/Linux Platforms
> setenv PLIOBJS "novas_fli.so"

When the linking is successful, a Novas banner will be shown to indicate the
coordinating FSDB dumper engine is loading; otherwise, a failed to load
message is shown instead.
Succeeds:
*Novas* Loading libssocre_mtiXXX.so
Fails:
*Novas* Failed to load FSDB dumper.

Linking with Other Applications

Other vendors often provide their applications as standalone shared library files.
One of the following methods can be used to load different PLI programs into
vsim at the same time.

134 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with ModelSim Simulators

Method 1: -pli Option

Use the -pli option with vsim. For example:
Solaris/Linux Platforms
> vsim -pli novas_fli.so -pli third_party.so top ...

Method 2: veriuser Entry

Set the veriuser entry in the modelsim.ini file. For example:
Solaris/Linux Platforms
[vsim]
...
veriuser=novas_fli.so third_party.so

Method 3: PLIOBJS Environment Variable

Set the PLIOBJS system environment variable before running vsim. For
example:
Solaris/Linux Platforms
> setenv PLIOBJS "novas_fli.so third_party.so"

Linking Novas Files with Simulators and Enabling FSDB Dumping 135
Linking with ModelSim Simulators

ModelSim (SE 10.2 or Later Versions) - VHDL

or Mixed Only
The Novas object files for FSDB dumping support signal dumping in pure
VHDL or mixed-HDL designs with ModelSim. To dump VHDL and Verilog
signals to the FSDB files, you can use the FSDB dumping commands at the vsim
prompt, invoke the FSDB foreign functions in the VHDL code or invoke the
FSDB dumping commands in the Verilog code.
The related files for FSDB dumping of VHDL or mixed-HDL designs with
ModelSim are in the <VERDI_HOME>/share/PLI/MODELSIM/
${PLATFORM} directory. The FSDB dumper is a shared library file called
novas_fli.so. You have to load it in vsim when running the ModelSim simulation.

NOTE: This is a limitation: The FSDB dumper for ModelSim cannot

automatically record each value change of variable types. You have to
use fsdbDumpVariable to repeatedly dump the current value of a
variable.
To link the Novas object files for FSDB dumping with ModelSim, specify the
shared library path, compile and include the FSDB dumping commands, and then
load the FSDB dumper.

Specify Shared Library Search Path

Set the system shared library search path to include the directory for the Novas
object files for FSDB dumping.
Solaris/Linux Platforms
> setenv LD_LIBRARY_PATH \
${VERDI_HOME}/share/PLI/MODELSIM/${PLATFORM}:\
$LD_LIBRARY_PATH

Compile and Include Novas FSDB Dumping Commands

Compile Novas FSDB Dumping Commands to Design
Library
Compile the VHDL file novas.vhd into the default design working library or the
novas design library. This VHDL file is found in the <VERDI_HOME>/share/
PLI/MODELSIM/${PLATFORM} directory.

136 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with ModelSim Simulators

For example, compile novas.vhd into the specific design library:

> setenv MTI_VCO_MODE 32 // Enable 32-bit simulation
or
> setenv MTI_VCO_MODE 64 // Enable 64-bit simulation

> vlib novas

> vcom -work novas \
${VERDI_HOME}/share/PLI/MODELSIM/${PLATFORM}/novas.vhd

Or, compile novas.vhd into the default working design library:

> vcom ${VERDI_HOME}/share/PLI/MODELSIM/${PLATFORM}/novas.vhd

The novas.vhd file contains the declarations of the FSDB foreign functions in the
pkg package and the definition of the novas entity.

Include Novas FSDB Dumping Commands in Design Files

Alternatively, use the pkg package in any VHDL design files that include FSDB
foreign functions. For example, if the novas.vhd is compiled into the novas
library:
library IEEE;
use IEEE.std_logic_1164.all;
library novas;
use novas.pkg.all;

Otherwise, if the novas.vhd is compiled into the default working library:

library IEEE;
use IEEE.std_logic_1164.all;
library work;
use work.pkg.all;

The following example shows how to invoke the FSDB foreign functions in the
VHDL code.
process
begin
fsdbDumpfile("test.fsdb");
fsdbDumpvars(0, "system");
wait ;
end process;

Re-compile all VHDL files you modified.

To learn more about the usage and syntax of the FSDB foreign functions, you can
refer to the FSDB Dumping Commands Used in VHDL section.

Linking Novas Files with Simulators and Enabling FSDB Dumping 137
Linking with ModelSim Simulators

Load the FSDB Dumper

The novas_fli.so Novas object files for FSDB dumping also support the FSDB
dumping commands for Verilog. If any FSDB dumping commands are included
in the Verilog code, vsim must load the novas_fli.so file as a PLI program. This
is optional. There are three methods for loading the FSDB dumper:

Method 1: -pli Option

Use the -pli option with vsim. For example:
Solaris/Linux Platforms
> vsim -pli novas_fli.so novas top ...

Method 2: veriuser Entry

Set the veriuser entry in the modelsim.ini file. For example:
Solaris/Linux Platforms
[vsim]
...
veriuser= novas_fli.so

Method 3: PLIOBJS Environment Variable

Set the PLIOBJS system environment variable before running vsim. For
example:
Solaris/Linux Platforms
> setenv PLIOBJS "novas_fli.so"

Loading the FSDB dumper is optional; however, if FSDB commands will be

invoked at the vsim prompt, or if the ModelSim simulation will be run using
interactive mode in the Verdi platform, the novas entity must be loaded when
starting the ModelSim simulation with vsim. For example, assume novas.vhd is
compiled into the novas library:
Solaris/Linux Platforms
> vsim novas.novas top ...

Then the FSDB commands can be invoked at the vsim prompt. For example:
VSIM 1> fsdbDumpfile test.fsdb (Creates the FSDB file)
VSIM 2> fsdbDumpvars 0 system (Dump all signals from the system
region)

138 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with ModelSim Simulators

The -sva and -assertdebug options should be specified in the vsim command line
options if dumping assertions is desired. For example,
> vsim –c top –pli novas_fli.so –sva -assertdebug

To learn more about the usage and syntax of the FSDB foreign functions, you can
refer to the FSDB Dumping Commands Used in VHDL section.

Linking Novas Files with Simulators and Enabling FSDB Dumping 139
Linking with ModelSim Simulators

ModelSim (SE 10.2 and Later Versions) -

SystemC and HDL (Verilog/ SystemVerilog,
VHDL) Mixed
SystemC Dumper for ModelSim 10.2

Platform Compiler Library Directory

Latest simulator
Sun Solaris (32-bit) share/PLI/MODELSIM/SOL2
supported compiler
Latest simulator
Sun Solaris (64-bit) share/PLI/MODELSIM/SOL7
supported compiler
Latest simulator
Linux (32-bit) share/PLI/MODELSIM /LINUX
supported compiler
Latest simulator share/PLI/MODELSIM /
Linux (64-bit)
supported compiler LINUX64
Latest simulator
SUSE (32-bit) share/PLI/MODELSIM /SUSE32
supported compiler
Latest simulator
SUSE (64-bit) share/PLI/MODELSIM /SUSE64
supported compiler

The libraries are located under the <VERDI_HOME>/ directory.

ModelSim Simulator
The Novas object files for FSDB dumping support signal dumping in mixed
SystemC/HDL designs with ModelSim. To dump signals to the FSDB files, there
are two ways: 1) use the FSDB commands at the vsim prompt and include FSDB
foreign functions in the VHDL code or 2) include the FSDB dumping commands
in the Verilog code. The related Novas object files for FSDB dumping of mixed-
SystemC/HDL designs with ModelSim are in the <VERDI_HOME>/share/PLI/
MODELSIM/${PLATFORM} directory. The FSDB dumper is a shared library
file called novas_fli.so. You have to load it in vsim when running the ModelSim
simulation.

Linking the Novas Library with the ModelSim Simulator

NOTE: Linux and Modelsim10.2 are used as examples in the following steps.

140 Linking Novas Files with Simulators and Enabling FSDB Dumping
Linking with ModelSim Simulators

1. Set the shared library search path of the system to include the directory for
the Novas object files for FSDB dumping.
>setenv LD_LIBRARY_PATH
<VERDI_HOME>/share/PLI/MODELSIM/${PLATFORM}:
$LD_LIBRARY_PATH

Compile Design
2. Create the library.
>vlib novas

3. Do common elaboration on Verilog design.

>vlog +define+NEW_PLI=1 -sv *.v

4. Compile the *.cpp codes.

>sccom -g *.cpp
Link the *.o files to be "systemc.so".
>sccom -link

5. Load the Novas object files for FSDB dumping while running the
simulation:
>vsim -pli \
<VERDI_HOME>/share/PLI/MODELSIM/<PLATFORM>/novas_fli.so \
sc_main -c -do "fsdbDumpfile sc.fsdb; fsdbDumpSC 0; run 1000
ns; exit"

Also, you can invoke the FSDB commands at the vsim prompt. For
example:
VSIM 1>fsdbDumpfile test.fsdb
VSIM 2>fsdbDumpSC 0 system (Dump all signals from the system
region)

Mixed SystemC/HDL Dumping Limitations

Non-intuitive names, such as, signal_1, are shown as signal names if no signal
names have been passed in a member initializer for the object.

Linking Novas Files with Simulators and Enabling FSDB Dumping 141
Linking with ModelSim Simulators

142 Linking Novas Files with Simulators and Enabling FSDB Dumping
SystemC Dumper to Open SystemC Initiative Simulator

SystemC Dumper to Open

SystemC Initiative Simulator

Simulators, Platforms, and Compilers

Supported by Verdi
Automatic SystemC dumper for Open SystemC Inituative 2.0.1

Platform Compiler Library Directory

systemc/old/osci201/lib-
Sun Solaris 2.8 (32-bit) GNU GCC-3.2
solaris_gcc3_2
Linux Redhat 7.2 (32- systemc/old/osci201/lib-
GNU GCC-3.2
bit) linux_gcc3_2

Automatic SystemC Dumper for Open SystemC Initiative 2.1.v1

Platform Compiler Library Directory

systemc/old/osci21v1/lib-
Sun Solaris 2.8 (32-bit) GNU GCC-3.2
solaris_gcc3_2
systemc/old/osci21v1/lib-
GNU GCC-3.2
Linux Redhat 7.2 (32- linux_gcc3_2
bit) systemc/old/osci21v1/lib-
GNU GCC-3.3.2
linux_gcc3_32

SystemC Dumper for Open SystemC Initiative 2.0.1

Platform Compiler Library Directory

systemc/old/osci201/lib-
GNU GCC-2.95
Sun Solaris 2.7/2.8 (32- solaris_gcc2_95
bit) systemc/old/osci201/lib-
GNU GCC-3.2
solaris_gcc3_2

Linking Novas Files with Simulators and Enabling FSDB Dumping 143
SystemC Dumper to Open SystemC Initiative Simulator

systemc/old/osci201/lib-
GNU GCC-2.96
Linux Redhat 7.2 (32- linux_gcc2_96
bit) systemc/old/osci201/lib-
GNU GCC-3.2
linux_gcc3_2
Linux Redhat 6.2 (32- systemc/old/osci201/lib-
GNU GCC-2.95
bit) linux_gcc2_95
x86/MS-Windows NT MS Visual C++ 6.0 systemc/old/osci201/msvc60

SystemC Dumper for Open SystemC Initiative 2.1

Platform Compiler Library Directory

systemc/old/osci21/lib-
GNU GCC-2.95
Sun Solaris 2.7/2.8 (32- solaris_gcc2_95
bit) systemc/old/osci21/lib-
GNU GCC-3.2
solaris_gcc3_2
systemc/old/osci21/lib-
GNU GCC-2.96
Linux Redhat 7.2 (32- linux_gcc2_96
bit) systemc/old/osci21/lib-
GNU GCC-3.2.3
linux_gcc3_23
Linux Redhat 6.2 (32- systemc/old/osci21/lib-
GNU GCC-2.95
bit) linux_gcc2_95

SystemC Dumper for Open SystemC Initiative 2.1v1

Platform Compiler Library Directory

systemc/old/osci21v1/lib-
GNU GCC-2.95
Sun Solaris 2.7/2.8 (32- solaris_gcc2_95
bit) systemc/old/osci21v1/lib-
GNU GCC-3.2
solaris_gcc3_2
systemc/old/osci21v1/lib-
GNU GCC-2.96
linux_gcc2_96
Linux Redhat 7.2 (32- systemc/old/osci21v1/lib-
GNU GCC-3.2.3
bit) linux_gcc3_23
systemc/old/osci21v1/lib-
GNU GCC-2.3.2
linux_gcc3_2

144 Linking Novas Files with Simulators and Enabling FSDB Dumping
SystemC Dumper to Open SystemC Initiative Simulator

SystemC Dumper for Open SystemC Initiative 2.2

Platform Compiler Library Directory

systemc/old/osci22/lib-
GNU GCC-3.2.3
linux_gcc3_23
systemc/old/osci22/lib-
GNU GCC-3.4.x
Linux Redhat 7.2 (32- linux_gcc3_4x
bit) systemc/old/osci22/lib-
GNU GCC-4.0.2
linux_gcc4_02
systemc/old/osci22/lib-
GNU GCC-4.1.1
linux_gcc4_11
systemc/old/osci22/lib-
GNU GCC-4.0.2
Linux Redhat 7.2 (64- linux_gcc4_02_x86_64
bit) systemc/old/osci22/lib-
GNU GCC-4.1.1
linux_gcc4_11_x86_64

The libraries are located under the <VERDI_HOME>/share/PLI directory.

Using the Automatic SystemC Dumper to Dump

SystemC Designs
The libfsdbSC.a library provides the dumping functions that let you create an
FSDB file containing the values of signals as they change during the simulation.
Access to the dumping functions are provided in the header file named
fsdb_trace_file.h.
The following functions are provided:

Functions
• fsdbDumpfile
• fsdbDumpAll
• fsdbDumpvars
• fsdbDumpAllTrans
• fsdbDumpTrans
• fsdbDumpon
• fsdbDumpoff
• fsdbEnableDumpVariable
• fsdbDumpFinish

Linking Novas Files with Simulators and Enabling FSDB Dumping 145
SystemC Dumper to Open SystemC Initiative Simulator

• fsdbSwitchDumpfile
• fsdbAutoSwitchDumpfile
To dump the signals in your SystemC design, you must modify your SystemC
code with the following steps:
1. Include the header file fsdb_trace_file.h.
#include "systemc.h"
#include "fsdb_trace_file.h"
...

2. Invoke the dumping functions to dump module instances or signals

explicitly.
fsdbDumpvars(5,top);

3. Link the libnffw.a and libfsdbSC.a libraries.

You can find libnffw.a in the <VERDI_HOME>/share/FsdbWriter/
$PLATFORM sub-directory.

Linking the Novas Library with the Open SystemC

Initiative Simulator
NOTE: The osci21v1 simulator in the Linux is used as an example in the
following steps.
To build a SystemC executable that contains the Novas PLI application
functions, use the following steps:
1. Set the library path.
>setenv LD_LIBRARY_PATH
<VERDI_HOME>/share/FsdbWriter/LINUX_GNC_32:\
$LD_LIBRARY_PATH

2. Compile your design. You should specify the compiler option -gdwarf-2
and -I<VERDI_HOME>/share/PLI/systemc/old/osci21v1/include.
>g++ -gdwarf-2 -c *.cpp
-I<OSCI_INSTALL_DIR>/include
-I<VERDI_HOME>/share/PLI/systemc/osci21v1/include

3. Build an executable file. You should link the libfsdbSC.a and libnffw.a
libraries.
>g++ *.o -o run.x
-L<VERDI_HOME>/share/PLI/systemc/osci21v1/lib-linux_gcc3_2
-L<VERDI_HOME>/share/FsdbWriter/LINUX_GNU_32
-L<OSCI_INSTALL_DIR>/lib-linux_gcc3_2
-lfsdbSC -lnffw -lsystemc

146 Linking Novas Files with Simulators and Enabling FSDB Dumping
SystemC Dumper to Open SystemC Initiative Simulator

SystemC Dumping Limitations

1. This library only supports pure SystemC designs.
2. Non-intuitive names, such as, signal_0, are shown as signal names if no
signal names declared in sc_main function have been passed. For example:
int sc_main(int argc, int argv[]){
sc_signal<int> var1;
sc_signal<int> var2("var2");
...

The name of var1 is "signal_0", and the name of var2 is "var2".

Using the SystemC Dumper to Dump SystemC Designs

The libfsdbSC.a library provides the dumping class and functions that let you
create an FSDB file containing the values of signals as they change during the
simulation. Access to the dumping class and functions are provided in the signal
header file named fsdb_trace_file.h.
The following class and functions are provided:

Class
• fsdb_trace_file

Functions
• fsdbDumpvars
• fsdbDumpOn
• fsdbDumpOff
• fsdb_trace
To dump the signals in your SystemC design, you must modify your SystemC
code with the following steps:
1. Include the header file fsdb_trace_file.h.
#include "systemc.h"
#include " fsdb_trace_file.h "
...

2. Create the trace file at the top level after all modules and signals have been
instantiated.
fsdb_trace_file *my_trace_file;
my_trace_file = new fsdb_trace_file("dump.fsdb");

Linking Novas Files with Simulators and Enabling FSDB Dumping 147
SystemC Dumper to Open SystemC Initiative Simulator

3. Invoke the dumping functions to dump module instances or signals

explicitly.
fsdbDumpvars(my_trace_file)

4. Link the libnffw.a and libfsdbSC.a libraries.

You can find libnffw.a in the <VERDI_HOME>/share/FsdbWriter/
$PLATFORM sub-directory.

Linking the Novas Library with the Open SystemC

Initiative Simulator
NOTE: Linux and gcc2.96 are used as examples in the following steps.

To build a SystemC executable that contains the Novas PLI application

functions, use the following steps:
1. Set the library path.
setenv LD_LIBRARY_PATH
<VERDI_HOME>/share/FsdbWriter/LINUX_GNU_296: $LD_LIBRARY_PATH

2. Compile your design. You should specify the compiler option

-I<VERDI_HOME>/share/PLI/systemc/<sc_version_dependant>/include.
g++ -c *.cpp
-I<VERDI_HOME>/include
-I<VERDI_HOME>/share/PLI/systemc/include
-I<VERDI_HOME>/share/PLI/systemc/old/osci201/include

3. Build an executable file. You should link the libfsdbSC.a and libnffw.a
libraries.
g++ *.o -o run.x
-L<VERDI_HOME>/share/PLI/systemc/old/osci201/lib-
linux_gcc2_96
-L<VERDI_HOME>/share/FsdbWriter/LINUX_GNU_296
-L<OSCI_INSTALL_DIR>/lib-linux_gcc2_06
-lfsdbSC -lnffw -lsystemc

Data and Object Types Supported by the SystemC and C

Programming Languages
In the simulator IUS 13.1, VCS MX 2014.03, ModelSim SE 10.2 and their later
versions, the System C and C programming languages support the following

148 Linking Novas Files with Simulators and Enabling FSDB Dumping
SystemC Dumper to Open SystemC Initiative Simulator

object and data types: sc_signal<T>, sc_buffer<T>, and sc_in<T>/sc_out<T>/

sc_inout<T>. The data types can be inserted as the <T> in the object types.

NOTE: If the dumper option is not specified, the sc_signal<T>, sc_buffer<T>,

and sc_in<T>/sc_out<T>/sc_inout<T> types will be dumped
automatically.

Supported Data Types

Language Data Type

sc_bit
sc_logic
sc_bv<w>
sc_lv<w>
sc_int<w>
sc_uint<w>
SystemC
sc_signed
sc_unsigned
sc_fxval
sc_fxval_fast
sc_fxnum
sc_fxnum_fast
char
unsigned char
short
unsigned short
int
C unsigned int
long
unsigned long
long long
unsigned long long
double

Linking Novas Files with Simulators and Enabling FSDB Dumping 149
SystemC Dumper to Open SystemC Initiative Simulator

For the resolved signal, the System C program language supports the object types
in the simulator IUS 13.1, VCS MX 2014.03, ModelSim SE 10.2 and their later
versions.
SystemC Supported Object Types

Simulator Version Object Type

sc_signal_rv<w>
sc_in_rv<w>
sc_inout_rv<w>
sc_out<w>
IUS 13.1 and later version
sc_logic_resolved
sc_in_resolved
sc_inout_resolved
sc_out_resolved
sc_signal_rv<w>
sc_in_rv<w>
VCS MX 2014.03 and later version sc_logic_resolved
sc_in_resolved
sc_inout_resolved
sc_signal_rv<w>
sc_in_rv<w>
ModelSim SE 10.2 and later version sc_logic_resolved
sc_in_resolved
sc_inout_resolved

150 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix A: Third Party Integration

Appendix A: Third Party

Integration

Linking with Synopsys VCS Simulators (VCS

2014.03 or Later Versions)

Using the Stackable -P Option for Specifying Multiple

Libraries
When using the Novas object files along with custom PLI libraries (which may
use the open FSDB library, FsdbWriter), refer to the <VERDI_HOME>/demo/
dumper/vcs_link_third_party for a detailed example.

Linking with Cadence Simulators (IUS 13.1

or Later Versions)
Refer to the <VERDI_HOME>/demo/dumper directory for detailed examples of
the different methods to link the Cadence simulator and other third party
integrations with the Novas object files for FSDB dumping.

Linking Novas Files with Simulators and Enabling FSDB Dumping 151
Appendix A: Third Party Integration

Verilog Only
Dynamically Link Novas Object File with Other
Applications
Use one of the following methods to dynamically link IUS with the Novas object
files for FSDB dumping alone or with other applications. C code will be used to
demonstrate how to integrate the Novas object files for FSDB dumping with a
third party application/library.

Method 1 - Bootstrap Function

If the other applications support bootstrap functions for dynamic loading, the
-loadpli1 option can be used with ncelab (or the +loadpli1 option with ncverilog)
to load them and then dynamic linking can be used to load the libpli.so (libpli.sl)
shared library of the Novas object files for FSDB dumping by default. If the
third-party’s application/library supports bootstrap method, it should contain its
own boot function (its own veriuser.c in binary format). Refer to the
<VERDI_HOME>/demo/dumper/vlog_pli_dynamic_boot directory for a
detailed example.

NOTE: The FSDB dumper has no dependency on any other symbol. If a third
party application has the dependency of symbols located in the FSDB
dumper, use the “:export” qualifier as shown below when loading the
FSDB Dumper, or refer to the simulator’s manual regarding
“-PLI_Export” for details.
> ncverilog +ncaccess+r -f run.f\
+loadpli1=debpli:novas_pli_boot:export \
+loadpli1=<third_party_PLI_path>:<boot_fn>:expo
rt
or
> ncelab -access +r -f ncelab.args\
-loadpli1 debpli:novas_pli_boot:export \
-loadpli1 <3rd_party_PLI_path>:<boot_fn>:export

Instead of adding the :export qualifier, you can use the -pli_export
option. For example:
> ncverilog +ncaccess+r +ncpli_export -f run.f\
+loadpli1=debpli:novas_pli_boot \
+loadpli1=<third_party_PLI_path>:<boot_fn>
or
> ncelab -access +r -pli_export -f ncelab.args\
-loadpli1 debpli:novas_pli_boot \
-loadpli1 <third_party_PLI_path>:<boot_fn>

152 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix A: Third Party Integration

Method 2 - Single Shared Library

The Novas object files for FSDB dumping can be merged with other applications
to become a single shared library. A custom veriuser.c file can be merged with
the one that the FSDB dumper provides, and archive the merged modified
veriuser.o, custom sample binary and FSDB dumper object file together to
become a single share library. After that, there is only one single share library that
needs to be linked while calling the FSDB dumping commands or the custom
task commands. Refer to the <VERDI_HOME>/demo/dumper/vlog_custom_pli
directory for a detailed example.

NOTE: For the case that making standalone “ncelab” and “ncsim” excutable
object is desired, try with the “make –f Makefile.nc static” method as
addressed in the example.

Method 3 – Single CFC Shared Library

The CFC library is specifically for commands called under Tcl command
prompt, “ncsim>”. This method merges the custom CFC library with the Novas
CFC library to become a single shared library, libcfc.so. A custom cfc_user.c file
can be merged with the novascfc.c file that the FSDB dumper provides, and
archive the merged modified novascfc.o, custom sample binary and FSDB
dumper object file together to become a single share library, libcfc.so. After that,
there is only one single share library that needs to be linked while calling the
FSDB dumping commands or the custom task commands under the simulator
command prompt, “ncsim>”. Refer to the <VERDI_HOME>/demo/dumper/
vlog_cfc_pli directory for a detailed example.

NOTE: For the situation where making standalone “ncelab” and “ncsim”
excuteable objects is desired, try the “make –f Makefile.nc static”
method as addressed in the example.

Static Linking
The Novas object files for FSDB dumping can be statically linked with the IUS
executable files ncelab and ncsim. If this method is selected, new ncelab and
ncsim executable files need to be built when a different release of IUS or the
Verdi platform is used. Refer to the <VERDI_HOME>/demo/dumper/
vlog_static_link directory for a detailed example.

Linking Novas Files with Simulators and Enabling FSDB Dumping 153
Appendix A: Third Party Integration

VHDL Only
In pure VHDL designs, the FMI library is required for commands specified
inside the VHDL design and the CFC library is required for commands called
under the Tcl command prompt in interactive mode. Third-party CFC and FMI
can be merged into the FSDB dumper's CFC and FMI libraries. Refer to the
<VERDI_HOME>/demo/dumper/vhdl_cfc_fmi directory for a detailed example.

Mixed Verilog/VHDL
In mixed language designs, the FMI library is required for commands specified
inside the VHDL design, the PLI library is required for commands specified
inside the Verilog design and the CFC library is required for commands called
under the Tcl command prompt in interactive mode. Third-party PLI, CFC, and
FMI can be merged into the FSDB dumper's PLI, CFC, and FMI libraries. Refer
to the <VERDI_HOME>/demo/dumper/mixed_cfc_fmi_pli directory for a
detailed example.

Linking with ModelSim Simulators (10.2 or

Later Versions)

Build a New Shared Library to Include Other

Applications
You may want to load just one shared library into vsim that contains the Novas
object files for FSDB dumping and other applications (your own or other
vendors). Refer to the <VERDI_HOME>/demo/dumper/
modelsim_link_third_party for a detailed example.

154 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix B: Required VCS MX Options for Linking with FSDB Dumper

Appendix B: Required VCS

MX Options for Linking with
FSDB Dumper
The following table is a quick reference of required VCS options when linking
with FSDB dumping. It was based on VCS MX 2013.06 and is valid until
VCS MX 2014.12 version.

NOTE: The list below is subject to change without notice due to changes in
different simulator versions. Refer to the appropriate simulator manual
for the latest information.

Affected
Command Related FSDB
Option or Setting Requirement
-line Dumping Commands
Executable

$fsdbDumpvars,
Required for all FSDB $fsdbDumpMDA,
commands related to $fsdbDumpSVA,
vcs +vcsd
dumping value change data $fsdbDumpvarsByFile
of any kind. ($fsdbDumpvarsToFile
)

$fsdbDumpvars,
Required for all FSDB $fsdbDumpMDA,
commands related to $fsdbDumpSVA,
vcs +vpi
dumping value change data $fsdbDumpvarsByFile
of any kind. ($fsdbDumpvarsToFile
)

Required for FSDB dumping

$fsdbDumpMDA,
vcs +memcbk command where MDA/
$fsdbDumpvars +mda
memory is desired.

Linking Novas Files with Simulators and Enabling FSDB Dumping 155
Appendix B: Required VCS MX Options for Linking with FSDB Dumper

Affected
Command Related FSDB
Option or Setting Requirement
-line Dumping Commands
Executable

Required for UCLI mode

(interactive "ucli%" All FSDB commands in
command prompt). The “ucli%” command
additional "-load prompt:
libnovas.so: > simv -ucli
vcs -ucli FSDBDumpCmd" option is ucli% fsdbDumpvars 0
also required. or
NOTE: -debug_access+pp/ > simv -ucli -i cmd.do
-debug_access/- cmd.do file contains
debug_access+all should fsdbDumpvars 0
cover this.

Optional, equivalent to an
vcs -debug_access+pp aggregation of +vcsd +vpi All
+memcbk +cli+1 and -ucli.

Optional, equivalent to an
aggregation of -
vcs -debug_access debug_access+pp plus All
+cli+4; able to force net and
reg, set value, time break.

Optional, equivalent to
-debug_access plus line
All (specifically for
stepping, debugging;
vcs -debug_access+all fsdbDumpvars
required by dumping
+trace_process)
variables under VHDL
process.

Required for situations

where environments
(scripts) are bound with the
OLD FSDB dumper ( or
vcs -rdynamic N/A
FsdbWriter) in static linking
and cannot be removed.
NOTE: Valid for LINUX
platform.

156 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix B: Required VCS MX Options for Linking with FSDB Dumper

Affected
Command Related FSDB
Option or Setting Requirement
-line Dumping Commands
Executable

-P $VERDI_
HOME/shared/PLI/
VCS/
$PLATFORM/ Required for all Verilog/SV
vcs All
novas.tab \ FSDB dumping.
$VERDI_HOME/
shared/PLI/VCS/
$PLATFORM/pli.a

Required for all FSDB

dumping commands in
UCLI mode entry.
-load libnovas.so:
vcs NOTE: Valid for pure All
FSDBDumpCmd
Verilog/SV or mixed
(Verilog/SV and VHDL)
scenarios.

Required for all FSDB

-vhpi dumping commands in
vcs novas:FSDBDump UCLI mode entry. All
Cmd NOTE: Valid for pure
VHDL scenarios.

For smooth migration of

conventional "-fsdb" users to
adopt the new FSDB
dumper.
NOTE:
1. Valid since VCS2013.06
version.
2. "VERDI_HOME"
vcs -fsdb/-fsdb_pp All
environment variable is
required to be set to the
Verdi installation directory.
3. -fsdb_new: also set VCS
debug option: "+cli+3".
-fsdb_pp_new: also set
VCS debug option:
"+vcsd+cli+1".

To enable parallel FSDB

+fsdb+parallel=
simv dumping with all VCS All
on
versions.

Linking Novas Files with Simulators and Enabling FSDB Dumping 157
Appendix B: Required VCS MX Options for Linking with FSDB Dumper

Affected
Command Related FSDB
Option or Setting Requirement
-line Dumping Commands
Executable

setenv
Required for loading FSDB
LD_LIBRARY
dumper's core library,
_PATH
simv VHDL procedure call entry All
${VERDI_HOME
library or UCLI command
}/share/PLI/VCS/
entry library.
${PLATFORM}

158 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix C: Dumping to Multiple Files with FSDB Commands

Appendix C: Dumping to
Multiple Files with FSDB
Commands

Overview
The FSDB dumper provides a more flexible method to have multiple dumping
files opened to collect different dumping data in a simulation run. With simple
rules, each dumping file can be configured with different combinations, such as
dumping scopes, dump off time or dump on time, dumping tasks, and options.
By using dumping tasks and the scheme of multiple files, dumping multiple
specified modules into different files can be easily achieved.

+fsdbfile+ Aware Dumping Commands

The following dump commands can take effect with the +fsdbfile+ option:
• $fsdbDumpvars
• $fsdbDumpMDA
• $fsdbDumpSVA
• $fsdbDumpvarsByFile
• $fsdbDumpoff
• $fsdbDumpon
• $fsdbDumpfile
• $fsdbAutoSwitchDumpfile

NOTE: $fsdbDumpfile and $fsdbAutoSwitchDumpfile do not require the

+fsdbfile+ prefix.

Linking Novas Files with Simulators and Enabling FSDB Dumping 159
Appendix C: Dumping to Multiple Files with FSDB Commands

Default FSDB Files and Target FSDB Files

The first created FSDB file that is opened for collecting simulation data is
defined as the default FSDB file.
$fsdbDumpfile("my_first");
$fsdbDumpvars("+all");

• The first command specifies the default file name as my_first.fsdb.

• The second command performs dumpvars +all to my_first.fsdb.

If more than one FSDB file is opened for dumping, the +fsdbfile+target option
is used to distinguish the affected FSDB files.
$fsdbDumpfile("my_1st");
$fsdbDumpfile("my_2nd");
$fsdbDumpvars(0, top.inst1, "+fsdbfile+my_2nd");

• The first command specifies the default file name as my_1st.fsdb.

• The third command dumps "top.inst1" to the target FSDB file
my_2nd.fsdb.
• my_1st.fsdb contains nothing.

Subsequent dumping tasks without specifying the +fsdbfile+target option will

affect the default FSDB file.
$fsdbDumpfile("my_1st");
$fsdbDumpfile("my_2nd");
$fsdbDumpvars(top.inst1, "+fsdbfile+my_2nd");
$fsdbDumpvars(top.inst2);

• The first command specifies the default file name as my_1st.fsdb.

• The third command dumps signals under the scope "top.inst1" to the
target FSDB file my_2nd.fsdb.
• The fourth command dumps signals under the scope "top.inst2" to the
default FSDB file my_1st.fsdb.

The default FSDB file name can either be specified with the first $fsdbDumpfile
or +fsdbfile+filename task argument, or be given by the default file name,
novas.fsdb.

160 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix C: Dumping to Multiple Files with FSDB Commands

For $fsdbDumpoff and $fsdbDumpon commands, if the target FSDB file is not
specified, all opened FSDB files in the current simulation will be affected.

Usage Examples
Example 1
$fsdbDumpvars("+all");
$fsdbDumpMDA("+fsdbfile+my_mda_file");
$fsdbDumpSVA();

1. The first command creates the default file (the file name is novas.fsdb) and
performs dumpvars +all to the novas.fsdb file.
2. The second command dumps MDAs to the my_mda_file.fsdb file.
3. The third command dumps SVA to the default file novas.fsdb.
Example 2
$fsdbDumpvars(top.inst1, "+fsdbfile+my_inst1");
$fsdbDumpvars(top.inst2, "+fsdbfile+my_inst2", "+all");
$fsdbDumpMDA(top.inst1);
$fsdbDumpSVA(top.inst2, "+fsdbfile+my_inst2");

1. The first command specifies the default file name as my_inst1.fsdb.

2. The first command specifies to dump signals under the scope "top.inst1" to
the my_inst1.fsdb file.
3. The second command dumps "all" under "top.inst2" to my_inst2.fsdb.
4. The third command also dumps MDAs under "top.inst1" to the default file.
5. The fourth command dumps SVA under "top.inst2" to my_inst2.fsdb.
Example 3
$fsdbDumpvars(top.inst1, "+fsdbfile+my_inst1", "+all");
$fsdbDumpvars(top.inst2, "+fsdbfile+my_inst2", "+all");
#100 $fsdbDumpoff("+fsdbfile+my_inst1");
#100 $fsdbDumpoff("+fsdbfile+my_inst2");
#100$fsdbDumpon();

1. The first command specifies the default file name as my_inst1.fsdb.

2. The first command dumps "all" under "top.inst1" to my_inst1.fsdb and the
second command dumps "all" under "top.inst2" to my_inst2.fsdb.
3. my_inst1.fsdb performs "dump off" at simulation time 100 and
my_inst2.fsdb performs "dump off" at time 200.
4. At simulation time 300, both my_inst1.fsdb and my_inst2.fsdb perform
"dump on", because the $fsdbDumpon command specifies no specific target
file, and all opened FSDB files in the current simulation will be affected.

Linking Novas Files with Simulators and Enabling FSDB Dumping 161
Appendix C: Dumping to Multiple Files with FSDB Commands

Example 4
$fsdbAutoSwitchDumpfile(10, "my_full_dump", 0);
$fsdbDumpvars("+all");
$fsdbDumpSVA("+fsdbfile+my_sva");

1. The first command specifies the default file name as my_full_dump.fsdb.

2. The second command dumps "all" to the my_full_dump.fsdb file.
3. The third command dumps SVA to my_sva.fsdb.
4. Whenever file size reaches 10 MB, switching files automatically takes
effect on the my_full_dump.fsdb file.

162 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix D: Switch Dumping with Simulator Restore

Appendix D: Switch Dumping

with Simulator Restore
The FSDB dumper supports switching the FSDB dump file when the restore
command of the simulator is executed. When the restore (or restart) command
of the simulator is executed for the first time, the FSDB dumping will be
redirected to a new FSDB file named as <original_FSDB_name>.restore.FSDB.
The original dumping files will be saved and closed. If multiple FSDB files are
being dumped, each of them will be redirected to a different restore FSDB file.
When the restore command of the simulator is executed several times, the
<original_FSDB_name>.restore.FSDB files will be overridden.

NOTE: For VCS simulator, new restore file will not be created after the restore
command of the simulator is executed.

Synopsys VCS Simulators

When the restore command is executed for the first time, the dumping will be
saved to the original dump file. If multiple FSDB files are dumped, all of them
will be saved to the original dump file.

Simulator Commands
• save
• restore
Refer to the VCS user’s manual for details of the save and restore commands.

NOTE: The environment variable VCS_ENABLE_ASLR_SUPPORT must be

set to 1 before running the simulation. For example:
> setenv VCS_ENABLE_ASLR_SUPPORT 1

Example
ucli> fsdbDumpvars {"+fsdbfile+save.fsdb"}
Create the FSDB file "save.fsdb".

Linking Novas Files with Simulators and Enabling FSDB Dumping 163
Appendix D: Switch Dumping with Simulator Restore

ucli> run 5ns

ucli> save saveData
Save a copy of the simulation data at the time for later restore.
ucli> run 20ns
ucli> restore saveData
When the simulation is restored to the previously saved time point, the file
"save.fsdb" will be restored to 5ns.
ucli> run 30ns
ucli> exit

The following FSDB file and associated time range will be the result:
• save.fsdb: 0ns ~ 35ns

NOTE: User-defined Tcl procedures that were loaded before saving will not be
saved when executing the save command. To use these Tcl procedures
after the restore process, load these Tcl procedures again.

ModelSim Simulators
When the restore command is executed for the first time, the dumping will be
redirected to a new FSDB file named as <original_FSDB_name>.restore.FSDB.
If multiple FSDB files are being dumped, each of them will be redirected to a
different restore FSDB file.

Simulator Commands
• checkpoint
• restore
Refer to the ModelSim user’s manual for details of the checkpoint and restore
commands.

Example
vsim> fsdbDumpvars +fsdbfile+save.fsdb
Create the FSDB file "save.fsdb".
vsim> run 10ns
vsim> checkpoint saveData
Save a copy of the simulation data at the time for later restore.
vsim> run 20ns

164 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix D: Switch Dumping with Simulator Restore

vsim> restore saveData

When the simulation is restored to the previously saved time point, the file
"save.fsdb" will be saved and closed, and the new file "save.restore.fsdb"
will be created.
vsim> run 30ns
vsim> quit

The following FSDB files and associated time ranges will be the result:
• save.fsdb: 0ns ~ 30ns
• save.restore.fsdb: 10ns ~ 40ns

Cadence IUS Simulators

When the restart command is executed for the first time, the dumping will be
redirected to a new FSDB file named as <original_FSDB_name>.restore.FSDB.
If multiple FSDB files are being dumped, each of them will be redirected to a
different restore FSDB file.

Simulator Commands
• save
• restart
Refer to the IUS user’s manual for details of the save and restart commands.

Example
ncsim> call fsdbDumpvars +fsdbfile+save.fsdb
Create the FSDB file "save.fsdb".
ncsim> run 20ns
ncsim> save saveData
Save a copy of the simulation data at the time for later restore.
ncsim> run 20ns
ncsim> restart saveData
When the simulation is restored to the previously saved time point, the file
"save.fsdb" will be saved and closed, and the new file "save.restore.fsdb"
will be created.
ncsim> run 10ns
ncsim> exit

Linking Novas Files with Simulators and Enabling FSDB Dumping 165
Appendix D: Switch Dumping with Simulator Restore

The following FSDB files and associated time ranges will be the result:
• save.fsdb: 0ns ~ 40ns
• save.restore.fsdb: 20ns ~ 30ns

Miscellaneous Rules
The miscellaneous rules apply in the following situations:
• When the restore command is executed several times.
• When the FSDB name happens to have a "restore.fsdb" extension.
• When restoring in a new simulation session.

restore Command Executed Multiple Times

When the restore command is executed several times, the
<original_FSDB_name>.restore.FSDB files will be overridden.

Example in IUS
ncsim> call fsdbDumpvars +fsdbfile+save.fsdb
Create the FSDB file "save.fsdb".
ncsim> run 20ns
ncsim> save saveData
Save a copy of the simulation data at the time for later restore.
ncsim> run 20ns
ncsim> restart saveData
When the simulation is restored to the previously saved time point, the file
"save.fsdb" will be saved and closed, and the new file "save.restore.fsdb"
will be created.
ncsim> run 10ns
ncsim> restart saveData
When the simulation is restored to the previously saved time point, the file
"save.restore.fsdb" will be recreated and this file will overwrite the previous
one.
ncsim> run 40ns
ncsim> exit

166 Linking Novas Files with Simulators and Enabling FSDB Dumping
Appendix D: Switch Dumping with Simulator Restore

FSDB File with 'restore.fsdb' Extension

When the FSDB name happens to have a "restore.fsdb" extension, then the
restore FSDB file name will be the same.

Example in VCS
ucli> fsdbDumpvars {"+fsdbfile+save.restore.fsdb"}
Create the FSDB file "save.restore.fsdb".
ucli> run 5ns
ucli> save saveData
Save a copy of the simulation data at the time for later restore.
ucli> run 20ns
ucli> restore saveData
When the simulation is restored to the previously saved time point, the file
"save.restore.fsdb" will be recreated and this will overwrite the previous
one.
ucli> run 30ns
ucli> exit

Restore in a New Simulation Session

For IUS and Modelsim, restoring in a new simulation session is an independent
dumper process. For VCS, the environment is exactly the same as in a single
session.

Example in IUS
• The first simulation session:
ncsim> call fsdbDumpvars +fsdbfile+save.fsdb

The file "save.fsdb" will be created.

ncsim> run 20ns
ncsim> save saveData
ncsim> run 20ns
ncsim> restart saveData

The file "save.restore.fsdb" will be created.

ncsim> run 10ns
ncsim> exit

• The second simulation session:

ncsim> restart saveData
ncsim> call fsdbDumpvars +fsdbfile+save.fsdb

Linking Novas Files with Simulators and Enabling FSDB Dumping 167
Appendix D: Switch Dumping with Simulator Restore

The file "save.fsdb" will be created.

Example in VCS
• The first simulation session:
ucli> fsdbDumpvars {"+fsdbfile+save.fsdb" "+all"}

Create the file "save.fsdb".

ucli> run 5ns
ucli> save saveData
ucli> run 30ns
ucli> exit

• The second simulation session:

ucli> restore saveData

The file "save.restore.fsdb" is created with the "+all" option.

ucli> run 20ns
ucli> exit

168 Linking Novas Files with Simulators and Enabling FSDB Dumping

Blaine Readler - Verilog by Example - A Concise Introduction For FPGA Design (2011, Full Arc Press) PDF
100% (1)
Blaine Readler - Verilog by Example - A Concise Introduction For FPGA Design (2011, Full Arc Press) PDF
114 pages
Blaine Readler - Verilog by Example - A Concise Introduction For FPGA Design (2011, Full Arc Press) PDF
100% (1)
Blaine Readler - Verilog by Example - A Concise Introduction For FPGA Design (2011, Full Arc Press) PDF
114 pages
Verdi-Quick Ref PDF
100% (1)
Verdi-Quick Ref PDF
7 pages
Verdi Basic Training and Technical Overview
No ratings yet
Verdi Basic Training and Technical Overview
136 pages
Verification Compiler User Guide, Version L-2016.06-SP
100% (1)
Verification Compiler User Guide, Version L-2016.06-SP
422 pages
What Is The Best Site For Finding Dumps 2 - Quora
No ratings yet
What Is The Best Site For Finding Dumps 2 - Quora
1 page
SpyGlass 4 6 Training PDF
100% (1)
SpyGlass 4 6 Training PDF
74 pages
SpyGlass MBISTMethodology GuideWare2.0 UserGuide PDF
No ratings yet
SpyGlass MBISTMethodology GuideWare2.0 UserGuide PDF
136 pages
XCELIUM BASIC Vs ADVANCED PROFILER
0% (1)
XCELIUM BASIC Vs ADVANCED PROFILER
9 pages
Tessent AppNote Memory Shared BUS
100% (2)
Tessent AppNote Memory Shared BUS
38 pages
SpyGlass - CDC - Challenges in Hierarchical Convergence - v1.2 - To - Intel
100% (2)
SpyGlass - CDC - Challenges in Hierarchical Convergence - v1.2 - To - Intel
51 pages
Gate Level Simulation
0% (1)
Gate Level Simulation
26 pages
Verilog
100% (1)
Verilog
141 pages
TPV Ug
No ratings yet
TPV Ug
263 pages
Getting Started Lab With Spyglass 450
100% (1)
Getting Started Lab With Spyglass 450
47 pages
CDC User
67% (3)
CDC User
479 pages
2019 21 Interviews
No ratings yet
2019 21 Interviews
17 pages
DFT With Tetramax PDF
100% (1)
DFT With Tetramax PDF
33 pages
Short Questions of OOAD-solutions
No ratings yet
Short Questions of OOAD-solutions
3 pages
Rain Technology Seminar
67% (3)
Rain Technology Seminar
18 pages
Untitled
No ratings yet
Untitled
907 pages
Salon Vina - Katalog 2017
No ratings yet
Salon Vina - Katalog 2017
76 pages
The Missing Link: The Testbench To Dut Connection: David Rich - Mentor A Siemens Business
No ratings yet
The Missing Link: The Testbench To Dut Connection: David Rich - Mentor A Siemens Business
10 pages
Create Login Form As Shown Below.: Fes/Kjm
No ratings yet
Create Login Form As Shown Below.: Fes/Kjm
10 pages
RTL Lint Checking Lec
100% (1)
RTL Lint Checking Lec
49 pages
Prime Ric 15
100% (1)
Prime Ric 15
33 pages
Sony Xperia XA1 Plus - Schematic Diagarm
No ratings yet
Sony Xperia XA1 Plus - Schematic Diagarm
115 pages
0212 Jefford Wine and Astonishment 0612
No ratings yet
0212 Jefford Wine and Astonishment 0612
21 pages
CDC User
0% (2)
CDC User
493 pages
Symmetrix SRDF Product Guide
No ratings yet
Symmetrix SRDF Product Guide
136 pages
Magnetic Switches and Accessories
No ratings yet
Magnetic Switches and Accessories
13 pages
VAPL Facade Pattern
No ratings yet
VAPL Facade Pattern
5 pages
Linux Kernel Driver
No ratings yet
Linux Kernel Driver
32 pages
Configuring SSL
No ratings yet
Configuring SSL
61 pages
MSFT Cloud Architecture Security
No ratings yet
MSFT Cloud Architecture Security
14 pages
Linking Novas Files With Simulators and Enabling FSDB Dumping
88% (8)
Linking Novas Files With Simulators and Enabling FSDB Dumping
134 pages
A Comparative Study of Mobile Phone's Operating Systems
No ratings yet
A Comparative Study of Mobile Phone's Operating Systems
7 pages
Texxt
No ratings yet
Texxt
12 pages
Gate Level Simulations
100% (1)
Gate Level Simulations
6 pages
5 Zasto-Analiza: Wcom World Class Operations Management
No ratings yet
5 Zasto-Analiza: Wcom World Class Operations Management
12 pages
VAPL Strategy Pattern
No ratings yet
VAPL Strategy Pattern
5 pages
SpyGlass CDC
No ratings yet
SpyGlass CDC
11 pages
VAPL Resource Sharing Pattern
No ratings yet
VAPL Resource Sharing Pattern
3 pages
VAPL BFM Notification Pattern
No ratings yet
VAPL BFM Notification Pattern
3 pages
Data Profiling Guide: Informatica Powercenter
No ratings yet
Data Profiling Guide: Informatica Powercenter
92 pages
Linux OS
No ratings yet
Linux OS
10 pages
Aim Theory::: Study and Working of WEKA Tool
No ratings yet
Aim Theory::: Study and Working of WEKA Tool
3 pages
Getting Started Lab With SpyGlass 450
50% (2)
Getting Started Lab With SpyGlass 450
47 pages
AWS S3 - Integration - of - SFG
No ratings yet
AWS S3 - Integration - of - SFG
8 pages
Beauty Parlour Mangement System
No ratings yet
Beauty Parlour Mangement System
19 pages
Atpg GD PDF
100% (1)
Atpg GD PDF
400 pages
Dip Switch Settings Read
100% (1)
Dip Switch Settings Read
3 pages
Broadsoft Partner Configuration Guide
No ratings yet
Broadsoft Partner Configuration Guide
46 pages
DFT Questions
100% (2)
DFT Questions
8 pages
Debussy 0407
No ratings yet
Debussy 0407
117 pages
Creating Menu in Foxpro For DOS - Live To Learn!
0% (1)
Creating Menu in Foxpro For DOS - Live To Learn!
3 pages
IHI0024C Amba Apb Protocol Spec
No ratings yet
IHI0024C Amba Apb Protocol Spec
28 pages
Mbist GD
100% (1)
Mbist GD
350 pages
SV VCS UVM Design Challenges
100% (1)
SV VCS UVM Design Challenges
58 pages
Systemverilog Constraint Layering Via Reusable Randomization Policy Classes Poster
No ratings yet
Systemverilog Constraint Layering Via Reusable Randomization Policy Classes Poster
1 page
DC Tutorial
No ratings yet
DC Tutorial
132 pages
Spy Glass Quick Guide
0% (1)
Spy Glass Quick Guide
18 pages
Systemverilog For RTL Design Workshop: Lab Guide
No ratings yet
Systemverilog For RTL Design Workshop: Lab Guide
36 pages
Reminder + Radar: Getting Things Done One Place at A Time
No ratings yet
Reminder + Radar: Getting Things Done One Place at A Time
21 pages
Social Media Half Yearly Report 2023
No ratings yet
Social Media Half Yearly Report 2023
25 pages
Clock Domain Crossing & Asynchronous FIFO
100% (1)
Clock Domain Crossing & Asynchronous FIFO
40 pages
Accessug
No ratings yet
Accessug
136 pages
Java J2EE JBoss Ejb With Eclipse 2003
No ratings yet
Java J2EE JBoss Ejb With Eclipse 2003
42 pages
Exchange 2013 Outlook Anywhere
No ratings yet
Exchange 2013 Outlook Anywhere
6 pages
DFT Compiler RTL Test Design Rule Checking User Guide
100% (3)
DFT Compiler RTL Test Design Rule Checking User Guide
34 pages
LowPower User
No ratings yet
LowPower User
74 pages
RTLtoGDSII 5 0.secured - Lect
No ratings yet
RTLtoGDSII 5 0.secured - Lect
360 pages
Node JS
No ratings yet
Node JS
1 page
Practica 1 Equilibrio de Fuerzas
No ratings yet
Practica 1 Equilibrio de Fuerzas
5 pages
SpyGlass AdvancedLintMethodology GuideWare2.0 UserGuide
No ratings yet
SpyGlass AdvancedLintMethodology GuideWare2.0 UserGuide
42 pages
Gate Level Simulation WP
No ratings yet
Gate Level Simulation WP
34 pages
CDC Tutorial Slides
100% (2)
CDC Tutorial Slides
53 pages
VC SpyGlass CDC Quick Start Guide
No ratings yet
VC SpyGlass CDC Quick Start Guide
28 pages
Iviewhmixecplctutorial
No ratings yet
Iviewhmixecplctutorial
10 pages
Improving Gate-Level Simulation Performance Author: Gagandeep Singh
No ratings yet
Improving Gate-Level Simulation Performance Author: Gagandeep Singh
34 pages
Choosing The Right Superlinting Technology For Early RTL Code Signoff
No ratings yet
Choosing The Right Superlinting Technology For Early RTL Code Signoff
5 pages
VCS QuickStart
No ratings yet
VCS QuickStart
66 pages
Mod Menu Log - Com - Roblox.client
No ratings yet
Mod Menu Log - Com - Roblox.client
2 pages
GENUS-MODUS-LBIST - Overview 23.10
No ratings yet
GENUS-MODUS-LBIST - Overview 23.10
120 pages
(MX) Seamless Script Execution in Collecting Data From Peer Router Through SSH
No ratings yet
(MX) Seamless Script Execution in Collecting Data From Peer Router Through SSH
6 pages
SV Basic
100% (1)
SV Basic
28 pages
Spyglass® Known Problems and Solutions: This Document Describes The Following
No ratings yet
Spyglass® Known Problems and Solutions: This Document Describes The Following
82 pages
1 DFT Coding Rules
No ratings yet
1 DFT Coding Rules
22 pages
Vcs MX Quickstart Guide: March 2017
No ratings yet
Vcs MX Quickstart Guide: March 2017
61 pages
Memory Built in Self Testing
No ratings yet
Memory Built in Self Testing
30 pages
Faults, Testing & Test Generation
No ratings yet
Faults, Testing & Test Generation
34 pages
Coverage
No ratings yet
Coverage
25 pages
MBIST Verification Best Practices Challenges
No ratings yet
MBIST Verification Best Practices Challenges
5 pages
DFT Compiler Lab 1: Insert Scan Chain: Computer-Aided VLSI System Design
100% (1)
DFT Compiler Lab 1: Insert Scan Chain: Computer-Aided VLSI System Design
4 pages
Synopsys VCS Commands For Verilogn Compilation
No ratings yet
Synopsys VCS Commands For Verilogn Compilation
3 pages
Spyglass Lint Analysis
No ratings yet
Spyglass Lint Analysis
4 pages
Clock Domain Crossing
No ratings yet
Clock Domain Crossing
5 pages
2.dft Flow
No ratings yet
2.dft Flow
47 pages
Lab4 Testing DFT
No ratings yet
Lab4 Testing DFT
6 pages
CDC Signoff Using SDC
No ratings yet
CDC Signoff Using SDC
36 pages
Synchronizer Techniques For Multi Clock Domain SoCs
No ratings yet
Synchronizer Techniques For Multi Clock Domain SoCs
8 pages
Lint Usage Rules
No ratings yet
Lint Usage Rules
9 pages
Lint
No ratings yet
Lint
13 pages
Linking Dumping
No ratings yet
Linking Dumping
182 pages
Abstract:: Invitation To Ezhil: A Tamil Programming Language For Early Computer-Science Education
No ratings yet
Abstract:: Invitation To Ezhil: A Tamil Programming Language For Early Computer-Science Education
11 pages