1# From: @(#)bsd.prog.mk 5.26 (Berkeley) 6/25/91 2# $FreeBSD$ 3# 4# The include file <bsd.kmod.mk> handles building and installing loadable 5# kernel modules. 6# 7# 8# +++ variables +++ 9# 10# CLEANFILES Additional files to remove for the clean and cleandir targets. 11# 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 15# exported. 16# 17# KMOD The name of the kernel module to build. 18# 19# KMODDIR Base path for kernel modules (see kld(4)). [/boot/kernel] 20# 21# KMODOWN Module file owner. [${BINOWN}] 22# 23# KMODGRP Module file group. [${BINGRP}] 24# 25# KMODMODE Module file mode. [${BINMODE}] 26# 27# KMODLOAD Command to load a kernel module [/sbin/kldload] 28# 29# KMODUNLOAD Command to unload a kernel module [/sbin/kldunload] 30# 31# KMODISLOADED Command to check whether a kernel module is 32# loaded [/sbin/kldstat -q -n] 33# 34# PROG The name of the kernel module to build. 35# If not supplied, ${KMOD}.ko is used. 36# 37# SRCS List of source files. 38# 39# FIRMWS List of firmware images in format filename:shortname:version 40# 41# FIRMWARE_LICENSE 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 44# 45# DESTDIR The tree where the module gets installed. [not set] 46# 47# KERNBUILDDIR 48# Set to the location of the kernel build directory where 49# the opt_*.h files, .o's and kernel winds up. 50# 51# +++ targets +++ 52# 53# install: 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 58# is executed. 59# 60# load: 61# Load a module. 62# 63# unload: 64# Unload a module. 65# 66# reload: 67# Unload if loaded, then load. 68# 69 70AWK?= awk 71KMODLOAD?= /sbin/kldload 72KMODUNLOAD?= /sbin/kldunload 73KMODISLOADED?= /sbin/kldstat -q -n 74OBJCOPY?= objcopy 75 76.include "kmod.opts.mk" 77.include <bsd.sysdir.mk> 78 79.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m 80 81# amd64 and mips use direct linking for kmod, all others use shared binaries 82.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips 83__KLD_SHARED=yes 84.else 85__KLD_SHARED=no 86.endif 87 88.if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing) 89CFLAGS+= -fno-strict-aliasing 90.endif 91.if ${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} < 50000 92WERROR?= -Wno-error 93.else 94WERROR?= -Werror 95.endif 96 97CFLAGS+= ${WERROR} 98CFLAGS+= -D_KERNEL 99CFLAGS+= -DKLD_MODULE 100.if defined(MODULE_TIED) 101CFLAGS+= -DKLD_TIED 102.endif 103 104# Don't use any standard or source-relative include directories. 105NOSTDINC= -nostdinc 106CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*} 107.if defined(KERNBUILDDIR) 108CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h 109.endif 110 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. 114CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include 115 116CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT} 117CFLAGS.gcc+= -fms-extensions 118CFLAGS.gcc+= --param inline-unit-growth=100 119CFLAGS.gcc+= --param large-function-growth=1000 120 121# Disallow common variables, and if we end up with commons from 122# somewhere unexpected, allocate storage for them in the module itself. 123CFLAGS+= -fno-common 124LDFLAGS+= -d -warn-common 125 126.if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id} 127LDFLAGS+= --build-id=sha1 128.endif 129 130CFLAGS+= ${DEBUG_FLAGS} 131.if ${MACHINE_CPUARCH} == amd64 132CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer 133.endif 134 135.if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" 136CFLAGS+= -fPIC 137.endif 138 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 143CFLAGS.clang+= -mllvm -arm-use-movt=0 144.else 145CFLAGS.clang+= -mno-movt 146.endif 147CFLAGS.clang+= -mfpu=none 148CFLAGS+= -funwind-tables 149.endif 150 151.if ${MACHINE_CPUARCH} == powerpc 152CFLAGS+= -mlongcall -fno-omit-frame-pointer 153.if ${LINKER_TYPE} == "lld" 154# TOC optimization in LLD (9.0) currently breaks kernel modules, so disable it 155LDFLAGS+= --no-toc-optimize 156.endif 157.endif 158 159.if ${MACHINE_CPUARCH} == mips 160CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls 161.endif 162 163.if defined(DEBUG) || defined(DEBUG_FLAGS) 164CTFFLAGS+= -g 165.endif 166 167.if defined(FIRMWS) 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} 171 172SRCS+= ${KMOD:S/$/.c/} 173CLEANFILES+= ${KMOD:S/$/.c/} 174 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/\:.*$//}; \ 182 else \ 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/\:.*$//}; \ 188 fi 189 190OBJS+= ${_firmw:C/\:.*$/.fwo/:T} 191.endfor 192.endif 193 194# Conditionally include SRCS based on kernel config options. 195.for _o in ${KERN_OPTS} 196SRCS+=${SRCS.${_o}} 197.endfor 198 199OBJS+= ${SRCS:N*.h:R:S/$/.o/g} 200 201.if !defined(PROG) 202PROG= ${KMOD}.ko 203.endif 204 205.if !defined(DEBUG_FLAGS) 206FULLPROG= ${PROG} 207.else 208FULLPROG= ${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} 214.endif 215 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} 222.endif 223.endif 224 225EXPORT_SYMS?= NO 226.if ${EXPORT_SYMS} != YES 227CLEANFILES+= export_syms 228.endif 229 230.if exists(${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH}) 231LDSCRIPT_FLAGS?= -T ${SYSDIR}/conf/ldscript.kmod.${MACHINE_ARCH} 232.endif 233 234.if ${__KLD_SHARED} == yes 235${KMOD}.kld: ${OBJS} 236.else 237${FULLPROG}: ${OBJS} 238.endif 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} 243.endif 244.if defined(EXPORT_SYMS) 245.if ${EXPORT_SYMS} != YES 246.if ${EXPORT_SYMS} == NO 247 :> export_syms 248.elif !exists(${.CURDIR}/${EXPORT_SYMS}) 249 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms 250.else 251 grep -v '^#' < ${EXPORT_SYMS} > export_syms 252.endif 253 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \ 254 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET} 255.endif 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} 260.endif 261.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no 262 ${OBJCOPY} --strip-debug ${.TARGET} 263.endif 264 265.if ${COMPILER_TYPE} == "clang" || \ 266 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000) 267_MAP_DEBUG_PREFIX= yes 268.endif 269 270_ILINKS=machine 271.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64" 272_ILINKS+=x86 273.endif 274CLEANFILES+=${_ILINKS} 275 276all: ${PROG} 277 278beforedepend: ${_ILINKS} 279beforebuild: ${_ILINKS} 280 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}) 286OBJS_DEPEND_GUESS+= ${_link} 287.endif 288.if defined(_MAP_DEBUG_PREFIX) 289.if ${_link} == "machine" 290CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include 291.else 292CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include 293.endif 294.endif 295.endfor 296 297.NOPATH: ${_ILINKS} 298 299${_ILINKS}: 300 @case ${.TARGET} in \ 301 machine) \ 302 path=${SYSDIR}/${MACHINE}/include ;; \ 303 *) \ 304 path=${SYSDIR}/${.TARGET:T}/include ;; \ 305 esac ; \ 306 path=`(cd $$path && /bin/pwd)` ; \ 307 ${ECHO} ${.TARGET:T} "->" $$path ; \ 308 ln -fns $$path ${.TARGET:T} 309 310CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS} 311 312.if defined(DEBUG_FLAGS) 313CLEANFILES+= ${FULLPROG} ${PROG}.debug 314.endif 315 316.if !target(install) 317 318_INSTALLFLAGS:= ${INSTALLFLAGS} 319.for ie in ${INSTALLFLAGS_EDIT} 320_INSTALLFLAGS:= ${_INSTALLFLAGS${ie}} 321.endfor 322 323.if !target(realinstall) 324KERN_DEBUGDIR?= ${DEBUGDIR} 325realinstall: _kmodinstall 326.ORDER: beforeinstall _kmodinstall 327_kmodinstall: .PHONY 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}/ 333.endif 334 335.include <bsd.links.mk> 336 337.if !defined(NO_XREF) 338afterinstall: _kldxref 339.ORDER: realinstall _kldxref 340.ORDER: _installlinks _kldxref 341_kldxref: .PHONY 342 @if type kldxref >/dev/null 2>&1; then \ 343 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \ 344 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \ 345 fi 346.endif 347.endif # !target(realinstall) 348 349.endif # !target(install) 350 351.if !target(load) 352load: ${PROG} .PHONY 353 ${KMODLOAD} -v ${.OBJDIR}/${PROG} 354.endif 355 356.if !target(unload) 357unload: .PHONY 358 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi 359.endif 360 361.if !target(reload) 362reload: unload load .PHONY 363.endif 364 365.if defined(KERNBUILDDIR) 366.PATH: ${KERNBUILDDIR} 367CFLAGS+= -I${KERNBUILDDIR} 368.for _src in ${SRCS:Mopt_*.h} 369CLEANFILES+= ${_src} 370.if !target(${_src}) 371${_src}: 372 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET} 373.endif 374.endfor 375.else 376.for _src in ${SRCS:Mopt_*.h} 377CLEANFILES+= ${_src} 378.if !target(${_src}) 379${_src}: 380 :> ${.TARGET} 381.endif 382.endfor 383.endif 384 385# Add the sanitizer C flags 386CFLAGS+= ${SAN_CFLAGS} 387 388# Add the gcov flags 389CFLAGS+= ${GCOV_CFLAGS} 390 391# Respect configuration-specific C flags. 392CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS} 393 394.if !empty(SRCS:Mvnode_if.c) 395CLEANFILES+= vnode_if.c 396vnode_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 398.endif 399 400.if !empty(SRCS:Mvnode_if.h) 401CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h 402vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \ 403 ${SYSDIR}/kern/vnode_if.src 404vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h 405 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h 406vnode_if_newproto.h: 407 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p 408vnode_if_typedef.h: 409 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q 410.endif 411 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} 416.PATH.m: ${_MPATH} 417.for _i in ${SRCS:M*_if.[ch]} 418_MATCH=M${_i:R:S/$/.m/} 419_MATCHES=${_MFILES:${_MATCH}} 420.if !empty(_MATCHES) 421CLEANFILES+= ${_i} 422.endif 423.endfor # _i 424.m.c: ${SYSDIR}/tools/makeobjops.awk 425 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c 426 427.m.h: ${SYSDIR}/tools/makeobjops.awk 428 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h 429 430.for _i in mii pccard 431.if !empty(SRCS:M${_i}devs.h) 432CLEANFILES+= ${_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 435.endif 436.endfor # _i 437 438.if !empty(SRCS:Mbhnd_nvram_map.h) 439CLEANFILES+= bhnd_nvram_map.h 440bhnd_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 443bhnd_nvram_map.h: 444 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 445 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h 446.endif 447 448.if !empty(SRCS:Mbhnd_nvram_map_data.h) 449CLEANFILES+= bhnd_nvram_map_data.h 450bhnd_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 453bhnd_nvram_map_data.h: 454 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 455 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d 456.endif 457 458.if !empty(SRCS:Musbdevs.h) 459CLEANFILES+= usbdevs.h 460usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs 461 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h 462.endif 463 464.if !empty(SRCS:Musbdevs_data.h) 465CLEANFILES+= usbdevs_data.h 466usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs 467 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d 468.endif 469 470.if !empty(SRCS:Msdiodevs.h) 471CLEANFILES+= sdiodevs.h 472sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs 473 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h 474.endif 475 476.if !empty(SRCS:Msdiodevs_data.h) 477CLEANFILES+= sdiodevs_data.h 478sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs 479 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d 480.endif 481 482.if !empty(SRCS:Macpi_quirks.h) 483CLEANFILES+= acpi_quirks.h 484acpi_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 486.endif 487 488.if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc) 489CLEANFILES+= assym.inc genassym.o 490DEPENDOBJS+= genassym.o 491DPSRCS+= offset.inc 492.endif 493.if defined(MODULE_TIED) 494DPSRCS+= offset.inc 495.endif 496.if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc) 497CLEANFILES+= offset.inc genoffset.o 498DEPENDOBJS+= genoffset.o 499.endif 500assym.inc: genassym.o 501offset.inc: genoffset.o 502assym.inc: ${SYSDIR}/kern/genassym.sh 503 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET} 504genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc 505genassym.o: ${SRCS:Mopt_*.h} 506 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \ 507 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c 508offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o 509 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET} 510genoffset.o: ${SYSDIR}/kern/genoffset.c 511genoffset.o: ${SRCS:Mopt_*.h} 512 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \ 513 ${SYSDIR}/kern/genoffset.c 514 515CLEANDEPENDFILES+= ${_ILINKS} 516# .depend needs include links so we remove them only together. 517cleanilinks: 518 rm -f ${_ILINKS} 519 520OBJS_DEPEND_GUESS+= ${SRCS:M*.h} 521.if defined(KERNBUILDDIR) 522OBJS_DEPEND_GUESS+= opt_global.h 523.endif 524 525.include <bsd.dep.mk> 526.include <bsd.clang-analyze.mk> 527.include <bsd.obj.mk> 528.include "kern.mk" 529