src/compiler/x86/call.lisp

   1 ;;;; function call for the x86 VM
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   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.
  11
  12 (in-package "SB!VM")
  13 \f
  14 ;;;; interfaces to IR2 conversion
  15
  16 ;;; Return a wired TN describing the N'th full call argument passing
  17 ;;; location.
  18 (!def-vm-support-routine standard-arg-location (n)
  19   (declare (type unsigned-byte n))
  20   (if (< n register-arg-count)
  21       (make-wired-tn *backend-t-primitive-type* descriptor-reg-sc-number
  22                      (nth n *register-arg-offsets*))
  23       (make-wired-tn *backend-t-primitive-type* control-stack-sc-number n)))
  24
  25 ;;; Make a passing location TN for a local call return PC.
  26 ;;;
  27 ;;; Always wire the return PC location to the stack in its standard
  28 ;;; location.
  29 (!def-vm-support-routine make-return-pc-passing-location (standard)
  30   (declare (ignore standard))
  31   (make-wired-tn (primitive-type-or-lose 'system-area-pointer)
  32                  sap-stack-sc-number return-pc-save-offset))
  33
  34 ;;; This is similar to MAKE-RETURN-PC-PASSING-LOCATION, but makes a
  35 ;;; location to pass OLD-FP in.
  36 ;;;
  37 ;;; This is wired in both the standard and the local-call conventions,
  38 ;;; because we want to be able to assume it's always there. Besides,
  39 ;;; the x86 doesn't have enough registers to really make it profitable
  40 ;;; to pass it in a register.
  41 (!def-vm-support-routine make-old-fp-passing-location (standard)
  42   (declare (ignore standard))
  43   (make-wired-tn *fixnum-primitive-type* control-stack-sc-number
  44                  ocfp-save-offset))
  45
  46 ;;; Make the TNs used to hold OLD-FP and RETURN-PC within the current
  47 ;;; function. We treat these specially so that the debugger can find
  48 ;;; them at a known location.
  49 ;;;
  50 ;;; Without using a save-tn - which does not make much sense if it is
  51 ;;; wired to the stack?
  52 (!def-vm-support-routine make-old-fp-save-location (physenv)
  53   (physenv-debug-live-tn (make-wired-tn *fixnum-primitive-type*
  54                                         control-stack-sc-number
  55                                         ocfp-save-offset)
  56                          physenv))
  57 (!def-vm-support-routine make-return-pc-save-location (physenv)
  58   (physenv-debug-live-tn
  59    (make-wired-tn (primitive-type-or-lose 'system-area-pointer)
  60                   sap-stack-sc-number return-pc-save-offset)
  61    physenv))
  62
  63 ;;; Make a TN for the standard argument count passing location. We only
  64 ;;; need to make the standard location, since a count is never passed when we
  65 ;;; are using non-standard conventions.
  66 (!def-vm-support-routine make-arg-count-location ()
  67   (make-wired-tn *fixnum-primitive-type* any-reg-sc-number ecx-offset))
  68
  69 ;;; Make a TN to hold the number-stack frame pointer. This is allocated
  70 ;;; once per component, and is component-live.
  71 (!def-vm-support-routine make-nfp-tn ()
  72   (make-restricted-tn *fixnum-primitive-type* ignore-me-sc-number))
  73
  74 (!def-vm-support-routine make-stack-pointer-tn ()
  75   (make-normal-tn *fixnum-primitive-type*))
  76
  77 (!def-vm-support-routine make-number-stack-pointer-tn ()
  78   (make-restricted-tn *fixnum-primitive-type* ignore-me-sc-number))
  79
  80 ;;; Return a list of TNs that can be used to represent an unknown-values
  81 ;;; continuation within a function.
  82 (!def-vm-support-routine make-unknown-values-locations ()
  83   (list (make-stack-pointer-tn)
  84         (make-normal-tn *fixnum-primitive-type*)))
  85
  86 ;;; This function is called by the ENTRY-ANALYZE phase, allowing
  87 ;;; VM-dependent initialization of the IR2-COMPONENT structure. We
  88 ;;; push placeholder entries in the CONSTANTS to leave room for
  89 ;;; additional noise in the code object header.
  90 (!def-vm-support-routine select-component-format (component)
  91   (declare (type component component))
  92   ;; The 1+ here is because for the x86 the first constant is a
  93   ;; pointer to a list of fixups, or NIL if the code object has none.
  94   ;; (If I understand correctly, the fixups are needed at GC copy
  95   ;; time because the X86 code isn't relocatable.)
  96   ;;
  97   ;; KLUDGE: It'd be cleaner to have the fixups entry be a named
  98   ;; element of the CODE (aka component) primitive object. However,
  99   ;; it's currently a large, tricky, error-prone chore to change
 100   ;; the layout of any primitive object, so for the foreseeable future
 101   ;; we'll just live with this ugliness. -- WHN 2002-01-02
 102   (dotimes (i (1+ code-constants-offset))
 103     (vector-push-extend nil
 104                         (ir2-component-constants (component-info component))))
 105   (values))
 106 \f
 107 ;;;; frame hackery
 108
 109 ;;; This is used for setting up the Old-FP in local call.
 110 (define-vop (current-fp)
 111   (:results (val :scs (any-reg control-stack)))
 112   (:generator 1
 113     (move val ebp-tn)))
 114
 115 ;;; We don't have a separate NFP, so we don't need to do anything here.
 116 (define-vop (compute-old-nfp)
 117   (:results (val))
 118   (:ignore val)
 119   (:generator 1
 120     nil))
 121
 122 (define-vop (xep-allocate-frame)
 123   (:info start-lab copy-more-arg-follows)
 124   (:vop-var vop)
 125   (:generator 1
 126     (align n-lowtag-bits)
 127     (trace-table-entry trace-table-fun-prologue)
 128     (emit-label start-lab)
 129     ;; Skip space for the function header.
 130     (inst simple-fun-header-word)
 131     (dotimes (i (1- simple-fun-code-offset))
 132       (inst dword 0))
 133
 134     ;; The start of the actual code.
 135     ;; Save the return-pc.
 136     (popw ebp-tn (- (1+ return-pc-save-offset)))
 137
 138     ;; If copy-more-arg follows it will allocate the correct stack
 139     ;; size. The stack is not allocated first here as this may expose
 140     ;; args on the stack if they take up more space than the frame!
 141     (unless copy-more-arg-follows
 142       ;; The args fit within the frame so just allocate the frame.
 143       (inst lea esp-tn
 144             (make-ea :dword :base ebp-tn
 145                      :disp (- (* n-word-bytes
 146                                  (max 3 (sb-allocated-size 'stack)))))))
 147
 148     (trace-table-entry trace-table-normal)))
 149
 150 ;;; This is emitted directly before either a known-call-local, call-local,
 151 ;;; or a multiple-call-local. All it does is allocate stack space for the
 152 ;;; callee (who has the same size stack as us).
 153 (define-vop (allocate-frame)
 154   (:results (res :scs (any-reg control-stack))
 155             (nfp))
 156   (:info callee)
 157   (:ignore nfp callee)
 158   (:generator 2
 159     (move res esp-tn)
 160     (inst sub esp-tn (* n-word-bytes (sb-allocated-size 'stack)))))
 161
 162 ;;; Allocate a partial frame for passing stack arguments in a full
 163 ;;; call. NARGS is the number of arguments passed. We allocate at
 164 ;;; least 3 slots, because the XEP noise is going to want to use them
 165 ;;; before it can extend the stack.
 166 (define-vop (allocate-full-call-frame)
 167   (:info nargs)
 168   (:results (res :scs (any-reg control-stack)))
 169   (:generator 2
 170     (move res esp-tn)
 171     (inst sub esp-tn (* (max nargs 3) n-word-bytes))))
 172 \f
 173 ;;; Emit code needed at the return-point from an unknown-values call
 174 ;;; for a fixed number of values. Values is the head of the TN-REF
 175 ;;; list for the locations that the values are to be received into.
 176 ;;; Nvals is the number of values that are to be received (should
 177 ;;; equal the length of Values).
 178 ;;;
 179 ;;; MOVE-TEMP is a DESCRIPTOR-REG TN used as a temporary.
 180 ;;;
 181 ;;; This code exploits the fact that in the unknown-values convention,
 182 ;;; a single value return returns at the return PC + 2, whereas a
 183 ;;; return of other than one value returns directly at the return PC.
 184 ;;;
 185 ;;; If 0 or 1 values are expected, then we just emit an instruction to
 186 ;;; reset the SP (which will only be executed when other than 1 value
 187 ;;; is returned.)
 188 ;;;
 189 ;;; In the general case we have to do three things:
 190 ;;;  -- Default unsupplied register values. This need only be done
 191 ;;;     when a single value is returned, since register values are
 192 ;;;     defaulted by the called in the non-single case.
 193 ;;;  -- Default unsupplied stack values. This needs to be done whenever
 194 ;;;     there are stack values.
 195 ;;;  -- Reset SP. This must be done whenever other than 1 value is
 196 ;;;     returned, regardless of the number of values desired.
 197 (defun default-unknown-values (vop values nvals)
 198   (declare (type (or tn-ref null) values)
 199            (type unsigned-byte nvals))
 200   (cond
 201    ((<= nvals 1)
 202     (note-this-location vop :single-value-return)
 203     (inst mov esp-tn ebx-tn))
 204    ((<= nvals register-arg-count)
 205     (let ((regs-defaulted (gen-label)))
 206       (note-this-location vop :unknown-return)
 207       (inst jmp-short regs-defaulted)
 208       ;; Default the unsuppled registers.
 209       (let* ((2nd-tn-ref (tn-ref-across values))
 210              (2nd-tn (tn-ref-tn 2nd-tn-ref)))
 211         (inst mov 2nd-tn nil-value)
 212         (when (> nvals 2)
 213           (loop
 214             for tn-ref = (tn-ref-across 2nd-tn-ref)
 215             then (tn-ref-across tn-ref)
 216             for count from 2 below register-arg-count
 217             do (inst mov (tn-ref-tn tn-ref) 2nd-tn))))
 218       (inst mov ebx-tn esp-tn)
 219       (emit-label regs-defaulted)
 220       (inst mov esp-tn ebx-tn)))
 221    ((<= nvals 7)
 222     ;; The number of bytes depends on the relative jump instructions.
 223     ;; Best case is 31+(n-3)*14, worst case is 35+(n-3)*18. For
 224     ;; NVALS=6 that is 73/89 bytes, and for NVALS=7 that is 87/107
 225     ;; bytes which is likely better than using the blt below.
 226     (let ((regs-defaulted (gen-label))
 227           (defaulting-done (gen-label))
 228           (default-stack-slots (gen-label)))
 229       (note-this-location vop :unknown-return)
 230       ;; Branch off to the MV case.
 231       (inst jmp-short regs-defaulted)
 232       ;; Do the single value case.
 233       ;; Default the register args
 234       (inst mov eax-tn nil-value)
 235       (do ((i 1 (1+ i))
 236            (val (tn-ref-across values) (tn-ref-across val)))
 237           ((= i (min nvals register-arg-count)))
 238         (inst mov (tn-ref-tn val) eax-tn))
 239
 240       ;; Fake other registers so it looks like we returned with all the
 241       ;; registers filled in.
 242       (move ebx-tn esp-tn)
 243       (inst push edx-tn)
 244       (inst jmp default-stack-slots)
 245
 246       (emit-label regs-defaulted)
 247
 248       (inst mov eax-tn nil-value)
 249       (storew edx-tn ebx-tn -1)
 250       (collect ((defaults))
 251         (do ((i register-arg-count (1+ i))
 252              (val (do ((i 0 (1+ i))
 253                        (val values (tn-ref-across val)))
 254                       ((= i register-arg-count) val))
 255                   (tn-ref-across val)))
 256             ((null val))
 257           (let ((default-lab (gen-label))
 258                 (tn (tn-ref-tn val)))
 259             (defaults (cons default-lab tn))
 260
 261             (inst cmp ecx-tn (fixnumize i))
 262             (inst jmp :be default-lab)
 263             (loadw edx-tn ebx-tn (- (1+ i)))
 264             (inst mov tn edx-tn)))
 265
 266         (emit-label defaulting-done)
 267         (loadw edx-tn ebx-tn -1)
 268         (move esp-tn ebx-tn)
 269
 270         (let ((defaults (defaults)))
 271           (when defaults
 272             (assemble (*elsewhere*)
 273               (trace-table-entry trace-table-fun-prologue)
 274               (emit-label default-stack-slots)
 275               (dolist (default defaults)
 276                 (emit-label (car default))
 277                 (inst mov (cdr default) eax-tn))
 278               (inst jmp defaulting-done)
 279               (trace-table-entry trace-table-normal)))))))
 280    (t
 281     ;; 91 bytes for this branch.
 282     (let ((regs-defaulted (gen-label))
 283           (restore-edi (gen-label))
 284           (no-stack-args (gen-label))
 285           (default-stack-vals (gen-label))
 286           (count-okay (gen-label)))
 287       (note-this-location vop :unknown-return)
 288       ;; Branch off to the MV case.
 289       (inst jmp-short regs-defaulted)
 290
 291       ;; Default the register args, and set up the stack as if we
 292       ;; entered the MV return point.
 293       (inst mov ebx-tn esp-tn)
 294       (inst push edx-tn)
 295       (inst mov edi-tn nil-value)
 296       (inst push edi-tn)
 297       (inst mov esi-tn edi-tn)
 298       ;; Compute a pointer to where to put the [defaulted] stack values.
 299       (emit-label no-stack-args)
 300       (inst lea edi-tn
 301             (make-ea :dword :base ebp-tn
 302                      :disp (* (- (1+ register-arg-count)) n-word-bytes)))
 303       ;; Load EAX with NIL so we can quickly store it, and set up
 304       ;; stuff for the loop.
 305       (inst mov eax-tn nil-value)
 306       (inst std)
 307       (inst mov ecx-tn (- nvals register-arg-count))
 308       ;; Jump into the default loop.
 309       (inst jmp default-stack-vals)
 310
 311       ;; The regs are defaulted. We need to copy any stack arguments,
 312       ;; and then default the remaining stack arguments.
 313       (emit-label regs-defaulted)
 314       ;; Save EDI.
 315       (storew edi-tn ebx-tn (- (1+ 1)))
 316       ;; Compute the number of stack arguments, and if it's zero or
 317       ;; less, don't copy any stack arguments.
 318       (inst sub ecx-tn (fixnumize register-arg-count))
 319       (inst jmp :le no-stack-args)
 320
 321       ;; Throw away any unwanted args.
 322       (inst cmp ecx-tn (fixnumize (- nvals register-arg-count)))
 323       (inst jmp :be count-okay)
 324       (inst mov ecx-tn (fixnumize (- nvals register-arg-count)))
 325       (emit-label count-okay)
 326       ;; Save the number of stack values.
 327       (inst mov eax-tn ecx-tn)
 328       ;; Compute a pointer to where the stack args go.
 329       (inst lea edi-tn
 330             (make-ea :dword :base ebp-tn
 331                      :disp (* (- (1+ register-arg-count)) n-word-bytes)))
 332       ;; Save ESI, and compute a pointer to where the args come from.
 333       (storew esi-tn ebx-tn (- (1+ 2)))
 334       (inst lea esi-tn
 335             (make-ea :dword :base ebx-tn
 336                      :disp (* (- (1+ register-arg-count)) n-word-bytes)))
 337       ;; Do the copy.
 338       (inst shr ecx-tn word-shift)              ; make word count
 339       (inst std)
 340       (inst rep)
 341       (inst movs :dword)
 342       ;; Restore ESI.
 343       (loadw esi-tn ebx-tn (- (1+ 2)))
 344       ;; Now we have to default the remaining args. Find out how many.
 345       (inst sub eax-tn (fixnumize (- nvals register-arg-count)))
 346       (inst neg eax-tn)
 347       ;; If none, then just blow out of here.
 348       (inst jmp :le restore-edi)
 349       (inst mov ecx-tn eax-tn)
 350       (inst shr ecx-tn word-shift)      ; word count
 351       ;; Load EAX with NIL for fast storing.
 352       (inst mov eax-tn nil-value)
 353       ;; Do the store.
 354       (emit-label default-stack-vals)
 355       (inst rep)
 356       (inst stos eax-tn)
 357       ;; Restore EDI, and reset the stack.
 358       (emit-label restore-edi)
 359       (loadw edi-tn ebx-tn (- (1+ 1)))
 360       (inst mov esp-tn ebx-tn))))
 361   (values))
 362 \f
 363 ;;;; unknown values receiving
 364
 365 ;;; Emit code needed at the return point for an unknown-values call
 366 ;;; for an arbitrary number of values.
 367 ;;;
 368 ;;; We do the single and non-single cases with no shared code: there
 369 ;;; doesn't seem to be any potential overlap, and receiving a single
 370 ;;; value is more important efficiency-wise.
 371 ;;;
 372 ;;; When there is a single value, we just push it on the stack,
 373 ;;; returning the old SP and 1.
 374 ;;;
 375 ;;; When there is a variable number of values, we move all of the
 376 ;;; argument registers onto the stack, and return ARGS and NARGS.
 377 ;;;
 378 ;;; ARGS and NARGS are TNs wired to the named locations. We must
 379 ;;; explicitly allocate these TNs, since their lifetimes overlap with
 380 ;;; the results start and count. (Also, it's nice to be able to target
 381 ;;; them.)
 382 (defun receive-unknown-values (args nargs start count)
 383   (declare (type tn args nargs start count))
 384   (let ((variable-values (gen-label))
 385         (done (gen-label)))
 386     (inst jmp-short variable-values)
 387
 388     (cond ((location= start (first *register-arg-tns*))
 389            (inst push (first *register-arg-tns*))
 390            (inst lea start (make-ea :dword :base esp-tn :disp 4)))
 391           (t (inst mov start esp-tn)
 392              (inst push (first *register-arg-tns*))))
 393     (inst mov count (fixnumize 1))
 394     (inst jmp done)
 395
 396     (emit-label variable-values)
 397     ;; dtc: this writes the registers onto the stack even if they are
 398     ;; not needed, only the number specified in ecx are used and have
 399     ;; stack allocated to them. No harm is done.
 400     (loop
 401       for arg in *register-arg-tns*
 402       for i downfrom -1
 403       do (storew arg args i))
 404     (move start args)
 405     (move count nargs)
 406
 407     (emit-label done))
 408   (values))
 409
 410 ;;; VOP that can be inherited by unknown values receivers. The main thing this
 411 ;;; handles is allocation of the result temporaries.
 412 (define-vop (unknown-values-receiver)
 413   (:temporary (:sc descriptor-reg :offset ebx-offset
 414                    :from :eval :to (:result 0))
 415               values-start)
 416   (:temporary (:sc any-reg :offset ecx-offset
 417                :from :eval :to (:result 1))
 418               nvals)
 419   (:results (start :scs (any-reg control-stack))
 420             (count :scs (any-reg control-stack))))
 421 \f
 422 ;;;; local call with unknown values convention return
 423
 424 ;;; Non-TR local call for a fixed number of values passed according to
 425 ;;; the unknown values convention.
 426 ;;;
 427 ;;; FP is the frame pointer in install before doing the call.
 428 ;;;
 429 ;;; NFP would be the number-stack frame pointer if we had a separate
 430 ;;; number stack.
 431 ;;;
 432 ;;; Args are the argument passing locations, which are specified only
 433 ;;; to terminate their lifetimes in the caller.
 434 ;;;
 435 ;;; VALUES are the return value locations (wired to the standard
 436 ;;; passing locations). NVALS is the number of values received.
 437 ;;;
 438 ;;; Save is the save info, which we can ignore since saving has been
 439 ;;; done.
 440 ;;;
 441 ;;; TARGET is a continuation pointing to the start of the called
 442 ;;; function.
 443 (define-vop (call-local)
 444   (:args (fp)
 445          (nfp)
 446          (args :more t))
 447   (:results (values :more t))
 448   (:save-p t)
 449   (:move-args :local-call)
 450   (:info arg-locs callee target nvals)
 451   (:vop-var vop)
 452   (:ignore nfp arg-locs args #+nil callee)
 453   (:generator 5
 454     (trace-table-entry trace-table-call-site)
 455     (move ebp-tn fp)
 456
 457     (let ((ret-tn (callee-return-pc-tn callee)))
 458       #+nil
 459       (format t "*call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
 460               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
 461               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
 462
 463       ;; Is the return-pc on the stack or in a register?
 464       (sc-case ret-tn
 465         ((sap-stack)
 466          #+nil (format t "*call-local: ret-tn on stack; offset=~S~%"
 467                        (tn-offset ret-tn))
 468          (storew (make-fixup nil :code-object return)
 469                  ebp-tn (- (1+ (tn-offset ret-tn)))))
 470         ((sap-reg)
 471          (inst lea ret-tn (make-fixup nil :code-object return)))))
 472
 473     (note-this-location vop :call-site)
 474     (inst jmp target)
 475     RETURN
 476     (default-unknown-values vop values nvals)
 477     (trace-table-entry trace-table-normal)))
 478
 479 ;;; Non-TR local call for a variable number of return values passed according
 480 ;;; to the unknown values convention. The results are the start of the values
 481 ;;; glob and the number of values received.
 482 (define-vop (multiple-call-local unknown-values-receiver)
 483   (:args (fp)
 484          (nfp)
 485          (args :more t))
 486   (:save-p t)
 487   (:move-args :local-call)
 488   (:info save callee target)
 489   (:ignore args save nfp #+nil callee)
 490   (:vop-var vop)
 491   (:generator 20
 492     (trace-table-entry trace-table-call-site)
 493     (move ebp-tn fp)
 494
 495     (let ((ret-tn (callee-return-pc-tn callee)))
 496       #+nil
 497       (format t "*multiple-call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
 498               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
 499               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
 500
 501       ;; Is the return-pc on the stack or in a register?
 502       (sc-case ret-tn
 503         ((sap-stack)
 504          #+nil (format t "*multiple-call-local: ret-tn on stack; offset=~S~%"
 505                        (tn-offset ret-tn))
 506          ;; Stack
 507          (storew (make-fixup nil :code-object return)
 508                  ebp-tn (- (1+ (tn-offset ret-tn)))))
 509         ((sap-reg)
 510          ;; Register
 511          (inst lea ret-tn (make-fixup nil :code-object return)))))
 512
 513     (note-this-location vop :call-site)
 514     (inst jmp target)
 515     RETURN
 516     (note-this-location vop :unknown-return)
 517     (receive-unknown-values values-start nvals start count)
 518     (trace-table-entry trace-table-normal)))
 519 \f
 520 ;;;; local call with known values return
 521
 522 ;;; Non-TR local call with known return locations. Known-value return
 523 ;;; works just like argument passing in local call.
 524 ;;;
 525 ;;; Note: we can't use normal load-tn allocation for the fixed args,
 526 ;;; since all registers may be tied up by the more operand. Instead,
 527 ;;; we use MAYBE-LOAD-STACK-TN.
 528 (define-vop (known-call-local)
 529   (:args (fp)
 530          (nfp)
 531          (args :more t))
 532   (:results (res :more t))
 533   (:move-args :local-call)
 534   (:save-p t)
 535   (:info save callee target)
 536   (:ignore args res save nfp #+nil callee)
 537   (:vop-var vop)
 538   (:generator 5
 539     (trace-table-entry trace-table-call-site)
 540     (move ebp-tn fp)
 541
 542     (let ((ret-tn (callee-return-pc-tn callee)))
 543
 544       #+nil
 545       (format t "*known-call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
 546               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
 547               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
 548
 549       ;; Is the return-pc on the stack or in a register?
 550       (sc-case ret-tn
 551         ((sap-stack)
 552          #+nil (format t "*known-call-local: ret-tn on stack; offset=~S~%"
 553                        (tn-offset ret-tn))
 554          ;; Stack
 555          (storew (make-fixup nil :code-object return)
 556                  ebp-tn (- (1+ (tn-offset ret-tn)))))
 557         ((sap-reg)
 558          ;; Register
 559          (inst lea ret-tn (make-fixup nil :code-object return)))))
 560
 561     (note-this-location vop :call-site)
 562     (inst jmp target)
 563     RETURN
 564     (note-this-location vop :known-return)
 565     (trace-table-entry trace-table-normal)))
 566 \f
 567 ;;; Return from known values call. We receive the return locations as
 568 ;;; arguments to terminate their lifetimes in the returning function. We
 569 ;;; restore FP and CSP and jump to the Return-PC.
 570 ;;;
 571 ;;; We can assume we know exactly where old-fp and return-pc are because
 572 ;;; make-old-fp-save-location and make-return-pc-save-location always
 573 ;;; return the same place.
 574 #+nil
 575 (define-vop (known-return)
 576   (:args (old-fp)
 577          (return-pc :scs (any-reg immediate-stack) :target rpc)
 578          (vals :more t))
 579   (:move-args :known-return)
 580   (:info val-locs)
 581   (:temporary (:sc unsigned-reg :from (:argument 1)) rpc)
 582   (:ignore val-locs vals)
 583   (:vop-var vop)
 584   (:generator 6
 585     (trace-table-entry trace-table-fun-epilogue)
 586     ;; Save the return-pc in a register 'cause the frame-pointer is
 587     ;; going away. Note this not in the usual stack location so we
 588     ;; can't use RET
 589     (move rpc return-pc)
 590     ;; Restore the stack.
 591     (move esp-tn ebp-tn)
 592     ;; Restore the old fp. We know OLD-FP is going to be in its stack
 593     ;; save slot, which is a different frame that than this one,
 594     ;; so we don't have to worry about having just cleared
 595     ;; most of the stack.
 596     (move ebp-tn old-fp)
 597     (inst jmp rpc)
 598     (trace-table-entry trace-table-normal)))
 599 \f
 600 ;;; From Douglas Crosher
 601 ;;; Return from known values call. We receive the return locations as
 602 ;;; arguments to terminate their lifetimes in the returning function. We
 603 ;;; restore FP and CSP and jump to the Return-PC.
 604 ;;;
 605 ;;; The old-fp may be either in a register or on the stack in its
 606 ;;; standard save locations - slot 0.
 607 ;;;
 608 ;;; The return-pc may be in a register or on the stack in any slot.
 609 (define-vop (known-return)
 610   (:args (old-fp)
 611          (return-pc)
 612          (vals :more t))
 613   (:move-args :known-return)
 614   (:info val-locs)
 615   (:ignore val-locs vals)
 616   (:vop-var vop)
 617   (:generator 6
 618     (trace-table-entry trace-table-fun-epilogue)
 619
 620     #+nil (format t "*known-return: old-fp ~S, tn-kind ~S; ~S ~S~%"
 621                   old-fp (sb!c::tn-kind old-fp) (sb!c::tn-save-tn old-fp)
 622                   (sb!c::tn-kind (sb!c::tn-save-tn old-fp)))
 623
 624     #+nil (format t "*known-return: return-pc ~S, tn-kind ~S; ~S ~S~%"
 625                   return-pc (sb!c::tn-kind return-pc)
 626                   (sb!c::tn-save-tn return-pc)
 627                   (sb!c::tn-kind (sb!c::tn-save-tn return-pc)))
 628
 629     ;; return-pc may be either in a register or on the stack.
 630     (sc-case return-pc
 631       ((sap-reg)
 632        (sc-case old-fp
 633          ((control-stack)
 634
 635           #+nil (format t "*known-return: old-fp ~S on stack; offset=~S~%"
 636                         old-fp (tn-offset old-fp))
 637
 638           (cond ((zerop (tn-offset old-fp))
 639                  ;; Zot all of the stack except for the old-fp.
 640                  (inst lea esp-tn (make-ea :dword :base ebp-tn
 641                                            :disp (- (* (1+ ocfp-save-offset)
 642                                                        n-word-bytes))))
 643                  ;; Restore the old fp from its save location on the stack,
 644                  ;; and zot the stack.
 645                  (inst pop ebp-tn))
 646
 647                 (t
 648                  (cerror "Continue anyway"
 649                          "VOP return-local doesn't work if old-fp (in slot ~
 650                           ~S) is not in slot 0"
 651                          (tn-offset old-fp)))))
 652
 653          ((any-reg descriptor-reg)
 654           ;; Zot all the stack.
 655           (move esp-tn ebp-tn)
 656           ;; Restore the old-fp.
 657           (move ebp-tn old-fp)))
 658
 659        ;; Return; return-pc is in a register.
 660        (inst jmp return-pc))
 661
 662       ((sap-stack)
 663
 664        #+nil (format t "*known-return: return-pc ~S on stack; offset=~S~%"
 665                      return-pc (tn-offset return-pc))
 666
 667        ;; Zot all of the stack except for the old-fp and return-pc.
 668        (inst lea esp-tn
 669              (make-ea :dword :base ebp-tn
 670                       :disp (- (* (1+ (tn-offset return-pc)) n-word-bytes))))
 671        ;; Restore the old fp. old-fp may be either on the stack in its
 672        ;; save location or in a register, in either case this restores it.
 673        (move ebp-tn old-fp)
 674        ;; The return pops the return address (4 bytes), then we need
 675        ;; to pop all the slots before the return-pc which includes the
 676        ;; 4 bytes for the old-fp.
 677        (inst ret (* (tn-offset return-pc) n-word-bytes))))
 678
 679     (trace-table-entry trace-table-normal)))
 680 \f
 681 ;;;; full call
 682 ;;;
 683 ;;; There is something of a cross-product effect with full calls.
 684 ;;; Different versions are used depending on whether we know the
 685 ;;; number of arguments or the name of the called function, and
 686 ;;; whether we want fixed values, unknown values, or a tail call.
 687 ;;;
 688 ;;; In full call, the arguments are passed creating a partial frame on
 689 ;;; the stack top and storing stack arguments into that frame. On
 690 ;;; entry to the callee, this partial frame is pointed to by FP.
 691
 692 ;;; This macro helps in the definition of full call VOPs by avoiding
 693 ;;; code replication in defining the cross-product VOPs.
 694 ;;;
 695 ;;; NAME is the name of the VOP to define.
 696 ;;;
 697 ;;; NAMED is true if the first argument is an fdefinition object whose
 698 ;;; definition is to be called.
 699 ;;;
 700 ;;; RETURN is either :FIXED, :UNKNOWN or :TAIL:
 701 ;;; -- If :FIXED, then the call is for a fixed number of values, returned in
 702 ;;;    the standard passing locations (passed as result operands).
 703 ;;; -- If :UNKNOWN, then the result values are pushed on the stack, and the
 704 ;;;    result values are specified by the Start and Count as in the
 705 ;;;    unknown-values continuation representation.
 706 ;;; -- If :TAIL, then do a tail-recursive call. No values are returned.
 707 ;;;    The Old-Fp and Return-PC are passed as the second and third arguments.
 708 ;;;
 709 ;;; In non-tail calls, the pointer to the stack arguments is passed as
 710 ;;; the last fixed argument. If Variable is false, then the passing
 711 ;;; locations are passed as a more arg. Variable is true if there are
 712 ;;; a variable number of arguments passed on the stack. Variable
 713 ;;; cannot be specified with :TAIL return. TR variable argument call
 714 ;;; is implemented separately.
 715 ;;;
 716 ;;; In tail call with fixed arguments, the passing locations are
 717 ;;; passed as a more arg, but there is no new-FP, since the arguments
 718 ;;; have been set up in the current frame.
 719 (macrolet ((define-full-call (name named return variable)
 720             (aver (not (and variable (eq return :tail))))
 721             `(define-vop (,name
 722                           ,@(when (eq return :unknown)
 723                               '(unknown-values-receiver)))
 724                (:args
 725                ,@(unless (eq return :tail)
 726                    '((new-fp :scs (any-reg) :to (:argument 1))))
 727
 728                (fun :scs (descriptor-reg control-stack)
 729                     :target eax :to (:argument 0))
 730
 731                ,@(when (eq return :tail)
 732                    '((old-fp)
 733                      (return-pc)))
 734
 735                ,@(unless variable '((args :more t :scs (descriptor-reg)))))
 736
 737                ,@(when (eq return :fixed)
 738                '((:results (values :more t))))
 739
 740                (:save-p ,(if (eq return :tail) :compute-only t))
 741
 742                ,@(unless (or (eq return :tail) variable)
 743                '((:move-args :full-call)))
 744
 745                (:vop-var vop)
 746                (:info
 747                ,@(unless (or variable (eq return :tail)) '(arg-locs))
 748                ,@(unless variable '(nargs))
 749                ,@(when (eq return :fixed) '(nvals)))
 750
 751                (:ignore
 752                ,@(unless (or variable (eq return :tail)) '(arg-locs))
 753                ,@(unless variable '(args)))
 754
 755                ;; We pass either the fdefn object (for named call) or
 756                ;; the actual function object (for unnamed call) in
 757                ;; EAX. With named call, closure-tramp will replace it
 758                ;; with the real function and invoke the real function
 759                ;; for closures. Non-closures do not need this value,
 760                ;; so don't care what shows up in it.
 761                (:temporary
 762                (:sc descriptor-reg
 763                     :offset eax-offset
 764                     :from (:argument 0)
 765                     :to :eval)
 766                eax)
 767
 768                ;; We pass the number of arguments in ECX.
 769                (:temporary (:sc unsigned-reg :offset ecx-offset :to :eval) ecx)
 770
 771                ;; With variable call, we have to load the
 772                ;; register-args out of the (new) stack frame before
 773                ;; doing the call. Therefore, we have to tell the
 774                ;; lifetime stuff that we need to use them.
 775                ,@(when variable
 776                    (mapcar (lambda (name offset)
 777                              `(:temporary (:sc descriptor-reg
 778                                                :offset ,offset
 779                                                :from (:argument 0)
 780                                                :to :eval)
 781                                           ,name))
 782                            *register-arg-names* *register-arg-offsets*))
 783
 784                ,@(when (eq return :tail)
 785                    '((:temporary (:sc unsigned-reg
 786                                       :from (:argument 1)
 787                                       :to (:argument 2))
 788                                  old-fp-tmp)))
 789
 790                (:generator ,(+ (if named 5 0)
 791                                (if variable 19 1)
 792                                (if (eq return :tail) 0 10)
 793                                15
 794                                (if (eq return :unknown) 25 0))
 795                (trace-table-entry trace-table-call-site)
 796
 797                ;; This has to be done before the frame pointer is
 798                ;; changed! EAX stores the 'lexical environment' needed
 799                ;; for closures.
 800                (move eax fun)
 801
 802
 803                ,@(if variable
 804                      ;; For variable call, compute the number of
 805                      ;; arguments and move some of the arguments to
 806                      ;; registers.
 807                      (collect ((noise))
 808                               ;; Compute the number of arguments.
 809                               (noise '(inst mov ecx new-fp))
 810                               (noise '(inst sub ecx esp-tn))
 811                               ;; Move the necessary args to registers,
 812                               ;; this moves them all even if they are
 813                               ;; not all needed.
 814                               (loop
 815                                for name in *register-arg-names*
 816                                for index downfrom -1
 817                                do (noise `(loadw ,name new-fp ,index)))
 818                               (noise))
 819                    '((if (zerop nargs)
 820                          (inst xor ecx ecx)
 821                        (inst mov ecx (fixnumize nargs)))))
 822                ,@(cond ((eq return :tail)
 823                         '(;; Python has figured out what frame we should
 824                           ;; return to so might as well use that clue.
 825                           ;; This seems really important to the
 826                           ;; implementation of things like
 827                           ;; (without-interrupts ...)
 828                           ;;
 829                           ;; dtc; Could be doing a tail call from a
 830                           ;; known-local-call etc in which the old-fp
 831                           ;; or ret-pc are in regs or in non-standard
 832                           ;; places. If the passing location were
 833                           ;; wired to the stack in standard locations
 834                           ;; then these moves will be un-necessary;
 835                           ;; this is probably best for the x86.
 836                           (sc-case old-fp
 837                                    ((control-stack)
 838                                     (unless (= ocfp-save-offset
 839                                                (tn-offset old-fp))
 840                                       ;; FIXME: FORMAT T for stale
 841                                       ;; diagnostic output (several of
 842                                       ;; them around here), ick
 843                                       (format t "** tail-call old-fp not S0~%")
 844                                       (move old-fp-tmp old-fp)
 845                                       (storew old-fp-tmp
 846                                               ebp-tn
 847                                               (- (1+ ocfp-save-offset)))))
 848                                    ((any-reg descriptor-reg)
 849                                     (format t "** tail-call old-fp in reg not S0~%")
 850                                     (storew old-fp
 851                                             ebp-tn
 852                                             (- (1+ ocfp-save-offset)))))
 853
 854                           ;; For tail call, we have to push the
 855                           ;; return-pc so that it looks like we CALLed
 856                           ;; despite the fact that we are going to JMP.
 857                           (inst push return-pc)
 858                           ))
 859                        (t
 860                         ;; For non-tail call, we have to save our
 861                         ;; frame pointer and install the new frame
 862                         ;; pointer. We can't load stack tns after this
 863                         ;; point.
 864                         `(;; Python doesn't seem to allocate a frame
 865                           ;; here which doesn't leave room for the
 866                           ;; ofp/ret stuff.
 867
 868                           ;; The variable args are on the stack and
 869                           ;; become the frame, but there may be <3
 870                           ;; args and 3 stack slots are assumed
 871                           ;; allocate on the call. So need to ensure
 872                           ;; there are at least 3 slots. This hack
 873                           ;; just adds 3 more.
 874                           ,(if variable
 875                                '(inst sub esp-tn (fixnumize 3)))
 876
 877                           ;; Save the fp
 878                           (storew ebp-tn new-fp (- (1+ ocfp-save-offset)))
 879
 880                           (move ebp-tn new-fp) ; NB - now on new stack frame.
 881                           )))
 882
 883                (note-this-location vop :call-site)
 884
 885                (inst ,(if (eq return :tail) 'jmp 'call)
 886                      (make-ea :dword :base eax
 887                               :disp ,(if named
 888                                          '(- (* fdefn-raw-addr-slot
 889                                                 n-word-bytes)
 890                                              other-pointer-lowtag)
 891                                        '(- (* closure-fun-slot n-word-bytes)
 892                                            fun-pointer-lowtag))))
 893                ,@(ecase return
 894                    (:fixed
 895                     '((default-unknown-values vop values nvals)))
 896                    (:unknown
 897                     '((note-this-location vop :unknown-return)
 898                       (receive-unknown-values values-start nvals start count)))
 899                    (:tail))
 900                (trace-table-entry trace-table-normal)))))
 901
 902   (define-full-call call nil :fixed nil)
 903   (define-full-call call-named t :fixed nil)
 904   (define-full-call multiple-call nil :unknown nil)
 905   (define-full-call multiple-call-named t :unknown nil)
 906   (define-full-call tail-call nil :tail nil)
 907   (define-full-call tail-call-named t :tail nil)
 908
 909   (define-full-call call-variable nil :fixed t)
 910   (define-full-call multiple-call-variable nil :unknown t))
 911
 912 ;;; This is defined separately, since it needs special code that BLT's
 913 ;;; the arguments down. All the real work is done in the assembly
 914 ;;; routine. We just set things up so that it can find what it needs.
 915 (define-vop (tail-call-variable)
 916   (:args (args :scs (any-reg control-stack) :target esi)
 917          (function :scs (descriptor-reg control-stack) :target eax)
 918          (old-fp)
 919          (ret-addr))
 920   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 0)) esi)
 921   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)) eax)
 922 ;  (:ignore ret-addr old-fp)
 923   (:generator 75
 924     ;; Move these into the passing locations if they are not already there.
 925     (move esi args)
 926     (move eax function)
 927
 928     ;; The following assumes that the return-pc and old-fp are on the
 929     ;; stack in their standard save locations - Check this.
 930     (unless (and (sc-is old-fp control-stack)
 931                  (= (tn-offset old-fp) ocfp-save-offset))
 932             (error "tail-call-variable: ocfp not on stack in standard save location?"))
 933     (unless (and (sc-is ret-addr sap-stack)
 934                  (= (tn-offset ret-addr) return-pc-save-offset))
 935             (error "tail-call-variable: ret-addr not on stack in standard save location?"))
 936
 937
 938     ;; And jump to the assembly routine.
 939     (inst jmp (make-fixup 'tail-call-variable :assembly-routine))))
 940 \f
 941 ;;;; unknown values return
 942
 943 ;;; Return a single-value using the Unknown-Values convention. Specifically,
 944 ;;; we jump to clear the stack and jump to return-pc+2.
 945 ;;;
 946 ;;; We require old-fp to be in a register, because we want to reset ESP before
 947 ;;; restoring EBP. If old-fp were still on the stack, it could get clobbered
 948 ;;; by a signal.
 949 ;;;
 950 ;;; pfw--get wired-tn conflicts sometimes if register sc specd for args
 951 ;;; having problems targeting args to regs -- using temps instead.
 952 (define-vop (return-single)
 953   (:args (old-fp)
 954          (return-pc)
 955          (value))
 956   (:temporary (:sc unsigned-reg) ofp)
 957   (:temporary (:sc unsigned-reg) ret)
 958   (:ignore value)
 959   (:generator 6
 960     (trace-table-entry trace-table-fun-epilogue)
 961     (move ret return-pc)
 962     ;; Clear the control stack
 963     (move ofp old-fp)
 964     ;; Adjust the return address for the single value return.
 965     (inst add ret 2)
 966     ;; Restore the frame pointer.
 967     (move esp-tn ebp-tn)
 968     (move ebp-tn ofp)
 969     ;; Out of here.
 970     (inst jmp ret)))
 971
 972 ;;; Do unknown-values return of a fixed (other than 1) number of
 973 ;;; values. The VALUES are required to be set up in the standard
 974 ;;; passing locations. NVALS is the number of values returned.
 975 ;;;
 976 ;;; Basically, we just load ECX with the number of values returned and
 977 ;;; EBX with a pointer to the values, set ESP to point to the end of
 978 ;;; the values, and jump directly to return-pc.
 979 (define-vop (return)
 980   (:args (old-fp)
 981          (return-pc :to (:eval 1))
 982          (values :more t))
 983   (:ignore values)
 984   (:info nvals)
 985
 986   ;; In the case of other than one value, we need these registers to
 987   ;; tell the caller where they are and how many there are.
 988   (:temporary (:sc unsigned-reg :offset ebx-offset) ebx)
 989   (:temporary (:sc unsigned-reg :offset ecx-offset) ecx)
 990
 991   ;; We need to stretch the lifetime of return-pc past the argument
 992   ;; registers so that we can default the argument registers without
 993   ;; trashing return-pc.
 994   (:temporary (:sc unsigned-reg :offset (first *register-arg-offsets*)
 995                    :from :eval) a0)
 996   (:temporary (:sc unsigned-reg :offset (second *register-arg-offsets*)
 997                    :from :eval) a1)
 998   (:temporary (:sc unsigned-reg :offset (third *register-arg-offsets*)
 999                    :from :eval) a2)
1000
1001   (:generator 6
1002     (trace-table-entry trace-table-fun-epilogue)
1003     ;; Establish the values pointer and values count.
1004     (move ebx ebp-tn)
1005     (if (zerop nvals)
1006         (inst xor ecx ecx) ; smaller
1007       (inst mov ecx (fixnumize nvals)))
1008     ;; Restore the frame pointer.
1009     (move ebp-tn old-fp)
1010     ;; Clear as much of the stack as possible, but not past the return
1011     ;; address.
1012     (inst lea esp-tn (make-ea :dword :base ebx
1013                               :disp (- (* (max nvals 2) n-word-bytes))))
1014     ;; Pre-default any argument register that need it.
1015     (when (< nvals register-arg-count)
1016       (let* ((arg-tns (nthcdr nvals (list a0 a1 a2)))
1017              (first (first arg-tns)))
1018         (inst mov first nil-value)
1019         (dolist (tn (cdr arg-tns))
1020           (inst mov tn first))))
1021     ;; And away we go. Except that return-pc is still on the
1022     ;; stack and we've changed the stack pointer. So we have to
1023     ;; tell it to index off of EBX instead of EBP.
1024     (cond ((zerop nvals)
1025            ;; Return popping the return address and the OCFP.
1026            (inst ret n-word-bytes))
1027           ((= nvals 1)
1028            ;; Return popping the return, leaving 1 slot. Can this
1029            ;; happen, or is a single value return handled elsewhere?
1030            (inst ret))
1031           (t
1032            (inst jmp (make-ea :dword :base ebx
1033                               :disp (- (* (1+ (tn-offset return-pc))
1034                                           n-word-bytes))))))
1035
1036     (trace-table-entry trace-table-normal)))
1037
1038 ;;; Do unknown-values return of an arbitrary number of values (passed
1039 ;;; on the stack.) We check for the common case of a single return
1040 ;;; value, and do that inline using the normal single value return
1041 ;;; convention. Otherwise, we branch off to code that calls an
1042 ;;; assembly-routine.
1043 ;;;
1044 ;;; The assembly routine takes the following args:
1045 ;;;  EAX -- the return-pc to finally jump to.
1046 ;;;  EBX -- pointer to where to put the values.
1047 ;;;  ECX -- number of values to find there.
1048 ;;;  ESI -- pointer to where to find the values.
1049 (define-vop (return-multiple)
1050   (:args (old-fp :to (:eval 1) :target old-fp-temp)
1051          (return-pc :target eax)
1052          (vals :scs (any-reg) :target esi)
1053          (nvals :scs (any-reg) :target ecx))
1054
1055   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)) eax)
1056   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 2)) esi)
1057   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 3)) ecx)
1058   (:temporary (:sc unsigned-reg :offset ebx-offset :from (:eval 0)) ebx)
1059   (:temporary (:sc descriptor-reg :offset (first *register-arg-offsets*)
1060                    :from (:eval 0)) a0)
1061   (:temporary (:sc unsigned-reg :from (:eval 1)) old-fp-temp)
1062   (:node-var node)
1063
1064   (:generator 13
1065     (trace-table-entry trace-table-fun-epilogue)
1066     ;; Load the return-pc.
1067     (move eax return-pc)
1068     (unless (policy node (> space speed))
1069       ;; Check for the single case.
1070       (let ((not-single (gen-label)))
1071         (inst cmp nvals (fixnumize 1))
1072         (inst jmp :ne not-single)
1073
1074         ;; Return with one value.
1075         (loadw a0 vals -1)
1076         ;; Clear the stack. We load old-fp into a register before clearing
1077         ;; the stack.
1078         (move old-fp-temp old-fp)
1079         (move esp-tn ebp-tn)
1080         (move ebp-tn old-fp-temp)
1081         ;; Fix the return-pc to point at the single-value entry point.
1082         (inst add eax 2)
1083         ;; Out of here.
1084         (inst jmp eax)
1085
1086         ;; Nope, not the single case. Jump to the assembly routine.
1087         (emit-label not-single)))
1088     (move esi vals)
1089     (move ecx nvals)
1090     (move ebx ebp-tn)
1091     (move ebp-tn old-fp)
1092     (inst jmp (make-fixup 'return-multiple :assembly-routine))
1093     (trace-table-entry trace-table-normal)))
1094 \f
1095 ;;;; XEP hackery
1096
1097 ;;; We don't need to do anything special for regular functions.
1098 (define-vop (setup-environment)
1099   (:info label)
1100   (:ignore label)
1101   (:generator 0
1102     ;; Don't bother doing anything.
1103     nil))
1104
1105 ;;; Get the lexical environment from its passing location.
1106 (define-vop (setup-closure-environment)
1107   (:results (closure :scs (descriptor-reg)))
1108   (:info label)
1109   (:ignore label)
1110   (:generator 6
1111     ;; Get result.
1112     (move closure eax-tn)))
1113
1114 ;;; Copy a &MORE arg from the argument area to the end of the current
1115 ;;; frame. FIXED is the number of non-&MORE arguments.
1116 ;;;
1117 ;;; The tricky part is doing this without trashing any of the calling
1118 ;;; convention registers that are still needed. This vop is emitted
1119 ;;; directly after the xep-allocate frame. That means the registers
1120 ;;; are in use as follows:
1121 ;;;
1122 ;;;  EAX -- The lexenv.
1123 ;;;  EBX -- Available.
1124 ;;;  ECX -- The total number of arguments.
1125 ;;;  EDX -- The first arg.
1126 ;;;  EDI -- The second arg.
1127 ;;;  ESI -- The third arg.
1128 ;;;
1129 ;;; So basically, we have one register available for our use: EBX.
1130 ;;;
1131 ;;; What we can do is push the other regs onto the stack, and then
1132 ;;; restore their values by looking directly below where we put the
1133 ;;; more-args.
1134 (define-vop (copy-more-arg)
1135   (:info fixed)
1136   (:generator 20
1137     ;; Avoid the copy if there are no more args.
1138     (cond ((zerop fixed)
1139            (inst jecxz just-alloc-frame))
1140           (t
1141            (inst cmp ecx-tn (fixnumize fixed))
1142            (inst jmp :be just-alloc-frame)))
1143
1144     ;; Allocate the space on the stack.
1145     ;; stack = ebp - (max 3 frame-size) - (nargs - fixed)
1146     (inst lea ebx-tn
1147           (make-ea :dword :base ebp-tn
1148                    :disp (- (fixnumize fixed)
1149                             (* n-word-bytes
1150                                (max 3 (sb-allocated-size 'stack))))))
1151     (inst sub ebx-tn ecx-tn)  ; Got the new stack in ebx
1152     (inst mov esp-tn ebx-tn)
1153
1154     ;; Now: nargs>=1 && nargs>fixed
1155
1156     ;; Save the original count of args.
1157     (inst mov ebx-tn ecx-tn)
1158
1159     (cond ((< fixed register-arg-count)
1160            ;; We must stop when we run out of stack args, not when we
1161            ;; run out of more args.
1162            ;; Number to copy = nargs-3
1163            (inst sub ecx-tn (fixnumize register-arg-count))
1164            ;; Everything of interest in registers.
1165            (inst jmp :be do-regs))
1166           (t
1167            ;; Number to copy = nargs-fixed
1168            (inst sub ecx-tn (fixnumize fixed))))
1169
1170     ;; Save edi and esi register args.
1171     (inst push edi-tn)
1172     (inst push esi-tn)
1173     ;; Okay, we have pushed the register args. We can trash them
1174     ;; now.
1175
1176     ;; Initialize dst to be end of stack; skiping the values pushed
1177     ;; above.
1178     (inst lea edi-tn (make-ea :dword :base esp-tn :disp 8))
1179
1180     ;; Initialize src to be end of args.
1181     (inst mov esi-tn ebp-tn)
1182     (inst sub esi-tn ebx-tn)
1183
1184     (inst shr ecx-tn word-shift)        ; make word count
1185     ;; And copy the args.
1186     (inst cld)                          ; auto-inc ESI and EDI.
1187     (inst rep)
1188     (inst movs :dword)
1189
1190     ;; So now we need to restore EDI and ESI.
1191     (inst pop esi-tn)
1192     (inst pop edi-tn)
1193
1194     DO-REGS
1195
1196     ;; Restore ECX
1197     (inst mov ecx-tn ebx-tn)
1198
1199     ;; Here: nargs>=1 && nargs>fixed
1200     (when (< fixed register-arg-count)
1201           ;; Now we have to deposit any more args that showed up in
1202           ;; registers.
1203           (do ((i fixed))
1204               ( nil )
1205               ;; Store it relative to ebp
1206               (inst mov (make-ea :dword :base ebp-tn
1207                                  :disp (- (* 4
1208                                              (+ 1 (- i fixed)
1209                                                 (max 3 (sb-allocated-size 'stack))))))
1210                     (nth i *register-arg-tns*))
1211
1212               (incf i)
1213               (when (>= i register-arg-count)
1214                     (return))
1215
1216               ;; Don't deposit any more than there are.
1217               (if (zerop i)
1218                   (inst test ecx-tn ecx-tn)
1219                 (inst cmp ecx-tn (fixnumize i)))
1220               (inst jmp :eq done)))
1221
1222     (inst jmp done)
1223
1224     JUST-ALLOC-FRAME
1225     (inst lea esp-tn
1226           (make-ea :dword :base ebp-tn
1227                    :disp (- (* n-word-bytes
1228                                (max 3 (sb-allocated-size 'stack))))))
1229
1230     DONE))
1231
1232 ;;; &MORE args are stored contiguously on the stack, starting
1233 ;;; immediately at the context pointer. The context pointer is not
1234 ;;; typed, so the lowtag is 0.
1235 (define-vop (more-arg)
1236   (:translate %more-arg)
1237   (:policy :fast-safe)
1238   (:args (object :scs (descriptor-reg) :to :result)
1239          (index :scs (any-reg) :target temp))
1240   (:arg-types * tagged-num)
1241   (:temporary (:sc unsigned-reg :from (:argument 1) :to :result) temp)
1242   (:results (value :scs (any-reg descriptor-reg)))
1243   (:result-types *)
1244   (:generator 5
1245     (move temp index)
1246     (inst neg temp)
1247     (inst mov value (make-ea :dword :base object :index temp))))
1248
1249 (define-vop (more-arg-c)
1250   (:translate %more-arg)
1251   (:policy :fast-safe)
1252   (:args (object :scs (descriptor-reg)))
1253   (:info index)
1254   (:arg-types * (:constant (signed-byte 30)))
1255   (:results (value :scs (any-reg descriptor-reg)))
1256   (:result-types *)
1257   (:generator 4
1258    (inst mov value
1259          (make-ea :dword :base object :disp (- (* index n-word-bytes))))))
1260
1261
1262 ;;; Turn more arg (context, count) into a list.
1263 (defoptimizer (%listify-rest-args stack-allocate-result) ((&rest args))
1264   t)
1265
1266 (define-vop (listify-rest-args)
1267   (:translate %listify-rest-args)
1268   (:policy :safe)
1269   (:args (context :scs (descriptor-reg) :target src)
1270          (count :scs (any-reg) :target ecx))
1271   (:arg-types * tagged-num)
1272   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 0)) src)
1273   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
1274   (:temporary (:sc unsigned-reg :offset eax-offset) eax)
1275   (:temporary (:sc unsigned-reg) dst)
1276   (:results (result :scs (descriptor-reg)))
1277   (:node-var node)
1278   (:generator 20
1279     (let ((enter (gen-label))
1280           (loop (gen-label))
1281           (done (gen-label))
1282           (stack-allocate-p (node-stack-allocate-p node)))
1283       (move src context)
1284       (move ecx count)
1285       ;; Check to see whether there are no args, and just return NIL if so.
1286       (inst mov result nil-value)
1287       (inst jecxz done)
1288       (inst lea dst (make-ea :dword :index ecx :scale 2))
1289       (maybe-pseudo-atomic stack-allocate-p
1290        (allocation dst dst node stack-allocate-p)
1291        (inst lea dst (make-ea :byte :base dst :disp list-pointer-lowtag))
1292        ;; Convert the count into a raw value, so that we can use the
1293        ;; LOOP instruction.
1294        (inst shr ecx 2)
1295        ;; Set decrement mode (successive args at lower addresses)
1296        (inst std)
1297        ;; Set up the result.
1298        (move result dst)
1299        ;; Jump into the middle of the loop, 'cause that's were we want
1300        ;; to start.
1301        (inst jmp enter)
1302        (emit-label loop)
1303        ;; Compute a pointer to the next cons.
1304        (inst add dst (* cons-size n-word-bytes))
1305        ;; Store a pointer to this cons in the CDR of the previous cons.
1306        (storew dst dst -1 list-pointer-lowtag)
1307        (emit-label enter)
1308        ;; Grab one value and stash it in the car of this cons.
1309        (inst lods eax)
1310        (storew eax dst 0 list-pointer-lowtag)
1311        ;; Go back for more.
1312        (inst loop loop)
1313        ;; NIL out the last cons.
1314        (storew nil-value dst 1 list-pointer-lowtag))
1315       (emit-label done))))
1316
1317 ;;; Return the location and size of the &MORE arg glob created by
1318 ;;; COPY-MORE-ARG. SUPPLIED is the total number of arguments supplied
1319 ;;; (originally passed in ECX). FIXED is the number of non-rest
1320 ;;; arguments.
1321 ;;;
1322 ;;; We must duplicate some of the work done by COPY-MORE-ARG, since at
1323 ;;; that time the environment is in a pretty brain-damaged state,
1324 ;;; preventing this info from being returned as values. What we do is
1325 ;;; compute supplied - fixed, and return a pointer that many words
1326 ;;; below the current stack top.
1327 (define-vop (more-arg-context)
1328   (:policy :fast-safe)
1329   (:translate sb!c::%more-arg-context)
1330   (:args (supplied :scs (any-reg) :target count))
1331   (:arg-types positive-fixnum (:constant fixnum))
1332   (:info fixed)
1333   (:results (context :scs (descriptor-reg))
1334             (count :scs (any-reg)))
1335   (:result-types t tagged-num)
1336   (:note "more-arg-context")
1337   (:generator 5
1338     (move count supplied)
1339     ;; SP at this point points at the last arg pushed.
1340     ;; Point to the first more-arg, not above it.
1341     (inst lea context (make-ea :dword :base esp-tn
1342                                :index count :scale 1
1343                                :disp (- (+ (fixnumize fixed) 4))))
1344     (unless (zerop fixed)
1345       (inst sub count (fixnumize fixed)))))
1346
1347 ;;; Signal wrong argument count error if NARGS isn't equal to COUNT.
1348 (define-vop (verify-arg-count)
1349   (:policy :fast-safe)
1350   (:translate sb!c::%verify-arg-count)
1351   (:args (nargs :scs (any-reg)))
1352   (:arg-types positive-fixnum (:constant t))
1353   (:info count)
1354   (:vop-var vop)
1355   (:save-p :compute-only)
1356   (:generator 3
1357     (let ((err-lab
1358            (generate-error-code vop invalid-arg-count-error nargs)))
1359       (if (zerop count)
1360           (inst test nargs nargs)  ; smaller instruction
1361         (inst cmp nargs (fixnumize count)))
1362       (inst jmp :ne err-lab))))
1363
1364 ;;; Various other error signallers.
1365 (macrolet ((def (name error translate &rest args)
1366              `(define-vop (,name)
1367                 ,@(when translate
1368                     `((:policy :fast-safe)
1369                       (:translate ,translate)))
1370                 (:args ,@(mapcar (lambda (arg)
1371                                    `(,arg :scs (any-reg descriptor-reg)))
1372                                  args))
1373                 (:vop-var vop)
1374                 (:save-p :compute-only)
1375                 (:generator 1000
1376                   (error-call vop ,error ,@args)))))
1377   (def arg-count-error invalid-arg-count-error
1378     sb!c::%arg-count-error nargs)
1379   (def type-check-error object-not-type-error sb!c::%type-check-error
1380     object type)
1381   (def layout-invalid-error layout-invalid-error sb!c::%layout-invalid-error
1382     object layout)
1383   (def odd-key-args-error odd-key-args-error
1384     sb!c::%odd-key-args-error)
1385   (def unknown-key-arg-error unknown-key-arg-error
1386     sb!c::%unknown-key-arg-error key)
1387   (def nil-fun-returned-error nil-fun-returned-error nil fun))