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