Removed superfluous debug comments from ARM generator
[voodoo-lang.git] / lib / voodoo / generators / arm_gas_generator.rb
blobdac73568eeacbc5982789b9785ea1cb8d655aae7
1 require 'voodoo/generators/common_code_generator'
3 module Voodoo
4   # = ARM GNU Assembler Code Generator
5   #
6   # The ARM code generator generates assembly code for use with
7   # the GNU assembler.
8   #
9   # == Calling Convention
10   #
11   # The first four arguments are passed in the registers r0 through r3.
12   # Any additional arguments are passed on the stack, starting at
13   # r13. r13 will always be a multiple of 8.
14   #
15   # The return address for the called function is passed in r14.
16   #
17   # The called function will store its return value in r0.
18   #
19   # The called function is required to preserve the values of registers
20   # r4 through r11 and register r13.
21   #
22   # This calling convention is compatible with the Procedure Call
23   # Standard for the ARM Architecture (AAPCS).
24   #
25   # == Call Frames
26   #
27   # Call frames have the following layout:
28   #
29   # When a function is called, it receives a stack frame that looks like
30   # the following:
31   #
32   #   :
33   #   old frame
34   #   padding
35   #   argn
36   #   :
37   #   arg4        <-- r13 points here
38   #
39   # The function prologue of functions generated by this code generator
40   # creates activation frames that look as follows:
41   #
42   #   :
43   #   old frame
44   #   padding
45   #   argn
46   #   :
47   #   arg4       <-- r11 points here
48   #   saved r14
49   #   saved r11
50   #   :
51   #   saved r4   <-- r13 points here
52   #
53   # == Register Usage
54   #
55   # Inside a function, registers r4..r8 and r10 are used for local variables
56   # and function arguments, whereas r11 is used as a frame pointer.
57   #
58   # r12 is used as a temporary, and r3 is used when another temporary
59   # is needed.
60   #
61   class ARMGasGenerator < CommonCodeGenerator
62     def initialize params
63       @WORDSIZE_BITS = 2
64       @WORDSIZE = 1 << @WORDSIZE_BITS
65       @CODE_ALIGNMENT = 4
66       @DATA_ALIGNMENT = @WORDSIZE
67       @FUNCTION_ALIGNMENT = @WORDSIZE
68       @STACK_ALIGNMENT_BITS = 3
69       @STACK_ALIGNMENT = 1 << @STACK_ALIGNMENT_BITS
70       @SAVE_FRAME_REGISTERS = [:r4, :r5, :r6, :r7, :r8, :r9,
71                                :r10, :r11, :r13, :r14]
72       @INITIAL_FRAME_SIZE = 2 * @WORDSIZE
73       @NREGISTER_ARGS = 4
74       @NREGISTER_LOCALS = 6
75       @FP = :r11
76       @RETURN = :r0
77       @TEMPORARY = :r12
78       @constants = []
79       @frame_offset = 0
80       @frame_size = 0
81       @function_end_label = nil
82       @imports = {}
83       @if_labels = []
84       @saved_registers = []       # registers we've saved in the current frame
85       super params
86       @output_file_suffix = '.s'
87       @features.merge! \
88         :'bits-per-word' => '32',
89         :'byte-order' => 'little-endian',
90         :'bytes-per-word' => 4
91     end
93     # Create an entry in the constants table,
94     # returning the label that will refer to the constant.
95     # The value may be an integer or a label.
96     def add_constant value
97       label = gensym
98       @constants << [label, value]
99       label
100     end
102     def align alignment = nil
103       unless alignment
104         # Get default alignment
105         case @section
106         when :code
107           alignment = @CODE_ALIGNMENT
108         when :data
109           alignment = @DATA_ALIGNMENT
110         when :function
111           alignment = @FUNCTION_ALIGNMENT
112         else
113           # Use data alignment as default
114           alignment = @DATA_ALIGNMENT
115         end
116       end
117       emit ".align #{alignment}\n" unless alignment == 0
118     end
120     # Returns the fp-relative offset for the nth (0-based) argument.
121     def arg_offset n
122       (n - @NREGISTER_ARGS) * @WORDSIZE
123     end
124     
125     # Returns an fp-relative reference for the nth (0-based) argument.
126     def arg_reference n
127       offset_reference arg_offset(n)
128     end
130     # Return the register in which the nth (0-based) argument is stored, or
131     # nil if not stored in a register
132     def arg_register n
133       # The first @NREGISTER_ARGS arguments are in the v registers,
134       # the rest are on the stack.
135       if register_arg? n
136         "v#{n + 1}"
137       else
138         nil
139       end
140     end
142     def auto_bytes value, register
143       if value.kind_of? Integer
144         grow_frame value
145       else
146         temporary = register == :sp ? @TEMPORARY : register
147         load_value_into_register value, temporary
148         auto_bytes_register temporary
149       end
150       emit "cpy #{register}, sp\n" unless register == :sp
151     end
152     
153     # auto-bytes where the value is supplied in a register and the return
154     # value will be in sp. register must not be sp.
155     def auto_bytes_register register
156       temporary = register == @TEMPORARY ? :r3 : @TEMPORARY
157       emit "add #{register}, #{register}, \##{@STACK_ALIGNMENT - 1}\n"
158       emit "mvn #{temporary}, \##{@STACK_ALIGNMENT - 1}\n"
159       emit "and #{register}, #{register}, #{temporary}\n"
160       emit "sub sp, #{register}\n"
161     end
162     
163     def auto_words value, register
164       if value.kind_of? Integer
165         auto_bytes(value * @WORDSIZE, register)
166       else
167         temporary = register == :sp ? @TEMPORARY : register
168         load_value_into_register value, temporary
169         emit "lsl #{temporary}, #{temporary}, \##{@WORDSIZE_BITS}\n"
170         auto_bytes_register temporary
171         emit "cpy #{register}, sp\n" unless register == :sp
172       end
173     end
174     
175     # Begins a new block.
176     def begin_block *code
177       # If we are starting a block at top level, create a frame
178       if @environment == @top_level
179         nlocals = count_locals code
180         create_frame nlocals, false
181       end
182       @environment = Environment.new @environment
183     end
185     # Emit function prologue and declare _formals_ as function arguments
186     def begin_function formals, nlocals
187       if @environment != @top_level
188         raise "Can only begin a function at top level"
189       end
191       @function_end_label = gensym
192       environment = Environment.new @environment
193       formals.each_with_index do |formal, i|
194         if i < @NREGISTER_ARGS
195           environment.add_arg formal, arg_register(i)
196         else
197           environment.add_arg formal, arg_offset(i)
198         end
199       end
200       @environment = environment
201       emit_function_prologue formals, nlocals
202     end
204     # Define a byte with the given value
205     def byte value
206       emit ".byte #{value}\n"
207     end
209     # Call a function.
210     def call func, *args
211       # Calculate how many arguments need to be pushed on
212       # the stack, and allocate space for them.
213       nstack_args = number_of_stack_arguments args.length
214       old_frame_offset = @frame_offset
215       old_frame_size = @frame_size
216       grow_frame nstack_args if nstack_args > 0
218       # Put stack arguments on the stack
219       (@NREGISTER_ARGS...args.length).each do |n|
220         load_value_into_register args[n], @TEMPORARY
221         emit "str #{@TEMPORARY}, " +
222           "[sp , \##{(n - @NREGISTER_ARGS) * @WORDSIZE}]\n"
223       end
225       # Put register arguments in the right registers
226       nregister_args = number_of_register_arguments args.length
227       nregister_args.times do |n|
228           load_value_into_register args[n], :"a#{n + 1}"        
229       end
231       # Call function
232       if global? func
233         emit "bl #{func}\n"
234       else
235         func_reg = load_value func
236         emit "blx #{func_reg}\n"
237       end
239       # Restore original stack frame
240       if old_frame_size != @frame_size
241         emit "add sp, sp, \##{@frame_size - old_frame_size}\n"
242         @frame_offset = old_frame_offset
243         @frame_size = old_frame_size
244       end
245     end
247     # Creates a stack frame for the given number of arguments
248     # and local variables.
249     def create_frame nvars, save_lr = true
250       # Calculate how many variables we will store in registers,
251       # and how many on the stack.
252       nregister_vars = [nvars, @NREGISTER_LOCALS].min
253       nstack_vars = nvars - nregister_vars
255       # Save the registers we will clobber to the stack.
256       clobbered = []
257       nregister_vars.times do |i|
258         clobbered << :"v#{i < 5 ? i + 1 : i + 2}"
259       end
260       clobbered << @FP
261       clobbered << :lr if save_lr
262       @saved_registers = clobbered
263       emit "stmfd sp!, {#{clobbered.join ', '}}\n"
264       emit "add #{@FP}, sp, \##{clobbered.length * @WORDSIZE}\n"
266       # Calculate frame size so that the stack pointer will
267       # be properly aligned at the end of emit_function_prologue.
268       @frame_size = stack_align((clobbered.length + nstack_vars) * @WORDSIZE)
269       extra_space = @frame_size - clobbered.length * @WORDSIZE
270       if extra_space > 0
271         emit "sub sp, sp, \##{extra_space}\n"
272       end
273       @frame_offset = 0
274     end
276     # Emits a comment.
277     def comment text
278       emit "# #{text}\n"
279     end
281     # Start a conditional using the specified branch instruction
282     # after the comparison.
283     def common_if comp, x, y = nil
284       xreg = load_value x, @TEMPORARY
285       yreg = load_value y, :a4
287       falselabel = @environment.gensym
288       @if_labels.push falselabel
290       emit "cmp #{xreg}, #{yreg}\n"
292       lut = { :ifeq => "bne", :ifge => "blt", :ifgt => "ble",
293         :ifle => "bgt", :iflt => "bge", :ifne => "beq" }
294       emit "#{lut[comp]} #{falselabel}\n"
295     end
297     # Destroys the current stack frame.
298     # If ret is true, loads the saved value of lr into pc.
299     def destroy_frame ret = false
300       # Set sp back to where saved registers were stored
301       saved = @saved_registers
302       emit "sub sp, #{@FP}, \##{saved.length * @WORDSIZE}\n"
304       if ret
305         index = saved.index :lr
306         if index
307           saved[index] = :pc
308         else
309           raise "Request to load saved lr into pc, but lr has not been saved"
310         end
311       end
312       emit "ldmfd sp!, {#{saved.join ', '}}\n"
313       
314       emit_constants if ret
315     end
317     # Writes any constants that need to be written to the instruction
318     # stream, and clears the list of constants that need to be written.
319     def emit_constants
320       @constants.each do |x|
321         label x[0]
322         word x[1]
323       end
324       @constants = []
325     end
327     # Emit function prologue.
328     def emit_function_prologue formals = [], nlocals = 0
329       # Calculate the number of arguments we were passed in
330       # registers, the total number of values we need to save
331       # on the stack, then create a stack frame and save
332       # the v registers we will be using.
333       nregister_args = [formals.length, @NREGISTER_ARGS].min
334       nvars = nregister_args + nlocals
335       create_frame nvars, true
337       # Move arguments that were passed in registers into
338       # callee-save registers.
339       nregister_args.times do |i|
340         emit "cpy v#{i + 1}, a#{i + 1}\n"
341       end
342     end
344     # Ends the current block.
345     def end_block
346       # If we are returning to top level, restore stack pointer
347       # and saved registers.
348       if @environment.parent == @top_level
349         offset = @frame_size - @saved_registers.length * @WORDSIZE
350         if offset > 0
351           emit "add sp, sp, \##{offset}\n"
352         end
353         emit "ldmfd sp!, {#{@saved_registers.join ', '}}\n"
354         @frame_size = 0
355         @frame_offset = 0
356         @saved_registers = []
358         # If we need to emit constants, do so now
359         unless @constants.empty?
360           lbl = gensym
361           goto lbl
362           label lbl
363         end
364       end
366       # Restore old value of @environment
367       @environment = @environment.parent
368     end
370     # Ends a function body.
371     def end_function
372       if @environment == @top_level
373         raise "Cannot end function when not in a function"
374       end
376       label @function_end_label
378       destroy_frame true
379       @frame_size = 0
380       @frame_offset = 0
381       @saved_registers = []
382       @environment = @top_level
383     end
385     # Ends a conditional.
386     def end_if
387       label @if_labels.pop
388     end
390     # Evaluate the binary operation expr and store the result in register
391     def eval_binop expr, register
392       op = expr[0]
394       # Emulation for div and mod, which ARM does not have instructions for
395       case op
396       when :div
397         func = :"__aeabi_idiv"
398         import func unless @imports.has_key? func
399         call func, expr[1], expr[2]
400         emit "cpy #{register}, r0\n" if register != :r0
401         return
402       when :mod
403         func = :"__aeabi_idivmod"
404         import func unless @imports.has_key? func
405         call func, expr[1], expr[2]
406         emit "cpy #{register}, r1\n" if register != :r1
407         return
408       end
410       x = load_value expr[1], :a4
411       y = load_value expr[2], @TEMPORARY
413       case op
414       when :bsr
415         emit "lsr #{register}, #{x}, #{y}\n"
416       when :or
417         emit "orr #{register}, #{x}, #{y}\n"
418       when :mul
419         # Can't store result in same register as first operand.
420         if register == x
421           if x == y
422             # All using the same register. Move x to a different
423             # register to make this work.
424             temp = (x == @TEMPORARY) ? :a4 : @TEMPORARY
425             emit "cpy #{temp}, #{x}\n"
426             emit "mul #{register}, #{temp}, #{y}\n"
427           else
428             # Multiplication is commutative. Just swap x and y.
429             emit "mul #{register}, #{y}, #{x}\n"
430           end
431         else
432           # Common case, register and x are different.
433           emit "mul #{register}, #{x}, #{y}\n"
434         end
435       when :rol
436         emit "rsb #{y}, #{y}, #32\n"
437         emit "ror #{register}, #{x}, #{y}\n"
438       when :shl
439         emit "lsl #{register}, #{x}, #{y}\n"
440       when :shr
441         emit "lsr #{register}, #{x}, #{y}\n"
442       when :xor
443         emit "eor #{register}, #{x}, #{y}\n"
444       else
445         emit "#{expr[0]} #{register}, #{x}, #{y}\n"
446       end
447     end
449     # Evaluates the expression +expr+ and stores the result in +register+.
450     def eval_expr expr, register
451       if expr.length == 1
452         # Load value
453         load_value_into_register expr[0], register
454       else
455         # Evaluate expression
456         op = expr[0]
457         case op
458         when :'auto-bytes'
459           auto_bytes expr[1], register
460         when :'auto-words'
461           auto_words expr[1], register
462         when :call
463           call *expr[1..-1]
464           emit "cpy #{register}, #{@RETURN}\n" if register != @RETURN
465         when :'get-byte'
466           get_byte expr[1], expr[2], register
467         when :'get-word'
468           get_word expr[1], expr[2], register
469         when :not
470           load_value_into_register expr[1], register
471           emit "mvn #{@TEMPORARY}, #0\n"
472           emit "eor #{register}, #{register}, #{@TEMPORARY}\n"
473         else
474           if binop? op
475             eval_binop expr, register
476           else
477             raise "Not a magic word: #{op}"
478           end
479         end
480       end
481     end
483     # Export symbols from the current section
484     def export *symbols
485       symbols.each { |sym| emit ".globl #{sym}\n" }
486     end
488     # Load byte from _base_ + _offset_ into _register_
489     def get_byte base, offset, register
490       # If base is an integer, but offset isn't, swap them
491       if !integer?(offset) && integer?(base)
492         base, offset = [offset, base]
493       end
495       if integer? offset
496         base_reg = load_value base
497         if offset == 0
498           emit "ldrb #{register}, [#{base_reg}]\n"
499         else
500           emit "ldrb #{register}, [#{base_reg}, \##{offset}]\n"
501         end
502       else
503         base_reg = load_value base
504         offset_reg = load_value offset, :a4
505         emit "ldrb #{register}, [#{base_reg}, #{offset_reg}]\n"
506       end
507     end
509     # Load word from _base_ + _offset_ * _@WORDSIZE_ into _register_
510     def get_word base, offset, register
511       if integer? offset
512         base_reg = load_value base
513         if offset == 0
514           emit "ldr #{register}, [#{base_reg}]\n"
515         else
516           emit "ldr #{register}, [#{base_reg}, \##{offset * @WORDSIZE}]\n"
517         end
518       else
519         base_reg = load_value base
520         offset_reg = load_value offset, :a4
521         emit "ldr #{register}, [#{base_reg}, #{offset_reg}, LSL #2]\n"
522       end
523     end
525     # Jump to a label.
526     def goto label
527       if global? label
528         emit "b #{label}\n"
529       else
530         register = load_value label
531         emit "cpy pc, #{register}\n"
532       end
534       # If we have constants that need to be emitted, do so now
535       emit_constants
536     end
538     # Grows the current frame by n words, plus padding to
539     # respect alignment rules.
540     def grow_frame nwords
541       increment = stack_align(nwords * @WORDSIZE)
542       emit "sub sp, sp, \##{increment}\n"
543       @frame_size = @frame_size + increment
544       @frame_offset = @frame_offset + increment
545     end
547     # Start the false path of a conditional.
548     def ifelse
549       newlabel = @environment.gensym
550       goto newlabel
551       lbl = @if_labels.pop
552       label lbl
553       @if_labels.push newlabel
554     end
556     # Test if x is equal to y
557     def ifeq x, y
558       common_if :ifeq, x, y
559     end
561     # Test if x is greater than or equal to y
562     def ifge x, y
563       common_if :ifge, x, y
564     end
566     # Test if x is strictly greater than y
567     def ifgt x, y
568       common_if :ifgt, x, y
569     end
571     # Test if x is less than or equal to y
572     def ifle x, y
573       common_if :ifle, x, y
574     end
576     # Test if x is strictly less than y
577     def iflt x, y
578       common_if :iflt, x, y
579     end
581     # Test if x different from y
582     def ifne x, y
583       common_if :ifne, x, y
584     end
586     # Import labels into the current section
587     def import *symbols
588       # Record imported labels in @imports
589       symbols.each { |sym| @imports[sym] = sym }
590     end
592     # Emit a label
593     def label name
594       emit "#{name}:\n"
595     end
597     # Introduce a new local variable
598     def let symbol, *expr
599       n = @environment.locals
600       register = local_register n
602       if register
603         # We will use a register to store the value
604         @environment.add_local symbol, register
605         eval_expr expr, register
606       else
607         # We will use the stack to store the value
608         offset = local_offset n
609         @environment.add_local symbol, offset
610         eval_expr expr, @TEMPORARY
611         emit "str #{@TEMPORARY}, #{offset_reference offset}\n"
612       end
613     end
615     # Load the value at the given address.
616     def load_at address, register = @TEMPORARY
617       load_value_into_register address, register
618       emit "ldr #{register}, [#{register}]\n"
619       register
620     end
622     # Load a value into a register.
623     # Returns the name of the register.
624     # If the value was already in a register, the name of that
625     # register is returned.
626     # Else, the value is loaded into a register and the name of
627     # that register is returned. The register to use in that case
628     # may be specified using the optional second argument.
629     def load_value x, register = @TEMPORARY
630       if substitution? x
631         x = substitute_number x[1]
632       end
633         
634       if integer? x
635         if x >= 0 && x <= 255
636           emit "mov #{register}, \##{x}\n"
637           return register
638         elsif x >= -255 && x < 0
639           emit "mvn #{register}, \##{-(x + 1)}\n"
640           return register
641         else
642           lbl = add_constant x
643           emit "ldr #{register}, #{lbl}\n"
644           return register
645         end
646       elsif symbol? x
647         binding = @environment[x]
648         if binding.kind_of? String
649           # Value is already in a register. Return register name.
650           return binding
651         elsif binding.kind_of? Integer
652           # Value is on the stack. Load from the stack.
653           emit "ldr #{register}, #{offset_reference binding}\n"
654           return register
655         else
656           # Assume global
657           lbl = add_constant x
658           emit "ldr #{register}, #{lbl}\n"
659           return register
660         end
661       elsif at_expr? x
662         load_at x[1], register
663       else
664         raise "Don't know how to load #{x.inspect}"
665       end
666     end
668     # Load a value into a specific register
669     def load_value_into_register x, register
670       reg = load_value x, register
671       if reg != register
672         emit "cpy #{register}, #{reg}\n"
673       end
674     end
676     # Returns the fp-relative reference for the nth (0-based) local.
677     def local_offset n
678       -@INITIAL_FRAME_SIZE - (n * @WORDSIZE)
679     end
680     
681     # Return the register in which the nth local (0-based) is stored, or
682     # nil if not stored in a register
683     def local_register n
684       if register_local? n
685         n = n + number_of_register_arguments
686         if n < 5
687           "v#{n + 1}"
688         else
689           "v#{n + 2}"
690         end
691       else
692         nil
693       end
694     end
696     # Calculate the number of register arguments,
697     # given the total number of arguments.
698     def number_of_register_arguments n = @environment.args
699       [n, @NREGISTER_ARGS].min
700     end
702     # Calculate the number of stack arguments,
703     # given the total number of arguments.
704     def number_of_stack_arguments n = @environment.args
705       [0, n - @NREGISTER_ARGS].max
706     end
708     # Given an offset, returns an fp-relative reference.
709     def offset_reference offset
710       "[#{@FP}, \##{offset}]"
711     end
713     # Returns true if the nth (0-based) argument is stored in a register
714     def register_arg? n
715       n < @NREGISTER_ARGS
716     end
718     # Returns true if the nth (0-based) local is stored in a register
719     def register_local? n
720       (n + number_of_register_arguments) < @NREGISTER_LOCALS
721     end
723     # Restores the frame saved at the given location.
724     def restore_frame location
725       load_value_into_register location, @TEMPORARY
726       @SAVE_FRAME_REGISTERS.each_with_index do |register,i|
727         emit "ldr #{register}, [#{@TEMPORARY}, \##{i * @WORDSIZE}]\n"
728       end
729     end
730     
731     # Returns from a function.
732     # 
733     # _words_ may contain an expression to be evaluated. The result
734     # of the evaluation is returned from the function.
735     def ret *words
736       # Compute return value and store it in @RETURN
737       eval_expr(words, @RETURN) unless words.empty?
738       # Go to epilogue
739       goto @function_end_label
740     end
742     # Saves the current frame to the given location.
743     def save_frame location
744       load_value_into_register location, @TEMPORARY
745       @SAVE_FRAME_REGISTERS.each_with_index do |register,i|
746         emit "str #{register}, [#{@TEMPORARY}, \##{i * @WORDSIZE}]\n"
747       end
748     end
749     
750     # Returns the number of bytes necessary to save the current frame.
751     def saved_frame_size
752       @SAVE_FRAME_REGISTERS.length * @WORDSIZE
753     end
754     
755     # Set a variable to the result of evaluating an expression
756     def set symbol, *expr
757       if at_expr? symbol
758         eval_expr expr, :r3
759         register = load_value symbol[1]
760         emit "str r3, [#{register}]\n"
761       else
762         x = @environment[symbol]
763         if x == nil
764           raise "Cannot change value of constant #{symbol}"
765         elsif x.kind_of? String
766           eval_expr expr, x
767         else
768           eval_expr expr, @TEMPORARY
769           emit "str #{@TEMPORARY}, #{offset_reference x}\n"
770         end
771       end
772     end
774     # Set the byte at _base_ + _offset_ to _value_
775     def set_byte base, offset, value
776       # If base is an integer, but offset isn't, swap them
777       if !integer?(offset) && integer?(base)
778         base, offset = [offset, base]
779       end
781       if integer? offset
782         base_reg = load_value base, :a4
783         load_value_into_register value, @TEMPORARY
784         if offset == 0
785           emit "strb #{@TEMPORARY}, [#{base_reg}]\n"
786         else
787           emit "strb #{@TEMPORARY}, [#{base_reg}, \##{offset}]\n"
788         end
789       else
790         eval_binop [:add, base, offset], :a4
791         load_value_into_register value, @TEMPORARY
792         emit "strb #{@TEMPORARY}, [a4]\n"
793       end
794     end
796     # Set the word at _base_ + _offset_ * +@WORDSIZE+ to _value_
797     def set_word base, offset, value
798       # If base is an integer, but offset isn't, swap them
799       if !integer?(offset) && integer?(base)
800         base, offset = [offset, base]
801       end
803       if integer? offset
804         base_reg = load_value base, :a4
805         load_value_into_register value, @TEMPORARY
806         if offset == 0
807           emit "str #{@TEMPORARY}, [#{base_reg}]\n"
808         else
809           emit "str #{@TEMPORARY}, [#{base_reg}, \##{offset * @WORDSIZE}]\n"
810         end
811       else
812         load_value_into_register base, :a4
813         load_value_into_register offset, @TEMPORARY
814         emit "add a4, a4, #{@TEMPORARY}, LSL #2\n"
815         load_value_into_register value, @TEMPORARY
816         emit "str #{@TEMPORARY}, [a4]\n"
817       end
818     end
820     # Given n, returns the nearest multiple of @STACK_ALIGNMENT
821     # that is >= n.
822     def stack_align n
823       (n + @STACK_ALIGNMENT - 1) / @STACK_ALIGNMENT * @STACK_ALIGNMENT
824     end
825     
826     # Define a string with the given value
827     def string value
828       code = ''
829       value.each_byte do |b|
830         if b == 92
831           code << "\\\\"
832         elsif b >= 32 && b < 127 && b != 34
833           code << b.chr
834         else
835           code << sprintf("\\%03o", b)
836         end
837       end
838       emit ".ascii \"#{code}\"\n"
839     end
841     # Call a function, re-using the current call frame if possible.
842     def tail_call func, *args
843       # Compute number of stack arguments
844       nstackargs = number_of_stack_arguments args.length
845       # If we need more stack arguments than we have now,
846       # perform a normal call and return
847       if nstackargs > number_of_stack_arguments(@environment.args)
848         emit "# Not enough space for proper tail call; using regular call\n"
849         ret :call, func, *args
850       end
852       # We will assign arguments from left to right.
853       # Find places that we will overwrite before we read them,
854       # and store their values in some newly allocated stack space.
855       old_frame_offset = @frame_offset
856       old_frame_size = @frame_size
857       overwritten = {}
858       (@NREGISTER_ARGS...args.length).each do |i|
859         arg = args[i]
860         arg = arg[1] if at_expr? arg
861         if symbol?(arg)
862           binding = @environment[arg]
863           if binding[0] == :arg && binding[1] >= @NREGISTER_ARGS &&
864               binding[1] < i
865             # Argument i is a stack argument, but the value we will assign
866             # it is a stack argument that comes before it, so we will
867             # have overwritten it by the time we get to it.
868             overwritten[arg] = nil
869           end
870         end
871       end
872       
873       unless overwritten.empty?
874         # Allocate space for arguments to be saved
875         grow_frame overwritten.length
876         # Save values
877         offset = 0
878         overwritten.each_key do |key|
879           reg = load_value key
880           emit "str #{reg}, [sp, \##{offset}]\n"
881           overwritten[key] = offset
882           offset = offset + @WORDSIZE
883         end
884       end
886       # Assign arguments
887       args.each_index do |i|
888         arg = args[i]
889         if register_arg? i
890           load_value_into_register arg, "a#{i + 1}"
891         else
892           # Test if this is a value we saved
893           sym = at_expr?(arg) ? arg[1] : arg
894           saved = overwritten[sym]
895           if saved
896             # Saved value, load from stack
897             reg = @TEMPORARY
898             emit "ldr #{reg}, [sp, \##{saved}]\n"
899           else
900             # Regular value, use load_value
901             reg = load_value arg
902           end
903           emit "str #{reg}, #{arg_reference i}\n"
904         end
905       end
907       # Load address of function to be called into @TEMPORARY
908       load_value_into_register func, @TEMPORARY
910       # Destroy current activation frame and enter func
911       destroy_frame false
912       emit "bx #{@TEMPORARY}\n"
913       emit_constants
914     end
916     # Define a word with the given value
917     def word value
918       emit ".int #{value}\n"
919     end
921   end
923   # Register class for little endian ARM
924   Voodoo::CodeGenerator.register_generator ARMGasGenerator,
925                                            :architecture => :arm,
926                                            :format => :gas