added status flags to saf_externals, and SIMD intrinsics can now be enabled via CMake

Author: leomccormack

CMakeLists.txt

@@ -11,6 +11,7 @@ option(SAF_BUILD_EXTRAS              "Build SAF extras."
 option(SAF_ENABLE_SOFA_READER_MODULE "Enable the SAF SOFA READER module"          OFF)
 option(SAF_ENABLE_TRACKER_MODULE     "Enable the SAF TRACKER module"              OFF)
 option(SAF_USE_INTEL_IPP             "Use Intel IPP for the FFT, resampler, etc." OFF)
+option(SAF_ENABLE_SIMD               "Enable the use of SSE3, AVX2, AVX512"       OFF)
 if (NOT SAF_PERFORMANCE_LIB)
     set(SAF_PERFORMANCE_LIB "SAF_USE_INTEL_MKL_LP64" CACHE STRING "Performance library for SAF to use.")
 endif()

README.md

@@ -95,7 +95,8 @@ The available SAF-related CMake options (and their default values) are:
 -DSAF_BUILD_EXAMPLES=1                       # build saf examples
 -DSAF_BUILD_EXTRAS=0                         # build safmex etc.
 -DSAF_BUILD_TESTS=1                          # build unit testing program
--DSAF_USE_INTEL_IPP=0                        # To link and use Intel IPP for the FFT, resampler, etc.
+-DSAF_USE_INTEL_IPP=0                        # link and use Intel IPP for the FFT, resampler, etc.
+-DSAF_ENABLE_SIMD=0                          # enable/disable SSE, AVX, and/or AVX-512 support
 ```
 
 If using e.g. **SAF_USE_INTEL_MKL_LP64** as the performance library, note that the default header and library search paths may be overridden [according to your setup](docs/PERFORMANCE_LIBRARY_INSTRUCTIONS.md) with:
@@ -116,6 +117,8 @@ If the **saf_sofa_reader** module is enabled, CMake will use the statically buil
 For Linux/MacOS users: the framework, examples, and unit testing program may be built as follows:
 ```
 cmake -S . -B build 
+# Or to also enable e.g. SSE3 and AVX2 intrinsics (for both C and C++ code)
+cmake -S . -B build -DSAF_ENABLE_SIMD=1 -DCMAKE_CXX_FLAGS="-msse3 -mavx2" -DCMAKE_C_FLAGS="-msse3 -mavx2"
 cd build
 make
 test/saf_test # To run the unit testing program

framework/CMakeLists.txt

@@ -212,6 +212,15 @@ if(SAF_USE_INTEL_IPP)
     target_link_libraries(${PROJECT_NAME} PUBLIC ${INTEL_IPP_LIB} )
 endif()
 
+############################################################################
+# Enable SIMD intrinsics
+if(SAF_ENABLE_SIMD)
+    # Note that you need to pass the appropriate compiler flags to actually
+    # enable certain intrinsics, for example:
+    # $ cmake -S . -B build -DCMAKE_CXX_FLAGS="-msse3 -mavx2" -DCMAKE_C_FLAGS="-msse3 -mavx2"
+    message(STATUS "SIMD intrinsics support is enabled.")
+    target_compile_definitions(${PROJECT_NAME} PUBLIC SAF_ENABLE_SIMD=1)
+endif()
 
 ############################################################################
 # Sofa reader module dependencies

framework/include/saf_externals.h

@@ -270,4 +270,73 @@
 #endif
 
 
+/* ========================================================================== */
+/*                   Configuration and Status Flags/Strings                   */
+/* ========================================================================== */
+
+/* Currently employed performance library: */
+#if defined(SAF_USE_INTEL_MKL_LP64)
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "Intel MKL (LP64)"
+#elif defined(SAF_USE_INTEL_MKL_ILP64)
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "Intel MKL (ILP64)"
+#elif defined(SAF_USE_OPEN_BLAS_AND_LAPACKE)
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "OpenBLAS with LAPACKE"
+#elif defined(SAF_USE_ATLAS)
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "ATLAS"
+#elif defined(__APPLE__) && defined(SAF_USE_APPLE_ACCELERATE)
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "Apple Accelerate"
+#else
+# define SAF_CURRENT_PERFORMANCE_LIBRARY_STRING "NONE"
+#endif
+
+/* Status of Intel IPP */
+#if defined(SAF_USE_INTEL_IPP)
+# define SAF_INTEL_IPP_STATUS_STRING "Enabled"
+#else
+# define SAF_INTEL_IPP_STATUS_STRING "Disabled"
+#endif
+
+/* Status of FFTW */
+#if defined(SAF_USE_FFTW)
+# define SAF_FFTW_STATUS_STRING "Enabled"
+#else
+# define SAF_FFTW_STATUS_STRING "Disabled"
+#endif
+
+/* Status of SIMD intrinsics */
+#if defined(SAF_ENABLE_SIMD)
+# define SAF_SIMD_STATUS_STRING "Enabled"
+/* Which SIMD intrinsics are currently enabled? */
+# if defined(__AVX512F__)
+#  define SAF_ENABLED_SIMD_INTRINSICS_STRING "SSE, SSE2, SSE3, AVX, AVX2, AVX512F"
+# elif defined(__AVX__) && defined(__AVX2__)
+#  define SAF_ENABLED_SIMD_INTRINSICS_STRING "SSE, SSE2, SSE3, AVX, AVX2"
+# elif defined(__SSE__) && defined(__SSE2__) && defined(__SSE3__)
+#  define SAF_ENABLED_SIMD_INTRINSICS_STRING "SSE, SSE2, SSE3"
+# else
+#  define SAF_ENABLED_SIMD_INTRINSICS_STRING "None"
+# endif
+#else
+# define SAF_SIMD_STATUS_STRING "Disabled"
+# define SAF_ENABLED_SIMD_INTRINSICS_STRING "None"
+#endif
+
+/* Status of netCDF */
+#if defined(SAF_ENABLE_SOFA_READER_MODULE)
+# define SAF_NETCDF_STATUS_STRING "Enabled"
+#else
+# define SAF_NETCDF_STATUS_STRING "Disabled"
+#endif
+
+/** Current configuration information */
+#define SAF_EXTERNALS_CONFIGURATION_STRING  \
+    "Current SAF externals configuration: "                               "\n" \
+    " - Performance library: " SAF_CURRENT_PERFORMANCE_LIBRARY_STRING     "\n" \
+    " - Intel IPP status:    " SAF_INTEL_IPP_STATUS_STRING                "\n" \
+    " - FFTW status:         " SAF_FFTW_STATUS_STRING                     "\n" \
+    " - SIMD status:         " SAF_SIMD_STATUS_STRING                     "\n" \
+    " - Enabled intrinsics:  " SAF_ENABLED_SIMD_INTRINSICS_STRING         "\n" \
+    " - netCDF status:       " SAF_NETCDF_STATUS_STRING                   "\n"
+
+
 #endif /* __SAF_EXTERNALS_H_INCLUDED__ */

test/saf_test.c

@@ -66,6 +66,7 @@ int main_test(void) {
 #else
     printf(" (Debug):\n\n");
 #endif
+    printf("%s\n", SAF_EXTERNALS_CONFIGURATION_STRING);
 
     /* initialise */
     timer_lib_initialize();