ghc/compiler/codeGen/CodeGen.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   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 module CodeGen ( codeGen ) where
  19
  20 #include "HsVersions.h"
  21
  22 -- Kludge (??) so that CgExpr is reached via at least one non-SOURCE
  23 -- import.  Before, that wasn't the case, and CM therefore didn't
  24 -- bother to compile it.
  25 import CgExpr           ( {-NOTHING!-} )        -- DO NOT DELETE THIS IMPORT
  26 import CgProf
  27 import CgMonad
  28 import CgBindery        ( CgIdInfo, addBindC, addBindsC, getCgIdInfo,
  29                           cgIdInfoId )
  30 import CgClosure        ( cgTopRhsClosure )
  31 import CgCon            ( cgTopRhsCon, cgTyCon )
  32 import CgUtils          ( cmmRegOffW, emitRODataLits, cmmNeWord, emitRtsCall )
  33
  34 import CLabel
  35 import Cmm
  36 import CmmUtils         ( zeroCLit, mkIntCLit, mkLblExpr )
  37 import PprCmm           ( pprCmms )
  38 import MachOp           ( wordRep, MachHint(..) )
  39
  40 import StgSyn
  41 import PrelNames        ( gHC_PRIM, rOOT_MAIN, mAIN, pREL_TOP_HANDLER )
  42 import DynFlags         ( DynFlags(..), DynFlag(..), dopt )
  43 import StaticFlags      ( opt_SccProfilingOn )
  44
  45 import HscTypes         ( ForeignStubs(..), TypeEnv, typeEnvTyCons )
  46 import CostCentre       ( CollectedCCs )
  47 import Id               ( Id, idName, setIdName )
  48 import Name             ( nameSrcLoc, nameOccName, nameUnique, isInternalName, mkExternalName )
  49 import OccName          ( mkLocalOcc )
  50 import TyCon            ( isDataTyCon )
  51 import Module           ( Module, mkModule )
  52 import ErrUtils         ( dumpIfSet_dyn, showPass )
  53 import Panic            ( assertPanic )
  54
  55 #ifdef DEBUG
  56 import Outputable
  57 #endif
  58 \end{code}
  59
  60 \begin{code}
  61 codeGen :: DynFlags
  62         -> Module
  63         -> TypeEnv
  64         -> ForeignStubs
  65         -> [Module]             -- directly-imported modules
  66         -> CollectedCCs         -- (Local/global) cost-centres needing declaring/registering.
  67         -> [(StgBinding,[(Id,[Id])])]   -- Bindings to convert, with SRTs
  68         -> IO [Cmm]             -- Output
  69
  70 codeGen dflags this_mod type_env foreign_stubs imported_mods
  71         cost_centre_info stg_binds
  72   = do
  73   { showPass dflags "CodeGen"
  74   ; let way = buildTag dflags
  75         mb_main_mod = mainModIs dflags
  76
  77   ; let     tycons      = typeEnvTyCons type_env
  78             data_tycons = filter isDataTyCon tycons
  79
  80 -- Why?
  81 --   ; mapM_ (\x -> seq x (return ())) data_tycons
  82
  83   ; code_stuff <- initC dflags this_mod $ do
  84                 { cmm_binds  <- mapM (getCmm . cgTopBinding dflags) stg_binds
  85                 ; cmm_tycons <- mapM cgTyCon data_tycons
  86                 ; cmm_init   <- getCmm (mkModuleInit dflags way cost_centre_info
  87                                              this_mod mb_main_mod
  88                                              foreign_stubs imported_mods)
  89                 ; return (cmm_binds ++ concat cmm_tycons
  90                         ++ if opt_SccProfilingOn
  91 #if defined(mingw32_HOST_OS)
  92                               || True
  93 #endif
  94                             then [cmm_init]
  95                             else [])
  96                 }
  97                 -- Put datatype_stuff after code_stuff, because the
  98                 -- datatype closure table (for enumeration types) to
  99                 -- (say) PrelBase_True_closure, which is defined in
 100                 -- code_stuff
 101
 102   ; dumpIfSet_dyn dflags Opt_D_dump_cmm "Cmm" (pprCmms code_stuff)
 103
 104   ; return code_stuff }
 105 \end{code}
 106
 107 %************************************************************************
 108 %*                                                                      *
 109 \subsection[codegen-init]{Module initialisation code}
 110 %*                                                                      *
 111 %************************************************************************
 112
 113 /* -----------------------------------------------------------------------------
 114    Module initialisation
 115
 116    The module initialisation code looks like this, roughly:
 117
 118         FN(__stginit_Foo) {
 119           JMP_(__stginit_Foo_1_p)
 120         }
 121
 122         FN(__stginit_Foo_1_p) {
 123         ...
 124         }
 125
 126    We have one version of the init code with a module version and the
 127    'way' attached to it.  The version number helps to catch cases
 128    where modules are not compiled in dependency order before being
 129    linked: if a module has been compiled since any modules which depend on
 130    it, then the latter modules will refer to a different version in their
 131    init blocks and a link error will ensue.
 132
 133    The 'way' suffix helps to catch cases where modules compiled in different
 134    ways are linked together (eg. profiled and non-profiled).
 135
 136    We provide a plain, unadorned, version of the module init code
 137    which just jumps to the version with the label and way attached.  The
 138    reason for this is that when using foreign exports, the caller of
 139    startupHaskell() must supply the name of the init function for the "top"
 140    module in the program, and we don't want to require that this name
 141    has the version and way info appended to it.
 142    --------------------------------------------------------------------------  */
 143
 144 We initialise the module tree by keeping a work-stack,
 145         * pointed to by Sp
 146         * that grows downward
 147         * Sp points to the last occupied slot
 148
 149
 150 \begin{code}
 151 mkModuleInit
 152         :: DynFlags
 153         -> String               -- the "way"
 154         -> CollectedCCs         -- cost centre info
 155         -> Module
 156         -> Maybe String         -- Just m ==> we have flag: -main-is Foo.baz
 157         -> ForeignStubs
 158         -> [Module]
 159         -> Code
 160 mkModuleInit dflags way cost_centre_info this_mod mb_main_mod foreign_stubs imported_mods
 161   = do  {
 162
 163         -- Allocate the static boolean that records if this
 164         -- module has been registered already
 165         ; emitData Data [CmmDataLabel moduleRegdLabel,
 166                          CmmStaticLit zeroCLit]
 167
 168         ; emitSimpleProc real_init_lbl $ do
 169             {   -- The return-code pops the work stack by
 170                 -- incrementing Sp, and then jumpd to the popped item
 171               ret_blk <- forkLabelledCode $ stmtsC
 172                         [ CmmAssign spReg (cmmRegOffW spReg 1)
 173                         , CmmJump (CmmLoad (cmmRegOffW spReg (-1)) wordRep) [] ]
 174
 175             ; init_blk <- forkLabelledCode $ do
 176                             { mod_init_code; stmtC (CmmBranch ret_blk) }
 177
 178             ; stmtC (CmmCondBranch (cmmNeWord (CmmLit zeroCLit) mod_reg_val)
 179                         ret_blk)
 180             ; stmtC (CmmBranch init_blk)
 181             }
 182
 183
 184             -- Make the "plain" procedure jump to the "real" init procedure
 185         ; emitSimpleProc plain_init_lbl jump_to_init
 186
 187         -- When compiling the module in which the 'main' function lives,
 188         -- (that is, this_mod == main_mod)
 189         -- we inject an extra stg_init procedure for stg_init_ZCMain, for the
 190         -- RTS to invoke.  We must consult the -main-is flag in case the
 191         -- user specified a different function to Main.main
 192         ; whenC (this_mod == main_mod)
 193                 (emitSimpleProc plain_main_init_lbl jump_to_init)
 194     }
 195   where
 196     plain_init_lbl = mkPlainModuleInitLabel dflags this_mod
 197     real_init_lbl  = mkModuleInitLabel dflags this_mod way
 198     plain_main_init_lbl = mkPlainModuleInitLabel dflags rOOT_MAIN
 199
 200     jump_to_init = stmtC (CmmJump (mkLblExpr real_init_lbl) [])
 201
 202     mod_reg_val = CmmLoad (mkLblExpr moduleRegdLabel) wordRep
 203
 204     main_mod = case mb_main_mod of
 205                         Just mod_name -> mkModule mod_name
 206                         Nothing       -> mAIN
 207
 208     -- Main refers to GHC.TopHandler.runIO, so make sure we call the
 209     -- init function for GHC.TopHandler.
 210     extra_imported_mods
 211         | this_mod == main_mod = [pREL_TOP_HANDLER]
 212         | otherwise            = []
 213
 214     mod_init_code = do
 215         {       -- Set mod_reg to 1 to record that we've been here
 216           stmtC (CmmStore (mkLblExpr moduleRegdLabel) (CmmLit (mkIntCLit 1)))
 217
 218                 -- Now do local stuff
 219 #if defined(mingw32_HOST_OS)
 220         ; registerForeignExports foreign_stubs
 221 #endif
 222         ; initCostCentres cost_centre_info
 223         ; mapCs (registerModuleImport dflags way)
 224                 (imported_mods++extra_imported_mods)
 225         }
 226
 227
 228 -----------------------
 229 registerModuleImport :: DynFlags -> String -> Module -> Code
 230 registerModuleImport dflags way mod
 231   | mod == gHC_PRIM
 232   = nopC
 233   | otherwise   -- Push the init procedure onto the work stack
 234   = stmtsC [ CmmAssign spReg (cmmRegOffW spReg (-1))
 235            , CmmStore (CmmReg spReg) (mkLblExpr (mkModuleInitLabel dflags mod way)) ]
 236
 237 -----------------------
 238 registerForeignExports :: ForeignStubs -> Code
 239 registerForeignExports NoStubs
 240   = nopC
 241 registerForeignExports (ForeignStubs _ _ _ fe_bndrs)
 242   = mapM_ mk_export_register fe_bndrs
 243   where
 244         mk_export_register bndr
 245           = emitRtsCall SLIT("getStablePtr")
 246                 [ (CmmLit (CmmLabel (mkLocalClosureLabel (idName bndr))),
 247                    PtrHint) ]
 248 \end{code}
 249
 250
 251
 252 Cost-centre profiling: Besides the usual stuff, we must produce
 253 declarations for the cost-centres defined in this module;
 254
 255 (The local cost-centres involved in this are passed into the
 256 code-generator.)
 257
 258 \begin{code}
 259 initCostCentres :: CollectedCCs -> Code
 260 -- Emit the declarations, and return code to register them
 261 initCostCentres (local_CCs, ___extern_CCs, singleton_CCSs)
 262   | not opt_SccProfilingOn = nopC
 263   | otherwise
 264   = do  { mapM_ emitCostCentreDecl       local_CCs
 265         ; mapM_ emitCostCentreStackDecl  singleton_CCSs
 266         ; mapM_ emitRegisterCC           local_CCs
 267         ; mapM_ emitRegisterCCS          singleton_CCSs
 268         }
 269 \end{code}
 270
 271 %************************************************************************
 272 %*                                                                      *
 273 \subsection[codegen-top-bindings]{Converting top-level STG bindings}
 274 %*                                                                      *
 275 %************************************************************************
 276
 277 @cgTopBinding@ is only used for top-level bindings, since they need
 278 to be allocated statically (not in the heap) and need to be labelled.
 279 No unboxed bindings can happen at top level.
 280
 281 In the code below, the static bindings are accumulated in the
 282 @MkCgState@, and transferred into the ``statics'' slot by @forkStatics@.
 283 This is so that we can write the top level processing in a compositional
 284 style, with the increasing static environment being plumbed as a state
 285 variable.
 286
 287 \begin{code}
 288 cgTopBinding :: DynFlags -> (StgBinding,[(Id,[Id])]) -> Code
 289 cgTopBinding dflags (StgNonRec id rhs, srts)
 290   = do  { id' <- maybeExternaliseId dflags id
 291         ; mapM_ (mkSRT dflags [id']) srts
 292         ; (id,info) <- cgTopRhs id' rhs
 293         ; addBindC id info      -- Add the *un-externalised* Id to the envt,
 294                                 -- so we find it when we look up occurrences
 295         }
 296
 297 cgTopBinding dflags (StgRec pairs, srts)
 298   = do  { let (bndrs, rhss) = unzip pairs
 299         ; bndrs' <- mapFCs (maybeExternaliseId dflags) bndrs
 300         ; let pairs' = zip bndrs' rhss
 301         ; mapM_ (mkSRT dflags bndrs')  srts
 302         ; _new_binds <- fixC (\ new_binds -> do
 303                 { addBindsC new_binds
 304                 ; mapFCs ( \ (b,e) -> cgTopRhs b e ) pairs' })
 305         ; nopC }
 306
 307 mkSRT :: DynFlags -> [Id] -> (Id,[Id]) -> Code
 308 mkSRT dflags these (id,[])  = nopC
 309 mkSRT dflags these (id,ids)
 310   = do  { ids <- mapFCs remap ids
 311         ; id  <- remap id
 312         ; emitRODataLits (mkSRTLabel (idName id))
 313                        (map (CmmLabel . mkClosureLabel dflags . idName) ids)
 314         }
 315   where
 316         -- Sigh, better map all the ids against the environment in
 317         -- case they've been externalised (see maybeExternaliseId below).
 318     remap id = case filter (==id) these of
 319                 (id':_) -> returnFC id'
 320                 [] -> do { info <- getCgIdInfo id; return (cgIdInfoId info) }
 321
 322 -- Urgh!  I tried moving the forkStatics call from the rhss of cgTopRhs
 323 -- to enclose the listFCs in cgTopBinding, but that tickled the
 324 -- statics "error" call in initC.  I DON'T UNDERSTAND WHY!
 325
 326 cgTopRhs :: Id -> StgRhs -> FCode (Id, CgIdInfo)
 327         -- The Id is passed along for setting up a binding...
 328         -- It's already been externalised if necessary
 329
 330 cgTopRhs bndr (StgRhsCon cc con args)
 331   = forkStatics (cgTopRhsCon bndr con args)
 332
 333 cgTopRhs bndr (StgRhsClosure cc bi fvs upd_flag srt args body)
 334   = ASSERT(null fvs)    -- There should be no free variables
 335     setSRTLabel (mkSRTLabel (idName bndr)) $
 336     forkStatics (cgTopRhsClosure bndr cc bi srt upd_flag args body)
 337 \end{code}
 338
 339
 340 %************************************************************************
 341 %*                                                                      *
 342 \subsection{Stuff to support splitting}
 343 %*                                                                      *
 344 %************************************************************************
 345
 346 If we're splitting the object, we need to externalise all the top-level names
 347 (and then make sure we only use the externalised one in any C label we use
 348 which refers to this name).
 349
 350 \begin{code}
 351 maybeExternaliseId :: DynFlags -> Id -> FCode Id
 352 maybeExternaliseId dflags id
 353   | dopt Opt_SplitObjs dflags,  -- Externalise the name for -split-objs
 354     isInternalName name = do { mod <- moduleName
 355                              ; returnFC (setIdName id (externalise mod)) }
 356   | otherwise           = returnFC id
 357   where
 358     externalise mod = mkExternalName uniq mod new_occ Nothing loc
 359     name    = idName id
 360     uniq    = nameUnique name
 361     new_occ = mkLocalOcc uniq (nameOccName name)
 362     loc     = nameSrcLoc name
 363         -- We want to conjure up a name that can't clash with any
 364         -- existing name.  So we generate
 365         --      Mod_$L243foo
 366         -- where 243 is the unique.
 367 \end{code}