scripts/functions
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Mon Jul 14 15:22:53 2008 +0000 (2008-07-14)
changeset 658 3e590fb8f1a6
parent 657 6eb39aec2d07
child 668 65e27c3bcf99
permissions -rw-r--r--
Don't print double-faults.

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