Export to VCD files, additional logging macros added

Author: RTEdbg

Code/RTEmsg.vcxproj

@@ -411,6 +411,7 @@
     <ClInclude Include="text.h" />
     <ClInclude Include="timestamp.h" />
     <ClInclude Include="utf8_helpers.h" />
+    <ClInclude Include="vcd.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="cmd_line.c" />
@@ -442,6 +443,7 @@
     <ClCompile Include="statistics.c" />
     <ClCompile Include="process_bin_data.c" />
     <ClCompile Include="utf8_helpers.c" />
+    <ClCompile Include="vcd.c" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">

Code/RTEmsg.vcxproj.filters

@@ -87,6 +87,9 @@
     <ClInclude Include="timestamp.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="vcd.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.c">
@@ -149,5 +152,8 @@
     <ClCompile Include="messages.c">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="vcd.c">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
 </Project>

Code/cmd_line.c

@@ -285,6 +285,10 @@ static void process_one_cmd_line_parameter(char *argv)
     {
         g_msg.param.purge_defines = true;
     }
+    else if (strcmp(argv, "-no_gtkw") == 0)
+    {
+        g_msg.param.do_not_generate_gtkw_file = true;
+    }
     else if (strncmp(argv, "-T=", 3) == 0)
     {
         g_msg.param.timestamp_print = (char *)allocate_memory(strlen(argv) - 2, "tstamp");

Code/decoder.c

@@ -312,6 +312,7 @@ void process_message(uint32_t last_index)
 
     if (current_fmt_id >= MAX_FMT_IDS)
     {
+        g_msg.print_nl_to_main_log = true;
         report_no_definition_for_current_message(current_fmt_id, last_index);
         return;
     }
@@ -326,6 +327,7 @@ void process_message(uint32_t last_index)
 
     if (p_fmt == NULL)
     {
+        g_msg.print_nl_to_main_log = true;
         report_no_definition_for_current_message(current_fmt_id, last_index);
         return;
     }
@@ -342,6 +344,7 @@ void process_message(uint32_t last_index)
             g_msg.asm_words++;      // Also print the extended data.
         }
 
+        g_msg.print_nl_to_main_log = true;
         hex_dump_current_message(true);
         return;
     }

Code/files.c

@@ -15,6 +15,8 @@
 #include <stdlib.h>
 #include <string.h>
 #include <direct.h>
+#include <time.h>
+#include <windows.h>
 #include "main.h"
 #include "errors.h"
 #include "files.h"
@@ -194,10 +196,10 @@ void create_main_log_file(void)
 void remove_file(const char *file_name)
 {
     _set_errno(0);
-    int result = utf8_remove(file_name);
+        int result = utf8_remove(file_name);
 
     if (result == -1)
-    {
+        {
         if (errno != ENOENT)    // ENOENT indicates the file does not exist, which is acceptable
         {
             report_problem_with_string(ERR_COULD_NOT_DELETE_FILE, file_name);

Code/format.c

@@ -328,6 +328,8 @@ static void print_single_value_formatting_data(FILE *out, value_format_t *p_val_
     }
 
     fprintf(out, "%s\t%s\t", timer_name, value_statistic_name);
+    print_indexed_text(out, p_val_fmt->special_fmt,
+        " ,VCD_WORK,VCD_FINALIZE");
     fprintf(out, "\n");
 }
 
@@ -354,9 +356,9 @@ void print_format_decoding_information(void)
     }
 
     fprintf(out,
-        "FMT\tName\tType\tLength\t"
+        "FMT\tName\tType\tLength\tAdd_nl\t"
         "String\tOutput\tData type\tFmt_type\tAddr\tSize\t"
-        "Get.memo\tPut.memo\tIn.file/memo\tOffset\tMult\tTimer\tStatistics\t\n"
+        "Get.memo\tPut.memo\tIn.file/memo\tOffset\tMult\tTimer\tStatistics\tSpecial type\t\n"
     );
 
     msg_data_t *p_fmt = NULL;
@@ -377,14 +379,23 @@ void print_format_decoding_information(void)
         print_indexed_text(out, p_fmt->msg_type, "MSG0_NN,MSGN,EXT_MSG,MSGX");
         fprintf(out, "%u\t", p_fmt->msg_len);
 
+        if (p_fmt->add_nl_to_main_log)
+        {
+            fprintf(out, "yes\t");
+        }
+        else
+        {
+            fprintf(out, "no\t");
+        }
+
         size_t fmt_counter = 0;
         value_format_t *p_val_fmt = p_fmt->format;
 
         while (p_val_fmt != NULL)
         {
             if (fmt_counter > 0)
             {
-                fprintf(out, "\t\t\t\t");
+                fprintf(out, "\t\t\t\t\t");
             }
 
             fmt_counter++;

Code/format.h

@@ -46,7 +46,7 @@ enum fmt_type_t
     PRINT_UINT64,               // "%u", "%c", "%x", "%o", "%X", "%lu", "%lx", "%lX", "%lo" etc.
     PRINT_INT64,                // "%d", "%i", "%ld", "%li" etc.
     PRINT_DOUBLE,               // "%f", "%F", "%e", "%E", "%g", "%G", "%a", "%A"
-    PRINT_BINARY,               // "%b", "%B"
+    PRINT_BINARY,               // "%B"
     PRINT_TIMESTAMP,            // "%t"
     PRINT_dTIMESTAMP,           // "%T"
     PRINT_MSG_NO,               // "%N"
@@ -56,6 +56,8 @@ enum fmt_type_t
     PRINT_BIN_TO_FILE,          // "%W"
     PRINT_DATE,                 // "%D"
     PRINT_MSG_FMT_ID_NAME       // "%M"
+    // Not assigned:  *C, I, J, K, O, P, Q, R, *S, U, V, *Z, b, j, k, m, *n, *p, q, r, v, w, y, z
+    //  '*' - see special types: https://learn.microsoft.com/en-us/cpp/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions?view=msvc-170
 };
 
 
@@ -95,6 +97,7 @@ typedef struct value_format
     enum data_type_t data_type;     /*!< Type of data formatting (signed, unsigned, float, ...) */
     enum fmt_type_t fmt_type;       /*!< Which data type should be used for the fprintf() */
     bool print_copy_to_main_log;    /*!< != 0 => Print copy of data printed to defined file to Main.log file. */
+    special_fmt_t special_fmt;      /*!< != 0 => Special formating requirement. */
     double mult;                    /*!< Multiplier for data scaling (0 = no scaling) */
     double offset;                  /*!< Offset added before the multiplication */
     value_stats_t *value_stat;      /*!< Value statistics (NULL = no statistics for this value) */
@@ -105,7 +108,7 @@ typedef struct value_format
 /*@brief Define type of message for which the decoding function must expect. */
 enum msg_type_t
 {
-    TYPE_MSG0_4,                    /*!< For MSG0 .. MSGnn - known length at compile time */
+    TYPE_MSG0_8,                    /*!< For MSG0 .. MSGnn - known length at compile time */
     TYPE_MSGN,                      /*!< For MSGN - known and unknown length (0 = unknown) */
     TYPE_EXT_MSG,                   /*!< For EXT_MSG0..4 - known length */
     TYPE_MSGX                       /*!< For MSGX - unknown length */
@@ -118,6 +121,7 @@ typedef struct
 {
     const char *message_name;       /*!< Name of this message type - i.e. MSG2_NAME */
     enum msg_type_t msg_type;       /*!< Type of message (most message types have known length) */
+    bool add_nl_to_main_log;        /*!< true - add newline before next message in Main.log */
     uint16_t ext_data_mask;         /*!< AND mask used to select the extended info from the format_id */
     uint32_t msg_len;               /*!< Expected message length in bytes (0 - unknown at compile time) */
     uint32_t counter;               /*!< Number of same message type received and successfully processed after

Code/main.c

@@ -37,6 +37,7 @@
 #include "parse_directive.h"
 #include "cmd_line.h"
 #include "utf8_helpers.h"
+#include "vcd.h"
 
 #pragma comment(linker, "/STACK:8388608")       // Increase stack size to 8 MB
 
@@ -197,16 +198,14 @@ static void check_print_errors(void)
 
 
 /**
- * @brief Prints the full binary file name and creation date, and prepares the date string
- *        for the special format type "%D".
+ * @brief Print the full binary file name and creation date to a file,
+ *        and prepare the date string for the special format type "%D".
+ * 
+ * @param out Pointer to the output file.
  */
 
-static void print_data_file_name_and_date(void)
+void print_data_file_name_and_date(FILE * out)
 {
-    FILE *out = g_msg.file.main_log;
-
-    fprintf(out, TXT_MSG_RTEMSG_VERSION, RTEMSG_VERSION, RTEMSG_SUBVERSION, RTEMSG_REVISION, __DATE__);
-
     struct _stat stbuf;
     int rez = _stat(g_msg.param.data_file_name, &stbuf);
     if (rez == 0)
@@ -223,6 +222,18 @@ static void print_data_file_name_and_date(void)
 }
 
 
+/**
+ * @brief Print the RTEmsg version to a file.
+ *
+ * @param out Pointer to the output file.
+ */
+
+void print_rtemsg_version(FILE* out)
+{
+    fprintf(out, TXT_MSG_RTEMSG_VERSION, RTEMSG_VERSION, RTEMSG_SUBVERSION, RTEMSG_REVISION, __DATE__);
+}
+
+
 /**
  * @brief Create the Timestamps.csv file and write the header
  *        if this functionality was enabled with a command line parameter
@@ -411,7 +422,7 @@ static void prepare_sys_msg_fmt_structure(void)
     msg_data_t *p_fmt = allocate_memory(sizeof(msg_data_t), "sysFmt");
     g_fmt[MSG1_SYS_STREAMING_MODE_LOGGING] = p_fmt;
     p_fmt->msg_len = 4u;
-    p_fmt->msg_type = TYPE_MSG0_4;
+    p_fmt->msg_type = TYPE_MSG0_8;
     p_fmt->message_name = "sys";
 }
 
@@ -427,7 +438,8 @@ static void Process_binary_data_file(int argc, char *argv[])
 {
     create_main_log_file();
     load_and_check_rtedbg_header();     // Read and verify the header
-    print_data_file_name_and_date();    // Print header information
+    print_rtemsg_version(g_msg.file.main_log);          // RTEmsg version and date
+    print_data_file_name_and_date(g_msg.file.main_log); // Binary data file info
     print_cmd_line_parameters(argc, argv);
     print_bin_file_header_info();
     check_timestamp_diff_values();      // Check the values of the -ts command line argument (the timestamp period is known here)
@@ -458,6 +470,7 @@ static void Process_binary_data_file(int argc, char *argv[])
 
     print_msg_intro();
     process_bin_data_worker();           // Process the loaded binary data
+    vcd_finalize_files();                // Finalize VCD output files (if any)
     write_statistics_to_file();          // Generate various statistics files (if enabled)
     report_decode_error_summary();
     print_notes_and_warnings();
@@ -524,6 +537,7 @@ int main(int argc, char *argv[])
         return EXIT_FATAL_FMT_PARSING_ERRORS;
     }
 
+    set_tags_for_add_newline_to_main_log();
     print_format_decoding_information();
     dump_filter_names_to_file();
 

Code/main.h

@@ -22,9 +22,6 @@
 #include "messages.h"
 
 
-#define MAX_FMT_IDS  (1ul << MAX_FMT_ID_BITS)
-
-
 /* @brief Values returned by the functions assemble_message() and data_in_the_buffer() */
 typedef enum assemble_msg_code_t
 {
@@ -53,6 +50,7 @@ typedef struct _param_t
     bool purge_defines;                 //!< Eliminate all #define directives from the format files during parsing
     bool additional_newline;            //!< Print additional newline after information for every message to Main.log
     bool codepage_utf8;                 //!< Use the CP_UTF8 while printing the parsing error messages to the console
+    bool do_not_generate_gtkw_file;     //!< Do not generate the .gtkw file during generation of a .vcd file.
     char time_unit;                     //!< Specify time unit for the timestamps
     double time_multiplier;             //!< Time multiplier - used for printing of timestamps
     char number_of_format_id_bits;      //!< Number of bits used for the format ID
@@ -113,6 +111,67 @@ typedef struct _header_data_t
 } rte_header_data_t;
 
 
+/**
+ * @brief Enumeration of VCD variable data types.
+ */
+typedef enum _vcd_type
+{
+    VCD_TYPE_NONE = 0,
+    VCD_TYPE_BIT,           // Single bit data type
+    VCD_TYPE_FLOAT,         // Floating point and integer data type (signed/unsigned up to 64 bits)
+    VCD_TYPE_STRING,        // String data type
+    VCD_TYPE_ANALOG,        // Analog data type
+    VCD_TYPE_LAST
+} vcd_type_t;
+
+
+/**
+ * @brief Special formatting options (VCD support implemented so far).
+ */
+typedef enum
+{
+    VCD_NONE = 0,               // No special handling
+    VCD_WORK,                   // Processing of VCD $var value
+    VCD_FINALIZE                // Finalize the VCD $var value and write it to output file
+                                // VCD_FINALIZE may be the only one for simple format definitions
+} special_fmt_t;
+
+#define IS_A_VCD_TYPE(type) ((type >= VCD_WORK) && (type <= VCD_FINALIZE))
+
+
+/**
+ * @brief Structure with name, data type and id string for a $var VCD variable.
+ */
+typedef struct
+{
+    char name[VCD_MAX_VAR_NAME_LENGTH]; // $var name - truncated if too long
+    char id[VCD_MAX_ID_LENGTH];         // $var identifier
+    vcd_type_t variable_type;           // $var type (defines var size also)
+} vcd_var_data_t;
+
+/**
+ * @brief Structure with data for a single VCD output file.
+ */
+typedef struct
+{
+    bool writing_disabled;              // True if writing is disabled due to timestamp errors
+    bool discard_excessive_variables;   // True if too many variables defined for a single VCD file
+    bool data_written;                  // True if at least one $var value has been written to the file
+    bool timestamp_error_found;         // True if a timestamp error has been detected for the current message
+    char last_timestamp_error_value;    // To avoid multiple reporting of same value (unnecessarily VCD file size increase)
+    unsigned consecutive_timestamp_errors; // Number of consecutive timestamp errors found
+
+    uint64_t last_timestamp_ns;         // Last timestamp printed
+    unsigned msg_no_of_last_timestamp;
+                // To check if the timestamp has been already printed for the current message
+    unsigned no_variables;              // Number of variables found during message processing for a single VCD file
+    vcd_var_data_t* p_vcd[VCD_MAX_VARIABLES_PER_FILE];
+    char previous_bit_value[VCD_MAX_VARIABLES_PER_FILE]; // Used for T-toggle and R-reset
+    char pulse_variable_id[VCD_MAX_ID_LENGTH]; // ID of the variable used for pulse generation
+                                               // Non-zero value indicates that a pulse is to be generated.
+} vcd_file_data_t;
+
+
 enum enums_type_t
 {
     FILTER_TYPE,                    // FILTER() data
@@ -129,6 +188,8 @@ typedef struct _enum_data_t
 {
     char *name;                      /*!< Name of the enumerated value: filter, memo, in_file, out_file */
     enum enums_type_t type;          /*!< Type of data in the union */
+    vcd_file_data_t* vcd_data;       /*!< Pointer to structure with VCD specific data (NULL = not a vcd FILE) */
+    char* file_name;                 /*!< Name of the file defined with OUT_FILE() or IN_FILE() */
     union def_union
     {
         char *filter_description;    /*!< FILTER:   pointer to filter description (NULL if not specified) */
@@ -140,7 +201,6 @@ typedef struct _enum_data_t
                                         how the data is formatted - how it has to be prepared */
         double memo_value;           /*!< MEMO:     memorizing of temporary values */
     };
-    char *file_name;                 /*!< Name of the file defined with OUT_FILE() or IN_FILE() */
 } enum_data_t;
 
 
@@ -188,6 +248,9 @@ typedef struct _timestamp_t
     bool mark_problematic_tstamps;  /*!< Add asterisk before the message number */
     bool no_previous_tstamp;        /*!< The timestamp.old value is not valid */
     bool long_timestamp_found;      /*!< At least one long timestamp found */
+    bool first_timestamp_processed; /*!< First timestamp processed */
+    uint64_t first_timestamp_ns;    /*!< First timestamp found in the binary data file in ns */
+    uint64_t last_timestamp_ns;     /*!< Last timestamp found in the binary data file in ns */
 } timestamp_t;
 
 
@@ -211,6 +274,8 @@ typedef struct _rte_msg_t
     char date_string[BIN_FILE_DATE_LENGTH]; /*!< String with date and time of binary data file creation - for "%D" */
     uint32_t messages_processed_after_restart; /*!< Counter of messages processed after reset/restart */
     value_t value;                      /*!< Currently processed/printed numerical value */
+    bool vcd_files_processed;           /*!< true - VCD file definitions found. VCD file have to be processed. */
+    bool print_nl_to_main_log;          /*!< true - print additional newline before next message */
 
     /* Binary data file processing variables */
     uint32_t index;                     /*!< Index to the rte_buffer */
@@ -266,6 +331,8 @@ extern rte_msg_t g_msg;                 /*!< Main global data structure for the
 void *allocate_memory(size_t size, const char *memory_name);
 char *duplicate_string(const char *string_to_duplicate);
 bool   is_power_of_two(size_t n);
+void print_data_file_name_and_date(FILE* out);
+void print_rtemsg_version(FILE* out);
 
 #endif   // _MAIN_H