basis/compiler/codegen/codegen.factor

   1 ! Copyright (C) 2008, 2010 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: namespaces make math math.order math.parser sequences
   4 accessors kernel layouts assocs words summary arrays combinators
   5 classes.algebra alien alien.private alien.c-types alien.strings
   6 alien.arrays alien.complex alien.libraries sets libc
   7 continuations.private fry cpu.architecture classes
   8 classes.struct locals source-files.errors slots parser
   9 generic.parser strings quotations
  10 compiler.errors
  11 compiler.alien
  12 compiler.constants
  13 compiler.cfg
  14 compiler.cfg.instructions
  15 compiler.cfg.stack-frame
  16 compiler.cfg.registers
  17 compiler.cfg.builder
  18 compiler.codegen.fixup
  19 compiler.utilities ;
  20 FROM: namespaces => set ;
  21 IN: compiler.codegen
  22
  23 SYMBOL: insn-counts
  24
  25 H{ } clone insn-counts set-global
  26
  27 GENERIC: generate-insn ( insn -- )
  28
  29 ! Mapping _label IDs to label instances
  30 SYMBOL: labels
  31
  32 : generate ( mr -- code )
  33     dup label>> [
  34         H{ } clone labels set
  35         instructions>> [
  36             [ class insn-counts get inc-at ]
  37             [ generate-insn ]
  38             bi
  39         ] each
  40     ] with-fixup ;
  41
  42 : lookup-label ( id -- label )
  43     labels get [ drop <label> ] cache ;
  44
  45 ! Special cases
  46 M: ##no-tco generate-insn drop ;
  47
  48 M: _dispatch-label generate-insn
  49     label>> lookup-label
  50     cell 0 <repetition> %
  51     rc-absolute-cell label-fixup ;
  52
  53 M: _prologue generate-insn
  54     stack-frame>> [ stack-frame set ] [ total-size>> %prologue ] bi ;
  55
  56 M: _epilogue generate-insn
  57     stack-frame>> total-size>> %epilogue ;
  58
  59 M: _spill-area-size generate-insn drop ;
  60
  61 ! Some meta-programming to generate simple code generators, where
  62 ! the instruction is unpacked and then a %word is called
  63 <<
  64
  65 : insn-slot-quot ( spec -- quot )
  66     name>> [ reader-word ] [ "label" = ] bi
  67     [ \ lookup-label [ ] 2sequence ] [ [ ] 1sequence ] if ;
  68
  69 : codegen-method-body ( class word -- quot )
  70     [
  71         "insn-slots" word-prop
  72         [ insn-slot-quot ] map cleave>quot
  73     ] dip suffix ;
  74
  75 SYNTAX: CODEGEN:
  76     scan-word [ \ generate-insn create-method-in ] keep scan-word
  77     codegen-method-body define ;
  78 >>
  79
  80 CODEGEN: ##load-immediate %load-immediate
  81 CODEGEN: ##load-reference %load-reference
  82 CODEGEN: ##load-constant %load-reference
  83 CODEGEN: ##peek %peek
  84 CODEGEN: ##replace %replace
  85 CODEGEN: ##inc-d %inc-d
  86 CODEGEN: ##inc-r %inc-r
  87 CODEGEN: ##call %call
  88 CODEGEN: ##jump %jump
  89 CODEGEN: ##return %return
  90 CODEGEN: ##slot %slot
  91 CODEGEN: ##slot-imm %slot-imm
  92 CODEGEN: ##set-slot %set-slot
  93 CODEGEN: ##set-slot-imm %set-slot-imm
  94 CODEGEN: ##string-nth %string-nth
  95 CODEGEN: ##set-string-nth-fast %set-string-nth-fast
  96 CODEGEN: ##add %add
  97 CODEGEN: ##add-imm %add-imm
  98 CODEGEN: ##sub %sub
  99 CODEGEN: ##sub-imm %sub-imm
 100 CODEGEN: ##mul %mul
 101 CODEGEN: ##mul-imm %mul-imm
 102 CODEGEN: ##and %and
 103 CODEGEN: ##and-imm %and-imm
 104 CODEGEN: ##or %or
 105 CODEGEN: ##or-imm %or-imm
 106 CODEGEN: ##xor %xor
 107 CODEGEN: ##xor-imm %xor-imm
 108 CODEGEN: ##shl %shl
 109 CODEGEN: ##shl-imm %shl-imm
 110 CODEGEN: ##shr %shr
 111 CODEGEN: ##shr-imm %shr-imm
 112 CODEGEN: ##sar %sar
 113 CODEGEN: ##sar-imm %sar-imm
 114 CODEGEN: ##min %min
 115 CODEGEN: ##max %max
 116 CODEGEN: ##not %not
 117 CODEGEN: ##neg %neg
 118 CODEGEN: ##log2 %log2
 119 CODEGEN: ##copy %copy
 120 CODEGEN: ##add-float %add-float
 121 CODEGEN: ##sub-float %sub-float
 122 CODEGEN: ##mul-float %mul-float
 123 CODEGEN: ##div-float %div-float
 124 CODEGEN: ##min-float %min-float
 125 CODEGEN: ##max-float %max-float
 126 CODEGEN: ##sqrt %sqrt
 127 CODEGEN: ##unary-float-function %unary-float-function
 128 CODEGEN: ##binary-float-function %binary-float-function
 129 CODEGEN: ##single>double-float %single>double-float
 130 CODEGEN: ##double>single-float %double>single-float
 131 CODEGEN: ##integer>float %integer>float
 132 CODEGEN: ##float>integer %float>integer
 133 CODEGEN: ##zero-vector %zero-vector
 134 CODEGEN: ##fill-vector %fill-vector
 135 CODEGEN: ##gather-vector-2 %gather-vector-2
 136 CODEGEN: ##gather-vector-4 %gather-vector-4
 137 CODEGEN: ##shuffle-vector-imm %shuffle-vector-imm
 138 CODEGEN: ##shuffle-vector %shuffle-vector
 139 CODEGEN: ##tail>head-vector %tail>head-vector
 140 CODEGEN: ##merge-vector-head %merge-vector-head
 141 CODEGEN: ##merge-vector-tail %merge-vector-tail
 142 CODEGEN: ##signed-pack-vector %signed-pack-vector
 143 CODEGEN: ##unsigned-pack-vector %unsigned-pack-vector
 144 CODEGEN: ##unpack-vector-head %unpack-vector-head
 145 CODEGEN: ##unpack-vector-tail %unpack-vector-tail
 146 CODEGEN: ##integer>float-vector %integer>float-vector
 147 CODEGEN: ##float>integer-vector %float>integer-vector
 148 CODEGEN: ##compare-vector %compare-vector
 149 CODEGEN: ##test-vector %test-vector
 150 CODEGEN: ##add-vector %add-vector
 151 CODEGEN: ##saturated-add-vector %saturated-add-vector
 152 CODEGEN: ##add-sub-vector %add-sub-vector
 153 CODEGEN: ##sub-vector %sub-vector
 154 CODEGEN: ##saturated-sub-vector %saturated-sub-vector
 155 CODEGEN: ##mul-vector %mul-vector
 156 CODEGEN: ##mul-high-vector %mul-high-vector
 157 CODEGEN: ##mul-horizontal-add-vector %mul-horizontal-add-vector
 158 CODEGEN: ##saturated-mul-vector %saturated-mul-vector
 159 CODEGEN: ##div-vector %div-vector
 160 CODEGEN: ##min-vector %min-vector
 161 CODEGEN: ##max-vector %max-vector
 162 CODEGEN: ##avg-vector %avg-vector
 163 CODEGEN: ##dot-vector %dot-vector
 164 CODEGEN: ##sad-vector %sad-vector
 165 CODEGEN: ##sqrt-vector %sqrt-vector
 166 CODEGEN: ##horizontal-add-vector %horizontal-add-vector
 167 CODEGEN: ##horizontal-sub-vector %horizontal-sub-vector
 168 CODEGEN: ##horizontal-shl-vector-imm %horizontal-shl-vector-imm
 169 CODEGEN: ##horizontal-shr-vector-imm %horizontal-shr-vector-imm
 170 CODEGEN: ##abs-vector %abs-vector
 171 CODEGEN: ##and-vector %and-vector
 172 CODEGEN: ##andn-vector %andn-vector
 173 CODEGEN: ##or-vector %or-vector
 174 CODEGEN: ##xor-vector %xor-vector
 175 CODEGEN: ##not-vector %not-vector
 176 CODEGEN: ##shl-vector-imm %shl-vector-imm
 177 CODEGEN: ##shr-vector-imm %shr-vector-imm
 178 CODEGEN: ##shl-vector %shl-vector
 179 CODEGEN: ##shr-vector %shr-vector
 180 CODEGEN: ##integer>scalar %integer>scalar
 181 CODEGEN: ##scalar>integer %scalar>integer
 182 CODEGEN: ##vector>scalar %vector>scalar
 183 CODEGEN: ##scalar>vector %scalar>vector
 184 CODEGEN: ##box-alien %box-alien
 185 CODEGEN: ##box-displaced-alien %box-displaced-alien
 186 CODEGEN: ##unbox-alien %unbox-alien
 187 CODEGEN: ##unbox-any-c-ptr %unbox-any-c-ptr
 188 CODEGEN: ##alien-unsigned-1 %alien-unsigned-1
 189 CODEGEN: ##alien-unsigned-2 %alien-unsigned-2
 190 CODEGEN: ##alien-unsigned-4 %alien-unsigned-4
 191 CODEGEN: ##alien-signed-1 %alien-signed-1
 192 CODEGEN: ##alien-signed-2 %alien-signed-2
 193 CODEGEN: ##alien-signed-4 %alien-signed-4
 194 CODEGEN: ##alien-cell %alien-cell
 195 CODEGEN: ##alien-float %alien-float
 196 CODEGEN: ##alien-double %alien-double
 197 CODEGEN: ##alien-vector %alien-vector
 198 CODEGEN: ##set-alien-integer-1 %set-alien-integer-1
 199 CODEGEN: ##set-alien-integer-2 %set-alien-integer-2
 200 CODEGEN: ##set-alien-integer-4 %set-alien-integer-4
 201 CODEGEN: ##set-alien-cell %set-alien-cell
 202 CODEGEN: ##set-alien-float %set-alien-float
 203 CODEGEN: ##set-alien-double %set-alien-double
 204 CODEGEN: ##set-alien-vector %set-alien-vector
 205 CODEGEN: ##allot %allot
 206 CODEGEN: ##write-barrier %write-barrier
 207 CODEGEN: ##write-barrier-imm %write-barrier-imm
 208 CODEGEN: ##compare %compare
 209 CODEGEN: ##compare-imm %compare-imm
 210 CODEGEN: ##compare-float-ordered %compare-float-ordered
 211 CODEGEN: ##compare-float-unordered %compare-float-unordered
 212 CODEGEN: ##save-context %save-context
 213 CODEGEN: ##vm-field %vm-field
 214 CODEGEN: ##set-vm-field %set-vm-field
 215
 216 CODEGEN: _fixnum-add %fixnum-add
 217 CODEGEN: _fixnum-sub %fixnum-sub
 218 CODEGEN: _fixnum-mul %fixnum-mul
 219 CODEGEN: _label resolve-label
 220 CODEGEN: _branch %jump-label
 221 CODEGEN: _compare-branch %compare-branch
 222 CODEGEN: _compare-imm-branch %compare-imm-branch
 223 CODEGEN: _compare-float-ordered-branch %compare-float-ordered-branch
 224 CODEGEN: _compare-float-unordered-branch %compare-float-unordered-branch
 225 CODEGEN: _test-vector-branch %test-vector-branch
 226 CODEGEN: _dispatch %dispatch
 227 CODEGEN: _spill %spill
 228 CODEGEN: _reload %reload
 229
 230 ! ##gc
 231 : wipe-locs ( locs temp -- )
 232     '[
 233         _
 234         [ 0 %load-immediate ]
 235         [ swap [ %replace ] with each ] bi
 236     ] unless-empty ;
 237
 238 GENERIC# save-gc-root 1 ( gc-root operand temp -- )
 239
 240 M:: spill-slot save-gc-root ( gc-root operand temp -- )
 241     temp int-rep operand %reload
 242     gc-root temp %save-gc-root ;
 243
 244 M: object save-gc-root drop %save-gc-root ;
 245
 246 : save-gc-roots ( gc-roots temp -- ) '[ _ save-gc-root ] assoc-each ;
 247
 248 : save-data-regs ( data-regs -- ) [ first3 %spill ] each ;
 249
 250 GENERIC# load-gc-root 1 ( gc-root operand temp -- )
 251
 252 M:: spill-slot load-gc-root ( gc-root operand temp -- )
 253     gc-root temp %load-gc-root
 254     temp int-rep operand %spill ;
 255
 256 M: object load-gc-root drop %load-gc-root ;
 257
 258 : load-gc-roots ( gc-roots temp -- ) '[ _ load-gc-root ] assoc-each ;
 259
 260 : load-data-regs ( data-regs -- ) [ first3 %reload ] each ;
 261
 262 M: ##gc generate-insn
 263     "no-gc" define-label
 264     {
 265         [ [ "no-gc" get ] dip [ size>> ] [ temp1>> ] [ temp2>> ] tri %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 %save-context ]
 270         [ [ tagged-values>> length ] [ temp1>> ] bi %call-gc ]
 271         [ [ tagged-values>> ] [ temp1>> ] bi load-gc-roots ]
 272         [ data-values>> load-data-regs ]
 273     } cleave
 274     "no-gc" resolve-label ;
 275
 276 M: _loop-entry generate-insn drop %loop-entry ;
 277
 278 M: ##alien-global generate-insn
 279     [ dst>> ] [ symbol>> ] [ library>> ] tri
 280     %alien-global ;
 281
 282 ! ##alien-invoke
 283 GENERIC: next-fastcall-param ( rep -- )
 284
 285 : ?dummy-stack-params ( rep -- )
 286     dummy-stack-params? [ rep-size cell align stack-params +@ ] [ drop ] if ;
 287
 288 : ?dummy-int-params ( rep -- )
 289     dummy-int-params? [ rep-size cell /i 1 max int-regs +@ ] [ drop ] if ;
 290
 291 : ?dummy-fp-params ( rep -- )
 292     drop dummy-fp-params? [ float-regs inc ] when ;
 293
 294 M: int-rep next-fastcall-param
 295     int-regs inc [ ?dummy-stack-params ] [ ?dummy-fp-params ] bi ;
 296
 297 M: float-rep next-fastcall-param
 298     float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
 299
 300 M: double-rep next-fastcall-param
 301     float-regs inc [ ?dummy-stack-params ] [ ?dummy-int-params ] bi ;
 302
 303 GENERIC# reg-class-full? 1 ( reg-class abi -- ? )
 304
 305 M: stack-params reg-class-full? 2drop t ;
 306
 307 M: reg-class reg-class-full?
 308     [ get ] swap '[ _ param-regs length ] bi >= ;
 309
 310 : alloc-stack-param ( rep -- n reg-class rep )
 311     stack-params get
 312     [ rep-size cell align stack-params +@ ] dip
 313     stack-params dup ;
 314
 315 : alloc-fastcall-param ( rep -- n reg-class rep )
 316     [ [ reg-class-of get ] [ reg-class-of ] [ next-fastcall-param ] tri ] keep ;
 317
 318 :: alloc-parameter ( parameter abi -- reg rep )
 319     parameter c-type-rep dup reg-class-of abi reg-class-full?
 320     [ alloc-stack-param ] [ alloc-fastcall-param ] if
 321     [ abi param-reg ] dip ;
 322
 323 SYMBOL: (stack-value)
 324 << void* c-type clone \ (stack-value) define-primitive-type
 325 stack-params \ (stack-value) c-type (>>rep) >>
 326
 327 : ((flatten-type)) ( type to-type -- seq )
 328     [ stack-size cell align cell /i ] dip c-type <repetition> ; inline
 329
 330 : (flatten-int-type) ( type -- seq )
 331     void* ((flatten-type)) ;
 332 : (flatten-stack-type) ( type -- seq )
 333     (stack-value) ((flatten-type)) ;
 334
 335 GENERIC: flatten-value-type ( type -- types )
 336
 337 M: object flatten-value-type 1array ;
 338 M: struct-c-type flatten-value-type (flatten-int-type) ;
 339 M: long-long-type flatten-value-type (flatten-int-type) ;
 340 M: c-type-name flatten-value-type c-type flatten-value-type ;
 341
 342 : flatten-value-types ( params -- params )
 343     #! Convert value type structs to consecutive void*s.
 344     [
 345         0 [
 346             c-type
 347             [ parameter-align cell /i void* c-type <repetition> % ] keep
 348             [ stack-size cell align + ] keep
 349             flatten-value-type %
 350         ] reduce drop
 351     ] { } make ;
 352
 353 : each-parameter ( parameters quot -- )
 354     [ [ parameter-offsets nip ] keep ] dip 2each ; inline
 355
 356 : reset-fastcall-counts ( -- )
 357     { int-regs float-regs stack-params } [ 0 swap set ] each ;
 358
 359 : with-param-regs ( quot -- )
 360     #! In quot you can call alloc-parameter
 361     [ reset-fastcall-counts call ] with-scope ; inline
 362
 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
 366     #! %save-param-reg).
 367     [ [ alien-parameters flatten-value-types ] [ abi>> ] bi ]
 368     [ '[ _ alloc-parameter _ execute ] ]
 369     bi* each-parameter ; inline
 370
 371 : reverse-each-parameter ( parameters quot -- )
 372     [ [ parameter-offsets nip ] keep ] dip 2reverse-each ; inline
 373
 374 : prepare-unbox-parameters ( parameters -- offsets types indices )
 375     [ parameter-offsets nip ] [ ] [ length iota <reversed> ] tri ;
 376
 377 : unbox-parameters ( offset node -- )
 378     parameters>> swap
 379     '[ prepare-unbox-parameters [ %pop-stack [ _ + ] dip unbox-parameter ] 3each ]
 380     [ length neg %inc-d ]
 381     bi ;
 382
 383 : prepare-box-struct ( node -- offset )
 384     #! Return offset on C stack where to store unboxed
 385     #! parameters. If the C function is returning a structure,
 386     #! the first parameter is an implicit target area pointer,
 387     #! so we need to use a different offset.
 388     return>> large-struct?
 389     [ %prepare-box-struct cell ] [ 0 ] if ;
 390
 391 : objects>registers ( params -- )
 392     #! Generate code for unboxing a list of C types, then
 393     #! generate code for moving these parameters to registers on
 394     #! architectures where parameters are passed in registers.
 395     [
 396         [ prepare-box-struct ] keep
 397         [ unbox-parameters ] keep
 398         \ %load-param-reg move-parameters
 399     ] with-param-regs ;
 400
 401 : box-return* ( node -- )
 402     return>> [ ] [ box-return %push-stack ] if-void ;
 403
 404 GENERIC# dlsym-valid? 1 ( symbols dll -- ? )
 405
 406 M: string dlsym-valid? dlsym ;
 407
 408 M: array dlsym-valid? '[ _ dlsym ] any? ;
 409
 410 : check-dlsym ( symbols dll -- )
 411     dup dll-valid? [
 412         dupd dlsym-valid?
 413         [ drop ] [ compiling-word get no-such-symbol ] if
 414     ] [
 415         dll-path compiling-word get no-such-library drop
 416     ] if ;
 417
 418 : stdcall-mangle ( params -- symbols )
 419     [ function>> ] [ parameters>> parameter-offsets drop number>string ] bi
 420     [ drop ] [ "@" glue ] [ "@" glue "_" prepend ] 2tri
 421     3array ;
 422
 423 : alien-invoke-dlsym ( params -- symbols dll )
 424     [ dup abi>> stdcall = [ stdcall-mangle ] [ function>> ] if ]
 425     [ library>> load-library ]
 426     bi 2dup check-dlsym ;
 427
 428 M: ##alien-invoke generate-insn
 429     params>>
 430     ! Unbox parameters
 431     dup objects>registers
 432     %prepare-var-args
 433     ! Call function
 434     dup alien-invoke-dlsym %alien-invoke
 435     ! Box return value
 436     dup %cleanup
 437     box-return* ;
 438
 439 M: ##alien-assembly generate-insn
 440     params>>
 441     ! Unbox parameters
 442     dup objects>registers
 443     %prepare-var-args
 444     ! Generate assembly
 445     dup quot>> call( -- )
 446     ! Box return value
 447     box-return* ;
 448
 449 ! ##alien-indirect
 450 M: ##alien-indirect generate-insn
 451     params>>
 452     ! Save alien at top of stack to temporary storage
 453     %prepare-alien-indirect
 454     ! Unbox parameters
 455     dup objects>registers
 456     %prepare-var-args
 457     ! Call alien in temporary storage
 458     %alien-indirect
 459     ! Box return value
 460     dup %cleanup
 461     box-return* ;
 462
 463 ! ##alien-callback
 464 : box-parameters ( params -- )
 465     alien-parameters [ box-parameter %push-context-stack ] each-parameter ;
 466
 467 : registers>objects ( node -- )
 468     ! Generate code for boxing input parameters in a callback.
 469     [
 470         dup \ %save-param-reg move-parameters
 471         %begin-callback
 472         box-parameters
 473     ] with-param-regs ;
 474
 475 : callback-return-quot ( ctype -- quot )
 476     return>> {
 477         { [ dup void? ] [ drop [ ] ] }
 478         { [ dup large-struct? ] [ heap-size '[ _ memcpy ] ] }
 479         [ c-type c-type-unboxer-quot ]
 480     } cond ;
 481
 482 : callback-prep-quot ( params -- quot )
 483     parameters>> [ c-type c-type-boxer-quot ] map spread>quot ;
 484
 485 : wrap-callback-quot ( params -- quot )
 486     [ callback-prep-quot ] [ quot>> ] [ callback-return-quot ] tri 3append
 487      yield-hook get
 488      '[ _ _ do-callback ]
 489      >quotation ;
 490
 491 M: ##alien-callback generate-insn
 492     params>>
 493     [ registers>objects ]
 494     [ wrap-callback-quot %alien-callback ]
 495     [ alien-return [ %end-callback ] [ %end-callback-value ] if-void ] tri ;