CmmLint.hs 6.92 KB
Newer Older
1 2 3
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
Ian Lynagh's avatar
Ian Lynagh committed
4
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
5 6
-- for details

7 8
-----------------------------------------------------------------------------
--
Simon Marlow's avatar
Simon Marlow committed
9
-- (c) The University of Glasgow 2004-2006
10
--
Simon Marlow's avatar
Simon Marlow committed
11
-- CmmLint: checking the correctness of Cmm statements and expressions
12 13 14 15 16 17 18
--
-----------------------------------------------------------------------------

module CmmLint (
  cmmLint, cmmLintTop
  ) where

19
import BlockId
20
import Cmm
Simon Marlow's avatar
Simon Marlow committed
21
import CLabel
22 23
import Outputable
import PprCmm
Simon Marlow's avatar
Simon Marlow committed
24
import Constants
25
import FastString
26

Simon Marlow's avatar
Simon Marlow committed
27
import Control.Monad
Ian Lynagh's avatar
Ian Lynagh committed
28
import Data.Maybe
29 30 31 32

-- -----------------------------------------------------------------------------
-- Exported entry points:

33 34 35
cmmLint :: (Outputable d, Outputable h)
	=> GenCmm d h (ListGraph CmmStmt) -> Maybe SDoc
cmmLint (Cmm tops) = runCmmLint (mapM_ lintCmmTop) tops
36

37 38 39
cmmLintTop :: (Outputable d, Outputable h)
	   => GenCmmTop d h (ListGraph CmmStmt) -> Maybe SDoc
cmmLintTop top = runCmmLint lintCmmTop top
40

41 42 43 44 45 46 47 48
runCmmLint :: Outputable a => (a -> CmmLint b) -> a -> Maybe SDoc
runCmmLint l p = 
   case unCL (l p) of
	Left err -> Just (vcat [ptext $ sLit ("Cmm lint error:"),
				nest 2 err,
				ptext $ sLit ("Program was:"),
				nest 2 (ppr p)])
  	Right _  -> Nothing
49

50
lintCmmTop :: (GenCmmTop h i (ListGraph CmmStmt)) -> CmmLint ()
51
lintCmmTop (CmmProc _ lbl _ (ListGraph blocks))
52
  = addLintInfo (text "in proc " <> pprCLabel lbl) $
53 54 55 56
        let labels = foldl (\s b -> extendBlockSet s (blockId b)) emptyBlockSet blocks
	in  mapM_ (lintCmmBlock labels) blocks

lintCmmTop (CmmData {})
57 58
  = return ()

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
59
lintCmmBlock :: BlockSet -> GenBasicBlock CmmStmt -> CmmLint ()
60
lintCmmBlock labels (BasicBlock id stmts)
61
  = addLintInfo (text "in basic block " <> ppr id) $
62
	mapM_ (lintCmmStmt labels) stmts
63 64 65 66 67 68 69

-- -----------------------------------------------------------------------------
-- lintCmmExpr

-- Checks whether a CmmExpr is "type-correct", and check for obvious-looking
-- byte/word mismatches.

70
lintCmmExpr :: CmmExpr -> CmmLint CmmType
71
lintCmmExpr (CmmLoad expr rep) = do
72
  _ <- lintCmmExpr expr
73
  when (widthInBytes (typeWidth rep) >= wORD_SIZE) $
74 75 76
     cmmCheckWordAddress expr
  return rep
lintCmmExpr expr@(CmmMachOp op args) = do
77 78 79 80
  tys <- mapM lintCmmExpr args
  if map (typeWidth . cmmExprType) args == machOpArgReps op
  	then cmmCheckMachOp op args tys
	else cmmLintMachOpErr expr (map cmmExprType args) (machOpArgReps op)
81
lintCmmExpr (CmmRegOff reg offset)
82
  = lintCmmExpr (CmmMachOp (MO_Add rep)
83
		[CmmReg reg, CmmLit (CmmInt (fromIntegral offset) rep)])
84
  where rep = typeWidth (cmmRegType reg)
85
lintCmmExpr expr = 
86
  return (cmmExprType expr)
87 88

-- Check for some common byte/word mismatches (eg. Sp + 1)
89 90 91 92 93
cmmCheckMachOp   :: MachOp -> [CmmExpr] -> [CmmType] -> CmmLint CmmType
cmmCheckMachOp op [lit@(CmmLit (CmmInt { })), reg@(CmmReg _)] tys
  = cmmCheckMachOp op [reg, lit] tys
cmmCheckMachOp op _ tys
  = return (machOpResultType op tys)
94

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
95
isOffsetOp :: MachOp -> Bool
96 97 98 99 100 101
isOffsetOp (MO_Add _) = True
isOffsetOp (MO_Sub _) = True
isOffsetOp _ = False

-- This expression should be an address from which a word can be loaded:
-- check for funny-looking sub-word offsets.
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
102
cmmCheckWordAddress :: CmmExpr -> CmmLint ()
103
cmmCheckWordAddress e@(CmmMachOp op [arg, CmmLit (CmmInt i _)])
Simon Marlow's avatar
Simon Marlow committed
104
  | isOffsetOp op && notNodeReg arg && i `rem` fromIntegral wORD_SIZE /= 0
105 106
  = cmmLintDubiousWordOffset e
cmmCheckWordAddress e@(CmmMachOp op [CmmLit (CmmInt i _), arg])
Simon Marlow's avatar
Simon Marlow committed
107
  | isOffsetOp op && notNodeReg arg && i `rem` fromIntegral wORD_SIZE /= 0
108 109 110 111
  = cmmLintDubiousWordOffset e
cmmCheckWordAddress _
  = return ()

Simon Marlow's avatar
Simon Marlow committed
112 113
-- No warnings for unaligned arithmetic with the node register,
-- which is used to extract fields from tagged constructor closures.
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
114
notNodeReg :: CmmExpr -> Bool
Simon Marlow's avatar
Simon Marlow committed
115 116
notNodeReg (CmmReg reg) | reg == nodeReg = False
notNodeReg _                             = True
117

118 119 120 121 122 123
lintCmmStmt :: BlockSet -> CmmStmt -> CmmLint ()
lintCmmStmt labels = lint
    where lint (CmmNop) = return ()
          lint (CmmComment {}) = return ()
          lint stmt@(CmmAssign reg expr) = do
            erep <- lintCmmExpr expr
124 125
	    let reg_ty = cmmRegType reg
            if (erep `cmmEqType_ignoring_ptrhood` reg_ty)
126
                then return ()
127
                else cmmLintAssignErr stmt erep reg_ty
128
          lint (CmmStore l r) = do
129 130
            _ <- lintCmmExpr l
            _ <- lintCmmExpr r
131 132
            return ()
          lint (CmmCall target _res args _ _) =
133
              lintTarget target >> mapM_ (lintCmmExpr . hintlessCmm) args
134 135 136 137
          lint (CmmCondBranch e id) = checkTarget id >> lintCmmExpr e >> checkCond e
          lint (CmmSwitch e branches) = do
            mapM_ checkTarget $ catMaybes branches
            erep <- lintCmmExpr e
138
            if (erep `cmmEqType_ignoring_ptrhood` bWord)
139
              then return ()
140 141 142 143
              else cmmLintErr (text "switch scrutinee is not a word: " <> ppr e <>
                               text " :: " <> ppr erep)
          lint (CmmJump e args) = lintCmmExpr e >> mapM_ (lintCmmExpr . hintlessCmm) args
          lint (CmmReturn ress) = mapM_ (lintCmmExpr . hintlessCmm) ress
144 145 146 147 148 149 150 151
          lint (CmmBranch id)    = checkTarget id
          checkTarget id = if elemBlockSet id labels then return ()
                           else cmmLintErr (text "Branch to nonexistent id" <+> ppr id)

lintTarget :: CmmCallTarget -> CmmLint ()
lintTarget (CmmCallee e _) = lintCmmExpr e >> return ()
lintTarget (CmmPrim {})    = return ()

152

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
153
checkCond :: CmmExpr -> CmmLint ()
154 155 156 157
checkCond (CmmMachOp mop _) | isComparisonMachOp mop = return ()
checkCond expr = cmmLintErr (hang (text "expression is not a conditional:") 2
				    (ppr expr))

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
-- -----------------------------------------------------------------------------
-- CmmLint monad

-- just a basic error monad:

newtype CmmLint a = CmmLint { unCL :: Either SDoc a }

instance Monad CmmLint where
  CmmLint m >>= k = CmmLint $ case m of 
				Left e -> Left e
				Right a -> unCL (k a)
  return a = CmmLint (Right a)

cmmLintErr :: SDoc -> CmmLint a
cmmLintErr msg = CmmLint (Left msg)

addLintInfo :: SDoc -> CmmLint a -> CmmLint a
addLintInfo info thing = CmmLint $ 
   case unCL thing of
	Left err -> Left (hang info 2 err)
	Right a  -> Right a

180
cmmLintMachOpErr :: CmmExpr -> [CmmType] -> [Width] -> CmmLint a
181 182 183 184 185
cmmLintMachOpErr expr argsRep opExpectsRep
     = cmmLintErr (text "in MachOp application: " $$ 
					nest 2 (pprExpr expr) $$
				        (text "op is expecting: " <+> ppr opExpectsRep) $$
					(text "arguments provide: " <+> ppr argsRep))
186

187 188 189 190 191 192 193 194
cmmLintAssignErr :: CmmStmt -> CmmType -> CmmType -> CmmLint a
cmmLintAssignErr stmt e_ty r_ty
  = cmmLintErr (text "in assignment: " $$ 
		nest 2 (vcat [pprStmt stmt, 
			      text "Reg ty:" <+> ppr r_ty,
			      text "Rhs ty:" <+> ppr e_ty]))
			 
					
195 196 197 198 199

cmmLintDubiousWordOffset :: CmmExpr -> CmmLint a
cmmLintDubiousWordOffset expr
   = cmmLintErr (text "offset is not a multiple of words: " $$
			nest 2 (pprExpr expr))