updated vqm2blif test script to now allow input flags and provide usage information. The script now also supports creating a new set of golden netlists (instead of testing).

Author: Srivat97

utils/vqm2blif/test/scripts/test_vqm2blif.sh

@@ -26,6 +26,30 @@
 
 # Finally, the generated blif files have the extension ".test.blif", so please do not name any other files with this extension
 
+## usefule functions ##
+# prints information regarding how to use the script
+print_usage() 
+{
+    echo "Usage: test_vqm2blif.sh [-h | --help] [-vqm2blif_location] V [-netlists] N [-arch] A [-create_golden]"
+    echo ""
+    echo "Evaluating the vqm2blif program."
+    echo ""
+    echo "Positional Arguments:"
+    echo "V             Location of the vqm2blif program executable"
+    echo "N             Location of the folder containing the netlists"
+    echo "A             Location of the architecture file to use"
+    echo ""
+    echo "Optional Arguments:"
+    echo "-h, --help            show the usage of the test script"
+    echo "-vqm2blif_location    specify the vqm2blif program executable (defalt: \$VTR_ROOT/build/utils/vqm2blif/vqm2blif"
+    echo "-netlists             specify the netlists used to evalute the vqm2blif program (default: \$VTR_ROOT/utils/vqm2blif/test/netlists/"
+    echo "-arch                 specify the architecture file that will be used to evalute the vqm2blif program" 
+    echo "                      (default: \$VTR_ROOT/vtr_flow/arch/titan/stratixiv_arch.timing.xml)"    
+    echo "-create_golden        creates a set of \"golden\" .blif netlists using the vqm2blif program. The generated netlists will have the same"
+    echo "                      name as the provided .vqm netlists with the extension \"golden.blif\". The generated netlists can be found in the same"
+    echo "                      location as provided .vqm netlists."
+}
+
 
 # has useful utilities
 source "$(dirname "$0")/../../../../.github/scripts/common.sh"
@@ -34,6 +58,9 @@ source "$(dirname "$0")/../../../../.github/scripts/common.sh"
 # location of the VTR project root directory
 VTR_ROOT_DIR="$(dirname "$0")/../../../../"
 
+# location of the vqm program directory
+VQM_PROGRAM="$VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif"
+
 # location of the deafult architecture file used when testing the vqm2blif program
 ARCH_FILE="$(dirname "$0")/../../../../vtr_flow/arch/titan/stratixiv_arch.timing.xml"
 
@@ -44,27 +71,81 @@ TEST_FOLDER="$(dirname "$0")/../netlists/"
 # file extensions of the created blif netlists (these files will be compared to the golden netlists)
 VQM_OUTPUT_EXT=".test.blif"
 
+# file extension for the generated golden blif netlists
+VQM_GOLDEN_OUTPUT_EXT=".golden.blif"
+
 # variable to keep track of the test status
 # initially the status is successful
-TEST_STATUS=0 
-
-# check if the user provided a different folder for the test netlist locations
-# if they did, the update the test folder
-if ! [ -z $1 ]; then
-
-    # update the test folder to the user input
-    TEST_FOLDER=$1
+TEST_STATUS=0
 
-fi
-
-# check if the user provided a different architecture file to use.
-# if they did, then update the architecture file.
-if ! [ -z $2 ]; then
-
-    # upadte the architecture file to the user input
-    ARCH_FILE=$2
+# variable to determine whether the user wanted to generate a set of golden netlists (initially we assume the golden netlists are not being generated)
+GEN_GOLDEN=0
 
-fi
+# we process the command line inputs below
+while test $# -gt 0;
+do
+    case "$1" in
+    -h | --help)
+        print_usage
+        exit 0
+        ;;
+    -vqm2blif_location)
+        if ! [ -z $2 ]; then
+
+            # update the test folder to the user input
+            VQM_PROGRAM=$2
+
+        else
+            echo "Did not supply vqm program location"
+            echo "-----------------------------------"
+            print_usage
+            exit 1
+        fi
+        shift
+        shift
+        ;;
+    -netlists)
+        if ! [ -z $2 ]; then
+
+            # update the test folder to the user input
+            TEST_FOLDER=$2
+
+        else
+            echo "Did not supply the folder location for netlists"
+            echo "-----------------------------------------------"
+            print_usage
+            exit 1
+        fi
+        shift
+        shift
+        ;;
+    -arch)
+       if ! [ -z $2 ]; then
+
+            # update the test folder to the user input
+            ARCH_FILE=$2
+
+        else
+            echo "Did not supply architecture file location"
+            echo "-----------------------------------------"
+            print_usage
+            exit 1
+        fi
+        shift
+        shift
+        ;;
+    -create_golden)
+        GEN_GOLDEN=1
+        shift
+        ;;
+    *) # handle all other options
+        echo "Invalid Argument Provided"
+        echo "-------------------------"
+        print_usage
+        exit 1        
+        ;;
+    esac
+done
 
 
 echo "VQM2BLIF Program Check"
@@ -74,7 +155,11 @@ echo "----------------------"
 # start by going through the user supplied directory and identify all the .vqm files. We will recursively go throught the directory and identify these .vqm files. We assume that any file found is going to be a test file.
 find $TEST_FOLDER -name "*.vqm" -print0 | while read -d $'\0' vqm_file
 do
-    
+    # "create_golden" related variables
+    CREATE_GOLDEN_FILE_NAME=""
+    CREATE_GOLDEN_OUTPUT=""
+
+
     # identify the directory of the current vqm file and its name
     CURR_DIR_NAME="$(dirname "$vqm_file")"
     CURR_VQM_FILE_NAME="$(basename "$vqm_file" .vqm)"
@@ -88,28 +173,66 @@ do
     GOLDEN_BLIF_OUTPUT="$(find "$CURR_DIR_NAME" -name *.blif)"
     GOLDEN_BLIF_OUTPUT_FILE_NAME="$(basename "$GOLDEN_BLIF_OUTPUT" .blif)"
 
+    # if the user chose the "create_golden" option, then we need to generate the file/location names for them
+    if [ $GEN_GOLDEN -eq 1 ]; then
+
+        CREATE_GOLDEN_FILE_NAME="${CURR_VQM_FILE_NAME}${VQM_GOLDEN_OUTPUT_EXT}"
+        CREATE_GOLDEN_OUTPUT="${CURR_DIR_NAME}/${CREATE_GOLDEN_FILE_NAME}"
+  
+    fi
+
     # uncomment for debugging
     #echo "Starting test $CURR_VQM_FILE_NAME"
 
     # now we need to run the vqm to blif program.
     # we only care about any outputs related to errors, so ignore standard output.
     # We are running this process in a seperate sub shell to make sure that unwanted error messags are not reported in the terminal
-    ($VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $VQM_OUTPUT || false) > /dev/null 2>&1
+    # we have two cases, one for testing and one for generating a golden set of outputs
+    if [ $GEN_GOLDEN -eq 0 ]; then
+
+        ($VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $VQM_OUTPUT || false) > /dev/null 2>&1
+    
+    else
+
+        ($VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $CREATE_GOLDEN_OUTPUT || false) > /dev/null 2>&1
 
+    fi
+    
+    # if we errored during the program execution
     if [ $? -ne 0 ]; then
 
         echo "ERROR: The vqm2blif program failed while converting \"$CURR_VQM_FILE_NAME.vqm\". Please refer to the failure messages below:"
         echo "-----------------------------------------------------------------------------------------------------------------------"
 
         $VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $VQM_OUTPUT
 
+        # once again, we cover the cases of testing and creating a golden set of outputs
+        if [ $GEN_GOLDEN -eq 0]; then
+
+            $VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $VQM_OUTPUT
+        
+        else
+
+            $VTR_ROOT_DIR/build/utils/vqm2blif/vqm2blif -vqm $vqm_file -arch $ARCH_FILE -out $CREATE_GOLDEN_OUTPUT 
+
+        fi
+
         exit 1
     fi
 
     #uncomment for debugging
     #echo "Comparing $CURR_VQM_FILE_NAME output"
 
-    NUM_OF_DIFFERENCES="$(diff $GOLDEN_BLIF_OUTPUT $VQM_OUTPUT | grep "^>" | wc -l)"
+    # variable to keep track of the total number of differences between a generated nelist and its "golden" counterpart
+    NUM_OF_DIFFERENCES=0
+
+    # we only need to calculate the number of differences, if we are testing the vqm2blif program
+    # this is not needed when we are just generating a golden set of outputs
+    if [ $GEN_GOLDEN -eq 0 ]; then
+        
+        NUM_OF_DIFFERENCES="$(diff $GOLDEN_BLIF_OUTPUT $VQM_OUTPUT | grep "^>" | wc -l)"
+    
+    fi
 
     #uncomment for debugging
     #echo "Number of differences: $NUM_OF_DIFFERENCES"
@@ -125,6 +248,7 @@ do
         diff $GOLDEN_BLIF_OUTPUT $VQM_OUTPUT
 
         exit 1
+    
     fi
 
     # uncomment for debugging
@@ -142,14 +266,35 @@ if [ $? -eq 1 ]; then
     # if we are here then the test failed, so update the test status with an error code
     TEST_STATUS=1
 
+    # delete the blif files generated if there was an error
+    # this is for the case where golden blif files are generated
+    find $TEST_FOLDER -name "*$VQM_OUTPUT_EXT" -type f -delete
+
 else
 
-    # if we are here then the test passed, so report to the user (no need to update the test status)
-    echo "VQM2BLIF Checks Successfully Passed!"    
+    # if we are here then the test passed or the golden blif netlists were successfully generated, so report to the user (no need to update the test status)
+
+    if [ $GEN_GOLDEN -eq 0 ]; then
+        
+        # case where we are testing
+        echo "VQM2BLIF Checks Successfully Passed!"
+    
+    else    
+
+        # case where we are generating a set of golden blif outputs
+        echo "VQM2BLIF has Successfully created all golden blif netlists!"
+    
+    fi
 fi
 
-#find all the newly created blif files above (used for verification) and delete them (don't need them anymore)
-find $TEST_FOLDER -name "*$VQM_OUTPUT_EXT" -type f -delete
+# find all the newly created blif files above (used for verification) and delete them (don't need them anymore)
+# we only delete the generated blif files if we are testing, when we are generating a new set of golden blif outputs, we do not want to delete them
+
+if [ $GEN_GOLDEN -eq 0 ]; then
+
+    find $TEST_FOLDER -name "*$VQM_OUTPUT_EXT" -type f -delete
+
+fi
 
 # exit with the status of the test (failure=1 and pass=0)
 exit $TEST_STATUS