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