xref: /freebsd/sys/conf/kmod.mk (revision c697fb7f7cc9bedc5beee44d35b771c4e87b335a)
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# KMODISLOADED	Command to check whether a kernel module is
32#		loaded [/sbin/kldstat -q -n]
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# KERNBUILDDIR
48#		Set to the location of the kernel build directory where
49#		the opt_*.h files, .o's and kernel winds up.
50#
51# +++ targets +++
52#
53# 	install:
54#               install the kernel module; if the Makefile
55#               does not itself define the target install, the targets
56#               beforeinstall and afterinstall may also be used to cause
57#               actions immediately before and after the install target
58#		is executed.
59#
60# 	load:
61#		Load a module.
62#
63# 	unload:
64#		Unload a module.
65#
66#	reload:
67#		Unload if loaded, then load.
68#
69
70AWK?=		awk
71KMODLOAD?=	/sbin/kldload
72KMODUNLOAD?=	/sbin/kldunload
73KMODISLOADED?=	/sbin/kldstat -q -n
74OBJCOPY?=	objcopy
75
76.include "kmod.opts.mk"
77.include <bsd.sysdir.mk>
78
79.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
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
91.if ${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} < 50000
92WERROR?=	-Wno-error
93.else
94WERROR?=	-Werror
95.endif
96
97LINUXKPI_GENSRCS+= \
98	bus_if.h \
99	device_if.h \
100	pci_if.h \
101	pci_iov_if.h \
102	vnode_if.h \
103	usb_if.h \
104	opt_usb.h \
105	opt_stack.h
106
107CFLAGS+=	${WERROR}
108CFLAGS+=	-D_KERNEL
109CFLAGS+=	-DKLD_MODULE
110.if defined(MODULE_TIED)
111CFLAGS+=	-DKLD_TIED
112.endif
113
114# Don't use any standard or source-relative include directories.
115NOSTDINC=	-nostdinc
116CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
117.if defined(KERNBUILDDIR)
118CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
119.else
120SRCS+=		opt_global.h
121CFLAGS+=	-include ${.OBJDIR}/opt_global.h
122.endif
123
124# Add -I paths for system headers.  Individual module makefiles don't
125# need any -I paths for this.  Similar defaults for .PATH can't be
126# set because there are no standard paths for non-headers.
127CFLAGS+=	-I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
128
129CFLAGS.gcc+=	-finline-limit=${INLINE_LIMIT}
130CFLAGS.gcc+=	-fms-extensions
131CFLAGS.gcc+= --param inline-unit-growth=100
132CFLAGS.gcc+= --param large-function-growth=1000
133
134# Disallow common variables, and if we end up with commons from
135# somewhere unexpected, allocate storage for them in the module itself.
136CFLAGS+=	-fno-common
137LDFLAGS+=	-d -warn-common
138
139.if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
140LDFLAGS+=	--build-id=sha1
141.endif
142
143CFLAGS+=	${DEBUG_FLAGS}
144.if ${MACHINE_CPUARCH} == amd64
145CFLAGS+=	-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
146.endif
147
148.if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
149    ${MACHINE_CPUARCH} == "powerpc"
150CFLAGS+=	-fPIC
151.endif
152
153# Temporary workaround for PR 196407, which contains the fascinating details.
154# Don't allow clang to use fpu instructions or registers in kernel modules.
155.if ${MACHINE_CPUARCH} == arm
156.if ${COMPILER_VERSION} < 30800
157CFLAGS.clang+=	-mllvm -arm-use-movt=0
158.else
159CFLAGS.clang+=	-mno-movt
160.endif
161CFLAGS.clang+=	-mfpu=none
162CFLAGS+=	-funwind-tables
163.endif
164
165.if ${MACHINE_CPUARCH} == powerpc
166CFLAGS+=	-mlongcall -fno-omit-frame-pointer
167.if ${LINKER_TYPE} == "lld"
168# TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
169LDFLAGS+=	--no-toc-optimize
170.endif
171.endif
172
173.if ${MACHINE_CPUARCH} == mips
174CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
175.endif
176
177.if defined(DEBUG) || defined(DEBUG_FLAGS)
178CTFFLAGS+=	-g
179.endif
180
181.if defined(FIRMWS)
182${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
183	${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
184	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
185
186SRCS+=	${KMOD:S/$/.c/}
187CLEANFILES+=	${KMOD:S/$/.c/}
188
189.for _firmw in ${FIRMWS}
190${_firmw:C/\:.*$/.fwo/:T}:	${_firmw:C/\:.*$//}
191	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
192	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
193		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
194		    -m ${LD_EMULATION} -r -d			\
195		    -o ${.TARGET} ${_firmw:C/\:.*$//};		\
196	else							\
197		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
198		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
199		    -m ${LD_EMULATION} -r -d			\
200		    -o ${.TARGET} ${_firmw:C/\:.*$//};		\
201		rm ${_firmw:C/\:.*$//};				\
202	fi
203
204OBJS+=	${_firmw:C/\:.*$/.fwo/:T}
205.endfor
206.endif
207
208# Conditionally include SRCS based on kernel config options.
209.for _o in ${KERN_OPTS}
210SRCS+=${SRCS.${_o}}
211.endfor
212
213OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
214
215.if !defined(PROG)
216PROG=	${KMOD}.ko
217.endif
218
219.if !defined(DEBUG_FLAGS)
220FULLPROG=	${PROG}
221.else
222FULLPROG=	${PROG}.full
223${PROG}: ${FULLPROG} ${PROG}.debug
224	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
225	    ${FULLPROG} ${.TARGET}
226${PROG}.debug: ${FULLPROG}
227	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
228.endif
229
230.if ${__KLD_SHARED} == yes
231${FULLPROG}: ${KMOD}.kld
232	${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
233	    -o ${.TARGET} ${KMOD}.kld
234.if !defined(DEBUG_FLAGS)
235	${OBJCOPY} --strip-debug ${.TARGET}
236.endif
237.endif
238
239EXPORT_SYMS?=	NO
240.if ${EXPORT_SYMS} != YES
241CLEANFILES+=	export_syms
242.endif
243
244.if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
245LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
246.endif
247
248.if ${__KLD_SHARED} == yes
249${KMOD}.kld: ${OBJS}
250.else
251${FULLPROG}: ${OBJS}
252.endif
253	${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
254	    -o ${.TARGET} ${OBJS}
255.if ${MK_CTF} != "no"
256	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
257.endif
258.if defined(EXPORT_SYMS)
259.if ${EXPORT_SYMS} != YES
260.if ${EXPORT_SYMS} == NO
261	:> export_syms
262.elif !exists(${.CURDIR}/${EXPORT_SYMS})
263	echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
264.else
265	grep -v '^#' < ${EXPORT_SYMS} > export_syms
266.endif
267	${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
268	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
269.endif
270.endif # defined(EXPORT_SYMS)
271.if defined(PREFIX_SYMS)
272	${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
273	    ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
274.endif
275.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
276	${OBJCOPY} --strip-debug ${.TARGET}
277.endif
278
279.if ${COMPILER_TYPE} == "clang" || \
280    (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
281_MAP_DEBUG_PREFIX= yes
282.endif
283
284_ILINKS=machine
285.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
286_ILINKS+=x86
287.endif
288CLEANFILES+=${_ILINKS}
289
290all: ${PROG}
291
292beforedepend: ${_ILINKS}
293beforebuild: ${_ILINKS}
294
295# Ensure that the links exist without depending on it when it exists which
296# causes all the modules to be rebuilt when the directory pointed to changes.
297# Ensure that debug info references the path in the source tree.
298.for _link in ${_ILINKS}
299.if !exists(${.OBJDIR}/${_link})
300OBJS_DEPEND_GUESS+=	${_link}
301.endif
302.if defined(_MAP_DEBUG_PREFIX)
303.if ${_link} == "machine"
304CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
305.else
306CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
307.endif
308.endif
309.endfor
310
311.NOPATH: ${_ILINKS}
312
313${_ILINKS}:
314	@case ${.TARGET} in \
315	machine) \
316		path=${SYSDIR}/${MACHINE}/include ;; \
317	*) \
318		path=${SYSDIR}/${.TARGET:T}/include ;; \
319	esac ; \
320	path=`(cd $$path && /bin/pwd)` ; \
321	${ECHO} ${.TARGET:T} "->" $$path ; \
322	ln -fns $$path ${.TARGET:T}
323
324CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
325
326.if defined(DEBUG_FLAGS)
327CLEANFILES+= ${FULLPROG} ${PROG}.debug
328.endif
329
330.if !target(install)
331
332_INSTALLFLAGS:=	${INSTALLFLAGS}
333.for ie in ${INSTALLFLAGS_EDIT}
334_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
335.endfor
336
337.if !target(realinstall)
338KERN_DEBUGDIR?=	${DEBUGDIR}
339realinstall: _kmodinstall
340.ORDER: beforeinstall _kmodinstall
341_kmodinstall: .PHONY
342	${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
343	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
344.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
345	${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
346	    ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
347.endif
348
349.include <bsd.links.mk>
350
351.if !defined(NO_XREF)
352afterinstall: _kldxref
353.ORDER: realinstall _kldxref
354.ORDER: _installlinks _kldxref
355_kldxref: .PHONY
356	@if type kldxref >/dev/null 2>&1; then \
357		${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
358		${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
359	fi
360.endif
361.endif # !target(realinstall)
362
363.endif # !target(install)
364
365.if !target(load)
366load: ${PROG} .PHONY
367	${KMODLOAD} -v ${.OBJDIR}/${PROG}
368.endif
369
370.if !target(unload)
371unload: .PHONY
372	if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
373.endif
374
375.if !target(reload)
376reload: unload load .PHONY
377.endif
378
379.if defined(KERNBUILDDIR)
380.PATH: ${KERNBUILDDIR}
381CFLAGS+=	-I${KERNBUILDDIR}
382.for _src in ${SRCS:Mopt_*.h}
383CLEANFILES+=	${_src}
384.if !target(${_src})
385${_src}:
386	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
387.endif
388.endfor
389.else
390.for _src in ${SRCS:Mopt_*.h}
391CLEANFILES+=	${_src}
392.if !target(${_src})
393${_src}:
394	:> ${.TARGET}
395.endif
396.endfor
397.endif
398
399# Add the sanitizer C flags
400CFLAGS+=	${SAN_CFLAGS}
401
402# Add the gcov flags
403CFLAGS+=	${GCOV_CFLAGS}
404
405# Respect configuration-specific C flags.
406CFLAGS+=	${ARCH_FLAGS} ${CONF_CFLAGS}
407
408.if !empty(SRCS:Mvnode_if.c)
409CLEANFILES+=	vnode_if.c
410vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
411	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
412.endif
413
414.if !empty(SRCS:Mvnode_if.h)
415CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
416vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
417    ${SYSDIR}/kern/vnode_if.src
418vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
419	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
420vnode_if_newproto.h:
421	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
422vnode_if_typedef.h:
423	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
424.endif
425
426# Build _if.[ch] from _if.m, and clean them when we're done.
427# __MPATH defined in config.mk
428_MFILES=${__MPATH:T:O}
429_MPATH=${__MPATH:H:O:u}
430.PATH.m: ${_MPATH}
431.for _i in ${SRCS:M*_if.[ch]}
432_MATCH=M${_i:R:S/$/.m/}
433_MATCHES=${_MFILES:${_MATCH}}
434.if !empty(_MATCHES)
435CLEANFILES+=	${_i}
436.endif
437.endfor # _i
438.m.c:	${SYSDIR}/tools/makeobjops.awk
439	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
440
441.m.h:	${SYSDIR}/tools/makeobjops.awk
442	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
443
444.for _i in mii pccard
445.if !empty(SRCS:M${_i}devs.h)
446CLEANFILES+=	${_i}devs.h
447${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
448	${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
449.endif
450.endfor # _i
451
452.if !empty(SRCS:Mbhnd_nvram_map.h)
453CLEANFILES+=	bhnd_nvram_map.h
454bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
455    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
456    ${SYSDIR}/dev/bhnd/nvram/nvram_map
457bhnd_nvram_map.h:
458	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
459	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
460.endif
461
462.if !empty(SRCS:Mbhnd_nvram_map_data.h)
463CLEANFILES+=	bhnd_nvram_map_data.h
464bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
465    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
466    ${SYSDIR}/dev/bhnd/nvram/nvram_map
467bhnd_nvram_map_data.h:
468	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
469	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
470.endif
471
472.if !empty(SRCS:Musbdevs.h)
473CLEANFILES+=	usbdevs.h
474usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
475	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
476.endif
477
478.if !empty(SRCS:Musbdevs_data.h)
479CLEANFILES+=	usbdevs_data.h
480usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
481	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
482.endif
483
484.if !empty(SRCS:Msdiodevs.h)
485CLEANFILES+=	sdiodevs.h
486sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
487	${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
488.endif
489
490.if !empty(SRCS:Msdiodevs_data.h)
491CLEANFILES+=	sdiodevs_data.h
492sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
493	${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
494.endif
495
496.if !empty(SRCS:Macpi_quirks.h)
497CLEANFILES+=	acpi_quirks.h
498acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
499	${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
500.endif
501
502.if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
503CLEANFILES+=	assym.inc genassym.o
504DEPENDOBJS+=	genassym.o
505DPSRCS+=	offset.inc
506.endif
507.if defined(MODULE_TIED)
508DPSRCS+=	offset.inc
509.endif
510.if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
511CLEANFILES+=	offset.inc genoffset.o
512DEPENDOBJS+=	genoffset.o
513.endif
514assym.inc: genassym.o
515offset.inc: genoffset.o
516assym.inc: ${SYSDIR}/kern/genassym.sh
517	sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
518genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
519genassym.o: ${SRCS:Mopt_*.h}
520	${CC} -c ${CFLAGS:N-flto:N-fno-common} \
521	    ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
522offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
523	sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
524genoffset.o: ${SYSDIR}/kern/genoffset.c
525genoffset.o: ${SRCS:Mopt_*.h}
526	${CC} -c ${CFLAGS:N-flto:N-fno-common} \
527	    ${SYSDIR}/kern/genoffset.c
528
529CLEANDEPENDFILES+=	${_ILINKS}
530# .depend needs include links so we remove them only together.
531cleanilinks:
532	rm -f ${_ILINKS}
533
534OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
535.if defined(KERNBUILDDIR)
536OBJS_DEPEND_GUESS+= opt_global.h
537.endif
538
539.include <bsd.dep.mk>
540.include <bsd.clang-analyze.mk>
541.include <bsd.obj.mk>
542.include "kern.mk"
543