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# Filename filters for qemu-img create 123_filter_img_create_filenames() 124{ 125 $SED \ 126 -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \ 127 -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \ 128 -e "s#$TEST_DIR#TEST_DIR#g" \ 129 -e "s#$SOCK_DIR#SOCK_DIR#g" \ 130 -e "s#$IMGFMT#IMGFMT#g" \ 131 -e 's#nbd:127.0.0.1:[0-9]\\+#TEST_DIR/t.IMGFMT#g' \ 132 -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' 133} 134 135# replace driver-specific options in the "Formatting..." line 136_do_filter_img_create() 137{ 138 # Split the line into the pre-options part ($filename_part, which 139 # precedes ", fmt=") and the options part ($options, which starts 140 # with "fmt=") 141 # (And just echo everything before the first "^Formatting") 142 readarray formatting_line < <($SED -e 's/, fmt=/\n/') 143 144 filename_part=${formatting_line[0]} 145 unset formatting_line[0] 146 147 options="fmt=${formatting_line[@]}" 148 149 # Set grep_data_file to '\|data_file' to keep it; make it empty 150 # to drop it. 151 # We want to drop it if it is part of the global $IMGOPTS, and we 152 # want to keep it otherwise (if the test specifically wants to 153 # test data files). 154 grep_data_file=(-e data_file) 155 if _get_data_file "$TEST_IMG" > /dev/null; then 156 grep_data_file=() 157 fi 158 159 filename_part=$(echo "$filename_part" | _filter_img_create_filenames) 160 161 # Break the option line before each option (preserving pre-existing 162 # line breaks by replacing them by \0 and restoring them at the end), 163 # then filter out the options we want to keep and sort them according 164 # to some order that all block drivers used at the time of writing 165 # this function. 166 options=$( 167 echo "$options" \ 168 | tr '\n' '\0' \ 169 | $SED -e 's/ \([a-z0-9_.-]*\)=/\n\1=/g' \ 170 | grep -a -e '^fmt' -e '^size' -e '^backing' -e '^preallocation' \ 171 -e '^encryption' "${grep_data_file[@]}" \ 172 | _filter_img_create_filenames \ 173 | $SED \ 174 -e 's/^\(fmt\)/0-\1/' \ 175 -e 's/^\(size\)/1-\1/' \ 176 -e 's/^\(backing\)/2-\1/' \ 177 -e 's/^\(data_file\)/3-\1/' \ 178 -e 's/^\(encryption\)/4-\1/' \ 179 -e 's/^\(preallocation\)/8-\1/' \ 180 | LC_ALL=C sort \ 181 | $SED -e 's/^[0-9]-//' \ 182 | tr '\n\0' ' \n' \ 183 | $SED -e 's/^ *$//' -e 's/ *$//' 184 ) 185 186 if [ -n "$options" ]; then 187 echo "$filename_part, $options" 188 elif [ -n "$filename_part" ]; then 189 echo "$filename_part" 190 fi 191} 192 193# Filter qemu-img create output: 194# Pipe all ^Formatting lines through _do_filter_img_create, and all 195# other lines through _filter_img_create_filenames 196_filter_img_create() 197{ 198 while read -r line; do 199 if echo "$line" | grep -q '^Formatting'; then 200 echo "$line" | _do_filter_img_create 201 else 202 echo "$line" | _filter_img_create_filenames 203 fi 204 done 205} 206 207_filter_img_create_size() 208{ 209 $SED -e "s# size=[0-9]\\+# size=SIZE#g" 210} 211 212_filter_img_info() 213{ 214 if [[ "$1" == "--format-specific" ]]; then 215 local format_specific=1 216 shift 217 else 218 local format_specific=0 219 fi 220 221 discard=0 222 regex_json_spec_start='^ *"format-specific": \{' 223 $SED -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \ 224 -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \ 225 -e "s#$TEST_DIR#TEST_DIR#g" \ 226 -e "s#$SOCK_DIR#SOCK_DIR#g" \ 227 -e "s#$IMGFMT#IMGFMT#g" \ 228 -e 's#nbd://127.0.0.1:[0-9]\\+$#TEST_DIR/t.IMGFMT#g' \ 229 -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' \ 230 -e "/encrypted: yes/d" \ 231 -e "/cluster_size: [0-9]\\+/d" \ 232 -e "/table_size: [0-9]\\+/d" \ 233 -e "/compat: '[^']*'/d" \ 234 -e "/compat6: \\(on\\|off\\)/d" \ 235 -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \ 236 -e "/static: \\(on\\|off\\)/d" \ 237 -e "/zeroed_grain: \\(on\\|off\\)/d" \ 238 -e "/subformat: '[^']*'/d" \ 239 -e "/adapter_type: '[^']*'/d" \ 240 -e "/hwversion: '[^']*'/d" \ 241 -e "/lazy_refcounts: \\(on\\|off\\)/d" \ 242 -e "/block_size: [0-9]\\+/d" \ 243 -e "/block_state_zero: \\(on\\|off\\)/d" \ 244 -e "/log_size: [0-9]\\+/d" \ 245 -e "s/iters: [0-9]\\+/iters: 1024/" \ 246 -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \ 247 while IFS='' read -r line; do 248 if [[ $format_specific == 1 ]]; then 249 discard=0 250 elif [[ $line == "Format specific information:" ]]; then 251 discard=1 252 elif [[ $line =~ $regex_json_spec_start ]]; then 253 discard=2 254 regex_json_spec_end="^${line%%[^ ]*}\\},? *$" 255 fi 256 if [[ $discard == 0 ]]; then 257 echo "$line" 258 elif [[ $discard == 1 && ! $line ]]; then 259 echo 260 discard=0 261 elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then 262 discard=0 263 fi 264 done 265} 266 267# filter out offsets and file names from qemu-img map; good for both 268# human and json output 269_filter_qemu_img_map() 270{ 271 # Assuming the data_file value in $IMGOPTS contains a '$TEST_IMG', 272 # create a filter that replaces the data file name by $TEST_IMG. 273 # Example: 274 # In $IMGOPTS: 'data_file=$TEST_IMG.data_file' 275 # Then data_file_pattern == '\(.*\).data_file' 276 # And data_file_filter == -e 's#\(.*\).data_file#\1# 277 data_file_filter=() 278 if data_file_pattern=$(_get_data_file '\\(.*\\)'); then 279 data_file_filter=(-e "s#$data_file_pattern#\\1#") 280 fi 281 282 $SED -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \ 283 -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \ 284 -e 's/Mapped to *//' \ 285 "${data_file_filter[@]}" \ 286 | _filter_testdir | _filter_imgfmt 287} 288 289_filter_nbd() 290{ 291 # nbd.c error messages contain function names and line numbers that are 292 # prone to change. Message ordering depends on timing between send and 293 # receive callbacks sometimes, making them unreliable. 294 # 295 # Filter out the TCP port number since this changes between runs. 296 $SED -e '/nbd\/.*\.c:/d' \ 297 -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \ 298 -e "s#?socket=$SOCK_DIR#?socket=SOCK_DIR#g" \ 299 -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#' 300} 301 302_filter_qmp_empty_return() 303{ 304 grep -v '{"return": {}}' 305} 306 307_filter_json_filename() 308{ 309 $PYTHON -c 'import sys 310result, *fnames = sys.stdin.read().split("json:{") 311depth = 0 312for fname in fnames: 313 depth += 1 # For the opening brace in the split separator 314 for chr_i, chr in enumerate(fname): 315 if chr == "{": 316 depth += 1 317 elif chr == "}": 318 depth -= 1 319 if depth == 0: 320 break 321 322 # json:{} filenames may be nested; filter out everything from 323 # inside the outermost one 324 if depth == 0: 325 chr_i += 1 # First character past the filename 326 result += "json:{ /* filtered */ }" + fname[chr_i:] 327 328sys.stdout.write(result)' 329} 330 331# make sure this script returns success 332true 333