kmod.mk revision 214629 
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: head/sys/conf/kmod.mk 214629 2010-11-01 17:34:04Z jhb $
3#
4# The include file <bsd.kmod.mk> handles building and installing loadable
5# kernel modules.
6#
7#
8# +++ variables +++
9#
10# CLEANFILES	Additional files to remove for the clean and cleandir targets.
11#
12# EXPORT_SYMS	A list of symbols that should be exported from the module,
13#		or the name of a file containing a list of symbols, or YES
14#		to export all symbols.  If not defined, no symbols are
15#		exported.
16#
17# KMOD		The name of the kernel module to build.
18#
19# KMODDIR	Base path for kernel modules (see kld(4)). [/boot/kernel]
20#
21# KMODOWN	Module file owner. [${BINOWN}]
22#
23# KMODGRP	Module file group. [${BINGRP}]
24#
25# KMODMODE	Module file mode. [${BINMODE}]
26#
27# KMODLOAD	Command to load a kernel module [/sbin/kldload]
28#
29# KMODUNLOAD	Command to unload a kernel module [/sbin/kldunload]
30#
31# MFILES	Optionally a list of interfaces used by the module.
32#		This file contains a default list of interfaces.
33#
34# PROG		The name of the kernel module to build.
35#		If not supplied, ${KMOD}.ko is used.
36#
37# SRCS		List of source files.
38#
39# FIRMWS	List of firmware images in format filename:shortname:version
40#
41# FIRMWARE_LICENSE
42#		Set to the name of the license the user has to agree on in
43#		order to use this firmware. See /usr/share/doc/legal
44#
45# DESTDIR	The tree where the module gets installed. [not set]
46#
47# +++ targets +++
48#
49# 	install:
50#               install the kernel module; if the Makefile
51#               does not itself define the target install, the targets
52#               beforeinstall and afterinstall may also be used to cause
53#               actions immediately before and after the install target
54#		is executed.
55#
56# 	load:
57#		Load a module.
58#
59# 	unload:
60#		Unload a module.
61#
62
63# backwards compat option for older systems.
64MACHINE_CPUARCH?=${MACHINE_ARCH:C/mipse[lb]/mips/:C/armeb/arm/:C/powerpc64/powerpc/}
65
66AWK?=		awk
67KMODLOAD?=	/sbin/kldload
68KMODUNLOAD?=	/sbin/kldunload
69OBJCOPY?=	objcopy
70
71.if defined(KMODDEPS)
72.error "Do not use KMODDEPS on 5.0+; use MODULE_VERSION/MODULE_DEPEND"
73.endif
74
75# Enable CTF conversion on request.
76.if defined(WITH_CTF)
77.undef NO_CTF
78.endif
79
80.include <bsd.init.mk>
81
82.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
83
84# amd64 and mips use direct linking for kmod, all others use shared binaries
85.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
86__KLD_SHARED=yes
87.else
88__KLD_SHARED=no
89.endif
90
91.if ${CC:T:Micc} == "icc"
92CFLAGS:=	${CFLAGS:C/(-x[^M^K^W]+)[MKW]+|-x[MKW]+/\1/}
93.else
94. if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
95CFLAGS+=	-fno-strict-aliasing
96. endif
97WERROR?=	-Werror
98.endif
99CFLAGS+=	${WERROR}
100CFLAGS+=	-D_KERNEL
101CFLAGS+=	-DKLD_MODULE
102
103# Don't use any standard or source-relative include directories.
104.if ${CC:T:Micc} == "icc"
105NOSTDINC=	-X
106.else
107CSTD=		c99
108NOSTDINC=	-nostdinc
109.endif
110CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
111.if defined(KERNBUILDDIR)
112CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
113.endif
114
115# Add -I paths for system headers.  Individual module makefiles don't
116# need any -I paths for this.  Similar defaults for .PATH can't be
117# set because there are no standard paths for non-headers.
118CFLAGS+=	-I. -I@
119
120# Add -I path for altq headers as they are included via net/if_var.h
121# for example.
122CFLAGS+=	-I@/contrib/altq
123
124.if ${CC:T:Micc} != "icc" && ${CC:T:Mclang} != "clang"
125CFLAGS+=	-finline-limit=${INLINE_LIMIT}
126CFLAGS+= --param inline-unit-growth=100
127CFLAGS+= --param large-function-growth=1000
128.endif
129
130# Disallow common variables, and if we end up with commons from
131# somewhere unexpected, allocate storage for them in the module itself.
132.if ${CC:T:Micc} != "icc"
133CFLAGS+=	-fno-common
134.endif
135LDFLAGS+=	-d -warn-common
136
137CFLAGS+=	${DEBUG_FLAGS}
138.if ${MACHINE_CPUARCH} == amd64
139CFLAGS+=	-fno-omit-frame-pointer
140.endif
141
142.if ${MACHINE_CPUARCH} == powerpc
143CFLAGS+=	-mlongcall -fno-omit-frame-pointer
144.endif
145
146.if ${MACHINE_CPUARCH} == mips
147CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
148.endif
149
150.if defined(DEBUG) || defined(DEBUG_FLAGS)
151CTFFLAGS+=	-g
152.endif
153
154.if defined(FIRMWS)
155.if !exists(@)
156${KMOD:S/$/.c/}: @
157.else
158${KMOD:S/$/.c/}: @/tools/fw_stub.awk
159.endif
160	${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
161	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
162
163SRCS+=	${KMOD:S/$/.c/}
164CLEANFILES+=	${KMOD:S/$/.c/}
165
166.for _firmw in ${FIRMWS}
167${_firmw:C/\:.*$/.fwo/}:	${_firmw:C/\:.*$//}
168	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
169	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
170		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
171		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
172	else							\
173		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
174		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
175		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
176		rm ${_firmw:C/\:.*$//};				\
177	fi
178
179OBJS+=	${_firmw:C/\:.*$/.fwo/}
180.endfor
181.endif
182
183OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
184
185.if !defined(PROG)
186PROG=	${KMOD}.ko
187.endif
188
189.if !defined(DEBUG_FLAGS)
190FULLPROG=	${PROG}
191.else
192FULLPROG=	${PROG}.debug
193${PROG}: ${FULLPROG} ${PROG}.symbols
194	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
195	    ${FULLPROG} ${.TARGET}
196${PROG}.symbols: ${FULLPROG}
197	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
198.endif
199
200.if ${__KLD_SHARED} == yes
201${FULLPROG}: ${KMOD}.kld
202	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
203.if !defined(DEBUG_FLAGS)
204	${OBJCOPY} --strip-debug ${.TARGET}
205.endif
206.endif
207
208EXPORT_SYMS?=	NO
209.if ${EXPORT_SYMS} != YES
210CLEANFILES+=	export_syms
211.endif
212
213.if ${__KLD_SHARED} == yes
214${KMOD}.kld: ${OBJS}
215.else
216${FULLPROG}: ${OBJS}
217.endif
218	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
219	@[ -z "${CTFMERGE}" -o -n "${NO_CTF}" ] || ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
220.if defined(EXPORT_SYMS)
221.if ${EXPORT_SYMS} != YES
222.if ${EXPORT_SYMS} == NO
223	:> export_syms
224.elif !exists(${.CURDIR}/${EXPORT_SYMS})
225	echo ${EXPORT_SYMS} > export_syms
226.else
227	grep -v '^#' < ${EXPORT_SYMS} > export_syms
228.endif
229	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
230	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
231.endif
232.endif
233.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
234	${OBJCOPY} --strip-debug ${.TARGET}
235.endif
236
237_ILINKS=@ machine
238.if ${MACHINE} != ${MACHINE_CPUARCH}
239_ILINKS+=${MACHINE_CPUARCH}
240.endif
241.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
242_ILINKS+=x86
243.endif
244
245all: objwarn ${PROG}
246
247beforedepend: ${_ILINKS}
248
249# Ensure that the links exist without depending on it when it exists which
250# causes all the modules to be rebuilt when the directory pointed to changes.
251.for _link in ${_ILINKS}
252.if !exists(${.OBJDIR}/${_link})
253${OBJS}: ${_link}
254.endif
255.endfor
256
257# Search for kernel source tree in standard places.
258.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
259.if !defined(SYSDIR) && exists(${_dir}/kern/)
260SYSDIR=	${_dir}
261.endif
262.endfor
263.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
264.error "can't find kernel source tree"
265.endif
266
267${_ILINKS}:
268	@case ${.TARGET} in \
269	machine) \
270		path=${SYSDIR}/${MACHINE}/include ;; \
271	@) \
272		path=${SYSDIR} ;; \
273	*) \
274		path=${SYSDIR}/${.TARGET}/include ;; \
275	esac ; \
276	path=`(cd $$path && /bin/pwd)` ; \
277	${ECHO} ${.TARGET} "->" $$path ; \
278	ln -sf $$path ${.TARGET}
279
280CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
281
282.if defined(DEBUG_FLAGS)
283CLEANFILES+= ${FULLPROG} ${PROG}.symbols
284.endif
285
286.if !target(install)
287
288_INSTALLFLAGS:=	${INSTALLFLAGS}
289.for ie in ${INSTALLFLAGS_EDIT}
290_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
291.endfor
292
293.if !target(realinstall)
294realinstall: _kmodinstall
295.ORDER: beforeinstall _kmodinstall
296_kmodinstall:
297	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
298	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
299.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG)
300	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
301	    ${_INSTALLFLAGS} ${PROG}.symbols ${DESTDIR}${KMODDIR}
302.endif
303
304.include <bsd.links.mk>
305
306.if !defined(NO_XREF)
307afterinstall: _kldxref
308.ORDER: realinstall _kldxref
309.ORDER: _installlinks _kldxref
310_kldxref:
311	@if type kldxref >/dev/null 2>&1; then \
312		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
313		kldxref ${DESTDIR}${KMODDIR}; \
314	fi
315.endif
316.endif # !target(realinstall)
317
318.endif # !target(install)
319
320.if !target(load)
321load: ${PROG}
322	${KMODLOAD} -v ${.OBJDIR}/${PROG}
323.endif
324
325.if !target(unload)
326unload:
327	${KMODUNLOAD} -v ${PROG}
328.endif
329
330.if defined(KERNBUILDDIR)
331.PATH: ${KERNBUILDDIR}
332CFLAGS+=	-I${KERNBUILDDIR}
333.for _src in ${SRCS:Mopt_*.h}
334CLEANFILES+=	${_src}
335.if !target(${_src})
336${_src}:
337	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
338.endif
339.endfor
340.else
341.for _src in ${SRCS:Mopt_*.h}
342CLEANFILES+=	${_src}
343.if !target(${_src})
344${_src}:
345	:> ${.TARGET}
346.endif
347.endfor
348.endif
349
350# Respect configuration-specific C flags.
351CFLAGS+=	${CONF_CFLAGS}
352
353MFILES?= dev/acpica/acpi_if.m dev/acpi_support/acpi_wmi_if.m \
354	dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_if.m \
355	dev/iicbus/iicbb_if.m dev/iicbus/iicbus_if.m \
356	dev/mmc/mmcbr_if.m dev/mmc/mmcbus_if.m \
357	dev/mii/miibus_if.m dev/mvs/mvs_if.m dev/ofw/ofw_bus_if.m \
358	dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
359	dev/pci/pcib_if.m dev/ppbus/ppbus_if.m dev/smbus/smbus_if.m \
360	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
361	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
362	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
363	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
364	kern/bus_if.m kern/clock_if.m \
365	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
366	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
367	pc98/pc98/canbus_if.m
368
369.for _srcsrc in ${MFILES}
370.for _ext in c h
371.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
372CLEANFILES+=	${_src}
373.if !target(${_src})
374.if !exists(@)
375${_src}: @
376.else
377${_src}: @/tools/makeobjops.awk @/${_srcsrc}
378.endif
379	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
380.endif
381.endfor # _src
382.endfor # _ext
383.endfor # _srcsrc
384
385.if !empty(SRCS:Mvnode_if.c)
386CLEANFILES+=	vnode_if.c
387.if !exists(@)
388vnode_if.c: @
389.else
390vnode_if.c: @/tools/vnode_if.awk @/kern/vnode_if.src
391.endif
392	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -c
393.endif
394
395.if !empty(SRCS:Mvnode_if.h)
396CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
397.if !exists(@)
398vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @
399.else
400vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @/tools/vnode_if.awk \
401    @/kern/vnode_if.src
402.endif
403vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
404	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -h
405vnode_if_newproto.h:
406	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -p
407vnode_if_typedef.h:
408	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -q
409.endif
410
411.for _i in mii pccard
412.if !empty(SRCS:M${_i}devs.h)
413CLEANFILES+=	${_i}devs.h
414.if !exists(@)
415${_i}devs.h: @
416.else
417${_i}devs.h: @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
418.endif
419	${AWK} -f @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
420.endif
421.endfor # _i
422
423.if !empty(SRCS:Musbdevs.h)
424CLEANFILES+=	usbdevs.h
425.if !exists(@)
426usbdevs.h: @
427.else
428usbdevs.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
429.endif
430	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -h
431.endif
432
433.if !empty(SRCS:Musbdevs_data.h)
434CLEANFILES+=	usbdevs_data.h
435.if !exists(@)
436usbdevs_data.h: @
437.else
438usbdevs_data.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
439.endif
440	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -d
441.endif
442
443.if !empty(SRCS:Macpi_quirks.h)
444CLEANFILES+=	acpi_quirks.h
445.if !exists(@)
446acpi_quirks.h: @
447.else
448acpi_quirks.h: @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
449.endif
450	${AWK} -f @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
451.endif
452
453.if !empty(SRCS:Massym.s)
454CLEANFILES+=	assym.s genassym.o
455assym.s: genassym.o
456.if defined(KERNBUILDDIR)
457genassym.o: opt_global.h
458.endif
459.if !exists(@)
460assym.s: @
461.else
462assym.s: @/kern/genassym.sh
463.endif
464	sh @/kern/genassym.sh genassym.o > ${.TARGET}
465.if exists(@)
466genassym.o: @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
467.endif
468genassym.o: @ machine ${SRCS:Mopt_*.h}
469	${CC} -c ${CFLAGS:N-fno-common} \
470	    @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
471.endif
472
473lint: ${SRCS}
474	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
475
476.if defined(KERNBUILDDIR)
477${OBJS}: opt_global.h
478.endif
479
480.include <bsd.dep.mk>
481
482cleandepend: cleanilinks
483# .depend needs include links so we remove them only together.
484cleanilinks:
485	rm -f ${_ILINKS}
486
487.if !exists(${.OBJDIR}/${DEPENDFILE})
488${OBJS}: ${SRCS:M*.h}
489.endif
490
491.include <bsd.obj.mk>
492.include "kern.mk"
493