[libc] Add CMake script to check host cpu features

[gchatelet]

Summary

Tested on MacOSX and Linux.
For robustness we can go the OpenCV way and add individual c++ files with intrinsics.
https://github.com/opencv/opencv/blob/master/cmake/checks/cpu_avx2.cpp

[gchatelet]

• formatting nits

[gchatelet]

• make it explicit that these are host's cpu_features

[gchatelet]

There are slight variations in how the cpu features are encoded for instance OSX has AVX1.0 where Linux has AVX.
So I believe we need something more robust.

[abrachet]

For robustness we can go the OpenCV way and add individual c++ files with intrinsics.
https://github.com/opencv/opencv/blob/master/cmake/checks/cpu_avx2.cpp

I think this makes the most sense. It's also what cmake does in the initial configuration step where it creates small source files and sees if they compile. Do all of the cpu features that you are interested in have related intrinsics? Or will we need to assemble and run files to see if the cpu raises an invalid opcode exception?

[sivachandra]

In D74897#1885013, @abrachet wrote:

For robustness we can go the OpenCV way and add individual c++ files with intrinsics.
https://github.com/opencv/opencv/blob/master/cmake/checks/cpu_avx2.cpp

I think this makes the most sense. It's also what cmake does in the initial configuration step where it creates small source files and sees if they compile. Do all of the cpu features that you are interested in have related intrinsics? Or will we need to assemble and run files to see if the cpu raises an invalid opcode exception?

Yes, this is what I was hinting at when I proposed the try_run/try_compile solution.
I am OK with this change however if you think it will help you make progress with other things but may be put this in a x86 specific location.

libc/cmake/modules/LLVMLibCCheckCpuFeatures.cmake

11

If OSX requires more massaging of the results, then may be just not include it here?

21

Apparently, cpuinfo on powerpc does not give the flags!

[gchatelet]

• Uses a more principled detection mechanism

[sivachandra]

libc/cmake/modules/LLVMLibCCheckCpuFeatures.cmake

2

I had a hard time jumping through the various pieces here. WDYT of this suggestion:

Populate ALL_CPU_FEATURES first up as:

if(${LIBC_TARGET_MACHINE} MATCHES "x86|x86_64")
  set(ALL_CPU_FEATURES SSE SSE2 AVX AVX512)
endif()

Then, you can have just one function called check_cpu_features which populates HOST_CPU_FEATURES as a return value. You choose to use a helper function like define_compiler_options_for_feature:

function(define_compiler_options_for_feature feature)
  if(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
    string(TOLOWER ${feature} lowercase_feature)
    set(CPU_FEATURE_${name}_ENABLE_FLAG "-m${lowercase_feature}" PARENT_SCOPE)
    set(CPU_FEATURE_${name}_DISABLE_FLAG "-mno-${lowercase_feature}" PARENT_SCOPE)
  else()
    # In future, we can extend for other compilers.
    message(FATAL "Unkown compiler ${CMAKE_CXX_COMPILER_ID}.")
  endif()
endfunction()

23

We shouldn't need this block.

30

Does it need to be set here?

52

We can push this foreach block into the above function and instead have a call to the function without any args? If you want to split, then may be call the above function check_single_cpu_feature which gives a yes/no answer, and the function check_cpu_features will call this single feature function and populate AVAILABLE_CPU_FEATURES as a return value. When cross-compiling, one will have to set AVAILABLE_CPU_FEATURES manually.

WDYT?

[sivachandra]

The overall approach is solid. I left a few comments related to future extensions/scalability.

[gchatelet]

• Address comments

[gchatelet]

Let me know if it's better now @sivachandra

[gchatelet]

• Added construction of flag list to support up to a particular cpu feature

[gchatelet]

Please note that this is not the final solution since it assumes a linear hierarchy of the features. This is the case for X86 but not true for other architectures like ARM.
I need to think about it a little more but we can start from here.

[sivachandra]

This has a better top-down flow. I left a few minor comments inline but accepting as I agree with you that we can iterate as required.

libc/cmake/modules/LLVMLibCCheckCpuFeatures.cmake

16

Do we really need this function? We only iterate over the ALL_CPU_FEATURES list which is a literal list defined in this file.

44

If you want these flags available in global scope, then may be prefix them with CPU_FEATURE_OPT_<FEATURE>_FLAGS?

88

Like above, do we need this call?

[gchatelet]

Rebased and addressed comments.

libc/cmake/modules/LLVMLibCCheckCpuFeatures.cmake

16

Removed.

libc/cmake/modules/LLVMLibCCheckCpuFeatures.cmake

+#------------------------------------------------------------------------------
+# Cpu features definition and flags
+#
+# Declare a list of all supported cpu features in ALL_CPU_FEATURES.
+#
+# Declares associated flags to enable/disable individual feature of the form:
+# - CPU_FEATURE_<FEATURE>_ENABLE_FLAG
+# - CPU_FEATURE_<FEATURE>_DISABLE_FLAG
+#
+#------------------------------------------------------------------------------
+
+if(${LIBC_TARGET_MACHINE} MATCHES "x86|x86_64")
+  set(ALL_CPU_FEATURES SSE SSE2 AVX AVX512F)
+endif()
+
+function(check_valid_feature feature)
+  if(NOT ${feature} IN_LIST ALL_CPU_FEATURES)
+    message(FATAL_ERROR "${feature} is not part of available ${ALL_CPU_FEATURES}")
+  endif()
+endfunction()
+
+function(_define_cpu_feature_flags feature)
+  check_valid_feature(${feature})
+  if(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
+    string(TOLOWER ${feature} lowercase_feature)
+    set(CPU_FEATURE_${feature}_ENABLE_FLAG "-m${lowercase_feature}" PARENT_SCOPE)
+    set(CPU_FEATURE_${feature}_DISABLE_FLAG "-mno-${lowercase_feature}" PARENT_SCOPE)
+  else()
+    # In future, we can extend for other compilers.
+    message(FATAL_ERROR "Unkown compiler ${CMAKE_CXX_COMPILER_ID}.")
+  endif()
+endfunction()
+
+# Defines cpu features flags
+foreach(feature IN LISTS ALL_CPU_FEATURES)
+  _define_cpu_feature_flags(${feature})
+endforeach()
+
+#------------------------------------------------------------------------------
+# Optimization level flags
+#
+# Generates the set of flags needed to compile for a up to a particular optimization level
+#
+# Creates variables of the form `OPT_<FEATURE>_FLAGS`.
+# OPT_NONE_FLAGS is a special flag for which no feature is needed.
+#
+# e.g.
+# OPT_NONE_FLAGS : -mno-sse;-mno-sse2;-mno-avx;-mno-avx512f
+# OPT_SSE_FLAGS : -msse;-mno-sse2;-mno-avx;-mno-avx512f
+# OPT_SSE2_FLAGS : -msse;-msse2;-mno-avx;-mno-avx512f
+# OPT_AVX_FLAGS : -msse;-msse2;-mavx;-mno-avx512f
+# OPT_AVX512F_FLAGS : -msse;-msse2;-mavx;-mavx512f
+#------------------------------------------------------------------------------
+
+# Helper function to concatenate flags needed to support optimization up to
+# a particular feature.
+function(_generate_flags_for_up_to feature flag_variable)
+  list(FIND ALL_CPU_FEATURES ${feature} feature_index)
+  foreach(current_feature IN LISTS ALL_CPU_FEATURES)
+    list(FIND ALL_CPU_FEATURES ${current_feature} current_feature_index)  
+    if(${current_feature_index} GREATER ${feature_index})
+      list(APPEND flags ${CPU_FEATURE_${current_feature}_DISABLE_FLAG})
+    else()
+      list(APPEND flags ${CPU_FEATURE_${current_feature}_ENABLE_FLAG})
+    endif()
+  endforeach()
+  set(${flag_variable} ${flags} PARENT_SCOPE)
+endfunction()
+
+function(_generate_opt_levels)
+  set(opt_levels NONE)
+  list(APPEND opt_levels ${ALL_CPU_FEATURES})
+  foreach(feature IN LISTS opt_levels)
+    set(flag_name "OPT_${feature}_FLAGS")
+    _generate_flags_for_up_to(${feature} ${flag_name})
+    set(${flag_name} ${${flag_name}} PARENT_SCOPE)
+  endforeach()
+endfunction()
+
+_generate_opt_levels()
+
+#------------------------------------------------------------------------------
+# Host cpu feature introspection
+#
+# Populates a HOST_CPU_FEATURES list containing the available CPU_FEATURE.
+#------------------------------------------------------------------------------
+function(_check_host_cpu_feature feature)
+  check_valid_feature(${feature})
+  string(TOLOWER ${feature} lowercase_feature)
+  try_run(
+    run_result
+    compile_result
+    "${CMAKE_CURRENT_BINARY_DIR}/check_${lowercase_feature}"
+    "${CMAKE_MODULE_PATH}/cpu_features/check_${lowercase_feature}.cpp"
+    COMPILE_DEFINITIONS ${CPU_FEATURE_${feature}_ENABLE_FLAG}
+    OUTPUT_VARIABLE compile_output
+  )
+  if(${compile_result} AND ("${run_result}" EQUAL 0))
+    list(APPEND HOST_CPU_FEATURES ${feature})
+    set(HOST_CPU_FEATURES ${HOST_CPU_FEATURES} PARENT_SCOPE)
+  endif()
+endfunction()
+
+foreach(feature IN LISTS ALL_CPU_FEATURES)
+  _check_host_cpu_feature(${feature})
+endforeach()

libc/cmake/modules/cpu_features/check_avx.cpp

+#if !defined __AVX__
+#error "missing __AVX__"
+#endif
+#include <immintrin.h>
+int main() {
+  (void)_mm256_set1_epi8('0');
+  return 0;
+}

libc/cmake/modules/cpu_features/check_avx512f.cpp

+#if !defined __AVX512F__
+#error "missing __AVX512F__"
+#endif
+#include <immintrin.h>
+int main() {
+  (void)_mm512_undefined();
+  return 0;
+}

libc/cmake/modules/cpu_features/check_sse.cpp

+#if !defined __SSE__
+#error "missing __SSE__"
+#endif
+#include <immintrin.h>
+int main() {
+  (void)_mm_set_ss(1.0f);
+  return 0;
+}

libc/cmake/modules/cpu_features/check_sse2.cpp

+#if !defined __SSE2__
+#error "missing __SSE2__"
+#endif
+#include <immintrin.h>
+int main() {
+  (void)_mm_set1_epi8('0');
+  return 0;
+}