[project @ 1998-01-08 18:03:08 by simonm]
[ghc-hetmet.git] / ghc / compiler / codeGen / CgExpr.lhs
index 4713767..904dd55 100644 (file)
@@ -8,42 +8,48 @@
 %********************************************************
 
 \begin{code}
-#include "HsVersions.h"
-
-module CgExpr (
-       cgExpr, cgSccExpr, getPrimOpArgAmodes
+module CgExpr ( cgExpr, getPrimOpArgAmodes ) where
 
-       -- and to make the interface self-sufficient...
-    ) where
+#include "HsVersions.h"
 
+import Constants       ( mAX_SPEC_SELECTEE_SIZE )
 import StgSyn
 import CgMonad
 import AbsCSyn
 
-import PrelInfo                ( PrimOp(..), PrimOpResultInfo(..), HeapRequirement(..),
-                         primOpHeapReq, getPrimOpResultInfo, PrimRep,
-                         primOpCanTriggerGC
-                         IF_ATTACK_PRAGMAS(COMMA tagOf_PrimOp)
-                         IF_ATTACK_PRAGMAS(COMMA pprPrimOp)
-                       )
-import Type            ( isPrimType, getTyConDataCons )
-import CLabel  ( CLabel, mkPhantomInfoTableLabel, mkInfoTableVecTblLabel )
-import ClosureInfo     ( LambdaFormInfo, mkClosureLFInfo )
-import CgBindery       ( getAtomAmodes )
+import AbsCUtils       ( mkAbsCStmts, mkAbstractCs )
+import CgBindery       ( getArgAmodes, getCAddrModeAndInfo, CgIdInfo )
 import CgCase          ( cgCase, saveVolatileVarsAndRegs )
 import CgClosure       ( cgRhsClosure )
 import CgCon           ( buildDynCon, cgReturnDataCon )
 import CgHeapery       ( allocHeap )
 import CgLetNoEscape   ( cgLetNoEscapeClosure )
-import CgRetConv       -- various things...
-import CgTailCall      ( cgTailCall, performReturn, mkDynamicAlgReturnCode,
-                         mkPrimReturnCode
+import CgRetConv       ( dataReturnConvAlg, ctrlReturnConvAlg,
+                         DataReturnConvention(..), CtrlReturnConvention(..),
+                         assignPrimOpResultRegs, makePrimOpArgsRobust
+                       )
+import CgTailCall      ( cgTailCall, performReturn,
+                         mkDynamicAlgReturnCode, mkPrimReturnCode
+                       )
+import CLabel          ( mkPhantomInfoTableLabel, mkInfoTableVecTblLabel )
+import ClosureInfo     ( mkClosureLFInfo, mkSelectorLFInfo, mkVapLFInfo,
+                         layOutDynCon )
+import CostCentre      ( sccAbleCostCentre, isDictCC, isSccCountCostCentre )
+import HeapOffs                ( VirtualSpBOffset, intOffsetIntoGoods )
+import Id              ( dataConTyCon, idPrimRep, getIdArity, 
+                         mkIdSet, unionIdSets, GenId{-instance Outputable-},
+                         Id
                        )
-import CostCentre      ( setToAbleCostCentre, isDupdCC, CostCentre )
-import Maybes          ( Maybe(..) )
-import PrimRep         ( getPrimRepSize )
-import UniqSet
-import Util
+import IdInfo          ( ArityInfo(..) )
+import Name            ( isLocallyDefined )
+import PrimOp          ( primOpCanTriggerGC, primOpHeapReq, HeapRequirement(..),
+                         getPrimOpResultInfo, PrimOp(..), PrimOpResultInfo(..)
+                       )
+import PrimRep         ( getPrimRepSize, PrimRep(..) )
+import TyCon           ( tyConDataCons, maybeTyConSingleCon  )
+import Maybes          ( assocMaybe, maybeToBool )
+import Util            ( isIn )
+import Outputable
 \end{code}
 
 This module provides the support code for @StgToAbstractC@ to deal
@@ -77,7 +83,7 @@ cgExpr (StgApp fun args live_vars) = cgTailCall fun args live_vars
 
 \begin{code}
 cgExpr (StgCon con args live_vars)
-  = getAtomAmodes args `thenFC` \ amodes ->
+  = getArgAmodes args `thenFC` \ amodes ->
     cgReturnDataCon con amodes (all zero_size args) live_vars
   where
     zero_size atom = getPrimRepSize (getArgPrimRep atom) == 0
@@ -93,10 +99,10 @@ Here is where we insert real live machine instructions.
 
 \begin{code}
 cgExpr x@(StgPrim op args live_vars)
-  = getIntSwitchChkrC          `thenFC` \ isw_chkr ->
+  = ASSERT(op /= SeqOp) -- can't handle SeqOp
     getPrimOpArgAmodes op args `thenFC` \ arg_amodes ->
     let
-       result_regs   = assignPrimOpResultRegs {-NO:isw_chkr-} op
+       result_regs   = assignPrimOpResultRegs op
        result_amodes = map CReg result_regs
        may_gc  = primOpCanTriggerGC op
        dyn_tag = head result_amodes
@@ -108,7 +114,7 @@ cgExpr x@(StgPrim op args live_vars)
        -- (Can-trigger-gc primops guarantee to have their args in regs)
        let
            (arg_robust_amodes, liveness_mask, arg_assts)
-             = makePrimOpArgsRobust {-NO:isw_chkr-} op arg_amodes
+             = makePrimOpArgsRobust op arg_amodes
 
            liveness_arg = mkIntCLit liveness_mask
        in
@@ -172,20 +178,18 @@ cgExpr x@(StgPrim op args live_vars)
                vec_lbl  = CTableEntry (CLbl (mkInfoTableVecTblLabel tycon) DataPtrRep)
                                dyn_tag DataPtrRep
 
-               data_con = head (getTyConDataCons tycon)
+               data_con = head (tyConDataCons tycon)
 
                (dir_lbl, num_of_fields)
-                 = case (dataReturnConvAlg fake_isw_chkr data_con) of
+                 = case (dataReturnConvAlg data_con) of
                      ReturnInRegs rs
                        -> (CLbl (mkPhantomInfoTableLabel data_con) DataPtrRep,
                            mkIntCLit (length rs)) -- for ticky-ticky only
 
                      ReturnInHeap
-                       -> pprPanic "CgExpr: can't return prim in heap:" (ppr PprDebug data_con)
+                       -> pprPanic "CgExpr: can't return prim in heap:" (ppr data_con)
                          -- Never used, and no point in generating
                          -- the code for it!
-
-               fake_isw_chkr x = Nothing
   where
     -- for all PrimOps except ccalls, we pin the liveness info
     -- on as the first "argument"
@@ -271,30 +275,17 @@ cgExpr (StgLetNoEscape live_in_whole_let live_in_rhss bindings body)
 
 SCC expressions are treated specially. They set the current cost
 centre.
-
-For evaluation scoping we also need to save the cost centre in an
-``restore CC frame''. We only need to do this once before setting all
-nested SCCs.
-
 \begin{code}
-cgExpr scc_expr@(StgSCC ty cc expr) = cgSccExpr scc_expr
+cgExpr (StgSCC ty cc expr)
+  = ASSERT(sccAbleCostCentre cc)
+    costCentresC
+       (if isDictCC cc then SLIT("SET_DICT_CCC") else SLIT("SET_CCC"))
+       [mkCCostCentre cc, mkIntCLit (if isSccCountCostCentre cc then 1 else 0)]
+    `thenC`
+    cgExpr expr
 \end{code}
 
-@cgSccExpr@ (also used in \tr{CgClosure}):
-We *don't* set the cost centre for CAF/Dict cost centres
-[Likewise Subsumed and NoCostCentre, but they probably
-don't exist in an StgSCC expression.]
-\begin{code}
-cgSccExpr (StgSCC ty cc expr)
-  = (if setToAbleCostCentre cc then
-       costCentresC SLIT("SET_CCC")
-           [mkCCostCentre cc, mkIntCLit (if isDupdCC cc then 1 else 0)]
-     else
-       nopC)           `thenC`
-    cgSccExpr expr
-cgSccExpr other
-  = cgExpr other
-\end{code}
+ToDo: counting of dict sccs ...
 
 %********************************************************
 %*                                                     *
@@ -303,9 +294,6 @@ cgSccExpr other
 %********************************************************
 \subsection[non-top-level-bindings]{Converting non-top-level bindings}
 
-@cgBinding@ is only used for let/letrec, not for unboxed bindings.
-So the kind should always be @PtrRep@.
-
 We rely on the support code in @CgCon@ (to do constructors) and
 in @CgClosure@ (to do closures).
 
@@ -314,7 +302,7 @@ cgRhs :: Id -> StgRhs -> FCode (Id, CgIdInfo)
        -- the Id is passed along so a binding can be set up
 
 cgRhs name (StgRhsCon maybe_cc con args)
-  = getAtomAmodes args         `thenFC` \ amodes ->
+  = getArgAmodes args          `thenFC` \ amodes ->
     buildDynCon name maybe_cc con amodes (all zero_size args)
                                `thenFC` \ idinfo ->
     returnFC (name, idinfo)
@@ -324,9 +312,115 @@ cgRhs name (StgRhsCon maybe_cc con args)
 cgRhs name (StgRhsClosure cc bi fvs upd_flag args body)
   = cgRhsClosure name cc bi fvs args body lf_info
   where
-    lf_info = mkClosureLFInfo False{-not top level-} fvs upd_flag args body
+    lf_info = mkRhsLFInfo fvs upd_flag args body
+    
 \end{code}
 
+mkRhsLFInfo looks for two special forms of the right-hand side:
+       a) selector thunks.
+       b) VAP thunks
+
+If neither happens, it just calls mkClosureLFInfo.  You might think
+that mkClosureLFInfo should do all this, but
+
+       (a) it seems wrong for the latter to look at the structure 
+               of an expression
+
+       [March 97: item (b) is no longer true, but I've left mkRhsLFInfo here
+        anyway because of (a).]
+
+       (b) mkRhsLFInfo has to be in the monad since it looks up in
+               the environment, and it's very tiresome for mkClosureLFInfo to
+               be.  Apart from anything else it would make a loop between
+               CgBindery and ClosureInfo.
+
+Selectors
+~~~~~~~~~
+We look at the body of the closure to see if it's a selector---turgid,
+but nothing deep.  We are looking for a closure of {\em exactly} the
+form:
+\begin{verbatim}
+...  = [the_fv] \ u [] ->
+        case the_fv of
+          con a_1 ... a_n -> a_i
+\end{verbatim}
+
+\begin{code}
+mkRhsLFInfo    [the_fv]                -- Just one free var
+               Updatable               -- Updatable thunk
+               []                      -- A thunk
+               (StgCase (StgApp (StgVarArg scrutinee) [{-no args-}] _)
+                     _ _ _   -- ignore live vars and uniq...
+                     (StgAlgAlts case_ty
+                        [(con, params, use_mask,
+                           (StgApp (StgVarArg selectee) [{-no args-}] _))]
+                        StgNoDefault))
+  |  the_fv == scrutinee                       -- Scrutinee is the only free variable
+  && maybeToBool maybe_offset                  -- Selectee is a component of the tuple
+  && maybeToBool offset_into_int_maybe
+  && offset_into_int <= mAX_SPEC_SELECTEE_SIZE -- Offset is small enough
+  = -- ASSERT(is_single_constructor)           -- Should be true, but causes error for SpecTyCon
+    mkSelectorLFInfo scrutinee con offset_into_int
+  where
+    (_, params_w_offsets) = layOutDynCon con idPrimRep params
+    maybe_offset         = assocMaybe params_w_offsets selectee
+    Just the_offset      = maybe_offset
+    offset_into_int_maybe = intOffsetIntoGoods the_offset
+    Just offset_into_int  = offset_into_int_maybe
+    is_single_constructor = maybeToBool (maybeTyConSingleCon tycon)
+    tycon                = dataConTyCon con
+\end{code}
+
+
+Vap thunks
+~~~~~~~~~~
+Same kind of thing, looking for vector-apply thunks, of the form:
+
+       x = [...] \ .. [] -> f a1 .. an
+
+where f has arity n.  We rely on the arity info inside the Id being correct.
+
+\begin{code}
+mkRhsLFInfo    fvs
+               upd_flag
+               []                      -- No args; a thunk
+               (StgApp (StgVarArg fun_id) args _)
+  | isLocallyDefined fun_id            -- Must be defined in this module
+  =    -- Get the arity of the fun_id.  It's guaranteed to be correct (by setStgVarInfo).
+     let
+       arity_maybe = case getIdArity fun_id of
+                       ArityExactly n  -> Just n
+                       other           -> Nothing
+     in
+     case arity_maybe of
+               Just arity
+                   | arity > 0 &&                      -- It'd better be a function!
+                     arity == length args              -- Saturated application
+                   ->          -- Ha!  A VAP thunk
+                       mkVapLFInfo fvs upd_flag fun_id args store_fun_in_vap
+
+               other -> mkClosureLFInfo False{-not top level-} fvs upd_flag []
+  where        
+       -- If the function is a free variable then it must be stored
+       -- in the thunk too; if it isn't a free variable it must be
+       -- because it's constant, so it doesn't need to be stored in the thunk
+    store_fun_in_vap = fun_id `is_elem` fvs
+    is_elem         = isIn "mkClosureLFInfo"
+\end{code}
+
+The default case
+~~~~~~~~~~~~~~~~
+\begin{code}
+mkRhsLFInfo fvs upd_flag args body
+  = mkClosureLFInfo False{-not top level-} fvs upd_flag args
+\end{code}
+
+
+%********************************************************
+%*                                                     *
+%*             Let-no-escape bindings
+%*                                                     *
+%********************************************************
 \begin{code}
 cgLetNoEscapeBindings live_in_rhss rhs_eob_info maybe_cc_slot (StgNonRec binder rhs)
   = cgLetNoEscapeRhs live_in_rhss rhs_eob_info maybe_cc_slot binder rhs
@@ -344,7 +438,7 @@ cgLetNoEscapeBindings live_in_rhss rhs_eob_info maybe_cc_slot (StgRec pairs)
   where
     -- We add the binders to the live-in-rhss set so that we don't
     -- delete the bindings for the binder from the environment!
-    full_live_in_rhss = live_in_rhss `unionUniqSets` (mkUniqSet [b | (b,r) <- pairs])
+    full_live_in_rhss = live_in_rhss `unionIdSets` (mkIdSet [b | (b,r) <- pairs])
 
 cgLetNoEscapeRhs
     :: StgLiveVars     -- Live in rhss
@@ -386,10 +480,9 @@ Main current use: allocating SynchVars.
 
 \begin{code}
 getPrimOpArgAmodes op args
-  = getAtomAmodes args         `thenFC` \ arg_amodes ->
+  = getArgAmodes args          `thenFC` \ arg_amodes ->
 
     case primOpHeapReq op of
-
        FixedHeapRequired size -> allocHeap size `thenFC` \ amode ->
                                  returnFC (amode : arg_amodes)