enable gin bindings for compilation flags (#103)

* enable gin bindings for compilation flags

* updated gin bindings for compilation flags. make necessary changes to enable replace_flags. updates the default list of delete_flags.

* updated gin bindings for compilation flags. make necessary changes to enable replace_flags. updates the default list of delete_flags.

* update delete flags.

Author: kshiteejm

compiler_opt/rl/corpus.py

@@ -183,6 +183,8 @@ def _build_modulespecs_from_datapath(
       logging.warning('Additional flags are specified together with override.')
     if len(delete_flags) > 0:
       logging.warning('Delete flags are specified together with override.')
+    if len(replace_flags) > 0:
+      logging.warning('Replace flags are specified together with override.')
 
   module_specs: List[ModuleSpec] = []
 

compiler_opt/rl/inlining/gin_configs/common.gin

@@ -7,3 +7,9 @@ clang_path=None
 runners.InliningRunner.llvm_size_path=%llvm_size_path
 runners.InliningRunner.clang_path=%clang_path
 runners.InliningRunner.launcher_path=%launcher_path
+
+problem_config.flags_to_add.add_flags=()
+problem_config.flags_to_delete.delete_flags=('-split-dwarf-file','-split-dwarf-output',)
+# For AFDO profile reinjection elide overlapping flags from delete_flags and set
+# problem_config.flags_to_replace.replace_flags={'-fprofile-sample-use':'/path/to/gwp.afdo','-fprofile-remapping-file':'/path/to/prof_remap.txt'}
+problem_config.flags_to_replace.replace_flags={}

compiler_opt/rl/problem_configuration.py

@@ -68,7 +68,8 @@
 """
 
 import abc
-from typing import Callable, Iterable, Tuple
+import gin
+from typing import Callable, Dict, Iterable, Optional, Tuple
 
 import tensorflow as tf
 import tf_agents as tfa
@@ -103,15 +104,25 @@ def get_runner_type(self) -> 'type[compilation_runner.CompilationRunner]':
   # TODO(b/233935329): The following clang flags need to be tied to a corpus
   # rather than to a training tool invocation.
 
-  # List of flags to add to clang compilation command. The flag names should
-  # match the actual flags provided to clang. An example for AFDO reinjection:
-  # return ['-fprofile-sample-use=/path/to/gwp.afdo',
-  #  '-fprofile-remapping-file=/path/to/prof_remap.txt']
-  def flags_to_add(self) -> Tuple[str, ...]:
-    return ()
+  # List of flags to add to clang compilation command.
+  @gin.configurable(module='problem_config')
+  def flags_to_add(self, add_flags=()) -> Tuple[str, ...]:
+    return add_flags
 
   # List of flags to remove from clang compilation command. The flag names
   # should match the actual flags provided to clang.'
-  def flags_to_delete(self) -> Tuple[str, ...]:
-    return ('-split-dwarf-file', '-split-dwarf-output', '-fprofile-sample-use',
-            '-fprofile-remapping-file')
+  @gin.configurable(module='problem_config')
+  def flags_to_delete(self, delete_flags=()) -> Tuple[str, ...]:
+    return delete_flags
+
+  # List of flags to replace in the clang compilation command. The flag names
+  # should match the actual flags provided to clang. An example for AFDO
+  # reinjection:
+  # replace_flags={
+  #     '-fprofile-sample-use':'/path/to/gwp.afdo',
+  #     '-fprofile-remapping-file':'/path/to/prof_remap.txt'
+  # }
+  # return replace_flags
+  @gin.configurable(module='problem_config')
+  def flags_to_replace(self, replace_flags=None) -> Optional[Dict[str, str]]:
+    return replace_flags

compiler_opt/rl/regalloc/gin_configs/common.gin

@@ -5,3 +5,9 @@ clang_path=None
 
 runners.RegAllocRunner.clang_path=%clang_path
 runners.RegAllocRunner.launcher_path=%launcher_path
+
+problem_config.flags_to_add.add_flags=()
+problem_config.flags_to_delete.delete_flags=('-split-dwarf-file','-split-dwarf-output',)
+# For AFDO profile reinjection elide overlapping flags from delete_flags and set
+# problem_config.flags_to_replace.replace_flags={'-fprofile-sample-use':'/path/to/gwp.afdo','-fprofile-remapping-file':'/path/to/prof_remap.txt'}
+problem_config.flags_to_replace.replace_flags={}

compiler_opt/rl/train_locally.py

@@ -99,8 +99,11 @@ def train_eval(agent_name=constant.AgentName.PPO,
   saver = policy_saver.PolicySaver(policy_dict=policy_dict)
 
   logging.info('Loading module specs from corpus at %s.', FLAGS.data_path)
-  cps = corpus.Corpus(FLAGS.data_path, problem_config.flags_to_add(),
-                      problem_config.flags_to_delete())
+  cps = corpus.Corpus(
+    FLAGS.data_path,
+    additional_flags=problem_config.flags_to_add(),
+    delete_flags=problem_config.flags_to_delete(),
+    replace_flags=problem_config.flags_to_replace())
   logging.info('Done loading module specs from corpus.')
 
   dataset_fn = data_reader.create_sequence_example_dataset_fn(

compiler_opt/tools/generate_default_trace.py

@@ -142,7 +142,8 @@ def main(_):
   cps = corpus.Corpus(
       _DATA_PATH.value,
       additional_flags=config.flags_to_add(),
-      delete_flags=config.flags_to_delete())
+      delete_flags=config.flags_to_delete(),
+      replace_flags=config.flags_to_replace())
   logging.info('Done loading module specs from corpus.')
 
   if _MODULE_FILTER.value: