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 (defun specialized-list-seek-function-name (function-name key-functions variant)
 295   (or (find-symbol (with-output-to-string (s)
 296                      ;; Write "%NAME-FUN1-FUN2-FUN3", etc. Not only is
 297                      ;; this ever so slightly faster then FORMAT, this
 298                      ;; way we are also proof against *PRINT-CASE*
 299                      ;; frobbing and such.
 300                      (write-char #\% s)
 301                      (write-string (symbol-name function-name) s)
 302                      (dolist (f key-functions)
 303                        (write-char #\- s)
 304                        (write-string (symbol-name f) s))
 305                      (when variant
 306                        (write-char #\- s)
 307                        (write-string (symbol-name variant) s)))
 308                    (load-time-value (find-package "SB!KERNEL")))
 309       (bug "Unknown list item seek transform: name=~S, key-functions=~S variant=~S"
 310            function-name key-functions variant)))
 311
 312 (defun transform-list-item-seek (name item list key test test-not node)
 313   ;; If TEST is EQL, drop it.
 314   (when (and test (lvar-for-named-function test 'eql))
 315     (setf test nil))
 316   ;; Ditto for KEY IDENTITY.
 317   (when (and key (lvar-for-named-function key 'identity))
 318     (setf key nil))
 319   ;; Key can legally be NIL, but if it's NIL for sure we pretend it's
 320   ;; not there at all. If it might be NIL, make up a form to that
 321   ;; ensures it is a function.
 322   (multiple-value-bind (key key-form)
 323       (when key
 324         (let ((key-type (lvar-type key))
 325               (null-type (specifier-type 'null)))
 326           (cond ((csubtypep key-type null-type)
 327                  (values nil nil))
 328                 ((csubtypep null-type key-type)
 329                  (values key '(if key
 330                                (%coerce-callable-to-fun key)
 331                                #'identity)))
 332                 (t
 333                  (values key '(%coerce-callable-to-fun key))))))
 334     (let* ((c-test (cond ((and test (lvar-for-named-function test 'eq))
 335                           (setf test nil)
 336                           'eq)
 337                          ((and (not test) (not test-not))
 338                           (when (eq-comparable-type-p (lvar-type item))
 339                             'eq))))
 340            (funs (remove nil (list (and key 'key) (cond (test 'test)
 341                                                         (test-not 'test-not)))))
 342            (target-expr (if key '(%funcall key target) 'target))
 343            (test-expr (cond (test `(%funcall test item ,target-expr))
 344                             (test-not `(not (%funcall test-not item ,target-expr)))
 345                             (c-test `(,c-test item ,target-expr))
 346                             (t `(eql item ,target-expr)))))
 347       (labels ((open-code (tail)
 348                  (when tail
 349                    `(if (let ((this ',(car tail)))
 350                           ,(ecase name
 351                                   (assoc
 352                                    `(and this (let ((target (car this)))
 353                                                 ,test-expr)))
 354                                   (member
 355                                    `(let ((target this))
 356                                       ,test-expr))))
 357                         ',(ecase name
 358                                  (assoc (car tail))
 359                                  (member tail))
 360                         ,(open-code (cdr tail)))))
 361                (ensure-fun (fun)
 362                  (if (eq 'key fun)
 363                      key-form
 364                      `(%coerce-callable-to-fun ,fun))))
 365         (let* ((cp (constant-lvar-p list))
 366                (c-list (when cp (lvar-value list))))
 367           (cond ((and cp c-list (member name '(assoc member))
 368                       (policy node (>= speed space)))
 369                  `(let ,(mapcar (lambda (fun) `(,fun ,(ensure-fun fun))) funs)
 370                     ,(open-code c-list)))
 371                 ((and cp (not c-list))
 372                  ;; constant nil list
 373                  (if (eq name 'adjoin)
 374                      '(list item)
 375                      nil))
 376                 (t
 377                  ;; specialized out-of-line version
 378                  `(,(specialized-list-seek-function-name name funs c-test)
 379                     item list ,@(mapcar #'ensure-fun funs)))))))))
 380
 381 (deftransform member ((item list &key key test test-not) * * :node node)
 382   (transform-list-item-seek 'member item list key test test-not node))
 383
 384 (deftransform assoc ((item list &key key test test-not) * * :node node)
 385   (transform-list-item-seek 'assoc item list key test test-not node))
 386
 387 (deftransform adjoin ((item list &key key test test-not) * * :node node)
 388   (transform-list-item-seek 'adjoin item list key test test-not node))
 389
 390 (deftransform memq ((item list) (t (constant-arg list)))
 391   (labels ((rec (tail)
 392              (if tail
 393                  `(if (eq item ',(car tail))
 394                       ',tail
 395                       ,(rec (cdr tail)))
 396                  nil)))
 397     (rec (lvar-value list))))
 398
 399 ;;; A similar transform used to apply to MEMBER and ASSOC, but since
 400 ;;; TRANSFORM-LIST-ITEM-SEEK now takes care of them those transform
 401 ;;; would never fire, and (%MEMBER-TEST ITEM LIST #'EQ) should be
 402 ;;; almost as fast as MEMQ.
 403 (deftransform delete ((item list &key test) (t list &rest t) *)
 404   "convert to EQ test"
 405   ;; FIXME: The scope of this transformation could be
 406   ;; widened somewhat, letting it work whenever the test is
 407   ;; 'EQL and we know from the type of ITEM that it #'EQ
 408   ;; works like #'EQL on it. (E.g. types FIXNUM, CHARACTER,
 409   ;; and SYMBOL.)
 410   ;;   If TEST is EQ, apply transform, else
 411   ;;   if test is not EQL, then give up on transform, else
 412   ;;   if ITEM is not a NUMBER or is a FIXNUM, apply
 413   ;;   transform, else give up on transform.
 414   (cond (test
 415          (unless (lvar-fun-is test '(eq))
 416            (give-up-ir1-transform)))
 417         ((types-equal-or-intersect (lvar-type item)
 418                                    (specifier-type 'number))
 419          (give-up-ir1-transform "Item might be a number.")))
 420   `(delq item list))
 421
 422 (deftransform delete-if ((pred list) (t list))
 423   "open code"
 424   '(do ((x list (cdr x))
 425         (splice '()))
 426        ((endp x) list)
 427      (cond ((funcall pred (car x))
 428             (if (null splice)
 429                 (setq list (cdr x))
 430                 (rplacd splice (cdr x))))
 431            (t (setq splice x)))))
 432
 433 (deftransform fill ((seq item &key (start 0) (end nil))
 434                     (list t &key (:start t) (:end t)))
 435   '(list-fill* seq item start end))
 436
 437 (deftransform fill ((seq item &key (start 0) (end nil))
 438                     (vector t &key (:start t) (:end t))
 439                     *
 440                     :node node)
 441   (let ((type (lvar-type seq))
 442         (element-type (type-specifier (extract-upgraded-element-type seq))))
 443     (cond ((and (neq '* element-type) (policy node (> speed space)))
 444            (values
 445             `(with-array-data ((data seq)
 446                                (start start)
 447                                (end end)
 448                                :check-fill-pointer t)
 449                (declare (type (simple-array ,element-type 1) data))
 450                (declare (type index start end))
 451                ;; WITH-ARRAY-DATA did our range checks once and for all, so
 452                ;; it'd be wasteful to check again on every AREF...
 453                (declare (optimize (safety 0) (speed 3)))
 454                (do ((i start (1+ i)))
 455                    ((= i end) seq)
 456                  (declare (type index i))
 457                  (setf (aref data i) item)))
 458             ;; ... though we still need to check that the new element can fit
 459             ;; into the vector in safe code. -- CSR, 2002-07-05
 460             `((declare (type ,element-type item)))))
 461           ((csubtypep type (specifier-type 'string))
 462            '(string-fill* seq item start end))
 463           (t
 464            '(vector-fill* seq item start end)))))
 465
 466 (deftransform fill ((seq item &key (start 0) (end nil))
 467                     ((and sequence (not vector) (not list)) t &key (:start t) (:end t)))
 468   `(sb!sequence:fill seq item
 469                      :start start
 470                      :end (%check-generic-sequence-bounds seq start end)))
 471 \f
 472 ;;;; utilities
 473
 474 ;;; Return true if LVAR's only use is a non-NOTINLINE reference to a
 475 ;;; global function with one of the specified NAMES.
 476 (defun lvar-fun-is (lvar names)
 477   (declare (type lvar lvar) (list names))
 478   (let ((use (lvar-uses lvar)))
 479     (and (ref-p use)
 480          (let ((leaf (ref-leaf use)))
 481            (and (global-var-p leaf)
 482                 (eq (global-var-kind leaf) :global-function)
 483                 (not (null (member (leaf-source-name leaf) names
 484                                    :test #'equal))))))))
 485
 486 ;;; If LVAR is a constant lvar, the return the constant value. If it
 487 ;;; is null, then return default, otherwise quietly give up the IR1
 488 ;;; transform.
 489 ;;;
 490 ;;; ### Probably should take an ARG and flame using the NAME.
 491 (defun constant-value-or-lose (lvar &optional default)
 492   (declare (type (or lvar null) lvar))
 493   (cond ((not lvar) default)
 494         ((constant-lvar-p lvar)
 495          (lvar-value lvar))
 496         (t
 497          (give-up-ir1-transform))))
 498
 499
 500 ;;;; hairy sequence transforms
 501
 502 ;;; FIXME: no hairy sequence transforms in SBCL?
 503 ;;;
 504 ;;; There used to be a bunch of commented out code about here,
 505 ;;; containing the (apparent) beginning of hairy sequence transform
 506 ;;; infrastructure. People interested in implementing better sequence
 507 ;;; transforms might want to look at it for inspiration, even though
 508 ;;; the actual code is ancient CMUCL -- and hence bitrotted. The code
 509 ;;; was deleted in 1.0.7.23.
 510 \f
 511 ;;;; string operations
 512
 513 ;;; We transform the case-sensitive string predicates into a non-keyword
 514 ;;; version. This is an IR1 transform so that we don't have to worry about
 515 ;;; changing the order of evaluation.
 516 (macrolet ((def (fun pred*)
 517              `(deftransform ,fun ((string1 string2 &key (start1 0) end1
 518                                                          (start2 0) end2)
 519                                    * *)
 520                 `(,',pred* string1 string2 start1 end1 start2 end2))))
 521   (def string< string<*)
 522   (def string> string>*)
 523   (def string<= string<=*)
 524   (def string>= string>=*)
 525   (def string= string=*)
 526   (def string/= string/=*))
 527
 528 ;;; Return a form that tests the free variables STRING1 and STRING2
 529 ;;; for the ordering relationship specified by LESSP and EQUALP. The
 530 ;;; start and end are also gotten from the environment. Both strings
 531 ;;; must be SIMPLE-BASE-STRINGs.
 532 (macrolet ((def (name lessp equalp)
 533              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 534                                    (simple-base-string simple-base-string t t t t) *)
 535                 `(let* ((end1 (if (not end1) (length string1) end1))
 536                         (end2 (if (not end2) (length string2) end2))
 537                         (index (sb!impl::%sp-string-compare
 538                                 string1 start1 end1 string2 start2 end2)))
 539                   (if index
 540                       (cond ((= index end1)
 541                              ,(if ',lessp 'index nil))
 542                             ((= (+ index (- start2 start1)) end2)
 543                              ,(if ',lessp nil 'index))
 544                             ((,(if ',lessp 'char< 'char>)
 545                                (schar string1 index)
 546                                (schar string2
 547                                       (truly-the index
 548                                                  (+ index
 549                                                     (truly-the fixnum
 550                                                                (- start2
 551                                                                   start1))))))
 552                              index)
 553                             (t nil))
 554                       ,(if ',equalp 'end1 nil))))))
 555   (def string<* t nil)
 556   (def string<=* t t)
 557   (def string>* nil nil)
 558   (def string>=* nil t))
 559
 560 (macrolet ((def (name result-fun)
 561              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 562                                    (simple-base-string simple-base-string t t t t) *)
 563                 `(,',result-fun
 564                   (sb!impl::%sp-string-compare
 565                    string1 start1 (or end1 (length string1))
 566                    string2 start2 (or end2 (length string2)))))))
 567   (def string=* not)
 568   (def string/=* identity))
 569
 570 \f
 571 ;;;; transforms for sequence functions
 572
 573 ;;; Moved here from generic/vm-tran.lisp to satisfy clisp.  Only applies
 574 ;;; to vectors based on simple arrays.
 575 (def!constant vector-data-bit-offset
 576   (* sb!vm:vector-data-offset sb!vm:n-word-bits))
 577
 578 (eval-when (:compile-toplevel)
 579 (defun valid-bit-bash-saetp-p (saetp)
 580   ;; BIT-BASHing isn't allowed on simple vectors that contain pointers
 581   (and (not (eq t (sb!vm:saetp-specifier saetp)))
 582        ;; Disallowing (VECTOR NIL) also means that we won't transform
 583        ;; sequence functions into bit-bashing code and we let the
 584        ;; generic sequence functions signal errors if necessary.
 585        (not (zerop (sb!vm:saetp-n-bits saetp)))
 586        ;; Due to limitations with the current BIT-BASHing code, we can't
 587        ;; BIT-BASH reliably on arrays whose element types are larger
 588        ;; than the word size.
 589        (<= (sb!vm:saetp-n-bits saetp) sb!vm:n-word-bits)))
 590 ) ; EVAL-WHEN
 591
 592 ;;; FIXME: In the copy loops below, we code the loops in a strange
 593 ;;; fashion:
 594 ;;;
 595 ;;; (do ((i (+ src-offset length) (1- i)))
 596 ;;;     ((<= i 0) ...)
 597 ;;;   (... (aref foo (1- i)) ...))
 598 ;;;
 599 ;;; rather than the more natural (and seemingly more efficient):
 600 ;;;
 601 ;;; (do ((i (1- (+ src-offset length)) (1- i)))
 602 ;;;     ((< i 0) ...)
 603 ;;;   (... (aref foo i) ...))
 604 ;;;
 605 ;;; (more efficient because we don't have to do the index adjusting on
 606 ;;; every iteration of the loop)
 607 ;;;
 608 ;;; We do this to avoid a suboptimality in SBCL's backend.  In the
 609 ;;; latter case, the backend thinks I is a FIXNUM (which it is), but
 610 ;;; when used as an array index, the backend thinks I is a
 611 ;;; POSITIVE-FIXNUM (which it is).  However, since the backend thinks of
 612 ;;; these as distinct storage classes, it cannot coerce a move from a
 613 ;;; FIXNUM TN to a POSITIVE-FIXNUM TN.  The practical effect of this
 614 ;;; deficiency is that we have two extra moves and increased register
 615 ;;; pressure, which can lead to some spectacularly bad register
 616 ;;; allocation.  (sub-FIXME: the register allocation even with the
 617 ;;; strangely written loops is not always excellent, either...).  Doing
 618 ;;; it the first way, above, means that I is always thought of as a
 619 ;;; POSITIVE-FIXNUM and there are no issues.
 620 ;;;
 621 ;;; Besides, the *-WITH-OFFSET machinery will fold those index
 622 ;;; adjustments in the first version into the array addressing at no
 623 ;;; performance penalty!
 624
 625 ;;; This transform is critical to the performance of string streams.  If
 626 ;;; you tweak it, make sure that you compare the disassembly, if not the
 627 ;;; performance of, the functions implementing string streams
 628 ;;; (e.g. SB!IMPL::STRING-OUCH).
 629 (eval-when (:compile-toplevel :load-toplevel :execute)
 630   (defun make-replace-transform (saetp sequence-type1 sequence-type2)
 631     `(deftransform replace ((seq1 seq2 &key (start1 0) (start2 0) end1 end2)
 632                             (,sequence-type1 ,sequence-type2 &rest t)
 633                             ,sequence-type1
 634                             :node node)
 635        ,(cond
 636          ((and saetp (valid-bit-bash-saetp-p saetp)) nil)
 637          ;; If the sequence types are different, SEQ1 and SEQ2 must
 638          ;; be distinct arrays, and we can open code the copy loop.
 639          ((not (eql sequence-type1 sequence-type2)) nil)
 640          ;; If we're not bit-bashing, only allow cases where we
 641          ;; can determine the order of copying up front.  (There
 642          ;; are actually more cases we can handle if we know the
 643          ;; amount that we're copying, but this handles the
 644          ;; common cases.)
 645          (t '(unless (= (constant-value-or-lose start1 0)
 646                       (constant-value-or-lose start2 0))
 647               (give-up-ir1-transform))))
 648        `(let* ((len1 (length seq1))
 649                (len2 (length seq2))
 650                (end1 (or end1 len1))
 651                (end2 (or end2 len2))
 652                (replace-len1 (- end1 start1))
 653                (replace-len2 (- end2 start2)))
 654           ,(unless (policy node (= safety 0))
 655              `(progn
 656                  (unless (<= 0 start1 end1 len1)
 657                    (sequence-bounding-indices-bad-error seq1 start1 end1))
 658                  (unless (<= 0 start2 end2 len2)
 659                    (sequence-bounding-indices-bad-error seq2 start2 end2))))
 660           ,',(cond
 661               ((and saetp (valid-bit-bash-saetp-p saetp))
 662                (let* ((n-element-bits (sb!vm:saetp-n-bits saetp))
 663                       (bash-function (intern (format nil "UB~D-BASH-COPY"
 664                                                      n-element-bits)
 665                                              (find-package "SB!KERNEL"))))
 666                  `(funcall (function ,bash-function) seq2 start2
 667                            seq1 start1 (min replace-len1 replace-len2))))
 668               (t
 669                ;; We can expand the loop inline here because we
 670                ;; would have given up the transform (see above)
 671                ;; if we didn't have constant matching start
 672                ;; indices.
 673                '(do ((i start1 (1+ i))
 674                      (j start2 (1+ j))
 675                      (end (+ start1
 676                              (min replace-len1 replace-len2))))
 677                  ((>= i end))
 678                  (declare (optimize (insert-array-bounds-checks 0)))
 679                  (setf (aref seq1 i) (aref seq2 j)))))
 680           seq1))))
 681
 682 (macrolet
 683     ((define-replace-transforms ()
 684        (loop for saetp across sb!vm:*specialized-array-element-type-properties*
 685              for sequence-type = `(simple-array ,(sb!vm:saetp-specifier saetp) (*))
 686              unless (= (sb!vm:saetp-typecode saetp) sb!vm::simple-array-nil-widetag)
 687              collect (make-replace-transform saetp sequence-type sequence-type)
 688              into forms
 689              finally (return `(progn ,@forms))))
 690      (define-one-transform (sequence-type1 sequence-type2)
 691        (make-replace-transform nil sequence-type1 sequence-type2)))
 692   (define-replace-transforms)
 693   #!+sb-unicode
 694   (progn
 695    (define-one-transform (simple-array base-char (*)) (simple-array character (*)))
 696    (define-one-transform (simple-array character (*)) (simple-array base-char (*)))))
 697
 698 ;;; Expand simple cases of UB<SIZE>-BASH-COPY inline.  "simple" is
 699 ;;; defined as those cases where we are doing word-aligned copies from
 700 ;;; both the source and the destination and we are copying from the same
 701 ;;; offset from both the source and the destination.  (The last
 702 ;;; condition is there so we can determine the direction to copy at
 703 ;;; compile time rather than runtime.  Remember that UB<SIZE>-BASH-COPY
 704 ;;; acts like memmove, not memcpy.)  These conditions may seem rather
 705 ;;; restrictive, but they do catch common cases, like allocating a (* 2
 706 ;;; N)-size buffer and blitting in the old N-size buffer in.
 707
 708 (defun frob-bash-transform (src src-offset
 709                             dst dst-offset
 710                             length n-elems-per-word)
 711   (declare (ignore src dst length))
 712   (let ((n-bits-per-elem (truncate sb!vm:n-word-bits n-elems-per-word)))
 713     (multiple-value-bind (src-word src-elt)
 714         (truncate (lvar-value src-offset) n-elems-per-word)
 715       (multiple-value-bind (dst-word dst-elt)
 716           (truncate (lvar-value dst-offset) n-elems-per-word)
 717         ;; Avoid non-word aligned copies.
 718         (unless (and (zerop src-elt) (zerop dst-elt))
 719           (give-up-ir1-transform))
 720         ;; Avoid copies where we would have to insert code for
 721         ;; determining the direction of copying.
 722         (unless (= src-word dst-word)
 723           (give-up-ir1-transform))
 724         ;; FIXME: The cross-compiler doesn't optimize TRUNCATE properly,
 725         ;; so we have to do its work here.
 726         `(let ((end (+ ,src-word ,(if (= n-elems-per-word 1)
 727                                       'length
 728                                       `(truncate (the index length) ,n-elems-per-word)))))
 729            (declare (type index end))
 730            ;; Handle any bits at the end.
 731            (when (logtest length (1- ,n-elems-per-word))
 732              (let* ((extra (mod length ,n-elems-per-word))
 733                     ;; FIXME: The shift amount on this ASH is
 734                     ;; *always* negative, but the backend doesn't
 735                     ;; have a NEGATIVE-FIXNUM primitive type, so we
 736                     ;; wind up with a pile of code that tests the
 737                     ;; sign of the shift count prior to shifting when
 738                     ;; all we need is a simple negate and shift
 739                     ;; right.  Yuck.
 740                     (mask (ash #.(1- (ash 1 sb!vm:n-word-bits))
 741                                (* (- extra ,n-elems-per-word)
 742                                   ,n-bits-per-elem))))
 743                (setf (sb!kernel:%vector-raw-bits dst end)
 744                      (logior
 745                       (logandc2 (sb!kernel:%vector-raw-bits dst end)
 746                                 (ash mask
 747                                      ,(ecase sb!c:*backend-byte-order*
 748                                              (:little-endian 0)
 749                                              (:big-endian `(* (- ,n-elems-per-word extra)
 750                                                               ,n-bits-per-elem)))))
 751                       (logand (sb!kernel:%vector-raw-bits src end)
 752                               (ash mask
 753                                    ,(ecase sb!c:*backend-byte-order*
 754                                            (:little-endian 0)
 755                                            (:big-endian `(* (- ,n-elems-per-word extra)
 756                                                             ,n-bits-per-elem)))))))))
 757            ;; Copy from the end to save a register.
 758            (do ((i end (1- i)))
 759                ((<= i ,src-word))
 760              (setf (sb!kernel:%vector-raw-bits dst (1- i))
 761                    (sb!kernel:%vector-raw-bits src (1- i))))
 762            (values))))))
 763
 764 #.(loop for i = 1 then (* i 2)
 765         collect `(deftransform ,(intern (format nil "UB~D-BASH-COPY" i)
 766                                         "SB!KERNEL")
 767                                                         ((src src-offset
 768                                                           dst dst-offset
 769                                                           length)
 770                                                         ((simple-unboxed-array (*))
 771                                                          (constant-arg index)
 772                                                          (simple-unboxed-array (*))
 773                                                          (constant-arg index)
 774                                                          index)
 775                                                         *)
 776                   (frob-bash-transform src src-offset
 777                                        dst dst-offset length
 778                                        ,(truncate sb!vm:n-word-bits i))) into forms
 779         until (= i sb!vm:n-word-bits)
 780         finally (return `(progn ,@forms)))
 781
 782 ;;; We expand copy loops inline in SUBSEQ and COPY-SEQ if we're copying
 783 ;;; arrays with elements of size >= the word size.  We do this because
 784 ;;; we know the arrays cannot alias (one was just consed), therefore we
 785 ;;; can determine at compile time the direction to copy, and for
 786 ;;; word-sized elements, UB<WORD-SIZE>-BASH-COPY will do a bit of
 787 ;;; needless checking to figure out what's going on.  The same
 788 ;;; considerations apply if we are copying elements larger than the word
 789 ;;; size, with the additional twist that doing it inline is likely to
 790 ;;; cons far less than calling REPLACE and letting generic code do the
 791 ;;; work.
 792 ;;;
 793 ;;; However, we do not do this for elements whose size is < than the
 794 ;;; word size because we don't want to deal with any alignment issues
 795 ;;; inline.  The UB*-BASH-COPY transforms might fix things up later
 796 ;;; anyway.
 797
 798 (defun maybe-expand-copy-loop-inline (src src-offset dst dst-offset length
 799                                       element-type)
 800   (let ((saetp (find-saetp element-type)))
 801     (aver saetp)
 802     (if (>= (sb!vm:saetp-n-bits saetp) sb!vm:n-word-bits)
 803         (expand-aref-copy-loop src src-offset dst dst-offset length)
 804         `(locally (declare (optimize (safety 0)))
 805            (replace ,dst ,src :start1 ,dst-offset :start2 ,src-offset :end1 ,length)))))
 806
 807 (defun expand-aref-copy-loop (src src-offset dst dst-offset length)
 808   (if (eql src-offset dst-offset)
 809       `(do ((i (+ ,src-offset ,length) (1- i)))
 810            ((<= i ,src-offset))
 811          (declare (optimize (insert-array-bounds-checks 0)))
 812          (setf (aref ,dst (1- i)) (aref ,src (1- i))))
 813       ;; KLUDGE: The compiler is not able to derive that (+ offset
 814       ;; length) must be a fixnum, but arrives at (unsigned-byte 29).
 815       ;; We, however, know it must be so, as by this point the bounds
 816       ;; have already been checked.
 817       `(do ((i (truly-the fixnum (+ ,src-offset ,length)) (1- i))
 818             (j (+ ,dst-offset ,length) (1- j)))
 819            ((<= i ,src-offset))
 820          (declare (optimize (insert-array-bounds-checks 0))
 821                   (type (integer 0 #.sb!xc:array-dimension-limit) j i))
 822          (setf (aref ,dst (1- j)) (aref ,src (1- i))))))
 823
 824 ;;; SUBSEQ, COPY-SEQ
 825
 826 (deftransform subseq ((seq start &optional end)
 827                       (vector t &optional t)
 828                       *
 829                       :node node)
 830   (let ((type (lvar-type seq)))
 831     (cond
 832       ((and (array-type-p type)
 833             (csubtypep type (specifier-type '(or (simple-unboxed-array (*)) simple-vector))))
 834        (let ((element-type (type-specifier (array-type-specialized-element-type type))))
 835          `(let* ((length (length seq))
 836                  (end (or end length)))
 837             ,(unless (policy node (zerop insert-array-bounds-checks))
 838                      '(progn
 839                        (unless (<= 0 start end length)
 840                          (sequence-bounding-indices-bad-error seq start end))))
 841             (let* ((size (- end start))
 842                    (result (make-array size :element-type ',element-type)))
 843               ,(maybe-expand-copy-loop-inline 'seq (if (constant-lvar-p start)
 844                                                        (lvar-value start)
 845                                                        'start)
 846                                               'result 0 'size element-type)
 847               result))))
 848       ((csubtypep type (specifier-type 'string))
 849        '(string-subseq* seq start end))
 850       (t
 851        '(vector-subseq* seq start end)))))
 852
 853 (deftransform subseq ((seq start &optional end)
 854                       (list t &optional t))
 855   `(list-subseq* seq start end))
 856
 857 (deftransform subseq ((seq start &optional end)
 858                       ((and sequence (not vector) (not list)) t &optional t))
 859   '(sb!sequence:subseq seq start end))
 860
 861 (deftransform copy-seq ((seq) (vector))
 862   (let ((type (lvar-type seq)))
 863     (cond ((and (array-type-p type)
 864                 (csubtypep type (specifier-type '(or (simple-unboxed-array (*)) simple-vector))))
 865            (let ((element-type (type-specifier (array-type-specialized-element-type type))))
 866              `(let* ((length (length seq))
 867                      (result (make-array length :element-type ',element-type)))
 868                 ,(maybe-expand-copy-loop-inline 'seq 0 'result 0 'length element-type)
 869                 result)))
 870           ((csubtypep type (specifier-type 'string))
 871            '(string-subseq* seq 0 nil))
 872           (t
 873            '(vector-subseq* seq 0 nil)))))
 874
 875 (deftransform copy-seq ((seq) (list))
 876   '(list-copy-seq* seq))
 877
 878 (deftransform copy-seq ((seq) ((and sequence (not vector) (not list))))
 879   '(sb!sequence:copy-seq seq))
 880
 881 ;;; FIXME: it really should be possible to take advantage of the
 882 ;;; macros used in code/seq.lisp here to avoid duplication of code,
 883 ;;; and enable even funkier transformations.
 884 (deftransform search ((pattern text &key (start1 0) (start2 0) end1 end2
 885                                (test #'eql)
 886                                (key #'identity)
 887                                from-end)
 888                       (vector vector &rest t)
 889                       *
 890                       :node node
 891                       :policy (> speed (max space safety)))
 892   "open code"
 893   (let ((from-end (when (lvar-p from-end)
 894                     (unless (constant-lvar-p from-end)
 895                       (give-up-ir1-transform ":FROM-END is not constant."))
 896                     (lvar-value from-end)))
 897         (keyp (lvar-p key))
 898         (testp (lvar-p test))
 899         (check-bounds-p (policy node (plusp insert-array-bounds-checks))))
 900     `(block search
 901        (flet ((oops (vector start end)
 902                 (sequence-bounding-indices-bad-error vector start end)))
 903          (let* ((len1 (length pattern))
 904                 (len2 (length text))
 905                 (end1 (or end1 len1))
 906                 (end2 (or end2 len2))
 907                ,@(when keyp
 908                        '((key (coerce key 'function))))
 909                ,@(when testp
 910                        '((test (coerce test 'function)))))
 911           (declare (type index start1 start2 end1 end2))
 912           ,@(when check-bounds-p
 913              `((unless (<= start1 end1 len1)
 914                  (oops pattern start1 end1))
 915                (unless (<= start2 end2 len2)
 916                  (oops pattern start2 end2))))
 917           (do (,(if from-end
 918                     '(index2 (- end2 (- end1 start1)) (1- index2))
 919                     '(index2 start2 (1+ index2))))
 920               (,(if from-end
 921                     '(< index2 start2)
 922                     '(>= index2 end2))
 923                nil)
 924             ;; INDEX2 is FIXNUM, not an INDEX, as right before the loop
 925             ;; terminates is hits -1 when :FROM-END is true and :START2
 926             ;; is 0.
 927             (declare (type fixnum index2))
 928             (when (do ((index1 start1 (1+ index1))
 929                        (index2 index2 (1+ index2)))
 930                       ((>= index1 end1) t)
 931                     (declare (type index index1 index2)
 932                              (optimize (insert-array-bounds-checks 0)))
 933                     ,@(unless from-end
 934                               '((when (= index2 end2)
 935                                   (return-from search nil))))
 936                     (unless (,@(if testp
 937                                    '(funcall test)
 938                                    '(eql))
 939                                ,(if keyp
 940                                     '(funcall key (aref pattern index1))
 941                                     '(aref pattern index1))
 942                                ,(if keyp
 943                                     '(funcall key (aref text index2))
 944                                     '(aref text index2)))
 945                       (return nil)))
 946               (return index2))))))))
 947
 948
 949 ;;; Open-code CONCATENATE for strings. It would be possible to extend
 950 ;;; this transform to non-strings, but I chose to just do the case that
 951 ;;; should cover 95% of CONCATENATE performance complaints for now.
 952 ;;;   -- JES, 2007-11-17
 953 (deftransform concatenate ((result-type &rest lvars)
 954                            (symbol &rest sequence)
 955                            *
 956                            :policy (> speed space))
 957   (unless (constant-lvar-p result-type)
 958     (give-up-ir1-transform))
 959   (let* ((element-type (let ((type (lvar-value result-type)))
 960                          ;; Only handle the simple result type cases. If
 961                          ;; somebody does (CONCATENATE '(STRING 6) ...)
 962                          ;; their code won't be optimized, but nobody does
 963                          ;; that in practice.
 964                          (case type
 965                            ((string simple-string) 'character)
 966                            ((base-string simple-base-string) 'base-char)
 967                            (t (give-up-ir1-transform)))))
 968          (vars (loop for x in lvars collect (gensym)))
 969          (lvar-values (loop for lvar in lvars
 970                             collect (when (constant-lvar-p lvar)
 971                                       (lvar-value lvar))))
 972          (lengths
 973           (loop for value in lvar-values
 974                 for var in vars
 975                 collect (if value
 976                             (length value)
 977                             `(sb!impl::string-dispatch ((simple-array * (*))
 978                                                         sequence)
 979                                  ,var
 980                                (declare (muffle-conditions compiler-note))
 981                                (length ,var))))))
 982     `(apply
 983       (lambda ,vars
 984         (declare (ignorable ,@vars))
 985         (let* ((.length. (+ ,@lengths))
 986                (.pos. 0)
 987                (.string. (make-string .length. :element-type ',element-type)))
 988           (declare (type index .length. .pos.)
 989                    (muffle-conditions compiler-note))
 990           ,@(loop for value in lvar-values
 991                   for var in vars
 992                   collect (if (stringp value)
 993                               ;; Fold the array reads for constant arguments
 994                               `(progn
 995                                  ,@(loop for c across value
 996                                          collect `(setf (aref .string.
 997                                                               .pos.) ,c)
 998                                          collect `(incf .pos.)))
 999                               `(sb!impl::string-dispatch
1000                                    (#!+sb-unicode
1001                                     (simple-array character (*))
1002                                     (simple-array base-char (*))
1003                                     t)
1004                                    ,var
1005                                  (replace .string. ,var :start1 .pos.)
1006                                  (incf .pos. (length ,var)))))
1007           .string.))
1008       lvars)))
1009 \f
1010 ;;;; CONS accessor DERIVE-TYPE optimizers
1011
1012 (defoptimizer (car derive-type) ((cons))
1013   (let ((type (lvar-type cons))
1014         (null-type (specifier-type 'null)))
1015     (cond ((eq type null-type)
1016            null-type)
1017           ((cons-type-p type)
1018            (cons-type-car-type type)))))
1019
1020 (defoptimizer (cdr derive-type) ((cons))
1021   (let ((type (lvar-type cons))
1022         (null-type (specifier-type 'null)))
1023     (cond ((eq type null-type)
1024            null-type)
1025           ((cons-type-p type)
1026            (cons-type-cdr-type type)))))
1027 \f
1028 ;;;; FIND, POSITION, and their -IF and -IF-NOT variants
1029
1030 ;;; We want to make sure that %FIND-POSITION is inline-expanded into
1031 ;;; %FIND-POSITION-IF only when %FIND-POSITION-IF has an inline
1032 ;;; expansion, so we factor out the condition into this function.
1033 (defun check-inlineability-of-find-position-if (sequence from-end)
1034   (let ((ctype (lvar-type sequence)))
1035     (cond ((csubtypep ctype (specifier-type 'vector))
1036            ;; It's not worth trying to inline vector code unless we
1037            ;; know a fair amount about it at compile time.
1038            (upgraded-element-type-specifier-or-give-up sequence)
1039            (unless (constant-lvar-p from-end)
1040              (give-up-ir1-transform
1041               "FROM-END argument value not known at compile time")))
1042           ((csubtypep ctype (specifier-type 'list))
1043            ;; Inlining on lists is generally worthwhile.
1044            )
1045           (t
1046            (give-up-ir1-transform
1047             "sequence type not known at compile time")))))
1048
1049 ;;; %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for LIST data
1050 (macrolet ((def (name condition)
1051              `(deftransform ,name ((predicate sequence from-end start end key)
1052                                    (function list t t t function)
1053                                    *
1054                                    :policy (> speed space))
1055                 "expand inline"
1056                 `(let ((index 0)
1057                        (find nil)
1058                        (position nil))
1059                    (declare (type index index))
1060                    (dolist (i sequence
1061                             (if (and end (> end index))
1062                                 (sequence-bounding-indices-bad-error
1063                                  sequence start end)
1064                                 (values find position)))
1065                      (let ((key-i (funcall key i)))
1066                        (when (and end (>= index end))
1067                          (return (values find position)))
1068                        (when (>= index start)
1069                          (,',condition (funcall predicate key-i)
1070                           ;; This hack of dealing with non-NIL
1071                           ;; FROM-END for list data by iterating
1072                           ;; forward through the list and keeping
1073                           ;; track of the last time we found a match
1074                           ;; might be more screwy than what the user
1075                           ;; expects, but it seems to be allowed by
1076                           ;; the ANSI standard. (And if the user is
1077                           ;; screwy enough to ask for FROM-END
1078                           ;; behavior on list data, turnabout is
1079                           ;; fair play.)
1080                           ;;
1081                           ;; It's also not enormously efficient,
1082                           ;; calling PREDICATE and KEY more often
1083                           ;; than necessary; but all the
1084                           ;; alternatives seem to have their own
1085                           ;; efficiency problems.
1086                           (if from-end
1087                               (setf find i
1088                                     position index)
1089                               (return (values i index))))))
1090                      (incf index))))))
1091   (def %find-position-if when)
1092   (def %find-position-if-not unless))
1093
1094 ;;; %FIND-POSITION for LIST data can be expanded into %FIND-POSITION-IF
1095 ;;; without loss of efficiency. (I.e., the optimizer should be able
1096 ;;; to straighten everything out.)
1097 (deftransform %find-position ((item sequence from-end start end key test)
1098                               (t list t t t t t)
1099                               *
1100                               :policy (> speed space))
1101   "expand inline"
1102   '(%find-position-if (let ((test-fun (%coerce-callable-to-fun test)))
1103                         ;; The order of arguments for asymmetric tests
1104                         ;; (e.g. #'<, as opposed to order-independent
1105                         ;; tests like #'=) is specified in the spec
1106                         ;; section 17.2.1 -- the O/Zi stuff there.
1107                         (lambda (i)
1108                           (funcall test-fun item i)))
1109                       sequence
1110                       from-end
1111                       start
1112                       end
1113                       (%coerce-callable-to-fun key)))
1114
1115 ;;; The inline expansions for the VECTOR case are saved as macros so
1116 ;;; that we can share them between the DEFTRANSFORMs and the default
1117 ;;; cases in the DEFUNs. (This isn't needed for the LIST case, because
1118 ;;; the DEFTRANSFORMs for LIST are less choosy about when to expand.)
1119 (defun %find-position-or-find-position-if-vector-expansion (sequence-arg
1120                                                             from-end
1121                                                             start
1122                                                             end-arg
1123                                                             element
1124                                                             done-p-expr)
1125   (with-unique-names (offset block index n-sequence sequence end)
1126     `(let* ((,n-sequence ,sequence-arg))
1127        (with-array-data ((,sequence ,n-sequence :offset-var ,offset)
1128                          (,start ,start)
1129                          (,end ,end-arg)
1130                          :check-fill-pointer t)
1131          (block ,block
1132            (macrolet ((maybe-return ()
1133                         ;; WITH-ARRAY-DATA has already performed bounds
1134                         ;; checking, so we can safely elide the checks
1135                         ;; in the inner loop.
1136                         '(let ((,element (locally (declare (optimize (insert-array-bounds-checks 0)))
1137                                            (aref ,sequence ,index))))
1138                           (when ,done-p-expr
1139                             (return-from ,block
1140                               (values ,element
1141                                       (- ,index ,offset)))))))
1142              (if ,from-end
1143                  (loop for ,index
1144                        ;; (If we aren't fastidious about declaring that
1145                        ;; INDEX might be -1, then (FIND 1 #() :FROM-END T)
1146                        ;; can send us off into never-never land, since
1147                        ;; INDEX is initialized to -1.)
1148                        of-type index-or-minus-1
1149                        from (1- ,end) downto ,start do
1150                        (maybe-return))
1151                  (loop for ,index of-type index from ,start below ,end do
1152                           (maybe-return))))
1153            (values nil nil))))))
1154
1155 (def!macro %find-position-vector-macro (item sequence
1156                                              from-end start end key test)
1157   (with-unique-names (element)
1158     (%find-position-or-find-position-if-vector-expansion
1159      sequence
1160      from-end
1161      start
1162      end
1163      element
1164      ;; (See the LIST transform for a discussion of the correct
1165      ;; argument order, i.e. whether the searched-for ,ITEM goes before
1166      ;; or after the checked sequence element.)
1167      `(funcall ,test ,item (funcall ,key ,element)))))
1168
1169 (def!macro %find-position-if-vector-macro (predicate sequence
1170                                                      from-end start end key)
1171   (with-unique-names (element)
1172     (%find-position-or-find-position-if-vector-expansion
1173      sequence
1174      from-end
1175      start
1176      end
1177      element
1178      `(funcall ,predicate (funcall ,key ,element)))))
1179
1180 (def!macro %find-position-if-not-vector-macro (predicate sequence
1181                                                          from-end start end key)
1182   (with-unique-names (element)
1183     (%find-position-or-find-position-if-vector-expansion
1184      sequence
1185      from-end
1186      start
1187      end
1188      element
1189      `(not (funcall ,predicate (funcall ,key ,element))))))
1190
1191 ;;; %FIND-POSITION, %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for
1192 ;;; VECTOR data
1193 (deftransform %find-position-if ((predicate sequence from-end start end key)
1194                                  (function vector t t t function)
1195                                  *
1196                                  :policy (> speed space))
1197   "expand inline"
1198   (check-inlineability-of-find-position-if sequence from-end)
1199   '(%find-position-if-vector-macro predicate sequence
1200                                    from-end start end key))
1201
1202 (deftransform %find-position-if-not ((predicate sequence from-end start end key)
1203                                      (function vector t t t function)
1204                                      *
1205                                      :policy (> speed space))
1206   "expand inline"
1207   (check-inlineability-of-find-position-if sequence from-end)
1208   '(%find-position-if-not-vector-macro predicate sequence
1209                                        from-end start end key))
1210
1211 (deftransform %find-position ((item sequence from-end start end key test)
1212                               (t vector t t t function function)
1213                               *
1214                               :policy (> speed space))
1215   "expand inline"
1216   (check-inlineability-of-find-position-if sequence from-end)
1217   '(%find-position-vector-macro item sequence
1218     from-end start end key test))
1219
1220 ;;; logic to unravel :TEST, :TEST-NOT, and :KEY options in FIND,
1221 ;;; POSITION-IF, etc.
1222 (define-source-transform effective-find-position-test (test test-not)
1223   (once-only ((test test)
1224               (test-not test-not))
1225     `(cond
1226       ((and ,test ,test-not)
1227        (error "can't specify both :TEST and :TEST-NOT"))
1228       (,test (%coerce-callable-to-fun ,test))
1229       (,test-not
1230        ;; (Without DYNAMIC-EXTENT, this is potentially horribly
1231        ;; inefficient, but since the TEST-NOT option is deprecated
1232        ;; anyway, we don't care.)
1233        (complement (%coerce-callable-to-fun ,test-not)))
1234       (t #'eql))))
1235 (define-source-transform effective-find-position-key (key)
1236   (once-only ((key key))
1237     `(if ,key
1238          (%coerce-callable-to-fun ,key)
1239          #'identity)))
1240
1241 (macrolet ((define-find-position (fun-name values-index)
1242              `(deftransform ,fun-name ((item sequence &key
1243                                              from-end (start 0) end
1244                                              key test test-not)
1245                                        (t (or list vector) &rest t))
1246                 '(nth-value ,values-index
1247                             (%find-position item sequence
1248                                             from-end start
1249                                             end
1250                                             (effective-find-position-key key)
1251                                             (effective-find-position-test
1252                                              test test-not))))))
1253   (define-find-position find 0)
1254   (define-find-position position 1))
1255
1256 (macrolet ((define-find-position-if (fun-name values-index)
1257              `(deftransform ,fun-name ((predicate sequence &key
1258                                                   from-end (start 0)
1259                                                   end key)
1260                                        (t (or list vector) &rest t))
1261                 '(nth-value
1262                   ,values-index
1263                   (%find-position-if (%coerce-callable-to-fun predicate)
1264                                      sequence from-end
1265                                      start end
1266                                      (effective-find-position-key key))))))
1267   (define-find-position-if find-if 0)
1268   (define-find-position-if position-if 1))
1269
1270 ;;; the deprecated functions FIND-IF-NOT and POSITION-IF-NOT. We
1271 ;;; didn't bother to worry about optimizing them, except note that on
1272 ;;; Sat, Oct 06, 2001 at 04:22:38PM +0100, Christophe Rhodes wrote on
1273 ;;; sbcl-devel
1274 ;;;
1275 ;;;     My understanding is that while the :test-not argument is
1276 ;;;     deprecated in favour of :test (complement #'foo) because of
1277 ;;;     semantic difficulties (what happens if both :test and :test-not
1278 ;;;     are supplied, etc) the -if-not variants, while officially
1279 ;;;     deprecated, would be undeprecated were X3J13 actually to produce
1280 ;;;     a revised standard, as there are perfectly legitimate idiomatic
1281 ;;;     reasons for allowing the -if-not versions equal status,
1282 ;;;     particularly remove-if-not (== filter).
1283 ;;;
1284 ;;;     This is only an informal understanding, I grant you, but
1285 ;;;     perhaps it's worth optimizing the -if-not versions in the same
1286 ;;;     way as the others?
1287 ;;;
1288 ;;; FIXME: Maybe remove uses of these deprecated functions within the
1289 ;;; implementation of SBCL.
1290 (macrolet ((define-find-position-if-not (fun-name values-index)
1291                `(deftransform ,fun-name ((predicate sequence &key
1292                                           from-end (start 0)
1293                                           end key)
1294                                          (t (or list vector) &rest t))
1295                  '(nth-value
1296                    ,values-index
1297                    (%find-position-if-not (%coerce-callable-to-fun predicate)
1298                     sequence from-end
1299                     start end
1300                     (effective-find-position-key key))))))
1301   (define-find-position-if-not find-if-not 0)
1302   (define-find-position-if-not position-if-not 1))
1303
1304 (macrolet ((define-trimmer-transform (fun-name leftp rightp)
1305              `(deftransform ,fun-name ((char-bag string)
1306                                        (t simple-string))
1307                 (let ((find-expr
1308                        (if (constant-lvar-p char-bag)
1309                            ;; If the bag is constant, use MEMBER
1310                            ;; instead of FIND, since we have a
1311                            ;; deftransform for MEMBER that can
1312                            ;; open-code all of the comparisons when
1313                            ;; the list is constant. -- JES, 2007-12-10
1314                            `(not (member (schar string index)
1315                                          ',(coerce (lvar-value char-bag) 'list)
1316                                          :test #'char=))
1317                            '(not (find (schar string index) char-bag :test #'char=)))))
1318                   `(flet ((char-not-in-bag (index)
1319                             ,find-expr))
1320                      (let* ((end (length string))
1321                             (left-end (if ,',leftp
1322                                           (do ((index 0 (1+ index)))
1323                                               ((or (= index (the fixnum end))
1324                                                    (char-not-in-bag index))
1325                                                index)
1326                                             (declare (fixnum index)))
1327                                           0))
1328                             (right-end (if ,',rightp
1329                                            (do ((index (1- end) (1- index)))
1330                                                ((or (< index left-end)
1331                                                     (char-not-in-bag index))
1332                                                 (1+ index))
1333                                              (declare (fixnum index)))
1334                                            end)))
1335                        (if (and (eql left-end 0)
1336                                 (eql right-end (length string)))
1337                            string
1338                            (subseq string left-end right-end))))))))
1339   (define-trimmer-transform string-left-trim t nil)
1340   (define-trimmer-transform string-right-trim nil t)
1341   (define-trimmer-transform string-trim t t))
1342