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