blob: 8d767116c054e5ea664ef4062c56f2605e0d8b45 [file] [log] [blame]
# Copyright (C) 2011 Apple Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
# THE POSSIBILITY OF SUCH DAMAGE.
require "config"
require "ast"
#
# node.resolveSettings(settings)
#
# Construct a new AST that does not have any IfThenElse nodes by
# substituting concrete boolean values for each Setting.
#
class Node
def resolveSettings(settings)
mapChildren {
| child |
child.resolveSettings(settings)
}
end
end
class True
def resolveSettings(settings)
self
end
end
class False
def resolveSettings(settings)
self
end
end
class Setting
def resolveSettings(settings)
settings[@name].asNode
end
end
class And
def resolveSettings(settings)
(@left.resolveSettings(settings).value and @right.resolveSettings(settings).value).asNode
end
end
class Or
def resolveSettings(settings)
(@left.resolveSettings(settings).value or @right.resolveSettings(settings).value).asNode
end
end
class Not
def resolveSettings(settings)
(not @child.resolveSettings(settings).value).asNode
end
end
class IfThenElse
def resolveSettings(settings)
if @predicate.resolveSettings(settings).value
@thenCase.resolveSettings(settings)
else
@elseCase.resolveSettings(settings)
end
end
end
class Sequence
def resolveSettings(settings)
newList = []
@list.each {
| item |
item = item.resolveSettings(settings)
if item.is_a? Sequence
newList += item.list
else
newList << item
end
}
Sequence.new(codeOrigin, newList)
end
end
#
# node.demacroify(macros)
# node.substitute(mapping)
#
# demacroify() constructs a new AST that does not have any Macro
# nodes, while substitute() replaces Variable nodes with the given
# nodes in the mapping.
#
class Node
def demacroify(macros)
mapChildren {
| child |
child.demacroify(macros)
}
end
def freshVariables(mapping)
mapChildren {
| child |
child.freshVariables(mapping)
}
end
def substitute(mapping)
mapChildren {
| child |
child.substitute(mapping)
}
end
def substituteLabels(mapping)
mapChildren {
| child |
child.substituteLabels(mapping)
}
end
end
$uniqueMacroVarID = 0
class Macro
def freshVariables(mapping = {})
myMapping = mapping.dup
newVars = []
variables.each do |var|
$uniqueMacroVarID += 1
newVar = Variable.forName(var.codeOrigin, "_var#{$uniqueMacroVarID}", var.originalName)
newVars << newVar
myMapping[var] = newVar
end
Macro.new(codeOrigin, name, newVars, body.freshVariables(myMapping))
end
def substitute(mapping)
myMapping = {}
mapping.each_pair {
| key, value |
unless @variables.include? key
myMapping[key] = value
end
}
mapChildren {
| child |
child.substitute(myMapping)
}
end
end
class MacroCall
def freshVariables(mapping)
newName = Variable.forName(codeOrigin, name, originalName)
if mapping[newName]
newName = mapping[newName]
end
newOperands = operands.map { |operand| operand.freshVariables(mapping) }
MacroCall.new(codeOrigin, newName.name, newOperands, annotation, originalName)
end
end
$concatenation = /%([a-zA-Z0-9_]+)%/
class Variable
def freshVariables(mapping)
if @name =~ $concatenation
name = @name.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
"%#{mapping[var].name}%"
else
match
end
}
Variable.forName(codeOrigin, name)
elsif mapping[self]
mapping[self]
else
self
end
end
def substitute(mapping)
if @name =~ $concatenation
name = @name.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
mapping[var].name
else
match
end
}
Variable.forName(codeOrigin, name)
elsif mapping[self]
mapping[self]
else
self
end
end
end
class StructOffset
def freshVariables(mapping)
if dump =~ $concatenation
names = dump.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
"%#{mapping[var].name}%"
else
match
end
}.split('::')
StructOffset.forField(codeOrigin, names[0..-2].join('::'), names[-1])
else
self
end
end
def substitute(mapping)
if dump =~ $concatenation
names = dump.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
mapping[var].name
else
match
end
}.split('::')
StructOffset.forField(codeOrigin, names[0..-2].join('::'), names[-1])
else
self
end
end
end
class Label
def freshVariables(mapping)
if @name =~ $concatenation
name = @name.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
"%#{mapping[var].name}%"
else
match
end
}
result = Label.forName(codeOrigin, name, @definedInFile)
result.setGlobal() if global?
result.clearExtern unless extern?
result
else
self
end
end
def substitute(mapping)
if @name =~ $concatenation
name = @name.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
mapping[var].name
else
match
end
}
result = Label.forName(codeOrigin, name, @definedInFile)
result.setGlobal() if global?
result.clearExtern unless extern?
result
else
self
end
end
end
class ConstExpr
def freshVariables(mapping)
if @value =~ $concatenation
value = @value.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
"%#{mapping[var].name}%"
else
match
end
}
ConstExpr.forName(codeOrigin, value)
else
self
end
end
def substitute(mapping)
if @value =~ $concatenation
value = @value.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
mapping[var].name
else
match
end
}
ConstExpr.forName(codeOrigin, value)
else
self
end
end
end
class Sizeof
def freshVariables(mapping)
if struct =~ $concatenation
value = struct.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
"%#{mapping[var].name}%"
else
match
end
}
Sizeof.forName(codeOrigin, value)
else
self
end
end
def substitute(mapping)
if struct =~ $concatenation
value = struct.gsub($concatenation) { |match|
var = Variable.forName(codeOrigin, match[1...-1])
if mapping[var]
mapping[var].name
else
match
end
}
Sizeof.forName(codeOrigin, value)
else
self
end
end
end
class LocalLabel
def substituteLabels(mapping)
if mapping[self]
mapping[self]
else
self
end
end
end
class MacroError < StandardError
end
class Sequence
def substitute(constants)
newList = []
myConstants = constants.dup
@list.each {
| item |
if item.is_a? ConstDecl
myConstants[item.variable] = item.value.substitute(myConstants)
else
newList << item.substitute(myConstants)
end
}
Sequence.new(codeOrigin, newList)
end
def renameLabels(comment)
mapping = {}
@list.each {
| item |
if item.is_a? LocalLabel
mapping[item] = LocalLabel.unique(if comment then comment + "_" else "" end + item.cleanName)
end
}
substituteLabels(mapping)
end
@@demacroifyStack = []
def macroError(msg)
backtrace = @@demacroifyStack.reverse.map { |macroCall|
"#{macroCall.codeOrigin} in call to #{macroCall.originalName}"
}
raise MacroError, msg, backtrace
end
def demacroify(macros)
myMacros = macros.dup
# We do an initial pass looking for all macros in order to allow forward references
@list.each {
| item |
if item.is_a? Macro
myMacros[item.name] = item.freshVariables
end
}
newList = []
@list.each {
| item |
if item.is_a? Macro
# Ignore. We already looked for macros above and they should not be part of the final output
elsif item.is_a? MacroCall
@@demacroifyStack << item
mapping = {}
myMyMacros = myMacros.dup
macro = myMacros[item.name]
macroError "Could not find macro #{item.originalName}" unless macro
macroError "Argument count mismatch for call to #{item.originalName} (expected #{macro.variables.size} but got #{item.operands.size} arguments for macro #{item.originalName} defined at #{macro.codeOrigin})" unless item.operands.size == macro.variables.size
item.operands.size.times {
| idx |
if item.operands[idx].is_a? Variable and myMacros[item.operands[idx].name]
myMyMacros[macro.variables[idx].name] = myMacros[item.operands[idx].name]
mapping[macro.variables[idx]] = nil
elsif item.operands[idx].is_a? Macro
myMyMacros[macro.variables[idx].name] = item.operands[idx].freshVariables
mapping[macro.variables[idx]] = nil
else
myMyMacros[macro.variables[idx]] = nil
mapping[macro.variables[idx]] = item.operands[idx]
end
}
if item.annotation
newList << Instruction.new(item.codeOrigin, "localAnnotation", [], item.annotation)
end
newList += macro.body.substitute(mapping).demacroify(myMyMacros).renameLabels(item.originalName).list
@@demacroifyStack.pop
else
newList << item.demacroify(myMacros)
end
}
Sequence.new(codeOrigin, newList).substitute({})
end
end
#
# node.resolveOffsets(offsets, sizes)
#
# Construct a new AST that has offset values instead of symbolic
# offsets.
#
class Node
def resolveOffsets(constantsMap)
mapChildren {
| child |
child.resolveOffsets(constantsMap)
}
end
end
class StructOffset
def resolveOffsets(constantsMap)
if constantsMap[self]
Immediate.new(codeOrigin, constantsMap[self])
else
puts "Could not find #{self.inspect} in #{constantsMap.keys.inspect}"
puts "sizes = #{constantsMap.inspect}"
raise
end
end
end
class Sizeof
def resolveOffsets(constantsMap)
if constantsMap[self]
Immediate.new(codeOrigin, constantsMap[self])
else
puts "Could not find #{self.inspect} in #{constantsMap.keys.inspect}"
puts "sizes = #{constantsMap.inspect}"
raise
end
end
end
class ConstExpr
def resolveOffsets(constantsMap)
if constantsMap[self]
Immediate.new(codeOrigin, constantsMap[self])
else
puts "Could not find #{self.inspect} in #{constantsMap.keys.inspect}"
puts "sizes = #{constantsMap.inspect}"
raise
end
end
end
#
# node.fold
#
# Resolve constant references and compute arithmetic expressions.
#
class Node
def fold
mapChildren {
| child |
child.fold
}
end
end
class AddImmediates
def fold
@left = @left.fold
@right = @right.fold
return right.plusOffset(@left.value) if @left.is_a? Immediate and @right.is_a? LabelReference
return left.plusOffset(@right.value) if @left.is_a? LabelReference and @right.is_a? Immediate
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value + @right.value)
end
end
class SubImmediates
def fold
@left = @left.fold
@right = @right.fold
return left.plusOffset(-@right.value) if @left.is_a? LabelReference and @right.is_a? Immediate
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value - @right.value)
end
end
class MulImmediates
def fold
@left = @left.fold
@right = @right.fold
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value * @right.value)
end
end
class NegImmediate
def fold
@child = @child.fold
return self unless @child.is_a? Immediate
Immediate.new(codeOrigin, -@child.value)
end
end
class OrImmediates
def fold
@left = @left.fold
@right = @right.fold
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value | @right.value)
end
end
class AndImmediates
def fold
@left = @left.fold
@right = @right.fold
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value & @right.value)
end
end
class XorImmediates
def fold
@left = @left.fold
@right = @right.fold
return self unless @left.is_a? Immediate
return self unless @right.is_a? Immediate
Immediate.new(codeOrigin, @left.value ^ @right.value)
end
end
class BitnotImmediate
def fold
@child = @child.fold
return self unless @child.is_a? Immediate
Immediate.new(codeOrigin, ~@child.value)
end
end
#
# node.resolveAfterSettings(offsets, sizes)
#
# Compile assembly against a set of offsets.
#
class Node
def resolve(constantsMap)
demacroify({}).resolveOffsets(constantsMap).fold
end
end
#
# node.validate
#
# Checks that the node is ready for backend compilation.
#
class Node
def validate
raise "Unresolved #{dump} at #{codeOriginString}"
end
def validateChildren
children.each {
| node |
node.validate
}
end
end
class Sequence
def validate
validateChildren
# Further verify that this list contains only instructions, labels, and skips.
@list.each {
| node |
unless node.is_a? Instruction or
node.is_a? Label or
node.is_a? LocalLabel or
node.is_a? Skip
raise "Unexpected #{node.inspect} at #{node.codeOrigin}"
end
}
end
end
class Immediate
def validate
end
end
class StringLiteral
def validate
end
end
class RegisterID
def validate
end
end
class FPRegisterID
def validate
end
end
class Address
def validate
validateChildren
end
end
class BaseIndex
def validate
validateChildren
end
end
class AbsoluteAddress
def validate
validateChildren
end
end
class Instruction
def validate
validateChildren
end
end
class SubImmediates
def validate
raise "Invalid operand #{left.dump} to immediate subtraction" unless left.immediateOperand?
raise "Invalid operand #{right.dump} to immediate subtraction" unless right.immediateOperand?
end
end
class Error
def validate
end
end
class Label
def validate
raise "Unresolved substitution in Label #{name} at #{codeOrigin}" if name =~ /%/
end
end
class LocalLabel
def validate
end
end
class LabelReference
def validate
end
end
class LocalLabelReference
def validate
end
end
class Skip
def validate
end
end