common/fuzzy

   1 ##/bin/bash
   2
   3 # Routines for fuzzing and scrubbing a filesystem.
   4 #
   5 #-----------------------------------------------------------------------
   6 #  Copyright (c) 2017 Oracle.  All Rights Reserved.
   7 #  This program is free software; you can redistribute it and/or modify
   8 #  it under the terms of the GNU General Public License as published by
   9 #  the Free Software Foundation; either version 2 of the License, or
  10 #  (at your option) any later version.
  11 #
  12 #  This program is distributed in the hope that it will be useful,
  13 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #  GNU General Public License for more details.
  16 #
  17 #  You should have received a copy of the GNU General Public License
  18 #  along with this program; if not, write to the Free Software
  19 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  20 #  USA
  21 #-----------------------------------------------------------------------
  22
  23 # Modify various files after a fuzzing operation
  24 _scratch_fuzz_modify() {
  25         nr="$1"
  26
  27         test -z "${nr}" && nr=50000
  28         echo "+++ touch ${nr} files"
  29         blk_sz=$(stat -f -c '%s' ${SCRATCH_MNT})
  30         $XFS_IO_PROG -f -c "pwrite -S 0x63 0 ${blk_sz}" "/tmp/afile" > /dev/null
  31         date="$(date)"
  32         find "${SCRATCH_MNT}/" -type f 2> /dev/null | head -n "${nr}" | while read f; do
  33                 setfattr -n "user.date" -v "${date}" "$f"
  34                 cat "/tmp/afile" >> "$f"
  35                 mv "$f" "$f.longer"
  36         done
  37         sync
  38         rm -rf "/tmp/afile"
  39
  40         echo "+++ create files"
  41         mkdir -p "${SCRATCH_MNT}/test.moo"
  42         $XFS_IO_PROG -f -c 'pwrite -S 0x80 0 65536' "${SCRATCH_MNT}/test.moo/urk" > /dev/null
  43         sync
  44
  45         echo "+++ remove files"
  46         rm -rf "${SCRATCH_MNT}/test.moo"
  47 }
  48
  49 # Try to access files after fuzzing
  50 _scratch_fuzz_test() {
  51         echo "+++ ls -laR" >> $seqres.full
  52         ls -laR "${SCRATCH_MNT}/test.1/" >/dev/null 2>&1
  53
  54         echo "+++ cat files" >> $seqres.full
  55         (find "${SCRATCH_MNT}/test.1/" -type f -size -1048576k -print0 | xargs -0 cat) >/dev/null 2>&1
  56 }
  57
  58 # Do we have an online scrub program?
  59 _require_scrub() {
  60         case "${FSTYP}" in
  61         "xfs")
  62                 test -x "$XFS_SCRUB_PROG" || _notrun "xfs_scrub not found"
  63                 ;;
  64         *)
  65                 _notrun "No online scrub program for ${FSTYP}."
  66                 ;;
  67         esac
  68 }
  69
  70 # Scrub the scratch filesystem metadata (online)
  71 _scratch_scrub() {
  72         case "${FSTYP}" in
  73         "xfs")
  74                 $XFS_SCRUB_PROG -d -T -v "$@" $SCRATCH_MNT
  75                 ;;
  76         *)
  77                 _fail "No online scrub program for ${FSTYP}."
  78                 ;;
  79         esac
  80 }
  81
  82 # Filter out any keys with an array index >= 10, collapse any array range
  83 # ("[1-195]") to the first item, and ignore padding fields.
  84 __filter_xfs_db_keys() {
  85         sed -e '/\([a-z]*\)\[\([0-9][0-9]\+\)\].*/d' \
  86             -e 's/\([a-zA-Z0-9_]*\)\[\([0-9]*\)-[0-9]*\]/\1[\2]/g' \
  87             -e '/pad/d'
  88 }
  89
  90 # Filter the xfs_db print command's field debug information
  91 # into field name and type.
  92 __filter_xfs_db_print_fields() {
  93         filter="$1"
  94         if [ -z "${filter}" ] || [ "${filter}" = "nofilter" ]; then
  95                 filter='^'
  96         fi
  97         grep ' = ' | while read key equals value; do
  98                 fuzzkey="$(echo "${key}" | __filter_xfs_db_keys)"
  99                 if [ -z "${fuzzkey}" ]; then
 100                         continue
 101                 elif [[ "${value}" == "["* ]]; then
 102                         echo "${value}" | sed -e 's/^.//g' -e 's/.$//g' -e 's/,/\n/g' | while read subfield; do
 103                                 echo "${fuzzkey}.${subfield}"
 104                         done | __filter_xfs_db_keys
 105                 else
 106                         echo "${fuzzkey}"
 107                 fi
 108         done | egrep "${filter}"
 109 }
 110
 111 # Navigate to some part of the filesystem and print the field info.
 112 # The first argument is an egrep filter for the fields
 113 # The rest of the arguments are xfs_db commands to locate the metadata.
 114 _scratch_xfs_list_metadata_fields() {
 115         filter="$1"
 116         shift
 117         if [ -n "${SCRATCH_XFS_LIST_METADATA_FIELDS}" ]; then
 118                 echo "${SCRATCH_XFS_LIST_METADATA_FIELDS}" | tr '[ ,]' '[\n\n]'
 119                 return;
 120         fi
 121
 122         local cmds=()
 123         for arg in "$@"; do
 124                 cmds+=("-c" "${arg}")
 125         done
 126         _scratch_xfs_db "${cmds[@]}" -c print | __filter_xfs_db_print_fields "${filter}"
 127 }
 128
 129 # Fuzz a metadata field
 130 # The first arg is the field name
 131 # The second arg is the xfs_db fuzz verb
 132 # The rest of the arguments are xfs_db commands to find the metadata.
 133 _scratch_xfs_fuzz_metadata_field() {
 134         key="$1"
 135         value="$2"
 136         shift; shift
 137
 138         if [[ "${key}" == *crc ]]; then
 139                 fuzz_arg="-c"
 140         else
 141                 fuzz_arg="-d"
 142         fi
 143         oldval="$(_scratch_xfs_get_metadata_field "${key}" "$@")"
 144
 145         local cmds=()
 146         for arg in "$@"; do
 147                 cmds+=("-c" "${arg}")
 148         done
 149         while true; do
 150                 _scratch_xfs_db -x "${cmds[@]}" -c "fuzz ${fuzz_arg} ${key} ${value}"
 151                 echo
 152                 newval="$(_scratch_xfs_get_metadata_field "${key}" "$@" 2> /dev/null)"
 153                 if [ "${key}" != "random" ] || [ "${oldval}" != "${newval}" ]; then
 154                         break;
 155                 fi
 156         done
 157         if [ "${oldval}" = "${newval}" ]; then
 158                 echo "Field ${key} already set to ${newval}, skipping test."
 159                 return 1
 160         fi
 161         return 0
 162 }
 163
 164 # Try to forcibly unmount the scratch fs
 165 __scratch_xfs_fuzz_unmount()
 166 {
 167         while _scratch_unmount 2>/dev/null; do sleep 0.2; done
 168 }
 169
 170 # Restore metadata to scratch device prior to field-fuzzing.
 171 __scratch_xfs_fuzz_mdrestore()
 172 {
 173         test -e "${POPULATE_METADUMP}" || _fail "Need to set POPULATE_METADUMP"
 174
 175         __scratch_xfs_fuzz_unmount
 176         xfs_mdrestore "${POPULATE_METADUMP}" "${SCRATCH_DEV}"
 177 }
 178
 179 __fuzz_notify() {
 180         echo "$@"
 181         test -w /dev/ttyprintk && echo "$@" >> /dev/ttyprintk
 182 }
 183
 184 # Fuzz one field of some piece of metadata.
 185 # First arg is the field name
 186 # Second arg is the fuzz verb (ones, zeroes, random, add, sub...)
 187 # Third arg is the repair mode (online, offline, both)
 188 __scratch_xfs_fuzz_field_test() {
 189         field="$1"
 190         fuzzverb="$2"
 191         repair="$3"
 192         shift; shift; shift
 193
 194         # Set the new field value
 195         __fuzz_notify "+ Fuzz ${field} = ${fuzzverb}"
 196         echo "========================"
 197         _scratch_xfs_fuzz_metadata_field "${field}" ${fuzzverb} "$@"
 198         res=$?
 199         test $res -ne 0 && return
 200
 201         # Try to catch the error with scrub
 202         echo "+ Try to catch the error"
 203         _try_scratch_mount 2>&1
 204         res=$?
 205         if [ $res -eq 0 ]; then
 206                 # Try an online scrub unless we're fuzzing ag 0's sb,
 207                 # which scrub doesn't know how to fix.
 208                 echo "++ Online scrub"
 209                 if [ "$1" != "sb 0" ]; then
 210                         _scratch_scrub -n -a 1 -e continue 2>&1
 211                         res=$?
 212                         test $res -eq 0 && \
 213                                 (>&2 echo "scrub didn't fail with ${field} = ${fuzzverb}.")
 214                 fi
 215
 216                 # Try fixing the filesystem online?!
 217                 if [ "${repair}" = "online" ] || [ "${repair}" = "both" ]; then
 218                         __fuzz_notify "++ Try to repair filesystem online"
 219                         _scratch_scrub 2>&1
 220                         res=$?
 221                         test $res -ne 0 && \
 222                                 (>&2 echo "online repair failed ($res) with ${field} = ${fuzzverb}.")
 223                 fi
 224
 225                 __scratch_xfs_fuzz_unmount
 226         elif [ "${repair}" = "online" ] || [ "${repair}" = "both" ]; then
 227                 (>&2 echo "mount failed ($res) with ${field} = ${fuzzverb}.")
 228         fi
 229
 230         # Repair the filesystem offline?
 231         if [ "${repair}" = "offline" ] || [ "${repair}" = "both" ]; then
 232                 echo "+ Try to repair the filesystem offline"
 233                 _repair_scratch_fs 2>&1
 234                 res=$?
 235                 test $res -ne 0 && \
 236                         (>&2 echo "offline repair failed ($res) with ${field} = ${fuzzverb}.")
 237         fi
 238
 239         # See if repair finds a clean fs
 240         echo "+ Make sure error is gone (offline)"
 241         _scratch_xfs_repair -n 2>&1
 242         res=$?
 243         test $res -ne 0 && \
 244                 (>&2 echo "offline re-scrub ($res) with ${field} = ${fuzzverb}.")
 245
 246         # See if scrub finds a clean fs
 247         echo "+ Make sure error is gone (online)"
 248         _try_scratch_mount 2>&1
 249         res=$?
 250         if [ $res -eq 0 ]; then
 251                 # Try an online scrub unless we're fuzzing ag 0's sb,
 252                 # which scrub doesn't know how to fix.
 253                 echo "++ Online scrub"
 254                 if [ "$1" != "sb 0" ]; then
 255                         _scratch_scrub -n -e continue 2>&1
 256                         res=$?
 257                         test $res -ne 0 && \
 258                                 (>&2 echo "online re-scrub ($res) with ${field} = ${fuzzverb}.")
 259                 fi
 260
 261                 # Try modifying the filesystem again!
 262                 __fuzz_notify "++ Try to write filesystem again"
 263                 _scratch_fuzz_modify 100 2>&1
 264                 __scratch_xfs_fuzz_unmount
 265         else
 266                 (>&2 echo "re-mount failed ($res) with ${field} = ${fuzzverb}.")
 267         fi
 268
 269         # See if repair finds a clean fs
 270         echo "+ Re-check the filesystem (offline)"
 271         _scratch_xfs_repair -n 2>&1
 272         res=$?
 273         test $res -ne 0 && \
 274                 (>&2 echo "re-repair failed ($res) with ${field} = ${fuzzverb}.")
 275 }
 276
 277 # Make sure we have all the pieces we need for field fuzzing
 278 _require_scratch_xfs_fuzz_fields()
 279 {
 280         _require_scratch_nocheck
 281         _require_scrub
 282         _require_populate_commands
 283         _scratch_mkfs_xfs >/dev/null 2>&1
 284         _require_xfs_db_command "fuzz"
 285 }
 286
 287 # Grab the list of available fuzzing verbs
 288 _scratch_xfs_list_fuzz_verbs() {
 289         if [ -n "${SCRATCH_XFS_LIST_FUZZ_VERBS}" ]; then
 290                 echo "${SCRATCH_XFS_LIST_FUZZ_VERBS}" | tr '[ ,]' '[\n\n]'
 291                 return;
 292         fi
 293         _scratch_xfs_db -x -c 'sb 0' -c 'fuzz' | grep '^Fuzz commands:' | \
 294                 sed -e 's/[,.]//g' -e 's/Fuzz commands: //g' -e 's/ /\n/g'
 295 }
 296
 297 # Fuzz some of the fields of some piece of metadata
 298 # The first argument is an egrep filter for the field names
 299 # The second argument is the repair mode (online, offline, both)
 300 # The rest of the arguments are xfs_db commands to locate the metadata.
 301 #
 302 # Users can specify the fuzz verbs via SCRATCH_XFS_LIST_FUZZ_VERBS
 303 # They can specify the fields via SCRATCH_XFS_LIST_METADATA_FIELDS
 304 _scratch_xfs_fuzz_metadata() {
 305         filter="$1"
 306         repair="$2"
 307         shift; shift
 308
 309         fields="$(_scratch_xfs_list_metadata_fields "${filter}" "$@")"
 310         verbs="$(_scratch_xfs_list_fuzz_verbs)"
 311         echo "Fields we propose to fuzz under: $@"
 312         echo $(echo "${fields}")
 313         echo "Verbs we propose to fuzz with:"
 314         echo $(echo "${verbs}")
 315
 316         echo "${fields}" | while read field; do
 317                 echo "${verbs}" | while read fuzzverb; do
 318                         __scratch_xfs_fuzz_mdrestore
 319                         __scratch_xfs_fuzz_field_test "${field}" "${fuzzverb}" "${repair}" "$@"
 320                 done
 321         done
 322 }