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 CFLAGS+= -include ${.OBJDIR}/opt_global.h
114 # Add -I paths for system headers. Individual module makefiles don't
115 # need any -I paths for this. Similar defaults for .PATH can't be
116 # set because there are no standard paths for non-headers.
117 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
119 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
120 CFLAGS.gcc+= -fms-extensions
121 CFLAGS.gcc+= --param inline-unit-growth=100
122 CFLAGS.gcc+= --param large-function-growth=1000
124 # Disallow common variables, and if we end up with commons from
125 # somewhere unexpected, allocate storage for them in the module itself.
127 LDFLAGS+= -d -warn-common
129 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
130 LDFLAGS+= --build-id=sha1
133 CFLAGS+= ${DEBUG_FLAGS}
134 .if ${MACHINE_CPUARCH} == amd64
135 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
138 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" || \
139 ${MACHINE_CPUARCH} == "powerpc"
143 # Temporary workaround for PR 196407, which contains the fascinating details.
144 # Don't allow clang to use fpu instructions or registers in kernel modules.
145 .if ${MACHINE_CPUARCH} == arm
146 .if ${COMPILER_VERSION} < 30800
147 CFLAGS.clang+= -mllvm -arm-use-movt=0
149 CFLAGS.clang+= -mno-movt
151 CFLAGS.clang+= -mfpu=none
152 CFLAGS+= -funwind-tables
155 .if ${MACHINE_CPUARCH} == powerpc
156 CFLAGS+= -mlongcall -fno-omit-frame-pointer
157 .if ${LINKER_TYPE} == "lld"
158 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
159 LDFLAGS+= --no-toc-optimize
163 .if ${MACHINE_CPUARCH} == mips
164 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
167 .if defined(DEBUG) || defined(DEBUG_FLAGS)
172 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
173 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
174 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
176 SRCS+= ${KMOD:S/$/.c/}
177 CLEANFILES+= ${KMOD:S/$/.c/}
179 .for _firmw in ${FIRMWS}
180 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
181 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
182 @if [ -e ${_firmw:C/\:.*$//} ]; then \
183 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
184 -m ${LD_EMULATION} -r -d \
185 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
187 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
188 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
189 -m ${LD_EMULATION} -r -d \
190 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
191 rm ${_firmw:C/\:.*$//}; \
194 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
198 # Conditionally include SRCS based on kernel config options.
199 .for _o in ${KERN_OPTS}
203 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
209 .if !defined(DEBUG_FLAGS)
212 FULLPROG= ${PROG}.full
213 ${PROG}: ${FULLPROG} ${PROG}.debug
214 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
215 ${FULLPROG} ${.TARGET}
216 ${PROG}.debug: ${FULLPROG}
217 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
220 .if ${__KLD_SHARED} == yes
221 ${FULLPROG}: ${KMOD}.kld
222 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
223 -o ${.TARGET} ${KMOD}.kld
224 .if !defined(DEBUG_FLAGS)
225 ${OBJCOPY} --strip-debug ${.TARGET}
230 .if ${EXPORT_SYMS} != YES
231 CLEANFILES+= export_syms
234 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
235 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
238 .if ${__KLD_SHARED} == yes
243 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
244 -o ${.TARGET} ${OBJS}
245 .if ${MK_CTF} != "no"
246 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
248 .if defined(EXPORT_SYMS)
249 .if ${EXPORT_SYMS} != YES
250 .if ${EXPORT_SYMS} == NO
252 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
253 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
255 grep -v '^#' < ${EXPORT_SYMS} > export_syms
257 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
258 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
260 .endif # defined(EXPORT_SYMS)
261 .if defined(PREFIX_SYMS)
262 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
263 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
265 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
266 ${OBJCOPY} --strip-debug ${.TARGET}
269 .if ${COMPILER_TYPE} == "clang" || \
270 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
271 _MAP_DEBUG_PREFIX= yes
275 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
278 CLEANFILES+=${_ILINKS}
282 beforedepend: ${_ILINKS}
283 beforebuild: ${_ILINKS}
285 # Ensure that the links exist without depending on it when it exists which
286 # causes all the modules to be rebuilt when the directory pointed to changes.
287 # Ensure that debug info references the path in the source tree.
288 .for _link in ${_ILINKS}
289 .if !exists(${.OBJDIR}/${_link})
290 OBJS_DEPEND_GUESS+= ${_link}
292 .if defined(_MAP_DEBUG_PREFIX)
293 .if ${_link} == "machine"
294 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
296 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
304 @case ${.TARGET} in \
306 path=${SYSDIR}/${MACHINE}/include ;; \
308 path=${SYSDIR}/${.TARGET:T}/include ;; \
310 path=`(cd $$path && /bin/pwd)` ; \
311 ${ECHO} ${.TARGET:T} "->" $$path ; \
312 ln -fns $$path ${.TARGET:T}
314 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
316 .if defined(DEBUG_FLAGS)
317 CLEANFILES+= ${FULLPROG} ${PROG}.debug
322 _INSTALLFLAGS:= ${INSTALLFLAGS}
323 .for ie in ${INSTALLFLAGS_EDIT}
324 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
327 .if !target(realinstall)
328 KERN_DEBUGDIR?= ${DEBUGDIR}
329 realinstall: _kmodinstall
330 .ORDER: beforeinstall _kmodinstall
332 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
333 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
334 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
335 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
336 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
339 .include <bsd.links.mk>
341 .if !defined(NO_XREF)
342 afterinstall: _kldxref
343 .ORDER: realinstall _kldxref
344 .ORDER: _installlinks _kldxref
346 @if type kldxref >/dev/null 2>&1; then \
347 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
348 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
351 .endif # !target(realinstall)
353 .endif # !target(install)
357 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
362 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
366 reload: unload load .PHONY
369 .if defined(KERNBUILDDIR)
370 .PATH: ${KERNBUILDDIR}
371 CFLAGS+= -I${KERNBUILDDIR}
372 .for _src in ${SRCS:Mopt_*.h}
376 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
380 .for _src in ${SRCS:Mopt_*.h}
389 # Add the sanitizer C flags
390 CFLAGS+= ${SAN_CFLAGS}
393 CFLAGS+= ${GCOV_CFLAGS}
395 # Respect configuration-specific C flags.
396 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
398 .if !empty(SRCS:Mvnode_if.c)
399 CLEANFILES+= vnode_if.c
400 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
401 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
404 .if !empty(SRCS:Mvnode_if.h)
405 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
406 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
407 ${SYSDIR}/kern/vnode_if.src
408 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
409 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
411 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
413 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
416 # Build _if.[ch] from _if.m, and clean them when we're done.
417 # __MPATH defined in config.mk
418 _MFILES=${__MPATH:T:O}
419 _MPATH=${__MPATH:H:O:u}
421 .for _i in ${SRCS:M*_if.[ch]}
422 _MATCH=M${_i:R:S/$/.m/}
423 _MATCHES=${_MFILES:${_MATCH}}
428 .m.c: ${SYSDIR}/tools/makeobjops.awk
429 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
431 .m.h: ${SYSDIR}/tools/makeobjops.awk
432 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
434 .for _i in mii pccard
435 .if !empty(SRCS:M${_i}devs.h)
436 CLEANFILES+= ${_i}devs.h
437 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
438 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
442 .if !empty(SRCS:Mbhnd_nvram_map.h)
443 CLEANFILES+= bhnd_nvram_map.h
444 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
445 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
446 ${SYSDIR}/dev/bhnd/nvram/nvram_map
448 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
449 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
452 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
453 CLEANFILES+= bhnd_nvram_map_data.h
454 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
455 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
456 ${SYSDIR}/dev/bhnd/nvram/nvram_map
457 bhnd_nvram_map_data.h:
458 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
459 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
462 .if !empty(SRCS:Musbdevs.h)
463 CLEANFILES+= usbdevs.h
464 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
465 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
468 .if !empty(SRCS:Musbdevs_data.h)
469 CLEANFILES+= usbdevs_data.h
470 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
471 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
474 .if !empty(SRCS:Msdiodevs.h)
475 CLEANFILES+= sdiodevs.h
476 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
477 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
480 .if !empty(SRCS:Msdiodevs_data.h)
481 CLEANFILES+= sdiodevs_data.h
482 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
483 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
486 .if !empty(SRCS:Macpi_quirks.h)
487 CLEANFILES+= acpi_quirks.h
488 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
489 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
492 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
493 CLEANFILES+= assym.inc genassym.o
494 DEPENDOBJS+= genassym.o
497 .if defined(MODULE_TIED)
500 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
501 CLEANFILES+= offset.inc genoffset.o
502 DEPENDOBJS+= genoffset.o
504 assym.inc: genassym.o
505 offset.inc: genoffset.o
506 assym.inc: ${SYSDIR}/kern/genassym.sh
507 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
508 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
509 genassym.o: ${SRCS:Mopt_*.h}
510 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
511 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
512 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
513 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
514 genoffset.o: ${SYSDIR}/kern/genoffset.c
515 genoffset.o: ${SRCS:Mopt_*.h}
516 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
517 ${SYSDIR}/kern/genoffset.c
519 CLEANDEPENDFILES+= ${_ILINKS}
520 # .depend needs include links so we remove them only together.
524 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
525 .if defined(KERNBUILDDIR)
526 OBJS_DEPEND_GUESS+= opt_global.h
529 .include <bsd.dep.mk>
530 .include <bsd.clang-analyze.mk>
531 .include <bsd.obj.mk>