[enhancement] workload-xsave: Add cmake build support

1. Based on the instruction set supported by the CPU, selectively compile the source files.

Signed-off-by: Haoliang Zhu <[email protected]>

workload-xsave/CMakeLists.txt

@@ -0,0 +1,94 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# Copyright (c) 2024 Intel Corporation.
+# Yi Sun <[email protected]>
+# Haoliang Zhu <[email protected]>
+
+cmake_minimum_required(VERSION 3.12)
+project(Yogini)
+
+# Set the compiler
+set(CMAKE_C_COMPILER ${CROSS_COMPILE}gcc)
+
+# Set the build output directory
+set(BUILD_OUTPUT ${CMAKE_CURRENT_BINARY_DIR})
+
+# Set the installation prefix
+if(NOT CMAKE_INSTALL_PREFIX)
+    set(CMAKE_INSTALL_PREFIX /usr)
+endif()
+
+# Set the source files
+set(SRC
+    yogini.c
+    work_UMWAIT.c
+    work_TPAUSE.c
+    work_RDTSC.c
+    work_PAUSE.c
+    work_memcpy.c
+    work_MEM.c
+    # The source files here are not needed for now
+    # run_common.c
+    # work_GETCPU.c
+)
+
+add_compile_definitions(CMAKE_FLAG=0)
+
+# Get target CPU information
+execute_process(
+    COMMAND ${CMAKE_C_COMPILER} -march=native -Q --help=target
+    OUTPUT_VARIABLE TARGET_CPU
+    ERROR_QUIET
+)
+
+# Print information about the target CPU
+message(STATUS "Target CPU: ${TARGET_CPU}")
+
+# Function to check for CPU feature and add source files and compile definition if the feature is enabled
+function(check_cpu_feature)
+    # Separate the feature, compile definition, and source files
+    set(options "")
+    set(oneValueArgs FEATURE COMPILE_DEFINITION)
+    set(multiValueArgs SOURCES)
+    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    string(REGEX MATCH "${ARG_FEATURE}[ \t]+\\[enabled\\]" feature_enabled_match "${TARGET_CPU}")
+    if(feature_enabled_match)
+        message(STATUS "${ARG_FEATURE} is enabled")
+        add_compile_definitions(${ARG_COMPILE_DEFINITION}=1)
+        # Append all source files to the list in the parent scope
+        set(SRC_LIST ${SRC})
+        foreach(source_file IN LISTS ARG_SOURCES)
+            list(APPEND SRC_LIST ${source_file})
+        endforeach()
+        set(SRC ${SRC_LIST} PARENT_SCOPE)
+    else()
+        message(STATUS "${ARG_FEATURE} is disabled or not found")
+    endif()
+endfunction()
+
+# Check CPU feature and add source files and compile definition
+check_cpu_feature(FEATURE "-mamx-tile" COMPILE_DEFINITION "MAMX_ENABLED" SOURCES "work_AMX.c")
+check_cpu_feature(FEATURE "-mavx" COMPILE_DEFINITION "MAVX_ENABLED" SOURCES "work_AVX.c")
+check_cpu_feature(FEATURE "-mavx2" COMPILE_DEFINITION "MAVX2_ENABLED" SOURCES "work_AVX2.c" "work_DOTPROD.c")
+check_cpu_feature(FEATURE "-mavx512f" COMPILE_DEFINITION "MAVX512f_ENABLED" SOURCES "work_AVX512.c")
+check_cpu_feature(FEATURE "-mvnni" COMPILE_DEFINITION "MVNNI_ENABLED" SOURCES "work_VNNI.c")
+check_cpu_feature(FEATURE "-mvnni512" COMPILE_DEFINITION "MVNNSI512_ENABLED" SOURCES "work_VNNI512.c")
+
+# Print the contents of the SRC
+message(STATUS "SRC contains the following files: ${SRC}")
+
+# Set the compiler flags
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_FORTIFY_SOURCE=2 -Wall -O3")
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -march=native")
+# Add the -g flags, if use gdb for debugging
+# set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g")
+
+# Add the executable
+add_executable(yogini ${SRC})
+
+# Link libraries
+target_link_libraries(yogini m pthread)
+
+# Install the program
+install(TARGETS yogini DESTINATION ${CMAKE_INSTALL_PREFIX}/bin)

workload-xsave/README.md

@@ -14,7 +14,7 @@ These instructions will help you get a copy of the Intel SIMD Instruction Microb
 
 ### Prerequisites
 * C/C++ compiler with support for the desired SIMD instruction sets.
-* Make installed.
+* CMake and make installed.
 
 ### Installation
 Clone the repository to your local machine:
@@ -25,8 +25,19 @@ Enter the project directory:
 ```
 cd workload-xsave
 ```
+#### CMake(Recommended)
+The CMakeLists.txt is capable of selecting the appropriate source files for compilation based on the instruction sets supported by the target CPU.
 Build the benchmarks using CMake:
 ```
+mkdir build
+cd build
+cmake ..
+make
+```
+
+#### Make(Alternative)
+Build the benchmarks using Make:
+```
 make
 ```
 Or, if your platform is not support all SIMD feature, you can try

workload-xsave/yogini.h

@@ -9,9 +9,14 @@
 
 #ifndef YOGINI_H
 #define YOGINI_H
-#include<string.h>
+#include <string.h>
+#include <stdio.h>
 #include <pthread.h>
 
+#ifndef CMAKE_FLAG
+#define CMAKE_FLAG 1
+#endif
+
 struct work_instance {
 	struct work_instance *next;
 	pthread_t thread_id;
@@ -55,13 +60,19 @@ extern unsigned int SIZE_1GB;
 
 #ifdef YOGINI_MAIN
 struct workload *(*all_register_routines[]) () = {
+#if MAVX_ENABLED || CMAKE_FLAG
 	register_AVX,
+#endif
+#if MAVX2_ENABLED || CMAKE_FLAG
 	register_AVX2,
+#endif
+#if MAVX512F_ENABLED || CMAKE_FLAG
 	register_AVX512,
-#if __GNUC__ >= 9
+#endif
+#if MVNNI512_ENABLED || CMAKE_FLAG
 	register_VNNI512,
 #endif
-#if __GNUC__ >= 11
+#if MVNNI_ENABLED || CMAKE_FLAG
 	register_VNNI,
 #endif
 	register_DOTPROD,
@@ -71,10 +82,14 @@ struct workload *(*all_register_routines[]) () = {
 	register_UMWAIT,
 #endif
 	register_RDTSC,
+#if MSSE_ENABLED || CMAKE_FLAG
 	register_SSE,
+#endif
 	register_MEM,
 	register_memcpy,
+#if MAMX_ENABLED || CMAKE_FLAG
 	register_AMX,
+#endif
 	NULL
 };
 #endif