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