kbuild: enable 'make AFLAGS=...' to add additional options to AS
[linux-3.10.git] / Documentation / kbuild / makefiles.txt
1 Linux Kernel Makefiles
2
3 This document describes the Linux kernel Makefiles.
4
5 === Table of Contents
6
7         === 1 Overview
8         === 2 Who does what
9         === 3 The kbuild files
10            --- 3.1 Goal definitions
11            --- 3.2 Built-in object goals - obj-y
12            --- 3.3 Loadable module goals - obj-m
13            --- 3.4 Objects which export symbols
14            --- 3.5 Library file goals - lib-y
15            --- 3.6 Descending down in directories
16            --- 3.7 Compilation flags
17            --- 3.8 Command line dependency
18            --- 3.9 Dependency tracking
19            --- 3.10 Special Rules
20            --- 3.11 $(CC) support functions
21
22         === 4 Host Program support
23            --- 4.1 Simple Host Program
24            --- 4.2 Composite Host Programs
25            --- 4.3 Defining shared libraries
26            --- 4.4 Using C++ for host programs
27            --- 4.5 Controlling compiler options for host programs
28            --- 4.6 When host programs are actually built
29            --- 4.7 Using hostprogs-$(CONFIG_FOO)
30
31         === 5 Kbuild clean infrastructure
32
33         === 6 Architecture Makefiles
34            --- 6.1 Set variables to tweak the build to the architecture
35            --- 6.2 Add prerequisites to archprepare:
36            --- 6.3 List directories to visit when descending
37            --- 6.4 Architecture-specific boot images
38            --- 6.5 Building non-kbuild targets
39            --- 6.6 Commands useful for building a boot image
40            --- 6.7 Custom kbuild commands
41            --- 6.8 Preprocessing linker scripts
42
43         === 7 Kbuild Variables
44         === 8 Makefile language
45         === 9 Credits
46         === 10 TODO
47
48 === 1 Overview
49
50 The Makefiles have five parts:
51
52         Makefile                the top Makefile.
53         .config                 the kernel configuration file.
54         arch/$(ARCH)/Makefile   the arch Makefile.
55         scripts/Makefile.*      common rules etc. for all kbuild Makefiles.
56         kbuild Makefiles        there are about 500 of these.
57
58 The top Makefile reads the .config file, which comes from the kernel
59 configuration process.
60
61 The top Makefile is responsible for building two major products: vmlinux
62 (the resident kernel image) and modules (any module files).
63 It builds these goals by recursively descending into the subdirectories of
64 the kernel source tree.
65 The list of subdirectories which are visited depends upon the kernel
66 configuration. The top Makefile textually includes an arch Makefile
67 with the name arch/$(ARCH)/Makefile. The arch Makefile supplies
68 architecture-specific information to the top Makefile.
69
70 Each subdirectory has a kbuild Makefile which carries out the commands
71 passed down from above. The kbuild Makefile uses information from the
72 .config file to construct various file lists used by kbuild to build
73 any built-in or modular targets.
74
75 scripts/Makefile.* contains all the definitions/rules etc. that
76 are used to build the kernel based on the kbuild makefiles.
77
78
79 === 2 Who does what
80
81 People have four different relationships with the kernel Makefiles.
82
83 *Users* are people who build kernels.  These people type commands such as
84 "make menuconfig" or "make".  They usually do not read or edit
85 any kernel Makefiles (or any other source files).
86
87 *Normal developers* are people who work on features such as device
88 drivers, file systems, and network protocols.  These people need to
89 maintain the kbuild Makefiles for the subsystem they are
90 working on.  In order to do this effectively, they need some overall
91 knowledge about the kernel Makefiles, plus detailed knowledge about the
92 public interface for kbuild.
93
94 *Arch developers* are people who work on an entire architecture, such
95 as sparc or ia64.  Arch developers need to know about the arch Makefile
96 as well as kbuild Makefiles.
97
98 *Kbuild developers* are people who work on the kernel build system itself.
99 These people need to know about all aspects of the kernel Makefiles.
100
101 This document is aimed towards normal developers and arch developers.
102
103
104 === 3 The kbuild files
105
106 Most Makefiles within the kernel are kbuild Makefiles that use the
107 kbuild infrastructure. This chapter introduces the syntax used in the
108 kbuild makefiles.
109 The preferred name for the kbuild files are 'Makefile' but 'Kbuild' can
110 be used and if both a 'Makefile' and a 'Kbuild' file exists, then the 'Kbuild'
111 file will be used.
112
113 Section 3.1 "Goal definitions" is a quick intro, further chapters provide
114 more details, with real examples.
115
116 --- 3.1 Goal definitions
117
118         Goal definitions are the main part (heart) of the kbuild Makefile.
119         These lines define the files to be built, any special compilation
120         options, and any subdirectories to be entered recursively.
121
122         The most simple kbuild makefile contains one line:
123
124         Example:
125                 obj-y += foo.o
126
127         This tells kbuild that there is one object in that directory, named
128         foo.o. foo.o will be built from foo.c or foo.S.
129
130         If foo.o shall be built as a module, the variable obj-m is used.
131         Therefore the following pattern is often used:
132
133         Example:
134                 obj-$(CONFIG_FOO) += foo.o
135
136         $(CONFIG_FOO) evaluates to either y (for built-in) or m (for module).
137         If CONFIG_FOO is neither y nor m, then the file will not be compiled
138         nor linked.
139
140 --- 3.2 Built-in object goals - obj-y
141
142         The kbuild Makefile specifies object files for vmlinux
143         in the $(obj-y) lists.  These lists depend on the kernel
144         configuration.
145
146         Kbuild compiles all the $(obj-y) files.  It then calls
147         "$(LD) -r" to merge these files into one built-in.o file.
148         built-in.o is later linked into vmlinux by the parent Makefile.
149
150         The order of files in $(obj-y) is significant.  Duplicates in
151         the lists are allowed: the first instance will be linked into
152         built-in.o and succeeding instances will be ignored.
153
154         Link order is significant, because certain functions
155         (module_init() / __initcall) will be called during boot in the
156         order they appear. So keep in mind that changing the link
157         order may e.g. change the order in which your SCSI
158         controllers are detected, and thus your disks are renumbered.
159
160         Example:
161                 #drivers/isdn/i4l/Makefile
162                 # Makefile for the kernel ISDN subsystem and device drivers.
163                 # Each configuration option enables a list of files.
164                 obj-$(CONFIG_ISDN)             += isdn.o
165                 obj-$(CONFIG_ISDN_PPP_BSDCOMP) += isdn_bsdcomp.o
166
167 --- 3.3 Loadable module goals - obj-m
168
169         $(obj-m) specify object files which are built as loadable
170         kernel modules.
171
172         A module may be built from one source file or several source
173         files. In the case of one source file, the kbuild makefile
174         simply adds the file to $(obj-m).
175
176         Example:
177                 #drivers/isdn/i4l/Makefile
178                 obj-$(CONFIG_ISDN_PPP_BSDCOMP) += isdn_bsdcomp.o
179
180         Note: In this example $(CONFIG_ISDN_PPP_BSDCOMP) evaluates to 'm'
181
182         If a kernel module is built from several source files, you specify
183         that you want to build a module in the same way as above.
184
185         Kbuild needs to know which the parts that you want to build your
186         module from, so you have to tell it by setting an
187         $(<module_name>-objs) variable.
188
189         Example:
190                 #drivers/isdn/i4l/Makefile
191                 obj-$(CONFIG_ISDN) += isdn.o
192                 isdn-objs := isdn_net_lib.o isdn_v110.o isdn_common.o
193
194         In this example, the module name will be isdn.o. Kbuild will
195         compile the objects listed in $(isdn-objs) and then run
196         "$(LD) -r" on the list of these files to generate isdn.o.
197
198         Kbuild recognises objects used for composite objects by the suffix
199         -objs, and the suffix -y. This allows the Makefiles to use
200         the value of a CONFIG_ symbol to determine if an object is part
201         of a composite object.
202
203         Example:
204                 #fs/ext2/Makefile
205                 obj-$(CONFIG_EXT2_FS)        += ext2.o
206                 ext2-y                       := balloc.o bitmap.o
207                 ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o
208
209         In this example, xattr.o is only part of the composite object
210         ext2.o if $(CONFIG_EXT2_FS_XATTR) evaluates to 'y'.
211
212         Note: Of course, when you are building objects into the kernel,
213         the syntax above will also work. So, if you have CONFIG_EXT2_FS=y,
214         kbuild will build an ext2.o file for you out of the individual
215         parts and then link this into built-in.o, as you would expect.
216
217 --- 3.4 Objects which export symbols
218
219         No special notation is required in the makefiles for
220         modules exporting symbols.
221
222 --- 3.5 Library file goals - lib-y
223
224         Objects listed with obj-* are used for modules, or
225         combined in a built-in.o for that specific directory.
226         There is also the possibility to list objects that will
227         be included in a library, lib.a.
228         All objects listed with lib-y are combined in a single
229         library for that directory.
230         Objects that are listed in obj-y and additionally listed in
231         lib-y will not be included in the library, since they will
232         be accessible anyway.
233         For consistency, objects listed in lib-m will be included in lib.a.
234
235         Note that the same kbuild makefile may list files to be built-in
236         and to be part of a library. Therefore the same directory
237         may contain both a built-in.o and a lib.a file.
238
239         Example:
240                 #arch/i386/lib/Makefile
241                 lib-y    := checksum.o delay.o
242
243         This will create a library lib.a based on checksum.o and delay.o.
244         For kbuild to actually recognize that there is a lib.a being built,
245         the directory shall be listed in libs-y.
246         See also "6.3 List directories to visit when descending".
247
248         Use of lib-y is normally restricted to lib/ and arch/*/lib.
249
250 --- 3.6 Descending down in directories
251
252         A Makefile is only responsible for building objects in its own
253         directory. Files in subdirectories should be taken care of by
254         Makefiles in these subdirs. The build system will automatically
255         invoke make recursively in subdirectories, provided you let it know of
256         them.
257
258         To do so, obj-y and obj-m are used.
259         ext2 lives in a separate directory, and the Makefile present in fs/
260         tells kbuild to descend down using the following assignment.
261
262         Example:
263                 #fs/Makefile
264                 obj-$(CONFIG_EXT2_FS) += ext2/
265
266         If CONFIG_EXT2_FS is set to either 'y' (built-in) or 'm' (modular)
267         the corresponding obj- variable will be set, and kbuild will descend
268         down in the ext2 directory.
269         Kbuild only uses this information to decide that it needs to visit
270         the directory, it is the Makefile in the subdirectory that
271         specifies what is modules and what is built-in.
272
273         It is good practice to use a CONFIG_ variable when assigning directory
274         names. This allows kbuild to totally skip the directory if the
275         corresponding CONFIG_ option is neither 'y' nor 'm'.
276
277 --- 3.7 Compilation flags
278
279     EXTRA_CFLAGS, EXTRA_AFLAGS, EXTRA_LDFLAGS
280
281         All the EXTRA_ variables apply only to the kbuild makefile
282         where they are assigned. The EXTRA_ variables apply to all
283         commands executed in the kbuild makefile.
284
285         $(EXTRA_CFLAGS) specifies options for compiling C files with
286         $(CC).
287
288         Example:
289                 # drivers/sound/emu10k1/Makefile
290                 EXTRA_CFLAGS += -I$(obj)
291                 ifdef DEBUG
292                     EXTRA_CFLAGS += -DEMU10K1_DEBUG
293                 endif
294
295
296         This variable is necessary because the top Makefile owns the
297         variable $(KBUILD_CFLAGS) and uses it for compilation flags for the
298         entire tree.
299
300         $(EXTRA_AFLAGS) is a similar string for per-directory options
301         when compiling assembly language source.
302
303         Example:
304                 #arch/x86_64/kernel/Makefile
305                 EXTRA_AFLAGS := -traditional
306
307
308         $(EXTRA_LDFLAGS) is a string for per-directory options to $(LD).
309
310         Example:
311                 #arch/m68k/fpsp040/Makefile
312                 EXTRA_LDFLAGS := -x
313
314     CFLAGS_$@, AFLAGS_$@
315
316         CFLAGS_$@ and AFLAGS_$@ only apply to commands in current
317         kbuild makefile.
318
319         $(CFLAGS_$@) specifies per-file options for $(CC).  The $@
320         part has a literal value which specifies the file that it is for.
321
322         Example:
323                 # drivers/scsi/Makefile
324                 CFLAGS_aha152x.o =   -DAHA152X_STAT -DAUTOCONF
325                 CFLAGS_gdth.o    = # -DDEBUG_GDTH=2 -D__SERIAL__ -D__COM2__ \
326                                      -DGDTH_STATISTICS
327                 CFLAGS_seagate.o =   -DARBITRATE -DPARITY -DSEAGATE_USE_ASM
328
329         These three lines specify compilation flags for aha152x.o,
330         gdth.o, and seagate.o
331
332         $(AFLAGS_$@) is a similar feature for source files in assembly
333         languages.
334
335         Example:
336                 # arch/arm/kernel/Makefile
337                 AFLAGS_head-armv.o := -DTEXTADDR=$(TEXTADDR) -traditional
338                 AFLAGS_head-armo.o := -DTEXTADDR=$(TEXTADDR) -traditional
339
340 --- 3.9 Dependency tracking
341
342         Kbuild tracks dependencies on the following:
343         1) All prerequisite files (both *.c and *.h)
344         2) CONFIG_ options used in all prerequisite files
345         3) Command-line used to compile target
346
347         Thus, if you change an option to $(CC) all affected files will
348         be re-compiled.
349
350 --- 3.10 Special Rules
351
352         Special rules are used when the kbuild infrastructure does
353         not provide the required support. A typical example is
354         header files generated during the build process.
355         Another example are the architecture-specific Makefiles which
356         need special rules to prepare boot images etc.
357
358         Special rules are written as normal Make rules.
359         Kbuild is not executing in the directory where the Makefile is
360         located, so all special rules shall provide a relative
361         path to prerequisite files and target files.
362
363         Two variables are used when defining special rules:
364
365     $(src)
366         $(src) is a relative path which points to the directory
367         where the Makefile is located. Always use $(src) when
368         referring to files located in the src tree.
369
370     $(obj)
371         $(obj) is a relative path which points to the directory
372         where the target is saved. Always use $(obj) when
373         referring to generated files.
374
375         Example:
376                 #drivers/scsi/Makefile
377                 $(obj)/53c8xx_d.h: $(src)/53c7,8xx.scr $(src)/script_asm.pl
378                         $(CPP) -DCHIP=810 - < $< | ... $(src)/script_asm.pl
379
380         This is a special rule, following the normal syntax
381         required by make.
382         The target file depends on two prerequisite files. References
383         to the target file are prefixed with $(obj), references
384         to prerequisites are referenced with $(src) (because they are not
385         generated files).
386
387 --- 3.11 $(CC) support functions
388
389         The kernel may be built with several different versions of
390         $(CC), each supporting a unique set of features and options.
391         kbuild provide basic support to check for valid options for $(CC).
392         $(CC) is usually the gcc compiler, but other alternatives are
393         available.
394
395     as-option
396         as-option is used to check if $(CC) -- when used to compile
397         assembler (*.S) files -- supports the given option. An optional
398         second option may be specified if the first option is not supported.
399
400         Example:
401                 #arch/sh/Makefile
402                 cflags-y += $(call as-option,-Wa$(comma)-isa=$(isa-y),)
403
404         In the above example, cflags-y will be assigned the option
405         -Wa$(comma)-isa=$(isa-y) if it is supported by $(CC).
406         The second argument is optional, and if supplied will be used
407         if first argument is not supported.
408
409     ld-option
410         ld-option is used to check if $(CC) when used to link object files
411         supports the given option.  An optional second option may be
412         specified if first option are not supported.
413
414         Example:
415                 #arch/i386/kernel/Makefile
416                 vsyscall-flags += $(call ld-option, -Wl$(comma)--hash-style=sysv)
417
418         In the above example, vsyscall-flags will be assigned the option
419         -Wl$(comma)--hash-style=sysv if it is supported by $(CC).
420         The second argument is optional, and if supplied will be used
421         if first argument is not supported.
422
423     as-instr
424         as-instr checks if the assembler reports a specific instruction
425         and then outputs either option1 or option2
426         C escapes are supported in the test instruction
427         Note: as-instr-option uses KBUILD_AFLAGS for $(AS) options
428
429     cc-option
430         cc-option is used to check if $(CC) supports a given option, and not
431         supported to use an optional second option.
432
433         Example:
434                 #arch/i386/Makefile
435                 cflags-y += $(call cc-option,-march=pentium-mmx,-march=i586)
436
437         In the above example, cflags-y will be assigned the option
438         -march=pentium-mmx if supported by $(CC), otherwise -march=i586.
439         The second argument to cc-option is optional, and if omitted,
440         cflags-y will be assigned no value if first option is not supported.
441         Note: cc-option uses KBUILD_CFLAGS for $(CC) options
442
443    cc-option-yn
444         cc-option-yn is used to check if gcc supports a given option
445         and return 'y' if supported, otherwise 'n'.
446
447         Example:
448                 #arch/ppc/Makefile
449                 biarch := $(call cc-option-yn, -m32)
450                 aflags-$(biarch) += -a32
451                 cflags-$(biarch) += -m32
452
453         In the above example, $(biarch) is set to y if $(CC) supports the -m32
454         option. When $(biarch) equals 'y', the expanded variables $(aflags-y)
455         and $(cflags-y) will be assigned the values -a32 and -m32,
456         respectively.
457         Note: cc-option-yn uses KBUILD_CFLAGS for $(CC) options
458
459     cc-option-align
460         gcc versions >= 3.0 changed the type of options used to specify
461         alignment of functions, loops etc. $(cc-option-align), when used
462         as prefix to the align options, will select the right prefix:
463         gcc < 3.00
464                 cc-option-align = -malign
465         gcc >= 3.00
466                 cc-option-align = -falign
467
468         Example:
469                 KBUILD_CFLAGS += $(cc-option-align)-functions=4
470
471         In the above example, the option -falign-functions=4 is used for
472         gcc >= 3.00. For gcc < 3.00, -malign-functions=4 is used.
473         Note: cc-option-align uses KBUILD_CFLAGS for $(CC) options
474
475     cc-version
476         cc-version returns a numerical version of the $(CC) compiler version.
477         The format is <major><minor> where both are two digits. So for example
478         gcc 3.41 would return 0341.
479         cc-version is useful when a specific $(CC) version is faulty in one
480         area, for example -mregparm=3 was broken in some gcc versions
481         even though the option was accepted by gcc.
482
483         Example:
484                 #arch/i386/Makefile
485                 cflags-y += $(shell \
486                 if [ $(call cc-version) -ge 0300 ] ; then \
487                         echo "-mregparm=3"; fi ;)
488
489         In the above example, -mregparm=3 is only used for gcc version greater
490         than or equal to gcc 3.0.
491
492     cc-ifversion
493         cc-ifversion tests the version of $(CC) and equals last argument if
494         version expression is true.
495
496         Example:
497                 #fs/reiserfs/Makefile
498                 EXTRA_CFLAGS := $(call cc-ifversion, -lt, 0402, -O1)
499
500         In this example, EXTRA_CFLAGS will be assigned the value -O1 if the
501         $(CC) version is less than 4.2.
502         cc-ifversion takes all the shell operators:
503         -eq, -ne, -lt, -le, -gt, and -ge
504         The third parameter may be a text as in this example, but it may also
505         be an expanded variable or a macro.
506
507     cc-fullversion
508         cc-fullversion is useful when the exact version of gcc is needed.
509         One typical use-case is when a specific GCC version is broken.
510         cc-fullversion points out a more specific version than cc-version does.
511
512         Example:
513                 #arch/powerpc/Makefile
514                 $(Q)if test "$(call cc-fullversion)" = "040200" ; then \
515                         echo -n '*** GCC-4.2.0 cannot compile the 64-bit powerpc ' ; \
516                         false ; \
517                 fi
518
519         In this example for a specific GCC version the build will error out explaining
520         to the user why it stops.
521
522 === 4 Host Program support
523
524 Kbuild supports building executables on the host for use during the
525 compilation stage.
526 Two steps are required in order to use a host executable.
527
528 The first step is to tell kbuild that a host program exists. This is
529 done utilising the variable hostprogs-y.
530
531 The second step is to add an explicit dependency to the executable.
532 This can be done in two ways. Either add the dependency in a rule,
533 or utilise the variable $(always).
534 Both possibilities are described in the following.
535
536 --- 4.1 Simple Host Program
537
538         In some cases there is a need to compile and run a program on the
539         computer where the build is running.
540         The following line tells kbuild that the program bin2hex shall be
541         built on the build host.
542
543         Example:
544                 hostprogs-y := bin2hex
545
546         Kbuild assumes in the above example that bin2hex is made from a single
547         c-source file named bin2hex.c located in the same directory as
548         the Makefile.
549
550 --- 4.2 Composite Host Programs
551
552         Host programs can be made up based on composite objects.
553         The syntax used to define composite objects for host programs is
554         similar to the syntax used for kernel objects.
555         $(<executable>-objs) lists all objects used to link the final
556         executable.
557
558         Example:
559                 #scripts/lxdialog/Makefile
560                 hostprogs-y   := lxdialog
561                 lxdialog-objs := checklist.o lxdialog.o
562
563         Objects with extension .o are compiled from the corresponding .c
564         files. In the above example, checklist.c is compiled to checklist.o
565         and lxdialog.c is compiled to lxdialog.o.
566         Finally, the two .o files are linked to the executable, lxdialog.
567         Note: The syntax <executable>-y is not permitted for host-programs.
568
569 --- 4.3 Defining shared libraries
570
571         Objects with extension .so are considered shared libraries, and
572         will be compiled as position independent objects.
573         Kbuild provides support for shared libraries, but the usage
574         shall be restricted.
575         In the following example the libkconfig.so shared library is used
576         to link the executable conf.
577
578         Example:
579                 #scripts/kconfig/Makefile
580                 hostprogs-y     := conf
581                 conf-objs       := conf.o libkconfig.so
582                 libkconfig-objs := expr.o type.o
583
584         Shared libraries always require a corresponding -objs line, and
585         in the example above the shared library libkconfig is composed by
586         the two objects expr.o and type.o.
587         expr.o and type.o will be built as position independent code and
588         linked as a shared library libkconfig.so. C++ is not supported for
589         shared libraries.
590
591 --- 4.4 Using C++ for host programs
592
593         kbuild offers support for host programs written in C++. This was
594         introduced solely to support kconfig, and is not recommended
595         for general use.
596
597         Example:
598                 #scripts/kconfig/Makefile
599                 hostprogs-y   := qconf
600                 qconf-cxxobjs := qconf.o
601
602         In the example above the executable is composed of the C++ file
603         qconf.cc - identified by $(qconf-cxxobjs).
604
605         If qconf is composed by a mixture of .c and .cc files, then an
606         additional line can be used to identify this.
607
608         Example:
609                 #scripts/kconfig/Makefile
610                 hostprogs-y   := qconf
611                 qconf-cxxobjs := qconf.o
612                 qconf-objs    := check.o
613
614 --- 4.5 Controlling compiler options for host programs
615
616         When compiling host programs, it is possible to set specific flags.
617         The programs will always be compiled utilising $(HOSTCC) passed
618         the options specified in $(HOSTCFLAGS).
619         To set flags that will take effect for all host programs created
620         in that Makefile, use the variable HOST_EXTRACFLAGS.
621
622         Example:
623                 #scripts/lxdialog/Makefile
624                 HOST_EXTRACFLAGS += -I/usr/include/ncurses
625
626         To set specific flags for a single file the following construction
627         is used:
628
629         Example:
630                 #arch/ppc64/boot/Makefile
631                 HOSTCFLAGS_piggyback.o := -DKERNELBASE=$(KERNELBASE)
632
633         It is also possible to specify additional options to the linker.
634
635         Example:
636                 #scripts/kconfig/Makefile
637                 HOSTLOADLIBES_qconf := -L$(QTDIR)/lib
638
639         When linking qconf, it will be passed the extra option
640         "-L$(QTDIR)/lib".
641
642 --- 4.6 When host programs are actually built
643
644         Kbuild will only build host-programs when they are referenced
645         as a prerequisite.
646         This is possible in two ways:
647
648         (1) List the prerequisite explicitly in a special rule.
649
650         Example:
651                 #drivers/pci/Makefile
652                 hostprogs-y := gen-devlist
653                 $(obj)/devlist.h: $(src)/pci.ids $(obj)/gen-devlist
654                         ( cd $(obj); ./gen-devlist ) < $<
655
656         The target $(obj)/devlist.h will not be built before
657         $(obj)/gen-devlist is updated. Note that references to
658         the host programs in special rules must be prefixed with $(obj).
659
660         (2) Use $(always)
661         When there is no suitable special rule, and the host program
662         shall be built when a makefile is entered, the $(always)
663         variable shall be used.
664
665         Example:
666                 #scripts/lxdialog/Makefile
667                 hostprogs-y   := lxdialog
668                 always        := $(hostprogs-y)
669
670         This will tell kbuild to build lxdialog even if not referenced in
671         any rule.
672
673 --- 4.7 Using hostprogs-$(CONFIG_FOO)
674
675         A typical pattern in a Kbuild file looks like this:
676
677         Example:
678                 #scripts/Makefile
679                 hostprogs-$(CONFIG_KALLSYMS) += kallsyms
680
681         Kbuild knows about both 'y' for built-in and 'm' for module.
682         So if a config symbol evaluate to 'm', kbuild will still build
683         the binary. In other words, Kbuild handles hostprogs-m exactly
684         like hostprogs-y. But only hostprogs-y is recommended to be used
685         when no CONFIG symbols are involved.
686
687 === 5 Kbuild clean infrastructure
688
689 "make clean" deletes most generated files in the obj tree where the kernel
690 is compiled. This includes generated files such as host programs.
691 Kbuild knows targets listed in $(hostprogs-y), $(hostprogs-m), $(always),
692 $(extra-y) and $(targets). They are all deleted during "make clean".
693 Files matching the patterns "*.[oas]", "*.ko", plus some additional files
694 generated by kbuild are deleted all over the kernel src tree when
695 "make clean" is executed.
696
697 Additional files can be specified in kbuild makefiles by use of $(clean-files).
698
699         Example:
700                 #drivers/pci/Makefile
701                 clean-files := devlist.h classlist.h
702
703 When executing "make clean", the two files "devlist.h classlist.h" will
704 be deleted. Kbuild will assume files to be in same relative directory as the
705 Makefile except if an absolute path is specified (path starting with '/').
706
707 To delete a directory hierarchy use:
708
709         Example:
710                 #scripts/package/Makefile
711                 clean-dirs := $(objtree)/debian/
712
713 This will delete the directory debian, including all subdirectories.
714 Kbuild will assume the directories to be in the same relative path as the
715 Makefile if no absolute path is specified (path does not start with '/').
716
717 Usually kbuild descends down in subdirectories due to "obj-* := dir/",
718 but in the architecture makefiles where the kbuild infrastructure
719 is not sufficient this sometimes needs to be explicit.
720
721         Example:
722                 #arch/i386/boot/Makefile
723                 subdir- := compressed/
724
725 The above assignment instructs kbuild to descend down in the
726 directory compressed/ when "make clean" is executed.
727
728 To support the clean infrastructure in the Makefiles that builds the
729 final bootimage there is an optional target named archclean:
730
731         Example:
732                 #arch/i386/Makefile
733                 archclean:
734                         $(Q)$(MAKE) $(clean)=arch/i386/boot
735
736 When "make clean" is executed, make will descend down in arch/i386/boot,
737 and clean as usual. The Makefile located in arch/i386/boot/ may use
738 the subdir- trick to descend further down.
739
740 Note 1: arch/$(ARCH)/Makefile cannot use "subdir-", because that file is
741 included in the top level makefile, and the kbuild infrastructure
742 is not operational at that point.
743
744 Note 2: All directories listed in core-y, libs-y, drivers-y and net-y will
745 be visited during "make clean".
746
747 === 6 Architecture Makefiles
748
749 The top level Makefile sets up the environment and does the preparation,
750 before starting to descend down in the individual directories.
751 The top level makefile contains the generic part, whereas
752 arch/$(ARCH)/Makefile contains what is required to set up kbuild
753 for said architecture.
754 To do so, arch/$(ARCH)/Makefile sets up a number of variables and defines
755 a few targets.
756
757 When kbuild executes, the following steps are followed (roughly):
758 1) Configuration of the kernel => produce .config
759 2) Store kernel version in include/linux/version.h
760 3) Symlink include/asm to include/asm-$(ARCH)
761 4) Updating all other prerequisites to the target prepare:
762    - Additional prerequisites are specified in arch/$(ARCH)/Makefile
763 5) Recursively descend down in all directories listed in
764    init-* core* drivers-* net-* libs-* and build all targets.
765    - The values of the above variables are expanded in arch/$(ARCH)/Makefile.
766 6) All object files are then linked and the resulting file vmlinux is
767    located at the root of the obj tree.
768    The very first objects linked are listed in head-y, assigned by
769    arch/$(ARCH)/Makefile.
770 7) Finally, the architecture-specific part does any required post processing
771    and builds the final bootimage.
772    - This includes building boot records
773    - Preparing initrd images and the like
774
775
776 --- 6.1 Set variables to tweak the build to the architecture
777
778     LDFLAGS             Generic $(LD) options
779
780         Flags used for all invocations of the linker.
781         Often specifying the emulation is sufficient.
782
783         Example:
784                 #arch/s390/Makefile
785                 LDFLAGS         := -m elf_s390
786         Note: EXTRA_LDFLAGS can be used to further customise
787         the flags used. See chapter 3.7.
788
789     LDFLAGS_MODULE      Options for $(LD) when linking modules
790
791         LDFLAGS_MODULE is used to set specific flags for $(LD) when
792         linking the .ko files used for modules.
793         Default is "-r", for relocatable output.
794
795     LDFLAGS_vmlinux     Options for $(LD) when linking vmlinux
796
797         LDFLAGS_vmlinux is used to specify additional flags to pass to
798         the linker when linking the final vmlinux image.
799         LDFLAGS_vmlinux uses the LDFLAGS_$@ support.
800
801         Example:
802                 #arch/i386/Makefile
803                 LDFLAGS_vmlinux := -e stext
804
805     OBJCOPYFLAGS        objcopy flags
806
807         When $(call if_changed,objcopy) is used to translate a .o file,
808         the flags specified in OBJCOPYFLAGS will be used.
809         $(call if_changed,objcopy) is often used to generate raw binaries on
810         vmlinux.
811
812         Example:
813                 #arch/s390/Makefile
814                 OBJCOPYFLAGS := -O binary
815
816                 #arch/s390/boot/Makefile
817                 $(obj)/image: vmlinux FORCE
818                         $(call if_changed,objcopy)
819
820         In this example, the binary $(obj)/image is a binary version of
821         vmlinux. The usage of $(call if_changed,xxx) will be described later.
822
823     KBUILD_AFLAGS               $(AS) assembler flags
824
825         Default value - see top level Makefile
826         Append or modify as required per architecture.
827
828         Example:
829                 #arch/sparc64/Makefile
830                 KBUILD_AFLAGS += -m64 -mcpu=ultrasparc
831
832     KBUILD_CFLAGS               $(CC) compiler flags
833
834         Default value - see top level Makefile
835         Append or modify as required per architecture.
836
837         Often, the KBUILD_CFLAGS variable depends on the configuration.
838
839         Example:
840                 #arch/i386/Makefile
841                 cflags-$(CONFIG_M386) += -march=i386
842                 KBUILD_CFLAGS += $(cflags-y)
843
844         Many arch Makefiles dynamically run the target C compiler to
845         probe supported options:
846
847                 #arch/i386/Makefile
848
849                 ...
850                 cflags-$(CONFIG_MPENTIUMII)     += $(call cc-option,\
851                                                 -march=pentium2,-march=i686)
852                 ...
853                 # Disable unit-at-a-time mode ...
854                 KBUILD_CFLAGS += $(call cc-option,-fno-unit-at-a-time)
855                 ...
856
857
858         The first example utilises the trick that a config option expands
859         to 'y' when selected.
860
861     CFLAGS_KERNEL       $(CC) options specific for built-in
862
863         $(CFLAGS_KERNEL) contains extra C compiler flags used to compile
864         resident kernel code.
865
866     CFLAGS_MODULE       $(CC) options specific for modules
867
868         $(CFLAGS_MODULE) contains extra C compiler flags used to compile code
869         for loadable kernel modules.
870
871
872 --- 6.2 Add prerequisites to archprepare:
873
874         The archprepare: rule is used to list prerequisites that need to be
875         built before starting to descend down in the subdirectories.
876         This is usually used for header files containing assembler constants.
877
878                 Example:
879                 #arch/arm/Makefile
880                 archprepare: maketools
881
882         In this example, the file target maketools will be processed
883         before descending down in the subdirectories.
884         See also chapter XXX-TODO that describe how kbuild supports
885         generating offset header files.
886
887
888 --- 6.3 List directories to visit when descending
889
890         An arch Makefile cooperates with the top Makefile to define variables
891         which specify how to build the vmlinux file.  Note that there is no
892         corresponding arch-specific section for modules; the module-building
893         machinery is all architecture-independent.
894
895
896     head-y, init-y, core-y, libs-y, drivers-y, net-y
897
898         $(head-y) lists objects to be linked first in vmlinux.
899         $(libs-y) lists directories where a lib.a archive can be located.
900         The rest list directories where a built-in.o object file can be
901         located.
902
903         $(init-y) objects will be located after $(head-y).
904         Then the rest follows in this order:
905         $(core-y), $(libs-y), $(drivers-y) and $(net-y).
906
907         The top level Makefile defines values for all generic directories,
908         and arch/$(ARCH)/Makefile only adds architecture-specific directories.
909
910         Example:
911                 #arch/sparc64/Makefile
912                 core-y += arch/sparc64/kernel/
913                 libs-y += arch/sparc64/prom/ arch/sparc64/lib/
914                 drivers-$(CONFIG_OPROFILE)  += arch/sparc64/oprofile/
915
916
917 --- 6.4 Architecture-specific boot images
918
919         An arch Makefile specifies goals that take the vmlinux file, compress
920         it, wrap it in bootstrapping code, and copy the resulting files
921         somewhere. This includes various kinds of installation commands.
922         The actual goals are not standardized across architectures.
923
924         It is common to locate any additional processing in a boot/
925         directory below arch/$(ARCH)/.
926
927         Kbuild does not provide any smart way to support building a
928         target specified in boot/. Therefore arch/$(ARCH)/Makefile shall
929         call make manually to build a target in boot/.
930
931         The recommended approach is to include shortcuts in
932         arch/$(ARCH)/Makefile, and use the full path when calling down
933         into the arch/$(ARCH)/boot/Makefile.
934
935         Example:
936                 #arch/i386/Makefile
937                 boot := arch/i386/boot
938                 bzImage: vmlinux
939                         $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@
940
941         "$(Q)$(MAKE) $(build)=<dir>" is the recommended way to invoke
942         make in a subdirectory.
943
944         There are no rules for naming architecture-specific targets,
945         but executing "make help" will list all relevant targets.
946         To support this, $(archhelp) must be defined.
947
948         Example:
949                 #arch/i386/Makefile
950                 define archhelp
951                   echo  '* bzImage      - Image (arch/$(ARCH)/boot/bzImage)'
952                 endif
953
954         When make is executed without arguments, the first goal encountered
955         will be built. In the top level Makefile the first goal present
956         is all:.
957         An architecture shall always, per default, build a bootable image.
958         In "make help", the default goal is highlighted with a '*'.
959         Add a new prerequisite to all: to select a default goal different
960         from vmlinux.
961
962         Example:
963                 #arch/i386/Makefile
964                 all: bzImage
965
966         When "make" is executed without arguments, bzImage will be built.
967
968 --- 6.5 Building non-kbuild targets
969
970     extra-y
971
972         extra-y specify additional targets created in the current
973         directory, in addition to any targets specified by obj-*.
974
975         Listing all targets in extra-y is required for two purposes:
976         1) Enable kbuild to check changes in command lines
977            - When $(call if_changed,xxx) is used
978         2) kbuild knows what files to delete during "make clean"
979
980         Example:
981                 #arch/i386/kernel/Makefile
982                 extra-y := head.o init_task.o
983
984         In this example, extra-y is used to list object files that
985         shall be built, but shall not be linked as part of built-in.o.
986
987
988 --- 6.6 Commands useful for building a boot image
989
990         Kbuild provides a few macros that are useful when building a
991         boot image.
992
993     if_changed
994
995         if_changed is the infrastructure used for the following commands.
996
997         Usage:
998                 target: source(s) FORCE
999                         $(call if_changed,ld/objcopy/gzip)
1000
1001         When the rule is evaluated, it is checked to see if any files
1002         need an update, or the command line has changed since the last
1003         invocation. The latter will force a rebuild if any options
1004         to the executable have changed.
1005         Any target that utilises if_changed must be listed in $(targets),
1006         otherwise the command line check will fail, and the target will
1007         always be built.
1008         Assignments to $(targets) are without $(obj)/ prefix.
1009         if_changed may be used in conjunction with custom commands as
1010         defined in 6.7 "Custom kbuild commands".
1011
1012         Note: It is a typical mistake to forget the FORCE prerequisite.
1013         Another common pitfall is that whitespace is sometimes
1014         significant; for instance, the below will fail (note the extra space
1015         after the comma):
1016                 target: source(s) FORCE
1017         #WRONG!#        $(call if_changed, ld/objcopy/gzip)
1018
1019     ld
1020         Link target. Often, LDFLAGS_$@ is used to set specific options to ld.
1021
1022     objcopy
1023         Copy binary. Uses OBJCOPYFLAGS usually specified in
1024         arch/$(ARCH)/Makefile.
1025         OBJCOPYFLAGS_$@ may be used to set additional options.
1026
1027     gzip
1028         Compress target. Use maximum compression to compress target.
1029
1030         Example:
1031                 #arch/i386/boot/Makefile
1032                 LDFLAGS_bootsect := -Ttext 0x0 -s --oformat binary
1033                 LDFLAGS_setup    := -Ttext 0x0 -s --oformat binary -e begtext
1034
1035                 targets += setup setup.o bootsect bootsect.o
1036                 $(obj)/setup $(obj)/bootsect: %: %.o FORCE
1037                         $(call if_changed,ld)
1038
1039         In this example, there are two possible targets, requiring different
1040         options to the linker. The linker options are specified using the
1041         LDFLAGS_$@ syntax - one for each potential target.
1042         $(targets) are assigned all potential targets, by which kbuild knows
1043         the targets and will:
1044                 1) check for commandline changes
1045                 2) delete target during make clean
1046
1047         The ": %: %.o" part of the prerequisite is a shorthand that
1048         free us from listing the setup.o and bootsect.o files.
1049         Note: It is a common mistake to forget the "target :=" assignment,
1050               resulting in the target file being recompiled for no
1051               obvious reason.
1052
1053
1054 --- 6.7 Custom kbuild commands
1055
1056         When kbuild is executing with KBUILD_VERBOSE=0, then only a shorthand
1057         of a command is normally displayed.
1058         To enable this behaviour for custom commands kbuild requires
1059         two variables to be set:
1060         quiet_cmd_<command>     - what shall be echoed
1061               cmd_<command>     - the command to execute
1062
1063         Example:
1064                 #
1065                 quiet_cmd_image = BUILD   $@
1066                       cmd_image = $(obj)/tools/build $(BUILDFLAGS) \
1067                                                      $(obj)/vmlinux.bin > $@
1068
1069                 targets += bzImage
1070                 $(obj)/bzImage: $(obj)/vmlinux.bin $(obj)/tools/build FORCE
1071                         $(call if_changed,image)
1072                         @echo 'Kernel: $@ is ready'
1073
1074         When updating the $(obj)/bzImage target, the line
1075
1076         BUILD    arch/i386/boot/bzImage
1077
1078         will be displayed with "make KBUILD_VERBOSE=0".
1079
1080
1081 --- 6.8 Preprocessing linker scripts
1082
1083         When the vmlinux image is built, the linker script
1084         arch/$(ARCH)/kernel/vmlinux.lds is used.
1085         The script is a preprocessed variant of the file vmlinux.lds.S
1086         located in the same directory.
1087         kbuild knows .lds files and includes a rule *lds.S -> *lds.
1088
1089         Example:
1090                 #arch/i386/kernel/Makefile
1091                 always := vmlinux.lds
1092
1093                 #Makefile
1094                 export CPPFLAGS_vmlinux.lds += -P -C -U$(ARCH)
1095
1096         The assignment to $(always) is used to tell kbuild to build the
1097         target vmlinux.lds.
1098         The assignment to $(CPPFLAGS_vmlinux.lds) tells kbuild to use the
1099         specified options when building the target vmlinux.lds.
1100
1101         When building the *.lds target, kbuild uses the variables:
1102         CPPFLAGS        : Set in top-level Makefile
1103         EXTRA_CPPFLAGS  : May be set in the kbuild makefile
1104         CPPFLAGS_$(@F)  : Target specific flags.
1105                           Note that the full filename is used in this
1106                           assignment.
1107
1108         The kbuild infrastructure for *lds file are used in several
1109         architecture-specific files.
1110
1111
1112 === 7 Kbuild Variables
1113
1114 The top Makefile exports the following variables:
1115
1116     VERSION, PATCHLEVEL, SUBLEVEL, EXTRAVERSION
1117
1118         These variables define the current kernel version.  A few arch
1119         Makefiles actually use these values directly; they should use
1120         $(KERNELRELEASE) instead.
1121
1122         $(VERSION), $(PATCHLEVEL), and $(SUBLEVEL) define the basic
1123         three-part version number, such as "2", "4", and "0".  These three
1124         values are always numeric.
1125
1126         $(EXTRAVERSION) defines an even tinier sublevel for pre-patches
1127         or additional patches.  It is usually some non-numeric string
1128         such as "-pre4", and is often blank.
1129
1130     KERNELRELEASE
1131
1132         $(KERNELRELEASE) is a single string such as "2.4.0-pre4", suitable
1133         for constructing installation directory names or showing in
1134         version strings.  Some arch Makefiles use it for this purpose.
1135
1136     ARCH
1137
1138         This variable defines the target architecture, such as "i386",
1139         "arm", or "sparc". Some kbuild Makefiles test $(ARCH) to
1140         determine which files to compile.
1141
1142         By default, the top Makefile sets $(ARCH) to be the same as the
1143         host system architecture.  For a cross build, a user may
1144         override the value of $(ARCH) on the command line:
1145
1146             make ARCH=m68k ...
1147
1148
1149     INSTALL_PATH
1150
1151         This variable defines a place for the arch Makefiles to install
1152         the resident kernel image and System.map file.
1153         Use this for architecture-specific install targets.
1154
1155     INSTALL_MOD_PATH, MODLIB
1156
1157         $(INSTALL_MOD_PATH) specifies a prefix to $(MODLIB) for module
1158         installation.  This variable is not defined in the Makefile but
1159         may be passed in by the user if desired.
1160
1161         $(MODLIB) specifies the directory for module installation.
1162         The top Makefile defines $(MODLIB) to
1163         $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE).  The user may
1164         override this value on the command line if desired.
1165
1166     INSTALL_MOD_STRIP
1167
1168         If this variable is specified, will cause modules to be stripped
1169         after they are installed.  If INSTALL_MOD_STRIP is '1', then the
1170         default option --strip-debug will be used.  Otherwise,
1171         INSTALL_MOD_STRIP will used as the option(s) to the strip command.
1172
1173
1174 === 8 Makefile language
1175
1176 The kernel Makefiles are designed to be run with GNU Make.  The Makefiles
1177 use only the documented features of GNU Make, but they do use many
1178 GNU extensions.
1179
1180 GNU Make supports elementary list-processing functions.  The kernel
1181 Makefiles use a novel style of list building and manipulation with few
1182 "if" statements.
1183
1184 GNU Make has two assignment operators, ":=" and "=".  ":=" performs
1185 immediate evaluation of the right-hand side and stores an actual string
1186 into the left-hand side.  "=" is like a formula definition; it stores the
1187 right-hand side in an unevaluated form and then evaluates this form each
1188 time the left-hand side is used.
1189
1190 There are some cases where "=" is appropriate.  Usually, though, ":="
1191 is the right choice.
1192
1193 === 9 Credits
1194
1195 Original version made by Michael Elizabeth Chastain, <mailto:mec@shout.net>
1196 Updates by Kai Germaschewski <kai@tp1.ruhr-uni-bochum.de>
1197 Updates by Sam Ravnborg <sam@ravnborg.org>
1198 Language QA by Jan Engelhardt <jengelh@gmx.de>
1199
1200 === 10 TODO
1201
1202 - Describe how kbuild supports shipped files with _shipped.
1203 - Generating offset header files.
1204 - Add more variables to section 7?
1205
1206
1207