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 are 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 This will display results and errors as they happen. You can still look
  90 at them later using -s. Note that buildman will assume that the source
  91 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 Buildman does not store intermediate object files. It optionally copies
 112 the binary output into a directory when a build is successful. Size
 113 information is always recorded. It needs a fair bit of disk space to work,
 114 typically 250MB per thread.
 115
 116
 117 Setting up
 118 ==========
 119
 120 1. Get the U-Boot source. You probably already have it, but if not these
 121 steps should get you started with a repo and some commits for testing.
 122
 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
 128 2. Create ~/.buildman to tell buildman where to find tool chains. As an
 129 example:
 130
 131 # Buildman settings file
 132
 133 [toolchain]
 134 root: /
 135 rest: /toolchains/*
 136 eldk: /opt/eldk-4.2
 137 arm: /opt/linaro/gcc-linaro-arm-linux-gnueabihf-4.8-2013.08_linux
 138 aarch64: /opt/linaro/gcc-linaro-aarch64-none-elf-4.8-2013.10_linux
 139
 140 [toolchain-alias]
 141 x86: i386
 142 blackfin: bfin
 143 sh: sh4
 144 nds32: nds32le
 145 openrisc: or32
 146
 147
 148 This selects the available toolchain paths. Add the base directory for
 149 each of your toolchains here. Buildman will search inside these directories
 150 and also in any '/usr' and '/usr/bin' subdirectories.
 151
 152 Make sure the tags (here root: rest: and eldk:) are unique.
 153
 154 The toolchain-alias section indicates that the i386 toolchain should be used
 155 to build x86 commits.
 156
 157
 158 2. Check the available toolchains
 159
 160 Run this check to make sure that you have a toolchain for every architecture.
 161
 162 $ ./tools/buildman/buildman --list-tool-chains
 163 Scanning for tool chains
 164    - scanning path '/'
 165       - looking in '/.'
 166       - looking in '/bin'
 167       - looking in '/usr/bin'
 168          - found '/usr/bin/gcc'
 169 Tool chain test:  OK
 170          - found '/usr/bin/c89-gcc'
 171 Tool chain test:  OK
 172          - found '/usr/bin/c99-gcc'
 173 Tool chain test:  OK
 174          - found '/usr/bin/x86_64-linux-gnu-gcc'
 175 Tool chain test:  OK
 176    - scanning path '/toolchains/powerpc-linux'
 177       - looking in '/toolchains/powerpc-linux/.'
 178       - looking in '/toolchains/powerpc-linux/bin'
 179          - found '/toolchains/powerpc-linux/bin/powerpc-linux-gcc'
 180 Tool chain test:  OK
 181       - looking in '/toolchains/powerpc-linux/usr/bin'
 182    - scanning path '/toolchains/nds32le-linux-glibc-v1f'
 183       - looking in '/toolchains/nds32le-linux-glibc-v1f/.'
 184       - looking in '/toolchains/nds32le-linux-glibc-v1f/bin'
 185          - found '/toolchains/nds32le-linux-glibc-v1f/bin/nds32le-linux-gcc'
 186 Tool chain test:  OK
 187       - looking in '/toolchains/nds32le-linux-glibc-v1f/usr/bin'
 188    - scanning path '/toolchains/nios2'
 189       - looking in '/toolchains/nios2/.'
 190       - looking in '/toolchains/nios2/bin'
 191          - found '/toolchains/nios2/bin/nios2-linux-gcc'
 192 Tool chain test:  OK
 193          - found '/toolchains/nios2/bin/nios2-linux-uclibc-gcc'
 194 Tool chain test:  OK
 195       - looking in '/toolchains/nios2/usr/bin'
 196          - found '/toolchains/nios2/usr/bin/nios2-linux-gcc'
 197 Tool chain test:  OK
 198          - found '/toolchains/nios2/usr/bin/nios2-linux-uclibc-gcc'
 199 Tool chain test:  OK
 200    - scanning path '/toolchains/microblaze-unknown-linux-gnu'
 201       - looking in '/toolchains/microblaze-unknown-linux-gnu/.'
 202       - looking in '/toolchains/microblaze-unknown-linux-gnu/bin'
 203          - found '/toolchains/microblaze-unknown-linux-gnu/bin/microblaze-unknown-linux-gnu-gcc'
 204 Tool chain test:  OK
 205          - found '/toolchains/microblaze-unknown-linux-gnu/bin/mb-linux-gcc'
 206 Tool chain test:  OK
 207       - looking in '/toolchains/microblaze-unknown-linux-gnu/usr/bin'
 208    - scanning path '/toolchains/mips-linux'
 209       - looking in '/toolchains/mips-linux/.'
 210       - looking in '/toolchains/mips-linux/bin'
 211          - found '/toolchains/mips-linux/bin/mips-linux-gcc'
 212 Tool chain test:  OK
 213       - looking in '/toolchains/mips-linux/usr/bin'
 214    - scanning path '/toolchains/old'
 215       - looking in '/toolchains/old/.'
 216       - looking in '/toolchains/old/bin'
 217       - looking in '/toolchains/old/usr/bin'
 218    - scanning path '/toolchains/i386-linux'
 219       - looking in '/toolchains/i386-linux/.'
 220       - looking in '/toolchains/i386-linux/bin'
 221          - found '/toolchains/i386-linux/bin/i386-linux-gcc'
 222 Tool chain test:  OK
 223       - looking in '/toolchains/i386-linux/usr/bin'
 224    - scanning path '/toolchains/bfin-uclinux'
 225       - looking in '/toolchains/bfin-uclinux/.'
 226       - looking in '/toolchains/bfin-uclinux/bin'
 227          - found '/toolchains/bfin-uclinux/bin/bfin-uclinux-gcc'
 228 Tool chain test:  OK
 229       - looking in '/toolchains/bfin-uclinux/usr/bin'
 230    - scanning path '/toolchains/sparc-elf'
 231       - looking in '/toolchains/sparc-elf/.'
 232       - looking in '/toolchains/sparc-elf/bin'
 233          - found '/toolchains/sparc-elf/bin/sparc-elf-gcc'
 234 Tool chain test:  OK
 235       - looking in '/toolchains/sparc-elf/usr/bin'
 236    - scanning path '/toolchains/arm-2010q1'
 237       - looking in '/toolchains/arm-2010q1/.'
 238       - looking in '/toolchains/arm-2010q1/bin'
 239          - found '/toolchains/arm-2010q1/bin/arm-none-linux-gnueabi-gcc'
 240 Tool chain test:  OK
 241       - looking in '/toolchains/arm-2010q1/usr/bin'
 242    - scanning path '/toolchains/from'
 243       - looking in '/toolchains/from/.'
 244       - looking in '/toolchains/from/bin'
 245       - looking in '/toolchains/from/usr/bin'
 246    - scanning path '/toolchains/sh4-gentoo-linux-gnu'
 247       - looking in '/toolchains/sh4-gentoo-linux-gnu/.'
 248       - looking in '/toolchains/sh4-gentoo-linux-gnu/bin'
 249          - found '/toolchains/sh4-gentoo-linux-gnu/bin/sh4-gentoo-linux-gnu-gcc'
 250 Tool chain test:  OK
 251       - looking in '/toolchains/sh4-gentoo-linux-gnu/usr/bin'
 252    - scanning path '/toolchains/avr32-linux'
 253       - looking in '/toolchains/avr32-linux/.'
 254       - looking in '/toolchains/avr32-linux/bin'
 255          - found '/toolchains/avr32-linux/bin/avr32-gcc'
 256 Tool chain test:  OK
 257       - looking in '/toolchains/avr32-linux/usr/bin'
 258    - scanning path '/toolchains/m68k-linux'
 259       - looking in '/toolchains/m68k-linux/.'
 260       - looking in '/toolchains/m68k-linux/bin'
 261          - found '/toolchains/m68k-linux/bin/m68k-linux-gcc'
 262 Tool chain test:  OK
 263       - looking in '/toolchains/m68k-linux/usr/bin'
 264 List of available toolchains (17):
 265 arm       : /toolchains/arm-2010q1/bin/arm-none-linux-gnueabi-gcc
 266 avr32     : /toolchains/avr32-linux/bin/avr32-gcc
 267 bfin      : /toolchains/bfin-uclinux/bin/bfin-uclinux-gcc
 268 c89       : /usr/bin/c89-gcc
 269 c99       : /usr/bin/c99-gcc
 270 i386      : /toolchains/i386-linux/bin/i386-linux-gcc
 271 m68k      : /toolchains/m68k-linux/bin/m68k-linux-gcc
 272 mb        : /toolchains/microblaze-unknown-linux-gnu/bin/mb-linux-gcc
 273 microblaze: /toolchains/microblaze-unknown-linux-gnu/bin/microblaze-unknown-linux-gnu-gcc
 274 mips      : /toolchains/mips-linux/bin/mips-linux-gcc
 275 nds32le   : /toolchains/nds32le-linux-glibc-v1f/bin/nds32le-linux-gcc
 276 nios2     : /toolchains/nios2/bin/nios2-linux-gcc
 277 powerpc   : /toolchains/powerpc-linux/bin/powerpc-linux-gcc
 278 sandbox   : /usr/bin/gcc
 279 sh4       : /toolchains/sh4-gentoo-linux-gnu/bin/sh4-gentoo-linux-gnu-gcc
 280 sparc     : /toolchains/sparc-elf/bin/sparc-elf-gcc
 281 x86_64    : /usr/bin/x86_64-linux-gnu-gcc
 282
 283
 284 You can see that everything is covered, even some strange ones that won't
 285 be used (c88 and c99). This is a feature.
 286
 287
 288 How to run it
 289 =============
 290
 291 First do a dry run using the -n flag: (replace <branch> with a real, local
 292 branch with a valid upstream)
 293
 294 $ ./tools/buildman/buildman -b <branch> -n
 295
 296 If it can't detect the upstream branch, try checking out the branch, and
 297 doing something like 'git branch --set-upstream <branch> upstream/master'
 298 or something similar.
 299
 300 As an example:
 301
 302 Dry run, so not doing much. But I would do this:
 303
 304 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 305 Build directory: ../lcd9b
 306     5bb3505 Merge branch 'master' of git://git.denx.de/u-boot-arm
 307     c18f1b4 tegra: Use const for pinmux_config_pingroup/table()
 308     2f043ae tegra: Add display support to funcmux
 309     e349900 tegra: fdt: Add pwm binding and node
 310     424a5f0 tegra: fdt: Add LCD definitions for Tegra
 311     0636ccf tegra: Add support for PWM
 312     a994fe7 tegra: Add SOC support for display/lcd
 313     fcd7350 tegra: Add LCD driver
 314     4d46e9d tegra: Add LCD support to Nvidia boards
 315     991bd48 arm: Add control over cachability of memory regions
 316     54e8019 lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 317     d92aff7 lcd: Add support for flushing LCD fb from dcache after update
 318     dbd0677 tegra: Align LCD frame buffer to section boundary
 319     0cff9b8 tegra: Support control of cache settings for LCD
 320     9c56900 tegra: fdt: Add LCD definitions for Seaboard
 321     5cc29db lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 322     cac5a23 tegra: Enable display/lcd support on Seaboard
 323     49ff541 wip
 324
 325 Total boards to build for each commit: 1059
 326
 327 This shows that it will build all 1059 boards, using 4 threads (because
 328 we have a 4-core CPU). Each thread will run with -j1, meaning that each
 329 make job will use a single CPU. The list of commits to be built helps you
 330 confirm that things look about right. Notice that buildman has chosen a
 331 'base' directory for you, immediately above your source tree.
 332
 333 Buildman works entirely inside the base directory, here ../lcd9b,
 334 creating a working directory for each thread, and creating output
 335 directories for each commit and board.
 336
 337
 338 Suggested Workflow
 339 ==================
 340
 341 To run the build for real, take off the -n:
 342
 343 $ ./tools/buildman/buildman -b <branch>
 344
 345 Buildman will set up some working directories, and get started. After a
 346 minute or so it will settle down to a steady pace, with a display like this:
 347
 348 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 349   528   36  124 /19062  1:13:30  : SIMPC8313_SP
 350
 351 This means that it is building 19062 board/commit combinations. So far it
 352 has managed to successfully build 528. Another 36 have built with warnings,
 353 and 124 more didn't build at all. Buildman expects to complete the process
 354 in an hour and 15 minutes. Use this time to buy a faster computer.
 355
 356
 357 To find out how the build went, ask for a summary with -s. You can do this
 358 either before the build completes (presumably in another terminal) or or
 359 afterwards. Let's work through an example of how this is used:
 360
 361 $ ./tools/buildman/buildman -b lcd9b -s
 362 ...
 363 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
 364    powerpc:   + galaxy5200_LOWBOOT
 365 02: tegra: Use const for pinmux_config_pingroup/table()
 366 03: tegra: Add display support to funcmux
 367 04: tegra: fdt: Add pwm binding and node
 368 05: tegra: fdt: Add LCD definitions for Tegra
 369 06: tegra: Add support for PWM
 370 07: tegra: Add SOC support for display/lcd
 371 08: tegra: Add LCD driver
 372 09: tegra: Add LCD support to Nvidia boards
 373 10: arm: Add control over cachability of memory regions
 374 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 375 12: lcd: Add support for flushing LCD fb from dcache after update
 376        arm:   + lubbock
 377 13: tegra: Align LCD frame buffer to section boundary
 378 14: tegra: Support control of cache settings for LCD
 379 15: tegra: fdt: Add LCD definitions for Seaboard
 380 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 381 17: tegra: Enable display/lcd support on Seaboard
 382 18: wip
 383
 384 This shows which commits have succeeded and which have failed. In this case
 385 the build is still in progress so many boards are not built yet (use -u to
 386 see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
 387 never builds correctly. This could be a problem with our toolchain, or it
 388 could be a bug in the upstream. The good news is that we probably don't need
 389 to blame our commits. The bad news is it isn't tested on that board.
 390
 391 Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
 392 is never fixed by a later commit, or you would see lubbock again, in green,
 393 without the +.
 394
 395 To see the actual error:
 396
 397 $ ./tools/buildman/buildman -b <branch> -se lubbock
 398 ...
 399 12: lcd: Add support for flushing LCD fb from dcache after update
 400        arm:   + lubbock
 401 +common/libcommon.o: In function `lcd_sync':
 402 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 403 +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
 404 +make: *** [/u-boot/lcd9b/.bm-work/00/build/u-boot] Error 139
 405 13: tegra: Align LCD frame buffer to section boundary
 406 14: tegra: Support control of cache settings for LCD
 407 15: tegra: fdt: Add LCD definitions for Seaboard
 408 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 409 -/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 410 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:125: undefined reference to `flush_dcache_range'
 411 17: tegra: Enable display/lcd support on Seaboard
 412 18: wip
 413
 414 So the problem is in lcd.c, due to missing cache operations. This information
 415 should be enough to work out what that commit is doing to break these
 416 boards. (In this case pxa did not have cache operations defined).
 417
 418 If you see error lines marked with - that means that the errors were fixed
 419 by that commit. Sometimes commits can be in the wrong order, so that a
 420 breakage is introduced for a few commits and fixed by later commits. This
 421 shows up clearly with buildman. You can then reorder the commits and try
 422 again.
 423
 424 At commit 16, the error moves - you can see that the old error at line 120
 425 is fixed, but there is a new one at line 126. This is probably only because
 426 we added some code and moved the broken line father down the file.
 427
 428 If many boards have the same error, then -e will display the error only
 429 once. This makes the output as concise as possible.
 430
 431 The full build output in this case is available in:
 432
 433 ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
 434
 435    done: Indicates the build was done, and holds the return code from make.
 436          This is 0 for a good build, typically 2 for a failure.
 437
 438    err:  Output from stderr, if any. Errors and warnings appear here.
 439
 440    log:  Output from stdout. Normally there isn't any since buildman runs
 441          in silent mode for now.
 442
 443    toolchain: Shows information about the toolchain used for the build.
 444
 445    sizes: Shows image size information.
 446
 447 It is possible to get the build output there also. Use the -k option for
 448 this. In that case you will also see some output files, like:
 449
 450    System.map  toolchain  u-boot  u-boot.bin  u-boot.map  autoconf.mk
 451    (also SPL versions u-boot-spl and u-boot-spl.bin if available)
 452
 453
 454 Checking Image Sizes
 455 ====================
 456
 457 A key requirement for U-Boot is that you keep code/data size to a minimum.
 458 Where a new feature increases this noticeably it should normally be put
 459 behind a CONFIG flag so that boards can leave it off and keep the image
 460 size more or less the same with each new release.
 461
 462 To check the impact of your commits on image size, use -S. For example:
 463
 464 $ ./tools/buildman/buildman -b us-x86 -sS
 465 Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
 466 01: MAKEALL: add support for per architecture toolchains
 467 02: x86: Add function to get top of usable ram
 468        x86: (for 1/3 boards)  text -272.0  rodata +41.0
 469 03: x86: Add basic cache operations
 470 04: x86: Permit bootstage and timer data to be used prior to relocation
 471        x86: (for 1/3 boards)  data +16.0
 472 05: x86: Add an __end symbol to signal the end of the U-Boot binary
 473        x86: (for 1/3 boards)  text +76.0
 474 06: x86: Rearrange the output input to remove BSS
 475        x86: (for 1/3 boards)  bss -2140.0
 476 07: x86: Support relocation of FDT on start-up
 477        x86: +   coreboot-x86
 478 08: x86: Add error checking to x86 relocation code
 479 09: x86: Adjust link device tree include file
 480 10: x86: Enable CONFIG_OF_CONTROL on coreboot
 481
 482
 483 You can see that image size only changed on x86, which is good because this
 484 series is not supposed to change any other board. From commit 7 onwards the
 485 build fails so we don't get code size numbers. The numbers are fractional
 486 because they are an average of all boards for that architecture. The
 487 intention is to allow you to quickly find image size problems introduced by
 488 your commits.
 489
 490 Note that the 'text' region and 'rodata' are split out. You should add the
 491 two together to get the total read-only size (reported as the first column
 492 in the output from binutil's 'size' utility).
 493
 494 A useful option is --step which lets you skip some commits. For example
 495 --step 2 will show the image sizes for only every 2nd commit (so it will
 496 compare the image sizes of the 1st, 3rd, 5th... commits). You can also use
 497 --step 0 which will compare only the first and last commits. This is useful
 498 for an overview of how your entire series affects code size.
 499
 500 You can also use -d to see a detailed size breakdown for each board. This
 501 list is sorted in order from largest growth to largest reduction.
 502
 503 It is possible to go a little further with the -B option (--bloat). This
 504 shows where U-Boot has bloated, breaking the size change down to the function
 505 level. Example output is below:
 506
 507 $ ./tools/buildman/buildman -b us-mem4 -sSdB
 508 ...
 509 19: Roll crc32 into hash infrastructure
 510        arm: (for 10/10 boards)  all -143.4  bss +1.2  data -4.8  rodata -48.2 text -91.6
 511             paz00          :  all +23  bss -4  rodata -29  text +56
 512                u-boot: add: 1/0, grow: 3/-2 bytes: 168/-104 (64)
 513                  function                                   old     new   delta
 514                  hash_command                                80     160     +80
 515                  crc32_wd_buf                                 -      56     +56
 516                  ext4fs_read_file                           540     568     +28
 517                  insert_var_value_sub                       688     692      +4
 518                  run_list_real                             1996    1992      -4
 519                  do_mem_crc                                 168      68    -100
 520             trimslice      :  all -9  bss +16  rodata -29  text +4
 521                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 522                  function                                   old     new   delta
 523                  hash_command                                80     160     +80
 524                  crc32_wd_buf                                 -      56     +56
 525                  ext4fs_iterate_dir                         672     668      -4
 526                  ext4fs_read_file                           568     548     -20
 527                  do_mem_crc                                 168      68    -100
 528             whistler       :  all -9  bss +16  rodata -29  text +4
 529                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 530                  function                                   old     new   delta
 531                  hash_command                                80     160     +80
 532                  crc32_wd_buf                                 -      56     +56
 533                  ext4fs_iterate_dir                         672     668      -4
 534                  ext4fs_read_file                           568     548     -20
 535                  do_mem_crc                                 168      68    -100
 536             seaboard       :  all -9  bss -28  rodata -29  text +48
 537                u-boot: add: 1/0, grow: 3/-2 bytes: 160/-104 (56)
 538                  function                                   old     new   delta
 539                  hash_command                                80     160     +80
 540                  crc32_wd_buf                                 -      56     +56
 541                  ext4fs_read_file                           548     568     +20
 542                  run_list_real                             1996    2000      +4
 543                  do_nandboot                                760     756      -4
 544                  do_mem_crc                                 168      68    -100
 545             colibri_t20_iris:  all -9  rodata -29  text +20
 546                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-112 (28)
 547                  function                                   old     new   delta
 548                  hash_command                                80     160     +80
 549                  crc32_wd_buf                                 -      56     +56
 550                  read_abs_bbt                               204     208      +4
 551                  do_nandboot                                760     756      -4
 552                  ext4fs_read_file                           576     568      -8
 553                  do_mem_crc                                 168      68    -100
 554             ventana        :  all -37  bss -12  rodata -29  text +4
 555                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 556                  function                                   old     new   delta
 557                  hash_command                                80     160     +80
 558                  crc32_wd_buf                                 -      56     +56
 559                  ext4fs_iterate_dir                         672     668      -4
 560                  ext4fs_read_file                           568     548     -20
 561                  do_mem_crc                                 168      68    -100
 562             harmony        :  all -37  bss -16  rodata -29  text +8
 563                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-124 (16)
 564                  function                                   old     new   delta
 565                  hash_command                                80     160     +80
 566                  crc32_wd_buf                                 -      56     +56
 567                  nand_write_oob_syndrome                    428     432      +4
 568                  ext4fs_iterate_dir                         672     668      -4
 569                  ext4fs_read_file                           568     548     -20
 570                  do_mem_crc                                 168      68    -100
 571             medcom-wide    :  all -417  bss +28  data -16  rodata -93  text -336
 572                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 573                  function                                   old     new   delta
 574                  crc32_wd_buf                                 -      56     +56
 575                  do_fat_read_at                            2872    2904     +32
 576                  hash_algo                                   16       -     -16
 577                  do_mem_crc                                 168      68    -100
 578                  hash_command                               420     160    -260
 579             tec            :  all -449  bss -4  data -16  rodata -93  text -336
 580                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 581                  function                                   old     new   delta
 582                  crc32_wd_buf                                 -      56     +56
 583                  do_fat_read_at                            2872    2904     +32
 584                  hash_algo                                   16       -     -16
 585                  do_mem_crc                                 168      68    -100
 586                  hash_command                               420     160    -260
 587             plutux         :  all -481  bss +16  data -16  rodata -93  text -388
 588                u-boot: add: 1/-1, grow: 1/-3 bytes: 68/-408 (-340)
 589                  function                                   old     new   delta
 590                  crc32_wd_buf                                 -      56     +56
 591                  do_load_serial_bin                        1688    1700     +12
 592                  hash_algo                                   16       -     -16
 593                  do_fat_read_at                            2904    2872     -32
 594                  do_mem_crc                                 168      68    -100
 595                  hash_command                               420     160    -260
 596    powerpc: (for 5/5 boards)  all +37.4  data -3.2  rodata -41.8  text +82.4
 597             MPC8610HPCD    :  all +55  rodata -29  text +84
 598                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 599                  function                                   old     new   delta
 600                  hash_command                                 -     176    +176
 601                  do_mem_crc                                 184      88     -96
 602             MPC8641HPCN    :  all +55  rodata -29  text +84
 603                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 604                  function                                   old     new   delta
 605                  hash_command                                 -     176    +176
 606                  do_mem_crc                                 184      88     -96
 607             MPC8641HPCN_36BIT:  all +55  rodata -29  text +84
 608                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 609                  function                                   old     new   delta
 610                  hash_command                                 -     176    +176
 611                  do_mem_crc                                 184      88     -96
 612             sbc8641d       :  all +55  rodata -29  text +84
 613                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 614                  function                                   old     new   delta
 615                  hash_command                                 -     176    +176
 616                  do_mem_crc                                 184      88     -96
 617             xpedite517x    :  all -33  data -16  rodata -93  text +76
 618                u-boot: add: 1/-1, grow: 0/-1 bytes: 176/-112 (64)
 619                  function                                   old     new   delta
 620                  hash_command                                 -     176    +176
 621                  hash_algo                                   16       -     -16
 622                  do_mem_crc                                 184      88     -96
 623 ...
 624
 625
 626 This shows that commit 19 has increased text size for arm (although only one
 627 board was built) and by 96 bytes for powerpc. This increase was offset in both
 628 cases by reductions in rodata and data/bss.
 629
 630 Shown below the summary lines is the sizes for each board. Below each board
 631 is the sizes for each function. This information starts with:
 632
 633    add - number of functions added / removed
 634    grow - number of functions which grew / shrunk
 635    bytes - number of bytes of code added to / removed from all functions,
 636             plus the total byte change in brackets
 637
 638 The change seems to be that hash_command() has increased by more than the
 639 do_mem_crc() function has decreased. The function sizes typically add up to
 640 roughly the text area size, but note that every read-only section except
 641 rodata is included in 'text', so the function total does not exactly
 642 correspond.
 643
 644 It is common when refactoring code for the rodata to decrease as the text size
 645 increases, and vice versa.
 646
 647
 648 Providing 'make' flags
 649 ======================
 650
 651 U-Boot's build system supports a few flags (such as BUILD_TAG) which affect
 652 the build product. These flags can be specified in the buildman settings
 653 file. They can also be useful when building U-Boot against other open source
 654 software.
 655
 656 [make-flags]
 657 at91-boards=ENABLE_AT91_TEST=1
 658 snapper9260=${at91-boards} BUILD_TAG=442
 659 snapper9g45=${at91-boards} BUILD_TAG=443
 660
 661 This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
 662 and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
 663 variable ${target} is available to access the target name (snapper9260 and
 664 snapper9g20 in this case). Variables are resolved recursively.
 665
 666 It is expected that any variables added are dealt with in U-Boot's
 667 config.mk file and documented in the README.
 668
 669
 670 Quick Sanity Check
 671 ==================
 672
 673 If you have made changes and want to do a quick sanity check of the
 674 currently-checked-out source, run buildman without the -b flag. This will
 675 build the selected boards and display build status and errors as it runs
 676 (i.e. -v amd -e are enabled automatically).
 677
 678
 679 Other options
 680 =============
 681
 682 Buildman has various other command line options. Try --help to see them.
 683
 684
 685 How to change from MAKEALL
 686 ==========================
 687
 688 Buildman includes most of the features of MAKEALL and is generally faster
 689 and easier to use. In particular it builds entire branches: if a particular
 690 commit introduces an error in a particular board, buildman can easily show
 691 you this, even if a later commit fixes that error.
 692
 693 The reasons to deprecate MAKEALL are:
 694 - We don't want to maintain two build systems
 695 - Buildman is typically faster
 696 - Buildman has a lot more features
 697
 698 But still, many people will be sad to lose MAKEALL. If you are used to
 699 MAKEALL, here are a few pointers.
 700
 701 First you need to set up your tool chains - see the 'Setting up' section
 702 for details. Once you have your required toolchain(s) detected then you are
 703 ready to go.
 704
 705 To build the current source tree, run buildman without a -b flag:
 706
 707    ./tools/buildman/buildman <list of things to build>
 708
 709 This will build the current source tree for the given boards and display
 710 the results and errors.
 711
 712 However buildman usually works on entire branches, and for that you must
 713 specify a board flag:
 714
 715    ./tools/buildman/buildman -b <branch_name> <list of things to build>
 716
 717 followed by (afterwards, or perhaps concurrently in another terminal):
 718
 719    ./tools/buildman/buildman -b <branch_name> -s <list of things to build>
 720
 721 to see the results of the build. Rather than showing you all the output,
 722 buildman just shows a summary, with red indicating that a commit introduced
 723 an error and green indicating that a commit fixed an error. Use the -e
 724 flag to see the full errors.
 725
 726 If you really want to see build results as they happen, use -v when doing a
 727 build (and -e if you want to see errors as well).
 728
 729 You don't need to stick around on that branch while buildman is running. It
 730 checks out its own copy of the source code, so you can change branches,
 731 add commits, etc. without affecting the build in progress.
 732
 733 The <list of things to build> can include board names, architectures or the
 734 like. There are no flags to disambiguate since ambiguities are rare. Using
 735 the examples from MAKEALL:
 736
 737 Examples:
 738   - build all Power Architecture boards:
 739       MAKEALL -a powerpc
 740       MAKEALL --arch powerpc
 741       MAKEALL powerpc
 742           ** buildman -b <branch> powerpc
 743   - build all PowerPC boards manufactured by vendor "esd":
 744       MAKEALL -a powerpc -v esd
 745           ** buildman -b <branch> esd
 746   - build all PowerPC boards manufactured either by "keymile" or "siemens":
 747       MAKEALL -a powerpc -v keymile -v siemens
 748           ** buildman -b <branch> keymile siemens
 749   - build all Freescale boards with MPC83xx CPUs, plus all 4xx boards:
 750       MAKEALL -c mpc83xx -v freescale 4xx
 751           ** buildman -b <branch> mpc83xx freescale 4xx
 752
 753 Buildman automatically tries to use all the CPUs in your machine. If you
 754 are building a lot of boards it will use one thread for every CPU core
 755 it detects in your machine. This is like MAKEALL's BUILD_NBUILDS option.
 756 You can use the -T flag to change the number of threads. If you are only
 757 building a few boards, buildman will automatically run make with the -j
 758 flag to increase the number of concurrent make tasks. It isn't normally
 759 that helpful to fiddle with this option, but if you use the BUILD_NCPUS
 760 option in MAKEALL then -j is the equivalent in buildman.
 761
 762 Buildman puts its output in ../<branch_name> by default but you can change
 763 this with the -o option. Buildman normally does out-of-tree builds: use -i
 764 to disable that if you really want to. But be careful that once you have
 765 used -i you pollute buildman's copies of the source tree, and you will need
 766 to remove the build directory (normally ../<branch_name>) to run buildman
 767 in normal mode (without -i).
 768
 769 Buildman doesn't keep the output result normally, but use the -k option to
 770 do this.
 771
 772 Please read 'Theory of Operation' a few times as it will make a lot of
 773 things clearer.
 774
 775 Some options you might like are:
 776
 777    -B shows which functions are growing/shrinking in which commit - great
 778         for finding code bloat.
 779    -S shows image sizes for each commit (just an overall summary)
 780    -u shows boards that you haven't built yet
 781    --step 0 will build just the upstream commit and the last commit of your
 782         branch. This is often a quick sanity check that your branch doesn't
 783         break anything. But note this does not check bisectability!
 784
 785
 786 TODO
 787 ====
 788
 789 This has mostly be written in my spare time as a response to my difficulties
 790 in testing large series of patches. Apart from tidying up there is quite a
 791 bit of scope for improvement. Things like better error diffs, easier access
 792 to log files, error display while building. Also it would be nice it buildman
 793 could 'hunt' for problems, perhaps by building a few boards for each arch,
 794 or checking commits for changed files and building only boards which use
 795 those files.
 796
 797
 798 Credits
 799 =======
 800
 801 Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
 802 the build speed by building all commits for a board instead of the other
 803 way around.
 804
 805
 806 Simon Glass
 807 sjg@chromium.org
 808 Halloween 2012
 809 Updated 12-12-12
 810 Updated 23-02-13