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