LlvmCodeGen.hs 7.78 KB
Newer Older
Gabor Greif's avatar
Gabor Greif committed
1
{-# LANGUAGE CPP, TypeFamilies, ViewPatterns #-}
2

3 4 5
-- -----------------------------------------------------------------------------
-- | This is the top-level module in the LLVM code generator.
--
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
6
module LlvmCodeGen ( LlvmVersion (..), llvmCodeGen, llvmFixupAsm ) where
7 8 9

#include "HsVersions.h"

10 11
import GhcPrelude

dterei's avatar
dterei committed
12
import Llvm
13 14 15 16
import LlvmCodeGen.Base
import LlvmCodeGen.CodeGen
import LlvmCodeGen.Data
import LlvmCodeGen.Ppr
Peter Wortmann's avatar
Peter Wortmann committed
17
import LlvmCodeGen.Regs
18 19
import LlvmMangler

20
import BlockId
21
import CgUtils ( fixStgRegisters )
22
import Cmm
23
import CmmUtils
24 25
import Hoopl.Block
import Hoopl.Collections
26
import PprCmm
27 28 29 30

import BufWrite
import DynFlags
import ErrUtils
dterei's avatar
dterei committed
31
import FastString
32 33
import Outputable
import UniqSupply
34
import SysTools ( figureLlvmVersion )
Peter Wortmann's avatar
Peter Wortmann committed
35
import qualified Stream
36

37
import Control.Monad ( when )
Peter Wortmann's avatar
Peter Wortmann committed
38
import Data.Maybe ( fromMaybe, catMaybes )
39 40 41
import System.IO

-- -----------------------------------------------------------------------------
dterei's avatar
dterei committed
42
-- | Top-level of the LLVM Code generator
43
--
Peter Wortmann's avatar
Peter Wortmann committed
44 45 46 47
llvmCodeGen :: DynFlags -> Handle -> UniqSupply
               -> Stream.Stream IO RawCmmGroup ()
               -> IO ()
llvmCodeGen dflags h us cmm_stream
48 49
  = withTiming (pure dflags) (text "LLVM CodeGen") (const ()) $ do
       bufh <- newBufHandle h
Peter Wortmann's avatar
Peter Wortmann committed
50 51 52

       -- Pass header
       showPass dflags "LLVM CodeGen"
53

Peter Wortmann's avatar
Peter Wortmann committed
54
       -- get llvm version, cache for later use
55
       ver <- (fromMaybe supportedLlvmVersion) `fmap` figureLlvmVersion dflags
Peter Wortmann's avatar
Peter Wortmann committed
56 57 58 59 60

       -- warn if unsupported
       debugTraceMsg dflags 2
            (text "Using LLVM version:" <+> text (show ver))
       let doWarn = wopt Opt_WarnUnsupportedLlvmVersion dflags
61 62
       when (ver /= supportedLlvmVersion && doWarn) $
           putMsg dflags (text "You are using an unsupported version of LLVM!"
63 64 65
                            $+$ text ("Currently only " ++
                                      llvmVersionStr supportedLlvmVersion ++
                                      " is supported.")
Peter Wortmann's avatar
Peter Wortmann committed
66 67 68 69 70 71 72 73 74 75 76
                            $+$ text "We will try though...")

       -- run code generation
       runLlvm dflags ver bufh us $
         llvmCodeGen' (liftStream cmm_stream)

       bFlush bufh

llvmCodeGen' :: Stream.Stream LlvmM RawCmmGroup () -> LlvmM ()
llvmCodeGen' cmm_stream
  = do  -- Preamble
Moritz Angermann's avatar
Moritz Angermann committed
77
        renderLlvm header
Peter Wortmann's avatar
Peter Wortmann committed
78 79 80 81 82 83 84 85
        ghcInternalFunctions
        cmmMetaLlvmPrelude

        -- Procedures
        let llvmStream = Stream.mapM llvmGroupLlvmGens cmm_stream
        _ <- Stream.collect llvmStream

        -- Declare aliases for forward references
86
        renderLlvm . pprLlvmData =<< generateExternDecls
Peter Wortmann's avatar
Peter Wortmann committed
87 88 89

        -- Postamble
        cmmUsedLlvmGens
Moritz Angermann's avatar
Moritz Angermann committed
90 91 92 93 94 95 96 97 98
  where
    header :: SDoc
    header = sdocWithDynFlags $ \dflags ->
      let target = LLVM_TARGET
          layout = case lookup target (llvmTargets dflags) of
            Just (LlvmTarget dl _ _) -> dl
            Nothing -> error $ "Failed to lookup the datalayout for " ++ target ++ "; available targets: " ++ show (map fst $ llvmTargets dflags)
      in     text ("target datalayout = \"" ++ layout ++ "\"")
         $+$ text ("target triple = \"" ++ target ++ "\"")
Peter Wortmann's avatar
Peter Wortmann committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

llvmGroupLlvmGens :: RawCmmGroup -> LlvmM ()
llvmGroupLlvmGens cmm = do

        -- Insert functions into map, collect data
        let split (CmmData s d' )     = return $ Just (s, d')
            split (CmmProc h l live g) = do
              -- Set function type
              let l' = case mapLookup (g_entry g) h of
                         Nothing                   -> l
                         Just (Statics info_lbl _) -> info_lbl
              lml <- strCLabel_llvm l'
              funInsert lml =<< llvmFunTy live
              return Nothing
        cdata <- fmap catMaybes $ mapM split cmm

        {-# SCC "llvm_datas_gen" #-}
          cmmDataLlvmGens cdata
        {-# SCC "llvm_procs_gen" #-}
          mapM_ cmmLlvmGen cmm
119 120

-- -----------------------------------------------------------------------------
dterei's avatar
dterei committed
121
-- | Do LLVM code generation on all these Cmms data sections.
122
--
Peter Wortmann's avatar
Peter Wortmann committed
123
cmmDataLlvmGens :: [(Section,CmmStatics)] -> LlvmM ()
124

Peter Wortmann's avatar
Peter Wortmann committed
125 126
cmmDataLlvmGens statics
  = do lmdatas <- mapM genLlvmData statics
127

Gabor Greif's avatar
Gabor Greif committed
128
       let (concat -> gs, tss) = unzip lmdatas
129

Peter Wortmann's avatar
Peter Wortmann committed
130 131
       let regGlobal (LMGlobal (LMGlobalVar l ty _ _ _ _) _)
                        = funInsert l ty
Gabor Greif's avatar
Gabor Greif committed
132 133 134
           regGlobal _  = pure ()
       mapM_ regGlobal gs
       gss' <- mapM aliasify $ gs
Peter Wortmann's avatar
Peter Wortmann committed
135

136
       renderLlvm $ pprLlvmData (concat gss', concat tss)
137

138 139 140
-- | LLVM can't handle entry blocks which loop back to themselves (could be
-- seen as an LLVM bug) so we rearrange the code to keep the original entry
-- label which branches to a newly generated second label that branches back
141
-- to itself. See: #11649
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
fixBottom :: RawCmmDecl -> LlvmM RawCmmDecl
fixBottom cp@(CmmProc hdr entry_lbl live g) =
    maybe (pure cp) fix_block $ mapLookup (g_entry g) blk_map
  where
    blk_map = toBlockMap g

    fix_block :: CmmBlock -> LlvmM RawCmmDecl
    fix_block blk
        | (CmmEntry e_lbl tickscp, middle, CmmBranch b_lbl) <- blockSplit blk
        , isEmptyBlock middle
        , e_lbl == b_lbl = do
            new_lbl <- mkBlockId <$> getUniqueM

            let fst_blk =
                    BlockCC (CmmEntry e_lbl tickscp) BNil (CmmBranch new_lbl)
                snd_blk =
                    BlockCC (CmmEntry new_lbl tickscp) BNil (CmmBranch new_lbl)

            pure . CmmProc hdr entry_lbl live . ofBlockMap (g_entry g)
                $ mapFromList [(e_lbl, fst_blk), (new_lbl, snd_blk)]

    fix_block _ = pure cp

fixBottom rcd = pure rcd

dterei's avatar
dterei committed
167
-- | Complete LLVM code generation phase for a single top-level chunk of Cmm.
Peter Wortmann's avatar
Peter Wortmann committed
168 169 170
cmmLlvmGen ::RawCmmDecl -> LlvmM ()
cmmLlvmGen cmm@CmmProc{} = do

171
    -- rewrite assignments to global regs
Peter Wortmann's avatar
Peter Wortmann committed
172
    dflags <- getDynFlag id
173 174
    fixed_cmm <- fixBottom $
                    {-# SCC "llvm_fix_regs" #-}
175
                    fixStgRegisters dflags cmm
176

Peter Wortmann's avatar
Peter Wortmann committed
177
    dumpIfSetLlvm Opt_D_dump_opt_cmm "Optimised Cmm" (pprCmmGroup [fixed_cmm])
178 179

    -- generate llvm code from cmm
Peter Wortmann's avatar
Peter Wortmann committed
180
    llvmBC <- withClearVars $ genLlvmProc fixed_cmm
181

Peter Wortmann's avatar
Peter Wortmann committed
182
    -- pretty print
183
    (docs, ivars) <- fmap unzip $ mapM pprLlvmCmmDecl llvmBC
Peter Wortmann's avatar
Peter Wortmann committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

    -- Output, note down used variables
    renderLlvm (vcat docs)
    mapM_ markUsedVar $ concat ivars

cmmLlvmGen _ = return ()

-- -----------------------------------------------------------------------------
-- | Generate meta data nodes
--

cmmMetaLlvmPrelude :: LlvmM ()
cmmMetaLlvmPrelude = do
  metas <- flip mapM stgTBAA $ \(uniq, name, parent) -> do
    -- Generate / lookup meta data IDs
    tbaaId <- getMetaUniqueId
    setUniqMeta uniq tbaaId
    parentId <- maybe (return Nothing) getUniqMeta parent
    -- Build definition
203 204 205 206 207 208 209
    return $ MetaUnnamed tbaaId $ MetaStruct $
          case parentId of
              Just p  -> [ MetaStr name, MetaNode p ]
              -- As of LLVM 4.0, a node without parents should be rendered as
              -- just a name on its own. Previously `null` was accepted as the
              -- name.
              Nothing -> [ MetaStr name ]
Peter Wortmann's avatar
Peter Wortmann committed
210 211 212 213 214
  renderLlvm $ ppLlvmMetas metas

-- -----------------------------------------------------------------------------
-- | Marks variables as used where necessary
--
215

Peter Wortmann's avatar
Peter Wortmann committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
cmmUsedLlvmGens :: LlvmM ()
cmmUsedLlvmGens = do

  -- LLVM would discard variables that are internal and not obviously
  -- used if we didn't provide these hints. This will generate a
  -- definition of the form
  --
  --   @llvm.used = appending global [42 x i8*] [i8* bitcast <var> to i8*, ...]
  --
  -- Which is the LLVM way of protecting them against getting removed.
  ivars <- getUsedVars
  let cast x = LMBitc (LMStaticPointer (pVarLift x)) i8Ptr
      ty     = (LMArray (length ivars) i8Ptr)
      usedArray = LMStaticArray (map cast ivars) ty
      sectName  = Just $ fsLit "llvm.metadata"
      lmUsedVar = LMGlobalVar (fsLit "llvm.used") ty Appending sectName Nothing Constant
      lmUsed    = LMGlobal lmUsedVar (Just usedArray)
  if null ivars
     then return ()
     else renderLlvm $ pprLlvmData ([lmUsed], [])