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
113 CFLAGS+= -DKLD_MODULE
114 .if defined(MODULE_TIED)
118 # Don't use any standard or source-relative include directories.
120 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
121 .if defined(KERNBUILDDIR)
122 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
125 CFLAGS+= -include ${.OBJDIR}/opt_global.h
128 # Add -I paths for system headers. Individual module makefiles don't
129 # need any -I paths for this. Similar defaults for .PATH can't be
130 # set because there are no standard paths for non-headers.
131 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
133 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
134 CFLAGS.gcc+= -fms-extensions
135 CFLAGS.gcc+= --param inline-unit-growth=100
136 CFLAGS.gcc+= --param large-function-growth=1000
138 # Disallow common variables, and if we end up with commons from
139 # somewhere unexpected, allocate storage for them in the module itself.
141 # -fno-common is the default for src builds, but this should be left in place
142 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
143 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
144 # CFLAGS for in-tree module builds as they will also pick it up from
145 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
148 .if ${LINKER_TYPE} != "lld" || ${LINKER_VERSION} < 140000
149 # lld >= 14 warns that -d is deprecated, and will be removed.
152 LDFLAGS+= -warn-common
154 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
155 LDFLAGS+= --build-id=sha1
158 CFLAGS+= ${DEBUG_FLAGS}
159 .if ${MACHINE_CPUARCH} == aarch64 || ${MACHINE_CPUARCH} == amd64
160 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
163 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
164 ${MACHINE_CPUARCH} == "powerpc"
168 # Temporary workaround for PR 196407, which contains the fascinating details.
169 # Don't allow clang to use fpu instructions or registers in kernel modules.
170 .if ${MACHINE_CPUARCH} == arm
171 CFLAGS.clang+= -mno-movt
172 CFLAGS.clang+= -mfpu=none
173 CFLAGS+= -funwind-tables
176 .if ${MACHINE_CPUARCH} == powerpc
177 CFLAGS+= -mlongcall -fno-omit-frame-pointer
178 .if ${LINKER_TYPE} == "lld"
179 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
180 LDFLAGS+= --no-toc-optimize
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/\:.*$//} ${SYSDIR}/kern/firmw.S
198 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
199 ${CC:N${CCACHE_BIN}} -c -x assembler-with-cpp -DLOCORE \
200 ${CFLAGS} ${WERROR} \
201 -DFIRMW_FILE="${.ALLSRC:M*${_firmw:C/\:.*$//}}" \
202 -DFIRMW_SYMBOL="${_firmw:C/\:.*$//:C/[-.\/@]/_/g}" \
203 ${SYSDIR}/kern/firmw.S -o ${.TARGET}
205 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
209 # Conditionally include SRCS based on kernel config options.
210 .for _o in ${KERN_OPTS}
214 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
220 .if !defined(DEBUG_FLAGS) || ${MK_SPLIT_KERNEL_DEBUG} == "no"
223 FULLPROG= ${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}
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}
241 .if ${EXPORT_SYMS} != YES
242 CLEANFILES+= export_syms
245 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE})
246 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE}
249 .if ${__KLD_SHARED} == yes
250 ${KMOD}.kld: ${OBJS} ${BLOB_OBJS}
252 ${FULLPROG}: ${OBJS} ${BLOB_OBJS}
254 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r \
255 -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
256 .if ${MK_CTF} != "no"
257 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
259 .if defined(EXPORT_SYMS)
260 .if ${EXPORT_SYMS} != YES
261 .if ${EXPORT_SYMS} == NO
263 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
264 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
266 grep -v '^#' < ${EXPORT_SYMS} > export_syms
268 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
269 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
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}
276 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
277 ${OBJCOPY} --strip-debug ${.TARGET}
280 _MAP_DEBUG_PREFIX= yes
283 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
286 .if ${MACHINE_CPUARCH} == "amd64"
289 CLEANFILES+=${_ILINKS}
293 beforedepend: ${_ILINKS}
294 beforebuild: ${_ILINKS}
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})
301 OBJS_DEPEND_GUESS+= ${_link}
303 .if defined(_MAP_DEBUG_PREFIX)
304 .if ${_link} == "machine"
305 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
307 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
315 @case ${.TARGET} in \
317 path=${SYSDIR}/${MACHINE}/include ;; \
319 path=${SYSDIR}/${.TARGET:T}/include ;; \
321 path=`realpath $$path`; \
322 ${ECHO} ${.TARGET:T} "->" $$path ; \
323 ln -fns $$path ${.TARGET:T}
325 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
327 .if defined(DEBUG_FLAGS) && ${MK_SPLIT_KERNEL_DEBUG} != "no"
328 CLEANFILES+= ${FULLPROG} ${PROG}.debug
333 _INSTALLFLAGS:= ${INSTALLFLAGS}
334 .for ie in ${INSTALLFLAGS_EDIT}
335 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
338 .if !target(realinstall)
339 KERN_DEBUGDIR?= ${DEBUGDIR}
340 realinstall: _kmodinstall
341 .ORDER: beforeinstall _kmodinstall
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 dbg -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
347 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
350 .include <bsd.links.mk>
352 .if !defined(NO_XREF)
353 afterinstall: _kldxref
354 .ORDER: realinstall _kldxref
355 .ORDER: _installlinks _kldxref
357 @if type kldxref >/dev/null 2>&1; then \
358 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
359 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
362 .endif # !target(realinstall)
364 .endif # !target(install)
368 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
373 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
377 reload: unload load .PHONY
380 .if defined(KERNBUILDDIR)
381 .PATH: ${KERNBUILDDIR}
382 CFLAGS+= -I${KERNBUILDDIR}
383 .for _src in ${SRCS:Mopt_*.h}
387 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
391 .for _src in ${SRCS:Mopt_*.h}
400 # Add the sanitizer C flags
401 CFLAGS+= ${SAN_CFLAGS}
404 CFLAGS+= ${GCOV_CFLAGS}
406 # Respect configuration-specific C flags.
407 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
409 .if !empty(SRCS:Mvnode_if.c)
410 CLEANFILES+= vnode_if.c
411 vnode_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
415 .if !empty(SRCS:Mvnode_if.h)
416 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
417 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
418 ${SYSDIR}/kern/vnode_if.src
419 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
420 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
422 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
424 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
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}
432 .for _i in ${SRCS:M*_if.[ch]}
433 _MATCH=M${_i:R:S/$/.m/}
434 _MATCHES=${_MFILES:${_MATCH}}
439 .m.c: ${SYSDIR}/tools/makeobjops.awk
440 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
442 .m.h: ${SYSDIR}/tools/makeobjops.awk
443 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
445 .for _i in mii pccard
446 .if !empty(SRCS:M${_i}devs.h)
447 CLEANFILES+= ${_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
453 .if !empty(SRCS:Mbhnd_nvram_map.h)
454 CLEANFILES+= bhnd_nvram_map.h
455 bhnd_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
459 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
460 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
463 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
464 CLEANFILES+= bhnd_nvram_map_data.h
465 bhnd_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
468 bhnd_nvram_map_data.h:
469 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
470 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
473 .if !empty(SRCS:Musbdevs.h)
474 CLEANFILES+= usbdevs.h
475 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
476 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
479 .if !empty(SRCS:Musbdevs_data.h)
480 CLEANFILES+= usbdevs_data.h
481 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
482 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
485 .if !empty(SRCS:Msdiodevs.h)
486 CLEANFILES+= sdiodevs.h
487 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
488 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
491 .if !empty(SRCS:Msdiodevs_data.h)
492 CLEANFILES+= sdiodevs_data.h
493 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
494 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
497 .if !empty(SRCS:Macpi_quirks.h)
498 CLEANFILES+= acpi_quirks.h
499 acpi_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
503 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
504 CLEANFILES+= assym.inc genassym.o
505 DEPENDOBJS+= genassym.o
508 .if defined(MODULE_TIED)
511 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
512 CLEANFILES+= offset.inc genoffset.o
513 DEPENDOBJS+= genoffset.o
515 assym.inc: genassym.o
516 offset.inc: genoffset.o
517 assym.inc: ${SYSDIR}/kern/genassym.sh
518 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
519 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
520 genassym.o: ${SRCS:Mopt_*.h}
521 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
522 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
523 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
524 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
525 genoffset.o: ${SYSDIR}/kern/genoffset.c
526 genoffset.o: ${SRCS:Mopt_*.h}
527 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
528 ${SYSDIR}/kern/genoffset.c
530 CLEANDEPENDFILES+= ${_ILINKS}
531 # .depend needs include links so we remove them only together.
535 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
536 .if defined(KERNBUILDDIR)
537 OBJS_DEPEND_GUESS+= opt_global.h
540 ZINCDIR=${SYSDIR}/contrib/openzfs/include
547 -I${ZINCDIR}/os/freebsd \
548 -I${ZINCDIR}/os/freebsd/spl \
549 -I${ZINCDIR}/os/freebsd/zfs \
550 -I${SYSDIR}/cddl/compat/opensolaris \
551 -I${SYSDIR}/cddl/contrib/opensolaris/uts/common \
552 -include ${ZINCDIR}/os/freebsd/spl/sys/ccompile.h
553 OPENZFS_CWARNFLAGS= \
556 .include <bsd.dep.mk>
557 .include <bsd.clang-analyze.mk>
558 .include <bsd.obj.mk>