Diff for /gforth/libcc.fs between versions 1.12 and 1.39

version 1.12, 2007/04/25 22:11:29 version 1.39, 2008/07/05 20:09:42
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
Line 73 Line 72
 \ 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
   
Line 82 Line 123
 \ first-time word, then to the run-time word; the run-time word calls  \ first-time word, then to the run-time word; the run-time word calls
 \ the c function.  \ 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 struct.fs
   
Line 99  struct Line 150  struct
     \  counted string: c-name      \  counted string: c-name
 end-struct cff%  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
   
   : delete-file 2drop 0 ;
   
 : .nb ( n -- )  : .nb ( n -- )
     0 .r ;      0 .r ;
Line 120  end-struct cff% Line 181  end-struct cff%
     c c-addr1 c!      c c-addr1 c!
     c-addr1 u1 1 /string ;      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  struct
     cell% field list-next      cell% field list-next
Line 146  end-struct list% Line 217  end-struct list%
             node list-next @              node list-next @
     repeat ;      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<nodelib>" to string1
       >r s"  -l" append r> c-lib-string 2@ append ;
   
 \ C prefix lines  \ C prefix lines
   
 \ linked list of longcstrings: [ link | count-cell | characters ]  \ linked list of longcstrings: [ link | count-cell | characters ]
Line 158  end-struct c-prefix% Line 248  end-struct c-prefix%
 variable c-prefix-lines 0 c-prefix-lines !  variable c-prefix-lines 0 c-prefix-lines !
 variable c-prefix-lines-end c-prefix-lines c-prefix-lines-end !  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 -- )  : print-c-prefix-line ( node -- )
     dup c-prefix-chars swap c-prefix-count @ type cr ;      dup c-prefix-chars swap c-prefix-count @ type cr ;
   
 : print-c-prefix-lines ( -- )  : print-c-prefix-lines ( -- )
     c-prefix-lines @ ['] print-c-prefix-line list-map ;      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 <gforth/" version-string s+ s" /libcc.h>" append ( c-addr u )
     2dup save-c-prefix-line drop free throw
   
 \ Types (for parsing)  \ Types (for parsing)
   
Line 299  create gen-par-types Line 394  create gen-par-types
     ." ," gen-par-n ." ," gen-par-n ." )" ;      ." ," 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 )
     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-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
     gen-wrapped-a ;      gen-wrapped-a ;
Line 333  create gen-wrapped-types Line 428  create gen-wrapped-types
 : gen-wrapper-function ( addr -- )  : gen-wrapper-function ( addr -- )
     \ addr points to the return type index of a c-function descriptor      \ addr points to the return type index of a c-function descriptor
     dup { descriptor }      dup { descriptor }
     c@+ { ret } count 2dup { d: pars } chars + count { d: c-name }      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"      .\" (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"
Line 346  create gen-wrapped-types Line 441  create gen-wrapped-types
     endif      endif
     .\" }\n" ;      .\" }\n" ;
   
 variable c-source-file-id \ contains the source file id of the current batch  : open-wrappers ( -- addr )
 0 c-source-file-id !      lib-filename 2@ s" .la" s+
 variable lib-handle-addr \ points to the library handle of the current batch.      2dup open-lib >r
                          \ the library handle is 0 if the current      drop free throw r> ;
                          \ 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 file basename for lib-handle-addr X
       0 <<# ['] #s $10 base-execute #> 
       s" gforth_c_" 2swap s+ #>> ;
   
   : prepend-dirname ( c-addr1 u1 -- c-addr2 u2 )
       tempdir s" /" s+ 2over append
       2swap drop free throw ;
   
   : c-library-name-setup ( c-addr u -- )
       assert( c-source-file-id @ 0= )
       prepend-dirname { d: filename }
       here 0 , lib-handle-addr ! filename lib-filename 2!
       filename tempdir nip 1+ /string 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-library-name1 ( c-addr u -- )
       \ set up filenames for a (possibly new) library; c-addr u is the
       \ basename of the library
       c-library-name-setup
       open-wrappers dup if
           lib-handle-addr @ !
       else
           drop c-library-name-create
       endif ;
   
   : c-library-name2 ( c-addr u -- )
       \ set up filenames for a new library; c-addr u is the basename of
       \ the library
       c-library-name-setup c-library-name-create ;
   
   : lib-handle ( -- addr )
       lib-handle-addr @ @ ;
   
 : init-c-source-file ( -- )  : init-c-source-file ( -- )
     c-source-file-id @ 0= if      lib-handle 0= if
         s" xxx.c" w/o create-file throw dup c-source-file-id !          c-source-file-id @ 0= if
         ['] print-c-prefix-lines swap outfile-execute              here gen-filename c-library-name2
         here 0 , lib-handle-addr !          endif
     endif ;      endif ;
   
 : c-source-file ( -- file-id )  : c-source-file ( -- file-id )
     c-source-file-id @ assert( dup ) ;      c-source-file-id @ assert( dup ) ;
   
 : compile-wrapper-function ( -- )  : notype-execute ( ... xt -- ... )
     c-source-file close-file throw      what's type { oldtype } try
     0 c-source-file-id !          ['] 2drop is type execute 0
     s" gcc -fPIC -shared -Wl,-soname,xxx.so.1 -Wl,-export_dynamic -o xxx.so.1 -O xxx.c" system      restore
     $? abort" compiler generated error"          oldtype is type
     s" /home/anton/gforth/xxx.so.1" open-lib dup 0= abort" open-lib failed"      endtry
     ( lib-handle ) lib-handle-addr @ ! ;      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
           tempdir 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  \    s" ar rcs xxx.a xxx.o" system
 \    $? abort" ar generated error" ;  \    $? abort" ar generated error" ;
   
 : link-wrapper-function { cff -- sym }  : link-wrapper-function { cff -- sym }
     cff cff-rtype wrapper-function-name { d: wrapper-name }      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 ;      wrapper-name drop free throw ;
   
 : c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- )  : c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- )
Line 383  variable lib-handle-addr \ points to the Line 563  variable lib-handle-addr \ points to the
     noname create 2, lib-handle-addr @ ,      noname create 2, lib-handle-addr @ ,
     parse-name { d: c-name }      parse-name { d: c-name }
     here parse-function-types c-name string,      here parse-function-types c-name string,
     ['] gen-wrapper-function c-source-file outfile-execute      ['] gen-wrapper-function c-source-file-execute
   does> ( ... -- ... )    does> ( ... -- ... )
     dup 2@ { xt-defer xt-cfr }      dup 2@ { xt-defer xt-cfr }
     dup cff-lha @ @ 0= if      dup cff-lha @ @ 0= if
Line 400  variable lib-handle-addr \ points to the Line 580  variable lib-handle-addr \ points to the
   does> ( ... -- ... )    does> ( ... -- ... )
     @ call-c ;      @ 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      defer lastxt dup c-function-rt lastxt c-function-ft
     lastxt swap defer! ;      lastxt swap defer! ;
   
 s" Library not found" exception constant err-nolib  : clear-libs ( -- )
   \G Clear the list of libs
 : library ( "name" "file" -- ) \ gforth      c-source-file-id @ if
 \G Dynamically links the library specified by @i{file}.  Defines a          compile-wrapper-function
 \G word @i{name} ( -- lib ) that starts the declaration of a      endif
 \G function from that library.      0 c-libs ! ;
     create parse-name open-lib dup 0= err-nolib and throw ,  clear-libs
   does> ( -- lib )  
     @ ;  
   
 \ test  
   
 \ test all parameter and return types  
   
 \ 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 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 #include <string.h>  
 \c #include <stdlib.h>  
   
 c-function strlen strlen a -- n  : c-library-incomplete ( -- )
 c-function labs labs n -- n      true abort" Called function of unfinished named C library" ;
   
 cr s\" fooo\0" 2dup dump drop .s strlen cr .s drop cr   : c-library-name ( c-addr u -- ) \ gforth
 -5 labs .s drop cr  \G Start a C library interface with name @i{c-addr u}.
       clear-libs
       ['] c-library-incomplete is compile-wrapper-function
       c-library-name1 ;
   
   : 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 ;

Removed from v.1.12  
changed lines
  Added in v.1.39


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>