[project @ 2004-08-13 10:45:16 by simonmar]
[ghc-hetmet.git] / ghc / compiler / codeGen / CgConTbls.lhs
index a3113e4..37ced1e 100644 (file)
@@ -1,62 +1,28 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 \section[CgConTbls]{Info tables and update bits for constructors}
 
 \begin{code}
-#include "HsVersions.h"
-
 module CgConTbls ( genStaticConBits ) where
 
-import Ubiq{-uitous-}
+#include "HsVersions.h"
 
 import AbsCSyn
 import CgMonad
 
-import AbsCUtils       ( mkAbsCStmts, mkAbstractCs, magicIdPrimRep )
-import CgCompInfo      ( uF_UPDATEE )
-import CgHeapery       ( heapCheck, allocDynClosure )
-import CgRetConv       ( mkLiveRegsMask,
-                         dataReturnConvAlg, ctrlReturnConvAlg,
-                         CtrlReturnConvention(..),
-                         DataReturnConvention(..)
-                       )
+import AbsCUtils       ( mkAbstractCs, mkAbsCStmts )
 import CgTailCall      ( performReturn, mkStaticAlgReturnCode )
-import CgUsages                ( getHpRelOffset )
-import CLabel          ( mkConEntryLabel, mkClosureLabel,
-                         mkConUpdCodePtrVecLabel,
-                         mkStdUpdCodePtrVecLabel, mkStdUpdVecTblLabel
-                       )
-import ClosureInfo     ( layOutStaticClosure, layOutDynCon,
-                         layOutPhantomClosure, closurePtrsSize,
-                         fitsMinUpdSize, mkConLFInfo,
-                         infoTableLabelFromCI, dataConLiveness
-                       )
-import CostCentre      ( dontCareCostCentre )
-import FiniteMap       ( fmToList )
-import HeapOffs                ( zeroOff, VirtualHeapOffset(..) )
-import Id              ( dataConTag, dataConSig,
-                         dataConArity, fIRST_TAG,
-                         emptyIdSet,
-                         GenId{-instance NamedThing-}
-                       )
-import Outputable      ( getLocalName )
-import PrimRep         ( getPrimRepSize, PrimRep(..) )
-import TyCon           ( tyConDataCons, mkSpecTyCon )
+import ClosureInfo     ( layOutStaticConstr, layOutDynConstr, ClosureInfo )
+import DataCon         ( DataCon, dataConRepArgTys, isNullaryDataCon )
+import TyCon           ( tyConDataCons, isEnumerationTyCon, TyCon )
 import Type            ( typePrimRep )
-import Util            ( panic )
-
-maybeIntLikeTyCon = panic "CgConTbls.maybeIntLikeTyCon (ToDo)"
-mkSameSpecCon = panic "CgConTbls.mkSameSpecCon (ToDo)"
+import CmdLineOpts
 \end{code}
 
 For every constructor we generate the following info tables:
        A static info table, for static instances of the constructor,
 
-       For constructors which return in registers (and only them),
-               an "inregs" info table.  This info table is rather emaciated;
-               it only contains update code and tag.
-
        Plus:
 
 \begin{tabular}{lll}
@@ -72,28 +38,20 @@ info & @GEN_INFO_TABLE@&      GENish (hence bigger than or equal to @MIN_UPD_SIZ
 Possible info tables for constructor con:
 
 \begin{description}
-\item[@con_info@:]
+\item[@_con_info@:]
 Used for dynamically let(rec)-bound occurrences of
 the constructor, and for updates.  For constructors
 which are int-like, char-like or nullary, when GC occurs,
 the closure tries to get rid of itself.
 
-\item[@con_inregs_info@:]
-Used when returning a new constructor in registers.
-Only for return-in-regs constructors.
-Macro: @INREGS_INFO_TABLE@.
-
-\item[@con_static_info@:]
+\item[@_static_info@:]
 Static occurrences of the constructor
 macro: @STATIC_INFO_TABLE@.
 \end{description}
 
-For zero-arity constructors, \tr{con}, we also generate a static closure:
 
-\begin{description}
-\item[@con_closure@:]
-A single static copy of the (zero-arity) constructor itself.
-\end{description}
+For zero-arity constructors, \tr{con}, we NO LONGER generate a static closure;
+it's place is taken by the top level defn of the constructor.
 
 For charlike and intlike closures there is a fixed array of static
 closures predeclared.
@@ -101,11 +59,9 @@ closures predeclared.
 \begin{code}
 genStaticConBits :: CompilationInfo    -- global info about the compilation
                 -> [TyCon]             -- tycons to generate
-                -> FiniteMap TyCon [(Bool, [Maybe Type])]
-                                       -- tycon specialisation info
                 -> AbstractC           -- output
 
-genStaticConBits comp_info gen_tycons tycon_specs
+genStaticConBits comp_info gen_tycons
   = -- for each type constructor:
     --  grab all its data constructors;
     --     for each one, generate an info table
@@ -118,64 +74,22 @@ genStaticConBits comp_info gen_tycons tycon_specs
     --       C labels are local to this module i.e. static
     --      since they may be duplicated in other modules
 
-    mkAbstractCs [ gen_for_tycon tc | tc <- gen_tycons ]
-      `mkAbsCStmts`
-    mkAbstractCs [ mkAbstractCs [ gen_for_spec_tycon tc spec
-                               | (imported_spec, spec) <- specs,
-                                 -- no code generated if spec is imported
-                                 not imported_spec
-                               ]
-                | (tc, specs) <- fmToList tycon_specs ]
+    mkAbstractCs [ gen_for_tycon tc `mkAbsCStmts` enum_closure_table tc
+                | tc <- gen_tycons ]
   where
     gen_for_tycon :: TyCon -> AbstractC
-    gen_for_tycon tycon
-      = mkAbstractCs (map (genConInfo comp_info tycon) data_cons)
-         `mkAbsCStmts`
-       maybe_tycon_vtbl
-      where
-       data_cons       = tyConDataCons tycon
-       tycon_upd_label = mkStdUpdVecTblLabel tycon
-
-       maybe_tycon_vtbl =
-         case ctrlReturnConvAlg tycon of
-           UnvectoredReturn 1 -> CRetUnVector tycon_upd_label
-                                       (mk_upd_label tycon (head data_cons))
-           UnvectoredReturn _ -> AbsCNop
-           VectoredReturn   _ -> CFlatRetVector tycon_upd_label
-                                       (map (mk_upd_label tycon) data_cons)
-    ------------------
-    gen_for_spec_tycon :: TyCon -> [Maybe Type] -> AbstractC
-
-    gen_for_spec_tycon tycon ty_maybes
-      = mkAbstractCs (map (genConInfo comp_info spec_tycon) spec_data_cons)
-         `mkAbsCStmts`
-       maybe_spec_tycon_vtbl
-      where
-       data_cons      = tyConDataCons tycon
-
-       spec_tycon     = mkSpecTyCon tycon ty_maybes
-       spec_data_cons = map (mkSameSpecCon ty_maybes) data_cons
-
-       spec_tycon_upd_label = mkStdUpdVecTblLabel spec_tycon
-
-       maybe_spec_tycon_vtbl =
-         case ctrlReturnConvAlg spec_tycon of
-           UnvectoredReturn 1 -> CRetUnVector spec_tycon_upd_label
-                                       (mk_upd_label spec_tycon (head spec_data_cons))
-           UnvectoredReturn _ -> AbsCNop
-           VectoredReturn   _ -> CFlatRetVector spec_tycon_upd_label
-                                       (map (mk_upd_label spec_tycon) spec_data_cons)
-    ------------------
-    mk_upd_label tycon con
-      = CLbl
-       (case (dataReturnConvAlg con) of
-         ReturnInRegs _ -> mkConUpdCodePtrVecLabel tycon tag
-         ReturnInHeap   -> mkStdUpdCodePtrVecLabel tycon tag)
-       CodePtrRep
-      where
-       tag = dataConTag con
+    gen_for_tycon tycon = mkAbstractCs [ genConInfo comp_info data_con 
+                                      | data_con <- tyConDataCons tycon ] 
+
+    enum_closure_table tycon
+       | isEnumerationTyCon tycon = CClosureTbl tycon
+       | otherwise                = AbsCNop
+               -- Put the table after the data constructor decls, because the
+               -- datatype closure table (for enumeration types)
+               -- to (say) PrelBase_$wTrue_closure, which is defined in code_stuff
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
 \subsection[CgConTbls-info-tables]{Generating info tables for constructors}
@@ -186,223 +100,64 @@ Generate the entry code, info tables, and (for niladic constructor) the
 static closure, for a constructor.
 
 \begin{code}
-genConInfo :: CompilationInfo -> TyCon -> Id -> AbstractC
+genConInfo :: CompilationInfo -> DataCon -> AbstractC
 
-genConInfo comp_info tycon data_con
-  = mkAbstractCs [
-                 CSplitMarker,
-                 inregs_upd_maybe,
+genConInfo comp_info data_con
+  =    -- Order of things is to reduce forward references
+    mkAbstractCs [if opt_EnsureSplittableC then CSplitMarker else AbsCNop,
                  closure_code,
-                 static_code,
-                 closure_maybe]
-       -- Order of things is to reduce forward references
+                 static_code]
   where
     (closure_info, body_code) = mkConCodeAndInfo data_con
 
     -- To allow the debuggers, interpreters, etc to cope with static
     -- data structures (ie those built at compile time), we take care that
     -- info-table contains the information we need.
-    (static_ci,_) = layOutStaticClosure data_con typePrimRep arg_tys (mkConLFInfo data_con)
-
-    body       = (initC comp_info (
-                     profCtrC SLIT("ENT_CON") [CReg node] `thenC`
-                     body_code))
-
-    entry_addr = CLbl entry_label CodePtrRep
-    con_descr  = _UNPK_ (getLocalName data_con)
-
-    closure_code        = CClosureInfoAndCode closure_info body Nothing
-                                             stdUpd con_descr
-                                             (dataConLiveness closure_info)
-    static_code         = CClosureInfoAndCode static_ci body Nothing
-                                             stdUpd con_descr
-                                             (dataConLiveness static_ci)
+    (static_ci,_) = layOutStaticConstr data_con typePrimRep arg_tys
 
-    inregs_upd_maybe    = genPhantomUpdInfo comp_info tycon data_con
+    static_body  = initC comp_info (
+                      profCtrC FSLIT("TICK_ENT_STATIC_CON") [CReg node] `thenC`
+                      ldv_enter_and_body_code)
 
-    stdUpd             = CLbl (mkStdUpdCodePtrVecLabel tycon tag) CodePtrRep
+    closure_body = initC comp_info (
+                      profCtrC FSLIT("TICK_ENT_DYN_CON") [CReg node] `thenC`
+                      ldv_enter_and_body_code)
 
-    tag                        = dataConTag data_con
+    ldv_enter_and_body_code = ldvEnter `thenC` body_code
 
-    cost_centre = mkCCostCentre dontCareCostCentre -- not worried about static data costs
+    -- Don't need any dynamic closure code for zero-arity constructors
+    closure_code = if zero_arity_con then 
+                       AbsCNop 
+                  else 
+                       CClosureInfoAndCode closure_info closure_body
 
-    -- For zero-arity data constructors, or, more accurately,
-    --          those which only have VoidRep args (or none):
-    --         We make the closure too (not just info tbl), so that we can share
-    --  one copy throughout.
-    closure_maybe = if not (all zero_size arg_tys) then
-                       AbsCNop
-                   else
-                       CStaticClosure  closure_label           -- Label for closure
-                                       static_ci               -- Info table
-                                       cost_centre
-                                       [{-No args!  A slight lie for constrs with VoidRep args-}]
+    static_code  = CClosureInfoAndCode static_ci static_body
 
-    zero_size arg_ty = getPrimRepSize (typePrimRep arg_ty) == 0
+    zero_arity_con   = isNullaryDataCon data_con
+       -- We used to check that all the arg-sizes were zero, but we don't
+       -- really have any constructors with only zero-size args, and it's
+       -- just one more thing to go wrong.
 
-    (_,_,arg_tys,_) = dataConSig   data_con
-    con_arity      = dataConArity data_con
-    entry_label     = mkConEntryLabel data_con
-    closure_label   = mkClosureLabel  data_con
+    arg_tys        = dataConRepArgTys  data_con
 \end{code}
 
 \begin{code}
-mkConCodeAndInfo :: Id                         -- Data constructor
+mkConCodeAndInfo :: DataCon            -- Data constructor
                 -> (ClosureInfo, Code) -- The info table
 
 mkConCodeAndInfo con
-  = case (dataReturnConvAlg con) of
-
-    ReturnInRegs regs ->
-       let
-           (closure_info, regs_w_offsets)
-             = layOutDynCon con magicIdPrimRep regs
-
-           body_code
-             = profCtrC SLIT("RET_OLD_IN_REGS") [mkIntCLit (length regs_w_offsets)] `thenC`
-
-               performReturn (mkAbstractCs (map move_to_reg regs_w_offsets))
-                             (mkStaticAlgReturnCode con Nothing {- Info-ptr already loaded-})
-                             emptyIdSet{-no live vars-}
-       in
-       (closure_info, body_code)
-
-    ReturnInHeap ->
-       let
-           (_, _, arg_tys, _) = dataConSig con
+  = let
+       arg_tys = dataConRepArgTys con
 
-           (closure_info, arg_things)
-               = layOutDynCon con typePrimRep arg_tys
+       (closure_info, arg_things) = layOutDynConstr con typePrimRep arg_tys
 
-           body_code
+       body_code
                = -- NB: We don't set CC when entering data (WDP 94/06)
-                 profCtrC SLIT("RET_OLD_IN_HEAP") [mkIntCLit (length arg_things)] `thenC`
+                 profCtrC FSLIT("TICK_RET_OLD") 
+                       [mkIntCLit (length arg_things)] `thenC`
 
-                 performReturn AbsCNop -- Ptr to thing already in Node
-                               (mkStaticAlgReturnCode con Nothing {- Info-ptr already loaded-})
-                               emptyIdSet{-no live vars-}
+                 performReturn AbsCNop         -- Ptr to thing already in Node
+                               (mkStaticAlgReturnCode con)
        in
        (closure_info, body_code)
-
-  where
-    move_to_reg :: (MagicId, VirtualHeapOffset {-from Node-}) -> AbstractC
-    move_to_reg (reg, offset)
-      = CAssign (CReg reg) (CVal (NodeRel offset) (magicIdPrimRep reg))
-\end{code}
-
-%************************************************************************
-%*                                                                     *
-\subsection[CgConTbls-updates]{Generating update bits for constructors}
-%*                                                                     *
-%************************************************************************
-
-Generate the "phantom" info table and update code, iff the constructor returns in regs
-
-\begin{code}
-
-genPhantomUpdInfo :: CompilationInfo -> TyCon -> Id{-data con-} -> AbstractC
-
-genPhantomUpdInfo comp_info tycon data_con
-  = case (dataReturnConvAlg data_con) of
-
-      ReturnInHeap -> AbsCNop  -- No need for a phantom update
-
-      ReturnInRegs regs ->
-       let
-           phantom_itbl = CClosureInfoAndCode phantom_ci AbsCNop Nothing
-                               upd_code con_descr
-                               (dataConLiveness phantom_ci)
-
-           phantom_ci = layOutPhantomClosure data_con (mkConLFInfo data_con)
-
-           con_descr = _UNPK_ (getLocalName data_con)
-
-           con_arity = dataConArity data_con
-
-           upd_code = CLabelledCode upd_label (mkAbsCStmts build_closure perform_return)
-           upd_label = mkConUpdCodePtrVecLabel tycon tag
-           tag = dataConTag data_con
-
-           updatee = CVal (SpBRel 0 (- uF_UPDATEE)) PtrRep
-
-           perform_return = mkAbstractCs
-             [
-               CMacroStmt POP_STD_UPD_FRAME [],
-               CReturn (CReg RetReg) return_info
-             ]
-
-           return_info =
-             case (ctrlReturnConvAlg tycon) of
-               UnvectoredReturn _ -> DirectReturn
-               VectoredReturn   _ -> StaticVectoredReturn (tag - fIRST_TAG)
-
-           -- Determine cost centre for the updated closures CC (and allocation)
-           -- CCC for lexical (now your only choice)
-           use_cc = CReg CurCostCentre -- what to put in the closure
-           blame_cc = use_cc -- who to blame for allocation
-
-           do_move (reg, virt_offset) =
-               CAssign (CVal (NodeRel virt_offset) (magicIdPrimRep reg)) (CReg reg)
-
-
-           -- Code for building a new constructor in place over the updatee
-                   overwrite_code
-             = profCtrC SLIT("UPD_CON_IN_PLACE")
-                        [mkIntCLit (length regs_w_offsets)]    `thenC`
-               absC (mkAbstractCs
-                 [
-                   CAssign (CReg node) updatee,
-
-                   -- Tell the storage mgr that we intend to update in place
-                   -- This may (in complicated mgrs eg generational) cause gc,
-                   -- and it may modify Node to point to another place to
-                   -- actually update into.
-                   CMacroStmt upd_inplace_macro [liveness_mask],
-
-                   -- Initialise the closure pointed to by node
-                   CInitHdr closure_info (NodeRel zeroOff) use_cc True,
-                   mkAbstractCs (map do_move regs_w_offsets),
-                   if con_arity /= 0 then
-                       CAssign (CReg infoptr) (CLbl info_label DataPtrRep)
-                   else
-                       AbsCNop
-                 ])
-
-           upd_inplace_macro = if closurePtrsSize closure_info == 0
-                               then UPD_INPLACE_NOPTRS
-                               else UPD_INPLACE_PTRS
-
-           -- Code for allocating a new constructor in the heap
-           alloc_code
-             = let
-                   amodes_w_offsets = [ (CReg r, o) | (r,o) <- regs_w_offsets ]
-               in
-                   -- Allocate and build closure specifying upd_new_w_regs
-                   allocDynClosure closure_info use_cc blame_cc amodes_w_offsets
-                                                       `thenFC` \ hp_offset ->
-                   getHpRelOffset hp_offset            `thenFC` \ hp_rel ->
-                   let
-                       amode = CAddr hp_rel
-                   in
-                   profCtrC SLIT("UPD_CON_IN_NEW")
-                            [mkIntCLit (length amodes_w_offsets)] `thenC`
-                   absC (mkAbstractCs
-                     [ CMacroStmt UPD_IND [updatee, amode],
-                       CAssign (CReg node) amode,
-                       CAssign (CReg infoptr) (CLbl info_label DataPtrRep)
-                     ])
-
-           (closure_info, regs_w_offsets) = layOutDynCon data_con magicIdPrimRep regs
-           info_label = infoTableLabelFromCI closure_info
-           liveness_mask = mkIntCLit (mkLiveRegsMask (node:regs))
-
-           build_closure =
-             if fitsMinUpdSize closure_info then
-               initC comp_info overwrite_code
-             else
-               initC comp_info (heapCheck regs False alloc_code)
-
-       in CClosureUpdInfo phantom_itbl
-
 \end{code}
-