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