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 @ 10727

Last change on this file since 10727 was 10587, checked in by nicolasmartin, 5 years ago

Modification of makenemo conception: -[rau] option is mandatory in any case even for a preceding build

  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 11.6 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
123Mandatory:
124   -m   Computing architecture (./arch), FCM file describing the compilation settings
125   and one of the following option (use 'all' arg to list available items)
126   -r   Reference configuration (./cfgs), proven with long-term support until the EOL of the release
127   -a   Academic test case (./tests), ready to use at the release start without guarantee or support over time
128   -u   Scripted remote configuration (see ./tests/rmt_cfgs.txt)
129
130Optional:
131   -d   New set of sub-components (list from ./src directory)
132   -e   Path for alter patch  location (default: 'MY_SRC' in configuration folder)
133   -h   Print this help
134   -j   Number of processes to compile (0: dry run with no build)
135   -n   Name for new configuration
136   -s   Path for alter source location (default: 'src' root directory)
137   -t   Path for alter build  location (default: 'BLD' in configuration folder)
138   -v   Level of verbosity ([0-3])
139
140Examples:
141   ¤ Configuration creation
142        Build          : ./makenemo -[aru] ... [...]
143        Copy           : ./makenemo -n ...  -[aru] ... [...]
144   ¤ Configuration management
145        List CPP keys  : ./makenemo [...] list_key
146        Add-Remove keys: ./makenemo [...] add_key '...' del_key '...'
147        Fresh start    : ./makenemo [...] clean
148        Erasure        : ./makenemo [...] clean_config
149EOF
150            exit 0       ;;
151      ('d') x_d=${OPTARG};; ('n') x_n=${OPTARG};; ('r') x_r=${OPTARG};; ('u') x_u=${OPTARG};;
152      ('a') x_a=${OPTARG};; ('m') x_m=${OPTARG};; ('j') x_j=${OPTARG};; ('t') x_t=${OPTARG};;
153      ('e') x_e=${OPTARG};; ('s') x_s=${OPTARG};; ('v') x_v=${OPTARG}                      ;;
154      ('k') chk_key=${OPTARG}                                                              ;;
155      (':') echo ${b_n}" : -"${OPTARG}" option : missing value" 1>&2;   exit 2             ;;
156      ('?') echo ${b_n}" : -"${OPTARG}" option : not supported" 1>&2;   exit 2             ;;
157   esac
158
159done
160
161shift $(($OPTIND-1));
162
163## Get clean, clean_config options
164while [ ${#1} -gt 0 ]; do
165
166   case "$1" in
167      'clean'       ) x_c="--$1"                                     ;;
168      'clean_config') . ${COMPIL_DIR}/Fclean_config.sh; exit         ;;
169      ## Checking if argument has anything other than whitespace
170      'add_key'     ) [[ ! "$2" =~ ^\ +$ ]] && list_add_key=$2; shift;;
171      'del_key'     ) [[ ! "$2" =~ ^\ +$ ]] && list_del_key=$2; shift;;
172      'list_key'    ) list_key='1'                                   ;;
173      '*'           ) echo " \"$1\" BAD OPTION"; exit 2              ;;
174   esac
175
176   shift
177done
178
179
180export NEW_CONF=${x_n}
181NBR_PRC=${x_j}
182CMP_NAM=${x_m}
183NEM_SUBDIR=${x_d}
184REF_CONF=${x_r}
185DEMO_CONF=${x_a}
186RMT_CONF=${x_u}
187TML_CONF=${REF_CONF}
188export NEMO_DIR=${MAIN_DIR}/${x_s}
189
190[ "${CMP_NAM}" == 'all' ] && . ${COMPIL_DIR}/Flist_archfile.sh all && exit
191
192
193## No ref. cfg, demo case, nor remote cfg selected
194if [[ -z "${REF_CONF}" && -z "${DEMO_CONF}" && -z "${RMT_CONF}" ]]; then
195
196      ## Reuse last configuration compiled if any (existing 'work_cfgs.txt')
197#     if [[ $( find ./cfgs ./tests -name work_cfgs.txt ) ]]; then
198#        CONFIG_DIR=${MAIN_DIR}/$( ls -rt */work_cfgs.txt | awk -F/ 'END{ print $1}' )
199#        TML_CONF=$( tail -1 ${CONFIG_DIR}/work_cfgs.txt | awk '{ print $1 }' )
200#     else
201         ## No ${REF_CONF}, ${DEMO_CONF}, ${RMT_CONF} nor ${NEM_SUBDIR} and 1st compilation => exit
202#        echo -e "\033[0;33m\nNo previous build found!"
203         echo -e "\033[0;31m\nAt least a reference configuration ('-r'), a test case ('-a'), "
204         echo -e "a remote configuration ('-u') has to be choosen!!!\033[0m"
205         ${COMPIL_DIR}/Flist_cfgs.sh
206         exit 2
207#     fi
208
209## At least one config has been requested
210else
211
212   ## 'all' arg: list all available configurations
213   if [[ "${REF_CONF}" == 'all' || "${DEMO_CONF}" == 'all' || "${RMT_CONF}" == 'all' ]]; then
214      ${COMPIL_DIR}/Flist_cfgs.sh
215      exit 2
216   ## Probably useless but who knows?
217   elif [[ -n "${REF_CONF}" && -n "${DEMO_CONF}" ]]; then
218      echo -e "\033[0;31m\nYou have to choose whether you work with:"
219      echo -e "  - LTS configurations in ./cfgs  ('-r') or"
220      echo -e "  - Unsupported cases  in ./tests ('-a')\033[0m\n"
221      exit 2
222   fi
223
224   ## Remote cfg
225   if   [ -n "${RMT_CONF}" ]; then
226      conf_file=rmt_cfgs.txt; CONFIG_DIR=${MAIN_DIR}/tests;
227
228      if [[ ! $( grep ${RMT_CONF} ${CONFIG_DIR}/${conf_file} ) ]]; then
229            echo -e "\033[0;31m\nThe reference configuration ('-r'), test case ('-a') or "
230            echo -e "remote configuration ('-u') selected is not available!!!"
231            echo -e "Check the option used and the available items in .txt files\033[0m"
232            ${COMPIL_DIR}/Flist_cfgs.sh
233            exit 2
234      fi
235
236      ## Little tricky this one
237      for word in $( grep ${RMT_CONF} ${CONFIG_DIR}/${conf_file} ); do
238         words[${#words[@]}]=$word
239      done
240
241      TML_CONF=${words[2]}; NEM_SUBDIR=${words[4]}; URL=${words[6]}
242
243   ## Demo case
244   elif [ -n "${DEMO_CONF}" ]; then
245      conf_file=demo_cfgs.txt; CONFIG_DIR=${MAIN_DIR}/tests; TML_CONF=${DEMO_CONF}
246   fi
247
248fi
249
250## Test if ref. cfg or demo case does exist
251if [[ ! $( grep "${TML_CONF} " ${CONFIG_DIR}/*_cfgs.txt ) ]]; then
252   echo -e "\033[0;31m\nThe reference configuration ('-r'), demonstration case ('-a') or "
253   echo -e "remote configuration ('-u') selected is not available!!!"
254   echo -e "Check the option used and the available items in .txt files\033[0m"
255   ${COMPIL_DIR}/Flist_cfgs.sh
256   exit 2
257
258else
259
260   ## Reuse a working cfg 
261   if [[ -f ${CONFIG_DIR}/work_cfgs.txt && $( grep "${TML_CONF} " ${CONFIG_DIR}/work_cfgs.txt ) ]]; then
262      conf_file=work_cfgs.txt
263   fi
264
265   ## If new cfg exists, work in it
266   [ -z "${NEW_CONF}" ] && NEW_CONF=${TML_CONF}
267
268   ## Update sub-comps if needed
269   if [ -z "${NEM_SUBDIR}" ]; then
270         NEM_SUBDIR=$( grep "${TML_CONF} " ${CONFIG_DIR}/${conf_file}  | awk '{$1 = ""; print $0}' )
271   fi
272
273fi
274
275export NEMO_TDIR=${x_t:-$CONFIG_DIR}
276
277## Save new configuration with sub-components set in work_cfgs.txt
278[ -f ${CONFIG_DIR}/work_cfgs.txt ] && sed -i "/${NEW_CONF} /d" ${CONFIG_DIR}/work_cfgs.txt
279echo ${NEW_CONF} "${NEM_SUBDIR}" \
280   >> ${CONFIG_DIR}/work_cfgs.txt
281
282cd ${CONFIG_DIR}
283
284printf "\nYou are installing a new configuration %s from %s " ${NEW_CONF} ${TML_CONF}
285printf  "with sub-components: %s\n"  "${NEM_SUBDIR}"
286
287## Create new config even in existing one (mkdir with -p option, cp with -n)
288${COMPIL_DIR}/Fmake_config.sh ${NEW_CONF} ${TML_CONF}
289
290## create EXP00 if needed
291[ ! -d ${CONFIG_DIR}/${NEW_CONF}/EXP00 ] && \cp -R -n ${CONFIG_DIR}/${NEW_CONF}/EXPREF ${CONFIG_DIR}/${NEW_CONF}/EXP00
292
293## Get online script file for remote cfg
294[ -n "${RMT_CONF}" ] && ${COMPIL_DIR}/Ffetch_extdir.sh ${NEW_CONF} $URL
295
296#- Create the WORK ---
297#- Clean links and librairies ---
298#- Creating the good links, at first on OCE ---
299. ${COMPIL_DIR}/Fmake_WORK.sh ${x_e} ${NEW_CONF} ${NEM_SUBDIR} || exit 3
300
301. ${COMPIL_DIR}/Fmake_bld.sh ${CONFIG_DIR} ${NEW_CONF} ${NEMO_TDIR} || exit 3
302
303# build the complete list of the cpp keys of this configuration
304if [ ${chk_key} -eq 1 ] ; then
305
306   for i in $( grep "^ *#.* key_" ${NEW_CONF}/WORK/* ); do
307      echo $i | grep key_ | sed -e "s/=.*//"
308   done \
309   | sort -d | uniq > ${COMPIL_DIR}/full_key_list.txt
310
311   [ ${list_key} -eq 1 ] && cat ${COMPIL_DIR}/full_key_list.txt && exit 0
312
313fi
314
315#- At this stage new configuration has been added, we add or remove keys
316[ ! -z "${list_add_key}" ] && { . ${COMPIL_DIR}/Fadd_keys.sh ${NEW_CONF} add_key ${list_add_key}; }
317[ ! -z "${list_del_key}" ] && { . ${COMPIL_DIR}/Fdel_keys.sh ${NEW_CONF} del_key ${list_del_key}; }
318
319#- check that all keys are really existing...
320if [ $chk_key -eq 1 ] ; then
321
322   for kk in $( cat ${NEW_CONF}/cpp_${NEW_CONF}.fcm ); do
323
324      if [ "$( echo $kk | cut -c 1-4 )" == "key_" ]; then
325         kk=${kk/=*/}
326
327         if [ ! $( grep $kk ${COMPIL_DIR}/full_key_list.txt ) ]; then
328            echo
329            echo "E R R O R : key "$kk" is not found in ${NEW_CONF}/WORK routines..."
330            echo "we stop..."
331            echo
332            exit 1
333         fi
334
335      fi
336
337   done
338
339fi
340
341#- At this stage cpp keys have been updated. we can check the arch file
342#- When used for the first time, choose a compiler ---
343. ${COMPIL_DIR}/Fcheck_archfile.sh arch_nemo.fcm cpp.fcm ${CMP_NAM} || exit 3
344
345#- At this stage the configuration has beeen chosen
346#- We coose the default light file
347export USEBLD=bldxag.cfg
348
349#- We look after agrif
350grep key_agrif ${COMPIL_DIR}/cpp.fcm && export AGRIFUSE=1 && export USEBLD=${USEBLD/xag/}
351. ${COMPIL_DIR}/Fprep_agrif.sh ${NEW_CONF} ${NEMO_TDIR} || exit 3
352
353#-
354#_ END OF CONFIGURATION PHASE
355#_
356
357#-
358#- Compile ---
359
360if [ "${NBR_PRC}" -gt 0 ]; then
361   cd ${NEMO_TDIR}/${NEW_CONF} || cd -
362
363   ## if AGRIF we do a first preprocessing
364   if [[ ${#x_c} -eq 0 && "$AGRIFUSE" -eq 1 ]]; then
365      fcm build --ignore-lock -j 1 ${COMPIL_DIR}/bld_preproagr.cfg ||{ cd - ; exit 1 ;}
366      echo ''
367      echo "---------------------------------"
368      echo "CONV preprocessing successfull !!"
369      echo "---------------------------------"
370      echo ''
371   fi
372
373   fcm build ${x_c} --ignore-lock -v ${x_v} -j ${NBR_PRC} ${COMPIL_DIR}/$USEBLD ||{ cd - ; exit 1 ;}
374
375   if [ -f ${NEMO_TDIR}/${NEW_CONF}/BLD/bin/nemo.exe ]; then
376      ln -sf ${NEMO_TDIR}/${NEW_CONF}/BLD/bin/nemo.exe  ${CONFIG_DIR}/${NEW_CONF}/EXP00/nemo
377   fi
378
379   ## add remove for clean option
380   if [ ${#x_c} -ne 0 ]; then
381
382      echo 'Cleaning in '${NEW_CONF}' the building folders'
383
384      for dir in AGRIFLIB BLD EXP00 LONG NEMOFILES REPRO_* SHORT WORK; do
385         rm -rf ${NEMO_TDIR}/${NEW_CONF}/$dir
386      done
387
388      for file in cpp.history cpp.fcm full_key_list.txt; do
389         rm -f  ${COMPIL_DIR}/$file
390      done
391
392   fi
393
394fi
395
396#- Come back to original directory ---
397cd -
398
399#-
400#- Unset variables
401${COMPIL_DIR}/Fclean_var.sh
Note: See TracBrowser for help on using the repository browser.