1 # From: @(#)bsd.prog.mk 5.26 (Berkeley) 6/25/91
3 # The include file <bsd.kmod.mk> handles building and installing loadable
9 # CLEANFILES Additional files to remove for the clean and cleandir targets.
11 # EXPORT_SYMS A list of symbols that should be exported from the module,
12 # or the name of a file containing a list of symbols, or YES
13 # to export all symbols. If not defined, no symbols are
16 # KMOD The name of the kernel module to build.
18 # KMODDIR Base path for kernel modules (see kld(4)). [/boot/kernel]
20 # KMODOWN Module file owner. [${BINOWN}]
22 # KMODGRP Module file group. [${BINGRP}]
24 # KMODMODE Module file mode. [${BINMODE}]
26 # KMODLOAD Command to load a kernel module [/sbin/kldload]
28 # KMODUNLOAD Command to unload a kernel module [/sbin/kldunload]
30 # KMODISLOADED Command to check whether a kernel module is
31 # loaded [/sbin/kldstat -q -n]
33 # PROG The name of the kernel module to build.
34 # If not supplied, ${KMOD}.ko is used.
36 # SRCS List of source files.
38 # FIRMWS List of firmware images in format filename:shortname:version
41 # Set to the name of the license the user has to agree on in
42 # order to use this firmware. See /usr/share/doc/legal
44 # DESTDIR The tree where the module gets installed. [not set]
46 # KERNBUILDDIR Set to the location of the kernel build directory where
47 # the opt_*.h files, .o's and kernel winds up.
49 # BLOB_OBJS Prebuilt binary blobs .o's from the src tree to be linked into
50 # the module. These are precious and not removed in make clean.
55 # install the kernel module; if the Makefile
56 # does not itself define the target install, the targets
57 # beforeinstall and afterinstall may also be used to cause
58 # actions immediately before and after the install target
68 # Unload if loaded, then load.
72 KMODLOAD?= /sbin/kldload
73 KMODUNLOAD?= /sbin/kldunload
74 KMODISLOADED?= /sbin/kldstat -q -n
77 .include "kmod.opts.mk"
78 .include <bsd.sysdir.mk>
80 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
82 # amd64 uses direct linking for kmod, all others use shared binaries
83 .if ${MACHINE_CPUARCH} != amd64
89 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
90 CFLAGS+= -fno-strict-aliasing
110 LINUXKPI_INCLUDES+= \
111 -I${SYSDIR}/compat/linuxkpi/common/include \
112 -I${SYSDIR}/compat/linuxkpi/dummy/include
116 CFLAGS+= -DKLD_MODULE
117 .if defined(MODULE_TIED)
121 # Don't use any standard or source-relative include directories.
123 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
124 .if defined(KERNBUILDDIR)
125 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
128 CFLAGS+= -include ${.OBJDIR}/opt_global.h
131 # Add -I paths for system headers. Individual module makefiles don't
132 # need any -I paths for this. Similar defaults for .PATH can't be
133 # set because there are no standard paths for non-headers.
134 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
136 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
137 CFLAGS.gcc+= -fms-extensions
138 CFLAGS.gcc+= --param inline-unit-growth=100
139 CFLAGS.gcc+= --param large-function-growth=1000
141 # Disallow common variables, and if we end up with commons from
142 # somewhere unexpected, allocate storage for them in the module itself.
144 # -fno-common is the default for src builds, but this should be left in place
145 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
146 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
147 # CFLAGS for in-tree module builds as they will also pick it up from
148 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
151 .if ${LINKER_TYPE} != "lld" || ${LINKER_VERSION} < 140000
152 # lld >= 14 warns that -d is deprecated, and will be removed.
155 LDFLAGS+= -warn-common
157 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
158 LDFLAGS+= --build-id=sha1
161 CFLAGS+= ${DEBUG_FLAGS}
162 .if ${MACHINE_CPUARCH} == aarch64 || ${MACHINE_CPUARCH} == amd64 || \
163 ${MACHINE_CPUARCH} == riscv
164 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
167 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
168 ${MACHINE_CPUARCH} == "powerpc" || ${MACHINE_CPUARCH} == "i386"
172 .if ${MACHINE_CPUARCH} == "aarch64"
173 # https://bugs.freebsd.org/264094
174 # lld >= 14 and recent GNU ld can relax adrp+add and adrp+ldr instructions,
179 # Temporary workaround for PR 196407, which contains the fascinating details.
180 # Don't allow clang to use fpu instructions or registers in kernel modules.
181 .if ${MACHINE_CPUARCH} == arm
182 CFLAGS.clang+= -mno-movt
183 CFLAGS.clang+= -mfpu=none
184 CFLAGS+= -funwind-tables
187 .if ${MACHINE_CPUARCH} == powerpc
188 CFLAGS+= -mlongcall -fno-omit-frame-pointer
189 .if ${LINKER_TYPE} == "lld"
190 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
191 LDFLAGS+= --no-toc-optimize
195 .if defined(DEBUG) || defined(DEBUG_FLAGS)
200 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
201 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
202 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
204 SRCS+= ${KMOD:S/$/.c/}
205 CLEANFILES+= ${KMOD:S/$/.c/}
207 .for _firmw in ${FIRMWS}
208 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//} ${SYSDIR}/kern/firmw.S
209 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
210 ${CC:N${CCACHE_BIN}} -c -x assembler-with-cpp -DLOCORE \
211 ${CFLAGS} ${WERROR} \
212 -DFIRMW_FILE=\""${.ALLSRC:M*${_firmw:C/\:.*$//}}"\" \
213 -DFIRMW_SYMBOL="${_firmw:C/\:.*$//:C/[-.\/@]/_/g}" \
214 ${SYSDIR}/kern/firmw.S -o ${.TARGET}
216 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
220 # Conditionally include SRCS based on kernel config options.
221 .for _o in ${KERN_OPTS}
225 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
231 .if !defined(DEBUG_FLAGS) || ${MK_SPLIT_KERNEL_DEBUG} == "no"
234 FULLPROG= ${PROG}.full
235 ${PROG}: ${FULLPROG} ${PROG}.debug
236 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
237 ${FULLPROG} ${.TARGET}
238 ${PROG}.debug: ${FULLPROG}
239 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
242 .if ${__KLD_SHARED} == yes
243 ${FULLPROG}: ${KMOD}.kld
244 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
245 -o ${.TARGET} ${KMOD}.kld
246 .if !defined(DEBUG_FLAGS)
247 ${OBJCOPY} --strip-debug ${.TARGET}
252 .if ${EXPORT_SYMS} != YES
253 CLEANFILES+= export_syms
256 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE})
257 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE}
260 .if ${__KLD_SHARED} == yes
261 ${KMOD}.kld: ${OBJS} ${BLOB_OBJS}
263 ${FULLPROG}: ${OBJS} ${BLOB_OBJS}
265 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r \
266 -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
267 .if ${MK_CTF} != "no"
268 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS} ${BLOB_OBJS}
270 .if defined(EXPORT_SYMS)
271 .if ${EXPORT_SYMS} != YES
272 .if ${EXPORT_SYMS} == NO
274 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
275 printf '%s' "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
277 grep -v '^#' < ${EXPORT_SYMS} > export_syms
279 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
280 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
282 .endif # defined(EXPORT_SYMS)
283 .if defined(PREFIX_SYMS)
284 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
285 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
287 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
288 ${OBJCOPY} --strip-debug ${.TARGET}
292 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
295 .if ${MACHINE_CPUARCH} == "amd64"
298 CLEANFILES+=${_ILINKS}
302 beforedepend: ${_ILINKS}
303 beforebuild: ${_ILINKS}
305 # Ensure that the links exist without depending on it when it exists which
306 # causes all the modules to be rebuilt when the directory pointed to changes.
307 # Ensure that debug info references the path in the source tree.
308 .for _link in ${_ILINKS}
309 .if !exists(${.OBJDIR}/${_link})
310 OBJS_DEPEND_GUESS+= ${_link}
312 .if ${_link} == "machine"
313 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
315 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
322 @case ${.TARGET} in \
324 path=${SYSDIR}/${MACHINE}/include ;; \
326 path=${SYSDIR}/${.TARGET:T}/include ;; \
328 path=`realpath $$path`; \
329 ${ECHO} ${.TARGET:T} "->" $$path ; \
330 ln -fns $$path ${.TARGET:T}
332 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
334 .if defined(DEBUG_FLAGS) && ${MK_SPLIT_KERNEL_DEBUG} != "no"
335 CLEANFILES+= ${FULLPROG} ${PROG}.debug
340 _INSTALLFLAGS:= ${INSTALLFLAGS}
341 .for ie in ${INSTALLFLAGS_EDIT}
342 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
345 .if !target(realinstall)
346 KERN_DEBUGDIR?= ${DEBUGDIR}
347 realinstall: _kmodinstall
348 .ORDER: beforeinstall _kmodinstall
350 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
351 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
352 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
353 ${INSTALL} -T dbg -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
354 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
357 .include <bsd.links.mk>
359 .if !defined(NO_XREF)
360 afterinstall: _kldxref
361 .ORDER: realinstall _kldxref
362 .ORDER: _installlinks _kldxref
364 @if type kldxref >/dev/null 2>&1; then \
365 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
366 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
369 .endif # !target(realinstall)
371 .endif # !target(install)
375 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
380 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
384 reload: unload load .PHONY
387 .if defined(KERNBUILDDIR)
388 .PATH: ${KERNBUILDDIR}
389 CFLAGS+= -I${KERNBUILDDIR}
390 .for _src in ${SRCS:Mopt_*.h}
394 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
398 .for _src in ${SRCS:Mopt_*.h}
407 # Add the sanitizer C flags
408 CFLAGS+= ${SAN_CFLAGS}
411 CFLAGS+= ${GCOV_CFLAGS}
413 # Respect configuration-specific C flags.
414 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
416 .if !empty(SRCS:Mvnode_if.c)
417 CLEANFILES+= vnode_if.c
418 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
419 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
422 .if !empty(SRCS:Mvnode_if.h)
423 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
424 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
425 ${SYSDIR}/kern/vnode_if.src
426 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
427 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
429 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
431 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
434 # Build _if.[ch] from _if.m, and clean them when we're done.
435 # __MPATH defined in config.mk
436 _MFILES=${__MPATH:T:O}
437 _MPATH=${__MPATH:H:O:u}
439 .for _i in ${SRCS:M*_if.[ch]}
440 _MATCH=M${_i:R:S/$/.m/}
441 _MATCHES=${_MFILES:${_MATCH}}
446 .m.c: ${SYSDIR}/tools/makeobjops.awk
447 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
449 .m.h: ${SYSDIR}/tools/makeobjops.awk
450 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
452 .for _i in mii pccard
453 .if !empty(SRCS:M${_i}devs.h)
454 CLEANFILES+= ${_i}devs.h
455 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
456 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
460 .if !empty(SRCS:Mbhnd_nvram_map.h)
461 CLEANFILES+= bhnd_nvram_map.h
462 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
463 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
464 ${SYSDIR}/dev/bhnd/nvram/nvram_map
466 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
467 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
470 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
471 CLEANFILES+= bhnd_nvram_map_data.h
472 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
473 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
474 ${SYSDIR}/dev/bhnd/nvram/nvram_map
475 bhnd_nvram_map_data.h:
476 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
477 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
480 .if !empty(SRCS:Musbdevs.h)
481 CLEANFILES+= usbdevs.h
482 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
483 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
486 .if !empty(SRCS:Musbdevs_data.h)
487 CLEANFILES+= usbdevs_data.h
488 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
489 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
492 .if !empty(SRCS:Msdiodevs.h)
493 CLEANFILES+= sdiodevs.h
494 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
495 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
498 .if !empty(SRCS:Msdiodevs_data.h)
499 CLEANFILES+= sdiodevs_data.h
500 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
501 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
504 .if !empty(SRCS:Macpi_quirks.h)
505 CLEANFILES+= acpi_quirks.h
506 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
507 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
510 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
511 CLEANFILES+= assym.inc genassym.o
512 DEPENDOBJS+= genassym.o
515 .if defined(MODULE_TIED)
518 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
519 CLEANFILES+= offset.inc genoffset.o
520 DEPENDOBJS+= genoffset.o
522 assym.inc: genassym.o
523 offset.inc: genoffset.o
524 assym.inc: ${SYSDIR}/kern/genassym.sh
525 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
526 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
527 genassym.o: ${SRCS:Mopt_*.h}
528 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
529 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
530 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
531 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
532 genoffset.o: ${SYSDIR}/kern/genoffset.c
533 genoffset.o: ${SRCS:Mopt_*.h}
534 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
535 ${SYSDIR}/kern/genoffset.c
537 CLEANDEPENDFILES+= ${_ILINKS}
538 # .depend needs include links so we remove them only together.
542 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
543 .if defined(KERNBUILDDIR)
544 OBJS_DEPEND_GUESS+= opt_global.h
547 ZINCDIR=${SYSDIR}/contrib/openzfs/include
554 -I${ZINCDIR}/os/freebsd \
555 -I${ZINCDIR}/os/freebsd/spl \
556 -I${ZINCDIR}/os/freebsd/zfs \
557 -I${SYSDIR}/cddl/compat/opensolaris \
558 -I${SYSDIR}/cddl/contrib/opensolaris/uts/common \
559 -include ${ZINCDIR}/os/freebsd/spl/sys/ccompile.h
561 .include <bsd.dep.mk>
562 .include <bsd.clang-analyze.mk>
563 .include <bsd.obj.mk>