scripts/scsi_logging_level

   1 #! /bin/bash
   2 ###############################################################################
   3 # Conveniently create and set scsi logging level, show SCSI_LOG fields in human
   4 # readable form.
   5 #
   6 # Copyright IBM Corp. 2006.
   7 ###############################################################################
   8
   9
  10 SCRIPTNAME="scsi_logging_level"
  11
  12 declare -i LOG_ERROR=0
  13 declare -i LOG_TIMEOUT=0
  14 declare -i LOG_SCAN=0
  15 declare -i LOG_MLQUEUE=0
  16 declare -i LOG_MLCOMPLETE=0
  17 declare -i LOG_LLQUEUE=0
  18 declare -i LOG_LLCOMPLETE=0
  19 declare -i LOG_HLQUEUE=0
  20 declare -i LOG_HLCOMPLETE=0
  21 declare -i LOG_IOCTL=0
  22
  23 declare -i LEVEL=0
  24
  25 _ERROR_SHIFT=0
  26 _TIMEOUT_SHIFT=3
  27 _SCAN_SHIFT=6
  28 _MLQUEUE_SHIFT=9
  29 _MLCOMPLETE_SHIFT=12
  30 _LLQUEUE_SHIFT=15
  31 _LLCOMPLETE_SHIFT=18
  32 _HLQUEUE_SHIFT=21
  33 _HLCOMPLETE_SHIFT=24
  34 _IOCTL_SHIFT=27
  35
  36 SET=0
  37 GET=0
  38 CREATE=0
  39
  40 OPTS=`getopt -o hvcgsa:E:T:S:I:M:L:H: --long \
  41 help,version,create,get,set,all:,error:,timeout:,scan:,ioctl:,\
  42 midlevel:,mlqueue:,mlcomplete:,lowlevel:,llqueue:,llcomplete:,\
  43 highlevel:,hlqueue:,hlcomplete: -n \'$SCRIPTNAME\' -- "$@"`
  44 eval set -- "$OPTS"
  45
  46 # print version info
  47 printversion()
  48 {
  49     cat <<EOF
  50 $SCRIPTNAME: version %S390_TOOLS_VERSION%
  51 Copyright IBM Corp. 2006
  52 EOF
  53 }
  54
  55 # print usage and help
  56 printhelp()
  57 {
  58     cat <<EOF
  59 Usage: $SCRIPTNAME [OPTIONS]
  60
  61 Create, get or set scsi logging level.
  62
  63 Options:
  64
  65         -h, --help       print this help
  66         -v, --version    print version information
  67         -s, --set        create and set logging level as specified on
  68                          command line
  69         -g, --get        get current logging level and display it
  70         -c, --create     create logging level as specified on command line
  71         -a, --all        specify value for all SCSI_LOG fields
  72         -E, --error      specify SCSI_LOG_ERROR
  73         -T, --timeout    specify SCSI_LOG_TIMEOUT
  74         -S, --scan       specify SCSI_LOG_SCAN
  75         -M, --midlevel   specify SCSI_LOG_MLQUEUE and SCSI_LOG_MLCOMPLETE
  76             --mlqueue    specify SCSI_LOG_MLQUEUE
  77             --mlcomplete specify SCSI_LOG_MLCOMPLETE
  78         -L, --lowlevel   specify SCSI_LOG_LLQUEUE and SCSI_LOG_LLCOMPLETE
  79             --llqueue    specify SCSI_LOG_LLQUEUE
  80             --llcomplete specify SCSI_LOG_LLCOMPLETE
  81         -H, --highlevel  specify SCSI_LOG_HLQUEUE and SCSI_LOG_HLCOMPLETE
  82             --hlqueue    specify SCSI_LOG_HLQUEUE
  83             --hlcomplete specify SCSI_LOG_HLCOMPLETE
  84         -I, --ioctl      specify SCSI_LOG_IOCTL
  85
  86 Exactly one of the options "-c", "-g" and "-s" has to be specified.
  87 Valid values for SCSI_LOG fields are integers from 0 to 7.
  88
  89 Note: Several SCSI_LOG fields can be specified using several options.
  90 When multiple options specify same SCSI_LOG field the most specific
  91 option has precedence.
  92
  93 Example: "scsi_logging_level --hlqueue 3 --hlcomplete 2 --all 1 -s" sets
  94 SCSI_LOG_HLQUEUE=3, SCSI_LOG_HLCOMPLETE=2 and assigns all other SCSI_LOG
  95 fields the value 1.
  96 EOF
  97 }
  98
  99 check_level()
 100 {
 101     if [ `echo -n $1 | tr --complement [:digit:] 'a' | grep -s 'a'` ]
 102     then
 103         invalid_cmdline "log level '$1' out of range [0, 7]"
 104     fi
 105
 106     if [ $1 -lt 0 -o $1 -gt 7 ]
 107     then
 108         invalid_cmdline "log level '$1' out of range [0, 7]"
 109     fi
 110 }
 111
 112 # check cmd line arguments
 113 check_cmdline()
 114 {
 115     while true ; do
 116         case "$1" in
 117             -a|--all)   _ALL=$2; check_level $2
 118                         shift 2;;
 119             -c|--create) CREATE=1;
 120                         shift 1;;
 121             -g|--get)   GET=1
 122                         shift 1;;
 123             -h|--help) printhelp
 124                         exit 0;;
 125             -s|--set)   SET=1
 126                         shift 1;;
 127             -v|--version) printversion
 128                         exit 0;;
 129             -E|--error) _ERROR=$2; check_level $2
 130                         shift 2;;
 131             -T|--timeout) _TIMEOUT=$2; check_level $2
 132                         shift 2;;
 133             -S|--scan)  _SCAN=$2; check_level $2
 134                         shift 2;;
 135             -M|--midlevel) _ML=$2; check_level $2
 136                         shift 2;;
 137             --mlqueue)  _MLQUEUE=$2; check_level $2
 138                         shift 2;;
 139             --mlcomplete) _MLCOMPLETE=$2; check_level $2
 140                         shift 2;;
 141             -L|--lowlevel) _LL=$2; check_level $2
 142                         shift 2;;
 143             --llqueue)  _LLQUEUE=$2; check_level $2
 144                         shift 2;;
 145             --llcomplete) _LLCOMPLETE=$2; check_level $2
 146                         shift 2;;
 147             -H|--highlevel) _HL=$2; check_level $2
 148                         shift 2;;
 149             --hlqueue)  _HLQUEUE=$2; check_level $2
 150                         shift 2;;
 151             --hlcomplete) _HLCOMPLETE=$2; check_level $2
 152                         shift 2;;
 153             -I|--ioctl) _IOCTL=$2; check_level $2
 154                         shift 2;;
 155             --) shift; break;;
 156             *) echo "Internal error!" ; exit 1;;
 157         esac
 158     done
 159
 160     if [ -n "$*" ]
 161     then
 162         invalid_cmdline invalid parameter $*
 163     fi
 164
 165     if [ $GET = "1" -a $SET = "1" ]
 166     then
 167         invalid_cmdline options \'-c\', \'-g\' and \'-s\' are mutual exclusive
 168     elif [ $GET = "1" -a $CREATE = "1" ]
 169     then
 170         invalid_cmdline options \'-c\', \'-g\' and \'-s\' are mutual exclusive
 171     elif [ $SET = "1" -a $CREATE = "1" ]
 172     then
 173         invalid_cmdline options \'-c\', \'-g\' and \'-s\' are mutual exclusive
 174     fi
 175
 176     LOG_ERROR=${_ERROR:-${_ALL:-0}}
 177     LOG_TIMEOUT=${_TIMEOUT:-${_ALL:-0}}
 178     LOG_SCAN=${_SCAN:-${_ALL:-0}}
 179     LOG_MLQUEUE=${_MLQUEUE:-${_ML:-${_ALL:-0}}}
 180     LOG_MLCOMPLETE=${_MLCOMPLETE:-${_ML:-${_ALL:-0}}}
 181     LOG_LLQUEUE=${_LLQUEUE:-${_LL:-${_ALL:-0}}}
 182     LOG_LLCOMPLETE=${_LLCOMPLETE:-${_LL:-${_ALL:-0}}}
 183     LOG_HLQUEUE=${_HLQUEUE:-${_HL:-${_ALL:-0}}}
 184     LOG_HLCOMPLETE=${_HLCOMPLETE:-${_HL:-${_ALL:-0}}}
 185     LOG_IOCTL=${_IOCTL:-${_ALL:-0}}
 186 }
 187
 188 invalid_cmdline()
 189 {
 190         echo "$SCRIPTNAME: $*"
 191         echo "$SCRIPTNAME: Try '$SCRIPTNAME --help' for more information."
 192         exit 1
 193 }
 194
 195 get_logging_level()
 196 {
 197     echo "Current scsi logging level:"
 198     LEVEL=`sysctl -n dev.scsi.logging_level`
 199     if [ $? != 0 ]
 200     then
 201         echo "$SCRIPTNAME: could not read scsi logging level" \
 202              "(kernel probably without SCSI_LOGGING support)"
 203         exit 1
 204     fi
 205 }
 206
 207 show_logging_level()
 208 {
 209     echo "dev.scsi.logging_level = $LEVEL"
 210
 211     LOG_ERROR=$((($LEVEL>>$_ERROR_SHIFT) & 7))
 212     LOG_TIMEOUT=$((($LEVEL>>$_TIMEOUT_SHIFT) & 7))
 213     LOG_SCAN=$((($LEVEL>>$_SCAN_SHIFT) & 7))
 214     LOG_MLQUEUE=$((($LEVEL>>$_MLQUEUE_SHIFT) & 7))
 215     LOG_MLCOMPLETE=$((($LEVEL>>$_MLCOMPLETE_SHIFT) & 7))
 216     LOG_LLQUEUE=$((($LEVEL>>$_LLQUEUE_SHIFT) & 7))
 217     LOG_LLCOMPLETE=$((($LEVEL>>$_LLCOMPLETE_SHIFT) & 7))
 218     LOG_HLQUEUE=$((($LEVEL>>$_HLQUEUE_SHIFT) & 7))
 219     LOG_HLCOMPLETE=$((($LEVEL>>$_HLCOMPLETE_SHIFT) & 7))
 220     LOG_IOCTL=$((($LEVEL>>$_IOCTL_SHIFT) & 7))
 221
 222     echo "SCSI_LOG_ERROR=$LOG_ERROR"
 223     echo "SCSI_LOG_TIMEOUT=$LOG_TIMEOUT"
 224     echo "SCSI_LOG_SCAN=$LOG_SCAN"
 225     echo "SCSI_LOG_MLQUEUE=$LOG_MLQUEUE"
 226     echo "SCSI_LOG_MLCOMPLETE=$LOG_MLCOMPLETE"
 227     echo "SCSI_LOG_LLQUEUE=$LOG_LLQUEUE"
 228     echo "SCSI_LOG_LLCOMPLETE=$LOG_LLCOMPLETE"
 229     echo "SCSI_LOG_HLQUEUE=$LOG_HLQUEUE"
 230     echo "SCSI_LOG_HLCOMPLETE=$LOG_HLCOMPLETE"
 231     echo "SCSI_LOG_IOCTL=$LOG_IOCTL"
 232 }
 233
 234 set_logging_level()
 235 {
 236     echo "New scsi logging level:"
 237     sysctl -q -w dev.scsi.logging_level=$LEVEL
 238     if [ $? != 0 ]
 239     then
 240         echo "$SCRIPTNAME: could not write scsi logging level" \
 241              "(kernel probably without SCSI_LOGGING support)"
 242         exit 1
 243     fi
 244 }
 245 create_logging_level()
 246 {
 247     LEVEL=$((($LOG_ERROR & 7)<<$_ERROR_SHIFT))
 248     LEVEL=$(($LEVEL|(($LOG_TIMEOUT & 7)<<$_TIMEOUT_SHIFT)))
 249     LEVEL=$(($LEVEL|(($LOG_SCAN & 7)<<$_SCAN_SHIFT)))
 250     LEVEL=$(($LEVEL|(($LOG_MLQUEUE & 7)<<$_MLQUEUE_SHIFT)))
 251     LEVEL=$(($LEVEL|(($LOG_MLCOMPLETE & 7)<<$_MLCOMPLETE_SHIFT)))
 252     LEVEL=$(($LEVEL|(($LOG_LLQUEUE & 7)<<$_LLQUEUE_SHIFT)))
 253     LEVEL=$(($LEVEL|(($LOG_LLCOMPLETE & 7)<<$_LLCOMPLETE_SHIFT)))
 254     LEVEL=$(($LEVEL|(($LOG_HLQUEUE & 7)<<$_HLQUEUE_SHIFT)))
 255     LEVEL=$(($LEVEL|(($LOG_HLCOMPLETE & 7)<<$_HLCOMPLETE_SHIFT)))
 256     LEVEL=$(($LEVEL|(($LOG_IOCTL & 7)<<$_IOCTL_SHIFT)))
 257 }
 258
 259 check_cmdline $*
 260
 261 if [ $SET = "1" ]
 262 then
 263     create_logging_level
 264     set_logging_level
 265     show_logging_level
 266 elif [ $GET = "1" ]
 267 then
 268     get_logging_level
 269     show_logging_level
 270 elif [ $CREATE = "1" ]
 271 then
 272     create_logging_level
 273     show_logging_level
 274 else
 275     invalid_cmdline missing option \'-g\', \'-s\' or \'-c\'
 276 fi