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