tools/buildman/README

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