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