3 ################################################################################
5 # The MIT License (MIT)
7 # Copyright (c) 2016 Stéphane Desneux <sdx@iot.bzh>
8 # (c) 2016 Jan-Simon Möller <jsmoeller@linuxfoundation.org>
10 # Permission is hereby granted, free of charge, to any person obtaining a copy
11 # of this software and associated documentation files (the "Software"), to deal
12 # in the Software without restriction, including without limitation the rights
13 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 # copies of the Software, and to permit persons to whom the Software is
15 # furnished to do so, subject to the following conditions:
17 # The above copyright notice and this permission notice shall be included in
18 # all copies or substantial portions of the Software.
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 ################################################################################
30 # this script shouldn't be called directly, but through aglsetup.sh that will in
31 # turn execute (source) generated instructions back in the parent shell,
32 # whether it's bash, zsh, or any other supported shell
35 DEFAULT_MACHINE=qemux86-64
36 DEFAULT_BUILDDIR=./build
40 #SCRIPT=$(basename $BASH_SOURCE)
42 SCRIPTDIR=$(cd $(dirname $BASH_SOURCE) && pwd -P)
43 METADIR=$(cd $(dirname $BASH_SOURCE)/../.. && pwd -P)
45 function info() { echo "$@" >&2; }
46 function infon() { echo -n "$@" >&2; }
47 function error() { echo "ERROR: $@" >&2; return 1; }
48 function verbose() { [[ $VERBOSE == 1 ]] && echo "$@" >&2; return 0; }
49 function debug() { [[ $DEBUG == 1 ]] && echo "DEBUG: $@" >&2; return 0;}
51 info "------------ $SCRIPT: Starting"
53 #compute AGL_REPOSITORIES
54 AGL_REPOSITORIES=$(for x in $(ls -d $METADIR/meta-*/templates/{machine,feature} $METADIR/bsp/*/templates/machine 2>/dev/null); do echo $(basename $(dirname $(dirname $x))); done | sort -u)
56 function list_machines() {
58 for y in $(ls -d $METADIR/{.,bsp}/$a/templates/machine/* 2>/dev/null); do
64 function list_all_machines() {
65 for x in $AGL_REPOSITORIES; do
70 function validate_builddir() {
71 if [[ "$BUILDDIR" =~ [[:space:]] ]]; then
72 error "Build dir '$BUILDDIR' shouldn't contain any space"
74 debug "Build dir is valid"
77 function validate_machines() {
78 list_all_machines | sort | uniq -c | while read cnt machine; do
79 [[ $cnt == 1 ]] && continue
80 info "Machine $machine found in the following repositories:"
81 for x in $(ls -d $METADIR/*/templates/machine/$machine $METADIR/bsp/*/templates/machine/$machine 2>/dev/null); do
84 error "Multiple machine templates are not allowed"
86 debug "Machines list has no duplicate."
89 function list_features() {
91 for y in $(ls -d $METADIR/$x/templates/feature/* 2>/dev/null); do
97 function list_all_features() {
98 for x in $AGL_REPOSITORIES; do
103 function validate_features() {
104 list_all_features | sort | uniq -c | while read cnt feature; do
105 [[ $cnt == 1 ]] && continue;
106 info "Feature $feature found in the following repositories:"
107 for x in $(ls -d $METADIR/*/templates/feature/$feature 2>/dev/null); do
110 error "Multiple feature templates are not allowed"
112 debug "Features list has no duplicate."
115 function find_machine_dir() {
117 for x in $AGL_REPOSITORIES; do
118 dirs=$(ls -d $METADIR/{.,bsp}/$x/templates/machine/$machine 2>/dev/null)
120 [[ -d $dir ]] && { echo $dir; return 0; }
126 function find_feature_dir() {
128 for x in $AGL_REPOSITORIES; do
129 dir=$METADIR/$x/templates/feature/$feature
130 [[ -d $dir ]] && { echo $dir; return 0; }
137 Usage: . $SCRIPT [options] [feature [feature [... ]]]
140 Compatibility: bash, zsh, ksh
143 -m|--machine <machine>
145 default: '$DEFAULT_MACHINE'
146 -b|--build <directory>
147 build directory to use
148 default: '$DEFAULT_BUILDDIR'
149 -s|--script <filename>
150 file where setup script is generated
151 default: none (no script)
153 flag to force overwriting any existing configuration
155 -r|--rpm-revision <schema>
156 Specify how to handle RPM packages revisions
158 'prservice[:<address>]' : Use a PR service daemon.
159 if <address> is not specified, the default value 'localhost:0'
160 is used (shortcut for a PR service started by bitbake)
161 'timestamp' : Use a generated time stamp (UTC).
162 'value:<revision>' : Use <revision> explicitly.
176 echo "Available machines:" >&2
177 for x in $AGL_REPOSITORIES; do
178 buf=$(list_machines $x)
179 [[ -z "$buf" ]] && continue
182 [[ $y == $DEFAULT_MACHINE ]] && def="* " || def=" "
188 echo "Available features:" >&2
189 for x in $AGL_REPOSITORIES; do
190 buf=$(list_features $x)
191 [[ -z "$buf" ]] && continue
193 for feature in $buf; do
194 print_feature="$feature"
195 featuredir=$(find_feature_dir $feature)
196 if [ -e $featuredir/included.dep ];then
197 print_feature="$print_feature :($(find_feature_dependency $feature $feature))"
199 echo " $print_feature"
205 function append_fragment() {
206 basefile=$1; shift # output file
207 f=$1; shift # input file
210 debug "adding fragment to $basefile: $f"
212 echo "# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #" >>$basefile
213 echo "# fragment { " >>$basefile
214 [[ -f $f ]] && echo "# $f" >>$basefile || true
216 [[ -n "$label" ]] && echo "$label" >>$basefile
217 [[ -f $f ]] && cat $f >>$basefile || true
220 echo "# }" >>$basefile
221 echo "# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #" >>$basefile
222 [[ -f $f ]] && echo $f >>$BUILDDIR/conf/fragments.log || true
225 function execute_setup() {
227 debug "Executing script $script"
229 [[ $DEBUG == 1 ]] && opts="$opts -x"
230 pushd $BUILDDIR &>/dev/null
231 $BASH $opts $script \
233 || { rc=$?; error "Script $script failed"; }
239 # process all fragments
240 FRAGMENTS_BBLAYERS=""
241 FRAGMENTS_LOCALCONF=""
243 function process_fragments() {
245 debug "processing fragments in dir $dir"
247 verbose " Searching fragments: $dir"
249 # lookup for files with priorities specified: something like xx_bblayers.conf.yyyyy.inc
250 for x in $(ls $dir/??[._]bblayers.conf*.inc 2>/dev/null); do
251 FRAGMENTS_BBLAYERS="$FRAGMENTS_BBLAYERS $(basename $x):$x"
252 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
255 # same for local.conf
256 for x in $(ls $dir/??[._]local.conf*.inc 2>/dev/null); do
257 FRAGMENTS_LOCALCONF="$FRAGMENTS_LOCALCONF $(basename $x):$x"
258 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
262 for x in $(ls $dir/??[._]setup*.sh 2>/dev/null); do
263 FRAGMENTS_SETUP="$FRAGMENTS_SETUP $(basename $x):$x"
264 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
269 function containsFeature () {
270 for feature in $1; do
271 [[ "$feature" == "$2" ]] && return 1;
276 function find_feature_dependency() {
278 featuredir=$(find_feature_dir $1)
280 if [ -e $featuredir/included.dep ]; then
281 dep_features="$(cat $featuredir/included.dep)"
282 for dep_feature in $dep_features; do
283 full_feature="$full_feature $res_dep_features"
284 res_dep_features="$res_dep_features $dep_feature"
285 if containsFeature $dep_feature $full_feature ; then
286 res_dep_features="$res_dep_features $(find_feature_dependency $dep_feature $full_feature)"
290 echo "$res_dep_features";
295 debug "Parsing arguments: $@"
296 TEMP=$(getopt -o m:b:r:s:fvdh --long machine:,builddir:,rpm-revision:,script:,force,verbose,debug,help -n $SCRIPT -- "$@")
297 [[ $? != 0 ]] && { usage; exit 1; }
302 ### default options values
303 MACHINE=$DEFAULT_MACHINE
304 BUILDDIR=$DEFAULT_BUILDDIR
308 SETUP_MANIFEST=aglsetup.manifest
312 -m|--machine) MACHINE=$2; shift 2;;
313 -b|--builddir) BUILDDIR=$2; shift 2;;
314 -s|--setupscript) SETUPSCRIPT=$2; shift 2;;
315 -f|--force) FORCE=1; shift;;
316 -r|--rpm-revision) RPMREVISION=$2; shift 2;;
317 -v|--verbose) VERBOSE=1; shift;;
318 -d|--debug) VERBOSE=1; DEBUG=1; shift;;
319 -h|--help) HELP=1; shift;;
321 *) error "Arguments parsing error"; exit 1;;
325 [[ "$HELP" == 1 ]] && { usage; exit 0; }
327 verbose "Command line arguments: ${GLOBAL_ARGS[@]}"
329 # the remaining args are the features
332 # validate the machine list
333 debug "validating machines list"
336 # validate the machine
337 debug "validating machine $MACHINE"
338 find_machine_dir $MACHINE >/dev/null || error "Machine '$MACHINE' not found in [ $(list_all_machines)]"
340 # validate the features list
341 debug "validating features list"
345 for FEATURE in $FEATURES;do
346 TMP_FEATURES="$TMP_FEATURES $FEATURE"
347 TMP_FEATURES="$TMP_FEATURES $(find_feature_dependency $FEATURE $TMP_FEATURES)"
349 # remove duplicate features if any
350 FEATURES=$(for x in $TMP_FEATURES; do echo $x; done | sort -u | awk '{printf("%s ",$1);}')
352 # validate the features
353 for f in $FEATURES; do
354 debug "validating feature $f"
355 find_feature_dir $f >/dev/null || error "Feature '$f' not found in [ $(list_all_features)]"
359 debug "validating builddir $BUILDDIR"
360 BUILDDIR=$(mkdir -p "$BUILDDIR" && cd "$BUILDDIR" && pwd -P)
363 ###########################################################################################
364 function dump_log() {
365 info " ------------ $(basename $1) -----------------"
367 info " ----------------------------------------"
370 function genconfig() {
371 info "Generating configuration files:"
372 info " Build dir: $BUILDDIR"
373 info " Machine: $MACHINE"
374 info " Features: $FEATURES"
376 # step 1: run usual OE setup to generate conf dir
377 export TEMPLATECONF=$(cd $SCRIPTDIR/../templates/base && pwd -P)
378 debug "running oe-init-build-env with TEMPLATECONF=$TEMPLATECONF"
379 info " Running $METADIR/external/poky/oe-init-build-env"
380 info " Templates dir: $TEMPLATECONF"
383 . $METADIR/external/poky/oe-init-build-env $BUILDDIR >/dev/null
386 # step 2: concatenate other remaining fragments coming from base
387 process_fragments $TEMPLATECONF
389 # step 3: fragments for machine
390 process_fragments $(find_machine_dir $MACHINE)
392 # step 4: fragments for features
393 for feature in $FEATURES; do
394 process_fragments $(find_feature_dir $feature)
397 # step 5: sort fragments and append them in destination files
398 FRAGMENTS_BBLAYERS=$(sed 's/ /\n/g' <<<$FRAGMENTS_BBLAYERS | sort)
399 debug "bblayer fragments: $FRAGMENTS_BBLAYERS"
400 info " Config: $BUILDDIR/conf/bblayers.conf"
401 for x in $FRAGMENTS_BBLAYERS; do
403 append_fragment $BUILDDIR/conf/bblayers.conf $file
407 FRAGMENTS_LOCALCONF=$(sed 's/ /\n/g' <<<$FRAGMENTS_LOCALCONF | sort)
408 debug "localconf fragments: $FRAGMENTS_LOCALCONF"
409 info " Config: $BUILDDIR/conf/local.conf"
410 for x in $FRAGMENTS_LOCALCONF; do
412 append_fragment $BUILDDIR/conf/local.conf $file
415 # special fragment to call distro-manifest-generator.sh from
416 # meta-agl-profile-core/recipes-core/distro-build-manifest/distro-build-manifest.bb
417 append_fragment $BUILDDIR/conf/local.conf /dev/stdin "# generated by $(realpath $BASH_SOURCE)" <<-EOF
418 DISTRO_SETUP_MANIFEST = "$(realpath -Ls $BUILDDIR)/$SETUP_MANIFEST"
419 DISTRO_MANIFEST_GENERATOR = "$(dirname $(realpath $BASH_SOURCE))/distro-manifest-generator.sh"
422 FRAGMENTS_SETUP=$(sed 's/ /\n/g' <<<$FRAGMENTS_SETUP | sort)
423 debug "setup fragments: $FRAGMENTS_SETUP"
424 cat <<EOF >$BUILDDIR/conf/setup.sh
427 # this script has been generated by $BASH_SOURCE
429 export MACHINE="$MACHINE"
430 export FEATURES="$FEATURES"
431 export BUILDDIR="$BUILDDIR"
432 export METADIR="$METADIR"
433 export RPMREVISION="$RPMREVISION"
434 export LOCALCONF="$BUILDDIR/conf/local.conf"
436 echo "--- beginning of setup script"
438 info " Setup script: $BUILDDIR/conf/setup.sh"
439 for x in $FRAGMENTS_SETUP; do
441 append_fragment $BUILDDIR/conf/setup.sh $file "echo '--- fragment $file'"
444 append_fragment $BUILDDIR/conf/setup.sh "" "echo '--- end of setup script'"
446 infon " Executing setup script ... "
447 execute_setup $BUILDDIR/conf/setup.sh 2>&1 | tee $BUILDDIR/conf/setup.log
448 [[ ${PIPESTATUS[0]} == 0 ]] && {
450 [[ $VERBOSE == 1 ]] && dump_log $BUILDDIR/conf/setup.log
451 rm $BUILDDIR/conf/setup.sh
454 info "FAIL: please check $BUILDDIR/conf/setup.log"
455 dump_log $BUILDDIR/conf/setup.log
460 ###########################################################################################
462 # check for overwrite
463 [[ $FORCE -eq 1 ]] && rm -f \
464 $BUILDDIR/conf/local.conf \
465 $BUILDDIR/conf/bblayers.conf \
466 $BUILDDIR/conf/setup.* \
469 ####### step 1: generate configuration file #######
471 if [[ -f $BUILDDIR/conf/local.conf || -f $BUILDDIR/conf/bblayers.conf ]]; then
472 info "Configuration files already exist:"
473 for x in $BUILDDIR/conf/local.conf $BUILDDIR/conf/bblayers.conf; do
474 [[ -f $x ]] && info " - $x"
476 info "Skipping configuration files generation."
477 info "Use option -f|--force to overwrite existing configuration."
482 ####### step 2: generate aglsetup.manifest #######
484 infon "Generating setup manifest: $BUILDDIR/$SETUP_MANIFEST ... "
485 for x in /etc/os-release /usr/lib/os-release; do
488 FEATURES_md5=$(echo $FEATURES|md5sum -|awk '{print $1;}')
489 cat <<EOF >$BUILDDIR/$SETUP_MANIFEST
490 # ----------------------------------------------
491 # This fragment has been generated by $SCRIPT at setup time
494 DIST_DISTRO_NAME="AGL"
496 # target machine as passed to $SCRIPT
497 DIST_MACHINE="$MACHINE"
499 # features as resolved by $SCRIPT
500 DIST_FEATURES="$FEATURES"
501 DIST_FEATURES_MD5="${FEATURES_md5}"
503 # build host information deduced from os-release
504 DIST_BUILD_HOST="$(id -un)@$(hostname -f || hostname || hostname -s)"
505 DIST_BUILD_OS="${PRETTY_NAME:-${NAME} ${VERSION} [COMPUTED]}"
508 DIST_METADIR="$METADIR"
511 DIST_SETUP_TS="$(date -u +%Y%m%d_%H%M%S_%Z)"
513 # ------------ end of $SCRIPT fragment --------
517 ####### step 3: generate agl-init-build-env #######
519 # always generate setup script in builddir: it can be sourced later manually without re-running the setup
520 infon "Generating setup file: $BUILDDIR/agl-init-build-env ... "
522 cat <<EOF >$BUILDDIR/agl-init-build-env
523 . $METADIR/external/poky/oe-init-build-env $BUILDDIR
524 if [ -n "\$DL_DIR" ]; then
525 BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE DL_DIR"
527 if [ -n "\$SSTATE_DIR" ]; then
528 BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE SSTATE_DIR"
530 export BB_ENV_EXTRAWHITE
535 ####### step 4: generate output script #######
537 # finally, generate output script if requested by caller
538 if [[ -n "$SETUPSCRIPT" ]]; then
539 debug "generating setupscript in $SETUPSCRIPT"
540 cat <<EOF >$SETUPSCRIPT
541 . $BUILDDIR/agl-init-build-env
545 info "------------ $SCRIPT: Done"