1#!/usr/bin/env bash
2#
3# Copyright (C) 2009 Red Hat, Inc.
4# Copyright (c) 2000-2001 Silicon Graphics, Inc.  All Rights Reserved.
5#
6# This program is free software; you can redistribute it and/or
7# modify it under the terms of the GNU General Public License as
8# published by the Free Software Foundation.
9#
10# This program is distributed in the hope that it would be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program.  If not, see <http://www.gnu.org/licenses/>.
17#
18#
19# standard filters
20#
21
22_filter_date()
23{
24    $SED -re 's/[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}/yyyy-mm-dd hh:mm:ss/'
25}
26
27_filter_vmstate_size()
28{
29    $SED -r -e 's/[0-9. ]{5} [KMGT]iB/     SIZE/' \
30            -e 's/[0-9. ]{5} B/   SIZE/'
31}
32
33_filter_generated_node_ids()
34{
35    $SED -re 's/\#block[0-9]{3,}/NODE_NAME/'
36}
37
38_filter_qom_path()
39{
40    $SED -e 's#\(Attached to: *\) /.*#\1 PATH#'
41}
42
43# replace occurrences of the actual TEST_DIR value with TEST_DIR
44_filter_testdir()
45{
46    $SED -e "s#$TEST_DIR/#TEST_DIR/#g" \
47         -e "s#$SOCK_DIR/#SOCK_DIR/#g"
48}
49
50# replace occurrences of the actual IMGFMT value with IMGFMT
51_filter_imgfmt()
52{
53    $SED -e "s#$IMGFMT#IMGFMT#g"
54}
55
56# Replace error message when the format is not supported and delete
57# the output lines after the first one
58_filter_qemu_img_check()
59{
60    $SED -e '/allocated.*fragmented.*compressed clusters/d' \
61        -e 's/qemu-img: This image format does not support checks/No errors were found on the image./' \
62        -e '/Image end offset: [0-9]\+/d'
63}
64
65# Removes \r from messages
66_filter_win32()
67{
68    $SED -e 's/\r//g'
69}
70
71# sanitize qemu-io output
72_filter_qemu_io()
73{
74    _filter_win32 | $SED -e "s/[0-9]* ops\; [0-9/:. sec]* ([0-9/.inf]* [EPTGMKiBbytes]*\/sec and [0-9/.inf]* ops\/sec)/X ops\; XX:XX:XX.X (XXX YYY\/sec and XXX ops\/sec)/" \
75        -e "s/: line [0-9][0-9]*:  *[0-9][0-9]*\( Aborted\| Killed\)/:\1/" \
76        -e "s/qemu-io> //g"
77}
78
79# replace occurrences of QEMU_PROG with "qemu"
80_filter_qemu()
81{
82    $SED -e "s#\\(^\\|(qemu) \\)$(basename $QEMU_PROG):#\1QEMU_PROG:#" \
83        -e 's#^QEMU [0-9]\+\.[0-9]\+\.[0-9]\+ monitor#QEMU X.Y.Z monitor#' \
84        -e $'s#\r##' # QEMU monitor uses \r\n line endings
85}
86
87# replace problematic QMP output like timestamps
88_filter_qmp()
89{
90    _filter_win32 | \
91    $SED -e 's#\("\(micro\)\?seconds": \)[0-9]\+#\1 TIMESTAMP#g' \
92        -e 's#^{"QMP":.*}$#QMP_VERSION#' \
93        -e '/^    "QMP": {\s*$/, /^    }\s*$/ c\' \
94        -e '    QMP_VERSION'
95}
96
97# readline makes HMP command strings so long that git complains
98_filter_hmp()
99{
100    $SED -e $'s/^\\((qemu) \\)\\?.*\e\\[D/\\1/g' \
101        -e $'s/\e\\[K//g'
102}
103
104# replace block job offset
105_filter_block_job_offset()
106{
107    $SED -e 's/, "offset": [0-9]\+,/, "offset": OFFSET,/'
108}
109
110# replace block job len
111_filter_block_job_len()
112{
113    $SED -e 's/, "len": [0-9]\+,/, "len": LEN,/g'
114}
115
116# replace actual image size (depends on the host filesystem)
117_filter_actual_image_size()
118{
119    $SED -s 's/\("actual-size":\s*\)[0-9]\+/\1SIZE/g'
120}
121
122# replace driver-specific options in the "Formatting..." line
123_filter_img_create()
124{
125    # Split the line into the pre-options part ($filename_part, which
126    # precedes ", fmt=") and the options part ($options, which starts
127    # with "fmt=")
128    # (And just echo everything before the first "^Formatting")
129    readarray formatting_line < <($SED -e 's/, fmt=/\n/')
130
131    filename_part=''
132    options=''
133    lines=${#formatting_line[@]}
134    for ((i = 0; i < $lines; i++)); do
135        line=${formatting_line[i]}
136        unset formatting_line[i]
137
138        filename_part="$filename_part$line"
139
140        if echo "$line" | grep -q '^Formatting'; then
141            next_i=$((i + 1))
142            if [ -n "${formatting_line[next_i]}" ]; then
143                options="fmt=${formatting_line[@]}"
144            fi
145            break
146        fi
147    done
148
149    # Set grep_data_file to '\|data_file' to keep it; make it empty
150    # to drop it.
151    # We want to drop it if it is part of the global $IMGOPTS, and we
152    # want to keep it otherwise (if the test specifically wants to
153    # test data files).
154    grep_data_file=(-e data_file)
155    if _get_data_file "$TEST_IMG" > /dev/null; then
156        grep_data_file=()
157    fi
158
159    filename_filters=(
160        -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
161        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
162        -e "s#$TEST_DIR#TEST_DIR#g" \
163        -e "s#$SOCK_DIR#SOCK_DIR#g" \
164        -e "s#$IMGFMT#IMGFMT#g" \
165        -e 's#nbd:127.0.0.1:[0-9]\\+#TEST_DIR/t.IMGFMT#g' \
166        -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g'
167    )
168
169    filename_part=$(echo "$filename_part" | $SED "${filename_filters[@]}")
170
171    # Break the option line before each option (preserving pre-existing
172    # line breaks by replacing them by \0 and restoring them at the end),
173    # then filter out the options we want to keep and sort them according
174    # to some order that all block drivers used at the time of writing
175    # this function.
176    options=$(
177        echo "$options" \
178        | tr '\n' '\0' \
179        | $SED -e 's/ \([a-z0-9_.-]*\)=/\n\1=/g' \
180        | grep -a -e '^fmt' -e '^size' -e '^backing' -e '^preallocation' \
181                  -e '^encryption' "${grep_data_file[@]}" \
182        | $SED "${filename_filters[@]}" \
183            -e 's/^\(fmt\)/0-\1/' \
184            -e 's/^\(size\)/1-\1/' \
185            -e 's/^\(backing\)/2-\1/' \
186            -e 's/^\(data_file\)/3-\1/' \
187            -e 's/^\(encryption\)/4-\1/' \
188            -e 's/^\(preallocation\)/8-\1/' \
189        | sort \
190        | $SED -e 's/^[0-9]-//' \
191        | tr '\n\0' ' \n' \
192        | $SED -e 's/^ *$//' -e 's/ *$//'
193    )
194
195    if [ -n "$options" ]; then
196        echo "$filename_part, $options"
197    elif [ -n "$filename_part" ]; then
198        echo "$filename_part"
199    fi
200}
201
202# Filter the "Formatting..." line in QMP output (leaving the QMP output
203# untouched)
204# (In contrast to _filter_img_create(), this function does not support
205# multi-line Formatting output)
206_filter_img_create_in_qmp()
207{
208    while read -r line; do
209        if echo "$line" | grep -q '^Formatting'; then
210            echo "$line" | _filter_img_create
211        else
212            echo "$line"
213        fi
214    done
215}
216
217_filter_img_create_size()
218{
219    $SED -e "s# size=[0-9]\\+# size=SIZE#g"
220}
221
222_filter_img_info()
223{
224    if [[ "$1" == "--format-specific" ]]; then
225        local format_specific=1
226        shift
227    else
228        local format_specific=0
229    fi
230
231    discard=0
232    regex_json_spec_start='^ *"format-specific": \{'
233    $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
234        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
235        -e "s#$TEST_DIR#TEST_DIR#g" \
236        -e "s#$SOCK_DIR#SOCK_DIR#g" \
237        -e "s#$IMGFMT#IMGFMT#g" \
238        -e 's#nbd://127.0.0.1:[0-9]\\+$#TEST_DIR/t.IMGFMT#g' \
239        -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' \
240        -e 's#json.*vdisk-id.*vxhs"}}#TEST_DIR/t.IMGFMT#' \
241        -e "/encrypted: yes/d" \
242        -e "/cluster_size: [0-9]\\+/d" \
243        -e "/table_size: [0-9]\\+/d" \
244        -e "/compat: '[^']*'/d" \
245        -e "/compat6: \\(on\\|off\\)/d" \
246        -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \
247        -e "/static: \\(on\\|off\\)/d" \
248        -e "/zeroed_grain: \\(on\\|off\\)/d" \
249        -e "/subformat: '[^']*'/d" \
250        -e "/adapter_type: '[^']*'/d" \
251        -e "/hwversion: '[^']*'/d" \
252        -e "/lazy_refcounts: \\(on\\|off\\)/d" \
253        -e "/block_size: [0-9]\\+/d" \
254        -e "/block_state_zero: \\(on\\|off\\)/d" \
255        -e "/log_size: [0-9]\\+/d" \
256        -e "s/iters: [0-9]\\+/iters: 1024/" \
257        -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \
258    while IFS='' read -r line; do
259        if [[ $format_specific == 1 ]]; then
260            discard=0
261        elif [[ $line == "Format specific information:" ]]; then
262            discard=1
263        elif [[ $line =~ $regex_json_spec_start ]]; then
264            discard=2
265            regex_json_spec_end="^${line%%[^ ]*}\\},? *$"
266        fi
267        if [[ $discard == 0 ]]; then
268            echo "$line"
269        elif [[ $discard == 1 && ! $line ]]; then
270            echo
271            discard=0
272        elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then
273            discard=0
274        fi
275    done
276}
277
278# filter out offsets and file names from qemu-img map; good for both
279# human and json output
280_filter_qemu_img_map()
281{
282    # Assuming the data_file value in $IMGOPTS contains a '$TEST_IMG',
283    # create a filter that replaces the data file name by $TEST_IMG.
284    # Example:
285    #   In $IMGOPTS: 'data_file=$TEST_IMG.data_file'
286    #   Then data_file_pattern == '\(.*\).data_file'
287    #   And  data_file_filter  == -e 's#\(.*\).data_file#\1#
288    data_file_filter=()
289    if data_file_pattern=$(_get_data_file '\\(.*\\)'); then
290        data_file_filter=(-e "s#$data_file_pattern#\\1#")
291    fi
292
293    $SED -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \
294        -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \
295        -e 's/Mapped to *//' \
296        "${data_file_filter[@]}" \
297        | _filter_testdir | _filter_imgfmt
298}
299
300_filter_nbd()
301{
302    # nbd.c error messages contain function names and line numbers that are
303    # prone to change.  Message ordering depends on timing between send and
304    # receive callbacks sometimes, making them unreliable.
305    #
306    # Filter out the TCP port number since this changes between runs.
307    $SED -e '/nbd\/.*\.c:/d' \
308        -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \
309        -e "s#?socket=$SOCK_DIR#?socket=SOCK_DIR#g" \
310        -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#'
311}
312
313_filter_qmp_empty_return()
314{
315    grep -v '{"return": {}}'
316}
317
318_filter_json_filename()
319{
320    $PYTHON -c 'import sys
321result, *fnames = sys.stdin.read().split("json:{")
322depth = 0
323for fname in fnames:
324    depth += 1 # For the opening brace in the split separator
325    for chr_i, chr in enumerate(fname):
326        if chr == "{":
327            depth += 1
328        elif chr == "}":
329            depth -= 1
330            if depth == 0:
331                break
332
333    # json:{} filenames may be nested; filter out everything from
334    # inside the outermost one
335    if depth == 0:
336        chr_i += 1 # First character past the filename
337        result += "json:{ /* filtered */ }" + fname[chr_i:]
338
339sys.stdout.write(result)'
340}
341
342# make sure this script returns success
343true
344