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