ipbus-uhal: init at 2.8.16

[joealsubash]

IPBus uhal and firmware provide a mechanism to read/write into FPGA firmware in a reliable fashion. It is used in many current particle-physics experiments at CERN like ATLAS and CMS.
shell-env.sh allows development using the uhal API and provides python bindings for reading and writing into firmware.

https://ipbus.web.cern.ch/

Things done

• Built on platform(s)
  • [ x] x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[ghost]

Welcome to nixpkgs!
Please modify your pr title and commit message to comply with the repository requirements
Please add this package in pkgs/top-level/all-packages.nix

[joealsubash]

Hi,
Thanks for the review.
I have tried to incorporate your suggestions. Could you point me in the right direction as to how to fix the Vet nixpkgs error?

[joealsubash]

Hi, I have squashed the commits and added it to pkgs/top-level/all-packages.nix, please review and let me know anymore changes that are required. Kindly merge otherwise. Thanks.

[pluiedev]

I'm really quite unsure of what the purpose of this script is.

[joealsubash]

Its probably because I don't understand nix very well.
But the idea is, package user should be able to invoke uhal from python and use it to communicate with FPGA hardware connected via. the Ethernet port. That is what adding to PYTHONPATH part does. Another use case is for software developers to be able to access the uhal API to write their custom C/C++ applications.
These are the main ideas this script is trying to provide when the user wants a nix shell with uhal.
If there is a better way to do it, I'd be happy to change. Thanks.

[pluiedev]

In Nix shells, if you want to have a Python install with certain modules configured, you'd use the withPackages function on python3: python3.withPackages (ps: with ps; [ iphus-uhal ]) or something similar.

As for installing other tools, you should add them to propagatedBuildInputs.

[pluiedev]

All other unresolved comments still remain an issue

[joealsubash]

Hi, does this look ok to merge now? Thanks.

[pluiedev]

I don't think my concerns regarding the install prefix & the superfluous bash script have been resolved yet

[joealsubash]

I got the following error and cannot build.

uhal> Traceback (most recent call last):
uhal>   File "/build/source/uhal/python/rpm/RPMBUILD/cactuscore-uhal-python312.py", line 3, in <module>
uhal>     from distutils.core import setup
uhal>   File "/nix/store/w3kv27g00v7g7k2kw5yf51wlbjsy273n-python3.12-distutils-75.1.0/lib/python3.12/site-packages/distutils/core.py", line 17, in <module>
uhal>     from .dist import Distribution
uhal>   File "/nix/store/w3kv27g00v7g7k2kw5yf51wlbjsy273n-python3.12-distutils-75.1.0/lib/python3.12/site-packages/distutils/dist.py", line 17, in <module>
uhal>     from packaging.utils import canonicalize_name, canonicalize_version
uhal> ModuleNotFoundError: No module named 'packaging'
uhal> make[2]: *** [/build/source/uhal/config/mfPythonRPMRules.mk:97: install] Error 1
uhal> make[2]: Leaving directory '/build/source/uhal/python'
uhal> make[1]: *** [Makefile:49: python/.virtual.Makefile] Error 2
uhal> make[1]: Leaving directory '/build/source/uhal'
uhal> make: *** [Makefile:58: uhal/.virtual.Makefile] Error 2

I am unable to reproduce your error locally(builds fine on my machine), not sure why. How can I investigate this further?
'enableParallelBuilding = true' sped things up a lot, thanks.

[FliegendeWurst]

The package builds for me. Some suggestions:

diff --git a/pkgs/by-name/ip/ipbus-uhal/package.nix b/pkgs/by-name/ip/ipbus-uhal/package.nix
index 8fc83623ebf6..57e920610b75 100644
--- a/pkgs/by-name/ip/ipbus-uhal/package.nix
+++ b/pkgs/by-name/ip/ipbus-uhal/package.nix
@@ -34,23 +34,22 @@ stdenv.mkDerivation (finalAttrs: {
     python3.pkgs.distutils
     python3.pkgs.pybind11
   ];
-  configurePhase = ''
-    patchShebangs  uhal/config/install.sh
-    patchShebangs uhal/tests/setup.sh
-    patchShebangs scripts/doxygen/api_uhal.sh
-    patchShebangs config/progress.sh
-    patchShebangs config/Makefile.macros
+  postPatch = ''
+    patchShebangs --build uhal/config/install.sh
+    patchShebangs --build uhal/tests/setup.sh
+    patchShebangs --build scripts/doxygen/api_uhal.sh
+    patchShebangs --build config/progress.sh
+    patchShebangs --build config/Makefile.macros
   '';
 
   enableParallelBuilding = true;
 
-  makeFlags = [ "Set=uhal" ];
-
-  installPhase = ''
-    mkdir -p $out/bin
-    mkdir -p $out/include
-    make Set=uhal install prefix=$out/bin includedir=$out/include
-  '';
+  makeFlags = [
+    "Set=uhal"
+    "CXX=${stdenv.cc.targetPrefix}c++"
+    "prefix=$out/bin"
+    "includedir=$out/include"
+  ];
 
   meta = {
     description = "Software which pairs with ipbus-firmware";

[joealsubash]

Hi,
I have tested this on a few machines and seems to be building and working ok now. Could this be merged now?
Thanks

[joealsubash]

@FliegendeWurst how does this look now? I have incorporated your changes, but had to revert some because it broke the installation. Thanks for the review and suggestions.

[FliegendeWurst]

boost186 and the tag argument still apply. You might need to rebase on current master for it to work.

[joealsubash]

boost186 and the tag argument still apply. You might need to rebase on current master for it to work.

OK, those changes have been made now and has been rebased.

[FliegendeWurst]

Thank you. Please also reorder the commits so the maintainers modification comes first, and clean up the other commit message a bit 😉

[joealsubash]

Thank you. Please also reorder the commits so the maintainers modification comes first, and clean up the other commit message a bit 😉

Ok done now. Made a mistake when rebasing but this has been fixed in the newest push.

[FliegendeWurst]

Alright it looks okay now.