tools/testing/selftests/rcutorture/bin/kvm.sh

   1 #!/bin/bash
   2 # SPDX-License-Identifier: GPL-2.0+
   3 #
   4 # Run a series of tests under KVM.  By default, this series is specified
   5 # by the relevant CFLIST file, but can be overridden by the --configs
   6 # command-line argument.
   7 #
   8 # Usage: kvm.sh [ options ]
   9 #
  10 # Copyright (C) IBM Corporation, 2011
  11 #
  12 # Authors: Paul E. McKenney <paulmck@linux.ibm.com>
  13
  14 scriptname=$0
  15 args="$*"
  16
  17 T=${TMPDIR-/tmp}/kvm.sh.$$
  18 trap 'rm -rf $T' 0
  19 mkdir $T
  20
  21 cd `dirname $scriptname`/../../../../../
  22
  23 dur=$((30*60))
  24 dryrun=""
  25 KVM="`pwd`/tools/testing/selftests/rcutorture"; export KVM
  26 PATH=${KVM}/bin:$PATH; export PATH
  27 . functions.sh
  28
  29 TORTURE_ALLOTED_CPUS="`identify_qemu_vcpus`"
  30 TORTURE_DEFCONFIG=defconfig
  31 TORTURE_BOOT_IMAGE=""
  32 TORTURE_INITRD="$KVM/initrd"; export TORTURE_INITRD
  33 TORTURE_KCONFIG_ARG=""
  34 TORTURE_KCONFIG_KCSAN_ARG=""
  35 TORTURE_KMAKE_ARG=""
  36 TORTURE_QEMU_MEM=512
  37 TORTURE_SHUTDOWN_GRACE=180
  38 TORTURE_SUITE=rcu
  39 TORTURE_TRUST_MAKE=""
  40 resdir=""
  41 configs=""
  42 cpus=0
  43 ds=`date +%Y.%m.%d-%H.%M.%S`
  44 jitter="-1"
  45
  46 usage () {
  47         echo "Usage: $scriptname optional arguments:"
  48         echo "       --bootargs kernel-boot-arguments"
  49         echo "       --bootimage relative-path-to-kernel-boot-image"
  50         echo "       --buildonly"
  51         echo "       --configs \"config-file list w/ repeat factor (3*TINY01)\""
  52         echo "       --cpus N"
  53         echo "       --datestamp string"
  54         echo "       --defconfig string"
  55         echo "       --dryrun sched|script"
  56         echo "       --duration minutes"
  57         echo "       --interactive"
  58         echo "       --jitter N [ maxsleep (us) [ maxspin (us) ] ]"
  59         echo "       --kconfig Kconfig-options"
  60         echo "       --kmake-arg kernel-make-arguments"
  61         echo "       --mac nn:nn:nn:nn:nn:nn"
  62         echo "       --memory megabytes | nnnG"
  63         echo "       --no-initrd"
  64         echo "       --qemu-args qemu-arguments"
  65         echo "       --qemu-cmd qemu-system-..."
  66         echo "       --results absolute-pathname"
  67         echo "       --torture rcu"
  68         echo "       --trust-make"
  69         exit 1
  70 }
  71
  72 while test $# -gt 0
  73 do
  74         case "$1" in
  75         --bootargs|--bootarg)
  76                 checkarg --bootargs "(list of kernel boot arguments)" "$#" "$2" '.*' '^--'
  77                 TORTURE_BOOTARGS="$2"
  78                 shift
  79                 ;;
  80         --bootimage)
  81                 checkarg --bootimage "(relative path to kernel boot image)" "$#" "$2" '[a-zA-Z0-9][a-zA-Z0-9_]*' '^--'
  82                 TORTURE_BOOT_IMAGE="$2"
  83                 shift
  84                 ;;
  85         --buildonly)
  86                 TORTURE_BUILDONLY=1
  87                 ;;
  88         --configs|--config)
  89                 checkarg --configs "(list of config files)" "$#" "$2" '^[^/]*$' '^--'
  90                 configs="$2"
  91                 shift
  92                 ;;
  93         --cpus)
  94                 checkarg --cpus "(number)" "$#" "$2" '^[0-9]*$' '^--'
  95                 cpus=$2
  96                 TORTURE_ALLOTED_CPUS="$2"
  97                 max_cpus="`identify_qemu_vcpus`"
  98                 if test "$TORTURE_ALLOTED_CPUS" -gt "$max_cpus"
  99                 then
 100                         TORTURE_ALLOTED_CPUS=$max_cpus
 101                 fi
 102                 shift
 103                 ;;
 104         --datestamp)
 105                 checkarg --datestamp "(relative pathname)" "$#" "$2" '^[^/]*$' '^--'
 106                 ds=$2
 107                 shift
 108                 ;;
 109         --defconfig)
 110                 checkarg --defconfig "defconfigtype" "$#" "$2" '^[^/][^/]*$' '^--'
 111                 TORTURE_DEFCONFIG=$2
 112                 shift
 113                 ;;
 114         --dryrun)
 115                 checkarg --dryrun "sched|script" $# "$2" 'sched\|script' '^--'
 116                 dryrun=$2
 117                 shift
 118                 ;;
 119         --duration)
 120                 checkarg --duration "(minutes)" $# "$2" '^[0-9]*$' '^error'
 121                 dur=$(($2*60))
 122                 shift
 123                 ;;
 124         --interactive)
 125                 TORTURE_QEMU_INTERACTIVE=1; export TORTURE_QEMU_INTERACTIVE
 126                 ;;
 127         --jitter)
 128                 checkarg --jitter "(# threads [ sleep [ spin ] ])" $# "$2" '^-\{,1\}[0-9]\+\( \+[0-9]\+\)\{,2\} *$' '^error$'
 129                 jitter="$2"
 130                 shift
 131                 ;;
 132         --kconfig)
 133                 checkarg --kconfig "(Kconfig options)" $# "$2" '^CONFIG_[A-Z0-9_]\+=\([ynm]\|[0-9]\+\)\( CONFIG_[A-Z0-9_]\+=\([ynm]\|[0-9]\+\)\)*$' '^error$'
 134                 TORTURE_KCONFIG_ARG="$2"
 135                 shift
 136                 ;;
 137         --kcsan)
 138                 TORTURE_KCONFIG_KCSAN_ARG="CONFIG_DEBUG_INFO=y CONFIG_KCSAN=y CONFIG_KCSAN_ASSUME_PLAIN_WRITES_ATOMIC=n CONFIG_KCSAN_REPORT_VALUE_CHANGE_ONLY=n CONFIG_KCSAN_REPORT_ONCE_IN_MS=100000 CONFIG_KCSAN_VERBOSE=y CONFIG_KCSAN_INTERRUPT_WATCHER=y"; export TORTURE_KCONFIG_KCSAN_ARG
 139                 ;;
 140         --kmake-arg)
 141                 checkarg --kmake-arg "(kernel make arguments)" $# "$2" '.*' '^error$'
 142                 TORTURE_KMAKE_ARG="$2"
 143                 shift
 144                 ;;
 145         --mac)
 146                 checkarg --mac "(MAC address)" $# "$2" '^\([0-9a-fA-F]\{2\}:\)\{5\}[0-9a-fA-F]\{2\}$' error
 147                 TORTURE_QEMU_MAC=$2
 148                 shift
 149                 ;;
 150         --memory)
 151                 checkarg --memory "(memory size)" $# "$2" '^[0-9]\+[MG]\?$' error
 152                 TORTURE_QEMU_MEM=$2
 153                 shift
 154                 ;;
 155         --no-initrd)
 156                 TORTURE_INITRD=""; export TORTURE_INITRD
 157                 ;;
 158         --qemu-args|--qemu-arg)
 159                 checkarg --qemu-args "(qemu arguments)" $# "$2" '^-' '^error'
 160                 TORTURE_QEMU_ARG="$2"
 161                 shift
 162                 ;;
 163         --qemu-cmd)
 164                 checkarg --qemu-cmd "(qemu-system-...)" $# "$2" 'qemu-system-' '^--'
 165                 TORTURE_QEMU_CMD="$2"
 166                 shift
 167                 ;;
 168         --results)
 169                 checkarg --results "(absolute pathname)" "$#" "$2" '^/' '^error'
 170                 resdir=$2
 171                 shift
 172                 ;;
 173         --shutdown-grace)
 174                 checkarg --shutdown-grace "(seconds)" "$#" "$2" '^[0-9]*$' '^error'
 175                 TORTURE_SHUTDOWN_GRACE=$2
 176                 shift
 177                 ;;
 178         --torture)
 179                 checkarg --torture "(suite name)" "$#" "$2" '^\(lock\|rcu\|rcuperf\)$' '^--'
 180                 TORTURE_SUITE=$2
 181                 shift
 182                 if test "$TORTURE_SUITE" = rcuperf
 183                 then
 184                         # If you really want jitter for rcuperf, specify
 185                         # it after specifying rcuperf.  (But why?)
 186                         jitter=0
 187                 fi
 188                 ;;
 189         --trust-make)
 190                 TORTURE_TRUST_MAKE="y"
 191                 ;;
 192         *)
 193                 echo Unknown argument $1
 194                 usage
 195                 ;;
 196         esac
 197         shift
 198 done
 199
 200 if test -z "$TORTURE_INITRD" || tools/testing/selftests/rcutorture/bin/mkinitrd.sh
 201 then
 202         :
 203 else
 204         echo No initrd and unable to create one, aborting test >&2
 205         exit 1
 206 fi
 207
 208 TORTURE_KCONFIG_ARG="${TORTURE_KCONFIG_ARG} ${TORTURE_KCONFIG_KCSAN_ARG}"
 209 TORTURE_KCONFIG_ARG="`echo ${TORTURE_KCONFIG_ARG} | sed -e 's/^ *//' -e 's/ *$//'`"
 210
 211 CONFIGFRAG=${KVM}/configs/${TORTURE_SUITE}; export CONFIGFRAG
 212
 213 defaultconfigs="`tr '\012' ' ' < $CONFIGFRAG/CFLIST`"
 214 if test -z "$configs"
 215 then
 216         configs=$defaultconfigs
 217 fi
 218
 219 if test -z "$resdir"
 220 then
 221         resdir=$KVM/res
 222 fi
 223
 224 # Create a file of test-name/#cpus pairs, sorted by decreasing #cpus.
 225 configs_derep=
 226 for CF in $configs
 227 do
 228         case $CF in
 229         [0-9]\**|[0-9][0-9]\**|[0-9][0-9][0-9]\**)
 230                 config_reps=`echo $CF | sed -e 's/\*.*$//'`
 231                 CF1=`echo $CF | sed -e 's/^[^*]*\*//'`
 232                 ;;
 233         *)
 234                 config_reps=1
 235                 CF1=$CF
 236                 ;;
 237         esac
 238         for ((cur_rep=0;cur_rep<$config_reps;cur_rep++))
 239         do
 240                 configs_derep="$configs_derep $CF1"
 241         done
 242 done
 243 touch $T/cfgcpu
 244 configs_derep="`echo $configs_derep | sed -e "s/\<CFLIST\>/$defaultconfigs/g"`"
 245 for CF1 in $configs_derep
 246 do
 247         if test -f "$CONFIGFRAG/$CF1"
 248         then
 249                 cpu_count=`configNR_CPUS.sh $CONFIGFRAG/$CF1`
 250                 cpu_count=`configfrag_boot_cpus "$TORTURE_BOOTARGS" "$CONFIGFRAG/$CF1" "$cpu_count"`
 251                 cpu_count=`configfrag_boot_maxcpus "$TORTURE_BOOTARGS" "$CONFIGFRAG/$CF1" "$cpu_count"`
 252                 echo $CF1 $cpu_count >> $T/cfgcpu
 253         else
 254                 echo "The --configs file $CF1 does not exist, terminating."
 255                 exit 1
 256         fi
 257 done
 258 sort -k2nr $T/cfgcpu -T="$T" > $T/cfgcpu.sort
 259
 260 # Use a greedy bin-packing algorithm, sorting the list accordingly.
 261 awk < $T/cfgcpu.sort > $T/cfgcpu.pack -v ncpus=$cpus '
 262 BEGIN {
 263         njobs = 0;
 264 }
 265
 266 {
 267         # Read file of tests and corresponding required numbers of CPUs.
 268         cf[njobs] = $1;
 269         cpus[njobs] = $2;
 270         njobs++;
 271 }
 272
 273 END {
 274         batch = 0;
 275         nc = -1;
 276
 277         # Each pass through the following loop creates on test batch
 278         # that can be executed concurrently given ncpus.  Note that a
 279         # given test that requires more than the available CPUs will run in
 280         # their own batch.  Such tests just have to make do with what
 281         # is available.
 282         while (nc != ncpus) {
 283                 batch++;
 284                 nc = ncpus;
 285
 286                 # Each pass through the following loop considers one
 287                 # test for inclusion in the current batch.
 288                 for (i = 0; i < njobs; i++) {
 289                         if (done[i])
 290                                 continue; # Already part of a batch.
 291                         if (nc >= cpus[i] || nc == ncpus) {
 292
 293                                 # This test fits into the current batch.
 294                                 done[i] = batch;
 295                                 nc -= cpus[i];
 296                                 if (nc <= 0)
 297                                         break; # Too-big test in its own batch.
 298                         }
 299                 }
 300         }
 301
 302         # Dump out the tests in batch order.
 303         for (b = 1; b <= batch; b++)
 304                 for (i = 0; i < njobs; i++)
 305                         if (done[i] == b)
 306                                 print cf[i], cpus[i];
 307 }'
 308
 309 # Generate a script to execute the tests in appropriate batches.
 310 cat << ___EOF___ > $T/script
 311 CONFIGFRAG="$CONFIGFRAG"; export CONFIGFRAG
 312 KVM="$KVM"; export KVM
 313 PATH="$PATH"; export PATH
 314 TORTURE_ALLOTED_CPUS="$TORTURE_ALLOTED_CPUS"; export TORTURE_ALLOTED_CPUS
 315 TORTURE_BOOT_IMAGE="$TORTURE_BOOT_IMAGE"; export TORTURE_BOOT_IMAGE
 316 TORTURE_BUILDONLY="$TORTURE_BUILDONLY"; export TORTURE_BUILDONLY
 317 TORTURE_DEFCONFIG="$TORTURE_DEFCONFIG"; export TORTURE_DEFCONFIG
 318 TORTURE_INITRD="$TORTURE_INITRD"; export TORTURE_INITRD
 319 TORTURE_KCONFIG_ARG="$TORTURE_KCONFIG_ARG"; export TORTURE_KCONFIG_ARG
 320 TORTURE_KCONFIG_KCSAN_ARG="$TORTURE_KCONFIG_KCSAN_ARG"; export TORTURE_KCONFIG_KCSAN_ARG
 321 TORTURE_KMAKE_ARG="$TORTURE_KMAKE_ARG"; export TORTURE_KMAKE_ARG
 322 TORTURE_QEMU_CMD="$TORTURE_QEMU_CMD"; export TORTURE_QEMU_CMD
 323 TORTURE_QEMU_INTERACTIVE="$TORTURE_QEMU_INTERACTIVE"; export TORTURE_QEMU_INTERACTIVE
 324 TORTURE_QEMU_MAC="$TORTURE_QEMU_MAC"; export TORTURE_QEMU_MAC
 325 TORTURE_QEMU_MEM="$TORTURE_QEMU_MEM"; export TORTURE_QEMU_MEM
 326 TORTURE_SHUTDOWN_GRACE="$TORTURE_SHUTDOWN_GRACE"; export TORTURE_SHUTDOWN_GRACE
 327 TORTURE_SUITE="$TORTURE_SUITE"; export TORTURE_SUITE
 328 TORTURE_TRUST_MAKE="$TORTURE_TRUST_MAKE"; export TORTURE_TRUST_MAKE
 329 if ! test -e $resdir
 330 then
 331         mkdir -p "$resdir" || :
 332 fi
 333 mkdir $resdir/$ds
 334 echo Results directory: $resdir/$ds
 335 echo $scriptname $args
 336 touch $resdir/$ds/log
 337 echo $scriptname $args >> $resdir/$ds/log
 338 echo ${TORTURE_SUITE} > $resdir/$ds/TORTURE_SUITE
 339 pwd > $resdir/$ds/testid.txt
 340 if test -d .git
 341 then
 342         git status >> $resdir/$ds/testid.txt
 343         git rev-parse HEAD >> $resdir/$ds/testid.txt
 344         git diff HEAD >> $resdir/$ds/testid.txt
 345 fi
 346 ___EOF___
 347 awk < $T/cfgcpu.pack \
 348         -v TORTURE_BUILDONLY="$TORTURE_BUILDONLY" \
 349         -v CONFIGDIR="$CONFIGFRAG/" \
 350         -v KVM="$KVM" \
 351         -v ncpus=$cpus \
 352         -v jitter="$jitter" \
 353         -v rd=$resdir/$ds/ \
 354         -v dur=$dur \
 355         -v TORTURE_QEMU_ARG="$TORTURE_QEMU_ARG" \
 356         -v TORTURE_BOOTARGS="$TORTURE_BOOTARGS" \
 357 'BEGIN {
 358         i = 0;
 359 }
 360
 361 {
 362         cf[i] = $1;
 363         cpus[i] = $2;
 364         i++;
 365 }
 366
 367 # Dump out the scripting required to run one test batch.
 368 function dump(first, pastlast, batchnum)
 369 {
 370         print "echo ----Start batch " batchnum ": `date` | tee -a " rd "log";
 371         print "needqemurun="
 372         jn=1
 373         for (j = first; j < pastlast; j++) {
 374                 builddir=KVM "/b" j - first + 1
 375                 cpusr[jn] = cpus[j];
 376                 if (cfrep[cf[j]] == "") {
 377                         cfr[jn] = cf[j];
 378                         cfrep[cf[j]] = 1;
 379                 } else {
 380                         cfrep[cf[j]]++;
 381                         cfr[jn] = cf[j] "." cfrep[cf[j]];
 382                 }
 383                 if (cpusr[jn] > ncpus && ncpus != 0)
 384                         ovf = "-ovf";
 385                 else
 386                         ovf = "";
 387                 print "echo ", cfr[jn], cpusr[jn] ovf ": Starting build. `date` | tee -a " rd "log";
 388                 print "rm -f " builddir ".*";
 389                 print "touch " builddir ".wait";
 390                 print "mkdir " rd cfr[jn] " || :";
 391                 print "kvm-test-1-run.sh " CONFIGDIR cf[j], builddir, rd cfr[jn], dur " \"" TORTURE_QEMU_ARG "\" \"" TORTURE_BOOTARGS "\" > " rd cfr[jn]  "/kvm-test-1-run.sh.out 2>&1 &"
 392                 print "echo ", cfr[jn], cpusr[jn] ovf ": Waiting for build to complete. `date` | tee -a " rd "log";
 393                 print "while test -f " builddir ".wait"
 394                 print "do"
 395                 print "\tsleep 1"
 396                 print "done"
 397                 print "echo ", cfr[jn], cpusr[jn] ovf ": Build complete. `date` | tee -a " rd "log";
 398                 jn++;
 399         }
 400         for (j = 1; j < jn; j++) {
 401                 builddir=KVM "/b" j
 402                 print "rm -f " builddir ".ready"
 403                 print "if test -f \"" rd cfr[j] "/builtkernel\""
 404                 print "then"
 405                 print "\techo ----", cfr[j], cpusr[j] ovf ": Kernel present. `date` | tee -a " rd "log";
 406                 print "\tneedqemurun=1"
 407                 print "fi"
 408         }
 409         njitter = 0;
 410         split(jitter, ja);
 411         if (ja[1] == -1 && ncpus == 0)
 412                 njitter = 1;
 413         else if (ja[1] == -1)
 414                 njitter = ncpus;
 415         else
 416                 njitter = ja[1];
 417         if (TORTURE_BUILDONLY && njitter != 0) {
 418                 njitter = 0;
 419                 print "echo Build-only run, so suppressing jitter | tee -a " rd "log"
 420         }
 421         if (TORTURE_BUILDONLY) {
 422                 print "needqemurun="
 423         }
 424         print "if test -n \"$needqemurun\""
 425         print "then"
 426         print "\techo ---- Starting kernels. `date` | tee -a " rd "log";
 427         for (j = 0; j < njitter; j++)
 428                 print "\tjitter.sh " j " " dur " " ja[2] " " ja[3] "&"
 429         print "\twait"
 430         print "\techo ---- All kernel runs complete. `date` | tee -a " rd "log";
 431         print "else"
 432         print "\twait"
 433         print "\techo ---- No kernel runs. `date` | tee -a " rd "log";
 434         print "fi"
 435         for (j = 1; j < jn; j++) {
 436                 builddir=KVM "/b" j
 437                 print "echo ----", cfr[j], cpusr[j] ovf ": Build/run results: | tee -a " rd "log";
 438                 print "cat " rd cfr[j]  "/kvm-test-1-run.sh.out | tee -a " rd "log";
 439         }
 440 }
 441
 442 END {
 443         njobs = i;
 444         nc = ncpus;
 445         first = 0;
 446         batchnum = 1;
 447
 448         # Each pass through the following loop considers one test.
 449         for (i = 0; i < njobs; i++) {
 450                 if (ncpus == 0) {
 451                         # Sequential test specified, each test its own batch.
 452                         dump(i, i + 1, batchnum);
 453                         first = i;
 454                         batchnum++;
 455                 } else if (nc < cpus[i] && i != 0) {
 456                         # Out of CPUs, dump out a batch.
 457                         dump(first, i, batchnum);
 458                         first = i;
 459                         nc = ncpus;
 460                         batchnum++;
 461                 }
 462                 # Account for the CPUs needed by the current test.
 463                 nc -= cpus[i];
 464         }
 465         # Dump the last batch.
 466         if (ncpus != 0)
 467                 dump(first, i, batchnum);
 468 }' >> $T/script
 469
 470 cat << ___EOF___ >> $T/script
 471 echo
 472 echo
 473 echo " --- `date` Test summary:"
 474 echo Results directory: $resdir/$ds
 475 kvm-recheck.sh $resdir/$ds
 476 ___EOF___
 477
 478 if test "$dryrun" = script
 479 then
 480         cat $T/script
 481         exit 0
 482 elif test "$dryrun" = sched
 483 then
 484         # Extract the test run schedule from the script.
 485         egrep 'Start batch|Starting build\.' $T/script |
 486                 grep -v ">>" |
 487                 sed -e 's/:.*$//' -e 's/^echo //'
 488         exit 0
 489 else
 490         # Not a dryrun, so run the script.
 491         sh $T/script
 492 fi
 493
 494 # Tracing: trace_event=rcu:rcu_grace_period,rcu:rcu_future_grace_period,rcu:rcu_grace_period_init,rcu:rcu_nocb_wake,rcu:rcu_preempt_task,rcu:rcu_unlock_preempted_task,rcu:rcu_quiescent_state_report,rcu:rcu_fqs,rcu:rcu_callback,rcu:rcu_kfree_callback,rcu:rcu_batch_start,rcu:rcu_invoke_callback,rcu:rcu_invoke_kfree_callback,rcu:rcu_batch_end,rcu:rcu_torture_read,rcu:rcu_barrier
 495 # Function-graph tracing: ftrace=function_graph ftrace_graph_filter=sched_setaffinity,migration_cpu_stop
 496 # Also --kconfig "CONFIG_FUNCTION_TRACER=y CONFIG_FUNCTION_GRAPH_TRACER=y"