Ignore:
Timestamp:
Mar 10, 2022, 6:35:06 PM (3 years ago)
Author:
Elliott Williams
Message:

[XCBuild] Emit a discovered dependency file from offlineasm
​https://bugs.webkit.org/show_bug.cgi?id=237329

Reviewed by Alexey Proskuryakov.

Xcode needs to know what files offlineasm uses and produces in order to schedule it
correctly in incremental builds. Rather than use generated xcfilelists like WebKit does
elsewhere in the project, emit a depfile from offlineasm based on the parse tree's source
files.

Discovered dependency files ("depfiles") are Makefile-formatted files which list the inputs
used to produce an output. They are emitting during the build to a temporary directory, and
ensure that subsequent incremental builds will re-run offlineasm when any of the included
sources change. This is the same mechanism clang uses to track header dependencies.

Unfortunately, the legacy build system will refuse to execute a script phase or rule that
emits a depfile. To work around this, convert the offlineasm pipeline to be based on build
rules, to be used by XCBuild only. The idea is that LowLevelInterpreter.asm is listed as a
source build file in JSCLLIntSettingsExtractor, JSCLLIntOffsetsExtractor, and
JavaScriptCore. Each target uses a build rule to generate its respective header from
LowLevelInterpreter.asm. Xcode schedules these rule executions before any clang tasks.

The legacy build system avoids executing the rules via EXCLUDED_SOURCE_FILE_NAMES, and
instead uses the existing build phases, which have "(Legacy)" in their names and are now
no-ops under XCBuild.

Aside from working around the legacy build system's limitations, using build rules is
probably a superior way to express what we're doing, as it gives Xcode the opportunity to
compile other objects in parallel, and could be easily extended to compile multiple discrete
asm files should the need arise.

  • Configurations/ToolExecutable.xcconfig: Build rules are XCBuild-only.
  • JavaScriptCore.xcodeproj/project.pbxproj: Add build rules, rename legacy scripts.
  • offlineasm/asm.rb: Add --depfile flag.
  • offlineasm/generate_offset_extractor.rb: Add --depfile flag.
  • offlineasm/generate_settings_extractor.rb: Add --depfile flag.
Location:
trunk/Source/JavaScriptCore/offlineasm
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/JavaScriptCore/offlineasm/asm.rb

    r290990 r291142  
    3434require "self_hash"
    3535require "settings"
     36require "shellwords"
    3637require "transform"
    3738
    … …  
    348349$options = {}
    349350OptionParser.new do |opts|
    350     opts.banner = "Usage: asm.rb asmFile offsetsFile outputFileName [--assembler=<ASM>] [--webkit-additions-path=<path>] [--binary-format=<format>]"
     351    opts.banner = "Usage: asm.rb asmFile offsetsFile outputFileName [--assembler=<ASM>] [--webkit-additions-path=<path>] [--binary-format=<format>] [--depfile=<depfile>]"
    351352    # This option is currently only used to specify the masm assembler
    352353    opts.on("--assembler=[ASM]", "Specify an assembler to use.") do |assembler|
    … …  
    358359    opts.on("--binary-format=FORMAT", "Specify the binary format used by the target system.") do |format|
    359360        $options[:binary_format] = format
     361    end
     362    opts.on("--depfile=DEPFILE", "Path to write Makefile-style discovered dependencies to.") do |path|
     363        $options[:depfile] = path
    360364    end
    361365end.parse!
    … …  
    385389    " " + Digest::SHA1.hexdigest($options.has_key?(:assembler) ? $options[:assembler] : "")
    386390
    387 if FileTest.exist? outputFlnm
     391if FileTest.exist?(outputFlnm) and (not $options[:depfile] or FileTest.exist?($options[:depfile]))
    388392    lastLine = nil
    389393    File.open(outputFlnm, "r") {
    … …  
    408412
    409413    $asm = Assembler.new($output)
    410    
    411     ast = parse(asmFile, $options)
     414
     415    sources = Set.new
     416    ast = parse(asmFile, $options, sources)
    412417    settingsCombinations = computeSettingsCombinations(ast)
     418   
     419    if $options[:depfile]
     420        depfile = File.open($options[:depfile], "w")
     421        depfile.print(Shellwords.escape(outputFlnm), ": ")
     422        depfile.puts(Shellwords.join(sources.sort))
     423    end
    413424
    414425    configurationList.each {

  • trunk/Source/JavaScriptCore/offlineasm/generate_offset_extractor.rb

    r290990 r291142  
    3434require "self_hash"
    3535require "settings"
     36require "shellwords"
    3637require "transform"
    3738
    … …  
    4950$options = {}
    5051OptionParser.new do |opts|
    51     opts.banner = "Usage: generate_offset_extractor.rb asmFile settingFile outputFileName backends variants [--webkit-additions-path=<path>]"
     52    opts.banner = "Usage: generate_offset_extractor.rb asmFile settingFile outputFileName backends variants [--webkit-additions-path=<path>] [--depfile=<depfile>]"
    5253    opts.on("--webkit-additions-path=PATH", "WebKitAdditions path.") do |path|
    5354        $options[:webkit_additions_path] = path
     55    end
     56    opts.on("--depfile=DEPFILE", "path to write Makefile-style discovered dependencies to.") do |path|
     57        $options[:depfile] = path
    5458    end
    5559end.parse!
    … …  
    7276inputHash = "// OffsetExtractor input hash: #{parseHash(inputFlnm, $options)} #{configurationHash} #{selfHash}"
    7377
    74 if FileTest.exist? outputFlnm
     78if FileTest.exist?(outputFlnm) and (not $options[:depfile] or FileTest.exist?($options[:depfile]))
    7579    File.open(outputFlnm, "r") {
    7680        | inp |
    … …  
    8387end
    8488
    85 ast = parse(inputFlnm, $options)
     89sources = Set.new
     90ast = parse(inputFlnm, $options, sources)
    8691settingsCombinations = computeSettingsCombinations(ast)
     92
     93if $options[:depfile]
     94    depfile = File.open($options[:depfile], "w")
     95    depfile.print(Shellwords.escape(outputFlnm), ": ")
     96    depfile.puts(Shellwords.join(sources.sort))
     97end
    8798
    8899File.open(outputFlnm, "w") {

  • trunk/Source/JavaScriptCore/offlineasm/generate_settings_extractor.rb

    r290990 r291142  
    3434require "self_hash"
    3535require "settings"
     36require "shellwords"
    3637require "transform"
    3738
    … …  
    4647$options = {}
    4748OptionParser.new do |opts|
    48     opts.banner = "Usage: generate_settings_extractor.rb asmFile settingFile [--webkit-additions-path=<path>]"
     49    opts.banner = "Usage: generate_settings_extractor.rb asmFile settingFile [--webkit-additions-path=<path>] [--depfile=<depfile>]"
    4950    opts.on("--webkit-additions-path=PATH", "WebKitAdditions path.") do |path|
    5051        $options[:webkit_additions_path] = path
     52    end
     53    opts.on("--depfile=DEPFILE", "path to write Makefile-style discovered dependencies to.") do |path|
     54        $options[:depfile] = path
    5155    end
    5256end.parse!
    … …  
    5458inputHash = "// SettingsExtractor input hash: #{parseHash(inputFlnm, $options)} #{selfHash}"
    5559
    56 if FileTest.exist? outputFlnm
     60if FileTest.exist?(outputFlnm) and (not $options[:depfile] or FileTest.exist?($options[:depfile]))
    5761    File.open(outputFlnm, "r") {
    5862        | inp |
    … …  
    6569end
    6670
    67 originalAST = parse(inputFlnm, $options)
     71sources = Set.new
     72originalAST = parse(inputFlnm, $options, sources)
    6873prunedAST = Sequence.new(originalAST.codeOrigin, originalAST.filter(Setting))
     74
     75if $options[:depfile]
     76    depfile = File.open($options[:depfile], "w")
     77    depfile.print(Shellwords.escape(outputFlnm), ": ")
     78    depfile.puts(Shellwords.join(sources.sort))
     79end
    6980
    7081File.open(outputFlnm, "w") {

  • trunk/Source/JavaScriptCore/offlineasm/parser.rb

    r290990 r291142  
    261261
    262262class Parser
    263     def initialize(data, fileName, options)
     263    def initialize(data, fileName, options, sources=nil)
    264264        @tokens = lex(data, fileName)
    265265        @idx = 0
    … …  
    269269        @buildProductsDirectory = ENV['BUILT_PRODUCTS_DIR'];
    270270        @options = options
     271        @sources = sources
    271272    end
    272273   
    … …  
    844845                fileExists = File.exists?(fileName)
    845846                raise "File not found: #{fileName}" if not fileExists and not isOptional
    846                 list << parse(fileName, @options) if fileExists
     847                list << parse(fileName, @options, @sources) if fileExists
    847848            else
    848849                parseError "Expecting terminal #{final} #{comment}"
    … …  
    901902end
    902903
    903 def parseData(data, fileName, options)
    904     parser = Parser.new(data, SourceFile.new(fileName), options)
     904def parseData(data, fileName, options, sources)
     905    parser = Parser.new(data, SourceFile.new(fileName), options, sources)
    905906    parser.parseSequence(nil, "")
    906907end
    907908
    908 def parse(fileName, options)
    909     parseData(readTextFile(fileName), fileName, options)
     909def parse(fileName, options, sources=nil)
     910    sources << fileName if sources
     911    parseData(readTextFile(fileName), fileName, options, sources)
    910912end
    911913
Note: See TracChangeset for help on using the changeset viewer.