fusesoc 2.4.2__tar.gz → 2.4.4__tar.gz

{fusesoc-2.4.2 → fusesoc-2.4.4}/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         os:
-        - { icon: 🐧, name: ubuntu-20.04 }
+        - { icon: 🐧, name: ubuntu-22.04 }
         - { icon: 🍎, name: macos-latest }
         # CI is currently broken on Windows
         # https://github.com/olofk/fusesoc/issues/528

{fusesoc-2.4.2 → fusesoc-2.4.4}/.github/workflows/lint.yml

@@ -4,8 +4,8 @@ on: [pull_request, push]
 
 jobs:
   pre-commit:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
-    - uses: pre-commit/action@v2.0.0
+    - uses: pre-commit/action@v3.0.1

{fusesoc-2.4.2 → fusesoc-2.4.4}/NEWS

@@ -1,4 +1,38 @@
-2.4.2 2024-01-07 Olof Kindgren <olof.kindgren@gmail.com>
+2.4.4 2025-09-09 Olof Kindgren
+======================================================
+
+* Fix exporting of generated files
+* Make filter errors fatal
+* Add signing support
+* Add license field to CAPI2
+
+Contributors:
+Anders Ahlberg
+Anska Ludwig
+Hugo McNally
+Olof Kindgren
+Paul Gatewood
+
+2.4.3 2025-04-14 Olof Kindgren <olof.kindgren@gmail.com>
+======================================================
+
+* Improve generator caching
+* Check out missing core libraries on updates
+* Added argcompletion
+* Add lockfile support
+* Add mapping support
+* Expose core description files in EDAM
+
+Contributors:
+Erik Bånvik <erik.public@gmail.com>
+Hugo McNally <hugo.mcnally@gmail.com>
+Ivan <ivanmvig@gmail.com>
+Julian Frimmel <julian@fri-me.de>
+Nico Rumpeltin <nico@rumpeltin.de>
+Olof Kindgren <olof.kindgren@gmail.com>
+
+
+2.4.2 2025-01-07 Olof Kindgren <olof.kindgren@gmail.com>
 ======================================================
 
 * Support lists in file_input_parameters

{fusesoc-2.4.2 → fusesoc-2.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fusesoc
-Version: 2.4.2
+Version: 2.4.4
 Summary: Award-winnning package manager and build abstraction tool for HDL code
 Author-email: Olof Kindgren <olof@award-winning.me>
 Maintainer-email: Olof Kindgren <olof@award-winning.me>
@@ -22,7 +22,8 @@ Requires-Dist: pyparsing>=2.3.1
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: simplesat>=0.9.1
 Requires-Dist: fastjsonschema
-Requires-Dist: jsonschema2md
+Requires-Dist: argcomplete
+Dynamic: license-file
 
 # FuseSoC
 

{fusesoc-2.4.2 → fusesoc-2.4.4}/doc/requirements.txt

@@ -1,3 +1,4 @@
+jsonschema2md
 myst_parser >= 0.18.0
 Sphinx >= 6.2.1
 sphinx-rtd-theme >= 1.2.0

{fusesoc-2.4.2 → fusesoc-2.4.4}/doc/source/user/build_system/core_files.rst

@@ -270,3 +270,29 @@ As always with inheritance the interesting questions are around overriding behav
   To do so, it specifies the special ``filesets_append`` key with a partial list.
   When evaluating the core file, FuseSoC appends the contents of ``sim.fileset_append`` at the end of ``default.fileset`` to form a list with two items: ``rtl``, and ``tb``.
   The same behavior works for all lists in core files.
+
+Signed core files
+-----------------
+
+The fusesoc cli tool can produce a cryptographic signature for a core (currenly using ssh keys).  The signature is stored in a separate file named as the signed core but with ``.sig`` appended.
+
+For verifying signatures a file called a *trustfile* is used.  The trustfile contains a list of trusted users and their public ssh keys, one per line:
+
+.. code-block:: text
+
+   $ cat tests/signature_files/trustfiles/trustfile_1ed_and_2
+   user1@example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFL1l8BB+EnUUkwMtMMqv1HFw8q2SZ7ERuGcFYt8VtqL
+   user2@example.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIP6w+b8Xue0Jo/Hskd9B+Ttr6g9rq99qbZV/01q+FgED
+
+The location of this file can be set in the ``[main]`` section of the ``fusesoc.conf`` file:
+
+.. code-block:: INI
+
+   [main]
+   ssh-trustfile = /home/anders/FuseSoCdb/git/fusesoc/tests/signature_files/trustfiles/trustfile
+
+This setting can also be overridden using the command line option ``--ssh-trustfile``.
+
+The signing process is accomplished with the ``core sign`` command, which takes a core name and a path to a private ssh key as arguments.
+
+The signing status of a core is shown in the ``core list`` and ``core show`` commands in the fusesoc cli tool.

{fusesoc-2.4.2 → fusesoc-2.4.4}/doc/source/user/build_system/index.rst

@@ -38,5 +38,7 @@ A full reference documentation on the CAPI2 core file format can be found in the
    filters.rst
    flags.rst
    generators.rst
+   virtual_cores.rst
+   mappings.rst
    hooks.rst
    vpi.rst

fusesoc-2.4.4/doc/source/user/build_system/mappings.rst

@@ -0,0 +1,40 @@
+.. _ug_build_system_mappings:
+
+Mappings: Replace cores in the dependency tree
+==============================================
+
+Mappings allow a user of a core to substitute dependencies of the core with other cores without having to edit any of the core or it's dependencies files.
+An example use case is making use of an existing core but substituting one of it's dependencies with a version that some desired changes (e.g. bug fixes).
+
+If you are looking to provide a core with multiple implementations, virtual cores is the recommended and more semantic solution.
+See :ref:`ug_build_system_virtual_cores` for more information on virtual cores.
+Note: virtual cores can also be substituted in mappings.
+
+Declaring mappings
+------------------
+
+Each core file can have one mapping.
+An example mapping core file:
+
+.. code:: yaml
+
+    name: "local:map:override_fpu_and_fifo"
+    mapping:
+      "vendor:lib:fpu":  "local:lib:fpu"
+      "vendor:lib:fifo": "local:lib:fifo"
+
+The example above is a core file with only a mapping property, but any core file may contain a mapping in addition to other properties (e.g. filesets, targets & generators).
+
+Applying mappings
+-----------------
+
+To apply a mapping, provide the VLNV of the core file that contains the desired
+mapping with `fusesoc run`'s `--mapping` argument. Multiple mappings may be
+provided as shown below.
+
+.. code:: sh
+
+    fusesoc run \
+      --mapping local:map:override_fpu_and_fifo \
+      --mapping local:map:another_mapping \
+      vendor:top:main

fusesoc-2.4.4/doc/source/user/build_system/virtual_cores.rst

@@ -0,0 +1,8 @@
+.. _ug_build_system_virtual_cores:
+
+Virtual Cores: Provide a common interface
+=========================================
+
+.. todo::
+
+   Document virtual cores.

{fusesoc-2.4.2 → fusesoc-2.4.4}/fusesoc/capi2/core.py

@@ -10,8 +10,10 @@ import os
 import shutil
 import warnings
 from filecmp import cmp
+from types import MappingProxyType
+from typing import Mapping, Optional
 
-from fusesoc import utils
+from fusesoc import signature, utils
 from fusesoc.capi2.coredata import CoreData
 from fusesoc.provider.provider import get_provider
 from fusesoc.vlnv import Vlnv
@@ -129,7 +131,9 @@ class Core:
         for root, dirs, files in os.walk(dst_dir):
             for f in files:
                 _abs_f = os.path.join(root, f)
-                if not os.path.relpath(_abs_f, dst_dir).replace("\\", "/") in src_files:
+                _rel_f = os.path.normpath(os.path.relpath(_abs_f, dst_dir))
+
+                if not _rel_f in [os.path.normpath(x) for x in src_files]:
                     os.remove(_abs_f)
 
     def _get_script_names(self, flags):
@@ -517,12 +521,13 @@ class Core:
             )
         return vpi
 
-    def info(self):
+    def info(self, trustfile):
         s = """CORE INFO
 Name:        {}
 Description: {}
 Core root:   {}
 Core file:   {}
+Signature:   {}
 
 Targets:
 {}"""
@@ -547,6 +552,7 @@ Targets:
             str(self.get_description() or "<No description>"),
             str(self.core_root),
             str(self.core_basename),
+            self.sig_status_long(trustfile),
             targets,
         )
 
@@ -630,3 +636,57 @@ Targets:
 
     def get_description(self):
         return self._coredata.get_description()
+
+    @property
+    def mapping(self) -> Optional[Mapping[str, str]]:
+        return MappingProxyType(self._coredata.get("mapping", {}))
+
+    def signed_data(self):
+        """
+        Return a canonical representation of the core as a string
+        for signature purposes.
+        """
+        file = open(self.core_file, "rb")
+        header = file.readline()
+        core_raw = file.read()
+        file.close()
+        if header.startswith(b"CAPI=2:"):
+            # Core file is single document, no built in signature.  We
+            # sign everything after the header line.
+            core_canonical = core_raw.strip()
+        else:
+            # Core file is not a valid CAPI=2 document.
+            raise RuntimeError("File to sign is not a valid CAPI=2 document.")
+        return core_canonical
+
+    def sig_status_long(self, trustfile):
+        return {
+            "-": "Not signed",
+            "?": "Signed by unknown key",
+            "*": "Signature is not for this core",
+            "!": "Signature checking error",
+            "good": "Good",
+            "?!": "Either signed by an unknown key, or signature does not match",
+        }.get(self.sig_status(trustfile), "Other signature checking error")
+
+    def sig_status(self, trustfile):
+        sigfile = self.core_file + ".sig"
+        if not os.path.isfile(sigfile):
+            return "-"  # Not signed
+        if not trustfile:
+            return "?"  # Signed by unknown key
+        ok = False
+        try:
+            res = signature.verify(self, trustfile, sigfile)
+            for user in res:
+                if res[user]:
+                    ok = True
+        except RuntimeError:
+            return "*"  # Signature is not for this core (should not happen)
+        except:
+            return "!"  # Other signature checking error
+        if ok:
+            return "good"
+        else:
+            return "?!"  # Either signed by an untrusted key, or
+            # signature does not match.

{fusesoc-2.4.2 → fusesoc-2.4.4}/fusesoc/capi2/coredata.py

@@ -43,22 +43,18 @@ class CoreData:
 
         if type(data) == list:
             remove = []
-            append = []
-            for i in data:
+            for idx, i in enumerate(data):
                 if type(i) == str and len(i) > 0 and "?" in i:
                     expanded = Exprs(i).expand(flags)
                     if i != expanded:
-                        remove.append(i)
                         if len(expanded) > 0:
-                            append.append(expanded)
+                            data[idx] = expanded
+                        else:
+                            remove.append(idx)
                 elif type(i) == dict or type(i) == list:
                     self._expand_use(i, flags)
-
-            for i in remove:
-                data.remove(i)
-
-            for i in append:
-                data.append(i)
+            for i in reversed(remove):
+                data.pop(i)
 
     def _append_lists(self, data):
         if type(data) == list: