--- gforth/libcc.fs 2007/12/05 13:54:38 1.26 +++ gforth/libcc.fs 2010/12/31 18:09:02 1.67 @@ -1,12 +1,12 @@ \ libcc.fs foreign function interface implemented using a C compiler -\ Copyright (C) 2006 Free Software Foundation, Inc. +\ Copyright (C) 2006,2007,2008,2009,2010 Free Software Foundation, Inc. \ 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 -\ as published by the Free Software Foundation; either version 2 +\ as published by the Free Software Foundation, either version 3 \ of the License, or (at your option) any later version. \ This program is distributed in the hope that it will be useful, @@ -15,8 +15,7 @@ \ GNU General Public License for more details. \ You should have received a copy of the GNU General Public License -\ along with this program; if not, write to the Free Software -\ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. +\ along with this program. If not, see http://www.gnu.org/licenses/. \ What this implementation does is this: if it sees a declaration like @@ -68,11 +67,6 @@ \ The files are built in .../lib/gforth/$VERSION/libcc/ or \ ~/.gforth/libcc/$HOST/. -\ other things to do: - -\ c-variable forth-name c-name -\ c-constant forth-name c-name - \ Todo: conversion between function pointers and xts (both directions) \ taking an xt and turning it into a function pointer: @@ -124,18 +118,27 @@ \ first-time word, then to the run-time word; the run-time word calls \ the c function. -: delete-file 2drop 0 ; +[ifundef] parse-name + ' parse-word alias parse-name +[then] +[ifundef] defer! +: defer! ( xt xt-deferred -- ) \ gforth defer-store +\G Changes the @code{defer}red word @var{xt-deferred} to execute @var{xt}. + >body [ has? rom [IF] ] @ [ [THEN] ] ! ; +[then] + +\ : delete-file 2drop 0 ; require struct.fs +require mkdir.fs - \ counted-string - \ c-function-ft word body: struct cell% field cff-cfr \ xt of c-function-rt word cell% field cff-deferred \ xt of c-function deferred word cell% field cff-lha \ address of the lib-handle for the lib that \ contains the wrapper function of the word + char% field cff-ctype \ call type (function=1, value=0) char% field cff-rtype \ return type char% field cff-np \ number of parameters 1 0 field cff-ptypes \ #npar parameter types @@ -147,8 +150,14 @@ variable c-source-file-id \ contains the variable lib-handle-addr \ points to the library handle of the current batch. \ the library handle is 0 if the current \ batch is not yet compiled. + here 0 , lib-handle-addr ! \ just make sure LIB-HANDLE always works 2variable lib-filename \ filename without extension 2variable lib-modulename \ basename of the file without extension +2variable libcc-named-dir-v \ directory for named libcc wrapper libraries +Variable libcc-path \ pointer to path of library directories + +defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 ) +' noop is replace-rpath : .nb ( n -- ) 0 .r ; @@ -206,6 +215,20 @@ end-struct list% node list-next @ repeat ; +2variable c-libs \ library names in a string (without "lib") + +: add-lib ( c-addr u -- ) \ gforth +\G Add library lib@i{string} to the list of libraries, where + \G @i{string} is represented by @i{c-addr u}. + c-libs 2@ d0= IF 0 allocate throw 0 c-libs 2! THEN + c-libs 2@ s" -l" append 2swap append c-libs 2! ; + +: add-libpath ( c-addr u -- ) \ gforth +\G Add path @i{string} to the list of library search pathes, where + \G @i{string} is represented by @i{c-addr u}. + c-libs 2@ d0= IF 0 allocate throw 0 c-libs 2! THEN + c-libs 2@ s" -L" append 2swap append c-libs 2! ; + \ C prefix lines \ linked list of longcstrings: [ link | count-cell | characters ] @@ -224,13 +247,21 @@ variable c-prefix-lines-end c-prefix-lin : print-c-prefix-lines ( -- ) c-prefix-lines @ ['] print-c-prefix-line list-map ; -: save-c-prefix-line ( c-addr u -- ) - c-source-file-id @ ?dup-if - >r 2dup r> write-line throw - then +: write-c-prefix-line ( c-addr u -- ) + c-source-file-id @ dup if + write-line throw + else + drop 2drop + then ; + +: save-c-prefix-line1 ( c-addr u -- ) + 2dup write-c-prefix-line align here 0 , c-prefix-lines-end list-append ( c-addr u ) longstring, ; +defer save-c-prefix-line ( c-addr u -- ) +' save-c-prefix-line1 is save-c-prefix-line + : \c ( "rest-of-line" -- ) \ gforth backslash-c \G One line of C declarations for the C interface -1 parse save-c-prefix-line ; @@ -257,16 +288,38 @@ drop set-current -: parse-libcc-type ( "libcc-type" -- u ) - parse-name libcc-types search-wordlist 0= -13 and throw execute ; +\ call types +0 +const+ c-func +const+ c-val +const+ c-var +drop + +: libcc-type ( c-addr u -- u2 ) + libcc-types search-wordlist 0= -13 and throw execute ; + +: parse-libcc-type ( "libcc-type" -- u ) parse-name libcc-type ; -: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- ) - here 2 chars allot here begin +: parse-return-type ( "libcc-type" -- u ) + parse-libcc-type dup 0< -32 and throw ; + +: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- addr ) + c-func c, here + dup 2 chars allot here begin parse-libcc-type dup 0>= while c, repeat drop here swap - over char+ c! - parse-libcc-type dup 0< -32 and throw swap c! ; + parse-return-type swap c! ; + +: parse-value-type ( "{--}" "libcc-type" -- addr ) + c-val c, here + parse-libcc-type dup 0< if drop parse-return-type then + c, 0 c, ; + +: parse-variable-type ( -- addr ) + c-var c, here + s" a" libcc-type c, 0 c, ; : type-letter ( n -- c ) chars s" nadrfv" drop + c@ ; @@ -338,7 +391,7 @@ create gen-par-types \ the call itself -: gen-wrapped-call { d: pars d: c-name fp-change1 sp-change1 -- } +: gen-wrapped-func { d: pars d: c-name fp-change1 sp-change1 -- } c-name type ." (" fp-change1 sp-change1 pars over + swap u+do i c@ gen-par @@ -348,6 +401,20 @@ create gen-par-types loop 2drop ." )" ; +: gen-wrapped-const { d: pars d: c-name fp-change1 sp-change1 -- } + ." (" c-name type ." )" ; + +: gen-wrapped-var { d: pars d: c-name fp-change1 sp-change1 -- } + ." &(" c-name type ." )" ; + +create gen-call-types +' gen-wrapped-func , +' gen-wrapped-const , +' gen-wrapped-var , + +: gen-wrapped-call ( pars c-name fp-change1 sp-change1 -- ) + 5 pick 3 chars - c@ cells gen-call-types + @ execute ; + \ calls for various kinds of return values : gen-wrapped-void ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) @@ -364,7 +431,7 @@ create gen-par-types ." ," gen-par-n ." ," gen-par-n ." )" ; : gen-wrapped-r ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) - 2dup gen-par-r 2>r ." =" gen-wrapped-void 2r> ; + 2dup gen-par-r 2>r ." =" gen-wrapped-call 2r> ; : gen-wrapped-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) gen-wrapped-a ; @@ -400,7 +467,7 @@ create gen-wrapped-types dup { descriptor } count { ret } count 2dup { d: pars } chars + count { d: c-name } ." void " lib-modulename 2@ type ." _LTX_" descriptor wrapper-function-name 2dup type drop free throw - .\" (void)\n" + .\" (GFORTH_ARGS)\n" .\" {\n Cell MAYBE_UNUSED *sp = gforth_SP;\n Float MAYBE_UNUSED *fp = gforth_FP;\n " pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n" ?dup-if @@ -411,56 +478,144 @@ create gen-wrapped-types endif .\" }\n" ; -: tempdir ( -- c-addr u ) - s" TMPDIR" getenv dup 0= if - 2drop s" /tmp" - then ; +: scan-back { c-addr u1 c -- c-addr u2 } + \ the last occurence of c in c-addr u1 is at u2-1; if it does not + \ occur, u2=0. + c-addr 1- c-addr u1 + 1- u-do + i c@ c = if + c-addr i over - 1+ unloop exit endif + 1 -loop + c-addr 0 ; + +: dirname ( c-addr1 u1 -- c-addr2 u2 ) + \ directory name of the file name c-addr1 u1, including the final "/". + '/ scan-back ; + +: basename ( c-addr1 u1 -- c-addr2 u2 ) + \ file name without directory component + 2dup dirname nip /string ; : gen-filename ( x -- c-addr u ) - \ generates a filename without extension for lib-handle-addr X + \ generates a file basename for lib-handle-addr X 0 <<# ['] #s $10 base-execute #> - tempdir s" /gforth_c_" s+ 2swap append #>> ; + s" gforth_c_" 2swap s+ #>> ; + +: libcc-named-dir ( -- c-addr u ) + libcc-named-dir-v 2@ ; + +: libcc-tmp-dir ( -- c-addr u ) + s" ~/.gforth/libcc-tmp/" ; + +: prepend-dirname ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 ) + 2over s+ 2swap drop free throw ; + +: open-wrappers ( -- addr|0 ) + lib-filename 2@ s" .la" s+ + 2dup libcc-named-dir string-prefix? if ( c-addr u ) + \ see if we can open it in the path + libcc-named-dir nip /string + libcc-path open-path-file if + 0 exit endif + ( wfile-id c-addr2 u2 ) rot close-file throw save-mem ( c-addr2 u2 ) + endif + \ 2dup cr type + 2dup open-lib >r + drop free throw r> ; + +: c-library-name-setup ( c-addr u -- ) + assert( c-source-file-id @ 0= ) + { d: filename } + here 0 , lib-handle-addr ! filename lib-filename 2! + filename basename lib-modulename 2! + ['] write-c-prefix-line is save-c-prefix-line ; + +: c-library-name-create ( -- ) + lib-filename 2@ s" .c" s+ 2dup w/o create-file throw + c-source-file-id ! + drop free throw ; + +: c-named-library-name ( c-addr u -- ) + \ set up filenames for a (possibly new) library; c-addr u is the + \ basename of the library + libcc-named-dir prepend-dirname c-library-name-setup + open-wrappers dup if + lib-handle-addr @ ! + else + libcc-named-dir $1ff mkdir-parents drop + drop c-library-name-create + c-prefix-lines @ ['] print-c-prefix-line \ first line only + c-source-file-id @ outfile-execute + endif ; + +: c-tmp-library-name ( c-addr u -- ) + \ set up filenames for a new library; c-addr u is the basename of + \ the library + libcc-tmp-dir 2dup $1ff mkdir-parents drop + prepend-dirname c-library-name-setup c-library-name-create + ['] print-c-prefix-lines c-source-file-id @ outfile-execute ; + +: lib-handle ( -- addr ) + lib-handle-addr @ @ ; : init-c-source-file ( -- ) - c-source-file-id @ 0= if - here 0 , dup lib-handle-addr ! gen-filename 2dup lib-filename 2! - 2dup tempdir nip 1+ /string lib-modulename 2! - s" .c" s+ 2dup w/o create-file throw dup c-source-file-id ! - ['] print-c-prefix-lines swap outfile-execute - drop free throw + lib-handle 0= if + c-source-file-id @ 0= if + here gen-filename c-tmp-library-name + endif endif ; : c-source-file ( -- file-id ) c-source-file-id @ assert( dup ) ; +: notype-execute ( ... xt -- ... ) + what's type { oldtype } try + ['] 2drop is type execute 0 + restore + oldtype is type + endtry + throw ; + +: c-source-file-execute ( ... xt -- ... ) + \ direct the output of xt to c-source-file, or nothing + lib-handle if + notype-execute + else + c-source-file outfile-execute + endif ; + : .lib-error ( -- ) [ifdef] lib-error ['] cr stderr outfile-execute - lib-error ['] type outfile-execute + lib-error ['] type stderr outfile-execute [then] ; -DEFER compile-wrapper-function -:NONAME ( -- ) - c-source-file close-file throw - 0 c-source-file-id ! - [ libtool-command s" --silent --mode=compile gcc -I " s+ - s" includedir" getenv append ] sliteral - s" -O -c " s+ lib-filename 2@ append s" .c -o " append - lib-filename 2@ append s" .lo" append ( c-addr u ) - 2dup system drop free throw $? abort" libtool compile failed" - [ libtool-command s" --silent --mode=link gcc -module -rpath " s+ ] sliteral - tempdir s+ s" " append - lib-filename 2@ append s" .lo -o " append - lib-filename 2@ append s" .la" append ( c-addr u ) - 2dup system drop free throw $? abort" libtool link failed" - lib-filename 2@ s" .la" s+ - 2dup open-lib dup 0= if - .lib-error true abort" open-lib failed" +DEFER compile-wrapper-function ( -- ) +: compile-wrapper-function1 ( -- ) + lib-handle 0= if + c-source-file close-file throw + 0 c-source-file-id ! + [ libtool-command s" --silent --tag=CC --mode=compile " s+ + libtool-cc append s" -I '" append + s" includedir" getenv append s" '" append ] sliteral + s" -O -c " s+ lib-filename 2@ append s" .c -o " append + lib-filename 2@ append s" .lo" append ( c-addr u ) + \ 2dup type cr + 2dup system drop free throw $? abort" libtool compile failed" + [ libtool-command s" --silent --tag=CC --mode=link " s+ + libtool-cc append libtool-flags append s" -module -rpath " s+ ] sliteral + lib-filename 2@ dirname replace-rpath s+ s" " append + lib-filename 2@ append s" .lo -o " append + lib-filename 2@ append s" .la" append ( c-addr u ) + c-libs 2@ append + \ 2dup type cr + 2dup system drop free throw $? abort" libtool link failed" + open-wrappers dup 0= if + .lib-error true abort" open-lib failed" + endif + ( lib-handle ) lib-handle-addr @ ! endif - ( lib-handle ) lib-handle-addr @ ! - 2dup delete-file throw drop free throw - lib-filename 2@ s" .c" s+ 2dup delete-file throw drop free throw - lib-filename 2@ drop free throw 0 0 lib-filename 2! ; IS compile-wrapper-function + lib-filename 2@ drop free throw 0 0 lib-filename 2! ; +' compile-wrapper-function1 IS compile-wrapper-function \ s" ar rcs xxx.a xxx.o" system \ $? abort" ar generated error" ; @@ -471,13 +626,13 @@ DEFER compile-wrapper-function endif wrapper-name drop free throw ; -: c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- ) +: c-function-ft ( xt-defr xt-cfr xt-parse "c-name" "type signature" -- ) \ build time/first time action for c-function - init-c-source-file + { xt-parse-types } init-c-source-file noname create 2, lib-handle-addr @ , parse-name { d: c-name } - here parse-function-types c-name string, - ['] gen-wrapper-function c-source-file outfile-execute + xt-parse-types execute c-name string, + ['] gen-wrapper-function c-source-file-execute does> ( ... -- ... ) dup 2@ { xt-defer xt-cfr } dup cff-lha @ @ 0= if @@ -494,8 +649,65 @@ DEFER compile-wrapper-function does> ( ... -- ... ) @ call-c ; -: c-function ( "forth-name" "c-name" "@{type@}" "--" "type" -- ) \ gforth +: (c-function) ( xt-parse "forth-name" "c-name" "{stack effect}" -- ) + { xt-parse-types } defer lastxt dup c-function-rt + lastxt xt-parse-types c-function-ft + lastxt swap defer! ; + +: c-function ( "forth-name" "c-name" "@{type@}" "---" "type" -- ) \ gforth \G Define a Forth word @i{forth-name}. @i{Forth-name} has the \G specified stack effect and calls the C function @code{c-name}. - defer lastxt dup c-function-rt lastxt c-function-ft - lastxt swap defer! ; + ['] parse-function-types (c-function) ; + +: c-value ( "forth-name" "c-name" "[---]" "type" -- ) \ gforth + \G Define a Forth word @i{forth-name}. @i{Forth-name} has the + \G specified stack effect and gives the C value of @code{c-name}. + ['] parse-value-type (c-function) ; + +: c-variable ( "forth-name" "c-name" -- ) \ gforth + \G Define a Forth word @i{forth-name}. @i{Forth-name} returns the + \G address of @code{c-name}. + ['] parse-variable-type (c-function) ; + +: clear-libs ( -- ) \ gforth +\G Clear the list of libs + c-source-file-id @ if + compile-wrapper-function + endif + 0. c-libs 2! ; +clear-libs + +: c-library-incomplete ( -- ) + true abort" Called function of unfinished named C library" ; + +: c-library-name ( c-addr u -- ) \ gforth +\G Start a C library interface with name @i{c-addr u}. + clear-libs + ['] c-library-incomplete is compile-wrapper-function + c-named-library-name ; + +: c-library ( "name" -- ) \ gforth +\G Parsing version of @code{c-library-name} + parse-name save-mem c-library-name ; + +: end-c-library ( -- ) \ gforth +\G Finish and (if necessary) build the latest C library interface. + ['] save-c-prefix-line1 is save-c-prefix-line + ['] compile-wrapper-function1 is compile-wrapper-function + compile-wrapper-function1 ; + +: init-libcc ( -- ) + s" ~/.gforth/libcc-named/" libcc-named-dir-v 2! +[IFDEF] $init + libcc-path $init + libcc-named-dir libcc-path also-path + [ s" libccdir" getenv ] sliteral libcc-path also-path +[THEN] +; + +init-libcc + +:noname ( -- ) + defers 'cold + init-libcc ; +is 'cold