bdd1d54134416934ae0b6528865dbe4bc08cb7dd
[sbcl.git] / 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     (emit-alignment 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 (frame-word-offset 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     (let ((single-value (gen-label)))
204       (cond
205        ((member :cmov *backend-subfeatures*)
206         (inst cmov :c esp-tn ebx-tn))
207        (t
208         (inst jmp :nc single-value)
209         (inst mov esp-tn ebx-tn)
210         (emit-label single-value)))))
211    ((<= nvals register-arg-count)
212     (let ((regs-defaulted (gen-label)))
213       (note-this-location vop :unknown-return)
214       (inst jmp :c regs-defaulted)
215       ;; Default the unsuppled registers.
216       (let* ((2nd-tn-ref (tn-ref-across values))
217              (2nd-tn (tn-ref-tn 2nd-tn-ref)))
218         (inst mov 2nd-tn nil-value)
219         (when (> nvals 2)
220           (loop
221             for tn-ref = (tn-ref-across 2nd-tn-ref)
222             then (tn-ref-across tn-ref)
223             for count from 2 below register-arg-count
224             do (inst mov (tn-ref-tn tn-ref) 2nd-tn))))
225       (inst mov ebx-tn esp-tn)
226       (emit-label regs-defaulted)
227       (inst mov esp-tn ebx-tn)))
228    ((<= nvals 7)
229     ;; The number of bytes depends on the relative jump instructions.
230     ;; Best case is 31+(n-3)*14, worst case is 35+(n-3)*18. For
231     ;; NVALS=6 that is 73/89 bytes, and for NVALS=7 that is 87/107
232     ;; bytes which is likely better than using the blt below.
233     (let ((regs-defaulted (gen-label))
234           (defaulting-done (gen-label))
235           (default-stack-slots (gen-label)))
236       (note-this-location vop :unknown-return)
237       ;; Branch off to the MV case.
238       (inst jmp :c regs-defaulted)
239       ;; Do the single value case.
240       ;; Default the register args
241       (inst mov eax-tn nil-value)
242       (do ((i 1 (1+ i))
243            (val (tn-ref-across values) (tn-ref-across val)))
244           ((= i (min nvals register-arg-count)))
245         (inst mov (tn-ref-tn val) eax-tn))
246
247       ;; Fake other registers so it looks like we returned with all the
248       ;; registers filled in.
249       (move ebx-tn esp-tn)
250       (inst push edx-tn)
251       (inst jmp default-stack-slots)
252
253       (emit-label regs-defaulted)
254
255       (inst mov eax-tn nil-value)
256       (storew edx-tn ebx-tn -1)
257       (collect ((defaults))
258         (do ((i register-arg-count (1+ i))
259              (val (do ((i 0 (1+ i))
260                        (val values (tn-ref-across val)))
261                       ((= i register-arg-count) val))
262                   (tn-ref-across val)))
263             ((null val))
264           (let ((default-lab (gen-label))
265                 (tn (tn-ref-tn val)))
266             (defaults (cons default-lab tn))
267
268             (inst cmp ecx-tn (fixnumize i))
269             (inst jmp :be default-lab)
270             (loadw edx-tn ebx-tn (frame-word-offset i))
271             (inst mov tn edx-tn)))
272
273         (emit-label defaulting-done)
274         (loadw edx-tn ebx-tn -1)
275         (move esp-tn ebx-tn)
276
277         (let ((defaults (defaults)))
278           (when defaults
279             (assemble (*elsewhere*)
280               (trace-table-entry trace-table-fun-prologue)
281               (emit-label default-stack-slots)
282               (dolist (default defaults)
283                 (emit-label (car default))
284                 (inst mov (cdr default) eax-tn))
285               (inst jmp defaulting-done)
286               (trace-table-entry trace-table-normal)))))))
287    (t
288     ;; 91 bytes for this branch.
289     (let ((regs-defaulted (gen-label))
290           (restore-edi (gen-label))
291           (no-stack-args (gen-label))
292           (default-stack-vals (gen-label))
293           (count-okay (gen-label)))
294       (note-this-location vop :unknown-return)
295       ;; Branch off to the MV case.
296       (inst jmp :c regs-defaulted)
297
298       ;; Default the register args, and set up the stack as if we
299       ;; entered the MV return point.
300       (inst mov ebx-tn esp-tn)
301       (inst push edx-tn)
302       (inst mov edi-tn nil-value)
303       (inst push edi-tn)
304       (inst mov esi-tn edi-tn)
305       ;; Compute a pointer to where to put the [defaulted] stack values.
306       (emit-label no-stack-args)
307       (inst lea edi-tn
308             (make-ea :dword :base ebp-tn
309                      :disp (frame-byte-offset register-arg-count)))
310       ;; Load EAX with NIL so we can quickly store it, and set up
311       ;; stuff for the loop.
312       (inst mov eax-tn nil-value)
313       (inst std)
314       (inst mov ecx-tn (- nvals register-arg-count))
315       ;; Jump into the default loop.
316       (inst jmp default-stack-vals)
317
318       ;; The regs are defaulted. We need to copy any stack arguments,
319       ;; and then default the remaining stack arguments.
320       (emit-label regs-defaulted)
321       ;; Save EDI.
322       (storew edi-tn ebx-tn (frame-word-offset 1))
323       ;; Compute the number of stack arguments, and if it's zero or
324       ;; less, don't copy any stack arguments.
325       (inst sub ecx-tn (fixnumize register-arg-count))
326       (inst jmp :le no-stack-args)
327
328       ;; Throw away any unwanted args.
329       (inst cmp ecx-tn (fixnumize (- nvals register-arg-count)))
330       (inst jmp :be count-okay)
331       (inst mov ecx-tn (fixnumize (- nvals register-arg-count)))
332       (emit-label count-okay)
333       ;; Save the number of stack values.
334       (inst mov eax-tn ecx-tn)
335       ;; Compute a pointer to where the stack args go.
336       (inst lea edi-tn
337             (make-ea :dword :base ebp-tn
338                      :disp (frame-byte-offset register-arg-count)))
339       ;; Save ESI, and compute a pointer to where the args come from.
340       (storew esi-tn ebx-tn (frame-word-offset 2))
341       (inst lea esi-tn
342             (make-ea :dword :base ebx-tn
343                      :disp (frame-byte-offset register-arg-count)))
344       ;; Do the copy.
345       (inst shr ecx-tn word-shift)              ; make word count
346       (inst std)
347       (inst rep)
348       (inst movs :dword)
349       ;; Restore ESI.
350       (loadw esi-tn ebx-tn (frame-word-offset 2))
351       ;; Now we have to default the remaining args. Find out how many.
352       (inst sub eax-tn (fixnumize (- nvals register-arg-count)))
353       (inst neg eax-tn)
354       ;; If none, then just blow out of here.
355       (inst jmp :le restore-edi)
356       (inst mov ecx-tn eax-tn)
357       (inst shr ecx-tn word-shift)      ; word count
358       ;; Load EAX with NIL for fast storing.
359       (inst mov eax-tn nil-value)
360       ;; Do the store.
361       (emit-label default-stack-vals)
362       (inst rep)
363       (inst stos eax-tn)
364       ;; Restore EDI, and reset the stack.
365       (emit-label restore-edi)
366       (loadw edi-tn ebx-tn (frame-word-offset 1))
367       (inst mov esp-tn ebx-tn)
368       (inst cld))))
369   (values))
370 \f
371 ;;;; unknown values receiving
372
373 ;;; Emit code needed at the return point for an unknown-values call
374 ;;; for an arbitrary number of values.
375 ;;;
376 ;;; We do the single and non-single cases with no shared code: there
377 ;;; doesn't seem to be any potential overlap, and receiving a single
378 ;;; value is more important efficiency-wise.
379 ;;;
380 ;;; When there is a single value, we just push it on the stack,
381 ;;; returning the old SP and 1.
382 ;;;
383 ;;; When there is a variable number of values, we move all of the
384 ;;; argument registers onto the stack, and return ARGS and NARGS.
385 ;;;
386 ;;; ARGS and NARGS are TNs wired to the named locations. We must
387 ;;; explicitly allocate these TNs, since their lifetimes overlap with
388 ;;; the results start and count. (Also, it's nice to be able to target
389 ;;; them.)
390 (defun receive-unknown-values (args nargs start count)
391   (declare (type tn args nargs start count))
392   (let ((variable-values (gen-label))
393         (done (gen-label)))
394     (inst jmp :c variable-values)
395
396     (cond ((location= start (first *register-arg-tns*))
397            (inst push (first *register-arg-tns*))
398            (inst lea start (make-ea :dword :base esp-tn :disp 4)))
399           (t (inst mov start esp-tn)
400              (inst push (first *register-arg-tns*))))
401     (inst mov count (fixnumize 1))
402     (inst jmp done)
403
404     (emit-label variable-values)
405     ;; dtc: this writes the registers onto the stack even if they are
406     ;; not needed, only the number specified in ecx are used and have
407     ;; stack allocated to them. No harm is done.
408     (loop
409       for arg in *register-arg-tns*
410       for i downfrom -1
411       do (storew arg args i))
412     (move start args)
413     (move count nargs)
414
415     (emit-label done))
416   (values))
417
418 ;;; VOP that can be inherited by unknown values receivers. The main thing this
419 ;;; handles is allocation of the result temporaries.
420 (define-vop (unknown-values-receiver)
421   (:temporary (:sc descriptor-reg :offset ebx-offset
422                    :from :eval :to (:result 0))
423               values-start)
424   (:temporary (:sc any-reg :offset ecx-offset
425                :from :eval :to (:result 1))
426               nvals)
427   (:results (start :scs (any-reg control-stack))
428             (count :scs (any-reg control-stack))))
429 \f
430 ;;;; local call with unknown values convention return
431
432 ;;; Non-TR local call for a fixed number of values passed according to
433 ;;; the unknown values convention.
434 ;;;
435 ;;; FP is the frame pointer in install before doing the call.
436 ;;;
437 ;;; NFP would be the number-stack frame pointer if we had a separate
438 ;;; number stack.
439 ;;;
440 ;;; Args are the argument passing locations, which are specified only
441 ;;; to terminate their lifetimes in the caller.
442 ;;;
443 ;;; VALUES are the return value locations (wired to the standard
444 ;;; passing locations). NVALS is the number of values received.
445 ;;;
446 ;;; Save is the save info, which we can ignore since saving has been
447 ;;; done.
448 ;;;
449 ;;; TARGET is a continuation pointing to the start of the called
450 ;;; function.
451 (define-vop (call-local)
452   (:args (fp)
453          (nfp)
454          (args :more t))
455   (:results (values :more t))
456   (:save-p t)
457   (:move-args :local-call)
458   (:info arg-locs callee target nvals)
459   (:vop-var vop)
460   (:ignore nfp arg-locs args #+nil callee)
461   (:generator 5
462     (trace-table-entry trace-table-call-site)
463     (move ebp-tn fp)
464
465     (let ((ret-tn (callee-return-pc-tn callee)))
466       #+nil
467       (format t "*call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
468               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
469               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
470
471       ;; Is the return-pc on the stack or in a register?
472       (sc-case ret-tn
473         ((sap-stack)
474          #+nil (format t "*call-local: ret-tn on stack; offset=~S~%"
475                        (tn-offset ret-tn))
476          (storew (make-fixup nil :code-object return)
477                  ebp-tn (frame-word-offset (tn-offset ret-tn))))
478         ((sap-reg)
479          (inst lea ret-tn (make-fixup nil :code-object return)))))
480
481     (note-this-location vop :call-site)
482     (inst jmp target)
483     RETURN
484     (default-unknown-values vop values nvals)
485     (trace-table-entry trace-table-normal)))
486
487 ;;; Non-TR local call for a variable number of return values passed according
488 ;;; to the unknown values convention. The results are the start of the values
489 ;;; glob and the number of values received.
490 (define-vop (multiple-call-local unknown-values-receiver)
491   (:args (fp)
492          (nfp)
493          (args :more t))
494   (:save-p t)
495   (:move-args :local-call)
496   (:info save callee target)
497   (:ignore args save nfp #+nil callee)
498   (:vop-var vop)
499   (:generator 20
500     (trace-table-entry trace-table-call-site)
501     (move ebp-tn fp)
502
503     (let ((ret-tn (callee-return-pc-tn callee)))
504       #+nil
505       (format t "*multiple-call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
506               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
507               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
508
509       ;; Is the return-pc on the stack or in a register?
510       (sc-case ret-tn
511         ((sap-stack)
512          #+nil (format t "*multiple-call-local: ret-tn on stack; offset=~S~%"
513                        (tn-offset ret-tn))
514          ;; Stack
515          (storew (make-fixup nil :code-object return)
516                  ebp-tn (frame-word-offset (tn-offset ret-tn))))
517         ((sap-reg)
518          ;; Register
519          (inst lea ret-tn (make-fixup nil :code-object return)))))
520
521     (note-this-location vop :call-site)
522     (inst jmp target)
523     RETURN
524     (note-this-location vop :unknown-return)
525     (receive-unknown-values values-start nvals start count)
526     (trace-table-entry trace-table-normal)))
527 \f
528 ;;;; local call with known values return
529
530 ;;; Non-TR local call with known return locations. Known-value return
531 ;;; works just like argument passing in local call.
532 ;;;
533 ;;; Note: we can't use normal load-tn allocation for the fixed args,
534 ;;; since all registers may be tied up by the more operand. Instead,
535 ;;; we use MAYBE-LOAD-STACK-TN.
536 (define-vop (known-call-local)
537   (:args (fp)
538          (nfp)
539          (args :more t))
540   (:results (res :more t))
541   (:move-args :local-call)
542   (:save-p t)
543   (:info save callee target)
544   (:ignore args res save nfp #+nil callee)
545   (:vop-var vop)
546   (:generator 5
547     (trace-table-entry trace-table-call-site)
548     (move ebp-tn fp)
549
550     (let ((ret-tn (callee-return-pc-tn callee)))
551
552       #+nil
553       (format t "*known-call-local ~S; tn-kind ~S; tn-save-tn ~S; its tn-kind ~S~%"
554               ret-tn (sb!c::tn-kind ret-tn) (sb!c::tn-save-tn ret-tn)
555               (sb!c::tn-kind (sb!c::tn-save-tn ret-tn)))
556
557       ;; Is the return-pc on the stack or in a register?
558       (sc-case ret-tn
559         ((sap-stack)
560          #+nil (format t "*known-call-local: ret-tn on stack; offset=~S~%"
561                        (tn-offset ret-tn))
562          ;; Stack
563          (storew (make-fixup nil :code-object return)
564                  ebp-tn (frame-word-offset (tn-offset ret-tn))))
565         ((sap-reg)
566          ;; Register
567          (inst lea ret-tn (make-fixup nil :code-object return)))))
568
569     (note-this-location vop :call-site)
570     (inst jmp target)
571     RETURN
572     (note-this-location vop :known-return)
573     (trace-table-entry trace-table-normal)))
574 \f
575 ;;; Return from known values call. We receive the return locations as
576 ;;; arguments to terminate their lifetimes in the returning function. We
577 ;;; restore FP and CSP and jump to the Return-PC.
578 ;;;
579 ;;; We can assume we know exactly where old-fp and return-pc are because
580 ;;; make-old-fp-save-location and make-return-pc-save-location always
581 ;;; return the same place.
582 #+nil
583 (define-vop (known-return)
584   (:args (old-fp)
585          (return-pc :scs (any-reg immediate-stack) :target rpc)
586          (vals :more t))
587   (:move-args :known-return)
588   (:info val-locs)
589   (:temporary (:sc unsigned-reg :from (:argument 1)) rpc)
590   (:ignore val-locs vals)
591   (:vop-var vop)
592   (:generator 6
593     (trace-table-entry trace-table-fun-epilogue)
594     ;; Save the return-pc in a register 'cause the frame-pointer is
595     ;; going away. Note this not in the usual stack location so we
596     ;; can't use RET
597     (move rpc return-pc)
598     ;; Restore the stack.
599     (move esp-tn ebp-tn)
600     ;; Restore the old fp. We know OLD-FP is going to be in its stack
601     ;; save slot, which is a different frame that than this one,
602     ;; so we don't have to worry about having just cleared
603     ;; most of the stack.
604     (move ebp-tn old-fp)
605     (inst jmp rpc)
606     (trace-table-entry trace-table-normal)))
607 \f
608 ;;; From Douglas Crosher
609 ;;; Return from known values call. We receive the return locations as
610 ;;; arguments to terminate their lifetimes in the returning function. We
611 ;;; restore FP and CSP and jump to the Return-PC.
612 ;;;
613 ;;; The old-fp may be either in a register or on the stack in its
614 ;;; standard save locations - slot 0.
615 ;;;
616 ;;; The return-pc may be in a register or on the stack in any slot.
617 (define-vop (known-return)
618   (:args (old-fp)
619          (return-pc)
620          (vals :more t))
621   (:move-args :known-return)
622   (:info val-locs)
623   (:ignore val-locs vals)
624   (:vop-var vop)
625   (:generator 6
626     (trace-table-entry trace-table-fun-epilogue)
627
628     #+nil (format t "*known-return: old-fp ~S, tn-kind ~S; ~S ~S~%"
629                   old-fp (sb!c::tn-kind old-fp) (sb!c::tn-save-tn old-fp)
630                   (sb!c::tn-kind (sb!c::tn-save-tn old-fp)))
631
632     #+nil (format t "*known-return: return-pc ~S, tn-kind ~S; ~S ~S~%"
633                   return-pc (sb!c::tn-kind return-pc)
634                   (sb!c::tn-save-tn return-pc)
635                   (sb!c::tn-kind (sb!c::tn-save-tn return-pc)))
636
637     ;; return-pc may be either in a register or on the stack.
638     (sc-case return-pc
639       ((sap-reg)
640        (sc-case old-fp
641          ((control-stack)
642
643           #+nil (format t "*known-return: old-fp ~S on stack; offset=~S~%"
644                         old-fp (tn-offset old-fp))
645
646           (cond ((zerop (tn-offset old-fp))
647                  ;; Zot all of the stack except for the old-fp.
648                  (inst lea esp-tn (make-ea :dword :base ebp-tn
649                                            :disp (frame-byte-offset ocfp-save-offset)))
650                  ;; Restore the old fp from its save location on the stack,
651                  ;; and zot the stack.
652                  (inst pop ebp-tn))
653
654                 (t
655                  (cerror "Continue anyway"
656                          "VOP return-local doesn't work if old-fp (in slot ~
657                           ~S) is not in slot 0"
658                          (tn-offset old-fp)))))
659
660          ((any-reg descriptor-reg)
661           ;; Zot all the stack.
662           (move esp-tn ebp-tn)
663           ;; Restore the old-fp.
664           (move ebp-tn old-fp)))
665
666        ;; Return; return-pc is in a register.
667        (inst jmp return-pc))
668
669       ((sap-stack)
670
671        #+nil (format t "*known-return: return-pc ~S on stack; offset=~S~%"
672                      return-pc (tn-offset return-pc))
673
674        ;; Zot all of the stack except for the old-fp and return-pc.
675        (inst lea esp-tn
676              (make-ea :dword :base ebp-tn
677                       :disp (frame-byte-offset (tn-offset return-pc))))
678        ;; Restore the old fp. old-fp may be either on the stack in its
679        ;; save location or in a register, in either case this restores it.
680        (move ebp-tn old-fp)
681        ;; The return pops the return address (4 bytes), then we need
682        ;; to pop all the slots before the return-pc which includes the
683        ;; 4 bytes for the old-fp.
684        (inst ret (* (tn-offset return-pc) n-word-bytes))))
685
686     (trace-table-entry trace-table-normal)))
687 \f
688 ;;;; full call
689 ;;;
690 ;;; There is something of a cross-product effect with full calls.
691 ;;; Different versions are used depending on whether we know the
692 ;;; number of arguments or the name of the called function, and
693 ;;; whether we want fixed values, unknown values, or a tail call.
694 ;;;
695 ;;; In full call, the arguments are passed creating a partial frame on
696 ;;; the stack top and storing stack arguments into that frame. On
697 ;;; entry to the callee, this partial frame is pointed to by FP.
698
699 ;;; This macro helps in the definition of full call VOPs by avoiding
700 ;;; code replication in defining the cross-product VOPs.
701 ;;;
702 ;;; NAME is the name of the VOP to define.
703 ;;;
704 ;;; NAMED is true if the first argument is an fdefinition object whose
705 ;;; definition is to be called.
706 ;;;
707 ;;; RETURN is either :FIXED, :UNKNOWN or :TAIL:
708 ;;; -- If :FIXED, then the call is for a fixed number of values, returned in
709 ;;;    the standard passing locations (passed as result operands).
710 ;;; -- If :UNKNOWN, then the result values are pushed on the stack, and the
711 ;;;    result values are specified by the Start and Count as in the
712 ;;;    unknown-values continuation representation.
713 ;;; -- If :TAIL, then do a tail-recursive call. No values are returned.
714 ;;;    The Old-Fp and Return-PC are passed as the second and third arguments.
715 ;;;
716 ;;; In non-tail calls, the pointer to the stack arguments is passed as
717 ;;; the last fixed argument. If Variable is false, then the passing
718 ;;; locations are passed as a more arg. Variable is true if there are
719 ;;; a variable number of arguments passed on the stack. Variable
720 ;;; cannot be specified with :TAIL return. TR variable argument call
721 ;;; is implemented separately.
722 ;;;
723 ;;; In tail call with fixed arguments, the passing locations are
724 ;;; passed as a more arg, but there is no new-FP, since the arguments
725 ;;; have been set up in the current frame.
726 (macrolet ((define-full-call (name named return variable)
727             (aver (not (and variable (eq return :tail))))
728             `(define-vop (,name
729                           ,@(when (eq return :unknown)
730                               '(unknown-values-receiver)))
731                (:args
732                ,@(unless (eq return :tail)
733                    '((new-fp :scs (any-reg) :to (:argument 1))))
734
735                (fun :scs (descriptor-reg control-stack)
736                     :target eax :to (:argument 0))
737
738                ,@(when (eq return :tail)
739                    '((old-fp)
740                      (return-pc)))
741
742                ,@(unless variable '((args :more t :scs (descriptor-reg)))))
743
744                ,@(when (eq return :fixed)
745                '((:results (values :more t))))
746
747                (:save-p ,(if (eq return :tail) :compute-only t))
748
749                ,@(unless (or (eq return :tail) variable)
750                '((:move-args :full-call)))
751
752                (:vop-var vop)
753                (:info
754                ,@(unless (or variable (eq return :tail)) '(arg-locs))
755                ,@(unless variable '(nargs))
756                ,@(when (eq return :fixed) '(nvals))
757                step-instrumenting)
758
759                (:ignore
760                ,@(unless (or variable (eq return :tail)) '(arg-locs))
761                ,@(unless variable '(args)))
762
763                ;; We pass either the fdefn object (for named call) or
764                ;; the actual function object (for unnamed call) in
765                ;; EAX. With named call, closure-tramp will replace it
766                ;; with the real function and invoke the real function
767                ;; for closures. Non-closures do not need this value,
768                ;; so don't care what shows up in it.
769                (:temporary
770                (:sc descriptor-reg
771                     :offset eax-offset
772                     :from (:argument 0)
773                     :to :eval)
774                eax)
775
776                ;; We pass the number of arguments in ECX.
777                (:temporary (:sc unsigned-reg :offset ecx-offset :to :eval) ecx)
778
779                ;; With variable call, we have to load the
780                ;; register-args out of the (new) stack frame before
781                ;; doing the call. Therefore, we have to tell the
782                ;; lifetime stuff that we need to use them.
783                ,@(when variable
784                    (mapcar (lambda (name offset)
785                              `(:temporary (:sc descriptor-reg
786                                                :offset ,offset
787                                                :from (:argument 0)
788                                                :to :eval)
789                                           ,name))
790                            *register-arg-names* *register-arg-offsets*))
791
792                ,@(when (eq return :tail)
793                    '((:temporary (:sc unsigned-reg
794                                       :from (:argument 1)
795                                       :to (:argument 2))
796                                  old-fp-tmp)))
797
798                (:generator ,(+ (if named 5 0)
799                                (if variable 19 1)
800                                (if (eq return :tail) 0 10)
801                                15
802                                (if (eq return :unknown) 25 0))
803                (trace-table-entry trace-table-call-site)
804
805                ;; This has to be done before the frame pointer is
806                ;; changed! EAX stores the 'lexical environment' needed
807                ;; for closures.
808                (move eax fun)
809
810
811                ,@(if variable
812                      ;; For variable call, compute the number of
813                      ;; arguments and move some of the arguments to
814                      ;; registers.
815                      (collect ((noise))
816                               ;; Compute the number of arguments.
817                               (noise '(inst mov ecx new-fp))
818                               (noise '(inst sub ecx esp-tn))
819                               ;; Move the necessary args to registers,
820                               ;; this moves them all even if they are
821                               ;; not all needed.
822                               (loop
823                                for name in *register-arg-names*
824                                for index downfrom -1
825                                do (noise `(loadw ,name new-fp ,index)))
826                               (noise))
827                    '((if (zerop nargs)
828                          (inst xor ecx ecx)
829                        (inst mov ecx (fixnumize nargs)))))
830                ,@(cond ((eq return :tail)
831                         '(;; Python has figured out what frame we should
832                           ;; return to so might as well use that clue.
833                           ;; This seems really important to the
834                           ;; implementation of things like
835                           ;; (without-interrupts ...)
836                           ;;
837                           ;; dtc; Could be doing a tail call from a
838                           ;; known-local-call etc in which the old-fp
839                           ;; or ret-pc are in regs or in non-standard
840                           ;; places. If the passing location were
841                           ;; wired to the stack in standard locations
842                           ;; then these moves will be un-necessary;
843                           ;; this is probably best for the x86.
844                           (sc-case old-fp
845                                    ((control-stack)
846                                     (unless (= ocfp-save-offset
847                                                (tn-offset old-fp))
848                                       ;; FIXME: FORMAT T for stale
849                                       ;; diagnostic output (several of
850                                       ;; them around here), ick
851                                       (format t "** tail-call old-fp not S0~%")
852                                       (move old-fp-tmp old-fp)
853                                       (storew old-fp-tmp
854                                               ebp-tn
855                                               (frame-word-offset ocfp-save-offset))))
856                                    ((any-reg descriptor-reg)
857                                     (format t "** tail-call old-fp in reg not S0~%")
858                                     (storew old-fp
859                                             ebp-tn
860                                             (frame-word-offset ocfp-save-offset))))
861
862                           ;; For tail call, we have to push the
863                           ;; return-pc so that it looks like we CALLed
864                           ;; despite the fact that we are going to JMP.
865                           (inst push return-pc)
866                           ))
867                        (t
868                         ;; For non-tail call, we have to save our
869                         ;; frame pointer and install the new frame
870                         ;; pointer. We can't load stack tns after this
871                         ;; point.
872                         `(;; Python doesn't seem to allocate a frame
873                           ;; here which doesn't leave room for the
874                           ;; ofp/ret stuff.
875
876                           ;; The variable args are on the stack and
877                           ;; become the frame, but there may be <3
878                           ;; args and 3 stack slots are assumed
879                           ;; allocate on the call. So need to ensure
880                           ;; there are at least 3 slots. This hack
881                           ;; just adds 3 more.
882                           ,(if variable
883                                '(inst sub esp-tn (fixnumize 3)))
884
885                           ;; Save the fp
886                           (storew ebp-tn new-fp (frame-word-offset ocfp-save-offset))
887
888                           (move ebp-tn new-fp) ; NB - now on new stack frame.
889                           )))
890
891                (when step-instrumenting
892                  (emit-single-step-test)
893                  (inst jmp :eq DONE)
894                  (inst break single-step-around-trap))
895                DONE
896
897                (note-this-location vop :call-site)
898
899                (inst ,(if (eq return :tail) 'jmp 'call)
900                      ,(if named
901                           '(make-ea-for-object-slot eax fdefn-raw-addr-slot
902                                                     other-pointer-lowtag)
903                           '(make-ea-for-object-slot eax closure-fun-slot
904                                                     fun-pointer-lowtag)))
905                ,@(ecase return
906                    (:fixed
907                     '((default-unknown-values vop values nvals)))
908                    (:unknown
909                     '((note-this-location vop :unknown-return)
910                       (receive-unknown-values values-start nvals start count)))
911                    (:tail))
912                (trace-table-entry trace-table-normal)))))
913
914   (define-full-call call nil :fixed nil)
915   (define-full-call call-named t :fixed nil)
916   (define-full-call multiple-call nil :unknown nil)
917   (define-full-call multiple-call-named t :unknown nil)
918   (define-full-call tail-call nil :tail nil)
919   (define-full-call tail-call-named t :tail nil)
920
921   (define-full-call call-variable nil :fixed t)
922   (define-full-call multiple-call-variable nil :unknown t))
923
924 ;;; This is defined separately, since it needs special code that BLT's
925 ;;; the arguments down. All the real work is done in the assembly
926 ;;; routine. We just set things up so that it can find what it needs.
927 (define-vop (tail-call-variable)
928   (:args (args :scs (any-reg control-stack) :target esi)
929          (function :scs (descriptor-reg control-stack) :target eax)
930          (old-fp)
931          (ret-addr))
932   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 0)) esi)
933   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)) eax)
934 ;  (:ignore ret-addr old-fp)
935   (:generator 75
936     ;; Move these into the passing locations if they are not already there.
937     (move esi args)
938     (move eax function)
939
940     ;; The following assumes that the return-pc and old-fp are on the
941     ;; stack in their standard save locations - Check this.
942     (unless (and (sc-is old-fp control-stack)
943                  (= (tn-offset old-fp) ocfp-save-offset))
944             (error "tail-call-variable: ocfp not on stack in standard save location?"))
945     (unless (and (sc-is ret-addr sap-stack)
946                  (= (tn-offset ret-addr) return-pc-save-offset))
947             (error "tail-call-variable: ret-addr not on stack in standard save location?"))
948
949
950     ;; And jump to the assembly routine.
951     (inst jmp (make-fixup 'tail-call-variable :assembly-routine))))
952 \f
953 ;;;; unknown values return
954
955 ;;; Return a single-value using the Unknown-Values convention. Specifically,
956 ;;; we jump to clear the stack and jump to return-pc+2.
957 ;;;
958 ;;; We require old-fp to be in a register, because we want to reset ESP before
959 ;;; restoring EBP. If old-fp were still on the stack, it could get clobbered
960 ;;; by a signal.
961 ;;;
962 ;;; pfw--get wired-tn conflicts sometimes if register sc specd for args
963 ;;; having problems targeting args to regs -- using temps instead.
964 ;;;
965 ;;; First off, modifying the return-pc defeats the branch-prediction
966 ;;; optimizations on modern CPUs quite handily. Second, we can do all
967 ;;; this without needing a temp register. Fixed the latter, at least.
968 ;;; -- AB 2006/Feb/04
969 (define-vop (return-single)
970   (:args (old-fp)
971          (return-pc)
972          (value))
973   (:ignore value)
974   (:generator 6
975     (trace-table-entry trace-table-fun-epilogue)
976     ;; Code structure lifted from known-return.
977     (sc-case return-pc
978       ((sap-reg)
979        ;; return PC in register for some reason (local call?)
980        ;; we jmp to the return pc after fixing the stack and frame.
981        (sc-case old-fp
982          ((control-stack)
983           ;; ofp on stack must be in slot 0 (the traditional storage place).
984           ;; Drop the stack above it and pop it off.
985           (cond ((zerop (tn-offset old-fp))
986                  (inst lea esp-tn (make-ea :dword :base ebp-tn
987                                            :disp (frame-byte-offset ocfp-save-offset)))
988                  (inst pop ebp-tn))
989                 (t
990                  ;; Should this ever happen, we do the same as above, but
991                  ;; using (tn-offset old-fp) instead of ocfp-save-offset
992                  ;; (which is 0 anyway, see src/compiler/x86/vm.lisp) and
993                  ;; then lea esp again against itself with a displacement
994                  ;; of (* (tn-offset old-fp) n-word-bytes) to clear the
995                  ;; rest of the stack.
996                  (cerror "Continue anyway"
997                          "VOP return-single doesn't work if old-fp (in slot ~S) is not in slot 0" (tn-offset old-fp)))))
998          ((any-reg descriptor-reg)
999           ;; ofp in reg, drop the stack and load the real fp.
1000           (move esp-tn ebp-tn)
1001           (move ebp-tn old-fp)))
1002
1003        ;; Set single-value-return flag
1004        (inst clc)
1005        ;; And return
1006        (inst jmp return-pc))
1007
1008       ((sap-stack)
1009        ;; Note that this will only work right if, when old-fp is on
1010        ;; the stack, it has a lower tn-offset than return-pc. One of
1011        ;; the comments in known-return indicate that this is the case
1012        ;; (in that it will be in its save location), but we may wish
1013        ;; to assert that (in either the weaker or stronger forms).
1014        ;; Should this ever not be the case, we should load old-fp
1015        ;; into a temp reg while we fix the stack.
1016        ;; Drop stack above return-pc
1017        (inst lea esp-tn (make-ea :dword :base ebp-tn
1018                                  :disp (frame-byte-offset (tn-offset return-pc))))
1019        ;; Set single-value return flag
1020        (inst clc)
1021        ;; Restore the old frame pointer
1022        (move ebp-tn old-fp)
1023        ;; And return, dropping the rest of the stack as we go.
1024        (inst ret (* (tn-offset return-pc) n-word-bytes))))))
1025
1026 ;;; Do unknown-values return of a fixed (other than 1) number of
1027 ;;; values. The VALUES are required to be set up in the standard
1028 ;;; passing locations. NVALS is the number of values returned.
1029 ;;;
1030 ;;; Basically, we just load ECX with the number of values returned and
1031 ;;; EBX with a pointer to the values, set ESP to point to the end of
1032 ;;; the values, and jump directly to return-pc.
1033 (define-vop (return)
1034   (:args (old-fp)
1035          (return-pc :to (:eval 1))
1036          (values :more t))
1037   (:ignore values)
1038   (:info nvals)
1039
1040   ;; In the case of other than one value, we need these registers to
1041   ;; tell the caller where they are and how many there are.
1042   (:temporary (:sc unsigned-reg :offset ebx-offset) ebx)
1043   (:temporary (:sc unsigned-reg :offset ecx-offset) ecx)
1044
1045   ;; We need to stretch the lifetime of return-pc past the argument
1046   ;; registers so that we can default the argument registers without
1047   ;; trashing return-pc.
1048   (:temporary (:sc unsigned-reg :offset (first *register-arg-offsets*)
1049                    :from :eval) a0)
1050   (:temporary (:sc unsigned-reg :offset (second *register-arg-offsets*)
1051                    :from :eval) a1)
1052   (:temporary (:sc unsigned-reg :offset (third *register-arg-offsets*)
1053                    :from :eval) a2)
1054
1055   (:generator 6
1056     (trace-table-entry trace-table-fun-epilogue)
1057     ;; Establish the values pointer and values count.
1058     (move ebx ebp-tn)
1059     (if (zerop nvals)
1060         (inst xor ecx ecx) ; smaller
1061       (inst mov ecx (fixnumize nvals)))
1062     ;; Restore the frame pointer.
1063     (move ebp-tn old-fp)
1064     ;; Clear as much of the stack as possible, but not past the return
1065     ;; address.
1066     (inst lea esp-tn (make-ea :dword :base ebx
1067                               :disp (- (* (max nvals 2) n-word-bytes))))
1068     ;; Pre-default any argument register that need it.
1069     (when (< nvals register-arg-count)
1070       (let* ((arg-tns (nthcdr nvals (list a0 a1 a2)))
1071              (first (first arg-tns)))
1072         (inst mov first nil-value)
1073         (dolist (tn (cdr arg-tns))
1074           (inst mov tn first))))
1075     ;; Set multi-value return flag.
1076     (inst stc)
1077     ;; And away we go. Except that return-pc is still on the
1078     ;; stack and we've changed the stack pointer. So we have to
1079     ;; tell it to index off of EBX instead of EBP.
1080     (cond ((zerop nvals)
1081            ;; Return popping the return address and the OCFP.
1082            (inst ret n-word-bytes))
1083           ((= nvals 1)
1084            ;; Return popping the return, leaving 1 slot. Can this
1085            ;; happen, or is a single value return handled elsewhere?
1086            (inst ret))
1087           (t
1088            (inst jmp (make-ea :dword :base ebx
1089                               :disp (frame-byte-offset (tn-offset return-pc))))))
1090
1091     (trace-table-entry trace-table-normal)))
1092
1093 ;;; Do unknown-values return of an arbitrary number of values (passed
1094 ;;; on the stack.) We check for the common case of a single return
1095 ;;; value, and do that inline using the normal single value return
1096 ;;; convention. Otherwise, we branch off to code that calls an
1097 ;;; assembly-routine.
1098 ;;;
1099 ;;; The assembly routine takes the following args:
1100 ;;;  EAX -- the return-pc to finally jump to.
1101 ;;;  EBX -- pointer to where to put the values.
1102 ;;;  ECX -- number of values to find there.
1103 ;;;  ESI -- pointer to where to find the values.
1104 (define-vop (return-multiple)
1105   (:args (old-fp :to (:eval 1) :target old-fp-temp)
1106          (return-pc :target eax)
1107          (vals :scs (any-reg) :target esi)
1108          (nvals :scs (any-reg) :target ecx))
1109
1110   (:temporary (:sc unsigned-reg :offset eax-offset :from (:argument 1)) eax)
1111   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 2)) esi)
1112   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 3)) ecx)
1113   (:temporary (:sc unsigned-reg :offset ebx-offset :from (:eval 0)) ebx)
1114   (:temporary (:sc descriptor-reg :offset (first *register-arg-offsets*)
1115                    :from (:eval 0)) a0)
1116   (:temporary (:sc unsigned-reg :from (:eval 1)) old-fp-temp)
1117   (:node-var node)
1118
1119   (:generator 13
1120     (trace-table-entry trace-table-fun-epilogue)
1121     ;; Load the return-pc.
1122     (move eax return-pc)
1123     (unless (policy node (> space speed))
1124       ;; Check for the single case.
1125       (let ((not-single (gen-label)))
1126         (inst cmp nvals (fixnumize 1))
1127         (inst jmp :ne not-single)
1128
1129         ;; Return with one value.
1130         (loadw a0 vals -1)
1131         ;; Clear the stack. We load old-fp into a register before clearing
1132         ;; the stack.
1133         (move old-fp-temp old-fp)
1134         (move esp-tn ebp-tn)
1135         (move ebp-tn old-fp-temp)
1136         ;; Set the single-value return flag.
1137         (inst clc)
1138         ;; Out of here.
1139         (inst jmp eax)
1140
1141         ;; Nope, not the single case. Jump to the assembly routine.
1142         (emit-label not-single)))
1143     (move esi vals)
1144     (move ecx nvals)
1145     (move ebx ebp-tn)
1146     (move ebp-tn old-fp)
1147     (inst jmp (make-fixup 'return-multiple :assembly-routine))
1148     (trace-table-entry trace-table-normal)))
1149 \f
1150 ;;;; XEP hackery
1151
1152 ;;; We don't need to do anything special for regular functions.
1153 (define-vop (setup-environment)
1154   (:info label)
1155   (:ignore label)
1156   (:generator 0
1157     ;; Don't bother doing anything.
1158     nil))
1159
1160 ;;; Get the lexical environment from its passing location.
1161 (define-vop (setup-closure-environment)
1162   (:results (closure :scs (descriptor-reg)))
1163   (:info label)
1164   (:ignore label)
1165   (:generator 6
1166     ;; Get result.
1167     (move closure eax-tn)))
1168
1169 ;;; Copy a &MORE arg from the argument area to the end of the current
1170 ;;; frame. FIXED is the number of non-&MORE arguments.
1171 ;;;
1172 ;;; The tricky part is doing this without trashing any of the calling
1173 ;;; convention registers that are still needed. This vop is emitted
1174 ;;; directly after the xep-allocate frame. That means the registers
1175 ;;; are in use as follows:
1176 ;;;
1177 ;;;  EAX -- The lexenv.
1178 ;;;  EBX -- Available.
1179 ;;;  ECX -- The total number of arguments.
1180 ;;;  EDX -- The first arg.
1181 ;;;  EDI -- The second arg.
1182 ;;;  ESI -- The third arg.
1183 ;;;
1184 ;;; So basically, we have one register available for our use: EBX.
1185 ;;;
1186 ;;; What we can do is push the other regs onto the stack, and then
1187 ;;; restore their values by looking directly below where we put the
1188 ;;; more-args.
1189 (define-vop (copy-more-arg)
1190   (:info fixed)
1191   (:generator 20
1192     ;; Avoid the copy if there are no more args.
1193     (cond ((zerop fixed)
1194            (inst jecxz just-alloc-frame))
1195           (t
1196            (inst cmp ecx-tn (fixnumize fixed))
1197            (inst jmp :be just-alloc-frame)))
1198
1199     ;; Allocate the space on the stack.
1200     ;; stack = ebp - (max 3 frame-size) - (nargs - fixed)
1201     (inst lea ebx-tn
1202           (make-ea :dword :base ebp-tn
1203                    :disp (- (fixnumize fixed)
1204                             (* n-word-bytes
1205                                (max 3 (sb-allocated-size 'stack))))))
1206     (inst sub ebx-tn ecx-tn)  ; Got the new stack in ebx
1207     (inst mov esp-tn ebx-tn)
1208
1209     ;; Now: nargs>=1 && nargs>fixed
1210
1211     ;; Save the original count of args.
1212     (inst mov ebx-tn ecx-tn)
1213
1214     (cond ((< fixed register-arg-count)
1215            ;; We must stop when we run out of stack args, not when we
1216            ;; run out of more args.
1217            ;; Number to copy = nargs-3
1218            (inst sub ecx-tn (fixnumize register-arg-count))
1219            ;; Everything of interest in registers.
1220            (inst jmp :be do-regs))
1221           (t
1222            ;; Number to copy = nargs-fixed
1223            (inst sub ecx-tn (fixnumize fixed))))
1224
1225     ;; Save edi and esi register args.
1226     (inst push edi-tn)
1227     (inst push esi-tn)
1228     (inst push ebx-tn)
1229     ;; Okay, we have pushed the register args. We can trash them
1230     ;; now.
1231
1232     ;; Initialize src to be end of args.
1233     (inst mov esi-tn ebp-tn)
1234     (inst sub esi-tn ebx-tn)
1235
1236     ;; We need to copy from downwards up to avoid overwriting some of
1237     ;; the yet uncopied args. So we need to use EBX as the copy index
1238     ;; and ECX as the loop counter, rather than using ECX for both.
1239     (inst xor ebx-tn ebx-tn)
1240
1241     ;; We used to use REP MOVS here, but on modern x86 it performs
1242     ;; much worse than an explicit loop for small blocks.
1243     COPY-LOOP
1244     (inst mov edi-tn (make-ea :dword :base esi-tn :index ebx-tn))
1245     ;; The :DISP is to account for the registers saved on the stack
1246     (inst mov (make-ea :dword :base esp-tn :disp (* 3 n-word-bytes)
1247                        :index ebx-tn)
1248           edi-tn)
1249     (inst add ebx-tn n-word-bytes)
1250     (inst sub ecx-tn n-word-bytes)
1251     (inst jmp :nz COPY-LOOP)
1252
1253     ;; So now we need to restore EDI and ESI.
1254     (inst pop ebx-tn)
1255     (inst pop esi-tn)
1256     (inst pop edi-tn)
1257
1258     DO-REGS
1259
1260     ;; Restore ECX
1261     (inst mov ecx-tn ebx-tn)
1262
1263     ;; Here: nargs>=1 && nargs>fixed
1264     (when (< fixed register-arg-count)
1265           ;; Now we have to deposit any more args that showed up in
1266           ;; registers.
1267           (do ((i fixed))
1268               ( nil )
1269               ;; Store it relative to ebp
1270               (inst mov (make-ea :dword :base ebp-tn
1271                                  :disp (- (* 4
1272                                              (+ 1 (- i fixed)
1273                                                 (max 3 (sb-allocated-size 'stack))))))
1274                     (nth i *register-arg-tns*))
1275
1276               (incf i)
1277               (when (>= i register-arg-count)
1278                     (return))
1279
1280               ;; Don't deposit any more than there are.
1281               (if (zerop i)
1282                   (inst test ecx-tn ecx-tn)
1283                 (inst cmp ecx-tn (fixnumize i)))
1284               (inst jmp :eq done)))
1285
1286     (inst jmp done)
1287
1288     JUST-ALLOC-FRAME
1289     (inst lea esp-tn
1290           (make-ea :dword :base ebp-tn
1291                    :disp (- (* n-word-bytes
1292                                (max 3 (sb-allocated-size 'stack))))))
1293
1294     DONE))
1295
1296 (define-vop (more-kw-arg)
1297   (:translate sb!c::%more-kw-arg)
1298   (:policy :fast-safe)
1299   (:args (object :scs (descriptor-reg) :to (:result 1))
1300          (index :scs (any-reg immediate) :to (:result 1) :target keyword))
1301   (:arg-types * tagged-num)
1302   (:results (value :scs (descriptor-reg any-reg))
1303             (keyword :scs (descriptor-reg any-reg)))
1304   (:result-types * *)
1305   (:generator 4
1306     (sc-case index
1307       (immediate
1308        (inst mov value (make-ea :dword :base object :disp (tn-value index)))
1309        (inst mov keyword (make-ea :dword :base object
1310                                   :disp (+ (tn-value index) n-word-bytes))))
1311       (t
1312        (inst mov value (make-ea :dword :base object :index index))
1313        (inst mov keyword (make-ea :dword :base object :index index
1314                                   :disp n-word-bytes))))))
1315
1316 (define-vop (more-arg)
1317     (:translate sb!c::%more-arg)
1318   (:policy :fast-safe)
1319   (:args (object :scs (descriptor-reg) :to (:result 1))
1320          (index :scs (any-reg) :to (:result 1) :target value))
1321   (:arg-types * tagged-num)
1322   (:results (value :scs (descriptor-reg any-reg)))
1323   (:result-types *)
1324   (:generator 4
1325     (move value index)
1326     (inst neg value)
1327     (inst mov value (make-ea :dword :base object :index value))))
1328
1329 ;;; Turn more arg (context, count) into a list.
1330 (define-vop (listify-rest-args)
1331   (:translate %listify-rest-args)
1332   (:policy :safe)
1333   (:args (context :scs (descriptor-reg) :target src)
1334          (count :scs (any-reg) :target ecx))
1335   (:arg-types * tagged-num)
1336   (:temporary (:sc unsigned-reg :offset esi-offset :from (:argument 0)) src)
1337   (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 1)) ecx)
1338   (:temporary (:sc unsigned-reg :offset eax-offset) eax)
1339   (:temporary (:sc unsigned-reg) dst)
1340   (:results (result :scs (descriptor-reg)))
1341   (:node-var node)
1342   (:generator 20
1343     (let ((enter (gen-label))
1344           (loop (gen-label))
1345           (done (gen-label))
1346           (stack-allocate-p (node-stack-allocate-p node)))
1347       (move src context)
1348       (move ecx count)
1349       ;; Check to see whether there are no args, and just return NIL if so.
1350       (inst mov result nil-value)
1351       (inst jecxz done)
1352       (inst lea dst (make-ea :dword :base ecx :index ecx))
1353       (maybe-pseudo-atomic stack-allocate-p
1354        (allocation dst dst node stack-allocate-p list-pointer-lowtag)
1355        (inst shr ecx 2)
1356        ;; Set decrement mode (successive args at lower addresses)
1357        (inst std)
1358        ;; Set up the result.
1359        (move result dst)
1360        ;; Jump into the middle of the loop, 'cause that's were we want
1361        ;; to start.
1362        (inst jmp enter)
1363        (emit-label loop)
1364        ;; Compute a pointer to the next cons.
1365        (inst add dst (* cons-size n-word-bytes))
1366        ;; Store a pointer to this cons in the CDR of the previous cons.
1367        (storew dst dst -1 list-pointer-lowtag)
1368        (emit-label enter)
1369        ;; Grab one value and stash it in the car of this cons.
1370        (inst lods eax)
1371        (storew eax dst 0 list-pointer-lowtag)
1372        ;; Go back for more.
1373        (inst sub ecx 1)
1374        (inst jmp :nz loop)
1375        ;; NIL out the last cons.
1376        (storew nil-value dst 1 list-pointer-lowtag)
1377        (inst cld))
1378       (emit-label done))))
1379
1380 ;;; Return the location and size of the &MORE arg glob created by
1381 ;;; COPY-MORE-ARG. SUPPLIED is the total number of arguments supplied
1382 ;;; (originally passed in ECX). FIXED is the number of non-rest
1383 ;;; arguments.
1384 ;;;
1385 ;;; We must duplicate some of the work done by COPY-MORE-ARG, since at
1386 ;;; that time the environment is in a pretty brain-damaged state,
1387 ;;; preventing this info from being returned as values. What we do is
1388 ;;; compute supplied - fixed, and return a pointer that many words
1389 ;;; below the current stack top.
1390 (define-vop (more-arg-context)
1391   (:policy :fast-safe)
1392   (:translate sb!c::%more-arg-context)
1393   (:args (supplied :scs (any-reg) :target count))
1394   (:arg-types positive-fixnum (:constant fixnum))
1395   (:info fixed)
1396   (:results (context :scs (descriptor-reg))
1397             (count :scs (any-reg)))
1398   (:result-types t tagged-num)
1399   (:note "more-arg-context")
1400   (:generator 5
1401     (move count supplied)
1402     ;; SP at this point points at the last arg pushed.
1403     ;; Point to the first more-arg, not above it.
1404     (inst lea context (make-ea :dword :base esp-tn
1405                                :index count :scale 1
1406                                :disp (- (+ (fixnumize fixed) 4))))
1407     (unless (zerop fixed)
1408       (inst sub count (fixnumize fixed)))))
1409
1410 ;;; Signal wrong argument count error if NARGS isn't equal to COUNT.
1411 (define-vop (verify-arg-count)
1412   (:policy :fast-safe)
1413   (:translate sb!c::%verify-arg-count)
1414   (:args (nargs :scs (any-reg)))
1415   (:arg-types positive-fixnum (:constant t))
1416   (:info count)
1417   (:vop-var vop)
1418   (:save-p :compute-only)
1419   (:generator 3
1420     (let ((err-lab
1421            (generate-error-code vop 'invalid-arg-count-error nargs)))
1422       (if (zerop count)
1423           (inst test nargs nargs)  ; smaller instruction
1424         (inst cmp nargs (fixnumize count)))
1425       (inst jmp :ne err-lab))))
1426
1427 ;;; Various other error signallers.
1428 (macrolet ((def (name error translate &rest args)
1429              `(define-vop (,name)
1430                 ,@(when translate
1431                     `((:policy :fast-safe)
1432                       (:translate ,translate)))
1433                 (:args ,@(mapcar (lambda (arg)
1434                                    `(,arg :scs (any-reg descriptor-reg)))
1435                                  args))
1436                 (:vop-var vop)
1437                 (:save-p :compute-only)
1438                 (:generator 1000
1439                   (error-call vop ',error ,@args)))))
1440   (def arg-count-error invalid-arg-count-error
1441     sb!c::%arg-count-error nargs)
1442   (def type-check-error object-not-type-error sb!c::%type-check-error
1443     object type)
1444   (def layout-invalid-error layout-invalid-error sb!c::%layout-invalid-error
1445     object layout)
1446   (def odd-key-args-error odd-key-args-error
1447     sb!c::%odd-key-args-error)
1448   (def unknown-key-arg-error unknown-key-arg-error
1449     sb!c::%unknown-key-arg-error key)
1450   (def nil-fun-returned-error nil-fun-returned-error nil fun))
1451
1452 ;;; Single-stepping
1453
1454 (defun emit-single-step-test ()
1455   ;; We use different ways of representing whether stepping is on on
1456   ;; +SB-THREAD / -SB-THREAD: on +SB-THREAD, we use a slot in the
1457   ;; thread structure. On -SB-THREAD we use the value of a static
1458   ;; symbol. Things are done this way, since reading a thread-local
1459   ;; slot from a symbol would require an extra register on +SB-THREAD,
1460   ;; and reading a slot from a thread structure would require an extra
1461   ;; register on -SB-THREAD.
1462   #!+sb-thread
1463   (progn
1464     (inst cmp (make-ea :dword
1465                        :disp (* thread-stepping-slot n-word-bytes))
1466           nil-value :fs))
1467   #!-sb-thread
1468   (inst cmp (make-ea-for-symbol-value sb!impl::*stepping*)
1469         nil-value))
1470
1471 (define-vop (step-instrument-before-vop)
1472   (:policy :fast-safe)
1473   (:vop-var vop)
1474   (:generator 3
1475      (emit-single-step-test)
1476      (inst jmp :eq DONE)
1477      (inst break single-step-before-trap)
1478      DONE
1479      (note-this-location vop :step-before-vop)))