Update version to -svn.
1 # This file contains some usefull common functions
2 # Copyright 2007 Yann E. MORIN
3 # Licensed under the GPL v2. See COPYING in the root of this package
5 # Prepare the fault handler
8 CT_DoLog ERROR "Build failed in step \"${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}\""
9 for((step=(CT_STEP_COUNT-1); step>1; step--)); do
10 CT_DoLog ERROR " called in step \"${CT_STEP_MESSAGE[${step}]}\""
12 CT_DoLog ERROR "Error happened in \"${BASH_SOURCE[1]}\" in function \"${FUNCNAME[1]}\" (line unknown, sorry)"
13 for((depth=2; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
14 CT_DoLog ERROR " called from \"${BASH_SOURCE[${depth}]}\" at line # ${BASH_LINENO[${depth}-1]} in function \"${FUNCNAME[${depth}]}\""
16 [ "${CT_LOG_TO_FILE}" = "y" ] && CT_DoLog ERROR "Look at \"${CT_LOG_FILE}\" for more info on this error."
22 # Install the fault handler
25 # Inherit the fault handler in subshells and functions
28 # Make pipes fail on the _first_ failed command
29 # Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x
32 # Don't hash commands' locations, and search every time it is requested.
33 # This is slow, but needed because of the static/shared core gcc which shall
34 # always match to shared if it exists, and only fallback to static if the
39 # - first of all, save stdout so we can see the live logs: fd #6
41 # - then point stdout to the log file (temporary for now)
42 tmp_log_file="${CT_TOP_DIR}/log.$$"
43 exec >>"${tmp_log_file}"
45 # The different log levels:
53 # A function to log what is happening
54 # Different log level are available:
55 # - ERROR: A serious, fatal error occurred
56 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
57 # - INFO: Informational messages
58 # - EXTRA: Extra informational messages
59 # - DEBUG: Debug messages
60 # - ALL: Component's build messages
61 # Usage: CT_DoLog <level> [message]
62 # If message is empty, then stdin will be logged.
64 local max_level LEVEL level cur_l cur_L
66 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
67 # Set the maximum log level to DEBUG if we have none
68 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
71 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
77 fi |( IFS="\n" # We want the full lines, even leading spaces
79 indent=$((2*CT_STEP_COUNT))
81 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
82 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
83 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
84 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
85 *"make["?*"]:"*"Stop.") cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
86 *) cur_L="${LEVEL}"; cur_l="${level}";;
88 l="`printf \"[%-5s]%*s%s%s\" \"${cur_L}\" \"${indent}\" \" \" \"${line}\"`"
89 # There will always be a log file, be it /dev/null
91 if [ ${cur_l} -le ${max_level} ]; then
94 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
95 [ ${CT_PROG_BAR_CPT} -eq 0 ] && bar="/"
96 [ ${CT_PROG_BAR_CPT} -eq 10 ] && bar="-"
97 [ ${CT_PROG_BAR_CPT} -eq 20 ] && bar="\\"
98 [ ${CT_PROG_BAR_CPT} -eq 30 ] && bar="|"
99 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${bar}" >&6
100 CT_PROG_BAR_CPT=$(((CT_PROG_BAR_CPT+1)%40))
108 # Tail message to be logged whatever happens
109 # Usage: CT_DoEnd <level>
113 CT_STOP_DATE=`CT_DoDate +%s%N`
114 CT_STOP_DATE_HUMAN=`CT_DoDate +%Y%m%d.%H%M%S`
115 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
116 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
117 elapsed_min=$((elapsed/(60*1000*1000*1000)))
118 elapsed_sec=`printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000)))`
119 elapsed_csec=`printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000)))`
120 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
123 # Abort the execution with an error message
124 # Usage: CT_Abort <message>
130 # Test a condition, and print a message if satisfied
131 # Usage: CT_Test <message> <tests>
136 test "$@" && CT_DoLog WARN "$m"
140 # Test a condition, and abort with an error message if satisfied
141 # Usage: CT_TestAndAbort <message> <tests>
145 test "$@" && CT_Abort "$m"
149 # Test a condition, and abort with an error message if not satisfied
150 # Usage: CT_TestAndAbort <message> <tests>
154 test "$@" || CT_Abort "$m"
158 # Test the presence of a tool, or abort if not found
159 # Usage: CT_HasOrAbort <tool>
161 CT_TestAndAbort "\"${1}\" not found and needed for successfull toolchain build." -z "`which \"${1}\"`"
165 # Get current date with nanosecond precision
166 # On those system not supporting nanosecond precision, faked with rounding down
167 # to the highest entire second
168 # Usage: CT_DoDate <fmt>
170 date "$1" |sed -r -e 's/%N$/000000000/;'
174 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
175 # Memorise a step being done so that any error is caught
176 # Usage: CT_DoStep <loglevel> <message>
178 local start=`CT_DoDate +%s%N`
179 CT_DoLog "$1" "================================================================="
181 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
182 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
183 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
184 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
188 # End the step just being done
191 local stop=`CT_DoDate +%s%N`
192 local duration=`printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;'`
193 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
194 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
195 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
196 CT_DoLog "${level}" "${message}: done in ${duration}s"
200 # Pushes into a directory, and pops back
202 pushd "$1" >/dev/null 2>&1
208 # Makes a path absolute
209 # Usage: CT_MakeAbsolutePath path
210 CT_MakeAbsolutePath() {
211 # Try to cd in that directory
217 # No such directory, fail back to guessing
227 # Creates a temporary directory
228 # $1: variable to assign to
229 # Usage: CT_MktempDir foo
231 # Some mktemp do not allow more than 6 Xs
232 eval "$1"="`mktemp -q -d \"${CT_BUILD_DIR}/.XXXXXX\"`"
233 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
236 # Echoes the specified string on stdout until the pipe breaks.
239 # Usage: CT_DoYes "" |make oldconfig
244 # Get the file name extension of a component
245 # Usage: CT_GetFileExtension <component_name-component_version>
246 # If found, echoes the extension to stdout
247 # If not found, echoes nothing on stdout.
248 CT_GetFileExtension() {
253 CT_Pushd "${CT_TARBALLS_DIR}"
254 # we need to also check for an empty extension for those very
255 # peculiar components that don't have one (such as sstrip from
257 for ext in .tar.gz .tar.bz2 .tgz .tar ''; do
258 if [ -f "${file}${ext}" ]; then
269 # Download an URL using wget
270 # Usage: CT_DoGetFileWget <URL>
272 # Need to return true because it is legitimate to not find the tarball at
273 # some of the provided URLs (think about snapshots, different layouts for
274 # different gcc versions, etc...)
275 # Some (very old!) FTP server might not support the passive mode, thus
277 # With automated download as we are doing, it can be very dangerous to use
278 # -c to continue the downloads. It's far better to simply overwrite the
280 wget -nc --progress=dot:binary --tries=3 --passive-ftp "$1" || wget -nc --progress=dot:binary --tries=3 "$1" || true
283 # Download an URL using curl
284 # Usage: CT_DoGetFileCurl <URL>
286 # Note: comments about wget method are also valid here
287 # Plus: no good progreess indicator is available with curl,
288 # so output is consigned to oblivion
289 curl --ftp-pasv -O --retry 3 "$1" >/dev/null || curl -O --retry 3 "$1" >/dev/null || true
292 # Wrapper function to call one of curl or wget
293 # Usage: CT_DoGetFile <URL>
295 local _wget=`which wget`
296 local _curl=`which curl`
297 case "${_wget},${_curl}" in
298 ,) CT_DoError "Could find neither wget nor curl";;
299 ,*) CT_DoGetFileCurl "$1" 2>&1 |CT_DoLog ALL;;
300 *) CT_DoGetFileWget "$1" 2>&1 |CT_DoLog ALL;;
304 # Download the file from one of the URLs passed as argument
305 # Usage: CT_GetFile <filename> <url> [<url> ...]
313 # Do we already have it?
314 ext=`CT_GetFileExtension "${file}"`
315 if [ -n "${ext}" ]; then
316 CT_DoLog DEBUG "Already have \"${file}\""
320 CT_Pushd "${CT_TARBALLS_DIR}"
321 # File not yet downloaded, try to get it
323 # We'd rather have a bzip2'ed tarball, then gzipped, and finally plain tar.
324 # Try local copy first, if it exists
325 for ext in .tar.bz2 .tar.gz .tgz .tar; do
326 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" -a \
327 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
328 CT_DoLog EXTRA "Copying \"${file}\" from local copy"
329 cp -v "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" "${file}${ext}" |CT_DoLog ALL
334 CT_DoLog EXTRA "Retrieving \"${file}\""
335 for ext in .tar.bz2 .tar.gz .tgz .tar; do
336 # Try all urls in turn
339 *) CT_DoLog DEBUG "Trying \"${url}/${file}${ext}\""
340 CT_DoGetFile "${url}/${file}${ext}"
343 [ -f "${file}${ext}" ] && return 0 || true
348 CT_Abort "Could not download \"${file}\", and not present in \"${CT_LOCAL_TARBALLS_DIR}\""
351 # Extract a tarball and patch the resulting sources if necessary.
352 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
353 # must be extracted in the glibc directory; uCLibc locales must be extracted
354 # in the extra/locale sub-directory of uClibc.
355 CT_ExtractAndPatch() {
357 local base_file=`echo "${file}" |cut -d - -f 1`
358 local ver_file=`echo "${file}" |cut -d - -f 2-`
359 local official_patch_dir
360 local custom_patch_dir
362 local ext=`CT_GetFileExtension "${file}"`
363 CT_TestAndAbort "\"${file}\" not found in \"${CT_TARBALLS_DIR}\"" -z "${ext}"
364 local full_file="${CT_TARBALLS_DIR}/${file}${ext}"
366 CT_Pushd "${CT_SRC_DIR}"
368 # Add-ons need a little love, really.
371 CT_TestAndAbort "Trying to extract the C-library addon/locales \"${file}\" when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
374 [ -f ".${file}.extracted" ] && return 0
375 touch ".${file}.extracted"
378 CT_TestAndAbort "Trying to extract the C-library addon/locales \"${file}\" when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
379 cd "${CT_LIBC_FILE}/extra/locale"
381 [ -f ".${file}.extracted" ] && return 0
382 touch ".${file}.extracted"
386 # If the directory exists, then consider extraction and patching done
387 if [ -d "${file}" ]; then
388 CT_DoLog DEBUG "Already extracted \"${file}\""
392 CT_DoLog EXTRA "Extracting \"${file}\""
394 .tar.bz2) tar xvjf "${full_file}" |CT_DoLog ALL;;
395 .tar.gz|.tgz) tar xvzf "${full_file}" |CT_DoLog ALL;;
396 .tar) tar xvf "${full_file}" |CT_DoLog ALL;;
397 *) CT_Abort "Don't know how to handle \"${file}\": unknown extension" ;;
400 # Snapshots might not have the version number in the extracted directory
401 # name. This is also the case for some (old) packages, such as libfloat.
402 # Overcome this issue by symlink'ing the directory.
403 if [ ! -d "${file}" -a "${libc_addon}" != "y" ]; then
405 .tar.bz2) base=`tar tjf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
406 .tar.gz|.tgz) base=`tar tzf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
407 .tar) base=`tar tf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
409 CT_TestOrAbort "There was a problem when extracting \"${file}\"" -d "${base}" -o "${base}" != "${file}"
410 ln -s "${base}" "${file}"
413 # Kludge: outside this function, we wouldn't know if we had just extracted
414 # a libc addon, or a plain package. Apply patches now.
415 CT_DoLog EXTRA "Patching \"${file}\""
417 if [ "${libc_addon}" = "y" ]; then
418 # Some addons tarball directly contian the correct addon directory,
419 # while others have the addon directory named ofter the tarball.
420 # Fix that bu always using the short name (eg: linuxthreads, ports, etc...)
421 addon_short_name=`echo "${file}" |sed -r -e 's/^[^-]+-//; s/-[^-]+$//;'`
422 [ -d "${addon_short_name}" ] || ln -s "${file}" "${addon_short_name}"
423 # If libc addon, we're already in the correct place
428 [ "${CUSTOM_PATCH_ONLY}" = "y" ] || official_patch_dir="${CT_TOP_DIR}/patches/${base_file}/${ver_file}"
429 [ "${CT_CUSTOM_PATCH}" = "y" ] && custom_patch_dir="${CT_CUSTOM_PATCH_DIR}/${base_file}/${ver_file}"
430 for patch_dir in "${official_patch_dir}" "${custom_patch_dir}"; do
431 if [ -n "${patch_dir}" -a -d "${patch_dir}" ]; then
432 for p in "${patch_dir}"/*.patch; do
433 if [ -f "${p}" ]; then
434 CT_DoLog DEBUG "Applying patch \"${p}\""
435 patch -g0 -F1 -p1 -f <"${p}" |CT_DoLog ALL
436 CT_TestAndAbort "Failed while applying patch file \"${p}\"" ${PIPESTATUS[0]} -ne 0
445 # Compute the target triplet from what is provided by the user
446 # Usage: CT_DoBuildTargetTriplet
447 # In fact this function takes the environment variables to build the target
448 # triplet. It is needed both by the normal build sequence, as well as the
449 # sample saving sequence.
450 CT_DoBuildTargetTriplet() {
451 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
452 y,) target_endian_eb=eb; target_endian_el=;;
453 ,y) target_endian_eb=; target_endian_el=el;;
456 arm) CT_TARGET="${CT_ARCH}${target_endian_eb}";;
457 mips) CT_TARGET="${CT_ARCH}${target_endian_el}";;
458 x86*) # Much love for this one :-(
459 arch="${CT_ARCH_ARCH}"
460 [ -z "${arch}" ] && arch="${CT_ARCH_TUNE}"
462 x86_64) CT_TARGET=x86_64;;
465 i386|i486|i586|i686) CT_TARGET="${arch}";;
466 winchip*) CT_TARGET=i486;;
467 pentium|pentium-mmx|c3*) CT_TARGET=i586;;
468 nocona|athlon*64|k8|athlon-fx|opteron) CT_TARGET=x86_64;;
469 pentiumpro|pentium*|athlon*) CT_TARGET=i686;;
474 case "${CT_TARGET_VENDOR}" in
475 "") CT_TARGET="${CT_TARGET}-unknown";;
476 *) CT_TARGET="${CT_TARGET}-${CT_TARGET_VENDOR}";;
478 case "${CT_KERNEL}" in
479 linux*) CT_TARGET="${CT_TARGET}-linux";;
482 glibc) CT_TARGET="${CT_TARGET}-gnu";;
483 uClibc) CT_TARGET="${CT_TARGET}-uclibc";;
485 CT_TARGET="`${CT_TOP_DIR}/tools/config.sub ${CT_TARGET}`"
488 # This function does pause the build until the user strikes "Return"
489 # Usage: CT_DoPause [optional_message]
492 local message="${1:-Pausing for your pleasure}"
493 CT_DoLog INFO "${message}"
494 read -p "Press \"Enter\" to continue, or Ctrl-C to stop..." foo >&6
498 # This function saves the state of the toolchain to be able to restart
500 # Usage: CT_DoSaveState <next_step_name>
502 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
503 local state_name="$1"
504 local state_dir="${CT_STATE_DIR}/${state_name}"
506 CT_DoLog DEBUG "Saving state to restart at step \"${state_name}\"..."
507 rm -rf "${state_dir}"
508 mkdir -p "${state_dir}"
510 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
511 y) tar_opt=czf; tar_ext=".tar.gz";;
512 *) tar_opt=cf; tar_ext=".tar";;
515 CT_DoLog DEBUG " Saving environment and aliases"
516 # We must omit shell functions
517 # 'isgrep' is here because I don't seem to
518 # be able to remove the functions names.
521 $0~/^[^ ] ()/ { _p = 0; }
523 $0 == "}" { _p = 1; }
524 ' |egrep -v '^[^ ]+ \(\)' >"${state_dir}/env.sh"
526 CT_DoLog DEBUG " Saving CT_CC_CORE_STATIC_PREFIX_DIR=\"${CT_CC_CORE_STATIC_PREFIX_DIR}\""
527 CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
528 tar ${tar_opt} "${state_dir}/cc_core_static_prefix_dir${tar_ext}" .
531 CT_DoLog DEBUG " Saving CT_CC_CORE_SHARED_PREFIX_DIR=\"${CT_CC_CORE_SHARED_PREFIX_DIR}\""
532 CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
533 tar ${tar_opt} "${state_dir}/cc_core_shared_prefix_dir${tar_ext}" .
536 CT_DoLog DEBUG " Saving CT_PREFIX_DIR=\"${CT_PREFIX_DIR}\""
537 CT_Pushd "${CT_PREFIX_DIR}"
538 tar ${tar_opt} "${state_dir}/prefix_dir${tar_ext}" --exclude '*.log' .
541 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
542 CT_DoLog DEBUG " Saving log file"
544 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
545 y) gzip -3 -c "${CT_LOG_FILE}" >"${state_dir}/log.gz";;
546 *) cat "${CT_LOG_FILE}" >"${state_dir}/log";;
548 exec >>"${CT_LOG_FILE}"
552 # This function restores a previously saved state
553 # Usage: CT_DoLoadState <state_name>
555 local state_name="$1"
556 local state_dir="${CT_STATE_DIR}/${state_name}"
557 local old_RESTART="${CT_RESTART}"
558 local old_STOP="${CT_STOP}"
560 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at \"${CT_RESTART}\"" -d "${state_dir}"
562 # We need to do something special with the log file!
563 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
564 exec >"${state_dir}/tail.log"
566 CT_DoLog INFO "Restoring state at step \"${state_name}\", as requested."
568 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
569 y) tar_opt=xzf; tar_ext=".tar.gz";;
570 *) tar_opt=cf; tar_ext=".tar";;
573 CT_DoLog DEBUG " Removing previous build directories"
574 chmod -R u+rwX "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
575 rm -rf "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
576 mkdir -p "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
578 CT_DoLog DEBUG " Restoring CT_PREFIX_DIR=\"${CT_PREFIX_DIR}\""
579 CT_Pushd "${CT_PREFIX_DIR}"
580 tar ${tar_opt} "${state_dir}/prefix_dir${tar_ext}"
583 CT_DoLog DEBUG " Restoring CT_CC_CORE_SHARED_PREFIX_DIR=\"${CT_CC_CORE_SHARED_PREFIX_DIR}\""
584 CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
585 tar ${tar_opt} "${state_dir}/cc_core_shared_prefix_dir${tar_ext}"
588 CT_DoLog DEBUG " Restoring CT_CC_CORE_STATIC_PREFIX_DIR=\"${CT_CC_CORE_STATIC_PREFIX_DIR}\""
589 CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
590 tar ${tar_opt} "${state_dir}/cc_core_static_prefix_dir${tar_ext}"
593 # Restore the environment, discarding any error message
594 # (for example, read-only bash internals)
595 CT_DoLog DEBUG " Restoring environment"
596 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
598 # Restore the new RESTART and STOP steps
599 CT_RESTART="${old_RESTART}"
600 CT_STOP="${old_STOP}"
601 unset old_stop old_restart
603 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
604 CT_DoLog DEBUG " Restoring log file"
606 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
607 y) zcat "${state_dir}/log.gz" >"${CT_LOG_FILE}";;
608 *) cat "${state_dir}/log" >"${CT_LOG_FILE}";;
610 cat "${state_dir}/tail.log" >>"${CT_LOG_FILE}"
611 exec >>"${CT_LOG_FILE}"
612 rm -f "${state_dir}/tail.log"