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 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
81 # amd64 and mips use direct linking for kmod, all others use shared binaries
82 .if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
88 .if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
89 CFLAGS+= -fno-strict-aliasing
96 # Don't use any standard or source-relative include directories.
98 CFLAGS:= ${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
99 .if defined(KERNBUILDDIR)
100 CFLAGS+= -DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
103 # Add -I paths for system headers. Individual module makefiles don't
104 # need any -I paths for this. Similar defaults for .PATH can't be
105 # set because there are no standard paths for non-headers.
106 CFLAGS+= -I. -I${SYSDIR}
108 CFLAGS.gcc+= -finline-limit=${INLINE_LIMIT}
109 CFLAGS.gcc+= -fms-extensions
110 CFLAGS.gcc+= --param inline-unit-growth=100
111 CFLAGS.gcc+= --param large-function-growth=1000
113 # Disallow common variables, and if we end up with commons from
114 # somewhere unexpected, allocate storage for them in the module itself.
116 LDFLAGS+= -d -warn-common
118 CFLAGS+= ${DEBUG_FLAGS}
119 .if ${MACHINE_CPUARCH} == amd64
120 CFLAGS+= -fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
123 .if ${MACHINE_CPUARCH} == "aarch64"
127 # Temporary workaround for PR 196407, which contains the fascinating details.
128 # Don't allow clang to use fpu instructions or registers in kernel modules.
129 .if ${MACHINE_CPUARCH} == arm
130 .if ${COMPILER_VERSION} < 30800
131 CFLAGS.clang+= -mllvm -arm-use-movt=0
133 CFLAGS.clang+= -mno-movt
135 CFLAGS.clang+= -mfpu=none
136 CFLAGS+= -funwind-tables
139 .if ${MACHINE_CPUARCH} == powerpc
140 CFLAGS+= -mlongcall -fno-omit-frame-pointer
143 .if ${MACHINE_CPUARCH} == mips
144 CFLAGS+= -G0 -fno-pic -mno-abicalls -mlong-calls
147 .if defined(DEBUG) || defined(DEBUG_FLAGS)
152 ${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
153 ${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
154 ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
156 SRCS+= ${KMOD:S/$/.c/}
157 CLEANFILES+= ${KMOD:S/$/.c/}
159 .for _firmw in ${FIRMWS}
160 ${_firmw:C/\:.*$/.fwo/}: ${_firmw:C/\:.*$//}
161 @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
162 @if [ -e ${_firmw:C/\:.*$//} ]; then \
163 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
164 -r -d -o ${.TARGET} ${_firmw:C/\:.*$//}; \
166 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
167 ${LD} -b binary --no-warn-mismatch ${_LDFLAGS} \
168 -r -d -o ${.TARGET} ${_firmw:C/\:.*$//}; \
169 rm ${_firmw:C/\:.*$//}; \
172 OBJS+= ${_firmw:C/\:.*$/.fwo/}
176 # Conditionally include SRCS based on kernel config options.
177 .for _o in ${KERN_OPTS}
181 OBJS+= ${SRCS:N*.h:R:S/$/.o/g}
187 .if !defined(DEBUG_FLAGS)
190 FULLPROG= ${PROG}.full
191 ${PROG}: ${FULLPROG} ${PROG}.debug
192 ${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
193 ${FULLPROG} ${.TARGET}
194 ${PROG}.debug: ${FULLPROG}
195 ${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
198 .if ${__KLD_SHARED} == yes
199 ${FULLPROG}: ${KMOD}.kld
200 .if ${MACHINE_CPUARCH} != "aarch64"
201 ${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${KMOD}.kld
203 #XXXKIB Relocatable linking in aarch64 ld from binutils 2.25.1 does
204 # not work. The linker corrupts the references to the external
205 # symbols which are defined by other object in the linking set
206 # and should therefore loose the GOT entry. The problem seems
207 # to be fixed in the binutils-gdb git HEAD as of 2015-10-04. Hack
208 # below allows to get partially functioning modules for now.
209 ${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${OBJS}
211 .if !defined(DEBUG_FLAGS)
212 ${OBJCOPY} --strip-debug ${.TARGET}
217 .if ${EXPORT_SYMS} != YES
218 CLEANFILES+= export_syms
221 .if ${__KLD_SHARED} == yes
226 ${LD} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
227 .if ${MK_CTF} != "no"
228 ${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
230 .if defined(EXPORT_SYMS)
231 .if ${EXPORT_SYMS} != YES
232 .if ${EXPORT_SYMS} == NO
234 .elif !exists(${.CURDIR}/${EXPORT_SYMS})
235 echo ${EXPORT_SYMS} > export_syms
237 grep -v '^#' < ${EXPORT_SYMS} > export_syms
239 ${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
240 export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
243 .if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
244 ${OBJCOPY} --strip-debug ${.TARGET}
248 .if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
249 _ILINKS+=${MACHINE_CPUARCH}
251 .if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
254 CLEANFILES+=${_ILINKS}
258 beforedepend: ${_ILINKS}
259 beforebuild: ${_ILINKS}
261 # Ensure that the links exist without depending on it when it exists which
262 # causes all the modules to be rebuilt when the directory pointed to changes.
263 .for _link in ${_ILINKS}
264 .if !exists(${.OBJDIR}/${_link})
269 # Search for kernel source tree in standard places.
270 .for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
271 .if !defined(SYSDIR) && exists(${_dir}/kern/)
275 .if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
276 .error "can't find kernel source tree"
282 @case ${.TARGET} in \
284 path=${SYSDIR}/${MACHINE}/include ;; \
286 path=${SYSDIR}/${.TARGET:T}/include ;; \
288 path=`(cd $$path && /bin/pwd)` ; \
289 ${ECHO} ${.TARGET:T} "->" $$path ; \
290 ln -sf $$path ${.TARGET:T}
292 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
294 .if defined(DEBUG_FLAGS)
295 CLEANFILES+= ${FULLPROG} ${PROG}.debug
300 _INSTALLFLAGS:= ${INSTALLFLAGS}
301 .for ie in ${INSTALLFLAGS_EDIT}
302 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
305 .if !target(realinstall)
306 KERN_DEBUGDIR?= ${DEBUGDIR}
307 realinstall: _kmodinstall
308 .ORDER: beforeinstall _kmodinstall
310 ${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
311 ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
312 .if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
313 ${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
314 ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
317 .include <bsd.links.mk>
319 .if !defined(NO_XREF)
320 afterinstall: _kldxref
321 .ORDER: realinstall _kldxref
322 .ORDER: _installlinks _kldxref
324 @if type kldxref >/dev/null 2>&1; then \
325 ${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
326 kldxref ${DESTDIR}${KMODDIR}; \
329 .endif # !target(realinstall)
331 .endif # !target(install)
335 ${KMODLOAD} -v ${.OBJDIR}/${PROG}
340 if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
347 .if defined(KERNBUILDDIR)
348 .PATH: ${KERNBUILDDIR}
349 CFLAGS+= -I${KERNBUILDDIR}
350 .for _src in ${SRCS:Mopt_*.h}
354 ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
358 .for _src in ${SRCS:Mopt_*.h}
367 # Respect configuration-specific C flags.
368 CFLAGS+= ${CONF_CFLAGS}
370 .if !empty(SRCS:Mvnode_if.c)
371 CLEANFILES+= vnode_if.c
372 vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
373 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
376 .if !empty(SRCS:Mvnode_if.h)
377 CLEANFILES+= vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
378 vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
379 ${SYSDIR}/kern/vnode_if.src
380 vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
381 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
383 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
385 ${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
388 # Build _if.[ch] from _if.m, and clean them when we're done.
389 # __MPATH defined in config.mk
390 _MFILES=${__MPATH:T:O}
391 _MPATH=${__MPATH:H:O:u}
393 .for _i in ${SRCS:M*_if.[ch]}
394 _MATCH=M${_i:R:S/$/.m/}
395 _MATCHES=${_MFILES:${_MATCH}}
400 .m.c: ${SYSDIR}/tools/makeobjops.awk
401 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
403 .m.h: ${SYSDIR}/tools/makeobjops.awk
404 ${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
406 .for _i in mii pccard
407 .if !empty(SRCS:M${_i}devs.h)
408 CLEANFILES+= ${_i}devs.h
409 ${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
410 ${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
414 .if !empty(SRCS:Musbdevs.h)
415 CLEANFILES+= usbdevs.h
416 usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
417 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
420 .if !empty(SRCS:Musbdevs_data.h)
421 CLEANFILES+= usbdevs_data.h
422 usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
423 ${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
426 .if !empty(SRCS:Macpi_quirks.h)
427 CLEANFILES+= acpi_quirks.h
428 acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
429 ${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
432 .if !empty(SRCS:Massym.s)
433 CLEANFILES+= assym.s genassym.o
435 .if defined(KERNBUILDDIR)
436 genassym.o: opt_global.h
438 assym.s: ${SYSDIR}/kern/genassym.sh
439 sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
440 genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
441 genassym.o: ${SRCS:Mopt_*.h}
442 ${CC} -c ${CFLAGS:N-fno-common} \
443 ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
447 ${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
449 .if defined(KERNBUILDDIR)
450 ${OBJS}: opt_global.h
453 CLEANDEPENDFILES+= ${_ILINKS}
454 # .depend needs include links so we remove them only together.
458 OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
460 .include <bsd.dep.mk>
461 .include <bsd.clang-analyze.mk>
462 .include <bsd.obj.mk>