0.8.9.10:
[sbcl.git] / src / compiler / sparc / call.lisp
1 ;;;; the VM definition of function call for the Sparc
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
14 \f
15 ;;;; Interfaces to IR2 conversion:
16
17 ;;; Return a wired TN describing the N'th full call argument passing
18 ;;; location.
19 (!def-vm-support-routine standard-arg-location (n)
20   (declare (type unsigned-byte n))
21   (if (< n register-arg-count)
22       (make-wired-tn *backend-t-primitive-type* register-arg-scn
23                      (elt *register-arg-offsets* n))
24       (make-wired-tn *backend-t-primitive-type* control-stack-arg-scn n)))
25
26
27 ;;; Make a passing location TN for a local call return PC.  If
28 ;;; standard is true, then use the standard (full call) location,
29 ;;; otherwise use any legal location.  Even in the non-standard case,
30 ;;; this may be restricted by a desire to use a subroutine call
31 ;;; instruction.
32 (!def-vm-support-routine make-return-pc-passing-location (standard)
33   (if standard
34       (make-wired-tn *backend-t-primitive-type* register-arg-scn lra-offset)
35       (make-restricted-tn *backend-t-primitive-type* register-arg-scn)))
36
37 ;;; This is similar to MAKE-RETURN-PC-PASSING-LOCATION, but makes a
38 ;;; location to pass OLD-FP in. This is (obviously) wired in the
39 ;;; standard convention, but is totally unrestricted in non-standard
40 ;;; conventions, since we can always fetch it off of the stack using
41 ;;; the arg pointer.
42 (!def-vm-support-routine make-old-fp-passing-location (standard)
43   (if standard
44       (make-wired-tn *fixnum-primitive-type* immediate-arg-scn ocfp-offset)
45       (make-normal-tn *fixnum-primitive-type*)))
46
47 ;;; Make the TNs used to hold Old-FP and Return-PC within the current
48 ;;; function.  We treat these specially so that the debugger can find
49 ;;; them at a known location.
50 (!def-vm-support-routine make-old-fp-save-location (env)
51   (specify-save-tn
52    (physenv-debug-live-tn (make-normal-tn *fixnum-primitive-type*) env)
53    (make-wired-tn *fixnum-primitive-type*
54                   control-stack-arg-scn
55                   ocfp-save-offset)))
56
57 (!def-vm-support-routine make-return-pc-save-location (env)
58   (specify-save-tn
59    (physenv-debug-live-tn (make-normal-tn *backend-t-primitive-type*) env)
60    (make-wired-tn *backend-t-primitive-type*
61                   control-stack-arg-scn
62                   lra-save-offset)))
63
64 ;;; Make a TN for the standard argument count passing location.  We
65 ;;; only need to make the standard location, since a count is never
66 ;;; passed when we are using non-standard conventions.
67 (!def-vm-support-routine make-arg-count-location ()
68   (make-wired-tn *fixnum-primitive-type* immediate-arg-scn nargs-offset))
69
70
71 ;;; Make a TN to hold the number-stack frame pointer.  This is
72 ;;; allocated once per component, and is component-live.
73 (!def-vm-support-routine make-nfp-tn ()
74   (component-live-tn
75    (make-wired-tn *fixnum-primitive-type* immediate-arg-scn nfp-offset)))
76
77 (!def-vm-support-routine make-stack-pointer-tn ()
78   (make-normal-tn *fixnum-primitive-type*))
79
80 (!def-vm-support-routine make-number-stack-pointer-tn ()
81   (make-normal-tn *fixnum-primitive-type*))
82
83 ;;; Return a list of TNs that can be used to represent an
84 ;;; unknown-values continuation within a function.
85 (!def-vm-support-routine make-unknown-values-locations ()
86   (list (make-stack-pointer-tn)
87         (make-normal-tn *fixnum-primitive-type*)))
88
89
90 ;;; This function is called by the ENTRY-ANALYZE phase, allowing
91 ;;; VM-dependent initialization of the IR2-COMPONENT structure.  We push
92 ;;; placeholder entries in the CONSTANTS to leave room for additional
93 ;;; noise in the code object header.
94 (!def-vm-support-routine select-component-format (component)
95   (declare (type component component))
96   (dotimes (i code-constants-offset)
97     (vector-push-extend nil
98                         (ir2-component-constants (component-info component))))
99   (values))
100 \f
101 ;;;; Frame hackery:
102
103 ;;; Return the number of bytes needed for the current non-descriptor
104 ;;; stack frame.  Non-descriptor stack frames must be multiples of 8
105 ;;; bytes on the PMAX.
106 (defun bytes-needed-for-non-descriptor-stack-frame ()
107   (* (logandc2 (1+ (sb-allocated-size 'non-descriptor-stack)) 1)
108      n-word-bytes))
109
110 ;;; Used for setting up the Old-FP in local call.
111 (define-vop (current-fp)
112   (:results (val :scs (any-reg)))
113   (:generator 1
114     (move val cfp-tn)))
115
116 ;;; Used for computing the caller's NFP for use in known-values return.  Only
117 ;;; works assuming there is no variable size stuff on the nstack.
118 ;;;
119 (define-vop (compute-old-nfp)
120   (:results (val :scs (any-reg)))
121   (:vop-var vop)
122   (:generator 1
123     (let ((nfp (current-nfp-tn vop)))
124       (when nfp
125         (inst add val nfp (bytes-needed-for-non-descriptor-stack-frame))))))
126
127
128 (define-vop (xep-allocate-frame)
129   (:info start-lab copy-more-arg-follows)
130   (:ignore copy-more-arg-follows)
131   (:vop-var vop)
132   (:temporary (:scs (non-descriptor-reg)) temp)
133   (:generator 1
134     ;; Make sure the function is aligned, and drop a label pointing to this
135     ;; function header.
136     (align n-lowtag-bits)
137     (trace-table-entry trace-table-fun-prologue)
138     (emit-label start-lab)
139     ;; Allocate function header.
140     (inst simple-fun-header-word)
141     (dotimes (i (1- simple-fun-code-offset))
142       (inst word 0))
143     ;; The start of the actual code.
144     ;; Fix CODE, cause the function object was passed in.
145     (inst compute-code-from-fn code-tn code-tn start-lab temp)
146     ;; Build our stack frames.
147     (inst add csp-tn cfp-tn
148           (* n-word-bytes (sb-allocated-size 'control-stack)))
149     (let ((nfp-tn (current-nfp-tn vop)))
150       (when nfp-tn
151         (inst sub nsp-tn (bytes-needed-for-non-descriptor-stack-frame))
152         (inst add nfp-tn nsp-tn number-stack-displacement)))
153     (trace-table-entry trace-table-normal)))
154
155 (define-vop (allocate-frame)
156   (:results (res :scs (any-reg))
157             (nfp :scs (any-reg)))
158   (:info callee)
159   (:generator 2
160     (trace-table-entry trace-table-fun-prologue)
161     (move res csp-tn)
162     (inst add csp-tn csp-tn
163           (* n-word-bytes (sb-allocated-size 'control-stack)))
164     (when (ir2-physenv-number-stack-p callee)
165       (inst sub nsp-tn (bytes-needed-for-non-descriptor-stack-frame))
166       (inst add nfp nsp-tn number-stack-displacement))
167     (trace-table-entry trace-table-normal)))
168
169 ;;; Allocate a partial frame for passing stack arguments in a full call.  Nargs
170 ;;; is the number of arguments passed.  If no stack arguments are passed, then
171 ;;; we don't have to do anything.
172 ;;;
173 (define-vop (allocate-full-call-frame)
174   (:info nargs)
175   (:results (res :scs (any-reg)))
176   (:generator 2
177     (when (> nargs register-arg-count)
178       (move res csp-tn)
179       (inst add csp-tn csp-tn (* nargs n-word-bytes)))))
180
181
182
183 \f
184 ;;; Emit code needed at the return-point from an unknown-values call
185 ;;; for a fixed number of values.  Values is the head of the TN-REF
186 ;;; list for the locations that the values are to be received into.
187 ;;; Nvals is the number of values that are to be received (should
188 ;;; equal the length of Values).
189 ;;;
190 ;;; Move-Temp is a Descriptor-Reg TN used as a temporary.
191 ;;;
192 ;;; This code exploits the fact that in the unknown-values convention,
193 ;;; a single value return returns at the return PC + 8, whereas a
194 ;;; return of other than one value returns directly at the return PC.
195 ;;;
196 ;;; If 0 or 1 values are expected, then we just emit an instruction to
197 ;;; reset the SP (which will only be executed when other than 1 value
198 ;;; is returned.)
199 ;;;
200 ;;; In the general case, we have to do three things:
201 ;;;  -- Default unsupplied register values.  This need only be done when a
202 ;;;     single value is returned, since register values are defaulted by the
203 ;;;     called in the non-single case.
204 ;;;  -- Default unsupplied stack values.  This needs to be done whenever there
205 ;;;     are stack values.
206 ;;;  -- Reset SP.  This must be done whenever other than 1 value is returned,
207 ;;;     regardless of the number of values desired.
208 ;;;
209 ;;; The general-case code looks like this:
210 #|
211         b regs-defaulted                ; Skip if MVs
212         nop
213
214         move a1 null-tn                 ; Default register values
215         ...
216         loadi nargs 1                   ; Force defaulting of stack values
217         move old-fp csp                 ; Set up args for SP resetting
218
219 regs-defaulted
220         subcc temp nargs register-arg-count
221
222         b :lt default-value-7   ; jump to default code
223         loadw move-temp ocfp-tn 6       ; Move value to correct location.
224         subcc temp 1
225         store-stack-tn val4-tn move-temp
226
227         b :lt default-value-8
228         loadw move-temp ocfp-tn 7
229         subcc temp 1
230         store-stack-tn val5-tn move-temp
231
232         ...
233
234 defaulting-done
235         move csp ocfp                   ; Reset SP.
236 <end of code>
237
238 <elsewhere>
239 default-value-7
240         store-stack-tn val4-tn null-tn  ; Nil out 7'th value. (first on stack)
241
242 default-value-8
243         store-stack-tn val5-tn null-tn  ; Nil out 8'th value.
244
245         ...
246
247         br defaulting-done
248         nop
249 |#
250 (defun default-unknown-values (vop values nvals move-temp temp lra-label)
251   (declare (type (or tn-ref null) values)
252            (type unsigned-byte nvals) (type tn move-temp temp))
253   (if (<= nvals 1)
254       (progn
255         (without-scheduling ()
256           (note-this-location vop :single-value-return)
257           (move csp-tn ocfp-tn)
258           (inst nop))
259         (inst compute-code-from-lra code-tn code-tn lra-label temp))
260       (let ((regs-defaulted (gen-label))
261             (defaulting-done (gen-label))
262             (default-stack-vals (gen-label)))
263         ;; Branch off to the MV case.
264         (without-scheduling ()
265           (note-this-location vop :unknown-return)
266           (inst b regs-defaulted)
267           (if (> nvals register-arg-count)
268               (inst subcc temp nargs-tn (fixnumize register-arg-count))
269               (move csp-tn ocfp-tn)))
270         
271         ;; Do the single value calse.
272         (do ((i 1 (1+ i))
273              (val (tn-ref-across values) (tn-ref-across val)))
274             ((= i (min nvals register-arg-count)))
275           (move (tn-ref-tn val) null-tn))
276         (when (> nvals register-arg-count)
277           (inst b default-stack-vals)
278           (move ocfp-tn csp-tn))
279         
280         (emit-label regs-defaulted)
281         (when (> nvals register-arg-count)
282           (collect ((defaults))
283             (do ((i register-arg-count (1+ i))
284                  (val (do ((i 0 (1+ i))
285                            (val values (tn-ref-across val)))
286                           ((= i register-arg-count) val))
287                       (tn-ref-across val)))
288                 ((null val))
289               
290               (let ((default-lab (gen-label))
291                     (tn (tn-ref-tn val)))
292                 (defaults (cons default-lab tn))
293                 
294                 (inst b :le default-lab)
295                 (inst ld move-temp ocfp-tn (* i n-word-bytes))
296                 (inst subcc temp (fixnumize 1))
297                 (store-stack-tn tn move-temp)))
298             
299             (emit-label defaulting-done)
300             (move csp-tn ocfp-tn)
301             
302             (let ((defaults (defaults)))
303               (when defaults
304                 (assemble (*elsewhere*)
305                   (emit-label default-stack-vals)
306                   (trace-table-entry trace-table-fun-prologue)
307                   (do ((remaining defaults (cdr remaining)))
308                       ((null remaining))
309                     (let ((def (car remaining)))
310                       (emit-label (car def))
311                       (when (null (cdr remaining))
312                         (inst b defaulting-done))
313                       (store-stack-tn (cdr def) null-tn)))
314                   (trace-table-entry trace-table-normal))))))
315
316         (inst compute-code-from-lra code-tn code-tn lra-label temp)))
317   (values))
318
319 \f
320 ;;; Emit code needed at the return point for an unknown-values call
321 ;;; for an arbitrary number of values.
322 ;;;
323 ;;; We do the single and non-single cases with no shared code: there
324 ;;; doesn't seem to be any potential overlap, and receiving a single
325 ;;; value is more important efficiency-wise.
326 ;;;
327 ;;; When there is a single value, we just push it on the stack,
328 ;;; returning the old SP and 1.
329 ;;;
330 ;;; When there is a variable number of values, we move all of the
331 ;;; argument registers onto the stack, and return ARGS and NARGS.
332 ;;;
333 ;;; ARGS and NARGS are TNs wired to the named locations.  We must
334 ;;; explicitly allocate these TNs, since their lifetimes overlap with
335 ;;; the results START and COUNT. (Also, it's nice to be able to target
336 ;;; them.)
337 (defun receive-unknown-values (args nargs start count lra-label temp)
338   (declare (type tn args nargs start count temp))
339   (let ((variable-values (gen-label))
340         (done (gen-label)))
341     (without-scheduling ()
342       (inst b variable-values)
343       (inst nop))
344     
345     (inst compute-code-from-lra code-tn code-tn lra-label temp)
346     (inst add csp-tn 4)
347     (storew (first *register-arg-tns*) csp-tn -1)
348     (inst sub start csp-tn 4)
349     (inst li count (fixnumize 1))
350     
351     (emit-label done)
352     
353     (assemble (*elsewhere*)
354       (trace-table-entry trace-table-fun-prologue)
355       (emit-label variable-values)
356       (inst compute-code-from-lra code-tn code-tn lra-label temp)
357       (do ((arg *register-arg-tns* (rest arg))
358            (i 0 (1+ i)))
359           ((null arg))
360         (storew (first arg) args i))
361       (move start args)
362       (move count nargs)
363       (inst b done)
364       (inst nop)
365       (trace-table-entry trace-table-normal)))
366   (values))
367
368
369 ;;; VOP that can be inherited by unknown values receivers.  The main
370 ;;; thing this handles is allocation of the result temporaries.
371 (define-vop (unknown-values-receiver)
372   (:results
373    (start :scs (any-reg))
374    (count :scs (any-reg)))
375   (:temporary (:sc descriptor-reg :offset ocfp-offset
376                    :from :eval :to (:result 0))
377               values-start)
378   (:temporary (:sc any-reg :offset nargs-offset
379                :from :eval :to (:result 1))
380               nvals)
381   (:temporary (:scs (non-descriptor-reg)) temp))
382
383
384 \f
385 ;;;; Local call with unknown values convention return:
386
387 ;;; Non-TR local call for a fixed number of values passed according to the
388 ;;; unknown values convention.
389 ;;;
390 ;;; Args are the argument passing locations, which are specified only to
391 ;;; terminate their lifetimes in the caller.
392 ;;;
393 ;;; Values are the return value locations (wired to the standard passing
394 ;;; locations).
395 ;;;
396 ;;; Save is the save info, which we can ignore since saving has been done.
397 ;;; Return-PC is the TN that the return PC should be passed in.
398 ;;; Target is a continuation pointing to the start of the called function.
399 ;;; Nvals is the number of values received.
400 ;;;
401 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
402 ;;; registers may be tied up by the more operand.  Instead, we use
403 ;;; MAYBE-LOAD-STACK-TN.
404 (define-vop (call-local)
405   (:args (fp)
406          (nfp)
407          (args :more t))
408   (:results (values :more t))
409   (:save-p t)
410   (:move-args :local-call)
411   (:info arg-locs callee target nvals)
412   (:vop-var vop)
413   (:temporary (:scs (descriptor-reg) :from (:eval 0)) move-temp)
414   (:temporary (:scs (non-descriptor-reg)) temp)
415   (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
416   (:temporary (:sc any-reg :offset ocfp-offset :from (:eval 0)) ocfp)
417   (:ignore arg-locs args ocfp)
418   (:generator 5
419     (trace-table-entry trace-table-call-site)
420     (let ((label (gen-label))
421           (cur-nfp (current-nfp-tn vop)))
422       (when cur-nfp
423         (store-stack-tn nfp-save cur-nfp))
424       (let ((callee-nfp (callee-nfp-tn callee)))
425         (when callee-nfp
426           (maybe-load-stack-tn callee-nfp nfp)))
427       (maybe-load-stack-tn cfp-tn fp)
428       (inst compute-lra-from-code
429             (callee-return-pc-tn callee) code-tn label temp)
430       (note-this-location vop :call-site)
431       (inst b target)
432       (inst nop)
433       (emit-return-pc label)
434       (default-unknown-values vop values nvals move-temp temp label)
435       (when cur-nfp
436         (load-stack-tn cur-nfp nfp-save)))
437     (trace-table-entry trace-table-normal)))
438
439
440 ;;; Non-TR local call for a variable number of return values passed according
441 ;;; to the unknown values convention.  The results are the start of the values
442 ;;; glob and the number of values received.
443 ;;;
444 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
445 ;;; registers may be tied up by the more operand.  Instead, we use
446 ;;; MAYBE-LOAD-STACK-TN.
447 (define-vop (multiple-call-local unknown-values-receiver)
448   (:args (fp)
449          (nfp)
450          (args :more t))
451   (:save-p t)
452   (:move-args :local-call)
453   (:info save callee target)
454   (:ignore args save)
455   (:vop-var vop)
456   (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
457   (:generator 20
458     (trace-table-entry trace-table-call-site)
459     (let ((label (gen-label))
460           (cur-nfp (current-nfp-tn vop)))
461       (when cur-nfp
462         (store-stack-tn nfp-save cur-nfp))
463       (let ((callee-nfp (callee-nfp-tn callee)))
464         (when callee-nfp
465           (maybe-load-stack-tn callee-nfp nfp)))
466       (maybe-load-stack-tn cfp-tn fp)
467       (inst compute-lra-from-code
468             (callee-return-pc-tn callee) code-tn label temp)
469       (note-this-location vop :call-site)
470       (inst b target)
471       (inst nop)
472       (emit-return-pc label)
473       (note-this-location vop :unknown-return)
474       (receive-unknown-values values-start nvals start count label temp)
475       (when cur-nfp
476         (load-stack-tn cur-nfp nfp-save)))
477     (trace-table-entry trace-table-normal)))
478
479 \f
480 ;;;; Local call with known values return:
481
482 ;;; Non-TR local call with known return locations.  Known-value return works
483 ;;; just like argument passing in local call.
484 ;;;
485 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
486 ;;; registers may be tied up by the more operand.  Instead, we use
487 ;;; MAYBE-LOAD-STACK-TN.
488 (define-vop (known-call-local)
489   (:args (fp)
490          (nfp)
491          (args :more t))
492   (:results (res :more t))
493   (:move-args :local-call)
494   (:save-p t)
495   (:info save callee target)
496   (:ignore args res save)
497   (:vop-var vop)
498   (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
499   (:temporary (:scs (non-descriptor-reg)) temp)
500   (:generator 5
501     (trace-table-entry trace-table-call-site)
502     (let ((label (gen-label))
503           (cur-nfp (current-nfp-tn vop)))
504       (when cur-nfp
505         (store-stack-tn nfp-save cur-nfp))
506       (let ((callee-nfp (callee-nfp-tn callee)))
507         (when callee-nfp
508           (maybe-load-stack-tn callee-nfp nfp)))
509       (maybe-load-stack-tn cfp-tn fp)
510       (inst compute-lra-from-code
511             (callee-return-pc-tn callee) code-tn label temp)
512       (note-this-location vop :call-site)
513       (inst b target)
514       (inst nop)
515       (emit-return-pc label)
516       (note-this-location vop :known-return)
517       (when cur-nfp
518         (load-stack-tn cur-nfp nfp-save)))
519     (trace-table-entry trace-table-normal)))
520
521 ;;; Return from known values call.  We receive the return locations as
522 ;;; arguments to terminate their lifetimes in the returning function.  We
523 ;;; restore FP and CSP and jump to the Return-PC.
524 ;;;
525 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
526 ;;; registers may be tied up by the more operand.  Instead, we use
527 ;;; MAYBE-LOAD-STACK-TN.
528 (define-vop (known-return)
529   (:args (old-fp :target old-fp-temp)
530          (return-pc :target return-pc-temp)
531          (vals :more t))
532   (:temporary (:sc any-reg :from (:argument 0)) old-fp-temp)
533   (:temporary (:sc descriptor-reg :from (:argument 1)) return-pc-temp)
534   (:move-args :known-return)
535   (:info val-locs)
536   (:ignore val-locs vals)
537   (:vop-var vop)
538   (:generator 6
539     (trace-table-entry trace-table-fun-epilogue)
540     (maybe-load-stack-tn old-fp-temp old-fp)
541     (maybe-load-stack-tn return-pc-temp return-pc)
542     (move csp-tn cfp-tn)
543     (let ((cur-nfp (current-nfp-tn vop)))
544       (when cur-nfp
545         (inst add nsp-tn cur-nfp 
546               (- (bytes-needed-for-non-descriptor-stack-frame)
547                  number-stack-displacement))))
548     (inst j return-pc-temp (- n-word-bytes other-pointer-lowtag))
549     (move cfp-tn old-fp-temp)
550     (trace-table-entry trace-table-normal)))
551
552 \f
553 ;;;; Full call:
554 ;;;
555 ;;; There is something of a cross-product effect with full calls.
556 ;;; Different versions are used depending on whether we know the
557 ;;; number of arguments or the name of the called function, and
558 ;;; whether we want fixed values, unknown values, or a tail call.
559 ;;;
560 ;;; In full call, the arguments are passed creating a partial frame on
561 ;;; the stack top and storing stack arguments into that frame.  On
562 ;;; entry to the callee, this partial frame is pointed to by FP.  If
563 ;;; there are no stack arguments, we don't bother allocating a partial
564 ;;; frame, and instead set FP to SP just before the call.
565
566 ;;; This macro helps in the definition of full call VOPs by avoiding code
567 ;;; replication in defining the cross-product VOPs.
568 ;;;
569 ;;; Name is the name of the VOP to define.
570 ;;; 
571 ;;; Named is true if the first argument is a symbol whose global function
572 ;;; definition is to be called.
573 ;;;
574 ;;; Return is either :Fixed, :Unknown or :Tail:
575 ;;; -- If :Fixed, then the call is for a fixed number of values, returned in
576 ;;;    the standard passing locations (passed as result operands).
577 ;;; -- If :Unknown, then the result values are pushed on the stack, and the
578 ;;;    result values are specified by the Start and Count as in the
579 ;;;    unknown-values continuation representation.
580 ;;; -- If :Tail, then do a tail-recursive call.  No values are returned.
581 ;;;    The Old-Fp and Return-PC are passed as the second and third arguments.
582 ;;;
583 ;;; In non-tail calls, the pointer to the stack arguments is passed as the last
584 ;;; fixed argument.  If Variable is false, then the passing locations are
585 ;;; passed as a more arg.  Variable is true if there are a variable number of
586 ;;; arguments passed on the stack.  Variable cannot be specified with :Tail
587 ;;; return.  TR variable argument call is implemented separately.
588 ;;;
589 ;;; In tail call with fixed arguments, the passing locations are passed as a
590 ;;; more arg, but there is no new-FP, since the arguments have been set up in
591 ;;; the current frame.
592 (defmacro define-full-call (name named return variable)
593   (assert (not (and variable (eq return :tail))))
594   `(define-vop (,name
595                 ,@(when (eq return :unknown)
596                     '(unknown-values-receiver)))
597      (:args
598       ,@(unless (eq return :tail)
599           '((new-fp :scs (any-reg) :to :eval)))
600
601       ,(if named
602            '(name :target name-pass)
603            '(arg-fun :target lexenv))
604       
605       ,@(when (eq return :tail)
606           '((old-fp :target old-fp-pass)
607             (return-pc :target return-pc-pass)))
608       
609       ,@(unless variable '((args :more t :scs (descriptor-reg)))))
610
611      ,@(when (eq return :fixed)
612          '((:results (values :more t))))
613    
614      (:save-p ,(if (eq return :tail) :compute-only t))
615
616      ,@(unless (or (eq return :tail) variable)
617          '((:move-args :full-call)))
618
619      (:vop-var vop)
620      (:info ,@(unless (or variable (eq return :tail)) '(arg-locs))
621             ,@(unless variable '(nargs))
622             ,@(when (eq return :fixed) '(nvals)))
623
624      (:ignore
625       ,@(unless (or variable (eq return :tail)) '(arg-locs))
626       ,@(unless variable '(args)))
627
628      (:temporary (:sc descriptor-reg
629                   :offset ocfp-offset
630                   :from (:argument 1)
631                   ,@(unless (eq return :fixed)
632                       '(:to :eval)))
633                  old-fp-pass)
634
635      (:temporary (:sc descriptor-reg
636                   :offset lra-offset
637                   :from (:argument ,(if (eq return :tail) 2 1))
638                   :to :eval)
639                  return-pc-pass)
640
641      ,(if named
642           `(:temporary (:sc descriptor-reg :offset cname-offset
643                             :from (:argument ,(if (eq return :tail) 0 1))
644                             :to :eval)
645                        name-pass)
646           `(:temporary (:sc descriptor-reg :offset lexenv-offset
647                             :from (:argument ,(if (eq return :tail) 0 1))
648                             :to :eval)
649                        lexenv))
650
651      (:temporary (:scs (descriptor-reg) :from (:argument 0) :to :eval)
652                  function)
653      (:temporary (:sc any-reg :offset nargs-offset :to :eval)
654                  nargs-pass)
655
656      ,@(when variable
657          (mapcar #'(lambda (name offset)
658                      `(:temporary (:sc descriptor-reg
659                                    :offset ,offset
660                                    :to :eval)
661                          ,name))
662                  register-arg-names *register-arg-offsets*))
663      ,@(when (eq return :fixed)
664          '((:temporary (:scs (descriptor-reg) :from :eval) move-temp)))
665
666      ,@(unless (eq return :tail)
667          '((:temporary (:scs (non-descriptor-reg)) temp)
668            (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)))
669
670      (:generator ,(+ (if named 5 0)
671                      (if variable 19 1)
672                      (if (eq return :tail) 0 10)
673                      15
674                      (if (eq return :unknown) 25 0))
675        (trace-table-entry trace-table-call-site)
676        (let* ((cur-nfp (current-nfp-tn vop))
677               ,@(unless (eq return :tail)
678                   '((lra-label (gen-label))))
679               (filler
680                (remove nil
681                        (list :load-nargs
682                              ,@(if (eq return :tail)
683                                    '((unless (location= old-fp old-fp-pass)
684                                        :load-old-fp)
685                                      (unless (location= return-pc
686                                                         return-pc-pass)
687                                        :load-return-pc)
688                                      (when cur-nfp
689                                        :frob-nfp))
690                                    '(:comp-lra
691                                      (when cur-nfp
692                                        :frob-nfp)
693                                      :save-fp
694                                      :load-fp))))))
695          (flet ((do-next-filler ()
696                   (let* ((next (pop filler))
697                          (what (if (consp next) (car next) next)))
698                     (ecase what
699                       (:load-nargs
700                        ,@(if variable
701                              `((inst sub nargs-pass csp-tn new-fp)
702                                ,@(let ((index -1))
703                                    (mapcar #'(lambda (name)
704                                                `(loadw ,name new-fp
705                                                        ,(incf index)))
706                                            register-arg-names)))
707                              '((inst li nargs-pass (fixnumize nargs)))))
708                       ,@(if (eq return :tail)
709                             '((:load-old-fp
710                                (sc-case old-fp
711                                  (any-reg
712                                   (inst move old-fp-pass old-fp))
713                                  (control-stack
714                                   (loadw old-fp-pass cfp-tn
715                                          (tn-offset old-fp)))))
716                               (:load-return-pc
717                                (sc-case return-pc
718                                  (descriptor-reg
719                                   (inst move return-pc-pass return-pc))
720                                  (control-stack
721                                   (loadw return-pc-pass cfp-tn
722                                          (tn-offset return-pc)))))
723                               (:frob-nfp
724                                (inst add nsp-tn cur-nfp
725                                      (- (bytes-needed-for-non-descriptor-stack-frame)
726                                         number-stack-displacement))))
727                             `((:comp-lra
728                                (inst compute-lra-from-code
729                                      return-pc-pass code-tn lra-label temp))
730                               (:frob-nfp
731                                (store-stack-tn nfp-save cur-nfp))
732                               (:save-fp
733                                (inst move old-fp-pass cfp-tn))
734                               (:load-fp
735                                ,(if variable
736                                     '(move cfp-tn new-fp)
737                                     '(if (> nargs register-arg-count)
738                                          (move cfp-tn new-fp)
739                                          (move cfp-tn csp-tn))))))
740                       ((nil))))))
741
742            ,@(if named
743                  `((sc-case name
744                      (descriptor-reg (move name-pass name))
745                      (control-stack
746                       (loadw name-pass cfp-tn (tn-offset name))
747                       (do-next-filler))
748                      (constant
749                       (loadw name-pass code-tn (tn-offset name)
750                              other-pointer-lowtag)
751                       (do-next-filler)))
752                    (loadw function name-pass fdefn-raw-addr-slot
753                           other-pointer-lowtag)
754                    (do-next-filler))
755                  `((sc-case arg-fun
756                      (descriptor-reg (move lexenv arg-fun))
757                      (control-stack
758                       (loadw lexenv cfp-tn (tn-offset arg-fun))
759                       (do-next-filler))
760                      (constant
761                       (loadw lexenv code-tn (tn-offset arg-fun)
762                              other-pointer-lowtag)
763                       (do-next-filler)))
764                    (loadw function lexenv closure-fun-slot
765                           fun-pointer-lowtag)
766                    (do-next-filler)))
767            (loop
768              (if filler
769                  (do-next-filler)
770                  (return)))
771            
772            (note-this-location vop :call-site)
773            (inst j function
774                  (- (ash simple-fun-code-offset word-shift)
775                     fun-pointer-lowtag))
776            (inst move code-tn function))
777
778          ,@(ecase return
779              (:fixed
780               '((emit-return-pc lra-label)
781                 (default-unknown-values vop values nvals move-temp
782                                         temp lra-label)
783                 (when cur-nfp
784                   (load-stack-tn cur-nfp nfp-save))))
785              (:unknown
786               '((emit-return-pc lra-label)
787                 (note-this-location vop :unknown-return)
788                 (receive-unknown-values values-start nvals start count
789                                         lra-label temp)
790                 (when cur-nfp
791                   (load-stack-tn cur-nfp nfp-save))))
792              (:tail)))
793        (trace-table-entry trace-table-normal))))
794
795
796 (define-full-call call nil :fixed nil)
797 (define-full-call call-named t :fixed nil)
798 (define-full-call multiple-call nil :unknown nil)
799 (define-full-call multiple-call-named t :unknown nil)
800 (define-full-call tail-call nil :tail nil)
801 (define-full-call tail-call-named t :tail nil)
802
803 (define-full-call call-variable nil :fixed t)
804 (define-full-call multiple-call-variable nil :unknown t)
805
806
807 ;;; Defined separately, since needs special code that BLT's the
808 ;;; arguments down.
809 (define-vop (tail-call-variable)
810   (:args
811    (args-arg :scs (any-reg) :target args)
812    (function-arg :scs (descriptor-reg) :target lexenv)
813    (old-fp-arg :scs (any-reg) :target old-fp)
814    (lra-arg :scs (descriptor-reg) :target lra))
815
816   (:temporary (:sc any-reg :offset nl0-offset :from (:argument 0)) args)
817   (:temporary (:sc any-reg :offset lexenv-offset :from (:argument 1)) lexenv)
818   (:temporary (:sc any-reg :offset ocfp-offset :from (:argument 2)) old-fp)
819   (:temporary (:sc any-reg :offset lra-offset :from (:argument 3)) lra)
820
821   (:temporary (:scs (any-reg) :from :eval) temp)
822
823   (:vop-var vop)
824
825   (:generator 75
826
827     ;; Move these into the passing locations if they are not already there.
828     (move args args-arg)
829     (move lexenv function-arg)
830     (move old-fp old-fp-arg)
831     (move lra lra-arg)
832
833     ;; Clear the number stack if anything is there.
834     (let ((cur-nfp (current-nfp-tn vop)))
835       (when cur-nfp
836         (inst add nsp-tn cur-nfp
837               (- (bytes-needed-for-non-descriptor-stack-frame)
838                  number-stack-displacement))))
839
840     ;; And jump to the assembly-routine that does the bliting.
841     (inst ji temp (make-fixup 'tail-call-variable :assembly-routine))
842     (inst nop)))
843
844 \f
845 ;;;; Unknown values return:
846
847
848 ;;; Return a single value using the unknown-values convention.
849 (define-vop (return-single)
850   (:args (old-fp :scs (any-reg))
851          (return-pc :scs (descriptor-reg))
852          (value))
853   (:ignore value)
854   (:vop-var vop)
855   (:generator 6
856     (trace-table-entry trace-table-fun-epilogue)
857     ;; Clear the number stack.
858     (let ((cur-nfp (current-nfp-tn vop)))
859       (when cur-nfp
860         (inst add nsp-tn cur-nfp
861               (- (bytes-needed-for-non-descriptor-stack-frame)
862                  number-stack-displacement))))
863     ;; Clear the control stack, and restore the frame pointer.
864     (move csp-tn cfp-tn)
865     (move cfp-tn old-fp)
866     ;; Out of here.
867     (lisp-return return-pc :offset 2)
868     (trace-table-entry trace-table-normal)))
869
870 ;;; Do unknown-values return of a fixed number of values.  The Values are
871 ;;; required to be set up in the standard passing locations.  Nvals is the
872 ;;; number of values returned.
873 ;;;
874 ;;; If returning a single value, then deallocate the current frame, restore
875 ;;; FP and jump to the single-value entry at Return-PC + 8.
876 ;;;
877 ;;; If returning other than one value, then load the number of values returned,
878 ;;; NIL out unsupplied values registers, restore FP and return at Return-PC.
879 ;;; When there are stack values, we must initialize the argument pointer to
880 ;;; point to the beginning of the values block (which is the beginning of the
881 ;;; current frame.)
882 (define-vop (return)
883   (:args
884    (old-fp :scs (any-reg))
885    (return-pc :scs (descriptor-reg) :to (:eval 1))
886    (values :more t))
887   (:ignore values)
888   (:info nvals)
889   (:temporary (:sc descriptor-reg :offset a0-offset :from (:eval 0)) a0)
890   (:temporary (:sc descriptor-reg :offset a1-offset :from (:eval 0)) a1)
891   (:temporary (:sc descriptor-reg :offset a2-offset :from (:eval 0)) a2)
892   (:temporary (:sc descriptor-reg :offset a3-offset :from (:eval 0)) a3)
893   (:temporary (:sc descriptor-reg :offset a4-offset :from (:eval 0)) a4)
894   (:temporary (:sc descriptor-reg :offset a5-offset :from (:eval 0)) a5)
895   (:temporary (:sc any-reg :offset nargs-offset) nargs)
896   (:temporary (:sc any-reg :offset ocfp-offset) val-ptr)
897   (:vop-var vop)
898   (:generator 6
899     (trace-table-entry trace-table-fun-epilogue)
900     ;; Clear the number stack.
901     (let ((cur-nfp (current-nfp-tn vop)))
902       (when cur-nfp
903         (inst add nsp-tn cur-nfp
904               (- (bytes-needed-for-non-descriptor-stack-frame)
905                  number-stack-displacement))))
906     (cond ((= nvals 1)
907            ;; Clear the control stack, and restore the frame pointer.
908            (move csp-tn cfp-tn)
909            (move cfp-tn old-fp)
910            ;; Out of here.
911            (lisp-return return-pc :offset 2))
912           (t
913            ;; Establish the values pointer and values count.
914            (move val-ptr cfp-tn)
915            (inst li nargs (fixnumize nvals))
916            ;; restore the frame pointer and clear as much of the control
917            ;; stack as possible.
918            (move cfp-tn old-fp)
919            (inst add csp-tn val-ptr (* nvals n-word-bytes))
920            ;; pre-default any argument register that need it.
921            (when (< nvals register-arg-count)
922              (dolist (reg (subseq (list a0 a1 a2 a3 a4 a5) nvals))
923                (move reg null-tn)))
924            ;; And away we go.
925            (lisp-return return-pc)))
926     (trace-table-entry trace-table-normal)))
927
928 ;;; Do unknown-values return of an arbitrary number of values (passed on the
929 ;;; stack.)  We check for the common case of a single return value, and do that
930 ;;; inline using the normal single value return convention.  Otherwise, we
931 ;;; branch off to code that calls an assembly-routine.
932 (define-vop (return-multiple)
933   (:args
934    (old-fp-arg :scs (any-reg) :to (:eval 1))
935    (lra-arg :scs (descriptor-reg) :to (:eval 1))
936    (vals-arg :scs (any-reg) :target vals)
937    (nvals-arg :scs (any-reg) :target nvals))
938
939   (:temporary (:sc any-reg :offset nl1-offset :from (:argument 0)) old-fp)
940   (:temporary (:sc descriptor-reg :offset lra-offset :from (:argument 1)) lra)
941   (:temporary (:sc any-reg :offset nl0-offset :from (:argument 2)) vals)
942   (:temporary (:sc any-reg :offset nargs-offset :from (:argument 3)) nvals)
943   (:temporary (:sc descriptor-reg :offset a0-offset) a0)
944
945   (:temporary (:scs (any-reg) :from (:eval 1)) temp)
946
947   (:vop-var vop)
948
949   (:generator 13
950     (trace-table-entry trace-table-fun-epilogue)
951     (let ((not-single (gen-label)))
952       ;; Clear the number stack.
953       (let ((cur-nfp (current-nfp-tn vop)))
954         (when cur-nfp
955           (inst add nsp-tn cur-nfp
956                 (- (bytes-needed-for-non-descriptor-stack-frame)
957                    number-stack-displacement))))
958
959       ;; Check for the single case.
960       (inst cmp nvals-arg (fixnumize 1))
961       (inst b :ne not-single)
962       (inst ld a0 vals-arg)
963
964       ;; Return with one value.
965       (move csp-tn cfp-tn)
966       (move cfp-tn old-fp-arg)
967       (lisp-return lra-arg :offset 2)
968                 
969       ;; Nope, not the single case.
970       (emit-label not-single)
971       (move old-fp old-fp-arg)
972       (move lra lra-arg)
973       (move vals vals-arg)
974       (move nvals nvals-arg)
975       (inst ji temp (make-fixup 'return-multiple :assembly-routine))
976       (inst nop))
977     (trace-table-entry trace-table-normal)))
978
979
980 \f
981 ;;;; XEP hackery:
982
983
984 ;;; We don't need to do anything special for regular functions.
985 (define-vop (setup-environment)
986   (:info label)
987   (:ignore label)
988   (:generator 0
989     ;; Don't bother doing anything.
990     ))
991
992 ;;; Get the lexical environment from it's passing location.
993 (define-vop (setup-closure-environment)
994   (:temporary (:sc descriptor-reg :offset lexenv-offset :target closure
995                :to (:result 0))
996               lexenv)
997   (:results (closure :scs (descriptor-reg)))
998   (:info label)
999   (:ignore label)
1000   (:generator 6
1001     ;; Get result.
1002     (move closure lexenv)))
1003
1004 ;;; Copy a more arg from the argument area to the end of the current frame.
1005 ;;; Fixed is the number of non-more arguments. 
1006 (define-vop (copy-more-arg)
1007   (:temporary (:sc any-reg :offset nl0-offset) result)
1008   (:temporary (:sc any-reg :offset nl1-offset) count)
1009   (:temporary (:sc any-reg :offset nl2-offset) src)
1010   (:temporary (:sc any-reg :offset nl3-offset) dst)
1011   (:temporary (:sc descriptor-reg :offset l0-offset) temp)
1012   (:info fixed)
1013   (:generator 20
1014     (let ((loop (gen-label))
1015           (do-regs (gen-label))
1016           (done (gen-label)))
1017       (when (< fixed register-arg-count)
1018         ;; Save a pointer to the results so we can fill in register args.
1019         ;; We don't need this if there are more fixed args than reg args.
1020         (move result csp-tn))
1021       ;; Allocate the space on the stack.
1022       (cond ((zerop fixed)
1023              (inst cmp nargs-tn)
1024              (inst b :eq done)
1025              (inst add csp-tn csp-tn nargs-tn))
1026             (t
1027              (inst subcc count nargs-tn (fixnumize fixed))
1028              (inst b :le done)
1029              (inst nop)
1030              (inst add csp-tn csp-tn count)))
1031       (when (< fixed register-arg-count)
1032         ;; We must stop when we run out of stack args, not when we run out of
1033         ;; more args.
1034         (inst subcc count nargs-tn (fixnumize register-arg-count))
1035         ;; Everything of interest in registers.
1036         (inst b :le do-regs))
1037       ;; Initialize dst to be end of stack.
1038       (move dst csp-tn)
1039       ;; Initialize src to be end of args.
1040       (inst add src cfp-tn nargs-tn)
1041
1042       (emit-label loop)
1043       ;; *--dst = *--src, --count
1044       (inst add src src (- n-word-bytes))
1045       (inst subcc count count (fixnumize 1))
1046       (loadw temp src)
1047       (inst add dst dst (- n-word-bytes))
1048       (inst b :gt loop)
1049       (storew temp dst)
1050
1051       (emit-label do-regs)
1052       (when (< fixed register-arg-count)
1053         ;; Now we have to deposit any more args that showed up in registers.
1054         (inst subcc count nargs-tn (fixnumize fixed))
1055         (do ((i fixed (1+ i)))
1056             ((>= i register-arg-count))
1057           ;; Don't deposit any more than there are.
1058           (inst b :eq done)
1059           (inst subcc count (fixnumize 1))
1060           ;; Store it relative to the pointer saved at the start.
1061           (storew (nth i *register-arg-tns*) result (- i fixed))))
1062       (emit-label done))))
1063
1064
1065 ;;; More args are stored consequtively on the stack, starting immediately at
1066 ;;; the context pointer.  The context pointer is not typed, so the lowtag is 0.
1067 (define-vop (more-arg word-index-ref)
1068   (:variant 0 0)
1069   (:translate %more-arg))
1070
1071
1072 ;;; Turn more arg (context, count) into a list.
1073 (define-vop (listify-rest-args)
1074   (:args (context-arg :target context :scs (descriptor-reg))
1075          (count-arg :target count :scs (any-reg)))
1076   (:info dx)
1077   (:ignore dx)
1078   (:arg-types * tagged-num (:constant t))
1079   (:temporary (:scs (any-reg) :from (:argument 0)) context)
1080   (:temporary (:scs (any-reg) :from (:argument 1)) count)
1081   (:temporary (:scs (descriptor-reg) :from :eval) temp)
1082   (:temporary (:scs (non-descriptor-reg) :from :eval) dst)
1083   (:results (result :scs (descriptor-reg)))
1084   (:translate %listify-rest-args)
1085   (:policy :safe)
1086   (:generator 20
1087     (move context context-arg)
1088     (move count count-arg)
1089     ;; Check to see if there are any arguments.
1090     (inst cmp count)
1091     (inst b :eq done)
1092     (move result null-tn)
1093
1094     ;; We need to do this atomically.
1095     (pseudo-atomic ()
1096       (assemble ()
1097         ;; Allocate a cons (2 words) for each item.
1098         (inst andn result alloc-tn lowtag-mask)
1099         (inst or result list-pointer-lowtag)
1100         (move dst result)
1101         (inst sll temp count 1)
1102         (inst b enter)
1103         (inst add alloc-tn temp)
1104
1105         ;; Compute the next cons and store it in the current one.
1106         LOOP
1107         (inst add dst dst (* 2 n-word-bytes))
1108         (storew dst dst -1 list-pointer-lowtag)
1109
1110         ;; Grab one value.
1111         ENTER
1112         (loadw temp context)
1113         (inst add context context n-word-bytes)
1114
1115         ;; Dec count, and if != zero, go back for more.
1116         (inst subcc count (fixnumize 1))
1117         (inst b :gt loop)
1118
1119         ;; Store the value into the car of the current cons (in the delay
1120         ;; slot).
1121         (storew temp dst 0 list-pointer-lowtag)
1122
1123         ;; NIL out the last cons.
1124         (storew null-tn dst 1 list-pointer-lowtag)))
1125     DONE))
1126
1127
1128 ;;; Return the location and size of the more arg glob created by Copy-More-Arg.
1129 ;;; Supplied is the total number of arguments supplied (originally passed in
1130 ;;; NARGS.)  Fixed is the number of non-rest arguments.
1131 ;;;
1132 ;;; We must duplicate some of the work done by Copy-More-Arg, since at that
1133 ;;; time the environment is in a pretty brain-damaged state, preventing this
1134 ;;; info from being returned as values.  What we do is compute
1135 ;;; supplied - fixed, and return a pointer that many words below the current
1136 ;;; stack top.
1137 (define-vop (more-arg-context)
1138   (:policy :fast-safe)
1139   (:translate sb!c::%more-arg-context)
1140   (:args (supplied :scs (any-reg)))
1141   (:arg-types tagged-num (:constant fixnum))
1142   (:info fixed)
1143   (:results (context :scs (descriptor-reg))
1144             (count :scs (any-reg)))
1145   (:result-types t tagged-num)
1146   (:note "more-arg-context")
1147   (:generator 5
1148     (inst sub count supplied (fixnumize fixed))
1149     (inst sub context csp-tn count)))
1150
1151
1152 ;;; Signal wrong argument count error if Nargs isn't = to Count.
1153 ;;;
1154 (define-vop (verify-arg-count)
1155   (:policy :fast-safe)
1156   (:translate sb!c::%verify-arg-count)
1157   (:args (nargs :scs (any-reg)))
1158   (:arg-types positive-fixnum (:constant t))
1159   (:info count)
1160   (:vop-var vop)
1161   (:save-p :compute-only)
1162   (:generator 3
1163     (let ((err-lab
1164            (generate-error-code vop invalid-arg-count-error nargs)))
1165       (inst cmp nargs (fixnumize count))
1166       (if (member :sparc-v9 *backend-subfeatures*)
1167           ;; Assume we don't take the branch
1168           (inst b :ne err-lab :pn)
1169           (inst b :ne err-lab))
1170       (inst nop))))
1171
1172 ;;; Signal various errors.
1173 (macrolet ((frob (name error translate &rest args)
1174              `(define-vop (,name)
1175                 ,@(when translate
1176                     `((:policy :fast-safe)
1177                       (:translate ,translate)))
1178                 (:args ,@(mapcar #'(lambda (arg)
1179                                      `(,arg :scs (any-reg descriptor-reg)))
1180                                  args))
1181                 (:vop-var vop)
1182                 (:save-p :compute-only)
1183                 (:generator 1000
1184                   (error-call vop ,error ,@args)))))
1185   (frob arg-count-error invalid-arg-count-error
1186     sb!c::%arg-count-error nargs)
1187   (frob type-check-error object-not-type-error sb!c::%type-check-error
1188     object type)
1189   (frob layout-invalid-error layout-invalid-error sb!c::%layout-invalid-error
1190     object layout)
1191   (frob odd-key-args-error odd-key-args-error
1192     sb!c::%odd-key-args-error)
1193   (frob unknown-key-arg-error unknown-key-arg-error
1194     sb!c::%unknown-key-arg-error key)
1195   (frob nil-fun-returned-error nil-fun-returned-error nil fun))