4 # Copyright (c) 2013-2017 Vojtech Horky
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
11 # - Redistributions of source code must retain the above copyright
12 # notice, this list of conditions and the following disclaimer.
13 # - Redistributions in binary form must reproduce the above copyright
14 # notice, this list of conditions and the following disclaimer in the
15 # documentation and/or other materials provided with the distribution.
16 # - The name of the author may not be used to endorse or promote products
17 # derived from this software without specific prior written permission.
19 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 # Calling harbour functions:
32 # These functions are always called in a subshell to "guard" them a little
33 # bit (variables set by the harbour, cd into package directory).
35 # Notice on usage of set -o errexit (set -e)
36 # We want to use that option for the harbour scripts to get rid of the
37 # "|| return 1" at the end of each line.
38 # Obvious solution is to wrap the call like this:
39 # ( set -o errexit; build ) || { hsct_error "..."; return 1; }
40 # This doesn't work because the whole subshell is then part of a ||
41 # operand and thus the set -e is ignored (even if it is a subshell).
42 # See https://groups.google.com/d/msg/gnu.bash.bug/NCK_0GmIv2M/y6RQF1AWUQkJ
43 # Thus, we need to use the following template to get past this:
44 # ( set -o errexit; build; exit $? );
45 # [ $? -eq 0 ] || { hsct_error "..."; return 1; }
47 # Also notice that we never ever call exit from the top-most shell when
48 # leaving after an error. That is to prevent terminating user shell when
49 # this script is sourced ("env" command). It complicates the error handling
50 # a bit but it is more reliable than trying to guess whether we are running
51 # in a subshell or not.
54 HSCT_HOME
=`which -- "$0" 2>/dev/null`
55 # Maybe, we are running Bash
56 [ -z "$HSCT_HOME" ] && HSCT_HOME
=`which -- "$BASH_SOURCE" 2>/dev/null`
57 HSCT_HOME
=`dirname -- "$HSCT_HOME"`
58 HSCT_HSCT
="$HSCT_HOME/hsct.sh"
60 HSCT_BUILD_DIR
=`pwd`/build
61 HSCT_INCLUDE_DIR
=`pwd`/include
62 HSCT_LIB_DIR
=`pwd`/libs
63 HSCT_DIST_DIR
="`pwd`/dist/"
64 HSCT_ARCHIVE_DIR
="`pwd`/archives/"
65 HSCT_CACHE_DIR
=`pwd`/helenos
68 # Does not exit the whole script.
71 echo " $1 action [package]"
72 echo " Action can be one of following:"
73 echo " clean Clean built directory."
74 echo " fetch Fetch sources (e.g. download from homepage)."
75 echo " build Build given package."
76 echo " package Save installable files to allow cleaning."
77 echo " install Install to uspace/dist of HelenOS."
78 echo " archive Create tarball instead of installing."
79 echo " $1 init [/path/to/HelenOS] [profile]"
80 echo " Initialize current directory as coastline build directory".
81 echo " Full path has to be provided to the HelenOS source tree."
82 echo " If profile is specified, forcefully rebuild to specified profile."
83 echo " If no argument is provided, path to HelenOS source tree is"
84 echo " read from the HELENOS_ROOT environment variable."
86 echo " Display this help and exit."
89 # Print high-level information message.
94 # Print lower-level information message (additional info after hsct_info).
99 # Print information message from HARBOUR script.
104 # Print high-level error message.
106 echo "[hsct]:" "Error:" "$@" >&2
109 # Print additional details to the error message.
111 echo "[hsct]:" " -> " "$@" >&2
114 # Run a command but print it first.
118 echo -n "$___i" |
sed -e 's#"#\\"#g' -e 's#.*#"&" #'
124 # Run comman from HARBOUR script and print it as well.
129 hsct_process_harbour_opts
() {
130 HSCT_OPTS_NO_DEPENDENCY_BUILDING
=false
131 HSCT_OPTS_NO_FILE_DOWNLOADING
=false
134 while [ "$#" -ne 0 ]; do
137 HSCT_OPTS_NO_DEPENDENCY_BUILDING
=true
140 HSCT_OPTS_NO_FILE_DOWNLOADING
=true
143 hsct_error
"Unknown option $1."
147 if [ -z "$HSCT_HARBOUR_NAME" ]; then
148 HSCT_HARBOUR_NAME
="$1"
150 hsct_error
"Only one package name allowed."
161 # Fetch all the specified files in the HARBOUR
163 mkdir
-p "$HSCT_SOURCES_DIR"
164 hsct_info
"Fetching sources..."
165 for _url
in $shipsources; do
166 _filename
=`basename "$_url"`
167 if [ "$_filename" = "$_url" ]; then
170 if ! [ -r "$HSCT_SOURCES_DIR/$_filename" ]; then
171 if $HSCT_OPTS_NO_FILE_DOWNLOADING; then
172 hsct_error
"File $_filename missing, cannot continue."
173 hsct_error2
"Build without --no-fetch."
177 hsct_info2
"Fetching $_filename..."
178 # Remove the file even on Ctrl-C when fetching
179 trap "rm -f \"$HSCT_SOURCES_DIR/$_filename\"; echo" SIGINT SIGQUIT
180 if ! wget
$HSCT_WGET_OPTS "$_url" -O "$HSCT_SOURCES_DIR/$_filename"; then
181 rm -f "$HSCT_SOURCES_DIR/$_filename"
182 hsct_error
"Failed to fetch $_url."
185 trap - SIGINT SIGQUIT
192 # Remove the build directory of given package.
194 hsct_info
"Cleaning build directory..."
195 rm -rf "$HSCT_BUILD_DIR/$shipname/"*
200 mkdir
-p "$HSCT_BUILD_DIR/$shipname"
201 if [ -e "$HSCT_BUILD_DIR/${shipname}.built" ]; then
202 hsct_info
"No need to build $shipname."
206 # Check for prerequisities
207 for tug
in $shiptugs; do
208 if ! [ -e "$HSCT_BUILD_DIR/${tug}.packaged" ]; then
209 if $HSCT_OPTS_NO_DEPENDENCY_BUILDING; then
210 hsct_error
"Dependency $tug not built, cannot continue."
211 hsct_error2
"Build $tug first or run without --no-deps."
214 hsct_info
"Need to build $tug first."
215 hsct_info2
"Running $HSCT_HSCT package $tug"
217 $HSCT_HSCT package
$tug
220 if [ $?
-ne 0 ]; then
221 hsct_error
"Failed to package dependency $tug."
222 hsct_error2
"Cannot continue building $shipname."
225 hsct_info2
"Back from building $tug."
229 hsct_fetch ||
return 1
231 for _url
in $shipsources; do
232 _filename
=`basename "$_url"`
233 if [ "$_filename" = "$_url" ]; then
234 _origin
="$HSCT_HOME/$shipname/$_filename"
236 _origin
="$HSCT_SOURCES_DIR/$_filename"
238 ln -srf "$_origin" "$HSCT_BUILD_DIR/$shipname/$_filename"
242 cd "$HSCT_BUILD_DIR/$shipname/"
243 hsct_info
"Building..."
248 if [ $?
-ne 0 ]; then
249 hsct_error
"Build failed!"
252 touch "$HSCT_BUILD_DIR/${shipname}.built"
256 # Pseudo-installation - copy from build directory to "my" directory, copy libraries
258 mkdir
-p "$HSCT_INCLUDE_DIR" ||
{ hsct_error
"Failed to create include directory."; return 1; }
259 mkdir
-p "$HSCT_LIB_DIR" ||
{ hsct_error
"Failed to create library directory."; return 1; }
260 mkdir
-p "$HSCT_MY_DIR" ||
{ hsct_error
"Failed to create package directory."; return 1; }
262 if [ -e "$HSCT_BUILD_DIR/${shipname}.packaged" ]; then
263 hsct_info
"No need to package $shipname."
267 hsct_build ||
return 1
270 cd "$HSCT_BUILD_DIR/$shipname/"
271 hsct_info
"Packaging..."
276 if [ $?
-ne 0 ]; then
277 hsct_error
"Packaging failed!"
280 touch "$HSCT_BUILD_DIR/${shipname}.packaged"
284 # Install the package to HelenOS source tree (to uspace/overlay).
286 hsct_package ||
return 1
288 hsct_info
"Installing..."
289 if ls "$HSCT_MY_DIR"/* &>/dev
/null
; then
290 mkdir
-p "$HSCT_OVERLAY"
291 cp -v -r -L "$HSCT_MY_DIR"/* "$HSCT_OVERLAY" ||
return 1
292 hsct_info2
"Do not forget to rebuild the image."
294 hsct_info2
"Note: nothing to install."
299 # Create tarball to allow redistribution of the build packages
301 hsct_package ||
return 1
303 hsct_info
"Creating the archive..."
304 mkdir
-p "$HSCT_ARCHIVE_DIR"
307 cd "$HSCT_DIST_DIR/$shipname"
308 case "$HSCT_FORMAT" in
310 tar czf
"$HSCT_ARCHIVE_DIR/$shipname.tar.gz" .
313 tar cJf
"$HSCT_ARCHIVE_DIR/$shipname.tar.xz" .
316 hsct_info
"Unknown archive_format $HSCT_FORMAT."
321 if [ $?
-ne 0 ]; then
322 hsct_error
"Archiving failed!"
331 HSCT_CONFIG
="./config.sh"
333 HSCT_SOURCES_DIR
=`pwd`/sources
335 HSCT_PARALLELISM
=`nproc`
338 if [ -e "$HSCT_CONFIG" ]; then
344 echo "HSCT_WGET_OPTS=\"${HSCT_WGET_OPTS}\"" >> "${HSCT_CONFIG}.new"
345 echo "HSCT_SOURCES_DIR=\"${HSCT_SOURCES_DIR}\"" >> "${HSCT_CONFIG}.new"
346 echo "HSCT_FORMAT=\"${HSCT_FORMAT}\"" >> "${HSCT_CONFIG}.new"
347 echo "HSCT_PARALLELISM=\"${HSCT_PARALLELISM}\"" >> "${HSCT_CONFIG}.new"
348 echo "HELENOS_ROOT=\"${HELENOS_ROOT}\"" >> "${HSCT_CONFIG}.new"
349 mv "${HSCT_CONFIG}.new" "${HSCT_CONFIG}"
352 # Initialize current directory for coastline building.
359 if [ -z "$_root_dir" ]; then
360 # Try to get HELENOS_ROOT from the environment if not specified.
361 _root_dir
="$HELENOS_ROOT"
364 if [ -z "$_root_dir" ]; then
365 hsct_error
"HELENOS_ROOT is not set. Either set the environment variable, or specify it on the command line.";
369 _root_dir
=`( cd "$_root_dir"; pwd ) 2>/dev/null`
370 if ! [ -e "$_root_dir/HelenOS.config" ]; then
371 hsct_error
"$_root_dir does not look like a valid HelenOS directory.";
375 HELENOS_ROOT
="$_root_dir"
377 hsct_info
"Initializing this build directory."
379 EXPORT_DIR
=`pwd`/helenos
382 if [ -z $profile ]; then
383 hsct_info2
"Reusing existing configuration."
384 make -j`nproc` export-posix
"EXPORT_DIR=$EXPORT_DIR" HANDS_OFF
=y
>/dev
/null
2>&1
386 hsct_info2
"Cleaning previous configuration in $PWD."
387 make distclean
>/dev
/null
2>&1
388 hsct_info2
"Configuring for $profile."
389 make -j`nproc` export-posix
"EXPORT_DIR=$EXPORT_DIR" "PROFILE=$profile" HANDS_OFF
=y
>/dev
/null
2>&1
392 if [ $?
-ne 0 ]; then
393 hsct_error
"Failed to automatically configure HelenOS for profile '$profile'."
397 hsct_info
"Creating facade toolchain."
399 facade_path
="$PWD/facade"
404 if [ -z "$HELENOS_ARCH" ]; then
405 hsct_error
"HELENOS_ARCH undefined."
410 install -m 755 "$x" "$facade_path/$HELENOS_ARCH-helenos-$x"
419 alias leave_script_ok
='return 0 2>/dev/null || exit 0'
420 alias leave_script_err
='return 1 2>/dev/null || exit 1'
423 # This is separate from the rest, so that the user can run
424 # eval `path/to/hsct.sh vars` to get these vars in interactive shell.
427 HELENOS_EXPORT_ROOT
="$HSCT_CACHE_DIR"
428 HELENOS_CONFIG
="$HSCT_CACHE_DIR/config.rc"
430 if ! [ -e "$HELENOS_CONFIG" ]; then
431 hsct_error
"Configuration not found. Maybe you need to run init first?"
436 echo "export HELENOS_EXPORT_ROOT='$HSCT_CACHE_DIR'"
437 echo "export HSCT_REAL_CC='$HELENOS_TARGET-gcc'"
438 echo "export HSCT_REAL_CXX='$HELENOS_TARGET-g++'"
440 echo "export HSCT_ARFLAGS='$HELENOS_ARFLAGS'"
441 echo "export HSCT_CPPFLAGS='-isystem $HSCT_INCLUDE_DIR $HELENOS_CPPFLAGS'"
442 echo "export HSCT_CFLAGS='$HELENOS_CFLAGS'"
443 echo "export HSCT_CXXFLAGS='$HELENOS_CXXFLAGS'"
444 echo "export HSCT_ASFLAGS='$HELENOS_ASFLAGS'"
445 echo "export HSCT_LDFLAGS='-L $HSCT_LIB_DIR $HELENOS_LDFLAGS'"
446 echo "export HSCT_LDLIBS='$HELENOS_LDLIBS'"
448 target
="$HELENOS_ARCH-helenos"
449 cvars
="CC=$target-cc CXX=$target-cxx AR=$target-ar AS=$target-as CPP=$target-cpp NM=$target-nm OBJDUMP=$target-objdump OBJCOPY=$target-objcopy STRIP=$target-strip RANLIB=$target-ranlib"
451 echo "export HSCT_CC='$target-cc'"
452 echo "export HSCT_CXX='$target-cxx'"
453 echo "export HSCT_TARGET='$target'"
454 echo "export HSCT_REAL_TARGET='$HELENOS_TARGET'"
455 echo "export HSCT_CONFIGURE_VARS='$cvars'"
456 echo "export HSCT_CONFIGURE_ARGS='--build=`sh $HSCT_HOME/config.guess` --host=$target $cvars'"
458 echo "export PATH='$PWD/facade:$HELENOS_CROSS_PATH:$PATH'"
462 eval `hsct_print_vars`
466 HELENOS_CONFIG
="$HSCT_CACHE_DIR/config.rc"
468 if ! [ -e "$HELENOS_CONFIG" ]; then
469 hsct_error
"Configuration not found. Maybe you need to run init first?"
474 HSCT_MY_DIR
="$HSCT_DIST_DIR/$HSCT_HARBOUR_NAME"
475 HSCT_OVERLAY
="$HELENOS_ROOT/uspace/overlay"
476 HSCT_CONFIG_SUB
="$HSCT_HOME/config.sub"
478 if ! [ "$HSCT_PARALLELISM" -ge 0 ] 2>/dev
/null
; then
482 if ! [ -d "$HSCT_HOME/$HSCT_HARBOUR_NAME" ]; then
483 hsct_error
"Unknown package $HSCT_HARBOUR_NAME."
487 if ! [ -r "$HSCT_HOME/$HSCT_HARBOUR_NAME/HARBOUR" ]; then
488 hsct_error
"HARBOUR file missing." >&2
492 # Source the harbour to get access to the variables and functions
493 .
"$HSCT_HOME/$HSCT_HARBOUR_NAME/HARBOUR"
495 if [ "$shipfunnels" -ne "1" ] 2>/dev
/null
; then
496 shipfunnels
="$HSCT_PARALLELISM"
499 case "$HSCT_ACTION" in
519 hsct_error
"Internal error, we shall not get to this point!"
529 case "$HSCT_ACTION" in
530 clean|fetch|build|package|
install|archive
)
532 if ! hsct_process_harbour_opts
"$@"; then
535 if [ -z "$HSCT_HARBOUR_NAME" ]; then
547 hsct_init
"$2" "$3" "$4"