Merge pull request #94 from r-devulap/install

Provide a way to install x86simdsort as a library

Author: Raghuveer Devulapalli

.github/workflows/c-cpp.yml

@@ -30,7 +30,7 @@ jobs:
         CXX: g++-9
       run: |
         make clean
-        meson setup --warnlevel 2 --werror --buildtype release builddir
+        meson setup -Dbuild_tests=true --warnlevel 2 --werror --buildtype release builddir
         cd builddir
         ninja
 
@@ -60,7 +60,7 @@ jobs:
         CXX: g++-10
       run: |
         make clean
-        meson setup --warnlevel 2 --werror --buildtype release builddir
+        meson setup -Dbuild_tests=true --warnlevel 2 --werror --buildtype release builddir
         cd builddir
         ninja
 
@@ -90,7 +90,7 @@ jobs:
         CXX: g++-11
       run: |
         make clean
-        meson setup --warnlevel 2 --werror --buildtype release builddir
+        meson setup -Dbuild_tests=true --warnlevel 2 --werror --buildtype release builddir
         cd builddir
         ninja
     - name: Run test suite on TGL
@@ -126,7 +126,7 @@ jobs:
         CXX: g++-13
       run: |
         make clean
-        meson setup --warnlevel 2 --werror --buildtype release builddir
+        meson setup -Dbuild_tests=true --warnlevel 2 --werror --buildtype release builddir
         cd builddir
         ninja
 
@@ -157,7 +157,7 @@ jobs:
         CXXFLAGS: -DXSS_MINIMAL_NETWORK_SORT
       run: |
         make clean
-        meson setup --warnlevel 2 --werror --buildtype release builddir
+        meson setup -Dbuild_tests=true --warnlevel 2 --werror --buildtype release builddir
         cd builddir
         ninja
 

Makefile

@@ -1,10 +1,10 @@
 meson:
-	meson setup --warnlevel 2 --werror --buildtype release builddir
+	meson setup -Dbuild_tests=true -Dbuild_benchmarks=true --warnlevel 2 --werror --buildtype release builddir
 	cd builddir && ninja
 
 mesondebug:
-	meson setup --warnlevel 2 --werror --buildtype debug debug
+	meson setup -Dbuild_tests=true -Dbuild_benchmarks=true --warnlevel 2 --werror --buildtype debug debug
 	cd debug && ninja
 
 clean:
-	$(RM) -rf $(TESTOBJS) $(BENCHOBJS) $(UTILOBJS) testexe benchexe builddir
+	$(RM) -rf $(TESTOBJS) $(BENCHOBJS) $(UTILOBJS) testexe benchexe builddir debug

lib/meson.build

@@ -39,3 +39,5 @@ if cancompilefp16
     cpp_args : ['-march=sapphirerapids', flags_hide_symbols],
     )
 endif
+
+install_headers('x86simdsort.h')

meson.build

@@ -1,5 +1,5 @@
 project('x86-simd-sort', 'cpp',
-        version : '2.0.0',
+        version : '4.0.0',
         license : 'BSD 3-clause',
         default_options : ['cpp_std=c++17'])
 cpp = meson.get_compiler('cpp')
@@ -8,8 +8,6 @@ lib = include_directories('lib')
 bench = include_directories('benchmarks')
 utils = include_directories('utils')
 tests = include_directories('tests')
-gtest_dep = dependency('gtest_main', required : false, static: false)
-gbench_dep = dependency('benchmark', required : false, static: false)
 
 fp16code = '''#include<immintrin.h>
 int main() {
@@ -27,19 +25,32 @@ libsimdsort = shared_library('x86simdsort',
                              include_directories : [utils, lib],
                              link_with : [libtargets],
                              cpp_args : [flags_hide_symbols],
+                             install : true,
                             )
 
-if gtest_dep.found()
+pkg_mod = import('pkgconfig')
+pkg_mod.generate(libraries : libsimdsort,
+                 version : '4.0',
+                 name : 'libx86simdsort',
+                 filebase : 'x86simdsort',
+                 description : 'High performance SIMD based sorting routines.')
+
+# Build test suite if option build_tests set to true
+if get_option('build_tests')
+  gtest_dep = dependency('gtest_main', required : true, static: false)
   subdir('tests')
   testexe = executable('testexe',
                      include_directories : [lib, utils],
                      dependencies : gtest_dep,
                      link_whole : [libtests],
                      link_with : libsimdsort,
                     )
+  test('x86 simd sort tests', testexe)
 endif
 
-if gbench_dep.found()
+# Build benchmarking suite if option build_benchmarks is set to true
+if get_option('build_benchmarks')
+  gbench_dep = dependency('benchmark', required : true, static: false)
   subdir('benchmarks')
   benchexe = executable('benchexe',
                       include_directories : [src, lib, utils, bench],
@@ -52,8 +63,8 @@ endif
 
 summary({
   'Can compile AVX-512 FP16 ISA': cancompilefp16,
-  'Built test content': gtest_dep.found(),
-  'Built benchmarks': gbench_dep.found(),
+  'Build test content': get_option('build_tests'),
+  'Build benchmarks': get_option('build_benchmarks'),
   },
   section: 'Configuration',
   bool_yn: true

meson_options.txt

@@ -0,0 +1,4 @@
+option('build_tests', type : 'boolean', value : false,
+  description : 'Build test suite (default: "false").')
+option('build_benchmarks', type : 'boolean', value : false,
+  description : 'Build benchmarking suite (default: "false").')