bin/foamEndJob

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | foam-extend: Open Source CFD
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | For copyright notice see file Copyright
   7 #    \\/     M anipulation  |
   8 #------------------------------------------------------------------------------
   9 # License
  10 #     This file is part of foam-extend.
  11 #
  12 #     foam-extend 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 3 of the License, or (at your
  15 #     option) any later version.
  16 #
  17 #     foam-extend is distributed in the hope that it will be useful, but
  18 #     WITHOUT ANY WARRANTY; without even the implied warranty of
  19 #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 #     General Public License for more details.
  21 #
  22 #     You should have received a copy of the GNU General Public License
  23 #     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25 # Script
  26 #     foamEndJob
  27 #
  28 # Description
  29 #     Ends running job on current machine. Called with root,case,pid.
  30 #     - checks if pid exists
  31 #     - modifies controlDict
  32 #     - waits until
  33 #       - pid disappeared
  34 #       - controlDict modified
  35 #       to restore controlDict
  36 #
  37 #------------------------------------------------------------------------------
  38
  39 PROGNAME=`basename $0`
  40
  41
  42 #------------------------------------------------------------------------------
  43 #
  44 # Functions
  45 #
  46 #------------------------------------------------------------------------------
  47
  48 # getNumberedLine dictionary entry
  49 # Prints dictionary entry line + lineno
  50 getNumberedLine() {
  51     grep -n "^[ \t]*$2[ \t]" $1 | grep -v '^//' | head -1
  52 }
  53
  54 # getLine dictionary entry
  55 # Prints dictionary entry line (without lineno)
  56 getLine() {
  57     getNumberedLine $1 "$2" | sed -e 's/^[^:]*://'
  58 }
  59
  60 # getRawEntry dictionary entry
  61 # Prints value of dictionary entry
  62 getRawEntry() {
  63     getLine $1 "$2" | sed -e "s/^[ \t]*$2[ \t][ \t]*//"
  64 }
  65
  66 # getEntry dictionary entry
  67 # Like getRawEntry but strips " and ending ';'
  68 getEntry() {
  69     getRawEntry $1 "$2" | sed -e 's/^"//'  -e 's/;$//' -e 's/"$//'
  70 }
  71
  72 # getKey entryLine
  73 # Prints first item on line
  74 getKey() {
  75     echo "$1" | sed -e 's/[ \t]*\(.*\)[ \t].*/\1/'
  76 }
  77
  78
  79 # setRawEntry dictionary entry newValue
  80 # Replaces value of entry
  81 setRawEntry() {
  82     oldNumLine=`getNumberedLine $1 "$2"`
  83     lineNo=`echo "$oldNumLine" | sed -e 's/:.*//'`
  84     oldLine=`echo "$oldNumLine" | sed -e 's/^[^:]*://'`
  85     oldKey=`getKey "$oldLine"`
  86     oldVal=`getRawEntry $1 "$2"`
  87     if [ ! "$oldKey" -o ! "$oldVal" -o ! "$oldLine" ]; then
  88         echo "setRawStringEntry: entry $2 not found in $1"
  89         echo "oldKey=$oldKey"
  90         echo "lineNo=$lineNo"
  91         echo "oldLine=$oldLine"
  92         exit 1
  93     fi
  94     #echo "oldKey=$oldKey"
  95     #echo "lineNo=$lineNo"
  96     #echo "oldLine=$oldLine"
  97     #echo "oldVal=$oldVal"
  98     mv $1 ${1}_tmp
  99     sed -e "${lineNo}s/ ${oldVal}/ $3;/" ${1}_tmp > $1
 100     rm -f ${1}_tmp
 101 }
 102
 103
 104
 105 # like getEntry but returns true if boolean is logical true
 106 getBoolEntry()
 107 {
 108     val=`getEntry $1 $2`
 109     case "$val" in
 110       'yes')
 111         return 0
 112         ;;
 113       'no')
 114         return 123
 115         ;;
 116       'true')
 117         return 0
 118         ;;
 119       'false')
 120         return 123
 121         ;;
 122       1)
 123         return 0
 124         ;;
 125       0)
 126         return 123
 127         ;;
 128       *)
 129         echo "$PROGNAME : getBoolEntry : Illegal boolean value $val in dictionary $1"
 130         exit 1
 131         ;;
 132     esac
 133 }
 134
 135 # newerFile file1 file2
 136 newerFile() {
 137     latest=`ls -1 -t $1 $2 2> /dev/null | head -1`
 138     if [ "$latest" = $1 ]; then
 139         return 0
 140     else
 141         return 1
 142     fi
 143 }
 144
 145 # processExists pid
 146 # Returns true if pid exists.
 147 processExists() {
 148     ps -u $LOGNAME -o 'pid' | fgrep $1 >/dev/null
 149 }
 150
 151 printUsage() {
 152 cat << USAGELABEL
 153 Usage: $PROGNAME [-n] <root> <case> <pid>
 154           or
 155        $PROGNAME -c <root> <case>
 156
 157 Tries to end running Foam application at next write or at next time
 158 step (-n option). It needs runTimeModifiable switched on in the
 159 controlDict. It changes stopAt in the controlDict and waits for the job to
 160 finish. Restores original controlDict if
 161     - job has finished
 162     - controlDict gets modified (by user)
 163     - $PROGNAME gets killed.
 164
 165 The -c option clears any outstanding $PROGNAME for the case.
 166
 167 USAGELABEL
 168 }
 169
 170
 171 # Restore controlDict and clean up
 172 restoreDict() {
 173     trap 2 3 15
 174
 175     echo "$PROGNAME : Restoring controlDict from controlDict_bak."
 176     if [ -r ${controlDict}_bak ]; then
 177         cp ${controlDict}_bak $controlDict
 178     fi
 179
 180     rm -f $pidFile
 181
 182     echo "$PROGNAME : Exiting."
 183     exit 0
 184 }
 185
 186
 187 #------------------------------------------------------------------------------
 188 #
 189 # Main
 190 #
 191 #------------------------------------------------------------------------------
 192
 193 ARCH=`uname -s`
 194
 195 #-- Force standards behaving ps
 196 #   Get info on all $USER processes
 197 case $ARCH in
 198   HP-UX*)
 199     UNIX95=a; export UNIX95
 200     ;;
 201   IRIX*)
 202     _XPG=1; export _XPG
 203     ;;
 204 esac
 205
 206
 207 #
 208 # Initial checks
 209 #
 210 if [ $# -lt 3 ]; then
 211     printUsage
 212     exit 1
 213 fi
 214 STOPNOW=''
 215 if [ $1 = '-n' ]; then
 216     STOPNOW='yes'
 217     shift
 218 fi
 219 CLEAR=''
 220 if [ $1 = '-c' ]; then
 221     CLEAR='yes'
 222     shift
 223     if [ $# -ne 2 ]; then
 224         printUsage
 225         exit 1
 226     fi
 227     ROOT=$1
 228     CASE=$2
 229 else
 230     if [ $# -ne 3 ]; then
 231         printUsage
 232         exit 1
 233     fi
 234     ROOT=$1
 235     CASE=$2
 236     PID=$3
 237 fi
 238 CASE=`echo $CASE | sed -e 's!/.*!!'`       #strip of processorXXX ending
 239
 240 #- Pid actually running
 241 if [ ! "$CLEAR" ]; then
 242     processExists $PID
 243     if [ $? -ne 0 ] ;then
 244         echo "$PROGNAME : process $PID not running."
 245         exit 1
 246     fi
 247 fi
 248
 249 #- case directory writeable
 250 if [ ! -w $ROOT/$CASE ]; then
 251     echo "$PROGNAME : $ROOT/$CASE is not writeable."
 252     exit 1
 253 fi
 254
 255 #- Controldict writeable
 256 controlDict=$ROOT/$CASE/system/controlDict
 257 if [ ! -w  $controlDict ]; then
 258     echo "$PROGNAME : $controlDict is not writeable."
 259     exit 1
 260 fi
 261
 262 #- runTimeModifiable
 263 getBoolEntry $controlDict 'runTimeModifiable'
 264 if [ $? -ne 0 ]; then
 265     echo "$PROGNAME : runTimeModifiable not true in dictionary $controlDict."
 266     exit 1
 267 fi
 268
 269 #
 270 #- Check if another foamEndJob running
 271 #
 272 if [ "$CLEAR" ]; then
 273     pidFiles=`ls $ROOT/$CASE/.foamEndJob* 2>/dev/null`
 274     for pidFile in $pidFiles
 275     do
 276         pid=`cat $pidFile`
 277         if [ "$pid" ]; then
 278             echo "$PROGNAME : found $PROGNAME (pid $pid) for Foam process"
 279             echo "  root: $ROOT"
 280             echo "  case: $CASE"
 281             echo "$PROGNAME : Killing $PROGNAME (pid $pid)."
 282             kill $pid
 283             rm -f $pidFile
 284         fi
 285     done
 286     exit 0
 287 fi
 288
 289 pidFile=$ROOT/$CASE/.foamEndJob${PID}
 290 if [ -f $pidFile ]; then
 291     pid=`cat $pidFile`
 292     if [ "$pid" ]; then
 293         processExists $pid
 294         if [ $? -eq 0 ] ;then
 295             echo "$PROGNAME : found running $PROGNAME (pid $pid) for Foam process"
 296             echo "  root: $ROOT"
 297             echo "  case: $CASE"
 298             echo "  pid : $PID"
 299             echo "  lock: $pidFile"
 300             echo "Remove the lock if this is not the case."
 301             exit 1
 302         fi
 303     fi
 304 fi
 305
 306 # Mark with my pid
 307 echo $$ > $pidFile
 308
 309 #
 310 #- Get controlDict entries
 311 #
 312
 313
 314 #- startTime
 315 startTime=`getEntry $controlDict 'startTime'`
 316 if [ ! "$startTime" ]; then
 317     echo "$PROGNAME : startTime not set in dictionary $controlDict."
 318     exit 1
 319 fi
 320
 321 #- Write interval
 322 writeInterval=`getEntry $controlDict 'writeInterval'`
 323 if [ ! "$writeInterval" ]; then
 324     echo "$PROGNAME : writeInterval not set in dictionary $controlDict."
 325     exit 1
 326 fi
 327
 328 #- stopAt
 329 stopAt=`getEntry $controlDict 'stopAt'`
 330 if [ ! "$stopAt" ]; then
 331     echo "$PROGNAME : stopAt not set in dictionary $controlDict."
 332     exit 1
 333 fi
 334
 335 #- endTime
 336 endTime=`getEntry $controlDict 'endTime'`
 337 if [ ! "$endTime" ]; then
 338     echo "$PROGNAME : endTime not set in dictionary $controlDict."
 339     exit 1
 340 fi
 341
 342
 343 echo "$PROGNAME : Read from controlDict:"
 344 echo "  controlDict   : $controlDict"
 345 echo "  writeInterval : $writeInterval"
 346 #echo "  startTime     : $startTime"
 347 echo "  stopAt        : $stopAt"
 348 #echo "  endTime       : $endTime"
 349
 350 echo "$PROGNAME : Making backup of controlDict to controlDict_bak"
 351 cp $controlDict ${controlDict}_bak
 352 #- Set up handler to restore controlDict
 353 trap restoreDict 2 3 15
 354
 355 if [ "$STOPNOW" ]; then
 356     setRawEntry  $controlDict 'stopAt' 'nextWrite'
 357     setRawEntry  $controlDict 'writeInterval' '1'
 358
 359     echo "$PROGNAME : Changed in controlDict:"
 360     echo "    `getLine $controlDict 'stopAt'`"
 361     echo "    `getLine $controlDict 'writeInterval'`"
 362 else
 363     setRawEntry $controlDict 'stopAt' 'nextWrite'
 364
 365     echo "$PROGNAME : Changed in controlDict:"
 366     echo "    `getLine $controlDict 'stopAt'`"
 367 fi
 368
 369
 370
 371 #- Just to make sure time has changed
 372 touch ${controlDict}
 373
 374 sleep 5
 375
 376 #- Give bak a later date
 377 touch ${controlDict}_bak
 378
 379 #- Loop a while to give NFS time to update
 380 if newerFile ${controlDict} ${controlDict}_bak; then
 381     echo "$PROGNAME : controlDict newer than controlDict_bak."
 382     echo "$PROGNAME : Waiting for file dates to get updated."
 383
 384     iter=0
 385     while newerFile ${controlDict} ${controlDict}_bak
 386     do
 387         if [ $iter -ge 120 ]; then
 388             #- 120*5 sec = 10 mins passed. Give up
 389             echo "$PROGNAME : File date not yet ok after 10 mins. Giving up."
 390             break
 391         fi
 392         #- Give _bak a later time
 393         touch ${controlDict}_bak
 394
 395         #- Give nfs some time to update time on controlDict.
 396         sleep 5
 397
 398         iter=`expr $iter + 1`
 399     done
 400 fi
 401
 402 #
 403 #- Start waiting until:
 404 #  - pid finished. Restore controlDict.
 405 #  - controlDict modified. No restore.
 406 #  - controlDict_bak removed. No restore.
 407
 408 echo "$PROGNAME : Waiting for Foam job $PID to finish ..."
 409
 410 while true
 411 do
 412     sleep 5
 413
 414     if [ ! -r ${controlDict}_bak ]; then
 415         echo "$PROGNAME : ${controlDict}_bak dissappeared. Exiting without restore."
 416         exit 1
 417     fi
 418
 419     if newerFile ${controlDict} ${controlDict}_bak; then
 420         echo "$PROGNAME : ${controlDict} modified externally. Exiting without restore."
 421         exit 0
 422     fi
 423
 424     processExists $PID
 425     if [ $? -ne 0 ] ;then
 426         #- Job finished
 427         break
 428     fi
 429     #echo "Foam job $PID still running ..."
 430 done
 431
 432 #- Dictionary restore
 433 restoreDict
 434
 435 #------------------------------------------------------------------------------