src/compiler/seqtran.lisp

   1 ;;;; optimizers for list and sequence functions
   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!C")
  13 \f
  14 ;;;; mapping onto lists: the MAPFOO functions
  15
  16 (defun mapfoo-transform (fn arglists accumulate take-car)
  17   (collect ((do-clauses)
  18             (args-to-fn)
  19             (tests))
  20     (let ((n-first (gensym)))
  21       (dolist (a (if accumulate
  22                      arglists
  23                      `(,n-first ,@(rest arglists))))
  24         (let ((v (gensym)))
  25           (do-clauses `(,v ,a (cdr ,v)))
  26           (tests `(endp ,v))
  27           (args-to-fn (if take-car `(car ,v) v))))
  28
  29       (let* ((fn-sym (gensym))  ; for ONCE-ONLY-ish purposes
  30              (call `(%funcall ,fn-sym . ,(args-to-fn)))
  31              (endtest `(or ,@(tests))))
  32
  33         `(let ((,fn-sym (%coerce-callable-to-fun ,fn)))
  34            ,(ecase accumulate
  35              (:nconc
  36               (let ((temp (gensym))
  37                     (map-result (gensym)))
  38                 `(let ((,map-result (list nil)))
  39                    (do-anonymous ((,temp ,map-result) . ,(do-clauses))
  40                      (,endtest (cdr ,map-result))
  41                      (setq ,temp (last (nconc ,temp ,call)))))))
  42              (:list
  43               (let ((temp (gensym))
  44                     (map-result (gensym)))
  45                 `(let ((,map-result (list nil)))
  46                    (do-anonymous ((,temp ,map-result) . ,(do-clauses))
  47                      (,endtest (truly-the list (cdr ,map-result)))
  48                      (rplacd ,temp (setq ,temp (list ,call)))))))
  49              ((nil)
  50               `(let ((,n-first ,(first arglists)))
  51                  (do-anonymous ,(do-clauses)
  52                    (,endtest (truly-the list ,n-first))
  53                    ,call)))))))))
  54
  55 (define-source-transform mapc (function list &rest more-lists)
  56   (mapfoo-transform function (cons list more-lists) nil t))
  57
  58 (define-source-transform mapcar (function list &rest more-lists)
  59   (mapfoo-transform function (cons list more-lists) :list t))
  60
  61 (define-source-transform mapcan (function list &rest more-lists)
  62   (mapfoo-transform function (cons list more-lists) :nconc t))
  63
  64 (define-source-transform mapl (function list &rest more-lists)
  65   (mapfoo-transform function (cons list more-lists) nil nil))
  66
  67 (define-source-transform maplist (function list &rest more-lists)
  68   (mapfoo-transform function (cons list more-lists) :list nil))
  69
  70 (define-source-transform mapcon (function list &rest more-lists)
  71   (mapfoo-transform function (cons list more-lists) :nconc nil))
  72 \f
  73 ;;;; mapping onto sequences: the MAP function
  74
  75 ;;; MAP is %MAP plus a check to make sure that any length specified in
  76 ;;; the result type matches the actual result. We also wrap it in a
  77 ;;; TRULY-THE for the most specific type we can determine.
  78 (deftransform map ((result-type-arg fun seq &rest seqs) * * :node node)
  79   (let* ((seq-names (make-gensym-list (1+ (length seqs))))
  80          (bare `(%map result-type-arg fun ,@seq-names))
  81          (constant-result-type-arg-p (constant-lvar-p result-type-arg))
  82          ;; what we know about the type of the result. (Note that the
  83          ;; "result type" argument is not necessarily the type of the
  84          ;; result, since NIL means the result has NULL type.)
  85          (result-type (if (not constant-result-type-arg-p)
  86                           'consed-sequence
  87                           (let ((result-type-arg-value
  88                                  (lvar-value result-type-arg)))
  89                             (if (null result-type-arg-value)
  90                                 'null
  91                                 result-type-arg-value)))))
  92     `(lambda (result-type-arg fun ,@seq-names)
  93        (truly-the ,result-type
  94          ,(cond ((policy node (< safety 3))
  95                  ;; ANSI requires the length-related type check only
  96                  ;; when the SAFETY quality is 3... in other cases, we
  97                  ;; skip it, because it could be expensive.
  98                  bare)
  99                 ((not constant-result-type-arg-p)
 100                  `(sequence-of-checked-length-given-type ,bare
 101                                                          result-type-arg))
 102                 (t
 103                  (let ((result-ctype (ir1-transform-specifier-type
 104                                       result-type)))
 105                    (if (array-type-p result-ctype)
 106                        (let ((dims (array-type-dimensions result-ctype)))
 107                          (unless (and (listp dims) (= (length dims) 1))
 108                            (give-up-ir1-transform "invalid sequence type"))
 109                          (let ((dim (first dims)))
 110                            (if (eq dim '*)
 111                                bare
 112                                `(vector-of-checked-length-given-length ,bare
 113                                                                        ,dim))))
 114                        ;; FIXME: this is wrong, as not all subtypes of
 115                        ;; VECTOR are ARRAY-TYPEs [consider, for
 116                        ;; example, (OR (VECTOR T 3) (VECTOR T
 117                        ;; 4))]. However, it's difficult to see what we
 118                        ;; should put here... maybe we should
 119                        ;; GIVE-UP-IR1-TRANSFORM if the type is a
 120                        ;; subtype of VECTOR but not an ARRAY-TYPE?
 121                        bare))))))))
 122
 123 ;;; Return a DO loop, mapping a function FUN to elements of
 124 ;;; sequences. SEQS is a list of lvars, SEQ-NAMES - list of variables,
 125 ;;; bound to sequences, INTO - a variable, which is used in
 126 ;;; MAP-INTO. RESULT and BODY are forms, which can use variables
 127 ;;; FUNCALL-RESULT, containing the result of application of FUN, and
 128 ;;; INDEX, containing the current position in sequences.
 129 (defun build-sequence-iterator (seqs seq-names &key result into body)
 130   (declare (type list seqs seq-names)
 131            (type symbol into))
 132   (collect ((bindings)
 133             (declarations)
 134             (vector-lengths)
 135             (tests)
 136             (places))
 137     (let ((found-vector-p nil))
 138       (flet ((process-vector (length)
 139                (unless found-vector-p
 140                  (setq found-vector-p t)
 141                  (bindings `(index 0 (1+ index)))
 142                  (declarations `(type index index)))
 143                (vector-lengths length)))
 144         (loop for seq of-type lvar in seqs
 145            for seq-name in seq-names
 146            for type = (lvar-type seq)
 147            do (cond ((csubtypep type (specifier-type 'list))
 148                      (with-unique-names (index)
 149                        (bindings `(,index ,seq-name (cdr ,index)))
 150                        (declarations `(type list ,index))
 151                        (places `(car ,index))
 152                        (tests `(endp ,index))))
 153                     ((csubtypep type (specifier-type 'vector))
 154                      (process-vector `(length ,seq-name))
 155                      (places `(locally (declare (optimize (insert-array-bounds-checks 0)))
 156                                 (aref ,seq-name index))))
 157                     (t
 158                      (give-up-ir1-transform
 159                       "can't determine sequence argument type"))))
 160         (when into
 161           (process-vector `(array-dimension ,into 0))))
 162       (when found-vector-p
 163         (bindings `(length (min ,@(vector-lengths))))
 164         (tests `(>= index length)))
 165       `(do (,@(bindings))
 166            ((or ,@(tests)) ,result)
 167          (declare ,@(declarations))
 168          (let ((funcall-result (funcall fun ,@(places))))
 169            (declare (ignorable funcall-result))
 170            ,body)))))
 171
 172 ;;; Try to compile %MAP efficiently when we can determine sequence
 173 ;;; argument types at compile time.
 174 ;;;
 175 ;;; Note: This transform was written to allow open coding of
 176 ;;; quantifiers by expressing them in terms of (MAP NIL ..). For
 177 ;;; non-NIL values of RESULT-TYPE, it's still useful, but not
 178 ;;; necessarily as efficient as possible. In particular, it will be
 179 ;;; inefficient when RESULT-TYPE is a SIMPLE-ARRAY with specialized
 180 ;;; numeric element types. It should be straightforward to make it
 181 ;;; handle that case more efficiently, but it's left as an exercise to
 182 ;;; the reader, because the code is complicated enough already and I
 183 ;;; don't happen to need that functionality right now. -- WHN 20000410
 184 (deftransform %map ((result-type fun seq &rest seqs) * *
 185                     :policy (>= speed space))
 186   "open code"
 187   (unless (constant-lvar-p result-type)
 188     (give-up-ir1-transform "RESULT-TYPE argument not constant"))
 189   (labels ( ;; 1-valued SUBTYPEP, fails unless second value of SUBTYPEP is true
 190            (fn-1subtypep (fn x y)
 191              (multiple-value-bind (subtype-p valid-p) (funcall fn x y)
 192                (if valid-p
 193                    subtype-p
 194                    (give-up-ir1-transform
 195                     "can't analyze sequence type relationship"))))
 196            (1subtypep (x y) (fn-1subtypep #'sb!xc:subtypep x y)))
 197     (let* ((result-type-value (lvar-value result-type))
 198            (result-supertype (cond ((null result-type-value) 'null)
 199                                    ((1subtypep result-type-value 'vector)
 200                                     'vector)
 201                                    ((1subtypep result-type-value 'list)
 202                                     'list)
 203                                    (t
 204                                     (give-up-ir1-transform
 205                                      "result type unsuitable")))))
 206       (cond ((and result-type-value (null seqs))
 207              ;; The consing arity-1 cases can be implemented
 208              ;; reasonably efficiently as function calls, and the cost
 209              ;; of consing should be significantly larger than
 210              ;; function call overhead, so we always compile these
 211              ;; cases as full calls regardless of speed-versus-space
 212              ;; optimization policy.
 213              (cond ((subtypep result-type-value 'list)
 214                     '(%map-to-list-arity-1 fun seq))
 215                    ( ;; (This one can be inefficient due to COERCE, but
 216                     ;; the current open-coded implementation has the
 217                     ;; same problem.)
 218                     (subtypep result-type-value 'vector)
 219                     `(coerce (%map-to-simple-vector-arity-1 fun seq)
 220                              ',result-type-value))
 221                    (t (bug "impossible (?) sequence type"))))
 222             (t
 223              (let* ((seqs (cons seq seqs))
 224                     (seq-args (make-gensym-list (length seqs))))
 225                (multiple-value-bind (push-dacc result)
 226                    (ecase result-supertype
 227                      (null (values nil nil))
 228                      (list (values `(push funcall-result acc)
 229                                    `(nreverse acc)))
 230                      (vector (values `(push funcall-result acc)
 231                                      `(coerce (nreverse acc)
 232                                               ',result-type-value))))
 233                  ;; (We use the same idiom, of returning a LAMBDA from
 234                  ;; DEFTRANSFORM, as is used in the DEFTRANSFORMs for
 235                  ;; FUNCALL and ALIEN-FUNCALL, and for the same
 236                  ;; reason: we need to get the runtime values of each
 237                  ;; of the &REST vars.)
 238                  `(lambda (result-type fun ,@seq-args)
 239                     (declare (ignore result-type))
 240                     (let ((fun (%coerce-callable-to-fun fun))
 241                           (acc nil))
 242                       (declare (type list acc))
 243                       (declare (ignorable acc))
 244                       ,(build-sequence-iterator
 245                         seqs seq-args
 246                         :result result
 247                         :body push-dacc))))))))))
 248
 249 ;;; MAP-INTO
 250 (deftransform map-into ((result fun &rest seqs)
 251                         (vector * &rest *)
 252                         *)
 253   "open code"
 254   (let ((seqs-names (mapcar (lambda (x)
 255                               (declare (ignore x))
 256                               (gensym))
 257                             seqs)))
 258     `(lambda (result fun ,@seqs-names)
 259        ,(build-sequence-iterator
 260          seqs seqs-names
 261          :result '(when (array-has-fill-pointer-p result)
 262                    (setf (fill-pointer result) index))
 263          :into 'result
 264          :body '(locally (declare (optimize (insert-array-bounds-checks 0)))
 265                  (setf (aref result index) funcall-result)))
 266        result)))
 267
 268 \f
 269 ;;; FIXME: once the confusion over doing transforms with known-complex
 270 ;;; arrays is over, we should also transform the calls to (AND (ARRAY
 271 ;;; * (*)) (NOT (SIMPLE-ARRAY * (*)))) objects.
 272 (deftransform elt ((s i) ((simple-array * (*)) *) *)
 273   '(aref s i))
 274
 275 (deftransform elt ((s i) (list *) * :policy (< safety 3))
 276   '(nth i s))
 277
 278 (deftransform %setelt ((s i v) ((simple-array * (*)) * *) *)
 279   '(%aset s i v))
 280
 281 (deftransform %setelt ((s i v) (list * *) * :policy (< safety 3))
 282   '(setf (car (nthcdr i s)) v))
 283
 284 (deftransform %check-vector-sequence-bounds ((vector start end)
 285                                              (vector * *) *
 286                                              :node node)
 287   (if (policy node (= 0 insert-array-bounds-checks))
 288       '(or end (length vector))
 289       '(let ((length (length vector)))
 290          (if (<= 0 start (or end length) length)
 291              (or end length)
 292              (sequence-bounding-indices-bad-error vector start end)))))
 293
 294 (deftype eq-comparable-type ()
 295   '(or fixnum (not number)))
 296
 297 ;;; True if EQL comparisons involving type can be simplified to EQ.
 298 (defun eq-comparable-type-p (type)
 299   (csubtypep type (specifier-type 'eq-comparable-type)))
 300
 301 (defun specialized-list-seek-function-name (function-name key-functions &optional variant)
 302   (or (find-symbol (with-output-to-string (s)
 303                      ;; Write "%NAME-FUN1-FUN2-FUN3", etc. Not only is
 304                      ;; this ever so slightly faster then FORMAT, this
 305                      ;; way we are also proof against *PRINT-CASE*
 306                      ;; frobbing and such.
 307                      (write-char #\% s)
 308                      (write-string (symbol-name function-name) s)
 309                      (dolist (f key-functions)
 310                        (write-char #\- s)
 311                        (write-string (symbol-name f) s))
 312                      (when variant
 313                        (write-char #\- s)
 314                        (write-string (symbol-name variant) s)))
 315                    (load-time-value (find-package "SB!KERNEL")))
 316       (bug "Unknown list item seek transform: name=~S, key-functions=~S variant=~S"
 317            function-name key-functions variant)))
 318
 319 (defun transform-list-item-seek (name item list key test test-not node)
 320   ;; If TEST is EQL, drop it.
 321   (when (and test (lvar-fun-is test '(eql)))
 322     (setf test nil))
 323   ;; Ditto for KEY IDENTITY.
 324   (when (and key (lvar-fun-is key '(identity)))
 325     (setf key nil))
 326   ;; Key can legally be NIL, but if it's NIL for sure we pretend it's
 327   ;; not there at all. If it might be NIL, make up a form to that
 328   ;; ensures it is a function.
 329   (multiple-value-bind (key key-form)
 330       (when key
 331         (let ((key-type (lvar-type key))
 332               (null-type (specifier-type 'null)))
 333           (cond ((csubtypep key-type null-type)
 334                  (values nil nil))
 335                 ((csubtypep null-type key-type)
 336                  (values key '(if key
 337                                (%coerce-callable-to-fun key)
 338                                #'identity)))
 339                 (t
 340                  (values key (ensure-lvar-fun-form key 'key))))))
 341     (let* ((c-test (cond ((and test (lvar-fun-is test '(eq)))
 342                           (setf test nil)
 343                           'eq)
 344                          ((and (not test) (not test-not))
 345                           (when (eq-comparable-type-p (lvar-type item))
 346                             'eq))))
 347            (funs (delete nil (list (when key (list key 'key))
 348                                    (when test (list test 'test))
 349                                    (when test-not (list test-not 'test-not)))))
 350            (target-expr (if key '(%funcall key target) 'target))
 351            (test-expr (cond (test `(%funcall test item ,target-expr))
 352                             (test-not `(not (%funcall test-not item ,target-expr)))
 353                             (c-test `(,c-test item ,target-expr))
 354                             (t `(eql item ,target-expr)))))
 355       (labels ((open-code (tail)
 356                  (when tail
 357                    `(if (let ((this ',(car tail)))
 358                           ,(ecase name
 359                                   ((assoc rassoc)
 360                                    (let ((cxx (if (eq name 'assoc) 'car 'cdr)))
 361                                      `(and this (let ((target (,cxx this)))
 362                                                   ,test-expr))))
 363                                   (member
 364                                    `(let ((target this))
 365                                       ,test-expr))))
 366                         ',(ecase name
 367                                  ((assoc rassoc) (car tail))
 368                                  (member tail))
 369                         ,(open-code (cdr tail)))))
 370                (ensure-fun (args)
 371                  (if (eq 'key (second args))
 372                      key-form
 373                      (apply #'ensure-lvar-fun-form args))))
 374         (let* ((cp (constant-lvar-p list))
 375                (c-list (when cp (lvar-value list))))
 376           (cond ((and cp c-list (member name '(assoc rassoc member))
 377                       (policy node (>= speed space)))
 378                  `(let ,(mapcar (lambda (fun) `(,(second fun) ,(ensure-fun fun))) funs)
 379                     ,(open-code c-list)))
 380                 ((and cp (not c-list))
 381                  ;; constant nil list
 382                  (if (eq name 'adjoin)
 383                      '(list item)
 384                      nil))
 385                 (t
 386                  ;; specialized out-of-line version
 387                  `(,(specialized-list-seek-function-name name (mapcar #'second funs) c-test)
 388                     item list ,@(mapcar #'ensure-fun funs)))))))))
 389
 390 (defun transform-list-pred-seek (name pred list key node)
 391   ;; If KEY is IDENTITY, drop it.
 392   (when (and key (lvar-fun-is key '(identity)))
 393     (setf key nil))
 394   ;; Key can legally be NIL, but if it's NIL for sure we pretend it's
 395   ;; not there at all. If it might be NIL, make up a form to that
 396   ;; ensures it is a function.
 397   (multiple-value-bind (key key-form)
 398       (when key
 399         (let ((key-type (lvar-type key))
 400               (null-type (specifier-type 'null)))
 401           (cond ((csubtypep key-type null-type)
 402                  (values nil nil))
 403                 ((csubtypep null-type key-type)
 404                  (values key '(if key
 405                                (%coerce-callable-to-fun key)
 406                                #'identity)))
 407                 (t
 408                  (values key (ensure-lvar-fun-form key 'key))))))
 409     (let ((test-expr `(%funcall pred ,(if key '(%funcall key target) 'target)))
 410           (pred-expr (ensure-lvar-fun-form pred 'pred)))
 411       (when (member name '(member-if-not assoc-if-not rassoc-if-not))
 412         (setf test-expr `(not ,test-expr)))
 413       (labels ((open-code (tail)
 414                  (when tail
 415                    `(if (let ((this ',(car tail)))
 416                           ,(ecase name
 417                                   ((assoc-if assoc-if-not rassoc-if rassoc-if-not)
 418                                    (let ((cxx (if (member name '(assoc-if assoc-if-not)) 'car 'cdr)))
 419                                      `(and this (let ((target (,cxx this)))
 420                                                   ,test-expr))))
 421                                   ((member-if member-if-not)
 422                                    `(let ((target this))
 423                                       ,test-expr))))
 424                         ',(ecase name
 425                                  ((assoc-if assoc-if-not rassoc-if rassoc-if-not)
 426                                   (car tail))
 427                                  ((member-if member-if-not)
 428                                   tail))
 429                         ,(open-code (cdr tail))))))
 430         (let* ((cp (constant-lvar-p list))
 431                (c-list (when cp (lvar-value list))))
 432           (cond ((and cp c-list (policy node (>= speed space)))
 433                  `(let ((pred ,pred-expr)
 434                         ,@(when key `((key ,key-form))))
 435                     ,(open-code c-list)))
 436                 ((and cp (not c-list))
 437                  ;; constant nil list -- nothing to find!
 438                  nil)
 439                 (t
 440                  ;; specialized out-of-line version
 441                  `(,(specialized-list-seek-function-name name (when key '(key)))
 442                     ,pred-expr list ,@(when key (list key-form))))))))))
 443
 444 (macrolet ((def (name &optional if/if-not)
 445              (let ((basic (symbolicate "%" name))
 446                    (basic-eq (symbolicate "%" name "-EQ"))
 447                    (basic-key (symbolicate "%" name "-KEY"))
 448                    (basic-key-eq (symbolicate "%" name "-KEY-EQ")))
 449                `(progn
 450                   (deftransform ,name ((item list &key key test test-not) * * :node node)
 451                     (transform-list-item-seek ',name item list key test test-not node))
 452                   (deftransform ,basic ((item list) (eq-comparable-type t))
 453                     `(,',basic-eq item list))
 454                   (deftransform ,basic-key ((item list) (eq-comparable-type t))
 455                     `(,',basic-key-eq item list))
 456                   ,@(when if/if-not
 457                           (let ((if-name (symbolicate name "-IF"))
 458                                 (if-not-name (symbolicate name "-IF-NOT")))
 459                             `((deftransform ,if-name ((pred list &key key) * * :node node)
 460                                 (transform-list-pred-seek ',if-name pred list key node))
 461                               (deftransform ,if-not-name ((pred list &key key) * * :node node)
 462                                 (transform-list-pred-seek ',if-not-name pred list key node)))))))))
 463   (def adjoin)
 464   (def assoc  t)
 465   (def member t)
 466   (def rassoc t))
 467
 468 (deftransform memq ((item list) (t (constant-arg list)))
 469   (labels ((rec (tail)
 470              (if tail
 471                  `(if (eq item ',(car tail))
 472                       ',tail
 473                       ,(rec (cdr tail)))
 474                  nil)))
 475     (rec (lvar-value list))))
 476
 477 ;;; A similar transform used to apply to MEMBER and ASSOC, but since
 478 ;;; TRANSFORM-LIST-ITEM-SEEK now takes care of them those transform
 479 ;;; would never fire, and (%MEMBER-TEST ITEM LIST #'EQ) should be
 480 ;;; almost as fast as MEMQ.
 481 (deftransform delete ((item list &key test) (t list &rest t) *)
 482   "convert to EQ test"
 483   ;; FIXME: The scope of this transformation could be
 484   ;; widened somewhat, letting it work whenever the test is
 485   ;; 'EQL and we know from the type of ITEM that it #'EQ
 486   ;; works like #'EQL on it. (E.g. types FIXNUM, CHARACTER,
 487   ;; and SYMBOL.)
 488   ;;   If TEST is EQ, apply transform, else
 489   ;;   if test is not EQL, then give up on transform, else
 490   ;;   if ITEM is not a NUMBER or is a FIXNUM, apply
 491   ;;   transform, else give up on transform.
 492   (cond (test
 493          (unless (lvar-fun-is test '(eq))
 494            (give-up-ir1-transform)))
 495         ((types-equal-or-intersect (lvar-type item)
 496                                    (specifier-type 'number))
 497          (give-up-ir1-transform "Item might be a number.")))
 498   `(delq item list))
 499
 500 (deftransform delete-if ((pred list) (t list))
 501   "open code"
 502   '(do ((x list (cdr x))
 503         (splice '()))
 504        ((endp x) list)
 505      (cond ((funcall pred (car x))
 506             (if (null splice)
 507                 (setq list (cdr x))
 508                 (rplacd splice (cdr x))))
 509            (t (setq splice x)))))
 510
 511 (deftransform fill ((seq item &key (start 0) (end nil))
 512                     (list t &key (:start t) (:end t)))
 513   '(list-fill* seq item start end))
 514
 515 (deftransform fill ((seq item &key (start 0) (end nil))
 516                     (vector t &key (:start t) (:end t))
 517                     *
 518                     :node node)
 519   (let* ((element-ctype (extract-upgraded-element-type seq))
 520          (element-type (type-specifier element-ctype))
 521          (type (lvar-type seq))
 522          (saetp (unless (eq *wild-type* element-ctype)
 523                   (find-saetp-by-ctype element-ctype))))
 524     (cond ((eq *wild-type* element-ctype)
 525            (delay-ir1-transform node :constraint)
 526            `(vector-fill* seq item start end))
 527           ((and saetp (sb!vm::valid-bit-bash-saetp-p saetp))
 528            (let* ((n-bits (sb!vm:saetp-n-bits saetp))
 529                   (basher-name (format nil "UB~D-BASH-FILL" n-bits))
 530                   (basher (or (find-symbol basher-name
 531                                            (load-time-value (find-package :sb!kernel)))
 532                               (abort-ir1-transform
 533                                "Unknown fill basher, please report to sbcl-devel: ~A"
 534                                basher-name)))
 535                   (kind (cond ((sb!vm:saetp-fixnum-p saetp) :tagged)
 536                               ((member element-type '(character base-char)) :char)
 537                               ((eq element-type 'single-float) :single-float)
 538                               #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 539                               ((eq element-type 'double-float) :double-float)
 540                               #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 541                               ((equal element-type '(complex single-float))
 542                                :complex-single-float)
 543                               (t
 544                                (aver (integer-type-p element-ctype))
 545                                :bits)))
 546                   ;; BASH-VALUE is a word that we can repeatedly smash
 547                   ;; on the array: for less-than-word sized elements it
 548                   ;; contains multiple copies of the fill item.
 549                   (bash-value
 550                    (if (constant-lvar-p item)
 551                        (let ((tmp (lvar-value item)))
 552                          (unless (ctypep tmp element-ctype)
 553                            (abort-ir1-transform "~S is not ~S" tmp element-type))
 554                          (let* ((bits
 555                                  (ldb (byte n-bits 0)
 556                                       (ecase kind
 557                                         (:tagged
 558                                          (ash tmp sb!vm:n-fixnum-tag-bits))
 559                                         (:char
 560                                          (char-code tmp))
 561                                         (:bits
 562                                          tmp)
 563                                         (:single-float
 564                                          (single-float-bits tmp))
 565                                         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 566                                         (:double-float
 567                                          (logior (ash (double-float-high-bits tmp) 32)
 568                                                  (double-float-low-bits tmp)))
 569                                         #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 570                                         (:complex-single-float
 571                                          (logior (ash (single-float-bits (imagpart tmp)) 32)
 572                                                  (ldb (byte 32 0)
 573                                                       (single-float-bits (realpart tmp))))))))
 574                                 (res bits))
 575                            (loop for i of-type sb!vm:word from n-bits by n-bits
 576                                  until (= i sb!vm:n-word-bits)
 577                                  do (setf res (ldb (byte sb!vm:n-word-bits 0)
 578                                                    (logior res (ash bits i)))))
 579                            res))
 580                        (progn
 581                          (delay-ir1-transform node :constraint)
 582                         `(let* ((bits (ldb (byte ,n-bits 0)
 583                                            ,(ecase kind
 584                                                    (:tagged
 585                                                     `(ash item ,sb!vm:n-fixnum-tag-bits))
 586                                                    (:char
 587                                                     `(char-code item))
 588                                                    (:bits
 589                                                     `item)
 590                                                    (:single-float
 591                                                     `(single-float-bits item))
 592                                                    #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 593                                                    (:double-float
 594                                                     `(logior (ash (double-float-high-bits item) 32)
 595                                                              (double-float-low-bits item)))
 596                                                    #!+#.(cl:if (cl:= 64 sb!vm:n-word-bits) '(and) '(or))
 597                                                    (:complex-single-float
 598                                                     `(logior (ash (single-float-bits (imagpart item)) 32)
 599                                                              (ldb (byte 32 0)
 600                                                                   (single-float-bits (realpart item))))))))
 601                                 (res bits))
 602                            (declare (type sb!vm:word res))
 603                            ,@(unless (= sb!vm:n-word-bits n-bits)
 604                                      `((loop for i of-type sb!vm:word from ,n-bits by ,n-bits
 605                                              until (= i sb!vm:n-word-bits)
 606                                              do (setf res
 607                                                       (ldb (byte ,sb!vm:n-word-bits 0)
 608                                                            (logior res (ash bits (truly-the (integer 0 ,(- sb!vm:n-word-bits n-bits)) i))))))))
 609                            res)))))
 610              (values
 611               `(with-array-data ((data seq)
 612                                  (start start)
 613                                  (end end)
 614                                  :check-fill-pointer t)
 615                  (declare (type (simple-array ,element-type 1) data))
 616                  (declare (type index start end))
 617                  (declare (optimize (safety 0) (speed 3))
 618                           (muffle-conditions compiler-note))
 619                  (,basher ,bash-value data start (- end start))
 620                  seq)
 621               `((declare (type ,element-type item))))))
 622           ((policy node (> speed space))
 623            (values
 624             `(with-array-data ((data seq)
 625                                (start start)
 626                                (end end)
 627                                :check-fill-pointer t)
 628                (declare (type (simple-array ,element-type 1) data))
 629                (declare (type index start end))
 630                ;; WITH-ARRAY-DATA did our range checks once and for all, so
 631                ;; it'd be wasteful to check again on every AREF...
 632                (declare (optimize (safety 0) (speed 3)))
 633                (do ((i start (1+ i)))
 634                    ((= i end) seq)
 635                  (declare (type index i))
 636                  (setf (aref data i) item)))
 637             ;; ... though we still need to check that the new element can fit
 638             ;; into the vector in safe code. -- CSR, 2002-07-05
 639             `((declare (type ,element-type item)))))
 640           ((csubtypep type (specifier-type 'string))
 641            '(string-fill* seq item start end))
 642           (t
 643            '(vector-fill* seq item start end)))))
 644
 645 (deftransform fill ((seq item &key (start 0) (end nil))
 646                     ((and sequence (not vector) (not list)) t &key (:start t) (:end t)))
 647   `(sb!sequence:fill seq item
 648                      :start start
 649                      :end (%check-generic-sequence-bounds seq start end)))
 650 \f
 651 ;;;; hairy sequence transforms
 652
 653 ;;; FIXME: no hairy sequence transforms in SBCL?
 654 ;;;
 655 ;;; There used to be a bunch of commented out code about here,
 656 ;;; containing the (apparent) beginning of hairy sequence transform
 657 ;;; infrastructure. People interested in implementing better sequence
 658 ;;; transforms might want to look at it for inspiration, even though
 659 ;;; the actual code is ancient CMUCL -- and hence bitrotted. The code
 660 ;;; was deleted in 1.0.7.23.
 661 \f
 662 ;;;; string operations
 663
 664 ;;; We transform the case-sensitive string predicates into a non-keyword
 665 ;;; version. This is an IR1 transform so that we don't have to worry about
 666 ;;; changing the order of evaluation.
 667 (macrolet ((def (fun pred*)
 668              `(deftransform ,fun ((string1 string2 &key (start1 0) end1
 669                                                          (start2 0) end2)
 670                                    * *)
 671                 `(,',pred* string1 string2 start1 end1 start2 end2))))
 672   (def string< string<*)
 673   (def string> string>*)
 674   (def string<= string<=*)
 675   (def string>= string>=*)
 676   (def string= string=*)
 677   (def string/= string/=*))
 678
 679 ;;; Return a form that tests the free variables STRING1 and STRING2
 680 ;;; for the ordering relationship specified by LESSP and EQUALP. The
 681 ;;; start and end are also gotten from the environment. Both strings
 682 ;;; must be SIMPLE-BASE-STRINGs.
 683 (macrolet ((def (name lessp equalp)
 684              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 685                                    (simple-base-string simple-base-string t t t t) *)
 686                 `(let* ((end1 (if (not end1) (length string1) end1))
 687                         (end2 (if (not end2) (length string2) end2))
 688                         (index (sb!impl::%sp-string-compare
 689                                 string1 start1 end1 string2 start2 end2)))
 690                   (if index
 691                       (cond ((= index end1)
 692                              ,(if ',lessp 'index nil))
 693                             ((= (+ index (- start2 start1)) end2)
 694                              ,(if ',lessp nil 'index))
 695                             ((,(if ',lessp 'char< 'char>)
 696                                (schar string1 index)
 697                                (schar string2
 698                                       (truly-the index
 699                                                  (+ index
 700                                                     (truly-the fixnum
 701                                                                (- start2
 702                                                                   start1))))))
 703                              index)
 704                             (t nil))
 705                       ,(if ',equalp 'end1 nil))))))
 706   (def string<* t nil)
 707   (def string<=* t t)
 708   (def string>* nil nil)
 709   (def string>=* nil t))
 710
 711 (macrolet ((def (name result-fun)
 712              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 713                                    (simple-base-string simple-base-string t t t t) *)
 714                 `(,',result-fun
 715                   (sb!impl::%sp-string-compare
 716                    string1 start1 (or end1 (length string1))
 717                    string2 start2 (or end2 (length string2)))))))
 718   (def string=* not)
 719   (def string/=* identity))
 720
 721 \f
 722 ;;;; transforms for sequence functions
 723
 724 ;;; Moved here from generic/vm-tran.lisp to satisfy clisp.  Only applies
 725 ;;; to vectors based on simple arrays.
 726 (def!constant vector-data-bit-offset
 727   (* sb!vm:vector-data-offset sb!vm:n-word-bits))
 728
 729 ;;; FIXME: In the copy loops below, we code the loops in a strange
 730 ;;; fashion:
 731 ;;;
 732 ;;; (do ((i (+ src-offset length) (1- i)))
 733 ;;;     ((<= i 0) ...)
 734 ;;;   (... (aref foo (1- i)) ...))
 735 ;;;
 736 ;;; rather than the more natural (and seemingly more efficient):
 737 ;;;
 738 ;;; (do ((i (1- (+ src-offset length)) (1- i)))
 739 ;;;     ((< i 0) ...)
 740 ;;;   (... (aref foo i) ...))
 741 ;;;
 742 ;;; (more efficient because we don't have to do the index adjusting on
 743 ;;; every iteration of the loop)
 744 ;;;
 745 ;;; We do this to avoid a suboptimality in SBCL's backend.  In the
 746 ;;; latter case, the backend thinks I is a FIXNUM (which it is), but
 747 ;;; when used as an array index, the backend thinks I is a
 748 ;;; POSITIVE-FIXNUM (which it is).  However, since the backend thinks of
 749 ;;; these as distinct storage classes, it cannot coerce a move from a
 750 ;;; FIXNUM TN to a POSITIVE-FIXNUM TN.  The practical effect of this
 751 ;;; deficiency is that we have two extra moves and increased register
 752 ;;; pressure, which can lead to some spectacularly bad register
 753 ;;; allocation.  (sub-FIXME: the register allocation even with the
 754 ;;; strangely written loops is not always excellent, either...).  Doing
 755 ;;; it the first way, above, means that I is always thought of as a
 756 ;;; POSITIVE-FIXNUM and there are no issues.
 757 ;;;
 758 ;;; Besides, the *-WITH-OFFSET machinery will fold those index
 759 ;;; adjustments in the first version into the array addressing at no
 760 ;;; performance penalty!
 761
 762 ;;; This transform is critical to the performance of string streams.  If
 763 ;;; you tweak it, make sure that you compare the disassembly, if not the
 764 ;;; performance of, the functions implementing string streams
 765 ;;; (e.g. SB!IMPL::STRING-OUCH).
 766 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
 767   (defun make-replace-transform (saetp sequence-type1 sequence-type2)
 768     `(deftransform replace ((seq1 seq2 &key (start1 0) (start2 0) end1 end2)
 769                             (,sequence-type1 ,sequence-type2 &rest t)
 770                             ,sequence-type1
 771                             :node node)
 772        `(let* ((len1 (length seq1))
 773                (len2 (length seq2))
 774                (end1 (or end1 len1))
 775                (end2 (or end2 len2))
 776                (replace-len (min (- end1 start1) (- end2 start2))))
 777           ,(unless (policy node (= safety 0))
 778              `(progn
 779                 (unless (<= 0 start1 end1 len1)
 780                   (sequence-bounding-indices-bad-error seq1 start1 end1))
 781                 (unless (<= 0 start2 end2 len2)
 782                   (sequence-bounding-indices-bad-error seq2 start2 end2))))
 783           ,',(cond
 784                ((and saetp (sb!vm:valid-bit-bash-saetp-p saetp))
 785                 (let* ((n-element-bits (sb!vm:saetp-n-bits saetp))
 786                        (bash-function (intern (format nil "UB~D-BASH-COPY"
 787                                                       n-element-bits)
 788                                               (find-package "SB!KERNEL"))))
 789                   `(funcall (function ,bash-function) seq2 start2
 790                     seq1 start1 replace-len)))
 791                (t
 792                 `(if (and
 793                       ;; If the sequence types are different, SEQ1 and
 794                       ;; SEQ2 must be distinct arrays.
 795                       ,(eql sequence-type1 sequence-type2)
 796                       (eq seq1 seq2) (> start1 start2))
 797                      (do ((i (truly-the index (+ start1 replace-len -1))
 798                              (1- i))
 799                           (j (truly-the index (+ start2 replace-len -1))
 800                              (1- j)))
 801                          ((< i start1))
 802                        (declare (optimize (insert-array-bounds-checks 0)))
 803                        (setf (aref seq1 i) (aref seq2 j)))
 804                      (do ((i start1 (1+ i))
 805                           (j start2 (1+ j))
 806                           (end (+ start1 replace-len)))
 807                          ((>= i end))
 808                        (declare (optimize (insert-array-bounds-checks 0)))
 809                        (setf (aref seq1 i) (aref seq2 j))))))
 810           seq1))))
 811
 812 (macrolet
 813     ((define-replace-transforms ()
 814        (loop for saetp across sb!vm:*specialized-array-element-type-properties*
 815              for sequence-type = `(simple-array ,(sb!vm:saetp-specifier saetp) (*))
 816              unless (= (sb!vm:saetp-typecode saetp) sb!vm::simple-array-nil-widetag)
 817              collect (make-replace-transform saetp sequence-type sequence-type)
 818              into forms
 819              finally (return `(progn ,@forms))))
 820      (define-one-transform (sequence-type1 sequence-type2)
 821        (make-replace-transform nil sequence-type1 sequence-type2)))
 822   (define-replace-transforms)
 823   #!+sb-unicode
 824   (progn
 825    (define-one-transform (simple-array base-char (*)) (simple-array character (*)))
 826    (define-one-transform (simple-array character (*)) (simple-array base-char (*)))))
 827
 828 ;;; Expand simple cases of UB<SIZE>-BASH-COPY inline.  "simple" is
 829 ;;; defined as those cases where we are doing word-aligned copies from
 830 ;;; both the source and the destination and we are copying from the same
 831 ;;; offset from both the source and the destination.  (The last
 832 ;;; condition is there so we can determine the direction to copy at
 833 ;;; compile time rather than runtime.  Remember that UB<SIZE>-BASH-COPY
 834 ;;; acts like memmove, not memcpy.)  These conditions may seem rather
 835 ;;; restrictive, but they do catch common cases, like allocating a (* 2
 836 ;;; N)-size buffer and blitting in the old N-size buffer in.
 837
 838 (defun frob-bash-transform (src src-offset
 839                             dst dst-offset
 840                             length n-elems-per-word)
 841   (declare (ignore src dst length))
 842   (let ((n-bits-per-elem (truncate sb!vm:n-word-bits n-elems-per-word)))
 843     (multiple-value-bind (src-word src-elt)
 844         (truncate (lvar-value src-offset) n-elems-per-word)
 845       (multiple-value-bind (dst-word dst-elt)
 846           (truncate (lvar-value dst-offset) n-elems-per-word)
 847         ;; Avoid non-word aligned copies.
 848         (unless (and (zerop src-elt) (zerop dst-elt))
 849           (give-up-ir1-transform))
 850         ;; Avoid copies where we would have to insert code for
 851         ;; determining the direction of copying.
 852         (unless (= src-word dst-word)
 853           (give-up-ir1-transform))
 854         ;; FIXME: The cross-compiler doesn't optimize TRUNCATE properly,
 855         ;; so we have to do its work here.
 856         `(let ((end (+ ,src-word ,(if (= n-elems-per-word 1)
 857                                       'length
 858                                       `(truncate (the index length) ,n-elems-per-word)))))
 859            (declare (type index end))
 860            ;; Handle any bits at the end.
 861            (when (logtest length (1- ,n-elems-per-word))
 862              (let* ((extra (mod length ,n-elems-per-word))
 863                     ;; FIXME: The shift amount on this ASH is
 864                     ;; *always* negative, but the backend doesn't
 865                     ;; have a NEGATIVE-FIXNUM primitive type, so we
 866                     ;; wind up with a pile of code that tests the
 867                     ;; sign of the shift count prior to shifting when
 868                     ;; all we need is a simple negate and shift
 869                     ;; right.  Yuck.
 870                     (mask (ash #.(1- (ash 1 sb!vm:n-word-bits))
 871                                (* (- extra ,n-elems-per-word)
 872                                   ,n-bits-per-elem))))
 873                (setf (sb!kernel:%vector-raw-bits dst end)
 874                      (logior
 875                       (logandc2 (sb!kernel:%vector-raw-bits dst end)
 876                                 (ash mask
 877                                      ,(ecase sb!c:*backend-byte-order*
 878                                              (:little-endian 0)
 879                                              (:big-endian `(* (- ,n-elems-per-word extra)
 880                                                               ,n-bits-per-elem)))))
 881                       (logand (sb!kernel:%vector-raw-bits src end)
 882                               (ash mask
 883                                    ,(ecase sb!c:*backend-byte-order*
 884                                            (:little-endian 0)
 885                                            (:big-endian `(* (- ,n-elems-per-word extra)
 886                                                             ,n-bits-per-elem)))))))))
 887            ;; Copy from the end to save a register.
 888            (do ((i end (1- i)))
 889                ((<= i ,src-word))
 890              (setf (sb!kernel:%vector-raw-bits dst (1- i))
 891                    (sb!kernel:%vector-raw-bits src (1- i))))
 892            (values))))))
 893
 894 #.(loop for i = 1 then (* i 2)
 895         collect `(deftransform ,(intern (format nil "UB~D-BASH-COPY" i)
 896                                         "SB!KERNEL")
 897                                                         ((src src-offset
 898                                                           dst dst-offset
 899                                                           length)
 900                                                         ((simple-unboxed-array (*))
 901                                                          (constant-arg index)
 902                                                          (simple-unboxed-array (*))
 903                                                          (constant-arg index)
 904                                                          index)
 905                                                         *)
 906                   (frob-bash-transform src src-offset
 907                                        dst dst-offset length
 908                                        ,(truncate sb!vm:n-word-bits i))) into forms
 909         until (= i sb!vm:n-word-bits)
 910         finally (return `(progn ,@forms)))
 911
 912 ;;; We expand copy loops inline in SUBSEQ and COPY-SEQ if we're copying
 913 ;;; arrays with elements of size >= the word size.  We do this because
 914 ;;; we know the arrays cannot alias (one was just consed), therefore we
 915 ;;; can determine at compile time the direction to copy, and for
 916 ;;; word-sized elements, UB<WORD-SIZE>-BASH-COPY will do a bit of
 917 ;;; needless checking to figure out what's going on.  The same
 918 ;;; considerations apply if we are copying elements larger than the word
 919 ;;; size, with the additional twist that doing it inline is likely to
 920 ;;; cons far less than calling REPLACE and letting generic code do the
 921 ;;; work.
 922 ;;;
 923 ;;; However, we do not do this for elements whose size is < than the
 924 ;;; word size because we don't want to deal with any alignment issues
 925 ;;; inline.  The UB*-BASH-COPY transforms might fix things up later
 926 ;;; anyway.
 927
 928 (defun maybe-expand-copy-loop-inline (src src-offset dst dst-offset length
 929                                       element-type)
 930   (let ((saetp (find-saetp element-type)))
 931     (aver saetp)
 932     (if (>= (sb!vm:saetp-n-bits saetp) sb!vm:n-word-bits)
 933         (expand-aref-copy-loop src src-offset dst dst-offset length)
 934         `(locally (declare (optimize (safety 0)))
 935            (replace ,dst ,src :start1 ,dst-offset :start2 ,src-offset :end1 ,length)))))
 936
 937 (defun expand-aref-copy-loop (src src-offset dst dst-offset length)
 938   (if (eql src-offset dst-offset)
 939       `(do ((i (+ ,src-offset ,length) (1- i)))
 940            ((<= i ,src-offset))
 941          (declare (optimize (insert-array-bounds-checks 0)))
 942          (setf (aref ,dst (1- i)) (aref ,src (1- i))))
 943       ;; KLUDGE: The compiler is not able to derive that (+ offset
 944       ;; length) must be a fixnum, but arrives at (unsigned-byte 29).
 945       ;; We, however, know it must be so, as by this point the bounds
 946       ;; have already been checked.
 947       `(do ((i (truly-the fixnum (+ ,src-offset ,length)) (1- i))
 948             (j (+ ,dst-offset ,length) (1- j)))
 949            ((<= i ,src-offset))
 950          (declare (optimize (insert-array-bounds-checks 0))
 951                   (type (integer 0 #.sb!xc:array-dimension-limit) j i))
 952          (setf (aref ,dst (1- j)) (aref ,src (1- i))))))
 953
 954 ;;; SUBSEQ, COPY-SEQ
 955
 956 (deftransform subseq ((seq start &optional end)
 957                       (vector t &optional t)
 958                       *
 959                       :node node)
 960   (let ((type (lvar-type seq)))
 961     (cond
 962       ((and (array-type-p type)
 963             (csubtypep type (specifier-type '(or (simple-unboxed-array (*)) simple-vector))))
 964        (let ((element-type (type-specifier (array-type-specialized-element-type type))))
 965          `(let* ((length (length seq))
 966                  (end (or end length)))
 967             ,(unless (policy node (zerop insert-array-bounds-checks))
 968                      '(progn
 969                        (unless (<= 0 start end length)
 970                          (sequence-bounding-indices-bad-error seq start end))))
 971             (let* ((size (- end start))
 972                    (result (make-array size :element-type ',element-type)))
 973               ,(maybe-expand-copy-loop-inline 'seq (if (constant-lvar-p start)
 974                                                        (lvar-value start)
 975                                                        'start)
 976                                               'result 0 'size element-type)
 977               result))))
 978       ((csubtypep type (specifier-type 'string))
 979        '(string-subseq* seq start end))
 980       (t
 981        '(vector-subseq* seq start end)))))
 982
 983 (deftransform subseq ((seq start &optional end)
 984                       (list t &optional t))
 985   `(list-subseq* seq start end))
 986
 987 (deftransform subseq ((seq start &optional end)
 988                       ((and sequence (not vector) (not list)) t &optional t))
 989   '(sb!sequence:subseq seq start end))
 990
 991 (deftransform copy-seq ((seq) (vector))
 992   (let ((type (lvar-type seq)))
 993     (cond ((and (array-type-p type)
 994                 (csubtypep type (specifier-type '(or (simple-unboxed-array (*)) simple-vector))))
 995            (let ((element-type (type-specifier (array-type-specialized-element-type type))))
 996              `(let* ((length (length seq))
 997                      (result (make-array length :element-type ',element-type)))
 998                 ,(maybe-expand-copy-loop-inline 'seq 0 'result 0 'length element-type)
 999                 result)))
1000           ((csubtypep type (specifier-type 'string))
1001            '(string-subseq* seq 0 nil))
1002           (t
1003            '(vector-subseq* seq 0 nil)))))
1004
1005 (deftransform copy-seq ((seq) (list))
1006   '(list-copy-seq* seq))
1007
1008 (deftransform copy-seq ((seq) ((and sequence (not vector) (not list))))
1009   '(sb!sequence:copy-seq seq))
1010
1011 ;;; FIXME: it really should be possible to take advantage of the
1012 ;;; macros used in code/seq.lisp here to avoid duplication of code,
1013 ;;; and enable even funkier transformations.
1014 (deftransform search ((pattern text &key (start1 0) (start2 0) end1 end2
1015                                (test #'eql)
1016                                (key #'identity)
1017                                from-end)
1018                       (vector vector &rest t)
1019                       *
1020                       :node node
1021                       :policy (> speed (max space safety)))
1022   "open code"
1023   (let ((from-end (when (lvar-p from-end)
1024                     (unless (constant-lvar-p from-end)
1025                       (give-up-ir1-transform ":FROM-END is not constant."))
1026                     (lvar-value from-end)))
1027         (keyp (lvar-p key))
1028         (testp (lvar-p test))
1029         (check-bounds-p (policy node (plusp insert-array-bounds-checks))))
1030     `(block search
1031        (flet ((oops (vector start end)
1032                 (sequence-bounding-indices-bad-error vector start end)))
1033          (let* ((len1 (length pattern))
1034                 (len2 (length text))
1035                 (end1 (or end1 len1))
1036                 (end2 (or end2 len2))
1037                ,@(when keyp
1038                        '((key (coerce key 'function))))
1039                ,@(when testp
1040                        '((test (coerce test 'function)))))
1041           (declare (type index start1 start2 end1 end2))
1042           ,@(when check-bounds-p
1043              `((unless (<= start1 end1 len1)
1044                  (oops pattern start1 end1))
1045                (unless (<= start2 end2 len2)
1046                  (oops pattern start2 end2))))
1047           (do (,(if from-end
1048                     '(index2 (- end2 (- end1 start1)) (1- index2))
1049                     '(index2 start2 (1+ index2))))
1050               (,(if from-end
1051                     '(< index2 start2)
1052                     '(>= index2 end2))
1053                nil)
1054             ;; INDEX2 is FIXNUM, not an INDEX, as right before the loop
1055             ;; terminates is hits -1 when :FROM-END is true and :START2
1056             ;; is 0.
1057             (declare (type fixnum index2))
1058             (when (do ((index1 start1 (1+ index1))
1059                        (index2 index2 (1+ index2)))
1060                       ((>= index1 end1) t)
1061                     (declare (type index index1 index2)
1062                              (optimize (insert-array-bounds-checks 0)))
1063                     ,@(unless from-end
1064                               '((when (= index2 end2)
1065                                   (return-from search nil))))
1066                     (unless (,@(if testp
1067                                    '(funcall test)
1068                                    '(eql))
1069                                ,(if keyp
1070                                     '(funcall key (aref pattern index1))
1071                                     '(aref pattern index1))
1072                                ,(if keyp
1073                                     '(funcall key (aref text index2))
1074                                     '(aref text index2)))
1075                       (return nil)))
1076               (return index2))))))))
1077
1078
1079 ;;; Open-code CONCATENATE for strings. It would be possible to extend
1080 ;;; this transform to non-strings, but I chose to just do the case that
1081 ;;; should cover 95% of CONCATENATE performance complaints for now.
1082 ;;;   -- JES, 2007-11-17
1083 (deftransform concatenate ((result-type &rest lvars)
1084                            (symbol &rest sequence)
1085                            *
1086                            :policy (> speed space))
1087   (unless (constant-lvar-p result-type)
1088     (give-up-ir1-transform))
1089   (let* ((element-type (let ((type (lvar-value result-type)))
1090                          ;; Only handle the simple result type cases. If
1091                          ;; somebody does (CONCATENATE '(STRING 6) ...)
1092                          ;; their code won't be optimized, but nobody does
1093                          ;; that in practice.
1094                          (case type
1095                            ((string simple-string) 'character)
1096                            ((base-string simple-base-string) 'base-char)
1097                            (t (give-up-ir1-transform)))))
1098          (vars (loop for x in lvars collect (gensym)))
1099          (lvar-values (loop for lvar in lvars
1100                             collect (when (constant-lvar-p lvar)
1101                                       (lvar-value lvar))))
1102          (lengths
1103           (loop for value in lvar-values
1104                 for var in vars
1105                 collect (if value
1106                             (length value)
1107                             `(sb!impl::string-dispatch ((simple-array * (*))
1108                                                         sequence)
1109                                  ,var
1110                                (declare (muffle-conditions compiler-note))
1111                                (length ,var))))))
1112     `(apply
1113       (lambda ,vars
1114         (declare (ignorable ,@vars))
1115         (let* ((.length. (+ ,@lengths))
1116                (.pos. 0)
1117                (.string. (make-string .length. :element-type ',element-type)))
1118           (declare (type index .length. .pos.)
1119                    (muffle-conditions compiler-note))
1120           ,@(loop for value in lvar-values
1121                   for var in vars
1122                   collect (if (stringp value)
1123                               ;; Fold the array reads for constant arguments
1124                               `(progn
1125                                  ,@(loop for c across value
1126                                          collect `(setf (aref .string.
1127                                                               .pos.) ,c)
1128                                          collect `(incf .pos.)))
1129                               `(sb!impl::string-dispatch
1130                                    (#!+sb-unicode
1131                                     (simple-array character (*))
1132                                     (simple-array base-char (*))
1133                                     t)
1134                                    ,var
1135                                  (replace .string. ,var :start1 .pos.)
1136                                  (incf .pos. (length ,var)))))
1137           .string.))
1138       lvars)))
1139 \f
1140 ;;;; CONS accessor DERIVE-TYPE optimizers
1141
1142 (defoptimizer (car derive-type) ((cons))
1143   ;; This and CDR needs to use LVAR-CONSERVATIVE-TYPE because type inference
1144   ;; gets confused by things like (SETF CAR).
1145   (let ((type (lvar-conservative-type cons))
1146         (null-type (specifier-type 'null)))
1147     (cond ((eq type null-type)
1148            null-type)
1149           ((cons-type-p type)
1150            (cons-type-car-type type)))))
1151
1152 (defoptimizer (cdr derive-type) ((cons))
1153   (let ((type (lvar-conservative-type cons))
1154         (null-type (specifier-type 'null)))
1155     (cond ((eq type null-type)
1156            null-type)
1157           ((cons-type-p type)
1158            (cons-type-cdr-type type)))))
1159 \f
1160 ;;;; FIND, POSITION, and their -IF and -IF-NOT variants
1161
1162 ;;; We want to make sure that %FIND-POSITION is inline-expanded into
1163 ;;; %FIND-POSITION-IF only when %FIND-POSITION-IF has an inline
1164 ;;; expansion, so we factor out the condition into this function.
1165 (defun check-inlineability-of-find-position-if (sequence from-end)
1166   (let ((ctype (lvar-type sequence)))
1167     (cond ((csubtypep ctype (specifier-type 'vector))
1168            ;; It's not worth trying to inline vector code unless we
1169            ;; know a fair amount about it at compile time.
1170            (upgraded-element-type-specifier-or-give-up sequence)
1171            (unless (constant-lvar-p from-end)
1172              (give-up-ir1-transform
1173               "FROM-END argument value not known at compile time")))
1174           ((csubtypep ctype (specifier-type 'list))
1175            ;; Inlining on lists is generally worthwhile.
1176            )
1177           (t
1178            (give-up-ir1-transform
1179             "sequence type not known at compile time")))))
1180
1181 ;;; %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for LIST data
1182 (macrolet ((def (name condition)
1183              `(deftransform ,name ((predicate sequence from-end start end key)
1184                                    (function list t t t function)
1185                                    *
1186                                    :policy (> speed space))
1187                 "expand inline"
1188                 `(let ((index 0)
1189                        (find nil)
1190                        (position nil))
1191                    (declare (type index index))
1192                    (dolist (i sequence
1193                             (if (and end (> end index))
1194                                 (sequence-bounding-indices-bad-error
1195                                  sequence start end)
1196                                 (values find position)))
1197                      (when (and end (>= index end))
1198                        (return (values find position)))
1199                      (when (>= index start)
1200                        (let ((key-i (funcall key i)))
1201                          (,',condition (funcall predicate key-i)
1202                                        ;; This hack of dealing with non-NIL
1203                                        ;; FROM-END for list data by iterating
1204                                        ;; forward through the list and keeping
1205                                        ;; track of the last time we found a
1206                                        ;; match might be more screwy than what
1207                                        ;; the user expects, but it seems to be
1208                                        ;; allowed by the ANSI standard. (And
1209                                        ;; if the user is screwy enough to ask
1210                                        ;; for FROM-END behavior on list data,
1211                                        ;; turnabout is fair play.)
1212                                        ;;
1213                                        ;; It's also not enormously efficient,
1214                                        ;; calling PREDICATE and KEY more often
1215                                        ;; than necessary; but all the
1216                                        ;; alternatives seem to have their own
1217                                        ;; efficiency problems.
1218                                        (if from-end
1219                                            (setf find i
1220                                                  position index)
1221                                            (return (values i index))))))
1222                      (incf index))))))
1223   (def %find-position-if when)
1224   (def %find-position-if-not unless))
1225
1226 ;;; %FIND-POSITION for LIST data can be expanded into %FIND-POSITION-IF
1227 ;;; without loss of efficiency. (I.e., the optimizer should be able
1228 ;;; to straighten everything out.)
1229 (deftransform %find-position ((item sequence from-end start end key test)
1230                               (t list t t t t t)
1231                               *
1232                               :policy (> speed space))
1233   "expand inline"
1234   '(%find-position-if (let ((test-fun (%coerce-callable-to-fun test)))
1235                         ;; The order of arguments for asymmetric tests
1236                         ;; (e.g. #'<, as opposed to order-independent
1237                         ;; tests like #'=) is specified in the spec
1238                         ;; section 17.2.1 -- the O/Zi stuff there.
1239                         (lambda (i)
1240                           (funcall test-fun item i)))
1241                       sequence
1242                       from-end
1243                       start
1244                       end
1245                       (%coerce-callable-to-fun key)))
1246
1247 ;;; The inline expansions for the VECTOR case are saved as macros so
1248 ;;; that we can share them between the DEFTRANSFORMs and the default
1249 ;;; cases in the DEFUNs. (This isn't needed for the LIST case, because
1250 ;;; the DEFTRANSFORMs for LIST are less choosy about when to expand.)
1251 (defun %find-position-or-find-position-if-vector-expansion (sequence-arg
1252                                                             from-end
1253                                                             start
1254                                                             end-arg
1255                                                             element
1256                                                             done-p-expr)
1257   (with-unique-names (offset block index n-sequence sequence end)
1258     `(let* ((,n-sequence ,sequence-arg))
1259        (with-array-data ((,sequence ,n-sequence :offset-var ,offset)
1260                          (,start ,start)
1261                          (,end ,end-arg)
1262                          :check-fill-pointer t)
1263          (block ,block
1264            (macrolet ((maybe-return ()
1265                         ;; WITH-ARRAY-DATA has already performed bounds
1266                         ;; checking, so we can safely elide the checks
1267                         ;; in the inner loop.
1268                         '(let ((,element (locally (declare (optimize (insert-array-bounds-checks 0)))
1269                                            (aref ,sequence ,index))))
1270                           (when ,done-p-expr
1271                             (return-from ,block
1272                               (values ,element
1273                                       (- ,index ,offset)))))))
1274              (if ,from-end
1275                  (loop for ,index
1276                        ;; (If we aren't fastidious about declaring that
1277                        ;; INDEX might be -1, then (FIND 1 #() :FROM-END T)
1278                        ;; can send us off into never-never land, since
1279                        ;; INDEX is initialized to -1.)
1280                        of-type index-or-minus-1
1281                        from (1- ,end) downto ,start do
1282                        (maybe-return))
1283                  (loop for ,index of-type index from ,start below ,end do
1284                           (maybe-return))))
1285            (values nil nil))))))
1286
1287 (def!macro %find-position-vector-macro (item sequence
1288                                              from-end start end key test)
1289   (with-unique-names (element)
1290     (%find-position-or-find-position-if-vector-expansion
1291      sequence
1292      from-end
1293      start
1294      end
1295      element
1296      ;; (See the LIST transform for a discussion of the correct
1297      ;; argument order, i.e. whether the searched-for ,ITEM goes before
1298      ;; or after the checked sequence element.)
1299      `(funcall ,test ,item (funcall ,key ,element)))))
1300
1301 (def!macro %find-position-if-vector-macro (predicate sequence
1302                                                      from-end start end key)
1303   (with-unique-names (element)
1304     (%find-position-or-find-position-if-vector-expansion
1305      sequence
1306      from-end
1307      start
1308      end
1309      element
1310      `(funcall ,predicate (funcall ,key ,element)))))
1311
1312 (def!macro %find-position-if-not-vector-macro (predicate sequence
1313                                                          from-end start end key)
1314   (with-unique-names (element)
1315     (%find-position-or-find-position-if-vector-expansion
1316      sequence
1317      from-end
1318      start
1319      end
1320      element
1321      `(not (funcall ,predicate (funcall ,key ,element))))))
1322
1323 ;;; %FIND-POSITION, %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for
1324 ;;; VECTOR data
1325 (deftransform %find-position-if ((predicate sequence from-end start end key)
1326                                  (function vector t t t function)
1327                                  *
1328                                  :policy (> speed space))
1329   "expand inline"
1330   (check-inlineability-of-find-position-if sequence from-end)
1331   '(%find-position-if-vector-macro predicate sequence
1332                                    from-end start end key))
1333
1334 (deftransform %find-position-if-not ((predicate sequence from-end start end key)
1335                                      (function vector t t t function)
1336                                      *
1337                                      :policy (> speed space))
1338   "expand inline"
1339   (check-inlineability-of-find-position-if sequence from-end)
1340   '(%find-position-if-not-vector-macro predicate sequence
1341                                        from-end start end key))
1342
1343 (deftransform %find-position ((item sequence from-end start end key test)
1344                               (t vector t t t function function)
1345                               *
1346                               :policy (> speed space))
1347   "expand inline"
1348   (check-inlineability-of-find-position-if sequence from-end)
1349   '(%find-position-vector-macro item sequence
1350     from-end start end key test))
1351
1352 ;;; logic to unravel :TEST, :TEST-NOT, and :KEY options in FIND,
1353 ;;; POSITION-IF, etc.
1354 (define-source-transform effective-find-position-test (test test-not)
1355   (once-only ((test test)
1356               (test-not test-not))
1357     `(cond
1358       ((and ,test ,test-not)
1359        (error "can't specify both :TEST and :TEST-NOT"))
1360       (,test (%coerce-callable-to-fun ,test))
1361       (,test-not
1362        ;; (Without DYNAMIC-EXTENT, this is potentially horribly
1363        ;; inefficient, but since the TEST-NOT option is deprecated
1364        ;; anyway, we don't care.)
1365        (complement (%coerce-callable-to-fun ,test-not)))
1366       (t #'eql))))
1367 (define-source-transform effective-find-position-key (key)
1368   (once-only ((key key))
1369     `(if ,key
1370          (%coerce-callable-to-fun ,key)
1371          #'identity)))
1372
1373 (macrolet ((define-find-position (fun-name values-index)
1374              `(deftransform ,fun-name ((item sequence &key
1375                                              from-end (start 0) end
1376                                              key test test-not)
1377                                        (t (or list vector) &rest t))
1378                 '(nth-value ,values-index
1379                             (%find-position item sequence
1380                                             from-end start
1381                                             end
1382                                             (effective-find-position-key key)
1383                                             (effective-find-position-test
1384                                              test test-not))))))
1385   (define-find-position find 0)
1386   (define-find-position position 1))
1387
1388 (macrolet ((define-find-position-if (fun-name values-index)
1389              `(deftransform ,fun-name ((predicate sequence &key
1390                                                   from-end (start 0)
1391                                                   end key)
1392                                        (t (or list vector) &rest t))
1393                 '(nth-value
1394                   ,values-index
1395                   (%find-position-if (%coerce-callable-to-fun predicate)
1396                                      sequence from-end
1397                                      start end
1398                                      (effective-find-position-key key))))))
1399   (define-find-position-if find-if 0)
1400   (define-find-position-if position-if 1))
1401
1402 ;;; the deprecated functions FIND-IF-NOT and POSITION-IF-NOT. We
1403 ;;; didn't bother to worry about optimizing them, except note that on
1404 ;;; Sat, Oct 06, 2001 at 04:22:38PM +0100, Christophe Rhodes wrote on
1405 ;;; sbcl-devel
1406 ;;;
1407 ;;;     My understanding is that while the :test-not argument is
1408 ;;;     deprecated in favour of :test (complement #'foo) because of
1409 ;;;     semantic difficulties (what happens if both :test and :test-not
1410 ;;;     are supplied, etc) the -if-not variants, while officially
1411 ;;;     deprecated, would be undeprecated were X3J13 actually to produce
1412 ;;;     a revised standard, as there are perfectly legitimate idiomatic
1413 ;;;     reasons for allowing the -if-not versions equal status,
1414 ;;;     particularly remove-if-not (== filter).
1415 ;;;
1416 ;;;     This is only an informal understanding, I grant you, but
1417 ;;;     perhaps it's worth optimizing the -if-not versions in the same
1418 ;;;     way as the others?
1419 ;;;
1420 ;;; FIXME: Maybe remove uses of these deprecated functions within the
1421 ;;; implementation of SBCL.
1422 (macrolet ((define-find-position-if-not (fun-name values-index)
1423                `(deftransform ,fun-name ((predicate sequence &key
1424                                           from-end (start 0)
1425                                           end key)
1426                                          (t (or list vector) &rest t))
1427                  '(nth-value
1428                    ,values-index
1429                    (%find-position-if-not (%coerce-callable-to-fun predicate)
1430                     sequence from-end
1431                     start end
1432                     (effective-find-position-key key))))))
1433   (define-find-position-if-not find-if-not 0)
1434   (define-find-position-if-not position-if-not 1))
1435
1436 (macrolet ((define-trimmer-transform (fun-name leftp rightp)
1437              `(deftransform ,fun-name ((char-bag string)
1438                                        (t simple-string))
1439                 (let ((find-expr
1440                        (if (constant-lvar-p char-bag)
1441                            ;; If the bag is constant, use MEMBER
1442                            ;; instead of FIND, since we have a
1443                            ;; deftransform for MEMBER that can
1444                            ;; open-code all of the comparisons when
1445                            ;; the list is constant. -- JES, 2007-12-10
1446                            `(not (member (schar string index)
1447                                          ',(coerce (lvar-value char-bag) 'list)
1448                                          :test #'char=))
1449                            '(not (find (schar string index) char-bag :test #'char=)))))
1450                   `(flet ((char-not-in-bag (index)
1451                             ,find-expr))
1452                      (let* ((end (length string))
1453                             (left-end (if ,',leftp
1454                                           (do ((index 0 (1+ index)))
1455                                               ((or (= index (the fixnum end))
1456                                                    (char-not-in-bag index))
1457                                                index)
1458                                             (declare (fixnum index)))
1459                                           0))
1460                             (right-end (if ,',rightp
1461                                            (do ((index (1- end) (1- index)))
1462                                                ((or (< index left-end)
1463                                                     (char-not-in-bag index))
1464                                                 (1+ index))
1465                                              (declare (fixnum index)))
1466                                            end)))
1467                        (if (and (eql left-end 0)
1468                                 (eql right-end (length string)))
1469                            string
1470                            (subseq string left-end right-end))))))))
1471   (define-trimmer-transform string-left-trim t nil)
1472   (define-trimmer-transform string-right-trim nil t)
1473   (define-trimmer-transform string-trim t t))
1474