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]
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
63 # Unload if loaded, then load.
67 KMODLOAD?= /sbin/kldload
68 KMODUNLOAD?= /sbin/kldunload
69 KMODISLOADED?= /sbin/kldstat -q -n
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>
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/)
85 .if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
86 .error "can't find kernel source tree"
89 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
91 # amd64 and mips use direct linking for kmod, all others use shared binaries
92 .if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
98 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
99 CFLAGS+= -fno-strict-aliasing
104 CFLAGS+= -DKLD_MODULE
106 # Don't use any standard or source-relative include directories.
108 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
109 .if defined(KERNBUILDDIR)
110 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
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.
116 CFLAGS+= -I. -I${SYSDIR}
118 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
119 CFLAGS.gcc+= -fms-extensions
120 CFLAGS.gcc+= --param inline-unit-growth=100
121 CFLAGS.gcc+= --param large-function-growth=1000
123 # Disallow common variables, and if we end up with commons from
124 # somewhere unexpected, allocate storage for them in the module itself.
126 LDFLAGS+= -d -warn-common
128 CFLAGS+= ${DEBUG_FLAGS}
129 .if ${MACHINE_CPUARCH} == amd64
130 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
133 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
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
141 CFLAGS.clang+= -mllvm -arm-use-movt=0
143 CFLAGS.clang+= -mno-movt
145 CFLAGS.clang+= -mfpu=none
146 CFLAGS+= -funwind-tables
149 .if ${MACHINE_CPUARCH} == powerpc
150 CFLAGS+= -mlongcall -fno-omit-frame-pointer
153 .if ${MACHINE_CPUARCH} == mips
154 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
157 .if defined(DEBUG) || defined(DEBUG_FLAGS)
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}
166 SRCS+= ${KMOD:S/$/.c/}
167 CLEANFILES+= ${KMOD:S/$/.c/}
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/\:.*$//}; \
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/\:.*$//}; \
184 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
188 # Conditionally include SRCS based on kernel config options.
189 .for _o in ${KERN_OPTS}
193 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
199 .if !defined(DEBUG_FLAGS)
202 FULLPROG= ${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}
210 .if ${__KLD_SHARED} == yes
211 ${FULLPROG}: ${KMOD}.kld
212 ${LD} -m ${LD_EMULATION} -Bshareable -znotext ${_LDFLAGS} \
213 -o ${.TARGET} ${KMOD}.kld
214 .if !defined(DEBUG_FLAGS)
215 ${OBJCOPY} --strip-debug ${.TARGET}
220 .if ${EXPORT_SYMS} != YES
221 CLEANFILES+= export_syms
224 .if ${__KLD_SHARED} == yes
229 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
230 .if ${MK_CTF} != "no"
231 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
233 .if defined(EXPORT_SYMS)
234 .if ${EXPORT_SYMS} != YES
235 .if ${EXPORT_SYMS} == NO
237 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
238 echo ${EXPORT_SYMS} > export_syms
240 grep -v '^#' < ${EXPORT_SYMS} > export_syms
242 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
243 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
246 .if defined(PREFIX_SYMS)
247 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
248 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
250 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
251 ${OBJCOPY} --strip-debug ${.TARGET}
255 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
256 _ILINKS+=${MACHINE_CPUARCH}
258 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
261 CLEANFILES+=${_ILINKS}
265 beforedepend: ${_ILINKS}
266 beforebuild: ${_ILINKS}
268 # Ensure that the links exist without depending on it when it exists which
269 # causes all the modules to be rebuilt when the directory pointed to changes.
270 .for _link in ${_ILINKS}
271 .if !exists(${.OBJDIR}/${_link})
272 OBJS_DEPEND_GUESS+= ${_link}
279 @case ${.TARGET} in \
281 path=${SYSDIR}/${MACHINE}/include ;; \
283 path=${SYSDIR}/${.TARGET:T}/include ;; \
285 path=`(cd $$path && /bin/pwd)` ; \
286 ${ECHO} ${.TARGET:T} "->" $$path ; \
287 ln -fhs $$path ${.TARGET:T}
289 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
291 .if defined(DEBUG_FLAGS)
292 CLEANFILES+= ${FULLPROG} ${PROG}.debug
297 _INSTALLFLAGS:= ${INSTALLFLAGS}
298 .for ie in ${INSTALLFLAGS_EDIT}
299 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
302 .if !target(realinstall)
303 KERN_DEBUGDIR?= ${DEBUGDIR}
304 realinstall: _kmodinstall
305 .ORDER: beforeinstall _kmodinstall
307 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
308 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
309 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
310 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
311 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
314 .include <bsd.links.mk>
316 .if !defined(NO_XREF)
317 afterinstall: _kldxref
318 .ORDER: realinstall _kldxref
319 .ORDER: _installlinks _kldxref
321 @if type kldxref >/dev/null 2>&1; then \
322 ${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
323 kldxref ${DESTDIR}${KMODDIR}; \
326 .endif # !target(realinstall)
328 .endif # !target(install)
332 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
337 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
341 reload: unload load .PHONY
344 .if defined(KERNBUILDDIR)
345 .PATH: ${KERNBUILDDIR}
346 CFLAGS+= -I${KERNBUILDDIR}
347 .for _src in ${SRCS:Mopt_*.h}
351 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
355 .for _src in ${SRCS:Mopt_*.h}
364 # Respect configuration-specific C flags.
365 CFLAGS+= ${CONF_CFLAGS}
367 .if !empty(SRCS:Mvnode_if.c)
368 CLEANFILES+= vnode_if.c
369 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
370 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
373 .if !empty(SRCS:Mvnode_if.h)
374 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
375 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
376 ${SYSDIR}/kern/vnode_if.src
377 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
378 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
380 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
382 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
385 # Build _if.[ch] from _if.m, and clean them when we're done.
386 # __MPATH defined in config.mk
387 _MFILES=${__MPATH:T:O}
388 _MPATH=${__MPATH:H:O:u}
390 .for _i in ${SRCS:M*_if.[ch]}
391 _MATCH=M${_i:R:S/$/.m/}
392 _MATCHES=${_MFILES:${_MATCH}}
397 .m.c: ${SYSDIR}/tools/makeobjops.awk
398 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
400 .m.h: ${SYSDIR}/tools/makeobjops.awk
401 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
403 .for _i in mii pccard
404 .if !empty(SRCS:M${_i}devs.h)
405 CLEANFILES+= ${_i}devs.h
406 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
407 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
411 .if !empty(SRCS:Mbhnd_nvram_map.h)
412 CLEANFILES+= bhnd_nvram_map.h
413 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
414 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
415 ${SYSDIR}/dev/bhnd/nvram/nvram_map
417 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
418 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
421 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
422 CLEANFILES+= bhnd_nvram_map_data.h
423 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
424 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
425 ${SYSDIR}/dev/bhnd/nvram/nvram_map
426 bhnd_nvram_map_data.h:
427 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
428 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
431 .if !empty(SRCS:Musbdevs.h)
432 CLEANFILES+= usbdevs.h
433 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
434 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
437 .if !empty(SRCS:Musbdevs_data.h)
438 CLEANFILES+= usbdevs_data.h
439 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
440 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
443 .if !empty(SRCS:Macpi_quirks.h)
444 CLEANFILES+= acpi_quirks.h
445 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
446 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
449 .if !empty(SRCS:Massym.s) || !empty(DPSRCS:Massym.s)
450 CLEANFILES+= assym.s genassym.o
451 DEPENDOBJS+= genassym.o
453 .if defined(KERNBUILDDIR)
454 genassym.o: opt_global.h
456 assym.s: ${SYSDIR}/kern/genassym.sh
457 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
458 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
459 genassym.o: ${SRCS:Mopt_*.h}
460 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
461 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
465 ${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
467 .if defined(KERNBUILDDIR)
468 ${OBJS}: opt_global.h
471 CLEANDEPENDFILES+= ${_ILINKS}
472 # .depend needs include links so we remove them only together.
476 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
478 .include <bsd.dep.mk>
479 .include <bsd.clang-analyze.mk>
480 .include <bsd.obj.mk>