utils/llvm.grm

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