1.0.1.35: propagate (EQL X Y) constraints symmetrically
[sbcl.git] / src / compiler / checkgen.lisp
index 0e02ec2..c70fb35 100644 (file)
 (defun fun-guessed-cost (name)
   (declare (symbol name))
   (let ((info (info :function :info name))
-       (call-cost (template-cost (template-or-lose 'call-named))))
+        (call-cost (template-cost (template-or-lose 'call-named))))
     (if info
-       (let ((templates (fun-info-templates info)))
-         (if templates
-             (template-cost (first templates))
-             (case name
-               (null (template-cost (template-or-lose 'if-eq)))
-               (t call-cost))))
-       call-cost)))
+        (let ((templates (fun-info-templates info)))
+          (if templates
+              (template-cost (first templates))
+              (case name
+                (null (template-cost (template-or-lose 'if-eq)))
+                (t call-cost))))
+        call-cost)))
 
 ;;; Return some sort of guess for the cost of doing a test against
 ;;; TYPE. The result need not be precise as long as it isn't way out
 ;;; templates in the VM definition.
 (defun type-test-cost (type)
   (declare (type ctype type))
-  (or (let ((check (type-check-template type)))
-       (if check
-           (template-cost check)
-           (let ((found (cdr (assoc type *backend-type-predicates*
-                                    :test #'type=))))
-             (if found
-                 (+ (fun-guessed-cost found) (fun-guessed-cost 'eq))
-                 nil))))
+  (or (when (eq type *universal-type*)
+        0)
+      (when (eq type *empty-type*)
+        0)
+      (let ((check (type-check-template type)))
+        (if check
+            (template-cost check)
+            (let ((found (cdr (assoc type *backend-type-predicates*
+                                     :test #'type=))))
+              (if found
+                  (+ (fun-guessed-cost found) (fun-guessed-cost 'eq))
+                  nil))))
       (typecase type
-       (compound-type
-        (reduce #'+ (compound-type-types type) :key 'type-test-cost))
-       (member-type
-        (* (length (member-type-members type))
-           (fun-guessed-cost 'eq)))
-       (numeric-type
-        (* (if (numeric-type-complexp type) 2 1)
-           (fun-guessed-cost
-            (if (csubtypep type (specifier-type 'fixnum)) 'fixnump 'numberp))
-           (+ 1
-              (if (numeric-type-low type) 1 0)
-              (if (numeric-type-high type) 1 0))))
-       (cons-type
-        (+ (type-test-cost (specifier-type 'cons))
-           (fun-guessed-cost 'car)
-           (type-test-cost (cons-type-car-type type))
-           (fun-guessed-cost 'cdr)
-           (type-test-cost (cons-type-cdr-type type))))
-       (t
-        (fun-guessed-cost 'typep)))))
+        (compound-type
+         (reduce #'+ (compound-type-types type) :key 'type-test-cost))
+        (member-type
+         (* (length (member-type-members type))
+            (fun-guessed-cost 'eq)))
+        (numeric-type
+         (* (if (numeric-type-complexp type) 2 1)
+            (fun-guessed-cost
+             (if (csubtypep type (specifier-type 'fixnum)) 'fixnump 'numberp))
+            (+ 1
+               (if (numeric-type-low type) 1 0)
+               (if (numeric-type-high type) 1 0))))
+        (cons-type
+         (+ (type-test-cost (specifier-type 'cons))
+            (fun-guessed-cost 'car)
+            (type-test-cost (cons-type-car-type type))
+            (fun-guessed-cost 'cdr)
+            (type-test-cost (cons-type-cdr-type type))))
+        (t
+         (fun-guessed-cost 'typep)))))
 
 (defun-cached
     (weaken-type :hash-bits 8
   (declare (type ctype type))
   (multiple-value-bind (res count) (values-types type)
     (values (mapcar (lambda (type)
-                     (if (fun-type-p type)
-                         (specifier-type 'function)
-                         type))
-                   res)
-           count)))
+                      (if (fun-type-p type)
+                          (specifier-type 'function)
+                          type))
+                    res)
+            count)))
 
 ;;; Switch to disable check complementing, for evaluation.
 (defvar *complement-type-checks* t)
 
-;;; CONT is a continuation we are doing a type check on and TYPES is a
-;;; list of types that we are checking its values against. If we have
-;;; proven that CONT generates a fixed number of values, then for each
+;;; LVAR is an lvar we are doing a type check on and TYPES is a list
+;;; of types that we are checking its values against. If we have
+;;; proven that LVAR generates a fixed number of values, then for each
 ;;; value, we check whether it is cheaper to then difference between
 ;;; the proven type and the corresponding type in TYPES. If so, we opt
 ;;; for a :HAIRY check with that test negated. Otherwise, we try to do
 ;;; FIXME: I don't quite understand this, but it looks as though
 ;;; that means type checks are weakened when SPEED=3 regardless of
 ;;; the SAFETY level, which is not the right thing to do.
-(defun maybe-negate-check (lvar types original-types force-hairy)
-  (declare (type lvar lvar) (list types))
-  (multiple-value-bind (ptypes count)
-      (no-fun-values-types (lvar-derived-type lvar))
-    (if (eq count :unknown)
-        (if (and (every #'type-check-template types) (not force-hairy))
-            (values :simple types)
-            (values :hairy (mapcar (lambda (x) (list nil x x)) types)))
-        (let ((res (mapcar (lambda (p c a)
-                             (let ((diff (type-difference p c)))
-                               (if (and diff
-                                        (< (type-test-cost diff)
-                                           (type-test-cost c))
-                                        *complement-type-checks*)
-                                   (list t diff a)
-                                   (list nil c a))))
-                           ptypes types original-types)))
-          (cond ((or force-hairy (find-if #'first res))
-                 (values :hairy res))
-                ((every #'type-check-template types)
-                 (values :simple types))
-                (t
-                 (values :hairy res)))))))
+(defun maybe-negate-check (lvar types original-types force-hairy n-required)
+  (declare (type lvar lvar) (list types original-types))
+  (let ((ptypes (values-type-out (lvar-derived-type lvar) (length types))))
+    (multiple-value-bind (hairy-res simple-res)
+        (loop for p in ptypes
+              and c in types
+              and a in original-types
+              and i from 0
+              for cc = (if (>= i n-required)
+                           (type-union c (specifier-type 'null))
+                           c)
+              for diff = (type-difference p cc)
+              collect (if (and diff
+                               (< (type-test-cost diff)
+                                  (type-test-cost cc))
+                               *complement-type-checks*)
+                          (list t diff a)
+                          (list nil cc a))
+              into hairy-res
+              collect cc into simple-res
+              finally (return (values hairy-res simple-res)))
+      (cond ((or force-hairy (find-if #'first hairy-res))
+             (values :hairy hairy-res))
+            ((every #'type-check-template simple-res)
+             (values :simple simple-res))
+            (t
+             (values :hairy hairy-res))))))
 
-;;; Determines whether CONT's assertion is:
+;;; Determines whether CAST's assertion is:
 ;;;  -- checkable by the back end (:SIMPLE), or
-;;;  -- not checkable by the back end, but checkable via an explicit 
+;;;  -- not checkable by the back end, but checkable via an explicit
 ;;;     test in type check conversion (:HAIRY), or
 ;;;  -- not reasonably checkable at all (:TOO-HAIRY).
 ;;;
-;;; A type is checkable if it either represents a fixed number of
-;;; values (as determined by VALUES-TYPES), or it is the assertion for
-;;; an MV-BIND. A type is simply checkable if all the type assertions
-;;; have a TYPE-CHECK-TEMPLATE. In this :SIMPLE case, the second value
-;;; is a list of the type restrictions specified for the leading
-;;; positional values.
+;;; We may check only fixed number of values; in any case the number
+;;; of generated values is trusted. If we know the number of produced
+;;; values, all of them are checked; otherwise if we know the number
+;;; of consumed -- only they are checked; otherwise the check is not
+;;; performed.
+;;;
+;;; A type is simply checkable if all the type assertions have a
+;;; TYPE-CHECK-TEMPLATE. In this :SIMPLE case, the second value is a
+;;; list of the type restrictions specified for the leading positional
+;;; values.
+;;;
+;;; Old comment:
 ;;;
-;;; We force a check to be hairy even when there are fixed values if
-;;; we are in a context where we may be forced to use the unknown
-;;; values convention anyway. This is because IR2tran can't generate
-;;; type checks for unknown values continuations but people could
-;;; still be depending on the check being done. We only care about
-;;; EXIT and RETURN (not MV-COMBINATION) since these are the only
-;;; contexts where the ultimate values receiver
+;;;    We force a check to be hairy even when there are fixed values
+;;;    if we are in a context where we may be forced to use the
+;;;    unknown values convention anyway. This is because IR2tran can't
+;;;    generate type checks for unknown values lvars but people could
+;;;    still be depending on the check being done. We only care about
+;;;    EXIT and RETURN (not MV-COMBINATION) since these are the only
+;;;    contexts where the ultimate values receiver
 ;;;
 ;;; In the :HAIRY case, the second value is a list of triples of
 ;;; the form:
 ;;;
 ;;; If true, the NOT-P flag indicates a test that the corresponding
 ;;; value is *not* of the specified TYPE. ORIGINAL-TYPE is the type
-;;; asserted on this value in the continuation, for use in error
+;;; asserted on this value in the lvar, for use in error
 ;;; messages. When NOT-P is true, this will be different from TYPE.
 ;;;
-;;; This allows us to take what has been proven about CONT's type into
-;;; consideration. If it is cheaper to test for the difference between
-;;; the derived type and the asserted type, then we check for the
-;;; negation of this type instead.
+;;; This allows us to take what has been proven about CAST's argument
+;;; type into consideration. If it is cheaper to test for the
+;;; difference between the derived type and the asserted type, then we
+;;; check for the negation of this type instead.
 (defun cast-check-types (cast force-hairy)
   (declare (type cast cast))
   (let* ((ctype (coerce-to-values (cast-type-to-check cast)))
          (atype (coerce-to-values (cast-asserted-type cast)))
+         (dtype (node-derived-type cast))
          (value (cast-value cast))
-         (vtype (lvar-derived-type value))
          (lvar (node-lvar cast))
-         (dest (and lvar (lvar-dest lvar))))
+         (dest (and lvar (lvar-dest lvar)))
+         (n-consumed (cond ((not lvar)
+                            nil)
+                           ((lvar-single-value-p lvar)
+                            1)
+                           ((and (mv-combination-p dest)
+                                 (eq (mv-combination-kind dest) :local))
+                            (let ((fun-ref (lvar-use (mv-combination-fun dest))))
+                              (length (lambda-vars (ref-leaf fun-ref)))))))
+         (n-required (length (values-type-required dtype))))
     (aver (not (eq ctype *wild-type*)))
-    (multiple-value-bind (ctypes count) (no-fun-values-types ctype)
-      (multiple-value-bind (atypes acount) (no-fun-values-types atype)
-        (multiple-value-bind (vtypes vcount) (values-types vtype)
-          (declare (ignore vtypes))
-          (aver (eq count acount))
-          (cond ((not (eq count :unknown))
-                 (if (or (exit-p dest)
-                         (and (return-p dest)
-                              (multiple-value-bind (ignore count)
-                                  (values-types (return-result-type dest))
-                                (declare (ignore ignore))
-                                (eq count :unknown))))
-                     (maybe-negate-check value ctypes atypes t)
-                     (maybe-negate-check value ctypes atypes force-hairy)))
-                ((and (lvar-single-value-p lvar)
-                      (or (not (args-type-rest ctype))
-                          (eq (args-type-rest ctype) *universal-type*)))
-                 (principal-lvar-single-valuify lvar)
-                 (let ((creq (car (args-type-required ctype))))
-                   (multiple-value-setq (ctype atype)
-                     (if creq
-                         (values creq (car (args-type-required atype)))
-                         (values (car (args-type-optional ctype))
-                                 (car (args-type-optional atype)))))
-                   (maybe-negate-check value
-                                       (list ctype) (list atype)
-                                       force-hairy)))
-                ((and (mv-combination-p dest)
-                      (eq (mv-combination-kind dest) :local))
-                 (let* ((fun-ref (lvar-use (mv-combination-fun dest)))
-                        (length (length (lambda-vars (ref-leaf fun-ref)))))
-                   (maybe-negate-check value
-                                       ;; FIXME
-                                       (adjust-list (values-type-types ctype)
-                                                    length
-                                                    *universal-type*)
-                                       (adjust-list (values-type-types atype)
-                                                    length
-                                                    *universal-type*)
-                                       force-hairy)))
-                ((not (eq vcount :unknown))
-                 (maybe-negate-check value
-                                     (values-type-out ctype vcount)
-                                     (values-type-out atype vcount)
-                                     t))
-                (t
-                 (values :too-hairy nil))))))))
+    (cond ((and (null (values-type-optional dtype))
+                (not (values-type-rest dtype)))
+           ;; we [almost] know how many values are produced
+           (maybe-negate-check value
+                               (values-type-out ctype n-required)
+                               (values-type-out atype n-required)
+                               ;; backend checks only consumed values
+                               (not (eql n-required n-consumed))
+                               n-required))
+          ((lvar-single-value-p lvar)
+           ;; exactly one value is consumed
+           (principal-lvar-single-valuify lvar)
+           (flet ((get-type (type)
+                    (acond ((args-type-required type)
+                            (car it))
+                           ((args-type-optional type)
+                            (car it))
+                           (t (bug "type ~S is too hairy" type)))))
+             (multiple-value-bind (ctype atype)
+                 (values (get-type ctype) (get-type atype))
+               (maybe-negate-check value
+                                   (list ctype) (list atype)
+                                   force-hairy
+                                   n-required))))
+          ((and (mv-combination-p dest)
+                (eq (mv-combination-kind dest) :local))
+           ;; we know the number of consumed values
+           (maybe-negate-check value
+                               (adjust-list (values-type-types ctype)
+                                            n-consumed
+                                            *universal-type*)
+                               (adjust-list (values-type-types atype)
+                                            n-consumed
+                                            *universal-type*)
+                               force-hairy
+                               n-required))
+          (t
+           (values :too-hairy nil)))))
 
 ;;; Do we want to do a type check?
-(defun worth-type-check-p (cast)
+(defun cast-externally-checkable-p (cast)
   (declare (type cast cast))
   (let* ((lvar (node-lvar cast))
          (dest (and lvar (lvar-dest lvar))))
-    (cond ((not (cast-type-check cast))
-           nil)
-          ((and (combination-p dest)
-                (call-full-like-p dest)
-                ;; The theory is that the type assertion is
-                ;; from a declaration in (or on) the callee,
-                ;; so the callee should be able to do the
-                ;; check. We want to let the callee do the
-                ;; check, because it is possible that by the
-                ;; time of call that declaration will be
-                ;; changed and we do not want to make people
-                ;; recompile all calls to a function when they
-                ;; were originally compiled with a bad
-                ;; declaration. (See also bug 35.)
-                (immediately-used-p lvar cast)
-                (values-subtypep (lvar-externally-checkable-type lvar)
-                                 (cast-type-to-check cast)))
-           nil)
-          (t
-           t))))
+    (and (combination-p dest)
+         ;; The theory is that the type assertion is from a
+         ;; declaration in (or on) the callee, so the callee should be
+         ;; able to do the check. We want to let the callee do the
+         ;; check, because it is possible that by the time of call
+         ;; that declaration will be changed and we do not want to
+         ;; make people recompile all calls to a function when they
+         ;; were originally compiled with a bad declaration. (See also
+         ;; bug 35.)
+         (or (immediately-used-p lvar cast)
+             (binding* ((ctran (node-next cast) :exit-if-null)
+                        (next (ctran-next ctran)))
+               (and (cast-p next)
+                    (eq (node-dest next) dest)
+                    (eq (cast-type-check next) :external))))
+         (values-subtypep (lvar-externally-checkable-type lvar)
+                          (cast-type-to-check cast)))))
 
-;;; Return true if CONT is a continuation whose type the back end is
+;;; Return true if CAST's value is an lvar whose type the back end is
 ;;; likely to want to check. Since we don't know what template the
 ;;; back end is going to choose to implement the continuation's DEST,
 ;;; we use a heuristic. We always return T unless:
 ;;;  -- nobody uses the value, or
 ;;;  -- safety is totally unimportant, or
-;;;  -- the continuation is an argument to an unknown function, or
-;;;  -- the continuation is an argument to a known function that has
+;;;  -- the lvar is an argument to an unknown function, or
+;;;  -- the lvar is an argument to a known function that has
 ;;;     no IR2-CONVERT method or :FAST-SAFE templates that are
 ;;;     compatible with the call's type.
 (defun probable-type-check-p (cast)
           (t t))
     #+nil
     (cond ((or (not dest)
-              (policy dest (zerop safety)))
-          nil)
-         ((basic-combination-p dest)
-          (let ((kind (basic-combination-kind dest)))
-            (cond ((eq cont (basic-combination-fun dest)) t)
-                  ((eq kind :local) t)
-                   ((eq kind :full)
-                    (and (combination-p dest)
-                         (not (values-subtypep ; explicit THE
-                               (continuation-externally-checkable-type cont)
-                               (continuation-type-to-check cont)))))
-
-                  ((eq kind :error) nil)
-                   ;; :ERROR means that we have an invalid syntax of
-                   ;; the call and the callee will detect it before
-                   ;; thinking about types.
-
-                  ((fun-info-ir2-convert kind) t)
-                  (t
-                   (dolist (template (fun-info-templates kind) nil)
-                     (when (eq (template-ltn-policy template) :fast-safe)
-                       (multiple-value-bind (val win)
-                           (valid-fun-use dest (template-type template))
-                         (when (or val (not win)) (return t)))))))))
-         (t t))))
+               (policy dest (zerop safety)))
+           nil)
+          ((basic-combination-p dest)
+           (let ((kind (basic-combination-kind dest)))
+             (cond
+               ((eq cont (basic-combination-fun dest)) t)
+               (t
+                (ecase kind
+                  (:local t)
+                  (:full
+                   (and (combination-p dest)
+                        (not (values-subtypep ; explicit THE
+                              (continuation-externally-checkable-type cont)
+                              (continuation-type-to-check cont)))))
+                  ;; :ERROR means that we have an invalid syntax of
+                  ;; the call and the callee will detect it before
+                  ;; thinking about types.
+                  (:error nil)
+                  (:known
+                   (let ((info (basic-combination-fun-info dest)))
+                     (if (fun-info-ir2-convert info)
+                         t
+                         (dolist (template (fun-info-templates info) nil)
+                           (when (eq (template-ltn-policy template)
+                                     :fast-safe)
+                             (multiple-value-bind (val win)
+                                 (valid-fun-use dest (template-type template))
+                               (when (or val (not win)) (return t)))))))))))))
+          (t t))))
 
 ;;; Return a lambda form that we can convert to do a hairy type check
 ;;; of the specified TYPES. TYPES is a list of the format returned by
-;;; CONTINUATION-CHECK-TYPES in the :HAIRY case.
+;;; LVAR-CHECK-TYPES in the :HAIRY case.
 ;;;
 ;;; Note that we don't attempt to check for required values being
 ;;; unsupplied. Such checking is impossible to efficiently do at the
                  types)
        (values ,@temps))))
 
-;;; Splice in explicit type check code immediately before the node
-;;; which is CONT's DEST. This code receives the value(s) that were
-;;; being passed to CONT, checks the type(s) of the value(s), then
-;;; passes them on to CONT.
+;;; Splice in explicit type check code immediately before CAST. This
+;;; code receives the value(s) that were being passed to CAST-VALUE,
+;;; checks the type(s) of the value(s), then passes them further.
 (defun convert-type-check (cast types)
   (declare (type cast cast) (type list types))
   (let ((value (cast-value cast))
     (setf (cast-%type-check cast) nil)
     (let* ((atype (cast-asserted-type cast))
            (atype (cond ((not (values-type-p atype))
-                        atype)
-                       ((= length 1)
+                         atype)
+                        ((= length 1)
                          (single-value-type atype))
                         (t
-                        (make-values-type
+                         (make-values-type
                           :required (values-type-out atype length)))))
            (dtype (node-derived-type cast))
            (dtype (make-values-type
                                    (leaf-source-name (elt (lambda-vars lambda)
                                                           pos)))))))
             (cond ((and (ref-p use) (constant-p (ref-leaf use)))
-                   (compiler-warn "~:[This~;~:*~A~] is not a ~<~%~9T~:;~S:~>~%  ~S"
-                                  what atype-spec (constant-value (ref-leaf use))))
+                   (warn 'type-warning
+                         :format-control
+                         "~:[This~;~:*~A~] is not a ~<~%~9T~:;~S:~>~%  ~S"
+                         :format-arguments
+                         (list what atype-spec
+                               (constant-value (ref-leaf use)))))
                   (t
-                   (compiler-warn
-                    "~:[Result~;~:*~A~] is a ~S, ~<~%~9T~:;not a ~S.~>"
-                    what (type-specifier dtype) atype-spec))))))))
+                   (warn 'type-warning
+                         :format-control
+                         "~:[Result~;~:*~A~] is a ~S, ~<~%~9T~:;not a ~S.~>"
+                         :format-arguments
+                         (list what (type-specifier dtype) atype-spec)))))))))
   (values))
 
 ;;; Loop over all blocks in COMPONENT that have TYPE-CHECK set,
-;;; looking for continuations with TYPE-CHECK T. We do two mostly
-;;; unrelated things: detect compile-time type errors and determine if
-;;; and how to do run-time type checks.
+;;; looking for CASTs with TYPE-CHECK T. We do two mostly unrelated
+;;; things: detect compile-time type errors and determine if and how
+;;; to do run-time type checks.
 ;;;
-;;; If there is a compile-time type error, then we mark the
-;;; continuation and emit a warning if appropriate. This part loops
-;;; over all the uses of the continuation, since after we convert the
-;;; check, the :DELETED kind will inhibit warnings about the types of
-;;; other uses.
+;;; If there is a compile-time type error, then we mark the CAST and
+;;; emit a warning if appropriate. This part loops over all the uses
+;;; of the continuation, since after we convert the check, the
+;;; :DELETED kind will inhibit warnings about the types of other uses.
 ;;;
-;;; If a continuation is too complex to be checked by the back end, or
-;;; is better checked with explicit code, then convert to an explicit
+;;; If the cast is too complex to be checked by the back end, or is
+;;; better checked with explicit code, then convert to an explicit
 ;;; test. Assertions that can checked by the back end are passed
 ;;; through. Assertions that can't be tested are flamed about and
 ;;; marked as not needing to be checked.
   (collect ((casts))
     (do-blocks (block component)
       (when (block-type-check block)
-       (do-nodes (node nil block)
+        ;; CAST-EXTERNALLY-CHECKABLE-P wants the backward pass
+        (do-nodes-backwards (node nil block)
           (when (and (cast-p node)
                      (cast-type-check node))
             (cast-check-uses node)
-            (cond ((worth-type-check-p node)
-                   (casts (cons node (not (probable-type-check-p node)))))
+            (cond ((cast-externally-checkable-p node)
+                   (setf (cast-%type-check node) :external))
                   (t
-                   (setf (cast-%type-check node) nil)
-                   (setf (cast-type-to-check node) *wild-type*)))))
-       (setf (block-type-check block) nil)))
+                   ;; it is possible that NODE was marked :EXTERNAL by
+                   ;; the previous pass
+                   (setf (cast-%type-check node) t)
+                   (casts (cons node (not (probable-type-check-p node))))))))
+        (setf (block-type-check block) nil)))
     (dolist (cast (casts))
       (destructuring-bind (cast . force-hairy) cast
         (multiple-value-bind (check types)