1 ;;;; the definition of non-local exit for the x86 VM
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 ;;; Make an environment-live stack TN for saving the SP for NLX entry.
15 (!def-vm-support-routine make-nlx-sp-tn (env)
17 (make-representation-tn *fixnum-primitive-type* any-reg-sc-number)
20 ;;; Make a TN for the argument count passing location for a non-local entry.
21 (!def-vm-support-routine make-nlx-entry-arg-start-location ()
22 (make-wired-tn *fixnum-primitive-type* any-reg-sc-number ebx-offset))
24 (defun catch-block-ea (tn)
25 (aver (sc-is tn catch-block))
26 (make-ea :dword :base ebp-tn
27 :disp (frame-byte-offset (+ -1 (tn-offset tn) catch-block-size))))
30 ;;;; Save and restore dynamic environment.
32 ;;;; These VOPs are used in the reentered function to restore the
33 ;;;; appropriate dynamic environment. Currently we only save the
34 ;;;; Current-Catch and the alien stack pointer. (Before sbcl-0.7.0,
35 ;;;; when there were IR1 and byte interpreters, we had to save
36 ;;;; the interpreter "eval stack" too.)
38 ;;;; We don't need to save/restore the current UNWIND-PROTECT, since
39 ;;;; UNWIND-PROTECTs are implicitly processed during unwinding.
41 ;;;; We don't need to save the BSP, because that is handled automatically.
43 (define-vop (save-dynamic-state)
44 (:results (catch :scs (descriptor-reg))
45 (alien-stack :scs (descriptor-reg)))
47 (load-tl-symbol-value catch *current-catch-block*)
48 (load-tl-symbol-value alien-stack *alien-stack*)))
50 (define-vop (restore-dynamic-state)
51 (:args (catch :scs (descriptor-reg))
52 (alien-stack :scs (descriptor-reg)))
53 #!+sb-thread (:temporary (:sc unsigned-reg) temp)
55 (store-tl-symbol-value catch *current-catch-block* temp)
56 (store-tl-symbol-value alien-stack *alien-stack* temp)))
58 (define-vop (current-stack-pointer)
59 (:results (res :scs (any-reg control-stack)))
63 (define-vop (current-binding-pointer)
64 (:results (res :scs (any-reg descriptor-reg)))
66 (load-binding-stack-pointer res)))
68 ;;;; unwind block hackery
70 ;;; Compute the address of the catch block from its TN, then store into the
71 ;;; block the current Fp, Env, Unwind-Protect, and the entry PC.
72 (define-vop (make-unwind-block)
75 (:temporary (:sc unsigned-reg) temp)
76 (:results (block :scs (any-reg)))
78 (inst lea block (catch-block-ea tn))
79 (load-tl-symbol-value temp *current-unwind-protect-block*)
80 (storew temp block unwind-block-current-uwp-slot)
81 (storew ebp-tn block unwind-block-current-cont-slot)
82 (storew (make-fixup nil :code-object entry-label)
83 block catch-block-entry-pc-slot)
86 (inst mov temp (make-ea :dword :disp 0) :fs)
87 (storew temp block unwind-block-next-seh-frame-slot))))
89 ;;; like MAKE-UNWIND-BLOCK, except that we also store in the specified
90 ;;; tag, and link the block into the CURRENT-CATCH list
91 (define-vop (make-catch-block)
93 (tag :scs (any-reg descriptor-reg) :to (:result 1)))
95 (:results (block :scs (any-reg)))
96 (:temporary (:sc descriptor-reg) temp)
98 (inst lea block (catch-block-ea tn))
99 (load-tl-symbol-value temp *current-unwind-protect-block*)
100 (storew temp block unwind-block-current-uwp-slot)
101 (storew ebp-tn block unwind-block-current-cont-slot)
102 (storew (make-fixup nil :code-object entry-label)
103 block catch-block-entry-pc-slot)
106 (inst mov temp (make-ea :dword :disp 0) :fs)
107 (storew temp block unwind-block-next-seh-frame-slot))
108 (storew tag block catch-block-tag-slot)
109 (load-tl-symbol-value temp *current-catch-block*)
110 (storew temp block catch-block-previous-catch-slot)
111 (store-tl-symbol-value block *current-catch-block* temp)))
113 ;;; Just set the current unwind-protect to TN's address. This instantiates an
114 ;;; unwind block as an unwind-protect.
115 (define-vop (set-unwind-protect)
117 (:temporary (:sc unsigned-reg) new-uwp #!+sb-thread tls #!+win32 seh-frame)
119 (inst lea new-uwp (catch-block-ea tn))
122 (storew (make-fixup 'uwp-seh-handler :assembly-routine)
123 new-uwp unwind-block-seh-frame-handler-slot)
125 (make-ea-for-object-slot new-uwp
126 unwind-block-next-seh-frame-slot 0))
127 (inst mov (make-ea :dword :disp 0) seh-frame :fs))
128 (store-tl-symbol-value new-uwp *current-unwind-protect-block* tls)))
130 (define-vop (unlink-catch-block)
131 (:temporary (:sc unsigned-reg) #!+sb-thread tls block)
133 (:translate %catch-breakup)
135 (load-tl-symbol-value block *current-catch-block*)
136 (loadw block block catch-block-previous-catch-slot)
137 (store-tl-symbol-value block *current-catch-block* tls)))
139 (define-vop (unlink-unwind-protect)
140 ;; NOTE: When we have both #!+sb-thread and #!+win32, we only need one temp
141 (:temporary (:sc unsigned-reg) block #!+sb-thread tls #!+win32 seh-frame)
143 (:translate %unwind-protect-breakup)
145 (load-tl-symbol-value block *current-unwind-protect-block*)
148 (loadw seh-frame block unwind-block-next-seh-frame-slot)
149 (inst mov (make-ea :dword :disp 0) seh-frame :fs))
150 (loadw block block unwind-block-current-uwp-slot)
151 (store-tl-symbol-value block *current-unwind-protect-block* tls)))
154 (define-vop (nlx-entry)
155 ;; Note: we can't list an sc-restriction, 'cause any load vops would
156 ;; be inserted before the return-pc label.
160 (:results (values :more t))
161 (:temporary (:sc descriptor-reg) move-temp)
163 (:save-p :force-to-stack)
167 (note-this-location vop :non-local-entry)
168 (cond ((zerop nvals))
170 (let ((no-values (gen-label)))
171 (inst mov (tn-ref-tn values) nil-value)
172 (inst jecxz no-values)
173 (loadw (tn-ref-tn values) start -1)
174 (emit-label no-values)))
176 (collect ((defaults))
178 (tn-ref values (tn-ref-across tn-ref)))
180 (let ((default-lab (gen-label))
181 (tn (tn-ref-tn tn-ref)))
182 (defaults (cons default-lab tn))
184 (inst cmp count (fixnumize i))
185 (inst jmp :le default-lab)
187 ((descriptor-reg any-reg)
188 (loadw tn start (frame-word-offset i)))
190 (loadw move-temp start (frame-word-offset i))
191 (inst mov tn move-temp)))))
192 (let ((defaulting-done (gen-label)))
193 (emit-label defaulting-done)
194 (assemble (*elsewhere*)
195 (dolist (def (defaults))
196 (emit-label (car def))
197 (inst mov (cdr def) nil-value))
198 (inst jmp defaulting-done))))))
199 (inst mov esp-tn sp)))
201 (define-vop (nlx-entry-multiple)
205 ;; Again, no SC restrictions for the args, 'cause the loading would
206 ;; happen before the entry label.
208 (:temporary (:sc unsigned-reg :offset ecx-offset :from (:argument 2)) ecx)
209 (:temporary (:sc unsigned-reg :offset esi-offset) esi)
210 (:temporary (:sc unsigned-reg :offset edi-offset) edi)
211 (:results (result :scs (any-reg) :from (:argument 0))
212 (num :scs (any-reg control-stack)))
213 (:save-p :force-to-stack)
217 (note-this-location vop :non-local-entry)
219 (inst lea esi (make-ea :dword :base source :disp (- n-word-bytes)))
220 ;; The 'top' arg contains the %esp value saved at the time the
221 ;; catch block was created and points to where the thrown values
226 (inst sub edi n-word-bytes)
227 (move ecx count) ; fixnum words == bytes
229 (inst shr ecx word-shift) ; word count for <rep movs>
230 ;; If we got zero, we be done.
238 ;; Reset the CSP at last moved arg.
239 (inst lea esp-tn (make-ea :dword :base edi :disp n-word-bytes))))
242 ;;; This VOP is just to force the TNs used in the cleanup onto the stack.
243 (define-vop (uwp-entry)
245 (:save-p :force-to-stack)
246 (:results (block) (start) (count))
247 (:ignore block start count)
251 (note-this-location vop :non-local-entry)))
253 (define-vop (unwind-to-frame-and-call)
254 (:args (ofp :scs (descriptor-reg))
255 (uwp :scs (descriptor-reg))
256 (function :scs (descriptor-reg)))
257 (:arg-types system-area-pointer system-area-pointer t)
258 (:temporary (:sc sap-reg) temp)
259 (:temporary (:sc unsigned-reg :offset eax-offset) block)
261 ;; Store the function into a non-stack location, since we'll be
262 ;; unwinding the stack and destroying register contents before we
264 (store-tl-symbol-value function
265 *unwind-to-frame-function*
268 ;; Allocate space for magic UWP block.
269 (inst sub esp-tn unwind-block-size)
270 ;; Set up magic catch / UWP block.
272 (loadw temp uwp sap-pointer-slot other-pointer-lowtag)
273 (storew temp block unwind-block-current-uwp-slot)
274 (loadw temp ofp sap-pointer-slot other-pointer-lowtag)
275 (storew temp block unwind-block-current-cont-slot)
277 (storew (make-fixup nil :code-object entry-label)
279 catch-block-entry-pc-slot)
281 ;; Run any required UWPs.
282 (inst jmp (make-fixup 'unwind :assembly-routine))
285 ;; Load function from symbol
286 (load-tl-symbol-value block *unwind-to-frame-function*)
289 (inst xor ecx-tn ecx-tn)
293 (make-ea :dword :base ebp-tn :disp (* -3 n-word-bytes)))
295 ;; Push the return-pc so it looks like we just called.
299 (inst jmp (make-ea :dword :base block
300 :disp (- (* closure-fun-slot n-word-bytes)
301 fun-pointer-lowtag)))))