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