scripts/functions
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sun Jul 27 14:25:19 2008 +0000 (2008-07-27)
changeset 738 e8c68d0d1a0c
parent 726 8b628f8dc108
child 754 b13657cd64b3
permissions -rw-r--r--
Re-enable the restart functionality by removing some variables from the saved environment.

/trunk/scripts/functions | 16 10 6 0 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
     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
     4 
     5 # Prepare the fault handler
     6 CT_OnError() {
     7     ret=$?
     8     # Bail out early in subshell, the upper level shell will act accordingly.
     9     [ ${BASH_SUBSHELL} -eq 0 ] || exit $ret
    10     CT_DoLog ERROR "Build failed in step '${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}'"
    11     for((step=(CT_STEP_COUNT-1); step>1; step--)); do
    12         CT_DoLog ERROR "      called in step '${CT_STEP_MESSAGE[${step}]}'"
    13     done
    14     CT_DoLog ERROR "Error happened in '${BASH_SOURCE[1]}' in function '${FUNCNAME[1]}' (line unknown, sorry)"
    15     for((depth=2; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do
    16         CT_DoLog ERROR "      called from '${BASH_SOURCE[${depth}]}' at line # ${BASH_LINENO[${depth}-1]} in function '${FUNCNAME[${depth}]}'"
    17     done
    18     [ "${CT_LOG_TO_FILE}" = "y" ] && CT_DoLog ERROR "Look at '${CT_LOG_FILE}' for more info on this error."
    19     CT_STEP_COUNT=1
    20     CT_DoEnd ERROR
    21     exit $ret
    22 }
    23 
    24 # Install the fault handler
    25 trap CT_OnError ERR
    26 
    27 # Inherit the fault handler in subshells and functions
    28 set -E
    29 
    30 # Make pipes fail on the _first_ failed command
    31 # Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x
    32 set -o pipefail
    33 
    34 # Don't hash commands' locations, and search every time it is requested.
    35 # This is slow, but needed because of the static/shared core gcc which shall
    36 # always match to shared if it exists, and only fallback to static if the
    37 # shared is not found
    38 set +o hashall
    39 
    40 # Log policy:
    41 #  - first of all, save stdout so we can see the live logs: fd #6
    42 exec 6>&1
    43 #  - then point stdout to the log file (temporary for now)
    44 tmp_log_file="${CT_TOP_DIR}/log.$$"
    45 exec >>"${tmp_log_file}"
    46 
    47 # The different log levels:
    48 CT_LOG_LEVEL_ERROR=0
    49 CT_LOG_LEVEL_WARN=1
    50 CT_LOG_LEVEL_INFO=2
    51 CT_LOG_LEVEL_EXTRA=3
    52 CT_LOG_LEVEL_DEBUG=4
    53 CT_LOG_LEVEL_ALL=5
    54 
    55 # A function to log what is happening
    56 # Different log level are available:
    57 #   - ERROR:   A serious, fatal error occurred
    58 #   - WARN:    A non fatal, non serious error occurred, take your responsbility with the generated build
    59 #   - INFO:    Informational messages
    60 #   - EXTRA:   Extra informational messages
    61 #   - DEBUG:   Debug messages
    62 #   - ALL:     Component's build messages
    63 # Usage: CT_DoLog <level> [message]
    64 # If message is empty, then stdin will be logged.
    65 CT_DoLog() {
    66     local max_level LEVEL level cur_l cur_L
    67     local l
    68     eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"
    69     # Set the maximum log level to DEBUG if we have none
    70     [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}
    71 
    72     LEVEL="$1"; shift
    73     eval level="\${CT_LOG_LEVEL_${LEVEL}}"
    74 
    75     if [ $# -eq 0 ]; then
    76         cat -
    77     else
    78         echo "${@}"
    79     fi |( IFS="\n" # We want the full lines, even leading spaces
    80           _prog_bar_cpt=0
    81           _prog_bar[0]='/'
    82           _prog_bar[1]='-'
    83           _prog_bar[2]='\'
    84           _prog_bar[3]='|'
    85           indent=$((2*CT_STEP_COUNT))
    86           while read line; do
    87               case "${CT_LOG_SEE_TOOLS_WARN},${line}" in
    88                 y,*"warning:"*)         cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
    89                 y,*"WARNING:"*)         cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;
    90                 *"error:"*)             cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
    91                 *"make["?*"]:"*"Stop.") cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;
    92                 *)                      cur_L="${LEVEL}"; cur_l="${level}";;
    93               esac
    94               # There will always be a log file (stdout, fd #1), be it /dev/null
    95               printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"
    96               if [ ${cur_l} -le ${max_level} ]; then
    97                   # Only print to console (fd #6) if log level is high enough.
    98                   printf "\r[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6
    99               fi
   100               if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then
   101                   printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6
   102                   _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))
   103               fi
   104           done
   105         )
   106 
   107     return 0
   108 }
   109 
   110 # Execute an action, and log its messages
   111 # Usage: CT_DoExecLog <level> <[VAR=val...] command [parameters...]>
   112 CT_DoExecLog() {
   113     local level="$1"
   114     shift
   115     CT_DoLog DEBUG "==> Executing: '${@}'"
   116     "${@}" 2>&1 |CT_DoLog "${level}"
   117 }
   118 
   119 # Tail message to be logged whatever happens
   120 # Usage: CT_DoEnd <level>
   121 CT_DoEnd()
   122 {
   123     local level="$1"
   124     CT_STOP_DATE=$(CT_DoDate +%s%N)
   125     CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)
   126     if [ "${level}" != "ERROR" ]; then
   127         CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"
   128     fi
   129     elapsed=$((CT_STOP_DATE-CT_STAR_DATE))
   130     elapsed_min=$((elapsed/(60*1000*1000*1000)))
   131     elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))
   132     elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))
   133     CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"
   134 }
   135 
   136 # Abort the execution with an error message
   137 # Usage: CT_Abort <message>
   138 CT_Abort() {
   139     CT_DoLog ERROR "$1"
   140     exit 1
   141 }
   142 
   143 # Test a condition, and print a message if satisfied
   144 # Usage: CT_Test <message> <tests>
   145 CT_Test() {
   146     local ret
   147     local m="$1"
   148     shift
   149     test "$@" && CT_DoLog WARN "$m"
   150     return 0
   151 }
   152 
   153 # Test a condition, and abort with an error message if satisfied
   154 # Usage: CT_TestAndAbort <message> <tests>
   155 CT_TestAndAbort() {
   156     local m="$1"
   157     shift
   158     test "$@" && CT_Abort "$m"
   159     return 0
   160 }
   161 
   162 # Test a condition, and abort with an error message if not satisfied
   163 # Usage: CT_TestAndAbort <message> <tests>
   164 CT_TestOrAbort() {
   165     local m="$1"
   166     shift
   167     test "$@" || CT_Abort "$m"
   168     return 0
   169 }
   170 
   171 # Test the presence of a tool, or abort if not found
   172 # Usage: CT_HasOrAbort <tool>
   173 CT_HasOrAbort() {
   174     CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z ""$(CT_Which "${1}")
   175     return 0
   176 }
   177 
   178 # Search a program: wrap "which" for those system where
   179 # "which" verbosely says there is no match (Mdk are such
   180 # suckers...)
   181 # Usage: CT_Which <filename>
   182 CT_Which() {
   183   which "$1" 2>/dev/null || true
   184 }
   185 
   186 # Get current date with nanosecond precision
   187 # On those system not supporting nanosecond precision, faked with rounding down
   188 # to the highest entire second
   189 # Usage: CT_DoDate <fmt>
   190 CT_DoDate() {
   191     date "$1" |sed -r -e 's/%N$/000000000/;'
   192 }
   193 
   194 CT_STEP_COUNT=1
   195 CT_STEP_MESSAGE[${CT_STEP_COUNT}]="<none>"
   196 # Memorise a step being done so that any error is caught
   197 # Usage: CT_DoStep <loglevel> <message>
   198 CT_DoStep() {
   199     local start=$(CT_DoDate +%s%N)
   200     CT_DoLog "$1" "================================================================="
   201     CT_DoLog "$1" "$2"
   202     CT_STEP_COUNT=$((CT_STEP_COUNT+1))
   203     CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift
   204     CT_STEP_START[${CT_STEP_COUNT}]="${start}"
   205     CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"
   206     return 0
   207 }
   208 
   209 # End the step just being done
   210 # Usage: CT_EndStep
   211 CT_EndStep() {
   212     local stop=$(CT_DoDate +%s%N)
   213     local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')
   214     local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))
   215     local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"
   216     local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"
   217     CT_STEP_COUNT=$((CT_STEP_COUNT-1))
   218     CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"
   219     return 0
   220 }
   221 
   222 # Pushes into a directory, and pops back
   223 CT_Pushd() {
   224     pushd "$1" >/dev/null 2>&1
   225 }
   226 CT_Popd() {
   227     popd >/dev/null 2>&1
   228 }
   229 
   230 # Makes a path absolute
   231 # Usage: CT_MakeAbsolutePath path
   232 CT_MakeAbsolutePath() {
   233     # Try to cd in that directory
   234     if [ -d "$1" ]; then
   235         CT_Pushd "$1"
   236         pwd
   237         CT_Popd
   238     else
   239         # No such directory, fail back to guessing
   240         case "$1" in
   241             /*)  echo "$1";;
   242             *)   echo "$(pwd)/$1";;
   243         esac
   244     fi
   245     
   246     return 0
   247 }
   248 
   249 # Creates a temporary directory
   250 # $1: variable to assign to
   251 # Usage: CT_MktempDir foo
   252 CT_MktempDir() {
   253     # Some mktemp do not allow more than 6 Xs
   254     eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/.XXXXXX")
   255     CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"
   256 }
   257 
   258 # Echoes the specified string on stdout until the pipe breaks.
   259 # Doesn't fail
   260 # $1: string to echo
   261 # Usage: CT_DoYes "" |make oldconfig
   262 CT_DoYes() {
   263     yes "$1" || true
   264 }
   265 
   266 # Get the file name extension of a component
   267 # Usage: CT_GetFileExtension <component_name-component_version> [extension]
   268 # If found, echoes the extension to stdout
   269 # If not found, echoes nothing on stdout.
   270 CT_GetFileExtension() {
   271     local ext
   272     local file="$1"
   273     shift
   274     local first_ext="$1"
   275 
   276     CT_Pushd "${CT_TARBALLS_DIR}"
   277     # we need to also check for an empty extension for those very
   278     # peculiar components that don't have one (such as sstrip from
   279     # buildroot).
   280     for ext in ${first_ext} .tar.gz .tar.bz2 .tgz .tar ''; do
   281         if [ -f "${file}${ext}" ]; then
   282             echo "${ext}"
   283             break
   284         fi
   285     done
   286     CT_Popd
   287 
   288     return 0
   289 }
   290 
   291 # Download an URL using wget
   292 # Usage: CT_DoGetFileWget <URL>
   293 CT_DoGetFileWget() {
   294     # Need to return true because it is legitimate to not find the tarball at
   295     # some of the provided URLs (think about snapshots, different layouts for
   296     # different gcc versions, etc...)
   297     # Some (very old!) FTP server might not support the passive mode, thus
   298     # retry without
   299     # With automated download as we are doing, it can be very dangerous to use
   300     # -c to continue the downloads. It's far better to simply overwrite the
   301     # destination file
   302     # Some company networks have firewalls to connect to the internet, but it's
   303     # not easy to detect them, and wget does not timeout by default  while
   304     # connecting, so force a global ${CT_CONNECT_TIMEOUT}-second timeout.
   305     wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 --passive-ftp "$1"    \
   306     || wget -T ${CT_CONNECT_TIMEOUT} -nc --progress=dot:binary --tries=3 "$1"               \
   307     || true
   308 }
   309 
   310 # Download an URL using curl
   311 # Usage: CT_DoGetFileCurl <URL>
   312 CT_DoGetFileCurl() {
   313     # Note: comments about wget method (above) are also valid here
   314     # Plus: no good progress indicator is available with curl,
   315     #       so output is consigned to oblivion
   316     curl --ftp-pasv -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} >/dev/null    \
   317     || curl -O --retry 3 "$1" --connect-timeout ${CT_CONNECT_TIMEOUT} >/dev/null            \
   318     || true
   319 }
   320 
   321 _wget=$(CT_Which wget)
   322 _curl=$(CT_Which curl)
   323 # Wrapper function to call one of curl or wget
   324 # Usage: CT_DoGetFile <URL>
   325 CT_DoGetFile() {
   326     case "${_wget},${_curl}" in
   327         ,)  CT_DoError "Could find neither wget nor curl";;
   328         ,*) CT_DoGetFileCurl "$1" 2>&1 |CT_DoLog ALL;;
   329         *)  CT_DoGetFileWget "$1" 2>&1 |CT_DoLog ALL;;
   330     esac
   331 }
   332 
   333 # Download the file from one of the URLs passed as argument
   334 # Usage: CT_GetFile <filename> [extension] <url> [url ...]
   335 CT_GetFile() {
   336     local ext
   337     local url
   338     local file="$1"
   339     local first_ext=""
   340     shift
   341     # If next argument starts with a dot, then this is not an URL,
   342     # and we can consider that it is a preferred extension.
   343     case "$1" in
   344         .*) first_ext="$1"
   345             shift
   346             ;;
   347     esac
   348 
   349     # Do we already have it?
   350     ext=$(CT_GetFileExtension "${file}" ${first_ext})
   351     if [ -n "${ext}" ]; then
   352         CT_DoLog DEBUG "Already have '${file}'"
   353         return 0
   354     fi
   355 
   356     CT_Pushd "${CT_TARBALLS_DIR}"
   357     # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,
   358     # or, as a failover, a file without extension.
   359     # Try local copy first, if it exists
   360     for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
   361         CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${file}${ext}'"
   362         if [ -r "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" -a \
   363              "${CT_FORCE_DOWNLOAD}" != "y" ]; then
   364             CT_DoLog EXTRA "Using '${file}' from local storage"
   365             ln -sv "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" "${file}${ext}" |CT_DoLog ALL
   366             return 0
   367         fi
   368     done
   369 
   370     # Not found locally, try from the network
   371     CT_DoLog EXTRA "Retrieving '${file}' from network"
   372 
   373     # Start with LAN mirror
   374     if [ "${CT_USE_LAN_MIRROR}" = "y" ]; then
   375         LAN_URLs=
   376         for pat in ${CT_LAN_MIRROR_PATTERNS}; do
   377             # Please note: we just have the file's basename in a single piece.
   378             # So we have to just try and split it back into name and version... :-(
   379             pat="${pat//\%pkg/${file%-*}}"
   380             pat="${pat//\%ver/${file##*-}}"
   381             LAN_URLs="${LAN_URLs} ${CT_LAN_MIRROR_SCHEME}://${CT_LAN_MIRROR_HOSTNAME}/${pat}"
   382         done
   383         for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
   384             for url in ${LAN_URLs}; do
   385                 CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
   386                 CT_DoGetFile "${url}/${file}${ext}"
   387                 if [ -f "${file}${ext}" ]; then
   388                     if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
   389                         # No need to test if the file already exists because
   390                         # it does NOT. If it did exist, we'd have been stopped
   391                         # above, when looking for local copies.
   392                         CT_DoLog EXTRA "Saving '${file}' to local storage"
   393                         mv "${file}${ext}" "${CT_LOCAL_TARBALLS_DIR}" |CT_DoLog ALL
   394                         ln -sv "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" "${file}${ext}" |CT_DoLog ALL
   395                     fi
   396                     return 0
   397                 fi
   398             done
   399         done
   400     fi
   401 
   402     # OK, available neither localy, nor from the LAN mirror (if any).
   403     for ext in ${first_ext} .tar.bz2 .tar.gz .tgz .tar ''; do
   404         # Try all urls in turn
   405         for url in "$@"; do
   406             CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"
   407             CT_DoGetFile "${url}/${file}${ext}"
   408             if [ -f "${file}${ext}" ]; then
   409                 if [ "${CT_SAVE_TARBALLS}" = "y" ]; then
   410                     # No need to test if the file already exists because
   411                     # it does NOT. If it did exist, we'd have been stopped
   412                     # above, when looking for local copies.
   413                     CT_DoLog EXTRA "Saving '${file}' to local storage"
   414                     mv "${file}${ext}" "${CT_LOCAL_TARBALLS_DIR}" |CT_DoLog ALL
   415                     ln -sv "${CT_LOCAL_TARBALLS_DIR}/${file}${ext}" "${file}${ext}" |CT_DoLog ALL
   416                 fi
   417                 return 0
   418             fi
   419         done
   420     done
   421     CT_Popd
   422 
   423     CT_Abort "Could not download '${file}', and not present in '${CT_LOCAL_TARBALLS_DIR}'"
   424 }
   425 
   426 # Extract a tarball and patch the resulting sources if necessary.
   427 # Some tarballs need to be extracted in specific places. Eg.: glibc addons
   428 # must be extracted in the glibc directory; uCLibc locales must be extracted
   429 # in the extra/locale sub-directory of uClibc.
   430 CT_ExtractAndPatch() {
   431     local file="$1"
   432     local base_file=$(echo "${file}" |cut -d - -f 1)
   433     local ver_file=$(echo "${file}" |cut -d - -f 2-)
   434     local official_patch_dir
   435     local custom_patch_dir
   436     local libc_addon
   437     local ext=$(CT_GetFileExtension "${file}")
   438     CT_TestAndAbort "'${file}' not found in '${CT_TARBALLS_DIR}'" -z "${ext}"
   439     local full_file="${CT_TARBALLS_DIR}/${file}${ext}"
   440 
   441     CT_Pushd "${CT_SRC_DIR}"
   442 
   443     # Add-ons need a little love, really.
   444     case "${file}" in
   445         glibc-[a-z]*-*)
   446             CT_TestAndAbort "Trying to extract the C-library addon/locales '${file}' when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
   447             cd "${CT_LIBC_FILE}"
   448             libc_addon=y
   449             [ -f ".${file}.extracted" ] && return 0
   450             touch ".${file}.extracted"
   451             ;;
   452         uClibc-locale-*)
   453             CT_TestAndAbort "Trying to extract the C-library addon/locales '${file}' when C-library not yet extracted" ! -d "${CT_LIBC_FILE}"
   454             cd "${CT_LIBC_FILE}/extra/locale"
   455             libc_addon=y
   456             [ -f ".${file}.extracted" ] && return 0
   457             touch ".${file}.extracted"
   458             ;;
   459     esac
   460 
   461     # If the directory exists, then consider extraction and patching done
   462     if [ -d "${file}" ]; then
   463         CT_DoLog DEBUG "Already extracted '${file}'"
   464         return 0
   465     fi
   466 
   467     CT_DoLog EXTRA "Extracting '${file}'"
   468     case "${ext}" in
   469         .tar.bz2)     tar xvjf "${full_file}" |CT_DoLog ALL;;
   470         .tar.gz|.tgz) tar xvzf "${full_file}" |CT_DoLog ALL;;
   471         .tar)         tar xvf  "${full_file}" |CT_DoLog ALL;;
   472         *)            CT_Abort "Don't know how to handle '${file}': unknown extension" ;;
   473     esac
   474 
   475     # Snapshots might not have the version number in the extracted directory
   476     # name. This is also the case for some (odd) packages, such as D.U.M.A.
   477     # Overcome this issue by symlink'ing the directory.
   478     if [ ! -d "${file}" -a "${libc_addon}" != "y" ]; then
   479         case "${ext}" in
   480             .tar.bz2)     base=$(tar tjf "${full_file}" |head -n 1 |cut -d / -f 1 || true);;
   481             .tar.gz|.tgz) base=$(tar tzf "${full_file}" |head -n 1 |cut -d / -f 1 || true);;
   482             .tar)         base=$(tar tf  "${full_file}" |head -n 1 |cut -d / -f 1 || true);;
   483         esac
   484         CT_TestOrAbort "There was a problem when extracting '${file}'" -d "${base}" -o "${base}" != "${file}"
   485         ln -s "${base}" "${file}"
   486     fi
   487 
   488     # Kludge: outside this function, we wouldn't know if we had just extracted
   489     # a libc addon, or a plain package. Apply patches now.
   490     CT_DoLog EXTRA "Patching '${file}'"
   491 
   492     if [ "${libc_addon}" = "y" ]; then
   493         # Some addon tarballs directly contain the correct addon directory,
   494         # while others have the addon directory named after the tarball.
   495         # Fix that by always using the short name (eg: linuxthreads, ports, etc...)
   496         addon_short_name=$(echo "${file}" |sed -r -e 's/^[^-]+-//; s/-[^-]+$//;')
   497         [ -d "${addon_short_name}" ] || ln -s "${file}" "${addon_short_name}"
   498         # If libc addon, we're already in the correct place
   499     else
   500         cd "${file}"
   501     fi
   502 
   503     official_patch_dir=
   504     custom_patch_dir=
   505     [ "${CUSTOM_PATCH_ONLY}" = "y" ] || official_patch_dir="${CT_LIB_DIR}/patches/${base_file}/${ver_file}"
   506     [ "${CT_CUSTOM_PATCH}" = "y" ] && custom_patch_dir="${CT_CUSTOM_PATCH_DIR}/${base_file}/${ver_file}"
   507     for patch_dir in "${official_patch_dir}" "${custom_patch_dir}"; do
   508         if [ -n "${patch_dir}" -a -d "${patch_dir}" ]; then
   509             for p in "${patch_dir}"/*.patch; do
   510                 if [ -f "${p}" ]; then
   511                     CT_DoLog DEBUG "Applying patch '${p}'"
   512                     patch -g0 -F1 -p1 -f <"${p}" |CT_DoLog ALL
   513                     CT_TestAndAbort "Failed while applying patch file '${p}'" ${PIPESTATUS[0]} -ne 0
   514                 fi
   515             done
   516         fi
   517     done
   518 
   519     if [ "${CT_OVERIDE_CONFIG_GUESS_SUB}" = "y" ]; then
   520         CT_DoLog ALL "Overiding config.guess and config.sub"
   521         for cfg in config_guess config_sub; do
   522             eval ${cfg}="${CT_LIB_DIR}/tools/${cfg/_/.}"
   523             [ -e "${CT_TOP_DIR}/tools/${cfg/_/.}" ] && eval ${cfg}="${CT_TOP_DIR}/tools/${cfg/_/.}"
   524             find . -type f -name "${cfg/_/.}" -exec cp -v "${!cfg}" {} \; |CT_DoLog ALL
   525         done
   526     fi
   527 
   528     CT_Popd
   529 }
   530 
   531 # Two wrappers to call config.(guess|sub) either from CT_TOP_DIR or CT_LIB_DIR.
   532 # Those from CT_TOP_DIR, if they exist, will be be more recent than those from CT_LIB_DIR.
   533 CT_DoConfigGuess() {
   534     if [ -x "${CT_TOP_DIR}/tools/config.guess" ]; then
   535         "${CT_TOP_DIR}/tools/config.guess"
   536     else
   537         "${CT_LIB_DIR}/tools/config.guess"
   538     fi
   539 }
   540 
   541 CT_DoConfigSub() {
   542     if [ -x "${CT_TOP_DIR}/tools/config.sub" ]; then
   543         "${CT_TOP_DIR}/tools/config.sub" "$@"
   544     else
   545         "${CT_LIB_DIR}/tools/config.sub" "$@"
   546     fi
   547 }
   548 
   549 # Compute the target tuple from what is provided by the user
   550 # Usage: CT_DoBuildTargetTuple
   551 # In fact this function takes the environment variables to build the target
   552 # tuple. It is needed both by the normal build sequence, as well as the
   553 # sample saving sequence.
   554 CT_DoBuildTargetTuple() {
   555     # Set the endianness suffix, and the default endianness gcc option
   556     case "${CT_ARCH_BE},${CT_ARCH_LE}" in
   557         y,) target_endian_eb=eb
   558             target_endian_el=
   559             CT_ARCH_ENDIAN_CFLAG="-mbig-endian"
   560             CT_ARCH_ENDIAN_LDFLAG="-EB"
   561             ;;
   562         ,y) target_endian_eb=
   563             target_endian_el=el
   564             CT_ARCH_ENDIAN_CFLAG="-mlittle-endian"
   565             CT_ARCH_ENDIAN_LDFLAG="-EL"
   566             ;;
   567     esac
   568 
   569     # Set defaults for the system part of the tuple. Can be overriden
   570     # by architecture-specific values.
   571     case "${CT_LIBC}" in
   572         glibc)  CT_TARGET_SYS=gnu;;
   573         uClibc) CT_TARGET_SYS=uclibc;;
   574     esac
   575 
   576     # Transform the ARCH into a kernel-understandable ARCH
   577     CT_KERNEL_ARCH="${CT_ARCH}"
   578 
   579     # Set the default values for ARCH, ABI, CPU, TUNE, FPU and FLOAT
   580     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
   581     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
   582     [ "${CT_ARCH_ARCH}"     ] && { CT_ARCH_ARCH_CFLAG="-march=${CT_ARCH_ARCH}";  CT_ARCH_WITH_ARCH="--with-arch=${CT_ARCH_ARCH}"; }
   583     [ "${CT_ARCH_ABI}"      ] && { CT_ARCH_ABI_CFLAG="-mabi=${CT_ARCH_ABI}";     CT_ARCH_WITH_ABI="--with-abi=${CT_ARCH_ABI}";    }
   584     [ "${CT_ARCH_CPU}"      ] && { CT_ARCH_CPU_CFLAG="-mcpu=${CT_ARCH_CPU}";     CT_ARCH_WITH_CPU="--with-cpu=${CT_ARCH_CPU}";    }
   585     [ "${CT_ARCH_TUNE}"     ] && { CT_ARCH_TUNE_CFLAG="-mtune=${CT_ARCH_TUNE}";  CT_ARCH_WITH_TUNE="--with-tune=${CT_ARCH_TUNE}"; }
   586     [ "${CT_ARCH_FPU}"      ] && { CT_ARCH_FPU_CFLAG="-mfpu=${CT_ARCH_FPU}";     CT_ARCH_WITH_FPU="--with-fpu=${CT_ARCH_FPU}";    }
   587     [ "${CT_ARCH_FLOAT_SW}" ] && { CT_ARCH_FLOAT_CFLAG="-msoft-float";           CT_ARCH_WITH_FLOAT="--with-float=soft";          }
   588 
   589     # Call the architecture specific settings
   590     CT_DoArchValues
   591 
   592     # Finish the target tuple construction
   593     case "${CT_KERNEL}" in
   594         linux*)  CT_TARGET_KERNEL=linux;;
   595     esac
   596     CT_TARGET=$(CT_DoConfigSub "${CT_TARGET_ARCH}-${CT_TARGET_VENDOR:-unknown}-${CT_TARGET_KERNEL}-${CT_TARGET_SYS}")
   597 
   598     # Prepare the target CFLAGS
   599     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_ENDIAN_CFLAG}"
   600     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ARCH_CFLAG}"
   601     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_ABI_CFLAG}"
   602     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_CPU_CFLAG}"
   603     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_TUNE_CFLAG}"
   604     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FPU_CFLAG}"
   605     CT_ARCH_TARGET_CFLAGS="${CT_ARCH_TARGET_CFLAGS} ${CT_ARCH_FLOAT_CFLAG}"
   606 
   607     # Now on for the target LDFLAGS
   608     CT_ARCH_TARGET_LDFLAGS="${CT_ARCH_ENDIAN_LDFLAG}"
   609 }
   610 
   611 # This function does pause the build until the user strikes "Return"
   612 # Usage: CT_DoPause [optional_message]
   613 CT_DoPause() {
   614     local foo
   615     local message="${1:-Pausing for your pleasure}"
   616     CT_DoLog INFO "${message}"
   617     read -p "Press 'Enter' to continue, or Ctrl-C to stop..." foo >&6
   618     return 0
   619 }
   620 
   621 # This function saves the state of the toolchain to be able to restart
   622 # at any one point
   623 # Usage: CT_DoSaveState <next_step_name>
   624 CT_DoSaveState() {
   625 	[ "${CT_DEBUG_CT_SAVE_STEPS}" = "y" ] || return 0
   626     local state_name="$1"
   627     local state_dir="${CT_STATE_DIR}/${state_name}"
   628 
   629     CT_DoLog DEBUG "Saving state to restart at step '${state_name}'..."
   630     rm -rf "${state_dir}"
   631     mkdir -p "${state_dir}"
   632 
   633     case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
   634         y)  tar_opt=z; tar_ext=.gz;;
   635         *)  tar_opt=;  tar_ext=;;
   636     esac
   637 
   638     CT_DoLog DEBUG "  Saving environment and aliases"
   639     # We must omit shell functions, and some specific bash variables
   640     # that break when restoring the environment, later. We could do
   641     # all the processing in the awk script, but a sed is easier...
   642     set |awk '
   643              BEGIN { _p = 1; }
   644              $0~/^[^ ]+ \(\)/ { _p = 0; }
   645              _p == 1
   646              $0 == "}" { _p = 1; }
   647              ' |sed -r -e '/^BASH_(ARGC|ARGV|LINENO|SOURCE|VERSINFO)=/d;
   648                            /^(UID|EUID)=/d;
   649                            /^(FUNCNAME|GROUPS|PPID|SHELLOPTS)=/d;' >"${state_dir}/env.sh"
   650 
   651     CT_DoLog DEBUG "  Saving CT_CC_CORE_STATIC_PREFIX_DIR='${CT_CC_CORE_STATIC_PREFIX_DIR}'"
   652     CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
   653     tar cv${tar_opt}f "${state_dir}/cc_core_static_prefix_dir.tar${tar_ext}" . |CT_DoLog DEBUG
   654     CT_Popd
   655 
   656     CT_DoLog DEBUG "  Saving CT_CC_CORE_SHARED_PREFIX_DIR='${CT_CC_CORE_SHARED_PREFIX_DIR}'"
   657     CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
   658     tar cv${tar_opt}f "${state_dir}/cc_core_shared_prefix_dir.tar${tar_ext}" . |CT_DoLog DEBUG
   659     CT_Popd
   660 
   661     CT_DoLog DEBUG "  Saving CT_PREFIX_DIR='${CT_PREFIX_DIR}'"
   662     CT_Pushd "${CT_PREFIX_DIR}"
   663     tar cv${tar_opt}f "${state_dir}/prefix_dir.tar${tar_ext}" --exclude '*.log' . |CT_DoLog DEBUG
   664     CT_Popd
   665 
   666     if [ "${CT_LOG_TO_FILE}" = "y" ]; then
   667         CT_DoLog DEBUG "  Saving log file"
   668         exec >/dev/null
   669         case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
   670             y)  gzip -3 -c "${CT_LOG_FILE}"  >"${state_dir}/log.gz";;
   671             *)  cat "${CT_LOG_FILE}" >"${state_dir}/log";;
   672         esac
   673         exec >>"${CT_LOG_FILE}"
   674     fi
   675 }
   676 
   677 # This function restores a previously saved state
   678 # Usage: CT_DoLoadState <state_name>
   679 CT_DoLoadState(){
   680     local state_name="$1"
   681     local state_dir="${CT_STATE_DIR}/${state_name}"
   682     local old_RESTART="${CT_RESTART}"
   683     local old_STOP="${CT_STOP}"
   684 
   685     CT_TestOrAbort "The previous build did not reach the point where it could be restarted at '${CT_RESTART}'" -d "${state_dir}"
   686 
   687     # We need to do something special with the log file!
   688     if [ "${CT_LOG_TO_FILE}" = "y" ]; then
   689         exec >"${state_dir}/tail.log"
   690     fi
   691     CT_DoLog INFO "Restoring state at step '${state_name}', as requested."
   692 
   693     case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
   694         y)  tar_opt=z; tar_ext=.gz;;
   695         *)  tar_opt=;  tar_ext=;;
   696     esac
   697 
   698     CT_DoLog DEBUG "  Removing previous build directories"
   699     chmod -R u+rwX "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
   700     rm -rf         "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
   701     mkdir -p       "${CT_PREFIX_DIR}" "${CT_CC_CORE_SHARED_PREFIX_DIR}" "${CT_CC_CORE_STATIC_PREFIX_DIR}"
   702 
   703     CT_DoLog DEBUG "  Restoring CT_PREFIX_DIR='${CT_PREFIX_DIR}'"
   704     CT_Pushd "${CT_PREFIX_DIR}"
   705     tar xv${tar_opt}f "${state_dir}/prefix_dir.tar${tar_ext}" |CT_DoLog DEBUG
   706     CT_Popd
   707 
   708     CT_DoLog DEBUG "  Restoring CT_CC_CORE_SHARED_PREFIX_DIR='${CT_CC_CORE_SHARED_PREFIX_DIR}'"
   709     CT_Pushd "${CT_CC_CORE_SHARED_PREFIX_DIR}"
   710     tar xv${tar_opt}f "${state_dir}/cc_core_shared_prefix_dir.tar${tar_ext}" |CT_DoLog DEBUG
   711     CT_Popd
   712 
   713     CT_DoLog DEBUG "  Restoring CT_CC_CORE_STATIC_PREFIX_DIR='${CT_CC_CORE_STATIC_PREFIX_DIR}'"
   714     CT_Pushd "${CT_CC_CORE_STATIC_PREFIX_DIR}"
   715     tar xv${tar_opt}f "${state_dir}/cc_core_static_prefix_dir.tar${tar_ext}" |CT_DoLog DEBUG
   716     CT_Popd
   717 
   718     # Restore the environment, discarding any error message
   719     # (for example, read-only bash internals)
   720     CT_DoLog DEBUG "  Restoring environment"
   721     . "${state_dir}/env.sh" >/dev/null 2>&1 || true
   722 
   723     # Restore the new RESTART and STOP steps
   724     CT_RESTART="${old_RESTART}"
   725     CT_STOP="${old_STOP}"
   726     unset old_stop old_restart
   727 
   728     if [ "${CT_LOG_TO_FILE}" = "y" ]; then
   729         CT_DoLog DEBUG "  Restoring log file"
   730         exec >/dev/null
   731         case "${CT_DEBUG_CT_SAVE_STEPS_GZIP}" in
   732             y)  zcat "${state_dir}/log.gz" >"${CT_LOG_FILE}";;
   733             *)  cat "${state_dir}/log" >"${CT_LOG_FILE}";;
   734         esac
   735         cat "${state_dir}/tail.log" >>"${CT_LOG_FILE}"
   736         exec >>"${CT_LOG_FILE}"
   737         rm -f "${state_dir}/tail.log"
   738     fi
   739 }