offlineasm/generate_offset_extractor.rb

   1 #!/usr/bin/env ruby
   2
   3 # Copyright (C) 2011 Apple Inc. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 # 1. Redistributions of source code must retain the above copyright
   9 #    notice, this list of conditions and the following disclaimer.
  10 # 2. Redistributions in binary form must reproduce the above copyright
  11 #    notice, this list of conditions and the following disclaimer in the
  12 #    documentation and/or other materials provided with the distribution.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  15 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  18 # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  24 # THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 $: << File.dirname(__FILE__)
  27
  28 require "config"
  29 require "backends"
  30 require "digest/sha1"
  31 require "offsets"
  32 require "parser"
  33 require "self_hash"
  34 require "settings"
  35 require "transform"
  36
  37 IncludeFile.processIncludeOptions()
  38
  39 inputFlnm = ARGV.shift
  40 outputFlnm = ARGV.shift
  41
  42 validBackends = ARGV.shift
  43 if validBackends
  44     $stderr.puts "Only dealing with backends: #{validBackends}"
  45     includeOnlyBackends(validBackends.split(","))
  46 end
  47
  48 $stderr.puts "offlineasm: Parsing #{inputFlnm} and creating offset extractor #{outputFlnm}."
  49
  50 def emitMagicNumber
  51     OFFSET_MAGIC_NUMBERS.each {
  52         | number |
  53         $output.puts "unsigned(#{number}),"
  54     }
  55 end
  56
  57 inputHash = "// offlineasm input hash: #{parseHash(inputFlnm)} #{selfHash}"
  58
  59 if FileTest.exist? outputFlnm
  60     File.open(outputFlnm, "r") {
  61         | inp |
  62         firstLine = inp.gets
  63         if firstLine and firstLine.chomp == inputHash
  64             $stderr.puts "offlineasm: Nothing changed."
  65             exit 0
  66         end
  67     }
  68 end
  69
  70 originalAST = parse(inputFlnm)
  71
  72 #
  73 # Optimize the AST to make configuration extraction faster. This reduces the AST to a form
  74 # that only contains the things that matter for our purposes: offsets, sizes, and if
  75 # statements.
  76 #
  77
  78 class Node
  79     def offsetsPruneTo(sequence)
  80         children.each {
  81             | child |
  82             child.offsetsPruneTo(sequence)
  83         }
  84     end
  85
  86     def offsetsPrune
  87         result = Sequence.new(codeOrigin, [])
  88         offsetsPruneTo(result)
  89         result
  90     end
  91 end
  92
  93 class IfThenElse
  94     def offsetsPruneTo(sequence)
  95         ifThenElse = IfThenElse.new(codeOrigin, predicate, thenCase.offsetsPrune)
  96         ifThenElse.elseCase = elseCase.offsetsPrune
  97         sequence.list << ifThenElse
  98     end
  99 end
 100
 101 class StructOffset
 102     def offsetsPruneTo(sequence)
 103         sequence.list << self
 104     end
 105 end
 106
 107 class Sizeof
 108     def offsetsPruneTo(sequence)
 109         sequence.list << self
 110     end
 111 end
 112
 113 prunedAST = originalAST.offsetsPrune
 114
 115 File.open(outputFlnm, "w") {
 116     | outp |
 117     $output = outp
 118     outp.puts inputHash
 119     length = 0
 120     emitCodeInAllConfigurations(prunedAST) {
 121         | settings, ast, backend, index |
 122         offsetsList = ast.filter(StructOffset).uniq.sort
 123         sizesList = ast.filter(Sizeof).uniq.sort
 124         length += OFFSET_HEADER_MAGIC_NUMBERS.size + (OFFSET_MAGIC_NUMBERS.size + 1) * (1 + offsetsList.size + sizesList.size)
 125     }
 126     outp.puts "static const unsigned extractorTable[#{length}] = {"
 127     emitCodeInAllConfigurations(prunedAST) {
 128         | settings, ast, backend, index |
 129         OFFSET_HEADER_MAGIC_NUMBERS.each {
 130             | number |
 131             $output.puts "unsigned(#{number}),"
 132         }
 133
 134         offsetsList = ast.filter(StructOffset).uniq.sort
 135         sizesList = ast.filter(Sizeof).uniq.sort
 136
 137         emitMagicNumber
 138         outp.puts "#{index},"
 139         offsetsList.each {
 140             | offset |
 141             emitMagicNumber
 142             outp.puts "OFFLINE_ASM_OFFSETOF(#{offset.struct}, #{offset.field}),"
 143         }
 144         sizesList.each {
 145             | offset |
 146             emitMagicNumber
 147             outp.puts "sizeof(#{offset.struct}),"
 148         }
 149     }
 150     outp.puts "};"
 151 }
 152
 153 $stderr.puts "offlineasm: offset extractor #{outputFlnm} successfully generated."
 154