cx86.py
40.4 KB
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
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# cx86.py: modified by Franck Pommereau (2018)
# ---------------------------------------------------------------
# cx86.py
#
# Atul Varma
# Python C Compiler - Intel x86 Code Generator
# $Id: cx86.py,v 1.3 2004/06/02 21:05:23 varmaa Exp $
# ---------------------------------------------------------------
import io, os.path
from . import cparse
from .cvisitors import Visitor
# ---------------------------------------------------------------
# CONSTANTS
# ---------------------------------------------------------------
# Size of the 'int' type.
INT_SIZE = 4
# Size of the 'char' type.
CHAR_SIZE = 1
# The machine's word size. Note that making this different
# from INT_SIZE may cause serious problems.
WORD_SIZE = 4
# This is a strange multiplier that needs to be used in the allocation
# of global variables for the GNU Assembler. Not sure exactly what it
# represents.
WEIRD_MULTIPLIER = 4
# ---------------------------------------------------------------
# STACK MACHINE ABSTRACTION
# ---------------------------------------------------------------
class x86Registers:
"""This class attempts to abstract the x86 registers into a stack
machine. Calling push() gives you a register that isn't currently
in use by the stack machine, pop() gives you a register with the
value of the most recently pushed element.
Through this method the stack machine can be used to compute
values the same way a reverse polish notation (RPN) calculator
does.
When push() and pop() are called, it may be the case that no
registers are currently available; if this happens, the least
recently used register is 'spilled' into a temporary local
variable on the process' stack and freed for use. Note that the
process' stack is not to be confused with this stack machine
abstraction--the two are completely different entities.
Currently, push() and pop() also implement a little bit of
implicit type conversion, so they take as parameters a cparse.Type
object; currently conversion is done between char and int types,
so depending on the pushed and popped types, some type conversion
assembly code may be generated.
Finally, an additional method, done(), should be called whenever
the stack machine is done popping values for the current
operation. This is because when pop is called, the returned
register is not immediately made 'free' for another call to pop or
push. If this were the case, then the following situation could
occur:
rightOp.calc() # calc val of right op, put on stack
leftOp.calc() # calc val of left op, put on stack
l = leftOp.pop() # pop left val from stack
r = rightOp.pop() # pop right val from stack
output('addl %s, %s' % (r, l))
The problem with this approach is that we don't know how many
registers will be used by leftOp's calc() method--it may use all
the remaining registers, in which case the value that rightOp's
calc() method put on the stack is no longer stored in a register.
If leftOp.pop() returned register %eax and immediately marked the
%eax register as being 'free for use', then the call to
rightOp.pop() could very well generate code that moves rightOp's
value from a temporary variable into %eax, thereby overwriting
leftOp's value!
So, instead, the pop() method places the %eax register (in this
example) into an internal list of 'almost free' registers;
registers that have just been returned by pop() but shouldn't be
used by the stack machine until a call to done() is made. The
done() method simply moves the registers in the 'almost free' list
over to the 'free' list."""
def __init__(self, parent, base_fp):
# A list of all registers on the machine.
self.all_regs = ['%ebx','%esi','%edi','%eax','%ecx','%edx']
# A list of the registers currently free. Note that this
# is a *copy* of the list of all registers on the machine.
self.regs_free = self.all_regs[:]
# A list of all the registers that are "almost" free
# (see the docstring for this class).
self.regs_almost_free = []
# A list of all the temporary variable memory locations
# that are currently unused.
self.mem_free = []
# A list corresponding to the actual stack of the stack
# machine. The item at the top of the stack is the
# last element of this list.
self.stack = []
# A list that stores the Type objects of each corresponding
# element on the stack machine's stack. e.g., type_stack[0]
# represents the type of the element at stack[0].
self.type_stack = []
# The location of the next memory location to be used for
# temporary variables, relative to the current function's
# frame pointer.
self.next_temp = base_fp - WORD_SIZE
# The parent CodeGenVisitor object of this stack machine.
self.parent = parent
# A list of the callee-save registers that have been used
# so far by this function. Once processing is finished,
# these registers will be pushed onto the process' stack
# at the beginning of the function and popped off just
# before the function terminates.
self.callee_save_regs_used = []
# A list of the caller-save registers on the machine.
self.caller_save_regs = ['%eax', '%ecx', '%edx']
# A list of the callee-save registers on the machine.
self.callee_save_regs = ['%ebx', '%esi', '%edi']
# A list of the registers on the machine that have
# sub-registers allowing access to their low-order bytes.
self.byte_compat_regs = ['%eax', '%ebx', '%ecx', '%edx']
# The default type of an element that is pushed onto
# the stack machine without a 'type' object passed.
self.default_type = cparse.BaseType('int')
def o(self, str, comment=None):
"""Wrapper for the parent CodeGenVisitor's o() method."""
self.parent.o(str, comment)
def save_caller_saves(self):
"""Saves the caller-save registers, which should be done
before the current function makes a function call, so that
the registers don't get corrupted by the called function.
Normally, this is done by pushing the caller-save registers
onto the stack just before the function call is made and
popping them off afterwards; however, due to the workings of
this particular stack machine it's much easier to just move
the contents of the caller-save registers, if they are
currently being used, into temporary variables."""
for reg in self.caller_save_regs:
if reg not in self.regs_free:
self._copy_reg_to_temp([reg],
"Save caller-save register to temp")
self.regs_free.append(reg)
def save_callee_saves(self):
"""Emits code that pushes the callee-save registers used by
the stack machine onto the process' stack."""
for reg in self.callee_save_regs_used:
self.o(" pushl %s" % reg,
"Save callee-save register")
def load_callee_saves(self):
"""Emits code that pops the callee-save registers used by
the stack machine off the process' stack."""
for reg in reversed(self.callee_save_regs_used):
self.o(" popl %s" % reg,
"Restore callee-save register")
def _copy_reg_to_temp(self, valid_regs, comment_str=None):
"""Copy the least recently used register on the stack into a
temporary variable. The register must be in the valid_regs
list."""
# if no free temp variables exist,
# create a new one.
if len(self.mem_free) == 0:
self.mem_free.append("%d(%%ebp)" % self.next_temp)
self.next_temp -= WORD_SIZE
# get an unused temp var
mem = self.mem_free.pop()
# find the least recently used register on the stack
reg = None
index = 0
for i in self.stack:
if i in valid_regs:
reg = i
break
index += 1
if reg == None:
raise Exception("No free registers inside OR outside of stack!")
# emit code to copy the register to the memory location.
if comment_str == None:
comment_str = "Stack machine: copy register to temp"
self.o(" movl %s, %s" % (reg, mem),
comment_str)
# Modify the element's stack machine position to reflect
# its new location.
self.stack[index] = mem
return reg
def _get_free_reg(self, valid_regs, preferred_reg=None):
"""Returns a free register that is in the valid_regs list. If
no registers are available, the most least-recently used
eligible one is freed (by moving its contents to a temporary
variable) and returned."""
# If we have a register free, return it.
if len(self.regs_free) > 0:
reg = None
if preferred_reg != None and preferred_reg in self.regs_free:
reg = preferred_reg
else:
for r in self.regs_free:
if r in valid_regs:
reg = r
if reg != None:
self.regs_free.remove(reg)
# If this register is a callee-save register that
# we haven't used before, add it to our list
# of used callee-save registers.
if reg in self.callee_save_regs and reg not in self.callee_save_regs_used:
self.callee_save_regs_used.append(reg)
return reg
# copy a register into a temp var and return the register.
return self._copy_reg_to_temp(valid_regs)
def _get_type_valid_regs(self, type):
"""Returns the valid registers that an element of the given
type can occupy. For instance, 8-bit chars should only be
placed in %eax/%ebx/%ecx/%edx because these are the only
registers with low-order byte sub-registers
(%al/%bl/%cl/%dl)."""
type_str = type.get_outer_string()
if type_str == 'char':
return self.byte_compat_regs
elif type_str in ['int', 'pointer']:
return self.all_regs
def push(self, type=None, preferred_reg=None, valid_regs=None):
"""Finds a free eligible register (or frees one if all are
being used) and returns it, pushing the register onto the
stack machine's stack.
This method associates the stack entry with the given Type
object; if none is supplied, then an 'int' type is used
by default.
If preferred_reg is passed, this function will try its
best to return preferred_reg, if it's available."""
if type == None:
type = self.default_type
self.type_stack.append(type)
if valid_regs == None:
valid_regs = self._get_type_valid_regs(type)
reg = self._get_free_reg(valid_regs, preferred_reg)
self.stack.append(reg)
return reg
def _coerce_type(self, curr_reg, from_type, to_type):
"""Attempts to coerce the element in the current register
from the given type to the given type."""
from_str = from_type.get_outer_string()
to_str = to_type.get_outer_string()
comment_str = "Implicit cast: %s -> %s" % (from_str, to_str)
if from_str == to_str:
return curr_reg
if from_str == 'char':
if to_str == 'int':
return curr_reg
elif from_str == 'int':
if to_str == 'char':
self.o(" movzbl %s, %s" % (self.lo(curr_reg),
curr_reg),
comment_str)
return curr_reg
def pop(self, type=None, valid_regs=None):
"""Pops the top element off the stack machine's stack, coerces
it to the given type if necessary, and returns a register in
which the element's value now resides.
If no type is specified, pop() returns the value of the
element as-is."""
prev_type = self.type_stack.pop()
if type != None:
if valid_regs == None:
valid_regs = self._get_type_valid_regs(type)
reg = self._pop(valid_regs)
return self._coerce_type(reg, prev_type, type)
else:
return self._pop(self.all_regs)
def _pop(self, valid_regs):
"""Pops the top element of the stack into a free register
that is also in valid_regs and returns the register name. If
no registers are free, the least recently used one is first
copied into a temporary variable and then used."""
loc = self.stack.pop()
# If the top of the stack is a register, just return the
# name of the register and add the register to our free
# register list.
if loc in valid_regs:
self.regs_almost_free.append(loc)
return loc
# Otherwise, copy the temp variable at the top of the stack
# into a free register, possibly requiring us to spill the
# current contents of the memory register into another temp
# variable.
reg = self._get_free_reg(valid_regs)
self.o(" movl %s, %s" % (loc, reg),
"Stack machine: copy temp to register")
# if our location was a register but not in valid_regs,
# make the register free for use.
if loc in self.all_regs:
self.regs_free.append(loc)
self.regs_almost_free.append(reg)
return reg
def peek(self):
"""Returns the top element of the stack, but doesn't pop
it. Note that this is not guaranteed to be a register; it
could be a memory location!"""
return self.stack[-1]
def is_empty(self):
"""Returns whether the stack machine is empty."""
return len(self.stack) == 0
def done(self):
"""Frees all registers that are marked as being in
intermediate use (i.e., have been pop()'d)."""
self.regs_free.extend(self.regs_almost_free)
self.regs_almost_free = []
def get_max_fp(self):
"""Returns the maximum point in the process' stack, relative
to the current function's frame pointer, that the stack
machine is using for temporary variables."""
return self.next_temp + WORD_SIZE
def lo(self, reg):
"""Returns the low-order byte of the given register. If the
register isn't byte-compatible (i.e., isn't %eax, %ebx, %ecx,
or %edx), then an exception is raised.
Example: stack.lo('%eax') == '%al'."""
if reg[0] == '$':
return reg
if reg not in self.byte_compat_regs:
raise Exception("Register %s is not byte-compatible!" % reg)
return '%' + reg[2] + 'l'
def force_type_change(self, type):
"""Forces a type change of the top element of the stack."""
self.type_stack[-1] = type
# ---------------------------------------------------------------
# CODE GENERATOR
# ---------------------------------------------------------------
class CodeGenVisitor(Visitor):
"""Visitor that generates x86 assembly code for the abstract
syntax tree."""
# The current label number we're on, for generating
# jump labels in the assembly code (e.g., 'LO', 'L1', etc).
__label = 0
# Current label number for generating string literal labels.
__str_literal_label = 0
def __init__(self, path, test=None):
"""Constructor. 'file' is the file object to output the
resulting code to."""
Visitor.__init__(self)
# path of compiled C source
self.path = path
# Current assembly code for string literals.
self.str_literal_str = io.StringIO()
self.str_literal_dict = {}
# A hashtable of binary operators and the assembly
# instructions corresponding to them. Certain instructions
# are just the 'base' instruction and require a suffix
# corresponding to the size of the operands; for instance,
# addition can be accomplished with the 'addl' instruction
# for 32-bit integers and 'addb' for 8-bit integers.
#
# In such cases, the code adds the appropriate suffixes on its
# own.
self.binop_instructions = \
{ '==' : 'sete',
'!=' : 'setne',
'>=' : 'setge',
'<=' : 'setle',
'>' : 'setg',
'<' : 'setl',
'+' : 'add',
'-' : 'sub',
'*' : 'imul',
'=' : 'mov'
}
# Windows' C linkage prepends a '_' before symbol
# names, whereas Unix doesn't. This is particularly
# critical if the source file is linking to external
# libraries that we're not compiling. Figure out
# which one to use here.
import sys
if sys.platform == 'win32':
self.symbol_prepend = "_"
else:
self.symbol_prepend = ""
def new_label(self):
"""Generate a new jump label and return it."""
label = ".L%d" % self.__label
self.__class__.__label += 1
return label
def o(self, str, comment=None):
"""Output a line of assembly code to the output file,
with an optional annotated comment (if comments are
enabled)."""
if comment != None:
comment = "# %s" % comment
self.curr_str.write("%-35s %s\n" % (str, comment))
else:
if str == "":
return
self.curr_str.write(str + "\n")
def c(self, str, indent_amt=2):
"Output a single-line comment to the output file."
indent = " " * indent_amt
self.o("\n%s# %s\n" % (indent, str))
def vNodeList(self, node):
self._visitList(node.nodes)
def _empty_stack(self, node):
"""Pops the top value from the stack machine's stack and
discard it. This is used when a statement has a return
value (for instance, the line 'a = b + 1;') and its
return value has been pushed onto the stack but there's
nothing to pop it off."""
# if the statement was also an expression, then its return
# value is still on the stack, so empty it (throw away
# the return value).
if not self.stack.is_empty():
self.stack.pop(node.type)
self.stack.done()
if not self.stack.is_empty():
raise Exception("PANIC! Register stack isn't empty!")
def _accept_and_empty_stack(self, node):
"""Visit the node and then empty the stack machine of the
node's return value, if one exists."""
node.accept(self)
self._empty_stack(node)
def vStatementList(self, node):
for n in node.nodes:
self._accept_and_empty_stack(n)
def _generate_global_variable_definitions(self, node):
"""Generate and return a list of global variable
definitions."""
globals_str = io.StringIO()
for symbol in node.symtab.entries.values():
symbol.compile_loc = self.symbol_prepend + symbol.name
if not symbol.type.is_function() and not symbol.extern:
globals_str.write(" .comm %s,%d\n"
% (symbol.compile_loc,
self._calc_var_size(symbol.type)*WEIRD_MULTIPLIER))
return globals_str
def vTranslationUnit(self, node):
"""Outputs the entire assembly source file."""
self.curr_str = io.StringIO()
self.globals_str = self._generate_global_variable_definitions(node)
# Generate the main code.
self._visitList(node.nodes)
@classmethod
def concat (cls, outfile, chunks) :
outfile.write("# Generated by cct\n"
"# Franck Pommereau (2018)\n"
"# Adapted from Atul Varma's c.py (Spring 2004)\n\n")
#
outfile.write(".text\n\n")
for c in chunks :
outfile.write("# code from file %r\n" % c.path)
outfile.write(c.curr_str.getvalue())
#
outfile.write(".global_vars:\n\n")
for c in chunks :
outfile.write("\n# globals from file %r\n\n" % c.path)
outfile.write(c.globals_str.getvalue())
for c in chunks :
outfile.write("\n# string literals from file %r\n\n" % c.path)
outfile.write(c.str_literal_str.getvalue())
def _calc_var_size(self, type):
"""Calculate and return the size of the given type, in
bytes."""
type_str = type.get_outer_string()
if type_str == "int":
return INT_SIZE
elif type_str == "char":
return CHAR_SIZE
elif type_str == "pointer":
return WORD_SIZE
else:
self.error("Unknown type: %s" % type_str)
def _calc_var_align(self, type):
"""Calculate and return the alignment of the given type,
in bytes."""
return self._calc_var_size(type)
def _calc_function_var_addrs(self, symtab, last_fp_loc):
"""Calculate the addresses of all local variables in the
function and attach them to their respective symbols in
the function's symbol table(s)."""
self._calc_function_arg_addrs(symtab)
return self._calc_local_var_addrs(symtab.children[0], last_fp_loc)
def _calc_function_arg_addrs(self, symtab):
"""Calculate the addresses of all the arguments passed to
the function."""
for symbol in symtab.entries.values():
symbol.compile_loc = "%d(%%ebp)" % (WORD_SIZE*2+(symbol.param_num*WORD_SIZE))
if not symbol.is_used:
self.warning("function argument '%s' is never used." % symbol.name)
def _calc_local_var_addrs(self, symtab, last_fp_loc):
"""Calculate the locations of all the local variables defined
in the function's body and all nested scopes therein.
This model of allocation assumes a 'worst-case' scenario
where all branches and nested scopes of the function are
executed; thus the space required for all the local
variables is allocated on the process' stack at the
beginning of the function.
Note, however, that lexical scopes that cannot exist
at the same time may overlap in memory. For instance,
examine the following 'if' statement:
if (a > 1) {
int i;
} else {
int j;
}
Here 'i' and 'j' will actually occupy the same place in
memory because it is impossible for both of them to
exist in memory at the same time."""
for symbol in symtab.entries.values():
if symbol.extern:
symbol.compile_loc = self.symbol_prepend + symbol.name
continue
last_fp_loc -= self._calc_var_size(symbol.type)
# adjust location for alignment
align = self._calc_var_align(symbol.type)
bytes_overboard = (-last_fp_loc) % align
if bytes_overboard != 0:
last_fp_loc -= (align - bytes_overboard)
symbol.compile_loc = "%d(%%ebp)" % last_fp_loc
if not symbol.is_used:
self.warning("local variable '%s' is never used." % symbol.name)
max_last_fp = last_fp_loc
for kid in symtab.children:
curr_last_fp = self._calc_local_var_addrs(kid, last_fp_loc)
if curr_last_fp < max_last_fp:
max_last_fp = curr_last_fp
# adjust location for alignment, to keep the stack aligned
# on a word-sized boundary.
align = self._calc_var_align(cparse.PointerType())
bytes_overboard = (-max_last_fp) % align
if bytes_overboard != 0:
max_last_fp -= (align - bytes_overboard)
return max_last_fp
def _fill_line(self, str, width=70):
"""Fills a string to the given width with the '-'
character."""
extra = "-" * (width-1-len(str))
return str + " " + extra
def vFunctionDefn(self, node):
"""Output the assembly code for a function."""
self.break_labels = []
self.continue_labels = []
self.curr_func_end_label = self.new_label() + "_function_end"
# Calculate the base size of the stack frame (not including
# space for the stack machine's temporary variables).
stack_frame_size = self._calc_function_var_addrs(node.symtab, 0)
line = self._fill_line("BEGIN FUNCTION: %s()" % node.name)
self.c("%s\n"
"#\n"
"# Function type: %s" %
(line, node.type.get_string()), 0)
if not node.static:
self.o(" .global %s" % node.compile_loc)
self.o("%s:" % node.compile_loc)
self.o(" pushl %ebp", "Save old frame pointer")
self.o(" movl %esp, %ebp", "Set new frame pointer")
# Create a new stack machine for this function.
self.stack = x86Registers(self, stack_frame_size)
# Generate assembly code for the function. Here we
# perform a little hack so that we can generate the
# code for the function into a separate string, and then
# insert it into our code later on.
old_str = self.curr_str
self.curr_str = io.StringIO()
node.body.accept(self)
function_str = self.curr_str
self.curr_str = old_str
# Figure out the final size of the stack frame, taking into
# account the stack machine's temporary variables, and
# insert the code at the beginning of the function.
if self.stack.get_max_fp() != 0:
self.o(" subl $%d, %%esp" % (-self.stack.get_max_fp()),
"Allocate space for local+temp vars")
# Save any callee-save registers that may have been used.
self.stack.save_callee_saves()
# Add the previously-generated assembly code for the function.
self.curr_str.write(function_str.getvalue())
self.o("%s:" % self.curr_func_end_label)
# Restore any callee-save registers that may have been used.
self.stack.load_callee_saves()
self.o(" movl %ebp, %esp", "Deallocate stack frame")
self.o(" popl %ebp", "Restore old stack frame")
self.o(" ret\n")
line = self._fill_line("END FUNCTION: %s()" % node.name)
self.c(line, 0)
def vCompoundStatement(self, node):
node.statement_list.accept(self)
def vIfStatement(self, node):
done_label = self.new_label() + "_done"
if not node.else_stmt.is_null():
else_label = self.new_label() + "_else"
else:
else_label = done_label
self.c("IF statment - begin")
node.expr.accept(self)
comparer = self.stack.pop()
self.stack.done()
self.o(" testl %s, %s" % (comparer, comparer), "Test the result")
self.o(" jz %s" % else_label,
"If result is zero, jump to else clause")
self.c("IF statment - THEN clause - begin")
self._accept_and_empty_stack(node.then_stmt)
self.c("IF statment - THEN clause - end")
self.o(" jmp %s" % done_label)
if not node.else_stmt.is_null():
self.c("IF statment - ELSE clause - begin")
self.o("%s:" % else_label)
self._accept_and_empty_stack(node.else_stmt)
self.c("IF statment - ELSE clause - end")
self.o("%s:" % done_label)
self.c("IF statment - end")
def _push_loop_labels(self, break_label, continue_label):
"""Pushes new values of labels to jump to for 'break' and
'continue' statements."""
self.break_labels.append(break_label)
self.continue_labels.append(continue_label)
def _pop_loop_labels(self):
"""Restores old values of labels to jump to for 'break' and
'continue' statements."""
self.break_labels.pop()
self.continue_labels.pop()
def vWhileLoop(self, node):
test_label = self.new_label() + "_test"
done_label = self.new_label() + "_done"
self._push_loop_labels(break_label=done_label,
continue_label=test_label)
self.c("WHILE loop - begin")
self.o("%s:" % test_label)
node.expr.accept(self)
comparer = self.stack.pop()
self.stack.done()
self.o(" testl %s, %s" % (comparer, comparer), "Test the result")
self.o(" jz %s" % done_label,
"If result is zero, leave while loop")
self._accept_and_empty_stack(node.stmt)
self.o(" jmp %s" % test_label, "Jump to start of while loop")
self.o("%s:" % done_label)
self.c("WHILE loop - end")
self._pop_loop_labels()
def vForLoop(self, node):
test_label = self.new_label() + "_test"
done_label = self.new_label() + "_done"
self._push_loop_labels(break_label=done_label,
continue_label=test_label)
self.c("FOR loop - begin")
self._accept_and_empty_stack(node.begin_stmt)
self.o("%s:" % test_label)
node.expr.accept(self)
comparer = self.stack.pop()
self.stack.done()
self.o(" testl %s, %s" % (comparer, comparer), "Test the result")
self.o(" jz %s" % done_label,
"If result is zero, leave for loop")
self._accept_and_empty_stack(node.stmt)
self._accept_and_empty_stack(node.end_stmt)
self.o(" jmp %s" % test_label, "Jump to start of for loop")
self.o("%s:" % done_label)
self.c("FOR loop - end")
self._pop_loop_labels()
def vBreakStatement(self, node):
self.o(" jmp %s" % self.break_labels[-1],
"Loop: break statement")
def vContinueStatement(self, node):
self.o(" jmp %s" % self.continue_labels[-1],
"Loop: continue statement")
def _get_new_str_literal_label(self, str):
"""Create a new string literal label for the given string,
generate (but do not yet emit) the assembly for it, and return
the name of the new label."""
if str in self.str_literal_dict :
return self.str_literal_dict[str]
label_str = "LC%d" % self.__str_literal_label
self.str_literal_dict[str] = label_str
str = str.replace('\n', '\\12')
self.str_literal_str.write("""%s:\n .ascii "%s\\0"\n""" % (label_str, str))
self.__class__.__str_literal_label += 1
return label_str
def vStringLiteral(self, node):
label_str = self._get_new_str_literal_label(node.get_str())
# Make a little preview of the literal in the annotated
# comments.
COMMENT_CHARS = 7
comment_label = node.get_sanitized_str()
if len(comment_label) > COMMENT_CHARS:
comment_label = "%s..." % comment_label[0:COMMENT_CHARS]
self.o(" movl $%s, %s" % (label_str,
self.stack.push(node.type)),
"Get addr of string literal '%s'" % comment_label)
def vConst(self, node):
self.o(" movl $%d, %s" % (node.value,
self.stack.push(node.type)),
"Load numeric constant %d" % node.value)
def vId(self, node):
# If we're only supposed to push our address on the stack, not
# our actual value, then do that and exit.
if node.output_addr:
self.o(" leal %s, %s" % (node.symbol.compile_loc,
self.stack.push()),
"Get address of %s" % node.symbol.name)
return
type_str = node.type.get_outer_string()
if type_str in ['pointer', 'int']:
instr = 'movl'
elif type_str == 'char':
instr = 'movzbl'
self.o(" %s %s, %s" % (instr, node.symbol.compile_loc,
self.stack.push(node.type)),
"Get value of %s" % node.symbol.name)
def vArrayExpression(self, node):
node.expr.accept(self)
node.index.accept(self)
reg_index = self.stack.pop(node.index.type)
reg_expr = self.stack.pop(node.expr.type)
reg_to = self.stack.push(node.type)
size = self._calc_var_size(node.type)
addr_str = "(%s,%s,%d)" % (reg_expr, reg_index, size)
self.stack.done()
if node.output_addr:
self.o(" leal %s, %s" % (addr_str, reg_to),
"Load addr of pointer array index")
else:
type_str = node.type.get_outer_string()
if type_str in ['int', 'pointer']:
instr = 'movl'
elif type_str == 'char':
instr = 'movzbl'
self.o(" %s %s, %s" % (instr, addr_str, reg_to),
"Pointer array index dereference")
def vFunctionExpression(self, node):
"""Generates assembly for calling a function."""
self.c("FUNCTION CALL to %s() - begin" %
node.function.symbol.name)
# If we're using any caller-save registers, free them up.
self.stack.save_caller_saves()
# We need to temporarily reverse the order of the function's
# arguments because we need to push them onto the stack
# in reverse order.
node.arglist.nodes.reverse()
argnum = len(node.arglist.nodes)
for arg in node.arglist.nodes:
arg_reg = self._accept_and_pop(arg)
self.o(" pushl %s" % arg_reg, "Push arg %d" % argnum)
self.stack.done()
argnum -= 1
node.arglist.nodes.reverse()
self.o(" call %s" % node.function.symbol.compile_loc,
"Call %s()" % node.function.symbol.name)
# The function will place its return value in register %eax.
# So, we'll push a register from the stack and ask it to
# give us %eax.
result = self.stack.push(node.function.symbol.type.get_return_type(), preferred_reg='%eax')
# If we got %eax, don't do anything, because our return
# value is already in there. Otherwise, move it.
#
# (Note that in the current implementation of the stack
# machine, we should always get %eax.)
if result != '%eax':
self.o(" movl %%eax, %s" % result, "Copy return value")
arg_stack_size = (len(node.arglist.nodes)*WORD_SIZE)
if arg_stack_size > 0:
self.o(" addl $%d, %%esp" % arg_stack_size,
"Deallocate argument stack")
self.c("FUNCTION CALL to %s() - end" %
node.function.symbol.name)
def vReturnStatement(self, node):
return_reg = self._accept_and_pop(node.expr)
self.o(" movl %s, %%eax" % return_reg, "Set return value")
self.o(" jmp %s" % self.curr_func_end_label, "Exit function")
self.stack.done()
def _accept_and_pop(self, node):
"""Accept the given node and pop its value into a register and
return the register. Implicit type conversion is performed,
if necessary, by the stack machine.
Also, if the node is determined to be a numeric constant,
the literal value of the constant (e.g., '$15') is returned,
for purposes of optimization."""
if node.is_const():
return "$%d" % node.value
else:
node.accept(self)
return self.stack.pop(node.coerce_to_type)
def _binop_assign(self, node):
"""Performs an assignment operation (=, +=, etc) on the given
Binop node."""
node.left.accept(self)
right_reg = self._accept_and_pop(node.right)
left_reg = self.stack.pop()
instr = self.binop_instructions[node.op[0]]
instr += self._type_suffix(node.type)
type_str = node.type.get_outer_string()
if type_str == 'char':
right_reg = self.stack.lo(right_reg)
self.o(" %s %s, (%s)" % (instr, right_reg, left_reg),
"Perform assignment '%s'" % node.op)
# NOTE: Wow, this makes for insanely inefficient code, especially
# when the result of the operation isn't being used.
if type_str in ['int', 'pointer']:
instr = 'movl'
elif type_str == 'char':
instr = 'movzbl'
self.o(" %s (%s), %s" % (instr, left_reg,
self.stack.push(node.type)),
"Copy assignment result to register")
self.stack.done()
def _type_suffix(self, type):
"""Returns the assembly instruction suffix for the given type;
'l' for 32-bit types, 'b' for 8-bit types, etc..."""
type_str = type.get_outer_string()
if type_str in ['int', 'pointer']:
return 'l'
elif type_str == 'char':
return 'b'
def _binop_arith(self, node):
"""Performs an arithmetic operation (+, -, etc) on the given
Binop node."""
node.left.accept(self)
right_reg = self._accept_and_pop(node.right)
left_reg = self.stack.pop(node.left.coerce_to_type)
instr = self.binop_instructions[node.op] + \
self._type_suffix(node.type)
type_str = node.type.get_outer_string()
if type_str == 'char':
r_reg = self.stack.lo(right_reg)
l_reg = self.stack.lo(left_reg)
else:
r_reg = right_reg
l_reg = left_reg
self.o(" %s %s, %s" % (instr, r_reg, l_reg),
"Perform '%s'" % node.op)
self.stack.done()
# Here we are relying on the fact that left_reg is now free
# from the last pop(), so we should be able to push it
# back onto the stack machine.
new_reg = self.stack.push(node.type, preferred_reg=left_reg)
if new_reg != left_reg:
raise Exception("PANIC! Binop push() isn't same as last pop()!")
def _binop_compare(self, node):
"""Performs a comparison operation (>, ==, etc) on the given
Binop node."""
node.left.accept(self)
right_reg = self._accept_and_pop(node.right)
left_reg = self.stack.pop(node.left.coerce_to_type)
self.stack.done()
self.o(" cmpl %s, %s" % (right_reg, left_reg),
"Compare %s to %s" % (left_reg, right_reg))
# TODO: this could cause errors, if push() generates
# mov instructions... not sure if mov instructions
# change the flags though, they probably shouldn't
# since they're not arithmetic operations.
byte_reg = self.stack.push(cparse.BaseType('char'))
lo = self.stack.lo(byte_reg)
self.o(" %s %s" % (self.binop_instructions[node.op],
lo),
"Perform '%s'" % node.op)
self.o(" movzbl %s, %s" % (lo, byte_reg),
"Zero-extend the boolean result")
def vBinop(self, node):
if node.op in cparse.Binop.ASSIGN_OPS:
self._binop_assign(node)
elif node.op in ['+','-','*']:
self._binop_arith(node)
elif node.op in ['==', '!=', '<', '>', '<=', '>=']:
self._binop_compare(node)
def vNegative(self, node):
node.expr.accept(self)
self.o(" negl %s" % self.stack.peek(),
"Perform unary negation")
def vPointer(self, node):
node.expr.accept(self)
if node.output_addr:
self.o("", "(Getting pointer target addr via '*')")
return
reg_from = self.stack.pop(node.expr.type)
reg_to = self.stack.push(node.type)
type_str = node.type.get_outer_string()
if type_str in ['int', 'pointer']:
instr = 'movl'
elif type_str == 'char':
instr = 'movzbl'
self.o(" %s (%s), %s" % (instr, reg_from, reg_to),
"Pointer dereference")
self.stack.done()
def vAddrOf(self, node):
node.expr.accept(self)
self.stack.force_type_change(node.type)
self.o("", "(Address-of operator '&' used here)")
# ---------------------------------------------------------------
# End of cx86.py
# ---------------------------------------------------------------
def compile (path) :
tgt = os.path.splitext(path)[0]
return tgt, ["gcc", "-m32", "-o", tgt, path]
def cpp (args, path) :
if args.test :
return ["cpp", "-P", "-D", "CC", path]
else :
return ["cpp", "-P", path]