Introduction:
In case there is a need to send Plunify log files for debugging purposes, "log_cleanup.tcl" is a script provided with the InTime software to replace potentially confidential information from InTime log files with Xs. This script takes in the project and the input log file as inputs, and produces a cleaned up version of the input log file.
(See related blog post.)
Command and options:
- -proj: (Mandatory) The target project (full path); .qpf for Quartus and .xpr/.dcp for Vivado.
- -log : (Mandatory) The log file (full path) to clean.
- -rev : (Optional) The target revision (Quartus) or run (Vivado) of the project. By default, the current revision / run will be used.
- -incl: (Optional) Additional strings to clean.
By default, design module names, instance names, the project name and the device name will be cleaned. To specify multiple strings, use "," as the separator between strings, for example: -incl string1,string2,string3
Examples:
Vivado
- Project: /home/plunify/project_1/project_1.xpr
- InTime installation directory: /mnt/opt/Plunify/InTime/2.0
- Target InTime log file: /home/plunify/project1/plunify.jobs/1/calibrate_1.log
In a command-line terminal, enter the following:
> vivado -mode batch -s /mnt/opt/Plunify/InTime/2.0/scripts/log_cleanup.tcl -tclargs -proj /home/plunify/project_1/project1.xpr -log /home/plunify/project_1/plunify.jobs/1/calibrate_1.log
To clean the log file with extra sensitive words "secret_board_123" and "secret_module_name_123":
> vivado -mode batch -s /mnt/opt/Plunify/InTime/2.0/scripts/log_cleanup.tcl -tclargs -proj /home/plunify/project_1/project1.xpr -log /home/plunify/project_1/plunify.jobs/1/calibrate_1.log -incl secret_board_123,secret_module_name_123
Quartus
- Project: /home/plunify/project_1/project_1.qpf
- InTime installation directory: /mnt/opt/Plunify/InTime/2.0
- Target InTime log file: /home/plunify/project1/plunify.jobs/1/calibrate_1.log
> quartus_sh -t /mnt/opt/Plunify/InTime/2.0/scripts/log_cleanup.tcl -proj /home/plunify/project_1/project_1.qpf -log /home/plunify/project_1/plunify.jobs/1/calibrate_1.log
Depending on the size of the log file and the number of keywords to be checked, the script might take a couple of minutes to complete.
Progress will be shown in the terminal.
When it is done, check the output file (named after the input log file but with an extra ".cleanup" extension) located where the user ran this script.