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