v.0.8.12 Decoder/Reader refactored + reduces memory usage.

Author: milo

CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 
-# Unreleased
+# v.0.8.12 - 2021-08-10
+
+- reduction of heap usage and overall memory usage
+  - only 10 heap allocs needed to disassemble an intel hex file
+
+- getting rid of basic integers in important sections
+  - flash address is now represented as uint32_t 
+  - opcodes are (finally) represented as uint32_t
+  - for more user relevant changes see libvmcu headers
+
+- the disassembly is now sorted (ascending, sorted by address)
+  - this change is mandatory for the cfg
+
+- refactored decoder
+  - decoder operates now on an intermediate representation (binary_buffer) of the binary
+
+- added vmcu_binary_buffer_t (only for internal usage)
+  - this serves as an intermediate representation for the decoder
+  - every single format reader (reader/) should return a binary buffer
+
+- refactored intel hex reader
 
 - adjusted example section in README
 

README.md

@@ -62,7 +62,7 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P);
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->cfg->used; i++) {
+    for(uint32_t i = 0; i < report->cfg->used; i++) {
         
         vmcu_cfg_node_t *node = &report->cfg->node[i];
         print_instruction(node->xto.i);
@@ -131,7 +131,7 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->progsize; i++) {
+    for(uint32_t i = 0; i < report->progsize; i++) {
 
         printf("0x%04x ", report->disassembly[i].addr);
         print_instruction(&report->disassembly[i]);
@@ -165,7 +165,7 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->progsize; i++) {
+    for(uint32_t i = 0; i < report->progsize; i++) {
 
         vmcu_instr_t *instr = &report->disassembly[i];
         
@@ -199,7 +199,7 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->n_vector; i++) {
+    for(uint32_t i = 0; i < report->n_vector; i++) {
 
         vmcu_vector_t *vect = &report->vector[i];
         vmcu_instr_t  *isr  = vect->xto->i;
@@ -241,12 +241,12 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->n_label; i++) {
+    for(uint32_t i = 0; i < report->n_label; i++) {
 
         vmcu_label_t *lx = &report->label[i];
         printf("0x%04x\tL%d\n\n", lx->addr, lx->id);
 
-        for(int32_t j = 0; j < lx->n_xfrom; j++) {
+        for(uint32_t j = 0; j < lx->n_xfrom; j++) {
 
             vmcu_xref_t *x = &lx->xfrom[j];
             
@@ -291,12 +291,12 @@ int main(const int argc, const char **argv) {
     vmcu_model_t  *m328p  = vmcu_model_ctor(VMCU_DEVICE_M328P); 
     vmcu_report_t *report = vmcu_analyze_ihex("file.hex", m328p);
 
-    for(int32_t i = 0; i < report->n_sfr; i++) {
+    for(uint32_t i = 0; i < report->n_sfr; i++) {
 
         vmcu_sfr_t *sfr = &report->sfr[i];
         printf("SFR ID: %d\n\n", sfr->id);
 
-        for(int32_t j = 0; j < sfr->n_xfrom; j++) {
+        for(uint32_t j = 0; j < sfr->n_xfrom; j++) {
 
             vmcu_xref_t *x = &sfr->xfrom[j];
 
@@ -344,7 +344,7 @@ int main(const int argc, const char **argv) {
     const VMCU_GROUP grp   = instr.group;         // VMCU_GROUP_MATH_LOGIC
 
     const uint32_t opcode  = instr.opcode;        // 0x976a (big endian)
-    const uint16_t addr    = instr.addr;          // 0x0000 (undefined)
+    const uint32_t addr    = instr.addr;          // 0x0000 (undefined)
 
     const bool dword       = instr.dword;         // false
     const bool exec        = instr.exec;          // true

TODO.txt

@@ -4,9 +4,6 @@ These are a some of my ideas for the future of libvmcu
 
 /********************************* Features ***************************************/
 
-[0] controlflow graph (cfg)
-    [0.1] requires slab allocator to minimize memory requests
-
 [1] McCabe's cyclomatic complexity
     [1.1] requires controlflow graph, see [0]
 
@@ -37,9 +34,7 @@ These are a some of my ideas for the future of libvmcu
 
 /********************************* Internal / Cleanup *****************************/
 
-[11] sort instructions by address in disassembly (important)
-
-[12] remove usage of basic integers (int) in libvmcu
+[12] remove usage of basic integers (int) in libvmcu (nearly done)
 
 [13] adjust driver makefiles (debug recipe, add -g -o)
 

driver/cfg/cfg.c

@@ -57,7 +57,7 @@ int main(const int argc, const char **argv) {
 
     vmcu_cfg_t *cfg = report->cfg;
 
-    for(int32_t i = 0; i < cfg->used; i++) {
+    for(uint32_t i = 0; i < cfg->used; i++) {
 
         vmcu_cfg_node_t *node = &cfg->node[i];
 
@@ -111,7 +111,7 @@ static void print_instruction(vmcu_instr_t *instr) {
 
 static void print_instruction_details(vmcu_instr_t *instr) {
 
-    printf("0x%04x", instr->addr);
+    printf("0x%04" PRIx32, instr->addr);
 
     const uint16_t opcl = (instr->opcode & 0x0000ffff);
     const uint16_t swpl = (opcl >> 8) | (opcl << 8);
@@ -122,9 +122,9 @@ static void print_instruction_details(vmcu_instr_t *instr) {
     if(instr->dword == false)
         printf("      %s....%s ", COLOR_GREEN, COLOR_RESET);
     else
-        printf("      %s%04x%s ", COLOR_GREEN, swph, COLOR_RESET);
+        printf("      %s%04" PRIx16 "%s ", COLOR_GREEN, swph, COLOR_RESET);
 
-    printf("%s%04x%s      ", COLOR_YELLOW, swpl, COLOR_RESET);
+    printf("%s%04" PRIx16 "%s      ", COLOR_YELLOW, swpl, COLOR_RESET);
 }
 
 static void print_colored_base(const char *basestr, VMCU_GROUP group) {

driver/details/details.c

@@ -25,11 +25,11 @@ int main(const int argc, const char **argv) {
         return EXIT_FAILURE;
     }
 
-    const uint32_t opc = htoi(argv[1]);
-
     vmcu_instr_t instr;
     vmcu_model_t *m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
+    const uint32_t opc = htoi(argv[1]);
+
     if(vmcu_disassemble_bytes(opc, &instr, m328p) < 0) {
 
         printf("Could not decode.\n");
@@ -50,8 +50,8 @@ static void print_instr(vmcu_instr_t *instr, const uint32_t opcode) {
 
     printf("---- Instruction details of 0x%04x ----\n", opcode);
 
-    printf("opcode:     0x%04x\n", instr->opcode);
-    printf("address:    0x%04x\n", instr->addr);
+    printf("opcode:     0x%04" PRIx32 "\n", instr->opcode);
+    printf("address:    0x%04" PRIx32 "\n", instr->addr);
 
     printf("mnemonic:   ");
     print_mnemonic(instr);

driver/disasm/disasm.c

@@ -71,13 +71,13 @@ int main(const int argc, const char **argv) {
     atexit(cleanup);
     m328p = vmcu_model_ctor(VMCU_DEVICE_M328P);
 
-    int32_t progsize = 0;
+    uint32_t progsize = 0;
     vmcu_instr_t *prog = vmcu_disassemble_ihex(argv[1], &progsize, m328p);
 
     if(prog == NULL || progsize == 0)
         return EXIT_FAILURE;
 
-    for(int32_t i = 0; i < progsize; i++)
+    for(uint32_t i = 0; i < progsize; i++)
         print_instruction(&prog[i]);
 
     free(prog);
@@ -113,7 +113,7 @@ static void print_instruction(vmcu_instr_t *instr) {
 
 static void print_instruction_details(vmcu_instr_t *instr) {
 
-    printf("0x%04x", instr->addr);
+    printf("0x%04" PRIx32, instr->addr);
 
     const uint16_t opcl = (instr->opcode & 0x0000ffff);
     const uint16_t swpl = (opcl >> 8) | (opcl << 8);
@@ -124,9 +124,9 @@ static void print_instruction_details(vmcu_instr_t *instr) {
     if(instr->dword == false)
         printf("      %s....%s ", COLOR_GREEN, COLOR_RESET);
     else
-        printf("      %s%04x%s ", COLOR_GREEN, swph, COLOR_RESET);
+        printf("      %s%04" PRIx16 "%s ", COLOR_GREEN, swph, COLOR_RESET);
 
-    printf("%s%04x%s      ", COLOR_YELLOW, swpl, COLOR_RESET);
+    printf("%s%04" PRIx16 "%s      ", COLOR_YELLOW, swpl, COLOR_RESET);
 }
 
 static void print_colored_base(const char *basestr, VMCU_GROUP group) {

driver/endloop/endloop.c

@@ -6,7 +6,6 @@
 #include <string.h>
 #include <stdbool.h>
 #include <inttypes.h>
-#include <time.h>
 
 // libvmcu
 #include "libvmcu_analyzer.h"
@@ -55,7 +54,7 @@ int main(const int argc, const char **argv) {
         return EXIT_FAILURE;
     }
 
-    for(int32_t i = 0; i < report->progsize; i++) {
+    for(uint32_t i = 0; i < report->progsize; i++) {
 
         vmcu_instr_t *instr = &report->disassembly[i];
 
@@ -67,7 +66,7 @@ int main(const int argc, const char **argv) {
         else
             printf("unconditional endloop:\t");
 
-        printf("0x%04x\t", instr->addr);
+        printf("0x%04" PRIx32 "\t", instr->addr);
         print_instruction(instr);
     }
 

driver/findgroup/findgroup.c

@@ -5,7 +5,6 @@
 #include <stdlib.h>
 #include <string.h>
 #include <inttypes.h>
-#include <time.h>
 
 // libvmcu
 #include "libvmcu_analyzer.h"
@@ -56,14 +55,14 @@ int main(const int argc, const char **argv) {
 
     VMCU_GROUP filter = get_filter(argv[2]);
 
-    for(int32_t i = 0; i < report->progsize; i++) {
+    for(uint32_t i = 0; i < report->progsize; i++) {
 
         vmcu_instr_t *instr = &report->disassembly[i];
 
         if(instr->group != filter)
             continue;
 
-        printf("0x%04x\t", instr->addr);
+        printf("0x%04" PRIx32 "\t", instr->addr);
         print_instruction(instr);
     }
 

driver/findisr/findisr.c

@@ -18,32 +18,34 @@ static void cleanup(void);
 
 /* --- Extern --- */
 
-vmcu_label_t* find_label(int address, vmcu_report_t* report) {
+vmcu_label_t* find_label(uint32_t address, vmcu_report_t* report) {
 
-    for(int i=0; i < report->n_label; i++) {
+    for(uint32_t i=0; i < report->n_label; i++) {
 
         vmcu_label_t* label = &report->label[i];
 
         if(label->addr == address)
             return label;
     }
+
+    return NULL;
 }
 
 void analyze_isr(vmcu_instr_t* instr, vmcu_report_t* report) {
 
     vmcu_operand_t* op = &instr->src;
-    int absolute_address = (op->type == VMCU_OPTYPE_S12) ? op->s : op->p;
+    uint32_t absolute_address = (op->type == VMCU_OPTYPE_S12) ? instr->addr : op->p;
 
     if(instr->key == VMCU_IKEY_RJMP)
-        absolute_address += instr->addr + 1;
+        absolute_address += op->s + 1;
 
     vmcu_label_t* label = find_label(absolute_address, report);
     printf("L%d\t0x%04x\n", label->id, absolute_address);
 }
 
-void print_addresses(vmcu_report_t* report, int start_index, int end_index) {
+void print_addresses(vmcu_report_t* report, uint32_t start_index, uint32_t end_index) {
 
-    for(int i=start_index; i <= end_index; i++) {
+    for(uint32_t i=start_index; i <= end_index; i++) {
 
         vmcu_instr_t* instr = &report->disassembly[i];
         analyze_isr(instr, report);
@@ -77,36 +79,39 @@ int main(const int argc, const char **argv) {
     if((report = vmcu_analyze_ihex(filename, m328p)) == NULL)
         return EXIT_FAILURE;
 
-    int start_index = -1;
-    for(int i=0; i < report->progsize; i++) {
+    uint32_t start_index = 0;
+    bool ready = false;
 
-        vmcu_instr_t* instr = &report->disassembly[i];
+    for(uint32_t i=0; i < report->progsize; i++) {
 
-        int key = instr->key;
+        vmcu_instr_t* instr = &report->disassembly[i];
+        VMCU_IKEY key = instr->key;
 
         if(key == VMCU_IKEY_JMP || key == VMCU_IKEY_RJMP) {
 
-            if(start_index == -1)
+            if(ready == false) {
+
                 start_index = i;
+                ready = true;
+            }
 
             continue;
         }
 
-        const int count = i - start_index;
-
-        if(start_index == -1)
+        if(ready == false)
             continue;
 
+        const uint32_t count = i - start_index;
+
         bool case1 = table_size == -1 && count >= 14;
         bool case2 = table_size != -1 && count == table_size;
 
-        int end_index = start_index + count - 1;
+        uint32_t end_index = start_index + count - 1;
 
         if(case1 || case2)
             print_addresses(report, start_index, end_index);
 
-        start_index = -1;
-
+        ready = false;
     }
 
     return EXIT_SUCCESS;

driver/graph/graph.c

@@ -85,7 +85,7 @@ int main(const int argc, const char **argv) {
     struct CFGBlock** blocks = obtain_blocks(report, &nblocks);
 
     for(uint32_t i = 0; i < nblocks; i++) {
-	print_block(blocks[i], file);
+	    print_block(blocks[i], file);
     }
 
     for(uint32_t i = 0; i < nblocks; i++) {
@@ -105,7 +105,6 @@ int main(const int argc, const char **argv) {
     free(blocks);
 
     if(report != NULL) vmcu_report_dtor(report);
-
     if(m328p != NULL) vmcu_model_dtor(m328p);
 
     return EXIT_SUCCESS;
@@ -203,8 +202,8 @@ static uint32_t branch_from(vmcu_cfg_node_t* node){
 
 static uint32_t get_highest_addr(vmcu_report_t* report){
 	vmcu_instr_t* disassembly = report->disassembly;
-	int32_t highest_addr = 0;
-	for(int32_t i = 0; i < report->progsize; i++){
+	uint32_t highest_addr = 0;
+	for(uint32_t i = 0; i < report->progsize; i++){
 		if(disassembly[i].addr > highest_addr){
 			highest_addr = disassembly[i].addr;
 		}