1 ! Copyright (C) 2008, 2009 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: namespaces make math math.order math.parser sequences accessors
4 kernel kernel.private layouts assocs words summary arrays
5 combinators classes.algebra alien alien.c-types alien.structs
6 alien.strings alien.arrays alien.complex alien.libraries sets libc
7 continuations.private fry cpu.architecture classes locals
8 source-files.errors slots parser generic.parser
13 compiler.cfg.instructions
14 compiler.cfg.stack-frame
15 compiler.cfg.registers
17 compiler.codegen.fixup
23 H{ } clone insn-counts set-global
25 GENERIC: generate-insn ( insn -- )
27 TUPLE: asm label code calls ;
31 : add-call ( word -- )
32 #! Compile this word later.
35 SYMBOL: compiling-word
37 : compiled-stack-traces? ( -- ? ) 67 getenv ;
39 ! Mapping _label IDs to label instances
42 : init-generator ( word -- )
46 compiled-stack-traces? [ compiling-word get add-literal ] when ;
48 : generate-insns ( asm -- code )
50 [ word>> init-generator ]
54 [ class insn-counts get inc-at ]
61 : generate ( mr -- asm )
63 [ label>> ] [ generate-insns ] bi calls get
67 : lookup-label ( id -- label )
68 labels get [ drop <label> ] cache ;
71 M: ##no-tco generate-insn drop ;
73 M: ##call generate-insn
74 word>> dup sub-primitive>>
75 [ first % ] [ [ add-call ] [ %call ] bi ] ?if ;
77 M: ##jump generate-insn word>> [ add-call ] [ %jump ] bi ;
79 M: _dispatch-label generate-insn
82 rc-absolute-cell label-fixup ;
84 M: _prologue generate-insn
85 stack-frame>> [ stack-frame set ] [ total-size>> %prologue ] bi ;
87 M: _epilogue generate-insn
88 stack-frame>> total-size>> %epilogue ;
90 M: _spill-area-size generate-insn drop ;
92 ! Some meta-programming to generate simple code generators, where
93 ! the instruction is unpacked and then a %word is called
96 : insn-slot-quot ( spec -- quot )
97 name>> [ reader-word ] [ "label" = ] bi
98 [ \ lookup-label [ ] 2sequence ] [ [ ] 1sequence ] if ;
100 : codegen-method-body ( class word -- quot )
102 "insn-slots" word-prop
103 [ insn-slot-quot ] map cleave>quot
107 scan-word [ \ generate-insn create-method-in ] keep scan-word
108 codegen-method-body define ;
111 CODEGEN: ##load-immediate %load-immediate
112 CODEGEN: ##load-reference %load-reference
113 CODEGEN: ##peek %peek
114 CODEGEN: ##replace %replace
115 CODEGEN: ##inc-d %inc-d
116 CODEGEN: ##inc-r %inc-r
117 CODEGEN: ##return %return
118 CODEGEN: ##slot %slot
119 CODEGEN: ##slot-imm %slot-imm
120 CODEGEN: ##set-slot %set-slot
121 CODEGEN: ##set-slot-imm %set-slot-imm
122 CODEGEN: ##string-nth %string-nth
123 CODEGEN: ##set-string-nth-fast %set-string-nth-fast
125 CODEGEN: ##add-imm %add-imm
127 CODEGEN: ##sub-imm %sub-imm
129 CODEGEN: ##mul-imm %mul-imm
131 CODEGEN: ##and-imm %and-imm
133 CODEGEN: ##or-imm %or-imm
135 CODEGEN: ##xor-imm %xor-imm
137 CODEGEN: ##shl-imm %shl-imm
139 CODEGEN: ##shr-imm %shr-imm
141 CODEGEN: ##sar-imm %sar-imm
145 CODEGEN: ##log2 %log2
146 CODEGEN: ##copy %copy
147 CODEGEN: ##integer>bignum %integer>bignum
148 CODEGEN: ##bignum>integer %bignum>integer
149 CODEGEN: ##unbox-float %unbox-float
150 CODEGEN: ##box-float %box-float
151 CODEGEN: ##add-float %add-float
152 CODEGEN: ##sub-float %sub-float
153 CODEGEN: ##mul-float %mul-float
154 CODEGEN: ##div-float %div-float
155 CODEGEN: ##min-float %min-float
156 CODEGEN: ##max-float %max-float
157 CODEGEN: ##sqrt %sqrt
158 CODEGEN: ##unary-float-function %unary-float-function
159 CODEGEN: ##binary-float-function %binary-float-function
160 CODEGEN: ##single>double-float %single>double-float
161 CODEGEN: ##double>single-float %double>single-float
162 CODEGEN: ##integer>float %integer>float
163 CODEGEN: ##float>integer %float>integer
164 CODEGEN: ##unbox-vector %unbox-vector
165 CODEGEN: ##broadcast-vector %broadcast-vector
166 CODEGEN: ##gather-vector-2 %gather-vector-2
167 CODEGEN: ##gather-vector-4 %gather-vector-4
168 CODEGEN: ##box-vector %box-vector
169 CODEGEN: ##add-vector %add-vector
170 CODEGEN: ##sub-vector %sub-vector
171 CODEGEN: ##mul-vector %mul-vector
172 CODEGEN: ##div-vector %div-vector
173 CODEGEN: ##min-vector %min-vector
174 CODEGEN: ##max-vector %max-vector
175 CODEGEN: ##sqrt-vector %sqrt-vector
176 CODEGEN: ##horizontal-add-vector %horizontal-add-vector
177 CODEGEN: ##box-alien %box-alien
178 CODEGEN: ##box-displaced-alien %box-displaced-alien
179 CODEGEN: ##unbox-alien %unbox-alien
180 CODEGEN: ##unbox-any-c-ptr %unbox-any-c-ptr
181 CODEGEN: ##alien-unsigned-1 %alien-unsigned-1
182 CODEGEN: ##alien-unsigned-2 %alien-unsigned-2
183 CODEGEN: ##alien-unsigned-4 %alien-unsigned-4
184 CODEGEN: ##alien-signed-1 %alien-signed-1
185 CODEGEN: ##alien-signed-2 %alien-signed-2
186 CODEGEN: ##alien-signed-4 %alien-signed-4
187 CODEGEN: ##alien-cell %alien-cell
188 CODEGEN: ##alien-float %alien-float
189 CODEGEN: ##alien-double %alien-double
190 CODEGEN: ##alien-vector %alien-vector
191 CODEGEN: ##set-alien-integer-1 %set-alien-integer-1
192 CODEGEN: ##set-alien-integer-2 %set-alien-integer-2
193 CODEGEN: ##set-alien-integer-4 %set-alien-integer-4
194 CODEGEN: ##set-alien-cell %set-alien-cell
195 CODEGEN: ##set-alien-float %set-alien-float
196 CODEGEN: ##set-alien-double %set-alien-double
197 CODEGEN: ##set-alien-vector %set-alien-vector
198 CODEGEN: ##allot %allot
199 CODEGEN: ##write-barrier %write-barrier
200 CODEGEN: ##compare %compare
201 CODEGEN: ##compare-imm %compare-imm
202 CODEGEN: ##compare-float-ordered %compare-float-ordered
203 CODEGEN: ##compare-float-unordered %compare-float-unordered
204 CODEGEN: ##save-context %save-context
206 CODEGEN: _fixnum-add %fixnum-add
207 CODEGEN: _fixnum-sub %fixnum-sub
208 CODEGEN: _fixnum-mul %fixnum-mul
209 CODEGEN: _label resolve-label
210 CODEGEN: _branch %jump-label
211 CODEGEN: _compare-branch %compare-branch
212 CODEGEN: _compare-imm-branch %compare-imm-branch
213 CODEGEN: _compare-float-ordered-branch %compare-float-ordered-branch
214 CODEGEN: _compare-float-unordered-branch %compare-float-unordered-branch
215 CODEGEN: _dispatch %dispatch
216 CODEGEN: _spill %spill
217 CODEGEN: _reload %reload
220 : wipe-locs ( locs temp -- )
223 [ 0 %load-immediate ]
224 [ swap [ %replace ] with each ] bi
227 GENERIC# save-gc-root 1 ( gc-root operand temp -- )
229 M:: spill-slot save-gc-root ( gc-root operand temp -- )
230 temp int-rep operand n>> %reload
231 gc-root temp %save-gc-root ;
233 M: object save-gc-root drop %save-gc-root ;
235 : save-gc-roots ( gc-roots temp -- ) '[ _ save-gc-root ] assoc-each ;
237 : save-data-regs ( data-regs -- ) [ first3 %spill ] each ;
239 GENERIC# load-gc-root 1 ( gc-root operand temp -- )
241 M:: spill-slot load-gc-root ( gc-root operand temp -- )
242 gc-root temp %load-gc-root
243 temp int-rep operand n>> %spill ;
245 M: object load-gc-root drop %load-gc-root ;
247 : load-gc-roots ( gc-roots temp -- ) '[ _ load-gc-root ] assoc-each ;
249 : load-data-regs ( data-regs -- ) [ first3 %reload ] each ;
254 [ [ "no-gc" get ] dip [ temp1>> ] [ temp2>> ] bi %check-nursery ]
255 [ [ uninitialized-locs>> ] [ temp1>> ] bi wipe-locs ]
256 [ data-values>> save-data-regs ]
257 [ [ tagged-values>> ] [ temp1>> ] bi save-gc-roots ]
258 [ [ temp1>> ] [ temp2>> ] bi t %save-context ]
259 [ tagged-values>> length %call-gc ]
260 [ [ tagged-values>> ] [ temp1>> ] bi load-gc-roots ]
261 [ data-values>> load-data-regs ]
263 "no-gc" resolve-label ;
265 M: _loop-entry generate-insn drop %loop-entry ;
267 M: ##alien-global generate-insn
268 [ dst>> ] [ symbol>> ] [ library>> ] tri
272 GENERIC: next-fastcall-param ( rep -- )
274 : ?dummy-stack-params ( rep -- )
275 dummy-stack-params? [ rep-size cell align stack-params +@ ] [ drop ] if ;
277 : ?dummy-int-params ( rep -- )
278 dummy-int-params? [ rep-size cell /i 1 max int-regs +@ ] [ drop ] if ;
280 : ?dummy-fp-params ( rep -- )
281 drop dummy-fp-params? [ float-regs inc ] when ;
283 M: int-rep next-fastcall-param
284 int-regs inc [ ?dummy-stack-params ] [ ?dummy-fp-params ] bi ;
286 M: float-rep next-fastcall-param
287 float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
289 M: double-rep next-fastcall-param
290 float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
292 GENERIC: reg-class-full? ( reg-class -- ? )
294 M: stack-params reg-class-full? drop t ;
296 M: reg-class reg-class-full?
297 [ get ] [ param-regs length ] bi >= ;
299 : alloc-stack-param ( rep -- n reg-class rep )
301 [ rep-size cell align stack-params +@ ] dip
304 : alloc-fastcall-param ( rep -- n reg-class rep )
305 [ [ reg-class-of get ] [ reg-class-of ] [ next-fastcall-param ] tri ] keep ;
307 : alloc-parameter ( parameter -- reg rep )
308 c-type-rep dup reg-class-of reg-class-full?
309 [ alloc-stack-param ] [ alloc-fastcall-param ] if
312 : (flatten-int-type) ( size -- seq )
313 cell /i "void*" c-type <repetition> ;
315 GENERIC: flatten-value-type ( type -- types )
317 M: object flatten-value-type 1array ;
319 M: struct-type flatten-value-type ( type -- types )
320 stack-size cell align (flatten-int-type) ;
322 M: long-long-type flatten-value-type ( type -- types )
323 stack-size cell align (flatten-int-type) ;
325 : flatten-value-types ( params -- params )
326 #! Convert value type structs to consecutive void*s.
330 [ parameter-align (flatten-int-type) % ] keep
331 [ stack-size cell align + ] keep
336 : each-parameter ( parameters quot -- )
337 [ [ parameter-sizes nip ] keep ] dip 2each ; inline
339 : reverse-each-parameter ( parameters quot -- )
340 [ [ parameter-sizes nip ] keep ] dip 2reverse-each ; inline
342 : reset-fastcall-counts ( -- )
343 { int-regs float-regs stack-params } [ 0 swap set ] each ;
345 : with-param-regs ( quot -- )
346 #! In quot you can call alloc-parameter
347 [ reset-fastcall-counts call ] with-scope ; inline
349 : move-parameters ( node word -- )
350 #! Moves values from C stack to registers (if word is
351 #! %load-param-reg) and registers to C stack (if word is
353 [ alien-parameters flatten-value-types ]
354 [ '[ alloc-parameter _ execute ] ]
355 bi* each-parameter ; inline
357 : unbox-parameters ( offset node -- )
359 %prepare-unbox [ over + ] dip unbox-parameter
360 ] reverse-each-parameter drop ;
362 : prepare-box-struct ( node -- offset )
363 #! Return offset on C stack where to store unboxed
364 #! parameters. If the C function is returning a structure,
365 #! the first parameter is an implicit target area pointer,
366 #! so we need to use a different offset.
367 return>> large-struct?
368 [ %prepare-box-struct cell ] [ 0 ] if ;
370 : objects>registers ( params -- )
371 #! Generate code for unboxing a list of C types, then
372 #! generate code for moving these parameters to registers on
373 #! architectures where parameters are passed in registers.
375 [ prepare-box-struct ] keep
376 [ unbox-parameters ] keep
377 \ %load-param-reg move-parameters
380 : box-return* ( node -- )
381 return>> [ ] [ box-return ] if-void ;
383 : check-dlsym ( symbols dll -- )
385 dupd '[ _ dlsym ] any?
386 [ drop ] [ compiling-word get no-such-symbol ] if
388 dll-path compiling-word get no-such-library drop
391 : stdcall-mangle ( symbol params -- symbol )
392 parameters>> parameter-sizes drop number>string "@" glue ;
394 : alien-invoke-dlsym ( params -- symbols dll )
395 [ [ function>> dup ] keep stdcall-mangle 2array ]
396 [ library>> library dup [ dll>> ] when ]
397 bi 2dup check-dlsym ;
399 M: ##alien-invoke generate-insn
402 dup objects>registers
405 dup alien-invoke-dlsym %alien-invoke
411 M: ##alien-indirect generate-insn
413 ! Save alien at top of stack to temporary storage
414 %prepare-alien-indirect
416 dup objects>registers
418 ! Call alien in temporary storage
425 : box-parameters ( params -- )
426 alien-parameters [ box-parameter ] each-parameter ;
428 : registers>objects ( node -- )
429 ! Generate code for boxing input parameters in a callback.
431 dup \ %save-param-reg move-parameters
432 "nest_stacks" f %alien-invoke
436 TUPLE: callback-context ;
438 : current-callback ( -- id ) 2 getenv ;
440 : wait-to-return ( token -- )
441 dup current-callback eq? [
444 yield-hook get call( -- ) wait-to-return
447 : do-callback ( quot token -- )
449 [ 2 setenv call ] keep
450 wait-to-return ; inline
452 : callback-return-quot ( ctype -- quot )
454 { [ dup "void" = ] [ drop [ ] ] }
455 { [ dup large-struct? ] [ heap-size '[ _ memcpy ] ] }
456 [ c-type c-type-unboxer-quot ]
459 : callback-prep-quot ( params -- quot )
460 parameters>> [ c-type c-type-boxer-quot ] map spread>quot ;
462 : wrap-callback-quot ( params -- quot )
464 [ callback-prep-quot ]
466 [ callback-return-quot ] tri 3append ,
467 [ callback-context new do-callback ] %
470 : %unnest-stacks ( -- ) "unnest_stacks" f %alien-invoke ;
472 M: ##callback-return generate-insn
473 #! All the extra book-keeping for %unwind is only for x86.
474 #! On other platforms its an alias for %return.
475 params>> %callback-return ;
477 M: ##alien-callback generate-insn
479 [ registers>objects ]
480 [ wrap-callback-quot %alien-callback ]
481 [ alien-return [ %unnest-stacks ] [ %callback-value ] if-void ]