Diff for /gforth/libcc.fs between versions 1.17 and 1.57

version 1.17, 2007/06/01 16:27:37 version 1.57, 2008/11/01 19:21:07
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,2008 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
   require mkdir.fs
   
     \ counted-string  
       
 \ c-function-ft word body:  \ c-function-ft word body:
 struct  struct
     cell% field cff-cfr \ xt of c-function-rt word      cell% field cff-cfr \ xt of c-function-rt word
Line 104  variable c-source-file-id \ contains the Line 154  variable c-source-file-id \ contains the
 variable lib-handle-addr \ points to the library handle of the current batch.  variable lib-handle-addr \ points to the library handle of the current batch.
                          \ the library handle is 0 if the current                           \ the library handle is 0 if the current
                          \ batch is not yet compiled.                           \ 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
   2variable libcc-named-dir-v \ directory for named libcc wrapper libraries
   0 value libcc-path       \ pointer to path of library directories
   
   defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 )
   ' noop is replace-rpath
   
 : .nb ( n -- )  : .nb ( n -- )
     0 .r ;      0 .r ;
Line 162  end-struct list% Line 219  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 -- ) \ gforth
   \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 187  variable c-prefix-lines-end c-prefix-lin Line 263  variable c-prefix-lines-end c-prefix-lin
     align here 0 , c-prefix-lines-end list-append ( c-addr u )      align here 0 , c-prefix-lines-end list-append ( c-addr u )
     longstring, ;      longstring, ;
   
 : \c ( "rest-of-line" -- )  : \c ( "rest-of-line" -- ) \ gforth backslash-c
     \G One line of C declarations for the C interface      \G One line of C declarations for the C interface
     -1 parse save-c-prefix-line ;      -1 parse save-c-prefix-line ;
   
 \c #include "engine/libcc.h"  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 319  create gen-par-types Line 396  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 354  create gen-wrapped-types Line 431  create gen-wrapped-types
     \ 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 }
     count { 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"      .\" (GFORTH_ARGS)\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 366  create gen-wrapped-types Line 443  create gen-wrapped-types
     endif      endif
     .\" }\n" ;      .\" }\n" ;
   
 : tempdir ( -- c-addr u )  : scan-back { c-addr u1 c -- c-addr u2 }
     s" TMPDIR" getenv dup 0= if      \ the last occurence of c in c-addr u1 is at u2-1; if it does not
         2drop s" /tmp"      \ occur, u2=0.
     then ;      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 )  : gen-filename ( x -- c-addr u )
     \ generates a filename without extension for lib-handle-addr X      \ generates a file basename for lib-handle-addr X
     0 <<# ['] #s $10 base-execute #>       0 <<# ['] #s $10 base-execute #> 
     tempdir s" /gforth-c-" s+ 2swap append #>> ;      s" gforth_c_" 2swap s+ #>> ;
   
   : libcc-named-dir ( -- c-addr u )
       libcc-named-dir-v 2@ ;
   
   : 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 ;
   
   : 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
           libcc-named-dir $1ff mkdir-parents drop
           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 2dup $1ff mkdir-parents drop
       prepend-dirname 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
         here 0 , dup lib-handle-addr ! gen-filename 2dup lib-filename 2!          c-source-file-id @ 0= if
         s" .c" s+ 2dup w/o create-file throw dup c-source-file-id !              here gen-filename c-tmp-library-name
         ['] print-c-prefix-lines swap outfile-execute          endif
         drop free throw  
     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 -I. -fPIC -shared -Wl,-soname," lib-filename 2@ s+      restore
     s" .so.1 -Wl,-export_dynamic -o " append lib-filename 2@ append          oldtype is type
     s" .so.1 -O " append lib-filename 2@ append s" .c" append ( c-addr u )      endtry
     2dup system drop free throw      throw ;
     $? abort" compiler generated error" \ !! call dlerror  
     lib-filename 2@ s" .so.1" s+  : c-source-file-execute ( ... xt -- ... )
     2dup open-lib dup 0= abort" open-lib failed" \ !! call dlerror      \ direct the output of xt to c-source-file, or nothing
     ( lib-handle ) lib-handle-addr @ !      lib-handle if
     2dup delete-file throw drop free throw          notype-execute
     lib-filename 2@ s" .c" s+ 2dup delete-file throw drop free throw      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 " s+
             libtool-cc append s"  -I " append
             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 type cr
           2dup system drop free throw $? abort" libtool compile failed"
           [ libtool-command s"  --silent --mode=link " s+
             libtool-cc append libtool-flags append s"  -module -rpath " s+ ] sliteral
           lib-filename 2@ dirname replace-rpath 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! ;      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 415  create gen-wrapped-types Line 594  create gen-wrapped-types
     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 432  create gen-wrapped-types Line 611  create gen-wrapped-types
   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 Define a Forth word @i{forth-name}.  @i{Forth-name} has the
     \G specified stack effect and calls the C function @code{c-name}.      \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! ;
   
   : clear-libs ( -- ) \ gforth
   \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" ;
   
   : 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 ;
   
   : init-libcc ( -- )
       s" ~/.gforth/libcc-named/" libcc-named-dir-v 2!
   [IFDEF] make-path
       make-path to libcc-path
       libcc-named-dir libcc-path also-path
       [ s" libccdir" getenv ] sliteral libcc-path also-path
   [THEN]
   ;
   
   init-libcc
   
   :noname ( -- )
       defers 'cold
       init-libcc ;
   is 'cold

Removed from v.1.17  
changed lines
  Added in v.1.57


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