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 M: x86.32 param-reg-1 EAX ;
42 M: x86.32 param-reg-2 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 %vm-invoke ( function -- )
59 M: x86.32 return-struct-in-registers? ( c-type -- ? )
61 [ return-in-registers?>> ]
62 [ heap-size { 1 2 4 8 } member? ] bi
63 os { linux netbsd solaris } member? not
66 : struct-return@ ( n -- operand )
67 [ next-stack@ ] [ stack-frame get params>> stack@ ] if* ;
69 ! On x86, parameters are never passed in registers.
70 M: int-regs return-reg drop EAX ;
71 M: int-regs param-regs drop { } ;
72 M: float-regs param-regs drop { } ;
74 GENERIC: push-return-reg ( rep -- )
75 GENERIC: load-return-reg ( n rep -- )
76 GENERIC: store-return-reg ( n rep -- )
78 M: int-rep push-return-reg drop EAX PUSH ;
79 M: int-rep load-return-reg drop EAX swap next-stack@ MOV ;
80 M: int-rep store-return-reg drop stack@ EAX MOV ;
82 M: float-rep push-return-reg drop ESP 4 SUB ESP [] FSTPS ;
83 M: float-rep load-return-reg drop next-stack@ FLDS ;
84 M: float-rep store-return-reg drop stack@ FSTPS ;
86 M: double-rep push-return-reg drop ESP 8 SUB ESP [] FSTPL ;
87 M: double-rep load-return-reg drop next-stack@ FLDL ;
88 M: double-rep store-return-reg drop stack@ FSTPL ;
91 [ align-stack ] keep - decr-stack-reg ;
94 align-stack incr-stack-reg ;
96 : with-aligned-stack ( n quot -- )
97 '[ align-sub @ ] [ align-add ] bi ; inline
99 M: x86.32 %prologue ( n -- )
101 0 PUSH rc-absolute-cell rel-this
102 3 cells - decr-stack-reg ;
104 M: x86.32 %load-param-reg 3drop ;
106 M: x86.32 %save-param-reg 3drop ;
108 : (%box) ( n rep -- )
109 #! If n is f, push the return register onto the stack; we
110 #! are boxing a return value of a C function. If n is an
111 #! integer, push [ESP+n] on the stack; we are boxing a
112 #! parameter being passed to a callback from C.
113 over [ load-return-reg ] [ 2drop ] if ;
115 CONSTANT: vm-ptr-size 4
117 M:: x86.32 %box ( n rep func -- )
119 rep rep-size vm-ptr-size + [
123 ] with-aligned-stack ;
125 : (%box-long-long) ( n -- )
127 EDX over next-stack@ MOV
128 EAX swap cell - next-stack@ MOV
131 M: x86.32 %box-long-long ( n func -- )
132 [ (%box-long-long) ] dip
137 ] with-aligned-stack ;
139 M:: x86.32 %box-large-struct ( n c-type -- )
140 ! Compute destination address
141 ECX n struct-return@ LEA
144 c-type heap-size PUSH
145 ! Push destination address
147 ! Copy the struct from the C stack
148 "box_value_struct" f %alien-invoke
149 ] with-aligned-stack ;
151 M: x86.32 %prepare-box-struct ( -- )
152 ! Compute target address for value struct return
153 EAX f struct-return@ LEA
154 ! Store it as the first parameter
157 M: x86.32 %box-small-struct ( c-type -- )
158 #! Box a <= 8-byte struct returned in EAX:EDX. OS X only.
163 "box_small_struct" f %alien-invoke
164 ] with-aligned-stack ;
166 M: x86.32 %prepare-unbox ( -- )
167 #! Move top of data stack to EAX.
171 : call-unbox-func ( func -- )
173 ! push the vm ptr as an argument
179 ] with-aligned-stack ;
181 M: x86.32 %unbox ( n rep func -- )
182 #! The value being unboxed must already be in EAX.
183 #! If n is f, we're unboxing a return value about to be
184 #! returned by the callback. Otherwise, we're unboxing
185 #! a parameter to a C function about to be called.
187 ! Store the return value on the C stack
188 over [ store-return-reg ] [ 2drop ] if ;
190 M: x86.32 %unbox-long-long ( n func -- )
192 ! Store the return value on the C stack
195 cell + stack@ EDX MOV
198 : %unbox-struct-1 ( -- )
199 #! Alien must be in EAX.
202 "alien_offset" f %alien-invoke
205 ] with-aligned-stack ;
207 : %unbox-struct-2 ( -- )
208 #! 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
231 c-type heap-size PUSH
232 ! Push destination address
234 ! Push source address
236 ! Copy the struct to the stack
237 "to_value_struct" f %alien-invoke
238 ] with-aligned-stack ;
240 M: x86.32 %prepare-alien-indirect ( -- )
241 "unbox_alien" f %alien-invoke
244 M: x86.32 %alien-indirect ( -- )
247 M: x86.32 %alien-callback ( quot -- )
249 EAX swap %load-reference
251 param-reg-2 0 MOV rc-absolute-cell rt-vm rel-fixup
252 "c_to_factor" f %alien-invoke
253 ] with-aligned-stack ;
255 M: x86.32 %callback-value ( ctype -- )
258 ! Save top of data stack in non-volatile register
261 ! Restore data/call/retain stacks
262 "unnest_stacks" f %alien-invoke
263 ! Place top of data stack in EAX
270 M: x86.32 %cleanup ( params -- )
271 #! a) If we just called an stdcall function in Windows, it
272 #! cleaned up the stack frame for us. But we don't want that
273 #! so we 'undo' the cleanup since we do that in %epilogue.
274 #! b) If we just called a function returning a struct, we
278 [ dup abi>> "stdcall" = ]
279 [ drop ESP stack-frame get params>> SUB ]
281 [ dup return>> large-struct? ]
287 M: x86.32 %callback-return ( n -- )
288 #! a) If the callback is stdcall, we have to clean up the
289 #! caller's stack frame.
290 #! b) If the callback is returning a large struct, we have
293 { [ dup abi>> "stdcall" = ] [
295 [ params>> ] [ return>> ] bi +
297 { [ dup return>> large-struct? ] [ drop 4 ] }
301 M: x86.32 dummy-stack-params? f ;
303 M: x86.32 dummy-int-params? f ;
305 M: x86.32 dummy-fp-params? f ;
308 cell "longlong" c-type (>>align)
309 cell "ulonglong" c-type (>>align)
310 4 "double" c-type (>>align)
313 "cpu.x86.features" require