ThirdPartyFunctions 16.9 KB
Newer Older
Henry's avatar
Henry committed
1
2
3
4
#---------------------------------*- sh -*-------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
5
#   \\  /    A nd           | Copyright (C) 2016-2019 OpenCFD Ltd.
OpenFOAM bot's avatar
OpenFOAM bot committed
6
7
8
#    \\/     M anipulation  |
#------------------------------------------------------------------------------
#                           | Copyright (C) 2011-2016 OpenFOAM Foundation
Henry's avatar
Henry committed
9
10
#------------------------------------------------------------------------------
# License
Mark Olesen's avatar
Mark Olesen committed
11
12
#     This file is part of OpenFOAM, licensed under GNU General Public License
#     <http://www.gnu.org/licenses/>.
Henry's avatar
Henry committed
13
14
15
16
17
#
# File
#     etc/tools/ThirdPartyFunctions
#
# Description
18
#     Various functions used in building ThirdParty packages
Henry's avatar
Henry committed
19
20
21
#
#     Define the standard buildBASE and installBASE for the platform
#     Define WM_NCOMPPROCS always.
22
23
24
25
#
#     Compiler and flags are managed via the 'wmake -show-c, -show-cflags, ..'
#     but also with WM_CC, WM_CFLAGS,... env variables
#
Henry's avatar
Henry committed
26
27
#------------------------------------------------------------------------------

28
# The normal locations for source, build and installation (prefix-dir)
29
30
31
32
33
34
sourceBASE="$WM_THIRD_PARTY_DIR"
buildBASE="$WM_THIRD_PARTY_DIR/build/$WM_ARCH$WM_COMPILER"
installBASE="$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER"

# Synthetic value combining precision and label size (Eg, DPInt32)
WM_SIZE_OPTIONS="${WM_PRECISION_OPTION}Int${WM_LABEL_SIZE}"
Henry's avatar
Henry committed
35

36
# Dynamic library endings (default is .so)
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
SO="$(wmake -show-ext-so 2>/dev/null)"; SO="${SO#.}"
if [ -z "$SO" ] && [ "$(uname -s)" = Darwin ]
then
    SO=dylib
fi
: "${SO:=so}"


# Fallback values, needed for our scotch Makefile which uses
# WM_CFLAGS and WM_LDFLAGS for arch information
if [ -z "$WM_CFLAGS" ]
then
    export WM_CFLAGS="$(wmake -show-cflags 2>/dev/null)"
fi

if [ -z "$WM_LDFLAGS" ]
then
    export WM_LDFLAGS="$(wmake -show-cflags-arch 2>/dev/null)"
fi
56

57
unset BUILD_SUFFIX
58
#------------------------------------------------------------------------------
59
60
61
62
63
# Export compiler settings (and flags) for CMake/configure
# based on the values from wmake -show-compile-*
#
# Since "wmake -show-XX" is only available after 1904, continue to support
# the previous env variables method (WM_CC, WM_CFLAGS, WM_CXX, WM_CXXFLAGS)
64
65
exportCompiler()
{
66
67
68
69
70
71
72
73
74
75
    local comp flag

    # C compiler and flags
    comp="$(wmake -show-c 2>/dev/null)" && \
    flag="$(wmake -show-cflags 2>/dev/null)" || {
        comp="$WM_CC"
        flag="$WM_CFLAGS"
    }

    if test -n "$comp" && command -v "$comp" >/dev/null
76
    then
77
78
        export CC="$comp"
        if [ -n "$flag" ]
79
        then
80
            export CFLAGS="$flag"
81
82
83
        fi
    fi

84
85
86
87
88
89
90
91
    # C++ compiler and flags
    comp="$(wmake -show-cxx 2>/dev/null)" && \
    flag="$(wmake -show-cxxflags 2>/dev/null)" || {
        comp="$WM_CXX"
        flag="$WM_CXXFLAGS"
    }

    if test -n "$comp" && command -v "$comp" >/dev/null
92
    then
93
94
        export CXX="$comp"
        if [ -n "$flag" ]
95
        then
96
            export CXXFLAGS="$flag"
97
98
99
100
        fi
    fi
}

101
# Export linker settings for CMake/configure
102
103
exportLinker()
{
104
105
106
107
108
109
    local flag

    # Linker flags, actually just the machine arch
    flag="$(wmake -show-cflags-arch 2>/dev/null)" || flag="$WM_LDFLAGS"

    if test -n "$flag"
110
    then
111
        export LDFLAGS="$flag"
112
    fi
113
114
}

115
116

# Force use of gcc/g++, but the values of CFLAGS, CXXFLAGS may be incorrect
117
118
useGcc()
{
119
    export CC=gcc
120
121
122
    export CXX=g++
}

123
124
125
126
127
128
129
130
131
132
133
134
135
# Scan arguments for a '-gcc' option, forcing gcc/g++ when found
useGccFlag()
{
    for i
    do
        if [ "$i" = "-gcc" ]
        then
            useGcc
            break
        fi
    done
}

136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Return current value of $CC if set or obtain from 'wmake -show-c',
# using $WM_CC (older env variable) as the first level fallback.
# Final fallback is <gcc>
whichCC()
{
    local comp="$CC"

    if [ -z "$comp" ]
    then
        comp="$(wmake -show-c 2>/dev/null)" || comp="$WM_CC"
        test -n "$comp" && command -v "$comp" >/dev/null || unset comp
    fi

    echo "${comp:-gcc}"
}


# Return current value of $CXX if set or obtain from 'wmake -show-cxx',
# using $WM_CXX (older env variable) as the first level fallback.
# Final fallback is <g++>
whichCXX()
{
    local comp="$CXX"

    if [ -z "$comp" ]
    then
        comp="$(wmake -show-cxx 2>/dev/null)" || comp="$WM_CXX"
        test -n "$comp" && command -v "$comp" >/dev/null || unset comp
    fi

    echo "${comp:-g++}"
}


170
171
# Return <mpicc> by default or <mpiicc> if possible for INTELMPI.
# Cray doesn't have <mpicc>, but its <cc> manages mpi paths directly.
172
# NOTE: could further refine based on "wmake -show-c", but not yet needed
173
174
whichMpicc()
{
175
    local comp="$(command -v mpicc)"
176
177
    case "$WM_MPLIB" in
    (INTELMPI)
178
        comp="$(command -v mpiicc)"     # Intel <mpiicc> available?
179
180
        ;;
    (CRAY-MPI*)
181
        : "${comp:=cc}"                 # Cray <cc> if there is no <mpicc>
182
183
        ;;
    esac
184
    echo "${comp:-mpicc}"
185
186
}

187

188
189
190
# Return <mpicxx> by default or <mpiicpc> if possible for INTELMPI.
# Cray doesn't have <mpicxx>, but its <CC> manages mpi paths directly.
# NOTE: could further refine based on "wmake -show-cxx", but not yet needed
191
192
whichMpicxx()
{
193
    local comp="$(command -v mpicxx)"
194
195
    case "$WM_MPLIB" in
    (INTELMPI)
196
        comp="$(command -v mpiicpc)"    # Intel <mpiicpc> available?
197
198
        ;;
    (CRAY-MPI*)
199
        : "${comp:=CC}"                 # Cray <CC> if there is no <mpicc>
200
201
        ;;
    esac
202
    echo "${comp:-mpicxx}"
203
204
}

205
# Require wmkdepend etc when building with wmake
206
207
requireWMakeToolchain()
{
208
209
    local wmDir="${WM_DIR:-$WM_PROJECT_DIR/wmake}"
    local archDir="$wmDir/platforms/$WM_ARCH$WM_COMPILER"
210

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    if [ -x "$archDir/wmkdepend" ] || [ -x "$archDir/wmkdep" ]
    then
        echo "Appear to have {wmkdepend,wmkdep} binary" 1>&2
    else
        echo "Warning: appear to be missing {wmkdepend,wmkdep} binary ... building" 1>&2
        ( cd "$wmDir/src" && make -s )

        [ -x "$archDir/wmkdepend" ] || [ -x "$archDir/wmkdep" ] || {
            exec 1>&2
            echo
            echo "Error: cannot use wmake build for '${0##*/}"
            echo "    Missing {wmkdepend,wmkdep} binary"
            echo "    Please try run the top-level OpenFOAM Allwmake first"
            echo
            exit 1
        }
    fi
228
229
}

230

231
232
233
#------------------------------------------------------------------------------
# Some functions as per OpenFOAM etc/config.sh/functions

234
unset -f _foamAddLib _foamAddLibAuto _foamAddMan _foamAddPath # Get settings only
235
unset -f _foamClean _foamConfig
236
237
238
239
240
241
242
243
244
245
246
247
248

if [ -x "$WM_PROJECT_DIR/bin/foamCleanPath" ]
then
    # Cleaning environment variables
    _foamClean()
    {
         local var=$1
         shift
         eval $($WM_PROJECT_DIR/bin/foamCleanPath -sh-env=$var "$@")
    }
else
    _foamClean() { echo "No foamCleanPath" 1>&2; }
fi
249

250
251
# Source an etc/config.sh file
_foamConfig() { eval "$($WM_PROJECT_DIR/bin/foamEtcFile -sh -config $@)"; }
252

253
254
255
# Source an etc file (as per OpenFOAM functions). Eg, for mpi setup.
_foamEtc() { eval "$($WM_PROJECT_DIR/bin/foamEtcFile -sh $@)"; }

256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
#------------------------------------------------------------------------------

#
# Set a suffix for the build
# - eg, for -mpi, or -mesa etc
#
setBuildSuffix()
{
    BUILD_SUFFIX="${1##-}"
    if [ -n "$BUILD_SUFFIX" ]
    then
        BUILD_SUFFIX="-${BUILD_SUFFIX}"
    else
        unset BUILD_SUFFIX
    fi
}


Henry's avatar
Henry committed
274
#
275
# Mostly building without wmake
Henry's avatar
Henry committed
276
# - disable wmakeScheduler variables
277
# - use max number of cores for building
Henry's avatar
Henry committed
278
279
#
unset WM_HOSTS WM_SCHEDULER
280

281
WM_NCOMPPROCS=$(getconf _NPROCESSORS_ONLN 2>/dev/null) || WM_NCOMPPROCS=1
282
: ${WM_NCOMPPROCS:=1}
283
export WM_NCOMPPROCS
Henry's avatar
Henry committed
284
285
286


#
287
288
# If WM_CONTINUE_ON_ERROR not set activate the shell option "stop on error"
#
289
if [ -z "$WM_CONTINUE_ON_ERROR" ]
290
291
292
293
294
then
    set -e
fi


295
296
297
298
299
300
301
302
303
304
305
# Report error and exit
die()
{
    exec 1>&2
    echo
    echo "Error: see '${0##*/} -help' for usage"
    while [ "$#" -ge 1 ]; do echo "    $1"; shift; done
    echo
    exit 1
}

306
307
308
309
310
311
312
313
314
315
316
317
318
# Test if it matches "*-none"
_foamIsNone()
{
    test "${1##*-}" = none
}

# Test if it matches "*-system"
_foamIsSystem()
{
    test "${1##*-}" = system
}


319
#
320
321
322
323
# Try to locate cmake according to the CMAKE_PATH.
#
# On success: return the resolved value as output.
# On failure: just report what is found in the path.
324
#
325
unset CMAKE_PATH # clear when first loaded
326
327
findCMake()
{
328
    local candidate foundExe
329
330
331

    if [ -n "$CMAKE_PATH" ]
    then
332
        # Check as directory
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
        if [ -d "$CMAKE_PATH" ]
        then
            for candidate in \
                $CMAKE_PATH/cmake \
                $CMAKE_PATH/bin/cmake \
            ;
            do
                if [ -f "$candidate" -a -x "$candidate" ]
                then
                    foundExe=$candidate
                    break
                fi
            done
        fi

348
        # Check as file, include ThirdParty installation in the search
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
        if [ -z "$foundExe" ]
        then
            for candidate in \
                $CMAKE_PATH \
                $installBASE/$CMAKE_PATH/bin/cmake \
                $installBASE/cmake-$CMAKE_PATH/bin/cmake \
            ;
            do
                if [ -f "$candidate" -a -x "$candidate" ]
                then
                    foundExe=$candidate
                    break
                fi
            done
        fi

        if [ -n "$foundExe" ]
        then
            # Use absolute path
            if [ "${foundExe#/}" = "$foundExe" ]
            then
                foundExe="$(cd ${foundExe%/cmake} 2>/dev/null && pwd)/cmake"
            fi
372
            echo "Using cmake=$foundExe" 1>&2
373
            echo $foundExe
374
375
376
377
378
379
380
381
382
383
            return 0
        else
            cat << NOT_FOUND 1>&2
'cmake' not found under specified CMAKE_PATH
    CMAKE_PATH=$CMAKE_PATH
reverting to using command from path
NOT_FOUND
        fi
    fi

384
385
386
387
388
389
390
    # Default to use the path, try resolving (so we know what we are using).
    for candidate in cmake
    do
        foundExe=$(command -v $candidate 2>/dev/null) && break
    done
    : ${foundExe:=false}

391
392
    echo "Using cmake=$foundExe" 1>&2
    echo $foundExe
393
394
395
396
}


#
397
# Try to locate qmake or qmake-qt5 according to the QMAKE_PATH
398
399
400
#
# On success: return the resolved value as output.
# On failure: just report what is found in the path.
401
#
402
unset QMAKE_PATH # clear when first loaded
403
findQMake()
404
{
405
    local candidate foundExe
406
407
408

    if [ -n "$QMAKE_PATH" ]
    then
409
        # Check as directory
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
        if [ -d "$QMAKE_PATH" ]
        then
            for candidate in \
                $QMAKE_PATH/qmake \
                $QMAKE_PATH/bin/qmake \
            ;
            do
                if [ -f "$candidate" -a -x "$candidate" ]
                then
                    foundExe=$candidate
                    break
                fi
            done
        fi

425
        # Check as file, include ThirdParty installation in the search
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
        if [ -z "$foundExe" ]
        then
            for candidate in \
                $QMAKE_PATH \
                $installBASE/$QMAKE_PATH/bin/qmake \
                $installBASE/qt-$QMAKE_PATH/bin/qmake \
            ;
            do
                if [ -f "$candidate" -a -x "$candidate" ]
                then
                    foundExe=$candidate
                    break
                fi
            done
        fi

        if [ -n "$foundExe" ]
        then
            # Use absolute path
            if [ "${foundExe#/}" = "$foundExe" ]
            then
                foundExe="$(cd ${foundExe%/qmake} 2>/dev/null && pwd)/qmake"
            fi
449
            echo "Using qmake=$foundExe" 1>&2
450
            echo $foundExe
451
452
453
454
455
456
457
458
459
460
            return 0
        else
            cat << NOT_FOUND 1>&2
'qmake' not found under specified QMAKE_PATH
    QMAKE_PATH=$QMAKE_PATH
reverting to using command from path
NOT_FOUND
        fi
    fi

461
462
463
464
465
466
467
468
    # Default to use the path, try resolving (so we know what we are using).
    # Some systems have qmake-qt5 as well as qmake
    for candidate in qmake-qt5 qmake
    do
        foundExe=$(command -v $candidate 2>/dev/null) && break
    done
    : ${foundExe:=false}

469
470
    echo "Using qmake=$foundExe" 1>&2
    echo $foundExe
471
472
473
}


474
#
475
# Set a new prefix=... in pkgconfig files
476
#
477
pkgconfigNewPrefix()
478
{
479
    local dir="${1%%/}"
480

481
    if [ -n "$dir" -a -d "$dir" ]
482
    then
483
484
485
486
487
488
489
490
491
492
493
494
495
496
        # Require absolute path, but use logical (not physical) location
        [ "${dir}" != "${dir#/}" ] || dir=$(cd $dir 2>/dev/null && /bin/pwd -L)
        # Strip sub-level
        case "$dir" in (*/pkgconfig) dir="${dir%/*}";; esac
        # Strip a level
        case "$dir" in (*/lib | */lib64 | */bin) dir="${dir%/*}";; esac
    fi

    # Verify that the prefix path is valid
    # Warning (not an error) - thus no special return code
    [ -n "$dir" -a -d "$dir" ] || {
        echo "Warning: invalid prefix directory: $dir" 1>&2
        return 0
    }
497

498
    echo "Set pkgconfig prefix : $dir"
499

500
501
502
503
504
505
    local nfiles
    for libdir in lib/pkgconfig lib64/pkgconfig
    do
        unset nfiles
        [ -d "$dir/$libdir" ] || continue
        for i in $dir/$libdir/*.pc
506
        do
507
            if [ -f "$i" -a ! -L "$i" ]
508
509
            then
                nfiles="x$nfiles"
510
                sed -i~ -e 's@^\(prefix=\).*$@\1'"$dir@" $i
511
512
            fi
        done
513
514
        echo "    $libdir/*.pc  (edited ${#nfiles})"
    done
515
516
517
518
}


#
519
520
521
522
523
# Adjust pkgconfig information to use '${prefix} where possible instead
# of directory paths.
#
# Adjusts includedir=, libdir=, -I/... and -L/... and
# any *_location= entries (QT)
524
525
526
#
pkgconfigAdjust()
{
527
    local dir="${1%%/}"
528

529
    if [ -n "$dir" -a -d "$dir" ]
530
    then
531
532
533
534
535
536
537
        # Require absolute path, but use logical (not physical) location
        [ "${dir}" != "${dir#/}" ] || dir=$(cd $dir 2>/dev/null && /bin/pwd -L)
        # Strip sub-level
        case "$dir" in (*/pkgconfig) dir="${dir%/*}";; esac
        # Strip a level
        case "$dir" in (*/lib | */lib64 | */bin) dir="${dir%/*}";; esac
    fi
538

539
540
541
542
543
544
    # Verify that the prefix path is valid
    # Warning (not an error) - thus no special return code
    [ -n "$dir" -a -d "$dir" ] || {
        echo "Warning: invalid prefix directory: $dir" 1>&2
        return 0
    }
545

546
547
548
549
550
551
552
553
    echo "Adjust pkgconfig locations : $dir"

    local nfiles
    for libdir in lib/pkgconfig lib64/pkgconfig
    do
        unset nfiles
        [ -d "$dir/$libdir" ] || continue
        for i in $dir/$libdir/*.pc
554
        do
555
            if [ -f "$i" -a ! -L "$i" ]
556
557
            then
                nfiles="x$nfiles"
558
                sed -i~ \
559
560
561
562
                    -e 's@^\(includedir=\)'"$dir/"'@\1${prefix}/@' \
                    -e 's@^\(libdir=\)'"$dir/"'@\1${prefix}/@'     \
                    -e 's@\(_location=\)'"$dir/"'@\1${prefix}/@'   \
                    -e 's@\(-[IL]\)'"$dir/"'@\1${prefix}/@g'       \
563
564
565
                    $i
            fi
        done
566
567
        echo "    $libdir/*.pc  (edited ${#nfiles})"
    done
568
569
570
}


571
572
#
# Download file $1 from url $2 into download/ directory
Henry's avatar
Henry committed
573
574
575
576
577
578
579
580
#
downloadFile()
{
    [ "$#" -eq 2 ] || {
        echo "downloadFile called with incorrect number of arguments $@"
        return 1
    }

581
582
    local file="$1"
    local url="$2"
Henry's avatar
Henry committed
583
584
585
586
587
588
589
590
591
592
593

    if [ ! -e download/$file ]
    then
        mkdir -p download
        echo "downloading $tarFile from $url"
        ( cd download && wget --no-check-certificate $url -O $file )
    fi
}


#
594
# Copy Make/{files,options} from etc/makeFiles/PACKAGE
Henry's avatar
Henry committed
595
596
#
# $1 = PACKAGE
597
# $2 = TARGET DIRECTORY (optional)
Henry's avatar
Henry committed
598
599
600
601
602
603
604
cpMakeFiles()
{
    [ "$#" -eq 1 -o "$#" -eq 2 ] || {
        echo "cpMakeFiles called with incorrect number of arguments $@"
        return 1
    }

605
606
    local pkg=$1
    local dst="${2:-.}"
Henry's avatar
Henry committed
607
608
    echo "cpMakeFiles" $pkg $dst

609
    wmakeFiles=$WM_THIRD_PARTY_DIR/etc/makeFiles/$pkg
Henry's avatar
Henry committed
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633

    for i in $(cd $wmakeFiles && find . -type f)
    do
        d=${i%/*}   # dirname
        b=${i##*/}   # basename

        mkdir -p $dst/$d/Make 2>/dev/null

        # NOTE the behaviour of '-nt' can cause problems
        #
        # - bash, ksh, /usr/bin/test
        #   True, if file1 exists and file2 does not
        #
        # - dash, zsh (and maybe others)
        #   False, if file1 or file2 does not exist
        #
        if [ ! -e $dst/$d/Make/$b -o $wmakeFiles/$i -nt $dst/$d/Make/$b ]
        then
            cp $wmakeFiles/$i $dst/$d/Make/$b
        fi
    done
}


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
#
# Apply source-code patch if possible.
# Patches are taken from etc/patches/PACKAGE
#
# $1 = PACKAGE
# $2 = TARGET DIRECTORY (optional)
applyPatch()
{
    [ "$#" -eq 1 -o "$#" -eq 2 ] || {
        echo "applyPatch called with incorrect number of arguments ($#): $@"
        return 1
    }

    local pkg="$1"
    local dst="${2:-.}"

    local patch="$WM_THIRD_PARTY_DIR/etc/patches/$pkg"
    local sentinel="PATCHED_DURING_OPENFOAM_BUILD"

    if [ -r "$patch" ]
    then
    (
        cd $dst || exit 1
        if [ -f "$sentinel" ]
        then
            echo "patch for $pkg was already applied"
        else
            echo "apply patch for $pkg"
            touch "$sentinel"
663
            patch -b -l -p1 < $patch 2>&1 | tee $sentinel
664
665
666
667
668
669
670
        fi
    )
    else
        echo "no patch found for $pkg"
    fi
}

671

672
#------------------------------------------------------------------------------