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