Merge pull request #31 from ErickOF/jvillalobos/TLM_FIXES

Add compilation flags to avoid debug prints

Author: jgavillalobos

modules/router/Makefile

@@ -67,6 +67,36 @@ ifdef IPS_JPG_PV_EN
 	LFLAGS += -DIPS_JPG_PV_EN
 endif # IPS_JPG_PV_EN
 
+ifdef DISABLE_ROUTER_DEBUG
+	CFLAGS += -DDISABLE_ROUTER_DEBUG
+	LFLAGS += -DDISABLE_ROUTER_DEBUG
+endif # DISABLE_ROUTER_DEBUG
+
+ifdef DISABLE_FILTER_DEBUG
+	CFLAGS += -DDISABLE_FILTER_DEBUG
+	LFLAGS += -DDISABLE_FILTER_DEBUG
+endif # DISABLE_FILTER_DEBUG
+
+ifdef DISABLE_MEM_DEBUG
+	CFLAGS += -DDISABLE_MEM_DEBUG
+	LFLAGS += -DDISABLE_MEM_DEBUG
+endif # DISABLE_MEM_DEBUG
+
+ifdef DISABLE_RGB_DEBUG
+	CFLAGS += -DDISABLE_RGB_DEBUG
+	LFLAGS += -DDISABLE_RGB_DEBUG
+endif # DISABLE_RGB_DEBUG
+
+ifdef DISABLE_SOBEL_DEBUG
+	CFLAGS += -DDISABLE_SOBEL_DEBUG
+	LFLAGS += -DDISABLE_SOBEL_DEBUG
+endif # DISABLE_SOBEL_DEBUG
+
+ifdef DISABLE_TB_DEBUG
+	CFLAGS += -DDISABLE_TB_DEBUG
+	LFLAGS += -DDISABLE_TB_DEBUG
+endif # DISABLE_TB_DEBUG
+
 .PHONY: print-all
 print-all:
 		@echo "Incdir is $(INCDIR)"

modules/router/include/common_func.hpp

@@ -2,12 +2,32 @@
 #define COMMON_FUNC_HPP
 
 #define dbgprint(FORMAT, ARGS...) \
-printf("%s(%0d) @%s: " FORMAT "\n", __FILE__, __LINE__, sc_time_stamp().to_string().c_str(), ##ARGS)
+printf("%s(%0d) @%s: " FORMAT "\n", __FILE__, __LINE__, sc_time_stamp().to_string().c_str(), ##ARGS);
 
-#define dbgmodprint(FORMAT, ARGS...) \
-printf("%s(%0d) [%s] @%s : " FORMAT "\n", __FILE__, __LINE__, this->name(), sc_time_stamp().to_string().c_str(), ##ARGS)
+#define dbgmodprint(DBG_ACT, FORMAT, ARGS...) \
+if (DBG_ACT) printf("%s(%0d) [%s] @%s : " FORMAT "\n", __FILE__, __LINE__, this->name(), sc_time_stamp().to_string().c_str(), ##ARGS)
 
-#define dbgimgtarmodprint(FORMAT, ARGS...) \
-printf("%s(%0d) [%s] @%s : " FORMAT "\n", __FILE__, __LINE__, img_target::name(), sc_time_stamp().to_string().c_str(), ##ARGS)
+#define dbgimgtarmodprint(DBG_ACT, FORMAT, ARGS...) \
+if (DBG_ACT) printf("%s(%0d) [%s] @%s : " FORMAT "\n", __FILE__, __LINE__, img_target::name(), sc_time_stamp().to_string().c_str(), ##ARGS)
+
+#define checkprintenable(DBG_ACT) \
+if (DBG_ACT) \
+{ \
+  printf("%s(%0d) [%s] @%s : " "Prints enabled for this module" "\n", __FILE__, __LINE__, this->name(), sc_time_stamp().to_string().c_str()); \
+} \
+else \
+{ \
+  printf("%s(%0d) [%s] @%s : " "Prints are not enabled for this module" "\n", __FILE__, __LINE__, this->name(), sc_time_stamp().to_string().c_str()); \
+}
+
+#define checkprintenableimgtar(DBG_ACT) \
+if (DBG_ACT) \
+{ \
+  printf("%s(%0d) [%s] @%s : " "Prints enabled for this module" "\n", __FILE__, __LINE__, img_target::name(), sc_time_stamp().to_string().c_str()); \
+} \
+else \
+{ \
+  printf("%s(%0d) [%s] @%s : " "Prints are not enabled for this module" "\n", __FILE__, __LINE__, img_target::name(), sc_time_stamp().to_string().c_str()); \
+}
 
 #endif // COMMON_FUNC_HPP

modules/router/include/ips_filter_tlm.hpp

@@ -19,7 +19,11 @@ using namespace std;
 struct ips_filter_tlm : public Filter<IPS_IN_TYPE_TB, IPS_OUT_TYPE_TB, IPS_FILTER_KERNEL_SIZE>, public img_target
 {
 
-    SC_CTOR(ips_filter_tlm): Filter<IPS_IN_TYPE_TB, IPS_OUT_TYPE_TB, IPS_FILTER_KERNEL_SIZE>(Filter<IPS_IN_TYPE_TB, IPS_OUT_TYPE_TB, IPS_FILTER_KERNEL_SIZE>::name()), img_target(img_target::name()) {
+    ips_filter_tlm(sc_module_name name) : Filter<IPS_IN_TYPE_TB, IPS_OUT_TYPE_TB, IPS_FILTER_KERNEL_SIZE>((std::string(name) + "_HW_block").c_str()), img_target((std::string(name) + "_target").c_str()) {
+#ifdef DISABLE_FILTER_DEBUG
+        this->use_prints = false;
+#endif //DISABLE_FILTER_DEBUG
+        checkprintenableimgtar(use_prints);
     }
 
     //Override do_when_transaction functions

modules/router/include/memory_tlm.hpp

@@ -16,8 +16,12 @@ using namespace std;
 struct memory_tlm : public img_target
 {
 
-    SC_CTOR(memory_tlm): img_target(img_target::name()) {
+    memory_tlm(sc_module_name name) : img_target((std::string(name) + "_target").c_str()) {
       mem_array = new unsigned char[2764852];
+#ifdef DISABLE_MEM_DEBUG
+      this->use_prints = false;
+#endif //DISABLE_MEM_DEBUG
+      checkprintenableimgtar(use_prints);
     }
 
     //Override do_when_transaction functions

modules/router/include/rgb2gray_tlm.hpp

@@ -17,7 +17,11 @@ using namespace std;
 struct rgb2gray_tlm : public Rgb2Gray, public img_target
 {
 
-    SC_CTOR(rgb2gray_tlm): Rgb2Gray(Rgb2Gray::name()), img_target(img_target::name()) {
+    rgb2gray_tlm(sc_module_name name) : Rgb2Gray((std::string(name) + "_HW_block").c_str()), img_target((std::string(name) + "_target").c_str()) {
+#ifdef DISABLE_RGB_DEBUG
+        this->use_prints = false;
+#endif //DISABLE_RGB_DEBUG
+        checkprintenableimgtar(use_prints);
     }
 
     //Override do_when_transaction functions

modules/router/include/sobel_edge_detector_tlm.hpp

@@ -17,7 +17,11 @@ using namespace std;
 struct sobel_edge_detector_tlm : public Edge_Detector, public img_target
 {
 
-    SC_CTOR(sobel_edge_detector_tlm): Edge_Detector(Edge_Detector::name()), img_target(img_target::name()) {
+    sobel_edge_detector_tlm(sc_module_name name) : Edge_Detector((std::string(name) + "_HW_block").c_str()), img_target((std::string(name) + "_target").c_str()) {
+#ifdef DISABLE_SOBEL_DEBUG
+        this->use_prints = false;
+#endif //DISABLE_SOBEL_DEBUG
+        checkprintenableimgtar(use_prints);
     }
 
     //Override do_when_transaction functions

modules/router/run_all.sh

@@ -4,11 +4,14 @@ case $1 in
   "save_log")
     make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 all > output.log
     ;;
+  "save_log_no_dbg")
+    make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 DISABLE_ROUTER_DEBUG=1 DISABLE_FILTER_DEBUG=1 DISABLE_MEM_DEBUG=1 DISABLE_RGB_DEBUG=1 DISABLE_SOBEL_DEBUG=1 DISABLE_TB_DEBUG=1 all > output.log
+    ;;
   "print_all")
     make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 print-all
     ;;
   "compile")
-    make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 compile
+    make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 DISABLE_ROUTER_DEBUG=1 DISABLE_FILTER_DEBUG=1 DISABLE_MEM_DEBUG=1 DISABLE_RGB_DEBUG=1 DISABLE_SOBEL_DEBUG=1 DISABLE_TB_DEBUG=1 compile
     ;;
   "router_tb")
     make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 EDGE_DETECTOR_AT_EN=1 USING_TLM_ROUTER_TB_EN=1 USING_TLM_TB_EN=1 all > output.log
@@ -17,6 +20,6 @@ case $1 in
     make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 EDGE_DETECTOR_AT_EN=1 USING_TLM_ROUTER_TB_EN=1 USING_TLM_TB_EN=1 all > output.log
     ;;
   *)
-    make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 all
+    make INCLUDE_OPENCV_PKG=1 RGB2GRAY_PV_EN=1 IPS_FILTER_LT_EN=1 EDGE_DETECTOR_AT_EN=1 IMG_UNIFICATE_PV_EN=1 IPS_JPG_PV_EN=1 USING_TLM_TB_EN=1 DISABLE_ROUTER_DEBUG=1 DISABLE_FILTER_DEBUG=1 DISABLE_MEM_DEBUG=1 DISABLE_RGB_DEBUG=1 DISABLE_SOBEL_DEBUG=1 DISABLE_TB_DEBUG=1 all
     ;;
 esac

modules/router/src/img_initiator.cpp

@@ -47,10 +47,12 @@ struct img_initiator: sc_module
   // DEBUG
   unsigned int transaction_sent_id = 0;
   unsigned int transaction_received_id = 0;
+
+  bool use_prints;
 
   //Constructor
   SC_CTOR(img_initiator)   
-  : socket("socket"), m_peq(this, &img_initiator::peq_cb) // Construct and name socket   
+  : socket("socket"), m_peq(this, &img_initiator::peq_cb), use_prints(true) // Construct and name socket   
   {   
     // Register callbacks for incoming interface method calls
     socket.register_nb_transport_bw(this, &img_initiator::nb_transport_bw);
@@ -81,11 +83,10 @@ struct img_initiator: sc_module
 
     data = transaction->get_data_ptr();
     //-----------DEBUG-----------
-    dbgmodprint("Reading at Initiator: ");
+    dbgmodprint(use_prints, "Reading at Initiator: ");
     for (long unsigned int i = 0; i < transaction->get_data_length()/sizeof(int); ++i){
-      dbgmodprint("%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
+      dbgmodprint(use_prints, "%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
     }
-    printf("\n");
     //-----------DEBUG-----------
   }
 
@@ -108,11 +109,10 @@ struct img_initiator: sc_module
     transaction->set_extension(img_ext);
 
     //-----------DEBUG-----------
-    dbgmodprint("Writing: ");
+    dbgmodprint(use_prints, "Writing: ");
     for (long unsigned int i = 0; i < data_length/sizeof(int); ++i){
-      dbgmodprint("%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
+      dbgmodprint(use_prints, "%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
     }
-    printf("\n");
     //-----------DEBUG-----------
 
     //Set transaction
@@ -134,14 +134,14 @@ struct img_initiator: sc_module
 
     this->transaction_sent_id = img_ext->transaction_number;
 
-    dbgmodprint("BEGIN_REQ SENT TRANS ID %0d", img_ext->transaction_number);
+    dbgmodprint(use_prints, "BEGIN_REQ SENT TRANS ID %0d", img_ext->transaction_number);
     status = socket->nb_transport_fw(*transaction, phase, ((cur_command == tlm::TLM_WRITE_COMMAND) ? this->write_delay : this->read_delay));  // Non-blocking transport call   
 
     // Check request status returned by target
     switch (status) {   
         //Case 1: Transaction was accepted
         case tlm::TLM_ACCEPTED: {
-          dbgmodprint("%s received -> Transaction ID %d", "TLM_ACCEPTED", img_ext->transaction_number);
+          dbgmodprint(use_prints, "%s received -> Transaction ID %d", "TLM_ACCEPTED", img_ext->transaction_number);
           check_transaction(*transaction);
           //transaction->release();
           //Initiator only cares about sending the transaction, doesnt need to wait for response (non-blocking)
@@ -150,7 +150,7 @@ struct img_initiator: sc_module
 
         //Not implementing Updated and Completed Status
         default: {
-          dbgmodprint("[ERROR] Invalid status received at initiator -> Transaction ID %d", img_ext->transaction_number);
+          dbgmodprint(use_prints, "[ERROR] Invalid status received at initiator -> Transaction ID %d", img_ext->transaction_number);
           break;
         }
     }
@@ -161,11 +161,10 @@ struct img_initiator: sc_module
     this->transaction_received_id = img_ext->transaction_number;
     // }
     //-----------DEBUG-----------
-    dbgmodprint("[DEBUG1] Reading at Initiator: ");
+    dbgmodprint(use_prints, "[DEBUG1] Reading at Initiator: ");
     for (long unsigned int i = 0; i < transaction->get_data_length()/sizeof(int); ++i){
-      dbgmodprint("%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
+      dbgmodprint(use_prints, "%02x", *(reinterpret_cast<int*>(transaction->get_data_ptr())+i));
     }
-    printf("\n");
     //-----------DEBUG-----------
 
     //Increment transaction ID
@@ -185,7 +184,7 @@ struct img_initiator: sc_module
   void peq_cb(tlm::tlm_generic_payload& trans, const tlm::tlm_phase& phase)
   {
 
-    //dbgmodprint("%s received -> Transaction ID %d from address %x", phase, this->id_extension->transaction_id);
+    //dbgmodprint(use_prints, "%s received -> Transaction ID %d from address %x", phase, this->id_extension->transaction_id);
     //cout << name() << " " <<hex << trans.get_address() << " BEGIN_RESP RECEIVED at " << sc_time_stamp() << endl;
     switch (phase) {
       case tlm::BEGIN_RESP: {
@@ -195,20 +194,18 @@ struct img_initiator: sc_module
         //Initiator dont care about confirming resp transaction. So nothing else to do.
 
         //-----------DEBUG-----------
-        dbgmodprint("[DEBUG] Reading at Initiator: ");
+        dbgmodprint(use_prints, "[DEBUG] Reading at Initiator: ");
         for (long unsigned int i = 0; i < trans.get_data_length()/sizeof(int); ++i){
-          dbgmodprint("%02x", *(reinterpret_cast<int*>(trans.get_data_ptr())+i));
+          dbgmodprint(use_prints, "%02x", *(reinterpret_cast<int*>(trans.get_data_ptr())+i));
         }
-        printf("\n");
         //-----------DEBUG-----------
 
         transaction_received_e.notify();
         //-----------DEBUG-----------
-        dbgmodprint("[DEBUG] Reading at Initiator: ");
+        dbgmodprint(use_prints, "[DEBUG] Reading at Initiator: ");
         for (long unsigned int i = 0; i < trans.get_data_length()/sizeof(int); ++i){
-          dbgmodprint("%02x", *(reinterpret_cast<int*>(trans.get_data_ptr())+i));
+          dbgmodprint(use_prints, "%02x", *(reinterpret_cast<int*>(trans.get_data_ptr())+i));
         }
-        printf("\n");
         //-----------DEBUG-----------
         break;
       }

modules/router/src/img_router.cpp

@@ -77,10 +77,12 @@ struct img_router: sc_module
   //DEBUG
   unsigned int transaction_in_fw_path_id = 0;
   unsigned int transaction_in_bw_path_id = 0;
+
+  bool use_prints;
 
   //Constructor
   SC_CTOR(img_router)   
-  : target_socket("socket"), bw_m_peq(this, &img_router::bw_peq_cb), fw_m_peq(this, &img_router::fw_peq_cb), fw_fifo(10), bw_fifo(2) // Construct and name socket   
+  : target_socket("socket"), bw_m_peq(this, &img_router::bw_peq_cb), fw_m_peq(this, &img_router::fw_peq_cb), fw_fifo(10), bw_fifo(2), use_prints(true) // Construct and name socket   
   {   
     // Register callbacks for incoming interface method calls
     target_socket.register_nb_transport_fw(this, &img_router::nb_transport_fw);
@@ -93,6 +95,11 @@ struct img_router: sc_module
 
     SC_THREAD(fw_thread);
     SC_THREAD(bw_thread);
+
+#ifdef DISABLE_ROUTER_DEBUG
+    this->use_prints = false;
+#endif //DISABLE_ROUTER_DEBUG
+    checkprintenable(use_prints);
   }
 
   //Address Decoding
@@ -106,25 +113,25 @@ struct img_router: sc_module
     switch(address) {
         // To Filter
         case IMG_FILTER_KERNEL: {
-            dbgmodprint("Decoded address %016llX corresponds to Filter module.", address);
+            dbgmodprint(use_prints, "Decoded address %016llX corresponds to Filter module.", address);
             return IMG_FILTER_INITIATOR_ID;
         }
 
         // To/from Sobel
         case SOBEL_INPUT_0: 
         case SOBEL_INPUT_1: 
         case SOBEL_OUTPUT: {
-            dbgmodprint("Decoded address %016llX corresponds to Sobel module.", address);
+            dbgmodprint(use_prints, "Decoded address %016llX corresponds to Sobel module.", address);
             return IMG_SOBEL_INITIATOR_ID;
         }
 
         // To/From Memory Valid addresses
         case MEM_START ... MEM_FINISH : {
-            dbgmodprint("Decoded address %016llX corresponds to Memory.", address);
+            dbgmodprint(use_prints, "Decoded address %016llX corresponds to Memory.", address);
             return IMG_MEMORY_INITIATOR_ID;
         }
         default: {
-            dbgmodprint("[ERROR] Decoding invalid address %016llX.", address);
+            dbgmodprint(use_prints, "[ERROR] Decoding invalid address %016llX.", address);
             SC_REPORT_FATAL("[IMG ROUTER]", "Received address is invalid, does not match any hardware block");
             return INVALID_INITIATOR_ID;
         }   
@@ -144,12 +151,12 @@ struct img_router: sc_module
     item.delay = delay;
     trans.get_extension(img_ext);
     if (bw_fifo.num_free() == 0) {
-        dbgmodprint("[BW_FIFO] FIFO is FULL. Waiting...");
+        dbgmodprint(use_prints, "[BW_FIFO] FIFO is FULL. Waiting...");
         wait(bw_fifo.data_read_event());
     }
     bw_fifo.nb_write(item);
     wait(bw_fifo.data_written_event());
-    dbgmodprint("[BW_FIFO] Pushed transaction #%0d", img_ext->transaction_number);
+    dbgmodprint(use_prints, "[BW_FIFO] Pushed transaction #%0d", img_ext->transaction_number);
     return tlm::TLM_ACCEPTED;
   }
 
@@ -166,12 +173,12 @@ struct img_router: sc_module
     item.delay = delay;
     trans.get_extension(img_ext);
     if (fw_fifo.num_free() == 0) {
-        dbgmodprint("[FW_FIFO] FIFO is FULL. Waiting...");
+        dbgmodprint(use_prints, "[FW_FIFO] FIFO is FULL. Waiting...");
         wait(fw_fifo.data_read_event());
     }
     fw_fifo.nb_write(item);
     wait(fw_fifo.data_written_event());
-    dbgmodprint("[FW_FIFO] Pushed transaction #%0d", img_ext->transaction_number);
+    dbgmodprint(use_prints, "[FW_FIFO] Pushed transaction #%0d", img_ext->transaction_number);
     return tlm::TLM_ACCEPTED;
   }
 
@@ -192,7 +199,7 @@ struct img_router: sc_module
         phase = item.phase;
         delay = item.delay;
         (*trans_ptr).get_extension(img_ext);
-        dbgmodprint("[FW_FIFO] Popped transaction #%0d", img_ext->transaction_number);
+        dbgmodprint(use_prints, "[FW_FIFO] Popped transaction #%0d", img_ext->transaction_number);
         fw_m_peq.notify(*trans_ptr, phase, delay);
         wait(fw_delay);
     }
@@ -215,7 +222,7 @@ struct img_router: sc_module
         phase = item.phase;
         delay = item.delay;
         (*trans_ptr).get_extension(img_ext);
-        dbgmodprint("[BW_FIFO] Popped transaction #%0d", img_ext->transaction_number);
+        dbgmodprint(use_prints, "[BW_FIFO] Popped transaction #%0d", img_ext->transaction_number);
         bw_m_peq.notify(*trans_ptr, phase, delay);
         wait(bw_delay);
     }
@@ -231,7 +238,7 @@ struct img_router: sc_module
     sc_dt::uint64 address = trans.get_address();
     this->transaction_in_bw_path_id = img_ext->transaction_number;
 
-    dbgmodprint("Received transaction #%0d with address %016llX in backward path. Redirecting transaction to CPU", img_ext->transaction_number, address);
+    dbgmodprint(use_prints, "Received transaction #%0d with address %016llX in backward path. Redirecting transaction to CPU", img_ext->transaction_number, address);
     target_socket->nb_transport_bw(trans, local_phase, this->bw_delay);
   }
 
@@ -245,7 +252,7 @@ struct img_router: sc_module
     this->transaction_in_fw_path_id = img_ext->transaction_number;
 
     unsigned int initiator_id = decode_address(address);
-    dbgmodprint("Received transaction #%0d with address %016llX in forward path. Redirecting transaction through initiator %d", img_ext->transaction_number, address, initiator_id);
+    dbgmodprint(use_prints, "Received transaction #%0d with address %016llX in forward path. Redirecting transaction through initiator %d", img_ext->transaction_number, address, initiator_id);
     (*initiator_socket[initiator_id])->nb_transport_fw(trans, local_phase, this->fw_delay);
   }