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