Diff for /gforth/prims2x.fs between versions 1.69 and 1.146

version 1.69, 2001/01/19 21:07:05 version 1.146, 2003/10/16 18:48:03
Line 1 Line 1
 \ converts primitives to, e.g., C code   \ converts primitives to, e.g., C code 
   
 \ Copyright (C) 1995,1996,1997,1998,2000 Free Software Foundation, Inc.  \ Copyright (C) 1995,1996,1997,1998,2000,2003 Free Software Foundation, Inc.
   
 \ This file is part of Gforth.  \ This file is part of Gforth.
   
Line 19 Line 19
 \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.  \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
   
   
 \ This is not very nice (hard limits, no checking, assumes 1 chars = 1)  \ This is not very nice (hard limits, no checking, assumes 1 chars = 1).
   \ And it grew even worse when it aged.
   
 \ Optimizations:  \ Optimizations:
 \ superfluous stores are removed. GCC removes the superfluous loads by itself  \ superfluous stores are removed. GCC removes the superfluous loads by itself
Line 39 Line 40
 \ add the store optimization for doubles  \ add the store optimization for doubles
 \ regarding problem 1 above: It would be better (for over) to implement  \ regarding problem 1 above: It would be better (for over) to implement
 \       the alternative  \       the alternative
   \ store optimization for combined instructions.
   
   \ Design Uglyness:
   
   \ - global state (values, variables) in connection with combined instructions.
   
   \ - index computation is different for instruction-stream and the
   \ stacks; there are two mechanisms for dealing with that
   \ (stack-in-index-xt and a test for stack==instruction-stream); there
   \ should be only one.
   
   \ for backwards compatibility, jaw
   require compat/strcomp.fs
   
 warnings off  warnings off
   
 [IFUNDEF] vocabulary    \ we are executed just with kernel image  \ redefinitions of kernel words not present in gforth-0.6.1
                         \ load the rest that is needed  : latestxt lastcfa @ ;
                         \ (require fails because this file is needed from a  : latest last @ ;
                         \ different directory with the wordlibraries)  
 include ./search.fs                       
 include ./extend.fs  
 [THEN]  
   
 [IFUNDEF] environment?  [IFUNDEF] try
 include ./environ.fs  include startup.fs
 [THEN]  [THEN]
   
 : struct% struct ; \ struct is redefined in gray  : struct% struct ; \ struct is redefined in gray
   
 include ./gray.fs  warnings off
   \ warnings on
   
 32 constant max-effect \ number of things on one side of a stack effect  include ./gray.fs
   128 constant max-effect \ number of things on one side of a stack effect
   4 constant max-stacks  \ the max. number of stacks (including inst-stream).
 255 constant maxchar  255 constant maxchar
 maxchar 1+ constant eof-char  maxchar 1+ constant eof-char
 #tab constant tab-char  #tab constant tab-char
Line 72  variable line-start \ pointer to start o Line 85  variable line-start \ pointer to start o
 0 line !  0 line !
 2variable filename \ filename of original input file  2variable filename \ filename of original input file
 0 0 filename 2!  0 0 filename 2!
   2variable out-filename \ filename of the output file (for sync lines)
   0 0 out-filename 2!
 2variable f-comment  2variable f-comment
 0 0 f-comment 2!  0 0 f-comment 2!
 variable skipsynclines \ are sync lines ("#line ...") invisible to the parser?  variable skipsynclines \ are sync lines ("#line ...") invisible to the parser?
 skipsynclines on   skipsynclines on
   variable out-nls \ newlines in output (for output sync lines)
   0 out-nls !
   variable store-optimization \ use store optimization?
   store-optimization off
   
   variable include-skipped-insts
   \ does the threaded code for a combined instruction include the cells
   \ for the component instructions (true) or only the cells for the
   \ inline arguments (false)
   include-skipped-insts off
   
   variable immarg \ values for immediate arguments (to be used in IMM_ARG macros)
   $12340000 immarg !
   
   : th ( addr1 n -- addr2 )
       cells + ;
   
   : holds ( addr u -- )
       \ like HOLD, but for a string
       tuck + swap 0 +do
           1- dup c@ hold
       loop
       drop ;
   
   : insert-wordlist { c-addr u wordlist xt -- }
       \ adds name "addr u" to wordlist using defining word xt
       \ xt may cause additional stack effects
       get-current >r wordlist set-current
       c-addr u nextname xt execute
       r> set-current ;
   
 : start ( -- addr )  : start ( -- addr )
  cookedinput @ ;   cookedinput @ ;
Line 83  skipsynclines on Line 128  skipsynclines on
 : end ( addr -- addr u )  : end ( addr -- addr u )
  cookedinput @ over - ;   cookedinput @ over - ;
   
   : print-error-line ( -- )
       \ print the current line and position
       line-start @ endrawinput @ over - 2dup nl-char scan drop nip ( start end )
       over - type cr
       line-start @ rawinput @ over - typewhite ." ^" cr ;
   
   : ?print-error { f addr u -- }
       f ?not? if
           outfile-id >r try
               stderr to outfile-id
               filename 2@ type ." :" line @ 0 .r ." : " addr u type cr
               print-error-line
               0
           recover endtry
           r> to outfile-id throw
           1 (bye) \ abort
       endif ;
   
 : quote ( -- )  : quote ( -- )
     [char] " emit ;      [char] " emit ;
   
 variable output \ xt ( -- ) of output word  \ count output lines to generate sync lines for output
   
 : printprim ( -- )  : count-nls ( addr u -- )
  output @ execute ;      bounds u+do
           i c@ nl-char = negate out-nls +!
       loop ;
   
   :noname ( addr u -- )
       2dup count-nls
       defers type ;
   is type
   
   variable output          \ xt ( -- ) of output word for simple primitives
   variable output-combined \ xt ( -- ) of output word for combined primitives
   
 struct%  struct%
       cell%    field stack-number \ the number of this stack
     cell% 2* field stack-pointer \ stackpointer name      cell% 2* field stack-pointer \ stackpointer name
     cell% 2* field stack-cast \ cast string for assignments to stack elements      cell%    field stack-type \ name for default type of stack items
     cell%    field stack-in-index-xt \ ( in-size item -- in-index )      cell%    field stack-in-index-xt \ ( in-size item -- in-index )
     cell%    field stack-in  \ number of stack items in effect in      cell%    field stack-access-transform \ ( nitem -- index )
     cell%    field stack-out \ number of stack items in effect out  
 end-struct stack%  end-struct stack%
   
 struct%  struct%
Line 115  struct% Line 188  struct%
     cell%    field type-store \ xt of store code generator ( item -- )      cell%    field type-store \ xt of store code generator ( item -- )
 end-struct type%  end-struct type%
   
   struct%
       cell%    field register-number
       cell%    field register-type \ pointer to type
       cell% 2* field register-name \ c name
   end-struct register%
   
   struct%
       cell% 2* field ss-registers  \ addr u; ss-registers[0] is TOS
                                    \ 0 means: use memory
       cell%    field ss-offset     \ stack pointer offset: sp[-offset] is TOS
   end-struct ss% \ stack-state
   
   struct%
       cell%              field state-number
       cell% max-stacks * field state-sss
   end-struct state%
   
   variable next-stack-number 0 next-stack-number !
   create stacks max-stacks cells allot \ array of stacks
   256 constant max-registers
   create registers max-registers cells allot \ array of registers
   variable nregisters 0 nregisters ! \ number of registers
   variable next-state-number 0 next-state-number ! \ next state number
   
 : stack-in-index ( in-size item -- in-index )  : stack-in-index ( in-size item -- in-index )
     item-offset @ - 1- ;      item-offset @ - 1- ;
   
 : inst-in-index ( in-size item -- in-index )  : inst-in-index ( in-size item -- in-index )
     nip dup item-offset @ swap item-type @ type-size @ + 1- ;      nip dup item-offset @ swap item-type @ type-size @ + 1- ;
   
 : make-stack ( addr-ptr u1 addr-cast u2 "stack-name" -- )  : make-stack ( addr-ptr u1 type "stack-name" -- )
       next-stack-number @ max-stacks < s" too many stacks" ?print-error
     create stack% %allot >r      create stack% %allot >r
     save-mem r@ stack-cast 2!      r@ stacks next-stack-number @ th !
       next-stack-number @ r@ stack-number !
       1 next-stack-number +!
       r@ stack-type !
     save-mem r@ stack-pointer 2!       save-mem r@ stack-pointer 2! 
     ['] stack-in-index r> stack-in-index-xt ! ;      ['] stack-in-index r@ stack-in-index-xt !
       ['] noop r@ stack-access-transform !
       rdrop ;
   
 s" sp" save-mem s" (Cell)" make-stack data-stack   : map-stacks { xt -- }
 s" fp" save-mem s" "       make-stack fp-stack      \ perform xt for all stacks
 s" rp" save-mem s" (Cell)" make-stack return-stack      next-stack-number @ 0 +do
 s" IP" save-mem s" error don't use # on results" make-stack inst-stream          stacks i th @ xt execute
 ' inst-in-index inst-stream stack-in-index-xt !      loop ;
 \ !! initialize stack-in and stack-out  
   : map-stacks1 { xt -- }
       \ perform xt for all stacks except inst-stream
       next-stack-number @ 1 +do
           stacks i th @ xt execute
       loop ;
   
 \ stack items  \ stack items
   
Line 148  s" IP" save-mem s" error don't use # on Line 256  s" IP" save-mem s" error don't use # on
         i xt execute          i xt execute
     item% %size +loop ;      item% %size +loop ;
   
   \ types
   
   : print-type-prefix ( type -- )
       body> >head name>string type ;
   
 \ various variables for storing stuff of one primitive  \ various variables for storing stuff of one primitive
   
 struct%  struct%
     cell% 2* field prim-name      cell% 2* field prim-name
     cell% 2* field prim-wordset      cell% 2* field prim-wordset
     cell% 2* field prim-c-name      cell% 2* field prim-c-name
       cell% 2* field prim-c-name-orig \ for reprocessed prims, the original name
     cell% 2* field prim-doc      cell% 2* field prim-doc
     cell% 2* field prim-c-code      cell% 2* field prim-c-code
     cell% 2* field prim-forth-code      cell% 2* field prim-forth-code
     cell% 2* field prim-stack-string      cell% 2* field prim-stack-string
       cell%    field prim-num            \ ordinal number
       cell%    field prim-items-wordlist \ unique items
     item% max-effect * field prim-effect-in      item% max-effect * field prim-effect-in
     item% max-effect * field prim-effect-out      item% max-effect * field prim-effect-out
     cell%    field prim-effect-in-end      cell%    field prim-effect-in-end
     cell%    field prim-effect-out-end      cell%    field prim-effect-out-end
       cell% max-stacks * field prim-stacks-in  \ number of in items per stack
       cell% max-stacks * field prim-stacks-out \ number of out items per stack
 end-struct prim%  end-struct prim%
   
 create prim prim% %allot  : make-prim ( -- prim )
       prim% %alloc { p }
       s" " p prim-doc 2! s" " p prim-forth-code 2! s" " p prim-wordset 2!
       p ;
   
   0 value prim     \ in combined prims either combined or a part
   0 value combined \ in combined prims the combined prim
   variable in-part \ true if processing a part
    in-part off
   0 value state-in  \ state on entering prim
   0 value state-out \ state on exiting prim
   0 value state-default  \ canonical state at bb boundaries
   
   : prim-context ( ... p xt -- ... )
       \ execute xt with prim set to p
       prim >r
       swap to prim
       catch
       r> to prim
       throw ;
   
   : prim-c-name-2! ( c-addr u -- )
       2dup prim prim-c-name 2! prim prim-c-name-orig 2! ;
   
   1000 constant max-combined
   create combined-prims max-combined cells allot
   variable num-combined
   variable part-num \ current part number during process-combined
   
   : map-combined { xt -- }
       \ perform xt for all components of the current combined instruction
       num-combined @ 0 +do
           combined-prims i th @ xt execute
       loop ;
   
   table constant combinations
     \ the keys are the sequences of pointers to primitives
   
   create current-depth max-stacks cells allot
   create max-depth     max-stacks cells allot
   create min-depth     max-stacks cells allot
   
   create sp-update-in max-stacks cells allot
   \ where max-depth occured the first time
   create max-depths max-stacks max-combined 1+ * cells allot
   \ maximum depth at start of each part: array[parts] of array[stack]
   create max-back-depths max-stacks max-combined 1+ * cells allot
   \ maximun depth from end of the combination to the start of the each part
   
   : s-c-max-depth ( nstack ncomponent -- addr )
       max-stacks * + cells max-depths + ;
   
   : s-c-max-back-depth ( nstack ncomponent -- addr )
       max-stacks * + cells max-back-depths + ;
   
   wordlist constant primitives
   
   : create-prim ( prim -- )
       dup prim-name 2@ primitives ['] constant insert-wordlist ;
   
   : stack-in ( stack -- addr )
       \ address of number of stack items in effect in
       stack-number @ cells prim prim-stacks-in + ;
   
   : stack-out ( stack -- addr )
       \ address of number of stack items in effect out
       stack-number @ cells prim prim-stacks-out + ;
   
 \ global vars  \ global vars
 variable c-line  variable c-line
Line 173  variable name-line Line 357  variable name-line
 2variable name-filename  2variable name-filename
 2variable last-name-filename  2variable last-name-filename
 Variable function-number 0 function-number !  Variable function-number 0 function-number !
   Variable function-old 0 function-old !
 \ for several reasons stack items of a word are stored in a wordlist  : function-diff ( n -- )
 \ since neither forget nor marker are implemented yet, we make a new      ." GROUPADD(" function-number @ function-old @ - 0 .r ." )" cr
 \ wordlist for every word and store it in the variable items      function-number @ function-old ! ;
 variable items  : forth-fdiff ( -- )
       function-number @ function-old @ - 0 .r ."  groupadd" cr
       function-number @ function-old ! ;
   
 \ a few more set ops  \ a few more set ops
   
Line 187  variable items Line 373  variable items
 : complement ( set1 -- set2 )  : complement ( set1 -- set2 )
  empty ['] bit-equivalent binary-set-operation ;   empty ['] bit-equivalent binary-set-operation ;
   
 \ types  \ forward declaration for inst-stream (breaks cycle in definitions)
   defer inst-stream-f ( -- stack )
   
   \ stack access stuff
   
   : normal-stack-access0 { n stack -- }
       \ n has the ss-offset already applied (see ...-access1)
       n stack stack-access-transform @ execute ." [" 0 .r ." ]" ;
   
   : state-ss { stack state -- ss }
       state state-sss stack stack-number @ th @ ;
   
   : stack-reg { n stack state -- reg }
       \ n is the index (TOS=0); reg is 0 if the access is to memory
       stack state state-ss ss-registers 2@ n u> if ( addr ) \ in ss-registers?
           n th @
       else
           drop 0
       endif ;
   
   : .reg ( reg -- )
       register-name 2@ type ;
   
   : stack-offset ( stack state -- n )
       \ offset for stack in state
       state-ss ss-offset @ ;
   
   : normal-stack-access1 { n stack state -- }
       n stack state stack-reg ?dup-if
           .reg exit
       endif
       stack stack-pointer 2@ type
       n stack state stack-offset - stack normal-stack-access0 ;
   
   : normal-stack-access ( n stack state -- )
       over inst-stream-f = if
           ." IMM_ARG(" normal-stack-access1 ." ," immarg ? ." )"
           1 immarg +!
       else
           normal-stack-access1
       endif ;
   
   : stack-depth { stack -- n }
       current-depth stack stack-number @ th @ ;
   
   : part-stack-access { n stack -- }
       \ print _<stack><x>, x=inst-stream? n : maxdepth-currentdepth-n-1
       ." _" stack stack-pointer 2@ type
       stack stack-number @ { stack# }
       stack stack-depth n + { access-depth }
       stack inst-stream-f = if
           access-depth
       else
           combined prim-stacks-in stack# th @
           assert( dup max-depth stack# th @ = )
           access-depth - 1-
       endif
       0 .r ;
   
   : part-stack-read { n stack -- }
       stack stack-depth n + ( ndepth )
       stack stack-number @ part-num @ s-c-max-depth @
   \    max-depth stack stack-number @ th @ ( ndepth nmaxdepth )
       over <= if ( ndepth ) \ load from memory
           stack state-in normal-stack-access
       else
           drop n stack part-stack-access
       endif ;
   
   : stack-diff ( stack -- n )
       \ in-out
       dup stack-in @ swap stack-out @ - ;
   
   : part-stack-write { n stack -- }
       stack stack-depth n +
       stack stack-number @ part-num @ s-c-max-back-depth @
       over <= if ( ndepth )
           stack combined ['] stack-diff prim-context -
           stack state-out normal-stack-access
       else
           drop n stack part-stack-access
       endif ;
   
   : stack-read ( n stack -- )
       \ print a stack access at index n of stack
       in-part @ if
           part-stack-read
       else
           state-in normal-stack-access
       endif ;
   
 : stack-access ( n stack -- )  : stack-write ( n stack -- )
     \ print a stack access at index n of stack      \ print a stack access at index n of stack
     stack-pointer 2@ type      in-part @ if
     dup          part-stack-write
     if  
         ." [" 0 .r ." ]"  
     else      else
         drop ." TOS"          state-out normal-stack-access
     endif ;      endif ;
   
 : item-in-index { item -- n }  : item-in-index { item -- n }
Line 204  variable items Line 477  variable items
     item item-stack @ dup >r stack-in @ ( in-size r:stack )      item item-stack @ dup >r stack-in @ ( in-size r:stack )
     item r> stack-in-index-xt @ execute ;      item r> stack-in-index-xt @ execute ;
   
   : item-stack-type-name ( item -- addr u )
       item-stack @ stack-type @ type-c-name 2@ ;
   
 : fetch-single ( item -- )  : fetch-single ( item -- )
  \ fetch a single stack item from its stack      \ fetch a single stack item from its stack
  >r      >r
  r@ item-name 2@ type      ." vm_" r@ item-stack-type-name type
  ."  = ("       ." 2" r@ item-type @ print-type-prefix ." ("
  r@ item-type @ type-c-name 2@ type ." ) "      r@ item-in-index r@ item-stack @ stack-read ." ,"
  r@ item-in-index r@ item-stack @ stack-access      r@ item-name 2@ type
  ." ;" cr      ." );" cr
  rdrop ;       rdrop ; 
   
 : fetch-double ( item -- )  : fetch-double ( item -- )
  \ fetch a double stack item from its stack      \ fetch a double stack item from its stack
  >r      >r
  ." FETCH_DCELL("      ." vm_two"
  r@ item-name 2@ type ." , "      r@ item-stack-type-name type ." 2"
  r@ item-in-index r@ item-stack @ 2dup ." (Cell)" stack-access      r@ item-type @ print-type-prefix ." ("
  ." , "                      -1 under+ ." (Cell)" stack-access      r@ item-in-index r@ item-stack @ 2dup ." (Cell)" stack-read
  ." );" cr      ." , "                      -1 under+ ." (Cell)" stack-read
  rdrop ;      ." , " r@ item-name 2@ type
       ." )" cr
       rdrop ;
   
 : same-as-in? ( item -- f )  : same-as-in? ( item -- f )
  \ f is true iff the offset and stack of item is the same as on input   \ f is true iff the offset and stack of item is the same as on input
  >r   >r
  r@ item-name 2@ items @ search-wordlist 0=   r@ item-first @ if
  abort" bug"       rdrop false exit
    endif
    r@ item-name 2@ prim prim-items-wordlist @ search-wordlist 0= abort" bug"
  execute @   execute @
  dup r@ =   dup r@ =
  if \ item first appeared in output   if \ item first appeared in output
Line 240  variable items Line 520  variable items
  rdrop ;   rdrop ;
   
 : item-out-index ( item -- n )  : item-out-index ( item -- n )
     \ n is the index of item (in the in-effect)      \ n is the index of item (in the out-effect)
     >r r@ item-stack @ stack-out @ r> item-offset @ - 1- ;      >r r@ item-stack @ stack-out @ r> item-offset @ - 1- ;
   
 : really-store-single ( item -- )  : really-store-single ( item -- )
  >r      >r
  r@ item-out-index r@ item-stack @ stack-access ."  = "      ." vm_"
  r@ item-stack @ stack-cast 2@ type      r@ item-type @ print-type-prefix ." 2"
  r@ item-name 2@ type ." ;"      r@ item-stack-type-name type ." ("
  rdrop ;      r@ item-name 2@ type ." ,"
       r@ item-out-index r@ item-stack @ stack-write ." );"
       rdrop ;
   
 : store-single ( item -- )  : store-single { item -- }
  >r      item item-stack @ { stack }
  r@ same-as-in?      store-optimization @ in-part @ 0= and item same-as-in? and
  if      item item-in-index  stack state-in  stack-reg 0= and \  in in memory?
    r@ item-in-index 0= r@ item-out-index 0= xor      item item-out-index stack state-out stack-reg 0= and \ out in memory?
    if      0= if
        ." IF_" r@ item-stack @ stack-pointer 2@ type          item really-store-single cr
        ." TOS(" r@ really-store-single ." );" cr      endif ;
    endif  
  else  
    r@ really-store-single cr  
  endif  
  rdrop ;  
   
 : store-double ( item -- )  : store-double ( item -- )
 \ !! store optimization is not performed, because it is not yet needed  \ !! store optimization is not performed, because it is not yet needed
  >r   >r
  ." STORE_DCELL(" r@ item-name 2@ type ." , "   ." vm_"
  r@ item-out-index r@ item-stack @ 2dup stack-access   r@ item-type @ print-type-prefix ." 2two"
  ." , "                       -1 under+ stack-access   r@ item-stack-type-name type ." ("
  ." );" cr   r@ item-name 2@ type ." , "
    r@ item-out-index r@ item-stack @ 2dup stack-write
    ." , "                       -1 under+ stack-write
    ." )" cr
  rdrop ;   rdrop ;
   
 : single ( -- xt1 xt2 n )  : single ( -- xt1 xt2 n )
Line 308  wordlist constant prefixes Line 588  wordlist constant prefixes
     stack r@ type-stack !      stack r@ type-stack !
     rdrop ;      rdrop ;
   
 : type-prefix ( xt1 xt2 n stack "prefix" -- )  : type-prefix ( addr u xt1 xt2 n stack "prefix" -- )
     create-type      get-current >r prefixes set-current
       create-type r> set-current
 does> ( item -- )  does> ( item -- )
     \ initialize item      \ initialize item
     { item typ }      { item typ }
     typ item item-type !      typ item item-type !
     typ type-stack @ item item-stack !default      typ type-stack @ item item-stack !default
     item item-name 2@ items @ search-wordlist 0= if \ new name      item item-name 2@ prim prim-items-wordlist @ search-wordlist 0= if
         item item-name 2@ nextname item declare          item item-name 2@ nextname item declare
         item item-first on          item item-first on
         \ typ type-c-name 2@ type space type  ." ;" cr          \ typ type-c-name 2@ type space type  ." ;" cr
Line 335  does> ( item -- ) Line 616  does> ( item -- )
         endif          endif
         -1 s+loop          -1 s+loop
     \ we did not find a type, abort      \ we did not find a type, abort
     true abort" unknown prefix" ;      false s" unknown prefix" ?print-error ;
   
 : declaration ( item -- )  : declaration ( item -- )
     dup item-name 2@ execute-prefix ;      dup item-name 2@ execute-prefix ;
Line 344  does> ( item -- ) Line 625  does> ( item -- )
     ['] declaration map-items ;      ['] declaration map-items ;
   
 : declarations ( -- )  : declarations ( -- )
  wordlist dup items ! set-current   wordlist dup prim prim-items-wordlist ! set-current
  prim prim-effect-in prim prim-effect-in-end @ declaration-list   prim prim-effect-in prim prim-effect-in-end @ declaration-list
  prim prim-effect-out prim prim-effect-out-end @ declaration-list ;   prim prim-effect-out prim prim-effect-out-end @ declaration-list ;
   
Line 359  does> ( item -- ) Line 640  does> ( item -- )
     prim prim-effect-out prim prim-effect-out-end @ ['] print-declaration map-items ;      prim prim-effect-out prim prim-effect-out-end @ ['] print-declaration map-items ;
           
 : stack-prefix ( stack "prefix" -- )  : stack-prefix ( stack "prefix" -- )
       get-current >r prefixes set-current
     name tuck nextname create ( stack length ) 2,      name tuck nextname create ( stack length ) 2,
       r> set-current
 does> ( item -- )  does> ( item -- )
     2@ { item stack prefix-length }      2@ { item stack prefix-length }
     item item-name 2@ prefix-length /string item item-name 2!      item item-name 2@ prefix-length /string item item-name 2!
     stack item item-stack !      stack item item-stack !
     item declaration ;      item declaration ;
   
   \ types pointed to by stacks for use in combined prims
   \ !! output-c-combined shouldn't use these names!
   : stack-type-name ( addr u "name" -- )
       single 0 create-type ;
   
   wordlist constant type-names \ this is here just to meet the requirement
                       \ that a type be a word; it is never used for lookup
   
   : define-type ( addr u -- xt )
       \ define single type with name addr u, without stack
       get-current type-names set-current >r
       2dup nextname stack-type-name
       r> set-current
       latestxt ;
   
   : stack ( "name" "stack-pointer" "type" -- )
       \ define stack
       name { d: stack-name }
       name { d: stack-pointer }
       name { d: stack-type }
       stack-type define-type
       stack-pointer rot >body stack-name nextname make-stack ;
   
   stack inst-stream IP Cell
   ' inst-in-index inst-stream stack-in-index-xt !
   ' inst-stream <is> inst-stream-f
   \ !! initialize stack-in and stack-out
   
   \ registers
   
   : make-register ( type addr u -- )
       \ define register with type TYPE and name ADDR U.
       nregisters @ max-registers < s" too many registers" ?print-error
       2dup nextname create register% %allot >r
       r@ register-name 2!
       r@ register-type !
       nregisters @ r@ register-number !
       1 nregisters +!
       rdrop ;
   
   : register ( "name" "type" -- )
       \ define register
       name { d: reg-name }
       name { d: reg-type }
       reg-type define-type >body
       reg-name make-register ;
   
   \ stack-states
   
   : stack-state ( a-addr u uoffset "name" -- )
       create ss% %allot >r
       r@ ss-offset !
       r@ ss-registers 2!
       rdrop ;
   
   0 0 0 stack-state default-ss
   
   \ state
   
   : state ( "name" -- )
       \ create a state initialized with default-sss
       create state% %allot { s }
       next-state-number @ s state-number ! 1 next-state-number +!
       max-stacks 0 ?do
           default-ss s state-sss i th !
       loop ;
   
   : set-ss ( ss stack state -- )
       state-sss swap stack-number @ th ! ;
   
 \ offset computation  \ offset computation
 \ the leftmost (i.e. deepest) item has offset 0  \ the leftmost (i.e. deepest) item has offset 0
 \ the rightmost item has the highest offset  \ the rightmost item has the highest offset
Line 382  does> ( item -- ) Line 735  does> ( item -- )
 : compute-offset-out ( addr1 addr2 -- )  : compute-offset-out ( addr1 addr2 -- )
     ['] stack-out compute-offset ;      ['] stack-out compute-offset ;
   
 : clear-stack { -- }  
     dup stack-in off stack-out off ;  
   
 : compute-offsets ( -- )  : compute-offsets ( -- )
     data-stack clear-stack  fp-stack clear-stack return-stack clear-stack      prim prim-stacks-in  max-stacks cells erase
     inst-stream clear-stack      prim prim-stacks-out max-stacks cells erase
     prim prim-effect-in  prim prim-effect-in-end  @ ['] compute-offset-in  map-items      prim prim-effect-in  prim prim-effect-in-end  @ ['] compute-offset-in  map-items
     prim prim-effect-out prim prim-effect-out-end @ ['] compute-offset-out map-items      prim prim-effect-out prim prim-effect-out-end @ ['] compute-offset-out map-items
     inst-stream stack-out @ 0<> abort" # can only be on the input side" ;      inst-stream stack-out @ 0= s" # can only be on the input side" ?print-error ;
   
 : flush-a-tos { stack -- }  : process-simple ( -- )
     stack stack-out @ 0<> stack stack-in @ 0= and      prim prim { W^ key } key cell
     if      combinations ['] constant insert-wordlist
         ." IF_" stack stack-pointer 2@ 2dup type ." TOS("      declarations compute-offsets
         2dup type ." [0] = " type ." TOS);" cr      output @ execute ;
     endif ;  
   : stack-state-items ( stack state -- n )
 : flush-tos ( -- )      state-ss ss-registers 2@ nip ;
     data-stack   flush-a-tos  
     fp-stack     flush-a-tos  : unused-stack-items { stack -- n-in n-out }
     return-stack flush-a-tos ;      \ n-in  are the stack items in state-in  not used    by prim
       \ n-out are the stack items in state-out not written by prim
 : fill-a-tos { stack -- }      stack state-in  stack-state-items stack stack-in  @ - 0 max
     stack stack-out @ 0= stack stack-in @ 0<> and      stack state-out stack-state-items stack stack-out @ - 0 max ;
     if  
         ." IF_" stack stack-pointer 2@ 2dup type ." TOS("  : spill-stack { stack -- }
         2dup type ." TOS = " type ." [0]);" cr      \ spill regs of state-in that are not used by prim and are not in state-out
     endif ;      stack state-in stack-offset { offset }
       stack state-in stack-state-items ( items )
       dup stack unused-stack-items - - +do
           \ loop through the bottom items
           stack stack-pointer 2@ type
           i offset - stack normal-stack-access0 ."  = "
           i stack state-in normal-stack-access1 ." ;" cr
       loop ;
   
   : spill-state ( -- )
       ['] spill-stack map-stacks1 ;
   
   : fill-stack { stack -- }
       stack state-out stack-offset { offset }
       stack state-out stack-state-items ( items )
       dup stack unused-stack-items - + +do
           \ loop through the bottom items
           i stack state-out normal-stack-access1 ."  = "
           stack stack-pointer 2@ type
           i offset - stack normal-stack-access0 ." ;" cr
       loop ;
   
 : fill-tos ( -- )  : fill-state ( -- )
     \ !! inst-stream for prefetching?      \ !! inst-stream for prefetching?
     fp-stack     fill-a-tos      ['] fill-stack map-stacks1 ;
     data-stack   fill-a-tos  
     return-stack fill-a-tos ;  
   
 : fetch ( addr -- )  : fetch ( addr -- )
  dup item-type @ type-fetch @ execute ;      dup item-type @ type-fetch @ execute ;
   
 : fetches ( -- )  : fetches ( -- )
     prim prim-effect-in prim prim-effect-in-end @ ['] fetch map-items ;      prim prim-effect-in prim prim-effect-in-end @ ['] fetch map-items ;
   
 : stack-pointer-update { stack -- }  : reg-reg-move ( reg-from reg-to -- )
     \ stack grow downwards      2dup = if
     stack stack-in @ stack stack-out @ -          2drop
     ?dup-if \ this check is not necessary, gcc would do this for us      else
         stack stack-pointer 2@ type ."  += " 0 .r ." ;" cr          .reg ."  = " .reg ." ;" cr
     endif ;      endif ;
   
 : inst-pointer-update ( -- )  : stack-bottom-reg { n stack state -- reg }
     inst-stream stack-in @ ?dup-if      stack state stack-state-items n - 1- stack state stack-reg ;
         ." INC_IP(" 0 .r ." );" cr  
   : stack-moves { stack -- }
       \ generate moves between registers in state-in/state-out that are
       \ not spilled or consumed/produced by prim.
       \ !! this works only for a simple stack cache, not e.g., for
       \ rotating stack caches, or registers shared between stacks (the
       \ latter would also require a change in interface)
       \ !! maybe place this after NEXT_P1?
       stack unused-stack-items 2dup < if ( n-in n-out )
           \ move registers from 0..n_in-1 to n_out-n_in..n_out-1
           over - { diff } ( n-in )
           -1 swap 1- -do
               i stack state-in stack-bottom-reg ( reg-from )
               i diff + stack state-out stack-bottom-reg reg-reg-move
           1 -loop
       else
           \ move registers from n_in-n_out..n_in-1 to 0..n_out-1
           swap over - { diff } ( n-out )
           0 +do
               i diff + stack state-in stack-bottom-reg ( reg-from )
               i stack state-out stack-bottom-reg reg-reg-move
           loop
     endif ;      endif ;
   
   : stack-update-transform ( n1 stack -- n2 )
       \ n2 is the number by which the stack pointer should be
       \ incremented to pop n1 items
       stack-access-transform @ dup >r execute
       0 r> execute - ;
   
   : stack-pointer-update { stack -- }
       \ and moves
       \ stacks grow downwards
       stack stack-diff ( in-out )
       stack state-in  stack-offset -
       stack state-out stack-offset + ( [in-in_offset]-[out-out_offset] )
       ?dup-if \ this check is not necessary, gcc would do this for us
           stack inst-stream = if
               ." INC_IP(" 0 .r ." );" cr
           else
               stack stack-pointer 2@ type ."  += "
               stack stack-update-transform 0 .r ." ;" cr
           endif
       endif
       stack stack-moves ;
   
 : stack-pointer-updates ( -- )  : stack-pointer-updates ( -- )
     inst-pointer-update      ['] stack-pointer-update map-stacks ;
     data-stack   stack-pointer-update  
     fp-stack     stack-pointer-update  
     return-stack stack-pointer-update ;  
   
 : store ( item -- )  : store ( item -- )
 \ f is true if the item should be stored  \ f is true if the item should be stored
Line 449  does> ( item -- ) Line 857  does> ( item -- )
 : stores ( -- )  : stores ( -- )
     prim prim-effect-out prim prim-effect-out-end @ ['] store map-items ;      prim prim-effect-out prim prim-effect-out-end @ ['] store map-items ;
   
 : output-c-tail ( -- )  
     \ the final part of the generated C code  
     ." NEXT_P1;" cr  
     stores  
     fill-tos  
     ." NEXT_P2;" cr ;  
   
 : type-c ( c-addr u -- )  
     \ like TYPE, but replaces "TAIL;" with tail code  
     begin ( c-addr1 u1 )  
         2dup s" TAIL;" search  
     while ( c-addr1 u1 c-addr3 u3 )  
         2dup 2>r drop nip over - type  
         output-c-tail  
         2r> 5 /string  
         \ !! resync #line missing  
     repeat  
     2drop type ;  
   
 : print-type-prefix ( type -- )  
     body> >head .name ;  
   
 : print-debug-arg { item -- }  : print-debug-arg { item -- }
     ." fputs(" quote space item item-name 2@ type ." =" quote ." , vm_out); "      ." fputs(" quote space item item-name 2@ type ." =" quote ." , vm_out); "
     ." printarg_" item item-type @ print-type-prefix      ." printarg_" item item-type @ print-type-prefix
Line 480  does> ( item -- ) Line 866  does> ( item -- )
     ." #ifdef VM_DEBUG" cr      ." #ifdef VM_DEBUG" cr
     ." if (vm_debug) {" cr      ." if (vm_debug) {" cr
     prim prim-effect-in prim prim-effect-in-end @ ['] print-debug-arg map-items      prim prim-effect-in prim prim-effect-in-end @ ['] print-debug-arg map-items
   \    ." fputc('\n', vm_out);" cr
       ." }" cr
       ." #endif" cr ;
   
   : print-debug-result { item -- }
       item item-first @ if
           item print-debug-arg
       endif ;
   
   : print-debug-results ( -- )
       cr
       ." #ifdef VM_DEBUG" cr
       ." if (vm_debug) {" cr
       ." fputs(" quote ."  -- " quote ." , vm_out); "
       prim prim-effect-out prim prim-effect-out-end @ ['] print-debug-result map-items
     ." fputc('\n', vm_out);" cr      ." fputc('\n', vm_out);" cr
     ." }" cr      ." }" cr
     ." #endif" cr ;      ." #endif" cr ;
   
   : output-super-end ( -- )
       prim prim-c-code 2@ s" SET_IP" search if
           ." SUPER_END;" cr
       endif
       2drop ;
   
   
   defer output-nextp0
   :noname ( -- )
       ." NEXT_P0;" cr ;
   is output-nextp0
   
   defer output-nextp1
   :noname ( -- )
       ." NEXT_P1;" cr ;
   is output-nextp1
   
   : output-nextp2 ( -- )
       ." NEXT_P2;" cr ;
   
   variable tail-nextp2 \ xt to execute for printing NEXT_P2 in INST_TAIL
   ' output-nextp2 tail-nextp2 !
   
   : output-label2 ( -- )
       ." LABEL2(" prim prim-c-name 2@ type ." )" cr
       ." NEXT_P2;" cr ;
   
   : output-c-tail1 { xt -- }
       \ the final part of the generated C code, with xt printing LABEL2 or not.
       output-super-end
       print-debug-results
       output-nextp1
       stores
       fill-state 
       xt execute ;
   
   : output-c-tail1-no-stores { xt -- }
       \ the final part of the generated C code for combinations
       output-super-end
       output-nextp1
       fill-state 
       xt execute ;
   
   : output-c-tail ( -- )
       tail-nextp2 @ output-c-tail1 ;
   
   : output-c-tail2 ( -- )
       ['] output-label2 output-c-tail1 ;
   
   : output-c-tail-no-stores ( -- )
       tail-nextp2 @ output-c-tail1-no-stores ;
   
   : output-c-tail2-no-stores ( -- )
       ['] output-label2 output-c-tail1-no-stores ;
   
   : type-c-code ( c-addr u xt -- )
       \ like TYPE, but replaces "INST_TAIL;" with tail code produced by xt
       { xt }
       ." {" cr
       ." #line " c-line @ . quote c-filename 2@ type quote cr
       begin ( c-addr1 u1 )
           2dup s" INST_TAIL;" search
       while ( c-addr1 u1 c-addr3 u3 )
           2dup 2>r drop nip over - type
           xt execute
           2r> 10 /string
           \ !! resync #line missing
       repeat
       2drop type
       ." #line " out-nls @ 2 + . quote out-filename 2@ type quote cr
       ." }" cr ;
   
   : print-entry ( -- )
       ." LABEL(" prim prim-c-name 2@ type ." )" ;
           
 : output-c ( -- )   : output-c ( -- ) 
  ." I_" prim prim-c-name 2@ type ." :   /* " prim prim-name 2@ type ."  ( " prim prim-stack-string 2@ type ." ) */" cr      print-entry ."  /* " prim prim-name 2@ type ."  ( " prim prim-stack-string 2@ type ." ) */" cr
  ." /* " prim prim-doc 2@ type ."  */" cr      ." /* " prim prim-doc 2@ type ."  */" cr
  ." NAME(" quote prim prim-name 2@ type quote ." )" cr \ debugging      ." NAME(" quote prim prim-name 2@ type quote ." )" cr \ debugging
  ." {" cr      ." {" cr
  ." DEF_CA" cr      ." DEF_CA" cr
  print-declarations      print-declarations
  ." NEXT_P0;" cr      output-nextp0
  flush-tos      spill-state
  fetches      fetches
  print-debug-args      print-debug-args
  stack-pointer-updates      stack-pointer-updates
  ." {" cr      prim prim-c-code 2@ ['] output-c-tail type-c-code
  ." #line " c-line @ . quote c-filename 2@ type quote cr      output-c-tail2
  prim prim-c-code 2@ type-c      ." }" cr
  ." }" cr      cr
  output-c-tail  
  ." }" cr  
  cr  
 ;  ;
   
 : disasm-arg { item -- }  : disasm-arg { item -- }
     item item-stack @ inst-stream = if      item item-stack @ inst-stream = if
         ."   fputc(' ', vm_out); "          ." {" cr
         ." printarg_" item item-type @ print-type-prefix          item print-declaration
         ." ((" item item-type @ type-c-name 2@ type ." )"          item fetch
         ." ip[" item item-offset @ 1+ 0 .r ." ]);" cr          item print-debug-arg
           ." }" cr
     endif ;      endif ;
   
 : disasm-args ( -- )  : disasm-args ( -- )
Line 518  does> ( item -- ) Line 992  does> ( item -- )
   
 : output-disasm ( -- )  : output-disasm ( -- )
     \ generate code for disassembling VM instructions      \ generate code for disassembling VM instructions
     ." if (ip[0] == prim[" function-number @ 0 .r ." ]) {" cr      ." if (VM_IS_INST(*ip, " function-number @ 0 .r ." )) {" cr
     ."   fputs(" quote prim prim-name 2@ type quote ." , vm_out);" cr      ."   fputs(" quote prim prim-name 2@ type quote ." , vm_out);" cr
     disasm-args      disasm-args
     ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr      ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr
     ." } else " ;      ."   goto _endif_;" cr
       ." }" cr ;
   
   : output-profile ( -- )
       \ generate code for postprocessing the VM block profile stuff
       ." if (VM_IS_INST(*ip, " function-number @ 0 .r ." )) {" cr
       ."   add_inst(b, " quote prim prim-name 2@ type quote ." );" cr
       ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr
       prim prim-c-code 2@  s" SET_IP"    search nip nip
       prim prim-c-code 2@  s" SUPER_END" search nip nip or if
           ."   return;" cr
       else
           ."   goto _endif_;" cr
       endif
       ." }" cr ;
   
   : output-profile-part ( p )
       ."   add_inst(b, " quote
       prim-name 2@ type
       quote ." );" cr ;
       
   : output-profile-combined ( -- )
       \ generate code for postprocessing the VM block profile stuff
       ." if (VM_IS_INST(*ip, " function-number @ 0 .r ." )) {" cr
       ['] output-profile-part map-combined
       ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr
       combined-prims num-combined @ 1- th @ prim-c-code 2@  s" SET_IP"    search nip nip
       combined-prims num-combined @ 1- th @ prim-c-code 2@  s" SUPER_END" search nip nip or if
           ."   return;" cr
       else
           ."   goto _endif_;" cr
       endif
       ." }" cr ;
   
   : prim-branch? { prim -- f }
       \ true if prim is a branch or super-end
       prim prim-c-code 2@  s" SET_IP" search nip nip 0<> ;
   
   : output-superend ( -- )
       \ output flag specifying whether the current word ends a dynamic superinst
       prim prim-branch?
       prim prim-c-code 2@  s" SUPER_END" search nip nip 0<> or
       prim prim-c-code 2@  s" SUPER_CONTINUE" search nip nip 0= and
       negate 0 .r ." , /* " prim prim-name 2@ type ."  */" cr ;
   
 : gen-arg-parm { item -- }  : gen-arg-parm { item -- }
     item item-stack @ inst-stream = if      item item-stack @ inst-stream = if
Line 559  does> ( item -- ) Line 1076  does> ( item -- )
 : output-forthname ( -- )  : output-forthname ( -- )
   '" emit prim prim-name 2@ type '" emit ." ," cr ;    '" emit prim prim-name 2@ type '" emit ." ," cr ;
   
 : output-c-func ( -- )  \  : output-c-func ( -- )
 \ used for word libraries  \  \ used for word libraries
     ." Cell * I_" prim prim-c-name 2@ type ." (Cell *SP, Cell **FP)      /* " prim prim-name 2@ type  \      ." Cell * I_" prim prim-c-name 2@ type ." (Cell *SP, Cell **FP)      /* " prim prim-name 2@ type
     ."  ( " prim prim-stack-string 2@ type ."  ) */" cr  \      ."  ( " prim prim-stack-string 2@ type ."  ) */" cr
     ." /* " prim prim-doc 2@ type ."  */" cr  \      ." /* " prim prim-doc 2@ type ."  */" cr
     ." NAME(" quote prim prim-name 2@ type quote ." )" cr  \      ." NAME(" quote prim prim-name 2@ type quote ." )" cr
     \ debugging  \      \ debugging
     ." {" cr  \      ." {" cr
     print-declarations  \      print-declarations
     inst-stream  stack-used? IF ." Cell *ip=IP;" cr THEN  \      \ !! don't know what to do about that
     data-stack   stack-used? IF ." Cell *sp=SP;" cr THEN  \      inst-stream  stack-used? IF ." Cell *ip=IP;" cr THEN
     fp-stack     stack-used? IF ." Cell *fp=*FP;" cr THEN  \      data-stack   stack-used? IF ." Cell *sp=SP;" cr THEN
     return-stack stack-used? IF ." Cell *rp=*RP;" cr THEN  \      fp-stack     stack-used? IF ." Cell *fp=*FP;" cr THEN
     flush-tos  \      return-stack stack-used? IF ." Cell *rp=*RP;" cr THEN
     fetches  \      spill-state
     stack-pointer-updates  \      fetches
     fp-stack   stack-used? IF ." *FP=fp;" cr THEN  \      stack-pointer-updates
     ." {" cr  \      fp-stack   stack-used? IF ." *FP=fp;" cr THEN
     ." #line " c-line @ . quote c-filename 2@ type quote cr  \      ." {" cr
     prim prim-c-code 2@ type  \      ." #line " c-line @ . quote c-filename 2@ type quote cr
     ." }" cr  \      prim prim-c-code 2@ type
     stores  \      ." }" cr
     fill-tos  \      stores
     ." return (sp);" cr  \      fill-state
     ." }" cr  \      ." return (sp);" cr
     cr ;  \      ." }" cr
   \      cr ;
   
 : output-label ( -- )    : output-label ( -- )  
     ." (Label)&&I_" prim prim-c-name 2@ type ." ," cr ;      ." INST_ADDR(" prim prim-c-name 2@ type ." )," cr ;
   
 : output-alias ( -- )   : output-alias ( -- ) 
     ( primitive-number @ . ." alias " ) ." Primitive " prim prim-name 2@ type cr ;      ( primitive-number @ . ." alias " ) ." Primitive " prim prim-name 2@ type cr ;
   
   : output-c-prim-num ( -- )
       ." N_" prim prim-c-name 2@ type ." ," cr ;
   
 : output-forth ( -- )    : output-forth ( -- )  
     prim prim-forth-code @ 0=      prim prim-forth-code @ 0=
     IF          \ output-alias      IF          \ output-alias
Line 619  does> ( item -- ) Line 1140  does> ( item -- )
     name-line @ 0 .r      name-line @ 0 .r
     ." ,0" cr ;      ." ,0" cr ;
   
   : output-vi-tag ( -- )
       name-filename 2@ type #tab emit
       prim prim-name 2@ type #tab emit
       ." /^" prim prim-name 2@ type ."  *(/" cr ;
   
 [IFDEF] documentation  [IFDEF] documentation
 : register-doc ( -- )  : register-doc ( -- )
     get-current documentation set-current      prim prim-name 2@ documentation ['] create insert-wordlist
     prim prim-name 2@ nextname create  
     prim prim-name 2@ 2,      prim prim-name 2@ 2,
     prim prim-stack-string 2@ condition-stack-effect 2,      prim prim-stack-string 2@ condition-stack-effect 2,
     prim prim-wordset 2@ 2,      prim prim-wordset 2@ 2,
     prim prim-c-name 2@ condition-pronounciation 2,      prim prim-c-name 2@ condition-pronounciation 2,
     prim prim-doc 2@ 2,      prim prim-doc 2@ 2, ;
     set-current ;  
 [THEN]  [THEN]
   
   
Line 690  does> ( item -- ) Line 1214  does> ( item -- )
 \  #line 516 "./prim"  \  #line 516 "./prim"
 \  n = n1+n2;  \  n = n1+n2;
 \  }  \  }
 \  NEXT_P1;  
 \  _x_sp0 = (Cell)n;  \  _x_sp0 = (Cell)n;
 \  NEXT_P2;  
 \  }  \  }
 \  NEXT_P1;  \  NEXT_P1;
 \  spTOS = (Cell)_x_sp0;  \  spTOS = (Cell)_x_sp0;
 \  NEXT_P2;  \  NEXT_P2;
   
   : init-combined ( -- )
       prim to combined
       0 num-combined !
       current-depth max-stacks cells erase
       include-skipped-insts @ current-depth 0 th !
       max-depth     max-stacks cells erase
       min-depth     max-stacks cells erase
       prim prim-effect-in  prim prim-effect-in-end  !
       prim prim-effect-out prim prim-effect-out-end ! ;
   
   : max! ( n addr -- )
       tuck @ max swap ! ;
   
   : min! ( n addr -- )
       tuck @ min swap ! ;
   
   : inst-stream-adjustment ( nstack -- n )
       \ number of stack items to add for each part
       0= include-skipped-insts @ and negate ;
   
   : add-depths { p -- }
       \ combine stack effect of p with *-depths
       max-stacks 0 ?do
           current-depth i th @
           p prim-stacks-in  i th @ + i inst-stream-adjustment +
           dup max-depth i th max!
           p prim-stacks-out i th @ -
           dup min-depth i th min!
           current-depth i th !
       loop ;
   
   : copy-maxdepths ( n -- )
       max-depth max-depths rot max-stacks * th max-stacks cells move ;
   
   : add-prim ( addr u -- )
       \ add primitive given by "addr u" to combined-prims
       primitives search-wordlist s" unknown primitive" ?print-error
       execute { p }
       p combined-prims num-combined @ th !
       num-combined @ copy-maxdepths
       1 num-combined +!
       p add-depths
       num-combined @ copy-maxdepths ;
   
   : compute-effects { q -- }
       \ compute the stack effects of q from the depths
       max-stacks 0 ?do
           max-depth i th @ dup
           q prim-stacks-in i th !
           current-depth i th @ -
           q prim-stacks-out i th !
       loop ;
   
   : make-effect-items { stack# items effect-endp -- }
       \ effect-endp points to a pointer to the end of the current item-array
       \ and has to be updated
       stacks stack# th @ { stack }
       items 0 +do
           effect-endp @ { item }
           i 0 <# #s stack stack-pointer 2@ holds [char] _ hold #> save-mem
           item item-name 2!
           stack item item-stack !
           stack stack-type @ item item-type !
           i item item-offset !
           item item-first on
           item% %size effect-endp +!
       loop ;
   
   : init-effects { q -- }
       \ initialize effects field for FETCHES and STORES
       max-stacks 0 ?do
           i q prim-stacks-in  i th @ q prim-effect-in-end  make-effect-items
           i q prim-stacks-out i th @ q prim-effect-out-end make-effect-items
       loop ;
   
   : compute-stack-max-back-depths ( stack -- )
       stack-number @ { stack# }
       current-depth stack# th @ dup
       dup stack# num-combined @ s-c-max-back-depth !
       -1 num-combined @ 1- -do ( max-depth current-depth )
           combined-prims i th @ { p }
           p prim-stacks-out stack# th @ +
           dup >r max r>
           over stack# i s-c-max-back-depth !
           p prim-stacks-in stack# th @ -
           stack# inst-stream-adjustment -
       1 -loop
       assert( dup stack# inst-stream-adjustment negate = )
       assert( over max-depth stack# th @ = )
       2drop ;
   
   : compute-max-back-depths ( -- )
       \ compute max-back-depths.
       \ assumes that current-depths is correct for the end of the combination
       ['] compute-stack-max-back-depths map-stacks ;
   
   : process-combined ( -- )
       combined combined-prims num-combined @ cells
       combinations ['] constant insert-wordlist
       combined-prims num-combined @ 1- th ( last-part )
       @ prim-c-code 2@ prim prim-c-code 2! \ used by output-super-end
       prim compute-effects
       prim init-effects
       compute-max-back-depths
       output-combined perform ;
   
   \ reprocessing (typically to generate versions for another cache states)
   \ !! use prim-context
   
   variable reprocessed-num 0 reprocessed-num !
   
   : new-name ( -- c-addr u )
       reprocessed-num @ 0
       1 reprocessed-num +!
       <# #s 'p hold '_ hold #> save-mem ;
   
   : reprocess-simple ( prim -- )
       to prim
       new-name prim prim-c-name 2!
       output @ execute ;
   
   : lookup-prim ( c-addr u -- prim )
       primitives search-wordlist 0= -13 and throw execute ;
   
   : state-prim1 { in-state out-state prim -- }
       in-state out-state state-default dup d= ?EXIT
       in-state  to state-in
       out-state to state-out
       prim reprocess-simple ;
   
   : state-prim ( in-state out-state "name" -- )
       parse-word lookup-prim state-prim1 ;
   
   \ reprocessing with default states
   
   \ This is a simple scheme and should be generalized
   \ assumes we only cache one stack and use simple states for that
   
   0 value cache-stack  \ stack that we cache
   2variable cache-states \ states of the cache, starting with the empty state
   
   : compute-default-state-out ( n-in -- n-out )
       \ for the current prim
       cache-stack stack-in @ - 0 max
       cache-stack stack-out @ + cache-states 2@ nip 1- min ;
   
   : gen-prim-states ( prim -- )
       to prim
       cache-states 2@ swap { states } ( nstates )
       cache-stack stack-in @ +do
           states i th @
           states i compute-default-state-out th @
           prim state-prim1
       loop ;
   
   : prim-states ( "name" -- )
       parse-word lookup-prim gen-prim-states ;
   
   : gen-branch-states ( prim -- )
       \ generate versions that produce state-default; useful for branches
       to prim
       cache-states 2@ swap { states } ( nstates )
       cache-stack stack-in @ +do
           states i th @ state-default prim state-prim1
       loop ;
   
   : branch-states ( out-state "name" -- )
       parse-word lookup-prim gen-branch-states ;
   
   \ producing state transitions
   
   : gen-transitions ( "name" -- )
       parse-word lookup-prim { prim }
       cache-states 2@ { states nstates }
       nstates 0 +do
           nstates 0 +do
               i j <> if
                   states i th @ states j th @ prim state-prim1
               endif
           loop
       loop ;
   
   \ C output
   
   : print-item { n stack -- }
       \ print nth stack item name
       stack stack-type @ type-c-name 2@ type space
       ." MAYBE_UNUSED _" stack stack-pointer 2@ type n 0 .r ;
   
   : print-declarations-combined ( -- )
       max-stacks 0 ?do
           max-depth i th @ min-depth i th @ - 0 +do
               i stacks j th @ print-item ." ;" cr
           loop
       loop ;
   
   : part-fetches ( -- )
       fetches ;
   
   : part-output-c-tail ( -- )
       print-debug-results
       stores ;
   
   : output-combined-tail ( -- )
       part-output-c-tail
       in-part @ >r in-part off
       combined ['] output-c-tail-no-stores prim-context
       r> in-part ! ;
   
   : part-stack-pointer-updates ( -- )
       next-stack-number @ 0 +do
           i part-num @ 1+ s-c-max-depth @ dup
           i num-combined @ s-c-max-depth @ =    \ final depth
           swap i part-num @ s-c-max-depth @ <> \ just reached now
           part-num @ 0= \ first part
           or and if
               stacks i th @ stack-pointer-update
           endif
       loop ;
   
   : output-part ( p -- )
       to prim
       ." /* " prim prim-name 2@ type ."  ( " prim prim-stack-string 2@ type ." ) */" cr
       ." NAME(" quote prim prim-name 2@ type quote ." )" cr \ debugging
       ." {" cr
       print-declarations
       part-fetches
       print-debug-args
       combined ['] part-stack-pointer-updates prim-context
       1 part-num +!
       prim add-depths \ !! right place?
       prim prim-c-code 2@ ['] output-combined-tail type-c-code
       part-output-c-tail
       ." }" cr ;
   
   : output-parts ( -- )
       prim >r in-part on
       current-depth max-stacks cells erase
       0 part-num !
       ['] output-part map-combined
       in-part off
       r> to prim ;
   
   : output-c-combined ( -- )
       print-entry cr
       \ debugging messages just in parts
       ." {" cr
       ." DEF_CA" cr
       print-declarations-combined
       output-nextp0
       spill-state
       \ fetches \ now in parts
       \ print-debug-args
       \ stack-pointer-updates now in parts
       output-parts
       output-c-tail2-no-stores
       ." }" cr
       cr ;
   
   : output-forth-combined ( -- )
   ;
   
   
   \ peephole optimization rules
   
   \ data for a simple peephole optimizer that always tries to combine
   \ the currently compiled instruction with the last one.
   
   \ in order for this to work as intended, shorter combinations for each
   \ length must be present, and the longer combinations must follow
   \ shorter ones (this restriction may go away in the future).
     
   : output-peephole ( -- )
       combined-prims num-combined @ 1- cells combinations search-wordlist
       s" the prefix for this superinstruction must be defined earlier" ?print-error
       ." {"
       execute prim-num @ 5 .r ." ,"
       combined-prims num-combined @ 1- th @ prim-num @ 5 .r ." ,"
       combined prim-num @ 5 .r ." }, /* "
       combined prim-c-name 2@ type ."  */"
       cr ;
   
   
   \ cost and superinstruction data for a sophisticated combiner (e.g.,
   \ shortest path)
   
   \ This is intended as initializer for a structure like this
   
   \  struct cost {
   \    char loads;       /* number of stack loads */
   \    char stores;      /* number of stack stores */
   \    char updates;     /* number of stack pointer updates */
   \    char branch;      /* is it a branch (SET_IP) */
   \    char state_in;    /* state on entry */
   \    char state_out;   /* state on exit */
   \    short offset;     /* offset into super2 table */
   \    char length;      /* number of components */
   \  };
   
   \ How do you know which primitive or combined instruction this
   \ structure refers to?  By the order of cost structures, as in most
   \ other cases.
   
   : super2-length ( -- n )
       combined if
           num-combined @
       else
           1
       endif ;
   
   : compute-costs { p -- nloads nstores nupdates }
       \ compute the number of loads, stores, and stack pointer updates
       \ of a primitive or combined instruction; does not take TOS
       \ caching into account
       0 max-stacks 0 +do
           p prim-stacks-in i th @ +
       loop
       super2-length 1- - \ don't count instruction fetches of subsumed insts
       0 max-stacks 0 +do
           p prim-stacks-out i th @ +
       loop
       0 max-stacks 1 +do \ don't count ip updates, therefore "1 +do"
           p prim-stacks-in i th @ p prim-stacks-out i th @ <> -
       loop ;
   
   : output-num-part ( p -- )
       ." N_" prim-c-name-orig 2@ type ." ," ;
       \ prim-num @ 4 .r ." ," ;
   
   : output-name-comment ( -- )
       ."  /* " prim prim-name 2@ type ."  */" ;
   
   variable offset-super2  0 offset-super2 ! \ offset into the super2 table
   
   : output-costs-prefix ( -- )
       ." {" prim compute-costs
       rot 2 .r ." ," swap 2 .r ." ," 2 .r ." , "
       prim prim-branch? negate . ." ,"
       state-in  state-number @ 2 .r ." ,"
       state-out state-number @ 2 .r ." ," ;
   
   : output-costs-gforth-simple ( -- )
       output-costs-prefix
       prim output-num-part
       1 2 .r ." },"
       output-name-comment
       cr ;
   
   : output-costs-gforth-combined ( -- )
       output-costs-prefix
       ." N_START_SUPER+" offset-super2 @ 5 .r ." ,"
       super2-length dup 2 .r ." }," offset-super2 +!
       output-name-comment
       cr ;
   
   : output-costs ( -- )
       \ description of superinstructions and simple instructions
       ." {" prim compute-costs
       rot 2 .r ." ," swap 2 .r ." ," 2 .r ." ,"
       offset-super2 @ 5 .r ." ,"
       super2-length dup 2 .r ." }," offset-super2 +!
       output-name-comment
       cr ;
   
   : output-super2-simple ( -- )
       prim prim-c-name 2@ prim prim-c-name-orig 2@ d= if
           prim output-num-part
           output-name-comment
           cr
       endif ;   
     
   : output-super2-combined ( -- )
       ['] output-num-part map-combined 
       output-name-comment
       cr ;   
   
 \ the parser  \ the parser
   
Line 723  print-token ! Line 1620  print-token !
  getinput member? ;   getinput member? ;
 ' testchar? test-vector !  ' testchar? test-vector !
   
 : checksyncline ( -- )  : checksynclines ( -- )
     \ when input points to a newline, check if the next line is a      \ when input points to a newline, check if the next line is a
     \ sync line.  If it is, perform the appropriate actions.      \ sync line.  If it is, perform the appropriate actions.
     rawinput @ >r      rawinput @ begin >r
     s" #line " r@ over compare 0<> if          s" #line " r@ over compare if
         rdrop 1 line +! EXIT              rdrop 1 line +! EXIT
     endif          endif
     0. r> 6 chars + 20 >number drop >r drop line ! r> ( c-addr )          0. r> 6 chars + 20 >number drop >r drop line ! r> ( c-addr )
     dup c@ bl = if          dup c@ bl = if
         char+ dup c@ [char] " <> abort" sync line syntax"              char+ dup c@ [char] " <> 0= s" sync line syntax" ?print-error
         char+ dup 100 [char] " scan drop swap 2dup - save-mem filename 2!              char+ dup 100 [char] " scan drop swap 2dup - save-mem filename 2!
         char+              char+
     endif          endif
     dup c@ nl-char <> abort" sync line syntax"          dup c@ nl-char <> 0= s" sync line syntax" ?print-error
     skipsynclines @ if          skipsynclines @ if
         dup char+ rawinput !              char+ dup rawinput !
         rawinput @ c@ cookedinput @ c!              rawinput @ c@ cookedinput @ c!
     endif          endif
     drop ;      again ;
   
 : print-error-line ( -- )  
     \ print the current line and position  
     line-start @ endrawinput @ over - 2dup nl-char scan drop nip ( start end )  
     over - type cr  
     line-start @ rawinput @ over - typewhite ." ^" cr ;  
       
 : ?nextchar ( f -- )  : ?nextchar ( f -- )
     ?not? if      s" syntax error, wrong char" ?print-error
         outfile-id >r try  
             stderr to outfile-id  
             filename 2@ type ." :" line @ 0 .r ." : syntax error, wrong char:"  
             getinput . cr  
             print-error-line  
             0  
         recover endtry  
         r> to outfile-id throw  
         abort  
     endif  
     rawinput @ endrawinput @ <> if      rawinput @ endrawinput @ <> if
         rawinput @ c@          rawinput @ c@
         1 chars rawinput +!          1 chars rawinput +!
         1 chars cookedinput +!          1 chars cookedinput +!
         nl-char = if          nl-char = if
             checksyncline              checksynclines
             rawinput @ line-start !              rawinput @ line-start !
         endif          endif
         rawinput @ c@ cookedinput @ c!          rawinput @ c@
           cookedinput @ c!
     endif ;      endif ;
   
 : charclass ( set "name" -- )  : charclass ( set "name" -- )
Line 792  bl singleton tab-char over add-member Line 1674  bl singleton tab-char over add-member
 nl-char singleton eof-char over add-member complement   charclass nonl  nl-char singleton eof-char over add-member complement   charclass nonl
 nl-char singleton eof-char over add-member  nl-char singleton eof-char over add-member
     char : over add-member complement                   charclass nocolonnl      char : over add-member complement                   charclass nocolonnl
   nl-char singleton eof-char over add-member
       char } over add-member complement                   charclass nobracenl
 bl 1+ maxchar .. char \ singleton complement intersection  bl 1+ maxchar .. char \ singleton complement intersection
                                                         charclass nowhitebq                                                          charclass nowhitebq
 bl 1+ maxchar ..                                        charclass nowhite  bl 1+ maxchar ..                                        charclass nowhite
 char " singleton eof-char over add-member complement    charclass noquote  char " singleton eof-char over add-member complement    charclass noquote
 nl-char singleton                                       charclass nl  nl-char singleton                                       charclass nl
 eof-char singleton                                      charclass eof  eof-char singleton                                      charclass eof
   nl-char singleton eof-char over add-member              charclass nleof
   
 (( letter (( letter || digit )) **  (( letter (( letter || digit )) **
 )) <- c-ident ( -- )  )) <- c-ident ( -- )
   
 (( ` # ?? (( letter || digit || ` : )) **  (( ` # ?? (( letter || digit || ` : )) ++
 )) <- stack-ident ( -- )  )) <- stack-ident ( -- )
   
 (( nowhitebq nowhite ** ))  (( nowhitebq nowhite ** ))
Line 825  Variable c-flag Line 1709  Variable c-flag
 )) <- c-comment ( -- )  )) <- c-comment ( -- )
   
 (( ` - nonl ** {{   (( ` - nonl ** {{ 
         forth-flag @ IF ." [ELSE]" cr THEN          forth-flag @ IF forth-fdiff ." [ELSE]" cr THEN
         c-flag @ IF ." #else" cr THEN }}          c-flag @ IF
               function-diff
               ." #else /* " function-number @ 0 .r ."  */" cr THEN }}
 )) <- else-comment  )) <- else-comment
   
 (( ` + {{ start }} nonl ** {{ end  (( ` + {{ start }} nonl ** {{ end
         dup          dup
         IF      c-flag @          IF      c-flag @
                 IF    ." #ifdef HAS_" bounds ?DO  I c@ toupper emit  LOOP cr              IF
                   function-diff
                   ." #ifdef HAS_" bounds ?DO  I c@ toupper emit  LOOP cr
                 THEN                  THEN
                 forth-flag @                  forth-flag @
                 IF  ." has? " type ."  [IF]"  cr THEN                  IF  forth-fdiff  ." has? " type ."  [IF]"  cr THEN
         ELSE    2drop          ELSE    2drop
             c-flag @      IF  ." #endif"  cr THEN              c-flag @      IF
             forth-flag @  IF  ." [THEN]"  cr THEN                  function-diff  ." #endif" cr THEN
               forth-flag @  IF  forth-fdiff  ." [THEN]"  cr THEN
         THEN }}          THEN }}
 )) <- if-comment  )) <- if-comment
   
 (( (( eval-comment || forth-comment || c-comment || else-comment || if-comment )) ?? nonl ** )) <- comment-body  (( (( ` g || ` G )) {{ start }} nonl **
      {{ end
         forth-flag @ IF  forth-fdiff  ." group " type cr  THEN
         c-flag @     IF  function-diff
             ." GROUP(" type ." , " function-number @ 0 .r ." )" cr  THEN }}
   )) <- group-comment
   
   (( (( eval-comment || forth-comment || c-comment || else-comment || if-comment || group-comment )) ?? nonl ** )) <- comment-body
   
 (( ` \ comment-body nl )) <- comment ( -- )  (( ` \ comment-body nleof )) <- comment ( -- )
   
 (( {{ start }} stack-ident {{ end 2 pick init-item item% %size + }} white ** )) **  (( {{ start }} stack-ident {{ end 2 pick init-item item% %size + }} white ** )) **
 <- stack-items  <- stack-items
Line 854  Variable c-flag Line 1750  Variable c-flag
    {{ prim prim-effect-out }} stack-items {{ prim prim-effect-out-end ! }}     {{ prim prim-effect-out }} stack-items {{ prim prim-effect-out-end ! }}
 )) <- stack-effect ( -- )  )) <- stack-effect ( -- )
   
 ((  (( {{ prim create-prim }}
    ` ( white ** {{ start }} stack-effect {{ end prim prim-stack-string 2! }} ` ) white **     ` ( white ** {{ start }} stack-effect {{ end prim prim-stack-string 2! }} ` ) white **
    (( {{ start }} forth-ident {{ end prim prim-wordset 2! }} white **     (( {{ start }} forth-ident {{ end prim prim-wordset 2! }} white **
       (( {{ start }}  c-ident {{ end prim prim-c-name 2! }} )) ??        (( {{ start }}  c-ident {{ end 2dup prim-c-name-2! }} )) ??
    )) ??  nl     )) ??  nleof
    (( ` " ` "  {{ start }} (( noquote ++ ` " )) ++ {{ end 1- prim prim-doc 2! }} ` " white ** nl )) ??     (( ` " ` "  {{ start }} (( noquote ++ ` " )) ++ {{ end 1- prim prim-doc 2! }} ` " white ** nleof )) ??
    {{ skipsynclines off line @ c-line ! filename 2@ c-filename 2! start }} (( nocolonnl nonl **  nl white ** )) ** {{ end prim prim-c-code 2! skipsynclines on }}     {{ skipsynclines off line @ c-line ! filename 2@ c-filename 2! start }}
    (( ` :  white ** nl     (( (( ` { nonl ** nleof (( (( nobracenl {{ line @ drop }} nonl ** )) ?? nleof )) ** ` } white ** nleof white ** ))
       {{ start }} (( nonl ++  nl white ** )) ++ {{ end prim prim-forth-code 2! }}     || (( nocolonnl nonl **  nleof white ** )) ** ))
    )) ?? {{  declarations compute-offsets printprim 1 function-number +! }}     {{ end prim prim-c-code 2! skipsynclines on }}
    (( nl || eof ))     (( ` :  white ** nleof
         {{ start }} (( nonl ++  nleof white ** )) ++ {{ end prim prim-forth-code 2! }}
      )) ?? {{ process-simple }}
      nleof
 )) <- simple-primitive ( -- )  )) <- simple-primitive ( -- )
   
 (( ` = (( white ++ forth-ident )) ++ (( nl || eof ))  (( {{ init-combined }}
      ` = white ** (( {{ start }} forth-ident {{ end add-prim }} white ** )) ++
      nleof {{ process-combined }}
 )) <- combined-primitive  )) <- combined-primitive
   
 (( {{ s" " prim prim-doc 2! s" " prim prim-forth-code 2! s" " prim prim-wordset 2!  (( {{ make-prim to prim 0 to combined
       line @ name-line ! filename 2@ name-filename 2!        line @ name-line ! filename 2@ name-filename 2!
       start }} forth-ident {{ end 2dup prim prim-name 2! prim prim-c-name 2! }}  white ++        function-number @ prim prim-num !
         start }} [ifdef] vmgen c-ident [else] forth-ident [then] {{ end
         2dup prim prim-name 2! prim-c-name-2! }}  white **
      (( ` / white ** {{ start }} c-ident {{ end prim-c-name-2! }} white ** )) ??
    (( simple-primitive || combined-primitive ))     (( simple-primitive || combined-primitive ))
      {{ 1 function-number +! }}
 )) <- primitive ( -- )  )) <- primitive ( -- )
   
 (( (( comment || primitive || nl white ** )) ** eof ))  (( (( comment || primitive || nl white ** )) ** eof ))
Line 882  warnings @ [IF] Line 1787  warnings @ [IF]
 .( parser generated ok ) cr  .( parser generated ok ) cr
 [THEN]  [THEN]
   
   
   \ run with gforth-0.5.0 (slurp-file is missing)
   [IFUNDEF] slurp-file
   : slurp-file ( c-addr1 u1 -- c-addr2 u2 )
       \ c-addr1 u1 is the filename, c-addr2 u2 is the file's contents
       r/o bin open-file throw >r
       r@ file-size throw abort" file too large"
       dup allocate throw swap
       2dup r@ read-file throw over <> abort" could not read whole file"
       r> close-file throw ;
   [THEN]
   
 : primfilter ( addr u -- )  : primfilter ( addr u -- )
     \ process the string at addr u      \ process the string at addr u
     over dup rawinput ! dup line-start ! cookedinput !      over dup rawinput ! dup line-start ! cookedinput !
     + endrawinput !      + endrawinput !
     checksyncline      checksynclines
     primitives2something ;          primitives2something ;    
   
 : process-file ( addr u xt -- )  : unixify ( c-addr u1 -- c-addr u2 )
     output !      \ delete crs from the string
       bounds tuck tuck ?do ( c-addr1 )
           i c@ dup #cr <> if
               over c! char+
           else
               drop
           endif
       loop
       over - ;
   
   : process-file ( addr u xt-simple x-combined -- )
       output-combined ! output !
     save-mem 2dup filename 2!      save-mem 2dup filename 2!
     slurp-file      slurp-file unixify
     warnings @ if      warnings @ if
         ." ------------ CUT HERE -------------" cr  endif          ." ------------ CUT HERE -------------" cr  endif
     primfilter ;      primfilter ;
   
 : process      ( xt -- )  \  : process      ( xt -- )
     bl word count rot  \      bl word count rot
     process-file ;  \      process-file ;

Removed from v.1.69  
changed lines
  Added in v.1.146


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>