cross.fs 99.6 KB
Newer Older
anton's avatar
anton committed
1 2
\ CROSS.FS     The Cross-Compiler                      06oct92py
\ Idea and implementation: Bernd Paysan (py)
anton's avatar
anton committed
3

anton's avatar
anton committed
4
\ Copyright (C) 1995,1996,1997,1998,1999,2000,2003,2004,2005,2006,2007,2009,2010,2011 Free Software Foundation, Inc.
anton's avatar
anton committed
5 6 7 8 9

\ This file is part of Gforth.

\ Gforth is free software; you can redistribute it and/or
\ modify it under the terms of the GNU General Public License
anton's avatar
anton committed
10
\ as published by the Free Software Foundation, either version 3
anton's avatar
anton committed
11 12 13 14 15 16 17 18
\ of the License, or (at your option) any later version.

\ This program is distributed in the hope that it will be useful,
\ but WITHOUT ANY WARRANTY; without even the implied warranty of
\ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
\ GNU General Public License for more details.

\ You should have received a copy of the GNU General Public License
anton's avatar
anton committed
19
\ along with this program. If not, see http://www.gnu.org/licenses/.
anton's avatar
anton committed
20

jwilke's avatar
jwilke committed
21 22 23 24
0 
[IF]

ToDo:
jwilke's avatar
jwilke committed
25 26 27 28
- Crossdoc destination ./doc/crossdoc.fd makes no sense when
  cross.fs is used seperately. jaw
- Do we need this char translation with >address and in branchoffset? 
  (>body also affected) jaw
jwilke's avatar
jwilke committed
29 30

[THEN]
anton's avatar
anton committed
31

32 33
s" compat/strcomp.fs" included

jwilke's avatar
jwilke committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
hex

\ debugging for compiling

\ print stack at each colon definition
\ : : save-input cr bl word count type restore-input throw .s : ;

\ print stack at each created word
\ : create save-input cr bl word count type restore-input throw .s create ;


\ \ -------------  Setup Vocabularies

\ Remark: Vocabulary is not ANS, but it should work...

Vocabulary Cross
Vocabulary Target
Vocabulary Ghosts
Vocabulary Minimal
only Forth also Target also also
definitions Forth

jwilke's avatar
jwilke committed
56
: T  previous Ghosts also Target ; immediate
jwilke's avatar
jwilke committed
57 58 59 60 61
: G  Ghosts ; immediate
: H  previous Forth also Cross ; immediate

forth definitions

jwilke's avatar
jwilke committed
62
: T  previous Ghosts also Target ; immediate
jwilke's avatar
jwilke committed
63 64
: G  Ghosts ; immediate

65

jwilke's avatar
jwilke committed
66 67 68 69 70 71 72 73
: >cross  also Cross definitions previous ;
: >target also Target definitions previous ;
: >minimal also Minimal definitions previous ;

H

>CROSS

jwilke's avatar
jwilke committed
74 75 76 77
\ Test against this definitions to find out whether we are cross-compiling
\ may be usefull for assemblers
0 Constant gforth-cross-indicator

jwilke's avatar
jwilke committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
\ find out whether we are compiling with gforth

: defined? bl word find nip ;
defined? emit-file defined? toupper and \ drop 0
[IF]
\ use this in a gforth system
: \GFORTH ; immediate
: \ANSI postpone \ ; immediate
[ELSE]
: \GFORTH postpone \ ; immediate
: \ANSI ; immediate
[THEN]

\ANSI : [IFUNDEF] defined? 0= postpone [IF] ; immediate
\ANSI : [IFDEF] defined? postpone [IF] ; immediate
0 \ANSI drop 1
[IF]
: \G postpone \ ; immediate
: rdrop postpone r> postpone drop ; immediate
: name bl word count ;
: bounds over + swap ;
: scan >r BEGIN dup WHILE over c@ r@ <> WHILE 1 /string REPEAT THEN rdrop ;
: linked here over @ , swap ! ;
: alias create , DOES> @ EXECUTE ;
: defer ['] noop alias ;
: is state @ 
  IF ' >body postpone literal postpone ! 
  ELSE ' >body ! THEN ; immediate
: 0>= 0< 0= ;
: d<> rot <> -rot <> or ;
: toupper dup [char] a [char] z 1+ within IF [char] A [char] a - + THEN ;
Variable ebuf
: emit-file ( c fd -- ior ) swap ebuf c! ebuf 1 chars rot write-file ;
0a Constant #lf
0d Constant #cr

[IFUNDEF] Warnings Variable Warnings [THEN]

\ \ Number parsing					23feb93py

\ number? number                                       23feb93py

Variable dpl

hex
Create bases   10 ,   2 ,   A , 100 ,
\              16     2    10   character

\ !! protect BASE saving wrapper against exceptions
: getbase ( addr u -- addr' u' )
    over c@ [char] $ - dup 4 u<
    IF
	cells bases + @ base ! 1 /string
    ELSE
	drop
    THEN ;

: sign? ( addr u -- addr u flag )
    over c@ [char] - =  dup >r
    IF
	1 /string
    THEN
    r> ;

: s>unumber? ( addr u -- ud flag )
jwilke's avatar
jwilke committed
143 144 145 146
    over [char] ' =
    IF 	\ a ' alone is rather unusual :-)
	drop char+ c@ 0 true EXIT 
    THEN
jwilke's avatar
jwilke committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    base @ >r  dpl on  getbase
    0. 2swap
    BEGIN ( d addr len )
	dup >r >number dup
    WHILE \ there are characters left
	dup r> -
    WHILE \ the last >number parsed something
	dup 1- dpl ! over c@ [char] . =
    WHILE \ the current char is '.'
	1 /string
    REPEAT  THEN \ there are unparseable characters left
	2drop false
    ELSE
	rdrop 2drop true
    THEN
    r> base ! ;

\ ouch, this is complicated; there must be a simpler way - anton
: s>number? ( addr len -- d f )
    \ converts string addr len into d, flag indicates success
    sign? >r
    s>unumber?
    0= IF
        rdrop false
    ELSE \ no characters left, all ok
	r>
	IF
	    dnegate
	THEN
	true
    THEN ;

: s>number ( addr len -- d )
    \ don't use this, there is no way to tell success
    s>number? drop ;

: snumber? ( c-addr u -- 0 / n -1 / d 0> )
    s>number? 0=
    IF
	2drop false  EXIT
    THEN
    dpl @ dup 0< IF
	nip
    ELSE
	1+
    THEN ;

194
: (number?) ( string -- string 0 / n -1 / d 0> )
jwilke's avatar
jwilke committed
195 196 197 198 199 200 201
    dup >r count snumber? dup if
	rdrop
    else
	r> swap
    then ;

: number ( string -- d )
202
    (number?) ?dup 0= abort" ?"  0<
jwilke's avatar
jwilke committed
203 204 205 206 207
    IF
	s>d
    THEN ;

[THEN]
anton's avatar
anton committed
208

209 210
[IFUNDEF] (number?) : (number?) number? ; [THEN]

211 212 213 214 215 216 217
\ this provides assert( and struct stuff
\GFORTH [IFUNDEF] assert1(
\GFORTH also forth definitions require assert.fs previous
\GFORTH [THEN]

>CROSS

jwilke's avatar
jwilke committed
218
hex     \ the defualt base for the cross-compiler is hex !!
jwilke's avatar
jwilke committed
219
\ Warnings off
jwilke's avatar
jwilke committed
220 221 222

\ words that are generaly useful

223
: KB  400 * ;
jwilke's avatar
jwilke committed
224 225 226 227 228
: >wordlist ( vocabulary-xt -- wordlist-struct )
  also execute get-order swap >r 1- set-order r> ;

: umax 2dup u< IF swap THEN drop ;
: umin 2dup u> IF swap THEN drop ;
anton's avatar
anton committed
229

pazsan's avatar
pazsan committed
230 231 232
: string, ( c-addr u -- )
    \ puts down string as cstring
    dup c, here swap chars dup allot move ;
233

jwilke's avatar
jwilke committed
234 235
: ," [char] " parse string, ;

jwilke's avatar
jwilke committed
236
: SetValue ( n -- <name> )
pazsan's avatar
pazsan committed
237 238
\G Same behaviour as "Value" if the <name> is not defined
\G Same behaviour as "to" if <name> is defined
jwilke's avatar
jwilke committed
239
\G SetValue searches in the current vocabulary
jwilke's avatar
jwilke committed
240 241 242 243 244 245
  save-input bl word >r restore-input throw r> count
  get-current search-wordlist
  IF	drop >r
	\ we have to set current to be topmost context wordlist
	get-order get-order get-current swap 1+ set-order
	r> ['] to execute
jwilke's avatar
jwilke committed
246
	set-order
jwilke's avatar
jwilke committed
247
  ELSE Value THEN ;
jwilke's avatar
jwilke committed
248 249

: DefaultValue ( n -- <name> )
pazsan's avatar
pazsan committed
250 251
\G Same behaviour as "Value" if the <name> is not defined
\G DefaultValue searches in the current vocabulary
jwilke's avatar
jwilke committed
252 253
 save-input bl word >r restore-input throw r> count
 get-current search-wordlist
254
 IF bl word drop 2drop ELSE Value THEN ;
anton's avatar
anton committed
255 256 257

hex

jwilke's avatar
jwilke committed
258
\ FIXME delete`
jwilke's avatar
jwilke committed
259 260 261
\ 1 Constant Cross-Flag	\ to check whether assembler compiler plug-ins are
			\ for cross-compiling
\ No! we use "[IFUNDEF]" there to find out whether we are target compiling!!!
pazsan's avatar
pazsan committed
262

jwilke's avatar
jwilke committed
263
\ FIXME move down
jwilke's avatar
jwilke committed
264
: comment? ( c-addr u -- c-addr u )
265
        2dup s" (" str=
jwilke's avatar
jwilke committed
266
        IF    postpone (
267
        ELSE  2dup s" \" str= IF postpone \ THEN
jwilke's avatar
jwilke committed
268
        THEN ;
pazsan's avatar
pazsan committed
269

jwilke's avatar
jwilke committed
270 271 272 273 274 275 276 277
: X ( -- <name> )
\G The next word in the input is a target word.
\G Equivalent to T <name> but without permanent
\G switch to target dictionary. Used as prefix e.g. for @, !, here etc.
  bl word count [ ' target >wordlist ] Literal search-wordlist
  IF state @ IF compile, ELSE execute THEN
  ELSE	-1 ABORT" Cross: access method not supported!"
  THEN ; immediate
278

jwilke's avatar
jwilke committed
279
\ Begin CROSS COMPILER:
anton's avatar
anton committed
280

jwilke's avatar
jwilke committed
281
\ debugging
jwilke's avatar
jwilke committed
282

jwilke's avatar
jwilke committed
283 284 285 286 287 288 289 290 291
0 [IF]

This implements debugflags for the cross compiler and the compiled
images. It works identical to the has-flags in the environment.
The debugflags are defined in a vocabluary. If the word exists and
its value is true, the flag is switched on.

[THEN]

jwilke's avatar
jwilke committed
292 293
>CROSS

jwilke's avatar
jwilke committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
Vocabulary debugflags	\ debug flags for cross
also debugflags get-order over
Constant debugflags-wl
set-order previous

: DebugFlag
  get-current >r debugflags-wl set-current
  SetValue
  r> set-current ;

: Debug? ( adr u -- flag )
\G return true if debug flag is defined or switched on
  debugflags-wl search-wordlist
  IF EXECUTE
  ELSE false THEN ;

: D? ( <name> -- flag )
\G return true if debug flag is defined or switched on
\G while compiling we do not return the current value but
  bl word count debug? ;

: [d?]
\G compile the value-xt so the debug flag can be switched
\G the flag must exist!
  bl word count debugflags-wl search-wordlist
  IF 	compile,
  ELSE  -1 ABORT" unknown debug flag"
	\ POSTPONE false 
  THEN ; immediate
pazsan's avatar
pazsan committed
323

jwilke's avatar
jwilke committed
324 325 326 327 328 329 330 331 332 333 334 335
: symentry ( adr len taddr -- )
\G Produce a symbol table (an optional symbol address
\G map) if wanted
    [ [IFDEF] fd-symbol-table ]
      base @ swap hex s>d <# 8 0 DO # LOOP #> fd-symbol-table write-file throw base !
      s" :" fd-symbol-table write-file throw
      fd-symbol-table write-line throw
    [ [ELSE] ]
      2drop drop
    [ [THEN] ] ;


jwilke's avatar
jwilke committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
\ \ --------------------	source file

decimal

Variable cross-file-list
0 cross-file-list !
Variable target-file-list
0 target-file-list !
Variable host-file-list
0 host-file-list !

cross-file-list Value file-list
0 Value source-desc

\ file loading

: >fl-id   1 cells + ;
: >fl-name 2 cells + ;

Variable filelist 0 filelist !
Create NoFile ," #load-file#"

: loadfile ( -- adr )
  source-desc ?dup IF >fl-name ELSE NoFile THEN ;

: sourcefilename ( -- adr len ) 
  loadfile count ;

\ANSI : sourceline# 0 ;

\ \ --------------------	path handling from kernel/paths.fs

\ paths.fs path file handling                                    03may97jaw

\ -Changing the search-path:
\ fpath+ <path> 	adds a directory to the searchpath
\ fpath= <path>|<path>	makes complete now searchpath
\ 			seperator is |
\ .fpath		displays the search path
\ remark I: 
\ a ./ in the beginning of filename is expanded to the directory the
\ current file comes from. ./ can also be included in the search-path!
\ ~+/ loads from the current working directory

\ remark II:
\ if there is no sufficient space for the search path increase it!


\ -Creating custom paths:

\ It is possible to use the search mechanism on yourself.

\ Make a buffer for the path:
\ create mypath	100 chars , 	\ maximum length (is checked)
\ 		0 ,		\ real len
\ 		100 chars allot \ space for path
\ use the same functions as above with:
\ mypath path+ 
\ mypath path=
\ mypath .path

\ do a open with the search path:
\ open-path-file ( adr len path -- fd adr len ior )
\ the file is opened read-only; if the file is not found an error is generated

\ questions to: wilke@jwdt.com

[IFUNDEF] +place
: +place ( adr len adr )
        2dup >r >r
        dup c@ char+ + swap move
        r> r> dup c@ rot + swap c! ;
[THEN]

[IFUNDEF] place
: place ( c-addr1 u c-addr2 )
        2dup c! char+ swap move ;
[THEN]

\ if we have path handling, use this and the setup of it
[IFUNDEF] open-fpath-file

create sourcepath 1024 chars , 0 , 1024 chars allot \ !! make this dynamic
sourcepath value fpath

: also-path ( adr len path^ -- )
  >r
  \ len check
  r@ cell+ @ over + r@ @ u> ABORT" path buffer too small!"
  \ copy into
  tuck r@ cell+ dup @ cell+ + swap cmove
  \ make delimiter
  0 r@ cell+ dup @ cell+ + 2 pick + c! 1 + r> cell+ +!
  ;

: only-path ( adr len path^ -- )
  dup 0 swap cell+ ! also-path ;

: path+ ( path-addr  "dir" -- ) \ gforth
    \G Add the directory @var{dir} to the search path @var{path-addr}.
    name rot also-path ;

: fpath+ ( "dir" ) \ gforth
    \G Add directory @var{dir} to the Forth search path.
    fpath path+ ;

: path= ( path-addr "dir1|dir2|dir3" ) \ gforth
    \G Make a complete new search path; the path separator is |.
    name 2dup bounds ?DO i c@ [char] | = IF 0 i c! THEN LOOP
    rot only-path ;

: fpath= ( "dir1|dir2|dir3" ) \ gforth
    \G Make a complete new Forth search path; the path separator is |.
    fpath path= ;

451
: path>string  cell+ dup cell+ swap @ ;
jwilke's avatar
jwilke committed
452 453 454 455 456 457 458 459

: next-path ( adr len -- adr2 len2 )
  2dup 0 scan
  dup 0= IF     2drop 0 -rot 0 -rot EXIT THEN
  >r 1+ -rot r@ 1- -rot
  r> - ;

: previous-path ( path^ -- )
460
  dup path>string
jwilke's avatar
jwilke committed
461 462 463 464
  BEGIN tuck dup WHILE repeat ;

: .path ( path-addr -- ) \ gforth
    \G Display the contents of the search path @var{path-addr}.
465
    path>string
jwilke's avatar
jwilke committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479
    BEGIN next-path dup WHILE type space REPEAT 2drop 2drop ;

: .fpath ( -- ) \ gforth
    \G Display the contents of the Forth search path.
    fpath .path ;

: absolut-path? ( addr u -- flag ) \ gforth
    \G A path is absolute if it starts with a / or a ~ (~ expansion),
    \G or if it is in the form ./*, extended regexp: ^[/~]|./, or if
    \G it has a colon as second character ("C:...").  Paths simply
    \G containing a / are not absolute!
    2dup 2 u> swap 1+ c@ [char] : = and >r \ dos absoulte: c:/....
    over c@ [char] / = >r
    over c@ [char] ~ = >r
480 481
    \ 2dup S" ../" string-prefix? r> or >r \ not catered for in expandtopic
    S" ./" string-prefix?
jwilke's avatar
jwilke committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
    r> r> r> or or or ;

Create ofile 0 c, 255 chars allot
Create tfile 0 c, 255 chars allot

: pathsep? dup [char] / = swap [char] \ = or ;

: need/   ofile dup c@ + c@ pathsep? 0= IF s" /" ofile +place THEN ;

: extractpath ( adr len -- adr len2 )
  BEGIN dup WHILE 1-
        2dup + c@ pathsep? IF EXIT THEN
  REPEAT ;

: remove~+ ( -- )
497
    ofile count s" ~+/" string-prefix?
jwilke's avatar
jwilke committed
498 499 500 501 502 503
    IF
	ofile count 3 /string ofile place
    THEN ;

: expandtopic ( -- ) \ stack effect correct? - anton
    \ expands "./" into an absolute name
504
    ofile count s" ./" string-prefix?
jwilke's avatar
jwilke committed
505 506 507 508 509 510 511 512 513
    IF
	ofile count 1 /string tfile place
	0 ofile c! sourcefilename extractpath ofile place
	ofile c@ IF need/ THEN
	tfile count over c@ pathsep? IF 1 /string THEN
	ofile +place
    THEN ;

: compact.. ( adr len -- adr2 len2 )
pazsan's avatar
pazsan committed
514 515 516
    \ deletes phrases like "xy/.." out of our directory name 2dec97jaw
    over swap
    BEGIN  dup  WHILE
517
        dup >r '/ scan 2dup s" /../" string-prefix?
pazsan's avatar
pazsan committed
518 519 520 521 522 523 524
        IF
            dup r> - >r 4 /string over r> + 4 -
            swap 2dup + >r move dup r> over -
        ELSE
            rdrop dup 1 min /string
        THEN
    REPEAT  drop over - ;
jwilke's avatar
jwilke committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

: reworkdir ( -- )
  remove~+
  ofile count compact..
  nip ofile c! ;

: open-ofile ( -- fid ior )
    \G opens the file whose name is in ofile
    expandtopic reworkdir
    ofile count r/o open-file ;

: check-path ( adr1 len1 adr2 len2 -- fd 0 | 0 <>0 )
  0 ofile ! >r >r ofile place need/
  r> r> ofile +place
  open-ofile ;

: open-path-file ( addr1 u1 path-addr -- wfileid addr2 u2 0 | ior ) \ gforth
    \G Look in path @var{path-addr} for the file specified by @var{addr1 u1}.
    \G If found, the resulting path and an open file descriptor
    \G are returned. If the file is not found, @var{ior} is non-zero.
  >r
  2dup absolut-path?
  IF    rdrop
        ofile place open-ofile
	dup 0= IF >r ofile count r> THEN EXIT
550
  ELSE  r> path>string
jwilke's avatar
jwilke committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
        BEGIN  next-path dup
        WHILE  5 pick 5 pick check-path
        0= IF >r 2drop 2drop r> ofile count 0 EXIT ELSE drop THEN
  REPEAT
        2drop 2drop 2drop -38
  THEN ;

: open-fpath-file ( addr1 u1 -- wfileid addr2 u2 0 | ior ) \ gforth
    \G Look in the Forth search path for the file specified by @var{addr1 u1}.
    \G If found, the resulting path and an open file descriptor
    \G are returned. If the file is not found, @var{ior} is non-zero.
    fpath open-path-file ;

fpath= ~+

[THEN]

\ \ --------------------	include require			13may99jaw

>CROSS

: add-included-file ( adr len -- adr )
  dup >fl-name char+ allocate throw >r
  file-list @ r@ ! r@ file-list !
  r@ >fl-name place r> ;

: included? ( c-addr u -- f )
  file-list
  BEGIN	@ dup
580
  WHILE	>r 2dup r@ >fl-name count str=
jwilke's avatar
jwilke committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
	IF rdrop 2drop true EXIT THEN
	r>
  REPEAT
  2drop drop false ;	

false DebugFlag showincludedfiles

: included1 ( fd adr u -- )
\ include file adr u / fd
\ we don't use fd with include-file, because the forth system
\ doesn't know the name of the file to get a nice error report
  [d?] showincludedfiles
  IF	cr ." Including: " 2dup type ." ..." THEN
  rot close-file throw
  source-desc >r
  add-included-file to source-desc 
  sourcefilename
  ['] included catch
  r> to source-desc 
  throw ;

: included ( adr len -- )
	cross-file-list to file-list
	open-fpath-file throw 
        included1 ;

: required ( adr len -- )
	cross-file-list to file-list
	open-fpath-file throw \ 2dup cr ." R:" type
	2dup included?
	IF 	2drop close-file throw
	ELSE	included1
	THEN ;

: include bl word count included ;

: require bl word count required ;

jwilke's avatar
jwilke committed
619 620
0 [IF]

jwilke's avatar
jwilke committed
621 622 623 624 625 626 627 628 629 630
also forth definitions previous

: included ( adr len -- ) included ;

: required ( adr len -- ) required ;

: include include ;

: require require ;

jwilke's avatar
jwilke committed
631 632
[THEN]

jwilke's avatar
jwilke committed
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
>CROSS
hex

\ \ --------------------        Error Handling                  05aug97jaw

\ Flags

also forth definitions  \ these values may be predefined before
                        \ the cross-compiler is loaded

false DefaultValue stack-warn   	 \ check on empty stack at any definition
false DefaultValue create-forward-warn   \ warn on forward declaration of created words

previous >CROSS

: .dec
  base @ decimal swap . base ! ;

: .sourcepos
  cr sourcefilename type ." :"
  sourceline# .dec ;

: warnhead
\G display error-message head
\G perhaps with linenumber and filename
  .sourcepos ." Warning: " ;

: empty? depth IF .sourcepos ." Stack not empty!"  THEN ;

stack-warn [IF]
: defempty? empty? ;
[ELSE]
: defempty? ; immediate
666
\ : defempty? .sourcepos ; 
jwilke's avatar
jwilke committed
667 668
[THEN]

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
\ \ --------------------        Compiler Plug Ins               01aug97jaw

>CROSS

\ Compiler States

Variable comp-state
0 Constant interpreting
1 Constant compiling
2 Constant resolving
3 Constant assembling

: compiling? comp-state @ compiling = ;

: pi-undefined -1 ABORT" Plugin undefined" ;

: Plugin ( -- : pluginname )
  Create 
  \ for normal cross-compiling only one action
  \ exists, this fields are identical. For the instant
  \ simulation environment we need, two actions for each plugin
  \ the target one and the one that generates the simulation code
  ['] pi-undefined , \ action
  ['] pi-undefined , \ target plugin action
  8765 ,     \ plugin magic
  DOES> perform ;

Plugin DummyPlugin

: 'PI ( -- addr : pluginname )
  ' >body dup 2 cells + @ 8765 <> ABORT" not a plugin" ;

: plugin-of ( xt -- : pluginname )
  dup 'PI 2! ;

: action-of ( xt -- : plunginname )
  'PI cell+ ! ;

: TPA ( -- : plugin )
\ target plugin action
\ executes current target action of plugin
  'PI cell+ POSTPONE literal POSTPONE perform ; immediate

Variable ppi-temp 0 ppi-temp !

: pa:
\g define plugin action
  ppi-temp @ ABORT" pa: definition not closed"
  'PI ppi-temp ! :noname ;

: ;pa
\g end a definition for plugin action
  POSTPONE ; ppi-temp @ ! 0 ppi-temp ! ; immediate


jwilke's avatar
jwilke committed
724
Plugin dlit, ( d -- )			\ compile numerical value the target
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
Plugin lit, ( n -- )
Plugin alit, ( n -- )

Plugin branch, ( target-addr -- )	\ compiles a branch
Plugin ?branch, ( target-addr -- )	\ compiles a ?branch
Plugin branchmark, ( -- branch-addr )	\ reserves room for a branch
Plugin ?branchmark, ( -- branch-addr )	\ reserves room for a ?branch
Plugin ?domark, ( -- branch-addr )	\ reserves room for a ?do branch
Plugin branchto, ( -- )			\ actual program position is target of a branch (do e.g. alignment)
' NOOP plugin-of branchto, 
Plugin branchtoresolve, ( branch-addr -- ) \ resolves a forward reference from branchmark
Plugin branchtomark, ( -- target-addr )	\ marks a branch destination

Plugin colon, ( tcfa -- )		\ compiles call to tcfa at current position
Plugin prim, ( tcfa -- )		\ compiles primitive invocation
Plugin colonmark, ( -- addr )		\ marks a colon call
Plugin colon-resolve ( tcfa addr -- )

Plugin addr-resolve ( target-addr addr -- )
Plugin doer-resolve ( ghost res-pnt target-addr addr -- ghost res-pnt )

Plugin ncontrols? ( [ xn ... x1 ] n -- ) \ checks wheter n control structures are open
Plugin if, 	( -- if-token )
Plugin else,	( if-token -- if-token )
Plugin then,	( if-token -- )
Plugin ahead,
Plugin begin,
Plugin while,
Plugin until,
Plugin again,
Plugin repeat,
Plugin cs-swap	( x1 x2 -- x2 x1 )

Plugin case,	( -- n )
Plugin of,	( n -- x1 n )
Plugin endof,	( x1 n -- x2 n )
Plugin endcase,	( x1 .. xn n -- )

Plugin do,	( -- do-token )
Plugin ?do,	( -- ?do-token )
Plugin for,	( -- for-token )
Plugin loop,	( do-token / ?do-token -- )
Plugin +loop,	( do-token / ?do-token -- )
pazsan's avatar
pazsan committed
768
Plugin -loop,	( do-token / ?do-token -- )
769 770 771 772
Plugin next,	( for-token )
Plugin leave,	( -- )
Plugin ?leave, 	( -- )

jwilke's avatar
jwilke committed
773 774 775 776 777 778 779 780
Plugin ca>native  \ Convert a code address to the processors
                  \ native address. This is used in doprim, and
                  \ code/code: primitive definitions word to
                  \ convert the addresses.
                  \ The only target where we need this is the misc
                  \ which is a 16 Bit processor with word addresses
                  \ but the forth system we build has a normal byte
                  \ addressed memory model    
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805

Plugin doprim,	\ compiles start of a primitive
Plugin docol,   	\ compiles start of a colon definition
Plugin doer,		
Plugin fini,      \ compiles end of definition ;s
Plugin doeshandler,
Plugin dodoes,

Plugin colon-start
' noop plugin-of colon-start
Plugin colon-end
' noop plugin-of colon-end

Plugin ]comp     \ starts compilation
' noop plugin-of ]comp
Plugin comp[     \ ends compilation
' noop plugin-of comp[

Plugin t>body             \ we need the system >body
			\ and the target >body

>TARGET
: >body t>body ;


806
\ Ghost Builder                                        06oct92py
jwilke's avatar
jwilke committed
807

808
>CROSS
809
hex
810
\ Values for ghost magic
811 812 813
4711 Constant <fwd>             4712 Constant <res>
4713 Constant <imm>             4714 Constant <do:>
4715 Constant <skip>
jwilke's avatar
jwilke committed
814

815
\ Bitmask for ghost flags
816
1 Constant <unique>
817 818 819 820 821 822 823 824 825 826 827 828
2 Constant <primitive>

\ FXIME: move this to general stuff?
: set-flag ( addr flag -- )
  over @ or swap ! ;

: reset-flag ( addr flag -- )
  invert over @ and swap ! ;

: get-flag ( addr flag -- f )
  swap @ and 0<> ;
  
jwilke's avatar
jwilke committed
829

830
Struct
jwilke's avatar
jwilke committed
831

832 833
  \ link to next ghost (always the first element)
  cell% field >next-ghost
jwilke's avatar
jwilke committed
834

835 836 837 838 839 840
  \ type of ghost
  cell% field >magic
		
  \ pointer where ghost is in target, or if unresolved
  \ points to the where we have to resolve (linked-list)
  cell% field >link
jwilke's avatar
jwilke committed
841

jwilke's avatar
jwilke committed
842
  \ execution semantics (while target compiling) of ghost
843
  cell% field >exec
jwilke's avatar
jwilke committed
844

jwilke's avatar
jwilke committed
845 846 847 848
  \ compilation action of this ghost; this is what is
  \ done to compile a call (or whatever) to this definition.
  \ E.g. >comp contains the semantic of postpone s"
  \ whereas >exec-compile contains the semantic of s"
849 850
  cell% field >comp

jwilke's avatar
jwilke committed
851 852 853 854 855
  \ Compilation sematics (while parsing) of this ghost. E.g. 
  \ "\" will skip the rest of line.
  \ These semantics are defined by Cond: and
  \ if a word is made immediate in instant, then the >exec2 field
  \ gets copied to here
856
  cell% field >exec-compile
jwilke's avatar
jwilke committed
857

jwilke's avatar
jwilke committed
858 859 860
  \ Additional execution semantics of this ghost. This is used
  \ for code generated by instant and for the doer-xt of created
  \ words
861 862 863
  cell% field >exec2

  cell% field >created
jwilke's avatar
jwilke committed
864

865 866
  \ the xt of the created ghost word itself
  cell% field >ghost-xt
jwilke's avatar
jwilke committed
867

868 869 870
  \ pointer to the counted string of the assiciated
  \ assembler label
  cell% field >asm-name
871

872 873 874 875 876 877 878 879
  \ mapped primitives have a special address, so
  \ we are able to detect them
  cell% field >asm-dummyaddr
			
  \ for builder (create, variable...) words
  \ the execution symantics of words built are placed here
  \ this is a doer ghost or a dummy ghost
  cell% field >do:ghost
880

881
  cell% field >ghost-flags
jwilke's avatar
jwilke committed
882

883 884
  cell% field >ghost-name

885 886
\  cell% field >ghost-vt

887 888 889 890
End-Struct ghost-struct

Variable ghost-list
0 ghost-list !
jwilke's avatar
jwilke committed
891 892

Variable executed-ghost \ last executed ghost, needed in tcreate and gdoes>
893
\ Variable last-ghost	\ last ghost that is created
jwilke's avatar
jwilke committed
894 895
Variable last-header-ghost \ last ghost definitions with header

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
\ space for ghosts resolve structure
\ we create ghosts in a sepearte space
\ and not to the current host dp, because this
\ gives trouble with instant while compiling and creating
\ a ghost for a forward reference
\ BTW: we cannot allocate another memory region
\ because allot will check the overflow!!
Variable cross-space-dp
Create cross-space 250000 allot here 100 allot align 
Constant cross-space-end
cross-space cross-space-dp !
Variable cross-space-dp-orig

: cross-space-used cross-space-dp @ cross-space - ;

: >space ( -- )
  dp @ cross-space-dp-orig !
  cross-space-dp @ dp ! ;

: space> ( -- )
  dp @ dup cross-space-dp !
  cross-space-end u> ABORT" CROSS: cross-space overflow"
  cross-space-dp-orig @ dp ! ;

jwilke's avatar
jwilke committed
920
\ this is just for debugging, to see this in the backtrace
921 922 923 924 925 926 927 928 929 930 931
: execute-exec execute ;
: execute-exec2 execute ;
: execute-exec-compile execute ;

: NoExec
  executed-ghost @ >exec2 @
  ?dup 
  IF   execute-exec2
  ELSE true ABORT" CROSS: Don't execute ghost, or immediate target word"
  THEN ;

932 933
Defer is-forward

934
: (ghostheader) ( -- )
jwilke's avatar
jwilke committed
935
    ghost-list linked <fwd> , 0 , ['] NoExec , ['] is-forward ,
936
    0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 , ;
937 938 939 940 941 942 943 944

: ghostheader ( -- ) (ghostheader) 0 , ;

' Ghosts >wordlist Constant ghosts-wordlist

\ the current wordlist for ghost definitions in the host
ghosts-wordlist Value current-ghosts

jwilke's avatar
jwilke committed
945
: Make-Ghost ( "name" -- ghost )
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
  >space
  \ save current and create in ghost vocabulary
  get-current >r current-ghosts set-current
  >in @ Create >in !
  \ some forth systems like iForth need the immediate directly
  \ after the word is created
  \ restore current
  r> set-current
  here (ghostheader)
  bl word count string, align
  space>
  \ set ghost-xt field by doing a search
  dup >ghost-name count 
  current-ghosts search-wordlist
  0= ABORT" CROSS: Just created, must be there!"
  over >ghost-xt !
  DOES> 
      dup executed-ghost !
      >exec @ execute-exec ;
jwilke's avatar
jwilke committed
965 966 967 968

\ ghost words                                          14oct92py
\                                          changed:    10may93py/jaw

969 970 971 972 973 974 975 976 977 978 979 980
Defer search-ghosts

: (search-ghosts) ( adr len -- cfa true | 0 )
  current-ghosts search-wordlist ; 

  ' (search-ghosts) IS search-ghosts

: gsearch ( addr len -- ghost true | 0 )
  search-ghosts
  dup IF swap >body swap THEN ;

: gfind   ( string -- ghost true / string false )
jwilke's avatar
jwilke committed
981
\ searches for string in word-list ghosts
982 983 984
  \ dup count type space
  dup >r count gsearch
  dup IF rdrop ELSE r> swap THEN ;
jwilke's avatar
jwilke committed
985 986

: gdiscover ( xt -- ghost true | xt false )
987
  >r ghost-list
jwilke's avatar
jwilke committed
988
  BEGIN @ dup
989 990 991 992
  WHILE dup >magic @ <fwd> <>
        IF dup >link @ r@ =
           IF rdrop true EXIT THEN
        THEN
jwilke's avatar
jwilke committed
993
  REPEAT
994
  drop r> false ;
jwilke's avatar
jwilke committed
995

996 997 998
: xt>ghost ( xt -- ghost )
  gdiscover 0= ABORT" CROSS: ghost not found for this xt" ;

999 1000
: Ghost   ( "name" -- ghost )
  >in @ bl word gfind IF  nip EXIT  THEN
jwilke's avatar
jwilke committed
1001 1002 1003
  drop  >in !  Make-Ghost ;

: >ghostname ( ghost -- adr len )
1004
  >ghost-name count ;
jwilke's avatar
jwilke committed
1005 1006 1007 1008

: forward? ( ghost -- flag )
  >magic @ <fwd> = ;

1009 1010 1011
: undefined? ( ghost -- flag )
  >magic @ dup <fwd> = swap <skip> = or ;

1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
: immediate? ( ghost -- flag )
  >magic @ <imm> = ;

Variable TWarnings
TWarnings on
Variable Exists-Warnings
Exists-Warnings on

: exists-warning ( ghost -- ghost )
  TWarnings @ Exists-Warnings @ and
  IF dup >ghostname warnhead type ."  exists " THEN ;

\ : HeaderGhost Ghost ;

Variable reuse-ghosts reuse-ghosts off

: HeaderGhost ( "name" -- ghost )
  >in @ 
  bl word count 
\  2dup type space
  current-ghosts search-wordlist
  IF  >body dup undefined? reuse-ghosts @ or
      IF   nip EXIT
      ELSE exists-warning 
      THEN
      drop >in ! 
  ELSE >in ! 
  THEN 
  \ we keep the execution semantics of the prviously
  \ defined words, this is a workaround
  \ for the redefined \ until vocs work
  Make-Ghost ;
 
: .ghost ( ghost -- ) >ghostname type ;

\ ' >ghostname ALIAS @name

1049 1050 1051
: findghost ( "ghostname" -- ghost ) 
  bl word gfind 0= ABORT" CROSS: Ghost don't exists" ;

1052 1053
: [G'] ( -- ghost : name )
\G ticks a ghost and returns its address
1054 1055
  findghost
  state @ IF postpone literal THEN ; immediate
1056

1057 1058
: g>xt ( ghost -- xt )
\G Returns the xt (cfa) of a ghost. Issues a warning if undefined.
1059 1060
  dup undefined? ABORT" CROSS: forward " >link @ ;
   
1061 1062 1063 1064 1065
: g>body ( ghost -- body )
\G Returns the body-address (pfa) of a ghost. 
\G Issues a warning if undefined (a forward-reference).
  g>xt X >body ;

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
1 Constant <label>

Struct
  \ bitmask of address type (not used for now)
  cell% field addr-type
  \ if this address is an xt, this field points to the ghost
  cell% field addr-xt-ghost
  \ a bit mask that tells as what part of the cell
  \ is refenced from an address pointer, used for assembler generation
  cell% field addr-refs
End-Struct addr-struct

: %allocerase ( align size -- addr )
  dup >r %alloc dup r> erase ;

\ returns the addr struct, define it if 0 reference
: define-addr-struct ( addr -- struct-addr )
  dup @ ?dup IF nip EXIT THEN
  addr-struct %allocerase tuck swap ! ;

1086 1087
>cross

jwilke's avatar
jwilke committed
1088 1089
\ Predefined ghosts                                    12dec92py

jwilke's avatar
jwilke committed
1090 1091
Ghost - drop \ need a ghost otherwise "-" would be treated as a number

1092 1093 1094
Ghost 0=                                        drop
Ghost branch    Ghost ?branch                   2drop
Ghost unloop    Ghost ;S                        2drop
1095 1096
Ghost lit       Ghost !                         2drop
Ghost noop                                      drop
1097 1098 1099
Ghost over      Ghost =         Ghost drop      2drop drop
Ghost 2drop drop
Ghost 2dup drop
1100 1101 1102 1103 1104 1105 1106
Ghost call drop
Ghost @ drop
Ghost useraddr drop
Ghost execute drop
Ghost + drop
Ghost decimal drop
Ghost hex drop
1107 1108 1109 1110
Ghost lit@ drop
Ghost lit-perform drop
Ghost lit+ drop
Ghost does-exec drop
jwilke's avatar
jwilke committed
1111

pazsan's avatar
pazsan committed
1112
Ghost :docol    Ghost :doesjump Ghost :dodoes   2drop drop
1113
Ghost :dovar	Ghost dovar-vt	Ghost dodoes-vt	2drop drop
pazsan's avatar
pazsan committed
1114

jwilke's avatar
jwilke committed
1115 1116
\ \ Parameter for target systems                         06oct92py

1117

jwilke's avatar
jwilke committed
1118 1119 1120
\ we define it ans like...
wordlist Constant target-environment

1121 1122
\ save information of current dictionary to restore with environ>
Variable env-current 
jwilke's avatar
jwilke committed
1123 1124 1125 1126 1127 1128

: >ENVIRON get-current env-current ! target-environment set-current ;
: ENVIRON> env-current @ set-current ; 

>TARGET

1129 1130 1131 1132 1133
: environment? ( addr len -- [ x ] true | false )
\G returns the content of environment variable and true or
\G false if not present
   target-environment search-wordlist 
   IF EXECUTE true ELSE false THEN ;
jwilke's avatar
jwilke committed
1134

1135 1136 1137 1138
: $has? ( addr len -- x | false )
\G returns the content of environment variable 
\G or false if not present
   T environment? H dup IF drop THEN ;
jwilke's avatar
jwilke committed
1139

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
: e? ( "name" -- x )
\G returns the content of environment variable. 
\G The variable is expected to exist. If not, issue an error.
   bl word count T environment? H 
   0= ABORT" environment variable not defined!" ;

: has? ( "name" --- x | false )
\G returns the content of environment variable 
\G or false if not present
   bl word count T $has? H ;
jwilke's avatar
jwilke committed
1150 1151


pazsan's avatar
pazsan committed
1152 1153
>ENVIRON get-order get-current swap 1+ set-order
true SetValue compiler
1154
true SetValue cross
pazsan's avatar
pazsan committed
1155 1156
true SetValue standard-threading
>TARGET previous
jwilke's avatar
jwilke committed
1157

jwilke's avatar
jwilke committed
1158
0
1159 1160 1161
[IFDEF] mach-file drop mach-file count 1 [THEN]
[IFDEF] machine-file drop machine-file 1 [THEN]
[IF] 	included hex
jwilke's avatar
jwilke committed
1162 1163
[ELSE]  cr ." No machine description!" ABORT 
[THEN]
jwilke's avatar
jwilke committed
1164

jwilke's avatar
jwilke committed
1165 1166
>ENVIRON

pazsan's avatar
pazsan committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
T has? ec H
[IF]
false DefaultValue relocate
false DefaultValue file
false DefaultValue OS
false DefaultValue prims
false DefaultValue floating
false DefaultValue glocals
false DefaultValue dcomps
false DefaultValue hash
false DefaultValue xconds
false DefaultValue header
1179 1180 1181
false DefaultValue backtrace
false DefaultValue new-input
false DefaultValue peephole
pazsan's avatar
pazsan committed
1182
false DefaultValue primcentric
1183
false DefaultValue abranch
1184
true DefaultValue f83headerstring
pazsan's avatar
pazsan committed
1185
true DefaultValue control-rack
pazsan's avatar
pazsan committed
1186 1187
[THEN]

1188
true DefaultValue gforthcross
pazsan's avatar
pazsan committed
1189 1190 1191
true DefaultValue interpreter
true DefaultValue ITC
false DefaultValue rom
pazsan's avatar
pazsan committed
1192
false DefaultValue flash
jwilke's avatar
jwilke committed
1193
true DefaultValue standardthreading
jwilke's avatar
jwilke committed
1194

1195 1196 1197 1198 1199
\ ANSForth environment  stuff
8 DefaultValue ADDRESS-UNIT-BITS
255 DefaultValue MAX-CHAR
255 DefaultValue /COUNTED-STRING

jwilke's avatar
jwilke committed
1200 1201
>TARGET
s" relocate" T environment? H 
1202 1203
\ JAW why set NIL to this?!
[IF]	drop \ SetValue NIL
1204
[ELSE]	>ENVIRON X NIL SetValue relocate
jwilke's avatar
jwilke committed
1205
[THEN]
1206 1207 1208
>TARGET

0 Constant NIL
pazsan's avatar
pazsan committed
1209 1210 1211

>CROSS

jwilke's avatar
jwilke committed
1212
\ \ Create additional parameters                         19jan95py
pazsan's avatar
pazsan committed
1213

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
\ currently cross only works for host machines with address-unit-bits
\ eual to 8 because of s! and sc!
\ but I start to query the environment just to modularize a little bit

: check-address-unit-bits ( -- )	
\	s" ADDRESS-UNIT-BITS" environment?
\	IF 8 <> ELSE true THEN
\	ABORT" ADDRESS-UNIT-BITS unknown or not equal to 8!"

\	shit, this doesn't work because environment? is only defined for 
\	gforth.fi and not kernl???.fi
	;

check-address-unit-bits
8 Constant bits/byte	\ we define: byte is address-unit

1 bits/byte lshift Constant maxbyte 
jwilke's avatar
jwilke committed
1231
\ this sets byte size for the target machine, (probably right guess) jaw
jwilke's avatar
jwilke committed
1232

pazsan's avatar
pazsan committed
1233
T
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
NIL		   	Constant TNIL
cell               	Constant tcell
cell<<             	Constant tcell<<
cell>bit           	Constant tcell>bit
bits/char          	Constant tbits/char
bits/char H bits/byte T /      
			Constant tchar
float             	Constant tfloat
1 bits/char lshift 	Constant tmaxchar
[IFUNDEF] bits/byte
8			Constant tbits/byte
[ELSE]
bits/byte		Constant tbits/byte
[THEN]
pazsan's avatar
pazsan committed
1248
H
1249
tbits/char bits/byte /	Constant tbyte
1250

1251 1252 1253
: >signed ( u -- n )
    1 tbits/char tcell * 1- lshift 2dup and
    IF  negate or  ELSE  drop  THEN ;
pazsan's avatar
pazsan committed
1254

anton's avatar
anton committed
1255 1256
\ Variables                                            06oct92py

1257 1258
Variable (tlast)    
(tlast) Value tlast TNIL tlast !  \ Last name field
anton's avatar
anton committed
1259 1260
Variable tlastcfa \ Last code field

jwilke's avatar
jwilke committed
1261 1262 1263 1264 1265
\ statistics						10jun97jaw

Variable headers-named 0 headers-named !
Variable user-vars 0 user-vars !

jwilke's avatar
jwilke committed
1266 1267 1268
: target>bitmask-size ( u1 -- u2 )
  1- tcell>bit rshift 1+ ;

1269
: allocatetarget ( size -- adr )
jwilke's avatar
jwilke committed
1270 1271
  dup allocate ABORT" CROSS: No memory for target"
  swap over swap erase ;
jwilke's avatar
jwilke committed
1272

pazsan's avatar
pazsan committed
1273
\ \ memregion.fs
jwilke's avatar
jwilke committed
1274 1275 1276 1277 1278 1279 1280


Variable last-defined-region    \ pointer to last defined region
Variable region-link            \ linked list with all regions
Variable mirrored-link          \ linked list for mirrored regions
0 dup mirrored-link ! region-link !

1281 1282
: >rname 9 cells + ;
: >rtouch 8 cells + ; \ executed when region is accessed
1283
: >rbm   4 cells + ; \ bitfield per cell witch indicates relocation
1284
: >rmem  5 cells + ;
1285 1286
: >rtype 6 cells + ; \ field per cell witch points to a type struct
: >rrom 7 cells + ;  \ a -1 indicates that this region is rom
jwilke's avatar
jwilke committed
1287
: >rlink 3 cells + ;
jwilke's avatar
jwilke committed
1288 1289 1290 1291
: >rdp 2 cells + ;
: >rlen cell+ ;
: >rstart ;

1292 1293 1294 1295
: (region) ( addr len region -- )
\G change startaddress and length of an existing region
  >r r@ last-defined-region !
  r@ >rlen ! dup r@ >rstart ! r> >rdp ! ;
jwilke's avatar
jwilke committed
1296

1297 1298
: uninitialized -1 ABORT" CROSS: Region is uninitialized" ;

jwilke's avatar
jwilke committed
1299
: region ( addr len -- "name" )                
1300
\G create a new region
jwilke's avatar
jwilke committed
1301 1302 1303 1304 1305 1306 1307
  \ check whether predefined region exists 
  save-input bl word find >r >r restore-input throw r> r> 0= 
  IF	\ make region
	drop
	save-input create restore-input throw
	here last-defined-region !
	over ( startaddr ) , ( length ) , ( dp ) ,
1308 1309 1310
	region-link linked 0 , 0 , 0 , 0 , 
        ['] uninitialized ,
        bl word count string,
jwilke's avatar
jwilke committed
1311 1312
  ELSE	\ store new parameters in region
        bl word drop
1313
	>body (region)
jwilke's avatar
jwilke committed
1314 1315
  THEN ;

1316 1317
: borders ( region -- startaddr endaddr ) 
\G returns lower and upper region border
jwilke's avatar
jwilke committed
1318
  dup >rstart @ swap >rlen @ over + ;
jwilke's avatar
jwilke committed
1319

1320 1321
: extent  ( region -- startaddr len )   
\G returns the really used area
jwilke's avatar
jwilke committed
1322
  dup >rstart @ swap >rdp @ over - ;
jwilke's avatar
jwilke committed
1323

1324 1325
: area ( region -- startaddr totallen ) 
\G returns the total area
1326
  dup >rstart @ swap >rlen @ ;
jwilke's avatar
jwilke committed
1327

1328 1329 1330
: dp@ ( region -- dp )
  >rdp @ ;

1331 1332
: mirrored ( -- )                              
\G mark last defined region as mirrored
jwilke's avatar
jwilke committed
1333
  mirrored-link
jwilke's avatar
jwilke committed
1334
  align linked last-defined-region @ , ;
jwilke's avatar
jwilke committed
1335

1336 1337 1338 1339
: writeprotected
\G mark a region as write protected
  -1 last-defined-region @ >rrom ! ;

jwilke's avatar
jwilke committed
1340 1341
: .addr ( u -- )
\G prints a 16 or 32 Bit nice hex value
jwilke's avatar
jwilke committed
1342 1343
  base @ >r hex
  tcell 2 u>
jwilke's avatar
jwilke committed
1344
  IF s>d <# # # # # [char] . hold # # # # #> type
jwilke's avatar
jwilke committed
1345
  ELSE s>d <# # # # # # #> type
1346
  THEN r> base ! space ;
jwilke's avatar
jwilke committed
1347 1348 1349 1350 1351 1352 1353 1354

: .regions                      \G display region statistic

  \ we want to list the regions in the right order
  \ so first collect all regions on stack
  0 region-link @
  BEGIN dup WHILE dup @ REPEAT drop
  BEGIN dup
jwilke's avatar
jwilke committed
1355 1356 1357
  WHILE cr
        0 >rlink - >r
        r@ >rname count tuck type
jwilke's avatar
jwilke committed
1358
        12 swap - 0 max spaces space
jwilke's avatar
jwilke committed
1359 1360 1361
        ." Start: " r@ >rstart @ dup .addr space
        ." End: " r@ >rlen @ + .addr space
        ." DP: " r> >rdp @ .addr
jwilke's avatar
jwilke committed
1362
  REPEAT drop
jwilke's avatar
jwilke committed
1363
  s" rom" T $has? H 0= ?EXIT
jwilke's avatar
jwilke committed
1364 1365 1366
  cr ." Mirrored:"
  mirrored-link @
  BEGIN dup
jwilke's avatar
jwilke committed
1367
  WHILE space dup cell+ @ >rname count type @
jwilke's avatar
jwilke committed
1368 1369 1370 1371 1372 1373 1374 1375
  REPEAT drop cr
  ;

\ -------- predefined regions

0 0 region address-space
\ total memory addressed and used by the target system

1376 1377 1378 1379
0 0 region user-region
\ data for user variables goes here
\ this has to be defined before dictionary or ram-dictionary

jwilke's avatar
jwilke committed
1380 1381 1382
0 0 region dictionary
\ rom area for the compiler

jwilke's avatar
jwilke committed
1383
T has? rom H
jwilke's avatar
jwilke committed
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
[IF]
0 0 region ram-dictionary mirrored
\ ram area for the compiler
[ELSE]
' dictionary ALIAS ram-dictionary
[THEN]

0 0 region return-stack

0 0 region data-stack

0 0 region tib-region

' dictionary ALIAS rom-dictionary

1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
: setup-region ( region -- )
  >r
  \ allocate mem
  r@ >rlen @ allocatetarget
  r@ >rmem !

  r@ >rlen @
  target>bitmask-size allocatetarget
  r@ >rbm !

  r@ >rlen @
  tcell / 1+ cells allocatetarget r@ >rtype !

  ['] noop r@ >rtouch !
  rdrop ;
jwilke's avatar
jwilke committed
1414

1415
: setup-target ( -- )   \G initialize target's memory space
jwilke's avatar
jwilke committed
1416
  s" rom" T $has? H
jwilke's avatar
jwilke committed
1417
  IF  \ check for ram and rom...
1418
      \ address-space area nip 0<>
jwilke's avatar
jwilke committed
1419 1420
      ram-dictionary area nip 0<>
      rom-dictionary area nip 0<>
1421
      and 0=
jwilke's avatar
jwilke committed
1422 1423 1424 1425 1426 1427 1428 1429
      ABORT" CROSS: define address-space, rom- , ram-dictionary, with rom-support!"
  THEN
  address-space area nip
  IF
      address-space area
  ELSE
      dictionary area
  THEN
jwilke's avatar
jwilke committed
1430
  nip 0=
jwilke's avatar
jwilke committed
1431
  ABORT" CROSS: define at least address-space or dictionary!!"
jwilke's avatar
jwilke committed
1432 1433 1434 1435 1436 1437 1438

  \ allocate target for each region
  region-link
  BEGIN @ dup
  WHILE dup
        0 >rlink - >r
        r@ >rlen @
1439 1440
        IF      r@ setup-region
        THEN    rdrop
1441 1442
   REPEAT drop ;

1443
\ MakeKernel                                           		22feb99jaw
1444

1445
: makekernel ( start targetsize -- )
1446 1447
\G convenience word to setup the memory of the target
\G used by main.fs of the c-engine based systems
1448
  dictionary (region) setup-target ;
1449 1450 1451 1452

>MINIMAL
: makekernel makekernel ;
>CROSS
jwilke's avatar
jwilke committed
1453

pazsan's avatar
pazsan committed
1454
\ \ switched tdp for rom support				03jun97jaw
jwilke's avatar
jwilke committed
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472

\ second value is here to store some maximal value for statistics
\ tempdp is also embedded here but has nothing to do with rom support
\ (needs switched dp)

variable tempdp	0 ,	\ temporary dp for resolving
variable tempdp-save

0 [IF]
variable romdp 0 ,      \ Dictionary-Pointer for ramarea
variable ramdp 0 ,      \ Dictionary-Pointer for romarea

\
variable sramdp		\ start of ram-area for forth
variable sromdp		\ start of rom-area for forth

[THEN]

jwilke's avatar
jwilke committed
1473 1474 1475
0 Value current-region
0 Value tdp
Variable fixed		\ flag: true: no automatic switching
jwilke's avatar
jwilke committed
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
			\	false: switching is done automatically

\ Switch-Policy:
\
\ a header is always compiled into rom
\ after a created word (create and variable) compilation goes to ram
\
\ Be careful: If you want to make the data behind create into rom
\ you have to put >rom before create!

variable constflag constflag off

jwilke's avatar
jwilke committed
1488 1489
: activate ( region -- )
\G next code goes to this region
jwilke's avatar
jwilke committed
1490
  dup to current-region >rdp to tdp ;
jwilke's avatar
jwilke committed
1491

jwilke's avatar
jwilke committed
1492
: (switchram)
jwilke's avatar
jwilke committed
1493
  fixed @ ?EXIT s" rom" T $has? H 0= ?EXIT
jwilke's avatar
jwilke committed
1494
  ram-dictionary activate ;
jwilke's avatar
jwilke committed
1495 1496 1497 1498 1499 1500

: switchram
  constflag @
  IF constflag off ELSE (switchram) THEN ;

: switchrom
jwilke's avatar
jwilke committed
1501
  fixed @ ?EXIT rom-dictionary activate ;
jwilke's avatar
jwilke committed
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516

: >tempdp ( addr -- ) 
  tdp tempdp-save ! tempdp to tdp tdp ! ;
: tempdp> ( -- )
  tempdp-save @ to tdp ;

: >ram  fixed off (switchram) fixed on ;
: >rom  fixed off switchrom fixed on ;
: >auto fixed off switchrom ;



\ : romstart dup sromdp ! romdp ! ;
\ : ramstart dup sramdp ! ramdp ! ;

jwilke's avatar
jwilke committed
1517
\ default compilation goes to rom
jwilke's avatar
jwilke committed
1518 1519 1520 1521
\ when romable support is off, only the rom switch is used (!!)
>auto

: there  tdp @ ;
anton's avatar
anton committed
1522

anton's avatar
anton committed
1523 1524
>TARGET

jwilke's avatar
jwilke committed
1525 1526
\ \ Target Memory Handling

anton's avatar
anton committed
1527 1528
\ Byte ordering and cell size                          06oct92py

pazsan's avatar
pazsan committed
1529 1530
: cell+         tcell + ;
: cells         tcell<< lshift ;
1531 1532
: chars         tchar * ;
: char+		tchar + ;
pazsan's avatar
pazsan committed
1533
: floats	tfloat * ;
1534
    
anton's avatar
anton committed
1535
>CROSS
pazsan's avatar
pazsan committed
1536
: cell/         tcell<< rshift ;
anton's avatar
anton committed
1537 1538
>TARGET
20 CONSTANT bl
jwilke's avatar
jwilke committed
1539
\ TNIL Constant NIL
anton's avatar
anton committed
1540 1541 1542

>CROSS

1543 1544
bigendian
[IF]
jwilke's avatar
jwilke committed
1545
   : DS!  ( d addr -- )  tcell bounds swap 1-
1546
     DO  maxbyte ud/mod rot I c!  -1 +LOOP  2drop ;
jwilke's avatar
jwilke committed
1547 1548
   : DS@  ( addr -- d )  >r 0 0 r> tcell bounds
     DO  maxbyte * swap maxbyte um* rot + swap I c@ + swap  LOOP ;
1549 1550 1551 1552
   : Sc!  ( n addr -- )  >r s>d r> tchar bounds swap 1-
     DO  maxbyte ud/mod rot I c!  -1 +LOOP  2drop ;
   : Sc@  ( addr -- n )  >r 0 0 r> tchar bounds
     DO  maxbyte * swap maxbyte um* rot + swap I c@ + swap  LOOP d>s ;
pazsan's avatar
pazsan committed
1553
[ELSE]
jwilke's avatar
jwilke committed
1554
   : DS!  ( d addr -- )  tcell bounds
1555
     DO  maxbyte ud/mod rot I c!  LOOP  2drop ;
jwilke's avatar
jwilke committed
1556 1557
   : DS@  ( addr -- n )  >r 0 0 r> tcell bounds swap 1-
     DO  maxbyte * swap maxbyte um* rot + swap I c@ + swap  -1 +LOOP ;
1558 1559 1560 1561
   : Sc!  ( n addr -- )  >r s>d r> tchar bounds
     DO  maxbyte ud/mod rot I c!  LOOP  2drop ;
   : Sc@  ( addr -- n )  >r 0 0 r> tchar bounds swap 1-
     DO  maxbyte * swap maxbyte um* rot + swap I c@ + swap  -1 +LOOP d>s ;
anton's avatar
anton committed
1562 1563
[THEN]

jwilke's avatar
jwilke committed
1564 1565 1566
: S! ( n addr -- ) >r s>d r> DS! ;
: S@ ( addr -- n ) DS@ d>s ;

jwilke's avatar
jwilke committed
1567 1568 1569 1570 1571 1572 1573 1574 1575
: taddr>region ( taddr -- region | 0 )
\G finds for a target-address the correct region
\G returns 0 if taddr is not in range of a target memory region
  region-link
  BEGIN @ dup
  WHILE dup >r
        0 >rlink - >r
        r@ >rlen @
        IF      dup r@ borders within
1576 1577 1578
                IF r> r> drop nip 
                   dup >rtouch @ EXECUTE EXIT 
                THEN
jwilke's avatar
jwilke committed
1579 1580 1581 1582 1583 1584
        THEN
        r> drop
        r>
  REPEAT
  2drop 0 ;

1585
: taddr>region-abort ( taddr -- region | 0 )
1586 1587
\G Same as taddr>region but aborts if taddr is not
\G a valid address in the target address space
1588 1589 1590 1591 1592
  dup taddr>region dup 0= 
  IF    drop cr ." Wrong address: " .addr
        -1 ABORT" Address out of range!"
  THEN nip ;

jwilke's avatar
jwilke committed
1593 1594 1595
: (>regionimage) ( taddr -- 'taddr )
  dup
  \ find region we want to address
1596
  taddr>region-abort
jwilke's avatar
jwilke committed
1597 1598 1599 1600 1601 1602
  >r
  \ calculate offset in region
  r@ >rstart @ -
  \ add regions real address in our memory
  r> >rmem @ + ;

1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
: (>regionramimage) ( taddr -- 'taddr )
\G same as (>regionimage) but aborts if the region is rom
  dup
  \ find region we want to address
  taddr>region-abort
  >r
  r@ >rrom @ ABORT" CROSS: region is write-protected!"
  \ calculate offset in region
  r@ >rstart @ -
  \ add regions real address in our memory
  r> >rmem @ + ;

1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
: (>regionbm) ( taddr -- 'taddr bitmaskbaseaddr )
  dup
  \ find region we want to address
  taddr>region-abort
  >r
  \ calculate offset in region
  r@ >rstart @ -
  \ add regions real address in our memory
  r> >rbm @ ;

: (>regiontype) ( taddr -- 'taddr )
  dup
  \ find region we want to address
  taddr>region-abort
  >r
  \ calculate offset in region
  r@ >rstart @ - tcell / cells
  \ add regions real address in our memory
  r> >rtype @ + ;
  
anton's avatar
anton committed
1635 1636 1637 1638 1639 1640 1641
\ Bit string manipulation                               06oct92py
\                                                       9may93jaw
CREATE Bittable 80 c, 40 c, 20 c, 10 c, 8 c, 4 c, 2 c, 1 c,
: bits ( n -- n ) chars Bittable + c@ ;

: >bit ( addr n -- c-addr mask ) 8 /mod rot + swap bits ;
: +bit ( addr n -- )  >bit over c@ or swap c! ;
pazsan's avatar
pazsan committed
1642
: -bit ( addr n -- )  >bit invert over c@ and swap c! ;
jwilke's avatar
jwilke committed
1643

1644 1645
: @relbit ( taddr -- f ) (>regionbm) swap cell/ >bit swap c@ and ;

1646 1647 1648 1649 1650
: (relon) ( taddr -- )  
  [ [IFDEF] fd-relocation-table ]
  s" +" fd-relocation-table write-file throw
  dup s>d <# #s #> fd-relocation-table write-line throw
  [ [THEN] ]
1651
  (>regionbm) swap cell/ +bit ;
1652 1653 1654 1655 1656 1657

: (reloff) ( taddr -- ) 
  [ [IFDEF] fd-relocation-table ]
  s" -" fd-relocation-table write-file throw
  dup s>d <# #s #> fd-relocation-table write-line throw
  [ [THEN] ]
1658
  (>regionbm) swap cell/ -bit ;
jwilke's avatar
jwilke committed
1659 1660

DEFER >image
1661
DEFER >ramimage
jwilke's avatar
jwilke committed
1662 1663 1664 1665 1666 1667 1668 1669
DEFER relon
DEFER reloff
DEFER correcter

T has? relocate H
[IF]
' (relon) IS relon
' (reloff) IS reloff
1670
' (>regionimage) IS >image
1671
' (>regionimage) IS >ramimage
jwilke's avatar
jwilke committed
1672 1673 1674
[ELSE]
' drop IS relon
' drop IS reloff
jwilke's avatar
jwilke committed
1675
' (>regionimage) IS >image
1676
' (>regionimage) IS >ramimage
jwilke's avatar
jwilke committed
1677
[THEN]
anton's avatar
anton committed
1678

1679 1680 1681 1682 1683 1684 1685 1686 1687
: enforce-writeprotection ( -- )
  ['] (>regionramimage) IS >ramimage ;

: relax-writeprotection ( -- )
  ['] (>regionimage) IS >ramimage ;

: writeprotection-relaxed? ( -- )
  ['] >ramimage >body @ ['] (>regionimage) = ;

anton's avatar
anton committed
1688 1689 1690
\ Target memory access                                 06oct92py

: align+  ( taddr -- rest )
anton's avatar
anton committed
1691
    tcell tuck 1- and - [ tcell 1- ] Literal and ;
1692
: cfalign+  ( taddr -- rest )
pazsan's avatar
pazsan committed
1693
    \ see kernel.fs:cfaligned
pazsan's avatar
pazsan committed
1694
    /maxalign tuck 1- and - [ /maxalign 1- ] Literal and ;
anton's avatar
anton committed
1695 1696 1697 1698 1699

>TARGET
: aligned ( taddr -- ta-addr )  dup align+ + ;
\ assumes cell alignment granularity (as GNU C)

1700
: cfaligned ( taddr1 -- taddr2 )
pazsan's avatar
pazsan committed
1701
    \ see kernel.fs