Merge pull request #67 from discopop-project/refactor/TP/commandLineArguments

Correction of Task Pattern command line arguments

Author: lukasrothenberger

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
         uses: actions/checkout@v2
       - name: "Install Dependencies"
         run: |
-          sudo apt-get remove clang-10 clang-9
+          sudo apt-get remove clang-10 clang-9 clang-11
           sudo apt-get install libclang-8-dev clang-8 llvm-8
       - name: "Build DiscoPoP Profiler"
         run: |

discopop_explorer/__init__.py

@@ -19,7 +19,8 @@
 
 def run(cu_xml: str, dep_file: str, loop_counter_file: str, reduction_file: str, plugins: List[str],
         file_mapping: Optional[str] = None, cu_inst_result_file: Optional[str] = None,
-        llvm_cxxfilt_path: Optional[str] = None, discopop_build_path: Optional[str] = None) -> DetectionResult:
+        llvm_cxxfilt_path: Optional[str] = None, discopop_build_path: Optional[str] = None,
+        enable_task_pattern: bool = False) -> DetectionResult:
     pet = PETGraphX.from_parsed_input(*parse_inputs(cu_xml, dep_file,
                                                     loop_counter_file, reduction_file))
     # TODO add visualization
@@ -39,7 +40,7 @@ def run(cu_xml: str, dep_file: str, loop_counter_file: str, reduction_file: str,
 
     res: DetectionResult = pattern_detector.detect_patterns(cu_xml, dep_file, loop_counter_file, reduction_file,
                                                             file_mapping, cu_inst_result_file, llvm_cxxfilt_path,
-                                                            discopop_build_path)
+                                                            discopop_build_path, enable_task_pattern)
 
     for plugin_name in plugins:
         p = plugin_source.load_plugin(plugin_name)

discopop_explorer/__main__.py

@@ -11,8 +11,8 @@
 Usage:
     discopop_explorer [--path <path>] [--cu-xml <cuxml>] [--dep-file <depfile>] [--plugins <plugs>] \
 [--loop-counter <loopcount>] [--reduction <reduction>] [--json <json_out>] [--fmap <fmap>] \
-[--cu-inst-res <cuinstres>] [--llvm-cxxfilt-path <cxxfp>] [--discopop-build-path=<dpbuildpath>] \
-[--generate-data-cu-inst <outputdir>]
+[--task-pattern] [--cu-inst-res <cuinstres>] [--llvm-cxxfilt-path <cxxfp>] \
+[--dp-build-path=<dpbuildpath>] [--generate-data-cu-inst <outputdir>]
 
 Options:
     --path=<path>               Directory with input data [default: ./]
@@ -23,10 +23,12 @@
     --fmap=<fmap>               File mapping [default: FileMapping.txt]
     --json=<json_out>           Json output
     --plugins=<plugs>           Plugins to execute
-    --cu-inst-res=<cuinstres>   CU instantiation result file. Task Pattern Detector is executed if this option is set.
-    --llvm-cxxfilt-path=<cxxfp> Path to llvm-cxxfilt executable. Required for Task Pattern Detector
+    --task-pattern              Enables the task parallelism pattern identification.
+                                Requires --cu-inst-res and --llvm-cxxfilt-path to be set.
+    --cu-inst-res=<cuinstres>   CU instantiation result file.
+    --llvm-cxxfilt-path=<cxxfp> Path to llvm-cxxfilt executable. Required for task pattern detector
                                 if non-standard path should be used.
-    --discopop-build-path=<dpbuildpath>     Path to DiscoPoP build folder. Required, if --cu-inst-res is set.
+    --dp-build-path=<dpbuildpath>           Path to DiscoPoP build folder [default: discopop/build]
     --generate-data-cu-inst=<outputdir>     Generates Data_CUInst.txt file and stores it in the given directory.
                                             Stops the regular execution of the discopop_explorer.
                                             Requires --cu-xml, --dep-file, --loop-counter, --reduction.
@@ -40,6 +42,7 @@
 
 from docopt import docopt  # type:ignore
 from schema import Schema, Use, SchemaError  # type:ignore
+from pathlib import Path
 
 from . import run, __version__
 from .json_serializer import PatternInfoSerializer
@@ -53,9 +56,10 @@
     '--fmap': Use(str),
     '--plugins': Use(str),
     '--json': Use(str),
+    '--task-pattern': Use(bool),
     '--cu-inst-res': Use(str),
     '--llvm-cxxfilt-path': Use(str),
-    '--discopop-build-path': Use(str),
+    '--dp-build-path': Use(str),
     '--generate-data-cu-inst': Use(str),
 })
 
@@ -86,6 +90,12 @@ def main():
     reduction_file = get_path(path, arguments['--reduction'])
     file_mapping = get_path(path, 'FileMapping.txt')
     cu_inst_result_file = get_path(path, arguments['--cu-inst-res'])
+    if arguments['--dp-build-path'] != 'None':
+        discopop_build_path=arguments['--dp-build-path']
+    else:
+        # set default discopop build path
+        discopop_build_path = Path(__file__).resolve().parent.parent
+        discopop_build_path = os.path.join(discopop_build_path, "build")
 
     for file in [cu_xml, dep_file, loop_counter_file, reduction_file]:
         if not os.path.isfile(file):
@@ -105,7 +115,7 @@ def main():
 
     res = run(cu_xml, dep_file, loop_counter_file, reduction_file, plugins, file_mapping=file_mapping,
               cu_inst_result_file=cu_inst_result_file, llvm_cxxfilt_path=arguments['--llvm-cxxfilt-path'],
-              discopop_build_path=arguments['--discopop-build-path'])
+              discopop_build_path=discopop_build_path, enable_task_pattern=arguments['--task-pattern'])
 
     end = time.time()
 

discopop_explorer/pattern_detection.py

@@ -60,7 +60,7 @@ def __merge(self, loop_type: bool, remove_dummies: bool):
             self.pet.g.remove_node(n)
 
     def detect_patterns(self, cu_dict, dependencies, loop_data, reduction_vars, file_mapping, cu_inst_result_file,
-                        llvm_cxxfilt_path, discopop_build_path):
+                        llvm_cxxfilt_path, discopop_build_path, enable_task_pattern):
         """Runs pattern discovery on the CU graph
         """
         self.__merge(False, True)
@@ -74,10 +74,7 @@ def detect_patterns(self, cu_dict, dependencies, loop_data, reduction_vars, file
         res.geometric_decomposition = detect_gd(self.pet)
 
         # check if task pattern should be enabled
-        if file_mapping is None or cu_inst_result_file is None:
-            return res
-        if cu_inst_result_file.endswith("/None"):
-            return res
-        res.task = detect_tp(cu_dict, dependencies, loop_data, reduction_vars, file_mapping, cu_inst_result_file,
-                             llvm_cxxfilt_path, discopop_build_path)
+        if enable_task_pattern:
+            res.task = detect_tp(cu_dict, dependencies, loop_data, reduction_vars, file_mapping, cu_inst_result_file,
+                                 llvm_cxxfilt_path, discopop_build_path)
         return res