kgdb: document parameters
[linux-2.6] / scripts / Makefile.modpost
1 # ===========================================================================
2 # Module versions
3 # ===========================================================================
4 #
5 # Stage one of module building created the following:
6 # a) The individual .o files used for the module
7 # b) A <module>.o file which is the .o files above linked together
8 # c) A <module>.mod file in $(MODVERDIR)/, listing the name of the
9 #    the preliminary <module>.o file, plus all .o files
10
11 # Stage 2 is handled by this file and does the following
12 # 1) Find all modules from the files listed in $(MODVERDIR)/
13 # 2) modpost is then used to
14 # 3)  create one <module>.mod.c file pr. module
15 # 4)  create one Module.symvers file with CRC for all exported symbols
16 # 4a) [CONFIG_MARKERS] create one Module.markers file listing defined markers
17 # 5) compile all <module>.mod.c files
18 # 6) final link of the module to a <module.ko> file
19
20 # Step 3 is used to place certain information in the module's ELF
21 # section, including information such as:
22 #   Version magic (see include/vermagic.h for full details)
23 #     - Kernel release
24 #     - SMP is CONFIG_SMP
25 #     - PREEMPT is CONFIG_PREEMPT
26 #     - GCC Version
27 #   Module info
28 #     - Module version (MODULE_VERSION)
29 #     - Module alias'es (MODULE_ALIAS)
30 #     - Module license (MODULE_LICENSE)
31 #     - See include/linux/module.h for more details
32
33 # Step 4 is solely used to allow module versioning in external modules,
34 # where the CRC of each module is retrieved from the Module.symers file.
35
36 # KBUILD_MODPOST_WARN can be set to avoid error out in case of undefined
37 # symbols in the final module linking stage
38 # KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
39 # This is solely usefull to speed up test compiles
40 PHONY := _modpost
41 _modpost: __modpost
42
43 include include/config/auto.conf
44 include scripts/Kbuild.include
45 include scripts/Makefile.lib
46
47 kernelsymfile := $(objtree)/Module.symvers
48 modulesymfile := $(firstword $(KBUILD_EXTMOD))/Module.symvers
49 kernelmarkersfile := $(objtree)/Module.markers
50 modulemarkersfile := $(firstword $(KBUILD_EXTMOD))/Module.markers
51
52 markersfile = $(if $(KBUILD_EXTMOD),$(modulemarkersfile),$(kernelmarkersfile))
53
54 # Step 1), find all modules listed in $(MODVERDIR)/
55 __modules := $(sort $(shell grep -h '\.ko' /dev/null $(wildcard $(MODVERDIR)/*.mod)))
56 modules   := $(patsubst %.o,%.ko, $(wildcard $(__modules:.ko=.o)))
57
58 # Stop after building .o files if NOFINAL is set. Makes compile tests quicker
59 _modpost: $(if $(KBUILD_MODPOST_NOFINAL), $(modules:.ko:.o),$(modules))
60
61 ifneq ($(KBUILD_BUILDHOST),$(ARCH))
62         cross_build := 1
63 endif
64
65 # Step 2), invoke modpost
66 #  Includes step 3,4
67 modpost = scripts/mod/modpost                    \
68  $(if $(CONFIG_MODVERSIONS),-m)                  \
69  $(if $(CONFIG_MODULE_SRCVERSION_ALL),-a,)       \
70  $(if $(KBUILD_EXTMOD),-i,-o) $(kernelsymfile)   \
71  $(if $(KBUILD_EXTMOD),-I $(modulesymfile))      \
72  $(if $(KBUILD_EXTMOD),-o $(modulesymfile))      \
73  $(if $(CONFIG_DEBUG_SECTION_MISMATCH),,-S)      \
74  $(if $(CONFIG_MARKERS),-K $(kernelmarkersfile)) \
75  $(if $(CONFIG_MARKERS),-M $(markersfile))       \
76  $(if $(KBUILD_EXTMOD)$(KBUILD_MODPOST_WARN),-w) \
77  $(if $(cross_build),-c)
78
79 quiet_cmd_modpost = MODPOST $(words $(filter-out vmlinux FORCE, $^)) modules
80       cmd_modpost = $(modpost) -s
81
82 PHONY += __modpost
83 __modpost: $(modules:.ko=.o) FORCE
84         $(call cmd,modpost) $(wildcard vmlinux) $(filter-out FORCE,$^)
85
86 quiet_cmd_kernel-mod = MODPOST $@
87       cmd_kernel-mod = $(modpost) $@
88
89 vmlinux.o: FORCE
90         $(call cmd,kernel-mod)
91
92 # Declare generated files as targets for modpost
93 $(symverfile):         __modpost ;
94 $(modules:.ko=.mod.c): __modpost ;
95
96 ifdef CONFIG_MARKERS
97 $(markersfile):        __modpost ;
98 endif
99
100
101 # Step 5), compile all *.mod.c files
102
103 # modname is set to make c_flags define KBUILD_MODNAME
104 modname = $(notdir $(@:.mod.o=))
105
106 quiet_cmd_cc_o_c = CC      $@
107       cmd_cc_o_c = $(CC) $(c_flags) $(CFLAGS_MODULE)    \
108                    -c -o $@ $<
109
110 $(modules:.ko=.mod.o): %.mod.o: %.mod.c FORCE
111         $(call if_changed_dep,cc_o_c)
112
113 targets += $(modules:.ko=.mod.o)
114
115 # Step 6), final link of the modules
116 quiet_cmd_ld_ko_o = LD [M]  $@
117       cmd_ld_ko_o = $(LD) -r $(LDFLAGS) $(LDFLAGS_MODULE) -o $@         \
118                           $(filter-out FORCE,$^)
119
120 $(modules): %.ko :%.o %.mod.o FORCE
121         $(call if_changed,ld_ko_o)
122
123 targets += $(modules)
124
125
126 # Add FORCE to the prequisites of a target to force it to be always rebuilt.
127 # ---------------------------------------------------------------------------
128
129 PHONY += FORCE
130
131 FORCE:
132
133 # Read all saved command lines and dependencies for the $(targets) we
134 # may be building above, using $(if_changed{,_dep}). As an
135 # optimization, we don't need to read them if the target does not
136 # exist, we will rebuild anyway in that case.
137
138 targets := $(wildcard $(sort $(targets)))
139 cmd_files := $(wildcard $(foreach f,$(targets),$(dir $(f)).$(notdir $(f)).cmd))
140
141 ifneq ($(cmd_files),)
142   include $(cmd_files)
143 endif
144
145
146 # Declare the contents of the .PHONY variable as phony.  We keep that
147 # information in a variable se we can use it in if_changed and friends.
148
149 .PHONY: $(PHONY)