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