Make isolate_driver.py process build.ninja and extract dependencies.

tools/isolate_driver.py

 #!/usr/bin/env python
 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Adaptor script called through build/isolate.gypi.
 
 Creates a wrapping .isolate which 'includes' the original one, that can be
 consumed by tools/swarming_client/isolate.py. Path variables are determined
 based on the current working directory. The relative_cwd in the .isolated file
-is determined based on *the .isolate file that declare the 'command' variable to
-be used* so the wrapping .isolate doesn't affect this value.
+is determined based on the .isolate file that declare the 'command' variable to
+be used so the wrapping .isolate doesn't affect this value.
 
-It packages all the dynamic libraries found in this wrapping .isolate. This is
-inefficient and non-deterministic. In the very near future, it will parse
-build.ninja, find back the root target and find all the dynamic libraries that
-are marked as a dependency to this target.
+This script loads build.ninja and processes it to determine all the executables
+referenced by the isolated target. It adds them in the wrapping .isolate file.
 """
 
+import StringIO
 import glob
+import logging
 import os
 import posixpath
 import subprocess
 import sys
 import time
 
 TOOLS_DIR = os.path.dirname(os.path.abspath(__file__))
 SWARMING_CLIENT_DIR = os.path.join(TOOLS_DIR, 'swarming_client')
 SRC_DIR = os.path.dirname(TOOLS_DIR)
 
 sys.path.insert(0, SWARMING_CLIENT_DIR)
 
 import isolate_format
 
 
+def load_ninja_recursively(build_dir, ninja_path, build_steps):
+  """Crudely extracts all the subninja and build referenced in ninja_path.
 
-# Location to grab binaries based on the OS.
-DYNAMIC_LIBRARIES = {
-  'darwin': '*.dylib',
-  'linux2': 'lib/*.so',
-  'win32': '*.dll',
-}
+  In particular, it ignores rule and variable declarations. The goal is to be
+  performant (well, as much as python can be performant) which is currently in
+  the <200ms range for a complete chromium tree. As such the code is layed out

[csharp, 2014/04/08 18:05:37]

layed->laid

[M-A Ruel, 2014/04/08 18:51:25]

Done.

+  for performance instead of readability.
+  """
+  try:
+    with open(os.path.join(build_dir, ninja_path), 'rb') as f:
+      line = None
+      merge_line = ''
+      subninja = []
+      for line in f:
+        line = line.rstrip()
+        if not line:
+          continue
+
+        if line[-1:] == '$':

[csharp, 2014/04/08 18:05:37]

drop :? (since line[-1:] == line[-1], right?)

[M-A Ruel, 2014/04/08 18:51:25]

Done. While editing I hadn't done line 51-52 so this was throwing but it's fine
now.

+          # The next line needs to be merged in.
+          merge_line += line[:-1]
+          continue
+
+        if merge_line:
+          line = merge_line + line
+          merge_line = ''
+
+        statement = line[:line.find(' ')]
+        if statement == 'build':
+          # Save the dependency list as a raw string. Only the lines needed will

[csharp, 2014/04/08 18:05:37]

What do you mean" only the lines needed will be processes"? Where is the logic
that determines that?

[M-A Ruel, 2014/04/08 18:51:25]

Changed to:
Save the dependency list as a raw string. Only the lines needed will
be processed with raw_build_to_deps().

+          # be processed. This saves a good 70ms of processing time.
+          build_target, line = line[6:].split(': ', 1)

[csharp, 2014/04/08 18:05:37]

Can you change this to "build_target, dependencies" here. Line 74 really
confused me because I didn't realize line had changed value within this if
statement

[M-A Ruel, 2014/04/08 18:51:25]

Done.

+          # Interestingly, trying to be smart and only saving the build steps
+          # with the intended extensions ('', '.stamp', '.so') slows down
+          # parsing even if 90% of the build rules can be skipped.
+          # On Windows, a single step may generate two target, so split items
+          # accordingly. It has only been seen for .exe/.exe.pdb combos.
+          for i in build_target.strip().split():
+            build_steps[i] = line
+        elif statement == 'subninja':
+          subninja.append(line[9:])
+  except IOError:
+    print >> sys.stderr, 'Failed to open %s' % ninja_path
+    raise
+
+  for rel_path in subninja:
+    try:
+      # Load each of the files referenced.
+      # TODO(maruel): Skip the files known to not be needed. It's save an aweful

[csharp, 2014/04/08 18:05:37]

"it's save" -> "It saves"

[M-A Ruel, 2014/04/08 18:51:25]

Done.

+      # lot of processing time.
+      load_ninja_recursively(build_dir, rel_path, build_steps)
+    except IOError:
+      print >> sys.stderr, '... as referenced by %s' % ninja_path
+      raise
+  return build_steps
 
 
-def get_dynamic_libs(build_dir):
-  """Finds all the dynamic libs to map.
+def load_ninja(build_dir):
+  """Loads the tree of .ninja files in build_dir."""
+  build_steps = {}
+  load_ninja_recursively(build_dir, 'build.ninja', build_steps)
+  return build_steps
 
-  Returns:
-    list of relative path, e.g. [../out/Debug/lib/libuser_prefs.so].
+
+def using_blacklist(item):
+  """Returns True if an item should be analyzed.
+
+  Ignores many rules that are assumed to not depend on a dynamic library. If
+  the assumption doesn't hold true anymore for a file format, remove it from
+  this list. This is simply an optimization.
   """
-  items = set()
-  root = os.path.join(build_dir, DYNAMIC_LIBRARIES[sys.platform])
-  for i in glob.iglob(root):
-    try:
-      # Will throw on Windows if another process is writing to this file.
-      open(i).close()
-      items.add((i, os.stat(i).st_size))
-    except IOError:
-      continue
+  IGNORED = (
+    '.a', '.cc', '.css', '.h', '.html', '.js', '.json', '.manifest', '.o',
+    '.obj', '.pak', '.png', '.pdb', '.strings', '.txt',
+  )
+  # ninja files use native path format.
+  ext = os.path.splitext(item)[1]
+  if ext in IGNORED:
+    return False
+  # Special case Windows, keep .dll.lib but discard .lib.
+  if item.endswith('.dll.lib'):
+    return True
+  if ext == '.lib':
+    return False
+  return item not in ('', '|', '||')
 
-  # The following sleep value was carefully selected via random guessing. The
-  # goal is to detect files that are being linked by checking their file size
-  # after a small delay.
-  #
-  # This happens as other build targets can be built simultaneously. For
-  # example, base_unittests.isolated is being processed but dynamic libraries
-  # for chrome are currently being linked.
-  #
-  # TODO(maruel): Obviously, this must go away and be replaced with a proper
-  # ninja parser but we need something now. http://crbug.com/333473
-  time.sleep(10)
 
-  for item in sorted(items):
-    file_name, file_size = item
-    try:
-      open(file_name).close()
-      if os.stat(file_name).st_size != file_size:
-        items.remove(item)
-    except IOError:
-      items.remove(item)
-      continue
+def raw_build_to_deps(item):
+  """Converts a raw ninja build statement into the list of interesting
+  dependencies.
+  """
+  # TODO(maruel): Use a whitelist instead? .stamp, .so.TOC, .dylib.TOC,
+  # .dll.lib, .exe and empty.
+  # The first item is the build rule, e.g. 'link', 'cxx', 'phony', etc.
+  return filter(using_blacklist, item.split(' ')[1:])
 
-  return [i[0].replace(os.path.sep, '/') for i in items]
+
+def recurse(target, build_steps):
+  """Recursively returns all the interesting dependencies for root_item."""
+  out = []
+  try:
+    dependencies = raw_build_to_deps(build_steps[target])
+  except KeyError:
+    logging.warning('MIA: %s', target)

[csharp, 2014/04/08 18:05:37]

Why use MIA here, I'm not sure I understand how this could be missing

[M-A Ruel, 2014/04/08 18:51:25]

It used to happen in the code as I was making progress but not anymore so it
should be fine and removed it. Will add back if necessary.

+    return out
+  logging.debug('recurse(%s) -> %s', target, dependencies)
+  for dependency in dependencies:
+    out.append(dependency)
+    dependency_raw_dependencies = build_steps.get(dependency)
+    if dependency_raw_dependencies:
+      for i in raw_build_to_deps(dependency_raw_dependencies):
+        out.extend(recurse(i, build_steps))
+    else:
+      logging.info('MIA: %s', dependency)
+  return out
+
+
+def post_process_deps(dependencies):
+  """Processes the dependency list with OS specific rules."""
+  def filter_item(i):
+    if i.endswith('.so.TOC'):
+      # Remove only the suffix .TOC, not the .so!
+      return i[:-4]
+    if i.endswith('.dylib.TOC'):
+      # Remove only the suffix .TOC, not the .dylib!
+      return i[:-4]
+    if i.endswith('.dll.lib'):
+      # Remove only the suffix .lib, not the .dll!
+      return i[:-4]
+    return i
+
+  return map(filter_item, dependencies)
 
 
 def create_wrapper(args, isolate_index, isolated_index):
   """Creates a wrapper .isolate that add dynamic libs.
 
   The original .isolate is not modified.
   """
   cwd = os.getcwd()
   isolate = args[isolate_index]
   # The code assumes the .isolate file is always specified path-less in cwd. Fix
@@ skipping 10 matching lines @@
 
   # The wrapping .isolate. This will look like
   # ../out/Debug/gen/chrome/unit_tests.isolate.
   temp_isolate = os.path.join(build_dir, 'gen', src_isolate)
   temp_isolate_dir = os.path.dirname(temp_isolate)
 
   # Relative path between the new and old .isolate file.
   isolate_relpath = os.path.relpath(
       '.', temp_isolate_dir).replace(os.path.sep, '/')
 
-  # Will look like ['<(PRODUCT_DIR)/lib/flibuser_prefs.so'].
-  rebased_libs = [
-    '<(PRODUCT_DIR)/%s' % i[len(build_dir)+1:]
-    for i in get_dynamic_libs(build_dir)
-  ]
+  # It's a big assumption here that the name of the isolate file matches the

[csharp, 2014/04/08 18:05:37]

Can we assert this somewhere in the code?

[M-A Ruel, 2014/04/08 18:51:25]

It's really an assumption, there's no way to assert that it's what is going to
be executed.

+  # primary target. Fix accordingly if this doesn't hold true.
+  target = isolate[:-len('.isolate')]
+  build_steps = load_ninja(build_dir)
+  binary_deps = post_process_deps(recurse(target, build_steps))
+  logging.debug(
+      'Binary dependencies:%s', ''.join('\n  ' + i for i in binary_deps))
 
   # Now do actual wrapping .isolate.
-  out = {
+  isolate_dict = {
     'includes': [
       posixpath.join(isolate_relpath, isolate),
     ],
     'variables': {
-      isolate_format.KEY_TRACKED: rebased_libs,
+      # Will look like ['<(PRODUCT_DIR)/lib/flibuser_prefs.so'].
+      isolate_format.KEY_TRACKED: sorted(
+          '<(PRODUCT_DIR)/%s' % i for i in binary_deps),
     },
   }
   if not os.path.isdir(temp_isolate_dir):
     os.makedirs(temp_isolate_dir)
   comment = (
       '# Warning: this file was AUTOGENERATED.\n'
       '# DO NO EDIT.\n')
+  out = StringIO.StringIO()
+  isolate_format.print_all(comment, isolate_dict, out)

[csharp, 2014/04/08 18:05:37]

why don't we write directly to the file anymore?

[M-A Ruel, 2014/04/08 18:51:25]

So it's content can be logged at line 228, which is super useful for debugging.

+  isolate_content = out.getvalue()
   with open(temp_isolate, 'wb') as f:
-    isolate_format.print_all(comment, out, f)
-  if '--verbose' in args:
-    print('Added %d dynamic libs' % len(dynamic_libs))
+    f.write(isolate_content)
+  logging.info('Added %d dynamic libs', len(binary_deps))
+  logging.debug('%s', isolate_content)
   args[isolate_index] = temp_isolate
 
 
 def main():
+  logging.basicConfig(level=logging.ERROR)
   args = sys.argv[1:]
   isolate = None
   isolated = None
   is_component = False
   for i, arg in enumerate(args):
     if arg == '--isolate':
       isolate = i + 1
     if arg == '--isolated':
       isolated = i + 1
     if arg == 'component=shared_library':
       is_component = True
   if isolate is None or isolated is None:
     print >> sys.stderr, 'Internal failure'
     return 1
 
-  # Implement a ninja parser.
-  # http://crbug.com/360223
-  if is_component and False:
+  if is_component:
     create_wrapper(args, isolate, isolated)
 
   swarming_client = os.path.join(SRC_DIR, 'tools', 'swarming_client')
   sys.stdout.flush()
   result = subprocess.call(
       [sys.executable, os.path.join(swarming_client, 'isolate.py')] + args)
   return result
 
 
 if __name__ == '__main__':
   sys.exit(main())