1 # Copyright (c) 2013 The Chromium OS Authors.
3 # SPDX-License-Identifier: GPL-2.0+
6 (Please read 'How to change from MAKEALL' if you are used to that tool)
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.
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.
25 Buildman is still in its infancy. It is already a very useful tool, but
26 expect to find problems and send patches.
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.
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.
40 (please read this section in full twice or you will be perpetually confused)
42 Buildman is a builder. It is not make, although it runs make. It does not
43 produce any useful output on the terminal while building, except for
44 progress information (except with -v, see below). All the output (errors,
45 warnings and binaries if you ask for them) is stored in output
46 directories, which you can look at while the build is progressing, or when
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.
55 Buildman stores image size information and can report changes in image size
56 from commit to commit. An example of this is below.
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
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.
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.
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
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.
88 If you just want to build the current source tree, leave off the -b flag
89 and add -e. This will display results and errors as they happen. You can
90 still look at them later using -se. Note that buildman will assume that the
91 source has changed, and will build all specified boards in this case.
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.
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:
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
111 While the default is to OR the terms together, you can also make use of
112 the '&' operator to limit the selection:
114 * 'freescale & arm sandbox' All Freescale boards with ARM architecture,
117 You can also use -x to specifically exclude some boards. For example:
119 buildmand arm -x nvidia,freescale,.*ball$
121 means to build all arm boards except nvidia, freescale and anything ending
124 It is convenient to use the -n option to see what will be built based on
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.
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.
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
144 2. Create ~/.buildman to tell buildman where to find tool chains. As an
147 # Buildman settings file
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
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.
168 Make sure the tags (here root: rest: and eldk:) are unique.
170 The toolchain-alias section indicates that the i386 toolchain should be used
171 to build x86 commits.
174 2. Check the available toolchains
176 Run this check to make sure that you have a toolchain for every architecture.
178 $ ./tools/buildman/buildman --list-tool-chains
179 Scanning for tool chains
183 - looking in '/usr/bin'
184 - found '/usr/bin/gcc'
186 - found '/usr/bin/c89-gcc'
188 - found '/usr/bin/c99-gcc'
190 - found '/usr/bin/x86_64-linux-gnu-gcc'
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'
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'
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'
209 - found '/toolchains/nios2/bin/nios2-linux-uclibc-gcc'
211 - looking in '/toolchains/nios2/usr/bin'
212 - found '/toolchains/nios2/usr/bin/nios2-linux-gcc'
214 - found '/toolchains/nios2/usr/bin/nios2-linux-uclibc-gcc'
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'
221 - found '/toolchains/microblaze-unknown-linux-gnu/bin/mb-linux-gcc'
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'
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'
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'
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'
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'
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'
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'
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'
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
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.
307 First do a dry run using the -n flag: (replace <branch> with a real, local
308 branch with a valid upstream)
310 $ ./tools/buildman/buildman -b <branch> -n
312 If it can't detect the upstream branch, try checking out the branch, and
313 doing something like 'git branch --set-upstream-to upstream/master'
314 or something similar. Buildman will try to guess a suitable upstream branch
315 if it can't find one (you will see a message like" Guessing upstream as ...).
319 Dry run, so not doing much. But I would do this:
321 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
322 Build 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
342 Total boards to build for each commit: 1059
344 This shows that it will build all 1059 boards, using 4 threads (because
345 we have a 4-core CPU). Each thread will run with -j1, meaning that each
346 make job will use a single CPU. The list of commits to be built helps you
347 confirm that things look about right. Notice that buildman has chosen a
348 'base' directory for you, immediately above your source tree.
350 Buildman works entirely inside the base directory, here ../lcd9b,
351 creating a working directory for each thread, and creating output
352 directories for each commit and board.
358 To run the build for real, take off the -n:
360 $ ./tools/buildman/buildman -b <branch>
362 Buildman will set up some working directories, and get started. After a
363 minute or so it will settle down to a steady pace, with a display like this:
365 Building 18 commits for 1059 boards (4 threads, 1 job per thread)
366 528 36 124 /19062 1:13:30 : SIMPC8313_SP
368 This means that it is building 19062 board/commit combinations. So far it
369 has managed to successfully build 528. Another 36 have built with warnings,
370 and 124 more didn't build at all. Buildman expects to complete the process
371 in an hour and 15 minutes. Use this time to buy a faster computer.
374 To find out how the build went, ask for a summary with -s. You can do this
375 either before the build completes (presumably in another terminal) or
376 afterwards. Let's work through an example of how this is used:
378 $ ./tools/buildman/buildman -b lcd9b -s
380 01: Merge branch 'master' of git://git.denx.de/u-boot-arm
381 powerpc: + galaxy5200_LOWBOOT
382 02: tegra: Use const for pinmux_config_pingroup/table()
383 03: tegra: Add display support to funcmux
384 04: tegra: fdt: Add pwm binding and node
385 05: tegra: fdt: Add LCD definitions for Tegra
386 06: tegra: Add support for PWM
387 07: tegra: Add SOC support for display/lcd
388 08: tegra: Add LCD driver
389 09: tegra: Add LCD support to Nvidia boards
390 10: arm: Add control over cachability of memory regions
391 11: lcd: Add CONFIG_LCD_ALIGNMENT to select frame buffer alignment
392 12: lcd: Add support for flushing LCD fb from dcache after update
394 13: tegra: Align LCD frame buffer to section boundary
395 14: tegra: Support control of cache settings for LCD
396 15: tegra: fdt: Add LCD definitions for Seaboard
397 16: lcd: Add CONFIG_CONSOLE_SCROLL_LINES option to speed console
398 17: tegra: Enable display/lcd support on Seaboard
401 This shows which commits have succeeded and which have failed. In this case
402 the build is still in progress so many boards are not built yet (use -u to
403 see which ones). But still we can see a few failures. The galaxy5200_LOWBOOT
404 never builds correctly. This could be a problem with our toolchain, or it
405 could be a bug in the upstream. The good news is that we probably don't need
406 to blame our commits. The bad news is it isn't tested on that board.
408 Commit 12 broke lubbock. That's what the '+ lubbock' means. The failure
409 is never fixed by a later commit, or you would see lubbock again, in green,
412 To see the actual error:
414 $ ./tools/buildman/buildman -b <branch> -se lubbock
416 12: lcd: Add support for flushing LCD fb from dcache after update
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
422 13: tegra: Align LCD frame buffer to section boundary
423 14: tegra: Support control of cache settings for LCD
424 15: tegra: fdt: Add LCD definitions for Seaboard
425 16: 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'
428 17: tegra: Enable display/lcd support on Seaboard
431 So the problem is in lcd.c, due to missing cache operations. This information
432 should be enough to work out what that commit is doing to break these
433 boards. (In this case pxa did not have cache operations defined).
435 If you see error lines marked with - that means that the errors were fixed
436 by that commit. Sometimes commits can be in the wrong order, so that a
437 breakage is introduced for a few commits and fixed by later commits. This
438 shows up clearly with buildman. You can then reorder the commits and try
441 At commit 16, the error moves - you can see that the old error at line 120
442 is fixed, but there is a new one at line 126. This is probably only because
443 we added some code and moved the broken line further down the file.
445 If many boards have the same error, then -e will display the error only
446 once. This makes the output as concise as possible. To see which boards have
449 Buildman tries to distinguish warnings from errors, and shows warning lines
450 separately with a 'w' prefix.
452 The full build output in this case is available in:
454 ../lcd9b/12_of_18_gd92aff7_lcd--Add-support-for/lubbock/
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.
459 err: Output from stderr, if any. Errors and warnings appear here.
461 log: Output from stdout. Normally there isn't any since buildman runs
462 in silent mode for now.
464 toolchain: Shows information about the toolchain used for the build.
466 sizes: Shows image size information.
468 It is possible to get the build output there also. Use the -k option for
469 this. In that case you will also see some output files, like:
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)
478 A key requirement for U-Boot is that you keep code/data size to a minimum.
479 Where a new feature increases this noticeably it should normally be put
480 behind a CONFIG flag so that boards can leave it off and keep the image
481 size more or less the same with each new release.
483 To check the impact of your commits on image size, use -S. For example:
485 $ ./tools/buildman/buildman -b us-x86 -sS
486 Summary of 10 commits for 1066 boards (4 threads, 1 job per thread)
487 01: MAKEALL: add support for per architecture toolchains
488 02: x86: Add function to get top of usable ram
489 x86: (for 1/3 boards) text -272.0 rodata +41.0
490 03: x86: Add basic cache operations
491 04: x86: Permit bootstage and timer data to be used prior to relocation
492 x86: (for 1/3 boards) data +16.0
493 05: x86: Add an __end symbol to signal the end of the U-Boot binary
494 x86: (for 1/3 boards) text +76.0
495 06: x86: Rearrange the output input to remove BSS
496 x86: (for 1/3 boards) bss -2140.0
497 07: x86: Support relocation of FDT on start-up
499 08: x86: Add error checking to x86 relocation code
500 09: x86: Adjust link device tree include file
501 10: x86: Enable CONFIG_OF_CONTROL on coreboot
504 You can see that image size only changed on x86, which is good because this
505 series is not supposed to change any other board. From commit 7 onwards the
506 build fails so we don't get code size numbers. The numbers are fractional
507 because they are an average of all boards for that architecture. The
508 intention is to allow you to quickly find image size problems introduced by
511 Note that the 'text' region and 'rodata' are split out. You should add the
512 two together to get the total read-only size (reported as the first column
513 in the output from binutil's 'size' utility).
515 A 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
517 compare 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
519 for an overview of how your entire series affects code size.
521 You can also use -d to see a detailed size breakdown for each board. This
522 list is sorted in order from largest growth to largest reduction.
524 It is possible to go a little further with the -B option (--bloat). This
525 shows where U-Boot has bloated, breaking the size change down to the function
526 level. Example output is below:
528 $ ./tools/buildman/buildman -b us-mem4 -sSdB
530 19: 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
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
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
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
643 do_mem_crc 184 88 -96
647 This shows that commit 19 has increased text size for arm (although only one
648 board was built) and by 96 bytes for powerpc. This increase was offset in both
649 cases by reductions in rodata and data/bss.
651 Shown below the summary lines are the sizes for each board. Below each board
652 are the sizes for each function. This information starts with:
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
659 The change seems to be that hash_command() has increased by more than the
660 do_mem_crc() function has decreased. The function sizes typically add up to
661 roughly the text area size, but note that every read-only section except
662 rodata is included in 'text', so the function total does not exactly
665 It is common when refactoring code for the rodata to decrease as the text size
666 increases, and vice versa.
669 Providing 'make' flags
670 ======================
672 U-Boot's build system supports a few flags (such as BUILD_TAG) which affect
673 the build product. These flags can be specified in the buildman settings
674 file. They can also be useful when building U-Boot against other open source
678 at91-boards=ENABLE_AT91_TEST=1
679 snapper9260=${at91-boards} BUILD_TAG=442
680 snapper9g45=${at91-boards} BUILD_TAG=443
682 This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
683 and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
684 variable ${target} is available to access the target name (snapper9260 and
685 snapper9g20 in this case). Variables are resolved recursively. Note that
686 variables can only contain the characters A-Z, a-z, 0-9, hyphen (-) and
689 It is expected that any variables added are dealt with in U-Boot's
690 config.mk file and documented in the README.
696 If you have made changes and want to do a quick sanity check of the
697 currently checked-out source, run buildman without the -b flag. This will
698 build the selected boards and display build status as it runs (i.e. -v is
699 enabled automatically). Use -e to see errors/warnings as well.
705 You can build a range of commits by specifying a range instead of a branch
706 when using the -b flag. For example:
708 upstream/master..us-buildman
710 will build commits in us-buildman that are not in upstream/master.
716 Buildman has various other command line options. Try --help to see them.
718 When doing builds, Buildman's return code will reflect the overall result:
720 0 (success) No errors or warnings found
725 How to change from MAKEALL
726 ==========================
728 Buildman includes most of the features of MAKEALL and is generally faster
729 and easier to use. In particular it builds entire branches: if a particular
730 commit introduces an error in a particular board, buildman can easily show
731 you this, even if a later commit fixes that error.
733 The 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
738 But still, many people will be sad to lose MAKEALL. If you are used to
739 MAKEALL, here are a few pointers.
741 First you need to set up your tool chains - see the 'Setting up' section
742 for details. Once you have your required toolchain(s) detected then you are
745 To build the current source tree, run buildman without a -b flag:
747 ./tools/buildman/buildman <list of things to build>
749 This will build the current source tree for the given boards and display
750 the results and errors.
752 However buildman usually works on entire branches, and for that you must
753 specify a board flag:
755 ./tools/buildman/buildman -b <branch_name> <list of things to build>
757 followed by (afterwards, or perhaps concurrently in another terminal):
759 ./tools/buildman/buildman -b <branch_name> -s <list of things to build>
761 to see the results of the build. Rather than showing you all the output,
762 buildman just shows a summary, with red indicating that a commit introduced
763 an error and green indicating that a commit fixed an error. Use the -e
764 flag to see the full errors and -l to see which boards caused which errors.
766 If you really want to see build results as they happen, use -v when doing a
767 build (and -e to see the errors/warnings too).
769 You don't need to stick around on that branch while buildman is running. It
770 checks out its own copy of the source code, so you can change branches,
771 add commits, etc. without affecting the build in progress.
773 The <list of things to build> can include board names, architectures or the
774 like. There are no flags to disambiguate since ambiguities are rare. Using
775 the examples from MAKEALL:
778 - build all Power Architecture boards:
780 MAKEALL --arch 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
793 Buildman automatically tries to use all the CPUs in your machine. If you
794 are building a lot of boards it will use one thread for every CPU core
795 it detects in your machine. This is like MAKEALL's BUILD_NBUILDS option.
796 You can use the -T flag to change the number of threads. If you are only
797 building a few boards, buildman will automatically run make with the -j
798 flag to increase the number of concurrent make tasks. It isn't normally
799 that helpful to fiddle with this option, but if you use the BUILD_NCPUS
800 option in MAKEALL then -j is the equivalent in buildman.
802 Buildman puts its output in ../<branch_name> by default but you can change
803 this with the -o option. Buildman normally does out-of-tree builds: use -i
804 to disable that if you really want to. But be careful that once you have
805 used -i you pollute buildman's copies of the source tree, and you will need
806 to remove the build directory (normally ../<branch_name>) to run buildman
807 in normal mode (without -i).
809 Buildman doesn't keep the output result normally, but use the -k option to
812 Please read 'Theory of Operation' a few times as it will make a lot of
815 Some options you might like are:
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!
829 This has mostly be written in my spare time as a response to my difficulties
830 in testing large series of patches. Apart from tidying up there is quite a
831 bit of scope for improvement. Things like better error diffs and easier
832 access to log files. Also it would be nice if buildman could 'hunt' for
833 problems, perhaps by building a few boards for each arch, or checking
834 commits for changed files and building only boards which use those files.
840 Thanks to Grant Grundler <grundler@chromium.org> for his ideas for improving
841 the build speed by building all commits for a board instead of the other