common: introduce the PMEM Benchmark workflow

Signed-off-by: Jan Michalski <jan.michalski@intel.com>

.github/actions/pmem_benchmark_run/action.yml

@@ -0,0 +1,53 @@
+name: PMEM benchmark procedure
+description: PMDK benchmarking procedure for self-hosted runners equipped with PMEM
+inputs:
+ runtime_dir:
+ description: The root directory of the repository designated as runtime
+ required: true
+ reference_LIB_PATH:
+ description: LD_LIBRARY_PATH where the first version of PMDK is built
+ required: true
+ rival_LIB_PATH:
+ description: LD_LIBRARY_PATH where the second version of PMDK is built
+ required: true
+ config:
+ description: Name of the .cfg file to use
+ required: true
+ scenario:
+ description: Name of the scenario to run
+ required: true
+ pmem_path:
+ description: A PMEM-mounted directory to use
+ default: /mnt/pmem0
+runs:
+ using: composite
+ steps:
+ - name: Identify the NUMA node local to PMEM
+ id: numa
+ shell: bash
+ run: |
+ DEV=$(mount | grep ${{ inputs.pmem_path }} | cut -d' ' -f1 | cut -d'/' -f 3)
+ NUMA=$(ndctl list -v | jq ".[] | select(.blockdev==\"$DEV\" and .mode==\"fsdax\") | .numa_node")
+ echo "node=$NUMA" >> $GITHUB_OUTPUT
+
+ - name: Run the benchmark
+ working-directory: ${{ inputs.runtime_dir }}
+ shell: bash
+ run: >-
+ ./utils/benchmarks/run_and_combine.py
+ --reference ${{ inputs.reference_LIB_PATH }} --rival ${{ inputs.rival_LIB_PATH }}
+ --config ${{ inputs.config }} --scenario ${{ inputs.scenario }}
+ --pmem_path ${{ inputs.pmem_path }} --numa_node ${{ steps.numa.outputs.node }}
+
+ - name: Archive logs
+ if: always()
+ uses: actions/upload-artifact@v4
+ with:
+ name: ${{ inputs.config }}__${{ inputs.scenario }}
+ path: '${{ inputs.runtime_dir }}/*.csv'
+
+ - name: Remove logs
+ if: always()
+ working-directory: ${{ inputs.runtime_dir }}
+ shell: bash
+ run: rm -f *.csv

.github/workflows/pmem_benchmark.yml

@@ -0,0 +1,79 @@
+name: PMEM Benchmark
+
+on:
+ workflow_dispatch:
+ inputs:
+ reference_ref:
+ type: string
+ default: master
+ rival_ref:
+ type: string
+ default: stable-2.0
+ push: # XXX
+
+
+jobs:
+ prep:
+ name: Prepare ${{ matrix.ROLE }}
+ runs-on: [self-hosted, benchmark]
+ strategy:
+ matrix:
+ include:
+ - ROLE: reference
+ GITHUB_REF: master # XXX ${{ inputs.reference_ref }}
+ - ROLE: rival
+ GITHUB_REF: stable-2.0 # XXX ${{ inputs.rival_ref }}
+ - ROLE: runtime
+ GITHUB_REF: ''
+ permissions:
+ contents: read
+ steps:
+ - name: Clone the git repo (libraries)
+ uses: actions/checkout@v4
+ with:
+ ref: ${{ matrix.GITHUB_REF }}
+ fetch-depth: 1
+ path: ${{ matrix.ROLE }}
+
+ - name: Build libraries
+ working-directory: ${{ matrix.ROLE }}
+ run: make -j
+
+
+ run:
+ name: Run perf.cfg ${{ matrix.SCENARIO }}
+ runs-on: [self-hosted, benchmark]
+ needs: prep
+ strategy:
+ matrix:
+ SCENARIO:
+ - obj_tx_alloc_small_v_thread
+ - obj_pmalloc_small_v_threads
+ - obj_rbtree_map_insert
+ - obj_hashmap_tx_map_insert
+ steps:
+ - name: Benchmark
+ uses: ./runtime/.github/actions/pmem_benchmark_run
+ with:
+ runtime_dir: ./runtime/
+ reference: ../reference/src/nondebug
+ rival: ../rival/src/nondebug
+ config: perf
+ scenario: ${{ matrix.SCENARIO }}
+
+
+ repack:
+ name: Repack
+ runs-on: ubuntu-latest
+ needs: run
+ steps:
+ - name: Download all artifacts
+ uses: actions/download-artifact@v4
+ with:
+ path: csvs
+
+ - name: Upload all as a single artifact
+ uses: actions/upload-artifact@v4
+ with:
+ name: perf__all
+ path: csvs/**/*