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" || \
136 ${MACHINE_CPUARCH} == "powerpc"
140 # Temporary workaround for PR 196407, which contains the fascinating details.
141 # Don't allow clang to use fpu instructions or registers in kernel modules.
142 .if ${MACHINE_CPUARCH} == arm
143 .if ${COMPILER_VERSION} < 30800
144 CFLAGS.clang+= -mllvm -arm-use-movt=0
146 CFLAGS.clang+= -mno-movt
148 CFLAGS.clang+= -mfpu=none
149 CFLAGS+= -funwind-tables
152 .if ${MACHINE_CPUARCH} == powerpc
153 CFLAGS+= -mlongcall -fno-omit-frame-pointer
154 .if ${LINKER_TYPE} == "lld"
155 # TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it
156 LDFLAGS+= --no-toc-optimize
160 .if ${MACHINE_CPUARCH} == mips
161 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
164 .if defined(DEBUG) || defined(DEBUG_FLAGS)
169 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
170 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
171 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
173 SRCS+= ${KMOD:S/$/.c/}
174 CLEANFILES+= ${KMOD:S/$/.c/}
176 .for _firmw in ${FIRMWS}
177 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
178 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
179 @if [ -e ${_firmw:C/\:.*$//} ]; then \
180 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
181 -m ${LD_EMULATION} -r -d \
182 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
184 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
185 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
186 -m ${LD_EMULATION} -r -d \
187 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
188 rm ${_firmw:C/\:.*$//}; \
191 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
195 # Conditionally include SRCS based on kernel config options.
196 .for _o in ${KERN_OPTS}
200 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
206 .if !defined(DEBUG_FLAGS)
209 FULLPROG= ${PROG}.full
210 ${PROG}: ${FULLPROG} ${PROG}.debug
211 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
212 ${FULLPROG} ${.TARGET}
213 ${PROG}.debug: ${FULLPROG}
214 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
217 .if ${__KLD_SHARED} == yes
218 ${FULLPROG}: ${KMOD}.kld
219 ${LD} -m ${LD_EMULATION} -Bshareable -znotext -znorelro ${_LDFLAGS} \
220 -o ${.TARGET} ${KMOD}.kld
221 .if !defined(DEBUG_FLAGS)
222 ${OBJCOPY} --strip-debug ${.TARGET}
227 .if ${EXPORT_SYMS} != YES
228 CLEANFILES+= export_syms
231 .if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH})
232 LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}
235 .if ${__KLD_SHARED} == yes
240 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} ${LDSCRIPT_FLAGS} -r -d \
241 -o ${.TARGET} ${OBJS}
242 .if ${MK_CTF} != "no"
243 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
245 .if defined(EXPORT_SYMS)
246 .if ${EXPORT_SYMS} != YES
247 .if ${EXPORT_SYMS} == NO
249 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
250 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
252 grep -v '^#' < ${EXPORT_SYMS} > export_syms
254 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
255 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
257 .endif # defined(EXPORT_SYMS)
258 .if defined(PREFIX_SYMS)
259 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
260 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
262 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
263 ${OBJCOPY} --strip-debug ${.TARGET}
266 .if ${COMPILER_TYPE} == "clang" || \
267 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000)
268 _MAP_DEBUG_PREFIX= yes
272 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
275 CLEANFILES+=${_ILINKS}
279 beforedepend: ${_ILINKS}
280 beforebuild: ${_ILINKS}
282 # Ensure that the links exist without depending on it when it exists which
283 # causes all the modules to be rebuilt when the directory pointed to changes.
284 # Ensure that debug info references the path in the source tree.
285 .for _link in ${_ILINKS}
286 .if !exists(${.OBJDIR}/${_link})
287 OBJS_DEPEND_GUESS+= ${_link}
289 .if defined(_MAP_DEBUG_PREFIX)
290 .if ${_link} == "machine"
291 CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include
293 CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include
301 @case ${.TARGET} in \
303 path=${SYSDIR}/${MACHINE}/include ;; \
305 path=${SYSDIR}/${.TARGET:T}/include ;; \
307 path=`(cd $$path && /bin/pwd)` ; \
308 ${ECHO} ${.TARGET:T} "->" $$path ; \
309 ln -fns $$path ${.TARGET:T}
311 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
313 .if defined(DEBUG_FLAGS)
314 CLEANFILES+= ${FULLPROG} ${PROG}.debug
319 _INSTALLFLAGS:= ${INSTALLFLAGS}
320 .for ie in ${INSTALLFLAGS_EDIT}
321 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
324 .if !target(realinstall)
325 KERN_DEBUGDIR?= ${DEBUGDIR}
326 realinstall: _kmodinstall
327 .ORDER: beforeinstall _kmodinstall
329 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
330 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
331 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
332 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
333 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
336 .include <bsd.links.mk>
338 .if !defined(NO_XREF)
339 afterinstall: _kldxref
340 .ORDER: realinstall _kldxref
341 .ORDER: _installlinks _kldxref
343 @if type kldxref >/dev/null 2>&1; then \
344 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
345 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \
348 .endif # !target(realinstall)
350 .endif # !target(install)
354 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
359 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
363 reload: unload load .PHONY
366 .if defined(KERNBUILDDIR)
367 .PATH: ${KERNBUILDDIR}
368 CFLAGS+= -I${KERNBUILDDIR}
369 .for _src in ${SRCS:Mopt_*.h}
373 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
377 .for _src in ${SRCS:Mopt_*.h}
386 # Add the sanitizer C flags
387 CFLAGS+= ${SAN_CFLAGS}
390 CFLAGS+= ${GCOV_CFLAGS}
392 # Respect configuration-specific C flags.
393 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
395 .if !empty(SRCS:Mvnode_if.c)
396 CLEANFILES+= vnode_if.c
397 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
398 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
401 .if !empty(SRCS:Mvnode_if.h)
402 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
403 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
404 ${SYSDIR}/kern/vnode_if.src
405 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
406 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
408 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
410 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
413 # Build _if.[ch] from _if.m, and clean them when we're done.
414 # __MPATH defined in config.mk
415 _MFILES=${__MPATH:T:O}
416 _MPATH=${__MPATH:H:O:u}
418 .for _i in ${SRCS:M*_if.[ch]}
419 _MATCH=M${_i:R:S/$/.m/}
420 _MATCHES=${_MFILES:${_MATCH}}
425 .m.c: ${SYSDIR}/tools/makeobjops.awk
426 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
428 .m.h: ${SYSDIR}/tools/makeobjops.awk
429 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
431 .for _i in mii pccard
432 .if !empty(SRCS:M${_i}devs.h)
433 CLEANFILES+= ${_i}devs.h
434 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
435 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
439 .if !empty(SRCS:Mbhnd_nvram_map.h)
440 CLEANFILES+= bhnd_nvram_map.h
441 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
442 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
443 ${SYSDIR}/dev/bhnd/nvram/nvram_map
445 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
446 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
449 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
450 CLEANFILES+= bhnd_nvram_map_data.h
451 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
452 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
453 ${SYSDIR}/dev/bhnd/nvram/nvram_map
454 bhnd_nvram_map_data.h:
455 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
456 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
459 .if !empty(SRCS:Musbdevs.h)
460 CLEANFILES+= usbdevs.h
461 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
462 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
465 .if !empty(SRCS:Musbdevs_data.h)
466 CLEANFILES+= usbdevs_data.h
467 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
468 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
471 .if !empty(SRCS:Msdiodevs.h)
472 CLEANFILES+= sdiodevs.h
473 sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
474 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h
477 .if !empty(SRCS:Msdiodevs_data.h)
478 CLEANFILES+= sdiodevs_data.h
479 sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs
480 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d
483 .if !empty(SRCS:Macpi_quirks.h)
484 CLEANFILES+= acpi_quirks.h
485 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
486 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
489 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
490 CLEANFILES+= assym.inc genassym.o
491 DEPENDOBJS+= genassym.o
494 .if defined(MODULE_TIED)
497 .if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc)
498 CLEANFILES+= offset.inc genoffset.o
499 DEPENDOBJS+= genoffset.o
501 assym.inc: genassym.o
502 offset.inc: genoffset.o
503 assym.inc: ${SYSDIR}/kern/genassym.sh
504 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
505 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc
506 genassym.o: ${SRCS:Mopt_*.h}
507 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
508 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
509 offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o
510 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET}
511 genoffset.o: ${SYSDIR}/kern/genoffset.c
512 genoffset.o: ${SRCS:Mopt_*.h}
513 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
514 ${SYSDIR}/kern/genoffset.c
516 CLEANDEPENDFILES+= ${_ILINKS}
517 # .depend needs include links so we remove them only together.
521 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
522 .if defined(KERNBUILDDIR)
523 OBJS_DEPEND_GUESS+= opt_global.h
526 .include <bsd.dep.mk>
527 .include <bsd.clang-analyze.mk>
528 .include <bsd.obj.mk>