README 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195
  1. # SPDX-License-Identifier: GPL-2.0+
  2. # Copyright (c) 2013 The Chromium OS Authors.
  3. (Please read 'How to change from MAKEALL' if you are used to that tool)
  4. Quick-start
  5. ===========
  6. If you just want to quickly set up buildman so you can build something (for
  7. example Raspberry Pi 2):
  8. cd /path/to/u-boot
  9. PATH=$PATH:`pwd`/tools/buildman
  10. buildman --fetch-arch arm
  11. buildman -k rpi_2
  12. ls ../current/rpi_2
  13. # u-boot.bin is the output image
  14. What is this?
  15. =============
  16. This tool handles building U-Boot to check that you have not broken it
  17. with your patch series. It can build each individual commit and report
  18. which boards fail on which commits, and which errors come up. It aims
  19. to make full use of multi-processor machines.
  20. A key feature of buildman is its output summary, which allows warnings,
  21. errors or image size increases in a particular commit or board to be
  22. quickly identified and the offending commit pinpointed. This can be a big
  23. help for anyone working with >10 patches at a time.
  24. Caveats
  25. =======
  26. Buildman can be stopped and restarted, in which case it will continue
  27. where it left off. This should happen cleanly and without side-effects.
  28. If not, it is a bug, for which a patch would be welcome.
  29. Buildman gets so tied up in its work that it can ignore the outside world.
  30. You may need to press Ctrl-C several times to quit it. Also it will print
  31. out various exceptions when stopped. You may have to kill it since the
  32. Ctrl-C handling is somewhat broken.
  33. Theory of Operation
  34. ===================
  35. (please read this section in full twice or you will be perpetually confused)
  36. Buildman is a builder. It is not make, although it runs make. It does not
  37. produce any useful output on the terminal while building, except for
  38. progress information (except with -v, see below). All the output (errors,
  39. warnings and binaries if you ask for them) is stored in output
  40. directories, which you can look at while the build is progressing, or when
  41. it is finished.
  42. Buildman is designed to build entire git branches, i.e. muliple commits. It
  43. can be run repeatedly on the same branch. In this case it will automatically
  44. rebuild commits which have changed (and remove its old results for that
  45. commit). It is possible to build a branch for one board, then later build it
  46. for another board. If you want buildman to re-build a commit it has already
  47. built (e.g. because of a toolchain update), use the -f flag.
  48. Buildman produces a concise summary of which boards succeeded and failed.
  49. It shows which commit introduced which board failure using a simple
  50. red/green colour coding. Full error information can be requested, in which
  51. case it is de-duped and displayed against the commit that introduced the
  52. error. An example workflow is below.
  53. Buildman stores image size information and can report changes in image size
  54. from commit to commit. An example of this is below.
  55. Buildman starts multiple threads, and each thread builds for one board at
  56. a time. A thread starts at the first commit, configures the source for your
  57. board and builds it. Then it checks out the next commit and does an
  58. incremental build. Eventually the thread reaches the last commit and stops.
  59. If errors or warnings are found along the way, the thread will reconfigure
  60. after every commit, and your build will be very slow. This is because a
  61. file that produces just a warning would not normally be rebuilt in an
  62. incremental build.
  63. Buildman works in an entirely separate place from your U-Boot repository.
  64. It creates a separate working directory for each thread, and puts the
  65. output files in the working directory, organised by commit name and board
  66. name, in a two-level hierarchy.
  67. Buildman is invoked in your U-Boot directory, the one with the .git
  68. directory. It clones this repository into a copy for each thread, and the
  69. threads do not affect the state of your git repository. Any checkouts done
  70. by the thread affect only the working directory for that thread.
  71. Buildman automatically selects the correct tool chain for each board. You
  72. must supply suitable tool chains, but buildman takes care of selecting the
  73. right one.
  74. Buildman generally builds a branch (with the -b flag), and in this case
  75. builds the upstream commit as well, for comparison. It cannot build
  76. individual commits at present, unless (maybe) you point it at an empty
  77. branch. Put all your commits in a branch, set the branch's upstream to a
  78. valid value, and all will be well. Otherwise buildman will perform random
  79. actions. Use -n to check what the random actions might be.
  80. If you just want to build the current source tree, leave off the -b flag
  81. and add -e. This will display results and errors as they happen. You can
  82. still look at them later using -se. Note that buildman will assume that the
  83. source has changed, and will build all specified boards in this case.
  84. Buildman is optimised for building many commits at once, for many boards.
  85. On multi-core machines, Buildman is fast because it uses most of the
  86. available CPU power. When it gets to the end, or if you are building just
  87. a few commits or boards, it will be pretty slow. As a tip, if you don't
  88. plan to use your machine for anything else, you can use -T to increase the
  89. number of threads beyond the default.
  90. Selecting which boards to build
  91. ===============================
  92. Buildman lets you build all boards, or a subset. Specify the subset by passing
  93. command-line arguments that list the desired board name, architecture name,
  94. SOC name, or anything else in the boards.cfg file. Multiple arguments are
  95. allowed. Each argument will be interpreted as a regular expression, so
  96. behaviour is a superset of exact or substring matching. Examples are:
  97. * 'tegra20' All boards with a Tegra20 SoC
  98. * 'tegra' All boards with any Tegra Soc (Tegra20, Tegra30, Tegra114...)
  99. * '^tegra[23]0$' All boards with either Tegra20 or Tegra30 SoC
  100. * 'powerpc' All PowerPC boards
  101. While the default is to OR the terms together, you can also make use of
  102. the '&' operator to limit the selection:
  103. * 'freescale & arm sandbox' All Freescale boards with ARM architecture,
  104. plus sandbox
  105. You can also use -x to specifically exclude some boards. For example:
  106. buildman arm -x nvidia,freescale,.*ball$
  107. means to build all arm boards except nvidia, freescale and anything ending
  108. with 'ball'.
  109. For building specific boards you can use the --boards option, which takes a
  110. comma-separated list of board target names and be used multiple times on
  111. the command line:
  112. buildman --boards sandbox,snow --boards
  113. It is convenient to use the -n option to see what will be built based on
  114. the subset given. Use -v as well to get an actual list of boards.
  115. Buildman does not store intermediate object files. It optionally copies
  116. the binary output into a directory when a build is successful (-k). Size
  117. information is always recorded. It needs a fair bit of disk space to work,
  118. typically 250MB per thread.
  119. Setting up
  120. ==========
  121. 1. Get the U-Boot source. You probably already have it, but if not these
  122. steps should get you started with a repo and some commits for testing.
  123. $ cd /path/to/u-boot
  124. $ git clone git://git.denx.de/u-boot.git .
  125. $ git checkout -b my-branch origin/master
  126. $ # Add some commits to the branch, reading for testing
  127. 2. Create ~/.buildman to tell buildman where to find tool chains (see 'The
  128. .buildman file' later for details). As an example:
  129. # Buildman settings file
  130. [toolchain]
  131. root: /
  132. rest: /toolchains/*
  133. eldk: /opt/eldk-4.2
  134. arm: /opt/linaro/gcc-linaro-arm-linux-gnueabihf-4.8-2013.08_linux
  135. aarch64: /opt/linaro/gcc-linaro-aarch64-none-elf-4.8-2013.10_linux
  136. [toolchain-alias]
  137. x86: i386
  138. blackfin: bfin
  139. nds32: nds32le
  140. openrisc: or1k
  141. This selects the available toolchain paths. Add the base directory for
  142. each of your toolchains here. Buildman will search inside these directories
  143. and also in any '/usr' and '/usr/bin' subdirectories.
  144. Make sure the tags (here root: rest: and eldk:) are unique.
  145. The toolchain-alias section indicates that the i386 toolchain should be used
  146. to build x86 commits.
  147. Note that you can also specific exactly toolchain prefixes if you like:
  148. [toolchain-prefix]
  149. arm: /opt/arm-eabi-4.6/bin/arm-eabi-
  150. or even:
  151. [toolchain-prefix]
  152. arm: /opt/arm-eabi-4.6/bin/arm-eabi-gcc
  153. This tells buildman that you want to use this exact toolchain for the arm
  154. architecture. This will override any toolchains found by searching using the
  155. [toolchain] settings.
  156. Since the toolchain prefix is an explicit request, buildman will report an
  157. error if a toolchain is not found with that prefix. The current PATH will be
  158. searched, so it is possible to use:
  159. [toolchain-prefix]
  160. arm: arm-none-eabi-
  161. and buildman will find arm-none-eabi-gcc in /usr/bin if you have it installed.
  162. [toolchain-wrapper]
  163. wrapper: ccache
  164. This tells buildman to use a compiler wrapper in front of CROSS_COMPILE. In
  165. this example, ccache. It doesn't affect the toolchain scan. The wrapper is
  166. added when CROSS_COMPILE environtal variable is set. The name in this
  167. section is ignored. If more than one line is provided, only the last one
  168. is taken.
  169. 3. Make sure you have the require Python pre-requisites
  170. Buildman uses multiprocessing, Queue, shutil, StringIO, ConfigParser and
  171. urllib2. These should normally be available, but if you get an error like
  172. this then you will need to obtain those modules:
  173. ImportError: No module named multiprocessing
  174. 4. Check the available toolchains
  175. Run this check to make sure that you have a toolchain for every architecture.
  176. $ ./tools/buildman/buildman --list-tool-chains
  177. Scanning for tool chains
  178. - scanning prefix '/opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-'
  179. Tool chain test: OK, arch='x86', priority 1
  180. - scanning prefix '/opt/arm-eabi-4.6/bin/arm-eabi-'
  181. Tool chain test: OK, arch='arm', priority 1
  182. - scanning path '/toolchains/gcc-4.9.0-nolibc/i386-linux'
  183. - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/.'
  184. - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin'
  185. - found '/toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc'
  186. - looking in '/toolchains/gcc-4.9.0-nolibc/i386-linux/usr/bin'
  187. Tool chain test: OK, arch='i386', priority 4
  188. - scanning path '/toolchains/gcc-4.9.0-nolibc/aarch64-linux'
  189. - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/.'
  190. - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin'
  191. - found '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc'
  192. - looking in '/toolchains/gcc-4.9.0-nolibc/aarch64-linux/usr/bin'
  193. Tool chain test: OK, arch='aarch64', priority 4
  194. - scanning path '/toolchains/gcc-4.9.0-nolibc/microblaze-linux'
  195. - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/.'
  196. - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin'
  197. - found '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc'
  198. - looking in '/toolchains/gcc-4.9.0-nolibc/microblaze-linux/usr/bin'
  199. Tool chain test: OK, arch='microblaze', priority 4
  200. - scanning path '/toolchains/gcc-4.9.0-nolibc/mips64-linux'
  201. - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/.'
  202. - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin'
  203. - found '/toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc'
  204. - looking in '/toolchains/gcc-4.9.0-nolibc/mips64-linux/usr/bin'
  205. Tool chain test: OK, arch='mips64', priority 4
  206. - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc64-linux'
  207. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/.'
  208. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin'
  209. - found '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc'
  210. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc64-linux/usr/bin'
  211. Tool chain test: OK, arch='sparc64', priority 4
  212. - scanning path '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi'
  213. - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/.'
  214. - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin'
  215. - found '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin/arm-unknown-linux-gnueabi-gcc'
  216. - looking in '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/usr/bin'
  217. Tool chain test: OK, arch='arm', priority 3
  218. Toolchain '/toolchains/gcc-4.9.0-nolibc/arm-unknown-linux-gnueabi/bin/arm-unknown-linux-gnueabi-gcc' at priority 3 will be ignored because another toolchain for arch 'arm' has priority 1
  219. - scanning path '/toolchains/gcc-4.9.0-nolibc/sparc-linux'
  220. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/.'
  221. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin'
  222. - found '/toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc'
  223. - looking in '/toolchains/gcc-4.9.0-nolibc/sparc-linux/usr/bin'
  224. Tool chain test: OK, arch='sparc', priority 4
  225. - scanning path '/toolchains/gcc-4.9.0-nolibc/mips-linux'
  226. - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/.'
  227. - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin'
  228. - found '/toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc'
  229. - looking in '/toolchains/gcc-4.9.0-nolibc/mips-linux/usr/bin'
  230. Tool chain test: OK, arch='mips', priority 4
  231. - scanning path '/toolchains/gcc-4.9.0-nolibc/x86_64-linux'
  232. - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/.'
  233. - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin'
  234. - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc'
  235. - found '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-x86_64-linux-gcc'
  236. - looking in '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/usr/bin'
  237. Tool chain test: OK, arch='x86_64', priority 4
  238. Tool chain test: OK, arch='x86_64', priority 4
  239. Toolchain '/toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-x86_64-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'x86_64' has priority 4
  240. - scanning path '/toolchains/gcc-4.9.0-nolibc/m68k-linux'
  241. - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/.'
  242. - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin'
  243. - found '/toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc'
  244. - looking in '/toolchains/gcc-4.9.0-nolibc/m68k-linux/usr/bin'
  245. Tool chain test: OK, arch='m68k', priority 4
  246. - scanning path '/toolchains/gcc-4.9.0-nolibc/powerpc-linux'
  247. - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/.'
  248. - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin'
  249. - found '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
  250. - looking in '/toolchains/gcc-4.9.0-nolibc/powerpc-linux/usr/bin'
  251. Tool chain test: OK, arch='powerpc', priority 4
  252. - scanning path '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux'
  253. - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/.'
  254. - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin'
  255. - found '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc'
  256. - looking in '/toolchains/gcc-4.6.3-nolibc/bfin-uclinux/usr/bin'
  257. Tool chain test: OK, arch='bfin', priority 6
  258. - scanning path '/toolchains/gcc-4.6.3-nolibc/sparc-linux'
  259. - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/.'
  260. - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin'
  261. - found '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin/sparc-linux-gcc'
  262. - looking in '/toolchains/gcc-4.6.3-nolibc/sparc-linux/usr/bin'
  263. Tool chain test: OK, arch='sparc', priority 4
  264. Toolchain '/toolchains/gcc-4.6.3-nolibc/sparc-linux/bin/sparc-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'sparc' has priority 4
  265. - scanning path '/toolchains/gcc-4.6.3-nolibc/mips-linux'
  266. - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/.'
  267. - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin'
  268. - found '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin/mips-linux-gcc'
  269. - looking in '/toolchains/gcc-4.6.3-nolibc/mips-linux/usr/bin'
  270. Tool chain test: OK, arch='mips', priority 4
  271. Toolchain '/toolchains/gcc-4.6.3-nolibc/mips-linux/bin/mips-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'mips' has priority 4
  272. - scanning path '/toolchains/gcc-4.6.3-nolibc/m68k-linux'
  273. - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/.'
  274. - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin'
  275. - found '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin/m68k-linux-gcc'
  276. - looking in '/toolchains/gcc-4.6.3-nolibc/m68k-linux/usr/bin'
  277. Tool chain test: OK, arch='m68k', priority 4
  278. Toolchain '/toolchains/gcc-4.6.3-nolibc/m68k-linux/bin/m68k-linux-gcc' at priority 4 will be ignored because another toolchain for arch 'm68k' has priority 4
  279. - scanning path '/toolchains/gcc-4.6.3-nolibc/powerpc-linux'
  280. - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/.'
  281. - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin'
  282. - found '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/bin/powerpc-linux-gcc'
  283. - looking in '/toolchains/gcc-4.6.3-nolibc/powerpc-linux/usr/bin'
  284. Tool chain test: OK, arch='powerpc', priority 4
  285. Tool chain test: OK, arch='or32', priority 4
  286. - scanning path '/'
  287. - looking in '/.'
  288. - looking in '/bin'
  289. - looking in '/usr/bin'
  290. - found '/usr/bin/i586-mingw32msvc-gcc'
  291. - found '/usr/bin/c89-gcc'
  292. - found '/usr/bin/x86_64-linux-gnu-gcc'
  293. - found '/usr/bin/gcc'
  294. - found '/usr/bin/c99-gcc'
  295. - found '/usr/bin/arm-linux-gnueabi-gcc'
  296. - found '/usr/bin/aarch64-linux-gnu-gcc'
  297. - found '/usr/bin/winegcc'
  298. - found '/usr/bin/arm-linux-gnueabihf-gcc'
  299. Tool chain test: OK, arch='i586', priority 11
  300. Tool chain test: OK, arch='c89', priority 11
  301. Tool chain test: OK, arch='x86_64', priority 4
  302. Toolchain '/usr/bin/x86_64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'x86_64' has priority 4
  303. Tool chain test: OK, arch='sandbox', priority 11
  304. Tool chain test: OK, arch='c99', priority 11
  305. Tool chain test: OK, arch='arm', priority 4
  306. Toolchain '/usr/bin/arm-linux-gnueabi-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
  307. Tool chain test: OK, arch='aarch64', priority 4
  308. Toolchain '/usr/bin/aarch64-linux-gnu-gcc' at priority 4 will be ignored because another toolchain for arch 'aarch64' has priority 4
  309. Tool chain test: OK, arch='sandbox', priority 11
  310. Toolchain '/usr/bin/winegcc' at priority 11 will be ignored because another toolchain for arch 'sandbox' has priority 11
  311. Tool chain test: OK, arch='arm', priority 4
  312. Toolchain '/usr/bin/arm-linux-gnueabihf-gcc' at priority 4 will be ignored because another toolchain for arch 'arm' has priority 1
  313. List of available toolchains (34):
  314. aarch64 : /toolchains/gcc-4.9.0-nolibc/aarch64-linux/bin/aarch64-linux-gcc
  315. alpha : /toolchains/gcc-4.9.0-nolibc/alpha-linux/bin/alpha-linux-gcc
  316. am33_2.0 : /toolchains/gcc-4.9.0-nolibc/am33_2.0-linux/bin/am33_2.0-linux-gcc
  317. arm : /opt/arm-eabi-4.6/bin/arm-eabi-gcc
  318. bfin : /toolchains/gcc-4.6.3-nolibc/bfin-uclinux/bin/bfin-uclinux-gcc
  319. c89 : /usr/bin/c89-gcc
  320. c99 : /usr/bin/c99-gcc
  321. frv : /toolchains/gcc-4.9.0-nolibc/frv-linux/bin/frv-linux-gcc
  322. h8300 : /toolchains/gcc-4.9.0-nolibc/h8300-elf/bin/h8300-elf-gcc
  323. hppa : /toolchains/gcc-4.9.0-nolibc/hppa-linux/bin/hppa-linux-gcc
  324. hppa64 : /toolchains/gcc-4.9.0-nolibc/hppa64-linux/bin/hppa64-linux-gcc
  325. i386 : /toolchains/gcc-4.9.0-nolibc/i386-linux/bin/i386-linux-gcc
  326. i586 : /usr/bin/i586-mingw32msvc-gcc
  327. ia64 : /toolchains/gcc-4.9.0-nolibc/ia64-linux/bin/ia64-linux-gcc
  328. m32r : /toolchains/gcc-4.9.0-nolibc/m32r-linux/bin/m32r-linux-gcc
  329. m68k : /toolchains/gcc-4.9.0-nolibc/m68k-linux/bin/m68k-linux-gcc
  330. microblaze: /toolchains/gcc-4.9.0-nolibc/microblaze-linux/bin/microblaze-linux-gcc
  331. mips : /toolchains/gcc-4.9.0-nolibc/mips-linux/bin/mips-linux-gcc
  332. mips64 : /toolchains/gcc-4.9.0-nolibc/mips64-linux/bin/mips64-linux-gcc
  333. or32 : /toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc
  334. powerpc : /toolchains/gcc-4.9.0-nolibc/powerpc-linux/bin/powerpc-linux-gcc
  335. powerpc64 : /toolchains/gcc-4.9.0-nolibc/powerpc64-linux/bin/powerpc64-linux-gcc
  336. ppc64le : /toolchains/gcc-4.9.0-nolibc/ppc64le-linux/bin/ppc64le-linux-gcc
  337. s390x : /toolchains/gcc-4.9.0-nolibc/s390x-linux/bin/s390x-linux-gcc
  338. sandbox : /usr/bin/gcc
  339. sh4 : /toolchains/gcc-4.6.3-nolibc/sh4-linux/bin/sh4-linux-gcc
  340. sparc : /toolchains/gcc-4.9.0-nolibc/sparc-linux/bin/sparc-linux-gcc
  341. sparc64 : /toolchains/gcc-4.9.0-nolibc/sparc64-linux/bin/sparc64-linux-gcc
  342. tilegx : /toolchains/gcc-4.6.2-nolibc/tilegx-linux/bin/tilegx-linux-gcc
  343. x86 : /opt/gcc-4.6.3-nolibc/x86_64-linux/bin/x86_64-linux-gcc
  344. x86_64 : /toolchains/gcc-4.9.0-nolibc/x86_64-linux/bin/x86_64-linux-gcc
  345. You can see that everything is covered, even some strange ones that won't
  346. be used (c88 and c99). This is a feature.
  347. 5. Install new toolchains if needed
  348. You can download toolchains and update the [toolchain] section of the
  349. settings file to find them.
  350. To make this easier, buildman can automatically download and install
  351. toolchains from kernel.org. First list the available architectures:
  352. $ ./tools/buildman/buildman --fetch-arch list
  353. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
  354. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
  355. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
  356. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.2.4/
  357. Available architectures: alpha am33_2.0 arm bfin cris crisv32 frv h8300
  358. hppa hppa64 i386 ia64 m32r m68k mips mips64 or32 powerpc powerpc64 s390x sh4
  359. sparc sparc64 tilegx x86_64 xtensa
  360. Then pick one and download it:
  361. $ ./tools/buildman/buildman --fetch-arch or32
  362. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.3/
  363. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.6.2/
  364. Checking: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1/
  365. Downloading: https://www.kernel.org/pub/tools/crosstool/files/bin/x86_64/4.5.1//x86_64-gcc-4.5.1-nolibc_or32-linux.tar.xz
  366. Unpacking to: /home/sjg/.buildman-toolchains
  367. Testing
  368. - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/.'
  369. - looking in '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin'
  370. - found '/home/sjg/.buildman-toolchains/gcc-4.5.1-nolibc/or32-linux/bin/or32-linux-gcc'
  371. Tool chain test: OK
  372. Or download them all from kernel.org and move them to /toolchains directory,
  373. $ ./tools/buildman/buildman --fetch-arch all
  374. $ sudo mkdir -p /toolchains
  375. $ sudo mv ~/.buildman-toolchains/*/* /toolchains/
  376. For those not available from kernel.org, download from the following links.
  377. arc: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases/
  378. download/arc-2016.09-release/arc_gnu_2016.09_prebuilt_uclibc_le_archs_linux_install.tar.gz
  379. blackfin: http://sourceforge.net/projects/adi-toolchain/files/
  380. blackfin-toolchain-elf-gcc-4.5-2014R1_45-RC2.x86_64.tar.bz2
  381. nds32: http://osdk.andestech.com/packages/
  382. nds32le-linux-glibc-v1.tgz
  383. nios2: http://sourcery.mentor.com/public/gnu_toolchain/nios2-linux-gnu/
  384. sourceryg++-2015.11-27-nios2-linux-gnu-i686-pc-linux-gnu.tar.bz2
  385. sh: http://sourcery.mentor.com/public/gnu_toolchain/sh-linux-gnu/
  386. renesas-4.4-200-sh-linux-gnu-i686-pc-linux-gnu.tar.bz2
  387. Note openrisc kernel.org toolchain is out of date. Download the latest one from
  388. http://opencores.org/or1k/OpenRISC_GNU_tool_chain#Prebuilt_versions - eg:
  389. ftp://ocuser:ocuser@openrisc.opencores.org/toolchain/gcc-or1k-elf-4.8.1-x86.tar.bz2.
  390. Buildman should now be set up to use your new toolchain.
  391. At the time of writing, U-Boot has these architectures:
  392. arc, arm, blackfin, m68k, microblaze, mips, nds32, nios2, openrisc
  393. powerpc, sandbox, sh, sparc, x86
  394. Of these, only arc and nds32 are not available at kernel.org..
  395. How to run it
  396. =============
  397. First do a dry run using the -n flag: (replace <branch> with a real, local
  398. branch with a valid upstream)
  399. $ ./tools/buildman/buildman -b <branch> -n
  400. If it can't detect the upstream branch, try checking out the branch, and
  401. doing something like 'git branch --set-upstream-to upstream/master'
  402. or something similar. Buildman will try to guess a suitable upstream branch
  403. if it can't find one (you will see a message like" Guessing upstream as ...).
  404. As an example:
  405. Dry run, so not doing much. But I would do this:
  406. Building 18 commits for 1059 boards (4 threads, 1 job per thread)
  407. Build directory: ../lcd9b
  408. 5bb3505 Merge branch 'master' of git://git.denx.de/u-boot-arm
  409. c18f1b4 tegra: Use const for pinmux_config_pingroup/table()
  410. 2f043ae tegra: Add display support to funcmux
  411. e349900 tegra: fdt: Add pwm binding and node
  412. 424a5f0 tegra: fdt: Add LCD definitions for Tegra
  413. 0636ccf tegra: Add support for PWM
  414. a994fe7 tegra: Add SOC support for display/lcd
  415. fcd7350 tegra: Add LCD driver
  416. 4d46e9d tegra: Add LCD support to Nvidia boards
  417. 991bd48 arm: Add control over cachability of memory regions
  418. 54e8019 lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
  419. d92aff7 lcd: Add support for flushing LCD fb from dcache after update
  420. dbd0677 tegra: Align LCD frame buffer to section boundary
  421. 0cff9b8 tegra: Support control of cache settings for LCD
  422. 9c56900 tegra: fdt: Add LCD definitions for Seaboard
  423. 5cc29db lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
  424. cac5a23 tegra: Enable display/lcd support on Seaboard
  425. 49ff541 wip
  426. Total boards to build for each commit: 1059
  427. This shows that it will build all 1059 boards, using 4 threads (because
  428. we have a 4-core CPU). Each thread will run with -j1, meaning that each
  429. make job will use a single CPU. The list of commits to be built helps you
  430. confirm that things look about right. Notice that buildman has chosen a
  431. 'base' directory for you, immediately above your source tree.
  432. Buildman works entirely inside the base directory, here ../lcd9b,
  433. creating a working directory for each thread, and creating output
  434. directories for each commit and board.
  435. Suggested Workflow
  436. ==================
  437. To run the build for real, take off the -n:
  438. $ ./tools/buildman/buildman -b <branch>
  439. Buildman will set up some working directories, and get started. After a
  440. minute or so it will settle down to a steady pace, with a display like this:
  441. Building 18 commits for 1059 boards (4 threads, 1 job per thread)
  442. 528 36 124 /19062 1:13:30 : SIMPC8313_SP
  443. This means that it is building 19062 board/commit combinations. So far it
  444. has managed to successfully build 528. Another 36 have built with warnings,
  445. and 124 more didn't build at all. Buildman expects to complete the process
  446. in around an hour and a quarter. Use this time to buy a faster computer.
  447. To find out how the build went, ask for a summary with -s. You can do this
  448. either before the build completes (presumably in another terminal) or
  449. afterwards. Let's work through an example of how this is used:
  450. $ ./tools/buildman/buildman -b lcd9b -s
  451. ...
  452. 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
  453. powerpc: + galaxy5200_LOWBOOT
  454. 02: tegra: Use const for pinmux_config_pingroup/table()
  455. 03: tegra: Add display support to funcmux
  456. 04: tegra: fdt: Add pwm binding and node
  457. 05: tegra: fdt: Add LCD definitions for Tegra
  458. 06: tegra: Add support for PWM
  459. 07: tegra: Add SOC support for display/lcd
  460. 08: tegra: Add LCD driver
  461. 09: tegra: Add LCD support to Nvidia boards
  462. 10: arm: Add control over cachability of memory regions
  463. 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
  464. 12: lcd: Add support for flushing LCD fb from dcache after update
  465. arm: + lubbock
  466. 13: tegra: Align LCD frame buffer to section boundary
  467. 14: tegra: Support control of cache settings for LCD
  468. 15: tegra: fdt: Add LCD definitions for Seaboard
  469. 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
  470. 17: tegra: Enable display/lcd support on Seaboard
  471. 18: wip
  472. This shows which commits have succeeded and which have failed. In this case
  473. the build is still in progress so many boards are not built yet (use -u to
  474. see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
  475. never builds correctly. This could be a problem with our toolchain, or it
  476. could be a bug in the upstream. The good news is that we probably don't need
  477. to blame our commits. The bad news is that our commits are not tested on that
  478. board.
  479. Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
  480. is never fixed by a later commit, or you would see lubbock again, in green,
  481. without the +.
  482. To see the actual error:
  483. $ ./tools/buildman/buildman -b <branch> -se lubbock
  484. ...
  485. 12: lcd: Add support for flushing LCD fb from dcache after update
  486. arm: + lubbock
  487. +common/libcommon.o: In function `lcd_sync':
  488. +/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
  489. +arm-none-linux-gnueabi-ld: BFD (Sourcery G++ Lite 2010q1-202) 2.19.51.20090709 assertion fail /scratch/julian/2010q1-release-linux-lite/obj/binutils-src-2010q1-202-arm-none-linux-gnueabi-i686-pc-linux-gnu/bfd/elf32-arm.c:12572
  490. +make: *** [/u-boot/lcd9b/.bm-work/00/build/u-boot] Error 139
  491. 13: tegra: Align LCD frame buffer to section boundary
  492. 14: tegra: Support control of cache settings for LCD
  493. 15: tegra: fdt: Add LCD definitions for Seaboard
  494. 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
  495. -/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
  496. +/u-boot/lcd9b/.bm-work/00/common/lcd.c:125: undefined reference to `flush_dcache_range'
  497. 17: tegra: Enable display/lcd support on Seaboard
  498. 18: wip
  499. So the problem is in lcd.c, due to missing cache operations. This information
  500. should be enough to work out what that commit is doing to break these
  501. boards. (In this case pxa did not have cache operations defined).
  502. If you see error lines marked with '-', that means that the errors were fixed
  503. by that commit. Sometimes commits can be in the wrong order, so that a
  504. breakage is introduced for a few commits and fixed by later commits. This
  505. shows up clearly with buildman. You can then reorder the commits and try
  506. again.
  507. At commit 16, the error moves: you can see that the old error at line 120
  508. is fixed, but there is a new one at line 126. This is probably only because
  509. we added some code and moved the broken line further down the file.
  510. If many boards have the same error, then -e will display the error only
  511. once. This makes the output as concise as possible. To see which boards have
  512. each error, use -l. So it is safe to omit the board name - you will not get
  513. lots of repeated output for every board.
  514. Buildman tries to distinguish warnings from errors, and shows warning lines
  515. separately with a 'w' prefix.
  516. The full build output in this case is available in:
  517. ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
  518. done: Indicates the build was done, and holds the return code from make.
  519. This is 0 for a good build, typically 2 for a failure.
  520. err: Output from stderr, if any. Errors and warnings appear here.
  521. log: Output from stdout. Normally there isn't any since buildman runs
  522. in silent mode. Use -V to force a verbose build (this passes V=1
  523. to 'make')
  524. toolchain: Shows information about the toolchain used for the build.
  525. sizes: Shows image size information.
  526. It is possible to get the build binary output there also. Use the -k option
  527. for this. In that case you will also see some output files, like:
  528. System.map toolchain u-boot u-boot.bin u-boot.map autoconf.mk
  529. (also SPL versions u-boot-spl and u-boot-spl.bin if available)
  530. Checking Image Sizes
  531. ====================
  532. A key requirement for U-Boot is that you keep code/data size to a minimum.
  533. Where a new feature increases this noticeably it should normally be put
  534. behind a CONFIG flag so that boards can leave it disabled and keep the image
  535. size more or less the same with each new release.
  536. To check the impact of your commits on image size, use -S. For example:
  537. $ ./tools/buildman/buildman -b us-x86 -sS
  538. Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
  539. 01: MAKEALL: add support for per architecture toolchains
  540. 02: x86: Add function to get top of usable ram
  541. x86: (for 1/3 boards) text -272.0 rodata +41.0
  542. 03: x86: Add basic cache operations
  543. 04: x86: Permit bootstage and timer data to be used prior to relocation
  544. x86: (for 1/3 boards) data +16.0
  545. 05: x86: Add an __end symbol to signal the end of the U-Boot binary
  546. x86: (for 1/3 boards) text +76.0
  547. 06: x86: Rearrange the output input to remove BSS
  548. x86: (for 1/3 boards) bss -2140.0
  549. 07: x86: Support relocation of FDT on start-up
  550. x86: + coreboot-x86
  551. 08: x86: Add error checking to x86 relocation code
  552. 09: x86: Adjust link device tree include file
  553. 10: x86: Enable CONFIG_OF_CONTROL on coreboot
  554. You can see that image size only changed on x86, which is good because this
  555. series is not supposed to change any other board. From commit 7 onwards the
  556. build fails so we don't get code size numbers. The numbers are fractional
  557. because they are an average of all boards for that architecture. The
  558. intention is to allow you to quickly find image size problems introduced by
  559. your commits.
  560. Note that the 'text' region and 'rodata' are split out. You should add the
  561. two together to get the total read-only size (reported as the first column
  562. in the output from binutil's 'size' utility).
  563. A useful option is --step which lets you skip some commits. For example
  564. --step 2 will show the image sizes for only every 2nd commit (so it will
  565. compare the image sizes of the 1st, 3rd, 5th... commits). You can also use
  566. --step 0 which will compare only the first and last commits. This is useful
  567. for an overview of how your entire series affects code size. It will build
  568. only the upstream commit and your final branch commit.
  569. You can also use -d to see a detailed size breakdown for each board. This
  570. list is sorted in order from largest growth to largest reduction.
  571. It is even possible to go a little further with the -B option (--bloat). This
  572. shows where U-Boot has bloated, breaking the size change down to the function
  573. level. Example output is below:
  574. $ ./tools/buildman/buildman -b us-mem4 -sSdB
  575. ...
  576. 19: Roll crc32 into hash infrastructure
  577. arm: (for 10/10 boards) all -143.4 bss +1.2 data -4.8 rodata -48.2 text -91.6
  578. paz00 : all +23 bss -4 rodata -29 text +56
  579. u-boot: add: 1/0, grow: 3/-2 bytes: 168/-104 (64)
  580. function old new delta
  581. hash_command 80 160 +80
  582. crc32_wd_buf - 56 +56
  583. ext4fs_read_file 540 568 +28
  584. insert_var_value_sub 688 692 +4
  585. run_list_real 1996 1992 -4
  586. do_mem_crc 168 68 -100
  587. trimslice : all -9 bss +16 rodata -29 text +4
  588. u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
  589. function old new delta
  590. hash_command 80 160 +80
  591. crc32_wd_buf - 56 +56
  592. ext4fs_iterate_dir 672 668 -4
  593. ext4fs_read_file 568 548 -20
  594. do_mem_crc 168 68 -100
  595. whistler : all -9 bss +16 rodata -29 text +4
  596. u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
  597. function old new delta
  598. hash_command 80 160 +80
  599. crc32_wd_buf - 56 +56
  600. ext4fs_iterate_dir 672 668 -4
  601. ext4fs_read_file 568 548 -20
  602. do_mem_crc 168 68 -100
  603. seaboard : all -9 bss -28 rodata -29 text +48
  604. u-boot: add: 1/0, grow: 3/-2 bytes: 160/-104 (56)
  605. function old new delta
  606. hash_command 80 160 +80
  607. crc32_wd_buf - 56 +56
  608. ext4fs_read_file 548 568 +20
  609. run_list_real 1996 2000 +4
  610. do_nandboot 760 756 -4
  611. do_mem_crc 168 68 -100
  612. colibri_t20 : all -9 rodata -29 text +20
  613. u-boot: add: 1/0, grow: 2/-3 bytes: 140/-112 (28)
  614. function old new delta
  615. hash_command 80 160 +80
  616. crc32_wd_buf - 56 +56
  617. read_abs_bbt 204 208 +4
  618. do_nandboot 760 756 -4
  619. ext4fs_read_file 576 568 -8
  620. do_mem_crc 168 68 -100
  621. ventana : all -37 bss -12 rodata -29 text +4
  622. u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
  623. function old new delta
  624. hash_command 80 160 +80
  625. crc32_wd_buf - 56 +56
  626. ext4fs_iterate_dir 672 668 -4
  627. ext4fs_read_file 568 548 -20
  628. do_mem_crc 168 68 -100
  629. harmony : all -37 bss -16 rodata -29 text +8
  630. u-boot: add: 1/0, grow: 2/-3 bytes: 140/-124 (16)
  631. function old new delta
  632. hash_command 80 160 +80
  633. crc32_wd_buf - 56 +56
  634. nand_write_oob_syndrome 428 432 +4
  635. ext4fs_iterate_dir 672 668 -4
  636. ext4fs_read_file 568 548 -20
  637. do_mem_crc 168 68 -100
  638. medcom-wide : all -417 bss +28 data -16 rodata -93 text -336
  639. u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
  640. function old new delta
  641. crc32_wd_buf - 56 +56
  642. do_fat_read_at 2872 2904 +32
  643. hash_algo 16 - -16
  644. do_mem_crc 168 68 -100
  645. hash_command 420 160 -260
  646. tec : all -449 bss -4 data -16 rodata -93 text -336
  647. u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
  648. function old new delta
  649. crc32_wd_buf - 56 +56
  650. do_fat_read_at 2872 2904 +32
  651. hash_algo 16 - -16
  652. do_mem_crc 168 68 -100
  653. hash_command 420 160 -260
  654. plutux : all -481 bss +16 data -16 rodata -93 text -388
  655. u-boot: add: 1/-1, grow: 1/-3 bytes: 68/-408 (-340)
  656. function old new delta
  657. crc32_wd_buf - 56 +56
  658. do_load_serial_bin 1688 1700 +12
  659. hash_algo 16 - -16
  660. do_fat_read_at 2904 2872 -32
  661. do_mem_crc 168 68 -100
  662. hash_command 420 160 -260
  663. powerpc: (for 5/5 boards) all +37.4 data -3.2 rodata -41.8 text +82.4
  664. MPC8610HPCD : all +55 rodata -29 text +84
  665. u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
  666. function old new delta
  667. hash_command - 176 +176
  668. do_mem_crc 184 88 -96
  669. MPC8641HPCN : all +55 rodata -29 text +84
  670. u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
  671. function old new delta
  672. hash_command - 176 +176
  673. do_mem_crc 184 88 -96
  674. MPC8641HPCN_36BIT: all +55 rodata -29 text +84
  675. u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
  676. function old new delta
  677. hash_command - 176 +176
  678. do_mem_crc 184 88 -96
  679. sbc8641d : all +55 rodata -29 text +84
  680. u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
  681. function old new delta
  682. hash_command - 176 +176
  683. do_mem_crc 184 88 -96
  684. xpedite517x : all -33 data -16 rodata -93 text +76
  685. u-boot: add: 1/-1, grow: 0/-1 bytes: 176/-112 (64)
  686. function old new delta
  687. hash_command - 176 +176
  688. hash_algo 16 - -16
  689. do_mem_crc 184 88 -96
  690. ...
  691. This shows that commit 19 has reduced codesize for arm slightly and increased
  692. it for powerpc. This increase was offset in by reductions in rodata and
  693. data/bss.
  694. Shown below the summary lines are the sizes for each board. Below each board
  695. are the sizes for each function. This information starts with:
  696. add - number of functions added / removed
  697. grow - number of functions which grew / shrunk
  698. bytes - number of bytes of code added to / removed from all functions,
  699. plus the total byte change in brackets
  700. The change seems to be that hash_command() has increased by more than the
  701. do_mem_crc() function has decreased. The function sizes typically add up to
  702. roughly the text area size, but note that every read-only section except
  703. rodata is included in 'text', so the function total does not exactly
  704. correspond.
  705. It is common when refactoring code for the rodata to decrease as the text size
  706. increases, and vice versa.
  707. The .buildman file
  708. ==================
  709. The .buildman file provides information about the available toolchains and
  710. also allows build flags to be passed to 'make'. It consists of several
  711. sections, with the section name in square brackets. Within each section are
  712. a set of (tag, value) pairs.
  713. '[toolchain]' section
  714. This lists the available toolchains. The tag here doesn't matter, but
  715. make sure it is unique. The value is the path to the toolchain. Buildman
  716. will look in that path for a file ending in 'gcc'. It will then execute
  717. it to check that it is a C compiler, passing only the --version flag to
  718. it. If the return code is 0, buildman assumes that it is a valid C
  719. compiler. It uses the first part of the name as the architecture and
  720. strips off the last part when setting the CROSS_COMPILE environment
  721. variable (parts are delimited with a hyphen).
  722. For example powerpc-linux-gcc will be noted as a toolchain for 'powerpc'
  723. and CROSS_COMPILE will be set to powerpc-linux- when using it.
  724. '[toolchain-alias]' section
  725. This converts toolchain architecture names to U-Boot names. For example,
  726. if an x86 toolchains is called i386-linux-gcc it will not normally be
  727. used for architecture 'x86'. Adding 'x86: i386 x86_64' to this section
  728. will tell buildman that the i386 and x86_64 toolchains can be used for
  729. the x86 architecture.
  730. '[make-flags]' section
  731. U-Boot's build system supports a few flags (such as BUILD_TAG) which
  732. affect the build product. These flags can be specified in the buildman
  733. settings file. They can also be useful when building U-Boot against other
  734. open source software.
  735. [make-flags]
  736. at91-boards=ENABLE_AT91_TEST=1
  737. snapper9260=${at91-boards} BUILD_TAG=442
  738. snapper9g45=${at91-boards} BUILD_TAG=443
  739. This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
  740. and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
  741. variable ${target} is available to access the target name (snapper9260
  742. and snapper9g20 in this case). Variables are resolved recursively. Note
  743. that variables can only contain the characters A-Z, a-z, 0-9, hyphen (-)
  744. and underscore (_).
  745. It is expected that any variables added are dealt with in U-Boot's
  746. config.mk file and documented in the README.
  747. Note that you can pass ad-hoc options to the build using environment
  748. variables, for example:
  749. SOME_OPTION=1234 ./tools/buildman/buildman my_board
  750. Quick Sanity Check
  751. ==================
  752. If you have made changes and want to do a quick sanity check of the
  753. currently checked-out source, run buildman without the -b flag. This will
  754. build the selected boards and display build status as it runs (i.e. -v is
  755. enabled automatically). Use -e to see errors/warnings as well.
  756. Building Ranges
  757. ===============
  758. You can build a range of commits by specifying a range instead of a branch
  759. when using the -b flag. For example:
  760. upstream/master..us-buildman
  761. will build commits in us-buildman that are not in upstream/master.
  762. Building Faster
  763. ===============
  764. By default, buildman executes 'make mrproper' prior to building the first
  765. commit for each board. This causes everything to be built from scratch. If you
  766. trust the build system's incremental build capabilities, you can pass the -I
  767. flag to skip the 'make mproper' invocation, which will reduce the amount of
  768. work 'make' does, and hence speed up the build. This flag will speed up any
  769. buildman invocation, since it reduces the amount of work done on any build.
  770. One possible application of buildman is as part of a continual edit, build,
  771. edit, build, ... cycle; repeatedly applying buildman to the same change or
  772. series of changes while making small incremental modifications to the source
  773. each time. This provides quick feedback regarding the correctness of recent
  774. modifications. In this scenario, buildman's default choice of build directory
  775. causes more build work to be performed than strictly necessary.
  776. By default, each buildman thread uses a single directory for all builds. When a
  777. thread builds multiple boards, the configuration built in this directory will
  778. cycle through various different configurations, one per board built by the
  779. thread. Variations in the configuration will force a rebuild of affected source
  780. files when a thread switches between boards. Ideally, such buildman-induced
  781. rebuilds would not happen, thus allowing the build to operate as efficiently as
  782. the build system and source changes allow. buildman's -P flag may be used to
  783. enable this; -P causes each board to be built in a separate (board-specific)
  784. directory, thus avoiding any buildman-induced configuration changes in any
  785. build directory.
  786. U-Boot's build system embeds information such as a build timestamp into the
  787. final binary. This information varies each time U-Boot is built. This causes
  788. various files to be rebuilt even if no source changes are made, which in turn
  789. requires that the final U-Boot binary be re-linked. This unnecessary work can
  790. be avoided by turning off the timestamp feature. This can be achieved by
  791. setting the SOURCE_DATE_EPOCH environment variable to 0.
  792. Combining all of these options together yields the command-line shown below.
  793. This will provide the quickest possible feedback regarding the current content
  794. of the source tree, thus allowing rapid tested evolution of the code.
  795. SOURCE_DATE_EPOCH=0 ./tools/buildman/buildman -I -P tegra
  796. Checking configuration
  797. ======================
  798. A common requirement when converting CONFIG options to Kconfig is to check
  799. that the effective configuration has not changed due to the conversion.
  800. Buildman supports this with the -K option, used after a build. This shows
  801. differences in effective configuration between one commit and the next.
  802. For example:
  803. $ buildman -b kc4 -sK
  804. ...
  805. 43: Convert CONFIG_SPL_USBETH_SUPPORT to Kconfig
  806. arm:
  807. + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET_SUPPORT=1
  808. + u-boot-spl.cfg: CONFIG_SPL_MMC_SUPPORT=1 CONFIG_SPL_NAND_SUPPORT=1
  809. + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC_SUPPORT=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET_SUPPORT=1
  810. am335x_evm_usbspl :
  811. + u-boot.cfg: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_NET_SUPPORT=1
  812. + u-boot-spl.cfg: CONFIG_SPL_MMC_SUPPORT=1 CONFIG_SPL_NAND_SUPPORT=1
  813. + all: CONFIG_SPL_ENV_SUPPORT=1 CONFIG_SPL_MMC_SUPPORT=1 CONFIG_SPL_NAND_SUPPORT=1 CONFIG_SPL_NET_SUPPORT=1
  814. 44: Convert CONFIG_SPL_USB_HOST_SUPPORT to Kconfig
  815. ...
  816. This shows that commit 44 enabled three new options for the board
  817. am335x_evm_usbspl which were not enabled in commit 43. There is also a
  818. summary for 'arm' showing all the changes detected for that architecture.
  819. In this case there is only one board with changes, so 'arm' output is the
  820. same as 'am335x_evm_usbspl'/
  821. The -K option uses the u-boot.cfg, spl/u-boot-spl.cfg and tpl/u-boot-tpl.cfg
  822. files which are produced by a build. If all you want is to check the
  823. configuration you can in fact avoid doing a full build, using -D. This tells
  824. buildman to configuration U-Boot and create the .cfg files, but not actually
  825. build the source. This is 5-10 times faster than doing a full build.
  826. By default buildman considers the follow two configuration methods
  827. equivalent:
  828. #define CONFIG_SOME_OPTION
  829. CONFIG_SOME_OPTION=y
  830. The former would appear in a header filer and the latter in a defconfig
  831. file. The achieve this, buildman considers 'y' to be '1' in configuration
  832. variables. This avoids lots of useless output when converting a CONFIG
  833. option to Kconfig. To disable this behaviour, use --squash-config-y.
  834. Checking the environment
  835. ========================
  836. When converting CONFIG options which manipulate the default environment,
  837. a common requirement is to check that the default environment has not
  838. changed due to the conversion. Buildman supports this with the -U option,
  839. used after a build. This shows differences in the default environment
  840. between one commit and the next.
  841. For example:
  842. $ buildman -b squash brppt1 -sU
  843. boards.cfg is up to date. Nothing to do.
  844. Summary of 2 commits for 3 boards (3 threads, 3 jobs per thread)
  845. 01: Migrate bootlimit to Kconfig
  846. 02: Squashed commit of the following:
  847. c brppt1_mmc: altbootcmd=mmc dev 1; run mmcboot0; -> mmc dev 1; run mmcboot0
  848. c brppt1_spi: altbootcmd=mmc dev 1; run mmcboot0; -> mmc dev 1; run mmcboot0
  849. + brppt1_nand: altbootcmd=run usbscript
  850. - brppt1_nand: altbootcmd=run usbscript
  851. (no errors to report)
  852. This shows that commit 2 modified the value of 'altbootcmd' for 'brppt1_mmc'
  853. and 'brppt1_spi', removing a trailing semicolon. 'brppt1_nand' gained an a
  854. value for 'altbootcmd', but lost one for ' altbootcmd'.
  855. The -U option uses the u-boot.env files which are produced by a build.
  856. Building with clang
  857. ===================
  858. To build with clang (sandbox only), use the -O option to override the
  859. toolchain. For example:
  860. buildman -O clang-7 --board sandbox
  861. Other options
  862. =============
  863. Buildman has various other command line options. Try --help to see them.
  864. When doing builds, Buildman's return code will reflect the overall result:
  865. 0 (success) No errors or warnings found
  866. 128 Errors found
  867. 129 Warnings found
  868. How to change from MAKEALL
  869. ==========================
  870. Buildman includes most of the features of MAKEALL and is generally faster
  871. and easier to use. In particular it builds entire branches: if a particular
  872. commit introduces an error in a particular board, buildman can easily show
  873. you this, even if a later commit fixes that error.
  874. The reasons to deprecate MAKEALL are:
  875. - We don't want to maintain two build systems
  876. - Buildman is typically faster
  877. - Buildman has a lot more features
  878. But still, many people will be sad to lose MAKEALL. If you are used to
  879. MAKEALL, here are a few pointers.
  880. First you need to set up your tool chains - see the 'Setting up' section
  881. for details. Once you have your required toolchain(s) detected then you are
  882. ready to go.
  883. To build the current source tree, run buildman without a -b flag:
  884. ./tools/buildman/buildman <list of things to build>
  885. This will build the current source tree for the given boards and display
  886. the results and errors.
  887. However buildman usually works on entire branches, and for that you must
  888. specify a board flag:
  889. ./tools/buildman/buildman -b <branch_name> <list of things to build>
  890. followed by (afterwards, or perhaps concurrently in another terminal):
  891. ./tools/buildman/buildman -b <branch_name> -s <list of things to build>
  892. to see the results of the build. Rather than showing you all the output,
  893. buildman just shows a summary, with red indicating that a commit introduced
  894. an error and green indicating that a commit fixed an error. Use the -e
  895. flag to see the full errors and -l to see which boards caused which errors.
  896. If you really want to see build results as they happen, use -v when doing a
  897. build (and -e to see the errors/warnings too).
  898. You don't need to stick around on that branch while buildman is running. It
  899. checks out its own copy of the source code, so you can change branches,
  900. add commits, etc. without affecting the build in progress.
  901. The <list of things to build> can include board names, architectures or the
  902. like. There are no flags to disambiguate since ambiguities are rare. Using
  903. the examples from MAKEALL:
  904. Examples:
  905. - build all Power Architecture boards:
  906. MAKEALL -a powerpc
  907. MAKEALL --arch powerpc
  908. MAKEALL powerpc
  909. ** buildman -b <branch> powerpc
  910. - build all PowerPC boards manufactured by vendor "esd":
  911. MAKEALL -a powerpc -v esd
  912. ** buildman -b <branch> esd
  913. - build all PowerPC boards manufactured either by "keymile" or "siemens":
  914. MAKEALL -a powerpc -v keymile -v siemens
  915. ** buildman -b <branch> keymile siemens
  916. - build all Freescale boards with MPC83xx CPUs, plus all 4xx boards:
  917. MAKEALL -c mpc83xx -v freescale 4xx
  918. ** buildman -b <branch> mpc83xx freescale 4xx
  919. Buildman automatically tries to use all the CPUs in your machine. If you
  920. are building a lot of boards it will use one thread for every CPU core
  921. it detects in your machine. This is like MAKEALL's BUILD_NBUILDS option.
  922. You can use the -T flag to change the number of threads. If you are only
  923. building a few boards, buildman will automatically run make with the -j
  924. flag to increase the number of concurrent make tasks. It isn't normally
  925. that helpful to fiddle with this option, but if you use the BUILD_NCPUS
  926. option in MAKEALL then -j is the equivalent in buildman.
  927. Buildman puts its output in ../<branch_name> by default but you can change
  928. this with the -o option. Buildman normally does out-of-tree builds: use -i
  929. to disable that if you really want to. But be careful that once you have
  930. used -i you pollute buildman's copies of the source tree, and you will need
  931. to remove the build directory (normally ../<branch_name>) to run buildman
  932. in normal mode (without -i).
  933. Buildman doesn't keep the output result normally, but use the -k option to
  934. do this.
  935. Please read 'Theory of Operation' a few times as it will make a lot of
  936. things clearer.
  937. Some options you might like are:
  938. -B shows which functions are growing/shrinking in which commit - great
  939. for finding code bloat.
  940. -S shows image sizes for each commit (just an overall summary)
  941. -u shows boards that you haven't built yet
  942. --step 0 will build just the upstream commit and the last commit of your
  943. branch. This is often a quick sanity check that your branch doesn't
  944. break anything. But note this does not check bisectability!
  945. TODO
  946. ====
  947. This has mostly be written in my spare time as a response to my difficulties
  948. in testing large series of patches. Apart from tidying up there is quite a
  949. bit of scope for improvement. Things like better error diffs and easier
  950. access to log files. Also it would be nice if buildman could 'hunt' for
  951. problems, perhaps by building a few boards for each arch, or checking
  952. commits for changed files and building only boards which use those files.
  953. Credits
  954. =======
  955. Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
  956. the build speed by building all commits for a board instead of the other
  957. way around.
  958. Simon Glass
  959. sjg@chromium.org
  960. Halloween 2012
  961. Updated 12-12-12
  962. Updated 23-02-13