1 # This file contains some usefull common functions -*- sh -*-
2 # Copyright 2007 Yann E. MORIN
3 # Licensed under the GPL v2. See COPYING in the root of this package
5 # Prepare the fault handler
14 # To avoid printing the backtace for each sub-shell
15 # up to the top-level, just remember we've dumped it
16 if [ ! -f "${CT_WORK_DIR}/backtrace" ]; then
17 touch "${CT_WORK_DIR}/backtrace"
19 # Print steps backtrace
20 step_depth=${CT_STEP_COUNT}
21 CT_STEP_COUNT=1 # To have a zero-indentation
25 for((step=step_depth; step>0; step--)); do
26 CT_DoLog ERROR ">> ${intro} in step '${CT_STEP_MESSAGE[${step}]}'"
30 # Print functions backtrace
31 intro="Error happened in"
33 for((depth=1; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
34 file="${BASH_SOURCE[${depth}]#${CT_LIB_DIR}/}"
35 func="${FUNCNAME[${depth}]}"
36 line="@${BASH_LINENO[${depth}-1]:-?}"
37 CT_DoLog ERROR ">> ${intro}: ${func}[${file}${line}]"
41 # If the user asked for interactive debugging, dump him/her to a shell
42 if [ "${CT_DEBUG_INTERACTIVE}" = "y" ]; then
43 # We do not want this sub-shell exit status to be caught, because
44 # it is absolutely legit that it exits with non-zero.
45 # Save the trap handler to restore it after our debug-shell
46 old_trap="$(trap -p ERR)"
50 printf "\r \n\nCurrent command"
51 if [ -n "${cur_cmd}" ]; then
52 printf ":\n %s\n" "${cur_cmd}"
56 printf "exited with error code: %d\n" ${ret}
57 printf "Please fix it up and finish by exiting the shell with one of these values:\n"
58 printf " 1 fixed, continue with next build command\n"
59 if [ -n "${cur_cmd}" ]; then
60 printf " 2 repeat this build command\n"
62 printf " 3 abort build\n\n"
64 ${bash} --rcfile <(printf "PS1='ct-ng:\w> '\nPROMPT_COMMAND=''\n") -i
67 1) printf "\nContinuing past the failed command.\n\n"
70 2) if [ -n "${cur_cmd}" ]; then
71 printf "\nRe-trying last command.\n\n"
76 *) printf "\nPlease exit with one of these values:\n"
77 printf " 1 fixed, continue with next build command\n"
78 if [ -n "${cur_cmd}" ]; then
79 printf " 2 repeat this build command\n"
81 printf " 3 abort build\n"
88 # Restore the trap handler
91 1) rm -f "${CT_WORK_DIR}/backtrace"; return;;
92 2) rm -f "${CT_WORK_DIR}/backtrace"; touch "${CT_BUILD_DIR}/repeat"; return;;
93 # 3 is an abort, continue...
98 # And finally, in top-level shell, print some hints
99 if [ ${BASH_SUBSHELL} -eq 0 ]; then
100 # Help diagnose the error
101 CT_STEP_COUNT=1 # To have a zero-indentation
103 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
104 CT_DoLog ERROR ">> For more info on this error, look at the file: '${tmp_log_file#${CT_TOP_DIR}/}'"
106 CT_DoLog ERROR ">> There is a list of known issues, some with workarounds, in:"
107 CT_DoLog ERROR ">> '${CT_DOC_DIR#${CT_TOP_DIR}/}/B - Known issues.txt'"
111 rm -f "${CT_WORK_DIR}/backtrace"
116 # Install the fault handler
119 # Inherit the fault handler in subshells and functions
122 # Make pipes fail on the _first_ failed command
123 # Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x
126 # Don't hash commands' locations, and search every time it is requested.
127 # This is slow, but needed because of the static/shared core gcc which shall
128 # always match to shared if it exists, and only fallback to static if the
129 # shared is not found
133 # - first of all, save stdout so we can see the live logs: fd #6
135 # - then point stdout to the log file
136 tmp_log_file="${CT_TOP_DIR}/build.log"
137 rm -f "${tmp_log_file}"
138 exec >>"${tmp_log_file}"
140 # The different log levels:
151 # Make it easy to use \n and !
155 # A function to log what is happening
156 # Different log level are available:
157 # - ERROR: A serious, fatal error occurred
158 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
159 # - INFO: Informational messages
160 # - EXTRA: Extra informational messages
161 # - CFG: Output of various "./configure"-type scripts
162 # - FILE: File / archive unpacking.
163 # - STATE: State save & restore
164 # - ALL: Component's build messages
165 # - DEBUG: Internal debug messages
166 # Usage: CT_DoLog <level> [message]
167 # If message is empty, then stdin will be logged.
169 local max_level LEVEL level cur_l cur_L
171 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
172 # Set the maximum log level to DEBUG if we have none
173 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
176 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
178 if [ $# -eq 0 ]; then
182 fi |( IFS="${CR}" # We want the full lines, even leading spaces
188 indent=$((2*CT_STEP_COUNT))
190 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
191 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
192 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
193 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
194 *"make["*"]: *** ["*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
195 *) cur_L="${LEVEL}"; cur_l="${level}";;
197 # There will always be a log file (stdout, fd #1), be it /dev/null
198 printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"
199 if [ ${cur_l} -le ${max_level} ]; then
200 # Only print to console (fd #6) if log level is high enough.
201 printf "${CT_LOG_PROGRESS_BAR:+\r}[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6
203 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
204 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6
205 _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))
213 # Execute an action, and log its messages
214 # It is possible to even log local variable assignments (a-la: var=val ./cmd opts)
215 # Usage: CT_DoExecLog <level> [VAR=val...] <command> [parameters...]
226 *=*) eval export "'${1}'"; shift;;
230 # This while-loop goes hand-in-hand with the ERR trap handler:
231 # - if the command terminates successfully, then we hit the break
232 # statement, and we exit the loop
233 # - if the command terminates in error, then the ERR handler kicks
235 # - if the user did *not* ask for interactive debugging, the ERR
236 # handler exits, and we hit the end of the sub-shell
237 # - if the user did ask for interactive debugging, the ERR handler
238 # spawns a shell. Upon termination of this shell, the ERR handler
239 # examines the exit status of the shell:
240 # - if 1, the ERR handler returns; then we hit the else statement,
241 # then the break, and we exit the 'while' loop, to continue the
243 # - if 2, the ERR handler touches the repeat file, and returns;
244 # then we hit the if statement, and we loop for one more
246 # - if 3, the ERR handler exits with the command's exit status,
248 # - for any other exit status of the shell, the ERR handler
249 # prints an informational message, and respawns the shell
251 # This allows a user to get an interactive shell that has the same
252 # environment (PATH and so on) that the failed command was ran with.
254 rm -f "${CT_BUILD_DIR}/repeat"
255 CT_DoLog DEBUG "==> Executing: ${cur_cmd}"
256 "${@}" 2>&1 |CT_DoLog "${level}"
257 if [ -f "${CT_BUILD_DIR}/repeat" ]; then
264 # Catch failure of the sub-shell
268 # Tail message to be logged whatever happens
269 # Usage: CT_DoEnd <level>
273 CT_STOP_DATE=$(CT_DoDate +%s%N)
274 CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)
275 if [ "${level}" != "ERROR" ]; then
276 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
278 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
279 elapsed_min=$((elapsed/(60*1000*1000*1000)))
280 elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))
281 elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))
282 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
285 # Remove entries referring to . and other relative paths
286 # Usage: CT_SanitizePath
292 # Only accept absolute paths;
293 # Note: as a special case the empty string in PATH is equivalent to .
294 if [ -n "${p}" -a -z "${p%%/*}" ]; then
295 new="${new}${new:+:}${p}"
301 # Sanitise the directory name contained in the variable passed as argument:
302 # - remove duplicate /
303 # Usage: CT_SanitiseVarDir CT_PREFIX_DIR
304 CT_SanitiseVarDir() {
310 eval "old_dir=\"\${${var}}\""
311 new_dir="$( printf "${old_dir}" \
312 |sed -r -e 's:/+:/:g;' \
314 eval "${var}=\"${new_dir}\""
315 CT_DoLog DEBUG "Sanitised '${var}': '${old_dir}' -> '${new_dir}'"
319 # Abort the execution with an error message
320 # Usage: CT_Abort <message>
326 # Test a condition, and print a message if satisfied
327 # Usage: CT_Test <message> <tests>
332 CT_DoLog DEBUG "Testing '! ( $* )'"
333 test "$@" && CT_DoLog WARN "$m"
337 # Test a condition, and abort with an error message if satisfied
338 # Usage: CT_TestAndAbort <message> <tests>
342 CT_DoLog DEBUG "Testing '! ( $* )'"
343 test "$@" && CT_Abort "$m"
347 # Test a condition, and abort with an error message if not satisfied
348 # Usage: CT_TestAndAbort <message> <tests>
352 CT_DoLog DEBUG "Testing '$*'"
353 test "$@" || CT_Abort "$m"
357 # Test the presence of a tool, or abort if not found
358 # Usage: CT_HasOrAbort <tool>
360 CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z "$(CT_Which "${1}")"
364 # Search a program: wrap "which" for those system where "which"
365 # verbosely says there is no match (such as on Mandriva).
366 # Usage: CT_Which <filename>
368 which "$1" 2>/dev/null || true
371 # Get current date with nanosecond precision
372 # On those system not supporting nanosecond precision, faked with rounding down
373 # to the highest entire second
374 # Usage: CT_DoDate <fmt>
376 date "$1" |sed -r -e 's/%?N$/000000000/;'
380 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="(top-level)"
381 # Memorise a step being done so that any error is caught
382 # Usage: CT_DoStep <loglevel> <message>
384 local start=$(CT_DoDate +%s%N)
385 CT_DoLog "$1" "================================================================="
387 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
388 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
389 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
390 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
394 # End the step just being done
397 local stop=$(CT_DoDate +%s%N)
398 local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
399 local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
400 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
401 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
402 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
403 CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
407 # Pushes into a directory, and pops back
409 pushd "$1" >/dev/null 2>&1
415 # Create a dir and cd or pushd into it
416 # Usage: CT_mkdir_cd <dir/to/create>
417 # CT_mkdir_pushd <dir/to/create>
431 # Creates a temporary directory
432 # $1: variable to assign to
433 # Usage: CT_MktempDir foo
435 # Some mktemp do not allow more than 6 Xs
436 eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")
437 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
438 CT_DoLog DEBUG "Made temporary directory '${!1}'"
442 # Removes one or more directories, even if it is read-only, or its parent is
443 # Usage: CT_DoForceRmdir dir [...]
447 for dir in "${@}"; do
448 [ -d "${dir}" ] || continue
451 mode="$(stat -c '%a' "$(dirname "${dir}")")"
454 mode="$(stat -f '%Lp' "$(dirname "${dir}")")"
457 CT_Abort "Unhandled host OS $CT_SYS_OS"
460 CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"
461 CT_DoExecLog ALL chmod -R u+w "${dir}"
462 CT_DoExecLog ALL rm -rf "${dir}"
463 CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"
467 # Echoes the specified string on stdout until the pipe breaks.
470 # Usage: CT_DoYes "" |make oldconfig
475 # Add the specified directory to LD_LIBRARY_PATH, and export it
476 # If the specified patch is already present, just export
478 # $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty
479 # Usage CT_SetLibPath /some/where/lib [first|last]
484 case ":${LD_LIBRARY_PATH}:" in
488 CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"
489 LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"
492 CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"
493 LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"
496 CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"
501 CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"
502 export LD_LIBRARY_PATH
505 # Build up the list of allowed tarball extensions
506 # Add them in the prefered order; most preferred comes first
507 CT_DoListTarballExt() {
508 if [ "${CT_CONFIGURE_has_xz}" = "y" ]; then
511 if [ "${CT_CONFIGURE_has_lzma}" = "y" \
512 -o "${CT_CONFIGURE_has_xz}" = "y" ]; then
516 printf ".tar.gz\n.tgz\n"
520 # Get the file name extension of a component
521 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
522 # If found, echoes the extension to stdout, and return 0
523 # If not found, echoes nothing on stdout, and return !0.
524 CT_GetFileExtension() {
530 # we need to also check for an empty extension for those very
531 # peculiar components that don't have one (such as sstrip from
533 for ext in ${first_ext} $(CT_DoListTarballExt) /.git ''; do
534 if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
543 # Try to retrieve the specified URL (HTTP or FTP)
544 # Usage: CT_DoGetFile <URL>
545 # This functions always returns true (0), as it can be legitimate not
546 # to find the requested URL (think about snapshots, different layouts
547 # for different gcc versions, etc...).
550 local dest="${CT_TARBALLS_DIR}/${url##*/}"
551 local tmp="${dest}.tmp-dl"
553 # Remove potential left-over from a previous run
556 # We also retry a few times, in case there is a transient error (eg. behind
557 # a dynamic IP that changes during the transfer...)
558 # With automated download as we are doing, it can be very dangerous to
559 # continue the downloads. It's far better to simply overwrite the
561 # Some company networks have firewalls to connect to the internet, but it's
562 # not easy to detect them, so force a global ${CT_CONNECT_TIMEOUT}-second
564 # For curl, no good progress indicator is available. So, be silent.
565 if CT_DoExecLog ALL wget --passive-ftp --tries=3 -nc \
566 --progress=dot:binary \
567 -T ${CT_CONNECT_TIMEOUT} \
571 # Success, we got it, good!
572 mv "${tmp}" "${dest}"
579 # This function tries to retrieve a tarball form a local directory
580 # Usage: CT_GetLocal <basename> [.extension]
586 # Do we already have it in *our* tarballs dir?
587 if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then
588 CT_DoLog DEBUG "Already have '${basename}'"
592 if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then
593 CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"
594 # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
595 # or, as a failover, a file without extension.
596 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
597 CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"
598 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \
599 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
600 CT_DoLog DEBUG "Got '${basename}' from local storage"
601 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"
609 # This function gets the custom source from either a tarball or directory
610 # Usage: CT_GetCustom <component> <custom_version> <custom_location>
612 local custom_component="$1"
613 local custom_version="$2"
614 local custom_location="$3"
615 local custom_name="${custom_component}-${custom_version}"
617 CT_TestAndAbort "${custom_name}: CT_CUSTOM_LOCATION_ROOT_DIR or ${custom_component}'s CUSTOM_LOCATION must be set." \
618 -z "${CT_CUSTOM_LOCATION_ROOT_DIR}" -a -z "${custom_location}"
620 if [ -n "${CT_CUSTOM_LOCATION_ROOT_DIR}" \
621 -a -z "${custom_location}" ]; then
622 custom_location="${CT_CUSTOM_LOCATION_ROOT_DIR}/${custom_component}"
625 CT_DoLog EXTRA "Using '${custom_name}' from custom location"
626 if [ ! -d "${custom_location}" ]; then
627 # We need to know the custom tarball extension,
628 # so we can create a properly-named symlink, which
629 # we use later on in 'extract'
630 case "${custom_location}" in
631 *.tar.bz2) custom_name="${custom_name}.tar.bz2";;
632 *.tar.gz|*.tgz) custom_name="${custom_name}.tar.gz";;
633 *.tar) custom_name="${custom_name}.tar";;
634 *) CT_Abort "Unknown extension for custom tarball '${custom_location}'";;
636 CT_DoExecLog DEBUG ln -sf "${custom_location}" \
637 "${CT_TARBALLS_DIR}/${custom_name}"
639 CT_DoExecLog DEBUG ln -snf "${custom_location}" \
640 "${CT_SRC_DIR}/${custom_name}"
644 # This function saves the specified to local storage if possible,
645 # and if so, symlinks it for later usage
646 # Usage: CT_SaveLocal </full/path/file.name>
649 local basename="${file##*/}"
651 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
652 CT_DoLog EXTRA "Saving '${basename}' to local storage"
653 # The file may already exist if downloads are forced: remove it first
654 CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"
655 CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"
656 CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"
660 # Download the file from one of the URLs passed as argument
661 # Usage: CT_GetFile <basename> [.extension] <url> [url ...]
669 # If next argument starts with a dot, then this is not an URL,
670 # and we can consider that it is a preferred extension.
677 # Does it exist localy?
678 if CT_GetLocal "${file}" ${first_ext}; then
683 # If not allowed to download from the Internet, don't
684 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
685 CT_DoLog DEBUG "Not allowed to download from the Internet, aborting ${file} download"
689 # Try to retrieve the file
690 CT_DoLog EXTRA "Retrieving '${file}'"
692 # Add URLs on the LAN mirror
693 if [ "${CT_USE_MIRROR}" = "y" ]; then
694 CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"
695 URLS+=( "${CT_MIRROR_BASE_URL}/${file%-*}" )
696 URLS+=( "${CT_MIRROR_BASE_URL}" )
699 if [ "${CT_FORCE_MIRROR}" != "y" ]; then
703 # Scan all URLs in turn, and try to grab a tarball from there
704 # Do *not* try git trees (ext=/.git), this is handled in a specific
706 for ext in ${first_ext} $(CT_DoListTarballExt) ''; do
707 # Try all urls in turn
708 for url in "${URLS[@]}"; do
709 [ -n "${url}" ] || continue
710 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
711 CT_DoGetFile "${url}/${file}${ext}"
712 if [ -f "${CT_TARBALLS_DIR}/${file}${ext}" ]; then
713 CT_DoLog DEBUG "Got '${file}' from the Internet"
714 CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"
720 # Just return error, someone may want to catch and handle the error
721 # (eg. glibc/eglibc add-ons can be missing).
725 # Checkout from CVS, and build the associated tarball
726 # The tarball will be called ${basename}.tar.bz2
727 # Prerequisite: either the server does not require password,
728 # or the user must already be logged in.
729 # 'tag' is the tag to retrieve. Must be specified, but can be empty.
730 # If dirname is specified, then module will be renamed to dirname
731 # prior to building the tarball.
732 # Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]
733 # Note: if '=subdir' is given, then it is used instead of 'module'.
738 local tag="${4:+-r ${4}}"
742 # First try locally, then the mirror
743 if CT_GetFile "${basename}"; then
744 # Got it! Return early! :-)
748 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
749 CT_DoLog WARN "Downloads forbidden, not trying cvs retrieval"
754 CT_Pushd "${tmp_dir}"
756 CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"
757 if [ -n "${dirname}" ]; then
760 CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"
761 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"
764 CT_DoExecLog ALL mv "${module}" "${dirname}"
765 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"
769 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
772 CT_DoExecLog ALL rm -rf "${tmp_dir}"
775 # Check out from SVN, and build the associated tarball
776 # The tarball will be called ${basename}.tar.bz2
777 # Prerequisite: either the server does not require password,
778 # or the user must already be logged in.
779 # 'rev' is the revision to retrieve
780 # Usage: CT_GetSVN <basename> <url> [rev]
786 # First try locally, then the mirror
787 if CT_GetFile "${basename}"; then
788 # Got it! Return early! :-)
792 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
793 CT_DoLog WARN "Downloads forbidden, not trying svn retrieval"
798 CT_Pushd "${tmp_dir}"
800 if ! CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"; then
801 CT_DoLog WARN "Could not retrieve '${basename}'"
804 CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"
805 CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"
808 CT_DoExecLog ALL rm -rf "${tmp_dir}"
812 # Tries the given URLs in turn until one can get cloned. No tarball will be created.
813 # Prerequisites: either the server does not require password,
814 # or the user has already taken any action to authenticate to the server.
815 # The cloned tree will *not* be stored in the local tarballs dir!
816 # Usage: CT_GetGit <basename> <url [url ...]>
818 local basename="$1"; shift
822 if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then
823 CT_DoLog WARN "Downloads forbidden, not trying git retrieval"
827 # Do we have it in our tarballs dir?
828 if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then
829 CT_DoLog EXTRA "Updating git tree '${basename}'"
830 CT_Pushd "${CT_TARBALLS_DIR}/${basename}"
831 CT_DoExecLog ALL git pull
834 CT_DoLog EXTRA "Retrieving git tree '${basename}'"
835 for url in "${@}"; do
836 CT_DoLog ALL "Trying to clone from '${url}'"
837 CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"
838 if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then
843 CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0
848 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
849 # must be extracted in the glibc directory; uCLibc locales must be extracted
850 # in the extra/locale sub-directory of uClibc. This is taken into account
851 # by the caller, that did a 'cd' into the correct path before calling us
852 # and sets nochdir to 'nochdir'.
853 # Note also that this function handles the git trees!
854 # Usage: CT_Extract <basename> [nochdir] [options]
855 # where 'options' are dependent on the source (eg. git branch/tag...)
863 if [ "${nochdir}" = "nochdir" ]; then
867 nochdir="${CT_SRC_DIR}"
873 if ! ext="$(CT_GetFileExtension "${basename}")"; then
874 CT_DoLog WARN "'${basename}' not found in '${CT_TARBALLS_DIR}'"
877 local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"
879 # Check if already extracted
880 if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then
881 CT_DoLog DEBUG "Already extracted '${basename}'"
885 # Check if previously partially extracted
886 if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then
887 CT_DoLog ERROR "The '${basename}' sources were partially extracted."
888 CT_DoLog ERROR "Please remove first:"
889 CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"
890 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"
891 CT_Abort "I'll stop now to avoid any carnage..."
893 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"
895 CT_Pushd "${nochdir}"
897 CT_DoLog EXTRA "Extracting '${basename}'"
898 CT_DoExecLog FILE mkdir -p "${basename}"
899 tar_opts=( "--strip-components=1" )
900 tar_opts+=( "-C" "${basename}" )
904 # - lzma can be handled either with 'xz' or 'lzma'
905 # - we get lzma tarball only if either or both are available
906 # - so, if we get an lzma tarball, and either 'xz' or 'lzma' is
907 # missing, we can assume the other is available
908 if [ "${CT_CONFIGURE_has_lzma}" = "y" ]; then
909 lzma_prog="lzma -fdc"
914 .tar.xz) xz -fdc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
915 .tar.lzma) ${lzma_prog} "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
916 .tar.bz2) bzip2 -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
917 .tar.gz|.tgz) gzip -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;
918 .tar) CT_DoExecLog FILE tar "${tar_opts[@]}" -f "${full_file}";;
919 /.git) CT_ExtractGit "${basename}" "${@}";;
920 *) CT_DoLog WARN "Don't know how to handle '${basename}${ext}': unknown extension"
925 # Don't mark as being extracted for git
928 *) CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;
930 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"
935 # Create a working git clone of a local git repository
936 # Usage: CT_ExtractGit <basename> [ref]
937 # where 'ref' is the reference to use:
938 # the full name of a branch, like "remotes/origin/branch_name"
939 # a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"
941 # If 'ref' is not given, the current repository HEAD will be used
943 local basename="${1}"
948 # pushd now to be able to get git revlist in case ref is a date
949 repo="${CT_TARBALLS_DIR}/${basename}"
952 # What kind of reference is ${ref} ?
953 if [ -z "${ref}" ]; then
955 ref=$(git rev-list -n1 HEAD)
956 elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then
958 elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then
960 elif date -d "${ref}" >/dev/null 2>&1; then
962 ref=$(git rev-list -n1 --before="${ref}")
964 CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"
969 CT_DoExecLog FILE rmdir "${basename}"
970 case "${ref_type}" in
971 branch) CT_DoExecLog FILE git clone -b "${ref}" "${repo}" "${basename}" ;;
972 *) CT_DoExecLog FILE git clone "${repo}" "${basename}"
973 CT_Pushd "${basename}"
974 CT_DoExecLog FILE git checkout "${ref}"
980 # Patches the specified component
981 # See CT_Extract, above, for explanations on 'nochdir'
982 # Usage: CT_Patch [nochdir] <packagename> <packageversion>
983 # If the package directory is *not* packagename-packageversion, then
984 # the caller must cd into the proper directory first, and call us
995 local bundled_patch_dir
996 local local_patch_dir
998 if [ "${nochdir}" = "nochdir" ]; then
1002 pkgdir="${pkgname}-${version}"
1007 pkgdir="${pkgname}-${version}"
1008 nochdir="${CT_SRC_DIR}/${pkgdir}"
1011 # Check if already patched
1012 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patched" ]; then
1013 CT_DoLog DEBUG "Already patched '${pkgdir}'"
1017 # Check if already partially patched
1018 if [ -e "${CT_SRC_DIR}/.${pkgdir}.patching" ]; then
1019 CT_DoLog ERROR "The '${pkgdir}' sources were partially patched."
1020 CT_DoLog ERROR "Please remove first:"
1021 CT_DoLog ERROR " - the source dir for '${pkgdir}', in '${CT_SRC_DIR}'"
1022 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.extracted'"
1023 CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${pkgdir}.patching'"
1024 CT_Abort "I'll stop now to avoid any carnage..."
1026 touch "${CT_SRC_DIR}/.${pkgdir}.patching"
1028 CT_Pushd "${nochdir}"
1030 CT_DoLog EXTRA "Patching '${pkgdir}'"
1032 bundled_patch_dir="${CT_LIB_DIR}/patches/${pkgname}/${version}"
1033 local_patch_dir="${CT_LOCAL_PATCH_DIR}/${pkgname}/${version}"
1035 case "${CT_PATCH_ORDER}" in
1036 bundled) patch_dirs=("${bundled_patch_dir}");;
1037 local) patch_dirs=("${local_patch_dir}");;
1038 bundled,local) patch_dirs=("${bundled_patch_dir}" "${local_patch_dir}");;
1039 local,bundled) patch_dirs=("${local_patch_dir}" "${bundled_patch_dir}");;
1043 for d in "${patch_dirs[@]}"; do
1044 CT_DoLog DEBUG "Looking for patches in '${d}'..."
1045 if [ -n "${d}" -a -d "${d}" ]; then
1046 for p in "${d}"/*.patch; do
1047 if [ -f "${p}" ]; then
1048 CT_DoLog DEBUG "Applying patch '${p}'"
1049 CT_DoExecLog ALL patch --no-backup-if-mismatch -g0 -F1 -p1 -f <"${p}"
1052 if [ "${CT_PATCH_SINGLE}" = "y" ]; then
1058 if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
1059 CT_DoLog ALL "Overiding config.guess and config.sub"
1060 for cfg in config_guess config_sub; do
1061 eval ${cfg}="${CT_LIB_DIR}/scripts/${cfg/_/.}"
1062 [ -e "${CT_TOP_DIR}/scripts/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/scripts/${cfg/_/.}"
1063 # Can't use CT_DoExecLog because of the '{} \;' to be passed un-mangled to find
1064 find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
1068 CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${pkgdir}.patched"
1069 CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${pkgdir}.patching"
1074 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
1075 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
1076 CT_DoConfigGuess() {
1077 if [ -x "${CT_TOP_DIR}/scripts/config.guess" ]; then
1078 "${CT_TOP_DIR}/scripts/config.guess"
1080 "${CT_LIB_DIR}/scripts/config.guess"
1085 if [ -x "${CT_TOP_DIR}/scripts/config.sub" ]; then
1086 "${CT_TOP_DIR}/scripts/config.sub" "$@"
1088 "${CT_LIB_DIR}/scripts/config.sub" "$@"
1092 # Compute the target tuple from what is provided by the user
1093 # Usage: CT_DoBuildTargetTuple
1094 # In fact this function takes the environment variables to build the target
1095 # tuple. It is needed both by the normal build sequence, as well as the
1096 # sample saving sequence.
1097 CT_DoBuildTargetTuple() {
1098 # Set the endianness suffix, and the default endianness gcc option
1099 case "${CT_ARCH_ENDIAN}" in
1103 CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
1104 CT_ARCH_ENDIAN_LDFLAG="-Wl,-EB"
1109 CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
1110 CT_ARCH_ENDIAN_LDFLAG="-Wl,-EL"
1114 # Build the default architecture tuple part
1115 CT_TARGET_ARCH="${CT_ARCH}"
1117 # Set defaults for the system part of the tuple. Can be overriden
1118 # by architecture-specific values.
1119 case "${CT_LIBC}" in
1120 *glibc) CT_TARGET_SYS=gnu;;
1121 uClibc) CT_TARGET_SYS=uclibc;;
1122 *) CT_TARGET_SYS=elf;;
1125 # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
1126 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
1127 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
1128 [ "${CT_ARCH_ARCH}" ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}"; CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
1129 [ "${CT_ARCH_ABI}" ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}"; CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}"; }
1130 [ "${CT_ARCH_CPU}" ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}"; CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}"; }
1131 [ "${CT_ARCH_TUNE}" ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}"; CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
1132 [ "${CT_ARCH_FPU}" ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}"; CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}"; }
1134 case "${CT_ARCH_FLOAT}" in
1136 CT_ARCH_FLOAT_CFLAG="-mhard-float"
1137 CT_ARCH_WITH_FLOAT="--with-float=hard"
1140 CT_ARCH_FLOAT_CFLAG="-msoft-float"
1141 CT_ARCH_WITH_FLOAT="--with-float=soft"
1144 CT_ARCH_FLOAT_CFLAG="-mfloat-abi=softfp"
1145 CT_ARCH_WITH_FLOAT="--with-float=softfp"
1149 # Build the default kernel tuple part
1150 CT_TARGET_KERNEL="${CT_KERNEL}"
1152 # Overide the default values with the components specific settings
1153 CT_DoArchTupleValues
1154 CT_DoKernelTupleValues
1156 # Finish the target tuple construction
1157 CT_TARGET="${CT_TARGET_ARCH}"
1158 CT_TARGET="${CT_TARGET}${CT_TARGET_VENDOR:+-${CT_TARGET_VENDOR}}"
1159 CT_TARGET="${CT_TARGET}${CT_TARGET_KERNEL:+-${CT_TARGET_KERNEL}}"
1160 CT_TARGET="${CT_TARGET}${CT_TARGET_SYS:+-${CT_TARGET_SYS}}"
1164 if [ -n "${CT_TARGET_ALIAS_SED_EXPR}" ]; then
1165 __sed_alias=$(echo "${CT_TARGET}" |sed -r -e "${CT_TARGET_ALIAS_SED_EXPR}")
1167 case ":${CT_TARGET_VENDOR}:${CT_TARGET_ALIAS}:${__sed_alias}:" in
1168 :*" "*:*:*:) CT_Abort "Don't use spaces in the vendor string, it breaks things.";;
1169 :*"-"*:*:*:) CT_Abort "Don't use dashes in the vendor string, it breaks things.";;
1170 :*:*" "*:*:) CT_Abort "Don't use spaces in the target alias, it breaks things.";;
1171 :*:*:*" "*:) CT_Abort "Don't use spaces in the target sed transform, it breaks things.";;
1175 CT_TARGET=$(CT_DoConfigSub "${CT_TARGET}")
1176 # Prepare the target CFLAGS
1177 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ENDIAN_CFLAG}"
1178 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
1179 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
1180 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
1181 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
1182 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
1183 CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
1185 # Now on for the target LDFLAGS
1186 CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_TARGET_LDFLAGS} ${CT_ARCH_ENDIAN_LDFLAG}"
1189 # This function does pause the build until the user strikes "Return"
1190 # Usage: CT_DoPause [optional_message]
1193 local message="${1:-Pausing for your pleasure}"
1194 CT_DoLog INFO "${message}"
1195 read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
1199 # This function creates a tarball of the specified directory, but
1201 # Usage: CT_DoTarballIfExists <dir> <tarball_basename> [extra_tar_options [...]]
1202 CT_DoTarballIfExists() {
1206 local -a extra_tar_opts=( "$@" )
1209 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1210 y) compress=( gzip -c -3 - ); tar_ext=.gz;;
1211 *) compress=( cat - ); tar_ext=;;
1214 if [ -d "${dir}" ]; then
1215 CT_DoLog DEBUG " Saving '${dir}'"
1216 { tar c -C "${dir}" -v -f - "${extra_tar_opts[@]}" . \
1217 |"${compress[@]}" >"${tarball}.tar${tar_ext}" ;
1218 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1220 CT_DoLog STATE " Not saving '${dir}': does not exist"
1224 # This function extracts a tarball to the specified directory, but
1225 # only if the tarball exists
1226 # Usage: CT_DoExtractTarballIfExists <tarball_basename> <dir> [extra_tar_options [...]]
1227 CT_DoExtractTarballIfExists() {
1231 local -a extra_tar_opts=( "$@" )
1234 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1235 y) uncompress=( gzip -c -d ); tar_ext=.gz;;
1236 *) uncompress=( cat ); tar_ext=;;
1239 if [ -f "${tarball}.tar${tar_ext}" ]; then
1240 CT_DoLog DEBUG " Restoring '${dir}'"
1241 CT_DoForceRmdir "${dir}"
1242 CT_DoExecLog DEBUG mkdir -p "${dir}"
1243 { "${uncompress[@]}" "${tarball}.tar${tar_ext}" \
1244 |tar x -C "${dir}" -v -f - "${extra_tar_opts[@]}" ;
1245 } 2>&1 |sed -r -e 's/^/ /;' |CT_DoLog STATE
1247 CT_DoLog STATE " Not restoring '${dir}': does not exist"
1251 # This function saves the state of the toolchain to be able to restart
1253 # Usage: CT_DoSaveState <next_step_name>
1255 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
1256 local state_name="$1"
1257 local state_dir="${CT_STATE_DIR}/${state_name}"
1259 # Log this to the log level required by the user
1260 CT_DoLog ${CT_LOG_LEVEL_MAX} "Saving state to restart at step '${state_name}'..."
1262 rm -rf "${state_dir}"
1263 mkdir -p "${state_dir}"
1265 CT_DoLog STATE " Saving environment and aliases"
1266 # We must omit shell functions, and some specific bash variables
1267 # that break when restoring the environment, later. We could do
1268 # all the processing in the awk script, but a sed is easier...
1271 $0~/^[^ ]+ \(\)/ { _p = 0; }
1273 $0 == "}" { _p = 1; }
1274 ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
1276 /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
1278 CT_DoTarballIfExists "${CT_BUILDTOOLS_PREFIX_DIR}" "${state_dir}/buildtools_dir"
1279 CT_DoTarballIfExists "${CT_CONFIG_DIR}" "${state_dir}/config_dir"
1280 CT_DoTarballIfExists "${CT_PREFIX_DIR}" "${state_dir}/prefix_dir" --exclude '*.log'
1282 CT_DoLog STATE " Saving log file"
1284 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1285 y) gzip -3 -c "${tmp_log_file}" >"${state_dir}/log.gz";;
1286 *) cat "${tmp_log_file}" >"${state_dir}/log";;
1288 exec >>"${tmp_log_file}"
1291 # This function restores a previously saved state
1292 # Usage: CT_DoLoadState <state_name>
1294 local state_name="$1"
1295 local state_dir="${CT_STATE_DIR}/${state_name}"
1296 local old_RESTART="${CT_RESTART}"
1297 local old_STOP="${CT_STOP}"
1299 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
1301 # We need to do something special with the log file!
1302 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
1303 exec >"${state_dir}/tail.log"
1306 # Log this to the log level required by the user
1307 CT_DoLog ${CT_LOG_LEVEL_MAX} "Restoring state at step '${state_name}', as requested."
1309 CT_DoExtractTarballIfExists "${state_dir}/prefix_dir" "${CT_PREFIX_DIR}"
1310 CT_DoExtractTarballIfExists "${state_dir}/config_dir" "${CT_CONFIG_DIR}"
1311 CT_DoExtractTarballIfExists "${state_dir}/buildtools_dir" "${CT_BUILDTOOLS_PREFIX_DIR}"
1313 # Restore the environment, discarding any error message
1314 # (for example, read-only bash internals)
1315 CT_DoLog STATE " Restoring environment"
1316 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
1318 # Restore the new RESTART and STOP steps
1319 CT_RESTART="${old_RESTART}"
1320 CT_STOP="${old_STOP}"
1321 unset old_stop old_restart
1323 CT_DoLog STATE " Restoring log file"
1325 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
1326 y) zcat "${state_dir}/log.gz" >"${tmp_log_file}";;
1327 *) cat "${state_dir}/log" >"${tmp_log_file}";;
1329 cat "${state_dir}/tail.log" >>"${tmp_log_file}"
1330 exec >>"${tmp_log_file}"
1331 rm -f "${state_dir}/tail.log"