;;;; This file contains code which knows about both the type
;;;; representation and the compiler IR1 representation. This stuff is
;;;; used for doing type checking.

;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.

;;;; FIXME: This is a poor name for this file, since CTYPE is the name
;;;; of the type used internally to represent Lisp types. It'd
;;;; probably be good to rename this file to "call-type.lisp" or
;;;; "ir1-type.lisp" or something.

(in-package "SB-C")

(declaim (type (or function null) *lossage-fun* *unwinnage-fun* *ctype-test-fun*))

;;; These are the functions that are to be called when a problem is
;;; detected. They are passed format arguments. If null, we don't do
;;; anything. The LOSSAGE function is called when something is
;;; definitely incorrect. The UNWINNAGE function is called when it is
;;; somehow impossible to tell whether the call is correct. (Thus,
;;; they should correspond fairly closely to the FAILURE-P and WARNINGS-P
;;; return values of CL:COMPILE and CL:COMPILE-FILE. However, see the
;;; KLUDGE note below for *LOSSAGE-DETECTED*.)
(defvar *lossage-fun*)
(defvar *unwinnage-fun*)

;;; the function that we use for type checking. The derived type is
;;; its first argument and the type we are testing against is its
;;; second argument. The function should return values like CSUBTYPEP.
;;; Can be NIL when no type testing is needed. (When ir1 converting,
;;; as opposed to checking whether an ir1-transform is applicable.)
(defvar *ctype-test-fun*)

;;; *LOSSAGE-DETECTED* is set when a "definite incompatibility" is
;;; detected. *UNWINNAGE-DETECTED* is set when we can't tell whether the
;;; call is compatible or not. Thus, they should correspond very closely
;;; to the FAILURE-P and WARNINGS-P return values of CL:COMPILE and
;;; CL:COMPILE-FILE.) However...
;;;
;;; KLUDGE: Common Lisp is a dynamic language, even if CMU CL was not.
;;; As far as I can see, none of the "definite incompatibilities"
;;; detected in this file are actually definite under the ANSI spec.
;;; They would be incompatibilites if the use were within the same
;;; compilation unit as the contradictory definition (as per the spec
;;; section "3.2.2.3 Semantic Constraints") but the old Python code
;;; doesn't keep track of whether that's the case. So until/unless we
;;; upgrade the code to keep track of that, we have to handle all
;;; these as STYLE-WARNINGs. -- WHN 2001-02-10
(defvar *lossage-detected*)
(defvar *unwinnage-detected*)

;;; Signal a warning if appropriate and set *FOO-DETECTED*.
(defun note-lossage (format-string &rest format-args)
  (declare (explicit-check))
  (setq *lossage-detected* t)
  (when *lossage-fun*
    (apply *lossage-fun* format-string format-args))
  (values))
(defun note-unwinnage (format-string &rest format-args)
  (declare (explicit-check))
  (setq *unwinnage-detected* t)
  (when *unwinnage-fun*
    (apply *unwinnage-fun* format-string format-args))
  (values))


(defun node-asserted-type (node)
  (let ((dtype (node-derived-type node)))
    (or
     (binding* ((lvar (node-lvar node) :exit-if-null)
                (dest (lvar-dest lvar)))
       (when (and (cast-p dest)
                  (eq (cast-type-to-check dest) *wild-type*))
         (values-type-intersection
          dtype (cast-asserted-type dest))))
     dtype)))

;;;; stuff for checking a call against a function type

;;; Determine whether a use of a function is consistent with its type.
;;; These values are returned:
;;;    T, T: the call is definitely valid.
;;;    NIL, T: the call is definitely invalid.
;;;    NIL, NIL: unable to determine whether the call is valid.
;;;
;;; The ARGUMENT-TEST function is used to determine whether an
;;; argument type matches the type we are checking against. Similarly,
;;; the RESULT-TEST is used to determine whether the result type
;;; matches the specified result.
;;;
;;; Unlike the argument test, the result test may be called on values
;;; or function types. NODE-DERIVED-TYPE is intersected with the
;;; trusted asserted type.
;;;
;;; The error and warning functions are functions that are called to
;;; explain the result. We bind *COMPILER-ERROR-CONTEXT* to the
;;; combination node so that COMPILER-WARNING and related functions
;;; will do the right thing if they are supplied.
(defun valid-fun-use (call type &key
                      ((:argument-test *ctype-test-fun*) #'csubtypep)
                      (result-test #'values-subtypep)
                      ((:lossage-fun *lossage-fun*))
                      ((:unwinnage-fun *unwinnage-fun*)))
  (declare (type (or function null) result-test) (type combination call)
           ;; FIXME: Could TYPE here actually be something like
           ;; (AND GENERIC-FUNCTION (FUNCTION (T) T))?  How
           ;; horrible...  -- CSR, 2003-05-03
           (type ctype type))
  (let* ((*lossage-detected* nil)
         (*unwinnage-detected* nil)
         (*compiler-error-context* call)
         (args (combination-args call))
         unknown-keys)
    (if (fun-type-p type)
        (let* ((nargs (length args))
               (required (fun-type-required type))
               (min-args (length required))
               (optional (fun-type-optional type))
               (max-args (+ min-args (length optional)))
               (rest (fun-type-rest type))
               (keyp (fun-type-keyp type))
               (fun (combination-fun call)))
          (cond
            ((report-arg-count-mismatch fun nil type nargs nil #'note-lossage))
            (t
             (check-fixed-and-rest args (append required optional) rest)
             (when (and keyp
                        (check-key-args fun args max-args type))
               (setf unknown-keys t))))

          (when result-test
            (let* ((out-type (node-asserted-type call))
                   (return-type (fun-type-returns type)))
              (multiple-value-bind (int win) (funcall result-test out-type return-type)
                (cond ((not win)
                       (note-unwinnage "can't tell whether the result is a ~S"
                                       (type-specifier return-type)))
                      ((not int)
                       (note-lossage "The result is a ~S, not a ~S."
                                     (type-specifier out-type)
                                     (type-specifier return-type))))))))
        (loop for arg in args
              and i from 1
              do (check-arg-type arg *wild-type* i)))
    (awhen (lvar-fun-name (combination-fun call) t)
      (validate-test-and-test-not call)
      (let ((xform (info :function :source-transform it)))
        ;; One more check for structure constructors, because satisfying the
        ;; ftype is not sufficient to ensure that slots get valid defaults.
        (when (typep xform '(cons defstruct-description (eql :constructor)))
          (let ((dd (car xform)))
            (awhen (assq it (dd-constructors dd))
              (check-structure-constructor-call call dd (cdr it)))))))
    (cond (*lossage-detected* (values nil t unknown-keys))
          (*unwinnage-detected* (values nil nil unknown-keys))
          (t (values t t unknown-keys)))))

(defun valid-transform-fun (call type arg-fun result-fun)
  (declare (function arg-fun result-fun))
  (let ((args (combination-args call)))
    (flet ((check (lvar type)
             (if (constant-type-p type)
                 (and (constant-lvar-p lvar)
                      (ctypep (lvar-value lvar)
                              (constant-type-type type)))
                 (funcall arg-fun (lvar-type lvar) type))))
      (and (or (fun-type-wild-args type)
               (and (loop for type in (fun-type-required type)
                          always (and args
                                      (check (pop args) type)))
                    (loop for type in (fun-type-optional type)
                          always (if args
                                     (check (pop args) type)
                                     (return-from valid-transform-fun t)))
                    (or (not args)
                        ;; Assume that validate-call-type has ensured that
                        ;; the keys are all constant.
                        (cond ((fun-type-keyp type)
                               (loop with keywords = (fun-type-keywords type)
                                     for (key value) on args by #'cddr
                                     for info = (find (lvar-value key)
                                                      (fun-type-keywords type)
                                                      :key #'key-info-name)
                                     always (and info
                                                 (check value
                                                        (key-info-type info)))))
                              ((let ((rest (fun-type-rest type)))
                                 (and rest
                                      (or (eq rest *universal-type*)
                                          (loop for arg in args
                                                always (csubtypep (lvar-type arg) rest))))))))))
           (let ((return-type (fun-type-returns type)))
             (or (eq return-type *wild-type*)
                 (funcall result-fun (node-asserted-type call) return-type)))))))

;;;

(defun check-structure-constructor-call (call dd ctor-ll-parts)
  (destructuring-bind (&optional req opt rest keys aux)
      (and (listp ctor-ll-parts) (cdr ctor-ll-parts))
    (declare (ignore rest))
    (let* ((call-args (combination-args call))
           (n-req (length req))
           (keyword-lvars (nthcdr (+ n-req (length opt)) call-args))
           (const-keysp (check-key-args-constant keyword-lvars))
           (n-call-args (length call-args)))
      (dolist (slot (dd-slots dd))
        (let ((name (dsd-name slot))
              (suppliedp :maybe)
              (lambda-list-element nil))
          ;; Ignore &AUX vars - it's not the caller's fault if wrong.
          (unless (find name aux :key (lambda (x) (if (listp x) (car x) x))
                        ;; is this right, or should it be EQ
                        ;; like in DETERMINE-UNSAFE-SLOTS ?
                        :test #'string=)
            (multiple-value-bind (arg position)
                (%find-position name opt nil 0 nil #'parse-optional-arg-spec
                                #'string=)
              (when arg
                (setq suppliedp (< (+ n-req position) n-call-args)
                      lambda-list-element arg)))
            (when (and (eq suppliedp :maybe) const-keysp)
              ;; Deduce the keyword (if any) that initializes this slot.
              (multiple-value-bind (keyword arg)
                  (if (listp ctor-ll-parts)
                      (dolist (arg keys)
                        (multiple-value-bind (key var) (parse-key-arg-spec arg)
                          (when (string= name var) (return (values key arg)))))
                      (values (keywordicate name) t))
                (when arg
                  (setq suppliedp (find-keyword-lvar keyword-lvars keyword)
                        lambda-list-element arg))))
            (when (eq suppliedp nil)
              (let ((initform (if (typep lambda-list-element '(cons t cons))
                                  (second lambda-list-element)
                                  (dsd-default slot))))
                (if (logtest sb-kernel::dsd-default-error (sb-kernel::dsd-bits slot))
                    (note-lossage "The slot ~S default form ~s doesn't match :type ~s"
                                  name
                                  (dsd-default slot)
                                  (dsd-type slot))
                    ;; Return T if value-form definitely does not satisfy
                    ;; the type-check for DSD. Return NIL if we can't decide.
                    (when (if (constantp initform)
                              (not (sb-xc:typep (constant-form-value initform)
                                                (dsd-type slot)))
                              ;; Find uses of nil-returning functions as defaults,
                              ;; like ERROR and MISSING-ARG.
                              (and (sb-kernel::dd-null-lexenv-p dd)
                                   (listp initform)
                                   (let ((f (car initform)))
                                     ;; Don't examine :function :type of macros!
                                     (and (eq (info :function :kind f) :function)
                                          (let ((info (info :function :type f)))
                                            (and (fun-type-p info)
                                                 (type= (fun-type-returns info)
                                                        *empty-type*)))))))
                      (note-lossage "The slot ~S does not have a suitable default, ~
and no value was provided for it." name)))))))))))

;;; Check that the derived type of the LVAR is compatible with TYPE. N
;;; is the arg number, for error message purposes. We return true if
;;; arg is definitely o.k. If the type is a magic CONSTANT-TYPE, then
;;; we check for the argument being a constant value of the specified
;;; type. If there is a manifest type error (DERIVED-TYPE = NIL), then
;;; we flame about the asserted type even when our type is satisfied
;;; under the test.
(defun check-arg-type (lvar type n)
  (declare (type lvar lvar) (type ctype type) (type index n))
  (cond
    ((eq (lvar-type lvar) *empty-type*)
     (note-unwinnage "The ~:R argument never returns a value." n)
     nil)
    ((not *ctype-test-fun*))
    ((not (constant-type-p type))
     (let* ((ctype (lvar-type lvar))
            (int (funcall *ctype-test-fun* ctype type)))
       (cond ((not int)
              (unless (type= ctype (specifier-type '(eql dummy)))
                (note-lossage "The ~:R argument is a ~S, not a ~S."
                              n (type-specifier ctype) (type-specifier type)))
              nil)
             (t t))))
    ((not (constant-lvar-p lvar))
     (note-unwinnage "The ~:R argument is not a constant." n)
     nil)
    (t
     (let ((val (lvar-value lvar))
           (type (constant-type-type type)))
       (multiple-value-bind (res win) (ctypep val type)
         (cond ((not win)
                (note-unwinnage "can't tell whether the ~:R argument is a ~
                                 constant ~S:~%  ~S"
                                n (type-specifier type) val)
                nil)
               ((not res)
                (note-lossage "The ~:R argument is not a constant ~S:~%  ~S"
                              n (type-specifier type) val)
                nil)
               (t t)))))))

;;; Check that each of the type of each supplied argument intersects
;;; with the type specified for that argument. If we can't tell, then
;;; we can complain about the absence of manifest winnage.
(defun check-fixed-and-rest (args types rest)
  (declare (list args types) (type (or ctype null) rest))
  (do ((arg args (cdr arg))
       (type types (cdr type))
       (n 1 (1+ n)))
      ((or (null type) (null arg))
       (when rest
         (dolist (arg arg)
           (check-arg-type arg rest n)
           (incf n))))
    (declare (fixnum n))
    (check-arg-type (car arg) (car type) n))
  (values))

;;; Check that the &KEY args are of the correct type. Each key should
;;; be known and the corresponding argument should be of the correct
;;; type. If the key isn't a constant, then we can't tell, so we can
;;; complain about absence of manifest winnage.
(defun check-key-args (fun args pre-key type)
  (declare (list args) (fixnum pre-key) (type fun-type type))
  (declare (ignorable fun))
  (let (lossages allow-other-keys
        unknown-keys)
    (do ((key (nthcdr pre-key args) (cddr key))
         (n (1+ pre-key) (+ n 2)))
        ((null key))
      (declare (fixnum n))
      (let ((k (first key))
            (v (second key)))
        (cond
          ((not (types-equal-or-intersect (lvar-type k) (specifier-type 'symbol)))
           (note-lossage "The ~:R argument of type ~s cannot be used as a keyword."
                         n (type-specifier (lvar-type k))))
          ((not (constant-lvar-p k))
           (setf unknown-keys t)
           ;; An unknown key may turn out to be :ALLOW-OTHER-KEYS at runtime,
           ;; so we cannot signal full warnings for keys that look bad.
           (unless allow-other-keys
             (setf allow-other-keys :maybe)))
          (t
           (let* ((name (lvar-value k))
                  (info (find name (fun-type-keywords type)
                              :key #'key-info-name)))
             (cond ((eq name :allow-other-keys)
                    (unless allow-other-keys
                      (if (constant-lvar-p v)
                          (setf allow-other-keys (if (lvar-value v)
                                                     :yes
                                                     :no))
                          (setf allow-other-keys :maybe))))
                   ((not info)
                    (unless (fun-type-allowp type)
                      (pushnew name lossages :test #'eq)))
                   (t
                    (check-arg-type (second key) (key-info-type info)
                                    (1+ n)))))))))
    (when (and lossages (member allow-other-keys '(nil :no)))
      (setf lossages (nreverse lossages))
      (let (#-sb-xc-host
            (name (nth-value 1 (lvar-fun-type fun))))
        (cond #-sb-xc-host
              ((or (eq (info :function :type name) :generic-function)
                   (eq (info :function :where-from name) :defined-method))
               (note-key-arg-mismatch name lossages))
              ((cdr lossages)
               (note-lossage "~@<~{~S~^, ~} and ~S are not a known argument keywords.~:@>"
                             (butlast lossages)
                             (car (last lossages))))
              (t
               (note-lossage "~S is not a known argument keyword."
                             (car lossages))))))
    unknown-keys))

;;; Construct a function type from a definition.
;;;
;;; Due to the lack of a (LIST X) type specifier, we can't reconstruct
;;; the &REST type.
(defun definition-type (functional)
  (declare (type functional functional)
           #-sb-xc-host (values fun-type &optional))
  (if (lambda-p functional)
      (make-fun-type
       :required (mapcar #'leaf-type (lambda-vars functional))
       :returns (if (functional-kind-eq functional deleted)
                    *empty-type*
                    (tail-set-type (lambda-tail-set functional))))
      (let ((rest nil))
        (collect ((req)
                  (opt)
                  (keys))
          (dolist (arg (optional-dispatch-arglist functional))
            (let ((info (lambda-var-arg-info arg))
                  (type (leaf-type arg)))
              (if info
                  (ecase (arg-info-kind info)
                    (:required (req type))
                    (:optional (opt type))
                    (:keyword
                     (keys (make-key-info (arg-info-key info) type)))
                    ((:rest :more-context)
                     (setq rest *universal-type*))
                    (:more-count))
                  (req type))))

          (make-fun-type
           :required (req)
           :optional (opt)
           :rest rest
           :keywords (sb-kernel::intern-key-infos (keys))
           :keyp (optional-dispatch-keyp functional)
           :allowp (optional-dispatch-allowp functional)
           :returns (let ((tail-set (lambda-tail-set
                                     (optional-dispatch-main-entry functional))))
                      (if tail-set
                          (tail-set-type tail-set)
                          *wild-type*)))))))

;;;; approximate function types
;;;;
;;;; FIXME: This is stuff to look at when I get around to fixing function
;;;; type inference and declarations.
;;;;
;;;; Approximate function types provide a condensed representation of all the
;;;; different ways that a function has been used. If we have no declared or
;;;; defined type for a function, then we build an approximate function type by
;;;; examining each use of the function. When we encounter a definition or
;;;; proclamation, we can check the actual type for compatibity with the
;;;; previous uses.

(defstruct (approximate-fun-type (:copier nil))
  ;; the smallest and largest numbers of arguments that this function
  ;; has been called with.
  (min-args call-arguments-limit
            :type (integer 0 #.call-arguments-limit))
  (max-args 0
            :type (integer 0 #.call-arguments-limit))
  ;; a list of lists of the all the types that have been used in each
  ;; argument position
  (types () :type list)
  ;; A list of APPROXIMATE-KEY-INFO structures describing all the
  ;; things that looked like &KEY arguments. There are distinct
  ;; structures describing each argument position in which the keyword
  ;; appeared.
  (keys () :type list))

(defstruct (approximate-key-info (:copier nil))
  ;; The keyword name of this argument. Although keyword names don't
  ;; have to be keywords, we only match on keywords when figuring an
  ;; approximate type.
  (name (missing-arg) :type keyword)
  ;; The position at which this keyword appeared. 0 if it appeared as the
  ;; first argument, etc.
  (position (missing-arg)
            :type (integer 0 #.call-arguments-limit))
  ;; a list of all the argument types that have been used with this keyword
  (types nil :type list)
  ;; true if this keyword has appeared only in calls with an obvious
  ;; :ALLOW-OTHER-KEYS
  (allowp nil :type (member t nil)))

;;; Return an APPROXIMATE-FUN-TYPE representing the context of
;;; CALL. If TYPE is supplied and not null, then we merge the
;;; information into the information already accumulated in TYPE.
(defun note-fun-use (call &optional type)
  (declare (inline make-approximate-key-info
                   make-approximate-fun-type)
           (sb-c::tlab :system))
  (declare (type combination call)
           (type (or approximate-fun-type null) type)
           #-sb-xc-host
           (values approximate-fun-type))
  (let* ((type (or type (make-approximate-fun-type)))
         (types (approximate-fun-type-types type))
         (args (combination-args call))
         (nargs (length args))
         (allowp (some (lambda (x)
                         (and (constant-lvar-p x)
                              (eq (lvar-value x) :allow-other-keys)))
                       args)))

    (setf (approximate-fun-type-min-args type)
          (min (approximate-fun-type-min-args type) nargs))
    (setf (approximate-fun-type-max-args type)
          (max (approximate-fun-type-max-args type) nargs))

    (do ((old types (cdr old))
         (arg args (cdr arg)))
        ((null old)
         (setf (approximate-fun-type-types type)
               (nconc types
                      (mapcar (lambda (x)
                                (list (lvar-type x)))
                              arg))))
      (when (null arg) (return))
      (pushnew (lvar-type (car arg))
               (car old)
               :test #'type=))

    (collect ((keys (approximate-fun-type-keys type) cons))
      (do ((arg args (cdr arg))
           (pos 0 (1+ pos)))
          ((or (null arg) (null (cdr arg)))
           (setf (approximate-fun-type-keys type) (keys)))
        (let ((key (first arg))
              (val (second arg)))
          (when (constant-lvar-p key)
            (let ((name (lvar-value key)))
              (when (keywordp name)
                (let ((old (find-if
                            (lambda (x)
                              (and (eq (approximate-key-info-name x) name)
                                   (= (approximate-key-info-position x)
                                      pos)))
                            (keys)))
                      (val-type (lvar-type val)))
                  (cond (old
                         (pushnew val-type
                                  (approximate-key-info-types old)
                                  :test #'type=)
                         (unless allowp
                           (setf (approximate-key-info-allowp old) nil)))
                        (t
                         (keys (make-approximate-key-info
                                :name name
                                :position pos
                                :allowp allowp
                                :types (list val-type))))))))))))
    type))

;;; This is similar to VALID-FUN-USE, but checks an
;;; APPROXIMATE-FUN-TYPE against a real function type.
(defun valid-approximate-type (call-type type &optional
                                         (*ctype-test-fun*
                                          #'types-equal-or-intersect)
                                         (*lossage-fun*
                                          #'compiler-style-warn)
                                         (*unwinnage-fun* #'compiler-notify))
  (declare (type approximate-fun-type call-type)
           (type fun-type type)
           (function *ctype-test-fun* *lossage-fun* *unwinnage-fun*)
           #-sb-xc-host
           (values boolean boolean))
  (let* ((*lossage-detected* nil)
         (*unwinnage-detected* nil)
         (required (fun-type-required type))
         (min-args (length required))
         (optional (fun-type-optional type))
         (max-args (+ min-args (length optional)))
         (rest (fun-type-rest type))
         (keyp (fun-type-keyp type)))

    (when (fun-type-wild-args type)
      (return-from valid-approximate-type (values t t)))

    (let ((call-min (approximate-fun-type-min-args call-type)))
      (when (< call-min min-args)
        (note-lossage
         "~:@<The function was previously called with ~R argument~:P, ~
          but wants at least ~R.~:>"
         call-min min-args)))

    (let ((call-max (approximate-fun-type-max-args call-type)))
      (cond ((<= call-max max-args))
            ((not (or keyp rest))
             (note-lossage
              "~:@<The function was previously called with ~R argument~:P, ~
                but wants at most ~R.~:>"
              call-max max-args))
            ((and keyp (oddp (- call-max max-args)))
             (note-lossage
              "~:@<The function was previously called with an odd number of ~
               arguments in the keyword portion.~:>")))

      (when (and keyp (> call-max max-args))
        (check-approximate-keywords call-type max-args type)))

    (check-approximate-fixed-and-rest call-type (append required optional)
                                      rest)

    (cond (*lossage-detected* (values nil t))
          (*unwinnage-detected* (values nil nil))
          (t (values t t)))))

;;; Check that each of the types used at each arg position is
;;; compatible with the actual type.
(defun check-approximate-fixed-and-rest (call-type fixed rest)
  (declare (type approximate-fun-type call-type)
           (list fixed)
           (type (or ctype null) rest))
  (do ((types (approximate-fun-type-types call-type) (cdr types))
       (n 1 (1+ n))
       (arg fixed (cdr arg)))
      ((null types))
    (let ((decl-type (or (car arg) rest)))
      (unless decl-type (return))
      (check-approximate-arg-type (car types) decl-type "~:R" n)))
  (values))

;;; Check that each of the call-types is compatible with DECL-TYPE,
;;; complaining if not or if we can't tell.
(defun check-approximate-arg-type (call-types decl-type context &rest args)
  (declare (list call-types) (type ctype decl-type) (string context))
  (when *ctype-test-fun*
    (let ((losers *empty-type*))
      (dolist (ctype call-types)
        (multiple-value-bind (int win) (funcall *ctype-test-fun* ctype decl-type)
          (cond
            ((not win)
             (note-unwinnage "can't tell whether previous ~? ~
                           argument type ~S is a ~S"
                             context
                             args
                             (type-specifier ctype)
                             (type-specifier decl-type)))
            ((not int)
             (setq losers (type-union ctype losers))))))

      (unless (eq losers *empty-type*)
        (note-lossage "~:(~?~) argument should be a ~S but was a ~S in a previous call."
                      context args (type-specifier decl-type) (type-specifier losers)))))
  (values))

;;; Check the types of each manifest keyword that appears in a keyword
;;; argument position. Check the validity of all keys that appeared in
;;; valid keyword positions.
;;;
;;; ### We could check the APPROXIMATE-FUN-TYPE-TYPES to make
;;; sure that all arguments in keyword positions were manifest
;;; keywords.
(defun check-approximate-keywords (call-type max-args type)
  (let ((call-keys (approximate-fun-type-keys call-type))
        (keys (fun-type-keywords type)))
    (dolist (key keys)
      (let ((name (key-info-name key)))
        (collect ((types nil append))
          (dolist (call-key call-keys)
            (let ((pos (approximate-key-info-position call-key)))
              (when (and (eq (approximate-key-info-name call-key) name)
                         (> pos max-args) (evenp (- pos max-args)))
                (types (approximate-key-info-types call-key)))))
          (check-approximate-arg-type (types) (key-info-type key) "~S" name))))

    (unless (fun-type-allowp type)
      (collect ((names () adjoin))
        (dolist (call-key call-keys)
          (let ((pos (approximate-key-info-position call-key)))
            (when (and (> pos max-args) (evenp (- pos max-args))
                       (not (approximate-key-info-allowp call-key)))
              (names (approximate-key-info-name call-key)))))

        (dolist (name (names))
          (unless (find name keys :key #'key-info-name)
            (note-lossage "Function previously called with unknown argument keyword ~S."
                  name)))))))

;;;; ASSERT-DEFINITION-TYPE

;;; Intersect LAMBDA's var types with TYPES, giving a warning if there
;;; is a mismatch. If all intersections are non-null, we return lists
;;; of the variables and intersections, otherwise we return NIL, NIL.
(defun try-type-intersections (vars types where)
  (declare (list vars types) (string where))
  (collect ((res))
    (mapc (lambda (var type)
            (let* ((vtype (leaf-type var))
                   (int (type-approx-intersection2 vtype type)))
              (cond
               ((eq int *empty-type*)
                (note-lossage
                 "Definition's declared type for variable ~A:~%  ~S~@
                  conflicts with this type from ~A:~%  ~S"
                 (leaf-debug-name var) (type-specifier vtype)
                 where (type-specifier type))
                (return-from try-type-intersections (values nil nil)))
               (t
                (res int)))))
          vars types)
    (values vars (res))))

;;; Check that the optional-dispatch OD conforms to TYPE. We return
;;; the values of TRY-TYPE-INTERSECTIONS if there are no syntax
;;; problems, otherwise NIL, NIL.
;;;
;;; Note that the variables in the returned list are the actual
;;; original variables (extracted from the optional dispatch arglist),
;;; rather than the variables that are arguments to the main entry.
;;; This difference is significant only for &KEY args with hairy
;;; defaults. Returning the actual vars allows us to use the right
;;; variable name in warnings.
;;;
;; Despite FTYPE proclamations affecting only the calls and not the
;; function itself, it would be very weird to see a default of &key or
;; &optional be different from the proclaimed type. Accept NULL only
;; when there's no default form.
(defun find-optional-dispatch-types (od type where)
  (declare (type optional-dispatch od)
           (type fun-type type)
           (string where))
  (let ((od-min (optional-dispatch-min-args od))
        (od-max (optional-dispatch-max-args od))
        (od-more (optional-dispatch-more-entry od))
        (od-keyp (optional-dispatch-keyp od))
        (od-allowp (optional-dispatch-allowp od))
        (type-required (fun-type-required type))
        (type-optional (fun-type-optional type))
        (type-rest (fun-type-rest type))
        (type-keyp (fun-type-keyp type))
        (type-allowp (fun-type-allowp type)))
    (flet ((check-num (num-definition num-type arg-kind)
             (unless (= num-definition num-type)
               (note-lossage
                "The definition has ~R ~A arg~P, but ~A has ~R."
                num-definition arg-kind num-definition where num-type)))
           (check-section (in-od-p in-type-p section)
             (unless (eq in-od-p in-type-p)
               (note-lossage
                "The definition ~:[doesn't have~;has~] ~A, but ~
                 ~A ~:[doesn't~;does~]."
                in-od-p section where in-type-p))))
      (check-num od-min (length type-required) 'required)
      ;; When TYPE does not have &OPTIONAL parameters and the type of
      ;; the &REST parameter is T, it may have been simplified from
      ;;
      ;;   (function (... &optional t &rest t ...) ...)
      ;;
      ;; We cannot check the exact number of optional parameters then.
      (unless (and (not type-optional)
                   type-rest (type= type-rest *universal-type*))
        (check-num (- od-max od-min) (length type-optional) '&optional))
      (check-section od-keyp type-keyp "&KEY arguments")
      (unless od-keyp
        (check-section (not (null od-more)) (not (null type-rest))
                       "&REST argument"))
      (check-section od-allowp type-allowp '&allow-other-keys))

    (when *lossage-detected*
      (return-from find-optional-dispatch-types (values nil nil)))

    (collect ((res)
              (vars))
      (let ((keys (fun-type-keywords type))
            (arglist (optional-dispatch-arglist od)))
        (dolist (arg arglist)
          (cond
            ((lambda-var-arg-info arg)
             (let* ((info (lambda-var-arg-info arg))
                    (default-p (arg-info-default-p info)))
               (ecase (arg-info-kind info)
                 (:keyword
                  (let* ((key (arg-info-key info))
                         (kinfo (find key keys :key #'key-info-name)))
                    (cond
                      (kinfo
                       (res (if default-p
                                (key-info-type kinfo)
                                (type-union (key-info-type kinfo)
                                            (specifier-type 'null)))))
                      (t
                       (note-lossage
                        "Defining a ~S keyword not present in ~A."
                        key where)
                       (res *universal-type*)))))
                 (:required (res (pop type-required)))
                 (:optional
                  ;; We can exhaust TYPE-OPTIONAL when the type was
                  ;; simplified as described above.
                  (res (let ((type (or (pop type-optional)
                                       *universal-type*)))
                         (if default-p
                             type
                             (type-union type
                                         (specifier-type 'null))))))
                 (:rest
                  (when (fun-type-rest type)
                    (res (specifier-type 'list))))
                 (:more-context
                  (when (fun-type-rest type)
                    (res *universal-type*)))
                 (:more-count
                  (when (fun-type-rest type)
                    (res (specifier-type 'fixnum)))))
               (vars arg)
               (when (arg-info-supplied-p info)
                 (res *universal-type*)
                 (vars (arg-info-supplied-p info)))))
            (t
             (res (pop type-required))
             (vars arg))))

        (dolist (key keys)
          (unless (find (key-info-name key) arglist
                        :key (lambda (x)
                               (let ((info (lambda-var-arg-info x)))
                                 (when info
                                   (arg-info-key info)))))
            (note-lossage
             "The definition lacks the ~S key present in ~A."
             (key-info-name key) where))))

      (try-type-intersections (vars) (res) where))))

;;; Check that TYPE doesn't specify any funny args, and do the
;;; intersection.
(defun find-lambda-types (lambda type where)
  (declare (type clambda lambda) (type fun-type type) (string where))
  (flet ((frob (x what)
           (when x
             (note-lossage
              "The definition has no ~A, but the ~A did."
              what where))))
    (frob (fun-type-optional type) "&OPTIONAL arguments")
    (frob (fun-type-keyp type) "&KEY arguments")
    (frob (fun-type-rest type) "&REST argument"))
  (let* ((vars (lambda-vars lambda))
         (nvars (length vars))
         (req (fun-type-required type))
         (nreq (length req)))
    (unless (= nvars nreq)
      (note-lossage "The definition has ~R arg~:P, but the ~A has ~R."
                    nvars where nreq))
    (if *lossage-detected*
        (values nil nil)
        (try-type-intersections vars req where))))

;;; Check for syntactic and type conformance between the definition
;;; FUNCTIONAL and the specified FUN-TYPE. If they are compatible
;;; and REALLY-ASSERT is T, then add type assertions to the definition
;;; from the FUN-TYPE.
;;;
;;; If there is a syntactic or type problem, then we call
;;; LOSSAGE-FUN with an error message using WHERE as context
;;; describing where FUN-TYPE came from.
;;;
;;; If there is no problem, we return T (even if REALLY-ASSERT was
;;; false). If there was a problem, we return NIL.
(defun assert-definition-type
    (functional type &key (really-assert t)
                          ((:lossage-fun *lossage-fun*) #'compiler-style-warn)
                          unwinnage-fun
                          (where "previous declaration"))
  (declare (type functional functional)
           (type function *lossage-fun*)
           (string where))
  (unless (fun-type-p type)
    (return-from assert-definition-type t))
  (let ((*lossage-detected* nil))
    (multiple-value-bind (vars types)
        (if (fun-type-wild-args type)
            (values nil nil)
            (etypecase functional
              (optional-dispatch
               (find-optional-dispatch-types functional type where))
              (clambda
               (find-lambda-types functional type where))))
      (let* ((type-returns (fun-type-returns type))
             (return (lambda-return (main-entry functional)))
             (dtype (when return
                      (lvar-derived-type (return-result return)))))
        (cond
          (really-assert
           ;; REALLY-ASSERT can be T or `(:NOT . ,vars) where the latter is
           ;; a list of vars for which compiling will *not* generate
           ;; an automatic check.
           (let ((policy (lexenv-policy (functional-lexenv functional))))
             (when (and return
                        (or (eq really-assert t)
                            (not (member :result (cdr really-assert)))))
               (assert-lvar-type (return-result return) type-returns
                                 policy
                                 'ftype-context)))
           (loop for var in vars
                 for type in types do
                 (cond ((basic-var-sets var)
                        (when (and unwinnage-fun
                                   (not (csubtypep (leaf-type var) type)))
                          (funcall unwinnage-fun
                                   (sb-format:tokens
                                      "Assignment to argument: ~S~%  ~
                                       prevents use of assertion from function ~
                                       type ~A:~% ~/sb-impl:print-type/~%")
                                   (leaf-debug-name var) where type)))
                       ((and (listp really-assert) ; (:NOT . ,vars)
                             (member (lambda-var-%source-name var)
                                     (cdr really-assert)))) ; do nothing
                       (t
                        (setf (leaf-type var) type)
                        (let ((s-type (make-single-value-type type)))
                          (dolist (ref (leaf-refs var))
                            (derive-node-type ref s-type))))))
           t)
          ((and dtype
                (not (values-types-equal-or-intersect dtype
                                                      type-returns)))
           (note-lossage
            "The result type from ~A:~%  ~
             ~/sb-impl:print-type/~@
             conflicts with the definition's result type:~%  ~
             ~/sb-impl:print-type/"
            where type-returns dtype)
           nil)
          (t
           t))))))

;;; Manipulate the poorly-named :REALLY-ASSERT value.
;;; It would make sense to pass the opposite sense of the arg
;;; (as ":SKIP-CHECKS") corresponding to the declaration.
(defun explicit-check->really-assert (explicit-check)
  (case explicit-check
    ((nil) t)
    ((t) nil)
    (t `(:not . ,explicit-check))))

;;; If the function has both &REST and &KEY, FIND-OPTIONAL-DISPATCH-TYPES
;;; doesn't complain about the type missing &REST -- which is good, because in
;;; that case &REST is really an implementation detail and not part of the
;;; interface. However since we set the leaf type missing &REST from there
;;; would be a bad thing -- to make up a new type if necessary.
(defun massage-global-definition-type (type fun)
  (if (and (fun-type-p type)
           (optional-dispatch-p fun)
           (optional-dispatch-keyp fun)
           (optional-dispatch-more-entry fun)
           (not (or (fun-type-rest type)
                    (fun-type-wild-args type))))
      (make-fun-type :required (fun-type-required type)
                     :optional (fun-type-optional type)
                     :rest *universal-type*
                     :keyp (fun-type-keyp type)
                     :keywords (fun-type-keywords type)
                     :allowp (fun-type-allowp type)
                     :returns (fun-type-returns type))
      type))


(defun single-value-args (call)
  (let ((args (basic-combination-args call)))
   (if (mv-combination-p call)
       (loop for arg in args
             while (type-single-value-p (lvar-derived-type arg))
             collect arg)
       args)))

;;; Call FUN with (arg-lvar arg-type lvars &optional annotation)
(defun map-combination-args-and-types (fun call &key info
                                                     unknown-keys-fun
                                                     defined-here
                                                     asserted-type
                                                     type)
  (declare (type function fun)
           (type basic-combination call))
  (binding* ((type (or type
                       (lvar-fun-type (basic-combination-fun call) defined-here asserted-type)))
             (nil (fun-type-p type) :exit-if-null)
             (annotation (and info
                              (fun-info-annotation info)))
             (args (single-value-args call))
             ((arg-lvars unknown-keys)
              (resolve-key-args args type))
             (i -1))
    (flet ((positional-annotation ()
             (and annotation
                  (cdr (assoc (incf i)
                              (fun-type-annotation-positional annotation)))))
           (key-annotation (key)
             (and annotation
                  (getf (fun-type-annotation-key annotation) key)))
           (call (arg type &optional annotation)
             (funcall fun arg type arg-lvars annotation)))
      (dolist (req (fun-type-required type))
        (when (null args) (return-from map-combination-args-and-types))
        (let ((arg (pop args)))
          (call arg req (positional-annotation))))
      (dolist (opt (fun-type-optional type))
        (when (null args) (return-from map-combination-args-and-types))
        (let ((arg (pop args)))
          (call arg opt (positional-annotation))))

      (let ((annotation (and annotation
                             (fun-type-annotation-rest annotation)))
            (rest (or (fun-type-rest type)
                      (and annotation
                           *universal-type*))))
        (when (and rest
                   (or annotation
                       (neq rest *universal-type*)))
          (let ((butlast (getf (cddr annotation) :butlast)))
            (loop for (arg . next) on args
                  when (or (not butlast)
                           next)
                  do
                  (call arg rest annotation)))))

      (let ((key-args (nthcdr (+ (length (fun-type-optional type))
                                 (length (fun-type-required type)))
                              arg-lvars)))
        (dolist (key (fun-type-keywords type))
          (let* ((name (key-info-name key))
                 (lvar (getf key-args name)))
            (when lvar
              (call lvar (key-info-type key) (key-annotation name)))))
        (when (and unknown-keys-fun
                   unknown-keys)
          (funcall unknown-keys-fun unknown-keys))))))

(defun assert-array-index-lvar-type (lvar type policy)
  (let ((internal-lvar (make-lvar))
        (dest (lvar-dest lvar)))
    (substitute-lvar internal-lvar lvar)
    (with-ir1-environment-from-node dest
      (let ((cast (make-array-index-cast
                   :asserted-type type
                   :type-to-check (maybe-weaken-check type policy)
                   :value lvar
                   :derived-type (coerce-to-values type))))
        (%insert-cast-before dest cast)
        (use-lvar cast internal-lvar)
        t))))

(defun apply-type-annotation (fun-name arg type lvars policy &optional annotation context)
  (case (car annotation)
    ((function function-designator)
     (assert-function-designator fun-name lvars arg (cdr annotation) policy)
     t)
    (t
     (case (car annotation)
       (modifying
        (when (policy policy (> check-constant-modification 0))
          (add-annotation arg
                          (make-lvar-modified-annotation :caller fun-name))))
       (type-specifier
        (add-annotation arg
                        (make-lvar-type-spec-annotation
                         :hook
                         (lambda (value)
                           (unless (and (eql value :default)
                                        (eq fun-name 'open))
                             (compiler-specifier-type value))))))
       ((proper-list proper-sequence
                     proper-or-circular-list proper-or-dotted-list)
        (add-annotation arg
                        (make-lvar-proper-sequence-annotation
                         :kind (car annotation)))))
     (assert-lvar-type arg type policy context))))

;;; Assert that CALL is to a function of the specified TYPE. It is
;;; assumed that the call is legal and has only constants in the
;;; keyword positions.
(defun assert-call-type (call type trusted where-from)
  (declare (type combination call) (type fun-type type))
  (let ((policy (lexenv-policy (node-lexenv call)))
        (returns (fun-type-returns type)))
    (if trusted
        (derive-node-type call returns)
        (let ((lvar (node-lvar call)))
          ;; If the value is used in a non-tail position, and the lvar
          ;; is a single-use, assert the type. Multiple use sites need
          ;; to be elided because the assertion has to apply to all
          ;; uses. Tail positions are elided because the assertion
          ;; would cause us not the be in a tail-position anymore. MV
          ;; calls are elided because not only are the assertions of
          ;; less use there, but they can cause the MV call conversion
          ;; to cause astray.
          (when (and lvar
                     (or (eq where-from :declared-verify)
                         (and (not (return-p (lvar-dest lvar)))
                              (not (mv-combination-p (lvar-dest lvar)))
                              (lvar-has-single-use-p lvar))))
            (when (assert-node-type call returns policy 'ftype-context)
              (reoptimize-lvar lvar)))))
    (let* ((name (lvar-fun-name (combination-fun call) t))
           (info (and name
                      (info :function :info name))))
      (if (and info
               (fun-info-call-type-deriver info))
          (funcall (fun-info-call-type-deriver info) call trusted)
          (map-combination-args-and-types
           (lambda (arg type lvars &optional annotation)
             (when (and
                    (apply-type-annotation name arg type
                                           lvars policy annotation
                                           (and (not trusted)
                                                'ftype-context))
                    (not trusted))
               (reoptimize-lvar arg)))
           call
           :info info
           :defined-here t
           :type type))))
  (values))

;;;; FIXME: Move to some other file.
(defun check-catch-tag-type (tag)
  (declare (type lvar tag))
  (let ((ctype (lvar-type tag)))
    (when (csubtypep ctype (specifier-type '(or number character)))
      (let ((sources (lvar-all-sources tag)))
        (if (singleton-p sources)
            (compiler-style-warn
              "~@<Using ~S of type ~/sb-impl:print-type/ as ~
               a catch tag (which tends to be unportable because THROW ~
               and CATCH use EQ comparison)~@:>"
             (first sources) (lvar-type tag))
            (compiler-style-warn
              "~@<Using ~{~S~^~#[~; or ~:;, ~]~} in ~S of type ~
               ~/sb-impl:print-type/ as a catch tag (which tends to be ~
               unportable because THROW and CATCH use EQ comparison)~@:>"
             (rest sources) (first sources) (lvar-type tag)))))))

(defun %compile-time-type-error (values atype dtype detail code-context cast-context)
  (declare (ignore dtype))
  (cond ((eq cast-context 'ftype-context)
         (error 'simple-type-error
                :datum (car values)
                :expected-type atype
                :format-control
                "~@<Values ~2I~_[~{~S~^ ~}] ~I~_from ~S in~_~A ~
                   ~I~_is not of the declared return type of the function ~
                   ~2I~_~/sb-impl:print-type-specifier/.~:>"
                :format-arguments (list values
                                        (first detail) code-context
                                        atype)))
        ((and (consp atype) (eq (car atype) 'values))
         (if (singleton-p detail)
             (error 'simple-type-error
                    :datum (car values)
                    :expected-type atype
                    :format-control
                    "~@<Values ~2I~_[~{~S~^ ~}] ~I~_from ~S in~_~A ~
                     ~I~_is not of type ~
                    ~2I~_~/sb-impl:print-type-specifier/.~:>"
                    :format-arguments (list values
                                            (first detail) code-context
                                            atype))
             (error 'simple-type-error
                    :datum (car values)
                    :expected-type atype
                    :format-control
                    "~@<Values ~2I~_[~{~S~^ ~}] ~
                   ~I~_from ~2I~_~{~S~^~#[~; or ~:;, ~]~} ~
                   ~I~_of ~2I~_~S ~I~_in~_~A ~I~_is not of type ~
                   ~2I~_~/sb-impl:print-type-specifier/.~:>"
                    :format-arguments (list values
                                            (rest detail) (first detail)
                                            code-context
                                            atype))))
        ((singleton-p detail)
         (error 'simple-type-error
                :datum (car values)
                :expected-type atype
                :format-control
                "~@<Value of ~S in ~_~A ~I~_is ~2I~_~S, ~
                   ~I~_not a ~2I~_~/sb-impl:print-type-specifier/.~:@>"
                :format-arguments (list (car detail) code-context
                                        (car values)
                                        atype)))
        (t
         (error 'simple-type-error
                :datum (car values)
                :expected-type atype
                :format-control
                "~@<Value from ~2I~_~{~S~^~#[~; or ~:;, ~]~} ~
                   ~I~_of ~2I~_~S ~I~_in~_~A ~I~_is ~2I~_~S, ~
                   ~I~_not a ~2I~_~/sb-impl:print-type-specifier/.~:@>"
                :format-arguments (list (rest detail) (first detail) code-context
                                        (car values)
                                        atype)))))

(defun %compile-time-type-error-warn (node atype dtype detail
                                      &key cast-context
                                           (condition 'type-warning))
  (let ((*compiler-error-context* node))
    (cond ((eq atype nil))
          ((eq cast-context 'ftype-context)
           (warn condition
                 :format-control
                 "~@<Derived type of ~/sb-impl:print-type-specifier/ is ~
                    ~2I~_~/sb-impl:print-type-specifier/, ~
                    ~I~_conflicting with the declared function return type ~
                    ~2I~_~/sb-impl:print-type-specifier/.~@:>"
                 :format-arguments (list detail dtype atype)))
          ((singleton-p detail)
           (let ((detail (first detail)))
             (if (constantp detail)
                 (warn condition
                       :format-control
                       "~@<Constant ~2I~_~S ~Iconflicts with its ~
                            asserted type ~
                            ~2I~_~/sb-impl:print-type-specifier/.~@:>"
                       :format-arguments (list (constant-form-value detail) atype))
                 (warn condition
                       :format-control
                       "~@<Derived type of ~/sb-impl:print-type-specifier/ is ~
                            ~2I~_~/sb-impl:print-type-specifier/, ~
                            ~I~_conflicting with its asserted type ~
                            ~2I~_~/sb-impl:print-type-specifier/.~@:>"
                       :format-arguments (list detail dtype atype)))))
          (t
           (warn condition
                 :format-control
                 "~@<Derived type of ~2I~_~{~S~^~#[~; and ~:;, ~
                      ~]~} ~I~_in ~2I~_~S ~I~_is ~
                      ~2I~_~/sb-impl:print-type-specifier/, ~
                      ~I~_conflicting with their asserted type ~
                      ~2I~_~/sb-impl:print-type-specifier/.~@:>"
                 :format-arguments (list (rest detail) (first detail)
                                         dtype atype))))))
