--- gforth/libcc.fs 2007/01/14 22:19:35 1.6 +++ gforth/libcc.fs 2007/06/01 16:27:37 1.17 @@ -45,6 +45,29 @@ \ the function pointer of gforth_c_lseek_ndn_d on the stack and \ 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: \ c-variable forth-name c-name @@ -53,12 +76,35 @@ \ 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. + + +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 : .nb ( n -- ) 0 .r ; @@ -66,11 +112,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 @@ -106,23 +174,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 ! +: 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" -- ) + \G One line of C declarations for the C interface -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" -print-c-prefix-lines - \ Types (for parsing) wordlist constant libcc-types @@ -265,15 +335,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 " 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" ?dup-if @@ -284,67 +366,74 @@ create gen-wrapped-types endif .\" }\n" ; +: 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 + 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 + endif ; + +: c-source-file ( -- file-id ) + c-source-file-id @ assert( dup ) ; + : 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" ; + c-source-file close-file throw + 0 c-source-file-id ! + s" gcc -I. -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 + lib-filename 2@ s" .so.1" s+ + 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 + lib-filename 2@ drop free throw 0 0 lib-filename 2! ; \ 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 ; - -: c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- ) - create here >r 0 , \ place for the wrapper function pointer +: 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 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-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> ! + here parse-function-types c-name string, + ['] gen-wrapper-function c-source-file outfile-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 ; - - - - -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 +: c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- ) + \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! ;