0.pre7.59:
[sbcl.git] / src / code / bit-bash.lisp
index f9611cf..fe2fa6e 100644 (file)
 \f
 ;;;; constants and types
 
-(defconstant unit-bits sb!vm:word-bits
-  #!+sb-doc
-  "The number of bits to process at a time.")
+;;; the number of bits to process at a time
+(defconstant unit-bits sb!vm:n-word-bits)
 
-(defconstant max-bits (ash most-positive-fixnum -2)
-  #!+sb-doc
-  "The maximum number of bits that can be delt with during a single call.")
-
-;;; FIXME: Do we really need EVAL-WHEN around these DEFTYPEs?
-(eval-when (:compile-toplevel :load-toplevel :execute)
+;;; the maximum number of bits that can be dealt with in a single call
+(defconstant max-bits (ash most-positive-fixnum -2))
 
 (deftype unit ()
   `(unsigned-byte ,unit-bits))
@@ -38,8 +33,6 @@
 
 (deftype word-offset ()
   `(integer 0 (,(ceiling max-bits unit-bits))))
-
-) ; EVAL-WHEN
 \f
 ;;;; support routines
 
   (def-frob 32bit-logical-orc1 x y)
   (def-frob 32bit-logical-orc2 x y))
 
+;;; Shift NUMBER by the low-order bits of COUNTOID, adding zero bits
+;;; at the "end" and removing bits from the "start". On big-endian
+;;; machines this is a left-shift and on little-endian machines this
+;;; is a right-shift.
 (defun shift-towards-start (number countoid)
-  #!+sb-doc
-  "Shift NUMBER by the low-order bits of COUNTOID, adding zero bits at
-  the ``end'' and removing bits from the ``start.''  On big-endian
-  machines this is a left-shift and on little-endian machines this is a
-  right-shift."
   (declare (type unit number) (fixnum countoid))
   (let ((count (ldb (byte (1- (integer-length unit-bits)) 0) countoid)))
     (declare (type bit-offset count))
          (:little-endian
           (ash number (- count)))))))
 
+;;; Shift NUMBER by COUNT bits, adding zero bits at the "start" and
+;;; removing bits from the "end". On big-endian machines this is a
+;;; right-shift and on little-endian machines this is a left-shift.
 (defun shift-towards-end (number count)
-  #!+sb-doc
-  "Shift NUMBER by COUNT bits, adding zero bits at the ``start'' and removing
-  bits from the ``end.''  On big-endian machines this is a right-shift and
-  on little-endian machines this is a left-shift."
   (declare (type unit number) (fixnum count))
   (let ((count (ldb (byte (1- (integer-length unit-bits)) 0) count)))
     (declare (type bit-offset count))
           (ash (ldb (byte (- unit-bits count) 0) number) count))))))
 
 #!-sb-fluid (declaim (inline start-mask end-mask fix-sap-and-offset))
+
+;;; Produce a mask that contains 1's for the COUNT "start" bits and
+;;; 0's for the remaining "end" bits. Only the lower 5 bits of COUNT
+;;; are significant (KLUDGE: because of hardwired implicit dependence
+;;; on 32-bit word size -- WHN 2001-03-19).
 (defun start-mask (count)
-  #!+sb-doc
-  "Produce a mask that contains 1's for the COUNT ``start'' bits and 0's for
-  the remaining ``end'' bits. Only the lower 5 bits of COUNT are significant."
   (declare (fixnum count))
   (shift-towards-start (1- (ash 1 unit-bits)) (- count)))
 
+;;; Produce a mask that contains 1's for the COUNT "end" bits and 0's
+;;; for the remaining "start" bits. Only the lower 5 bits of COUNT are
+;;; significant (KLUDGE: because of hardwired implicit dependence on
+;;; 32-bit word size -- WHN 2001-03-19).
 (defun end-mask (count)
-  #!+sb-doc
-  "Produce a mask that contains 1's for the COUNT ``end'' bits and 0's for
-  the remaining ``start'' bits. Only the lower 5 bits of COUNT are
-  significant."
   (declare (fixnum count))
   (shift-towards-end (1- (ash 1 unit-bits)) (- count)))
 
+;;; Align the SAP to a word boundary, and update the offset accordingly.
 (defun fix-sap-and-offset (sap offset)
-  #!+sb-doc
-  "Align the SAP to a word boundary, and update the offset accordingly."
   (declare (type system-area-pointer sap)
           (type index offset)
           (values system-area-pointer index))
 \f
 ;;;; DO-CONSTANT-BIT-BASH
 
+;;; Fill DST with VALUE starting at DST-OFFSET and continuing for
+;;; LENGTH bits.
 #!-sb-fluid (declaim (inline do-constant-bit-bash))
 (defun do-constant-bit-bash (dst dst-offset length value dst-ref-fn dst-set-fn)
-  #!+sb-doc
-  "Fill DST with VALUE starting at DST-OFFSET and continuing for LENGTH bits."
   (declare (type offset dst-offset) (type unit value)
           (type function dst-ref-fn dst-set-fn))
   (multiple-value-bind (dst-word-offset dst-bit-offset)
 #!-sb-fluid (declaim (inline do-unary-bit-bash))
 (defun do-unary-bit-bash (src src-offset dst dst-offset length
                              dst-ref-fn dst-set-fn src-ref-fn)
+  ;; FIXME: Declaring these bit indices to be of type OFFSET, then
+  ;; using the inline expansion in SPEED 3 SAFETY 0 functions, is not
+  ;; a good thing. At the very least, we should make sure that the
+  ;; type (overflow) checks get done. Better would be to avoid
+  ;; using bit indices, and to use 32-bit unsigneds instead, and/or
+  ;; to call out to things like memmove(3) for big moves.
   (declare (type offset src-offset dst-offset length)
           (type function dst-ref-fn dst-set-fn src-ref-fn))
   (multiple-value-bind (dst-word-offset dst-bit-offset)
               (type bit-offset src-bit-offset))
       (cond
        ((<= (+ dst-bit-offset length) unit-bits)
-       ;; We are only writing one word, so it doesn't matter what order
-       ;; we do it in. But we might be reading from multiple words, so take
-       ;; care.
+       ;; We are only writing one word, so it doesn't matter what
+       ;; order we do it in. But we might be reading from multiple
+       ;; words, so take care.
        (cond
         ((zerop length)
          ;; Actually, we aren't even writing one word. This is really easy.
          )
         ((= length unit-bits)
-         ;; DST-BIT-OFFSET must be equal to zero, or we would be writing
-         ;; multiple words. If SRC-BIT-OFFSET is also zero, then we
-         ;; just transfer the single word. Otherwise we have to extract bits
-         ;; from two src words.
+         ;; DST-BIT-OFFSET must be equal to zero, or we would be
+         ;; writing multiple words. If SRC-BIT-OFFSET is also zero,
+         ;; then we just transfer the single word. Otherwise we have
+         ;; to extract bits from two src words.
          (funcall dst-set-fn dst dst-word-offset
                   (if (zerop src-bit-offset)
                       (funcall src-ref-fn src src-word-offset)
                         (funcall src-ref-fn src (1+ src-word-offset))
                         (- src-bit-offset))))))
         (t
-         ;; We are only writing some portion of the dst word, so we need to
-         ;; preserve the extra bits. Also, we still don't know whether we need
-         ;; one or two source words.
+         ;; We are only writing some portion of the dst word, so we
+         ;; need to preserve the extra bits. Also, we still don't
+         ;; know whether we need one or two source words.
          (let ((mask (shift-towards-end (start-mask length) dst-bit-offset))
                (orig (funcall dst-ref-fn dst dst-word-offset))
                (value
                 (if (> src-bit-offset dst-bit-offset)
-                    ;; The source starts further into the word than does
-                    ;; the dst, so the source could extend into the next
-                    ;; word. If it does, we have to merge the two words,
-                    ;; and if not, we can just shift the first word.
+                    ;; The source starts further into the word than
+                    ;; does the dst, so the source could extend into
+                    ;; the next word. If it does, we have to merge
+                    ;; the two words, and if not, we can just shift
+                    ;; the first word.
                     (let ((src-bit-shift (- src-bit-offset dst-bit-offset)))
                       (if (> (+ src-bit-offset length) unit-bits)
                           (32bit-logical-or
                           (shift-towards-start
                            (funcall src-ref-fn src src-word-offset)
                            src-bit-shift)))
-                    ;; The dst starts further into the word than does the
-                    ;; source, so we know the source can not extend into
-                    ;; a second word (or else the dst would too, and we
-                    ;; wouldn't be in this branch.
+                    ;; The dst starts further into the word than does
+                    ;; the source, so we know the source can not
+                    ;; extend into a second word (or else the dst
+                    ;; would too, and we wouldn't be in this branch.
                     (shift-towards-end
                      (funcall src-ref-fn src src-word-offset)
                      (- dst-bit-offset src-bit-offset)))))
                      (32bit-logical-andc2 orig mask)))))))
        ((= src-bit-offset dst-bit-offset)
        ;; The source and dst are aligned, so we don't need to shift
-       ;; anything. But we have to pick the direction of the loop
-       ;; in case the source and dst are really the same thing.
+       ;; anything. But we have to pick the direction of the loop in
+       ;; case the source and dst are really the same thing.
        (multiple-value-bind (words final-bits)
            (floor (+ dst-bit-offset length) unit-bits)
          (declare (type word-offset words) (type bit-offset final-bits))
             ((<= dst-offset src-offset)
              ;; We need to loop from left to right
              (unless (zerop dst-bit-offset)
-               ;; We are only writing part of the first word, so mask off the
-               ;; bits we want to preserve.
+               ;; We are only writing part of the first word, so mask
+               ;; off the bits we want to preserve.
                (let ((mask (end-mask (- dst-bit-offset)))
                      (orig (funcall dst-ref-fn dst dst-word-offset))
                      (value (funcall src-ref-fn src src-word-offset)))
   (declare (type (simple-array (unsigned-byte 8) 1) bv))
   (declare (type sap sap))
   (declare (type fixnum offset))
-  ;; FIXME: Actually it looks as though this, and most other calls
-  ;; to COPY-TO-SYSTEM-AREA, could be written more concisely with BYTE-BLT.
-  ;; Except that the DST-END-DST-START convention for the length is confusing.
-  ;; Perhaps I could rename BYTE-BLT to BYTE-BLIT and replace the
-  ;; DST-END argument with an N-BYTES argument?
+  ;; FIXME: Actually it looks as though this, and most other calls to
+  ;; COPY-TO-SYSTEM-AREA, could be written more concisely with
+  ;; %BYTE-BLT. Except that the DST-END-DST-START convention for the
+  ;; length is confusing. Perhaps I could rename %BYTE-BLT to
+  ;; %BYTE-BLIT (and correspondingly rename the corresponding VOP) and
+  ;; replace the DST-END argument with an N-BYTES argument?
   (copy-to-system-area bv
-                      (* sb!vm:vector-data-offset sb!vm:word-bits)
+                      (* sb!vm:vector-data-offset sb!vm:n-word-bits)
                       sap
                       offset
                       (* (length bv) sb!vm:byte-bits)))