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