3 # This file is part of PulseAudio.
5 # Copyright 2015 Ahmed S. Darwish <darwish.07@gmail.com>
7 # PulseAudio is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU Lesser General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
12 # PulseAudio is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public License
18 # along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
21 # Measure PulseAudio memory usage (VmSize, Private+Shared_Dirty)
22 # while increasing the number of connected clients over time.
24 # To avoid premature client exits, please ensure giving a long
25 # wave file as the script's first parameter.
32 BASENAME=$(basename $0)
33 PROMPT="${_bold}[$BASENAME]${_reset}"
35 echo -e "$PROMPT: ** Error: ${_error}$1${_reset}" >&2; exit -1
41 _absolute_dirname="$(dirname `readlink -f $0`)"
42 PA_HOME="${_absolute_dirname%/scripts}"
43 [ -d "$PA_HOME/src" -a -d "$PA_HOME/scripts" ] ||
44 error "This script can only be executed from PulseAudio source tree"
46 PA=${PA_HOME}/src/pulseaudio
47 PA_CAT=${PA_HOME}/src/pacat
48 PA_PLAY=${PA_HOME}/src/paplay
49 PA_FLAGS="-n -F ${PA_HOME}/src/default.pa -p ${PA_HOME}/src/"
51 [ -L "$PA_PLAY" ] || ln -sf .libs/lt-pacat $PA_PLAY
52 PA_PLAY_PROCESS_NAME="paplay"
54 SCRIPTS_DIR=${PA_HOME}/scripts
55 BENCHMARKS_DIR=${SCRIPTS_DIR}/benchmarks
56 GNUPLOT_SCRIPT=${SCRIPTS_DIR}/plot_memory_usage.gp
57 OUTPUT_FILE=${BENCHMARKS_DIR}/memory-usage-`date -Iseconds`.txt
58 SYMLINK_LATEST_OUTPUT_FILE=${BENCHMARKS_DIR}/memory-usage-LATEST.txt
62 [ -e "$PA" ] || error "$PA does not exist. Compile PulseAudio tree first."
63 [ -x "$PA" ] || error "$PA cannot be executed"
64 [ -x "$PA_CAT" ] || error "$PA_CAT cannot be executed"
67 [ -n "$AUDIO_FILE" ] || error "Usage: $BASENAME AUDIO_FILE"
68 [ -e "$AUDIO_FILE" ] || error "$AUDIO_FILE does not exist"
69 [ -f "$AUDIO_FILE" ] || error "$AUDIO_FILE is not a regular file"
71 $PA --check >/dev/null 2>&1
73 msg "A PulseAudio daemon is already running on your system"
74 msg "To use this script, please do the following first:"
75 msg " 1. Add autospawn=no to $HOME/.pulse/client.conf"
76 msg " 2. Kill current daemon instance using 'pulseaudio --kill'"
77 error "Failed to start PulseAudio daemon"
80 msg "Hello. Benchmarking PulseAudio daemon memory usage over time"
82 # Check Linux Kernel's Documentation/sysctl/vm.txt for details.
83 msg "Ensuring consistent results by dropping all VM caches!"
84 sudo bash -c "sync && echo 3 >/proc/sys/vm/drop_caches"
86 msg "Starting PulseAudio daemon"
87 PULSE_LOG=0 PULSE_LOG_COLORS= PULSE_LOG_META= $PA $PA_FLAGS &
90 # Give PA daemon time to initialize everything and vacuum. We want
91 # to make the _starting_ dirty RSS memory usage (0 clients) as
92 # equivalent as possible for multiple trials.
95 $PA --check >/dev/null 2>&1
96 [ "$?" -eq "0" ] || error "Failed to start PulseAudio daemon"
98 echo "# ClientCount VmSize (KiB) DirtyRSS (KiB)" >$OUTPUT_FILE
100 msg "Starting PulseAudio clients"
103 [ "$_i" -le "$MAX_CLIENTS" ] || break
105 _vmsize=`ps -o vsize= $_pid`
106 _drss=`awk '/(Shared|Private)_Dirty:/{ sum += $2 } END { print sum }' /proc/$_pid/smaps`
107 [ "$?" -eq "0" ] || error "Error sampling PulseAudio RSS memory usage"
109 echo " $_i $_vmsize $_drss" >>$OUTPUT_FILE
111 $PA_PLAY $AUDIO_FILE 2>/dev/null &
116 msg "Finished starting ${MAX_CLIENTS} PulseAudio clients over time"
118 _n_clients_still_alive=$(ps -C $PA_PLAY_PROCESS_NAME --no-headers | wc -l)
119 [ "$_n_clients_still_alive" -ge "$MAX_CLIENTS" ] || {
120 msg "You did not provide a long-enough wave file for clients to play"
121 msg "Only $_n_clients_still_alive clients are now active; expected $MAX_CLIENTS"
122 error "Please provide a large wave file (~ $((MAX_CLIENTS*2))s) then redo the benchmarks"
125 msg "Killing PulseAudio daemon"
126 $PA --kill >/dev/null 2>&1
128 rm -f $SYMLINK_LATEST_OUTPUT_FILE
129 ln -s $OUTPUT_FILE $SYMLINK_LATEST_OUTPUT_FILE
131 msg "Sampling daemon memory usage done!"
132 msg "Check the results at $SYMLINK_LATEST_OUTPUT_FILE"
133 msg "Plot these results using 'gnuplot $GNUPLOT_SCRIPT'"