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 <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> 81.include "config.mk" 82 83# Search for kernel source tree in standard places. 84.if empty(KERNBUILDDIR) 85.if !defined(SYSDIR) 86.for _dir in ${SRCTOP:D${SRCTOP}/sys} \ 87 ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys 88.if !defined(SYSDIR) && exists(${_dir}/kern/) 89SYSDIR= ${_dir:tA} 90.endif 91.endfor 92.endif 93.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/) 94.error "can't find kernel source tree" 95.endif 96.endif 97 98.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m 99 100# amd64 and mips use direct linking for kmod, all others use shared binaries 101.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips 102__KLD_SHARED=yes 103.else 104__KLD_SHARED=no 105.endif 106 107ZLIB_CFLAGS+= -DZ_SOLO 108 109.if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing) 110CFLAGS+= -fno-strict-aliasing 111.endif 112WERROR?= -Werror 113CFLAGS+= ${WERROR} 114CFLAGS+= -D_KERNEL 115CFLAGS+= -DKLD_MODULE 116.if defined(MODULE_TIED) 117CFLAGS+= -DKLD_TIED 118.endif 119 120# Don't use any standard or source-relative include directories. 121NOSTDINC= -nostdinc 122CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*} 123.if defined(KERNBUILDDIR) 124CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h 125.endif 126 127# Add -I paths for system headers. Individual module makefiles don't 128# need any -I paths for this. Similar defaults for .PATH can't be 129# set because there are no standard paths for non-headers. 130CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include 131 132CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT} 133CFLAGS.gcc+= -fms-extensions 134CFLAGS.gcc+= --param inline-unit-growth=100 135CFLAGS.gcc+= --param large-function-growth=1000 136 137# Disallow common variables, and if we end up with commons from 138# somewhere unexpected, allocate storage for them in the module itself. 139CFLAGS+= -fno-common 140LDFLAGS+= -d -warn-common 141 142.if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id} 143LDFLAGS+= --build-id=sha1 144.endif 145 146CFLAGS+= ${DEBUG_FLAGS} 147.if ${MACHINE_CPUARCH} == amd64 148CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer 149.endif 150 151.if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv" 152CFLAGS+= -fPIC 153.endif 154 155# Temporary workaround for PR 196407, which contains the fascinating details. 156# Don't allow clang to use fpu instructions or registers in kernel modules. 157.if ${MACHINE_CPUARCH} == arm 158.if ${COMPILER_VERSION} < 30800 159CFLAGS.clang+= -mllvm -arm-use-movt=0 160.else 161CFLAGS.clang+= -mno-movt 162.endif 163CFLAGS.clang+= -mfpu=none 164CFLAGS+= -funwind-tables 165.endif 166 167.if ${MACHINE_CPUARCH} == powerpc 168CFLAGS+= -mlongcall -fno-omit-frame-pointer 169.endif 170 171.if ${MACHINE_CPUARCH} == mips 172CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls 173.endif 174 175.if defined(DEBUG) || defined(DEBUG_FLAGS) 176CTFFLAGS+= -g 177.endif 178 179.if defined(FIRMWS) 180${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk 181 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \ 182 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE} 183 184SRCS+= ${KMOD:S/$/.c/} 185CLEANFILES+= ${KMOD:S/$/.c/} 186 187.for _firmw in ${FIRMWS} 188${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//} 189 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}} 190 @if [ -e ${_firmw:C/\:.*$//} ]; then \ 191 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \ 192 -m ${LD_EMULATION} -r -d \ 193 -o ${.TARGET} ${_firmw:C/\:.*$//}; \ 194 else \ 195 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \ 196 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \ 197 -m ${LD_EMULATION} -r -d \ 198 -o ${.TARGET} ${_firmw:C/\:.*$//}; \ 199 rm ${_firmw:C/\:.*$//}; \ 200 fi 201 202OBJS+= ${_firmw:C/\:.*$/.fwo/:T} 203.endfor 204.endif 205 206# Conditionally include SRCS based on kernel config options. 207.for _o in ${KERN_OPTS} 208SRCS+=${SRCS.${_o}} 209.endfor 210 211OBJS+= ${SRCS:N*.h:R:S/$/.o/g} 212 213.if !defined(PROG) 214PROG= ${KMOD}.ko 215.endif 216 217.if !defined(DEBUG_FLAGS) 218FULLPROG= ${PROG} 219.else 220FULLPROG= ${PROG}.full 221${PROG}: ${FULLPROG} ${PROG}.debug 222 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \ 223 ${FULLPROG} ${.TARGET} 224${PROG}.debug: ${FULLPROG} 225 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET} 226.endif 227 228.if ${__KLD_SHARED} == yes 229${FULLPROG}: ${KMOD}.kld 230 ${LD} -m ${LD_EMULATION} -Bshareable -znotext ${_LDFLAGS} \ 231 -o ${.TARGET} ${KMOD}.kld 232.if !defined(DEBUG_FLAGS) 233 ${OBJCOPY} --strip-debug ${.TARGET} 234.endif 235.endif 236 237EXPORT_SYMS?= NO 238.if ${EXPORT_SYMS} != YES 239CLEANFILES+= export_syms 240.endif 241 242.if ${__KLD_SHARED} == yes 243${KMOD}.kld: ${OBJS} 244.else 245${FULLPROG}: ${OBJS} 246.endif 247.if !defined(FIRMWS) && (${MACHINE_CPUARCH} == "i386") 248 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r \ 249 -T ${SYSDIR}/conf/ldscript.set_padding \ 250 -d -o ${.TARGET} ${OBJS} 251.else 252 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS} 253.endif 254.if ${MK_CTF} != "no" 255 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS} 256.endif 257.if defined(EXPORT_SYMS) 258.if ${EXPORT_SYMS} != YES 259.if ${EXPORT_SYMS} == NO 260 :> export_syms 261.elif !exists(${.CURDIR}/${EXPORT_SYMS}) 262 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms 263.else 264 grep -v '^#' < ${EXPORT_SYMS} > export_syms 265.endif 266 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \ 267 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET} 268.endif 269.endif # defined(EXPORT_SYMS) 270.if defined(PREFIX_SYMS) 271 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \ 272 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET} 273.endif 274.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no 275 ${OBJCOPY} --strip-debug ${.TARGET} 276.endif 277 278.if ${COMPILER_TYPE} == "clang" || \ 279 (${COMPILER_TYPE} == "gcc" && ${COMPILER_VERSION} >= 60000) 280_MAP_DEBUG_PREFIX= yes 281.endif 282 283_ILINKS=machine 284.if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64" 285_ILINKS+=${MACHINE_CPUARCH} 286.endif 287.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64" 288_ILINKS+=x86 289.endif 290CLEANFILES+=${_ILINKS} 291 292all: ${PROG} 293 294beforedepend: ${_ILINKS} 295beforebuild: ${_ILINKS} 296 297# Ensure that the links exist without depending on it when it exists which 298# causes all the modules to be rebuilt when the directory pointed to changes. 299# Ensure that debug info references the path in the source tree. 300.for _link in ${_ILINKS} 301.if !exists(${.OBJDIR}/${_link}) 302OBJS_DEPEND_GUESS+= ${_link} 303.endif 304.if defined(_MAP_DEBUG_PREFIX) 305.if ${_link} == "machine" 306CFLAGS+= -fdebug-prefix-map=./machine=${SYSDIR}/${MACHINE}/include 307.else 308CFLAGS+= -fdebug-prefix-map=./${_link}=${SYSDIR}/${_link}/include 309.endif 310.endif 311.endfor 312 313.NOPATH: ${_ILINKS} 314 315${_ILINKS}: 316 @case ${.TARGET} in \ 317 machine) \ 318 path=${SYSDIR}/${MACHINE}/include ;; \ 319 *) \ 320 path=${SYSDIR}/${.TARGET:T}/include ;; \ 321 esac ; \ 322 path=`(cd $$path && /bin/pwd)` ; \ 323 ${ECHO} ${.TARGET:T} "->" $$path ; \ 324 ln -fns $$path ${.TARGET:T} 325 326CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS} 327 328.if defined(DEBUG_FLAGS) 329CLEANFILES+= ${FULLPROG} ${PROG}.debug 330.endif 331 332.if !target(install) 333 334_INSTALLFLAGS:= ${INSTALLFLAGS} 335.for ie in ${INSTALLFLAGS_EDIT} 336_INSTALLFLAGS:= ${_INSTALLFLAGS${ie}} 337.endfor 338 339.if !target(realinstall) 340KERN_DEBUGDIR?= ${DEBUGDIR} 341realinstall: _kmodinstall 342.ORDER: beforeinstall _kmodinstall 343_kmodinstall: .PHONY 344 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \ 345 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/ 346.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no" 347 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \ 348 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/ 349.endif 350 351.include <bsd.links.mk> 352 353.if !defined(NO_XREF) 354afterinstall: _kldxref 355.ORDER: realinstall _kldxref 356.ORDER: _installlinks _kldxref 357_kldxref: .PHONY 358 @if type kldxref >/dev/null 2>&1; then \ 359 ${ECHO} ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \ 360 ${KLDXREF_CMD} ${DESTDIR}${KMODDIR}; \ 361 fi 362.endif 363.endif # !target(realinstall) 364 365.endif # !target(install) 366 367.if !target(load) 368load: ${PROG} .PHONY 369 ${KMODLOAD} -v ${.OBJDIR}/${PROG} 370.endif 371 372.if !target(unload) 373unload: .PHONY 374 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi 375.endif 376 377.if !target(reload) 378reload: unload load .PHONY 379.endif 380 381.if defined(KERNBUILDDIR) 382.PATH: ${KERNBUILDDIR} 383CFLAGS+= -I${KERNBUILDDIR} 384.for _src in ${SRCS:Mopt_*.h} 385CLEANFILES+= ${_src} 386.if !target(${_src}) 387${_src}: 388 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET} 389.endif 390.endfor 391.else 392.for _src in ${SRCS:Mopt_*.h} 393CLEANFILES+= ${_src} 394.if !target(${_src}) 395${_src}: 396 :> ${.TARGET} 397.endif 398.endfor 399.endif 400 401# Add the sanitizer C flags 402CFLAGS+= ${SAN_CFLAGS} 403 404# Add the gcov flags 405CFLAGS+= ${GCOV_CFLAGS} 406 407# Respect configuration-specific C flags. 408CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS} 409 410.if !empty(SRCS:Mvnode_if.c) 411CLEANFILES+= vnode_if.c 412vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src 413 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c 414.endif 415 416.if !empty(SRCS:Mvnode_if.h) 417CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h 418vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \ 419 ${SYSDIR}/kern/vnode_if.src 420vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h 421 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h 422vnode_if_newproto.h: 423 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p 424vnode_if_typedef.h: 425 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q 426.endif 427 428# Build _if.[ch] from _if.m, and clean them when we're done. 429# __MPATH defined in config.mk 430_MFILES=${__MPATH:T:O} 431_MPATH=${__MPATH:H:O:u} 432.PATH.m: ${_MPATH} 433.for _i in ${SRCS:M*_if.[ch]} 434_MATCH=M${_i:R:S/$/.m/} 435_MATCHES=${_MFILES:${_MATCH}} 436.if !empty(_MATCHES) 437CLEANFILES+= ${_i} 438.endif 439.endfor # _i 440.m.c: ${SYSDIR}/tools/makeobjops.awk 441 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c 442 443.m.h: ${SYSDIR}/tools/makeobjops.awk 444 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h 445 446.for _i in mii pccard 447.if !empty(SRCS:M${_i}devs.h) 448CLEANFILES+= ${_i}devs.h 449${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs 450 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs 451.endif 452.endfor # _i 453 454.if !empty(SRCS:Mbhnd_nvram_map.h) 455CLEANFILES+= bhnd_nvram_map.h 456bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \ 457 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 458 ${SYSDIR}/dev/bhnd/nvram/nvram_map 459bhnd_nvram_map.h: 460 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 461 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h 462.endif 463 464.if !empty(SRCS:Mbhnd_nvram_map_data.h) 465CLEANFILES+= bhnd_nvram_map_data.h 466bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \ 467 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 468 ${SYSDIR}/dev/bhnd/nvram/nvram_map 469bhnd_nvram_map_data.h: 470 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \ 471 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d 472.endif 473 474.if !empty(SRCS:Musbdevs.h) 475CLEANFILES+= usbdevs.h 476usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs 477 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h 478.endif 479 480.if !empty(SRCS:Musbdevs_data.h) 481CLEANFILES+= usbdevs_data.h 482usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs 483 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d 484.endif 485 486.if !empty(SRCS:Msdiodevs.h) 487CLEANFILES+= sdiodevs.h 488sdiodevs.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs 489 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -h 490.endif 491 492.if !empty(SRCS:Msdiodevs_data.h) 493CLEANFILES+= sdiodevs_data.h 494sdiodevs_data.h: ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs 495 ${AWK} -f ${SYSDIR}/tools/sdiodevs2h.awk ${SYSDIR}/dev/sdio/sdiodevs -d 496.endif 497 498.if !empty(SRCS:Macpi_quirks.h) 499CLEANFILES+= acpi_quirks.h 500acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks 501 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks 502.endif 503 504.if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc) 505CLEANFILES+= assym.inc genassym.o 506DEPENDOBJS+= genassym.o 507DPSRCS+= offset.inc 508.endif 509.if defined(MODULE_TIED) 510DPSRCS+= offset.inc 511.endif 512.if !empty(SRCS:Moffset.inc) || !empty(DPSRCS:Moffset.inc) 513CLEANFILES+= offset.inc genoffset.o 514DEPENDOBJS+= genoffset.o 515.endif 516assym.inc: genassym.o 517offset.inc: genoffset.o 518assym.inc: ${SYSDIR}/kern/genassym.sh 519 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET} 520genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c offset.inc 521genassym.o: ${SRCS:Mopt_*.h} 522 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \ 523 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c 524offset.inc: ${SYSDIR}/kern/genoffset.sh genoffset.o 525 sh ${SYSDIR}/kern/genoffset.sh genoffset.o > ${.TARGET} 526genoffset.o: ${SYSDIR}/kern/genoffset.c 527genoffset.o: ${SRCS:Mopt_*.h} 528 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \ 529 ${SYSDIR}/kern/genoffset.c 530 531CLEANDEPENDFILES+= ${_ILINKS} 532# .depend needs include links so we remove them only together. 533cleanilinks: 534 rm -f ${_ILINKS} 535 536OBJS_DEPEND_GUESS+= ${SRCS:M*.h} 537.if defined(KERNBUILDDIR) 538OBJS_DEPEND_GUESS+= opt_global.h 539.endif 540 541.include <bsd.dep.mk> 542.include <bsd.clang-analyze.mk> 543.include <bsd.obj.mk> 544.include "kern.mk" 545