Fix deadlocks in GC on Windows.
[sbcl.git] / src / compiler / sparc / macros.lisp
index 68bf325..4da9325 100644 (file)
 (defmacro move (dst src)
   "Move SRC into DST unless they are location=."
   (once-only ((n-dst dst)
-             (n-src src))
+              (n-src src))
     `(unless (location= ,n-dst ,n-src)
        (inst move ,n-dst ,n-src))))
 
 (macrolet
-    ((frob (op inst shift)
+    ((def (op inst shift)
        `(defmacro ,op (object base &optional (offset 0) (lowtag 0))
-         `(inst ,',inst ,object ,base (- (ash ,offset ,,shift) ,lowtag)))))
-  (frob loadw ld word-shift)
-  (frob storew st word-shift))
+          `(inst ,',inst ,object ,base (- (ash ,offset ,,shift) ,lowtag)))))
+  (def loadw ld word-shift)
+  (def storew st word-shift))
 
 (defmacro load-symbol (reg symbol)
   `(inst add ,reg null-tn (static-symbol-offset ,symbol)))
 (macrolet
     ((frob (slot)
        (let ((loader (intern (concatenate 'simple-string
-                                         "LOAD-SYMBOL-"
-                                         (string slot))))
-            (storer (intern (concatenate 'simple-string
-                                         "STORE-SYMBOL-"
-                                         (string slot))))
-            (offset (intern (concatenate 'simple-string
-                                         "SYMBOL-"
-                                         (string slot)
-                                         "-SLOT")
-                            (find-package "SB!VM"))))
-        `(progn
-           (defmacro ,loader (reg symbol)
-             `(inst ld ,reg null-tn
-                    (+ (static-symbol-offset ',symbol)
-                       (ash ,',offset word-shift)
-                       (- other-pointer-lowtag))))
-           (defmacro ,storer (reg symbol)
-             `(inst st ,reg null-tn
-                    (+ (static-symbol-offset ',symbol)
-                       (ash ,',offset word-shift)
-                       (- other-pointer-lowtag))))))))
+                                          "LOAD-SYMBOL-"
+                                          (string slot))))
+             (storer (intern (concatenate 'simple-string
+                                          "STORE-SYMBOL-"
+                                          (string slot))))
+             (offset (intern (concatenate 'simple-string
+                                          "SYMBOL-"
+                                          (string slot)
+                                          "-SLOT")
+                             (find-package "SB!VM"))))
+         `(progn
+            (defmacro ,loader (reg symbol)
+              `(inst ld ,reg null-tn
+                     (+ (static-symbol-offset ',symbol)
+                        (ash ,',offset word-shift)
+                        (- other-pointer-lowtag))))
+            (defmacro ,storer (reg symbol)
+              `(inst st ,reg null-tn
+                     (+ (static-symbol-offset ',symbol)
+                        (ash ,',offset word-shift)
+                        (- other-pointer-lowtag))))))))
   (frob value)
   (frob function))
 
   "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))
+              (n-source source)
+              (n-offset offset))
     ;; FIXME: although I don't understand entirely, I'm going to do
     ;; what whn does in x86/macros.lisp -- Christophe
     (ecase *backend-byte-order*
       (:little-endian
        `(inst ldub ,n-target ,n-source ,n-offset))
       (:big-endian
-       `(inst ldub ,n-target ,n-source (+ ,n-offset 3))))))
+       `(inst ldub ,n-target ,n-source (+ ,n-offset (1- n-word-bytes)))))))
 
 ;;; Macros to handle the fact that we cannot use the machine native call and
-;;; return instructions. 
+;;; return instructions.
 
 (defmacro lisp-jump (fun)
   "Jump to the lisp function FUNCTION.  LIP is an interior-reg temporary."
   `(progn
      (inst j ,fun
-          (- (ash simple-fun-code-offset word-shift) fun-pointer-lowtag))
+           (- (ash simple-fun-code-offset word-shift) fun-pointer-lowtag))
      (move code-tn ,fun)))
 
 (defmacro lisp-return (return-pc &key (offset 0) (frob-code t))
   "Return to RETURN-PC."
   `(progn
      (inst j ,return-pc
-          (- (* (1+ ,offset) n-word-bytes) other-pointer-lowtag))
+           (- (* (1+ ,offset) n-word-bytes) other-pointer-lowtag))
      ,(if frob-code
-         `(move code-tn ,return-pc)
-         '(inst nop))))
+          `(move code-tn ,return-pc)
+          '(inst nop))))
 
 (defmacro emit-return-pc (label)
   "Emit a return-pc header word.  LABEL is the label to use for this return-pc."
   `(progn
-     (align n-lowtag-bits)
+     (emit-alignment n-lowtag-bits)
      (emit-label ,label)
      (inst lra-header-word)))
 
 ;;; Move a stack TN to a register and vice-versa.
 (defmacro load-stack-tn (reg stack)
   `(let ((reg ,reg)
-        (stack ,stack))
+         (stack ,stack))
      (let ((offset (tn-offset stack)))
        (sc-case stack
-        ((control-stack)
-         (loadw reg cfp-tn offset))))))
+         ((control-stack)
+          (loadw reg cfp-tn offset))))))
 
 (defmacro store-stack-tn (stack reg)
   `(let ((stack ,stack)
-        (reg ,reg))
+         (reg ,reg))
      (let ((offset (tn-offset stack)))
        (sc-case stack
-        ((control-stack)
-         (storew reg cfp-tn offset))))))
+         ((control-stack)
+          (storew reg cfp-tn offset))))))
 
 (defmacro maybe-load-stack-tn (reg reg-or-stack)
   "Move the TN Reg-Or-Stack into Reg if it isn't already there."
   (once-only ((n-reg reg)
-             (n-stack reg-or-stack))
+              (n-stack reg-or-stack))
     `(sc-case ,n-reg
        ((any-reg descriptor-reg)
-       (sc-case ,n-stack
-         ((any-reg descriptor-reg)
-          (move ,n-reg ,n-stack))
-         ((control-stack)
-          (loadw ,n-reg cfp-tn (tn-offset ,n-stack))))))))
+        (sc-case ,n-stack
+          ((any-reg descriptor-reg)
+           (move ,n-reg ,n-stack))
+          ((control-stack)
+           (loadw ,n-reg cfp-tn (tn-offset ,n-stack))))))))
 
 \f
+\f
 ;;;; Storage allocation:
+
+;;;; Allocation macro
+;;;;
+;;;; This macro does the appropriate stuff to allocate space.
+;;;;
+;;;; The allocated space is stored in RESULT-TN with the lowtag LOWTAG
+;;;; applied.  The amount of space to be allocated is SIZE bytes (which
+;;;; must be a multiple of the lisp object size).
+(defmacro allocation (result-tn size lowtag &key stack-p temp-tn)
+  #!+gencgc
+  ;; A temp register is needed to do inline allocation.  TEMP-TN, in
+  ;; this case, can be any register, since it holds a double-word
+  ;; aligned address (essentially a fixnum).
+  (assert temp-tn)
+  ;; We assume we're in a pseudo-atomic so the pseudo-atomic bit is
+  ;; set.
+  `(cond
+     (,stack-p
+      ;; Stack allocation
+      ;;
+      ;; The control stack grows up, so round up CSP to a
+      ;; multiple of 8 (lispobj size).  Use that as the
+      ;; allocation pointer.  Then add SIZE bytes to the
+      ;; allocation and set CSP to that, so we have the desired
+      ;; space.
+
+      ;; Make sure the temp-tn is a non-descriptor register!
+      (assert (and ,temp-tn (sc-is ,temp-tn non-descriptor-reg)))
+
+      ;; temp-tn is csp-tn rounded up to a multiple of 8 (lispobj size)
+      (align-csp ,temp-tn)
+      ;; For the benefit of future historians, this is how CMUCL does the
+      ;; align-csp (I think their version is branch free only because
+      ;; they simply don't worry about zeroing the pad word):
+      #+nil (inst add ,temp-tn csp-tn sb!vm:lowtag-mask)
+      #+nil (inst andn ,temp-tn sb!vm:lowtag-mask)
+
+      ;; Set the result to temp-tn, with appropriate lowtag
+      (inst or ,result-tn csp-tn ,lowtag)
+
+      ;; Allocate the desired space on the stack.
+      ;;
+      ;; FIXME: Can't allocate on stack if SIZE is too large.
+      ;; Need to rearrange this code.
+      (inst add csp-tn ,size))
+
+     #!-gencgc
+     ;; Normal allocation to the heap -- cheneygc version.
+     ;;
+     ;; On cheneygc, the alloc-tn currently has the pseudo-atomic bit.
+     ;; If the lowtag also has a 1 bit in the same position, we're all set.
+     ;;
+     ;; See comment in PSEUDO-ATOMIC-FLAG.
+     ((logbitp (1- n-lowtag-bits) ,lowtag)
+      (inst or ,result-tn alloc-tn ,lowtag)
+      (inst add alloc-tn ,size))
+     ;;
+     ;; Otherwise, we need to zap out the lowtag from alloc-tn, and then
+     ;; or in the lowtag.
+     #!-gencgc
+     (t
+      (inst andn ,result-tn alloc-tn lowtag-mask)
+      (inst or ,result-tn ,lowtag)
+      (inst add alloc-tn ,size))
+
+     ;; Normal allocation to the heap -- gencgc version.
+     ;;
+     ;; No need to worry about lowtag bits matching up here, since
+     ;; alloc-tn is just a "pseudo-atomic-bit-tn" now and we don't read
+     ;; it.
+     #!+gencgc
+     (t
+      (inst li ,temp-tn (make-fixup "boxed_region" :foreign))
+      (loadw ,result-tn ,temp-tn 0)     ;boxed_region.free_pointer
+      (loadw ,temp-tn ,temp-tn 1)       ;boxed_region.end_addr
+
+      (without-scheduling ()
+        (let ((done (gen-label))
+              (full-alloc (gen-label)))
+          ;; See if we can do an inline allocation.  The updated
+          ;; free pointer should not point past the end of the
+          ;; current region.  If it does, a full alloc needs to be
+          ;; done.
+          (inst add ,result-tn ,size)
+
+          ;; result-tn points to the new end of region.  Did we go
+          ;; past the actual end of the region?  If so, we need a
+          ;; full alloc.
+          (inst cmp ,result-tn ,temp-tn)
+          (if (member :sparc-v9 *backend-subfeatures*)
+              (inst b :gtu full-alloc :pn)
+              (inst b :gtu full-alloc))
+          (inst nop)
+          ;; Inline allocation worked, so update the free pointer
+          ;; and go.  Should really do a swap instruction here to
+          ;; swap memory with a register.
+
+          ;; Kludge: We ought to have two distinct FLAG-TN and TEMP-TN
+          ;; here, to avoid the SUB and the TEMP-TN reload which is
+          ;; causing it.  PPC gets it right.
+          (inst li ,temp-tn (make-fixup "boxed_region" :foreign))
+          (storew ,result-tn ,temp-tn 0)
+
+          (inst b done)
+          (inst sub ,result-tn ,size)
+
+          (emit-label full-alloc)
+          ;; Full alloc via trap to the C allocator.  Tell the
+          ;; allocator what the result-tn and size are, using the
+          ;; OR instruction.  Then trap to the allocator.
+          (inst or zero-tn ,result-tn ,size)
+          ;; DFL: Not certain why we use two kinds of traps: T for p/a
+          ;; and UNIMP for all other traps.  But the C code in the runtime
+          ;; for the UNIMP case is a lot nicer, so I'm hooking into that.
+          ;; (inst t :t allocation-trap)
+          (inst unimp allocation-trap)
+
+          (emit-label done)
+          ;; Set lowtag appropriately
+          (inst or ,result-tn ,lowtag))))))
+
 (defmacro with-fixed-allocation ((result-tn temp-tn type-code size)
-                                &body body)
+                                 &body body)
   "Do stuff to allocate an other-pointer object of fixed Size with a single
   word header having the specified Type-Code.  The result is placed in
   Result-TN, and Temp-TN is a non-descriptor temp (which may be randomly used
   by the body.)  The body is placed inside the PSEUDO-ATOMIC, and presumably
   initializes the object."
+  (unless body
+    (bug "empty &body in WITH-FIXED-ALLOCATION"))
   (once-only ((result-tn result-tn) (temp-tn temp-tn)
-             (type-code type-code) (size size))
-    `(pseudo-atomic (:extra (pad-data-block ,size))
-       (inst or ,result-tn alloc-tn other-pointer-lowtag)
+              (type-code type-code) (size size))
+    `(pseudo-atomic ()
+       (allocation ,result-tn (pad-data-block ,size) other-pointer-lowtag
+                   :temp-tn ,temp-tn)
        (inst li ,temp-tn (logior (ash (1- ,size) n-widetag-bits) ,type-code))
        (storew ,temp-tn ,result-tn 0 other-pointer-lowtag)
        ,@body)))
 
+(defun align-csp (temp)
+  (let ((aligned (gen-label)))
+    ;; FIXME: why use a TEMP?  Why not just ZERO-TN?
+    (inst andcc temp csp-tn lowtag-mask)
+    (if (member :sparc-v9 *backend-subfeatures*)
+        (inst b :eq aligned :pt)
+        (inst b :eq aligned))
+    (storew zero-tn csp-tn 0) ; sneaky use of delay slot
+    (inst add csp-tn csp-tn n-word-bytes)
+    (emit-label aligned)))
 \f
 ;;;; Error Code
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defun emit-error-break (vop kind code values)
     (let ((vector (gensym)))
       `((let ((vop ,vop))
-         (when vop
-           (note-this-location vop :internal-error)))
-       (inst unimp ,kind)
-       (with-adjustable-vector (,vector)
-         (write-var-integer (error-number-or-lose ',code) ,vector)
-         ,@(mapcar #'(lambda (tn)
-                       `(let ((tn ,tn))
-                          (write-var-integer (make-sc-offset (sc-number
-                                                              (tn-sc tn))
-                                                             (tn-offset tn))
-                                             ,vector)))
-                   values)
-         (inst byte (length ,vector))
-         (dotimes (i (length ,vector))
-           (inst byte (aref ,vector i))))
-       (align word-shift)))))
+          (when vop
+            (note-this-location vop :internal-error)))
+        (inst unimp ,kind)
+        (with-adjustable-vector (,vector)
+          (write-var-integer (error-number-or-lose ',code) ,vector)
+          ,@(mapcar #'(lambda (tn)
+                        `(let ((tn ,tn))
+                           (write-var-integer (make-sc-offset (sc-number
+                                                               (tn-sc tn))
+                                                              (tn-offset tn))
+                                              ,vector)))
+                    values)
+          (inst byte (length ,vector))
+          (dotimes (i (length ,vector))
+            (inst byte (aref ,vector i))))
+        (emit-alignment word-shift)))))
 
 (defmacro error-call (vop error-code &rest values)
   "Cause an error.  ERROR-CODE is the error to cause."
   (cons 'progn
-       (emit-error-break vop error-trap error-code values)))
+        (emit-error-break vop error-trap error-code values)))
 
 
 (defmacro cerror-call (vop label error-code &rest values)
     `(let ((,continue (gen-label)))
        (emit-label ,continue)
        (assemble (*elsewhere*)
-        (let ((,error (gen-label)))
-          (emit-label ,error)
-          (cerror-call ,vop ,continue ,error-code ,@values)
-          ,error)))))
+         (let ((,error (gen-label)))
+           (emit-label ,error)
+           (cerror-call ,vop ,continue ,error-code ,@values)
+           ,error)))))
 \f
 ;;; a handy macro for making sequences look atomic
-(defmacro pseudo-atomic ((&key (extra 0)) &rest forms)
-  (let ((n-extra (gensym)))
-    `(let ((,n-extra ,extra))
+(defmacro pseudo-atomic ((&optional) &rest forms)
+  (let ()
+    `(progn
        ;; Set the pseudo-atomic flag.
        (without-scheduling ()
-        (inst add alloc-tn 4))
+         (inst or alloc-tn 4))
        ,@forms
        ;; Reset the pseudo-atomic flag.
        (without-scheduling ()
-        #+nil (inst taddcctv alloc-tn (- ,n-extra 4))
-       ;; Remove the pseudo-atomic flag.
-       (inst add alloc-tn (- ,n-extra 4))
-       ;; Check to see if pseudo-atomic interrupted flag is set (bit 0 = 1).
-       (inst andcc zero-tn alloc-tn 3)
-       ;; The C code needs to process this correctly and fixup alloc-tn.
-       (inst t :ne pseudo-atomic-trap)))))
+        ;; Remove the pseudo-atomic flag.
+        (inst andn alloc-tn 4)
+        ;; Check to see if pseudo-atomic interrupted flag is set (bit 0 = 1).
+        (inst andcc zero-tn alloc-tn 3)
+        ;; The C code needs to process this correctly and fixup alloc-tn.
+        (inst t :ne pseudo-atomic-trap)))))
+
+
+(def!macro 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.  This is currently implemented by disabling GC"
+  #!-gencgc
+  (declare (ignore objects))            ;should we eval these for side-effect?
+  #!-gencgc
+  `(without-gcing
+    ,@body)
+  #!+gencgc
+  `(let ((*pinned-objects* (list* ,@objects *pinned-objects*)))
+     (declare (truly-dynamic-extent *pinned-objects*))
+     ,@body))