util/fipstools/delocate/delocate.peg - boringssl - Git at Google


            
            # Copyright 2017 The BoringSSL Authors

            
            #

            
            # Licensed under the Apache License, Version 2.0 (the "License");

            
            # you may not use this file except in compliance with the License.

            
            # You may obtain a copy of the License at

            
            #

            
            #     https://www.apache.org/licenses/LICENSE-2.0

            
            #

            
            # Unless required by applicable law or agreed to in writing, software

            
            # distributed under the License is distributed on an "AS IS" BASIS,

            
            # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

            
            # See the License for the specific language governing permissions and

            
            # limitations under the License.


            # This is a rough parser for x86-64 and aarch64 assembly designed to work with

            
            # https://github.com/pointlander/peg. delocate.go has a go:generate line for

            
            # rebuilding delocate.peg.go from this file.


            # To regenerate delocate.peg.go:

            
            #

            
            # go install github.com/pointlander/peg@latest

            
            # ~/go/bin/peg <path-to-this-file>

            
            #

            
            # this will generate delocate.peg.go next to delocate.peg.


            package main


            type Asm Peg {}


            AsmFile <- Statement* !.

            
            Statement <- WS? (Label / ((GlobalDirective /

            
                                        LocationDirective /

            
                                        SymbolDefiningDirective /

            
                                        LabelContainingDirective /

            
                                        PrefAlignDirective /

            
                                        Instruction /

            
                                        Directive /

            
                                        Comment / ) WS? ((Comment? '\n') / ';')))

            
            GlobalDirective <- (".global" / ".globl") WS SymbolName

            
            Directive <- '.' DirectiveName (WS Args)?

            
            DirectiveName <- [[A-Z0-9_]]+

            
            LocationDirective <- FileDirective / LocDirective

            
            FileDirective <- ".file" WS [^#\n]+

            
            LocDirective <- ".loc" WS [^#/\n]+

            
            Args <- Arg ((WS? ',' WS?) Arg)*

            
            Arg <- QuotedArg / [[0-9a-z%+\-*_@.$]]*

            
            QuotedArg <- '"' QuotedText '"'

            
            QuotedText <- (EscapedChar / [^"])*

            
            SymbolDefiningDirective <- (SymbolDefiningDirectiveName WS (LocalSymbol / SymbolName) WS? ',' WS? SymbolArg /

            
                                        (LocalSymbol / SymbolName) WS? '=' WS? SymbolArg)

            
            SymbolDefiningDirectiveName <- ".equiv" / ".equ" / ".set"

            
            LabelContainingDirective <- LabelContainingDirectiveName WS SymbolArgs

            
            LabelContainingDirectiveName <- ".xword" / ".word" / ".hword" / ".long" / ".byte" / ".8byte" / ".4byte" / ".quad" / ".tc" / ".localentry" / ".size" / ".type" / ".uleb128" / ".sleb128"

            
            # Prior to https://github.com/llvm/llvm-project/commit/193d7a6ace9f7016e03c90c63626fdb7fdf99bc0,

            
            # .prefalign took a single integer. Afterwards, it took three parameters with a

            
            # symbol as the second argument. Parse both forms.

            
            PrefAlignDirective <- ".prefalign" WS Arg (WS? ',' WS? SymbolArg WS? ',' WS? Arg)?

            
            SymbolArgs <- SymbolArg ((WS? ',' WS?) SymbolArg)*


            SymbolArg <- SymbolExpr

            
            SymbolExpr <- SymbolAtom (WS? SymbolOperator WS? SymbolExpr)?

            
            SymbolAtom <- LocalLabelRef / Offset / SymbolType / LocalSymbol TCMarker? / SymbolName Offset / SymbolName TCMarker? / Dot / OpenParen WS? SymbolExpr WS? CloseParen

            
            SymbolOperator <- '+' / '-' / '|' / '<<' / '>>'

            
            OpenParen <- '('

            
            CloseParen <- ')'


            SymbolType <- [@%] ('function' / 'object')

            
            Dot <- '.'

            
            TCMarker <- '[TC]'

            
            EscapedChar <- '\\' .

            
            WS <- [ \t]+

            
            Comment <- ("//" / '#') [^\n]*

            
            Label <- (LocalSymbol / LocalLabel / SymbolName) ':'

            
            SymbolName <- [[A-Z._]][[A-Z.0-9$_]]*

            
            LocalSymbol <- '.L' [[A-Za-z.0-9$_]]+

            
            LocalLabel <- [0-9][0-9$]*

            
            LocalLabelRef <- [0-9][0-9$]*[bf]

            
            InstructionPrefix <- "notrack"

            
            Instruction <- (InstructionPrefix WS)? InstructionName (WS InstructionArg ((WS? ',' WS?) InstructionArg)*)?

            
            InstructionName <- [[A-Z]][[A-Z.0-9]]* [.+\-]?

            
            InstructionArg <- IndirectionIndicator? (ARMConstantTweak / RegisterOrConstant / LocalLabelRef / TOCRefHigh / TOCRefLow / GOTLocation / GOTAddress / GOTSymbolOffset / MemoryRef) AVX512Token*

            
            GOTLocation <- '$_GLOBAL_OFFSET_TABLE_-' LocalSymbol

            
            GOTAddress <- '_GLOBAL_OFFSET_TABLE_(%rip)'

            
            GOTSymbolOffset <- ('$' SymbolName '@GOT' 'OFF'?) / (":got:" SymbolName)

            
            AVX512Token <- WS? '{' '%'? [0-9a-z]* '}'

            
            TOCRefHigh <- '.TOC.-' ('0b' / ('.L' [a-zA-Z_0-9]+)) "@ha"

            
            TOCRefLow <- '.TOC.-' ('0b' / ('.L' [a-zA-Z_0-9]+)) "@l"

            
            IndirectionIndicator <- '*'

            
            Float <- [0-9]+ '.' [0-9]*

            
            RegisterOrConstant <- (('%'[[A-Z]][[A-Z0-9]]*) /

            
                                   ('$'? ((Offset Offset) / Offset)) /

            
                                   ('#' Float ) /

            
                                   ('#' Offset ('*' [0-9]+ ('-' [0-9] [0-9]*)?)? ) /

            
                                   ('#' '~'? '(' [0-9] WS? "<<" WS? [0-9] ')' ) /

            
                                   ARMRegister)

            
                                  ![fb:(+\-]

            
            ARMConstantTweak <- ((([us] "xt" [xwhb]) / "lsl" / "lsr" / "ror" / "asr" / "msl") (WS '#' Offset)?) /

            
                                "mul vl"  / # multiply offset by the hardware's vector length

            
                                "mul #" [0-9][0-9]?

            
            ARMRegister <- "sp" /

            
                           ([xwdqshb] [0-9] [0-9]?) /

            
                           "xzr" / "wzr" / "NZCV" / SVE2PredicateRegister / ARMVectorRegister / SVE2SpecialValue /

            
                           ('{' WS? ARMVectorRegister (',' WS? ARMVectorRegister)* WS? '}' ('[' [0-9] [0-9]? ']')? )

            
            ARMVectorRegister <- [pvz] [0-9] [0-9]? ![[0-9a-z_]] ('.' [0-9]* [bsdhq] ('[' [0-9] [0-9]? ']')? )?

            
            SVE2PredicateRegister <- "p" [0-9] [0-9]? "/" [[mz]]

            
            # https://developer.arm.com/documentation/ddi0596/2020-12/SVE-Instructions/INCD--INCH--INCW--vector---Increment-vector-by-multiple-of-predicate-constraint-element-count-

            
            SVE2SpecialValue <- ("pow2" / ("vl" [12345678] ![0-9] ) / "vl16" / "vl32" / "vl64" / "vl128" / "vl256" / "mul3" / "mul4" / "all") ![[0-9a-z_]]

            
            # Compilers only output a very limited number of expression forms. Rather than

            
            # implement a full expression parser, this enumerate those forms plus a few

            
            # that appear in our hand-written assembly.

            
            MemoryRef <- (SymbolRef BaseIndexScale /

            
                          SymbolRef /

            
                          Low12BitsSymbolRef /

            
                          Offset* BaseIndexScale /

            
                          SegmentRegister Offset BaseIndexScale /

            
                          SegmentRegister BaseIndexScale /

            
                          SegmentRegister Offset /

            
                          ARMBaseIndexScale /

            
                          BaseIndexScale)

            
            SymbolRef <- (Offset* '+')? (LocalSymbol / SymbolName) Offset* ('@' Section Offset*)?

            
            Low12BitsSymbolRef <- ":lo12:" (LocalSymbol / SymbolName) Offset?

            
            ARMBaseIndexScale <- '[' ARMRegister (',' WS? (('#' Offset (('*' [0-9]+) / ('*' '(' [0-9]+ Operator [0-9]+ ')') / (('+' [0-9]+)*))? ) / ARMGOTLow12 / Low12BitsSymbolRef / ARMRegister) (',' WS? ARMConstantTweak)?)? ']' ARMPostincrement?

            
            ARMGOTLow12 <- ":got_lo12:" SymbolName

            
            ARMPostincrement <- '!'

            
            BaseIndexScale <- '(' RegisterOrConstant? WS? (',' WS? RegisterOrConstant WS? (',' [0-9]+)? )? ')'

            
            Operator <- [+\-]

            
            Offset <- '+'? '-'? (("0b" [01]+) / ("0x" [[0-9A-F]]+) / [0-9]+)

            
            Section <- [[A-Z@]]+

            
            SegmentRegister <- '%' [c-gs] 's:'
	# Copyright 2017 The BoringSSL Authors
	#
	# Licensed under the Apache License, Version 2.0 (the "License");
	# you may not use this file except in compliance with the License.
	# You may obtain a copy of the License at
	#
	# https://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing, software
	# distributed under the License is distributed on an "AS IS" BASIS,
	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	# See the License for the specific language governing permissions and
	# limitations under the License.

	# This is a rough parser for x86-64 and aarch64 assembly designed to work with
	# https://github.com/pointlander/peg. delocate.go has a go:generate line for
	# rebuilding delocate.peg.go from this file.

	# To regenerate delocate.peg.go:
	#
	# go install github.com/pointlander/peg@latest
	# ~/go/bin/peg <path-to-this-file>
	#
	# this will generate delocate.peg.go next to delocate.peg.

	package main

	type Asm Peg {}

	AsmFile <- Statement* !.
	Statement <- WS? (Label / ((GlobalDirective /
	LocationDirective /
	SymbolDefiningDirective /
	LabelContainingDirective /
	PrefAlignDirective /
	Instruction /
	Directive /
	Comment / ) WS? ((Comment? '\n') / ';')))
	GlobalDirective <- (".global" / ".globl") WS SymbolName
	Directive <- '.' DirectiveName (WS Args)?
	DirectiveName <- [[A-Z0-9_]]+
	LocationDirective <- FileDirective / LocDirective
	FileDirective <- ".file" WS [^#\n]+
	LocDirective <- ".loc" WS [^#/\n]+
	Args <- Arg ((WS? ',' WS?) Arg)*
	Arg <- QuotedArg / [[0-9a-z%+\-_@.$]]
	QuotedArg <- '"' QuotedText '"'
	QuotedText <- (EscapedChar / [^"])*
	SymbolDefiningDirective <- (SymbolDefiningDirectiveName WS (LocalSymbol / SymbolName) WS? ',' WS? SymbolArg /
	(LocalSymbol / SymbolName) WS? '=' WS? SymbolArg)
	SymbolDefiningDirectiveName <- ".equiv" / ".equ" / ".set"
	LabelContainingDirective <- LabelContainingDirectiveName WS SymbolArgs
	LabelContainingDirectiveName <- ".xword" / ".word" / ".hword" / ".long" / ".byte" / ".8byte" / ".4byte" / ".quad" / ".tc" / ".localentry" / ".size" / ".type" / ".uleb128" / ".sleb128"
	# Prior to https://github.com/llvm/llvm-project/commit/193d7a6ace9f7016e03c90c63626fdb7fdf99bc0,
	# .prefalign took a single integer. Afterwards, it took three parameters with a
	# symbol as the second argument. Parse both forms.
	PrefAlignDirective <- ".prefalign" WS Arg (WS? ',' WS? SymbolArg WS? ',' WS? Arg)?
	SymbolArgs <- SymbolArg ((WS? ',' WS?) SymbolArg)*

	SymbolArg <- SymbolExpr
	SymbolExpr <- SymbolAtom (WS? SymbolOperator WS? SymbolExpr)?
	SymbolAtom <- LocalLabelRef / Offset / SymbolType / LocalSymbol TCMarker? / SymbolName Offset / SymbolName TCMarker? / Dot / OpenParen WS? SymbolExpr WS? CloseParen
	SymbolOperator <- '+' / '-' / '\|' / '<<' / '>>'
	OpenParen <- '('
	CloseParen <- ')'

	SymbolType <- [@%] ('function' / 'object')
	Dot <- '.'
	TCMarker <- '[TC]'
	EscapedChar <- '\\' .
	WS <- [ \t]+
	Comment <- ("//" / '#') [^\n]*
	Label <- (LocalSymbol / LocalLabel / SymbolName) ':'
	SymbolName <- [[A-Z._]][[A-Z.0-9$_]]*
	LocalSymbol <- '.L' [[A-Za-z.0-9$_]]+
	LocalLabel <- [0-9][0-9$]*
	LocalLabelRef <- [0-9][0-9$]*[bf]
	InstructionPrefix <- "notrack"
	Instruction <- (InstructionPrefix WS)? InstructionName (WS InstructionArg ((WS? ',' WS?) InstructionArg)*)?
	InstructionName <- [[A-Z]][[A-Z.0-9]]* [.+\-]?
	InstructionArg <- IndirectionIndicator? (ARMConstantTweak / RegisterOrConstant / LocalLabelRef / TOCRefHigh / TOCRefLow / GOTLocation / GOTAddress / GOTSymbolOffset / MemoryRef) AVX512Token*
	GOTLocation <- '$_GLOBAL_OFFSET_TABLE_-' LocalSymbol
	GOTAddress <- '_GLOBAL_OFFSET_TABLE_(%rip)'
	GOTSymbolOffset <- ('$' SymbolName '@GOT' 'OFF'?) / (":got:" SymbolName)
	AVX512Token <- WS? '{' '%'? [0-9a-z]* '}'
	TOCRefHigh <- '.TOC.-' ('0b' / ('.L' [a-zA-Z_0-9]+)) "@ha"
	TOCRefLow <- '.TOC.-' ('0b' / ('.L' [a-zA-Z_0-9]+)) "@l"
	IndirectionIndicator <- '*'
	Float <- [0-9]+ '.' [0-9]*
	RegisterOrConstant <- (('%'[[A-Z]][[A-Z0-9]]*) /
	('$'? ((Offset Offset) / Offset)) /
	('#' Float ) /
	('#' Offset ('' [0-9]+ ('-' [0-9] [0-9])?)? ) /
	('#' '~'? '(' [0-9] WS? "<<" WS? [0-9] ')' ) /
	ARMRegister)
	![fb:(+\-]
	ARMConstantTweak <- ((([us] "xt" [xwhb]) / "lsl" / "lsr" / "ror" / "asr" / "msl") (WS '#' Offset)?) /
	"mul vl" / # multiply offset by the hardware's vector length
	"mul #" [0-9][0-9]?
	ARMRegister <- "sp" /
	([xwdqshb] [0-9] [0-9]?) /
	"xzr" / "wzr" / "NZCV" / SVE2PredicateRegister / ARMVectorRegister / SVE2SpecialValue /
	('{' WS? ARMVectorRegister (',' WS? ARMVectorRegister)* WS? '}' ('[' [0-9] [0-9]? ']')? )
	ARMVectorRegister <- [pvz] [0-9] [0-9]? ![[0-9a-z_]] ('.' [0-9]* [bsdhq] ('[' [0-9] [0-9]? ']')? )?
	SVE2PredicateRegister <- "p" [0-9] [0-9]? "/" [[mz]]
	# https://developer.arm.com/documentation/ddi0596/2020-12/SVE-Instructions/INCD--INCH--INCW--vector---Increment-vector-by-multiple-of-predicate-constraint-element-count-
	SVE2SpecialValue <- ("pow2" / ("vl" [12345678] ![0-9] ) / "vl16" / "vl32" / "vl64" / "vl128" / "vl256" / "mul3" / "mul4" / "all") ![[0-9a-z_]]
	# Compilers only output a very limited number of expression forms. Rather than
	# implement a full expression parser, this enumerate those forms plus a few
	# that appear in our hand-written assembly.
	MemoryRef <- (SymbolRef BaseIndexScale /
	SymbolRef /
	Low12BitsSymbolRef /
	Offset* BaseIndexScale /
	SegmentRegister Offset BaseIndexScale /
	SegmentRegister BaseIndexScale /
	SegmentRegister Offset /
	ARMBaseIndexScale /
	BaseIndexScale)
	SymbolRef <- (Offset* '+')? (LocalSymbol / SymbolName) Offset* ('@' Section Offset*)?
	Low12BitsSymbolRef <- ":lo12:" (LocalSymbol / SymbolName) Offset?
	ARMBaseIndexScale <- '[' ARMRegister (',' WS? (('#' Offset (('' [0-9]+) / ('' '(' [0-9]+ Operator [0-9]+ ')') / (('+' [0-9]+)*))? ) / ARMGOTLow12 / Low12BitsSymbolRef / ARMRegister) (',' WS? ARMConstantTweak)?)? ']' ARMPostincrement?
	ARMGOTLow12 <- ":got_lo12:" SymbolName
	ARMPostincrement <- '!'
	BaseIndexScale <- '(' RegisterOrConstant? WS? (',' WS? RegisterOrConstant WS? (',' [0-9]+)? )? ')'
	Operator <- [+\-]
	Offset <- '+'? '-'? (("0b" [01]+) / ("0x" [[0-9A-F]]+) / [0-9]+)
	Section <- [[A-Z@]]+
	SegmentRegister <- '%' [c-gs] 's:'