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