--- gforth/libcc.fs 2007/05/29 20:44:38 1.15 +++ gforth/libcc.fs 2008/07/10 21:11:57 1.42 @@ -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 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 @@ -73,6 +72,48 @@ \ 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: + +\ 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 @@ -82,6 +123,16 @@ \ 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 @@ -104,7 +155,11 @@ 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. -2variable lib-filename \ filename without extension + 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 + +: delete-file 2drop 0 ; : .nb ( n -- ) 0 .r ; @@ -140,8 +195,6 @@ variable lib-handle-addr \ points to the \ linked list stuff (should go elsewhere) -hex - struct cell% field list-next 1 0 field list-payload @@ -164,6 +217,25 @@ end-struct list% node list-next @ repeat ; +\ linked libraries + +list% + cell% 2* field c-lib-string +end-struct c-lib% + +variable c-libs \ linked list of library names (without "lib") + +: add-lib ( c-addr u -- ) +\G Add library lib@i{string} to the list of libraries, where +\G @i{string} is represented by @i{c-addr u}. + c-lib% %size allocate throw dup >r + c-lib-string 2! + r> c-libs list-insert ; + +: append-l ( c-addr1 u1 node -- c-addr2 u2 ) + \ append " -l" to string1 + >r s" -l" append r> c-lib-string 2@ append ; + \ C prefix lines \ linked list of longcstrings: [ link | count-cell | characters ] @@ -189,10 +261,12 @@ variable c-prefix-lines-end c-prefix-lin align here 0 , c-prefix-lines-end list-append ( c-addr u ) longstring, ; -: \c ( "rest-of-line" -- ) +: \c ( "rest-of-line" -- ) \ gforth backslash-c + \G One line of C declarations for the C interface -1 parse save-c-prefix-line ; -\c #include "engine/libcc.h" +s" #include " append ( c-addr u ) + 2dup save-c-prefix-line drop free throw \ Types (for parsing) @@ -320,7 +394,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 ; @@ -355,7 +429,7 @@ create gen-wrapped-types \ 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 " descriptor wrapper-function-name 2dup type drop free throw + ." void " lib-modulename 2@ type ." _LTX_" descriptor wrapper-function-name 2dup type drop free throw .\" (void)\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" @@ -367,41 +441,151 @@ create gen-wrapped-types endif .\" }\n" ; +: 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 - 0 <<# ['] #s $10 base-execute 'x hold 'x hold 'x hold #> save-mem #>> ; + \ 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 ) + s" ~/.gforth/libcc-named/" ; + +: 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 ; + +0 value libcc-path +here 1024 dup , 0 , allot to libcc-path \ !! the path words should grow buffers dynamically +libcc-path clear-path +libcc-named-dir libcc-path also-path +\ !! setup path on boot + +: 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! ; + +: c-library-name-create ( -- ) + lib-filename 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 ; + +: 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 + drop c-library-name-create + 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 prepend-dirname c-library-name-setup c-library-name-create ; + +: 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! - 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 ) ; -: compile-wrapper-function ( -- ) - c-source-file close-file throw - 0 c-source-file-id ! - s" gcc -fPIC -shared -Wl,-soname," lib-filename 2@ s+ - s" .so.1 -Wl,-export_dynamic -o " append lib-filename 2@ append - s" .so.1 -O " append lib-filename 2@ append s" .c" append ( c-addr u ) - 2dup system drop free throw - $? abort" compiler generated error" \ !! call dlerror - s" ./" lib-filename 2@ s+ s" .so.1" append - 2dup open-lib dup 0= abort" open-lib failed" \ !! call dlerror - ( 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 +: 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 --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 ) + \ cr 2dup type + 2dup system drop free throw $? abort" libtool compile failed" + [ libtool-command s" --silent --mode=link gcc -module -rpath " s+ ] sliteral + lib-filename 2@ dirname s+ s" " append + lib-filename 2@ append s" .lo -o " append + lib-filename 2@ append s" .la" append ( c-addr u ) + c-libs @ ['] append-l list-map + \ 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 { cff -- sym } cff cff-rtype wrapper-function-name { d: wrapper-name } - wrapper-name cff cff-lha @ @ assert( dup ) lib-sym dup 0= -&32 and throw + wrapper-name cff cff-lha @ @ assert( dup ) lib-sym dup 0= if + .lib-error -&32 throw + endif wrapper-name drop free throw ; : c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- ) @@ -410,7 +594,7 @@ create gen-wrapped-types 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 + ['] gen-wrapper-function c-source-file-execute does> ( ... -- ... ) dup 2@ { xt-defer xt-cfr } dup cff-lha @ @ 0= if @@ -427,16 +611,34 @@ create gen-wrapped-types does> ( ... -- ... ) @ call-c ; -: c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- ) +: 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! ; -s" Library not found" exception constant err-nolib +: clear-libs ( -- ) +\G Clear the list of libs + c-source-file-id @ if + compile-wrapper-function + endif + 0 c-libs ! ; +clear-libs + +: c-library-incomplete ( -- ) + true abort" Called function of unfinished named C library" ; -: 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 ) - @ ; +: 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. + ['] compile-wrapper-function1 is compile-wrapper-function + compile-wrapper-function1 ;