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