src/code/array.lisp

   1 ;;;; functions to implement arrays
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!IMPL")
  13
  14 #!-sb-fluid
  15 (declaim (inline adjustable-array-p
  16                  array-displacement))
  17 \f
  18 ;;;; miscellaneous accessor functions
  19
  20 ;;; These functions are only needed by the interpreter, 'cause the
  21 ;;; compiler inlines them.
  22 (macrolet ((def (name)
  23              `(progn
  24                 (defun ,name (array)
  25                   (,name array))
  26                 (defun (setf ,name) (value array)
  27                   (setf (,name array) value)))))
  28   (def %array-fill-pointer)
  29   (def %array-fill-pointer-p)
  30   (def %array-available-elements)
  31   (def %array-data-vector)
  32   (def %array-displacement)
  33   (def %array-displaced-p)
  34   (def %array-diplaced-from))
  35
  36 (defun %array-rank (array)
  37   (%array-rank array))
  38
  39 (defun %array-dimension (array axis)
  40   (%array-dimension array axis))
  41
  42 (defun %set-array-dimension (array axis value)
  43   (%set-array-dimension array axis value))
  44
  45 (defun %check-bound (array bound index)
  46   (declare (type index bound)
  47            (fixnum index))
  48   (%check-bound array bound index))
  49
  50 (defun %with-array-data/fp (array start end)
  51   (%with-array-data-macro array start end :check-bounds t :check-fill-pointer t))
  52
  53 (defun %with-array-data (array start end)
  54   (%with-array-data-macro array start end :check-bounds t :check-fill-pointer nil))
  55
  56 (defun %data-vector-and-index (array index)
  57   (if (array-header-p array)
  58       (multiple-value-bind (vector index)
  59           (%with-array-data array index nil)
  60         (values vector index))
  61       (values array index)))
  62 \f
  63 ;;;; MAKE-ARRAY
  64 (eval-when (:compile-toplevel :execute)
  65   (sb!xc:defmacro pick-vector-type (type &rest specs)
  66     `(cond ,@(mapcar (lambda (spec)
  67                        `(,(if (eq (car spec) t)
  68                               t
  69                               `(subtypep ,type ',(car spec)))
  70                          ,@(cdr spec)))
  71                      specs))))
  72
  73 ;;; These functions are used in the implementation of MAKE-ARRAY for
  74 ;;; complex arrays. There are lots of transforms to simplify
  75 ;;; MAKE-ARRAY for various easy cases, but not for all reasonable
  76 ;;; cases, so e.g. as of sbcl-0.6.6 we still make full calls to
  77 ;;; MAKE-ARRAY for any non-simple array. Thus, there's some value to
  78 ;;; making this somewhat efficient, at least not doing full calls to
  79 ;;; SUBTYPEP in the easy cases.
  80 (defun %vector-widetag-and-n-bits (type)
  81   (case type
  82     ;; Pick off some easy common cases.
  83     ;;
  84     ;; (Perhaps we should make a much more exhaustive table of easy
  85     ;; common cases here. Or perhaps the effort would be better spent
  86     ;; on smarter compiler transforms which do the calculation once
  87     ;; and for all in any reasonable user programs.)
  88     ((t)
  89      (values #.sb!vm:simple-vector-widetag #.sb!vm:n-word-bits))
  90     ((base-char standard-char #!-sb-unicode character)
  91      (values #.sb!vm:simple-base-string-widetag #.sb!vm:n-byte-bits))
  92     #!+sb-unicode
  93     ((character)
  94      (values #.sb!vm:simple-character-string-widetag #.sb!vm:n-word-bits))
  95     ((bit)
  96      (values #.sb!vm:simple-bit-vector-widetag 1))
  97     ;; OK, we have to wade into SUBTYPEPing after all.
  98     (t
  99      (unless *type-system-initialized*
 100        (bug "SUBTYPEP dispatch for MAKE-ARRAY before the type system is ready"))
 101      #.`(pick-vector-type type
 102          ,@(map 'list
 103                 (lambda (saetp)
 104                   `(,(sb!vm:saetp-specifier saetp)
 105                     (values ,(sb!vm:saetp-typecode saetp)
 106                             ,(sb!vm:saetp-n-bits saetp))))
 107                 sb!vm:*specialized-array-element-type-properties*)))))
 108
 109 (defun %complex-vector-widetag (type)
 110   (case type
 111     ;; Pick off some easy common cases.
 112     ((t)
 113      #.sb!vm:complex-vector-widetag)
 114     ((base-char #!-sb-unicode character)
 115      #.sb!vm:complex-base-string-widetag)
 116     #!+sb-unicode
 117     ((character)
 118      #.sb!vm:complex-character-string-widetag)
 119     ((nil)
 120      #.sb!vm:complex-vector-nil-widetag)
 121     ((bit)
 122      #.sb!vm:complex-bit-vector-widetag)
 123     ;; OK, we have to wade into SUBTYPEPing after all.
 124     (t
 125      (pick-vector-type type
 126        (nil #.sb!vm:complex-vector-nil-widetag)
 127        #!-sb-unicode
 128        (character #.sb!vm:complex-base-string-widetag)
 129        #!+sb-unicode
 130        (base-char #.sb!vm:complex-base-string-widetag)
 131        #!+sb-unicode
 132        (character #.sb!vm:complex-character-string-widetag)
 133        (bit #.sb!vm:complex-bit-vector-widetag)
 134        (t #.sb!vm:complex-vector-widetag)))))
 135
 136 (defun make-array (dimensions &key
 137                               (element-type t)
 138                               (initial-element nil initial-element-p)
 139                               (initial-contents nil initial-contents-p)
 140                               adjustable fill-pointer
 141                               displaced-to displaced-index-offset)
 142   (let* ((dimensions (if (listp dimensions) dimensions (list dimensions)))
 143          (array-rank (length (the list dimensions)))
 144          (simple (and (null fill-pointer)
 145                       (not adjustable)
 146                       (null displaced-to))))
 147     (declare (fixnum array-rank))
 148     (when (and displaced-index-offset (null displaced-to))
 149       (error "can't specify :DISPLACED-INDEX-OFFSET without :DISPLACED-TO"))
 150     (when (and displaced-to
 151                (arrayp displaced-to)
 152                (not (equal (array-element-type displaced-to)
 153                            (upgraded-array-element-type element-type))))
 154       (error "Array element type of :DISPLACED-TO array does not match specified element type"))
 155     (if (and simple (= array-rank 1))
 156         ;; it's a (SIMPLE-ARRAY * (*))
 157         (multiple-value-bind (type n-bits)
 158             (%vector-widetag-and-n-bits element-type)
 159           (declare (type (unsigned-byte 8) type)
 160                    (type (integer 0 256) n-bits))
 161           (let* ((length (car dimensions))
 162                  (array (allocate-vector
 163                          type
 164                          length
 165                          (ceiling
 166                           (* (if (or (= type sb!vm:simple-base-string-widetag)
 167                                      #!+sb-unicode
 168                                      (= type
 169                                         sb!vm:simple-character-string-widetag))
 170                                  (1+ length)
 171                                  length)
 172                              n-bits)
 173                           sb!vm:n-word-bits))))
 174             (declare (type index length))
 175             (when initial-element-p
 176               (fill array initial-element))
 177             (when initial-contents-p
 178               (when initial-element-p
 179                 (error "can't specify both :INITIAL-ELEMENT and ~
 180                        :INITIAL-CONTENTS"))
 181               (unless (= length (length initial-contents))
 182                 (error "There are ~W elements in the :INITIAL-CONTENTS, but ~
 183                        the vector length is ~W."
 184                        (length initial-contents)
 185                        length))
 186               (replace array initial-contents))
 187             array))
 188         ;; it's either a complex array or a multidimensional array.
 189         (let* ((total-size (reduce #'* dimensions))
 190                (data (or displaced-to
 191                          (data-vector-from-inits
 192                           dimensions total-size element-type
 193                           initial-contents initial-contents-p
 194                           initial-element initial-element-p)))
 195                (array (make-array-header
 196                        (cond ((= array-rank 1)
 197                               (%complex-vector-widetag element-type))
 198                              (simple sb!vm:simple-array-widetag)
 199                              (t sb!vm:complex-array-widetag))
 200                        array-rank)))
 201           (cond (fill-pointer
 202                  (unless (= array-rank 1)
 203                    (error "Only vectors can have fill pointers."))
 204                  (let ((length (car dimensions)))
 205                    (declare (fixnum length))
 206                    (setf (%array-fill-pointer array)
 207                      (cond ((eq fill-pointer t)
 208                             length)
 209                            (t
 210                             (unless (and (fixnump fill-pointer)
 211                                          (>= fill-pointer 0)
 212                                          (<= fill-pointer length))
 213                               ;; FIXME: should be TYPE-ERROR?
 214                               (error "invalid fill-pointer ~W"
 215                                      fill-pointer))
 216                             fill-pointer))))
 217                  (setf (%array-fill-pointer-p array) t))
 218                 (t
 219                  (setf (%array-fill-pointer array) total-size)
 220                  (setf (%array-fill-pointer-p array) nil)))
 221           (setf (%array-available-elements array) total-size)
 222           (setf (%array-data-vector array) data)
 223           (setf (%array-displaced-from array) nil)
 224           (cond (displaced-to
 225                  (when (or initial-element-p initial-contents-p)
 226                    (error "Neither :INITIAL-ELEMENT nor :INITIAL-CONTENTS ~
 227                    can be specified along with :DISPLACED-TO"))
 228                  (let ((offset (or displaced-index-offset 0)))
 229                    (when (> (+ offset total-size)
 230                             (array-total-size displaced-to))
 231                      (error "~S doesn't have enough elements." displaced-to))
 232                    (setf (%array-displacement array) offset)
 233                    (setf (%array-displaced-p array) t)
 234                    (%save-displaced-array-backpointer array data)))
 235                 (t
 236                  (setf (%array-displaced-p array) nil)))
 237           (let ((axis 0))
 238             (dolist (dim dimensions)
 239               (setf (%array-dimension array axis) dim)
 240               (incf axis)))
 241           array))))
 242
 243 (defun make-static-vector (length &key
 244                            (element-type '(unsigned-byte 8))
 245                            (initial-contents nil initial-contents-p)
 246                            (initial-element nil initial-element-p))
 247   "Allocate vector of LENGTH elements in static space. Only allocation
 248 of specialized arrays is supported."
 249   ;; STEP 1: check inputs fully
 250   ;;
 251   ;; This way of doing explicit checks before the vector is allocated
 252   ;; is expensive, but probably worth the trouble as once we've allocated
 253   ;; the vector we have no way to get rid of it anymore...
 254   (when (eq t (upgraded-array-element-type element-type))
 255     (error "Static arrays of type ~S not supported."
 256            element-type))
 257   (when initial-contents-p
 258     (when initial-element-p
 259       (error "can't specify both :INITIAL-ELEMENT and :INITIAL-CONTENTS"))
 260     (unless (= length (length initial-contents))
 261       (error "There are ~W elements in the :INITIAL-CONTENTS, but the ~
 262               vector length is ~W."
 263              (length initial-contents)
 264              length))
 265     (unless (every (lambda (x) (typep x element-type)) initial-contents)
 266       (error ":INITIAL-CONTENTS contains elements not of type ~S."
 267              element-type)))
 268   (when initial-element-p
 269     (unless (typep initial-element element-type)
 270       (error ":INITIAL-ELEMENT ~S is not of type ~S."
 271              initial-element element-type)))
 272   ;; STEP 2
 273   ;;
 274   ;; Allocate and possibly initialize the vector.
 275   (multiple-value-bind (type n-bits)
 276       (sb!impl::%vector-widetag-and-n-bits element-type)
 277     (let ((vector
 278            (allocate-static-vector type length
 279                                    (ceiling (* length n-bits)
 280                                             sb!vm:n-word-bits))))
 281       (cond (initial-element-p
 282              (fill vector initial-element))
 283             (initial-contents-p
 284              (replace vector initial-contents))
 285             (t
 286              vector)))))
 287
 288 ;;; DATA-VECTOR-FROM-INITS returns a simple vector that has the
 289 ;;; specified array characteristics. Dimensions is only used to pass
 290 ;;; to FILL-DATA-VECTOR for error checking on the structure of
 291 ;;; initial-contents.
 292 (defun data-vector-from-inits (dimensions total-size element-type
 293                                initial-contents initial-contents-p
 294                                initial-element initial-element-p)
 295   (when (and initial-contents-p initial-element-p)
 296     (error "cannot supply both :INITIAL-CONTENTS and :INITIAL-ELEMENT to
 297             either MAKE-ARRAY or ADJUST-ARRAY."))
 298   (let ((data (if initial-element-p
 299                   (make-array total-size
 300                               :element-type element-type
 301                               :initial-element initial-element)
 302                   (make-array total-size
 303                               :element-type element-type))))
 304     (cond (initial-element-p
 305            (unless (simple-vector-p data)
 306              (unless (typep initial-element element-type)
 307                (error "~S cannot be used to initialize an array of type ~S."
 308                       initial-element element-type))
 309              (fill (the vector data) initial-element)))
 310           (initial-contents-p
 311            (fill-data-vector data dimensions initial-contents)))
 312     data))
 313
 314 (defun vector (&rest objects)
 315   #!+sb-doc
 316   "Construct a SIMPLE-VECTOR from the given objects."
 317   (coerce (the list objects) 'simple-vector))
 318 \f
 319
 320 ;;;; accessor/setter functions
 321
 322 ;;; Dispatch to an optimized routine the data vector accessors for
 323 ;;; each different specialized vector type. Do dispatching by looking
 324 ;;; up the widetag in the array rather than with the typecases, which
 325 ;;; as of 1.0.5 compiles to a naive sequence of linear TYPEPs. Also
 326 ;;; provide separate versions where bounds checking has been moved
 327 ;;; from the callee to the caller, since it's much cheaper to do once
 328 ;;; the type information is available. Finally, for each of these
 329 ;;; routines also provide a slow path, taken for arrays that are not
 330 ;;; vectors or not simple.
 331 (macrolet ((def (name table-name)
 332              `(progn
 333                 (defglobal ,table-name (make-array ,(1+ sb!vm:widetag-mask)))
 334                 (defmacro ,name (array-var)
 335                   `(the function
 336                      (let ((tag 0))
 337                        (when (sb!vm::%other-pointer-p ,array-var)
 338                          (setf tag (%other-pointer-widetag ,array-var)))
 339                        (svref ,',table-name tag)))))))
 340   (def !find-data-vector-setter %%data-vector-setters%%)
 341   (def !find-data-vector-setter/check-bounds %%data-vector-setters/check-bounds%%)
 342   (def !find-data-vector-reffer %%data-vector-reffers%%)
 343   (def !find-data-vector-reffer/check-bounds %%data-vector-reffers/check-bounds%%))
 344
 345 (macrolet ((%ref (accessor-getter extra-params)
 346              `(funcall (,accessor-getter array) array index ,@extra-params))
 347            (define (accessor-name slow-accessor-name accessor-getter
 348                                   extra-params check-bounds)
 349              `(progn
 350                 (defun ,accessor-name (array index ,@extra-params)
 351                   (declare (optimize speed
 352                                      ;; (SAFETY 0) is ok. All calls to
 353                                      ;; these functions are generated by
 354                                      ;; the compiler, so argument count
 355                                      ;; checking isn't needed. Type checking
 356                                      ;; is done implicitly via the widetag
 357                                      ;; dispatch.
 358                                      (safety 0)))
 359                   (%ref ,accessor-getter ,extra-params))
 360                 (defun ,slow-accessor-name (array index ,@extra-params)
 361                   (declare (optimize speed (safety 0)))
 362                   (if (not (%array-displaced-p array))
 363                       ;; The reasonably quick path of non-displaced complex
 364                       ;; arrays.
 365                       (let ((array (%array-data-vector array)))
 366                         (%ref ,accessor-getter ,extra-params))
 367                       ;; The real slow path.
 368                       (with-array-data
 369                           ((vector array)
 370                            (index (locally
 371                                       (declare (optimize (speed 1) (safety 1)))
 372                                     (,@check-bounds index)))
 373                            (end)
 374                            :force-inline t)
 375                         (declare (ignore end))
 376                         (,accessor-name vector index ,@extra-params)))))))
 377   (define hairy-data-vector-ref slow-hairy-data-vector-ref
 378     !find-data-vector-reffer
 379     nil (progn))
 380   (define hairy-data-vector-set slow-hairy-data-vector-set
 381     !find-data-vector-setter
 382     (new-value) (progn))
 383   (define hairy-data-vector-ref/check-bounds
 384       slow-hairy-data-vector-ref/check-bounds
 385     !find-data-vector-reffer/check-bounds
 386     nil (%check-bound array (array-dimension array 0)))
 387   (define hairy-data-vector-set/check-bounds
 388       slow-hairy-data-vector-set/check-bounds
 389     !find-data-vector-setter/check-bounds
 390     (new-value) (%check-bound array (array-dimension array 0))))
 391
 392 (defun hairy-ref-error (array index &optional new-value)
 393   (declare (ignore index new-value))
 394   (error 'type-error
 395          :datum array
 396          :expected-type 'vector))
 397
 398 (macrolet ((define-reffer (saetp check-form)
 399              (let* ((type (sb!vm:saetp-specifier saetp))
 400                     (atype `(simple-array ,type (*))))
 401                `(named-lambda optimized-data-vector-ref (vector index)
 402                   (declare (optimize speed (safety 0)))
 403                   (data-vector-ref (the ,atype vector)
 404                                    (locally
 405                                        (declare (optimize (safety 1)))
 406                                      (the index
 407                                        (,@check-form index)))))))
 408            (define-setter (saetp check-form)
 409              (let* ((type (sb!vm:saetp-specifier saetp))
 410                     (atype `(simple-array ,type (*))))
 411                `(named-lambda optimized-data-vector-set (vector index new-value)
 412                   (declare (optimize speed (safety 0)))
 413                   (data-vector-set (the ,atype vector)
 414                                    (locally
 415                                        (declare (optimize (safety 1)))
 416                                      (the index
 417                                        (,@check-form index)))
 418                                    (locally
 419                                        ;; SPEED 1 needed to avoid the compiler
 420                                        ;; from downgrading the type check to
 421                                        ;; a cheaper one.
 422                                        (declare (optimize (speed 1)
 423                                                           (safety 1)))
 424                                      (the ,type new-value)))
 425                   ;; For specialized arrays, the return from
 426                   ;; data-vector-set would have to be reboxed to be a
 427                   ;; (Lisp) return value; instead, we use the
 428                   ;; already-boxed value as the return.
 429                   new-value)))
 430            (define-reffers (symbol deffer check-form slow-path)
 431              `(progn
 432                 ;; FIXME/KLUDGE: can't just FILL here, because genesis doesn't
 433                 ;; preserve the binding, so re-initiaize as NS doesn't have
 434                 ;; the energy to figure out to change that right now.
 435                 (setf ,symbol (make-array (1+ sb!vm::widetag-mask)
 436                                           :initial-element #'hairy-ref-error))
 437                 ,@(loop for widetag in '(sb!vm:complex-vector-widetag
 438                                          sb!vm:complex-vector-nil-widetag
 439                                          sb!vm:complex-bit-vector-widetag
 440                                          #!+sb-unicode sb!vm:complex-character-string-widetag
 441                                          sb!vm:complex-base-string-widetag
 442                                          sb!vm:simple-array-widetag
 443                                          sb!vm:complex-array-widetag)
 444                         collect `(setf (svref ,symbol ,widetag) ,slow-path))
 445                 ,@(loop for saetp across sb!vm:*specialized-array-element-type-properties*
 446                         for widetag = (sb!vm:saetp-typecode saetp)
 447                         collect `(setf (svref ,symbol ,widetag)
 448                                        (,deffer ,saetp ,check-form))))))
 449   (defun !hairy-data-vector-reffer-init ()
 450     (define-reffers %%data-vector-reffers%% define-reffer
 451       (progn)
 452       #'slow-hairy-data-vector-ref)
 453     (define-reffers %%data-vector-setters%% define-setter
 454       (progn)
 455       #'slow-hairy-data-vector-set)
 456     (define-reffers %%data-vector-reffers/check-bounds%% define-reffer
 457       (%check-bound vector (length vector))
 458       #'slow-hairy-data-vector-ref/check-bounds)
 459     (define-reffers %%data-vector-setters/check-bounds%% define-setter
 460       (%check-bound vector (length vector))
 461       #'slow-hairy-data-vector-set/check-bounds)))
 462
 463 ;;; (Ordinary DATA-VECTOR-REF usage compiles into a vop, but
 464 ;;; DATA-VECTOR-REF is also FOLDABLE, and this ordinary function
 465 ;;; definition is needed for the compiler to use in constant folding.)
 466 (defun data-vector-ref (array index)
 467   (hairy-data-vector-ref array index))
 468
 469 (defun data-vector-ref-with-offset (array index offset)
 470   (hairy-data-vector-ref array (+ index offset)))
 471
 472 (defun invalid-array-p (array)
 473   (and (array-header-p array)
 474        (consp (%array-displaced-p array))))
 475
 476 (declaim (ftype (function (array) nil) invalid-array-error))
 477 (defun invalid-array-error (array)
 478   (aver (array-header-p array))
 479   ;; Array invalidation stashes the original dimensions here...
 480   (let ((dims (%array-displaced-p array))
 481         (et (array-element-type array)))
 482     (error 'invalid-array-error
 483            :datum array
 484            :expected-type
 485            (if (cdr dims)
 486                `(array ,et ,dims)
 487                `(vector ,et ,@dims)))))
 488
 489 (declaim (ftype (function (array integer integer &optional t) nil)
 490                 invalid-array-index-error))
 491 (defun invalid-array-index-error (array index bound &optional axis)
 492   (if (invalid-array-p array)
 493       (invalid-array-error array)
 494       (error 'invalid-array-index-error
 495              :array array
 496              :axis axis
 497              :datum index
 498              :expected-type `(integer 0 (,bound)))))
 499
 500 ;;; SUBSCRIPTS has a dynamic-extent list structure and is destroyed
 501 (defun %array-row-major-index (array subscripts
 502                                      &optional (invalid-index-error-p t))
 503   (declare (array array)
 504            (list subscripts))
 505   (let ((rank (array-rank array)))
 506     (unless (= rank (length subscripts))
 507       (error "wrong number of subscripts, ~W, for array of rank ~W"
 508              (length subscripts) rank))
 509     (if (array-header-p array)
 510         (do ((subs (nreverse subscripts) (cdr subs))
 511              (axis (1- (array-rank array)) (1- axis))
 512              (chunk-size 1)
 513              (result 0))
 514             ((null subs) result)
 515           (declare (list subs) (fixnum axis chunk-size result))
 516           (let ((index (car subs))
 517                 (dim (%array-dimension array axis)))
 518             (declare (fixnum dim))
 519             (unless (and (fixnump index) (< -1 index dim))
 520               (if invalid-index-error-p
 521                   (invalid-array-index-error array index dim axis)
 522                   (return-from %array-row-major-index nil)))
 523             (incf result (* chunk-size (the fixnum index)))
 524             (setf chunk-size (* chunk-size dim))))
 525         (let ((index (first subscripts))
 526               (length (length (the (simple-array * (*)) array))))
 527           (unless (and (fixnump index) (< -1 index length))
 528             (if invalid-index-error-p
 529                 (invalid-array-index-error array index length)
 530                 (return-from %array-row-major-index nil)))
 531           index))))
 532
 533 (defun array-in-bounds-p (array &rest subscripts)
 534   #!+sb-doc
 535   "Return T if the SUBSCRIPTS are in bounds for the ARRAY, NIL otherwise."
 536   (if (%array-row-major-index array subscripts nil)
 537       t))
 538
 539 (defun array-row-major-index (array &rest subscripts)
 540   (declare (truly-dynamic-extent subscripts))
 541   (%array-row-major-index array subscripts))
 542
 543 (defun aref (array &rest subscripts)
 544   #!+sb-doc
 545   "Return the element of the ARRAY specified by the SUBSCRIPTS."
 546   (declare (truly-dynamic-extent subscripts))
 547   (row-major-aref array (%array-row-major-index array subscripts)))
 548
 549 (defun %aset (array &rest stuff)
 550   (declare (truly-dynamic-extent stuff))
 551   (let ((subscripts (butlast stuff))
 552         (new-value (car (last stuff))))
 553     (setf (row-major-aref array (%array-row-major-index array subscripts))
 554           new-value)))
 555
 556 ;;; FIXME: What's supposed to happen with functions
 557 ;;; like AREF when we (DEFUN (SETF FOO) ..) when
 558 ;;; DEFSETF FOO is also defined? It seems as though the logical
 559 ;;; thing to do would be to nuke the macro definition for (SETF FOO)
 560 ;;; and replace it with the (SETF FOO) function, issuing a warning,
 561 ;;; just as for ordinary functions
 562 ;;;  * (LISP-IMPLEMENTATION-VERSION)
 563 ;;;  "18a+ release x86-linux 2.4.7 6 November 1998 cvs"
 564 ;;;  * (DEFMACRO ZOO (X) `(+ ,X ,X))
 565 ;;;  ZOO
 566 ;;;  * (DEFUN ZOO (X) (* 3 X))
 567 ;;;  Warning: ZOO previously defined as a macro.
 568 ;;;  ZOO
 569 ;;; But that doesn't seem to be what happens in CMU CL.
 570 ;;;
 571 ;;; KLUDGE: this is probably because ANSI, in its wisdom (CLHS
 572 ;;; 5.1.2.5) requires implementations to support
 573 ;;;   (SETF (APPLY #'AREF ...) ...)
 574 ;;; [and also #'BIT and #'SBIT].  Yes, this is terrifying, and it's
 575 ;;; also terrifying that this sequence of definitions causes it to
 576 ;;; work.
 577 ;;;
 578 ;;; Also, it would be nice to make DESCRIBE FOO tell whether a symbol
 579 ;;; has a setf expansion and/or a setf function defined.
 580
 581 #!-sb-fluid (declaim (inline (setf aref)))
 582 (defun (setf aref) (new-value array &rest subscripts)
 583   (declare (truly-dynamic-extent subscripts))
 584   (declare (type array array))
 585   (setf (row-major-aref array (%array-row-major-index array subscripts))
 586         new-value))
 587
 588 (defun row-major-aref (array index)
 589   #!+sb-doc
 590   "Return the element of array corressponding to the row-major index. This is
 591    SETF'able."
 592   (declare (optimize (safety 1)))
 593   (row-major-aref array index))
 594
 595 (defun %set-row-major-aref (array index new-value)
 596   (declare (optimize (safety 1)))
 597   (setf (row-major-aref array index) new-value))
 598
 599 (defun svref (simple-vector index)
 600   #!+sb-doc
 601   "Return the INDEX'th element of the given Simple-Vector."
 602   (declare (optimize (safety 1)))
 603   (aref simple-vector index))
 604
 605 (defun %svset (simple-vector index new)
 606   (declare (optimize (safety 1)))
 607   (setf (aref simple-vector index) new))
 608
 609 (defun bit (bit-array &rest subscripts)
 610   #!+sb-doc
 611   "Return the bit from the BIT-ARRAY at the specified SUBSCRIPTS."
 612   (declare (type (array bit) bit-array) (optimize (safety 1)))
 613   (row-major-aref bit-array (%array-row-major-index bit-array subscripts)))
 614
 615 (defun %bitset (bit-array &rest stuff)
 616   (declare (type (array bit) bit-array) (optimize (safety 1)))
 617   (let ((subscripts (butlast stuff))
 618         (new-value (car (last stuff))))
 619     (setf (row-major-aref bit-array
 620                           (%array-row-major-index bit-array subscripts))
 621           new-value)))
 622
 623 #!-sb-fluid (declaim (inline (setf bit)))
 624 (defun (setf bit) (new-value bit-array &rest subscripts)
 625   (declare (type (array bit) bit-array) (optimize (safety 1)))
 626   (setf (row-major-aref bit-array
 627                         (%array-row-major-index bit-array subscripts))
 628         new-value))
 629
 630 (defun sbit (simple-bit-array &rest subscripts)
 631   #!+sb-doc
 632   "Return the bit from SIMPLE-BIT-ARRAY at the specified SUBSCRIPTS."
 633   (declare (type (simple-array bit) simple-bit-array) (optimize (safety 1)))
 634   (row-major-aref simple-bit-array
 635                   (%array-row-major-index simple-bit-array subscripts)))
 636
 637 ;;; KLUDGE: Not all these things (%SET-ROW-MAJOR-AREF, %SET-FILL-POINTER,
 638 ;;; %SET-FDEFINITION, %SCHARSET, %SBITSET..) seem to deserve separate names.
 639 ;;; Could we just DEFUN (SETF SBIT) etc. and get rid of the non-ANSI names?
 640 ;;; -- WHN 19990911
 641 (defun %sbitset (simple-bit-array &rest stuff)
 642   (declare (type (simple-array bit) simple-bit-array) (optimize (safety 1)))
 643   (let ((subscripts (butlast stuff))
 644         (new-value (car (last stuff))))
 645     (setf (row-major-aref simple-bit-array
 646                           (%array-row-major-index simple-bit-array subscripts))
 647           new-value)))
 648
 649 #!-sb-fluid (declaim (inline (setf sbit)))
 650 (defun (setf sbit) (new-value bit-array &rest subscripts)
 651   (declare (type (simple-array bit) bit-array) (optimize (safety 1)))
 652   (setf (row-major-aref bit-array
 653                         (%array-row-major-index bit-array subscripts))
 654         new-value))
 655 \f
 656 ;;;; miscellaneous array properties
 657
 658 (defun array-element-type (array)
 659   #!+sb-doc
 660   "Return the type of the elements of the array"
 661   (let ((widetag (widetag-of array)))
 662     (macrolet ((pick-element-type (&rest stuff)
 663                  `(cond ,@(mapcar (lambda (stuff)
 664                                     (cons
 665                                      (let ((item (car stuff)))
 666                                        (cond ((eq item t)
 667                                               t)
 668                                              ((listp item)
 669                                               (cons 'or
 670                                                     (mapcar (lambda (x)
 671                                                               `(= widetag ,x))
 672                                                             item)))
 673                                              (t
 674                                               `(= widetag ,item))))
 675                                      (cdr stuff)))
 676                                   stuff))))
 677       #.`(pick-element-type
 678           ,@(map 'list
 679                  (lambda (saetp)
 680                    `(,(if (sb!vm:saetp-complex-typecode saetp)
 681                           (list (sb!vm:saetp-typecode saetp)
 682                                 (sb!vm:saetp-complex-typecode saetp))
 683                           (sb!vm:saetp-typecode saetp))
 684                      ',(sb!vm:saetp-specifier saetp)))
 685                  sb!vm:*specialized-array-element-type-properties*)
 686           ((sb!vm:simple-array-widetag
 687             sb!vm:complex-vector-widetag
 688             sb!vm:complex-array-widetag)
 689            (with-array-data ((array array) (start) (end))
 690              (declare (ignore start end))
 691              (array-element-type array)))
 692           (t
 693            (error 'type-error :datum array :expected-type 'array))))))
 694
 695 (defun array-rank (array)
 696   #!+sb-doc
 697   "Return the number of dimensions of ARRAY."
 698   (if (array-header-p array)
 699       (%array-rank array)
 700       1))
 701
 702 (defun array-dimension (array axis-number)
 703   #!+sb-doc
 704   "Return the length of dimension AXIS-NUMBER of ARRAY."
 705   (declare (array array) (type index axis-number))
 706   (cond ((not (array-header-p array))
 707          (unless (= axis-number 0)
 708            (error "Vector axis is not zero: ~S" axis-number))
 709          (length (the (simple-array * (*)) array)))
 710         ((>= axis-number (%array-rank array))
 711          (error "Axis number ~W is too big; ~S only has ~D dimension~:P."
 712                 axis-number array (%array-rank array)))
 713         (t
 714          (%array-dimension array axis-number))))
 715
 716 (defun array-dimensions (array)
 717   #!+sb-doc
 718   "Return a list whose elements are the dimensions of the array"
 719   (declare (array array))
 720   (if (array-header-p array)
 721       (do ((results nil (cons (array-dimension array index) results))
 722            (index (1- (array-rank array)) (1- index)))
 723           ((minusp index) results))
 724       (list (array-dimension array 0))))
 725
 726 (defun array-total-size (array)
 727   #!+sb-doc
 728   "Return the total number of elements in the Array."
 729   (declare (array array))
 730   (if (array-header-p array)
 731       (%array-available-elements array)
 732       (length (the vector array))))
 733
 734 (defun array-displacement (array)
 735   #!+sb-doc
 736   "Return the values of :DISPLACED-TO and :DISPLACED-INDEX-offset
 737    options to MAKE-ARRAY, or NIL and 0 if not a displaced array."
 738   (declare (type array array))
 739   (if (and (array-header-p array) ; if unsimple and
 740            (%array-displaced-p array)) ; displaced
 741       (values (%array-data-vector array) (%array-displacement array))
 742       (values nil 0)))
 743
 744 (defun adjustable-array-p (array)
 745   #!+sb-doc
 746   "Return T if (ADJUST-ARRAY ARRAY...) would return an array identical
 747    to the argument, this happens for complex arrays."
 748   (declare (array array))
 749   ;; Note that this appears not to be a fundamental limitation.
 750   ;; non-vector SIMPLE-ARRAYs are in fact capable of being adjusted,
 751   ;; but in practice we test using ADJUSTABLE-ARRAY-P in ADJUST-ARRAY.
 752   ;; -- CSR, 2004-03-01.
 753   (not (typep array 'simple-array)))
 754 \f
 755 ;;;; fill pointer frobbing stuff
 756
 757 (declaim (inline array-has-fill-pointer-p))
 758 (defun array-has-fill-pointer-p (array)
 759   #!+sb-doc
 760   "Return T if the given ARRAY has a fill pointer, or NIL otherwise."
 761   (declare (array array))
 762   (and (array-header-p array) (%array-fill-pointer-p array)))
 763
 764 (defun fill-pointer-error (vector arg)
 765   (cond (arg
 766          (aver (array-has-fill-pointer-p vector))
 767          (let ((max (%array-available-elements vector)))
 768            (error 'simple-type-error
 769                   :datum arg
 770                   :expected-type (list 'integer 0 max)
 771                   :format-control "The new fill pointer, ~S, is larger than the length of the vector (~S.)"
 772                   :format-arguments (list arg max))))
 773         (t
 774          (error 'simple-type-error
 775                 :datum vector
 776                 :expected-type '(and vector (satisfies array-has-fill-pointer-p))
 777                 :format-control "~S is not an array with a fill pointer."
 778                 :format-arguments (list vector)))))
 779
 780 (declaim (inline fill-pointer))
 781 (defun fill-pointer (vector)
 782   #!+sb-doc
 783   "Return the FILL-POINTER of the given VECTOR."
 784   (if (array-has-fill-pointer-p vector)
 785       (%array-fill-pointer vector)
 786       (fill-pointer-error vector nil)))
 787
 788 (defun %set-fill-pointer (vector new)
 789   (flet ((oops (x)
 790            (fill-pointer-error vector x)))
 791     (if (array-has-fill-pointer-p vector)
 792         (if (> new (%array-available-elements vector))
 793             (oops new)
 794             (setf (%array-fill-pointer vector) new))
 795         (oops nil))))
 796
 797 ;;; FIXME: It'd probably make sense to use a MACROLET to share the
 798 ;;; guts of VECTOR-PUSH between VECTOR-PUSH-EXTEND. Such a macro
 799 ;;; should probably be based on the VECTOR-PUSH-EXTEND code (which is
 800 ;;; new ca. sbcl-0.7.0) rather than the VECTOR-PUSH code (which dates
 801 ;;; back to CMU CL).
 802 (defun vector-push (new-el array)
 803   #!+sb-doc
 804   "Attempt to set the element of ARRAY designated by its fill pointer
 805    to NEW-EL, and increment the fill pointer by one. If the fill pointer is
 806    too large, NIL is returned, otherwise the index of the pushed element is
 807    returned."
 808   (let ((fill-pointer (fill-pointer array)))
 809     (declare (fixnum fill-pointer))
 810     (cond ((= fill-pointer (%array-available-elements array))
 811            nil)
 812           (t
 813            (locally (declare (optimize (safety 0)))
 814              (setf (aref array fill-pointer) new-el))
 815            (setf (%array-fill-pointer array) (1+ fill-pointer))
 816            fill-pointer))))
 817
 818 (defun vector-push-extend (new-element
 819                            vector
 820                            &optional
 821                            (min-extension
 822                             (let ((length (length vector)))
 823                               (min (1+ length)
 824                                    (- array-dimension-limit length)))))
 825   (declare (fixnum min-extension))
 826   (let ((fill-pointer (fill-pointer vector)))
 827     (declare (fixnum fill-pointer))
 828     (when (= fill-pointer (%array-available-elements vector))
 829       (adjust-array vector (+ fill-pointer (max 1 min-extension))))
 830     ;; disable bounds checking
 831     (locally (declare (optimize (safety 0)))
 832       (setf (aref vector fill-pointer) new-element))
 833     (setf (%array-fill-pointer vector) (1+ fill-pointer))
 834     fill-pointer))
 835
 836 (defun vector-pop (array)
 837   #!+sb-doc
 838   "Decrease the fill pointer by 1 and return the element pointed to by the
 839   new fill pointer."
 840   (let ((fill-pointer (fill-pointer array)))
 841     (declare (fixnum fill-pointer))
 842     (if (zerop fill-pointer)
 843         (error "There is nothing left to pop.")
 844         ;; disable bounds checking (and any fixnum test)
 845         (locally (declare (optimize (safety 0)))
 846           (aref array
 847                 (setf (%array-fill-pointer array)
 848                       (1- fill-pointer)))))))
 849
 850 \f
 851 ;;;; ADJUST-ARRAY
 852
 853 (defun adjust-array (array dimensions &key
 854                            (element-type (array-element-type array))
 855                            (initial-element nil initial-element-p)
 856                            (initial-contents nil initial-contents-p)
 857                            fill-pointer
 858                            displaced-to displaced-index-offset)
 859   #!+sb-doc
 860   "Adjust ARRAY's dimensions to the given DIMENSIONS and stuff."
 861   (when (invalid-array-p array)
 862     (invalid-array-error array))
 863   (let ((dimensions (if (listp dimensions) dimensions (list dimensions))))
 864     (cond ((/= (the fixnum (length (the list dimensions)))
 865                (the fixnum (array-rank array)))
 866            (error "The number of dimensions not equal to rank of array."))
 867           ((not (subtypep element-type (array-element-type array)))
 868            (error "The new element type, ~S, is incompatible with old type."
 869                   element-type))
 870           ((and fill-pointer (not (array-has-fill-pointer-p array)))
 871            (error 'type-error
 872                   :datum array
 873                   :expected-type '(satisfies array-has-fill-pointer-p))))
 874     (let ((array-rank (length (the list dimensions))))
 875       (declare (fixnum array-rank))
 876       (unless (= array-rank 1)
 877         (when fill-pointer
 878           (error "Only vectors can have fill pointers.")))
 879       (cond (initial-contents-p
 880              ;; array former contents replaced by INITIAL-CONTENTS
 881              (if (or initial-element-p displaced-to)
 882                  (error "INITIAL-CONTENTS may not be specified with ~
 883                          the :INITIAL-ELEMENT or :DISPLACED-TO option."))
 884              (let* ((array-size (apply #'* dimensions))
 885                     (array-data (data-vector-from-inits
 886                                  dimensions array-size element-type
 887                                  initial-contents initial-contents-p
 888                                  initial-element initial-element-p)))
 889                (if (adjustable-array-p array)
 890                    (set-array-header array array-data array-size
 891                                  (get-new-fill-pointer array array-size
 892                                                        fill-pointer)
 893                                  0 dimensions nil nil)
 894                    (if (array-header-p array)
 895                        ;; simple multidimensional or single dimensional array
 896                        (make-array dimensions
 897                                    :element-type element-type
 898                                    :initial-contents initial-contents)
 899                        array-data))))
 900             (displaced-to
 901              ;; We already established that no INITIAL-CONTENTS was supplied.
 902              (when initial-element
 903                (error "The :INITIAL-ELEMENT option may not be specified ~
 904                        with :DISPLACED-TO."))
 905              (unless (subtypep element-type (array-element-type displaced-to))
 906                (error "can't displace an array of type ~S into another of ~
 907                        type ~S"
 908                       element-type (array-element-type displaced-to)))
 909              (let ((displacement (or displaced-index-offset 0))
 910                    (array-size (apply #'* dimensions)))
 911                (declare (fixnum displacement array-size))
 912                (if (< (the fixnum (array-total-size displaced-to))
 913                       (the fixnum (+ displacement array-size)))
 914                    (error "The :DISPLACED-TO array is too small."))
 915                (if (adjustable-array-p array)
 916                    ;; None of the original contents appear in adjusted array.
 917                    (set-array-header array displaced-to array-size
 918                                      (get-new-fill-pointer array array-size
 919                                                            fill-pointer)
 920                                      displacement dimensions t nil)
 921                    ;; simple multidimensional or single dimensional array
 922                    (make-array dimensions
 923                                :element-type element-type
 924                                :displaced-to displaced-to
 925                                :displaced-index-offset
 926                                displaced-index-offset))))
 927             ((= array-rank 1)
 928              (let ((old-length (array-total-size array))
 929                    (new-length (car dimensions))
 930                    new-data)
 931                (declare (fixnum old-length new-length))
 932                (with-array-data ((old-data array) (old-start)
 933                                  (old-end old-length))
 934                  (cond ((or (and (array-header-p array)
 935                                  (%array-displaced-p array))
 936                             (< old-length new-length))
 937                         (setf new-data
 938                               (data-vector-from-inits
 939                                dimensions new-length element-type
 940                                initial-contents initial-contents-p
 941                                initial-element initial-element-p))
 942                         (replace new-data old-data
 943                                  :start2 old-start :end2 old-end))
 944                        (t (setf new-data
 945                                 (shrink-vector old-data new-length))))
 946                  (if (adjustable-array-p array)
 947                      (set-array-header array new-data new-length
 948                                        (get-new-fill-pointer array new-length
 949                                                              fill-pointer)
 950                                        0 dimensions nil nil)
 951                      new-data))))
 952             (t
 953              (let ((old-length (%array-available-elements array))
 954                    (new-length (apply #'* dimensions)))
 955                (declare (fixnum old-length new-length))
 956                (with-array-data ((old-data array) (old-start)
 957                                  (old-end old-length))
 958                  (declare (ignore old-end))
 959                  (let ((new-data (if (or (and (array-header-p array)
 960                                               (%array-displaced-p array))
 961                                          (> new-length old-length))
 962                                      (data-vector-from-inits
 963                                       dimensions new-length
 964                                       element-type () nil
 965                                       initial-element initial-element-p)
 966                                      old-data)))
 967                    (if (or (zerop old-length) (zerop new-length))
 968                        (when initial-element-p (fill new-data initial-element))
 969                        (zap-array-data old-data (array-dimensions array)
 970                                        old-start
 971                                        new-data dimensions new-length
 972                                        element-type initial-element
 973                                        initial-element-p))
 974                    (if (adjustable-array-p array)
 975                        (set-array-header array new-data new-length
 976                                          nil 0 dimensions nil nil)
 977                        (let ((new-array
 978                               (make-array-header
 979                                sb!vm:simple-array-widetag array-rank)))
 980                          (set-array-header new-array new-data new-length
 981                                            nil 0 dimensions nil t)))))))))))
 982
 983
 984 (defun get-new-fill-pointer (old-array new-array-size fill-pointer)
 985   (cond ((not fill-pointer)
 986          (when (array-has-fill-pointer-p old-array)
 987            (when (> (%array-fill-pointer old-array) new-array-size)
 988              (error "cannot ADJUST-ARRAY an array (~S) to a size (~S) that is ~
 989                      smaller than its fill pointer (~S)"
 990                     old-array new-array-size (fill-pointer old-array)))
 991            (%array-fill-pointer old-array)))
 992         ((not (array-has-fill-pointer-p old-array))
 993          (error "cannot supply a non-NIL value (~S) for :FILL-POINTER ~
 994                  in ADJUST-ARRAY unless the array (~S) was originally ~
 995                  created with a fill pointer"
 996                 fill-pointer
 997                 old-array))
 998         ((numberp fill-pointer)
 999          (when (> fill-pointer new-array-size)
1000            (error "can't supply a value for :FILL-POINTER (~S) that is larger ~
1001                    than the new length of the vector (~S)"
1002                   fill-pointer new-array-size))
1003          fill-pointer)
1004         ((eq fill-pointer t)
1005          new-array-size)
1006         (t
1007          (error "bogus value for :FILL-POINTER in ADJUST-ARRAY: ~S"
1008                 fill-pointer))))
1009
1010 ;;; Destructively alter VECTOR, changing its length to NEW-LENGTH,
1011 ;;; which must be less than or equal to its current length. This can
1012 ;;; be called on vectors without a fill pointer but it is extremely
1013 ;;; dangerous to do so: shrinking the size of an object (as viewed by
1014 ;;; the gc) makes bounds checking unreliable in the face of interrupts
1015 ;;; or multi-threading. Call it only on provably local vectors.
1016 (defun %shrink-vector (vector new-length)
1017   (declare (vector vector))
1018   (unless (array-header-p vector)
1019     (macrolet ((frob (name &rest things)
1020                  `(etypecase ,name
1021                     ((simple-array nil (*)) (error 'nil-array-accessed-error))
1022                     ,@(mapcar (lambda (thing)
1023                                 (destructuring-bind (type-spec fill-value)
1024                                     thing
1025                                   `(,type-spec
1026                                     (fill (truly-the ,type-spec ,name)
1027                                           ,fill-value
1028                                           :start new-length))))
1029                               things))))
1030       ;; Set the 'tail' of the vector to the appropriate type of zero,
1031       ;; "because in some cases we'll scavenge larger areas in one go,
1032       ;; like groups of pages that had triggered the write barrier, or
1033       ;; the whole static space" according to jsnell.
1034       #.`(frob vector
1035           ,@(map 'list
1036                  (lambda (saetp)
1037                    `((simple-array ,(sb!vm:saetp-specifier saetp) (*))
1038                      ,(if (or (eq (sb!vm:saetp-specifier saetp) 'character)
1039                               #!+sb-unicode
1040                               (eq (sb!vm:saetp-specifier saetp) 'base-char))
1041                           *default-init-char-form*
1042                           (sb!vm:saetp-initial-element-default saetp))))
1043                  (remove-if-not
1044                   #'sb!vm:saetp-specifier
1045                   sb!vm:*specialized-array-element-type-properties*)))))
1046   ;; Only arrays have fill-pointers, but vectors have their length
1047   ;; parameter in the same place.
1048   (setf (%array-fill-pointer vector) new-length)
1049   vector)
1050
1051 (defun shrink-vector (vector new-length)
1052   (declare (vector vector))
1053   (cond
1054     ((eq (length vector) new-length)
1055      vector)
1056     ((array-has-fill-pointer-p vector)
1057      (setf (%array-fill-pointer vector) new-length)
1058      vector)
1059     (t (subseq vector 0 new-length))))
1060
1061 ;;; BIG THREAD SAFETY NOTE
1062 ;;;
1063 ;;; ADJUST-ARRAY/SET-ARRAY-HEADER, and its callees are very
1064 ;;; thread unsafe. They are nonatomic, and can mess with parallel
1065 ;;; code using the same arrays.
1066 ;;;
1067 ;;; A likely seeming fix is an additional level of indirection:
1068 ;;; ARRAY-HEADER -> ARRAY-INFO -> ... where ARRAY-HEADER would
1069 ;;; hold nothing but the pointer to ARRAY-INFO, and ARRAY-INFO
1070 ;;; would hold everything ARRAY-HEADER now holds. This allows
1071 ;;; consing up a new ARRAY-INFO and replacing it atomically in
1072 ;;; the ARRAY-HEADER.
1073 ;;;
1074 ;;; %WALK-DISPLACED-ARRAY-BACKPOINTERS is an especially nasty
1075 ;;; one: not only is it needed extremely rarely, which makes
1076 ;;; any thread safety bugs involving it look like rare random
1077 ;;; corruption, but because it walks the chain *upwards*, which
1078 ;;; may violate user expectations.
1079
1080 (defun %save-displaced-array-backpointer (array data)
1081   (flet ((purge (pointers)
1082            (remove-if (lambda (value)
1083                         (or (not value) (eq array value)))
1084                       pointers
1085                       :key #'weak-pointer-value)))
1086     ;; Add backpointer to the new data vector if it has a header.
1087     (when (array-header-p data)
1088       (setf (%array-displaced-from data)
1089             (cons (make-weak-pointer array)
1090                   (purge (%array-displaced-from data)))))
1091     ;; Remove old backpointer, if any.
1092     (let ((old-data (%array-data-vector array)))
1093       (when (and (neq data old-data) (array-header-p old-data))
1094         (setf (%array-displaced-from old-data)
1095               (purge (%array-displaced-from old-data)))))))
1096
1097 (defun %walk-displaced-array-backpointers (array new-length)
1098   (dolist (p (%array-displaced-from array))
1099     (let ((from (weak-pointer-value p)))
1100       (when (and from (eq array (%array-data-vector from)))
1101         (let ((requires (+ (%array-available-elements from)
1102                            (%array-displacement from))))
1103           (unless (>= new-length requires)
1104             ;; ANSI sayeth (ADJUST-ARRAY dictionary entry):
1105             ;;
1106             ;;   "If A is displaced to B, the consequences are unspecified if B is
1107             ;;   adjusted in such a way that it no longer has enough elements to
1108             ;;   satisfy A.
1109             ;;
1110             ;; since we're hanging on a weak pointer here, we can't signal an
1111             ;; error right now: the array that we're looking at might be
1112             ;; garbage. Instead, we set all dimensions to zero so that next
1113             ;; safe access to the displaced array will trap. Additionally, we
1114             ;; save the original dimensions, so we can signal a more
1115             ;; understandable error when the time comes.
1116             (%walk-displaced-array-backpointers from 0)
1117             (setf (%array-fill-pointer from) 0
1118                   (%array-available-elements from) 0
1119                   (%array-displaced-p from) (array-dimensions array))
1120             (dotimes (i (%array-rank from))
1121               (setf (%array-dimension from i) 0))))))))
1122
1123 ;;; Fill in array header with the provided information, and return the array.
1124 (defun set-array-header (array data length fill-pointer displacement dimensions
1125                          displacedp newp)
1126   (if newp
1127       (setf (%array-displaced-from array) nil)
1128       (%walk-displaced-array-backpointers array length))
1129   (when displacedp
1130     (%save-displaced-array-backpointer array data))
1131   (setf (%array-data-vector array) data)
1132   (setf (%array-available-elements array) length)
1133   (cond (fill-pointer
1134          (setf (%array-fill-pointer array) fill-pointer)
1135          (setf (%array-fill-pointer-p array) t))
1136         (t
1137          (setf (%array-fill-pointer array) length)
1138          (setf (%array-fill-pointer-p array) nil)))
1139   (setf (%array-displacement array) displacement)
1140   (if (listp dimensions)
1141       (dotimes (axis (array-rank array))
1142         (declare (type index axis))
1143         (setf (%array-dimension array axis) (pop dimensions)))
1144       (setf (%array-dimension array 0) dimensions))
1145   (setf (%array-displaced-p array) displacedp)
1146   array)
1147
1148 ;;; User visible extension
1149 (declaim (ftype (function (array) (values (simple-array * (*)) &optional))
1150                 array-storage-vector))
1151 (defun array-storage-vector (array)
1152   "Returns the underlying storage vector of ARRAY, which must be a non-displaced array.
1153
1154 In SBCL, if ARRAY is a of type \(SIMPLE-ARRAY * \(*)), it is its own storage
1155 vector. Multidimensional arrays, arrays with fill pointers, and adjustable
1156 arrays have an underlying storage vector with the same ARRAY-ELEMENT-TYPE as
1157 ARRAY, which this function returns.
1158
1159 Important note: the underlying vector is an implementation detail. Even though
1160 this function exposes it, changes in the implementation may cause this
1161 function to be removed without further warning."
1162   ;; KLUDGE: Without TRULY-THE the system is not smart enough to figure out that
1163   ;; the return value is always of the known type.
1164   (truly-the (simple-array * (*))
1165              (if (array-header-p array)
1166                  (if (%array-displaced-p array)
1167                      (error "~S cannot be used with displaced arrays. Use ~S instead."
1168                             'array-storage-vector 'array-displacement)
1169                      (%array-data-vector array))
1170                  array)))
1171 \f
1172
1173 ;;;; ZAP-ARRAY-DATA for ADJUST-ARRAY
1174
1175 ;;; This does the grinding work for ADJUST-ARRAY. It zaps the data
1176 ;;; from the OLD-DATA in an arrangement specified by the OLD-DIMS to
1177 ;;; the NEW-DATA in an arrangement specified by the NEW-DIMS. OFFSET
1178 ;;; is a displaced offset to be added to computed indices of OLD-DATA.
1179 (defun zap-array-data (old-data old-dims offset new-data new-dims new-length
1180                        element-type initial-element initial-element-p)
1181   (declare (list old-dims new-dims)
1182            (fixnum new-length))
1183   ;; OLD-DIMS comes from array-dimensions, which returns a fresh list
1184   ;; at least in SBCL.
1185   ;; NEW-DIMS comes from the user.
1186   (setf old-dims (nreverse old-dims)
1187         new-dims (reverse new-dims))
1188   (cond ((eq old-data new-data)
1189          ;; NEW-LENGTH, ELEMENT-TYPE, INITIAL-ELEMENT, and
1190          ;; INITIAL-ELEMENT-P are used when OLD-DATA and NEW-DATA are
1191          ;; EQ; in this case, a temporary must be used and filled
1192          ;; appropriately. specified initial-element.
1193          (when initial-element-p
1194            ;; FIXME: transforming this TYPEP to someting a bit faster
1195            ;; would be a win...
1196            (unless (typep initial-element element-type)
1197              (error "~S can't be used to initialize an array of type ~S."
1198                     initial-element element-type)))
1199          (let ((temp (if initial-element-p
1200                          (make-array new-length :initial-element initial-element)
1201                          (make-array new-length))))
1202            (declare (simple-vector temp))
1203            (zap-array-data-aux old-data old-dims offset temp new-dims)
1204            (dotimes (i new-length)
1205              (setf (aref new-data i) (aref temp i)))
1206            ;; Kill the temporary vector to prevent garbage retention.
1207            (%shrink-vector temp 0)))
1208         (t
1209          ;; When OLD-DATA and NEW-DATA are not EQ, NEW-DATA has
1210          ;; already been filled with any
1211          (zap-array-data-aux old-data old-dims offset new-data new-dims))))
1212
1213 (defun zap-array-data-aux (old-data old-dims offset new-data new-dims)
1214   (declare (fixnum offset))
1215   (let ((limits (mapcar (lambda (x y)
1216                           (declare (fixnum x y))
1217                           (1- (the fixnum (min x y))))
1218                         old-dims new-dims)))
1219     (macrolet ((bump-index-list (index limits)
1220                  `(do ((subscripts ,index (cdr subscripts))
1221                        (limits ,limits (cdr limits)))
1222                       ((null subscripts) :eof)
1223                     (cond ((< (the fixnum (car subscripts))
1224                               (the fixnum (car limits)))
1225                            (rplaca subscripts
1226                                    (1+ (the fixnum (car subscripts))))
1227                            (return ,index))
1228                           (t (rplaca subscripts 0))))))
1229       (do ((index (make-list (length old-dims) :initial-element 0)
1230                   (bump-index-list index limits)))
1231           ((eq index :eof))
1232         (setf (aref new-data (row-major-index-from-dims index new-dims))
1233               (aref old-data
1234                     (+ (the fixnum (row-major-index-from-dims index old-dims))
1235                        offset)))))))
1236
1237 ;;; Figure out the row-major-order index of an array reference from a
1238 ;;; list of subscripts and a list of dimensions. This is for internal
1239 ;;; calls only, and the subscripts and dim-list variables are assumed
1240 ;;; to be reversed from what the user supplied.
1241 (defun row-major-index-from-dims (rev-subscripts rev-dim-list)
1242   (do ((rev-subscripts rev-subscripts (cdr rev-subscripts))
1243        (rev-dim-list rev-dim-list (cdr rev-dim-list))
1244        (chunk-size 1)
1245        (result 0))
1246       ((null rev-dim-list) result)
1247     (declare (fixnum chunk-size result))
1248     (setq result (+ result
1249                     (the fixnum (* (the fixnum (car rev-subscripts))
1250                                    chunk-size))))
1251     (setq chunk-size (* chunk-size (the fixnum (car rev-dim-list))))))
1252 \f
1253 ;;;; some bit stuff
1254
1255 (defun bit-array-same-dimensions-p (array1 array2)
1256   (declare (type (array bit) array1 array2))
1257   (and (= (array-rank array1)
1258           (array-rank array2))
1259        (dotimes (index (array-rank array1) t)
1260          (when (/= (array-dimension array1 index)
1261                    (array-dimension array2 index))
1262            (return nil)))))
1263
1264 (defun pick-result-array (result-bit-array bit-array-1)
1265   (case result-bit-array
1266     ((t) bit-array-1)
1267     ((nil) (make-array (array-dimensions bit-array-1)
1268                        :element-type 'bit
1269                        :initial-element 0))
1270     (t
1271      (unless (bit-array-same-dimensions-p bit-array-1
1272                                           result-bit-array)
1273        (error "~S and ~S don't have the same dimensions."
1274               bit-array-1 result-bit-array))
1275      result-bit-array)))
1276
1277 (defmacro def-bit-array-op (name function)
1278   `(defun ,name (bit-array-1 bit-array-2 &optional result-bit-array)
1279      #!+sb-doc
1280      ,(format nil
1281               "Perform a bit-wise ~A on the elements of BIT-ARRAY-1 and ~
1282                BIT-ARRAY-2,~%  putting the results in RESULT-BIT-ARRAY. ~
1283                If RESULT-BIT-ARRAY is T,~%  BIT-ARRAY-1 is used. If ~
1284                RESULT-BIT-ARRAY is NIL or omitted, a new array is~%  created. ~
1285                All the arrays must have the same rank and dimensions."
1286               (symbol-name function))
1287      (declare (type (array bit) bit-array-1 bit-array-2)
1288               (type (or (array bit) (member t nil)) result-bit-array))
1289      (unless (bit-array-same-dimensions-p bit-array-1 bit-array-2)
1290        (error "~S and ~S don't have the same dimensions."
1291               bit-array-1 bit-array-2))
1292      (let ((result-bit-array (pick-result-array result-bit-array bit-array-1)))
1293        (if (and (simple-bit-vector-p bit-array-1)
1294                 (simple-bit-vector-p bit-array-2)
1295                 (simple-bit-vector-p result-bit-array))
1296            (locally (declare (optimize (speed 3) (safety 0)))
1297              (,name bit-array-1 bit-array-2 result-bit-array))
1298            (with-array-data ((data1 bit-array-1) (start1) (end1))
1299              (declare (ignore end1))
1300              (with-array-data ((data2 bit-array-2) (start2) (end2))
1301                (declare (ignore end2))
1302                (with-array-data ((data3 result-bit-array) (start3) (end3))
1303                  (do ((index-1 start1 (1+ index-1))
1304                       (index-2 start2 (1+ index-2))
1305                       (index-3 start3 (1+ index-3)))
1306                      ((>= index-3 end3) result-bit-array)
1307                    (declare (type index index-1 index-2 index-3))
1308                    (setf (sbit data3 index-3)
1309                          (logand (,function (sbit data1 index-1)
1310                                             (sbit data2 index-2))
1311                                  1))))))))))
1312
1313 (def-bit-array-op bit-and logand)
1314 (def-bit-array-op bit-ior logior)
1315 (def-bit-array-op bit-xor logxor)
1316 (def-bit-array-op bit-eqv logeqv)
1317 (def-bit-array-op bit-nand lognand)
1318 (def-bit-array-op bit-nor lognor)
1319 (def-bit-array-op bit-andc1 logandc1)
1320 (def-bit-array-op bit-andc2 logandc2)
1321 (def-bit-array-op bit-orc1 logorc1)
1322 (def-bit-array-op bit-orc2 logorc2)
1323
1324 (defun bit-not (bit-array &optional result-bit-array)
1325   #!+sb-doc
1326   "Performs a bit-wise logical NOT on the elements of BIT-ARRAY,
1327   putting the results in RESULT-BIT-ARRAY. If RESULT-BIT-ARRAY is T,
1328   BIT-ARRAY is used. If RESULT-BIT-ARRAY is NIL or omitted, a new array is
1329   created. Both arrays must have the same rank and dimensions."
1330   (declare (type (array bit) bit-array)
1331            (type (or (array bit) (member t nil)) result-bit-array))
1332   (let ((result-bit-array (pick-result-array result-bit-array bit-array)))
1333     (if (and (simple-bit-vector-p bit-array)
1334              (simple-bit-vector-p result-bit-array))
1335         (locally (declare (optimize (speed 3) (safety 0)))
1336           (bit-not bit-array result-bit-array))
1337         (with-array-data ((src bit-array) (src-start) (src-end))
1338           (declare (ignore src-end))
1339           (with-array-data ((dst result-bit-array) (dst-start) (dst-end))
1340             (do ((src-index src-start (1+ src-index))
1341                  (dst-index dst-start (1+ dst-index)))
1342                 ((>= dst-index dst-end) result-bit-array)
1343               (declare (type index src-index dst-index))
1344               (setf (sbit dst dst-index)
1345                     (logxor (sbit src src-index) 1))))))))
1346
1347 ;;;; array type dispatching
1348
1349 ;;; Store some saetp fields for DEFINE-ARRAY-DISPATCH since
1350 ;;; sb!vm:*specialized-array-element-type-properties* is not always
1351 ;;; available.
1352 (macrolet
1353     ((define-saetp-info ()
1354        `(eval-when (:compile-toplevel :load-toplevel :execute)
1355           (defglobal %%saetp-info%%
1356               ',(loop for saetp
1357                       across sb!vm:*specialized-array-element-type-properties*
1358                       collect `(,(sb!vm:saetp-typecode saetp)
1359                                 ,(sb!vm:saetp-specifier saetp)
1360                                 ,(sb!vm:saetp-primitive-type-name saetp)))))))
1361   (define-saetp-info))
1362
1363 ;;; Given DISPATCH-FOO as the DISPATCH-NAME argument (unevaluated),
1364 ;;; defines the functions
1365 ;;;
1366 ;;; DISPATCH-FOO/SIMPLE-BASE-STRING
1367 ;;; DISPATCH-FOO/SIMPLE-CHARACTER-STRING
1368 ;;; DISPATCH-FOO/SIMPLE-ARRAY-SINGLE-FLOAT
1369 ;;; ...
1370 ;;;
1371 ;;; PARAMS are the function parameters in the definition of each
1372 ;;; specializer function. The array being specialized must be the
1373 ;;; first parameter in PARAMS. A type declaration for this parameter
1374 ;;; is automatically inserted into the body of each function.
1375 ;;;
1376 ;;; The dispatch table %%FOO-FUNS%% is defined and populated by these
1377 ;;; functions. The table is padded by the function
1378 ;;; HAIRY-FOO-DISPATCH-ERROR, also defined by DEFINE-ARRAY-DISPATCH.
1379 ;;;
1380 ;;; Finally, the DISPATCH-FOO macro is defined which does the actual
1381 ;;; dispatching when called. It expects arguments that match PARAMS.
1382 ;;;
1383 (defmacro define-array-dispatch (dispatch-name params &body body)
1384   (let ((table-name (symbolicate "%%" dispatch-name "-FUNS%%"))
1385         (error-name (symbolicate "HAIRY-" dispatch-name "-ERROR")))
1386     `(progn
1387        (eval-when (:compile-toplevel :load-toplevel :execute)
1388          (defun ,error-name (&rest args)
1389            (error 'type-error
1390                   :datum (first args)
1391                   :expected-type '(simple-array * (*)))))
1392        (defglobal ,table-name (make-array ,(1+ sb!vm:widetag-mask)
1393                                           :initial-element #',error-name))
1394        ,@(loop for (typecode specifier primitive-type-name) in %%saetp-info%%
1395                collect (let ((fun-name (symbolicate (string dispatch-name)
1396                                                     "/" primitive-type-name)))
1397                          `(progn
1398                             (defun ,fun-name ,params
1399                               (declare (type (simple-array ,specifier (*))
1400                                              ,(first params)))
1401                               ,@body)
1402                             (setf (svref ,table-name ,typecode) #',fun-name))))
1403        (defmacro ,dispatch-name (&rest args)
1404          (check-type (first args) symbol)
1405          (let ((tag (gensym "TAG")))
1406            `(funcall
1407              (the function
1408                (let ((,tag 0))
1409                  (when (sb!vm::%other-pointer-p ,(first args))
1410                    (setf ,tag (%other-pointer-widetag ,(first args))))
1411                  (svref ,',table-name ,tag)))
1412              ,@args))))))