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