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 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
167 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
168 ${MACHINE_CPUARCH} == "powerpc"
172 # Temporary workaround for PR 196407, which contains the fascinating details.
173 # Don't allow clang to use fpu instructions or registers in kernel modules.
174 .if ${MACHINE_CPUARCH} == arm
175 CFLAGS.clang+= -mno-movt
176 CFLAGS.clang+= -mfpu=none
177 CFLAGS+= -funwind-tables
180 .if ${MACHINE_CPUARCH} == powerpc
181 CFLAGS+= -mlongcall -fno-omit-frame-pointer
182 .if ${LINKER_TYPE} == "lld"
183 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
184 LDFLAGS+= --no-toc-optimize
188 .if defined(DEBUG) || defined(DEBUG_FLAGS)
193 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
194 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
195 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
197 SRCS+= ${KMOD:S/$/.c/}
198 CLEANFILES+= ${KMOD:S/$/.c/}
200 .for _firmw in ${FIRMWS}
201 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//} ${SYSDIR}/kern/firmw.S
202 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
203 ${CC:N${CCACHE_BIN}} -c -x assembler-with-cpp -DLOCORE \
204 ${CFLAGS} ${WERROR} \
205 -DFIRMW_FILE="${.ALLSRC:M*${_firmw:C/\:.*$//}}" \
206 -DFIRMW_SYMBOL="${_firmw:C/\:.*$//:C/[-.\/@]/_/g}" \
207 ${SYSDIR}/kern/firmw.S -o ${.TARGET}
209 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
213 # Conditionally include SRCS based on kernel config options.
214 .for _o in ${KERN_OPTS}
218 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
224 .if !defined(DEBUG_FLAGS) || ${MK_SPLIT_KERNEL_DEBUG} == "no"
227 FULLPROG= ${PROG}.full
228 ${PROG}: ${FULLPROG} ${PROG}.debug
229 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
230 ${FULLPROG} ${.TARGET}
231 ${PROG}.debug: ${FULLPROG}
232 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
235 .if ${__KLD_SHARED} == yes
236 ${FULLPROG}: ${KMOD}.kld
237 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
238 -o ${.TARGET} ${KMOD}.kld
239 .if !defined(DEBUG_FLAGS)
240 ${OBJCOPY} --strip-debug ${.TARGET}
245 .if ${EXPORT_SYMS} != YES
246 CLEANFILES+= export_syms
249 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE})
250 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE}
253 .if ${__KLD_SHARED} == yes
254 ${KMOD}.kld: ${OBJS} ${BLOB_OBJS}
256 ${FULLPROG}: ${OBJS} ${BLOB_OBJS}
258 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r \
259 -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
260 .if ${MK_CTF} != "no"
261 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
263 .if defined(EXPORT_SYMS)
264 .if ${EXPORT_SYMS} != YES
265 .if ${EXPORT_SYMS} == NO
267 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
268 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
270 grep -v '^#' < ${EXPORT_SYMS} > export_syms
272 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
273 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
275 .endif # defined(EXPORT_SYMS)
276 .if defined(PREFIX_SYMS)
277 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
278 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
280 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
281 ${OBJCOPY} --strip-debug ${.TARGET}
284 _MAP_DEBUG_PREFIX= yes
287 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
290 .if ${MACHINE_CPUARCH} == "amd64"
293 CLEANFILES+=${_ILINKS}
297 beforedepend: ${_ILINKS}
298 beforebuild: ${_ILINKS}
300 # Ensure that the links exist without depending on it when it exists which
301 # causes all the modules to be rebuilt when the directory pointed to changes.
302 # Ensure that debug info references the path in the source tree.
303 .for _link in ${_ILINKS}
304 .if !exists(${.OBJDIR}/${_link})
305 OBJS_DEPEND_GUESS+= ${_link}
307 .if defined(_MAP_DEBUG_PREFIX)
308 .if ${_link} == "machine"
309 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
311 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
319 @case ${.TARGET} in \
321 path=${SYSDIR}/${MACHINE}/include ;; \
323 path=${SYSDIR}/${.TARGET:T}/include ;; \
325 path=`realpath $$path`; \
326 ${ECHO} ${.TARGET:T} "->" $$path ; \
327 ln -fns $$path ${.TARGET:T}
329 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
331 .if defined(DEBUG_FLAGS) && ${MK_SPLIT_KERNEL_DEBUG} != "no"
332 CLEANFILES+= ${FULLPROG} ${PROG}.debug
337 _INSTALLFLAGS:= ${INSTALLFLAGS}
338 .for ie in ${INSTALLFLAGS_EDIT}
339 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
342 .if !target(realinstall)
343 KERN_DEBUGDIR?= ${DEBUGDIR}
344 realinstall: _kmodinstall
345 .ORDER: beforeinstall _kmodinstall
347 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
348 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
349 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
350 ${INSTALL} -T dbg -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
351 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
354 .include <bsd.links.mk>
356 .if !defined(NO_XREF)
357 afterinstall: _kldxref
358 .ORDER: realinstall _kldxref
359 .ORDER: _installlinks _kldxref
361 @if type kldxref >/dev/null 2>&1; then \
362 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
363 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
366 .endif # !target(realinstall)
368 .endif # !target(install)
372 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
377 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
381 reload: unload load .PHONY
384 .if defined(KERNBUILDDIR)
385 .PATH: ${KERNBUILDDIR}
386 CFLAGS+= -I${KERNBUILDDIR}
387 .for _src in ${SRCS:Mopt_*.h}
391 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
395 .for _src in ${SRCS:Mopt_*.h}
404 # Add the sanitizer C flags
405 CFLAGS+= ${SAN_CFLAGS}
408 CFLAGS+= ${GCOV_CFLAGS}
410 # Respect configuration-specific C flags.
411 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
413 .if !empty(SRCS:Mvnode_if.c)
414 CLEANFILES+= vnode_if.c
415 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
416 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
419 .if !empty(SRCS:Mvnode_if.h)
420 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
421 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
422 ${SYSDIR}/kern/vnode_if.src
423 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
424 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
426 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
428 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
431 # Build _if.[ch] from _if.m, and clean them when we're done.
432 # __MPATH defined in config.mk
433 _MFILES=${__MPATH:T:O}
434 _MPATH=${__MPATH:H:O:u}
436 .for _i in ${SRCS:M*_if.[ch]}
437 _MATCH=M${_i:R:S/$/.m/}
438 _MATCHES=${_MFILES:${_MATCH}}
443 .m.c: ${SYSDIR}/tools/makeobjops.awk
444 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
446 .m.h: ${SYSDIR}/tools/makeobjops.awk
447 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
449 .for _i in mii pccard
450 .if !empty(SRCS:M${_i}devs.h)
451 CLEANFILES+= ${_i}devs.h
452 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
453 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
457 .if !empty(SRCS:Mbhnd_nvram_map.h)
458 CLEANFILES+= bhnd_nvram_map.h
459 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
460 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
461 ${SYSDIR}/dev/bhnd/nvram/nvram_map
463 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
464 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
467 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
468 CLEANFILES+= bhnd_nvram_map_data.h
469 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
470 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
471 ${SYSDIR}/dev/bhnd/nvram/nvram_map
472 bhnd_nvram_map_data.h:
473 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
474 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
477 .if !empty(SRCS:Musbdevs.h)
478 CLEANFILES+= usbdevs.h
479 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
480 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
483 .if !empty(SRCS:Musbdevs_data.h)
484 CLEANFILES+= usbdevs_data.h
485 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
486 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
489 .if !empty(SRCS:Msdiodevs.h)
490 CLEANFILES+= sdiodevs.h
491 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
492 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
495 .if !empty(SRCS:Msdiodevs_data.h)
496 CLEANFILES+= sdiodevs_data.h
497 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
498 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
501 .if !empty(SRCS:Macpi_quirks.h)
502 CLEANFILES+= acpi_quirks.h
503 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
504 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
507 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
508 CLEANFILES+= assym.inc genassym.o
509 DEPENDOBJS+= genassym.o
512 .if defined(MODULE_TIED)
515 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
516 CLEANFILES+= offset.inc genoffset.o
517 DEPENDOBJS+= genoffset.o
519 assym.inc: genassym.o
520 offset.inc: genoffset.o
521 assym.inc: ${SYSDIR}/kern/genassym.sh
522 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
523 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
524 genassym.o: ${SRCS:Mopt_*.h}
525 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
526 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
527 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
528 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
529 genoffset.o: ${SYSDIR}/kern/genoffset.c
530 genoffset.o: ${SRCS:Mopt_*.h}
531 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
532 ${SYSDIR}/kern/genoffset.c
534 CLEANDEPENDFILES+= ${_ILINKS}
535 # .depend needs include links so we remove them only together.
539 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
540 .if defined(KERNBUILDDIR)
541 OBJS_DEPEND_GUESS+= opt_global.h
544 ZINCDIR=${SYSDIR}/contrib/openzfs/include
551 -I${ZINCDIR}/os/freebsd \
552 -I${ZINCDIR}/os/freebsd/spl \
553 -I${ZINCDIR}/os/freebsd/zfs \
554 -I${SYSDIR}/cddl/compat/opensolaris \
555 -I${SYSDIR}/cddl/contrib/opensolaris/uts/common \
556 -include ${ZINCDIR}/os/freebsd/spl/sys/ccompile.h
557 OPENZFS_CWARNFLAGS= \
560 .include <bsd.dep.mk>
561 .include <bsd.clang-analyze.mk>
562 .include <bsd.obj.mk>