source: branches/win64/lib/db-io.lisp @ 9713

Last change on this file since 9713 was 9713, checked in by andreas, 13 years ago

Allow multiple concurrent readers for cdb files.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 64.0 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2001 Clozure Associates
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17;;; The "CDB" files used here are similar (but not identical) to those
18;;; used in the Unix CDB package <http://cr.yp.to/cdb.html>.  The primary
19;;; known & intentional differences are:
20;;;
21;;; a) key values, record positions, and other 32-bit metadata in the
22;;;    files are stored in native (vice little-endian) order.
23;;; b) hash values are always non-negative fixnums.
24;;;
25;;; I haven't thought of a compelling reason to attempt full compatibility.
26;;;
27;;; The basic idea is that the database files are created in a batch
28;;; process and are henceforth read-only (e.g., lookup is optimized by
29;;; making insertion & deletion impractical or impossible.)  That's
30;;; just about exactly what we want here.
31;;;
32;;; Those of you keeping score may notice that this is the third or forth
33;;; database format that OpenMCL has used for its interface database.
34;;; As always, this will hopefully be the last format change; the fact
35;;; that this code is self-contained (doesn't depend on any Unix database
36;;; library) should make it easier to port to other platforms.
37
38(in-package "CCL")
39
40(defparameter *interface-abi-version* 2)
41(defparameter *min-interface-abi-version* 1)
42
43(defconstant cdb-hash-mask (1- (ash 1 29)))
44
45(defun cdb-hash (buf len)
46  (declare (fixnum len))
47  (let* ((h 5381))
48    (declare (fixnum h))
49    (dotimes (i len (logand h cdb-hash-mask))
50      (setq h (+ h (the fixnum (logand cdb-hash-mask (ash h 5)))))
51      (setq h (logxor (the (unsigned-byte 8) (%get-unsigned-byte buf i)) h)))))
52
53(defconstant cdbm-hplist 1000)
54
55(defmacro hp-h (v n)
56  `(aref ,v (* ,n 2)))
57
58(defmacro hp-p (v n)
59  `(aref ,v (1+ (* ,n 2))))
60
61(defstruct cdbm-hplist
62  (hp (make-array (* 2 cdbm-hplist)
63                  :element-type '(unsigned-byte 32)
64                  :initial-element 0))
65  (next nil)
66  (num 0))
67
68
69
70
71
72#+openmcl
73(progn
74  ;;; Given a (possibly logical) PATHNAME, return a corresponding namestring
75  ;;; suitable for passing to an OS file-open call.
76  (defun cdb-native-namestring (pathname)
77    (native-translated-namestring pathname))
78 
79  ;;; Open the file specified by PATHNAME for output and return a
80  ;;; small integer "file id" (fid).
81  (defun fid-open-output (pathname)
82    (let ((dir (make-pathname :type nil :name nil :defaults pathname)))
83      (unless (probe-file dir)
84        (error "The directory ~S does not exist, cannot open/create ~S"
85               dir pathname)))
86    (let* ((id (fd-open (cdb-native-namestring pathname)
87                        (logior #$O_WRONLY #$O_CREAT #$O_TRUNC))))
88      (if (< id 0)
89        (%errno-disp id pathname)
90        id)))
91
92  ;;; Open the file specified by PATHNAME for input and return a
93  ;;; file id.
94  #-windows-target
95  (defun fid-open-input (pathname)
96    (let* ((id (fd-open (cdb-native-namestring pathname) #$O_RDONLY)))
97      (if (< id 0)
98        (%errno-disp id pathname)
99        id)))
100  ;; On Windows, open() can't open the same file twice, which breaks
101  ;; bootstrapping.  Use CreateFile instead, and tell it to share.
102  #+windows-target
103  (defun fid-open-input (pathname)
104    (with-filename-cstrs ((name (cdb-native-namestring pathname)))
105      (let* ((handle (%ptr-to-int (#_CreateFileW
106                                   name
107                                   #$GENERIC_READ
108                                   #$FILE_SHARE_READ
109                                   (%null-ptr)
110                                   #$OPEN_EXISTING
111                                   #$FILE_ATTRIBUTE_NORMAL
112                                   (%null-ptr)))))
113        (if (eq handle #xffffffffffffffff)
114          (error "Error opening CDB database ~S" pathname)
115          (#__open_osfhandle handle #$O_RDONLY)))))
116 
117 
118  ;;; Read N octets from FID into BUF.  Return #of octets read or error.
119  (defun fid-read (fid buf n)
120    (let* ((count (fd-read fid buf n)))
121      (if (< count 0)
122        (%errno-disp count "reading from file")
123        count)))
124
125  ;;; Write N octets to FID from BUF.  Return #of octets written or error.
126  (defun fid-write (fid buf n)
127    (let* ((count (fd-write fid buf n)))
128      (if (< count 0)
129        (%errno-disp count "writing to file")
130        count)))
131
132  ;;; Return the absolute (octet) position of FID.
133  (defun fid-pos (fid)
134    (fd-tell fid))
135
136  ;;; Return the current size of the file referenced by FID, in
137  ;;; octets.
138  (defun fid-size (fid)
139    (fd-size fid))
140 
141  ;;; Seek to specified position (relative to file start.)
142  (defun fid-seek (fid pos)
143    (fd-lseek fid pos #$SEEK_SET))
144
145  ;;; Guess what this does ?
146  (defun fid-close (fid)
147    (fd-close fid))
148
149  ;;; Allocate a block of size N bytes (via malloc, #_NewPtr, etc.)
150  (defun cdb-alloc (n)
151    (malloc n))
152
153  ;;; Free a block allocated by cdb-alloc.
154  (defun cdb-free (block)
155    (free block))
156  )
157
158;;; I suppose that if we wanted to store these things in little-endian
159;;; order this'd be the place to swap bytes ...
160(defun fid-write-u32 (fid val)
161  (%stack-block ((valptr 4))
162    (setf (%get-unsigned-long valptr) val)
163    (fid-write fid valptr 4)
164    val))
165
166(defun fid-read-u32 (fid)
167  (%stack-block ((valptr 4))
168    (fid-read fid valptr 4)
169    (%get-unsigned-long valptr)))
170
171
172
173;;; Write N elements of a vector of type (UNSIGNED-BYTE 32) to file-id
174;;; FID, starting at element START.  The vector should be a simple
175;;; (non-displaced) array.
176(defun fid-write-u32-vector (fid v n start)
177  (let* ((remaining-octets (* n 4))
178         (start-octet (* start 4))
179         (bufsize 2048))
180    (%stack-block ((buf bufsize))
181      (do* ()
182           ((zerop remaining-octets))
183        (let* ((chunksize (min remaining-octets bufsize)))
184          (%copy-ivector-to-ptr v start-octet buf 0 chunksize)
185          (fid-write fid buf chunksize)
186          (incf start-octet chunksize)
187          (decf remaining-octets chunksize))))))
188
189(defstruct cdbx
190  fid                                   ;a small integer denoting a file
191  pathname)                             ;that file's pathname
192
193;;; A CDBM is used to create a database.
194(defstruct (cdbm (:include cdbx))
195  (final (make-array (* 256 2)
196                     :element-type '(unsigned-byte 32)
197                     :initial-element 0))
198  (count (make-array 256 :element-type '(unsigned-byte 32) :initial-element 0))
199  (start (make-array 256 :element-type '(unsigned-byte 32) :initial-element 0))
200  (head nil)
201  (split nil)
202  (hash nil)
203  (numentries 0)
204  )
205
206(defun cdbm-open (pathname)
207  (let* ((fid (fid-open-output pathname))
208         (cdbm (make-cdbm :fid fid :pathname pathname))
209         (final (cdbm-final cdbm)))
210    ;;; Write the (empty) final table to the start of the file.  Twice.
211    (fid-write-u32-vector fid final (length final) 0)
212    (fid-write-u32-vector fid final (length final) 0)
213    cdbm))
214
215;;; Note a newly-added <key,value> pair's file position and hash code.
216(defun %cdbm-add-hash-pos (cdbm hash pos)
217  (let* ((head (cdbm-head cdbm)))
218    (when (or (null head)
219              (>= (cdbm-hplist-num head) cdbm-hplist))
220      (setq head (make-cdbm-hplist))
221      (setf (cdbm-hplist-next head) (cdbm-head cdbm)
222            (cdbm-head cdbm) head))
223    (let* ((num (cdbm-hplist-num head))
224           (hp (cdbm-hplist-hp head)))
225      (setf (hp-h hp num) hash
226            (hp-p hp num) pos))
227    (incf (cdbm-hplist-num head))
228    (incf (cdbm-numentries cdbm))))
229
230(defun cdbm-put (cdbm key data)
231  (let* ((fid (cdbm-fid cdbm))
232         (pos (fid-pos fid))
233         (keylen (pref key :cdb-datum.size))
234         (keyptr (pref key :cdb-datum.data))
235         (datalen (pref data :cdb-datum.size))
236         (hash (cdb-hash keyptr keylen)))
237    (fid-write-u32 fid keylen)
238    (fid-write-u32 fid datalen)
239    (fid-write fid keyptr keylen)
240    (fid-write fid (pref data :cdb-datum.data) datalen)
241    (%cdbm-add-hash-pos cdbm hash pos)))
242
243(defun %cdbm-split (cdbm)
244  (let* ((count (cdbm-count cdbm))
245         (start (cdbm-start cdbm))
246         (numentries (cdbm-numentries cdbm)))
247    (dotimes (i 256) (setf (aref count i) 0))
248    (do* ((x (cdbm-head cdbm) (cdbm-hplist-next x)))
249         ((null x))
250      (do* ((i (cdbm-hplist-num x))
251            (hp (cdbm-hplist-hp x)))
252           ((zerop i))
253        (decf i)
254        (incf (aref count (logand 255 (hp-h hp i))))))
255    (let* ((memsize 1))
256      (dotimes (i 256)
257        (let* ((u (* 2 (aref count i))))
258          (if (> u memsize)
259            (setq memsize u))))
260      (incf memsize numentries)
261      (let* ((split (make-array (the fixnum (* 2 memsize))
262                                :element-type '(unsigned-byte 32))))
263        (setf (cdbm-split cdbm) split)
264        (setf (cdbm-hash cdbm)
265              (make-array (- (* 2 memsize)
266                             (* 2 numentries))
267                          :element-type '(unsigned-byte 32)
268                          :displaced-to split
269                          :displaced-index-offset (* 2 numentries)))
270        (let* ((u 0))
271          (dotimes (i 256)
272            (incf u (aref count i))
273            (setf (aref start i) u)))
274
275        (do* ((x (cdbm-head cdbm) (cdbm-hplist-next x)))
276             ((null x))
277          (do* ((i (cdbm-hplist-num x))
278                (hp (cdbm-hplist-hp x)))
279               ((zerop i))
280            (decf i)
281            (let* ((idx (decf (aref start (logand 255 (hp-h hp i))))))
282              (setf (hp-h split idx) (hp-h hp i)
283                    (hp-p split idx) (hp-p hp i)))))))))
284
285(defun %cdbm-throw (cdbm pos b)
286  (let* ((count (aref (cdbm-count cdbm) b))
287         (len (* 2 count))
288         (hash (cdbm-hash cdbm))
289         (split (cdbm-split cdbm)))
290    (let* ((final (cdbm-final cdbm)))
291      (setf (aref final (* 2 b)) pos
292            (aref final (1+ (* 2 b))) len))
293    (unless (zerop len)
294      (dotimes (j len)
295        (setf (hp-h hash j) 0
296              (hp-p hash j) 0))
297      (let* ((hpi (aref (cdbm-start cdbm) b)))
298        (dotimes (j count)
299          (let* ((where (mod (ash (hp-h split hpi) -8) len)))
300            (do* ()
301                 ((zerop (hp-p hash where)))
302              (incf where)
303              (if (= where len)
304                (setq where 0)))
305            (setf (hp-p hash where) (hp-p split hpi)
306                  (hp-h hash where) (hp-h split hpi)
307                  hpi (1+ hpi))))))
308    len))
309
310;;; Write data structures to the file, then close the file.
311(defun cdbm-close (cdbm)
312  (when (cdbm-fid cdbm)
313    (%cdbm-split cdbm)
314    (let* ((hash (cdbm-hash cdbm))
315           (fid (cdbm-fid cdbm))
316           (pos (fid-pos fid)))
317      (dotimes (i 256)
318        (let* ((len (%cdbm-throw cdbm pos i)))
319          (dotimes (u len)
320            (fid-write-u32 fid (hp-h hash u))
321            (fid-write-u32 fid (hp-p hash u))
322            (incf pos 8))))
323      (write-cdbm-trailer cdbm)
324      (fid-seek fid (* 256 2 4)) ; skip the empty "final" table, write the new one
325      (let* ((final (cdbm-final cdbm)))
326        (fid-write-u32-vector fid final (length final) 0))
327      (fid-close fid)
328      (setf (cdbm-fid cdbm) nil))))
329
330(defun write-cdbm-trailer (cdbm)
331  (let* ((string (format nil "~s ~s ~d " "OpenMCL Interface File" (backend-name *target-backend*) *interface-abi-version*)))
332    (%stack-block ((buf 512))
333      (%cstr-pointer string buf)
334      (fid-write (cdbm-fid cdbm) buf 512))))
335
336     
337;;; A CDB is used to access a database.
338(defstruct (cdb (:include cdbx))
339  (lock (make-lock)))
340
341     
342;;; Do the bytes on disk match KEY ?
343(defun %cdb-match (fid key keylen)
344  (%stack-block ((buf keylen))
345    (fid-read fid buf keylen)
346    (dotimes (i keylen t)
347      (unless (= (the fixnum (%get-unsigned-byte key i))
348                 (the fixnum (%get-unsigned-byte buf i)))
349        (return)))))
350
351;;; Seek to file position of data associated with key.  Return length
352;;; of data (or NIL if no matching key.)
353(defun %cdb-seek (fid key keylen)
354  (let* ((hash (cdb-hash key keylen)))
355    (fid-seek fid (+ (* 256 2 4) (* 8 (logand hash 255))))
356    (let* ((pos (fid-read-u32 fid))
357           (lenhash (fid-read-u32 fid)))
358      (unless (zerop lenhash)
359        (let* ((h2 (mod (ash hash -8) lenhash)))
360          (dotimes (i lenhash)
361            (fid-seek fid (+ pos (* 8 h2)))
362            (let* ((hashed-key (fid-read-u32 fid))
363                   (poskd (fid-read-u32 fid)))
364              (when (zerop poskd)
365                (return-from %cdb-seek nil))
366              (when (= hashed-key hash)
367                (fid-seek fid poskd)
368                (let* ((hashed-key-len (fid-read-u32 fid))
369                       (data-len (fid-read-u32 fid)))
370                  (when (= hashed-key-len keylen)
371                    (if (%cdb-match fid key keylen)
372                      (return-from %cdb-seek data-len)))))
373              (if (= (incf h2) lenhash)
374                (setq h2 0)))))))))
375
376;;; This should only be called with the cdb-lock of the containing cdb
377;;; held.
378(defun %cdb-get (fid key value)
379  (setf (pref value :cdb-datum.size) 0
380        (pref value :cdb-datum.data) (%null-ptr))
381  (when fid
382    (let* ((datalen (%cdb-seek fid
383                               (pref key :cdb-datum.data)
384                               (pref key :cdb-datum.size))))
385      (when datalen
386        (let* ((buf (cdb-alloc datalen)))
387          (fid-read fid buf datalen)
388          (setf (pref value :cdb-datum.size) datalen
389                (pref value :cdb-datum.data) buf)))
390      value)))
391
392(defun cdb-get (cdb key value)
393  (with-lock-grabbed ((cdb-lock cdb))
394    (%cdb-get (cdb-fid cdb) key value)))
395
396(defun cdb-subdirectory-path (&optional (ftd *target-ftd*))
397  (let* ((ftd-name (ftd-interface-db-directory ftd))
398         (ftd-dir (pathname-directory ftd-name)))
399    (assert (equalp (pathname-host ftd-name) "ccl"))
400    (assert (eq (car ftd-dir) :absolute))
401    (cdr ftd-dir)))
402
403(defvar *interfaces-root* "ccl:")
404
405(defun open-interface-db-pathname (name d)
406  (let* ((db-path (make-pathname :host (pathname-host *interfaces-root*)
407                                 :directory (append
408                                             (or (pathname-directory *interfaces-root*)
409                                                 '(:absolute))
410                                             (cdb-subdirectory-path *target-ftd*))))
411         (path (merge-pathnames name
412                                (merge-pathnames (interface-dir-subdir d) db-path))))
413    (cdb-open path)))
414
415(defun cdb-open (pathname)
416  (if (probe-file pathname)
417    (let* ((cdb (make-cdb :fid (fid-open-input (cdb-native-namestring pathname))
418                          :pathname (namestring pathname))))
419      (cdb-check-trailer cdb))
420    (progn
421      (if (probe-file (make-pathname :name nil :type nil :defaults pathname))
422        (warn "Interface file ~s does not exist." pathname)
423        (warn "Interface file ~s does not exist, and the containing directory does not exist.~%This may mean that that the \"ccl:\" logical-pathname host has not been properly initialized. " (translate-logical-pathname pathname)))
424      (make-cdb :fid nil :pathname (namestring pathname)))))
425
426(defun cdb-check-trailer (cdb)
427  (flet ((error-with-cdb (string &rest args)
428           (error "Error in interface file at ~s: ~a"
429                  (cdb-pathname cdb) (apply #'format nil string args))))
430    (let* ((fid (cdb-fid cdb)))
431      (fid-seek fid (- (fid-size fid) 512))
432      (%stack-block ((buf 512))
433        (fid-read fid buf 512)
434        (let* ((string (make-string 512)))
435          (dotimes (i 512)
436            (setf (%scharcode string i) (%get-unsigned-byte buf i)))
437          (with-input-from-string (s string)
438            (let* ((sig (ignore-errors (read s)))
439                   (target (ignore-errors (read s)))
440                   (version (ignore-errors (read s))))
441              (if (equal sig "OpenMCL Interface File")
442                (if (eq target (backend-name *target-backend*))
443                  (if (and version
444                           (>= version *min-interface-abi-version*)
445                           (<=  version *interface-abi-version*))
446                    cdb
447                    (error-with-cdb "Wrong interface ABI version. Expected ~d, got ~d" *interface-abi-version* version))
448                  cdb #+nil(error-with-cdb "Wrong target."))
449                (error-with-cdb "Missing interface file signature.  Obsolete version?")))))))))
450
451                 
452   
453(defun cdb-close (cdb)
454  (let* ((fid (cdb-fid cdb)))
455    (setf (cdb-fid cdb) nil)
456    (when fid
457      (fid-close fid))
458    t))
459
460(defmethod print-object ((cdb cdbx) stream)
461  (print-unreadable-object (cdb stream :type t :identity t)
462    (let* ((fid (cdb-fid cdb)))
463      (format stream "~s [~a]" (cdb-pathname cdb) (or fid "closed")))))
464
465
466(defun cdb-enumerate-keys (cdb &optional (predicate #'true))
467  "Returns a list of all keys (strings) in the open .cdb file CDB which
468satisfy the optional predicate PREDICATE."
469  (with-lock-grabbed ((cdb-lock cdb))
470    (let* ((keys ())
471           (fid (cdb-fid cdb)))
472      (dotimes (i 256 keys)
473        (fid-seek fid (+ (* 256 2 4) (* 8 i)))
474        (let* ((pos (fid-read-u32 fid))
475               (n (fid-read-u32 fid)))
476          (dotimes (j n)
477            (fid-seek fid (+ pos (* 8 j) 4))
478            (let* ((posk (fid-read-u32 fid)))
479              (unless (zerop posk)
480                (fid-seek fid posk)
481                (let* ((hashed-key-len (fid-read-u32 fid)))
482                  ;; Skip hashed data length
483                  (fid-read-u32 fid)
484                  (let* ((string (make-string hashed-key-len)))
485                    (%stack-block ((buf hashed-key-len))
486                      (fid-read fid buf hashed-key-len)
487                      (dotimes (k hashed-key-len)
488                        (setf (schar string k)
489                              (code-char (%get-unsigned-byte buf k)))))
490                    (when (funcall predicate string)
491                      (push (copy-seq string) keys))))))))))))
492                                        ;
493                 
494
495
496(defstruct ffi-type
497  (ordinal nil)
498  (defined nil)
499  (string)
500  (name)                                ; a keyword, uppercased or NIL
501)
502
503(defmethod print-object ((x ffi-type) out)
504  (print-unreadable-object (x out :type t :identity t)
505    (format out "~a" (ffi-type-string x))))
506
507(defvar *ffi-prefix* "")
508
509(defstruct (ffi-mem-block (:include ffi-type))
510  fields
511  (anon-global-id )
512  (alt-alignment-bits nil))
513
514(defstruct (ffi-union (:include ffi-mem-block)
515                      (:constructor
516                       make-ffi-union (&key
517                                       string name
518                                       &aux
519                                       (anon-global-id
520                                        (unless name
521                                          (concatenate 'string
522                                                       *ffi-prefix*
523                                                       "-" string)))))))
524
525
526(defstruct (ffi-struct (:include ffi-mem-block)
527                       (:constructor
528                       make-ffi-struct (&key
529                                       string name
530                                       &aux
531                                       (anon-global-id
532                                        (unless name
533                                          (concatenate 'string
534                                                       *ffi-prefix*
535                                                       "-" string)))))))
536
537(defstruct (ffi-typedef (:include ffi-type))
538  (type))
539
540(defstruct (ffi-objc-class (:include ffi-type))
541  super-foreign-name
542  protocol-names
543  own-ivars
544  )
545
546(defstruct (ffi-objc-method)
547  class-name
548  arglist
549  result-type
550  flags)
551
552(defstruct (ffi-objc-message (:include ffi-type))
553  methods)
554                           
555
556(defun ffi-struct-reference (s)
557  (or (ffi-struct-name s) (ffi-struct-anon-global-id s)))
558
559(defun ffi-union-reference (u)
560  (or (ffi-union-name u) (ffi-union-anon-global-id u)))
561
562(defstruct (ffi-function (:include ffi-type))
563  arglist
564  return-value)
565   
566
567
568(defconstant db-string-constant 0)
569(defconstant db-read-string-constant 1)
570(defconstant db-s32-constant 2)
571(defconstant db-u32-constant 3)
572(defconstant db-float-constant 4)
573(defconstant db-double-constant 5)
574(defconstant db-char-constant 6)
575
576(defparameter *arg-spec-encoding*
577  '((#\Space . :void)
578    (#\a . :address)
579    (#\F . :signed-fullword)
580    (#\f . :unsigned-fullword)
581    (#\H . :signed-halfword)
582    (#\h . :unsigned-halfword)
583    (#\B . :signed-byte)
584    (#\b . :unsigned-byte)
585    (#\s . :single-float)
586    (#\d . :double-float)
587    (#\L . :signed-doubleword)
588    (#\l . :unsigned-doubleword)
589    (#\r . :record)))
590
591
592
593(defun decode-arguments (string)
594  (let* ((result nil))
595    (collect ((args))
596      (do* ((i 0 (1+ i)))
597           ((= i (length string)) (values (args) result))
598        (declare (fixnum i))
599        (let* ((ch (schar string i))
600               (val (if (or (eql ch #\r) (eql ch #\u) (eql ch #\t))
601                      (let* ((namelen (char-code (schar string (incf i))))
602                             (name (make-string namelen)))
603                        (dotimes (k namelen)
604                          (setf (schar name k)
605                                (schar string (incf i))))
606                        (setq name (escape-foreign-name name))
607                        (if (eql ch #\r)
608                          `(:struct ,name)
609                          (if (eql ch #\u)
610                            `(:union ,name)
611                            name)))
612                      (cdr (assoc ch *arg-spec-encoding*)))))
613          (if result
614            (args val)
615            (setq result val)))))))
616
617
618;;; encoded external function looks like:
619;;; byte min-args
620;;; byte name-length
621;;; name-length bytes of name
622;;; result+arg specs
623
624(defun extract-db-function (datum)
625  (let* ((val nil)
626         (dsize (pref datum :cdb-datum.size)))
627    (with-macptrs ((dptr))
628      (%setf-macptr dptr (pref datum :cdb-datum.data))
629      (unless (%null-ptr-p dptr)
630        (let* ((min-args (%get-byte dptr))
631               (name-len (%get-byte dptr 1))
632               (external-name (%str-from-ptr (%inc-ptr dptr 2) name-len))
633               (encoding-len (- dsize (+ 2 name-len)))
634               (encoding (make-string encoding-len)))
635          (declare (dynamic-extent encoding))
636          (%str-from-ptr (%inc-ptr dptr (+ 2 name-len)) encoding-len encoding)
637          (cdb-free (pref datum :cdb-datum.data))
638          (multiple-value-bind (args result)
639              (decode-arguments encoding)
640            (setq val (make-external-function-definition
641                       :entry-name external-name
642                       :arg-specs args
643                       :result-spec result
644                       :min-args min-args))))))
645    val))
646
647(defun db-lookup-function (cdb name)
648  (when cdb
649    (rletZ ((value :cdb-datum)
650            (key :cdb-datum))
651      (with-cstrs ((keyname (string name)))
652        (setf (pref key :cdb-datum.data) keyname
653              (pref key :cdb-datum.size) (length (string name))
654              (pref value :cdb-datum.data) (%null-ptr)
655              (pref value :cdb-datum.size) 0)
656        (cdb-get cdb key value)
657        (extract-db-function value)))))
658
659
660
661
662       
663(defun extract-db-constant-value (datum)
664  (let* ((val nil)
665         (dsize (pref datum :cdb-datum.size)))
666    (with-macptrs ((dptr))
667      (%setf-macptr dptr (pref datum :cdb-datum.data))
668      (unless (%null-ptr-p dptr)
669        (let* ((class (pref dptr :dbm-constant.class)))
670          (setq val
671                (ecase class
672                  ((#.db-string-constant #.db-read-string-constant)
673                   (let* ((str (%str-from-ptr (%inc-ptr dptr 4) (- dsize 4))))
674                     (if (eql class db-read-string-constant)
675                       (read-from-string str)
676                       str)))
677                  (#.db-s32-constant (pref dptr :dbm-constant.value.s32))
678                  (#.db-u32-constant (pref dptr :dbm-constant.value.u32))
679                  (#.db-float-constant (pref dptr :dbm-constant.value.single-float))
680                  (#.db-double-constant (pref dptr :dbm-constant.value.double-float))
681                  (#.db-char-constant (code-char (pref dptr :dbm-constant.value.u32)))))
682          (cdb-free (pref datum :cdb-datum.data)))))
683    val))
684
685
686
687(defun db-lookup-constant (cdb name)
688  (when cdb
689    (rletZ ((value :cdb-datum)
690            (key :cdb-datum))
691      (with-cstrs ((keyname (string name)))
692        (setf (pref key :cdb-datum.data) keyname
693              (pref key :cdb-datum.size) (length (string name))
694              (pref value :cdb-datum.data) (%null-ptr)
695              (pref value :cdb-datum.size) 0)
696        (cdb-get cdb key value)
697        (extract-db-constant-value value)))))
698   
699
700
701(defun db-define-string-constant (cdbm name val &optional (class db-string-constant))
702  (let* ((dsize (+ 4 (length val))))
703    (%stack-block ((valbuf dsize))
704      (dotimes (i (length val))
705        (setf (%get-unsigned-byte valbuf (the fixnum (+ 4 i)))
706              (%scharcode val i)))
707      (setf (%get-long valbuf) class)
708      (rletZ ((content :cdb-datum)
709              (key :cdb-datum))
710        (setf (pref content :cdb-datum.size) dsize
711              (pref content :cdb-datum.data) valbuf)
712        (with-cstrs ((keyname (string name)))
713          (setf (pref key :cdb-datum.size) (length (string name))
714                (pref key :cdb-datum.data) keyname)
715          (cdbm-put cdbm key content))))))
716     
717(defun db-define-constant (cdbm name val)
718  (typecase val
719    (string (db-define-string-constant cdbm name val))
720    ((or (unsigned-byte 32)
721         (signed-byte 32)
722         short-float
723         double-float
724         character)
725     (rletZ ((constant :dbm-constant)
726             (content :cdb-datum)
727             (key :cdb-datum))
728       (etypecase val
729         ((signed-byte 32)
730          (setf (pref constant :dbm-constant.value.s32) val)
731          (setf (pref constant :dbm-constant.class) db-s32-constant))
732         ((unsigned-byte 32)
733          (setf (pref constant :dbm-constant.value.u32) val)
734          (setf (pref constant :dbm-constant.class) db-u32-constant))
735         (short-float
736          (setf (pref constant :dbm-constant.value.single-float) val)
737          (setf (pref constant :dbm-constant.class) db-float-constant))
738         (double-float
739          (setf (pref constant :dbm-constant.value.double-float) val)
740          (setf (pref constant :dbm-constant.class) db-double-constant))
741         (character
742          (setf (pref constant :dbm-constant.value.u32) (char-code val))
743          (setf (pref constant :dbm-constant.class) db-char-constant)))
744       (setf (pref content :cdb-datum.data) constant
745             (pref content :cdb-datum.size) (record-length :dbm-constant))
746       (with-cstrs ((keyname (string name)))
747         (setf (pref key :cdb-datum.data) keyname
748               (pref key :cdb-datum.size) (length (string name)))
749         (cdbm-put cdbm key content))))
750    (t (db-define-string-constant cdbm name (format nil "~a" val) db-read-string-constant))))
751
752
753 
754
755(defmacro with-new-db-file ((var pathname) &body body)
756  (let* ((db (gensym)))
757    `(let* (,db)
758      (unwind-protect
759           (let* ((,var (setq ,db (cdbm-open ,pathname))))
760             ,@body)
761        (when ,db (cdbm-close ,db))))))
762
763
764
765(defun interface-db-pathname (name d &optional (ftd *target-ftd*))
766  (merge-pathnames name
767                   (merge-pathnames (interface-dir-subdir d)
768                                    (ftd-interface-db-directory ftd))))
769
770(def-ccl-pointers reset-db-files ()
771  (do-interface-dirs (d)
772    (setf (interface-dir-constants-interface-db-file d) nil
773          (interface-dir-functions-interface-db-file d) nil
774          (interface-dir-records-interface-db-file d) nil
775          (interface-dir-types-interface-db-file d) nil
776          (interface-dir-vars-interface-db-file d) nil
777          (interface-dir-objc-classes-interface-db-file d) nil
778          (interface-dir-objc-methods-interface-db-file d) nil)))
779
780(defun db-constants (dir)
781  (or (interface-dir-constants-interface-db-file dir)
782      (setf (interface-dir-constants-interface-db-file dir)
783            (open-interface-db-pathname "constants.cdb" dir))))
784
785(defun db-objc-classes (dir)
786  (or (interface-dir-objc-classes-interface-db-file dir)
787      (setf (interface-dir-objc-classes-interface-db-file dir)
788            (open-interface-db-pathname "objc-classes.cdb" dir))))
789
790(defun db-objc-methods (dir)
791  (or (interface-dir-objc-methods-interface-db-file dir)
792      (setf (interface-dir-objc-methods-interface-db-file dir)
793            (open-interface-db-pathname "objc-methods.cdb" dir))))
794
795(defun db-vars (dir)
796  (or (interface-dir-vars-interface-db-file dir)
797      (setf (interface-dir-vars-interface-db-file dir)
798            (open-interface-db-pathname "vars.cdb" dir))))
799
800(defun db-types (dir)
801  (or (interface-dir-types-interface-db-file dir)
802      (setf (interface-dir-types-interface-db-file dir)
803            (open-interface-db-pathname "types.cdb" dir))))
804
805(defun db-records (dir)
806  (or (interface-dir-records-interface-db-file dir)
807      (setf (interface-dir-records-interface-db-file dir)
808            (open-interface-db-pathname "records.cdb" dir))))
809
810(defun db-functions (dir)
811  (or (interface-dir-functions-interface-db-file dir)
812      (setf (interface-dir-functions-interface-db-file dir)
813            (open-interface-db-pathname "functions.cdb" dir))))
814
815(defun load-os-constant (sym &optional query)
816  (let* ((val (do-interface-dirs (d)
817                    (let* ((v (db-lookup-constant (db-constants d) sym)))
818                      (when v (return v))))))
819    (if query
820      (not (null val))
821      (if val
822        (let* ((*record-source-file* nil))
823          (%defconstant sym val)
824          val)
825        (error "Constant not found: ~s" sym)))))
826
827(defun %load-var (name &optional query-only)
828  (let* ((ftd *target-ftd*)
829         (string (if (getf (ftd-attributes ftd)
830                           :prepend-underscores)
831                   (concatenate 'string "_" (string name))
832                   (string name)))
833         (fv (gethash string (fvs))))
834    (unless fv
835      (with-cstrs ((cstring string))
836        (let* ((type
837                (do-interface-dirs (d)
838                  (let* ((vars (db-vars d)))
839                    (when vars
840                      (rletZ ((value :cdb-datum)
841                              (key :cdb-datum))
842                        (setf (pref key :cdb-datum.data) cstring
843                              (pref key :cdb-datum.size) (length string)
844                              (pref value :cdb-datum.data) (%null-ptr)
845                              (pref value :cdb-datum.size) 0)
846                        (cdb-get vars key value)
847                        (let* ((vartype (extract-db-type value ftd)))
848                          (when vartype (return vartype)))))))))
849          (when type
850            (setq fv (%cons-foreign-variable string type))
851            (resolve-foreign-variable fv nil)
852            (setf (gethash string (fvs)) fv)))))
853    (if query-only
854      (not (null fv))
855      (or fv (error "Foreign variable ~s not found" string)))))
856
857
858(set-dispatch-macro-character 
859 #\# #\&
860 (qlfun |#&-reader| (stream char arg)
861   (declare (ignore char arg))
862   (let* ((package (find-package (ftd-interface-package-name *target-ftd*))))
863     (multiple-value-bind (sym query)
864         (%read-symbol-preserving-case
865          stream
866          package)
867       (unless *read-suppress*
868         (let* ((fv (%load-var sym query)))
869           (if query
870             fv
871             (%foreign-access-form `(%reference-external-entry-point (load-time-value ,fv))
872                                   (fv.type fv)
873                                   0
874                                   nil))))))))
875
876
877             
878
879(defstruct objc-message-info
880  message-name
881  methods                               ; all methods
882  ambiguous-methods                     ; partitioned by signature
883  req-args
884  flags
885  protocol-methods
886  lisp-name
887  selector)
888
889
890
891   
892(defstruct objc-method-info
893  message-info
894  class-name
895  class-pointer                         ;canonical, in some sense
896  arglist
897  result-type
898  flags
899  signature
900  signature-info
901  )
902
903
904
905(defmethod print-object ((m objc-method-info) stream)
906  (print-unreadable-object (m stream :type t :identity t)
907    (format stream "~c[~a ~a]"
908            (if (getf (objc-method-info-flags m) :class)
909              #\+
910              #\-)
911            (let* ((name (objc-method-info-class-name m)))
912              (if (getf (objc-method-info-flags m) :protocol)
913                (format nil "<~a>" name)
914                name))
915            (objc-message-info-message-name
916                          (objc-method-info-message-info m)))))
917
918(defun extract-db-objc-message-info (datum message-name info &optional
919                                           (ftd *target-ftd*))
920  (with-macptrs ((buf))
921    (%setf-macptr buf (pref datum :cdb-datum.data))
922    (unless (%null-ptr-p buf)
923      (unless info
924        (setq info
925              (make-objc-message-info
926               :message-name (string message-name))))
927      (let* ((p 0)
928             (nmethods 0)
929             (nargs 0))
930        (multiple-value-setq (nmethods p) (%decode-uint buf p))
931        (multiple-value-setq (nargs p) (%decode-uint buf p))
932        (dotimes (i nmethods)
933          (let* ((flag-byte (prog1 (%get-unsigned-byte buf p)
934                              (incf p)))
935                 (is-class-method (logbitp 0 flag-byte))
936                 (is-protocol-method (logbitp 1 flag-byte))
937                 (class-name ())
938                 (result-type ())
939                 (arg-types ())
940                 (arg-type ()))
941            (multiple-value-setq (class-name p) (%decode-name buf p t))
942            (multiple-value-setq (result-type p) (%decode-type buf p ftd t))
943            (dotimes (i nargs)
944              (multiple-value-setq (arg-type p) (%decode-type buf p ftd t))
945              (push arg-type arg-types))
946            (unless (dolist (m (objc-message-info-methods info))
947                      (when (and (eq (getf (objc-method-info-flags m) :class)  is-class-method)
948                                 (string= (objc-method-info-class-name m)
949                                          class-name))
950                        (return t)))
951              (let* ((flags ()))
952                (if is-class-method
953                  (setf (getf flags :class) t))
954                (if is-protocol-method
955                  (setf (getf flags :protocol) t))
956                (push (make-objc-method-info
957                                     :message-info info
958                                     :class-name class-name
959                                     :arglist (nreverse arg-types)
960                                     :result-type result-type
961                                     :flags flags)
962                 (objc-message-info-methods info))))))
963        (cdb-free (pref datum :cdb-datum.data))))
964    info))
965
966(defun db-note-objc-method-info (cdb message-name message-info)
967  (when cdb
968    (rletZ ((value :cdb-datum)
969            (key :cdb-datum))
970      (with-cstrs ((keyname (string message-name)))
971        (setf (pref key :cdb-datum.data) keyname
972              (pref key :cdb-datum.size) (length (string message-name))
973              (pref value :cdb-datum.data) (%null-ptr)
974              (pref value :cdb-datum.size) 0)
975        (cdb-get cdb key value)
976        (extract-db-objc-message-info value message-name message-info)))))
977
978(defun lookup-objc-message-info (message-name &optional message-info)
979  (do-interface-dirs (d)
980    (setq message-info
981          (db-note-objc-method-info (db-objc-methods d) message-name message-info)))
982  message-info)
983
984(defun %find-objc-class-info (name)
985  (do-interface-dirs (d)
986    (let* ((info (db-lookup-objc-class (db-objc-classes d) name)))
987      (when info (return info)))))
988
989(defun load-external-function (sym query)
990  (let* ((def (or (do-interface-dirs (d)
991                    (let* ((f (db-lookup-function (db-functions d) sym)))
992                      (when f (return f))))
993                  (unless query
994                    (error "Foreign function not found: ~s" sym)))))
995    (if query
996      (not (null def))
997      (progn
998        (setf (gethash sym (ftd-external-function-definitions
999                            *target-ftd*)) def)
1000        (setf (macro-function sym) #'%external-call-expander)
1001        sym))))
1002
1003(defun %read-symbol-preserving-case (stream package)
1004  (let* ((case (readtable-case *readtable*))
1005         (query nil)
1006         (error nil)
1007         (sym nil))
1008    (let* ((*package* package))
1009      (unwind-protect
1010           (progn
1011             (setf (readtable-case *readtable*) :preserve)
1012             (when (eq #\? (peek-char t stream nil nil))
1013               (setq query t)
1014               (read-char stream))
1015             (multiple-value-setq (sym error)
1016               (handler-case (read stream nil nil)
1017                 (error (condition) (values nil condition)))))
1018        (setf (readtable-case *readtable*) case)))
1019    (when error
1020      (error error))
1021    (values sym query)))
1022
1023(set-dispatch-macro-character 
1024 #\# #\$
1025 (qlfun |#$-reader| (stream char arg)
1026   (declare (ignore char))
1027   (let* ((package (find-package (ftd-interface-package-name *target-ftd*))))
1028     (multiple-value-bind (sym query)
1029         (%read-symbol-preserving-case
1030            stream
1031            package)
1032       (unless *read-suppress*
1033         (etypecase sym
1034           (symbol
1035            (if query
1036              (load-os-constant sym query)
1037              (progn
1038                (when (eq (symbol-package sym) package)
1039                  (unless arg (setq arg 0))
1040                  (ecase arg
1041                    (0
1042                     (unless (and (constant-symbol-p sym)
1043                                  (not (eq (%sym-global-value sym)
1044                                           (%unbound-marker-8))))
1045                       (load-os-constant sym)))
1046                    (1 (makunbound sym) (load-os-constant sym))))
1047                sym)))
1048           (string
1049            (let* ((val 0)
1050                   (len (length sym)))
1051              (dotimes (i 4 val)
1052                (let* ((ch (if (< i len) (char sym i) #\space)))
1053                  (setq val (logior (ash val 8) (char-code ch)))))))))))))
1054
1055(set-dispatch-macro-character #\# #\_
1056  (qlfun |#_-reader| (stream char arg)
1057    (declare (ignore char))
1058    (unless arg (setq arg 0))
1059    (multiple-value-bind (sym query)
1060        (%read-symbol-preserving-case
1061                 stream
1062                 (find-package (ftd-interface-package-name *target-ftd*)))
1063      (unless *read-suppress*
1064        (unless (and sym (symbolp sym)) (report-bad-arg sym 'symbol))
1065        (if query
1066          (load-external-function sym t)
1067          (let* ((def (if (eql arg 0)
1068                        (gethash sym (ftd-external-function-definitions
1069                                      *target-ftd*)))))
1070            (if (and def (eq (macro-function sym) #'%external-call-expander))
1071              sym
1072              (load-external-function sym nil))))))))
1073
1074(set-dispatch-macro-character
1075 #\# #\>
1076 (qlfun |#>-reader| (stream char arg)
1077    (declare (ignore char arg))
1078    (if *read-suppress*
1079      (progn
1080        (%read-list-expression stream nil)
1081        nil)
1082      (let* ((readtable *readtable*)
1083             (case (readtable-case readtable))
1084             (string nil)
1085             (error nil))
1086        (unwind-protect
1087             (progn
1088               (setf (readtable-case readtable) :preserve)
1089               (multiple-value-setq (string error)
1090                 (handler-case (read-symbol-token stream)
1091                   (error (condition) (values nil condition)))))
1092          (setf (readtable-case *readtable*) case))
1093        (when error
1094          (error error))
1095        (escape-foreign-name string)))))
1096             
1097
1098
1099
1100(eval-when (:compile-toplevel :execute)
1101  (defconstant encoded-type-void 0)
1102  (defconstant encoded-type-signed-32 1)
1103  (defconstant encoded-type-unsigned-32 2)
1104  (defconstant encoded-type-signed-8 3)
1105  (defconstant encoded-type-unsigned-8 4)
1106  (defconstant encoded-type-signed-16 5)
1107  (defconstant encoded-type-unsigned-16 6)
1108  (defconstant encoded-type-signed-n 7) ;N
1109  (defconstant encoded-type-unsigned-n 8) ;N
1110  (defconstant encoded-type-single-float 9)
1111  (defconstant encoded-type-double-float 10)
1112  (defconstant encoded-type-pointer 11) ; <type>
1113  (defconstant encoded-type-array 12) ; <size> <type>
1114  (defconstant encoded-type-named-struct-ref 13); <tag>
1115  (defconstant encoded-type-named-union-ref 14) ;<tag>
1116  (defconstant encoded-type-named-type-ref 15) ; <name>
1117  (defconstant encoded-type-anon-struct-ref 16) ; <tag>
1118  (defconstant encoded-type-anon-union-ref 17) ; <tag>
1119  (defconstant encoded-type-bitfield-marker 18) ; <nbits>
1120  )
1121
1122
1123(defconstant encoded-type-type-byte (byte 5 0))
1124(defconstant encoded-type-align-byte (byte 3 5)
1125  "alignment in octets, if other than \"natural\" alignment,")
1126
1127;;; Constants & function names get saved verbatim.
1128;;; Record, type, and field names get escaped.
1129
1130(defun encode-name (name &optional verbatim)
1131  (if (null name)
1132    (list 0)
1133    (let* ((string
1134            (if (and (typep name 'keyword)
1135                     (not verbatim))
1136              (unescape-foreign-name name)
1137              (string name)))
1138           (length (length string)))
1139      (cons length (map 'list #'char-code string)))))
1140
1141(defun encode-ffi-field (field)
1142  (destructuring-bind (name type offset width) field
1143  `(,@(encode-name name)
1144    ,@(encode-ffi-type type)
1145    ,@(encode-uint offset)
1146    ,@(encode-uint width))))
1147
1148(defun encode-ffi-field-list (fields)
1149  (let* ((len (length fields)))
1150    (labels ((encode-fields (fields)
1151               (if fields
1152                 `(,@(encode-ffi-field (car fields)) ,@(encode-fields (cdr fields))))))
1153      `(,@(encode-uint len) ,@(encode-fields fields)))))
1154
1155(defun encode-ffi-union (u)
1156  (let* ((name (ffi-union-name u))
1157         (alt-align-in-bytes-mask (ash (or (ffi-union-alt-alignment-bits u)
1158                                      0)
1159                                  (- 5 3))))
1160    (if name
1161      `(,(logior encoded-type-named-union-ref alt-align-in-bytes-mask)
1162        ,@(encode-name name)
1163        ,@(encode-ffi-field-list (ffi-union-fields u)))
1164      `(,(logior encoded-type-anon-union-ref alt-align-in-bytes-mask)
1165        ,@(encode-ffi-field-list (ffi-union-fields u))))))
1166
1167(defun encode-ffi-struct (s)
1168  (let* ((name (ffi-struct-name s))
1169         (alt-align-in-bytes-mask (ash (or (ffi-struct-alt-alignment-bits s)
1170                                           0)
1171                                       (- 5 3))))
1172    (if name
1173      `(,(logior encoded-type-named-struct-ref alt-align-in-bytes-mask)
1174        ,@(encode-name (ffi-struct-name s))
1175        ,@(encode-ffi-field-list (ffi-struct-fields s)))
1176      `(,(logior encoded-type-anon-struct-ref alt-align-in-bytes-mask)
1177        ,@(encode-ffi-field-list (ffi-struct-fields s))))))
1178
1179(defun encode-ffi-objc-class (c)
1180  (let* ((protocols (ffi-objc-class-protocol-names c)))
1181    (labels ((encode-name-list (names)
1182               (if names
1183                 `(,@(encode-name (car names) t)
1184                   ,@(encode-name-list (cdr names))))))
1185      `(,@(encode-name (ffi-objc-class-string c))
1186        ,@(encode-name (ffi-objc-class-super-foreign-name c))
1187        ,@(encode-uint (length protocols))
1188        ,@(encode-name-list protocols)
1189        ,@(encode-ffi-field-list (ffi-objc-class-own-ivars c))))))
1190
1191
1192(defstruct db-objc-class-info
1193  class-name
1194  superclass-name
1195  protocols
1196  ivars
1197  instance-methods
1198  class-methods
1199  )
1200
1201(defun extract-db-objc-class (datum &optional (ftd *target-ftd*))
1202  (let* ((val nil))
1203    (with-macptrs ((buf))
1204      (%setf-macptr buf (pref datum :cdb-datum.data))
1205      (unless (%null-ptr-p buf)
1206        (let* ((p 0)
1207               (protocol-count 0)
1208               (class-name ())
1209               (superclass-name ())
1210               (protocol-name ())
1211               (ivars ()))
1212          (collect ((protocols))
1213            (multiple-value-setq (class-name p) (%decode-name buf p t))
1214            (multiple-value-setq (superclass-name p) (%decode-name buf p t))
1215            (multiple-value-setq (protocol-count p) (%decode-uint buf p))
1216            (dotimes (i protocol-count)
1217              (multiple-value-setq (protocol-name p) (%decode-name buf p t))
1218              (protocols protocol-name))
1219            (setq ivars (%decode-field-list buf p ftd))
1220            (cdb-free (pref datum :cdb-datum.data))
1221            (setq val (make-db-objc-class-info
1222                       :class-name class-name
1223                       :superclass-name superclass-name
1224                       :ivars ivars
1225                       :protocols (protocols)
1226                     ))))))
1227    val))
1228
1229(defun db-lookup-objc-class (cdb name)
1230  (when cdb
1231    (rletZ ((value :cdb-datum)
1232            (key :cdb-datum))
1233      (with-cstrs ((keyname (string name)))
1234        (setf (pref key :cdb-datum.data) keyname
1235              (pref key :cdb-datum.size) (length (string name))
1236              (pref value :cdb-datum.data) (%null-ptr)
1237              (pref value :cdb-datum.size) 0)
1238        (cdb-get cdb key value)
1239        (extract-db-objc-class value)))))
1240
1241(defun encode-u32 (val)
1242  `(,(ldb (byte 8 24) val)
1243    ,(ldb (byte 8 16) val)
1244    ,(ldb (byte 8 8) val)
1245    ,(ldb (byte 8 0) val)))
1246
1247(defun encode-uint (val)
1248  (collect ((bytes))
1249    (do* ((b (ldb (byte 7 0) val) (ldb (byte 7 0) val))
1250          (done nil))
1251         (done (bytes))
1252      (when (zerop (setq val (ash val -7)))
1253        (setq b (logior #x80 b) done t))
1254      (bytes b))))
1255
1256   
1257
1258(defun encode-ffi-type (spec)
1259  (case (car spec)
1260    (:primitive
1261     (let ((primtype (cadr spec)))
1262       (if (atom primtype)
1263         (case primtype
1264           (:float `(,encoded-type-single-float))
1265           (:double `(,encoded-type-double-float))
1266           (:void `(,encoded-type-void))
1267           (:signed `(,encoded-type-signed-32))
1268           (:unsigned `(,encoded-type-unsigned-32))
1269           ((:long-double :complex-int
1270                        :complex-float :complex-double :complex-long-double)
1271            (encode-ffi-type `(:struct ,primtype))))
1272         (ecase (car primtype)
1273           (* `(,encoded-type-pointer ,@(encode-ffi-type
1274                                           (if (eq (cadr primtype) t)
1275                                             `(:primitive :void)
1276                                             (cadr primtype)))))
1277           (:signed
1278            (case (cadr primtype)
1279              (32 `(,encoded-type-signed-32))
1280              (16 `(,encoded-type-signed-16))
1281              (8 `(,encoded-type-signed-8))
1282              (t `(,encoded-type-signed-n ,(cadr primtype)))))
1283           (:unsigned
1284            (case (cadr primtype)
1285              (32 `(,encoded-type-unsigned-32))
1286              (16 `(,encoded-type-unsigned-16))
1287              (8 `(,encoded-type-unsigned-8))
1288              (t `(,encoded-type-unsigned-n ,(cadr primtype)))))))))
1289     (:struct
1290      (let* ((s (cadr spec))
1291             (name (ffi-struct-name s))
1292             (alt-align-bytes-mask (ash (or (ffi-struct-alt-alignment-bits s)
1293                                            0)
1294                                        (- 5 3))))
1295      `(,(if name
1296             (logior encoded-type-named-struct-ref alt-align-bytes-mask)
1297             (logior encoded-type-anon-struct-ref alt-align-bytes-mask))
1298        ,@(encode-name (ffi-struct-reference s)))))
1299     (:union
1300      (let* ((u (cadr spec))
1301             (name (ffi-union-name u))
1302             (alt-align-bytes-mask (ash (or (ffi-union-alt-alignment-bits u)
1303                                            0)
1304                                        (- 5 3)))            )
1305      `(,(if name
1306             (logior encoded-type-named-union-ref alt-align-bytes-mask)
1307             (logior encoded-type-anon-union-ref alt-align-bytes-mask))
1308        ,@(encode-name (ffi-union-reference u)))))
1309     (:typedef
1310      `(,encoded-type-named-type-ref ,@(encode-name (ffi-typedef-name (cadr spec)))))
1311     (:pointer
1312      `(,encoded-type-pointer ,@(encode-ffi-type
1313                                   (if (eq (cadr spec) t)
1314                                     '(:primitive :void)
1315                                     (cadr spec)))))
1316     (:array
1317      `(,encoded-type-array ,@(encode-uint (cadr spec)) ,@(encode-ffi-type (caddr spec))))
1318     (t
1319      (break "Type spec = ~s" spec))))
1320
1321(defun encode-ffi-arg-type (spec)
1322  (case (car spec)
1323    (:primitive
1324     (let ((primtype (cadr spec)))
1325       (if (atom primtype)
1326         (case primtype
1327           (:float `(#\s))
1328           (:double `(#\d))
1329           (:void `(#\Space))
1330           (:signed `(#\F))
1331           (:unsigned `(f))
1332           ((:long-double :complex-int
1333                          :complex-float :complex-double :complex-long-double)           
1334            #|(encode-ffi-arg-type `(:struct ,primtype))|#
1335            `(#\?)))
1336         (ecase (car primtype)
1337           (* `(#\a))
1338           (:signed
1339            (let* ((nbits (cadr primtype)))
1340              (if (<= nbits 8)
1341                '(#\B)
1342                (if (<= nbits 16)
1343                  '(#\H)
1344                  (if (<= nbits 32)
1345                    '(#\F)
1346                    (if (<= nbits 64)
1347                      `(#\L)
1348                      '(#\?)))))))
1349           (:unsigned
1350            (let* ((nbits (cadr primtype)))
1351              (if (<= nbits 8)
1352                '(#\b)
1353                (if (<= nbits 16)
1354                  '(#\h)
1355                  (if (<= nbits 32)
1356                    '(#\f)
1357                    (if (<= nbits 64)
1358                      `(#\l)
1359                      '(#\?)))))))))))
1360    ((:struct :union)
1361     `(,(if (eq (car spec) :struct)
1362                #\r
1363                #\u)
1364           ,@(encode-name (ffi-struct-reference (cadr spec)))))
1365    (:typedef
1366     `(#\t ,@(encode-name (ffi-typedef-name (cadr spec)))))
1367    (:pointer
1368      `(#\a))
1369    (:array
1370      `(#\?))))
1371
1372(defun encode-ffi-arg-list (args)
1373  (if args
1374    `(,@(encode-ffi-arg-type (car args)) ,@(encode-ffi-arg-list (cdr args)))))
1375
1376(defvar *prepend-underscores-to-ffi-function-names* nil)
1377
1378(defun encode-ffi-function (f)
1379  (let* ((args (ffi-function-arglist f))
1380         (string (ffi-function-string f))
1381         (name (if *prepend-underscores-to-ffi-function-names*
1382                 (concatenate 'string "_" string)
1383                 string))
1384         (min-args (length args))
1385         (result (ffi-function-return-value f)))
1386    `(,min-args
1387      ,@(encode-name name t)            ; verbatim
1388      ,@(encode-ffi-arg-type result)
1389      ,@(encode-ffi-arg-list args))))
1390
1391(defun encode-ffi-objc-method (m)
1392  (let* ((flag-byte (logior (if (getf (ffi-objc-method-flags m) :class) 1 0)
1393                            (if (getf (ffi-objc-method-flags m) :protocol) 2 0))))
1394  `(,flag-byte
1395    ,@(encode-name (ffi-objc-method-class-name m) t)
1396    ,@(encode-ffi-type (ffi-objc-method-result-type m))
1397    ,@(apply #'append (mapcar #'encode-ffi-type (ffi-objc-method-arglist m))))))
1398
1399(defun save-ffi-objc-message (cdbm message)
1400  (let* ((methods (ffi-objc-message-methods message))
1401         (nmethods (length methods))
1402         (nargs (length (ffi-objc-method-arglist (car methods)))))
1403    (labels ((encode-objc-method-list (ml)
1404               (when ml
1405                 `(,@(encode-ffi-objc-method (car ml))
1406                   ,@(encode-objc-method-list (cdr ml))))))
1407      (db-write-byte-list cdbm
1408                          (ffi-objc-message-string message)
1409                          `(,@(encode-uint nmethods)
1410                            ,@(encode-uint nargs)
1411                            ,@(encode-objc-method-list methods))
1412                          t))))
1413 
1414   
1415(defun save-byte-list (ptr l)
1416  (do* ((l l (cdr l))
1417        (i 0 (1+ i)))
1418       ((null l))
1419    (let* ((b (car l)))
1420      (if (typep b 'character)
1421        (setq b (char-code b)))
1422      (setf (%get-unsigned-byte ptr i) b))))
1423
1424(defun db-write-byte-list (cdbm keyname bytes &optional verbatim)
1425  (let* ((len (length bytes)))
1426    (%stack-block ((p len))
1427      (save-byte-list p bytes)
1428      (rletZ ((contents :cdb-datum)
1429              (key :cdb-datum))
1430        (let* ((foreign-name
1431                (if verbatim
1432                  keyname
1433                  (unescape-foreign-name keyname))))
1434          (with-cstrs ((keystring foreign-name))
1435            (setf (pref contents :cdb-datum.data) p
1436                  (pref contents :cdb-datum.size) len
1437                  (pref key :cdb-datum.data) keystring
1438                  (pref key :cdb-datum.size) (length foreign-name))
1439            (cdbm-put cdbm key contents)))))))
1440
1441(defun save-ffi-function (cdbm fun)
1442  (let* ((encoding (encode-ffi-function fun)))
1443    (db-write-byte-list cdbm
1444                        (ffi-function-string fun)
1445                        encoding
1446                        t)))
1447
1448(defun save-ffi-typedef (cdbm def)
1449  (db-write-byte-list cdbm
1450                       (ffi-typedef-string def)
1451                       (encode-ffi-type (ffi-typedef-type def))
1452                       t))
1453
1454(defun save-ffi-struct (cdbm s)
1455  (db-write-byte-list cdbm (ffi-struct-reference s) (encode-ffi-struct s)))
1456
1457(defun save-ffi-union (cdbm u)
1458  (db-write-byte-list cdbm (ffi-union-reference u) (encode-ffi-union u)))
1459
1460
1461
1462(defun db-define-var (cdbm name type)
1463  (db-write-byte-list cdbm
1464                      (if *prepend-underscores-to-ffi-function-names*
1465                        (concatenate 'string "_" name)
1466                        name)
1467  (encode-ffi-type type) t))
1468
1469(defun save-ffi-objc-class (cdbm c)
1470  (db-write-byte-list cdbm (ffi-objc-class-name c) (encode-ffi-objc-class c)))
1471
1472
1473;;; An "uppercase-sequence" is a maximal substring of a string that
1474;;; starts with an uppercase character and doesn't contain any
1475;;; lowercase characters.
1476(defun count-uppercase-sequences (string)
1477  (let* ((state :lower)
1478         (nupper 0))
1479    (declare (fixnum nupper))
1480    (dotimes (i (length string) nupper)
1481      (let* ((ch (char string i)))
1482        (case state
1483          (:lower 
1484           (when (upper-case-p ch)
1485             (incf nupper)
1486             (setq state :upper)))
1487          (:upper
1488           (unless (upper-case-p ch)
1489             (setq state :lower))))))))
1490
1491(defun escape-foreign-name (in &optional
1492                               (count (count-uppercase-sequences in)))
1493  (intern
1494   (if (zerop count)
1495     (string-upcase in)
1496     (let* ((len (length in))
1497            (j 0)
1498            (out (make-string (+ len (* 2 count))))
1499            (state :lower))
1500       (flet ((outch (ch)
1501                (setf (schar out j) ch)
1502                (incf j)
1503                ch))
1504         (dotimes (i len (progn (if (eq state :upper) (outch #\>)) out))
1505           (let* ((ch (char in i)))
1506             (cond ((and (upper-case-p ch) (eq state :lower))
1507                    (outch #\<)
1508                    (setq state :upper))
1509                   ((and (not (upper-case-p ch)) (eq state :upper))
1510                    (outch #\>)
1511                    (setq state :lower)))
1512             (outch (char-upcase ch)))))))
1513   *keyword-package*))
1514
1515(defun unescape-foreign-name (key)
1516  (let* ((string (if (typep key 'symbol)
1517                   (string-downcase key)
1518                   (string key)))
1519         (nleftbrackets (count #\< string))
1520         (nrightbrackets (count #\> string))
1521         (nbrackets (+ nleftbrackets nrightbrackets)))
1522    (declare (fixnum nleftbrackets nrightbrackets nbrackets))
1523    (if (zerop nbrackets)
1524      string
1525      (if (/= nleftbrackets nrightbrackets)
1526        (error "Mismatched brackets in ~s." key)
1527        (let* ((len (length string))
1528               (out (make-string (- len nbrackets)))
1529               (j 0)
1530               (state :lower))
1531          (dotimes (i len out)
1532            (let* ((ch (schar string i)))
1533              (if (or (and (eq ch #\<)
1534                           (eq state :upper))
1535                      (and (eq ch #\>)
1536                           (eq state :lower)))
1537                (error "Mismatched brackets in ~s." key))
1538              (case ch
1539                (#\< (setq state :upper))
1540                (#\> (setq state :lower))
1541                (t (setf (schar out j) (if (eq state :upper)
1542                                         (char-upcase ch)
1543                                         (char-downcase ch))
1544                         j (1+ j)))))))))))
1545
1546       
1547       
1548(defun %decode-name (buf p &optional verbatim)
1549  (declare (type macptr buf) (fixnum p))
1550  (let* ((n (%get-unsigned-byte buf p)))
1551    (declare (fixnum n))
1552    (if (zerop n)
1553      (values nil (1+ p))
1554      (let* ((pname (%str-from-ptr (%inc-ptr buf (1+ p)) n)))
1555        (values (if verbatim pname (escape-foreign-name pname))
1556                (+ p (1+ n)))))))
1557
1558(defun %decode-u32 (buf p)
1559  (declare (fixnum p) (type macptr buf))
1560  (values (dpb
1561           (%get-unsigned-byte buf p)
1562           (byte 8 24)
1563           (dpb
1564            (%get-unsigned-byte buf (+ p 1))
1565            (byte 8 16)
1566            (dpb
1567             (%get-unsigned-byte buf (+ p 2))
1568             (byte 8 8)
1569             (%get-unsigned-byte buf (+ p 3)))))
1570          (+ p 4)))
1571
1572(defun %decode-uint (buf p)
1573  (do* ((val 0)
1574        (p p (1+ p))
1575        (shift 0 (+ shift 7))
1576        (done nil))
1577       (done (values val p))
1578    (let* ((b (%get-unsigned-byte buf p)))
1579      (setq done (logbitp 7 b) val (logior val (ash (logand b #x7f) shift))))))
1580       
1581 
1582;; Should return a FOREIGN-TYPE structure.
1583(defun %decode-type (buf p ftd &optional suppress-typedef-expansion)
1584  (declare (type macptr buf) (fixnum p))
1585  (let* ((q (1+ p)))
1586    (ecase (ldb encoded-type-type-byte (%get-unsigned-byte buf p))
1587      (#.encoded-type-void (values (parse-foreign-type :void) q))
1588      (#.encoded-type-signed-32 (values (svref *signed-integer-types* 32) q))
1589      (#.encoded-type-unsigned-32 (values (svref *unsigned-integer-types* 32) q))
1590      (#.encoded-type-signed-8 (values (svref *signed-integer-types* 8) q))
1591      (#.encoded-type-unsigned-8 (values (svref *unsigned-integer-types* 8) q))
1592      (#.encoded-type-signed-16 (values (svref *signed-integer-types* 16) q))
1593      (#.encoded-type-unsigned-16 (values (svref *unsigned-integer-types* 16) q))
1594      (#.encoded-type-signed-n (values (let* ((bits (%get-unsigned-byte buf q)))
1595                                         (if (<= bits 32)
1596                                           (svref *signed-integer-types* bits)
1597                                           (make-foreign-integer-type
1598                                            :signed t
1599                                            :bits bits)))
1600                                         (1+ q)))
1601      (#.encoded-type-unsigned-n (values (let* ((bits (%get-unsigned-byte buf q)))
1602                                         (if (<= bits 32)
1603                                           (svref *unsigned-integer-types* bits)
1604                                           (make-foreign-integer-type
1605                                            :signed nil
1606                                            :bits bits)))
1607                                           (1+ q)))
1608      (#.encoded-type-single-float (values (parse-foreign-type :float) q))
1609      (#.encoded-type-double-float (values (parse-foreign-type :double) q))
1610      (#.encoded-type-pointer (multiple-value-bind (target qq)
1611                                  (%decode-type buf q ftd suppress-typedef-expansion)
1612                                (values (make-foreign-pointer-type
1613                                         :to target
1614                                         :bits (getf (ftd-attributes ftd)
1615                                                     :bits-per-word)
1616                                         )
1617                                          qq)))
1618      (#.encoded-type-array
1619       (multiple-value-bind (size qq) (%decode-uint buf q)
1620         (multiple-value-bind (target qqq) (%decode-type buf qq ftd)
1621           (let* ((type-alignment (foreign-type-alignment target))
1622                  (type-bits (foreign-type-bits target)))
1623             (values (make-foreign-array-type
1624                      :element-type target
1625                      :dimensions (list size)
1626                      :alignment type-alignment
1627                      :bits (if type-bits
1628                              (* (align-offset type-bits type-alignment) size)))
1629                     qqq)))))
1630      (#.encoded-type-named-type-ref
1631       (multiple-value-bind (name qq) (%decode-name buf q)         
1632         (values (if suppress-typedef-expansion
1633                   name
1634                   (%parse-foreign-type name))
1635                 qq)))
1636      (#.encoded-type-named-struct-ref
1637       (multiple-value-bind (name qq) (%decode-name buf q)
1638         (values (or (info-foreign-type-struct name)
1639                     (setf (info-foreign-type-struct name)
1640                           (make-foreign-record-type :kind :struct
1641                                                     :name name)))
1642                 qq)))
1643      (#.encoded-type-named-union-ref
1644       (multiple-value-bind (name qq) (%decode-name buf q)
1645         (values (or (info-foreign-type-union name)
1646                     (setf (info-foreign-type-union name)
1647                           (make-foreign-record-type :kind :union
1648                                                     :name name)))
1649                 qq)))
1650      ((#.encoded-type-anon-struct-ref #.encoded-type-anon-union-ref)
1651       (multiple-value-bind (tag qq) (%decode-name buf q t)
1652         (values (load-record tag) qq))))))
1653
1654(defun extract-db-type (datum ftd)
1655  (let* ((data (pref datum :cdb-datum.data)))
1656    (unless (%null-ptr-p data)
1657      (prog1
1658          (%decode-type data 0 ftd)
1659        (cdb-free data)))))
1660
1661(defun %load-foreign-type (cdb name ftd)
1662  (when cdb
1663    (with-cstrs ((string (string name)))
1664      (rletZ ((contents :cdb-datum)
1665              (key :cdb-datum))
1666        (setf (pref key :cdb-datum.size) (length (string name))
1667            (pref key :cdb-datum.data) string
1668            (pref contents :cdb-datum.data) (%null-ptr)
1669            (pref contents :cdb-datum.size) 0)
1670      (cdb-get cdb key contents)
1671      (let* ((type (extract-db-type contents ftd)))
1672        (if type
1673          (%def-foreign-type (escape-foreign-name name) type ftd)))))))
1674
1675(defun load-foreign-type (name &optional (ftd *target-ftd*))
1676  (let* ((name (unescape-foreign-name name)))
1677    (do-interface-dirs (d ftd)
1678      (let* ((type (%load-foreign-type (db-types d) name ftd)))
1679        (when type (return type))))))
1680
1681(defun %decode-field (buf p ftd)
1682  (declare (type macptr buf) (fixnum p))
1683  (multiple-value-bind (name p) (%decode-name buf p)
1684    (multiple-value-bind (type p) (%decode-type buf p ftd)
1685      (multiple-value-bind (offset p) (%decode-uint buf p)
1686        (multiple-value-bind (width p) (%decode-uint buf p)
1687          (values (make-foreign-record-field :type type
1688                                             :name name
1689                                             :bits width
1690                                             :offset offset)
1691                  p))))))
1692
1693(defun %decode-field-list (buf p ftd)
1694  (declare (type macptr buf) (fixnum p))
1695  (let* ((n nil)
1696         (fields nil))
1697    (multiple-value-setq (n p) (%decode-uint buf p))
1698    (dotimes (i n (values (nreverse fields) p))
1699      (multiple-value-bind (field q) (%decode-field buf p ftd)
1700        (push field fields)
1701        (setq p q)))))
1702
1703(defun %determine-record-attributes (rtype parsed-fields &optional alt-align)
1704  (let* ((total-bits 0)
1705         (overall-alignment 1)
1706         #+(and darwinppc-target ppc32-target)
1707         (first-field-p t)
1708         (kind (foreign-record-type-kind rtype)))
1709    (dolist (field parsed-fields)
1710      (let* ((field-type (foreign-record-field-type field))
1711             (bits (ensure-foreign-type-bits field-type))
1712             (natural-alignment (foreign-type-alignment field-type))
1713             (alignment (if alt-align
1714                          (min natural-alignment alt-align)
1715                          #+(and darwinppc-target ppc32-target)
1716                          (if first-field-p
1717                            (progn
1718                              (setq first-field-p nil)
1719                              natural-alignment)
1720                            (min 32 natural-alignment))
1721                          #-(and darwinppc-target ppc32-target)
1722                          natural-alignment)))
1723        (unless bits
1724          (error "Unknown size: ~S"
1725                 (unparse-foreign-type field-type)))
1726        (unless alignment
1727          (error "Unknown alignment: ~S"
1728                 (unparse-foreign-type field-type)))
1729        (setq overall-alignment (max overall-alignment (if (= alignment 1) 32 alignment)))
1730        (ecase kind
1731          (:struct (let* ((imported-offset (foreign-record-field-offset field))
1732                          (offset (or imported-offset (align-offset total-bits alignment))))
1733                     (unless imported-offset
1734                       (setf (foreign-record-field-offset field) offset))
1735                     (setq total-bits (+ offset bits))))
1736          (:union (setq total-bits (max total-bits bits))))))
1737    (setf (foreign-record-type-fields rtype) parsed-fields
1738          (foreign-record-type-alignment rtype) (or
1739                                                 alt-align
1740                                                 overall-alignment)
1741          (foreign-record-type-bits rtype) (align-offset
1742                                            total-bits
1743                                            (or alt-align overall-alignment))
1744          (foreign-record-type-alt-align rtype) alt-align)
1745    rtype))
1746
1747(defun %decode-record-type (buf p ftd already)
1748  (declare (type macptr buf) (fixnum p))
1749  (let* ((rbyte (%get-unsigned-byte buf p))
1750         (rcode (ldb encoded-type-type-byte rbyte))
1751         (ralign-in-bytes (ldb encoded-type-align-byte rbyte))
1752         (alt-align (unless (zerop ralign-in-bytes)
1753                      (the fixnum (ash ralign-in-bytes 3)))))
1754    (declare (fixnum rbyte rcode ralign-in-bytes))
1755    (multiple-value-bind (name q)
1756        (case rcode
1757          ((#.encoded-type-anon-struct-ref #.encoded-type-anon-union-ref)
1758           (values nil (1+ p)))
1759          (t
1760           (%decode-name buf (1+ p))))
1761      (%determine-record-attributes
1762       (or already
1763           (if name
1764             (if (eql rcode encoded-type-named-struct-ref)
1765               (or (info-foreign-type-struct name)
1766                   (setf (info-foreign-type-struct name)
1767                         (make-foreign-record-type :kind :struct :name name)))
1768               (or (info-foreign-type-union name)
1769                   (setf (info-foreign-type-union name)
1770                         (make-foreign-record-type :kind :union :name name))))
1771             (make-foreign-record-type
1772              :kind (if (eql rcode encoded-type-anon-struct-ref)
1773                      :struct
1774                      :union)
1775              :name name)))
1776       (%decode-field-list buf q ftd)
1777       alt-align))))
1778
1779(defun extract-db-record (datum ftd already)
1780  (let* ((data (pref datum :cdb-datum.data)))
1781    (unless (%null-ptr-p data)
1782      (prog1
1783          (%decode-record-type data 0 ftd already)
1784        (cdb-free data)))))
1785
1786
1787(defun %load-foreign-record (cdb name ftd already)
1788  (when cdb
1789    (with-cstrs ((string (string name)))
1790      (rlet ((contents :cdb-datum)
1791             (key :cdb-datum))
1792        (setf (pref key :cdb-datum.size) (length (string name))
1793              (pref key :cdb-datum.data) string
1794              (pref contents :cdb-datum.data) (%null-ptr)
1795              (pref contents :cdb-datum.size) 0)
1796        (cdb-get cdb key contents)
1797        (extract-db-record contents ftd already)))))
1798
1799(defun load-record (name &optional (ftd *target-ftd*))
1800  ;; Try to destructively modify any info we already have.  Use the
1801  ;; "escaped" name (keyword) for the lookup here.
1802  (let* ((already (or (info-foreign-type-struct name ftd)
1803                      (info-foreign-type-union name ftd)))
1804         (name (unescape-foreign-name name)))
1805    (do-interface-dirs (d)
1806      (let* ((r (%load-foreign-record (db-records d) name ftd already)))
1807        (when r (return r))))))
1808
1809
Note: See TracBrowser for help on using the repository browser.