0.pre8.108:
[sbcl.git] / src / compiler / checkgen.lisp
1 ;;;; This file implements type check generation. This is a phase that
2 ;;;; runs at the very end of IR1. If a type check is too complex for
3 ;;;; the back end to directly emit in-line, then we transform the check
4 ;;;; into an explicit conditional using TYPEP.
5
6 ;;;; This software is part of the SBCL system. See the README file for
7 ;;;; more information.
8 ;;;;
9 ;;;; This software is derived from the CMU CL system, which was
10 ;;;; written at Carnegie Mellon University and released into the
11 ;;;; public domain. The software is in the public domain and is
12 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
13 ;;;; files for more information.
14
15 (in-package "SB!C")
16 \f
17 ;;;; cost estimation
18
19 ;;; Return some sort of guess about the cost of a call to a function.
20 ;;; If the function has some templates, we return the cost of the
21 ;;; cheapest one, otherwise we return the cost of CALL-NAMED. Calling
22 ;;; this with functions that have transforms can result in relatively
23 ;;; meaningless results (exaggerated costs.)
24 ;;;
25 ;;; We special-case NULL, since it does have a source tranform and is
26 ;;; interesting to us.
27 (defun fun-guessed-cost (name)
28   (declare (symbol name))
29   (let ((info (info :function :info name))
30         (call-cost (template-cost (template-or-lose 'call-named))))
31     (if info
32         (let ((templates (fun-info-templates info)))
33           (if templates
34               (template-cost (first templates))
35               (case name
36                 (null (template-cost (template-or-lose 'if-eq)))
37                 (t call-cost))))
38         call-cost)))
39
40 ;;; Return some sort of guess for the cost of doing a test against
41 ;;; TYPE. The result need not be precise as long as it isn't way out
42 ;;; in space. The units are based on the costs specified for various
43 ;;; templates in the VM definition.
44 (defun type-test-cost (type)
45   (declare (type ctype type))
46   (or (let ((check (type-check-template type)))
47         (if check
48             (template-cost check)
49             (let ((found (cdr (assoc type *backend-type-predicates*
50                                      :test #'type=))))
51               (if found
52                   (+ (fun-guessed-cost found) (fun-guessed-cost 'eq))
53                   nil))))
54       (typecase type
55         (compound-type
56          (reduce #'+ (compound-type-types type) :key 'type-test-cost))
57         (member-type
58          (* (length (member-type-members type))
59             (fun-guessed-cost 'eq)))
60         (numeric-type
61          (* (if (numeric-type-complexp type) 2 1)
62             (fun-guessed-cost
63              (if (csubtypep type (specifier-type 'fixnum)) 'fixnump 'numberp))
64             (+ 1
65                (if (numeric-type-low type) 1 0)
66                (if (numeric-type-high type) 1 0))))
67         (cons-type
68          (+ (type-test-cost (specifier-type 'cons))
69             (fun-guessed-cost 'car)
70             (type-test-cost (cons-type-car-type type))
71             (fun-guessed-cost 'cdr)
72             (type-test-cost (cons-type-cdr-type type))))
73         (t
74          (fun-guessed-cost 'typep)))))
75
76 (defun-cached
77     (weaken-type :hash-bits 8
78                  :hash-function (lambda (x)
79                                   (logand (type-hash-value x) #xFF)))
80     ((type eq))
81   (declare (type ctype type))
82   (let ((min-cost (type-test-cost type))
83         (min-type type)
84         (found-super nil))
85     (dolist (x *backend-type-predicates*)
86       (let ((stype (car x)))
87         (when (and (csubtypep type stype)
88                    (not (union-type-p stype)))
89           (let ((stype-cost (type-test-cost stype)))
90             (when (or (< stype-cost min-cost)
91                       (type= stype type))
92               ;; If the supertype is equal in cost to the type, we
93               ;; prefer the supertype. This produces a closer
94               ;; approximation of the right thing in the presence of
95               ;; poor cost info.
96               (setq found-super t
97                     min-type stype
98                     min-cost stype-cost))))))
99     (if found-super
100         min-type
101         *universal-type*)))
102
103 (defun weaken-values-type (type)
104   (declare (type ctype type))
105   (cond ((eq type *wild-type*) type)
106         ((values-type-p type)
107          (make-values-type :required (mapcar #'weaken-type
108                                              (values-type-required type))
109                            :optional (mapcar #'weaken-type
110                                              (values-type-optional type))
111                            :rest (acond ((values-type-rest type)
112                                          (weaken-type it))
113                                         ((values-type-keyp type)
114                                          *universal-type*))))
115         (t (weaken-type type))))
116 \f
117 ;;;; checking strategy determination
118
119 ;;; Return the type we should test for when we really want to check
120 ;;; for TYPE. If type checking policy is "fast", then we return a
121 ;;; weaker type if it is easier to check. First we try the defined
122 ;;; type weakenings, then look for any predicate that is cheaper.
123 (defun maybe-weaken-check (type policy)
124   (declare (type ctype type))
125   (ecase (policy policy type-check)
126     (0 *wild-type*)
127     (2 (weaken-values-type type))
128     (3 type)))
129
130 ;;; This is like VALUES-TYPES, only we mash any complex function types
131 ;;; to FUNCTION.
132 (defun no-fun-values-types (type)
133   (declare (type ctype type))
134   (multiple-value-bind (res count) (values-types type)
135     (values (mapcar (lambda (type)
136                       (if (fun-type-p type)
137                           (specifier-type 'function)
138                           type))
139                     res)
140             count)))
141
142 ;;; Switch to disable check complementing, for evaluation.
143 (defvar *complement-type-checks* t)
144
145 ;;; CONT is a continuation we are doing a type check on and TYPES is a
146 ;;; list of types that we are checking its values against. If we have
147 ;;; proven that CONT generates a fixed number of values, then for each
148 ;;; value, we check whether it is cheaper to then difference between
149 ;;; the proven type and the corresponding type in TYPES. If so, we opt
150 ;;; for a :HAIRY check with that test negated. Otherwise, we try to do
151 ;;; a simple test, and if that is impossible, we do a hairy test with
152 ;;; non-negated types. If true, FORCE-HAIRY forces a hairy type check.
153 ;;;
154 ;;; When doing a non-negated check, we call MAYBE-WEAKEN-CHECK to
155 ;;; weaken the test to a convenient supertype (conditional on policy.)
156 ;;; If SPEED is 3, or DEBUG-INFO is not particularly important (DEBUG
157 ;;; <= 1), then we allow weakened checks to be simple, resulting in
158 ;;; less informative error messages, but saving space and possibly
159 ;;; time.
160 ;;;
161 ;;; FIXME: I don't quite understand this, but it looks as though
162 ;;; that means type checks are weakened when SPEED=3 regardless of
163 ;;; the SAFETY level, which is not the right thing to do.
164 (defun maybe-negate-check (cont types original-types force-hairy)
165   (declare (type continuation cont) (list types))
166   (multiple-value-bind (ptypes count)
167       (no-fun-values-types (continuation-proven-type cont))
168     (if (eq count :unknown)
169         (if (and (every #'type-check-template types) (not force-hairy))
170             (values :simple types)
171             (values :hairy (mapcar (lambda (x) (list nil x x)) types)))
172         (let ((res (mapcar (lambda (p c a)
173                              (let ((diff (type-difference p c)))
174                                (if (and diff
175                                         (< (type-test-cost diff)
176                                            (type-test-cost c))
177                                         *complement-type-checks*)
178                                    (list t diff a)
179                                    (list nil c a))))
180                            ptypes types original-types)))
181           (cond ((or force-hairy (find-if #'first res))
182                  (values :hairy res))
183                 ((every #'type-check-template types)
184                  (values :simple types))
185                 (t
186                  (values :hairy res)))))))
187
188 ;;; Determines whether CONT's assertion is:
189 ;;;  -- checkable by the back end (:SIMPLE), or
190 ;;;  -- not checkable by the back end, but checkable via an explicit 
191 ;;;     test in type check conversion (:HAIRY), or
192 ;;;  -- not reasonably checkable at all (:TOO-HAIRY).
193 ;;;
194 ;;; A type is checkable if it either represents a fixed number of
195 ;;; values (as determined by VALUES-TYPES), or it is the assertion for
196 ;;; an MV-BIND. A type is simply checkable if all the type assertions
197 ;;; have a TYPE-CHECK-TEMPLATE. In this :SIMPLE case, the second value
198 ;;; is a list of the type restrictions specified for the leading
199 ;;; positional values.
200 ;;;
201 ;;; We force a check to be hairy even when there are fixed values if
202 ;;; we are in a context where we may be forced to use the unknown
203 ;;; values convention anyway. This is because IR2tran can't generate
204 ;;; type checks for unknown values continuations but people could
205 ;;; still be depending on the check being done. We only care about
206 ;;; EXIT and RETURN (not MV-COMBINATION) since these are the only
207 ;;; contexts where the ultimate values receiver
208 ;;;
209 ;;; In the :HAIRY case, the second value is a list of triples of
210 ;;; the form:
211 ;;;    (NOT-P TYPE ORIGINAL-TYPE)
212 ;;;
213 ;;; If true, the NOT-P flag indicates a test that the corresponding
214 ;;; value is *not* of the specified TYPE. ORIGINAL-TYPE is the type
215 ;;; asserted on this value in the continuation, for use in error
216 ;;; messages. When NOT-P is true, this will be different from TYPE.
217 ;;;
218 ;;; This allows us to take what has been proven about CONT's type into
219 ;;; consideration. If it is cheaper to test for the difference between
220 ;;; the derived type and the asserted type, then we check for the
221 ;;; negation of this type instead.
222 (defun continuation-check-types (cont force-hairy)
223   (declare (type continuation cont))
224   (let ((ctype (continuation-type-to-check cont))
225         (atype (continuation-asserted-type cont))
226         (dest (continuation-dest cont)))
227     (aver (not (eq ctype *wild-type*)))
228     (multiple-value-bind (ctypes count) (no-fun-values-types ctype)
229       (multiple-value-bind (atypes acount) (no-fun-values-types atype)
230         (aver (eq count acount))
231         (cond ((not (eq count :unknown))
232                (if (or (exit-p dest)
233                        (and (return-p dest)
234                             (multiple-value-bind (ignore count)
235                                 (values-types (return-result-type dest))
236                               (declare (ignore ignore))
237                               (eq count :unknown))))
238                    (maybe-negate-check cont ctypes atypes t)
239                    (maybe-negate-check cont ctypes atypes force-hairy)))
240               ((and (mv-combination-p dest)
241                     (eq (basic-combination-kind dest) :local))
242                (aver (values-type-p ctype))
243                (maybe-negate-check cont
244                                    (args-type-optional ctype)
245                                    (args-type-optional atype)
246                                    force-hairy))
247               (t
248                (values :too-hairy nil)))))))
249
250 ;;; Do we want to do a type check?
251 (defun worth-type-check-p (cont)
252   (let ((dest (continuation-dest cont)))
253     (not (or (values-subtypep (continuation-proven-type cont)
254                               (continuation-type-to-check cont))
255              (and (combination-p dest)
256                   (let ((kind (combination-kind dest)))
257                     (or (eq kind :full)
258                         (and (fun-info-p kind)
259                              (null (fun-info-templates kind))
260                              (not (fun-info-ir2-convert kind)))))
261                   ;; The theory is that the type assertion is from a
262                   ;; declaration in (or on) the callee, so the callee
263                   ;; should be able to do the check. We want to let
264                   ;; the callee do the check, because it is possible
265                   ;; that by the time of call that declaration will be
266                   ;; changed and we do not want to make people
267                   ;; recompile all calls to a function when they were
268                   ;; originally compiled with a bad declaration. (See
269                   ;; also bug 35.)
270                   (values-subtypep (continuation-externally-checkable-type cont)
271                                    (continuation-type-to-check cont)))
272              (and (mv-combination-p dest) ; bug 220
273                   (eq (mv-combination-kind dest) :full))))))
274
275 ;;; Return true if CONT is a continuation whose type the back end is
276 ;;; likely to want to check. Since we don't know what template the
277 ;;; back end is going to choose to implement the continuation's DEST,
278 ;;; we use a heuristic. We always return T unless:
279 ;;;  -- nobody uses the value, or
280 ;;;  -- safety is totally unimportant, or
281 ;;;  -- the continuation is an argument to an unknown function, or
282 ;;;  -- the continuation is an argument to a known function that has
283 ;;;     no IR2-CONVERT method or :FAST-SAFE templates that are
284 ;;;     compatible with the call's type.
285 ;;;
286 ;;; We must only return NIL when it is *certain* that a check will not
287 ;;; be done, since if we pass up this chance to do the check, it will
288 ;;; be too late. The penalty for being too conservative is duplicated
289 ;;; type checks. The penalty for erring by being too speculative is
290 ;;; much nastier, e.g. falling through without ever being able to find
291 ;;; an appropriate VOP.
292 (defun probable-type-check-p (cont)
293   (declare (type continuation cont))
294   (let ((dest (continuation-dest cont)))
295     (cond ((or (not dest)
296                (policy dest (zerop safety)))
297            nil)
298           ((basic-combination-p dest)
299            (let ((kind (basic-combination-kind dest)))
300              (cond ((eq cont (basic-combination-fun dest)) t)
301                    ((eq kind :local) t)
302                    ((eq kind :full)
303                     (and (combination-p dest)
304                          (not (values-subtypep ; explicit THE
305                                (continuation-externally-checkable-type cont)
306                                (continuation-type-to-check cont)))))
307
308                    ((eq kind :error) nil)
309                    ;; :ERROR means that we have an invalid syntax of
310                    ;; the call and the callee will detect it before
311                    ;; thinking about types.
312
313                    ((fun-info-ir2-convert kind) t)
314                    (t
315                     (dolist (template (fun-info-templates kind) nil)
316                       (when (eq (template-ltn-policy template) :fast-safe)
317                         (multiple-value-bind (val win)
318                             (valid-fun-use dest (template-type template))
319                           (when (or val (not win)) (return t)))))))))
320           (t t))))
321
322 ;;; Return a form that we can convert to do a hairy type check of the
323 ;;; specified TYPES. TYPES is a list of the format returned by
324 ;;; CONTINUATION-CHECK-TYPES in the :HAIRY case. In place of the
325 ;;; actual value(s) we are to check, we use 'DUMMY. This constant
326 ;;; reference is later replaced with the actual values continuation.
327 ;;;
328 ;;; Note that we don't attempt to check for required values being
329 ;;; unsupplied. Such checking is impossible to efficiently do at the
330 ;;; source level because our fixed-values conventions are optimized
331 ;;; for the common MV-BIND case.
332 ;;;
333 ;;; We can always use MULTIPLE-VALUE-BIND, since the macro is clever
334 ;;; about binding a single variable.
335 (defun make-type-check-form (types)
336   (let ((temps (make-gensym-list (length types))))
337     `(multiple-value-bind ,temps 'dummy
338        ,@(mapcar (lambda (temp type)
339                    (let* ((spec
340                            (let ((*unparse-fun-type-simplify* t))
341                              (type-specifier (second type))))
342                           (test (if (first type) `(not ,spec) spec)))
343                      `(unless (typep ,temp ',test)
344                         (%type-check-error
345                          ,temp
346                          ',(type-specifier (third type))))))
347                  temps
348                  types)
349        (values ,@temps))))
350
351 ;;; Splice in explicit type check code immediately before the node
352 ;;; which is CONT's DEST. This code receives the value(s) that were
353 ;;; being passed to CONT, checks the type(s) of the value(s), then
354 ;;; passes them on to CONT.
355 (defun convert-type-check (cont types)
356   (declare (type continuation cont) (type list types))
357   (with-ir1-environment-from-node (continuation-dest cont)
358
359     ;; Ensuring that CONT starts a block lets us freely manipulate its uses.
360     (ensure-block-start cont)
361
362     ;; Make a new continuation and move CONT's uses to it.
363     (let* ((new-start (make-continuation))
364            (dest (continuation-dest cont))
365            (prev (node-prev dest)))
366       (continuation-starts-block new-start)
367       (substitute-continuation-uses new-start cont)
368
369       ;; Setting TYPE-CHECK in CONT to :DELETED indicates that the
370       ;; check has been done.
371       (setf (continuation-%type-check cont) :deleted)
372
373       ;; Make the DEST node start its block so that we can splice in
374       ;; the type check code.
375       (when (continuation-use prev)
376         (node-ends-block (continuation-use prev)))
377
378       (let* ((prev-block (continuation-block prev))
379              (new-block (continuation-block new-start))
380              (dummy (make-continuation)))
381
382         ;; Splice in the new block before DEST, giving the new block
383         ;; all of DEST's predecessors.
384         (dolist (block (block-pred prev-block))
385           (change-block-successor block prev-block new-block))
386
387         ;; Convert the check form, using the new block start as START
388         ;; and a dummy continuation as CONT.
389         (ir1-convert new-start dummy (make-type-check-form types))
390
391         ;; TO DO: Why should this be true? -- WHN 19990601
392         (aver (eq (continuation-block dummy) new-block))
393
394         ;; KLUDGE: Comments at the head of this function in CMU CL
395         ;; said that somewhere in here we
396         ;;   Set the new block's start and end cleanups to the *start*
397         ;;   cleanup of PREV's block. This overrides the incorrect
398         ;;   default from WITH-IR1-ENVIRONMENT-FROM-NODE.
399         ;; Unfortunately I can't find any code which corresponds to this.
400         ;; Perhaps it was a stale comment? Or perhaps I just don't
401         ;; understand.. -- WHN 19990521
402
403         (let ((node (continuation-use dummy)))
404           (setf (block-last new-block) node)
405           ;; Change the use to a use of CONT. (We need to use the
406           ;; dummy continuation to get the control transfer right,
407           ;; because we want to go to PREV's block, not CONT's.)
408           (delete-continuation-use node)
409           (add-continuation-use node cont))
410         ;; Link the new block to PREV's block.
411         (link-blocks new-block prev-block))
412
413       ;; MAKE-TYPE-CHECK-FORM generated a form which checked the type
414       ;; of 'DUMMY, not a real form. At this point we convert to the
415       ;; real form by finding 'DUMMY and overwriting it with the new
416       ;; continuation. (We can find 'DUMMY because no LET conversion
417       ;; has been done yet.) The [mv-]combination code from the
418       ;; mv-bind in the check form will be the use of the new check
419       ;; continuation. We substitute for the first argument of this
420       ;; node.
421       (let* ((node (continuation-use cont))
422              (args (basic-combination-args node))
423              (victim (first args)))
424         (aver (and (= (length args) 1)
425                      (eq (constant-value
426                           (ref-leaf
427                            (continuation-use victim)))
428                          'dummy)))
429         (substitute-continuation new-start victim)))
430
431     ;; Invoking local call analysis converts this call to a LET.
432     (locall-analyze-component *current-component*))
433
434   (values))
435
436 ;;; Emit a type warning for NODE. If the value of NODE is being used
437 ;;; for a variable binding, we figure out which one for source
438 ;;; context. If the value is a constant, we print it specially. We
439 ;;; ignore nodes whose type is NIL, since they are supposed to never
440 ;;; return.
441 (defun emit-type-warning (node)
442   (declare (type node node))
443   (let* ((*compiler-error-context* node)
444          (cont (node-cont node))
445          (atype-spec (type-specifier (continuation-asserted-type cont)))
446          (dtype (node-derived-type node))
447          (dest (continuation-dest cont))
448          (what (when (and (combination-p dest)
449                           (eq (combination-kind dest) :local))
450                  (let ((lambda (combination-lambda dest))
451                        (pos (position-or-lose cont (combination-args dest))))
452                    (format nil "~:[A possible~;The~] binding of ~S"
453                            (and (continuation-use cont)
454                                 (eq (functional-kind lambda) :let))
455                            (leaf-source-name (elt (lambda-vars lambda)
456                                                   pos)))))))
457     (cond ((eq dtype *empty-type*))
458           ((and (ref-p node) (constant-p (ref-leaf node)))
459            (compiler-warn "~:[This~;~:*~A~] is not a ~<~%~9T~:;~S:~>~%  ~S"
460                           what atype-spec (constant-value (ref-leaf node))))
461           (t
462            (compiler-warn
463             "~:[Result~;~:*~A~] is a ~S, ~<~%~9T~:;not a ~S.~>"
464             what (type-specifier dtype) atype-spec))))
465   (values))
466
467 ;;; Loop over all blocks in COMPONENT that have TYPE-CHECK set,
468 ;;; looking for continuations with TYPE-CHECK T. We do two mostly
469 ;;; unrelated things: detect compile-time type errors and determine if
470 ;;; and how to do run-time type checks.
471 ;;;
472 ;;; If there is a compile-time type error, then we mark the
473 ;;; continuation and emit a warning if appropriate. This part loops
474 ;;; over all the uses of the continuation, since after we convert the
475 ;;; check, the :DELETED kind will inhibit warnings about the types of
476 ;;; other uses.
477 ;;;
478 ;;; If a continuation is too complex to be checked by the back end, or
479 ;;; is better checked with explicit code, then convert to an explicit
480 ;;; test. Assertions that can checked by the back end are passed
481 ;;; through. Assertions that can't be tested are flamed about and
482 ;;; marked as not needing to be checked.
483 ;;;
484 ;;; If we determine that a type check won't be done, then we set
485 ;;; TYPE-CHECK to :NO-CHECK. In the non-hairy cases, this is just to
486 ;;; prevent us from wasting time coming to the same conclusion again
487 ;;; on a later iteration. In the hairy case, we must indicate to LTN
488 ;;; that it must choose a safe implementation, since IR2 conversion
489 ;;; will choke on the check.
490 ;;;
491 ;;; The generation of the type checks is delayed until all the type
492 ;;; check decisions have been made because the generation of the type
493 ;;; checks creates new nodes whose derived types aren't always updated
494 ;;; which may lead to inappropriate template choices due to the
495 ;;; modification of argument types.
496 (defun generate-type-checks (component)
497   (collect ((conts))
498     (do-blocks (block component)
499       (when (block-type-check block)
500         (do-nodes (node cont block)
501           (let ((type-check (continuation-type-check cont)))
502             (unless (member type-check '(nil :deleted))
503               (let ((atype (continuation-asserted-type cont)))
504                 (do-uses (use cont)
505                   (unless (values-types-equal-or-intersect
506                            (node-derived-type use) atype)
507                     (unless (policy node (= inhibit-warnings 3))
508                       (emit-type-warning use))))))
509             (when (eq type-check t)
510               (cond ((worth-type-check-p cont)
511                      (conts (cons cont (not (probable-type-check-p cont)))))
512                     ((probable-type-check-p cont)
513                      (setf (continuation-%type-check cont) :deleted))
514                     (t
515                      (setf (continuation-%type-check cont) :no-check))))))
516         (setf (block-type-check block) nil)))
517     (dolist (cont (conts))
518       (destructuring-bind (cont . force-hairy) cont
519         (multiple-value-bind (check types)
520             (continuation-check-types cont force-hairy)
521           (ecase check
522             (:simple)
523             (:hairy
524              (convert-type-check cont types))
525             (:too-hairy
526              (let* ((context (continuation-dest cont))
527                     (*compiler-error-context* context))
528                (when (policy context (>= safety inhibit-warnings))
529                  (compiler-note
530                   "type assertion too complex to check:~% ~S."
531                   (type-specifier (continuation-asserted-type cont)))))
532              (setf (continuation-%type-check cont) :deleted)))))))
533   (values))