forked from micropython/micropython-esp32-ulp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathassemble.py
307 lines (257 loc) · 8.66 KB
/
assemble.py
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
#
# This file is part of the micropython-esp32-ulp project,
# https://github.com/micropython/micropython-esp32-ulp
#
# SPDX-FileCopyrightText: 2018-2023, the micropython-esp32-ulp authors, see AUTHORS file.
# SPDX-License-Identifier: MIT
from esp32_ulp.assemble import Assembler, TEXT, DATA, BSS, REL, ABS
from esp32_ulp.assemble import SymbolTable
from esp32_ulp.nocomment import remove_comments
src = """\
.set const, 123
.set const_left, 976
start: wait 42
ld r0, r1, 0
st r0, r1,0
halt
end:
.data
"""
src_bss = """\
.bss
label:
.long 0
"""
src_global = """\
.global counter
counter:
.long 0
internal:
.long 0
.text
.global entry
entry:
wait 42
halt
"""
def test_parse_line():
a = Assembler()
lines = iter(src.splitlines())
assert a.parse_line(next(lines)) == (None, '.set', ('const', '123', ))
assert a.parse_line(next(lines)) == (None, '.set', ('const_left', '976', ))
assert a.parse_line(next(lines)) == None
assert a.parse_line(next(lines)) == ('start', 'wait', ('42', ))
assert a.parse_line(next(lines)) == (None, 'ld', ('r0', 'r1', '0', ))
assert a.parse_line(next(lines)) == (None, 'st', ('r0', 'r1', '0', ))
assert a.parse_line(next(lines)) == (None, 'halt', ())
assert a.parse_line(next(lines)) == ('end', None, ())
assert a.parse_line(next(lines)) == (None, '.data', ()) # test left-aligned directive is not treated as label
def test_parse_labels_correctly():
"""
description of what defines a label
https://sourceware.org/binutils/docs/as/Statements.html
https://sourceware.org/binutils/docs/as/Labels.html
"""
a = Assembler()
assert a.parse_line('') is None
assert a.parse_line('label: .set const, 42') == ('label', '.set', ('const', '42',))
assert a.parse_line('label:.set const, 42') == ('label', '.set', ('const', '42',))
assert a.parse_line('label:') == ('label', None, ())
assert a.parse_line(' label:') == ('label', None, ())
assert a.parse_line(' label: ') == ('label', None, ())
assert a.parse_line('nop ') == (None, 'nop', ())
assert a.parse_line('.set c, 1 ') == (None, '.set', ('c', '1',))
assert a.parse_line('invalid : nop') == (None, 'invalid', (': nop',)) # no whitespace between label and colon
assert a.parse_line('.string "hello world"') == (None, '.string', ('"hello world"',))
assert a.parse_line('.string "hello : world"') == (None, '.string', ('"hello : world"',)) # colon in string
assert a.parse_line('label::') == ('label', ':', ())
assert a.parse_line('label: :') == ('label', ':', ())
assert a.parse_line('a_label:') == ('a_label', None, ())
assert a.parse_line('$label:') == ('$label', None, ())
assert a.parse_line('.label:') == ('.label', None, ())
assert a.parse_line('&label:') == (None, '&label:', ()) # & not a valid char in a label
def test_parse():
a = Assembler()
lines = remove_comments(src)
result = a.parse(lines)
assert None not in result
def test_assemble():
a = Assembler()
a.assemble(src)
assert a.symbols.has_sym('const')
assert a.symbols.has_sym('const_left')
assert a.symbols.has_sym('start')
assert a.symbols.has_sym('end')
assert a.symbols.get_sym('const') == (ABS, None, 123)
assert a.symbols.get_sym('const_left') == (ABS, None, 976)
assert a.symbols.get_sym('start') == (REL, TEXT, 0)
assert a.symbols.get_sym('end') == (REL, TEXT, 4)
assert len(b''.join(a.sections[TEXT])) == 16 # 4 instructions * 4B
assert len(a.sections[DATA]) == 0
assert a.offsets[BSS] == 0
def test_assemble_bss():
a = Assembler()
try:
a.assemble(src_bss)
except TypeError:
raised = True
else:
raised = False
assert not raised
assert a.offsets[BSS] == 4 # 1 word * 4B
def test_assemble_bss_with_value():
lines = """\
.bss
.long 3 #non-zero value not allowed in bss section
"""
a = Assembler()
try:
a.assemble(lines)
except ValueError as e:
if str(e) != "attempt to store non-zero value in section .bss":
raise # re-raise failures we didn't expect
raised = True
else:
raised = False
assert raised
def test_assemble_global():
a = Assembler()
a.assemble(src_global)
assert a.symbols.has_sym('counter')
assert a.symbols.has_sym('internal')
assert a.symbols.has_sym('entry')
exported_symbols = a.symbols.export()
assert exported_symbols == [(0, 'counter'), (2, 'entry')] # internal not exported
exported_symbols = a.symbols.export(True) # include non-global symbols
assert exported_symbols == [(0, 'counter'), (1, 'internal'), (2, 'entry')]
def test_assemble_uppercase_opcode():
a = Assembler()
try:
a.assemble(" WAIT 42")
except ValueError as e:
if str(e) != "Unknown opcode or directive: WAIT":
# re-raise failures we didn't expect
raise
raised = True
else:
raised = False
assert not raised
def test_assemble_evalulate_expressions():
src_w_expr = """\
.set shft, 2
.set loops, (1 << shft)
entry:
move r0, 1+1
move r1, loops
move r2, (shft + 10) * 2
move r3, entry << 2
"""
a = Assembler()
a.assemble(src_w_expr)
assert a.symbols.has_sym('shft')
assert a.symbols.has_sym('loops')
assert a.symbols.has_sym('entry')
assert a.symbols.get_sym('shft') == (ABS, None, 2)
assert a.symbols.get_sym('loops') == (ABS, None, 4)
assert a.symbols.get_sym('entry') == (REL, TEXT, 0)
def test_assemble_optional_comment_removal():
line = " move r1, 123 # comment"
a = Assembler()
# first assemble as normal (comments will be removed by default)
a.assemble(line)
# now assemble with comment removal disabled
try:
a.assemble(line, remove_comments=False)
except ValueError as e:
raised = True
else:
raised = False
assert raised
def test_assemble_test_regressions_from_evaluation():
line = " reg_wr (0x3ff48400 + 0x10), 1, 1, 1"
a = Assembler()
raised = False
try:
a.assemble(line)
except ValueError as e:
if str(e) == 'invalid register base': # ensure we trapped the expected Exception
raised = True
assert not raised
def test_symbols():
st = SymbolTable({}, {}, {})
for entry in [
('rel_t4', REL, TEXT, 4),
('abs_t4', ABS, TEXT, 4),
('rel_d4', REL, DATA, 4),
('abs_d4', ABS, DATA, 4),
('const', ABS, None, 123),
]:
st.set_sym(*entry)
# PASS 1 ========================================================
assert st.has_sym('abs_t4')
assert st.get_sym('abs_t4') == (ABS, TEXT, 4)
assert not st.has_sym('notexist')
try:
st.get_sym('notexist') # pass1 -> raises
except KeyError:
raised = True
else:
raised = False
assert raised
assert st.resolve_absolute('abs_t4') == 4
try:
# relative symbols cannot be resolved, because in pass 1 section bases are not yet defined
st.resolve_absolute('rel_t4')
except KeyError:
raised = True
else:
raised = False
assert raised
assert st.resolve_absolute('const') == 123
# PASS 2 ========================================================
st.set_bases({TEXT: 100, DATA: 200})
assert st.has_sym('abs_t4')
assert st.get_sym('abs_t4') == (ABS, TEXT, 4)
assert not st.has_sym('notexist')
try:
st.get_sym('notexist') # pass2 -> raises
except KeyError:
raised = True
else:
raised = False
assert raised
assert st.resolve_absolute('abs_t4') == 4
assert st.resolve_absolute('abs_d4') == 4
assert st.resolve_absolute('rel_t4') == 100 + 4
assert st.resolve_absolute('rel_d4') == 200 + 4
assert st.resolve_absolute('const') == 123
st.set_from(TEXT, 8)
assert st.resolve_relative('abs_t4') == 4 - 108
assert st.resolve_relative('abs_d4') == 4 - 108
assert st.resolve_relative('rel_t4') == 104 - 108
assert st.resolve_relative('rel_d4') == 204 - 108
assert st.resolve_absolute('const') == 123
def test_support_multiple_statements_per_line():
src = """
label: nop; nop;
wait 42
"""
lines = Assembler().parse(src.splitlines())
assert lines == [
('label', 'nop', ()),
(None, 'nop', ()),
(None, 'wait', ('42',))
]
test_parse_line()
test_parse_labels_correctly()
test_parse()
test_assemble()
test_assemble_bss()
test_assemble_bss_with_value()
test_assemble_global()
test_assemble_uppercase_opcode()
test_assemble_evalulate_expressions()
test_assemble_optional_comment_removal()
test_assemble_test_regressions_from_evaluation()
test_support_multiple_statements_per_line()
test_symbols()