2189b1e5c609e8a736a29df5be8696923ee5dade
[sbcl.git] / src / compiler / x86-64 / 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 :qword :base ptr :index offset :scale 1)))
122              (immediate
123               (inst lea res (make-ea :qword :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)))
162                     (:arg-types system-area-pointer signed-num)
163                     ,@(unless (eq size :qword)
164                         `((:temporary (:sc ,temp-sc
165                                        :from (:eval 0)
166                                        :to (:eval 1))
167                                       temp)))
168                     (:results (result :scs (,sc)))
169                     (:result-types ,type)
170                     (:generator 5
171                                 (inst mov ,(if (eq size :qword) 'result 'temp)
172                                       (make-ea ,size :base sap :index offset))
173                                 ,@(unless (eq size :qword)
174                                     `((inst ,(if signed 'movsx 'movzx)
175                                             result temp)))))
176                   (define-vop (,ref-name-c)
177                     (:translate ,ref-name)
178                     (:policy :fast-safe)
179                     (:args (sap :scs (sap-reg)))
180                     (:arg-types system-area-pointer
181                                 (:constant (signed-byte 64)))
182                     (:info offset)
183                     ,@(unless (eq size :qword)
184                         `((:temporary (:sc ,temp-sc
185                                        :from (:eval 0)
186                                        :to (:eval 1))
187                                       temp)))
188                     (:results (result :scs (,sc)))
189                     (:result-types ,type)
190                     (:generator 4
191                                 (inst mov ,(if (eq size :qword) 'result 'temp)
192                                       (make-ea ,size :base sap :disp offset))
193                                 ,@(unless (eq size :qword)
194                                     `((inst ,(if signed 'movsx 'movzx)
195                                             result temp)))))
196                   (define-vop (,set-name)
197                     (:translate ,set-name)
198                     (:policy :fast-safe)
199                     (:args (sap :scs (sap-reg) :to (:eval 0))
200                            (offset :scs (signed-reg) :to (:eval 0))
201                            (value :scs (,sc)
202                                   :target ,(if (eq size :qword)
203                                                'result
204                                                'temp)))
205                     (:arg-types system-area-pointer signed-num ,type)
206                     ,@(unless (eq size :qword)
207                         `((:temporary (:sc ,temp-sc :offset rax-offset
208                                            :from (:argument 2) :to (:result 0)
209                                            :target result)
210                                       temp)))
211                     (:results (result :scs (,sc)))
212                     (:result-types ,type)
213                     (:generator 5
214                                 ,@(unless (eq size :qword)
215                                     `((move rax-tn value)))
216                                 (inst mov (make-ea ,size
217                                                    :base sap
218                                                    :index offset)
219                                       ,(if (eq size :qword) 'value 'temp))
220                                 (move result
221                                       ,(if (eq size :qword) 'value 'rax-tn))))
222                   (define-vop (,set-name-c)
223                     (:translate ,set-name)
224                     (:policy :fast-safe)
225                     (:args (sap :scs (sap-reg) :to (:eval 0))
226                            (value :scs (,sc)
227                                   :target ,(if (eq size :qword)
228                                                'result
229                                                'temp)))
230                     (:arg-types system-area-pointer
231                                 (:constant (signed-byte 64)) ,type)
232                     (:info offset)
233                     ,@(unless (eq size :qword)
234                         `((:temporary (:sc ,temp-sc :offset rax-offset
235                                            :from (:argument 2) :to (:result 0)
236                                            :target result)
237                                       temp)))
238                     (:results (result :scs (,sc)))
239                     (:result-types ,type)
240                     (:generator 4
241                                 ,@(unless (eq size :qword)
242                                     `((move rax-tn value)))
243                                 (inst mov
244                                       (make-ea ,size :base sap :disp offset)
245                                       ,(if (eq size :qword) 'value 'temp))
246                                 (move result ,(if (eq size :qword)
247                                                   'value
248                                                   'rax-tn))))))))
249
250   (def-system-ref-and-set sap-ref-8 %set-sap-ref-8
251     unsigned-reg positive-fixnum :byte nil)
252   (def-system-ref-and-set signed-sap-ref-8 %set-signed-sap-ref-8
253     signed-reg tagged-num :byte t)
254   (def-system-ref-and-set sap-ref-16 %set-sap-ref-16
255     unsigned-reg positive-fixnum :word nil)
256   (def-system-ref-and-set signed-sap-ref-16 %set-signed-sap-ref-16
257     signed-reg tagged-num :word t)
258   (def-system-ref-and-set sap-ref-32 %set-sap-ref-32
259     unsigned-reg unsigned-num :dword nil)
260   (def-system-ref-and-set signed-sap-ref-32 %set-signed-sap-ref-32
261     signed-reg signed-num :dword t)
262   (def-system-ref-and-set sap-ref-64 %set-sap-ref-64
263     unsigned-reg unsigned-num :qword nil)
264   (def-system-ref-and-set signed-sap-ref-64 %set-signed-sap-ref-64
265     signed-reg signed-num :qword t)
266   (def-system-ref-and-set sap-ref-sap %set-sap-ref-sap
267     sap-reg system-area-pointer :qword))
268 \f
269 ;;;; SAP-REF-DOUBLE
270
271 (define-vop (sap-ref-double)
272   (:translate sap-ref-double)
273   (:policy :fast-safe)
274   (:args (sap :scs (sap-reg))
275          (offset :scs (signed-reg)))
276   (:arg-types system-area-pointer signed-num)
277   (:results (result :scs (double-reg)))
278   (:result-types double-float)
279   (:generator 5
280      (with-empty-tn@fp-top(result)
281         (inst fldd (make-ea :dword :base sap :index offset)))))
282
283 (define-vop (sap-ref-double-c)
284   (:translate sap-ref-double)
285   (:policy :fast-safe)
286   (:args (sap :scs (sap-reg)))
287   (:arg-types system-area-pointer (:constant (signed-byte 64)))
288   (:info offset)
289   (:results (result :scs (double-reg)))
290   (:result-types double-float)
291   (:generator 4
292      (with-empty-tn@fp-top(result)
293         (inst fldd (make-ea :dword :base sap :disp offset)))))
294
295 (define-vop (%set-sap-ref-double)
296   (:translate %set-sap-ref-double)
297   (:policy :fast-safe)
298   (:args (sap :scs (sap-reg) :to (:eval 0))
299          (offset :scs (signed-reg) :to (:eval 0))
300          (value :scs (double-reg)))
301   (:arg-types system-area-pointer signed-num double-float)
302   (:results (result :scs (double-reg)))
303   (:result-types double-float)
304   (:generator 5
305     (cond ((zerop (tn-offset value))
306            ;; Value is in ST0.
307            (inst fstd (make-ea :dword :base sap :index offset))
308            (unless (zerop (tn-offset result))
309                    ;; Value is in ST0 but not result.
310                    (inst fstd result)))
311           (t
312            ;; Value is not in ST0.
313            (inst fxch value)
314            (inst fstd (make-ea :dword :base sap :index offset))
315            (cond ((zerop (tn-offset result))
316                   ;; The result is in ST0.
317                   (inst fstd value))
318                  (t
319                   ;; Neither value or result are in ST0.
320                   (unless (location= value result)
321                           (inst fstd result))
322                   (inst fxch value)))))))
323
324 (define-vop (%set-sap-ref-double-c)
325   (:translate %set-sap-ref-double)
326   (:policy :fast-safe)
327   (:args (sap :scs (sap-reg) :to (:eval 0))
328          (value :scs (double-reg)))
329   (:arg-types system-area-pointer (:constant (signed-byte 64)) double-float)
330   (:info offset)
331   (:results (result :scs (double-reg)))
332   (:result-types double-float)
333   (:generator 4
334     (cond ((zerop (tn-offset value))
335            ;; Value is in ST0.
336            (inst fstd (make-ea :qword :base sap :disp offset))
337            (unless (zerop (tn-offset result))
338                    ;; Value is in ST0 but not result.
339                    (inst fstd result)))
340           (t
341            ;; Value is not in ST0.
342            (inst fxch value)
343            (inst fstd (make-ea :qword :base sap :disp offset))
344            (cond ((zerop (tn-offset result))
345                   ;; The result is in ST0.
346                   (inst fstd value))
347                  (t
348                   ;; Neither value or result are in ST0.
349                   (unless (location= value result)
350                           (inst fstd result))
351                   (inst fxch value)))))))
352 \f
353 ;;;; SAP-REF-SINGLE
354
355 (define-vop (sap-ref-single)
356   (:translate sap-ref-single)
357   (:policy :fast-safe)
358   (:args (sap :scs (sap-reg))
359          (offset :scs (signed-reg)))
360   (:arg-types system-area-pointer signed-num)
361   (:results (result :scs (single-reg)))
362   (:result-types single-float)
363   (:generator 5
364      (with-empty-tn@fp-top(result)
365         (inst fld (make-ea :dword :base sap :index offset)))))
366
367 (define-vop (sap-ref-single-c)
368   (:translate sap-ref-single)
369   (:policy :fast-safe)
370   (:args (sap :scs (sap-reg)))
371   (:arg-types system-area-pointer (:constant (signed-byte 32)))
372   (:info offset)
373   (:results (result :scs (single-reg)))
374   (:result-types single-float)
375   (:generator 4
376      (with-empty-tn@fp-top(result)
377         (inst fld (make-ea :dword :base sap :disp offset)))))
378
379 (define-vop (%set-sap-ref-single)
380   (:translate %set-sap-ref-single)
381   (:policy :fast-safe)
382   (:args (sap :scs (sap-reg) :to (:eval 0))
383          (offset :scs (signed-reg) :to (:eval 0))
384          (value :scs (single-reg)))
385   (:arg-types system-area-pointer signed-num single-float)
386   (:results (result :scs (single-reg)))
387   (:result-types single-float)
388   (:generator 5
389     (cond ((zerop (tn-offset value))
390            ;; Value is in ST0
391            (inst fst (make-ea :dword :base sap :index offset))
392            (unless (zerop (tn-offset result))
393                    ;; Value is in ST0 but not result.
394                    (inst fst result)))
395           (t
396            ;; Value is not in ST0.
397            (inst fxch value)
398            (inst fst (make-ea :dword :base sap :index offset))
399            (cond ((zerop (tn-offset result))
400                   ;; The result is in ST0.
401                   (inst fst value))
402                  (t
403                   ;; Neither value or result are in ST0
404                   (unless (location= value result)
405                           (inst fst result))
406                   (inst fxch value)))))))
407
408 (define-vop (%set-sap-ref-single-c)
409   (:translate %set-sap-ref-single)
410   (:policy :fast-safe)
411   (:args (sap :scs (sap-reg) :to (:eval 0))
412          (value :scs (single-reg)))
413   (:arg-types system-area-pointer (:constant (signed-byte 32)) single-float)
414   (:info offset)
415   (:results (result :scs (single-reg)))
416   (:result-types single-float)
417   (:generator 4
418     (cond ((zerop (tn-offset value))
419            ;; Value is in ST0
420            (inst fst (make-ea :dword :base sap :disp offset))
421            (unless (zerop (tn-offset result))
422                    ;; Value is in ST0 but not result.
423                    (inst fst result)))
424           (t
425            ;; Value is not in ST0.
426            (inst fxch value)
427            (inst fst (make-ea :dword :base sap :disp offset))
428            (cond ((zerop (tn-offset result))
429                   ;; The result is in ST0.
430                   (inst fst value))
431                  (t
432                   ;; Neither value or result are in ST0
433                   (unless (location= value result)
434                           (inst fst result))
435                   (inst fxch value)))))))
436 \f
437 ;;;; SAP-REF-LONG
438 #+nil
439 (define-vop (sap-ref-long)
440   (:translate sap-ref-long)
441   (:policy :fast-safe)
442   (:args (sap :scs (sap-reg))
443          (offset :scs (signed-reg)))
444   (:arg-types system-area-pointer signed-num)
445   (:results (result :scs (#!+long-float long-reg #!-long-float double-reg)))
446   (:result-types #!+long-float long-float #!-long-float double-float)
447   (:generator 5
448      (with-empty-tn@fp-top(result)
449         (inst fldl (make-ea :qword :base sap :index offset)))))
450 #+nil
451 (define-vop (sap-ref-long-c)
452   (:translate sap-ref-long)
453   (:policy :fast-safe)
454   (:args (sap :scs (sap-reg)))
455   (:arg-types system-area-pointer (:constant (signed-byte 64)))
456   (:info offset)
457   (:results (result :scs (#!+long-float long-reg #!-long-float double-reg)))
458   (:result-types #!+long-float long-float #!-long-float double-float)
459   (:generator 4
460      (with-empty-tn@fp-top(result)
461         (inst fldl (make-ea :qword :base sap :disp offset)))))
462
463 \f
464 ;;; noise to convert normal lisp data objects into SAPs
465
466 (define-vop (vector-sap)
467   (:translate vector-sap)
468   (:policy :fast-safe)
469   (:args (vector :scs (descriptor-reg) :target sap))
470   (:results (sap :scs (sap-reg)))
471   (:result-types system-area-pointer)
472   (:generator 2
473     (move sap vector)
474     (inst add
475           sap
476           (- (* vector-data-offset n-word-bytes) other-pointer-lowtag))))
477
478