1 # From: @(#)bsd.prog.mk 5.26 (Berkeley) 6/25/91
4 # The include file <bsd.kmod.mk> handles building and installing loadable
10 # CLEANFILES Additional files to remove for the clean and cleandir targets.
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
17 # KMOD The name of the kernel module to build.
19 # KMODDIR Base path for kernel modules (see kld(4)). [/boot/kernel]
21 # KMODOWN Module file owner. [${BINOWN}]
23 # KMODGRP Module file group. [${BINGRP}]
25 # KMODMODE Module file mode. [${BINMODE}]
27 # KMODLOAD Command to load a kernel module [/sbin/kldload]
29 # KMODUNLOAD Command to unload a kernel module [/sbin/kldunload]
31 # KMODISLOADED Command to check whether a kernel module is
32 # loaded [/sbin/kldstat -q -n]
34 # PROG The name of the kernel module to build.
35 # If not supplied, ${KMOD}.ko is used.
37 # SRCS List of source files.
39 # FIRMWS List of firmware images in format filename:shortname:version
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
45 # DESTDIR The tree where the module gets installed. [not set]
48 # Set to the location of the kernel build directory where
49 # the opt_*.h files, .o's and kernel winds up.
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
67 # Unload if loaded, then load.
71 KMODLOAD?= /sbin/kldload
72 KMODUNLOAD?= /sbin/kldunload
73 KMODISLOADED?= /sbin/kldstat -q -n
76 .include "kmod.opts.mk"
77 .include <bsd.sysdir.mk>
79 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
81 # amd64 and mips use direct linking for kmod, all others use shared binaries
82 .if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
88 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
89 CFLAGS+= -fno-strict-aliasing
91 .if ${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} < 50000
109 CFLAGS+= -DKLD_MODULE
110 .if defined(MODULE_TIED)
114 # Don't use any standard or source-relative include directories.
116 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
117 .if defined(KERNBUILDDIR)
118 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
121 CFLAGS+= -include ${.OBJDIR}/opt_global.h
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.
127 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
129 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
130 CFLAGS.gcc+= -fms-extensions
131 CFLAGS.gcc+= --param inline-unit-growth=100
132 CFLAGS.gcc+= --param large-function-growth=1000
134 # Disallow common variables, and if we end up with commons from
135 # somewhere unexpected, allocate storage for them in the module itself.
137 # -fno-common is the default for src builds, but this should be left in place
138 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
139 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
140 # CFLAGS for in-tree module builds as they will also pick it up from
141 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
144 LDFLAGS+= -d -warn-common
146 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
147 LDFLAGS+= --build-id=sha1
150 CFLAGS+= ${DEBUG_FLAGS}
151 .if ${MACHINE_CPUARCH} == amd64
152 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
155 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
156 ${MACHINE_CPUARCH} == "powerpc"
160 # Temporary workaround for PR 196407, which contains the fascinating details.
161 # Don't allow clang to use fpu instructions or registers in kernel modules.
162 .if ${MACHINE_CPUARCH} == arm
163 .if ${COMPILER_VERSION} < 30800
164 CFLAGS.clang+= -mllvm -arm-use-movt=0
166 CFLAGS.clang+= -mno-movt
168 CFLAGS.clang+= -mfpu=none
169 CFLAGS+= -funwind-tables
172 .if ${MACHINE_CPUARCH} == powerpc
173 CFLAGS+= -mlongcall -fno-omit-frame-pointer
174 .if ${LINKER_TYPE} == "lld"
175 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
176 LDFLAGS+= --no-toc-optimize
180 .if ${MACHINE_CPUARCH} == mips
181 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
184 .if defined(DEBUG) || defined(DEBUG_FLAGS)
189 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
190 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
191 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
193 SRCS+= ${KMOD:S/$/.c/}
194 CLEANFILES+= ${KMOD:S/$/.c/}
196 .for _firmw in ${FIRMWS}
197 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
198 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
199 @if [ -e ${_firmw:C/\:.*$//} ]; then \
200 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
201 -m ${LD_EMULATION} -r -d \
202 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
204 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
205 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
206 -m ${LD_EMULATION} -r -d \
207 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
208 rm ${_firmw:C/\:.*$//}; \
211 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
215 # Conditionally include SRCS based on kernel config options.
216 .for _o in ${KERN_OPTS}
220 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
226 .if !defined(DEBUG_FLAGS)
229 FULLPROG= ${PROG}.full
230 ${PROG}: ${FULLPROG} ${PROG}.debug
231 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
232 ${FULLPROG} ${.TARGET}
233 ${PROG}.debug: ${FULLPROG}
234 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
237 .if ${__KLD_SHARED} == yes
238 ${FULLPROG}: ${KMOD}.kld
239 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
240 -o ${.TARGET} ${KMOD}.kld
241 .if !defined(DEBUG_FLAGS)
242 ${OBJCOPY} --strip-debug ${.TARGET}
247 .if ${EXPORT_SYMS} != YES
248 CLEANFILES+= export_syms
251 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
252 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
255 .if ${__KLD_SHARED} == yes
260 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
261 -o ${.TARGET} ${OBJS}
262 .if ${MK_CTF} != "no"
263 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
265 .if defined(EXPORT_SYMS)
266 .if ${EXPORT_SYMS} != YES
267 .if ${EXPORT_SYMS} == NO
269 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
270 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
272 grep -v '^#' < ${EXPORT_SYMS} > export_syms
274 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
275 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
277 .endif # defined(EXPORT_SYMS)
278 .if defined(PREFIX_SYMS)
279 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
280 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
282 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
283 ${OBJCOPY} --strip-debug ${.TARGET}
286 .if ${COMPILER_TYPE} == "clang" || \
287 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
288 _MAP_DEBUG_PREFIX= yes
292 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
295 CLEANFILES+=${_ILINKS}
299 beforedepend: ${_ILINKS}
300 beforebuild: ${_ILINKS}
302 # Ensure that the links exist without depending on it when it exists which
303 # causes all the modules to be rebuilt when the directory pointed to changes.
304 # Ensure that debug info references the path in the source tree.
305 .for _link in ${_ILINKS}
306 .if !exists(${.OBJDIR}/${_link})
307 OBJS_DEPEND_GUESS+= ${_link}
309 .if defined(_MAP_DEBUG_PREFIX)
310 .if ${_link} == "machine"
311 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
313 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
321 @case ${.TARGET} in \
323 path=${SYSDIR}/${MACHINE}/include ;; \
325 path=${SYSDIR}/${.TARGET:T}/include ;; \
327 path=`(cd $$path && /bin/pwd)` ; \
328 ${ECHO} ${.TARGET:T} "->" $$path ; \
329 ln -fns $$path ${.TARGET:T}
331 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
333 .if defined(DEBUG_FLAGS)
334 CLEANFILES+= ${FULLPROG} ${PROG}.debug
339 _INSTALLFLAGS:= ${INSTALLFLAGS}
340 .for ie in ${INSTALLFLAGS_EDIT}
341 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
344 .if !target(realinstall)
345 KERN_DEBUGDIR?= ${DEBUGDIR}
346 realinstall: _kmodinstall
347 .ORDER: beforeinstall _kmodinstall
349 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
350 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
351 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
352 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
353 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
356 .include <bsd.links.mk>
358 .if !defined(NO_XREF)
359 afterinstall: _kldxref
360 .ORDER: realinstall _kldxref
361 .ORDER: _installlinks _kldxref
363 @if type kldxref >/dev/null 2>&1; then \
364 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
365 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
368 .endif # !target(realinstall)
370 .endif # !target(install)
374 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
379 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
383 reload: unload load .PHONY
386 .if defined(KERNBUILDDIR)
387 .PATH: ${KERNBUILDDIR}
388 CFLAGS+= -I${KERNBUILDDIR}
389 .for _src in ${SRCS:Mopt_*.h}
393 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
397 .for _src in ${SRCS:Mopt_*.h}
406 # Add the sanitizer C flags
407 CFLAGS+= ${SAN_CFLAGS}
410 CFLAGS+= ${GCOV_CFLAGS}
412 # Respect configuration-specific C flags.
413 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
415 .if !empty(SRCS:Mvnode_if.c)
416 CLEANFILES+= vnode_if.c
417 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
418 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
421 .if !empty(SRCS:Mvnode_if.h)
422 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
423 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
424 ${SYSDIR}/kern/vnode_if.src
425 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
426 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
428 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
430 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
433 # Build _if.[ch] from _if.m, and clean them when we're done.
434 # __MPATH defined in config.mk
435 _MFILES=${__MPATH:T:O}
436 _MPATH=${__MPATH:H:O:u}
438 .for _i in ${SRCS:M*_if.[ch]}
439 _MATCH=M${_i:R:S/$/.m/}
440 _MATCHES=${_MFILES:${_MATCH}}
445 .m.c: ${SYSDIR}/tools/makeobjops.awk
446 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
448 .m.h: ${SYSDIR}/tools/makeobjops.awk
449 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
451 .for _i in mii pccard
452 .if !empty(SRCS:M${_i}devs.h)
453 CLEANFILES+= ${_i}devs.h
454 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
455 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
459 .if !empty(SRCS:Mbhnd_nvram_map.h)
460 CLEANFILES+= bhnd_nvram_map.h
461 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
462 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
463 ${SYSDIR}/dev/bhnd/nvram/nvram_map
465 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
466 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
469 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
470 CLEANFILES+= bhnd_nvram_map_data.h
471 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
472 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
473 ${SYSDIR}/dev/bhnd/nvram/nvram_map
474 bhnd_nvram_map_data.h:
475 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
476 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
479 .if !empty(SRCS:Musbdevs.h)
480 CLEANFILES+= usbdevs.h
481 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
482 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
485 .if !empty(SRCS:Musbdevs_data.h)
486 CLEANFILES+= usbdevs_data.h
487 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
488 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
491 .if !empty(SRCS:Msdiodevs.h)
492 CLEANFILES+= sdiodevs.h
493 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
494 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
497 .if !empty(SRCS:Msdiodevs_data.h)
498 CLEANFILES+= sdiodevs_data.h
499 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
500 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
503 .if !empty(SRCS:Macpi_quirks.h)
504 CLEANFILES+= acpi_quirks.h
505 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
506 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
509 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
510 CLEANFILES+= assym.inc genassym.o
511 DEPENDOBJS+= genassym.o
514 .if defined(MODULE_TIED)
517 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
518 CLEANFILES+= offset.inc genoffset.o
519 DEPENDOBJS+= genoffset.o
521 assym.inc: genassym.o
522 offset.inc: genoffset.o
523 assym.inc: ${SYSDIR}/kern/genassym.sh
524 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
525 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
526 genassym.o: ${SRCS:Mopt_*.h}
527 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
528 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
529 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
530 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
531 genoffset.o: ${SYSDIR}/kern/genoffset.c
532 genoffset.o: ${SRCS:Mopt_*.h}
533 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
534 ${SYSDIR}/kern/genoffset.c
536 CLEANDEPENDFILES+= ${_ILINKS}
537 # .depend needs include links so we remove them only together.
541 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
542 .if defined(KERNBUILDDIR)
543 OBJS_DEPEND_GUESS+= opt_global.h
546 .include <bsd.dep.mk>
547 .include <bsd.clang-analyze.mk>
548 .include <bsd.obj.mk>