new(libsinsp): inspector thread pool

.github/install-deps.sh

@@ -66,3 +66,8 @@ popd
 echo "=== Downloading uthash.h (1.9.8) ==="
 
 wget -P "/usr/include" "https://raw.githubusercontent.com/troydhanson/uthash/v1.9.8/src/uthash.h"
+
+# === BS_thread_pool ===
+echo "=== Downloading BS_thread_pool.h (4.1.0) ==="
+
+wget -P "/usr/include" "https://github.com/bshoshany/thread-pool/raw/v4.1.0/include/BS_thread_pool.hpp"

.github/workflows/ci.yml

@@ -64,7 +64,7 @@ jobs:
           UBSAN_OPTIONS: print_stacktrace=1
         run: |
           mkdir -p build
-          cd build && cmake ${{ matrix.cmake_opts }} ../
+          cd build && cmake ${{ matrix.cmake_opts }} -DENABLE_THREAD_POOL=ON ../
           KERNELDIR=/lib/modules/$(ls /lib/modules)/build make -j4
           make run-unit-tests
 
@@ -90,7 +90,7 @@ jobs:
       - name: Build and test 🏗️🧪
         run: |
           mkdir -p build
-          cd build && cmake -DBUILD_BPF=On -DBUILD_DRIVER=Off -DUSE_BUNDLED_DEPS=On -DUSE_BUNDLED_LIBELF=Off -DUSE_SHARED_LIBELF=Off -DBUILD_LIBSCAP_MODERN_BPF=ON -DMUSL_OPTIMIZED_BUILD=On ../
+          cd build && cmake -DBUILD_BPF=On -DBUILD_DRIVER=Off -DUSE_BUNDLED_DEPS=On -DUSE_BUNDLED_LIBELF=Off -DUSE_SHARED_LIBELF=Off -DBUILD_LIBSCAP_MODERN_BPF=ON -DMUSL_OPTIMIZED_BUILD=On -DENABLE_THREAD_POOL=ON ../
           make run-unit-tests -j4
 
   build-shared-libs-linux-amd64:
@@ -115,7 +115,7 @@ jobs:
       - name: Build and test 🏗️🧪
         run: |
           mkdir -p build
-          cd build && cmake -DBUILD_SHARED_LIBS=True -DUSE_BUNDLED_DEPS=False -DMINIMAL_BUILD=True -DCMAKE_INSTALL_PREFIX=/tmp/libs-test ../
+          cd build && cmake -DBUILD_SHARED_LIBS=True -DUSE_BUNDLED_DEPS=False -DMINIMAL_BUILD=True -DCMAKE_INSTALL_PREFIX=/tmp/libs-test -DENABLE_THREAD_POOL=ON ../
           make -j4
           make run-unit-tests
 
@@ -155,7 +155,7 @@ jobs:
       - name: Build and test 🏗️🧪
         run: |
           mkdir -p build
-          cd build && cmake -DUSE_BUNDLED_DEPS=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_MSVC_RUNTIME_LIBRARY=${{ matrix.crt }} -DCREATE_TEST_TARGETS=ON -DMINIMAL_BUILD=ON ..
+          cd build && cmake -DUSE_BUNDLED_DEPS=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_MSVC_RUNTIME_LIBRARY=${{ matrix.crt }} -DCREATE_TEST_TARGETS=ON -DMINIMAL_BUILD=ON -DENABLE_THREAD_POOL=ON ..
           cmake --build . --config Release --parallel 4 && make run-unit-tests || libsinsp\test\Release\unit-test-libsinsp.exe
 
   build-shared-libs-macos-amd64:
@@ -174,7 +174,7 @@ jobs:
       - name: Build 🏗️
         run: |
           mkdir -p build
-          cd build && cmake -DBUILD_SHARED_LIBS=True -DUSE_BUNDLED_DEPS=False -DUSE_BUNDLED_VALIJSON=ON -DCMAKE_BUILD_TYPE=Release -DCREATE_TEST_TARGETS=OFF -DMINIMAL_BUILD=ON -DCMAKE_INSTALL_PREFIX=/tmp/libs-test ..
+          cd build && cmake -DBUILD_SHARED_LIBS=True -DUSE_BUNDLED_DEPS=False -DUSE_BUNDLED_VALIJSON=ON -DUSE_BUNDLED_BS_THREADPOOL=ON -DENABLE_THREAD_POOL=ON -DCMAKE_BUILD_TYPE=Release -DCREATE_TEST_TARGETS=OFF -DMINIMAL_BUILD=ON -DCMAKE_INSTALL_PREFIX=/tmp/libs-test ..
           cmake --build . --config Release --parallel $(getconf _NPROCESSORS_ONLN)
 
       - name: Install

cmake/modules/CompilerFlags.cmake

@@ -77,6 +77,10 @@ if(NOT MSVC)
 		set(FALCOSECURITY_LIBS_USERSPACE_LINK_FLAGS "${FALCOSECURITY_LIBS_USERSPACE_COMPILE_FLAGS};--coverage")
 	endif()
 
+	if(ENABLE_THREAD_POOL)
+		set(FALCOSECURITY_LIBS_COMMON_FLAGS "${FALCOSECURITY_LIBS_COMMON_FLAGS} -DENABLE_THREAD_POOL")
+	endif()
+
 	set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${FALCOSECURITY_LIBS_COMMON_FLAGS}")
 	# we need also `-std=c++17` here beacuse `set(CMAKE_CXX_STANDARD 17)` is not enough to enforce c++17
 	# with some Cmake versions: https://github.com/falcosecurity/libs/pull/950

cmake/modules/Findbs_threadpool.cmake

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright (C) 2023 The Falco Authors.
+#
+# 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.
+#
+
+find_path(BS_THREADPOOL_INCLUDE NAMES BS_thread_pool.hpp)
+
+if (BS_THREADPOOL_INCLUDE)
+    if (NOT bs_threadpool_FIND_QUIETLY)
+        message(STATUS "Found bs_threadpool: include: ${BS_THREADPOOL_INCLUDE}.")
+    endif()
+else()
+    if (bs_threadpool_FIND_REQUIRED)
+        message(FATAL_ERROR "Required component bs_threadpool missing.")
+    endif()
+    if (NOT bs_threadpool_FIND_QUIETLY)
+        message(WARNING "bs_threadpool not found.")
+    endif()
+endif()

cmake/modules/bs_threadpool.cmake

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright (C) 2024 The Falco Authors.
+#
+# 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.
+#
+
+#
+# bshoshany/thread-pool (https://github.com/bshoshany/thread-pool)
+#
+
+option(USE_BUNDLED_BS_THREADPOOL "Enable building of the bundled bs_threadpool" ${USE_BUNDLED_DEPS})
+
+if(BS_THREADPOOL_INCLUDE)
+	# we already have bs_threadpool
+elseif(NOT USE_BUNDLED_BS_THREADPOOL)
+	find_package(bs_threadpool REQUIRED)
+else()
+	set(BS_THREADPOOL_SRC "${PROJECT_BINARY_DIR}/bs_threadpool-prefix/src/bs_threadpool")
+	set(BS_THREADPOOL_INCLUDE "${BS_THREADPOOL_SRC}/include")
+
+	message(STATUS "Using bundled bs_threadpool in '${BS_THREADPOOL_SRC}'")
+
+	ExternalProject_Add(bs_threadpool
+		PREFIX "${PROJECT_BINARY_DIR}/bs_threadpool-prefix"
+		URL "https://github.com/bshoshany/thread-pool/archive/refs/tags/v4.1.0.tar.gz"
+		URL_HASH "SHA256=be7abecbc420bb87919eeef729b13ff7c29d5ce547bdae284923296c695415bd"
+		CONFIGURE_COMMAND ""
+		BUILD_COMMAND ""
+		INSTALL_COMMAND "")	
+endif()
+
+if(NOT TARGET bs_threadpool)
+	add_custom_target(bs_threadpool)
+endif()
+
+include_directories("${BS_THREADPOOL_INCLUDE}")

cmake/modules/libsinsp.cmake

@@ -20,6 +20,7 @@ if(NOT LIBS_DIR)
 endif()
 
 option(USE_BUNDLED_DEPS "Enable bundled dependencies instead of using the system ones" ON)
+option(ENABLE_THREAD_POOL "Enable inspector thread pool" OFF)
 
 if(DEFINED LIBSINSP_USER_AGENT)
 	add_definitions(-DLIBSINSP_USER_AGENT="${LIBSINSP_USER_AGENT}")
@@ -38,6 +39,10 @@ include(jsoncpp)
 include(valijson)
 include(re2)
 
+if(ENABLE_THREAD_POOL AND NOT EMSCRIPTEN)
+	include(bs_threadpool)
+endif()
+
 set(LIBSINSP_INCLUDE_DIRS ${LIBS_DIR} ${LIBS_DIR}/userspace ${LIBSCAP_INCLUDE_DIRS} ${DRIVER_CONFIG_DIR})
 
 if (NOT EMSCRIPTEN)
@@ -54,6 +59,11 @@ list(APPEND LIBSINSP_INCLUDE_DIRS ${VALIJSON_ABSOLUTE_INCLUDE_DIR})
 get_filename_component(RE2_ABSOLUTE_INCLUDE_DIR ${RE2_INCLUDE} ABSOLUTE)
 list(APPEND LIBSINSP_INCLUDE_DIRS ${RE2_ABSOLUTE_INCLUDE_DIR})
 
+if (ENABLE_THREAD_POOL AND NOT EMSCRIPTEN)
+	get_filename_component(BS_THREADPOOL_ABSOLUTE_INCLUDE_DIR ${BS_THREADPOOL_INCLUDE} ABSOLUTE)
+	list(APPEND LIBSINSP_INCLUDE_DIRS ${BS_THREADPOOL_ABSOLUTE_INCLUDE_DIR})
+endif()
+
 if(NOT MINIMAL_BUILD AND NOT EMSCRIPTEN AND NOT APPLE)
 	get_filename_component(CARES_ABSOLUTE_INCLUDE_DIR ${CARES_INCLUDE} ABSOLUTE)
 	list(APPEND LIBSINSP_INCLUDE_DIRS ${CARES_ABSOLUTE_INCLUDE_DIR})

userspace/libsinsp/CMakeLists.txt

@@ -16,6 +16,7 @@
 #
 
 option(USE_BUNDLED_DEPS "Enable bundled dependencies instead of using the system ones" ON)
+option(ENABLE_THREAD_POOL "Enable inspector thread pool" OFF)
 
 if(NOT MSVC)
 	add_definitions(-DHAVE_PWD_H)
@@ -112,6 +113,13 @@ add_library(sinsp
 	events/sinsp_events_ppm_sc.cpp
 )
 
+if (ENABLE_THREAD_POOL AND NOT EMSCRIPTEN)
+	target_sources(sinsp
+	PRIVATE
+		thread_pool_bs.cpp
+	)
+endif()
+
 if(NOT WIN32 AND NOT APPLE)
 	target_sources(sinsp PRIVATE procfs_utils.cpp sinsp_cgroup.cpp)
 endif()
@@ -199,6 +207,10 @@ if(USE_BUNDLED_JSONCPP)
 	add_dependencies(sinsp jsoncpp)
 endif()
 
+if(ENABLE_THREAD_POOL AND USE_BUNDLED_BS_THREADPOOL)
+	add_dependencies(sinsp bs_threadpool)
+endif()
+
 function(prepare_cri_grpc api_version)
 	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cri-${api_version}.proto ${CMAKE_CURRENT_BINARY_DIR}/cri-${api_version}.proto COPYONLY)
 	add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/cri-${api_version}.grpc.pb.cc