summaryrefslogtreecommitdiff
path: root/src/scripts
diff options
context:
space:
mode:
authorVictor "Nate" Graf <nategraf1@gmail.com>2017-08-08 11:14:42 -0700
committerGitHub <noreply@github.com>2017-08-08 11:14:42 -0700
commit488d562052e61dde32ff0593835acc2713e9a0d1 (patch)
treea7214b175fcadc9826bfb7bb672d47dbe5205d73 /src/scripts
parentd0e76ed19b8578caf746b3a4faa324c521d6420e (diff)
downloadcoreclr-488d562052e61dde32ff0593835acc2713e9a0d1.tar.gz
coreclr-488d562052e61dde32ff0593835acc2713e9a0d1.tar.bz2
coreclr-488d562052e61dde32ff0593835acc2713e9a0d1.zip
Add build-time check to enforce PGO compilation for applicable DLL files (#13258)
* Added PGO execution verification script Added a script which can help verify whether or not PGO was used to compile PE files passed to it * Added target to enforce PGO compilation * Remove OS checking for enforcepgo
Diffstat (limited to 'src/scripts')
-rw-r--r--src/scripts/pgocheck.py77
1 files changed, 77 insertions, 0 deletions
diff --git a/src/scripts/pgocheck.py b/src/scripts/pgocheck.py
new file mode 100644
index 0000000000..d408e6eaba
--- /dev/null
+++ b/src/scripts/pgocheck.py
@@ -0,0 +1,77 @@
+#!/usr/bin/env python
+#
+## Licensed to the .NET Foundation under one or more agreements.
+## The .NET Foundation licenses this file to you under the MIT license.
+## See the LICENSE file in the project root for more information.
+#
+##
+# Title :pgocheck.py
+#
+# A script to check whether or not a particular portable executable
+# (e.g. EXE, DLL) was compiled using PGO technology
+#
+################################################################################
+
+from glob import glob
+import sys
+import re
+import subprocess
+import argparse
+
+# This pattern matches the line which specifies if PGO, LTCG, or similar techologies were used for compilation
+# coffgrp matches the literal string. It uniquely identifies within the field in question
+# (?:\s+[0-9A-F]+){4} matches 4 hex valued fields without capturing them
+# \((\S*)\) captures the text identifier from the dump output, letting us know the technology
+pgo_pattern_str = r'coffgrp(?:\s+[0-9A-F]+){4}\s+\((\S*)\)'
+pgo_pattern = re.compile(pgo_pattern_str)
+
+def was_compiled_with_pgo(filename):
+ headers = subprocess.check_output(["link", "/dump", "/headers", filename])
+
+ match = pgo_pattern.search(headers)
+
+ result = False
+ tech = "UNKNOWN"
+ if match:
+ result = match.group(1) == 'PGU'
+ tech = match.group(1)
+
+ return result, tech
+
+if __name__ == "__main__":
+ from sys import stdout, stderr
+
+ parser = argparse.ArgumentParser(description="Check if the given PE files were compiled with PGO. Fails if the files were not.")
+ parser.add_argument('files', metavar='file', nargs='+', help="the files to check for PGO flags")
+ parser.add_argument('--negative', action='store_true', help="fail on PGO flags found")
+ parser.add_argument('--quiet', action='store_true', help="don't output; just return a code")
+
+ args = parser.parse_args()
+ # Divide up filenames which are separated by semicolons as well as the ones by spaces. Avoid duplicates
+ filenames = set()
+ for token in args.files:
+ unexpanded_filenames = token.split(';')
+ # Provide support for Unix-style filename expansion (i.e. with * and ?)
+ for unexpanded_filename in unexpanded_filenames:
+ expanded_filenames = glob(unexpanded_filename)
+ if unexpanded_filename and not expanded_filenames:
+ stderr.write("ERROR: Could not find file(s) {0}\n".format(unexpanded_filename))
+ exit(2)
+ filenames.update(expanded_filenames)
+
+ success = True
+ for filename in filenames:
+ result, tech = was_compiled_with_pgo(filename)
+ success = success and result
+
+ if not args.quiet:
+ status = "compiled with PGO" if result else "NOT compiled with PGO"
+ sys.stdout.write("{0}: {1} ({2})\n".format(filename, status, tech))
+
+ if not success:
+ if not args.quiet:
+ if not args.negative:
+ stderr.write("ERROR: The files listed above must be compiled with PGO\n")
+ else:
+ stderr.write("ERROR: The files listed above must NOT be compiled with PGO\n")
+ exit(1) \ No newline at end of file