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