ghc/compiler/codeGen/CodeGen.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
   3 %
   4 \section[CodeGen]{@CodeGen@: main module of the code generator}
   5
   6 This module says how things get going at the top level.
   7
   8 @codeGen@ is the interface to the outside world.  The \tr{cgTop*}
   9 functions drive the mangling of top-level bindings.
  10
  11 %************************************************************************
  12 %*                                                                      *
  13 \subsection[codeGen-outside-interface]{The code generator's offering to the world}
  14 %*                                                                      *
  15 %************************************************************************
  16
  17 \begin{code}
  18 #include "HsVersions.h"
  19
  20 module CodeGen ( codeGen ) where
  21
  22 IMP_Ubiq(){-uitous-}
  23
  24 import StgSyn
  25 import CgMonad
  26 import AbsCSyn
  27
  28 import AbsCUtils        ( mkAbstractCs, mkAbsCStmts )
  29 import Bag              ( foldBag )
  30 import CgBindery        ( CgIdInfo )
  31 import CgClosure        ( cgTopRhsClosure )
  32 import CgCon            ( cgTopRhsCon )
  33 import CgConTbls        ( genStaticConBits )
  34 import ClosureInfo      ( mkClosureLFInfo )
  35 import CmdLineOpts      ( opt_SccProfilingOn, opt_CompilingGhcInternals,
  36                           opt_EnsureSplittableC, opt_SccGroup
  37                         )
  38 import CStrings         ( modnameToC )
  39 import FiniteMap        ( FiniteMap )
  40 import Maybes           ( maybeToBool )
  41 import PrimRep          ( getPrimRepSize, PrimRep(..) )
  42 import Util             ( panic, assertPanic )
  43 \end{code}
  44
  45 \begin{code}
  46 codeGen :: FAST_STRING          -- module name
  47         -> ([CostCentre],       -- local cost-centres needing declaring/registering
  48             [CostCentre])       -- "extern" cost-centres needing declaring
  49         -> [Module]             -- import names
  50         -> [TyCon]              -- tycons with data constructors to convert
  51         -> FiniteMap TyCon [(Bool, [Maybe Type])]
  52                                 -- tycon specialisation info
  53         -> [StgBinding] -- bindings to convert
  54         -> AbstractC            -- output
  55
  56 codeGen mod_name (local_CCs, extern_CCs) import_names gen_tycons tycon_specs stg_pgm
  57   = let
  58         doing_profiling   = opt_SccProfilingOn
  59         compiling_prelude = opt_CompilingGhcInternals
  60         maybe_split       = if opt_EnsureSplittableC then CSplitMarker else AbsCNop
  61         cinfo             = MkCompInfo mod_name
  62     in
  63     if not doing_profiling then
  64         mkAbstractCs [
  65             genStaticConBits cinfo gen_tycons tycon_specs,
  66             initC cinfo (cgTopBindings maybe_split stg_pgm) ]
  67
  68     else -- yes, cost-centre profiling:
  69          -- Besides the usual stuff, we must produce:
  70          --
  71          -- * Declarations for the cost-centres defined in this module;
  72          -- * Code to participate in "registering" all the cost-centres
  73          --   in the program (done at startup time when the pgm is run).
  74          --
  75          -- (The local cost-centres involved in this are passed
  76          -- into the code-generator, as are the imported-modules' names.)
  77          --
  78          -- Note: we don't register/etc if compiling Prelude bits.
  79
  80         mkAbstractCs [
  81                 if compiling_prelude
  82                 then AbsCNop
  83                 else mkAbstractCs [mkAbstractCs (map (CCostCentreDecl True)  local_CCs),
  84                                    mkAbstractCs (map (CCostCentreDecl False) extern_CCs),
  85                                    mkCcRegister local_CCs import_names],
  86
  87                 genStaticConBits cinfo gen_tycons tycon_specs,
  88                 initC cinfo (cgTopBindings maybe_split stg_pgm) ]
  89   where
  90     -----------------
  91     grp_name  = case opt_SccGroup of
  92                   Just xx -> _PK_ xx
  93                   Nothing -> mod_name   -- default: module name
  94
  95     -----------------
  96     mkCcRegister ccs import_names
  97       = let
  98             register_ccs     = mkAbstractCs (map mk_register ccs)
  99             register_imports
 100               = foldr (mkAbsCStmts . mk_import_register) AbsCNop import_names
 101         in
 102         mkAbstractCs [
 103             CCallProfCCMacro SLIT("START_REGISTER_CCS") [CLitLit (modnameToC (SLIT("_reg") _APPEND_ mod_name)) AddrRep],
 104             register_ccs,
 105             register_imports,
 106             CCallProfCCMacro SLIT("END_REGISTER_CCS") []
 107         ]
 108       where
 109         mk_register cc
 110           = CCallProfCCMacro SLIT("REGISTER_CC") [mkCCostCentre cc]
 111
 112         mk_import_register import_name
 113           = CCallProfCCMacro SLIT("REGISTER_IMPORT") [CLitLit (modnameToC (SLIT("_reg") _APPEND_ import_name)) AddrRep]
 114 \end{code}
 115
 116 %************************************************************************
 117 %*                                                                      *
 118 \subsection[codegen-top-bindings]{Converting top-level STG bindings}
 119 %*                                                                      *
 120 %************************************************************************
 121
 122 @cgTopBindings@ is only used for top-level bindings, since they need
 123 to be allocated statically (not in the heap) and need to be labelled.
 124 No unboxed bindings can happen at top level.
 125
 126 In the code below, the static bindings are accumulated in the
 127 @MkCgState@, and transferred into the ``statics'' slot by @forkStatics@.
 128 This is so that we can write the top level processing in a compositional
 129 style, with the increasing static environment being plumbed as a state
 130 variable.
 131
 132 \begin{code}
 133 cgTopBindings :: AbstractC -> [StgBinding] -> Code
 134
 135 cgTopBindings split bindings = mapCs (cgTopBinding split) bindings
 136
 137 cgTopBinding :: AbstractC -> StgBinding -> Code
 138
 139 cgTopBinding split (StgNonRec name rhs)
 140   = absC split          `thenC`
 141     cgTopRhs name rhs   `thenFC` \ (name, info) ->
 142     addBindC name info
 143
 144 cgTopBinding split (StgRec pairs)
 145   = absC split          `thenC`
 146     fixC (\ new_binds -> addBindsC new_binds    `thenC`
 147                          mapFCs ( \ (b,e) -> cgTopRhs b e ) pairs
 148     )                   `thenFC` \ new_binds ->
 149     addBindsC new_binds
 150
 151 -- Urgh!  I tried moving the forkStatics call from the rhss of cgTopRhs
 152 -- to enclose the listFCs in cgTopBinding, but that tickled the
 153 -- statics "error" call in initC.  I DON'T UNDERSTAND WHY!
 154
 155 cgTopRhs :: Id -> StgRhs -> FCode (Id, CgIdInfo)
 156         -- the Id is passed along for setting up a binding...
 157
 158 cgTopRhs name (StgRhsCon cc con args)
 159   = forkStatics (cgTopRhsCon name con args (all zero_size args))
 160   where
 161     zero_size atom = getPrimRepSize (getArgPrimRep atom) == 0
 162
 163 cgTopRhs name (StgRhsClosure cc bi fvs upd_flag args body)
 164   = ASSERT(null fvs) -- There should be no free variables
 165     forkStatics (cgTopRhsClosure name cc bi args body lf_info)
 166   where
 167     lf_info = mkClosureLFInfo True{-top level-} [{-no fvs-}] upd_flag args
 168 \end{code}