1 ;;;; Foreign symbol linkage
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!IMPL")
14 ;;; *STATIC-FOREIGN-SYMBOLS* are static as opposed to "dynamic" (not
15 ;;; as opposed to C's "extern"). The table contains symbols known at
16 ;;; the time that the program was built, but not symbols defined in
17 ;;; object files which have been loaded dynamically since then.
18 (declaim (type hash-table *static-foreign-symbols*))
19 (defvar *static-foreign-symbols* (make-hash-table :test 'equal))
21 (defun find-foreign-symbol-in-table (name table)
22 (some (lambda (prefix)
23 (gethash (concatenate 'string prefix name) table))
26 (defun foreign-symbol-address-as-integer-or-nil (name &optional datap)
27 (declare (ignorable datap))
28 (or (find-foreign-symbol-in-table name *static-foreign-symbols*)
32 (values #!-linkage-table
33 (get-dynamic-foreign-symbol-address name)
35 (ensure-foreign-symbol-linkage name datap)
38 (defun foreign-symbol-address-as-integer (name &optional datap)
39 (or (foreign-symbol-address-as-integer-or-nil name datap)
40 (error "Unknown foreign symbol: ~S" name)))
42 (defun foreign-symbol-address (symbol &optional datap)
43 (declare (ignorable datap))
44 (let ((name (sb!vm:extern-alien-name symbol)))
46 (int-sap (foreign-symbol-address-as-integer name))
48 (multiple-value-bind (addr sharedp)
49 (foreign-symbol-address-as-integer name datap)
52 ;; If the address is from linkage-table and refers to data
53 ;; we need to do a bit of juggling.
54 (if (and sharedp datap)
55 (int-sap (sap-ref-word (int-sap addr) 0))
59 (defun foreign-reinit ()
61 (reopen-shared-objects)
63 (update-linkage-table))
65 ;;; Cleanups before saving a core
67 (defun foreign-deinit ()
68 ;; KLUDGE: Giving this warning only when non-static foreign symbols
69 ;; are used would be much nicer, but actually pretty hard: we can
70 ;; get dynamic symbols thru the runtime as well, so cheking the
71 ;; list of *shared-objects* is not enough. Eugh & blech.
72 #!+(and os-provides-dlopen (not linkage-table))
73 (when (dynamic-foreign-symbols)
74 (warn "~@<Saving cores with alien definitions referring to non-static ~
75 foreign symbols is unsupported on this platform: references to ~
76 such foreign symbols from the restarted core will not work. You ~
77 may be able to work around this limitation by reloading all ~
78 foreign definitions and code using them in the restarted core, ~
79 but no guarantees.~%~%Dynamic foreign symbols in this core: ~
80 ~{~A~^, ~}~:@>" (dynamic-foreign-symbols)))
82 (close-shared-objects))
84 (defun foreign-symbol-in-address (sap)
85 (declare (ignorable sap))
87 (let ((addr (sap-int sap)))
88 (declare (ignorable addr))
90 (when (<= sb!vm:linkage-table-space-start
92 sb!vm:linkage-table-space-end)
93 (maphash (lambda (name info)
94 (let ((table-addr (linkage-info-address info)))
97 (+ table-addr sb!vm:linkage-table-entry-size))
98 (return-from foreign-symbol-in-address name))))
100 #!+os-provides-dladdr
101 (with-alien ((info (struct dl-info
105 (symbol-address unsigned)))
106 (dladdr (function unsigned unsigned (* (struct dl-info)))
108 (let ((err (alien-funcall dladdr addr (addr info))))
111 (slot info 'symbol))))
112 ;; FIXME: Even in the absence of dladdr we could search the
113 ;; static foreign symbols (and *linkage-info*, for that matter).
116 ;;; How we learn about foreign symbols and dlhandles initially
117 (defvar *!initial-foreign-symbols*)
120 (defun !foreign-cold-init ()
121 (dolist (symbol *!initial-foreign-symbols*)
122 (setf (gethash (car symbol) *static-foreign-symbols*) (cdr symbol)))
123 #!+os-provides-dlopen
124 (setf *runtime-dlhandle* (dlopen-or-lose)
125 *shared-objects* nil))
127 #!-os-provides-dlopen
128 (define-unsupported-fun load-shared-object)