--- gforth/libcc.fs 2007/05/28 09:43:34 1.13 +++ gforth/libcc.fs 2008/02/12 20:28:51 1.30 @@ -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 @@ -99,6 +150,13 @@ struct \ 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. +2variable lib-filename \ filename without extension +2variable lib-modulename \ basename of the file without extension : .nb ( n -- ) 0 .r ; @@ -120,9 +178,19 @@ end-struct cff% c c-addr1 c! c-addr1 u1 1 /string ; -\ linked list stuff (should go elsewhere) +: 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 ; + +\ linked list stuff (should go elsewhere) struct cell% field list-next @@ -158,20 +226,25 @@ 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" +: save-c-prefix-line ( c-addr u -- ) + c-source-file-id @ ?dup-if + >r 2dup r> write-line throw + then + align here 0 , c-prefix-lines-end list-append ( c-addr u ) + longstring, ; + +: \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) @@ -299,7 +372,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 ; @@ -334,7 +407,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" @@ -346,35 +419,64 @@ create gen-wrapped-types endif .\" }\n" ; -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. +: tempdir ( -- c-addr u ) + s" TMPDIR" getenv dup 0= if + 2drop s" /tmp" + then ; + +: gen-filename ( x -- c-addr u ) + \ generates a filename without extension for lib-handle-addr X + 0 <<# ['] #s $10 base-execute #> + tempdir s" /gforth_c_" s+ 2swap append #>> ; : init-c-source-file ( -- ) c-source-file-id @ 0= if - s" xxx.c" w/o create-file throw dup c-source-file-id ! - ['] print-c-prefix-lines swap outfile-execute - here 0 , lib-handle-addr ! + 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 endif ; : c-source-file ( -- file-id ) c-source-file-id @ assert( dup ) ; -: compile-wrapper-function ( -- ) +: .lib-error ( -- ) + [ifdef] lib-error + ['] cr stderr outfile-execute + lib-error ['] type outfile-execute + [then] ; + +DEFER compile-wrapper-function +:NONAME ( -- ) c-source-file close-file throw 0 c-source-file-id ! - s" gcc -fPIC -shared -Wl,-soname,xxx.so.1 -Wl,-export_dynamic -o xxx.so.1 -O xxx.c" system - $? abort" compiler generated error" - s" /home/anton/gforth/xxx.so.1" open-lib dup 0= abort" open-lib failed" - ( lib-handle ) lib-handle-addr @ ! ; + [ 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" + 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 \ 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" -- ) @@ -400,16 +502,8 @@ variable lib-handle-addr \ points to the 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 - -: 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 ) - @ ;