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-type-specifier (upgraded-element-type-specifier lvar)))
21 (if (eq element-type-specifier '*)
22 (give-up-ir1-transform
23 "upgraded array element type not known at compile time")
24 element-type-specifier)))
26 (defun upgraded-element-type-specifier (lvar)
27 (type-specifier (array-type-upgraded-element-type (lvar-type lvar))))
29 ;;; Array access functions return an object from the array, hence its type is
30 ;;; going to be the array upgraded element type. Secondary return value is the
31 ;;; known supertype of the upgraded-array-element-type, if if the exact
32 ;;; U-A-E-T is not known. (If it is NIL, the primary return value is as good
34 (defun array-type-upgraded-element-type (type)
36 ;; Note that this IF mightn't be satisfied even if the runtime
37 ;; value is known to be a subtype of some specialized ARRAY, because
38 ;; we can have values declared e.g. (AND SIMPLE-VECTOR UNKNOWN-TYPE),
39 ;; which are represented in the compiler as INTERSECTION-TYPE, not
42 (values (array-type-specialized-element-type type) nil))
43 ;; Deal with intersection types (bug #316078)
45 (let ((intersection-types (intersection-type-types type))
46 (element-type *wild-type*)
47 (element-supertypes nil))
48 (dolist (intersection-type intersection-types)
49 (multiple-value-bind (cur-type cur-supertype)
50 (array-type-upgraded-element-type intersection-type)
51 ;; According to ANSI, an array may have only one specialized
52 ;; element type - e.g. '(and (array foo) (array bar))
53 ;; is not a valid type unless foo and bar upgrade to the
56 ((eq cur-type *wild-type*)
58 ((eq element-type *wild-type*)
59 (setf element-type cur-type))
60 ((or (not (csubtypep cur-type element-type))
61 (not (csubtypep element-type cur-type)))
62 ;; At least two different element types where given, the array
63 ;; is valid iff they represent the same type.
65 ;; FIXME: TYPE-INTERSECTION already takes care of disjoint array
66 ;; types, so I believe this code should be unreachable. Maybe
67 ;; signal a warning / error instead?
68 (setf element-type *empty-type*)))
69 (push (or cur-supertype (type-*-to-t cur-type))
72 (when (and (eq *wild-type* element-type) element-supertypes)
73 (apply #'type-intersection element-supertypes)))))
75 (let ((union-types (union-type-types type))
77 (element-supertypes nil))
78 (dolist (union-type union-types)
79 (multiple-value-bind (cur-type cur-supertype)
80 (array-type-upgraded-element-type union-type)
82 ((eq element-type *wild-type*)
84 ((eq element-type nil)
85 (setf element-type cur-type))
86 ((or (eq cur-type *wild-type*)
87 ;; If each of the two following tests fail, it is not
88 ;; possible to determine the element-type of the array
89 ;; because more than one kind of element-type was provided
90 ;; like in '(or (array foo) (array bar)) although a
91 ;; supertype (or foo bar) may be provided as the second
92 ;; returned value returned. See also the KLUDGE below.
93 (not (csubtypep cur-type element-type))
94 (not (csubtypep element-type cur-type)))
95 (setf element-type *wild-type*)))
96 (push (or cur-supertype (type-*-to-t cur-type))
99 (when (eq *wild-type* element-type)
100 (apply #'type-union element-supertypes)))))
102 ;; Convert member-type to an union-type.
103 (array-type-upgraded-element-type
104 (apply #'type-union (mapcar #'ctype-of (member-type-members type)))))
106 ;; KLUDGE: there is no good answer here, but at least
107 ;; *wild-type* won't cause HAIRY-DATA-VECTOR-{REF,SET} to be
108 ;; erroneously optimized (see generic/vm-tran.lisp) -- CSR,
110 (values *wild-type* nil))))
112 (defun array-type-declared-element-type (type)
113 (if (array-type-p type)
114 (array-type-element-type type)
117 ;;; The ``new-value'' for array setters must fit in the array, and the
118 ;;; return type is going to be the same as the new-value for SETF
120 (defun assert-new-value-type (new-value array)
121 (let ((type (lvar-type array)))
122 (when (array-type-p type)
125 (array-type-specialized-element-type type)
126 (lexenv-policy (node-lexenv (lvar-dest new-value))))))
127 (lvar-type new-value))
129 ;;; Return true if ARG is NIL, or is a constant-lvar whose
130 ;;; value is NIL, false otherwise.
131 (defun unsupplied-or-nil (arg)
132 (declare (type (or lvar null) arg))
134 (and (constant-lvar-p arg)
135 (not (lvar-value arg)))))
137 (defun supplied-and-true (arg)
139 (constant-lvar-p arg)
143 ;;;; DERIVE-TYPE optimizers
145 ;;; Array operations that use a specific number of indices implicitly
146 ;;; assert that the array is of that rank.
147 (defun assert-array-rank (array rank)
150 (specifier-type `(array * ,(make-list rank :initial-element '*)))
151 (lexenv-policy (node-lexenv (lvar-dest array)))))
153 (defun derive-aref-type (array)
154 (multiple-value-bind (uaet other)
155 (array-type-upgraded-element-type (lvar-type array))
158 (defoptimizer (array-in-bounds-p derive-type) ((array &rest indices))
159 (assert-array-rank array (length indices))
162 (deftransform array-in-bounds-p ((array &rest subscripts))
164 (give-up-ir1-transform
165 "~@<lower array bounds unknown or negative and upper bounds not ~
168 (integerp x))) ; might be NIL or *
170 (let ((dimensions (array-type-dimensions-or-give-up
171 (lvar-conservative-type array))))
172 ;; Might be *. (Note: currently this is never true, because the type
173 ;; derivation infers the rank from the call to ARRAY-IN-BOUNDS-P, but
174 ;; let's keep this future proof.)
175 (when (eq '* dimensions)
176 (give-up-ir1-transform "array bounds unknown"))
177 ;; shortcut for zero dimensions
178 (when (some (lambda (dim)
179 (and (bound-known-p dim) (zerop dim)))
182 ;; we first collect the subscripts LVARs' bounds and see whether
183 ;; we can already decide on the result of the optimization without
184 ;; even taking a look at the dimensions.
185 (flet ((subscript-bounds (subscript)
186 (let* ((type1 (lvar-type subscript))
187 (type2 (if (csubtypep type1 (specifier-type 'integer))
188 (weaken-integer-type type1 :range-only t)
190 (low (if (integer-type-p type2)
191 (numeric-type-low type2)
193 (high (numeric-type-high type2)))
195 ((and (or (not (bound-known-p low)) (minusp low))
196 (or (not (bound-known-p high)) (not (minusp high))))
197 ;; can't be sure about the lower bound and the upper bound
198 ;; does not give us a definite clue either.
200 ((and (bound-known-p high) (minusp high))
201 (return nil)) ; definitely below lower bound (zero).
204 (let* ((subscripts-bounds (mapcar #'subscript-bounds subscripts))
205 (subscripts-lower-bound (mapcar #'car subscripts-bounds))
206 (subscripts-upper-bound (mapcar #'cdr subscripts-bounds))
208 (mapcar (lambda (low high dim)
210 ;; first deal with infinite bounds
211 ((some (complement #'bound-known-p) (list low high dim))
212 (when (and (bound-known-p dim) (bound-known-p low) (<= dim low))
214 ;; now we know all bounds
218 (aver (not (minusp low)))
222 subscripts-lower-bound
223 subscripts-upper-bound
225 (if (eql in-bounds (length dimensions))
229 (defoptimizer (aref derive-type) ((array &rest indices) node)
230 (assert-array-rank array (length indices))
231 (derive-aref-type array))
233 (defoptimizer (%aset derive-type) ((array &rest stuff))
234 (assert-array-rank array (1- (length stuff)))
235 (assert-new-value-type (car (last stuff)) array))
237 (macrolet ((define (name)
238 `(defoptimizer (,name derive-type) ((array index))
239 (derive-aref-type array))))
240 (define hairy-data-vector-ref)
241 (define hairy-data-vector-ref/check-bounds)
242 (define data-vector-ref))
245 (defoptimizer (data-vector-ref-with-offset derive-type) ((array index offset))
246 (derive-aref-type array))
248 (macrolet ((define (name)
249 `(defoptimizer (,name derive-type) ((array index new-value))
250 (assert-new-value-type new-value array))))
251 (define hairy-data-vector-set)
252 (define hairy-data-vector-set/check-bounds)
253 (define data-vector-set))
256 (defoptimizer (data-vector-set-with-offset derive-type) ((array index offset new-value))
257 (assert-new-value-type new-value array))
259 ;;; Figure out the type of the data vector if we know the argument
261 (defun derive-%with-array-data/mumble-type (array)
262 (let ((atype (lvar-type array)))
263 (when (array-type-p atype)
265 `(simple-array ,(type-specifier
266 (array-type-specialized-element-type atype))
268 (defoptimizer (%with-array-data derive-type) ((array start end))
269 (derive-%with-array-data/mumble-type array))
270 (defoptimizer (%with-array-data/fp derive-type) ((array start end))
271 (derive-%with-array-data/mumble-type array))
273 (defoptimizer (array-row-major-index derive-type) ((array &rest indices))
274 (assert-array-rank array (length indices))
277 (defoptimizer (row-major-aref derive-type) ((array index))
278 (derive-aref-type array))
280 (defoptimizer (%set-row-major-aref derive-type) ((array index new-value))
281 (assert-new-value-type new-value array))
283 (defoptimizer (make-array derive-type)
284 ((dims &key initial-element element-type initial-contents
285 adjustable fill-pointer displaced-index-offset displaced-to))
286 (let* ((simple (and (unsupplied-or-nil adjustable)
287 (unsupplied-or-nil displaced-to)
288 (unsupplied-or-nil fill-pointer)))
290 (or `(,(if simple 'simple-array 'array)
291 ,(cond ((not element-type) t)
292 ((constant-lvar-p element-type)
293 (let ((ctype (careful-specifier-type
294 (lvar-value element-type))))
296 ((or (null ctype) (unknown-type-p ctype)) '*)
297 (t (sb!xc:upgraded-array-element-type
298 (lvar-value element-type))))))
301 ,(cond ((constant-lvar-p dims)
302 (let* ((val (lvar-value dims))
303 (cdims (if (listp val) val (list val))))
307 ((csubtypep (lvar-type dims)
308 (specifier-type 'integer))
313 (if (and (not simple)
314 (or (supplied-and-true adjustable)
315 (supplied-and-true displaced-to)
316 (supplied-and-true fill-pointer)))
317 (careful-specifier-type `(and ,spec (not simple-array)))
318 (careful-specifier-type spec))))
322 ;;; Convert VECTOR into a MAKE-ARRAY.
323 (define-source-transform vector (&rest elements)
324 `(make-array ,(length elements) :initial-contents (list ,@elements)))
326 ;;; Just convert it into a MAKE-ARRAY.
327 (deftransform make-string ((length &key
328 (element-type 'character)
330 #.*default-init-char-form*)))
331 `(the simple-string (make-array (the index length)
332 :element-type element-type
333 ,@(when initial-element
334 '(:initial-element initial-element)))))
336 (defun rewrite-initial-contents (rank initial-contents env)
338 (if (and (consp initial-contents)
339 (member (car initial-contents) '(list vector sb!impl::backq-list)))
340 `(list ,@(mapcar (lambda (dim)
341 (rewrite-initial-contents (1- rank) dim env))
342 (cdr initial-contents)))
344 ;; This is the important bit: once we are past the level of
345 ;; :INITIAL-CONTENTS that relates to the array structure, reinline LIST
346 ;; and VECTOR so that nested DX isn't screwed up.
347 `(locally (declare (inline list vector))
350 ;;; Prevent open coding DIMENSION and :INITIAL-CONTENTS arguments, so that we
351 ;;; can pick them apart in the DEFTRANSFORMS, and transform '(3) style
352 ;;; dimensions to integer args directly.
353 (define-source-transform make-array (dimensions &rest keyargs &environment env)
354 (if (or (and (fun-lexically-notinline-p 'list)
355 (fun-lexically-notinline-p 'vector))
356 (oddp (length keyargs)))
358 (multiple-value-bind (new-dimensions rank)
359 (flet ((constant-dims (dimensions)
360 (let* ((dims (constant-form-value dimensions env))
361 (canon (if (listp dims) dims (list dims)))
362 (rank (length canon)))
363 (values (if (= rank 1)
364 (list 'quote (car canon))
367 (cond ((sb!xc:constantp dimensions env)
368 (constant-dims dimensions))
369 ((and (consp dimensions) (eq 'list dimensions))
370 (values dimensions (length (cdr dimensions))))
372 (values dimensions nil))))
373 (let ((initial-contents (getf keyargs :initial-contents)))
374 (when (and initial-contents rank)
375 (setf keyargs (copy-list keyargs)
376 (getf keyargs :initial-contents)
377 (rewrite-initial-contents rank initial-contents env))))
378 `(locally (declare (notinline list vector))
379 (make-array ,new-dimensions ,@keyargs)))))
381 ;;; This baby is a bit of a monster, but it takes care of any MAKE-ARRAY
382 ;;; call which creates a vector with a known element type -- and tries
383 ;;; to do a good job with all the different ways it can happen.
384 (defun transform-make-array-vector (length element-type initial-element
385 initial-contents call)
386 (aver (or (not element-type) (constant-lvar-p element-type)))
387 (let* ((c-length (when (constant-lvar-p length)
388 (lvar-value length)))
389 (elt-spec (if element-type
390 (lvar-value element-type)
392 (elt-ctype (ir1-transform-specifier-type elt-spec))
393 (saetp (if (unknown-type-p elt-ctype)
394 (give-up-ir1-transform "~S is an unknown type: ~S"
395 :element-type elt-spec)
396 (find-saetp-by-ctype elt-ctype)))
397 (default-initial-element (sb!vm:saetp-initial-element-default saetp))
398 (n-bits (sb!vm:saetp-n-bits saetp))
399 (typecode (sb!vm:saetp-typecode saetp))
400 (n-pad-elements (sb!vm:saetp-n-pad-elements saetp))
403 (ceiling (* (+ c-length n-pad-elements) n-bits)
405 (let ((padded-length-form (if (zerop n-pad-elements)
407 `(+ length ,n-pad-elements))))
410 ((>= n-bits sb!vm:n-word-bits)
411 `(* ,padded-length-form
413 ,(the fixnum (/ n-bits sb!vm:n-word-bits))))
415 (let ((n-elements-per-word (/ sb!vm:n-word-bits n-bits)))
416 (declare (type index n-elements-per-word)) ; i.e., not RATIO
417 `(ceiling ,padded-length-form ,n-elements-per-word)))))))
419 `(simple-array ,(sb!vm:saetp-specifier saetp) (,(or c-length '*))))
421 `(truly-the ,result-spec
422 (allocate-vector ,typecode (the index length) ,n-words-form))))
423 (cond ((and initial-element initial-contents)
424 (abort-ir1-transform "Both ~S and ~S specified."
425 :initial-contents :initial-element))
426 ;; :INITIAL-CONTENTS (LIST ...), (VECTOR ...) and `(1 1 ,x) with a
428 ((and initial-contents c-length
429 (lvar-matches initial-contents
430 :fun-names '(list vector sb!impl::backq-list)
431 :arg-count c-length))
432 (let ((parameters (eliminate-keyword-args
433 call 1 '((:element-type element-type)
434 (:initial-contents initial-contents))))
435 (elt-vars (make-gensym-list c-length))
436 (lambda-list '(length)))
437 (splice-fun-args initial-contents :any c-length)
438 (dolist (p parameters)
441 (if (eq p 'initial-contents)
444 `(lambda ,lambda-list
445 (declare (type ,elt-spec ,@elt-vars)
446 (ignorable ,@lambda-list))
447 (truly-the ,result-spec
448 (initialize-vector ,alloc-form ,@elt-vars)))))
449 ;; constant :INITIAL-CONTENTS and LENGTH
450 ((and initial-contents c-length (constant-lvar-p initial-contents))
451 (let ((contents (lvar-value initial-contents)))
452 (unless (= c-length (length contents))
453 (abort-ir1-transform "~S has ~S elements, vector length is ~S."
454 :initial-contents (length contents) c-length))
455 (let ((parameters (eliminate-keyword-args
456 call 1 '((:element-type element-type)
457 (:initial-contents initial-contents)))))
458 `(lambda (length ,@parameters)
459 (declare (ignorable ,@parameters))
460 (truly-the ,result-spec
461 (initialize-vector ,alloc-form
462 ,@(map 'list (lambda (elt)
463 `(the ,elt-spec ',elt))
465 ;; any other :INITIAL-CONTENTS
467 (let ((parameters (eliminate-keyword-args
468 call 1 '((:element-type element-type)
469 (:initial-contents initial-contents)))))
470 `(lambda (length ,@parameters)
471 (declare (ignorable ,@parameters))
472 (unless (= length (length initial-contents))
473 (error "~S has ~S elements, vector length is ~S."
474 :initial-contents (length initial-contents) length))
475 (truly-the ,result-spec
476 (replace ,alloc-form initial-contents)))))
477 ;; :INITIAL-ELEMENT, not EQL to the default
478 ((and initial-element
479 (or (not (constant-lvar-p initial-element))
480 (not (eql default-initial-element (lvar-value initial-element)))))
481 (let ((parameters (eliminate-keyword-args
482 call 1 '((:element-type element-type)
483 (:initial-element initial-element))))
484 (init (if (constant-lvar-p initial-element)
485 (list 'quote (lvar-value initial-element))
487 `(lambda (length ,@parameters)
488 (declare (ignorable ,@parameters))
489 (truly-the ,result-spec
490 (fill ,alloc-form (the ,elt-spec ,init))))))
491 ;; just :ELEMENT-TYPE, or maybe with :INITIAL-ELEMENT EQL to the
495 (unless (ctypep default-initial-element elt-ctype)
496 ;; This situation arises e.g. in (MAKE-ARRAY 4 :ELEMENT-TYPE
497 ;; '(INTEGER 1 5)) ANSI's definition of MAKE-ARRAY says "If
498 ;; INITIAL-ELEMENT is not supplied, the consequences of later
499 ;; reading an uninitialized element of new-array are undefined,"
500 ;; so this could be legal code as long as the user plans to
501 ;; write before he reads, and if he doesn't we're free to do
502 ;; anything we like. But in case the user doesn't know to write
503 ;; elements before he reads elements (or to read manuals before
504 ;; he writes code:-), we'll signal a STYLE-WARNING in case he
505 ;; didn't realize this.
507 (compiler-warn "~S ~S is not a ~S"
508 :initial-element default-initial-element
510 (compiler-style-warn "The default initial element ~S is not a ~S."
511 default-initial-element
513 (let ((parameters (eliminate-keyword-args
514 call 1 '((:element-type element-type)
515 (:initial-element initial-element)))))
516 `(lambda (length ,@parameters)
517 (declare (ignorable ,@parameters))
520 ;;; IMPORTANT: The order of these three MAKE-ARRAY forms matters: the least
521 ;;; specific must come first, otherwise suboptimal transforms will result for
524 (deftransform make-array ((dims &key initial-element element-type
525 adjustable fill-pointer)
527 (when (null initial-element)
528 (give-up-ir1-transform))
529 (let* ((eltype (cond ((not element-type) t)
530 ((not (constant-lvar-p element-type))
531 (give-up-ir1-transform
532 "ELEMENT-TYPE is not constant."))
534 (lvar-value element-type))))
535 (eltype-type (ir1-transform-specifier-type eltype))
536 (saetp (find-if (lambda (saetp)
537 (csubtypep eltype-type (sb!vm:saetp-ctype saetp)))
538 sb!vm:*specialized-array-element-type-properties*))
539 (creation-form `(make-array dims
540 :element-type ',(type-specifier (sb!vm:saetp-ctype saetp))
542 '(:fill-pointer fill-pointer))
544 '(:adjustable adjustable)))))
547 (give-up-ir1-transform "ELEMENT-TYPE not found in *SAETP*: ~S" eltype))
549 (cond ((and (constant-lvar-p initial-element)
550 (eql (lvar-value initial-element)
551 (sb!vm:saetp-initial-element-default saetp)))
554 ;; error checking for target, disabled on the host because
555 ;; (CTYPE-OF #\Null) is not possible.
557 (when (constant-lvar-p initial-element)
558 (let ((value (lvar-value initial-element)))
560 ((not (ctypep value (sb!vm:saetp-ctype saetp)))
561 ;; this case will cause an error at runtime, so we'd
562 ;; better WARN about it now.
563 (warn 'array-initial-element-mismatch
564 :format-control "~@<~S is not a ~S (which is the ~
569 (type-specifier (sb!vm:saetp-ctype saetp))
570 'upgraded-array-element-type
572 ((not (ctypep value eltype-type))
573 ;; this case will not cause an error at runtime, but
574 ;; it's still worth STYLE-WARNing about.
575 (compiler-style-warn "~S is not a ~S."
577 `(let ((array ,creation-form))
578 (multiple-value-bind (vector)
579 (%data-vector-and-index array 0)
580 (fill vector (the ,(sb!vm:saetp-specifier saetp) initial-element)))
583 ;;; The list type restriction does not ensure that the result will be a
584 ;;; multi-dimensional array. But the lack of adjustable, fill-pointer,
585 ;;; and displaced-to keywords ensures that it will be simple.
587 ;;; FIXME: should we generalize this transform to non-simple (though
588 ;;; non-displaced-to) arrays, given that we have %WITH-ARRAY-DATA to
589 ;;; deal with those? Maybe when the DEFTRANSFORM
590 ;;; %DATA-VECTOR-AND-INDEX in the VECTOR case problem is solved? --
592 (deftransform make-array ((dims &key
593 element-type initial-element initial-contents)
595 (:element-type (constant-arg *))
597 (:initial-contents *))
601 (when (lvar-matches dims :fun-names '(list) :arg-count 1)
602 (let ((length (car (splice-fun-args dims :any 1))))
603 (return-from make-array
604 (transform-make-array-vector length
609 (unless (constant-lvar-p dims)
610 (give-up-ir1-transform
611 "The dimension list is not constant; cannot open code array creation."))
612 (let ((dims (lvar-value dims)))
613 (unless (every #'integerp dims)
614 (give-up-ir1-transform
615 "The dimension list contains something other than an integer: ~S"
617 (if (= (length dims) 1)
618 `(make-array ',(car dims)
620 '(:element-type element-type))
621 ,@(when initial-element
622 '(:initial-element initial-element))
623 ,@(when initial-contents
624 '(:initial-contents initial-contents)))
625 (let* ((total-size (reduce #'* dims))
628 ,(cond ((null element-type) t)
629 ((and (constant-lvar-p element-type)
630 (ir1-transform-specifier-type
631 (lvar-value element-type)))
632 (sb!xc:upgraded-array-element-type
633 (lvar-value element-type)))
635 ,(make-list rank :initial-element '*))))
636 `(let ((header (make-array-header sb!vm:simple-array-widetag ,rank))
637 (data (make-array ,total-size
639 '(:element-type element-type))
640 ,@(when initial-element
641 '(:initial-element initial-element)))))
642 ,@(when initial-contents
643 ;; FIXME: This is could be open coded at least a bit too
644 `((sb!impl::fill-data-vector data ',dims initial-contents)))
645 (setf (%array-fill-pointer header) ,total-size)
646 (setf (%array-fill-pointer-p header) nil)
647 (setf (%array-available-elements header) ,total-size)
648 (setf (%array-data-vector header) data)
649 (setf (%array-displaced-p header) nil)
650 (setf (%array-displaced-from header) nil)
652 (mapcar (lambda (dim)
653 `(setf (%array-dimension header ,(incf axis))
656 (truly-the ,spec header)))))))
658 (deftransform make-array ((dims &key element-type initial-element initial-contents)
660 (:element-type (constant-arg *))
662 (:initial-contents *))
665 (transform-make-array-vector dims
671 ;;;; miscellaneous properties of arrays
673 ;;; Transforms for various array properties. If the property is know
674 ;;; at compile time because of a type spec, use that constant value.
676 ;;; Most of this logic may end up belonging in code/late-type.lisp;
677 ;;; however, here we also need the -OR-GIVE-UP for the transforms, and
678 ;;; maybe this is just too sloppy for actual type logic. -- CSR,
680 (defun array-type-dimensions-or-give-up (type)
681 (labels ((maybe-array-type-dimensions (type)
684 (array-type-dimensions type))
686 (let* ((types (remove nil (mapcar #'maybe-array-type-dimensions
687 (union-type-types type))))
688 (result (car types)))
689 (dolist (other (cdr types) result)
690 (unless (equal result other)
691 (give-up-ir1-transform
692 "~@<dimensions of arrays in union type ~S do not match~:@>"
693 (type-specifier type))))))
695 (let* ((types (remove nil (mapcar #'maybe-array-type-dimensions
696 (intersection-type-types type))))
697 (result (car types)))
698 (dolist (other (cdr types) result)
699 (unless (equal result other)
701 "~@<dimensions of arrays in intersection type ~S do not match~:@>"
702 (type-specifier type)))))))))
703 (or (maybe-array-type-dimensions type)
704 (give-up-ir1-transform
705 "~@<don't know how to extract array dimensions from type ~S~:@>"
706 (type-specifier type)))))
708 (defun conservative-array-type-complexp (type)
710 (array-type (array-type-complexp type))
712 (let ((types (union-type-types type)))
713 (aver (> (length types) 1))
714 (let ((result (conservative-array-type-complexp (car types))))
715 (dolist (type (cdr types) result)
716 (unless (eq (conservative-array-type-complexp type) result)
717 (return-from conservative-array-type-complexp :maybe))))))
718 ;; FIXME: intersection type
721 ;;; If we can tell the rank from the type info, use it instead.
722 (deftransform array-rank ((array))
723 (let ((array-type (lvar-type array)))
724 (let ((dims (array-type-dimensions-or-give-up array-type)))
727 ((eq t (array-type-complexp array-type))
728 '(%array-rank array))
730 `(if (array-header-p array)
734 ;;; If we know the dimensions at compile time, just use it. Otherwise,
735 ;;; if we can tell that the axis is in bounds, convert to
736 ;;; %ARRAY-DIMENSION (which just indirects the array header) or length
737 ;;; (if it's simple and a vector).
738 (deftransform array-dimension ((array axis)
740 (unless (constant-lvar-p axis)
741 (give-up-ir1-transform "The axis is not constant."))
742 ;; Dimensions may change thanks to ADJUST-ARRAY, so we need the
743 ;; conservative type.
744 (let ((array-type (lvar-conservative-type array))
745 (axis (lvar-value axis)))
746 (let ((dims (array-type-dimensions-or-give-up array-type)))
748 (give-up-ir1-transform
749 "The array dimensions are unknown; must call ARRAY-DIMENSION at runtime."))
750 (unless (> (length dims) axis)
751 (abort-ir1-transform "The array has dimensions ~S, ~W is too large."
754 (let ((dim (nth axis dims)))
755 (cond ((integerp dim)
758 (ecase (conservative-array-type-complexp array-type)
760 '(%array-dimension array 0))
762 '(vector-length array))
764 `(if (array-header-p array)
765 (%array-dimension array axis)
766 (vector-length array)))))
768 '(%array-dimension array axis)))))))
770 ;;; If the length has been declared and it's simple, just return it.
771 (deftransform length ((vector)
772 ((simple-array * (*))))
773 (let ((type (lvar-type vector)))
774 (let ((dims (array-type-dimensions-or-give-up type)))
775 (unless (and (listp dims) (integerp (car dims)))
776 (give-up-ir1-transform
777 "Vector length is unknown, must call LENGTH at runtime."))
780 ;;; All vectors can get their length by using VECTOR-LENGTH. If it's
781 ;;; simple, it will extract the length slot from the vector. It it's
782 ;;; complex, it will extract the fill pointer slot from the array
784 (deftransform length ((vector) (vector))
785 '(vector-length vector))
787 ;;; If a simple array with known dimensions, then VECTOR-LENGTH is a
788 ;;; compile-time constant.
789 (deftransform vector-length ((vector))
790 (let ((vtype (lvar-type vector)))
791 (let ((dim (first (array-type-dimensions-or-give-up vtype))))
793 (give-up-ir1-transform))
794 (when (conservative-array-type-complexp vtype)
795 (give-up-ir1-transform))
798 ;;; Again, if we can tell the results from the type, just use it.
799 ;;; Otherwise, if we know the rank, convert into a computation based
800 ;;; on array-dimension. We can wrap a TRULY-THE INDEX around the
801 ;;; multiplications because we know that the total size must be an
803 (deftransform array-total-size ((array)
805 (let ((array-type (lvar-type array)))
806 (let ((dims (array-type-dimensions-or-give-up array-type)))
808 (give-up-ir1-transform "can't tell the rank at compile time"))
810 (do ((form 1 `(truly-the index
811 (* (array-dimension array ,i) ,form)))
813 ((= i (length dims)) form))
814 (reduce #'* dims)))))
816 ;;; Only complex vectors have fill pointers.
817 (deftransform array-has-fill-pointer-p ((array))
818 (let ((array-type (lvar-type array)))
819 (let ((dims (array-type-dimensions-or-give-up array-type)))
820 (if (and (listp dims) (not (= (length dims) 1)))
822 (ecase (conservative-array-type-complexp array-type)
828 (give-up-ir1-transform
829 "The array type is ambiguous; must call ~
830 ARRAY-HAS-FILL-POINTER-P at runtime.")))))))
832 ;;; Primitive used to verify indices into arrays. If we can tell at
833 ;;; compile-time or we are generating unsafe code, don't bother with
835 (deftransform %check-bound ((array dimension index) * * :node node)
836 (cond ((policy node (= insert-array-bounds-checks 0))
838 ((not (constant-lvar-p dimension))
839 (give-up-ir1-transform))
841 (let ((dim (lvar-value dimension)))
842 ;; FIXME: Can SPEED > SAFETY weaken this check to INTEGER?
843 `(the (integer 0 (,dim)) index)))))
847 ;;; This checks to see whether the array is simple and the start and
848 ;;; end are in bounds. If so, it proceeds with those values.
849 ;;; Otherwise, it calls %WITH-ARRAY-DATA. Note that %WITH-ARRAY-DATA
850 ;;; may be further optimized.
852 ;;; Given any ARRAY, bind DATA-VAR to the array's data vector and
853 ;;; START-VAR and END-VAR to the start and end of the designated
854 ;;; portion of the data vector. SVALUE and EVALUE are any start and
855 ;;; end specified to the original operation, and are factored into the
856 ;;; bindings of START-VAR and END-VAR. OFFSET-VAR is the cumulative
857 ;;; offset of all displacements encountered, and does not include
860 ;;; When FORCE-INLINE is set, the underlying %WITH-ARRAY-DATA form is
861 ;;; forced to be inline, overriding the ordinary judgment of the
862 ;;; %WITH-ARRAY-DATA DEFTRANSFORMs. Ordinarily the DEFTRANSFORMs are
863 ;;; fairly picky about their arguments, figuring that if you haven't
864 ;;; bothered to get all your ducks in a row, you probably don't care
865 ;;; that much about speed anyway! But in some cases it makes sense to
866 ;;; do type testing inside %WITH-ARRAY-DATA instead of outside, and
867 ;;; the DEFTRANSFORM can't tell that that's going on, so it can make
868 ;;; sense to use FORCE-INLINE option in that case.
869 (def!macro with-array-data (((data-var array &key offset-var)
870 (start-var &optional (svalue 0))
871 (end-var &optional (evalue nil))
872 &key force-inline check-fill-pointer)
875 (once-only ((n-array array)
876 (n-svalue `(the index ,svalue))
877 (n-evalue `(the (or index null) ,evalue)))
878 (let ((check-bounds (policy env (plusp insert-array-bounds-checks))))
879 `(multiple-value-bind (,data-var
882 ,@(when offset-var `(,offset-var)))
883 (if (not (array-header-p ,n-array))
884 (let ((,n-array ,n-array))
885 (declare (type (simple-array * (*)) ,n-array))
886 ,(once-only ((n-len (if check-fill-pointer
888 `(array-total-size ,n-array)))
889 (n-end `(or ,n-evalue ,n-len)))
891 `(if (<= 0 ,n-svalue ,n-end ,n-len)
892 (values ,n-array ,n-svalue ,n-end 0)
893 ,(if check-fill-pointer
894 `(sequence-bounding-indices-bad-error ,n-array ,n-svalue ,n-evalue)
895 `(array-bounding-indices-bad-error ,n-array ,n-svalue ,n-evalue)))
896 `(values ,n-array ,n-svalue ,n-end 0))))
898 `(%with-array-data-macro ,n-array ,n-svalue ,n-evalue
899 :check-bounds ,check-bounds
900 :check-fill-pointer ,check-fill-pointer)
901 (if check-fill-pointer
902 `(%with-array-data/fp ,n-array ,n-svalue ,n-evalue)
903 `(%with-array-data ,n-array ,n-svalue ,n-evalue))))
906 ;;; This is the fundamental definition of %WITH-ARRAY-DATA, for use in
907 ;;; DEFTRANSFORMs and DEFUNs.
908 (def!macro %with-array-data-macro (array
915 (with-unique-names (size defaulted-end data cumulative-offset)
916 `(let* ((,size ,(if check-fill-pointer
918 `(array-total-size ,array)))
919 (,defaulted-end (or ,end ,size)))
921 `((unless (<= ,start ,defaulted-end ,size)
922 ,(if check-fill-pointer
923 `(sequence-bounding-indices-bad-error ,array ,start ,end)
924 `(array-bounding-indices-bad-error ,array ,start ,end)))))
925 (do ((,data ,array (%array-data-vector ,data))
926 (,cumulative-offset 0
927 (+ ,cumulative-offset
928 (%array-displacement ,data))))
929 ((not (array-header-p ,data))
930 (values (the (simple-array ,element-type 1) ,data)
931 (the index (+ ,cumulative-offset ,start))
932 (the index (+ ,cumulative-offset ,defaulted-end))
933 (the index ,cumulative-offset)))
934 (declare (type index ,cumulative-offset))))))
936 (defun transform-%with-array-data/muble (array node check-fill-pointer)
937 (let ((element-type (upgraded-element-type-specifier-or-give-up array))
938 (type (lvar-type array))
939 (check-bounds (policy node (plusp insert-array-bounds-checks))))
940 (if (and (array-type-p type)
941 (not (array-type-complexp type))
942 (listp (array-type-dimensions type))
943 (not (null (cdr (array-type-dimensions type)))))
944 ;; If it's a simple multidimensional array, then just return
945 ;; its data vector directly rather than going through
946 ;; %WITH-ARRAY-DATA-MACRO. SBCL doesn't generally generate
947 ;; code that would use this currently, but we have encouraged
948 ;; users to use WITH-ARRAY-DATA and we may use it ourselves at
949 ;; some point in the future for optimized libraries or
952 `(let* ((data (truly-the (simple-array ,element-type (*))
953 (%array-data-vector array)))
955 (real-end (or end len)))
956 (unless (<= 0 start data-end lend)
957 (sequence-bounding-indices-bad-error array start end))
958 (values data 0 real-end 0))
959 `(let ((data (truly-the (simple-array ,element-type (*))
960 (%array-data-vector array))))
961 (values data 0 (or end (length data)) 0)))
962 `(%with-array-data-macro array start end
963 :check-fill-pointer ,check-fill-pointer
964 :check-bounds ,check-bounds
965 :element-type ,element-type))))
967 ;; It might very well be reasonable to allow general ARRAY here, I
968 ;; just haven't tried to understand the performance issues involved.
969 ;; -- WHN, and also CSR 2002-05-26
970 (deftransform %with-array-data ((array start end)
971 ((or vector simple-array) index (or index null) t)
974 :policy (> speed space))
975 "inline non-SIMPLE-vector-handling logic"
976 (transform-%with-array-data/muble array node nil))
977 (deftransform %with-array-data/fp ((array start end)
978 ((or vector simple-array) index (or index null) t)
981 :policy (> speed space))
982 "inline non-SIMPLE-vector-handling logic"
983 (transform-%with-array-data/muble array node t))
987 ;;; We convert all typed array accessors into AREF and %ASET with type
988 ;;; assertions on the array.
989 (macrolet ((define-bit-frob (reffer setter simplep)
991 (define-source-transform ,reffer (a &rest i)
992 `(aref (the (,',(if simplep 'simple-array 'array)
994 ,(mapcar (constantly '*) i))
996 (define-source-transform ,setter (a &rest i)
997 `(%aset (the (,',(if simplep 'simple-array 'array)
999 ,(cdr (mapcar (constantly '*) i)))
1001 (define-bit-frob sbit %sbitset t)
1002 (define-bit-frob bit %bitset nil))
1003 (macrolet ((define-frob (reffer setter type)
1005 (define-source-transform ,reffer (a i)
1006 `(aref (the ,',type ,a) ,i))
1007 (define-source-transform ,setter (a i v)
1008 `(%aset (the ,',type ,a) ,i ,v)))))
1009 (define-frob svref %svset simple-vector)
1010 (define-frob schar %scharset simple-string)
1011 (define-frob char %charset string))
1013 (macrolet (;; This is a handy macro for computing the row-major index
1014 ;; given a set of indices. We wrap each index with a call
1015 ;; to %CHECK-BOUND to ensure that everything works out
1016 ;; correctly. We can wrap all the interior arithmetic with
1017 ;; TRULY-THE INDEX because we know the resultant
1018 ;; row-major index must be an index.
1019 (with-row-major-index ((array indices index &optional new-value)
1021 `(let (n-indices dims)
1022 (dotimes (i (length ,indices))
1023 (push (make-symbol (format nil "INDEX-~D" i)) n-indices)
1024 (push (make-symbol (format nil "DIM-~D" i)) dims))
1025 (setf n-indices (nreverse n-indices))
1026 (setf dims (nreverse dims))
1027 `(lambda (,',array ,@n-indices
1028 ,@',(when new-value (list new-value)))
1029 (let* (,@(let ((,index -1))
1030 (mapcar (lambda (name)
1031 `(,name (array-dimension
1038 (do* ((dims dims (cdr dims))
1039 (indices n-indices (cdr indices))
1040 (last-dim nil (car dims))
1041 (form `(%check-bound ,',array
1053 ((null (cdr dims)) form)))))
1056 ;; Just return the index after computing it.
1057 (deftransform array-row-major-index ((array &rest indices))
1058 (with-row-major-index (array indices index)
1061 ;; Convert AREF and %ASET into a HAIRY-DATA-VECTOR-REF (or
1062 ;; HAIRY-DATA-VECTOR-SET) with the set of indices replaced with the an
1063 ;; expression for the row major index.
1064 (deftransform aref ((array &rest indices))
1065 (with-row-major-index (array indices index)
1066 (hairy-data-vector-ref array index)))
1068 (deftransform %aset ((array &rest stuff))
1069 (let ((indices (butlast stuff)))
1070 (with-row-major-index (array indices index new-value)
1071 (hairy-data-vector-set array index new-value)))))
1073 ;; For AREF of vectors we do the bounds checking in the callee. This
1074 ;; lets us do a significantly more efficient check for simple-arrays
1075 ;; without bloating the code. If we already know the type of the array
1076 ;; with sufficient precision, skip directly to DATA-VECTOR-REF.
1077 (deftransform aref ((array index) (t t) * :node node)
1078 (let* ((type (lvar-type array))
1079 (element-ctype (array-type-upgraded-element-type type)))
1081 ((and (array-type-p type)
1082 (null (array-type-complexp type))
1083 (not (eql element-ctype *wild-type*))
1084 (eql (length (array-type-dimensions type)) 1))
1085 (let* ((declared-element-ctype (array-type-declared-element-type type))
1087 `(data-vector-ref array
1088 (%check-bound array (array-dimension array 0) index))))
1089 (if (type= declared-element-ctype element-ctype)
1091 `(the ,(type-specifier declared-element-ctype) ,bare-form))))
1092 ((policy node (zerop insert-array-bounds-checks))
1093 `(hairy-data-vector-ref array index))
1094 (t `(hairy-data-vector-ref/check-bounds array index)))))
1096 (deftransform %aset ((array index new-value) (t t t) * :node node)
1097 (if (policy node (zerop insert-array-bounds-checks))
1098 `(hairy-data-vector-set array index new-value)
1099 `(hairy-data-vector-set/check-bounds array index new-value)))
1101 ;;; But if we find out later that there's some useful type information
1102 ;;; available, switch back to the normal one to give other transforms
1104 (macrolet ((define (name transform-to extra extra-type)
1105 (declare (ignore extra-type))
1106 `(deftransform ,name ((array index ,@extra))
1107 (let* ((type (lvar-type array))
1108 (element-type (array-type-upgraded-element-type type))
1109 (declared-type (type-specifier
1110 (array-type-declared-element-type type))))
1111 ;; If an element type has been declared, we want to
1112 ;; use that information it for type checking (even
1113 ;; if the access can't be optimized due to the array
1114 ;; not being simple).
1115 (when (and (eql element-type *wild-type*)
1116 ;; This type logic corresponds to the special
1117 ;; case for strings in HAIRY-DATA-VECTOR-REF
1118 ;; (generic/vm-tran.lisp)
1119 (not (csubtypep type (specifier-type 'simple-string))))
1120 (when (or (not (array-type-p type))
1121 ;; If it's a simple array, we might be able
1122 ;; to inline the access completely.
1123 (not (null (array-type-complexp type))))
1124 (give-up-ir1-transform
1125 "Upgraded element type of array is not known at compile time.")))
1127 ``(truly-the ,declared-type
1128 (,',transform-to array
1130 (array-dimension array 0)
1132 (the ,declared-type ,@',extra)))
1133 ``(the ,declared-type
1134 (,',transform-to array
1136 (array-dimension array 0)
1138 (define hairy-data-vector-ref/check-bounds
1139 hairy-data-vector-ref nil nil)
1140 (define hairy-data-vector-set/check-bounds
1141 hairy-data-vector-set (new-value) (*)))
1143 ;;; Just convert into a HAIRY-DATA-VECTOR-REF (or
1144 ;;; HAIRY-DATA-VECTOR-SET) after checking that the index is inside the
1145 ;;; array total size.
1146 (deftransform row-major-aref ((array index))
1147 `(hairy-data-vector-ref array
1148 (%check-bound array (array-total-size array) index)))
1149 (deftransform %set-row-major-aref ((array index new-value))
1150 `(hairy-data-vector-set array
1151 (%check-bound array (array-total-size array) index)
1154 ;;;; bit-vector array operation canonicalization
1156 ;;;; We convert all bit-vector operations to have the result array
1157 ;;;; specified. This allows any result allocation to be open-coded,
1158 ;;;; and eliminates the need for any VM-dependent transforms to handle
1161 (macrolet ((def (fun)
1163 (deftransform ,fun ((bit-array-1 bit-array-2
1164 &optional result-bit-array)
1165 (bit-vector bit-vector &optional null) *
1166 :policy (>= speed space))
1167 `(,',fun bit-array-1 bit-array-2
1168 (make-array (array-dimension bit-array-1 0) :element-type 'bit)))
1169 ;; If result is T, make it the first arg.
1170 (deftransform ,fun ((bit-array-1 bit-array-2 result-bit-array)
1171 (bit-vector bit-vector (eql t)) *)
1172 `(,',fun bit-array-1 bit-array-2 bit-array-1)))))
1184 ;;; Similar for BIT-NOT, but there is only one arg...
1185 (deftransform bit-not ((bit-array-1 &optional result-bit-array)
1186 (bit-vector &optional null) *
1187 :policy (>= speed space))
1188 '(bit-not bit-array-1
1189 (make-array (array-dimension bit-array-1 0) :element-type 'bit)))
1190 (deftransform bit-not ((bit-array-1 result-bit-array)
1191 (bit-vector (eql t)))
1192 '(bit-not bit-array-1 bit-array-1))
1194 ;;; Pick off some constant cases.
1195 (defoptimizer (array-header-p derive-type) ((array))
1196 (let ((type (lvar-type array)))
1197 (cond ((not (array-type-p type))
1198 ;; FIXME: use analogue of ARRAY-TYPE-DIMENSIONS-OR-GIVE-UP
1201 (let ((dims (array-type-dimensions type)))
1202 (cond ((csubtypep type (specifier-type '(simple-array * (*))))
1204 (specifier-type 'null))
1205 ((and (listp dims) (/= (length dims) 1))
1206 ;; multi-dimensional array, will have a header
1207 (specifier-type '(eql t)))
1208 ((eql (array-type-complexp type) t)
1209 (specifier-type '(eql t)))