[flang][flang-omp-report] Add flang-omp-report summarising script

[josh.mottley.arm]

Summary

The flang plugin `flang-omp-report` takes one fortran file in and returns a
YAML report file of the input file. This becomes an issue when you want to
analyse an entire project into one final report.
The purpose of this Python script is to generate a final YAML
report from all of the files generated by `flang-omp-report`. The report can
have (currently) 2 formats; summary and log. Summary focuses on "summarizing"
all constructs and there clauses from all YAML files with a corresponding "count"
for each. Log instead combines the generated YAML files into one report in a
"cleaner" format. (Pseudo) Examples can be found for both formats at the top of
the script.

Co-Authored by: Ivan Zhechev <[e-mail]>

[josh.mottley.arm]

I will now be taking over this patch from Ivan.

[josh.mottley.arm]

Refactored code.

[awarzynski]

Hey @josh.mottley.arm , thanks for taking over! I like how you have refactoring this and split into functions - makes a lot of sense! Also, great job documenting them!

Currently this script is somewhere between a "Python Script" and a "Python Module". Take a look idiomatic usage for python scripts. Basically, in a script everything should be inside functions. Also, things inside the main block (i.e. if __name__ == "__main__") should be kept to the bare minimum. Could you update accordingly? This shouldn't be too much work.

flang/examples/flang-omp-report-plugin/yaml_summarizer.py

58

When ruamel.yaml is not present, the script will still run all the way down here and fail with:

Traceback (most recent call last):
  File "flang/examples/flang-omp-report-plugin/yaml_summarizer.py", line 58, in <module>
    yaml = YAML()
NameError: name 'YAML' is not defined

220–224

[nit] IMHO, we don't need a function for this.

[josh.mottley.arm]

• Removed try...except check for importing ruamel.yaml. This also includes removing the yaml_module_not_found function.
• Added requirements.txt.
• Refactored code to include functions; main, parse_arguments, create_arg_parser.

[awarzynski]

flang/examples/flang-omp-report-plugin/yaml_summarizer.py

4–5

[nit] Could you add a note explaining why one can't simply use the plugin here?

6

21

IMHO, you can safely remove This option (it is clear that it's an option ;-) ). On the other hand, it would be helpful to emphasis the difference between -l and the default behavior. See my suggestion inline.

42

You don't need the search pattern outside this method. And to me, find_yaml_files should only care about the directory in which to search and whether to do secretively. The search pattern itself that you pass to glob.iglob is just an implementation detail.

But your current approach is correct and this comment is just a nit.

51–55

This an important comment, but provides a solution a bit preemptively. And, by differentiating between the source and build dirs, it's become rather long. Also, I'm concerned that it might be quite hard to find a good solution and perhaps not worth it?

How about this:

# @TODO: Currently *all* yaml files are read - regardless of whether they have been generated with  'flang-omp-report' or not. This might result in the script reading files that it should ignore.

70–81

Wouldn't the output with -l only really differ when at least 2 input files were used?

96

119–136

Was this generated using /../llvm-project/flang/test/Examples/omp-device-constructs.f90? (like for process_log?)

163

[nit] That's clear from the function definition.

[josh.mottley.arm]

• Fixed issues reported from review comments.
• Added type hints where appropriate to arguments of functions.
• Removed the default arguments from functions where it was not neccesary, and added default arguments to parsed arguments.

[josh.mottley.arm]

flang/examples/flang-omp-report-plugin/yaml_summarizer.py

70–81

The only difference when using 1 input file to original yaml file would be that the file path is stated only once at the top, whereas the original yaml file states the file with each construct.

119–136

My bad. It was generated using all the omp tests. Changed example code to just use /../llvm-project/flang/test/Examples/omp-device-constructs.yaml now since its a bit more interesting as an example. Also made both "process" functions use the same ".yaml" file for the example, so you can see the clear difference between the two methods.

[awarzynski]

flang/examples/flang-omp-report-plugin/yaml_summarizer.py

34

70–81

It looks like -l will change the output in two cases:

• when only one file is read, the filename will only appear once at the top (as opposed to multiple times within the file)
• when multiple files are read, then the filename for each file is only printed once before the input for the corresponding file is dumped

Is this correct? Could you document it? Perhaps that's something that should appear in the module doc-string rather than here?

Also, I think that you could simplify this documentation by including a pseudo-example:

$ python3 yaml_summarizer.py -l file_1.yaml file_2.yaml
file_1.yaml
<OMP clauses and constructs from file_1.yaml>
file_2.yaml
<OMP clauses and constructs from file_2.yaml>

$ python3 yaml_summarizer.py file_1.yaml file_2.yaml
<OMP clauses and constructs from file_1.yaml and file_2.yaml>

Or something similar. This way, you make the behavior controlled with -l more obvious. Also, pasting the output for omp-device-constructs.f90 takes a lot of space, but does not really clarify much. I would just remove it. Similar comment for process_summary.

237–238

Why is this needed?

[josh.mottley.arm]

• Fixed issues reported from review comments.
• Extended '-d' argument to be able to take a list of semicolon seperated directory paths to search for '.yaml' files in.

[awarzynski]

Many thanks for working on this, LGTM!

flang/examples/flang-omp-report-plugin/yaml_summarizer.py

+"""YAML Summariser
+
+This Python script generates a YAML summary from
+the files generated by ``flang-omp-report``.
+Currently, it only support ``ruamel.yaml``,
+which can be installed with:
+
+    ``pip3 install ruamel.yaml``
+
+By default it scans the directory it is ran in
+for any YAML files and outputs a summary to
+stdout. It can be ran as:
+
+    ``python3 yaml_summarizer.py``
+
+Parameters:
+
+    -d   --directory   Specify which directory to scan
+
+    -l   --log         This option combines all yaml files into one
+
+    -o   --output      Specify a directory in which to save the summary file
+
+    -r   --recursive   Recursively search directory for all yaml files
+
+Examples:
+
+    ``python3 yaml_summarizer.py -d ~/llvm-project/build/``
+
+    ``python3 yaml_summarizer.py -l -o ~/examples/``
+"""
+
+import sys
+import glob
+import argparse
+from pathlib import Path
+from os.path import isdir, isfile
+
+YAML_MODULE_FOUND = True
+try:
+    from ruamel.yaml import YAML
+except ImportError:
+    YAML_MODULE_FOUND = False
+
+parser = argparse.ArgumentParser()
+parser.add_argument("-d", "--directory", help="Specify a directory to scan",
+                    dest="dir", type=str)
+parser.add_argument("-o", "--output", help="Writes to a file instead of\
+                                            stdout", dest="output", type=str)
+parser.add_argument("-r", "--recursive", help="Recursive search for .yaml files",
+                    dest="recursive", type=bool, nargs='?', const=True, default=False)
+
+exclusive_parser = parser.add_mutually_exclusive_group()
+exclusive_parser.add_argument("-l", "--log", help="Combines the log files instead of\
+                                         writing out a summary",
+                                        action='store_true', dest='log')
+
+yaml = YAML()
+
+def find_yaml_files(search_pattern):
+    """
+    Find all '.yaml' files and returns an iglob iterator to them.
+
+    Keyword arguments:
+    search_pattern -- Search pattern for 'iglob' to use for finding '.yaml' files.
+                      If this is set to 'None', then it will default to just searching
+                      for all '.yaml' files in the current directory.
+    """
+    # @TODO: Currently yaml files not from the 'flang-omp-report' plugin could be
+    # included resulting in errors. So we need to check whether the yaml files are
+    # generated in the build or source directory. If in build directory,
+    # look at adding some check for a prefix in yaml file name. If in source, add a
+    # check for the yaml file against its corresponding source file.
+    if search_pattern:
+        return glob.iglob(search_pattern, recursive=True)
+
+    return glob.iglob('*.yaml')
+
+def process_log(data, result):
+    """
+    Process the data input as a 'log' to the result array. This esssentially just
+    stitches together all of the '.yaml' input files into one result.
+
+    Keyword arguments:
+    data -- Data from yaml.load() for a yaml file. So the type can be 'Any'.
+    result -- Array to add the processed data to.
+
+    Example after being processed to yaml:
+        /../llvm-project/flang/test/Examples/omp-device-constructs.f90:
+        - construct: target
+          line: 18
+          clauses:
+          - clause: map
+              details: arraya
+          - construct: target
+          line: 24
+          clauses:
+          - clause: device
+              details: '0'
+    """
+    for datum in data:
+        items = result.get(datum['file'], [])
+        items.append({"construct" : datum['construct'],
+                        "line" : datum['line'],
+                        "clauses" : datum['clauses']})
+        result[datum['file']] = items
+
+def add_clause(datum, construct):
+    """
+    Add clauses to the construct if they're missing
+    Otherwise increment their count by one.
+
+    Keyword arguments:
+    dataum -- Data construct containing clauses to check.
+    construct -- Construct to add or increment clause count.
+    """
+    to_check = [i['clause'] for i in construct['clauses']]
+    to_add = [i['clause'] for i in datum['clauses']]
+    clauses = construct["clauses"]
+    for item in to_add:
+        if item in to_check:
+            for clause in clauses:
+                if clause["clause"] == item:
+                    clause["num"] += 1
+        else:
+            clauses.append({"clause" : item,
+                            "num" : 1})
+
+def process_summary(data, result):
+    """
+    Process the data input as a 'summary' to the 'result' dictionary.
+
+    Keyword arguments:
+    data -- Data from yaml.load() for a yaml file. So the type can be 'Any'.
+    result -- Dictionary to add the processed data to.
+
+    Example after being processed to yaml:
+        - construct: target data
+          num: 1
+          clauses:
+          - clause: device
+              num: 1
+          - clause: map
+              num: 1
+        - construct: atomic-read
+          num: 1
+          clauses:
+          - clause: seq_cst
+              num: 1
+          - construct: atomic-write
+          num: 1
+          clauses:
+          - clause: seq_cst
+              num: 1
+    """
+    for datum in data:
+        construct = next((item for item in result
+                            if item["construct"] == datum["construct"]), None)
+        clauses = []
+        # Add the construct and clauses to the summary if
+        # they haven't been seen before
+        if not construct:
+            for i in datum['clauses']:
+                clauses.append({"clause" : i['clause'],
+                                "num"    : 1})
+            result.append({"construct" : datum['construct'],
+                            "num" : 1,
+                            "clauses" : clauses})
+        else:
+            construct["num"] += 1
+
+            add_clause(datum, construct)
+
+def output_result(result, output_file=None):
+    """
+    Outputs result to either 'stdout' or to a output file.
+
+    Keyword arguments:
+    result -- Format result to output.
+    output_file -- File to output result to. If this is 'None' then result will be
+                  outputted to 'stdout'. (Default: None)
+    """
+    if output_file:
+        with open(output_file, 'w+', encoding='utf-8') as file:
+            if output_file.endswith(".yaml"):
+                yaml.dump(result, file)
+            else:
+                file.write(result)
+    else:
+        yaml.dump(result, sys.stdout)
+
+
+def process_yaml(search_pattern=None, result_format=None, output_file=None):
+    """
+    Reads each yaml file, calls the appropiate format function for
+    the file and then ouputs the result to either 'stdout' or to an output file.
+
+    Keyword arguments:
+    search_pattern -- String pattern formatted for use with glob.iglob to find all
+                      '.yaml' files. (Default: None)
+    result_format -- String representing output format. Current supported strings are: 'log'.
+                     (Default: None - The format will default to 'summary' when argument is None)
+    output_file -- Path to output file. (Default: None)
+                   (If value is None, then defaults to outputting to 'stdout')
+    """
+    if result_format == "log":
+        result = {}
+        action = process_log
+    else:
+        result = []
+        action = process_summary
+
+    for file in find_yaml_files(search_pattern):
+        with open(file, "r", encoding='utf-8') as yaml_file:
+            data = yaml.load(yaml_file)
+            action(data, result)
+
+    output_result(result, output_file)
+
+def yaml_module_not_found():
+    """ Print missing yaml module error and exit script. """
+    print("Currently this script only works with\
+           ``ruamel.yaml`` installed.")
+    sys.exit(1)
+
+if __name__ == "__main__":
+    if not YAML_MODULE_FOUND:
+        yaml_module_not_found()
+
+    args = parser.parse_args()
+
+    SEARCH_PATTERN = None
+    if args.dir:
+        if args.recursive:
+            SEARCH_PATTERN = str(Path(args.dir).joinpath("**/*.yaml"))
+        else:
+            SEARCH_PATTERN = str(Path(args.dir).joinpath("*.yaml"))
+
+    RESULT_FORMAT = None
+    if args.log:
+        RESULT_FORMAT = "log"
+    else:
+        RESULT_FORMAT = "summary"
+
+    OUTPUT_FILE = None
+    if args.output:
+        if isdir(args.output):
+            OUTPUT_FILE = Path(args.output).joinpath("summary.yaml")
+        elif isfile(args.output):
+            OUTPUT_FILE = Path(args.output)
+
+
+    process_yaml(SEARCH_PATTERN, RESULT_FORMAT, OUTPUT_FILE)