No in-build execution for CMake managed builds

[ck3d]

Issue description

I try to migrate a library written in C++ build via CMake to Nix. The test executables also written in C++ are part of this project. CMake allows in-build execution (and therefor in-build testing), because it sets the RPATH for the build executable.

Nixpkgs skips adding this RPATH by setting CMAKE_SKIP_BUILD_RPATH`. This behavior breaks the possibility to test the library or call built executables during build.

Workarounds

• Expand LD_LIBRARY_PATH; Following command gives an overview how many derivations tackle this issue.
  .../nixpkgs $ git grep -E "LD_LIBRARY_PATH.*pwd"
• Install before checking/install project before checking/testing

Proposal

The canonical behavior of CMake should be preserved and CMAKE_SKIP_BUILD_RPATH should not be set.

What do you think about this issue?

[cpages]

That behavior is a bit annoying, but there is a reason CMAKE_SKIP_BUILD_RPATH is set, as is explained on the comment above the line you referred. Specifically, cmake clears the rpath after the build if the SKIP option is not set, breaking all the dependencies that are set by nix.

So it's not as easy as just not setting that flag. Did you have a specific solution in mind?

[ck3d]

Only if CMake would use RPATH for local and RUNPATH for global dependencies. But CMake uses put all the dependencies into RUNPATH.

No I have no solution.
I think we should document the limitation.

[globin]

cc @viric

[mmahut]

Are there any updates to this issue, please?

[bjornfor]

I dug in the nixpkgs tree and found that some packages actually set -DCMAKE_SKIP_BUILD_RPATH=OFF, to reverse the effect of the setup hook and be able to run binaries from the build tree.

Digging a bit more I found that -DCMAKE_SKIP_BUILD_RPATH=ON was added in 2009. Commit f3c2348 added it to the cmake setup hook after it having been manually set in a few packages earlier that year.

In 2016 an attempt was made to change from -DCMAKE_SKIP_BUILD_RPATH=ON to -DCMAKE_BUILD_WITH_INSTALL_RPATH=TRUE, but it was reverted due to a blocking darwin issue: d5d4606. I'm not sure that commit would have fixed this issue, but the discussion that lead up the the revert is worth a read:#15881.

After that revert, -DCMAKE_SKIP_BUILD_RPATH=OFF popped up in various package to workaround this issue.

I wonder if we could try removing it again, possibly only for Linux?

[knedlsepp]

I dug in the nixpkgs tree and found that some packages actually set -DCMAKE_SKIP_BUILD_RPATH=OFF, to reverse the effect of the setup hook and be able to run binaries from the build tree.

Digging a bit more I found that -DCMAKE_SKIP_BUILD_RPATH=ON was added in 2009. Commit f3c2348 added it to the cmake setup hook after it having been manually set in a few packages earlier that year.

In 2016 an attempt was made to change from -DCMAKE_SKIP_BUILD_RPATH=ON to -DCMAKE_BUILD_WITH_INSTALL_RPATH=TRUE, but it was reverted due to a blocking darwin issue: d5d4606. I'm not sure that commit would have fixed this issue, but the discussion that lead up the the revert is worth a read:#15881.

After that revert, -DCMAKE_SKIP_BUILD_RPATH=OFF popped up in various package to workaround this issue.

I wonder if we could try removing it again, possibly only for Linux?

I'd highly appreciate that. I've had the same issue too. 😀

[stale]

Hello, I'm a bot and I thank you in the name of the community for opening this issue.

To help our human contributors focus on the most-relevant reports, I check up on old issues to see if they're still relevant. This issue has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

The community would appreciate your effort in checking if the issue is still valid. If it isn't, please close it.

If the issue persists, and you'd like to remove the stale label, you simply need to leave a comment. Your comment can be as simple as "still important to me". If you'd like it to get more attention, you can ask for help by searching for maintainers and people that previously touched related code and @ mention them in a comment. You can use Git blame or GitHub's web interface on the relevant files to find them.

Lastly, you can always ask for help at our Discourse Forum or at #nixos' IRC channel.

[knedlsepp]

Still important to me.

[knedlsepp]

@LnL7 As this bit me again today while developing on a project, I'm wondering if you could help with fixing this issue. The previous attempt to fix this failed because of some issues on darwin, so you seem like the perfect person to turn to (being both maintainer of cmake and a (the?) top darwin contributor).

[stale]

I marked this as stale due to inactivity. → More info

[Artturin]

pr merged

[Artturin]

can someone add a section to @jtojnar's https://github.com/jtojnar/cmake-snips on how to fix this without
"-DCMAKE_SKIP_BUILD_RPATH=ON" workaround

#181243
#181540

the errors are
# RPATH of binary /nix/store/.../bin/... contains a forbidden reference to /build/
# file RPATH_CHANGE could not write new RPATH

example of a error

https://hydra.nixos.org/build/183517097/log
https://github.com/SIPp/sipp/blob/f44d0cf5dec0013eff8fd7b4da885d455aa82e0e/CMakeLists.txt#L125

Install the project...
-- Install configuration: "Release"
-- Installing: /nix/store/wm6dndxvsnsxfv95dm3vgg7jm6b1vkzi-sipp-3.6.1/bin/sipp
CMake Error at cmake_install.cmake:55 (file):
  file RPATH_CHANGE could not write new RPATH:

    

  to the file:

    /nix/store/wm6dndxvsnsxfv95dm3vgg7jm6b1vkzi-sipp-3.6.1/bin/sipp

  The current RUNPATH is:

    /nix/store/wm6dndxvsnsxfv95dm3vgg7jm6b1vkzi-sipp-3.6.1/lib64:/nix/store/wm6dndxvsnsxfv95dm3vgg7jm6b1vkzi-sipp-3.6.1/lib:/nix/store/pkv4ngqc7arfqpr1bsn1bappvms9xbfg-ncurses-6.3-p20220507/lib:/nix/store/ff98lqrrlndgcai7hjrw50pjgdfmnixr-libpcap-1.10.1/lib:/nix/store/c8fc7saagp0vm5ll5mccpfnhg957pfya-openssl-1.1.1q/lib:/nix/store/x4h0a3mv3mw2sv3j2ysrl4wsacfrg7kq-lksctp-tools-1.0.17/lib:/nix/store/mhhlymrg2m70r8h94cwhv2d7a0c8l7g6-glibc-2.34-210/lib:/nix/store/xjmm9xg5sq47q63cbf447qalz9fmwp0v-gcc-11.3.0-lib/lib

  which does not contain:

    /var/empty/local/lib:

  as was expected.


make: *** [Makefile:100: install] Error 1

[lopsided98]

What actually is the root cause of the # RPATH of binary ... contains a forbidden reference to /build/ error? I can't seem to find any examples where that has been fixed without setting -DCMAKE_SKIP_BUILD_RPATH=ON.

[bjornfor]

What actually is the root cause of the # RPATH of binary ... contains a forbidden reference to /build/ error? I can't seem to find any examples where that has been fixed without setting -DCMAKE_SKIP_BUILD_RPATH=ON.

AFAIK, it's due to bad cmake code in upstream projects. If the cmake code installs binaries with install(FILES ...) or install(DIRECTORY ...), instead of the proper install(TARGETS ...), then cmake will not fixup the rpath in the binaries inside the install tree. The nixpkgs setup-hook audit-tmpdir.sh then detects the bad rpath reference and emits RPATH of binary $i contains a forbidden reference to $TMPDIR/".