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
91 .if ${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} < 50000
100 .if defined(MODULE_TIED)
104 # Don't use any standard or source-relative include directories.
106 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
107 .if defined(KERNBUILDDIR)
108 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
111 # Add -I paths for system headers. Individual module makefiles don't
112 # need any -I paths for this. Similar defaults for .PATH can't be
113 # set because there are no standard paths for non-headers.
114 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
116 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
117 CFLAGS.gcc+= -fms-extensions
118 CFLAGS.gcc+= --param inline-unit-growth=100
119 CFLAGS.gcc+= --param large-function-growth=1000
121 # Disallow common variables, and if we end up with commons from
122 # somewhere unexpected, allocate storage for them in the module itself.
124 LDFLAGS+= -d -warn-common
126 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
127 LDFLAGS+= --build-id=sha1
130 CFLAGS+= ${DEBUG_FLAGS}
131 .if ${MACHINE_CPUARCH} == amd64
132 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
135 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
139 # Temporary workaround for PR 196407, which contains the fascinating details.
140 # Don't allow clang to use fpu instructions or registers in kernel modules.
141 .if ${MACHINE_CPUARCH} == arm
142 .if ${COMPILER_VERSION} < 30800
143 CFLAGS.clang+= -mllvm -arm-use-movt=0
145 CFLAGS.clang+= -mno-movt
147 CFLAGS.clang+= -mfpu=none
148 CFLAGS+= -funwind-tables
151 .if ${MACHINE_CPUARCH} == powerpc
152 CFLAGS+= -mlongcall -fno-omit-frame-pointer
153 .if ${LINKER_TYPE} == "lld"
154 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
155 LDFLAGS+= --no-toc-optimize
159 .if ${MACHINE_CPUARCH} == mips
160 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
163 .if defined(DEBUG) || defined(DEBUG_FLAGS)
168 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
169 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
170 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
172 SRCS+= ${KMOD:S/$/.c/}
173 CLEANFILES+= ${KMOD:S/$/.c/}
175 .for _firmw in ${FIRMWS}
176 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
177 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
178 @if [ -e ${_firmw:C/\:.*$//} ]; then \
179 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
180 -m ${LD_EMULATION} -r -d \
181 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
183 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
184 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
185 -m ${LD_EMULATION} -r -d \
186 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
187 rm ${_firmw:C/\:.*$//}; \
190 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
194 # Conditionally include SRCS based on kernel config options.
195 .for _o in ${KERN_OPTS}
199 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
205 .if !defined(DEBUG_FLAGS)
208 FULLPROG= ${PROG}.full
209 ${PROG}: ${FULLPROG} ${PROG}.debug
210 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
211 ${FULLPROG} ${.TARGET}
212 ${PROG}.debug: ${FULLPROG}
213 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
216 .if ${__KLD_SHARED} == yes
217 ${FULLPROG}: ${KMOD}.kld
218 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
219 -o ${.TARGET} ${KMOD}.kld
220 .if !defined(DEBUG_FLAGS)
221 ${OBJCOPY} --strip-debug ${.TARGET}
226 .if ${EXPORT_SYMS} != YES
227 CLEANFILES+= export_syms
230 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
231 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
234 .if ${__KLD_SHARED} == yes
239 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
240 -o ${.TARGET} ${OBJS}
241 .if ${MK_CTF} != "no"
242 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
244 .if defined(EXPORT_SYMS)
245 .if ${EXPORT_SYMS} != YES
246 .if ${EXPORT_SYMS} == NO
248 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
249 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
251 grep -v '^#' < ${EXPORT_SYMS} > export_syms
253 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
254 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
256 .endif # defined(EXPORT_SYMS)
257 .if defined(PREFIX_SYMS)
258 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
259 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
261 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
262 ${OBJCOPY} --strip-debug ${.TARGET}
265 .if ${COMPILER_TYPE} == "clang" || \
266 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
267 _MAP_DEBUG_PREFIX= yes
271 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
274 CLEANFILES+=${_ILINKS}
278 beforedepend: ${_ILINKS}
279 beforebuild: ${_ILINKS}
281 # Ensure that the links exist without depending on it when it exists which
282 # causes all the modules to be rebuilt when the directory pointed to changes.
283 # Ensure that debug info references the path in the source tree.
284 .for _link in ${_ILINKS}
285 .if !exists(${.OBJDIR}/${_link})
286 OBJS_DEPEND_GUESS+= ${_link}
288 .if defined(_MAP_DEBUG_PREFIX)
289 .if ${_link} == "machine"
290 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
292 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
300 @case ${.TARGET} in \
302 path=${SYSDIR}/${MACHINE}/include ;; \
304 path=${SYSDIR}/${.TARGET:T}/include ;; \
306 path=`(cd $$path && /bin/pwd)` ; \
307 ${ECHO} ${.TARGET:T} "->" $$path ; \
308 ln -fns $$path ${.TARGET:T}
310 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
312 .if defined(DEBUG_FLAGS)
313 CLEANFILES+= ${FULLPROG} ${PROG}.debug
318 _INSTALLFLAGS:= ${INSTALLFLAGS}
319 .for ie in ${INSTALLFLAGS_EDIT}
320 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
323 .if !target(realinstall)
324 KERN_DEBUGDIR?= ${DEBUGDIR}
325 realinstall: _kmodinstall
326 .ORDER: beforeinstall _kmodinstall
328 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
329 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
330 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
331 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
332 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
335 .include <bsd.links.mk>
337 .if !defined(NO_XREF)
338 afterinstall: _kldxref
339 .ORDER: realinstall _kldxref
340 .ORDER: _installlinks _kldxref
342 @if type kldxref >/dev/null 2>&1; then \
343 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
344 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
347 .endif # !target(realinstall)
349 .endif # !target(install)
353 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
358 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
362 reload: unload load .PHONY
365 .if defined(KERNBUILDDIR)
366 .PATH: ${KERNBUILDDIR}
367 CFLAGS+= -I${KERNBUILDDIR}
368 .for _src in ${SRCS:Mopt_*.h}
372 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
376 .for _src in ${SRCS:Mopt_*.h}
385 # Add the sanitizer C flags
386 CFLAGS+= ${SAN_CFLAGS}
389 CFLAGS+= ${GCOV_CFLAGS}
391 # Respect configuration-specific C flags.
392 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
394 .if !empty(SRCS:Mvnode_if.c)
395 CLEANFILES+= vnode_if.c
396 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
397 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
400 .if !empty(SRCS:Mvnode_if.h)
401 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
402 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
403 ${SYSDIR}/kern/vnode_if.src
404 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
405 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
407 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
409 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
412 # Build _if.[ch] from _if.m, and clean them when we're done.
413 # __MPATH defined in config.mk
414 _MFILES=${__MPATH:T:O}
415 _MPATH=${__MPATH:H:O:u}
417 .for _i in ${SRCS:M*_if.[ch]}
418 _MATCH=M${_i:R:S/$/.m/}
419 _MATCHES=${_MFILES:${_MATCH}}
424 .m.c: ${SYSDIR}/tools/makeobjops.awk
425 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
427 .m.h: ${SYSDIR}/tools/makeobjops.awk
428 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
430 .for _i in mii pccard
431 .if !empty(SRCS:M${_i}devs.h)
432 CLEANFILES+= ${_i}devs.h
433 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
434 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
438 .if !empty(SRCS:Mbhnd_nvram_map.h)
439 CLEANFILES+= bhnd_nvram_map.h
440 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
441 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
442 ${SYSDIR}/dev/bhnd/nvram/nvram_map
444 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
445 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
448 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
449 CLEANFILES+= bhnd_nvram_map_data.h
450 bhnd_nvram_map_data.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
453 bhnd_nvram_map_data.h:
454 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
455 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
458 .if !empty(SRCS:Musbdevs.h)
459 CLEANFILES+= usbdevs.h
460 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
461 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
464 .if !empty(SRCS:Musbdevs_data.h)
465 CLEANFILES+= usbdevs_data.h
466 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
467 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
470 .if !empty(SRCS:Msdiodevs.h)
471 CLEANFILES+= sdiodevs.h
472 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
473 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
476 .if !empty(SRCS:Msdiodevs_data.h)
477 CLEANFILES+= sdiodevs_data.h
478 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
479 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
482 .if !empty(SRCS:Macpi_quirks.h)
483 CLEANFILES+= acpi_quirks.h
484 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
485 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
488 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
489 CLEANFILES+= assym.inc genassym.o
490 DEPENDOBJS+= genassym.o
493 .if defined(MODULE_TIED)
496 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
497 CLEANFILES+= offset.inc genoffset.o
498 DEPENDOBJS+= genoffset.o
500 assym.inc: genassym.o
501 offset.inc: genoffset.o
502 assym.inc: ${SYSDIR}/kern/genassym.sh
503 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
504 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
505 genassym.o: ${SRCS:Mopt_*.h}
506 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
507 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
508 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
509 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
510 genoffset.o: ${SYSDIR}/kern/genoffset.c
511 genoffset.o: ${SRCS:Mopt_*.h}
512 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
513 ${SYSDIR}/kern/genoffset.c
515 CLEANDEPENDFILES+= ${_ILINKS}
516 # .depend needs include links so we remove them only together.
520 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
521 .if defined(KERNBUILDDIR)
522 OBJS_DEPEND_GUESS+= opt_global.h
525 .include <bsd.dep.mk>
526 .include <bsd.clang-analyze.mk>
527 .include <bsd.obj.mk>