summaryrefslogtreecommitdiffstats
path: root/debug/risc-v-gsp-rm-vm/tests/test_core.py
blob: ab2745149381a0fadeaf907789631cbd252b2c49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
"""Unit tests for ELF parsing, symbol resolution and structure decoding."""
from __future__ import annotations

import json
import os
import tempfile
import unittest

from greeneye.elf import EM_RISCV, parse_elf, load_elf
from greeneye.structs import Field, Schema, decode, render, schema_from_json
from greeneye.symbols import Symbol, SymbolDB

DEMO_ELF = os.path.join(os.path.dirname(__file__), "..", "firmware", "uproc_demo", "build", "uproc_demo.elf")


class ElfTests(unittest.TestCase):
    def test_parse_demo_elf(self):
        if not os.path.exists(DEMO_ELF):
            self.skipTest("demo firmware not built")
        image = load_elf(DEMO_ELF)
        self.assertTrue(image.is_riscv)
        self.assertEqual(image.e_machine, EM_RISCV)
        self.assertEqual(image.entry, 0x80000000)
        self.assertGreaterEqual(len(image.load_segments), 1)
        names = {s.name for s in image.symbols}
        self.assertIn("main", names)
        self.assertIn("rpc_ping", names)
        self.assertIn("gsp_ctrl", names)
        ctrl = next(s for s in image.symbols if s.name == "gsp_ctrl")
        self.assertEqual(ctrl.value, 0x80000840)
        self.assertEqual(ctrl.size, 0x188)
        plan = image.flat_load_plan()
        self.assertTrue(plan and plan[0][0] == 0x80000000)

    def test_not_elf(self):
        with self.assertRaises(Exception):
            parse_elf(b"not an elf")


class SymbolTests(unittest.TestCase):
    def setUp(self):
        self.db = SymbolDB()
        self.db.add(Symbol(addr=0x1000, name="alpha", size=0x100, source="test"))
        self.db.add(Symbol(addr=0x1200, name="beta", size=0x20, source="test"))

    def test_resolve(self):
        self.assertEqual(self.db.resolve(0x1010).name, "alpha")
        self.assertEqual(self.db.resolve(0x1210).name, "beta")
        self.assertIsNone(self.db.resolve(0x5000))
        self.assertEqual(self.db.annotate(0x1010), "0x1010 alpha+0x10")
        self.assertEqual(self.db.lookup("beta"), 0x1200)

    def test_names_tsv(self):
        with tempfile.NamedTemporaryFile("w", suffix=".tsv", delete=False) as fh:
            fh.write("# comment\n0x00279000\t_DT_INIT\tghidra\n0x00279020\tFUN_x\n")
            path = fh.name
        try:
            count = self.db.load_names_tsv(path, bias=0x100000)
            self.assertEqual(count, 2)
            self.assertEqual(self.db.lookup("_DT_INIT"), 0x279000 + 0x100000)
        finally:
            os.unlink(path)

    def test_index_tsv(self):
        with tempfile.NamedTemporaryFile("w", suffix=".tsv", delete=False) as fh:
            fh.write("addr\tfile_addr\tsize\tname\n")
            fh.write("0x00279000\t0x00179000\t24\t_DT_INIT\n")
            path = fh.name
        try:
            count = self.db.load_index_tsv(path, bias=0)
            self.assertEqual(count, 1)
            sym = self.db.get("_DT_INIT")
            self.assertEqual(sym.addr, 0x179000)
            self.assertEqual(sym.size, 24)
            self.assertEqual(sym.extras["program_addr"], 0x279000)
        finally:
            os.unlink(path)

    def test_json_roundtrip(self):
        with tempfile.NamedTemporaryFile("w", suffix=".json", delete=False) as fh:
            path = fh.name
        try:
            self.db.save_json(path, meta={"unit": "test"})
            other = SymbolDB()
            self.assertEqual(other.load_json(path), 2)
            self.assertEqual(other.lookup("alpha"), 0x1000)
            payload = json.load(open(path))
            self.assertEqual(payload["format"], "greeneye-symbols/1")
        finally:
            os.unlink(path)


class StructTests(unittest.TestCase):
    SCHEMA = {
        "name": "demo",
        "fields": [
            {"name": "magic", "offset": 0, "fmt": "u32"},
            {"name": "state", "offset": 4, "fmt": "u32", "enum": {"0": "IDLE", "1": "RUN"}},
            {"name": "count", "offset": 8, "fmt": "u64"},
            {"name": "name", "offset": 16, "fmt": "cstr", "size": 16},
            {"name": "buf", "offset": 32, "fmt": "bytes", "size": 8},
        ],
    }

    def test_decode_render(self):
        schema = schema_from_json(self.SCHEMA)
        self.assertEqual(schema.size, 40)
        data = bytearray(40)
        data[0:4] = (0x47535031).to_bytes(4, "little")
        data[4:8] = (1).to_bytes(4, "little")
        data[8:16] = (42).to_bytes(8, "little")
        data[16:22] = b"green\x00"
        data[32:40] = bytes(range(8))
        values = decode(schema, bytes(data), base=0x80000000)
        self.assertEqual(values["magic"], 0x47535031)
        self.assertEqual(values["state"], 1)
        self.assertEqual(values["count"], 42)
        self.assertEqual(values["name"], "green")
        self.assertEqual(values["buf"], bytes(range(8)))
        text = render(schema, values)
        self.assertIn("magic", text)
        self.assertIn("0x47535031", text)
        self.assertIn("green", text)

    def test_invalid_schema(self):
        with self.assertRaises(Exception):
            Field(name="x", offset=0, fmt="nope").nbytes


if __name__ == "__main__":
    unittest.main()