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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
|
# Assign addresses (co-ordinates) to instructions (landmarks) in a program
# (landscape).
# Use the addresses assigned to:
# a) replace labels
# b) add segment headers with addresses and offsets correctly filled in
#
# To build (from the subx/ directory):
# $ ./subx translate *.subx apps/survey.subx -o apps/survey
#
# The expected input is a stream of bytes with segment headers, comments and
# some interspersed labels.
# $ cat x
# == code 0x1
# l1:
# aa bb l1/imm8
# cc dd l2/disp32
# l2:
# ee foo/imm32
# == data 0x10
# foo:
# 00
#
# The output is the stream of bytes without segment headers or label definitions,
# and with label references replaced with numeric values/displacements.
#
# $ cat x |./subx run apps/assort
# ...ELF header bytes...
# # ELF header above will specify that code segment begins at this offset
# aa bb nn # some computed address
# cc dd nn nn nn nn # some computed displacement
# ee nn nn nn nn # some computed address
# # ELF header above will specify that data segment begins at this offset
# 00
== code
# instruction effective address register displacement immediate
# . op subop mod rm32 base index scale r32
# . 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes
Entry:
# Heap = new-segment(64KB)
# . . push args
68/push Heap/imm32
68/push 0x10000/imm32/64KB
# . . call
e8/call new-segment/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# initialize-trace-stream(256KB)
# . . push args
68/push 0x40000/imm32/256KB
# . . call
e8/call initialize-trace-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# run tests if necessary, convert stdin if not
# . prolog
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# initialize heap
# - if argc > 1 and argv[1] == "test", then return run_tests()
# . argc > 1
81 7/subop/compare 1/mod/*+disp8 5/rm32/EBP . . . . 0/disp8 1/imm32 # compare *EBP
7e/jump-if-lesser-or-equal $run-main/disp8
# . argv[1] == "test"
# . . push args
68/push "test"/imm32
ff 6/subop/push 1/mod/*+disp8 5/rm32/EBP . . . . 8/disp8 . # push *(EBP+8)
# . . call
e8/call kernel-string-equal?/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check result
3d/compare-EAX-and 1/imm32
75/jump-if-not-equal $run-main/disp8
# . run-tests()
e8/call run-tests/disp32
8b/copy 0/mod/indirect 5/rm32/.disp32 . . 3/r32/EBX Num-test-failures/disp32 # copy *Num-test-failures to EBX
eb/jump $main:end/disp8
$run-main:
# - otherwise convert stdin
# var ed/EAX : exit-descriptor
81 5/subop/subtract 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # subtract from ESP
89/copy 3/mod/direct 0/rm32/EAX . . . 4/r32/ESP . . # copy ESP to EAX
# configure ed to really exit()
# . ed->target = 0
c7 0/subop/copy 0/mod/direct 0/rm32/EAX . . . . . 0/imm32 # copy to *EAX
# return convert(Stdin, 1/stdout, 2/stderr, ed)
# . . push args
50/push-EAX/ed
68/push Stderr/imm32
68/push Stdout/imm32
68/push Stdin/imm32
# . . call
e8/call convert/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0x10/imm32 # add to ESP
# . syscall(exit, 0)
bb/copy-to-EBX 0/imm32
$main:end:
b8/copy-to-EAX 1/imm32/exit
cd/syscall 0x80/imm8
# data structures:
# segment-info: {address, file-offset, size} (12 bytes)
# segments: (address stream {string, segment-info}) (16 bytes per row)
# label-info: {segment-name, segment-offset, address} (12 bytes)
# labels: (address stream {string, label-info}) (16 bytes per row)
convert: # in : (address buffered-file), out : (address buffered-file) -> <void>
# pseudocode
# var segments = new-stream(10 rows, 16 bytes each)
# var labels = new-stream(512 rows, 16 bytes each)
# compute-offsets(in, segments, labels)
# compute-addresses(segments, labels)
# rewind-stream(in)
# emit-output(in, out, segments, labels)
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
51/push-ECX
52/push-EDX
# var segments/ECX = stream(10 * 16)
81 5/subop/subtract 3/mod/direct 4/rm32/ESP . . . . . 0xa0/imm32 # subtract from ESP
68/push 0xa0/imm32/length
68/push 0/imm32/read
68/push 0/imm32/write
89/copy 3/mod/direct 1/rm32/ECX . . . 4/r32/ESP . . # copy ESP to ECX
# var labels/EDX = stream(512 * 16)
81 5/subop/subtract 3/mod/direct 4/rm32/ESP . . . . . 0x2000/imm32 # subtract from ESP
68/push 0x2000/imm32/length
68/push 0/imm32/read
68/push 0/imm32/write
89/copy 3/mod/direct 2/rm32/EDX . . . 4/r32/ESP . . # copy ESP to EDX
# compute-offsets(in, segments, labels)
# . . push args
52/push-EDX
51/push-ECX
ff 6/subop/push 1/mod/*+disp8 5/rm32/EBP . . . . 8/disp8 . # push *(EBP+8)
# . . call
e8/call compute-offsets/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP
# compute-addresses(segments, labels)
# . . push args
52/push-EDX
51/push-ECX
# . . call
e8/call compute-addresses/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0x10/imm32 # add to ESP
# rewind-stream(in)
# . . push args
ff 6/subop/push 1/mod/*+disp8 5/rm32/EBP . . . . 8/disp8 . # push *(EBP+8)
# . . call
e8/call rewind-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# emit-output(in, out, segments, labels)
# . . push args
52/push-EDX
51/push-ECX
ff 6/subop/push 1/mod/*+disp8 5/rm32/EBP . . . . 0xc/disp8 . # push *(EBP+12)
ff 6/subop/push 1/mod/*+disp8 5/rm32/EBP . . . . 8/disp8 . # push *(EBP+8)
# . . call
e8/call emit-output/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0x10/imm32 # add to ESP
$convert:end:
# . reclaim locals
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0x214/imm32 # add to ESP
# . restore registers
5a/pop-to-EDX
59/pop-to-ECX
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
test-convert-computes-addresses:
# input:
# == code 0x1
# ab x/imm32
# == data 0x1000
# x:
# 01
#
# trace contains (in any order):
# label x is at address 0x1079
# segment code starts at address 0x74
# segment code has size 5
# segment data starts at address 0x1079
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# setup
# . clear-stream(_test-input-stream)
# . . push args
68/push _test-input-stream/imm32
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-input-buffered-file+4)
# . . push args
b8/copy-to-EAX _test-input-buffered-file/imm32
05/add-to-EAX 4/imm32
50/push-EAX
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-output-stream)
# . . push args
68/push _test-output-stream/imm32
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-output-buffered-file+4)
# . . push args
b8/copy-to-EAX _test-output-buffered-file/imm32
05/add-to-EAX 4/imm32
50/push-EAX
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# initialize input
# . write(_test-input-stream, "== code 0x1\n")
# . . push args
68/push "== code 0x1\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "ab x/imm32\n")
# . . push args
68/push "ab x/imm32\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "== data 0x1000\n")
# . . push args
68/push "== data 0x1000\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "x:\n")
# . . push args
68/push "x:\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "01\n")
# . . push args
68/push "01\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# convert(_test-input-buffered-file, _test-output-buffered-file)
# . . push args
68/push _test-output-buffered-file/imm32
68/push _test-input-buffered-file/imm32
# . . call
e8/call convert/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# check trace
# . check-trace-contains("label 'x' is at address 0x1079", msg)
# . . push args
68/push "F - test-convert-computes-addresses/0"/imm32
68/push "label 'x' is at address 0x1079"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'code' starts at address 0x74", msg)
# . . push args
68/push "F - test-convert-computes-addresses/1"/imm32
68/push "segment 'code' starts at address 0x74"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'code' has size 0x5", msg)
# . . push args
68/push "F - test-convert-computes-addresses/2"/imm32
68/push "segment 'code' has size 0x5"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'data' starts at address 0x1079", msg)
# . . push args
68/push "F - test-convert-computes-addresses/3"/imm32
68/push "segment 'data' starts at address 0x1079"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
compute-offsets: # in : (address buffered-file), segments : (address stream {string, segment-info}), labels : (address stream {string, label-info})
# pseudocode:
# var curr-segment-name = 0
# var file-offset = 0, segment-offset = 0
# var line = new-stream(512, 1)
# while true
# clear-stream(line)
# read-line-buffered(in, line)
# if (line->write == 0) break # end of file
# while true
# var word-slice = next-word(line)
# if slice-empty?(word-slice) # end of line
# break
# if slice-starts-with?(word-slice, "#") # comment
# continue
# if is-label?(word-slice)
# x : (address number) = insert(labels, name)
# *x = segment-offset
# trace("label '", word-slice, "' is in segment '", curr-segment-name, "'")
# trace("label '", word-slice, "' is at offset 0x", file-offset)
# # labels occupy no space, so no need to increment offsets
# continue
# if slice-equal?(word-slice, "==")
# curr-segment-name = next-word(line)
# if slice-empty?(curr-segment-name)
# abort
# segment-start = next-word(line)
# if slice-empty?(segment-start)
# abort
# seg = insert(segments, curr-segment-name)
# seg->starting-address = parse-hex-int(segment-start)
# seg->starting-offset = file-offset
# trace("segment '", curr-segment-name, "' is at file offset 0x", seg->starting-offset)
# trace("segment '", curr-segment-name, "' has size 0x", seg->starting-offset)
# segment-offset = 0
# else
# width = compute-width(word-slice)
# segment-offset += width
# file-offset += width
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$compute-offsets:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
test-compute-offsets:
# input:
# == code 0x1
# ab x/imm32
# == data 0x1000
# x:
# 34
#
# trace contains (in any order):
# segment 'code' is at file offset 0x0
# segment 'code' has size 0x5
# segment 'data' is at file offset 0x5
# label 'x' is in segment 'data'
# label 'x' is at offset 0x0
# segment 'data' has size 0x1
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# setup
# . clear-stream(_test-input-stream)
# . . push args
68/push _test-input-stream/imm32
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-input-buffered-file+4)
# . . push args
b8/copy-to-EAX _test-input-buffered-file/imm32
05/add-to-EAX 4/imm32
50/push-EAX
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-output-stream)
# . . push args
68/push _test-output-stream/imm32
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# . clear-stream(_test-output-buffered-file+4)
# . . push args
b8/copy-to-EAX _test-output-buffered-file/imm32
05/add-to-EAX 4/imm32
50/push-EAX
# . . call
e8/call clear-stream/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP
# var segments/ECX = stream(2 * 16)
81 5/subop/subtract 3/mod/direct 4/rm32/ESP . . . . . 0x20/imm32 # subtract from ESP
68/push 0x20/imm32/length
68/push 0/imm32/read
68/push 0/imm32/write
89/copy 3/mod/direct 1/rm32/ECX . . . 4/r32/ESP . . # copy ESP to ECX
# var labels/EDX = stream(2 * 16)
81 5/subop/subtract 3/mod/direct 4/rm32/ESP . . . . . 0x20/imm32 # subtract from ESP
68/push 0x20/imm32/length
68/push 0/imm32/read
68/push 0/imm32/write
89/copy 3/mod/direct 2/rm32/EDX . . . 4/r32/ESP . . # copy ESP to EDX
# initialize input
# . write(_test-input-stream, "== code 0x1\n")
# . . push args
68/push "== code 0x1\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "ab x/imm32\n")
# . . push args
68/push "ab x/imm32\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "== data 0x1000\n")
# . . push args
68/push "== data 0x1000\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "x:\n")
# . . push args
68/push "x:\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . write(_test-input-stream, "34\n")
# . . push args
68/push "34\n"/imm32
68/push _test-input-stream/imm32
# . . call
e8/call write/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# compute-offsets(_test-input-buffered-file, _test-output-buffered-file, segments, labels)
# . . push args
52/push-EDX
51/push-ECX
68/push _test-output-buffered-file/imm32
68/push _test-input-buffered-file/imm32
# . . call
e8/call compute-offsets/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0x10/imm32 # add to ESP
# check trace
# . check-trace-contains("segment 'code' is at file offset 0x0", msg)
# . . push args
68/push "F - test-compute-offsets/0"/imm32
68/push "segment 'code' is at file offset 0x0"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'code' has size 0x5", msg)
# . . push args
68/push "F - test-compute-offsets/1"/imm32
68/push "segment 'code' has size 0x5"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'data' is at file offset 0x5", msg)
# . . push args
68/push "F - test-compute-offsets/2"/imm32
68/push "segment 'data' is at file offset 0x5"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'data' has size 0x1", msg)
# . . push args
68/push "F - test-compute-offsets/3"/imm32
68/push "segment 'data' has size 0x1"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("label 'x' is in segment 'data'", msg)
# . . push args
68/push "F - test-compute-offsets/4"/imm32
68/push "label 'x' is in segment 'data'"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("label 'x' is at offset 0x0", msg)
# . . push args
68/push "F - test-compute-offsets/5"/imm32
68/push "label 'x' is at offset 0x0"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
compute-addresses: # segments : (address stream {string, segment-info}), labels : (address stream {string, label-info})
# pseudocode:
# s : (address segment-info) = segments->data + 4 # skip key
# max = segments->data + segments->write
# while true
# if (s >= max) break
# s->address &= 0xfffff000 # clear last 12 bits for p_align
# s->address += (s->file-offset & 0x00000fff)
# s += 16 # size of segment-info
# l : (address label-info) = labels->data + 4 # skip key
# max = labels->data + labels->write
# while true
# if (l >= max) break
# seg-name : (address string) = l->segment-name
# label-seg : (address segment-info) = get(labels, seg-name)
# l->address = label-seg->address + l->segment-offset
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$compute-addresses:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
test-compute-addresses:
# segment-info:
# - {'a', 0x1000, 5, 0}
# - {'b', 0x500, 1, 0}
# - {'c', 0x5444, 12, 0}
# label-info:
# - {'l1', 'code', 3, 0}
# - {'l2', 'data', 0, 0}
#
# trace contains (in any order):
# segment 'code starts at address 0x1074
# segment 'data starts at address 0x579
# label 'l1' is at address 0x1077
# label 'l2' is at address 0x579
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# setup
# . check-trace-contains("segment 'code' starts at address 0x1074", msg)
# . . push args
68/push "F - test-compute-addresses/0"/imm32
68/push "segment 'code' starts at address 0x1074"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("segment 'data' starts at address 0x579", msg)
# . . push args
68/push "F - test-compute-addresses/1"/imm32
68/push "segment 'data' starts at address 0x579"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("label 'l1' is at address 0x1077", msg)
# . . push args
68/push "F - test-compute-addresses/2"/imm32
68/push "label 'l1' is at address 0x1077"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . check-trace-contains("label 'l2' is at address 0x579", msg)
# . . push args
68/push "F - test-compute-addresses/3"/imm32
68/push "label 'l2' is at address 0x579"/imm32
# . . call
e8/call check-trace-contains/disp32
# . . discard args
81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
emit-output: # in : (address buffered-file), out : (address buffered-file), segments : (address stream {string, segment-info}), labels : (address stream {string, label-info})
# pseudocode:
# emit-headers(out, segments, labels)
# var offset-of-next-instruction = 0
# var line = new-stream(512, 1)
# while true
# clear-stream(line)
# read-line-buffered(in, line)
# if (line->write == 0) break # end of file
# offset-of-next-instruction += num-bytes(line)
# while true
# var word-slice = next-word(line)
# if slice-empty?(word-slice) # end of line
# break
# if slice-starts-with?(word-slice, "#") # comment
# break
# if is-label?(word-slice) # no need for label declarations anymore
# break
# if slice-equal?(word-slice, "==")
# break # no need for segment header lines
# if length(word-slice) == 2
# write-slice-buffered(out, word-slice)
# write-buffered(out, " ")
# continue
# datum = next-token(word-slice, "/")
# info = get(labels, datum)
# if has-metadata?(word-slice, "imm8")
# abort # label should never go to imm8
# else if has-metadata?(word-slice, "imm32")
# emit(out, info->address, 4)
# else if has-metadata?(word-slice, "disp8")
# value = info->offset - offset-of-next-instruction
# emit(out, value, 1)
# else if has-metadata?(word-slice, "disp32")
# value = info->offset - offset-of-next-instruction
# emit(out, value, 4)
# else
# abort
# write-buffered(out, "\n")
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$emit-output:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
emit-headers: # out : (address buffered-file), segments : (address stream {string, segment-info}), labels : (address stream {string, label-info})
# pseudocode:
# emit-elf-header(out, segments, labels)
# curr-segment = segments->data
# max = segments->data + segments->write
# while true
# if (curr-segment >= max) break
# emit-elf-program-header-entry(curr-segment)
# curr-segment += 20 # size of a row
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$emit-headers:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
emit-elf-header: # out : (address buffered-file), segments : (address stream {string, segment-info}), labels : (address stream {string, label-info})
# pseudocode
# *Elf_e_entry = get(labels, "Entry")->address
# *Elf_e_phnum = segments->write / 20 # size of a row
# write(out, Elf_header)
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$emit-elf-header:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
emit-elf-program-header-entry: # curr-segment : {string, segment-info}
# pseudocode:
# *Elf_p_offset = curr-segment->file-offset
# *Elf_p_vaddr = curr-segment->address
# *Elf_p_paddr = curr-segment->address
# *Elf_p_filesz = curr-segment->size
# *Elf_p_memsz = curr-segment->size
# if curr-segment->name == "code"
# *Elf_p_flags = 5 # r-x
# else
# *Elf_p_flags = 6 # rw-
# write(out, Elf_program_header_entry)
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$emit-elf-program-header-entry:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
num-bytes: # line : (address stream) -> EAX : int
# pseudocode:
# result = 0
# while true
# var word-slice = next-word(line)
# if slice-empty?(word-slice) # end of line
# break
# if slice-starts-with?(word-slice, "#") # comment
# break
# if is-label?(word-slice) # no need for label declarations anymore
# break
# if slice-equal?(word-slice, "==")
# break # no need for segment header lines
# result += compute-width(word-slice)
# return result
#
# . prolog
55/push-EBP
89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP
# . save registers
$num-bytes:end:
# . reclaim locals
# . restore registers
# . epilog
89/copy 3/mod/direct 4/rm32/ESP . . . 5/r32/EBP . . # copy EBP to ESP
5d/pop-to-EBP
c3/return
== data
Segment-size:
0x1000/imm32/4KB
# This block of bytes gets copied to the start of the output ELF file, with
# some fields filled in.
# http://www.sco.com/developers/gabi/latest/ch4.eheader.html
Elf_header:
# - length
0x34/imm32
# - data
$e_ident:
7f 45/E 4c/L 46/F
01/32-bit 01/little-endian 01/file-version 00/no-os-extensions
00 00 00 00 00 00 00 00 # 8 bytes of padding
$e_type:
02 00
$e_machine:
03 00
$e_version:
1/imm32
Elf_e_entry:
0x09000000/imm32 # approximate default; must be updated
$e_phoff:
0x34/imm32 # offset for the 'program header table' containing segment headers
$e_shoff:
0/imm32 # no sections
$e_flags:
0/imm32 # unused
$e_ehsize:
0x34 00
$e_phentsize:
0x20 00
Elf_e_phnum:
00 00 # number of segments; must be updated
$e_shentsize:
00 00 # no sections
$e_shnum:
00 00
$e_shstrndx:
00 00
# This block of bytes gets copied after the Elf_header once for each segment.
# Some fields need filling in each time.
# https://docs.oracle.com/cd/E19683-01/816-1386/chapter6-83432/index.html
Elf_program_header_entry:
# - length
0x20/imm32
# - data
$p_type:
1/imm32/PT_LOAD
Elf_p_offset:
0/imm32 # byte offset in the file at which a segment begins; must be updated
Elf_p_vaddr:
0/imm32 # starting address to store the segment at before running the program
Elf_p_paddr:
0/imm32 # should have same value as Elf_p_vaddr
Elf_p_filesz:
0/imm32
Elf_p_memsz:
0/imm32 # should have same value as Elf_p_filesz
Elf_p_flags:
6/imm32/rw- # read/write/execute permissions for the segment; must be updated for the code segment
$p_align:
# we hold this constant; changing it will require adjusting the way we
# compute the starting address for each segment
0x1000/imm32
# . . vim:nowrap:textwidth=0
|