Find file
Fetching contributors…
Cannot retrieve contributors at this time
1400 lines (1306 sloc) 57.9 KB
;;;; function call for the x86 VM
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!VM")
(defconstant arg-count-sc (make-sc-offset any-reg-sc-number rcx-offset))
(defconstant closure-sc (make-sc-offset any-reg-sc-number rax-offset))
;;; Make a passing location TN for a local call return PC.
;;; Always wire the return PC location to the stack in its standard
;;; location.
(defun make-return-pc-passing-location (standard)
(declare (ignore standard))
(make-wired-tn (primitive-type-or-lose 'system-area-pointer)
sap-stack-sc-number return-pc-save-offset))
(defconstant return-pc-passing-offset
(make-sc-offset sap-stack-sc-number return-pc-save-offset))
;;; This is similar to MAKE-RETURN-PC-PASSING-LOCATION, but makes a
;;; location to pass OLD-FP in.
;;; This is wired in both the standard and the local-call conventions,
;;; because we want to be able to assume it's always there. Besides,
;;; the x86 doesn't have enough registers to really make it profitable
;;; to pass it in a register.
(defun make-old-fp-passing-location (standard)
(declare (ignore standard))
(make-wired-tn *fixnum-primitive-type* control-stack-sc-number
(defconstant old-fp-passing-offset
(make-sc-offset control-stack-sc-number ocfp-save-offset))
;;; Make the TNs used to hold OLD-FP and RETURN-PC within the current
;;; function. We treat these specially so that the debugger can find
;;; them at a known location.
;;; Without using a save-tn - which does not make much sense if it is
;;; wired to the stack?
(defun make-old-fp-save-location (physenv)
(physenv-debug-live-tn (make-wired-tn *fixnum-primitive-type*
(defun make-return-pc-save-location (physenv)
(make-wired-tn (primitive-type-or-lose 'system-area-pointer)
sap-stack-sc-number return-pc-save-offset)
;;; Make a TN for the standard argument count passing location. We only
;;; need to make the standard location, since a count is never passed when we
;;; are using non-standard conventions.
(defun make-arg-count-location ()
(make-wired-tn *fixnum-primitive-type* any-reg-sc-number rcx-offset))
;;;; frame hackery
;;; This is used for setting up the Old-FP in local call.
(define-vop (current-fp)
(:results (val :scs (any-reg control-stack)))
(:generator 1
(move val rbp-tn)))
;;; We don't have a separate NFP, so we don't need to do anything here.
(define-vop (compute-old-nfp)
(:results (val))
(:ignore val)
(:generator 1
;;; Accessing a slot from an earlier stack frame is definite hackery.
(define-vop (ancestor-frame-ref)
(:args (frame-pointer :scs (descriptor-reg))
(variable-home-tn :load-if nil))
(:results (value :scs (descriptor-reg any-reg)))
(:policy :fast-safe)
(:generator 4
(aver (sc-is variable-home-tn control-stack))
(loadw value frame-pointer
(frame-word-offset (tn-offset variable-home-tn)))))
(define-vop (ancestor-frame-set)
(:args (frame-pointer :scs (descriptor-reg))
(value :scs (descriptor-reg any-reg)))
(:results (variable-home-tn :load-if nil))
(:policy :fast-safe)
(:generator 4
(aver (sc-is variable-home-tn control-stack))
(storew value frame-pointer
(frame-word-offset (tn-offset variable-home-tn)))))
(macrolet ((define-frame-op
(suffix sc stack-sc instruction
&optional (ea
`(make-ea :qword
:base frame-pointer
:disp (frame-byte-offset
(tn-offset variable-home-tn)))))
(let ((reffer (symbolicate 'ancestor-frame-ref '/ suffix))
(setter (symbolicate 'ancestor-frame-set '/ suffix)))
(define-vop (,reffer ancestor-frame-ref)
(:results (value :scs (,sc)))
(:generator 4
(aver (sc-is variable-home-tn ,stack-sc))
(inst ,instruction value
(define-vop (,setter ancestor-frame-set)
(:args (frame-pointer :scs (descriptor-reg))
(value :scs (,sc)))
(:generator 4
(aver (sc-is variable-home-tn ,stack-sc))
(inst ,instruction ,ea value)))))))
(define-frame-op double-float double-reg double-stack movsd)
(define-frame-op single-float single-reg single-stack movss)
(define-frame-op complex-double-float complex-double-reg complex-double-stack
movupd (ea-for-cdf-data-stack variable-home-tn frame-pointer))
(define-frame-op complex-single-float complex-single-reg complex-single-stack
movq (ea-for-csf-data-stack variable-home-tn frame-pointer))
(define-frame-op signed-byte-64 signed-reg signed-stack mov)
(define-frame-op unsigned-byte-64 unsigned-reg unsigned-stack mov)
(define-frame-op system-area-pointer sap-reg sap-stack mov))
(defun primitive-type-indirect-cell-type (ptype)
(declare (type primitive-type ptype))
(macrolet ((foo (&body data)
`(case (primitive-type-name ptype)
,@(loop for (name stack-sc ref set) in data
(list (primitive-type-or-lose ',name)
(sc-or-lose ',stack-sc)
(lambda (node block fp value res)
(sb!c::vop ,ref node block
fp value res))
(lambda (node block fp new-val value)
(sb!c::vop ,set node block
fp new-val value)))))))))
(foo (double-float double-stack
(single-float single-stack
(complex-double-float complex-double-stack
(complex-single-float complex-single-stack
(signed-byte-64 signed-stack
(unsigned-byte-64 unsigned-stack
(unsigned-byte-63 unsigned-stack
(system-area-pointer sap-stack
(define-vop (xep-allocate-frame)
(:info start-lab)
(:generator 1
(emit-alignment n-lowtag-bits)
(emit-label start-lab)
;; Skip space for the function header.
(inst simple-fun-header-word)
(dotimes (i (* n-word-bytes (1- simple-fun-code-offset)))
(inst byte 0))
;; The start of the actual code.
;; Save the return-pc.
(popw rbp-tn (frame-word-offset return-pc-save-offset))))
(define-vop (xep-setup-sp)
(:generator 1
(inst lea rsp-tn
(make-ea :qword :base rbp-tn
:disp (- (* n-word-bytes
(- (max 3 (sb-allocated-size 'stack))
;;; This is emitted directly before either a known-call-local, call-local,
;;; or a multiple-call-local. All it does is allocate stack space for the
;;; callee (who has the same size stack as us).
(define-vop (allocate-frame)
(:results (res :scs (any-reg))
(:info callee)
(:ignore nfp callee)
(:generator 2
(inst lea res (make-ea :qword :base rsp-tn
:disp (- (* sp->fp-offset n-word-bytes))))
(inst sub rsp-tn (* n-word-bytes (sb-allocated-size 'stack)))))
;;; Allocate a partial frame for passing stack arguments in a full
;;; call. NARGS is the number of arguments passed. We allocate at
;;; least 3 slots, because the XEP noise is going to want to use them
;;; before it can extend the stack.
(define-vop (allocate-full-call-frame)
(:info nargs)
(:results (res :scs (any-reg)))
(:generator 2
(inst lea res (make-ea :qword :base rsp-tn
:disp (- (* sp->fp-offset n-word-bytes))))
(inst sub rsp-tn (* (max nargs 3) n-word-bytes))))
;;; Emit code needed at the return-point from an unknown-values call
;;; for a fixed number of values. Values is the head of the TN-REF
;;; list for the locations that the values are to be received into.
;;; Nvals is the number of values that are to be received (should
;;; equal the length of Values).
;;; If 0 or 1 values are expected, then we just emit an instruction to
;;; reset the SP (which will only be executed when other than 1 value
;;; is returned.)
;;; In the general case we have to do three things:
;;; -- Default unsupplied register values. This need only be done
;;; when a single value is returned, since register values are
;;; defaulted by the called in the non-single case.
;;; -- Default unsupplied stack values. This needs to be done whenever
;;; there are stack values.
;;; -- Reset SP. This must be done whenever other than 1 value is
;;; returned, regardless of the number of values desired.
(defun default-unknown-values (vop values nvals node)
(declare (type (or tn-ref null) values)
(type unsigned-byte nvals))
(let ((type (sb!c::basic-combination-derived-type node)))
((<= nvals 1)
(note-this-location vop :single-value-return)
((<= (sb!kernel:values-type-max-value-count type)
(when (and (named-type-p type)
(eq nil (named-type-name type)))
;; The function never returns, it may happen that the code
;; ends right here leavig the :SINGLE-VALUE-RETURN note
;; dangling. Let's emit a NOP.
(inst nop)))
((not (sb!kernel:values-type-may-be-single-value-p type))
(inst mov rsp-tn rbx-tn))
(inst cmov :c rsp-tn rbx-tn))))
((<= nvals register-arg-count)
(note-this-location vop :unknown-return)
(when (sb!kernel:values-type-may-be-single-value-p type)
(let ((regs-defaulted (gen-label)))
(inst jmp :c regs-defaulted)
;; Default the unsupplied registers.
(let* ((2nd-tn-ref (tn-ref-across values))
(2nd-tn (tn-ref-tn 2nd-tn-ref)))
(inst mov 2nd-tn nil-value)
(when (> nvals 2)
for tn-ref = (tn-ref-across 2nd-tn-ref)
then (tn-ref-across tn-ref)
for count from 2 below register-arg-count
do (inst mov (tn-ref-tn tn-ref) 2nd-tn))))
(inst mov rbx-tn rsp-tn)
(emit-label regs-defaulted)))
(when (< register-arg-count
(sb!kernel:values-type-max-value-count type))
(inst mov rsp-tn rbx-tn)))
((<= nvals 7)
;; The number of bytes depends on the relative jump instructions.
;; Best case is 31+(n-3)*14, worst case is 35+(n-3)*18. For
;; NVALS=6 that is 73/89 bytes, and for NVALS=7 that is 87/107
;; bytes which is likely better than using the blt below.
(let ((regs-defaulted (gen-label))
(defaulting-done (gen-label))
(default-stack-slots (gen-label)))
(note-this-location vop :unknown-return)
(inst mov rax-tn nil-value)
;; Branch off to the MV case.
(inst jmp :c regs-defaulted)
;; Do the single value case.
;; Default the register args
(do ((i 1 (1+ i))
(val (tn-ref-across values) (tn-ref-across val)))
((= i (min nvals register-arg-count)))
(inst mov (tn-ref-tn val) rax-tn))
;; Fake other registers so it looks like we returned with all the
;; registers filled in.
(move rbx-tn rsp-tn)
(inst jmp default-stack-slots)
(emit-label regs-defaulted)
(collect ((defaults))
(do ((i register-arg-count (1+ i))
(val (do ((i 0 (1+ i))
(val values (tn-ref-across val)))
((= i register-arg-count) val))
(tn-ref-across val)))
((null val))
(let ((default-lab (gen-label))
(tn (tn-ref-tn val))
(first-stack-arg-p (= i register-arg-count)))
(defaults (cons default-lab
(cons tn first-stack-arg-p)))
(inst cmp rcx-tn (fixnumize i))
(inst jmp :be default-lab)
(when first-stack-arg-p
;; There are stack args so the frame of the callee is
;; still there, save RDX in its first slot temporalily.
(storew rdx-tn rbx-tn (frame-word-offset sp->fp-offset)))
(loadw rdx-tn rbx-tn (frame-word-offset (+ sp->fp-offset i)))
(inst mov tn rdx-tn)))
(emit-label defaulting-done)
(loadw rdx-tn rbx-tn (frame-word-offset sp->fp-offset))
(move rsp-tn rbx-tn)
(let ((defaults (defaults)))
(when defaults
(assemble (*elsewhere*)
(emit-label default-stack-slots)
(dolist (default defaults)
(emit-label (car default))
(when (cddr default)
;; We are setting the first stack argument to NIL.
;; The callee's stack frame is dead, save RDX by
;; pushing it to the stack, it will end up at same
;; place as in the (STOREW RDX-TN RBX-TN -1) case
;; above.
(inst push rdx-tn))
(inst mov (second default) rax-tn))
(inst jmp defaulting-done)))))))
(let ((regs-defaulted (gen-label))
(restore-edi (gen-label))
(no-stack-args (gen-label))
(default-stack-vals (gen-label))
(count-okay (gen-label)))
(note-this-location vop :unknown-return)
;; Branch off to the MV case.
(inst jmp :c regs-defaulted)
;; Default the register args, and set up the stack as if we
;; entered the MV return point.
(inst mov rbx-tn rsp-tn)
(inst mov rdi-tn nil-value)
(inst mov rsi-tn rdi-tn)
;; Compute a pointer to where to put the [defaulted] stack values.
(emit-label no-stack-args)
(inst push rdx-tn)
(inst push rdi-tn)
(inst lea rdi-tn
(make-ea :qword :base rbp-tn
:disp (frame-byte-offset register-arg-count)))
;; Load RAX with NIL so we can quickly store it, and set up
;; stuff for the loop.
(inst mov rax-tn nil-value)
(inst std)
(inst mov rcx-tn (- nvals register-arg-count))
;; Jump into the default loop.
(inst jmp default-stack-vals)
;; The regs are defaulted. We need to copy any stack arguments,
;; and then default the remaining stack arguments.
(emit-label regs-defaulted)
;; Compute the number of stack arguments, and if it's zero or
;; less, don't copy any stack arguments.
(inst sub rcx-tn (fixnumize register-arg-count))
(inst jmp :le no-stack-args)
;; Save EDI.
(storew rdi-tn rbx-tn (frame-word-offset (+ sp->fp-offset 1)))
;; Throw away any unwanted args.
(inst cmp rcx-tn (fixnumize (- nvals register-arg-count)))
(inst jmp :be count-okay)
(inst mov rcx-tn (fixnumize (- nvals register-arg-count)))
(emit-label count-okay)
;; Save the number of stack values.
(inst mov rax-tn rcx-tn)
;; Compute a pointer to where the stack args go.
(inst lea rdi-tn
(make-ea :qword :base rbp-tn
:disp (frame-byte-offset register-arg-count)))
;; Save ESI, and compute a pointer to where the args come from.
(storew rsi-tn rbx-tn (frame-word-offset (+ sp->fp-offset 2)))
(inst lea rsi-tn
(make-ea :qword :base rbx-tn
:disp (frame-byte-offset
(+ sp->fp-offset register-arg-count))))
;; Do the copy.
(inst shr rcx-tn n-fixnum-tag-bits) ; make word count
(inst std)
(inst rep)
(inst movs :qword)
;; Restore RSI.
(loadw rsi-tn rbx-tn (frame-word-offset (+ sp->fp-offset 2)))
;; Now we have to default the remaining args. Find out how many.
(inst sub rax-tn (fixnumize (- nvals register-arg-count)))
(inst neg rax-tn)
;; If none, then just blow out of here.
(inst jmp :le restore-edi)
(inst mov rcx-tn rax-tn)
(inst shr rcx-tn n-fixnum-tag-bits) ; word count
;; Load RAX with NIL for fast storing.
(inst mov rax-tn nil-value)
;; Do the store.
(emit-label default-stack-vals)
(inst rep)
(inst stos rax-tn)
;; Restore EDI, and reset the stack.
(emit-label restore-edi)
(loadw rdi-tn rbx-tn (frame-word-offset (+ sp->fp-offset 1)))
(inst mov rsp-tn rbx-tn)
(inst cld)))))
;;;; unknown values receiving
;;; Emit code needed at the return point for an unknown-values call
;;; for an arbitrary number of values.
;;; We do the single and non-single cases with no shared code: there
;;; doesn't seem to be any potential overlap, and receiving a single
;;; value is more important efficiency-wise.
;;; When there is a single value, we just push it on the stack,
;;; returning the old SP and 1.
;;; When there is a variable number of values, we move all of the
;;; argument registers onto the stack, and return ARGS and NARGS.
;;; ARGS and NARGS are TNs wired to the named locations. We must
;;; explicitly allocate these TNs, since their lifetimes overlap with
;;; the results start and count. (Also, it's nice to be able to target
;;; them.)
(defun receive-unknown-values (args nargs start count node)
(declare (type tn args nargs start count))
(let ((type (sb!c::basic-combination-derived-type node))
(variable-values (gen-label))
(stack-values (gen-label))
(done (gen-label)))
(when (sb!kernel:values-type-may-be-single-value-p type)
(inst jmp :c variable-values)
(cond ((location= start (first *register-arg-tns*))
(inst push (first *register-arg-tns*))
(inst lea start (make-ea :qword :base rsp-tn :disp n-word-bytes)))
(t (inst mov start rsp-tn)
(inst push (first *register-arg-tns*))))
(inst mov count (fixnumize 1))
(inst jmp done)
(emit-label variable-values))
;; The stack frame is burnt and RETurned from if there are no
;; stack values. In this case quickly reallocate sufficient space.
(when (<= (sb!kernel:values-type-min-value-count type)
(inst cmp nargs (fixnumize register-arg-count))
(inst jmp :g stack-values)
#!+#.(cl:if (cl:= sb!vm:word-shift sb!vm:n-fixnum-tag-bits) '(and) '(or))
(inst sub rsp-tn nargs)
#!-#.(cl:if (cl:= sb!vm:word-shift sb!vm:n-fixnum-tag-bits) '(and) '(or))
;; FIXME: This can't be efficient, but LEA (my first choice)
;; doesn't do subtraction.
(inst shl nargs (- word-shift n-fixnum-tag-bits))
(inst sub rsp-tn nargs)
(inst shr nargs (- word-shift n-fixnum-tag-bits)))
(emit-label stack-values))
;; dtc: this writes the registers onto the stack even if they are
;; not needed, only the number specified in rcx are used and have
;; stack allocated to them. No harm is done.
for arg in *register-arg-tns*
for i downfrom -1
for j below (sb!kernel:values-type-max-value-count type)
do (storew arg args i))
(move start args)
(move count nargs)
(emit-label done))
;;; VOP that can be inherited by unknown values receivers. The main thing this
;;; handles is allocation of the result temporaries.
(define-vop (unknown-values-receiver)
(:temporary (:sc descriptor-reg :offset rbx-offset
:from :eval :to (:result 0))
(:temporary (:sc any-reg :offset rcx-offset
:from :eval :to (:result 1))
(:results (start :scs (any-reg control-stack))
(count :scs (any-reg control-stack))))
;;;; local call with unknown values convention return
(defun check-ocfp-and-return-pc (old-fp return-pc)
(format t "*known-return: old-fp ~S, tn-kind ~S; ~S ~S~%"
old-fp (sb!c::tn-kind old-fp) (sb!c::tn-save-tn old-fp)
(sb!c::tn-kind (sb!c::tn-save-tn old-fp)))
(format t "*known-return: return-pc ~S, tn-kind ~S; ~S ~S~%"
return-pc (sb!c::tn-kind return-pc)
(sb!c::tn-save-tn return-pc)
(sb!c::tn-kind (sb!c::tn-save-tn return-pc)))
(unless (and (sc-is old-fp control-stack)
(= (tn-offset old-fp) ocfp-save-offset))
(error "ocfp not on stack in standard save location?"))
(unless (and (sc-is return-pc sap-stack)
(= (tn-offset return-pc) return-pc-save-offset))
(error "return-pc not on stack in standard save location?")))
;;; The local call convention doesn't fit that well with x86-style
;;; calls. Emit a header for local calls to pop the return address
;;; in the right place.
(defun emit-block-header (start-label trampoline-label fall-thru-p alignp)
(when (and fall-thru-p trampoline-label)
(inst jmp start-label))
(when trampoline-label
(emit-label trampoline-label)
(popw rbp-tn (frame-word-offset return-pc-save-offset)))
(when alignp
(emit-alignment n-lowtag-bits :long-nop))
(emit-label start-label))
;;; Non-TR local call for a fixed number of values passed according to
;;; the unknown values convention.
;;; FP is the frame pointer in install before doing the call.
;;; NFP would be the number-stack frame pointer if we had a separate
;;; number stack.
;;; Args are the argument passing locations, which are specified only
;;; to terminate their lifetimes in the caller.
;;; VALUES are the return value locations (wired to the standard
;;; passing locations). NVALS is the number of values received.
;;; Save is the save info, which we can ignore since saving has been
;;; done.
;;; TARGET is a continuation pointing to the start of the called
;;; function.
(define-vop (call-local)
(:args (fp)
(args :more t))
(:results (values :more t))
(:save-p t)
(:move-args :local-call)
(:info arg-locs callee target nvals)
(:vop-var vop)
(:ignore nfp arg-locs args callee)
(:node-var node)
(:generator 5
(move rbp-tn fp)
(note-this-location vop :call-site)
(inst call target)
(default-unknown-values vop values nvals node)))
;;; Non-TR local call for a variable number of return values passed according
;;; to the unknown values convention. The results are the start of the values
;;; glob and the number of values received.
(define-vop (multiple-call-local unknown-values-receiver)
(:args (fp)
(args :more t))
(:save-p t)
(:move-args :local-call)
(:info save callee target)
(:ignore args save nfp callee)
(:vop-var vop)
(:node-var node)
(:generator 20
(move rbp-tn fp)
(note-this-location vop :call-site)
(inst call target)
(note-this-location vop :unknown-return)
(receive-unknown-values values-start nvals start count node)))
;;;; local call with known values return
;;; Non-TR local call with known return locations. Known-value return
;;; works just like argument passing in local call.
;;; Note: we can't use normal load-tn allocation for the fixed args,
;;; since all registers may be tied up by the more operand. Instead,
(define-vop (known-call-local)
(:args (fp)
(args :more t))
(:results (res :more t))
(:move-args :local-call)
(:save-p t)
(:info save callee target)
(:ignore args res save nfp callee)
(:vop-var vop)
(:generator 5
(move rbp-tn fp)
(note-this-location vop :call-site)
(inst call target)
(note-this-location vop :known-return)))
;;; From Douglas Crosher
;;; Return from known values call. We receive the return locations as
;;; arguments to terminate their lifetimes in the returning function. We
;;; restore FP and CSP and jump to the Return-PC.
(define-vop (known-return)
(:args (old-fp)
(vals :more t))
(:move-args :known-return)
(:info val-locs)
(:ignore val-locs vals)
(:vop-var vop)
(:generator 6
(check-ocfp-and-return-pc old-fp return-pc)
;; Zot all of the stack except for the old-fp and return-pc.
(inst mov rsp-tn rbp-tn)
(inst pop rbp-tn)
(inst ret)))
;;;; full call
;;; There is something of a cross-product effect with full calls.
;;; Different versions are used depending on whether we know the
;;; number of arguments or the name of the called function, and
;;; whether we want fixed values, unknown values, or a tail call.
;;; In full call, the arguments are passed creating a partial frame on
;;; the stack top and storing stack arguments into that frame. On
;;; entry to the callee, this partial frame is pointed to by FP.
;;; This macro helps in the definition of full call VOPs by avoiding
;;; code replication in defining the cross-product VOPs.
;;; NAME is the name of the VOP to define.
;;; NAMED is true if the first argument is an fdefinition object whose
;;; definition is to be called.
;;; RETURN is either :FIXED, :UNKNOWN or :TAIL:
;;; -- If :FIXED, then the call is for a fixed number of values, returned in
;;; the standard passing locations (passed as result operands).
;;; -- If :UNKNOWN, then the result values are pushed on the stack, and the
;;; result values are specified by the Start and Count as in the
;;; unknown-values continuation representation.
;;; -- If :TAIL, then do a tail-recursive call. No values are returned.
;;; The Old-Fp and Return-PC are passed as the second and third arguments.
;;; In non-tail calls, the pointer to the stack arguments is passed as
;;; the last fixed argument. If Variable is false, then the passing
;;; locations are passed as a more arg. Variable is true if there are
;;; a variable number of arguments passed on the stack. Variable
;;; cannot be specified with :TAIL return. TR variable argument call
;;; is implemented separately.
;;; In tail call with fixed arguments, the passing locations are
;;; passed as a more arg, but there is no new-FP, since the arguments
;;; have been set up in the current frame.
(macrolet ((define-full-call (name named return variable)
(aver (not (and variable (eq return :tail))))
`(define-vop (,name
,@(when (eq return :unknown)
,@(unless (eq return :tail)
'((new-fp :scs (any-reg) :to (:argument 1))))
(fun :scs (descriptor-reg control-stack)
:target rax :to (:argument 0))
,@(when (eq return :tail)
,@(unless variable '((args :more t :scs (descriptor-reg)))))
,@(when (eq return :fixed)
'((:results (values :more t))))
(:save-p ,(if (eq return :tail) :compute-only t))
,@(unless (or (eq return :tail) variable)
'((:move-args :full-call)))
(:vop-var vop)
,@(unless (or variable (eq return :tail)) '(arg-locs))
,@(unless variable '(nargs))
,@(when (eq return :fixed) '(nvals))
,@(unless (or variable (eq return :tail)) '(arg-locs))
,@(unless variable '(args)))
;; We pass either the fdefn object (for named call) or
;; the actual function object (for unnamed call) in
;; RAX. With named call, closure-tramp will replace it
;; with the real function and invoke the real function
;; for closures. Non-closures do not need this value,
;; so don't care what shows up in it.
(:sc descriptor-reg
:offset rax-offset
:from (:argument 0)
:to :eval)
;; We pass the number of arguments in RCX.
(:temporary (:sc unsigned-reg :offset rcx-offset :to :eval) rcx)
;; With variable call, we have to load the
;; register-args out of the (new) stack frame before
;; doing the call. Therefore, we have to tell the
;; lifetime stuff that we need to use them.
,@(when variable
(mapcar (lambda (name offset)
`(:temporary (:sc descriptor-reg
:offset ,offset
:from (:argument 0)
:to :eval)
*register-arg-names* *register-arg-offsets*))
,@(when (eq return :tail)
'((:temporary (:sc unsigned-reg
:from (:argument 1)
:to (:argument 2))
,@(unless (eq return :tail)
'((:node-var node)))
(:generator ,(+ (if named 5 0)
(if variable 19 1)
(if (eq return :tail) 0 10)
(if (eq return :unknown) 25 0))
;; This has to be done before the frame pointer is
;; changed! RAX stores the 'lexical environment' needed
;; for closures.
(move rax fun)
,@(if variable
;; For variable call, compute the number of
;; arguments and move some of the arguments to
;; registers.
(collect ((noise))
;; Compute the number of arguments.
(noise '(inst mov rcx new-fp))
(noise '(inst sub rcx rsp-tn))
#.(unless (= word-shift n-fixnum-tag-bits)
'(noise '(inst shr rcx
(- word-shift n-fixnum-tag-bits))))
;; Move the necessary args to registers,
;; this moves them all even if they are
;; not all needed.
for name in *register-arg-names*
for index downfrom -1
do (noise `(loadw ,name new-fp ,index)))
'((if (zerop nargs)
(zeroize rcx)
(inst mov rcx (fixnumize nargs)))))
,@(cond ((eq return :tail)
'(;; Python has figured out what frame we should
;; return to so might as well use that clue.
;; This seems really important to the
;; implementation of things like
;; (without-interrupts ...)
;; dtc; Could be doing a tail call from a
;; known-local-call etc in which the old-fp
;; or ret-pc are in regs or in non-standard
;; places. If the passing location were
;; wired to the stack in standard locations
;; then these moves will be un-necessary;
;; this is probably best for the x86.
(sc-case old-fp
(unless (= ocfp-save-offset
(tn-offset old-fp))
;; FIXME: FORMAT T for stale
;; diagnostic output (several of
;; them around here), ick
(error "** tail-call old-fp not S0~%")
(move old-fp-tmp old-fp)
(storew old-fp-tmp
(frame-word-offset ocfp-save-offset))))
((any-reg descriptor-reg)
(error "** tail-call old-fp in reg not S0~%")
(storew old-fp
(frame-word-offset ocfp-save-offset))))
;; For tail call, we have to push the
;; return-pc so that it looks like we CALLed
;; despite the fact that we are going to JMP.
(inst push return-pc)
;; For non-tail call, we have to save our
;; frame pointer and install the new frame
;; pointer. We can't load stack tns after this
;; point.
`(;; Python doesn't seem to allocate a frame
;; here which doesn't leave room for the
;; ofp/ret stuff.
;; The variable args are on the stack and
;; become the frame, but there may be <3
;; args and 3 stack slots are assumed
;; allocate on the call. So need to ensure
;; there are at least 3 slots. This hack
;; just adds 3 more.
,(if variable
'(inst sub rsp-tn (* 3 n-word-bytes)))
;; Bias the new-fp for use as an fp
,(if variable
'(inst sub new-fp (* sp->fp-offset n-word-bytes)))
;; Save the fp
(storew rbp-tn new-fp
(frame-word-offset ocfp-save-offset))
(move rbp-tn new-fp) ; NB - now on new stack frame.
(when step-instrumenting
(inst jmp :eq DONE)
(inst break single-step-around-trap))
(note-this-location vop :call-site)
(inst ,(if (eq return :tail) 'jmp 'call)
(make-ea :qword :base rax
:disp ,(if named
'(- (* fdefn-raw-addr-slot
'(- (* closure-fun-slot n-word-bytes)
,@(ecase return
'((default-unknown-values vop values nvals node)))
'((note-this-location vop :unknown-return)
(receive-unknown-values values-start nvals start count
(define-full-call call nil :fixed nil)
(define-full-call call-named t :fixed nil)
(define-full-call multiple-call nil :unknown nil)
(define-full-call multiple-call-named t :unknown nil)
(define-full-call tail-call nil :tail nil)
(define-full-call tail-call-named t :tail nil)
(define-full-call call-variable nil :fixed t)
(define-full-call multiple-call-variable nil :unknown t))
;;; This is defined separately, since it needs special code that BLT's
;;; the arguments down. All the real work is done in the assembly
;;; routine. We just set things up so that it can find what it needs.
(define-vop (tail-call-variable)
(:args (args :scs (any-reg control-stack) :target rsi)
(function :scs (descriptor-reg control-stack) :target rax)
(:temporary (:sc unsigned-reg :offset rsi-offset :from (:argument 0)) rsi)
(:temporary (:sc unsigned-reg :offset rax-offset :from (:argument 1)) rax)
(:temporary (:sc unsigned-reg) call-target)
(:generator 75
(check-ocfp-and-return-pc old-fp return-pc)
;; Move these into the passing locations if they are not already there.
(move rsi args)
(move rax function)
;; And jump to the assembly routine.
(inst mov call-target (make-fixup 'tail-call-variable :assembly-routine))
(inst jmp call-target)))
;;;; unknown values return
;;; Return a single-value using the Unknown-Values convention.
;;; pfw--get wired-tn conflicts sometimes if register sc specd for args
;;; having problems targeting args to regs -- using temps instead.
;;; First off, modifying the return-pc defeats the branch-prediction
;;; optimizations on modern CPUs quite handily. Second, we can do all
;;; this without needing a temp register. Fixed the latter, at least.
;;; -- AB 2006/Feb/04
(define-vop (return-single)
(:args (old-fp)
(:ignore value)
(:generator 6
(check-ocfp-and-return-pc old-fp return-pc)
;; Drop stack above old-fp
(inst mov rsp-tn rbp-tn)
;; Clear the multiple-value return flag
(inst clc)
;; Restore the old frame pointer
(inst pop rbp-tn)
;; And return.
(inst ret)))
;;; Do unknown-values return of a fixed (other than 1) number of
;;; values. The VALUES are required to be set up in the standard
;;; passing locations. NVALS is the number of values returned.
;;; Basically, we just load RCX with the number of values returned and
;;; RBX with a pointer to the values, set RSP to point to the end of
;;; the values, and jump directly to return-pc.
(define-vop (return)
(:args (old-fp)
(return-pc :to (:eval 1))
(values :more t))
(:ignore values)
(:info nvals)
;; In the case of other than one value, we need these registers to
;; tell the caller where they are and how many there are.
(:temporary (:sc unsigned-reg :offset rbx-offset) rbx)
(:temporary (:sc unsigned-reg :offset rcx-offset) rcx)
;; We need to stretch the lifetime of return-pc past the argument
;; registers so that we can default the argument registers without
;; trashing return-pc.
(:temporary (:sc unsigned-reg :offset (first *register-arg-offsets*)
:from :eval) a0)
(:temporary (:sc unsigned-reg :offset (second *register-arg-offsets*)
:from :eval) a1)
(:temporary (:sc unsigned-reg :offset (third *register-arg-offsets*)
:from :eval) a2)
(:generator 6
(check-ocfp-and-return-pc old-fp return-pc)
(when (= nvals 1)
;; This is handled in RETURN-SINGLE.
(error "nvalues is 1"))
;; Establish the values pointer and values count.
(inst lea rbx (make-ea :qword :base rbp-tn
:disp (* sp->fp-offset n-word-bytes)))
(if (zerop nvals)
(zeroize rcx) ; smaller
(inst mov rcx (fixnumize nvals)))
;; Pre-default any argument register that need it.
(when (< nvals register-arg-count)
(let* ((arg-tns (nthcdr nvals (list a0 a1 a2)))
(first (first arg-tns)))
(inst mov first nil-value)
(dolist (tn (cdr arg-tns))
(inst mov tn first))))
;; Set the multiple value return flag.
(inst stc)
;; And away we go. Except that return-pc is still on the
;; stack and we've changed the stack pointer. So we have to
;; tell it to index off of RBX instead of RBP.
(cond ((<= nvals register-arg-count)
(inst mov rsp-tn rbp-tn)
(inst pop rbp-tn)
(inst ret))
;; Some values are on the stack after RETURN-PC and OLD-FP,
;; can't return normally and some slots of the frame will
;; be used as temporaries by the receiver.
;; Clear as much of the stack as possible, but not past the
;; old frame address.
(inst lea rsp-tn
(make-ea :qword :base rbp-tn
:disp (frame-byte-offset (1- nvals))))
(move rbp-tn old-fp)
(inst push (make-ea :qword :base rbx
:disp (frame-byte-offset
(+ sp->fp-offset
(tn-offset return-pc)))))
(inst ret)))))
;;; Do unknown-values return of an arbitrary number of values (passed
;;; on the stack.) We check for the common case of a single return
;;; value, and do that inline using the normal single value return
;;; convention. Otherwise, we branch off to code that calls an
;;; assembly-routine.
;;; The assembly routine takes the following args:
;;; RCX -- number of values to find there.
;;; RSI -- pointer to where to find the values.
(define-vop (return-multiple)
(:args (old-fp)
(vals :scs (any-reg) :target rsi)
(nvals :scs (any-reg) :target rcx))
(:temporary (:sc unsigned-reg :offset rsi-offset :from (:argument 2)) rsi)
(:temporary (:sc unsigned-reg :offset rcx-offset :from (:argument 3)) rcx)
(:temporary (:sc unsigned-reg) return-asm)
(:temporary (:sc descriptor-reg :offset (first *register-arg-offsets*)
:from (:eval 0)) a0)
(:node-var node)
(:generator 13
(check-ocfp-and-return-pc old-fp return-pc)
(unless (policy node (> space speed))
;; Check for the single case.
(let ((not-single (gen-label)))
(inst cmp nvals (fixnumize 1))
(inst jmp :ne not-single)
;; Return with one value.
(loadw a0 vals -1)
;; Clear the stack until ocfp.
(inst mov rsp-tn rbp-tn)
;; clear the multiple-value return flag
(inst clc)
;; Out of here.
(inst pop rbp-tn)
(inst ret)
;; Nope, not the single case. Jump to the assembly routine.
(emit-label not-single)))
(move rsi vals)
(move rcx nvals)
(inst mov return-asm (make-fixup 'return-multiple :assembly-routine))
(inst jmp return-asm)))
;;;; XEP hackery
;;; Get the lexical environment from its passing location.
(define-vop (setup-closure-environment)
(:results (closure :scs (descriptor-reg)))
(:info label)
(:ignore label)
(:generator 6
;; Get result.
(move closure rax-tn)))
;;; Copy a &MORE arg from the argument area to the end of the current
;;; frame. FIXED is the number of non-&MORE arguments.
(define-vop (copy-more-arg)
(:temporary (:sc any-reg :offset r8-offset) copy-index)
(:temporary (:sc any-reg :offset r9-offset) source)
(:temporary (:sc descriptor-reg :offset r10-offset) temp)
(:info fixed)
(:generator 20
;; Avoid the copy if there are no more args.
(cond ((zerop fixed)
(inst jrcxz JUST-ALLOC-FRAME))
(inst cmp rcx-tn (fixnumize fixed))
(inst jmp :be JUST-ALLOC-FRAME)))
;; Create a negated copy of the number of arguments to allow us to
;; use EA calculations in order to do scaled subtraction.
(inst mov temp rcx-tn)
(inst neg temp)
;; Allocate the space on the stack.
;; stack = rbp + sp->fp-offset - (max 3 frame-size) - (nargs - fixed)
;; if we'd move SP backward, swap the meaning of rsp and source;
;; otherwise, we'd be accessing values below SP, and that's no good
;; if a signal interrupts this code sequence. In that case, store
;; the final value in rsp after the stack-stack memmove loop.
(inst lea (if (<= fixed (max 3 (sb-allocated-size 'stack)))
(make-ea :qword :base rbp-tn
:index temp :scale (ash 1 (- word-shift n-fixnum-tag-bits))
:disp (* n-word-bytes
(- (+ sp->fp-offset fixed)
(max 3 (sb-allocated-size 'stack))))))
;; Now: nargs>=1 && nargs>fixed
;; Save the original count of args.
(inst mov rbx-tn rcx-tn)
(cond ((< fixed register-arg-count)
;; the code above only moves the final value of rsp in
;; rsp directly if that condition is satisfied. Currently,
;; r-a-c is 3, so the aver is OK. If the calling convention
;; ever changes, the logic above with LEA will have to be
;; adjusted.
(aver (<= fixed (max 3 (sb-allocated-size 'stack))))
;; We must stop when we run out of stack args, not when we
;; run out of more args.
;; Number to copy = nargs-3
(inst sub rbx-tn (fixnumize register-arg-count))
;; Everything of interest in registers.
(inst jmp :be DO-REGS))
;; Number to copy = nargs-fixed
(inst sub rbx-tn (fixnumize fixed))))
;; Initialize R8 to be the end of args.
;; Swap with SP if necessary to mirror the previous condition
(inst lea (if (<= fixed (max 3 (sb-allocated-size 'stack)))
(make-ea :qword :base rbp-tn
:index temp :scale (ash 1 (- word-shift n-fixnum-tag-bits))
:disp (* sp->fp-offset n-word-bytes)))
;; src: rbp + temp + sp->fp
;; dst: rbp + temp + sp->fp + (fixed - (max 3 [stack-size]))
(let ((delta (- fixed (max 3 (sb-allocated-size 'stack))))
(loop (gen-label))
(fixnum->word (ash 1 (- word-shift n-fixnum-tag-bits))))
(cond ((zerop delta)) ; no-op move
((minusp delta)
;; dst is lower than src, copy forward
(zeroize copy-index)
;; We used to use REP MOVS here, but on modern x86 it performs
;; much worse than an explicit loop for small blocks.
(emit-label loop)
(inst mov temp (make-ea :qword :base source :index copy-index))
(inst mov (make-ea :qword :base rsp-tn :index copy-index) temp)
(inst add copy-index n-word-bytes)
(inst sub rbx-tn (fixnumize 1))
(inst jmp :nz loop))
((plusp delta)
;; dst is higher than src; copy backward
(emit-label loop)
(inst sub rbx-tn (fixnumize 1))
(inst mov temp (make-ea :qword :base rsp-tn
:index rbx-tn :scale fixnum->word))
(inst mov (make-ea :qword :base source
:index rbx-tn :scale fixnum->word)
(inst jmp :nz loop)
;; done with the stack--stack copy. Reset RSP to its final
;; value
(inst mov rsp-tn source))))
;; Here: nargs>=1 && nargs>fixed
(when (< fixed register-arg-count)
;; Now we have to deposit any more args that showed up in
;; registers.
(do ((i fixed))
( nil )
;; Store it relative to rbp
(inst mov (make-ea :qword :base rbp-tn
:disp (* n-word-bytes
(- sp->fp-offset
(+ 1
(- i fixed)
(max 3 (sb-allocated-size
(nth i *register-arg-tns*))
(incf i)
(when (>= i register-arg-count)
;; Don't deposit any more than there are.
(if (zerop i)
(inst test rcx-tn rcx-tn)
(inst cmp rcx-tn (fixnumize i)))
(inst jmp :eq DONE)))
(inst jmp DONE)
(inst lea rsp-tn
(make-ea :qword :base rbp-tn
:disp (* n-word-bytes
(- sp->fp-offset
(max 3 (sb-allocated-size 'stack))))))
(define-vop (more-kw-arg)
(:translate sb!c::%more-kw-arg)
(:policy :fast-safe)
(:args (object :scs (descriptor-reg) :to (:result 1))
(index :scs (any-reg) :to (:result 1) :target keyword))
(:arg-types * tagged-num)
(:results (value :scs (descriptor-reg any-reg))
(keyword :scs (descriptor-reg any-reg)))
(:result-types * *)
(:generator 4
(inst mov value (make-ea :qword :base object :index index
:scale (ash 1 (- word-shift n-fixnum-tag-bits))))
(inst mov keyword (make-ea :qword :base object :index index
:scale (ash 1 (- word-shift n-fixnum-tag-bits))
:disp n-word-bytes))))
(define-vop (more-arg/c)
(:translate sb!c::%more-arg)
(:policy :fast-safe)
(:args (object :scs (descriptor-reg) :to (:result 1)))
(:info index)
(:arg-types * (:constant (signed-byte 32)))
(:results (value :scs (descriptor-reg any-reg)))
(:result-types *)
(:generator 3
(inst mov value (make-ea :qword :base object
:disp (- (* index n-word-bytes))))))
(define-vop (more-arg)
(:translate sb!c::%more-arg)
(:policy :fast-safe)
(:args (object :scs (descriptor-reg) :to (:result 1))
(index :scs (any-reg) :to (:result 1) :target value))
(:arg-types * tagged-num)
(:results (value :scs (descriptor-reg any-reg)))
(:result-types *)
(:generator 4
(move value index)
(inst neg value)
(inst mov value (make-ea :qword :base object :index value
:scale (ash 1 (- word-shift n-fixnum-tag-bits))))))
;;; Turn more arg (context, count) into a list.
(define-vop (listify-rest-args)
(:translate %listify-rest-args)
(:policy :safe)
(:args (context :scs (descriptor-reg) :target src)
(count :scs (any-reg) :target rcx))
(:arg-types * tagged-num)
(:temporary (:sc unsigned-reg :offset rsi-offset :from (:argument 0)) src)
(:temporary (:sc unsigned-reg :offset rcx-offset :from (:argument 1)) rcx)
(:temporary (:sc unsigned-reg :offset rax-offset) rax)
(:temporary (:sc unsigned-reg) dst)
(:results (result :scs (descriptor-reg)))
(:node-var node)
(:generator 20
(let ((enter (gen-label))
(loop (gen-label))
(done (gen-label))
(stack-allocate-p (node-stack-allocate-p node)))
(move src context)
(move rcx count)
;; Check to see whether there are no args, and just return NIL if so.
(inst mov result nil-value)
(inst jrcxz done)
(inst lea dst (make-ea :qword :index rcx :scale (ash 2 (- word-shift n-fixnum-tag-bits))))
(maybe-pseudo-atomic stack-allocate-p
(allocation dst dst node stack-allocate-p list-pointer-lowtag)
;; Set up the result.
(move result dst)
;; Jump into the middle of the loop, 'cause that's where we want
;; to start.
(inst jmp enter)
(emit-label loop)
;; Compute a pointer to the next cons.
(inst add dst (* cons-size n-word-bytes))
;; Store a pointer to this cons in the CDR of the previous cons.
(storew dst dst -1 list-pointer-lowtag)
(emit-label enter)
;; Grab one value and stash it in the car of this cons.
(inst mov rax (make-ea :qword :base src))
(inst sub src n-word-bytes)
(storew rax dst 0 list-pointer-lowtag)
;; Go back for more.
(inst sub rcx (fixnumize 1))
(inst jmp :nz loop)
;; NIL out the last cons.
(storew nil-value dst 1 list-pointer-lowtag))
(emit-label done))))
;;; Return the location and size of the &MORE arg glob created by
;;; COPY-MORE-ARG. SUPPLIED is the total number of arguments supplied
;;; (originally passed in RCX). FIXED is the number of non-rest
;;; arguments.
;;; We must duplicate some of the work done by COPY-MORE-ARG, since at
;;; that time the environment is in a pretty brain-damaged state,
;;; preventing this info from being returned as values. What we do is
;;; compute supplied - fixed, and return a pointer that many words
;;; below the current stack top.
(define-vop (more-arg-context)
(:policy :fast-safe)
(:translate sb!c::%more-arg-context)
(:args (supplied :scs (any-reg) :target count))
(:arg-types positive-fixnum (:constant fixnum))
(:info fixed)
(:results (context :scs (descriptor-reg))
(count :scs (any-reg)))
(:result-types t tagged-num)
(:note "more-arg-context")
(:generator 5
(move count supplied)
;; SP at this point points at the last arg pushed.
;; Point to the first more-arg, not above it.
(inst lea context (make-ea :qword :base rsp-tn
:index count
:scale (ash 1 (- word-shift n-fixnum-tag-bits))
:disp (- (* (1+ fixed) n-word-bytes))))
(unless (zerop fixed)
(inst sub count (fixnumize fixed)))))
(define-vop (verify-arg-count)
(:policy :fast-safe)
(:args (nargs :scs (any-reg)))
(:arg-types positive-fixnum (:constant t) (:constant t))
(:info min max)
(:vop-var vop)
(:save-p :compute-only)
(:generator 3
(let ((err-lab
(generate-error-code vop 'invalid-arg-count-error nargs)))
(flet ((check-min ()
(cond ((= min 1)
(inst test nargs nargs)
(inst jmp :e err-lab))
((plusp min)
(inst cmp nargs (fixnumize min))
(inst jmp :b err-lab)))))
(cond ((not min)
(if (zerop max)
(inst test nargs nargs)
(inst cmp nargs (fixnumize max)))
(inst jmp :ne err-lab))
(inst cmp nargs (fixnumize max))
(inst jmp :a err-lab))
;; Signal an error about an untagged number.
;; These are pretty much boilerplate and could be generic except:
;; - the names of the SCs could differ between backends (or maybe not?)
;; - in the "/c" case, the older backends don't eval the errcode
;; And the 6 vops above ought to be generic too...
;; FIXME: there are still some occurrences of
;; note: doing signed word to integer coercion
;; in regard to SB-C::%TYPE-CHECK-ERROR. Figure out why.
(define-vop (type-check-error/word)
(:policy :fast-safe)
(:translate sb!c::%type-check-error)
(:args (object :scs (signed-reg unsigned-reg))
;; Types are trees of symbols, so 'any-reg' is not
;; really possible.
(type :scs (any-reg descriptor-reg constant)))
(:arg-types untagged-num *)
(:vop-var vop)
(:save-p :compute-only)
;; cost is a smidgen less than type-check-error
;; otherwise this does not get selected.
(:generator 999
(error-call vop 'object-not-type-error object type)))
(define-vop (type-check-error/word/c)
(:policy :fast-safe)
(:translate sb!c::%type-check-error/c)
(:args (object :scs (signed-reg unsigned-reg)))
(:arg-types untagged-num (:constant symbol))
(:info errcode)
(:vop-var vop)
(:save-p :compute-only)
(:generator 899 ; smidgen less than type-check-error/c
(error-call vop errcode object)))
;;; Single-stepping
(defun emit-single-step-test ()
;; We use different ways of representing whether stepping is on on
;; +SB-THREAD / -SB-THREAD: on +SB-THREAD, we use a slot in the
;; thread structure. On -SB-THREAD we use the value of a static
;; symbol. Things are done this way, since reading a thread-local
;; slot from a symbol would require an extra register on +SB-THREAD,
;; and reading a slot from a thread structure would require an extra
;; register on -SB-THREAD. While this isn't critical for x86-64,
;; it's more serious for x86.
(inst cmp (make-ea :qword
:base thread-base-tn
:disp (* thread-stepping-slot n-word-bytes))
(inst cmp (make-ea :qword
:disp (+ nil-value (static-symbol-offset
(* symbol-value-slot n-word-bytes)
(- other-pointer-lowtag)))
(define-vop (step-instrument-before-vop)
(:policy :fast-safe)
(:vop-var vop)
(:generator 3
(inst jmp :eq DONE)
(inst break single-step-before-trap)
(note-this-location vop :step-before-vop)))