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 (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 ,n-first) ,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 &rest seqs) * * :node node)
  79   (let* ((seq-names (make-gensym-list (length seqs)))
  80          (bare `(%map result-type-arg fun ,@seq-names))
  81          (constant-result-type-arg-p (constant-continuation-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                                  (continuation-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 continuations, SEQ-NAMES - list of
 125 ;;; variables, 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 continuation in seqs
 145            for seq-name in seq-names
 146            for type = (continuation-type seq)
 147            do (cond ((csubtypep type (specifier-type 'list))
 148                      (let ((index (gensym "I")))
 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 `(aref ,seq-name index)))
 156                     (t
 157                      (give-up-ir1-transform
 158                       "can't determine sequence argument type"))))
 159         (when into
 160           (process-vector `(array-dimension ,into 0))))
 161       (when found-vector-p
 162         (bindings `(length (min ,@(vector-lengths))))
 163         (tests `(= index length)))
 164       `(do (,@(bindings))
 165            ((or ,@(tests)) ,result)
 166          (declare ,@(declarations))
 167          (let ((funcall-result (funcall fun ,@(places))))
 168            (declare (ignorable funcall-result))
 169            ,body)))))
 170
 171 ;;; Try to compile %MAP efficiently when we can determine sequence
 172 ;;; argument types at compile time.
 173 ;;;
 174 ;;; Note: This transform was written to allow open coding of
 175 ;;; quantifiers by expressing them in terms of (MAP NIL ..). For
 176 ;;; non-NIL values of RESULT-TYPE, it's still useful, but not
 177 ;;; necessarily as efficient as possible. In particular, it will be
 178 ;;; inefficient when RESULT-TYPE is a SIMPLE-ARRAY with specialized
 179 ;;; numeric element types. It should be straightforward to make it
 180 ;;; handle that case more efficiently, but it's left as an exercise to
 181 ;;; the reader, because the code is complicated enough already and I
 182 ;;; don't happen to need that functionality right now. -- WHN 20000410
 183 (deftransform %map ((result-type fun &rest seqs) * * :policy (>= speed space))
 184   "open code"
 185   (unless seqs (abort-ir1-transform "no sequence args"))
 186   (unless (constant-continuation-p result-type)
 187     (give-up-ir1-transform "RESULT-TYPE argument not constant"))
 188   (labels ( ;; 1-valued SUBTYPEP, fails unless second value of SUBTYPEP is true
 189            (fn-1subtypep (fn x y)
 190              (multiple-value-bind (subtype-p valid-p) (funcall fn x y)
 191                (if valid-p
 192                    subtype-p
 193                    (give-up-ir1-transform
 194                     "can't analyze sequence type relationship"))))
 195            (1subtypep (x y) (fn-1subtypep #'sb!xc:subtypep x y)))
 196     (let* ((result-type-value (continuation-value result-type))
 197            (result-supertype (cond ((null result-type-value) 'null)
 198                                    ((1subtypep result-type-value 'vector)
 199                                     'vector)
 200                                    ((1subtypep result-type-value 'list)
 201                                     'list)
 202                                    (t
 203                                     (give-up-ir1-transform
 204                                      "can't determine result type")))))
 205       (cond ((and result-type-value (= 1 (length seqs)))
 206              ;; The consing arity-1 cases can be implemented
 207              ;; reasonably efficiently as function calls, and the cost
 208              ;; of consing should be significantly larger than
 209              ;; function call overhead, so we always compile these
 210              ;; cases as full calls regardless of speed-versus-space
 211              ;; optimization policy.
 212              (cond ((subtypep 'list result-type-value)
 213                     '(apply #'%map-to-list-arity-1 fun seqs))
 214                    ( ;; (This one can be inefficient due to COERCE, but
 215                     ;; the current open-coded implementation has the
 216                     ;; same problem.)
 217                     (subtypep result-type-value 'vector)
 218                     `(coerce (apply #'%map-to-simple-vector-arity-1 fun seqs)
 219                              ',result-type-value))
 220                    (t (bug "impossible (?) sequence type"))))
 221             (t
 222              (let* ((seq-args (make-gensym-list (length seqs))))
 223                (multiple-value-bind (push-dacc result)
 224                    (ecase result-supertype
 225                      (null (values nil nil))
 226                      (list (values `(push funcall-result acc)
 227                                    `(nreverse acc)))
 228                      (vector (values `(push funcall-result acc)
 229                                      `(coerce (nreverse acc)
 230                                               ',result-type-value))))
 231                  ;; (We use the same idiom, of returning a LAMBDA from
 232                  ;; DEFTRANSFORM, as is used in the DEFTRANSFORMs for
 233                  ;; FUNCALL and ALIEN-FUNCALL, and for the same
 234                  ;; reason: we need to get the runtime values of each
 235                  ;; of the &REST vars.)
 236                  `(lambda (result-type fun ,@seq-args)
 237                     (declare (ignore result-type))
 238                     (let ((fun (%coerce-callable-to-fun fun))
 239                           (acc nil))
 240                       (declare (type list acc))
 241                       (declare (ignorable acc))
 242                       ,(build-sequence-iterator
 243                         seqs seq-args
 244                         :result result
 245                         :body push-dacc))))))))))
 246
 247 ;;; MAP-INTO
 248 (deftransform map-into ((result fun &rest seqs)
 249                         (vector * &rest *)
 250                         *)
 251   "open code"
 252   (let ((seqs-names (mapcar (lambda (x)
 253                               (declare (ignore x))
 254                               (gensym))
 255                             seqs)))
 256     `(lambda (result fun ,@seqs-names)
 257        ,(build-sequence-iterator
 258          seqs seqs-names
 259          :result '(when (array-has-fill-pointer-p result)
 260                    (setf (fill-pointer result) index))
 261          :into 'result
 262          :body '(setf (aref result index) funcall-result))
 263        result)))
 264
 265 \f
 266 ;;; FIXME: once the confusion over doing transforms with known-complex
 267 ;;; arrays is over, we should also transform the calls to (AND (ARRAY
 268 ;;; * (*)) (NOT (SIMPLE-ARRAY * (*)))) objects.
 269 (deftransform elt ((s i) ((simple-array * (*)) *) *)
 270   '(aref s i))
 271
 272 (deftransform elt ((s i) (list *) * :policy (< safety 3))
 273   '(nth i s))
 274
 275 (deftransform %setelt ((s i v) ((simple-array * (*)) * *) *)
 276   '(%aset s i v))
 277
 278 (deftransform %setelt ((s i v) (list * *) * :policy (< safety 3))
 279   '(setf (car (nthcdr i s)) v))
 280
 281 (deftransform %check-vector-sequence-bounds ((vector start end)
 282                                              (vector * *) *
 283                                              :node node)
 284   (if (policy node (< safety speed))
 285       '(or end (length vector))
 286       '(let ((length (length vector)))
 287         (if (<= 0 start (or end length) length)
 288             (or end length)
 289             (sb!impl::signal-bounding-indices-bad-error vector start end)))))
 290
 291 (macrolet ((def (name)
 292              `(deftransform ,name ((e l &key (test #'eql)) * *
 293                                    :node node)
 294                 (unless (constant-continuation-p l)
 295                   (give-up-ir1-transform))
 296
 297                 (let ((val (continuation-value l)))
 298                   (unless (policy node
 299                                   (or (= speed 3)
 300                                       (and (>= speed space)
 301                                            (<= (length val) 5))))
 302                     (give-up-ir1-transform))
 303
 304                   (labels ((frob (els)
 305                              (if els
 306                                  `(if (funcall test e ',(car els))
 307                                       ',els
 308                                       ,(frob (cdr els)))
 309                                  nil)))
 310                     (frob val))))))
 311   (def member)
 312   (def memq))
 313
 314 ;;; FIXME: We have rewritten the original code that used DOLIST to this
 315 ;;; more natural MACROLET.  However, the original code suggested that when
 316 ;;; this was done, a few bytes could be saved by a call to a shared
 317 ;;; function.  This remains to be done.
 318 (macrolet ((def (fun eq-fun)
 319              `(deftransform ,fun ((item list &key test) (t list &rest t) *)
 320                 "convert to EQ test"
 321                 ;; FIXME: The scope of this transformation could be
 322                 ;; widened somewhat, letting it work whenever the test is
 323                 ;; 'EQL and we know from the type of ITEM that it #'EQ
 324                 ;; works like #'EQL on it. (E.g. types FIXNUM, CHARACTER,
 325                 ;; and SYMBOL.)
 326                 ;;   If TEST is EQ, apply transform, else
 327                 ;;   if test is not EQL, then give up on transform, else
 328                 ;;   if ITEM is not a NUMBER or is a FIXNUM, apply
 329                 ;;   transform, else give up on transform.
 330                 (cond (test
 331                        (unless (continuation-fun-is test '(eq))
 332                          (give-up-ir1-transform)))
 333                       ((types-equal-or-intersect (continuation-type item)
 334                                                  (specifier-type 'number))
 335                        (give-up-ir1-transform "Item might be a number.")))
 336                 `(,',eq-fun item list))))
 337   (def delete delq)
 338   (def assoc assq)
 339   (def member memq))
 340
 341 (deftransform delete-if ((pred list) (t list))
 342   "open code"
 343   '(do ((x list (cdr x))
 344         (splice '()))
 345        ((endp x) list)
 346      (cond ((funcall pred (car x))
 347             (if (null splice)
 348                 (setq list (cdr x))
 349                 (rplacd splice (cdr x))))
 350            (T (setq splice x)))))
 351
 352 (deftransform fill ((seq item &key (start 0) (end (length seq)))
 353                     (vector t &key (:start t) (:end index))
 354                     *
 355                     :policy (> speed space))
 356   "open code"
 357   (let ((element-type (upgraded-element-type-specifier-or-give-up seq)))
 358     (values
 359      `(with-array-data ((data seq)
 360                         (start start)
 361                         (end end))
 362        (declare (type (simple-array ,element-type 1) data))
 363        (declare (type fixnum start end))
 364        (do ((i start (1+ i)))
 365            ((= i end) seq)
 366          (declare (type index i))
 367          ;; WITH-ARRAY-DATA did our range checks once and for all, so
 368          ;; it'd be wasteful to check again on every AREF...
 369          (declare (optimize (safety 0)))
 370          (setf (aref data i) item)))
 371      ;; ... though we still need to check that the new element can fit
 372      ;; into the vector in safe code. -- CSR, 2002-07-05
 373      `((declare (type ,element-type item))))))
 374 \f
 375 ;;;; utilities
 376
 377 ;;; Return true if CONT's only use is a non-NOTINLINE reference to a
 378 ;;; global function with one of the specified NAMES.
 379 (defun continuation-fun-is (cont names)
 380   (declare (type continuation cont) (list names))
 381   (let ((use (continuation-use cont)))
 382     (and (ref-p use)
 383          (let ((leaf (ref-leaf use)))
 384            (and (global-var-p leaf)
 385                 (eq (global-var-kind leaf) :global-function)
 386                 (not (null (member (leaf-source-name leaf) names
 387                                    :test #'equal))))))))
 388
 389 ;;; If CONT is a constant continuation, the return the constant value.
 390 ;;; If it is null, then return default, otherwise quietly give up the
 391 ;;; IR1 transform.
 392 ;;;
 393 ;;; ### Probably should take an ARG and flame using the NAME.
 394 (defun constant-value-or-lose (cont &optional default)
 395   (declare (type (or continuation null) cont))
 396   (cond ((not cont) default)
 397         ((constant-continuation-p cont)
 398          (continuation-value cont))
 399         (t
 400          (give-up-ir1-transform))))
 401
 402 ;;; FIXME: Why is this code commented out? (Why *was* it commented
 403 ;;; out? We inherited this situation from cmucl-2.4.8, with no
 404 ;;; explanation.) Should we just delete this code?
 405 #|
 406 ;;; This is a frob whose job it is to make it easier to pass around
 407 ;;; the arguments to IR1 transforms. It bundles together the name of
 408 ;;; the argument (which should be referenced in any expansion), and
 409 ;;; the continuation for that argument (or NIL if unsupplied.)
 410 (defstruct (arg (:constructor %make-arg (name cont))
 411                 (:copier nil))
 412   (name nil :type symbol)
 413   (cont nil :type (or continuation null)))
 414 (defmacro make-arg (name)
 415   `(%make-arg ',name ,name))
 416
 417 ;;; If Arg is null or its CONT is null, then return Default, otherwise
 418 ;;; return Arg's NAME.
 419 (defun default-arg (arg default)
 420   (declare (type (or arg null) arg))
 421   (if (and arg (arg-cont arg))
 422       (arg-name arg)
 423       default))
 424
 425 ;;; If Arg is null or has no CONT, return the default. Otherwise, Arg's
 426 ;;; CONT must be a constant continuation whose value we return. If not, we
 427 ;;; give up.
 428 (defun arg-constant-value (arg default)
 429   (declare (type (or arg null) arg))
 430   (if (and arg (arg-cont arg))
 431       (let ((cont (arg-cont arg)))
 432         (unless (constant-continuation-p cont)
 433           (give-up-ir1-transform "Argument is not constant: ~S."
 434                                  (arg-name arg)))
 435         (continuation-value from-end))
 436       default))
 437
 438 ;;; If Arg is a constant and is EQL to X, then return T, otherwise NIL. If
 439 ;;; Arg is NIL or its CONT is NIL, then compare to the default.
 440 (defun arg-eql (arg default x)
 441   (declare (type (or arg null) x))
 442   (if (and arg (arg-cont arg))
 443       (let ((cont (arg-cont arg)))
 444         (and (constant-continuation-p cont)
 445              (eql (continuation-value cont) x)))
 446       (eql default x)))
 447
 448 (defstruct (iterator (:copier nil))
 449   ;; The kind of iterator.
 450   (kind nil (member :normal :result))
 451   ;; A list of LET* bindings to create the initial state.
 452   (binds nil :type list)
 453   ;; A list of declarations for Binds.
 454   (decls nil :type list)
 455   ;; A form that returns the current value. This may be set with SETF to set
 456   ;; the current value.
 457   (current (error "Must specify CURRENT."))
 458   ;; In a :NORMAL iterator, a form that tests whether there is a current value.
 459   (done nil)
 460   ;; In a :RESULT iterator, a form that truncates the result at the current
 461   ;; position and returns it.
 462   (result nil)
 463   ;; A form that returns the initial total number of values. The result is
 464   ;; undefined after NEXT has been evaluated.
 465   (length (error "Must specify LENGTH."))
 466   ;; A form that advances the state to the next value. It is an error to call
 467   ;; this when the iterator is Done.
 468   (next (error "Must specify NEXT.")))
 469
 470 ;;; Type of an index var that can go negative (in the from-end case.)
 471 (deftype neg-index ()
 472   `(integer -1 ,most-positive-fixnum))
 473
 474 ;;; Return an ITERATOR structure describing how to iterate over an arbitrary
 475 ;;; sequence. Sequence is a variable bound to the sequence, and Type is the
 476 ;;; type of the sequence. If true, INDEX is a variable that should be bound to
 477 ;;; the index of the current element in the sequence.
 478 ;;;
 479 ;;; If we can't tell whether the sequence is a list or a vector, or whether
 480 ;;; the iteration is forward or backward, then GIVE-UP.
 481 (defun make-sequence-iterator (sequence type &key start end from-end index)
 482   (declare (symbol sequence) (type ctype type)
 483            (type (or arg null) start end from-end)
 484            (type (or symbol null) index))
 485   (let ((from-end (arg-constant-value from-end nil)))
 486     (cond ((csubtypep type (specifier-type 'vector))
 487            (let* ((n-stop (gensym))
 488                   (n-idx (or index (gensym)))
 489                   (start (default-arg 0 start))
 490                   (end (default-arg `(length ,sequence) end)))
 491              (make-iterator
 492               :kind :normal
 493               :binds `((,n-idx ,(if from-end `(1- ,end) ,start))
 494                        (,n-stop ,(if from-end `(1- ,start) ,end)))
 495               :decls `((type neg-index ,n-idx ,n-stop))
 496               :current `(aref ,sequence ,n-idx)
 497               :done `(,(if from-end '<= '>=) ,n-idx ,n-stop)
 498               :next `(setq ,n-idx
 499                            ,(if from-end `(1- ,n-idx) `(1+ ,n-idx)))
 500               :length (if from-end
 501                           `(- ,n-idx ,n-stop)
 502                           `(- ,n-stop ,n-idx)))))
 503           ((csubtypep type (specifier-type 'list))
 504            (let* ((n-stop (if (and end (not from-end)) (gensym) nil))
 505                   (n-current (gensym))
 506                   (start-p (not (arg-eql start 0 0)))
 507                   (end-p (not (arg-eql end nil nil)))
 508                   (start (default-arg start 0))
 509                   (end (default-arg end nil)))
 510              (make-iterator
 511               :binds `((,n-current
 512                         ,(if from-end
 513                              (if (or start-p end-p)
 514                                  `(nreverse (subseq ,sequence ,start
 515                                                     ,@(when end `(,end))))
 516                                  `(reverse ,sequence))
 517                              (if start-p
 518                                  `(nthcdr ,start ,sequence)
 519                                  sequence)))
 520                        ,@(when n-stop
 521                            `((,n-stop (nthcdr (the index
 522                                                    (- ,end ,start))
 523                                               ,n-current))))
 524                        ,@(when index
 525                            `((,index ,(if from-end `(1- ,end) start)))))
 526               :kind :normal
 527               :decls `((list ,n-current ,n-end)
 528                        ,@(when index `((type neg-index ,index))))
 529               :current `(car ,n-current)
 530               :done `(eq ,n-current ,n-stop)
 531               :length `(- ,(or end `(length ,sequence)) ,start)
 532               :next `(progn
 533                        (setq ,n-current (cdr ,n-current))
 534                        ,@(when index
 535                            `((setq ,n-idx
 536                                    ,(if from-end
 537                                         `(1- ,index)
 538                                         `(1+ ,index)))))))))
 539           (t
 540            (give-up-ir1-transform
 541             "can't tell whether sequence is a list or a vector")))))
 542
 543 ;;; Make an iterator used for constructing result sequences. Name is a
 544 ;;; variable to be bound to the result sequence. Type is the type of result
 545 ;;; sequence to make. Length is an expression to be evaluated to get the
 546 ;;; maximum length of the result (not evaluated in list case.)
 547 (defun make-result-sequence-iterator (name type length)
 548   (declare (symbol name) (type ctype type))
 549
 550 ;;; Define each NAME as a local macro that will call the value of the
 551 ;;; function arg with the given arguments. If the argument isn't known to be a
 552 ;;; function, give them an efficiency note and reference a coerced version.
 553 (defmacro coerce-funs (specs &body body)
 554   #!+sb-doc
 555   "COERCE-FUNCTIONS ({(Name Fun-Arg Default)}*) Form*"
 556   (collect ((binds)
 557             (defs))
 558     (dolist (spec specs)
 559       `(let ((body (progn ,@body))
 560              (n-fun (arg-name ,(second spec)))
 561              (fun-cont (arg-cont ,(second spec))))
 562          (cond ((not fun-cont)
 563                 `(macrolet ((,',(first spec) (&rest args)
 564                              `(,',',(third spec) ,@args)))
 565                    ,body))
 566                ((not (csubtypep (continuation-type fun-cont)
 567                                 (specifier-type 'function)))
 568                 (when (policy *compiler-error-context*
 569                               (> speed inhibit-warnings))
 570                   (compiler-note
 571                    "~S may not be a function, so must coerce at run-time."
 572                    n-fun))
 573                 (once-only ((n-fun `(if (functionp ,n-fun)
 574                                         ,n-fun
 575                                         (symbol-function ,n-fun))))
 576                   `(macrolet ((,',(first spec) (&rest args)
 577                                `(funcall ,',n-fun ,@args)))
 578                      ,body)))
 579                (t
 580                 `(macrolet ((,',(first spec) (&rest args)
 581                               `(funcall ,',n-fun ,@args)))
 582                    ,body)))))))
 583
 584 ;;; Wrap code around the result of the body to define Name as a local macro
 585 ;;; that returns true when its arguments satisfy the test according to the Args
 586 ;;; Test and Test-Not. If both Test and Test-Not are supplied, abort the
 587 ;;; transform.
 588 (defmacro with-sequence-test ((name test test-not) &body body)
 589   `(let ((not-p (arg-cont ,test-not)))
 590      (when (and (arg-cont ,test) not-p)
 591        (abort-ir1-transform "Both ~S and ~S were supplied."
 592                             (arg-name ,test)
 593                             (arg-name ,test-not)))
 594      (coerce-funs ((,name (if not-p ,test-not ,test) eql))
 595        ,@body)))
 596 |#
 597 \f
 598 ;;;; hairy sequence transforms
 599
 600 ;;; FIXME: no hairy sequence transforms in SBCL?
 601 \f
 602 ;;;; string operations
 603
 604 ;;; We transform the case-sensitive string predicates into a non-keyword
 605 ;;; version. This is an IR1 transform so that we don't have to worry about
 606 ;;; changing the order of evaluation.
 607 (macrolet ((def (fun pred*)
 608              `(deftransform ,fun ((string1 string2 &key (start1 0) end1
 609                                                          (start2 0) end2)
 610                                    * *)
 611                 `(,',pred* string1 string2 start1 end1 start2 end2))))
 612   (def string< string<*)
 613   (def string> string>*)
 614   (def string<= string<=*)
 615   (def string>= string>=*)
 616   (def string= string=*)
 617   (def string/= string/=*))
 618
 619 ;;; Return a form that tests the free variables STRING1 and STRING2
 620 ;;; for the ordering relationship specified by LESSP and EQUALP. The
 621 ;;; start and end are also gotten from the environment. Both strings
 622 ;;; must be SIMPLE-STRINGs.
 623 (macrolet ((def (name lessp equalp)
 624              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 625                                     (simple-string simple-string t t t t) *)
 626                 `(let* ((end1 (if (not end1) (length string1) end1))
 627                         (end2 (if (not end2) (length string2) end2))
 628                         (index (sb!impl::%sp-string-compare
 629                                 string1 start1 end1 string2 start2 end2)))
 630                   (if index
 631                       (cond ((= index ,(if ',lessp 'end1 'end2)) index)
 632                             ((= index ,(if ',lessp 'end2 'end1)) nil)
 633                             ((,(if ',lessp 'char< 'char>)
 634                                (schar string1 index)
 635                                (schar string2
 636                                       (truly-the index
 637                                                  (+ index
 638                                                     (truly-the fixnum
 639                                                                (- start2
 640                                                                   start1))))))
 641                              index)
 642                             (t nil))
 643                       ,(if ',equalp 'end1 nil))))))
 644   (def string<* t nil)
 645   (def string<=* t t)
 646   (def string>* nil nil)
 647   (def string>=* nil t))
 648
 649 (macrolet ((def (name result-fun)
 650              `(deftransform ,name ((string1 string2 start1 end1 start2 end2)
 651                                    (simple-string simple-string t t t t) *)
 652                 `(,',result-fun
 653                   (sb!impl::%sp-string-compare
 654                    string1 start1 (or end1 (length string1))
 655                    string2 start2 (or end2 (length string2)))))))
 656   (def string=* not)
 657   (def string/=* identity))
 658
 659 \f
 660 ;;;; string-only transforms for sequence functions
 661 ;;;;
 662 ;;;; Note: CMU CL had more of these, including transforms for
 663 ;;;; functions which cons. In SBCL, we've gotten rid of most of the
 664 ;;;; transforms for functions which cons, since our GC overhead is
 665 ;;;; sufficiently large that it doesn't seem worth it to try to
 666 ;;;; economize on function call overhead or on the overhead of runtime
 667 ;;;; type dispatch in AREF. The exception is CONCATENATE, since
 668 ;;;; a full call to CONCATENATE would have to look up the sequence
 669 ;;;; type, which can be really slow.
 670 ;;;;
 671 ;;;; FIXME: It would be nicer for these transforms to work for any
 672 ;;;; calls when all arguments are vectors with the same element type,
 673 ;;;; rather than restricting them to STRINGs only.
 674
 675 ;;; Moved here from generic/vm-tran.lisp to satisfy clisp
 676 ;;;
 677 ;;; FIXME: Add a comment telling whether this holds for all vectors
 678 ;;; or only for vectors based on simple arrays (non-adjustable, etc.).
 679 (def!constant vector-data-bit-offset
 680   (* sb!vm:vector-data-offset sb!vm:n-word-bits))
 681
 682 (deftransform replace ((string1 string2 &key (start1 0) (start2 0)
 683                                 end1 end2)
 684                        (simple-string simple-string &rest t)
 685                        *
 686                        ;; FIXME: consider replacing this policy test
 687                        ;; with some tests for the STARTx and ENDx
 688                        ;; indices being valid, conditional on high
 689                        ;; SAFETY code.
 690                        ;;
 691                        ;; FIXME: It turns out that this transform is
 692                        ;; critical for the performance of string
 693                        ;; streams.  Make this more explicit.
 694                        :policy (< (max safety space) 3))
 695   `(locally
 696      (declare (optimize (safety 0)))
 697      (bit-bash-copy string2
 698                     (the index
 699                          (+ (the index (* start2 sb!vm:n-byte-bits))
 700                             ,vector-data-bit-offset))
 701                     string1
 702                     (the index
 703                          (+ (the index (* start1 sb!vm:n-byte-bits))
 704                             ,vector-data-bit-offset))
 705                     (the index
 706                          (* (min (the index (- (or end1 (length string1))
 707                                                start1))
 708                                  (the index (- (or end2 (length string2))
 709                                                start2)))
 710                             sb!vm:n-byte-bits)))
 711      string1))
 712
 713 ;;; FIXME: It seems as though it should be possible to make a DEFUN
 714 ;;; %CONCATENATE (with a DEFTRANSFORM to translate constant RTYPE to
 715 ;;; CTYPE before calling %CONCATENATE) which is comparably efficient,
 716 ;;; at least once DYNAMIC-EXTENT works.
 717 ;;;
 718 ;;; FIXME: currently KLUDGEed because of bug 188
 719 (deftransform concatenate ((rtype &rest sequences)
 720                            (t &rest simple-string)
 721                            simple-string
 722                            :policy (< safety 3))
 723   (collect ((lets)
 724             (forms)
 725             (all-lengths)
 726             (args))
 727     (dolist (seq sequences)
 728       (declare (ignorable seq))
 729       (let ((n-seq (gensym))
 730             (n-length (gensym)))
 731         (args n-seq)
 732         (lets `(,n-length (the index (* (length ,n-seq) sb!vm:n-byte-bits))))
 733         (all-lengths n-length)
 734         (forms `(bit-bash-copy ,n-seq ,vector-data-bit-offset
 735                                res start
 736                                ,n-length))
 737         (forms `(setq start (opaque-identity (+ start ,n-length))))))
 738     `(lambda (rtype ,@(args))
 739        (declare (ignore rtype))
 740        ;; KLUDGE
 741        (flet ((opaque-identity (x) x))
 742          (declare (notinline opaque-identity))
 743          (let* (,@(lets)
 744                   (res (make-string (truncate (the index (+ ,@(all-lengths)))
 745                                               sb!vm:n-byte-bits)))
 746                   (start ,vector-data-bit-offset))
 747            (declare (type index start ,@(all-lengths)))
 748            ,@(forms)
 749            res)))))
 750 \f
 751 ;;;; CONS accessor DERIVE-TYPE optimizers
 752
 753 (defoptimizer (car derive-type) ((cons))
 754   (let ((type (continuation-type cons))
 755         (null-type (specifier-type 'null)))
 756     (cond ((eq type null-type)
 757            null-type)
 758           ((cons-type-p type)
 759            (cons-type-car-type type)))))
 760
 761 (defoptimizer (cdr derive-type) ((cons))
 762   (let ((type (continuation-type cons))
 763         (null-type (specifier-type 'null)))
 764     (cond ((eq type null-type)
 765            null-type)
 766           ((cons-type-p type)
 767            (cons-type-cdr-type type)))))
 768 \f
 769 ;;;; FIND, POSITION, and their -IF and -IF-NOT variants
 770
 771 ;;; We want to make sure that %FIND-POSITION is inline-expanded into
 772 ;;; %FIND-POSITION-IF only when %FIND-POSITION-IF has an inline
 773 ;;; expansion, so we factor out the condition into this function.
 774 (defun check-inlineability-of-find-position-if (sequence from-end)
 775   (let ((ctype (continuation-type sequence)))
 776     (cond ((csubtypep ctype (specifier-type 'vector))
 777            ;; It's not worth trying to inline vector code unless we
 778            ;; know a fair amount about it at compile time.
 779            (upgraded-element-type-specifier-or-give-up sequence)
 780            (unless (constant-continuation-p from-end)
 781              (give-up-ir1-transform
 782               "FROM-END argument value not known at compile time")))
 783           ((csubtypep ctype (specifier-type 'list))
 784            ;; Inlining on lists is generally worthwhile.
 785            )
 786           (t
 787            (give-up-ir1-transform
 788             "sequence type not known at compile time")))))
 789
 790 ;;; %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for LIST data
 791 (macrolet ((def (name condition)
 792              `(deftransform ,name ((predicate sequence from-end start end key)
 793                                    (function list t t t function)
 794                                    *
 795                                    :policy (> speed space)
 796                                    :important t)
 797                 "expand inline"
 798                 `(let ((index 0)
 799                        (find nil)
 800                        (position nil))
 801                    (declare (type index index))
 802                    (dolist (i sequence
 803                             (if (and end (> end index))
 804                                 (sb!impl::signal-bounding-indices-bad-error
 805                                  sequence start end)
 806                                 (values find position)))
 807                      (let ((key-i (funcall key i)))
 808                        (when (and end (>= index end))
 809                          (return (values find position)))
 810                        (when (>= index start)
 811                          (,',condition (funcall predicate key-i)
 812                           ;; This hack of dealing with non-NIL
 813                           ;; FROM-END for list data by iterating
 814                           ;; forward through the list and keeping
 815                           ;; track of the last time we found a match
 816                           ;; might be more screwy than what the user
 817                           ;; expects, but it seems to be allowed by
 818                           ;; the ANSI standard. (And if the user is
 819                           ;; screwy enough to ask for FROM-END
 820                           ;; behavior on list data, turnabout is
 821                           ;; fair play.)
 822                           ;;
 823                           ;; It's also not enormously efficient,
 824                           ;; calling PREDICATE and KEY more often
 825                           ;; than necessary; but all the
 826                           ;; alternatives seem to have their own
 827                           ;; efficiency problems.
 828                           (if from-end
 829                               (setf find i
 830                                     position index)
 831                               (return (values i index))))))
 832                      (incf index))))))
 833   (def %find-position-if when)
 834   (def %find-position-if-not unless))
 835
 836 ;;; %FIND-POSITION for LIST data can be expanded into %FIND-POSITION-IF
 837 ;;; without loss of efficiency. (I.e., the optimizer should be able
 838 ;;; to straighten everything out.)
 839 (deftransform %find-position ((item sequence from-end start end key test)
 840                               (t list t t t t t)
 841                               *
 842                               :policy (> speed space)
 843                               :important t)
 844   "expand inline"
 845   '(%find-position-if (let ((test-fun (%coerce-callable-to-fun test)))
 846                         ;; The order of arguments for asymmetric tests
 847                         ;; (e.g. #'<, as opposed to order-independent
 848                         ;; tests like #'=) is specified in the spec
 849                         ;; section 17.2.1 -- the O/Zi stuff there.
 850                         (lambda (i)
 851                           (funcall test-fun item i)))
 852                       sequence
 853                       from-end
 854                       start
 855                       end
 856                       (%coerce-callable-to-fun key)))
 857
 858 ;;; The inline expansions for the VECTOR case are saved as macros so
 859 ;;; that we can share them between the DEFTRANSFORMs and the default
 860 ;;; cases in the DEFUNs. (This isn't needed for the LIST case, because
 861 ;;; the DEFTRANSFORMs for LIST are less choosy about when to expand.)
 862 (defun %find-position-or-find-position-if-vector-expansion (sequence-arg
 863                                                             from-end
 864                                                             start
 865                                                             end-arg
 866                                                             element
 867                                                             done-p-expr)
 868   (let ((offset (gensym "OFFSET"))
 869         (block (gensym "BLOCK"))
 870         (index (gensym "INDEX"))
 871         (n-sequence (gensym "N-SEQUENCE-"))
 872         (sequence (gensym "SEQUENCE"))
 873         (n-end (gensym "N-END-"))
 874         (end (gensym "END-")))
 875     `(let ((,n-sequence ,sequence-arg)
 876            (,n-end ,end-arg))
 877        (with-array-data ((,sequence ,n-sequence :offset-var ,offset)
 878                          (,start ,start)
 879                          (,end (%check-vector-sequence-bounds
 880                                 ,n-sequence ,start ,n-end)))
 881          (block ,block
 882            (macrolet ((maybe-return ()
 883                         '(let ((,element (aref ,sequence ,index)))
 884                            (when ,done-p-expr
 885                              (return-from ,block
 886                                (values ,element
 887                                        (- ,index ,offset)))))))
 888              (if ,from-end
 889                  (loop for ,index
 890                        ;; (If we aren't fastidious about declaring that
 891                        ;; INDEX might be -1, then (FIND 1 #() :FROM-END T)
 892                        ;; can send us off into never-never land, since
 893                        ;; INDEX is initialized to -1.)
 894                        of-type index-or-minus-1
 895                        from (1- ,end) downto ,start do
 896                        (maybe-return))
 897                  (loop for ,index of-type index from ,start below ,end do
 898                        (maybe-return))))
 899            (values nil nil))))))
 900
 901 (def!macro %find-position-vector-macro (item sequence
 902                                              from-end start end key test)
 903   (let ((element (gensym "ELEMENT")))
 904     (%find-position-or-find-position-if-vector-expansion
 905      sequence
 906      from-end
 907      start
 908      end
 909      element
 910      ;; (See the LIST transform for a discussion of the correct
 911      ;; argument order, i.e. whether the searched-for ,ITEM goes before
 912      ;; or after the checked sequence element.)
 913      `(funcall ,test ,item (funcall ,key ,element)))))
 914
 915 (def!macro %find-position-if-vector-macro (predicate sequence
 916                                                      from-end start end key)
 917   (let ((element (gensym "ELEMENT")))
 918     (%find-position-or-find-position-if-vector-expansion
 919      sequence
 920      from-end
 921      start
 922      end
 923      element
 924      `(funcall ,predicate (funcall ,key ,element)))))
 925
 926 (def!macro %find-position-if-not-vector-macro (predicate sequence
 927                                                          from-end start end key)
 928   (let ((element (gensym "ELEMENT")))
 929     (%find-position-or-find-position-if-vector-expansion
 930      sequence
 931      from-end
 932      start
 933      end
 934      element
 935      `(not (funcall ,predicate (funcall ,key ,element))))))
 936
 937 ;;; %FIND-POSITION, %FIND-POSITION-IF and %FIND-POSITION-IF-NOT for
 938 ;;; VECTOR data
 939 (deftransform %find-position-if ((predicate sequence from-end start end key)
 940                                  (function vector t t t function)
 941                                  *
 942                                  :policy (> speed space)
 943                                  :important t)
 944   "expand inline"
 945   (check-inlineability-of-find-position-if sequence from-end)
 946   '(%find-position-if-vector-macro predicate sequence
 947                                    from-end start end key))
 948
 949 (deftransform %find-position-if-not ((predicate sequence from-end start end key)
 950                                      (function vector t t t function)
 951                                      *
 952                                      :policy (> speed space)
 953                                      :important t)
 954   "expand inline"
 955   (check-inlineability-of-find-position-if sequence from-end)
 956   '(%find-position-if-not-vector-macro predicate sequence
 957                                        from-end start end key))
 958
 959 (deftransform %find-position ((item sequence from-end start end key test)
 960                               (t vector t t t function function)
 961                               *
 962                               :policy (> speed space)
 963                               :important t)
 964   "expand inline"
 965   (check-inlineability-of-find-position-if sequence from-end)
 966   '(%find-position-vector-macro item sequence
 967                                 from-end start end key test))
 968
 969 ;;; logic to unravel :TEST, :TEST-NOT, and :KEY options in FIND,
 970 ;;; POSITION-IF, etc.
 971 (define-source-transform effective-find-position-test (test test-not)
 972   (once-only ((test test)
 973               (test-not test-not))
 974     `(cond
 975       ((and ,test ,test-not)
 976        (error "can't specify both :TEST and :TEST-NOT"))
 977       (,test (%coerce-callable-to-fun ,test))
 978       (,test-not
 979        ;; (Without DYNAMIC-EXTENT, this is potentially horribly
 980        ;; inefficient, but since the TEST-NOT option is deprecated
 981        ;; anyway, we don't care.)
 982        (complement (%coerce-callable-to-fun ,test-not)))
 983       (t #'eql))))
 984 (define-source-transform effective-find-position-key (key)
 985   (once-only ((key key))
 986     `(if ,key
 987          (%coerce-callable-to-fun ,key)
 988          #'identity)))
 989
 990 (macrolet ((define-find-position (fun-name values-index)
 991              `(deftransform ,fun-name ((item sequence &key
 992                                              from-end (start 0) end
 993                                              key test test-not))
 994                 '(nth-value ,values-index
 995                             (%find-position item sequence
 996                                             from-end start
 997                                             end
 998                                             (effective-find-position-key key)
 999                                             (effective-find-position-test
1000                                              test test-not))))))
1001   (define-find-position find 0)
1002   (define-find-position position 1))
1003
1004 (macrolet ((define-find-position-if (fun-name values-index)
1005              `(deftransform ,fun-name ((predicate sequence &key
1006                                                   from-end (start 0)
1007                                                   end key))
1008                 '(nth-value
1009                   ,values-index
1010                   (%find-position-if (%coerce-callable-to-fun predicate)
1011                                      sequence from-end
1012                                      start end
1013                                      (effective-find-position-key key))))))
1014   (define-find-position-if find-if 0)
1015   (define-find-position-if position-if 1))
1016
1017 ;;; the deprecated functions FIND-IF-NOT and POSITION-IF-NOT. We
1018 ;;; didn't bother to worry about optimizing them, except note that on
1019 ;;; Sat, Oct 06, 2001 at 04:22:38PM +0100, Christophe Rhodes wrote on
1020 ;;; sbcl-devel
1021 ;;;
1022 ;;;     My understanding is that while the :test-not argument is
1023 ;;;     deprecated in favour of :test (complement #'foo) because of
1024 ;;;     semantic difficulties (what happens if both :test and :test-not
1025 ;;;     are supplied, etc) the -if-not variants, while officially
1026 ;;;     deprecated, would be undeprecated were X3J13 actually to produce
1027 ;;;     a revised standard, as there are perfectly legitimate idiomatic
1028 ;;;     reasons for allowing the -if-not versions equal status,
1029 ;;;     particularly remove-if-not (== filter).
1030 ;;;
1031 ;;;     This is only an informal understanding, I grant you, but
1032 ;;;     perhaps it's worth optimizing the -if-not versions in the same
1033 ;;;     way as the others?
1034 ;;;
1035 ;;; FIXME: Maybe remove uses of these deprecated functions (and
1036 ;;; definitely of :TEST-NOT) within the implementation of SBCL.
1037 (macrolet ((define-find-position-if-not (fun-name values-index)
1038                `(deftransform ,fun-name ((predicate sequence &key
1039                                           from-end (start 0)
1040                                           end key))
1041                  '(nth-value
1042                    ,values-index
1043                    (%find-position-if-not (%coerce-callable-to-fun predicate)
1044                     sequence from-end
1045                     start end
1046                     (effective-find-position-key key))))))
1047   (define-find-position-if-not find-if-not 0)
1048   (define-find-position-if-not position-if-not 1))