1 ! Copyright (C) 2005, 2009 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: locals alien.c-types alien.syntax arrays kernel fry math
4 namespaces sequences system layouts io vocabs.loader accessors init
5 combinators command-line make compiler compiler.units
6 compiler.constants compiler.alien compiler.codegen
7 compiler.codegen.fixup compiler.cfg.instructions compiler.cfg.builder
8 compiler.cfg.intrinsics compiler.cfg.stack-frame cpu.x86.assembler
9 cpu.x86.assembler.operands cpu.x86 cpu.architecture ;
12 ! We implement the FFI for Linux, OS X and Windows all at once.
13 ! OS X requires that the stack be 16-byte aligned.
15 M: x86.32 machine-registers
17 { int-regs { EAX ECX EDX EBP EBX } }
18 { float-regs { XMM0 XMM1 XMM2 XMM3 XMM4 XMM5 XMM6 XMM7 } }
21 M: x86.32 ds-reg ESI ;
22 M: x86.32 rs-reg EDI ;
23 M: x86.32 stack-reg ESP ;
24 M: x86.32 temp-reg ECX ;
26 M:: x86.32 %dispatch ( src temp -- )
27 ! Load jump table base.
28 temp src HEX: ffffffff [+] LEA
29 building get length cell - :> start
30 0 rc-absolute-cell rel-here
33 building get length :> end
34 ! Fix up the displacement above
36 [ end start - + building get dup pop* push ]
40 ! Registers for fastcall
41 : param-reg-1 ( -- reg ) EAX ;
42 : param-reg-2 ( -- reg ) EDX ;
44 M: x86.32 pic-tail-reg EBX ;
46 M: x86.32 reserved-area-size 0 ;
48 M: x86.32 %alien-invoke 0 CALL rc-relative rel-dlsym ;
51 temp-reg 0 MOV rc-absolute-cell rt-vm rel-fixup ! push the vm ptr as an argument
54 M: x86.32 return-struct-in-registers? ( c-type -- ? )
56 [ return-in-registers?>> ]
57 [ heap-size { 1 2 4 8 } member? ] bi
58 os { linux netbsd solaris } member? not
61 : struct-return@ ( n -- operand )
62 [ next-stack@ ] [ stack-frame get params>> stack@ ] if* ;
64 ! On x86, parameters are never passed in registers.
65 M: int-regs return-reg drop EAX ;
66 M: int-regs param-regs drop { } ;
67 M: float-regs param-regs drop { } ;
69 GENERIC: push-return-reg ( rep -- )
70 GENERIC: load-return-reg ( n rep -- )
71 GENERIC: store-return-reg ( n rep -- )
73 M: int-rep push-return-reg drop EAX PUSH ;
74 M: int-rep load-return-reg drop EAX swap next-stack@ MOV ;
75 M: int-rep store-return-reg drop stack@ EAX MOV ;
77 M: float-rep push-return-reg drop ESP 4 SUB ESP [] FSTPS ;
78 M: float-rep load-return-reg drop next-stack@ FLDS ;
79 M: float-rep store-return-reg drop stack@ FSTPS ;
81 M: double-rep push-return-reg drop ESP 8 SUB ESP [] FSTPL ;
82 M: double-rep load-return-reg drop next-stack@ FLDL ;
83 M: double-rep store-return-reg drop stack@ FSTPL ;
86 [ align-stack ] keep - decr-stack-reg ;
89 align-stack incr-stack-reg ;
91 : with-aligned-stack ( n quot -- )
92 '[ align-sub @ ] [ align-add ] bi ; inline
94 M: x86.32 %prologue ( n -- )
96 0 PUSH rc-absolute-cell rel-this
97 3 cells - decr-stack-reg ;
99 M: x86.32 %load-param-reg 3drop ;
101 M: x86.32 %save-param-reg 3drop ;
103 : (%box) ( n rep -- )
104 #! If n is f, push the return register onto the stack; we
105 #! are boxing a return value of a C function. If n is an
106 #! integer, push [ESP+n] on the stack; we are boxing a
107 #! parameter being passed to a callback from C.
108 over [ load-return-reg ] [ 2drop ] if ;
110 CONSTANT: vm-ptr-size 4
112 M:: x86.32 %box ( n rep func -- )
114 rep rep-size vm-ptr-size + [
118 ] with-aligned-stack ;
120 : (%box-long-long) ( n -- )
122 EDX over next-stack@ MOV
123 EAX swap cell - next-stack@ MOV
126 M: x86.32 %box-long-long ( n func -- )
127 [ (%box-long-long) ] dip
133 ] with-aligned-stack ;
135 M:: x86.32 %box-large-struct ( n c-type -- )
136 ! Compute destination address
137 EDX n struct-return@ LEA
141 c-type heap-size PUSH
142 ! Push destination address
144 ! Copy the struct from the C stack
145 "box_value_struct" f %alien-invoke
146 ] with-aligned-stack ;
148 M: x86.32 %prepare-box-struct ( -- )
149 ! Compute target address for value struct return
150 EAX f struct-return@ LEA
151 ! Store it as the first parameter
154 M: x86.32 %box-small-struct ( c-type -- )
155 #! Box a <= 8-byte struct returned in EAX:EDX. OS X only.
161 "box_small_struct" f %alien-invoke
162 ] with-aligned-stack ;
164 M: x86.32 %prepare-unbox ( -- )
165 #! Move top of data stack to EAX.
169 : call-unbox-func ( func -- )
171 ! push the vm ptr as an argument
177 ] with-aligned-stack ;
179 M: x86.32 %unbox ( n rep func -- )
180 #! The value being unboxed must already be in EAX.
181 #! If n is f, we're unboxing a return value about to be
182 #! returned by the callback. Otherwise, we're unboxing
183 #! a parameter to a C function about to be called.
185 ! Store the return value on the C stack
186 over [ store-return-reg ] [ 2drop ] if ;
188 M: x86.32 %unbox-long-long ( n func -- )
190 ! Store the return value on the C stack
193 cell + stack@ EDX MOV
196 : %unbox-struct-1 ( -- )
197 #! Alien must be in EAX.
201 "alien_offset" f %alien-invoke
204 ] with-aligned-stack ;
206 : %unbox-struct-2 ( -- )
207 #! Alien must be in EAX.
211 "alien_offset" f %alien-invoke
216 ] with-aligned-stack ;
218 M: x86 %unbox-small-struct ( size -- )
219 #! Alien must be in EAX.
220 heap-size cell align cell /i {
221 { 1 [ %unbox-struct-1 ] }
222 { 2 [ %unbox-struct-2 ] }
225 M:: x86.32 %unbox-large-struct ( n c-type -- )
226 ! Alien must be in EAX.
227 ! Compute destination address
232 c-type heap-size PUSH
233 ! Push destination address
235 ! Push source address
237 ! Copy the struct to the stack
238 "to_value_struct" f %alien-invoke
239 ] with-aligned-stack ;
241 M: x86.32 %prepare-alien-indirect ( -- )
242 push-vm-ptr "unbox_alien" f %alien-invoke
246 M: x86.32 %alien-indirect ( -- )
249 M: x86.32 %alien-callback ( quot -- )
251 EAX swap %load-reference
253 param-reg-2 0 MOV rc-absolute-cell rt-vm rel-fixup
254 "c_to_factor" f %alien-invoke
255 ] with-aligned-stack ;
257 M: x86.32 %callback-value ( ctype -- )
260 ! Save top of data stack in non-volatile register
264 ! Restore data/call/retain stacks
265 "unnest_stacks" f %alien-invoke
266 ! Place top of data stack in EAX
274 M: x86.32 %cleanup ( params -- )
275 #! a) If we just called an stdcall function in Windows, it
276 #! cleaned up the stack frame for us. But we don't want that
277 #! so we 'undo' the cleanup since we do that in %epilogue.
278 #! b) If we just called a function returning a struct, we
282 [ dup abi>> "stdcall" = ]
283 [ drop ESP stack-frame get params>> SUB ]
285 [ dup return>> large-struct? ]
291 M: x86.32 %callback-return ( n -- )
292 #! a) If the callback is stdcall, we have to clean up the
293 #! caller's stack frame.
294 #! b) If the callback is returning a large struct, we have
297 { [ dup abi>> "stdcall" = ] [
299 [ params>> ] [ return>> ] bi +
301 { [ dup return>> large-struct? ] [ drop 4 ] }
305 M:: x86.32 %call-gc ( gc-root-count temp1 -- )
306 ! USE: prettyprint "PHIL" pprint temp1 pprint temp2 pprint
307 temp1 gc-root-base param@ LEA
309 0 PUSH rc-absolute-cell rt-vm rel-fixup ! push the vm ptr as an argument
310 ! Pass number of roots as second parameter
312 ! Pass pointer to start of GC roots as first parameter
315 "inline_gc" f %alien-invoke
316 ] with-aligned-stack ;
318 M: x86.32 dummy-stack-params? f ;
320 M: x86.32 dummy-int-params? f ;
322 M: x86.32 dummy-fp-params? f ;
325 cell "longlong" c-type (>>align)
326 cell "ulonglong" c-type (>>align)
327 4 "double" c-type (>>align)