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 .if defined(LINKER_FEATURES) && ${LINKER_FEATURES:Mbuild-id}
129 LDFLAGS+= -Wl,--build-id=sha1
132 CFLAGS+= ${DEBUG_FLAGS}
133 .if ${MACHINE_CPUARCH} == amd64
134 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
137 .if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
141 # Temporary workaround for PR 196407, which contains the fascinating details.
142 # Don't allow clang to use fpu instructions or registers in kernel modules.
143 .if ${MACHINE_CPUARCH} == arm
144 .if ${COMPILER_VERSION} < 30800
145 CFLAGS.clang+= -mllvm -arm-use-movt=0
147 CFLAGS.clang+= -mno-movt
149 CFLAGS.clang+= -mfpu=none
150 CFLAGS+= -funwind-tables
153 .if ${MACHINE_CPUARCH} == powerpc
154 CFLAGS+= -mlongcall -fno-omit-frame-pointer
157 .if ${MACHINE_CPUARCH} == mips
158 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
161 .if defined(DEBUG) || defined(DEBUG_FLAGS)
166 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
167 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
168 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
170 SRCS+= ${KMOD:S/$/.c/}
171 CLEANFILES+= ${KMOD:S/$/.c/}
173 .for _firmw in ${FIRMWS}
174 ${_firmw:C/\:.*$/.fwo/:T}: ${_firmw:C/\:.*$//}
175 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
176 @if [ -e ${_firmw:C/\:.*$//} ]; then \
177 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
178 -m ${LD_EMULATION} -r -d \
179 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
181 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
182 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
183 -m ${LD_EMULATION} -r -d \
184 -o ${.TARGET} ${_firmw:C/\:.*$//}; \
185 rm ${_firmw:C/\:.*$//}; \
188 OBJS+= ${_firmw:C/\:.*$/.fwo/:T}
192 # Conditionally include SRCS based on kernel config options.
193 .for _o in ${KERN_OPTS}
197 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
203 .if !defined(DEBUG_FLAGS)
206 FULLPROG= ${PROG}.full
207 ${PROG}: ${FULLPROG} ${PROG}.debug
208 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
209 ${FULLPROG} ${.TARGET}
210 ${PROG}.debug: ${FULLPROG}
211 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
214 .if ${__KLD_SHARED} == yes
215 ${FULLPROG}: ${KMOD}.kld
216 ${LD} -m ${LD_EMULATION} -Bshareable -znotext ${_LDFLAGS} \
217 -o ${.TARGET} ${KMOD}.kld
218 .if !defined(DEBUG_FLAGS)
219 ${OBJCOPY} --strip-debug ${.TARGET}
224 .if ${EXPORT_SYMS} != YES
225 CLEANFILES+= export_syms
228 .if ${__KLD_SHARED} == yes
233 ${LD} -m ${LD_EMULATION} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
234 .if ${MK_CTF} != "no"
235 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
237 .if defined(EXPORT_SYMS)
238 .if ${EXPORT_SYMS} != YES
239 .if ${EXPORT_SYMS} == NO
241 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
242 echo ${EXPORT_SYMS} > export_syms
244 grep -v '^#' < ${EXPORT_SYMS} > export_syms
246 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
247 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
250 .if defined(PREFIX_SYMS)
251 ${AWK} -v prefix=${PREFIX_SYMS} -f ${SYSDIR}/conf/kmod_syms_prefix.awk \
252 ${.TARGET} /dev/null | xargs -J% ${OBJCOPY} % ${.TARGET}
254 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
255 ${OBJCOPY} --strip-debug ${.TARGET}
259 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
260 _ILINKS+=${MACHINE_CPUARCH}
262 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
265 CLEANFILES+=${_ILINKS}
269 beforedepend: ${_ILINKS}
270 beforebuild: ${_ILINKS}
272 # Ensure that the links exist without depending on it when it exists which
273 # causes all the modules to be rebuilt when the directory pointed to changes.
274 .for _link in ${_ILINKS}
275 .if !exists(${.OBJDIR}/${_link})
276 OBJS_DEPEND_GUESS+= ${_link}
283 @case ${.TARGET} in \
285 path=${SYSDIR}/${MACHINE}/include ;; \
287 path=${SYSDIR}/${.TARGET:T}/include ;; \
289 path=`(cd $$path && /bin/pwd)` ; \
290 ${ECHO} ${.TARGET:T} "->" $$path ; \
291 ln -fhs $$path ${.TARGET:T}
293 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
295 .if defined(DEBUG_FLAGS)
296 CLEANFILES+= ${FULLPROG} ${PROG}.debug
301 _INSTALLFLAGS:= ${INSTALLFLAGS}
302 .for ie in ${INSTALLFLAGS_EDIT}
303 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
306 .if !target(realinstall)
307 KERN_DEBUGDIR?= ${DEBUGDIR}
308 realinstall: _kmodinstall
309 .ORDER: beforeinstall _kmodinstall
311 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
312 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
313 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
314 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
315 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
318 .include <bsd.links.mk>
320 .if !defined(NO_XREF)
321 afterinstall: _kldxref
322 .ORDER: realinstall _kldxref
323 .ORDER: _installlinks _kldxref
325 @if type kldxref >/dev/null 2>&1; then \
326 ${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
327 kldxref ${DESTDIR}${KMODDIR}; \
330 .endif # !target(realinstall)
332 .endif # !target(install)
336 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
341 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
345 reload: unload load .PHONY
348 .if defined(KERNBUILDDIR)
349 .PATH: ${KERNBUILDDIR}
350 CFLAGS+= -I${KERNBUILDDIR}
351 .for _src in ${SRCS:Mopt_*.h}
355 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
359 .for _src in ${SRCS:Mopt_*.h}
368 # Respect configuration-specific C flags.
369 CFLAGS+= ${CONF_CFLAGS}
371 .if !empty(SRCS:Mvnode_if.c)
372 CLEANFILES+= vnode_if.c
373 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
374 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
377 .if !empty(SRCS:Mvnode_if.h)
378 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
379 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
380 ${SYSDIR}/kern/vnode_if.src
381 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
382 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
384 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
386 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
389 # Build _if.[ch] from _if.m, and clean them when we're done.
390 # __MPATH defined in config.mk
391 _MFILES=${__MPATH:T:O}
392 _MPATH=${__MPATH:H:O:u}
394 .for _i in ${SRCS:M*_if.[ch]}
395 _MATCH=M${_i:R:S/$/.m/}
396 _MATCHES=${_MFILES:${_MATCH}}
401 .m.c: ${SYSDIR}/tools/makeobjops.awk
402 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
404 .m.h: ${SYSDIR}/tools/makeobjops.awk
405 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
407 .for _i in mii pccard
408 .if !empty(SRCS:M${_i}devs.h)
409 CLEANFILES+= ${_i}devs.h
410 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
411 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
415 .if !empty(SRCS:Mbhnd_nvram_map.h)
416 CLEANFILES+= bhnd_nvram_map.h
417 bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
418 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
419 ${SYSDIR}/dev/bhnd/nvram/nvram_map
421 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
422 ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
425 .if !empty(SRCS:Mbhnd_nvram_map_data.h)
426 CLEANFILES+= bhnd_nvram_map_data.h
427 bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
428 ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
429 ${SYSDIR}/dev/bhnd/nvram/nvram_map
430 bhnd_nvram_map_data.h:
431 sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
432 ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
435 .if !empty(SRCS:Musbdevs.h)
436 CLEANFILES+= usbdevs.h
437 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
438 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
441 .if !empty(SRCS:Musbdevs_data.h)
442 CLEANFILES+= usbdevs_data.h
443 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
444 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
447 .if !empty(SRCS:Macpi_quirks.h)
448 CLEANFILES+= acpi_quirks.h
449 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
450 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
453 .if !empty(SRCS:Massym.s) || !empty(DPSRCS:Massym.s)
454 CLEANFILES+= assym.s genassym.o
455 DEPENDOBJS+= genassym.o
457 .if defined(KERNBUILDDIR)
458 genassym.o: opt_global.h
460 assym.s: ${SYSDIR}/kern/genassym.sh
461 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
462 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
463 genassym.o: ${SRCS:Mopt_*.h}
464 ${CC} -c ${CFLAGS:N-flto:N-fno-common} \
465 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
469 ${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
471 .if defined(KERNBUILDDIR)
472 ${OBJS}: opt_global.h
475 CLEANDEPENDFILES+= ${_ILINKS}
476 # .depend needs include links so we remove them only together.
480 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
482 .include <bsd.dep.mk>
483 .include <bsd.clang-analyze.mk>
484 .include <bsd.obj.mk>