1 ;;;; the VOPs and other necessary machine specific support
2 ;;;; routines for call-out to C
4 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
15 ;; The MOVE-ARG vop is going to store args on the stack for
16 ;; call-out. These tn's will be used for that. move-arg is normally
17 ;; used for things going down the stack but C wants to have args
18 ;; indexed in the positive direction.
20 (defun my-make-wired-tn (prim-type-name sc-name offset)
21 (make-wired-tn (primitive-type-or-lose prim-type-name)
22 (sc-number-or-lose sc-name)
25 (defstruct (arg-state (:copier nil))
30 (defun int-arg (state prim-type reg-sc stack-sc)
31 (let ((reg-args (arg-state-register-args state)))
33 (setf (arg-state-register-args state) (1+ reg-args))
34 (my-make-wired-tn prim-type reg-sc
35 (nth reg-args *c-call-register-arg-offsets*)))
37 (let ((frame-size (arg-state-stack-frame-size state)))
38 (setf (arg-state-stack-frame-size state) (1+ frame-size))
39 (my-make-wired-tn prim-type stack-sc frame-size))))))
41 (define-alien-type-method (integer :arg-tn) (type state)
42 (if (alien-integer-type-signed type)
43 (int-arg state 'signed-byte-64 'signed-reg 'signed-stack)
44 (int-arg state 'unsigned-byte-64 'unsigned-reg 'unsigned-stack)))
46 (define-alien-type-method (system-area-pointer :arg-tn) (type state)
47 (declare (ignore type))
48 (int-arg state 'system-area-pointer 'sap-reg 'sap-stack))
50 (defun float-arg (state prim-type reg-sc stack-sc)
51 (let ((xmm-args (arg-state-xmm-args state)))
53 (setf (arg-state-xmm-args state) (1+ xmm-args))
54 (my-make-wired-tn prim-type reg-sc
55 (nth xmm-args *float-regs*)))
57 (let ((frame-size (arg-state-stack-frame-size state)))
58 (setf (arg-state-stack-frame-size state) (1+ frame-size))
59 (my-make-wired-tn prim-type stack-sc frame-size))))))
61 (define-alien-type-method (double-float :arg-tn) (type state)
62 (declare (ignore type))
63 (float-arg state 'double-float 'double-reg 'double-stack))
65 (define-alien-type-method (single-float :arg-tn) (type state)
66 (declare (ignore type))
67 (float-arg state 'single-float 'single-reg 'single-stack))
69 (defstruct (result-state (:copier nil))
72 (defun result-reg-offset (slot)
77 (define-alien-type-method (integer :result-tn) (type state)
78 (let ((num-results (result-state-num-results state)))
79 (setf (result-state-num-results state) (1+ num-results))
80 (multiple-value-bind (ptype reg-sc)
81 (if (alien-integer-type-signed type)
82 (values 'signed-byte-64 'signed-reg)
83 (values 'unsigned-byte-64 'unsigned-reg))
84 (my-make-wired-tn ptype reg-sc (result-reg-offset num-results)))))
86 (define-alien-type-method (integer :naturalize-gen) (type alien)
87 (if (<= (alien-type-bits type) 32)
88 (if (alien-integer-type-signed type)
89 `(sign-extend ,alien ,(alien-type-bits type))
90 `(logand ,alien ,(1- (ash 1 (alien-type-bits type)))))
93 (define-alien-type-method (system-area-pointer :result-tn) (type state)
94 (declare (ignore type))
95 (let ((num-results (result-state-num-results state)))
96 (setf (result-state-num-results state) (1+ num-results))
97 (my-make-wired-tn 'system-area-pointer 'sap-reg
98 (result-reg-offset num-results))))
100 (define-alien-type-method (double-float :result-tn) (type state)
101 (declare (ignore type))
102 (let ((num-results (result-state-num-results state)))
103 (setf (result-state-num-results state) (1+ num-results))
104 (my-make-wired-tn 'double-float 'double-reg num-results)))
106 (define-alien-type-method (single-float :result-tn) (type state)
107 (declare (ignore type))
108 (let ((num-results (result-state-num-results state)))
109 (setf (result-state-num-results state) (1+ num-results))
110 (my-make-wired-tn 'single-float 'single-reg num-results)))
112 (define-alien-type-method (values :result-tn) (type state)
113 (let ((values (alien-values-type-values type)))
114 (when (> (length values) 2)
115 (error "Too many result values from c-call."))
116 (mapcar (lambda (type)
117 (invoke-alien-type-method :result-tn type state))
120 (!def-vm-support-routine make-call-out-tns (type)
121 (let ((arg-state (make-arg-state)))
123 (dolist (arg-type (alien-fun-type-arg-types type))
124 (arg-tns (invoke-alien-type-method :arg-tn arg-type arg-state)))
125 (values (my-make-wired-tn 'positive-fixnum 'any-reg esp-offset)
126 (* (arg-state-stack-frame-size arg-state) n-word-bytes)
128 (invoke-alien-type-method :result-tn
129 (alien-fun-type-result-type type)
130 (make-result-state))))))
133 (deftransform %alien-funcall ((function type &rest args) * * :node node)
134 (aver (sb!c::constant-lvar-p type))
135 (let* ((type (sb!c::lvar-value type))
136 (env (sb!c::node-lexenv node))
137 (arg-types (alien-fun-type-arg-types type))
138 (result-type (alien-fun-type-result-type type)))
139 (aver (= (length arg-types) (length args)))
140 (if (or (some #'(lambda (type)
141 (and (alien-integer-type-p type)
142 (> (sb!alien::alien-integer-type-bits type) 64)))
144 (and (alien-integer-type-p result-type)
145 (> (sb!alien::alien-integer-type-bits result-type) 64)))
146 (collect ((new-args) (lambda-vars) (new-arg-types))
147 (dolist (type arg-types)
148 (let ((arg (gensym)))
150 (cond ((and (alien-integer-type-p type)
151 (> (sb!alien::alien-integer-type-bits type) 64))
152 ;; CLH: FIXME! This should really be
153 ;; #xffffffffffffffff. nyef says: "Passing
154 ;; 128-bit integers to ALIEN functions on x86-64
155 ;; believed to be broken."
156 (new-args `(logand ,arg #xffffffff))
157 (new-args `(ash ,arg -64))
158 (new-arg-types (parse-alien-type '(unsigned 64) env))
159 (if (alien-integer-type-signed type)
160 (new-arg-types (parse-alien-type '(signed 64) env))
161 (new-arg-types (parse-alien-type '(unsigned 64) env))))
164 (new-arg-types type)))))
165 (cond ((and (alien-integer-type-p result-type)
166 (> (sb!alien::alien-integer-type-bits result-type) 64))
167 (let ((new-result-type
168 (let ((sb!alien::*values-type-okay* t))
170 (if (alien-integer-type-signed result-type)
171 '(values (unsigned 64) (signed 64))
172 '(values (unsigned 64) (unsigned 64)))
174 `(lambda (function type ,@(lambda-vars))
175 (declare (ignore type))
176 (multiple-value-bind (low high)
177 (%alien-funcall function
178 ',(make-alien-fun-type
179 :arg-types (new-arg-types)
180 :result-type new-result-type)
182 (logior low (ash high 64))))))
184 `(lambda (function type ,@(lambda-vars))
185 (declare (ignore type))
186 (%alien-funcall function
187 ',(make-alien-fun-type
188 :arg-types (new-arg-types)
189 :result-type result-type)
191 (sb!c::give-up-ir1-transform))))
193 ;;; The ABI is vague about how signed sub-word integer return values
194 ;;; are handled, but since gcc versions >=4.3 no longer do sign
195 ;;; extension in the callee, we need to do it in the caller. FIXME:
196 ;;; If the value to be extended is known to already be of the target
197 ;;; type at compile time, we can (and should) elide the extension.
198 (defknown sign-extend ((signed-byte 64) t) fixnum
199 (foldable flushable movable))
201 (define-vop (sign-extend)
202 (:translate sign-extend)
204 (:args (val :scs (signed-reg)))
205 (:arg-types signed-num (:constant fixnum))
207 (:results (res :scs (signed-reg)))
208 (:result-types fixnum)
211 (make-random-tn :kind :normal
212 :sc (sc-or-lose (ecase size
216 :offset (tn-offset val)))))
219 (defun sign-extend (x size)
220 (declare (type (signed-byte 64) x))
222 (8 (sign-extend x size))
223 (16 (sign-extend x size))
224 (32 (sign-extend x size))))
227 (defun sign-extend (x size)
228 (if (logbitp (1- size) x)
229 (dpb x (byte size 0) -1)
232 (define-vop (foreign-symbol-sap)
233 (:translate foreign-symbol-sap)
236 (:arg-types (:constant simple-string))
237 (:info foreign-symbol)
238 (:results (res :scs (sap-reg)))
239 (:result-types system-area-pointer)
241 (inst lea res (make-fixup foreign-symbol :foreign))))
244 (define-vop (foreign-symbol-dataref-sap)
245 (:translate foreign-symbol-dataref-sap)
248 (:arg-types (:constant simple-string))
249 (:info foreign-symbol)
250 (:results (res :scs (sap-reg)))
251 (:result-types system-area-pointer)
253 (inst mov res (make-fixup foreign-symbol :foreign-dataref))))
255 (define-vop (call-out)
256 (:args (function :scs (sap-reg))
258 (:results (results :more t))
259 (:temporary (:sc unsigned-reg :offset rax-offset :to :result) rax)
264 ;; ABI: Direction flag must be clear on function entry. -- JES, 2006-01-20
266 ;; ABI: AL contains amount of arguments passed in XMM registers
269 (loop for tn-ref = args then (tn-ref-across tn-ref)
271 count (eq (sb-name (sc-sb (tn-sc (tn-ref-tn tn-ref))))
274 ;; To give the debugger a clue. XX not really internal-error?
275 (note-this-location vop :internal-error)))
277 (define-vop (alloc-number-stack-space)
279 (:results (result :scs (sap-reg any-reg)))
280 (:result-types system-area-pointer)
282 (aver (location= result rsp-tn))
283 (unless (zerop amount)
284 (let ((delta (logandc2 (+ amount 7) 7)))
285 (inst sub rsp-tn delta)))
286 ;; C stack must be 16 byte aligned
287 (inst and rsp-tn -16)
288 (move result rsp-tn)))
290 (define-vop (dealloc-number-stack-space)
293 (unless (zerop amount)
294 (let ((delta (logandc2 (+ amount 7) 7)))
295 (inst add rsp-tn delta)))))
297 (define-vop (alloc-alien-stack-space)
299 #!+sb-thread (:temporary (:sc unsigned-reg) temp)
300 (:results (result :scs (sap-reg any-reg)))
301 (:result-types system-area-pointer)
304 (aver (not (location= result rsp-tn)))
305 (unless (zerop amount)
306 (let ((delta (logandc2 (+ amount 7) 7)))
310 (static-symbol-offset '*alien-stack*)
311 (ash symbol-tls-index-slot word-shift)
312 (- other-pointer-lowtag))))
313 (inst sub (make-ea :qword :base thread-base-tn
314 :scale 1 :index temp) delta)))
315 (load-tl-symbol-value result *alien-stack*))
318 (aver (not (location= result rsp-tn)))
319 (unless (zerop amount)
320 (let ((delta (logandc2 (+ amount 7) 7)))
321 (inst sub (make-ea :qword
323 (static-symbol-offset '*alien-stack*)
324 (ash symbol-value-slot word-shift)
325 (- other-pointer-lowtag)))
327 (load-symbol-value result *alien-stack*)))
329 (define-vop (dealloc-alien-stack-space)
331 #!+sb-thread (:temporary (:sc unsigned-reg) temp)
334 (unless (zerop amount)
335 (let ((delta (logandc2 (+ amount 7) 7)))
339 (static-symbol-offset '*alien-stack*)
340 (ash symbol-tls-index-slot word-shift)
341 (- other-pointer-lowtag))))
342 (inst add (make-ea :qword :base thread-base-tn :scale 1 :index temp)
346 (unless (zerop amount)
347 (let ((delta (logandc2 (+ amount 7) 7)))
348 (inst add (make-ea :qword
350 (static-symbol-offset '*alien-stack*)
351 (ash symbol-value-slot word-shift)
352 (- other-pointer-lowtag)))
355 ;;; not strictly part of the c-call convention, but needed for the
356 ;;; WITH-PINNED-OBJECTS macro used for "locking down" lisp objects so
357 ;;; that GC won't move them while foreign functions go to work.
358 (define-vop (touch-object)
359 (:translate touch-object)
369 (defun alien-callback-accessor-form (type sp offset)
370 `(deref (sap-alien (sap+ ,sp ,offset) (* ,type))))
373 (defun alien-callback-assembler-wrapper (index result-type argument-types)
374 (labels ((make-tn-maker (sc-name)
376 (make-random-tn :kind :normal
377 :sc (sc-or-lose sc-name)
379 (out-of-registers-error ()
380 (error "Too many arguments in callback")))
381 (let* ((segment (make-segment))
390 ([rsp] (make-ea :qword :base rsp :disp 0))
391 ;; How many arguments have been copied
393 ;; How many arguments have been copied from the stack
394 (stack-argument-count 0)
395 (gprs (mapcar (make-tn-maker 'any-reg) *c-call-register-arg-offsets*))
396 (fprs (mapcar (make-tn-maker 'double-reg)
397 ;; Only 8 first XMM registers are used for
399 (subseq *float-regs* 0 8))))
401 ;; Make room on the stack for arguments.
402 (inst sub rsp (* n-word-bytes (length argument-types)))
403 ;; Copy arguments from registers to stack
404 (dolist (type argument-types)
405 (let ((integerp (not (alien-float-type-p type)))
406 ;; A TN pointing to the stack location where the
407 ;; current argument should be stored for the purposes
408 ;; of ENTER-ALIEN-CALLBACK.
409 (target-tn (make-ea :qword :base rsp
412 ;; A TN pointing to the stack location that contains
413 ;; the next argument passed on the stack.
414 (stack-arg-tn (make-ea :qword :base rsp
416 (length argument-types)
417 stack-argument-count)
421 (let ((gpr (pop gprs)))
422 ;; Argument not in register, copy it from the old
423 ;; stack location to a temporary register.
425 (incf stack-argument-count)
426 (setf gpr temp-reg-tn)
427 (inst mov gpr stack-arg-tn))
428 ;; Copy from either argument register or temporary
429 ;; register to target.
430 (inst mov target-tn gpr)))
431 ((or (alien-single-float-type-p type)
432 (alien-double-float-type-p type))
433 (let ((fpr (pop fprs)))
435 ;; Copy from float register to target location.
436 (inst movq target-tn fpr))
438 ;; Not in float register. Copy from stack to
439 ;; temporary (general purpose) register, and
440 ;; from there to the target location.
441 (incf stack-argument-count)
442 (inst mov temp-reg-tn stack-arg-tn)
443 (inst mov target-tn temp-reg-tn)))))
445 (bug "Unknown alien floating point type: ~S" type)))))
447 ;; arg0 to FUNCALL3 (function)
449 ;; Indirect the access to ENTER-ALIEN-CALLBACK through
450 ;; the symbol-value slot of SB-ALIEN::*ENTER-ALIEN-CALLBACK*
451 ;; to ensure it'll work even if the GC moves ENTER-ALIEN-CALLBACK.
452 ;; Skip any SB-THREAD TLS magic, since we don't expect anyone
453 ;; to rebind the variable. -- JES, 2006-01-01
454 (inst mov rdi (+ nil-value (static-symbol-offset
455 'sb!alien::*enter-alien-callback*)))
456 (loadw rdi rdi symbol-value-slot other-pointer-lowtag)
457 ;; arg0 to ENTER-ALIEN-CALLBACK (trampoline index)
458 (inst mov rsi (fixnumize index))
459 ;; arg1 to ENTER-ALIEN-CALLBACK (pointer to argument vector)
461 ;; add room on stack for return value
463 ;; arg2 to ENTER-ALIEN-CALLBACK (pointer to return value)
471 (inst mov rax (foreign-symbol-address "funcall3"))
474 ;; Back! Restore frame
478 ;; Result now on top of stack, put it in the right register
480 ((or (alien-integer-type-p result-type)
481 (alien-pointer-type-p result-type)
482 (alien-type-= #.(parse-alien-type 'system-area-pointer nil)
484 (inst mov rax [rsp]))
485 ((or (alien-single-float-type-p result-type)
486 (alien-double-float-type-p result-type))
487 (inst movq xmm0 [rsp]))
488 ((alien-void-type-p result-type))
490 (error "unrecognized alien type: ~A" result-type)))
492 ;; Pop the arguments and the return value from the stack to get
493 ;; the return address at top of stack.
494 (inst add rsp (* (1+ (length argument-types)) n-word-bytes))
497 (finalize-segment segment)
498 ;; Now that the segment is done, convert it to a static
499 ;; vector we can point foreign code to.
500 (let ((buffer (sb!assem::segment-buffer segment)))
501 (make-static-vector (length buffer)
502 :element-type '(unsigned-byte 8)
503 :initial-contents buffer)))))