Meson doesn't set LD_LIBRARY_PATH when executables in builddir are used to run custom_target · mesonbuild/meson#2881

(9 comments) (0 reactions) (0 assignees)Python (4,978 stars) (1,465 forks)batch import

OS:*BSDbugcompilersgeneratorshelp wanted

Description

colord uses custom_target to run cd-create-profile to generate icc files during the build. cd-create-profile is an executable built from the same source tree, which should have RPATH set by Meson. However, FreeBSD configures its compiler to pass --enable-new-dtags to the linker, so RPATH are converted to RUNPATH. If users have LD_LIBRARY_PATH set in the environment, it will override RUNPATH and cause cd-create-profile to fail to run because the runtime linker picks the already installed libcolordprivate.so.2 from LD_LIBRARY_PATH instead of the one built in builddir.

$ ninja
[108/215] Generating AppleRGB.icc with a custom command.
FAILED: data/profiles/AppleRGB.icc 
/home/lantw44/gnome/build/colord/client/cd-create-profile --output=data/profiles/AppleRGB.icc data/profiles/AppleRGB.iccprofile.xml
/home/lantw44/gnome/build/colord/client/cd-create-profile: Undefined symbol "cd_icc_set_created"
[109/215] Generating AdobeRGB1998.icc with a custom command.
FAILED: data/profiles/AdobeRGB1998.icc 
/home/lantw44/gnome/build/colord/client/cd-create-profile --output=data/profiles/AdobeRGB1998.icc data/profiles/AdobeRGB1998.iccprofile.xml
/home/lantw44/gnome/build/colord/client/cd-create-profile: Undefined symbol "cd_icc_set_created"
[111/215] Generating BestRGB.icc with a custom command.
FAILED: data/profiles/BestRGB.icc 
/home/lantw44/gnome/build/colord/client/cd-create-profile --output=data/profiles/BestRGB.icc data/profiles/BestRGB.iccprofile.xml
/home/lantw44/gnome/build/colord/client/cd-create-profile: Undefined symbol "cd_icc_set_created"
$ chrpath /home/lantw44/gnome/build/colord/client/cd-create-profile
/home/lantw44/gnome/build/colord/client/cd-create-profile: RUNPATH=$ORIGIN/../lib/colord

It seems there are some similar issues for tests: #1383, #1635.

I know I can workaround it by using a shell script to set LD_LIBRARY_PATH and run cd-create-profile, but it will become a problem if I have to patch all projects using uninstalled executables to run custom_target.

Contributor guide

Tech stack: pythonshell
Domain: build system
Issue type: bug
Difficulty: 4
Estimated time: 3-5 days
Activity status: stale
Clarity: clear
Prerequisites: Knowledge of RPATH and RUNPATHUnderstanding Meson's custom targetExperience with build system debuggingFamiliarity with environment variable handling
Newbie friendliness: 20
Research direction: Examine how Meson sets the environment for executables run via custom target in the build directory, particularly focusing on how LD LIBRARY PATH is handled. Compare with the existing handling for tests (issues #1383 and #1635). Investigate the Meson source code, likely in the `mesonbuild/scripts` or `mesonbuild/backend` directories, to find where custom commands are executed. The fix could involve ensuring that LD LIBRARY PATH is set to include the build directory's library paths for custom target executions, or alternatively, modifying the linker flags to use RPATH instead of RUNPATH when building executables used during the build.