ghc/compiler/codeGen/CgConTbls.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[CgConTbls]{Info tables and update bits for constructors}
   5
   6 \begin{code}
   7 module CgConTbls ( genStaticConBits ) where
   8
   9 #include "HsVersions.h"
  10
  11 import AbsCSyn
  12 import CgMonad
  13
  14 import StgSyn           ( SRT(..) )
  15 import AbsCUtils        ( mkAbstractCs, mkAbsCStmts )
  16 import CgTailCall       ( performReturn, mkStaticAlgReturnCode )
  17 import CLabel           ( mkConEntryLabel, mkStaticClosureLabel )
  18 import ClosureInfo      ( layOutStaticClosure, layOutDynCon,
  19                           mkConLFInfo, ClosureInfo
  20                         )
  21 import CostCentre       ( dontCareCCS )
  22 import FiniteMap        ( fmToList, FiniteMap )
  23 import DataCon          ( DataCon, dataConName, dataConAllRawArgTys )
  24 import Const            ( Con(..) )
  25 import Name             ( getOccString )
  26 import PrimRep          ( getPrimRepSize, PrimRep(..) )
  27 import TyCon            ( tyConDataCons, isEnumerationTyCon, TyCon )
  28 import Type             ( typePrimRep, Type )
  29 import Outputable
  30 \end{code}
  31
  32 For every constructor we generate the following info tables:
  33         A static info table, for static instances of the constructor,
  34
  35         Plus:
  36
  37 \begin{tabular}{lll}
  38 Info tbls &      Macro  &            Kind of constructor \\
  39 \hline
  40 info & @CONST_INFO_TABLE@&    Zero arity (no info -- compiler uses static closure)\\
  41 info & @CHARLIKE_INFO_TABLE@& Charlike   (no info -- compiler indexes fixed array)\\
  42 info & @INTLIKE_INFO_TABLE@&  Intlike; the one macro generates both info tbls\\
  43 info & @SPEC_INFO_TABLE@&     SPECish, and bigger than or equal to @MIN_UPD_SIZE@\\
  44 info & @GEN_INFO_TABLE@&      GENish (hence bigger than or equal to @MIN_UPD_SIZE@)\\
  45 \end{tabular}
  46
  47 Possible info tables for constructor con:
  48
  49 \begin{description}
  50 \item[@_con_info@:]
  51 Used for dynamically let(rec)-bound occurrences of
  52 the constructor, and for updates.  For constructors
  53 which are int-like, char-like or nullary, when GC occurs,
  54 the closure tries to get rid of itself.
  55
  56 \item[@_static_info@:]
  57 Static occurrences of the constructor
  58 macro: @STATIC_INFO_TABLE@.
  59 \end{description}
  60
  61 For zero-arity constructors, \tr{con}, we also generate a static closure:
  62
  63 \begin{description}
  64 \item[@_closure@:]
  65 A single static copy of the (zero-arity) constructor itself.
  66 \end{description}
  67
  68 For charlike and intlike closures there is a fixed array of static
  69 closures predeclared.
  70
  71 \begin{code}
  72 genStaticConBits :: CompilationInfo     -- global info about the compilation
  73                  -> [TyCon]             -- tycons to generate
  74                  -> AbstractC           -- output
  75
  76 genStaticConBits comp_info gen_tycons
  77   = -- for each type constructor:
  78     --   grab all its data constructors;
  79     --      for each one, generate an info table
  80     -- for each specialised type constructor
  81     --   for each specialisation of the type constructor
  82     --     grab data constructors, and generate info tables
  83
  84     -- ToDo: for tycons and specialisations which are not
  85     --       declared in this module we must ensure that the
  86     --       C labels are local to this module i.e. static
  87     --       since they may be duplicated in other modules
  88
  89     mkAbstractCs [ gen_for_tycon tc | tc <- gen_tycons ]
  90   where
  91     gen_for_tycon :: TyCon -> AbstractC
  92     gen_for_tycon tycon
  93       = mkAbstractCs (map (genConInfo comp_info tycon) (tyConDataCons tycon))
  94         `mkAbsCStmts` (
  95           -- after the con decls, so we don't need to declare the constructor labels
  96           if (isEnumerationTyCon tycon)
  97             then CClosureTbl tycon
  98             else AbsCNop
  99         )
 100 \end{code}
 101
 102 %************************************************************************
 103 %*                                                                      *
 104 \subsection[CgConTbls-info-tables]{Generating info tables for constructors}
 105 %*                                                                      *
 106 %************************************************************************
 107
 108 Generate the entry code, info tables, and (for niladic constructor) the
 109 static closure, for a constructor.
 110
 111 \begin{code}
 112 genConInfo :: CompilationInfo -> TyCon -> DataCon -> AbstractC
 113
 114 genConInfo comp_info tycon data_con
 115   = mkAbstractCs [
 116                   CSplitMarker,
 117                   closure_code,
 118                   static_code,
 119                   closure_maybe]
 120         -- Order of things is to reduce forward references
 121   where
 122     (closure_info, body_code) = mkConCodeAndInfo data_con
 123
 124     -- To allow the debuggers, interpreters, etc to cope with static
 125     -- data structures (ie those built at compile time), we take care that
 126     -- info-table contains the information we need.
 127     (static_ci,_) = layOutStaticClosure con_name typePrimRep arg_tys
 128                                 (mkConLFInfo data_con)
 129
 130     body       = (initC comp_info (
 131                       profCtrC SLIT("TICK_ENT_CON") [CReg node] `thenC`
 132                       body_code))
 133
 134     entry_addr = CLbl entry_label CodePtrRep
 135     con_descr  = getOccString data_con
 136
 137     -- Don't need any dynamic closure code for zero-arity constructors
 138     closure_code = if zero_arity_con then
 139                         AbsCNop
 140                    else
 141                         CClosureInfoAndCode closure_info body Nothing con_descr
 142
 143     static_code  = CClosureInfoAndCode static_ci body Nothing con_descr
 144
 145     cost_centre  = mkCCostCentreStack dontCareCCS -- not worried about static data costs
 146
 147     -- For zero-arity data constructors, or, more accurately,
 148     --   those which only have VoidRep args (or none):
 149     --  We make the closure too (not just info tbl), so that we can share
 150     --  one copy throughout.
 151     closure_maybe = if not zero_arity_con then
 152                         AbsCNop
 153                     else
 154                         CStaticClosure  closure_label           -- Label for closure
 155                                         static_ci               -- Info table
 156                                         cost_centre
 157                                         [{-No args!  A slight lie for constrs
 158                                            with VoidRep args-}]
 159
 160     zero_size arg_ty = getPrimRepSize (typePrimRep arg_ty) == 0
 161
 162     zero_arity_con   = all zero_size arg_tys
 163
 164     arg_tys         = dataConAllRawArgTys  data_con
 165     entry_label     = mkConEntryLabel      con_name
 166     closure_label   = mkStaticClosureLabel con_name
 167     con_name        = dataConName data_con
 168 \end{code}
 169
 170 \begin{code}
 171 mkConCodeAndInfo :: DataCon             -- Data constructor
 172                  -> (ClosureInfo, Code) -- The info table
 173
 174 mkConCodeAndInfo con
 175   = let
 176         arg_tys = dataConAllRawArgTys con
 177
 178         (closure_info, arg_things)
 179                 = layOutDynCon con typePrimRep arg_tys
 180
 181         body_code
 182                 = -- NB: We don't set CC when entering data (WDP 94/06)
 183                   profCtrC SLIT("TICK_RET_OLD")
 184                         [mkIntCLit (length arg_things)] `thenC`
 185
 186                   performReturn AbsCNop         -- Ptr to thing already in Node
 187                                 (mkStaticAlgReturnCode con)
 188         in
 189         (closure_info, body_code)
 190 \end{code}