2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
4 \section[StgLint]{A ``lint'' pass to check for Stg correctness}
7 module StgLint ( lintStgBindings ) where
9 #include "HsVersions.h"
13 import Bag ( Bag, emptyBag, isEmptyBag, snocBag )
14 import Id ( Id, idType, isLocalId )
16 import DataCon ( DataCon, dataConArgTys, dataConRepType )
17 import PrimOp ( primOpType )
18 import Literal ( literalType, Literal )
19 import Maybes ( catMaybes )
20 import Name ( getSrcLoc )
21 import ErrUtils ( ErrMsg, Message, addErrLocHdrLine, pprBagOfErrors, dontAddErrLoc )
22 import Type ( mkFunTys, splitFunTys, splitAlgTyConApp_maybe, splitTyConApp_maybe,
23 isUnLiftedType, isTyVarTy, splitForAllTys, Type
25 import TyCon ( TyCon )
26 import Util ( zipEqual )
29 infixr 9 `thenL`, `thenL_`, `thenMaybeL`, `thenMaybeL_`
33 (a) *some* type errors
34 (b) locally-defined variables used but not defined
37 Note: unless -dverbose-stg is on, display of lint errors will result
38 in "panic: bOGUS_LVs".
43 This module has suffered bit-rot; it is likely to yield lint errors
44 for Stg code that is currently perfectly acceptable for code
45 generation. Solution: don't use it! (KSW 2000-05).
48 %************************************************************************
50 \subsection{``lint'' for various constructs}
52 %************************************************************************
54 @lintStgBindings@ is the top-level interface function.
57 lintStgBindings :: String -> [StgBinding] -> [StgBinding]
59 lintStgBindings whodunnit binds
61 case (initL (lint_binds binds)) of
63 Just msg -> pprPanic "" (vcat [
64 ptext SLIT("*** Stg Lint ErrMsgs: in") <+> text whodunnit <+> ptext SLIT("***"),
66 ptext SLIT("*** Offending Program ***"),
68 ptext SLIT("*** End of Offense ***")])
70 lint_binds :: [StgBinding] -> LintM ()
72 lint_binds [] = returnL ()
73 lint_binds (bind:binds)
74 = lintStgBinds bind `thenL` \ binders ->
75 addInScopeVars binders (
82 lintStgArg :: StgArg -> LintM (Maybe Type)
83 lintStgArg (StgLitArg lit) = returnL (Just (literalType lit))
84 lintStgArg (StgVarArg v) = lintStgVar v
86 lintStgVar v = checkInScope v `thenL_`
87 returnL (Just (idType v))
91 lintStgBinds :: StgBinding -> LintM [Id] -- Returns the binders
92 lintStgBinds (StgNonRec _srt binder rhs)
93 = lint_binds_help (binder,rhs) `thenL_`
96 lintStgBinds (StgRec _srt pairs)
97 = addInScopeVars binders (
98 mapL lint_binds_help pairs `thenL_`
102 binders = [b | (b,_) <- pairs]
104 lint_binds_help (binder, rhs)
105 = addLoc (RhsOf binder) (
107 lintStgRhs rhs `thenL` \ maybe_rhs_ty ->
109 -- Check binder doesn't have unlifted type
110 checkL (not (isUnLiftedType binder_ty))
111 (mkUnLiftedTyMsg binder rhs) `thenL_`
113 -- Check match to RHS type
114 (case maybe_rhs_ty of
115 Nothing -> returnL ()
116 Just rhs_ty -> checkTys binder_ty
118 (mkRhsMsg binder rhs_ty)
124 binder_ty = idType binder
128 lintStgRhs :: StgRhs -> LintM (Maybe Type)
130 lintStgRhs (StgRhsClosure _ _ _ _ [] expr)
133 lintStgRhs (StgRhsClosure _ _ _ _ binders expr)
134 = addLoc (LambdaBodyOf binders) (
135 addInScopeVars binders (
136 lintStgExpr expr `thenMaybeL` \ body_ty ->
137 returnL (Just (mkFunTys (map idType binders) body_ty))
140 lintStgRhs (StgRhsCon _ con args)
141 = mapMaybeL lintStgArg args `thenL` \ maybe_arg_tys ->
142 case maybe_arg_tys of
143 Nothing -> returnL Nothing
144 Just arg_tys -> checkFunApp con_ty arg_tys (mkRhsConMsg con_ty arg_tys)
146 con_ty = dataConRepType con
150 lintStgExpr :: StgExpr -> LintM (Maybe Type) -- Nothing if error found
152 lintStgExpr (StgLit l) = returnL (Just (literalType l))
154 lintStgExpr e@(StgApp fun args)
155 = lintStgVar fun `thenMaybeL` \ fun_ty ->
156 mapMaybeL lintStgArg args `thenL` \ maybe_arg_tys ->
157 case maybe_arg_tys of
158 Nothing -> returnL Nothing
159 Just arg_tys -> checkFunApp fun_ty arg_tys (mkFunAppMsg fun_ty arg_tys e)
161 lintStgExpr e@(StgConApp con args)
162 = mapMaybeL lintStgArg args `thenL` \ maybe_arg_tys ->
163 case maybe_arg_tys of
164 Nothing -> returnL Nothing
165 Just arg_tys -> checkFunApp con_ty arg_tys (mkFunAppMsg con_ty arg_tys e)
167 con_ty = dataConRepType con
169 lintStgExpr e@(StgOpApp (StgFCallOp _ _) args res_ty)
170 = -- We don't have enough type information to check
171 -- the application; ToDo
172 mapMaybeL lintStgArg args `thenL` \ maybe_arg_tys ->
173 returnL (Just res_ty)
175 lintStgExpr e@(StgOpApp (StgPrimOp op) args _)
176 = mapMaybeL lintStgArg args `thenL` \ maybe_arg_tys ->
177 case maybe_arg_tys of
178 Nothing -> returnL Nothing
179 Just arg_tys -> checkFunApp op_ty arg_tys (mkFunAppMsg op_ty arg_tys e)
181 op_ty = primOpType op
183 lintStgExpr (StgLam _ bndrs _)
184 = addErrL (ptext SLIT("Unexpected StgLam") <+> ppr bndrs) `thenL_`
187 lintStgExpr (StgLet binds body)
188 = lintStgBinds binds `thenL` \ binders ->
189 addLoc (BodyOfLetRec binders) (
190 addInScopeVars binders (
194 lintStgExpr (StgLetNoEscape _ _ binds body)
195 = lintStgBinds binds `thenL` \ binders ->
196 addLoc (BodyOfLetRec binders) (
197 addInScopeVars binders (
201 lintStgExpr (StgSCC _ expr) = lintStgExpr expr
203 lintStgExpr e@(StgCase scrut _ _ bndr _ alts)
204 = lintStgExpr scrut `thenMaybeL` \ _ ->
207 StgPrimAlts tc _ _ -> check_bndr tc
208 StgAlgAlts (Just tc) _ _ -> check_bndr tc
209 StgAlgAlts Nothing _ _ -> returnL ()
212 (trace (showSDoc (ppr e)) $
213 -- we only allow case of tail-call or primop.
215 StgApp _ _ -> returnL ()
216 StgConApp _ _ -> returnL ()
217 other -> addErrL (mkCaseOfCaseMsg e)) `thenL_`
219 addInScopeVars [bndr] (lintStgAlts alts scrut_ty)
222 scrut_ty = idType bndr
223 bad_bndr = mkDefltMsg bndr
224 check_bndr tc = case splitTyConApp_maybe scrut_ty of
225 Just (bndr_tc, _) -> checkL (tc == bndr_tc) bad_bndr
226 Nothing -> addErrL bad_bndr
230 lintStgAlts :: StgCaseAlts
231 -> Type -- Type of scrutinee
232 -> LintM (Maybe Type) -- Type of alternatives
234 lintStgAlts alts scrut_ty
236 StgAlgAlts _ alg_alts deflt ->
237 mapL (lintAlgAlt scrut_ty) alg_alts `thenL` \ maybe_alt_tys ->
238 lintDeflt deflt scrut_ty `thenL` \ maybe_deflt_ty ->
239 returnL (maybe_deflt_ty : maybe_alt_tys)
241 StgPrimAlts _ prim_alts deflt ->
242 mapL (lintPrimAlt scrut_ty) prim_alts `thenL` \ maybe_alt_tys ->
243 lintDeflt deflt scrut_ty `thenL` \ maybe_deflt_ty ->
244 returnL (maybe_deflt_ty : maybe_alt_tys)
245 ) `thenL` \ maybe_result_tys ->
246 -- Check the result types
247 case catMaybes (maybe_result_tys) of
248 [] -> returnL Nothing
250 (first_ty:tys) -> mapL check tys `thenL_`
251 returnL (Just first_ty)
253 check ty = checkTys first_ty ty (mkCaseAltMsg alts)
255 lintAlgAlt scrut_ty (con, args, _, rhs)
256 = (case splitAlgTyConApp_maybe scrut_ty of
258 addErrL (mkAlgAltMsg1 scrut_ty)
259 Just (tycon, tys_applied, cons) ->
261 arg_tys = dataConArgTys con tys_applied
262 -- This almost certainly does not work for existential constructors
264 checkL (con `elem` cons) (mkAlgAltMsg2 scrut_ty con) `thenL_`
265 checkL (length arg_tys == length args) (mkAlgAltMsg3 con args)
267 mapL check (zipEqual "lintAlgAlt:stg" arg_tys args) `thenL_`
270 addInScopeVars args (
274 check (ty, arg) = checkTys ty (idType arg) (mkAlgAltMsg4 ty arg)
276 -- elem: yes, the elem-list here can sometimes be long-ish,
277 -- but as it's use-once, probably not worth doing anything different
278 -- We give it its own copy, so it isn't overloaded.
280 elem x (y:ys) = x==y || elem x ys
282 lintPrimAlt scrut_ty alt@(lit,rhs)
283 = checkTys (literalType lit) scrut_ty (mkPrimAltMsg alt) `thenL_`
286 lintDeflt StgNoDefault scrut_ty = returnL Nothing
287 lintDeflt deflt@(StgBindDefault rhs) scrut_ty = lintStgExpr rhs
291 %************************************************************************
293 \subsection[lint-monad]{The Lint monad}
295 %************************************************************************
298 type LintM a = [LintLocInfo] -- Locations
299 -> IdSet -- Local vars in scope
300 -> Bag ErrMsg -- Error messages so far
301 -> (a, Bag ErrMsg) -- Result and error messages (if any)
304 = RhsOf Id -- The variable bound
305 | LambdaBodyOf [Id] -- The lambda-binder
306 | BodyOfLetRec [Id] -- One of the binders
309 (getSrcLoc v, ptext SLIT(" [RHS of ") <> pp_binders [v] <> char ']' )
310 dumpLoc (LambdaBodyOf bs) =
311 (getSrcLoc (head bs), ptext SLIT(" [in body of lambda with binders ") <> pp_binders bs <> char ']' )
313 dumpLoc (BodyOfLetRec bs) =
314 (getSrcLoc (head bs), ptext SLIT(" [in body of letrec with binders ") <> pp_binders bs <> char ']' )
317 pp_binders :: [Id] -> SDoc
319 = sep (punctuate comma (map pp_binder bs))
322 = hsep [ppr b, dcolon, ppr (idType b)]
326 initL :: LintM a -> Maybe Message
328 = case (m [] emptyVarSet emptyBag) of { (_, errs) ->
329 if isEmptyBag errs then
332 Just (pprBagOfErrors errs)
335 returnL :: a -> LintM a
336 returnL r loc scope errs = (r, errs)
338 thenL :: LintM a -> (a -> LintM b) -> LintM b
339 thenL m k loc scope errs
340 = case m loc scope errs of
341 (r, errs') -> k r loc scope errs'
343 thenL_ :: LintM a -> LintM b -> LintM b
344 thenL_ m k loc scope errs
345 = case m loc scope errs of
346 (_, errs') -> k loc scope errs'
348 thenMaybeL :: LintM (Maybe a) -> (a -> LintM (Maybe b)) -> LintM (Maybe b)
349 thenMaybeL m k loc scope errs
350 = case m loc scope errs of
351 (Nothing, errs2) -> (Nothing, errs2)
352 (Just r, errs2) -> k r loc scope errs2
354 thenMaybeL_ :: LintM (Maybe a) -> LintM (Maybe b) -> LintM (Maybe b)
355 thenMaybeL_ m k loc scope errs
356 = case m loc scope errs of
357 (Nothing, errs2) -> (Nothing, errs2)
358 (Just _, errs2) -> k loc scope errs2
360 mapL :: (a -> LintM b) -> [a] -> LintM [b]
361 mapL f [] = returnL []
364 mapL f xs `thenL` \ rs ->
367 mapMaybeL :: (a -> LintM (Maybe b)) -> [a] -> LintM (Maybe [b])
368 -- Returns Nothing if anything fails
369 mapMaybeL f [] = returnL (Just [])
371 = f x `thenMaybeL` \ r ->
372 mapMaybeL f xs `thenMaybeL` \ rs ->
373 returnL (Just (r:rs))
377 checkL :: Bool -> Message -> LintM ()
378 checkL True msg loc scope errs = ((), errs)
379 checkL False msg loc scope errs = ((), addErr errs msg loc)
381 addErrL :: Message -> LintM ()
382 addErrL msg loc scope errs = ((), addErr errs msg loc)
384 addErr :: Bag ErrMsg -> Message -> [LintLocInfo] -> Bag ErrMsg
386 addErr errs_so_far msg locs
387 = errs_so_far `snocBag` mk_msg locs
389 mk_msg (loc:_) = let (l,hdr) = dumpLoc loc in addErrLocHdrLine l hdr msg
390 mk_msg [] = dontAddErrLoc msg
392 addLoc :: LintLocInfo -> LintM a -> LintM a
393 addLoc extra_loc m loc scope errs
394 = m (extra_loc:loc) scope errs
396 addInScopeVars :: [Id] -> LintM a -> LintM a
397 addInScopeVars ids m loc scope errs
398 = -- We check if these "new" ids are already
399 -- in scope, i.e., we have *shadowing* going on.
400 -- For now, it's just a "trace"; we may make
401 -- a real error out of it...
403 new_set = mkVarSet ids
405 -- After adding -fliberate-case, Simon decided he likes shadowed
406 -- names after all. WDP 94/07
407 -- (if isEmptyVarSet shadowed
409 -- else pprTrace "Shadowed vars:" (ppr (varSetElems shadowed))) $
410 m loc (scope `unionVarSet` new_set) errs
413 Checking function applications: we only check that the type has the
414 right *number* of arrows, we don't actually compare the types. This
415 is because we can't expect the types to be equal - the type
416 applications and type lambdas that we use to calculate accurate types
417 have long since disappeared.
420 checkFunApp :: Type -- The function type
421 -> [Type] -- The arg type(s)
422 -> Message -- Error messgae
423 -> LintM (Maybe Type) -- The result type
425 checkFunApp fun_ty arg_tys msg loc scope errs
426 = cfa res_ty expected_arg_tys arg_tys
428 (_, de_forall_ty) = splitForAllTys fun_ty
429 (expected_arg_tys, res_ty) = splitFunTys de_forall_ty
431 cfa res_ty expected [] -- Args have run out; that's fine
432 = (Just (mkFunTys expected res_ty), errs)
434 cfa res_ty [] arg_tys -- Expected arg tys ran out first;
435 -- first see if res_ty is a tyvar template;
436 -- otherwise, maybe res_ty is a
437 -- dictionary type which is actually a function?
439 = (Just res_ty, errs)
441 = case splitFunTys res_ty of
442 ([], _) -> (Nothing, addErr errs msg loc) -- Too many args
443 (new_expected, new_res) -> cfa new_res new_expected arg_tys
445 cfa res_ty (expected_arg_ty:expected_arg_tys) (arg_ty:arg_tys)
446 = cfa res_ty expected_arg_tys arg_tys
450 checkInScope :: Id -> LintM ()
451 checkInScope id loc scope errs
452 = if isLocalId id && not (id `elemVarSet` scope) then
453 ((), addErr errs (hsep [ppr id, ptext SLIT("is out of scope")]) loc)
457 checkTys :: Type -> Type -> Message -> LintM ()
458 checkTys ty1 ty2 msg loc scope errs
459 = -- if (ty1 == ty2) then
461 -- else ((), addErr errs msg loc)
465 mkCaseAltMsg :: StgCaseAlts -> Message
467 = ($$) (text "In some case alternatives, type of alternatives not all same:")
468 (empty) -- LATER: ppr alts
470 mkCaseAbstractMsg :: TyCon -> Message
471 mkCaseAbstractMsg tycon
472 = ($$) (ptext SLIT("An algebraic case on an abstract type:"))
475 mkDefltMsg :: Id -> Message
477 = ($$) (ptext SLIT("Binder of a case expression doesn't match type of scrutinee:"))
480 mkFunAppMsg :: Type -> [Type] -> StgExpr -> Message
481 mkFunAppMsg fun_ty arg_tys expr
482 = vcat [text "In a function application, function type doesn't match arg types:",
483 hang (ptext SLIT("Function type:")) 4 (ppr fun_ty),
484 hang (ptext SLIT("Arg types:")) 4 (vcat (map (ppr) arg_tys)),
485 hang (ptext SLIT("Expression:")) 4 (ppr expr)]
487 mkRhsConMsg :: Type -> [Type] -> Message
488 mkRhsConMsg fun_ty arg_tys
489 = vcat [text "In a RHS constructor application, con type doesn't match arg types:",
490 hang (ptext SLIT("Constructor type:")) 4 (ppr fun_ty),
491 hang (ptext SLIT("Arg types:")) 4 (vcat (map (ppr) arg_tys))]
493 mkUnappTyMsg :: Id -> Type -> Message
495 = vcat [text "Variable has a for-all type, but isn't applied to any types.",
496 (<>) (ptext SLIT("Var: ")) (ppr var),
497 (<>) (ptext SLIT("Its type: ")) (ppr ty)]
499 mkAlgAltMsg1 :: Type -> Message
501 = ($$) (text "In some case statement, type of scrutinee is not a data type:")
504 mkAlgAltMsg2 :: Type -> DataCon -> Message
507 text "In some algebraic case alternative, constructor is not a constructor of scrutinee type:",
512 mkAlgAltMsg3 :: DataCon -> [Id] -> Message
513 mkAlgAltMsg3 con alts
515 text "In some algebraic case alternative, number of arguments doesn't match constructor:",
520 mkAlgAltMsg4 :: Type -> Id -> Message
523 text "In some algebraic case alternative, type of argument doesn't match data constructor:",
528 mkPrimAltMsg :: (Literal, StgExpr) -> Message
530 = text "In a primitive case alternative, type of literal doesn't match type of scrutinee:"
533 mkCaseOfCaseMsg :: StgExpr -> Message
535 = text "Case of non-tail-call:" $$ ppr e
537 mkRhsMsg :: Id -> Type -> Message
539 = vcat [hsep [ptext SLIT("The type of this binder doesn't match the type of its RHS:"),
541 hsep [ptext SLIT("Binder's type:"), ppr (idType binder)],
542 hsep [ptext SLIT("Rhs type:"), ppr ty]
545 mkUnLiftedTyMsg binder rhs
546 = (ptext SLIT("Let(rec) binder") <+> quotes (ppr binder) <+>
547 ptext SLIT("has unlifted type") <+> quotes (ppr (idType binder)))
549 (ptext SLIT("RHS:") <+> ppr rhs)