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]
47 # KERNBUILDDIR Set to the location of the kernel build directory where
48 # the opt_*.h files, .o's and kernel winds up.
50 # BLOB_OBJS Prebuilt binary blobs .o's from the src tree to be linked into
51 # the module. These are precious and not removed in make clean.
56 # install the kernel module; if the Makefile
57 # does not itself define the target install, the targets
58 # beforeinstall and afterinstall may also be used to cause
59 # actions immediately before and after the install target
69 # Unload if loaded, then load.
73 KMODLOAD?= /sbin/kldload
74 KMODUNLOAD?= /sbin/kldunload
75 KMODISLOADED?= /sbin/kldstat -q -n
78 .include "kmod.opts.mk"
79 .include <bsd.sysdir.mk>
81 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
83 # amd64 uses direct linking for kmod, all others use shared binaries
84 .if ${MACHINE_CPUARCH} != amd64
90 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
91 CFLAGS+= -fno-strict-aliasing
111 LINUXKPI_INCLUDES+= \
112 -I${SYSDIR}/compat/linuxkpi/common/include \
113 -I${SYSDIR}/compat/linuxkpi/dummy/include
117 CFLAGS+= -DKLD_MODULE
118 .if defined(MODULE_TIED)
122 # Don't use any standard or source-relative include directories.
124 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
125 .if defined(KERNBUILDDIR)
126 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
129 CFLAGS+= -include ${.OBJDIR}/opt_global.h
132 # Add -I paths for system headers. Individual module makefiles don't
133 # need any -I paths for this. Similar defaults for .PATH can't be
134 # set because there are no standard paths for non-headers.
135 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
137 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
138 CFLAGS.gcc+= -fms-extensions
139 CFLAGS.gcc+= --param inline-unit-growth=100
140 CFLAGS.gcc+= --param large-function-growth=1000
142 # Disallow common variables, and if we end up with commons from
143 # somewhere unexpected, allocate storage for them in the module itself.
145 # -fno-common is the default for src builds, but this should be left in place
146 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
147 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
148 # CFLAGS for in-tree module builds as they will also pick it up from
149 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
152 .if ${LINKER_TYPE} != "lld" || ${LINKER_VERSION} < 140000
153 # lld >= 14 warns that -d is deprecated, and will be removed.
156 LDFLAGS+= -warn-common
158 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
159 LDFLAGS+= --build-id=sha1
162 CFLAGS+= ${DEBUG_FLAGS}
163 .if ${MACHINE_CPUARCH} == aarch64 || ${MACHINE_CPUARCH} == amd64 || \
164 ${MACHINE_CPUARCH} == riscv
165 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
168 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
169 ${MACHINE_CPUARCH} == "powerpc"
173 # Temporary workaround for PR 196407, which contains the fascinating details.
174 # Don't allow clang to use fpu instructions or registers in kernel modules.
175 .if ${MACHINE_CPUARCH} == arm
176 CFLAGS.clang+= -mno-movt
177 CFLAGS.clang+= -mfpu=none
178 CFLAGS+= -funwind-tables
181 .if ${MACHINE_CPUARCH} == powerpc
182 CFLAGS+= -mlongcall -fno-omit-frame-pointer
183 .if ${LINKER_TYPE} == "lld"
184 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
185 LDFLAGS+= --no-toc-optimize
189 .if defined(DEBUG) || defined(DEBUG_FLAGS)
194 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
195 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
196 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
198 SRCS+= ${KMOD:S/$/.c/}
199 CLEANFILES+= ${KMOD:S/$/.c/}
201 .for _firmw in ${FIRMWS}
202 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//} ${SYSDIR}/kern/firmw.S
203 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
204 ${CC:N${CCACHE_BIN}} -c -x assembler-with-cpp -DLOCORE \
205 ${CFLAGS} ${WERROR} \
206 -DFIRMW_FILE="${.ALLSRC:M*${_firmw:C/\:.*$//}}" \
207 -DFIRMW_SYMBOL="${_firmw:C/\:.*$//:C/[-.\/@]/_/g}" \
208 ${SYSDIR}/kern/firmw.S -o ${.TARGET}
210 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
214 # Conditionally include SRCS based on kernel config options.
215 .for _o in ${KERN_OPTS}
219 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
225 .if !defined(DEBUG_FLAGS) || ${MK_SPLIT_KERNEL_DEBUG} == "no"
228 FULLPROG= ${PROG}.full
229 ${PROG}: ${FULLPROG} ${PROG}.debug
230 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
231 ${FULLPROG} ${.TARGET}
232 ${PROG}.debug: ${FULLPROG}
233 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
236 .if ${__KLD_SHARED} == yes
237 ${FULLPROG}: ${KMOD}.kld
238 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
239 -o ${.TARGET} ${KMOD}.kld
240 .if !defined(DEBUG_FLAGS)
241 ${OBJCOPY} --strip-debug ${.TARGET}
246 .if ${EXPORT_SYMS} != YES
247 CLEANFILES+= export_syms
250 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE})
251 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE}
254 .if ${__KLD_SHARED} == yes
255 ${KMOD}.kld: ${OBJS} ${BLOB_OBJS}
257 ${FULLPROG}: ${OBJS} ${BLOB_OBJS}
259 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r \
260 -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
261 .if ${MK_CTF} != "no"
262 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
264 .if defined(EXPORT_SYMS)
265 .if ${EXPORT_SYMS} != YES
266 .if ${EXPORT_SYMS} == NO
268 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
269 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
271 grep -v '^#' < ${EXPORT_SYMS} > export_syms
273 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
274 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
276 .endif # defined(EXPORT_SYMS)
277 .if defined(PREFIX_SYMS)
278 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
279 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
281 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
282 ${OBJCOPY} --strip-debug ${.TARGET}
286 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
289 .if ${MACHINE_CPUARCH} == "amd64"
292 CLEANFILES+=${_ILINKS}
296 beforedepend: ${_ILINKS}
297 beforebuild: ${_ILINKS}
299 # Ensure that the links exist without depending on it when it exists which
300 # causes all the modules to be rebuilt when the directory pointed to changes.
301 # Ensure that debug info references the path in the source tree.
302 .for _link in ${_ILINKS}
303 .if !exists(${.OBJDIR}/${_link})
304 OBJS_DEPEND_GUESS+= ${_link}
306 .if ${_link} == "machine"
307 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
309 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
316 @case ${.TARGET} in \
318 path=${SYSDIR}/${MACHINE}/include ;; \
320 path=${SYSDIR}/${.TARGET:T}/include ;; \
322 path=`realpath $$path`; \
323 ${ECHO} ${.TARGET:T} "->" $$path ; \
324 ln -fns $$path ${.TARGET:T}
326 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
328 .if defined(DEBUG_FLAGS) && ${MK_SPLIT_KERNEL_DEBUG} != "no"
329 CLEANFILES+= ${FULLPROG} ${PROG}.debug
334 _INSTALLFLAGS:= ${INSTALLFLAGS}
335 .for ie in ${INSTALLFLAGS_EDIT}
336 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
339 .if !target(realinstall)
340 KERN_DEBUGDIR?= ${DEBUGDIR}
341 realinstall: _kmodinstall
342 .ORDER: beforeinstall _kmodinstall
344 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
345 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
346 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
347 ${INSTALL} -T dbg -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
348 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
351 .include <bsd.links.mk>
353 .if !defined(NO_XREF)
354 afterinstall: _kldxref
355 .ORDER: realinstall _kldxref
356 .ORDER: _installlinks _kldxref
358 @if type kldxref >/dev/null 2>&1; then \
359 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
360 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
363 .endif # !target(realinstall)
365 .endif # !target(install)
369 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
374 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
378 reload: unload load .PHONY
381 .if defined(KERNBUILDDIR)
382 .PATH: ${KERNBUILDDIR}
383 CFLAGS+= -I${KERNBUILDDIR}
384 .for _src in ${SRCS:Mopt_*.h}
388 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
392 .for _src in ${SRCS:Mopt_*.h}
401 # Add the sanitizer C flags
402 CFLAGS+= ${SAN_CFLAGS}
405 CFLAGS+= ${GCOV_CFLAGS}
407 # Respect configuration-specific C flags.
408 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
410 .if !empty(SRCS:Mvnode_if.c)
411 CLEANFILES+= vnode_if.c
412 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
413 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
416 .if !empty(SRCS:Mvnode_if.h)
417 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
418 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
419 ${SYSDIR}/kern/vnode_if.src
420 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
421 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
423 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
425 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
428 # Build _if.[ch] from _if.m, and clean them when we're done.
429 # __MPATH defined in config.mk
430 _MFILES=${__MPATH:T:O}
431 _MPATH=${__MPATH:H:O:u}
433 .for _i in ${SRCS:M*_if.[ch]}
434 _MATCH=M${_i:R:S/$/.m/}
435 _MATCHES=${_MFILES:${_MATCH}}
440 .m.c: ${SYSDIR}/tools/makeobjops.awk
441 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
443 .m.h: ${SYSDIR}/tools/makeobjops.awk
444 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
446 .for _i in mii pccard
447 .if !empty(SRCS:M${_i}devs.h)
448 CLEANFILES+= ${_i}devs.h
449 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
450 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
454 .if !empty(SRCS:Mbhnd_nvram_map.h)
455 CLEANFILES+= bhnd_nvram_map.h
456 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
457 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
458 ${SYSDIR}/dev/bhnd/nvram/nvram_map
460 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
461 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
464 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
465 CLEANFILES+= bhnd_nvram_map_data.h
466 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
467 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
468 ${SYSDIR}/dev/bhnd/nvram/nvram_map
469 bhnd_nvram_map_data.h:
470 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
471 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
474 .if !empty(SRCS:Musbdevs.h)
475 CLEANFILES+= usbdevs.h
476 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
477 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
480 .if !empty(SRCS:Musbdevs_data.h)
481 CLEANFILES+= usbdevs_data.h
482 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
483 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
486 .if !empty(SRCS:Msdiodevs.h)
487 CLEANFILES+= sdiodevs.h
488 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
489 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
492 .if !empty(SRCS:Msdiodevs_data.h)
493 CLEANFILES+= sdiodevs_data.h
494 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
495 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
498 .if !empty(SRCS:Macpi_quirks.h)
499 CLEANFILES+= acpi_quirks.h
500 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
501 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
504 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
505 CLEANFILES+= assym.inc genassym.o
506 DEPENDOBJS+= genassym.o
509 .if defined(MODULE_TIED)
512 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
513 CLEANFILES+= offset.inc genoffset.o
514 DEPENDOBJS+= genoffset.o
516 assym.inc: genassym.o
517 offset.inc: genoffset.o
518 assym.inc: ${SYSDIR}/kern/genassym.sh
519 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
520 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
521 genassym.o: ${SRCS:Mopt_*.h}
522 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
523 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
524 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
525 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
526 genoffset.o: ${SYSDIR}/kern/genoffset.c
527 genoffset.o: ${SRCS:Mopt_*.h}
528 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
529 ${SYSDIR}/kern/genoffset.c
531 CLEANDEPENDFILES+= ${_ILINKS}
532 # .depend needs include links so we remove them only together.
536 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
537 .if defined(KERNBUILDDIR)
538 OBJS_DEPEND_GUESS+= opt_global.h
541 ZINCDIR=${SYSDIR}/contrib/openzfs/include
548 -I${ZINCDIR}/os/freebsd \
549 -I${ZINCDIR}/os/freebsd/spl \
550 -I${ZINCDIR}/os/freebsd/zfs \
551 -I${SYSDIR}/cddl/compat/opensolaris \
552 -I${SYSDIR}/cddl/contrib/opensolaris/uts/common \
553 -include ${ZINCDIR}/os/freebsd/spl/sys/ccompile.h
555 .include <bsd.dep.mk>
556 .include <bsd.clang-analyze.mk>
557 .include <bsd.obj.mk>