Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace vendored SIMD Everywhere by prefix/system install #10961

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/scripts/utils.zsh/setup_ubuntu
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ sudo apt-get install -y --no-install-recommends \
libgl1-mesa-dev \
libjansson-dev \
uthash-dev \
libsimde-dev \
libluajit-5.1-dev python3-dev \
libx11-dev libxcb-randr0-dev libxcb-shm0-dev libxcb-xinerama0-dev \
libxcb-composite0-dev libxinerama-dev libxcb1-dev libx11-xcb-dev libxcb-xfixes0-dev \
Expand Down
1 change: 1 addition & 0 deletions build-aux/com.obsproject.Studio.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"modules/50-vpl-gpu-rt.json",
"modules/90-asio.json",
"modules/90-nlohmann-json.json",
"modules/90-simde.json",
"modules/90-uthash.json",
"modules/90-websocketpp.json",
"modules/99-cef.json",
Expand Down
16 changes: 16 additions & 0 deletions build-aux/modules/90-simde.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "simde",
"buildsystem": "meson",
"builddir": true,
"config-opts": [
"-Dtests=false"
],
"sources": [
{
"type": "git",
"url": "https://github.com/simd-everywhere/simde.git",
"tag": "v0.8.2",
"commit": "71fd833d9666141edcd1d3c109a80e228303d8d7"
}
]
}
9 changes: 9 additions & 0 deletions cmake/common/helpers_common.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,15 @@ function(target_export target)
COMPONENT Development
${exclude_variant}
)

if(target STREQUAL libobs)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we also need to export SIMDE here? Are SIMDE types used in function prototypes or inline functions?

Copy link
Collaborator Author

@tytan652 tytan652 Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The headers include a SIMDE header which make it a dependency of libobs header and so the CMake package needs the finder to be installed alongside the package.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah the question was more about which ones? Because SIMDE is an implementation detail of libobs internals and should not be exposed publicly. It doesn't make sense to expose it from an API point of view and if we do that seems like a mistake to me.

Copy link
Collaborator Author

@tytan652 tytan652 Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

util/sse-intrin.h (which hard depends on SIMDE) used in some installed headers:

grep -r "sse-intrin.h" /usr/include/obs/. 
/usr/include/obs/./graphics/quat.h:#include "../util/sse-intrin.h"
/usr/include/obs/./graphics/vec3.h:#include "../util/sse-intrin.h"
/usr/include/obs/./graphics/vec4.h:#include "../util/sse-intrin.h"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right and of course we inlined all those functions so we created a tight coupling between API users and the internal data types..

That should have never happened, but I guess that's water under the bridge and can be cleaned up once the current API is not used externally anymore in the future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this thread can be resolved as "todo in a future effort".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally it should be fixed before making it an external dependency, because by fixing that, we exposed another open wound (namely that it now becomes an explicit public 3rd party dependency) and we just trade one problem (vendored dependency) for another (internal dependency becomes a hard public external dependency) even though there is no architectural reason for that to be the case.

We're doctoring around symptoms again and make a change that is mostly cosmetic instead of fixing the actual issue. But it's a fight I've never won, so I gave up fighting it.

install(
FILES "${CMAKE_SOURCE_DIR}/cmake/finders/FindSIMDE.cmake"
DESTINATION "${package_destination}/finders"
COMPONENT Development
${exclude_variant}
)
endif()
endfunction()

# check_uuid: Helper function to check for valid UUID
Expand Down
100 changes: 100 additions & 0 deletions cmake/finders/FindSIMDE.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
#[=======================================================================[.rst
FindSIMDE
---------

FindModule for SIMD Everywhere

Imported Targets
^^^^^^^^^^^^^^^^

.. versionadded:: 3.0

This module defines the :prop_tgt:`IMPORTED` target ``SIMDE::SIMDE``.

Result Variables
^^^^^^^^^^^^^^^^

This module sets the following variables:

``SIMDE_FOUND``
True, if headers were found.
``SIMDE_VERSION``
Detected version of found SIMDE Everywhere.

Cache variables
^^^^^^^^^^^^^^^

The following cache variables may also be set:

``SIMDE_INCLUDE_DIR``
Directory containing ``simde/simde-common.h``.

#]=======================================================================]

include(FindPackageHandleStandardArgs)

find_package(PkgConfig QUIET)
if(PKG_CONFIG_FOUND)
pkg_search_module(PC_SIMDE QUIET simde)
endif()

find_path(
SIMDE_INCLUDE_DIR
NAMES simde/simde-common.h
HINTS ${PC_SIMDE_INCLUDE_DIRS}
PATHS /usr/include /usr/local/include
DOC "SIMD Everywhere include directory"
)

if(EXISTS "${SIMDE_INCLUDE_DIR}/simde/simde-common.h")
file(
STRINGS
"${SIMDE_INCLUDE_DIR}/simde/simde-common.h"
_version_string
REGEX "^.*VERSION_(MAJOR|MINOR|MICRO)[ \t]+[0-9]+[ \t]*$"
)

string(REGEX REPLACE ".*VERSION_MAJOR[ \t]+([0-9]+).*" "\\1" _version_major "${_version_string}")
string(REGEX REPLACE ".*VERSION_MINOR[ \t]+([0-9]+).*" "\\1" _version_minor "${_version_string}")
string(REGEX REPLACE ".*VERSION_MICRO[ \t]+([0-9]+).*" "\\1" _version_release "${_version_string}")

set(SIMDE_VERSION "${_version_major}.${_version_minor}.${_version_release}")
unset(_version_major)
unset(_version_minor)
unset(_version_release)
else()
if(NOT SIMDE_FIND_QUIETLY)
message(AUTHOR_WARNING "Failed to find SIMD Everywhere version.")
endif()
set(SIMDE_VERSION 0.0.0)
endif()

if(CMAKE_HOST_SYSTEM_NAME MATCHES "Darwin|Windows")
set(SIMDE_ERROR_REASON "Ensure that obs-deps is provided as part of CMAKE_PREFIX_PATH.")
elseif(CMAKE_HOST_SYSTEM_NAME MATCHES "Linux|FreeBSD")
set(SIMDE_ERROR_REASON "Ensure SIMD Everywhere is available in local library paths.")
endif()

find_package_handle_standard_args(
SIMDE
REQUIRED_VARS SIMDE_INCLUDE_DIR
VERSION_VAR SIMDE_VERSION
REASON_FAILURE_MESSAGE "${SIMDE_ERROR_REASON}"
)
mark_as_advanced(SIMDE_INCLUDE_DIR)
unset(SIMDE_ERROR_REASON)

if(SIMDE_FOUND)
if(NOT TARGET SIMDE::SIMDE)
add_library(SIMDE::SIMDE INTERFACE IMPORTED)
set_target_properties(SIMDE::SIMDE PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${SIMDE_INCLUDE_DIR}")
endif()
endif()

include(FeatureSummary)
set_package_properties(
SIMDE
PROPERTIES
URL "https://github.com/simd-everywhere/simde"
DESCRIPTION "Implementations of SIMD instruction sets for systems which don't natively support them."
)
36 changes: 2 additions & 34 deletions libobs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ if(OS_WINDOWS AND NOT OBS_PARENT_ARCHITECTURE STREQUAL CMAKE_VS_PLATFORM_NAME)
return()
endif()

find_package(SIMDE REQUIRED)
find_package(Threads REQUIRED)

find_package(FFmpeg 6.1 REQUIRED avformat avutil swscale swresample OPTIONAL_COMPONENTS avcodec)
Expand Down Expand Up @@ -135,25 +136,6 @@ target_sources(
util/util_uint64.h
)

target_sources(
libobs
PRIVATE
util/simde/check.h
util/simde/debug-trap.h
util/simde/hedley.h
util/simde/simde-align.h
util/simde/simde-arch.h
util/simde/simde-common.h
util/simde/simde-constify.h
util/simde/simde-detect-clang.h
util/simde/simde-diagnostic.h
util/simde/simde-features.h
util/simde/simde-math.h
util/simde/x86/mmx.h
util/simde/x86/sse.h
util/simde/x86/sse2.h
)

target_sources(
libobs
PRIVATE
Expand Down Expand Up @@ -260,7 +242,7 @@ target_link_libraries(
jansson::jansson
Uthash::Uthash
ZLIB::ZLIB
PUBLIC Threads::Threads
PUBLIC SIMDE::SIMDE Threads::Threads
)

if(OS_WINDOWS)
Expand Down Expand Up @@ -357,20 +339,6 @@ set(
util/profiler.h
util/profiler.hpp
util/serializer.h
util/simde/check.h
util/simde/debug-trap.h
util/simde/hedley.h
util/simde/simde-align.h
util/simde/simde-arch.h
util/simde/simde-common.h
util/simde/simde-constify.h
util/simde/simde-detect-clang.h
util/simde/simde-diagnostic.h
util/simde/simde-features.h
util/simde/simde-math.h
util/simde/x86/mmx.h
util/simde/x86/sse.h
util/simde/x86/sse2.h
util/sse-intrin.h
util/task.h
util/text-lookup.h
Expand Down
3 changes: 3 additions & 0 deletions libobs/cmake/libobsConfig.cmake.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

include(CMakeFindDependencyMacro)

list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/finders")

if(MSVC)
find_dependency(w32-pthreads REQUIRED)
endif()
find_dependency(SIMDE REQUIRED)
find_dependency(Threads REQUIRED)

include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")
Expand Down
3 changes: 0 additions & 3 deletions libobs/util/simde/.clang-format

This file was deleted.

40 changes: 0 additions & 40 deletions libobs/util/simde/LICENSE.simde

This file was deleted.

6 changes: 0 additions & 6 deletions libobs/util/simde/README.libobs

This file was deleted.

Loading
Loading