1 ;;;; array-specific optimizers and transforms
3 ;;;; This software is part of the SBCL system. See the README file for
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.
14 ;;;; utilities for optimizing array operations
16 ;;; Return UPGRADED-ARRAY-ELEMENT-TYPE for LVAR, or do
17 ;;; GIVE-UP-IR1-TRANSFORM if the upgraded element type can't be
19 (defun upgraded-element-type-specifier-or-give-up (lvar)
20 (let* ((element-ctype (extract-upgraded-element-type lvar))
21 (element-type-specifier (type-specifier element-ctype)))
22 (if (eq element-type-specifier '*)
23 (give-up-ir1-transform
24 "upgraded array element type not known at compile time")
25 element-type-specifier)))
27 ;;; Array access functions return an object from the array, hence its type is
28 ;;; going to be the array upgraded element type. Secondary return value is the
29 ;;; known supertype of the upgraded-array-element-type, if if the exact
30 ;;; U-A-E-T is not known. (If it is NIL, the primary return value is as good
32 (defun extract-upgraded-element-type (array)
33 (let ((type (lvar-type array)))
35 ;; Note that this IF mightn't be satisfied even if the runtime
36 ;; value is known to be a subtype of some specialized ARRAY, because
37 ;; we can have values declared e.g. (AND SIMPLE-VECTOR UNKNOWN-TYPE),
38 ;; which are represented in the compiler as INTERSECTION-TYPE, not
41 (values (array-type-specialized-element-type type) nil))
42 ;; fix for bug #396. This type logic corresponds to the special case for
43 ;; strings in HAIRY-DATA-VECTOR-REF (generic/vm-tran.lisp)
44 ((csubtypep type (specifier-type 'string))
46 ((csubtypep type (specifier-type '(array character (*))))
47 (values (specifier-type 'character) nil))
49 ((csubtypep type (specifier-type '(array base-char (*))))
50 (values (specifier-type 'base-char) nil))
51 ((csubtypep type (specifier-type '(array nil (*))))
52 (values *empty-type* nil))
55 (values *wild-type* (specifier-type 'character)))))
57 ;; KLUDGE: there is no good answer here, but at least
58 ;; *wild-type* won't cause HAIRY-DATA-VECTOR-{REF,SET} to be
59 ;; erroneously optimized (see generic/vm-tran.lisp) -- CSR,
61 (values *wild-type* nil)))))
63 (defun extract-declared-element-type (array)
64 (let ((type (lvar-type array)))
65 (if (array-type-p type)
66 (array-type-element-type type)
69 ;;; The ``new-value'' for array setters must fit in the array, and the
70 ;;; return type is going to be the same as the new-value for SETF
72 (defun assert-new-value-type (new-value array)
73 (let ((type (lvar-type array)))
74 (when (array-type-p type)
77 (array-type-specialized-element-type type)
78 (lexenv-policy (node-lexenv (lvar-dest new-value))))))
79 (lvar-type new-value))
81 (defun assert-array-complex (array)
84 (make-array-type :complexp t
85 :element-type *wild-type*)
86 (lexenv-policy (node-lexenv (lvar-dest array))))
89 ;;; Return true if ARG is NIL, or is a constant-lvar whose
90 ;;; value is NIL, false otherwise.
91 (defun unsupplied-or-nil (arg)
92 (declare (type (or lvar null) arg))
94 (and (constant-lvar-p arg)
95 (not (lvar-value arg)))))
97 ;;;; DERIVE-TYPE optimizers
99 ;;; Array operations that use a specific number of indices implicitly
100 ;;; assert that the array is of that rank.
101 (defun assert-array-rank (array rank)
104 (specifier-type `(array * ,(make-list rank :initial-element '*)))
105 (lexenv-policy (node-lexenv (lvar-dest array)))))
107 (defun derive-aref-type (array)
108 (multiple-value-bind (uaet other) (extract-upgraded-element-type array)
111 (defoptimizer (array-in-bounds-p derive-type) ((array &rest indices))
112 (assert-array-rank array (length indices))
115 (defoptimizer (aref derive-type) ((array &rest indices) node)
116 (assert-array-rank array (length indices))
117 (derive-aref-type array))
119 (defoptimizer (%aset derive-type) ((array &rest stuff))
120 (assert-array-rank array (1- (length stuff)))
121 (assert-new-value-type (car (last stuff)) array))
123 (macrolet ((define (name)
124 `(defoptimizer (,name derive-type) ((array index))
125 (derive-aref-type array))))
126 (define hairy-data-vector-ref)
127 (define hairy-data-vector-ref/check-bounds)
128 (define data-vector-ref))
131 (defoptimizer (data-vector-ref-with-offset derive-type) ((array index offset))
132 (derive-aref-type array))
134 (macrolet ((define (name)
135 `(defoptimizer (,name derive-type) ((array index new-value))
136 (assert-new-value-type new-value array))))
137 (define hairy-data-vector-set)
138 (define hairy-data-vector-set/check-bounds)
139 (define data-vector-set))
142 (defoptimizer (data-vector-set-with-offset derive-type) ((array index offset new-value))
143 (assert-new-value-type new-value array))
145 ;;; Figure out the type of the data vector if we know the argument
147 (defun derive-%with-array-data/mumble-type (array)
148 (let ((atype (lvar-type array)))
149 (when (array-type-p atype)
151 `(simple-array ,(type-specifier
152 (array-type-specialized-element-type atype))
154 (defoptimizer (%with-array-data derive-type) ((array start end))
155 (derive-%with-array-data/mumble-type array))
156 (defoptimizer (%with-array-data/fp derive-type) ((array start end))
157 (derive-%with-array-data/mumble-type array))
159 (defoptimizer (array-row-major-index derive-type) ((array &rest indices))
160 (assert-array-rank array (length indices))
163 (defoptimizer (row-major-aref derive-type) ((array index))
164 (derive-aref-type array))
166 (defoptimizer (%set-row-major-aref derive-type) ((array index new-value))
167 (assert-new-value-type new-value array))
169 (defoptimizer (make-array derive-type)
170 ((dims &key initial-element element-type initial-contents
171 adjustable fill-pointer displaced-index-offset displaced-to))
172 (let ((simple (and (unsupplied-or-nil adjustable)
173 (unsupplied-or-nil displaced-to)
174 (unsupplied-or-nil fill-pointer))))
175 (or (careful-specifier-type
176 `(,(if simple 'simple-array 'array)
177 ,(cond ((not element-type) t)
178 ((constant-lvar-p element-type)
179 (let ((ctype (careful-specifier-type
180 (lvar-value element-type))))
182 ((or (null ctype) (unknown-type-p ctype)) '*)
183 (t (sb!xc:upgraded-array-element-type
184 (lvar-value element-type))))))
187 ,(cond ((constant-lvar-p dims)
188 (let* ((val (lvar-value dims))
189 (cdims (if (listp val) val (list val))))
193 ((csubtypep (lvar-type dims)
194 (specifier-type 'integer))
198 (specifier-type 'array))))
200 ;;; Complex array operations should assert that their array argument
201 ;;; is complex. In SBCL, vectors with fill-pointers are complex.
202 (defoptimizer (fill-pointer derive-type) ((vector))
203 (assert-array-complex vector))
204 (defoptimizer (%set-fill-pointer derive-type) ((vector index))
205 (declare (ignorable index))
206 (assert-array-complex vector))
208 (defoptimizer (vector-push derive-type) ((object vector))
209 (declare (ignorable object))
210 (assert-array-complex vector))
211 (defoptimizer (vector-push-extend derive-type)
212 ((object vector &optional index))
213 (declare (ignorable object index))
214 (assert-array-complex vector))
215 (defoptimizer (vector-pop derive-type) ((vector))
216 (assert-array-complex vector))
220 ;;; Convert VECTOR into a MAKE-ARRAY followed by SETFs of all the
222 (define-source-transform vector (&rest elements)
223 (let ((len (length elements))
225 (once-only ((n-vec `(make-array ,len)))
227 ,@(mapcar (lambda (el)
228 (once-only ((n-val el))
229 `(locally (declare (optimize (safety 0)))
230 (setf (svref ,n-vec ,(incf n)) ,n-val))))
234 ;;; Just convert it into a MAKE-ARRAY.
235 (deftransform make-string ((length &key
236 (element-type 'character)
238 #.*default-init-char-form*)))
239 `(the simple-string (make-array (the index length)
240 :element-type element-type
241 ,@(when initial-element
242 '(:initial-element initial-element)))))
244 (deftransform make-array ((dims &key initial-element element-type
245 adjustable fill-pointer)
247 (when (null initial-element)
248 (give-up-ir1-transform))
249 (let* ((eltype (cond ((not element-type) t)
250 ((not (constant-lvar-p element-type))
251 (give-up-ir1-transform
252 "ELEMENT-TYPE is not constant."))
254 (lvar-value element-type))))
255 (eltype-type (ir1-transform-specifier-type eltype))
256 (saetp (find-if (lambda (saetp)
257 (csubtypep eltype-type (sb!vm:saetp-ctype saetp)))
258 sb!vm:*specialized-array-element-type-properties*))
259 (creation-form `(make-array dims
260 :element-type ',(type-specifier (sb!vm:saetp-ctype saetp))
262 '(:fill-pointer fill-pointer))
264 '(:adjustable adjustable)))))
267 (give-up-ir1-transform "ELEMENT-TYPE not found in *SAETP*: ~S" eltype))
269 (cond ((and (constant-lvar-p initial-element)
270 (eql (lvar-value initial-element)
271 (sb!vm:saetp-initial-element-default saetp)))
274 ;; error checking for target, disabled on the host because
275 ;; (CTYPE-OF #\Null) is not possible.
277 (when (constant-lvar-p initial-element)
278 (let ((value (lvar-value initial-element)))
280 ((not (ctypep value (sb!vm:saetp-ctype saetp)))
281 ;; this case will cause an error at runtime, so we'd
282 ;; better WARN about it now.
283 (warn 'array-initial-element-mismatch
284 :format-control "~@<~S is not a ~S (which is the ~
289 (type-specifier (sb!vm:saetp-ctype saetp))
290 'upgraded-array-element-type
292 ((not (ctypep value eltype-type))
293 ;; this case will not cause an error at runtime, but
294 ;; it's still worth STYLE-WARNing about.
295 (compiler-style-warn "~S is not a ~S."
297 `(let ((array ,creation-form))
298 (multiple-value-bind (vector)
299 (%data-vector-and-index array 0)
300 (fill vector initial-element))
303 ;;; The integer type restriction on the length ensures that it will be
304 ;;; a vector. The lack of :ADJUSTABLE, :FILL-POINTER, and
305 ;;; :DISPLACED-TO keywords ensures that it will be simple; the lack of
306 ;;; :INITIAL-ELEMENT relies on another transform to deal with that
307 ;;; kind of initialization efficiently.
308 (deftransform make-array ((length &key element-type)
310 (let* ((eltype (cond ((not element-type) t)
311 ((not (constant-lvar-p element-type))
312 (give-up-ir1-transform
313 "ELEMENT-TYPE is not constant."))
315 (lvar-value element-type))))
316 (len (if (constant-lvar-p length)
319 (eltype-type (ir1-transform-specifier-type eltype))
322 ,(if (unknown-type-p eltype-type)
323 (give-up-ir1-transform
324 "ELEMENT-TYPE is an unknown type: ~S" eltype)
325 (sb!xc:upgraded-array-element-type eltype))
327 (saetp (find-if (lambda (saetp)
328 (csubtypep eltype-type (sb!vm:saetp-ctype saetp)))
329 sb!vm:*specialized-array-element-type-properties*)))
331 (give-up-ir1-transform
332 "cannot open-code creation of ~S" result-type-spec))
334 (unless (ctypep (sb!vm:saetp-initial-element-default saetp) eltype-type)
335 ;; This situation arises e.g. in (MAKE-ARRAY 4 :ELEMENT-TYPE
336 ;; '(INTEGER 1 5)) ANSI's definition of MAKE-ARRAY says "If
337 ;; INITIAL-ELEMENT is not supplied, the consequences of later
338 ;; reading an uninitialized element of new-array are undefined,"
339 ;; so this could be legal code as long as the user plans to
340 ;; write before he reads, and if he doesn't we're free to do
341 ;; anything we like. But in case the user doesn't know to write
342 ;; elements before he reads elements (or to read manuals before
343 ;; he writes code:-), we'll signal a STYLE-WARNING in case he
344 ;; didn't realize this.
345 (compiler-style-warn "The default initial element ~S is not a ~S."
346 (sb!vm:saetp-initial-element-default saetp)
348 (let* ((n-bits-per-element (sb!vm:saetp-n-bits saetp))
349 (typecode (sb!vm:saetp-typecode saetp))
350 (n-pad-elements (sb!vm:saetp-n-pad-elements saetp))
351 (padded-length-form (if (zerop n-pad-elements)
353 `(+ length ,n-pad-elements)))
356 ((= n-bits-per-element 0) 0)
357 ((>= n-bits-per-element sb!vm:n-word-bits)
358 `(* ,padded-length-form
359 (the fixnum ; i.e., not RATIO
360 ,(/ n-bits-per-element sb!vm:n-word-bits))))
362 (let ((n-elements-per-word (/ sb!vm:n-word-bits
363 n-bits-per-element)))
364 (declare (type index n-elements-per-word)) ; i.e., not RATIO
365 `(ceiling ,padded-length-form ,n-elements-per-word))))))
367 `(truly-the ,result-type-spec
368 (allocate-vector ,typecode length ,n-words-form))
369 '((declare (type index length)))))))
371 ;;; The list type restriction does not ensure that the result will be a
372 ;;; multi-dimensional array. But the lack of adjustable, fill-pointer,
373 ;;; and displaced-to keywords ensures that it will be simple.
375 ;;; FIXME: should we generalize this transform to non-simple (though
376 ;;; non-displaced-to) arrays, given that we have %WITH-ARRAY-DATA to
377 ;;; deal with those? Maybe when the DEFTRANSFORM
378 ;;; %DATA-VECTOR-AND-INDEX in the VECTOR case problem is solved? --
380 (deftransform make-array ((dims &key element-type)
382 (unless (or (null element-type) (constant-lvar-p element-type))
383 (give-up-ir1-transform
384 "The element-type is not constant; cannot open code array creation."))
385 (unless (constant-lvar-p dims)
386 (give-up-ir1-transform
387 "The dimension list is not constant; cannot open code array creation."))
388 (let ((dims (lvar-value dims)))
389 (unless (every #'integerp dims)
390 (give-up-ir1-transform
391 "The dimension list contains something other than an integer: ~S"
393 (if (= (length dims) 1)
394 `(make-array ',(car dims)
396 '(:element-type element-type)))
397 (let* ((total-size (reduce #'* dims))
400 ,(cond ((null element-type) t)
401 ((and (constant-lvar-p element-type)
402 (ir1-transform-specifier-type
403 (lvar-value element-type)))
404 (sb!xc:upgraded-array-element-type
405 (lvar-value element-type)))
407 ,(make-list rank :initial-element '*))))
408 `(let ((header (make-array-header sb!vm:simple-array-widetag ,rank)))
409 (setf (%array-fill-pointer header) ,total-size)
410 (setf (%array-fill-pointer-p header) nil)
411 (setf (%array-available-elements header) ,total-size)
412 (setf (%array-data-vector header)
413 (make-array ,total-size
415 '(:element-type element-type))))
416 (setf (%array-displaced-p header) nil)
418 (mapcar (lambda (dim)
419 `(setf (%array-dimension header ,(incf axis))
422 (truly-the ,spec header))))))
424 ;;;; miscellaneous properties of arrays
426 ;;; Transforms for various array properties. If the property is know
427 ;;; at compile time because of a type spec, use that constant value.
429 ;;; Most of this logic may end up belonging in code/late-type.lisp;
430 ;;; however, here we also need the -OR-GIVE-UP for the transforms, and
431 ;;; maybe this is just too sloppy for actual type logic. -- CSR,
433 (defun array-type-dimensions-or-give-up (type)
435 (array-type (array-type-dimensions type))
437 (let ((types (union-type-types type)))
438 ;; there are at least two types, right?
439 (aver (> (length types) 1))
440 (let ((result (array-type-dimensions-or-give-up (car types))))
441 (dolist (type (cdr types) result)
442 (unless (equal (array-type-dimensions-or-give-up type) result)
443 (give-up-ir1-transform))))))
444 ;; FIXME: intersection type [e.g. (and (array * (*)) (satisfies foo)) ]
445 (t (give-up-ir1-transform))))
447 (defun conservative-array-type-complexp (type)
449 (array-type (array-type-complexp type))
451 (let ((types (union-type-types type)))
452 (aver (> (length types) 1))
453 (let ((result (conservative-array-type-complexp (car types))))
454 (dolist (type (cdr types) result)
455 (unless (eq (conservative-array-type-complexp type) result)
456 (return-from conservative-array-type-complexp :maybe))))))
457 ;; FIXME: intersection type
460 ;;; If we can tell the rank from the type info, use it instead.
461 (deftransform array-rank ((array))
462 (let ((array-type (lvar-type array)))
463 (let ((dims (array-type-dimensions-or-give-up array-type)))
464 (if (not (listp dims))
465 (give-up-ir1-transform
466 "The array rank is not known at compile time: ~S"
470 ;;; If we know the dimensions at compile time, just use it. Otherwise,
471 ;;; if we can tell that the axis is in bounds, convert to
472 ;;; %ARRAY-DIMENSION (which just indirects the array header) or length
473 ;;; (if it's simple and a vector).
474 (deftransform array-dimension ((array axis)
476 (unless (constant-lvar-p axis)
477 (give-up-ir1-transform "The axis is not constant."))
478 ;; Dimensions may change thanks to ADJUST-ARRAY, so we need the
479 ;; conservative type.
480 (let ((array-type (lvar-conservative-type array))
481 (axis (lvar-value axis)))
482 (let ((dims (array-type-dimensions-or-give-up array-type)))
484 (give-up-ir1-transform
485 "The array dimensions are unknown; must call ARRAY-DIMENSION at runtime."))
486 (unless (> (length dims) axis)
487 (abort-ir1-transform "The array has dimensions ~S, ~W is too large."
490 (let ((dim (nth axis dims)))
491 (cond ((integerp dim)
494 (ecase (conservative-array-type-complexp array-type)
496 '(%array-dimension array 0))
500 (give-up-ir1-transform
501 "can't tell whether array is simple"))))
503 '(%array-dimension array axis)))))))
505 ;;; If the length has been declared and it's simple, just return it.
506 (deftransform length ((vector)
507 ((simple-array * (*))))
508 (let ((type (lvar-type vector)))
509 (let ((dims (array-type-dimensions-or-give-up type)))
510 (unless (and (listp dims) (integerp (car dims)))
511 (give-up-ir1-transform
512 "Vector length is unknown, must call LENGTH at runtime."))
515 ;;; All vectors can get their length by using VECTOR-LENGTH. If it's
516 ;;; simple, it will extract the length slot from the vector. It it's
517 ;;; complex, it will extract the fill pointer slot from the array
519 (deftransform length ((vector) (vector))
520 '(vector-length vector))
522 ;;; If a simple array with known dimensions, then VECTOR-LENGTH is a
523 ;;; compile-time constant.
524 (deftransform vector-length ((vector))
525 (let ((vtype (lvar-type vector)))
526 (let ((dim (first (array-type-dimensions-or-give-up vtype))))
528 (give-up-ir1-transform))
529 (when (conservative-array-type-complexp vtype)
530 (give-up-ir1-transform))
533 ;;; Again, if we can tell the results from the type, just use it.
534 ;;; Otherwise, if we know the rank, convert into a computation based
535 ;;; on array-dimension. We can wrap a TRULY-THE INDEX around the
536 ;;; multiplications because we know that the total size must be an
538 (deftransform array-total-size ((array)
540 (let ((array-type (lvar-type array)))
541 (let ((dims (array-type-dimensions-or-give-up array-type)))
543 (give-up-ir1-transform "can't tell the rank at compile time"))
545 (do ((form 1 `(truly-the index
546 (* (array-dimension array ,i) ,form)))
548 ((= i (length dims)) form))
549 (reduce #'* dims)))))
551 ;;; Only complex vectors have fill pointers.
552 (deftransform array-has-fill-pointer-p ((array))
553 (let ((array-type (lvar-type array)))
554 (let ((dims (array-type-dimensions-or-give-up array-type)))
555 (if (and (listp dims) (not (= (length dims) 1)))
557 (ecase (conservative-array-type-complexp array-type)
563 (give-up-ir1-transform
564 "The array type is ambiguous; must call ~
565 ARRAY-HAS-FILL-POINTER-P at runtime.")))))))
567 ;;; Primitive used to verify indices into arrays. If we can tell at
568 ;;; compile-time or we are generating unsafe code, don't bother with
570 (deftransform %check-bound ((array dimension index) * * :node node)
571 (cond ((policy node (= insert-array-bounds-checks 0))
573 ((not (constant-lvar-p dimension))
574 (give-up-ir1-transform))
576 (let ((dim (lvar-value dimension)))
577 ;; FIXME: Can SPEED > SAFETY weaken this check to INTEGER?
578 `(the (integer 0 (,dim)) index)))))
582 ;;; This checks to see whether the array is simple and the start and
583 ;;; end are in bounds. If so, it proceeds with those values.
584 ;;; Otherwise, it calls %WITH-ARRAY-DATA. Note that %WITH-ARRAY-DATA
585 ;;; may be further optimized.
587 ;;; Given any ARRAY, bind DATA-VAR to the array's data vector and
588 ;;; START-VAR and END-VAR to the start and end of the designated
589 ;;; portion of the data vector. SVALUE and EVALUE are any start and
590 ;;; end specified to the original operation, and are factored into the
591 ;;; bindings of START-VAR and END-VAR. OFFSET-VAR is the cumulative
592 ;;; offset of all displacements encountered, and does not include
595 ;;; When FORCE-INLINE is set, the underlying %WITH-ARRAY-DATA form is
596 ;;; forced to be inline, overriding the ordinary judgment of the
597 ;;; %WITH-ARRAY-DATA DEFTRANSFORMs. Ordinarily the DEFTRANSFORMs are
598 ;;; fairly picky about their arguments, figuring that if you haven't
599 ;;; bothered to get all your ducks in a row, you probably don't care
600 ;;; that much about speed anyway! But in some cases it makes sense to
601 ;;; do type testing inside %WITH-ARRAY-DATA instead of outside, and
602 ;;; the DEFTRANSFORM can't tell that that's going on, so it can make
603 ;;; sense to use FORCE-INLINE option in that case.
604 (def!macro with-array-data (((data-var array &key offset-var)
605 (start-var &optional (svalue 0))
606 (end-var &optional (evalue nil))
607 &key force-inline check-fill-pointer)
610 (once-only ((n-array array)
611 (n-svalue `(the index ,svalue))
612 (n-evalue `(the (or index null) ,evalue)))
613 (let ((check-bounds (policy env (plusp insert-array-bounds-checks))))
614 `(multiple-value-bind (,data-var
617 ,@(when offset-var `(,offset-var)))
618 (if (not (array-header-p ,n-array))
619 (let ((,n-array ,n-array))
620 (declare (type (simple-array * (*)) ,n-array))
621 ,(once-only ((n-len (if check-fill-pointer
623 `(array-total-size ,n-array)))
624 (n-end `(or ,n-evalue ,n-len)))
626 `(if (<= 0 ,n-svalue ,n-end ,n-len)
627 (values ,n-array ,n-svalue ,n-end 0)
628 ,(if check-fill-pointer
629 `(sequence-bounding-indices-bad-error ,n-array ,n-svalue ,n-evalue)
630 `(array-bounding-indices-bad-error ,n-array ,n-svalue ,n-evalue)))
631 `(values ,n-array ,n-svalue ,n-end 0))))
633 `(%with-array-data-macro ,n-array ,n-svalue ,n-evalue
634 :check-bounds ,check-bounds
635 :check-fill-pointer ,check-fill-pointer)
636 (if check-fill-pointer
637 `(%with-array-data/fp ,n-array ,n-svalue ,n-evalue)
638 `(%with-array-data ,n-array ,n-svalue ,n-evalue))))
641 ;;; This is the fundamental definition of %WITH-ARRAY-DATA, for use in
642 ;;; DEFTRANSFORMs and DEFUNs.
643 (def!macro %with-array-data-macro (array
650 (with-unique-names (size defaulted-end data cumulative-offset)
651 `(let* ((,size ,(if check-fill-pointer
653 `(array-total-size ,array)))
654 (,defaulted-end (or ,end ,size)))
656 `((unless (<= ,start ,defaulted-end ,size)
657 ,(if check-fill-pointer
658 `(sequence-bounding-indices-bad-error ,array ,start ,end)
659 `(array-bounding-indices-bad-error ,array ,start ,end)))))
660 (do ((,data ,array (%array-data-vector ,data))
661 (,cumulative-offset 0
662 (+ ,cumulative-offset
663 (%array-displacement ,data))))
664 ((not (array-header-p ,data))
665 (values (the (simple-array ,element-type 1) ,data)
666 (the index (+ ,cumulative-offset ,start))
667 (the index (+ ,cumulative-offset ,defaulted-end))
668 (the index ,cumulative-offset)))
669 (declare (type index ,cumulative-offset))))))
671 (defun transform-%with-array-data/muble (array node check-fill-pointer)
672 (let ((element-type (upgraded-element-type-specifier-or-give-up array))
673 (type (lvar-type array))
674 (check-bounds (policy node (plusp insert-array-bounds-checks))))
675 (if (and (array-type-p type)
676 (not (array-type-complexp type))
677 (listp (array-type-dimensions type))
678 (not (null (cdr (array-type-dimensions type)))))
679 ;; If it's a simple multidimensional array, then just return
680 ;; its data vector directly rather than going through
681 ;; %WITH-ARRAY-DATA-MACRO. SBCL doesn't generally generate
682 ;; code that would use this currently, but we have encouraged
683 ;; users to use WITH-ARRAY-DATA and we may use it ourselves at
684 ;; some point in the future for optimized libraries or
687 `(let* ((data (truly-the (simple-array ,element-type (*))
688 (%array-data-vector array)))
690 (real-end (or end len)))
691 (unless (<= 0 start data-end lend)
692 (sequence-bounding-indices-bad-error array start end))
693 (values data 0 real-end 0))
694 `(let ((data (truly-the (simple-array ,element-type (*))
695 (%array-data-vector array))))
696 (values data 0 (or end (length data)) 0)))
697 `(%with-array-data-macro array start end
698 :check-fill-pointer ,check-fill-pointer
699 :check-bounds ,check-bounds
700 :element-type ,element-type))))
702 ;; It might very well be reasonable to allow general ARRAY here, I
703 ;; just haven't tried to understand the performance issues involved.
704 ;; -- WHN, and also CSR 2002-05-26
705 (deftransform %with-array-data ((array start end)
706 ((or vector simple-array) index (or index null) t)
709 :policy (> speed space))
710 "inline non-SIMPLE-vector-handling logic"
711 (transform-%with-array-data/muble array node nil))
712 (deftransform %with-array-data/fp ((array start end)
713 ((or vector simple-array) index (or index null) t)
716 :policy (> speed space))
717 "inline non-SIMPLE-vector-handling logic"
718 (transform-%with-array-data/muble array node t))
722 ;;; We convert all typed array accessors into AREF and %ASET with type
723 ;;; assertions on the array.
724 (macrolet ((define-bit-frob (reffer setter simplep)
726 (define-source-transform ,reffer (a &rest i)
727 `(aref (the (,',(if simplep 'simple-array 'array)
729 ,(mapcar (constantly '*) i))
731 (define-source-transform ,setter (a &rest i)
732 `(%aset (the (,',(if simplep 'simple-array 'array)
734 ,(cdr (mapcar (constantly '*) i)))
736 (define-bit-frob sbit %sbitset t)
737 (define-bit-frob bit %bitset nil))
738 (macrolet ((define-frob (reffer setter type)
740 (define-source-transform ,reffer (a i)
741 `(aref (the ,',type ,a) ,i))
742 (define-source-transform ,setter (a i v)
743 `(%aset (the ,',type ,a) ,i ,v)))))
744 (define-frob svref %svset simple-vector)
745 (define-frob schar %scharset simple-string)
746 (define-frob char %charset string))
748 (macrolet (;; This is a handy macro for computing the row-major index
749 ;; given a set of indices. We wrap each index with a call
750 ;; to %CHECK-BOUND to ensure that everything works out
751 ;; correctly. We can wrap all the interior arithmetic with
752 ;; TRULY-THE INDEX because we know the resultant
753 ;; row-major index must be an index.
754 (with-row-major-index ((array indices index &optional new-value)
756 `(let (n-indices dims)
757 (dotimes (i (length ,indices))
758 (push (make-symbol (format nil "INDEX-~D" i)) n-indices)
759 (push (make-symbol (format nil "DIM-~D" i)) dims))
760 (setf n-indices (nreverse n-indices))
761 (setf dims (nreverse dims))
762 `(lambda (,',array ,@n-indices
763 ,@',(when new-value (list new-value)))
764 (let* (,@(let ((,index -1))
765 (mapcar (lambda (name)
766 `(,name (array-dimension
773 (do* ((dims dims (cdr dims))
774 (indices n-indices (cdr indices))
775 (last-dim nil (car dims))
776 (form `(%check-bound ,',array
788 ((null (cdr dims)) form)))))
791 ;; Just return the index after computing it.
792 (deftransform array-row-major-index ((array &rest indices))
793 (with-row-major-index (array indices index)
796 ;; Convert AREF and %ASET into a HAIRY-DATA-VECTOR-REF (or
797 ;; HAIRY-DATA-VECTOR-SET) with the set of indices replaced with the an
798 ;; expression for the row major index.
799 (deftransform aref ((array &rest indices))
800 (with-row-major-index (array indices index)
801 (hairy-data-vector-ref array index)))
803 (deftransform %aset ((array &rest stuff))
804 (let ((indices (butlast stuff)))
805 (with-row-major-index (array indices index new-value)
806 (hairy-data-vector-set array index new-value)))))
808 ;; For AREF of vectors we do the bounds checking in the callee. This
809 ;; lets us do a significantly more efficient check for simple-arrays
810 ;; without bloating the code. If we already know the type of the array
811 ;; with sufficient precision, skip directly to DATA-VECTOR-REF.
812 (deftransform aref ((array index) (t t) * :node node)
813 (let* ((type (lvar-type array))
814 (element-ctype (extract-upgraded-element-type array)))
816 ((and (array-type-p type)
817 (null (array-type-complexp type))
818 (not (eql element-ctype *wild-type*))
819 (eql (length (array-type-dimensions type)) 1))
820 (let* ((declared-element-ctype (extract-declared-element-type array))
822 `(data-vector-ref array
823 (%check-bound array (array-dimension array 0) index))))
824 (if (type= declared-element-ctype element-ctype)
826 `(the ,(type-specifier declared-element-ctype) ,bare-form))))
827 ((policy node (zerop insert-array-bounds-checks))
828 `(hairy-data-vector-ref array index))
829 (t `(hairy-data-vector-ref/check-bounds array index)))))
831 (deftransform %aset ((array index new-value) (t t t) * :node node)
832 (if (policy node (zerop insert-array-bounds-checks))
833 `(hairy-data-vector-set array index new-value)
834 `(hairy-data-vector-set/check-bounds array index new-value)))
836 ;;; But if we find out later that there's some useful type information
837 ;;; available, switch back to the normal one to give other transforms
839 (macrolet ((define (name transform-to extra extra-type)
840 (declare (ignore extra-type))
841 `(deftransform ,name ((array index ,@extra))
842 (let ((type (lvar-type array))
843 (element-type (extract-upgraded-element-type array)))
844 ;; If an element type has been declared, we want to
845 ;; use that information it for type checking (even
846 ;; if the access can't be optimized due to the array
847 ;; not being simple).
848 (when (and (eql element-type *wild-type*)
849 ;; This type logic corresponds to the special
850 ;; case for strings in HAIRY-DATA-VECTOR-REF
851 ;; (generic/vm-tran.lisp)
852 (not (csubtypep type (specifier-type 'simple-string))))
853 (when (or (not (array-type-p type))
854 ;; If it's a simple array, we might be able
855 ;; to inline the access completely.
856 (not (null (array-type-complexp type))))
857 (give-up-ir1-transform
858 "Upgraded element type of array is not known at compile time."))))
859 `(,',transform-to array
861 (array-dimension array 0)
864 (define hairy-data-vector-ref/check-bounds
865 hairy-data-vector-ref nil nil)
866 (define hairy-data-vector-set/check-bounds
867 hairy-data-vector-set (new-value) (*)))
869 ;;; Just convert into a HAIRY-DATA-VECTOR-REF (or
870 ;;; HAIRY-DATA-VECTOR-SET) after checking that the index is inside the
871 ;;; array total size.
872 (deftransform row-major-aref ((array index))
873 `(hairy-data-vector-ref array
874 (%check-bound array (array-total-size array) index)))
875 (deftransform %set-row-major-aref ((array index new-value))
876 `(hairy-data-vector-set array
877 (%check-bound array (array-total-size array) index)
880 ;;;; bit-vector array operation canonicalization
882 ;;;; We convert all bit-vector operations to have the result array
883 ;;;; specified. This allows any result allocation to be open-coded,
884 ;;;; and eliminates the need for any VM-dependent transforms to handle
887 (macrolet ((def (fun)
889 (deftransform ,fun ((bit-array-1 bit-array-2
890 &optional result-bit-array)
891 (bit-vector bit-vector &optional null) *
892 :policy (>= speed space))
893 `(,',fun bit-array-1 bit-array-2
894 (make-array (array-dimension bit-array-1 0) :element-type 'bit)))
895 ;; If result is T, make it the first arg.
896 (deftransform ,fun ((bit-array-1 bit-array-2 result-bit-array)
897 (bit-vector bit-vector (eql t)) *)
898 `(,',fun bit-array-1 bit-array-2 bit-array-1)))))
910 ;;; Similar for BIT-NOT, but there is only one arg...
911 (deftransform bit-not ((bit-array-1 &optional result-bit-array)
912 (bit-vector &optional null) *
913 :policy (>= speed space))
914 '(bit-not bit-array-1
915 (make-array (array-dimension bit-array-1 0) :element-type 'bit)))
916 (deftransform bit-not ((bit-array-1 result-bit-array)
917 (bit-vector (eql t)))
918 '(bit-not bit-array-1 bit-array-1))
920 ;;; Pick off some constant cases.
921 (defoptimizer (array-header-p derive-type) ((array))
922 (let ((type (lvar-type array)))
923 (cond ((not (array-type-p type))
924 ;; FIXME: use analogue of ARRAY-TYPE-DIMENSIONS-OR-GIVE-UP
927 (let ((dims (array-type-dimensions type)))
928 (cond ((csubtypep type (specifier-type '(simple-array * (*))))
930 (specifier-type 'null))
931 ((and (listp dims) (/= (length dims) 1))
932 ;; multi-dimensional array, will have a header
933 (specifier-type '(eql t)))
934 ((eql (array-type-complexp type) t)
935 (specifier-type '(eql t)))