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