kmod.mk revision 228124 
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: head/sys/conf/kmod.mk 228124 2011-11-29 08:38:47Z fjoe $
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 !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
92CFLAGS+=	-fno-strict-aliasing
93.endif
94WERROR?=	-Werror
95CFLAGS+=	${WERROR}
96CFLAGS+=	-D_KERNEL
97CFLAGS+=	-DKLD_MODULE
98
99# Don't use any standard or source-relative include directories.
100CSTD=		c99
101NOSTDINC=	-nostdinc
102CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
103.if defined(KERNBUILDDIR)
104CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
105.endif
106
107# Add -I paths for system headers.  Individual module makefiles don't
108# need any -I paths for this.  Similar defaults for .PATH can't be
109# set because there are no standard paths for non-headers.
110CFLAGS+=	-I. -I@
111
112# Add -I path for altq headers as they are included via net/if_var.h
113# for example.
114CFLAGS+=	-I@/contrib/altq
115
116.if ${CC:T:Mclang} != "clang"
117CFLAGS+=	-finline-limit=${INLINE_LIMIT}
118CFLAGS+= --param inline-unit-growth=100
119CFLAGS+= --param large-function-growth=1000
120.endif
121
122# Disallow common variables, and if we end up with commons from
123# somewhere unexpected, allocate storage for them in the module itself.
124CFLAGS+=	-fno-common
125LDFLAGS+=	-d -warn-common
126
127CFLAGS+=	${DEBUG_FLAGS}
128.if ${MACHINE_CPUARCH} == amd64
129CFLAGS+=	-fno-omit-frame-pointer
130.endif
131
132.if ${MACHINE_CPUARCH} == powerpc
133CFLAGS+=	-mlongcall -fno-omit-frame-pointer
134.endif
135
136.if ${MACHINE_CPUARCH} == mips
137CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
138.endif
139
140.if defined(DEBUG) || defined(DEBUG_FLAGS)
141CTFFLAGS+=	-g
142.endif
143
144.if defined(FIRMWS)
145.if !exists(@)
146${KMOD:S/$/.c/}: @
147.else
148${KMOD:S/$/.c/}: @/tools/fw_stub.awk
149.endif
150	${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
151	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
152
153SRCS+=	${KMOD:S/$/.c/}
154CLEANFILES+=	${KMOD:S/$/.c/}
155
156.for _firmw in ${FIRMWS}
157${_firmw:C/\:.*$/.fwo/}:	${_firmw:C/\:.*$//}
158	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
159	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
160		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
161		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
162	else							\
163		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
164		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
165		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
166		rm ${_firmw:C/\:.*$//};				\
167	fi
168
169OBJS+=	${_firmw:C/\:.*$/.fwo/}
170.endfor
171.endif
172
173OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
174
175.if !defined(PROG)
176PROG=	${KMOD}.ko
177.endif
178
179.if !defined(DEBUG_FLAGS)
180FULLPROG=	${PROG}
181.else
182FULLPROG=	${PROG}.debug
183${PROG}: ${FULLPROG} ${PROG}.symbols
184	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
185	    ${FULLPROG} ${.TARGET}
186${PROG}.symbols: ${FULLPROG}
187	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
188.endif
189
190.if ${__KLD_SHARED} == yes
191${FULLPROG}: ${KMOD}.kld
192	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
193.if !defined(DEBUG_FLAGS)
194	${OBJCOPY} --strip-debug ${.TARGET}
195.endif
196.endif
197
198EXPORT_SYMS?=	NO
199.if ${EXPORT_SYMS} != YES
200CLEANFILES+=	export_syms
201.endif
202
203.if ${__KLD_SHARED} == yes
204${KMOD}.kld: ${OBJS}
205.else
206${FULLPROG}: ${OBJS}
207.endif
208	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
209.if !defined(NO_CTF)
210	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
211.endif
212.if defined(EXPORT_SYMS)
213.if ${EXPORT_SYMS} != YES
214.if ${EXPORT_SYMS} == NO
215	:> export_syms
216.elif !exists(${.CURDIR}/${EXPORT_SYMS})
217	echo ${EXPORT_SYMS} > export_syms
218.else
219	grep -v '^#' < ${EXPORT_SYMS} > export_syms
220.endif
221	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
222	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
223.endif
224.endif
225.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
226	${OBJCOPY} --strip-debug ${.TARGET}
227.endif
228
229_ILINKS=@ machine
230.if ${MACHINE} != ${MACHINE_CPUARCH}
231_ILINKS+=${MACHINE_CPUARCH}
232.endif
233.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
234_ILINKS+=x86
235.endif
236
237all: objwarn ${PROG}
238
239beforedepend: ${_ILINKS}
240
241# Ensure that the links exist without depending on it when it exists which
242# causes all the modules to be rebuilt when the directory pointed to changes.
243.for _link in ${_ILINKS}
244.if !exists(${.OBJDIR}/${_link})
245${OBJS}: ${_link}
246.endif
247.endfor
248
249# Search for kernel source tree in standard places.
250.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
251.if !defined(SYSDIR) && exists(${_dir}/kern/)
252SYSDIR=	${_dir}
253.endif
254.endfor
255.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
256.error "can't find kernel source tree"
257.endif
258
259${_ILINKS}:
260	@case ${.TARGET} in \
261	machine) \
262		path=${SYSDIR}/${MACHINE}/include ;; \
263	@) \
264		path=${SYSDIR} ;; \
265	*) \
266		path=${SYSDIR}/${.TARGET}/include ;; \
267	esac ; \
268	path=`(cd $$path && /bin/pwd)` ; \
269	${ECHO} ${.TARGET} "->" $$path ; \
270	ln -sf $$path ${.TARGET}
271
272CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
273
274.if defined(DEBUG_FLAGS)
275CLEANFILES+= ${FULLPROG} ${PROG}.symbols
276.endif
277
278.if !target(install)
279
280_INSTALLFLAGS:=	${INSTALLFLAGS}
281.for ie in ${INSTALLFLAGS_EDIT}
282_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
283.endfor
284
285.if !target(realinstall)
286realinstall: _kmodinstall
287.ORDER: beforeinstall _kmodinstall
288_kmodinstall:
289	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
290	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
291.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && \
292    (defined(MK_KERNEL_SYMBOLS) && ${MK_KERNEL_SYMBOLS} != "no")
293	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
294	    ${_INSTALLFLAGS} ${PROG}.symbols ${DESTDIR}${KMODDIR}
295.endif
296
297.include <bsd.links.mk>
298
299.if !defined(NO_XREF)
300afterinstall: _kldxref
301.ORDER: realinstall _kldxref
302.ORDER: _installlinks _kldxref
303_kldxref:
304	@if type kldxref >/dev/null 2>&1; then \
305		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
306		kldxref ${DESTDIR}${KMODDIR}; \
307	fi
308.endif
309.endif # !target(realinstall)
310
311.endif # !target(install)
312
313.if !target(load)
314load: ${PROG}
315	${KMODLOAD} -v ${.OBJDIR}/${PROG}
316.endif
317
318.if !target(unload)
319unload:
320	${KMODUNLOAD} -v ${PROG}
321.endif
322
323.if defined(KERNBUILDDIR)
324.PATH: ${KERNBUILDDIR}
325CFLAGS+=	-I${KERNBUILDDIR}
326.for _src in ${SRCS:Mopt_*.h}
327CLEANFILES+=	${_src}
328.if !target(${_src})
329${_src}:
330	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
331.endif
332.endfor
333.else
334.for _src in ${SRCS:Mopt_*.h}
335CLEANFILES+=	${_src}
336.if !target(${_src})
337${_src}:
338	:> ${.TARGET}
339.endif
340.endfor
341.endif
342
343# Respect configuration-specific C flags.
344CFLAGS+=	${CONF_CFLAGS}
345
346MFILES?= dev/acpica/acpi_if.m dev/acpi_support/acpi_wmi_if.m \
347	dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_if.m \
348	dev/iicbus/iicbb_if.m dev/iicbus/iicbus_if.m \
349	dev/mmc/mmcbr_if.m dev/mmc/mmcbus_if.m \
350	dev/mii/miibus_if.m dev/mvs/mvs_if.m dev/ofw/ofw_bus_if.m \
351	dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
352	dev/pci/pcib_if.m dev/ppbus/ppbus_if.m dev/smbus/smbus_if.m \
353	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
354	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
355	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
356	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
357	kern/bus_if.m kern/clock_if.m \
358	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
359	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
360	pc98/pc98/canbus_if.m
361
362.for _srcsrc in ${MFILES}
363.for _ext in c h
364.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
365CLEANFILES+=	${_src}
366.if !target(${_src})
367.if !exists(@)
368${_src}: @
369.else
370${_src}: @/tools/makeobjops.awk @/${_srcsrc}
371.endif
372	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
373.endif
374.endfor # _src
375.endfor # _ext
376.endfor # _srcsrc
377
378.if !empty(SRCS:Mvnode_if.c)
379CLEANFILES+=	vnode_if.c
380.if !exists(@)
381vnode_if.c: @
382.else
383vnode_if.c: @/tools/vnode_if.awk @/kern/vnode_if.src
384.endif
385	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -c
386.endif
387
388.if !empty(SRCS:Mvnode_if.h)
389CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
390.if !exists(@)
391vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @
392.else
393vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @/tools/vnode_if.awk \
394    @/kern/vnode_if.src
395.endif
396vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
397	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -h
398vnode_if_newproto.h:
399	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -p
400vnode_if_typedef.h:
401	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -q
402.endif
403
404.for _i in mii pccard
405.if !empty(SRCS:M${_i}devs.h)
406CLEANFILES+=	${_i}devs.h
407.if !exists(@)
408${_i}devs.h: @
409.else
410${_i}devs.h: @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
411.endif
412	${AWK} -f @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
413.endif
414.endfor # _i
415
416.if !empty(SRCS:Musbdevs.h)
417CLEANFILES+=	usbdevs.h
418.if !exists(@)
419usbdevs.h: @
420.else
421usbdevs.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
422.endif
423	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -h
424.endif
425
426.if !empty(SRCS:Musbdevs_data.h)
427CLEANFILES+=	usbdevs_data.h
428.if !exists(@)
429usbdevs_data.h: @
430.else
431usbdevs_data.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
432.endif
433	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -d
434.endif
435
436.if !empty(SRCS:Macpi_quirks.h)
437CLEANFILES+=	acpi_quirks.h
438.if !exists(@)
439acpi_quirks.h: @
440.else
441acpi_quirks.h: @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
442.endif
443	${AWK} -f @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
444.endif
445
446.if !empty(SRCS:Massym.s)
447CLEANFILES+=	assym.s genassym.o
448assym.s: genassym.o
449.if defined(KERNBUILDDIR)
450genassym.o: opt_global.h
451.endif
452.if !exists(@)
453assym.s: @
454.else
455assym.s: @/kern/genassym.sh
456.endif
457	sh @/kern/genassym.sh genassym.o > ${.TARGET}
458.if exists(@)
459genassym.o: @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
460.endif
461genassym.o: @ machine ${SRCS:Mopt_*.h}
462	${CC} -c ${CFLAGS:N-fno-common} \
463	    @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
464.endif
465
466lint: ${SRCS}
467	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
468
469.if defined(KERNBUILDDIR)
470${OBJS}: opt_global.h
471.endif
472
473.include <bsd.dep.mk>
474
475cleandepend: cleanilinks
476# .depend needs include links so we remove them only together.
477cleanilinks:
478	rm -f ${_ILINKS}
479
480.if !exists(${.OBJDIR}/${DEPENDFILE})
481${OBJS}: ${SRCS:M*.h}
482.endif
483
484.include <bsd.obj.mk>
485.include "kern.mk"
486