tests/qemu-iotests/common.filter

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