bin/foamPrintJobs

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   7 #    \\/     M anipulation  |
   8 #-------------------------------------------------------------------------------
   9 # License
  10 #     This file is part of OpenFOAM.
  11 #
  12 #     OpenFOAM is free software; you can redistribute it and/or modify it
  13 #     under the terms of the GNU General Public License as published by the
  14 #     Free Software Foundation; either version 2 of the License, or (at your
  15 #     option) any later version.
  16 #
  17 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  18 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 #     for more details.
  21 #
  22 #     You should have received a copy of the GNU General Public License
  23 #     along with OpenFOAM; if not, write to the Free Software Foundation,
  24 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  25 #
  26 # Script
  27 #     foamPrintJobs
  28 #
  29 # Description
  30 #     Uses finishedJobs/ and runningJobs/ and stateFile to print job info
  31 #
  32 #------------------------------------------------------------------------------
  33
  34 PROGNAME=`basename $0`
  35 TMPFILE=/tmp/${PROGNAME}$$.tmp
  36 TMPFILE2=/tmp/${PROGNAME}$$.tmp2
  37 JOBSTRING='%4s %8s %20s %10s %8s %4s %12s %12s %20s\n'
  38 DEFSTATEFILE=$HOME/.OpenFOAM/foamCheckJobs.out
  39
  40
  41 #-------------------------------------------------------------------------------
  42 #
  43 # Functions
  44 #
  45 #-------------------------------------------------------------------------------
  46
  47 printUsage() {
  48 cat << LABEL
  49 Usage: $PROGNAME [stateFile]
  50
  51 This program prints a table of all the running and finished jobs.
  52
  53 It is normally used in conjunction with foamCheckJobs which outputs
  54 a "stateFile" containing the actual process status of all jobs.
  55
  56 If stateFile is not supplied the default $DEFSTATEFILE
  57 is used.
  58 LABEL
  59 }
  60
  61
  62 # printJob stat user case machine pid ncpus start end code
  63 printJob() {
  64     printf "$JOBSTRING" "$1" "$2" "$3" "$4" "$5" "$6" "$7" "$8" "$9"
  65 }
  66
  67
  68 # getRawEntry dictionary entry
  69 # Prints value of dictionary entry
  70 getRawEntry() {
  71     grep -v '^//' $1 | grep "^[ \t]*$2 " | sed -e "s/^[ \t]*$2 [ ]*//"
  72 }
  73
  74 # getEntry dictionary entry
  75 # Like getRawEntry but strips " and ending ';'
  76 getEntry() {
  77     getRawEntry $1 $2 | sed -e 's/^"//'  -e 's/;$//' -e 's/"$//'
  78 }
  79
  80
  81 # notEmpty directory
  82 # Returns 0 if directory contains files/directories
  83 notEmpty() {
  84     if [ "`ls $1`" ]; then
  85         return 0
  86     else
  87         return 1
  88     fi
  89 }
  90
  91 # rightStr nChars string
  92 # Prints rightmost nChars of string
  93 rightStr() {
  94     echo "$2" | sed -e "s/.*\(.\{$1\}\)\$/\1/"
  95 }
  96
  97 leftStr() {
  98     echo "$2" | sed -e "s/\(.\{$1\}\).*/\1/"
  99 }
 100
 101 #-------------------------------------------------------------------------------
 102 #
 103 # Main
 104 #
 105 #-------------------------------------------------------------------------------
 106
 107 if [ ! "$FOAM_JOB_DIR" ]; then
 108     echo "$PROGNAME : FOAM_JOB_DIR environment variable not set."
 109     exit 1
 110 fi
 111
 112 if [ ! -d "$FOAM_JOB_DIR" ]; then
 113     echo "$PROGNAME : directory does not exist."
 114     echo "            FOAM_JOB_DIR: $FOAM_JOB_DIR"
 115 fi
 116 if [ ! -d "$FOAM_JOB_DIR/runningJobs" -o ! -d "$FOAM_JOB_DIR/finishedJobs" ]; then
 117     echo "$PROGNAME : invalid directory."
 118     echo "            FOAM_JOB_DIR: $FOAM_JOB_DIR"
 119 fi
 120
 121
 122 if [ $# -eq 1 ]; then
 123     if [ "$1" = '-h' ]; then
 124         printUsage
 125         exit 1
 126     else
 127         STATEFILE=$1
 128     fi
 129 elif [ $# -eq 0 ]; then
 130     STATEFILE=${STATEFILE:-$DEFSTATEFILE}
 131 else
 132     printUsage
 133     exit 1
 134 fi
 135
 136
 137 if [ -f "$STATEFILE" ]; then
 138     echo ""
 139     echo "Using process information from"
 140     echo "  $STATEFILE"
 141     echo "on jobs in"
 142     echo "  $FOAM_JOB_DIR"
 143     echo ""
 144 else
 145     echo ""
 146     echo "Cannot read $STATEFILE."
 147     echo ""
 148     STATEFILE=''
 149 fi
 150
 151
 152 #-- print header
 153 printJob 'stat' 'user' 'case' 'machine' 'pid' 'ncpu' 'start' 'end' 'code'
 154 printJob '----' '----' '----' '-------' '---' '----' '-----' '---' '----'
 155
 156
 157
 158 #-- print submitted
 159
 160
 161 #-- print running
 162 echo "Running:"
 163 if notEmpty $FOAM_JOB_DIR/runningJobs; then
 164     for f in `ls -t $FOAM_JOB_DIR/runningJobs/*`
 165     do
 166         machinePid=`basename $f`
 167
 168         machine=`echo $machinePid | sed -e 's/\..*$//'`
 169         machine=`rightStr 10 "$machine"`
 170
 171         pid=`echo $machinePid | sed -e 's/.*\.\([0-9][0-9]*\)$/\1/'`
 172
 173         if [ "$STATEFILE" ]; then
 174             stat=`getEntry $STATEFILE $machinePid`
 175         fi
 176         stat=${stat:-'UNKN'}
 177
 178         case=`getEntry $f 'case'`
 179         case=${case:-'---'}
 180         case=`echo $case | sed -e 's!/.*!!'`       #strip of processorXXX ending
 181         case=`rightStr 20 "$case"`
 182
 183         start=`getEntry $f 'startDate'`
 184         start=${start:-'---'}
 185         start=`leftStr 12 "$start"`
 186
 187         end='---'
 188
 189         code=`getEntry $f 'code'`
 190         if [ "$code" ]; then
 191             code=`basename $code`
 192         else
 193             code='---'
 194         fi
 195         code=`rightStr 20 "$code"`
 196
 197         nProcs=`getEntry $f 'nProcs'`
 198         nProcs=${nProcs:-'1'}
 199         if [ $nProcs -eq 1 ]; then
 200             nProcs='---'
 201         fi
 202         nProcs=`rightStr 3 "$nProcs"`
 203
 204         user=`getEntry $f 'username'`
 205         user=${user:-'---'}
 206         user=`leftStr 8 "$user"`
 207
 208         printJob "$stat" "$user" "$case" "$machine" "$pid" "$nProcs" "$start" "$end" "$code"
 209     done
 210 fi
 211
 212
 213 #-- print finished
 214 echo ""
 215 echo "Finished:"
 216 if notEmpty $FOAM_JOB_DIR/finishedJobs; then
 217     for f in `ls -t $FOAM_JOB_DIR/finishedJobs/*`
 218     do
 219         machinePid=`basename $f`
 220
 221         machine=`echo $machinePid | sed -e 's/\..*$//'`
 222         machine=`rightStr 10 "$machine"`
 223
 224         pid=`echo $machinePid | sed -e 's/.*\.\([0-9][0-9]*\)$/\1/'`
 225
 226         end=`getEntry $f endDate`
 227         end=${end:-'---'}
 228         end=`leftStr 12 "$end"`
 229
 230         if [ "$STATEFILE" ]; then
 231             stat=`getEntry $STATEFILE $machinePid`
 232         fi
 233         stat=${stat:-'UNKN'}
 234
 235         case=`getEntry $f case`
 236         case=`echo $case | sed -e 's!/.*!!'`       #strip of processorXXX ending
 237         case=${case:-'---'}
 238         case=`rightStr 20 "$case"`
 239
 240         start=`getEntry $f startDate`
 241         start=${start:-'---'}
 242         start=`leftStr 12 "$start"`
 243
 244         code=`getEntry $f code`
 245         if [ "$code" ]; then
 246             code=`basename $code`
 247         else
 248             code='---'
 249         fi
 250         code=`rightStr 20 "$code"`
 251
 252         nProcs=`getEntry $f 'nProcs'`
 253         nProcs=${nProcs:-'1'}
 254         if [ $nProcs -eq 1 ]; then
 255             nProcs='---'
 256         fi
 257         nProcs=`rightStr 3 "$nProcs"`
 258
 259         user=`getEntry $f 'username'`
 260         user=${user:-'---'}
 261         user=`leftStr 8 "$user"`
 262
 263         printJob "$stat" "$user" "$case" "$machine" "$pid" "$nProcs" "$start" "$end" "$code"
 264     done
 265 fi
 266
 267 #------------------------------------------------------------------------------