Add proxy library for intercepting user allocation requests

UMF proxy library is a library for intercepting user allocation requests.
It intercepts following APIs:
- aligned_alloc()
- calloc()
- free()
- malloc()
- malloc_usable_size()
- realloc()

Signed-off-by: Lukasz Dorau <[email protected]>

Author: ldorau

.github/workflows/codeql.yml

@@ -22,9 +22,11 @@ jobs:
                 - os: ubuntu-latest
                   nproc: $(nproc)
                   pool_scalable: 'ON'
+                  pool_jemalloc: 'ON'
                 - os: windows-latest
                   nproc: $Env:NUMBER_OF_PROCESSORS
                   pool_scalable: 'OFF'
+                  pool_jemalloc: 'OFF'
     runs-on: ${{matrix.os}}
 
     steps:
@@ -53,6 +55,7 @@ jobs:
         -DUMF_FORMAT_CODE_STYLE=ON
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_ENABLE_POOL_TRACKING=ON
+        -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=${{matrix.pool_jemalloc}}
         -DUMF_BUILD_LIBUMF_POOL_SCALABLE=${{matrix.pool_scalable}}
 
     - name: Build

.github/workflows/pr_push.yml

@@ -85,3 +85,6 @@ jobs:
     Benchmark:
         needs: [Build]
         uses: ./.github/workflows/benchmarks.yml
+    Proxy_lib:
+        needs: [Build]
+        uses: ./.github/workflows/proxy_lib.yml

.github/workflows/proxy_lib.yml

@@ -0,0 +1,52 @@
+name: Proxy library
+
+on: workflow_call
+
+permissions:
+  contents: read
+
+jobs:
+  ubuntu-build:
+    name: Build - Ubuntu
+
+    strategy:
+      matrix:
+        os: ['ubuntu-22.04']
+        build_type: [Release, Debug]
+        compiler: [{c: gcc, cxx: g++}]
+    runs-on: ${{matrix.os}}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Install apt packages
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake libhwloc-dev libnuma-dev libjemalloc-dev libtbb-dev
+
+      - name: Configure build
+        run: >
+          cmake
+          -B ${{github.workspace}}/build
+          -DCMAKE_BUILD_TYPE=${{matrix.build_type}}
+          -DCMAKE_C_COMPILER=${{matrix.compiler.c}}
+          -DCMAKE_CXX_COMPILER=${{matrix.compiler.cxx}}
+          -DUMF_BUILD_SHARED_LIBRARY=ON
+          -DUMF_BUILD_BENCHMARKS=ON
+          -DUMF_BUILD_TESTS=OFF
+          -DUMF_FORMAT_CODE_STYLE=OFF
+          -DUMF_DEVELOPER_MODE=OFF
+          -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
+          -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
+          -DUMF_BUILD_LIBUMF_POOL_SCALABLE=OFF
+          -DUMF_ENABLE_POOL_TRACKING=OFF
+
+      - name: Build UMF
+        run: cmake --build ${{github.workspace}}/build -j $(nproc)
+
+      - name: Run benchmarks
+        working-directory: ${{github.workspace}}/build
+        run: |
+          LD_DEBUG=all LD_PRELOAD=./lib/libumf_proxy.so ./benchmark/ubench
+          echo $?

src/CMakeLists.txt

@@ -103,3 +103,12 @@ install(TARGETS umf
 )
 
 add_subdirectory(pool)
+
+# TODO: enable proxy_lib on Windows
+if(LINUX)
+    if(UMF_BUILD_LIBUMF_POOL_JEMALLOC)
+        add_subdirectory(proxy_lib)
+    else()
+        message(STATUS "The proxy library is disabled, because UMF_BUILD_LIBUMF_POOL_JEMALLOC is OFF")
+    endif()
+endif()

src/proxy_lib/CMakeLists.txt

@@ -0,0 +1,50 @@
+# Copyright (C) 2023-2024 Intel Corporation
+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+include(${UMF_CMAKE_SOURCE_DIR}/cmake/helpers.cmake)
+
+set(PROXY_LIBS umf jemalloc_pool)
+
+set(PROXY_SOURCES
+    proxy_lib.c
+)
+
+set(PROXY_SOURCES_LINUX
+    proxy_lib_linux.c
+)
+
+set(PROXY_SOURCES_WINDOWS
+    proxy_lib_windows.c
+)
+
+set(PROXY_SOURCES_MACOSX
+    proxy_lib_linux.c
+)
+
+if(LINUX)
+    set(PROXY_SOURCES ${PROXY_SOURCES} ${PROXY_SOURCES_LINUX})
+elseif(WINDOWS)
+    set(PROXY_SOURCES ${PROXY_SOURCES} ${PROXY_SOURCES_WINDOWS})
+elseif(MACOSX)
+    set(PROXY_SOURCES ${PROXY_SOURCES} ${PROXY_SOURCES_MACOSX})
+endif()
+
+add_umf_library(NAME umf_proxy
+                TYPE SHARED
+                SRCS ${PROXY_SOURCES}
+                LIBS ${PROXY_LIBS}
+                LINUX_MAP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/proxy_lib.map
+                WINDOWS_DEF_FILE ${CMAKE_CURRENT_SOURCE_DIR}/proxy_lib.def)
+
+add_library(${PROJECT_NAME}::proxy ALIAS umf_proxy)
+
+target_include_directories(umf_proxy PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src/utils>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+)
+
+install(TARGETS umf_proxy
+        EXPORT ${PROJECT_NAME}-targets)