1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
--------------------------------------------------------------------------------
-- | Pretty print LLVM IR Code.
--
module Llvm.PpLlvm (
-- * Top level LLVM objects.
ppLlvmModule,
ppLlvmComments,
ppLlvmComment,
ppLlvmConstants,
ppLlvmConstant,
ppLlvmGlobals,
ppLlvmGlobal,
ppLlvmType,
ppLlvmTypes,
ppLlvmFunctionDecls,
ppLlvmFunctionDecl,
ppLlvmFunctions,
ppLlvmFunction,
llvmSDoc
) where
#include "HsVersions.h"
import Llvm.AbsSyn
import Llvm.Types
import Data.List ( intersperse )
import Pretty
import qualified Outputable as Outp
import Unique
--------------------------------------------------------------------------------
-- * Top Level Print functions
--------------------------------------------------------------------------------
-- | Print out a whole LLVM module.
ppLlvmModule :: LlvmModule -> Doc
ppLlvmModule (LlvmModule comments constants globals decls funcs)
= ppLlvmComments comments
$+$ empty
$+$ ppLlvmConstants constants
$+$ ppLlvmGlobals globals
$+$ empty
$+$ ppLlvmFunctionDecls decls
$+$ empty
$+$ ppLlvmFunctions funcs
-- | Print out a multi-line comment, can be inside a function or on its own
ppLlvmComments :: [LMString] -> Doc
ppLlvmComments comments = vcat $ map ppLlvmComment comments
-- | Print out a comment, can be inside a function or on its own
ppLlvmComment :: LMString -> Doc
ppLlvmComment com = semi <+> (ftext com)
-- | Print out a list of global mutable variable definitions
ppLlvmGlobals :: [LMGlobal] -> Doc
ppLlvmGlobals ls = vcat $ map ppLlvmGlobal ls
-- | Print out a global mutable variable definition
ppLlvmGlobal :: LMGlobal -> Doc
ppLlvmGlobal (var@(LMGlobalVar _ _ link), Nothing) =
ppAssignment var $ text (show link) <+> text "global" <+>
(text $ show (pLower $ getVarType var))
ppLlvmGlobal (var@(LMGlobalVar _ _ link), (Just stat)) =
ppAssignment var $ text (show link) <+> text "global" <+> text (show stat)
ppLlvmGlobal oth = error $ "Non Global var ppr as global! " ++ show oth
-- | Print out a list global constant variable
ppLlvmConstants :: [LMConstant] -> Doc
ppLlvmConstants cons = vcat $ map ppLlvmConstant cons
-- | Print out a global constant variable
ppLlvmConstant :: LMConstant -> Doc
ppLlvmConstant (dst@(LMGlobalVar _ _ link), src) =
ppAssignment dst $ text (show link) <+> text "constant" <+> text (show src)
ppLlvmConstant c = error $ "Non global var as constant! " ++ show c
-- | Print out a list of LLVM type aliases.
ppLlvmTypes :: [LlvmType] -> Doc
ppLlvmTypes tys = vcat $ map ppLlvmType tys
-- | Print out an LLVM type alias.
ppLlvmType :: LlvmType -> Doc
ppLlvmType al@(LMAlias _ t)
= (text $ show al) <+> equals <+> (text "type") <+> (text $ show t)
ppLlvmType (LMFunction t)
= ppLlvmFunctionDecl t
ppLlvmType _ = empty
-- | Print out a list of function definitions.
ppLlvmFunctions :: LlvmFunctions -> Doc
ppLlvmFunctions funcs = vcat $ map ppLlvmFunction funcs
-- | Print out a function definition.
ppLlvmFunction :: LlvmFunction -> Doc
ppLlvmFunction (LlvmFunction dec attrs body) =
let attrDoc = ppSpaceJoin attrs
in (text "define") <+> (ppLlvmFuncDecSig dec)
<+> attrDoc
$+$ lbrace
$+$ ppLlvmBlocks body
$+$ rbrace
-- | Print out a list of function declaration.
ppLlvmFunctionDecls :: LlvmFunctionDecls -> Doc
ppLlvmFunctionDecls decs = vcat $ map ppLlvmFunctionDecl decs
-- | Print out a function declaration.
-- Declarations define the function type but don't define the actual body of
-- the function.
ppLlvmFunctionDecl :: LlvmFunctionDecl -> Doc
ppLlvmFunctionDecl dec = (text "declare") <+> ppLlvmFuncDecSig dec
-- | Print out a functions type signature.
-- This differs from [ppLlvmFunctionDecl] in that it is used for both function
-- declarations and defined functions to print out the type.
ppLlvmFuncDecSig :: LlvmFunctionDecl -> Doc
ppLlvmFuncDecSig (LlvmFunctionDecl name link cc retTy argTy params)
= let linkTxt = show link
linkDoc | linkTxt == "" = empty
| otherwise = (text linkTxt) <> space
ppParams = either ppCommaJoin ppCommaJoin params <>
(case argTy of
VarArgs -> (text ", ...")
FixedArgs -> empty)
in linkDoc <> (text $ show cc) <+> (text $ show retTy)
<+> atsym <> (ftext name) <> lparen <+> ppParams <+> rparen
-- | Print out a list of LLVM blocks.
ppLlvmBlocks :: LlvmBlocks -> Doc
ppLlvmBlocks blocks = vcat $ map ppLlvmBlock blocks
-- | Print out an LLVM block.
-- It must be part of a function definition.
ppLlvmBlock :: LlvmBlock -> Doc
ppLlvmBlock (LlvmBlock blockId stmts)
= ppLlvmStatement (MkLabel blockId)
$+$ nest 4 (vcat $ map ppLlvmStatement stmts)
-- | Print out an LLVM statement.
ppLlvmStatement :: LlvmStatement -> Doc
ppLlvmStatement stmt
= case stmt of
Assignment dst expr -> ppAssignment dst (ppLlvmExpression expr)
Branch target -> ppBranch target
BranchIf cond ifT ifF -> ppBranchIf cond ifT ifF
Comment comments -> ppLlvmComments comments
MkLabel label -> (llvmSDoc $ pprUnique label) <> colon
Store value ptr -> ppStore value ptr
Switch scrut def tgs -> ppSwitch scrut def tgs
Return result -> ppReturn result
Expr expr -> ppLlvmExpression expr
Unreachable -> text "unreachable"
-- | Print out an LLVM expression.
ppLlvmExpression :: LlvmExpression -> Doc
ppLlvmExpression expr
= case expr of
Alloca tp amount -> ppAlloca tp amount
LlvmOp op left right -> ppMachOp op left right
Call tp fp args attrs -> ppCall tp fp args attrs
Cast op from to -> ppCast op from to
Compare op left right -> ppCmpOp op left right
GetElemPtr ptr indexes -> ppGetElementPtr ptr indexes
Load ptr -> ppLoad ptr
Malloc tp amount -> ppMalloc tp amount
Phi tp precessors -> ppPhi tp precessors
--------------------------------------------------------------------------------
-- * Individual print functions
--------------------------------------------------------------------------------
-- | Should always be a function pointer. So a global var of function type
-- (since globals are always pointers) or a local var of pointer function type.
ppCall :: LlvmCallType -> LlvmVar -> [LlvmVar] -> [LlvmFuncAttr] -> Doc
ppCall ct fptr vals attrs = case fptr of
--
-- if local var function pointer, unwrap
LMLocalVar _ (LMPointer (LMFunction d)) -> ppCall' d
-- should be function type otherwise
LMGlobalVar _ (LMFunction d) _ -> ppCall' d
-- not pointer or function, so error
_other -> error $ "ppCall called with non LMFunction type!\nMust be "
++ " called with either global var of function type or "
++ "local var of pointer function type."
where
ppCall' (LlvmFunctionDecl _ _ cc ret argTy params) =
let tc = if ct == TailCall then text "tail " else empty
ppValues = ppCommaJoin vals
ppArgTy = either ppCommaJoin (\x -> ppCommaJoin $ map getVarType x) params <>
(case argTy of
VarArgs -> (text ", ...")
FixedArgs -> empty)
fnty = space <> lparen <> ppArgTy <> rparen <> (text "*")
attrDoc = ppSpaceJoin attrs
in tc <> (text "call") <+> (text $ show cc) <+> (text $ show ret)
<> fnty <+> (text $ getName fptr) <> lparen <+> ppValues
<+> rparen <+> attrDoc
ppMachOp :: LlvmMachOp -> LlvmVar -> LlvmVar -> Doc
ppMachOp op left right =
(text $ show op) <+> (text $ show (getVarType left)) <+> (text $ getName left)
<> comma <+> (text $ getName right)
ppCmpOp :: LlvmCmpOp -> LlvmVar -> LlvmVar -> Doc
ppCmpOp op left right =
let cmpOp
| isInt (getVarType left) && isInt (getVarType right) = text "icmp"
| isFloat (getVarType left) && isFloat (getVarType right) = text "fcmp"
| otherwise = error ("can't compare different types, left = "
++ (show $ getVarType left) ++ ", right = "
++ (show $ getVarType right))
in cmpOp <+> (text $ show op) <+> (text $ show (getVarType left))
<+> (text $ getName left) <> comma <+> (text $ getName right)
ppAssignment :: LlvmVar -> Doc -> Doc
ppAssignment var expr = (text $ getName var) <+> equals <+> expr
ppLoad :: LlvmVar -> Doc
ppLoad var = (text "load") <+> (text $ show var)
ppStore :: LlvmVar -> LlvmVar -> Doc
ppStore val dst =
(text "store") <+> (text $ show val) <> comma <+> (text $ show dst)
ppCast :: LlvmCastOp -> LlvmVar -> LlvmType -> Doc
ppCast op from to =
let castOp = text $ show op
in castOp <+> (text $ show from) <+> (text "to") <+> (text $ show to)
ppMalloc :: LlvmType -> Int -> Doc
ppMalloc tp amount =
let amount' = LMLitVar $ LMIntLit (toInteger amount) i32
in (text "malloc") <+> (text $ show tp) <> comma <+> (text $ show amount')
ppAlloca :: LlvmType -> Int -> Doc
ppAlloca tp amount =
let amount' = LMLitVar $ LMIntLit (toInteger amount) i32
in (text "alloca") <+> (text $ show tp) <> comma <+> (text $ show amount')
ppGetElementPtr :: LlvmVar -> [Int] -> Doc
ppGetElementPtr ptr idx =
let indexes = hcat $ map ((comma <+> (text $ show i32) <+>) . text . show) idx
in (text "getelementptr") <+> (text $ show ptr) <> indexes
ppReturn :: Maybe LlvmVar -> Doc
ppReturn (Just var) = (text "ret") <+> (text $ show var)
ppReturn Nothing = (text "ret") <+> (text $ show LMVoid)
ppBranch :: LlvmVar -> Doc
ppBranch var = (text "br") <+> (text $ show var)
ppBranchIf :: LlvmVar -> LlvmVar -> LlvmVar -> Doc
ppBranchIf cond trueT falseT
= (text "br") <+> (text $ show cond) <> comma <+> (text $ show trueT) <> comma
<+> (text $ show falseT)
ppPhi :: LlvmType -> [(LlvmVar,LlvmVar)] -> Doc
ppPhi tp preds =
let ppPreds (val, label) = brackets $ (text $ getName val) <> comma
<+> (text $ getName label)
in (text "phi") <+> (text $ show tp)
<+> (hcat $ intersperse comma (map ppPreds preds))
ppSwitch :: LlvmVar -> LlvmVar -> [(LlvmVar,LlvmVar)] -> Doc
ppSwitch scrut dflt targets =
let ppTarget (val, lab) = (text $ show val) <> comma <+> (text $ show lab)
ppTargets xs = brackets $ vcat (map ppTarget xs)
in (text "switch") <+> (text $ show scrut) <> comma <+> (text $ show dflt)
<+> (ppTargets targets)
--------------------------------------------------------------------------------
-- * Misc functions
--------------------------------------------------------------------------------
atsym :: Doc
atsym = text "@"
ppCommaJoin :: (Show a) => [a] -> Doc
ppCommaJoin strs = hcat $ intersperse comma (map (text . show) strs)
ppSpaceJoin :: (Show a) => [a] -> Doc
ppSpaceJoin strs = hcat $ intersperse space (map (text . show) strs)
-- | Convert SDoc to Doc
llvmSDoc :: Outp.SDoc -> Doc
llvmSDoc d
= Outp.withPprStyleDoc (Outp.mkCodeStyle Outp.CStyle) d
|
