From 292e898c16d120bdb629e0e7ba743c0aa1b9f1d2 Mon Sep 17 00:00:00 2001
From: Joseph Huber <jhuber6@vols.utk.edu>
Date: Mon, 9 Nov 2020 11:02:30 -0500
Subject: [PATCH] [OpenMP] Begin Adding OpenMP Tool to Gather OpenMP
 Information

Summary:
This patch begins to add support for a set of scripts that can be used to get information from OpenMP programs to better describe problems and eventually show the data to the user in formatted output. Right now the only support is forformatting the register and memory usage reports from ptxas and nvlink. This is simply done as a wrapper around clang and clang++.

Reviewers: jdoerfert

DIfferential Revision: https://reviews.llvm.org/D91085
---
 openmp/tools/analyzer/analyzer.py            | 54 ++++++++++++++++++++++++++++
 openmp/tools/analyzer/llvm-openmp-analyzer   | 45 +++++++++++++++++++++++
 openmp/tools/analyzer/llvm-openmp-analyzer++ |  1 +
 3 files changed, 100 insertions(+)
 create mode 100644 openmp/tools/analyzer/analyzer.py
 create mode 100755 openmp/tools/analyzer/llvm-openmp-analyzer
 create mode 120000 openmp/tools/analyzer/llvm-openmp-analyzer++

diff --git a/openmp/tools/analyzer/analyzer.py b/openmp/tools/analyzer/analyzer.py
new file mode 100644
index 0000000..bcb9abc
--- /dev/null
+++ b/openmp/tools/analyzer/analyzer.py
@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+
+import subprocess
+import os.path
+import yaml
+import io
+import re
+
+def parseKernelUsages(usageStr, usageDict):
+    demangler = 'c++filt -p'
+
+    def getKernelMem(usages):
+        match = re.search(r"([0-9]+) bytes cmem\[0\]", usages)
+        return match.group(1) if match else None
+    def getSharedMem(usages):
+        match = re.search(r"([0-9]+) bytes smem", usages)
+        return match.group(1) if match else None
+    def getRegisters(usages):
+        match = re.search(r"[Uu]sed ([0-9]+) registers", usages)
+        return match.group(1) if match else None
+    def demangle(fn):
+        expr = re.compile("__omp_offloading_[a-zA-Z0-9]*_[a-zA-Z0-9]*_(_Z.*_)_l[0-9]*$")
+        match = expr.search(fn)
+        function = match.group(1) if match else fn
+        output = subprocess.run(demangler.split(' ') + [function], check=True, stdout=subprocess.PIPE)
+        return output.stdout.decode('utf-8').strip()
+    def getLine(fn):
+        expr = re.compile("__omp_offloading_[a-zA-Z0-9]*_[a-zA-Z0-9]*_.*_l([0-9]*)$")
+        match = expr.search(fn)
+        return match.group(1) if match else 0
+
+    expr = re.compile("Function properties for \'?([a-zA-Z0-9_]*)\'?\n(.*,.*)\n")
+    for (fn, usages) in expr.findall(usageStr):
+        info = usageDict[fn] if fn in usageDict else dict()
+        info["Name"] = demangle(fn)
+        info["DebugLoc"] = {"File" : "unknown", "Line": getLine(fn), "Column" : 0}
+        info["Usage"] = {"Registers" : getRegisters(usages), "Shared" : getSharedMem(usages), "Kernel" : getKernelMem(usages)}
+        usageDict[fn] = info
+
+def getKernelUsage(stderr, fname='usage.yaml'):
+    remarks = [line for line in stderr.split('\n') if re.search(r"^remark:", line)]
+    ptxas = '\n'.join([line.split(':')[1].strip() for line in stderr.split('\n') if re.search(r"^ptxas info *:", line)])
+    nvlink = '\n'.join([line.split(':')[1].strip() for line in stderr.split('\n') if re.search(r"^nvlink info *:", line)])
+
+    if os.path.exists(fname):
+        with io.open(fname, 'r', encoding = 'utf-8') as f:
+            usage = yaml.load(f, Loader=yaml.Loader)
+    else:
+        usage = dict()
+
+    parseKernelUsages(ptxas, usage)
+    parseKernelUsages(nvlink, usage)
+
+    return usage
diff --git a/openmp/tools/analyzer/llvm-openmp-analyzer b/openmp/tools/analyzer/llvm-openmp-analyzer
new file mode 100755
index 0000000..259809c
--- /dev/null
+++ b/openmp/tools/analyzer/llvm-openmp-analyzer
@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+
+"""
+A wrapper for Clang specialized for gathering information about OpenMP programs.
+Simple replace calls to clang or clang++ with llvm-openmp-analyzer to run the
+analysis passes.
+"""
+
+import argparse
+import subprocess
+import yaml # PyYaml to save and load analysis information
+import sys
+import io
+
+from analyzer import getKernelUsage
+
+desc = '''A wrapper around clang that runs OpenMP Analysis passes and gathers
+information about OpenMP programs.'''
+
+default_args = ["-fopenmp", "-Rpass=openmp-opt", "-Rpass-missed=openmp-opt", "-Rpass-analysis=openmp-opt"]
+
+def main():
+    compiler = ["clang++"] if sys.argv[0].endswith('++') else ["clang"]
+    parser = argparse.ArgumentParser(description=desc)
+    parser.add_argument('--usage-report-file',
+            metavar='filename',
+            default='usage.yaml',
+            help='Filename used for the OpenMP kernel usage reports in YAML format. "usage.yaml" by default.')
+    parser.add_argument('--no-usage-report', 
+            action='store_true',
+            default=False, 
+            help='Do not general a usage report for the OpenMP kernels.')
+    args, clang_args = parser.parse_known_args()
+
+    subprocess.run(compiler + default_args + clang_args, check=True)
+    output = subprocess.run(compiler + default_args + clang_args + ["-v"], stderr=subprocess.PIPE)
+    stderr = output.stderr.decode('utf-8')
+
+    if not args.no_usage_report:
+        usage = getKernelUsage(stderr, fname=args.usage_report_file)
+        with io.open(args.usage_report_file, 'w', encoding = 'utf-8') as f:
+            yaml.dump(usage, f)
+
+if __name__ == '__main__':
+    main()
diff --git a/openmp/tools/analyzer/llvm-openmp-analyzer++ b/openmp/tools/analyzer/llvm-openmp-analyzer++
new file mode 120000
index 0000000..b45062a
--- /dev/null
+++ b/openmp/tools/analyzer/llvm-openmp-analyzer++
@@ -0,0 +1 @@
+llvm-openmp-analyzer
\ No newline at end of file
-- 
2.7.4