[3d19a6]: src / compiler / x86 / macros.lisp Maximize Restore History

Download this file

macros.lisp    481 lines (439 with data), 17.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
;;;; a bunch of handy macros for the x86
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!VM")
;;; We can load/store into fp registers through the top of stack
;;; %st(0) (fr0 here). Loads imply a push to an empty register which
;;; then changes all the reg numbers. These macros help manage that.
;;; Use this when we don't have to load anything. It preserves old tos
;;; value, but probably destroys tn with operation.
(defmacro with-tn@fp-top((tn) &body body)
`(progn
(unless (zerop (tn-offset ,tn))
(inst fxch ,tn))
,@body
(unless (zerop (tn-offset ,tn))
(inst fxch ,tn))))
;;; Use this to prepare for load of new value from memory. This
;;; changes the register numbering so the next instruction had better
;;; be a FP load from memory; a register load from another register
;;; will probably be loading the wrong register!
(defmacro with-empty-tn@fp-top((tn) &body body)
`(progn
(inst fstp ,tn)
,@body
(unless (zerop (tn-offset ,tn))
(inst fxch ,tn)))) ; save into new dest and restore st(0)
;;;; instruction-like macros
(defmacro move (dst src)
#!+sb-doc
"Move SRC into DST unless they are location=."
(once-only ((n-dst dst)
(n-src src))
`(unless (location= ,n-dst ,n-src)
(inst mov ,n-dst ,n-src))))
(defmacro make-ea-for-object-slot (ptr slot lowtag)
`(make-ea :dword :base ,ptr :disp (- (* ,slot n-word-bytes) ,lowtag)))
(defmacro loadw (value ptr &optional (slot 0) (lowtag 0))
`(inst mov ,value (make-ea-for-object-slot ,ptr ,slot ,lowtag)))
(defmacro storew (value ptr &optional (slot 0) (lowtag 0))
(once-only ((value value))
`(inst mov (make-ea-for-object-slot ,ptr ,slot ,lowtag) ,value)))
(defmacro pushw (ptr &optional (slot 0) (lowtag 0))
`(inst push (make-ea-for-object-slot ,ptr ,slot ,lowtag)))
(defmacro popw (ptr &optional (slot 0) (lowtag 0))
`(inst pop (make-ea-for-object-slot ,ptr ,slot ,lowtag)))
;;;; macros to generate useful values
(defmacro load-symbol (reg symbol)
`(inst mov ,reg (+ nil-value (static-symbol-offset ,symbol))))
(defmacro load-symbol-value (reg symbol)
`(inst mov ,reg
(make-ea :dword
:disp (+ nil-value
(static-symbol-offset ',symbol)
(ash symbol-value-slot word-shift)
(- other-pointer-lowtag)))))
(defmacro store-symbol-value (reg symbol)
`(inst mov
(make-ea :dword
:disp (+ nil-value
(static-symbol-offset ',symbol)
(ash symbol-value-slot word-shift)
(- other-pointer-lowtag)))
,reg))
#!+sb-thread
(defmacro load-tl-symbol-value (reg symbol)
`(progn
(inst mov ,reg
(make-ea :dword
:disp (+ nil-value
(static-symbol-offset ',symbol)
(ash symbol-tls-index-slot word-shift)
(- other-pointer-lowtag))))
(inst fs-segment-prefix)
(inst mov ,reg (make-ea :dword :scale 1 :index ,reg))))
#!-sb-thread
(defmacro load-tl-symbol-value (reg symbol) `(load-symbol-value ,reg ,symbol))
#!+sb-thread
(defmacro store-tl-symbol-value (reg symbol temp)
`(progn
(inst mov ,temp
(make-ea :dword
:disp (+ nil-value
(static-symbol-offset ',symbol)
(ash symbol-tls-index-slot word-shift)
(- other-pointer-lowtag))))
(inst fs-segment-prefix)
(inst mov (make-ea :dword :scale 1 :index ,temp) ,reg)))
#!-sb-thread
(defmacro store-tl-symbol-value (reg symbol temp)
(declare (ignore temp))
`(store-symbol-value ,reg ,symbol))
(defmacro load-type (target source &optional (offset 0))
#!+sb-doc
"Loads the type bits of a pointer into target independent of
byte-ordering issues."
(once-only ((n-target target)
(n-source source)
(n-offset offset))
(ecase *backend-byte-order*
(:little-endian
`(inst mov ,n-target
(make-ea :byte :base ,n-source :disp ,n-offset)))
(:big-endian
`(inst mov ,n-target
(make-ea :byte :base ,n-source :disp (+ ,n-offset 3)))))))
;;;; allocation helpers
;;; All allocation is done by calls to assembler routines that
;;; eventually invoke the C alloc() function. Once upon a time
;;; (before threads) allocation within an alloc_region could also be
;;; done inline, with the aid of two C symbols storing the current
;;; allocation region boundaries; however, C cymbols are global.
;;; C calls for allocation don't /seem/ to make an awful lot of
;;; difference to speed. Guessing from historical context, it looks
;;; like inline allocation was introduced before pseudo-atomic, at
;;; which time all calls to alloc() would have needed a syscall to
;;; mask signals for the duration. Now we have pseudoatomic there's
;;; no need for that overhead. Still, inline alloc would be a neat
;;; addition someday
(defvar *maybe-use-inline-allocation* t) ; FIXME unused
;;; Emit code to allocate an object with a size in bytes given by
;;; SIZE. The size may be an integer of a TN. If Inline is a VOP
;;; node-var then it is used to make an appropriate speed vs size
;;; decision.
(defun allocation-dynamic-extent (alloc-tn size)
(inst sub esp-tn size)
;; FIXME: SIZE _should_ be double-word aligned (suggested but
;; unfortunately not enforced by PAD-DATA-BLOCK and
;; WITH-FIXED-ALLOCATION), so that ESP is always divisible by 8 (for
;; 32-bit lispobjs). In that case, this AND instruction is
;; unneccessary and could be removed. If not, explain why. -- CSR,
;; 2004-03-30
(inst and esp-tn #.(ldb (byte 32 0) (lognot lowtag-mask)))
(aver (not (location= alloc-tn esp-tn)))
(inst mov alloc-tn esp-tn)
(values))
(defun allocation-notinline (alloc-tn size)
(flet ((load-size (dst-tn size)
(unless (and (tn-p size) (location= alloc-tn size))
(inst mov dst-tn size))))
(let ((alloc-tn-offset (tn-offset alloc-tn)))
;; C call to allocate via dispatch routines. Each
;; destination has a special entry point. The size may be a
;; register or a constant.
(ecase alloc-tn-offset
(#.eax-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_eax")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_eax")
:foreign)))
(t
(load-size eax-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_eax")
:foreign)))))
(#.ecx-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_ecx")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_ecx")
:foreign)))
(t
(load-size ecx-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_ecx")
:foreign)))))
(#.edx-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_edx")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_edx")
:foreign)))
(t
(load-size edx-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_edx")
:foreign)))))
(#.ebx-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_ebx")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_ebx")
:foreign)))
(t
(load-size ebx-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_ebx")
:foreign)))))
(#.esi-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_esi")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_esi")
:foreign)))
(t
(load-size esi-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_esi")
:foreign)))))
(#.edi-offset
(case size
(8 (inst call (make-fixup (extern-alien-name "alloc_8_to_edi")
:foreign)))
(16 (inst call (make-fixup (extern-alien-name "alloc_16_to_edi")
:foreign)))
(t
(load-size edi-tn size)
(inst call (make-fixup (extern-alien-name "alloc_to_edi")
:foreign)))))))))
;;; This macro should only be used inside a pseudo-atomic section,
;;; which should also cover subsequent initialization of the object.
;;; (FIXME: so why aren't we asserting this?)
(defun allocation (alloc-tn size &optional inline dynamic-extent)
;; FIXME: since it appears that inline allocation is gone, we should
;; remove the INLINE parameter and *MAYBE-USE-INLINE-ALLOCATION*
(declare (ignore inline))
(cond
(dynamic-extent (allocation-dynamic-extent alloc-tn size))
(t (allocation-notinline alloc-tn size)))
(values))
;;; Allocate an other-pointer object of fixed SIZE with a single word
;;; header having the specified WIDETAG value. The result is placed in
;;; RESULT-TN.
(defmacro with-fixed-allocation ((result-tn widetag size &optional inline)
&rest forms)
`(pseudo-atomic
(allocation ,result-tn (pad-data-block ,size) ,inline)
(storew (logior (ash (1- ,size) n-widetag-bits) ,widetag)
,result-tn)
(inst lea ,result-tn
(make-ea :byte :base ,result-tn :disp other-pointer-lowtag))
,@forms))
;;;; error code
(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
(defun emit-error-break (vop kind code values)
(let ((vector (gensym)))
`((inst int 3) ; i386 breakpoint instruction
;; The return PC points here; note the location for the debugger.
(let ((vop ,vop))
(when vop
(note-this-location vop :internal-error)))
(inst byte ,kind) ; eg trap_Xyyy
(with-adjustable-vector (,vector) ; interr arguments
(write-var-integer (error-number-or-lose ',code) ,vector)
,@(mapcar (lambda (tn)
`(let ((tn ,tn))
;; classic CMU CL comment:
;; zzzzz jrd here. tn-offset is zero for constant
;; tns.
(write-var-integer (make-sc-offset (sc-number
(tn-sc tn))
(or (tn-offset tn)
0))
,vector)))
values)
(inst byte (length ,vector))
(dotimes (i (length ,vector))
(inst byte (aref ,vector i))))))))
(defmacro error-call (vop error-code &rest values)
#!+sb-doc
"Cause an error. ERROR-CODE is the error to cause."
(cons 'progn
(emit-error-break vop error-trap error-code values)))
(defmacro generate-error-code (vop error-code &rest values)
#!+sb-doc
"Generate-Error-Code Error-code Value*
Emit code for an error with the specified Error-Code and context Values."
`(assemble (*elsewhere*)
(let ((start-lab (gen-label)))
(emit-label start-lab)
(error-call ,vop ,error-code ,@values)
start-lab)))
;;;; PSEUDO-ATOMIC
;;; This is used to wrap operations which leave untagged memory lying
;;; around. It's an operation which the AOP weenies would describe as
;;; having "cross-cutting concerns", meaning it appears all over the
;;; place and there's no logical single place to attach documentation.
;;; grep (mostly in src/runtime) is your friend
;;; FIXME: *PSEUDO-ATOMIC-FOO* could be made into *PSEUDO-ATOMIC-BITS*,
;;; set with a single operation and cleared with SHR *PSEUDO-ATOMIC-BITS*,-2;
;;; the ATOMIC bit is bit 0, the INTERRUPTED bit is bit 1, and you check
;;; the C flag after the shift to see whether you were interrupted.
;;;
;;; KLUDGE: since the stack on the x86 is treated conservatively, it
;;; does not matter whether a signal occurs during construction of a
;;; dynamic-extent object, as the half-finished construction of the
;;; object will not cause any difficulty. We can therefore elide
(defvar *dynamic-extent* nil)
#!+sb-thread
(defmacro pseudo-atomic (&rest forms)
(with-unique-names (label)
`(if *dynamic-extent* ; I will burn in hell
(progn ,@forms)
(let ((,label (gen-label)))
(inst fs-segment-prefix)
(inst mov (make-ea :byte
:disp (* 4 thread-pseudo-atomic-interrupted-slot)) 0)
(inst fs-segment-prefix)
(inst mov (make-ea :byte :disp (* 4 thread-pseudo-atomic-atomic-slot)) 1)
,@forms
(inst fs-segment-prefix)
(inst mov (make-ea :byte :disp (* 4 thread-pseudo-atomic-atomic-slot)) 0)
(inst fs-segment-prefix)
(inst cmp (make-ea :byte
:disp (* 4 thread-pseudo-atomic-interrupted-slot)) 0)
(inst jmp :eq ,label)
;; if PAI was set, interrupts were disabled at the same
;; time using the process signal mask.
(inst break pending-interrupt-trap)
(emit-label ,label)))))
#!-sb-thread
(defmacro pseudo-atomic (&rest forms)
(with-unique-names (label)
`(if *dynamic-extent*
(progn ,@forms)
(let ((,label (gen-label)))
;; FIXME: The MAKE-EA noise should become a MACROLET macro
;; or something. (perhaps SVLB, for static variable low
;; byte)
(inst mov (make-ea :byte :disp (+ nil-value
(static-symbol-offset
'*pseudo-atomic-interrupted*)
(ash symbol-value-slot word-shift)
;; FIXME: Use mask, not minus, to
;; take out type bits.
(- other-pointer-lowtag)))
0)
(inst mov (make-ea :byte :disp (+ nil-value
(static-symbol-offset
'*pseudo-atomic-atomic*)
(ash symbol-value-slot word-shift)
(- other-pointer-lowtag)))
(fixnumize 1))
,@forms
(inst mov (make-ea :byte :disp (+ nil-value
(static-symbol-offset
'*pseudo-atomic-atomic*)
(ash symbol-value-slot word-shift)
(- other-pointer-lowtag)))
0)
;; KLUDGE: Is there any requirement for interrupts to be
;; handled in order? It seems as though an interrupt coming
;; in at this point will be executed before any pending
;; interrupts. Or do incoming interrupts check to see
;; whether any interrupts are pending? I wish I could find
;; the documentation for pseudo-atomics.. -- WHN 19991130
(inst cmp (make-ea :byte
:disp (+ nil-value
(static-symbol-offset
'*pseudo-atomic-interrupted*)
(ash symbol-value-slot word-shift)
(- other-pointer-lowtag)))
0)
(inst jmp :eq ,label)
;; if PAI was set, interrupts were disabled at the same
;; time using the process signal mask.
(inst break pending-interrupt-trap)
(emit-label ,label)))))
;;;; indexed references
(defmacro define-full-reffer (name type offset lowtag scs el-type &optional translate)
`(progn
(define-vop (,name)
,@(when translate
`((:translate ,translate)))
(:policy :fast-safe)
(:args (object :scs (descriptor-reg))
(index :scs (any-reg)))
(:arg-types ,type tagged-num)
(:results (value :scs ,scs))
(:result-types ,el-type)
(:generator 3 ; pw was 5
(inst mov value (make-ea :dword :base object :index index
:disp (- (* ,offset n-word-bytes)
,lowtag)))))
(define-vop (,(symbolicate name "-C"))
,@(when translate
`((:translate ,translate)))
(:policy :fast-safe)
(:args (object :scs (descriptor-reg)))
(:info index)
(:arg-types ,type (:constant (signed-byte 30)))
(:results (value :scs ,scs))
(:result-types ,el-type)
(:generator 2 ; pw was 5
(inst mov value (make-ea :dword :base object
:disp (- (* (+ ,offset index) n-word-bytes)
,lowtag)))))))
(defmacro define-full-setter (name type offset lowtag scs el-type &optional translate)
`(progn
(define-vop (,name)
,@(when translate
`((:translate ,translate)))
(:policy :fast-safe)
(:args (object :scs (descriptor-reg))
(index :scs (any-reg))
(value :scs ,scs :target result))
(:arg-types ,type tagged-num ,el-type)
(:results (result :scs ,scs))
(:result-types ,el-type)
(:generator 4 ; was 5
(inst mov (make-ea :dword :base object :index index
:disp (- (* ,offset n-word-bytes) ,lowtag))
value)
(move result value)))
(define-vop (,(symbolicate name "-C"))
,@(when translate
`((:translate ,translate)))
(:policy :fast-safe)
(:args (object :scs (descriptor-reg))
(value :scs ,scs :target result))
(:info index)
(:arg-types ,type (:constant (signed-byte 30)) ,el-type)
(:results (result :scs ,scs))
(:result-types ,el-type)
(:generator 3 ; was 5
(inst mov (make-ea :dword :base object
:disp (- (* (+ ,offset index) n-word-bytes)
,lowtag))
value)
(move result value)))))
;;; helper for alien stuff.
(defmacro with-pinned-objects ((&rest objects) &body body)
"Arrange with the garbage collector that the pages occupied by
OBJECTS will not be moved in memory for the duration of BODY.
Useful for e.g. foreign calls where another thread may trigger
garbage collection"
`(multiple-value-prog1
(progn
,@(loop for p in objects
collect `(push-word-on-c-stack
(int-sap (sb!kernel:get-lisp-obj-address ,p))))
,@body)
;; If the body returned normally, we should restore the stack pointer
;; for the benefit of any following code in the same function. If
;; there's a non-local exit in the body, sp is garbage anyway and
;; will get set appropriately from {a, the} frame pointer before it's
;; next needed
(pop-words-from-c-stack ,(length objects))))