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}
48
49# replace occurrences of the actual IMGFMT value with IMGFMT
50_filter_imgfmt()
51{
52    $SED -e "s#$IMGFMT#IMGFMT#g"
53}
54
55# Replace error message when the format is not supported and delete
56# the output lines after the first one
57_filter_qemu_img_check()
58{
59    $SED -e '/allocated.*fragmented.*compressed clusters/d' \
60        -e 's/qemu-img: This image format does not support checks/No errors were found on the image./' \
61        -e '/Image end offset: [0-9]\+/d'
62}
63
64# Removes \r from messages
65_filter_win32()
66{
67    $SED -e 's/\r//g'
68}
69
70# sanitize qemu-io output
71_filter_qemu_io()
72{
73    _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)/" \
74        -e "s/: line [0-9][0-9]*:  *[0-9][0-9]*\( Aborted\| Killed\)/:\1/" \
75        -e "s/qemu-io> //g"
76}
77
78# replace occurrences of QEMU_PROG with "qemu"
79_filter_qemu()
80{
81    $SED -e "s#\\(^\\|(qemu) \\)$(basename $QEMU_PROG):#\1QEMU_PROG:#" \
82        -e 's#^QEMU [0-9]\+\.[0-9]\+\.[0-9]\+ monitor#QEMU X.Y.Z monitor#' \
83        -e $'s#\r##' # QEMU monitor uses \r\n line endings
84}
85
86# replace problematic QMP output like timestamps
87_filter_qmp()
88{
89    _filter_win32 | \
90    $SED -e 's#\("\(micro\)\?seconds": \)[0-9]\+#\1 TIMESTAMP#g' \
91        -e 's#^{"QMP":.*}$#QMP_VERSION#' \
92        -e '/^    "QMP": {\s*$/, /^    }\s*$/ c\' \
93        -e '    QMP_VERSION'
94}
95
96# readline makes HMP command strings so long that git complains
97_filter_hmp()
98{
99    $SED -e $'s/^\\((qemu) \\)\\?.*\e\\[D/\\1/g' \
100        -e $'s/\e\\[K//g'
101}
102
103# replace block job offset
104_filter_block_job_offset()
105{
106    $SED -e 's/, "offset": [0-9]\+,/, "offset": OFFSET,/'
107}
108
109# replace block job len
110_filter_block_job_len()
111{
112    $SED -e 's/, "len": [0-9]\+,/, "len": LEN,/g'
113}
114
115# replace actual image size (depends on the host filesystem)
116_filter_actual_image_size()
117{
118    $SED -s 's/\("actual-size":\s*\)[0-9]\+/\1SIZE/g'
119}
120
121# replace driver-specific options in the "Formatting..." line
122_filter_img_create()
123{
124    $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
125        -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
126        -e "s#$TEST_DIR#TEST_DIR#g" \
127        -e "s#$IMGFMT#IMGFMT#g" \
128        -e 's#nbd:127.0.0.1:10810#TEST_DIR/t.IMGFMT#g' \
129        -e "s# encryption=off##g" \
130        -e "s# cluster_size=[0-9]\\+##g" \
131        -e "s# table_size=[0-9]\\+##g" \
132        -e "s# compat=[^ ]*##g" \
133        -e "s# compat6=\\(on\\|off\\)##g" \
134        -e "s# static=\\(on\\|off\\)##g" \
135        -e "s# zeroed_grain=\\(on\\|off\\)##g" \
136        -e "s# subformat=[^ ]*##g" \
137        -e "s# adapter_type=[^ ]*##g" \
138        -e "s# hwversion=[^ ]*##g" \
139        -e "s# lazy_refcounts=\\(on\\|off\\)##g" \
140        -e "s# block_size=[0-9]\\+##g" \
141        -e "s# block_state_zero=\\(on\\|off\\)##g" \
142        -e "s# log_size=[0-9]\\+##g" \
143        -e "s# refcount_bits=[0-9]\\+##g" \
144        -e "s# key-secret=[a-zA-Z0-9]\\+##g" \
145        -e "s# iter-time=[0-9]\\+##g" \
146        -e "s# force_size=\\(on\\|off\\)##g"
147}
148
149_filter_img_info()
150{
151    if [[ "$1" == "--format-specific" ]]; then
152        local format_specific=1
153        shift
154    else
155        local format_specific=0
156    fi
157
158    discard=0
159    regex_json_spec_start='^ *"format-specific": \{'
160    $SED -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#$IMGFMT#IMGFMT#g" \
164        -e 's#nbd://127.0.0.1:10810$#TEST_DIR/t.IMGFMT#g' \
165        -e 's#json.*vdisk-id.*vxhs"}}#TEST_DIR/t.IMGFMT#' \
166        -e "/encrypted: yes/d" \
167        -e "/cluster_size: [0-9]\\+/d" \
168        -e "/table_size: [0-9]\\+/d" \
169        -e "/compat: '[^']*'/d" \
170        -e "/compat6: \\(on\\|off\\)/d" \
171        -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \
172        -e "/static: \\(on\\|off\\)/d" \
173        -e "/zeroed_grain: \\(on\\|off\\)/d" \
174        -e "/subformat: '[^']*'/d" \
175        -e "/adapter_type: '[^']*'/d" \
176        -e "/hwversion: '[^']*'/d" \
177        -e "/lazy_refcounts: \\(on\\|off\\)/d" \
178        -e "/block_size: [0-9]\\+/d" \
179        -e "/block_state_zero: \\(on\\|off\\)/d" \
180        -e "/log_size: [0-9]\\+/d" \
181        -e "s/iters: [0-9]\\+/iters: 1024/" \
182        -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \
183    while IFS='' read -r line; do
184        if [[ $format_specific == 1 ]]; then
185            discard=0
186        elif [[ $line == "Format specific information:" ]]; then
187            discard=1
188        elif [[ $line =~ $regex_json_spec_start ]]; then
189            discard=2
190            regex_json_spec_end="^${line%%[^ ]*}\\},? *$"
191        fi
192        if [[ $discard == 0 ]]; then
193            echo "$line"
194        elif [[ $discard == 1 && ! $line ]]; then
195            echo
196            discard=0
197        elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then
198            discard=0
199        fi
200    done
201}
202
203# filter out offsets and file names from qemu-img map; good for both
204# human and json output
205_filter_qemu_img_map()
206{
207    $SED -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \
208        -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \
209        -e 's/Mapped to *//' | _filter_testdir | _filter_imgfmt
210}
211
212_filter_nbd()
213{
214    # nbd.c error messages contain function names and line numbers that are
215    # prone to change.  Message ordering depends on timing between send and
216    # receive callbacks sometimes, making them unreliable.
217    #
218    # Filter out the TCP port number since this changes between runs.
219    $SED -e '/nbd\/.*\.c:/d' \
220        -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \
221        -e "s#?socket=$TEST_DIR#?socket=TEST_DIR#g" \
222        -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#'
223}
224
225_filter_qmp_empty_return()
226{
227    grep -v '{"return": {}}'
228}
229
230# make sure this script returns success
231true
232