Introduce the notion of tols facilities (none so far, sstrip coming right away...).
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
38 # The different log levels:
46 # A function to log what is happening
47 # Different log level are available:
48 # - ERROR: A serious, fatal error occurred
49 # - WARN: A non fatal, non serious error occurred, take your responsbility with the generated build
50 # - INFO: Informational messages
51 # - EXTRA: Extra informational messages
52 # - DEBUG: Debug messages
53 # - ALL: Component's build messages
54 # Usage: CT_DoLog <level> [message]
55 # If message is empty, then stdin will be logged.
57 local max_level LEVEL level cur_l cur_L
59 eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
60 # Set the maximum log level to DEBUG if we have none
61 [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
64 eval level="\${CT_LOG_LEVEL_${LEVEL}}"
70 fi |( IFS="\n" # We want the full lines, even leading spaces
72 indent=$((2*CT_STEP_COUNT))
74 case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
75 y,*"warning:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
76 y,*"WARNING:"*) cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
77 *"error:"*) cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
78 *"make["?*"]:"*"Stop.") cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
79 *) cur_L="${LEVEL}"; cur_l="${level}";;
81 l="`printf \"[%-5s]%*s%s%s\" \"${cur_L}\" \"${indent}\" \" \" \"${line}\"`"
82 # There will always be a log file, be it /dev/null
84 if [ ${cur_l} -le ${max_level} ]; then
87 if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
88 [ ${CT_PROG_BAR_CPT} -eq 0 ] && bar="/"
89 [ ${CT_PROG_BAR_CPT} -eq 10 ] && bar="-"
90 [ ${CT_PROG_BAR_CPT} -eq 20 ] && bar="\\"
91 [ ${CT_PROG_BAR_CPT} -eq 30 ] && bar="|"
92 printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${bar}" >&6
93 CT_PROG_BAR_CPT=$(((CT_PROG_BAR_CPT+1)%40))
101 # Tail message to be logged whatever happens
102 # Usage: CT_DoEnd <level>
106 CT_STOP_DATE=`CT_DoDate +%s%N`
107 CT_STOP_DATE_HUMAN=`CT_DoDate +%Y%m%d.%H%M%S`
108 CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
109 elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
110 elapsed_min=$((elapsed/(60*1000*1000*1000)))
111 elapsed_sec=`printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000)))`
112 elapsed_csec=`printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000)))`
113 CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
116 # Abort the execution with an error message
117 # Usage: CT_Abort <message>
123 # Test a condition, and print a message if satisfied
124 # Usage: CT_Test <message> <tests>
129 test "$@" && CT_DoLog WARN "$m"
133 # Test a condition, and abort with an error message if satisfied
134 # Usage: CT_TestAndAbort <message> <tests>
138 test "$@" && CT_Abort "$m"
142 # Test a condition, and abort with an error message if not satisfied
143 # Usage: CT_TestAndAbort <message> <tests>
147 test "$@" || CT_Abort "$m"
151 # Test the presence of a tool, or abort if not found
152 # Usage: CT_HasOrAbort <tool>
154 CT_TestAndAbort "\"${1}\" not found and needed for successfull toolchain build." -z "`which \"${1}\"`"
158 # Get current date with nanosecond precision
159 # On those system not supporting nanosecond precision, faked with rounding down
160 # to the highest entire second
161 # Usage: CT_DoDate <fmt>
163 date "$1" |sed -r -e 's/%N$/000000000/;'
167 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
168 # Memorise a step being done so that any error is caught
169 # Usage: CT_DoStep <loglevel> <message>
171 local start=`CT_DoDate +%s%N`
172 CT_DoLog "$1" "================================================================="
174 CT_STEP_COUNT=$((CT_STEP_COUNT+1))
175 CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
176 CT_STEP_START[${CT_STEP_COUNT}]="${start}"
177 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
181 # End the step just being done
184 local stop=`CT_DoDate +%s%N`
185 local duration=`printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;'`
186 local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
187 local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
188 CT_STEP_COUNT=$((CT_STEP_COUNT-1))
189 CT_DoLog "${level}" "${message}: done in ${duration}s"
193 # Pushes into a directory, and pops back
195 pushd "$1" >/dev/null 2>&1
201 # Makes a path absolute
202 # Usage: CT_MakeAbsolutePath path
203 CT_MakeAbsolutePath() {
204 # Try to cd in that directory
210 # No such directory, fail back to guessing
220 # Creates a temporary directory
221 # $1: variable to assign to
222 # Usage: CT_MktempDir foo
224 # Some mktemp do not allow more than 6 Xs
225 eval "$1"="`mktemp -q -d \"${CT_BUILD_DIR}/.XXXXXX\"`"
226 CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
229 # Echoes the specified string on stdout until the pipe breaks.
232 # Usage: CT_DoYes "" |make oldconfig
237 # Get the file name extension of a component
238 # Usage: CT_GetFileExtension <component_name-component_version>
239 # If found, echoes the extension to stdout
240 # If not found, echoes nothing on stdout.
241 CT_GetFileExtension() {
246 CT_Pushd "${CT_TARBALLS_DIR}"
247 for ext in .tar.gz .tar.bz2 .tgz .tar; do
248 if [ -f "${file}${ext}" ]; then
259 # Download an URL using wget
260 # Usage: CT_DoGetFileWget <URL>
262 # Need to return true because it is legitimate to not find the tarball at
263 # some of the provided URLs (think about snapshots, different layouts for
264 # different gcc versions, etc...)
265 # Some (very old!) FTP server might not support the passive mode, thus
267 # With automated download as we are doing, it can be very dangerous to use
268 # -c to continue the downloads. It's far better to simply overwrite the
270 wget -nc --progress=dot:binary --tries=3 --passive-ftp "$1" || wget -nc --progress=dot:binary --tries=3 "$1" || true
273 # Download an URL using curl
274 # Usage: CT_DoGetFileCurl <URL>
276 # Note: comments about wget method are also valid here
277 # Plus: no good progreess indicator is available with curl,
278 # so output is consigned to oblivion
279 curl --ftp-pasv -O --retry 3 "$1" >/dev/null || curl -O --retry 3 "$1" >/dev/null || true
282 # Wrapper function to call one of curl or wget
283 # Usage: CT_DoGetFile <URL>
285 local _wget=`which wget`
286 local _curl=`which curl`
287 case "${_wget},${_curl}" in
288 ,) CT_DoError "Could find neither wget nor curl";;
289 ,*) CT_DoGetFileCurl "$1" 2>&1 |CT_DoLog ALL;;
290 *) CT_DoGetFileWget "$1" 2>&1 |CT_DoLog ALL;;
294 # Download the file from one of the URLs passed as argument
295 # Usage: CT_GetFile <filename> <url> [<url> ...]
303 # Do we already have it?
304 ext=`CT_GetFileExtension "${file}"`
305 if [ -n "${ext}" ]; then
306 CT_DoLog DEBUG "Already have \"${file}\""
310 CT_Pushd "${CT_TARBALLS_DIR}"
311 # File not yet downloaded, try to get it
313 # We'd rather have a bzip2'ed tarball, then gzipped, and finally plain tar.
314 # Try local copy first, if it exists
315 for ext in .tar.bz2 .tar.gz .tgz .tar; do
316 if [ -r "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" -a \
317 "${CT_FORCE_DOWNLOAD}" != "y" ]; then
318 CT_DoLog EXTRA "Copying \"${file}\" from local copy"
319 cp -v "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" "${file}${ext}" |CT_DoLog ALL
324 CT_DoLog EXTRA "Retrieving \"${file}\""
325 for ext in .tar.bz2 .tar.gz .tgz .tar; do
326 # Try all urls in turn
329 *) CT_DoLog DEBUG "Trying \"${url}/${file}${ext}\""
330 CT_DoGetFile "${url}/${file}${ext}"
333 [ -f "${file}${ext}" ] && return 0 || true
338 CT_Abort "Could not download \"${file}\", and not present in \"${CT_LOCAL_TARBALLS_DIR}\""
341 # Extract a tarball and patch the resulting sources if necessary.
342 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
343 # must be extracted in the glibc directory; uCLibc locales must be extracted
344 # in the extra/locale sub-directory of uClibc.
345 CT_ExtractAndPatch() {
347 local base_file=`echo "${file}" |cut -d - -f 1`
348 local ver_file=`echo "${file}" |cut -d - -f 2-`
349 local official_patch_dir
350 local custom_patch_dir
352 local ext=`CT_GetFileExtension "${file}"`
353 CT_TestAndAbort "\"${file}\" not found in \"${CT_TARBALLS_DIR}\"" -z "${ext}"
354 local full_file="${CT_TARBALLS_DIR}/${file}${ext}"
356 CT_Pushd "${CT_SRC_DIR}"
358 # Add-ons need a little love, really.
361 CT_TestAndAbort "Trying to extract the C-library addon/locales \"${file}\" when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
364 [ -f ".${file}.extracted" ] && return 0
365 touch ".${file}.extracted"
368 CT_TestAndAbort "Trying to extract the C-library addon/locales \"${file}\" when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
369 cd "${CT_LIBC_FILE}/extra/locale"
371 [ -f ".${file}.extracted" ] && return 0
372 touch ".${file}.extracted"
376 # If the directory exists, then consider extraction and patching done
377 if [ -d "${file}" ]; then
378 CT_DoLog DEBUG "Already extracted \"${file}\""
382 CT_DoLog EXTRA "Extracting \"${file}\""
384 .tar.bz2) tar xvjf "${full_file}" |CT_DoLog ALL;;
385 .tar.gz|.tgz) tar xvzf "${full_file}" |CT_DoLog ALL;;
386 .tar) tar xvf "${full_file}" |CT_DoLog ALL;;
387 *) CT_Abort "Don't know how to handle \"${file}\": unknown extension" ;;
390 # Snapshots might not have the version number in the extracted directory
391 # name. This is also the case for some (old) packages, such as libfloat.
392 # Overcome this issue by symlink'ing the directory.
393 if [ ! -d "${file}" -a "${libc_addon}" != "y" ]; then
395 .tar.bz2) base=`tar tjf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
396 .tar.gz|.tgz) base=`tar tzf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
397 .tar) base=`tar tf "${full_file}" |head -n 1 |cut -d / -f 1 || true`;;
399 CT_TestOrAbort "There was a problem when extracting \"${file}\"" -d "${base}" -o "${base}" != "${file}"
400 ln -s "${base}" "${file}"
403 # Kludge: outside this function, we wouldn't know if we had just extracted
404 # a libc addon, or a plain package. Apply patches now.
405 CT_DoLog EXTRA "Patching \"${file}\""
407 if [ "${libc_addon}" = "y" ]; then
408 # Some addons tarball directly contian the correct addon directory,
409 # while others have the addon directory named ofter the tarball.
410 # Fix that bu always using the short name (eg: linuxthreads, ports, etc...)
411 addon_short_name=`echo "${file}" |sed -r -e 's/^[^-]+-//; s/-[^-]+$//;'`
412 [ -d "${addon_short_name}" ] || ln -s "${file}" "${addon_short_name}"
413 # If libc addon, we're already in the correct place
418 [ "${CUSTOM_PATCH_ONLY}" = "y" ] || official_patch_dir="${CT_TOP_DIR}/patches/${base_file}/${ver_file}"
419 [ "${CT_CUSTOM_PATCH}" = "y" ] && custom_patch_dir="${CT_CUSTOM_PATCH_DIR}/${base_file}/${ver_file}"
420 for patch_dir in "${official_patch_dir}" "${custom_patch_dir}"; do
421 if [ -n "${patch_dir}" -a -d "${patch_dir}" ]; then
422 for p in "${patch_dir}"/*.patch; do
423 if [ -f "${p}" ]; then
424 CT_DoLog DEBUG "Applying patch \"${p}\""
425 patch -g0 -F1 -p1 -f <"${p}" |CT_DoLog ALL
426 CT_TestAndAbort "Failed while applying patch file \"${p}\"" ${PIPESTATUS[0]} -ne 0
435 # Compute the target triplet from what is provided by the user
436 # Usage: CT_DoBuildTargetTriplet
437 # In fact this function takes the environment variables to build the target
438 # triplet. It is needed both by the normal build sequence, as well as the
439 # sample saving sequence.
440 CT_DoBuildTargetTriplet() {
441 case "${CT_ARCH_BE},${CT_ARCH_LE}" in
442 y,) target_endian_eb=eb; target_endian_el=;;
443 ,y) target_endian_eb=; target_endian_el=el;;
446 arm) CT_TARGET="${CT_ARCH}${target_endian_eb}";;
447 mips) CT_TARGET="${CT_ARCH}${target_endian_el}";;
448 x86*) # Much love for this one :-(
449 arch="${CT_ARCH_ARCH}"
450 [ -z "${arch}" ] && arch="${CT_ARCH_TUNE}"
452 x86_64) CT_TARGET=x86_64;;
455 i386|i486|i586|i686) CT_TARGET="${arch}";;
456 winchip*) CT_TARGET=i486;;
457 pentium|pentium-mmx|c3*) CT_TARGET=i586;;
458 nocona|athlon*64|k8|athlon-fx|opteron) CT_TARGET=x86_64;;
459 pentiumpro|pentium*|athlon*) CT_TARGET=i686;;
464 case "${CT_TARGET_VENDOR}" in
465 "") CT_TARGET="${CT_TARGET}-unknown";;
466 *) CT_TARGET="${CT_TARGET}-${CT_TARGET_VENDOR}";;
468 case "${CT_KERNEL}" in
469 linux*) CT_TARGET="${CT_TARGET}-linux";;
472 glibc) CT_TARGET="${CT_TARGET}-gnu";;
473 uClibc) CT_TARGET="${CT_TARGET}-uclibc";;
475 CT_TARGET="`${CT_TOP_DIR}/tools/config.sub ${CT_TARGET}`"
478 # This function does pause the build until the user strikes "Return"
479 # Usage: CT_DoPause [optional_message]
482 local message="${1:-Pausing for your pleasure}"
483 CT_DoLog INFO "${message}"
484 read -p "Press \"Enter\" to continue, or Ctrl-C to stop..." foo >&6
488 # This function saves the state of the toolchain to be able to restart
490 # Usage: CT_DoSaveState <next_step_name>
492 [ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
493 local state_name="$1"
494 local state_dir="${CT_STATE_DIR}/${state_name}"
496 CT_DoLog DEBUG "Saving state to restart at step \"${state_name}\"..."
497 rm -rf "${state_dir}"
498 mkdir -p "${state_dir}"
500 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
501 y) tar_opt=czf; tar_ext=".tar.gz";;
502 *) tar_opt=cf; tar_ext=".tar";;
505 CT_DoLog DEBUG " Saving environment and aliases"
506 # We must omit shell functions
507 # 'isgrep' is here because I don't seem to
508 # be able to remove the functions names.
511 $0~/^[^ ] ()/ { _p = 0; }
513 $0 == "}" { _p = 1; }
514 ' |egrep -v '^[^ ]+ \(\)' >"${state_dir}/env.sh"
516 CT_DoLog DEBUG " Saving CT_CC_CORE_STATIC_PREFIX_DIR=\"${CT_CC_CORE_STATIC_PREFIX_DIR}\""
517 CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
518 tar ${tar_opt} "${state_dir}/cc_core_static_prefix_dir${tar_ext}" .
521 CT_DoLog DEBUG " Saving CT_CC_CORE_SHARED_PREFIX_DIR=\"${CT_CC_CORE_SHARED_PREFIX_DIR}\""
522 CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
523 tar ${tar_opt} "${state_dir}/cc_core_shared_prefix_dir${tar_ext}" .
526 CT_DoLog DEBUG " Saving CT_PREFIX_DIR=\"${CT_PREFIX_DIR}\""
527 CT_Pushd "${CT_PREFIX_DIR}"
528 tar ${tar_opt} "${state_dir}/prefix_dir${tar_ext}" --exclude '*.log' .
531 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
532 CT_DoLog DEBUG " Saving log file"
534 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
535 y) gzip -3 -c "${CT_LOG_FILE}" >"${state_dir}/log.gz";;
536 *) cat "${CT_LOG_FILE}" >"${state_dir}/log";;
538 exec >>"${CT_LOG_FILE}"
542 # This function restores a previously saved state
543 # Usage: CT_DoLoadState <state_name>
545 local state_name="$1"
546 local state_dir="${CT_STATE_DIR}/${state_name}"
547 local old_RESTART="${CT_RESTART}"
548 local old_STOP="${CT_STOP}"
550 CT_TestOrAbort "The previous build did not reach the point where it could be restarted at \"${CT_RESTART}\"" -d "${state_dir}"
552 # We need to do something special with the log file!
553 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
554 exec >"${state_dir}/tail.log"
556 CT_DoLog INFO "Restoring state at step \"${state_name}\", as requested."
558 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
559 y) tar_opt=xzf; tar_ext=".tar.gz";;
560 *) tar_opt=cf; tar_ext=".tar";;
563 CT_DoLog DEBUG " Removing previous build directories"
564 chmod -R u+rwX "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
565 rm -rf "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
566 mkdir -p "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
568 CT_DoLog DEBUG " Restoring CT_PREFIX_DIR=\"${CT_PREFIX_DIR}\""
569 CT_Pushd "${CT_PREFIX_DIR}"
570 tar ${tar_opt} "${state_dir}/prefix_dir${tar_ext}"
573 CT_DoLog DEBUG " Restoring CT_CC_CORE_SHARED_PREFIX_DIR=\"${CT_CC_CORE_SHARED_PREFIX_DIR}\""
574 CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
575 tar ${tar_opt} "${state_dir}/cc_core_shared_prefix_dir${tar_ext}"
578 CT_DoLog DEBUG " Restoring CT_CC_CORE_STATIC_PREFIX_DIR=\"${CT_CC_CORE_STATIC_PREFIX_DIR}\""
579 CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
580 tar ${tar_opt} "${state_dir}/cc_core_static_prefix_dir${tar_ext}"
583 # Restore the environment, discarding any error message
584 # (for example, read-only bash internals)
585 CT_DoLog DEBUG " Restoring environment"
586 . "${state_dir}/env.sh" >/dev/null 2>&1 || true
588 # Restore the new RESTART and STOP steps
589 CT_RESTART="${old_RESTART}"
590 CT_STOP="${old_STOP}"
591 unset old_stop old_restart
593 if [ "${CT_LOG_TO_FILE}" = "y" ]; then
594 CT_DoLog DEBUG " Restoring log file"
596 case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
597 y) zcat "${state_dir}/log.gz" >"${CT_LOG_FILE}";;
598 *) cat "${state_dir}/log" >"${CT_LOG_FILE}";;
600 cat "${state_dir}/tail.log" >>"${CT_LOG_FILE}"
601 exec >>"${CT_LOG_FILE}"
602 rm -f "${state_dir}/tail.log"