2.18.0 adding code hash sum

changelog

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.17.2] - 2024-03-20
+
+### Changed
+- vhdlhelper.py with created function 'get_files_hash_value' (hash value of all .py and .vhd files in "tmVhdlProducer" recursively) for use in VHDL templates ("menu.info.files_hash_value").
+- algodist.py with writing "files_hash_value" to log file.
+- VHDL templates.
+
 ## [2.17.1] - 2024-02-28
 
 ### Fixed
@@ -310,7 +317,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - adjusted `--dryrun` and `--ratio` options.
 
-[unreleased]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.17.1...HEAD
+[unreleased]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.17.2...HEAD
+[2.17.2]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.17.1...2.17.2
 [2.17.1]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.17.0...2.17.1
 [2.17.0]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.16.0...2.17.0
 [2.16.0]: https://github.com/cms-l1-globaltrigger/tm-vhdlproducer/compare/2.15.1...2.16.0

tmVhdlProducer/__init__.py

@@ -1 +1 @@
-__version__ = "2.17.1"
+__version__ = "2.17.2"

tmVhdlProducer/algodist.py

@@ -23,6 +23,7 @@
 import argparse
 import json
 import logging
+import subprocess
 import uuid
 import sys, os
 from collections import namedtuple
@@ -32,6 +33,8 @@
 import tmGrammar
 
 from .constants import BRAMS_TOTAL, SLICELUTS_TOTAL, PROCESSORS_TOTAL, NR_CALOS, NR_MUONS
+from . import vhdlhelper
+from . import __version__
 
 from .handles import Payload
 from .handles import ObjectHandle
@@ -1694,6 +1697,16 @@ def dump_distribution(collection: ModuleCollection, filename: str):
 
 def distribute(eventSetup, modules: int, config: str, ratio: float, reverse_sorting: bool, constraints: Dict[str, str] = None) -> ModuleCollection:
     """Distribution wrapper function, provided for convenience."""
+
+    # hash value of the content of all .py and .vhd files in 'file_path'.
+    file_path = os.path.dirname(__file__)
+    files_hash_value = vhdlhelper.get_files_hash_value(file_path)
+
+    logging.info("====================")
+    logging.info("VHDL producer")
+    logging.info("version: %s", vhdlhelper.VersionHelper(__version__))
+    logging.info("hash: %s", files_hash_value)
+    logging.info("====================")
     logging.info("distributing menu...")
 
     constraints = constraints or {}

tmVhdlProducer/templates/vhdl/algo_index.vhd

@@ -15,11 +15,12 @@
 -- Scale set:
 -- {{ menu.info.scale_set }}
 
--- VHDL producer version
--- v{{ menu.info.sw_version }}
+-- VHDL producer
+-- version: {{ menu.info.sw_version }}
+-- hash value: {{ menu.info.files_hash_value }}
 
--- tmEventSetup version
--- v{{ menu.info.version }}
+-- tmEventSetup
+-- version: {{ menu.info.version }}
 
 -- HB 2016-09-16: constants for algo_mapping_rop.
 type global_index_array is array (0 to NR_ALGOS-1) of integer;

tmVhdlProducer/templates/vhdl/gtl_module_instances.vhd

@@ -15,11 +15,12 @@
 -- Scale set:
 -- {{ menu.info.scale_set }}
 
--- VHDL producer version
--- v{{ menu.info.sw_version }}
+-- VHDL producer 
+-- version: {{ menu.info.sw_version }}
+-- hash value: {{ menu.info.files_hash_value }}
 
--- tmEventSetup version
--- v{{ menu.info.version }}
+-- tmEventSetup
+-- version: {{ menu.info.version }}
 
 -- ========================================================
 -- Instantiations of conditions

tmVhdlProducer/templates/vhdl/gtl_module_signals.vhd

@@ -15,11 +15,12 @@
 -- Scale set:
 -- {{ menu.info.scale_set }}
 
--- VHDL producer version
--- v{{ menu.info.sw_version }}
+-- VHDL producer
+-- version: {{ menu.info.sw_version }}
+-- hash value: {{ menu.info.files_hash_value }}
 
--- tmEventSetup version
--- v{{ menu.info.version }}
+-- tmEventSetup
+-- version: {{ menu.info.version }}
 
 -- Signal definition of pt, eta and phi for correlation conditions.
 {%- include  "signals/signal_correlation_conditions_parameter.vhd" %}

tmVhdlProducer/templates/vhdl/ugt_constants.vhd

@@ -15,11 +15,12 @@
 -- Scale set:
 -- {{ menu.info.scale_set }}
 
--- VHDL producer version
--- v{{ menu.info.sw_version }}
+-- VHDL producer
+-- version: {{ menu.info.sw_version }}
+-- hash value: {{ menu.info.files_hash_value }}
 
--- tmEventSetup version
--- v{{ menu.info.version }}
+-- tmEventSetup
+-- version: {{ menu.info.version }}
 
 -- Algorithms
 constant NR_ALGOS : positive := {{ module.algorithms | length }}; -- number of algorithmns (min. 32 for FDL registers width !!!) - written by TME

tmVhdlProducer/vhdlhelper.py

@@ -40,6 +40,7 @@
       * MassCutHelper
 """
 
+import subprocess
 import math
 import string
 import re, os
@@ -53,6 +54,9 @@
 from . import algodist
 from . import __version__
 
+import hashlib
+from glob import glob
+
 # -----------------------------------------------------------------------------
 #  Precompiled regular expressions
 # -----------------------------------------------------------------------------
@@ -251,6 +255,30 @@ def bx_encode_4_array(value: int) -> str:
     """
     return format([2, 1, 0, -1, -2].index(value), 'd')
 
+def get_files_hash_value(dir_path):
+    """Calculate hash value of the content of all .py and .vhd files in 'dir_path'.
+    """
+    py_files = dir_path+"/**/*.py"
+    vhd_files = dir_path+"/**/*.vhd"
+
+    x = hashlib.sha256()
+
+    filename = []
+
+    for filename_py in glob(py_files, recursive=True):
+        filename.append(filename_py)
+    for filename_vhd in glob(vhd_files, recursive=True):
+        filename.append(filename_vhd)
+    for i in range(0, len(filename)):
+        with open(filename[i], 'rb') as f:
+            while True:
+                # Reading is buffered, so we can read smaller chunks.
+                chunk = f.read(x.block_size)
+                if not chunk:
+                    break
+                x.update(chunk)
+
+    return x.hexdigest()
 
 # -----------------------------------------------------------------------------
 #  Factories
@@ -355,7 +383,10 @@ def __init__(self, collection):
         self.scale_set = eventSetup.getScaleSetName()
         self.version = VersionHelper(tmEventSetup.__version__)
         self.sw_version = VersionHelper(__version__)
-
+        # hash value of all .py and .vhd files in directory "tmVhdlProducer" recursively
+        file_path = os.path.dirname(__file__)
+        self.files_hash_value = get_files_hash_value(file_path)
+
 class ModuleHelper(VhdlHelper):
     """Module template helper.