--- gforth/libcc.fs 2007/01/14 22:19:35 1.6 +++ gforth/libcc.fs 2011/12/31 15:29:25 1.69 @@ -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,2011 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 @@ -45,20 +44,120 @@ \ the function pointer of gforth_c_lseek_ndn_d on the stack and \ calls CALL-C. -\ other things to do: +\ ToDo: -\ c-variable forth-name c-name -\ c-constant forth-name c-name +\ Batching, caching and lazy evaluation: + +\ Batching: + +\ New words are deferred, and the corresponding C functions are +\ collected in one file, until the first word is EXECUTEd; then the +\ file is compiled and linked into the system, and the word is +\ resolved. + +\ Caching: + +\ Instead of compiling all this stuff anew for every execution, we +\ keep the files around and have an index file containing the function +\ names and their corresponding .so files. If the needed wrapper name +\ is already present, it is just linked instead of generating the +\ wrapper again. This is all done by loading the index file(s?), +\ which define words for the wrappers in a separate wordlist. + +\ The files are built in .../lib/gforth/$VERSION/libcc/ or +\ ~/.gforth/libcc/$HOST/. + +\ Todo: conversion between function pointers and xts (both directions) + +\ taking an xt and turning it into a function pointer: + +\ e.g., assume we have the xt of + and want to create a C function int +\ gforth_callback_plus(int, int), and then pass the pointer to that +\ function: + +\ There should be Forth code like this: +\ ] + 0 (bye) +\ Assume that the start of this code is START + +\ Now, there should be a C function: + +\ int gforth_callback_plus(int p1, int p2) +\ { +\ Cell *sp = gforth_SP; +\ Float *fp = gforth_FP; +\ Float *fp = gforth_FP; +\ Address lp = gforth_LP; +\ sp -= 2; +\ sp[0] = p1; +\ sp[1] = p2; +\ gforth_engine(START, sp, rp, fp, lp); +\ sp += 1; +\ gforth_RP = rp; +\ gforth_SP = sp; +\ gforth_FP = fp; +\ gforth_LP = lp; +\ return sp[0]; +\ } + +\ and the pointer to that function is the C function pointer for the XT of +. + +\ Future problems: +\ how to combine the Forth code generation with inlining +\ START is not a constant across executions (when caching the C files) +\ Solution: make START a variable, and store into it on startup with dlsym + +\ Syntax: +\ callback -- \ data structures -\ c-function word body: -\ cell function pointer -\ char return type index -\ char parameter count n -\ char*n parameters (type indices) -\ counted string: c-name +\ For every c-function, we have three words: two anonymous words +\ created by c-function-ft (first time) and c-function-rt (run-time), +\ and a named deferred word. The deferred word first points to the +\ first-time word, then to the run-time word; the run-time word calls +\ the c function. + +[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 + +\ 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 + \ counted string: c-name +end-struct cff% + +variable c-source-file-id \ contains the source file id of the current batch +0 c-source-file-id ! +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 ; @@ -66,11 +165,33 @@ : const+ ( n1 "name" -- n2 ) dup constant 1+ ; -\ linked list stuff (should go elsewhere) +: front-string { c-addr1 u1 c-addr2 u2 -- c-addr3 u3 } + \ insert string c-addr2 u2 in buffer c-addr1 u1; c-addr3 u3 is the + \ remainder of the buffer. + assert( u1 u2 u>= ) + c-addr2 c-addr1 u2 move + c-addr1 u1 u2 /string ; + +: front-char { c-addr1 u1 c -- c-addr3 u2 } + \ insert c in buffer c-addr1 u1; c-addr3 u3 is the remainder of + \ the buffer. + assert( u1 0 u> ) + c c-addr1 c! + c-addr1 u1 1 /string ; + +: s+ { addr1 u1 addr2 u2 -- addr u } + u1 u2 + allocate throw { addr } + addr1 addr u1 move + addr2 addr u1 + u2 move + addr u1 u2 + +; -hex +: append { addr1 u1 addr2 u2 -- addr u } + addr1 u1 u2 + dup { u } resize throw { addr } + addr2 addr u1 + u2 move + addr u ; -require struct.fs +\ linked list stuff (should go elsewhere) struct cell% field list-next @@ -94,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 ] @@ -106,22 +241,33 @@ end-struct c-prefix% variable c-prefix-lines 0 c-prefix-lines ! variable c-prefix-lines-end c-prefix-lines c-prefix-lines-end ! -: save-c-prefix-line ( c-addr u -- ) - align here 0 , c-prefix-lines-end list-append ( c-addr u ) - longstring, ; - -: \c ( "rest-of-line" -- ) - -1 parse save-c-prefix-line ; - : print-c-prefix-line ( node -- ) dup c-prefix-chars swap c-prefix-count @ type cr ; : print-c-prefix-lines ( -- ) c-prefix-lines @ ['] print-c-prefix-line list-map ; -\c #include "engine/libcc.h" +: 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 -print-c-prefix-lines +: \c ( "rest-of-line" -- ) \ gforth backslash-c + \G One line of C declarations for the C interface + -1 parse save-c-prefix-line ; + +s" #include " append ( c-addr u ) + 2dup save-c-prefix-line drop free throw \ Types (for parsing) @@ -142,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 -: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- ) - here 2 chars allot here begin +: 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-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@ ; @@ -223,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 @@ -233,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 ) @@ -249,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 ; @@ -265,15 +447,27 @@ create gen-wrapped-types : gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change ) cells gen-wrapped-types + @ execute ; -: gen-wrapper-function ( addr -- ) +: wrapper-function-name ( addr -- c-addr u ) \ addr points to the return type index of a c-function descriptor - c@+ { ret } count 2dup { d: pars } chars + count { d: c-name } - print-c-prefix-lines - ." void gforth_c_" c-name type ." _" + count { r-type } count { d: pars } + pars + count { d: c-name } + s" gforth_c_" { d: prefix } + prefix nip c-name nip + pars nip + 3 + { u } + u allocate throw { c-addr } + c-addr u + prefix front-string c-name front-string '_ front-char pars bounds u+do - i c@ type-letter emit + i c@ type-letter front-char loop - ." _" ret type-letter emit .\" (void)\n" + '_ front-char r-type type-letter front-char assert( dup 0= ) + 2drop c-addr u ; + +: gen-wrapper-function ( addr -- ) + \ addr points to the return type index of a c-function descriptor + 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 + .\" (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 @@ -284,67 +478,236 @@ create gen-wrapped-types endif .\" }\n" ; -: compile-wrapper-function ( -- ) - s" gcc -fPIC -shared -Wl,-soname,xxx.so.1 -Wl,-export_dynamic -o xxx.so.1 -O xxx.c" system - $? abort" compiler generated error" ; +: 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 file basename for lib-handle-addr X + 0 <<# ['] #s $10 base-execute #> + 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 ( -- ) + 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 stderr outfile-execute + [then] ; + +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-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" ; -: link-wrapper-function ( -- ) - s" /home/anton/gforth/xxx.so.1" open-lib ( lib-handle ) - s" gforth_c_strlen_a_n" rot lib-sym dup 0= -32 and throw ; +: link-wrapper-function { cff -- sym } + cff cff-rtype wrapper-function-name { d: wrapper-name } + wrapper-name cff cff-lha @ @ assert( dup ) lib-sym dup 0= if + .lib-error -&32 throw + endif + wrapper-name drop free throw ; -: c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- ) - create here >r 0 , \ place for the wrapper function pointer +: c-function-ft ( xt-defr xt-cfr xt-parse "c-name" "type signature" -- ) + \ build time/first time action for c-function + { xt-parse-types } init-c-source-file + noname create 2, lib-handle-addr @ , parse-name { d: c-name } - parse-function-types c-name string, - r@ cell+ - s" xxx.c" w/o create-file throw ( file-id ) - dup >r >outfile gen-wrapper-function outfile< - r> close-file throw - compile-wrapper-function - link-wrapper-function - r> ! + 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 + compile-wrapper-function + endif + link-wrapper-function xt-cfr >body ! + xt-cfr xt-defer defer! + xt-cfr execute ; + +: c-function-rt ( -- ) + \ run-time definition for c function; addr is the address where + \ the sym should be stored + noname create 0 , does> ( ... -- ... ) @ call-c ; +: (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}. + ['] 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 -s" Library not found" exception constant err-nolib - -: library ( "name" "file" -- ) \ gforth -\G Dynamically links the library specified by @i{file}. Defines a -\G word @i{name} ( -- lib ) that starts the declaration of a -\G function from that library. - create parse-name open-lib dup 0= err-nolib and throw , - does> ( -- lib ) - @ ; - -\ test - -\ test all parameter and return types - -\ cr .( #include "engine/libcc.h") -\ cr .( #include ) -\ cr ." typedef void (* func)(int); -\ cr ." int test1(int,char*,long,double,void (*)(int));" -\ cr ." Cell *test2(void);" -\ cr ." int test3(void);" -\ cr ." float test4(void);" -\ cr ." func test5(void);" -\ cr ." void test6(void);" -\ cr - -\ c-function dlseek lseek n d n -- d -\ c-function n test1 n a d r func -- n -\ c-function a test2 -- a -\ c-function d test3 -- d -\ c-function r test4 -- r -\ c-function func test5 -- func -\ c-function void test6 -- void - -c-function strlen strlen a -- n - -cr s\" fooo\0" 2dup dump drop .s strlen cr .s cr +:noname ( -- ) + defers 'cold + init-libcc ; +is 'cold