(in-package "SB!ALIEN")
+;;; Used to serialize modifications to *linkage-info*,
+;;; *shared-objects* and the linkage-table proper. Calls thru
+;;; linkage-table are unaffected.
+(defvar *foreign-lock*
+ (sb!thread:make-mutex :name "foreign definition lock"))
+
(define-unsupported-fun load-foreign
"Unsupported as of SBCL 0.8.13. See LOAD-SHARED-OBJECT."
- "~S is unsupported as of SBCL 0.8.13. See LOAD-SHARED-OBJECT."
+ "~S is unsupported as of SBCL 0.8.13. See LOAD-SHARED-OBJECT."
(load-foreign))
-
+
(define-unsupported-fun load-1-foreign
"Unsupported as of SBCL 0.8.13. Please use LOAD-SHARED-OBJECT."
"~S is unsupported as of SBCL 0.8.13. Please use LOAD-SHARED-OBJECT."
(handle system-area-pointer)
(symbol c-string))
+(define-alien-variable undefined-alien-address unsigned-long)
+
(defvar *runtime-dlhandle*)
(defvar *shared-objects*)
(defstruct shared-object file sap)
-(defun dlopen-or-lose (filename)
- (dlerror) ; clear old errors
- (let ((sap (dlopen filename (logior rtld-global rtld-now))))
+(defun dlopen-or-lose (&optional (obj nil objp))
+ (when objp
+ (dlclose-or-lose obj))
+ (dlerror) ; clear errors
+ (let* ((file (and obj (shared-object-file obj)))
+ (sap (dlopen file (logior rtld-global rtld-now))))
+ (aver (or (not objp) file))
(when (zerop (sap-int sap))
- (error "Could not open ~:[runtime~;~:*shared object ~S~]: ~A"
- filename (dlerror)))
+ (if objp
+ (setf (shared-object-sap obj) nil)
+ (setf *runtime-dlhandle* nil))
+ (error "Error opening ~:[runtime~;shared object ~:*~S~]:~% ~A."
+ file (dlerror)))
+ (when objp
+ (setf (shared-object-sap obj) sap))
sap))
-(defun load-shared-object (file)
- "Load a shared library/dynamic shared object file/general
-dlopenable alien container.
-
-To use LOAD-SHARED-OBJECT, at the Unix command line do this:
+(defun dlclose-or-lose (&optional (obj nil objp))
+ (dlerror)
+ (let (dlerror)
+ (cond ((and (not objp) *runtime-dlhandle*)
+ (dlclose *runtime-dlhandle*)
+ (setf dlerror (dlerror)
+ *runtime-dlhandle* nil))
+ ((and objp (shared-object-sap obj))
+ (dlclose (shared-object-sap obj))
+ (setf dlerror (dlerror)
+ (shared-object-sap obj) nil)))
+ (when dlerror
+ (cerror "Ignore the error and continue anyway" "dlerror returned an error: ~S" dlerror))))
- echo 'int summish(int x, int y) { return 1 + x + y; }' > /tmp/ffi-test.c
- make /tmp/ffi-test.o # i.e. cc -c -o /tmp/ffi-test.o /tmp/ffi-test.c
- ld -shared -o /tmp/ffi-test.so /tmp/ffi-test.o
-
-Then in SBCL do this:
-
- (load-shared-object \"/tmp/ffi-test.so\")
- (define-alien-routine summish int (x int) (y int))
-
-Now running (summish 10 20) should return 31."
- (let* ((real-file (or (unix-namestring file) file))
- (sap (dlopen-or-lose real-file))
- (obj (make-shared-object :file real-file :sap sap)))
- (unless (member sap *shared-objects*
- :test #'sap= :key #'shared-object-sap)
- (setf *shared-objects* (append *shared-objects* (list obj))))
- (pathname real-file)))
+(defun load-shared-object (file)
+ "Load a shared library/dynamic shared object file/general dlopenable
+alien container, such as a .so on an ELF platform.
+
+Reloading the same shared object will replace the old definitions; if
+a symbol was previously referenced thru the object and is not present
+in the reloaded version an error will be signalled. Sameness is
+determined using the library filename. Reloading may not work as
+expected if user or library-code has called dlopen on FILE.
+
+References to foreign symbols in loaded shared objects do not survive
+intact through SB-EXT:SAVE-LISP-AND die on all platforms. See
+SB-EXT:SAVE-LISP-AND-DIE for details."
+ (sb!thread:with-mutex (*foreign-lock*)
+ (let* ((filename (or (unix-namestring file) file))
+ (old (find filename *shared-objects* :key #'shared-object-file :test #'equal))
+ (obj (or old (make-shared-object :file filename))))
+ (dlopen-or-lose obj)
+ (setf *shared-objects* (append (remove obj *shared-objects*)
+ (list obj)))
+ #!+linkage-table
+ (when (or old (undefined-foreign-symbols-p))
+ (update-linkage-table))
+ (pathname filename))))
(defun try-reopen-shared-object (obj)
- (restart-case
- (let ((sap (dlopen-or-lose (shared-object-file obj))))
- (setf (shared-object-sap obj) sap)
- obj)
- (skip ()
- :report "Skip this shared object and continue. References to ~
- foreign symbols in this shared object will fail, ~
- causing potential corruption."
- *runtime-dlhandle*)))
+ (declare (type shared-object obj))
+ (tagbody :dlopen
+ (restart-case
+ (dlopen-or-lose obj)
+ (continue ()
+ :report "Skip this shared object and continue."
+ (setf (shared-object-sap obj) nil))
+ (retry ()
+ :report "Retry loading this shared object."
+ (go :dlopen))
+ (load-other ()
+ :report "Specify an alternate shared object file to load."
+ (setf (shared-object-file obj)
+ (tagbody :query
+ (format *query-io* "~&Enter pathname (evaluated):~%")
+ (force-output *query-io*)
+ (let ((pathname (ignore-errors (pathname (read *query-io*)))))
+ (unless (pathnamep pathname)
+ (format *query-io* "~&Error: invalid pathname.~%")
+ (go :query))
+ (unix-namestring pathname)))))))
+ obj)
;;; Open libraries in *SHARED-OBJECTS* and the runtime. Called during
-;;; initialization.
+;;; initialization.
(defun reopen-shared-objects ()
- ;; Ensure that the runtime is present in the list
- (setf *runtime-dlhandle* (dlopen-or-lose nil)
+ ;; Ensure that the runtime is open
+ (setf *runtime-dlhandle* (dlopen-or-lose)
*shared-objects* (mapcar #'try-reopen-shared-object *shared-objects*)))
;;; Close all dlopened libraries and clear out sap entries in
;;; *SHARED-OBJECTS*.
(defun close-shared-objects ()
- (dolist (obj (reverse *shared-objects*))
- (dlclose (shared-object-sap obj))
- (setf (shared-object-sap obj) nil))
- (dlclose *runtime-dlhandle*)
- (setf *runtime-dlhandle* nil))
-
-(defun get-dynamic-foreign-symbol-address (symbol)
- (dlerror) ; clear old errors
- (let ((result (sap-int (dlsym *runtime-dlhandle* symbol)))
- (err (dlerror)))
+ (mapc #'dlclose-or-lose (reverse *shared-objects*))
+ (dlclose-or-lose))
+
+(defun find-dynamic-foreign-symbol-address (symbol)
+ (dlerror) ; clear old errors
+ (unless *runtime-dlhandle*
+ (bug "Cannot resolve foreign symbol: lost *runtime-dlhandle*"))
+ ;; On real ELF & dlsym platforms the EXTERN-ALIEN-NAME is a no-op,
+ ;; but on platforms where dlsym is simulated we use the mangled name.
+ (let* ((extern (extern-alien-name symbol))
+ (result (sap-int (dlsym *runtime-dlhandle* extern)))
+ (err (dlerror)))
(if (or (not (zerop result)) (not err))
result
(dolist (obj *shared-objects*)
- (setf result (sap-int (dlsym (shared-object-sap obj) symbol))
- err (dlerror))
- (when (or (not (zerop result)) (not err))
- (return result))))))
+ (let ((sap (shared-object-sap obj)))
+ (when sap
+ (setf result (sap-int (dlsym sap extern))
+ err (dlerror))
+ (when (or (not (zerop result)) (not err))
+ (return result))))))))
+
+(let ((symbols (make-hash-table :test #'equal))
+ (undefineds (make-hash-table :test #'equal)))
+ (defun ensure-dynamic-foreign-symbol-address (symbol &optional datap)
+ "Returns the address of the foreign symbol as an integer. On linkage-table
+ports if the symbols isn't found a special guard address is returned instead,
+accesses to which will result in an UNDEFINED-ALIEN-ERROR. On other ports an
+error is immediately signalled if the symbol isn't found. The returned address
+is never in the linkage-table."
+ (declare (ignorable datap))
+ (let ((addr (find-dynamic-foreign-symbol-address symbol)))
+ (cond #!-linkage-table
+ ((not addr)
+ (error 'undefined-alien-error :name symbol))
+ #!+linkage-table
+ ((not addr)
+ (style-warn "Undefined alien: ~S" symbol)
+ (setf (gethash symbol undefineds) t)
+ (remhash symbol symbols)
+ (if datap
+ undefined-alien-address
+ (foreign-symbol-address "undefined_alien_function")))
+ (addr
+ (setf (gethash symbol symbols) t)
+ (remhash symbol undefineds)
+ addr))))
+ (defun undefined-foreign-symbols-p ()
+ (plusp (hash-table-count undefineds)))
+ (defun dynamic-foreign-symbols-p ()
+ (plusp (hash-table-count symbols)))
+ (defun list-dynamic-foreign-symbols ()
+ (loop for symbol being each hash-key in symbols
+ collect symbol)))
+
projects / sbcl.git / blobdiff