[project @ 2000-08-21 15:40:14 by sewardj]
[ghc-hetmet.git] / ghc / compiler / nativeGen / Stix.lhs
index 3b297a8..1223490 100644 (file)
@@ -5,13 +5,23 @@
 \begin{code}
 module Stix (
        CodeSegment(..), StixReg(..), StixTree(..), StixTreeList,
-       sStLitLbl, pprStixTrees, ppStixReg,
+       pprStixTrees, pprStixTree, ppStixReg,
+        stixCountTempUses, stixSubst,
+       DestInfo(..),
 
        stgBaseReg, stgNode, stgSp, stgSu, stgSpLim, 
-        stgHp, stgHpLim, stgTagReg, stgR9, stgR10,
-       getUniqLabelNCG,
+        stgHp, stgHpLim, stgTagReg, stgR9, stgR10, 
+       stgCurrentTSO, stgCurrentNursery,
 
-       fixedHS, arrWordsHS, arrPtrsHS
+       fixedHS, arrWordsHS, arrPtrsHS,
+
+        NatM, initNat, thenNat, returnNat, 
+        mapNat, mapAndUnzipNat, mapAccumLNat,
+        getUniqueNat, getDeltaNat, setDeltaNat,
+        NatM_State, mkNatM_State,
+        uniqOfNatM_State, deltaOfNatM_State,
+
+       getUniqLabelNCG, getNatLabelNCG,
     ) where
 
 #include "HsVersions.h"
@@ -19,14 +29,14 @@ module Stix (
 import Ratio           ( Rational )
 
 import AbsCSyn         ( node, tagreg, MagicId(..) )
-import AbsCUtils       ( magicIdPrimRep )
 import CallConv                ( CallConv, pprCallConv )
 import CLabel          ( mkAsmTempLabel, CLabel, pprCLabel, pprCLabel_asm )
 import PrimRep          ( PrimRep(..), showPrimRep )
 import PrimOp           ( PrimOp, pprPrimOp )
 import Unique           ( Unique )
 import SMRep           ( fixedHdrSize, arrWordsHdrSize, arrPtrsHdrSize )
-import UniqSupply      ( returnUs, thenUs, getUniqueUs, UniqSM )
+import UniqSupply      ( UniqSupply, splitUniqSupply, uniqFromSupply,
+                          UniqSM, thenUs, returnUs, getUniqueUs )
 import Outputable
 \end{code}
 
@@ -42,11 +52,9 @@ data StixTree
     -- We can tag the leaves with constants/immediates.
 
   | StInt      Integer     -- ** add Kind at some point
+  | StFloat    Rational
   | StDouble   Rational
   | StString   FAST_STRING
-  | StLitLbl   SDoc    -- literal labels
-                           -- (will be _-prefixed on some machines)
-
   | StCLbl     CLabel      -- labels that we might index into
 
     -- Abstract registers of various kinds
@@ -74,10 +82,15 @@ data StixTree
   | StFunBegin CLabel
   | StFunEnd CLabel
 
-    -- An unconditional jump. This instruction is terminal.
-    -- Dynamic targets are allowed
+    -- An unconditional jump. This instruction may or may not jump
+    -- out of the register allocation domain (basic block, more or
+    -- less).  For correct register allocation when this insn is used
+    -- to jump through a jump table, we optionally allow a list of
+    -- the exact targets to be attached, so that the allocator can
+    -- easily construct the exact flow edges leaving this insn.
+    -- Dynamic targets are allowed.
 
-  | StJump StixTree
+  | StJump DestInfo StixTree
 
     -- A fall-through, from slow to fast
 
@@ -112,49 +125,60 @@ data StixTree
 
   | StComment FAST_STRING
 
-sStLitLbl :: FAST_STRING -> StixTree
-sStLitLbl s = StLitLbl (ptext s)
+
+-- used by insnFuture in RegAllocInfo.lhs
+data DestInfo
+   = NoDestInfo             -- no supplied dests; infer from context
+   | DestInfo [CLabel]      -- precisely these dests and no others
+
+pprDests :: DestInfo -> SDoc
+pprDests NoDestInfo      = text "NoDestInfo"
+pprDests (DestInfo dsts) = brack (hsep (map pprCLabel dsts))
 
 
 pprStixTrees :: [StixTree] -> SDoc
 pprStixTrees ts 
   = vcat [
-       vcat (map ppStixTree ts),
+       vcat (map pprStixTree ts),
        char ' ',
        char ' '
     ]
 
 paren t = char '(' <> t <> char ')'
+brack t = char '[' <> t <> char ']'
 
-ppStixTree :: StixTree -> SDoc
-ppStixTree t 
+pprStixTree :: StixTree -> SDoc
+pprStixTree t 
    = case t of
-       StSegment cseg -> paren (ppCodeSegment cseg)
-       StInt i        -> paren (integer i)
-       StDouble        rat   -> paren (text "Double" <+> rational rat)
-       StString str   -> paren (text "Str" <+> ptext str)
-       StComment str  -> paren (text "Comment" <+> ptext str)
-       StLitLbl sd    -> sd
-       StCLbl lbl     -> pprCLabel lbl
-       StReg reg      -> ppStixReg reg
-       StIndex k b o  -> paren (ppStixTree b <+> char '+' <> 
-                                pprPrimRep k <+> ppStixTree o)
-       StInd k t      -> pprPrimRep k <> char '[' <> ppStixTree t <> char ']'
-       StAssign k d s -> ppStixTree d <> text "  :=" <> pprPrimRep k 
-                                          <> text "  " <> ppStixTree s
-       StLabel ll     -> pprCLabel ll <+> char ':'
-       StFunBegin ll  -> char ' ' $$ paren (text "FunBegin" <+> pprCLabel ll)
-       StFunEnd ll    -> paren (text "FunEnd" <+> pprCLabel ll)
-       StJump t       -> paren (text "Jump" <+> ppStixTree t)
+       StSegment cseg   -> paren (ppCodeSegment cseg)
+       StInt i          -> paren (integer i)
+       StFloat rat      -> paren (text "Float" <+> rational rat)
+       StDouble        rat     -> paren (text "Double" <+> rational rat)
+       StString str     -> paren (text "Str" <+> ptext str)
+       StComment str    -> paren (text "Comment" <+> ptext str)
+       StCLbl lbl       -> pprCLabel lbl
+       StReg reg        -> ppStixReg reg
+       StIndex k b o    -> paren (pprStixTree b <+> char '+' <> 
+                                  pprPrimRep k <+> pprStixTree o)
+       StInd k t        -> pprPrimRep k <> char '[' <> pprStixTree t <> char ']'
+       StAssign k d s   -> pprStixTree d <> text "  :=" <> pprPrimRep k 
+                                         <> text "  " <> pprStixTree s
+       StLabel ll       -> pprCLabel ll <+> char ':'
+       StFunBegin ll    -> char ' ' $$ paren (text "FunBegin" <+> pprCLabel ll)
+       StFunEnd ll      -> paren (text "FunEnd" <+> pprCLabel ll)
+       StJump dsts t    -> paren (text "Jump" <+> pprDests dsts <+> pprStixTree t)
        StFallThrough ll -> paren (text "FallThru" <+> pprCLabel ll)
-       StCondJump l t -> paren (text "JumpC" <+> pprCLabel l <+> ppStixTree t)
-       StData k ds -> paren (text "Data" <+> pprPrimRep k <+>
-                      hsep (map ppStixTree ds))
-       StPrim op ts -> paren (text "Prim" <+> pprPrimOp op <+> hsep (map ppStixTree ts))
+       StCondJump l t   -> paren (text "JumpC" <+> pprCLabel l 
+                                               <+> pprStixTree t)
+       StData k ds      -> paren (text "Data" <+> pprPrimRep k <+>
+                                  hsep (map pprStixTree ds))
+       StPrim op ts     -> paren (text "Prim" <+> pprPrimOp op <+> 
+                                  hsep (map pprStixTree ts))
        StCall nm cc k args
-          -> paren (text "Call" <+> ptext nm <+>
-               pprCallConv cc <+> pprPrimRep k <+> hsep (map ppStixTree args))
-       StScratchWord i -> text "ScratchWord" <> paren (int i)
+                        -> paren (text "Call" <+> ptext nm <+>
+                                  pprCallConv cc <+> pprPrimRep k <+> 
+                                  hsep (map pprStixTree args))
+       StScratchWord i  -> text "ScratchWord" <> paren (int i)
 
 pprPrimRep = text . showPrimRep
 \end{code}
@@ -176,10 +200,12 @@ ppStixReg (StixTemp u pr)
 
 
 ppMId BaseReg              = text "BaseReg"
-ppMId (VanillaReg kind n)  = hcat [pprPrimRep kind, text "IntReg(", int (I# n), char ')']
+ppMId (VanillaReg kind n)  = hcat [pprPrimRep kind, text "IntReg(", 
+                                   int (I# n), char ')']
 ppMId (FloatReg n)         = hcat [text "FltReg(", int (I# n), char ')']
 ppMId (DoubleReg n)        = hcat [text "DblReg(", int (I# n), char ')']
-ppMId (LongReg kind n)     = hcat [pprPrimRep kind, text "LongReg(", int (I# n), char ')']
+ppMId (LongReg kind n)     = hcat [pprPrimRep kind, text "LongReg(", 
+                                   int (I# n), char ')']
 ppMId Sp                   = text "Sp"
 ppMId Su                   = text "Su"
 ppMId SpLim                = text "SpLim"
@@ -213,15 +239,166 @@ stgSu                = StReg (StixMagicId Su)
 stgSpLim           = StReg (StixMagicId SpLim)
 stgHp              = StReg (StixMagicId Hp)
 stgHpLim           = StReg (StixMagicId HpLim)
+stgCurrentTSO      = StReg (StixMagicId CurrentTSO)
+stgCurrentNursery   = StReg (StixMagicId CurrentNursery)
 stgR9               = StReg (StixMagicId (VanillaReg WordRep ILIT(9)))
 stgR10              = StReg (StixMagicId (VanillaReg WordRep ILIT(10)))
 
+getNatLabelNCG :: NatM CLabel
+getNatLabelNCG
+  = getUniqueNat `thenNat` \ u ->
+    returnNat (mkAsmTempLabel u)
+
 getUniqLabelNCG :: UniqSM CLabel
 getUniqLabelNCG
-  = getUniqueUs              `thenUs` \ u ->
+  = getUniqueUs `thenUs` \ u ->
     returnUs (mkAsmTempLabel u)
 
 fixedHS     = StInt (toInteger fixedHdrSize)
 arrWordsHS  = StInt (toInteger arrWordsHdrSize)
 arrPtrsHS   = StInt (toInteger arrPtrsHdrSize)
 \end{code}
+
+Stix optimisation passes may wish to find out how many times a
+given temporary appears in a tree, so as to be able to decide
+whether or not to inline the assignment's RHS at usage site(s).
+
+\begin{code}
+stixCountTempUses :: Unique -> StixTree -> Int
+stixCountTempUses u t 
+   = let qq = stixCountTempUses u
+     in
+     case t of
+        StReg reg
+           -> case reg of 
+                 StixTemp uu pr  -> if u == uu then 1 else 0
+                 StixMagicId mid -> 0
+
+        StIndex    pk t1 t2       -> qq t1 + qq t2
+        StInd      pk t1          -> qq t1
+        StAssign   pk t1 t2       -> qq t1 + qq t2
+        StJump     dsts t1        -> qq t1
+        StCondJump lbl t1         -> qq t1
+        StData     pk ts          -> sum (map qq ts)
+        StPrim     op ts          -> sum (map qq ts)
+        StCall     nm cconv pk ts -> sum (map qq ts)
+
+        StSegment _      -> 0
+        StInt _          -> 0
+        StFloat _        -> 0
+        StDouble _       -> 0
+        StString _       -> 0
+        StCLbl _         -> 0
+        StLabel _        -> 0
+        StFunBegin _     -> 0
+        StFunEnd _       -> 0
+        StFallThrough _  -> 0
+        StScratchWord _  -> 0
+        StComment _      -> 0
+
+
+stixSubst :: Unique -> StixTree -> StixTree -> StixTree
+stixSubst u new_u in_this_tree
+   = stixMapUniques f in_this_tree
+     where
+        f :: Unique -> Maybe StixTree
+        f uu = if uu == u then Just new_u else Nothing
+
+
+stixMapUniques :: (Unique -> Maybe StixTree) -> StixTree -> StixTree
+stixMapUniques f t
+   = let qq = stixMapUniques f
+     in
+     case t of
+        StReg reg
+           -> case reg of 
+                 StixMagicId mid -> t
+                 StixTemp uu pr  
+                    -> case f uu of
+                          Just xx -> xx
+                          Nothing -> t
+
+        StIndex    pk t1 t2       -> StIndex    pk (qq t1) (qq t2)
+        StInd      pk t1          -> StInd      pk (qq t1)
+        StAssign   pk t1 t2       -> StAssign   pk (qq t1) (qq t2)
+        StJump     dsts t1        -> StJump     dsts (qq t1)
+        StCondJump lbl t1         -> StCondJump lbl (qq t1)
+        StData     pk ts          -> StData     pk (map qq ts)
+        StPrim     op ts          -> StPrim     op (map qq ts)
+        StCall     nm cconv pk ts -> StCall     nm cconv pk (map qq ts)
+
+        StSegment _      -> t
+        StInt _          -> t
+        StFloat _        -> t
+        StDouble _       -> t
+        StString _       -> t
+        StCLbl _         -> t
+        StLabel _        -> t
+        StFunBegin _     -> t
+        StFunEnd _       -> t
+        StFallThrough _  -> t
+        StScratchWord _  -> t
+        StComment _      -> t
+\end{code}
+
+\begin{code}
+data NatM_State = NatM_State UniqSupply Int
+type NatM result = NatM_State -> (result, NatM_State)
+
+mkNatM_State :: UniqSupply -> Int -> NatM_State
+mkNatM_State = NatM_State
+
+uniqOfNatM_State  (NatM_State us delta) = us
+deltaOfNatM_State (NatM_State us delta) = delta
+
+
+initNat :: NatM_State -> NatM a -> (a, NatM_State)
+initNat init_st m = case m init_st of { (r,st) -> (r,st) }
+
+thenNat :: NatM a -> (a -> NatM b) -> NatM b
+thenNat expr cont st
+  = case expr st of { (result, st') -> cont result st' }
+
+returnNat :: a -> NatM a
+returnNat result st = (result, st)
+
+mapNat :: (a -> NatM b) -> [a] -> NatM [b]
+mapNat f []     = returnNat []
+mapNat f (x:xs)
+  = f x          `thenNat` \ r  ->
+    mapNat f xs  `thenNat` \ rs ->
+    returnNat (r:rs)
+
+mapAndUnzipNat :: (a -> NatM (b,c))   -> [a] -> NatM ([b],[c])
+mapAndUnzipNat f [] = returnNat ([],[])
+mapAndUnzipNat f (x:xs)
+  = f x                        `thenNat` \ (r1,  r2)  ->
+    mapAndUnzipNat f xs        `thenNat` \ (rs1, rs2) ->
+    returnNat (r1:rs1, r2:rs2)
+
+mapAccumLNat :: (acc -> x -> NatM (acc, y))
+                -> acc
+               -> [x]
+               -> NatM (acc, [y])
+
+mapAccumLNat f b []
+  = returnNat (b, [])
+mapAccumLNat f b (x:xs)
+  = f b x                          `thenNat` \ (b__2, x__2) ->
+    mapAccumLNat f b__2 xs         `thenNat` \ (b__3, xs__2) ->
+    returnNat (b__3, x__2:xs__2)
+
+
+getUniqueNat :: NatM Unique
+getUniqueNat (NatM_State us delta)
+    = case splitUniqSupply us of
+         (us1,us2) -> (uniqFromSupply us1, (NatM_State us2 delta))
+
+getDeltaNat :: NatM Int
+getDeltaNat st@(NatM_State us delta)
+   = (delta, st)
+
+setDeltaNat :: Int -> NatM ()
+setDeltaNat delta (NatM_State us _)
+   = ((), NatM_State us delta)
+\end{code}