[PATCH] vDSO hash-style fix
[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 that 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 introduce 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 tell 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 lists $(obj-y).  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 you 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 additional listed in
231         lib-y will not be included in the library, since they will anyway
232         be accessible.
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 build
245         the directory shall be listed in libs-y.
246         See also "6.3 List directories to visit when descending".
247  
248         Usage 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, EXTRA_ARFLAGS
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 $(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) and $(EXTRA_ARFLAGS) are similar strings for
309         per-directory options to $(LD) and $(AR).
310
311         Example:
312                 #arch/m68k/fpsp040/Makefile
313                 EXTRA_LDFLAGS := -x
314
315     CFLAGS_$@, AFLAGS_$@
316
317         CFLAGS_$@ and AFLAGS_$@ only apply to commands in current
318         kbuild makefile.
319
320         $(CFLAGS_$@) specifies per-file options for $(CC).  The $@
321         part has a literal value which specifies the file that it is for.
322
323         Example:
324                 # drivers/scsi/Makefile
325                 CFLAGS_aha152x.o =   -DAHA152X_STAT -DAUTOCONF
326                 CFLAGS_gdth.o    = # -DDEBUG_GDTH=2 -D__SERIAL__ -D__COM2__ \
327                                      -DGDTH_STATISTICS
328                 CFLAGS_seagate.o =   -DARBITRATE -DPARITY -DSEAGATE_USE_ASM
329
330         These three lines specify compilation flags for aha152x.o,
331         gdth.o, and seagate.o
332
333         $(AFLAGS_$@) is a similar feature for source files in assembly
334         languages.
335
336         Example:
337                 # arch/arm/kernel/Makefile
338                 AFLAGS_head-armv.o := -DTEXTADDR=$(TEXTADDR) -traditional
339                 AFLAGS_head-armo.o := -DTEXTADDR=$(TEXTADDR) -traditional
340
341 --- 3.9 Dependency tracking
342
343         Kbuild tracks dependencies on the following:
344         1) All prerequisite files (both *.c and *.h)
345         2) CONFIG_ options used in all prerequisite files
346         3) Command-line used to compile target
347
348         Thus, if you change an option to $(CC) all affected files will
349         be re-compiled.
350
351 --- 3.10 Special Rules
352
353         Special rules are used when the kbuild infrastructure does
354         not provide the required support. A typical example is
355         header files generated during the build process.
356         Another example is the architecture specific Makefiles which
357         needs special rules to prepare boot images etc.
358
359         Special rules are written as normal Make rules.
360         Kbuild is not executing in the directory where the Makefile is
361         located, so all special rules shall provide a relative
362         path to prerequisite files and target files.
363
364         Two variables are used when defining special rules:
365
366     $(src)
367         $(src) is a relative path which points to the directory
368         where the Makefile is located. Always use $(src) when
369         referring to files located in the src tree.
370
371     $(obj)
372         $(obj) is a relative path which points to the directory
373         where the target is saved. Always use $(obj) when
374         referring to generated files.
375
376         Example:
377                 #drivers/scsi/Makefile
378                 $(obj)/53c8xx_d.h: $(src)/53c7,8xx.scr $(src)/script_asm.pl
379                         $(CPP) -DCHIP=810 - < $< | ... $(src)/script_asm.pl
380
381         This is a special rule, following the normal syntax
382         required by make.
383         The target file depends on two prerequisite files. References
384         to the target file are prefixed with $(obj), references
385         to prerequisites are referenced with $(src) (because they are not
386         generated files).
387
388 --- 3.11 $(CC) support functions
389
390         The kernel may be build with several different versions of
391         $(CC), each supporting a unique set of features and options.
392         kbuild provide basic support to check for valid options for $(CC).
393         $(CC) is useally the gcc compiler, but other alternatives are
394         available.
395
396     as-option
397         as-option is used to check if $(CC) when used to compile
398         assembler (*.S) files supports the given option. An optional
399         second option may be specified if first option are not supported.
400
401         Example:
402                 #arch/sh/Makefile
403                 cflags-y += $(call as-option,-Wa$(comma)-isa=$(isa-y),)
404
405         In the above example cflags-y will be assinged the the option
406         -Wa$(comma)-isa=$(isa-y) if it is supported by $(CC).
407         The second argument is optional, and if supplied will be used
408         if first argument is not supported.
409
410     ld-option
411         ld-option is used to check if $(CC) when used to link object files
412         supports the given option.  An optional second option may be
413         specified if first option are not supported.
414
415         Example:
416                 #arch/i386/kernel/Makefile
417                 vsyscall-flags += $(call ld-option, -Wl$(comma)--hash-style=sysv)
418
419         In the above example vsyscall-flags will be assigned the option
420         -Wl$(comma)--hash-style=sysv if it is supported by $(CC).
421         The second argument is optional, and if supplied will be used
422         if first argument is not supported.
423
424     cc-option
425         cc-option is used to check if $(CC) support a given option, and not
426         supported to use an optional second option.
427
428         Example:
429                 #arch/i386/Makefile
430                 cflags-y += $(call cc-option,-march=pentium-mmx,-march=i586)
431
432         In the above example cflags-y will be assigned the option
433         -march=pentium-mmx if supported by $(CC), otherwise -march-i586.
434         The second argument to cc-option is optional, and if omitted
435         cflags-y will be assigned no value if first option is not supported.
436
437    cc-option-yn
438         cc-option-yn is used to check if gcc supports a given option
439         and return 'y' if supported, otherwise 'n'.
440
441         Example:
442                 #arch/ppc/Makefile
443                 biarch := $(call cc-option-yn, -m32)
444                 aflags-$(biarch) += -a32
445                 cflags-$(biarch) += -m32
446         
447         In the above example $(biarch) is set to y if $(CC) supports the -m32
448         option. When $(biarch) equals to y the expanded variables $(aflags-y)
449         and $(cflags-y) will be assigned the values -a32 and -m32.
450
451     cc-option-align
452         gcc version >= 3.0 shifted type of options used to speify
453         alignment of functions, loops etc. $(cc-option-align) whrn used
454         as prefix to the align options will select the right prefix:
455         gcc < 3.00
456                 cc-option-align = -malign
457         gcc >= 3.00
458                 cc-option-align = -falign
459         
460         Example:
461                 CFLAGS += $(cc-option-align)-functions=4
462
463         In the above example the option -falign-functions=4 is used for
464         gcc >= 3.00. For gcc < 3.00 -malign-functions=4 is used.
465         
466     cc-version
467         cc-version return a numerical version of the $(CC) compiler version.
468         The format is <major><minor> where both are two digits. So for example
469         gcc 3.41 would return 0341.
470         cc-version is useful when a specific $(CC) version is faulty in one
471         area, for example the -mregparm=3 were broken in some gcc version
472         even though the option was accepted by gcc.
473
474         Example:
475                 #arch/i386/Makefile
476                 cflags-y += $(shell \
477                 if [ $(call cc-version) -ge 0300 ] ; then \
478                         echo "-mregparm=3"; fi ;)
479
480         In the above example -mregparm=3 is only used for gcc version greater
481         than or equal to gcc 3.0.
482
483     cc-ifversion
484         cc-ifversion test the version of $(CC) and equals last argument if
485         version expression is true.
486
487         Example:
488                 #fs/reiserfs/Makefile
489                 EXTRA_CFLAGS := $(call cc-ifversion, -lt, 0402, -O1)
490
491         In this example EXTRA_CFLAGS will be assigned the value -O1 if the
492         $(CC) version is less than 4.2.
493         cc-ifversion takes all the shell operators: 
494         -eq, -ne, -lt, -le, -gt, and -ge
495         The third parameter may be a text as in this example, but it may also
496         be an expanded variable or a macro.
497
498
499 === 4 Host Program support
500
501 Kbuild supports building executables on the host for use during the
502 compilation stage.
503 Two steps are required in order to use a host executable.
504
505 The first step is to tell kbuild that a host program exists. This is
506 done utilising the variable hostprogs-y.
507
508 The second step is to add an explicit dependency to the executable.
509 This can be done in two ways. Either add the dependency in a rule, 
510 or utilise the variable $(always).
511 Both possibilities are described in the following.
512
513 --- 4.1 Simple Host Program
514
515         In some cases there is a need to compile and run a program on the
516         computer where the build is running.
517         The following line tells kbuild that the program bin2hex shall be
518         built on the build host.
519
520         Example:
521                 hostprogs-y := bin2hex
522
523         Kbuild assumes in the above example that bin2hex is made from a single
524         c-source file named bin2hex.c located in the same directory as
525         the Makefile.
526   
527 --- 4.2 Composite Host Programs
528
529         Host programs can be made up based on composite objects.
530         The syntax used to define composite objects for host programs is
531         similar to the syntax used for kernel objects.
532         $(<executeable>-objs) list all objects used to link the final
533         executable.
534
535         Example:
536                 #scripts/lxdialog/Makefile
537                 hostprogs-y   := lxdialog  
538                 lxdialog-objs := checklist.o lxdialog.o
539
540         Objects with extension .o are compiled from the corresponding .c
541         files. In the above example checklist.c is compiled to checklist.o
542         and lxdialog.c is compiled to lxdialog.o.
543         Finally the two .o files are linked to the executable, lxdialog.
544         Note: The syntax <executable>-y is not permitted for host-programs.
545
546 --- 4.3 Defining shared libraries  
547   
548         Objects with extension .so are considered shared libraries, and
549         will be compiled as position independent objects.
550         Kbuild provides support for shared libraries, but the usage
551         shall be restricted.
552         In the following example the libkconfig.so shared library is used
553         to link the executable conf.
554
555         Example:
556                 #scripts/kconfig/Makefile
557                 hostprogs-y     := conf
558                 conf-objs       := conf.o libkconfig.so
559                 libkconfig-objs := expr.o type.o
560   
561         Shared libraries always require a corresponding -objs line, and
562         in the example above the shared library libkconfig is composed by
563         the two objects expr.o and type.o.
564         expr.o and type.o will be built as position independent code and
565         linked as a shared library libkconfig.so. C++ is not supported for
566         shared libraries.
567
568 --- 4.4 Using C++ for host programs
569
570         kbuild offers support for host programs written in C++. This was
571         introduced solely to support kconfig, and is not recommended
572         for general use.
573
574         Example:
575                 #scripts/kconfig/Makefile
576                 hostprogs-y   := qconf
577                 qconf-cxxobjs := qconf.o
578
579         In the example above the executable is composed of the C++ file
580         qconf.cc - identified by $(qconf-cxxobjs).
581         
582         If qconf is composed by a mixture of .c and .cc files, then an
583         additional line can be used to identify this.
584
585         Example:
586                 #scripts/kconfig/Makefile
587                 hostprogs-y   := qconf
588                 qconf-cxxobjs := qconf.o
589                 qconf-objs    := check.o
590         
591 --- 4.5 Controlling compiler options for host programs
592
593         When compiling host programs, it is possible to set specific flags.
594         The programs will always be compiled utilising $(HOSTCC) passed
595         the options specified in $(HOSTCFLAGS).
596         To set flags that will take effect for all host programs created
597         in that Makefile use the variable HOST_EXTRACFLAGS.
598
599         Example:
600                 #scripts/lxdialog/Makefile
601                 HOST_EXTRACFLAGS += -I/usr/include/ncurses
602   
603         To set specific flags for a single file the following construction
604         is used:
605
606         Example:
607                 #arch/ppc64/boot/Makefile
608                 HOSTCFLAGS_piggyback.o := -DKERNELBASE=$(KERNELBASE)
609   
610         It is also possible to specify additional options to the linker.
611   
612         Example:
613                 #scripts/kconfig/Makefile
614                 HOSTLOADLIBES_qconf := -L$(QTDIR)/lib
615
616         When linking qconf it will be passed the extra option "-L$(QTDIR)/lib".
617  
618 --- 4.6 When host programs are actually built
619
620         Kbuild will only build host-programs when they are referenced
621         as a prerequisite.
622         This is possible in two ways:
623
624         (1) List the prerequisite explicitly in a special rule.
625
626         Example:
627                 #drivers/pci/Makefile
628                 hostprogs-y := gen-devlist
629                 $(obj)/devlist.h: $(src)/pci.ids $(obj)/gen-devlist
630                         ( cd $(obj); ./gen-devlist ) < $<
631
632         The target $(obj)/devlist.h will not be built before 
633         $(obj)/gen-devlist is updated. Note that references to
634         the host programs in special rules must be prefixed with $(obj).
635
636         (2) Use $(always)
637         When there is no suitable special rule, and the host program
638         shall be built when a makefile is entered, the $(always)
639         variable shall be used.
640
641         Example:
642                 #scripts/lxdialog/Makefile
643                 hostprogs-y   := lxdialog
644                 always        := $(hostprogs-y)
645
646         This will tell kbuild to build lxdialog even if not referenced in
647         any rule.
648
649 --- 4.7 Using hostprogs-$(CONFIG_FOO)
650
651         A typcal pattern in a Kbuild file lok like this:
652
653         Example:
654                 #scripts/Makefile
655                 hostprogs-$(CONFIG_KALLSYMS) += kallsyms
656
657         Kbuild knows about both 'y' for built-in and 'm' for module.
658         So if a config symbol evaluate to 'm', kbuild will still build
659         the binary. In other words Kbuild handle hostprogs-m exactly
660         like hostprogs-y. But only hostprogs-y is recommend used
661         when no CONFIG symbol are involved.
662
663 === 5 Kbuild clean infrastructure
664
665 "make clean" deletes most generated files in the src tree where the kernel
666 is compiled. This includes generated files such as host programs.
667 Kbuild knows targets listed in $(hostprogs-y), $(hostprogs-m), $(always),
668 $(extra-y) and $(targets). They are all deleted during "make clean".
669 Files matching the patterns "*.[oas]", "*.ko", plus some additional files
670 generated by kbuild are deleted all over the kernel src tree when
671 "make clean" is executed.
672
673 Additional files can be specified in kbuild makefiles by use of $(clean-files).
674
675         Example:
676                 #drivers/pci/Makefile
677                 clean-files := devlist.h classlist.h
678
679 When executing "make clean", the two files "devlist.h classlist.h" will
680 be deleted. Kbuild will assume files to be in same relative directory as the
681 Makefile except if an absolute path is specified (path starting with '/').
682
683 To delete a directory hirachy use:
684         Example:
685                 #scripts/package/Makefile
686                 clean-dirs := $(objtree)/debian/
687
688 This will delete the directory debian, including all subdirectories.
689 Kbuild will assume the directories to be in the same relative path as the
690 Makefile if no absolute path is specified (path does not start with '/').
691
692 Usually kbuild descends down in subdirectories due to "obj-* := dir/",
693 but in the architecture makefiles where the kbuild infrastructure
694 is not sufficient this sometimes needs to be explicit.
695
696         Example:
697                 #arch/i386/boot/Makefile
698                 subdir- := compressed/
699
700 The above assignment instructs kbuild to descend down in the
701 directory compressed/ when "make clean" is executed.
702
703 To support the clean infrastructure in the Makefiles that builds the
704 final bootimage there is an optional target named archclean:
705
706         Example:
707                 #arch/i386/Makefile
708                 archclean:
709                         $(Q)$(MAKE) $(clean)=arch/i386/boot
710
711 When "make clean" is executed, make will descend down in arch/i386/boot,
712 and clean as usual. The Makefile located in arch/i386/boot/ may use
713 the subdir- trick to descend further down.
714
715 Note 1: arch/$(ARCH)/Makefile cannot use "subdir-", because that file is
716 included in the top level makefile, and the kbuild infrastructure
717 is not operational at that point.
718
719 Note 2: All directories listed in core-y, libs-y, drivers-y and net-y will
720 be visited during "make clean".
721
722 === 6 Architecture Makefiles
723
724 The top level Makefile sets up the environment and does the preparation,
725 before starting to descend down in the individual directories.
726 The top level makefile contains the generic part, whereas the
727 arch/$(ARCH)/Makefile contains what is required to set-up kbuild
728 to the said architecture.
729 To do so arch/$(ARCH)/Makefile sets a number of variables, and defines
730 a few targets.
731
732 When kbuild executes the following steps are followed (roughly):
733 1) Configuration of the kernel => produced .config
734 2) Store kernel version in include/linux/version.h
735 3) Symlink include/asm to include/asm-$(ARCH)
736 4) Updating all other prerequisites to the target prepare:
737    - Additional prerequisites are specified in arch/$(ARCH)/Makefile
738 5) Recursively descend down in all directories listed in
739    init-* core* drivers-* net-* libs-* and build all targets.
740    - The value of the above variables are extended in arch/$(ARCH)/Makefile.
741 6) All object files are then linked and the resulting file vmlinux is 
742    located at the root of the src tree.
743    The very first objects linked are listed in head-y, assigned by
744    arch/$(ARCH)/Makefile.
745 7) Finally the architecture specific part does any required post processing
746    and builds the final bootimage.
747    - This includes building boot records
748    - Preparing initrd images and the like
749
750
751 --- 6.1 Set variables to tweak the build to the architecture
752
753     LDFLAGS             Generic $(LD) options
754
755         Flags used for all invocations of the linker.
756         Often specifying the emulation is sufficient.
757
758         Example:
759                 #arch/s390/Makefile
760                 LDFLAGS         := -m elf_s390
761         Note: EXTRA_LDFLAGS and LDFLAGS_$@ can be used to further customise
762         the flags used. See chapter 7.
763         
764     LDFLAGS_MODULE      Options for $(LD) when linking modules
765
766         LDFLAGS_MODULE is used to set specific flags for $(LD) when
767         linking the .ko files used for modules.
768         Default is "-r", for relocatable output.
769
770     LDFLAGS_vmlinux     Options for $(LD) when linking vmlinux
771
772         LDFLAGS_vmlinux is used to specify additional flags to pass to
773         the linker when linking the final vmlinux.
774         LDFLAGS_vmlinux uses the LDFLAGS_$@ support.
775
776         Example:
777                 #arch/i386/Makefile
778                 LDFLAGS_vmlinux := -e stext
779
780     OBJCOPYFLAGS        objcopy flags
781
782         When $(call if_changed,objcopy) is used to translate a .o file,
783         then the flags specified in OBJCOPYFLAGS will be used.
784         $(call if_changed,objcopy) is often used to generate raw binaries on
785         vmlinux.
786
787         Example:
788                 #arch/s390/Makefile
789                 OBJCOPYFLAGS := -O binary
790
791                 #arch/s390/boot/Makefile
792                 $(obj)/image: vmlinux FORCE
793                         $(call if_changed,objcopy)
794
795         In this example the binary $(obj)/image is a binary version of
796         vmlinux. The usage of $(call if_changed,xxx) will be described later.
797
798     AFLAGS              $(AS) assembler flags
799
800         Default value - see top level Makefile
801         Append or modify as required per architecture.
802
803         Example:
804                 #arch/sparc64/Makefile
805                 AFLAGS += -m64 -mcpu=ultrasparc
806
807     CFLAGS              $(CC) compiler flags
808
809         Default value - see top level Makefile
810         Append or modify as required per architecture.
811
812         Often the CFLAGS variable depends on the configuration.
813
814         Example:
815                 #arch/i386/Makefile
816                 cflags-$(CONFIG_M386) += -march=i386
817                 CFLAGS += $(cflags-y)
818
819         Many arch Makefiles dynamically run the target C compiler to
820         probe supported options:
821
822                 #arch/i386/Makefile
823
824                 ...
825                 cflags-$(CONFIG_MPENTIUMII)     += $(call cc-option,\
826                                                 -march=pentium2,-march=i686)
827                 ...
828                 # Disable unit-at-a-time mode ...
829                 CFLAGS += $(call cc-option,-fno-unit-at-a-time)
830                 ...
831
832
833         The first examples utilises the trick that a config option expands
834         to 'y' when selected.
835
836     CFLAGS_KERNEL       $(CC) options specific for built-in
837
838         $(CFLAGS_KERNEL) contains extra C compiler flags used to compile
839         resident kernel code.
840
841     CFLAGS_MODULE       $(CC) options specific for modules
842
843         $(CFLAGS_MODULE) contains extra C compiler flags used to compile code
844         for loadable kernel modules.
845
846  
847 --- 6.2 Add prerequisites to archprepare:
848
849         The archprepare: rule is used to list prerequisites that needs to be
850         built before starting to descend down in the subdirectories.
851         This is usual header files containing assembler constants.
852
853                 Example:
854                 #arch/arm/Makefile
855                 archprepare: maketools
856
857         In this example the file target maketools will be processed
858         before descending down in the subdirectories.
859         See also chapter XXX-TODO that describe how kbuild supports
860         generating offset header files.
861
862
863 --- 6.3 List directories to visit when descending
864
865         An arch Makefile cooperates with the top Makefile to define variables
866         which specify how to build the vmlinux file.  Note that there is no
867         corresponding arch-specific section for modules; the module-building
868         machinery is all architecture-independent.
869
870         
871     head-y, init-y, core-y, libs-y, drivers-y, net-y
872
873         $(head-y) list objects to be linked first in vmlinux.
874         $(libs-y) list directories where a lib.a archive can be located.
875         The rest list directories where a built-in.o object file can be located.
876
877         $(init-y) objects will be located after $(head-y).
878         Then the rest follows in this order:
879         $(core-y), $(libs-y), $(drivers-y) and $(net-y).
880
881         The top level Makefile define values for all generic directories,
882         and arch/$(ARCH)/Makefile only adds architecture specific directories.
883
884         Example:
885                 #arch/sparc64/Makefile
886                 core-y += arch/sparc64/kernel/
887                 libs-y += arch/sparc64/prom/ arch/sparc64/lib/
888                 drivers-$(CONFIG_OPROFILE)  += arch/sparc64/oprofile/
889
890
891 --- 6.4 Architecture specific boot images
892
893         An arch Makefile specifies goals that take the vmlinux file, compress
894         it, wrap it in bootstrapping code, and copy the resulting files
895         somewhere. This includes various kinds of installation commands.
896         The actual goals are not standardized across architectures.
897
898         It is common to locate any additional processing in a boot/
899         directory below arch/$(ARCH)/.
900
901         Kbuild does not provide any smart way to support building a
902         target specified in boot/. Therefore arch/$(ARCH)/Makefile shall
903         call make manually to build a target in boot/.
904
905         The recommended approach is to include shortcuts in
906         arch/$(ARCH)/Makefile, and use the full path when calling down
907         into the arch/$(ARCH)/boot/Makefile.
908
909         Example:
910                 #arch/i386/Makefile
911                 boot := arch/i386/boot
912                 bzImage: vmlinux
913                         $(Q)$(MAKE) $(build)=$(boot) $(boot)/$@
914
915         "$(Q)$(MAKE) $(build)=<dir>" is the recommended way to invoke
916         make in a subdirectory.
917
918         There are no rules for naming of the architecture specific targets,
919         but executing "make help" will list all relevant targets.
920         To support this $(archhelp) must be defined.
921
922         Example:
923                 #arch/i386/Makefile
924                 define archhelp
925                   echo  '* bzImage      - Image (arch/$(ARCH)/boot/bzImage)'
926                 endef
927
928         When make is executed without arguments, the first goal encountered
929         will be built. In the top level Makefile the first goal present
930         is all:.
931         An architecture shall always per default build a bootable image.
932         In "make help" the default goal is highlighted with a '*'.
933         Add a new prerequisite to all: to select a default goal different
934         from vmlinux.
935
936         Example:
937                 #arch/i386/Makefile
938                 all: bzImage 
939
940         When "make" is executed without arguments, bzImage will be built.
941
942 --- 6.5 Building non-kbuild targets
943
944     extra-y
945
946         extra-y specify additional targets created in the current
947         directory, in addition to any targets specified by obj-*.
948
949         Listing all targets in extra-y is required for two purposes:
950         1) Enable kbuild to check changes in command lines
951            - When $(call if_changed,xxx) is used
952         2) kbuild knows what files to delete during "make clean"
953
954         Example:
955                 #arch/i386/kernel/Makefile
956                 extra-y := head.o init_task.o
957
958         In this example extra-y is used to list object files that
959         shall be built, but shall not be linked as part of built-in.o.
960
961         
962 --- 6.6 Commands useful for building a boot image
963
964         Kbuild provides a few macros that are useful when building a
965         boot image.
966
967     if_changed
968
969         if_changed is the infrastructure used for the following commands.
970
971         Usage:
972                 target: source(s) FORCE
973                         $(call if_changed,ld/objcopy/gzip)
974
975         When the rule is evaluated it is checked to see if any files
976         needs an update, or the commandline has changed since last
977         invocation. The latter will force a rebuild if any options
978         to the executable have changed.
979         Any target that utilises if_changed must be listed in $(targets),
980         otherwise the command line check will fail, and the target will
981         always be built.
982         Assignments to $(targets) are without $(obj)/ prefix.
983         if_changed may be used in conjunction with custom commands as
984         defined in 6.7 "Custom kbuild commands".
985
986         Note: It is a typical mistake to forget the FORCE prerequisite.
987         Another common pitfall is that whitespace is sometimes
988         significant; for instance, the below will fail (note the extra space
989         after the comma):
990                 target: source(s) FORCE
991         #WRONG!#        $(call if_changed, ld/objcopy/gzip)
992
993     ld
994         Link target. Often LDFLAGS_$@ is used to set specific options to ld.
995         
996     objcopy
997         Copy binary. Uses OBJCOPYFLAGS usually specified in
998         arch/$(ARCH)/Makefile.
999         OBJCOPYFLAGS_$@ may be used to set additional options.
1000
1001     gzip
1002         Compress target. Use maximum compression to compress target.
1003
1004         Example:
1005                 #arch/i386/boot/Makefile
1006                 LDFLAGS_bootsect := -Ttext 0x0 -s --oformat binary
1007                 LDFLAGS_setup    := -Ttext 0x0 -s --oformat binary -e begtext
1008
1009                 targets += setup setup.o bootsect bootsect.o
1010                 $(obj)/setup $(obj)/bootsect: %: %.o FORCE
1011                         $(call if_changed,ld)
1012
1013         In this example there are two possible targets, requiring different
1014         options to the linker. the linker options are specified using the
1015         LDFLAGS_$@ syntax - one for each potential target.
1016         $(targets) are assinged all potential targets, herby kbuild knows
1017         the targets and will:
1018                 1) check for commandline changes
1019                 2) delete target during make clean
1020
1021         The ": %: %.o" part of the prerequisite is a shorthand that
1022         free us from listing the setup.o and bootsect.o files.
1023         Note: It is a common mistake to forget the "target :=" assignment,
1024               resulting in the target file being recompiled for no
1025               obvious reason.
1026
1027
1028 --- 6.7 Custom kbuild commands
1029
1030         When kbuild is executing with KBUILD_VERBOSE=0 then only a shorthand
1031         of a command is normally displayed.
1032         To enable this behaviour for custom commands kbuild requires
1033         two variables to be set:
1034         quiet_cmd_<command>     - what shall be echoed
1035               cmd_<command>     - the command to execute
1036
1037         Example:
1038                 #
1039                 quiet_cmd_image = BUILD   $@
1040                       cmd_image = $(obj)/tools/build $(BUILDFLAGS) \
1041                                                      $(obj)/vmlinux.bin > $@
1042
1043                 targets += bzImage
1044                 $(obj)/bzImage: $(obj)/vmlinux.bin $(obj)/tools/build FORCE
1045                         $(call if_changed,image)
1046                         @echo 'Kernel: $@ is ready'
1047
1048         When updating the $(obj)/bzImage target the line:
1049
1050         BUILD    arch/i386/boot/bzImage
1051
1052         will be displayed with "make KBUILD_VERBOSE=0".
1053         
1054
1055 --- 6.8 Preprocessing linker scripts
1056
1057         When the vmlinux image is build the linker script:
1058         arch/$(ARCH)/kernel/vmlinux.lds is used.
1059         The script is a preprocessed variant of the file vmlinux.lds.S
1060         located in the same directory.
1061         kbuild knows .lds file and includes a rule *lds.S -> *lds.
1062         
1063         Example:
1064                 #arch/i386/kernel/Makefile
1065                 always := vmlinux.lds
1066         
1067                 #Makefile
1068                 export CPPFLAGS_vmlinux.lds += -P -C -U$(ARCH)
1069                 
1070         The assigment to $(always) is used to tell kbuild to build the
1071         target: vmlinux.lds.
1072         The assignment to $(CPPFLAGS_vmlinux.lds) tell kbuild to use the
1073         specified options when building the target vmlinux.lds.
1074         
1075         When building the *.lds target kbuild used the variakles:
1076         CPPFLAGS        : Set in top-level Makefile
1077         EXTRA_CPPFLAGS  : May be set in the kbuild makefile
1078         CPPFLAGS_$(@F)  : Target specific flags.
1079                           Note that the full filename is used in this
1080                           assignment.
1081
1082         The kbuild infrastructure for *lds file are used in several
1083         architecture specific files.
1084
1085
1086 === 7 Kbuild Variables
1087
1088 The top Makefile exports the following variables:
1089
1090     VERSION, PATCHLEVEL, SUBLEVEL, EXTRAVERSION
1091
1092         These variables define the current kernel version.  A few arch
1093         Makefiles actually use these values directly; they should use
1094         $(KERNELRELEASE) instead.
1095
1096         $(VERSION), $(PATCHLEVEL), and $(SUBLEVEL) define the basic
1097         three-part version number, such as "2", "4", and "0".  These three
1098         values are always numeric.
1099
1100         $(EXTRAVERSION) defines an even tinier sublevel for pre-patches
1101         or additional patches.  It is usually some non-numeric string
1102         such as "-pre4", and is often blank.
1103
1104     KERNELRELEASE
1105
1106         $(KERNELRELEASE) is a single string such as "2.4.0-pre4", suitable
1107         for constructing installation directory names or showing in
1108         version strings.  Some arch Makefiles use it for this purpose.
1109
1110     ARCH
1111
1112         This variable defines the target architecture, such as "i386",
1113         "arm", or "sparc". Some kbuild Makefiles test $(ARCH) to
1114         determine which files to compile.
1115
1116         By default, the top Makefile sets $(ARCH) to be the same as the
1117         host system architecture.  For a cross build, a user may
1118         override the value of $(ARCH) on the command line:
1119
1120             make ARCH=m68k ...
1121
1122
1123     INSTALL_PATH
1124
1125         This variable defines a place for the arch Makefiles to install
1126         the resident kernel image and System.map file.
1127         Use this for architecture specific install targets.
1128
1129     INSTALL_MOD_PATH, MODLIB
1130
1131         $(INSTALL_MOD_PATH) specifies a prefix to $(MODLIB) for module
1132         installation.  This variable is not defined in the Makefile but
1133         may be passed in by the user if desired.
1134
1135         $(MODLIB) specifies the directory for module installation.
1136         The top Makefile defines $(MODLIB) to
1137         $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE).  The user may
1138         override this value on the command line if desired.
1139
1140     INSTALL_MOD_STRIP
1141
1142         If this variable is specified, will cause modules to be stripped
1143         after they are installed.  If INSTALL_MOD_STRIP is '1', then the
1144         default option --strip-debug will be used.  Otherwise,
1145         INSTALL_MOD_STRIP will used as the option(s) to the strip command.
1146
1147
1148 === 8 Makefile language
1149
1150 The kernel Makefiles are designed to run with GNU Make.  The Makefiles
1151 use only the documented features of GNU Make, but they do use many
1152 GNU extensions.
1153
1154 GNU Make supports elementary list-processing functions.  The kernel
1155 Makefiles use a novel style of list building and manipulation with few
1156 "if" statements.
1157
1158 GNU Make has two assignment operators, ":=" and "=".  ":=" performs
1159 immediate evaluation of the right-hand side and stores an actual string
1160 into the left-hand side.  "=" is like a formula definition; it stores the
1161 right-hand side in an unevaluated form and then evaluates this form each
1162 time the left-hand side is used.
1163
1164 There are some cases where "=" is appropriate.  Usually, though, ":="
1165 is the right choice.
1166
1167 === 9 Credits
1168
1169 Original version made by Michael Elizabeth Chastain, <mailto:mec@shout.net>
1170 Updates by Kai Germaschewski <kai@tp1.ruhr-uni-bochum.de>
1171 Updates by Sam Ravnborg <sam@ravnborg.org>
1172
1173 === 10 TODO
1174
1175 - Describe how kbuild support shipped files with _shipped.
1176 - Generating offset header files.
1177 - Add more variables to section 7?
1178