ghc/compiler/main/HscMain.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[GHC_Main]{Main driver for Glasgow Haskell compiler}
   5
   6 \begin{code}
   7 module HscMain ( hscMain ) where
   8
   9 #include "HsVersions.h"
  10
  11 import IO               ( hPutStr, stderr )
  12 import HsSyn
  13
  14 import RdrHsSyn         ( RdrNameHsModule )
  15 import FastString       ( unpackFS )
  16 import StringBuffer     ( hGetStringBuffer )
  17 import Parser           ( parse )
  18 import Lex              ( PState(..), ParseResult(..) )
  19 import SrcLoc           ( mkSrcLoc )
  20
  21 import Rename           ( renameModule )
  22
  23 import MkIface          ( writeIface )
  24 import TcModule         ( TcResults(..), typecheckModule )
  25 import Desugar          ( deSugar )
  26 import SimplCore        ( core2core )
  27 import OccurAnal        ( occurAnalyseBinds )
  28 import CoreUtils        ( coreBindsSize )
  29 import CoreTidy         ( tidyCorePgm )
  30 import CoreToStg        ( topCoreBindsToStg )
  31 import StgSyn           ( collectFinalStgBinders )
  32 import SimplStg         ( stg2stg )
  33 import CodeGen          ( codeGen )
  34 import CodeOutput       ( codeOutput )
  35
  36 import Module           ( ModuleName, moduleNameUserString )
  37 import CmdLineOpts
  38 import ErrUtils         ( ghcExit, doIfSet, dumpIfSet )
  39 import UniqSupply       ( mkSplitUniqSupply )
  40
  41 import Outputable
  42 import Char             ( isSpace )
  43 #if REPORT_TO_MOTHERLODE && __GLASGOW_HASKELL__ >= 303
  44 import SocketPrim
  45 import BSD
  46 import IOExts           ( unsafePerformIO )
  47 import NativeInfo       ( os, arch )
  48 #endif
  49 import StgInterp        ( runStgI )
  50 \end{code}
  51
  52 \begin{code}
  53 hscMain
  54   :: DynFlags
  55   -> ModSummary       -- summary, including source filename
  56   -> Maybe ModIFace   -- old interface, if available
  57   -> String           -- file in which to put the output (.s or .c)
  58   -> HomeSymbolTable            -- for home module ModDetails
  59   -> PersistentCompilerState    -- IN: persistent compiler state
  60   -> IO CompResult    -- NB. without the Linkable filled in; the
  61                       -- driver sorts that out.
  62
  63 hscMain flags core_cmds stg_cmds summary maybe_old_iface
  64         output_filename mod_details pcs =
  65
  66         --------------------------  Reader  ----------------
  67     show_pass "Parser"  >>
  68     _scc_     "Parser"
  69
  70     buf <- hGetStringBuffer True{-expand tabs-} src_filename
  71
  72     let glaexts | opt_GlasgowExts = 1#
  73                 | otherwise       = 0#
  74
  75     case parse buf PState{ bol = 0#, atbol = 1#,
  76                            context = [], glasgow_exts = glaexts,
  77                            loc = mkSrcLoc src_filename 1 } of {
  78
  79         PFailed err -> return (CompErrs pcs err);
  80
  81         POk _ rdr_module@(HsModule mod_name _ _ _ _ _ _) ->
  82
  83     dumpIfSet (dopt_D_dump_parsed flags) "Parser" (ppr rdr_module) >>
  84
  85     dumpIfSet (dopt_D_source_stats flags) "Source Statistics"
  86         (ppSourceStats False rdr_module)                >>
  87
  88     -- UniqueSupplies for later use (these are the only lower case uniques)
  89     mkSplitUniqSupply 'r'       >>= \ rn_uniqs  -> -- renamer
  90     mkSplitUniqSupply 'a'       >>= \ tc_uniqs  -> -- typechecker
  91     mkSplitUniqSupply 'd'       >>= \ ds_uniqs  -> -- desugarer
  92     mkSplitUniqSupply 'r'       >>= \ ru_uniqs  -> -- rules
  93     mkSplitUniqSupply 'c'       >>= \ c2s_uniqs -> -- core-to-stg
  94     mkSplitUniqSupply 'u'       >>= \ tidy_uniqs -> -- tidy up
  95     mkSplitUniqSupply 'g'       >>= \ st_uniqs  -> -- stg-to-stg passes
  96     mkSplitUniqSupply 'n'       >>= \ ncg_uniqs -> -- native-code generator
  97
  98         --------------------------  Rename  ----------------
  99     show_pass "Renamer"                         >>
 100     _scc_     "Renamer"
 101
 102     renameModule rn_uniqs rdr_module            >>= \ maybe_rn_stuff ->
 103     case maybe_rn_stuff of {
 104         Nothing ->      -- Hurrah!  Renamer reckons that there's no need to
 105                         -- go any further
 106                         reportCompile mod_name "Compilation NOT required!" >>
 107                         return ();
 108
 109         Just (this_mod, rn_mod,
 110               old_iface, new_iface,
 111               rn_name_supply, fixity_env,
 112               imported_modules) ->
 113                         -- Oh well, we've got to recompile for real
 114
 115
 116         --------------------------  Typechecking ----------------
 117     show_pass "TypeCheck"                               >>
 118     _scc_     "TypeCheck"
 119     typecheckModule tc_uniqs rn_name_supply
 120                     fixity_env rn_mod           >>= \ maybe_tc_stuff ->
 121     case maybe_tc_stuff of {
 122         Nothing -> ghcExit 1;   -- Type checker failed
 123
 124         Just (tc_results@(TcResults {tc_tycons  = local_tycons,
 125                                      tc_classes = local_classes,
 126                                      tc_insts   = inst_info })) ->
 127
 128
 129         --------------------------  Desugaring ----------------
 130     _scc_     "DeSugar"
 131     deSugar this_mod ds_uniqs tc_results        >>= \ (desugared, rules, h_code, c_code, fe_binders) ->
 132
 133
 134         --------------------------  Main Core-language transformations ----------------
 135     _scc_     "Core2Core"
 136     core2core core_cmds desugared rules                 >>= \ (simplified, orphan_rules) ->
 137
 138         -- Do the final tidy-up
 139     tidyCorePgm tidy_uniqs this_mod
 140                 simplified orphan_rules                 >>= \ (tidy_binds, tidy_orphan_rules) ->
 141
 142         -- Run the occurrence analyser one last time, so that
 143         -- dead binders get dead-binder info.  This is exploited by
 144         -- code generators to avoid spitting out redundant bindings.
 145         -- The occurrence-zapping in Simplify.simplCaseBinder means
 146         -- that the Simplifier nukes useful dead-var stuff especially
 147         -- in case patterns.
 148     let occ_anal_tidy_binds = occurAnalyseBinds tidy_binds in
 149
 150     coreBindsSize occ_anal_tidy_binds `seq`
 151 --      TEMP: the above call zaps some space usage allocated by the
 152 --      simplifier, which for reasons I don't understand, persists
 153 --      thoroughout code generation
 154
 155
 156
 157         --------------------------  Convert to STG code -------------------------------
 158     show_pass "Core2Stg"                        >>
 159     _scc_     "Core2Stg"
 160     let
 161         stg_binds   = topCoreBindsToStg c2s_uniqs occ_anal_tidy_binds
 162     in
 163
 164         --------------------------  Simplify STG code -------------------------------
 165     show_pass "Stg2Stg"                          >>
 166     _scc_     "Stg2Stg"
 167     stg2stg stg_cmds this_mod st_uniqs stg_binds >>= \ (stg_binds2, cost_centre_info) ->
 168
 169 #ifdef GHCI
 170     runStgI local_tycons local_classes
 171                          (map fst stg_binds2)    >>= \ i_result ->
 172     putStr ("\nANSWER = " ++ show i_result ++ "\n\n")
 173     >>
 174
 175 #else
 176         --------------------------  Interface file -------------------------------
 177         -- Dump instance decls and type signatures into the interface file
 178     _scc_     "Interface"
 179     let
 180         final_ids = collectFinalStgBinders (map fst stg_binds2)
 181     in
 182     writeIface this_mod old_iface new_iface
 183                local_tycons local_classes inst_info
 184                final_ids occ_anal_tidy_binds tidy_orphan_rules          >>
 185
 186
 187         --------------------------  Code generation -------------------------------
 188     show_pass "CodeGen"                         >>
 189     _scc_     "CodeGen"
 190     codeGen this_mod imported_modules
 191             cost_centre_info
 192             fe_binders
 193             local_tycons local_classes
 194             stg_binds2                          >>= \ abstractC ->
 195
 196
 197         --------------------------  Code output -------------------------------
 198     show_pass "CodeOutput"                              >>
 199     _scc_     "CodeOutput"
 200     codeOutput this_mod local_tycons local_classes
 201                occ_anal_tidy_binds stg_binds2
 202                c_code h_code abstractC
 203                ncg_uniqs                                >>
 204
 205
 206         --------------------------  Final report -------------------------------
 207     reportCompile mod_name (showSDoc (ppSourceStats True rdr_module)) >>
 208
 209 #endif
 210
 211
 212     ghcExit 0
 213     } }
 214   where
 215     -------------------------------------------------------------
 216     -- ****** help functions:
 217
 218     show_pass
 219       = if opt_D_show_passes
 220         then \ what -> hPutStr stderr ("*** "++what++":\n")
 221         else \ what -> return ()
 222
 223 ppSourceStats short (HsModule name version exports imports decls _ src_loc)
 224  = (if short then hcat else vcat)
 225         (map pp_val
 226                [("ExportAll        ", export_all), -- 1 if no export list
 227                 ("ExportDecls      ", export_ds),
 228                 ("ExportModules    ", export_ms),
 229                 ("Imports          ", import_no),
 230                 ("  ImpQual        ", import_qual),
 231                 ("  ImpAs          ", import_as),
 232                 ("  ImpAll         ", import_all),
 233                 ("  ImpPartial     ", import_partial),
 234                 ("  ImpHiding      ", import_hiding),
 235                 ("FixityDecls      ", fixity_ds),
 236                 ("DefaultDecls     ", default_ds),
 237                 ("TypeDecls        ", type_ds),
 238                 ("DataDecls        ", data_ds),
 239                 ("NewTypeDecls     ", newt_ds),
 240                 ("DataConstrs      ", data_constrs),
 241                 ("DataDerivings    ", data_derivs),
 242                 ("ClassDecls       ", class_ds),
 243                 ("ClassMethods     ", class_method_ds),
 244                 ("DefaultMethods   ", default_method_ds),
 245                 ("InstDecls        ", inst_ds),
 246                 ("InstMethods      ", inst_method_ds),
 247                 ("TypeSigs         ", bind_tys),
 248                 ("ValBinds         ", val_bind_ds),
 249                 ("FunBinds         ", fn_bind_ds),
 250                 ("InlineMeths      ", method_inlines),
 251                 ("InlineBinds      ", bind_inlines),
 252 --              ("SpecialisedData  ", data_specs),
 253 --              ("SpecialisedInsts ", inst_specs),
 254                 ("SpecialisedMeths ", method_specs),
 255                 ("SpecialisedBinds ", bind_specs)
 256                ])
 257   where
 258     pp_val (str, 0) = empty
 259     pp_val (str, n)
 260       | not short   = hcat [text str, int n]
 261       | otherwise   = hcat [text (trim str), equals, int n, semi]
 262
 263     trim ls     = takeWhile (not.isSpace) (dropWhile isSpace ls)
 264
 265     fixity_ds   = length [() | FixD d <- decls]
 266                 -- NB: this omits fixity decls on local bindings and
 267                 -- in class decls.  ToDo
 268
 269     tycl_decls  = [d | TyClD d <- decls]
 270     (class_ds, data_ds, newt_ds, type_ds) = countTyClDecls tycl_decls
 271
 272     inst_decls  = [d | InstD d <- decls]
 273     inst_ds     = length inst_decls
 274     default_ds  = length [() | DefD _ <- decls]
 275     val_decls   = [d | ValD d <- decls]
 276
 277     real_exports = case exports of { Nothing -> []; Just es -> es }
 278     n_exports    = length real_exports
 279     export_ms    = length [() | IEModuleContents _ <- real_exports]
 280     export_ds    = n_exports - export_ms
 281     export_all   = case exports of { Nothing -> 1; other -> 0 }
 282
 283     (val_bind_ds, fn_bind_ds, bind_tys, bind_specs, bind_inlines)
 284         = count_binds (foldr ThenBinds EmptyBinds val_decls)
 285
 286     (import_no, import_qual, import_as, import_all, import_partial, import_hiding)
 287         = foldr add6 (0,0,0,0,0,0) (map import_info imports)
 288     (data_constrs, data_derivs)
 289         = foldr add2 (0,0) (map data_info tycl_decls)
 290     (class_method_ds, default_method_ds)
 291         = foldr add2 (0,0) (map class_info tycl_decls)
 292     (inst_method_ds, method_specs, method_inlines)
 293         = foldr add3 (0,0,0) (map inst_info inst_decls)
 294
 295
 296     count_binds EmptyBinds        = (0,0,0,0,0)
 297     count_binds (ThenBinds b1 b2) = count_binds b1 `add5` count_binds b2
 298     count_binds (MonoBind b sigs _) = case (count_monobinds b, count_sigs sigs) of
 299                                         ((vs,fs),(ts,_,ss,is)) -> (vs,fs,ts,ss,is)
 300
 301     count_monobinds EmptyMonoBinds                 = (0,0)
 302     count_monobinds (AndMonoBinds b1 b2)           = count_monobinds b1 `add2` count_monobinds b2
 303     count_monobinds (PatMonoBind (VarPatIn n) r _) = (1,0)
 304     count_monobinds (PatMonoBind p r _)            = (0,1)
 305     count_monobinds (FunMonoBind f _ m _)          = (0,1)
 306
 307     count_sigs sigs = foldr add4 (0,0,0,0) (map sig_info sigs)
 308
 309     sig_info (Sig _ _ _)            = (1,0,0,0)
 310     sig_info (ClassOpSig _ _ _ _)   = (0,1,0,0)
 311     sig_info (SpecSig _ _ _)        = (0,0,1,0)
 312     sig_info (InlineSig _ _ _)      = (0,0,0,1)
 313     sig_info (NoInlineSig _ _ _)    = (0,0,0,1)
 314     sig_info _                      = (0,0,0,0)
 315
 316     import_info (ImportDecl _ _ qual as spec _)
 317         = add6 (1, qual_info qual, as_info as, 0,0,0) (spec_info spec)
 318     qual_info False  = 0
 319     qual_info True   = 1
 320     as_info Nothing  = 0
 321     as_info (Just _) = 1
 322     spec_info Nothing           = (0,0,0,1,0,0)
 323     spec_info (Just (False, _)) = (0,0,0,0,1,0)
 324     spec_info (Just (True, _))  = (0,0,0,0,0,1)
 325
 326     data_info (TyData _ _ _ _ _ nconstrs derivs _ _ _ _)
 327         = (nconstrs, case derivs of {Nothing -> 0; Just ds -> length ds})
 328     data_info other = (0,0)
 329
 330     class_info (ClassDecl _ _ _ _ meth_sigs def_meths _ _ _ )
 331         = case count_sigs meth_sigs of
 332             (_,classops,_,_) ->
 333                (classops, addpr (count_monobinds def_meths))
 334     class_info other = (0,0)
 335
 336     inst_info (InstDecl _ inst_meths inst_sigs _ _)
 337         = case count_sigs inst_sigs of
 338             (_,_,ss,is) ->
 339                (addpr (count_monobinds inst_meths), ss, is)
 340
 341     addpr :: (Int,Int) -> Int
 342     add1  :: Int -> Int -> Int
 343     add2  :: (Int,Int) -> (Int,Int) -> (Int, Int)
 344     add3  :: (Int,Int,Int) -> (Int,Int,Int) -> (Int, Int, Int)
 345     add4  :: (Int,Int,Int,Int) -> (Int,Int,Int,Int) -> (Int, Int, Int, Int)
 346     add5  :: (Int,Int,Int,Int,Int) -> (Int,Int,Int,Int,Int) -> (Int, Int, Int, Int, Int)
 347     add6  :: (Int,Int,Int,Int,Int,Int) -> (Int,Int,Int,Int,Int,Int) -> (Int, Int, Int, Int, Int, Int)
 348
 349     addpr (x,y) = x+y
 350     add1 x1 y1  = x1+y1
 351     add2 (x1,x2) (y1,y2) = (x1+y1,x2+y2)
 352     add3 (x1,x2,x3) (y1,y2,y3) = (x1+y1,x2+y2,x3+y3)
 353     add4 (x1,x2,x3,x4) (y1,y2,y3,y4) = (x1+y1,x2+y2,x3+y3,x4+y4)
 354     add5 (x1,x2,x3,x4,x5) (y1,y2,y3,y4,y5) = (x1+y1,x2+y2,x3+y3,x4+y4,x5+y5)
 355     add6 (x1,x2,x3,x4,x5,x6) (y1,y2,y3,y4,y5,y6) = (x1+y1,x2+y2,x3+y3,x4+y4,x5+y5,x6+y6)
 356 \end{code}
 357
 358 \begin{code}
 359 \end{code}
 360
 361 \begin{code}
 362 reportCompile :: ModuleName -> String -> IO ()
 363 #if REPORT_TO_MOTHERLODE && __GLASGOW_HASKELL__ >= 303
 364 reportCompile mod_name info
 365   | not opt_ReportCompile = return ()
 366   | otherwise = (do
 367       sock <- udpSocket 0
 368       addr <- motherShip
 369       sendTo sock (moduleNameUserString mod_name ++ ';': compiler_version ++
 370                    ';': os ++ ';':arch ++ '\n':' ':info ++ "\n") addr
 371       return ()) `catch` (\ _ -> return ())
 372
 373 motherShip :: IO SockAddr
 374 motherShip = do
 375   he <- getHostByName "laysan.dcs.gla.ac.uk"
 376   case (hostAddresses he) of
 377     []    -> IOERROR (userError "No address!")
 378     (x:_) -> return (SockAddrInet motherShipPort x)
 379
 380 --magick
 381 motherShipPort :: PortNumber
 382 motherShipPort = mkPortNumber 12345
 383
 384 -- creates a socket capable of sending datagrams,
 385 -- binding it to a port
 386 --  ( 0 => have the system pick next available port no.)
 387 udpSocket :: Int -> IO Socket
 388 udpSocket p = do
 389   pr <- getProtocolNumber "udp"
 390   s  <- socket AF_INET Datagram pr
 391   bindSocket s (SockAddrInet (mkPortNumber p) iNADDR_ANY)
 392   return s
 393 #else
 394 reportCompile _ _ = return ()
 395 #endif
 396
 397 \end{code}