blob: fb26dbb66f6098f3e0b764d0a65a775cd7b630d4 [file] [log] [blame]
Dan Gohman890c31c2008-05-22 22:45:03 +00001(*
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
Dan Gohmana2858522010-08-04 17:01:59 +000011TODO: Metadata, in all its forms
Dan Gohmana2858522010-08-04 17:01:59 +000012
Dan Gohman890c31c2008-05-22 22:45:03 +000013*)
14
15I ::= "title: LLVM assembly language\n"
16 ^ "status: experimental\n"
17 ^ "audience: LLVM developers\n"
18;
19
20S ::= Module ;
21
22(*
23Define rules for non-keyword tokens. This is currently just a bunch
24of hacks. They don't cover many valid forms of tokens, and they also
25generate some invalid forms of tokens. The LLVM parser has custom
26C++ code to lex these; custom C++ code for emitting them would be
27convenient, but polygen doesn't support that.
28*)
29NonZeroDecimalDigit ::= 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ;
30DecimalDigit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ;
31DecimalDigitSeq ::= DecimalDigit [^ DecimalDigitSeq ];
32HexDigit ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
33 | a | b | c | d | e | f ;
34HexDigitSeq ::= HexDigit [^ HexDigitSeq ];
35StringChar ::= a | b | c | d | e | f | g | h | i | j | k | l | m
36 | n | o | p | q | r | s | t | u | v | w | x | y | z ;
37StringConstantSeq ::= StringChar [^ StringConstantSeq ];
38StringConstant ::= StringChar [^ StringConstantSeq ];
39EUINT64VAL ::= NonZeroDecimalDigit [^ DecimalDigitSeq ];
40ESINT64VAL ::= [ "-" ] ^ EUINT64VAL ;
41EUAPINTVAL ::= EUINT64VAL ;
42ESAPINTVAL ::= ESINT64VAL ;
43LOCALVALID ::= "%" ^ DecimalDigitSeq ;
44GLOBALVALID ::= "@" ^ DecimalDigitSeq ;
45INTTYPE ::= "i" ^ EUINT64VAL ;
46GLOBALVAR ::= "@" ^ StringConstant ;
47LOCALVAR ::= "%" ^ StringConstant ;
48STRINGCONSTANT ::= "\"" ^ StringConstant ^ "\"" ;
49ATSTRINGCONSTANT ::= "@" ^ STRINGCONSTANT ;
50PCTSTRINGCONSTANT ::= "%" ^ STRINGCONSTANT ;
51LABELSTR ::= StringConstant ;
52FPVAL ::= ESAPINTVAL ^ "." ^ EUAPINTVAL | "0x" ^ HexDigitSeq ;
53
54(*
55The rest of this file is derived directly from llvmAsmParser.y.
56*)
57
Dan Gohmanbfacb7e2009-07-22 22:45:30 +000058ArithmeticOps ::= + OptNW add | fadd | OptNW sub | fsub | OptNW mul | fmul |
59 udiv | OptExact sdiv | fdiv | urem | srem | frem ;
Dan Gohman890c31c2008-05-22 22:45:03 +000060LogicalOps ::= shl | lshr | ashr | and | or | xor;
61CastOps ::= trunc | zext | sext | fptrunc | fpext | bitcast |
62 uitofp | sitofp | fptoui | fptosi | inttoptr | ptrtoint ;
63
64IPredicates ::= eq | ne | slt | sgt | sle | sge | ult | ugt | ule | uge ;
65
66FPredicates ::= oeq | one | olt | ogt | ole | oge | ord | uno | ueq | une
67 | ult | ugt | ule | uge | true | false ;
68
69IntType ::= INTTYPE;
70FPType ::= float | double | "ppc_fp128" | fp128 | "x86_fp80";
71
72LocalName ::= LOCALVAR | STRINGCONSTANT | PCTSTRINGCONSTANT ;
73OptLocalName ::= LocalName | _ ;
74
Dan Gohman8f56eba2009-01-05 17:29:42 +000075OptAddrSpace ::= - addrspace ^ "(" ^ EUINT64VAL ^ ")" | _ ;
Dan Gohman890c31c2008-05-22 22:45:03 +000076
77OptLocalAssign ::= LocalName "=" | _ ;
78
79GlobalName ::= GLOBALVAR | ATSTRINGCONSTANT ;
80
81OptGlobalAssign ::= GlobalAssign | _ ;
82
83GlobalAssign ::= GlobalName "=" ;
84
85GVInternalLinkage
86 ::= + internal
87 | weak
Duncan Sands667d4b82009-03-07 15:45:40 +000088 | "weak_odr"
Dan Gohman890c31c2008-05-22 22:45:03 +000089 | linkonce
Duncan Sands667d4b82009-03-07 15:45:40 +000090 | "linkonce_odr"
Dan Gohman890c31c2008-05-22 22:45:03 +000091 | appending
92 | dllexport
93 | common
Dan Gohman923a5792009-07-17 01:07:45 +000094 | private
Dan Gohmana2858522010-08-04 17:01:59 +000095 | "linker_private"
96 | "linker_private_weak"
Dan Gohman890c31c2008-05-22 22:45:03 +000097 ;
98
99GVExternalLinkage
100 ::= dllimport
101 | "extern_weak"
102 | + external
103 ;
104
105GVVisibilityStyle
106 ::= + _
107 | default
108 | hidden
109 | protected
110 ;
111
112FunctionDeclareLinkage
113 ::= + _
114 | dllimport
115 | "extern_weak"
116 ;
117
118FunctionDefineLinkage
119 ::= + _
120 | internal
121 | linkonce
Duncan Sands667d4b82009-03-07 15:45:40 +0000122 | "linkonce_odr"
Dan Gohman890c31c2008-05-22 22:45:03 +0000123 | weak
Duncan Sands667d4b82009-03-07 15:45:40 +0000124 | "weak_odr"
Dan Gohman890c31c2008-05-22 22:45:03 +0000125 | dllexport
126 ;
127
Duncan Sands667d4b82009-03-07 15:45:40 +0000128AliasLinkage ::= + _ | weak | "weak_odr" | internal ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000129
130OptCallingConv ::= + _ |
131 ccc |
132 fastcc |
133 coldcc |
134 "x86_stdcallcc" |
135 "x86_fastcallcc" |
136 cc EUINT64VAL ;
137
138ParamAttr ::= zeroext
Dan Gohman890c31c2008-05-22 22:45:03 +0000139 | signext
Dan Gohman890c31c2008-05-22 22:45:03 +0000140 | inreg
141 | sret
142 | noalias
Dan Gohman571238a2009-01-05 03:21:23 +0000143 | nocapture
Dan Gohman890c31c2008-05-22 22:45:03 +0000144 | byval
145 | nest
146 | align EUINT64VAL
147 ;
148
149OptParamAttrs ::= + _ | OptParamAttrs ParamAttr ;
150
Dan Gohman571238a2009-01-05 03:21:23 +0000151RetAttr ::= inreg
152 | zeroext
153 | signext
154 | noalias
155 ;
156
157OptRetAttrs ::= _
158 | OptRetAttrs RetAttr
159 ;
160
Dan Gohman890c31c2008-05-22 22:45:03 +0000161FuncAttr ::= noreturn
162 | nounwind
Dan Gohman571238a2009-01-05 03:21:23 +0000163 | inreg
Dan Gohman890c31c2008-05-22 22:45:03 +0000164 | zeroext
165 | signext
166 | readnone
167 | readonly
Jakob Stoklund Olesen570a4a52010-02-06 01:16:28 +0000168 | inlinehint
Dan Gohmanc235a0c2010-03-01 17:53:39 +0000169 | alignstack
Dan Gohman571238a2009-01-05 03:21:23 +0000170 | noinline
171 | alwaysinline
172 | optsize
173 | ssp
174 | sspreq
Rafael Espindolab3c4e262011-10-04 03:08:43 +0000175 | returns_twice
John McCall3a3465b2011-06-15 20:36:13 +0000176 | nonlazybind
Dan Gohman890c31c2008-05-22 22:45:03 +0000177 ;
178
179OptFuncAttrs ::= + _ | OptFuncAttrs FuncAttr ;
180
181OptGC ::= + _ | gc STRINGCONSTANT ;
182
183OptAlign ::= + _ | align EUINT64VAL ;
184OptCAlign ::= + _ | ^ "," align EUINT64VAL ;
185
186SectionString ::= section STRINGCONSTANT ;
187
188OptSection ::= + _ | SectionString ;
189
190GlobalVarAttributes ::= + _ | ^ "," GlobalVarAttribute GlobalVarAttributes ;
191GlobalVarAttribute ::= SectionString | align EUINT64VAL ;
192
193PrimType ::= INTTYPE | float | double | "ppc_fp128" | fp128 | "x86_fp80"
194 | - label ;
195
196Types
197 ::= opaque
198 | PrimType
199 | Types OptAddrSpace ^ "*"
200 | SymbolicValueRef
201 | "\\" ^ EUINT64VAL
202 | Types "(" ^ ArgTypeListI ^ ")" OptFuncAttrs
203 | void "(" ^ ArgTypeListI ^ ")" OptFuncAttrs
204 | "[" ^ EUINT64VAL "x" Types ^ "]"
205 | "<" ^ EUINT64VAL "x" Types ^ ">"
206 | "{" TypeListI "}"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000207 | "{" ^ "}"
Dan Gohman890c31c2008-05-22 22:45:03 +0000208 | "<" ^ "{" TypeListI "}" ^ ">"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000209 | "<" ^ "{" ^ "}" ^ ">"
Dan Gohman890c31c2008-05-22 22:45:03 +0000210 ;
211
212ArgType ::= Types OptParamAttrs ;
213
214ResultTypes ::= Types | void ;
215
216ArgTypeList ::= ArgType | ArgTypeList ^ "," ArgType ;
217
218ArgTypeListI ::= ArgTypeList | ArgTypeList ^ "," "..." | "..." | _ ;
219
220TypeListI ::= Types | TypeListI ^ "," Types ;
221
222ConstVal::= Types "[" ^ ConstVector ^ "]"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000223 | Types "[" ^ "]"
Dan Gohman890c31c2008-05-22 22:45:03 +0000224 | Types "c" ^ STRINGCONSTANT
225 | Types "<" ^ ConstVector ^ ">"
226 | Types "{" ConstVector "}"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000227 | Types "{" ^ "}"
Dan Gohman890c31c2008-05-22 22:45:03 +0000228 | Types "<" ^ "{" ConstVector "}" ^ ">"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000229 | Types "<" ^ "{" ^ "}" ^ ">"
Dan Gohman890c31c2008-05-22 22:45:03 +0000230 | Types null
231 | Types undef
232 | Types SymbolicValueRef
233 | Types ConstExpr
234 | Types zeroinitializer
Dan Gohman571238a2009-01-05 03:21:23 +0000235 | Types ESINT64VAL
236 | Types ESAPINTVAL
237 | Types EUINT64VAL
238 | Types EUAPINTVAL
239 | Types true
240 | Types false
241 | Types FPVAL ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000242
243ConstExpr::= CastOps "(" ^ ConstVal to Types ^ ")"
Dan Gohman224251d2009-07-27 21:55:32 +0000244 | getelementptr OptInBounds "(" ^ ConstVal IndexList ^ ")"
Dan Gohman890c31c2008-05-22 22:45:03 +0000245 | select "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
246 | ArithmeticOps "(" ^ ConstVal ^ "," ConstVal ^ ")"
247 | LogicalOps "(" ^ ConstVal ^ "," ConstVal ^ ")"
248 | icmp IPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")"
249 | fcmp FPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")"
Dan Gohman890c31c2008-05-22 22:45:03 +0000250 | extractelement "(" ^ ConstVal ^ "," ConstVal ^ ")"
251 | insertelement "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
Dan Gohmane4977cf2008-05-23 01:55:30 +0000252 | shufflevector "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")"
Dan Gohman34e71fe2008-06-02 19:47:09 +0000253 | extractvalue "(" ^ ConstVal ^ ConstantIndexList ^ ")"
254 | insertvalue "(" ^ ConstVal ^ "," ConstVal ^ ConstantIndexList ^ ")" ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000255
256ConstVector ::= ConstVector ^ "," ConstVal | ConstVal ;
257
258GlobalType ::= global | constant ;
259
260ThreadLocal ::= - "thread_local" | _ ;
261
262AliaseeRef ::= ResultTypes SymbolicValueRef
263 | bitcast "(" ^ AliaseeRef to Types ^ ")" ;
264
265Module ::= +++ DefinitionList | --- _ ;
266
267DefinitionList ::= - Definition | + DefinitionList Definition ;
268
269Definition
270 ::= ^ ( +++++ define Function
271 | declare FunctionProto
272 | - module asm AsmBlock
273 | OptLocalAssign type Types
Dan Gohmande0e7f22009-01-05 23:03:03 +0000274 | OptGlobalAssign GVVisibilityStyle ThreadLocal OptAddrSpace GlobalType
Dan Gohman8f56eba2009-01-05 17:29:42 +0000275 ConstVal GlobalVarAttributes
276 | OptGlobalAssign GVInternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace
277 GlobalType ConstVal GlobalVarAttributes
278 | OptGlobalAssign GVExternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace
279 GlobalType Types GlobalVarAttributes
Dan Gohman890c31c2008-05-22 22:45:03 +0000280 | OptGlobalAssign GVVisibilityStyle alias AliasLinkage AliaseeRef
281 | target TargetDefinition
282 | deplibs "=" LibrariesDefinition
283 ) ^ "\n";
284
285AsmBlock ::= STRINGCONSTANT ;
286
287TargetDefinition ::= triple "=" STRINGCONSTANT
288 | datalayout "=" STRINGCONSTANT ;
289
Dan Gohman8f56eba2009-01-05 17:29:42 +0000290LibrariesDefinition ::= "[" ( LibList | _ ) "]";
Dan Gohman890c31c2008-05-22 22:45:03 +0000291
Dan Gohman8f56eba2009-01-05 17:29:42 +0000292LibList ::= LibList ^ "," STRINGCONSTANT | STRINGCONSTANT ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000293
294ArgListH ::= ArgListH ^ "," Types OptParamAttrs OptLocalName
295 | Types OptParamAttrs OptLocalName ;
296
297ArgList ::= ArgListH | ArgListH ^ "," "..." | "..." | _ ;
298
Dan Gohman571238a2009-01-05 03:21:23 +0000299FunctionHeaderH ::= OptCallingConv OptRetAttrs ResultTypes
Dan Gohman8f56eba2009-01-05 17:29:42 +0000300 GlobalName ^ "(" ^ ArgList ^ ")"
Dan Gohman571238a2009-01-05 03:21:23 +0000301 OptFuncAttrs OptSection OptAlign OptGC ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000302
303BEGIN ::= ( begin | "{" ) ^ "\n";
304
305FunctionHeader ::=
306 FunctionDefineLinkage GVVisibilityStyle FunctionHeaderH BEGIN ;
307
308END ::= ^ ( end | "}" ) ^ "\n";
309
310Function ::= BasicBlockList END ;
311
312FunctionProto ::= FunctionDeclareLinkage GVVisibilityStyle FunctionHeaderH ;
313
314OptSideEffect ::= _ | sideeffect ;
315
316ConstValueRef ::= ESINT64VAL
317 | EUINT64VAL
318 | FPVAL
319 | true
320 | false
321 | null
322 | undef
323 | zeroinitializer
324 | "<" ConstVector ">"
Dan Gohmanf910eaa2008-06-09 14:45:02 +0000325 | "[" ConstVector "]"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000326 | "[" ^ "]"
Dan Gohmanf910eaa2008-06-09 14:45:02 +0000327 | "c" ^ STRINGCONSTANT
328 | "{" ConstVector "}"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000329 | "{" ^ "}"
Dan Gohmanf910eaa2008-06-09 14:45:02 +0000330 | "<" ^ "{" ConstVector "}" ^ ">"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000331 | "<" ^ "{" ^ "}" ^ ">"
Dan Gohman890c31c2008-05-22 22:45:03 +0000332 | ConstExpr
333 | asm OptSideEffect STRINGCONSTANT ^ "," STRINGCONSTANT ;
334
335SymbolicValueRef ::= LOCALVALID
336 | GLOBALVALID
337 | LocalName
338 | GlobalName ;
339
340ValueRef ::= SymbolicValueRef | ConstValueRef;
341
342ResolvedVal ::= Types ValueRef ;
343
344ReturnedVal ::= ResolvedVal | ReturnedVal ^ "," ResolvedVal ;
345
346BasicBlockList ::= BasicBlockList BasicBlock | FunctionHeader BasicBlock ;
347
348BasicBlock ::= InstructionList OptLocalAssign BBTerminatorInst ;
349
350InstructionList ::= +++ InstructionList Inst
351 | - _
352 | ^ LABELSTR ^ ":\n" ;
353
354BBTerminatorInst ::= ^ " " ^
355 ( ret ReturnedVal
356 | ret void
357 | br label ValueRef
358 | br INTTYPE ValueRef ^ "," label ValueRef ^ "," label ValueRef
359 | switch IntType ValueRef ^ "," label ValueRef "[" JumpTable "]"
Dan Gohman0d58eb62008-09-15 16:10:51 +0000360 | switch IntType ValueRef ^ "," label ValueRef "[" ^ "]"
361 | invoke OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")"
362 OptFuncAttrs
Dan Gohman890c31c2008-05-22 22:45:03 +0000363 to label ValueRef unwind label ValueRef
364 | unwind
365 | unreachable ) ^ "\n";
366
367JumpTable ::= JumpTable IntType ConstValueRef ^ "," label ValueRef
368 | IntType ConstValueRef ^ "," label ValueRef ;
369
370Inst ::= ^ " " ^ OptLocalAssign InstVal ^ "\n";
371
372PHIList ::= Types "[" ValueRef ^ "," ValueRef "]"
373 | PHIList ^ "," "[" ValueRef ^ "," ValueRef "]" ;
374
375ParamList ::= Types OptParamAttrs ValueRef OptParamAttrs
376 | label OptParamAttrs ValueRef OptParamAttrs
377 | ParamList ^ "," Types OptParamAttrs ValueRef OptParamAttrs
378 | ParamList ^ "," label OptParamAttrs ValueRef OptParamAttrs
379 | - _ ;
380
381IndexList ::= _ | IndexList ^ "," ResolvedVal ;
382
Dan Gohman34e71fe2008-06-02 19:47:09 +0000383ConstantIndexList ::= "," EUINT64VAL | ConstantIndexList ^ "," EUINT64VAL ;
384
Dan Gohman890c31c2008-05-22 22:45:03 +0000385OptTailCall ::= tail call | call ;
386
387InstVal ::=
388 ArithmeticOps Types ValueRef ^ "," ValueRef
389 | LogicalOps Types ValueRef ^ "," ValueRef
390 | icmp IPredicates Types ValueRef ^ "," ValueRef
391 | fcmp FPredicates Types ValueRef ^ "," ValueRef
Dan Gohman890c31c2008-05-22 22:45:03 +0000392 | CastOps ResolvedVal to Types
393 | select ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
Dan Gohmanb737a642008-05-23 17:11:55 +0000394 | "va_arg" ResolvedVal ^ "," Types
Dan Gohman890c31c2008-05-22 22:45:03 +0000395 | extractelement ResolvedVal ^ "," ResolvedVal
396 | insertelement ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
397 | shufflevector ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal
398 | phi PHIList
Dan Gohman0d58eb62008-09-15 16:10:51 +0000399 | OptTailCall OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")"
Dan Gohman890c31c2008-05-22 22:45:03 +0000400 OptFuncAttrs
401 | MemoryInst ;
402
403OptVolatile ::= - volatile | _ ;
Dan Gohmanbfacb7e2009-07-22 22:45:30 +0000404OptExact ::= - exact | _ ;
405OptNSW ::= - nsw | _ ;
406OptNUW ::= - nuw | _ ;
Dan Gohmand622b0b2010-05-04 00:13:24 +0000407OptNW ::= OptNUW OptNSW | OptNSW OptNUW ;
Dan Gohman224251d2009-07-27 21:55:32 +0000408OptInBounds ::= - inbounds | _ ;
Dan Gohman890c31c2008-05-22 22:45:03 +0000409
410MemoryInst ::= malloc Types OptCAlign
411 | malloc Types ^ "," INTTYPE ValueRef OptCAlign
412 | alloca Types OptCAlign
413 | alloca Types ^ "," INTTYPE ValueRef OptCAlign
414 | free ResolvedVal
415 | OptVolatile load Types ValueRef OptCAlign
416 | OptVolatile store ResolvedVal ^ "," Types ValueRef OptCAlign
417 | getresult Types ValueRef ^ "," EUINT64VAL
Dan Gohman224251d2009-07-27 21:55:32 +0000418 | getelementptr OptInBounds Types ValueRef IndexList
Dan Gohman34e71fe2008-06-02 19:47:09 +0000419 | extractvalue Types ValueRef ^ ConstantIndexList
420 | insertvalue Types ValueRef ^ "," Types ValueRef ^ ConstantIndexList ;