2020-09-04 16:41:10 +00:00
|
|
|
# Copyright 2011-2020 Blender Foundation
|
|
|
|
|
#
|
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
|
#
|
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
#
|
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
2018-02-03 23:38:27 +00:00
|
|
|
function(cycles_set_solution_folder target)
|
|
|
|
|
if(WINDOWS_USE_VISUAL_STUDIO_FOLDERS)
|
|
|
|
|
get_filename_component(folderdir ${CMAKE_CURRENT_SOURCE_DIR} DIRECTORY)
|
|
|
|
|
string(REPLACE ${CMAKE_SOURCE_DIR} "" folderdir ${folderdir})
|
|
|
|
|
set_target_properties(${target} PROPERTIES FOLDER ${folderdir})
|
|
|
|
|
endif()
|
|
|
|
|
endfunction()
|
|
|
|
|
|
2019-04-16 04:11:27 +00:00
|
|
|
macro(cycles_add_library target library_deps)
|
2018-02-03 23:38:27 +00:00
|
|
|
add_library(${target} ${ARGN})
|
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
2020-01-20 17:36:19 +00:00
|
|
|
|
|
|
|
|
# On Windows certain libraries have two sets of binaries: one for debug builds and one for
|
|
|
|
|
# release builds. The root of this requirement goes into ABI, I believe, but that's outside
|
|
|
|
|
# of a scope of this comment.
|
|
|
|
|
#
|
|
|
|
|
# CMake have a native way of dealing with this, which is specifying what build type the
|
|
|
|
|
# libraries are provided for:
|
|
|
|
|
#
|
|
|
|
|
# target_link_libraries(tagret optimized|debug|general <libraries>)
|
|
|
|
|
#
|
|
|
|
|
# The build type is to be provided as a separate argument to the function.
|
|
|
|
|
#
|
|
|
|
|
# CMake's variables for libraries will contain build type in such cases. For example:
|
|
|
|
|
#
|
|
|
|
|
# set(FOO_LIBRARIES optimized libfoo.lib debug libfoo_d.lib)
|
|
|
|
|
#
|
|
|
|
|
# Complications starts with a single argument for library_deps: all the elements are being
|
|
|
|
|
# put to a list: "${FOO_LIBRARIES}" will become "optimized;libfoo.lib;debug;libfoo_d.lib".
|
|
|
|
|
# This makes it impossible to pass it as-is to target_link_libraries sine it will treat
|
|
|
|
|
# this argument as a list of libraries to be linked against, causing missing libraries
|
|
|
|
|
# for optimized.lib.
|
|
|
|
|
#
|
|
|
|
|
# What this code does it traverses library_deps and extracts information about whether
|
|
|
|
|
# library is to provided as general, debug or optimized. This is a little state machine which
|
|
|
|
|
# keeps track of whiuch build type library is to provided for:
|
|
|
|
|
#
|
|
|
|
|
# - If "debug" or "optimized" word is found, the next element in the list is expected to be
|
|
|
|
|
# a library which will be passed to target_link_libraries() under corresponding build type.
|
|
|
|
|
#
|
|
|
|
|
# - If there is no "debug" or "optimized" used library is specified for all build types.
|
|
|
|
|
#
|
|
|
|
|
# NOTE: If separated libraries for debug and release ar eneeded every library is the list are
|
|
|
|
|
# to be prefixed explicitly.
|
|
|
|
|
#
|
|
|
|
|
# Use: "optimized libfoo optimized libbar debug libfoo_d debug libbar_d"
|
|
|
|
|
# NOT: "optimized libfoo libbar debug libfoo_d libbar_d"
|
|
|
|
|
#
|
|
|
|
|
# TODO(sergey): This is the same as Blender's side CMake. Find a way to avoid duplication
|
|
|
|
|
# somehow in a way which allows to have Cycles standalone.
|
|
|
|
|
if(NOT "${library_deps}" STREQUAL "")
|
|
|
|
|
set(next_library_mode "")
|
|
|
|
|
foreach(library ${library_deps})
|
|
|
|
|
string(TOLOWER "${library}" library_lower)
|
|
|
|
|
if(("${library_lower}" STREQUAL "optimized") OR
|
|
|
|
|
("${library_lower}" STREQUAL "debug"))
|
|
|
|
|
set(next_library_mode "${library_lower}")
|
|
|
|
|
else()
|
|
|
|
|
if("${next_library_mode}" STREQUAL "optimized")
|
|
|
|
|
target_link_libraries(${target} optimized ${library})
|
|
|
|
|
elseif("${next_library_mode}" STREQUAL "debug")
|
|
|
|
|
target_link_libraries(${target} debug ${library})
|
|
|
|
|
else()
|
|
|
|
|
target_link_libraries(${target} ${library})
|
|
|
|
|
endif()
|
|
|
|
|
set(next_library_mode "")
|
|
|
|
|
endif()
|
|
|
|
|
endforeach()
|
2019-04-16 04:11:27 +00:00
|
|
|
endif()
|
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
2020-01-20 17:36:19 +00:00
|
|
|
|
2018-02-03 23:38:27 +00:00
|
|
|
cycles_set_solution_folder(${target})
|
|
|
|
|
endmacro()
|
2020-09-04 16:41:10 +00:00
|
|
|
|
|
|
|
|
# Cycles library dependencies common to all executables
|
|
|
|
|
|
CMake/macOS: Remove _LIBPATH, avoid link_directories.
After tests were bundled in a single executable and cycles and libmv
created their own tests, the warnings on macOS have gone over 800.
The reason is setting `*_LIBRARIES` to names of the libraries
and later using `link_directories` to link them properly.
https://cmake.org/cmake/help/latest/command/link_directories.html
> Note This command is rarely necessary and should be avoided where
> there are other choices. Prefer to pass full absolute paths to
> libraries where possible, since this ensures the correct library
> will always be linked. The find_library() command provides the
> full path, which can generally be used directly in calls to
> target_link_libraries().
Warnings like the following popup for every target/executable,
for every library it links to.
```
ld: warning: directory not found for option
'-L/Users/me/blender-build/blender/../lib/darwin/jpeg/lib/Debug'
```
The patch completes a step towards removing `link_directories` as
mentioned in TODO at several places.
The patch uses absolute paths to link libraries and removes
all `*_LIBPATH`s except `PYTHON_LIBPATH` from
`platform_apple.cmake` file. (The corner case where it's used seems
like dead code. Python is no longer shipped with that file structure.)
Also, unused code for LLVM-3.4 has been removed.
Also, guards to avoid searching libraries in system directories have
been added.
`APPLE` platform now no longer needs `setup_libdirs`,
`cycles_link_directories`, and `link_directories`.
The number of warnings now is less than 100, most of them being
deprecation ones in dependencies.
This patch depended on {rBb746179d0add}, {rB2fdbe4d05011},
{rB402a4cadba49} and {rBd7f482f88ecb}.
Reviewed By: brecht
Differential Revision: https://developer.blender.org/D8855
2020-10-08 14:01:40 +00:00
|
|
|
function(cycles_link_directories)
|
|
|
|
|
if(APPLE)
|
|
|
|
|
# APPLE plaform uses full paths for linking libraries, and avoids link_directories.
|
|
|
|
|
return()
|
2020-10-12 13:21:48 +00:00
|
|
|
endif()
|
CMake/macOS: Remove _LIBPATH, avoid link_directories.
After tests were bundled in a single executable and cycles and libmv
created their own tests, the warnings on macOS have gone over 800.
The reason is setting `*_LIBRARIES` to names of the libraries
and later using `link_directories` to link them properly.
https://cmake.org/cmake/help/latest/command/link_directories.html
> Note This command is rarely necessary and should be avoided where
> there are other choices. Prefer to pass full absolute paths to
> libraries where possible, since this ensures the correct library
> will always be linked. The find_library() command provides the
> full path, which can generally be used directly in calls to
> target_link_libraries().
Warnings like the following popup for every target/executable,
for every library it links to.
```
ld: warning: directory not found for option
'-L/Users/me/blender-build/blender/../lib/darwin/jpeg/lib/Debug'
```
The patch completes a step towards removing `link_directories` as
mentioned in TODO at several places.
The patch uses absolute paths to link libraries and removes
all `*_LIBPATH`s except `PYTHON_LIBPATH` from
`platform_apple.cmake` file. (The corner case where it's used seems
like dead code. Python is no longer shipped with that file structure.)
Also, unused code for LLVM-3.4 has been removed.
Also, guards to avoid searching libraries in system directories have
been added.
`APPLE` platform now no longer needs `setup_libdirs`,
`cycles_link_directories`, and `link_directories`.
The number of warnings now is less than 100, most of them being
deprecation ones in dependencies.
This patch depended on {rBb746179d0add}, {rB2fdbe4d05011},
{rB402a4cadba49} and {rBd7f482f88ecb}.
Reviewed By: brecht
Differential Revision: https://developer.blender.org/D8855
2020-10-08 14:01:40 +00:00
|
|
|
|
2020-09-04 16:41:10 +00:00
|
|
|
if(WITH_OPENCOLORIO)
|
|
|
|
|
link_directories(${OPENCOLORIO_LIBPATH})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENVDB)
|
|
|
|
|
link_directories(${OPENVDB_LIBPATH} ${BLOSC_LIBPATH})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENSUBDIV)
|
|
|
|
|
link_directories(${OPENSUBDIV_LIBPATH})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENIMAGEDENOISE)
|
|
|
|
|
link_directories(${OPENIMAGEDENOISE_LIBPATH})
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
link_directories(
|
|
|
|
|
${OPENIMAGEIO_LIBPATH}
|
|
|
|
|
${BOOST_LIBPATH}
|
|
|
|
|
${PNG_LIBPATH}
|
|
|
|
|
${JPEG_LIBPATH}
|
|
|
|
|
${ZLIB_LIBPATH}
|
|
|
|
|
${TIFF_LIBPATH}
|
|
|
|
|
${OPENEXR_LIBPATH}
|
|
|
|
|
${OPENJPEG_LIBPATH}
|
|
|
|
|
)
|
CMake/macOS: Remove _LIBPATH, avoid link_directories.
After tests were bundled in a single executable and cycles and libmv
created their own tests, the warnings on macOS have gone over 800.
The reason is setting `*_LIBRARIES` to names of the libraries
and later using `link_directories` to link them properly.
https://cmake.org/cmake/help/latest/command/link_directories.html
> Note This command is rarely necessary and should be avoided where
> there are other choices. Prefer to pass full absolute paths to
> libraries where possible, since this ensures the correct library
> will always be linked. The find_library() command provides the
> full path, which can generally be used directly in calls to
> target_link_libraries().
Warnings like the following popup for every target/executable,
for every library it links to.
```
ld: warning: directory not found for option
'-L/Users/me/blender-build/blender/../lib/darwin/jpeg/lib/Debug'
```
The patch completes a step towards removing `link_directories` as
mentioned in TODO at several places.
The patch uses absolute paths to link libraries and removes
all `*_LIBPATH`s except `PYTHON_LIBPATH` from
`platform_apple.cmake` file. (The corner case where it's used seems
like dead code. Python is no longer shipped with that file structure.)
Also, unused code for LLVM-3.4 has been removed.
Also, guards to avoid searching libraries in system directories have
been added.
`APPLE` platform now no longer needs `setup_libdirs`,
`cycles_link_directories`, and `link_directories`.
The number of warnings now is less than 100, most of them being
deprecation ones in dependencies.
This patch depended on {rBb746179d0add}, {rB2fdbe4d05011},
{rB402a4cadba49} and {rBd7f482f88ecb}.
Reviewed By: brecht
Differential Revision: https://developer.blender.org/D8855
2020-10-08 14:01:40 +00:00
|
|
|
endfunction()
|
2020-09-04 16:41:10 +00:00
|
|
|
|
|
|
|
|
macro(cycles_target_link_libraries target)
|
|
|
|
|
if(WITH_CYCLES_LOGGING)
|
|
|
|
|
target_link_libraries(${target} ${GLOG_LIBRARIES} ${GFLAGS_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_CYCLES_OSL)
|
|
|
|
|
target_link_libraries(${target} ${OSL_LIBRARIES} ${LLVM_LIBRARY})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_CYCLES_EMBREE)
|
|
|
|
|
target_link_libraries(${target} ${EMBREE_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENSUBDIV)
|
|
|
|
|
target_link_libraries(${target} ${OPENSUBDIV_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENCOLORIO)
|
|
|
|
|
target_link_libraries(${target} ${OPENCOLORIO_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENVDB)
|
|
|
|
|
target_link_libraries(${target} ${OPENVDB_LIBRARIES} ${BLOSC_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
if(WITH_OPENIMAGEDENOISE)
|
|
|
|
|
target_link_libraries(${target} ${OPENIMAGEDENOISE_LIBRARIES})
|
|
|
|
|
endif()
|
|
|
|
|
target_link_libraries(
|
|
|
|
|
${target}
|
|
|
|
|
${OPENIMAGEIO_LIBRARIES}
|
|
|
|
|
${PNG_LIBRARIES}
|
|
|
|
|
${JPEG_LIBRARIES}
|
|
|
|
|
${TIFF_LIBRARY}
|
|
|
|
|
${OPENJPEG_LIBRARIES}
|
|
|
|
|
${OPENEXR_LIBRARIES}
|
|
|
|
|
${OPENEXR_LIBRARIES} # For circular dependencies between libs.
|
|
|
|
|
${PUGIXML_LIBRARIES}
|
|
|
|
|
${BOOST_LIBRARIES}
|
|
|
|
|
${ZLIB_LIBRARIES}
|
|
|
|
|
${CMAKE_DL_LIBS}
|
|
|
|
|
${PTHREADS_LIBRARIES}
|
|
|
|
|
${PLATFORM_LINKLIBS}
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
if(WITH_CUDA_DYNLOAD)
|
|
|
|
|
target_link_libraries(${target} extern_cuew)
|
|
|
|
|
else()
|
|
|
|
|
target_link_libraries(${target} ${CUDA_CUDA_LIBRARY})
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(CYCLES_STANDALONE_REPOSITORY)
|
|
|
|
|
target_link_libraries(${target} extern_numaapi)
|
|
|
|
|
else()
|
|
|
|
|
target_link_libraries(${target} bf_intern_numaapi)
|
|
|
|
|
endif()
|
|
|
|
|
|
2020-09-04 17:23:51 +00:00
|
|
|
if(UNIX AND NOT APPLE)
|
2020-09-04 16:41:10 +00:00
|
|
|
if(CYCLES_STANDALONE_REPOSITORY)
|
|
|
|
|
target_link_libraries(${target} extern_libc_compat)
|
|
|
|
|
else()
|
|
|
|
|
target_link_libraries(${target} bf_intern_libc_compat)
|
|
|
|
|
endif()
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(NOT CYCLES_STANDALONE_REPOSITORY)
|
|
|
|
|
target_link_libraries(${target} bf_intern_guardedalloc)
|
|
|
|
|
endif()
|
|
|
|
|
endmacro()
|
|
|
|
|
|
|
|
|
|
macro(cycles_install_libraries target)
|
|
|
|
|
# Copy DLLs for dynamically linked libraries.
|
|
|
|
|
if(WIN32)
|
|
|
|
|
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
|
|
|
|
|
install(
|
|
|
|
|
FILES
|
2020-09-07 13:12:34 +00:00
|
|
|
${TBB_ROOT_DIR}/lib/debug/tbb_debug${CMAKE_SHARED_LIBRARY_SUFFIX}
|
2020-09-04 16:41:10 +00:00
|
|
|
${OPENVDB_ROOT_DIR}/bin/openvdb_d${CMAKE_SHARED_LIBRARY_SUFFIX}
|
2020-09-07 13:12:34 +00:00
|
|
|
DESTINATION $<TARGET_FILE_DIR:${target}>)
|
2020-09-04 16:41:10 +00:00
|
|
|
else()
|
|
|
|
|
install(
|
|
|
|
|
FILES
|
2020-09-07 13:12:34 +00:00
|
|
|
${TBB_ROOT_DIR}/lib/tbb${CMAKE_SHARED_LIBRARY_SUFFIX}
|
2020-09-04 16:41:10 +00:00
|
|
|
${OPENVDB_ROOT_DIR}/bin/openvdb${CMAKE_SHARED_LIBRARY_SUFFIX}
|
2020-09-07 13:12:34 +00:00
|
|
|
DESTINATION $<TARGET_FILE_DIR:${target}>)
|
2020-09-04 16:41:10 +00:00
|
|
|
endif()
|
|
|
|
|
endif()
|
|
|
|
|
endmacro()
|
