1 ;;;; the VM definition of function call for MIPS
3 ;;;; This software is part of the SBCL system. See the README file for
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.
14 ;;;; Interfaces to IR2 conversion:
16 ;;; Return a wired TN describing the N'th full call argument passing
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*
23 (elt *register-arg-offsets* n))
24 (make-wired-tn *backend-t-primitive-type*
25 control-stack-arg-scn n)))
28 ;;; Make a passing location TN for a local call return PC. If standard is
29 ;;; true, then use the standard (full call) location, otherwise use any legal
30 ;;; location. Even in the non-standard case, this may be restricted by a
31 ;;; desire to use a subroutine call instruction.
32 (!def-vm-support-routine make-return-pc-passing-location (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)))
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
42 (!def-vm-support-routine make-old-fp-passing-location (standard)
44 (make-wired-tn *fixnum-primitive-type* immediate-arg-scn ocfp-offset)
45 (make-normal-tn *fixnum-primitive-type*)))
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)
52 (physenv-debug-live-tn (make-normal-tn *fixnum-primitive-type*) env)
53 (make-wired-tn *fixnum-primitive-type*
57 (!def-vm-support-routine make-return-pc-save-location (env)
58 (let ((ptype *backend-t-primitive-type*))
60 (physenv-debug-live-tn (make-normal-tn ptype) env)
61 (make-wired-tn ptype control-stack-arg-scn lra-save-offset))))
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* immediate-arg-scn nargs-offset))
70 ;;; Make a TN to hold the number-stack frame pointer. This is allocated
71 ;;; once per component, and is component-live.
72 (!def-vm-support-routine make-nfp-tn ()
74 (make-wired-tn *fixnum-primitive-type* immediate-arg-scn nfp-offset)))
76 (!def-vm-support-routine make-stack-pointer-tn ()
77 (make-normal-tn *fixnum-primitive-type*))
79 (!def-vm-support-routine make-number-stack-pointer-tn ()
80 (make-normal-tn *fixnum-primitive-type*))
82 ;;; Return a list of TNs that can be used to represent an unknown-values
83 ;;; continuation within a function.
84 (!def-vm-support-routine make-unknown-values-locations ()
85 (list (make-stack-pointer-tn)
86 (make-normal-tn *fixnum-primitive-type*)))
89 ;;; This function is called by the ENTRY-ANALYZE phase, allowing
90 ;;; VM-dependent initialization of the IR2-COMPONENT structure. We push
91 ;;; placeholder entries in the Constants to leave room for additional
92 ;;; noise in the code object header.
93 (!def-vm-support-routine select-component-format (component)
94 (declare (type component component))
95 (dotimes (i code-constants-offset)
96 (vector-push-extend nil
97 (ir2-component-constants (component-info component))))
103 ;;; BYTES-NEEDED-FOR-NON-DESCRIPTOR-STACK-FRAME -- internal
105 ;;; Return the number of bytes needed for the current non-descriptor stack
106 ;;; frame. Non-descriptor stack frames must be multiples of 8 bytes on
109 (defun bytes-needed-for-non-descriptor-stack-frame ()
110 (* (logandc2 (1+ (sb-allocated-size 'non-descriptor-stack)) 1)
113 ;;; Used for setting up the Old-FP in local call.
115 (define-vop (current-fp)
116 (:results (val :scs (any-reg)))
120 ;;; Used for computing the caller's NFP for use in known-values return. Only
121 ;;; works assuming there is no variable size stuff on the nstack.
123 (define-vop (compute-old-nfp)
124 (:results (val :scs (any-reg)))
127 (let ((nfp (current-nfp-tn vop)))
129 (inst addu val nfp (bytes-needed-for-non-descriptor-stack-frame))))))
132 (define-vop (xep-allocate-frame)
133 (:info start-lab copy-more-arg-follows)
134 (:ignore copy-more-arg-follows)
136 (:temporary (:scs (non-descriptor-reg)) temp)
138 ;; Make sure the function is aligned, and drop a label pointing to this
140 (emit-alignment n-lowtag-bits)
141 (trace-table-entry trace-table-fun-prologue)
142 (emit-label start-lab)
143 ;; Allocate function header.
144 (inst simple-fun-header-word)
145 (dotimes (i (1- simple-fun-code-offset))
147 ;; The start of the actual code.
148 ;; Compute CODE from the address of this entry point.
149 (let ((entry-point (gen-label)))
150 (emit-label entry-point)
151 (inst compute-code-from-lip code-tn lip-tn entry-point temp)
152 ;; ### We should also save it on the stack so that the garbage collector
153 ;; won't forget about us if we call anyone else.
155 ;; Build our stack frames.
156 (inst addu csp-tn cfp-tn
157 (* n-word-bytes (sb-allocated-size 'control-stack)))
158 (let ((nfp (current-nfp-tn vop)))
160 (inst addu nsp-tn nsp-tn
161 (- (bytes-needed-for-non-descriptor-stack-frame)))
163 (trace-table-entry trace-table-normal)))
165 (define-vop (allocate-frame)
166 (:results (res :scs (any-reg))
167 (nfp :scs (any-reg)))
170 (trace-table-entry trace-table-fun-prologue)
172 (inst addu csp-tn csp-tn
173 (* n-word-bytes (sb-allocated-size 'control-stack)))
174 (when (ir2-physenv-number-stack-p callee)
175 (inst addu nsp-tn nsp-tn
176 (- (bytes-needed-for-non-descriptor-stack-frame)))
178 (trace-table-entry trace-table-normal)))
180 ;;; Allocate a partial frame for passing stack arguments in a full call. Nargs
181 ;;; is the number of arguments passed. If no stack arguments are passed, then
182 ;;; we don't have to do anything.
184 (define-vop (allocate-full-call-frame)
186 (:results (res :scs (any-reg)))
188 (when (> nargs register-arg-count)
190 (inst addu csp-tn csp-tn (* nargs n-word-bytes)))))
195 ;;; Emit code needed at the return-point from an unknown-values call for a
196 ;;; fixed number of values. Values is the head of the TN-Ref list for the
197 ;;; locations that the values are to be received into. Nvals is the number of
198 ;;; values that are to be received (should equal the length of Values).
200 ;;; MOVE-TEMP is a DESCRIPTOR-REG TN used as a temporary.
202 ;;; This code exploits the fact that in the unknown-values convention, a
203 ;;; single value return returns at the return PC + 8, whereas a return of other
204 ;;; than one value returns directly at the return PC.
206 ;;; If 0 or 1 values are expected, then we just emit an instruction to reset
207 ;;; the SP (which will only be executed when other than 1 value is returned.)
209 ;;; In the general case, we have to do three things:
210 ;;; -- Default unsupplied register values. This need only be done when a
211 ;;; single value is returned, since register values are defaulted by the
212 ;;; callee in the non-single case.
213 ;;; -- Default unsupplied stack values. This needs to be done whenever there
214 ;;; are stack values.
215 ;;; -- Reset SP. This must be done whenever other than 1 value is returned,
216 ;;; regardless of the number of values desired.
218 ;;; The general-case code looks like this:
220 b regs-defaulted ; Skip if MVs
223 move a1 null-tn ; Default register values
225 loadi nargs 1 ; Force defaulting of stack values
226 move ocfp csp ; Set up args for SP resetting
229 subu temp nargs register-arg-count
231 bltz temp default-value-7 ; jump to default code
233 loadw move-temp ocfp-tn 6 ; Move value to correct location.
234 store-stack-tn val4-tn move-temp
236 bltz temp default-value-8
238 loadw move-temp ocfp-tn 7
239 store-stack-tn val5-tn move-temp
244 move csp ocfp ; Reset SP.
249 store-stack-tn val4-tn null-tn ; Nil out 7'th value. (first on stack)
252 store-stack-tn val5-tn null-tn ; Nil out 8'th value.
260 (defun default-unknown-values (vop values nvals move-temp temp lra-label)
261 (declare (type (or tn-ref null) values)
262 (type unsigned-byte nvals) (type tn move-temp temp))
265 ;; Note that this is a single-value return point. This is actually
266 ;; the multiple-value entry point for a single desired value, but
267 ;; the code location has to be here, or the debugger backtrace
269 (without-scheduling ()
270 (note-this-location vop :single-value-return)
271 (move csp-tn ocfp-tn t)
274 (inst compute-code-from-lra code-tn code-tn lra-label temp)))
275 (let ((regs-defaulted (gen-label))
276 (defaulting-done (gen-label))
277 (default-stack-vals (gen-label)))
278 (without-scheduling ()
279 ;; Note that this is an unknown-values return point.
280 (note-this-location vop :unknown-return)
281 ;; Branch off to the MV case.
282 (inst b regs-defaulted)
283 ;; If there are no stack results, clear the stack now.
284 (if (> nvals register-arg-count)
285 (inst addu temp nargs-tn (fixnumize (- register-arg-count)))
286 (move csp-tn ocfp-tn t)))
288 ;; Do the single value case.
290 (val (tn-ref-across values) (tn-ref-across val)))
291 ((= i (min nvals register-arg-count)))
292 (move (tn-ref-tn val) null-tn))
293 (when (> nvals register-arg-count)
294 (inst b default-stack-vals)
295 (move ocfp-tn csp-tn t))
297 (emit-label regs-defaulted)
299 (when (> nvals register-arg-count)
300 ;; If there are stack results, we have to default them
301 ;; and clear the stack.
302 (collect ((defaults))
303 (do ((i register-arg-count (1+ i))
304 (val (do ((i 0 (1+ i))
305 (val values (tn-ref-across val)))
306 ((= i register-arg-count) val))
307 (tn-ref-across val)))
310 (let ((default-lab (gen-label))
311 (tn (tn-ref-tn val)))
312 (defaults (cons default-lab tn))
314 (inst blez temp default-lab)
315 (inst lw move-temp ocfp-tn (* i n-word-bytes))
316 (inst addu temp temp (fixnumize -1))
317 (store-stack-tn tn move-temp)))
319 (emit-label defaulting-done)
320 (move csp-tn ocfp-tn)
322 (let ((defaults (defaults)))
324 (assemble (*elsewhere*)
325 (emit-label default-stack-vals)
326 (trace-table-entry trace-table-fun-prologue)
327 (do ((remaining defaults (cdr remaining)))
329 (let ((def (car remaining)))
330 (emit-label (car def))
331 (when (null (cdr remaining))
332 (inst b defaulting-done))
333 (store-stack-tn (cdr def) null-tn)))
334 (trace-table-entry trace-table-normal)))))
337 (inst compute-code-from-lra code-tn code-tn lra-label temp))))
341 ;;;; Unknown values receiving:
343 ;;; Emit code needed at the return point for an unknown-values call for an
344 ;;; arbitrary number of values.
346 ;;; We do the single and non-single cases with no shared code: there doesn't
347 ;;; seem to be any potential overlap, and receiving a single value is more
348 ;;; important efficiency-wise.
350 ;;; When there is a single value, we just push it on the stack, returning
351 ;;; the old SP and 1.
353 ;;; When there is a variable number of values, we move all of the argument
354 ;;; registers onto the stack, and return Args and Nargs.
356 ;;; Args and Nargs are TNs wired to the named locations. We must
357 ;;; explicitly allocate these TNs, since their lifetimes overlap with the
358 ;;; results Start and Count (also, it's nice to be able to target them).
360 (defun receive-unknown-values (args nargs start count lra-label temp)
361 (declare (type tn args nargs start count temp))
362 (let ((variable-values (gen-label))
364 (without-scheduling ()
365 (inst b variable-values)
369 (inst compute-code-from-lra code-tn code-tn lra-label temp))
370 (inst addu csp-tn csp-tn n-word-bytes)
371 (storew (first *register-arg-tns*) csp-tn -1)
372 (inst addu start csp-tn (- n-word-bytes))
373 (inst li count (fixnumize 1))
377 (assemble (*elsewhere*)
378 (trace-table-entry trace-table-fun-prologue)
379 (emit-label variable-values)
381 (inst compute-code-from-lra code-tn code-tn lra-label temp))
382 (do ((arg *register-arg-tns* (rest arg))
385 (storew (first arg) args i))
389 (trace-table-entry trace-table-normal)))
393 ;;; VOP that can be inherited by unknown values receivers. The main thing this
394 ;;; handles is allocation of the result temporaries.
396 (define-vop (unknown-values-receiver)
398 (start :scs (any-reg))
399 (count :scs (any-reg)))
400 (:temporary (:sc descriptor-reg :offset ocfp-offset
401 :from :eval :to (:result 0))
403 (:temporary (:sc any-reg :offset nargs-offset
404 :from :eval :to (:result 1))
406 (:temporary (:scs (non-descriptor-reg)) temp))
410 ;;;; Local call with unknown values convention return:
412 ;;; Non-TR local call for a fixed number of values passed according to the
413 ;;; unknown values convention.
415 ;;; Args are the argument passing locations, which are specified only to
416 ;;; terminate their lifetimes in the caller.
418 ;;; Values are the return value locations (wired to the standard passing
421 ;;; Save is the save info, which we can ignore since saving has been done.
422 ;;; Return-PC is the TN that the return PC should be passed in.
423 ;;; Target is a continuation pointing to the start of the called function.
424 ;;; Nvals is the number of values received.
426 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
427 ;;; registers may be tied up by the more operand. Instead, we use
428 ;;; MAYBE-LOAD-STACK-TN.
430 (define-vop (call-local)
434 (:results (values :more t))
436 (:move-args :local-call)
437 (:info arg-locs callee target nvals)
439 (:temporary (:scs (descriptor-reg) :from :eval) move-temp)
440 (:temporary (:scs (non-descriptor-reg)) temp)
441 (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
442 (:temporary (:sc any-reg :offset ocfp-offset :from :eval) ocfp)
443 (:ignore arg-locs args ocfp)
445 (let ((label (gen-label))
446 (cur-nfp (current-nfp-tn vop)))
448 (store-stack-tn nfp-save cur-nfp))
449 (let ((callee-nfp (callee-nfp-tn callee)))
451 (maybe-load-stack-tn callee-nfp nfp)))
452 (maybe-load-stack-tn cfp-tn fp)
453 (trace-table-entry trace-table-call-site)
454 (inst compute-lra-from-code
455 (callee-return-pc-tn callee) code-tn label temp)
456 (note-this-location vop :call-site)
459 (trace-table-entry trace-table-normal)
460 (emit-return-pc label)
461 (default-unknown-values vop values nvals move-temp temp label)
463 (load-stack-tn cur-nfp nfp-save)))))
466 ;;; Non-TR local call for a variable number of return values passed according
467 ;;; to the unknown values convention. The results are the start of the values
468 ;;; glob and the number of values received.
470 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
471 ;;; registers may be tied up by the more operand. Instead, we use
472 ;;; MAYBE-LOAD-STACK-TN.
474 (define-vop (multiple-call-local unknown-values-receiver)
479 (:move-args :local-call)
480 (:info save callee target)
483 (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
484 (:temporary (:scs (non-descriptor-reg)) temp)
486 (let ((label (gen-label))
487 (cur-nfp (current-nfp-tn vop)))
489 (store-stack-tn nfp-save cur-nfp))
490 (let ((callee-nfp (callee-nfp-tn callee)))
492 (maybe-load-stack-tn callee-nfp nfp)))
493 (maybe-load-stack-tn cfp-tn fp)
494 (trace-table-entry trace-table-call-site)
495 (inst compute-lra-from-code
496 (callee-return-pc-tn callee) code-tn label temp)
497 (note-this-location vop :call-site)
500 (trace-table-entry trace-table-normal)
501 (emit-return-pc label)
502 (note-this-location vop :unknown-return)
503 (receive-unknown-values values-start nvals start count label temp)
505 (load-stack-tn cur-nfp nfp-save)))))
508 ;;;; Local call with known values return:
510 ;;; Non-TR local call with known return locations. Known-value return works
511 ;;; just like argument passing in local call.
513 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
514 ;;; registers may be tied up by the more operand. Instead, we use
515 ;;; MAYBE-LOAD-STACK-TN.
517 (define-vop (known-call-local)
521 (:results (res :more t))
522 (:move-args :local-call)
524 (:info save callee target)
525 (:ignore args res save)
527 (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)
528 (:temporary (:scs (non-descriptor-reg)) temp)
530 (let ((label (gen-label))
531 (cur-nfp (current-nfp-tn vop)))
533 (store-stack-tn nfp-save cur-nfp))
534 (let ((callee-nfp (callee-nfp-tn callee)))
536 (maybe-load-stack-tn callee-nfp nfp)))
537 (maybe-load-stack-tn cfp-tn fp)
538 (trace-table-entry trace-table-call-site)
539 (inst compute-lra-from-code
540 (callee-return-pc-tn callee) code-tn label temp)
541 (note-this-location vop :call-site)
544 (trace-table-entry trace-table-normal)
545 (emit-return-pc label)
546 (note-this-location vop :known-return)
548 (load-stack-tn cur-nfp nfp-save)))))
550 ;;; Return from known values call. We receive the return locations as
551 ;;; arguments to terminate their lifetimes in the returning function. We
552 ;;; restore FP and CSP and jump to the Return-PC.
554 ;;; Note: we can't use normal load-tn allocation for the fixed args, since all
555 ;;; registers may be tied up by the more operand. Instead, we use
556 ;;; MAYBE-LOAD-STACK-TN.
558 (define-vop (known-return)
559 (:args (ocfp :target ocfp-temp)
560 (return-pc :target return-pc-temp)
562 (:temporary (:sc any-reg :from (:argument 0)) ocfp-temp)
563 (:temporary (:sc descriptor-reg :from (:argument 1))
565 (:temporary (:scs (interior-reg)) lip)
566 (:move-args :known-return)
568 (:ignore val-locs vals)
571 (trace-table-entry trace-table-fun-epilogue)
572 (maybe-load-stack-tn ocfp-temp ocfp)
573 (maybe-load-stack-tn return-pc-temp return-pc)
575 (let ((cur-nfp (current-nfp-tn vop)))
577 (inst addu nsp-tn cur-nfp
578 (bytes-needed-for-non-descriptor-stack-frame))))
579 (inst addu lip return-pc-temp (- n-word-bytes other-pointer-lowtag))
581 (move cfp-tn ocfp-temp t)
582 (trace-table-entry trace-table-normal)))
587 ;;; There is something of a cross-product effect with full calls. Different
588 ;;; versions are used depending on whether we know the number of arguments or
589 ;;; the name of the called function, and whether we want fixed values, unknown
590 ;;; values, or a tail call.
592 ;;; In full call, the arguments are passed creating a partial frame on the
593 ;;; stack top and storing stack arguments into that frame. On entry to the
594 ;;; callee, this partial frame is pointed to by FP. If there are no stack
595 ;;; arguments, we don't bother allocating a partial frame, and instead set FP
596 ;;; to SP just before the call.
598 ;;; This macro helps in the definition of full call VOPs by avoiding code
599 ;;; replication in defining the cross-product VOPs.
601 ;;; Name is the name of the VOP to define.
603 ;;; Named is true if the first argument is a symbol whose global function
604 ;;; definition is to be called.
606 ;;; Return is either :Fixed, :Unknown or :Tail:
607 ;;; -- If :Fixed, then the call is for a fixed number of values, returned in
608 ;;; the standard passing locations (passed as result operands).
609 ;;; -- If :Unknown, then the result values are pushed on the stack, and the
610 ;;; result values are specified by the Start and Count as in the
611 ;;; unknown-values continuation representation.
612 ;;; -- If :Tail, then do a tail-recursive call. No values are returned.
613 ;;; The Ocfp and Return-PC are passed as the second and third arguments.
615 ;;; In non-tail calls, the pointer to the stack arguments is passed as the last
616 ;;; fixed argument. If Variable is false, then the passing locations are
617 ;;; passed as a more arg. Variable is true if there are a variable number of
618 ;;; arguments passed on the stack. Variable cannot be specified with :Tail
619 ;;; return. TR variable argument call is implemented separately.
621 ;;; In tail call with fixed arguments, the passing locations are passed as a
622 ;;; more arg, but there is no new-FP, since the arguments have been set up in
623 ;;; the current frame.
625 (defmacro define-full-call (name named return variable)
626 (aver (not (and variable (eq return :tail))))
628 ,@(when (eq return :unknown)
629 '(unknown-values-receiver)))
631 ,@(unless (eq return :tail)
632 '((new-fp :scs (any-reg) :to :eval)))
635 '(name :target name-pass)
636 '(arg-fun :target lexenv))
638 ,@(when (eq return :tail)
639 '((ocfp :target ocfp-pass)
640 (return-pc :target return-pc-pass)))
642 ,@(unless variable '((args :more t :scs (descriptor-reg)))))
644 ,@(when (eq return :fixed)
645 '((:results (values :more t))))
647 (:save-p ,(if (eq return :tail) :compute-only t))
649 ,@(unless (or (eq return :tail) variable)
650 '((:move-args :full-call)))
653 (:info ,@(unless (or variable (eq return :tail)) '(arg-locs))
654 ,@(unless variable '(nargs))
655 ,@(when (eq return :fixed) '(nvals))
658 (:ignore ,@(unless (or variable (eq return :tail)) '(arg-locs))
659 ,@(unless variable '(args)))
661 (:temporary (:sc descriptor-reg
664 ,@(unless (eq return :fixed)
668 (:temporary (:sc descriptor-reg
670 :from (:argument ,(if (eq return :tail) 2 1))
675 `((:temporary (:sc descriptor-reg :offset fdefn-offset
676 :from (:argument ,(if (eq return :tail) 0 1))
680 `((:temporary (:sc descriptor-reg :offset lexenv-offset
681 :from (:argument ,(if (eq return :tail) 0 1))
684 (:temporary (:scs (descriptor-reg) :from (:argument 0) :to :eval)
687 (:temporary (:sc any-reg :offset nargs-offset :to :eval)
691 (mapcar #'(lambda (name offset)
692 `(:temporary (:sc descriptor-reg
696 register-arg-names *register-arg-offsets*))
697 ,@(when (eq return :fixed)
698 '((:temporary (:scs (descriptor-reg) :from :eval) move-temp)))
700 (:temporary (:scs (descriptor-reg) :to :eval) stepping)
702 ,@(unless (eq return :tail)
703 '((:temporary (:scs (non-descriptor-reg)) temp)
704 (:temporary (:sc control-stack :offset nfp-save-offset) nfp-save)))
706 (:temporary (:sc interior-reg) entry-point)
708 (:generator ,(+ (if named 5 0)
710 (if (eq return :tail) 0 10)
712 (if (eq return :unknown) 25 0))
713 (let* ((cur-nfp (current-nfp-tn vop))
714 ,@(unless (eq return :tail)
715 '((lra-label (gen-label))))
716 (step-done-label (gen-label))
720 ,@(if (eq return :tail)
721 '((unless (location= ocfp ocfp-pass)
723 (unless (location= return-pc
733 (flet ((do-next-filler ()
734 (let* ((next (pop filler))
735 (what (if (consp next) (car next) next)))
739 `((inst subu nargs-pass csp-tn new-fp)
741 (mapcar #'(lambda (name)
742 `(inst lw ,name new-fp
745 register-arg-names)))
746 '((inst li nargs-pass (fixnumize nargs)))))
747 ,@(if (eq return :tail)
751 (move ocfp-pass ocfp t))
753 (inst lw ocfp-pass cfp-tn
754 (ash (tn-offset ocfp)
759 (move return-pc-pass return-pc t))
761 (inst lw return-pc-pass cfp-tn
762 (ash (tn-offset return-pc)
765 (inst addu nsp-tn cur-nfp
766 (bytes-needed-for-non-descriptor-stack-frame))))
768 (inst compute-lra-from-code
769 return-pc-pass code-tn lra-label temp))
771 (store-stack-tn nfp-save cur-nfp))
773 (move ocfp-pass cfp-tn t))
776 '(move cfp-tn new-fp)
777 '(if (> nargs register-arg-count)
779 (move cfp-tn csp-tn)))
780 (trace-table-entry trace-table-call-site))))
783 (insert-step-instrumenting (callable-tn)
784 ;; Conditionally insert a conditional trap:
785 (when step-instrumenting
786 (load-symbol-value stepping sb!impl::*stepping*)
787 ;; If it's not NIL, trap.
788 (inst beq stepping null-tn step-done-label)
790 ;; CONTEXT-PC will be pointing here when the
791 ;; interrupt is handled, not after the BREAK.
792 (note-this-location vop :step-before-vop)
793 ;; Construct a trap code with the low bits from
794 ;; SINGLE-STEP-AROUND-TRAP and the high bits from
795 ;; the register number of CALLABLE-TN.
796 (inst break 0 (logior single-step-around-trap
797 (ash (reg-tn-encoding callable-tn)
799 (emit-label step-done-label))))
803 (descriptor-reg (move name-pass name))
805 (inst lw name-pass cfp-tn
806 (ash (tn-offset name) word-shift))
809 (inst lw name-pass code-tn
810 (- (ash (tn-offset name) word-shift)
811 other-pointer-lowtag))
813 ;; The step instrumenting must be done after
814 ;; FUNCTION is loaded, but before ENTRY-POINT is
816 (insert-step-instrumenting name-pass)
817 (inst lw entry-point name-pass
818 (- (ash fdefn-raw-addr-slot word-shift)
819 other-pointer-lowtag))
822 (descriptor-reg (move lexenv arg-fun))
824 (inst lw lexenv cfp-tn
825 (ash (tn-offset arg-fun) word-shift))
828 (inst lw lexenv code-tn
829 (- (ash (tn-offset arg-fun) word-shift)
830 other-pointer-lowtag))
832 (inst lw function lexenv
833 (- (ash closure-fun-slot word-shift)
836 ;; The step instrumenting must be done before
837 ;; after FUNCTION is loaded, but before ENTRY-POINT
839 (insert-step-instrumenting function)
840 (inst addu entry-point function
841 (- (ash simple-fun-code-offset word-shift)
842 fun-pointer-lowtag))))
849 (note-this-location vop :call-site)
855 '((trace-table-entry trace-table-normal)
856 (emit-return-pc lra-label)
857 (default-unknown-values vop values nvals
858 move-temp temp lra-label)
860 (load-stack-tn cur-nfp nfp-save))))
862 '((trace-table-entry trace-table-normal)
863 (emit-return-pc lra-label)
864 (note-this-location vop :unknown-return)
865 (receive-unknown-values values-start nvals start count
868 (load-stack-tn cur-nfp nfp-save))))
872 (define-full-call call nil :fixed nil)
873 (define-full-call call-named t :fixed nil)
874 (define-full-call multiple-call nil :unknown nil)
875 (define-full-call multiple-call-named t :unknown nil)
876 (define-full-call tail-call nil :tail nil)
877 (define-full-call tail-call-named t :tail nil)
879 (define-full-call call-variable nil :fixed t)
880 (define-full-call multiple-call-variable nil :unknown t)
883 ;;; Defined separately, since needs special code that BLT's the arguments
886 (define-vop (tail-call-variable)
888 (args-arg :scs (any-reg) :target args)
889 (function-arg :scs (descriptor-reg) :target lexenv)
890 (ocfp-arg :scs (any-reg) :target ocfp)
891 (lra-arg :scs (descriptor-reg) :target lra))
893 (:temporary (:sc any-reg :offset nl0-offset :from (:argument 0)) args)
894 (:temporary (:sc any-reg :offset lexenv-offset :from (:argument 1)) lexenv)
895 (:temporary (:sc any-reg :offset ocfp-offset :from (:argument 2)) ocfp)
896 (:temporary (:sc any-reg :offset lra-offset :from (:argument 3)) lra)
902 ;; Move these into the passing locations if they are not already there.
904 (move lexenv function-arg)
908 ;; Clear the number stack if anything is there and jump to the
909 ;; assembly-routine that does the bliting.
910 (inst j (make-fixup 'tail-call-variable :assembly-routine))
911 (let ((cur-nfp (current-nfp-tn vop)))
913 (inst addu nsp-tn cur-nfp
914 (bytes-needed-for-non-descriptor-stack-frame))
918 ;;;; Unknown values return:
920 ;;; Return a single value using the unknown-values convention.
922 (define-vop (return-single)
923 (:args (ocfp :scs (any-reg))
924 (return-pc :scs (descriptor-reg))
927 (:temporary (:scs (interior-reg)) lip)
930 ;; Clear the number stack.
931 (trace-table-entry trace-table-fun-epilogue)
932 (let ((cur-nfp (current-nfp-tn vop)))
934 (inst addu nsp-tn cur-nfp
935 (bytes-needed-for-non-descriptor-stack-frame))))
936 ;; Clear the control stack, and restore the frame pointer.
940 (lisp-return return-pc lip :offset 2)
941 (trace-table-entry trace-table-normal)))
944 ;;; Do unknown-values return of a fixed number of values. The Values are
945 ;;; required to be set up in the standard passing locations. Nvals is the
946 ;;; number of values returned.
948 ;;; If returning a single value, then deallocate the current frame, restore
949 ;;; FP and jump to the single-value entry at Return-PC + 8.
951 ;;; If returning other than one value, then load the number of values returned,
952 ;;; NIL out unsupplied values registers, restore FP and return at Return-PC.
953 ;;; When there are stack values, we must initialize the argument pointer to
954 ;;; point to the beginning of the values block (which is the beginning of the
958 (:args (ocfp :scs (any-reg))
959 (return-pc :scs (descriptor-reg) :to (:eval 1))
963 (:temporary (:sc descriptor-reg :offset a0-offset :from (:eval 0)) a0)
964 (:temporary (:sc descriptor-reg :offset a1-offset :from (:eval 0)) a1)
965 (:temporary (:sc descriptor-reg :offset a2-offset :from (:eval 0)) a2)
966 (:temporary (:sc descriptor-reg :offset a3-offset :from (:eval 0)) a3)
967 (:temporary (:sc descriptor-reg :offset a4-offset :from (:eval 0)) a4)
968 (:temporary (:sc descriptor-reg :offset a5-offset :from (:eval 0)) a5)
969 (:temporary (:sc any-reg :offset nargs-offset) nargs)
970 (:temporary (:sc any-reg :offset ocfp-offset) val-ptr)
971 (:temporary (:scs (interior-reg)) lip)
974 ;; Clear the number stack.
975 (trace-table-entry trace-table-fun-epilogue)
976 (let ((cur-nfp (current-nfp-tn vop)))
978 (inst addu nsp-tn cur-nfp
979 (bytes-needed-for-non-descriptor-stack-frame))))
981 ;; Clear the control stack, and restore the frame pointer.
985 (lisp-return return-pc lip :offset 2))
987 ;; Establish the values pointer and values count.
988 (move val-ptr cfp-tn)
989 (inst li nargs (fixnumize nvals))
990 ;; restore the frame pointer and clear as much of the control
991 ;; stack as possible.
993 (inst addu csp-tn val-ptr (* nvals n-word-bytes))
994 ;; pre-default any argument register that need it.
995 (when (< nvals register-arg-count)
996 (dolist (reg (subseq (list a0 a1 a2 a3 a4 a5) nvals))
999 (lisp-return return-pc lip)))
1000 (trace-table-entry trace-table-normal)))
1002 ;;; Do unknown-values return of an arbitrary number of values (passed on the
1003 ;;; stack.) We check for the common case of a single return value, and do that
1004 ;;; inline using the normal single value return convention. Otherwise, we
1005 ;;; branch off to code that calls an assembly-routine.
1007 (define-vop (return-multiple)
1008 (:args (ocfp-arg :scs (any-reg) :target ocfp)
1009 (lra-arg :scs (descriptor-reg) :target lra)
1010 (vals-arg :scs (any-reg) :target vals)
1011 (nvals-arg :scs (any-reg) :target nvals))
1013 (:temporary (:sc any-reg :offset nl1-offset :from (:argument 0)) ocfp)
1014 (:temporary (:sc descriptor-reg :offset lra-offset :from (:argument 1)) lra)
1015 (:temporary (:sc any-reg :offset nl0-offset :from (:argument 2)) vals)
1016 (:temporary (:sc any-reg :offset nargs-offset :from (:argument 3)) nvals)
1017 (:temporary (:sc descriptor-reg :offset a0-offset) a0)
1018 (:temporary (:scs (interior-reg)) lip)
1023 (trace-table-entry trace-table-fun-epilogue)
1024 (let ((not-single (gen-label)))
1025 ;; Clear the number stack.
1026 (let ((cur-nfp (current-nfp-tn vop)))
1028 (inst addu nsp-tn cur-nfp
1029 (bytes-needed-for-non-descriptor-stack-frame))))
1031 ;; Check for the single case.
1032 (inst li a0 (fixnumize 1))
1033 (inst bne nvals-arg a0 not-single)
1034 (inst lw a0 vals-arg)
1036 ;; Return with one value.
1037 (move csp-tn cfp-tn)
1038 (move cfp-tn ocfp-arg)
1039 (lisp-return lra-arg lip :offset 2)
1041 ;; Nope, not the single case.
1042 (emit-label not-single)
1043 (move ocfp ocfp-arg)
1045 (move vals vals-arg)
1047 (inst j (make-fixup 'return-multiple :assembly-routine))
1048 (move nvals nvals-arg t))
1049 (trace-table-entry trace-table-normal)))
1056 ;;; We don't need to do anything special for regular functions.
1058 (define-vop (setup-environment)
1062 ;; Don't bother doing anything.
1065 ;;; Get the lexical environment from its passing location.
1067 (define-vop (setup-closure-environment)
1068 (:temporary (:sc descriptor-reg :offset lexenv-offset :target closure
1071 (:results (closure :scs (descriptor-reg)))
1076 (move closure lexenv)))
1078 ;;; Copy a more arg from the argument area to the end of the current frame.
1079 ;;; Fixed is the number of non-more arguments.
1081 (define-vop (copy-more-arg)
1082 (:temporary (:sc any-reg :offset nl0-offset) result)
1083 (:temporary (:sc any-reg :offset nl1-offset) count)
1084 (:temporary (:sc any-reg :offset nl2-offset) src)
1085 (:temporary (:sc any-reg :offset nl3-offset) dst)
1086 (:temporary (:sc descriptor-reg :offset l0-offset) temp)
1089 (let ((loop (gen-label))
1090 (do-regs (gen-label))
1092 (when (< fixed register-arg-count)
1093 ;; Save a pointer to the results so we can fill in register args.
1094 ;; We don't need this if there are more fixed args than reg args.
1095 (move result csp-tn))
1096 ;; Allocate the space on the stack.
1097 (cond ((zerop fixed)
1098 (inst beq nargs-tn done)
1099 (inst addu csp-tn csp-tn nargs-tn))
1101 (inst addu count nargs-tn (fixnumize (- fixed)))
1102 (inst blez count done)
1104 (inst addu csp-tn csp-tn count)))
1105 (when (< fixed register-arg-count)
1106 ;; We must stop when we run out of stack args, not when we run out of
1108 (inst addu count nargs-tn (fixnumize (- register-arg-count))))
1109 ;; Everything of interest in registers.
1110 (inst blez count do-regs)
1111 ;; Initialize dst to be end of stack.
1113 ;; Initialize src to be end of args.
1114 (inst addu src cfp-tn nargs-tn)
1117 ;; *--dst = *--src, --count
1118 (inst addu src src (- n-word-bytes))
1119 (inst addu count count (fixnumize -1))
1121 (inst addu dst dst (- n-word-bytes))
1122 (inst bgtz count loop)
1125 (emit-label do-regs)
1126 (when (< fixed register-arg-count)
1127 ;; Now we have to deposit any more args that showed up in registers.
1128 ;; We know there is at least one more arg, otherwise we would have
1129 ;; branched to done up at the top.
1130 (inst subu count nargs-tn (fixnumize (1+ fixed)))
1131 (do ((i fixed (1+ i)))
1132 ((>= i register-arg-count))
1133 ;; Is this the last one?
1134 (inst beq count done)
1135 ;; Store it relative to the pointer saved at the start.
1136 (storew (nth i *register-arg-tns*) result (- i fixed))
1138 (inst subu count (fixnumize 1))))
1139 (emit-label done))))
1142 ;;; More args are stored consecutively on the stack, starting
1143 ;;; immediately at the context pointer. The context pointer is not
1144 ;;; typed, so the lowtag is 0.
1145 (define-full-reffer more-arg * 0 0 (descriptor-reg any-reg) * %more-arg)
1147 ;;; Turn more arg (context, count) into a list.
1148 (define-vop (listify-rest-args)
1149 (:args (context-arg :target context :scs (descriptor-reg))
1150 (count-arg :target count :scs (any-reg)))
1151 (:arg-types * tagged-num)
1152 (:temporary (:scs (any-reg) :from (:argument 0)) context)
1153 (:temporary (:scs (any-reg) :from (:argument 1)) count)
1154 (:temporary (:scs (descriptor-reg) :from :eval) temp dst)
1155 (:temporary (:sc non-descriptor-reg :offset nl4-offset) pa-flag)
1156 (:results (result :scs (descriptor-reg)))
1157 (:translate %listify-rest-args)
1161 (let* ((enter (gen-label))
1164 (dx-p (node-stack-allocate-p node))
1165 (alloc-area-tn (if dx-p csp-tn alloc-tn)))
1166 (move context context-arg)
1167 (move count count-arg)
1168 ;; Check to see if there are any arguments.
1169 (inst beq count done)
1170 (move result null-tn t)
1172 ;; We need to do this atomically.
1173 (pseudo-atomic (pa-flag)
1176 ;; Allocate a cons (2 words) for each item.
1177 (inst srl result alloc-area-tn n-lowtag-bits)
1178 (inst sll result n-lowtag-bits)
1179 (inst or result list-pointer-lowtag)
1181 (inst sll temp count 1)
1183 (inst addu alloc-area-tn temp)
1185 ;; Store the current cons in the cdr of the previous cons.
1187 (inst addu dst dst (* 2 n-word-bytes))
1188 (storew dst dst -1 list-pointer-lowtag)
1192 (loadw temp context)
1193 (inst addu context n-word-bytes)
1195 ;; Dec count, and if != zero, go back for more.
1196 (inst addu count count (fixnumize -1))
1197 (inst bne count loop)
1199 ;; Store the value in the car (in delay slot)
1200 (storew temp dst 0 list-pointer-lowtag)
1202 ;; NIL out the last cons.
1203 (storew null-tn dst 1 list-pointer-lowtag))
1204 (emit-label done))))
1206 ;;; Return the location and size of the more arg glob created by Copy-More-Arg.
1207 ;;; Supplied is the total number of arguments supplied (originally passed in
1208 ;;; NARGS.) Fixed is the number of non-rest arguments.
1210 ;;; We must duplicate some of the work done by Copy-More-Arg, since at that
1211 ;;; time the environment is in a pretty brain-damaged state, preventing this
1212 ;;; info from being returned as values. What we do is compute
1213 ;;; supplied - fixed, and return a pointer that many words below the current
1216 (define-vop (more-arg-context)
1217 (:policy :fast-safe)
1218 (:translate sb!c::%more-arg-context)
1219 (:args (supplied :scs (any-reg)))
1220 (:arg-types tagged-num (:constant fixnum))
1222 (:results (context :scs (descriptor-reg))
1223 (count :scs (any-reg)))
1224 (:result-types t tagged-num)
1225 (:note "more-arg-context")
1227 (inst addu count supplied (fixnumize (- fixed)))
1228 (inst subu context csp-tn count)))
1231 ;;; Signal wrong argument count error if Nargs isn't = to Count.
1233 (define-vop (verify-arg-count)
1234 (:policy :fast-safe)
1235 (:translate sb!c::%verify-arg-count)
1236 (:args (nargs :scs (any-reg)))
1237 (:arg-types positive-fixnum (:constant t))
1238 (:temporary (:scs (any-reg) :type fixnum) temp)
1241 (:save-p :compute-only)
1244 (generate-error-code vop invalid-arg-count-error nargs)))
1245 (cond ((zerop count)
1246 (inst bne nargs err-lab)
1249 (inst li temp (fixnumize count))
1250 (inst bne nargs temp err-lab)
1253 ;;; Various other error signalers.
1255 (macrolet ((frob (name error translate &rest args)
1256 `(define-vop (,name)
1258 `((:policy :fast-safe)
1259 (:translate ,translate)))
1260 (:args ,@(mapcar #'(lambda (arg)
1261 `(,arg :scs (any-reg descriptor-reg)))
1264 (:save-p :compute-only)
1266 (error-call vop ,error ,@args)))))
1267 (frob arg-count-error invalid-arg-count-error
1268 sb!c::%arg-count-error nargs)
1269 (frob type-check-error object-not-type-error sb!c::%type-check-error
1271 (frob layout-invalid-error layout-invalid-error sb!c::%layout-invalid-error
1273 (frob odd-key-args-error odd-key-args-error
1274 sb!c::%odd-key-args-error)
1275 (frob unknown-key-arg-error unknown-key-arg-error
1276 sb!c::%unknown-key-arg-error key)
1277 (frob nil-fun-returned-error nil-fun-returned-error nil fun))
1281 (define-vop (step-instrument-before-vop)
1282 (:temporary (:scs (descriptor-reg)) stepping)
1283 (:policy :fast-safe)
1286 (load-symbol-value stepping sb!impl::*stepping*)
1287 ;; If it's not NIL, trap.
1288 (inst beq stepping null-tn DONE)
1290 ;; CONTEXT-PC will be pointing here when the interrupt is handled,
1291 ;; not after the BREAK.
1292 (note-this-location vop :step-before-vop)
1293 ;; CALLEE-REGISTER-OFFSET isn't needed for before-traps, so we
1294 ;; can just use a bare SINGLE-STEP-BEFORE-TRAP as the code.
1295 (inst break 0 single-step-before-trap)