bootstrap

   1 #! /bin/sh -
   2 #
   3 # Builder of custom stages (cross compilers, GNU/Linux distributions)
   4 #
   5 # Copyright (c) 2014-2021 Matias Fonzo, <selk@dragora.org>.
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #    http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18
  19 # EXIT STATUS
  20 # 0  = Successful completion
  21 # 1  = Minor common errors (e.g: help usage, support not available)
  22 # 2  = Command execution error
  23 # 3  = Integrity check error for compressed files
  24
  25 PROGRAM="${0##*/}"
  26
  27 # Override locale settings
  28 LC_ALL=C
  29 LANGUAGE=C
  30 export LC_ALL LANGUAGE
  31
  32 # Get physical working directory (absolute path)
  33 CWD="$(CDPATH='' cd -P -- "$(dirname -- "$0")" && pwd -P)" || exit $?
  34
  35 ### Functions
  36
  37 usage()
  38 {
  39     printf '%s' \
  40 "Usage: $PROGRAM [OPTIONS] [FILE]...
  41 Builder of custom stages (cross compilers, GNU/Linux distributions).
  42
  43 Defaults for the options are specified in brackets.
  44
  45 Options:
  46   -a          Target architecture [${arch}]
  47   -j          Parallel jobs for the compiler [${jobs}]
  48   -k          Keep (don't delete) source directory
  49   -o          Output directory [${output}]
  50   -s          Stage number to build [${stage}]
  51   -h          Display this help and exit
  52   -V          Print version information and exit
  53
  54 Some influential environment variables:
  55   TMPDIR      Temporary directory for sources [${TMPDIR}]
  56   BTCC        C compiler command [${BTCC}]
  57   BTCXX       C++ compiler command [${BTCXX}]
  58   BTCFLAGS    C compiler flags [${BTCFLAGS}]
  59   BTCXXFLAGS  C++ compiler flags [${BTCXXFLAGS}]
  60   BTLDFLAGS   Linker flags [${BTLDFLAGS}]
  61   VENDOR      Vendor name to reflect on the target triplet
  62
  63 Available targets from ${CWD}/targets ...
  64
  65 "
  66 for name in "${CWD}/targets"/*
  67 do
  68     sed -e '2q;d' "$name"
  69 done
  70 unset -v name
  71 echo ""
  72 }
  73
  74 version()
  75 {
  76     printf '%s' \
  77 "$PROGRAM 3.28
  78 Copyright (C) 2014-2021 Matias Andres Fonzo.
  79 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
  80 This is free software: you are free to change and redistribute it.
  81 There is NO WARRANTY, to the extent permitted by law.
  82 "
  83 }
  84
  85 warn()
  86 {
  87     printf '%s\n' "$@" 1>&2
  88 }
  89
  90 chkstatus_or_exit()
  91 {
  92     status=$?
  93
  94     if test $status -ne 0
  95     then
  96         echo "Return status = $status" 1>&2
  97         exit "${1-2}";  # If not given, defaults to 2
  98     fi
  99
 100     unset -v status
 101 }
 102
 103 # Function to test and extract compressed files
 104 unpack()
 105 {
 106     for file in "$@"
 107     do
 108         case $file in
 109         *.tar)
 110             tar tf "$file" > /dev/null && \
 111             tar xpf "$file"
 112             chkstatus_or_exit 3
 113             ;;
 114         *.tar.gz | *.tgz | *.tar.Z )
 115             gzip -cd "$file" | tar tf - > /dev/null && \
 116             gzip -cd "$file" | tar xpf -
 117             chkstatus_or_exit 3
 118             ;;
 119         *.tar.bz2 | *.tbz2 | *.tbz )
 120             bzip2 -cd "$file" | tar tf - > /dev/null && \
 121             bzip2 -cd "$file" | tar xpf -
 122             chkstatus_or_exit 3
 123             ;;
 124         *.tar.lz | *.tlz )
 125             lzip -cd "$file" | tar tf - > /dev/null && \
 126             lzip -cd "$file" | tar xpf -
 127             chkstatus_or_exit 3
 128             ;;
 129         *.tar.xz | *.txz )
 130             xz -cd "$file" | tar tf - > /dev/null && \
 131             xz -cd "$file" | tar xpf -
 132             chkstatus_or_exit 3
 133             ;;
 134         *.zip | *.ZIP )
 135             unzip -t "$file" > /dev/null && \
 136             unzip "$file" > /dev/null
 137             chkstatus_or_exit 3
 138             ;;
 139         *.gz)
 140             gzip -t "$file" && \
 141             gzip -cd "$file" > "$(basename -- "$file" .gz)"
 142             chkstatus_or_exit 3
 143             ;;
 144         *.Z)
 145             gzip -t "$file" && \
 146             gzip -cd "$file" > "$(basename -- "$file" .Z)"
 147             chkstatus_or_exit 3
 148             ;;
 149         *.bz2)
 150             bzip2 -t "$file" && \
 151             bzip2 -cd "$file" > "$(basename -- "$file" .bz2)"
 152             chkstatus_or_exit 3
 153             ;;
 154         *.lz)
 155             lzip -t "$file" && \
 156             lzip -cd "$file" > "$(basename -- "$file" .lz)"
 157             chkstatus_or_exit 3
 158             ;;
 159         *.xz)
 160             xz -t "$file" && \
 161             xz -cd "$file" > "$(basename -- "$file" .xz)"
 162             chkstatus_or_exit 3
 163             ;;
 164         *)
 165             warn "${PROGRAM}: cannot unpack ${file}: Unsupported extension"
 166             exit 1
 167         esac
 168     done
 169     unset -v file
 170 }
 171
 172 # Print a warning for good practices.
 173 #
 174 # Recommended practices is to set variables
 175 # in front of `configure' or make(1), see:
 176 #
 177 # http://www.gnu.org/software/make/manual/html_node/Environment.html
 178 # http://gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Defining-Variables.html
 179 # http://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Setting-Output-Variables.html
 180
 181 warn_flags()
 182 {
 183     warn "" \
 184      "WARNING: Environment variable '$1' is set."   \
 185      "This will be unset to avoid possible risks."  \
 186      ""
 187 }
 188
 189 ### Default values
 190
 191 BTCC="${BTCC:=cc}"
 192 BTCXX="${BTCXX:=c++}"
 193 BTCFLAGS="${BTCFLAGS:=-O2}"
 194 BTCXXFLAGS="${BTCXXFLAGS:=-O2}"
 195 BTLDFLAGS="${BTLDFLAGS:=}"
 196 opt_keep=opt_keep.off
 197 stage=0
 198 libSuffix=""
 199 arch="$(uname -m)" || chkstatus_or_exit
 200 jobs=1
 201 worktree="$CWD"
 202 output=${worktree}/OUTPUT.${PROGRAM}
 203 TMPDIR="${TMPDIR:=${output}/sources}"
 204
 205 # Compose vendor name adding "-" as suffix
 206 test -n "$VENDOR" && VENDOR="${VENDOR}-"
 207
 208 ### Parse options
 209
 210 while getopts :ha:j:ko:s:V name
 211 do
 212     case $name in
 213     h)
 214         usage
 215         exit 0
 216         ;;
 217     a)
 218         arch="$OPTARG"
 219         ;;
 220     j)
 221         jobs="$OPTARG"
 222         ;;
 223     k)
 224         opt_keep=opt_keep
 225         ;;
 226     o)
 227         output="$OPTARG"
 228         ;;
 229     s)
 230         stage="$OPTARG"
 231         ;;
 232     V)
 233         version
 234         exit 0
 235         ;;
 236     :)
 237         warn "Option '-${OPTARG}' requires an argument"
 238         usage
 239         exit 1
 240         ;;
 241     \?)
 242         warn "Illegal option -- '-${OPTARG}'"
 243         usage
 244         exit 1
 245         ;;
 246     esac
 247 done
 248 shift $(( OPTIND - 1 ))
 249 unset -f usage
 250
 251 # Check for environment variables, print warning, unset in any case
 252
 253 test -n "$CC" && warn_flags CC
 254 test -n "$CXX" && warn_flags CXX
 255 test -n "$CFLAGS" && warn_flags CFLAGS
 256 test -n "$CXXFLAGS" && warn_flags CXXFLAGS
 257 test -n "$LDFLAGS" && warn_flags LDFLAGS
 258 unset CC CXX CFLAGS CXXFLAGS LDFLAGS warn_flags
 259
 260 # Load target architecture-file
 261
 262 if test -f "${worktree}/targets/$arch"
 263 then
 264     echo "${PROGRAM}: Loading target $arch ..."
 265     . "${worktree}/targets/$arch"
 266 else
 267     warn \
 268      "${PROGRAM}: Target name not recognized -- '${arch}'" \
 269      "See '$0 -h' for more information"
 270     exit 1
 271 fi
 272
 273 # Determine the host to use.
 274 #
 275 # Set up the host if a C compiler command was exported,
 276 # otherwise, a local `cc' will be used instead
 277
 278 if test -n "$BTCC"
 279 then
 280     host="$(${BTCC} -dumpmachine)" || chkstatus_or_exit
 281 else
 282     host="$(cc -dumpmachine)" || chkstatus_or_exit
 283 fi
 284
 285 # If the host and the target are the same triplet, it won't work.
 286 # We are changing the host if it is really needed
 287
 288 if test "$host" = "$target"
 289 then
 290     # Rename VENDOR to 'cross'.  If empty, 'cross-linux' is added
 291     case "${host%-*-*}" in
 292     *-*)
 293         host="$(echo "$host" | sed -e 's/-[^-]*/-cross/')"
 294         ;;
 295     *)
 296         host="$(echo "$host" | sed -e 's/-[^-]*/-cross-linux/')"
 297         ;;
 298     esac
 299 fi
 300
 301 # Compose variables for the physical output,
 302 # printing some useful information
 303
 304 crossdir=${output}/cross/${target}
 305 rootdir=${output}/stage${stage}
 306
 307 printf '%s\n' \
 308  "BTCC: $BTCC"                  \
 309  "BTCXX: $BTCXX"                \
 310  "BTCFLAGS: $BTCFLAGS"          \
 311  "BTCXXFLAGS: $BTCXXFLAGS"      \
 312  "BTLDFLAGS: $BTLDFLAGS"        \
 313  "Host: $host"                  \
 314  "Target: $target"              \
 315  "Output directory: $output"    \
 316  "Cross  directory: $crossdir"  \
 317  "Root   directory: $rootdir"
 318
 319 # Remove write permission for group and other
 320 umask 022
 321
 322 # Create required directories
 323 mkdir -p -- "$output" "$TMPDIR"
 324 chkstatus_or_exit
 325
 326 # Set default PATH, propagate variables
 327 PATH="${crossdir}/bin:${PATH}"
 328
 329 export PATH VENDOR TMPDIR
 330
 331 # Main loop
 332 for file in ${CWD}/stages/${stage}/${@:-??-*}
 333 do
 334     file="${file##*/}"
 335
 336     if test ! -f "${CWD}/stages/${stage}/$file"
 337     then
 338         warn "${PROGRAM}: ${stage}/${file}: No such file or stage number"
 339         exit 1
 340     fi
 341     if test ! -x "${CWD}/stages/${stage}/$file"
 342     then
 343         warn "${PROGRAM}: ${stage}/${file}: File not executable, dodging"
 344         continue;
 345     fi
 346
 347     ### Stage pre-settings
 348
 349     # Create sysroot directory, recreating the symlink for the stage 0
 350
 351     if test "$stage" = 0
 352     then
 353         mkdir -p -- "${crossdir}/$target" || chkstatus_or_exit
 354
 355         if test ! -e "${crossdir}/${target}/usr"
 356         then
 357             ln -sf . "${crossdir}/${target}/usr" || chkstatus_or_exit
 358         fi
 359
 360         # Ensure toolchain sanity for multilib purposes
 361         case $arch in
 362         aarch64* | arm* | i586 | *x32 | x86_64 | riscv* )
 363             if test ! -e "${crossdir}/lib" && test -n "$libSuffix"
 364             then
 365                 ln -sf lib${libSuffix} "${crossdir}/lib" || chkstatus_or_exit
 366             fi
 367             ;;
 368         esac
 369     fi
 370
 371     # Create "tools" directory, recreating the symlink for the stage 1
 372     if test "$stage" = 1
 373     then
 374         if test ! -d "${rootdir}/tools"
 375         then
 376             mkdir -p -- "${rootdir}/tools" || chkstatus_or_exit
 377         fi
 378
 379         # Make required symlink
 380         ln -sf "${rootdir}/tools" / || chkstatus_or_exit
 381     fi
 382
 383     echo "${PROGRAM}: Processing $file from stage $stage ..."
 384
 385     # Set trap before to run the script in order to
 386     # catch the return status, exit code 2 if fails
 387
 388     trap 'chkstatus_or_exit 2' EXIT HUP INT QUIT ABRT TERM
 389
 390     # Exit immediately on any error
 391     set -e
 392
 393     . "${CWD}/stages/${stage}/$file"
 394
 395     # Deactivate shell option(s)
 396     set +e
 397
 398     # Reset given signals
 399     trap - EXIT HUP INT QUIT ABRT TERM
 400
 401     # Delete declared directories on the cleanup() function
 402     if test "$opt_keep" != opt_keep
 403     then
 404         if type cleanup 1> /dev/null 2> /dev/null
 405         then
 406             cleanup
 407             chkstatus_or_exit 2
 408             unset -f cleanup
 409         fi
 410     fi
 411
 412     # Back to the current working directory
 413     cd -- "$CWD" || chkstatus_or_exit
 414 done
 415