Added ghdl_flags compile and sim options

Author: kraigher

user_guide.md

@@ -302,7 +302,7 @@ test = ent.test("test")
 test.disable_ieee_warnings()
 ```
 ## Setting custom simulation options
-Custom simulation options can be set using the`sim_options(name, value)` method. Options can either be set globally, for a library, for an entity or for a specific test.
+Custom simulation options can be set using the`set_sim_option(name, value)` method. Options can either be set globally, for a library, for an entity or for a specific test.
 ```python
 vu.set_sim_option("vsim_extra_args.gui", "-voptargs=+acc")
 ```
@@ -312,6 +312,22 @@ vu.set_sim_option("vsim_extra_args.gui", "-voptargs=+acc")
   - Extra arguments passed to `vsim` when loading the design.
 * `vsim_extra_args.gui`
   - Extra arguments passed to `vsim` when loading the design in GUI mode where it takes precedence over `vsim_extra_args`.
+* `ghdl_flags`
+  - Extra arguments passed to `ghdl --elab-run` command *before* executable specific flags. Must be a list of strings.
+  - Example `vu.set_sim_option("ghdl_flags", ["--no-vital-checks"])`.
+
+## Setting custom compilation options
+Custom compilation options can be set using the `set_compile_option(name, value)` method. Options can be either set globally, for a library or for a specific file returned by the `add_source_files` method.
+```python
+vu.set_compile_option("ghdl_flags", ["--no-vital-checks"])
+```
+
+**NOTE:** Only affects source files added *before* the option is set.
+
+### Known compilation options
+* `ghdl_flags`
+  - Extra arguments passed to `ghdl -a` command. Must be a list of strings.
+  - Example `vu.set_compile_option("ghdl_flags", ["--no-vital-checks"])`.
 
 ## Ctrl-C when using Git/MSYS Bash on Windows
 VUnit will catch Ctrl-C and perform a clean shutdown closing all started simulation processes and printing the test report so far. On Git/MSYS Bash on Windows however there is a mechanism that hard kills a process a very short time after pressing Ctrl-C often prohibiting VUnit from completing its shutdown. This can leave simulation process open which have to be manually killed. See this [stack overflow post](http://stackoverflow.com/questions/23678045/control-c-kills-ipython-in-git-bash-on-windows-7) for tips on how to remove this mechanism.

vunit/ghdl_interface.py

@@ -108,8 +108,11 @@ def compile_project(self, project, vhdl_standard):
             print('Compiling ' + source_file.name + ' into ' + source_file.library.name + ' ...')
 
             if source_file.file_type == 'vhdl':
-                success = self.compile_vhdl_file(source_file.name, source_file.library.name,
-                                                 source_file.library.directory, vhdl_standard)
+                success = self.compile_vhdl_file(source_file.name,
+                                                 source_file.library.name,
+                                                 source_file.library.directory,
+                                                 vhdl_standard,
+                                                 source_file.compile_options)
             elif source_file.file_type == 'verilog':
                 raise RuntimeError("Unkown file type: " + source_file.file_type)
 
@@ -130,7 +133,12 @@ def _std_str(self):
         else:
             assert False
 
-    def compile_vhdl_file(self, source_file_name, library_name, library_path, vhdl_standard):
+    def compile_vhdl_file(self,  # pylint: disable=too-many-arguments
+                          source_file_name,
+                          library_name,
+                          library_path,
+                          vhdl_standard,
+                          compile_options):
         """
         Compile a vhdl file
         """
@@ -140,6 +148,7 @@ def compile_vhdl_file(self, source_file_name, library_name, library_path, vhdl_s
                    '--std=%s' % self._std_str()]
             for library_name, library_path in self._libraries.items():
                 cmd += ["-P%s" % library_path]
+            cmd += compile_options.get("ghdl_flags", [])
             cmd += [source_file_name]
             proc = Process(cmd)
             proc.consume_output()
@@ -172,6 +181,7 @@ def simulate(self,  # pylint: disable=too-many-arguments, too-many-locals
 
             if self._has_output_flag():
                 cmd += ['-o', join(ghdl_output_path, "%s-%s" % (entity_name, architecture_name))]
+            cmd += config.options.get("ghdl_flags", [])
 
             cmd += [entity_name, architecture_name]
 

vunit/project.py

@@ -538,6 +538,7 @@ def __init__(self, name, library, file_type):
         self.file_type = file_type
         self.design_units = []
         self._content_hash = None
+        self._compile_options = {}
 
     def __eq__(self, other):
         if isinstance(other, type(self)):
@@ -557,9 +558,34 @@ def __hash__(self):
     def __repr__(self):
         return "SourceFile(%s, %s)" % (self.name, self.library.name)
 
+    _allowed_compile_options = ["ghdl_flags"]
+
+    def set_compile_option(self, name, value):
+        """
+        Set compile option
+        """
+        if name not in self._allowed_compile_options:
+            raise ValueError("Unknown compile option %r" % name)
+        self._compile_options[name] = value
+
+    @property
+    def compile_options(self):
+        return self._compile_options
+
+    def _compile_options_hash(self):
+        """
+        Compute hash of compile options
+
+        Needs to be updated if there are nested dictionaries
+        """
+        return hash_string(repr(sorted(self._compile_options.items())))
+
     @property
     def content_hash(self):
-        return self._content_hash
+        """
+        Compute hash of contents and compile options
+        """
+        return hash_string(self._content_hash + self._compile_options_hash())
 
 
 class VerilogSourceFile(SourceFile):

vunit/test/unit/test_project.py

@@ -547,6 +547,17 @@ def test_should_recompile_files_affected_by_change(self):
         file1, file2, file3 = self.create_dummy_three_file_project(update_file1=True)
         self.assert_should_recompile([file1, file2, file3])
 
+    def test_should_recompile_files_after_changing_compile_options(self):
+        file1, file2, file3 = self.create_dummy_three_file_project()
+
+        self.update(file1)
+        self.update(file2)
+        self.update(file3)
+        self.assert_should_recompile([])
+
+        file2.set_compile_option("ghdl_flags", ["--no-vital-checks"])
+        self.assert_should_recompile([file2, file3])
+
     def test_should_recompile_files_affected_by_change_with_later_timestamp(self):
         file1, file2, file3 = self.create_dummy_three_file_project()
 

vunit/test_configuration.py

@@ -57,7 +57,8 @@ def set_generic(self, name, value, scope=create_scope()):
         self._generics[scope][name] = value
 
     _known_options = ["vsim_extra_args",
-                      "vsim_extra_args.gui"]
+                      "vsim_extra_args.gui",
+                      "ghdl_flags"]
 
     def set_sim_option(self, name, value, scope=create_scope()):
         """

vunit/ui.py

@@ -228,6 +228,13 @@ def set_sim_option(self, name, value):
         """
         self._configuration.set_sim_option(name, value, scope=create_scope())
 
+    def set_compile_option(self, name, value):
+        """
+        Globally set compile option
+        """
+        for source_file in self._project.get_source_files_in_order():
+            source_file.set_compile_option(name, value)
+
     def set_pli(self, value):
         """
         Globally set pli
@@ -244,8 +251,9 @@ def add_source_files(self, pattern, library_name, preprocessors=None, include_di
         """
         Add source files matching wildcard pattern to library
         """
-        for file_name in glob(pattern):
+        return FileSetFacade(source_files=[
             self.add_source_file(file_name, library_name, preprocessors, include_dirs)
+            for file_name in glob(pattern)])
 
     def add_source_file(self, file_name, library_name, preprocessors=None, include_dirs=None):
         """
@@ -258,10 +266,10 @@ def add_source_file(self, file_name, library_name, preprocessors=None, include_d
             add_verilog_include_dir(include_dirs)
 
         file_name = self._preprocess(library_name, abspath(file_name), preprocessors)
-        self._project.add_source_file(file_name,
-                                      library_name,
-                                      file_type=file_type,
-                                      include_dirs=include_dirs)
+        return self._project.add_source_file(file_name,
+                                             library_name,
+                                             file_type=file_type,
+                                             include_dirs=include_dirs)
 
     def _preprocess(self, library_name, file_name, preprocessors):
         """
@@ -533,6 +541,14 @@ def set_sim_option(self, name, value):
         """
         self._configuration.set_sim_option(name, value, scope=self._scope)
 
+    def set_compile_option(self, name, value):
+        """
+        Set compile option within library
+        """
+        for source_file in self._project.get_source_files_in_order():
+            if source_file.library.name == self._library_name:
+                source_file.set_compile_option(name, value)
+
     def set_pli(self, value):
         """ Set pli within library """
         self._configuration.set_pli(value, scope=self._scope)
@@ -544,7 +560,7 @@ def disable_ieee_warnings(self):
         self._configuration.disable_ieee_warnings(scope=self._scope)
 
     def add_source_files(self, pattern, preprocessors=None):
-        self._parent.add_source_files(pattern, self._library_name, preprocessors)
+        return self._parent.add_source_files(pattern, self._library_name, preprocessors)
 
     def package(self, package_name):
         """
@@ -672,7 +688,7 @@ def generate_codecs(self, codec_package_name=None, used_packages=None, output_fi
                                         output_file_name,
                                         self._parent.use_debug_codecs)
 
-        self._parent.add_source_files(output_file_name, self._library_name)
+        return self._parent.add_source_files(output_file_name, self._library_name)
 
 
 class TestFacade(object):
@@ -727,6 +743,22 @@ def disable_ieee_warnings(self):
         self._config.disable_ieee_warnings(scope=self._scope)
 
 
+class FileSetFacade(object):
+    """
+    A set of one or more files
+    """
+
+    def __init__(self, source_files):
+        self._source_files = source_files
+
+    def set_compile_option(self, name, value):
+        """
+        Set compile option
+        """
+        for source_file in self._source_files:
+            source_file.set_compile_option(name, value)
+
+
 def select_vhdl_standard():
     """
     Select VHDL standard according to environment variable VUNIT_VHDL_STANDARD