common.filter (11127B)
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 -Ee '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 -E -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 -Ee 's/\#block[0-9]{3,}/NODE_NAME/' 36 } 37 38 _filter_qom_path() 39 { 40 gsed -e '/Attached to:/s/\device[[0-9]\+\]/device[N]/g' 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 -e "s#SOCK_DIR/fuse-#TEST_DIR/#g" 49 } 50 51 # replace occurrences of the actual IMGFMT value with IMGFMT 52 _filter_imgfmt() 53 { 54 sed -e "s#$IMGFMT#IMGFMT#g" 55 } 56 57 # Replace error message when the format is not supported and delete 58 # the output lines after the first one 59 _filter_qemu_img_check() 60 { 61 gsed -e '/allocated.*fragmented.*compressed clusters/d' \ 62 -e 's/qemu-img: This image format does not support checks/No errors were found on the image./' \ 63 -e '/Image end offset: [0-9]\+/d' 64 } 65 66 # Removes \r from messages 67 _filter_win32() 68 { 69 gsed -e 's/\r//g' 70 } 71 72 # sanitize qemu-io output 73 _filter_qemu_io() 74 { 75 _filter_win32 | \ 76 gsed -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)/" \ 77 -e "s/: line [0-9][0-9]*: *[0-9][0-9]*\( Aborted\| Killed\)/:\1/" \ 78 -e "s/qemu-io> //g" 79 } 80 81 # replace occurrences of QEMU_PROG with "qemu" 82 _filter_qemu() 83 { 84 gsed -e "s#\\(^\\|(qemu) \\)$(basename $QEMU_PROG):#\1QEMU_PROG:#" \ 85 -e 's#^QEMU [0-9]\+\.[0-9]\+\.[0-9]\+ monitor#QEMU X.Y.Z monitor#' \ 86 -e $'s#\r##' # QEMU monitor uses \r\n line endings 87 } 88 89 # replace problematic QMP output like timestamps 90 _filter_qmp() 91 { 92 _filter_win32 | \ 93 gsed -e 's#\("\(micro\)\?seconds": \)[0-9]\+#\1 TIMESTAMP#g' \ 94 -e 's#^{"QMP":.*}$#QMP_VERSION#' \ 95 -e '/^ "QMP": {\s*$/, /^ }\s*$/ c\' \ 96 -e ' QMP_VERSION' 97 } 98 99 # readline makes HMP command strings so long that git complains 100 _filter_hmp() 101 { 102 gsed -e $'s/^\\((qemu) \\)\\?.*\e\\[D/\\1/g' \ 103 -e $'s/\e\\[K//g' 104 } 105 106 # replace block job offset 107 _filter_block_job_offset() 108 { 109 gsed -e 's/, "offset": [0-9]\+,/, "offset": OFFSET,/' 110 } 111 112 # replace block job len 113 _filter_block_job_len() 114 { 115 gsed -e 's/, "len": [0-9]\+,/, "len": LEN,/g' 116 } 117 118 # replace actual image size (depends on the host filesystem) 119 _filter_actual_image_size() 120 { 121 gsed -s 's/\("actual-size":\s*\)[0-9]\+/\1SIZE/g' 122 } 123 124 # Filename filters for qemu-img create 125 _filter_img_create_filenames() 126 { 127 sed \ 128 -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \ 129 -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \ 130 -e "s#$TEST_DIR#TEST_DIR#g" \ 131 -e "s#$SOCK_DIR#SOCK_DIR#g" \ 132 -e 's#SOCK_DIR/fuse-#TEST_DIR/#g' \ 133 -e "s#$IMGFMT#IMGFMT#g" \ 134 -e 's#nbd:127.0.0.1:[0-9]\\+#TEST_DIR/t.IMGFMT#g' \ 135 -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' 136 } 137 138 # replace driver-specific options in the "Formatting..." line 139 _do_filter_img_create() 140 { 141 # Split the line into the pre-options part ($filename_part, which 142 # precedes ", fmt=") and the options part ($options, which starts 143 # with "fmt=") 144 # (And just echo everything before the first "^Formatting") 145 readarray formatting_line < <(gsed -e 's/, fmt=/\n/') 146 147 filename_part=${formatting_line[0]} 148 unset formatting_line[0] 149 150 options="fmt=${formatting_line[@]}" 151 152 # Set grep_data_file to '\|data_file' to keep it; make it empty 153 # to drop it. 154 # We want to drop it if it is part of the global $IMGOPTS, and we 155 # want to keep it otherwise (if the test specifically wants to 156 # test data files). 157 grep_data_file=(-e data_file) 158 if _get_data_file "$TEST_IMG" > /dev/null; then 159 grep_data_file=() 160 fi 161 162 filename_part=$(echo "$filename_part" | _filter_img_create_filenames) 163 164 # Break the option line before each option (preserving pre-existing 165 # line breaks by replacing them by \0 and restoring them at the end), 166 # then filter out the options we want to keep and sort them according 167 # to some order that all block drivers used at the time of writing 168 # this function. 169 options=$( 170 echo "$options" \ 171 | tr '\n' '\0' \ 172 | gsed -e 's/ \([a-z0-9_.-]*\)=/\n\1=/g' \ 173 | grep -a -e '^fmt' -e '^size' -e '^backing' -e '^preallocation' \ 174 -e '^encryption' "${grep_data_file[@]}" \ 175 | _filter_img_create_filenames \ 176 | sed \ 177 -e 's/^\(fmt\)/0-\1/' \ 178 -e 's/^\(size\)/1-\1/' \ 179 -e 's/^\(backing\)/2-\1/' \ 180 -e 's/^\(data_file\)/3-\1/' \ 181 -e 's/^\(encryption\)/4-\1/' \ 182 -e 's/^\(preallocation\)/8-\1/' \ 183 | LC_ALL=C sort \ 184 | sed -e 's/^[0-9]-//' \ 185 | tr '\n\0' ' \n' \ 186 | sed -e 's/^ *$//' -e 's/ *$//' 187 ) 188 189 if [ -n "$options" ]; then 190 echo "$filename_part, $options" 191 elif [ -n "$filename_part" ]; then 192 echo "$filename_part" 193 fi 194 } 195 196 # Filter qemu-img create output: 197 # Pipe all ^Formatting lines through _do_filter_img_create, and all 198 # other lines through _filter_img_create_filenames 199 _filter_img_create() 200 { 201 while read -r line; do 202 if echo "$line" | grep -q '^Formatting'; then 203 echo "$line" | _do_filter_img_create 204 else 205 echo "$line" | _filter_img_create_filenames 206 fi 207 done 208 } 209 210 _filter_img_create_size() 211 { 212 gsed -e "s# size=[0-9]\\+# size=SIZE#g" 213 } 214 215 _filter_img_info() 216 { 217 if [[ "$1" == "--format-specific" ]]; then 218 local format_specific=1 219 shift 220 else 221 local format_specific=0 222 fi 223 224 discard=0 225 regex_json_spec_start='^ *"format-specific": \{' 226 gsed -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \ 227 -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \ 228 -e "s#$TEST_DIR#TEST_DIR#g" \ 229 -e "s#$SOCK_DIR#SOCK_DIR#g" \ 230 -e "s#$IMGFMT#IMGFMT#g" \ 231 -e 's#nbd://127.0.0.1:[0-9]\\+$#TEST_DIR/t.IMGFMT#g' \ 232 -e 's#nbd+unix:///\??socket=SOCK_DIR/nbd#TEST_DIR/t.IMGFMT#g' \ 233 -e 's#SOCK_DIR/fuse-#TEST_DIR/#g' \ 234 -e "/encrypted: yes/d" \ 235 -e "/cluster_size: [0-9]\\+/d" \ 236 -e "/table_size: [0-9]\\+/d" \ 237 -e "/compat: '[^']*'/d" \ 238 -e "/compat6: \\(on\\|off\\)/d" \ 239 -e "s/cid: [0-9]\+/cid: XXXXXXXXXX/" \ 240 -e "/static: \\(on\\|off\\)/d" \ 241 -e "/zeroed_grain: \\(on\\|off\\)/d" \ 242 -e "/subformat: '[^']*'/d" \ 243 -e "/adapter_type: '[^']*'/d" \ 244 -e "/hwversion: '[^']*'/d" \ 245 -e "/lazy_refcounts: \\(on\\|off\\)/d" \ 246 -e "/extended_l2=\\(on\\|off\\)/d" \ 247 -e "/block_size: [0-9]\\+/d" \ 248 -e "/block_state_zero: \\(on\\|off\\)/d" \ 249 -e "/log_size: [0-9]\\+/d" \ 250 -e "s/iters: [0-9]\\+/iters: 1024/" \ 251 -e 's/\(compression type: \)\(zlib\|zstd\)/\1COMPRESSION_TYPE/' \ 252 -e "s/uuid: [-a-f0-9]\\+/uuid: 00000000-0000-0000-0000-000000000000/" | \ 253 while IFS='' read -r line; do 254 if [[ $format_specific == 1 ]]; then 255 discard=0 256 elif [[ $line == "Format specific information:" ]]; then 257 discard=1 258 elif [[ $line =~ $regex_json_spec_start ]]; then 259 discard=2 260 regex_json_spec_end="^${line%%[^ ]*}\\},? *$" 261 fi 262 if [[ $discard == 0 ]]; then 263 echo "$line" 264 elif [[ $discard == 1 && ! $line ]]; then 265 echo 266 discard=0 267 elif [[ $discard == 2 && $line =~ $regex_json_spec_end ]]; then 268 discard=0 269 fi 270 done 271 } 272 273 # filter out offsets and file names from qemu-img map; good for both 274 # human and json output 275 _filter_qemu_img_map() 276 { 277 # Assuming the data_file value in $IMGOPTS contains a '$TEST_IMG', 278 # create a filter that replaces the data file name by $TEST_IMG. 279 # Example: 280 # In $IMGOPTS: 'data_file=$TEST_IMG.data_file' 281 # Then data_file_pattern == '\(.*\).data_file' 282 # And data_file_filter == -e 's#\(.*\).data_file#\1# 283 data_file_filter=() 284 if data_file_pattern=$(_get_data_file '\\(.*\\)'); then 285 data_file_filter=(-e "s#$data_file_pattern#\\1#") 286 fi 287 288 sed -e 's/\([0-9a-fx]* *[0-9a-fx]* *\)[0-9a-fx]* */\1/g' \ 289 -e 's/"offset": [0-9]\+/"offset": OFFSET/g' \ 290 -e 's/Mapped to *//' \ 291 "${data_file_filter[@]}" \ 292 | _filter_testdir | _filter_imgfmt 293 } 294 295 _filter_nbd() 296 { 297 # nbd.c error messages contain function names and line numbers that are 298 # prone to change. Message ordering depends on timing between send and 299 # receive callbacks sometimes, making them unreliable. 300 # 301 # Filter out the TCP port number since this changes between runs. 302 sed -e '/nbd\/.*\.c:/d' \ 303 -e 's#127\.0\.0\.1:[0-9]*#127.0.0.1:PORT#g' \ 304 -e 's#localhost:[0-9]*#localhost:PORT#g' \ 305 -e 's#host=127\.0\.0\.1,port=[0-9]*#host=127.0.0.1,port=PORT#g' \ 306 -e 's#host=localhost,port=[0-9]*#host=localhost,port=PORT#g' \ 307 -e "s#path=$SOCK_DIR#path=SOCK_DIR#g" \ 308 -e "s#?socket=$SOCK_DIR#?socket=SOCK_DIR#g" \ 309 -e 's#\(foo\|PORT/\?\|.sock\): Failed to .*$#\1#' 310 } 311 312 _filter_qemu_nbd_exports() 313 { 314 grep '\(exports available\|export\|size\|min block\|qemu-nbd\):' 315 } 316 317 _filter_qmp_empty_return() 318 { 319 grep -v '{"return": {}}' 320 } 321 322 _filter_json_filename() 323 { 324 $PYTHON -c 'import sys 325 result, *fnames = sys.stdin.read().split("json:{") 326 depth = 0 327 for fname in fnames: 328 depth += 1 # For the opening brace in the split separator 329 for chr_i, chr in enumerate(fname): 330 if chr == "{": 331 depth += 1 332 elif chr == "}": 333 depth -= 1 334 if depth == 0: 335 break 336 337 # json:{} filenames may be nested; filter out everything from 338 # inside the outermost one 339 if depth == 0: 340 chr_i += 1 # First character past the filename 341 result += "json:{ /* filtered */ }" + fname[chr_i:] 342 343 sys.stdout.write(result)' 344 } 345 346 _filter_authz_check_tls() 347 { 348 sed -e 's/TLS x509 authz check for .* is denied/TLS x509 authz check for DISTINGUISHED-NAME is denied/' 349 } 350 351 _filter_qcow2_compression_type_bit() 352 { 353 gsed -e 's/\(incompatible_features\s\+\)\[3\(, \)\?/\1[/' \ 354 -e 's/\(incompatible_features.*\), 3\]/\1]/' \ 355 -e 's/\(incompatible_features.*\), 3\(,.*\)/\1\2/' 356 } 357 358 # make sure this script returns success 359 true