kmod.mk revision 207057
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: head/sys/conf/kmod.mk 207057 2010-04-22 09:24:01Z 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(DEBUG) || defined(DEBUG_FLAGS)
141CTFFLAGS+=	-g
142.endif
143
144.if defined(FIRMWS)
145.if !exists(@)
146${KMOD:S/$/.c/}: @
147.else
148${KMOD:S/$/.c/}: @/tools/fw_stub.awk
149.endif
150	${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
151	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
152
153SRCS+=	${KMOD:S/$/.c/}
154CLEANFILES+=	${KMOD:S/$/.c/}
155
156.for _firmw in ${FIRMWS}
157${_firmw:C/\:.*$/.fwo/}:	${_firmw:C/\:.*$//}
158	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
159	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
160		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
161		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
162	else							\
163		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
164		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
165		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
166		rm ${_firmw:C/\:.*$//};				\
167	fi
168
169OBJS+=	${_firmw:C/\:.*$/.fwo/}
170.endfor
171.endif
172
173OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
174
175.if !defined(PROG)
176PROG=	${KMOD}.ko
177.endif
178
179.if !defined(DEBUG_FLAGS)
180FULLPROG=	${PROG}
181.else
182FULLPROG=	${PROG}.debug
183${PROG}: ${FULLPROG} ${PROG}.symbols
184	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
185	    ${FULLPROG} ${.TARGET}
186${PROG}.symbols: ${FULLPROG}
187	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
188.endif
189
190.if ${MACHINE_ARCH} != amd64 && ${MACHINE_ARCH} != mips
191${FULLPROG}: ${KMOD}.kld
192	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
193.if !defined(DEBUG_FLAGS)
194	${OBJCOPY} --strip-debug ${.TARGET}
195.endif
196.endif
197
198EXPORT_SYMS?=	NO
199.if ${EXPORT_SYMS} != YES
200CLEANFILES+=	export_syms
201.endif
202
203.if ${MACHINE_ARCH} != amd64 && ${MACHINE_ARCH} != mips
204${KMOD}.kld: ${OBJS}
205.else
206${FULLPROG}: ${OBJS}
207.endif
208	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
209	@[ -z "${CTFMERGE}" -o -n "${NO_CTF}" ] || ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
210.if defined(EXPORT_SYMS)
211.if ${EXPORT_SYMS} != YES
212.if ${EXPORT_SYMS} == NO
213	:> export_syms
214.elif !exists(${.CURDIR}/${EXPORT_SYMS})
215	echo ${EXPORT_SYMS} > export_syms
216.else
217	grep -v '^#' < ${EXPORT_SYMS} > export_syms
218.endif
219	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
220	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
221.endif
222.endif
223.if !defined(DEBUG_FLAGS) && \
224    (${MACHINE_ARCH} == amd64 || ${MACHINE_ARCH} == mips)
225	${OBJCOPY} --strip-debug ${.TARGET}
226.endif
227
228_ILINKS=@ machine
229.if ${MACHINE} != ${MACHINE_ARCH}
230_ILINKS+=${MACHINE_ARCH}
231.endif
232
233all: objwarn ${PROG}
234
235beforedepend: ${_ILINKS}
236
237# Ensure that the links exist without depending on it when it exists which
238# causes all the modules to be rebuilt when the directory pointed to changes.
239.for _link in ${_ILINKS}
240.if !exists(${.OBJDIR}/${_link})
241${OBJS}: ${_link}
242.endif
243.endfor
244
245# Search for kernel source tree in standard places.
246.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
247.if !defined(SYSDIR) && exists(${_dir}/kern/)
248SYSDIR=	${_dir}
249.endif
250.endfor
251.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
252.error "can't find kernel source tree"
253.endif
254
255${_ILINKS}:
256	@case ${.TARGET} in \
257	${MACHINE_ARCH}) \
258		path=${SYSDIR}/${MACHINE_ARCH}/include ;; \
259	machine) \
260		path=${SYSDIR}/${MACHINE}/include ;; \
261	@) \
262		path=${SYSDIR} ;; \
263	esac ; \
264	path=`(cd $$path && /bin/pwd)` ; \
265	${ECHO} ${.TARGET} "->" $$path ; \
266	ln -sf $$path ${.TARGET}
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)
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.if defined(KERNBUILDDIR)
319.PATH: ${KERNBUILDDIR}
320CFLAGS+=	-I${KERNBUILDDIR}
321.for _src in ${SRCS:Mopt_*.h}
322CLEANFILES+=	${_src}
323.if !target(${_src})
324${_src}:
325	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
326.endif
327.endfor
328.else
329.for _src in ${SRCS:Mopt_*.h}
330CLEANFILES+=	${_src}
331.if !target(${_src})
332${_src}:
333	:> ${.TARGET}
334.endif
335.endfor
336.endif
337
338# Respect configuration-specific C flags.
339CFLAGS+=	${CONF_CFLAGS}
340
341MFILES?= dev/acpica/acpi_if.m dev/acpi_support/acpi_wmi_if.m \
342	dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_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/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 dev/smbus/smbus_if.m \
348	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
349	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
350	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
351	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
352	kern/bus_if.m kern/clock_if.m \
353	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
354	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
355	pc98/pc98/canbus_if.m
356
357.for _srcsrc in ${MFILES}
358.for _ext in c h
359.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
360CLEANFILES+=	${_src}
361.if !target(${_src})
362.if !exists(@)
363${_src}: @
364.else
365${_src}: @/tools/makeobjops.awk @/${_srcsrc}
366.endif
367	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
368.endif
369.endfor # _src
370.endfor # _ext
371.endfor # _srcsrc
372
373.if !empty(SRCS:Mvnode_if.c)
374CLEANFILES+=	vnode_if.c
375.if !exists(@)
376vnode_if.c: @
377.else
378vnode_if.c: @/tools/vnode_if.awk @/kern/vnode_if.src
379.endif
380	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -c
381.endif
382
383.if !empty(SRCS:Mvnode_if.h)
384CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
385.if !exists(@)
386vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @
387.else
388vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @/tools/vnode_if.awk \
389    @/kern/vnode_if.src
390.endif
391vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
392	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -h
393vnode_if_newproto.h:
394	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -p
395vnode_if_typedef.h:
396	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -q
397.endif
398
399.for _i in mii pccard
400.if !empty(SRCS:M${_i}devs.h)
401CLEANFILES+=	${_i}devs.h
402.if !exists(@)
403${_i}devs.h: @
404.else
405${_i}devs.h: @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
406.endif
407	${AWK} -f @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
408.endif
409.endfor # _i
410
411.if !empty(SRCS:Musbdevs.h)
412CLEANFILES+=	usbdevs.h
413.if !exists(@)
414usbdevs.h: @
415.else
416usbdevs.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
417.endif
418	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -h
419.endif
420
421.if !empty(SRCS:Musbdevs_data.h)
422CLEANFILES+=	usbdevs_data.h
423.if !exists(@)
424usbdevs_data.h: @
425.else
426usbdevs_data.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
427.endif
428	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -d
429.endif
430
431.if !empty(SRCS:Macpi_quirks.h)
432CLEANFILES+=	acpi_quirks.h
433.if !exists(@)
434acpi_quirks.h: @
435.else
436acpi_quirks.h: @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
437.endif
438	${AWK} -f @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
439.endif
440
441.if !empty(SRCS:Massym.s)
442CLEANFILES+=	assym.s genassym.o
443assym.s: genassym.o
444.if defined(KERNBUILDDIR)
445genassym.o: opt_global.h
446.endif
447.if !exists(@)
448assym.s: @
449.else
450assym.s: @/kern/genassym.sh
451.endif
452	sh @/kern/genassym.sh genassym.o > ${.TARGET}
453.if exists(@)
454genassym.o: @/${MACHINE_ARCH}/${MACHINE_ARCH}/genassym.c
455.endif
456genassym.o: @ machine ${SRCS:Mopt_*.h}
457	${CC} -c ${CFLAGS:N-fno-common} \
458	    @/${MACHINE_ARCH}/${MACHINE_ARCH}/genassym.c
459.endif
460
461lint: ${SRCS}
462	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
463
464.if defined(KERNBUILDDIR)
465${OBJS}: opt_global.h
466.endif
467
468.include <bsd.dep.mk>
469
470cleandepend: cleanilinks
471# .depend needs include links so we remove them only together.
472cleanilinks:
473	rm -f ${_ILINKS}
474
475.if !exists(${.OBJDIR}/${DEPENDFILE})
476${OBJS}: ${SRCS:M*.h}
477.endif
478
479.include <bsd.obj.mk>
480.include "kern.mk"
481