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
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
19 QUALIFIED: classes.struct
20 QUALIFIED: alien.structs
25 H{ } clone insn-counts set-global
27 GENERIC: generate-insn ( insn -- )
29 TUPLE: asm label code calls ;
33 : add-call ( word -- )
34 #! Compile this word later.
37 SYMBOL: compiling-word
39 : compiled-stack-traces? ( -- ? ) 67 getenv ;
41 ! Mapping _label IDs to label instances
44 : init-generator ( word -- )
48 compiled-stack-traces? [ compiling-word get add-literal ] when ;
50 : generate-insns ( asm -- code )
52 [ word>> init-generator ]
56 [ class insn-counts get inc-at ]
63 : generate ( mr -- asm )
65 [ label>> ] [ generate-insns ] bi calls get
69 : lookup-label ( id -- label )
70 labels get [ drop <label> ] cache ;
73 M: ##no-tco generate-insn drop ;
75 M: ##call generate-insn
76 word>> dup sub-primitive>>
77 [ first % ] [ [ add-call ] [ %call ] bi ] ?if ;
79 M: ##jump generate-insn word>> [ add-call ] [ %jump ] bi ;
81 M: _dispatch-label generate-insn
84 rc-absolute-cell label-fixup ;
86 M: _prologue generate-insn
87 stack-frame>> [ stack-frame set ] [ total-size>> %prologue ] bi ;
89 M: _epilogue generate-insn
90 stack-frame>> total-size>> %epilogue ;
92 M: _spill-area-size generate-insn drop ;
94 ! Some meta-programming to generate simple code generators, where
95 ! the instruction is unpacked and then a %word is called
98 : insn-slot-quot ( spec -- quot )
99 name>> [ reader-word ] [ "label" = ] bi
100 [ \ lookup-label [ ] 2sequence ] [ [ ] 1sequence ] if ;
102 : codegen-method-body ( class word -- quot )
104 "insn-slots" word-prop
105 [ insn-slot-quot ] map cleave>quot
109 scan-word [ \ generate-insn create-method-in ] keep scan-word
110 codegen-method-body define ;
113 CODEGEN: ##load-immediate %load-immediate
114 CODEGEN: ##load-reference %load-reference
115 CODEGEN: ##peek %peek
116 CODEGEN: ##replace %replace
117 CODEGEN: ##inc-d %inc-d
118 CODEGEN: ##inc-r %inc-r
119 CODEGEN: ##return %return
120 CODEGEN: ##slot %slot
121 CODEGEN: ##slot-imm %slot-imm
122 CODEGEN: ##set-slot %set-slot
123 CODEGEN: ##set-slot-imm %set-slot-imm
124 CODEGEN: ##string-nth %string-nth
125 CODEGEN: ##set-string-nth-fast %set-string-nth-fast
127 CODEGEN: ##add-imm %add-imm
129 CODEGEN: ##sub-imm %sub-imm
131 CODEGEN: ##mul-imm %mul-imm
133 CODEGEN: ##and-imm %and-imm
135 CODEGEN: ##or-imm %or-imm
137 CODEGEN: ##xor-imm %xor-imm
139 CODEGEN: ##shl-imm %shl-imm
141 CODEGEN: ##shr-imm %shr-imm
143 CODEGEN: ##sar-imm %sar-imm
147 CODEGEN: ##log2 %log2
148 CODEGEN: ##copy %copy
149 CODEGEN: ##integer>bignum %integer>bignum
150 CODEGEN: ##bignum>integer %bignum>integer
151 CODEGEN: ##unbox-float %unbox-float
152 CODEGEN: ##box-float %box-float
153 CODEGEN: ##add-float %add-float
154 CODEGEN: ##sub-float %sub-float
155 CODEGEN: ##mul-float %mul-float
156 CODEGEN: ##div-float %div-float
157 CODEGEN: ##min-float %min-float
158 CODEGEN: ##max-float %max-float
159 CODEGEN: ##sqrt %sqrt
160 CODEGEN: ##unary-float-function %unary-float-function
161 CODEGEN: ##binary-float-function %binary-float-function
162 CODEGEN: ##single>double-float %single>double-float
163 CODEGEN: ##double>single-float %double>single-float
164 CODEGEN: ##integer>float %integer>float
165 CODEGEN: ##float>integer %float>integer
166 CODEGEN: ##unbox-vector %unbox-vector
167 CODEGEN: ##broadcast-vector %broadcast-vector
168 CODEGEN: ##gather-vector-2 %gather-vector-2
169 CODEGEN: ##gather-vector-4 %gather-vector-4
170 CODEGEN: ##box-vector %box-vector
171 CODEGEN: ##add-vector %add-vector
172 CODEGEN: ##saturated-add-vector %saturated-add-vector
173 CODEGEN: ##add-sub-vector %add-sub-vector
174 CODEGEN: ##sub-vector %sub-vector
175 CODEGEN: ##saturated-sub-vector %saturated-sub-vector
176 CODEGEN: ##mul-vector %mul-vector
177 CODEGEN: ##saturated-mul-vector %saturated-mul-vector
178 CODEGEN: ##div-vector %div-vector
179 CODEGEN: ##min-vector %min-vector
180 CODEGEN: ##max-vector %max-vector
181 CODEGEN: ##sqrt-vector %sqrt-vector
182 CODEGEN: ##horizontal-add-vector %horizontal-add-vector
183 CODEGEN: ##abs-vector %abs-vector
184 CODEGEN: ##and-vector %and-vector
185 CODEGEN: ##or-vector %or-vector
186 CODEGEN: ##xor-vector %xor-vector
187 CODEGEN: ##box-alien %box-alien
188 CODEGEN: ##box-displaced-alien %box-displaced-alien
189 CODEGEN: ##unbox-alien %unbox-alien
190 CODEGEN: ##unbox-any-c-ptr %unbox-any-c-ptr
191 CODEGEN: ##alien-unsigned-1 %alien-unsigned-1
192 CODEGEN: ##alien-unsigned-2 %alien-unsigned-2
193 CODEGEN: ##alien-unsigned-4 %alien-unsigned-4
194 CODEGEN: ##alien-signed-1 %alien-signed-1
195 CODEGEN: ##alien-signed-2 %alien-signed-2
196 CODEGEN: ##alien-signed-4 %alien-signed-4
197 CODEGEN: ##alien-cell %alien-cell
198 CODEGEN: ##alien-float %alien-float
199 CODEGEN: ##alien-double %alien-double
200 CODEGEN: ##alien-vector %alien-vector
201 CODEGEN: ##set-alien-integer-1 %set-alien-integer-1
202 CODEGEN: ##set-alien-integer-2 %set-alien-integer-2
203 CODEGEN: ##set-alien-integer-4 %set-alien-integer-4
204 CODEGEN: ##set-alien-cell %set-alien-cell
205 CODEGEN: ##set-alien-float %set-alien-float
206 CODEGEN: ##set-alien-double %set-alien-double
207 CODEGEN: ##set-alien-vector %set-alien-vector
208 CODEGEN: ##allot %allot
209 CODEGEN: ##write-barrier %write-barrier
210 CODEGEN: ##compare %compare
211 CODEGEN: ##compare-imm %compare-imm
212 CODEGEN: ##compare-float-ordered %compare-float-ordered
213 CODEGEN: ##compare-float-unordered %compare-float-unordered
214 CODEGEN: ##save-context %save-context
215 CODEGEN: ##vm-field-ptr %vm-field-ptr
217 CODEGEN: _fixnum-add %fixnum-add
218 CODEGEN: _fixnum-sub %fixnum-sub
219 CODEGEN: _fixnum-mul %fixnum-mul
220 CODEGEN: _label resolve-label
221 CODEGEN: _branch %jump-label
222 CODEGEN: _compare-branch %compare-branch
223 CODEGEN: _compare-imm-branch %compare-imm-branch
224 CODEGEN: _compare-float-ordered-branch %compare-float-ordered-branch
225 CODEGEN: _compare-float-unordered-branch %compare-float-unordered-branch
226 CODEGEN: _dispatch %dispatch
227 CODEGEN: _spill %spill
228 CODEGEN: _reload %reload
231 : wipe-locs ( locs temp -- )
234 [ 0 %load-immediate ]
235 [ swap [ %replace ] with each ] bi
238 GENERIC# save-gc-root 1 ( gc-root operand temp -- )
240 M:: spill-slot save-gc-root ( gc-root operand temp -- )
241 temp int-rep operand n>> %reload
242 gc-root temp %save-gc-root ;
244 M: object save-gc-root drop %save-gc-root ;
246 : save-gc-roots ( gc-roots temp -- ) '[ _ save-gc-root ] assoc-each ;
248 : save-data-regs ( data-regs -- ) [ first3 %spill ] each ;
250 GENERIC# load-gc-root 1 ( gc-root operand temp -- )
252 M:: spill-slot load-gc-root ( gc-root operand temp -- )
253 gc-root temp %load-gc-root
254 temp int-rep operand n>> %spill ;
256 M: object load-gc-root drop %load-gc-root ;
258 : load-gc-roots ( gc-roots temp -- ) '[ _ load-gc-root ] assoc-each ;
260 : load-data-regs ( data-regs -- ) [ first3 %reload ] each ;
265 [ [ "no-gc" get ] dip [ temp1>> ] [ temp2>> ] bi %check-nursery ]
266 [ [ uninitialized-locs>> ] [ temp1>> ] bi wipe-locs ]
267 [ data-values>> save-data-regs ]
268 [ [ tagged-values>> ] [ temp1>> ] bi save-gc-roots ]
269 [ [ temp1>> ] [ temp2>> ] bi t %save-context ]
270 [ tagged-values>> length %call-gc ]
271 [ [ tagged-values>> ] [ temp1>> ] bi load-gc-roots ]
272 [ data-values>> load-data-regs ]
274 "no-gc" resolve-label ;
276 M: _loop-entry generate-insn drop %loop-entry ;
278 M: ##alien-global generate-insn
279 [ dst>> ] [ symbol>> ] [ library>> ] tri
283 GENERIC: next-fastcall-param ( rep -- )
285 : ?dummy-stack-params ( rep -- )
286 dummy-stack-params? [ rep-size cell align stack-params +@ ] [ drop ] if ;
288 : ?dummy-int-params ( rep -- )
289 dummy-int-params? [ rep-size cell /i 1 max int-regs +@ ] [ drop ] if ;
291 : ?dummy-fp-params ( rep -- )
292 drop dummy-fp-params? [ float-regs inc ] when ;
294 M: int-rep next-fastcall-param
295 int-regs inc [ ?dummy-stack-params ] [ ?dummy-fp-params ] bi ;
297 M: float-rep next-fastcall-param
298 float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
300 M: double-rep next-fastcall-param
301 float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
303 GENERIC: reg-class-full? ( reg-class -- ? )
305 M: stack-params reg-class-full? drop t ;
307 M: reg-class reg-class-full?
308 [ get ] [ param-regs length ] bi >= ;
310 : alloc-stack-param ( rep -- n reg-class rep )
312 [ rep-size cell align stack-params +@ ] dip
315 : alloc-fastcall-param ( rep -- n reg-class rep )
316 [ [ reg-class-of get ] [ reg-class-of ] [ next-fastcall-param ] tri ] keep ;
318 : alloc-parameter ( parameter -- reg rep )
319 c-type-rep dup reg-class-of reg-class-full?
320 [ alloc-stack-param ] [ alloc-fastcall-param ] if
323 : (flatten-int-type) ( size -- seq )
324 cell /i "void*" c-type <repetition> ;
326 GENERIC: flatten-value-type ( type -- types )
328 M: object flatten-value-type 1array ;
330 M: alien.structs:struct-type flatten-value-type ( type -- types )
331 stack-size cell align (flatten-int-type) ;
333 M: classes.struct:struct-c-type flatten-value-type ( type -- types )
334 stack-size cell align (flatten-int-type) ;
336 M: long-long-type flatten-value-type ( type -- types )
337 stack-size cell align (flatten-int-type) ;
339 : flatten-value-types ( params -- params )
340 #! Convert value type structs to consecutive void*s.
344 [ parameter-align (flatten-int-type) % ] keep
345 [ stack-size cell align + ] keep
350 : each-parameter ( parameters quot -- )
351 [ [ parameter-sizes nip ] keep ] dip 2each ; inline
353 : reverse-each-parameter ( parameters quot -- )
354 [ [ parameter-sizes nip ] keep ] dip 2reverse-each ; inline
356 : reset-fastcall-counts ( -- )
357 { int-regs float-regs stack-params } [ 0 swap set ] each ;
359 : with-param-regs ( quot -- )
360 #! In quot you can call alloc-parameter
361 [ reset-fastcall-counts call ] with-scope ; inline
363 : move-parameters ( node word -- )
364 #! Moves values from C stack to registers (if word is
365 #! %load-param-reg) and registers to C stack (if word is
367 [ alien-parameters flatten-value-types ]
368 [ '[ alloc-parameter _ execute ] ]
369 bi* each-parameter ; inline
371 : unbox-parameters ( offset node -- )
373 %prepare-unbox [ over + ] dip unbox-parameter
374 ] reverse-each-parameter drop ;
376 : prepare-box-struct ( node -- offset )
377 #! Return offset on C stack where to store unboxed
378 #! parameters. If the C function is returning a structure,
379 #! the first parameter is an implicit target area pointer,
380 #! so we need to use a different offset.
381 return>> large-struct?
382 [ %prepare-box-struct cell ] [ 0 ] if ;
384 : objects>registers ( params -- )
385 #! Generate code for unboxing a list of C types, then
386 #! generate code for moving these parameters to registers on
387 #! architectures where parameters are passed in registers.
389 [ prepare-box-struct ] keep
390 [ unbox-parameters ] keep
391 \ %load-param-reg move-parameters
394 : box-return* ( node -- )
395 return>> [ ] [ box-return ] if-void ;
397 : check-dlsym ( symbols dll -- )
399 dupd '[ _ dlsym ] any?
400 [ drop ] [ compiling-word get no-such-symbol ] if
402 dll-path compiling-word get no-such-library drop
405 : stdcall-mangle ( symbol params -- symbol )
406 parameters>> parameter-sizes drop number>string "@" glue ;
408 : alien-invoke-dlsym ( params -- symbols dll )
409 [ [ function>> dup ] keep stdcall-mangle 2array ]
410 [ library>> library dup [ dll>> ] when ]
411 bi 2dup check-dlsym ;
413 M: ##alien-invoke generate-insn
416 dup objects>registers
419 dup alien-invoke-dlsym %alien-invoke
425 M: ##alien-indirect generate-insn
427 ! Save alien at top of stack to temporary storage
428 %prepare-alien-indirect
430 dup objects>registers
432 ! Call alien in temporary storage
439 : box-parameters ( params -- )
440 alien-parameters [ box-parameter ] each-parameter ;
442 : registers>objects ( node -- )
443 ! Generate code for boxing input parameters in a callback.
445 dup \ %save-param-reg move-parameters
446 "nest_stacks" %vm-invoke-1st-arg
450 TUPLE: callback-context ;
452 : current-callback ( -- id ) 2 getenv ;
454 : wait-to-return ( token -- )
455 dup current-callback eq? [
458 yield-hook get call( -- ) wait-to-return
461 : do-callback ( quot token -- )
463 [ 2 setenv call ] keep
464 wait-to-return ; inline
466 : callback-return-quot ( ctype -- quot )
468 { [ dup void? ] [ drop [ ] ] }
469 { [ dup large-struct? ] [ heap-size '[ _ memcpy ] ] }
470 [ c-type c-type-unboxer-quot ]
473 : callback-prep-quot ( params -- quot )
474 parameters>> [ c-type c-type-boxer-quot ] map spread>quot ;
476 : wrap-callback-quot ( params -- quot )
478 [ callback-prep-quot ]
480 [ callback-return-quot ] tri 3append ,
481 [ callback-context new do-callback ] %
484 : %unnest-stacks ( -- ) "unnest_stacks" %vm-invoke-1st-arg ;
486 M: ##callback-return generate-insn
487 #! All the extra book-keeping for %unwind is only for x86.
488 #! On other platforms its an alias for %return.
489 params>> %callback-return ;
491 M: ##alien-callback generate-insn
493 [ registers>objects ]
494 [ wrap-callback-quot %alien-callback ]
495 [ alien-return [ %unnest-stacks ] [ %callback-value ] if-void ]