kmod.mk revision 278958 
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: head/sys/conf/kmod.mk 278958 2015-02-18 15:25:19Z imp $
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
63AWK?=		awk
64KMODLOAD?=	/sbin/kldload
65KMODUNLOAD?=	/sbin/kldunload
66OBJCOPY?=	objcopy
67
68.include <bsd.init.mk>
69# Grab all the options for a kernel build. For backwards compat, we need to
70# do this after bsd.own.mk.
71.include "kern.opts.mk"
72.include <bsd.compiler.mk>
73.include "config.mk"
74
75.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
76
77# amd64 and mips use direct linking for kmod, all others use shared binaries
78.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
79__KLD_SHARED=yes
80.else
81__KLD_SHARED=no
82.endif
83
84.if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
85CFLAGS+=	-fno-strict-aliasing
86.endif
87WERROR?=	-Werror
88CFLAGS+=	${WERROR}
89CFLAGS+=	-D_KERNEL
90CFLAGS+=	-DKLD_MODULE
91
92# Don't use any standard or source-relative include directories.
93NOSTDINC=	-nostdinc
94CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
95.if defined(KERNBUILDDIR)
96CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
97.endif
98
99# Add -I paths for system headers.  Individual module makefiles don't
100# need any -I paths for this.  Similar defaults for .PATH can't be
101# set because there are no standard paths for non-headers.
102CFLAGS+=	-I. -I${SYSDIR}
103
104# Add -I path for altq headers as they are included via net/if_var.h
105# for example.
106CFLAGS+=	-I${SYSDIR}/contrib/altq
107
108CFLAGS.gcc+=	-finline-limit=${INLINE_LIMIT}
109CFLAGS.gcc+=	-fms-extensions
110CFLAGS.gcc+= --param inline-unit-growth=100
111CFLAGS.gcc+= --param large-function-growth=1000
112
113# Disallow common variables, and if we end up with commons from
114# somewhere unexpected, allocate storage for them in the module itself.
115CFLAGS+=	-fno-common
116LDFLAGS+=	-d -warn-common
117
118CFLAGS+=	${DEBUG_FLAGS}
119.if ${MACHINE_CPUARCH} == amd64
120CFLAGS+=	-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
121.endif
122
123# Temporary workaround for PR 196407, which contains the fascinating details.
124# Don't allow clang to use fpu instructions or registers in kernel modules.
125.if ${MACHINE_CPUARCH} == arm
126CFLAGS.clang+=	-mllvm -arm-use-movt=0
127CFLAGS.clang+=	-mfpu=none
128.endif
129
130.if ${MACHINE_CPUARCH} == powerpc
131CFLAGS+=	-mlongcall -fno-omit-frame-pointer
132.endif
133
134.if ${MACHINE_CPUARCH} == mips
135CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
136.endif
137
138.if defined(DEBUG) || defined(DEBUG_FLAGS)
139CTFFLAGS+=	-g
140.endif
141
142.if defined(FIRMWS)
143${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
144	${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
145	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
146
147SRCS+=	${KMOD:S/$/.c/}
148CLEANFILES+=	${KMOD:S/$/.c/}
149
150.for _firmw in ${FIRMWS}
151${_firmw:C/\:.*$/.fwo/}:	${_firmw:C/\:.*$//}
152	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
153	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
154		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
155		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
156	else							\
157		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
158		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
159		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
160		rm ${_firmw:C/\:.*$//};				\
161	fi
162
163OBJS+=	${_firmw:C/\:.*$/.fwo/}
164.endfor
165.endif
166
167# Conditionally include SRCS based on kernel config options.
168.for _o in ${KERN_OPTS}
169SRCS+=${SRCS.${_o}}
170.endfor
171
172OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
173
174.if !defined(PROG)
175PROG=	${KMOD}.ko
176.endif
177
178.if !defined(DEBUG_FLAGS)
179FULLPROG=	${PROG}
180.else
181FULLPROG=	${PROG}.debug
182${PROG}: ${FULLPROG} ${PROG}.symbols
183	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
184	    ${FULLPROG} ${.TARGET}
185${PROG}.symbols: ${FULLPROG}
186	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
187.endif
188
189.if ${__KLD_SHARED} == yes
190${FULLPROG}: ${KMOD}.kld
191	${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${KMOD}.kld
192.if !defined(DEBUG_FLAGS)
193	${OBJCOPY} --strip-debug ${.TARGET}
194.endif
195.endif
196
197EXPORT_SYMS?=	NO
198.if ${EXPORT_SYMS} != YES
199CLEANFILES+=	export_syms
200.endif
201
202.if ${__KLD_SHARED} == yes
203${KMOD}.kld: ${OBJS}
204.else
205${FULLPROG}: ${OBJS}
206.endif
207	${LD} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
208.if ${MK_CTF} != "no"
209	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
210.endif
211.if defined(EXPORT_SYMS)
212.if ${EXPORT_SYMS} != YES
213.if ${EXPORT_SYMS} == NO
214	:> export_syms
215.elif !exists(${.CURDIR}/${EXPORT_SYMS})
216	echo ${EXPORT_SYMS} > export_syms
217.else
218	grep -v '^#' < ${EXPORT_SYMS} > export_syms
219.endif
220	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
221	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
222.endif
223.endif
224.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
225	${OBJCOPY} --strip-debug ${.TARGET}
226.endif
227
228_ILINKS=machine
229.if ${MACHINE} != ${MACHINE_CPUARCH}
230_ILINKS+=${MACHINE_CPUARCH}
231.endif
232.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
233_ILINKS+=x86
234.endif
235CLEANFILES+=${_ILINKS}
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}: ${.OBJDIR}/${_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.for _link in ${_ILINKS}
260.PHONY: ${_link}
261${_link}: ${.OBJDIR}/${_link}
262
263${.OBJDIR}/${_link}:
264	@case ${.TARGET:T} in \
265	machine) \
266		path=${SYSDIR}/${MACHINE}/include ;; \
267	*) \
268		path=${SYSDIR}/${.TARGET:T}/include ;; \
269	esac ; \
270	path=`(cd $$path && /bin/pwd)` ; \
271	${ECHO} ${.TARGET:T} "->" $$path ; \
272	ln -sf $$path ${.TARGET:T}
273.endfor
274
275CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
276
277.if defined(DEBUG_FLAGS)
278CLEANFILES+= ${FULLPROG} ${PROG}.symbols
279.endif
280
281.if !target(install)
282
283_INSTALLFLAGS:=	${INSTALLFLAGS}
284.for ie in ${INSTALLFLAGS_EDIT}
285_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
286.endfor
287
288.if !target(realinstall)
289realinstall: _kmodinstall
290.ORDER: beforeinstall _kmodinstall
291_kmodinstall:
292	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
293	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
294.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
295	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
296	    ${_INSTALLFLAGS} ${PROG}.symbols ${DESTDIR}${KMODDIR}
297.endif
298
299.include <bsd.links.mk>
300
301.if !defined(NO_XREF)
302afterinstall: _kldxref
303.ORDER: realinstall _kldxref
304.ORDER: _installlinks _kldxref
305_kldxref:
306	@if type kldxref >/dev/null 2>&1; then \
307		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
308		kldxref ${DESTDIR}${KMODDIR}; \
309	fi
310.endif
311.endif # !target(realinstall)
312
313.endif # !target(install)
314
315.if !target(load)
316load: ${PROG}
317	${KMODLOAD} -v ${.OBJDIR}/${PROG}
318.endif
319
320.if !target(unload)
321unload:
322	${KMODUNLOAD} -v ${PROG}
323.endif
324
325.if defined(KERNBUILDDIR)
326.PATH: ${KERNBUILDDIR}
327CFLAGS+=	-I${KERNBUILDDIR}
328.for _src in ${SRCS:Mopt_*.h}
329CLEANFILES+=	${_src}
330.if !target(${_src})
331${_src}:
332	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
333.endif
334.endfor
335.else
336.for _src in ${SRCS:Mopt_*.h}
337CLEANFILES+=	${_src}
338.if !target(${_src})
339${_src}:
340	:> ${.TARGET}
341.endif
342.endfor
343.endif
344
345# Respect configuration-specific C flags.
346CFLAGS+=	${CONF_CFLAGS}
347
348MFILES?= dev/acpica/acpi_if.m dev/acpi_support/acpi_wmi_if.m \
349	dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_if.m \
350	dev/fb/fb_if.m dev/gpio/gpio_if.m dev/gpio/gpiobus_if.m \
351	dev/iicbus/iicbb_if.m dev/iicbus/iicbus_if.m \
352	dev/mbox/mbox_if.m dev/mmc/mmcbr_if.m dev/mmc/mmcbus_if.m \
353	dev/mii/miibus_if.m dev/mvs/mvs_if.m dev/ofw/ofw_bus_if.m \
354	dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
355	dev/pci/pcib_if.m dev/ppbus/ppbus_if.m \
356	dev/sdhci/sdhci_if.m dev/smbus/smbus_if.m dev/spibus/spibus_if.m \
357	dev/sound/pci/hda/hdac_if.m \
358	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
359	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
360	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
361	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
362	kern/bus_if.m kern/clock_if.m \
363	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
364	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
365	pc98/pc98/canbus_if.m dev/etherswitch/mdio_if.m
366
367.for _srcsrc in ${MFILES}
368.for _ext in c h
369.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
370CLEANFILES+=	${_src}
371.if !target(${_src})
372${_src}: ${SYSDIR}/tools/makeobjops.awk ${SYSDIR}/${_srcsrc}
373	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${SYSDIR}/${_srcsrc} -${_ext}
374.endif
375.endfor # _src
376.endfor # _ext
377.endfor # _srcsrc
378
379.if !empty(SRCS:Mvnode_if.c)
380CLEANFILES+=	vnode_if.c
381vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
382	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
383.endif
384
385.if !empty(SRCS:Mvnode_if.h)
386CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
387vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
388    ${SYSDIR}/kern/vnode_if.src
389vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
390	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
391vnode_if_newproto.h:
392	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
393vnode_if_typedef.h:
394	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
395.endif
396
397.for _i in mii pccard
398.if !empty(SRCS:M${_i}devs.h)
399CLEANFILES+=	${_i}devs.h
400${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
401	${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
402.endif
403.endfor # _i
404
405.if !empty(SRCS:Musbdevs.h)
406CLEANFILES+=	usbdevs.h
407usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
408	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
409.endif
410
411.if !empty(SRCS:Musbdevs_data.h)
412CLEANFILES+=	usbdevs_data.h
413usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
414	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
415.endif
416
417.if !empty(SRCS:Macpi_quirks.h)
418CLEANFILES+=	acpi_quirks.h
419acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
420	${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
421.endif
422
423.if !empty(SRCS:Massym.s)
424CLEANFILES+=	assym.s genassym.o
425assym.s: genassym.o
426.if defined(KERNBUILDDIR)
427genassym.o: opt_global.h
428.endif
429assym.s: ${SYSDIR}/kern/genassym.sh
430	sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
431genassym.o: ${SYSDIR}/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
432genassym.o: ${SRCS:Mopt_*.h}
433	${CC} -c ${CFLAGS:N-fno-common} \
434	    ${SYSDIR}/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
435.endif
436
437lint: ${SRCS}
438	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
439
440.if defined(KERNBUILDDIR)
441${OBJS}: opt_global.h
442.endif
443
444.include <bsd.dep.mk>
445
446cleandepend: cleanilinks
447# .depend needs include links so we remove them only together.
448cleanilinks:
449	rm -f ${_ILINKS}
450
451.if !exists(${.OBJDIR}/${DEPENDFILE})
452${OBJS}: ${SRCS:M*.h}
453.endif
454
455.include <bsd.obj.mk>
456.include "kern.mk"
457