xref: /qemu/tests/qemu-iotests/common.filter (revision a18025f9) 
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    $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
126        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
127        -e "s#$TEST_DIR#TEST_DIR#g" \
128        -e "s#$SOCK_DIR#SOCK_DIR#g" \
129        -e "s#$IMGFMT#IMGFMT#g" \
130        -e 's#nbd:127.0.0.1:10810#TEST_DIR/t.IMGFMT#g' \
131        -e "s# encryption=off##g" \
132        -e "s# cluster_size=[0-9]\\+##g" \
133        -e "s# table_size=[0-9]\\+##g" \
134        -e "s# compat=[^ ]*##g" \
135        -e "s# compat6=\\(on\\|off\\)##g" \
136        -e "s# static=\\(on\\|off\\)##g" \
137        -e "s# zeroed_grain=\\(on\\|off\\)##g" \
138        -e "s# subformat=[^ ]*##g" \
139        -e "s# adapter_type=[^ ]*##g" \
140        -e "s# hwversion=[^ ]*##g" \
141        -e "s# lazy_refcounts=\\(on\\|off\\)##g" \
142        -e "s# block_size=[0-9]\\+##g" \
143        -e "s# block_state_zero=\\(on\\|off\\)##g" \
144        -e "s# log_size=[0-9]\\+##g" \
145        -e "s# refcount_bits=[0-9]\\+##g" \
146        -e "s# key-secret=[a-zA-Z0-9]\\+##g" \
147        -e "s# iter-time=[0-9]\\+##g" \
148        -e "s# force_size=\\(on\\|off\\)##g"
149}
150
151_filter_img_info()
152{
153    if [[ "$1" == "--format-specific" ]]; then
154        local format_specific=1
155        shift
156    else
157        local format_specific=0
158    fi
159
160    discard=0
161    regex_json_spec_start='^ *"format-specific": \{'
162    $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
163        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
164        -e "s#$TEST_DIR#TEST_DIR#g" \
165        -e "s#$SOCK_DIR#SOCK_DIR#g" \
166        -e "s#$IMGFMT#IMGFMT#g" \
167        -e 's#nbd://127.0.0.1:10810$#TEST_DIR/t.IMGFMT#g' \
168        -e 's#json.*vdisk-id.*vxhs"}}#TEST_DIR/t.IMGFMT#' \
169        -e "/encrypted: yes/d" \
170        -e "/cluster_size: [0-9]\\+/d" \
171        -e "/table_size: [0-9]\\+/d" \
172        -e "/compat: '[^']*'/d" \
173        -e "/compat6: \\(on\\|off\\)/d" \
174        -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \
175        -e "/static: \\(on\\|off\\)/d" \
176        -e "/zeroed_grain: \\(on\\|off\\)/d" \
177        -e "/subformat: '[^']*'/d" \
178        -e "/adapter_type: '[^']*'/d" \
179        -e "/hwversion: '[^']*'/d" \
180        -e "/lazy_refcounts: \\(on\\|off\\)/d" \
181        -e "/block_size: [0-9]\\+/d" \
182        -e "/block_state_zero: \\(on\\|off\\)/d" \
183        -e "/log_size: [0-9]\\+/d" \
184        -e "s/iters: [0-9]\\+/iters: 1024/" \
185        -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \
186    while IFS='' read -r line; do
187        if [[ $format_specific == 1 ]]; then
188            discard=0
189        elif [[ $line == "Format specific information:" ]]; then
190            discard=1
191        elif [[ $line =~ $regex_json_spec_start ]]; then
192            discard=2
193            regex_json_spec_end="^${line%%[^ ]*}\\},? *$"
194        fi
195        if [[ $discard == 0 ]]; then
196            echo "$line"
197        elif [[ $discard == 1 && ! $line ]]; then
198            echo
199            discard=0
200        elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then
201            discard=0
202        fi
203    done
204}
205
206# filter out offsets and file names from qemu-img map; good for both
207# human and json output
208_filter_qemu_img_map()
209{
210    $SED -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \
211        -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \
212        -e 's/Mapped to *//' | _filter_testdir | _filter_imgfmt
213}
214
215_filter_nbd()
216{
217    # nbd.c error messages contain function names and line numbers that are
218    # prone to change.  Message ordering depends on timing between send and
219    # receive callbacks sometimes, making them unreliable.
220    #
221    # Filter out the TCP port number since this changes between runs.
222    $SED -e '/nbd\/.*\.c:/d' \
223        -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \
224        -e "s#?socket=$SOCK_DIR#?socket=SOCK_DIR#g" \
225        -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#'
226}
227
228_filter_qmp_empty_return()
229{
230    grep -v '{"return": {}}'
231}
232
233# make sure this script returns success
234true
235