factor/library/compiler/generator/generator.factor

! Copyright (C) 2004, 2006 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
IN: compiler
USING: arrays assembler errors generic hashtables inference
kernel kernel-internals lists math namespaces queues sequences
words ;

GENERIC: stack-reserve*

M: object stack-reserve* drop 0 ;

: stack-reserve ( node -- n )
    0 swap [ stack-reserve* max ] each-node ;

: intrinsic ( #call -- quot )
    node-param "intrinsic" word-prop ;

: if-intrinsic ( #call -- quot )
    node-param "if-intrinsic" word-prop ;

DEFER: #terminal?

PREDICATE: #merge #terminal-merge node-successor #terminal? ;

PREDICATE: #call #terminal-call
    dup node-successor #if?
    over node-successor node-successor #terminal? and
    swap if-intrinsic and ;

UNION: #terminal
    POSTPONE: f #return #values #terminal-merge ;

: tail-call? ( -- ? )
    node-stack get [
        dup #terminal-call? swap node-successor #terminal? or
    ] all? ;

: generate-code ( word node quot -- length | quot: node -- )
    compiled-offset >r
    compile-aligned
    rot save-xt
    over stack-reserve %prologue
    call
    compile-aligned
    compiled-offset r> - ;

: generate-reloc ( -- length )
    relocation-table get
    dup [ assemble-cell ] each
    length cells ;

SYMBOL: previous-offset

: begin-generating ( -- code-len-fixup reloc-len-fixup )
    compiled-offset previous-offset set
    V{ } clone relocation-table set
    init-templates begin-assembly swap ;

: generate-1 ( word node quot -- | quot: node -- )
    #! If generation fails, reset compiled offset.
    [
        begin-generating >r >r
            generate-code
            generate-reloc
        r> set-compiled-cell
        r> set-compiled-cell
    ] [
        previous-offset get set-compiled-offset rethrow
    ] recover ;

SYMBOL: generate-queue

: generate-loop ( -- )
    generate-queue get dup queue-empty? [
        drop
    ] [
        deque first3 generate-1 generate-loop
    ] if ;

: generate-block ( word node quot -- | quot: node -- )
    3array generate-queue get enque ;

GENERIC: generate-node ( node -- )

: generate-nodes ( node -- )
    [ node@ generate-node ] iterate-nodes end-basic-block ;

: generate-word ( node -- )
    [ [ generate-nodes ] with-node-iterator ]
    generate-block ;

: generate ( word node -- )
    [
        <queue> generate-queue set
        generate-word generate-loop 
    ] with-scope ;

! node
M: node generate-node ( node -- next ) drop iterate-next ;

! #label
: generate-call ( label -- next )
    end-basic-block
    tail-call? [ %jump f ] [ %call iterate-next ] if ;

M: #label generate-node ( node -- next )
    #! We remap the IR node's label to a new label object here,
    #! to avoid problems with two IR #label nodes having the
    #! same label in different lexical scopes.
    dup node-param dup generate-call >r
    swap node-child generate-word r> ;

! #if
: end-false-branch ( label -- )
    tail-call? [ %return drop ] [ %jump-label ] if ;

: generate-if ( node label -- next )
    <label> [
        >r >r node-children first2 generate-nodes
        r> r> end-false-branch save-xt generate-nodes
    ] keep save-xt iterate-next ;

M: #if generate-node ( node -- next )
    [
        end-basic-block
        <label> dup %jump-t
    ] H{
        { +input { { 0 "flag" } } }
    } with-template generate-if ;

! #call
: [with-template] ( quot template -- quot )
    2array >list [ with-template ] append ;

: define-intrinsic ( word quot template -- | quot: -- )
    [with-template] "intrinsic" set-word-prop ;

: define-if-intrinsic ( word quot template -- | quot: label -- )
    [with-template] "if-intrinsic" set-word-prop ;

: if>boolean-intrinsic ( label -- )
    <label> "end" set
    f 0 <int-vreg> load-literal
    "end" get %jump-label
    save-xt
    t 0 <int-vreg> load-literal
    "end" get save-xt
    0 <int-vreg> phantom-d get phantom-push ;

: do-if-intrinsic ( node -- next )
    [ <label> dup ] keep if-intrinsic call
    >r node-successor dup #if? [
        r> generate-if node-successor
    ] [
        drop r> if>boolean-intrinsic iterate-next
    ] if ;

M: #call generate-node ( node -- next )
    {
        { [ dup if-intrinsic ] [ do-if-intrinsic ] }
        { [ dup intrinsic ] [ intrinsic call iterate-next ] }
        { [ t ] [ node-param generate-call ] }
    } cond ;

! #call-label
M: #call-label generate-node ( node -- next )
    node-param generate-call ;

! #dispatch
: target-label ( label -- ) 0 assemble-cell absolute-cell ;

: dispatch-head ( node -- label/node )
    #! Output the jump table insn and return a list of
    #! label/branch pairs.
    [ end-basic-block %dispatch ] H{
        { +input { { f "n" } } }
        { +scratch { { f "scratch" } } }
    } with-template
    node-children [ <label> dup target-label 2array ] map ;

: dispatch-body ( label/node -- )
    <label> swap [
        first2 save-xt generate-nodes end-basic-block
        dup %jump-label
    ] each save-xt ;

M: #dispatch generate-node ( node -- next )
    #! The parameter is a list of nodes, each one is a branch to
    #! take in case the top of stack has that type.
    dispatch-head dispatch-body iterate-next ;

! #push
UNION: immediate fixnum POSTPONE: f ;

: generate-push ( node -- )
    >#push< dup literal-template
    dup requested-vregs ensure-vregs
    alloc-vregs [ [ load-literal ] 2each ] keep
    phantom-d get phantom-append ;

M: #push generate-node ( #push -- )
    generate-push iterate-next ;

! #shuffle
: phantom-shuffle-input ( n phantom -- seq )
    2dup length <= [
        cut-phantom
    ] [
        [ phantom-locs ] keep [ length swap head-slice* ] keep
        [ append 0 ] keep set-length
    ] if ;

: phantom-shuffle-inputs ( shuffle -- locs locs )
    dup shuffle-in-d length phantom-d get phantom-shuffle-input
    swap shuffle-in-r length phantom-r get phantom-shuffle-input ;

: adjust-shuffle ( shuffle -- )
    dup shuffle-in-d length neg phantom-d get adjust-phantom
    shuffle-in-r length neg phantom-r get adjust-phantom ;

: shuffle-vregs# ( shuffle -- n )
    dup shuffle-in-d swap shuffle-in-r additional-vregs# ;

: phantom-shuffle ( shuffle -- )
    dup shuffle-vregs# 0 ensure-vregs
    [ phantom-shuffle-inputs ] keep
    [ shuffle* ] keep adjust-shuffle
    (template-outputs) ;

M: #shuffle generate-node ( #shuffle -- )
    node-shuffle phantom-shuffle iterate-next ;

! #return
M: #return generate-node drop end-basic-block %return f ;

! These constants must match native/card.h
: card-bits 7 ;
: card-mark HEX: 80 ;

: float-offset 8 float-tag - ;
: string-offset 3 cells object-tag - ;