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