Annotation of gforth/libcc.fs, revision 1.15
1.1 anton 1: \ libcc.fs foreign function interface implemented using a C compiler
2:
3: \ Copyright (C) 2006 Free Software Foundation, Inc.
4:
5: \ This file is part of Gforth.
6:
7: \ Gforth is free software; you can redistribute it and/or
8: \ modify it under the terms of the GNU General Public License
9: \ as published by the Free Software Foundation; either version 2
10: \ of the License, or (at your option) any later version.
11:
12: \ This program is distributed in the hope that it will be useful,
13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: \ GNU General Public License for more details.
16:
17: \ You should have received a copy of the GNU General Public License
18: \ along with this program; if not, write to the Free Software
19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
20:
21:
22: \ What this implementation does is this: if it sees a declaration like
23:
1.2 anton 24: \ \ something that tells it that the current library is libc
1.6 anton 25: \ \c #include <unistd.h>
1.2 anton 26: \ c-function dlseek lseek n d n -- d
1.1 anton 27:
28: \ it genererates C code similar to the following:
29:
30: \ #include <gforth.h>
1.2 anton 31: \ #include <unistd.h>
1.1 anton 32: \
1.2 anton 33: \ void gforth_c_lseek_ndn_d(void)
1.1 anton 34: \ {
35: \ Cell *sp = gforth_SP;
36: \ Float *fp = gforth_FP;
1.2 anton 37: \ long long result; /* longest type in C */
38: \ gforth_ll2d(lseek(sp[3],gforth_d2ll(sp[2],sp[1]),sp[0]),sp[3],sp[2]);
39: \ gforth_SP = sp+2;
1.1 anton 40: \ }
41:
42: \ Then it compiles this code and dynamically links it into the Gforth
43: \ system (batching and caching are future work). It also dynamically
44: \ links lseek. Performing DLSEEK then puts the function pointer of
1.2 anton 45: \ the function pointer of gforth_c_lseek_ndn_d on the stack and
46: \ calls CALL-C.
47:
1.7 anton 48: \ ToDo:
49:
50: \ Batching, caching and lazy evaluation:
51:
52: \ Batching:
53:
54: \ New words are deferred, and the corresponding C functions are
55: \ collected in one file, until the first word is EXECUTEd; then the
56: \ file is compiled and linked into the system, and the word is
57: \ resolved.
58:
59: \ Caching:
60:
61: \ Instead of compiling all this stuff anew for every execution, we
62: \ keep the files around and have an index file containing the function
63: \ names and their corresponding .so files. If the needed wrapper name
64: \ is already present, it is just linked instead of generating the
65: \ wrapper again. This is all done by loading the index file(s?),
66: \ which define words for the wrappers in a separate wordlist.
67:
68: \ The files are built in .../lib/gforth/$VERSION/libcc/ or
69: \ ~/.gforth/libcc/$HOST/.
70:
1.2 anton 71: \ other things to do:
72:
73: \ c-variable forth-name c-name
74: \ c-constant forth-name c-name
75:
76:
77: \ data structures
78:
1.10 anton 79: \ For every c-function, we have three words: two anonymous words
80: \ created by c-function-ft (first time) and c-function-rt (run-time),
81: \ and a named deferred word. The deferred word first points to the
82: \ first-time word, then to the run-time word; the run-time word calls
83: \ the c function.
84:
1.12 anton 85:
86: require struct.fs
87:
88: \ counted-string
89:
1.10 anton 90: \ c-function-ft word body:
1.12 anton 91: struct
92: cell% field cff-cfr \ xt of c-function-rt word
93: cell% field cff-deferred \ xt of c-function deferred word
94: cell% field cff-lha \ address of the lib-handle for the lib that
95: \ contains the wrapper function of the word
96: char% field cff-rtype \ return type
97: char% field cff-np \ number of parameters
98: 1 0 field cff-ptypes \ #npar parameter types
99: \ counted string: c-name
100: end-struct cff%
101:
1.14 anton 102: variable c-source-file-id \ contains the source file id of the current batch
103: 0 c-source-file-id !
104: variable lib-handle-addr \ points to the library handle of the current batch.
105: \ the library handle is 0 if the current
106: \ batch is not yet compiled.
1.15 ! anton 107: 2variable lib-filename \ filename without extension
1.2 anton 108:
1.3 anton 109: : .nb ( n -- )
1.2 anton 110: 0 .r ;
111:
112: : const+ ( n1 "name" -- n2 )
113: dup constant 1+ ;
114:
1.10 anton 115: : front-string { c-addr1 u1 c-addr2 u2 -- c-addr3 u3 }
116: \ insert string c-addr2 u2 in buffer c-addr1 u1; c-addr3 u3 is the
117: \ remainder of the buffer.
118: assert( u1 u2 u>= )
119: c-addr2 c-addr1 u2 move
120: c-addr1 u1 u2 /string ;
121:
122: : front-char { c-addr1 u1 c -- c-addr3 u2 }
123: \ insert c in buffer c-addr1 u1; c-addr3 u3 is the remainder of
124: \ the buffer.
125: assert( u1 0 u> )
126: c c-addr1 c!
127: c-addr1 u1 1 /string ;
128:
1.15 ! anton 129: : s+ { addr1 u1 addr2 u2 -- addr u }
! 130: u1 u2 + allocate throw { addr }
! 131: addr1 addr u1 move
! 132: addr2 addr u1 + u2 move
! 133: addr u1 u2 +
! 134: ;
! 135:
! 136: : append { addr1 u1 addr2 u2 -- addr u }
! 137: addr1 u1 u2 + dup { u } resize throw { addr }
! 138: addr2 addr u1 + u2 move
! 139: addr u ;
! 140:
1.6 anton 141: \ linked list stuff (should go elsewhere)
142:
143: hex
144:
145: struct
146: cell% field list-next
147: 1 0 field list-payload
148: end-struct list%
149:
150: : list-insert { node list -- }
151: list list-next @ node list-next !
152: node list list-next ! ;
153:
154: : list-append { node endlistp -- }
155: \ insert node at place pointed to by endlistp
156: node endlistp @ list-insert
157: node list-next endlistp ! ;
158:
159: : list-map ( ... list xt -- ... )
160: \ xt ( ... node -- ... )
161: { xt } begin { node }
162: node while
163: node xt execute
164: node list-next @
165: repeat ;
166:
167: \ C prefix lines
168:
169: \ linked list of longcstrings: [ link | count-cell | characters ]
170:
171: list%
172: cell% field c-prefix-count
173: 1 0 field c-prefix-chars
174: end-struct c-prefix%
175:
176: variable c-prefix-lines 0 c-prefix-lines !
177: variable c-prefix-lines-end c-prefix-lines c-prefix-lines-end !
178:
1.14 anton 179: : print-c-prefix-line ( node -- )
180: dup c-prefix-chars swap c-prefix-count @ type cr ;
181:
182: : print-c-prefix-lines ( -- )
183: c-prefix-lines @ ['] print-c-prefix-line list-map ;
184:
1.6 anton 185: : save-c-prefix-line ( c-addr u -- )
1.14 anton 186: c-source-file-id @ ?dup-if
187: >r 2dup r> write-line throw
188: then
1.6 anton 189: align here 0 , c-prefix-lines-end list-append ( c-addr u )
190: longstring, ;
191:
192: : \c ( "rest-of-line" -- )
193: -1 parse save-c-prefix-line ;
194:
195: \c #include "engine/libcc.h"
1.5 anton 196:
1.6 anton 197: \ Types (for parsing)
1.5 anton 198:
1.2 anton 199: wordlist constant libcc-types
200:
201: get-current libcc-types set-current
202:
203: \ index values
204: -1
205: const+ -- \ end of arguments
206: const+ n \ integer cell
1.5 anton 207: const+ a \ address cell
1.2 anton 208: const+ d \ double
209: const+ r \ float
210: const+ func \ C function pointer
211: const+ void
212: drop
213:
214: set-current
215:
216: : parse-libcc-type ( "libcc-type" -- u )
217: parse-name libcc-types search-wordlist 0= -13 and throw execute ;
218:
219: : parse-function-types ( "{libcc-type}" "--" "libcc-type" -- )
220: here 2 chars allot here begin
221: parse-libcc-type dup 0>= while
222: c,
223: repeat
1.3 anton 224: drop here swap - over char+ c!
225: parse-libcc-type dup 0< -32 and throw swap c! ;
1.2 anton 226:
227: : type-letter ( n -- c )
1.5 anton 228: chars s" nadrfv" drop + c@ ;
1.2 anton 229:
230: \ count-stacks
231:
232: : count-stacks-n ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
233: 1+ ;
234:
1.5 anton 235: : count-stacks-a ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
1.2 anton 236: 1+ ;
237:
238: : count-stacks-d ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
239: 2 + ;
240:
241: : count-stacks-r ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
242: swap 1+ swap ;
243:
244: : count-stacks-func ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
245: 1+ ;
246:
247: : count-stacks-void ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
248: ;
249:
250: create count-stacks-types
251: ' count-stacks-n ,
1.5 anton 252: ' count-stacks-a ,
1.2 anton 253: ' count-stacks-d ,
254: ' count-stacks-r ,
255: ' count-stacks-func ,
256: ' count-stacks-void ,
257:
258: : count-stacks ( pars -- fp-change sp-change )
259: \ pars is an addr u pair
260: 0 0 2swap over + swap u+do
1.3 anton 261: i c@ cells count-stacks-types + @ execute
1.2 anton 262: loop ;
263:
264: \ gen-pars
265:
266: : gen-par-n ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.5 anton 267: ." sp[" 1- dup .nb ." ]" ;
1.2 anton 268:
1.5 anton 269: : gen-par-a ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.2 anton 270: ." (void *)(" gen-par-n ." )" ;
271:
272: : gen-par-d ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.4 anton 273: ." gforth_d2ll(" gen-par-n ." ," gen-par-n ." )" ;
1.2 anton 274:
275: : gen-par-r ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.3 anton 276: swap 1- tuck ." fp[" .nb ." ]" ;
1.2 anton 277:
278: : gen-par-func ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.5 anton 279: gen-par-a ;
1.2 anton 280:
281: : gen-par-void ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
282: -32 throw ;
283:
284: create gen-par-types
285: ' gen-par-n ,
1.5 anton 286: ' gen-par-a ,
1.2 anton 287: ' gen-par-d ,
288: ' gen-par-r ,
289: ' gen-par-func ,
290: ' gen-par-void ,
291:
292: : gen-par ( fp-depth1 sp-depth1 partype -- fp-depth2 sp-depth2 )
1.3 anton 293: cells gen-par-types + @ execute ;
1.2 anton 294:
295: \ the call itself
296:
297: : gen-wrapped-call { d: pars d: c-name fp-change1 sp-change1 -- }
298: c-name type ." ("
1.3 anton 299: fp-change1 sp-change1 pars over + swap u+do
1.2 anton 300: i c@ gen-par
301: i 1+ i' < if
302: ." ,"
303: endif
304: loop
305: 2drop ." )" ;
306:
307: \ calls for various kinds of return values
308:
309: : gen-wrapped-void ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
310: 2dup 2>r gen-wrapped-call 2r> ;
311:
1.3 anton 312: : gen-wrapped-n ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.5 anton 313: 2dup gen-par-n 2>r ." =" gen-wrapped-call 2r> ;
1.3 anton 314:
1.5 anton 315: : gen-wrapped-a ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
316: 2dup gen-par-n 2>r ." =(Cell)" gen-wrapped-call 2r> ;
1.3 anton 317:
318: : gen-wrapped-d ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
319: ." gforth_ll2d(" gen-wrapped-void
1.5 anton 320: ." ," gen-par-n ." ," gen-par-n ." )" ;
1.3 anton 321:
322: : gen-wrapped-r ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.5 anton 323: 2dup gen-par-r 2>r ." =" gen-wrapped-void 2r> ;
1.3 anton 324:
325: : gen-wrapped-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.5 anton 326: gen-wrapped-a ;
1.3 anton 327:
1.2 anton 328: create gen-wrapped-types
329: ' gen-wrapped-n ,
1.5 anton 330: ' gen-wrapped-a ,
1.2 anton 331: ' gen-wrapped-d ,
332: ' gen-wrapped-r ,
333: ' gen-wrapped-func ,
334: ' gen-wrapped-void ,
335:
336: : gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change )
1.3 anton 337: cells gen-wrapped-types + @ execute ;
1.2 anton 338:
1.10 anton 339: : wrapper-function-name ( addr -- c-addr u )
340: \ addr points to the return type index of a c-function descriptor
341: count { r-type } count { d: pars }
342: pars + count { d: c-name }
343: s" gforth_c_" { d: prefix }
344: prefix nip c-name nip + pars nip + 3 + { u }
345: u allocate throw { c-addr }
346: c-addr u
347: prefix front-string c-name front-string '_ front-char
348: pars bounds u+do
349: i c@ type-letter front-char
350: loop
351: '_ front-char r-type type-letter front-char assert( dup 0= )
352: 2drop c-addr u ;
353:
1.2 anton 354: : gen-wrapper-function ( addr -- )
355: \ addr points to the return type index of a c-function descriptor
1.10 anton 356: dup { descriptor }
1.13 anton 357: count { ret } count 2dup { d: pars } chars + count { d: c-name }
1.10 anton 358: ." void " descriptor wrapper-function-name 2dup type drop free throw
359: .\" (void)\n"
1.4 anton 360: .\" {\n Cell MAYBE_UNUSED *sp = gforth_SP;\n Float MAYBE_UNUSED *fp = gforth_FP;\n "
1.2 anton 361: pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n"
362: ?dup-if
1.3 anton 363: ." gforth_SP = sp+" .nb .\" ;\n"
1.2 anton 364: endif
365: ?dup-if
1.3 anton 366: ." gforth_FP = fp+" .nb .\" ;\n"
1.2 anton 367: endif
1.3 anton 368: .\" }\n" ;
1.2 anton 369:
1.15 ! anton 370: : gen-filename ( x -- c-addr u )
! 371: \ generates a filename without extension for lib-handle-addr X
! 372: 0 <<# ['] #s $10 base-execute 'x hold 'x hold 'x hold #> save-mem #>> ;
! 373:
1.12 anton 374: : init-c-source-file ( -- )
375: c-source-file-id @ 0= if
1.15 ! anton 376: here 0 , dup lib-handle-addr ! gen-filename 2dup lib-filename 2!
! 377: s" .c" s+ 2dup w/o create-file throw dup c-source-file-id !
! 378: ['] print-c-prefix-lines swap outfile-execute
! 379: drop free throw
1.12 anton 380: endif ;
1.11 anton 381:
382: : c-source-file ( -- file-id )
1.12 anton 383: c-source-file-id @ assert( dup ) ;
1.11 anton 384:
1.5 anton 385: : compile-wrapper-function ( -- )
1.12 anton 386: c-source-file close-file throw
387: 0 c-source-file-id !
1.15 ! anton 388: s" gcc -fPIC -shared -Wl,-soname," lib-filename 2@ s+
! 389: s" .so.1 -Wl,-export_dynamic -o " append lib-filename 2@ append
! 390: s" .so.1 -O " append lib-filename 2@ append s" .c" append ( c-addr u )
! 391: 2dup system drop free throw
! 392: $? abort" compiler generated error" \ !! call dlerror
! 393: s" ./" lib-filename 2@ s+ s" .so.1" append
! 394: 2dup open-lib dup 0= abort" open-lib failed" \ !! call dlerror
! 395: ( lib-handle ) lib-handle-addr @ !
! 396: 2dup delete-file throw drop free throw
! 397: lib-filename 2@ s" .c" s+ 2dup delete-file throw drop free throw
! 398: lib-filename 2@ drop free throw 0 0 lib-filename 2! ;
1.5 anton 399: \ s" ar rcs xxx.a xxx.o" system
400: \ $? abort" ar generated error" ;
401:
1.12 anton 402: : link-wrapper-function { cff -- sym }
403: cff cff-rtype wrapper-function-name { d: wrapper-name }
404: wrapper-name cff cff-lha @ @ assert( dup ) lib-sym dup 0= -&32 and throw
1.10 anton 405: wrapper-name drop free throw ;
1.8 anton 406:
1.12 anton 407: : c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- )
1.8 anton 408: \ build time/first time action for c-function
1.12 anton 409: init-c-source-file
410: noname create 2, lib-handle-addr @ ,
1.2 anton 411: parse-name { d: c-name }
1.8 anton 412: here parse-function-types c-name string,
1.11 anton 413: ['] gen-wrapper-function c-source-file outfile-execute
1.8 anton 414: does> ( ... -- ... )
1.10 anton 415: dup 2@ { xt-defer xt-cfr }
1.12 anton 416: dup cff-lha @ @ 0= if
417: compile-wrapper-function
418: endif
419: link-wrapper-function xt-cfr >body !
1.8 anton 420: xt-cfr xt-defer defer!
421: xt-cfr execute ;
422:
423: : c-function-rt ( -- )
424: \ run-time definition for c function; addr is the address where
425: \ the sym should be stored
426: noname create 0 ,
1.2 anton 427: does> ( ... -- ... )
428: @ call-c ;
429:
1.8 anton 430: : c-function ( "forth-name" "c-name" "{libcc-type}" "--" "libcc-type" -- )
431: defer lastxt dup c-function-rt lastxt c-function-ft
432: lastxt swap defer! ;
1.1 anton 433:
434: s" Library not found" exception constant err-nolib
435:
436: : library ( "name" "file" -- ) \ gforth
437: \G Dynamically links the library specified by @i{file}. Defines a
438: \G word @i{name} ( -- lib ) that starts the declaration of a
439: \G function from that library.
440: create parse-name open-lib dup 0= err-nolib and throw ,
441: does> ( -- lib )
442: @ ;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to libcc.fs CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth