source: trunk/libIGCM/libIGCM_debug/libIGCM_debug.ksh @ 1204

Last change on this file since 1204 was 1204, checked in by sdipsl, 9 years ago
  • Property licence set to
    The following licence information concerns ONLY the libIGCM tools
    ==================================================================

    Copyright © Centre National de la Recherche Scientifique CNRS
    Commissariat à l'Énergie Atomique CEA

    libIGCM : Library for Portable Models Computation of IGCM Group.

    IGCM Group is the french IPSL Global Climate Model Group.

    This library is a set of shell scripts and functions whose purpose is
    the management of the initialization, the launch, the transfer of
    output files, the post-processing and the monitoring of datas produce
    by any numerical program on any plateforme.

    This software is governed by the CeCILL license under French law and
    abiding by the rules of distribution of free software. You can use,
    modify and/ or redistribute the software under the terms of the CeCILL
    license as circulated by CEA, CNRS and INRIA at the following URL
    "http://www.cecill.info".

    As a counterpart to the access to the source code and rights to copy,
    modify and redistribute granted by the license, users are provided only
    with a limited warranty and the software's author, the holder of the
    economic rights, and the successive licensors have only limited
    liability.

    In this respect, the user's attention is drawn to the risks associated
    with loading, using, modifying and/or developing or reproducing the
    software by the user in light of its specific status of free software,
    that may mean that it is complicated to manipulate, and that also
    therefore means that it is reserved for developers and experienced
    professionals having in-depth computer knowledge. Users are therefore
    encouraged to load and test the software's suitability as regards their
    requirements in conditions enabling the security of their systems and/or
    data to be ensured and, more generally, to use and operate it in the
    same conditions as regards security.

    The fact that you are presently reading this means that you have had
    knowledge of the CeCILL license and that you accept its terms.
  • Property svn:keywords set to Revision Author Date
File size: 34.2 KB
Line 
1#!/bin/ksh
2
3#**************************************************************
4# Author: Patrick Brockmann, Martial Mancip
5# Contact: Patrick.Brockmann__at__cea.fr Martial.Mancip__at__ipsl.jussieu.fr
6# $Revision::                                          $ Revision of last commit
7# $Author::                                            $ Author of last commit
8# $Date::                                              $ Date of last commit
9# IPSL (2006)
10#  This software is governed by the CeCILL licence see libIGCM/libIGCM_CeCILL.LIC
11#
12#**************************************************************
13
14#==================================================
15# The documentation of this file can be automatically generated
16# if you use the prefix #D- for comments to be extracted.
17# Extract with command: cat lib* | grep "^#D-" | cut -c "4-"
18#==================================================
19
20#==================================================
21# Add high level verbosity
22typeset -i Verbosity=${Verbosity:=3}
23
24#==================================================
25# DEBUG_debug
26# Add low level verbosity
27DEBUG_debug=${DEBUG_debug:=false}
28
29#==================================================
30# GENERATE RANDOM ERROR ; only apply if ( ${DEBUG_debug} )
31typeset RandomError=false
32
33#==================================================
34# NULL_STR
35# Default null string
36typeset -r NULL_STR="_0_"
37
38#==================================================
39# libIGCM_CurrentTag
40# Current libIGCM tag, check compatibilty with *.card
41typeset -r libIGCM_CurrentTag="1.0"
42
43#==================================================
44# Exit Flag (internal debug)
45# When true, end the master loop AFTER SAVES FILES
46ExitFlag=false
47
48#==================================================
49# Declare a stack of functions calls
50unset IGCM_debug_Stack
51unset IGCM_debug_StackArgs
52unset IGCM_debug_StackTiming
53IGCM_debug_Stack[0]=${NULL_STR}
54IGCM_debug_StackArgs[0]=${NULL_STR}
55IGCM_debug_StackTiming[0]=${NULL_STR}
56IGCM_debug_LenStack=0
57
58#D-#==================================================================
59#D-function IGCM_debug_getDate_ms
60#D- * Purpose: Give number of milliseconds since 01-jan-1970
61function IGCM_debug_getDate_ms
62{
63  typeset nanosecs ms
64  # nano secondes since 01-jan-1970
65  nanosecs=$( date +%s%N )
66
67  # truncate the last 6 digits to get milliseconds since 01-jan-1970
68  ms=${nanosecs:0:${#nanosecs}-6}
69
70  echo "$ms"
71}
72
73#D-#==================================================================
74#D-function IGCM_debug_sizeOfTabContent
75#D- * Purpose: Give sumed size of a list of files
76#D- * Usage: IGCM_debug_sizeOfTabContent entityList destination
77#D- *        where entityList is a list of files or directory
78#D- *        where dest is either a directory or a file name
79function IGCM_debug_sizeOfTabContent
80{
81  typeset entityListe destination iEntity sizeKo sumSizeKo sumSizeMo
82
83  eval set +A entityListe \${${1}}
84  destination=${2}
85  sumSizeKo=0
86
87  # Here we will try to compute size (file or directory size) from local path and not from archive.
88  for ((i = 0; i < ${#entityListe[*]}; i += 1)) ; do
89    if [ -f ${entityListe[$i]} ] ; then
90      # One file or a bunch of files has been copied without renaming from a visible filesystem
91      iEntity=${entityListe[$i]}
92    elif [ -f ${entityListe[$i]##/*/} ] ; then
93      # One file or a bunch of files has been copied without renaming from an non visible filesystem
94      # remove path /home/login/../ from entityListe elements
95      iEntity=${entityListe[$i]##/*/}
96    elif [ -f ${destination} ] ; then
97      # a file has been copied and renamed
98      iEntity=${destination}
99    elif [ -f ${destination}/${entityListe[$i]##/*/} ] ; then
100      # a copy in a directory but not in ${PWD}
101      iEntity=${destination}/${entityListe[$i]##/*/}
102    elif [ -d ${entityListe[$i]} ] ; then
103      # a directory has been copied from a non remote place
104      iEntity=${entityListe[$i]}
105    elif [ -d ${destination}/${entityListe[$i]##/*/} ] ; then
106      # a directory has been copied from a remote archive and not renamed
107      iEntity=${destination}/${entityListe[$i]##/*/}
108    elif [ -d ${destination} ] ; then
109      # a directory has been copied from a remote archive and renamed
110      iEntity=${destination}
111    fi
112    sizeKo=$( du --apparent-size -skL ${iEntity} | gawk '{print $1}' )
113    sumSizeKo=$(( $sumSizeKo + $sizeKo ))
114  done
115  sumSizeMo=$( echo "scale=6;${sumSizeKo}/1024" | bc )
116  echo "${sumSizeKo}|${sumSizeMo}"
117}
118
119#D-#==================================================================
120#D-function IGCM_debug_send_AMQP_msg__MAILTUNNEL
121#D- * Purpose: Take over AMQP C client using mail as a message recipient
122#D- * One argument : base64 encoded message
123#D- * Attach encoded config.card when starting the simulation
124
125function IGCM_debug_send_AMQP_msg__MAILTUNNEL {
126
127  typeset b64_encoded_msg mail_recipient
128  typeset buffer send_messages mail_frequency
129  typeset last_mail_date__file
130
131  b64_encoded_msg=$1
132
133  mail_recipient="superviseur@ipsl.jussieu.fr"
134  send_messages=0
135  mail_frequency=3600 # in seconds
136  # use to keep track when was last mail sent (maybe to be replaced with global variable)
137  last_mail_date__file=${R_BUF}/.stamp.${config_UserChoices_TagName}.${config_UserChoices_JobName}
138  # use to accumulate messages before sending them
139  buffer=${R_BUF}/.buffer.${config_UserChoices_TagName}.${config_UserChoices_JobName}
140
141  # init
142  if [ ! -f "${buffer}" ]; then
143    touch ${buffer}
144  fi
145
146  if [ ! -f "${last_mail_date__file}" ]; then
147    touch ${last_mail_date__file}
148  else
149    # compute last time the file was changed (in seconds)
150    seconds_since_last_mail=$(( $(date +%s) - $(stat -c %Y ${last_mail_date__file}) ))
151    # send message when exceeding threshold
152    [ ${seconds_since_last_mail} -gt ${mail_frequency} ] && send_messages=1
153  fi
154
155  # queue messages in the buffer
156  echo ${b64_encoded_msg} >> ${buffer}
157
158  # send mail
159
160  if [ X${initBigBro} = Xtrue ] ; then
161    #echo $(date +"%Y-%m-%dT%H:%M:%S.%N%z") > ${SUBMIT_DIR}/mail.txt
162    mailx -s "[TEMPORARY AMQP CHANNEL]" -a ${SUBMIT_DIR}/config.card.base64 ${mail_recipient} < ${buffer} # send buffer
163    rm -f $buffer ; touch ${buffer}                                    # clear buffer
164    touch ${last_mail_date__file}                                      # memorize last mail date
165    initBigBro=false
166  elif [ ${send_messages} -eq 1 ] ; then
167    #echo $(date +"%Y-%m-%dT%H:%M:%S.%N%z") >> ${SUBMIT_DIR}/mail.txt
168    mailx -s "[TEMPORARY AMQP CHANNEL]" ${mail_recipient}  < ${buffer} # send buffer
169    rm -f ${buffer} ; touch ${buffer}                                  # flush the buffer
170    touch ${last_mail_date__file}                                      # memorize last mail date
171  fi
172
173  if ( ${FlushAMQP} ) ; then
174    mailx -s "[TEMPORARY AMQP CHANNEL]" ${mail_recipient}  < ${buffer} # send buffer
175    rm -f ${buffer}                                                    # cleaning behind us
176    rm -f ${last_mail_date__file}                                      # cleaning behind us
177  fi
178
179  # Allways all good for now.
180  return 0
181}
182
183#D-#==================================================================
184#D-function IGCM_debug_sendAMQP_Metrics
185#D- * Purpose: Take over AMQP C client using mail as a message recipient
186#D- * Two arguments : - Directory where metrics.json files can be found
187#D- *                 - Metrics Group Name. metrics will be added to this group
188#D- * Attach encoded metrics.json files.
189
190function IGCM_debug_sendAMQP_Metrics {
191
192  typeset mail_recipient encodedBody
193  if [ X${ActivateBigBro} = Xtrue ] ; then
194    mail_recipient="superviseur@ipsl.jussieu.fr"
195    # Metrics tag on server side
196    code=7100
197    # Usual AMQP message to route messages on server side
198    encodedBody=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"metricsGroupName\":\"${2}\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" |  base64 -w 0 )
199    # send mail
200    attachmentsOptions=""
201    for metricsFile in $( ls $1/*json ) ; do
202      attachmentsOptions="-a ${metricsFile} ${attachmentsOptions}"
203    done
204    IGCM_debug_Print 2 "IGCM_debug_sendAMQP_Metrics "
205    echo ${encodedBody}|mailx -s "[TEMPORARY AMQP CHANNEL]" ${attachmentsOptions} ${mail_recipient}
206  fi
207
208  # Allways all good for now.
209  return 0
210}
211
212#D-#==================================================================
213#D-function IGCM_debug_SendAMQP
214#D- * Purpose: Send body; encoded body and config.card to rabbitMQ
215function IGCM_debug_sendAMQP {
216
217  typeset decal first additionnalOption encodedBody
218
219  # Encode message Body
220  encodedBody=$( echo "${Body}" | base64 -w 0 )
221
222  # Send config.card ?
223  if [ X${1} = Xactivate ] ; then
224    # Encode config.card
225    cat ${SUBMIT_DIR}/config.card | base64 -w 0 > ${SUBMIT_DIR}/config.card.base64
226    # Prepare additionnal option
227    additionnalOption="-f ${SUBMIT_DIR}/config.card.base64"
228    #
229    initBigBro=true
230  else
231    additionnalOption=
232    #
233    initBigBro=false
234  fi
235
236  # Only cosmetics : stack file
237  if [ X${ActivateStackFilling} = Xtrue ] ; then
238    decal=0
239    while [ ${decal} -lt ${IGCM_debug_LenStack} ]; do
240      printf ' ' >> ${StackFileLocation}/${StackFileName}
241      (( decal = decal + 1 ))
242    done
243    # Log to stack file using human readable format
244    echo "${Body}" >> ${StackFileLocation}/${StackFileName}
245  fi
246
247  # Log separately encoded AMQP message command for reuse in a mock up
248  #echo sendAMQPMsg -h localhost -p 5672 ${additionnalOption} -b ${encodedBody} >> ${RUN_DIR_PATH}/send.AMQP.${config_UserChoices_JobName}.${config_UserChoices_ExperimentName}.${config_UserChoices_SpaceName}.${config_UserChoices_TagName}.${CumulPeriod}.history.txt
249
250  # Send the message
251  if [ X${BigBrotherChannel} = XMAIL ] ; then
252    IGCM_debug_send_AMQP_msg__MAILTUNNEL "${encodedBody}"
253    status=$?
254  else
255    sendAMQPMsg -h localhost -p 5672 ${additionnalOption} -b ${encodedBody}
256    status=$?
257  fi
258
259  if [ ${status} -gt 0 ] ; then
260    IGCM_debug_Print 2 "IGCM_debug_Push/PopStack/ActivateBigBro : command sendAMQPMsg failed error code ${status}"
261    echo sendAMQPMsg -h localhost -p 5672 -b "${Body}"
262    exit 1
263  fi
264}
265
266#D-#==================================================================
267#D-function IGCM_debug_CallStack
268#D-* Purpose: Print the call stack tree from the oldest to the youngest (opposite of the display standard)
269#D-
270function IGCM_debug_CallStack {
271  if ( $DEBUG_debug ) ; then
272    # Cosmetics
273    typeset i decal
274    i=0
275    until [ $i -eq ${IGCM_debug_LenStack} ]; do
276      decal=0
277      until [ $decal -eq ${i} ]; do
278        printf -- ' '
279        (( decal = decal + 1 ))
280      done
281      echo "$i - ${IGCM_debug_Stack[$(( $IGCM_debug_LenStack-$i-1 ))]}" "(${IGCM_debug_StackArgs[$(( $IGCM_debug_LenStack-$i-1 ))]})"
282      ((i = i + 1))
283    done
284  fi
285}
286
287#D-#==================================================================
288#D-function IGCM_debug_PushStack
289#D-* Purpose: Push a function name in the stack
290#D-
291function IGCM_debug_PushStack {
292  if ( $DEBUG_debug ) ; then
293    typeset decal inputs startTime_ms
294
295    # Only cosmetics : stack file
296    if [ X${ActivateStackFilling} = Xtrue ] ; then
297      echo >> ${StackFileLocation}/${StackFileName}
298      decal=0
299      while [ ${decal} -lt ${IGCM_debug_LenStack} ]; do
300        printf ' ' >> ${StackFileLocation}/${StackFileName}
301        (( decal = decal + 1 ))
302      done
303
304      # Fill the stack file
305      echo "> ${IGCM_debug_LenStack} : ${@}" >> ${StackFileLocation}/${StackFileName}
306    fi
307
308    # Save input list in an indexed array
309    INPUTS=( $@ )
310
311    # Get timing information
312    startTime_ms=$( IGCM_debug_getDate_ms )
313
314    # We add function call name on beginning of the stack
315    set +A IGCM_debug_Stack -- ${1} ${IGCM_debug_Stack[*]}
316
317    # Save timing in milliseconds in an indexed array
318    set +A IGCM_debug_StackTiming -- ${startTime_ms} ${IGCM_debug_StackTiming[*]}
319
320    # We include the "null" Args in the beginning of the StackArgs
321    set +A IGCM_debug_StackArgs ${NULL_STR} ${IGCM_debug_StackArgs[*]}
322
323    # Then, we shift StackArgs tabular
324    # Replacing blank separated list by comma separated list of quoted elements (except the first and last element)
325    if [ $# -gt 1 ]; then
326      IGCM_debug_StackArgs[0]=$(echo ${INPUTS[*]:1} | sed -e "s/\ /\",\"/g" )
327    fi
328
329    # Unplugged message 4000 handling for now. To ease downstream treatment.
330    #if [ X${ActivateBigBro} = Xtrue ] ; then
331    #  # RabbitMQ message code "PUSHSTACK"
332    #  code=4000
333    #  # RabbitMQ message body
334    #  Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"nesting\":\"${IGCM_debug_LenStack}\",\"command\":\"${IGCM_debug_Stack[0]}\",\"arguments\":[\"${IGCM_debug_StackArgs[0]}\"],\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
335    #  # Fill the rabbitMQ queue
336    #  IGCM_debug_sendAMQP
337    #fi
338
339    # Increment LenStack
340    (( IGCM_debug_LenStack = IGCM_debug_LenStack + 1 ))
341
342    #IGCM_debug_CallStack
343  fi
344}
345
346#D-#==================================================================
347#D-function IGCM_debug_PopStack
348#D-* Purpose: Pop a function name in the stack
349#D-
350function IGCM_debug_PopStack {
351  if ( $DEBUG_debug ) ; then
352    typeset i decal command arguments startTime_ms endTime_ms
353    typeset instrumentation dest prefix
354    # they are not typeset because they are send "by adress" to son functions
355    # we unset them to avoid "memory effect"
356    unset fileList source
357
358    # INTRODUCE SIMPLE ERROR GENERATOR TO TEST SUPERVISOR
359    # PROBABILITY ERROR IS 0.0001 PER COMMAND OR FUNCTION CALL
360    # THERE ARE ~500 COMMAND OR FUNCTION CALL PER PERIOD
361    if ( ${RandomError} ) ; then
362      if [ $((RANDOM%10000)) -le 10 ] ; then
363        IGCM_debug_Print 1 "Random error has been triggered"
364        if [ X${ActivateStackFilling} = Xtrue ] ; then
365          echo "RANDOM ERROR" >> ${StackFileLocation}/${StackFileName}
366        fi
367        ExitFlag=true
368      fi
369    fi
370
371    if [ "${IGCM_debug_Stack[0]}" = "${1}" ]; then
372      # Everything is cool
373
374      # Get timing information
375      endTime_ms=$( IGCM_debug_getDate_ms )
376
377      # Save Stack information before poping the stack
378      command=${IGCM_debug_Stack[0]}
379
380      # Go from comma separated list of quoted elements (except the first and the last element)
381      # to unquoted space separated elements in an array
382      set -A arguments -- $( echo ${IGCM_debug_StackArgs[0]} | sed -e "s/\",\"/\ /g" )
383
384      # Save Stack information before poping the stack
385      startTime_ms=${IGCM_debug_StackTiming[0]}
386
387      # Pop the stack
388      (( IGCM_debug_LenStack = IGCM_debug_LenStack - 1 ))
389      set -A IGCM_debug_Stack -- ${IGCM_debug_Stack[*]:1}
390      set -A IGCM_debug_StackArgs -- ${IGCM_debug_StackArgs[*]:1}
391      set -A IGCM_debug_StackTiming -- ${IGCM_debug_StackTiming[*]:1}
392    else
393      echo 'IGCM_debug_Exit : stack is corrupted ! LenStack =' ${IGCM_debug_LenStack}
394      IGCM_debug_Exit $@
395    fi
396
397    # Special actions depending on command to prepare IGCM_debug_PrintInfosActions call
398    # We are interested in:
399    #  0. Which command performs the work
400    #  1. Size of entity we are working with
401    #  2. Where are we reading
402    #  3. Where are we writing
403    #  4. How long it took
404
405    instrumentation=false
406
407    case ${command} in
408    # Classical copy (only files are given to IGCM_sys_Cp as options)
409    IGCM_sys_Cp)
410      instrumentation=true
411      # All but the latest
412      fileList=${arguments[*]:0:${#arguments[*]}-1}
413      # just need the first file to get the directory
414      source=${arguments[0]}
415      # Nothing but the latest
416      dest=${arguments[${#arguments[*]}-1]}
417      # Size of file whose name are stored in a list
418      entitySize=$( IGCM_debug_sizeOfTabContent fileList ${dest} )
419      ;;
420
421    # Copy from archive machine or from buffer
422    IGCM_sys_Get|IGCM_sys_GetBuffer)
423      instrumentation=true
424      if [ ${#arguments[*]} -eq 2 ] ; then
425        source=${arguments[0]}
426        dest=${arguments[1]}
427        # Size of file whose name are stored in a variable
428        entitySize=$( IGCM_debug_sizeOfTabContent source ${dest} )
429      elif ( [ ${#arguments[*]} -eq 3 ] && [ ${arguments[0]} = '/l' ] ) ; then
430        # IGCM_sys_Get /l liste_file[*] /ccc/scratch/cont003/dsm/p86denv/RUN_DIR/985998_14754/
431        # Keep the array name hosting the all list
432        eval set +A fileList \${${arguments[1]}}
433        # just need the first file to get the directory
434        source=${fileList[0]}
435        dest=${arguments[2]}
436        # Size of file whose name are stored in a list
437        entitySize=$( IGCM_debug_sizeOfTabContent fileList[*] ${dest} )
438      elif [ [ ${#arguments[*]} -ge 3 ] ; then
439       # All but the latest
440        fileList=${arguments[*]:0:${#arguments[*]}-1}
441        # just need the first file to get the directory
442        source=${arguments[0]}
443        # Nothing but the latest
444        dest=${arguments[${#arguments[*]}-1]}
445        # Size of file whose name are stored in a list
446        entitySize=$( IGCM_debug_sizeOfTabContent fileList ${dest} )
447      fi
448      ;;
449
450    # Copy from compute node or copy to archive/buffer
451    IGCM_sys_Get_Master|IGCM_sys_Get_Dir|IGCM_sys_Put_Out|IGCM_sys_PutBuffer_Out)
452      instrumentation=true
453      source=${arguments[0]}
454      dest=${arguments[1]}
455      # Size of file whose name are stored in a variable
456      entitySize=$( IGCM_debug_sizeOfTabContent source ${dest} )
457      ;;
458
459    # Rebuild command
460    IGCM_sys_rebuild|IGCM_sys_rebuild_station)
461      instrumentation=true
462      # All but the first
463      fileList=${arguments[*]:1:${#arguments[*]}-1}
464      # just need a file to get the directory
465      source=${arguments[1]}
466      # Nothing but the first
467      dest=${arguments[0]}
468      # Size of file whose name are stored in a list
469      entitySize=$( IGCM_debug_sizeOfTabContent fileList ${dest} )
470      ;;
471
472    # NCO commands
473    IGCM_sys_ncrcat|IGCM_sys_ncecat|IGCM_sys_ncra|IGCM_sys_ncks|IGCM_sys_cdo)
474      # Example of what we want to catch : only filenames in those command lines
475      # IGCM_sys_ncrcat -O -v ${list_var_final_ncrcat} ${OUT_SE[*]} ${RESULT_SE}
476      # IGCM_sys_ncrcat --hst -v ${liste_coord}${var} ${file1} ${liste_file_tmp[*]} ${file_out}
477      # IGCM_sys_ncrcat -p ${dir} ${liste_file_tmp} --output ${output}
478      # IGCM_sys_ncrcat -x -v ${list_var} -p ${dir} ${liste_file_tmp} --output ${output}
479      instrumentation=true
480      keepGoing=true
481      prefix=.
482      i=0
483      while ( ${keepGoing} ) ; do
484        # the last one is not interesting
485        if [ ${i} -eq ${#arguments[*]}-1 ] ; then
486          keepGoing=false
487        # look after "-p" option. Path prefix is the following arguments
488        elif [ ${arguments[${i}]} = "-p" ] ; then
489          ((i = i + 1))
490          prefix=${arguments[${i}]}
491          ((i = i + 1))
492        elif [ ${i} -eq ${#arguments[*]}-1 ] ; then
493          keepGoing=false
494        # looking for files
495        elif [ -f ${prefix}/${arguments[${i}]} ] ; then
496          fileList="${fileList} ${prefix}/${arguments[${i}]}"
497          ((i = i + 1))
498        # other options are not interesting
499        else
500          ((i = i + 1))
501        fi
502      done
503
504      # i value is at least 1
505      # just need one file to get the directory
506      source=$( echo ${fileList} | gawk '{print $1}' )
507      # Nothing but the latest
508      dest=${arguments[${#arguments[*]}-1]}
509      # Size of file whose name are stored in a list
510      entitySize=$( IGCM_debug_sizeOfTabContent fileList ${dest} )
511      ;;
512    esac
513
514    # Print information related to instrumentation
515    ( ${instrumentation} ) && IGCM_debug_PrintInfosActions ${command} ${entitySize} ${startTime_ms} ${endTime_ms} ${dest} ${source}
516
517    # Only cosmetics : stack file
518    if [ X${ActivateStackFilling} = Xtrue ] ; then
519      decal=0
520      while [ ${decal} -lt ${IGCM_debug_LenStack} ]; do
521        printf ' ' >> ${StackFileLocation}/${StackFileName}
522        (( decal = decal + 1 ))
523      done
524    fi
525
526    if ( ${ExitFlag} ) ; then
527      # Inform the stack file
528      if [ X${ActivateStackFilling} = Xtrue ] ; then
529        echo '!!! ExitFlag has been activated !!!' >> ${StackFileLocation}/${StackFileName}
530      fi
531
532      if [ X${ActivateBigBro} = Xtrue ] ; then
533        # RabbitMQ message code "ERROR HAS BEEN TRIGGERED"
534        code=4900
535        # RabbitMQ message body
536        Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"nesting\":\"${IGCM_debug_LenStack}\",\"command\":\"${command}\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
537        # Fill the rabbitMQ queue
538        IGCM_debug_sendAMQP
539      fi
540    else
541      # Inform the stack file
542      if [ X${ActivateStackFilling} = Xtrue ] ; then
543        echo "< ${IGCM_debug_LenStack} : ${@}" >> ${StackFileLocation}/${StackFileName}
544      fi
545
546      # Unplugged message 4100 handling for now. To ease downstream treatment.
547      #if [ X${ActivateBigBro} = Xtrue ] ; then
548      #  # RabbitMQ message code "POPSTACK"
549      #  code=4100
550      #  # RabbitMQ message body
551      #  Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"nesting\":\"${IGCM_debug_LenStack}\",\"command\":\"${command}\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
552      #  # Fill the rabbitMQ queue
553      #  IGCM_debug_sendAMQP
554      #fi
555    fi
556
557    # Reset array if necessary
558    if [ ${IGCM_debug_LenStack} = 0 ]; then
559      #echo
560      #IGCM_debug_Print 3 "Clean stack array"
561      #echo
562      unset IGCM_debug_Stack
563      unset IGCM_debug_StackArgs
564      unset IGCM_debug_StackTiming
565      IGCM_debug_Stack[0]=${NULL_STR}
566      IGCM_debug_StackArgs[0]=${NULL_STR}
567      IGCM_debug_StackTiming[0]=${NULL_STR}
568    fi
569  fi
570  #IGCM_debug_CallStack
571}
572
573#D-#==================================================================
574#D-function IGCM_debug_BigBro_Initialize
575#D-* Purpose: switch rabbitMQ on
576#D-
577function IGCM_debug_BigBro_Initialize {
578  IGCM_debug_PushStack "IGCM_debug_BigBro_Initialize"
579
580# Message type standard fields:
581# https://github.com/Prodiguer/prodiguer-docs/wiki/MQ-Standard-Message-Fields
582
583# Message type dictionnary and custom fields:
584# https://github.com/Prodiguer/prodiguer-docs/wiki/Monitoring-Message-Dictionary
585
586  if [ X${BigBrother} = Xtrue ] ; then
587    # create a unique ID for this specific job
588    jobuid=$(uuidgen)
589
590    if [ X${TaskType} = Xcomputing ]; then
591      if ( ${FirstInitialize} ) ; then
592        # RabbitMQ message code "BEGIN A SIMULATION"
593        code=0000
594        # create and persist a unique id for this simulation
595        simuid=$(uuidgen)
596        IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration simuid ${simuid}
597        # Standard fields for the first message
598        genericSimulationID=$( echo "\"msgApplication\":\"monitoring\",\"msgProducer\":\"libigcm\",\"activity\":\"IPSL\",\"name\":\"${config_UserChoices_JobName}\",\"cumulPeriod\":\"${CumulPeriod}\",\"experiment\":\"${config_UserChoices_ExperimentName}\",\"space\":\"${config_UserChoices_SpaceName}\",\"model\":\"${config_UserChoices_TagName}\",\"startDate\":\"${config_UserChoices_DateBegin}\",\"endDate\":\"${config_UserChoices_DateEnd}\",\"login\":\"${LOGIN}\",\"centre\":\"${CENTER}\",\"machine\":\"${MASTER}\",\"simuid\":\"${simuid}\",\"jobuid\":\"${jobuid}\"" )
599        # RabbitMQ message body with specific fields associated message codes treated here
600        Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"accountingProject\":\"${PROJECT}\",\"jobWarningDelay\":\"${jobWarningDelay}\",\"msgUID\":\"$(uuidgen)\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
601        # Fill the rabbitMQ queue (the config.card in use will be sent)
602        IGCM_debug_sendAMQP activate
603      else
604        # RabbitMQ message code "A NEW COMPUTING JOB IS RUNNING PART OF A SIMULATION"
605        code=1000
606        # retrieve this simulation's unique id
607        IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration simuid
608        simuid=${run_Configuration_simuid}
609        # Using standard fields for message others than the first one. Still subject to change
610        genericSimulationID=$( echo "\"msgApplication\":\"monitoring\",\"msgProducer\":\"libigcm\",\"cumulPeriod\":\"${CumulPeriod}\",\"simuid\":\"${simuid}\",\"jobuid\":\"${jobuid}\"" )
611        # RabbitMQ message body with specific fields associated message codes treated here
612        Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"accountingProject\":\"${PROJECT}\",\"jobWarningDelay\":\"${jobWarningDelay}\",\"msgUID\":\"$(uuidgen)\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
613        # Fill the rabbitMQ queue
614        IGCM_debug_sendAMQP
615      fi
616
617      # NOT VERY NICE BUT ... IT WORKS
618      # Be sure that the genericSimulationID will be small from now on
619      # Using standard fields for messages others than the first one. Still subject to change
620      genericSimulationID=$( echo "\"msgApplication\":\"monitoring\",\"msgProducer\":\"libigcm\",\"cumulPeriod\":\"${CumulPeriod}\",\"simuid\":\"${simuid}\",\"jobuid\":\"${jobuid}\"" )
621
622    elif [ X${TaskType} = Xpost-processing ]; then
623      # RabbitMQ message code "A NEW POST-PROCESSING JOB IS RUNNING PART OF A SIMULATION"
624      code=2000
625      # retrieve this simulation's unique id
626      IGCM_card_DefineVariableFromOption ${SUBMIT_DIR}/run.card Configuration simuid
627      simuid=${run_Configuration_simuid}
628      # Using standard fields for message others than the first one. Still subject to change
629      genericSimulationID=$( echo "\"msgApplication\":\"monitoring\",\"msgProducer\":\"libigcm\",\"cumulPeriod\":\"${CumulPeriod}\",\"simuid\":\"${simuid}\",\"jobuid\":\"${jobuid}\"" )
630      # RabbitMQ message body with specific fields associated message codes treated here
631      Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"accountingProject\":\"${PROJECT}\",\"jobWarningDelay\":\"${jobWarningDelay}\",\"msgUID\":\"$(uuidgen)\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
632      # Fill the rabbitMQ queue
633      IGCM_debug_sendAMQP
634    fi
635    # Turn the flag on
636    ActivateBigBro=true
637    # Dont flush by default
638    FlushAMQP=false
639  fi
640  IGCM_debug_PopStack "IGCM_debug_BigBro_Initialize"
641}
642
643#D-#==================================================================
644#D-function IGCM_debug_BigBro_Finalize
645#D-* Purpose: Finalize rabbitMQ messages exchanges
646#D-
647function IGCM_debug_BigBro_Finalize {
648  IGCM_debug_PushStack "IGCM_debug_BigBro_Finalize"
649
650  # Message type standard fields:
651  # https://github.com/Prodiguer/prodiguer-docs/wiki/MQ-Standard-Message-Fields
652
653  # Message type dictionnary and custom fields:
654  # https://github.com/Prodiguer/prodiguer-docs/wiki/Monitoring-Message-Dictionary
655
656  if ( $DEBUG_debug ) ; then
657    if [ X${ActivateBigBro} = Xtrue ] ; then
658      if [ X${TaskType} = Xcomputing ]; then
659        if ( ${simulationIsOver} ) ; then
660          # RabbitMQ message code "SIMULATION ENDS"
661          code=0100
662          FlushAMQP=true
663        else
664          # RabbitMQ message code "COMPUTING JOB ENDS"
665          code=1100
666        fi
667      elif [ X${TaskType} = Xpost-processing ]; then
668        # RabbitMQ message code "POST-PROCESSING JOB ENDS"
669        code=2100
670        FlushAMQP=true
671      fi
672      # RabbitMQ message body
673      Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
674      # Fill the rabbitMQ queue
675      IGCM_debug_sendAMQP
676    fi
677  fi
678 
679  IGCM_debug_PopStack "IGCM_debug_BigBro_Finalize"
680}
681
682#D-#==================================================================
683#D-function IGCM_debug_Exit
684#D-* Purpose: Print Call Stack and set ExitFlag to true
685#D-
686function IGCM_debug_Exit {
687  IGCM_debug_PushStack "IGCM_debug_Exit"
688  echo "IGCM_debug_Exit : " "${@}"
689  echo
690  echo "!!!!!!!!!!!!!!!!!!!!!!!!!!"
691  echo "!!   ERROR TRIGGERED    !!"
692  echo "!!   EXIT FLAG SET      !!"
693  echo "!------------------------!"
694  echo
695  IGCM_debug_CallStack
696  ExitFlag=true
697  IGCM_debug_PopStack "IGCM_debug_Exit"
698}
699
700#D-#==================================================
701#D-function IGCM_debug_Verif_Exit
702#D-* Purpose: exit with number 1 if ExitFlag is true
703#D-
704function IGCM_debug_Verif_Exit {
705  if ( ${ExitFlag} ) ; then
706    # Plan to send an email here with IGCM_sys_SendMail
707    if [ X${TaskType} != Xchecking ] ; then
708      IGCM_card_WriteOption ${SUBMIT_DIR}/run.card Configuration PeriodState "Fatal"
709      echo "IGCM_debug_Verif_Exit : Something wrong happened previously."
710      echo "IGCM_debug_Verif_Exit : ERROR and EXIT keyword will help find out where."
711      echo "                        EXIT THE JOB."
712      echo
713      IGCM_debug_CallStack
714    fi
715
716    if [ X${ActivateBigBro} = Xtrue ] ; then
717      # RabbitMQ message code "EXIT THE JOBS BECAUSE ERROR(S) HAS BEEN TRIGGERED"
718      code=9999
719      # RabbitMQ message body
720      Body=$( echo "{${genericSimulationID},\"msgCode\":\"${code}\",\"msgUID\":\"$(uuidgen)\",\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
721      # To be sure we flush message buffer and clean up behind us before the end of the simulation
722      FlushAMQP=true
723      # Fill the rabbitMQ queue
724      IGCM_debug_sendAMQP
725    fi
726
727    # Mail notification
728    IGCM_sys_SendMail
729
730    # And Good Bye
731    date
732    exit 1
733  fi
734}
735
736#D-#==================================================
737#D-function IGCM_debug_Verif_Exit_Post
738#D-* Purpose: exit with number 1 if ExitFlag is true for Post-treatment
739#D-
740function IGCM_debug_Verif_Exit_Post {
741  if ( ${ExitFlag} ) ; then
742    echo "IGCM_debug_Verif_Exit_Post : Something wrong happened."
743    # If SpaceName is PROD then we stop if post_processing fails
744    # Plan to send an email here with IGCM_sys_SendMail
745    if [ X${config_UserChoices_SpaceName} = XPROD ] ; then
746      echo "                        EXIT THE JOB."
747      echo
748      # Mail notification
749      #IGCM_sys_SendMailPost
750      # And Good Bye
751      date
752      exit 1
753    else
754      echo "Either inside config.card the variable SpaceName is not in PROD"
755      echo "or inside the main Job the variable JobType is not in RUN mode"
756      echo "              SO WE DO NOT EXIT THE JOB."
757      echo
758      date
759    fi
760  fi
761}
762
763#D-#==================================================================
764#D-function IGCM_debug_Print
765#D-* Purpose: Print arguments according to a level of verbosity.
766#D-
767function IGCM_debug_Print
768{
769  typeset level=$1
770  shift
771
772  if [ X"${1}" = X"-e" ]; then
773    typeset cmd_echo="echo -e"
774    shift
775  else
776    typeset cmd_echo="echo"
777  fi
778
779  if [ ${level} -le ${Verbosity} ] ; then
780    typeset i
781    case "${level}" in
782    1) for i in "$@" ; do
783      ${cmd_echo} $(date +"%Y-%m-%d %T") "--Debug1-->" ${i}
784      done ;;
785    2) for i in "$@" ; do
786      ${cmd_echo} $(date +"%Y-%m-%d %T") "--------Debug2-->" ${i}
787      done ;;
788    3) for i in "$@" ; do
789      ${cmd_echo} $(date +"%Y-%m-%d %T") "--------------Debug3-->" ${i}
790      done ;;
791    esac
792  fi
793}
794
795#D-#==================================================================
796#D-function IGCM_debug_PrintVariables
797#D-* Purpose: Print arguments when match a pattern
798#D-           according to a level of verbosity.
799function IGCM_debug_PrintVariables
800{
801  typeset level=$1
802  shift
803
804  list=$( set | grep ^$1 | sed -e "s/'//g" )
805
806  if [ "X${list}" != X ]  ; then
807    IGCM_debug_Print ${level} ${list}
808  fi
809}
810
811#D-#==================================================================
812#D-function IGCM_debug_PrintInfosActions
813#D-* Purpose: Print information related to instrumentation
814function IGCM_debug_PrintInfosActions
815{
816  typeset actionType=$1
817  typeset entitySize=$2
818  typeset start_ms=$3
819  typeset end_ms=$4
820
821  typeset dest=$5
822  typeset source=$6
823
824  typeset diff_ms entitySizeKo entitySizeMo flux_Ko_ms flux_Ko_s flux_Mo_s
825  typeset dirFrom dirTo
826
827  diff_ms=$(( $end_ms - $start_ms ))
828  # echo "diff_ms=$diff_ms"
829
830  entitySizeKo=$( echo ${entitySize} | gawk -F"|" '{print $1}' )
831  # echo "entitySizeKo=$entitySizeKo"
832  entitySizeMo=$( echo ${entitySize} | gawk -F"|" '{print $2}' )
833
834  # flux en Ko / ms
835  flux_Ko_ms=$( echo "scale=6;${entitySizeKo}/${diff_ms}" | bc )
836  # echo "flux_Ko_ms=$flux_Ko_ms"
837
838  # flux en Ko / s
839  flux_Ko_s=$(( $flux_Ko_ms * 1000 ))
840  # echo "flux_Ko_s=$flux_Ko_s"
841
842  # flux en Mo / s
843  flux_Mo_s=$( echo "scale=6;${flux_Ko_s}/1024" | bc )
844  # echo "flux_Mo_s=$flux_Mo_s"
845
846  if [ -d $dest ] ; then
847    dirTo=$( readlink -f ${dest} )
848  else
849    dirTo=$( readlink -f $( dirname ${dest} ) )
850  fi
851
852  if [ -d $source ] ; then
853    dirFrom=$( readlink -f ${source} )
854  else
855    dirFrom=$( readlink -f $( dirname ${source} ) )
856  fi
857
858  instrumentationContent=$( echo "\"actionName\":\"${actionType}\",\"size_Mo\":\"${entitySizeMo}\",\"duration_ms\":\"${diff_ms}\",\"throughput_Mo_s\":\"${flux_Mo_s}\",\"dirFrom\":\"${dirFrom}\",\"dirTo\":\"${dirTo}\"" )
859
860  if [ X${ActivateStackFilling} = Xtrue ] ; then
861    echo "{${instrumentationContent}}" >> ${StackFileLocation}/${StackFileName}
862  fi
863
864  # Inform the rabbitMQ queue
865  if [ X${ActivateBigBro} = Xtrue ] ; then
866    # RabbitMQ message body
867    Body=$( echo "{${genericSimulationID},\"msgCode\":\"7000\",\"msgUID\":\"$(uuidgen)\",${instrumentationContent},\"msgTimestamp\":\"$( date +"%Y-%m-%dT%H:%M:%S.%N%z" )\"}" )
868    # Fill the rabbitMQ queue
869    IGCM_debug_sendAMQP
870  fi
871}
872
873#D-#==================================================================
874#D-function IGCM_debug_Check
875#D- * Purpose: Check the present file by comparison with a reference file
876function IGCM_debug_Check
877{
878  #---------------------
879  if [ ! -n "${libIGCM}" ] ; then
880    echo "Check libIGCM_debug ..........................................[ FAILED ]"
881    echo "--Error--> libIGCM variable is not defined"
882    exit 2
883  fi
884
885  #---------------------
886  if [ ! -n "${Verbosity}" ] ; then
887    echo "Check libIGCM_debug ..........................................[ FAILED ]"
888    echo "--Error--> Verbosity variable is not defined"
889    exit 3
890  fi
891
892  #---------------------
893  # Need to remove timestamps here
894  diff ${libIGCM}/libIGCM_debug/IGCM_debug_Test.ref <(${libIGCM}/libIGCM_debug/IGCM_debug_Test.ksh | sed -e "s:[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]\:[0-9][0-9]\:[0-9][0-9] ::g") > /dev/null 2>&1
895  status=$?
896
897  if [ ${status} -eq 0 ] ; then
898    echo "Check libIGCM_debug ..............................................[ OK ]"
899  else
900    echo "Check libIGCM_debug ..........................................[ FAILED ]"
901    echo "--Error--> Execution of ${libIGCM}/libIGCM_debug/IGCM_debug_Test.ksh"
902    echo "           has produced the file IGCM_debug_Test.ref.failed"
903    echo "           Please analyse differences with the reference file by typing:"
904    echo "           diff IGCM_debug_Test.ref.failed ${libIGCM}/libIGCM_debug/IGCM_debug_Test.ref"
905    echo "           Report errors to the author: Patrick.Brockmann@cea.fr"
906    diff ${libIGCM}/libIGCM_debug/IGCM_debug_Test.ref <(${libIGCM}/libIGCM_debug/IGCM_debug_Test.ksh | sed -e "s:[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]\:[0-9][0-9]\:[0-9][0-9] ::g")
907    exit 4
908  fi
909  #---------------------
910}
Note: See TracBrowser for help on using the repository browser.