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/*/templates/{machine,feature}); do echo $(basename $(dirname $(dirname $x))); done | sort -u)
56 function list_machines() {
58 for y in $(ls -d $METADIR/$x/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); 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); 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 dir=$METADIR/$x/templates/machine/$machine
119 [[ -d $dir ]] && { echo $dir; return 0; }
124 function find_feature_dir() {
126 for x in $AGL_REPOSITORIES; do
127 dir=$METADIR/$x/templates/feature/$feature
128 [[ -d $dir ]] && { echo $dir; return 0; }
135 Usage: . $SCRIPT [options] [feature [feature [... ]]]
138 Compatibility: bash, zsh, ksh
141 -m|--machine <machine>
143 default: '$DEFAULT_MACHINE'
144 -b|--build <directory>
145 build directory to use
146 default: '$DEFAULT_BUILDDIR'
147 -s|--script <filename>
148 file where setup script is generated
149 default: none (no script)
151 flag to force overwriting any existing configuration
153 -r|--rpm-revision <schema>
154 Specify how to handle RPM packages revisions
156 'prservice[:<address>]' : Use a PR service daemon.
157 if <address> is not specified, the default value 'localhost:0'
158 is used (shortcut for a PR service started by bitbake)
159 'timestamp' : Use a generated time stamp (UTC).
160 'value:<revision>' : Use <revision> explicitly.
174 echo "Available machines:" >&2
175 for x in $AGL_REPOSITORIES; do
176 buf=$(list_machines $x)
177 [[ -z "$buf" ]] && continue
180 [[ $y == $DEFAULT_MACHINE ]] && def="* " || def=" "
186 echo "Available features:" >&2
187 for x in $AGL_REPOSITORIES; do
188 buf=$(list_features $x)
189 [[ -z "$buf" ]] && continue
191 for feature in $buf; do
192 print_feature="$feature"
193 featuredir=$(find_feature_dir $feature)
194 if [ -e $featuredir/included.dep ];then
195 print_feature="$print_feature :($(find_feature_dependency $feature $feature))"
197 echo " $print_feature"
203 function append_fragment() {
204 basefile=$1; shift # output file
205 f=$1; shift # input file
208 debug "adding fragment to $basefile: $f"
210 echo "# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #" >>$basefile
211 echo "# fragment { " >>$basefile
212 [[ -f $f ]] && echo "# $f" >>$basefile || true
214 [[ -n "$label" ]] && echo "$label" >>$basefile
215 [[ -f $f ]] && cat $f >>$basefile || true
218 echo "# }" >>$basefile
219 echo "# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #" >>$basefile
220 [[ -f $f ]] && echo $f >>$BUILDDIR/conf/fragments.log || true
223 function execute_setup() {
225 debug "Executing script $script"
227 [[ $DEBUG == 1 ]] && opts="$opts -x"
228 pushd $BUILDDIR &>/dev/null
229 $BASH $opts $script \
231 || { rc=$?; error "Script $script failed"; }
237 # process all fragments
238 FRAGMENTS_BBLAYERS=""
239 FRAGMENTS_LOCALCONF=""
241 function process_fragments() {
243 debug "processing fragments in dir $dir"
245 verbose " Searching fragments: $dir"
247 # lookup for files with priorities specified: something like xx_bblayers.conf.yyyyy.inc
248 for x in $(ls $dir/??[._]bblayers.conf*.inc 2>/dev/null); do
249 FRAGMENTS_BBLAYERS="$FRAGMENTS_BBLAYERS $(basename $x):$x"
250 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
253 # same for local.conf
254 for x in $(ls $dir/??[._]local.conf*.inc 2>/dev/null); do
255 FRAGMENTS_LOCALCONF="$FRAGMENTS_LOCALCONF $(basename $x):$x"
256 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
260 for x in $(ls $dir/??[._]setup*.sh 2>/dev/null); do
261 FRAGMENTS_SETUP="$FRAGMENTS_SETUP $(basename $x):$x"
262 verbose " priority $(basename $x | cut -c1-2): $(basename $x)"
267 function containsFeature () {
268 for feature in $1; do
269 [[ "$feature" == "$2" ]] && return 1;
274 function find_feature_dependency() {
276 featuredir=$(find_feature_dir $1)
278 if [ -e $featuredir/included.dep ]; then
279 dep_features="$(cat $featuredir/included.dep)"
280 for dep_feature in $dep_features; do
281 full_feature="$full_feature $res_dep_features"
282 res_dep_features="$res_dep_features $dep_feature"
283 if containsFeature $dep_feature $full_feature ; then
284 res_dep_features="$res_dep_features $(find_feature_dependency $dep_feature $full_feature)"
288 echo "$res_dep_features";
293 debug "Parsing arguments: $@"
294 TEMP=$(getopt -o m:b:r:s:fvdh --long machine:,builddir:,rpm-revision:,script:,force,verbose,debug,help -n $SCRIPT -- "$@")
295 [[ $? != 0 ]] && { usage; exit 1; }
300 ### default options values
301 MACHINE=$DEFAULT_MACHINE
302 BUILDDIR=$DEFAULT_BUILDDIR
306 SETUP_MANIFEST=aglsetup.manifest
310 -m|--machine) MACHINE=$2; shift 2;;
311 -b|--builddir) BUILDDIR=$2; shift 2;;
312 -s|--setupscript) SETUPSCRIPT=$2; shift 2;;
313 -f|--force) FORCE=1; shift;;
314 -r|--rpm-revision) RPMREVISION=$2; shift 2;;
315 -v|--verbose) VERBOSE=1; shift;;
316 -d|--debug) VERBOSE=1; DEBUG=1; shift;;
317 -h|--help) HELP=1; shift;;
319 *) error "Arguments parsing error"; exit 1;;
323 [[ "$HELP" == 1 ]] && { usage; exit 0; }
325 verbose "Command line arguments: ${GLOBAL_ARGS[@]}"
327 # the remaining args are the features
330 # validate the machine list
331 debug "validating machines list"
334 # validate the machine
335 debug "validating machine $MACHINE"
336 find_machine_dir $MACHINE >/dev/null || error "Machine '$MACHINE' not found in [ $(list_all_machines)]"
338 # validate the features list
339 debug "validating features list"
343 for FEATURE in $FEATURES;do
344 TMP_FEATURES="$TMP_FEATURES $FEATURE"
345 TMP_FEATURES="$TMP_FEATURES $(find_feature_dependency $FEATURE $TMP_FEATURES)"
347 # remove duplicate features if any
348 FEATURES=$(for x in $TMP_FEATURES; do echo $x; done | sort -u | awk '{printf("%s ",$1);}')
350 # validate the features
351 for f in $FEATURES; do
352 debug "validating feature $f"
353 find_feature_dir $f >/dev/null || error "Feature '$f' not found in [ $(list_all_features)]"
357 debug "validating builddir $BUILDDIR"
358 BUILDDIR=$(mkdir -p "$BUILDDIR" && cd "$BUILDDIR" && pwd -P)
361 ###########################################################################################
362 function dump_log() {
363 info " ------------ $(basename $1) -----------------"
365 info " ----------------------------------------"
368 function genconfig() {
369 info "Generating configuration files:"
370 info " Build dir: $BUILDDIR"
371 info " Machine: $MACHINE"
372 info " Features: $FEATURES"
374 # step 1: run usual OE setup to generate conf dir
375 export TEMPLATECONF=$(cd $SCRIPTDIR/../templates/base && pwd -P)
376 debug "running oe-init-build-env with TEMPLATECONF=$TEMPLATECONF"
377 info " Running $METADIR/poky/oe-init-build-env"
378 info " Templates dir: $TEMPLATECONF"
381 . $METADIR/poky/oe-init-build-env $BUILDDIR >/dev/null
384 # step 2: concatenate other remaining fragments coming from base
385 process_fragments $TEMPLATECONF
387 # step 3: fragments for machine
388 process_fragments $(find_machine_dir $MACHINE)
390 # step 4: fragments for features
391 for feature in $FEATURES; do
392 process_fragments $(find_feature_dir $feature)
395 # step 5: sort fragments and append them in destination files
396 FRAGMENTS_BBLAYERS=$(sed 's/ /\n/g' <<<$FRAGMENTS_BBLAYERS | sort)
397 debug "bblayer fragments: $FRAGMENTS_BBLAYERS"
398 info " Config: $BUILDDIR/conf/bblayers.conf"
399 for x in $FRAGMENTS_BBLAYERS; do
401 append_fragment $BUILDDIR/conf/bblayers.conf $file
405 FRAGMENTS_LOCALCONF=$(sed 's/ /\n/g' <<<$FRAGMENTS_LOCALCONF | sort)
406 debug "localconf fragments: $FRAGMENTS_LOCALCONF"
407 info " Config: $BUILDDIR/conf/local.conf"
408 for x in $FRAGMENTS_LOCALCONF; do
410 append_fragment $BUILDDIR/conf/local.conf $file
413 # special fragment to call distro-manifest-generator.sh from
414 # meta-agl-profile-core/recipes-core/distro-build-manifest/distro-build-manifest.bb
415 append_fragment $BUILDDIR/conf/local.conf /dev/stdin "# generated by $(realpath $BASH_SOURCE)" <<-EOF
416 DISTRO_SETUP_MANIFEST = "$(realpath -Ls $BUILDDIR)/$SETUP_MANIFEST"
417 DISTRO_MANIFEST_GENERATOR = "$(dirname $(realpath $BASH_SOURCE))/distro-manifest-generator.sh"
420 FRAGMENTS_SETUP=$(sed 's/ /\n/g' <<<$FRAGMENTS_SETUP | sort)
421 debug "setup fragments: $FRAGMENTS_SETUP"
422 cat <<EOF >$BUILDDIR/conf/setup.sh
425 # this script has been generated by $BASH_SOURCE
427 export MACHINE="$MACHINE"
428 export FEATURES="$FEATURES"
429 export BUILDDIR="$BUILDDIR"
430 export METADIR="$METADIR"
431 export RPMREVISION="$RPMREVISION"
432 export LOCALCONF="$BUILDDIR/conf/local.conf"
434 echo "--- beginning of setup script"
436 info " Setup script: $BUILDDIR/conf/setup.sh"
437 for x in $FRAGMENTS_SETUP; do
439 append_fragment $BUILDDIR/conf/setup.sh $file "echo '--- fragment $file'"
442 append_fragment $BUILDDIR/conf/setup.sh "" "echo '--- end of setup script'"
444 infon " Executing setup script ... "
445 execute_setup $BUILDDIR/conf/setup.sh 2>&1 | tee $BUILDDIR/conf/setup.log
446 [[ ${PIPESTATUS[0]} == 0 ]] && {
448 [[ $VERBOSE == 1 ]] && dump_log $BUILDDIR/conf/setup.log
449 rm $BUILDDIR/conf/setup.sh
452 info "FAIL: please check $BUILDDIR/conf/setup.log"
453 dump_log $BUILDDIR/conf/setup.log
458 ###########################################################################################
460 # check for overwrite
461 [[ $FORCE -eq 1 ]] && rm -f \
462 $BUILDDIR/conf/local.conf \
463 $BUILDDIR/conf/bblayers.conf \
464 $BUILDDIR/conf/setup.* \
467 ####### step 1: generate configuration file #######
469 if [[ -f $BUILDDIR/conf/local.conf || -f $BUILDDIR/conf/bblayers.conf ]]; then
470 info "Configuration files already exist:"
471 for x in $BUILDDIR/conf/local.conf $BUILDDIR/conf/bblayers.conf; do
472 [[ -f $x ]] && info " - $x"
474 info "Skipping configuration files generation."
475 info "Use option -f|--force to overwrite existing configuration."
480 ####### step 2: generate aglsetup.manifest #######
482 infon "Generating setup manifest: $BUILDDIR/$SETUP_MANIFEST ... "
483 for x in /etc/os-release /usr/lib/os-release; do
486 FEATURES_md5=$(echo $FEATURES|md5sum -|awk '{print $1;}')
487 cat <<EOF >$BUILDDIR/$SETUP_MANIFEST
488 # ----------------------------------------------
489 # This fragment has been generated by $SCRIPT at setup time
492 DIST_DISTRO_NAME="AGL"
494 # target machine as passed to $SCRIPT
495 DIST_MACHINE="$MACHINE"
497 # features as resolved by $SCRIPT
498 DIST_FEATURES="$FEATURES"
499 DIST_FEATURES_MD5="${FEATURES_md5}"
501 # build host information deduced from os-release
502 DIST_BUILD_HOST="$(id -un)@$(hostname -f || hostname || hostname -s)"
503 DIST_BUILD_OS="${PRETTY_NAME:-${NAME} ${VERSION} [COMPUTED]}"
506 DIST_METADIR="$METADIR"
509 DIST_SETUP_TS="$(date -u +%Y%m%d_%H%M%S_%Z)"
511 # ------------ end of $SCRIPT fragment --------
515 ####### step 3: generate agl-init-build-env #######
517 # always generate setup script in builddir: it can be sourced later manually without re-running the setup
518 infon "Generating setup file: $BUILDDIR/agl-init-build-env ... "
520 cat <<EOF >$BUILDDIR/agl-init-build-env
521 . $METADIR/poky/oe-init-build-env $BUILDDIR
522 if [ -n "\$DL_DIR" ]; then
523 BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE DL_DIR"
525 if [ -n "\$SSTATE_DIR" ]; then
526 BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE SSTATE_DIR"
528 export BB_ENV_EXTRAWHITE
533 ####### step 4: generate output script #######
535 # finally, generate output script if requested by caller
536 if [[ -n "$SETUPSCRIPT" ]]; then
537 debug "generating setupscript in $SETUPSCRIPT"
538 cat <<EOF >$SETUPSCRIPT
539 . $BUILDDIR/agl-init-build-env
543 info "------------ $SCRIPT: Done"