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
110 .if ${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} < 50000
128 CFLAGS+= -DKLD_MODULE
129 .if defined(MODULE_TIED)
133 # Don't use any standard or source-relative include directories.
135 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
136 .if defined(KERNBUILDDIR)
137 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
140 # Add -I paths for system headers. Individual module makefiles don't
141 # need any -I paths for this. Similar defaults for .PATH can't be
142 # set because there are no standard paths for non-headers.
143 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
145 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
146 CFLAGS.gcc+= -fms-extensions
147 CFLAGS.gcc+= --param inline-unit-growth=100
148 CFLAGS.gcc+= --param large-function-growth=1000
150 # Disallow common variables, and if we end up with commons from
151 # somewhere unexpected, allocate storage for them in the module itself.
153 # -fno-common is the default for src builds, but this should be left in place
154 # until at least we catch up to GCC10/LLVM11 or otherwise enable -fno-common
155 # in <bsd.sys.mk> instead. For now, we will have duplicate -fno-common in
156 # CFLAGS for in-tree module builds as they will also pick it up from
157 # share/mk/src.sys.mk, but the following is important for out-of-tree modules
160 LDFLAGS+= -d -warn-common
162 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
163 LDFLAGS+= --build-id=sha1
166 CFLAGS+= ${DEBUG_FLAGS}
167 .if ${MACHINE_CPUARCH} == amd64
168 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
171 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
175 # Temporary workaround for PR 196407, which contains the fascinating details.
176 # Don't allow clang to use fpu instructions or registers in kernel modules.
177 .if ${MACHINE_CPUARCH} == arm
178 .if ${COMPILER_VERSION} < 30800
179 CFLAGS.clang+= -mllvm -arm-use-movt=0
181 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
191 .if ${MACHINE_CPUARCH} == mips
192 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
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/\:.*$//}
209 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
210 @if [ -e ${_firmw:C/\:.*$//} ]; then \
211 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
212 -m ${LD_EMULATION} -r -d \
213 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
215 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
216 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
217 -m ${LD_EMULATION} -r -d \
218 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
219 rm ${_firmw:C/\:.*$//}; \
222 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
226 # Conditionally include SRCS based on kernel config options.
227 .for _o in ${KERN_OPTS}
231 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
237 .if !defined(DEBUG_FLAGS)
240 FULLPROG= ${PROG}.full
241 ${PROG}: ${FULLPROG} ${PROG}.debug
242 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
243 ${FULLPROG} ${.TARGET}
244 ${PROG}.debug: ${FULLPROG}
245 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
248 .if ${__KLD_SHARED} == yes
249 ${FULLPROG}: ${KMOD}.kld
250 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
251 -o ${.TARGET} ${KMOD}.kld
252 .if !defined(DEBUG_FLAGS)
253 ${OBJCOPY} --strip-debug ${.TARGET}
258 .if ${EXPORT_SYMS} != YES
259 CLEANFILES+= export_syms
262 .if ${__KLD_SHARED} == yes
267 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
268 .if ${MK_CTF} != "no"
269 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
271 .if defined(EXPORT_SYMS)
272 .if ${EXPORT_SYMS} != YES
273 .if ${EXPORT_SYMS} == NO
275 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
276 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
278 grep -v '^#' < ${EXPORT_SYMS} > export_syms
280 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
281 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
283 .endif # defined(EXPORT_SYMS)
284 .if defined(PREFIX_SYMS)
285 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
286 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
288 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
289 ${OBJCOPY} --strip-debug ${.TARGET}
292 .if ${COMPILER_TYPE} == "clang" || \
293 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
294 _MAP_DEBUG_PREFIX= yes
298 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
299 _ILINKS+=${MACHINE_CPUARCH}
301 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
304 CLEANFILES+=${_ILINKS}
308 beforedepend: ${_ILINKS}
309 beforebuild: ${_ILINKS}
311 # Ensure that the links exist without depending on it when it exists which
312 # causes all the modules to be rebuilt when the directory pointed to changes.
313 # Ensure that debug info references the path in the source tree.
314 .for _link in ${_ILINKS}
315 .if !exists(${.OBJDIR}/${_link})
316 OBJS_DEPEND_GUESS+= ${_link}
318 .if defined(_MAP_DEBUG_PREFIX)
319 .if ${_link} == "machine"
320 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
322 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
330 @case ${.TARGET} in \
332 path=${SYSDIR}/${MACHINE}/include ;; \
334 path=${SYSDIR}/${.TARGET:T}/include ;; \
336 path=`(cd $$path && /bin/pwd)` ; \
337 ${ECHO} ${.TARGET:T} "->" $$path ; \
338 ln -fns $$path ${.TARGET:T}
340 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
342 .if defined(DEBUG_FLAGS)
343 CLEANFILES+= ${FULLPROG} ${PROG}.debug
348 _INSTALLFLAGS:= ${INSTALLFLAGS}
349 .for ie in ${INSTALLFLAGS_EDIT}
350 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
353 .if !target(realinstall)
354 KERN_DEBUGDIR?= ${DEBUGDIR}
355 realinstall: _kmodinstall
356 .ORDER: beforeinstall _kmodinstall
358 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
359 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
360 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
361 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
362 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
365 .include <bsd.links.mk>
367 .if !defined(NO_XREF)
368 afterinstall: _kldxref
369 .ORDER: realinstall _kldxref
370 .ORDER: _installlinks _kldxref
372 @if type kldxref >/dev/null 2>&1; then \
373 ${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
374 kldxref ${DESTDIR}${KMODDIR}; \
377 .endif # !target(realinstall)
379 .endif # !target(install)
383 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
388 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
392 reload: unload load .PHONY
395 .if defined(KERNBUILDDIR)
396 .PATH: ${KERNBUILDDIR}
397 CFLAGS+= -I${KERNBUILDDIR}
398 .for _src in ${SRCS:Mopt_*.h}
402 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
406 .for _src in ${SRCS:Mopt_*.h}
415 # Respect configuration-specific C flags.
416 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
418 .if !empty(SRCS:Mvnode_if.c)
419 CLEANFILES+= vnode_if.c
420 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
421 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
424 .if !empty(SRCS:Mvnode_if.h)
425 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
426 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
427 ${SYSDIR}/kern/vnode_if.src
428 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
429 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
431 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
433 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
436 # Build _if.[ch] from _if.m, and clean them when we're done.
437 # __MPATH defined in config.mk
438 _MFILES=${__MPATH:T:O}
439 _MPATH=${__MPATH:H:O:u}
441 .for _i in ${SRCS:M*_if.[ch]}
442 _MATCH=M${_i:R:S/$/.m/}
443 _MATCHES=${_MFILES:${_MATCH}}
448 .m.c: ${SYSDIR}/tools/makeobjops.awk
449 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
451 .m.h: ${SYSDIR}/tools/makeobjops.awk
452 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
454 .for _i in mii pccard
455 .if !empty(SRCS:M${_i}devs.h)
456 CLEANFILES+= ${_i}devs.h
457 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
458 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
462 .if !empty(SRCS:Mbhnd_nvram_map.h)
463 CLEANFILES+= bhnd_nvram_map.h
464 bhnd_nvram_map.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
468 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
469 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
472 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
473 CLEANFILES+= bhnd_nvram_map_data.h
474 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
475 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
476 ${SYSDIR}/dev/bhnd/nvram/nvram_map
477 bhnd_nvram_map_data.h:
478 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
479 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
482 .if !empty(SRCS:Musbdevs.h)
483 CLEANFILES+= usbdevs.h
484 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
485 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
488 .if !empty(SRCS:Musbdevs_data.h)
489 CLEANFILES+= usbdevs_data.h
490 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
491 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
494 .if !empty(SRCS:Macpi_quirks.h)
495 CLEANFILES+= acpi_quirks.h
496 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
497 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
500 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
501 CLEANFILES+= assym.inc genassym.o
502 DEPENDOBJS+= genassym.o
505 .if defined(MODULE_TIED)
508 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
509 CLEANFILES+= offset.inc genoffset.o
510 DEPENDOBJS+= genoffset.o
512 assym.inc: genassym.o
513 offset.inc: genoffset.o
514 assym.inc: ${SYSDIR}/kern/genassym.sh
515 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
516 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
517 genassym.o: ${SRCS:Mopt_*.h}
518 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
519 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
520 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
521 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
522 genoffset.o: ${SYSDIR}/kern/genoffset.c
523 genoffset.o: ${SRCS:Mopt_*.h}
524 ${CC} -c ${CFLAGS:N-flto:N-fno-common} -fcommon \
525 ${SYSDIR}/kern/genoffset.c
527 CLEANDEPENDFILES+= ${_ILINKS}
528 # .depend needs include links so we remove them only together.
532 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
533 .if defined(KERNBUILDDIR)
534 OBJS_DEPEND_GUESS+= opt_global.h
537 .include <bsd.dep.mk>
538 .include <bsd.clang-analyze.mk>
539 .include <bsd.obj.mk>