1 # This file contains some usefull common functions
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
8 # Bail out early in subshell, the upper level shell will act accordingly.
9 [ ${BASH_SUBSHELL} -eq 0 ] || exit $ret
10 CT_DoLog ERROR "Build failed in step '${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}'"
11 for((step=(CT_STEP_COUNT-1); step>1; step--)); do
12 CT_DoLog ERROR " called in step '${CT_STEP_MESSAGE[${step}]}'"
14 CT_DoLog ERROR "Error happened in '${BASH_SOURCE[1]}' in function '${FUNCNAME[1]}' (line unknown, sorry)"
15 for((depth=2; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
16 CT_DoLog ERROR " called from '${BASH_SOURCE[${depth}]}' at line # ${BASH_LINENO[${depth}-1]} in function '${FUNCNAME[${depth}]}'"
18 [ "${CT_LOG_TO_FILE}" = "y" ] && CT_DoLog ERROR "Look at '${CT_LOG_FILE}' for more info on this error."
24 # Install the fault handler
27 # Inherit the fault handler in subshells and functions
30 # Make pipes fail on the _first_ failed command
31 # Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x
34 # Don't hash commands' locations, and search every time it is requested.
35 # This is slow, but needed because of the static/shared core gcc which shall
36 # always match to shared if it exists, and only fallback to static if the
41 # - first of all, save stdout so we can see the live logs: fd #6
43 # - then point stdout to the log file (temporary for now)
44 tmp_log_file="${CT_TOP_DIR}/log.$$"
45 exec >>"${tmp_log_file}"
47 # The different log levels:
55 # Make it easy to use \n and !
59 # A function to log what is happening
60 # Different log level are available:
61 # - ERROR: A serious, fatal error occurred
62 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
63 # - INFO: Informational messages
64 # - EXTRA: Extra informational messages
65 # - DEBUG: Debug messages
66 # - ALL: Component's build messages
67 # Usage: CT_DoLog <level> [message]
68 # If message is empty, then stdin will be logged.
70 local max_level LEVEL level cur_l cur_L
72 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
73 # Set the maximum log level to DEBUG if we have none
74 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
77 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
83 fi |( IFS="${CR}" # We want the full lines, even leading spaces
89 indent=$((2*CT_STEP_COUNT))
91 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
92 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
93 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
94 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
95 *"make["*"]: *** ["*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
96 *) cur_L="${LEVEL}"; cur_l="${level}";;
98 # There will always be a log file (stdout, fd #1), be it /dev/null
99 printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"
100 if [ ${cur_l} -le ${max_level} ]; then
101 # Only print to console (fd #6) if log level is high enough.
102 printf "\r[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6
104 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
105 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6
106 _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))
114 # Execute an action, and log its messages
115 # Usage: [VAR=val...] CT_DoExecLog <level> <command [parameters...]>
119 CT_DoLog DEBUG "==> Executing: '${*}'"
120 "${@}" 2>&1 |CT_DoLog "${level}"
123 # Tail message to be logged whatever happens
124 # Usage: CT_DoEnd <level>
128 CT_STOP_DATE=$(CT_DoDate +%s%N)
129 CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)
130 if [ "${level}" != "ERROR" ]; then
131 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
133 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
134 elapsed_min=$((elapsed/(60*1000*1000*1000)))
135 elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))
136 elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))
137 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
140 # Remove entries referring to ., /tmp and non-existing directories from $PATH
141 # Usage: CT_SanitizePath
147 # Replace any occurence of . with $(pwd -P)
148 # Use /tmp as a default if the directory is non-existent
149 # Do not add /tmp in the PATH
150 tmp="$( cd /tmp; cd "${p}" 2>/dev/null || true; pwd -P )"
151 if [ "${tmp}" != "/tmp" ]; then
152 new="${new}${new:+:}${p}"
158 # Abort the execution with an error message
159 # Usage: CT_Abort <message>
165 # Test a condition, and print a message if satisfied
166 # Usage: CT_Test <message> <tests>
171 CT_DoLog DEBUG "Testing '! ( $* )'"
172 test "$@" && CT_DoLog WARN "$m"
176 # Test a condition, and abort with an error message if satisfied
177 # Usage: CT_TestAndAbort <message> <tests>
181 CT_DoLog DEBUG "Testing '! ( $* )'"
182 test "$@" && CT_Abort "$m"
186 # Test a condition, and abort with an error message if not satisfied
187 # Usage: CT_TestAndAbort <message> <tests>
191 CT_DoLog DEBUG "Testing '$*'"
192 test "$@" || CT_Abort "$m"
196 # Test the presence of a tool, or abort if not found
197 # Usage: CT_HasOrAbort <tool>
199 CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z "$(CT_Which "${1}")"
203 # Search a program: wrap "which" for those system where
204 # "which" verbosely says there is no match (Mandriva is
206 # Usage: CT_Which <filename>
208 which "$1" 2>/dev/null || true
211 # Get current date with nanosecond precision
212 # On those system not supporting nanosecond precision, faked with rounding down
213 # to the highest entire second
214 # Usage: CT_DoDate <fmt>
216 date "$1" |sed -r -e 's/N$/000000000/;'
220 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
221 # Memorise a step being done so that any error is caught
222 # Usage: CT_DoStep <loglevel> <message>
224 local start=$(CT_DoDate +%s%N)
225 CT_DoLog "$1" "================================================================="
227 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
228 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
229 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
230 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
234 # End the step just being done
237 local stop=$(CT_DoDate +%s%N)
238 local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
239 local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
240 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
241 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
242 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
243 CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
247 # Pushes into a directory, and pops back
249 pushd "$1" >/dev/null 2>&1
255 # Creates a temporary directory
256 # $1: variable to assign to
257 # Usage: CT_MktempDir foo
259 # Some mktemp do not allow more than 6 Xs
260 eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")
261 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
262 CT_DoLog DEBUG "Made temporary directory '${!1}'"
266 # Removes one or more directories, even if it is read-only, or its parent is
267 # Usage: CT_DoForceRmdir dir [...]
271 for dir in "${@}"; do
272 [ -d "${dir}" ] || continue
273 mode="$(stat -c '%a' "$(dirname "${dir}")")"
274 CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"
275 CT_DoExecLog ALL chmod -R u+w "${dir}"
276 CT_DoExecLog ALL rm -rf "${dir}"
277 CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"
281 # Echoes the specified string on stdout until the pipe breaks.
284 # Usage: CT_DoYes "" |make oldconfig
289 # Add the specified directory to LD_LIBRARY_PATH, and export it
290 # If the specified patch is already present, just export
292 # $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty
293 # Usage CT_SetLibPath /some/where/lib [first|last]
298 case ":${LD_LIBRARY_PATH}:" in
302 CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"
303 LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"
306 CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"
307 LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"
310 CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"
315 CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"
316 export LD_LIBRARY_PATH
319 # Get the file name extension of a component
320 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
321 # If found, echoes the extension to stdout, and return 0
322 # If not found, echoes nothing on stdout, and return !0.
323 CT_GetFileExtension() {
329 # we need to also check for an empty extension for those very
330 # peculiar components that don't have one (such as sstrip from
332 for ext in ${first_ext} .tar.gz .tar.bz2 .tgz .tar /.git ''; do
333 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
342 # Download an URL using wget
343 # Usage: CT_DoGetFileWget <URL>
345 # Need to return true because it is legitimate to not find the tarball at
346 # some of the provided URLs (think about snapshots, different layouts for
347 # different gcc versions, etc...)
348 # Some (very old!) FTP server might not support the passive mode, thus
350 # With automated download as we are doing, it can be very dangerous to use
351 # -c to continue the downloads. It's far better to simply overwrite the
353 # Some company networks have firewalls to connect to the internet, but it's
354 # not easy to detect them, and wget does not timeout by default while
355 # connecting, so force a global ${CT_CONNECT_TIMEOUT}-second timeout.
356 CT_DoExecLog ALL wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 --passive-ftp "$1" \
357 || CT_DoExecLog ALL wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 "$1" \
361 # Download an URL using curl
362 # Usage: CT_DoGetFileCurl <URL>
364 # Note: comments about wget method (above) are also valid here
365 # Plus: no good progress indicator is available with curl,
367 CT_DoExecLog ALL curl -s --ftp-pasv -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f \
368 || CT_DoExecLog ALL curl -s -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f \
372 # Download using aria2
373 # Usage: CT_DoGetFileAria2 <URL>
374 CT_DoGetFileAria2() {
375 # Note: comments about curl method (above) are also valid here
376 # Plus: default progress indicator is a single line, so use verbose log
377 # so that the CT-NG's ouput is 'live'.
378 CT_DoExecLog ALL aria2c --summary-interval=1 -s ${CT_DOWNLOAD_MAX_CHUNKS} -m 3 -t ${CT_CONNECT_TIMEOUT} -p "$1" \
379 || CT_DoExecLog ALL aria2c --summary-interval=1 -s ${CT_DOWNLOAD_MAX_CHUNKS} -m 3 -t ${CT_CONNECT_TIMEOUT} "$1" \
383 # OK, just look if we have them...
384 _aria2c=$(CT_Which aria2c)
385 _wget=$(CT_Which wget)
386 _curl=$(CT_Which curl)
388 # Wrapper function to call one of, in order of preference:
392 # Usage: CT_DoGetFile <URL>
394 if [ -n "${_aria2c}" ]; then
395 CT_DoGetFileAria2 "$1"
396 elif [ -n "${_curl}" ]; then
397 CT_DoGetFileCurl "$1"
398 elif [ -n "${_wget}" ]; then
399 CT_DoGetFileWget "$1"
401 CT_Abort "Could find neither wget nor curl"
405 # This function tries to retrieve a tarball form a local directory
406 # Usage: CT_GetLocal <basename> [.extension]
412 # Do we already have it in *our* tarballs dir?
413 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
414 CT_DoLog DEBUG "Already have '${basename}'"
418 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
419 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
420 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
421 # or, as a failover, a file without extension.
422 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
423 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
424 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
425 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
426 CT_DoLog DEBUG "Got '${basename}' from local storage"
427 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
435 # This function saves the specified to local storage if possible,
436 # and if so, symlinks it for later usage
437 # Usage: CT_SaveLocal </full/path/file.name>
440 local basename="${file##*/}"
442 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
443 CT_DoLog EXTRA "Saving '${basename}' to local storage"
444 # The file may already exist if downloads are forced: remove it first
445 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
446 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
447 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
451 # Download the file from one of the URLs passed as argument
452 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
455 local url URLS LAN_URLS
459 # If next argument starts with a dot, then this is not an URL,
460 # and we can consider that it is a preferred extension.
467 # Does it exist localy?
468 CT_GetLocal "${file}" ${first_ext} && return 0 || true
471 # Try to retrieve the file
472 CT_DoLog EXTRA "Retrieving '${file}'"
473 CT_Pushd "${CT_TARBALLS_DIR}"
477 # Add URLs on the LAN mirror
479 if [ "${CT_USE_MIRROR}" = "y" ]; then
480 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
481 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}/${file%-*}"
482 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}"
484 if [ "${CT_PREFER_MIRROR}" = "y" ]; then
485 CT_DoLog DEBUG "Pre-pending LAN mirror URLs"
486 URLS="${LAN_URLS} ${URLS}"
488 CT_DoLog DEBUG "Appending LAN mirror URLs"
489 URLS="${URLS} ${LAN_URLS}"
493 # Scan all URLs in turn, and try to grab a tarball from there
494 # Do *not* try git trees (ext=/.git), this is handled in a specific
496 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
497 # Try all urls in turn
498 for url in ${URLS}; do
499 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
500 CT_DoGetFile "${url}/${file}${ext}"
501 if [ -f "${file}${ext}" ]; then
502 CT_DoLog DEBUG "Got '${file}' from the Internet"
503 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
510 CT_Abort "Could not retrieve '${file}'."
513 # Checkout from CVS, and build the associated tarball
514 # The tarball will be called ${basename}.tar.bz2
515 # Prerequisite: either the server does not require password,
516 # or the user must already be logged in.
517 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
518 # If dirname is specified, then module will be renamed to dirname
519 # prior to building the tarball.
520 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
521 # Note: if '=subdir' is given, then it is used instead of 'module'.
526 local tag="${4:+-r ${4}}"
530 # Does it exist localy?
531 CT_GetLocal "${basename}" && return 0 || true
534 CT_DoLog EXTRA "Retrieving '${basename}'"
537 CT_Pushd "${tmp_dir}"
539 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
540 if [ -n "${dirname}" ]; then
543 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
544 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
547 CT_DoExecLog ALL mv "${module}" "${dirname}"
548 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
552 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
555 CT_DoExecLog ALL rm -rf "${tmp_dir}"
558 # Check out from SVN, and build the associated tarball
559 # The tarball will be called ${basename}.tar.bz2
560 # Prerequisite: either the server does not require password,
561 # or the user must already be logged in.
562 # 'rev' is the revision to retrieve
563 # Usage: CT_GetSVN <basename> <url> [rev]
569 # Does it exist localy?
570 CT_GetLocal "${basename}" && return 0 || true
573 CT_DoLog EXTRA "Retrieving '${basename}'"
576 CT_Pushd "${tmp_dir}"
578 CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"
579 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
580 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
583 CT_DoExecLog ALL rm -rf "${tmp_dir}"
587 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
588 # Prerequisites: either the server does not require password,
589 # or the user has already taken any action to authenticate to the server.
590 # The cloned tree will *not* be stored in the local tarballs dir!
591 # Usage: CT_GetGit <basename> <url [url ...]>
593 local basename="$1"; shift
597 # Do we have it in our tarballs dir?
598 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
599 CT_DoLog EXTRA "Updating git tree '${basename}'"
600 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
601 CT_DoExecLog ALL git pull
604 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
605 for url in "${@}"; do
606 CT_DoLog ALL "Trying to clone from '${url}'"
607 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
608 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
613 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
618 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
619 # must be extracted in the glibc directory; uCLibc locales must be extracted
620 # in the extra/locale sub-directory of uClibc. This is taken into account
621 # by the caller, that did a 'cd' into the correct path before calling us
622 # and sets nochdir to 'nochdir'.
623 # Note also that this function handles the git trees!
624 # Usage: CT_Extract <basename> [nochdir] [options]
625 # where 'options' are dependent on the source (eg. git branch/tag...)
631 if [ "${nochdir}" = "nochdir" ]; then
635 nochdir="${CT_SRC_DIR}"
641 if ! ext="$(CT_GetFileExtension "${basename}")"; then
642 CT_Abort "'${basename}' not found in '${CT_TARBALLS_DIR}'"
644 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
646 # Check if already extracted
647 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
648 CT_DoLog DEBUG "Already extracted '${basename}'"
652 # Check if previously partially extracted
653 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
654 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
655 CT_DoLog ERROR "Please remove first:"
656 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
657 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
658 CT_Abort "I'll stop now to avoid any carnage..."
660 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
662 CT_Pushd "${nochdir}"
664 CT_DoLog EXTRA "Extracting '${basename}'"
666 .tar.bz2) CT_DoExecLog ALL tar xvjf "${full_file}";;
667 .tar.gz|.tgz) CT_DoExecLog ALL tar xvzf "${full_file}";;
668 .tar) CT_DoExecLog ALL tar xvf "${full_file}";;
669 /.git) CT_ExtractGit "${basename}" "${@}";;
670 *) CT_Abort "Don't know how to handle '${basename}${ext}': unknown extension";;
673 # Some tarballs have read-only files... :-(
674 # Because of nochdir, we don't know where we are, so chmod all
676 CT_DoExecLog DEBUG chmod -R u+w "${CT_SRC_DIR}"
678 # Don't mark as being extracted for git
681 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
683 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
688 # Create a working git clone
689 # Usage: CT_ExtractGit <basename> [ref]
690 # where 'ref' is the reference to use:
691 # the full name of a branch, like "remotes/origin/branch_name"
692 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
695 local basename="${1}"
700 # pushd now to be able to get git revlist in case ref is a date
701 clone_dir="${CT_TARBALLS_DIR}/${basename}"
702 CT_Pushd "${clone_dir}"
704 # What kind of reference is ${ref} ?
705 if [ -z "${ref}" ]; then
706 # Don't update the clone, keep as-is
708 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
710 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
712 elif date -d "${ref}" >/dev/null 2>&1; then
714 ref=$(git rev-list -n1 --before="${ref}")
716 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
719 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/${basename}"
720 CT_DoExecLog ALL ln -sf "${clone_dir}" "${CT_SRC_DIR}/${basename}"
722 case "${ref_type}" in
724 *) CT_DoExecLog ALL git checkout "${ref}";;
730 # Patches the specified component
731 # See CT_Extract, above, for explanations on 'nochdir'
732 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
733 # If the package directory is *not* packagename-packageversion, then
734 # the caller must cd into the proper directory first, and call us
745 local bundled_patch_dir
746 local local_patch_dir
748 if [ "${nochdir}" = "nochdir" ]; then
752 pkgdir="${pkgname}-${version}"
757 pkgdir="${pkgname}-${version}"
758 nochdir="${CT_SRC_DIR}/${pkgdir}"
761 # Check if already patched
762 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
763 CT_DoLog DEBUG "Already patched '${pkgdir}'"
767 # Check if already partially patched
768 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
769 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
770 CT_DoLog ERROR "Please remove first:"
771 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
772 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
773 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
774 CT_Abort "I'll stop now to avoid any carnage..."
776 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
778 CT_Pushd "${nochdir}"
780 CT_DoLog EXTRA "Patching '${pkgdir}'"
782 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
783 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
785 case "${CT_PATCH_ORDER}" in
786 bundled) patch_dirs=("${bundled_patch_dir}");;
787 local) patch_dirs=("${local_patch_dir}");;
788 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
789 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
793 for d in "${patch_dirs[@]}"; do
794 CT_DoLog DEBUG "Looking for patches in '${d}'..."
795 if [ -n "${d}" -a -d "${d}" ]; then
796 for p in "${d}"/*.patch; do
797 if [ -f "${p}" ]; then
798 CT_DoLog DEBUG "Applying patch '${p}'"
799 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
802 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
808 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
809 CT_DoLog ALL "Overiding config.guess and config.sub"
810 for cfg in config_guess config_sub; do
811 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
812 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
813 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
814 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
818 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
819 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
824 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
825 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
827 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
828 "${CT_TOP_DIR}/scripts/config.guess"
830 "${CT_LIB_DIR}/scripts/config.guess"
835 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
836 "${CT_TOP_DIR}/scripts/config.sub" "$@"
838 "${CT_LIB_DIR}/scripts/config.sub" "$@"
842 # Compute the target tuple from what is provided by the user
843 # Usage: CT_DoBuildTargetTuple
844 # In fact this function takes the environment variables to build the target
845 # tuple. It is needed both by the normal build sequence, as well as the
846 # sample saving sequence.
847 CT_DoBuildTargetTuple() {
848 # Set the endianness suffix, and the default endianness gcc option
849 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
850 y,) target_endian_eb=eb
852 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
853 CT_ARCH_ENDIAN_LDFLAG="-EB"
855 ,y) target_endian_eb=
857 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
858 CT_ARCH_ENDIAN_LDFLAG="-EL"
862 # Build the default architecture tuple part
863 CT_TARGET_ARCH="${CT_ARCH}"
865 # Set defaults for the system part of the tuple. Can be overriden
866 # by architecture-specific values.
868 *glibc) CT_TARGET_SYS=gnu;;
869 uClibc) CT_TARGET_SYS=uclibc;;
870 *) CT_TARGET_SYS=elf;;
873 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
874 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
875 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
876 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
877 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
878 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
879 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
880 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
881 [ "${CT_ARCH_FLOAT_SW}" ] && { CT_ARCH_FLOAT_CFLAG="-msoft-float"; CT_ARCH_WITH_FLOAT="--with-float=soft"; }
883 # Build the default kernel tuple part
884 CT_TARGET_KERNEL="${CT_KERNEL}"
886 # Overide the default values with the components specific settings
888 CT_DoKernelTupleValues
890 # Finish the target tuple construction
891 CT_TARGET="${CT_TARGET_ARCH}"
892 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
893 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
894 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
898 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
899 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
901 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
902 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
903 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
904 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
905 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
909 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
910 # Prepare the target CFLAGS
911 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
912 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
913 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
914 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
915 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
916 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
917 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
919 # Now on for the target LDFLAGS
920 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
923 # This function does pause the build until the user strikes "Return"
924 # Usage: CT_DoPause [optional_message]
927 local message="${1:-Pausing for your pleasure}"
928 CT_DoLog INFO "${message}"
929 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
933 # This function creates a tarball of the specified directory, but
935 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
936 CT_DoTarballIfExists() {
940 local -a extra_tar_opts=( "$@" )
943 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
944 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
945 *) compress=( cat - ); tar_ext=;;
948 if [ -d "${dir}" ]; then
949 CT_DoLog DEBUG " Saving '${dir}'"
950 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
951 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
952 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog DEBUG
954 CT_DoLog DEBUG " Not saving '${dir}': does not exist"
958 # This function extracts a tarball to the specified directory, but
959 # only if the tarball exists
960 # Usage: CT_DoTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
961 CT_DoExtractTarballIfExists() {
965 local -a extra_tar_opts=( "$@" )
968 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
969 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
970 *) uncompress=( cat ); tar_ext=;;
973 if [ -f "${tarball}.tar${tar_ext}" ]; then
974 CT_DoLog DEBUG " Restoring '${dir}'"
975 CT_DoForceRmdir "${dir}"
976 CT_DoExecLog DEBUG mkdir -p "${dir}"
977 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
978 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
979 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog DEBUG
981 CT_DoLog DEBUG " Not restoring '${dir}': does not exist"
985 # This function saves the state of the toolchain to be able to restart
987 # Usage: CT_DoSaveState <next_step_name>
989 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
990 local state_name="$1"
991 local state_dir="${CT_STATE_DIR}/${state_name}"
993 # Log this to the log level required by the user
994 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
996 rm -rf "${state_dir}"
997 mkdir -p "${state_dir}"
999 CT_DoLog DEBUG " Saving environment and aliases"
1000 # We must omit shell functions, and some specific bash variables
1001 # that break when restoring the environment, later. We could do
1002 # all the processing in the awk script, but a sed is easier...
1005 $0~/^[^ ]+ \(\)/ { _p = 0; }
1007 $0 == "}" { _p = 1; }
1008 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1010 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1012 if [ "${CT_COMPLIBS_SHARED}" != "y" ]; then
1013 # If complibs are not shared, then COMPLIBS_DIR == PREFIX_DIR,
1015 CT_DoTarballIfExists "${CT_COMPLIBS_DIR}" "${state_dir}/complibs_dir"
1017 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1018 CT_DoTarballIfExists "${CT_CC_CORE_STATIC_PREFIX_DIR}" "${state_dir}/cc_core_static_prefix_dir"
1019 CT_DoTarballIfExists "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${state_dir}/cc_core_shared_prefix_dir"
1020 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1022 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1023 CT_DoLog DEBUG " Saving log file"
1025 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1026 y) gzip -3 -c "${CT_LOG_FILE}" >"${state_dir}/log.gz";;
1027 *) cat "${CT_LOG_FILE}" >"${state_dir}/log";;
1029 exec >>"${CT_LOG_FILE}"
1033 # This function restores a previously saved state
1034 # Usage: CT_DoLoadState <state_name>
1036 local state_name="$1"
1037 local state_dir="${CT_STATE_DIR}/${state_name}"
1038 local old_RESTART="${CT_RESTART}"
1039 local old_STOP="${CT_STOP}"
1041 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1043 # We need to do something special with the log file!
1044 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1045 exec >"${state_dir}/tail.log"
1048 # Log this to the log level required by the user
1049 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1051 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1052 CT_DoExtractTarballIfExists "${state_dir}/cc_core_shared_prefix_dir" "${CT_CC_CORE_SHARED_PREFIX_DIR}"
1053 CT_DoExtractTarballIfExists "${state_dir}/cc_core_static_prefix_dir" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
1054 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1055 if [ "${CT_COMPLIBS_SHARED}" != "y" ]; then
1056 # If complibs are not shared, then COMPLIBS_DIR == PREFIX_DIR,
1057 # so do not restore.
1058 CT_DoExtractTarballIfExists "${state_dir}/complibs_dir" "${CT_COMPLIBS_DIR}"
1061 # Restore the environment, discarding any error message
1062 # (for example, read-only bash internals)
1063 CT_DoLog DEBUG " Restoring environment"
1064 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1066 # Restore the new RESTART and STOP steps
1067 CT_RESTART="${old_RESTART}"
1068 CT_STOP="${old_STOP}"
1069 unset old_stop old_restart
1071 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1072 CT_DoLog DEBUG " Restoring log file"
1074 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1075 y) zcat "${state_dir}/log.gz" >"${CT_LOG_FILE}";;
1076 *) cat "${state_dir}/log" >"${CT_LOG_FILE}";;
1078 cat "${state_dir}/tail.log" >>"${CT_LOG_FILE}"
1079 exec >>"${CT_LOG_FILE}"
1080 rm -f "${state_dir}/tail.log"