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