test_uppercase.cpp

Go to the documentation of this file.

 
 
#include "../../uppercase/include/uppercase.hpp"
#include "../../common/src/common.cpp"
 
using namespace std;
 
//---------------------------------------------------------
// HELPERS FOR THE DEBUGGING TRACES
//  .e.g: DEBUG_LEVEL = (MDL_TRACE | IPS_TRACE)
//---------------------------------------------------------
#define THIS_NAME "TB"
 
#define TRACE_OFF     0x0000
#define TRACE_URIF   1 <<  1
#define TRACE_UAF    1 <<  2
#define TRACE_MMIO   1 <<  3
#define TRACE_ALL     0xFFFF
 
#define DEBUG_LEVEL (TRACE_ALL)
 
 
//------------------------------------------------------
//-- TESTBENCH DEFINES
//------------------------------------------------------
#define OK          true
#define KO          false
#define VALID       true
#define UNVALID     false
#define DEBUG_TRACE true
#define DEBUG_MULTI_RUNS True
#define TB_MULTI_RUNS_ITERATIONS 2
 
#define ENABLED     (ap_uint<1>)1
#define DISABLED    (ap_uint<1>)0
 
 
//------------------------------------------------------
//-- DUT INTERFACES AS GLOBAL VARIABLES
//------------------------------------------------------
 
//-- SHELL / Uaf / Mmio / Config Interfaces
//ap_uint<2>                piSHL_This_MmioEchoCtrl;
ap_uint<1>                  piSHL_This_MmioPostPktEn;
ap_uint<1>                  piSHL_This_MmioCaptPktEn;
 
//-- SHELL / Uaf / Udp Interfaces
stream<UdpWord>             sSHL_Uaf_Data ("sSHL_Uaf_Data");
stream<UdpWord>             sUAF_Shl_Data ("sUAF_Shl_Data");
stream<UdpWord>             image_stream_from_uppercase ("image_stream_from_uppercase");
 
ap_uint<32>                 s_udp_rx_ports = 0x0;
stream<NetworkMetaStream>   siUdp_meta          ("siUdp_meta");
stream<NetworkMetaStream>   soUdp_meta          ("soUdp_meta");
ap_uint<32>                 node_rank;
ap_uint<32>                 cluster_size;
 
//------------------------------------------------------
//-- TESTBENCH GLOBAL VARIABLES
//------------------------------------------------------
unsigned int         simCnt;
//------------------------------------------------------
//-- SHELL / Role / Mem / Mp1 Interface
//------------------------------------------------------
#ifdef ENABLE_DDR
#define MEMORY_LINES_512 TOTMEMDW_512 /* 100 Byte */
membus_t   lcl_mem0[MEMORY_LINES_512];
membus_t   lcl_mem1[MEMORY_LINES_512];
#endif
 
 
void stepDut() {
    uppercase(
      &node_rank,
      &cluster_size,
      sSHL_Uaf_Data,
      sUAF_Shl_Data,
      siUdp_meta,
      soUdp_meta,
      &s_udp_rx_ports
      #ifdef ENABLE_DDR
                      ,
        lcl_mem0,
        lcl_mem0
      #endif
      );
    simCnt++;
    //memcpy(lcl_mem1,lcl_mem0,MEMORY_LINES_512*sizeof(membus_t));
    printf("[%4.4d] STEP DUT \n", simCnt);
}
 
 
 
 
int main(int argc, char** argv) {
 
    //------------------------------------------------------
    //-- TESTBENCH LOCAL VARIABLES
    //------------------------------------------------------
    int         nrErr = 0;
 
    printf("#####################################################\n");
    printf("## TESTBENCH STARTS HERE                           ##\n");
    printf("#####################################################\n");
 
    simCnt = 0;
    nrErr  = 0;
 
    if (argc != 2) {
        printf("Usage : %s <input string> , provided %d\n", argv[0], argc);
        return -1;
    }
 
    string tmp_string= argv[1];
    string strInput;
 
    //clean the corners if make or other utilities insert this weird ticks at the beginning of the string
    if(isCornerPresent(tmp_string,"'") or isCornerPresent(tmp_string,"`") or isCornerPresent(tmp_string,"\"") ){
        tmp_string = tmp_string.substr(1,tmp_string.length()-2);
    }
    
    strInput = tmp_string;
    if (!strInput.length()) {
        printf("ERROR: Empty string provided. Aborting...\n");
        return -1;
    }
    else {
      printf("Succesfully loaded string ... %s\n", argv[1]);
      // Ensure that the selection of MTU is a multiple of 8 (Bytes per transaction)
      assert(PACK_SIZE % 8 == 0);
    }
    
    //------------------------------------------------------
    //-- TESTBENCH LOCAL VARIABLES FOR UPPERCASE
    //------------------------------------------------------
    unsigned int sim_time = 2 * CEIL(strInput.length(), 8) + 10;
    unsigned int tot_trasnfers = (CEIL(strInput.length(), PACK_SIZE));
    char *charOutput = (char*)malloc(strInput.length() * sizeof(char));
    char *charInput = (char*)malloc(strInput.length() * sizeof(char));
    if (!charOutput || !charInput) {
        printf("ERROR: Cannot allocate memory for output string. Aborting...\n");
        return -1;
    }
    
    
    //------------------------------------------------------
    //-- STEP-1.1 : CREATE MEMORY FOR OUTPUT IMAGES
    //------------------------------------------------------
    if (!dumpStringToFile(strInput, "ifsSHL_Uaf_Data.dat", simCnt)) {
      nrErr++;
    }
    //std::string strGold = createUppercaseGoldenOutput(strInput);
    //if (!dumpStringToFile(strGold, "verify_UAF_Shl_Data.dat", simCnt)){ 
    //  nrErr++;
    //}
    #ifdef DEBUG_MULTI_RUNS // test if the HLS kernel has reinit issues with streams leftovers or other stuffs
    for(int iterations=0; iterations < TB_MULTI_RUNS_ITERATIONS; iterations++){
    #endif //DEBUG_MULTI_RUNS
      #ifdef ENABLE_DDR
      for(int i=0; i < MEMORY_LINES_512; i++){
        lcl_mem0[i]=0;
        lcl_mem1[i]=0;
      }
      #endif//ENABLE_DDR
 
    //------------------------------------------------------
    //-- STEP-2.1 : CREATE TRAFFIC AS INPUT STREAMS
    //------------------------------------------------------
    if (nrErr == 0) {
        if (!setInputDataStream(sSHL_Uaf_Data, "sSHL_Uaf_Data", "ifsSHL_Uaf_Data.dat", simCnt)) { 
            printf("### ERROR : Failed to set input data stream \"sSHL_Uaf_Data\". \n");
            nrErr++;
        }
 
  //there are tot_trasnfers streams from the the App to the Role
  NetworkMeta tmp_meta = NetworkMeta(1,DEFAULT_RX_PORT,0,DEFAULT_RX_PORT,0);
    for (unsigned int i=0; i<tot_trasnfers; i++) {
      siUdp_meta.write(NetworkMetaStream(tmp_meta));
    }        
    //set correct node_rank and cluster_size
        node_rank = 1;
        cluster_size = 2;
    }
 
    //------------------------------------------------------
    //-- STEP-2.2 : SET THE PASS-THROUGH MODE
    //------------------------------------------------------
    //piSHL_This_MmioEchoCtrl.write(ECHO_PATH_THRU);
    //[TODO] piSHL_This_MmioPostPktEn.write(DISABLED);
    //[TODO] piSHL_This_MmioCaptPktEn.write(DISABLED);
 
    //------------------------------------------------------
    //-- STEP-3 : MAIN TRAFFIC LOOP
    //------------------------------------------------------
    while (!nrErr) {
    
        // Keep enough simulation time for sequntially executing the FSMs of the main 3 functions 
        // (Rx-Tx)
        if (simCnt < sim_time) 
        {
            stepDut();
 
            if(simCnt > 2)
            {
              assert(s_udp_rx_ports == 0x1);
            }
 
            //if( !soUdp_meta.empty())
            //{
            //  NetworkMetaStream tmp_meta = soUdp_meta.read();
            //  printf("NRC received NRCmeta stream from node_rank %d.\n", (int) tmp_meta.tdata.src_rank);
            //}
 
 
        } else {
            printf("## End of simulation at cycle=%3d. \n", simCnt);
            break;
        }
 
    }  // End: while()
 
    //-------------------------------------------------------
    //-- STEP-4 : DRAIN AND WRITE OUTPUT FILE STREAMS
    //-------------------------------------------------------
    //---- UAF-->SHELL Data ----
    if (!getOutputDataStream(sUAF_Shl_Data, "sUAF_Shl_Data", "ofsUAF_Shl_Data.dat", simCnt))
    {
        nrErr++;
    }
    //---- UAF-->SHELL META ----
    if( !soUdp_meta.empty())
    {
      unsigned int i = 0;
      while( !soUdp_meta.empty())
      {
        i++;
        NetworkMetaStream tmp_meta = soUdp_meta.read();
        printf("NRC received NRCmeta stream from rank %d to rank %d.\n", (int) tmp_meta.tdata.src_rank, (int) tmp_meta.tdata.dst_rank);
        assert(tmp_meta.tdata.src_rank == node_rank);
        //ensure forwarding behavior
        assert(tmp_meta.tdata.dst_rank == ((tmp_meta.tdata.src_rank + 1) % cluster_size));
      }
      assert(i == tot_trasnfers);
    }
    else {
      printf("Error No metadata received...\n");
      nrErr++;
    }
    
    //-------------------------------------------------------
    //-- STEP-5 : FROM THE OUTPUT FILE CREATE AN ARRAY
    //------------------------------------------------------- 
    if (!dumpFileToString("ifsSHL_Uaf_Data.dat", charInput, simCnt)) {
      printf("### ERROR : Failed to set string from file \"ofsUAF_Shl_Data.dat\". \n");
      nrErr++;
    }
    printf("Input string : ");
    for (unsigned int i = 0; i < strInput.length(); i++)
       printf("%c", charInput[i]); 
    printf("\n");    
    if (!dumpFileToString("ofsUAF_Shl_Data.dat", charOutput, simCnt)) {
      printf("### ERROR : Failed to set string from file \"ofsUAF_Shl_Data.dat\". \n");
      nrErr++;
    }
    __file_write("./hls_out.txt", charOutput, strInput.length());
    printf("Output string: ");
    for (unsigned int i = 0; i < strInput.length(); i++)
       printf("%c", charOutput[i]); 
    printf("\n");
 
    //------------------------------------------------------
    //-- STEP-6 : COMPARE INPUT AND OUTPUT FILE STREAMS
    //------------------------------------------------------
    int rc1 = system("diff --brief -w -i -y ../../../../test/ofsUAF_Shl_Data.dat \
                                            ../../../../test/verify_UAF_Shl_Data.dat");
    if (rc1)
    {
        printf("## Error : File \'ofsUAF_Shl_Data.dat\' does not match \'verify_UAF_Shl_Data.dat\'.\n");
    } else {
      printf("Output data in file \'ofsUAF_Shl_Data.dat\' verified.\n");
    }
 
  cout<< endl << "  End the TB with iteration " << iterations << endl << endl;
    nrErr += rc1;
 
    printf("#####################################################\n");
    if (nrErr) 
    {
        printf("## ERROR - TESTBENCH FAILED (RC=%d) !!!             ##\n", nrErr);
    } else {
        printf("## SUCCESSFULL END OF TESTBENCH (RC=0)             ##\n");
    }
    printf("#####################################################\n");
 
    simCnt = 0;//reset sim counter
    nrErr=0;
  #ifdef DEBUG_MULTI_RUNS
  }
  #endif//DEBUG_MULTI_RUNS
  
  //free dynamic memory
  if(charOutput != NULL){
  free(charOutput);
  charOutput = NULL;
  }
  if(charInput != NULL){
    free(charInput);
    charInput = NULL;
  }
    return(nrErr);
}