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 # Build up the list of allowed tarball extensions
401 # Add them in the prefered order; most preferred comes first
402 CT_DoListTarballExt() {
403 if [ "${CT_CONFIGURE_has_xzutils}" = "y" ]; then
406 if [ "${CT_CONFIGURE_has_lzma}" = "y" \
407 -o "${CT_CONFIGURE_has_xzutils}" = "y" ]; then
411 printf ".tar.gz\n.tgz\n"
415 # Get the file name extension of a component
416 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
417 # If found, echoes the extension to stdout, and return 0
418 # If not found, echoes nothing on stdout, and return !0.
419 CT_GetFileExtension() {
425 # we need to also check for an empty extension for those very
426 # peculiar components that don't have one (such as sstrip from
428 for ext in ${first_ext} $(CT_DoListTarballExt) /.git ''; do
429 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
438 # Try to retrieve the specified URL (HTTP or FTP)
439 # Usage: CT_DoGetFile <URL>
440 # This functions always returns true (0), as it can be legitimate not
441 # to find the requested URL (think about snapshots, different layouts
442 # for different gcc versions, etc...).
445 local dest="${CT_TARBALLS_DIR}/${url##*/}"
446 local tmp="${dest}.tmp-dl"
447 # OK, just look if we have them...
448 # We are sure at least one is available, ./configure checked for it.
449 local _curl=$(CT_Which curl)
450 local _wget=$(CT_Which wget)
451 _curl="${_curl:-false}"
452 _wget="${_wget:-false}"
454 # Remove potential left-over from a previous run
457 # Some (very old!) FTP server might not support the passive mode, thus
459 # We also retry a few times, in case there is a transient error (eg. behind
460 # a dynamic IP that changes during the transfer...)
461 # With automated download as we are doing, it can be very dangerous to
462 # continue the downloads. It's far better to simply overwrite the
464 # Some company networks have firewalls to connect to the internet, but it's
465 # not easy to detect them, and wget does not timeout by default while
466 # connecting, so force a global ${CT_CONNECT_TIMEOUT}-second timeout.
467 # For curl, no good progress indicator is available. So, be silent.
468 if CT_DoExecLog ALL "${_curl}" --ftp-pasv --retry 3 --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f -s -o "${tmp}" "${url}" \
469 || CT_DoExecLog ALL "${_curl}" --retry 3 --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f -s -o "${tmp}" "${url}" \
470 || CT_DoExecLog ALL "${_wget}" --passive-ftp --tries=3 -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary -O "${tmp}" "${url}" \
471 || CT_DoExecLog ALL "${_wget}" --tries=3 -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary -O "${tmp}" "${url}" \
473 # One of them succeeded, good!
474 mv "${tmp}" "${dest}"
481 # This function tries to retrieve a tarball form a local directory
482 # Usage: CT_GetLocal <basename> [.extension]
488 # Do we already have it in *our* tarballs dir?
489 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
490 CT_DoLog DEBUG "Already have '${basename}'"
494 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
495 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
496 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
497 # or, as a failover, a file without extension.
498 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
499 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
500 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
501 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
502 CT_DoLog DEBUG "Got '${basename}' from local storage"
503 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
511 # This function saves the specified to local storage if possible,
512 # and if so, symlinks it for later usage
513 # Usage: CT_SaveLocal </full/path/file.name>
516 local basename="${file##*/}"
518 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
519 CT_DoLog EXTRA "Saving '${basename}' to local storage"
520 # The file may already exist if downloads are forced: remove it first
521 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
522 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
523 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
527 # Download the file from one of the URLs passed as argument
528 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
536 # If next argument starts with a dot, then this is not an URL,
537 # and we can consider that it is a preferred extension.
544 # Does it exist localy?
545 if CT_GetLocal "${file}" ${first_ext}; then
550 # Try to retrieve the file
551 CT_DoLog EXTRA "Retrieving '${file}'"
553 # Add URLs on the LAN mirror
554 if [ "${CT_USE_MIRROR}" = "y" ]; then
555 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
556 URLS+=( "${CT_MIRROR_BASE_URL}/${file%-*}" )
557 URLS+=( "${CT_MIRROR_BASE_URL}" )
560 if [ "${CT_FORBID_DOWNLOAD}" != "y" ]; then
564 # Scan all URLs in turn, and try to grab a tarball from there
565 # Do *not* try git trees (ext=/.git), this is handled in a specific
567 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
568 # Try all urls in turn
569 for url in "${URLS[@]}"; do
570 [ -n "${url}" ] || continue
571 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
572 CT_DoGetFile "${url}/${file}${ext}"
573 if [ -f "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
574 CT_DoLog DEBUG "Got '${file}' from the Internet"
575 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
581 # Just return error, someone may want to catch and handle the error
582 # (eg. glibc/eglibc add-ons can be missing).
586 # Checkout from CVS, and build the associated tarball
587 # The tarball will be called ${basename}.tar.bz2
588 # Prerequisite: either the server does not require password,
589 # or the user must already be logged in.
590 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
591 # If dirname is specified, then module will be renamed to dirname
592 # prior to building the tarball.
593 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
594 # Note: if '=subdir' is given, then it is used instead of 'module'.
599 local tag="${4:+-r ${4}}"
603 # First try locally, then the mirror
604 if CT_GetFile "${basename}"; then
605 # Got it! Return early! :-)
609 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
610 CT_DoLog WARN "Downloads forbidden, not trying cvs retrieval"
615 CT_Pushd "${tmp_dir}"
617 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
618 if [ -n "${dirname}" ]; then
621 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
622 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
625 CT_DoExecLog ALL mv "${module}" "${dirname}"
626 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
630 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
633 CT_DoExecLog ALL rm -rf "${tmp_dir}"
636 # Check out from SVN, and build the associated tarball
637 # The tarball will be called ${basename}.tar.bz2
638 # Prerequisite: either the server does not require password,
639 # or the user must already be logged in.
640 # 'rev' is the revision to retrieve
641 # Usage: CT_GetSVN <basename> <url> [rev]
647 # First try locally, then the mirror
648 if CT_GetFile "${basename}"; then
649 # Got it! Return early! :-)
653 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
654 CT_DoLog WARN "Downloads forbidden, not trying svn retrieval"
659 CT_Pushd "${tmp_dir}"
661 if ! CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"; then
662 CT_DoLog WARN "Could not retrieve '${basename}'"
665 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
666 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
669 CT_DoExecLog ALL rm -rf "${tmp_dir}"
673 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
674 # Prerequisites: either the server does not require password,
675 # or the user has already taken any action to authenticate to the server.
676 # The cloned tree will *not* be stored in the local tarballs dir!
677 # Usage: CT_GetGit <basename> <url [url ...]>
679 local basename="$1"; shift
683 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
684 CT_DoLog WARN "Downloads forbidden, not trying git retrieval"
688 # Do we have it in our tarballs dir?
689 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
690 CT_DoLog EXTRA "Updating git tree '${basename}'"
691 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
692 CT_DoExecLog ALL git pull
695 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
696 for url in "${@}"; do
697 CT_DoLog ALL "Trying to clone from '${url}'"
698 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
699 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
704 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
709 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
710 # must be extracted in the glibc directory; uCLibc locales must be extracted
711 # in the extra/locale sub-directory of uClibc. This is taken into account
712 # by the caller, that did a 'cd' into the correct path before calling us
713 # and sets nochdir to 'nochdir'.
714 # Note also that this function handles the git trees!
715 # Usage: CT_Extract <basename> [nochdir] [options]
716 # where 'options' are dependent on the source (eg. git branch/tag...)
724 if [ "${nochdir}" = "nochdir" ]; then
728 nochdir="${CT_SRC_DIR}"
734 if ! ext="$(CT_GetFileExtension "${basename}")"; then
735 CT_DoLog WARN "'${basename}' not found in '${CT_TARBALLS_DIR}'"
738 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
740 # Check if already extracted
741 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
742 CT_DoLog DEBUG "Already extracted '${basename}'"
746 # Check if previously partially extracted
747 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
748 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
749 CT_DoLog ERROR "Please remove first:"
750 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
751 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
752 CT_Abort "I'll stop now to avoid any carnage..."
754 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
756 CT_Pushd "${nochdir}"
758 CT_DoLog EXTRA "Extracting '${basename}'"
759 CT_DoExecLog FILE mkdir -p "${basename}"
760 tar_opts=( "--strip-components=1" )
761 tar_opts+=( "-C" "${basename}" )
765 # - lzma can be handled either with 'xz' or 'lzma'
766 # - we get lzma tarball only if either or both are available
767 # - so, if we get an lzma tarball, and either 'xz' or 'lzma' is
768 # missing, we can assume the other is available
769 if [ "${CT_CONFIGURE_has_lzma}" = "y" ]; then
775 .tar.xz) CT_DoExecLog FILE tar "${tar_opts[@]}" --use-compress-program=xz -f "${full_file}";;
776 .tar.lzma) CT_DoExecLog FILE tar "${tar_opts[@]}" --use-compress-program="${lzma_prog}" -f "${full_file}";;
777 .tar.bz2) CT_DoExecLog FILE tar "${tar_opts[@]}" -j -f "${full_file}";;
778 .tar.gz|.tgz) CT_DoExecLog FILE tar "${tar_opts[@]}" -z -f "${full_file}";;
779 .tar) CT_DoExecLog FILE tar "${tar_opts[@]}" -f "${full_file}";;
780 /.git) CT_ExtractGit "${basename}" "${@}";;
781 *) CT_DoLog WARN "Don't know how to handle '${basename}${ext}': unknown extension"
786 # Don't mark as being extracted for git
789 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
791 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
796 # Create a working git clone
797 # Usage: CT_ExtractGit <basename> [ref]
798 # where 'ref' is the reference to use:
799 # the full name of a branch, like "remotes/origin/branch_name"
800 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
803 local basename="${1}"
808 # pushd now to be able to get git revlist in case ref is a date
809 clone_dir="${CT_TARBALLS_DIR}/${basename}"
810 CT_Pushd "${clone_dir}"
812 # What kind of reference is ${ref} ?
813 if [ -z "${ref}" ]; then
814 # Don't update the clone, keep as-is
816 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
818 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
820 elif date -d "${ref}" >/dev/null 2>&1; then
822 ref=$(git rev-list -n1 --before="${ref}")
824 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
827 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/${basename}"
828 CT_DoExecLog ALL ln -sf "${clone_dir}" "${CT_SRC_DIR}/${basename}"
830 case "${ref_type}" in
832 *) CT_DoExecLog FILE git checkout "${ref}";;
838 # Patches the specified component
839 # See CT_Extract, above, for explanations on 'nochdir'
840 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
841 # If the package directory is *not* packagename-packageversion, then
842 # the caller must cd into the proper directory first, and call us
853 local bundled_patch_dir
854 local local_patch_dir
856 if [ "${nochdir}" = "nochdir" ]; then
860 pkgdir="${pkgname}-${version}"
865 pkgdir="${pkgname}-${version}"
866 nochdir="${CT_SRC_DIR}/${pkgdir}"
869 # Check if already patched
870 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
871 CT_DoLog DEBUG "Already patched '${pkgdir}'"
875 # Check if already partially patched
876 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
877 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
878 CT_DoLog ERROR "Please remove first:"
879 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
880 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
881 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
882 CT_Abort "I'll stop now to avoid any carnage..."
884 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
886 CT_Pushd "${nochdir}"
888 CT_DoLog EXTRA "Patching '${pkgdir}'"
890 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
891 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
893 case "${CT_PATCH_ORDER}" in
894 bundled) patch_dirs=("${bundled_patch_dir}");;
895 local) patch_dirs=("${local_patch_dir}");;
896 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
897 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
901 for d in "${patch_dirs[@]}"; do
902 CT_DoLog DEBUG "Looking for patches in '${d}'..."
903 if [ -n "${d}" -a -d "${d}" ]; then
904 for p in "${d}"/*.patch; do
905 if [ -f "${p}" ]; then
906 CT_DoLog DEBUG "Applying patch '${p}'"
907 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
910 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
916 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
917 CT_DoLog ALL "Overiding config.guess and config.sub"
918 for cfg in config_guess config_sub; do
919 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
920 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
921 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
922 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
926 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
927 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
932 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
933 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
935 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
936 "${CT_TOP_DIR}/scripts/config.guess"
938 "${CT_LIB_DIR}/scripts/config.guess"
943 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
944 "${CT_TOP_DIR}/scripts/config.sub" "$@"
946 "${CT_LIB_DIR}/scripts/config.sub" "$@"
950 # Compute the target tuple from what is provided by the user
951 # Usage: CT_DoBuildTargetTuple
952 # In fact this function takes the environment variables to build the target
953 # tuple. It is needed both by the normal build sequence, as well as the
954 # sample saving sequence.
955 CT_DoBuildTargetTuple() {
956 # Set the endianness suffix, and the default endianness gcc option
957 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
958 y,) target_endian_eb=eb
960 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
961 CT_ARCH_ENDIAN_LDFLAG="-EB"
963 ,y) target_endian_eb=
965 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
966 CT_ARCH_ENDIAN_LDFLAG="-EL"
970 # Build the default architecture tuple part
971 CT_TARGET_ARCH="${CT_ARCH}"
973 # Set defaults for the system part of the tuple. Can be overriden
974 # by architecture-specific values.
976 *glibc) CT_TARGET_SYS=gnu;;
977 uClibc) CT_TARGET_SYS=uclibc;;
978 *) CT_TARGET_SYS=elf;;
981 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
982 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
983 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
984 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
985 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
986 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
987 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
988 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
989 [ "${CT_ARCH_FLOAT_SW}" ] && { CT_ARCH_FLOAT_CFLAG="-msoft-float"; CT_ARCH_WITH_FLOAT="--with-float=soft"; }
991 # Build the default kernel tuple part
992 CT_TARGET_KERNEL="${CT_KERNEL}"
994 # Overide the default values with the components specific settings
996 CT_DoKernelTupleValues
998 # Finish the target tuple construction
999 CT_TARGET="${CT_TARGET_ARCH}"
1000 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
1001 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
1002 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
1006 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
1007 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
1009 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
1010 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
1011 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
1012 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
1013 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
1017 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
1018 # Prepare the target CFLAGS
1019 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
1020 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
1021 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
1022 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
1023 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
1024 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
1025 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
1027 # Now on for the target LDFLAGS
1028 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
1031 # This function does pause the build until the user strikes "Return"
1032 # Usage: CT_DoPause [optional_message]
1035 local message="${1:-Pausing for your pleasure}"
1036 CT_DoLog INFO "${message}"
1037 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
1041 # This function creates a tarball of the specified directory, but
1043 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
1044 CT_DoTarballIfExists() {
1048 local -a extra_tar_opts=( "$@" )
1051 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1052 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
1053 *) compress=( cat - ); tar_ext=;;
1056 if [ -d "${dir}" ]; then
1057 CT_DoLog DEBUG " Saving '${dir}'"
1058 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
1059 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
1060 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1062 CT_DoLog STATE " Not saving '${dir}': does not exist"
1066 # This function extracts a tarball to the specified directory, but
1067 # only if the tarball exists
1068 # Usage: CT_DoExtractTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
1069 CT_DoExtractTarballIfExists() {
1073 local -a extra_tar_opts=( "$@" )
1076 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1077 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
1078 *) uncompress=( cat ); tar_ext=;;
1081 if [ -f "${tarball}.tar${tar_ext}" ]; then
1082 CT_DoLog DEBUG " Restoring '${dir}'"
1083 CT_DoForceRmdir "${dir}"
1084 CT_DoExecLog DEBUG mkdir -p "${dir}"
1085 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
1086 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
1087 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1089 CT_DoLog STATE " Not restoring '${dir}': does not exist"
1093 # This function saves the state of the toolchain to be able to restart
1095 # Usage: CT_DoSaveState <next_step_name>
1097 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
1098 local state_name="$1"
1099 local state_dir="${CT_STATE_DIR}/${state_name}"
1101 # Log this to the log level required by the user
1102 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
1104 rm -rf "${state_dir}"
1105 mkdir -p "${state_dir}"
1107 CT_DoLog STATE " Saving environment and aliases"
1108 # We must omit shell functions, and some specific bash variables
1109 # that break when restoring the environment, later. We could do
1110 # all the processing in the awk script, but a sed is easier...
1113 $0~/^[^ ]+ \(\)/ { _p = 0; }
1115 $0 == "}" { _p = 1; }
1116 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1118 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1120 CT_DoTarballIfExists "${CT_BUILDTOOLS_PREFIX_DIR}" "${state_dir}/buildtools_dir"
1121 CT_DoTarballIfExists "${CT_COMPLIBS_DIR}" "${state_dir}/complibs_dir"
1122 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1123 CT_DoTarballIfExists "${CT_CC_CORE_STATIC_PREFIX_DIR}" "${state_dir}/cc_core_static_prefix_dir"
1124 CT_DoTarballIfExists "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${state_dir}/cc_core_shared_prefix_dir"
1125 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1127 CT_DoLog STATE " Saving log file"
1129 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1130 y) gzip -3 -c "${tmp_log_file}" >"${state_dir}/log.gz";;
1131 *) cat "${tmp_log_file}" >"${state_dir}/log";;
1133 exec >>"${tmp_log_file}"
1136 # This function restores a previously saved state
1137 # Usage: CT_DoLoadState <state_name>
1139 local state_name="$1"
1140 local state_dir="${CT_STATE_DIR}/${state_name}"
1141 local old_RESTART="${CT_RESTART}"
1142 local old_STOP="${CT_STOP}"
1144 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1146 # We need to do something special with the log file!
1147 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1148 exec >"${state_dir}/tail.log"
1151 # Log this to the log level required by the user
1152 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1154 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1155 CT_DoExtractTarballIfExists "${state_dir}/cc_core_shared_prefix_dir" "${CT_CC_CORE_SHARED_PREFIX_DIR}"
1156 CT_DoExtractTarballIfExists "${state_dir}/cc_core_static_prefix_dir" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
1157 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1158 CT_DoExtractTarballIfExists "${state_dir}/complibs_dir" "${CT_COMPLIBS_DIR}"
1159 CT_DoExtractTarballIfExists "${state_dir}/buildtools_dir" "${CT_BUILDTOOLS_PREFIX_DIR}"
1161 # Restore the environment, discarding any error message
1162 # (for example, read-only bash internals)
1163 CT_DoLog STATE " Restoring environment"
1164 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1166 # Restore the new RESTART and STOP steps
1167 CT_RESTART="${old_RESTART}"
1168 CT_STOP="${old_STOP}"
1169 unset old_stop old_restart
1171 CT_DoLog STATE " Restoring log file"
1173 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1174 y) zcat "${state_dir}/log.gz" >"${tmp_log_file}";;
1175 *) cat "${state_dir}/log" >"${tmp_log_file}";;
1177 cat "${state_dir}/tail.log" >>"${tmp_log_file}"
1178 exec >>"${tmp_log_file}"
1179 rm -f "${state_dir}/tail.log"