kmod.mk revision 331751 
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: stable/11/sys/conf/kmod.mk 331751 2018-03-30 01:19:53Z 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
128.if ${LINKER_FEATURES:Mbuild-id}
129LDFLAGS+=	-Wl,--build-id=sha1
130.endif
131
132CFLAGS+=	${DEBUG_FLAGS}
133.if ${MACHINE_CPUARCH} == amd64
134CFLAGS+=	-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
135.endif
136
137.if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
138CFLAGS+=	-fPIC
139.endif
140
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
145CFLAGS.clang+=	-mllvm -arm-use-movt=0
146.else
147CFLAGS.clang+=	-mno-movt
148.endif
149CFLAGS.clang+=	-mfpu=none
150CFLAGS+=	-funwind-tables
151.endif
152
153.if ${MACHINE_CPUARCH} == powerpc
154CFLAGS+=	-mlongcall -fno-omit-frame-pointer
155.endif
156
157.if ${MACHINE_CPUARCH} == mips
158CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
159.endif
160
161.if defined(DEBUG) || defined(DEBUG_FLAGS)
162CTFFLAGS+=	-g
163.endif
164
165.if defined(FIRMWS)
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}
169
170SRCS+=	${KMOD:S/$/.c/}
171CLEANFILES+=	${KMOD:S/$/.c/}
172
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/\:.*$//};		\
180	else							\
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/\:.*$//};				\
186	fi
187
188OBJS+=	${_firmw:C/\:.*$/.fwo/:T}
189.endfor
190.endif
191
192# Conditionally include SRCS based on kernel config options.
193.for _o in ${KERN_OPTS}
194SRCS+=${SRCS.${_o}}
195.endfor
196
197OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
198
199.if !defined(PROG)
200PROG=	${KMOD}.ko
201.endif
202
203.if !defined(DEBUG_FLAGS)
204FULLPROG=	${PROG}
205.else
206FULLPROG=	${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}
212.endif
213
214.if ${__KLD_SHARED} == yes
215${FULLPROG}: ${KMOD}.kld
216	${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${KMOD}.kld
217.if !defined(DEBUG_FLAGS)
218	${OBJCOPY} --strip-debug ${.TARGET}
219.endif
220.endif
221
222EXPORT_SYMS?=	NO
223.if ${EXPORT_SYMS} != YES
224CLEANFILES+=	export_syms
225.endif
226
227.if ${__KLD_SHARED} == yes
228${KMOD}.kld: ${OBJS}
229.else
230${FULLPROG}: ${OBJS}
231.endif
232	${LD} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
233.if ${MK_CTF} != "no"
234	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
235.endif
236.if defined(EXPORT_SYMS)
237.if ${EXPORT_SYMS} != YES
238.if ${EXPORT_SYMS} == NO
239	:> export_syms
240.elif !exists(${.CURDIR}/${EXPORT_SYMS})
241	echo -n "${EXPORT_SYMS:@s@$s${.newline}@}" > export_syms
242.else
243	grep -v '^#' < ${EXPORT_SYMS} > export_syms
244.endif
245	${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
246	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
247.endif
248.endif # defined(EXPORT_SYMS)
249.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
250	${OBJCOPY} --strip-debug ${.TARGET}
251.endif
252
253_ILINKS=machine
254.if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
255_ILINKS+=${MACHINE_CPUARCH}
256.endif
257.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
258_ILINKS+=x86
259.endif
260CLEANFILES+=${_ILINKS}
261
262all: ${PROG}
263
264beforedepend: ${_ILINKS}
265beforebuild: ${_ILINKS}
266
267# Ensure that the links exist without depending on it when it exists which
268# causes all the modules to be rebuilt when the directory pointed to changes.
269.for _link in ${_ILINKS}
270.if !exists(${.OBJDIR}/${_link})
271OBJS_DEPEND_GUESS+=	${_link}
272.endif
273.endfor
274
275.NOPATH: ${_ILINKS}
276
277${_ILINKS}:
278	@case ${.TARGET} in \
279	machine) \
280		path=${SYSDIR}/${MACHINE}/include ;; \
281	*) \
282		path=${SYSDIR}/${.TARGET:T}/include ;; \
283	esac ; \
284	path=`(cd $$path && /bin/pwd)` ; \
285	${ECHO} ${.TARGET:T} "->" $$path ; \
286	ln -fhs $$path ${.TARGET:T}
287
288CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
289
290.if defined(DEBUG_FLAGS)
291CLEANFILES+= ${FULLPROG} ${PROG}.debug
292.endif
293
294.if !target(install)
295
296_INSTALLFLAGS:=	${INSTALLFLAGS}
297.for ie in ${INSTALLFLAGS_EDIT}
298_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
299.endfor
300
301.if !target(realinstall)
302KERN_DEBUGDIR?=	${DEBUGDIR}
303realinstall: _kmodinstall
304.ORDER: beforeinstall _kmodinstall
305_kmodinstall: .PHONY
306	${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
307	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
308.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
309	${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
310	    ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
311.endif
312
313.include <bsd.links.mk>
314
315.if !defined(NO_XREF)
316afterinstall: _kldxref
317.ORDER: realinstall _kldxref
318.ORDER: _installlinks _kldxref
319_kldxref: .PHONY
320	@if type kldxref >/dev/null 2>&1; then \
321		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
322		kldxref ${DESTDIR}${KMODDIR}; \
323	fi
324.endif
325.endif # !target(realinstall)
326
327.endif # !target(install)
328
329.if !target(load)
330load: ${PROG} .PHONY
331	${KMODLOAD} -v ${.OBJDIR}/${PROG}
332.endif
333
334.if !target(unload)
335unload: .PHONY
336	if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
337.endif
338
339.if !target(reload)
340reload: unload load .PHONY
341.endif
342
343.if defined(KERNBUILDDIR)
344.PATH: ${KERNBUILDDIR}
345CFLAGS+=	-I${KERNBUILDDIR}
346.for _src in ${SRCS:Mopt_*.h}
347CLEANFILES+=	${_src}
348.if !target(${_src})
349${_src}:
350	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
351.endif
352.endfor
353.else
354.for _src in ${SRCS:Mopt_*.h}
355CLEANFILES+=	${_src}
356.if !target(${_src})
357${_src}:
358	:> ${.TARGET}
359.endif
360.endfor
361.endif
362
363# Respect configuration-specific C flags.
364CFLAGS+=	${ARCH_FLAGS} ${CONF_CFLAGS}
365
366.if !empty(SRCS:Mvnode_if.c)
367CLEANFILES+=	vnode_if.c
368vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
369	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
370.endif
371
372.if !empty(SRCS:Mvnode_if.h)
373CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
374vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
375    ${SYSDIR}/kern/vnode_if.src
376vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
377	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
378vnode_if_newproto.h:
379	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
380vnode_if_typedef.h:
381	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
382.endif
383
384# Build _if.[ch] from _if.m, and clean them when we're done.
385# __MPATH defined in config.mk
386_MFILES=${__MPATH:T:O}
387_MPATH=${__MPATH:H:O:u}
388.PATH.m: ${_MPATH}
389.for _i in ${SRCS:M*_if.[ch]}
390_MATCH=M${_i:R:S/$/.m/}
391_MATCHES=${_MFILES:${_MATCH}}
392.if !empty(_MATCHES)
393CLEANFILES+=	${_i}
394.endif
395.endfor # _i
396.m.c:	${SYSDIR}/tools/makeobjops.awk
397	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
398
399.m.h:	${SYSDIR}/tools/makeobjops.awk
400	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
401
402.for _i in mii pccard
403.if !empty(SRCS:M${_i}devs.h)
404CLEANFILES+=	${_i}devs.h
405${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
406	${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
407.endif
408.endfor # _i
409
410.if !empty(SRCS:Mbhnd_nvram_map.h)
411CLEANFILES+=	bhnd_nvram_map.h
412bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
413    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
414    ${SYSDIR}/dev/bhnd/nvram/nvram_map
415bhnd_nvram_map.h:
416	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
417	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
418.endif
419
420.if !empty(SRCS:Mbhnd_nvram_map_data.h)
421CLEANFILES+=	bhnd_nvram_map_data.h
422bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
423    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
424    ${SYSDIR}/dev/bhnd/nvram/nvram_map
425bhnd_nvram_map_data.h:
426	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
427	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
428.endif
429
430.if !empty(SRCS:Musbdevs.h)
431CLEANFILES+=	usbdevs.h
432usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
433	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
434.endif
435
436.if !empty(SRCS:Musbdevs_data.h)
437CLEANFILES+=	usbdevs_data.h
438usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
439	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
440.endif
441
442.if !empty(SRCS:Macpi_quirks.h)
443CLEANFILES+=	acpi_quirks.h
444acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
445	${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
446.endif
447
448.if !empty(SRCS:Massym.s) || !empty(DPSRCS:Massym.s)
449CLEANFILES+=	assym.s genassym.o
450DEPENDOBJS+=	genassym.o
451assym.s: genassym.o
452.if defined(KERNBUILDDIR)
453genassym.o: opt_global.h
454.endif
455assym.s: ${SYSDIR}/kern/genassym.sh
456	sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
457genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
458genassym.o: ${SRCS:Mopt_*.h}
459	${CC} -c ${CFLAGS:N-flto:N-fno-common} \
460	    ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
461.endif
462
463lint: ${SRCS}
464	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
465
466.if defined(KERNBUILDDIR)
467${OBJS}: opt_global.h
468.endif
469
470CLEANDEPENDFILES+=	${_ILINKS}
471# .depend needs include links so we remove them only together.
472cleanilinks:
473	rm -f ${_ILINKS}
474
475OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
476
477.include <bsd.dep.mk>
478.include <bsd.clang-analyze.mk>
479.include <bsd.obj.mk>
480.include "kern.mk"
481