Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules
[ghc-hetmet.git] / compiler / cmm / CmmParse.y
index 2bb9869..039c616 100644 (file)
@@ -7,6 +7,13 @@
 -----------------------------------------------------------------------------
 
 {
+{-# OPTIONS_GHC -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
+-- for details
+
 module CmmParse ( parseCmmFile ) where
 
 import CgMonad
@@ -103,8 +110,10 @@ import System.Exit
        'if'            { L _ (CmmT_if) }
        'jump'          { L _ (CmmT_jump) }
        'foreign'       { L _ (CmmT_foreign) }
+       'never'         { L _ (CmmT_never) }
        'prim'          { L _ (CmmT_prim) }
        'return'        { L _ (CmmT_return) }
+       'returns'       { L _ (CmmT_returns) }
        'import'        { L _ (CmmT_import) }
        'switch'        { L _ (CmmT_switch) }
        'case'          { L _ (CmmT_case) }
@@ -200,47 +209,64 @@ lits      :: { [ExtFCode CmmExpr] }
 
 cmmproc :: { ExtCode }
 -- TODO: add real SRT/info tables to parsed Cmm
-       : info maybe_formals '{' body '}'
-               { do ((info_lbl, info, live, formals), stmts) <-
+       : info maybe_formals maybe_gc_block maybe_frame '{' body '}'
+               { do ((entry_ret_label, info, live, formals, gc_block, frame), stmts) <-
                       getCgStmtsEC' $ loopDecls $ do {
-                        (info_lbl, info, live) <- $1;
+                        (entry_ret_label, info, live) <- $1;
                         formals <- sequence $2;
-                        $4;
-                        return (info_lbl, info, live, formals) }
+                        gc_block <- $3;
+                        frame <- $4;
+                        $6;
+                        return (entry_ret_label, info, live, formals, gc_block, frame) }
                     blks <- code (cgStmtsToBlocks stmts)
-                    code (emitInfoTableAndCode info_lbl info formals blks) }
+                    code (emitInfoTableAndCode entry_ret_label (CmmInfo gc_block frame info) formals blks) }
 
        | info maybe_formals ';'
-               { do (info_lbl, info, live) <- $1;
+               { do (entry_ret_label, info, live) <- $1;
                     formals <- sequence $2;
-                    code (emitInfoTableAndCode info_lbl info formals []) }
+                    code (emitInfoTableAndCode entry_ret_label (CmmInfo Nothing Nothing info) formals []) }
 
-       | NAME maybe_formals '{' body '}'
-               { do (formals, stmts) <-
+       | NAME maybe_formals maybe_gc_block maybe_frame '{' body '}'
+               { do ((formals, gc_block, frame), stmts) <-
                        getCgStmtsEC' $ loopDecls $ do {
                          formals <- sequence $2;
-                         $4;
-                         return formals }
+                         gc_block <- $3;
+                         frame <- $4;
+                         $6;
+                         return (formals, gc_block, frame) }
                      blks <- code (cgStmtsToBlocks stmts)
-                    code (emitProc (CmmNonInfo Nothing) (mkRtsCodeLabelFS $1) formals blks) }
+                    code (emitProc (CmmInfo gc_block frame CmmNonInfoTable) (mkRtsCodeLabelFS $1) formals blks) }
 
-info   :: { ExtFCode (CLabel, CmmInfo, [Maybe LocalReg]) }
+info   :: { ExtFCode (CLabel, CmmInfoTable, [Maybe LocalReg]) }
        : 'INFO_TABLE' '(' NAME ',' INT ',' INT ',' INT ',' STRING ',' STRING ')'
                -- ptrs, nptrs, closure type, description, type
                { do prof <- profilingInfo $11 $13
-                    return (mkRtsInfoLabelFS $3,
-                       CmmInfo prof Nothing (fromIntegral $9)
-                               (ThunkInfo (fromIntegral $5, fromIntegral $7) NoC_SRT),
+                    return (mkRtsEntryLabelFS $3,
+                       CmmInfoTable prof (fromIntegral $9)
+                                    (ThunkInfo (fromIntegral $5, fromIntegral $7) NoC_SRT),
                        []) }
        
        | 'INFO_TABLE_FUN' '(' NAME ',' INT ',' INT ',' INT ',' STRING ',' STRING ',' INT ')'
                -- ptrs, nptrs, closure type, description, type, fun type
                { do prof <- profilingInfo $11 $13
-                    return (mkRtsInfoLabelFS $3,
-                       CmmInfo prof Nothing (fromIntegral $9)
-                               (FunInfo (fromIntegral $5, fromIntegral $7) NoC_SRT (fromIntegral $15) 0
-                                (ArgSpec 0)
-                                zeroCLit),
+                    return (mkRtsEntryLabelFS $3,
+                       CmmInfoTable prof (fromIntegral $9)
+                                    (FunInfo (fromIntegral $5, fromIntegral $7) NoC_SRT (fromIntegral $15) 0
+                                     (ArgSpec 0)
+                                     zeroCLit),
+                       []) }
+               -- we leave most of the fields zero here.  This is only used
+               -- to generate the BCO info table in the RTS at the moment.
+
+       -- A variant with a non-zero arity (needed to write Main_main in Cmm)
+       | 'INFO_TABLE_FUN' '(' NAME ',' INT ',' INT ',' INT ',' STRING ',' STRING ',' INT ',' INT ')'
+               -- ptrs, nptrs, closure type, description, type, fun type, arity
+               { do prof <- profilingInfo $11 $13
+                    return (mkRtsEntryLabelFS $3,
+                       CmmInfoTable prof (fromIntegral $9)
+                                    (FunInfo (fromIntegral $5, fromIntegral $7) NoC_SRT (fromIntegral $15) (fromIntegral $17)
+                                     (ArgSpec 0)
+                                     zeroCLit),
                        []) }
                -- we leave most of the fields zero here.  This is only used
                -- to generate the BCO info table in the RTS at the moment.
@@ -251,32 +277,33 @@ info      :: { ExtFCode (CLabel, CmmInfo, [Maybe LocalReg]) }
                     -- If profiling is on, this string gets duplicated,
                     -- but that's the way the old code did it we can fix it some other time.
                     desc_lit <- code $ mkStringCLit $13
-                    return (mkRtsInfoLabelFS $3,
-                       CmmInfo prof Nothing (fromIntegral $11)
-                               (ConstrInfo (fromIntegral $5, fromIntegral $7) (fromIntegral $9) desc_lit),
+                    return (mkRtsEntryLabelFS $3,
+                       CmmInfoTable prof (fromIntegral $11)
+                                    (ConstrInfo (fromIntegral $5, fromIntegral $7) (fromIntegral $9) desc_lit),
                        []) }
        
        | 'INFO_TABLE_SELECTOR' '(' NAME ',' INT ',' INT ',' STRING ',' STRING ')'
                -- selector, closure type, description, type
                { do prof <- profilingInfo $9 $11
-                    return (mkRtsInfoLabelFS $3,
-                       CmmInfo prof Nothing (fromIntegral $7)
-                               (ThunkSelectorInfo (fromIntegral $5) NoC_SRT),
+                    return (mkRtsEntryLabelFS $3,
+                       CmmInfoTable prof (fromIntegral $7)
+                                    (ThunkSelectorInfo (fromIntegral $5) NoC_SRT),
                        []) }
 
        | 'INFO_TABLE_RET' '(' NAME ',' INT ')'
                -- closure type (no live regs)
-               { return (mkRtsInfoLabelFS $3,
-                       CmmInfo (ProfilingInfo zeroCLit zeroCLit) Nothing (fromIntegral $5)
-                               (ContInfo [] NoC_SRT),
+               { do let infoLabel = mkRtsInfoLabelFS $3
+                    return (mkRtsRetLabelFS $3,
+                       CmmInfoTable (ProfilingInfo zeroCLit zeroCLit) (fromIntegral $5)
+                                    (ContInfo [] NoC_SRT),
                        []) }
 
        | 'INFO_TABLE_RET' '(' NAME ',' INT ',' formals0 ')'
                -- closure type, live regs
                { do live <- sequence (map (liftM Just) $7)
-                    return (mkRtsInfoLabelFS $3,
-                       CmmInfo (ProfilingInfo zeroCLit zeroCLit) Nothing (fromIntegral $5)
-                       (ContInfo live NoC_SRT),
+                    return (mkRtsRetLabelFS $3,
+                       CmmInfoTable (ProfilingInfo zeroCLit zeroCLit) (fromIntegral $5)
+                                    (ContInfo live NoC_SRT),
                        live) }
 
 body   :: { ExtCode }
@@ -289,7 +316,7 @@ decl        :: { ExtCode }
        | STRING type names ';'         {% do k <- parseKind $1;
                                              return $ mapM_ (newLocal k $2) $3 }
 
-       | 'import' names ';'            { return () }  -- ignore imports
+       | 'import' names ';'            { mapM_ newImport $2 }
        | 'export' names ';'            { return () }  -- ignore exports
 
 names  :: { [FastString] }
@@ -313,10 +340,10 @@ stmt      :: { ExtCode }
        -- we tweak the syntax to avoid the conflict.  The later
        -- option is taken here because the other way would require
        -- multiple levels of expanding and get unwieldy.
-       | maybe_results 'foreign' STRING expr '(' hint_exprs0 ')' vols ';'
-               {% foreignCall $3 $1 $4 $6 $8 NoC_SRT }
-       | maybe_results 'prim' '%' NAME '(' hint_exprs0 ')' vols ';'
-               {% primCall $1 $4 $6 $8 NoC_SRT }
+       | maybe_results 'foreign' STRING expr '(' hint_exprs0 ')' safety vols opt_never_returns ';'
+               {% foreignCall $3 $1 $4 $6 $9 $8 $10 }
+       | maybe_results 'prim' '%' NAME '(' hint_exprs0 ')' safety vols ';'
+               {% primCall $1 $4 $6 $9 $8 }
        -- stmt-level macros, stealing syntax from ordinary C-- function calls.
        -- Perhaps we ought to use the %%-form?
        | NAME '(' exprs0 ')' ';'
@@ -332,6 +359,10 @@ stmt       :: { ExtCode }
        | 'if' bool_expr '{' body '}' else      
                { ifThenElse $2 $4 $6 }
 
+opt_never_returns :: { CmmReturnInfo }
+        :                               { CmmMayReturn }
+        | 'never' 'returns'             { CmmNeverReturns }
+
 bool_expr :: { ExtFCode BoolExpr }
        : bool_op                       { $1 }
        | expr                          { do e <- $1; return (BoolTest e) }
@@ -345,6 +376,11 @@ bool_op :: { ExtFCode BoolExpr }
        | '(' bool_op ')'               { $2 }
 
 -- This is not C-- syntax.  What to do?
+safety  :: { CmmSafety }
+       : {- empty -}                   { CmmUnsafe } -- Default may change soon
+       | STRING                        {% parseSafety $1 }
+
+-- This is not C-- syntax.  What to do?
 vols   :: { Maybe [GlobalReg] }
        : {- empty -}                   { Nothing }
        | '[' ']'                       { Just [] }
@@ -498,6 +534,17 @@ formal :: { ExtFCode LocalReg }
        | STRING type NAME      {% do k <- parseKind $1;
                                     return $ newLocal k $2 $3 }
 
+maybe_frame :: { ExtFCode (Maybe UpdateFrame) }
+       : {- empty -}                   { return Nothing }
+       | 'jump' expr '(' exprs0 ')'    { do { target <- $2;
+                                              args <- sequence $4;
+                                              return $ Just (UpdateFrame target args) } }
+
+maybe_gc_block :: { ExtFCode (Maybe BlockId) }
+       : {- empty -}                   { return Nothing }
+       | 'goto' NAME
+               { do l <- lookupLabel $2; return (Just l) }
+
 type   :: { MachRep }
        : 'bits8'               { I8 }
        | typenot8              { $1 }
@@ -630,6 +677,11 @@ callishMachOps = listToUFM $
         -- ToDo: the rest, maybe
     ]
 
+parseSafety :: String -> P CmmSafety
+parseSafety "safe"   = return (CmmSafe NoC_SRT)
+parseSafety "unsafe" = return CmmUnsafe
+parseSafety str      = fail ("unrecognised safety: " ++ str)
+
 parseHint :: String -> P MachHint
 parseHint "ptr"    = return PtrHint
 parseHint "signed" = return SignedHint
@@ -744,9 +796,12 @@ instance Monad ExtFCode where
 -- an environment, which is looped back into the computation.  In this
 -- way, we can have embedded declarations that scope over the whole
 -- procedure, and imports that scope over the entire module.
+-- Discards the local declaration contained within decl'
 loopDecls :: ExtFCode a -> ExtFCode a
-loopDecls (EC fcode) = 
-   EC $ \e s -> fixC (\ ~(decls,a) -> fcode (addListToUFM e decls) [])
+loopDecls (EC fcode) =
+      EC $ \e globalDecls -> do
+       (decls', a) <- fixC (\ ~(decls,a) -> fcode (addListToUFM e (decls ++ globalDecls)) globalDecls)
+       return (globalDecls, a)
 
 getEnv :: ExtFCode Env
 getEnv = EC $ \e s -> return (s, e)
@@ -764,6 +819,13 @@ newLocal kind ty name = do
    addVarDecl name (CmmReg (CmmLocal reg))
    return reg
 
+-- Creates a foreign label in the import. CLabel's labelDynamic
+-- classifies these labels as dynamic, hence the code generator emits the
+-- PIC code for them.
+newImport :: FastString -> ExtFCode ()
+newImport name =
+       addVarDecl name (CmmLit (CmmLabel (mkForeignLabel name Nothing True)))
+
 newLabel :: FastString -> ExtFCode BlockId
 newLabel name = do
    u <- code newUnique
@@ -830,34 +892,53 @@ foreignCall
        -> ExtFCode CmmExpr
        -> [ExtFCode (CmmExpr,MachHint)]
        -> Maybe [GlobalReg]
-        -> C_SRT
+        -> CmmSafety
+        -> CmmReturnInfo
         -> P ExtCode
-foreignCall conv_string results_code expr_code args_code vols srt
+foreignCall conv_string results_code expr_code args_code vols safety ret
   = do  convention <- case conv_string of
           "C" -> return CCallConv
+          "stdcall" -> return StdCallConv
           "C--" -> return CmmCallConv
           _ -> fail ("unknown calling convention: " ++ conv_string)
        return $ do
          results <- sequence results_code
          expr <- expr_code
          args <- sequence args_code
-          code (emitForeignCall' PlayRisky results 
-                 (CmmForeignCall expr convention) args vols srt) where
+         --code (stmtC (CmmCall (CmmCallee expr convention) results args safety))
+          case convention of
+            -- Temporary hack so at least some functions are CmmSafe
+            CmmCallConv -> code (stmtC (CmmCall (CmmCallee expr convention) results args safety ret))
+            _ -> case safety of
+             CmmUnsafe ->
+                code (emitForeignCall' PlayRisky results 
+                   (CmmCallee expr convention) args vols NoC_SRT ret)
+              CmmSafe srt ->
+                code (emitForeignCall' (PlaySafe unused) results 
+                   (CmmCallee expr convention) args vols NoC_SRT ret) where
+               unused = panic "not used by emitForeignCall'"
 
 primCall
        :: [ExtFCode (CmmFormal,MachHint)]
        -> FastString
        -> [ExtFCode (CmmExpr,MachHint)]
        -> Maybe [GlobalReg]
-        -> C_SRT
+        -> CmmSafety
         -> P ExtCode
-primCall results_code name args_code vols srt
+primCall results_code name args_code vols safety
   = case lookupUFM callishMachOps name of
        Nothing -> fail ("unknown primitive " ++ unpackFS name)
        Just p  -> return $ do
                results <- sequence results_code
                args <- sequence args_code
-               code (emitForeignCall' PlayRisky results (CmmPrim p) args vols srt)
+               case safety of
+                 CmmUnsafe ->
+                   code (emitForeignCall' PlayRisky results
+                     (CmmPrim p) args vols NoC_SRT CmmMayReturn)
+                 CmmSafe srt ->
+                   code (emitForeignCall' (PlaySafe unused) results 
+                     (CmmPrim p) args vols NoC_SRT CmmMayReturn) where
+                   unused = panic "not used by emitForeignCall'"
 
 doStore :: MachRep -> ExtFCode CmmExpr  -> ExtFCode CmmExpr -> ExtCode
 doStore rep addr_code val_code