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