Skip to content

Commit 95ab708

Browse files
Megabytes, emojis
1 parent e790798 commit 95ab708

4 files changed

Lines changed: 39 additions & 26 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ jobs:
433433
--gtest_recreate_environments_when_repeating=1 \
434434
--gtest_output=xml:${{ env.BUILD_DIR }}/integration-test-results.xml
435435
436-
- name: Run Linux memory regression gate
436+
- name: Run memory regression tests
437437
if: matrix.name == 'ubuntu-24.04-x64' && inputs.build_type == 'release'
438438
timeout-minutes: 10
439439
shell: bash
@@ -445,7 +445,7 @@ jobs:
445445
--scenario all \
446446
--iterations 100 \
447447
--warmup 20 \
448-
--max-rss-growth-kib 8192 \
448+
--max-rss-growth-mib 8 \
449449
--max-thread-growth 0
450450
451451
- name: Run stress tests

‎docs/testing.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ tokens before running any scenario:
145145
source scripts/set-test-tokens.sh
146146
scripts/memory-regression.sh --scenario audio-track \
147147
--iterations 100 --warmup 20 \
148-
--max-rss-growth-kib 8192 --max-thread-growth 0
148+
--max-rss-growth-mib 8 --max-thread-growth 0
149149
scripts/memory-regression.sh --scenario video-track \
150150
--iterations 100 --warmup 20 \
151-
--max-rss-growth-kib 8192 --max-thread-growth 0
151+
--max-rss-growth-mib 8 --max-thread-growth 0
152152
```
153153

154154
Use `--scenario all` to run all six scenarios, each in a fresh tester process:

‎scripts/memory-regression.sh‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ Options:
3030
room-server-delete, or all (default: audio-track)
3131
--iterations N Lifecycle cycles (default: 100)
3232
--warmup N Baseline cycle (default: 20)
33-
--max-rss-growth-kib N Allowed RSS growth (default: 8192)
33+
--max-rss-growth-mib N Allowed RSS growth (default: 8)
3434
--max-thread-growth N Allowed thread growth (default: 0)
3535
-h, --help Show this help
3636
3737
Environment:
3838
MEMORY_REGRESSION_BUILD_DIR, MEMORY_REGRESSION_SCENARIO,
3939
MEMORY_REGRESSION_ITERATIONS,
40-
MEMORY_REGRESSION_WARMUP, MEMORY_REGRESSION_MAX_RSS_GROWTH_KIB,
40+
MEMORY_REGRESSION_WARMUP, MEMORY_REGRESSION_MAX_RSS_GROWTH_MIB,
4141
MEMORY_REGRESSION_MAX_THREAD_GROWTH, MALLOC_ARENA_MAX.
4242
All scenarios require LIVEKIT_URL and LIVEKIT_TOKEN_A.
4343
EOF
@@ -48,7 +48,7 @@ build_dir="${MEMORY_REGRESSION_BUILD_DIR:-build-release}"
4848
scenario="${MEMORY_REGRESSION_SCENARIO:-audio-track}"
4949
iterations="${MEMORY_REGRESSION_ITERATIONS:-100}"
5050
warmup="${MEMORY_REGRESSION_WARMUP:-20}"
51-
max_rss_growth_kib="${MEMORY_REGRESSION_MAX_RSS_GROWTH_KIB:-8192}"
51+
max_rss_growth_mib="${MEMORY_REGRESSION_MAX_RSS_GROWTH_MIB:-8}"
5252
max_thread_growth="${MEMORY_REGRESSION_MAX_THREAD_GROWTH:-0}"
5353

5454
while (($#)); do
@@ -57,7 +57,7 @@ while (($#)); do
5757
--scenario) scenario="$2"; shift 2 ;;
5858
--iterations) iterations="$2"; shift 2 ;;
5959
--warmup) warmup="$2"; shift 2 ;;
60-
--max-rss-growth-kib) max_rss_growth_kib="$2"; shift 2 ;;
60+
--max-rss-growth-mib) max_rss_growth_mib="$2"; shift 2 ;;
6161
--max-thread-growth) max_thread_growth="$2"; shift 2 ;;
6262
-h|--help) usage; exit 0 ;;
6363
*) echo "ERROR: unknown option: $1" >&2; usage >&2; exit 2 ;;
@@ -97,19 +97,21 @@ done
9797

9898
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
9999
{
100-
echo "## Linux memory regression"
100+
echo "## Memory regression results"
101101
echo
102-
echo "Warmup → final limits: RSS growth ≤ ${max_rss_growth_kib} KiB; thread growth ≤ ${max_thread_growth}."
102+
echo "Iterations: ${iterations}"
103+
echo "Warmup: ${warmup}"
104+
echo "Threshold: RSS growth ≤ ${max_rss_growth_mib} MiB; thread growth ≤ ${max_thread_growth}."
103105
echo
104-
echo "| Scenario | RSS 0→${warmup} | RSS ${warmup}→${iterations} | Threads 0→${warmup} | Threads ${warmup}→${iterations} |"
105-
echo "|---|---:|---:|---:|---:|"
106+
echo "| Scenario | RSS 0→${warmup} | RSS ${warmup}→${iterations} | Threads 0→${warmup} | Threads ${warmup}→${iterations} | Status |"
107+
echo "|---|---:|---:|---:|---:|---|"
106108
} >> "${GITHUB_STEP_SUMMARY}"
107109
fi
108110

109-
report_regex='memory lifecycle: scenario=([a-z-]+), RSS 0 ([0-9]+) -> warmup ([0-9]+) KiB \((-?[0-9]+) KiB\) -> final ([0-9]+) KiB \((-?[0-9]+) KiB\), threads 0 ([0-9]+) -> warmup ([0-9]+) \((-?[0-9]+)\) -> final ([0-9]+) \((-?[0-9]+)\), verdict=(PASS|FAIL)'
111+
report_regex='memory lifecycle: scenario=([a-z-]+), RSS 0 ([0-9]+\.[0-9]+) -> warmup ([0-9]+\.[0-9]+) MiB \((-?[0-9]+\.[0-9]+) MiB\) -> final ([0-9]+\.[0-9]+) MiB \((-?[0-9]+\.[0-9]+) MiB\), threads 0 ([0-9]+) -> warmup ([0-9]+) \((-?[0-9]+)\) -> final ([0-9]+) \((-?[0-9]+)\), verdict=(PASS|FAIL)'
110112

111113
format_growth() {
112-
if [[ "$1" == "0" || "$1" == -* ]]; then
114+
if [[ "$1" == "0" || "$1" == "0.00" || "$1" == -* ]]; then
113115
printf '%s' "$1"
114116
else
115117
printf '+%s' "$1"
@@ -124,7 +126,7 @@ for current_scenario in "${scenarios[@]}"; do
124126
--scenario "${current_scenario}" \
125127
--iterations "${iterations}" \
126128
--warmup "${warmup}" \
127-
--max-rss-growth-kib "${max_rss_growth_kib}" \
129+
--max-rss-growth-mib "${max_rss_growth_mib}" \
128130
--max-thread-growth "${max_thread_growth}" 2>&1
129131
)"
130132
status=$?
@@ -133,17 +135,22 @@ for current_scenario in "${scenarios[@]}"; do
133135

134136
if [[ "${output}" =~ ${report_regex} ]]; then
135137
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
138+
if [[ "${BASH_REMATCH[12]}" == "PASS" ]]; then
139+
verdict=":white_check_mark: PASS"
140+
else
141+
verdict=":x: FAIL"
142+
fi
136143
rss_warmup_growth="$(format_growth "${BASH_REMATCH[4]}")"
137144
rss_final_growth="$(format_growth "${BASH_REMATCH[6]}")"
138145
thread_warmup_growth="$(format_growth "${BASH_REMATCH[9]}")"
139146
thread_final_growth="$(format_growth "${BASH_REMATCH[11]}")"
140-
echo "| ${BASH_REMATCH[1]} | ${rss_warmup_growth} KiB | ${rss_final_growth} KiB | ${thread_warmup_growth} | ${thread_final_growth} |" \
147+
echo "| ${BASH_REMATCH[1]} | ${rss_warmup_growth} MiB | ${rss_final_growth} MiB | ${thread_warmup_growth} | ${thread_final_growth} | ${verdict} |" \
141148
>> "${GITHUB_STEP_SUMMARY}"
142149
fi
143150
else
144151
echo "ERROR: ${current_scenario} did not produce a memory report." >&2
145152
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
146-
echo "| ${current_scenario} | — | — | — | ERROR |" >> "${GITHUB_STEP_SUMMARY}"
153+
echo "| ${current_scenario} | — | — | — | — | :x: ERROR |" >> "${GITHUB_STEP_SUMMARY}"
147154
fi
148155
status=1
149156
fi

‎src/tests/memory/lifecycle_tester.cpp‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
#include <cstdint>
2626
#include <cstdlib>
2727
#include <fstream>
28+
#include <iomanip>
2829
#include <iostream>
2930
#include <memory>
3031
#include <mutex>
@@ -53,7 +54,7 @@ struct Options {
5354
Scenario scenario{Scenario::AudioTrack};
5455
std::uint64_t iterations{100};
5556
std::uint64_t warmup{20};
56-
std::uint64_t max_rss_growth_kib{std::uint64_t{8} * 1024U};
57+
std::uint64_t max_rss_growth_mib{8};
5758
std::uint64_t max_thread_growth{0};
5859
};
5960

@@ -190,8 +191,8 @@ Options parseOptions(int argc, char* argv[]) {
190191
options.iterations = parseUnsigned(value, option);
191192
} else if (option == "--warmup") {
192193
options.warmup = parseUnsigned(value, option);
193-
} else if (option == "--max-rss-growth-kib") {
194-
options.max_rss_growth_kib = parseUnsigned(value, option);
194+
} else if (option == "--max-rss-growth-mib") {
195+
options.max_rss_growth_mib = parseUnsigned(value, option);
195196
} else if (option == "--max-thread-growth") {
196197
options.max_thread_growth = parseUnsigned(value, option);
197198
} else {
@@ -234,6 +235,10 @@ ProcessSample sampleProcess() {
234235
return sample;
235236
}
236237

238+
double kibToMib(std::uint64_t kib) { return static_cast<double>(kib) / 1024.0; }
239+
240+
double kibToMib(std::int64_t kib) { return static_cast<double>(kib) / 1024.0; }
241+
237242
RoomCredentials roomCredentials() {
238243
const char* url = std::getenv("LIVEKIT_URL");
239244
const char* token = std::getenv("LIVEKIT_TOKEN_A");
@@ -487,13 +492,14 @@ int main(int argc, char* argv[]) {
487492
static_cast<std::int64_t>(warmup.threads) - static_cast<std::int64_t>(initial.threads);
488493
const auto final_thread_growth =
489494
static_cast<std::int64_t>(final.threads) - static_cast<std::int64_t>(warmup.threads);
490-
const bool passed = final_rss_growth <= static_cast<std::int64_t>(options.max_rss_growth_kib) &&
495+
const bool passed = kibToMib(final_rss_growth) <= static_cast<double>(options.max_rss_growth_mib) &&
491496
final_thread_growth <= static_cast<std::int64_t>(options.max_thread_growth);
492-
std::cout << "memory lifecycle: scenario=" << scenarioName(options.scenario) << ", RSS 0 " << initial.rss_kib
493-
<< " -> warmup " << warmup.rss_kib << " KiB (" << warmup_rss_growth << " KiB) -> final " << final.rss_kib
494-
<< " KiB (" << final_rss_growth << " KiB), threads 0 " << initial.threads << " -> warmup "
495-
<< warmup.threads << " (" << warmup_thread_growth << ") -> final " << final.threads << " ("
496-
<< final_thread_growth << "), verdict=" << (passed ? "PASS" : "FAIL") << '\n';
497+
std::cout << std::fixed << std::setprecision(2) << "memory lifecycle: scenario=" << scenarioName(options.scenario)
498+
<< ", RSS 0 " << kibToMib(initial.rss_kib) << " -> warmup " << kibToMib(warmup.rss_kib) << " MiB ("
499+
<< kibToMib(warmup_rss_growth) << " MiB) -> final " << kibToMib(final.rss_kib) << " MiB ("
500+
<< kibToMib(final_rss_growth) << " MiB), threads 0 " << initial.threads << " -> warmup " << warmup.threads
501+
<< " (" << warmup_thread_growth << ") -> final " << final.threads << " (" << final_thread_growth
502+
<< "), verdict=" << (passed ? "PASS" : "FAIL") << '\n';
497503
return passed ? 0 : 1;
498504
} catch (const std::exception& error) {
499505
std::cerr << "memory lifecycle tester failed: " << error.what() << '\n';

0 commit comments

Comments
 (0)