wmakeCollect 4.16 KB
Newer Older
1
2
3
4
5
6
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
34
35
36
37
38
39
40
41
42
43
44
#!/bin/bash
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
#    \\/     M anipulation  |
#-------------------------------------------------------------------------------
# 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/>.
#
# Script
#     wmakeCollect
#
# Usage
#     wmakeCollect [OPTION] <command>
#
# Description
#     wmake scheduler for efficient parallel compilations.
#
#-------------------------------------------------------------------------------
Script=${0##*/}

usage() {
    exec 1>&2
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    cat<<USAGE

Usage: $Script [OPTION] <command>

options:
45
46
  -clean            Clean-up before compilation (removes old makefiles)
  -kill             Clean-up after termination (removes makefiles)
47
48
49
50
51
52
  -h | -help        Print the usage

Collecting scheduler for fast parallel compilation of large numbers of object
files.  Can be used in compiling OpenFOAM by setting the WM_SCHEDULER variable.

When called with a compilation command it is written into a file in the
53
directory $WM_COLLECT_DIR.
54

55
56
57
When called without a command the files in the $WM_COLLECT_DIR directory are
combined into a single Makefile which is passed to make to compile all of the
object files efficiently in parallel.
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

Typical usage for compiling OpenFOAM:

  - Ensure all lnInclude directories are up-to-date:
    wmakeLnIncludeAll

  - Compile all with this scheduler:
    wmake -queue or wmake -q

USAGE
    exit 1
}

# Set true to clean-up file if interupted
cleanup=

while [ "$#" -gt 0 ]
do
    case "$1" in
    -h | -help)
        usage
        ;;
80
    -kill | -clean)
81
82
83
84
85
86
87
88
89
90
91
92
93
94
        cleanup="true"
        shift
        ;;
    -*)
        usage "unknown option: '$*'"
        break
        ;;
    *)
        break
        ;;
    esac
done


95
if [ -z "$WM_COLLECT_DIR" ]
96
then
97
    echo "$Script error: WM_COLLECT_DIR not set"
98
99
100
101
102
    exit 1
fi


# Collected makefile for this build
103
makefile="$WM_COLLECT_DIR.Makefile"
104
105
106
107
108


# Clean-up files and exit
if [ -n "$cleanup" ]
then
109
    rm -rf $WM_COLLECT_DIR
110
111
112
113
114
115
116
117
    rm -f $makefile
    exit 0
fi


if [ "$#" -gt 0 ]
then
    # Make sure directories exist
118
    mkdir -p $WM_COLLECT_DIR
119
120
121
122

    # The current target
    object="${@: -1:1}"

123
    # Create a unique name for the makefile from the object path
124
    file=$(mktemp $WM_COLLECT_DIR/XXXXXX)
125

126
127
128
129
130
    # Add the current target to the list of objects
    echo "OBJECTS += $object" >> $file

    # Add the build rule for the current target
    echo "$object: $makefile" >> $file
131
    echo -e "\tcd $PWD && \\" >> $file
132
133
134
    echo -e "\t${@:1:($#-1)} $object" >> $file
    echo >> $file
else
135
    if [ -d $WM_COLLECT_DIR ]
136
137
    then
        # Collect all the makefiles into a single makefiles for this build
138
        (cd $WM_COLLECT_DIR && ls -1rt | xargs cat > $makefile)
139
140
141
142
143

        # Add a build rule for all of the targets
        echo 'all: $(OBJECTS)' >> $makefile

        # Clear out all of the target makefiles
144
        rm -rf $WM_COLLECT_DIR
145
146
147
148
149
150
151
152

        # Run make on the collected makefile
        make -j $WM_NCOMPPROCS -f $makefile all

        rm -f $makefile
    fi
fi

153
154
155
156
157
158
159
160

#------------------------------------------------------------------------------
# Cleanup local variables and functions
#------------------------------------------------------------------------------

unset Script usage


161
#------------------------------------------------------------------------------