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
12 # To avoid printing the backtace for each sub-shell
13 # up to the top-level, just remember we've dumped it
14 if [ ! -f "${CT_BUILD_DIR}/backtrace" ]; then
15 touch "${CT_BUILD_DIR}/backtrace"
17 # Print steps backtrace
18 step_depth=${CT_STEP_COUNT}
19 CT_STEP_COUNT=1 # To have a zero-indentation
23 for((step=step_depth; step>0; step--)); do
24 CT_DoLog ERROR ">> ${intro} in step '${CT_STEP_MESSAGE[${step}]}'"
28 # Print functions backtrace
29 intro="Error happened in"
31 for((depth=1; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
32 file="${BASH_SOURCE[${depth}]#${CT_LIB_DIR}/}"
33 func="${FUNCNAME[${depth}]}"
34 line="@${BASH_LINENO[${depth}-1]:-?}"
35 CT_DoLog ERROR ">> ${intro}: ${func}[${file}${line}]"
40 # And finally, in top-level shell, print some hints
41 if [ ${BASH_SUBSHELL} -eq 0 ]; then
42 # Help diagnose the error
43 CT_STEP_COUNT=1 # To have a zero-indentation
45 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
46 CT_DoLog ERROR ">> For more info on this error, look at the file: '${tmp_log_file#${CT_TOP_DIR}/}'"
48 CT_DoLog ERROR ">> There is a list of known issues, some with workarounds, in:"
49 CT_DoLog ERROR ">> '${CT_DOC_DIR#${CT_TOP_DIR}/}/B - Known issues.txt'"
53 rm -f "${CT_BUILD_DIR}/backtrace"
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 "which"
275 # verbosely says there is no match (such as on Mandriva).
276 # Usage: CT_Which <filename>
278 which "$1" 2>/dev/null || true
281 # Get current date with nanosecond precision
282 # On those system not supporting nanosecond precision, faked with rounding down
283 # to the highest entire second
284 # Usage: CT_DoDate <fmt>
286 date "$1" |sed -r -e 's/%?N$/000000000/;'
290 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="(top-level)"
291 # Memorise a step being done so that any error is caught
292 # Usage: CT_DoStep <loglevel> <message>
294 local start=$(CT_DoDate +%s%N)
295 CT_DoLog "$1" "================================================================="
297 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
298 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
299 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
300 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
304 # End the step just being done
307 local stop=$(CT_DoDate +%s%N)
308 local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
309 local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
310 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
311 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
312 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
313 CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
317 # Pushes into a directory, and pops back
319 pushd "$1" >/dev/null 2>&1
325 # Create a dir and cd or pushd into it
326 # Usage: CT_mkdir_cd <dir/to/create>
327 # CT_mkdir_pushd <dir/to/create>
341 # Creates a temporary directory
342 # $1: variable to assign to
343 # Usage: CT_MktempDir foo
345 # Some mktemp do not allow more than 6 Xs
346 eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")
347 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
348 CT_DoLog DEBUG "Made temporary directory '${!1}'"
352 # Removes one or more directories, even if it is read-only, or its parent is
353 # Usage: CT_DoForceRmdir dir [...]
357 for dir in "${@}"; do
358 [ -d "${dir}" ] || continue
361 mode="$(stat -c '%a' "$(dirname "${dir}")")"
364 mode="$(stat -f '%Lp' "$(dirname "${dir}")")"
367 CT_Abort "Unhandled host OS $CT_SYS_OS"
370 CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"
371 CT_DoExecLog ALL chmod -R u+w "${dir}"
372 CT_DoExecLog ALL rm -rf "${dir}"
373 CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"
377 # Echoes the specified string on stdout until the pipe breaks.
380 # Usage: CT_DoYes "" |make oldconfig
385 # Add the specified directory to LD_LIBRARY_PATH, and export it
386 # If the specified patch is already present, just export
388 # $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty
389 # Usage CT_SetLibPath /some/where/lib [first|last]
394 case ":${LD_LIBRARY_PATH}:" in
398 CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"
399 LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"
402 CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"
403 LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"
406 CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"
411 CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"
412 export LD_LIBRARY_PATH
415 # Build up the list of allowed tarball extensions
416 # Add them in the prefered order; most preferred comes first
417 CT_DoListTarballExt() {
418 if [ "${CT_CONFIGURE_has_xz}" = "y" ]; then
421 if [ "${CT_CONFIGURE_has_lzma}" = "y" \
422 -o "${CT_CONFIGURE_has_xz}" = "y" ]; then
426 printf ".tar.gz\n.tgz\n"
430 # Get the file name extension of a component
431 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
432 # If found, echoes the extension to stdout, and return 0
433 # If not found, echoes nothing on stdout, and return !0.
434 CT_GetFileExtension() {
440 # we need to also check for an empty extension for those very
441 # peculiar components that don't have one (such as sstrip from
443 for ext in ${first_ext} $(CT_DoListTarballExt) /.git ''; do
444 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
453 # Try to retrieve the specified URL (HTTP or FTP)
454 # Usage: CT_DoGetFile <URL>
455 # This functions always returns true (0), as it can be legitimate not
456 # to find the requested URL (think about snapshots, different layouts
457 # for different gcc versions, etc...).
460 local dest="${CT_TARBALLS_DIR}/${url##*/}"
461 local tmp="${dest}.tmp-dl"
463 # Remove potential left-over from a previous run
466 # We also retry a few times, in case there is a transient error (eg. behind
467 # a dynamic IP that changes during the transfer...)
468 # With automated download as we are doing, it can be very dangerous to
469 # continue the downloads. It's far better to simply overwrite the
471 # Some company networks have firewalls to connect to the internet, but it's
472 # not easy to detect them, so force a global ${CT_CONNECT_TIMEOUT}-second
474 # For curl, no good progress indicator is available. So, be silent.
475 if CT_DoExecLog ALL wget --passive-ftp --tries=3 -nc \
476 --progress=dot:binary \
477 -T ${CT_CONNECT_TIMEOUT} \
481 # Success, we got it, good!
482 mv "${tmp}" "${dest}"
489 # This function tries to retrieve a tarball form a local directory
490 # Usage: CT_GetLocal <basename> [.extension]
496 # Do we already have it in *our* tarballs dir?
497 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
498 CT_DoLog DEBUG "Already have '${basename}'"
502 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
503 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
504 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
505 # or, as a failover, a file without extension.
506 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
507 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
508 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
509 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
510 CT_DoLog DEBUG "Got '${basename}' from local storage"
511 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
519 # This function saves the specified to local storage if possible,
520 # and if so, symlinks it for later usage
521 # Usage: CT_SaveLocal </full/path/file.name>
524 local basename="${file##*/}"
526 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
527 CT_DoLog EXTRA "Saving '${basename}' to local storage"
528 # The file may already exist if downloads are forced: remove it first
529 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
530 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
531 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
535 # Download the file from one of the URLs passed as argument
536 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
544 # If next argument starts with a dot, then this is not an URL,
545 # and we can consider that it is a preferred extension.
552 # Does it exist localy?
553 if CT_GetLocal "${file}" ${first_ext}; then
558 # If not allowed to download from the Internet, don't
559 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
560 CT_DoLog DEBUG "Not allowed to download from the Internet, aborting ${file} download"
564 # Try to retrieve the file
565 CT_DoLog EXTRA "Retrieving '${file}'"
567 # Add URLs on the LAN mirror
568 if [ "${CT_USE_MIRROR}" = "y" ]; then
569 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
570 URLS+=( "${CT_MIRROR_BASE_URL}/${file%-*}" )
571 URLS+=( "${CT_MIRROR_BASE_URL}" )
574 if [ "${CT_FORCE_MIRROR}" != "y" ]; then
578 # Scan all URLs in turn, and try to grab a tarball from there
579 # Do *not* try git trees (ext=/.git), this is handled in a specific
581 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
582 # Try all urls in turn
583 for url in "${URLS[@]}"; do
584 [ -n "${url}" ] || continue
585 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
586 CT_DoGetFile "${url}/${file}${ext}"
587 if [ -f "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
588 CT_DoLog DEBUG "Got '${file}' from the Internet"
589 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
595 # Just return error, someone may want to catch and handle the error
596 # (eg. glibc/eglibc add-ons can be missing).
600 # Checkout from CVS, and build the associated tarball
601 # The tarball will be called ${basename}.tar.bz2
602 # Prerequisite: either the server does not require password,
603 # or the user must already be logged in.
604 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
605 # If dirname is specified, then module will be renamed to dirname
606 # prior to building the tarball.
607 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
608 # Note: if '=subdir' is given, then it is used instead of 'module'.
613 local tag="${4:+-r ${4}}"
617 # First try locally, then the mirror
618 if CT_GetFile "${basename}"; then
619 # Got it! Return early! :-)
623 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
624 CT_DoLog WARN "Downloads forbidden, not trying cvs retrieval"
629 CT_Pushd "${tmp_dir}"
631 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
632 if [ -n "${dirname}" ]; then
635 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
636 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
639 CT_DoExecLog ALL mv "${module}" "${dirname}"
640 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
644 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
647 CT_DoExecLog ALL rm -rf "${tmp_dir}"
650 # Check out from SVN, and build the associated tarball
651 # The tarball will be called ${basename}.tar.bz2
652 # Prerequisite: either the server does not require password,
653 # or the user must already be logged in.
654 # 'rev' is the revision to retrieve
655 # Usage: CT_GetSVN <basename> <url> [rev]
661 # First try locally, then the mirror
662 if CT_GetFile "${basename}"; then
663 # Got it! Return early! :-)
667 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
668 CT_DoLog WARN "Downloads forbidden, not trying svn retrieval"
673 CT_Pushd "${tmp_dir}"
675 if ! CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"; then
676 CT_DoLog WARN "Could not retrieve '${basename}'"
679 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
680 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
683 CT_DoExecLog ALL rm -rf "${tmp_dir}"
687 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
688 # Prerequisites: either the server does not require password,
689 # or the user has already taken any action to authenticate to the server.
690 # The cloned tree will *not* be stored in the local tarballs dir!
691 # Usage: CT_GetGit <basename> <url [url ...]>
693 local basename="$1"; shift
697 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
698 CT_DoLog WARN "Downloads forbidden, not trying git retrieval"
702 # Do we have it in our tarballs dir?
703 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
704 CT_DoLog EXTRA "Updating git tree '${basename}'"
705 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
706 CT_DoExecLog ALL git pull
709 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
710 for url in "${@}"; do
711 CT_DoLog ALL "Trying to clone from '${url}'"
712 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
713 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
718 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
723 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
724 # must be extracted in the glibc directory; uCLibc locales must be extracted
725 # in the extra/locale sub-directory of uClibc. This is taken into account
726 # by the caller, that did a 'cd' into the correct path before calling us
727 # and sets nochdir to 'nochdir'.
728 # Note also that this function handles the git trees!
729 # Usage: CT_Extract <basename> [nochdir] [options]
730 # where 'options' are dependent on the source (eg. git branch/tag...)
738 if [ "${nochdir}" = "nochdir" ]; then
742 nochdir="${CT_SRC_DIR}"
748 if ! ext="$(CT_GetFileExtension "${basename}")"; then
749 CT_DoLog WARN "'${basename}' not found in '${CT_TARBALLS_DIR}'"
752 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
754 # Check if already extracted
755 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
756 CT_DoLog DEBUG "Already extracted '${basename}'"
760 # Check if previously partially extracted
761 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
762 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
763 CT_DoLog ERROR "Please remove first:"
764 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
765 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
766 CT_Abort "I'll stop now to avoid any carnage..."
768 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
770 CT_Pushd "${nochdir}"
772 CT_DoLog EXTRA "Extracting '${basename}'"
773 CT_DoExecLog FILE mkdir -p "${basename}"
774 tar_opts=( "--strip-components=1" )
775 tar_opts+=( "-C" "${basename}" )
779 # - lzma can be handled either with 'xz' or 'lzma'
780 # - we get lzma tarball only if either or both are available
781 # - so, if we get an lzma tarball, and either 'xz' or 'lzma' is
782 # missing, we can assume the other is available
783 if [ "${CT_CONFIGURE_has_lzma}" = "y" ]; then
784 lzma_prog="lzma -fdc"
789 .tar.xz) xz -fdc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
790 .tar.lzma) ${lzma_prog} "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
791 .tar.bz2) bzip2 -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
792 .tar.gz|.tgz) gzip -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
793 .tar) CT_DoExecLog FILE tar "${tar_opts[@]}" -f "${full_file}";;
794 /.git) CT_ExtractGit "${basename}" "${@}";;
795 *) CT_DoLog WARN "Don't know how to handle '${basename}${ext}': unknown extension"
800 # Don't mark as being extracted for git
803 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
805 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
810 # Create a working git clone of a local git repository
811 # Usage: CT_ExtractGit <basename> [ref]
812 # where 'ref' is the reference to use:
813 # the full name of a branch, like "remotes/origin/branch_name"
814 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
816 # If 'ref' is not given, the current repository HEAD will be used
818 local basename="${1}"
823 # pushd now to be able to get git revlist in case ref is a date
824 repo="${CT_TARBALLS_DIR}/${basename}"
827 # What kind of reference is ${ref} ?
828 if [ -z "${ref}" ]; then
830 ref=$(git rev-list -n1 HEAD)
831 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
833 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
835 elif date -d "${ref}" >/dev/null 2>&1; then
837 ref=$(git rev-list -n1 --before="${ref}")
839 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
844 CT_DoExecLog FILE rmdir "${basename}"
845 case "${ref_type}" in
846 branch) CT_DoExecLog FILE git clone -b "${ref}" "${repo}" "${basename}" ;;
847 *) CT_DoExecLog FILE git clone "${repo}" "${basename}"
848 CT_Pushd "${basename}"
849 CT_DoExecLog FILE git checkout "${ref}"
855 # Patches the specified component
856 # See CT_Extract, above, for explanations on 'nochdir'
857 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
858 # If the package directory is *not* packagename-packageversion, then
859 # the caller must cd into the proper directory first, and call us
870 local bundled_patch_dir
871 local local_patch_dir
873 if [ "${nochdir}" = "nochdir" ]; then
877 pkgdir="${pkgname}-${version}"
882 pkgdir="${pkgname}-${version}"
883 nochdir="${CT_SRC_DIR}/${pkgdir}"
886 # Check if already patched
887 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
888 CT_DoLog DEBUG "Already patched '${pkgdir}'"
892 # Check if already partially patched
893 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
894 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
895 CT_DoLog ERROR "Please remove first:"
896 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
897 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
898 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
899 CT_Abort "I'll stop now to avoid any carnage..."
901 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
903 CT_Pushd "${nochdir}"
905 CT_DoLog EXTRA "Patching '${pkgdir}'"
907 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
908 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
910 case "${CT_PATCH_ORDER}" in
911 bundled) patch_dirs=("${bundled_patch_dir}");;
912 local) patch_dirs=("${local_patch_dir}");;
913 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
914 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
918 for d in "${patch_dirs[@]}"; do
919 CT_DoLog DEBUG "Looking for patches in '${d}'..."
920 if [ -n "${d}" -a -d "${d}" ]; then
921 for p in "${d}"/*.patch; do
922 if [ -f "${p}" ]; then
923 CT_DoLog DEBUG "Applying patch '${p}'"
924 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
927 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
933 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
934 CT_DoLog ALL "Overiding config.guess and config.sub"
935 for cfg in config_guess config_sub; do
936 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
937 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
938 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
939 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
943 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
944 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
949 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
950 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
952 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
953 "${CT_TOP_DIR}/scripts/config.guess"
955 "${CT_LIB_DIR}/scripts/config.guess"
960 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
961 "${CT_TOP_DIR}/scripts/config.sub" "$@"
963 "${CT_LIB_DIR}/scripts/config.sub" "$@"
967 # Compute the target tuple from what is provided by the user
968 # Usage: CT_DoBuildTargetTuple
969 # In fact this function takes the environment variables to build the target
970 # tuple. It is needed both by the normal build sequence, as well as the
971 # sample saving sequence.
972 CT_DoBuildTargetTuple() {
973 # Set the endianness suffix, and the default endianness gcc option
974 case "${CT_ARCH_ENDIAN}" in
978 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
979 CT_ARCH_ENDIAN_LDFLAG="-Wl,-EB"
984 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
985 CT_ARCH_ENDIAN_LDFLAG="-Wl,-EL"
989 # Build the default architecture tuple part
990 CT_TARGET_ARCH="${CT_ARCH}"
992 # Set defaults for the system part of the tuple. Can be overriden
993 # by architecture-specific values.
995 *glibc) CT_TARGET_SYS=gnu;;
996 uClibc) CT_TARGET_SYS=uclibc;;
997 *) CT_TARGET_SYS=elf;;
1000 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
1001 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
1002 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
1003 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
1004 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
1005 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
1006 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
1007 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
1009 case "${CT_ARCH_FLOAT}" in
1011 CT_ARCH_FLOAT_CFLAG="-mhard-float"
1012 CT_ARCH_WITH_FLOAT="--with-float=hard"
1015 CT_ARCH_FLOAT_CFLAG="-msoft-float"
1016 CT_ARCH_WITH_FLOAT="--with-float=soft"
1019 CT_ARCH_FLOAT_CFLAG="-mfloat-abi=softfp"
1020 CT_ARCH_WITH_FLOAT="--with-float=softfp"
1024 # Build the default kernel tuple part
1025 CT_TARGET_KERNEL="${CT_KERNEL}"
1027 # Overide the default values with the components specific settings
1028 CT_DoArchTupleValues
1029 CT_DoKernelTupleValues
1031 # Finish the target tuple construction
1032 CT_TARGET="${CT_TARGET_ARCH}"
1033 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
1034 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
1035 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
1039 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
1040 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
1042 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
1043 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
1044 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
1045 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
1046 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
1050 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
1051 # Prepare the target CFLAGS
1052 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
1053 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
1054 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
1055 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
1056 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
1057 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
1058 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
1060 # Now on for the target LDFLAGS
1061 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
1064 # This function does pause the build until the user strikes "Return"
1065 # Usage: CT_DoPause [optional_message]
1068 local message="${1:-Pausing for your pleasure}"
1069 CT_DoLog INFO "${message}"
1070 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
1074 # This function creates a tarball of the specified directory, but
1076 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
1077 CT_DoTarballIfExists() {
1081 local -a extra_tar_opts=( "$@" )
1084 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1085 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
1086 *) compress=( cat - ); tar_ext=;;
1089 if [ -d "${dir}" ]; then
1090 CT_DoLog DEBUG " Saving '${dir}'"
1091 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
1092 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
1093 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1095 CT_DoLog STATE " Not saving '${dir}': does not exist"
1099 # This function extracts a tarball to the specified directory, but
1100 # only if the tarball exists
1101 # Usage: CT_DoExtractTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
1102 CT_DoExtractTarballIfExists() {
1106 local -a extra_tar_opts=( "$@" )
1109 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1110 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
1111 *) uncompress=( cat ); tar_ext=;;
1114 if [ -f "${tarball}.tar${tar_ext}" ]; then
1115 CT_DoLog DEBUG " Restoring '${dir}'"
1116 CT_DoForceRmdir "${dir}"
1117 CT_DoExecLog DEBUG mkdir -p "${dir}"
1118 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
1119 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
1120 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1122 CT_DoLog STATE " Not restoring '${dir}': does not exist"
1126 # This function saves the state of the toolchain to be able to restart
1128 # Usage: CT_DoSaveState <next_step_name>
1130 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
1131 local state_name="$1"
1132 local state_dir="${CT_STATE_DIR}/${state_name}"
1134 # Log this to the log level required by the user
1135 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
1137 rm -rf "${state_dir}"
1138 mkdir -p "${state_dir}"
1140 CT_DoLog STATE " Saving environment and aliases"
1141 # We must omit shell functions, and some specific bash variables
1142 # that break when restoring the environment, later. We could do
1143 # all the processing in the awk script, but a sed is easier...
1146 $0~/^[^ ]+ \(\)/ { _p = 0; }
1148 $0 == "}" { _p = 1; }
1149 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1151 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1153 CT_DoTarballIfExists "${CT_BUILDTOOLS_PREFIX_DIR}" "${state_dir}/buildtools_dir"
1154 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1155 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1157 CT_DoLog STATE " Saving log file"
1159 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1160 y) gzip -3 -c "${tmp_log_file}" >"${state_dir}/log.gz";;
1161 *) cat "${tmp_log_file}" >"${state_dir}/log";;
1163 exec >>"${tmp_log_file}"
1166 # This function restores a previously saved state
1167 # Usage: CT_DoLoadState <state_name>
1169 local state_name="$1"
1170 local state_dir="${CT_STATE_DIR}/${state_name}"
1171 local old_RESTART="${CT_RESTART}"
1172 local old_STOP="${CT_STOP}"
1174 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1176 # We need to do something special with the log file!
1177 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1178 exec >"${state_dir}/tail.log"
1181 # Log this to the log level required by the user
1182 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1184 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1185 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1186 CT_DoExtractTarballIfExists "${state_dir}/buildtools_dir" "${CT_BUILDTOOLS_PREFIX_DIR}"
1188 # Restore the environment, discarding any error message
1189 # (for example, read-only bash internals)
1190 CT_DoLog STATE " Restoring environment"
1191 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1193 # Restore the new RESTART and STOP steps
1194 CT_RESTART="${old_RESTART}"
1195 CT_STOP="${old_STOP}"
1196 unset old_stop old_restart
1198 CT_DoLog STATE " Restoring log file"
1200 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1201 y) zcat "${state_dir}/log.gz" >"${tmp_log_file}";;
1202 *) cat "${state_dir}/log" >"${tmp_log_file}";;
1204 cat "${state_dir}/tail.log" >>"${tmp_log_file}"
1205 exec >>"${tmp_log_file}"
1206 rm -f "${state_dir}/tail.log"