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