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         (ecase accumulate
  33           (:nconc
  34            (let ((temp (gensym))
  35                  (map-result (gensym)))
  36              `(let ((,fn-sym ,fn)
  37                     (,map-result (list nil)))
  38                 (do-anonymous ((,temp ,map-result) . ,(do-clauses))
  39                               (,endtest (cdr ,map-result))
  40                   (setq ,temp (last (nconc ,temp ,call)))))))
  41           (:list
  42            (let ((temp (gensym))
  43                  (map-result (gensym)))
  44              `(let ((,fn-sym ,fn)
  45                     (,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 ((,fn-sym ,fn)
  51                   (,n-first ,(first arglists)))
  52               (do-anonymous ,(do-clauses)
  53                             (,endtest (truly-the list ,n-first))
  54                             ,call))))))))
  55
  56 (define-source-transform mapc (function list &rest more-lists)
  57   (mapfoo-transform function (cons list more-lists) nil t))
  58
  59 (define-source-transform mapcar (function list &rest more-lists)
  60   (mapfoo-transform function (cons list more-lists) :list t))
  61
  62 (define-source-transform mapcan (function list &rest more-lists)
  63   (mapfoo-transform function (cons list more-lists) :nconc t))
  64
  65 (define-source-transform mapl (function list &rest more-lists)
  66   (mapfoo-transform function (cons list more-lists) nil nil))
  67
  68 (define-source-transform maplist (function list &rest more-lists)
  69   (mapfoo-transform function (cons list more-lists) :list nil))
  70
  71 (define-source-transform mapcon (function list &rest more-lists)
  72   (mapfoo-transform function (cons list more-lists) :nconc nil))
  73 \f
  74 ;;;; mapping onto sequences: the MAP function
  75
  76 ;;; MAP is %MAP plus a check to make sure that any length specified in
  77 ;;; the result type matches the actual result. We also wrap it in a
  78 ;;; TRULY-THE for the most specific type we can determine.
  79 (deftransform map ((result-type-arg fun seq &rest seqs) * * :node node)
  80   (let* ((seq-names (make-gensym-list (1+ (length seqs))))
  81          (bare `(%map result-type-arg fun ,@seq-names))
  82          (constant-result-type-arg-p (constant-lvar-p result-type-arg))
  83          ;; what we know about the type of the result. (Note that the
  84          ;; "result type" argument is not necessarily the type of the
  85          ;; result, since NIL means the result has NULL type.)
  86          (result-type (if (not constant-result-type-arg-p)
  87                           'consed-sequence
  88                           (let ((result-type-arg-value
  89                                  (lvar-value result-type-arg)))
  90                             (if (null result-type-arg-value)
  91                                 'null
  92                                 result-type-arg-value)))))
  93     `(lambda (result-type-arg fun ,@seq-names)
  94        (truly-the ,result-type
  95          ,(cond ((policy node (< safety 3))
  96                  ;; ANSI requires the length-related type check only
  97                  ;; when the SAFETY quality is 3... in other cases, we
  98                  ;; skip it, because it could be expensive.
  99                  bare)
 100                 ((not constant-result-type-arg-p)
 101                  `(sequence-of-checked-length-given-type ,bare
 102                                                          result-type-arg))
 103                 (t
 104                  (let ((result-ctype (ir1-transform-specifier-type
 105                                       result-type)))
 106                    (if (array-type-p result-ctype)
 107                        (let ((dims (array-type-dimensions result-ctype)))
 108                          (unless (and (listp dims) (= (length dims) 1))
 109                            (give-up-ir1-transform "invalid sequence type"))
 110                          (let ((dim (first dims)))
 111                            (if (eq dim '*)
 112                                bare
 113                                `(vector-of-checked-length-given-length ,bare
 114                                                                        ,dim))))
 115                        ;; FIXME: this is wrong, as not all subtypes of
 116                        ;; VECTOR are ARRAY-TYPEs [consider, for
 117                        ;; example, (OR (VECTOR T 3) (VECTOR T
 118                        ;; 4))]. However, it's difficult to see what we
 119                        ;; should put here... maybe we should
 120                        ;; GIVE-UP-IR1-TRANSFORM if the type is a
 121                        ;; subtype of VECTOR but not an ARRAY-TYPE?
 122                        bare))))))))
 123
 124 ;;; Return a DO loop, mapping a function FUN to elements of
 125 ;;; sequences. SEQS is a list of lvars, SEQ-NAMES - list of variables,
 126 ;;; bound to sequences, INTO - a variable, which is used in
 127 ;;; MAP-INTO. RESULT and BODY are forms, which can use variables
 128 ;;; FUNCALL-RESULT, containing the result of application of FUN, and
 129 ;;; INDEX, containing the current position in sequences.
 130 (defun build-sequence-iterator (seqs seq-names &key result into body)
 131   (declare (type list seqs seq-names)
 132            (type symbol into))
 133   (collect ((bindings)
 134             (declarations)
 135             (vector-lengths)
 136             (tests)
 137             (places))
 138     (let ((found-vector-p nil))
 139       (flet ((process-vector (length)
 140                (unless found-vector-p
 141                  (setq found-vector-p t)
 142                  (bindings `(index 0 (1+ index)))
 143                  (declarations `(type index index)))
 144                (vector-lengths length)))
 145         (loop for seq of-type lvar in seqs
 146            for seq-name in seq-names
 147            for type = (lvar-type seq)
 148            do (cond ((csubtypep type (specifier-type 'list))
 149                      (with-unique-names (index)
 150                        (bindings `(,index ,seq-name (cdr ,index)))
 151                        (declarations `(type list ,index))
 152                        (places `(car ,index))
 153                        (tests `(endp ,index))))
 154                     ((csubtypep type (specifier-type 'vector))
 155                      (process-vector `(length ,seq-name))
 156                      (places `(locally (declare (optimize (insert-array-bounds-checks 0)))
 157                                 (aref ,seq-name index))))
 158                     (t
 159                      (give-up-ir1-transform
 160                       "can't determine sequence argument type"))))
 161         (when into
 162           (process-vector `(array-dimension ,into 0))))
 163       (when found-vector-p
 164         (bindings `(length (min ,@(vector-lengths))))
 165         (tests `(>= index length)))
 166       `(do (,@(bindings))
 167            ((or ,@(tests)) ,result)
 168          (declare ,@(declarations))
 169          (let ((funcall-result (funcall fun ,@(places))))
 170            (declare (ignorable funcall-result))
 171            ,body)))))
 172
 173 ;;; Try to compile %MAP efficiently when we can determine sequence
 174 ;;; argument types at compile time.
 175 ;;;
 176 ;;; Note: This transform was written to allow open coding of
 177 ;;; quantifiers by expressing them in terms of (MAP NIL ..). For
 178 ;;; non-NIL values of RESULT-TYPE, it's still useful, but not
 179 ;;; necessarily as efficient as possible. In particular, it will be
 180 ;;; inefficient when RESULT-TYPE is a SIMPLE-ARRAY with specialized
 181 ;;; numeric element types. It should be straightforward to make it
 182 ;;; handle that case more efficiently, but it's left as an exercise to
 183 ;;; the reader, because the code is complicated enough already and I
 184 ;;; don't happen to need that functionality right now. -- WHN 20000410
 185 (deftransform %map ((result-type fun seq &rest seqs) * *
 186                     :policy (>= speed space))
 187   "open code"
 188   (unless (constant-lvar-p result-type)
 189     (give-up-ir1-transform "RESULT-TYPE argument not constant"))
 190   (labels ( ;; 1-valued SUBTYPEP, fails unless second value of SUBTYPEP is true
 191            (fn-1subtypep (fn x y)
 192              (multiple-value-bind (subtype-p valid-p) (funcall fn x y)
 193                (if valid-p
 194                    subtype-p
 195                    (give-up-ir1-transform
 196                     "can't analyze sequence type relationship"))))
 197            (1subtypep (x y) (fn-1subtypep #'sb!xc:subtypep x y)))
 198     (let* ((result-type-value (lvar-value result-type))
 199            (result-supertype (cond ((null result-type-value) 'null)
 200                                    ((1subtypep result-type-value 'vector)
 201                                     'vector)
 202                                    ((1subtypep result-type-value 'list)
 203                                     'list)
 204                                    (t
 205                                     (give-up-ir1-transform
 206                                      "result type unsuitable")))))
 207       (cond ((and result-type-value (null seqs))
 208              ;; The consing arity-1 cases can be implemented
 209              ;; reasonably efficiently as function calls, and the cost
 210              ;; of consing should be significantly larger than
 211              ;; function call overhead, so we always compile these
 212              ;; cases as full calls regardless of speed-versus-space
 213              ;; optimization policy.
 214              (cond ((subtypep result-type-value 'list)
 215                     '(%map-to-list-arity-1 fun seq))
 216                    ( ;; (This one can be inefficient due to COERCE, but
 217                     ;; the current open-coded implementation has the
 218                     ;; same problem.)
 219                     (subtypep result-type-value 'vector)
 220                     `(coerce (%map-to-simple-vector-arity-1 fun seq)
 221                              ',result-type-value))
 222                    (t (bug "impossible (?) sequence type"))))
 223             (t
 224              (let* ((seqs (cons seq seqs))
 225                     (seq-args (make-gensym-list (length seqs))))
 226                (multiple-value-bind (push-dacc result)
 227                    (ecase result-supertype
 228                      (null (values nil nil))
 229                      (list (values `(push funcall-result acc)
 230                                    `(nreverse acc)))
 231                      (vector (values `(push funcall-result acc)
 232                                      `(coerce (nreverse acc)
 233                                               ',result-type-value))))
 234                  ;; (We use the same idiom, of returning a LAMBDA from
 235                  ;; DEFTRANSFORM, as is used in the DEFTRANSFORMs for
 236                  ;; FUNCALL and ALIEN-FUNCALL, and for the same
 237                  ;; reason: we need to get the runtime values of each
 238                  ;; of the &REST vars.)
 239                  `(lambda (result-type fun ,@seq-args)
 240                     (declare (ignore result-type))
 241                     (let ((fun (%coerce-callable-to-fun fun))
 242                           (acc nil))
 243                       (declare (type list acc))
 244                       (declare (ignorable acc))
 245                       ,(build-sequence-iterator
 246                         seqs seq-args
 247                         :result result
 248                         :body push-dacc))))))))))
 249
 250 ;;; MAP-INTO
 251 (deftransform map-into ((result fun &rest seqs)
 252                         (vector * &rest *)
 253                         *)
 254   "open code"
 255   (let ((seqs-names (mapcar (lambda (x)
 256                               (declare (ignore x))
 257                               (gensym))
 258                             seqs)))
 259     `(lambda (result fun ,@seqs-names)
 260        ,(build-sequence-iterator
 261          seqs seqs-names
 262          :result '(when (array-has-fill-pointer-p result)
 263                    (setf (fill-pointer result) index))
 264          :into 'result
 265          :body '(locally (declare (optimize (insert-array-bounds-checks 0)))
 266                  (setf (aref result index) funcall-result)))
 267        result)))
 268
 269 \f
 270 ;;; FIXME: once the confusion over doing transforms with known-complex
 271 ;;; arrays is over, we should also transform the calls to (AND (ARRAY
 272 ;;; * (*)) (NOT (SIMPLE-ARRAY * (*)))) objects.
 273 (deftransform elt ((s i) ((simple-array * (*)) *) *)
 274   '(aref s i))
 275
 276 (deftransform elt ((s i) (list *) * :policy (< safety 3))
 277   '(nth i s))
 278
 279 (deftransform %setelt ((s i v) ((simple-array * (*)) * *) *)
 280   '(%aset s i v))
 281
 282 (deftransform %setelt ((s i v) (list * *) * :policy (< safety 3))
 283   '(setf (car (nthcdr i s)) v))
 284
 285 (deftransform %check-vector-sequence-bounds ((vector start end)
 286                                              (vector * *) *
 287                                              :node node)
 288   (if (policy node (< safety speed))
 289       '(or end (length vector))
 290       '(let ((length (length vector)))
 291         (if (<= 0 start (or end length) length)
 292             (or end length)
 293             (sb!impl::signal-bounding-indices-bad-error vector start end)))))
 294
 295 (macrolet ((def (name)
 296              `(deftransform ,name ((e l &key (test #'eql)) * *
 297                                    :node node)
 298                 (unless (constant-lvar-p l)
 299                   (give-up-ir1-transform))
 300
 301                 (let ((val (lvar-value l)))
 302                   (unless (policy node
 303                                   (or (= speed 3)
 304                                       (and (>= speed space)
 305                                            (<= (length val) 5))))
 306                     (give-up-ir1-transform))
 307
 308                   (labels ((frob (els)
 309                              (if els
 310                                  `(if (funcall test e ',(car els))
 311                                       ',els
 312                                       ,(frob (cdr els)))
 313                                  nil)))
 314                     (frob val))))))
 315   (def member)
 316   (def memq))
 317
 318 ;;; FIXME: We have rewritten the original code that used DOLIST to this
 319 ;;; more natural MACROLET.  However, the original code suggested that when
 320 ;;; this was done, a few bytes could be saved by a call to a shared
 321 ;;; function.  This remains to be done.
 322 (macrolet ((def (fun eq-fun)
 323              `(deftransform ,fun ((item list &key test) (t list &rest t) *)
 324                 "convert to EQ test"
 325                 ;; FIXME: The scope of this transformation could be
 326                 ;; widened somewhat, letting it work whenever the test is
 327                 ;; 'EQL and we know from the type of ITEM that it #'EQ
 328                 ;; works like #'EQL on it. (E.g. types FIXNUM, CHARACTER,
 329                 ;; and SYMBOL.)
 330                 ;;   If TEST is EQ, apply transform, else
 331                 ;;   if test is not EQL, then give up on transform, else
 332                 ;;   if ITEM is not a NUMBER or is a FIXNUM, apply
 333                 ;;   transform, else give up on transform.
 334                 (cond (test
 335                        (unless (lvar-fun-is test '(eq))
 336                          (give-up-ir1-transform)))
 337                       ((types-equal-or-intersect (lvar-type item)
 338                                                  (specifier-type 'number))
 339                        (give-up-ir1-transform "Item might be a number.")))
 340                 `(,',eq-fun item list))))
 341   (def delete delq)
 342   (def assoc assq)
 343   (def member memq))
 344
 345 (deftransform delete-if ((pred list) (t list))
 346   "open code"
 347   '(do ((x list (cdr x))
 348         (splice '()))
 349        ((endp x) list)
 350      (cond ((funcall pred (car x))
 351             (if (null splice)
 352                 (setq list (cdr x))
 353                 (rplacd splice (cdr x))))
 354            (t (setq splice x)))))
 355
 356 (deftransform fill ((seq item &key (start 0) (end (length seq)))
 357                     (vector t &key (:start t) (:end index))
 358                     *
 359                     :policy (> speed space))
 360   "open code"
 361   (let ((element-type (upgraded-element-type-specifier-or-give-up seq)))
 362     (values
 363      `(with-array-data ((data seq)
 364                         (start start)
 365                         (end end))
 366        (declare (type (simple-array ,element-type 1) data))
 367        (declare (type fixnum start end))
 368        (do ((i start (1+ i)))
 369            ((= i end) seq)
 370          (declare (type index i))
 371          ;; WITH-ARRAY-DATA did our range checks once and for all, so
 372          ;; it'd be wasteful to check again on every AREF...
 373          (declare (optimize (safety 0)))
 374          (setf (aref data i) item)))
 375      ;; ... though we still need to check that the new element can fit
 376      ;; into the vector in safe code. -- CSR, 2002-07-05
 377      `((declare (type ,element-type item))))))
 378 \f
 379 ;;;; utilities
 380
 381 ;;; Return true if LVAR's only use is a non-NOTINLINE reference to a
 382 ;;; global function with one of the specified NAMES.
 383 (defun lvar-fun-is (lvar names)
 384   (declare (type lvar lvar) (list names))
 385   (let ((use (lvar-uses lvar)))
 386     (and (ref-p use)
 387          (let ((leaf (ref-leaf use)))
 388            (and (global-var-p leaf)
 389                 (eq (global-var-kind leaf) :global-function)
 390                 (not (null (member (leaf-source-name leaf) names
 391                                    :test #'equal))))))))
 392
 393 ;;; If LVAR is a constant lvar, the return the constant value. If it
 394 ;;; is null, then return default, otherwise quietly give up the IR1
 395 ;;; transform.
 396 ;;;
 397 ;;; ### Probably should take an ARG and flame using the NAME.
 398 (defun constant-value-or-lose (lvar &optional default)
 399   (declare (type (or lvar null) lvar))
 400   (cond ((not lvar) default)
 401         ((constant-lvar-p lvar)
 402          (lvar-value lvar))
 403         (t
 404          (give-up-ir1-transform))))
 405
 406
 407 ;;;; hairy sequence transforms
 408
 409 ;;; FIXME: no hairy sequence transforms in SBCL?
 410 ;;;
 411 ;;; There used to be a bunch of commented out code about here,
 412 ;;; containing the (apparent) beginning of hairy sequence transform
 413 ;;; infrastructure. People interested in implementing better sequence
 414 ;;; transforms might want to look at it for inspiration, even though
 415 ;;; the actual code is ancient CMUCL -- and hence bitrotted. The code
 416 ;;; was deleted in 1.0.7.23.
 417 \f
 418 ;;;; string operations
 419
 420 ;;; We transform the case-sensitive string predicates into a non-keyword
 421 ;;; version. This is an IR1 transform so that we don't have to worry about
 422 ;;; changing the order of evaluation.
 423 (macrolet ((def (fun pred*)
 424              `(deftransform ,fun ((string1 string2 &key (start1 0) end1
 425                                                          (start2 0) end2)
 426                                    * *)
 427                 `(,',pred* string1 string2 start1 end1 start2 end2))))
 428   (def string< string<*)
 429   (def string> string>*)
 430   (def string<= string<=*)
 431   (def string>= string>=*)
 432   (def string= string=*)
 433   (def string/= string/=*))
 434
 435 ;;; Return a form that tests the free variables STRING1 and STRING2
 436 ;;; for the ordering relationship specified by LESSP and EQUALP. The
 437 ;;; start and end are also gotten from the environment. Both strings
 438 ;;; must be SIMPLE-BASE-STRINGs.
 439 (macrolet ((def (name lessp equalp)
 440              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 441                                    (simple-base-string simple-base-string t t t t) *)
 442                 `(let* ((end1 (if (not end1) (length string1) end1))
 443                         (end2 (if (not end2) (length string2) end2))
 444                         (index (sb!impl::%sp-string-compare
 445                                 string1 start1 end1 string2 start2 end2)))
 446                   (if index
 447                       (cond ((= index end1)
 448                              ,(if ',lessp 'index nil))
 449                             ((= (+ index (- start2 start1)) end2)
 450                              ,(if ',lessp nil 'index))
 451                             ((,(if ',lessp 'char< 'char>)
 452                                (schar string1 index)
 453                                (schar string2
 454                                       (truly-the index
 455                                                  (+ index
 456                                                     (truly-the fixnum
 457                                                                (- start2
 458                                                                   start1))))))
 459                              index)
 460                             (t nil))
 461                       ,(if ',equalp 'end1 nil))))))
 462   (def string<* t nil)
 463   (def string<=* t t)
 464   (def string>* nil nil)
 465   (def string>=* nil t))
 466
 467 (macrolet ((def (name result-fun)
 468              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 469                                    (simple-base-string simple-base-string t t t t) *)
 470                 `(,',result-fun
 471                   (sb!impl::%sp-string-compare
 472                    string1 start1 (or end1 (length string1))
 473                    string2 start2 (or end2 (length string2)))))))
 474   (def string=* not)
 475   (def string/=* identity))
 476
 477 \f
 478 ;;;; transforms for sequence functions
 479
 480 ;;; Moved here from generic/vm-tran.lisp to satisfy clisp.  Only applies
 481 ;;; to vectors based on simple arrays.
 482 (def!constant vector-data-bit-offset
 483   (* sb!vm:vector-data-offset sb!vm:n-word-bits))
 484
 485 (eval-when (:compile-toplevel)
 486 (defun valid-bit-bash-saetp-p (saetp)
 487   ;; BIT-BASHing isn't allowed on simple vectors that contain pointers
 488   (and (not (eq t (sb!vm:saetp-specifier saetp)))
 489        ;; Disallowing (VECTOR NIL) also means that we won't transform
 490        ;; sequence functions into bit-bashing code and we let the
 491        ;; generic sequence functions signal errors if necessary.
 492        (not (zerop (sb!vm:saetp-n-bits saetp)))
 493        ;; Due to limitations with the current BIT-BASHing code, we can't
 494        ;; BIT-BASH reliably on arrays whose element types are larger
 495        ;; than the word size.
 496        (<= (sb!vm:saetp-n-bits saetp) sb!vm:n-word-bits)))
 497 ) ; EVAL-WHEN
 498
 499 ;;; FIXME: In the copy loops below, we code the loops in a strange
 500 ;;; fashion:
 501 ;;;
 502 ;;; (do ((i (+ src-offset length) (1- i)))
 503 ;;;     ((<= i 0) ...)
 504 ;;;   (... (aref foo (1- i)) ...))
 505 ;;;
 506 ;;; rather than the more natural (and seemingly more efficient):
 507 ;;;
 508 ;;; (do ((i (1- (+ src-offset length)) (1- i)))
 509 ;;;     ((< i 0) ...)
 510 ;;;   (... (aref foo i) ...))
 511 ;;;
 512 ;;; (more efficient because we don't have to do the index adjusting on
 513 ;;; every iteration of the loop)
 514 ;;;
 515 ;;; We do this to avoid a suboptimality in SBCL's backend.  In the
 516 ;;; latter case, the backend thinks I is a FIXNUM (which it is), but
 517 ;;; when used as an array index, the backend thinks I is a
 518 ;;; POSITIVE-FIXNUM (which it is).  However, since the backend thinks of
 519 ;;; these as distinct storage classes, it cannot coerce a move from a
 520 ;;; FIXNUM TN to a POSITIVE-FIXNUM TN.  The practical effect of this
 521 ;;; deficiency is that we have two extra moves and increased register
 522 ;;; pressure, which can lead to some spectacularly bad register
 523 ;;; allocation.  (sub-FIXME: the register allocation even with the
 524 ;;; strangely written loops is not always excellent, either...).  Doing
 525 ;;; it the first way, above, means that I is always thought of as a
 526 ;;; POSITIVE-FIXNUM and there are no issues.
 527 ;;;
 528 ;;; Besides, the *-WITH-OFFSET machinery will fold those index
 529 ;;; adjustments in the first version into the array addressing at no
 530 ;;; performance penalty!
 531
 532 ;;; This transform is critical to the performance of string streams.  If
 533 ;;; you tweak it, make sure that you compare the disassembly, if not the
 534 ;;; performance of, the functions implementing string streams
 535 ;;; (e.g. SB!IMPL::STRING-OUCH).
 536 (macrolet
 537     ((define-replace-transforms ()
 538        (loop for saetp across sb!vm:*specialized-array-element-type-properties*
 539              for sequence-type = `(simple-array ,(sb!vm:saetp-specifier saetp) (*))
 540              unless (= (sb!vm:saetp-typecode saetp) sb!vm::simple-array-nil-widetag)
 541              collect
 542             `(deftransform replace ((seq1 seq2 &key (start1 0) (start2 0) end1 end2)
 543                                     (,sequence-type ,sequence-type &rest t)
 544                                     ,sequence-type
 545                                     :node node)
 546                ,(cond
 547                  ((valid-bit-bash-saetp-p saetp) nil)
 548                  ;; If we're not bit-bashing, only allow cases where we
 549                  ;; can determine the order of copying up front.  (There
 550                  ;; are actually more cases we can handle if we know the
 551                  ;; amount that we're copying, but this handles the
 552                  ;; common cases.)
 553                  (t '(unless (= (constant-value-or-lose start1 0)
 554                               (constant-value-or-lose start2 0))
 555                       (give-up-ir1-transform))))
 556                `(let* ((len1 (length seq1))
 557                        (len2 (length seq2))
 558                        (end1 (or end1 len1))
 559                        (end2 (or end2 len2))
 560                        (replace-len1 (- end1 start1))
 561                        (replace-len2 (- end2 start2)))
 562                   ,(unless (policy node (= safety 0))
 563                            `(progn
 564                               (unless (<= 0 start1 end1 len1)
 565                                 (sb!impl::signal-bounding-indices-bad-error seq1 start1 end1))
 566                               (unless (<= 0 start2 end2 len2)
 567                                 (sb!impl::signal-bounding-indices-bad-error seq2 start2 end2))))
 568                   ,',(cond
 569                       ((valid-bit-bash-saetp-p saetp)
 570                        (let* ((n-element-bits (sb!vm:saetp-n-bits saetp))
 571                               (bash-function (intern (format nil "UB~D-BASH-COPY" n-element-bits)
 572                                                      (find-package "SB!KERNEL"))))
 573                          `(funcall (function ,bash-function) seq2 start2
 574                                    seq1 start1 (min replace-len1 replace-len2))))
 575                       (t
 576                        ;; We can expand the loop inline here because we
 577                        ;; would have given up the transform (see above)
 578                        ;; if we didn't have constant matching start
 579                        ;; indices.
 580                        '(do ((i start1 (1+ i))
 581                              (end (+ start1
 582                                      (min replace-len1 replace-len2))))
 583                          ((>= i end))
 584                          (declare (optimize (insert-array-bounds-checks 0)))
 585                          (setf (aref seq1 i) (aref seq2 i)))))
 586                   seq1))
 587              into forms
 588              finally (return `(progn ,@forms)))))
 589   (define-replace-transforms))
 590
 591 ;;; Expand simple cases of UB<SIZE>-BASH-COPY inline.  "simple" is
 592 ;;; defined as those cases where we are doing word-aligned copies from
 593 ;;; both the source and the destination and we are copying from the same
 594 ;;; offset from both the source and the destination.  (The last
 595 ;;; condition is there so we can determine the direction to copy at
 596 ;;; compile time rather than runtime.  Remember that UB<SIZE>-BASH-COPY
 597 ;;; acts like memmove, not memcpy.)  These conditions may seem rather
 598 ;;; restrictive, but they do catch common cases, like allocating a (* 2
 599 ;;; N)-size buffer and blitting in the old N-size buffer in.
 600
 601 (defun frob-bash-transform (src src-offset
 602                             dst dst-offset
 603                             length n-elems-per-word)
 604   (declare (ignore src dst length))
 605   (let ((n-bits-per-elem (truncate sb!vm:n-word-bits n-elems-per-word)))
 606     (multiple-value-bind (src-word src-elt)
 607         (truncate (lvar-value src-offset) n-elems-per-word)
 608       (multiple-value-bind (dst-word dst-elt)
 609           (truncate (lvar-value dst-offset) n-elems-per-word)
 610         ;; Avoid non-word aligned copies.
 611         (unless (and (zerop src-elt) (zerop dst-elt))
 612           (give-up-ir1-transform))
 613         ;; Avoid copies where we would have to insert code for
 614         ;; determining the direction of copying.
 615         (unless (= src-word dst-word)
 616           (give-up-ir1-transform))
 617         ;; FIXME: The cross-compiler doesn't optimize TRUNCATE properly,
 618         ;; so we have to do its work here.
 619         `(let ((end (+ ,src-word ,(if (= n-elems-per-word 1)
 620                                       'length
 621                                       `(truncate (the index length) ,n-elems-per-word)))))
 622            (declare (type index end))
 623            ;; Handle any bits at the end.
 624            (when (logtest length (1- ,n-elems-per-word))
 625              (let* ((extra (mod length ,n-elems-per-word))
 626                     ;; FIXME: The shift amount on this ASH is
 627                     ;; *always* negative, but the backend doesn't
 628                     ;; have a NEGATIVE-FIXNUM primitive type, so we
 629                     ;; wind up with a pile of code that tests the
 630                     ;; sign of the shift count prior to shifting when
 631                     ;; all we need is a simple negate and shift
 632                     ;; right.  Yuck.
 633                     (mask (ash #.(1- (ash 1 sb!vm:n-word-bits))
 634                                (* (- extra ,n-elems-per-word)
 635                                   ,n-bits-per-elem))))
 636                (setf (sb!kernel:%vector-raw-bits dst end)
 637                      (logior
 638                       (logandc2 (sb!kernel:%vector-raw-bits dst end)
 639                                 (ash mask
 640                                      ,(ecase sb!c:*backend-byte-order*
 641                                              (:little-endian 0)
 642                                              (:big-endian `(* (- ,n-elems-per-word extra)
 643                                                               ,n-bits-per-elem)))))
 644                       (logand (sb!kernel:%vector-raw-bits src end)
 645                               (ash mask
 646                                    ,(ecase sb!c:*backend-byte-order*
 647                                            (:little-endian 0)
 648                                            (:big-endian `(* (- ,n-elems-per-word extra)
 649                                                             ,n-bits-per-elem)))))))))
 650            ;; Copy from the end to save a register.
 651            (do ((i end (1- i)))
 652                ((<= i ,src-word))
 653              (setf (sb!kernel:%vector-raw-bits dst (1- i))
 654                    (sb!kernel:%vector-raw-bits src (1- i)))))))))
 655
 656 #.(loop for i = 1 then (* i 2)
 657         collect `(deftransform ,(intern (format nil "UB~D-BASH-COPY" i)
 658                                         "SB!KERNEL")
 659                                                         ((src src-offset
 660                                                           dst dst-offset
 661                                                           length)
 662                                                         ((simple-unboxed-array (*))
 663                                                          (constant-arg index)
 664                                                          (simple-unboxed-array (*))
 665                                                          (constant-arg index)
 666                                                          index)
 667                                                         *)
 668                   (frob-bash-transform src src-offset
 669                                        dst dst-offset length
 670                                        ,(truncate sb!vm:n-word-bits i))) into forms
 671         until (= i sb!vm:n-word-bits)
 672         finally (return `(progn ,@forms)))
 673
 674 ;;; We expand copy loops inline in SUBSEQ and COPY-SEQ if we're copying
 675 ;;; arrays with elements of size >= the word size.  We do this because
 676 ;;; we know the arrays cannot alias (one was just consed), therefore we
 677 ;;; can determine at compile time the direction to copy, and for
 678 ;;; word-sized elements, UB<WORD-SIZE>-BASH-COPY will do a bit of
 679 ;;; needless checking to figure out what's going on.  The same
 680 ;;; considerations apply if we are copying elements larger than the word
 681 ;;; size, with the additional twist that doing it inline is likely to
 682 ;;; cons far less than calling REPLACE and letting generic code do the
 683 ;;; work.
 684 ;;;
 685 ;;; However, we do not do this for elements whose size is < than the
 686 ;;; word size because we don't want to deal with any alignment issues
 687 ;;; inline.  The UB*-BASH-COPY transforms might fix things up later
 688 ;;; anyway.
 689
 690 (defun maybe-expand-copy-loop-inline (src src-offset dst dst-offset length
 691                                       element-type)
 692   (let ((saetp (find-saetp element-type)))
 693     (aver saetp)
 694     (if (>= (sb!vm:saetp-n-bits saetp) sb!vm:n-word-bits)
 695         (expand-aref-copy-loop src src-offset dst dst-offset length)
 696         `(locally (declare (optimize (safety 0)))
 697            (replace ,dst ,src :start1 ,dst-offset :start2 ,src-offset :end1 ,length)))))
 698
 699 (defun expand-aref-copy-loop (src src-offset dst dst-offset length)
 700   (if (eql src-offset dst-offset)
 701       `(do ((i (+ ,src-offset ,length) (1- i)))
 702            ((<= i ,src-offset))
 703          (declare (optimize (insert-array-bounds-checks 0)))
 704          (setf (aref ,dst (1- i)) (aref ,src (1- i))))
 705       ;; KLUDGE: The compiler is not able to derive that (+ offset
 706       ;; length) must be a fixnum, but arrives at (unsigned-byte 29).
 707       ;; We, however, know it must be so, as by this point the bounds
 708       ;; have already been checked.
 709       `(do ((i (truly-the fixnum (+ ,src-offset ,length)) (1- i))
 710             (j (+ ,dst-offset ,length) (1- j)))
 711            ((<= i ,src-offset))
 712          (declare (optimize (insert-array-bounds-checks 0))
 713                   (type (integer 0 #.sb!xc:array-dimension-limit) j i))
 714          (setf (aref ,dst (1- j)) (aref ,src (1- i))))))
 715
 716 (deftransform subseq ((seq start &optional end)
 717                       ((or (simple-unboxed-array (*)) simple-vector) t &optional t)
 718                       * :node node)
 719   (let ((array-type (lvar-type seq)))
 720     (unless (array-type-p array-type)
 721       (give-up-ir1-transform))
 722     (let ((element-type (type-specifier (array-type-specialized-element-type array-type))))
 723       `(let* ((length (length seq))
 724               (end (or end length)))
 725          ,(unless (policy node (= safety 0))
 726                   '(progn
 727                     (unless (<= 0 start end length)
 728                       (sb!impl::signal-bounding-indices-bad-error seq start end))))
 729          (let* ((size (- end start))
 730                 (result (make-array size :element-type ',element-type)))
 731            ,(maybe-expand-copy-loop-inline 'seq (if (constant-lvar-p start)
 732                                                     (lvar-value start)
 733                                                     'start)
 734                                            'result 0 'size element-type)
 735            result)))))
 736
 737 (deftransform copy-seq ((seq) ((or (simple-unboxed-array (*)) simple-vector)) *)
 738   (let ((array-type (lvar-type seq)))
 739     (unless (array-type-p array-type)
 740       (give-up-ir1-transform))
 741     (let ((element-type (type-specifier (array-type-specialized-element-type array-type))))
 742       `(let* ((length (length seq))
 743               (result (make-array length :element-type ',element-type)))
 744          ,(maybe-expand-copy-loop-inline 'seq 0 'result 0 'length element-type)
 745          result))))
 746
 747 ;;; FIXME: it really should be possible to take advantage of the
 748 ;;; macros used in code/seq.lisp here to avoid duplication of code,
 749 ;;; and enable even funkier transformations.
 750 (deftransform search ((pattern text &key (start1 0) (start2 0) end1 end2
 751                                (test #'eql)
 752                                (key #'identity)
 753                                from-end)
 754                       (vector vector &rest t)
 755                       *
 756                       :policy (> speed (max space safety)))
 757   "open code"
 758   (let ((from-end (when (lvar-p from-end)
 759                     (unless (constant-lvar-p from-end)
 760                       (give-up-ir1-transform ":FROM-END is not constant."))
 761                     (lvar-value from-end)))
 762         (keyp (lvar-p key))
 763         (testp (lvar-p test)))
 764     `(block search
 765        (let ((end1 (or end1 (length pattern)))
 766              (end2 (or end2 (length text)))
 767              ,@(when keyp
 768                      '((key (coerce key 'function))))
 769              ,@(when testp
 770                      '((test (coerce test 'function)))))
 771          (declare (type index start1 start2 end1 end2))
 772          (do (,(if from-end
 773                    '(index2 (- end2 (- end1 start1)) (1- index2))
 774                    '(index2 start2 (1+ index2))))
 775              (,(if from-end
 776                    '(< index2 start2)
 777                    '(>= index2 end2))
 778               nil)
 779            ;; INDEX2 is FIXNUM, not an INDEX, as right before the loop
 780            ;; terminates is hits -1 when :FROM-END is true and :START2
 781            ;; is 0.
 782            (declare (type fixnum index2))
 783            (when (do ((index1 start1 (1+ index1))
 784                       (index2 index2 (1+ index2)))
 785                      ((>= index1 end1) t)
 786                    (declare (type index index1 index2))
 787                    ,@(unless from-end
 788                              '((when (= index2 end2)
 789                                  (return-from search nil))))
 790                    (unless (,@(if testp
 791                                   '(funcall test)
 792                                   '(eql))
 793                               ,(if keyp
 794                                    '(funcall key (aref pattern index1))
 795                                    '(aref pattern index1))
 796                               ,(if keyp
 797                                    '(funcall key (aref text index2))
 798                                    '(aref text index2)))
 799                      (return nil)))
 800              (return index2)))))))
 801
 802 ;;; FIXME: It seems as though it should be possible to make a DEFUN
 803 ;;; %CONCATENATE (with a DEFTRANSFORM to translate constant RTYPE to
 804 ;;; CTYPE before calling %CONCATENATE) which is comparably efficient,
 805 ;;; at least once DYNAMIC-EXTENT works.
 806 ;;;
 807 ;;; FIXME: currently KLUDGEed because of bug 188
 808 ;;;
 809 ;;; FIXME: disabled for sb-unicode: probably want it back
 810 #!-sb-unicode
 811 (deftransform concatenate ((rtype &rest sequences)
 812                            (t &rest (or simple-base-string
 813                                         (simple-array nil (*))))
 814                            simple-base-string
 815                            :policy (< safety 3))
 816   (loop for rest-seqs on sequences
 817         for n-seq = (gensym "N-SEQ")
 818         for n-length = (gensym "N-LENGTH")
 819         for start = 0 then next-start
 820         for next-start = (gensym "NEXT-START")
 821         collect n-seq into args
 822         collect `(,n-length (length ,n-seq)) into lets
 823         collect n-length into all-lengths
 824         collect next-start into starts
 825         collect `(if (and (typep ,n-seq '(simple-array nil (*)))
 826                           (> ,n-length 0))
 827                      (error 'nil-array-accessed-error)
 828                      (#.(let* ((i (position 'character sb!kernel::*specialized-array-element-types*))
 829                                (saetp (aref sb!vm:*specialized-array-element-type-properties* i))
 830                                (n-bits (sb!vm:saetp-n-bits saetp)))
 831                           (intern (format nil "UB~D-BASH-COPY" n-bits)
 832                                   "SB!KERNEL"))
 833                         ,n-seq 0 res ,start ,n-length))
 834                 into forms
 835         collect `(setq ,next-start (+ ,start ,n-length)) into forms
 836         finally
 837         (return
 838           `(lambda (rtype ,@args)
 839              (declare (ignore rtype))
 840              (let* (,@lets
 841                     (res (make-string (the index (+ ,@all-lengths))
 842                                       :element-type 'base-char)))
 843                (declare (type index ,@all-lengths))
 844                (let (,@(mapcar (lambda (name) `(,name 0)) starts))
 845                  (declare (type index ,@starts))
 846                  ,@forms)
 847                res)))))
 848 \f
 849 ;;;; CONS accessor DERIVE-TYPE optimizers
 850
 851 (defoptimizer (car derive-type) ((cons))
 852   (let ((type (lvar-type cons))
 853         (null-type (specifier-type 'null)))
 854     (cond ((eq type null-type)
 855            null-type)
 856           ((cons-type-p type)
 857            (cons-type-car-type type)))))
 858
 859 (defoptimizer (cdr derive-type) ((cons))
 860   (let ((type (lvar-type cons))
 861         (null-type (specifier-type 'null)))
 862     (cond ((eq type null-type)
 863            null-type)
 864           ((cons-type-p type)
 865            (cons-type-cdr-type type)))))
 866 \f
 867 ;;;; FIND, POSITION, and their -IF and -IF-NOT variants
 868
 869 ;;; We want to make sure that %FIND-POSITION is inline-expanded into
 870 ;;; %FIND-POSITION-IF only when %FIND-POSITION-IF has an inline
 871 ;;; expansion, so we factor out the condition into this function.
 872 (defun check-inlineability-of-find-position-if (sequence from-end)
 873   (let ((ctype (lvar-type sequence)))
 874     (cond ((csubtypep ctype (specifier-type 'vector))
 875            ;; It's not worth trying to inline vector code unless we
 876            ;; know a fair amount about it at compile time.
 877            (upgraded-element-type-specifier-or-give-up sequence)
 878            (unless (constant-lvar-p from-end)
 879              (give-up-ir1-transform
 880               "FROM-END argument value not known at compile time")))
 881           ((csubtypep ctype (specifier-type 'list))
 882            ;; Inlining on lists is generally worthwhile.
 883            )
 884           (t
 885            (give-up-ir1-transform
 886             "sequence type not known at compile time")))))
 887
 888 ;;; %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for LIST data
 889 (macrolet ((def (name condition)
 890              `(deftransform ,name ((predicate sequence from-end start end key)
 891                                    (function list t t t function)
 892                                    *
 893                                    :policy (> speed space))
 894                 "expand inline"
 895                 `(let ((index 0)
 896                        (find nil)
 897                        (position nil))
 898                    (declare (type index index))
 899                    (dolist (i sequence
 900                             (if (and end (> end index))
 901                                 (sb!impl::signal-bounding-indices-bad-error
 902                                  sequence start end)
 903                                 (values find position)))
 904                      (let ((key-i (funcall key i)))
 905                        (when (and end (>= index end))
 906                          (return (values find position)))
 907                        (when (>= index start)
 908                          (,',condition (funcall predicate key-i)
 909                           ;; This hack of dealing with non-NIL
 910                           ;; FROM-END for list data by iterating
 911                           ;; forward through the list and keeping
 912                           ;; track of the last time we found a match
 913                           ;; might be more screwy than what the user
 914                           ;; expects, but it seems to be allowed by
 915                           ;; the ANSI standard. (And if the user is
 916                           ;; screwy enough to ask for FROM-END
 917                           ;; behavior on list data, turnabout is
 918                           ;; fair play.)
 919                           ;;
 920                           ;; It's also not enormously efficient,
 921                           ;; calling PREDICATE and KEY more often
 922                           ;; than necessary; but all the
 923                           ;; alternatives seem to have their own
 924                           ;; efficiency problems.
 925                           (if from-end
 926                               (setf find i
 927                                     position index)
 928                               (return (values i index))))))
 929                      (incf index))))))
 930   (def %find-position-if when)
 931   (def %find-position-if-not unless))
 932
 933 ;;; %FIND-POSITION for LIST data can be expanded into %FIND-POSITION-IF
 934 ;;; without loss of efficiency. (I.e., the optimizer should be able
 935 ;;; to straighten everything out.)
 936 (deftransform %find-position ((item sequence from-end start end key test)
 937                               (t list t t t t t)
 938                               *
 939                               :policy (> speed space))
 940   "expand inline"
 941   '(%find-position-if (let ((test-fun (%coerce-callable-to-fun test)))
 942                         ;; The order of arguments for asymmetric tests
 943                         ;; (e.g. #'<, as opposed to order-independent
 944                         ;; tests like #'=) is specified in the spec
 945                         ;; section 17.2.1 -- the O/Zi stuff there.
 946                         (lambda (i)
 947                           (funcall test-fun item i)))
 948                       sequence
 949                       from-end
 950                       start
 951                       end
 952                       (%coerce-callable-to-fun key)))
 953
 954 ;;; The inline expansions for the VECTOR case are saved as macros so
 955 ;;; that we can share them between the DEFTRANSFORMs and the default
 956 ;;; cases in the DEFUNs. (This isn't needed for the LIST case, because
 957 ;;; the DEFTRANSFORMs for LIST are less choosy about when to expand.)
 958 (defun %find-position-or-find-position-if-vector-expansion (sequence-arg
 959                                                             from-end
 960                                                             start
 961                                                             end-arg
 962                                                             element
 963                                                             done-p-expr)
 964   (with-unique-names (offset block index n-sequence sequence n-end end)
 965     `(let ((,n-sequence ,sequence-arg)
 966            (,n-end ,end-arg))
 967        (with-array-data ((,sequence ,n-sequence :offset-var ,offset)
 968                          (,start ,start)
 969                          (,end (%check-vector-sequence-bounds
 970                                 ,n-sequence ,start ,n-end)))
 971          (block ,block
 972            (macrolet ((maybe-return ()
 973                         ;; WITH-ARRAY-DATA has already performed bounds
 974                         ;; checking, so we can safely elide the checks
 975                         ;; in the inner loop.
 976                         '(let ((,element (locally (declare (optimize (insert-array-bounds-checks 0)))
 977                                            (aref ,sequence ,index))))
 978                            (when ,done-p-expr
 979                              (return-from ,block
 980                                (values ,element
 981                                        (- ,index ,offset)))))))
 982              (if ,from-end
 983                  (loop for ,index
 984                        ;; (If we aren't fastidious about declaring that
 985                        ;; INDEX might be -1, then (FIND 1 #() :FROM-END T)
 986                        ;; can send us off into never-never land, since
 987                        ;; INDEX is initialized to -1.)
 988                        of-type index-or-minus-1
 989                        from (1- ,end) downto ,start do
 990                        (maybe-return))
 991                  (loop for ,index of-type index from ,start below ,end do
 992                        (maybe-return))))
 993            (values nil nil))))))
 994
 995 (def!macro %find-position-vector-macro (item sequence
 996                                              from-end start end key test)
 997   (with-unique-names (element)
 998     (%find-position-or-find-position-if-vector-expansion
 999      sequence
1000      from-end
1001      start
1002      end
1003      element
1004      ;; (See the LIST transform for a discussion of the correct
1005      ;; argument order, i.e. whether the searched-for ,ITEM goes before
1006      ;; or after the checked sequence element.)
1007      `(funcall ,test ,item (funcall ,key ,element)))))
1008
1009 (def!macro %find-position-if-vector-macro (predicate sequence
1010                                                      from-end start end key)
1011   (with-unique-names (element)
1012     (%find-position-or-find-position-if-vector-expansion
1013      sequence
1014      from-end
1015      start
1016      end
1017      element
1018      `(funcall ,predicate (funcall ,key ,element)))))
1019
1020 (def!macro %find-position-if-not-vector-macro (predicate sequence
1021                                                          from-end start end key)
1022   (with-unique-names (element)
1023     (%find-position-or-find-position-if-vector-expansion
1024      sequence
1025      from-end
1026      start
1027      end
1028      element
1029      `(not (funcall ,predicate (funcall ,key ,element))))))
1030
1031 ;;; %FIND-POSITION, %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for
1032 ;;; VECTOR data
1033 (deftransform %find-position-if ((predicate sequence from-end start end key)
1034                                  (function vector t t t function)
1035                                  *
1036                                  :policy (> speed space))
1037   "expand inline"
1038   (check-inlineability-of-find-position-if sequence from-end)
1039   '(%find-position-if-vector-macro predicate sequence
1040                                    from-end start end key))
1041
1042 (deftransform %find-position-if-not ((predicate sequence from-end start end key)
1043                                      (function vector t t t function)
1044                                      *
1045                                      :policy (> speed space))
1046   "expand inline"
1047   (check-inlineability-of-find-position-if sequence from-end)
1048   '(%find-position-if-not-vector-macro predicate sequence
1049                                        from-end start end key))
1050
1051 (deftransform %find-position ((item sequence from-end start end key test)
1052                               (t vector t t t function function)
1053                               *
1054                               :policy (> speed space))
1055   "expand inline"
1056   (check-inlineability-of-find-position-if sequence from-end)
1057   '(%find-position-vector-macro item sequence
1058                                 from-end start end key test))
1059
1060 ;;; logic to unravel :TEST, :TEST-NOT, and :KEY options in FIND,
1061 ;;; POSITION-IF, etc.
1062 (define-source-transform effective-find-position-test (test test-not)
1063   (once-only ((test test)
1064               (test-not test-not))
1065     `(cond
1066       ((and ,test ,test-not)
1067        (error "can't specify both :TEST and :TEST-NOT"))
1068       (,test (%coerce-callable-to-fun ,test))
1069       (,test-not
1070        ;; (Without DYNAMIC-EXTENT, this is potentially horribly
1071        ;; inefficient, but since the TEST-NOT option is deprecated
1072        ;; anyway, we don't care.)
1073        (complement (%coerce-callable-to-fun ,test-not)))
1074       (t #'eql))))
1075 (define-source-transform effective-find-position-key (key)
1076   (once-only ((key key))
1077     `(if ,key
1078          (%coerce-callable-to-fun ,key)
1079          #'identity)))
1080
1081 (macrolet ((define-find-position (fun-name values-index)
1082              `(deftransform ,fun-name ((item sequence &key
1083                                              from-end (start 0) end
1084                                              key test test-not)
1085                                        (t (or list vector) &rest t))
1086                 '(nth-value ,values-index
1087                             (%find-position item sequence
1088                                             from-end start
1089                                             end
1090                                             (effective-find-position-key key)
1091                                             (effective-find-position-test
1092                                              test test-not))))))
1093   (define-find-position find 0)
1094   (define-find-position position 1))
1095
1096 (macrolet ((define-find-position-if (fun-name values-index)
1097              `(deftransform ,fun-name ((predicate sequence &key
1098                                                   from-end (start 0)
1099                                                   end key)
1100                                        (t (or list vector) &rest t))
1101                 '(nth-value
1102                   ,values-index
1103                   (%find-position-if (%coerce-callable-to-fun predicate)
1104                                      sequence from-end
1105                                      start end
1106                                      (effective-find-position-key key))))))
1107   (define-find-position-if find-if 0)
1108   (define-find-position-if position-if 1))
1109
1110 ;;; the deprecated functions FIND-IF-NOT and POSITION-IF-NOT. We
1111 ;;; didn't bother to worry about optimizing them, except note that on
1112 ;;; Sat, Oct 06, 2001 at 04:22:38PM +0100, Christophe Rhodes wrote on
1113 ;;; sbcl-devel
1114 ;;;
1115 ;;;     My understanding is that while the :test-not argument is
1116 ;;;     deprecated in favour of :test (complement #'foo) because of
1117 ;;;     semantic difficulties (what happens if both :test and :test-not
1118 ;;;     are supplied, etc) the -if-not variants, while officially
1119 ;;;     deprecated, would be undeprecated were X3J13 actually to produce
1120 ;;;     a revised standard, as there are perfectly legitimate idiomatic
1121 ;;;     reasons for allowing the -if-not versions equal status,
1122 ;;;     particularly remove-if-not (== filter).
1123 ;;;
1124 ;;;     This is only an informal understanding, I grant you, but
1125 ;;;     perhaps it's worth optimizing the -if-not versions in the same
1126 ;;;     way as the others?
1127 ;;;
1128 ;;; FIXME: Maybe remove uses of these deprecated functions within the
1129 ;;; implementation of SBCL.
1130 (macrolet ((define-find-position-if-not (fun-name values-index)
1131                `(deftransform ,fun-name ((predicate sequence &key
1132                                           from-end (start 0)
1133                                           end key)
1134                                          (t (or list vector) &rest t))
1135                  '(nth-value
1136                    ,values-index
1137                    (%find-position-if-not (%coerce-callable-to-fun predicate)
1138                     sequence from-end
1139                     start end
1140                     (effective-find-position-key key))))))
1141   (define-find-position-if-not find-if-not 0)
1142   (define-find-position-if-not position-if-not 1))