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