New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
makenemo in utils/build – NEMO

source: utils/build/makenemo @ 9979

Last change on this file since 9979 was 9765, checked in by nicolasmartin, 6 years ago

Cosmetic changes to makenemo
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 11.8 KB
Line 
1#!/bin/bash
2#set -x
3set -o posix
4#set -u
5#set -e
6#+
7#
8# ===============
9# makenemo
10# ===============
11#
12# --------------------------
13# Compile NEMO
14# --------------------------
15#
16# SYNOPSIS
17# ========
18#
19# ::
20#
21#  $ makenemo
22#
23#
24# DESCRIPTION
25# ===========
26#
27#
28# This script aims :
29#
30# - to choose MYCONFIG
31# - to choose compiler options
32# - to create the CONFIG/MYCONFIG/WORK directory
33# - to compile this configuration
34#
35#  Variables used :
36#
37#  From user input
38#
39# - NEW_CONF    : configuration to be created
40# - REF_CONF    : reference configuration to build the new one from
41# - CMP_NAM     : compiler name
42# - NBR_PRC     : number of processes used to compile
43# - RMT_CONF    : unsupported (external) configuration to build the new one from
44# - NEM_SUBDIR  : NEMO subdirectory used (specified)
45#
46#  Locally defined :
47#
48# - TAB         : NEMO subdirectory used (read)
49# - MAIN_DIR    : self explaining
50# - CONFIG_DIR  :   "    "    "
51# - MODELES_DIR :   "    "    "
52# - TOOLS_DIR   :   "    "    "
53# - NEMO_DIR    :   "    "    "
54# - REMOTE_CTL  : URL link to a remote resource list for an external configuration
55#                 which is not part of the reference suite
56# - LOCAL_REF   : Nearest reference configuration to an external configuration
57#                 which is not part of the reference suite
58#                 (used to populate work directories if remote access is not available)
59#
60# EXAMPLES
61# ========
62#
63# ::
64#
65#  $ ./makenemo -m ifort_osx - j3 -n ORCA2_SI3_PISCES
66#
67#
68# TODO
69# ====
70#
71# option debug
72#
73#
74# EVOLUTIONS
75# ==========
76#
77# $Id$
78#
79#
80#
81#   * creation
82#
83#-
84
85#-
86##- Initialization of the options ---
87x_d=''; x_h=''; x_n=''; x_r='';
88x_u=''; x_a=''; x_m=''; x_t='';
89x_c='';
90x_j='1'; x_e='none'; x_s='src'; x_v='1'
91
92##- Local variables ---
93b_n=$(basename ${0})
94OPTIND='1'
95MAIN_DIR=$(cd $(dirname "$0"); pwd)
96MAIN_DIR=${MAIN_DIR%/sette*}
97MAIN_DIR=${MAIN_DIR%/tools*}
98MAIN_DIR=${MAIN_DIR%/cfgs*}
99export MAIN_DIR
100#
101export CONFIG_DIR=${MAIN_DIR}/cfgs
102export TOOLS_DIR=${MAIN_DIR}/tools
103export COMPIL_DIR=${MAIN_DIR}/mk
104export NEMO_DIR=${MAIN_DIR}/${x_s}
105export AGRIFUSE='10'
106list_key='0'; chk_key='1'
107list_add_key=''; list_del_key='';
108conf_file=ref_cfgs.txt
109#-
110#- FCM and functions location ---
111export PATH=${MAIN_DIR}/ext/FCM/bin:$PATH
112
113#-
114#- Choice of the options ---
115while getopts :hd:n:r:u:a:m:j:e:s:v:t:k: option; do
116
117   case $option in
118      ('h') cat <<EOF
119Usage:
120------
121./makenemo -[aru] CONFIG -m ARCH [-[dehjntv] ...] [{list_key,clean,clean_config}] [{add_key,del_key} ...]
122
123The previous build is reused by default if no mandatory option given
124
125Mandatory:
126   -a   Academic test case            (./tests)
127   -m   Computing architecture        (./arch)
128   -r   Reference configuration       (./cfgs)
129   -u   Scripted remote configuration (./tests/rmt_cfgs.txt)
130Pass 'all' to any option to list available arguments
131
132Optional:
133   -d   Set of new sub-components (space separated list from ./src directory)
134   -e   Path for alternative patch  location (default: 'MY_SRC' in configuration folder)
135   -h   Print this help
136   -j   Number of processes to compile (0: no build)
137   -n   Name for new configuration
138   -s   Path for alternative source location (default: 'src' root directory)
139   -t   Path for alternative build  location (default: 'BLD' in configuration folder)
140   -v   Level of verbosity ([0-3])
141
142Examples:
143   ¤ Configuration creation
144        Build          : ./makenemo -[aru] ... [...]
145        Duplication    : ./makenemo -n ...  -[aru] ... [...]
146   ¤ Configuration management
147        List CPP keys  : ./makenemo [...] list_key
148        Add-Remove keys: ./makenemo [...] add_key '...' del_key '...'
149        Fresh start    : ./makenemo [...] clean
150        Erasure        : ./makenemo [...] clean_config
151EOF
152            exit 0       ;;
153      ('d') x_d=${OPTARG};; ('n') x_n=${OPTARG};; ('r') x_r=${OPTARG};; ('u') x_u=${OPTARG};;
154      ('a') x_a=${OPTARG};; ('m') x_m=${OPTARG};; ('j') x_j=${OPTARG};; ('t') x_t=${OPTARG};;
155      ('e') x_e=${OPTARG};; ('s') x_s=${OPTARG};; ('v') x_v=${OPTARG}                      ;;
156      ('k') chk_key=${OPTARG}                                                              ;;
157      (':') echo ${b_n}" : -"${OPTARG}" option : missing value" 1>&2;   exit 2             ;;
158      ('?') echo ${b_n}" : -"${OPTARG}" option : not supported" 1>&2;   exit 2             ;;
159   esac
160
161done
162
163shift $(($OPTIND-1));
164
165## Get clean, clean_config options
166while [ ${#1} -gt 0 ]; do
167
168   case "$1" in
169      'clean'       ) x_c="--$1"                                     ;;
170      'clean_config') . ${COMPIL_DIR}/Fclean_config.sh; exit         ;;
171      ## Checking if argument has anything other than whitespace
172      'add_key'     ) [[ ! "$2" =~ ^\ +$ ]] && list_add_key=$2; shift;;
173      'del_key'     ) [[ ! "$2" =~ ^\ +$ ]] && list_del_key=$2; shift;;
174      'list_key'    ) list_key='1'                                   ;;
175      '*'           ) echo " \"$1\" BAD OPTION"; exit 2              ;;
176   esac
177
178   shift
179done
180
181
182export NEW_CONF=${x_n}
183NBR_PRC=${x_j}
184CMP_NAM=${x_m}
185NEM_SUBDIR=${x_d}
186REF_CONF=${x_r}
187DEMO_CONF=${x_a}
188RMT_CONF=${x_u}
189TML_CONF=${REF_CONF}
190export NEMO_DIR=${MAIN_DIR}/${x_s}
191
192[ "${CMP_NAM}" ==  'all' ] && . ${COMPIL_DIR}/Flist_archfile.sh all && exit
193
194
195## No ref. cfg, demo case, nor remote cfg selected
196if [[ -z "${REF_CONF}" && -z "${DEMO_CONF}" && -z "${RMT_CONF}" ]]; then
197
198      ## Reuse last configuration compiled if any (existing 'work_cfgs.txt')
199      if [[ $( find ./cfgs ./tests -name work_cfgs.txt ) ]]; then
200         CONFIG_DIR=${MAIN_DIR}/$( ls -rt */work_cfgs.txt | awk -F/ 'END{ print $1}' )
201         TML_CONF=$( tail -1 ${CONFIG_DIR}/work_cfgs.txt | awk '{ print $1 }' )
202      else
203         ## No ${REF_CONF}, ${DEMO_CONF}, ${RMT_CONF} nor ${NEM_SUBDIR} and 1st compilation => exit
204         echo -e "\033[0;33m\nNo previous build found!"
205         echo -e "\033[0;31m\nAt least a reference configuration ('-r'), a demonstration case ('-a'), "
206         echo -e "a remote configuration ('-u') or a set of NEMO sub-components ('-d') "
207         echo -e "has to be choose!!!\033[0m"
208         ${COMPIL_DIR}/Flist_cfgs.sh
209         exit 2
210      fi
211
212## At least one config has been requested
213else
214
215   ## Argument 'all': list all available configurations
216   if [[ "${REF_CONF}" == 'all' || "${DEMO_CONF}" == 'all' || "${RMT_CONF}" == 'all' ]]; then
217      ${COMPIL_DIR}/Flist_cfgs.sh
218      exit 2
219   elif [[ -n "${REF_CONF}" && -n "${DEMO_CONF}" ]]; then
220      echo -e "\033[0;31m\nYou have to choose whether you work with:"
221      echo -e "  - Supported reference configurations in ./cfgs  ('-r') or"
222      echo -e "  - Unsupported demonstration cases    in ./tests ('-a')\033[0m\n"
223      exit 2
224   fi
225
226   ## Remote cfg
227   if   [ -n "${RMT_CONF}" ]; then
228      conf_file=rmt_cfgs.txt; CONFIG_DIR=${MAIN_DIR}/tests;
229
230      if [[ ! $( grep ${RMT_CONF} ${CONFIG_DIR}/${conf_file} ) ]]; then
231            echo -e "\033[0;31m\nThe reference configuration ('-r'), demonstration case ('-a') or "
232            echo -e "remote configuration ('-u') selected is not available!!!"
233            echo -e "Check if you use the good option and the available items in txt files\033[0m"
234            ${COMPIL_DIR}/Flist_cfgs.sh
235            exit 2
236      fi
237
238      ## Little tricky this one
239      for word in $( grep ${RMT_CONF} ${CONFIG_DIR}/${conf_file} ); do
240         words[${#words[@]}]=$word
241      done
242
243      TML_CONF=${words[2]}; NEM_SUBDIR=${words[4]}; URL=${words[6]}
244
245   ## Demo case
246   elif [ -n "${DEMO_CONF}" ]; then
247      conf_file=demo_cfgs.txt; CONFIG_DIR=${MAIN_DIR}/tests; TML_CONF=${DEMO_CONF}
248   fi
249
250fi
251
252## Test if ref. cfg or demo case does exist
253if [[ ! $( grep "${TML_CONF} " ${CONFIG_DIR}/*_cfgs.txt ) ]]; then
254   echo -e "\033[0;31m\nThe reference configuration ('-r'), demonstration case ('-a') or "
255   echo -e "remote configuration ('-u') selected is not available!!!"
256   echo -e "Check if you use the good option and the available items in txt files\033[0m"
257   ${COMPIL_DIR}/Flist_cfgs.sh
258   exit 2
259
260else
261
262   ## Reuse a working cfg 
263   if [[ -f ${CONFIG_DIR}/work_cfgs.txt && $( grep "${TML_CONF} " ${CONFIG_DIR}/work_cfgs.txt ) ]]; then
264      conf_file=work_cfgs.txt
265   fi
266
267   ## If new cfg exists, work in it
268   [ -z "${NEW_CONF}" ] && NEW_CONF=${TML_CONF}
269
270   ## Update sub-comps if needed
271   if [ -z "${NEM_SUBDIR}" ]; then
272         NEM_SUBDIR=$( grep "${TML_CONF} " ${CONFIG_DIR}/${conf_file}  | awk '{$1 = ""; print $0}' )
273   fi
274
275fi
276
277export NEMO_TDIR=${x_t:-$CONFIG_DIR}
278
279## Save new configuration with sub-components set in work_cfgs.txt
280[ -f ${CONFIG_DIR}/work_cfgs.txt ] && sed -i "/${NEW_CONF} /d" ${CONFIG_DIR}/work_cfgs.txt
281echo ${NEW_CONF} "${NEM_SUBDIR}" \
282   >> ${CONFIG_DIR}/work_cfgs.txt
283
284cd ${CONFIG_DIR}
285
286printf "\nYou are installing a new configuration %s from %s " ${NEW_CONF} ${TML_CONF}
287printf  "with sub-components: %s\n"  "${NEM_SUBDIR}"
288
289## Create new config even in existing one (mkdir with -p option, cp with -n)
290${COMPIL_DIR}/Fmake_config.sh ${NEW_CONF} ${TML_CONF}
291
292## create EXP00 if needed
293[ ! -d ${CONFIG_DIR}/${NEW_CONF}/EXP00 ] && \cp -R -n ${CONFIG_DIR}/${NEW_CONF}/EXPREF ${CONFIG_DIR}/${NEW_CONF}/EXP00
294
295## Get online script file for remote cfg
296[ -n "${RMT_CONF}" ] && ${COMPIL_DIR}/Ffetch_extdir.sh ${NEW_CONF} $URL
297
298#- Create the WORK ---
299#- Clean links and librairies ---
300#- Creating the good links, at first on OCE ---
301. ${COMPIL_DIR}/Fmake_WORK.sh ${x_e} ${NEW_CONF} ${NEM_SUBDIR} || exit 3
302
303. ${COMPIL_DIR}/Fmake_bld.sh ${CONFIG_DIR} ${NEW_CONF} ${NEMO_TDIR} || exit 3
304
305# build the complete list of the cpp keys of this configuration
306if [ ${chk_key} -eq 1 ] ; then
307
308   for i in $( grep "^ *#.* key_" ${NEW_CONF}/WORK/* ); do
309      echo $i | grep key_ | sed -e "s/=.*//"
310   done \
311   | sort -d | uniq > ${COMPIL_DIR}/full_key_list.txt
312
313   [ ${list_key} -eq 1 ] && cat ${COMPIL_DIR}/full_key_list.txt && exit 0
314
315fi
316
317#- At this stage new configuration has been added, we add or remove keys
318[ ! -z "${list_add_key}" ] && { . ${COMPIL_DIR}/Fadd_keys.sh ${NEW_CONF} add_key ${list_add_key}; }
319[ ! -z "${list_del_key}" ] && { . ${COMPIL_DIR}/Fdel_keys.sh ${NEW_CONF} del_key ${list_del_key}; }
320
321#- check that all keys are really existing...
322if [ $chk_key -eq 1 ] ; then
323
324   for kk in $( cat ${NEW_CONF}/cpp_${NEW_CONF}.fcm ); do
325
326      if [ "$( echo $kk | cut -c 1-4 )" == "key_" ]; then
327         kk=${kk/=*/}
328
329         if [ ! $( grep $kk ${COMPIL_DIR}/full_key_list.txt ) ]; then
330            echo
331            echo "E R R O R : key "$kk" is not found in ${NEW_CONF}/WORK routines..."
332            echo "we stop..."
333            echo
334            exit 1
335         fi
336
337      fi
338
339   done
340
341fi
342
343#- At this stage cpp keys have been updated. we can check the arch file
344#- When used for the first time, choose a compiler ---
345. ${COMPIL_DIR}/Fcheck_archfile.sh arch_nemo.fcm cpp.fcm ${CMP_NAM} || exit 3
346
347#- At this stage the configuration has beeen chosen
348#- We coose the default light file
349export USEBLD=bldxag.cfg
350
351#- We look after agrif
352grep key_agrif ${COMPIL_DIR}/cpp.fcm && export AGRIFUSE=1 && export USEBLD=${USEBLD/xag/}
353. ${COMPIL_DIR}/Fprep_agrif.sh ${NEW_CONF} ${NEMO_TDIR} || exit 3
354
355#-
356#_ END OF CONFIGURATION PHASE
357#_
358
359#-
360#- Compile ---
361
362if [ "${NBR_PRC}" -gt 0 ]; then
363   cd ${NEMO_TDIR}/${NEW_CONF} || cd -
364
365   ## if AGRIF we do a first preprocessing
366   if [[ ${#x_c} -eq 0 && "$AGRIFUSE" -eq 1 ]]; then
367      fcm build --ignore-lock -j 1 ${COMPIL_DIR}/bld_preproagr.cfg ||{ cd - ; exit 1 ;}
368      echo ''
369      echo "---------------------------------"
370      echo "CONV preprocessing successfull !!"
371      echo "---------------------------------"
372      echo ''
373   fi
374
375   fcm build ${x_c} --ignore-lock -v ${x_v} -j ${NBR_PRC} ${COMPIL_DIR}/$USEBLD ||{ cd - ; exit 1 ;}
376
377   if [ -f ${NEMO_TDIR}/${NEW_CONF}/BLD/bin/nemo.exe ]; then
378      ln -sf ${NEMO_TDIR}/${NEW_CONF}/BLD/bin/nemo.exe  ${CONFIG_DIR}/${NEW_CONF}/EXP00/nemo
379   fi
380
381   ## add remove for clean option
382   if [ ${#x_c} -ne 0 ]; then
383      rm -rf ${NEMO_TDIR}/${NEW_CONF}/AGRIFLIB
384      rm -rf ${NEMO_TDIR}/${NEW_CONF}/BLD
385      rm -f  ${NEMO_TDIR}/${NEW_CONF}/EXP00/nemo
386      rm -rf ${NEMO_TDIR}/${NEW_CONF}/LONG
387      rm -rf ${NEMO_TDIR}/${NEW_CONF}/NEMOFILES
388      rm -rf ${NEMO_TDIR}/${NEW_CONF}/REPRO_*
389      rm -rf ${NEMO_TDIR}/${NEW_CONF}/SHORT
390      rm -rf ${NEMO_TDIR}/${NEW_CONF}/WORK
391      rm -f  ${COMPIL_DIR}/*history ${COMPIL_DIR}/*fcm ${COMPIL_DIR}/*txt
392      echo "cleaning ${NEW_CONF} AGRIFLIB, BLD, LONG, NEMOFILES, REPRO_*, SHORT, WORK"
393   fi
394
395fi
396
397#- Come back to original directory ---
398cd -
399
400#-
401#- Unset variables
402${COMPIL_DIR}/Fclean_var.sh
Note: See TracBrowser for help on using the repository browser.