ThirdPartyFunctions 8.35 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) 2011-2016 OpenFOAM Foundation
6
#    \\/     M anipulation  | Copyright (C) 2016 OpenCFD Ltd.
Henry's avatar
Henry committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM.
#
#     OpenFOAM is free software: you can redistribute it and/or modify it
#     under the terms of the GNU General Public License as published by
#     the Free Software Foundation, either version 3 of the License, or
#     (at your option) any later version.
#
#     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
#     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
#     for more details.
#
#     You should have received a copy of the GNU General Public License
#     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
#
# File
#     etc/tools/ThirdPartyFunctions
#
# Description
#     Functions for managing the third-party packages
#
#     Define the standard buildBASE and installBASE for the platform
#     Define WM_NCOMPPROCS always.
#------------------------------------------------------------------------------

34
35
# The normal locations for source, build and installation (prefix-dir)
sourceBASE=$WM_THIRD_PARTY_DIR
Henry's avatar
Henry committed
36
37
38
39
buildBASE=$WM_THIRD_PARTY_DIR/build/$WM_ARCH$WM_COMPILER
installBASE=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER

#
40
# Mostly building without wmake
Henry's avatar
Henry committed
41
# - disable wmakeScheduler variables
42
# - use max number of cores for building
Henry's avatar
Henry committed
43
44
#
unset WM_HOSTS WM_SCHEDULER
45
if [ -r /proc/cpuinfo ]
Henry's avatar
Henry committed
46
then
47
48
    WM_NCOMPPROCS=$(egrep "^processor" /proc/cpuinfo | wc -l)
else
Henry's avatar
Henry committed
49
50
    WM_NCOMPPROCS=1
fi
51
export WM_NCOMPPROCS
Henry's avatar
Henry committed
52
53
54
55
# echo "Building on $WM_NCOMPPROCS cores"


#
56
57
58
59
60
61
62
63
# If WM_CONTINUE_ON_ERROR not set activate the shell option "stop on error"
#
if [ -z "${WM_CONTINUE_ON_ERROR}" ]
then
    set -e
fi


64
65
66
67
68
69
70
71
72
73
74
# 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
}

75
76
77
78
79
80
81
82
83
84
85
86
87
# Test if it matches "*-none"
_foamIsNone()
{
    test "${1##*-}" = none
}

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


88
89
90
91
#
# try to locate cmake according to the CMAKE_PATH
# or just use what is found in the path
#
92
unset CMAKE_PATH # clear when first loaded
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
findCMake()
{
    local candidate
    local foundExe

    if [ -n "$CMAKE_PATH" ]
    then
        # check as directory
        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

        # check as file, include ThirdParty installation in the search
        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

141
            echo "Using cmake=$foundExe" 1>&2
142
143
144
145
146
147
148
149
150
151
152
            echo "$foundExe"
            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

153
    # Default to use the path, try resolving (so we know what we are using)
154
    foundExe=$(command -v cmake 2> /dev/null) || foundExe=cmake
155
156
    echo "Using cmake=${foundExe:-NotFound}"  1>&2
    echo "${foundExe:-cmake}"
157
158
159
160
161
162
163
}


#
# try to locate qmake according to the QMAKE_PATH
# or just use what is found in the path
#
164
unset QMAKE_PATH # clear when first loaded
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
findQtMake()
{
    local candidate
    local foundExe

    if [ -n "$QMAKE_PATH" ]
    then
        # check as directory
        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

        # check as file, include ThirdParty installation in the search
        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

213
            echo "Using qmake=$foundExe" 1>&2
214
215
216
217
218
219
220
221
222
223
224
            echo "$foundExe"
            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

225
226
227
228
    # Default to use the path, try resolving (so we know what we are using)
    foundExe=$(command -v qmake 2> /dev/null) || foundExe=qmake
    echo "Using qmake=${foundExe:-NotFound}"  1>&2
    echo "${foundExe:-qmake}"
229
230
231
}


232
233
#
# Download file $1 from url $2 into download/ directory
Henry's avatar
Henry committed
234
235
236
237
238
239
240
241
#
downloadFile()
{
    [ "$#" -eq 2 ] || {
        echo "downloadFile called with incorrect number of arguments $@"
        return 1
    }

242
243
    local file="$1"
    local url="$2"
Henry's avatar
Henry committed
244
245
246
247
248
249
250
251
252
253
254

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


#
255
# Copy Make/{files,options} from etc/wmakeFiles/PACKAGE
Henry's avatar
Henry committed
256
257
#
# $1 = PACKAGE
258
# $2 = TARGET DIRECTORY (optional)
Henry's avatar
Henry committed
259
260
261
262
263
264
265
266
267
cpMakeFiles()
{
    set +x

    [ "$#" -eq 1 -o "$#" -eq 2 ] || {
        echo "cpMakeFiles called with incorrect number of arguments $@"
        return 1
    }

268
269
    local pkg=$1
    local dst="${2:-.}"
Henry's avatar
Henry committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    echo "cpMakeFiles" $pkg $dst

    wmakeFiles=$WM_THIRD_PARTY_DIR/etc/wmakeFiles/$pkg

    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

    set -x
}


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
#
# 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"
328
            patch -p1 < $patch 2>&1 | tee $sentinel
329
330
331
332
333
334
335
        fi
    )
    else
        echo "no patch found for $pkg"
    fi
}

336
#------------------------------------------------------------------------------