LTO is forcefully enabled instead of by default in the build system

[davidhozic]

Intro

Hi!

I am a student (in a few days researcher) at University of Ljubljana, I use MuJoCo for my research on RL.

My setup

MuJoCo 3.3.7. Other info is irrelevant.

What's happening? What did you expect?

A few CMake files contain forceful set of the CMake variable CMAKE_INTERPROCEDURAL_OPTIMIZATION (LTO).

• mujoco/cmake/MujocoOptions.cmake

  Lines 107 to 109 in 36bed9a

  	if(NOT CMAKE_INTERPROCEDURAL_OPTIMIZATION AND (CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE STREQUAL "Debug"))
  	set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
  	endif()

• mujoco/sample/cmake/SampleOptions.cmake

  Lines 107 to 109 in 36bed9a

  	if(NOT CMAKE_INTERPROCEDURAL_OPTIMIZATION AND (CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE STREQUAL "Debug"))
  	set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
  	endif()

• mujoco/simulate/cmake/SimulateOptions.cmake

  Lines 107 to 109 in 36bed9a

  	if(NOT CMAKE_INTERPROCEDURAL_OPTIMIZATION AND (CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE STREQUAL "Debug"))
  	set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
  	endif()

This causes problems whenever the compiled (static) libraries may be used with a different linker, which is now the case for the Rust language on the default Linux target (they switched to rust-lld).

As a result of the forceful enable, the compiled library files contain additional information that is only compatible with the same linker. See the following issue: rust-lang/rust#146952.

Based on the commit message that added the forceful enable of LTO, the plan was to enable it by default, not permanently.

Several CI files also contain commands where this is explicitly disabled (

mujoco/.github/workflows/build.yml

Line 178 in 36bed9a

-DCMAKE_INTERPROCEDURAL_OPTIMIZATION:BOOL=OFF

), but as the result of the given lines inside CMake option files, nothing changes.

Steps for reproduction

1. Compile with CMAKE_INTERPROCEDURAL_OPTIMIZATION disabled from the console
2. CMAKE_INTERPROCEDURAL_OPTIMIZATION (LTO) is still enabled

Minimal model for reproduction

Irrelevant

Code required for reproduction

Irrelevant

Confirmations

• I searched the latest documentation thoroughly before posting.
• I searched previous Issues and Discussions, I am certain this has not been raised before.

[davidhozic]

Would it be suitable to just remove those lines? I tried changing them to a CACHE variable but then everything just fails with no explanation (I guess CMake special options don't support CACHE).

[saran-t]

Can we change the conditional to if(NOT DEFINED CMAKE_INTERPROCEDURAL_OPTIMIZATION...)?

[davidhozic]

Can we change the conditional to if(NOT DEFINED CMAKE_INTERPROCEDURAL_OPTIMIZATION...)?

That won't work because this variable is defined by default.

I think the best way to only enable it by default is by making another CMake option with a default value and then setting the CMAKE_INTERPROCEDURAL_OPTIMIZATION to that option.

Edit:

I tried using if(NOT DEFINED CMAKE_INTERPROCEDURAL_OPTIMIZATION and it is confirmed that the variable is defined by default so adding an option, like described above, should work best.

It would just need to be documented somewhere that CMAKE_INTERPROCEDURAL_OPTIMIZATION is not to be used.

[Yoshi-Sama-lab]

Maybe this can work?

option(MUJOCO_ENABLE_LTO ON)
if(MUJOCO_ENABLE_LTO AND CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
  set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
endif()

[davidhozic]

Maybe this can work?

option(MUJOCO_ENABLE_LTO ON)
if(MUJOCO_ENABLE_LTO AND CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
  set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
endif()

That's not alright, as it ignores LTO value on Debug builds. The pull request #2913 solves this properly.