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    data_file_filter=()
126    if data_file=$(_get_data_file "$TEST_IMG"); then
127        data_file_filter=(-e "s# data_file=$data_file##")
128    fi
129
130    $SED "${data_file_filter[@]}" \
131        -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
132        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
133        -e "s#$TEST_DIR#TEST_DIR#g" \
134        -e "s#$SOCK_DIR#SOCK_DIR#g" \
135        -e "s#$IMGFMT#IMGFMT#g" \
136        -e 's#nbd:127.0.0.1:[0-9]\\+#TEST_DIR/t.IMGFMT#g' \
137        -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' \
138        -e "s# encryption=off##g" \
139        -e "s# cluster_size=[0-9]\\+##g" \
140        -e "s# table_size=[0-9]\\+##g" \
141        -e "s# compat=[^ ]*##g" \
142        -e "s# compat6=\\(on\\|off\\)##g" \
143        -e "s# static=\\(on\\|off\\)##g" \
144        -e "s# zeroed_grain=\\(on\\|off\\)##g" \
145        -e "s# subformat=[^ ]*##g" \
146        -e "s# adapter_type=[^ ]*##g" \
147        -e "s# hwversion=[^ ]*##g" \
148        -e "s# lazy_refcounts=\\(on\\|off\\)##g" \
149        -e "s# block_size=[0-9]\\+##g" \
150        -e "s# block_state_zero=\\(on\\|off\\)##g" \
151        -e "s# log_size=[0-9]\\+##g" \
152        -e "s# refcount_bits=[0-9]\\+##g" \
153        -e "s# key-secret=[a-zA-Z0-9]\\+##g" \
154        -e "s# iter-time=[0-9]\\+##g" \
155        -e "s# force_size=\\(on\\|off\\)##g" \
156        -e "s# compression_type=[a-zA-Z0-9]\\+##g"
157}
158
159_filter_img_create_size()
160{
161    $SED -e "s# size=[0-9]\\+# size=SIZE#g"
162}
163
164_filter_img_info()
165{
166    if [[ "$1" == "--format-specific" ]]; then
167        local format_specific=1
168        shift
169    else
170        local format_specific=0
171    fi
172
173    discard=0
174    regex_json_spec_start='^ *"format-specific": \{'
175    $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
176        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
177        -e "s#$TEST_DIR#TEST_DIR#g" \
178        -e "s#$SOCK_DIR#SOCK_DIR#g" \
179        -e "s#$IMGFMT#IMGFMT#g" \
180        -e 's#nbd://127.0.0.1:[0-9]\\+$#TEST_DIR/t.IMGFMT#g' \
181        -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' \
182        -e 's#json.*vdisk-id.*vxhs"}}#TEST_DIR/t.IMGFMT#' \
183        -e "/encrypted: yes/d" \
184        -e "/cluster_size: [0-9]\\+/d" \
185        -e "/table_size: [0-9]\\+/d" \
186        -e "/compat: '[^']*'/d" \
187        -e "/compat6: \\(on\\|off\\)/d" \
188        -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \
189        -e "/static: \\(on\\|off\\)/d" \
190        -e "/zeroed_grain: \\(on\\|off\\)/d" \
191        -e "/subformat: '[^']*'/d" \
192        -e "/adapter_type: '[^']*'/d" \
193        -e "/hwversion: '[^']*'/d" \
194        -e "/lazy_refcounts: \\(on\\|off\\)/d" \
195        -e "/block_size: [0-9]\\+/d" \
196        -e "/block_state_zero: \\(on\\|off\\)/d" \
197        -e "/log_size: [0-9]\\+/d" \
198        -e "s/iters: [0-9]\\+/iters: 1024/" \
199        -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \
200    while IFS='' read -r line; do
201        if [[ $format_specific == 1 ]]; then
202            discard=0
203        elif [[ $line == "Format specific information:" ]]; then
204            discard=1
205        elif [[ $line =~ $regex_json_spec_start ]]; then
206            discard=2
207            regex_json_spec_end="^${line%%[^ ]*}\\},? *$"
208        fi
209        if [[ $discard == 0 ]]; then
210            echo "$line"
211        elif [[ $discard == 1 && ! $line ]]; then
212            echo
213            discard=0
214        elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then
215            discard=0
216        fi
217    done
218}
219
220# filter out offsets and file names from qemu-img map; good for both
221# human and json output
222_filter_qemu_img_map()
223{
224    # Assuming the data_file value in $IMGOPTS contains a '$TEST_IMG',
225    # create a filter that replaces the data file name by $TEST_IMG.
226    # Example:
227    #   In $IMGOPTS: 'data_file=$TEST_IMG.data_file'
228    #   Then data_file_pattern == '\(.*\).data_file'
229    #   And  data_file_filter  == -e 's#\(.*\).data_file#\1#
230    data_file_filter=()
231    if data_file_pattern=$(_get_data_file '\\(.*\\)'); then
232        data_file_filter=(-e "s#$data_file_pattern#\\1#")
233    fi
234
235    $SED -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \
236        -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \
237        -e 's/Mapped to *//' \
238        "${data_file_filter[@]}" \
239        | _filter_testdir | _filter_imgfmt
240}
241
242_filter_nbd()
243{
244    # nbd.c error messages contain function names and line numbers that are
245    # prone to change.  Message ordering depends on timing between send and
246    # receive callbacks sometimes, making them unreliable.
247    #
248    # Filter out the TCP port number since this changes between runs.
249    $SED -e '/nbd\/.*\.c:/d' \
250        -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \
251        -e "s#?socket=$SOCK_DIR#?socket=SOCK_DIR#g" \
252        -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#'
253}
254
255_filter_qmp_empty_return()
256{
257    grep -v '{"return": {}}'
258}
259
260_filter_json_filename()
261{
262    $PYTHON -c 'import sys
263result, *fnames = sys.stdin.read().split("json:{")
264depth = 0
265for fname in fnames:
266    depth += 1 # For the opening brace in the split separator
267    for chr_i, chr in enumerate(fname):
268        if chr == "{":
269            depth += 1
270        elif chr == "}":
271            depth -= 1
272            if depth == 0:
273                break
274
275    # json:{} filenames may be nested; filter out everything from
276    # inside the outermost one
277    if depth == 0:
278        chr_i += 1 # First character past the filename
279        result += "json:{ /* filtered */ }" + fname[chr_i:]
280
281sys.stdout.write(result)'
282}
283
284# make sure this script returns success
285true
286