CMake: Refactor external dependencies handling
authorSergey Sharybin <sergey.vfx@gmail.com>
Mon, 20 Jan 2020 17:36:19 +0000 (18:36 +0100)
committerSergey Sharybin <sergey.vfx@gmail.com>
Thu, 23 Jan 2020 15:59:18 +0000 (16:59 +0100)
commit517870a4a11f660c71d3901818fbb09798cb2d7d
tree11773a96b156339b5168e94ae0968929fdce2025
parent544ee7a4f2f81094967559dfd1dd21ae9f4b9809
CMake: Refactor external dependencies handling

This is a more correct fix to the issue Brecht was fixing in D6600.

While the fix in that patch worked fine for linking it broke ASAN
runtime under some circumstances.
For example, `make full debug developer` would compile, but trying
to start blender will cause assert failure in ASAN (related on check
that ASAN is not running already).

Top-level idea: leave it to CMake to keep track of dependency graph.

The root of the issue comes to the fact that target like "blender" is
configured to use a lot of static libraries coming from Blender sources
and to use external static libraries. There is nothing which ensures
order between blender's and external libraries. Only order of blender
libraries is guaranteed.

It was possible that due to a cycle or other circumstances some of
blender libraries would have been passed to linker after libraries
it uses, causing linker errors.

For example, this order will likely fail:

  libbf_blenfont.a libfreetype6.a libbf_blenfont.a

This change makes it so blender libraries are explicitly provided
their dependencies to an external libraries, which allows CMake to
ensure they are always linked against them.

General rule here: if bf_foo depends on an external library it is
to be provided to LIBS for bf_foo.
For example, if bf_blenkernel depends on opensubdiv then LIBS in
blenkernel's CMakeLists.txt is to include OPENSUBDIB_LIBRARIES.

The change is made based on searching for used include folders
such as OPENSUBDIV_INCLUDE_DIRS and adding corresponding libraries
to LIBS ion that CMakeLists.txt. Transitive dependencies are not
simplified by this approach, but I am not aware of any downside of
this: CMake should be smart enough to simplify them on its side.
And even if not, this shouldn't affect linking time.

Benefit of not relying on transitive dependencies is that build
system is more robust towards future changes. For example, if
bf_intern_opensubiv is no longer depends on OPENSUBDIV_LIBRARIES
and all such code is moved to bf_blenkernel this will not break
linking.

The not-so-trivial part is change to blender_add_lib (and its
version in Cycles). The complexity is caused by libraries being
provided as a single list argument which doesn't allow to use
different release and debug libraries on Windows. The idea is:

- Have every library prefixed as "optimized" or "debug" if
  separation is needed (non-prefixed libraries will be considered
  "generic").

- Loop through libraries passed to function and do simple parsing
  which will look for "optimized" and "debug" words and specify
  following library to corresponding category.

This isn't something particularly great. Alternative would be to
use target_link_libraries() directly, which sounds like more code
but which is more explicit and allows to have more flexibility
and control comparing to wrapper approach.

Tested the following configurations on Linux, macOS and Windows:

- make full debug developer
- make full release developer
- make lite debug developer
- make lite release developer

NOTE: Linux libraries needs to be compiled with D6641 applied,
otherwise, depending on configuration, it's possible to run into
duplicated zlib symbols error.

Differential Revision: https://developer.blender.org/D6642
57 files changed:
CMakeLists.txt
build_files/cmake/macros.cmake
build_files/cmake/platform/platform_apple.cmake
build_files/cmake/platform/platform_unix.cmake
build_files/cmake/platform/platform_win32.cmake
extern/ceres/CMakeLists.txt
extern/ceres/bundle.sh
extern/mantaflow/CMakeLists.txt
extern/quadriflow/CMakeLists.txt
intern/audaspace/CMakeLists.txt
intern/cycles/blender/CMakeLists.txt
intern/cycles/bvh/CMakeLists.txt
intern/cycles/cmake/macros.cmake
intern/cycles/device/CMakeLists.txt
intern/cycles/graph/CMakeLists.txt
intern/cycles/kernel/osl/CMakeLists.txt
intern/cycles/render/CMakeLists.txt
intern/ghost/CMakeLists.txt
intern/libmv/CMakeLists.txt
intern/libmv/bundle.sh
intern/locale/CMakeLists.txt
intern/mantaflow/CMakeLists.txt
intern/opencolorio/CMakeLists.txt
intern/opensubdiv/CMakeLists.txt
intern/openvdb/CMakeLists.txt
intern/quadriflow/CMakeLists.txt
intern/rigidbody/CMakeLists.txt
source/blender/alembic/CMakeLists.txt
source/blender/avi/CMakeLists.txt
source/blender/blenfont/CMakeLists.txt
source/blender/blenkernel/CMakeLists.txt
source/blender/blenlib/CMakeLists.txt
source/blender/blentranslation/msgfmt/CMakeLists.txt
source/blender/bmesh/CMakeLists.txt
source/blender/collada/CMakeLists.txt
source/blender/compositor/CMakeLists.txt
source/blender/editors/sound/CMakeLists.txt
source/blender/editors/space_graph/CMakeLists.txt
source/blender/editors/space_sequencer/CMakeLists.txt
source/blender/freestyle/CMakeLists.txt
source/blender/gpu/CMakeLists.txt
source/blender/imbuf/CMakeLists.txt
source/blender/imbuf/intern/oiio/CMakeLists.txt
source/blender/imbuf/intern/openexr/CMakeLists.txt
source/blender/makesrna/intern/CMakeLists.txt
source/blender/nodes/CMakeLists.txt
source/blender/physics/CMakeLists.txt
source/blender/python/bmesh/CMakeLists.txt
source/blender/python/generic/CMakeLists.txt
source/blender/python/gpu/CMakeLists.txt
source/blender/python/intern/CMakeLists.txt
source/blender/python/mathutils/CMakeLists.txt
source/blender/usd/CMakeLists.txt
source/blender/windowmanager/CMakeLists.txt
tests/gtests/alembic/CMakeLists.txt
tests/gtests/blenlib/CMakeLists.txt
tests/gtests/usd/CMakeLists.txt