Script checking that the observed function order matches an orderfile.

tools/cygprofile/check_orderfile.py

+#!/usr/bin/python
+# Copyright 2015 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.
+
+"""Check that symbols are ordered into a binary as they appear in the orderfile.
+"""
+
+import logging
+import sys
+
+import patch_orderfile
+import symbol_extractor
+
+
+_MAX_WARNINGS_TO_PRINT = 200
+
+
+def _CountMisorderedSymbols(symbols, symbol_infos):
+  """Count the number of misordered symbols, and log them.
+
+  Args:
+    symbols: ordered sequence of symbols from the orderfile
+    symbol_infos: ordered list of SymbolInfo from the binary
+
+  Returns:
+    (misordered_pairs_count, matched_symbols_count, unmatched_symbols_count)
+  """
+  name_to_symbol_info = symbol_extractor.CreateNameToSymbolInfo(symbol_infos)
+  matched_symbol_infos = []
+  missing_count = 0
+  misordered_count = 0
+
+  # Find the SymbolInfo matching the orderfile symbols in the binary.
+  for symbol in symbols:
+    if symbol in name_to_symbol_info:
+      matched_symbol_infos.append(name_to_symbol_info[symbol])
+    else:
+      missing_count += 1
+      if missing_count < _MAX_WARNINGS_TO_PRINT:
+        logging.warning('Symbol "%s" is in the orderfile, not in the binary' %
+                        symbol)
+  logging.info('%d matched symbols, %d un-matched (Only the first %d unmatched'
+               ' symbols are shown)' % (
+                   len(matched_symbol_infos), missing_count,
+                   _MAX_WARNINGS_TO_PRINT))
+
+  # In the order of the orderfile, find all the symbols that are at an offset
+  # smaller than their immediate predecessor, and record the pair.
+  previous_symbol_info = symbol_extractor.SymbolInfo(
+      name='', offset=-1, size=0, section='')
+  for symbol_info in matched_symbol_infos:
+    if symbol_info.offset < previous_symbol_info.offset:
+      logging.warning("Misordered pair: %s - %s" % (
+          str(previous_symbol_info), str(symbol_info)))
+      misordered_count += 1
+    previous_symbol_info = symbol_info
+  return (misordered_count, len(matched_symbol_infos), missing_count)
+
+
+def main():
+  if len(sys.argv) != 4 and len(sys.argv) != 3:
+    logging.error('Usage: check_orderfile.py binary orderfile [threshold]')
+    return 1
+  (binary_filename, orderfile_filename) = sys.argv[1:3]
+  threshold = 0
+  if len(sys.argv) == 4:
+    threshold = int(sys.argv[3])
+
+  symbols = patch_orderfile.GetSymbolsFromOrderfile(orderfile_filename)
+  symbol_infos = symbol_extractor.SymbolInfosFromBinary(binary_filename)
+  # Missing symbols is not an error since some of them can be eliminated through
+  # inlining.
+  (misordered_pairs_count, _, _) = _CountMisorderedSymbols(
+      symbols, symbol_infos)
+  return misordered_pairs_count > threshold
+
+
+if __name__ == '__main__':
+  logging.basicConfig(level=logging.INFO)
+  sys.exit(main())