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