Skip to contentSkip to conversation

cmake.bbclass: set the rpath for binaries build with cmake to ${libdir}

PATCH In review Simon Busch 2 participants 11 messages May 4, 2011 – May 5, 2011

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 cmake.bbclass: set the rpath for binaries build with cmake to ${libdir}

In the default configuration cmake does not set a rpath for its builded binaries. This leads to errors at runtime when the binaries not find their needed runtime libraries.

---
 classes/cmake.bbclass |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
classes/cmake.bbclass +4 -0
index 40fadea..5f7066b 100644
@@ -44,6 +44,10 @@ cmake_do_generate_toolchain_file() {
   echo "set( CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY )" >> ${WORKDIR}/toolchain.cmake
 # Use qt.conf settings
   echo "set( ENV{QT_CONF_PATH} ${WORKDIR}/qt.conf )" >> ${WORKDIR}/toolchain.cmake
+
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${libdir} )" >> ${WORKDIR}/toolchain.cmake
 }
 
 addtask generate_toolchain_file after do_patch before do_configure
Signature · 1 line
1.7.4.1
#1 lore raw

classes/cmake.bbclass cmake_do_generate_toolchain_file() { · line 50

Quoted 3 lines · Simon Busch
classes/cmake.bbclass +3 -0
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${libdir} )" >> ${WORKDIR}/toolchain.cmake

Shouldn't this be inside some kind of guard for native? You don't want rpath in target binaries, do you?

p.

#2 lore raw
Quoted 7 lines · Phil Blundell

classes/cmake.bbclass cmake_do_generate_toolchain_file() { · line 50

Quoted 3 lines · Simon Busch
classes/cmake.bbclass +3 -0
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${libdir} )" >> ${WORKDIR}/toolchain.cmake

Shouldn't this be inside some kind of guard for native? You don't want rpath in target binaries, do you?

Thanks for the hint!

You mean something like:

if not bb.data.inherits_class('native', d)
and not bb.data.inherits_class('cross', d):

[...]

?

regards,
Simon

#3 lore raw
Quoted 9 lines · Simon Busch
Quoted 7 lines · Phil Blundell

classes/cmake.bbclass cmake_do_generate_toolchain_file() { · line 50

Quoted 3 lines · Simon Busch
classes/cmake.bbclass +3 -0
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${libdir} )" >> ${WORKDIR}/toolchain.cmake

Shouldn't this be inside some kind of guard for native? You don't want rpath in target binaries, do you?

Quoted 6 lines

Thanks for the hint!

You mean something like:

if not bb.data.inherits_class('native', d)
and not bb.data.inherits_class('cross', d):

I think you have the sense backwards but yes, that's the general idea. Though I must admit I don't quite understand why the rpath setting from BUILD_LDFLAGS is not turning up in cmake's final link. It might be worth investigating why that isn't working for you in case this patch is just papering over some deeper problem.

p.

#4 lore raw
Quoted 14 lines · Phil Blundell
Quoted 13 lines · Simon Busch
Quoted 7 lines · Phil Blundell

classes/cmake.bbclass cmake_do_generate_toolchain_file() { · line 50

Quoted 3 lines · Simon Busch
classes/cmake.bbclass +3 -0
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${libdir} )" >> ${WORKDIR}/toolchain.cmake

Shouldn't this be inside some kind of guard for native? You don't want rpath in target binaries, do you?

Thanks for the hint!

You mean something like:

Quoted 8 lines
Quoted 2 lines

if not bb.data.inherits_class('native', d)
and not bb.data.inherits_class('cross', d):

I think you have the sense backwards but yes, that's the general idea. Though I must admit I don't quite understand why the rpath setting from BUILD_LDFLAGS is not turning up in cmake's final link. It might be worth investigating why that isn't working for you in case this patch is just papering over some deeper problem.

I alreay searched through the cmake documentation and it says that the rpath is set with the content of the CMAKE_INSTALL_RPATH variable. The default value of CMAKE_INSTALL_RPATH is ""[1]. As currently nothing sets it to another value the rpath is never set during the build for the resulting binaries. I send another patch which does the solution mentioned above the right way.

regards,
Simon

[1]: http://www.cmake.org/Wiki/CMake_RPATH_handling

#5 lore raw
Quoted 6 lines · Simon Busch

I alreay searched through the cmake documentation and it says that the rpath is set with the content of the CMAKE_INSTALL_RPATH variable. The default value of CMAKE_INSTALL_RPATH is ""[1]. As currently nothing sets it to another value the rpath is never set during the build for the resulting binaries. I send another patch which does the solution mentioned above the right way.

Oh right, I see. So cmake is actually stripping the rpaths during the install step unless you tell it that you want them included?

In that case, yeah, your plan seems reasonable.

p.

#6 lore raw
Quoted 8 lines · Phil Blundell
Quoted 6 lines · Simon Busch

I alreay searched through the cmake documentation and it says that the rpath is set with the content of the CMAKE_INSTALL_RPATH variable. The default value of CMAKE_INSTALL_RPATH is ""[1]. As currently nothing sets it to another value the rpath is never set during the build for the resulting binaries. I send another patch which does the solution mentioned above the right way.

Quoted 4 lines

Oh right, I see. So cmake is actually stripping the rpaths during the install step unless you tell it that you want them included?

In that case, yeah, your plan seems reasonable.

Ok, so you are fine with the patch?

regards,
Simon

Acked-by
#7 lore raw
Quoted 9 lines · Simon Busch
Quoted 8 lines · Phil Blundell
Quoted 6 lines · Simon Busch

I alreay searched through the cmake documentation and it says that the rpath is set with the content of the CMAKE_INSTALL_RPATH variable. The default value of CMAKE_INSTALL_RPATH is ""[1]. As currently nothing sets it to another value the rpath is never set during the build for the resulting binaries. I send another patch which does the solution mentioned above the right way.

Quoted 6 lines
Quoted 4 lines

Oh right, I see. So cmake is actually stripping the rpaths during the install step unless you tell it that you want them included?

In that case, yeah, your plan seems reasonable.

Ok, so you are fine with the patch?

Yup. My only remaining concern was that it seemed a bit unwholesome to do:

+ echo "set( CMAKE_INSTALL_RPATH ${OECMAKE_RPATH} )" >> ${WORKDIR}/toolchain.cmake

when OECMAKE_RPATH might be empty, and maybe it'd have been better to bracket that echo with "if [ -n ${OECMAKE_RPATH} ] ...". But if you've tested it and cmake does the right thing then I guess it's fine as it stands.

p.

#8 lore raw
Quoted 20 lines · Phil Blundell
Quoted 9 lines · Simon Busch
Quoted 8 lines · Phil Blundell
Quoted 6 lines · Simon Busch

I alreay searched through the cmake documentation and it says that the rpath is set with the content of the CMAKE_INSTALL_RPATH variable. The default value of CMAKE_INSTALL_RPATH is ""[1]. As currently nothing sets it to another value the rpath is never set during the build for the resulting binaries. I send another patch which does the solution mentioned above the right way.

Quoted 6 lines
Quoted 4 lines

Oh right, I see. So cmake is actually stripping the rpaths during the install step unless you tell it that you want them included?

In that case, yeah, your plan seems reasonable.

Ok, so you are fine with the patch?

Yup. My only remaining concern was that it seemed a bit unwholesome to do:

Quoted 8 lines

+ echo "set( CMAKE_INSTALL_RPATH ${OECMAKE_RPATH} )" >> ${WORKDIR}/toolchain.cmake

when OECMAKE_RPATH might be empty, and maybe it'd have been better to bracket that echo with "if [ -n ${OECMAKE_RPATH} ] ...". But if you've tested it and cmake does the right thing then I guess it's fine as it stands.

Ok, thanks for your help. Patch is now pushed but somehow cgit got the line breaks wrong while local git is showing them correctly ...

regards,
Simon

#9 lore raw

PATCH 1/1 cmake.bbclass: set the rpath for native binaries build with cmake

In reply to Simon Busch

In the default configuration cmake does not set a rpath for its builded binaries. This leads to errors at runtime when the binaries not find their needed runtime libraries. Please note that this is only done for recipes inheriting the native class!

---
 classes/cmake.bbclass |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
classes/cmake.bbclass +11 -0
index 40fadea..e8e485a 100644
@@ -24,6 +24,13 @@ OECMAKE_CXX_FLAGS ?= "${HOST_CC_ARCH} ${TOOLCHAIN_OPTIONS} ${TARGET_CPPFLAGS} -f
 OECMAKE_C_FLAGS_RELEASE ?= "${SELECTED_OPTIMIZATION} -DNDEBUG"
 OECMAKE_CXX_FLAGS_RELEASE ?= "${SELECTED_OPTIMIZATION} -DNDEBUG"
 
+OECMAKE_RPATH ?= ""
+python __anonymous() {
+    # Only set OECMAKE_RPATH if we build a native recipe
+    if bb.data.inherits_class('native', d) and not bb.data.inherits_class('cross', d):
+        bb.data.setVar('OECMAKE_RPATH', '${libdir}', d)
+}
+
 cmake_do_generate_toolchain_file() {
 # CMake system name must be something like "Linux".
 # This is important for cross-compiling.
@@ -44,6 +51,10 @@ cmake_do_generate_toolchain_file() {
   echo "set( CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY )" >> ${WORKDIR}/toolchain.cmake
 # Use qt.conf settings
   echo "set( ENV{QT_CONF_PATH} ${WORKDIR}/qt.conf )" >> ${WORKDIR}/toolchain.cmake
+
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${OECMAKE_RPATH} )" >> ${WORKDIR}/toolchain.cmake
 }
 
 addtask generate_toolchain_file after do_patch before do_configure
Signature · 1 line
1.7.4.1
#10 lore raw

Re: [PATCH] cmake.bbclass: set the rpath for native binaries build with cmake

Quoted 28 lines · Simon Busch

In the default configuration cmake does not set a rpath for its builded binaries. This leads to errors at runtime when the binaries not find their needed runtime libraries. Please note that this is only done for recipes inheriting the native class!

---
 classes/cmake.bbclass |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
classes/cmake.bbclass +7 -0
index 40fadea..e8e485a 100644
@@ -24,6 +24,13 @@ OECMAKE_CXX_FLAGS ?= "${HOST_CC_ARCH} ${TOOLCHAIN_OPTIONS} ${TARGET_CPPFLAGS} -f
 OECMAKE_C_FLAGS_RELEASE ?= "${SELECTED_OPTIMIZATION} -DNDEBUG"
 OECMAKE_CXX_FLAGS_RELEASE ?= "${SELECTED_OPTIMIZATION} -DNDEBUG"
 
+OECMAKE_RPATH ?= ""
+python __anonymous() {
+    # Only set OECMAKE_RPATH if we build a native recipe
+    if bb.data.inherits_class('native', d) and not bb.data.inherits_class('cross', d):
+        bb.data.setVar('OECMAKE_RPATH', '${libdir}', d)
+}
+
 cmake_do_generate_toolchain_file() {
 # CMake system name must be something like "Linux".
 # This is important for cross-compiling.

classes/cmake.bbclass cmake_do_generate_toolchain_file() { · line 60

Quoted 10 lines
classes/cmake.bbclass +4 -0
@@ -44,6 +51,10 @@ cmake_do_generate_toolchain_file() {
   echo "set( CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY )" >> ${WORKDIR}/toolchain.cmake
 # Use qt.conf settings
   echo "set( ENV{QT_CONF_PATH} ${WORKDIR}/qt.conf )" >> ${WORKDIR}/toolchain.cmake
+
+# We need to set the rpath to the correct directory as cmake does not provide any
+# directory as rpath by default
+  echo "set( CMAKE_INSTALL_RPATH ${OECMAKE_RPATH} )" >> ${WORKDIR}/toolchain.cmake
 }
 
 addtask generate_toolchain_file after do_patch before do_configure

To proof this: I tested it with native and non-native recipes (all builded with cmake.bbclass) and grep'ed through the resulting binaries afterwards to be sure there is a rpath in the native ones (and the correct one) and no one in the non native recipes:

morphis@nirvana ...root/tmp/sysroots/x86_64-linux/usr/bin % objdump -x generatorrunner | grep RPATH
RPATH $ORIGIN/../lib:$ORIGIN/../lib

morphis@nirvana ...libshiboken-1.0.2-r0.0/package/usr/lib % pwd /home/morphis/oe/buildroot/tmp/work/armv7a-oe-linux-gnueabi/libshiboken-1.0.2-r0.0/package/usr/lib morphis@nirvana ...libshiboken-1.0.2-r0.0/package/usr/lib % objdump -x libshiboken-python2.6.so.1.0.2 | grep RPATH
1 morphis@nirvana ...libshiboken-1.0.2-r0.0/package/usr/lib %

[...]

regards,
Simon