version 1.4, 2006/12/27 18:52:17
|
version 1.28, 2007/12/31 18:40:24
|
Line 1
|
Line 1
|
\ libcc.fs foreign function interface implemented using a C compiler |
\ 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. |
\ This file is part of Gforth. |
|
|
\ Gforth is free software; you can redistribute it and/or |
\ Gforth is free software; you can redistribute it and/or |
\ modify it under the terms of the GNU General Public License |
\ 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. |
\ of the License, or (at your option) any later version. |
|
|
\ This program is distributed in the hope that it will be useful, |
\ This program is distributed in the hope that it will be useful, |
Line 15
|
Line 15
|
\ GNU General Public License for more details. |
\ GNU General Public License for more details. |
|
|
\ You should have received a copy of the GNU General Public License |
\ You should have received a copy of the GNU General Public License |
\ along with this program; if not, write to the Free Software |
\ along with this program. If not, see http://www.gnu.org/licenses/. |
\ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. |
|
|
|
|
|
\ What this implementation does is this: if it sees a declaration like |
\ What this implementation does is this: if it sees a declaration like |
|
|
\ \ something that tells it to include <unistd.h> |
|
\ \ something that tells it that the current library is libc |
\ \ something that tells it that the current library is libc |
|
\ \c #include <unistd.h> |
\ c-function dlseek lseek n d n -- d |
\ c-function dlseek lseek n d n -- d |
|
|
\ it genererates C code similar to the following: |
\ it genererates C code similar to the following: |
Line 46
|
Line 44
|
\ the function pointer of gforth_c_lseek_ndn_d on the stack and |
\ the function pointer of gforth_c_lseek_ndn_d on the stack and |
\ calls CALL-C. |
\ calls CALL-C. |
|
|
|
\ ToDo: |
|
|
|
\ 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/. |
|
|
\ other things to do: |
\ other things to do: |
|
|
\ c-variable forth-name c-name |
\ c-variable forth-name c-name |
\ c-constant 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 <rettype> <params> <paramtypes> -- <rettype> |
|
|
|
|
\ data structures |
\ data structures |
|
|
\ c-function word body: |
\ For every c-function, we have three words: two anonymous words |
\ cell function pointer |
\ created by c-function-ft (first time) and c-function-rt (run-time), |
\ char return type index |
\ and a named deferred word. The deferred word first points to the |
\ char parameter count n |
\ first-time word, then to the run-time word; the run-time word calls |
\ char*n parameters (type indices) |
\ the c function. |
\ counted string: c-name |
|
|
: delete-file 2drop 0 ; |
|
|
|
require struct.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-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. |
|
2variable lib-filename \ filename without extension |
|
2variable lib-modulename \ basename of the file without extension |
|
|
: .nb ( n -- ) |
: .nb ( n -- ) |
0 .r ; |
0 .r ; |
Line 67
|
Line 155
|
: const+ ( n1 "name" -- n2 ) |
: const+ ( n1 "name" -- n2 ) |
dup constant 1+ ; |
dup constant 1+ ; |
|
|
|
: 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 + |
|
; |
|
|
|
: 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 |
|
1 0 field list-payload |
|
end-struct list% |
|
|
|
: list-insert { node list -- } |
|
list list-next @ node list-next ! |
|
node list list-next ! ; |
|
|
|
: list-append { node endlistp -- } |
|
\ insert node at place pointed to by endlistp |
|
node endlistp @ list-insert |
|
node list-next endlistp ! ; |
|
|
|
: list-map ( ... list xt -- ... ) |
|
\ xt ( ... node -- ... ) |
|
{ xt } begin { node } |
|
node while |
|
node xt execute |
|
node list-next @ |
|
repeat ; |
|
|
|
\ C prefix lines |
|
|
|
\ linked list of longcstrings: [ link | count-cell | characters ] |
|
|
|
list% |
|
cell% field c-prefix-count |
|
1 0 field c-prefix-chars |
|
end-struct c-prefix% |
|
|
|
variable c-prefix-lines 0 c-prefix-lines ! |
|
variable c-prefix-lines-end c-prefix-lines c-prefix-lines-end ! |
|
|
|
: 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 ; |
|
|
|
: 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 <gforth/" version-string s+ s" /libcc.h>" append ( c-addr u ) |
|
2dup save-c-prefix-line drop free throw |
|
|
|
\ Types (for parsing) |
|
|
wordlist constant libcc-types |
wordlist constant libcc-types |
|
|
get-current libcc-types set-current |
get-current libcc-types set-current |
Line 75 get-current libcc-types set-current
|
Line 247 get-current libcc-types set-current
|
-1 |
-1 |
const+ -- \ end of arguments |
const+ -- \ end of arguments |
const+ n \ integer cell |
const+ n \ integer cell |
const+ p \ pointer cell |
const+ a \ address cell |
const+ d \ double |
const+ d \ double |
const+ r \ float |
const+ r \ float |
const+ func \ C function pointer |
const+ func \ C function pointer |
Line 96 set-current
|
Line 268 set-current
|
parse-libcc-type dup 0< -32 and throw swap c! ; |
parse-libcc-type dup 0< -32 and throw swap c! ; |
|
|
: type-letter ( n -- c ) |
: type-letter ( n -- c ) |
chars s" npdrfv" drop + c@ ; |
chars s" nadrfv" drop + c@ ; |
|
|
\ count-stacks |
\ count-stacks |
|
|
: count-stacks-n ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
: count-stacks-n ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
1+ ; |
1+ ; |
|
|
: count-stacks-p ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
: count-stacks-a ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
1+ ; |
1+ ; |
|
|
: count-stacks-d ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
: count-stacks-d ( fp-change1 sp-change1 -- fp-change2 sp-change2 ) |
Line 120 set-current
|
Line 292 set-current
|
|
|
create count-stacks-types |
create count-stacks-types |
' count-stacks-n , |
' count-stacks-n , |
' count-stacks-p , |
' count-stacks-a , |
' count-stacks-d , |
' count-stacks-d , |
' count-stacks-r , |
' count-stacks-r , |
' count-stacks-func , |
' count-stacks-func , |
Line 135 create count-stacks-types
|
Line 307 create count-stacks-types
|
\ gen-pars |
\ gen-pars |
|
|
: gen-par-n ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
: gen-par-n ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
1- dup ." sp[" .nb ." ]" ; |
." sp[" 1- dup .nb ." ]" ; |
|
|
: gen-par-p ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
: gen-par-a ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
." (void *)(" gen-par-n ." )" ; |
." (void *)(" gen-par-n ." )" ; |
|
|
: gen-par-d ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
: gen-par-d ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
Line 147 create count-stacks-types
|
Line 319 create count-stacks-types
|
swap 1- tuck ." fp[" .nb ." ]" ; |
swap 1- tuck ." fp[" .nb ." ]" ; |
|
|
: gen-par-func ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
: gen-par-func ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
gen-par-p ; |
gen-par-a ; |
|
|
: gen-par-void ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
: gen-par-void ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 ) |
-32 throw ; |
-32 throw ; |
|
|
create gen-par-types |
create gen-par-types |
' gen-par-n , |
' gen-par-n , |
' gen-par-p , |
' gen-par-a , |
' gen-par-d , |
' gen-par-d , |
' gen-par-r , |
' gen-par-r , |
' gen-par-func , |
' gen-par-func , |
Line 181 create gen-par-types
|
Line 353 create gen-par-types
|
2dup 2>r gen-wrapped-call 2r> ; |
2dup 2>r gen-wrapped-call 2r> ; |
|
|
: gen-wrapped-n ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-n ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
1- dup ." sp[" .nb ." ]=" gen-wrapped-void ; |
2dup gen-par-n 2>r ." =" gen-wrapped-call 2r> ; |
|
|
: gen-wrapped-p ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-a ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
1- dup ." sp[" .nb ." ]=(Cell)" gen-wrapped-void ; |
2dup gen-par-n 2>r ." =(Cell)" gen-wrapped-call 2r> ; |
|
|
: gen-wrapped-d ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-d ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
." gforth_ll2d(" gen-wrapped-void |
." gforth_ll2d(" gen-wrapped-void |
." ,sp[" 1- dup .nb ." ],sp[" 1- dup .nb ." ])" ; |
." ," gen-par-n ." ," gen-par-n ." )" ; |
|
|
: gen-wrapped-r ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-r ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
swap 1- tuck ." fp[" .nb ." ]=" gen-wrapped-void ; |
2dup gen-par-r 2>r ." =" gen-wrapped-void 2r> ; |
|
|
: gen-wrapped-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
gen-wrapped-p ; |
gen-wrapped-a ; |
|
|
create gen-wrapped-types |
create gen-wrapped-types |
' gen-wrapped-n , |
' gen-wrapped-n , |
' gen-wrapped-p , |
' gen-wrapped-a , |
' gen-wrapped-d , |
' gen-wrapped-d , |
' gen-wrapped-r , |
' gen-wrapped-r , |
' gen-wrapped-func , |
' gen-wrapped-func , |
Line 207 create gen-wrapped-types
|
Line 379 create gen-wrapped-types
|
: gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change ) |
: gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change ) |
cells gen-wrapped-types + @ execute ; |
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 |
\ addr points to the return type index of a c-function descriptor |
c@+ { ret } count 2dup { d: pars } chars + count { d: c-name } |
count { r-type } count { d: pars } |
." void gforth_c_" c-name type ." _" |
pars + count { d: c-name } |
pars 0 +do |
s" gforth_c_" { d: prefix } |
i chars over + c@ type-letter emit |
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 front-char |
loop |
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 |
|
.\" (void)\n" |
.\" {\n Cell MAYBE_UNUSED *sp = gforth_SP;\n Float MAYBE_UNUSED *fp = gforth_FP;\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" |
pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n" |
?dup-if |
?dup-if |
Line 225 create gen-wrapped-types
|
Line 410 create gen-wrapped-types
|
endif |
endif |
.\" }\n" ; |
.\" }\n" ; |
|
|
: c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- ) |
: tempdir ( -- c-addr u ) |
create here >r 0 , \ place for the wrapper function pointer |
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 |
|
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 ) ; |
|
|
|
: .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 ! |
|
[ 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= if |
|
.lib-error -&32 throw |
|
endif |
|
wrapper-name drop free throw ; |
|
|
|
: c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- ) |
|
\ build time/first time action for c-function |
|
init-c-source-file |
|
noname create 2, lib-handle-addr @ , |
parse-name { d: c-name } |
parse-name { d: c-name } |
parse-function-types c-name string, |
here parse-function-types c-name string, |
r> cell+ gen-wrapper-function |
['] gen-wrapper-function c-source-file outfile-execute |
\ compile-wrapper-function |
does> ( ... -- ... ) |
\ link-wrapper-function |
dup 2@ { xt-defer xt-cfr } |
\ r> ! |
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> ( ... -- ... ) |
does> ( ... -- ... ) |
@ call-c ; |
@ call-c ; |
|
|
|
: 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 |
s" Library not found" exception constant err-nolib |
lastxt swap defer! ; |
|
|
: 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 |
|
|
|
cr .( #include "engine/libcc.h") |
|
cr .( #include <unistd.h>) |
|
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 p d r func -- n |
|
c-function p test2 -- p |
|
c-function d test3 -- d |
|
c-function r test4 -- r |
|
c-function func test5 -- func |
|
c-function void test6 -- void |
|