1(* 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 12 13*) 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 58ArithmeticOps ::= + OptNW add | fadd | OptNW sub | fsub | OptNW mul | fmul | 59 udiv | OptExact sdiv | fdiv | urem | srem | frem ; 60LogicalOps ::= 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 75OptAddrSpace ::= - addrspace ^ "(" ^ EUINT64VAL ^ ")" | _ ; 76 77OptLocalAssign ::= LocalName "=" | _ ; 78 79GlobalName ::= GLOBALVAR | ATSTRINGCONSTANT ; 80 81OptGlobalAssign ::= GlobalAssign | _ ; 82 83GlobalAssign ::= GlobalName "=" ; 84 85GVInternalLinkage 86 ::= + internal 87 | weak 88 | "weak_odr" 89 | linkonce 90 | "linkonce_odr" 91 | appending 92 | dllexport 93 | common 94 | private 95 | "linker_private" 96 | "linker_private_weak" 97 ; 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 122 | "linkonce_odr" 123 | weak 124 | "weak_odr" 125 | dllexport 126 ; 127 128AliasLinkage ::= + _ | weak | "weak_odr" | internal ; 129 130OptCallingConv ::= + _ | 131 ccc | 132 fastcc | 133 coldcc | 134 "x86_stdcallcc" | 135 "x86_fastcallcc" | 136 cc EUINT64VAL ; 137 138ParamAttr ::= zeroext 139 | signext 140 | inreg 141 | sret 142 | noalias 143 | nocapture 144 | byval 145 | nest 146 | align EUINT64VAL 147 ; 148 149OptParamAttrs ::= + _ | OptParamAttrs ParamAttr ; 150 151RetAttr ::= inreg 152 | zeroext 153 | signext 154 | noalias 155 ; 156 157OptRetAttrs ::= _ 158 | OptRetAttrs RetAttr 159 ; 160 161FuncAttr ::= noreturn 162 | nounwind 163 | inreg 164 | zeroext 165 | signext 166 | readnone 167 | readonly 168 | inlinehint 169 | alignstack 170 | noinline 171 | alwaysinline 172 | optsize 173 | ssp 174 | sspreq 175 | returns_twice 176 | nonlazybind 177 | sanitize_address 178 | sanitize_thread 179 | sanitize_memory 180 ; 181 182OptFuncAttrs ::= + _ | OptFuncAttrs FuncAttr ; 183 184OptGC ::= + _ | gc STRINGCONSTANT ; 185 186OptAlign ::= + _ | align EUINT64VAL ; 187OptCAlign ::= + _ | ^ "," align EUINT64VAL ; 188 189SectionString ::= section STRINGCONSTANT ; 190 191OptSection ::= + _ | SectionString ; 192 193GlobalVarAttributes ::= + _ | ^ "," GlobalVarAttribute GlobalVarAttributes ; 194GlobalVarAttribute ::= SectionString | align EUINT64VAL ; 195 196PrimType ::= INTTYPE | float | double | "ppc_fp128" | fp128 | "x86_fp80" 197 | - label ; 198 199Types 200 ::= opaque 201 | PrimType 202 | Types OptAddrSpace ^ "*" 203 | SymbolicValueRef 204 | "\\" ^ EUINT64VAL 205 | Types "(" ^ ArgTypeListI ^ ")" OptFuncAttrs 206 | void "(" ^ ArgTypeListI ^ ")" OptFuncAttrs 207 | "[" ^ EUINT64VAL "x" Types ^ "]" 208 | "<" ^ EUINT64VAL "x" Types ^ ">" 209 | "{" TypeListI "}" 210 | "{" ^ "}" 211 | "<" ^ "{" TypeListI "}" ^ ">" 212 | "<" ^ "{" ^ "}" ^ ">" 213 ; 214 215ArgType ::= Types OptParamAttrs ; 216 217ResultTypes ::= Types | void ; 218 219ArgTypeList ::= ArgType | ArgTypeList ^ "," ArgType ; 220 221ArgTypeListI ::= ArgTypeList | ArgTypeList ^ "," "..." | "..." | _ ; 222 223TypeListI ::= Types | TypeListI ^ "," Types ; 224 225ConstVal::= Types "[" ^ ConstVector ^ "]" 226 | Types "[" ^ "]" 227 | Types "c" ^ STRINGCONSTANT 228 | Types "<" ^ ConstVector ^ ">" 229 | Types "{" ConstVector "}" 230 | Types "{" ^ "}" 231 | Types "<" ^ "{" ConstVector "}" ^ ">" 232 | Types "<" ^ "{" ^ "}" ^ ">" 233 | Types null 234 | Types undef 235 | Types SymbolicValueRef 236 | Types ConstExpr 237 | Types zeroinitializer 238 | Types ESINT64VAL 239 | Types ESAPINTVAL 240 | Types EUINT64VAL 241 | Types EUAPINTVAL 242 | Types true 243 | Types false 244 | Types FPVAL ; 245 246ConstExpr::= CastOps "(" ^ ConstVal to Types ^ ")" 247 | getelementptr OptInBounds "(" ^ ConstVal IndexList ^ ")" 248 | select "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")" 249 | ArithmeticOps "(" ^ ConstVal ^ "," ConstVal ^ ")" 250 | LogicalOps "(" ^ ConstVal ^ "," ConstVal ^ ")" 251 | icmp IPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")" 252 | fcmp FPredicates "(" ^ ConstVal ^ "," ConstVal ^ ")" 253 | extractelement "(" ^ ConstVal ^ "," ConstVal ^ ")" 254 | insertelement "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")" 255 | shufflevector "(" ^ ConstVal ^ "," ConstVal ^ "," ConstVal ^ ")" 256 | extractvalue "(" ^ ConstVal ^ ConstantIndexList ^ ")" 257 | insertvalue "(" ^ ConstVal ^ "," ConstVal ^ ConstantIndexList ^ ")" ; 258 259ConstVector ::= ConstVector ^ "," ConstVal | ConstVal ; 260 261GlobalType ::= global | constant ; 262 263ThreadLocal ::= - "thread_local" | _ ; 264 265AliaseeRef ::= ResultTypes SymbolicValueRef 266 | bitcast "(" ^ AliaseeRef to Types ^ ")" ; 267 268Module ::= +++ DefinitionList | --- _ ; 269 270DefinitionList ::= - Definition | + DefinitionList Definition ; 271 272Definition 273 ::= ^ ( +++++ define Function 274 | declare FunctionProto 275 | - module asm AsmBlock 276 | OptLocalAssign type Types 277 | OptGlobalAssign GVVisibilityStyle ThreadLocal OptAddrSpace GlobalType 278 ConstVal GlobalVarAttributes 279 | OptGlobalAssign GVInternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace 280 GlobalType ConstVal GlobalVarAttributes 281 | OptGlobalAssign GVExternalLinkage GVVisibilityStyle ThreadLocal OptAddrSpace 282 GlobalType Types GlobalVarAttributes 283 | OptGlobalAssign GVVisibilityStyle alias AliasLinkage AliaseeRef 284 | target TargetDefinition 285 | deplibs "=" LibrariesDefinition 286 ) ^ "\n"; 287 288AsmBlock ::= STRINGCONSTANT ; 289 290TargetDefinition ::= triple "=" STRINGCONSTANT 291 | datalayout "=" STRINGCONSTANT ; 292 293LibrariesDefinition ::= "[" ( LibList | _ ) "]"; 294 295LibList ::= LibList ^ "," STRINGCONSTANT | STRINGCONSTANT ; 296 297ArgListH ::= ArgListH ^ "," Types OptParamAttrs OptLocalName 298 | Types OptParamAttrs OptLocalName ; 299 300ArgList ::= ArgListH | ArgListH ^ "," "..." | "..." | _ ; 301 302FunctionHeaderH ::= OptCallingConv OptRetAttrs ResultTypes 303 GlobalName ^ "(" ^ ArgList ^ ")" 304 OptFuncAttrs OptSection OptAlign OptGC ; 305 306BEGIN ::= ( begin | "{" ) ^ "\n"; 307 308FunctionHeader ::= 309 FunctionDefineLinkage GVVisibilityStyle FunctionHeaderH BEGIN ; 310 311END ::= ^ ( end | "}" ) ^ "\n"; 312 313Function ::= BasicBlockList END ; 314 315FunctionProto ::= FunctionDeclareLinkage GVVisibilityStyle FunctionHeaderH ; 316 317OptSideEffect ::= _ | sideeffect ; 318 319ConstValueRef ::= ESINT64VAL 320 | EUINT64VAL 321 | FPVAL 322 | true 323 | false 324 | null 325 | undef 326 | zeroinitializer 327 | "<" ConstVector ">" 328 | "[" ConstVector "]" 329 | "[" ^ "]" 330 | "c" ^ STRINGCONSTANT 331 | "{" ConstVector "}" 332 | "{" ^ "}" 333 | "<" ^ "{" ConstVector "}" ^ ">" 334 | "<" ^ "{" ^ "}" ^ ">" 335 | ConstExpr 336 | asm OptSideEffect STRINGCONSTANT ^ "," STRINGCONSTANT ; 337 338SymbolicValueRef ::= LOCALVALID 339 | GLOBALVALID 340 | LocalName 341 | GlobalName ; 342 343ValueRef ::= SymbolicValueRef | ConstValueRef; 344 345ResolvedVal ::= Types ValueRef ; 346 347ReturnedVal ::= ResolvedVal | ReturnedVal ^ "," ResolvedVal ; 348 349BasicBlockList ::= BasicBlockList BasicBlock | FunctionHeader BasicBlock ; 350 351BasicBlock ::= InstructionList OptLocalAssign BBTerminatorInst ; 352 353InstructionList ::= +++ InstructionList Inst 354 | - _ 355 | ^ LABELSTR ^ ":\n" ; 356 357BBTerminatorInst ::= ^ " " ^ 358 ( ret ReturnedVal 359 | ret void 360 | br label ValueRef 361 | br INTTYPE ValueRef ^ "," label ValueRef ^ "," label ValueRef 362 | switch IntType ValueRef ^ "," label ValueRef "[" JumpTable "]" 363 | switch IntType ValueRef ^ "," label ValueRef "[" ^ "]" 364 | invoke OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")" 365 OptFuncAttrs 366 to label ValueRef unwind label ValueRef 367 | unwind 368 | unreachable ) ^ "\n"; 369 370JumpTable ::= JumpTable IntType ConstValueRef ^ "," label ValueRef 371 | IntType ConstValueRef ^ "," label ValueRef ; 372 373Inst ::= ^ " " ^ OptLocalAssign InstVal ^ "\n"; 374 375PHIList ::= Types "[" ValueRef ^ "," ValueRef "]" 376 | PHIList ^ "," "[" ValueRef ^ "," ValueRef "]" ; 377 378ParamList ::= Types OptParamAttrs ValueRef OptParamAttrs 379 | label OptParamAttrs ValueRef OptParamAttrs 380 | ParamList ^ "," Types OptParamAttrs ValueRef OptParamAttrs 381 | ParamList ^ "," label OptParamAttrs ValueRef OptParamAttrs 382 | - _ ; 383 384IndexList ::= _ | IndexList ^ "," ResolvedVal ; 385 386ConstantIndexList ::= "," EUINT64VAL | ConstantIndexList ^ "," EUINT64VAL ; 387 388OptTailCall ::= tail call | call ; 389 390InstVal ::= 391 ArithmeticOps Types ValueRef ^ "," ValueRef 392 | LogicalOps Types ValueRef ^ "," ValueRef 393 | icmp IPredicates Types ValueRef ^ "," ValueRef 394 | fcmp FPredicates Types ValueRef ^ "," ValueRef 395 | CastOps ResolvedVal to Types 396 | select ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal 397 | "va_arg" ResolvedVal ^ "," Types 398 | extractelement ResolvedVal ^ "," ResolvedVal 399 | insertelement ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal 400 | shufflevector ResolvedVal ^ "," ResolvedVal ^ "," ResolvedVal 401 | phi PHIList 402 | OptTailCall OptCallingConv ResultTypes ValueRef ^ "(" ^ ParamList ^ ")" 403 OptFuncAttrs 404 | MemoryInst ; 405 406OptVolatile ::= - volatile | _ ; 407OptExact ::= - exact | _ ; 408OptNSW ::= - nsw | _ ; 409OptNUW ::= - nuw | _ ; 410OptNW ::= OptNUW OptNSW | OptNSW OptNUW ; 411OptInBounds ::= - inbounds | _ ; 412 413MemoryInst ::= malloc Types OptCAlign 414 | malloc Types ^ "," INTTYPE ValueRef OptCAlign 415 | alloca Types OptCAlign 416 | alloca Types ^ "," INTTYPE ValueRef OptCAlign 417 | free ResolvedVal 418 | OptVolatile load Types ValueRef OptCAlign 419 | OptVolatile store ResolvedVal ^ "," Types ValueRef OptCAlign 420 | getresult Types ValueRef ^ "," EUINT64VAL 421 | getelementptr OptInBounds Types ValueRef IndexList 422 | extractvalue Types ValueRef ^ ConstantIndexList 423 | insertvalue Types ValueRef ^ "," Types ValueRef ^ ConstantIndexList ; 424