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 <bsd.init.mk>
77 # Grab all the options for a kernel build. For backwards compat, we need to
78 # do this after bsd.own.mk.
79 .include "kern.opts.mk"
80 .include <bsd.compiler.mk>
83 # Search for kernel source tree in standard places.
84 .if empty(KERNBUILDDIR)
86 .for _dir in ${SRCTOP:D${SRCTOP}/sys} \
87 ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
88 .if !defined(SYSDIR) && exists(${_dir}/kern/)
93 .if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
94 .error "can't find kernel source tree"
98 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
100 # amd64 and mips use direct linking for kmod, all others use shared binaries
101 .if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
107 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
108 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 # Add -I paths for system headers. Individual module makefiles don't
126 # need any -I paths for this. Similar defaults for .PATH can't be
127 # set because there are no standard paths for non-headers.
128 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
130 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
131 CFLAGS.gcc+= -fms-extensions
132 CFLAGS.gcc+= --param inline-unit-growth=100
133 CFLAGS.gcc+= --param large-function-growth=1000
135 # Disallow common variables, and if we end up with commons from
136 # somewhere unexpected, allocate storage for them in the module itself.
138 LDFLAGS+= -d -warn-common
140 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
141 LDFLAGS+= --build-id=sha1
144 CFLAGS+= ${DEBUG_FLAGS}
145 .if ${MACHINE_CPUARCH} == amd64
146 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
149 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
153 # Temporary workaround for PR 196407, which contains the fascinating details.
154 # Don't allow clang to use fpu instructions or registers in kernel modules.
155 .if ${MACHINE_CPUARCH} == arm
156 .if ${COMPILER_VERSION} < 30800
157 CFLAGS.clang+= -mllvm -arm-use-movt=0
159 CFLAGS.clang+= -mno-movt
161 CFLAGS.clang+= -mfpu=none
162 CFLAGS+= -funwind-tables
165 .if ${MACHINE_CPUARCH} == powerpc
166 CFLAGS+= -mlongcall -fno-omit-frame-pointer
169 .if ${MACHINE_CPUARCH} == mips
170 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
173 .if defined(DEBUG) || defined(DEBUG_FLAGS)
178 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
179 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
180 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
182 SRCS+= ${KMOD:S/$/.c/}
183 CLEANFILES+= ${KMOD:S/$/.c/}
185 .for _firmw in ${FIRMWS}
186 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
187 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
188 @if [ -e ${_firmw:C/\:.*$//} ]; then \
189 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
190 -m ${LD_EMULATION} -r -d \
191 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
193 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
194 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
195 -m ${LD_EMULATION} -r -d \
196 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
197 rm ${_firmw:C/\:.*$//}; \
200 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
204 # Conditionally include SRCS based on kernel config options.
205 .for _o in ${KERN_OPTS}
209 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
215 .if !defined(DEBUG_FLAGS)
218 FULLPROG= ${PROG}.full
219 ${PROG}: ${FULLPROG} ${PROG}.debug
220 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
221 ${FULLPROG} ${.TARGET}
222 ${PROG}.debug: ${FULLPROG}
223 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
226 .if ${__KLD_SHARED} == yes
227 ${FULLPROG}: ${KMOD}.kld
228 ${LD} -m ${LD_EMULATION} -Bshareable -znotext ${_LDFLAGS} \
229 -o ${.TARGET} ${KMOD}.kld
230 .if !defined(DEBUG_FLAGS)
231 ${OBJCOPY} --strip-debug ${.TARGET}
236 .if ${EXPORT_SYMS} != YES
237 CLEANFILES+= export_syms
240 .if ${__KLD_SHARED} == yes
245 .if !defined(FIRMWS) && (${MACHINE_CPUARCH} == "i386")
246 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r \
247 -T ${SYSDIR}/conf/ldscript.set_padding \
248 -d -o ${.TARGET} ${OBJS}
250 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
252 .if ${MK_CTF} != "no"
253 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
255 .if defined(EXPORT_SYMS)
256 .if ${EXPORT_SYMS} != YES
257 .if ${EXPORT_SYMS} == NO
259 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
260 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
262 grep -v '^#' < ${EXPORT_SYMS} > export_syms
264 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
265 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
267 .endif # defined(EXPORT_SYMS)
268 .if defined(PREFIX_SYMS)
269 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
270 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
272 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
273 ${OBJCOPY} --strip-debug ${.TARGET}
276 .if ${COMPILER_TYPE} == "clang" || \
277 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
278 _MAP_DEBUG_PREFIX= yes
282 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
283 _ILINKS+=${MACHINE_CPUARCH}
285 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
288 CLEANFILES+=${_ILINKS}
292 beforedepend: ${_ILINKS}
293 beforebuild: ${_ILINKS}
295 # Ensure that the links exist without depending on it when it exists which
296 # causes all the modules to be rebuilt when the directory pointed to changes.
297 # Ensure that debug info references the path in the source tree.
298 .for _link in ${_ILINKS}
299 .if !exists(${.OBJDIR}/${_link})
300 OBJS_DEPEND_GUESS+= ${_link}
302 .if defined(_MAP_DEBUG_PREFIX)
303 .if ${_link} == "machine"
304 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
306 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
314 @case ${.TARGET} in \
316 path=${SYSDIR}/${MACHINE}/include ;; \
318 path=${SYSDIR}/${.TARGET:T}/include ;; \
320 path=`(cd $$path && /bin/pwd)` ; \
321 ${ECHO} ${.TARGET:T} "->" $$path ; \
322 ln -fns $$path ${.TARGET:T}
324 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
326 .if defined(DEBUG_FLAGS)
327 CLEANFILES+= ${FULLPROG} ${PROG}.debug
332 _INSTALLFLAGS:= ${INSTALLFLAGS}
333 .for ie in ${INSTALLFLAGS_EDIT}
334 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
337 .if !target(realinstall)
338 KERN_DEBUGDIR?= ${DEBUGDIR}
339 realinstall: _kmodinstall
340 .ORDER: beforeinstall _kmodinstall
342 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
343 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
344 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
345 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
346 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
349 .include <bsd.links.mk>
351 .if !defined(NO_XREF)
352 afterinstall: _kldxref
353 .ORDER: realinstall _kldxref
354 .ORDER: _installlinks _kldxref
356 @if type kldxref >/dev/null 2>&1; then \
357 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
358 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
361 .endif # !target(realinstall)
363 .endif # !target(install)
367 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
372 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
376 reload: unload load .PHONY
379 .if defined(KERNBUILDDIR)
380 .PATH: ${KERNBUILDDIR}
381 CFLAGS+= -I${KERNBUILDDIR}
382 .for _src in ${SRCS:Mopt_*.h}
386 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
390 .for _src in ${SRCS:Mopt_*.h}
399 # Add the sanitizer C flags
400 CFLAGS+= ${SAN_CFLAGS}
403 CFLAGS+= ${GCOV_CFLAGS}
405 # Respect configuration-specific C flags.
406 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
408 .if !empty(SRCS:Mvnode_if.c)
409 CLEANFILES+= vnode_if.c
410 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
411 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
414 .if !empty(SRCS:Mvnode_if.h)
415 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
416 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
417 ${SYSDIR}/kern/vnode_if.src
418 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
419 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
421 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
423 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
426 # Build _if.[ch] from _if.m, and clean them when we're done.
427 # __MPATH defined in config.mk
428 _MFILES=${__MPATH:T:O}
429 _MPATH=${__MPATH:H:O:u}
431 .for _i in ${SRCS:M*_if.[ch]}
432 _MATCH=M${_i:R:S/$/.m/}
433 _MATCHES=${_MFILES:${_MATCH}}
438 .m.c: ${SYSDIR}/tools/makeobjops.awk
439 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
441 .m.h: ${SYSDIR}/tools/makeobjops.awk
442 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
444 .for _i in mii pccard
445 .if !empty(SRCS:M${_i}devs.h)
446 CLEANFILES+= ${_i}devs.h
447 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
448 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
452 .if !empty(SRCS:Mbhnd_nvram_map.h)
453 CLEANFILES+= bhnd_nvram_map.h
454 bhnd_nvram_map.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
458 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
459 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
462 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
463 CLEANFILES+= bhnd_nvram_map_data.h
464 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
465 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
466 ${SYSDIR}/dev/bhnd/nvram/nvram_map
467 bhnd_nvram_map_data.h:
468 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
469 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
472 .if !empty(SRCS:Musbdevs.h)
473 CLEANFILES+= usbdevs.h
474 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
475 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
478 .if !empty(SRCS:Musbdevs_data.h)
479 CLEANFILES+= usbdevs_data.h
480 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
481 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
484 .if !empty(SRCS:Msdiodevs.h)
485 CLEANFILES+= sdiodevs.h
486 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
487 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
490 .if !empty(SRCS:Msdiodevs_data.h)
491 CLEANFILES+= sdiodevs_data.h
492 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
493 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
496 .if !empty(SRCS:Macpi_quirks.h)
497 CLEANFILES+= acpi_quirks.h
498 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
499 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
502 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
503 CLEANFILES+= assym.inc genassym.o
504 DEPENDOBJS+= genassym.o
507 .if defined(MODULE_TIED)
510 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
511 CLEANFILES+= offset.inc genoffset.o
512 DEPENDOBJS+= genoffset.o
514 assym.inc: genassym.o
515 offset.inc: genoffset.o
516 assym.inc: ${SYSDIR}/kern/genassym.sh
517 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
518 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
519 genassym.o: ${SRCS:Mopt_*.h}
520 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
521 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
522 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
523 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
524 genoffset.o: ${SYSDIR}/kern/genoffset.c
525 genoffset.o: ${SRCS:Mopt_*.h}
526 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
527 ${SYSDIR}/kern/genoffset.c
529 CLEANDEPENDFILES+= ${_ILINKS}
530 # .depend needs include links so we remove them only together.
534 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
535 .if defined(KERNBUILDDIR)
536 OBJS_DEPEND_GUESS+= opt_global.h
539 .include <bsd.dep.mk>
540 .include <bsd.clang-analyze.mk>
541 .include <bsd.obj.mk>