63a74ef9e1bf1fa2f3e438306de14a1af1d1cb9c
[sbcl.git] / src / compiler / x86 / cell.lisp
1 ;;;; various primitive memory access VOPs 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 ;;;; data object ref/set stuff
15
16 (define-vop (slot)
17   (:args (object :scs (descriptor-reg)))
18   (:info name offset lowtag)
19   (:ignore name)
20   (:results (result :scs (descriptor-reg any-reg)))
21   (:generator 1
22     (loadw result object offset lowtag)))
23
24 (define-vop (set-slot)
25   (:args (object :scs (descriptor-reg))
26          (value :scs (descriptor-reg any-reg immediate)))
27   (:info name offset lowtag)
28   (:ignore name)
29   (:results)
30   (:generator 1
31      (if (sc-is value immediate)
32         (let ((val (tn-value value)))
33            (etypecase val
34               (integer
35                (inst mov
36                      (make-ea :dword :base object
37                               :disp (- (* offset n-word-bytes) lowtag))
38                      (fixnumize val)))
39               (symbol
40                (inst mov
41                      (make-ea :dword :base object
42                               :disp (- (* offset n-word-bytes) lowtag))
43                      (+ nil-value (static-symbol-offset val))))
44               (character
45                (inst mov
46                      (make-ea :dword :base object
47                               :disp (- (* offset n-word-bytes) lowtag))
48                      (logior (ash (char-code val) n-widetag-bits)
49                              character-widetag)))))
50        ;; Else, value not immediate.
51        (storew value object offset lowtag))))
52 \f
53
54
55 ;;;; symbol hacking VOPs
56
57 ;;; these next two cf the sparc version, by jrd.
58 ;;; FIXME: Deref this ^ reference.
59
60
61 ;;; The compiler likes to be able to directly SET symbols.
62 #!+sb-thread
63 (define-vop (set)
64   (:args (symbol :scs (descriptor-reg))
65          (value :scs (descriptor-reg any-reg)))
66   (:temporary (:sc descriptor-reg) tls)
67   ;;(:policy :fast-safe)
68   (:generator 4
69     (let ((global-val (gen-label))
70           (done (gen-label)))
71       (loadw tls symbol symbol-tls-index-slot other-pointer-lowtag)
72       (inst or tls tls)
73       (inst jmp :z global-val)
74       (inst fs-segment-prefix)
75       (inst cmp (make-ea :dword :scale 1 :index tls) unbound-marker-widetag)
76       (inst jmp :z global-val)
77       (inst fs-segment-prefix)
78       (inst mov (make-ea :dword :scale 1 :index tls) value)
79       (inst jmp done)
80       (emit-label global-val)
81       (storew value symbol symbol-value-slot other-pointer-lowtag)
82       (emit-label done))))
83
84 ;; unithreaded it's a lot simpler ...
85 #!-sb-thread 
86 (define-vop (set cell-set)
87   (:variant symbol-value-slot other-pointer-lowtag))
88
89 ;;; Do a cell ref with an error check for being unbound.
90 ;;; XXX stil used? I can't see where -dan
91 (define-vop (checked-cell-ref)
92   (:args (object :scs (descriptor-reg) :target obj-temp))
93   (:results (value :scs (descriptor-reg any-reg)))
94   (:policy :fast-safe)
95   (:vop-var vop)
96   (:save-p :compute-only)
97   (:temporary (:sc descriptor-reg :from (:argument 0)) obj-temp))
98
99 ;;; With Symbol-Value, we check that the value isn't the trap object. So
100 ;;; Symbol-Value of NIL is NIL.
101 #!+sb-thread
102 (define-vop (symbol-value)
103   (:translate symbol-value)
104   (:policy :fast-safe)
105   (:args (object :scs (descriptor-reg) :to (:result 1)))
106   (:results (value :scs (descriptor-reg any-reg)))
107   (:vop-var vop)
108   (:save-p :compute-only)
109   (:generator 9
110     (let* ((err-lab (generate-error-code vop unbound-symbol-error object))
111            (ret-lab (gen-label)))
112       (loadw value object symbol-tls-index-slot other-pointer-lowtag)
113       (inst fs-segment-prefix)
114       (inst mov value (make-ea :dword :index value :scale 1))
115       (inst cmp value unbound-marker-widetag)
116       (inst jmp :ne ret-lab)
117       (loadw value object symbol-value-slot other-pointer-lowtag)
118       (inst cmp value unbound-marker-widetag)
119       (inst jmp :e err-lab)
120       (emit-label ret-lab))))
121
122 #!+sb-thread
123 (define-vop (fast-symbol-value symbol-value)
124   ;; KLUDGE: not really fast, in fact, because we're going to have to
125   ;; do a full lookup of the thread-local area anyway.  But half of
126   ;; the meaning of FAST-SYMBOL-VALUE is "do not signal an error if
127   ;; unbound", which is used in the implementation of COPY-SYMBOL.  --
128   ;; CSR, 2003-04-22
129   (:policy :fast)
130   (:translate symbol-value)
131   (:generator 8
132     (let ((ret-lab (gen-label)))
133       (loadw value object symbol-tls-index-slot other-pointer-lowtag)
134       (inst fs-segment-prefix)
135       (inst mov value (make-ea :dword :index value :scale 1))
136       (inst cmp value unbound-marker-widetag)
137       (inst jmp :ne ret-lab)
138       (loadw value object symbol-value-slot other-pointer-lowtag)
139       (emit-label ret-lab))))
140
141 #!-sb-thread
142 (define-vop (symbol-value)
143   (:translate symbol-value)
144   (:policy :fast-safe)
145   (:args (object :scs (descriptor-reg) :to (:result 1)))
146   (:results (value :scs (descriptor-reg any-reg)))
147   (:vop-var vop)
148   (:save-p :compute-only)
149   (:generator 9
150     (let ((err-lab (generate-error-code vop unbound-symbol-error object)))
151       (loadw value object symbol-value-slot other-pointer-lowtag)
152       (inst cmp value unbound-marker-widetag)
153       (inst jmp :e err-lab))))
154
155 #!-sb-thread
156 (define-vop (fast-symbol-value cell-ref)
157   (:variant symbol-value-slot other-pointer-lowtag)
158   (:policy :fast)
159   (:translate symbol-value))
160
161 (defknown locked-symbol-global-value-add (symbol fixnum) fixnum ())
162
163 (define-vop (locked-symbol-global-value-add)
164     (:args (object :scs (descriptor-reg) :to :result)
165            (value :scs (any-reg) :target result))
166   (:arg-types * tagged-num)
167   (:results (result :scs (any-reg) :from (:argument 1)))
168   (:policy :fast)
169   (:translate locked-symbol-global-value-add)
170   (:result-types tagged-num)
171   (:policy :fast-safe)
172   (:generator 4
173     (move result value)
174     (inst lock)
175     (inst add (make-ea :dword :base object
176                        :disp (- (* symbol-value-slot n-word-bytes)
177                                 other-pointer-lowtag))
178           value)))
179
180 #!+sb-thread
181 (define-vop (boundp)
182   (:translate boundp)
183   (:policy :fast-safe)
184   (:args (object :scs (descriptor-reg)))
185   (:conditional)
186   (:info target not-p)
187   (:temporary (:sc descriptor-reg #+nil(:from (:argument 0))) value)
188   (:generator 9
189     (if not-p
190         (let ((not-target (gen-label)))
191           (loadw value object symbol-value-slot other-pointer-lowtag)
192           (inst cmp value unbound-marker-widetag)
193           (inst jmp :ne not-target)
194           (loadw value object symbol-tls-index-slot other-pointer-lowtag)
195           (inst fs-segment-prefix)
196           (inst cmp (make-ea :dword :index value :scale 1) unbound-marker-widetag)
197           (inst jmp  :e  target)
198           (emit-label not-target))
199         (progn
200           (loadw value object symbol-value-slot other-pointer-lowtag)
201           (inst cmp value unbound-marker-widetag)
202           (inst jmp :ne target)
203           (loadw value object symbol-tls-index-slot other-pointer-lowtag)
204           (inst fs-segment-prefix)
205           (inst cmp (make-ea :dword :index value :scale 1) unbound-marker-widetag)
206           (inst jmp  :ne  target)))))
207
208 #!-sb-thread
209 (define-vop (boundp)
210   (:translate boundp)
211   (:policy :fast-safe)
212   (:args (object :scs (descriptor-reg)))
213   (:conditional)
214   (:info target not-p)
215   (:temporary (:sc descriptor-reg :from (:argument 0)) value)
216   (:generator 9
217     (loadw value object symbol-value-slot other-pointer-lowtag)
218     (inst cmp value unbound-marker-widetag)
219     (inst jmp (if not-p :e :ne) target)))
220
221
222 (define-vop (symbol-hash)
223   (:policy :fast-safe)
224   (:translate symbol-hash)
225   (:args (symbol :scs (descriptor-reg)))
226   (:results (res :scs (any-reg)))
227   (:result-types positive-fixnum)
228   (:generator 2
229     ;; The symbol-hash slot of NIL holds NIL because it is also the
230     ;; cdr slot, so we have to strip off the two low bits to make sure
231     ;; it is a fixnum.  The lowtag selection magic that is required to
232     ;; ensure this is explained in the comment in objdef.lisp
233     (loadw res symbol symbol-hash-slot other-pointer-lowtag)
234     (inst and res (lognot #b11))))
235 \f
236 ;;;; fdefinition (FDEFN) objects
237
238 (define-vop (fdefn-fun cell-ref)        ; /pfw - alpha
239   (:variant fdefn-fun-slot other-pointer-lowtag))
240
241 (define-vop (safe-fdefn-fun)
242   (:args (object :scs (descriptor-reg) :to (:result 1)))
243   (:results (value :scs (descriptor-reg any-reg)))
244   (:vop-var vop)
245   (:save-p :compute-only)
246   (:generator 10
247     (loadw value object fdefn-fun-slot other-pointer-lowtag)
248     (inst cmp value nil-value)
249     (let ((err-lab (generate-error-code vop undefined-fun-error object)))
250       (inst jmp :e err-lab))))
251
252 (define-vop (set-fdefn-fun)
253   (:policy :fast-safe)
254   (:translate (setf fdefn-fun))
255   (:args (function :scs (descriptor-reg) :target result)
256          (fdefn :scs (descriptor-reg)))
257   (:temporary (:sc unsigned-reg) raw)
258   (:temporary (:sc byte-reg) type)
259   (:results (result :scs (descriptor-reg)))
260   (:generator 38
261     (load-type type function (- fun-pointer-lowtag))
262     (inst lea raw
263           (make-ea :byte :base function
264                    :disp (- (* simple-fun-code-offset n-word-bytes)
265                             fun-pointer-lowtag)))
266     (inst cmp type simple-fun-header-widetag)
267     (inst jmp :e normal-fn)
268     (inst lea raw (make-fixup "closure_tramp" :foreign))
269     NORMAL-FN
270     (storew function fdefn fdefn-fun-slot other-pointer-lowtag)
271     (storew raw fdefn fdefn-raw-addr-slot other-pointer-lowtag)
272     (move result function)))
273
274 (define-vop (fdefn-makunbound)
275   (:policy :fast-safe)
276   (:translate fdefn-makunbound)
277   (:args (fdefn :scs (descriptor-reg) :target result))
278   (:results (result :scs (descriptor-reg)))
279   (:generator 38
280     (storew nil-value fdefn fdefn-fun-slot other-pointer-lowtag)
281     (storew (make-fixup "undefined_tramp" :foreign)
282             fdefn fdefn-raw-addr-slot other-pointer-lowtag)
283     (move result fdefn)))
284 \f
285 ;;;; binding and unbinding
286
287 ;;; BIND -- Establish VAL as a binding for SYMBOL. Save the old value and
288 ;;; the symbol on the binding stack and stuff the new value into the
289 ;;; symbol.
290
291 #!+sb-thread
292 (define-vop (bind)
293   (:args (val :scs (any-reg descriptor-reg))
294          (symbol :scs (descriptor-reg)))
295   (:temporary (:sc unsigned-reg) tls-index temp bsp)
296   (:generator 5
297     (let ((tls-index-valid (gen-label)))
298       (load-tl-symbol-value bsp *binding-stack-pointer*)
299       (loadw tls-index symbol symbol-tls-index-slot other-pointer-lowtag)
300       (inst add bsp (* binding-size n-word-bytes))
301       (store-tl-symbol-value bsp *binding-stack-pointer* temp)
302       
303       (inst or tls-index tls-index)
304       (inst jmp :ne tls-index-valid)
305       ;; allocate a new tls-index
306       (load-symbol-value tls-index *free-tls-index*)
307       (inst add tls-index 4)            ;XXX surely we can do this more
308       (store-symbol-value tls-index *free-tls-index*) ;succintly
309       (inst sub tls-index 4)
310       (storew tls-index symbol symbol-tls-index-slot other-pointer-lowtag)
311       (emit-label tls-index-valid)
312       (inst fs-segment-prefix) 
313       (inst mov temp (make-ea :dword :scale 1 :index tls-index))
314       (storew temp bsp (- binding-value-slot binding-size))
315       (storew symbol bsp (- binding-symbol-slot binding-size))
316       (inst fs-segment-prefix)
317       (inst mov (make-ea :dword :scale 1 :index tls-index) val))))
318
319 #!-sb-thread
320 (define-vop (bind)
321   (:args (val :scs (any-reg descriptor-reg))
322          (symbol :scs (descriptor-reg)))
323   (:temporary (:sc unsigned-reg) temp bsp)
324   (:generator 5
325     (load-symbol-value bsp *binding-stack-pointer*)
326     (loadw temp symbol symbol-value-slot other-pointer-lowtag)
327     (inst add bsp (* binding-size n-word-bytes))
328     (store-symbol-value bsp *binding-stack-pointer*)
329     (storew temp bsp (- binding-value-slot binding-size))
330     (storew symbol bsp (- binding-symbol-slot binding-size))
331     (storew val symbol symbol-value-slot other-pointer-lowtag)))
332
333
334 #!+sb-thread
335 (define-vop (unbind)
336     ;; four temporaries?   
337   (:temporary (:sc unsigned-reg) symbol value bsp tls-index)
338   (:generator 0
339     (load-tl-symbol-value bsp *binding-stack-pointer*)
340     (loadw symbol bsp (- binding-symbol-slot binding-size))
341     (loadw value bsp (- binding-value-slot binding-size))
342
343     (loadw tls-index symbol symbol-tls-index-slot other-pointer-lowtag)    
344     (inst fs-segment-prefix)
345     (inst mov (make-ea :dword :scale 1 :index tls-index) value)
346
347     (storew 0 bsp (- binding-symbol-slot binding-size))
348     (inst sub bsp (* binding-size n-word-bytes))
349     ;; we're done with value, so we can use it as a temp here
350     (store-tl-symbol-value bsp *binding-stack-pointer* value)))
351
352 #!-sb-thread
353 (define-vop (unbind)
354   (:temporary (:sc unsigned-reg) symbol value bsp)
355   (:generator 0
356     (load-symbol-value bsp *binding-stack-pointer*)
357     (loadw symbol bsp (- binding-symbol-slot binding-size))
358     (loadw value bsp (- binding-value-slot binding-size))
359     (storew value symbol symbol-value-slot other-pointer-lowtag)
360     (storew 0 bsp (- binding-symbol-slot binding-size))
361     (inst sub bsp (* binding-size n-word-bytes))
362     (store-symbol-value bsp *binding-stack-pointer*)))
363
364
365 (define-vop (unbind-to-here)
366   (:args (where :scs (descriptor-reg any-reg)))
367   (:temporary (:sc unsigned-reg) symbol value bsp #!+sb-thread tls-index)
368   (:generator 0
369     (load-tl-symbol-value bsp *binding-stack-pointer*)
370     (inst cmp where bsp)
371     (inst jmp :e done)
372
373     LOOP
374     (loadw symbol bsp (- binding-symbol-slot binding-size))
375     (inst or symbol symbol)
376     (inst jmp :z skip)
377     (loadw value bsp (- binding-value-slot binding-size))
378     #!-sb-thread (storew value symbol symbol-value-slot other-pointer-lowtag)
379
380     #!+sb-thread (loadw
381                   tls-index symbol symbol-tls-index-slot other-pointer-lowtag)
382     #!+sb-thread (inst fs-segment-prefix)
383     #!+sb-thread (inst mov (make-ea :dword :scale 1 :index tls-index) value)
384     (storew 0 bsp (- binding-symbol-slot binding-size))
385
386     SKIP
387     (inst sub bsp (* binding-size n-word-bytes))
388     (inst cmp where bsp)
389     (inst jmp :ne loop)
390     ;; we're done with value, so can use it as a temporary
391     (store-tl-symbol-value bsp *binding-stack-pointer* value)
392
393     DONE))
394 \f
395
396 \f
397 ;;;; closure indexing
398
399 (define-full-reffer closure-index-ref *
400   closure-info-offset fun-pointer-lowtag
401   (any-reg descriptor-reg) * %closure-index-ref)
402
403 (define-full-setter set-funcallable-instance-info *
404   funcallable-instance-info-offset fun-pointer-lowtag
405   (any-reg descriptor-reg) * %set-funcallable-instance-info)
406
407 (define-full-reffer funcallable-instance-info *
408   funcallable-instance-info-offset fun-pointer-lowtag
409   (descriptor-reg any-reg) * %funcallable-instance-info)
410
411 (define-vop (funcallable-instance-lexenv cell-ref)
412   (:variant funcallable-instance-lexenv-slot fun-pointer-lowtag))
413
414 (define-vop (closure-ref slot-ref)
415   (:variant closure-info-offset fun-pointer-lowtag))
416
417 (define-vop (closure-init slot-set)
418   (:variant closure-info-offset fun-pointer-lowtag))
419 \f
420 ;;;; value cell hackery
421
422 (define-vop (value-cell-ref cell-ref)
423   (:variant value-cell-value-slot other-pointer-lowtag))
424
425 (define-vop (value-cell-set cell-set)
426   (:variant value-cell-value-slot other-pointer-lowtag))
427 \f
428 ;;;; structure hackery
429
430 (define-vop (instance-length)
431   (:policy :fast-safe)
432   (:translate %instance-length)
433   (:args (struct :scs (descriptor-reg)))
434   (:results (res :scs (unsigned-reg)))
435   (:result-types positive-fixnum)
436   (:generator 4
437     (loadw res struct 0 instance-pointer-lowtag)
438     (inst shr res n-widetag-bits)))
439
440 (define-vop (instance-ref slot-ref)
441   (:variant instance-slots-offset instance-pointer-lowtag)
442   (:policy :fast-safe)
443   (:translate %instance-ref)
444   (:arg-types instance (:constant index)))
445
446 (define-vop (instance-set slot-set)
447   (:policy :fast-safe)
448   (:translate %instance-set)
449   (:variant instance-slots-offset instance-pointer-lowtag)
450   (:arg-types instance (:constant index) *))
451
452 (define-full-reffer instance-index-ref * instance-slots-offset
453   instance-pointer-lowtag (any-reg descriptor-reg) * %instance-ref)
454
455 (define-full-setter instance-index-set * instance-slots-offset
456   instance-pointer-lowtag (any-reg descriptor-reg) * %instance-set)
457
458
459 (defknown %instance-set-conditional (instance index t t) t
460           (unsafe))
461
462 (define-vop (instance-set-conditional)
463   (:translate %instance-set-conditional)
464   (:args (object :scs (descriptor-reg) :to :eval)
465          (slot :scs (any-reg) :to :result)
466          (old-value :scs (descriptor-reg any-reg) :target eax)
467          (new-value :scs (descriptor-reg any-reg)))
468   (:arg-types instance positive-fixnum * *)
469   (:temporary (:sc descriptor-reg :offset eax-offset
470                    :from (:argument 2) :to :result :target result)  eax)
471   (:results (result :scs (descriptor-reg any-reg)))
472   ;(:guard (backend-featurep :i486))
473   (:policy :fast-safe)
474   (:generator 5
475     (move eax old-value)
476     (inst lock)
477     (inst cmpxchg (make-ea :dword :base object :index slot :scale 1
478                            :disp (- (* instance-slots-offset n-word-bytes)
479                                     instance-pointer-lowtag))
480           new-value)
481     (move result eax)))
482
483
484 \f
485 ;;;; code object frobbing
486
487 (define-full-reffer code-header-ref * 0 other-pointer-lowtag
488   (any-reg descriptor-reg) * code-header-ref)
489
490 (define-full-setter code-header-set * 0 other-pointer-lowtag
491   (any-reg descriptor-reg) * code-header-set)