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
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:
58 # Make it easy to use \n and !
62 # A function to log what is happening
63 # Different log level are available:
64 # - ERROR: A serious, fatal error occurred
65 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
66 # - INFO: Informational messages
67 # - EXTRA: Extra informational messages
68 # - CFG: Output of various "./configure"-type scripts
69 # - FILE: File / archive unpacking.
70 # - STATE: State save & restore
71 # - ALL: Component's build messages
72 # - DEBUG: Internal debug messages
73 # Usage: CT_DoLog <level> [message]
74 # If message is empty, then stdin will be logged.
76 local max_level LEVEL level cur_l cur_L
78 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
79 # Set the maximum log level to DEBUG if we have none
80 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
83 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
89 fi |( IFS="${CR}" # We want the full lines, even leading spaces
95 indent=$((2*CT_STEP_COUNT))
97 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
98 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
99 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
100 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
101 *"make["*"]: *** ["*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
102 *) cur_L="${LEVEL}"; cur_l="${level}";;
104 # There will always be a log file (stdout, fd #1), be it /dev/null
105 printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"
106 if [ ${cur_l} -le ${max_level} ]; then
107 # Only print to console (fd #6) if log level is high enough.
108 printf "\r[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6
110 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
111 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6
112 _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))
120 # Execute an action, and log its messages
121 # Usage: [VAR=val...] CT_DoExecLog <level> <command [parameters...]>
125 CT_DoLog DEBUG "==> Executing: '${*}'"
126 "${@}" 2>&1 |CT_DoLog "${level}"
129 # Tail message to be logged whatever happens
130 # Usage: CT_DoEnd <level>
134 CT_STOP_DATE=$(CT_DoDate +%s%N)
135 CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)
136 if [ "${level}" != "ERROR" ]; then
137 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
139 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
140 elapsed_min=$((elapsed/(60*1000*1000*1000)))
141 elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))
142 elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))
143 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
146 # Remove entries referring to . and other relative paths
147 # Usage: CT_SanitizePath
153 # Only accept absolute paths;
154 # Note: as a special case the empty string in PATH is equivalent to .
155 if [ -n "${p}" -a -z "${p%%/*}" ]; then
156 new="${new}${new:+:}${p}"
162 # Abort the execution with an error message
163 # Usage: CT_Abort <message>
169 # Test a condition, and print a message if satisfied
170 # Usage: CT_Test <message> <tests>
175 CT_DoLog DEBUG "Testing '! ( $* )'"
176 test "$@" && CT_DoLog WARN "$m"
180 # Test a condition, and abort with an error message if satisfied
181 # Usage: CT_TestAndAbort <message> <tests>
185 CT_DoLog DEBUG "Testing '! ( $* )'"
186 test "$@" && CT_Abort "$m"
190 # Test a condition, and abort with an error message if not satisfied
191 # Usage: CT_TestAndAbort <message> <tests>
195 CT_DoLog DEBUG "Testing '$*'"
196 test "$@" || CT_Abort "$m"
200 # Test the presence of a tool, or abort if not found
201 # Usage: CT_HasOrAbort <tool>
203 CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z "$(CT_Which "${1}")"
207 # Search a program: wrap "which" for those system where
208 # "which" verbosely says there is no match (Mandriva is
210 # Usage: CT_Which <filename>
212 which "$1" 2>/dev/null || true
215 # Get current date with nanosecond precision
216 # On those system not supporting nanosecond precision, faked with rounding down
217 # to the highest entire second
218 # Usage: CT_DoDate <fmt>
220 date "$1" |sed -r -e 's/N$/000000000/;'
224 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
225 # Memorise a step being done so that any error is caught
226 # Usage: CT_DoStep <loglevel> <message>
228 local start=$(CT_DoDate +%s%N)
229 CT_DoLog "$1" "================================================================="
231 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
232 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
233 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
234 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
238 # End the step just being done
241 local stop=$(CT_DoDate +%s%N)
242 local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
243 local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
244 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
245 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
246 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
247 CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
251 # Pushes into a directory, and pops back
253 pushd "$1" >/dev/null 2>&1
259 # Creates a temporary directory
260 # $1: variable to assign to
261 # Usage: CT_MktempDir foo
263 # Some mktemp do not allow more than 6 Xs
264 eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")
265 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
266 CT_DoLog DEBUG "Made temporary directory '${!1}'"
270 # Removes one or more directories, even if it is read-only, or its parent is
271 # Usage: CT_DoForceRmdir dir [...]
275 for dir in "${@}"; do
276 [ -d "${dir}" ] || continue
279 mode="$(stat -c '%a' "$(dirname "${dir}")")"
282 mode="$(stat -f '%Lp' "$(dirname "${dir}")")"
285 CT_Abort "Unhandled host OS $CT_SYS_OS"
288 CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"
289 CT_DoExecLog ALL chmod -R u+w "${dir}"
290 CT_DoExecLog ALL rm -rf "${dir}"
291 CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"
295 # Echoes the specified string on stdout until the pipe breaks.
298 # Usage: CT_DoYes "" |make oldconfig
303 # Add the specified directory to LD_LIBRARY_PATH, and export it
304 # If the specified patch is already present, just export
306 # $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty
307 # Usage CT_SetLibPath /some/where/lib [first|last]
312 case ":${LD_LIBRARY_PATH}:" in
316 CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"
317 LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"
320 CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"
321 LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"
324 CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"
329 CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"
330 export LD_LIBRARY_PATH
333 # Get the file name extension of a component
334 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
335 # If found, echoes the extension to stdout, and return 0
336 # If not found, echoes nothing on stdout, and return !0.
337 CT_GetFileExtension() {
343 # we need to also check for an empty extension for those very
344 # peculiar components that don't have one (such as sstrip from
346 for ext in ${first_ext} .tar.gz .tar.bz2 .tgz .tar /.git ''; do
347 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
356 # Download an URL using wget
357 # Usage: CT_DoGetFileWget <URL>
359 # Need to return true because it is legitimate to not find the tarball at
360 # some of the provided URLs (think about snapshots, different layouts for
361 # different gcc versions, etc...)
362 # Some (very old!) FTP server might not support the passive mode, thus
364 # With automated download as we are doing, it can be very dangerous to use
365 # -c to continue the downloads. It's far better to simply overwrite the
367 # Some company networks have firewalls to connect to the internet, but it's
368 # not easy to detect them, and wget does not timeout by default while
369 # connecting, so force a global ${CT_CONNECT_TIMEOUT}-second timeout.
370 CT_DoExecLog ALL wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 --passive-ftp "$1" \
371 || CT_DoExecLog ALL wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 "$1" \
375 # Download an URL using curl
376 # Usage: CT_DoGetFileCurl <URL>
378 # Note: comments about wget method (above) are also valid here
379 # Plus: no good progress indicator is available with curl,
381 CT_DoExecLog ALL curl -s --ftp-pasv -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f \
382 || CT_DoExecLog ALL curl -s -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} -L -f \
386 # Download using aria2
387 # Usage: CT_DoGetFileAria2 <URL>
388 CT_DoGetFileAria2() {
389 # Note: comments about curl method (above) are also valid here
390 # Plus: default progress indicator is a single line, so use verbose log
391 # so that the CT-NG's ouput is 'live'.
392 CT_DoExecLog ALL aria2c --summary-interval=1 -s ${CT_DOWNLOAD_MAX_CHUNKS} -m 3 -t ${CT_CONNECT_TIMEOUT} -p "$1" \
393 || CT_DoExecLog ALL aria2c --summary-interval=1 -s ${CT_DOWNLOAD_MAX_CHUNKS} -m 3 -t ${CT_CONNECT_TIMEOUT} "$1" \
397 # OK, just look if we have them...
398 _aria2c=$(CT_Which aria2c)
399 _wget=$(CT_Which wget)
400 _curl=$(CT_Which curl)
402 # Wrapper function to call one of, in order of preference:
406 # Usage: CT_DoGetFile <URL>
408 if [ -n "${_aria2c}" -a ${CT_DOWNLOAD_MAX_CHUNKS} -gt 1 ]; then
409 CT_DoGetFileAria2 "$1"
410 elif [ -n "${_curl}" ]; then
411 CT_DoGetFileCurl "$1"
412 elif [ -n "${_wget}" ]; then
413 CT_DoGetFileWget "$1"
415 CT_Abort "Could find neither wget nor curl"
419 # This function tries to retrieve a tarball form a local directory
420 # Usage: CT_GetLocal <basename> [.extension]
426 # Do we already have it in *our* tarballs dir?
427 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
428 CT_DoLog DEBUG "Already have '${basename}'"
432 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
433 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
434 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
435 # or, as a failover, a file without extension.
436 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
437 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
438 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
439 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
440 CT_DoLog DEBUG "Got '${basename}' from local storage"
441 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
449 # This function saves the specified to local storage if possible,
450 # and if so, symlinks it for later usage
451 # Usage: CT_SaveLocal </full/path/file.name>
454 local basename="${file##*/}"
456 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
457 CT_DoLog EXTRA "Saving '${basename}' to local storage"
458 # The file may already exist if downloads are forced: remove it first
459 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
460 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
461 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
465 # Download the file from one of the URLs passed as argument
466 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
469 local url URLS LAN_URLS
473 # If next argument starts with a dot, then this is not an URL,
474 # and we can consider that it is a preferred extension.
481 # Does it exist localy?
482 CT_GetLocal "${file}" ${first_ext} && return 0 || true
485 # Try to retrieve the file
486 CT_DoLog EXTRA "Retrieving '${file}'"
487 CT_Pushd "${CT_TARBALLS_DIR}"
491 # Add URLs on the LAN mirror
493 if [ "${CT_USE_MIRROR}" = "y" ]; then
494 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
495 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}/${file%-*}"
496 LAN_URLS="${LAN_URLS} ${CT_MIRROR_BASE_URL}"
498 if [ "${CT_PREFER_MIRROR}" = "y" ]; then
499 CT_DoLog DEBUG "Pre-pending LAN mirror URLs"
500 URLS="${LAN_URLS} ${URLS}"
502 CT_DoLog DEBUG "Appending LAN mirror URLs"
503 URLS="${URLS} ${LAN_URLS}"
507 # Scan all URLs in turn, and try to grab a tarball from there
508 # Do *not* try git trees (ext=/.git), this is handled in a specific
510 for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
511 # Try all urls in turn
512 for url in ${URLS}; do
513 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
514 CT_DoGetFile "${url}/${file}${ext}"
515 if [ -f "${file}${ext}" ]; then
516 CT_DoLog DEBUG "Got '${file}' from the Internet"
517 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
524 CT_Abort "Could not retrieve '${file}'."
527 # Checkout from CVS, and build the associated tarball
528 # The tarball will be called ${basename}.tar.bz2
529 # Prerequisite: either the server does not require password,
530 # or the user must already be logged in.
531 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
532 # If dirname is specified, then module will be renamed to dirname
533 # prior to building the tarball.
534 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
535 # Note: if '=subdir' is given, then it is used instead of 'module'.
540 local tag="${4:+-r ${4}}"
544 # Does it exist localy?
545 CT_GetLocal "${basename}" && return 0 || true
548 CT_DoLog EXTRA "Retrieving '${basename}'"
551 CT_Pushd "${tmp_dir}"
553 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
554 if [ -n "${dirname}" ]; then
557 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
558 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
561 CT_DoExecLog ALL mv "${module}" "${dirname}"
562 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
566 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
569 CT_DoExecLog ALL rm -rf "${tmp_dir}"
572 # Check out from SVN, and build the associated tarball
573 # The tarball will be called ${basename}.tar.bz2
574 # Prerequisite: either the server does not require password,
575 # or the user must already be logged in.
576 # 'rev' is the revision to retrieve
577 # Usage: CT_GetSVN <basename> <url> [rev]
583 # Does it exist localy?
584 CT_GetLocal "${basename}" && return 0 || true
587 CT_DoLog EXTRA "Retrieving '${basename}'"
590 CT_Pushd "${tmp_dir}"
592 CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"
593 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
594 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
597 CT_DoExecLog ALL rm -rf "${tmp_dir}"
601 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
602 # Prerequisites: either the server does not require password,
603 # or the user has already taken any action to authenticate to the server.
604 # The cloned tree will *not* be stored in the local tarballs dir!
605 # Usage: CT_GetGit <basename> <url [url ...]>
607 local basename="$1"; shift
611 # Do we have it in our tarballs dir?
612 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
613 CT_DoLog EXTRA "Updating git tree '${basename}'"
614 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
615 CT_DoExecLog ALL git pull
618 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
619 for url in "${@}"; do
620 CT_DoLog ALL "Trying to clone from '${url}'"
621 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
622 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
627 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
632 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
633 # must be extracted in the glibc directory; uCLibc locales must be extracted
634 # in the extra/locale sub-directory of uClibc. This is taken into account
635 # by the caller, that did a 'cd' into the correct path before calling us
636 # and sets nochdir to 'nochdir'.
637 # Note also that this function handles the git trees!
638 # Usage: CT_Extract <basename> [nochdir] [options]
639 # where 'options' are dependent on the source (eg. git branch/tag...)
645 if [ "${nochdir}" = "nochdir" ]; then
649 nochdir="${CT_SRC_DIR}"
655 if ! ext="$(CT_GetFileExtension "${basename}")"; then
656 CT_Abort "'${basename}' not found in '${CT_TARBALLS_DIR}'"
658 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
660 # Check if already extracted
661 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
662 CT_DoLog DEBUG "Already extracted '${basename}'"
666 # Check if previously partially extracted
667 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
668 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
669 CT_DoLog ERROR "Please remove first:"
670 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
671 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
672 CT_Abort "I'll stop now to avoid any carnage..."
674 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
676 CT_Pushd "${nochdir}"
678 CT_DoLog EXTRA "Extracting '${basename}'"
680 .tar.bz2) CT_DoExecLog FILE tar xvjf "${full_file}";;
681 .tar.gz|.tgz) CT_DoExecLog FILE tar xvzf "${full_file}";;
682 .tar) CT_DoExecLog FILE tar xvf "${full_file}";;
683 /.git) CT_ExtractGit "${basename}" "${@}";;
684 *) CT_Abort "Don't know how to handle '${basename}${ext}': unknown extension";;
687 # Some tarballs have read-only files... :-(
688 # Because of nochdir, we don't know where we are, so chmod all
690 CT_DoExecLog DEBUG chmod -R u+w "${CT_SRC_DIR}"
692 # Don't mark as being extracted for git
695 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
697 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
702 # Create a working git clone
703 # Usage: CT_ExtractGit <basename> [ref]
704 # where 'ref' is the reference to use:
705 # the full name of a branch, like "remotes/origin/branch_name"
706 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
709 local basename="${1}"
714 # pushd now to be able to get git revlist in case ref is a date
715 clone_dir="${CT_TARBALLS_DIR}/${basename}"
716 CT_Pushd "${clone_dir}"
718 # What kind of reference is ${ref} ?
719 if [ -z "${ref}" ]; then
720 # Don't update the clone, keep as-is
722 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
724 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
726 elif date -d "${ref}" >/dev/null 2>&1; then
728 ref=$(git rev-list -n1 --before="${ref}")
730 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
733 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/${basename}"
734 CT_DoExecLog ALL ln -sf "${clone_dir}" "${CT_SRC_DIR}/${basename}"
736 case "${ref_type}" in
738 *) CT_DoExecLog FILE git checkout "${ref}";;
744 # Patches the specified component
745 # See CT_Extract, above, for explanations on 'nochdir'
746 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
747 # If the package directory is *not* packagename-packageversion, then
748 # the caller must cd into the proper directory first, and call us
759 local bundled_patch_dir
760 local local_patch_dir
762 if [ "${nochdir}" = "nochdir" ]; then
766 pkgdir="${pkgname}-${version}"
771 pkgdir="${pkgname}-${version}"
772 nochdir="${CT_SRC_DIR}/${pkgdir}"
775 # Check if already patched
776 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
777 CT_DoLog DEBUG "Already patched '${pkgdir}'"
781 # Check if already partially patched
782 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
783 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
784 CT_DoLog ERROR "Please remove first:"
785 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
786 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
787 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
788 CT_Abort "I'll stop now to avoid any carnage..."
790 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
792 CT_Pushd "${nochdir}"
794 CT_DoLog EXTRA "Patching '${pkgdir}'"
796 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
797 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
799 case "${CT_PATCH_ORDER}" in
800 bundled) patch_dirs=("${bundled_patch_dir}");;
801 local) patch_dirs=("${local_patch_dir}");;
802 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
803 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
807 for d in "${patch_dirs[@]}"; do
808 CT_DoLog DEBUG "Looking for patches in '${d}'..."
809 if [ -n "${d}" -a -d "${d}" ]; then
810 for p in "${d}"/*.patch; do
811 if [ -f "${p}" ]; then
812 CT_DoLog DEBUG "Applying patch '${p}'"
813 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
816 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
822 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
823 CT_DoLog ALL "Overiding config.guess and config.sub"
824 for cfg in config_guess config_sub; do
825 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
826 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
827 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
828 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
832 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
833 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
838 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
839 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
841 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
842 "${CT_TOP_DIR}/scripts/config.guess"
844 "${CT_LIB_DIR}/scripts/config.guess"
849 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
850 "${CT_TOP_DIR}/scripts/config.sub" "$@"
852 "${CT_LIB_DIR}/scripts/config.sub" "$@"
856 # Compute the target tuple from what is provided by the user
857 # Usage: CT_DoBuildTargetTuple
858 # In fact this function takes the environment variables to build the target
859 # tuple. It is needed both by the normal build sequence, as well as the
860 # sample saving sequence.
861 CT_DoBuildTargetTuple() {
862 # Set the endianness suffix, and the default endianness gcc option
863 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
864 y,) target_endian_eb=eb
866 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
867 CT_ARCH_ENDIAN_LDFLAG="-EB"
869 ,y) target_endian_eb=
871 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
872 CT_ARCH_ENDIAN_LDFLAG="-EL"
876 # Build the default architecture tuple part
877 CT_TARGET_ARCH="${CT_ARCH}"
879 # Set defaults for the system part of the tuple. Can be overriden
880 # by architecture-specific values.
882 *glibc) CT_TARGET_SYS=gnu;;
883 uClibc) CT_TARGET_SYS=uclibc;;
884 *) CT_TARGET_SYS=elf;;
887 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
888 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
889 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
890 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
891 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
892 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
893 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
894 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
895 [ "${CT_ARCH_FLOAT_SW}" ] && { CT_ARCH_FLOAT_CFLAG="-msoft-float"; CT_ARCH_WITH_FLOAT="--with-float=soft"; }
897 # Build the default kernel tuple part
898 CT_TARGET_KERNEL="${CT_KERNEL}"
900 # Overide the default values with the components specific settings
902 CT_DoKernelTupleValues
904 # Finish the target tuple construction
905 CT_TARGET="${CT_TARGET_ARCH}"
906 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
907 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
908 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
912 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
913 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
915 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
916 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
917 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
918 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
919 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
923 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
924 # Prepare the target CFLAGS
925 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
926 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
927 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
928 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
929 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
930 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
931 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
933 # Now on for the target LDFLAGS
934 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
937 # This function does pause the build until the user strikes "Return"
938 # Usage: CT_DoPause [optional_message]
941 local message="${1:-Pausing for your pleasure}"
942 CT_DoLog INFO "${message}"
943 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
947 # This function creates a tarball of the specified directory, but
949 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
950 CT_DoTarballIfExists() {
954 local -a extra_tar_opts=( "$@" )
957 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
958 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
959 *) compress=( cat - ); tar_ext=;;
962 if [ -d "${dir}" ]; then
963 CT_DoLog DEBUG " Saving '${dir}'"
964 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
965 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
966 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
968 CT_DoLog STATE " Not saving '${dir}': does not exist"
972 # This function extracts a tarball to the specified directory, but
973 # only if the tarball exists
974 # Usage: CT_DoExtractTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
975 CT_DoExtractTarballIfExists() {
979 local -a extra_tar_opts=( "$@" )
982 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
983 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
984 *) uncompress=( cat ); tar_ext=;;
987 if [ -f "${tarball}.tar${tar_ext}" ]; then
988 CT_DoLog DEBUG " Restoring '${dir}'"
989 CT_DoForceRmdir "${dir}"
990 CT_DoExecLog DEBUG mkdir -p "${dir}"
991 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
992 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
993 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
995 CT_DoLog STATE " Not restoring '${dir}': does not exist"
999 # This function saves the state of the toolchain to be able to restart
1001 # Usage: CT_DoSaveState <next_step_name>
1003 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
1004 local state_name="$1"
1005 local state_dir="${CT_STATE_DIR}/${state_name}"
1007 # Log this to the log level required by the user
1008 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
1010 rm -rf "${state_dir}"
1011 mkdir -p "${state_dir}"
1013 CT_DoLog STATE " Saving environment and aliases"
1014 # We must omit shell functions, and some specific bash variables
1015 # that break when restoring the environment, later. We could do
1016 # all the processing in the awk script, but a sed is easier...
1019 $0~/^[^ ]+ \(\)/ { _p = 0; }
1021 $0 == "}" { _p = 1; }
1022 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1024 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1026 if [ "${CT_COMPLIBS_BACKUP}" = "y" ]; then
1027 CT_DoTarballIfExists "${CT_COMPLIBS_DIR}" "${state_dir}/complibs_dir"
1029 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1030 CT_DoTarballIfExists "${CT_CC_CORE_STATIC_PREFIX_DIR}" "${state_dir}/cc_core_static_prefix_dir"
1031 CT_DoTarballIfExists "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${state_dir}/cc_core_shared_prefix_dir"
1032 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1034 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1035 CT_DoLog STATE " Saving log file"
1037 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1038 y) gzip -3 -c "${CT_LOG_FILE}" >"${state_dir}/log.gz";;
1039 *) cat "${CT_LOG_FILE}" >"${state_dir}/log";;
1041 exec >>"${CT_LOG_FILE}"
1045 # This function restores a previously saved state
1046 # Usage: CT_DoLoadState <state_name>
1048 local state_name="$1"
1049 local state_dir="${CT_STATE_DIR}/${state_name}"
1050 local old_RESTART="${CT_RESTART}"
1051 local old_STOP="${CT_STOP}"
1053 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1055 # We need to do something special with the log file!
1056 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1057 exec >"${state_dir}/tail.log"
1060 # Log this to the log level required by the user
1061 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1063 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1064 CT_DoExtractTarballIfExists "${state_dir}/cc_core_shared_prefix_dir" "${CT_CC_CORE_SHARED_PREFIX_DIR}"
1065 CT_DoExtractTarballIfExists "${state_dir}/cc_core_static_prefix_dir" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
1066 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1067 if [ "${CT_COMPLIBS_BACKUP}" = "y" ]; then
1068 CT_DoExtractTarballIfExists "${state_dir}/complibs_dir" "${CT_COMPLIBS_DIR}"
1071 # Restore the environment, discarding any error message
1072 # (for example, read-only bash internals)
1073 CT_DoLog STATE " Restoring environment"
1074 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1076 # Restore the new RESTART and STOP steps
1077 CT_RESTART="${old_RESTART}"
1078 CT_STOP="${old_STOP}"
1079 unset old_stop old_restart
1081 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1082 CT_DoLog STATE " Restoring log file"
1084 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1085 y) zcat "${state_dir}/log.gz" >"${CT_LOG_FILE}";;
1086 *) cat "${state_dir}/log" >"${CT_LOG_FILE}";;
1088 cat "${state_dir}/tail.log" >>"${CT_LOG_FILE}"
1089 exec >>"${CT_LOG_FILE}"
1090 rm -f "${state_dir}/tail.log"