tools/buildman/README

   1 # Copyright (c) 2013 The Chromium OS Authors.
   2 #
   3 # SPDX-License-Identifier:      GPL-2.0+
   4 #
   5
   6 What is this?
   7 =============
   8
   9 This tool handles building U-Boot to check that you have not broken it
  10 with your patch series. It can build each individual commit and report
  11 which boards fail on which commits, and which errors come up. It aims
  12 to make full use of multi-processor machines.
  13
  14 A key feature of buildman is its output summary, which allows warnings,
  15 errors or image size increases in a particular commit or board to be
  16 quickly identified and the offending commit pinpointed. This can be a big
  17 help for anyone working with >10 patches at a time.
  18
  19
  20 Caveats
  21 =======
  22
  23 Buildman is still in its infancy. It is already a very useful tool, but
  24 expect to find problems and send patches.
  25
  26 Buildman can be stopped and restarted, in which case it will continue
  27 where it left off. This should happen cleanly and without side-effects.
  28 If not, it is a bug, for which a patch would be welcome.
  29
  30 Buildman gets so tied up in its work that it can ignore the outside world.
  31 You may need to press Ctrl-C several times to quit it. Also it will print
  32 out various exceptions when stopped.
  33
  34
  35 Theory of Operation
  36 ===================
  37
  38 (please read this section in full twice or you will be perpetually confused)
  39
  40 Buildman is a builder. It is not make, although it runs make. It does not
  41 produce any useful output on the terminal while building, except for
  42 progress information. All the output (errors, warnings and binaries if you
  43 are ask for them) is stored in output directories, which you can look at
  44 while the build is progressing, or when it is finished.
  45
  46 Buildman produces a concise summary of which boards succeeded and failed.
  47 It shows which commit introduced which board failure using a simple
  48 red/green colour coding. Full error information can be requested, in which
  49 case it is de-duped and displayed against the commit that introduced the
  50 error. An example workflow is below.
  51
  52 Buildman stores image size information and can report changes in image size
  53 from commit to commit. An example of this is below.
  54
  55 Buildman starts multiple threads, and each thread builds for one board at
  56 a time. A thread starts at the first commit, configures the source for your
  57 board and builds it. Then it checks out the next commit and does an
  58 incremental build. Eventually the thread reaches the last commit and stops.
  59 If errors or warnings are found along the way, the thread will reconfigure
  60 after every commit, and your build will be very slow. This is because a
  61 file that produces just a warning would not normally be rebuilt in an
  62 incremental build.
  63
  64 Buildman works in an entirely separate place from your U-Boot repository.
  65 It creates a separate working directory for each thread, and puts the
  66 output files in the working directory, organised by commit name and board
  67 name, in a two-level hierarchy.
  68
  69 Buildman is invoked in your U-Boot directory, the one with the .git
  70 directory. It clones this repository into a copy for each thread, and the
  71 threads do not affect the state of your git repository. Any checkouts done
  72 by the thread affect only the working directory for that thread.
  73
  74 Buildman automatically selects the correct toolchain for each board. You
  75 must supply suitable toolchains, but buildman takes care of selecting the
  76 right one.
  77
  78 Buildman always builds a branch, and always builds the upstream commit as
  79 well, for comparison. It cannot build individual commits at present, unless
  80 (maybe) you point it at an empty branch. Put all your commits in a branch,
  81 set the branch's upstream to a valid value, and all will be well. Otherwise
  82 buildman will perform random actions. Use -n to check what the random
  83 actions might be.
  84
  85 Buildman is optimised for building many commits at once, for many boards.
  86 On multi-core machines, Buildman is fast because it uses most of the
  87 available CPU power. When it gets to the end, or if you are building just
  88 a few commits or boards, it will be pretty slow. As a tip, if you don't
  89 plan to use your machine for anything else, you can use -T to increase the
  90 number of threads beyond the default.
  91
  92 Buildman lets you build all boards, or a subset. Specify the subset by passing
  93 command-line arguments that list the desired board name, architecture name,
  94 SOC name, or anything else in the boards.cfg file. Multiple arguments are
  95 allowed. Each argument will be interpreted as a regular expression, so
  96 behaviour is a superset of exact or substring matching. Examples are:
  97
  98 * 'tegra20'      All boards with a Tegra20 SoC
  99 * 'tegra'        All boards with any Tegra Soc (Tegra20, Tegra30, Tegra114...)
 100 * '^tegra[23]0$' All boards with either Tegra20 or Tegra30 SoC
 101 * 'powerpc'      All PowerPC boards
 102
 103 Buildman does not store intermediate object files. It optionally copies
 104 the binary output into a directory when a build is successful. Size
 105 information is always recorded. It needs a fair bit of disk space to work,
 106 typically 250MB per thread.
 107
 108
 109 Setting up
 110 ==========
 111
 112 1. Get the U-Boot source. You probably already have it, but if not these
 113 steps should get you started with a repo and some commits for testing.
 114
 115 $ cd /path/to/u-boot
 116 $ git clone git://git.denx.de/u-boot.git .
 117 $ git checkout -b my-branch origin/master
 118 $ # Add some commits to the branch, reading for testing
 119
 120 2. Create ~/.buildman to tell buildman where to find tool chains. As an
 121 example:
 122
 123 # Buildman settings file
 124
 125 [toolchain]
 126 root: /
 127 rest: /toolchains/*
 128 eldk: /opt/eldk-4.2
 129
 130 [toolchain-alias]
 131 x86: i386
 132 blackfin: bfin
 133 sh: sh4
 134 nds32: nds32le
 135 openrisc: or32
 136
 137
 138 This selects the available toolchain paths. Add the base directory for
 139 each of your toolchains here. Buildman will search inside these directories
 140 and also in any '/usr' and '/usr/bin' subdirectories.
 141
 142 Make sure the tags (here root: rest: and eldk:) are unique.
 143
 144 The toolchain-alias section indicates that the i386 toolchain should be used
 145 to build x86 commits.
 146
 147
 148 2. Check the available toolchains
 149
 150 Run this check to make sure that you have a toolchain for every architecture.
 151
 152 $ ./tools/buildman/buildman --list-tool-chains
 153 Scanning for tool chains
 154    - scanning path '/'
 155       - looking in '/.'
 156       - looking in '/bin'
 157       - looking in '/usr/bin'
 158          - found '/usr/bin/gcc'
 159 Tool chain test:  OK
 160          - found '/usr/bin/c89-gcc'
 161 Tool chain test:  OK
 162          - found '/usr/bin/c99-gcc'
 163 Tool chain test:  OK
 164          - found '/usr/bin/x86_64-linux-gnu-gcc'
 165 Tool chain test:  OK
 166    - scanning path '/toolchains/powerpc-linux'
 167       - looking in '/toolchains/powerpc-linux/.'
 168       - looking in '/toolchains/powerpc-linux/bin'
 169          - found '/toolchains/powerpc-linux/bin/powerpc-linux-gcc'
 170 Tool chain test:  OK
 171       - looking in '/toolchains/powerpc-linux/usr/bin'
 172    - scanning path '/toolchains/nds32le-linux-glibc-v1f'
 173       - looking in '/toolchains/nds32le-linux-glibc-v1f/.'
 174       - looking in '/toolchains/nds32le-linux-glibc-v1f/bin'
 175          - found '/toolchains/nds32le-linux-glibc-v1f/bin/nds32le-linux-gcc'
 176 Tool chain test:  OK
 177       - looking in '/toolchains/nds32le-linux-glibc-v1f/usr/bin'
 178    - scanning path '/toolchains/nios2'
 179       - looking in '/toolchains/nios2/.'
 180       - looking in '/toolchains/nios2/bin'
 181          - found '/toolchains/nios2/bin/nios2-linux-gcc'
 182 Tool chain test:  OK
 183          - found '/toolchains/nios2/bin/nios2-linux-uclibc-gcc'
 184 Tool chain test:  OK
 185       - looking in '/toolchains/nios2/usr/bin'
 186          - found '/toolchains/nios2/usr/bin/nios2-linux-gcc'
 187 Tool chain test:  OK
 188          - found '/toolchains/nios2/usr/bin/nios2-linux-uclibc-gcc'
 189 Tool chain test:  OK
 190    - scanning path '/toolchains/microblaze-unknown-linux-gnu'
 191       - looking in '/toolchains/microblaze-unknown-linux-gnu/.'
 192       - looking in '/toolchains/microblaze-unknown-linux-gnu/bin'
 193          - found '/toolchains/microblaze-unknown-linux-gnu/bin/microblaze-unknown-linux-gnu-gcc'
 194 Tool chain test:  OK
 195          - found '/toolchains/microblaze-unknown-linux-gnu/bin/mb-linux-gcc'
 196 Tool chain test:  OK
 197       - looking in '/toolchains/microblaze-unknown-linux-gnu/usr/bin'
 198    - scanning path '/toolchains/mips-linux'
 199       - looking in '/toolchains/mips-linux/.'
 200       - looking in '/toolchains/mips-linux/bin'
 201          - found '/toolchains/mips-linux/bin/mips-linux-gcc'
 202 Tool chain test:  OK
 203       - looking in '/toolchains/mips-linux/usr/bin'
 204    - scanning path '/toolchains/old'
 205       - looking in '/toolchains/old/.'
 206       - looking in '/toolchains/old/bin'
 207       - looking in '/toolchains/old/usr/bin'
 208    - scanning path '/toolchains/i386-linux'
 209       - looking in '/toolchains/i386-linux/.'
 210       - looking in '/toolchains/i386-linux/bin'
 211          - found '/toolchains/i386-linux/bin/i386-linux-gcc'
 212 Tool chain test:  OK
 213       - looking in '/toolchains/i386-linux/usr/bin'
 214    - scanning path '/toolchains/bfin-uclinux'
 215       - looking in '/toolchains/bfin-uclinux/.'
 216       - looking in '/toolchains/bfin-uclinux/bin'
 217          - found '/toolchains/bfin-uclinux/bin/bfin-uclinux-gcc'
 218 Tool chain test:  OK
 219       - looking in '/toolchains/bfin-uclinux/usr/bin'
 220    - scanning path '/toolchains/sparc-elf'
 221       - looking in '/toolchains/sparc-elf/.'
 222       - looking in '/toolchains/sparc-elf/bin'
 223          - found '/toolchains/sparc-elf/bin/sparc-elf-gcc'
 224 Tool chain test:  OK
 225       - looking in '/toolchains/sparc-elf/usr/bin'
 226    - scanning path '/toolchains/arm-2010q1'
 227       - looking in '/toolchains/arm-2010q1/.'
 228       - looking in '/toolchains/arm-2010q1/bin'
 229          - found '/toolchains/arm-2010q1/bin/arm-none-linux-gnueabi-gcc'
 230 Tool chain test:  OK
 231       - looking in '/toolchains/arm-2010q1/usr/bin'
 232    - scanning path '/toolchains/from'
 233       - looking in '/toolchains/from/.'
 234       - looking in '/toolchains/from/bin'
 235       - looking in '/toolchains/from/usr/bin'
 236    - scanning path '/toolchains/sh4-gentoo-linux-gnu'
 237       - looking in '/toolchains/sh4-gentoo-linux-gnu/.'
 238       - looking in '/toolchains/sh4-gentoo-linux-gnu/bin'
 239          - found '/toolchains/sh4-gentoo-linux-gnu/bin/sh4-gentoo-linux-gnu-gcc'
 240 Tool chain test:  OK
 241       - looking in '/toolchains/sh4-gentoo-linux-gnu/usr/bin'
 242    - scanning path '/toolchains/avr32-linux'
 243       - looking in '/toolchains/avr32-linux/.'
 244       - looking in '/toolchains/avr32-linux/bin'
 245          - found '/toolchains/avr32-linux/bin/avr32-gcc'
 246 Tool chain test:  OK
 247       - looking in '/toolchains/avr32-linux/usr/bin'
 248    - scanning path '/toolchains/m68k-linux'
 249       - looking in '/toolchains/m68k-linux/.'
 250       - looking in '/toolchains/m68k-linux/bin'
 251          - found '/toolchains/m68k-linux/bin/m68k-linux-gcc'
 252 Tool chain test:  OK
 253       - looking in '/toolchains/m68k-linux/usr/bin'
 254 List of available toolchains (17):
 255 arm       : /toolchains/arm-2010q1/bin/arm-none-linux-gnueabi-gcc
 256 avr32     : /toolchains/avr32-linux/bin/avr32-gcc
 257 bfin      : /toolchains/bfin-uclinux/bin/bfin-uclinux-gcc
 258 c89       : /usr/bin/c89-gcc
 259 c99       : /usr/bin/c99-gcc
 260 i386      : /toolchains/i386-linux/bin/i386-linux-gcc
 261 m68k      : /toolchains/m68k-linux/bin/m68k-linux-gcc
 262 mb        : /toolchains/microblaze-unknown-linux-gnu/bin/mb-linux-gcc
 263 microblaze: /toolchains/microblaze-unknown-linux-gnu/bin/microblaze-unknown-linux-gnu-gcc
 264 mips      : /toolchains/mips-linux/bin/mips-linux-gcc
 265 nds32le   : /toolchains/nds32le-linux-glibc-v1f/bin/nds32le-linux-gcc
 266 nios2     : /toolchains/nios2/bin/nios2-linux-gcc
 267 powerpc   : /toolchains/powerpc-linux/bin/powerpc-linux-gcc
 268 sandbox   : /usr/bin/gcc
 269 sh4       : /toolchains/sh4-gentoo-linux-gnu/bin/sh4-gentoo-linux-gnu-gcc
 270 sparc     : /toolchains/sparc-elf/bin/sparc-elf-gcc
 271 x86_64    : /usr/bin/x86_64-linux-gnu-gcc
 272
 273
 274 You can see that everything is covered, even some strange ones that won't
 275 be used (c88 and c99). This is a feature.
 276
 277
 278 How to run it
 279 =============
 280
 281 First do a dry run using the -n flag: (replace <branch> with a real, local
 282 branch with a valid upstream)
 283
 284 $ ./tools/buildman/buildman -b <branch> -n
 285
 286 If it can't detect the upstream branch, try checking out the branch, and
 287 doing something like 'git branch --set-upstream <branch> upstream/master'
 288 or something similar.
 289
 290 As an exmmple:
 291
 292 Dry run, so not doing much. But I would do this:
 293
 294 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 295 Build directory: ../lcd9b
 296     5bb3505 Merge branch 'master' of git://git.denx.de/u-boot-arm
 297     c18f1b4 tegra: Use const for pinmux_config_pingroup/table()
 298     2f043ae tegra: Add display support to funcmux
 299     e349900 tegra: fdt: Add pwm binding and node
 300     424a5f0 tegra: fdt: Add LCD definitions for Tegra
 301     0636ccf tegra: Add support for PWM
 302     a994fe7 tegra: Add SOC support for display/lcd
 303     fcd7350 tegra: Add LCD driver
 304     4d46e9d tegra: Add LCD support to Nvidia boards
 305     991bd48 arm: Add control over cachability of memory regions
 306     54e8019 lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 307     d92aff7 lcd: Add support for flushing LCD fb from dcache after update
 308     dbd0677 tegra: Align LCD frame buffer to section boundary
 309     0cff9b8 tegra: Support control of cache settings for LCD
 310     9c56900 tegra: fdt: Add LCD definitions for Seaboard
 311     5cc29db lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 312     cac5a23 tegra: Enable display/lcd support on Seaboard
 313     49ff541 wip
 314
 315 Total boards to build for each commit: 1059
 316
 317 This shows that it will build all 1059 boards, using 4 threads (because
 318 we have a 4-core CPU). Each thread will run with -j1, meaning that each
 319 make job will use a single CPU. The list of commits to be built helps you
 320 confirm that things look about right. Notice that buildman has chosen a
 321 'base' directory for you, immediately above your source tree.
 322
 323 Buildman works entirely inside the base directory, here ../lcd9b,
 324 creating a working directory for each thread, and creating output
 325 directories for each commit and board.
 326
 327
 328 Suggested Workflow
 329 ==================
 330
 331 To run the build for real, take off the -n:
 332
 333 $ ./tools/buildman/buildman -b <branch>
 334
 335 Buildman will set up some working directories, and get started. After a
 336 minute or so it will settle down to a steady pace, with a display like this:
 337
 338 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
 339   528   36  124 /19062  1:13:30  : SIMPC8313_SP
 340
 341 This means that it is building 19062 board/commit combinations. So far it
 342 has managed to succesfully build 528. Another 36 have built with warnings,
 343 and 124 more didn't build at all. Buildman expects to complete the process
 344 in an hour and 15 minutes. Use this time to buy a faster computer.
 345
 346
 347 To find out how the build went, ask for a summary with -s. You can do this
 348 either before the build completes (presumably in another terminal) or or
 349 afterwards. Let's work through an example of how this is used:
 350
 351 $ ./tools/buildman/buildman -b lcd9b -s
 352 ...
 353 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
 354    powerpc:   + galaxy5200_LOWBOOT
 355 02: tegra: Use const for pinmux_config_pingroup/table()
 356 03: tegra: Add display support to funcmux
 357 04: tegra: fdt: Add pwm binding and node
 358 05: tegra: fdt: Add LCD definitions for Tegra
 359 06: tegra: Add support for PWM
 360 07: tegra: Add SOC support for display/lcd
 361 08: tegra: Add LCD driver
 362 09: tegra: Add LCD support to Nvidia boards
 363 10: arm: Add control over cachability of memory regions
 364 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
 365 12: lcd: Add support for flushing LCD fb from dcache after update
 366        arm:   + lubbock
 367 13: tegra: Align LCD frame buffer to section boundary
 368 14: tegra: Support control of cache settings for LCD
 369 15: tegra: fdt: Add LCD definitions for Seaboard
 370 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 371 17: tegra: Enable display/lcd support on Seaboard
 372 18: wip
 373
 374 This shows which commits have succeeded and which have failed. In this case
 375 the build is still in progress so many boards are not built yet (use -u to
 376 see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
 377 never builds correctly. This could be a problem with our toolchain, or it
 378 could be a bug in the upstream. The good news is that we probably don't need
 379 to blame our commits. The bad news is it isn't tested on that board.
 380
 381 Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
 382 is never fixed by a later commit, or you would see lubbock again, in green,
 383 without the +.
 384
 385 To see the actual error:
 386
 387 $ ./tools/buildman/buildman -b <branch> -se lubbock
 388 ...
 389 12: lcd: Add support for flushing LCD fb from dcache after update
 390        arm:   + lubbock
 391 +common/libcommon.o: In function `lcd_sync':
 392 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 393 +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
 394 +make: *** [/u-boot/lcd9b/.bm-work/00/build/u-boot] Error 139
 395 13: tegra: Align LCD frame buffer to section boundary
 396 14: tegra: Support control of cache settings for LCD
 397 15: tegra: fdt: Add LCD definitions for Seaboard
 398 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
 399 -/u-boot/lcd9b/.bm-work/00/common/lcd.c:120: undefined reference to `flush_dcache_range'
 400 +/u-boot/lcd9b/.bm-work/00/common/lcd.c:125: undefined reference to `flush_dcache_range'
 401 17: tegra: Enable display/lcd support on Seaboard
 402 18: wip
 403
 404 So the problem is in lcd.c, due to missing cache operations. This information
 405 should be enough to work out what that commit is doing to break these
 406 boards. (In this case pxa did not have cache operations defined).
 407
 408 If you see error lines marked with - that means that the errors were fixed
 409 by that commit. Sometimes commits can be in the wrong order, so that a
 410 breakage is introduced for a few commits and fixed by later commits. This
 411 shows up clearly with buildman. You can then reorder the commits and try
 412 again.
 413
 414 At commit 16, the error moves - you can see that the old error at line 120
 415 is fixed, but there is a new one at line 126. This is probably only because
 416 we added some code and moved the broken line futher down the file.
 417
 418 If many boards have the same error, then -e will display the error only
 419 once. This makes the output as concise as possible.
 420
 421 The full build output in this case is available in:
 422
 423 ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
 424
 425    done: Indicates the build was done, and holds the return code from make.
 426          This is 0 for a good build, typically 2 for a failure.
 427
 428    err:  Output from stderr, if any. Errors and warnings appear here.
 429
 430    log:  Output from stdout. Normally there isn't any since buildman runs
 431          in silent mode for now.
 432
 433    toolchain: Shows information about the toolchain used for the build.
 434
 435    sizes: Shows image size information.
 436
 437 It is possible to get the build output there also. Use the -k option for
 438 this. In that case you will also see some output files, like:
 439
 440    System.map  toolchain  u-boot  u-boot.bin  u-boot.map  autoconf.mk
 441    (also SPL versions u-boot-spl and u-boot-spl.bin if available)
 442
 443
 444 Checking Image Sizes
 445 ====================
 446
 447 A key requirement for U-Boot is that you keep code/data size to a minimum.
 448 Where a new feature increases this noticeably it should normally be put
 449 behind a CONFIG flag so that boards can leave it off and keep the image
 450 size more or less the same with each new release.
 451
 452 To check the impact of your commits on image size, use -S. For example:
 453
 454 $ ./tools/buildman/buildman -b us-x86 -sS
 455 Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
 456 01: MAKEALL: add support for per architecture toolchains
 457 02: x86: Add function to get top of usable ram
 458        x86: (for 1/3 boards)  text -272.0  rodata +41.0
 459 03: x86: Add basic cache operations
 460 04: x86: Permit bootstage and timer data to be used prior to relocation
 461        x86: (for 1/3 boards)  data +16.0
 462 05: x86: Add an __end symbol to signal the end of the U-Boot binary
 463        x86: (for 1/3 boards)  text +76.0
 464 06: x86: Rearrange the output input to remove BSS
 465        x86: (for 1/3 boards)  bss -2140.0
 466 07: x86: Support relocation of FDT on start-up
 467        x86: +   coreboot-x86
 468 08: x86: Add error checking to x86 relocation code
 469 09: x86: Adjust link device tree include file
 470 10: x86: Enable CONFIG_OF_CONTROL on coreboot
 471
 472
 473 You can see that image size only changed on x86, which is good because this
 474 series is not supposed to change any other board. From commit 7 onwards the
 475 build fails so we don't get code size numbers. The numbers are fractional
 476 because they are an average of all boards for that architecture. The
 477 intention is to allow you to quickly find image size problems introduced by
 478 your commits.
 479
 480 Note that the 'text' region and 'rodata' are split out. You should add the
 481 two together to get the total read-only size (reported as the first column
 482 in the output from binutil's 'size' utility).
 483
 484 A useful option is --step which lets you skip some commits. For example
 485 --step 2 will show the image sizes for only every 2nd commit (so it will
 486 compare the image sizes of the 1st, 3rd, 5th... commits). You can also use
 487 --step 0 which will compare only the first and last commits. This is useful
 488 for an overview of how your entire series affects code size.
 489
 490 You can also use -d to see a detailed size breakdown for each board. This
 491 list is sorted in order from largest growth to largest reduction.
 492
 493 It is possible to go a little further with the -B option (--bloat). This
 494 shows where U-Boot has bloted, breaking the size change down to the function
 495 level. Example output is below:
 496
 497 $ ./tools/buildman/buildman -b us-mem4 -sSdB
 498 ...
 499 19: Roll crc32 into hash infrastructure
 500        arm: (for 10/10 boards)  all -143.4  bss +1.2  data -4.8  rodata -48.2 text -91.6
 501             paz00          :  all +23  bss -4  rodata -29  text +56
 502                u-boot: add: 1/0, grow: 3/-2 bytes: 168/-104 (64)
 503                  function                                   old     new   delta
 504                  hash_command                                80     160     +80
 505                  crc32_wd_buf                                 -      56     +56
 506                  ext4fs_read_file                           540     568     +28
 507                  insert_var_value_sub                       688     692      +4
 508                  run_list_real                             1996    1992      -4
 509                  do_mem_crc                                 168      68    -100
 510             trimslice      :  all -9  bss +16  rodata -29  text +4
 511                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 512                  function                                   old     new   delta
 513                  hash_command                                80     160     +80
 514                  crc32_wd_buf                                 -      56     +56
 515                  ext4fs_iterate_dir                         672     668      -4
 516                  ext4fs_read_file                           568     548     -20
 517                  do_mem_crc                                 168      68    -100
 518             whistler       :  all -9  bss +16  rodata -29  text +4
 519                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 520                  function                                   old     new   delta
 521                  hash_command                                80     160     +80
 522                  crc32_wd_buf                                 -      56     +56
 523                  ext4fs_iterate_dir                         672     668      -4
 524                  ext4fs_read_file                           568     548     -20
 525                  do_mem_crc                                 168      68    -100
 526             seaboard       :  all -9  bss -28  rodata -29  text +48
 527                u-boot: add: 1/0, grow: 3/-2 bytes: 160/-104 (56)
 528                  function                                   old     new   delta
 529                  hash_command                                80     160     +80
 530                  crc32_wd_buf                                 -      56     +56
 531                  ext4fs_read_file                           548     568     +20
 532                  run_list_real                             1996    2000      +4
 533                  do_nandboot                                760     756      -4
 534                  do_mem_crc                                 168      68    -100
 535             colibri_t20_iris:  all -9  rodata -29  text +20
 536                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-112 (28)
 537                  function                                   old     new   delta
 538                  hash_command                                80     160     +80
 539                  crc32_wd_buf                                 -      56     +56
 540                  read_abs_bbt                               204     208      +4
 541                  do_nandboot                                760     756      -4
 542                  ext4fs_read_file                           576     568      -8
 543                  do_mem_crc                                 168      68    -100
 544             ventana        :  all -37  bss -12  rodata -29  text +4
 545                u-boot: add: 1/0, grow: 1/-3 bytes: 136/-124 (12)
 546                  function                                   old     new   delta
 547                  hash_command                                80     160     +80
 548                  crc32_wd_buf                                 -      56     +56
 549                  ext4fs_iterate_dir                         672     668      -4
 550                  ext4fs_read_file                           568     548     -20
 551                  do_mem_crc                                 168      68    -100
 552             harmony        :  all -37  bss -16  rodata -29  text +8
 553                u-boot: add: 1/0, grow: 2/-3 bytes: 140/-124 (16)
 554                  function                                   old     new   delta
 555                  hash_command                                80     160     +80
 556                  crc32_wd_buf                                 -      56     +56
 557                  nand_write_oob_syndrome                    428     432      +4
 558                  ext4fs_iterate_dir                         672     668      -4
 559                  ext4fs_read_file                           568     548     -20
 560                  do_mem_crc                                 168      68    -100
 561             medcom-wide    :  all -417  bss +28  data -16  rodata -93  text -336
 562                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 563                  function                                   old     new   delta
 564                  crc32_wd_buf                                 -      56     +56
 565                  do_fat_read_at                            2872    2904     +32
 566                  hash_algo                                   16       -     -16
 567                  do_mem_crc                                 168      68    -100
 568                  hash_command                               420     160    -260
 569             tec            :  all -449  bss -4  data -16  rodata -93  text -336
 570                u-boot: add: 1/-1, grow: 1/-2 bytes: 88/-376 (-288)
 571                  function                                   old     new   delta
 572                  crc32_wd_buf                                 -      56     +56
 573                  do_fat_read_at                            2872    2904     +32
 574                  hash_algo                                   16       -     -16
 575                  do_mem_crc                                 168      68    -100
 576                  hash_command                               420     160    -260
 577             plutux         :  all -481  bss +16  data -16  rodata -93  text -388
 578                u-boot: add: 1/-1, grow: 1/-3 bytes: 68/-408 (-340)
 579                  function                                   old     new   delta
 580                  crc32_wd_buf                                 -      56     +56
 581                  do_load_serial_bin                        1688    1700     +12
 582                  hash_algo                                   16       -     -16
 583                  do_fat_read_at                            2904    2872     -32
 584                  do_mem_crc                                 168      68    -100
 585                  hash_command                               420     160    -260
 586    powerpc: (for 5/5 boards)  all +37.4  data -3.2  rodata -41.8  text +82.4
 587             MPC8610HPCD    :  all +55  rodata -29  text +84
 588                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 589                  function                                   old     new   delta
 590                  hash_command                                 -     176    +176
 591                  do_mem_crc                                 184      88     -96
 592             MPC8641HPCN    :  all +55  rodata -29  text +84
 593                u-boot: add: 1/0, grow: 0/-1 bytes: 176/-96 (80)
 594                  function                                   old     new   delta
 595                  hash_command                                 -     176    +176
 596                  do_mem_crc                                 184      88     -96
 597             MPC8641HPCN_36BIT:  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             sbc8641d       :  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             xpedite517x    :  all -33  data -16  rodata -93  text +76
 608                u-boot: add: 1/-1, grow: 0/-1 bytes: 176/-112 (64)
 609                  function                                   old     new   delta
 610                  hash_command                                 -     176    +176
 611                  hash_algo                                   16       -     -16
 612                  do_mem_crc                                 184      88     -96
 613 ...
 614
 615
 616 This shows that commit 19 has increased text size for arm (although only one
 617 board was built) and by 96 bytes for powerpc. This increase was offset in both
 618 cases by reductions in rodata and data/bss.
 619
 620 Shown below the summary lines is the sizes for each board. Below each board
 621 is the sizes for each function. This information starts with:
 622
 623    add - number of functions added / removed
 624    grow - number of functions which grew / shrunk
 625    bytes - number of bytes of code added to / removed from all functions,
 626             plus the total byte change in brackets
 627
 628 The change seems to be that hash_command() has increased by more than the
 629 do_mem_crc() function has decreased. The function sizes typically add up to
 630 roughly the text area size, but note that every read-only section except
 631 rodata is included in 'text', so the function total does not exactly
 632 correspond.
 633
 634 It is common when refactoring code for the rodata to decrease as the text size
 635 increases, and vice versa.
 636
 637
 638 Providing 'make' flags
 639 ======================
 640
 641 U-Boot's build system supports a few flags (such as BUILD_TAG) which affect
 642 the build product. These flags can be specified in the buildman settings
 643 file. They can also be useful when building U-Boot against other open source
 644 software.
 645
 646 [make-flags]
 647 at91-boards=ENABLE_AT91_TEST=1
 648 snapper9260=${at91-boards} BUILD_TAG=442
 649 snapper9g45=${at91-boards} BUILD_TAG=443
 650
 651 This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
 652 and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
 653 variable ${target} is available to access the target name (snapper9260 and
 654 snapper9g20 in this case). Variables are resolved recursively.
 655
 656 It is expected that any variables added are dealt with in U-Boot's
 657 config.mk file and documented in the README.
 658
 659
 660 Other options
 661 =============
 662
 663 Buildman has various other command line options. Try --help to see them.
 664
 665
 666 TODO
 667 ====
 668
 669 This has mostly be written in my spare time as a response to my difficulties
 670 in testing large series of patches. Apart from tidying up there is quite a
 671 bit of scope for improvement. Things like better error diffs, easier access
 672 to log files, error display while building. Also it would be nice it buildman
 673 could 'hunt' for problems, perhaps by building a few boards for each arch,
 674 or checking commits for changed files and building only boards which use
 675 those files.
 676
 677
 678 Credits
 679 =======
 680
 681 Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
 682 the build speed by building all commits for a board instead of the other
 683 way around.
 684
 685
 686 Simon Glass
 687 sjg@chromium.org
 688 Halloween 2012
 689 Updated 12-12-12
 690 Updated 23-02-13