Added the madvise new zswap test

Author: pallavigopal

tests/madvise/README.md

@@ -0,0 +1,47 @@
+# Instructions
+## Run in Baremetal
+1. Run
+   ```
+    ./make_swap_space.sh
+   ```
+   Additional details of make_swap_space.sh script:
+	Command Line Arguments: The script now accepts -l for specifying the swap file location and -s for specifying the swap size in GB.
+	Default Values: If no arguments are provided, it defaults to /mnt/nvme1/swapfile for the location and 1GB for the size.
+	Dynamic Path Handling: It dynamically checks the available space in the directory derived from the provided or default swap file location.
+	Example of creating 4GB swap space at /mnt/nvme1/swapfile
+	```
+	./make_swap_space.sh  [-l <path_to_swap_file>] [-s <swap_size_in_GBi>]
+	```
+2. Configure IAA device
+    ```
+    ./enable_kernel_iaa
+    ```
+3. Active zswap by runnig
+   ```
+   ./enable_zswap.sh
+   ```
+4. Collect data and generate reports for all the compressors.
+   ```
+   ./collect_all.sh
+   ```
+ This will generate html files for CDFs of compress, decompress, compression ratio and page fault latencies and a summary.xlsx file. This will also generate (to stdout) P50 & P99 values.
+
+## Additional details
+For running individual compressors
+
+   ```
+    echo 'lz4' > /sys/module/zswap/parameters/compressor
+    ./collect_bpftraces.sh
+    echo 'deflate-iaa-canned' > /sys/module/zswap/parameters/compressor
+    ./collect_bpftraces.sh
+   ```
+... and so on. This will generate a <compressor>_output file for each run
+
+Once all runs are collected, run the post-processing Python script:
+   ```
+    ./process_bpftraces.py
+   ```
+This will generate html files for CDFs of compress, decompress, compression ratio and page fault latencies and a summary.xlsx file.
+This will also generate (to stdout) P50 & P99 values.
+
+

tests/madvise/collect_all.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+#SPDX-License-Identifier: BSD-3-Clause
+#Copyright (c) 2023, Intel Corporation
+comp_list=("lz4" "lzo-rle" "lzo" "deflate-iaa" "deflate-iaa-canned" "zstd")
+
+freq_list=("2500" "2900")
+dataset_list=("silesia.tar" "defconfig.out")
+
+for freq in "${freq_list[@]}"; do
+  for dataset in "${dataset_list[@]}"; do
+    for comp in "${comp_list[@]}"; do
+      echo "Removing ${comp}_output"
+      rm -f ${comp}_output
+      echo $comp > /sys/module/zswap/parameters/compressor
+      echo "Collecting data for $comp at ${freq}MHz"
+      ./collect_bpftraces.sh -f $freq -t $dataset
+    done
+    ./process_bpftraces.py
+    rm -rf result_$freq_$dataset
+    echo "creating result_$freq_$dataset"
+    mkdir result_${freq}_${dataset}
+    cp *_output result_${freq}_${dataset}
+    cp *.html result_${freq}_${dataset}
+    cp *.xlsx result_${freq}_${dataset}
+    cp perf_* result_${freq}_${dataset}
+  done
+done

tests/madvise/collect_bpftraces.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+#SPDX-License-Identifier: BSD-3-Clause
+#Copyright (c) 2023, Intel Corporation
+
+# Define the location of the swap file
+SWAP="silesia.tar"
+COMP=$(cat /sys/module/zswap/parameters/compressor 2>/dev/null)
+CORE_FREQUENCY=2500
+
+
+while getopts "f:t:" opt; do
+  case $opt in
+    f) CORE_FREQUENCY="$OPTARG" ;;
+    t) SWAP="$OPTARG" ;;
+    \?) echo "Invalid option: -$OPTARG" >&2; exit 1 ;;
+  esac
+done
+
+# Function to handle errors
+handle_error() {
+    echo "Error: $1"
+    exit 1
+}
+
+
+# Set CPU frequency to 2.5GHz for performance
+cpupower frequency-set -g performance --min ${CORE_FREQUENCY}MHz --max ${CORE_FREQUENCY}MHz > /dev/null || handle_error "Failed to set CPU frequency"
+
+# Check if the swap file exists, if not download it
+if [ ! -f "$SWAP" ] ; then
+    case "$SWAP" in
+        "defconfig.out")
+	    echo "unzipping defconfig.out.gz"
+            gunzip < defconfig.out.gz > defconfig.out ;;
+        "silesia.tar")
+             echo "Downloading $SWAP from http://wanos.co/assets/silesia.tar"
+             wget --no-check-certificate http://wanos.co/assets/silesia.tar || handle_error "Failed to download $SWAP" ;;
+          *) echo "Invalid file $SWAP" ;  exit 1 ;
+     esac
+fi
+
+
+# Install bpftrace if it is not available
+if [ ! -f /usr/bin/bpftrace ]; then
+    echo "Installing bpftrace..."
+    yum install bpftrace -y || handle_error "Failed to install bpftrace"
+fi
+
+# Build the madvise_test executable if not already built
+if [ ! -f madvise_test ]; then
+    echo "Building madvise_test..."
+    gcc -o madvise_test madvise_test.c || handle_error "Failed to build madvise_test"
+fi
+
+# Turn off read-ahead to optimize performance
+echo 0 > /proc/sys/vm/page-cluster || handle_error "Failed to set page-cluster"
+
+
+# Clear transparent huge pages configuration
+echo 'never' > /sys/kernel/mm/transparent_hugepage/hugepages-2048kB/enabled || handle_error "Failed to clear hugepages-2048kB configuration"
+echo 'never' > /sys/kernel/mm/transparent_hugepage/enabled || handle_error "Failed to clear transparent_hugepage configuration"
+
+# Calculate swap size and pages
+SZ=$(ls -s "$SWAP" | awk '{print $1}')
+NPGS=$(echo "scale=0; $SZ/4-1" | bc -l)
+
+
+CMD="./madvise_test ${SWAP} ${NPGS}"
+if [[ $COMP == 'deflate-iaa-canned' || $COMP == 'deflate-iaa-dynamic'||$COMP == 'deflate-iaa' ]];then
+    COMP_STR="iaa_comp_acompress"
+    DCOMP_STR="iaa_comp_adecompress"
+    SZ_STR="arg0+68"
+elif [ $COMP == 'lzo-rle' ]; then
+    COMP_STR="lzorle_scompress"
+    DCOMP_STR="lzorle_sdecompress"
+    SZ_STR="arg4"
+else
+    COMP_STR="${COMP}_scompress"
+    DCOMP_STR="${COMP}_sdecompress"
+    SZ_STR="arg4"
+fi
+
+PROG=`echo "kprobe:${COMP_STR} { @start=nsecs; @sz=${SZ_STR}; } kretprobe:${COMP_STR} { printf (\"C %d\\nR %d\\n\", nsecs-@start, *@sz); }
+            kprobe:${DCOMP_STR} { @start=nsecs; } kretprobe:${DCOMP_STR} { printf (\"D %d\\n\", nsecs-@start); }
+	    kprobe:handle_mm_fault /(arg1&0xfff) == 0/{@pf[cpu]=nsecs; if(arg2!=0x1254) {@pf[cpu]=0;}} kretprobe:handle_mm_fault {if(@pf[cpu]) {printf(\"P %d\\n\", nsecs-@pf[cpu]);} @pf[cpu]=0;}
+	    kprobe:swap_writepage { @start_swap_write=nsecs; } kretprobe:swap_writepage { printf (\"SW %d\\n\", nsecs-@start_swap_write); }
+	    kprobe:swap_read_folio { @start_swap_read=nsecs; } kretprobe:swap_read_folio { printf (\"SR %d\\n\", nsecs-@start_swap_read);}
+	    kprobe:zswap_compress { @start_zswap_comp=nsecs; @zsz=arg1;} kretprobe:zswap_compress { printf (\"ZC %d\\nZCSZ %d\\nZCR %d\\n\", nsecs-@start_zswap_comp, *(@zsz+8), retval&0x1);}
+	    kprobe:zswap_decompress { @start_zswap_decomp=nsecs; } kretprobe:zswap_decompress { printf (\"ZD %d\\n\", nsecs-@start_zswap_decomp);}
+	    END { clear(@pf); delete(@start); delete(@sz);}"`
+
+perf stat -o perf_${COMP}.log bpftrace -e "${PROG}" -c "${CMD}" -o ${COMP}_output
+echo "Script completed successfully."

tests/madvise/defconfig.out.gz

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+#SPDX-License-Identifier: BSD-3-Clause
+#Copyright (c) 2023, Intel Corporation
+
+IAX_CONFIG_PATH=/sys/bus/dsa/devices
+
+IAX_BIND_PATH=/sys/bus/dsa/drivers/idxd/bind
+IAX_BIND_WQ_PATH=/sys/bus/dsa/drivers/crypto/bind
+
+IAX_UNBIND_PATH=/sys/bus/dsa/drivers/idxd/unbind
+IAX_UNBIND_WQ_PATH=/sys/bus/dsa/drivers/crypto/unbind
+
+#
+# count iax instances
+#
+iax_dev_id="0cfe"
+num_iax=$(lspci -d:${iax_dev_id} | wc -l)
+num_wq=1
+echo "Found ${num_iax} IAX instances"
+
+#
+# disable iax wqs and devices
+#
+echo "Disable IAX"
+
+for ((i = 1; i < 2 * ${num_iax}; i += 2)); do
+    for ((j = 0; j < ${num_wq}; j += 1)); do
+        echo disable wq iax${i}/wq${i}.${j}
+        echo wq${i}.${j} > $IAX_UNBIND_WQ_PATH
+    done
+    echo disable iax iax${i}
+    echo iax${i} > $IAX_UNBIND_PATH
+done
+
+rmmod iaa_crypto
+modprobe iaa_crypto

tests/madvise/disable_iaa

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+#SPDX-License-Identifier: BSD-3-Clause
+#Copyright (c) 2023, Intel Corporation
+
+IAX_CONFIG_PATH=/sys/bus/dsa/devices
+
+IAX_BIND_PATH=/sys/bus/dsa/drivers/idxd/bind
+IAX_BIND_WQ_PATH=/sys/bus/dsa/drivers/crypto/bind
+
+IAX_UNBIND_PATH=/sys/bus/dsa/drivers/idxd/unbind
+IAX_UNBIND_WQ_PATH=/sys/bus/dsa/drivers/crypto/unbind
+VERIFY_COMPRESS_PATH=/sys/bus/dsa/drivers/crypto/verify_compress
+
+# input arg: if not 0, setup dedicated work queues (default: 0)
+verify_compress=${1:-1}; shift
+mode=${1:-1}; shift
+iaa_devices=${1:-4}; shift
+iaa_engines=${1:-8}; shift
+iaa_wqs=${1:-1}; shift
+echo "enabled iaa_devices per socket: (${iaa_devices})"
+echo "enabled iaa_engines per device: (${iaa_engines})"
+
+# Get number of cores and sockets
+sockets=$(lscpu | grep Socket | awk '{print $2}')
+cores=$(lscpu | grep socket | awk '{print $4}')
+
+if [ ${iaa_engines} -eq 8 ]; then
+  engine_string=""
+else
+  engine_string="-engine-${iaa_engines}"
+fi
+
+if [ ${iaa_wqs} -ne 1 ]; then
+  wq_string="-${iaa_wqs}wq"
+else
+  wq_string=""
+fi
+
+
+#
+# select iax config
+#
+dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+echo ${dir}
+if [ ${mode} -eq 0 ]; then
+    config_json=${dir}/iax-${iaa_devices}${engine_string}${wq_string}-swq.json
+elif [ ${mode} -eq 1 ]; then
+    config_json=${dir}/iax-${iaa_devices}${engine_string}${wq_string}-dwq.json
+else
+    echo "unsupported mode ${mode}"
+    exit
+fi
+echo $config_json
+
+
+#
+# count iax instances
+#
+iax_dev_id="0cfe"
+num_iax_in_hw=$(lspci -d:${iax_dev_id} | wc -l)
+
+# apply verify-compress
+echo $verify_compress > ${VERIFY_COMPRESS_PATH}
+
+#
+# load iax config json
+#
+echo "Load IAX config: ${config_json}"
+accel-config load-config -c ${config_json}
+
+#
+# enable iax devices and wqs
+num_iax=${iaa_devices}
+socket_iax_start=1
+socket_iax_end=$(($num_iax*2))
+for ((socket = 0; socket < ${sockets}; socket += 1)); do
+
+    echo "Enable IAX  (${iaa_devices})"
+    for ((i = ${socket_iax_start}; i < ${socket_iax_end} ; i += 2)); do
+        echo enable iax iax${i}
+        echo iax${i} > $IAX_BIND_PATH
+    for ((j = 0; j < ${iaa_wqs}; j += 1)); do
+        echo enable wq wq${i}.${j}
+        echo wq${i}.${j} > $IAX_BIND_WQ_PATH
+    done
+    done
+    socket_iax_start=$(($socket_iax_start + ($num_iax)*2))
+    socket_iax_end=$(($socket_iax_end + ($num_iax)*2))
+done

tests/madvise/enable_kernel_iaa

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+#SPDX-License-Identifier: BSD-3-Clause
+#Copyright (c) 2023, Intel Corporation
+
+# Enable zswap
+echo "Enabling zswap..."
+sudo sh -c 'echo zsmalloc > /sys/module/zswap/parameters/zpool'
+sudo sh -c 'echo 1 > /sys/module/zswap/parameters/enabled'
+
+# Recheck the configuration
+ZPOOL=$(cat /sys/module/zswap/parameters/zpool)
+ENABLED=$(cat /sys/module/zswap/parameters/enabled)
+
+if [ "$ZPOOL" == "zsmalloc" ] && [ "$ENABLED" == "Y" ]; then
+    echo "zswap has been enabled with zpool set to zsmalloc."
+else
+    echo "Failed to configure zswap correctly. Please check the parameters."
+fi