diff --git a/.github/workflows/sftp-benchmark.yml b/.github/workflows/sftp-benchmark.yml new file mode 100644 index 000000000..fd0f85837 --- /dev/null +++ b/.github/workflows/sftp-benchmark.yml @@ -0,0 +1,184 @@ +name: Benchmark Test + +on: + push: + branches: [ '*' ] + pull_request: + branches: [ '*' ] + +# give permissions to write a comment on the pull request +permissions: + pull-requests: write + actions: read + contents: read + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build_wolfssl: + strategy: + fail-fast: false + matrix: + os: [ ubuntu-latest ] + wolfssl: [ master ] + name: Build wolfssl + runs-on: ${{ matrix.os }} + timeout-minutes: 4 + steps: + - name: Checking cache for wolfssl + uses: actions/cache@v4 + id: cache-wolfssl + with: + path: build-dir/ + key: wolfssh-benchmark-wolfssl-${{ matrix.wolfssl }}-${{ matrix.os }} + lookup-only: true + + - name: Checkout, build, and install wolfssl + if: steps.cache-wolfssl.outputs.cache-hit != 'true' + uses: wolfSSL/actions-build-autotools-project@v1 + with: + repository: wolfssl/wolfssl + ref: ${{ matrix.wolfssl }} + path: wolfssl + configure: --enable-all --enable-intelasm --enable-sp --enable-sp-asm + check: false + install: true + + build_wolfssh: + needs: + - build_wolfssl + strategy: + fail-fast: false + matrix: + os: [ ubuntu-latest ] + wolfssl: [ master ] + name: Collect SFTP performance + runs-on: ${{ matrix.os }} + timeout-minutes: 15 + steps: + - name: Checking cache for wolfssl + uses: actions/cache@v4 + with: + path: build-dir/ + key: wolfssh-benchmark-wolfssl-${{ matrix.wolfssl }}-${{ matrix.os }} + fail-on-cache-miss: true + + - uses: actions/checkout@v4 + with: + path: wolfssh/ + + - name: autogen + working-directory: ./wolfssh/ + run: ./autogen.sh + + - name: configure + working-directory: ./wolfssh/ + run : | + ./configure --enable-all LDFLAGS="-L${{ github.workspace }}/build-dir/lib" CPPFLAGS="-I${{ github.workspace }}/build-dir/include -DWOLFSSH_NO_FPKI -DWOLFSSH_NO_SFTP_TIMEOUT -DWOLFSSH_MAX_SFTP_RW=4000000 -DMAX_PATH_SZ=120 -DEXAMPLE_SFTP_BENCHMARK" + + - name: make + working-directory: ./wolfssh/ + run: make + + - name: Get Saved OpenSSH Upload Results + id: cache-upload + uses: actions/cache/restore@v4 + with: + path: wolfssh/openssh-average-upload.csv + key: openssh-average-upload.csv + + - name: Get Saved OpenSSH Download Results + id: cache-download + uses: actions/cache/restore@v4 + with: + path: wolfssh/openssh-average-download.csv + key: openssh-average-download.csv + + - name: Install gnuplot + run: sudo apt-get install gnuplot + + - name: Setup OpenSSH Test Server + working-directory: ./wolfssh/ + run: | + sudo apt-get install openssh-server + mkdir ~/.ssh + chmod 700 ~/.ssh + echo "AuthorizedKeysFile $PWD/keys/hansel-key-ecc.pub" >> sshd-config-test.txt + echo "PubkeyAuthentication yes" >> sshd-config-test.txt + echo "Subsystem sftp internal-sftp" >> sshd-config-test.txt + echo "KbdInteractiveAuthentication no" >> sshd-config-test.txt + echo "PasswordAuthentication no" >> sshd-config-test.txt + echo "StrictModes no" >> sshd-config-test.txt + sed -i.bak "s/hansel/$USER/" ./keys/hansel-key-ecc.pub + chmod 600 ./keys/hansel-key-*.pem + chmod 600 ./keys/hansel-key-*.pub + sudo mkdir -p /run/sshd + sudo chmod 755 /run/sshd + sudo /usr/sbin/sshd -p 22222 -f sshd-config-test.txt -E $PWD/sshd-log.txt + cat sshd-config-test.txt + ps -e | grep sshd + + - name: Run SFTP client benchmark + working-directory: ./wolfssh/ + timeout-minutes: 8 + run: | + ./scripts/get-sftp-benchmark.sh 22222 + + - name: Save OpenSSH Upload Results + if: always() && steps.cache-upload.outputs.cache-hit != 'true' && hashFiles('wolfssh/openssh-average-upload.csv') != '' + uses: actions/cache/save@v4 + with: + path: wolfssh/openssh-average-upload.csv + key: openssh-average-upload.csv + + - name: Save OpenSSH Download Results + if: always() && steps.cache-download.outputs.cache-hit != 'true' && hashFiles('wolfssh/openssh-average-download.csv') != '' + uses: actions/cache/save@v4 + with: + path: wolfssh/openssh-average-download.csv + key: openssh-average-download.csv + + - name: Store Upload Speed PNG + uses: actions/upload-artifact@v4 + with: + name: upload-results-pr${{ github.event.pull_request.number }}.png + path: wolfssh/upload-results.png + retention-days: 2 + + - name: Store Download Speed PNG + uses: actions/upload-artifact@v4 + with: + name: download-results-pr${{ github.event.pull_request.number }}.png + path: wolfssh/download-results.png + retention-days: 2 + +# Currently the comment in PR does not work correctly +# - name: Comment on PR about performance +# env: +# GITHUB_URL: ${{ github.event.pull_request.comments_url }} +# GH_TOKEN: ${{ github.token }} +# PR_NUMBER: ${{ github.event.pull_request.number }} +# RUN_ID: ${{ github.run_id }} +# run: | +# # Get both artifact IDs +# DOWNLOAD_ARTIFACT=$(gh api repos/${{ github.repository }}/actions/artifacts \ +# --jq '.artifacts[] | select(.name | contains("download-results-pr")) | .id') +# UPLOAD_ARTIFACT=$(gh api repos/${{ github.repository }}/actions/artifacts \ +# --jq '.artifacts[] | select(.name | contains("upload-results-pr")) | .id') +# +# # Create the comment with direct link to download +# curl -X POST \ +# $GITHUB_URL \ +# -H "Content-Type: application/json" \ +# -H "Authorization: token $GH_TOKEN" \ +# -d "{\"body\":\"Performance test results:\n\n- [Download Results](https://github.com/${{ github.repository }}/actions/runs/$RUN_ID/artifacts/$DOWNLOAD_ARTIFACT)\n- [Upload Results](https://github.com/${{ github.repository }}/actions/runs/$RUN_ID/artifacts/$UPLOAD_ARTIFACT)\"}" + + - name: Print logs if failed + working-directory: ./wolfssh/ + if: failure() + run: | + sudo cat sshd-log.txt + cat log.csv + diff --git a/examples/sftpclient/sftpclient.c b/examples/sftpclient/sftpclient.c index 011d1c9a9..641cd6d3d 100644 --- a/examples/sftpclient/sftpclient.c +++ b/examples/sftpclient/sftpclient.c @@ -153,6 +153,21 @@ static void err_msg(const char* s) gettimeofday(&tv, 0); return (word32)tv.tv_sec; } + +#ifdef EXAMPLE_SFTP_BENCHMARK + double current_time_ms(int); + + /* return number of micro seconds */ + double current_time_ms(int reset) + { + struct timeval tv; + + (void)reset; + + gettimeofday(&tv, 0); + return (word64)(tv.tv_sec*1000000) + tv.tv_usec; + } +#endif #endif /* USE_WINDOWS_API */ #endif /* !WOLFSSH_NO_TIMESTAMP */ @@ -1505,6 +1520,13 @@ static int doAutopilot(int cmd, char* local, char* remote) WS_SFTPNAME* name = NULL; word32 remoteSz; byte remoteAbsPath = 0; +#if !defined(WOLFSSH_NO_TIMESTAMP) && !defined(USE_WINDOWS_API) &&\ + defined(EXAMPLE_SFTP_BENCHMARK) + double currentTime; + double longBytes = 0; + FILE* f; +#endif + /* check if is absolute path before making it one */ if (remote != NULL && WSTRLEN(remote) > 2 && remote[1] == ':' && @@ -1533,6 +1555,19 @@ static int doAutopilot(int cmd, char* local, char* remote) return WS_FATAL_ERROR; } +#if !defined(WOLFSSH_NO_TIMESTAMP) && !defined(USE_WINDOWS_API) &&\ + defined(EXAMPLE_SFTP_BENCHMARK) + ret = WFOPEN(NULL, &f, fullpath, "rb"); + if (ret != 0 || f == WBADFILE) return WS_BAD_FILE_E; + if (WFSEEK(NULL, f, 0, WSEEK_END) != 0) { + WFCLOSE(NULL, f); + return WS_BAD_FILE_E; + } + longBytes = (word32)WFTELL(NULL, f); + WREWIND(NULL, f); + currentTime = current_time_ms(0); +#endif + do { if (err == WS_REKEYING || err == WS_WINDOW_FULL) { /* handle rekeying and window-full state */ do { @@ -1579,6 +1614,16 @@ static int doAutopilot(int cmd, char* local, char* remote) fullpath, local); } } +#if !defined(WOLFSSH_NO_TIMESTAMP) && !defined(USE_WINDOWS_API) &&\ + defined(EXAMPLE_SFTP_BENCHMARK) + else { + currentTime = current_time_ms(0) - currentTime; + double result; + result = (double)longBytes / 1000000; + result = result / ((double)currentTime / 1000000); + printf("Transferred %s at %.2fMB/s\n", fullpath, result); + } +#endif wolfSSH_SFTPNAME_list_free(name); return ret; diff --git a/scripts/get-sftp-benchmark.sh b/scripts/get-sftp-benchmark.sh new file mode 100755 index 000000000..d69af59e2 --- /dev/null +++ b/scripts/get-sftp-benchmark.sh @@ -0,0 +1,213 @@ +#!/bin/bash + +KEY="$PWD/keys/hansel-key-ecc.pem" +TEST_FILE="$PWD/test" +FILE_SIZES=("5000" "10000" "50000" "100000" "150000" "200000" "250000" "300000" "350000" "400000" "500000" "1000000" "2000000") +TRANSFER_MBS="" +NUMBER_RUNS=10 +LOG_FILE="$PWD/log.csv" +COMPARE_TO="" +AVERAGE_FILE="" + +if [ -z $1 ]; then + echo "Assuming default server port of 22 (pass port number as first" + echo "argument if wanting to connect to a different port)" + PORT=22 +else + PORT="$1" +fi + +# Print the last transfer rate in the sftp progress output as MB/s +parse_openssh_rate() { + TRANSFER_MBS="$(tr '\r' '\n' < "$1" | awk ' + { + for (i = 1; i <= NF; i++) { + if ($i ~ /^[0-9.]+[KMG]?B\/s$/) { + v = $i; u = $i + sub(/[KMG]?B\/s$/, "", v) + sub(/^[0-9.]+/, "", u) + if (u == "B/s") v /= 1024 * 1024 + else if (u == "KB/s") v /= 1024 + else if (u == "GB/s") v *= 1024 + rate = v + } + } + } + END { if (rate != "") printf "%.3f", rate }')" + if [ -n "$TRANSFER_MBS" ]; then + printf " $TRANSFER_MBS" >> $LOG_FILE + else + echo "Failed to parse sftp rate from $1" >&2 + cat "$1" >&2 + exit 1 + fi +} + +do_openssh_put_test() { + cp $TEST_FILE $TEST_FILE-out + sftp_command="timeout 30 sftp -P $PORT -o BatchMode=yes -o StrictHostKeyChecking=no -i $KEY $USER@127.0.0.1" + output_file="sftp_log.txt" + + # Start the script command to capture the sftp session +script -qec "$sftp_command << EOF + put $TEST_FILE $TEST_FILE-out + bye +EOF" /dev/null > $output_file 2>&1 + if [ $? -ne 0 ]; then + echo "OpenSSH SFTP transfer failed" >&2 + cat $output_file >&2 + exit 1 + fi + parse_openssh_rate $output_file +} + +do_openssh_get_test() { + cp $TEST_FILE $TEST_FILE-out + sftp_command="timeout 30 sftp -P $PORT -o BatchMode=yes -o StrictHostKeyChecking=no -i $KEY $USER@127.0.0.1" + output_file="sftp_log.txt" + + # Start the script command to capture the sftp session +script -qec "$sftp_command << EOF + get $TEST_FILE $TEST_FILE-out + bye +EOF" /dev/null > $output_file 2>&1 + if [ $? -ne 0 ]; then + echo "OpenSSH SFTP transfer failed" >&2 + cat $output_file >&2 + exit 1 + fi + parse_openssh_rate $output_file +} + +do_wolfssh_put_test() { + cp $TEST_FILE $TEST_FILE-out + if ! RESULT=$(timeout 30 ./examples/sftpclient/wolfsftp -g -l $TEST_FILE -r $TEST_FILE-out -i $PWD/keys/hansel-key-ecc.der -j $PWD/keys/hansel-key-ecc.pub -u $USER -p $PORT); then + echo "wolfSSH SFTP transfer failed: $RESULT" >&2 + exit 1 + fi + TRANSFER_MBS="$(echo "$RESULT" | awk '/^Transferred .*MB\/s$/ {sub(/MB\/s$/, "", $NF); print $NF}')" + if [ -z "$TRANSFER_MBS" ]; then + echo "Failed to parse wolfSSH rate: $RESULT" >&2 + exit 1 + fi + printf " $TRANSFER_MBS" >> $LOG_FILE +} + +do_wolfssh_get_test() { + cp $TEST_FILE $TEST_FILE-out + if ! RESULT=$(timeout 30 ./examples/sftpclient/wolfsftp -G -l $TEST_FILE-out -r $TEST_FILE -i $PWD/keys/hansel-key-ecc.der -j $PWD/keys/hansel-key-ecc.pub -u $USER -p $PORT); then + echo "wolfSSH SFTP transfer failed: $RESULT" >&2 + exit 1 + fi + TRANSFER_MBS="$(echo "$RESULT" | awk '/^Transferred .*MB\/s$/ {sub(/MB\/s$/, "", $NF); print $NF}')" + if [ -z "$TRANSFER_MBS" ]; then + echo "Failed to parse wolfSSH rate: $RESULT" >&2 + exit 1 + fi + printf " $TRANSFER_MBS" >> $LOG_FILE +} + +# Create a log with averages +do_create_average() { + awk -F', ' '$2 + 0 > 0 {sum[$1]+=$2; count[$1]++} END {for (i in sum) print i, sum[i]/count[i]}' "$LOG_FILE" | sort -n > "$AVERAGE_FILE" + sed -i 's/ /, /' $AVERAGE_FILE +} + + +do_create_plot() { + gnuplot -e "set title '$TITLE';set ylabel 'MB/s' rotate by 90;set xlabel 'File Size in Bytes';set grid; set format x \"%2.1t×10^{%L}\"; set term pngcairo enhanced;set output '$OUTPUT_FILE';plot '$LOG_FILE' using 1:2, '$AVERAGE_FILE' with lines lc rgb 'red' lw 2, '$COMPARE_TO' with lines lc rgb 'gold' lw 2" +} + +echo "Starting tests" +echo "Getting the average over $NUMBER_RUNS runs" + +# create openssh average if not found +AVERAGE_FILE="$PWD/openssh-average-upload.csv" +if [ ! -f "$AVERAGE_FILE" ]; then + echo "Collecting openssh average upload" + rm -f $LOG_FILE && touch $LOG_FILE + for run in $(seq 1 $NUMBER_RUNS); do + printf "Run $run: " + for i in "${FILE_SIZES[@]}"; do + tail -c "$i" /dev/urandom > "$TEST_FILE" + printf "$i," >> $LOG_FILE + do_openssh_put_test + printf "\n" >> $LOG_FILE + done + printf "done\n" + done + + do_create_average + echo "" +fi + +# create wolfssh average upload +echo "Collecting wolfssh average upload" +rm -f $LOG_FILE && touch $LOG_FILE +for run in $(seq 1 $NUMBER_RUNS); do + printf "Run $run: " + for i in "${FILE_SIZES[@]}"; do + tail -c "$i" /dev/urandom > "$TEST_FILE" + printf "$i," >> $LOG_FILE + do_wolfssh_put_test + printf "\n" >> $LOG_FILE + done + printf "done\n" +done + +# compile and plot the results of average upload +AVERAGE_FILE="$PWD/wolfssh-average-upload.csv" +do_create_average + +TITLE="SFTP Client Upload Speeds [$NUMBER_RUNS runs]" +COMPARE_TO="$PWD/openssh-average-upload.csv" +AVERAGE_FILE="$PWD/wolfssh-average-upload.csv" +OUTPUT_FILE="$PWD/upload-results.png" +do_create_plot + +# create openssh average download if not found +AVERAGE_FILE="$PWD/openssh-average-download.csv" +if [ ! -f "$AVERAGE_FILE" ]; then + echo "Collecting openssh average download" + rm -f $LOG_FILE && touch $LOG_FILE + for run in $(seq 1 $NUMBER_RUNS); do + printf "Run $run: " + for i in "${FILE_SIZES[@]}"; do + tail -c "$i" /dev/urandom > "$TEST_FILE" + printf "$i," >> $LOG_FILE + do_openssh_get_test + printf "\n" >> $LOG_FILE + done + printf "done\n" + done + + do_create_average + echo "" +fi + +# create wolfssh average download +echo "Collecting wolfssh average download" +rm -f $LOG_FILE && touch $LOG_FILE +for run in $(seq 1 $NUMBER_RUNS); do + printf "Run $run: " + for i in "${FILE_SIZES[@]}"; do + tail -c "$i" /dev/urandom > "$TEST_FILE" + printf "$i," >> $LOG_FILE + do_wolfssh_get_test + printf "\n" >> $LOG_FILE + done + printf "done\n" +done + +# compile and plot the results of average download speeds +AVERAGE_FILE="$PWD/wolfssh-average-download.csv" +do_create_average + +TITLE="SFTP Client Download Speeds [$NUMBER_RUNS runs]" +COMPARE_TO="$PWD/openssh-average-download.csv" +AVERAGE_FILE="$PWD/wolfssh-average-download.csv" +OUTPUT_FILE="$PWD/download-results.png" +do_create_plot + +rm -rf $TEST_FILE +rm -rf $TEST_FILE-out