feat(build): Add support for CMake package #14738

kou · 2025-09-05T09:42:05Z

Fixes #14275
Fixes #14756

This is not a complete CMake package support. This works only when:

VELOX_BUILD_SHARED=ON
VELOX_BUILD_MINIMAL_WITH_DWIO=ON
All dependencies are resolved from system (No bundled dependencies)

FYI: I want to use this for Nimble: facebookincubator/nimble#215
Nimble uses VELOX_BUILD_MINIMAL_WITH_DWIO=ON.

This is disabled by default. We can enabled this by specifying VELOX_BUILD_CMAKE_PACKAGE=ON.

Users can find Velox by find_package(Velox).

We can expand supported cases step by step. How about this as the first step?

netlify · 2025-09-05T09:42:11Z

✅ Deploy Preview for meta-velox canceled.

Name	Link
🔨 Latest commit	`4a25bd2`
🔍 Latest deploy log	https://app.netlify.com/projects/meta-velox/deploys/68be22ecb4e8fc000860533b

assignUser

Very nice, thanks for getting a start on this. Makes sense to start with MINIMAL first and iterate.

I have build this PR and I had to fix some minor issues to get it to install correctly but when trying to link against it the configure fails as the config links against targets that we don't discover before, when building MINIMAL:

double-conversion::double-conversion
stemmer::stemmer

When building MINIMAL_WITH_DWIO:

protobuf::libprotobuf

CMake/VeloxUtils.cmake

CMake/VeloxConfig.cmake.in

assignUser · 2025-09-06T19:29:46Z

This was needed to avoid an issue with gflag_gflags not being in any export set (but obviously this is not a real solution):

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2a8e3e91b..4cea0c845 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -536,9 +536,9 @@ if(NOT TARGET gflags::gflags)
   # target even when velox is built as a subproject which uses
   # `find_package(gflags)` which does not create a globally imported target that
   # we can ALIAS.
-  add_library(gflags_gflags INTERFACE)
-  target_link_libraries(gflags_gflags INTERFACE gflags)
-  add_library(gflags::gflags ALIAS gflags_gflags)
+  # add_library(gflags_gflags INTERFACE)
+  # target_link_libraries(gflags_gflags INTERFACE gflags)
+  add_library(gflags::gflags ALIAS gflags)
 endif()
 
 if(${gflags_SOURCE} STREQUAL "BUNDLED")

I also noticed #14756 and will fix in #14757

kou · 2025-09-06T22:57:19Z

I have build this PR and I had to fix some minor issues to get it to install correctly but when trying to link against it the configure fails as the config links against targets that we don't discover before, when building MINIMAL:

double-conversion::double-conversion
stemmer::stemmer

When building MINIMAL_WITH_DWIO:

protobuf::libprotobuf

Oh, sorry. I'll add support for them.

This was needed to avoid an issue with gflag_gflags not being in any export set (but obviously this is not a real solution):

Ah, sorry. I should have explained the case. We need to specify -DGFLAGS_USE_TARGET_NAMESPACE=ON for now. I'll work on GFlags related cleanup as a separated task. We may need to change Folly and so on.

kou · 2025-09-07T08:24:14Z

Let's work on GFlags as a separated task: #14760

kou · 2025-09-07T08:27:35Z

I've added support for missing dependencies: double-conversion, stemmer and Protobuf

assignUser

Yeah this fixed the issues I had, no Thrift::thrift is missing though ^^

I also ran into issues with missing headers, this happens because there are a number of headers that are not part of any target, the diff below installs those headers.

I tried building an example but it looks like they all require exec or aggregates and are not compatible with minimal. :( When we have added more we should add CI to build examples against the installed Velox.

diff --git a/velox/CMakeLists.txt b/velox/CMakeLists.txt
index 1bf6976e8..ca66e3c82 100644
--- a/velox/CMakeLists.txt
+++ b/velox/CMakeLists.txt
@@ -26,6 +26,7 @@ add_subdirectory(external/date)
 add_subdirectory(external/tzdb)
 add_subdirectory(external/md5)
 add_subdirectory(external/hdfs)
+add_subdirectory(external/utf8proc)
 #
 
 # examples depend on expression
diff --git a/velox/common/CMakeLists.txt b/velox/common/CMakeLists.txt
index 666142765..119cfc147 100644
--- a/velox/common/CMakeLists.txt
+++ b/velox/common/CMakeLists.txt
@@ -26,3 +26,6 @@ add_subdirectory(serialization)
 add_subdirectory(time)
 add_subdirectory(testutil)
 add_subdirectory(fuzzer)
+add_subdirectory(future)
+
+velox_install_library_headers()
diff --git a/velox/common/future/CMakeLists.txt b/velox/common/future/CMakeLists.txt
new file mode 100644
index 000000000..a598690b3
--- /dev/null
+++ b/velox/common/future/CMakeLists.txt
@@ -0,0 +1,14 @@
+# Copyright (c) Facebook, Inc. and its affiliates.
+#
+# 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.
+velox_install_library_headers()
diff --git a/velox/external/utf8proc/CMakeLists.txt b/velox/external/utf8proc/CMakeLists.txt
new file mode 100644
index 000000000..a598690b3
--- /dev/null
+++ b/velox/external/utf8proc/CMakeLists.txt
@@ -0,0 +1,14 @@
+# Copyright (c) Facebook, Inc. and its affiliates.
+#
+# 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.
+velox_install_library_headers()

kou · 2025-09-07T21:37:46Z

Yeah this fixed the issues I had, no Thrift::thrift is missing though ^^

Oh, sorry. I forgot to install FindArrow.cmake. I've added it.

I also ran into issues with missing headers, this happens because there are a number of headers that are not part of any target, the diff below installs those headers.

Can we work on it as a separated task?
#14763

I tried building an example but it looks like they all require exec or aggregates and are not compatible with minimal. :( When we have added more we should add CI to build examples against the installed Velox.

It makes sense. I'll do it in a future PR.

assignUser

One minor comment, otherwise I think we can merge this and iterate the issues we found in follow up PRs!

Thanks again for starting this!

assignUser · 2025-09-07T23:10:31Z

velox/tpch/gen/CMakeLists.txt

@@ -18,7 +18,10 @@ velox_add_library(velox_tpch_gen DBGenIterator.cpp TpchGen.cpp)

 velox_include_directories(velox_tpch_gen PRIVATE dbgen/include)


Does this not need the same generator expression as velox_tpcds_gen?

We don't need it here because this is a "PRIVATE" include directory. "PRIVATE" include directories aren't exported.

kou · 2025-09-08T00:23:41Z

CMake/VeloxUtils.cmake

-      install(TARGETS velox LIBRARY DESTINATION pyvelox COMPONENT pyvelox_libraries)
+      if(VELOX_BUILD_PYTHON_PACKAGE)
+        install(TARGETS velox LIBRARY DESTINATION pyvelox COMPONENT pyvelox_libraries)
+      endif()


Oh, sorry. This is not an intended change. I'll revert this.

We should work on this as #14756 .

kou · 2025-09-08T00:26:21Z

velox/tpch/gen/CMakeLists.txt

@@ -18,7 +18,10 @@ velox_add_library(velox_tpch_gen DBGenIterator.cpp TpchGen.cpp)

 velox_include_directories(velox_tpch_gen PRIVATE dbgen/include)


We don't need it here because this is a "PRIVATE" include directory. "PRIVATE" include directories aren't exported.

facebook-github-bot · 2025-09-08T14:13:47Z

@Yuhta has imported this pull request. If you are a Meta employee, you can view this in D81923615.

facebook-github-bot · 2025-09-09T16:39:51Z

@Yuhta merged this pull request in dfb4936.

Summary: Fixes facebookincubator#14275 Fixes facebookincubator#14756 This is not a complete CMake package support. This works only when: * `VELOX_BUILD_SHARED=ON` * `VELOX_BUILD_MINIMAL_WITH_DWIO=ON` * All dependencies are resolved from system (No bundled dependencies) FYI: I want to use this for Nimble: facebookincubator/nimble#215 Nimble uses `VELOX_BUILD_MINIMAL_WITH_DWIO=ON`. This is disabled by default. We can enabled this by specifying `VELOX_BUILD_CMAKE_PACKAGE=ON`. Users can find Velox by `find_package(Velox)`. We can expand supported cases step by step. How about this as the first step? Pull Request resolved: facebookincubator#14738 Reviewed By: mbasmanova Differential Revision: D81923615 Pulled By: Yuhta fbshipit-source-id: 8a7cb55c5e57c3b87b696fa7298cbd171e80d40d

kou requested review from majetideepak and assignUser as code owners September 5, 2025 09:42

meta-cla bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Sep 5, 2025

assignUser reviewed Sep 6, 2025

View reviewed changes

CMake/VeloxUtils.cmake Show resolved Hide resolved

CMake/VeloxUtils.cmake Show resolved Hide resolved

CMake/VeloxConfig.cmake.in Outdated Show resolved Hide resolved

kou added 3 commits September 7, 2025 16:50

feat(build): Add support for CMake package

f093d69

Keep existing CMAKE_MODULE_PATH

3194ae5

Add missing dependencies

ebbc5a3

kou force-pushed the cmake-package branch from 9eb427c to ebbc5a3 Compare September 7, 2025 07:50

Validate

c9ca8c1

assignUser reviewed Sep 7, 2025

View reviewed changes

Install FindArrow.cmake

bbf1863

This was referenced Sep 7, 2025

build(pyvelox): Exclude pyvelox_libraries component from default #14757

Closed

Improve GFlags CMake target handling #14760

Open

assignUser approved these changes Sep 7, 2025

View reviewed changes

kou commented Sep 8, 2025

View reviewed changes

Revert a needless change

4a25bd2

facebook-github-bot closed this in dfb4936 Sep 9, 2025

facebook-github-bot added the Merged label Sep 9, 2025

assignUser mentioned this pull request Sep 9, 2025

Don't install pyvelox component by default #14756

Open

kou deleted the cmake-package branch September 10, 2025 00:33

		@@ -18,7 +18,10 @@ velox_add_library(velox_tpch_gen DBGenIterator.cpp TpchGen.cpp)

		velox_include_directories(velox_tpch_gen PRIVATE dbgen/include)

feat(build): Add support for CMake package #14738

feat(build): Add support for CMake package #14738

Conversation

kou commented Sep 5, 2025 • edited by assignUser Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for meta-velox canceled.

Uh oh!

assignUser left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

assignUser commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kou commented Sep 6, 2025

Uh oh!

kou commented Sep 7, 2025

Uh oh!

kou commented Sep 7, 2025

Uh oh!

assignUser left a comment

Choose a reason for hiding this comment

Uh oh!

kou commented Sep 7, 2025

Uh oh!

assignUser left a comment

Choose a reason for hiding this comment

Uh oh!

assignUser Sep 7, 2025

Choose a reason for hiding this comment

Uh oh!

kou Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kou Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

kou Sep 8, 2025

Choose a reason for hiding this comment

Uh oh!

kou Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot commented Sep 8, 2025

Uh oh!

facebook-github-bot commented Sep 9, 2025

Uh oh!

Uh oh!

kou commented Sep 5, 2025 •

edited by assignUser

Loading

netlify bot commented Sep 5, 2025 •

edited

Loading

assignUser commented Sep 6, 2025 •

edited

Loading

kou Sep 8, 2025 •

edited

Loading

kou Sep 8, 2025 •

edited

Loading