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]
48 # Set to the location of the kernel build directory where
49 # the opt_*.h files, .o's and kernel winds up.
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
67 # Unload if loaded, then load.
71 KMODLOAD?= /sbin/kldload
72 KMODUNLOAD?= /sbin/kldunload
73 KMODISLOADED?= /sbin/kldstat -q -n
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>
83 # Search for kernel source tree in standard places.
84 .if empty(KERNBUILDDIR)
86 .for _dir in ${SRCTOP:D${SRCTOP}/sys} \
87 ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
88 .if !defined(SYSDIR) && exists(${_dir}/kern/)
93 .if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
94 .error "can't find kernel source tree"
98 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
100 # amd64 and mips use direct linking for kmod, all others use shared binaries
101 .if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
107 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
108 CFLAGS+= -fno-strict-aliasing
113 CFLAGS+= -DKLD_MODULE
115 # Don't use any standard or source-relative include directories.
117 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
118 .if defined(KERNBUILDDIR)
119 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
122 # Add -I paths for system headers. Individual module makefiles don't
123 # need any -I paths for this. Similar defaults for .PATH can't be
124 # set because there are no standard paths for non-headers.
125 CFLAGS+= -I. -I${SYSDIR} -I${SYSDIR}/contrib/ck/include
127 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
128 CFLAGS.gcc+= -fms-extensions
129 CFLAGS.gcc+= --param inline-unit-growth=100
130 CFLAGS.gcc+= --param large-function-growth=1000
132 # Disallow common variables, and if we end up with commons from
133 # somewhere unexpected, allocate storage for them in the module itself.
135 LDFLAGS+= -d -warn-common
137 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
138 LDFLAGS+= -Wl,--build-id=sha1
141 CFLAGS+= ${DEBUG_FLAGS}
142 .if ${MACHINE_CPUARCH} == amd64
143 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
146 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
150 # Temporary workaround for PR 196407, which contains the fascinating details.
151 # Don't allow clang to use fpu instructions or registers in kernel modules.
152 .if ${MACHINE_CPUARCH} == arm
153 .if ${COMPILER_VERSION} < 30800
154 CFLAGS.clang+= -mllvm -arm-use-movt=0
156 CFLAGS.clang+= -mno-movt
158 CFLAGS.clang+= -mfpu=none
159 CFLAGS+= -funwind-tables
162 .if ${MACHINE_CPUARCH} == powerpc
163 CFLAGS+= -mlongcall -fno-omit-frame-pointer
166 .if ${MACHINE_CPUARCH} == mips
167 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
170 .if defined(DEBUG) || defined(DEBUG_FLAGS)
175 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
176 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
177 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
179 SRCS+= ${KMOD:S/$/.c/}
180 CLEANFILES+= ${KMOD:S/$/.c/}
182 .for _firmw in ${FIRMWS}
183 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
184 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
185 @if [ -e ${_firmw:C/\:.*$//} ]; then \
186 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
187 -m ${LD_EMULATION} -r -d \
188 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
190 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
191 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
192 -m ${LD_EMULATION} -r -d \
193 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
194 rm ${_firmw:C/\:.*$//}; \
197 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
201 # Conditionally include SRCS based on kernel config options.
202 .for _o in ${KERN_OPTS}
206 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
212 .if !defined(DEBUG_FLAGS)
215 FULLPROG= ${PROG}.full
216 ${PROG}: ${FULLPROG} ${PROG}.debug
217 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
218 ${FULLPROG} ${.TARGET}
219 ${PROG}.debug: ${FULLPROG}
220 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
223 .if ${__KLD_SHARED} == yes
224 ${FULLPROG}: ${KMOD}.kld
225 ${LD} -m ${LD_EMULATION} -Bshareable -znotext ${_LDFLAGS} \
226 -o ${.TARGET} ${KMOD}.kld
227 .if !defined(DEBUG_FLAGS)
228 ${OBJCOPY} --strip-debug ${.TARGET}
233 .if ${EXPORT_SYMS} != YES
234 CLEANFILES+= export_syms
237 .if ${__KLD_SHARED} == yes
242 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
243 .if ${MK_CTF} != "no"
244 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
246 .if defined(EXPORT_SYMS)
247 .if ${EXPORT_SYMS} != YES
248 .if ${EXPORT_SYMS} == NO
250 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
251 echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
253 grep -v '^#' < ${EXPORT_SYMS} > export_syms
255 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
256 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
258 .endif # defined(EXPORT_SYMS)
259 .if defined(PREFIX_SYMS)
260 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
261 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
263 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
264 ${OBJCOPY} --strip-debug ${.TARGET}
268 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
269 _ILINKS+=${MACHINE_CPUARCH}
271 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
274 CLEANFILES+=${_ILINKS}
278 beforedepend: ${_ILINKS}
279 beforebuild: ${_ILINKS}
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 .for _link in ${_ILINKS}
284 .if !exists(${.OBJDIR}/${_link})
285 OBJS_DEPEND_GUESS+= ${_link}
292 @case ${.TARGET} in \
294 path=${SYSDIR}/${MACHINE}/include ;; \
296 path=${SYSDIR}/${.TARGET:T}/include ;; \
298 path=`(cd $$path && /bin/pwd)` ; \
299 ${ECHO} ${.TARGET:T} "->" $$path ; \
300 ln -fns $$path ${.TARGET:T}
302 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
304 .if defined(DEBUG_FLAGS)
305 CLEANFILES+= ${FULLPROG} ${PROG}.debug
310 _INSTALLFLAGS:= ${INSTALLFLAGS}
311 .for ie in ${INSTALLFLAGS_EDIT}
312 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
315 .if !target(realinstall)
316 KERN_DEBUGDIR?= ${DEBUGDIR}
317 realinstall: _kmodinstall
318 .ORDER: beforeinstall _kmodinstall
320 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
321 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
322 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
323 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
324 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
327 .include <bsd.links.mk>
329 .if !defined(NO_XREF)
330 afterinstall: _kldxref
331 .ORDER: realinstall _kldxref
332 .ORDER: _installlinks _kldxref
334 @if type kldxref >/dev/null 2>&1; then \
335 ${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
336 kldxref ${DESTDIR}${KMODDIR}; \
339 .endif # !target(realinstall)
341 .endif # !target(install)
345 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
350 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
354 reload: unload load .PHONY
357 .if defined(KERNBUILDDIR)
358 .PATH: ${KERNBUILDDIR}
359 CFLAGS+= -I${KERNBUILDDIR}
360 .for _src in ${SRCS:Mopt_*.h}
364 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
368 .for _src in ${SRCS:Mopt_*.h}
377 # Respect configuration-specific C flags.
378 CFLAGS+= ${ARCH_FLAGS} ${CONF_CFLAGS}
380 .if !empty(SRCS:Mvnode_if.c)
381 CLEANFILES+= vnode_if.c
382 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
383 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
386 .if !empty(SRCS:Mvnode_if.h)
387 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
388 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
389 ${SYSDIR}/kern/vnode_if.src
390 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
391 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
393 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
395 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
398 # Build _if.[ch] from _if.m, and clean them when we're done.
399 # __MPATH defined in config.mk
400 _MFILES=${__MPATH:T:O}
401 _MPATH=${__MPATH:H:O:u}
403 .for _i in ${SRCS:M*_if.[ch]}
404 _MATCH=M${_i:R:S/$/.m/}
405 _MATCHES=${_MFILES:${_MATCH}}
410 .m.c: ${SYSDIR}/tools/makeobjops.awk
411 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
413 .m.h: ${SYSDIR}/tools/makeobjops.awk
414 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
416 .for _i in mii pccard
417 .if !empty(SRCS:M${_i}devs.h)
418 CLEANFILES+= ${_i}devs.h
419 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
420 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
424 .if !empty(SRCS:Mbhnd_nvram_map.h)
425 CLEANFILES+= bhnd_nvram_map.h
426 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
427 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
428 ${SYSDIR}/dev/bhnd/nvram/nvram_map
430 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
431 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
434 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
435 CLEANFILES+= bhnd_nvram_map_data.h
436 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
437 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
438 ${SYSDIR}/dev/bhnd/nvram/nvram_map
439 bhnd_nvram_map_data.h:
440 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
441 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
444 .if !empty(SRCS:Musbdevs.h)
445 CLEANFILES+= usbdevs.h
446 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
447 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
450 .if !empty(SRCS:Musbdevs_data.h)
451 CLEANFILES+= usbdevs_data.h
452 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
453 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
456 .if !empty(SRCS:Macpi_quirks.h)
457 CLEANFILES+= acpi_quirks.h
458 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
459 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
462 .if !empty(SRCS:Massym.inc) || !empty(DPSRCS:Massym.inc)
463 CLEANFILES+= assym.inc genassym.o
464 DEPENDOBJS+= genassym.o
465 assym.inc: genassym.o
466 .if defined(KERNBUILDDIR)
467 genassym.o: opt_global.h
469 assym.inc: ${SYSDIR}/kern/genassym.sh
470 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
471 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
472 genassym.o: ${SRCS:Mopt_*.h}
473 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
474 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
477 .if defined(KERNBUILDDIR)
478 ${OBJS}: opt_global.h
481 CLEANDEPENDFILES+= ${_ILINKS}
482 # .depend needs include links so we remove them only together.
486 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
488 .include <bsd.dep.mk>
489 .include <bsd.clang-analyze.mk>
490 .include <bsd.obj.mk>