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
105 CFLAGS+= -DKLD_MODULE
106 .if defined(MODULE_TIED)
110 # Don't use any standard or source-relative include directories.
112 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
113 .if defined(KERNBUILDDIR)
114 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
117 CFLAGS+= -include ${.OBJDIR}/opt_global.h
120 # Add -I paths for system headers. Individual module makefiles don't
121 # need any -I paths for this. Similar defaults for .PATH can't be
122 # set because there are no standard paths for non-headers.
123 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
125 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
126 CFLAGS.gcc+= -fms-extensions
127 CFLAGS.gcc+= --param inline-unit-growth=100
128 CFLAGS.gcc+= --param large-function-growth=1000
130 # Disallow common variables, and if we end up with commons from
131 # somewhere unexpected, allocate storage for them in the module itself.
133 # -fno-common is the default for src builds, but this should be left in place
134 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
135 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
136 # CFLAGS for in-tree module builds as they will also pick it up from
137 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
140 LDFLAGS+= -d -warn-common
142 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
143 LDFLAGS+= --build-id=sha1
146 CFLAGS+= ${DEBUG_FLAGS}
147 .if ${MACHINE_CPUARCH} == amd64
148 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
151 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
152 ${MACHINE_CPUARCH} == "powerpc"
156 # Temporary workaround for PR 196407, which contains the fascinating details.
157 # Don't allow clang to use fpu instructions or registers in kernel modules.
158 .if ${MACHINE_CPUARCH} == arm
159 CFLAGS.clang+= -mno-movt
160 CFLAGS.clang+= -mfpu=none
161 CFLAGS+= -funwind-tables
164 .if ${MACHINE_CPUARCH} == powerpc
165 CFLAGS+= -mlongcall -fno-omit-frame-pointer
166 .if ${LINKER_TYPE} == "lld"
167 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
168 LDFLAGS+= --no-toc-optimize
172 .if ${MACHINE_CPUARCH} == mips
173 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
176 .if defined(DEBUG) || defined(DEBUG_FLAGS)
181 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
182 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
183 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
185 SRCS+= ${KMOD:S/$/.c/}
186 CLEANFILES+= ${KMOD:S/$/.c/}
188 .for _firmw in ${FIRMWS}
189 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
190 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
191 @if [ -e ${_firmw:C/\:.*$//} ]; then \
192 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
193 -m ${LD_EMULATION} -r -d \
194 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
196 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
197 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
198 -m ${LD_EMULATION} -r -d \
199 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
200 rm ${_firmw:C/\:.*$//}; \
203 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
207 # Conditionally include SRCS based on kernel config options.
208 .for _o in ${KERN_OPTS}
212 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
218 .if !defined(DEBUG_FLAGS) || ${MK_KERNEL_SYMBOLS} == "no"
221 FULLPROG= ${PROG}.full
222 ${PROG}: ${FULLPROG} ${PROG}.debug
223 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
224 ${FULLPROG} ${.TARGET}
225 ${PROG}.debug: ${FULLPROG}
226 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
229 .if ${__KLD_SHARED} == yes
230 ${FULLPROG}: ${KMOD}.kld
231 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
232 -o ${.TARGET} ${KMOD}.kld
233 .if !defined(DEBUG_FLAGS)
234 ${OBJCOPY} --strip-debug ${.TARGET}
239 .if ${EXPORT_SYMS} != YES
240 CLEANFILES+= export_syms
243 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
244 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
247 .if ${__KLD_SHARED} == yes
252 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
253 -o ${.TARGET} ${OBJS}
254 .if ${MK_CTF} != "no"
255 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
257 .if defined(EXPORT_SYMS)
258 .if ${EXPORT_SYMS} != YES
259 .if ${EXPORT_SYMS} == NO
261 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
262 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
264 grep -v '^#' < ${EXPORT_SYMS} > export_syms
266 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
267 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
269 .endif # defined(EXPORT_SYMS)
270 .if defined(PREFIX_SYMS)
271 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
272 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
274 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
275 ${OBJCOPY} --strip-debug ${.TARGET}
278 _MAP_DEBUG_PREFIX= yes
281 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
284 CLEANFILES+=${_ILINKS}
288 beforedepend: ${_ILINKS}
289 beforebuild: ${_ILINKS}
291 # Ensure that the links exist without depending on it when it exists which
292 # causes all the modules to be rebuilt when the directory pointed to changes.
293 # Ensure that debug info references the path in the source tree.
294 .for _link in ${_ILINKS}
295 .if !exists(${.OBJDIR}/${_link})
296 OBJS_DEPEND_GUESS+= ${_link}
298 .if defined(_MAP_DEBUG_PREFIX)
299 .if ${_link} == "machine"
300 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
302 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
310 @case ${.TARGET} in \
312 path=${SYSDIR}/${MACHINE}/include ;; \
314 path=${SYSDIR}/${.TARGET:T}/include ;; \
316 path=`(cd $$path && /bin/pwd)` ; \
317 ${ECHO} ${.TARGET:T} "->" $$path ; \
318 ln -fns $$path ${.TARGET:T}
320 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
322 .if defined(DEBUG_FLAGS) && ${MK_KERNEL_SYMBOLS} != "no"
323 CLEANFILES+= ${FULLPROG} ${PROG}.debug
328 _INSTALLFLAGS:= ${INSTALLFLAGS}
329 .for ie in ${INSTALLFLAGS_EDIT}
330 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
333 .if !target(realinstall)
334 KERN_DEBUGDIR?= ${DEBUGDIR}
335 realinstall: _kmodinstall
336 .ORDER: beforeinstall _kmodinstall
338 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
339 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
340 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
341 ${INSTALL} -T dbg -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
342 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
345 .include <bsd.links.mk>
347 .if !defined(NO_XREF)
348 afterinstall: _kldxref
349 .ORDER: realinstall _kldxref
350 .ORDER: _installlinks _kldxref
352 @if type kldxref >/dev/null 2>&1; then \
353 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
354 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
357 .endif # !target(realinstall)
359 .endif # !target(install)
363 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
368 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
372 reload: unload load .PHONY
375 .if defined(KERNBUILDDIR)
376 .PATH: ${KERNBUILDDIR}
377 CFLAGS+= -I${KERNBUILDDIR}
378 .for _src in ${SRCS:Mopt_*.h}
382 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
386 .for _src in ${SRCS:Mopt_*.h}
395 # Add the sanitizer C flags
396 CFLAGS+= ${SAN_CFLAGS}
399 CFLAGS+= ${GCOV_CFLAGS}
401 # Respect configuration-specific C flags.
402 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
404 .if !empty(SRCS:Mvnode_if.c)
405 CLEANFILES+= vnode_if.c
406 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
407 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
410 .if !empty(SRCS:Mvnode_if.h)
411 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
412 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
413 ${SYSDIR}/kern/vnode_if.src
414 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
415 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
417 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
419 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
422 # Build _if.[ch] from _if.m, and clean them when we're done.
423 # __MPATH defined in config.mk
424 _MFILES=${__MPATH:T:O}
425 _MPATH=${__MPATH:H:O:u}
427 .for _i in ${SRCS:M*_if.[ch]}
428 _MATCH=M${_i:R:S/$/.m/}
429 _MATCHES=${_MFILES:${_MATCH}}
434 .m.c: ${SYSDIR}/tools/makeobjops.awk
435 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
437 .m.h: ${SYSDIR}/tools/makeobjops.awk
438 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
440 .for _i in mii pccard
441 .if !empty(SRCS:M${_i}devs.h)
442 CLEANFILES+= ${_i}devs.h
443 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
444 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
448 .if !empty(SRCS:Mbhnd_nvram_map.h)
449 CLEANFILES+= bhnd_nvram_map.h
450 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
451 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
452 ${SYSDIR}/dev/bhnd/nvram/nvram_map
454 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
455 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
458 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
459 CLEANFILES+= bhnd_nvram_map_data.h
460 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
461 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
462 ${SYSDIR}/dev/bhnd/nvram/nvram_map
463 bhnd_nvram_map_data.h:
464 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
465 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
468 .if !empty(SRCS:Musbdevs.h)
469 CLEANFILES+= usbdevs.h
470 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
471 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
474 .if !empty(SRCS:Musbdevs_data.h)
475 CLEANFILES+= usbdevs_data.h
476 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
477 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
480 .if !empty(SRCS:Msdiodevs.h)
481 CLEANFILES+= sdiodevs.h
482 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
483 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
486 .if !empty(SRCS:Msdiodevs_data.h)
487 CLEANFILES+= sdiodevs_data.h
488 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
489 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
492 .if !empty(SRCS:Macpi_quirks.h)
493 CLEANFILES+= acpi_quirks.h
494 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
495 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
498 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
499 CLEANFILES+= assym.inc genassym.o
500 DEPENDOBJS+= genassym.o
503 .if defined(MODULE_TIED)
506 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
507 CLEANFILES+= offset.inc genoffset.o
508 DEPENDOBJS+= genoffset.o
510 assym.inc: genassym.o
511 offset.inc: genoffset.o
512 assym.inc: ${SYSDIR}/kern/genassym.sh
513 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
514 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
515 genassym.o: ${SRCS:Mopt_*.h}
516 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
517 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
518 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
519 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
520 genoffset.o: ${SYSDIR}/kern/genoffset.c
521 genoffset.o: ${SRCS:Mopt_*.h}
522 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
523 ${SYSDIR}/kern/genoffset.c
525 CLEANDEPENDFILES+= ${_ILINKS}
526 # .depend needs include links so we remove them only together.
530 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
531 .if defined(KERNBUILDDIR)
532 OBJS_DEPEND_GUESS+= opt_global.h
535 .include <bsd.dep.mk>
536 .include <bsd.clang-analyze.mk>
537 .include <bsd.obj.mk>