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