v.0.8.4 Added naming convention for xref-from and xref-to (cross refe…

…rences). See CHANGELOG for more details.

CHANGELOG.md

@@ -4,6 +4,13 @@
 
 - nothing to log
 
+# v.0.8.4
+
+- Worked on naming Convention of xrefs
+  - xref-from and xref-to are using the same structure (vmcu_xref_t)
+  - xref-from's will always be exposed as xfrom with a list counter n_xfrom
+  - xref-to's will always be exposed as xto with a list counter n_xto
+
 # v.0.8.3 - 2021-03-18
 
 - Naming Convention of enums (preventing future internal name clashes)

README.md

@@ -232,9 +232,9 @@ int main(const int argc, const char **argv) {
         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_xref; j++) {
+        for(int32_t j = 0; j < lx->n_xfrom; j++) {
 
-            vmcu_xref_t *x = &lx->xref[j];
+            vmcu_xref_t *x = &lx->xfrom[j];
 
             printf(" xref from 0x%04x ", x->p->addr);
             printf("%s\n", x->p->mnem);
@@ -280,9 +280,9 @@ int main(const int argc, const char **argv) {
         vmcu_sfr_t *sfr = &report->sfr[i];
         printf("SFR ID: %d\n\n", sfr->id);
 
-        for(int32_t j = 0; j < sfr->n_xref; j++) {
+        for(int32_t j = 0; j < sfr->n_xfrom; j++) {
 
-            vmcu_xref_t *x = &sfr->xref[j];
+            vmcu_xref_t *x = &sfr->xfrom[j];
 
             printf(" xref from 0x%04x ", x->p->addr);
             printf("%s\n", x->p->mnem);
@@ -445,7 +445,7 @@ take a look at engine/*/arch/
 # Static Analysis
 
 - [x] Disassembler
-- [x] Cross references (xref-from)
+- [x] Cross references (xref-from, xref-to)
 - [ ] analyzer flags
 
 - [x] Decompose and classify instructions

driver/labels/labels.c

@@ -27,9 +27,9 @@ int main(const int argc, const char **argv) {
         vmcu_label_t *lx = &report->label[i];
         printf("0x%04x\tL%d\n", lx->addr, lx->id);
 
-        for(int32_t j = 0; j < lx->n_xref; j++) {
+        for(int32_t j = 0; j < lx->n_xfrom; j++) {
 
-            vmcu_xref_t *x = &lx->xref[j];
+            vmcu_xref_t *x = &lx->xfrom[j];
 
             printf(" xref from 0x%04x ", x->i->addr);
             printf("(%s)\n", x->i->mnem);

driver/sfr/sfr.c

@@ -33,9 +33,9 @@ int main(const int argc, const char **argv) {
         vmcu_sfr_t *sfr = &report->sfr[i];
         printf("SFR ID: %d\n", sfr->id);
 
-        for(int32_t j = 0; j < sfr->n_xref; j++) {
+        for(int32_t j = 0; j < sfr->n_xfrom; j++) {
 
-            vmcu_xref_t *x = &sfr->xref[j];
+            vmcu_xref_t *x = &sfr->xfrom[j];
 
             printf("  xref from 0x%04x ", x->i->addr);
             printf("(%s)\n", x->i->mnem);

engine/include/analyzer/report/label.h

@@ -14,8 +14,8 @@ typedef struct vmcu_label {
     uint16_t id;
     uint16_t addr;
 
-    int32_t n_xref;
-    vmcu_xref_t *xref;
+    int32_t n_xfrom;
+    vmcu_xref_t *xfrom;
 
 } vmcu_label_t;
 

engine/include/analyzer/report/sfr.h

@@ -16,8 +16,8 @@ typedef struct vmcu_sfr {
 
     VMCU_SFR id;
 
-    int32_t n_xref;
-    vmcu_xref_t *xref;
+    int32_t n_xfrom;
+    vmcu_xref_t *xfrom;
 
 } vmcu_sfr_t;
 

engine/include/libvmcu/libvmcu_analyzer.h

@@ -371,8 +371,8 @@ typedef struct vmcu_sfr {                     ///< sfr (special function registe
 
     VMCU_SFR id;                              ///< sfr id (for example id = VMCU_SFR_UCSR0A)
 
-    int32_t n_xref;                           ///< xref (from) count
-    vmcu_xref_t *xref;                        ///< xref (from) list
+    int32_t n_xfrom;                          ///< xref (from) count
+    vmcu_xref_t *xfrom;                       ///< xref (from) list
 
 } vmcu_sfr_t;
 
@@ -381,8 +381,8 @@ typedef struct vmcu_label {                   ///< label structure
     uint16_t id;                              ///< unique label identifier
     uint16_t addr;                            ///< label address
 
-    int32_t n_xref;                           ///< xref (from) count
-    vmcu_xref_t *xref;                        ///< xref (from) list
+    int32_t n_xfrom;                          ///< xref (from) count
+    vmcu_xref_t *xfrom;                       ///< xref (from) list
 
 } vmcu_label_t;
 

engine/src/analyzer/modules/labels/label_analyzer.c

@@ -42,10 +42,10 @@ int vmcu_analyze_labels(vmcu_report_t *report) {
 
         lx->id       = i;
         lx->addr     = field[i];
-        lx->n_xref   = 0;
+        lx->n_xfrom  = 0;
 
-        int32_t *size = &lx->n_xref;
-        lx->xref = get_xrefs(report, lx, size);
+        int32_t *size = &lx->n_xfrom;
+        lx->xfrom = get_xrefs(report, lx, size);
     }
 
 cleanup:

engine/src/analyzer/modules/sfr/sfr_analyzer.c

@@ -52,8 +52,8 @@ int vmcu_analyze_sfr(vmcu_report_t *report, vmcu_model_t *mcu) {
 
         vmcu_sfr_t *sfr = &report->sfr[i];
 
-        sfr->n_xref = sfr_map[sfr->id];
-        sfr->xref   = get_xrefs(report, sfr, mcu);
+        sfr->n_xfrom = sfr_map[sfr->id];
+        sfr->xfrom   = get_xrefs(report, sfr, mcu);
     }
 
 cleanup:
@@ -118,9 +118,9 @@ static vmcu_sfr_t* get_sfrs(const int32_t *sfr_map, int32_t size, vmcu_model_t *
 
         sfrs[j++] = (vmcu_sfr_t) {
 
-            .id     = i,
-            .n_xref = 0,
-            .xref   = NULL
+            .id      = i,
+            .n_xfrom = 0,
+            .xfrom   = NULL
         };
     }
 
@@ -129,7 +129,7 @@ static vmcu_sfr_t* get_sfrs(const int32_t *sfr_map, int32_t size, vmcu_model_t *
 
 static vmcu_xref_t* get_xrefs(vmcu_report_t *report, vmcu_sfr_t *sfr, vmcu_model_t *mcu) {
 
-    vmcu_xref_t *xrefs = malloc(sfr->n_xref * sizeof(vmcu_xref_t));
+    vmcu_xref_t *xrefs = malloc(sfr->n_xfrom * sizeof(vmcu_xref_t));
 
     for(int32_t i = 0, j = 0; i < report->progsize; i++) {
 

engine/src/analyzer/report/report.c

@@ -39,14 +39,14 @@ void vmcu_report_dtor(vmcu_report_t *this) {
 
     for(int32_t i = 0; i < this->n_sfr; i++) {
 
-        if(this->sfr[i].n_xref > 0)
-            free(this->sfr[i].xref);
+        if(this->sfr[i].n_xfrom > 0)
+            free(this->sfr[i].xfrom);
     }
 
     for(int32_t i = 0; i < this->n_label; i++) {
 
-        if(this->label[i].n_xref > 0)
-            free(this->label[i].xref);
+        if(this->label[i].n_xfrom > 0)
+            free(this->label[i].xfrom);
     }
 
     for(int32_t i = 0; i < this->n_vector; i++) {