dynamic_report (::quartus::interactive_synthesis)

The following table displays information for the dynamic_report Tcl command:

Tcl Package and Version

Belongs to ::quartus::interactive_synthesis 1.0

Syntax dynamic_report [-h | -help] [-long_help] [-dump_all] [-dump_lines <dumplines_value> ] [-filename <filename_value> ] [-html] [-query <query_value> ] -report <report_value> [-summary] [-xml]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-dump_all dump the entire target report
-dump_lines <dumplines_value> dump first # of lines of the target report
-filename <filename_value> Name of output file to be generated
-html Option to generate output file in HTML format
-query <query_value> Specifies the SQLite query
-report <report_value> Specifies a target report to begin action with
-summary give a summary of the target report
-xml Option to generate output file in XML format
API that allows user to act with a full report which is limited on showing items in GUI.
The report is a dynamic reporting infrastructure from SQLite report database, independent of synthesis compilation.
Use "-report" to target a report. This option is mandatory as further action depends on a certain report.
Current available "report" values are:
	      Value               Report name in compilation                       Database stored
	------------------   ------------------------------------   --------------------------------------------
	"registers removed"    Registers Removed During Synthesis     ./dynamic_report/registers_removed.sqlite 
Use "-summary" to get a summary of the target report such as table name, column name that can be used in query.
The format of the summary would be shown as:
	Database name: <name of the database that the target report is saved>
	Table name: <table in the database that target report content locates>
	Total size: <total size of the report>
	Column: <1st column name of the report>
	Column: <2nd column name of the report>
Use "-query" to take a whole SQLite query as an argument. 
For example -query "SELECT * FROM <table> WHERE <column> = <...>" to get SELECT result from the database. 
If query command is incorrect, an error message with details will be issued.
Use "-dump_all" to dump all content in the report.
Use "-dump_lines" with a non-negative integer to dump first <non-negative integer> of lines in the report.
The result of "-query", "-dump_all" and "-dump_lines" will be sent to an output file stored in local design directory.
Use "-filename" to specify output filename. If no filename entered, output file will be named as
report value. 
If the "-html" option is specified, the output file is generated in HTML format. 
If the "-xml" option is specified, the output file is generated in XML format. 
Otherwise, the output file is generated in ASCII format.
"-html" option and "-xml" option are mutually exclusive. Please only specify one option.
Example Usage
dynamic_report -report <report name> -query <SQLite query> -filename <output file name> -xml
dynamic_report -report <report name> -dump_all -filename <output file name>
dynamic_report -report <report name> -dump_lines <number of lines> -filename <output file name> -html
dynamic_report -report <report name> -summary
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_OK 0 INFO: No specified filename provided. Use <string> as the default output file name
TCL_OK 0 INFO: Successfully generated output file: <string>. <string> lines reported.
TCL_OK 0 INFO: The report's database summary is shown as the following:\n<string>
TCL_OK 0 WARNING: Summary content directly returns from terminal, further options(filename, html, and xml) are ignored.
TCL_ERROR 1 ERROR: Can't create or overwrite file: <string>.
TCL_ERROR 1 ERROR: Failed to open the SQLite database. Make sure you are running tcl command in the top level design directory not dynamic_report directory.\n If the SQLite database is not generated during compilation, please turn ON the qsf: synth_rpt_enable_dynamic_report and rerun synthesis compilation
TCL_ERROR 1 ERROR: Invalid filename input. Make sure your input is not empty and does not contain any special characters or spaces.
TCL_ERROR 1 ERROR: Illegal value: <string>. Specify a non-negative integer ranging from 1 to 999999999 for the option -dump_lines.
TCL_ERROR 1 ERROR: The referred sqlite database does not exist. There's no Registers Removed During Synthesis report table generated in your design.
TCL_ERROR 1 ERROR: This report name: <string> is currently not supported for dynamic reporting.\nPlease use dynamic_report -help to see current supported report.
TCL_ERROR 1 ERROR: SQLite error: <string>