X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Farray.lisp;h=4a9e054db00eb35ff33957f712a71739be626ba1;hb=2e33f2df9a6eb5a84d71726b88f06d92241e44da;hp=69d0e4f2cdd79cd1235429ce19e43ee27467d340;hpb=a530bbe337109d898d5b4a001fc8f1afa3b5dc39;p=sbcl.git diff --git a/src/code/array.lisp b/src/code/array.lisp index 69d0e4f..4a9e054 100644 --- a/src/code/array.lisp +++ b/src/code/array.lisp @@ -11,29 +11,27 @@ (in-package "SB!IMPL") -(file-comment - "$Header$") - #!-sb-fluid (declaim (inline fill-pointer array-has-fill-pointer-p adjustable-array-p - array-displacement)) + array-displacement)) ;;;; miscellaneous accessor functions -;;; These functions are needed by the interpreter, 'cause the compiler inlines -;;; them. -(macrolet ((def-frob (name) - `(progn - (defun ,name (array) - (,name array)) - (defun (setf ,name) (value array) - (setf (,name array) value))))) - (def-frob %array-fill-pointer) - (def-frob %array-fill-pointer-p) - (def-frob %array-available-elements) - (def-frob %array-data-vector) - (def-frob %array-displacement) - (def-frob %array-displaced-p)) +;;; These functions are only needed by the interpreter, 'cause the +;;; compiler inlines them. +(macrolet ((def (name) + `(progn + (defun ,name (array) + (,name array)) + (defun (setf ,name) (value array) + (setf (,name array) value))))) + (def %array-fill-pointer) + (def %array-fill-pointer-p) + (def %array-available-elements) + (def %array-data-vector) + (def %array-displacement) + (def %array-displaced-p) + (def %array-diplaced-from)) (defun %array-rank (array) (%array-rank array)) @@ -46,66 +44,40 @@ (defun %check-bound (array bound index) (declare (type index bound) - (fixnum index)) + (fixnum index)) (%check-bound array bound index)) -;;; The guts of the WITH-ARRAY-DATA macro. Note that this function is -;;; only called if we have an array header or an error, so it doesn't -;;; have to be too tense. +(defun %with-array-data/fp (array start end) + (%with-array-data-macro array start end :check-bounds t :check-fill-pointer t)) + (defun %with-array-data (array start end) - (declare (array array) (type index start) (type (or index null) end)) - ;; FIXME: The VALUES declaration here is correct, but as of SBCL - ;; 0.6.6, the corresponding runtime assertion is implemented - ;; horribly inefficiently, with a full call to %TYPEP for every - ;; call to this function. As a quick fix, I commented it out, - ;; but the proper fix would be to fix up type checking. - ;; - ;; A simpler test case for the optimization bug is - ;; (DEFUN FOO (X) - ;; (DECLARE (TYPE INDEXOID X)) - ;; (THE (VALUES INDEXOID) - ;; (VALUES X))) - ;; which also compiles to a full call to %TYPEP. - #+nil (declare (values (simple-array * (*)) index index index)) - (let* ((size (array-total-size array)) - (end (cond (end - (unless (<= end size) - (error "End ~D is greater than total size ~D." - end size)) - end) - (t size)))) - (when (> start end) - (error "Start ~D is greater than end ~D." start end)) - (do ((data array (%array-data-vector data)) - (cumulative-offset 0 - (+ cumulative-offset - (%array-displacement data)))) - ((not (array-header-p data)) - (values (the (simple-array * (*)) data) - (the index (+ cumulative-offset start)) - (the index (+ cumulative-offset end)) - (the index cumulative-offset))) - (declare (type index cumulative-offset))))) + (%with-array-data-macro array start end :check-bounds t :check-fill-pointer nil)) + +(defun %data-vector-and-index (array index) + (if (array-header-p array) + (multiple-value-bind (vector index) + (%with-array-data array index nil) + (values vector index)) + (values array index))) ;;;; MAKE-ARRAY - (eval-when (:compile-toplevel :execute) - (sb!xc:defmacro pick-type (type &rest specs) - `(cond ,@(mapcar #'(lambda (spec) - `(,(if (eq (car spec) t) - t - `(subtypep ,type ',(car spec))) - ,@(cdr spec))) - specs)))) + (sb!xc:defmacro pick-vector-type (type &rest specs) + `(cond ,@(mapcar (lambda (spec) + `(,(if (eq (car spec) t) + t + `(subtypep ,type ',(car spec))) + ,@(cdr spec))) + specs)))) ;;; These functions are used in the implementation of MAKE-ARRAY for ;;; complex arrays. There are lots of transforms to simplify -;;; MAKE-ARRAY is transformed away for various easy cases, but not for -;;; all reasonable cases, so e.g. as of sbcl-0.6.6 we still make full -;;; calls to MAKE-ARRAY for any non-simple array. Thus, there's some -;;; value to making this somewhat efficient, at least not doing full -;;; calls to SUBTYPEP in the easy cases. -(defun %vector-type-code (type) +;;; MAKE-ARRAY for various easy cases, but not for all reasonable +;;; cases, so e.g. as of sbcl-0.6.6 we still make full calls to +;;; MAKE-ARRAY for any non-simple array. Thus, there's some value to +;;; making this somewhat efficient, at least not doing full calls to +;;; SUBTYPEP in the easy cases. +(defun %vector-widetag-and-n-bits (type) (case type ;; Pick off some easy common cases. ;; @@ -114,329 +86,471 @@ ;; on smarter compiler transforms which do the calculation once ;; and for all in any reasonable user programs.) ((t) - (values #.sb!vm:simple-vector-type #.sb!vm:word-bits)) - ((character base-char) - (values #.sb!vm:simple-string-type #.sb!vm:byte-bits)) + (values #.sb!vm:simple-vector-widetag #.sb!vm:n-word-bits)) + ((base-char standard-char #!-sb-unicode character) + (values #.sb!vm:simple-base-string-widetag #.sb!vm:n-byte-bits)) + #!+sb-unicode + ((character) + (values #.sb!vm:simple-character-string-widetag #.sb!vm:n-word-bits)) ((bit) - (values #.sb!vm:simple-bit-vector-type 1)) + (values #.sb!vm:simple-bit-vector-widetag 1)) ;; OK, we have to wade into SUBTYPEPing after all. (t - (pick-type type - (base-char (values #.sb!vm:simple-string-type #.sb!vm:byte-bits)) - (bit (values #.sb!vm:simple-bit-vector-type 1)) - ((unsigned-byte 2) - (values #.sb!vm:simple-array-unsigned-byte-2-type 2)) - ((unsigned-byte 4) - (values #.sb!vm:simple-array-unsigned-byte-4-type 4)) - ((unsigned-byte 8) - (values #.sb!vm:simple-array-unsigned-byte-8-type 8)) - ((unsigned-byte 16) - (values #.sb!vm:simple-array-unsigned-byte-16-type 16)) - ((unsigned-byte 32) - (values #.sb!vm:simple-array-unsigned-byte-32-type 32)) - ((signed-byte 8) - (values #.sb!vm:simple-array-signed-byte-8-type 8)) - ((signed-byte 16) - (values #.sb!vm:simple-array-signed-byte-16-type 16)) - ((signed-byte 30) - (values #.sb!vm:simple-array-signed-byte-30-type 32)) - ((signed-byte 32) - (values #.sb!vm:simple-array-signed-byte-32-type 32)) - (single-float (values #.sb!vm:simple-array-single-float-type 32)) - (double-float (values #.sb!vm:simple-array-double-float-type 64)) - #!+long-float - (long-float - (values #.sb!vm:simple-array-long-float-type #!+x86 96 #!+sparc 128)) - ((complex single-float) - (values #.sb!vm:simple-array-complex-single-float-type 64)) - ((complex double-float) - (values #.sb!vm:simple-array-complex-double-float-type 128)) - #!+long-float - ((complex long-float) - (values #.sb!vm:simple-array-complex-long-float-type - #!+x86 192 - #!+sparc 256)) - (t (values #.sb!vm:simple-vector-type #.sb!vm:word-bits)))))) -(defun %complex-vector-type-code (type) + #.`(pick-vector-type type + ,@(map 'list + (lambda (saetp) + `(,(sb!vm:saetp-specifier saetp) + (values ,(sb!vm:saetp-typecode saetp) + ,(sb!vm:saetp-n-bits saetp)))) + sb!vm:*specialized-array-element-type-properties*))))) + +(defun %complex-vector-widetag (type) (case type ;; Pick off some easy common cases. ((t) - #.sb!vm:complex-vector-type) - ((character base-char) - #.sb!vm:complex-string-type) + #.sb!vm:complex-vector-widetag) + ((base-char #!-sb-unicode character) + #.sb!vm:complex-base-string-widetag) + #!+sb-unicode + ((character) + #.sb!vm:complex-character-string-widetag) + ((nil) + #.sb!vm:complex-vector-nil-widetag) ((bit) - #.sb!vm:complex-bit-vector-type) + #.sb!vm:complex-bit-vector-widetag) ;; OK, we have to wade into SUBTYPEPing after all. (t - (pick-type type - (base-char #.sb!vm:complex-string-type) - (bit #.sb!vm:complex-bit-vector-type) - (t #.sb!vm:complex-vector-type))))) + (pick-vector-type type + (nil #.sb!vm:complex-vector-nil-widetag) + #!-sb-unicode + (character #.sb!vm:complex-base-string-widetag) + #!+sb-unicode + (base-char #.sb!vm:complex-base-string-widetag) + #!+sb-unicode + (character #.sb!vm:complex-character-string-widetag) + (bit #.sb!vm:complex-bit-vector-widetag) + (t #.sb!vm:complex-vector-widetag))))) (defun make-array (dimensions &key - (element-type t) - (initial-element nil initial-element-p) - initial-contents adjustable fill-pointer - displaced-to displaced-index-offset) - #!+sb-doc - "Creates an array of the specified Dimensions. See manual for details." + (element-type t) + (initial-element nil initial-element-p) + (initial-contents nil initial-contents-p) + adjustable fill-pointer + displaced-to displaced-index-offset) (let* ((dimensions (if (listp dimensions) dimensions (list dimensions))) - (array-rank (length (the list dimensions))) - (simple (and (null fill-pointer) - (not adjustable) - (null displaced-to)))) + (array-rank (length (the list dimensions))) + (simple (and (null fill-pointer) + (not adjustable) + (null displaced-to)))) (declare (fixnum array-rank)) (when (and displaced-index-offset (null displaced-to)) - (error "Can't specify :displaced-index-offset without :displaced-to")) + (error "can't specify :DISPLACED-INDEX-OFFSET without :DISPLACED-TO")) + (when (and displaced-to + (arrayp displaced-to) + (not (equal (array-element-type displaced-to) + (upgraded-array-element-type element-type)))) + (error "Array element type of :DISPLACED-TO array does not match specified element type")) (if (and simple (= array-rank 1)) - ;; Its a (simple-array * (*)) - (multiple-value-bind (type bits) (%vector-type-code element-type) - (declare (type (unsigned-byte 8) type) - (type (integer 1 256) bits)) - (let* ((length (car dimensions)) - (array (allocate-vector - type - length - (ceiling (* (if (= type sb!vm:simple-string-type) - (1+ length) - length) - bits) - sb!vm:word-bits)))) - (declare (type index length)) - (when initial-element-p - (fill array initial-element)) - (when initial-contents - (when initial-element - (error "Cannot specify both :initial-element and ~ - :initial-contents")) - (unless (= length (length initial-contents)) - (error "~D elements in the initial-contents, but the ~ - vector length is ~D." - (length initial-contents) - length)) - (replace array initial-contents)) - array)) - ;; It's either a complex array or a multidimensional array. - (let* ((total-size (reduce #'* dimensions)) - (data (or displaced-to - (data-vector-from-inits - dimensions total-size element-type - initial-contents initial-element initial-element-p))) - (array (make-array-header - (cond ((= array-rank 1) - (%complex-vector-type-code element-type)) - (simple sb!vm:simple-array-type) - (t sb!vm:complex-array-type)) - array-rank))) - (cond (fill-pointer - (unless (= array-rank 1) - (error "Only vectors can have fill pointers.")) - (let ((length (car dimensions))) - (declare (fixnum length)) - (setf (%array-fill-pointer array) - (cond ((eq fill-pointer t) - length) - (t - (unless (and (fixnump fill-pointer) - (>= fill-pointer 0) - (<= fill-pointer length)) - (error "Invalid fill-pointer ~D" - fill-pointer)) - fill-pointer)))) - (setf (%array-fill-pointer-p array) t)) - (t - (setf (%array-fill-pointer array) total-size) - (setf (%array-fill-pointer-p array) nil))) - (setf (%array-available-elements array) total-size) - (setf (%array-data-vector array) data) - (cond (displaced-to - (when (or initial-element-p initial-contents) - (error "Neither :initial-element nor :initial-contents ~ - can be specified along with :displaced-to")) - (let ((offset (or displaced-index-offset 0))) - (when (> (+ offset total-size) - (array-total-size displaced-to)) - (error "~S doesn't have enough elements." displaced-to)) - (setf (%array-displacement array) offset) - (setf (%array-displaced-p array) t))) - (t - (setf (%array-displaced-p array) nil))) - (let ((axis 0)) - (dolist (dim dimensions) - (setf (%array-dimension array axis) dim) - (incf axis))) - array)))) - -;;; DATA-VECTOR-FROM-INITS returns a simple vector that has the specified array -;;; characteristics. Dimensions is only used to pass to FILL-DATA-VECTOR -;;; for error checking on the structure of initial-contents. + ;; it's a (SIMPLE-ARRAY * (*)) + (multiple-value-bind (type n-bits) + (%vector-widetag-and-n-bits element-type) + (declare (type (unsigned-byte 8) type) + (type (integer 0 256) n-bits)) + (let* ((length (car dimensions)) + (array (allocate-vector + type + length + (ceiling + (* (if (or (= type sb!vm:simple-base-string-widetag) + #!+sb-unicode + (= type + sb!vm:simple-character-string-widetag)) + (1+ length) + length) + n-bits) + sb!vm:n-word-bits)))) + (declare (type index length)) + (when initial-element-p + (fill array initial-element)) + (when initial-contents-p + (when initial-element-p + (error "can't specify both :INITIAL-ELEMENT and ~ + :INITIAL-CONTENTS")) + (unless (= length (length initial-contents)) + (error "There are ~W elements in the :INITIAL-CONTENTS, but ~ + the vector length is ~W." + (length initial-contents) + length)) + (replace array initial-contents)) + array)) + ;; it's either a complex array or a multidimensional array. + (let* ((total-size (reduce #'* dimensions)) + (data (or displaced-to + (data-vector-from-inits + dimensions total-size element-type + initial-contents initial-contents-p + initial-element initial-element-p))) + (array (make-array-header + (cond ((= array-rank 1) + (%complex-vector-widetag element-type)) + (simple sb!vm:simple-array-widetag) + (t sb!vm:complex-array-widetag)) + array-rank))) + (cond (fill-pointer + (unless (= array-rank 1) + (error "Only vectors can have fill pointers.")) + (let ((length (car dimensions))) + (declare (fixnum length)) + (setf (%array-fill-pointer array) + (cond ((eq fill-pointer t) + length) + (t + (unless (and (fixnump fill-pointer) + (>= fill-pointer 0) + (<= fill-pointer length)) + ;; FIXME: should be TYPE-ERROR? + (error "invalid fill-pointer ~W" + fill-pointer)) + fill-pointer)))) + (setf (%array-fill-pointer-p array) t)) + (t + (setf (%array-fill-pointer array) total-size) + (setf (%array-fill-pointer-p array) nil))) + (setf (%array-available-elements array) total-size) + (setf (%array-data-vector array) data) + (setf (%array-displaced-from array) nil) + (cond (displaced-to + (when (or initial-element-p initial-contents-p) + (error "Neither :INITIAL-ELEMENT nor :INITIAL-CONTENTS ~ + can be specified along with :DISPLACED-TO")) + (let ((offset (or displaced-index-offset 0))) + (when (> (+ offset total-size) + (array-total-size displaced-to)) + (error "~S doesn't have enough elements." displaced-to)) + (setf (%array-displacement array) offset) + (setf (%array-displaced-p array) t) + (%save-displaced-array-backpointer array data))) + (t + (setf (%array-displaced-p array) nil))) + (let ((axis 0)) + (dolist (dim dimensions) + (setf (%array-dimension array axis) dim) + (incf axis))) + array)))) + +(defun make-static-vector (length &key + (element-type '(unsigned-byte 8)) + (initial-contents nil initial-contents-p) + (initial-element nil initial-element-p)) + "Allocate vector of LENGTH elements in static space. Only allocation +of specialized arrays is supported." + ;; STEP 1: check inputs fully + ;; + ;; This way of doing explicit checks before the vector is allocated + ;; is expensive, but probably worth the trouble as once we've allocated + ;; the vector we have no way to get rid of it anymore... + (when (eq t (upgraded-array-element-type element-type)) + (error "Static arrays of type ~S not supported." + element-type)) + (when initial-contents-p + (when initial-element-p + (error "can't specify both :INITIAL-ELEMENT and :INITIAL-CONTENTS")) + (unless (= length (length initial-contents)) + (error "There are ~W elements in the :INITIAL-CONTENTS, but the ~ + vector length is ~W." + (length initial-contents) + length)) + (unless (every (lambda (x) (typep x element-type)) initial-contents) + (error ":INITIAL-CONTENTS contains elements not of type ~S." + element-type))) + (when initial-element-p + (unless (typep initial-element element-type) + (error ":INITIAL-ELEMENT ~S is not of type ~S." + initial-element element-type))) + ;; STEP 2 + ;; + ;; Allocate and possibly initialize the vector. + (multiple-value-bind (type n-bits) + (sb!impl::%vector-widetag-and-n-bits element-type) + (let ((vector + (allocate-static-vector type length + (ceiling (* length n-bits) + sb!vm:n-word-bits)))) + (cond (initial-element-p + (fill vector initial-element)) + (initial-contents-p + (replace vector initial-contents)) + (t + vector))))) + +;;; DATA-VECTOR-FROM-INITS returns a simple vector that has the +;;; specified array characteristics. Dimensions is only used to pass +;;; to FILL-DATA-VECTOR for error checking on the structure of +;;; initial-contents. (defun data-vector-from-inits (dimensions total-size element-type - initial-contents initial-element - initial-element-p) - (when (and initial-contents initial-element-p) - (error "Cannot supply both :initial-contents and :initial-element to - either make-array or adjust-array.")) + initial-contents initial-contents-p + initial-element initial-element-p) + (when (and initial-contents-p initial-element-p) + (error "cannot supply both :INITIAL-CONTENTS and :INITIAL-ELEMENT to + either MAKE-ARRAY or ADJUST-ARRAY.")) (let ((data (if initial-element-p - (make-array total-size - :element-type element-type - :initial-element initial-element) - (make-array total-size - :element-type element-type)))) + (make-array total-size + :element-type element-type + :initial-element initial-element) + (make-array total-size + :element-type element-type)))) (cond (initial-element-p - (unless (simple-vector-p data) - (unless (typep initial-element element-type) - (error "~S cannot be used to initialize an array of type ~S." - initial-element element-type)) - (fill (the vector data) initial-element))) - (initial-contents - (fill-data-vector data dimensions initial-contents))) + (unless (simple-vector-p data) + (unless (typep initial-element element-type) + (error "~S cannot be used to initialize an array of type ~S." + initial-element element-type)) + (fill (the vector data) initial-element))) + (initial-contents-p + (fill-data-vector data dimensions initial-contents))) data)) -(defun fill-data-vector (vector dimensions initial-contents) - (let ((index 0)) - (labels ((frob (axis dims contents) - (cond ((null dims) - (setf (aref vector index) contents) - (incf index)) - (t - (unless (typep contents 'sequence) - (error "Malformed :INITIAL-CONTENTS. ~S is not a ~ - sequence, but ~D more layer~:P needed." - contents - (- (length dimensions) axis))) - (unless (= (length contents) (car dims)) - (error "Malformed :INITIAL-CONTENTS. Dimension of ~ - axis ~D is ~D, but ~S is ~D long." - axis (car dims) contents (length contents))) - (if (listp contents) - (dolist (content contents) - (frob (1+ axis) (cdr dims) content)) - (dotimes (i (length contents)) - (frob (1+ axis) (cdr dims) (aref contents i)))))))) - (frob 0 dimensions initial-contents)))) - (defun vector (&rest objects) #!+sb-doc "Construct a SIMPLE-VECTOR from the given objects." (coerce (the list objects) 'simple-vector)) + ;;;; accessor/setter functions -(defun hairy-data-vector-ref (array index) - (with-array-data ((vector array) (index index) (end)) - (declare (ignore end) (optimize (safety 3))) - (macrolet ((dispatch (&rest stuff) - `(etypecase vector - ,@(mapcar #'(lambda (type) - (let ((atype `(simple-array ,type (*)))) - `(,atype - (data-vector-ref (the ,atype vector) - index)))) - stuff)))) - (dispatch - t - bit - character - (unsigned-byte 2) - (unsigned-byte 4) - (unsigned-byte 8) - (unsigned-byte 16) - (unsigned-byte 32) - (signed-byte 8) - (signed-byte 16) - (signed-byte 30) - (signed-byte 32) - single-float - double-float - #!+long-float long-float - (complex single-float) - (complex double-float) - #!+long-float (complex long-float))))) - -(defun hairy-data-vector-set (array index new-value) - (with-array-data ((vector array) (index index) (end)) - (declare (ignore end) (optimize (safety 3))) - (macrolet ((dispatch (&rest stuff) - `(etypecase vector - ,@(mapcar #'(lambda (type) - (let ((atype `(simple-array ,type (*)))) - `(,atype - (data-vector-set (the ,atype vector) - index - (the ,type - new-value))))) - stuff)))) - (dispatch - t - bit - character - (unsigned-byte 2) - (unsigned-byte 4) - (unsigned-byte 8) - (unsigned-byte 16) - (unsigned-byte 32) - (signed-byte 8) - (signed-byte 16) - (signed-byte 30) - (signed-byte 32) - single-float - double-float - #!+long-float long-float - (complex single-float) - (complex double-float) - #!+long-float (complex long-float))))) +;;; Dispatch to an optimized routine the data vector accessors for +;;; each different specialized vector type. Do dispatching by looking +;;; up the widetag in the array rather than with the typecases, which +;;; as of 1.0.5 compiles to a naive sequence of linear TYPEPs. Also +;;; provide separate versions where bounds checking has been moved +;;; from the callee to the caller, since it's much cheaper to do once +;;; the type information is available. Finally, for each of these +;;; routines also provide a slow path, taken for arrays that are not +;;; vectors or not simple. +(macrolet ((def (name table-name) + `(progn + (defglobal ,table-name (make-array ,(1+ sb!vm:widetag-mask))) + (defmacro ,name (array-var) + `(the function + (let ((tag 0)) + (when (sb!vm::%other-pointer-p ,array-var) + (setf tag (%other-pointer-widetag ,array-var))) + (svref ,',table-name tag))))))) + (def !find-data-vector-setter %%data-vector-setters%%) + (def !find-data-vector-setter/check-bounds %%data-vector-setters/check-bounds%%) + (def !find-data-vector-reffer %%data-vector-reffers%%) + (def !find-data-vector-reffer/check-bounds %%data-vector-reffers/check-bounds%%)) + +(macrolet ((%ref (accessor-getter extra-params) + `(funcall (,accessor-getter array) array index ,@extra-params)) + (define (accessor-name slow-accessor-name accessor-getter + extra-params check-bounds) + `(progn + (defun ,accessor-name (array index ,@extra-params) + (declare (optimize speed + ;; (SAFETY 0) is ok. All calls to + ;; these functions are generated by + ;; the compiler, so argument count + ;; checking isn't needed. Type checking + ;; is done implicitly via the widetag + ;; dispatch. + (safety 0))) + (%ref ,accessor-getter ,extra-params)) + (defun ,slow-accessor-name (array index ,@extra-params) + (declare (optimize speed (safety 0))) + (if (not (%array-displaced-p array)) + ;; The reasonably quick path of non-displaced complex + ;; arrays. + (let ((array (%array-data-vector array))) + (%ref ,accessor-getter ,extra-params)) + ;; The real slow path. + (with-array-data + ((vector array) + (index (locally + (declare (optimize (speed 1) (safety 1))) + (,@check-bounds index))) + (end) + :force-inline t) + (declare (ignore end)) + (,accessor-name vector index ,@extra-params))))))) + (define hairy-data-vector-ref slow-hairy-data-vector-ref + !find-data-vector-reffer + nil (progn)) + (define hairy-data-vector-set slow-hairy-data-vector-set + !find-data-vector-setter + (new-value) (progn)) + (define hairy-data-vector-ref/check-bounds + slow-hairy-data-vector-ref/check-bounds + !find-data-vector-reffer/check-bounds + nil (%check-bound array (array-dimension array 0))) + (define hairy-data-vector-set/check-bounds + slow-hairy-data-vector-set/check-bounds + !find-data-vector-setter/check-bounds + (new-value) (%check-bound array (array-dimension array 0)))) + +(defun hairy-ref-error (array index &optional new-value) + (declare (ignore index new-value)) + (error 'type-error + :datum array + :expected-type 'vector)) + +;;; Populate the dispatch tables. +(macrolet ((define-reffer (saetp check-form) + (let* ((type (sb!vm:saetp-specifier saetp)) + (atype `(simple-array ,type (*)))) + `(named-lambda optimized-data-vector-ref (vector index) + (declare (optimize speed (safety 0))) + (data-vector-ref (the ,atype vector) + (locally + (declare (optimize (safety 1))) + (the index + (,@check-form index))))))) + (define-setter (saetp check-form) + (let* ((type (sb!vm:saetp-specifier saetp)) + (atype `(simple-array ,type (*)))) + `(named-lambda optimized-data-vector-set (vector index new-value) + (declare (optimize speed (safety 0))) + (data-vector-set (the ,atype vector) + (locally + (declare (optimize (safety 1))) + (the index + (,@check-form index))) + (locally + ;; SPEED 1 needed to avoid the compiler + ;; from downgrading the type check to + ;; a cheaper one. + (declare (optimize (speed 1) + (safety 1))) + (the ,type new-value))) + ;; For specialized arrays, the return from + ;; data-vector-set would have to be reboxed to be a + ;; (Lisp) return value; instead, we use the + ;; already-boxed value as the return. + new-value))) + (define-reffers (symbol deffer check-form slow-path) + `(progn + ;; FIXME/KLUDGE: can't just FILL here, because genesis doesn't + ;; preserve the binding, so re-initiaize as NS doesn't have + ;; the energy to figure out to change that right now. + (setf ,symbol (make-array (1+ sb!vm::widetag-mask) + :initial-element #'hairy-ref-error)) + ,@(loop for widetag in '(sb!vm:complex-vector-widetag + sb!vm:complex-vector-nil-widetag + sb!vm:complex-bit-vector-widetag + #!+sb-unicode sb!vm:complex-character-string-widetag + sb!vm:complex-base-string-widetag + sb!vm:simple-array-widetag + sb!vm:complex-array-widetag) + collect `(setf (svref ,symbol ,widetag) ,slow-path)) + ,@(loop for saetp across sb!vm:*specialized-array-element-type-properties* + for widetag = (sb!vm:saetp-typecode saetp) + collect `(setf (svref ,symbol ,widetag) + (,deffer ,saetp ,check-form)))))) + (defun !hairy-data-vector-reffer-init () + (define-reffers %%data-vector-reffers%% define-reffer + (progn) + #'slow-hairy-data-vector-ref) + (define-reffers %%data-vector-setters%% define-setter + (progn) + #'slow-hairy-data-vector-set) + (define-reffers %%data-vector-reffers/check-bounds%% define-reffer + (%check-bound vector (length vector)) + #'slow-hairy-data-vector-ref/check-bounds) + (define-reffers %%data-vector-setters/check-bounds%% define-setter + (%check-bound vector (length vector)) + #'slow-hairy-data-vector-set/check-bounds))) + +;;; (Ordinary DATA-VECTOR-REF usage compiles into a vop, but +;;; DATA-VECTOR-REF is also FOLDABLE, and this ordinary function +;;; definition is needed for the compiler to use in constant folding.) +(defun data-vector-ref (array index) + (hairy-data-vector-ref array index)) + +(defun data-vector-ref-with-offset (array index offset) + (hairy-data-vector-ref array (+ index offset))) +(defun invalid-array-p (array) + (and (array-header-p array) + (consp (%array-displaced-p array)))) + +(declaim (ftype (function (array) nil) invalid-array-error)) +(defun invalid-array-error (array) + (aver (array-header-p array)) + ;; Array invalidation stashes the original dimensions here... + (let ((dims (%array-displaced-p array)) + (et (array-element-type array))) + (error 'invalid-array-error + :datum array + :expected-type + (if (cdr dims) + `(array ,et ,dims) + `(vector ,et ,@dims))))) + +(declaim (ftype (function (array integer integer &optional t) nil) + invalid-array-index-error)) +(defun invalid-array-index-error (array index bound &optional axis) + (if (invalid-array-p array) + (invalid-array-error array) + (error 'invalid-array-index-error + :array array + :axis axis + :datum index + :expected-type `(integer 0 (,bound))))) + +;;; SUBSCRIPTS has a dynamic-extent list structure and is destroyed (defun %array-row-major-index (array subscripts - &optional (invalid-index-error-p t)) + &optional (invalid-index-error-p t)) (declare (array array) - (list subscripts)) + (list subscripts)) (let ((rank (array-rank array))) (unless (= rank (length subscripts)) - (error "Wrong number of subscripts, ~D, for array of rank ~D" - (length subscripts) rank)) + (error "wrong number of subscripts, ~W, for array of rank ~W" + (length subscripts) rank)) (if (array-header-p array) - (do ((subs (nreverse subscripts) (cdr subs)) - (axis (1- (array-rank array)) (1- axis)) - (chunk-size 1) - (result 0)) - ((null subs) result) - (declare (list subs) (fixnum axis chunk-size result)) - (let ((index (car subs)) - (dim (%array-dimension array axis))) - (declare (fixnum index dim)) - (unless (< -1 index dim) - (if invalid-index-error-p - (error "Invalid index ~D~[~;~:; on axis ~:*~D~] in ~S" - index axis array) - (return-from %array-row-major-index nil))) - (incf result (* chunk-size index)) - (setf chunk-size (* chunk-size dim)))) - (let ((index (first subscripts))) - (unless (< -1 index (length (the (simple-array * (*)) array))) - (if invalid-index-error-p - (error "Invalid index ~D in ~S" index array) - (return-from %array-row-major-index nil))) - index)))) + (do ((subs (nreverse subscripts) (cdr subs)) + (axis (1- (array-rank array)) (1- axis)) + (chunk-size 1) + (result 0)) + ((null subs) result) + (declare (list subs) (fixnum axis chunk-size result)) + (let ((index (car subs)) + (dim (%array-dimension array axis))) + (declare (fixnum dim)) + (unless (and (fixnump index) (< -1 index dim)) + (if invalid-index-error-p + (invalid-array-index-error array index dim axis) + (return-from %array-row-major-index nil))) + (incf result (* chunk-size (the fixnum index))) + (setf chunk-size (* chunk-size dim)))) + (let ((index (first subscripts)) + (length (length (the (simple-array * (*)) array)))) + (unless (and (fixnump index) (< -1 index length)) + (if invalid-index-error-p + (invalid-array-index-error array index length) + (return-from %array-row-major-index nil))) + index)))) (defun array-in-bounds-p (array &rest subscripts) #!+sb-doc - "Returns T if the Subscipts are in bounds for the Array, Nil otherwise." + "Return T if the SUBSCRIPTS are in bounds for the ARRAY, NIL otherwise." (if (%array-row-major-index array subscripts nil) t)) (defun array-row-major-index (array &rest subscripts) + (declare (truly-dynamic-extent subscripts)) (%array-row-major-index array subscripts)) (defun aref (array &rest subscripts) #!+sb-doc - "Returns the element of the Array specified by the Subscripts." + "Return the element of the ARRAY specified by the SUBSCRIPTS." + (declare (truly-dynamic-extent subscripts)) (row-major-aref array (%array-row-major-index array subscripts))) (defun %aset (array &rest stuff) + (declare (truly-dynamic-extent stuff)) (let ((subscripts (butlast stuff)) - (new-value (car (last stuff)))) + (new-value (car (last stuff)))) (setf (row-major-aref array (%array-row-major-index array subscripts)) - new-value))) + new-value))) ;;; FIXME: What's supposed to happen with functions ;;; like AREF when we (DEFUN (SETF FOO) ..) when @@ -453,18 +567,26 @@ ;;; ZOO ;;; But that doesn't seem to be what happens in CMU CL. ;;; +;;; KLUDGE: this is probably because ANSI, in its wisdom (CLHS +;;; 5.1.2.5) requires implementations to support +;;; (SETF (APPLY #'AREF ...) ...) +;;; [and also #'BIT and #'SBIT]. Yes, this is terrifying, and it's +;;; also terrifying that this sequence of definitions causes it to +;;; work. +;;; ;;; Also, it would be nice to make DESCRIBE FOO tell whether a symbol ;;; has a setf expansion and/or a setf function defined. #!-sb-fluid (declaim (inline (setf aref))) (defun (setf aref) (new-value array &rest subscripts) + (declare (truly-dynamic-extent subscripts)) (declare (type array array)) (setf (row-major-aref array (%array-row-major-index array subscripts)) - new-value)) + new-value)) (defun row-major-aref (array index) #!+sb-doc - "Returns the element of array corressponding to the row-major index. This is + "Return the element of array corressponding to the row-major index. This is SETF'able." (declare (optimize (safety 1))) (row-major-aref array index)) @@ -475,7 +597,7 @@ (defun svref (simple-vector index) #!+sb-doc - "Returns the Index'th element of the given Simple-Vector." + "Return the INDEX'th element of the given Simple-Vector." (declare (optimize (safety 1))) (aref simple-vector index)) @@ -485,31 +607,31 @@ (defun bit (bit-array &rest subscripts) #!+sb-doc - "Returns the bit from the Bit-Array at the specified Subscripts." + "Return the bit from the BIT-ARRAY at the specified SUBSCRIPTS." (declare (type (array bit) bit-array) (optimize (safety 1))) (row-major-aref bit-array (%array-row-major-index bit-array subscripts))) (defun %bitset (bit-array &rest stuff) (declare (type (array bit) bit-array) (optimize (safety 1))) (let ((subscripts (butlast stuff)) - (new-value (car (last stuff)))) + (new-value (car (last stuff)))) (setf (row-major-aref bit-array - (%array-row-major-index bit-array subscripts)) - new-value))) + (%array-row-major-index bit-array subscripts)) + new-value))) #!-sb-fluid (declaim (inline (setf bit))) (defun (setf bit) (new-value bit-array &rest subscripts) (declare (type (array bit) bit-array) (optimize (safety 1))) (setf (row-major-aref bit-array - (%array-row-major-index bit-array subscripts)) - new-value)) + (%array-row-major-index bit-array subscripts)) + new-value)) (defun sbit (simple-bit-array &rest subscripts) #!+sb-doc - "Returns the bit from the Simple-Bit-Array at the specified Subscripts." + "Return the bit from SIMPLE-BIT-ARRAY at the specified SUBSCRIPTS." (declare (type (simple-array bit) simple-bit-array) (optimize (safety 1))) (row-major-aref simple-bit-array - (%array-row-major-index simple-bit-array subscripts))) + (%array-row-major-index simple-bit-array subscripts))) ;;; KLUDGE: Not all these things (%SET-ROW-MAJOR-AREF, %SET-FILL-POINTER, ;;; %SET-FDEFINITION, %SCHARSET, %SBITSET..) seem to deserve separate names. @@ -518,102 +640,91 @@ (defun %sbitset (simple-bit-array &rest stuff) (declare (type (simple-array bit) simple-bit-array) (optimize (safety 1))) (let ((subscripts (butlast stuff)) - (new-value (car (last stuff)))) + (new-value (car (last stuff)))) (setf (row-major-aref simple-bit-array - (%array-row-major-index simple-bit-array subscripts)) - new-value))) + (%array-row-major-index simple-bit-array subscripts)) + new-value))) #!-sb-fluid (declaim (inline (setf sbit))) (defun (setf sbit) (new-value bit-array &rest subscripts) (declare (type (simple-array bit) bit-array) (optimize (safety 1))) (setf (row-major-aref bit-array - (%array-row-major-index bit-array subscripts)) - new-value)) + (%array-row-major-index bit-array subscripts)) + new-value)) ;;;; miscellaneous array properties (defun array-element-type (array) #!+sb-doc - "Returns the type of the elements of the array" - (let ((type (get-type array))) + "Return the type of the elements of the array" + (let ((widetag (widetag-of array))) (macrolet ((pick-element-type (&rest stuff) - `(cond ,@(mapcar #'(lambda (stuff) - (cons - (let ((item (car stuff))) - (cond ((eq item t) - t) - ((listp item) - (cons 'or - (mapcar #'(lambda (x) - `(= type ,x)) - item))) - (t - `(= type ,item)))) - (cdr stuff))) - stuff)))) - (pick-element-type - ((sb!vm:simple-string-type sb!vm:complex-string-type) 'base-char) - ((sb!vm:simple-bit-vector-type sb!vm:complex-bit-vector-type) 'bit) - (sb!vm:simple-vector-type t) - (sb!vm:simple-array-unsigned-byte-2-type '(unsigned-byte 2)) - (sb!vm:simple-array-unsigned-byte-4-type '(unsigned-byte 4)) - (sb!vm:simple-array-unsigned-byte-8-type '(unsigned-byte 8)) - (sb!vm:simple-array-unsigned-byte-16-type '(unsigned-byte 16)) - (sb!vm:simple-array-unsigned-byte-32-type '(unsigned-byte 32)) - (sb!vm:simple-array-signed-byte-8-type '(signed-byte 8)) - (sb!vm:simple-array-signed-byte-16-type '(signed-byte 16)) - (sb!vm:simple-array-signed-byte-30-type '(signed-byte 30)) - (sb!vm:simple-array-signed-byte-32-type '(signed-byte 32)) - (sb!vm:simple-array-single-float-type 'single-float) - (sb!vm:simple-array-double-float-type 'double-float) - #!+long-float - (sb!vm:simple-array-long-float-type 'long-float) - (sb!vm:simple-array-complex-single-float-type '(complex single-float)) - (sb!vm:simple-array-complex-double-float-type '(complex double-float)) - #!+long-float - (sb!vm:simple-array-complex-long-float-type '(complex long-float)) - ((sb!vm:simple-array-type sb!vm:complex-vector-type - sb!vm:complex-array-type) - (with-array-data ((array array) (start) (end)) - (declare (ignore start end)) - (array-element-type array))) - (t - (error "~S is not an array." array)))))) + `(cond ,@(mapcar (lambda (stuff) + (cons + (let ((item (car stuff))) + (cond ((eq item t) + t) + ((listp item) + (cons 'or + (mapcar (lambda (x) + `(= widetag ,x)) + item))) + (t + `(= widetag ,item)))) + (cdr stuff))) + stuff)))) + #.`(pick-element-type + ,@(map 'list + (lambda (saetp) + `(,(if (sb!vm:saetp-complex-typecode saetp) + (list (sb!vm:saetp-typecode saetp) + (sb!vm:saetp-complex-typecode saetp)) + (sb!vm:saetp-typecode saetp)) + ',(sb!vm:saetp-specifier saetp))) + sb!vm:*specialized-array-element-type-properties*) + ((sb!vm:simple-array-widetag + sb!vm:complex-vector-widetag + sb!vm:complex-array-widetag) + (with-array-data ((array array) (start) (end)) + (declare (ignore start end)) + (array-element-type array))) + (t + (error 'type-error :datum array :expected-type 'array)))))) (defun array-rank (array) #!+sb-doc - "Returns the number of dimensions of the Array." + "Return the number of dimensions of ARRAY." (if (array-header-p array) (%array-rank array) 1)) (defun array-dimension (array axis-number) #!+sb-doc - "Returns length of dimension Axis-Number of the Array." + "Return the length of dimension AXIS-NUMBER of ARRAY." (declare (array array) (type index axis-number)) (cond ((not (array-header-p array)) - (unless (= axis-number 0) - (error "Vector axis is not zero: ~S" axis-number)) - (length (the (simple-array * (*)) array))) - ((>= axis-number (%array-rank array)) - (error "~D is too big; ~S only has ~D dimension~:P" - axis-number array (%array-rank array))) - (t - (%array-dimension array axis-number)))) + (unless (= axis-number 0) + (error "Vector axis is not zero: ~S" axis-number)) + (length (the (simple-array * (*)) array))) + ((>= axis-number (%array-rank array)) + (error "Axis number ~W is too big; ~S only has ~D dimension~:P." + axis-number array (%array-rank array))) + (t + (%array-dimension array axis-number)))) (defun array-dimensions (array) #!+sb-doc - "Returns a list whose elements are the dimensions of the array" + "Return a list whose elements are the dimensions of the array" (declare (array array)) (if (array-header-p array) (do ((results nil (cons (array-dimension array index) results)) - (index (1- (array-rank array)) (1- index))) - ((minusp index) results)) + (index (1- (array-rank array)) (1- index))) + ((minusp index) results)) (list (array-dimension array 0)))) (defun array-total-size (array) #!+sb-doc - "Returns the total number of elements in the Array." + "Return the total number of elements in the Array." (declare (array array)) (if (array-header-p array) (%array-available-elements array) @@ -621,372 +732,537 @@ (defun array-displacement (array) #!+sb-doc - "Returns values of :displaced-to and :displaced-index-offset options to - make-array, or the defaults nil and 0 if not a displaced array." - (declare (array array)) - (values (%array-data-vector array) (%array-displacement array))) + "Return the values of :DISPLACED-TO and :DISPLACED-INDEX-offset + options to MAKE-ARRAY, or NIL and 0 if not a displaced array." + (declare (type array array)) + (if (and (array-header-p array) ; if unsimple and + (%array-displaced-p array)) ; displaced + (values (%array-data-vector array) (%array-displacement array)) + (values nil 0))) (defun adjustable-array-p (array) #!+sb-doc - "Returns T if (adjust-array array...) would return an array identical + "Return T if (ADJUST-ARRAY ARRAY...) would return an array identical to the argument, this happens for complex arrays." (declare (array array)) + ;; Note that this appears not to be a fundamental limitation. + ;; non-vector SIMPLE-ARRAYs are in fact capable of being adjusted, + ;; but in practice we test using ADJUSTABLE-ARRAY-P in ADJUST-ARRAY. + ;; -- CSR, 2004-03-01. (not (typep array 'simple-array))) ;;;; fill pointer frobbing stuff (defun array-has-fill-pointer-p (array) #!+sb-doc - "Returns T if the given Array has a fill pointer, or Nil otherwise." + "Return T if the given ARRAY has a fill pointer, or NIL otherwise." (declare (array array)) (and (array-header-p array) (%array-fill-pointer-p array))) +(defun fill-pointer-error (vector arg) + (cond (arg + (aver (array-has-fill-pointer-p vector)) + (let ((max (%array-available-elements vector))) + (error 'simple-type-error + :datum arg + :expected-type (list 'integer 0 max) + :format-control "The new fill pointer, ~S, is larger than the length of the vector (~S.)" + :format-arguments (list arg max)))) + (t + (error 'simple-type-error + :datum vector + :expected-type '(and vector (satisfies array-has-fill-pointer-p)) + :format-control "~S is not an array with a fill pointer." + :format-arguments (list vector))))) + (defun fill-pointer (vector) #!+sb-doc - "Returns the Fill-Pointer of the given Vector." - (declare (vector vector)) - (if (and (array-header-p vector) (%array-fill-pointer-p vector)) + "Return the FILL-POINTER of the given VECTOR." + (if (array-has-fill-pointer-p vector) (%array-fill-pointer vector) - (error 'simple-type-error - :datum vector - :expected-type '(and vector (satisfies array-has-fill-pointer-p)) - :format-control - "~S is not an array with a fill-pointer." - :format-arguments (list vector)))) + (fill-pointer-error vector nil))) (defun %set-fill-pointer (vector new) - (declare (vector vector) (fixnum new)) - (if (and (array-header-p vector) (%array-fill-pointer-p vector)) - (if (> new (%array-available-elements vector)) - (error "New fill pointer, ~S, is larger than the length of the vector." - new) - (setf (%array-fill-pointer vector) new)) - (error 'simple-type-error - :datum vector - :expected-type '(and vector (satisfies array-has-fill-pointer-p)) - :format-control "~S is not an array with a fill-pointer." - :format-arguments (list vector)))) + (flet ((oops (x) + (fill-pointer-error vector x))) + (if (array-has-fill-pointer-p vector) + (if (> new (%array-available-elements vector)) + (oops new) + (setf (%array-fill-pointer vector) new)) + (oops nil)))) +;;; FIXME: It'd probably make sense to use a MACROLET to share the +;;; guts of VECTOR-PUSH between VECTOR-PUSH-EXTEND. Such a macro +;;; should probably be based on the VECTOR-PUSH-EXTEND code (which is +;;; new ca. sbcl-0.7.0) rather than the VECTOR-PUSH code (which dates +;;; back to CMU CL). (defun vector-push (new-el array) #!+sb-doc - "Attempts to set the element of Array designated by the fill pointer - to New-El and increment fill pointer by one. If the fill pointer is - too large, Nil is returned, otherwise the index of the pushed element is + "Attempt to set the element of ARRAY designated by its fill pointer + to NEW-EL, and increment the fill pointer by one. If the fill pointer is + too large, NIL is returned, otherwise the index of the pushed element is returned." (declare (vector array)) (let ((fill-pointer (fill-pointer array))) (declare (fixnum fill-pointer)) (cond ((= fill-pointer (%array-available-elements array)) - nil) - (t - (setf (aref array fill-pointer) new-el) - (setf (%array-fill-pointer array) (1+ fill-pointer)) - fill-pointer)))) - -(defun vector-push-extend (new-el array &optional - (extension (if (zerop (length array)) - 1 - (length array)))) - #!+sb-doc - "Like Vector-Push except that if the fill pointer gets too large, the - Array is extended rather than Nil being returned." - (declare (vector array) (fixnum extension)) - (let ((fill-pointer (fill-pointer array))) + nil) + (t + (locally (declare (optimize (safety 0))) + (setf (aref array fill-pointer) new-el)) + (setf (%array-fill-pointer array) (1+ fill-pointer)) + fill-pointer)))) + +(defun vector-push-extend (new-element + vector + &optional + (min-extension + (let ((length (length vector))) + (min (1+ length) + (- array-dimension-limit length))))) + (declare (vector vector) (fixnum min-extension)) + (let ((fill-pointer (fill-pointer vector))) (declare (fixnum fill-pointer)) - (when (= fill-pointer (%array-available-elements array)) - (adjust-array array (+ fill-pointer extension))) - (setf (aref array fill-pointer) new-el) - (setf (%array-fill-pointer array) (1+ fill-pointer)) + (when (= fill-pointer (%array-available-elements vector)) + (adjust-array vector (+ fill-pointer (max 1 min-extension)))) + ;; disable bounds checking + (locally (declare (optimize (safety 0))) + (setf (aref vector fill-pointer) new-element)) + (setf (%array-fill-pointer vector) (1+ fill-pointer)) fill-pointer)) (defun vector-pop (array) #!+sb-doc - "Attempts to decrease the fill-pointer by 1 and return the element - pointer to by the new fill pointer. If the original value of the fill - pointer is 0, an error occurs." + "Decrease the fill pointer by 1 and return the element pointed to by the + new fill pointer." (declare (vector array)) (let ((fill-pointer (fill-pointer array))) (declare (fixnum fill-pointer)) (if (zerop fill-pointer) - (error "Nothing left to pop.") - (aref array - (setf (%array-fill-pointer array) - (1- fill-pointer)))))) + (error "There is nothing left to pop.") + ;; disable bounds checking (and any fixnum test) + (locally (declare (optimize (safety 0))) + (aref array + (setf (%array-fill-pointer array) + (1- fill-pointer))))))) + ;;;; ADJUST-ARRAY (defun adjust-array (array dimensions &key - (element-type (array-element-type array)) - (initial-element nil initial-element-p) - initial-contents fill-pointer - displaced-to displaced-index-offset) + (element-type (array-element-type array)) + (initial-element nil initial-element-p) + (initial-contents nil initial-contents-p) + fill-pointer + displaced-to displaced-index-offset) #!+sb-doc - "Adjusts the Array's dimensions to the given Dimensions and stuff." + "Adjust ARRAY's dimensions to the given DIMENSIONS and stuff." + (when (invalid-array-p array) + (invalid-array-error array)) (let ((dimensions (if (listp dimensions) dimensions (list dimensions)))) (cond ((/= (the fixnum (length (the list dimensions))) - (the fixnum (array-rank array))) - (error "Number of dimensions not equal to rank of array.")) - ((not (subtypep element-type (array-element-type array))) - (error "New element type, ~S, is incompatible with old." - element-type))) + (the fixnum (array-rank array))) + (error "The number of dimensions not equal to rank of array.")) + ((not (subtypep element-type (array-element-type array))) + (error "The new element type, ~S, is incompatible with old type." + element-type)) + ((and fill-pointer (not (array-has-fill-pointer-p array))) + (error 'type-error + :datum array + :expected-type '(satisfies array-has-fill-pointer-p)))) (let ((array-rank (length (the list dimensions)))) (declare (fixnum array-rank)) - (when (and fill-pointer (> array-rank 1)) - (error "Multidimensional arrays can't have fill pointers.")) - (cond (initial-contents - ;; Array former contents replaced by initial-contents. - (if (or initial-element-p displaced-to) - (error "Initial contents may not be specified with ~ - the :initial-element or :displaced-to option.")) - (let* ((array-size (apply #'* dimensions)) - (array-data (data-vector-from-inits - dimensions array-size element-type - initial-contents initial-element - initial-element-p))) - (if (adjustable-array-p array) - (set-array-header array array-data array-size - (get-new-fill-pointer array array-size - fill-pointer) - 0 dimensions nil) - (if (array-header-p array) - ;; Simple multidimensional or single dimensional array. - (make-array dimensions - :element-type element-type - :initial-contents initial-contents) - array-data)))) - (displaced-to - ;; No initial-contents supplied is already established. - (when initial-element - (error "The :initial-element option may not be specified ~ - with :displaced-to.")) - (unless (subtypep element-type (array-element-type displaced-to)) - (error "One can't displace an array of type ~S into another of ~ - type ~S." - element-type (array-element-type displaced-to))) - (let ((displacement (or displaced-index-offset 0)) - (array-size (apply #'* dimensions))) - (declare (fixnum displacement array-size)) - (if (< (the fixnum (array-total-size displaced-to)) - (the fixnum (+ displacement array-size))) - (error "The :displaced-to array is too small.")) - (if (adjustable-array-p array) - ;; None of the original contents appear in adjusted array. - (set-array-header array displaced-to array-size - (get-new-fill-pointer array array-size - fill-pointer) - displacement dimensions t) - ;; Simple multidimensional or single dimensional array. - (make-array dimensions - :element-type element-type - :displaced-to displaced-to - :displaced-index-offset - displaced-index-offset)))) - ((= array-rank 1) - (let ((old-length (array-total-size array)) - (new-length (car dimensions)) - new-data) - (declare (fixnum old-length new-length)) - (with-array-data ((old-data array) (old-start) - (old-end old-length)) - (cond ((or (%array-displaced-p array) - (< old-length new-length)) - (setf new-data - (data-vector-from-inits - dimensions new-length element-type - initial-contents initial-element - initial-element-p)) - (replace new-data old-data - :start2 old-start :end2 old-end)) - (t (setf new-data - (shrink-vector old-data new-length)))) - (if (adjustable-array-p array) - (set-array-header array new-data new-length - (get-new-fill-pointer array new-length - fill-pointer) - 0 dimensions nil) - new-data)))) - (t - (let ((old-length (%array-available-elements array)) - (new-length (apply #'* dimensions))) - (declare (fixnum old-length new-length)) - (with-array-data ((old-data array) (old-start) - (old-end old-length)) - (declare (ignore old-end)) - (let ((new-data (if (or (%array-displaced-p array) - (> new-length old-length)) - (data-vector-from-inits - dimensions new-length - element-type () initial-element - initial-element-p) - old-data))) - (if (or (zerop old-length) (zerop new-length)) - (when initial-element-p (fill new-data initial-element)) - (zap-array-data old-data (array-dimensions array) - old-start - new-data dimensions new-length - element-type initial-element - initial-element-p)) - (set-array-header array new-data new-length - new-length 0 dimensions nil))))))))) + (unless (= array-rank 1) + (when fill-pointer + (error "Only vectors can have fill pointers."))) + (cond (initial-contents-p + ;; array former contents replaced by INITIAL-CONTENTS + (if (or initial-element-p displaced-to) + (error "INITIAL-CONTENTS may not be specified with ~ + the :INITIAL-ELEMENT or :DISPLACED-TO option.")) + (let* ((array-size (apply #'* dimensions)) + (array-data (data-vector-from-inits + dimensions array-size element-type + initial-contents initial-contents-p + initial-element initial-element-p))) + (if (adjustable-array-p array) + (set-array-header array array-data array-size + (get-new-fill-pointer array array-size + fill-pointer) + 0 dimensions nil nil) + (if (array-header-p array) + ;; simple multidimensional or single dimensional array + (make-array dimensions + :element-type element-type + :initial-contents initial-contents) + array-data)))) + (displaced-to + ;; We already established that no INITIAL-CONTENTS was supplied. + (when initial-element + (error "The :INITIAL-ELEMENT option may not be specified ~ + with :DISPLACED-TO.")) + (unless (subtypep element-type (array-element-type displaced-to)) + (error "can't displace an array of type ~S into another of ~ + type ~S" + element-type (array-element-type displaced-to))) + (let ((displacement (or displaced-index-offset 0)) + (array-size (apply #'* dimensions))) + (declare (fixnum displacement array-size)) + (if (< (the fixnum (array-total-size displaced-to)) + (the fixnum (+ displacement array-size))) + (error "The :DISPLACED-TO array is too small.")) + (if (adjustable-array-p array) + ;; None of the original contents appear in adjusted array. + (set-array-header array displaced-to array-size + (get-new-fill-pointer array array-size + fill-pointer) + displacement dimensions t nil) + ;; simple multidimensional or single dimensional array + (make-array dimensions + :element-type element-type + :displaced-to displaced-to + :displaced-index-offset + displaced-index-offset)))) + ((= array-rank 1) + (let ((old-length (array-total-size array)) + (new-length (car dimensions)) + new-data) + (declare (fixnum old-length new-length)) + (with-array-data ((old-data array) (old-start) + (old-end old-length)) + (cond ((or (and (array-header-p array) + (%array-displaced-p array)) + (< old-length new-length)) + (setf new-data + (data-vector-from-inits + dimensions new-length element-type + initial-contents initial-contents-p + initial-element initial-element-p)) + (replace new-data old-data + :start2 old-start :end2 old-end)) + (t (setf new-data + (shrink-vector old-data new-length)))) + (if (adjustable-array-p array) + (set-array-header array new-data new-length + (get-new-fill-pointer array new-length + fill-pointer) + 0 dimensions nil nil) + new-data)))) + (t + (let ((old-length (%array-available-elements array)) + (new-length (apply #'* dimensions))) + (declare (fixnum old-length new-length)) + (with-array-data ((old-data array) (old-start) + (old-end old-length)) + (declare (ignore old-end)) + (let ((new-data (if (or (and (array-header-p array) + (%array-displaced-p array)) + (> new-length old-length)) + (data-vector-from-inits + dimensions new-length + element-type () nil + initial-element initial-element-p) + old-data))) + (if (or (zerop old-length) (zerop new-length)) + (when initial-element-p (fill new-data initial-element)) + (zap-array-data old-data (array-dimensions array) + old-start + new-data dimensions new-length + element-type initial-element + initial-element-p)) + (if (adjustable-array-p array) + (set-array-header array new-data new-length + nil 0 dimensions nil nil) + (let ((new-array + (make-array-header + sb!vm:simple-array-widetag array-rank))) + (set-array-header new-array new-data new-length + nil 0 dimensions nil t))))))))))) + (defun get-new-fill-pointer (old-array new-array-size fill-pointer) (cond ((not fill-pointer) - (when (array-has-fill-pointer-p old-array) - (when (> (%array-fill-pointer old-array) new-array-size) - (error "Cannot adjust-array an array (~S) to a size (~S) that is ~ - smaller than its fill pointer (~S)." - old-array new-array-size (fill-pointer old-array))) - (%array-fill-pointer old-array))) - ((not (array-has-fill-pointer-p old-array)) - (error "Cannot supply a non-NIL value (~S) for :fill-pointer ~ - in adjust-array unless the array (~S) was originally ~ - created with a fill pointer." - fill-pointer - old-array)) - ((numberp fill-pointer) - (when (> fill-pointer new-array-size) - (error "Cannot supply a value for :fill-pointer (~S) that is larger ~ - than the new length of the vector (~S)." - fill-pointer new-array-size)) - fill-pointer) - ((eq fill-pointer t) - new-array-size) - (t - (error "Bogus value for :fill-pointer in adjust-array: ~S" - fill-pointer)))) - -(defun shrink-vector (vector new-size) - #!+sb-doc - "Destructively alters the Vector, changing its length to New-Size, which - must be less than or equal to its current size." + (when (array-has-fill-pointer-p old-array) + (when (> (%array-fill-pointer old-array) new-array-size) + (error "cannot ADJUST-ARRAY an array (~S) to a size (~S) that is ~ + smaller than its fill pointer (~S)" + old-array new-array-size (fill-pointer old-array))) + (%array-fill-pointer old-array))) + ((not (array-has-fill-pointer-p old-array)) + (error "cannot supply a non-NIL value (~S) for :FILL-POINTER ~ + in ADJUST-ARRAY unless the array (~S) was originally ~ + created with a fill pointer" + fill-pointer + old-array)) + ((numberp fill-pointer) + (when (> fill-pointer new-array-size) + (error "can't supply a value for :FILL-POINTER (~S) that is larger ~ + than the new length of the vector (~S)" + fill-pointer new-array-size)) + fill-pointer) + ((eq fill-pointer t) + new-array-size) + (t + (error "bogus value for :FILL-POINTER in ADJUST-ARRAY: ~S" + fill-pointer)))) + +;;; Destructively alter VECTOR, changing its length to NEW-LENGTH, +;;; which must be less than or equal to its current length. This can +;;; be called on vectors without a fill pointer but it is extremely +;;; dangerous to do so: shrinking the size of an object (as viewed by +;;; the gc) makes bounds checking unreliable in the face of interrupts +;;; or multi-threading. Call it only on provably local vectors. +(defun %shrink-vector (vector new-length) (declare (vector vector)) (unless (array-header-p vector) (macrolet ((frob (name &rest things) - `(etypecase ,name - ,@(mapcar #'(lambda (thing) - `(,(car thing) - (fill (truly-the ,(car thing) ,name) - ,(cadr thing) - :start new-size))) - things)))) - (frob vector - (simple-vector 0) - (simple-base-string #.default-init-char) - (simple-bit-vector 0) - ((simple-array (unsigned-byte 2) (*)) 0) - ((simple-array (unsigned-byte 4) (*)) 0) - ((simple-array (unsigned-byte 8) (*)) 0) - ((simple-array (unsigned-byte 16) (*)) 0) - ((simple-array (unsigned-byte 32) (*)) 0) - ((simple-array (signed-byte 8) (*)) 0) - ((simple-array (signed-byte 16) (*)) 0) - ((simple-array (signed-byte 30) (*)) 0) - ((simple-array (signed-byte 32) (*)) 0) - ((simple-array single-float (*)) (coerce 0 'single-float)) - ((simple-array double-float (*)) (coerce 0 'double-float)) - #!+long-float - ((simple-array long-float (*)) (coerce 0 'long-float)) - ((simple-array (complex single-float) (*)) - (coerce 0 '(complex single-float))) - ((simple-array (complex double-float) (*)) - (coerce 0 '(complex double-float))) - #!+long-float - ((simple-array (complex long-float) (*)) - (coerce 0 '(complex long-float)))))) + `(etypecase ,name + ((simple-array nil (*)) (error 'nil-array-accessed-error)) + ,@(mapcar (lambda (thing) + (destructuring-bind (type-spec fill-value) + thing + `(,type-spec + (fill (truly-the ,type-spec ,name) + ,fill-value + :start new-length)))) + things)))) + ;; Set the 'tail' of the vector to the appropriate type of zero, + ;; "because in some cases we'll scavenge larger areas in one go, + ;; like groups of pages that had triggered the write barrier, or + ;; the whole static space" according to jsnell. + #.`(frob vector + ,@(map 'list + (lambda (saetp) + `((simple-array ,(sb!vm:saetp-specifier saetp) (*)) + ,(if (or (eq (sb!vm:saetp-specifier saetp) 'character) + #!+sb-unicode + (eq (sb!vm:saetp-specifier saetp) 'base-char)) + *default-init-char-form* + (sb!vm:saetp-initial-element-default saetp)))) + (remove-if-not + #'sb!vm:saetp-specifier + sb!vm:*specialized-array-element-type-properties*))))) ;; Only arrays have fill-pointers, but vectors have their length ;; parameter in the same place. - (setf (%array-fill-pointer vector) new-size) + (setf (%array-fill-pointer vector) new-length) vector) +(defun shrink-vector (vector new-length) + (declare (vector vector)) + (cond + ((eq (length vector) new-length) + vector) + ((array-has-fill-pointer-p vector) + (setf (%array-fill-pointer vector) new-length) + vector) + (t (subseq vector 0 new-length)))) + +;;; BIG THREAD SAFETY NOTE +;;; +;;; ADJUST-ARRAY/SET-ARRAY-HEADER, and its callees are very +;;; thread unsafe. They are nonatomic, and can mess with parallel +;;; code using the same arrays. +;;; +;;; A likely seeming fix is an additional level of indirection: +;;; ARRAY-HEADER -> ARRAY-INFO -> ... where ARRAY-HEADER would +;;; hold nothing but the pointer to ARRAY-INFO, and ARRAY-INFO +;;; would hold everything ARRAY-HEADER now holds. This allows +;;; consing up a new ARRAY-INFO and replacing it atomically in +;;; the ARRAY-HEADER. +;;; +;;; %WALK-DISPLACED-ARRAY-BACKPOINTERS is an especially nasty +;;; one: not only is it needed extremely rarely, which makes +;;; any thread safety bugs involving it look like rare random +;;; corruption, but because it walks the chain *upwards*, which +;;; may violate user expectations. + +(defun %save-displaced-array-backpointer (array data) + (flet ((purge (pointers) + (remove-if (lambda (value) + (or (not value) (eq array value))) + pointers + :key #'weak-pointer-value))) + ;; Add backpointer to the new data vector if it has a header. + (when (array-header-p data) + (setf (%array-displaced-from data) + (cons (make-weak-pointer array) + (purge (%array-displaced-from data))))) + ;; Remove old backpointer, if any. + (let ((old-data (%array-data-vector array))) + (when (and (neq data old-data) (array-header-p old-data)) + (setf (%array-displaced-from old-data) + (purge (%array-displaced-from old-data))))))) + +(defun %walk-displaced-array-backpointers (array new-length) + (dolist (p (%array-displaced-from array)) + (let ((from (weak-pointer-value p))) + (when (and from (eq array (%array-data-vector from))) + (let ((requires (+ (%array-available-elements from) + (%array-displacement from)))) + (unless (>= new-length requires) + ;; ANSI sayeth (ADJUST-ARRAY dictionary entry): + ;; + ;; "If A is displaced to B, the consequences are unspecified if B is + ;; adjusted in such a way that it no longer has enough elements to + ;; satisfy A. + ;; + ;; since we're hanging on a weak pointer here, we can't signal an + ;; error right now: the array that we're looking at might be + ;; garbage. Instead, we set all dimensions to zero so that next + ;; safe access to the displaced array will trap. Additionally, we + ;; save the original dimensions, so we can signal a more + ;; understandable error when the time comes. + (%walk-displaced-array-backpointers from 0) + (setf (%array-fill-pointer from) 0 + (%array-available-elements from) 0 + (%array-displaced-p from) (array-dimensions array)) + (dotimes (i (%array-rank from)) + (setf (%array-dimension from i) 0)))))))) + +;;; Fill in array header with the provided information, and return the array. (defun set-array-header (array data length fill-pointer displacement dimensions - &optional displacedp) - #!+sb-doc - "Fills in array header with provided information. Returns array." + displacedp newp) + (if newp + (setf (%array-displaced-from array) nil) + (%walk-displaced-array-backpointers array length)) + (when displacedp + (%save-displaced-array-backpointer array data)) (setf (%array-data-vector array) data) (setf (%array-available-elements array) length) (cond (fill-pointer - (setf (%array-fill-pointer array) fill-pointer) - (setf (%array-fill-pointer-p array) t)) - (t - (setf (%array-fill-pointer array) length) - (setf (%array-fill-pointer-p array) nil))) + (setf (%array-fill-pointer array) fill-pointer) + (setf (%array-fill-pointer-p array) t)) + (t + (setf (%array-fill-pointer array) length) + (setf (%array-fill-pointer-p array) nil))) (setf (%array-displacement array) displacement) (if (listp dimensions) (dotimes (axis (array-rank array)) - (declare (type index axis)) - (setf (%array-dimension array axis) (pop dimensions))) + (declare (type index axis)) + (setf (%array-dimension array axis) (pop dimensions))) (setf (%array-dimension array 0) dimensions)) (setf (%array-displaced-p array) displacedp) array) + +;;; User visible extension +(declaim (ftype (function (array) (values (simple-array * (*)) &optional)) + array-storage-vector)) +(defun array-storage-vector (array) + "Returns the underlying storage vector of ARRAY, which must be a non-displaced array. + +In SBCL, if ARRAY is a of type \(SIMPLE-ARRAY * \(*)), it is its own storage +vector. Multidimensional arrays, arrays with fill pointers, and adjustable +arrays have an underlying storage vector with the same ARRAY-ELEMENT-TYPE as +ARRAY, which this function returns. + +Important note: the underlying vector is an implementation detail. Even though +this function exposes it, changes in the implementation may cause this +function to be removed without further warning." + ;; KLUDGE: Without TRULY-THE the system is not smart enough to figure out that + ;; the return value is always of the known type. + (truly-the (simple-array * (*)) + (if (array-header-p array) + (if (%array-displaced-p array) + (error "~S cannot be used with displaced arrays. Use ~S instead." + 'array-storage-vector 'array-displacement) + (%array-data-vector array)) + array))) +;;;; used by SORT + +;;; temporary vector for stable sorting vectors, allocated for each new thread +(defvar *merge-sort-temp-vector* (vector)) +(declaim (simple-vector *merge-sort-temp-vector*)) + ;;;; ZAP-ARRAY-DATA for ADJUST-ARRAY -;;; Make a temporary to be used when old-data and new-data are EQ. -;;; KLUDGE: Boy, DYNAMIC-EXTENT would be nice. -(defvar *zap-array-data-temp* (make-array 1000 :initial-element t)) +;;; a temporary to be used when OLD-DATA and NEW-DATA are EQ. +;;; KLUDGE: Boy, DYNAMIC-EXTENT would be nice. This is rebound +;;; to length zero array in each new thread. +;;; +;;; DX is probably a bad idea, because a with a big array it would +;;; be fairly easy to blow the stack. +(defvar *zap-array-data-temp* (vector)) +(declaim (simple-vector *zap-array-data-temp*)) -(defun zap-array-data-temp (length element-type initial-element - initial-element-p) +(defun zap-array-data-temp (length initial-element initial-element-p) (declare (fixnum length)) - (when (> length (the fixnum (length *zap-array-data-temp*))) - (setf *zap-array-data-temp* - (make-array length :initial-element t))) - (when initial-element-p - (unless (typep initial-element element-type) - (error "~S cannot be used to initialize an array of type ~S." - initial-element element-type)) - (fill (the simple-vector *zap-array-data-temp*) initial-element - :end length)) - *zap-array-data-temp*) - -;;; This does the grinding work for ADJUST-ARRAY. It zaps the data from the -;;; Old-Data in an arrangement specified by the Old-Dims to the New-Data in an -;;; arrangement specified by the New-Dims. Offset is a displaced offset to be -;;; added to computed indexes of Old-Data. New-Length, Element-Type, -;;; Initial-Element, and Initial-Element-P are used when Old-Data and New-Data -;;; are EQ; in this case, a temporary must be used and filled appropriately. -;;; When Old-Data and New-Data are not EQ, New-Data has already been filled -;;; with any specified initial-element. + (let ((tmp *zap-array-data-temp*)) + (declare (simple-vector tmp)) + (cond ((> length (length tmp)) + (setf *zap-array-data-temp* + (if initial-element-p + (make-array length :initial-element initial-element) + (make-array length)))) + (initial-element-p + (fill tmp initial-element :end length)) + (t + tmp)))) + +;;; This does the grinding work for ADJUST-ARRAY. It zaps the data +;;; from the OLD-DATA in an arrangement specified by the OLD-DIMS to +;;; the NEW-DATA in an arrangement specified by the NEW-DIMS. OFFSET +;;; is a displaced offset to be added to computed indices of OLD-DATA. (defun zap-array-data (old-data old-dims offset new-data new-dims new-length - element-type initial-element initial-element-p) + element-type initial-element initial-element-p) (declare (list old-dims new-dims)) - (setq old-dims (nreverse old-dims)) - (setq new-dims (reverse new-dims)) - (if (eq old-data new-data) - (let ((temp (zap-array-data-temp new-length element-type - initial-element initial-element-p))) - (zap-array-data-aux old-data old-dims offset temp new-dims) - (dotimes (i new-length) (setf (aref new-data i) (aref temp i)))) - (zap-array-data-aux old-data old-dims offset new-data new-dims))) + ;; OLD-DIMS comes from array-dimensions, which returns a fresh list + ;; at least in SBCL. + ;; NEW-DIMS comes from the user. + (setf old-dims (nreverse old-dims) + new-dims (reverse new-dims)) + (cond ((eq old-data new-data) + ;; NEW-LENGTH, ELEMENT-TYPE, INITIAL-ELEMENT, and + ;; INITIAL-ELEMENT-P are used when OLD-DATA and NEW-DATA are + ;; EQ; in this case, a temporary must be used and filled + ;; appropriately. specified initial-element. + (when initial-element-p + ;; FIXME: transforming this TYPEP to someting a bit faster + ;; would be a win... + (unless (typep initial-element element-type) + (error "~S can't be used to initialize an array of type ~S." + initial-element element-type))) + (let ((temp (zap-array-data-temp new-length + initial-element initial-element-p))) + (declare (simple-vector temp)) + (zap-array-data-aux old-data old-dims offset temp new-dims) + (dotimes (i new-length) + (setf (aref new-data i) (aref temp i) + ;; zero out any garbage right away + (aref temp i) 0)))) + (t + ;; When OLD-DATA and NEW-DATA are not EQ, NEW-DATA has + ;; already been filled with any + (zap-array-data-aux old-data old-dims offset new-data new-dims)))) (defun zap-array-data-aux (old-data old-dims offset new-data new-dims) (declare (fixnum offset)) - (let ((limits (mapcar #'(lambda (x y) - (declare (fixnum x y)) - (1- (the fixnum (min x y)))) - old-dims new-dims))) + (let ((limits (mapcar (lambda (x y) + (declare (fixnum x y)) + (1- (the fixnum (min x y)))) + old-dims new-dims))) (macrolet ((bump-index-list (index limits) - `(do ((subscripts ,index (cdr subscripts)) - (limits ,limits (cdr limits))) - ((null subscripts) nil) - (cond ((< (the fixnum (car subscripts)) - (the fixnum (car limits))) - (rplaca subscripts - (1+ (the fixnum (car subscripts)))) - (return ,index)) - (t (rplaca subscripts 0)))))) + `(do ((subscripts ,index (cdr subscripts)) + (limits ,limits (cdr limits))) + ((null subscripts) :eof) + (cond ((< (the fixnum (car subscripts)) + (the fixnum (car limits))) + (rplaca subscripts + (1+ (the fixnum (car subscripts)))) + (return ,index)) + (t (rplaca subscripts 0)))))) (do ((index (make-list (length old-dims) :initial-element 0) - (bump-index-list index limits))) - ((null index)) - (setf (aref new-data (row-major-index-from-dims index new-dims)) - (aref old-data - (+ (the fixnum (row-major-index-from-dims index old-dims)) - offset))))))) + (bump-index-list index limits))) + ((eq index :eof)) + (setf (aref new-data (row-major-index-from-dims index new-dims)) + (aref old-data + (+ (the fixnum (row-major-index-from-dims index old-dims)) + offset))))))) ;;; Figure out the row-major-order index of an array reference from a -;;; list of subscripts and a list of dimensions. This is for internal calls -;;; only, and the subscripts and dim-list variables are assumed to be reversed -;;; from what the user supplied. +;;; list of subscripts and a list of dimensions. This is for internal +;;; calls only, and the subscripts and dim-list variables are assumed +;;; to be reversed from what the user supplied. (defun row-major-index-from-dims (rev-subscripts rev-dim-list) (do ((rev-subscripts rev-subscripts (cdr rev-subscripts)) (rev-dim-list rev-dim-list (cdr rev-dim-list)) @@ -995,8 +1271,8 @@ ((null rev-dim-list) result) (declare (fixnum chunk-size result)) (setq result (+ result - (the fixnum (* (the fixnum (car rev-subscripts)) - chunk-size)))) + (the fixnum (* (the fixnum (car rev-subscripts)) + chunk-size)))) (setq chunk-size (* chunk-size (the fixnum (car rev-dim-list)))))) ;;;; some bit stuff @@ -1004,59 +1280,60 @@ (defun bit-array-same-dimensions-p (array1 array2) (declare (type (array bit) array1 array2)) (and (= (array-rank array1) - (array-rank array2)) + (array-rank array2)) (dotimes (index (array-rank array1) t) - (when (/= (array-dimension array1 index) - (array-dimension array2 index)) - (return nil))))) + (when (/= (array-dimension array1 index) + (array-dimension array2 index)) + (return nil))))) (defun pick-result-array (result-bit-array bit-array-1) (case result-bit-array ((t) bit-array-1) ((nil) (make-array (array-dimensions bit-array-1) - :element-type 'bit - :initial-element 0)) + :element-type 'bit + :initial-element 0)) (t (unless (bit-array-same-dimensions-p bit-array-1 - result-bit-array) - (error "~S and ~S do not have the same dimensions." - bit-array-1 result-bit-array)) + result-bit-array) + (error "~S and ~S don't have the same dimensions." + bit-array-1 result-bit-array)) result-bit-array))) (defmacro def-bit-array-op (name function) `(defun ,name (bit-array-1 bit-array-2 &optional result-bit-array) + #!+sb-doc ,(format nil - "Perform a bit-wise ~A on the elements of BIT-ARRAY-1 and ~ - BIT-ARRAY-2,~% putting the results in RESULT-BIT-ARRAY. ~ - If RESULT-BIT-ARRAY is T,~% BIT-ARRAY-1 is used. If ~ - RESULT-BIT-ARRAY is NIL or omitted, a new array is~% created. ~ - All the arrays must have the same rank and dimensions." - (symbol-name function)) + "Perform a bit-wise ~A on the elements of BIT-ARRAY-1 and ~ + BIT-ARRAY-2,~% putting the results in RESULT-BIT-ARRAY. ~ + If RESULT-BIT-ARRAY is T,~% BIT-ARRAY-1 is used. If ~ + RESULT-BIT-ARRAY is NIL or omitted, a new array is~% created. ~ + All the arrays must have the same rank and dimensions." + (symbol-name function)) (declare (type (array bit) bit-array-1 bit-array-2) - (type (or (array bit) (member t nil)) result-bit-array)) + (type (or (array bit) (member t nil)) result-bit-array)) (unless (bit-array-same-dimensions-p bit-array-1 bit-array-2) - (error "~S and ~S do not have the same dimensions." - bit-array-1 bit-array-2)) + (error "~S and ~S don't have the same dimensions." + bit-array-1 bit-array-2)) (let ((result-bit-array (pick-result-array result-bit-array bit-array-1))) (if (and (simple-bit-vector-p bit-array-1) - (simple-bit-vector-p bit-array-2) - (simple-bit-vector-p result-bit-array)) - (locally (declare (optimize (speed 3) (safety 0))) - (,name bit-array-1 bit-array-2 result-bit-array)) - (with-array-data ((data1 bit-array-1) (start1) (end1)) - (declare (ignore end1)) - (with-array-data ((data2 bit-array-2) (start2) (end2)) - (declare (ignore end2)) - (with-array-data ((data3 result-bit-array) (start3) (end3)) - (do ((index-1 start1 (1+ index-1)) - (index-2 start2 (1+ index-2)) - (index-3 start3 (1+ index-3))) - ((>= index-3 end3) result-bit-array) - (declare (type index index-1 index-2 index-3)) - (setf (sbit data3 index-3) - (logand (,function (sbit data1 index-1) - (sbit data2 index-2)) - 1)))))))))) + (simple-bit-vector-p bit-array-2) + (simple-bit-vector-p result-bit-array)) + (locally (declare (optimize (speed 3) (safety 0))) + (,name bit-array-1 bit-array-2 result-bit-array)) + (with-array-data ((data1 bit-array-1) (start1) (end1)) + (declare (ignore end1)) + (with-array-data ((data2 bit-array-2) (start2) (end2)) + (declare (ignore end2)) + (with-array-data ((data3 result-bit-array) (start3) (end3)) + (do ((index-1 start1 (1+ index-1)) + (index-2 start2 (1+ index-2)) + (index-3 start3 (1+ index-3))) + ((>= index-3 end3) result-bit-array) + (declare (type index index-1 index-2 index-3)) + (setf (sbit data3 index-3) + (logand (,function (sbit data1 index-1) + (sbit data2 index-2)) + 1)))))))))) (def-bit-array-op bit-and logand) (def-bit-array-op bit-ior logior) @@ -1076,18 +1353,18 @@ BIT-ARRAY is used. If RESULT-BIT-ARRAY is NIL or omitted, a new array is created. Both arrays must have the same rank and dimensions." (declare (type (array bit) bit-array) - (type (or (array bit) (member t nil)) result-bit-array)) + (type (or (array bit) (member t nil)) result-bit-array)) (let ((result-bit-array (pick-result-array result-bit-array bit-array))) (if (and (simple-bit-vector-p bit-array) - (simple-bit-vector-p result-bit-array)) - (locally (declare (optimize (speed 3) (safety 0))) - (bit-not bit-array result-bit-array)) - (with-array-data ((src bit-array) (src-start) (src-end)) - (declare (ignore src-end)) - (with-array-data ((dst result-bit-array) (dst-start) (dst-end)) - (do ((src-index src-start (1+ src-index)) - (dst-index dst-start (1+ dst-index))) - ((>= dst-index dst-end) result-bit-array) - (declare (type index src-index dst-index)) - (setf (sbit dst dst-index) - (logxor (sbit src src-index) 1)))))))) + (simple-bit-vector-p result-bit-array)) + (locally (declare (optimize (speed 3) (safety 0))) + (bit-not bit-array result-bit-array)) + (with-array-data ((src bit-array) (src-start) (src-end)) + (declare (ignore src-end)) + (with-array-data ((dst result-bit-array) (dst-start) (dst-end)) + (do ((src-index src-start (1+ src-index)) + (dst-index dst-start (1+ dst-index))) + ((>= dst-index dst-end) result-bit-array) + (declare (type index src-index dst-index)) + (setf (sbit dst dst-index) + (logxor (sbit src src-index) 1))))))))