blob: f97c0d147ae7c22e1933761619c090c14b75b6c6 [file] [log] [blame]
John Bauman89401822014-05-06 15:04:28 -04001(*
2
3polygen grammar for LLVM assembly language.
4
5This file defines an LLVM assembly language grammar for polygen,
6which is a tool for generating random text based on a grammar.
7It is strictly syntax-based, and makes no attempt to generate
8IR that is semantically valid. Most of the IR produced doesn't
9pass the Verifier.
10
11TODO: Metadata, in all its forms
12TODO: Union types
13
14*)
15
16I ::= "title: LLVM assembly language\n"
17 ^ "status: experimental\n"
18 ^ "audience: LLVM developers\n"
19;
20
21S ::= Module ;
22
23(*
24Define rules for non-keyword tokens. This is currently just a bunch
25of hacks. They don't cover many valid forms of tokens, and they also
26generate some invalid forms of tokens. The LLVM parser has custom
27C++ code to lex these; custom C++ code for emitting them would be
28convenient, but polygen doesn't support that.
29*)
30NonZeroDecimalDigit ::= 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ;
31DecimalDigit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ;
32DecimalDigitSeq ::= DecimalDigit [^ DecimalDigitSeq ];
33HexDigit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
34 | a | b | c | d | e | f ;
35HexDigitSeq ::= HexDigit [^ HexDigitSeq ];
36StringChar ::= a | b | c | d | e | f | g | h | i | j | k | l | m
37 | n | o | p | q | r | s | t | u | v | w | x | y | z ;
38StringConstantSeq ::= StringChar [^ StringConstantSeq ];
39StringConstant ::= StringChar [^ StringConstantSeq ];
40EUINT64VAL ::= NonZeroDecimalDigit [^ DecimalDigitSeq ];
41ESINT64VAL ::= [ "-" ] ^ EUINT64VAL ;
42EUAPINTVAL ::= EUINT64VAL ;
43ESAPINTVAL ::= ESINT64VAL ;
44LOCALVALID ::= "%" ^ DecimalDigitSeq ;
45GLOBALVALID ::= "@" ^ DecimalDigitSeq ;
46INTTYPE ::= "i" ^ EUINT64VAL ;
47GLOBALVAR ::= "@" ^ StringConstant ;
48LOCALVAR ::= "%" ^ StringConstant ;
49STRINGCONSTANT ::= "\"" ^ StringConstant ^ "\"" ;
50ATSTRINGCONSTANT ::= "@" ^ STRINGCONSTANT ;
51PCTSTRINGCONSTANT ::= "%" ^ STRINGCONSTANT ;
52LABELSTR ::= StringConstant ;
53FPVAL ::= ESAPINTVAL ^ "." ^ EUAPINTVAL | "0x" ^ HexDigitSeq ;
54
55(*
56The rest of this file is derived directly from llvmAsmParser.y.
57*)
58
59ArithmeticOps ::= + OptNW add | fadd | OptNW sub | fsub | OptNW mul | fmul |
60 udiv | OptExact sdiv | fdiv | urem | srem | frem ;
61LogicalOps ::= shl | lshr | ashr | and | or | xor;
62CastOps ::= trunc | zext | sext | fptrunc | fpext | bitcast |
63 uitofp | sitofp | fptoui | fptosi | inttoptr | ptrtoint ;
64
65IPredicates ::= eq | ne | slt | sgt | sle | sge | ult | ugt | ule | uge ;
66
67FPredicates ::= oeq | one | olt | ogt | ole | oge | ord | uno | ueq | une
68 | ult | ugt | ule | uge | true | false ;
69
70IntType ::= INTTYPE;
71FPType ::= float | double | "ppc_fp128" | fp128 | "x86_fp80";
72
73LocalName ::= LOCALVAR | STRINGCONSTANT | PCTSTRINGCONSTANT ;
74OptLocalName ::= LocalName | _ ;
75
76OptAddrSpace ::= - addrspace ^ "(" ^ EUINT64VAL ^ ")" | _ ;
77
78OptLocalAssign ::= LocalName "=" | _ ;
79
80GlobalName ::= GLOBALVAR | ATSTRINGCONSTANT ;
81
82OptGlobalAssign ::= GlobalAssign | _ ;
83
84GlobalAssign ::= GlobalName "=" ;
85
86GVInternalLinkage
87 ::= + internal
88 | weak
89 | "weak_odr"
90 | linkonce
91 | "linkonce_odr"
92 | appending
93 | dllexport
94 | common
95 | private
96 | "linker_private"
97 | "linker_private_weak"
98 ;
99
100GVExternalLinkage
101 ::= dllimport
102 | "extern_weak"
103 | + external
104 ;
105
106GVVisibilityStyle
107 ::= + _
108 | default
109 | hidden
110 | protected
111 ;
112
113FunctionDeclareLinkage
114 ::= + _
115 | dllimport
116 | "extern_weak"
117 ;
118
119FunctionDefineLinkage
120 ::= + _
121 | internal
122 | linkonce
123 | "linkonce_odr"
124 | weak
125 | "weak_odr"
126 | dllexport
127 ;
128
129AliasLinkage ::= + _ | weak | "weak_odr" | internal ;
130
131OptCallingConv ::= + _ |
132 ccc |
133 fastcc |
134 coldcc |
135 "x86_stdcallcc" |
136 "x86_fastcallcc" |
137 cc EUINT64VAL ;
138
139ParamAttr ::= zeroext
140 | signext
141 | inreg
142 | sret
143 | noalias
144 | nocapture
145 | byval
146 | nest
147 | align EUINT64VAL
148 ;
149
150OptParamAttrs ::= + _ | OptParamAttrs ParamAttr ;
151
152RetAttr ::= inreg
153 | zeroext
154 | signext
155 | noalias
156 ;
157
158OptRetAttrs ::= _
159 | OptRetAttrs RetAttr
160 ;
161
162FuncAttr ::= noreturn
163 | nounwind
164 | inreg
165 | zeroext
166 | signext
167 | readnone
168 | readonly
169 | inlinehint
170 | alignstack
171 | noinline
172 | alwaysinline
173 | optsize
174 | ssp
175 | sspreq
176 ;
177
178OptFuncAttrs ::= + _ | OptFuncAttrs FuncAttr ;
179
180OptGC ::= + _ | gc STRINGCONSTANT ;
181
182OptAlign ::= + _ | align EUINT64VAL ;
183OptCAlign ::= + _ | ^ "," align EUINT64VAL ;
184
185SectionString ::= section STRINGCONSTANT ;
186
187OptSection ::= + _ | SectionString ;
188
189GlobalVarAttributes ::= + _ | ^ "," GlobalVarAttribute GlobalVarAttributes ;
190GlobalVarAttribute ::= SectionString | align EUINT64VAL ;
191
192PrimType ::= INTTYPE | float | double | "ppc_fp128" | fp128 | "x86_fp80"
193 | - label ;
194
195Types
196 ::= opaque
197 | PrimType
198 | Types OptAddrSpace ^ "*"
199 | SymbolicValueRef
200 | "\\" ^ EUINT64VAL
201 | Types "(" ^ ArgTypeListI ^ ")" OptFuncAttrs
202 | void "(" ^ ArgTypeListI ^ ")" OptFuncAttrs
203 | "[" ^ EUINT64VAL "x" Types ^ "]"
204 | "<" ^ EUINT64VAL "x" Types ^ ">"
205 | "{" TypeListI "}"
206 | "{" ^ "}"
207 | "<" ^ "{" TypeListI "}" ^ ">"
208 | "<" ^ "{" ^ "}" ^ ">"
209 ;
210
211ArgType ::= Types OptParamAttrs ;
212
213ResultTypes ::= Types | void ;
214
215ArgTypeList ::= ArgType | ArgTypeList ^ "," ArgType ;
216
217ArgTypeListI ::= ArgTypeList | ArgTypeList ^ "," "..." | "..." | _ ;
218
219TypeListI ::= Types | TypeListI ^ "," Types ;
220
221ConstVal::= Types "[" ^ ConstVector ^ "]"
222 | Types "[" ^ "]"
223 | Types "c" ^ STRINGCONSTANT
224 | Types "<" ^ ConstVector ^ ">"
225 | Types "{" ConstVector "}"
226 | Types "{" ^ "}"
227 | Types "<" ^ "{" ConstVector "}" ^ ">"
228 | Types "<" ^ "{" ^ "}" ^ ">"
229 | Types null
230 | Types undef
231 | Types SymbolicValueRef
232 | Types ConstExpr
233 | Types zeroinitializer
234 | Types ESINT64VAL
235 | Types ESAPINTVAL
236 | Types EUINT64VAL
237 | Types EUAPINTVAL
238 | Types true
239 | Types false
240 | Types FPVAL ;
241
242ConstExpr::= CastOps "(" ^ ConstVal to Types ^ ")"
243 | getelementptr OptInBounds "(" ^ ConstVal IndexList ^ ")"
244 | select "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
245 | ArithmeticOps "(" ^ ConstVal ^ "," ConstVal ^ ")"
246 | LogicalOps "(" ^ ConstVal ^ "," ConstVal ^ ")"
247 | icmp IPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")"
248 | fcmp FPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")"
249 | extractelement "(" ^ ConstVal ^ "," ConstVal ^ ")"
250 | insertelement "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
251 | shufflevector "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
252 | extractvalue "(" ^ ConstVal ^ ConstantIndexList ^ ")"
253 | insertvalue "(" ^ ConstVal ^ "," ConstVal ^ ConstantIndexList ^ ")" ;
254
255ConstVector ::= ConstVector ^ "," ConstVal | ConstVal ;
256
257GlobalType ::= global | constant ;
258
259ThreadLocal ::= - "thread_local" | _ ;
260
261AliaseeRef ::= ResultTypes SymbolicValueRef
262 | bitcast "(" ^ AliaseeRef to Types ^ ")" ;
263
264Module ::= +++ DefinitionList | --- _ ;
265
266DefinitionList ::= - Definition | + DefinitionList Definition ;
267
268Definition
269 ::= ^ ( +++++ define Function
270 | declare FunctionProto
271 | - module asm AsmBlock
272 | OptLocalAssign type Types
273 | OptGlobalAssign GVVisibilityStyle ThreadLocal OptAddrSpace GlobalType
274 ConstVal GlobalVarAttributes
275 | OptGlobalAssign GVInternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace
276 GlobalType ConstVal GlobalVarAttributes
277 | OptGlobalAssign GVExternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace
278 GlobalType Types GlobalVarAttributes
279 | OptGlobalAssign GVVisibilityStyle alias AliasLinkage AliaseeRef
280 | target TargetDefinition
281 | deplibs "=" LibrariesDefinition
282 ) ^ "\n";
283
284AsmBlock ::= STRINGCONSTANT ;
285
286TargetDefinition ::= triple "=" STRINGCONSTANT
287 | datalayout "=" STRINGCONSTANT ;
288
289LibrariesDefinition ::= "[" ( LibList | _ ) "]";
290
291LibList ::= LibList ^ "," STRINGCONSTANT | STRINGCONSTANT ;
292
293ArgListH ::= ArgListH ^ "," Types OptParamAttrs OptLocalName
294 | Types OptParamAttrs OptLocalName ;
295
296ArgList ::= ArgListH | ArgListH ^ "," "..." | "..." | _ ;
297
298FunctionHeaderH ::= OptCallingConv OptRetAttrs ResultTypes
299 GlobalName ^ "(" ^ ArgList ^ ")"
300 OptFuncAttrs OptSection OptAlign OptGC ;
301
302BEGIN ::= ( begin | "{" ) ^ "\n";
303
304FunctionHeader ::=
305 FunctionDefineLinkage GVVisibilityStyle FunctionHeaderH BEGIN ;
306
307END ::= ^ ( end | "}" ) ^ "\n";
308
309Function ::= BasicBlockList END ;
310
311FunctionProto ::= FunctionDeclareLinkage GVVisibilityStyle FunctionHeaderH ;
312
313OptSideEffect ::= _ | sideeffect ;
314
315ConstValueRef ::= ESINT64VAL
316 | EUINT64VAL
317 | FPVAL
318 | true
319 | false
320 | null
321 | undef
322 | zeroinitializer
323 | "<" ConstVector ">"
324 | "[" ConstVector "]"
325 | "[" ^ "]"
326 | "c" ^ STRINGCONSTANT
327 | "{" ConstVector "}"
328 | "{" ^ "}"
329 | "<" ^ "{" ConstVector "}" ^ ">"
330 | "<" ^ "{" ^ "}" ^ ">"
331 | ConstExpr
332 | asm OptSideEffect STRINGCONSTANT ^ "," STRINGCONSTANT ;
333
334SymbolicValueRef ::= LOCALVALID
335 | GLOBALVALID
336 | LocalName
337 | GlobalName ;
338
339ValueRef ::= SymbolicValueRef | ConstValueRef;
340
341ResolvedVal ::= Types ValueRef ;
342
343ReturnedVal ::= ResolvedVal | ReturnedVal ^ "," ResolvedVal ;
344
345BasicBlockList ::= BasicBlockList BasicBlock | FunctionHeader BasicBlock ;
346
347BasicBlock ::= InstructionList OptLocalAssign BBTerminatorInst ;
348
349InstructionList ::= +++ InstructionList Inst
350 | - _
351 | ^ LABELSTR ^ ":\n" ;
352
353BBTerminatorInst ::= ^ " " ^
354 ( ret ReturnedVal
355 | ret void
356 | br label ValueRef
357 | br INTTYPE ValueRef ^ "," label ValueRef ^ "," label ValueRef
358 | switch IntType ValueRef ^ "," label ValueRef "[" JumpTable "]"
359 | switch IntType ValueRef ^ "," label ValueRef "[" ^ "]"
360 | invoke OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")"
361 OptFuncAttrs
362 to label ValueRef unwind label ValueRef
363 | unwind
364 | unreachable ) ^ "\n";
365
366JumpTable ::= JumpTable IntType ConstValueRef ^ "," label ValueRef
367 | IntType ConstValueRef ^ "," label ValueRef ;
368
369Inst ::= ^ " " ^ OptLocalAssign InstVal ^ "\n";
370
371PHIList ::= Types "[" ValueRef ^ "," ValueRef "]"
372 | PHIList ^ "," "[" ValueRef ^ "," ValueRef "]" ;
373
374ParamList ::= Types OptParamAttrs ValueRef OptParamAttrs
375 | label OptParamAttrs ValueRef OptParamAttrs
376 | ParamList ^ "," Types OptParamAttrs ValueRef OptParamAttrs
377 | ParamList ^ "," label OptParamAttrs ValueRef OptParamAttrs
378 | - _ ;
379
380IndexList ::= _ | IndexList ^ "," ResolvedVal ;
381
382ConstantIndexList ::= "," EUINT64VAL | ConstantIndexList ^ "," EUINT64VAL ;
383
384OptTailCall ::= tail call | call ;
385
386InstVal ::=
387 ArithmeticOps Types ValueRef ^ "," ValueRef
388 | LogicalOps Types ValueRef ^ "," ValueRef
389 | icmp IPredicates Types ValueRef ^ "," ValueRef
390 | fcmp FPredicates Types ValueRef ^ "," ValueRef
391 | CastOps ResolvedVal to Types
392 | select ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
393 | "va_arg" ResolvedVal ^ "," Types
394 | extractelement ResolvedVal ^ "," ResolvedVal
395 | insertelement ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
396 | shufflevector ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
397 | phi PHIList
398 | OptTailCall OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")"
399 OptFuncAttrs
400 | MemoryInst ;
401
402OptVolatile ::= - volatile | _ ;
403OptExact ::= - exact | _ ;
404OptNSW ::= - nsw | _ ;
405OptNUW ::= - nuw | _ ;
406OptNW ::= OptNUW OptNSW | OptNSW OptNUW ;
407OptInBounds ::= - inbounds | _ ;
408
409MemoryInst ::= malloc Types OptCAlign
410 | malloc Types ^ "," INTTYPE ValueRef OptCAlign
411 | alloca Types OptCAlign
412 | alloca Types ^ "," INTTYPE ValueRef OptCAlign
413 | free ResolvedVal
414 | OptVolatile load Types ValueRef OptCAlign
415 | OptVolatile store ResolvedVal ^ "," Types ValueRef OptCAlign
416 | getresult Types ValueRef ^ "," EUINT64VAL
417 | getelementptr OptInBounds Types ValueRef IndexList
418 | extractvalue Types ValueRef ^ ConstantIndexList
419 | insertvalue Types ValueRef ^ "," Types ValueRef ^ ConstantIndexList ;