1 # This file contains some usefull common functions -*- sh -*-
2 # Copyright 2007 Yann E. MORIN
3 # Licensed under the GPL v2. See COPYING in the root of this package
5 # Prepare the fault handler
14 # Bail out early in subshell, the upper level shell will act accordingly.
15 [ ${BASH_SUBSHELL} -eq 0 ] || exit $ret
17 # Print steps backtrace
18 step_depth=${CT_STEP_COUNT}
22 for((step=step_depth; step>1; step--)); do
23 CT_DoLog ERROR ">> ${intro} in step '${CT_STEP_MESSAGE[${step}]}'"
27 # Print functions backtrace
28 intro="Error happened in"
31 for((depth=1; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
32 file="${BASH_SOURCE[${depth}]#${CT_LIB_DIR}/}"
35 *) line="@${BASH_LINENO[${depth}-1]}"
37 func="${FUNCNAME[${depth}]}"
38 CT_DoLog ERROR ">> ${intro}: ${func}[${file}${line}]"
42 # Help diagnose the error
44 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
45 CT_DoLog ERROR ">> For more info on this error, look at the file: '${tmp_log_file#${CT_TOP_DIR}/}'"
47 CT_DoLog ERROR ">> There is a list of known issues, some with workarounds, in:"
48 CT_DoLog ERROR ">> '${CT_DOC_DIR#${CT_TOP_DIR}/}/B - Known issues.txt'"
51 CT_DoLog ERROR "Build failed in step '${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}'"
58 # Install the fault handler
61 # Inherit the fault handler in subshells and functions
64 # Make pipes fail on the _first_ failed command
65 # Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x
68 # Don't hash commands' locations, and search every time it is requested.
69 # This is slow, but needed because of the static/shared core gcc which shall
70 # always match to shared if it exists, and only fallback to static if the
75 # - first of all, save stdout so we can see the live logs: fd #6
77 # - then point stdout to the log file
78 tmp_log_file="${CT_TOP_DIR}/build.log"
79 rm -f "${tmp_log_file}"
80 exec >>"${tmp_log_file}"
82 # The different log levels:
93 # Make it easy to use \n and !
97 # A function to log what is happening
98 # Different log level are available:
99 # - ERROR: A serious, fatal error occurred
100 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
101 # - INFO: Informational messages
102 # - EXTRA: Extra informational messages
103 # - CFG: Output of various "./configure"-type scripts
104 # - FILE: File / archive unpacking.
105 # - STATE: State save & restore
106 # - ALL: Component's build messages
107 # - DEBUG: Internal debug messages
108 # Usage: CT_DoLog <level> [message]
109 # If message is empty, then stdin will be logged.
111 local max_level LEVEL level cur_l cur_L
113 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
114 # Set the maximum log level to DEBUG if we have none
115 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
118 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
120 if [ $# -eq 0 ]; then
124 fi |( IFS="${CR}" # We want the full lines, even leading spaces
130 indent=$((2*CT_STEP_COUNT))
132 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
133 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
134 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
135 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
136 *"make["*"]: *** ["*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
137 *) cur_L="${LEVEL}"; cur_l="${level}";;
139 # There will always be a log file (stdout, fd #1), be it /dev/null
140 printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"
141 if [ ${cur_l} -le ${max_level} ]; then
142 # Only print to console (fd #6) if log level is high enough.
143 printf "${CT_LOG_PROGRESS_BAR:+\r}[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6
145 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
146 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6
147 _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))
155 # Execute an action, and log its messages
156 # It is possible to even log local variable assignments (a-la: var=val ./cmd opts)
157 # Usage: CT_DoExecLog <level> [VAR=val...] <command> [parameters...]
167 *=*) eval export "'${1}'"; shift;;
171 CT_DoLog DEBUG "==> Executing: ${tmp_log}"
172 "${@}" 2>&1 |CT_DoLog "${level}"
174 # Catch failure of the sub-shell
178 # Tail message to be logged whatever happens
179 # Usage: CT_DoEnd <level>
183 CT_STOP_DATE=$(CT_DoDate +%s%N)
184 CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)
185 if [ "${level}" != "ERROR" ]; then
186 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
188 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
189 elapsed_min=$((elapsed/(60*1000*1000*1000)))
190 elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))
191 elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))
192 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
195 # Remove entries referring to . and other relative paths
196 # Usage: CT_SanitizePath
202 # Only accept absolute paths;
203 # Note: as a special case the empty string in PATH is equivalent to .
204 if [ -n "${p}" -a -z "${p%%/*}" ]; then
205 new="${new}${new:+:}${p}"
211 # Sanitise the directory name contained in the variable passed as argument:
212 # - remove duplicate /
213 # Usage: CT_SanitiseVarDir CT_PREFIX_DIR
214 CT_SanitiseVarDir() {
220 eval "old_dir=\"\${${var}}\""
221 new_dir="$( printf "${old_dir}" \
222 |sed -r -e 's:/+:/:g;' \
224 eval "${var}=\"${new_dir}\""
225 CT_DoLog DEBUG "Sanitised '${var}': '${old_dir}' -> '${new_dir}'"
229 # Abort the execution with an error message
230 # Usage: CT_Abort <message>
236 # Test a condition, and print a message if satisfied
237 # Usage: CT_Test <message> <tests>
242 CT_DoLog DEBUG "Testing '! ( $* )'"
243 test "$@" && CT_DoLog WARN "$m"
247 # Test a condition, and abort with an error message if satisfied
248 # Usage: CT_TestAndAbort <message> <tests>
252 CT_DoLog DEBUG "Testing '! ( $* )'"
253 test "$@" && CT_Abort "$m"
257 # Test a condition, and abort with an error message if not satisfied
258 # Usage: CT_TestAndAbort <message> <tests>
262 CT_DoLog DEBUG "Testing '$*'"
263 test "$@" || CT_Abort "$m"
267 # Test the presence of a tool, or abort if not found
268 # Usage: CT_HasOrAbort <tool>
270 CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z "$(CT_Which "${1}")"
274 # Search a program: wrap "which" for those system where
275 # "which" verbosely says there is no match (Mandriva is
277 # Usage: CT_Which <filename>
279 which "$1" 2>/dev/null || true
282 # Get current date with nanosecond precision
283 # On those system not supporting nanosecond precision, faked with rounding down
284 # to the highest entire second
285 # Usage: CT_DoDate <fmt>
287 date "$1" |sed -r -e 's/%?N$/000000000/;'
291 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
292 # Memorise a step being done so that any error is caught
293 # Usage: CT_DoStep <loglevel> <message>
295 local start=$(CT_DoDate +%s%N)
296 CT_DoLog "$1" "================================================================="
298 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
299 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
300 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
301 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
305 # End the step just being done
308 local stop=$(CT_DoDate +%s%N)
309 local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
310 local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
311 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
312 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
313 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
314 CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
318 # Pushes into a directory, and pops back
320 pushd "$1" >/dev/null 2>&1
326 # Creates a temporary directory
327 # $1: variable to assign to
328 # Usage: CT_MktempDir foo
330 # Some mktemp do not allow more than 6 Xs
331 eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")
332 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
333 CT_DoLog DEBUG "Made temporary directory '${!1}'"
337 # Removes one or more directories, even if it is read-only, or its parent is
338 # Usage: CT_DoForceRmdir dir [...]
342 for dir in "${@}"; do
343 [ -d "${dir}" ] || continue
346 mode="$(stat -c '%a' "$(dirname "${dir}")")"
349 mode="$(stat -f '%Lp' "$(dirname "${dir}")")"
352 CT_Abort "Unhandled host OS $CT_SYS_OS"
355 CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"
356 CT_DoExecLog ALL chmod -R u+w "${dir}"
357 CT_DoExecLog ALL rm -rf "${dir}"
358 CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"
362 # Echoes the specified string on stdout until the pipe breaks.
365 # Usage: CT_DoYes "" |make oldconfig
370 # Add the specified directory to LD_LIBRARY_PATH, and export it
371 # If the specified patch is already present, just export
373 # $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty
374 # Usage CT_SetLibPath /some/where/lib [first|last]
379 case ":${LD_LIBRARY_PATH}:" in
383 CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"
384 LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"
387 CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"
388 LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"
391 CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"
396 CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"
397 export LD_LIBRARY_PATH
400 # Get the file name extension of a component
401 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
402 # If found, echoes the extension to stdout, and return 0
403 # If not found, echoes nothing on stdout, and return !0.
404 CT_GetFileExtension() {
410 # we need to also check for an empty extension for those very
411 # peculiar components that don't have one (such as sstrip from
413 for ext in ${first_ext} .tar.gz .tar.bz2 .tgz .tar /.git ''; do
414 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
423 # Try to retrieve the specified URL (HTTP or FTP)
424 # Usage: CT_DoGetFile <URL>
425 # This functions always returns true (0), as it can be legitimate not
426 # to find the requested URL (think about snapshots, different layouts
427 # for different gcc versions, etc...).
430 local tmp="${dest}.tmp-dl"
431 # OK, just look if we have them...
432 # We are sure at least one is available, ./configure checked for it.
433 local _curl=$(CT_Which curl)
434 local _wget=$(CT_Which wget)
435 _curl="${_curl:-false}"
436 _wget="${_wget:-false}"
438 # Remove potential left-over from a previous run
441 # Some (very old!) FTP server might not support the passive mode, thus
443 # We also retry a few times, in case there is a transient error (eg. behind
444 # a dynamic IP that changes during the transfer...)
445 # With automated download as we are doing, it can be very dangerous to
446 # continue the downloads. It's far better to simply overwrite the
448 # Some company networks have firewalls to connect to the internet, but it's
449 # not easy to detect them, and wget does not timeout by default while
450 # connecting, so force a global ${CT_CONNECT_TIMEOUT}-second timeout.
451 # For curl, no good progress indicator is available. So, be silent.
452 if CT_DoExecLog ALL "${_curl}" --ftp-pasv --retry 3 --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f -s -o "${tmp}" "$1" \
453 || CT_DoExecLog ALL "${_curl}" --retry 3 --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f -s -o "${tmp}" "$1" \
454 || CT_DoExecLog ALL "${_wget}" --passive-ftp --tries=3 -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary -O "${tmp}" "$1" \
455 || CT_DoExecLog ALL "${_wget}" --tries=3 -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary -O "${tmp}" "$1" \
457 # One of them succeeded, good!
458 mv "${tmp}" "${dest}"
465 # This function tries to retrieve a tarball form a local directory
466 # Usage: CT_GetLocal <basename> [.extension]
472 # Do we already have it in *our* tarballs dir?
473 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
474 CT_DoLog DEBUG "Already have '${basename}'"
478 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
479 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
480 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
481 # or, as a failover, a file without extension.
482 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
483 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
484 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
485 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
486 CT_DoLog DEBUG "Got '${basename}' from local storage"
487 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
495 # This function saves the specified to local storage if possible,
496 # and if so, symlinks it for later usage
497 # Usage: CT_SaveLocal </full/path/file.name>
500 local basename="${file##*/}"
502 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
503 CT_DoLog EXTRA "Saving '${basename}' to local storage"
504 # The file may already exist if downloads are forced: remove it first
505 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
506 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
507 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
511 # Download the file from one of the URLs passed as argument
512 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
515 local url URLS LAN_URLS
519 # If next argument starts with a dot, then this is not an URL,
520 # and we can consider that it is a preferred extension.
527 # Does it exist localy?
528 CT_GetLocal "${file}" ${first_ext} && return 0 || true
531 # Try to retrieve the file
532 CT_DoLog EXTRA "Retrieving '${file}'"
536 # Add URLs on the LAN mirror
538 if [ "${CT_USE_MIRROR}" = "y" ]; then
539 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
540 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}/${file%-*}"
541 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}"
543 if [ "${CT_PREFER_MIRROR}" = "y" ]; then
544 CT_DoLog DEBUG "Pre-pending LAN mirror URLs"
545 URLS="${LAN_URLS} ${URLS}"
547 CT_DoLog DEBUG "Appending LAN mirror URLs"
548 URLS="${URLS} ${LAN_URLS}"
552 # Scan all URLs in turn, and try to grab a tarball from there
553 # Do *not* try git trees (ext=/.git), this is handled in a specific
555 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
556 # Try all urls in turn
557 for url in ${URLS}; do
558 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
559 CT_DoGetFile "${url}/${file}${ext}"
560 if [ -f "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
561 CT_DoLog DEBUG "Got '${file}' from the Internet"
562 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
568 # Just warn, someone may want to catch and handle the error
569 # (eg. glibc/eglibc add-ons can be missing).
570 CT_DoLog WARN "Could not retrieve '${file}'."
574 # Checkout from CVS, and build the associated tarball
575 # The tarball will be called ${basename}.tar.bz2
576 # Prerequisite: either the server does not require password,
577 # or the user must already be logged in.
578 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
579 # If dirname is specified, then module will be renamed to dirname
580 # prior to building the tarball.
581 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
582 # Note: if '=subdir' is given, then it is used instead of 'module'.
587 local tag="${4:+-r ${4}}"
591 # Does it exist localy?
592 CT_GetLocal "${basename}" && return 0 || true
595 CT_DoLog EXTRA "Retrieving '${basename}'"
598 CT_Pushd "${tmp_dir}"
600 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
601 if [ -n "${dirname}" ]; then
604 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
605 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
608 CT_DoExecLog ALL mv "${module}" "${dirname}"
609 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
613 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
616 CT_DoExecLog ALL rm -rf "${tmp_dir}"
619 # Check out from SVN, and build the associated tarball
620 # The tarball will be called ${basename}.tar.bz2
621 # Prerequisite: either the server does not require password,
622 # or the user must already be logged in.
623 # 'rev' is the revision to retrieve
624 # Usage: CT_GetSVN <basename> <url> [rev]
630 # Does it exist localy?
631 CT_GetLocal "${basename}" && return 0 || true
634 CT_DoLog EXTRA "Retrieving '${basename}'"
637 CT_Pushd "${tmp_dir}"
639 CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"
640 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
641 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
644 CT_DoExecLog ALL rm -rf "${tmp_dir}"
648 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
649 # Prerequisites: either the server does not require password,
650 # or the user has already taken any action to authenticate to the server.
651 # The cloned tree will *not* be stored in the local tarballs dir!
652 # Usage: CT_GetGit <basename> <url [url ...]>
654 local basename="$1"; shift
658 # Do we have it in our tarballs dir?
659 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
660 CT_DoLog EXTRA "Updating git tree '${basename}'"
661 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
662 CT_DoExecLog ALL git pull
665 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
666 for url in "${@}"; do
667 CT_DoLog ALL "Trying to clone from '${url}'"
668 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
669 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
674 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
679 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
680 # must be extracted in the glibc directory; uCLibc locales must be extracted
681 # in the extra/locale sub-directory of uClibc. This is taken into account
682 # by the caller, that did a 'cd' into the correct path before calling us
683 # and sets nochdir to 'nochdir'.
684 # Note also that this function handles the git trees!
685 # Usage: CT_Extract <basename> [nochdir] [options]
686 # where 'options' are dependent on the source (eg. git branch/tag...)
692 if [ "${nochdir}" = "nochdir" ]; then
696 nochdir="${CT_SRC_DIR}"
702 if ! ext="$(CT_GetFileExtension "${basename}")"; then
703 CT_Abort "'${basename}' not found in '${CT_TARBALLS_DIR}'"
705 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
707 # Check if already extracted
708 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
709 CT_DoLog DEBUG "Already extracted '${basename}'"
713 # Check if previously partially extracted
714 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
715 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
716 CT_DoLog ERROR "Please remove first:"
717 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
718 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
719 CT_Abort "I'll stop now to avoid any carnage..."
721 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
723 CT_Pushd "${nochdir}"
725 CT_DoLog EXTRA "Extracting '${basename}'"
727 .tar.bz2) CT_DoExecLog FILE tar xvjf "${full_file}";;
728 .tar.gz|.tgz) CT_DoExecLog FILE tar xvzf "${full_file}";;
729 .tar) CT_DoExecLog FILE tar xvf "${full_file}";;
730 /.git) CT_ExtractGit "${basename}" "${@}";;
731 *) CT_Abort "Don't know how to handle '${basename}${ext}': unknown extension";;
734 # Don't mark as being extracted for git
737 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
739 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
744 # Create a working git clone
745 # Usage: CT_ExtractGit <basename> [ref]
746 # where 'ref' is the reference to use:
747 # the full name of a branch, like "remotes/origin/branch_name"
748 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
751 local basename="${1}"
756 # pushd now to be able to get git revlist in case ref is a date
757 clone_dir="${CT_TARBALLS_DIR}/${basename}"
758 CT_Pushd "${clone_dir}"
760 # What kind of reference is ${ref} ?
761 if [ -z "${ref}" ]; then
762 # Don't update the clone, keep as-is
764 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
766 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
768 elif date -d "${ref}" >/dev/null 2>&1; then
770 ref=$(git rev-list -n1 --before="${ref}")
772 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
775 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/${basename}"
776 CT_DoExecLog ALL ln -sf "${clone_dir}" "${CT_SRC_DIR}/${basename}"
778 case "${ref_type}" in
780 *) CT_DoExecLog FILE git checkout "${ref}";;
786 # Patches the specified component
787 # See CT_Extract, above, for explanations on 'nochdir'
788 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
789 # If the package directory is *not* packagename-packageversion, then
790 # the caller must cd into the proper directory first, and call us
801 local bundled_patch_dir
802 local local_patch_dir
804 if [ "${nochdir}" = "nochdir" ]; then
808 pkgdir="${pkgname}-${version}"
813 pkgdir="${pkgname}-${version}"
814 nochdir="${CT_SRC_DIR}/${pkgdir}"
817 # Check if already patched
818 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
819 CT_DoLog DEBUG "Already patched '${pkgdir}'"
823 # Check if already partially patched
824 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
825 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
826 CT_DoLog ERROR "Please remove first:"
827 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
828 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
829 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
830 CT_Abort "I'll stop now to avoid any carnage..."
832 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
834 CT_Pushd "${nochdir}"
836 CT_DoLog EXTRA "Patching '${pkgdir}'"
838 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
839 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
841 case "${CT_PATCH_ORDER}" in
842 bundled) patch_dirs=("${bundled_patch_dir}");;
843 local) patch_dirs=("${local_patch_dir}");;
844 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
845 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
849 for d in "${patch_dirs[@]}"; do
850 CT_DoLog DEBUG "Looking for patches in '${d}'..."
851 if [ -n "${d}" -a -d "${d}" ]; then
852 for p in "${d}"/*.patch; do
853 if [ -f "${p}" ]; then
854 CT_DoLog DEBUG "Applying patch '${p}'"
855 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
858 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
864 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
865 CT_DoLog ALL "Overiding config.guess and config.sub"
866 for cfg in config_guess config_sub; do
867 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
868 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
869 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
870 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
874 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
875 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
880 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
881 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
883 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
884 "${CT_TOP_DIR}/scripts/config.guess"
886 "${CT_LIB_DIR}/scripts/config.guess"
891 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
892 "${CT_TOP_DIR}/scripts/config.sub" "$@"
894 "${CT_LIB_DIR}/scripts/config.sub" "$@"
898 # Compute the target tuple from what is provided by the user
899 # Usage: CT_DoBuildTargetTuple
900 # In fact this function takes the environment variables to build the target
901 # tuple. It is needed both by the normal build sequence, as well as the
902 # sample saving sequence.
903 CT_DoBuildTargetTuple() {
904 # Set the endianness suffix, and the default endianness gcc option
905 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
906 y,) target_endian_eb=eb
908 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
909 CT_ARCH_ENDIAN_LDFLAG="-EB"
911 ,y) target_endian_eb=
913 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
914 CT_ARCH_ENDIAN_LDFLAG="-EL"
918 # Build the default architecture tuple part
919 CT_TARGET_ARCH="${CT_ARCH}"
921 # Set defaults for the system part of the tuple. Can be overriden
922 # by architecture-specific values.
924 *glibc) CT_TARGET_SYS=gnu;;
925 uClibc) CT_TARGET_SYS=uclibc;;
926 *) CT_TARGET_SYS=elf;;
929 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
930 unset CT_ARCH_ARCH_CFLAG CT_ARCH_ABI_CFLAG CT_ARCH_CPU_CFLAG CT_ARCH_TUNE_CFLAG CT_ARCH_FPU_CFLAG CT_ARCH_FLOAT_CFLAG
931 unset CT_ARCH_WITH_ARCH CT_ARCH_WITH_ABI CT_ARCH_WITH_CPU CT_ARCH_WITH_TUNE CT_ARCH_WITH_FPU CT_ARCH_WITH_FLOAT
932 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
933 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
934 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
935 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
936 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
937 [ "${CT_ARCH_FLOAT_SW}" ] && { CT_ARCH_FLOAT_CFLAG="-msoft-float"; CT_ARCH_WITH_FLOAT="--with-float=soft"; }
939 # Build the default kernel tuple part
940 CT_TARGET_KERNEL="${CT_KERNEL}"
942 # Overide the default values with the components specific settings
944 CT_DoKernelTupleValues
946 # Finish the target tuple construction
947 CT_TARGET="${CT_TARGET_ARCH}"
948 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
949 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
950 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
954 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
955 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
957 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
958 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
959 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
960 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
961 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
965 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
966 # Prepare the target CFLAGS
967 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
968 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
969 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
970 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
971 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
972 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
973 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
975 # Now on for the target LDFLAGS
976 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
979 # This function does pause the build until the user strikes "Return"
980 # Usage: CT_DoPause [optional_message]
983 local message="${1:-Pausing for your pleasure}"
984 CT_DoLog INFO "${message}"
985 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
989 # This function creates a tarball of the specified directory, but
991 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
992 CT_DoTarballIfExists() {
996 local -a extra_tar_opts=( "$@" )
999 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1000 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
1001 *) compress=( cat - ); tar_ext=;;
1004 if [ -d "${dir}" ]; then
1005 CT_DoLog DEBUG " Saving '${dir}'"
1006 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
1007 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
1008 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1010 CT_DoLog STATE " Not saving '${dir}': does not exist"
1014 # This function extracts a tarball to the specified directory, but
1015 # only if the tarball exists
1016 # Usage: CT_DoExtractTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
1017 CT_DoExtractTarballIfExists() {
1021 local -a extra_tar_opts=( "$@" )
1024 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1025 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
1026 *) uncompress=( cat ); tar_ext=;;
1029 if [ -f "${tarball}.tar${tar_ext}" ]; then
1030 CT_DoLog DEBUG " Restoring '${dir}'"
1031 CT_DoForceRmdir "${dir}"
1032 CT_DoExecLog DEBUG mkdir -p "${dir}"
1033 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
1034 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
1035 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1037 CT_DoLog STATE " Not restoring '${dir}': does not exist"
1041 # This function saves the state of the toolchain to be able to restart
1043 # Usage: CT_DoSaveState <next_step_name>
1045 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
1046 local state_name="$1"
1047 local state_dir="${CT_STATE_DIR}/${state_name}"
1049 # Log this to the log level required by the user
1050 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
1052 rm -rf "${state_dir}"
1053 mkdir -p "${state_dir}"
1055 CT_DoLog STATE " Saving environment and aliases"
1056 # We must omit shell functions, and some specific bash variables
1057 # that break when restoring the environment, later. We could do
1058 # all the processing in the awk script, but a sed is easier...
1061 $0~/^[^ ]+ \(\)/ { _p = 0; }
1063 $0 == "}" { _p = 1; }
1064 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1066 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1068 CT_DoTarballIfExists "${CT_BUILDTOOLS_PREFIX_DIR}" "${state_dir}/buildtools_dir"
1069 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1070 CT_DoTarballIfExists "${CT_CC_CORE_STATIC_PREFIX_DIR}" "${state_dir}/cc_core_static_prefix_dir"
1071 CT_DoTarballIfExists "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${state_dir}/cc_core_shared_prefix_dir"
1072 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1074 CT_DoLog STATE " Saving log file"
1076 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1077 y) gzip -3 -c "${tmp_log_file}" >"${state_dir}/log.gz";;
1078 *) cat "${tmp_log_file}" >"${state_dir}/log";;
1080 exec >>"${tmp_log_file}"
1083 # This function restores a previously saved state
1084 # Usage: CT_DoLoadState <state_name>
1086 local state_name="$1"
1087 local state_dir="${CT_STATE_DIR}/${state_name}"
1088 local old_RESTART="${CT_RESTART}"
1089 local old_STOP="${CT_STOP}"
1091 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1093 # We need to do something special with the log file!
1094 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1095 exec >"${state_dir}/tail.log"
1098 # Log this to the log level required by the user
1099 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1101 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1102 CT_DoExtractTarballIfExists "${state_dir}/cc_core_shared_prefix_dir" "${CT_CC_CORE_SHARED_PREFIX_DIR}"
1103 CT_DoExtractTarballIfExists "${state_dir}/cc_core_static_prefix_dir" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
1104 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1105 CT_DoExtractTarballIfExists "${state_dir}/buildtools_dir" "${CT_BUILDTOOLS_PREFIX_DIR}"
1107 # Restore the environment, discarding any error message
1108 # (for example, read-only bash internals)
1109 CT_DoLog STATE " Restoring environment"
1110 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1112 # Restore the new RESTART and STOP steps
1113 CT_RESTART="${old_RESTART}"
1114 CT_STOP="${old_STOP}"
1115 unset old_stop old_restart
1117 CT_DoLog STATE " Restoring log file"
1119 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1120 y) zcat "${state_dir}/log.gz" >"${tmp_log_file}";;
1121 *) cat "${state_dir}/log" >"${tmp_log_file}";;
1123 cat "${state_dir}/tail.log" >>"${tmp_log_file}"
1124 exec >>"${tmp_log_file}"
1125 rm -f "${state_dir}/tail.log"