CmmLint.hs 7.12 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 OldCmm
Simon Marlow's avatar
Simon Marlow committed
21
import CLabel
22
import Outputable
23
import OldPprCmm()
Simon Marlow's avatar
Simon Marlow committed
24
import Constants
25
import FastString
26

Ian Lynagh's avatar
Ian Lynagh committed
27
import Data.Maybe
28 29 30 31

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

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

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

40 41 42 43 44 45 46 47
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
48

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

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

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

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

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

69
lintCmmExpr :: CmmExpr -> CmmLint CmmType
70
lintCmmExpr (CmmLoad expr rep) = do
71
  _ <- lintCmmExpr expr
72 73 74 75
  -- Disabled, if we have the inlining phase before the lint phase,
  -- we can have funny offsets due to pointer tagging. -- EZY
  -- when (widthInBytes (typeWidth rep) >= wORD_SIZE) $
  --   cmmCheckWordAddress expr
76 77
  return rep
lintCmmExpr expr@(CmmMachOp op args) = do
78 79 80 81
  tys <- mapM lintCmmExpr args
  if map (typeWidth . cmmExprType) args == machOpArgReps op
  	then cmmCheckMachOp op args tys
	else cmmLintMachOpErr expr (map cmmExprType args) (machOpArgReps op)
82
lintCmmExpr (CmmRegOff reg offset)
83
  = lintCmmExpr (CmmMachOp (MO_Add rep)
84
		[CmmReg reg, CmmLit (CmmInt (fromIntegral offset) rep)])
85
  where rep = typeWidth (cmmRegType reg)
86
lintCmmExpr expr = 
87
  return (cmmExprType expr)
88 89

-- Check for some common byte/word mismatches (eg. Sp + 1)
90 91 92 93 94
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)
95

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
96
isOffsetOp :: MachOp -> Bool
97 98 99 100 101 102
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.
103 104
_cmmCheckWordAddress :: CmmExpr -> CmmLint ()
_cmmCheckWordAddress e@(CmmMachOp op [arg, CmmLit (CmmInt i _)])
Simon Marlow's avatar
Simon Marlow committed
105
  | isOffsetOp op && notNodeReg arg && i `rem` fromIntegral wORD_SIZE /= 0
106
  = cmmLintDubiousWordOffset e
107
_cmmCheckWordAddress e@(CmmMachOp op [CmmLit (CmmInt i _), arg])
Simon Marlow's avatar
Simon Marlow committed
108
  | isOffsetOp op && notNodeReg arg && i `rem` fromIntegral wORD_SIZE /= 0
109
  = cmmLintDubiousWordOffset e
110
_cmmCheckWordAddress _
111 112
  = return ()

Simon Marlow's avatar
Simon Marlow committed
113 114
-- 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
115
notNodeReg :: CmmExpr -> Bool
Simon Marlow's avatar
Simon Marlow committed
116 117
notNodeReg (CmmReg reg) | reg == nodeReg = False
notNodeReg _                             = True
118

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

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

153

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
154
checkCond :: CmmExpr -> CmmLint ()
155
checkCond (CmmMachOp mop _) | isComparisonMachOp mop = return ()
156
checkCond (CmmLit (CmmInt x t)) | x == 0 || x == 1, t == wordWidth = return () -- constant values
157 158 159
checkCond expr = cmmLintErr (hang (text "expression is not a conditional:") 2
				    (ppr expr))

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
-- -----------------------------------------------------------------------------
-- 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

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

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

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