build.sh 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. #!/bin/bash
  2. # (c) 2014-2016 Freifunk Hochstift <kontakt@hochstift.freifunk.net>
  3. #
  4. # This script builds the firmware by the environment variables given, the
  5. # first two being mandatory:
  6. #
  7. # BASE = Gluon Version (tag or commit, i.e. v2014.4)
  8. # BRANCH = Firmware Branch (stable/testing/experimental)
  9. # VERSION = the version tag (can only be empty if BRANCH=experimental)
  10. #
  11. # optional:
  12. # AUTOUPDATER = force Autoupdater Branch (stable/testing/experimental/off)
  13. # BROKEN = 0 (default) or 1, build the untested hardware model firmwares, too
  14. # BUILD_TS = build timestamp (format: %Y-%m-%d %H:%M:%S)
  15. # DIRCLEAN = 1 perform "make dirclean" before build (BRANCH==stable/testing) or 0 perform "make clean" (BRANCH==experimental)
  16. # FAKETIME_LIB = path to libfaketime.so.1 if it is not in the standard location
  17. # KEY_DIR = specify directory for gluon-opkg-key
  18. # MAKEJOBS = number of compiler processes running in parallel (default: number of CPUs/Cores)
  19. # NO_FAKETIME = 0 (default) or 1, disables the use of Faketime
  20. # PRIORITY = determines the number of day a rollout phase should last at most
  21. # SITE_ID = specific site repository commit-id (leave blank to use HEAD)
  22. # SITE_REPO_FETCH_METHOD = http, everything except "git" will use the HTTP method for fetchting site repo
  23. # TARGETS = a space separated list of target platforms (if unset, all platforms will be build)
  24. # VERBOSE = 0 (default) or 1, call the make commands with 'V=s' to see actual errors better
  25. #
  26. ### includes
  27. . functions.sh
  28. ### static variables
  29. MY_DIR=$(dirname $0)
  30. MY_DIR=$(readlink -f "${MY_DIR}")
  31. DEFAULT_KEY_DIR="${MY_DIR}/opkg-keys"
  32. CODE_DIR="${MY_DIR}/src"
  33. GLUON_BUILD_DIR="${CODE_DIR}/build"
  34. SITE_DIR="${CODE_DIR}/site"
  35. PATCH_DIR="${SITE_DIR}/patches"
  36. OUTPUT_DIR="${MY_DIR}/output"
  37. IMAGE_DIR="${CODE_DIR}/output/images"
  38. MODULE_DIR="${CODE_DIR}/output/modules"
  39. VERSIONS_INFO_DIR="${MY_DIR}/versions"
  40. BUILD_INFO_FILENAME="build-info.txt"
  41. SITE_REPO_URL="git.c3pb.de/freifunk-pb/site-ffho.git"
  42. LANG=C
  43. pushd ${MY_DIR} > /dev/null
  44. ### ERROR handling
  45. [ -n "${BASE}" ] || abort "Please specify BASE environment variable (Gluon, i.e. 'v2014.3' or commit-id)."
  46. [ -n "${BRANCH}" ] || abort "Please specify BRANCH environment variable."
  47. [ "${BRANCH}" == "experimental" -o "${BASE}" != "HEAD" ] || abort "HEAD is not an allowed BASE-identifier for non-experimental builds. Either use a tagged commit or the commit-SHA itself."
  48. [ -n "${VERSION}" -o "${BRANCH}" == "experimental" ] || abort "Please specify VERSION environment variable (not necessary for experimental branch)."
  49. [ "${BRANCH}" == "experimental" -o ! -r "${VERSIONS_INFO_DIR}/${VERSION}" ] || abort "There exists a version file for '${VERSION}' ... you are trying to do something really stupid, aren't you?"
  50. ### set reasonable defaults for unset environment variables
  51. [ -n "${AUTOUPDATER}" ] || AUTOUPDATER=${BRANCH}
  52. if [ -n "${BROKEN}" ]; then
  53. if [ "${BROKEN}" -eq "1" ]; then
  54. export BROKEN
  55. else
  56. unset BROKEN
  57. fi
  58. fi
  59. [ -n "${BUILD_TS}" ] || BUILD_TS=$(date +"%Y-%m-%d %H:%M:%S")
  60. if [ -z "${DIRCLEAN}" ]; then
  61. if [ "${BRANCH}" == "experimental" ]; then
  62. DIRCLEAN=0
  63. else
  64. DIRCLEAN=1
  65. fi
  66. fi
  67. if [ -n "${KEY_DIR}" ]; then
  68. KEY_DIR=$(readlink -f "${KEY_DIR}")
  69. else
  70. KEY_DIR="${DEFAULT_KEY_DIR}"
  71. fi
  72. [ -e "${KEY_DIR}" ] || mkdir -p ${KEY_DIR}
  73. [ "$?" -eq "0" ] || abort "Unable to create output directory: ${KEY_DIR}"
  74. [ -n "${MAKEJOBS}" ] || MAKEJOBS=$(grep -c "^processor" /proc/cpuinfo)
  75. [ -n "${NO_FAKETIME}" ] || NO_FAKETIME=0
  76. [ -n "${PRIORITY}" ] || PRIORITY=0
  77. [ -n "${SITE_REPO_FETCH_METHOD}" ] || SITE_REPO_FETCH_METHOD="http"
  78. [ -n "${VERBOSE}" ] || VERBOSE=0
  79. if [ "${SITE_REPO_FETCH_METHOD}" != "git" ]; then
  80. SITE_REPO_URL="https://${SITE_REPO_URL}"
  81. else
  82. SITE_REPO_URL="git@${SITE_REPO_URL}"
  83. fi
  84. MAKE_PARAM=""
  85. [ "${VERBOSE}" -eq "1" ] && MAKE_PARAM="${MAKE_PARAM} V=s"
  86. ### INIT /src IF NECESSARY
  87. if [ ! -d "${CODE_DIR}" ]; then
  88. info "Code directory does not exist yet - fetching Gluon ..."
  89. git clone https://github.com/freifunk-gluon/gluon.git "${CODE_DIR}"
  90. [ "$?" -eq "0" ] || abort "Failed to fetch Gluon repository."
  91. fi
  92. ### INIT /src/site IF NECESSARY
  93. if [ ! -d "${SITE_DIR}" ]; then
  94. info "Site repository does not exist, fetching it ..."
  95. git clone "${SITE_REPO_URL}" "${SITE_DIR}"
  96. [ "$?" -eq "0" ] || abort "Failed to fetch SITE repository."
  97. fi
  98. pushd ${CODE_DIR} > /dev/null
  99. ### CHECKOUT GLUON
  100. progress "Checking out GLUON '${BASE}' ..."
  101. # check if gluon got modified and bail out if necessary
  102. [ "$(git status --porcelain)" ] && abort "Local changes to peers directory. Cowardly refusing to update gluon repository." >&2
  103. git fetch
  104. git checkout -q ${BASE}
  105. [ "$?" -eq "0" ] || abort "Failed to checkout '${BASE}' gluon base version, mimimi." >&2
  106. git show-ref --verify --quiet refs/remotes/origin/${BASE}
  107. if [ "$?" -eq "0" ]; then
  108. git pull
  109. [ "$?" -eq "0" ] || abort "Failed to get newest '${BASE}' in gluon repository, mimimi."
  110. fi
  111. GLUON_COMMIT=$(git rev-list --max-count=1 HEAD)
  112. ### CHECKOUT SITE REPO
  113. progress "Checking out SITE REPO ..."
  114. pushd ${SITE_DIR} > /dev/null
  115. # TODO: check if site got modified locally and bail out if necessary
  116. if [ -z "${SITE_ID}" ]; then
  117. # no specific site given - get the most current one
  118. git checkout -q ${BRANCH} ; git pull
  119. [ "$?" -eq "0" ] || abort "Failed to get newest '${BRANCH}' in site repository, mimimi."
  120. else
  121. # fetch site repo updates
  122. git fetch || true
  123. # commit given - use this one
  124. git checkout -q ${SITE_ID}
  125. [ "$?" -eq "0" ] || abort "Failed to checkout requested site commit '${SITE_ID}', mimimi."
  126. fi
  127. SITE_COMMIT=$(git rev-list --max-count=1 HEAD)
  128. popd > /dev/null #${SITE_DIR}
  129. ### APPLY PATCHES TO GLUON
  130. progress "Applying Patches ..."
  131. git checkout -B patching "${BASE}"
  132. if [ -d "${PATCH_DIR}" -a "$(echo ${PATCH_DIR}/*.patch)" ]; then
  133. git am ${PATCH_DIR}/*.patch || (
  134. git am --abort
  135. git checkout patched
  136. git branch -D patching
  137. false
  138. )
  139. [ "$?" -eq "0" ] || abort "Failed to apply patches, mimimi."
  140. fi
  141. git branch -M patched
  142. ### DIRCLEAN
  143. if [ -d "./build/" -a "${DIRCLEAN}" -eq "1" ]; then
  144. progress "Cleaning your build environment ..."
  145. make dirclean
  146. fi
  147. ### PREPARE
  148. progress "Preparing the build environment (make update) ..."
  149. make update
  150. [ "$?" -eq "0" ] || abort "Failed to update the build environment, mimimi."
  151. popd > /dev/null #${CODE_DIR}
  152. ### set reasonable defaults for ${TARGETS} and ${BRANCH} if unset
  153. if [ -z "${TARGETS}" ]; then
  154. TARGETS=$(make list-targets | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
  155. info "building all tagets: '${TARGETS}'"
  156. fi
  157. if [ "${BRANCH}" == "experimental" -a -z "${VERSION}" ] ; then
  158. VERSION=$(make default-release)
  159. info "EXPERIMENTAL FIRMWARE: using version tag '${VERSION}'"
  160. fi
  161. # we are now ready to produce the firmware images, so let's "save" our state
  162. build_info_path="${OUTPUT_DIR}/${BRANCH}/${BUILD_INFO_FILENAME}"
  163. progress "Saving build information to: ${build_info_path}"
  164. [ -n "${build_info_path}" -a -f "${build_info_path}" ] && rm -f ${build_info_path}
  165. mkdir -p $(dirname ${build_info_path})
  166. [ "$?" -eq "0" ] || abort "Unable to create output directory: $(dirname ${build_info_path})"
  167. touch $(dirname ${build_info_path})
  168. [ "$?" -eq "0" ] || abort "Cannot create build information file: ${build_info_path}"
  169. echo "VERSION=${VERSION}" >> ${build_info_path}
  170. echo "GLUON=${GLUON_COMMIT} # ${BASE}" >> ${build_info_path}
  171. echo "BRANCH=${BRANCH}" >> ${build_info_path}
  172. echo "SITE=${SITE_COMMIT} # ${VERSION}" >> ${build_info_path}
  173. echo "TARGETS=${TARGETS}" >> ${build_info_path}
  174. echo "TS=${BUILD_TS}" >> ${build_info_path}
  175. ### SETUP FAKETIME (consistent build)
  176. if [ "${NO_FAKETIME}" -eq "0" ]; then
  177. [ -z "${FAKETIME_LIB}" ] && FAKETIME_LIB="/usr/lib/${MACHTYPE}-${OSTYPE}/faketime/libfaketime.so.1"
  178. export LD_PRELOAD="${FAKETIME_LIB}"
  179. export FAKETIME="${BUILD_TS}"
  180. fi
  181. ### restore gluon-opkg-key, if already exists
  182. if [ -e "${KEY_DIR}/gluon-opkg-key" -a -e "${KEY_DIR}/gluon-opkg-key.pub" ]; then
  183. info "gluon-opkg-key already exists, restoring it."
  184. mkdir -p ${GLUON_BUILD_DIR}/
  185. [ "$?" -eq "0" ] || abort "Unable to create directory: ${GLUON_BUILD_DIR}/"
  186. cp -f ${KEY_DIR}/gluon-opkg-key* ${GLUON_BUILD_DIR}/
  187. [ "$?" -eq "0" ] || abort "Unable to copy gluon-opkg-key."
  188. fi
  189. ### BUILD FIRMWARE
  190. progress "Building the firmware - please stand by!"
  191. pushd ${CODE_DIR} > /dev/null
  192. for target in ${TARGETS} ; do
  193. # configure build environment for our current target
  194. export GLUON_TARGET="${target}"
  195. export GLUON_RELEASE="${VERSION}"
  196. [ "${AUTOUPDATER}" != "off" ] && export GLUON_BRANCH="${AUTOUPDATER}"
  197. # prepare build environment for our current target
  198. progress "Preparing build environment for target ${target}."
  199. [ "${DIRCLEAN}" -eq "1" ] || make clean
  200. [ "$?" -eq "0" ] || abort "Unable to clean environment for target-platform ${target}."
  201. make -j ${MAKEJOBS} prepare-target ${MAKE_PARAM}
  202. [ "$?" -eq "0" ] || abort "Unable to build environment for target-platform ${target}."
  203. # need to have a toolchain for the particular target
  204. progress "Building toolchain for target ${target}."
  205. make -j ${MAKEJOBS} toolchain/install ${MAKE_PARAM}
  206. [ "$?" -eq "0" ] || abort "Unable to build toolchain for target-platform ${target}."
  207. # now we can start building the images for the target platform
  208. progress "Building FFHO-flavoured Gluon firmware for target ${target}. You'd better go and fetch some c0ffee!"
  209. make -j ${MAKEJOBS} prepare ${MAKE_PARAM}
  210. [ "$?" -eq "0" ] || abort "Failed to build firmware for target-platform ${target}."
  211. # finally compile the firmware binaries
  212. progress "Compiling binary firmware images."
  213. make -j ${MAKEJOBS} images ${MAKE_PARAM}
  214. [ "$?" -eq "0" ] || abort "Failed to assemble images for target-platform ${target}."
  215. # compile the modules
  216. progress "Compiling modules."
  217. make -j ${MAKEJOBS} modules ${MAKE_PARAM}
  218. [ "$?" -eq "0" ] || abort "Failed to build modules for target-platform ${target}."
  219. done
  220. popd > /dev/null #${CODE_DIR}
  221. # compress all binaries into 7z archive
  222. progress "Assembling images.7z ..."
  223. pushd ${IMAGE_DIR} > /dev/null
  224. [ -e "${OUTPUT_DIR}/${BRANCH}/images.7z" ] && rm "${OUTPUT_DIR}/${BRANCH}/images.7z"
  225. 7z a -mmt=on -xr!*.manifest "${OUTPUT_DIR}/${BRANCH}/images.7z" ./sysupgrade/* ./factory/*
  226. [ "$?" -eq "0" ] || abort "Failed to assemble images (did you install p7zip-full?)."
  227. popd > /dev/null #${IMAGE_DIR}
  228. # compress modules into 7z archive
  229. progress "Assembling modules.7z ..."
  230. pushd ${MODULE_DIR} > /dev/null
  231. [ -e "${OUTPUT_DIR}/${BRANCH}/modules.7z" ] && rm "${OUTPUT_DIR}/${BRANCH}/modules.7z"
  232. 7z a -mmt=on "${OUTPUT_DIR}/${BRANCH}/modules.7z" ./* > /dev/null
  233. [ "$?" -eq "0" ] || abort "Failed to assemble modules."
  234. popd > /dev/null #${MODULE_DIR}
  235. # generate and copy manifests
  236. progress "Generating and copying manifest ..."
  237. pushd ${CODE_DIR} > /dev/null
  238. GLUON_PRIORITY=${PRIORITY} GLUON_BRANCH=${BRANCH} make manifest
  239. [ "$?" -eq "0" ] || abort "Failed to generate the manifest, try running 'make manifest' in '$CODE_DIR' directory manually."
  240. cp "${CODE_DIR}/output/images/sysupgrade/${BRANCH}.manifest" "${OUTPUT_DIR}/${BRANCH}/"
  241. popd > /dev/null #${CODE_DIR}
  242. # Saving a copy of the build info file as reference
  243. progress "Building a greater and brighter firmware finished successfully. Saving build information at: ${VERSIONS_INFO_DIR}/${VERSION}"
  244. cp -p "${build_info_path}" "${VERSIONS_INFO_DIR}/${VERSION}"
  245. # Saving a copy of gluon-opkg-key
  246. [ -e "${KEY_DIR}/gluon-opkg-key" -a -e "${KEY_DIR}/gluon-opkg-key.pub" ] || cp ${GLUON_BUILD_DIR}/gluon-opkg-key* ${KEY_DIR}/
  247. [ "$?" -eq "0" ] || abort "Failed to save gluon-opkg-key, try to execute 'cp ${GLUON_BUILD_DIR}/gluon-opkg-key* ${KEY_DIR}/' manually"
  248. # The end. Finally.
  249. success "We're done, go and enjoy your new firmware (${VERSION}) in ${OUTPUT_DIR}/${BRANCH}!"
  250. popd > /dev/null #${MY_DIR}