b1454a06cddb1d2879dec3466936888dd0665ac6
[sbcl.git] / src / compiler / x86 / sap.lisp
1 ;;;; SAP operations for the x86 VM
2
3 ;;;; This software is part of the SBCL system. See the README file for
4 ;;;; more information.
5 ;;;;
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
11
12 (in-package "SB!VM")
13 \f
14 ;;;; moves and coercions
15
16 ;;; Move a tagged SAP to an untagged representation.
17 (define-vop (move-to-sap)
18   (:args (x :scs (descriptor-reg)))
19   (:results (y :scs (sap-reg)))
20   (:note "pointer to SAP coercion")
21   (:generator 1
22     (loadw y x sap-pointer-slot other-pointer-lowtag)))
23 (define-move-vop move-to-sap :move
24   (descriptor-reg) (sap-reg))
25
26 ;;; Move an untagged SAP to a tagged representation.
27 (define-vop (move-from-sap)
28   (:args (sap :scs (sap-reg) :to :result))
29   (:results (res :scs (descriptor-reg) :from :argument))
30   (:note "SAP to pointer coercion")
31   (:node-var node)
32   (:generator 20
33     (with-fixed-allocation (res sap-widetag sap-size node)
34       (storew sap res sap-pointer-slot other-pointer-lowtag))))
35 (define-move-vop move-from-sap :move
36   (sap-reg) (descriptor-reg))
37
38 ;;; Move untagged sap values.
39 (define-vop (sap-move)
40   (:args (x :target y
41             :scs (sap-reg)
42             :load-if (not (location= x y))))
43   (:results (y :scs (sap-reg)
44                :load-if (not (location= x y))))
45   (:note "SAP move")
46   (:effects)
47   (:affected)
48   (:generator 0
49     (move y x)))
50 (define-move-vop sap-move :move
51   (sap-reg) (sap-reg))
52
53 ;;; Move untagged sap arguments/return-values.
54 (define-vop (move-sap-arg)
55   (:args (x :target y
56             :scs (sap-reg))
57          (fp :scs (any-reg)
58              :load-if (not (sc-is y sap-reg))))
59   (:results (y))
60   (:note "SAP argument move")
61   (:generator 0
62     (sc-case y
63       (sap-reg
64        (move y x))
65       (sap-stack
66        (if (= (tn-offset fp) esp-offset)
67            (storew x fp (tn-offset y))  ; c-call
68            (storew x fp (- (1+ (tn-offset y)))))))))
69 (define-move-vop move-sap-arg :move-arg
70   (descriptor-reg sap-reg) (sap-reg))
71
72 ;;; Use standard MOVE-ARG + coercion to move an untagged sap to a
73 ;;; descriptor passing location.
74 (define-move-vop move-arg :move-arg
75   (sap-reg) (descriptor-reg))
76 \f
77 ;;;; SAP-INT and INT-SAP
78
79 ;;; The function SAP-INT is used to generate an integer corresponding
80 ;;; to the system area pointer, suitable for passing to the kernel
81 ;;; interfaces (which want all addresses specified as integers). The
82 ;;; function INT-SAP is used to do the opposite conversion. The
83 ;;; integer representation of a SAP is the byte offset of the SAP from
84 ;;; the start of the address space.
85 (define-vop (sap-int)
86   (:args (sap :scs (sap-reg) :target int))
87   (:arg-types system-area-pointer)
88   (:results (int :scs (unsigned-reg)))
89   (:result-types unsigned-num)
90   (:translate sap-int)
91   (:policy :fast-safe)
92   (:generator 1
93     (move int sap)))
94 (define-vop (int-sap)
95   (:args (int :scs (unsigned-reg) :target sap))
96   (:arg-types unsigned-num)
97   (:results (sap :scs (sap-reg)))
98   (:result-types system-area-pointer)
99   (:translate int-sap)
100   (:policy :fast-safe)
101   (:generator 1
102     (move sap int)))
103 \f
104 ;;;; POINTER+ and POINTER-
105
106 (define-vop (pointer+)
107   (:translate sap+)
108   (:args (ptr :scs (sap-reg) :target res
109               :load-if (not (location= ptr res)))
110          (offset :scs (signed-reg immediate)))
111   (:arg-types system-area-pointer signed-num)
112   (:results (res :scs (sap-reg) :from (:argument 0)
113                  :load-if (not (location= ptr res))))
114   (:result-types system-area-pointer)
115   (:policy :fast-safe)
116   (:generator 1
117     (cond ((and (sc-is ptr sap-reg) (sc-is res sap-reg)
118                 (not (location= ptr res)))
119            (sc-case offset
120              (signed-reg
121               (inst lea res (make-ea :dword :base ptr :index offset :scale 1)))
122              (immediate
123               (inst lea res (make-ea :dword :base ptr
124                                      :disp (tn-value offset))))))
125           (t
126            (move res ptr)
127            (sc-case offset
128              (signed-reg
129               (inst add res offset))
130              (immediate
131               (inst add res (tn-value offset))))))))
132
133 (define-vop (pointer-)
134   (:translate sap-)
135   (:args (ptr1 :scs (sap-reg) :target res)
136          (ptr2 :scs (sap-reg)))
137   (:arg-types system-area-pointer system-area-pointer)
138   (:policy :fast-safe)
139   (:results (res :scs (signed-reg) :from (:argument 0)))
140   (:result-types signed-num)
141   (:generator 1
142     (move res ptr1)
143     (inst sub res ptr2)))
144 \f
145 ;;;; mumble-SYSTEM-REF and mumble-SYSTEM-SET
146
147 (macrolet ((def-system-ref-and-set (ref-name
148                                     set-name
149                                     sc
150                                     type
151                                     size
152                                     &optional signed)
153              (let ((ref-name-c (symbolicate ref-name "-C"))
154                    (set-name-c (symbolicate set-name "-C"))
155                    (temp-sc (symbolicate size "-REG")))
156                `(progn
157                   (define-vop (,ref-name)
158                     (:translate ,ref-name)
159                     (:policy :fast-safe)
160                     (:args (sap :scs (sap-reg))
161                            (offset :scs (signed-reg immediate)))
162                     (:arg-types system-area-pointer signed-num)
163                     (:results (result :scs (,sc)))
164                     (:result-types ,type)
165                     (:generator 5
166                       ,(let ((mov-inst (cond
167                                          ((eq size :dword) 'mov)
168                                          (signed 'movsx)
169                                          (t 'movzx))))
170                          `(sc-case offset
171                             (immediate
172                              (inst ,mov-inst result
173                                    (make-ea ,size :base sap
174                                             :disp (tn-value offset))))
175                             (t (inst ,mov-inst result
176                                      (make-ea ,size :base sap
177                                               :index offset)))))))
178                   (define-vop (,set-name)
179                     (:translate ,set-name)
180                     (:policy :fast-safe)
181                     (:args (sap :scs (sap-reg) :to (:eval 0))
182                            (offset :scs (signed-reg immediate) :to (:eval 0))
183                            (value :scs (,sc)
184                                   :target ,(if (eq size :dword)
185                                                'result
186                                                'temp)))
187                     (:arg-types system-area-pointer signed-num ,type)
188                     ,@(unless (eq size :dword)
189                         `((:temporary (:sc ,temp-sc :offset eax-offset
190                                            :from (:argument 2) :to (:result 0)
191                                            :target result)
192                                       temp)))
193                     (:results (result :scs (,sc)))
194                     (:result-types ,type)
195                     (:generator 5
196                                 ,@(unless (eq size :dword)
197                                     `((move eax-tn value)))
198                                 (inst mov (sc-case offset
199                                             (immediate
200                                              (make-ea ,size :base sap
201                                                       :disp (tn-value offset)))
202                                             (t (make-ea ,size
203                                                         :base sap
204                                                         :index offset)))
205                                       ,(if (eq size :dword) 'value 'temp))
206                                 (move result
207                                       ,(if (eq size :dword) 'value 'eax-tn))))))))
208
209   (def-system-ref-and-set sap-ref-8 %set-sap-ref-8
210     unsigned-reg positive-fixnum :byte nil)
211   (def-system-ref-and-set signed-sap-ref-8 %set-signed-sap-ref-8
212     signed-reg tagged-num :byte t)
213   (def-system-ref-and-set sap-ref-16 %set-sap-ref-16
214     unsigned-reg positive-fixnum :word nil)
215   (def-system-ref-and-set signed-sap-ref-16 %set-signed-sap-ref-16
216     signed-reg tagged-num :word t)
217   (def-system-ref-and-set sap-ref-32 %set-sap-ref-32
218     unsigned-reg unsigned-num :dword nil)
219   (def-system-ref-and-set signed-sap-ref-32 %set-signed-sap-ref-32
220     signed-reg signed-num :dword t)
221   (def-system-ref-and-set sap-ref-sap %set-sap-ref-sap
222     sap-reg system-area-pointer :dword))
223 \f
224 ;;;; SAP-REF-DOUBLE
225
226 (define-vop (sap-ref-double)
227   (:translate sap-ref-double)
228   (:policy :fast-safe)
229   (:args (sap :scs (sap-reg))
230          (offset :scs (signed-reg)))
231   (:arg-types system-area-pointer signed-num)
232   (:results (result :scs (double-reg)))
233   (:result-types double-float)
234   (:generator 5
235      (with-empty-tn@fp-top(result)
236         (inst fldd (make-ea :dword :base sap :index offset)))))
237
238 (define-vop (sap-ref-double-c)
239   (:translate sap-ref-double)
240   (:policy :fast-safe)
241   (:args (sap :scs (sap-reg)))
242   (:arg-types system-area-pointer (:constant (signed-byte 32)))
243   (:info offset)
244   (:results (result :scs (double-reg)))
245   (:result-types double-float)
246   (:generator 4
247      (with-empty-tn@fp-top(result)
248         (inst fldd (make-ea :dword :base sap :disp offset)))))
249
250 (define-vop (%set-sap-ref-double)
251   (:translate %set-sap-ref-double)
252   (:policy :fast-safe)
253   (:args (sap :scs (sap-reg) :to (:eval 0))
254          (offset :scs (signed-reg) :to (:eval 0))
255          (value :scs (double-reg)))
256   (:arg-types system-area-pointer signed-num double-float)
257   (:results (result :scs (double-reg)))
258   (:result-types double-float)
259   (:generator 5
260     (cond ((zerop (tn-offset value))
261            ;; Value is in ST0.
262            (inst fstd (make-ea :dword :base sap :index offset))
263            (unless (zerop (tn-offset result))
264                    ;; Value is in ST0 but not result.
265                    (inst fstd result)))
266           (t
267            ;; Value is not in ST0.
268            (inst fxch value)
269            (inst fstd (make-ea :dword :base sap :index offset))
270            (cond ((zerop (tn-offset result))
271                   ;; The result is in ST0.
272                   (inst fstd value))
273                  (t
274                   ;; Neither value or result are in ST0.
275                   (unless (location= value result)
276                           (inst fstd result))
277                   (inst fxch value)))))))
278
279 (define-vop (%set-sap-ref-double-c)
280   (:translate %set-sap-ref-double)
281   (:policy :fast-safe)
282   (:args (sap :scs (sap-reg) :to (:eval 0))
283          (value :scs (double-reg)))
284   (:arg-types system-area-pointer (:constant (signed-byte 32)) double-float)
285   (:info offset)
286   (:results (result :scs (double-reg)))
287   (:result-types double-float)
288   (:generator 4
289     (cond ((zerop (tn-offset value))
290            ;; Value is in ST0.
291            (inst fstd (make-ea :dword :base sap :disp offset))
292            (unless (zerop (tn-offset result))
293                    ;; Value is in ST0 but not result.
294                    (inst fstd result)))
295           (t
296            ;; Value is not in ST0.
297            (inst fxch value)
298            (inst fstd (make-ea :dword :base sap :disp offset))
299            (cond ((zerop (tn-offset result))
300                   ;; The result is in ST0.
301                   (inst fstd value))
302                  (t
303                   ;; Neither value or result are in ST0.
304                   (unless (location= value result)
305                           (inst fstd result))
306                   (inst fxch value)))))))
307 \f
308 ;;;; SAP-REF-SINGLE
309
310 (define-vop (sap-ref-single)
311   (:translate sap-ref-single)
312   (:policy :fast-safe)
313   (:args (sap :scs (sap-reg))
314          (offset :scs (signed-reg)))
315   (:arg-types system-area-pointer signed-num)
316   (:results (result :scs (single-reg)))
317   (:result-types single-float)
318   (:generator 5
319      (with-empty-tn@fp-top(result)
320         (inst fld (make-ea :dword :base sap :index offset)))))
321
322 (define-vop (sap-ref-single-c)
323   (:translate sap-ref-single)
324   (:policy :fast-safe)
325   (:args (sap :scs (sap-reg)))
326   (:arg-types system-area-pointer (:constant (signed-byte 32)))
327   (:info offset)
328   (:results (result :scs (single-reg)))
329   (:result-types single-float)
330   (:generator 4
331      (with-empty-tn@fp-top(result)
332         (inst fld (make-ea :dword :base sap :disp offset)))))
333
334 (define-vop (%set-sap-ref-single)
335   (:translate %set-sap-ref-single)
336   (:policy :fast-safe)
337   (:args (sap :scs (sap-reg) :to (:eval 0))
338          (offset :scs (signed-reg) :to (:eval 0))
339          (value :scs (single-reg)))
340   (:arg-types system-area-pointer signed-num single-float)
341   (:results (result :scs (single-reg)))
342   (:result-types single-float)
343   (:generator 5
344     (cond ((zerop (tn-offset value))
345            ;; Value is in ST0
346            (inst fst (make-ea :dword :base sap :index offset))
347            (unless (zerop (tn-offset result))
348                    ;; Value is in ST0 but not result.
349                    (inst fst result)))
350           (t
351            ;; Value is not in ST0.
352            (inst fxch value)
353            (inst fst (make-ea :dword :base sap :index offset))
354            (cond ((zerop (tn-offset result))
355                   ;; The result is in ST0.
356                   (inst fst value))
357                  (t
358                   ;; Neither value or result are in ST0
359                   (unless (location= value result)
360                           (inst fst result))
361                   (inst fxch value)))))))
362
363 (define-vop (%set-sap-ref-single-c)
364   (:translate %set-sap-ref-single)
365   (:policy :fast-safe)
366   (:args (sap :scs (sap-reg) :to (:eval 0))
367          (value :scs (single-reg)))
368   (:arg-types system-area-pointer (:constant (signed-byte 32)) single-float)
369   (:info offset)
370   (:results (result :scs (single-reg)))
371   (:result-types single-float)
372   (:generator 4
373     (cond ((zerop (tn-offset value))
374            ;; Value is in ST0
375            (inst fst (make-ea :dword :base sap :disp offset))
376            (unless (zerop (tn-offset result))
377                    ;; Value is in ST0 but not result.
378                    (inst fst result)))
379           (t
380            ;; Value is not in ST0.
381            (inst fxch value)
382            (inst fst (make-ea :dword :base sap :disp offset))
383            (cond ((zerop (tn-offset result))
384                   ;; The result is in ST0.
385                   (inst fst value))
386                  (t
387                   ;; Neither value or result are in ST0
388                   (unless (location= value result)
389                           (inst fst result))
390                   (inst fxch value)))))))
391 \f
392 ;;;; SAP-REF-LONG
393
394 (define-vop (sap-ref-long)
395   (:translate sap-ref-long)
396   (:policy :fast-safe)
397   (:args (sap :scs (sap-reg))
398          (offset :scs (signed-reg)))
399   (:arg-types system-area-pointer signed-num)
400   (:results (result :scs (#!+long-float long-reg #!-long-float double-reg)))
401   (:result-types #!+long-float long-float #!-long-float double-float)
402   (:generator 5
403      (with-empty-tn@fp-top(result)
404         (inst fldl (make-ea :dword :base sap :index offset)))))
405
406 (define-vop (sap-ref-long-c)
407   (:translate sap-ref-long)
408   (:policy :fast-safe)
409   (:args (sap :scs (sap-reg)))
410   (:arg-types system-area-pointer (:constant (signed-byte 32)))
411   (:info offset)
412   (:results (result :scs (#!+long-float long-reg #!-long-float double-reg)))
413   (:result-types #!+long-float long-float #!-long-float double-float)
414   (:generator 4
415      (with-empty-tn@fp-top(result)
416         (inst fldl (make-ea :dword :base sap :disp offset)))))
417
418 #!+long-float
419 (define-vop (%set-sap-ref-long)
420   (:translate %set-sap-ref-long)
421   (:policy :fast-safe)
422   (:args (sap :scs (sap-reg) :to (:eval 0))
423          (offset :scs (signed-reg) :to (:eval 0))
424          (value :scs (long-reg)))
425   (:arg-types system-area-pointer signed-num long-float)
426   (:results (result :scs (long-reg)))
427   (:result-types long-float)
428   (:generator 5
429     (cond ((zerop (tn-offset value))
430            ;; Value is in ST0
431            (store-long-float (make-ea :dword :base sap :index offset))
432            (unless (zerop (tn-offset result))
433              ;; Value is in ST0 but not result.
434              (inst fstd result)))
435           (t
436            ;; Value is not in ST0.
437            (inst fxch value)
438            (store-long-float (make-ea :dword :base sap :index offset))
439            (cond ((zerop (tn-offset result))
440                   ;; The result is in ST0.
441                   (inst fstd value))
442                  (t
443                   ;; Neither value or result are in ST0
444                   (unless (location= value result)
445                     (inst fstd result))
446                   (inst fxch value)))))))
447 \f
448 ;;; noise to convert normal lisp data objects into SAPs
449
450 (define-vop (vector-sap)
451   (:translate vector-sap)
452   (:policy :fast-safe)
453   (:args (vector :scs (descriptor-reg) :target sap))
454   (:results (sap :scs (sap-reg)))
455   (:result-types system-area-pointer)
456   (:generator 2
457     (move sap vector)
458     (inst add
459           sap
460           (- (* vector-data-offset n-word-bytes) other-pointer-lowtag))))
461
462 ;;; Transforms for 64-bit SAP accessors.
463
464 (deftransform sap-ref-64 ((sap offset) (* *))
465   '(logior (sap-ref-32 sap offset)
466            (ash (sap-ref-32 sap (+ offset 4)) 32)))
467
468 (deftransform signed-sap-ref-64 ((sap offset) (* *))
469   '(logior (sap-ref-32 sap offset)
470            (ash (signed-sap-ref-32 sap (+ offset 4)) 32)))
471
472 (deftransform %set-sap-ref-64 ((sap offset value) (* * *))
473   '(progn
474      (%set-sap-ref-32 sap offset (logand value #xffffffff))
475      (%set-sap-ref-32 sap (+ offset 4) (ash value -32))))
476
477 (deftransform %set-signed-sap-ref-64 ((sap offset value) (* * *))
478   '(progn
479      (%set-sap-ref-32 sap offset (logand value #xffffffff))
480      (%set-signed-sap-ref-32 sap (+ offset 4) (ash value -32))))